From b627037af11fd5152d95cb06a054a52240c8bfeb Mon Sep 17 00:00:00 2001 From: Josh Mock Date: Tue, 27 May 2025 15:30:21 -0500 Subject: [PATCH 1/7] WIP better generated API reference docs --- .gitignore | 1 + .npmignore | 42 +- api-extractor.json | 39 + docs/reference/api-reference.md | 15488 +--------------- docs/reference/api/API.md | 90 + .../reference/api/AcknowledgedResponseBase.md | 5 + docs/reference/api/Action.md | 4 + docs/reference/api/AggregateName.md | 4 + .../AggregationsAdjacencyMatrixAggregate.md | 4 + .../AggregationsAdjacencyMatrixAggregation.md | 6 + .../api/AggregationsAdjacencyMatrixBucket.md | 4 + .../AggregationsAdjacencyMatrixBucketKeys.md | 5 + docs/reference/api/AggregationsAggregate.md | 4 + .../api/AggregationsAggregateBase.md | 5 + .../api/AggregationsAggregateOrder.md | 4 + docs/reference/api/AggregationsAggregation.md | 4 + .../api/AggregationsAggregationContainer.md | 85 + .../api/AggregationsAggregationRange.md | 7 + .../api/AggregationsArrayPercentilesItem.md | 7 + .../AggregationsAutoDateHistogramAggregate.md | 5 + ...ggregationsAutoDateHistogramAggregation.md | 13 + .../api/AggregationsAverageAggregation.md | 4 + .../AggregationsAverageBucketAggregation.md | 4 + .../reference/api/AggregationsAvgAggregate.md | 4 + .../api/AggregationsBoxPlotAggregate.md | 18 + .../api/AggregationsBoxplotAggregation.md | 5 + .../api/AggregationsBucketAggregationBase.md | 4 + ...ggregationsBucketCorrelationAggregation.md | 5 + .../AggregationsBucketCorrelationFunction.md | 5 + ...cketCorrelationFunctionCountCorrelation.md | 5 + ...lationFunctionCountCorrelationIndicator.md | 7 + .../api/AggregationsBucketKsAggregation.md | 7 + .../AggregationsBucketMetricValueAggregate.md | 5 + .../api/AggregationsBucketPathAggregation.md | 5 + .../AggregationsBucketScriptAggregation.md | 5 + .../AggregationsBucketSelectorAggregation.md | 5 + .../api/AggregationsBucketSortAggregation.md | 8 + docs/reference/api/AggregationsBuckets.md | 4 + docs/reference/api/AggregationsBucketsPath.md | 4 + .../api/AggregationsCalendarInterval.md | 4 + .../api/AggregationsCardinalityAggregate.md | 5 + .../api/AggregationsCardinalityAggregation.md | 7 + .../AggregationsCardinalityExecutionMode.md | 4 + .../AggregationsCategorizeTextAggregation.md | 14 + .../api/AggregationsCategorizeTextAnalyzer.md | 4 + .../api/AggregationsChiSquareHeuristic.md | 6 + .../api/AggregationsChildrenAggregate.md | 4 + .../api/AggregationsChildrenAggregateKeys.md | 4 + .../api/AggregationsChildrenAggregation.md | 5 + .../api/AggregationsCompositeAggregate.md | 5 + .../api/AggregationsCompositeAggregateKey.md | 4 + .../api/AggregationsCompositeAggregation.md | 7 + .../AggregationsCompositeAggregationBase.md | 10 + .../AggregationsCompositeAggregationSource.md | 8 + .../api/AggregationsCompositeBucket.md | 4 + .../api/AggregationsCompositeBucketKeys.md | 5 + ...ationsCompositeDateHistogramAggregation.md | 9 + ...egationsCompositeGeoTileGridAggregation.md | 6 + ...gregationsCompositeHistogramAggregation.md | 5 + .../AggregationsCompositeTermsAggregation.md | 4 + ...regationsCumulativeCardinalityAggregate.md | 6 + ...gationsCumulativeCardinalityAggregation.md | 4 + .../AggregationsCumulativeSumAggregation.md | 4 + ...ggregationsCustomCategorizeTextAnalyzer.md | 7 + .../api/AggregationsDateHistogramAggregate.md | 4 + .../AggregationsDateHistogramAggregation.md | 19 + .../api/AggregationsDateHistogramBucket.md | 4 + .../AggregationsDateHistogramBucketKeys.md | 6 + .../api/AggregationsDateRangeAggregate.md | 4 + .../api/AggregationsDateRangeAggregation.md | 10 + .../api/AggregationsDateRangeExpression.md | 7 + .../api/AggregationsDerivativeAggregate.md | 6 + .../api/AggregationsDerivativeAggregation.md | 4 + ...gregationsDiversifiedSamplerAggregation.md | 9 + .../api/AggregationsDoubleTermsAggregate.md | 4 + .../api/AggregationsDoubleTermsBucket.md | 4 + .../api/AggregationsDoubleTermsBucketKeys.md | 6 + .../api/AggregationsEwmaModelSettings.md | 5 + ...ggregationsEwmaMovingAverageAggregation.md | 6 + .../api/AggregationsExtendedBounds.md | 6 + .../api/AggregationsExtendedStatsAggregate.md | 18 + .../AggregationsExtendedStatsAggregation.md | 5 + ...ggregationsExtendedStatsBucketAggregate.md | 4 + ...regationsExtendedStatsBucketAggregation.md | 5 + .../api/AggregationsFieldDateMath.md | 4 + .../api/AggregationsFilterAggregate.md | 4 + .../api/AggregationsFilterAggregateKeys.md | 4 + .../api/AggregationsFiltersAggregate.md | 4 + .../api/AggregationsFiltersAggregation.md | 8 + .../api/AggregationsFiltersBucket.md | 4 + .../api/AggregationsFiltersBucketKeys.md | 4 + ...AggregationsFormatMetricAggregationBase.md | 5 + ...ggregationsFormattableMetricAggregation.md | 5 + .../AggregationsFrequentItemSetsAggregate.md | 4 + ...AggregationsFrequentItemSetsAggregation.md | 9 + .../api/AggregationsFrequentItemSetsBucket.md | 4 + .../AggregationsFrequentItemSetsBucketKeys.md | 6 + .../api/AggregationsFrequentItemSetsField.md | 7 + docs/reference/api/AggregationsGapPolicy.md | 4 + .../api/AggregationsGeoBoundsAggregate.md | 5 + .../api/AggregationsGeoBoundsAggregation.md | 5 + .../api/AggregationsGeoCentroidAggregate.md | 6 + .../api/AggregationsGeoCentroidAggregation.md | 6 + .../api/AggregationsGeoDistanceAggregate.md | 4 + .../api/AggregationsGeoDistanceAggregation.md | 9 + .../api/AggregationsGeoHashGridAggregate.md | 4 + .../api/AggregationsGeoHashGridAggregation.md | 9 + .../api/AggregationsGeoHashGridBucket.md | 4 + .../api/AggregationsGeoHashGridBucketKeys.md | 5 + .../api/AggregationsGeoHexGridAggregate.md | 4 + .../api/AggregationsGeoHexGridBucket.md | 4 + .../api/AggregationsGeoHexGridBucketKeys.md | 5 + .../api/AggregationsGeoLineAggregate.md | 7 + .../api/AggregationsGeoLineAggregation.md | 9 + .../reference/api/AggregationsGeoLinePoint.md | 5 + docs/reference/api/AggregationsGeoLineSort.md | 5 + .../api/AggregationsGeoTileGridAggregate.md | 4 + .../api/AggregationsGeoTileGridAggregation.md | 9 + .../api/AggregationsGeoTileGridBucket.md | 4 + .../api/AggregationsGeoTileGridBucketKeys.md | 5 + .../api/AggregationsGeohexGridAggregation.md | 9 + .../api/AggregationsGlobalAggregate.md | 4 + .../api/AggregationsGlobalAggregateKeys.md | 4 + .../api/AggregationsGlobalAggregation.md | 4 + ...ationsGoogleNormalizedDistanceHeuristic.md | 5 + docs/reference/api/AggregationsHdrMethod.md | 5 + ...AggregationsHdrPercentileRanksAggregate.md | 4 + .../AggregationsHdrPercentilesAggregate.md | 4 + .../api/AggregationsHistogramAggregate.md | 4 + .../api/AggregationsHistogramAggregation.md | 15 + .../api/AggregationsHistogramBucket.md | 4 + .../api/AggregationsHistogramBucketKeys.md | 6 + .../AggregationsHoltLinearModelSettings.md | 6 + ...ggregationsHoltMovingAverageAggregation.md | 6 + .../AggregationsHoltWintersModelSettings.md | 10 + ...ionsHoltWintersMovingAverageAggregation.md | 6 + .../api/AggregationsHoltWintersType.md | 4 + .../api/AggregationsInferenceAggregate.md | 4 + .../api/AggregationsInferenceAggregateKeys.md | 8 + .../api/AggregationsInferenceAggregation.md | 6 + .../AggregationsInferenceClassImportance.md | 6 + .../AggregationsInferenceConfigContainer.md | 6 + .../AggregationsInferenceFeatureImportance.md | 7 + .../api/AggregationsInferenceTopClassEntry.md | 7 + .../api/AggregationsIpPrefixAggregate.md | 4 + .../api/AggregationsIpPrefixAggregation.md | 10 + .../api/AggregationsIpPrefixBucket.md | 4 + .../api/AggregationsIpPrefixBucketKeys.md | 8 + .../api/AggregationsIpRangeAggregate.md | 4 + .../api/AggregationsIpRangeAggregation.md | 6 + .../AggregationsIpRangeAggregationRange.md | 7 + .../api/AggregationsIpRangeBucket.md | 4 + .../api/AggregationsIpRangeBucketKeys.md | 7 + .../api/AggregationsKeyedPercentiles.md | 4 + ...regationsLinearMovingAverageAggregation.md | 6 + .../api/AggregationsLongRareTermsAggregate.md | 4 + .../api/AggregationsLongRareTermsBucket.md | 4 + .../AggregationsLongRareTermsBucketKeys.md | 6 + .../api/AggregationsLongTermsAggregate.md | 4 + .../api/AggregationsLongTermsBucket.md | 4 + .../api/AggregationsLongTermsBucketKeys.md | 6 + .../api/AggregationsMatrixAggregation.md | 6 + .../api/AggregationsMatrixStatsAggregate.md | 6 + .../api/AggregationsMatrixStatsAggregation.md | 5 + .../api/AggregationsMatrixStatsFields.md | 12 + .../reference/api/AggregationsMaxAggregate.md | 4 + .../api/AggregationsMaxAggregation.md | 4 + .../api/AggregationsMaxBucketAggregation.md | 4 + ...gationsMedianAbsoluteDeviationAggregate.md | 4 + ...tionsMedianAbsoluteDeviationAggregation.md | 5 + .../api/AggregationsMetricAggregationBase.md | 7 + .../reference/api/AggregationsMinAggregate.md | 4 + .../api/AggregationsMinAggregation.md | 4 + .../api/AggregationsMinBucketAggregation.md | 4 + .../api/AggregationsMinimumInterval.md | 4 + docs/reference/api/AggregationsMissing.md | 4 + .../api/AggregationsMissingAggregate.md | 4 + .../api/AggregationsMissingAggregateKeys.md | 4 + .../api/AggregationsMissingAggregation.md | 6 + .../reference/api/AggregationsMissingOrder.md | 4 + .../AggregationsMovingAverageAggregation.md | 4 + ...ggregationsMovingAverageAggregationBase.md | 7 + .../AggregationsMovingFunctionAggregation.md | 7 + ...ggregationsMovingPercentilesAggregation.md | 7 + .../AggregationsMultiBucketAggregateBase.md | 5 + .../api/AggregationsMultiBucketBase.md | 5 + .../api/AggregationsMultiTermLookup.md | 6 + .../api/AggregationsMultiTermsAggregate.md | 4 + .../api/AggregationsMultiTermsAggregation.md | 12 + .../api/AggregationsMultiTermsBucket.md | 4 + .../api/AggregationsMultiTermsBucketKeys.md | 7 + .../AggregationsMutualInformationHeuristic.md | 6 + .../api/AggregationsNestedAggregate.md | 4 + .../api/AggregationsNestedAggregateKeys.md | 4 + .../api/AggregationsNestedAggregation.md | 5 + .../api/AggregationsNormalizeAggregation.md | 5 + .../api/AggregationsNormalizeMethod.md | 4 + .../api/AggregationsParentAggregate.md | 4 + .../api/AggregationsParentAggregateKeys.md | 4 + .../api/AggregationsParentAggregation.md | 5 + .../AggregationsPercentageScoreHeuristic.md | 4 + .../AggregationsPercentileRanksAggregation.md | 8 + docs/reference/api/AggregationsPercentiles.md | 4 + .../AggregationsPercentilesAggregateBase.md | 5 + .../api/AggregationsPercentilesAggregation.md | 8 + .../AggregationsPercentilesBucketAggregate.md | 4 + ...ggregationsPercentilesBucketAggregation.md | 5 + .../AggregationsPipelineAggregationBase.md | 6 + .../AggregationsRandomSamplerAggregation.md | 7 + .../api/AggregationsRangeAggregate.md | 4 + .../api/AggregationsRangeAggregation.md | 10 + docs/reference/api/AggregationsRangeBucket.md | 4 + .../api/AggregationsRangeBucketKeys.md | 9 + .../api/AggregationsRareTermsAggregation.md | 11 + .../api/AggregationsRateAggregate.md | 6 + .../api/AggregationsRateAggregation.md | 6 + docs/reference/api/AggregationsRateMode.md | 4 + .../api/AggregationsReverseNestedAggregate.md | 4 + .../AggregationsReverseNestedAggregateKeys.md | 4 + .../AggregationsReverseNestedAggregation.md | 5 + .../api/AggregationsSamplerAggregate.md | 4 + .../api/AggregationsSamplerAggregateKeys.md | 4 + .../api/AggregationsSamplerAggregation.md | 5 + ...egationsSamplerAggregationExecutionHint.md | 4 + .../api/AggregationsScriptedHeuristic.md | 5 + .../AggregationsScriptedMetricAggregate.md | 5 + .../AggregationsScriptedMetricAggregation.md | 9 + ...gregationsSerialDifferencingAggregation.md | 5 + ...gregationsSignificantLongTermsAggregate.md | 4 + .../AggregationsSignificantLongTermsBucket.md | 4 + ...regationsSignificantLongTermsBucketKeys.md | 6 + ...egationsSignificantStringTermsAggregate.md | 4 + ...ggregationsSignificantStringTermsBucket.md | 4 + ...gationsSignificantStringTermsBucketKeys.md | 5 + ...gregationsSignificantTermsAggregateBase.md | 6 + ...AggregationsSignificantTermsAggregation.md | 19 + .../AggregationsSignificantTermsBucketBase.md | 6 + .../AggregationsSignificantTextAggregation.md | 21 + ...regationsSimpleMovingAverageAggregation.md | 6 + .../api/AggregationsSimpleValueAggregate.md | 4 + .../AggregationsSingleBucketAggregateBase.md | 5 + .../AggregationsSingleMetricAggregateBase.md | 6 + .../AggregationsStandardDeviationBounds.md | 10 + ...egationsStandardDeviationBoundsAsString.md | 10 + .../api/AggregationsStatsAggregate.md | 13 + .../api/AggregationsStatsAggregation.md | 4 + .../api/AggregationsStatsBucketAggregate.md | 4 + .../api/AggregationsStatsBucketAggregation.md | 4 + .../AggregationsStringRareTermsAggregate.md | 4 + .../api/AggregationsStringRareTermsBucket.md | 4 + .../AggregationsStringRareTermsBucketKeys.md | 5 + .../api/AggregationsStringStatsAggregate.md | 13 + .../api/AggregationsStringStatsAggregation.md | 5 + .../api/AggregationsStringTermsAggregate.md | 4 + .../api/AggregationsStringTermsBucket.md | 4 + .../api/AggregationsStringTermsBucketKeys.md | 5 + .../reference/api/AggregationsSumAggregate.md | 4 + .../api/AggregationsSumAggregation.md | 4 + .../api/AggregationsSumBucketAggregation.md | 4 + docs/reference/api/AggregationsTDigest.md | 5 + ...egationsTDigestPercentileRanksAggregate.md | 4 + ...AggregationsTDigestPercentilesAggregate.md | 4 + .../api/AggregationsTTestAggregate.md | 6 + .../api/AggregationsTTestAggregation.md | 7 + docs/reference/api/AggregationsTTestType.md | 4 + .../api/AggregationsTermsAggregateBase.md | 6 + .../api/AggregationsTermsAggregation.md | 21 + ...AggregationsTermsAggregationCollectMode.md | 4 + ...gregationsTermsAggregationExecutionHint.md | 4 + .../api/AggregationsTermsBucketBase.md | 5 + .../reference/api/AggregationsTermsExclude.md | 4 + .../reference/api/AggregationsTermsInclude.md | 4 + .../api/AggregationsTermsPartition.md | 6 + .../api/AggregationsTestPopulation.md | 7 + .../api/AggregationsTimeSeriesAggregate.md | 4 + .../api/AggregationsTimeSeriesAggregation.md | 6 + .../api/AggregationsTimeSeriesBucket.md | 4 + .../api/AggregationsTimeSeriesBucketKeys.md | 5 + .../api/AggregationsTopHitsAggregate.md | 5 + .../api/AggregationsTopHitsAggregation.md | 17 + docs/reference/api/AggregationsTopMetrics.md | 6 + .../api/AggregationsTopMetricsAggregate.md | 5 + .../api/AggregationsTopMetricsAggregation.md | 7 + .../api/AggregationsTopMetricsValue.md | 5 + .../AggregationsUnmappedRareTermsAggregate.md | 4 + .../AggregationsUnmappedSamplerAggregate.md | 4 + ...ggregationsUnmappedSamplerAggregateKeys.md | 4 + ...ationsUnmappedSignificantTermsAggregate.md | 4 + .../api/AggregationsUnmappedTermsAggregate.md | 4 + .../api/AggregationsValueCountAggregate.md | 4 + .../api/AggregationsValueCountAggregation.md | 4 + docs/reference/api/AggregationsValueType.md | 4 + ...egationsVariableWidthHistogramAggregate.md | 4 + ...ationsVariableWidthHistogramAggregation.md | 9 + ...ggregationsVariableWidthHistogramBucket.md | 4 + ...gationsVariableWidthHistogramBucketKeys.md | 10 + .../AggregationsWeightedAverageAggregation.md | 8 + .../api/AggregationsWeightedAverageValue.md | 7 + .../api/AggregationsWeightedAvgAggregate.md | 4 + docs/reference/api/AnalysisAnalyzer.md | 4 + .../api/AnalysisApostropheTokenFilter.md | 5 + docs/reference/api/AnalysisArabicAnalyzer.md | 8 + .../AnalysisArabicNormalizationTokenFilter.md | 5 + .../reference/api/AnalysisArmenianAnalyzer.md | 8 + .../api/AnalysisAsciiFoldingTokenFilter.md | 6 + docs/reference/api/AnalysisBasqueAnalyzer.md | 8 + docs/reference/api/AnalysisBengaliAnalyzer.md | 8 + .../api/AnalysisBrazilianAnalyzer.md | 7 + .../api/AnalysisBulgarianAnalyzer.md | 8 + docs/reference/api/AnalysisCatalanAnalyzer.md | 8 + docs/reference/api/AnalysisCharFilter.md | 4 + docs/reference/api/AnalysisCharFilterBase.md | 5 + .../api/AnalysisCharFilterDefinition.md | 4 + .../api/AnalysisCharGroupTokenizer.md | 7 + docs/reference/api/AnalysisChineseAnalyzer.md | 7 + docs/reference/api/AnalysisCjkAnalyzer.md | 7 + .../api/AnalysisCjkBigramIgnoredScript.md | 4 + .../api/AnalysisCjkBigramTokenFilter.md | 7 + .../api/AnalysisCjkWidthTokenFilter.md | 5 + .../api/AnalysisClassicTokenFilter.md | 5 + .../reference/api/AnalysisClassicTokenizer.md | 6 + .../api/AnalysisCommonGramsTokenFilter.md | 9 + .../AnalysisCompoundWordTokenFilterBase.md | 10 + .../api/AnalysisConditionTokenFilter.md | 7 + docs/reference/api/AnalysisCustomAnalyzer.md | 10 + .../reference/api/AnalysisCustomNormalizer.md | 7 + docs/reference/api/AnalysisCzechAnalyzer.md | 8 + docs/reference/api/AnalysisDanishAnalyzer.md | 7 + .../api/AnalysisDecimalDigitTokenFilter.md | 5 + .../api/AnalysisDelimitedPayloadEncoding.md | 4 + .../AnalysisDelimitedPayloadTokenFilter.md | 7 + ...alysisDictionaryDecompounderTokenFilter.md | 5 + docs/reference/api/AnalysisDutchAnalyzer.md | 8 + docs/reference/api/AnalysisEdgeNGramSide.md | 4 + .../api/AnalysisEdgeNGramTokenFilter.md | 9 + .../api/AnalysisEdgeNGramTokenizer.md | 9 + .../api/AnalysisElisionTokenFilter.md | 8 + docs/reference/api/AnalysisEnglishAnalyzer.md | 8 + .../reference/api/AnalysisEstonianAnalyzer.md | 7 + .../api/AnalysisFingerprintAnalyzer.md | 10 + .../api/AnalysisFingerprintTokenFilter.md | 7 + docs/reference/api/AnalysisFinnishAnalyzer.md | 8 + .../api/AnalysisFlattenGraphTokenFilter.md | 5 + docs/reference/api/AnalysisFrenchAnalyzer.md | 8 + .../reference/api/AnalysisGalicianAnalyzer.md | 8 + docs/reference/api/AnalysisGermanAnalyzer.md | 8 + .../AnalysisGermanNormalizationTokenFilter.md | 5 + docs/reference/api/AnalysisGreekAnalyzer.md | 7 + docs/reference/api/AnalysisHindiAnalyzer.md | 8 + .../AnalysisHindiNormalizationTokenFilter.md | 5 + .../api/AnalysisHtmlStripCharFilter.md | 6 + .../api/AnalysisHungarianAnalyzer.md | 8 + .../api/AnalysisHunspellTokenFilter.md | 11 + ...lysisHyphenationDecompounderTokenFilter.md | 8 + docs/reference/api/AnalysisIcuAnalyzer.md | 7 + .../api/AnalysisIcuCollationAlternate.md | 4 + .../api/AnalysisIcuCollationCaseFirst.md | 4 + .../api/AnalysisIcuCollationDecomposition.md | 4 + .../api/AnalysisIcuCollationStrength.md | 4 + .../api/AnalysisIcuCollationTokenFilter.md | 17 + .../api/AnalysisIcuFoldingTokenFilter.md | 6 + .../api/AnalysisIcuNormalizationCharFilter.md | 8 + .../api/AnalysisIcuNormalizationMode.md | 4 + .../AnalysisIcuNormalizationTokenFilter.md | 6 + .../api/AnalysisIcuNormalizationType.md | 4 + docs/reference/api/AnalysisIcuTokenizer.md | 6 + .../api/AnalysisIcuTransformDirection.md | 4 + .../api/AnalysisIcuTransformTokenFilter.md | 7 + .../AnalysisIndicNormalizationTokenFilter.md | 5 + .../api/AnalysisIndonesianAnalyzer.md | 8 + docs/reference/api/AnalysisIrishAnalyzer.md | 8 + docs/reference/api/AnalysisItalianAnalyzer.md | 8 + .../api/AnalysisJaStopTokenFilter.md | 6 + .../reference/api/AnalysisKStemTokenFilter.md | 5 + docs/reference/api/AnalysisKeepTypesMode.md | 4 + .../api/AnalysisKeepTypesTokenFilter.md | 7 + .../api/AnalysisKeepWordsTokenFilter.md | 8 + docs/reference/api/AnalysisKeywordAnalyzer.md | 6 + .../api/AnalysisKeywordMarkerTokenFilter.md | 9 + .../api/AnalysisKeywordRepeatTokenFilter.md | 5 + .../reference/api/AnalysisKeywordTokenizer.md | 6 + .../reference/api/AnalysisKuromojiAnalyzer.md | 7 + ...AnalysisKuromojiIterationMarkCharFilter.md | 7 + ...AnalysisKuromojiPartOfSpeechTokenFilter.md | 6 + .../AnalysisKuromojiReadingFormTokenFilter.md | 6 + .../api/AnalysisKuromojiStemmerTokenFilter.md | 6 + .../api/AnalysisKuromojiTokenizationMode.md | 4 + .../api/AnalysisKuromojiTokenizer.md | 12 + docs/reference/api/AnalysisLatvianAnalyzer.md | 8 + .../api/AnalysisLengthTokenFilter.md | 7 + docs/reference/api/AnalysisLetterTokenizer.md | 5 + .../api/AnalysisLimitTokenCountTokenFilter.md | 7 + .../api/AnalysisLithuanianAnalyzer.md | 8 + .../api/AnalysisLowercaseNormalizer.md | 5 + .../api/AnalysisLowercaseTokenFilter.md | 6 + .../AnalysisLowercaseTokenFilterLanguages.md | 4 + .../api/AnalysisLowercaseTokenizer.md | 5 + .../api/AnalysisMappingCharFilter.md | 7 + .../api/AnalysisMinHashTokenFilter.md | 9 + .../api/AnalysisMultiplexerTokenFilter.md | 7 + .../reference/api/AnalysisNGramTokenFilter.md | 8 + docs/reference/api/AnalysisNGramTokenizer.md | 9 + docs/reference/api/AnalysisNoriAnalyzer.md | 9 + .../api/AnalysisNoriDecompoundMode.md | 4 + .../AnalysisNoriPartOfSpeechTokenFilter.md | 6 + docs/reference/api/AnalysisNoriTokenizer.md | 9 + docs/reference/api/AnalysisNormalizer.md | 4 + .../api/AnalysisNorwegianAnalyzer.md | 8 + .../api/AnalysisPathHierarchyTokenizer.md | 10 + docs/reference/api/AnalysisPatternAnalyzer.md | 11 + .../api/AnalysisPatternCaptureTokenFilter.md | 7 + .../api/AnalysisPatternReplaceCharFilter.md | 8 + .../api/AnalysisPatternReplaceTokenFilter.md | 8 + .../reference/api/AnalysisPatternTokenizer.md | 8 + docs/reference/api/AnalysisPersianAnalyzer.md | 7 + ...AnalysisPersianNormalizationTokenFilter.md | 5 + docs/reference/api/AnalysisPhoneticEncoder.md | 4 + .../reference/api/AnalysisPhoneticLanguage.md | 4 + .../reference/api/AnalysisPhoneticNameType.md | 4 + .../reference/api/AnalysisPhoneticRuleType.md | 4 + .../api/AnalysisPhoneticTokenFilter.md | 11 + .../api/AnalysisPorterStemTokenFilter.md | 5 + .../api/AnalysisPortugueseAnalyzer.md | 8 + .../api/AnalysisPredicateTokenFilter.md | 6 + .../AnalysisRemoveDuplicatesTokenFilter.md | 5 + .../api/AnalysisReverseTokenFilter.md | 5 + .../reference/api/AnalysisRomanianAnalyzer.md | 8 + docs/reference/api/AnalysisRussianAnalyzer.md | 8 + .../AnalysisScandinavianFoldingTokenFilter.md | 5 + ...sisScandinavianNormalizationTokenFilter.md | 5 + docs/reference/api/AnalysisSerbianAnalyzer.md | 8 + ...AnalysisSerbianNormalizationTokenFilter.md | 5 + .../api/AnalysisShingleTokenFilter.md | 11 + docs/reference/api/AnalysisSimpleAnalyzer.md | 6 + .../AnalysisSimplePatternSplitTokenizer.md | 6 + .../api/AnalysisSimplePatternTokenizer.md | 6 + .../reference/api/AnalysisSnowballAnalyzer.md | 8 + .../reference/api/AnalysisSnowballLanguage.md | 4 + .../api/AnalysisSnowballTokenFilter.md | 6 + docs/reference/api/AnalysisSoraniAnalyzer.md | 8 + .../AnalysisSoraniNormalizationTokenFilter.md | 5 + docs/reference/api/AnalysisSpanishAnalyzer.md | 8 + .../reference/api/AnalysisStandardAnalyzer.md | 8 + .../api/AnalysisStandardTokenizer.md | 6 + .../api/AnalysisStemmerOverrideTokenFilter.md | 7 + .../api/AnalysisStemmerTokenFilter.md | 7 + docs/reference/api/AnalysisStopAnalyzer.md | 8 + docs/reference/api/AnalysisStopTokenFilter.md | 9 + .../reference/api/AnalysisStopWordLanguage.md | 4 + docs/reference/api/AnalysisStopWords.md | 4 + docs/reference/api/AnalysisSwedishAnalyzer.md | 8 + docs/reference/api/AnalysisSynonymFormat.md | 4 + .../api/AnalysisSynonymGraphTokenFilter.md | 5 + .../api/AnalysisSynonymTokenFilter.md | 5 + .../api/AnalysisSynonymTokenFilterBase.md | 12 + docs/reference/api/AnalysisThaiAnalyzer.md | 7 + docs/reference/api/AnalysisThaiTokenizer.md | 5 + docs/reference/api/AnalysisTokenChar.md | 4 + docs/reference/api/AnalysisTokenFilter.md | 4 + docs/reference/api/AnalysisTokenFilterBase.md | 5 + .../api/AnalysisTokenFilterDefinition.md | 4 + docs/reference/api/AnalysisTokenizer.md | 4 + docs/reference/api/AnalysisTokenizerBase.md | 5 + .../api/AnalysisTokenizerDefinition.md | 4 + docs/reference/api/AnalysisTrimTokenFilter.md | 5 + .../api/AnalysisTruncateTokenFilter.md | 6 + docs/reference/api/AnalysisTurkishAnalyzer.md | 8 + .../api/AnalysisUaxEmailUrlTokenizer.md | 6 + .../api/AnalysisUniqueTokenFilter.md | 6 + .../api/AnalysisUppercaseTokenFilter.md | 5 + .../api/AnalysisWhitespaceAnalyzer.md | 6 + .../api/AnalysisWhitespaceTokenizer.md | 6 + .../AnalysisWordDelimiterGraphTokenFilter.md | 7 + .../api/AnalysisWordDelimiterTokenFilter.md | 5 + .../AnalysisWordDelimiterTokenFilterBase.md | 17 + docs/reference/api/AsyncSearch.md | 20 + docs/reference/api/AsyncSearchAsyncSearch.md | 18 + ...ncSearchAsyncSearchDocumentResponseBase.md | 5 + .../api/AsyncSearchAsyncSearchResponseBase.md | 13 + .../reference/api/AsyncSearchDeleteRequest.md | 7 + .../api/AsyncSearchDeleteResponse.md | 4 + docs/reference/api/AsyncSearchGetRequest.md | 10 + docs/reference/api/AsyncSearchGetResponse.md | 4 + .../reference/api/AsyncSearchStatusRequest.md | 8 + .../api/AsyncSearchStatusResponse.md | 4 + .../AsyncSearchStatusStatusResponseBase.md | 7 + .../reference/api/AsyncSearchSubmitRequest.md | 69 + .../api/AsyncSearchSubmitResponse.md | 4 + docs/reference/api/Autoscaling.md | 20 + .../api/AutoscalingAutoscalingPolicy.md | 6 + ...toscalingDeleteAutoscalingPolicyRequest.md | 9 + ...oscalingDeleteAutoscalingPolicyResponse.md | 4 + ...tAutoscalingCapacityAutoscalingCapacity.md | 6 + ...etAutoscalingCapacityAutoscalingDecider.md | 7 + ...tAutoscalingCapacityAutoscalingDeciders.md | 8 + ...ngGetAutoscalingCapacityAutoscalingNode.md | 5 + ...AutoscalingCapacityAutoscalingResources.md | 6 + ...utoscalingGetAutoscalingCapacityRequest.md | 7 + ...toscalingGetAutoscalingCapacityResponse.md | 5 + .../AutoscalingGetAutoscalingPolicyRequest.md | 8 + ...AutoscalingGetAutoscalingPolicyResponse.md | 4 + .../AutoscalingPutAutoscalingPolicyRequest.md | 10 + ...AutoscalingPutAutoscalingPolicyResponse.md | 4 + docs/reference/api/BulkApi_1.md | 3 + docs/reference/api/BulkApi_2.md | 3 + docs/reference/api/BulkApi_3.md | 3 + docs/reference/api/BulkCreateOperation.md | 4 + docs/reference/api/BulkDeleteOperation.md | 4 + docs/reference/api/BulkFailureStoreStatus.md | 4 + docs/reference/api/BulkHelper.md | 6 + docs/reference/api/BulkHelperOptions.md | 14 + .../reference/api/BulkIndexByScrollFailure.md | 8 + docs/reference/api/BulkIndexOperation.md | 4 + docs/reference/api/BulkOperationBase.md | 11 + docs/reference/api/BulkOperationContainer.md | 8 + docs/reference/api/BulkOperationType.md | 4 + docs/reference/api/BulkRequest.md | 20 + docs/reference/api/BulkResponse.md | 8 + docs/reference/api/BulkResponseItem.md | 16 + docs/reference/api/BulkStats.md | 13 + docs/reference/api/BulkUpdateAction.md | 11 + docs/reference/api/BulkUpdateOperation.md | 6 + docs/reference/api/BulkWriteOperation.md | 7 + docs/reference/api/ByteSize.md | 4 + docs/reference/api/Bytes.md | 4 + docs/reference/api/CapabilitiesApi_1.md | 3 + docs/reference/api/CapabilitiesApi_2.md | 3 + docs/reference/api/CapabilitiesApi_3.md | 3 + docs/reference/api/Cat.md | 20 + docs/reference/api/CatAliasesAliasesRecord.md | 21 + docs/reference/api/CatAliasesRequest.md | 11 + docs/reference/api/CatAliasesResponse.md | 4 + .../api/CatAllocationAllocationRecord.md | 37 + docs/reference/api/CatAllocationRequest.md | 12 + docs/reference/api/CatAllocationResponse.md | 4 + .../api/CatCatAnomalyDetectorColumn.md | 4 + .../api/CatCatAnonalyDetectorColumns.md | 4 + docs/reference/api/CatCatDatafeedColumn.md | 4 + docs/reference/api/CatCatDatafeedColumns.md | 4 + docs/reference/api/CatCatDfaColumn.md | 4 + docs/reference/api/CatCatDfaColumns.md | 4 + docs/reference/api/CatCatNodeColumn.md | 4 + docs/reference/api/CatCatNodeColumns.md | 4 + docs/reference/api/CatCatRequestBase.md | 4 + .../api/CatCatTrainedModelsColumn.md | 4 + .../api/CatCatTrainedModelsColumns.md | 4 + docs/reference/api/CatCatTransformColumn.md | 4 + docs/reference/api/CatCatTransformColumns.md | 4 + .../CatComponentTemplatesComponentTemplate.md | 11 + .../api/CatComponentTemplatesRequest.md | 11 + .../api/CatComponentTemplatesResponse.md | 4 + docs/reference/api/CatCountCountRecord.md | 15 + docs/reference/api/CatCountRequest.md | 9 + docs/reference/api/CatCountResponse.md | 4 + .../api/CatFielddataFielddataRecord.md | 13 + docs/reference/api/CatFielddataRequest.md | 10 + docs/reference/api/CatFielddataResponse.md | 4 + docs/reference/api/CatHealthHealthRecord.md | 54 + docs/reference/api/CatHealthRequest.md | 10 + docs/reference/api/CatHealthResponse.md | 4 + docs/reference/api/CatHelpRequest.md | 6 + docs/reference/api/CatHelpResponse.md | 4 + docs/reference/api/CatIndicesIndicesRecord.md | 292 + docs/reference/api/CatIndicesRequest.md | 16 + docs/reference/api/CatIndicesResponse.md | 4 + docs/reference/api/CatMasterMasterRecord.md | 10 + docs/reference/api/CatMasterRequest.md | 10 + docs/reference/api/CatMasterResponse.md | 4 + ...aFrameAnalyticsDataFrameAnalyticsRecord.md | 45 + .../api/CatMlDataFrameAnalyticsRequest.md | 12 + .../api/CatMlDataFrameAnalyticsResponse.md | 4 + .../api/CatMlDatafeedsDatafeedsRecord.md | 36 + docs/reference/api/CatMlDatafeedsRequest.md | 11 + docs/reference/api/CatMlDatafeedsResponse.md | 4 + docs/reference/api/CatMlJobsJobsRecord.md | 178 + docs/reference/api/CatMlJobsRequest.md | 12 + docs/reference/api/CatMlJobsResponse.md | 4 + .../api/CatMlTrainedModelsRequest.md | 14 + .../api/CatMlTrainedModelsResponse.md | 4 + .../CatMlTrainedModelsTrainedModelsRecord.md | 50 + .../api/CatNodeattrsNodeAttributesRecord.md | 14 + docs/reference/api/CatNodeattrsRequest.md | 10 + docs/reference/api/CatNodeattrsResponse.md | 4 + docs/reference/api/CatNodesNodesRecord.md | 271 + docs/reference/api/CatNodesRequest.md | 13 + docs/reference/api/CatNodesResponse.md | 4 + .../api/CatPendingTasksPendingTasksRecord.md | 12 + docs/reference/api/CatPendingTasksRequest.md | 11 + docs/reference/api/CatPendingTasksResponse.md | 4 + docs/reference/api/CatPluginsPluginsRecord.md | 15 + docs/reference/api/CatPluginsRequest.md | 11 + docs/reference/api/CatPluginsResponse.md | 4 + .../api/CatRecoveryRecoveryRecord.md | 59 + docs/reference/api/CatRecoveryRequest.md | 13 + docs/reference/api/CatRecoveryResponse.md | 4 + .../api/CatRepositoriesRepositoriesRecord.md | 8 + docs/reference/api/CatRepositoriesRequest.md | 10 + docs/reference/api/CatRepositoriesResponse.md | 4 + docs/reference/api/CatSegmentsRequest.md | 12 + docs/reference/api/CatSegmentsResponse.md | 4 + .../api/CatSegmentsSegmentsRecord.md | 43 + docs/reference/api/CatShardsRequest.md | 12 + docs/reference/api/CatShardsResponse.md | 4 + docs/reference/api/CatShardsShardsRecord.md | 216 + docs/reference/api/CatSnapshotsRequest.md | 12 + docs/reference/api/CatSnapshotsResponse.md | 4 + .../api/CatSnapshotsSnapshotsRecord.md | 35 + docs/reference/api/CatTasksRequest.md | 15 + docs/reference/api/CatTasksResponse.md | 4 + docs/reference/api/CatTasksTasksRecord.md | 36 + docs/reference/api/CatTemplatesRequest.md | 11 + docs/reference/api/CatTemplatesResponse.md | 4 + .../api/CatTemplatesTemplatesRecord.md | 15 + docs/reference/api/CatThreadPoolRequest.md | 12 + docs/reference/api/CatThreadPoolResponse.md | 4 + .../api/CatThreadPoolThreadPoolRecord.md | 44 + docs/reference/api/CatTransformsRequest.md | 13 + docs/reference/api/CatTransformsResponse.md | 4 + .../api/CatTransformsTransformsRecord.md | 76 + docs/reference/api/CategoryId.md | 4 + docs/reference/api/Ccr.md | 20 + .../api/CcrDeleteAutoFollowPatternRequest.md | 8 + .../api/CcrDeleteAutoFollowPatternResponse.md | 4 + docs/reference/api/CcrFollowIndexStats.md | 6 + .../api/CcrFollowInfoFollowerIndex.md | 9 + .../CcrFollowInfoFollowerIndexParameters.md | 14 + .../api/CcrFollowInfoFollowerIndexStatus.md | 4 + docs/reference/api/CcrFollowInfoRequest.md | 8 + docs/reference/api/CcrFollowInfoResponse.md | 5 + docs/reference/api/CcrFollowRequest.md | 23 + docs/reference/api/CcrFollowResponse.md | 7 + docs/reference/api/CcrFollowStatsRequest.md | 8 + docs/reference/api/CcrFollowStatsResponse.md | 5 + .../reference/api/CcrForgetFollowerRequest.md | 12 + .../api/CcrForgetFollowerResponse.md | 5 + ...crGetAutoFollowPatternAutoFollowPattern.md | 6 + ...toFollowPatternAutoFollowPatternSummary.md | 10 + .../api/CcrGetAutoFollowPatternRequest.md | 8 + .../api/CcrGetAutoFollowPatternResponse.md | 5 + .../api/CcrPauseAutoFollowPatternRequest.md | 8 + .../api/CcrPauseAutoFollowPatternResponse.md | 4 + docs/reference/api/CcrPauseFollowRequest.md | 8 + docs/reference/api/CcrPauseFollowResponse.md | 4 + .../api/CcrPutAutoFollowPatternRequest.md | 23 + .../api/CcrPutAutoFollowPatternResponse.md | 4 + docs/reference/api/CcrReadException.md | 7 + .../api/CcrResumeAutoFollowPatternRequest.md | 8 + .../api/CcrResumeAutoFollowPatternResponse.md | 4 + docs/reference/api/CcrResumeFollowRequest.md | 18 + docs/reference/api/CcrResumeFollowResponse.md | 4 + docs/reference/api/CcrShardStats.md | 37 + docs/reference/api/CcrStatsAutoFollowStats.md | 9 + .../api/CcrStatsAutoFollowedCluster.md | 7 + docs/reference/api/CcrStatsFollowStats.md | 5 + docs/reference/api/CcrStatsRequest.md | 8 + docs/reference/api/CcrStatsResponse.md | 6 + docs/reference/api/CcrUnfollowRequest.md | 8 + docs/reference/api/CcrUnfollowResponse.md | 4 + docs/reference/api/ClearScrollApi_1.md | 3 + docs/reference/api/ClearScrollApi_2.md | 3 + docs/reference/api/ClearScrollApi_3.md | 3 + docs/reference/api/ClearScrollRequest.md | 7 + docs/reference/api/ClearScrollResponse.md | 6 + docs/reference/api/Client.md | 24 + docs/reference/api/ClientOptions.md | 102 + docs/reference/api/ClosePointInTimeApi_1.md | 3 + docs/reference/api/ClosePointInTimeApi_2.md | 3 + docs/reference/api/ClosePointInTimeApi_3.md | 3 + docs/reference/api/ClosePointInTimeRequest.md | 7 + .../reference/api/ClosePointInTimeResponse.md | 6 + docs/reference/api/Cluster.md | 20 + docs/reference/api/ClusterAlias.md | 4 + ...sterAllocationExplainAllocationDecision.md | 7 + ...ocationExplainAllocationExplainDecision.md | 4 + ...ClusterAllocationExplainAllocationStore.md | 10 + .../ClusterAllocationExplainClusterInfo.md | 9 + .../ClusterAllocationExplainCurrentNode.md | 10 + .../api/ClusterAllocationExplainDecision.md | 4 + .../api/ClusterAllocationExplainDiskUsage.md | 10 + ...ocationExplainNodeAllocationExplanation.md | 13 + .../ClusterAllocationExplainNodeDiskUsage.md | 7 + .../api/ClusterAllocationExplainRequest.md | 13 + .../ClusterAllocationExplainReservedSize.md | 8 + .../api/ClusterAllocationExplainResponse.md | 29 + ...rAllocationExplainUnassignedInformation.md | 11 + ...ationExplainUnassignedInformationReason.md | 4 + .../reference/api/ClusterComponentTemplate.md | 6 + .../api/ClusterComponentTemplateNode.md | 8 + .../api/ClusterComponentTemplateSummary.md | 10 + .../ClusterDeleteComponentTemplateRequest.md | 9 + .../ClusterDeleteComponentTemplateResponse.md | 4 + ...sterDeleteVotingConfigExclusionsRequest.md | 8 + ...terDeleteVotingConfigExclusionsResponse.md | 4 + docs/reference/api/ClusterDetails.md | 10 + .../ClusterExistsComponentTemplateRequest.md | 9 + .../ClusterExistsComponentTemplateResponse.md | 4 + .../api/ClusterGetComponentTemplateRequest.md | 11 + .../ClusterGetComponentTemplateResponse.md | 5 + .../api/ClusterGetSettingsRequest.md | 10 + .../api/ClusterGetSettingsResponse.md | 7 + .../api/ClusterHealthHealthResponseBody.md | 23 + .../api/ClusterHealthIndexHealthStats.md | 14 + docs/reference/api/ClusterHealthRequest.md | 18 + docs/reference/api/ClusterHealthResponse.md | 4 + .../api/ClusterHealthShardHealthStats.md | 11 + .../api/ClusterHealthWaitForNodes.md | 4 + docs/reference/api/ClusterInfoRequest.md | 7 + docs/reference/api/ClusterInfoResponse.md | 9 + docs/reference/api/ClusterInfoTarget.md | 4 + docs/reference/api/ClusterInfoTargets.md | 4 + .../api/ClusterPendingTasksPendingTask.md | 10 + .../api/ClusterPendingTasksRequest.md | 8 + .../api/ClusterPendingTasksResponse.md | 5 + ...lusterPostVotingConfigExclusionsRequest.md | 10 + ...usterPostVotingConfigExclusionsResponse.md | 4 + .../api/ClusterPutComponentTemplateRequest.md | 13 + .../ClusterPutComponentTemplateResponse.md | 4 + .../api/ClusterPutSettingsRequest.md | 11 + .../api/ClusterPutSettingsResponse.md | 7 + .../api/ClusterRemoteInfoClusterRemoteInfo.md | 4 + ...ClusterRemoteInfoClusterRemoteProxyInfo.md | 13 + ...ClusterRemoteInfoClusterRemoteSniffInfo.md | 11 + .../reference/api/ClusterRemoteInfoRequest.md | 6 + .../api/ClusterRemoteInfoResponse.md | 4 + docs/reference/api/ClusterRerouteCommand.md | 9 + ...sterRerouteCommandAllocatePrimaryAction.md | 8 + ...sterRerouteCommandAllocateReplicaAction.md | 7 + .../api/ClusterRerouteCommandCancelAction.md | 8 + .../api/ClusterRerouteCommandMoveAction.md | 8 + docs/reference/api/ClusterRerouteRequest.md | 13 + .../api/ClusterRerouteRerouteDecision.md | 7 + .../api/ClusterRerouteRerouteExplanation.md | 7 + .../api/ClusterRerouteRerouteParameters.md | 10 + docs/reference/api/ClusterRerouteResponse.md | 7 + docs/reference/api/ClusterSearchStatus.md | 4 + docs/reference/api/ClusterStateRequest.md | 16 + docs/reference/api/ClusterStateResponse.md | 4 + docs/reference/api/ClusterStatistics.md | 11 + docs/reference/api/ClusterStatsCCSStats.md | 7 + .../api/ClusterStatsCCSUsageClusterStats.md | 7 + .../api/ClusterStatsCCSUsageStats.md | 16 + .../api/ClusterStatsCCSUsageTimeValue.md | 7 + .../api/ClusterStatsCharFilterTypes.md | 12 + .../api/ClusterStatsClusterFileSystem.md | 7 + .../api/ClusterStatsClusterIndices.md | 15 + .../api/ClusterStatsClusterIndicesShards.md | 8 + .../ClusterStatsClusterIndicesShardsIndex.md | 7 + .../api/ClusterStatsClusterIngest.md | 6 + docs/reference/api/ClusterStatsClusterJvm.md | 8 + .../api/ClusterStatsClusterJvmMemory.md | 6 + .../api/ClusterStatsClusterJvmVersion.md | 11 + .../api/ClusterStatsClusterNetworkTypes.md | 6 + .../api/ClusterStatsClusterNodeCount.md | 18 + .../reference/api/ClusterStatsClusterNodes.md | 16 + .../api/ClusterStatsClusterOperatingSystem.md | 10 + ...StatsClusterOperatingSystemArchitecture.md | 6 + .../ClusterStatsClusterOperatingSystemName.md | 6 + ...erStatsClusterOperatingSystemPrettyName.md | 6 + .../api/ClusterStatsClusterProcess.md | 6 + .../api/ClusterStatsClusterProcessCpu.md | 5 + ...rStatsClusterProcessOpenFileDescriptors.md | 7 + .../api/ClusterStatsClusterProcessor.md | 9 + .../api/ClusterStatsClusterShardMetrics.md | 7 + docs/reference/api/ClusterStatsFieldTypes.md | 11 + .../api/ClusterStatsFieldTypesMappings.md | 10 + .../api/ClusterStatsIndexingPressure.md | 5 + .../api/ClusterStatsIndexingPressureMemory.md | 7 + ...usterStatsIndexingPressureMemorySummary.md | 12 + .../api/ClusterStatsIndicesVersions.md | 8 + .../api/ClusterStatsNodePackagingType.md | 7 + .../ClusterStatsOperatingSystemMemoryInfo.md | 10 + .../api/ClusterStatsRemoteClusterInfo.md | 19 + docs/reference/api/ClusterStatsRequest.md | 9 + docs/reference/api/ClusterStatsResponse.md | 4 + .../api/ClusterStatsRuntimeFieldTypes.md | 18 + .../api/ClusterStatsStatsResponseBase.md | 11 + docs/reference/api/CompletionStats.md | 7 + docs/reference/api/Conflicts.md | 4 + docs/reference/api/Connector.md | 20 + docs/reference/api/ConnectorCheckInRequest.md | 7 + .../reference/api/ConnectorCheckInResponse.md | 5 + docs/reference/api/ConnectorConnector.md | 35 + .../api/ConnectorConnectorConfigProperties.md | 19 + .../api/ConnectorConnectorConfiguration.md | 4 + .../api/ConnectorConnectorCustomScheduling.md | 4 + .../api/ConnectorConnectorFeatures.md | 8 + .../api/ConnectorConnectorFieldType.md | 4 + .../api/ConnectorConnectorScheduling.md | 6 + .../reference/api/ConnectorConnectorStatus.md | 4 + .../api/ConnectorConnectorSyncJob.md | 22 + .../api/ConnectorCustomScheduling.md | 9 + ...rCustomSchedulingConfigurationOverrides.md | 9 + docs/reference/api/ConnectorDeleteRequest.md | 9 + docs/reference/api/ConnectorDeleteResponse.md | 4 + docs/reference/api/ConnectorDependency.md | 6 + docs/reference/api/ConnectorDisplayType.md | 4 + docs/reference/api/ConnectorFeatureEnabled.md | 5 + .../api/ConnectorFilteringAdvancedSnippet.md | 7 + .../reference/api/ConnectorFilteringConfig.md | 7 + .../reference/api/ConnectorFilteringPolicy.md | 4 + docs/reference/api/ConnectorFilteringRule.md | 12 + .../api/ConnectorFilteringRuleRule.md | 4 + docs/reference/api/ConnectorFilteringRules.md | 7 + .../api/ConnectorFilteringRulesValidation.md | 6 + .../api/ConnectorFilteringValidation.md | 6 + .../api/ConnectorFilteringValidationState.md | 4 + docs/reference/api/ConnectorGetRequest.md | 8 + docs/reference/api/ConnectorGetResponse.md | 4 + .../api/ConnectorGreaterThanValidation.md | 6 + .../api/ConnectorIncludedInValidation.md | 6 + .../api/ConnectorIngestPipelineParams.md | 8 + .../reference/api/ConnectorLastSyncRequest.md | 19 + .../api/ConnectorLastSyncResponse.md | 5 + .../api/ConnectorLessThanValidation.md | 6 + docs/reference/api/ConnectorListRequest.md | 13 + docs/reference/api/ConnectorListResponse.md | 6 + .../api/ConnectorListTypeValidation.md | 6 + docs/reference/api/ConnectorPostRequest.md | 12 + docs/reference/api/ConnectorPostResponse.md | 6 + docs/reference/api/ConnectorPutRequest.md | 13 + docs/reference/api/ConnectorPutResponse.md | 6 + .../reference/api/ConnectorRegexValidation.md | 6 + .../api/ConnectorSchedulingConfiguration.md | 7 + docs/reference/api/ConnectorSelectOption.md | 6 + .../api/ConnectorSyncJobCancelRequest.md | 7 + .../api/ConnectorSyncJobCancelResponse.md | 5 + .../api/ConnectorSyncJobCheckInRequest.md | 7 + .../api/ConnectorSyncJobCheckInResponse.md | 4 + .../api/ConnectorSyncJobClaimRequest.md | 9 + .../api/ConnectorSyncJobClaimResponse.md | 4 + .../api/ConnectorSyncJobConnectorReference.md | 12 + .../api/ConnectorSyncJobDeleteRequest.md | 7 + .../api/ConnectorSyncJobDeleteResponse.md | 4 + .../api/ConnectorSyncJobErrorRequest.md | 8 + .../api/ConnectorSyncJobErrorResponse.md | 4 + .../api/ConnectorSyncJobGetRequest.md | 7 + .../api/ConnectorSyncJobGetResponse.md | 4 + .../api/ConnectorSyncJobListRequest.md | 11 + .../api/ConnectorSyncJobListResponse.md | 6 + .../api/ConnectorSyncJobPostRequest.md | 9 + .../api/ConnectorSyncJobPostResponse.md | 5 + .../api/ConnectorSyncJobTriggerMethod.md | 4 + docs/reference/api/ConnectorSyncJobType.md | 4 + .../api/ConnectorSyncJobUpdateStatsRequest.md | 13 + .../ConnectorSyncJobUpdateStatsResponse.md | 4 + .../api/ConnectorSyncRulesFeature.md | 6 + docs/reference/api/ConnectorSyncStatus.md | 4 + .../ConnectorUpdateActiveFilteringRequest.md | 7 + .../ConnectorUpdateActiveFilteringResponse.md | 5 + .../api/ConnectorUpdateApiKeyIdRequest.md | 9 + .../api/ConnectorUpdateApiKeyIdResponse.md | 5 + .../ConnectorUpdateConfigurationRequest.md | 9 + .../ConnectorUpdateConfigurationResponse.md | 5 + .../api/ConnectorUpdateErrorRequest.md | 8 + .../api/ConnectorUpdateErrorResponse.md | 5 + .../api/ConnectorUpdateFeaturesRequest.md | 8 + .../api/ConnectorUpdateFeaturesResponse.md | 5 + .../api/ConnectorUpdateFilteringRequest.md | 10 + .../api/ConnectorUpdateFilteringResponse.md | 5 + ...nnectorUpdateFilteringValidationRequest.md | 8 + ...nectorUpdateFilteringValidationResponse.md | 5 + .../api/ConnectorUpdateIndexNameRequest.md | 8 + .../api/ConnectorUpdateIndexNameResponse.md | 5 + .../api/ConnectorUpdateNameRequest.md | 9 + .../api/ConnectorUpdateNameResponse.md | 5 + .../api/ConnectorUpdateNativeRequest.md | 8 + .../api/ConnectorUpdateNativeResponse.md | 5 + .../api/ConnectorUpdatePipelineRequest.md | 8 + .../api/ConnectorUpdatePipelineResponse.md | 5 + .../api/ConnectorUpdateSchedulingRequest.md | 8 + .../api/ConnectorUpdateSchedulingResponse.md | 5 + .../api/ConnectorUpdateServiceTypeRequest.md | 8 + .../api/ConnectorUpdateServiceTypeResponse.md | 5 + .../api/ConnectorUpdateStatusRequest.md | 8 + .../api/ConnectorUpdateStatusResponse.md | 5 + docs/reference/api/ConnectorValidation.md | 4 + docs/reference/api/CoordsGeoBounds.md | 8 + docs/reference/api/CountApi_1.md | 3 + docs/reference/api/CountApi_2.md | 3 + docs/reference/api/CountApi_3.md | 3 + docs/reference/api/CountRequest.md | 22 + docs/reference/api/CountResponse.md | 6 + docs/reference/api/CreateAction.md | 4 + docs/reference/api/CreateActionOperation.md | 5 + docs/reference/api/CreateApi_1.md | 3 + docs/reference/api/CreateApi_2.md | 3 + docs/reference/api/CreateApi_3.md | 3 + docs/reference/api/CreateRequest.md | 22 + docs/reference/api/CreateResponse.md | 4 + docs/reference/api/DFIIndependenceMeasure.md | 4 + docs/reference/api/DFRAfterEffect.md | 4 + docs/reference/api/DFRBasicModel.md | 4 + docs/reference/api/DanglingIndices.md | 20 + ...nglingIndicesDeleteDanglingIndexRequest.md | 10 + ...glingIndicesDeleteDanglingIndexResponse.md | 4 + ...nglingIndicesImportDanglingIndexRequest.md | 10 + ...glingIndicesImportDanglingIndexResponse.md | 4 + ...IndicesListDanglingIndicesDanglingIndex.md | 8 + ...nglingIndicesListDanglingIndicesRequest.md | 6 + ...glingIndicesListDanglingIndicesResponse.md | 5 + docs/reference/api/DataStreamName.md | 4 + docs/reference/api/DataStreamNames.md | 4 + docs/reference/api/DateFormat.md | 4 + docs/reference/api/DateMath.md | 4 + docs/reference/api/DateTime.md | 4 + docs/reference/api/DeleteAction.md | 5 + docs/reference/api/DeleteApi_1.md | 3 + docs/reference/api/DeleteApi_2.md | 3 + docs/reference/api/DeleteApi_3.md | 3 + docs/reference/api/DeleteByQueryApi_1.md | 3 + docs/reference/api/DeleteByQueryApi_2.md | 3 + docs/reference/api/DeleteByQueryApi_3.md | 3 + docs/reference/api/DeleteByQueryRequest.md | 38 + docs/reference/api/DeleteByQueryResponse.md | 20 + .../api/DeleteByQueryRethrottleApi_1.md | 3 + .../api/DeleteByQueryRethrottleApi_2.md | 3 + .../api/DeleteByQueryRethrottleApi_3.md | 3 + .../api/DeleteByQueryRethrottleRequest.md | 8 + .../api/DeleteByQueryRethrottleResponse.md | 4 + docs/reference/api/DeleteRequest.md | 16 + docs/reference/api/DeleteResponse.md | 4 + docs/reference/api/DeleteScriptApi_1.md | 3 + docs/reference/api/DeleteScriptApi_2.md | 3 + docs/reference/api/DeleteScriptApi_3.md | 3 + docs/reference/api/DeleteScriptRequest.md | 9 + docs/reference/api/DeleteScriptResponse.md | 4 + docs/reference/api/Distance.md | 4 + docs/reference/api/DistanceUnit.md | 4 + docs/reference/api/DocStats.md | 6 + docs/reference/api/Duration.md | 4 + docs/reference/api/DurationLarge.md | 4 + docs/reference/api/DurationValue.md | 4 + .../reference/api/ElasticsearchVersionInfo.md | 13 + .../api/ElasticsearchVersionMinInfo.md | 8 + docs/reference/api/EmptyObject.md | 4 + docs/reference/api/Enrich.md | 20 + .../api/EnrichDeletePolicyRequest.md | 8 + .../api/EnrichDeletePolicyResponse.md | 4 + .../EnrichExecutePolicyEnrichPolicyPhase.md | 4 + ...hExecutePolicyExecuteEnrichPolicyStatus.md | 6 + .../api/EnrichExecutePolicyRequest.md | 9 + .../api/EnrichExecutePolicyResponse.md | 6 + docs/reference/api/EnrichGetPolicyRequest.md | 8 + docs/reference/api/EnrichGetPolicyResponse.md | 5 + docs/reference/api/EnrichPolicy.md | 10 + docs/reference/api/EnrichPolicyType.md | 4 + docs/reference/api/EnrichPutPolicyRequest.md | 11 + docs/reference/api/EnrichPutPolicyResponse.md | 4 + docs/reference/api/EnrichStatsCacheStats.md | 12 + .../api/EnrichStatsCoordinatorStats.md | 9 + .../api/EnrichStatsExecutingPolicy.md | 6 + docs/reference/api/EnrichStatsRequest.md | 7 + docs/reference/api/EnrichStatsResponse.md | 7 + docs/reference/api/EnrichSummary.md | 5 + docs/reference/api/EpochTime.md | 4 + docs/reference/api/Eql.md | 20 + docs/reference/api/EqlDeleteRequest.md | 7 + docs/reference/api/EqlDeleteResponse.md | 4 + docs/reference/api/EqlEqlHits.md | 7 + .../reference/api/EqlEqlSearchResponseBase.md | 11 + docs/reference/api/EqlGetRequest.md | 9 + docs/reference/api/EqlGetResponse.md | 4 + docs/reference/api/EqlGetStatusRequest.md | 7 + docs/reference/api/EqlGetStatusResponse.md | 10 + docs/reference/api/EqlHitsEvent.md | 9 + docs/reference/api/EqlHitsSequence.md | 6 + docs/reference/api/EqlSearchRequest.md | 27 + docs/reference/api/EqlSearchResponse.md | 4 + docs/reference/api/EqlSearchResultPosition.md | 4 + docs/reference/api/ErrorCause.md | 4 + docs/reference/api/ErrorCauseKeys.md | 10 + docs/reference/api/ErrorResponseBase.md | 6 + docs/reference/api/Esql.md | 20 + docs/reference/api/EsqlAsyncEsqlResult.md | 6 + .../api/EsqlAsyncQueryDeleteRequest.md | 7 + .../api/EsqlAsyncQueryDeleteResponse.md | 4 + .../reference/api/EsqlAsyncQueryGetRequest.md | 10 + .../api/EsqlAsyncQueryGetResponse.md | 4 + docs/reference/api/EsqlAsyncQueryRequest.md | 21 + docs/reference/api/EsqlAsyncQueryResponse.md | 4 + .../api/EsqlAsyncQueryStopRequest.md | 8 + .../api/EsqlAsyncQueryStopResponse.md | 4 + docs/reference/api/EsqlColumn.md | 6 + docs/reference/api/EsqlEsqlClusterDetails.md | 8 + docs/reference/api/EsqlEsqlClusterInfo.md | 11 + docs/reference/api/EsqlEsqlClusterStatus.md | 4 + docs/reference/api/EsqlEsqlColumnInfo.md | 6 + docs/reference/api/EsqlEsqlFormat.md | 4 + docs/reference/api/EsqlEsqlResult.md | 11 + docs/reference/api/EsqlEsqlShardFailure.md | 8 + docs/reference/api/EsqlEsqlShardInfo.md | 9 + docs/reference/api/EsqlGetQueryRequest.md | 7 + docs/reference/api/EsqlGetQueryResponse.md | 11 + docs/reference/api/EsqlHelper.md | 7 + docs/reference/api/EsqlListQueriesBody.md | 9 + docs/reference/api/EsqlListQueriesRequest.md | 6 + docs/reference/api/EsqlListQueriesResponse.md | 5 + docs/reference/api/EsqlQueryRequest.md | 18 + docs/reference/api/EsqlQueryResponse.md | 4 + .../reference/api/EsqlTableValuesContainer.md | 8 + .../api/EsqlTableValuesIntegerValue.md | 4 + .../api/EsqlTableValuesKeywordValue.md | 4 + .../api/EsqlTableValuesLongDouble.md | 4 + .../reference/api/EsqlTableValuesLongValue.md | 4 + docs/reference/api/EsqlToRecords.md | 6 + docs/reference/api/ExistsApi_1.md | 3 + docs/reference/api/ExistsApi_2.md | 3 + docs/reference/api/ExistsApi_3.md | 3 + docs/reference/api/ExistsRequest.md | 18 + docs/reference/api/ExistsResponse.md | 4 + docs/reference/api/ExistsSourceApi_1.md | 3 + docs/reference/api/ExistsSourceApi_2.md | 3 + docs/reference/api/ExistsSourceApi_3.md | 3 + docs/reference/api/ExistsSourceRequest.md | 17 + docs/reference/api/ExistsSourceResponse.md | 4 + docs/reference/api/ExpandWildcard.md | 4 + docs/reference/api/ExpandWildcards.md | 4 + docs/reference/api/ExplainApi_1.md | 3 + docs/reference/api/ExplainApi_2.md | 3 + docs/reference/api/ExplainApi_3.md | 3 + docs/reference/api/ExplainExplanation.md | 7 + .../reference/api/ExplainExplanationDetail.md | 7 + docs/reference/api/ExplainRequest.md | 21 + docs/reference/api/ExplainResponse.md | 9 + docs/reference/api/Features.md | 20 + docs/reference/api/FeaturesFeature.md | 6 + .../api/FeaturesGetFeaturesRequest.md | 7 + .../api/FeaturesGetFeaturesResponse.md | 5 + .../api/FeaturesResetFeaturesRequest.md | 7 + .../api/FeaturesResetFeaturesResponse.md | 5 + docs/reference/api/Field.md | 4 + docs/reference/api/FieldCapsApi_1.md | 3 + docs/reference/api/FieldCapsApi_2.md | 3 + docs/reference/api/FieldCapsApi_3.md | 3 + .../reference/api/FieldCapsFieldCapability.md | 16 + docs/reference/api/FieldCapsRequest.md | 17 + docs/reference/api/FieldCapsResponse.md | 6 + docs/reference/api/FieldMemoryUsage.md | 6 + docs/reference/api/FieldSizeUsage.md | 6 + docs/reference/api/FieldSort.md | 11 + docs/reference/api/FieldSortNumericType.md | 4 + docs/reference/api/FieldValue.md | 4 + docs/reference/api/FielddataStats.md | 8 + docs/reference/api/Fields.md | 4 + docs/reference/api/Fleet.md | 20 + docs/reference/api/FleetCheckpoint.md | 4 + .../api/FleetGlobalCheckpointsRequest.md | 11 + .../api/FleetGlobalCheckpointsResponse.md | 6 + docs/reference/api/FleetMsearchRequest.md | 21 + docs/reference/api/FleetMsearchResponse.md | 5 + docs/reference/api/FleetSearchRequest.md | 68 + docs/reference/api/FleetSearchResponse.md | 18 + docs/reference/api/FlushStats.md | 8 + docs/reference/api/Fuzziness.md | 4 + docs/reference/api/GeoBounds.md | 4 + docs/reference/api/GeoDistanceSort.md | 4 + docs/reference/api/GeoDistanceSortKeys.md | 10 + docs/reference/api/GeoDistanceType.md | 4 + docs/reference/api/GeoHash.md | 4 + docs/reference/api/GeoHashLocation.md | 5 + docs/reference/api/GeoHashPrecision.md | 4 + docs/reference/api/GeoHexCell.md | 4 + docs/reference/api/GeoLine.md | 6 + docs/reference/api/GeoLocation.md | 4 + docs/reference/api/GeoShape.md | 4 + docs/reference/api/GeoShapeRelation.md | 4 + docs/reference/api/GeoTile.md | 4 + docs/reference/api/GeoTilePrecision.md | 4 + docs/reference/api/GetApi_1.md | 3 + docs/reference/api/GetApi_2.md | 3 + docs/reference/api/GetApi_3.md | 3 + docs/reference/api/GetGetResult.md | 14 + docs/reference/api/GetRequest.md | 19 + docs/reference/api/GetResponse.md | 4 + docs/reference/api/GetScriptApi_1.md | 3 + docs/reference/api/GetScriptApi_2.md | 3 + docs/reference/api/GetScriptApi_3.md | 3 + docs/reference/api/GetScriptContextApi_1.md | 3 + docs/reference/api/GetScriptContextApi_2.md | 3 + docs/reference/api/GetScriptContextApi_3.md | 3 + docs/reference/api/GetScriptContextContext.md | 6 + .../api/GetScriptContextContextMethod.md | 7 + .../api/GetScriptContextContextMethodParam.md | 6 + docs/reference/api/GetScriptContextRequest.md | 6 + .../reference/api/GetScriptContextResponse.md | 5 + docs/reference/api/GetScriptLanguagesApi_1.md | 3 + docs/reference/api/GetScriptLanguagesApi_2.md | 3 + docs/reference/api/GetScriptLanguagesApi_3.md | 3 + .../api/GetScriptLanguagesLanguageContext.md | 6 + .../api/GetScriptLanguagesRequest.md | 6 + .../api/GetScriptLanguagesResponse.md | 6 + docs/reference/api/GetScriptRequest.md | 8 + docs/reference/api/GetScriptResponse.md | 7 + docs/reference/api/GetSourceApi_1.md | 3 + docs/reference/api/GetSourceApi_2.md | 3 + docs/reference/api/GetSourceApi_3.md | 3 + docs/reference/api/GetSourceRequest.md | 18 + docs/reference/api/GetSourceResponse.md | 4 + docs/reference/api/GetStats.md | 14 + docs/reference/api/Graph.md | 20 + docs/reference/api/GraphConnection.md | 8 + docs/reference/api/GraphExploreControls.md | 8 + docs/reference/api/GraphExploreRequest.md | 13 + docs/reference/api/GraphExploreResponse.md | 9 + docs/reference/api/GraphHop.md | 7 + docs/reference/api/GraphSampleDiversity.md | 6 + docs/reference/api/GraphVertex.md | 8 + docs/reference/api/GraphVertexDefinition.md | 10 + docs/reference/api/GraphVertexInclude.md | 6 + docs/reference/api/GrokPattern.md | 4 + docs/reference/api/HealthReportApi_1.md | 3 + docs/reference/api/HealthReportApi_2.md | 3 + docs/reference/api/HealthReportApi_3.md | 3 + .../api/HealthReportBaseIndicator.md | 8 + .../HealthReportDataStreamLifecycleDetails.md | 7 + ...ealthReportDataStreamLifecycleIndicator.md | 5 + docs/reference/api/HealthReportDiagnosis.md | 9 + .../HealthReportDiagnosisAffectedResources.md | 9 + .../api/HealthReportDiskIndicator.md | 5 + .../api/HealthReportDiskIndicatorDetails.md | 9 + .../api/HealthReportFileSettingsIndicator.md | 5 + ...ealthReportFileSettingsIndicatorDetails.md | 6 + .../reference/api/HealthReportIlmIndicator.md | 5 + .../api/HealthReportIlmIndicatorDetails.md | 7 + docs/reference/api/HealthReportImpact.md | 8 + docs/reference/api/HealthReportImpactArea.md | 4 + .../api/HealthReportIndicatorHealthStatus.md | 4 + .../api/HealthReportIndicatorNode.md | 6 + docs/reference/api/HealthReportIndicators.md | 13 + .../HealthReportMasterIsStableIndicator.md | 5 + ...erIsStableIndicatorClusterFormationNode.md | 7 + ...lthReportMasterIsStableIndicatorDetails.md | 8 + ...StableIndicatorExceptionFetchingHistory.md | 6 + ...ealthReportRepositoryIntegrityIndicator.md | 5 + ...portRepositoryIntegrityIndicatorDetails.md | 7 + docs/reference/api/HealthReportRequest.md | 10 + docs/reference/api/HealthReportResponse.md | 7 + ...HealthReportShardsAvailabilityIndicator.md | 5 + ...eportShardsAvailabilityIndicatorDetails.md | 14 + .../HealthReportShardsCapacityIndicator.md | 5 + ...lthReportShardsCapacityIndicatorDetails.md | 6 + ...ReportShardsCapacityIndicatorTierDetail.md | 6 + .../reference/api/HealthReportSlmIndicator.md | 5 + .../api/HealthReportSlmIndicatorDetails.md | 7 + ...althReportSlmIndicatorUnhealthyPolicies.md | 6 + .../HealthReportStagnatingBackingIndices.md | 7 + docs/reference/api/HealthStatus.md | 4 + docs/reference/api/Helpers.md | 18 + docs/reference/api/HelpersOptions.md | 7 + docs/reference/api/Host.md | 4 + docs/reference/api/HttpHeaders.md | 4 + docs/reference/api/IBDistribution.md | 4 + docs/reference/api/IBLambda.md | 4 + docs/reference/api/Id.md | 4 + docs/reference/api/Ids.md | 4 + docs/reference/api/Ilm.md | 20 + docs/reference/api/IlmActions.md | 17 + docs/reference/api/IlmAllocateAction.md | 9 + docs/reference/api/IlmDeleteAction.md | 5 + .../api/IlmDeleteLifecycleRequest.md | 9 + .../api/IlmDeleteLifecycleResponse.md | 4 + docs/reference/api/IlmDownsampleAction.md | 6 + .../IlmExplainLifecycleLifecycleExplain.md | 4 + ...ExplainLifecycleLifecycleExplainManaged.md | 31 + ...LifecycleLifecycleExplainPhaseExecution.md | 8 + ...plainLifecycleLifecycleExplainUnmanaged.md | 6 + .../api/IlmExplainLifecycleRequest.md | 10 + .../api/IlmExplainLifecycleResponse.md | 5 + docs/reference/api/IlmForceMergeAction.md | 6 + .../reference/api/IlmGetLifecycleLifecycle.md | 7 + docs/reference/api/IlmGetLifecycleRequest.md | 9 + docs/reference/api/IlmGetLifecycleResponse.md | 4 + docs/reference/api/IlmGetStatusRequest.md | 6 + docs/reference/api/IlmGetStatusResponse.md | 5 + docs/reference/api/IlmMigrateAction.md | 5 + .../api/IlmMigrateToDataTiersRequest.md | 10 + .../api/IlmMigrateToDataTiersResponse.md | 11 + docs/reference/api/IlmMoveToStepRequest.md | 9 + docs/reference/api/IlmMoveToStepResponse.md | 4 + docs/reference/api/IlmMoveToStepStepKey.md | 7 + docs/reference/api/IlmPhase.md | 6 + docs/reference/api/IlmPhases.md | 9 + docs/reference/api/IlmPolicy.md | 6 + docs/reference/api/IlmPutLifecycleRequest.md | 10 + docs/reference/api/IlmPutLifecycleResponse.md | 4 + docs/reference/api/IlmRemovePolicyRequest.md | 7 + docs/reference/api/IlmRemovePolicyResponse.md | 6 + docs/reference/api/IlmRetryRequest.md | 7 + docs/reference/api/IlmRetryResponse.md | 4 + docs/reference/api/IlmRolloverAction.md | 14 + .../api/IlmSearchableSnapshotAction.md | 6 + docs/reference/api/IlmSetPriorityAction.md | 5 + docs/reference/api/IlmShrinkAction.md | 7 + docs/reference/api/IlmStartRequest.md | 8 + docs/reference/api/IlmStartResponse.md | 4 + docs/reference/api/IlmStopRequest.md | 8 + docs/reference/api/IlmStopResponse.md | 4 + .../reference/api/IlmWaitForSnapshotAction.md | 5 + docs/reference/api/IndexAction.md | 4 + docs/reference/api/IndexActionOperation.md | 5 + docs/reference/api/IndexAlias.md | 4 + docs/reference/api/IndexApi_1.md | 3 + docs/reference/api/IndexApi_2.md | 3 + docs/reference/api/IndexApi_3.md | 3 + docs/reference/api/IndexName.md | 4 + docs/reference/api/IndexPattern.md | 4 + docs/reference/api/IndexPatterns.md | 4 + docs/reference/api/IndexRequest.md | 21 + docs/reference/api/IndexResponse.md | 4 + docs/reference/api/IndexingStats.md | 21 + docs/reference/api/Indices.md | 4 + .../api/IndicesAddBlockIndicesBlockOptions.md | 4 + .../api/IndicesAddBlockIndicesBlockStatus.md | 6 + docs/reference/api/IndicesAddBlockRequest.md | 13 + docs/reference/api/IndicesAddBlockResponse.md | 7 + docs/reference/api/IndicesAlias.md | 10 + docs/reference/api/IndicesAliasDefinition.md | 10 + .../api/IndicesAnalyzeAnalyzeDetail.md | 9 + .../api/IndicesAnalyzeAnalyzeToken.md | 10 + .../api/IndicesAnalyzeAnalyzerDetail.md | 6 + .../api/IndicesAnalyzeCharFilterDetail.md | 6 + .../api/IndicesAnalyzeExplainAnalyzeToken.md | 4 + .../IndicesAnalyzeExplainAnalyzeTokenKeys.md | 13 + docs/reference/api/IndicesAnalyzeRequest.md | 16 + docs/reference/api/IndicesAnalyzeResponse.md | 6 + .../api/IndicesAnalyzeTextToAnalyze.md | 4 + .../api/IndicesAnalyzeTokenDetail.md | 6 + docs/reference/api/IndicesCacheQueries.md | 5 + .../api/IndicesCancelMigrateReindexRequest.md | 7 + .../IndicesCancelMigrateReindexResponse.md | 4 + .../reference/api/IndicesClearCacheRequest.md | 14 + .../api/IndicesClearCacheResponse.md | 4 + docs/reference/api/IndicesCloneRequest.md | 13 + docs/reference/api/IndicesCloneResponse.md | 7 + .../api/IndicesCloseCloseIndexResult.md | 6 + .../api/IndicesCloseCloseShardResult.md | 5 + docs/reference/api/IndicesCloseRequest.md | 13 + docs/reference/api/IndicesCloseResponse.md | 7 + .../api/IndicesCreateDataStreamRequest.md | 9 + .../api/IndicesCreateDataStreamResponse.md | 4 + .../api/IndicesCreateFromCreateFrom.md | 7 + .../reference/api/IndicesCreateFromRequest.md | 9 + .../api/IndicesCreateFromResponse.md | 7 + docs/reference/api/IndicesCreateRequest.md | 13 + docs/reference/api/IndicesCreateResponse.md | 7 + docs/reference/api/IndicesDataStream.md | 22 + docs/reference/api/IndicesDataStreamIndex.md | 10 + .../api/IndicesDataStreamLifecycle.md | 7 + .../IndicesDataStreamLifecycleDownsampling.md | 5 + ...esDataStreamLifecycleRolloverConditions.md | 14 + .../IndicesDataStreamLifecycleWithRollover.md | 5 + .../api/IndicesDataStreamTimestampField.md | 5 + .../api/IndicesDataStreamVisibility.md | 6 + ...cesDataStreamsStatsDataStreamsStatsItem.md | 9 + .../api/IndicesDataStreamsStatsRequest.md | 8 + .../api/IndicesDataStreamsStatsResponse.md | 10 + .../api/IndicesDeleteAliasRequest.md | 10 + .../api/IndicesDeleteAliasResponse.md | 4 + .../api/IndicesDeleteDataLifecycleRequest.md | 10 + .../api/IndicesDeleteDataLifecycleResponse.md | 4 + .../api/IndicesDeleteDataStreamRequest.md | 9 + .../api/IndicesDeleteDataStreamResponse.md | 4 + .../api/IndicesDeleteIndexTemplateRequest.md | 9 + .../api/IndicesDeleteIndexTemplateResponse.md | 4 + docs/reference/api/IndicesDeleteRequest.md | 12 + docs/reference/api/IndicesDeleteResponse.md | 4 + .../api/IndicesDeleteTemplateRequest.md | 9 + .../api/IndicesDeleteTemplateResponse.md | 4 + docs/reference/api/IndicesDiskUsageRequest.md | 12 + .../reference/api/IndicesDiskUsageResponse.md | 4 + docs/reference/api/IndicesDownsampleConfig.md | 5 + .../reference/api/IndicesDownsampleRequest.md | 9 + .../api/IndicesDownsampleResponse.md | 4 + .../reference/api/IndicesDownsamplingRound.md | 6 + .../api/IndicesExistsAliasRequest.md | 12 + .../api/IndicesExistsAliasResponse.md | 4 + .../api/IndicesExistsIndexTemplateRequest.md | 10 + .../api/IndicesExistsIndexTemplateResponse.md | 4 + docs/reference/api/IndicesExistsRequest.md | 13 + docs/reference/api/IndicesExistsResponse.md | 4 + .../api/IndicesExistsTemplateRequest.md | 10 + .../api/IndicesExistsTemplateResponse.md | 4 + ...DataLifecycleDataStreamLifecycleExplain.md | 13 + .../api/IndicesExplainDataLifecycleRequest.md | 9 + .../IndicesExplainDataLifecycleResponse.md | 5 + docs/reference/api/IndicesFailureStore.md | 7 + .../api/IndicesFieldUsageStatsFieldSummary.md | 12 + .../IndicesFieldUsageStatsFieldsUsageBody.md | 4 + ...dicesFieldUsageStatsFieldsUsageBodyKeys.md | 5 + .../IndicesFieldUsageStatsInvertedIndex.md | 11 + .../api/IndicesFieldUsageStatsRequest.md | 11 + .../api/IndicesFieldUsageStatsResponse.md | 4 + .../api/IndicesFieldUsageStatsShardsStats.md | 6 + .../IndicesFieldUsageStatsUsageStatsIndex.md | 5 + .../IndicesFieldUsageStatsUsageStatsShards.md | 8 + .../api/IndicesFielddataFrequencyFilter.md | 7 + docs/reference/api/IndicesFlushRequest.md | 12 + docs/reference/api/IndicesFlushResponse.md | 4 + ...IndicesForcemergeForceMergeResponseBody.md | 5 + .../reference/api/IndicesForcemergeRequest.md | 14 + .../api/IndicesForcemergeResponse.md | 4 + .../api/IndicesGetAliasIndexAliases.md | 5 + docs/reference/api/IndicesGetAliasRequest.md | 12 + docs/reference/api/IndicesGetAliasResponse.md | 4 + ...GetDataLifecycleDataStreamWithLifecycle.md | 6 + .../api/IndicesGetDataLifecycleRequest.md | 10 + .../api/IndicesGetDataLifecycleResponse.md | 5 + ...cesGetDataLifecycleStatsDataStreamStats.md | 7 + .../IndicesGetDataLifecycleStatsRequest.md | 6 + .../IndicesGetDataLifecycleStatsResponse.md | 8 + .../api/IndicesGetDataStreamRequest.md | 11 + .../api/IndicesGetDataStreamResponse.md | 5 + docs/reference/api/IndicesGetFeature.md | 4 + docs/reference/api/IndicesGetFeatures.md | 4 + .../api/IndicesGetFieldMappingRequest.md | 12 + .../api/IndicesGetFieldMappingResponse.md | 4 + ...IndicesGetFieldMappingTypeFieldMappings.md | 5 + ...ndicesGetIndexTemplateIndexTemplateItem.md | 6 + .../api/IndicesGetIndexTemplateRequest.md | 11 + .../api/IndicesGetIndexTemplateResponse.md | 5 + .../IndicesGetMappingIndexMappingRecord.md | 6 + .../reference/api/IndicesGetMappingRequest.md | 12 + .../api/IndicesGetMappingResponse.md | 4 + .../IndicesGetMigrateReindexStatusRequest.md | 7 + .../IndicesGetMigrateReindexStatusResponse.md | 14 + ...dicesGetMigrateReindexStatusStatusError.md | 6 + ...GetMigrateReindexStatusStatusInProgress.md | 7 + docs/reference/api/IndicesGetRequest.md | 15 + docs/reference/api/IndicesGetResponse.md | 4 + .../api/IndicesGetSettingsRequest.md | 15 + .../api/IndicesGetSettingsResponse.md | 4 + .../api/IndicesGetTemplateRequest.md | 10 + .../api/IndicesGetTemplateResponse.md | 4 + .../api/IndicesIndexCheckOnStartup.md | 4 + docs/reference/api/IndicesIndexMode.md | 4 + docs/reference/api/IndicesIndexRouting.md | 6 + .../api/IndicesIndexRoutingAllocation.md | 8 + .../api/IndicesIndexRoutingAllocationDisk.md | 5 + .../IndicesIndexRoutingAllocationInclude.md | 6 + ...esIndexRoutingAllocationInitialRecovery.md | 5 + .../IndicesIndexRoutingAllocationOptions.md | 4 + .../api/IndicesIndexRoutingRebalance.md | 5 + .../IndicesIndexRoutingRebalanceOptions.md | 4 + docs/reference/api/IndicesIndexSegmentSort.md | 8 + .../api/IndicesIndexSettingBlocks.md | 9 + docs/reference/api/IndicesIndexSettings.md | 4 + .../api/IndicesIndexSettingsAnalysis.md | 9 + .../reference/api/IndicesIndexSettingsKeys.md | 60 + .../api/IndicesIndexSettingsLifecycle.md | 11 + .../api/IndicesIndexSettingsLifecycleStep.md | 5 + .../api/IndicesIndexSettingsTimeSeries.md | 6 + docs/reference/api/IndicesIndexState.md | 10 + docs/reference/api/IndicesIndexTemplate.md | 14 + ...cesIndexTemplateDataStreamConfiguration.md | 6 + .../api/IndicesIndexTemplateSummary.md | 8 + docs/reference/api/IndicesIndexVersioning.md | 6 + docs/reference/api/IndicesIndexingPressure.md | 5 + .../api/IndicesIndexingPressureMemory.md | 5 + .../api/IndicesIndexingSlowlogSettings.md | 8 + .../api/IndicesIndexingSlowlogTresholds.md | 5 + docs/reference/api/IndicesManagedBy.md | 4 + .../api/IndicesMappingLimitSettings.md | 13 + .../api/IndicesMappingLimitSettingsDepth.md | 5 + ...icesMappingLimitSettingsDimensionFields.md | 5 + ...icesMappingLimitSettingsFieldNameLength.md | 5 + ...IndicesMappingLimitSettingsNestedFields.md | 5 + ...ndicesMappingLimitSettingsNestedObjects.md | 5 + ...IndicesMappingLimitSettingsSourceFields.md | 5 + .../IndicesMappingLimitSettingsTotalFields.md | 6 + docs/reference/api/IndicesMerge.md | 5 + docs/reference/api/IndicesMergeScheduler.md | 6 + .../IndicesMigrateReindexMigrateReindex.md | 6 + .../api/IndicesMigrateReindexModeEnum.md | 4 + .../api/IndicesMigrateReindexRequest.md | 7 + .../api/IndicesMigrateReindexResponse.md | 4 + .../api/IndicesMigrateReindexSourceIndex.md | 5 + .../api/IndicesMigrateToDataStreamRequest.md | 9 + .../api/IndicesMigrateToDataStreamResponse.md | 4 + .../api/IndicesModifyDataStreamAction.md | 6 + ...odifyDataStreamIndexAndDataStreamAction.md | 6 + .../api/IndicesModifyDataStreamRequest.md | 7 + .../api/IndicesModifyDataStreamResponse.md | 4 + docs/reference/api/IndicesNumericFielddata.md | 5 + .../api/IndicesNumericFielddataFormat.md | 4 + docs/reference/api/IndicesOpenRequest.md | 13 + docs/reference/api/IndicesOpenResponse.md | 6 + docs/reference/api/IndicesOptions.md | 8 + .../api/IndicesPromoteDataStreamRequest.md | 8 + .../api/IndicesPromoteDataStreamResponse.md | 4 + docs/reference/api/IndicesPutAliasRequest.md | 15 + docs/reference/api/IndicesPutAliasResponse.md | 4 + .../api/IndicesPutDataLifecycleRequest.md | 13 + .../api/IndicesPutDataLifecycleResponse.md | 4 + ...cesPutIndexTemplateIndexTemplateMapping.md | 8 + .../api/IndicesPutIndexTemplateRequest.md | 20 + .../api/IndicesPutIndexTemplateResponse.md | 4 + .../reference/api/IndicesPutMappingRequest.md | 24 + .../api/IndicesPutMappingResponse.md | 4 + .../api/IndicesPutSettingsRequest.md | 16 + .../api/IndicesPutSettingsResponse.md | 4 + .../api/IndicesPutTemplateRequest.md | 16 + .../api/IndicesPutTemplateResponse.md | 4 + docs/reference/api/IndicesQueries.md | 5 + .../api/IndicesRecoveryFileDetails.md | 7 + .../api/IndicesRecoveryRecoveryBytes.md | 13 + .../api/IndicesRecoveryRecoveryFiles.md | 9 + .../api/IndicesRecoveryRecoveryIndexStatus.md | 13 + .../api/IndicesRecoveryRecoveryOrigin.md | 16 + .../api/IndicesRecoveryRecoveryStartStatus.md | 8 + .../api/IndicesRecoveryRecoveryStatus.md | 5 + docs/reference/api/IndicesRecoveryRequest.md | 9 + docs/reference/api/IndicesRecoveryResponse.md | 4 + .../api/IndicesRecoveryShardRecovery.md | 20 + .../api/IndicesRecoveryTranslogStatus.md | 10 + .../api/IndicesRecoveryVerifyIndex.md | 8 + docs/reference/api/IndicesRefreshRequest.md | 10 + docs/reference/api/IndicesRefreshResponse.md | 4 + ...dicesReloadSearchAnalyzersReloadDetails.md | 7 + ...ndicesReloadSearchAnalyzersReloadResult.md | 6 + .../IndicesReloadSearchAnalyzersRequest.md | 11 + .../IndicesReloadSearchAnalyzersResponse.md | 4 + .../api/IndicesResolveClusterRequest.md | 12 + ...IndicesResolveClusterResolveClusterInfo.md | 9 + .../api/IndicesResolveClusterResponse.md | 4 + .../api/IndicesResolveIndexRequest.md | 10 + ...ndicesResolveIndexResolveIndexAliasItem.md | 6 + ...ResolveIndexResolveIndexDataStreamsItem.md | 7 + .../IndicesResolveIndexResolveIndexItem.md | 8 + .../api/IndicesResolveIndexResponse.md | 7 + docs/reference/api/IndicesResponseBase.md | 5 + docs/reference/api/IndicesRetentionLease.md | 5 + docs/reference/api/IndicesRolloverRequest.md | 17 + docs/reference/api/IndicesRolloverResponse.md | 11 + .../api/IndicesRolloverRolloverConditions.md | 19 + docs/reference/api/IndicesSearchIdle.md | 5 + .../api/IndicesSegmentSortMissing.md | 4 + docs/reference/api/IndicesSegmentSortMode.md | 4 + docs/reference/api/IndicesSegmentSortOrder.md | 4 + .../api/IndicesSegmentsIndexSegment.md | 5 + docs/reference/api/IndicesSegmentsRequest.md | 10 + docs/reference/api/IndicesSegmentsResponse.md | 6 + docs/reference/api/IndicesSegmentsSegment.md | 13 + .../api/IndicesSegmentsShardSegmentRouting.md | 7 + .../api/IndicesSegmentsShardsSegment.md | 8 + docs/reference/api/IndicesSettingsAnalyze.md | 5 + .../reference/api/IndicesSettingsHighlight.md | 5 + .../api/IndicesSettingsQueryString.md | 5 + docs/reference/api/IndicesSettingsSearch.md | 6 + .../api/IndicesSettingsSimilarity.md | 4 + .../api/IndicesSettingsSimilarityBm25.md | 8 + .../api/IndicesSettingsSimilarityBoolean.md | 5 + .../api/IndicesSettingsSimilarityDfi.md | 6 + .../api/IndicesSettingsSimilarityDfr.md | 8 + .../api/IndicesSettingsSimilarityIb.md | 8 + .../api/IndicesSettingsSimilarityLmd.md | 6 + .../api/IndicesSettingsSimilarityLmj.md | 6 + .../api/IndicesSettingsSimilarityScripted.md | 7 + .../IndicesShardStoresIndicesShardStores.md | 5 + .../api/IndicesShardStoresRequest.md | 11 + .../api/IndicesShardStoresResponse.md | 5 + .../api/IndicesShardStoresShardStore.md | 4 + .../IndicesShardStoresShardStoreAllocation.md | 4 + .../IndicesShardStoresShardStoreException.md | 6 + .../api/IndicesShardStoresShardStoreKeys.md | 7 + .../api/IndicesShardStoresShardStoreNode.md | 10 + .../api/IndicesShardStoresShardStoreStatus.md | 4 + .../IndicesShardStoresShardStoreWrapper.md | 5 + docs/reference/api/IndicesShrinkRequest.md | 13 + docs/reference/api/IndicesShrinkResponse.md | 7 + .../IndicesSimulateIndexTemplateRequest.md | 11 + .../IndicesSimulateIndexTemplateResponse.md | 6 + .../api/IndicesSimulateTemplateOverlapping.md | 6 + .../api/IndicesSimulateTemplateRequest.md | 21 + .../api/IndicesSimulateTemplateResponse.md | 6 + .../api/IndicesSimulateTemplateTemplate.md | 7 + docs/reference/api/IndicesSlowlogSettings.md | 8 + .../api/IndicesSlowlogTresholdLevels.md | 8 + docs/reference/api/IndicesSlowlogTresholds.md | 6 + docs/reference/api/IndicesSoftDeletes.md | 6 + docs/reference/api/IndicesSourceMode.md | 4 + docs/reference/api/IndicesSplitRequest.md | 13 + docs/reference/api/IndicesSplitResponse.md | 7 + .../api/IndicesStatsIndexMetadataState.md | 4 + docs/reference/api/IndicesStatsIndexStats.md | 23 + .../reference/api/IndicesStatsIndicesStats.md | 10 + .../reference/api/IndicesStatsMappingStats.md | 7 + docs/reference/api/IndicesStatsRequest.md | 17 + docs/reference/api/IndicesStatsResponse.md | 7 + docs/reference/api/IndicesStatsShardCommit.md | 8 + .../api/IndicesStatsShardFileSizeInfo.md | 10 + docs/reference/api/IndicesStatsShardLease.md | 8 + docs/reference/api/IndicesStatsShardPath.md | 7 + .../api/IndicesStatsShardQueryCache.md | 11 + .../api/IndicesStatsShardRetentionLeases.md | 7 + .../reference/api/IndicesStatsShardRouting.md | 8 + .../api/IndicesStatsShardRoutingState.md | 4 + .../api/IndicesStatsShardSequenceNumber.md | 7 + docs/reference/api/IndicesStatsShardStats.md | 30 + .../api/IndicesStatsShardsTotalStats.md | 5 + docs/reference/api/IndicesStorage.md | 6 + docs/reference/api/IndicesStorageType.md | 4 + docs/reference/api/IndicesTemplateMapping.md | 10 + docs/reference/api/IndicesTranslog.md | 8 + .../api/IndicesTranslogDurability.md | 4 + .../reference/api/IndicesTranslogRetention.md | 6 + .../api/IndicesUpdateAliasesAction.md | 7 + .../api/IndicesUpdateAliasesAddAction.md | 15 + .../api/IndicesUpdateAliasesRemoveAction.md | 9 + .../IndicesUpdateAliasesRemoveIndexAction.md | 7 + .../api/IndicesUpdateAliasesRequest.md | 9 + .../api/IndicesUpdateAliasesResponse.md | 4 + ...lidateQueryIndicesValidationExplanation.md | 8 + .../api/IndicesValidateQueryRequest.md | 20 + .../api/IndicesValidateQueryResponse.md | 8 + docs/reference/api/Inference.md | 20 + .../api/InferenceAdaptiveAllocations.md | 7 + .../InferenceAlibabaCloudServiceSettings.md | 9 + .../api/InferenceAlibabaCloudServiceType.md | 4 + .../api/InferenceAlibabaCloudTaskSettings.md | 6 + .../api/InferenceAlibabaCloudTaskType.md | 4 + .../InferenceAmazonBedrockServiceSettings.md | 10 + .../api/InferenceAmazonBedrockServiceType.md | 4 + .../api/InferenceAmazonBedrockTaskSettings.md | 8 + .../api/InferenceAmazonBedrockTaskType.md | 4 + .../api/InferenceAnthropicServiceSettings.md | 7 + .../api/InferenceAnthropicServiceType.md | 4 + .../api/InferenceAnthropicTaskSettings.md | 8 + .../api/InferenceAnthropicTaskType.md | 4 + .../InferenceAzureAiStudioServiceSettings.md | 9 + .../api/InferenceAzureAiStudioServiceType.md | 4 + .../api/InferenceAzureAiStudioTaskSettings.md | 9 + .../api/InferenceAzureAiStudioTaskType.md | 4 + .../InferenceAzureOpenAIServiceSettings.md | 10 + .../api/InferenceAzureOpenAIServiceType.md | 4 + .../api/InferenceAzureOpenAITaskSettings.md | 5 + .../api/InferenceAzureOpenAITaskType.md | 4 + .../InferenceChatCompletionUnifiedRequest.md | 9 + .../InferenceChatCompletionUnifiedResponse.md | 4 + .../api/InferenceCohereEmbeddingType.md | 4 + .../reference/api/InferenceCohereInputType.md | 4 + .../api/InferenceCohereServiceSettings.md | 9 + .../api/InferenceCohereServiceType.md | 4 + .../api/InferenceCohereSimilarityType.md | 4 + .../api/InferenceCohereTaskSettings.md | 8 + docs/reference/api/InferenceCohereTaskType.md | 4 + .../api/InferenceCohereTruncateType.md | 4 + .../api/InferenceCompletionInferenceResult.md | 5 + .../api/InferenceCompletionRequest.md | 10 + .../api/InferenceCompletionResponse.md | 4 + .../api/InferenceCompletionResult.md | 5 + docs/reference/api/InferenceCompletionTool.md | 6 + .../api/InferenceCompletionToolChoice.md | 6 + .../InferenceCompletionToolChoiceFunction.md | 5 + .../api/InferenceCompletionToolFunction.md | 8 + .../api/InferenceCompletionToolType.md | 4 + docs/reference/api/InferenceContentObject.md | 6 + .../InferenceDeleteInferenceEndpointResult.md | 5 + docs/reference/api/InferenceDeleteRequest.md | 10 + docs/reference/api/InferenceDeleteResponse.md | 4 + .../reference/api/InferenceDenseByteVector.md | 4 + docs/reference/api/InferenceDenseVector.md | 4 + .../InferenceElasticsearchServiceSettings.md | 9 + .../api/InferenceElasticsearchServiceType.md | 4 + .../api/InferenceElasticsearchTaskSettings.md | 5 + .../api/InferenceElasticsearchTaskType.md | 4 + .../api/InferenceElserServiceSettings.md | 7 + .../api/InferenceElserServiceType.md | 4 + docs/reference/api/InferenceElserTaskType.md | 4 + docs/reference/api/InferenceGetRequest.md | 8 + docs/reference/api/InferenceGetResponse.md | 5 + .../api/InferenceGoogleAiServiceType.md | 4 + .../InferenceGoogleAiStudioServiceSettings.md | 7 + .../api/InferenceGoogleAiStudioTaskType.md | 4 + .../InferenceGoogleVertexAIServiceSettings.md | 9 + .../api/InferenceGoogleVertexAIServiceType.md | 4 + .../InferenceGoogleVertexAITaskSettings.md | 6 + .../api/InferenceGoogleVertexAITaskType.md | 4 + .../InferenceHuggingFaceServiceSettings.md | 7 + .../api/InferenceHuggingFaceServiceType.md | 4 + .../api/InferenceHuggingFaceTaskType.md | 4 + .../api/InferenceInferenceChunkingSettings.md | 8 + .../api/InferenceInferenceEndpoint.md | 8 + .../api/InferenceInferenceEndpointInfo.md | 6 + .../api/InferenceInferenceRequest.md | 12 + .../api/InferenceInferenceResponse.md | 4 + .../reference/api/InferenceInferenceResult.md | 10 + .../api/InferenceJinaAIServiceSettings.md | 8 + .../api/InferenceJinaAIServiceType.md | 4 + .../api/InferenceJinaAISimilarityType.md | 4 + .../api/InferenceJinaAITaskSettings.md | 7 + docs/reference/api/InferenceJinaAITaskType.md | 4 + .../api/InferenceJinaAITextEmbeddingTask.md | 4 + docs/reference/api/InferenceMessage.md | 8 + docs/reference/api/InferenceMessageContent.md | 4 + .../api/InferenceMistralServiceSettings.md | 8 + .../api/InferenceMistralServiceType.md | 4 + .../reference/api/InferenceMistralTaskType.md | 4 + .../api/InferenceOpenAIServiceSettings.md | 10 + .../api/InferenceOpenAIServiceType.md | 4 + .../api/InferenceOpenAITaskSettings.md | 5 + docs/reference/api/InferenceOpenAITaskType.md | 4 + .../api/InferencePutAlibabacloudRequest.md | 12 + .../api/InferencePutAlibabacloudResponse.md | 4 + .../api/InferencePutAmazonbedrockRequest.md | 12 + .../api/InferencePutAmazonbedrockResponse.md | 4 + .../api/InferencePutAnthropicRequest.md | 12 + .../api/InferencePutAnthropicResponse.md | 4 + .../api/InferencePutAzureaistudioRequest.md | 12 + .../api/InferencePutAzureaistudioResponse.md | 4 + .../api/InferencePutAzureopenaiRequest.md | 12 + .../api/InferencePutAzureopenaiResponse.md | 4 + .../api/InferencePutCohereRequest.md | 12 + .../api/InferencePutCohereResponse.md | 4 + .../api/InferencePutElasticsearchRequest.md | 12 + .../api/InferencePutElasticsearchResponse.md | 4 + .../reference/api/InferencePutElserRequest.md | 11 + .../api/InferencePutElserResponse.md | 4 + .../api/InferencePutGoogleaistudioRequest.md | 11 + .../api/InferencePutGoogleaistudioResponse.md | 4 + .../api/InferencePutGooglevertexaiRequest.md | 12 + .../api/InferencePutGooglevertexaiResponse.md | 4 + .../api/InferencePutHuggingFaceRequest.md | 11 + .../api/InferencePutHuggingFaceResponse.md | 4 + .../api/InferencePutJinaaiRequest.md | 12 + .../api/InferencePutJinaaiResponse.md | 4 + .../api/InferencePutMistralRequest.md | 11 + .../api/InferencePutMistralResponse.md | 4 + .../api/InferencePutOpenaiRequest.md | 12 + .../api/InferencePutOpenaiResponse.md | 4 + docs/reference/api/InferencePutRequest.md | 9 + docs/reference/api/InferencePutResponse.md | 4 + .../api/InferencePutVoyageaiRequest.md | 12 + .../api/InferencePutVoyageaiResponse.md | 4 + .../api/InferencePutWatsonxRequest.md | 10 + .../api/InferencePutWatsonxResponse.md | 4 + docs/reference/api/InferenceRankedDocument.md | 7 + .../api/InferenceRateLimitSetting.md | 5 + .../api/InferenceRequestChatCompletion.md | 12 + docs/reference/api/InferenceRerankRequest.md | 11 + docs/reference/api/InferenceRerankResponse.md | 4 + .../api/InferenceRerankedInferenceResult.md | 5 + .../reference/api/InferenceServiceSettings.md | 4 + ...InferenceSparseEmbeddingInferenceResult.md | 5 + .../api/InferenceSparseEmbeddingRequest.md | 10 + .../api/InferenceSparseEmbeddingResponse.md | 4 + .../api/InferenceSparseEmbeddingResult.md | 5 + docs/reference/api/InferenceSparseVector.md | 4 + .../api/InferenceStreamCompletionRequest.md | 9 + .../api/InferenceStreamCompletionResponse.md | 4 + docs/reference/api/InferenceTaskSettings.md | 4 + docs/reference/api/InferenceTaskType.md | 4 + .../api/InferenceTextEmbeddingByteResult.md | 5 + .../InferenceTextEmbeddingInferenceResult.md | 7 + .../api/InferenceTextEmbeddingRequest.md | 10 + .../api/InferenceTextEmbeddingResponse.md | 4 + .../api/InferenceTextEmbeddingResult.md | 5 + docs/reference/api/InferenceToolCall.md | 7 + .../api/InferenceToolCallFunction.md | 6 + docs/reference/api/InferenceUpdateRequest.md | 9 + docs/reference/api/InferenceUpdateResponse.md | 4 + .../api/InferenceVoyageAIServiceSettings.md | 8 + .../api/InferenceVoyageAIServiceType.md | 4 + .../api/InferenceVoyageAITaskSettings.md | 8 + .../api/InferenceVoyageAITaskType.md | 4 + .../api/InferenceWatsonxServiceSettings.md | 10 + .../api/InferenceWatsonxServiceType.md | 4 + .../reference/api/InferenceWatsonxTaskType.md | 4 + docs/reference/api/InfoApi_1.md | 3 + docs/reference/api/InfoApi_2.md | 3 + docs/reference/api/InfoApi_3.md | 3 + docs/reference/api/InfoRequest.md | 6 + docs/reference/api/InfoResponse.md | 9 + docs/reference/api/Ingest.md | 20 + docs/reference/api/IngestAppendProcessor.md | 7 + .../api/IngestAttachmentProcessor.md | 12 + docs/reference/api/IngestBytesProcessor.md | 7 + docs/reference/api/IngestCircleProcessor.md | 9 + .../api/IngestCommunityIDProcessor.md | 15 + docs/reference/api/IngestConvertProcessor.md | 8 + docs/reference/api/IngestConvertType.md | 4 + docs/reference/api/IngestCsvProcessor.md | 11 + .../api/IngestDatabaseConfiguration.md | 7 + .../api/IngestDatabaseConfigurationFull.md | 9 + .../api/IngestDateIndexNameProcessor.md | 11 + docs/reference/api/IngestDateProcessor.md | 10 + .../api/IngestDeleteGeoipDatabaseRequest.md | 9 + .../api/IngestDeleteGeoipDatabaseResponse.md | 4 + .../IngestDeleteIpLocationDatabaseRequest.md | 9 + .../IngestDeleteIpLocationDatabaseResponse.md | 4 + .../api/IngestDeletePipelineRequest.md | 9 + .../api/IngestDeletePipelineResponse.md | 4 + docs/reference/api/IngestDissectProcessor.md | 8 + docs/reference/api/IngestDocument.md | 7 + .../reference/api/IngestDocumentSimulation.md | 4 + .../api/IngestDocumentSimulationKeys.md | 11 + .../api/IngestDotExpanderProcessor.md | 7 + docs/reference/api/IngestDropProcessor.md | 4 + docs/reference/api/IngestEnrichProcessor.md | 11 + docs/reference/api/IngestFailProcessor.md | 5 + docs/reference/api/IngestFingerprintDigest.md | 4 + .../api/IngestFingerprintProcessor.md | 9 + docs/reference/api/IngestForeachProcessor.md | 7 + docs/reference/api/IngestGeoGridProcessor.md | 13 + .../api/IngestGeoGridTargetFormat.md | 4 + docs/reference/api/IngestGeoGridTileType.md | 4 + docs/reference/api/IngestGeoIpProcessor.md | 11 + ...IngestGeoIpStatsGeoIpDownloadStatistics.md | 10 + .../IngestGeoIpStatsGeoIpNodeDatabaseName.md | 5 + .../api/IngestGeoIpStatsGeoIpNodeDatabases.md | 6 + docs/reference/api/IngestGeoIpStatsRequest.md | 6 + .../reference/api/IngestGeoIpStatsResponse.md | 6 + ...ipDatabaseDatabaseConfigurationMetadata.md | 8 + .../api/IngestGetGeoipDatabaseRequest.md | 7 + .../api/IngestGetGeoipDatabaseResponse.md | 5 + ...onDatabaseDatabaseConfigurationMetadata.md | 9 + .../api/IngestGetIpLocationDatabaseRequest.md | 8 + .../IngestGetIpLocationDatabaseResponse.md | 5 + .../reference/api/IngestGetPipelineRequest.md | 9 + .../api/IngestGetPipelineResponse.md | 4 + docs/reference/api/IngestGrokProcessor.md | 10 + docs/reference/api/IngestGsubProcessor.md | 9 + .../reference/api/IngestHtmlStripProcessor.md | 7 + docs/reference/api/IngestInferenceConfig.md | 6 + .../IngestInferenceConfigClassification.md | 9 + .../api/IngestInferenceConfigRegression.md | 6 + .../reference/api/IngestInferenceProcessor.md | 10 + docs/reference/api/IngestIngest.md | 7 + docs/reference/api/IngestInputConfig.md | 6 + .../api/IngestIpLocationProcessor.md | 11 + docs/reference/api/IngestIpinfo.md | 4 + docs/reference/api/IngestJoinProcessor.md | 7 + docs/reference/api/IngestJsonProcessor.md | 9 + .../IngestJsonProcessorConflictStrategy.md | 4 + docs/reference/api/IngestKeyValueProcessor.md | 15 + docs/reference/api/IngestLocal.md | 5 + .../reference/api/IngestLowercaseProcessor.md | 7 + docs/reference/api/IngestMaxmind.md | 5 + .../api/IngestNetworkDirectionProcessor.md | 10 + docs/reference/api/IngestPipeline.md | 10 + docs/reference/api/IngestPipelineConfig.md | 7 + docs/reference/api/IngestPipelineProcessor.md | 6 + .../api/IngestPipelineProcessorResult.md | 11 + .../IngestPipelineSimulationStatusOptions.md | 4 + docs/reference/api/IngestProcessorBase.md | 9 + .../reference/api/IngestProcessorContainer.md | 49 + .../api/IngestProcessorGrokRequest.md | 6 + .../api/IngestProcessorGrokResponse.md | 5 + .../api/IngestPutGeoipDatabaseRequest.md | 11 + .../api/IngestPutGeoipDatabaseResponse.md | 4 + .../api/IngestPutIpLocationDatabaseRequest.md | 10 + .../IngestPutIpLocationDatabaseResponse.md | 4 + .../reference/api/IngestPutPipelineRequest.md | 16 + .../api/IngestPutPipelineResponse.md | 4 + docs/reference/api/IngestRedact.md | 5 + docs/reference/api/IngestRedactProcessor.md | 12 + .../api/IngestRegisteredDomainProcessor.md | 7 + docs/reference/api/IngestRemoveProcessor.md | 7 + docs/reference/api/IngestRenameProcessor.md | 7 + docs/reference/api/IngestRerouteProcessor.md | 7 + docs/reference/api/IngestScriptProcessor.md | 8 + docs/reference/api/IngestSetProcessor.md | 10 + .../api/IngestSetSecurityUserProcessor.md | 6 + docs/reference/api/IngestShapeType.md | 4 + .../api/IngestSimulateDocumentResult.md | 7 + docs/reference/api/IngestSimulateRequest.md | 10 + docs/reference/api/IngestSimulateResponse.md | 5 + docs/reference/api/IngestSortProcessor.md | 7 + docs/reference/api/IngestSplitProcessor.md | 9 + .../reference/api/IngestTerminateProcessor.md | 4 + docs/reference/api/IngestTrimProcessor.md | 7 + .../reference/api/IngestUppercaseProcessor.md | 7 + docs/reference/api/IngestUriPartsProcessor.md | 9 + .../reference/api/IngestUrlDecodeProcessor.md | 7 + .../reference/api/IngestUserAgentProcessor.md | 10 + docs/reference/api/IngestUserAgentProperty.md | 4 + docs/reference/api/IngestWeb.md | 4 + docs/reference/api/InlineGet.md | 4 + docs/reference/api/InlineGetKeys.md | 10 + docs/reference/api/Ip.md | 4 + docs/reference/api/KnnQuery.md | 12 + docs/reference/api/KnnRetriever.md | 11 + docs/reference/api/KnnSearch.md | 14 + docs/reference/api/KnnSearchApi_1.md | 3 + docs/reference/api/KnnSearchApi_2.md | 3 + docs/reference/api/KnnSearchApi_3.md | 3 + docs/reference/api/LatLonGeoLocation.md | 6 + docs/reference/api/Level.md | 4 + docs/reference/api/License.md | 20 + docs/reference/api/LicenseDeleteRequest.md | 8 + docs/reference/api/LicenseDeleteResponse.md | 4 + .../api/LicenseGetBasicStatusRequest.md | 6 + .../api/LicenseGetBasicStatusResponse.md | 5 + .../api/LicenseGetLicenseInformation.md | 16 + docs/reference/api/LicenseGetRequest.md | 8 + docs/reference/api/LicenseGetResponse.md | 5 + .../api/LicenseGetTrialStatusRequest.md | 6 + .../api/LicenseGetTrialStatusResponse.md | 5 + docs/reference/api/LicenseLicense.md | 14 + docs/reference/api/LicenseLicenseStatus.md | 4 + docs/reference/api/LicenseLicenseType.md | 4 + .../api/LicensePostAcknowledgement.md | 6 + docs/reference/api/LicensePostRequest.md | 11 + docs/reference/api/LicensePostResponse.md | 7 + .../api/LicensePostStartBasicRequest.md | 9 + .../api/LicensePostStartBasicResponse.md | 9 + .../api/LicensePostStartTrialRequest.md | 9 + .../api/LicensePostStartTrialResponse.md | 8 + docs/reference/api/LifecycleOperationMode.md | 4 + docs/reference/api/Logstash.md | 20 + .../api/LogstashDeletePipelineRequest.md | 7 + .../api/LogstashDeletePipelineResponse.md | 4 + .../api/LogstashGetPipelineRequest.md | 7 + .../api/LogstashGetPipelineResponse.md | 4 + docs/reference/api/LogstashPipeline.md | 10 + .../reference/api/LogstashPipelineMetadata.md | 6 + .../reference/api/LogstashPipelineSettings.md | 10 + .../api/LogstashPutPipelineRequest.md | 8 + .../api/LogstashPutPipelineResponse.md | 4 + docs/reference/api/MapboxVectorTiles.md | 4 + .../MappingAggregateMetricDoubleProperty.md | 8 + docs/reference/api/MappingAllField.md | 14 + docs/reference/api/MappingBinaryProperty.md | 5 + docs/reference/api/MappingBooleanProperty.md | 13 + .../api/MappingByteNumberProperty.md | 6 + docs/reference/api/MappingChunkingSettings.md | 8 + .../api/MappingCompletionProperty.md | 11 + .../reference/api/MappingCompositeSubField.md | 5 + .../api/MappingConstantKeywordProperty.md | 6 + docs/reference/api/MappingCorePropertyBase.md | 6 + .../api/MappingCountedKeywordProperty.md | 6 + .../api/MappingDataStreamTimestamp.md | 5 + .../reference/api/MappingDateNanosProperty.md | 13 + docs/reference/api/MappingDateProperty.md | 15 + .../reference/api/MappingDateRangeProperty.md | 6 + .../api/MappingDenseVectorElementType.md | 4 + .../api/MappingDenseVectorIndexOptions.md | 9 + ...ingDenseVectorIndexOptionsRescoreVector.md | 5 + .../api/MappingDenseVectorIndexOptionsType.md | 4 + .../api/MappingDenseVectorProperty.md | 10 + .../api/MappingDenseVectorSimilarity.md | 4 + .../api/MappingDocValuesPropertyBase.md | 5 + .../api/MappingDoubleNumberProperty.md | 6 + .../api/MappingDoubleRangeProperty.md | 5 + docs/reference/api/MappingDynamicMapping.md | 4 + docs/reference/api/MappingDynamicProperty.md | 27 + docs/reference/api/MappingDynamicTemplate.md | 13 + .../api/MappingFieldAliasProperty.md | 6 + docs/reference/api/MappingFieldMapping.md | 6 + docs/reference/api/MappingFieldNamesField.md | 5 + docs/reference/api/MappingFieldType.md | 4 + .../reference/api/MappingFlattenedProperty.md | 14 + .../api/MappingFloatNumberProperty.md | 6 + .../api/MappingFloatRangeProperty.md | 5 + docs/reference/api/MappingGeoOrientation.md | 4 + docs/reference/api/MappingGeoPointProperty.md | 11 + docs/reference/api/MappingGeoShapeProperty.md | 11 + docs/reference/api/MappingGeoStrategy.md | 4 + .../api/MappingHalfFloatNumberProperty.md | 6 + .../reference/api/MappingHistogramProperty.md | 6 + .../api/MappingIcuCollationProperty.md | 21 + docs/reference/api/MappingIndexField.md | 5 + docs/reference/api/MappingIndexOptions.md | 4 + .../api/MappingIntegerNumberProperty.md | 6 + .../api/MappingIntegerRangeProperty.md | 5 + docs/reference/api/MappingIpProperty.md | 12 + docs/reference/api/MappingIpRangeProperty.md | 5 + docs/reference/api/MappingJoinProperty.md | 7 + docs/reference/api/MappingKeywordProperty.md | 17 + .../api/MappingLongNumberProperty.md | 6 + .../reference/api/MappingLongRangeProperty.md | 5 + .../api/MappingMatchOnlyTextProperty.md | 8 + docs/reference/api/MappingMatchType.md | 4 + .../api/MappingMurmur3HashProperty.md | 5 + docs/reference/api/MappingNestedProperty.md | 8 + .../api/MappingNumberPropertyBase.md | 12 + docs/reference/api/MappingObjectProperty.md | 7 + docs/reference/api/MappingOnScriptError.md | 4 + .../api/MappingPassthroughObjectProperty.md | 8 + .../api/MappingPercolatorProperty.md | 5 + docs/reference/api/MappingPointProperty.md | 8 + docs/reference/api/MappingProperty.md | 4 + docs/reference/api/MappingPropertyBase.md | 10 + .../reference/api/MappingRangePropertyBase.md | 7 + .../api/MappingRankFeatureProperty.md | 6 + .../api/MappingRankFeaturesProperty.md | 6 + docs/reference/api/MappingRoutingField.md | 5 + docs/reference/api/MappingRuntimeField.md | 12 + .../api/MappingRuntimeFieldFetchFields.md | 6 + docs/reference/api/MappingRuntimeFieldType.md | 4 + docs/reference/api/MappingRuntimeFields.md | 4 + .../api/MappingScaledFloatNumberProperty.md | 7 + .../api/MappingSearchAsYouTypeProperty.md | 14 + .../api/MappingSemanticTextProperty.md | 9 + docs/reference/api/MappingShapeProperty.md | 9 + .../api/MappingShortNumberProperty.md | 6 + docs/reference/api/MappingSizeField.md | 5 + docs/reference/api/MappingSourceField.md | 10 + docs/reference/api/MappingSourceFieldMode.md | 4 + .../api/MappingSparseVectorProperty.md | 5 + docs/reference/api/MappingSubobjects.md | 4 + docs/reference/api/MappingSuggestContext.md | 8 + .../api/MappingSyntheticSourceKeepEnum.md | 4 + docs/reference/api/MappingTermVectorOption.md | 4 + .../reference/api/MappingTextIndexPrefixes.md | 6 + docs/reference/api/MappingTextProperty.md | 20 + .../api/MappingTimeSeriesMetricType.md | 4 + .../api/MappingTokenCountProperty.md | 10 + docs/reference/api/MappingTypeMapping.md | 21 + .../api/MappingUnsignedLongNumberProperty.md | 6 + docs/reference/api/MappingVersionProperty.md | 5 + docs/reference/api/MappingWildcardProperty.md | 6 + docs/reference/api/MergesStats.md | 20 + docs/reference/api/Metadata.md | 4 + docs/reference/api/Metrics.md | 4 + docs/reference/api/MgetApi_1.md | 3 + docs/reference/api/MgetApi_2.md | 3 + docs/reference/api/MgetApi_3.md | 3 + docs/reference/api/MgetMultiGetError.md | 7 + docs/reference/api/MgetOperation.md | 11 + docs/reference/api/MgetRequest.md | 18 + docs/reference/api/MgetResponse.md | 5 + docs/reference/api/MgetResponseItem.md | 4 + docs/reference/api/Migration.md | 20 + .../api/MigrationDeprecationsDeprecation.md | 10 + .../MigrationDeprecationsDeprecationLevel.md | 4 + .../api/MigrationDeprecationsRequest.md | 7 + .../api/MigrationDeprecationsResponse.md | 11 + ...GetFeatureUpgradeStatusMigrationFeature.md | 8 + ...eUpgradeStatusMigrationFeatureIndexInfo.md | 7 + ...nGetFeatureUpgradeStatusMigrationStatus.md | 4 + ...MigrationGetFeatureUpgradeStatusRequest.md | 6 + ...igrationGetFeatureUpgradeStatusResponse.md | 6 + ...ationPostFeatureUpgradeMigrationFeature.md | 5 + .../api/MigrationPostFeatureUpgradeRequest.md | 6 + .../MigrationPostFeatureUpgradeResponse.md | 7 + docs/reference/api/MinimumShouldMatch.md | 4 + docs/reference/api/Ml.md | 20 + .../api/MlAdaptiveAllocationsSettings.md | 7 + docs/reference/api/MlAnalysisConfig.md | 15 + docs/reference/api/MlAnalysisConfigRead.md | 15 + docs/reference/api/MlAnalysisLimits.md | 6 + docs/reference/api/MlAnalysisMemoryLimit.md | 5 + docs/reference/api/MlAnomaly.md | 28 + docs/reference/api/MlAnomalyCause.md | 19 + docs/reference/api/MlAnomalyExplanation.md | 14 + docs/reference/api/MlApiKeyAuthorization.md | 6 + docs/reference/api/MlAppliesTo.md | 4 + docs/reference/api/MlBucketInfluencer.md | 15 + docs/reference/api/MlBucketSummary.md | 15 + docs/reference/api/MlCalendarEvent.md | 12 + .../reference/api/MlCategorizationAnalyzer.md | 4 + .../api/MlCategorizationAnalyzerDefinition.md | 7 + docs/reference/api/MlCategorizationStatus.md | 4 + docs/reference/api/MlCategory.md | 18 + docs/reference/api/MlChunkingConfig.md | 6 + docs/reference/api/MlChunkingMode.md | 4 + .../api/MlClassificationInferenceOptions.md | 9 + ...ClearTrainedModelDeploymentCacheRequest.md | 7 + ...learTrainedModelDeploymentCacheResponse.md | 5 + docs/reference/api/MlCloseJobRequest.md | 10 + docs/reference/api/MlCloseJobResponse.md | 5 + .../api/MlCommonTokenizationConfig.md | 9 + docs/reference/api/MlConditionOperator.md | 4 + docs/reference/api/MlCustomSettings.md | 4 + docs/reference/api/MlDataCounts.md | 23 + docs/reference/api/MlDataDescription.md | 8 + docs/reference/api/MlDatafeed.md | 21 + docs/reference/api/MlDatafeedAuthorization.md | 7 + docs/reference/api/MlDatafeedConfig.md | 20 + docs/reference/api/MlDatafeedRunningState.md | 7 + docs/reference/api/MlDatafeedState.md | 4 + docs/reference/api/MlDatafeedStats.md | 10 + docs/reference/api/MlDatafeedTimingStats.md | 11 + docs/reference/api/MlDataframeAnalysis.md | 23 + .../api/MlDataframeAnalysisAnalyzedFields.md | 6 + .../api/MlDataframeAnalysisClassification.md | 6 + .../api/MlDataframeAnalysisContainer.md | 7 + .../MlDataframeAnalysisFeatureProcessor.md | 9 + ...alysisFeatureProcessorFrequencyEncoding.md | 7 + ...meAnalysisFeatureProcessorMultiEncoding.md | 5 + ...meAnalysisFeatureProcessorNGramEncoding.md | 10 + ...eAnalysisFeatureProcessorOneHotEncoding.md | 6 + ...lysisFeatureProcessorTargetMeanEncoding.md | 8 + .../MlDataframeAnalysisOutlierDetection.md | 10 + .../api/MlDataframeAnalysisRegression.md | 6 + docs/reference/api/MlDataframeAnalytics.md | 12 + .../api/MlDataframeAnalyticsAuthorization.md | 7 + .../api/MlDataframeAnalyticsDestination.md | 6 + .../api/MlDataframeAnalyticsFieldSelection.md | 10 + .../MlDataframeAnalyticsMemoryEstimation.md | 6 + .../api/MlDataframeAnalyticsSource.md | 8 + .../api/MlDataframeAnalyticsStatsContainer.md | 7 + .../MlDataframeAnalyticsStatsDataCounts.md | 7 + ...lDataframeAnalyticsStatsHyperparameters.md | 9 + .../MlDataframeAnalyticsStatsMemoryUsage.md | 8 + ...DataframeAnalyticsStatsOutlierDetection.md | 7 + .../api/MlDataframeAnalyticsStatsProgress.md | 6 + .../api/MlDataframeAnalyticsSummary.md | 17 + .../MlDataframeEvaluationClassification.md | 8 + ...ataframeEvaluationClassificationMetrics.md | 6 + ...meEvaluationClassificationMetricsAucRoc.md | 6 + .../api/MlDataframeEvaluationContainer.md | 7 + .../api/MlDataframeEvaluationMetrics.md | 7 + .../MlDataframeEvaluationOutlierDetection.md | 7 + ...aframeEvaluationOutlierDetectionMetrics.md | 5 + .../api/MlDataframeEvaluationRegression.md | 7 + .../MlDataframeEvaluationRegressionMetrics.md | 8 + ...taframeEvaluationRegressionMetricsHuber.md | 5 + ...ataframeEvaluationRegressionMetricsMsle.md | 5 + docs/reference/api/MlDataframeState.md | 4 + .../reference/api/MlDelayedDataCheckConfig.md | 6 + .../api/MlDeleteCalendarEventRequest.md | 8 + .../api/MlDeleteCalendarEventResponse.md | 4 + .../api/MlDeleteCalendarJobRequest.md | 8 + .../api/MlDeleteCalendarJobResponse.md | 7 + docs/reference/api/MlDeleteCalendarRequest.md | 7 + .../reference/api/MlDeleteCalendarResponse.md | 4 + .../api/MlDeleteDataFrameAnalyticsRequest.md | 9 + .../api/MlDeleteDataFrameAnalyticsResponse.md | 4 + docs/reference/api/MlDeleteDatafeedRequest.md | 8 + .../reference/api/MlDeleteDatafeedResponse.md | 4 + .../api/MlDeleteExpiredDataRequest.md | 9 + .../api/MlDeleteExpiredDataResponse.md | 5 + docs/reference/api/MlDeleteFilterRequest.md | 7 + docs/reference/api/MlDeleteFilterResponse.md | 4 + docs/reference/api/MlDeleteForecastRequest.md | 10 + .../reference/api/MlDeleteForecastResponse.md | 4 + docs/reference/api/MlDeleteJobRequest.md | 10 + docs/reference/api/MlDeleteJobResponse.md | 4 + .../api/MlDeleteModelSnapshotRequest.md | 8 + .../api/MlDeleteModelSnapshotResponse.md | 4 + .../api/MlDeleteTrainedModelAliasRequest.md | 8 + .../api/MlDeleteTrainedModelAliasResponse.md | 4 + .../api/MlDeleteTrainedModelRequest.md | 9 + .../api/MlDeleteTrainedModelResponse.md | 4 + .../api/MlDeploymentAllocationState.md | 4 + .../api/MlDeploymentAssignmentState.md | 4 + docs/reference/api/MlDetectionRule.md | 7 + docs/reference/api/MlDetector.md | 14 + docs/reference/api/MlDetectorRead.md | 14 + docs/reference/api/MlDetectorUpdate.md | 7 + docs/reference/api/MlDiscoveryNode.md | 4 + docs/reference/api/MlDiscoveryNodeCompact.md | 9 + docs/reference/api/MlDiscoveryNodeContent.md | 13 + .../api/MlEstimateModelMemoryRequest.md | 9 + .../api/MlEstimateModelMemoryResponse.md | 5 + .../MlEvaluateDataFrameConfusionMatrixItem.md | 8 + ...luateDataFrameConfusionMatrixPrediction.md | 6 + ...aluateDataFrameConfusionMatrixThreshold.md | 8 + ...DataFrameDataframeClassificationSummary.md | 9 + ...eDataframeClassificationSummaryAccuracy.md | 6 + ...icationSummaryMulticlassConfusionMatrix.md | 6 + ...DataframeClassificationSummaryPrecision.md | 6 + ...ameDataframeClassificationSummaryRecall.md | 6 + ...aluateDataFrameDataframeEvaluationClass.md | 5 + ...taFrameDataframeEvaluationSummaryAucRoc.md | 5 + ...taframeEvaluationSummaryAucRocCurveItem.md | 7 + ...aluateDataFrameDataframeEvaluationValue.md | 5 + ...taFrameDataframeOutlierDetectionSummary.md | 8 + ...uateDataFrameDataframeRegressionSummary.md | 8 + .../api/MlEvaluateDataFrameRequest.md | 9 + .../api/MlEvaluateDataFrameResponse.md | 7 + docs/reference/api/MlExcludeFrequent.md | 4 + .../api/MlExplainDataFrameAnalyticsRequest.md | 15 + .../MlExplainDataFrameAnalyticsResponse.md | 6 + .../MlExponentialAverageCalculationContext.md | 7 + docs/reference/api/MlFeatureExtractor.md | 4 + .../api/MlFillMaskInferenceOptions.md | 9 + .../api/MlFillMaskInferenceUpdateOptions.md | 7 + docs/reference/api/MlFilter.md | 7 + docs/reference/api/MlFilterRef.md | 6 + docs/reference/api/MlFilterType.md | 4 + docs/reference/api/MlFlushJobRequest.md | 12 + docs/reference/api/MlFlushJobResponse.md | 6 + docs/reference/api/MlForecastRequest.md | 10 + docs/reference/api/MlForecastResponse.md | 6 + docs/reference/api/MlGeoResults.md | 6 + docs/reference/api/MlGetBucketsRequest.md | 18 + docs/reference/api/MlGetBucketsResponse.md | 6 + .../api/MlGetCalendarEventsRequest.md | 12 + .../api/MlGetCalendarEventsResponse.md | 6 + docs/reference/api/MlGetCalendarsCalendar.md | 7 + docs/reference/api/MlGetCalendarsRequest.md | 10 + docs/reference/api/MlGetCalendarsResponse.md | 6 + docs/reference/api/MlGetCategoriesRequest.md | 12 + docs/reference/api/MlGetCategoriesResponse.md | 6 + .../api/MlGetDataFrameAnalyticsRequest.md | 11 + .../api/MlGetDataFrameAnalyticsResponse.md | 6 + .../MlGetDataFrameAnalyticsStatsRequest.md | 11 + .../MlGetDataFrameAnalyticsStatsResponse.md | 6 + .../api/MlGetDatafeedStatsRequest.md | 8 + .../api/MlGetDatafeedStatsResponse.md | 6 + docs/reference/api/MlGetDatafeedsRequest.md | 9 + docs/reference/api/MlGetDatafeedsResponse.md | 6 + docs/reference/api/MlGetFiltersRequest.md | 9 + docs/reference/api/MlGetFiltersResponse.md | 6 + docs/reference/api/MlGetInfluencersRequest.md | 16 + .../reference/api/MlGetInfluencersResponse.md | 6 + docs/reference/api/MlGetJobStatsRequest.md | 8 + docs/reference/api/MlGetJobStatsResponse.md | 6 + docs/reference/api/MlGetJobsRequest.md | 9 + docs/reference/api/MlGetJobsResponse.md | 6 + .../reference/api/MlGetMemoryStatsJvmStats.md | 10 + .../api/MlGetMemoryStatsMemMlStats.md | 14 + .../reference/api/MlGetMemoryStatsMemStats.md | 9 + docs/reference/api/MlGetMemoryStatsMemory.md | 11 + docs/reference/api/MlGetMemoryStatsRequest.md | 9 + .../reference/api/MlGetMemoryStatsResponse.md | 7 + .../MlGetModelSnapshotUpgradeStatsRequest.md | 9 + .../MlGetModelSnapshotUpgradeStatsResponse.md | 6 + .../api/MlGetModelSnapshotsRequest.md | 15 + .../api/MlGetModelSnapshotsResponse.md | 6 + .../api/MlGetOverallBucketsRequest.md | 14 + .../api/MlGetOverallBucketsResponse.md | 6 + docs/reference/api/MlGetRecordsRequest.md | 16 + docs/reference/api/MlGetRecordsResponse.md | 6 + .../api/MlGetTrainedModelsRequest.md | 14 + .../api/MlGetTrainedModelsResponse.md | 6 + .../api/MlGetTrainedModelsStatsRequest.md | 10 + .../api/MlGetTrainedModelsStatsResponse.md | 6 + docs/reference/api/MlHyperparameter.md | 9 + docs/reference/api/MlHyperparameters.md | 18 + docs/reference/api/MlInclude.md | 4 + .../api/MlInferTrainedModelRequest.md | 10 + .../api/MlInferTrainedModelResponse.md | 5 + .../api/MlInferenceConfigCreateContainer.md | 15 + .../api/MlInferenceConfigUpdateContainer.md | 14 + .../api/MlInferenceResponseResult.md | 13 + docs/reference/api/MlInfluence.md | 6 + docs/reference/api/MlInfluencer.md | 15 + docs/reference/api/MlInfoAnomalyDetectors.md | 9 + docs/reference/api/MlInfoDatafeeds.md | 5 + docs/reference/api/MlInfoDefaults.md | 6 + docs/reference/api/MlInfoLimits.md | 9 + docs/reference/api/MlInfoNativeCode.md | 6 + docs/reference/api/MlInfoRequest.md | 6 + docs/reference/api/MlInfoResponse.md | 8 + docs/reference/api/MlJob.md | 27 + docs/reference/api/MlJobBlocked.md | 6 + docs/reference/api/MlJobBlockedReason.md | 4 + docs/reference/api/MlJobConfig.md | 21 + docs/reference/api/MlJobForecastStatistics.md | 10 + docs/reference/api/MlJobState.md | 4 + docs/reference/api/MlJobStatistics.md | 8 + docs/reference/api/MlJobStats.md | 14 + docs/reference/api/MlJobTimingStats.md | 12 + docs/reference/api/MlLearningToRankConfig.md | 7 + docs/reference/api/MlMemoryStatus.md | 4 + docs/reference/api/MlModelPackageConfig.md | 18 + docs/reference/api/MlModelPlotConfig.md | 7 + docs/reference/api/MlModelSizeStats.md | 26 + docs/reference/api/MlModelSnapshot.md | 14 + docs/reference/api/MlModelSnapshotUpgrade.md | 9 + docs/reference/api/MlNerInferenceOptions.md | 8 + .../api/MlNerInferenceUpdateOptions.md | 6 + .../api/MlNlpBertTokenizationConfig.md | 4 + .../api/MlNlpRobertaTokenizationConfig.md | 5 + .../api/MlNlpTokenizationUpdateOptions.md | 6 + docs/reference/api/MlOpenJobRequest.md | 8 + docs/reference/api/MlOpenJobResponse.md | 6 + .../api/MlOutlierDetectionParameters.md | 10 + docs/reference/api/MlOverallBucket.md | 11 + docs/reference/api/MlOverallBucketJob.md | 6 + docs/reference/api/MlPage.md | 6 + .../api/MlPassThroughInferenceOptions.md | 7 + .../MlPassThroughInferenceUpdateOptions.md | 6 + .../api/MlPerPartitionCategorization.md | 6 + .../api/MlPostCalendarEventsRequest.md | 8 + .../api/MlPostCalendarEventsResponse.md | 5 + docs/reference/api/MlPostDataRequest.md | 10 + docs/reference/api/MlPostDataResponse.md | 22 + docs/reference/api/MlPredictedValue.md | 4 + ...ataFrameAnalyticsDataframePreviewConfig.md | 9 + .../api/MlPreviewDataFrameAnalyticsRequest.md | 8 + .../MlPreviewDataFrameAnalyticsResponse.md | 5 + .../reference/api/MlPreviewDatafeedRequest.md | 11 + .../api/MlPreviewDatafeedResponse.md | 4 + docs/reference/api/MlPutCalendarJobRequest.md | 8 + .../reference/api/MlPutCalendarJobResponse.md | 7 + docs/reference/api/MlPutCalendarRequest.md | 9 + docs/reference/api/MlPutCalendarResponse.md | 7 + .../api/MlPutDataFrameAnalyticsRequest.md | 18 + .../api/MlPutDataFrameAnalyticsResponse.md | 17 + docs/reference/api/MlPutDatafeedRequest.md | 27 + docs/reference/api/MlPutDatafeedResponse.md | 19 + docs/reference/api/MlPutFilterRequest.md | 9 + docs/reference/api/MlPutFilterResponse.md | 7 + docs/reference/api/MlPutJobRequest.md | 26 + docs/reference/api/MlPutJobResponse.md | 24 + .../api/MlPutTrainedModelAggregateOutput.md | 8 + .../api/MlPutTrainedModelAliasRequest.md | 9 + .../api/MlPutTrainedModelAliasResponse.md | 4 + .../api/MlPutTrainedModelDefinition.md | 6 + .../MlPutTrainedModelDefinitionPartRequest.md | 11 + ...MlPutTrainedModelDefinitionPartResponse.md | 4 + .../api/MlPutTrainedModelEnsemble.md | 9 + ...ainedModelFrequencyEncodingPreprocessor.md | 7 + docs/reference/api/MlPutTrainedModelInput.md | 5 + ...tTrainedModelOneHotEncodingPreprocessor.md | 6 + .../api/MlPutTrainedModelPreprocessor.md | 7 + .../reference/api/MlPutTrainedModelRequest.md | 20 + .../api/MlPutTrainedModelResponse.md | 4 + ...inedModelTargetMeanEncodingPreprocessor.md | 8 + .../api/MlPutTrainedModelTrainedModel.md | 7 + .../api/MlPutTrainedModelTrainedModelTree.md | 8 + .../MlPutTrainedModelTrainedModelTreeNode.md | 13 + .../api/MlPutTrainedModelVocabularyRequest.md | 10 + .../MlPutTrainedModelVocabularyResponse.md | 4 + .../reference/api/MlPutTrainedModelWeights.md | 5 + docs/reference/api/MlQueryFeatureExtractor.md | 7 + .../MlQuestionAnsweringInferenceOptions.md | 8 + ...QuestionAnsweringInferenceUpdateOptions.md | 9 + .../api/MlRegressionInferenceOptions.md | 6 + docs/reference/api/MlResetJobRequest.md | 9 + docs/reference/api/MlResetJobResponse.md | 4 + .../api/MlRevertModelSnapshotRequest.md | 9 + .../api/MlRevertModelSnapshotResponse.md | 5 + docs/reference/api/MlRoutingState.md | 4 + docs/reference/api/MlRuleAction.md | 4 + docs/reference/api/MlRuleCondition.md | 7 + .../api/MlRunningStateSearchInterval.md | 8 + docs/reference/api/MlSetUpgradeModeRequest.md | 8 + .../reference/api/MlSetUpgradeModeResponse.md | 4 + docs/reference/api/MlSnapshotUpgradeState.md | 4 + .../api/MlStartDataFrameAnalyticsRequest.md | 8 + .../api/MlStartDataFrameAnalyticsResponse.md | 6 + docs/reference/api/MlStartDatafeedRequest.md | 10 + docs/reference/api/MlStartDatafeedResponse.md | 6 + .../MlStartTrainedModelDeploymentRequest.md | 16 + .../MlStartTrainedModelDeploymentResponse.md | 5 + .../api/MlStopDataFrameAnalyticsRequest.md | 10 + .../api/MlStopDataFrameAnalyticsResponse.md | 5 + docs/reference/api/MlStopDatafeedRequest.md | 10 + docs/reference/api/MlStopDatafeedResponse.md | 5 + .../MlStopTrainedModelDeploymentRequest.md | 9 + .../MlStopTrainedModelDeploymentResponse.md | 5 + .../MlTextClassificationInferenceOptions.md | 9 + ...extClassificationInferenceUpdateOptions.md | 8 + .../api/MlTextEmbeddingInferenceOptions.md | 8 + .../MlTextEmbeddingInferenceUpdateOptions.md | 6 + .../api/MlTextExpansionInferenceOptions.md | 7 + .../MlTextExpansionInferenceUpdateOptions.md | 6 + docs/reference/api/MlTimingStats.md | 6 + .../api/MlTokenizationConfigContainer.md | 9 + docs/reference/api/MlTokenizationTruncate.md | 4 + docs/reference/api/MlTopClassEntry.md | 7 + .../reference/api/MlTotalFeatureImportance.md | 7 + .../api/MlTotalFeatureImportanceClass.md | 6 + .../api/MlTotalFeatureImportanceStatistics.md | 7 + .../reference/api/MlTrainedModelAssignment.md | 11 + ...nedModelAssignmentRoutingStateAndReason.md | 6 + .../MlTrainedModelAssignmentRoutingTable.md | 8 + .../MlTrainedModelAssignmentTaskParameters.md | 14 + docs/reference/api/MlTrainedModelConfig.md | 25 + .../api/MlTrainedModelConfigInput.md | 5 + .../api/MlTrainedModelConfigMetadata.md | 8 + ...lTrainedModelDeploymentAllocationStatus.md | 7 + .../api/MlTrainedModelDeploymentNodesStats.md | 22 + .../api/MlTrainedModelDeploymentStats.md | 22 + docs/reference/api/MlTrainedModelEntities.md | 9 + .../MlTrainedModelInferenceClassImportance.md | 6 + ...lTrainedModelInferenceFeatureImportance.md | 7 + .../api/MlTrainedModelInferenceStats.md | 9 + docs/reference/api/MlTrainedModelLocation.md | 5 + .../api/MlTrainedModelLocationIndex.md | 5 + .../api/MlTrainedModelPrefixStrings.md | 6 + docs/reference/api/MlTrainedModelSizeStats.md | 6 + docs/reference/api/MlTrainedModelStats.md | 10 + docs/reference/api/MlTrainedModelType.md | 4 + docs/reference/api/MlTrainingPriority.md | 4 + .../reference/api/MlTransformAuthorization.md | 7 + .../api/MlUpdateDataFrameAnalyticsRequest.md | 11 + .../api/MlUpdateDataFrameAnalyticsResponse.md | 16 + docs/reference/api/MlUpdateDatafeedRequest.md | 25 + .../reference/api/MlUpdateDatafeedResponse.md | 19 + docs/reference/api/MlUpdateFilterRequest.md | 10 + docs/reference/api/MlUpdateFilterResponse.md | 7 + docs/reference/api/MlUpdateJobRequest.md | 22 + docs/reference/api/MlUpdateJobResponse.md | 25 + .../api/MlUpdateModelSnapshotRequest.md | 10 + .../api/MlUpdateModelSnapshotResponse.md | 6 + .../MlUpdateTrainedModelDeploymentRequest.md | 9 + .../MlUpdateTrainedModelDeploymentResponse.md | 5 + .../api/MlUpgradeJobSnapshotRequest.md | 10 + .../api/MlUpgradeJobSnapshotResponse.md | 6 + .../api/MlValidateDetectorRequest.md | 7 + .../api/MlValidateDetectorResponse.md | 4 + docs/reference/api/MlValidateRequest.md | 15 + docs/reference/api/MlValidateResponse.md | 4 + docs/reference/api/MlValidationLoss.md | 6 + docs/reference/api/MlVocabulary.md | 5 + .../api/MlXlmRobertaTokenizationConfig.md | 4 + ...lZeroShotClassificationInferenceOptions.md | 10 + ...hotClassificationInferenceUpdateOptions.md | 8 + docs/reference/api/Monitoring.md | 20 + docs/reference/api/MonitoringBulkRequest.md | 11 + docs/reference/api/MonitoringBulkResponse.md | 8 + docs/reference/api/MsearchApi_1.md | 3 + docs/reference/api/MsearchApi_2.md | 3 + docs/reference/api/MsearchApi_3.md | 3 + docs/reference/api/MsearchHelper.md | 6 + docs/reference/api/MsearchHelperOptions.md | 9 + docs/reference/api/MsearchHelperResponse.md | 8 + docs/reference/api/MsearchMultiSearchItem.md | 5 + .../reference/api/MsearchMultiSearchResult.md | 6 + .../reference/api/MsearchMultisearchHeader.md | 15 + docs/reference/api/MsearchRequest.md | 21 + docs/reference/api/MsearchRequestItem.md | 4 + docs/reference/api/MsearchResponse.md | 4 + docs/reference/api/MsearchResponseItem.md | 4 + docs/reference/api/MsearchTemplateApi_1.md | 3 + docs/reference/api/MsearchTemplateApi_2.md | 3 + docs/reference/api/MsearchTemplateApi_3.md | 3 + docs/reference/api/MsearchTemplateRequest.md | 13 + .../api/MsearchTemplateRequestItem.md | 4 + docs/reference/api/MsearchTemplateResponse.md | 4 + .../api/MsearchTemplateTemplateConfig.md | 9 + docs/reference/api/MtermvectorsApi_1.md | 3 + docs/reference/api/MtermvectorsApi_2.md | 3 + docs/reference/api/MtermvectorsApi_3.md | 3 + docs/reference/api/MtermvectorsOperation.md | 17 + docs/reference/api/MtermvectorsRequest.md | 20 + docs/reference/api/MtermvectorsResponse.md | 5 + .../api/MtermvectorsTermVectorsResult.md | 11 + docs/reference/api/MultiTermQueryRewrite.md | 4 + docs/reference/api/Name.md | 4 + docs/reference/api/Names.md | 4 + docs/reference/api/Namespace.md | 4 + docs/reference/api/NestedSortValue.md | 8 + docs/reference/api/NodeAttributes.md | 9 + docs/reference/api/NodeId.md | 4 + docs/reference/api/NodeIds.md | 4 + docs/reference/api/NodeName.md | 4 + docs/reference/api/NodeOptions.md | 10 + docs/reference/api/NodeRole.md | 4 + docs/reference/api/NodeRoles.md | 4 + docs/reference/api/NodeShard.md | 14 + docs/reference/api/NodeStatistics.md | 8 + docs/reference/api/Nodes.md | 20 + docs/reference/api/NodesAdaptiveSelection.md | 11 + docs/reference/api/NodesBreaker.md | 10 + docs/reference/api/NodesCgroup.md | 7 + docs/reference/api/NodesCgroupCpu.md | 8 + docs/reference/api/NodesCgroupCpuStat.md | 7 + docs/reference/api/NodesCgroupMemory.md | 7 + ...ClearRepositoriesMeteringArchiveRequest.md | 8 + ...learRepositoriesMeteringArchiveResponse.md | 4 + ...RepositoriesMeteringArchiveResponseBase.md | 6 + docs/reference/api/NodesClient.md | 15 + .../reference/api/NodesClusterAppliedStats.md | 5 + docs/reference/api/NodesClusterStateQueue.md | 7 + docs/reference/api/NodesClusterStateUpdate.md | 19 + docs/reference/api/NodesContext.md | 8 + docs/reference/api/NodesCpu.md | 12 + docs/reference/api/NodesCpuAcct.md | 6 + docs/reference/api/NodesDataPathStats.md | 20 + docs/reference/api/NodesDiscovery.md | 9 + .../reference/api/NodesExtendedMemoryStats.md | 6 + docs/reference/api/NodesFileSystem.md | 8 + docs/reference/api/NodesFileSystemTotal.md | 10 + docs/reference/api/NodesGarbageCollector.md | 5 + .../api/NodesGarbageCollectorTotal.md | 7 + ...NodesGetRepositoriesMeteringInfoRequest.md | 7 + ...odesGetRepositoriesMeteringInfoResponse.md | 4 + ...GetRepositoriesMeteringInfoResponseBase.md | 6 + docs/reference/api/NodesHotThreadsRequest.md | 14 + docs/reference/api/NodesHotThreadsResponse.md | 4 + docs/reference/api/NodesHttp.md | 8 + docs/reference/api/NodesHttpRoute.md | 6 + docs/reference/api/NodesHttpRouteRequests.md | 7 + docs/reference/api/NodesHttpRouteResponses.md | 8 + docs/reference/api/NodesIndexingPressure.md | 5 + .../api/NodesIndexingPressureMemory.md | 8 + .../api/NodesInfoDeprecationIndexing.md | 5 + docs/reference/api/NodesInfoNodeInfo.md | 28 + docs/reference/api/NodesInfoNodeInfoAction.md | 5 + .../api/NodesInfoNodeInfoAggregation.md | 5 + .../api/NodesInfoNodeInfoBootstrap.md | 5 + docs/reference/api/NodesInfoNodeInfoClient.md | 5 + .../api/NodesInfoNodeInfoDiscover.md | 4 + .../api/NodesInfoNodeInfoDiscoverKeys.md | 7 + docs/reference/api/NodesInfoNodeInfoHttp.md | 8 + docs/reference/api/NodesInfoNodeInfoIngest.md | 5 + .../api/NodesInfoNodeInfoIngestDownloader.md | 5 + .../api/NodesInfoNodeInfoIngestInfo.md | 5 + .../api/NodesInfoNodeInfoIngestProcessor.md | 5 + .../api/NodesInfoNodeInfoJvmMemory.md | 14 + docs/reference/api/NodesInfoNodeInfoMemory.md | 6 + .../reference/api/NodesInfoNodeInfoNetwork.md | 6 + .../api/NodesInfoNodeInfoNetworkInterface.md | 7 + docs/reference/api/NodesInfoNodeInfoOSCPU.md | 12 + docs/reference/api/NodesInfoNodeInfoPath.md | 8 + .../api/NodesInfoNodeInfoRepositories.md | 5 + .../api/NodesInfoNodeInfoRepositoriesUrl.md | 5 + docs/reference/api/NodesInfoNodeInfoScript.md | 6 + docs/reference/api/NodesInfoNodeInfoSearch.md | 5 + .../api/NodesInfoNodeInfoSearchRemote.md | 5 + .../api/NodesInfoNodeInfoSettings.md | 19 + .../api/NodesInfoNodeInfoSettingsCluster.md | 9 + ...odesInfoNodeInfoSettingsClusterElection.md | 5 + .../api/NodesInfoNodeInfoSettingsHttp.md | 8 + .../api/NodesInfoNodeInfoSettingsHttpType.md | 5 + .../api/NodesInfoNodeInfoSettingsIngest.md | 38 + .../api/NodesInfoNodeInfoSettingsNetwork.md | 5 + .../api/NodesInfoNodeInfoSettingsNode.md | 7 + .../api/NodesInfoNodeInfoSettingsTransport.md | 7 + ...esInfoNodeInfoSettingsTransportFeatures.md | 5 + .../NodesInfoNodeInfoSettingsTransportType.md | 5 + .../api/NodesInfoNodeInfoTransport.md | 7 + docs/reference/api/NodesInfoNodeInfoXpack.md | 8 + .../api/NodesInfoNodeInfoXpackLicense.md | 5 + .../api/NodesInfoNodeInfoXpackLicenseType.md | 5 + .../reference/api/NodesInfoNodeInfoXpackMl.md | 5 + .../api/NodesInfoNodeInfoXpackSecurity.md | 8 + .../NodesInfoNodeInfoXpackSecurityAuthc.md | 6 + ...desInfoNodeInfoXpackSecurityAuthcRealms.md | 7 + ...oNodeInfoXpackSecurityAuthcRealmsStatus.md | 6 + ...odesInfoNodeInfoXpackSecurityAuthcToken.md | 5 + .../api/NodesInfoNodeInfoXpackSecuritySsl.md | 5 + docs/reference/api/NodesInfoNodeJvmInfo.md | 17 + .../api/NodesInfoNodeOperatingSystemInfo.md | 14 + .../reference/api/NodesInfoNodeProcessInfo.md | 7 + .../api/NodesInfoNodeThreadPoolInfo.md | 10 + docs/reference/api/NodesInfoRequest.md | 10 + docs/reference/api/NodesInfoResponse.md | 4 + docs/reference/api/NodesInfoResponseBase.md | 6 + docs/reference/api/NodesIngest.md | 6 + docs/reference/api/NodesIngestStats.md | 11 + docs/reference/api/NodesIngestTotal.md | 8 + docs/reference/api/NodesIoStatDevice.md | 10 + docs/reference/api/NodesIoStats.md | 6 + docs/reference/api/NodesJvm.md | 12 + docs/reference/api/NodesJvmClasses.md | 7 + docs/reference/api/NodesJvmMemoryStats.md | 11 + docs/reference/api/NodesJvmThreads.md | 6 + docs/reference/api/NodesKeyedProcessor.md | 6 + docs/reference/api/NodesMemoryStats.md | 14 + docs/reference/api/NodesNodeBufferPool.md | 9 + docs/reference/api/NodesNodeReloadResult.md | 6 + docs/reference/api/NodesNodesResponseBase.md | 5 + docs/reference/api/NodesOperatingSystem.md | 9 + docs/reference/api/NodesPool.md | 8 + docs/reference/api/NodesPressureMemory.md | 17 + docs/reference/api/NodesProcess.md | 9 + docs/reference/api/NodesProcessor.md | 8 + .../api/NodesPublishedClusterStates.md | 7 + docs/reference/api/NodesRecording.md | 8 + .../api/NodesReloadSecureSettingsRequest.md | 9 + .../api/NodesReloadSecureSettingsResponse.md | 4 + .../NodesReloadSecureSettingsResponseBase.md | 6 + docs/reference/api/NodesRepositoryLocation.md | 7 + .../api/NodesRepositoryMeteringInformation.md | 13 + docs/reference/api/NodesRequestCounts.md | 15 + docs/reference/api/NodesScriptCache.md | 8 + docs/reference/api/NodesScripting.md | 9 + .../api/NodesSerializedClusterState.md | 6 + .../api/NodesSerializedClusterStateDetail.md | 9 + docs/reference/api/NodesSizeHttpHistogram.md | 7 + docs/reference/api/NodesStats.md | 26 + docs/reference/api/NodesStatsRequest.md | 18 + docs/reference/api/NodesStatsResponse.md | 4 + docs/reference/api/NodesStatsResponseBase.md | 6 + docs/reference/api/NodesThreadCount.md | 10 + docs/reference/api/NodesTimeHttpHistogram.md | 7 + docs/reference/api/NodesTransport.md | 14 + docs/reference/api/NodesTransportHistogram.md | 7 + docs/reference/api/NodesUsageNodeUsage.md | 8 + docs/reference/api/NodesUsageRequest.md | 9 + docs/reference/api/NodesUsageResponse.md | 4 + docs/reference/api/NodesUsageResponseBase.md | 6 + docs/reference/api/Normalization.md | 4 + docs/reference/api/OnDropDocument.md | 9 + docs/reference/api/OnSuccessDocument.md | 6 + docs/reference/api/OpType.md | 4 + docs/reference/api/OpenPointInTimeApi_1.md | 3 + docs/reference/api/OpenPointInTimeApi_2.md | 3 + docs/reference/api/OpenPointInTimeApi_3.md | 3 + docs/reference/api/OpenPointInTimeRequest.md | 15 + docs/reference/api/OpenPointInTimeResponse.md | 6 + docs/reference/api/Password.md | 4 + docs/reference/api/Percentage.md | 4 + docs/reference/api/PingApi_1.md | 3 + docs/reference/api/PingApi_2.md | 3 + docs/reference/api/PingApi_3.md | 3 + docs/reference/api/PingRequest.md | 6 + docs/reference/api/PingResponse.md | 4 + docs/reference/api/PipelineName.md | 4 + docs/reference/api/PluginStats.md | 13 + docs/reference/api/Profiling.md | 20 + docs/reference/api/PropertyName.md | 4 + docs/reference/api/PutScriptApi_1.md | 3 + docs/reference/api/PutScriptApi_2.md | 3 + docs/reference/api/PutScriptApi_3.md | 3 + docs/reference/api/PutScriptRequest.md | 11 + docs/reference/api/PutScriptResponse.md | 4 + docs/reference/api/QueryCacheStats.md | 12 + docs/reference/api/QueryDslBoolQuery.md | 9 + docs/reference/api/QueryDslBoostingQuery.md | 7 + docs/reference/api/QueryDslChildScoreMode.md | 4 + .../api/QueryDslCombinedFieldsOperator.md | 4 + .../api/QueryDslCombinedFieldsQuery.md | 10 + .../api/QueryDslCombinedFieldsZeroTerms.md | 4 + .../reference/api/QueryDslCommonTermsQuery.md | 10 + .../api/QueryDslConstantScoreQuery.md | 5 + .../api/QueryDslDateDecayFunction.md | 4 + .../api/QueryDslDateDecayFunctionKeys.md | 4 + .../api/QueryDslDateDistanceFeatureQuery.md | 4 + docs/reference/api/QueryDslDateRangeQuery.md | 6 + docs/reference/api/QueryDslDecayFunction.md | 4 + .../api/QueryDslDecayFunctionBase.md | 5 + docs/reference/api/QueryDslDecayPlacement.md | 8 + docs/reference/api/QueryDslDisMaxQuery.md | 6 + .../api/QueryDslDistanceFeatureQuery.md | 4 + .../api/QueryDslDistanceFeatureQueryBase.md | 7 + docs/reference/api/QueryDslExistsQuery.md | 5 + docs/reference/api/QueryDslFieldAndFormat.md | 7 + docs/reference/api/QueryDslFieldLookup.md | 8 + .../api/QueryDslFieldValueFactorModifier.md | 4 + .../QueryDslFieldValueFactorScoreFunction.md | 8 + .../api/QueryDslFunctionBoostMode.md | 4 + .../api/QueryDslFunctionScoreContainer.md | 12 + .../api/QueryDslFunctionScoreMode.md | 4 + .../api/QueryDslFunctionScoreQuery.md | 10 + docs/reference/api/QueryDslFuzzyQuery.md | 10 + .../api/QueryDslGeoBoundingBoxQuery.md | 4 + .../api/QueryDslGeoBoundingBoxQueryKeys.md | 7 + .../reference/api/QueryDslGeoDecayFunction.md | 4 + .../api/QueryDslGeoDecayFunctionKeys.md | 4 + .../api/QueryDslGeoDistanceFeatureQuery.md | 4 + .../reference/api/QueryDslGeoDistanceQuery.md | 4 + .../api/QueryDslGeoDistanceQueryKeys.md | 8 + docs/reference/api/QueryDslGeoExecution.md | 4 + docs/reference/api/QueryDslGeoGridQuery.md | 7 + .../reference/api/QueryDslGeoPolygonPoints.md | 5 + docs/reference/api/QueryDslGeoPolygonQuery.md | 4 + .../api/QueryDslGeoPolygonQueryKeys.md | 6 + .../api/QueryDslGeoShapeFieldQuery.md | 7 + docs/reference/api/QueryDslGeoShapeQuery.md | 4 + .../api/QueryDslGeoShapeQueryKeys.md | 5 + .../api/QueryDslGeoValidationMethod.md | 4 + docs/reference/api/QueryDslHasChildQuery.md | 11 + docs/reference/api/QueryDslHasParentQuery.md | 9 + docs/reference/api/QueryDslIdsQuery.md | 5 + docs/reference/api/QueryDslIntervalsAllOf.md | 8 + docs/reference/api/QueryDslIntervalsAnyOf.md | 6 + .../api/QueryDslIntervalsContainer.md | 10 + docs/reference/api/QueryDslIntervalsFilter.md | 13 + docs/reference/api/QueryDslIntervalsFuzzy.md | 10 + docs/reference/api/QueryDslIntervalsMatch.md | 10 + docs/reference/api/QueryDslIntervalsPrefix.md | 7 + docs/reference/api/QueryDslIntervalsQuery.md | 10 + .../api/QueryDslIntervalsWildcard.md | 7 + docs/reference/api/QueryDslLike.md | 4 + docs/reference/api/QueryDslLikeDocument.md | 12 + docs/reference/api/QueryDslMatchAllQuery.md | 4 + .../api/QueryDslMatchBoolPrefixQuery.md | 13 + docs/reference/api/QueryDslMatchNoneQuery.md | 4 + .../api/QueryDslMatchPhrasePrefixQuery.md | 9 + .../reference/api/QueryDslMatchPhraseQuery.md | 8 + docs/reference/api/QueryDslMatchQuery.md | 17 + .../api/QueryDslMoreLikeThisQuery.md | 22 + docs/reference/api/QueryDslMultiMatchQuery.md | 21 + docs/reference/api/QueryDslMultiValueMode.md | 4 + docs/reference/api/QueryDslNestedQuery.md | 9 + .../reference/api/QueryDslNumberRangeQuery.md | 4 + .../api/QueryDslNumericDecayFunction.md | 4 + .../api/QueryDslNumericDecayFunctionKeys.md | 4 + docs/reference/api/QueryDslOperator.md | 4 + docs/reference/api/QueryDslParentIdQuery.md | 7 + docs/reference/api/QueryDslPercolateQuery.md | 13 + docs/reference/api/QueryDslPinnedDoc.md | 6 + docs/reference/api/QueryDslPinnedQuery.md | 7 + docs/reference/api/QueryDslPrefixQuery.md | 7 + docs/reference/api/QueryDslQueryBase.md | 6 + docs/reference/api/QueryDslQueryContainer.md | 65 + .../reference/api/QueryDslQueryStringQuery.md | 29 + .../api/QueryDslRandomScoreFunction.md | 6 + docs/reference/api/QueryDslRangeQuery.md | 4 + docs/reference/api/QueryDslRangeQueryBase.md | 11 + docs/reference/api/QueryDslRangeRelation.md | 4 + .../api/QueryDslRankFeatureFunction.md | 4 + .../api/QueryDslRankFeatureFunctionLinear.md | 4 + .../QueryDslRankFeatureFunctionLogarithm.md | 5 + .../QueryDslRankFeatureFunctionSaturation.md | 5 + .../api/QueryDslRankFeatureFunctionSigmoid.md | 6 + .../reference/api/QueryDslRankFeatureQuery.md | 9 + docs/reference/api/QueryDslRegexpQuery.md | 9 + docs/reference/api/QueryDslRuleQuery.md | 7 + docs/reference/api/QueryDslScriptQuery.md | 5 + .../api/QueryDslScriptScoreFunction.md | 5 + .../reference/api/QueryDslScriptScoreQuery.md | 7 + docs/reference/api/QueryDslSemanticQuery.md | 6 + docs/reference/api/QueryDslShapeFieldQuery.md | 7 + docs/reference/api/QueryDslShapeQuery.md | 4 + docs/reference/api/QueryDslShapeQueryKeys.md | 5 + .../api/QueryDslSimpleQueryStringFlag.md | 4 + .../api/QueryDslSimpleQueryStringFlags.md | 4 + .../api/QueryDslSimpleQueryStringQuery.md | 17 + .../api/QueryDslSpanContainingQuery.md | 6 + .../api/QueryDslSpanFieldMaskingQuery.md | 6 + docs/reference/api/QueryDslSpanFirstQuery.md | 6 + docs/reference/api/QueryDslSpanGapQuery.md | 4 + .../api/QueryDslSpanMultiTermQuery.md | 5 + docs/reference/api/QueryDslSpanNearQuery.md | 7 + docs/reference/api/QueryDslSpanNotQuery.md | 9 + docs/reference/api/QueryDslSpanOrQuery.md | 5 + docs/reference/api/QueryDslSpanQuery.md | 14 + docs/reference/api/QueryDslSpanTermQuery.md | 6 + docs/reference/api/QueryDslSpanWithinQuery.md | 6 + .../api/QueryDslSparseVectorQuery.md | 10 + docs/reference/api/QueryDslTermQuery.md | 6 + docs/reference/api/QueryDslTermRangeQuery.md | 4 + docs/reference/api/QueryDslTermsLookup.md | 8 + docs/reference/api/QueryDslTermsQuery.md | 4 + docs/reference/api/QueryDslTermsQueryField.md | 4 + docs/reference/api/QueryDslTermsQueryKeys.md | 4 + docs/reference/api/QueryDslTermsSetQuery.md | 8 + .../api/QueryDslTextExpansionQuery.md | 7 + docs/reference/api/QueryDslTextQueryType.md | 4 + .../api/QueryDslTokenPruningConfig.md | 7 + docs/reference/api/QueryDslTypeQuery.md | 5 + .../api/QueryDslUntypedDecayFunction.md | 4 + .../api/QueryDslUntypedDecayFunctionKeys.md | 4 + .../QueryDslUntypedDistanceFeatureQuery.md | 4 + .../api/QueryDslUntypedRangeQuery.md | 6 + .../api/QueryDslWeightedTokensQuery.md | 6 + docs/reference/api/QueryDslWildcardQuery.md | 8 + docs/reference/api/QueryDslWrapperQuery.md | 5 + docs/reference/api/QueryDslZeroTermsQuery.md | 4 + docs/reference/api/QueryRules.md | 20 + .../api/QueryRulesDeleteRuleRequest.md | 8 + .../api/QueryRulesDeleteRuleResponse.md | 4 + .../api/QueryRulesDeleteRulesetRequest.md | 7 + .../api/QueryRulesDeleteRulesetResponse.md | 4 + .../reference/api/QueryRulesGetRuleRequest.md | 8 + .../api/QueryRulesGetRuleResponse.md | 4 + .../api/QueryRulesGetRulesetRequest.md | 7 + .../api/QueryRulesGetRulesetResponse.md | 4 + ...ryRulesListRulesetsQueryRulesetListItem.md | 8 + .../api/QueryRulesListRulesetsRequest.md | 8 + .../api/QueryRulesListRulesetsResponse.md | 6 + .../reference/api/QueryRulesPutRuleRequest.md | 12 + .../api/QueryRulesPutRuleResponse.md | 5 + .../api/QueryRulesPutRulesetRequest.md | 8 + .../api/QueryRulesPutRulesetResponse.md | 5 + docs/reference/api/QueryRulesQueryRule.md | 9 + .../api/QueryRulesQueryRuleActions.md | 6 + .../api/QueryRulesQueryRuleCriteria.md | 7 + .../api/QueryRulesQueryRuleCriteriaType.md | 4 + docs/reference/api/QueryRulesQueryRuleType.md | 4 + docs/reference/api/QueryRulesQueryRuleset.md | 6 + .../QueryRulesTestQueryRulesetMatchedRule.md | 6 + docs/reference/api/QueryRulesTestRequest.md | 8 + docs/reference/api/QueryRulesTestResponse.md | 6 + docs/reference/api/QueryVector.md | 4 + docs/reference/api/QueryVectorBuilder.md | 5 + docs/reference/api/RRFRetriever.md | 7 + docs/reference/api/RankBase.md | 4 + docs/reference/api/RankContainer.md | 5 + docs/reference/api/RankEvalApi_1.md | 3 + docs/reference/api/RankEvalApi_2.md | 3 + docs/reference/api/RankEvalApi_3.md | 3 + docs/reference/api/RankEvalDocumentRating.md | 7 + docs/reference/api/RankEvalRankEvalHit.md | 7 + docs/reference/api/RankEvalRankEvalHitItem.md | 6 + docs/reference/api/RankEvalRankEvalMetric.md | 9 + .../api/RankEvalRankEvalMetricBase.md | 5 + .../api/RankEvalRankEvalMetricDetail.md | 8 + ...lRankEvalMetricDiscountedCumulativeGain.md | 5 + ...valRankEvalMetricExpectedReciprocalRank.md | 5 + ...ankEvalRankEvalMetricMeanReciprocalRank.md | 4 + .../api/RankEvalRankEvalMetricPrecision.md | 5 + .../RankEvalRankEvalMetricRatingTreshold.md | 5 + .../api/RankEvalRankEvalMetricRecall.md | 4 + docs/reference/api/RankEvalRankEvalQuery.md | 6 + .../api/RankEvalRankEvalRequestItem.md | 9 + docs/reference/api/RankEvalRequest.md | 13 + docs/reference/api/RankEvalResponse.md | 7 + docs/reference/api/RankEvalUnratedDocument.md | 6 + docs/reference/api/RecoveryStats.md | 8 + docs/reference/api/Refresh.md | 4 + docs/reference/api/RefreshStats.md | 10 + docs/reference/api/ReindexApi_1.md | 3 + docs/reference/api/ReindexApi_2.md | 3 + docs/reference/api/ReindexApi_3.md | 3 + docs/reference/api/ReindexDestination.md | 9 + docs/reference/api/ReindexRemoteSource.md | 10 + docs/reference/api/ReindexRequest.md | 20 + docs/reference/api/ReindexResponse.md | 20 + docs/reference/api/ReindexRethrottleApi_1.md | 3 + docs/reference/api/ReindexRethrottleApi_2.md | 3 + docs/reference/api/ReindexRethrottleApi_3.md | 3 + .../api/ReindexRethrottleReindexNode.md | 5 + .../api/ReindexRethrottleReindexStatus.md | 17 + .../api/ReindexRethrottleReindexTask.md | 14 + .../reference/api/ReindexRethrottleRequest.md | 8 + .../api/ReindexRethrottleResponse.md | 5 + docs/reference/api/ReindexSource.md | 12 + docs/reference/api/RelationName.md | 4 + docs/reference/api/RelocationFailureInfo.md | 5 + .../api/RenderSearchTemplateApi_1.md | 3 + .../api/RenderSearchTemplateApi_2.md | 3 + .../api/RenderSearchTemplateApi_3.md | 3 + .../api/RenderSearchTemplateRequest.md | 10 + .../api/RenderSearchTemplateResponse.md | 5 + docs/reference/api/RequestBase.md | 4 + docs/reference/api/RequestCacheStats.md | 9 + docs/reference/api/RescoreVector.md | 5 + docs/reference/api/Result.md | 4 + docs/reference/api/Retries.md | 6 + docs/reference/api/RetrieverBase.md | 6 + docs/reference/api/RetrieverContainer.md | 9 + docs/reference/api/Rollup.md | 20 + .../api/RollupDateHistogramGrouping.md | 11 + docs/reference/api/RollupDeleteJobRequest.md | 7 + docs/reference/api/RollupDeleteJobResponse.md | 6 + docs/reference/api/RollupFieldMetric.md | 6 + .../api/RollupGetJobsIndexingJobState.md | 4 + docs/reference/api/RollupGetJobsRequest.md | 7 + docs/reference/api/RollupGetJobsResponse.md | 5 + docs/reference/api/RollupGetJobsRollupJob.md | 7 + .../RollupGetJobsRollupJobConfiguration.md | 12 + .../api/RollupGetJobsRollupJobStats.md | 16 + .../api/RollupGetJobsRollupJobStatus.md | 7 + .../api/RollupGetRollupCapsRequest.md | 7 + .../api/RollupGetRollupCapsResponse.md | 4 + .../RollupGetRollupCapsRollupCapabilities.md | 5 + ...lupGetRollupCapsRollupCapabilitySummary.md | 8 + .../RollupGetRollupCapsRollupFieldSummary.md | 7 + ...llupGetRollupIndexCapsIndexCapabilities.md | 5 + .../api/RollupGetRollupIndexCapsRequest.md | 7 + .../api/RollupGetRollupIndexCapsResponse.md | 4 + ...ollupGetRollupIndexCapsRollupJobSummary.md | 8 + ...GetRollupIndexCapsRollupJobSummaryField.md | 7 + docs/reference/api/RollupGroupings.md | 7 + docs/reference/api/RollupHistogramGrouping.md | 6 + docs/reference/api/RollupMetric.md | 4 + docs/reference/api/RollupPutJobRequest.md | 15 + docs/reference/api/RollupPutJobResponse.md | 4 + .../api/RollupRollupSearchRequest.md | 13 + .../api/RollupRollupSearchResponse.md | 10 + docs/reference/api/RollupStartJobRequest.md | 7 + docs/reference/api/RollupStartJobResponse.md | 5 + docs/reference/api/RollupStopJobRequest.md | 9 + docs/reference/api/RollupStopJobResponse.md | 5 + docs/reference/api/RollupTermsGrouping.md | 5 + docs/reference/api/Routing.md | 4 + docs/reference/api/RrfRank.md | 6 + docs/reference/api/RuleRetriever.md | 8 + docs/reference/api/ScalarValue.md | 4 + docs/reference/api/ScoreSort.md | 5 + docs/reference/api/Script.md | 9 + docs/reference/api/ScriptField.md | 6 + docs/reference/api/ScriptLanguage.md | 4 + docs/reference/api/ScriptSort.md | 9 + docs/reference/api/ScriptSortType.md | 4 + docs/reference/api/ScriptSource.md | 4 + docs/reference/api/ScriptTransform.md | 8 + .../api/ScriptsPainlessExecuteApi_1.md | 3 + .../api/ScriptsPainlessExecuteApi_2.md | 3 + .../api/ScriptsPainlessExecuteApi_3.md | 3 + .../ScriptsPainlessExecutePainlessContext.md | 4 + ...iptsPainlessExecutePainlessContextSetup.md | 7 + .../api/ScriptsPainlessExecuteRequest.md | 9 + .../api/ScriptsPainlessExecuteResponse.md | 5 + docs/reference/api/ScrollApi_1.md | 3 + docs/reference/api/ScrollApi_2.md | 3 + docs/reference/api/ScrollApi_3.md | 3 + docs/reference/api/ScrollId.md | 4 + docs/reference/api/ScrollIds.md | 4 + docs/reference/api/ScrollRequest.md | 9 + docs/reference/api/ScrollResponse.md | 4 + docs/reference/api/ScrollSearchOptions.md | 5 + docs/reference/api/ScrollSearchResponse.md | 6 + .../api/SearchAggregationBreakdown.md | 16 + .../reference/api/SearchAggregationProfile.md | 10 + .../api/SearchAggregationProfileDebug.md | 36 + ...chAggregationProfileDelegateDebugFilter.md | 8 + docs/reference/api/SearchApi_1.md | 3 + docs/reference/api/SearchApi_2.md | 3 + docs/reference/api/SearchApi_3.md | 3 + docs/reference/api/SearchApplication.md | 20 + .../SearchApplicationAnalyticsCollection.md | 5 + ...icationDeleteBehavioralAnalyticsRequest.md | 7 + ...cationDeleteBehavioralAnalyticsResponse.md | 4 + .../api/SearchApplicationDeleteRequest.md | 7 + .../api/SearchApplicationDeleteResponse.md | 4 + .../api/SearchApplicationEventDataStream.md | 5 + .../api/SearchApplicationEventType.md | 4 + ...pplicationGetBehavioralAnalyticsRequest.md | 7 + ...plicationGetBehavioralAnalyticsResponse.md | 4 + .../api/SearchApplicationGetRequest.md | 7 + .../api/SearchApplicationGetResponse.md | 4 + .../api/SearchApplicationListRequest.md | 9 + .../api/SearchApplicationListResponse.md | 6 + ...tionPostBehavioralAnalyticsEventRequest.md | 10 + ...ionPostBehavioralAnalyticsEventResponse.md | 6 + ...alyticsAnalyticsAcknowledgeResponseBase.md | 5 + ...pplicationPutBehavioralAnalyticsRequest.md | 7 + ...plicationPutBehavioralAnalyticsResponse.md | 4 + .../api/SearchApplicationPutRequest.md | 9 + .../api/SearchApplicationPutResponse.md | 5 + .../SearchApplicationRenderQueryRequest.md | 8 + .../SearchApplicationRenderQueryResponse.md | 4 + .../api/SearchApplicationSearchApplication.md | 6 + ...hApplicationSearchApplicationParameters.md | 7 + ...rchApplicationSearchApplicationTemplate.md | 5 + .../api/SearchApplicationSearchRequest.md | 9 + .../api/SearchApplicationSearchResponse.md | 4 + docs/reference/api/SearchBoundaryScanner.md | 4 + docs/reference/api/SearchCollector.md | 8 + docs/reference/api/SearchCompletionContext.md | 9 + docs/reference/api/SearchCompletionSuggest.md | 5 + .../api/SearchCompletionSuggestOption.md | 14 + .../api/SearchCompletionSuggester.md | 8 + docs/reference/api/SearchContext.md | 4 + docs/reference/api/SearchDfsKnnProfile.md | 8 + docs/reference/api/SearchDfsProfile.md | 6 + .../api/SearchDfsStatisticsBreakdown.md | 12 + .../api/SearchDfsStatisticsProfile.md | 11 + docs/reference/api/SearchDirectGenerator.md | 15 + docs/reference/api/SearchFetchProfile.md | 10 + .../api/SearchFetchProfileBreakdown.md | 12 + docs/reference/api/SearchFetchProfileDebug.md | 6 + docs/reference/api/SearchFieldCollapse.md | 8 + docs/reference/api/SearchFieldSuggester.md | 10 + docs/reference/api/SearchHighlight.md | 6 + docs/reference/api/SearchHighlightBase.md | 25 + docs/reference/api/SearchHighlightField.md | 6 + .../reference/api/SearchHighlighterEncoder.md | 4 + .../api/SearchHighlighterFragmenter.md | 4 + docs/reference/api/SearchHighlighterOrder.md | 4 + .../api/SearchHighlighterTagsSchema.md | 4 + docs/reference/api/SearchHighlighterType.md | 4 + docs/reference/api/SearchHit.md | 24 + docs/reference/api/SearchHitsMetadata.md | 7 + docs/reference/api/SearchInnerHits.md | 20 + docs/reference/api/SearchInnerHitsResult.md | 5 + .../reference/api/SearchKnnCollectorResult.md | 9 + .../api/SearchKnnQueryProfileBreakdown.md | 24 + .../api/SearchKnnQueryProfileResult.md | 11 + .../api/SearchLaplaceSmoothingModel.md | 5 + docs/reference/api/SearchLearningToRank.md | 6 + ...SearchLinearInterpolationSmoothingModel.md | 7 + docs/reference/api/SearchMvtApi_1.md | 3 + docs/reference/api/SearchMvtApi_2.md | 3 + docs/reference/api/SearchMvtApi_3.md | 3 + docs/reference/api/SearchMvtCoordinate.md | 4 + .../api/SearchMvtGridAggregationType.md | 4 + docs/reference/api/SearchMvtGridType.md | 4 + docs/reference/api/SearchMvtRequest.md | 25 + docs/reference/api/SearchMvtResponse.md | 4 + docs/reference/api/SearchMvtZoomLevel.md | 4 + docs/reference/api/SearchNestedIdentity.md | 7 + docs/reference/api/SearchPhraseSuggest.md | 5 + .../api/SearchPhraseSuggestCollate.md | 7 + .../api/SearchPhraseSuggestCollateQuery.md | 6 + .../api/SearchPhraseSuggestHighlight.md | 6 + .../api/SearchPhraseSuggestOption.md | 8 + docs/reference/api/SearchPhraseSuggester.md | 17 + .../api/SearchPointInTimeReference.md | 6 + docs/reference/api/SearchProfile.md | 5 + docs/reference/api/SearchQueryBreakdown.md | 24 + docs/reference/api/SearchQueryProfile.md | 9 + docs/reference/api/SearchRegexOptions.md | 6 + docs/reference/api/SearchRequest.md | 72 + docs/reference/api/SearchRescore.md | 7 + docs/reference/api/SearchRescoreQuery.md | 8 + docs/reference/api/SearchResponse.md | 4 + docs/reference/api/SearchResponseBody.md | 18 + docs/reference/api/SearchScoreMode.md | 4 + docs/reference/api/SearchSearchProfile.md | 7 + docs/reference/api/SearchSearchRequestBody.md | 39 + docs/reference/api/SearchShardProfile.md | 13 + docs/reference/api/SearchShardsApi_1.md | 3 + docs/reference/api/SearchShardsApi_2.md | 3 + docs/reference/api/SearchShardsApi_3.md | 3 + docs/reference/api/SearchShardsRequest.md | 14 + docs/reference/api/SearchShardsResponse.md | 7 + .../SearchShardsSearchShardsNodeAttributes.md | 13 + .../api/SearchShardsShardStoreIndex.md | 6 + .../api/SearchSmoothingModelContainer.md | 7 + docs/reference/api/SearchSourceConfig.md | 4 + docs/reference/api/SearchSourceConfigParam.md | 4 + docs/reference/api/SearchSourceFilter.md | 8 + docs/reference/api/SearchStats.md | 22 + docs/reference/api/SearchStringDistance.md | 4 + .../api/SearchStupidBackoffSmoothingModel.md | 5 + docs/reference/api/SearchSuggest.md | 4 + docs/reference/api/SearchSuggestBase.md | 7 + docs/reference/api/SearchSuggestFuzziness.md | 9 + docs/reference/api/SearchSuggestSort.md | 4 + docs/reference/api/SearchSuggester.md | 4 + docs/reference/api/SearchSuggesterBase.md | 7 + docs/reference/api/SearchSuggesterKeys.md | 5 + docs/reference/api/SearchTemplateApi_1.md | 3 + docs/reference/api/SearchTemplateApi_2.md | 3 + docs/reference/api/SearchTemplateApi_3.md | 3 + docs/reference/api/SearchTemplateRequest.md | 23 + docs/reference/api/SearchTemplateResponse.md | 18 + docs/reference/api/SearchTermSuggest.md | 5 + docs/reference/api/SearchTermSuggestOption.md | 9 + docs/reference/api/SearchTermSuggester.md | 16 + docs/reference/api/SearchTotalHits.md | 6 + docs/reference/api/SearchTotalHitsRelation.md | 4 + docs/reference/api/SearchTrackHits.md | 4 + docs/reference/api/SearchTransform.md | 6 + docs/reference/api/SearchType.md | 4 + docs/reference/api/SearchableSnapshots.md | 20 + .../api/SearchableSnapshotsCacheStatsNode.md | 5 + .../SearchableSnapshotsCacheStatsRequest.md | 8 + .../SearchableSnapshotsCacheStatsResponse.md | 5 + .../SearchableSnapshotsCacheStatsShared.md | 12 + .../SearchableSnapshotsClearCacheRequest.md | 10 + .../SearchableSnapshotsClearCacheResponse.md | 4 + ...SearchableSnapshotsMountMountedSnapshot.md | 7 + .../api/SearchableSnapshotsMountRequest.md | 15 + .../api/SearchableSnapshotsMountResponse.md | 5 + .../api/SearchableSnapshotsStatsLevel.md | 4 + .../api/SearchableSnapshotsStatsRequest.md | 8 + .../api/SearchableSnapshotsStatsResponse.md | 6 + docs/reference/api/Security.md | 20 + docs/reference/api/SecurityAccess.md | 6 + .../api/SecurityActivateUserProfileRequest.md | 10 + .../SecurityActivateUserProfileResponse.md | 4 + docs/reference/api/SecurityApiKey.md | 20 + docs/reference/api/SecurityApiKeyType.md | 4 + ...SecurityApplicationGlobalUserPrivileges.md | 5 + .../api/SecurityApplicationPrivileges.md | 7 + .../SecurityAuthenticateAuthenticateApiKey.md | 6 + .../api/SecurityAuthenticateRequest.md | 6 + .../api/SecurityAuthenticateResponse.md | 15 + .../api/SecurityAuthenticateToken.md | 6 + .../api/SecurityBulkDeleteRoleRequest.md | 8 + .../api/SecurityBulkDeleteRoleResponse.md | 7 + docs/reference/api/SecurityBulkError.md | 6 + .../api/SecurityBulkPutRoleRequest.md | 8 + .../api/SecurityBulkPutRoleResponse.md | 8 + .../api/SecurityBulkUpdateApiKeysRequest.md | 10 + .../api/SecurityBulkUpdateApiKeysResponse.md | 7 + .../api/SecurityChangePasswordRequest.md | 10 + .../api/SecurityChangePasswordResponse.md | 4 + .../api/SecurityClearApiKeyCacheRequest.md | 7 + .../api/SecurityClearApiKeyCacheResponse.md | 7 + .../SecurityClearCachedPrivilegesRequest.md | 7 + .../SecurityClearCachedPrivilegesResponse.md | 7 + .../api/SecurityClearCachedRealmsRequest.md | 8 + .../api/SecurityClearCachedRealmsResponse.md | 7 + .../api/SecurityClearCachedRolesRequest.md | 7 + .../api/SecurityClearCachedRolesResponse.md | 7 + ...SecurityClearCachedServiceTokensRequest.md | 9 + ...ecurityClearCachedServiceTokensResponse.md | 7 + docs/reference/api/SecurityClusterNode.md | 5 + .../reference/api/SecurityClusterPrivilege.md | 4 + .../api/SecurityCreateApiKeyRequest.md | 11 + .../api/SecurityCreateApiKeyResponse.md | 9 + ...SecurityCreateCrossClusterApiKeyRequest.md | 10 + ...ecurityCreateCrossClusterApiKeyResponse.md | 9 + .../api/SecurityCreateServiceTokenRequest.md | 10 + .../api/SecurityCreateServiceTokenResponse.md | 6 + .../api/SecurityCreateServiceTokenToken.md | 6 + docs/reference/api/SecurityCreatedStatus.md | 5 + .../api/SecurityDelegatePkiAuthentication.md | 15 + .../SecurityDelegatePkiAuthenticationRealm.md | 7 + .../api/SecurityDelegatePkiRequest.md | 7 + .../api/SecurityDelegatePkiResponse.md | 8 + .../SecurityDeletePrivilegesFoundStatus.md | 5 + .../api/SecurityDeletePrivilegesRequest.md | 9 + .../api/SecurityDeletePrivilegesResponse.md | 4 + .../api/SecurityDeleteRoleMappingRequest.md | 8 + .../api/SecurityDeleteRoleMappingResponse.md | 5 + .../api/SecurityDeleteRoleRequest.md | 8 + .../api/SecurityDeleteRoleResponse.md | 5 + .../api/SecurityDeleteServiceTokenRequest.md | 10 + .../api/SecurityDeleteServiceTokenResponse.md | 5 + .../api/SecurityDeleteUserRequest.md | 8 + .../api/SecurityDeleteUserResponse.md | 5 + .../api/SecurityDisableUserProfileRequest.md | 8 + .../api/SecurityDisableUserProfileResponse.md | 4 + .../api/SecurityDisableUserRequest.md | 8 + .../api/SecurityDisableUserResponse.md | 4 + .../api/SecurityEnableUserProfileRequest.md | 8 + .../api/SecurityEnableUserProfileResponse.md | 4 + .../api/SecurityEnableUserRequest.md | 8 + .../api/SecurityEnableUserResponse.md | 4 + .../api/SecurityEnrollKibanaRequest.md | 6 + .../api/SecurityEnrollKibanaResponse.md | 6 + .../api/SecurityEnrollKibanaToken.md | 6 + .../api/SecurityEnrollNodeRequest.md | 6 + .../api/SecurityEnrollNodeResponse.md | 10 + docs/reference/api/SecurityFieldSecurity.md | 6 + .../reference/api/SecurityGetApiKeyRequest.md | 14 + .../api/SecurityGetApiKeyResponse.md | 5 + .../SecurityGetBuiltinPrivilegesRequest.md | 6 + .../SecurityGetBuiltinPrivilegesResponse.md | 7 + .../api/SecurityGetPrivilegesRequest.md | 8 + .../api/SecurityGetPrivilegesResponse.md | 4 + .../api/SecurityGetRoleMappingRequest.md | 7 + .../api/SecurityGetRoleMappingResponse.md | 4 + docs/reference/api/SecurityGetRoleRequest.md | 7 + docs/reference/api/SecurityGetRoleResponse.md | 4 + docs/reference/api/SecurityGetRoleRole.md | 15 + .../api/SecurityGetServiceAccountsRequest.md | 8 + .../api/SecurityGetServiceAccountsResponse.md | 4 + ...GetServiceAccountsRoleDescriptorWrapper.md | 5 + ...tyGetServiceCredentialsNodesCredentials.md | 6 + ...iceCredentialsNodesCredentialsFileToken.md | 5 + .../SecurityGetServiceCredentialsRequest.md | 8 + .../SecurityGetServiceCredentialsResponse.md | 8 + .../api/SecurityGetSettingsRequest.md | 7 + .../api/SecurityGetSettingsResponse.md | 7 + .../SecurityGetTokenAccessTokenGrantType.md | 4 + .../api/SecurityGetTokenAuthenticatedUser.md | 8 + .../SecurityGetTokenAuthenticationProvider.md | 6 + docs/reference/api/SecurityGetTokenRequest.md | 12 + .../reference/api/SecurityGetTokenResponse.md | 11 + .../api/SecurityGetTokenUserRealm.md | 6 + .../api/SecurityGetUserPrivilegesRequest.md | 9 + .../api/SecurityGetUserPrivilegesResponse.md | 11 + ...urityGetUserProfileGetUserProfileErrors.md | 6 + .../api/SecurityGetUserProfileRequest.md | 8 + .../api/SecurityGetUserProfileResponse.md | 6 + docs/reference/api/SecurityGetUserRequest.md | 8 + docs/reference/api/SecurityGetUserResponse.md | 4 + docs/reference/api/SecurityGlobalPrivilege.md | 5 + .../api/SecurityGrantApiKeyApiKeyGrantType.md | 4 + .../api/SecurityGrantApiKeyGrantApiKey.md | 8 + .../api/SecurityGrantApiKeyRequest.md | 12 + .../api/SecurityGrantApiKeyResponse.md | 9 + docs/reference/api/SecurityGrantType.md | 4 + ...HasPrivilegesApplicationPrivilegesCheck.md | 7 + ...rityHasPrivilegesApplicationsPrivileges.md | 4 + ...curityHasPrivilegesIndexPrivilegesCheck.md | 7 + .../api/SecurityHasPrivilegesPrivileges.md | 4 + .../api/SecurityHasPrivilegesRequest.md | 10 + ...SecurityHasPrivilegesResourcePrivileges.md | 4 + .../api/SecurityHasPrivilegesResponse.md | 9 + ...erProfileHasPrivilegesUserProfileErrors.md | 6 + ...HasPrivilegesUserProfilePrivilegesCheck.md | 7 + ...SecurityHasPrivilegesUserProfileRequest.md | 8 + ...ecurityHasPrivilegesUserProfileResponse.md | 6 + docs/reference/api/SecurityIndexPrivilege.md | 4 + .../api/SecurityIndicesPrivileges.md | 9 + .../api/SecurityIndicesPrivilegesQuery.md | 4 + .../api/SecurityInvalidateApiKeyRequest.md | 12 + .../api/SecurityInvalidateApiKeyResponse.md | 8 + .../api/SecurityInvalidateTokenRequest.md | 10 + .../api/SecurityInvalidateTokenResponse.md | 8 + .../api/SecurityManageUserPrivileges.md | 5 + .../api/SecurityOidcAuthenticateRequest.md | 10 + .../api/SecurityOidcAuthenticateResponse.md | 8 + .../api/SecurityOidcLogoutRequest.md | 8 + .../api/SecurityOidcLogoutResponse.md | 5 + ...ecurityOidcPrepareAuthenticationRequest.md | 11 + ...curityOidcPrepareAuthenticationResponse.md | 8 + .../api/SecurityPutPrivilegesActions.md | 8 + .../api/SecurityPutPrivilegesRequest.md | 8 + .../api/SecurityPutPrivilegesResponse.md | 4 + .../api/SecurityPutRoleMappingRequest.md | 14 + .../api/SecurityPutRoleMappingResponse.md | 6 + docs/reference/api/SecurityPutRoleRequest.md | 18 + docs/reference/api/SecurityPutRoleResponse.md | 5 + docs/reference/api/SecurityPutUserRequest.md | 15 + docs/reference/api/SecurityPutUserResponse.md | 5 + .../SecurityQueryApiKeysApiKeyAggregate.md | 4 + ...yQueryApiKeysApiKeyAggregationContainer.md | 16 + ...ityQueryApiKeysApiKeyFiltersAggregation.md | 8 + ...ecurityQueryApiKeysApiKeyQueryContainer.md | 15 + .../api/SecurityQueryApiKeysRequest.md | 16 + .../api/SecurityQueryApiKeysResponse.md | 8 + .../api/SecurityQueryRoleQueryRole.md | 6 + .../reference/api/SecurityQueryRoleRequest.md | 11 + .../api/SecurityQueryRoleResponse.md | 7 + .../SecurityQueryRoleRoleQueryContainer.md | 15 + .../api/SecurityQueryUserQueryUser.md | 5 + .../reference/api/SecurityQueryUserRequest.md | 12 + .../api/SecurityQueryUserResponse.md | 7 + .../SecurityQueryUserUserQueryContainer.md | 15 + docs/reference/api/SecurityRealmInfo.md | 6 + .../api/SecurityRemoteClusterPrivilege.md | 4 + .../api/SecurityRemoteClusterPrivileges.md | 6 + .../api/SecurityRemoteIndicesPrivileges.md | 10 + .../SecurityRemoteUserIndicesPrivileges.md | 10 + .../api/SecurityReplicationAccess.md | 6 + docs/reference/api/SecurityRestriction.md | 5 + .../api/SecurityRestrictionWorkflow.md | 4 + docs/reference/api/SecurityRoleDescriptor.md | 16 + .../api/SecurityRoleDescriptorRead.md | 16 + docs/reference/api/SecurityRoleMapping.md | 9 + docs/reference/api/SecurityRoleMappingRule.md | 8 + docs/reference/api/SecurityRoleTemplate.md | 6 + .../api/SecurityRoleTemplateInlineQuery.md | 4 + .../api/SecurityRoleTemplateQuery.md | 5 + .../api/SecurityRoleTemplateScript.md | 9 + .../api/SecuritySamlAuthenticateRequest.md | 9 + .../api/SecuritySamlAuthenticateResponse.md | 9 + .../api/SecuritySamlCompleteLogoutRequest.md | 10 + .../api/SecuritySamlCompleteLogoutResponse.md | 4 + .../api/SecuritySamlInvalidateRequest.md | 9 + .../api/SecuritySamlInvalidateResponse.md | 7 + .../api/SecuritySamlLogoutRequest.md | 8 + .../api/SecuritySamlLogoutResponse.md | 5 + ...ecuritySamlPrepareAuthenticationRequest.md | 9 + ...curitySamlPrepareAuthenticationResponse.md | 7 + ...uritySamlServiceProviderMetadataRequest.md | 7 + ...ritySamlServiceProviderMetadataResponse.md | 5 + docs/reference/api/SecuritySearchAccess.md | 8 + .../reference/api/SecuritySecuritySettings.md | 5 + .../api/SecuritySuggestUserProfilesHint.md | 6 + .../api/SecuritySuggestUserProfilesRequest.md | 10 + .../SecuritySuggestUserProfilesResponse.md | 7 + ...itySuggestUserProfilesTotalUserProfiles.md | 6 + docs/reference/api/SecurityTemplateFormat.md | 4 + .../api/SecurityUpdateApiKeyRequest.md | 10 + .../api/SecurityUpdateApiKeyResponse.md | 5 + ...SecurityUpdateCrossClusterApiKeyRequest.md | 10 + ...ecurityUpdateCrossClusterApiKeyResponse.md | 5 + .../api/SecurityUpdateSettingsRequest.md | 11 + .../api/SecurityUpdateSettingsResponse.md | 5 + .../SecurityUpdateUserProfileDataRequest.md | 12 + .../SecurityUpdateUserProfileDataResponse.md | 4 + docs/reference/api/SecurityUser.md | 11 + .../api/SecurityUserIndicesPrivileges.md | 9 + docs/reference/api/SecurityUserProfile.md | 9 + .../api/SecurityUserProfileHitMetadata.md | 6 + docs/reference/api/SecurityUserProfileId.md | 4 + docs/reference/api/SecurityUserProfileUser.md | 10 + .../api/SecurityUserProfileWithMetadata.md | 6 + docs/reference/api/SegmentsStats.md | 28 + docs/reference/api/SequenceNumber.md | 4 + docs/reference/api/Service.md | 4 + docs/reference/api/ShardFailure.md | 9 + docs/reference/api/ShardStatistics.md | 9 + .../api/ShardsOperationResponseBase.md | 5 + docs/reference/api/Shutdown.md | 20 + .../api/ShutdownDeleteNodeRequest.md | 9 + .../api/ShutdownDeleteNodeResponse.md | 4 + .../api/ShutdownGetNodeNodeShutdownStatus.md | 12 + .../ShutdownGetNodePersistentTaskStatus.md | 5 + .../api/ShutdownGetNodePluginsStatus.md | 5 + docs/reference/api/ShutdownGetNodeRequest.md | 8 + docs/reference/api/ShutdownGetNodeResponse.md | 5 + .../ShutdownGetNodeShardMigrationStatus.md | 5 + .../api/ShutdownGetNodeShutdownStatus.md | 4 + .../api/ShutdownGetNodeShutdownType.md | 4 + docs/reference/api/ShutdownPutNodeRequest.md | 13 + docs/reference/api/ShutdownPutNodeResponse.md | 4 + docs/reference/api/ShutdownType.md | 4 + docs/reference/api/Simulate.md | 20 + .../SimulateIngestIngestDocumentSimulation.md | 4 + ...ulateIngestIngestDocumentSimulationKeys.md | 11 + docs/reference/api/SimulateIngestRequest.md | 13 + docs/reference/api/SimulateIngestResponse.md | 5 + ...ulateIngestSimulateIngestDocumentResult.md | 5 + docs/reference/api/SlicedScroll.md | 7 + docs/reference/api/Slices.md | 4 + docs/reference/api/SlicesCalculation.md | 4 + docs/reference/api/Slm.md | 20 + docs/reference/api/SlmConfiguration.md | 10 + .../api/SlmDeleteLifecycleRequest.md | 9 + .../api/SlmDeleteLifecycleResponse.md | 4 + .../api/SlmExecuteLifecycleRequest.md | 9 + .../api/SlmExecuteLifecycleResponse.md | 5 + .../api/SlmExecuteRetentionRequest.md | 8 + .../api/SlmExecuteRetentionResponse.md | 4 + docs/reference/api/SlmGetLifecycleRequest.md | 9 + docs/reference/api/SlmGetLifecycleResponse.md | 4 + docs/reference/api/SlmGetStatsRequest.md | 8 + docs/reference/api/SlmGetStatsResponse.md | 14 + docs/reference/api/SlmGetStatusRequest.md | 8 + docs/reference/api/SlmGetStatusResponse.md | 5 + docs/reference/api/SlmInProgress.md | 8 + docs/reference/api/SlmInvocation.md | 6 + docs/reference/api/SlmPolicy.md | 9 + docs/reference/api/SlmPutLifecycleRequest.md | 14 + docs/reference/api/SlmPutLifecycleResponse.md | 4 + docs/reference/api/SlmRetention.md | 7 + docs/reference/api/SlmSnapshotLifecycle.md | 14 + docs/reference/api/SlmStartRequest.md | 8 + docs/reference/api/SlmStartResponse.md | 4 + docs/reference/api/SlmStatistics.md | 18 + docs/reference/api/SlmStopRequest.md | 8 + docs/reference/api/SlmStopResponse.md | 4 + docs/reference/api/Snapshot.md | 20 + docs/reference/api/SnapshotAzureRepository.md | 6 + .../api/SnapshotAzureRepositorySettings.md | 11 + ...eanupRepositoryCleanupRepositoryResults.md | 6 + .../api/SnapshotCleanupRepositoryRequest.md | 9 + .../api/SnapshotCleanupRepositoryResponse.md | 5 + docs/reference/api/SnapshotCloneRequest.md | 11 + docs/reference/api/SnapshotCloneResponse.md | 4 + .../api/SnapshotCreateRepositoryRequest.md | 11 + .../api/SnapshotCreateRepositoryResponse.md | 4 + docs/reference/api/SnapshotCreateRequest.md | 17 + docs/reference/api/SnapshotCreateResponse.md | 6 + .../api/SnapshotDeleteRepositoryRequest.md | 9 + .../api/SnapshotDeleteRepositoryResponse.md | 4 + docs/reference/api/SnapshotDeleteRequest.md | 9 + docs/reference/api/SnapshotDeleteResponse.md | 4 + .../api/SnapshotFileCountSnapshotStats.md | 6 + docs/reference/api/SnapshotGcsRepository.md | 6 + .../api/SnapshotGcsRepositorySettings.md | 9 + .../api/SnapshotGetRepositoryRequest.md | 9 + .../api/SnapshotGetRepositoryResponse.md | 4 + docs/reference/api/SnapshotGetRequest.md | 21 + docs/reference/api/SnapshotGetResponse.md | 9 + .../api/SnapshotGetSnapshotResponseItem.md | 7 + docs/reference/api/SnapshotIndexDetails.md | 8 + .../reference/api/SnapshotInfoFeatureState.md | 6 + .../api/SnapshotReadOnlyUrlRepository.md | 6 + .../SnapshotReadOnlyUrlRepositorySettings.md | 8 + docs/reference/api/SnapshotRepository.md | 4 + .../SnapshotRepositoryAnalyzeBlobDetails.md | 12 + .../SnapshotRepositoryAnalyzeDetailsInfo.md | 12 + ...napshotRepositoryAnalyzeReadBlobDetails.md | 13 + ...napshotRepositoryAnalyzeReadSummaryInfo.md | 15 + .../api/SnapshotRepositoryAnalyzeRequest.md | 19 + .../api/SnapshotRepositoryAnalyzeResponse.md | 24 + ...apshotRepositoryAnalyzeSnapshotNodeInfo.md | 6 + .../SnapshotRepositoryAnalyzeSummaryInfo.md | 6 + ...apshotRepositoryAnalyzeWriteSummaryInfo.md | 11 + docs/reference/api/SnapshotRepositoryBase.md | 5 + .../api/SnapshotRepositorySettingsBase.md | 8 + ...napshotRepositoryVerifyIntegrityRequest.md | 15 + ...apshotRepositoryVerifyIntegrityResponse.md | 4 + docs/reference/api/SnapshotRestoreRequest.md | 20 + docs/reference/api/SnapshotRestoreResponse.md | 6 + .../api/SnapshotRestoreSnapshotRestore.md | 7 + docs/reference/api/SnapshotS3Repository.md | 6 + .../api/SnapshotS3RepositorySettings.md | 19 + docs/reference/api/SnapshotShardsStats.md | 10 + .../reference/api/SnapshotShardsStatsStage.md | 4 + .../api/SnapshotShardsStatsSummary.md | 9 + .../api/SnapshotShardsStatsSummaryItem.md | 6 + .../api/SnapshotSharedFileSystemRepository.md | 6 + ...pshotSharedFileSystemRepositorySettings.md | 7 + .../api/SnapshotSnapshotIndexStats.md | 7 + docs/reference/api/SnapshotSnapshotInfo.md | 25 + .../api/SnapshotSnapshotShardFailure.md | 10 + .../api/SnapshotSnapshotShardsStatus.md | 6 + docs/reference/api/SnapshotSnapshotSort.md | 4 + docs/reference/api/SnapshotSnapshotStats.md | 9 + .../api/SnapshotSourceOnlyRepository.md | 6 + .../SnapshotSourceOnlyRepositorySettings.md | 8 + docs/reference/api/SnapshotStatus.md | 12 + docs/reference/api/SnapshotStatusRequest.md | 10 + docs/reference/api/SnapshotStatusResponse.md | 5 + ...SnapshotVerifyRepositoryCompactNodeInfo.md | 5 + .../api/SnapshotVerifyRepositoryRequest.md | 9 + .../api/SnapshotVerifyRepositoryResponse.md | 5 + docs/reference/api/SniffingTransport.md | 10 + docs/reference/api/Sort.md | 4 + docs/reference/api/SortCombinations.md | 4 + docs/reference/api/SortMode.md | 4 + docs/reference/api/SortOptions.md | 4 + docs/reference/api/SortOptionsKeys.md | 8 + docs/reference/api/SortOrder.md | 4 + docs/reference/api/SortResults.md | 4 + .../api/SpecUtilsAdditionalProperties.md | 4 + .../api/SpecUtilsAdditionalProperty.md | 4 + docs/reference/api/SpecUtilsBaseNode.md | 10 + .../api/SpecUtilsCommonCatQueryParameters.md | 7 + .../api/SpecUtilsCommonQueryParameters.md | 8 + docs/reference/api/SpecUtilsNullValue.md | 4 + docs/reference/api/SpecUtilsOverloadOf.md | 4 + .../api/SpecUtilsPipeSeparatedFlags.md | 4 + docs/reference/api/SpecUtilsStringified.md | 4 + docs/reference/api/SpecUtilsWithNullValue.md | 4 + docs/reference/api/Sql.md | 20 + docs/reference/api/SqlClearCursorRequest.md | 7 + docs/reference/api/SqlClearCursorResponse.md | 5 + docs/reference/api/SqlColumn.md | 6 + docs/reference/api/SqlDeleteAsyncRequest.md | 7 + docs/reference/api/SqlDeleteAsyncResponse.md | 4 + docs/reference/api/SqlGetAsyncRequest.md | 11 + docs/reference/api/SqlGetAsyncResponse.md | 10 + .../reference/api/SqlGetAsyncStatusRequest.md | 7 + .../api/SqlGetAsyncStatusResponse.md | 10 + docs/reference/api/SqlQueryRequest.md | 24 + docs/reference/api/SqlQueryResponse.md | 10 + docs/reference/api/SqlQuerySqlFormat.md | 4 + docs/reference/api/SqlRow.md | 4 + docs/reference/api/SqlTranslateRequest.md | 10 + docs/reference/api/SqlTranslateResponse.md | 10 + docs/reference/api/Ssl.md | 20 + .../SslCertificatesCertificateInformation.md | 12 + docs/reference/api/SslCertificatesRequest.md | 6 + docs/reference/api/SslCertificatesResponse.md | 4 + docs/reference/api/StandardRetriever.md | 9 + docs/reference/api/StoreStats.md | 10 + docs/reference/api/StoredScript.md | 7 + docs/reference/api/StreamResult.md | 4 + docs/reference/api/SuggestMode.md | 4 + docs/reference/api/SuggestionName.md | 4 + docs/reference/api/Synonyms.md | 20 + .../api/SynonymsDeleteSynonymRequest.md | 7 + .../api/SynonymsDeleteSynonymResponse.md | 4 + .../api/SynonymsDeleteSynonymRuleRequest.md | 9 + .../api/SynonymsDeleteSynonymRuleResponse.md | 4 + .../api/SynonymsGetSynonymRequest.md | 9 + .../api/SynonymsGetSynonymResponse.md | 6 + .../api/SynonymsGetSynonymRuleRequest.md | 8 + .../api/SynonymsGetSynonymRuleResponse.md | 4 + .../api/SynonymsGetSynonymsSetsRequest.md | 8 + .../api/SynonymsGetSynonymsSetsResponse.md | 6 + .../SynonymsGetSynonymsSetsSynonymsSetItem.md | 6 + .../api/SynonymsPutSynonymRequest.md | 9 + .../api/SynonymsPutSynonymResponse.md | 6 + .../api/SynonymsPutSynonymRuleRequest.md | 10 + .../api/SynonymsPutSynonymRuleResponse.md | 4 + docs/reference/api/SynonymsSynonymRule.md | 6 + docs/reference/api/SynonymsSynonymRuleRead.md | 6 + docs/reference/api/SynonymsSynonymString.md | 4 + .../api/SynonymsSynonymsUpdateResult.md | 6 + docs/reference/api/TODO.md | 4 + docs/reference/api/TaskFailure.md | 8 + docs/reference/api/TaskId.md | 4 + docs/reference/api/Tasks.md | 20 + docs/reference/api/TasksCancelRequest.md | 11 + docs/reference/api/TasksCancelResponse.md | 4 + docs/reference/api/TasksGetRequest.md | 9 + docs/reference/api/TasksGetResponse.md | 8 + docs/reference/api/TasksGroupBy.md | 4 + docs/reference/api/TasksListRequest.md | 13 + docs/reference/api/TasksListResponse.md | 4 + docs/reference/api/TasksNodeTasks.md | 11 + docs/reference/api/TasksParentTaskInfo.md | 5 + docs/reference/api/TasksTaskInfo.md | 17 + docs/reference/api/TasksTaskInfos.md | 4 + .../api/TasksTaskListResponseBase.md | 8 + docs/reference/api/TermsEnumApi_1.md | 3 + docs/reference/api/TermsEnumApi_2.md | 3 + docs/reference/api/TermsEnumApi_3.md | 3 + docs/reference/api/TermsEnumRequest.md | 14 + docs/reference/api/TermsEnumResponse.md | 7 + docs/reference/api/TermvectorsApi_1.md | 3 + docs/reference/api/TermvectorsApi_2.md | 3 + docs/reference/api/TermvectorsApi_3.md | 3 + .../api/TermvectorsFieldStatistics.md | 7 + docs/reference/api/TermvectorsFilter.md | 11 + docs/reference/api/TermvectorsRequest.md | 22 + docs/reference/api/TermvectorsResponse.md | 10 + docs/reference/api/TermvectorsTerm.md | 9 + docs/reference/api/TermvectorsTermVector.md | 6 + docs/reference/api/TermvectorsToken.md | 8 + docs/reference/api/TextEmbedding.md | 6 + docs/reference/api/TextSimilarityReranker.md | 9 + docs/reference/api/TextStructure.md | 20 + .../api/TextStructureEcsCompatibilityType.md | 4 + docs/reference/api/TextStructureFieldStat.md | 13 + .../TextStructureFindFieldStructureRequest.md | 20 + ...TextStructureFindFieldStructureResponse.md | 19 + ...extStructureFindMessageStructureRequest.md | 18 + ...xtStructureFindMessageStructureResponse.md | 19 + .../api/TextStructureFindStructureRequest.md | 22 + .../api/TextStructureFindStructureResponse.md | 26 + docs/reference/api/TextStructureFormatType.md | 4 + ...extStructureTestGrokPatternMatchedField.md | 7 + ...TextStructureTestGrokPatternMatchedText.md | 6 + .../TextStructureTestGrokPatternRequest.md | 9 + .../TextStructureTestGrokPatternResponse.md | 5 + docs/reference/api/TextStructureTopHit.md | 6 + docs/reference/api/That.md | 6 + docs/reference/api/That_10.md | 6 + docs/reference/api/That_11.md | 5 + docs/reference/api/That_12.md | 5 + docs/reference/api/That_13.md | 6 + docs/reference/api/That_14.md | 5 + docs/reference/api/That_15.md | 5 + docs/reference/api/That_16.md | 5 + docs/reference/api/That_17.md | 5 + docs/reference/api/That_18.md | 6 + docs/reference/api/That_19.md | 6 + docs/reference/api/That_20.md | 6 + docs/reference/api/That_21.md | 5 + docs/reference/api/That_22.md | 5 + docs/reference/api/That_23.md | 5 + docs/reference/api/That_24.md | 6 + docs/reference/api/That_25.md | 5 + docs/reference/api/That_26.md | 6 + docs/reference/api/That_27.md | 5 + docs/reference/api/That_28.md | 5 + docs/reference/api/That_29.md | 5 + docs/reference/api/That_3.md | 5 + docs/reference/api/That_30.md | 5 + docs/reference/api/That_31.md | 5 + docs/reference/api/That_32.md | 6 + docs/reference/api/That_33.md | 5 + docs/reference/api/That_34.md | 6 + docs/reference/api/That_35.md | 5 + docs/reference/api/That_36.md | 6 + docs/reference/api/That_37.md | 6 + docs/reference/api/That_38.md | 5 + docs/reference/api/That_39.md | 6 + docs/reference/api/That_4.md | 5 + docs/reference/api/That_40.md | 5 + docs/reference/api/That_41.md | 6 + docs/reference/api/That_42.md | 6 + docs/reference/api/That_43.md | 5 + docs/reference/api/That_44.md | 6 + docs/reference/api/That_45.md | 6 + docs/reference/api/That_46.md | 6 + docs/reference/api/That_47.md | 5 + docs/reference/api/That_48.md | 5 + docs/reference/api/That_49.md | 5 + docs/reference/api/That_5.md | 6 + docs/reference/api/That_50.md | 6 + docs/reference/api/That_51.md | 5 + docs/reference/api/That_52.md | 5 + docs/reference/api/That_53.md | 6 + docs/reference/api/That_54.md | 5 + docs/reference/api/That_55.md | 6 + docs/reference/api/That_56.md | 5 + docs/reference/api/That_57.md | 5 + docs/reference/api/That_58.md | 5 + docs/reference/api/That_59.md | 5 + docs/reference/api/That_6.md | 6 + docs/reference/api/That_60.md | 6 + docs/reference/api/That_61.md | 5 + docs/reference/api/That_62.md | 5 + docs/reference/api/That_63.md | 5 + docs/reference/api/That_64.md | 6 + docs/reference/api/That_65.md | 5 + docs/reference/api/That_66.md | 5 + docs/reference/api/That_67.md | 5 + docs/reference/api/That_68.md | 6 + docs/reference/api/That_69.md | 6 + docs/reference/api/That_7.md | 5 + docs/reference/api/That_70.md | 6 + docs/reference/api/That_71.md | 6 + docs/reference/api/That_72.md | 6 + docs/reference/api/That_73.md | 6 + docs/reference/api/That_74.md | 6 + docs/reference/api/That_75.md | 6 + docs/reference/api/That_76.md | 6 + docs/reference/api/That_77.md | 6 + docs/reference/api/That_78.md | 5 + docs/reference/api/That_79.md | 5 + docs/reference/api/That_8.md | 5 + docs/reference/api/That_80.md | 6 + docs/reference/api/That_81.md | 6 + docs/reference/api/That_82.md | 5 + docs/reference/api/That_83.md | 5 + docs/reference/api/That_84.md | 5 + docs/reference/api/That_85.md | 6 + docs/reference/api/That_86.md | 6 + docs/reference/api/That_9.md | 6 + docs/reference/api/ThreadType.md | 4 + docs/reference/api/TimeOfDay.md | 4 + docs/reference/api/TimeUnit.md | 4 + docs/reference/api/TimeZone.md | 4 + .../api/TopLeftBottomRightGeoBounds.md | 6 + .../api/TopRightBottomLeftGeoBounds.md | 6 + docs/reference/api/Transform.md | 20 + docs/reference/api/TransformContainer.md | 7 + .../api/TransformDeleteTransformRequest.md | 10 + .../api/TransformDeleteTransformResponse.md | 4 + docs/reference/api/TransformDestination.md | 6 + .../api/TransformGetTransformRequest.md | 11 + .../api/TransformGetTransformResponse.md | 6 + ...ansformGetTransformStatsCheckpointStats.md | 10 + ...TransformGetTransformStatsCheckpointing.md | 11 + .../api/TransformGetTransformStatsRequest.md | 11 + .../api/TransformGetTransformStatsResponse.md | 6 + ...rmGetTransformStatsTransformHealthIssue.md | 10 + ...mGetTransformStatsTransformIndexerStats.md | 21 + ...sformGetTransformStatsTransformProgress.md | 9 + ...ransformGetTransformStatsTransformStats.md | 11 + ...rmGetTransformStatsTransformStatsHealth.md | 6 + .../TransformGetTransformTransformSummary.md | 19 + docs/reference/api/TransformLatest.md | 6 + docs/reference/api/TransformPivot.md | 7 + .../api/TransformPivotGroupByContainer.md | 8 + .../api/TransformPreviewTransformRequest.md | 17 + .../api/TransformPreviewTransformResponse.md | 6 + .../api/TransformPutTransformRequest.md | 19 + .../api/TransformPutTransformResponse.md | 4 + .../api/TransformResetTransformRequest.md | 9 + .../api/TransformResetTransformResponse.md | 4 + .../reference/api/TransformRetentionPolicy.md | 6 + .../api/TransformRetentionPolicyContainer.md | 5 + .../TransformScheduleNowTransformRequest.md | 8 + .../TransformScheduleNowTransformResponse.md | 4 + docs/reference/api/TransformSettings.md | 10 + docs/reference/api/TransformSource.md | 7 + .../api/TransformStartTransformRequest.md | 9 + .../api/TransformStartTransformResponse.md | 4 + .../api/TransformStopTransformRequest.md | 12 + .../api/TransformStopTransformResponse.md | 4 + docs/reference/api/TransformSyncContainer.md | 5 + docs/reference/api/TransformTimeSync.md | 6 + .../api/TransformUpdateTransformRequest.md | 17 + .../api/TransformUpdateTransformResponse.md | 18 + .../api/TransformUpgradeTransformsRequest.md | 8 + .../api/TransformUpgradeTransformsResponse.md | 7 + docs/reference/api/TranslogStats.md | 11 + docs/reference/api/TransportAddress.md | 4 + docs/reference/api/UnitFloatMillis.md | 4 + docs/reference/api/UnitMillis.md | 4 + docs/reference/api/UnitNanos.md | 4 + docs/reference/api/UnitSeconds.md | 4 + docs/reference/api/UpdateAction.md | 4 + docs/reference/api/UpdateActionOperation.md | 5 + docs/reference/api/UpdateApi_1.md | 3 + docs/reference/api/UpdateApi_2.md | 3 + docs/reference/api/UpdateApi_3.md | 3 + docs/reference/api/UpdateByQueryApi_1.md | 3 + docs/reference/api/UpdateByQueryApi_2.md | 3 + docs/reference/api/UpdateByQueryApi_3.md | 3 + docs/reference/api/UpdateByQueryRequest.md | 41 + docs/reference/api/UpdateByQueryResponse.md | 20 + .../api/UpdateByQueryRethrottleApi_1.md | 3 + .../api/UpdateByQueryRethrottleApi_2.md | 3 + .../api/UpdateByQueryRethrottleApi_3.md | 3 + .../api/UpdateByQueryRethrottleRequest.md | 8 + .../api/UpdateByQueryRethrottleResponse.md | 5 + ...ryRethrottleUpdateByQueryRethrottleNode.md | 5 + docs/reference/api/UpdateRequest.md | 27 + docs/reference/api/UpdateResponse.md | 4 + .../api/UpdateUpdateWriteResponseBase.md | 5 + docs/reference/api/Username.md | 4 + docs/reference/api/Uuid.md | 4 + docs/reference/api/VersionNumber.md | 4 + docs/reference/api/VersionString.md | 4 + docs/reference/api/VersionType.md | 4 + .../api/WaitForActiveShardOptions.md | 4 + docs/reference/api/WaitForActiveShards.md | 4 + docs/reference/api/WaitForEvents.md | 4 + docs/reference/api/WarmerStats.md | 8 + docs/reference/api/Watcher.md | 20 + docs/reference/api/WatcherAckWatchRequest.md | 8 + docs/reference/api/WatcherAckWatchResponse.md | 5 + docs/reference/api/WatcherAcknowledgeState.md | 6 + .../api/WatcherAcknowledgementOptions.md | 4 + docs/reference/api/WatcherAction.md | 18 + .../api/WatcherActionExecutionMode.md | 4 + docs/reference/api/WatcherActionStatus.md | 8 + .../api/WatcherActionStatusOptions.md | 4 + docs/reference/api/WatcherActionType.md | 4 + docs/reference/api/WatcherActions.md | 4 + .../api/WatcherActivateWatchRequest.md | 7 + .../api/WatcherActivateWatchResponse.md | 5 + docs/reference/api/WatcherActivationState.md | 6 + docs/reference/api/WatcherActivationStatus.md | 7 + docs/reference/api/WatcherAlwaysCondition.md | 4 + .../api/WatcherArrayCompareCondition.md | 4 + .../api/WatcherArrayCompareConditionKeys.md | 5 + .../api/WatcherArrayCompareOpParams.md | 6 + docs/reference/api/WatcherChainInput.md | 5 + .../api/WatcherConditionContainer.md | 9 + docs/reference/api/WatcherConditionOp.md | 4 + docs/reference/api/WatcherConditionType.md | 4 + docs/reference/api/WatcherConnectionScheme.md | 4 + docs/reference/api/WatcherCronExpression.md | 4 + docs/reference/api/WatcherDailySchedule.md | 5 + .../api/WatcherDataAttachmentFormat.md | 4 + .../api/WatcherDataEmailAttachment.md | 5 + docs/reference/api/WatcherDay.md | 4 + .../api/WatcherDeactivateWatchRequest.md | 7 + .../api/WatcherDeactivateWatchResponse.md | 5 + .../api/WatcherDeleteWatchRequest.md | 7 + .../api/WatcherDeleteWatchResponse.md | 7 + docs/reference/api/WatcherEmail.md | 15 + docs/reference/api/WatcherEmailAction.md | 4 + .../api/WatcherEmailAttachmentContainer.md | 7 + docs/reference/api/WatcherEmailBody.md | 6 + docs/reference/api/WatcherEmailPriority.md | 4 + docs/reference/api/WatcherEmailResult.md | 7 + .../api/WatcherExecuteWatchRequest.md | 15 + .../api/WatcherExecuteWatchResponse.md | 6 + .../api/WatcherExecuteWatchWatchRecord.md | 15 + docs/reference/api/WatcherExecutionPhase.md | 4 + docs/reference/api/WatcherExecutionResult.md | 9 + .../api/WatcherExecutionResultAction.md | 15 + .../api/WatcherExecutionResultCondition.md | 7 + .../api/WatcherExecutionResultInput.md | 7 + docs/reference/api/WatcherExecutionState.md | 7 + docs/reference/api/WatcherExecutionStatus.md | 4 + .../api/WatcherExecutionThreadPool.md | 6 + .../api/WatcherGetSettingsRequest.md | 7 + .../api/WatcherGetSettingsResponse.md | 5 + docs/reference/api/WatcherGetWatchRequest.md | 7 + docs/reference/api/WatcherGetWatchResponse.md | 11 + docs/reference/api/WatcherHourAndMinute.md | 6 + docs/reference/api/WatcherHourlySchedule.md | 5 + .../api/WatcherHttpEmailAttachment.md | 7 + docs/reference/api/WatcherHttpInput.md | 7 + .../api/WatcherHttpInputAuthentication.md | 5 + .../WatcherHttpInputBasicAuthentication.md | 6 + docs/reference/api/WatcherHttpInputMethod.md | 4 + docs/reference/api/WatcherHttpInputProxy.md | 6 + .../api/WatcherHttpInputRequestDefinition.md | 17 + .../api/WatcherHttpInputRequestResult.md | 4 + .../api/WatcherHttpInputResponseResult.md | 7 + docs/reference/api/WatcherIndexAction.md | 10 + docs/reference/api/WatcherIndexResult.md | 5 + .../api/WatcherIndexResultSummary.md | 9 + docs/reference/api/WatcherInputContainer.md | 8 + docs/reference/api/WatcherInputType.md | 4 + docs/reference/api/WatcherLoggingAction.md | 7 + docs/reference/api/WatcherLoggingResult.md | 5 + docs/reference/api/WatcherMonth.md | 4 + docs/reference/api/WatcherNeverCondition.md | 4 + docs/reference/api/WatcherPagerDutyAction.md | 4 + docs/reference/api/WatcherPagerDutyContext.md | 7 + .../api/WatcherPagerDutyContextType.md | 4 + docs/reference/api/WatcherPagerDutyEvent.md | 14 + .../api/WatcherPagerDutyEventProxy.md | 6 + .../api/WatcherPagerDutyEventType.md | 4 + docs/reference/api/WatcherPagerDutyResult.md | 8 + docs/reference/api/WatcherPutWatchRequest.md | 19 + docs/reference/api/WatcherPutWatchResponse.md | 9 + docs/reference/api/WatcherQuantifier.md | 4 + docs/reference/api/WatcherQueryWatch.md | 9 + .../api/WatcherQueryWatchesRequest.md | 11 + .../api/WatcherQueryWatchesResponse.md | 6 + .../api/WatcherReportingEmailAttachment.md | 9 + .../api/WatcherResponseContentType.md | 4 + .../reference/api/WatcherScheduleContainer.md | 12 + .../reference/api/WatcherScheduleTimeOfDay.md | 4 + .../api/WatcherScheduleTriggerEvent.md | 6 + docs/reference/api/WatcherScriptCondition.md | 8 + docs/reference/api/WatcherSearchInput.md | 7 + .../api/WatcherSearchInputRequestBody.md | 5 + .../WatcherSearchInputRequestDefinition.md | 10 + .../api/WatcherSearchTemplateRequestBody.md | 9 + docs/reference/api/WatcherSimulatedActions.md | 7 + docs/reference/api/WatcherSlackAction.md | 6 + docs/reference/api/WatcherSlackAttachment.md | 19 + .../api/WatcherSlackAttachmentField.md | 7 + .../api/WatcherSlackDynamicAttachment.md | 6 + docs/reference/api/WatcherSlackMessage.md | 10 + docs/reference/api/WatcherSlackResult.md | 6 + docs/reference/api/WatcherStartRequest.md | 7 + docs/reference/api/WatcherStartResponse.md | 4 + docs/reference/api/WatcherStatsRequest.md | 8 + docs/reference/api/WatcherStatsResponse.md | 8 + .../api/WatcherStatsWatchRecordQueuedStats.md | 5 + .../api/WatcherStatsWatchRecordStats.md | 9 + .../api/WatcherStatsWatcherMetric.md | 4 + .../api/WatcherStatsWatcherNodeStats.md | 10 + .../reference/api/WatcherStatsWatcherState.md | 4 + docs/reference/api/WatcherStopRequest.md | 7 + docs/reference/api/WatcherStopResponse.md | 4 + docs/reference/api/WatcherThrottleState.md | 6 + docs/reference/api/WatcherTimeOfMonth.md | 6 + docs/reference/api/WatcherTimeOfWeek.md | 6 + docs/reference/api/WatcherTimeOfYear.md | 7 + docs/reference/api/WatcherTriggerContainer.md | 5 + .../api/WatcherTriggerEventContainer.md | 5 + .../api/WatcherTriggerEventResult.md | 7 + .../api/WatcherUpdateSettingsRequest.md | 10 + .../api/WatcherUpdateSettingsResponse.md | 5 + docs/reference/api/WatcherWatch.md | 13 + docs/reference/api/WatcherWatchStatus.md | 10 + docs/reference/api/WatcherWebhookAction.md | 4 + docs/reference/api/WatcherWebhookResult.md | 6 + docs/reference/api/WktGeoBounds.md | 5 + docs/reference/api/WriteResponseBase.md | 12 + docs/reference/api/Xpack.md | 20 + .../api/XpackInfoBuildInformation.md | 6 + docs/reference/api/XpackInfoFeature.md | 8 + docs/reference/api/XpackInfoFeatures.md | 31 + .../api/XpackInfoMinimalLicenseInformation.md | 9 + .../api/XpackInfoNativeCodeInformation.md | 6 + docs/reference/api/XpackInfoRequest.md | 9 + docs/reference/api/XpackInfoResponse.md | 8 + docs/reference/api/XpackInfoXPackCategory.md | 4 + docs/reference/api/XpackUsageAnalytics.md | 5 + .../api/XpackUsageAnalyticsStatistics.md | 13 + docs/reference/api/XpackUsageArchive.md | 5 + docs/reference/api/XpackUsageAudit.md | 5 + docs/reference/api/XpackUsageBase.md | 6 + docs/reference/api/XpackUsageCcr.md | 6 + docs/reference/api/XpackUsageCounter.md | 6 + docs/reference/api/XpackUsageDataStreams.md | 6 + .../api/XpackUsageDataTierPhaseStatistics.md | 14 + docs/reference/api/XpackUsageDataTiers.md | 9 + docs/reference/api/XpackUsageDatafeed.md | 5 + docs/reference/api/XpackUsageEql.md | 6 + docs/reference/api/XpackUsageEqlFeatures.md | 11 + .../api/XpackUsageEqlFeaturesJoin.md | 9 + .../api/XpackUsageEqlFeaturesKeys.md | 9 + .../api/XpackUsageEqlFeaturesPipes.md | 6 + .../api/XpackUsageEqlFeaturesSequences.md | 10 + docs/reference/api/XpackUsageFeatureToggle.md | 5 + docs/reference/api/XpackUsageFlattened.md | 5 + .../api/XpackUsageHealthStatistics.md | 5 + docs/reference/api/XpackUsageIlm.md | 6 + .../api/XpackUsageIlmPolicyStatistics.md | 6 + docs/reference/api/XpackUsageInvocations.md | 5 + docs/reference/api/XpackUsageIpFilter.md | 6 + docs/reference/api/XpackUsageJobUsage.md | 9 + .../api/XpackUsageMachineLearning.md | 9 + docs/reference/api/XpackUsageMlCounter.md | 5 + .../api/XpackUsageMlDataFrameAnalyticsJobs.md | 8 + ...ckUsageMlDataFrameAnalyticsJobsAnalysis.md | 7 + ...XpackUsageMlDataFrameAnalyticsJobsCount.md | 5 + ...packUsageMlDataFrameAnalyticsJobsMemory.md | 5 + docs/reference/api/XpackUsageMlInference.md | 7 + .../api/XpackUsageMlInferenceDeployments.md | 8 + .../XpackUsageMlInferenceDeploymentsTimeMs.md | 5 + .../XpackUsageMlInferenceIngestProcessor.md | 8 + ...ackUsageMlInferenceIngestProcessorCount.md | 7 + .../api/XpackUsageMlInferenceTrainedModels.md | 9 + ...XpackUsageMlInferenceTrainedModelsCount.md | 12 + .../reference/api/XpackUsageMlJobForecasts.md | 6 + docs/reference/api/XpackUsageMonitoring.md | 6 + docs/reference/api/XpackUsagePhase.md | 6 + docs/reference/api/XpackUsagePhases.md | 9 + docs/reference/api/XpackUsageQuery.md | 8 + docs/reference/api/XpackUsageRealm.md | 12 + docs/reference/api/XpackUsageRealmCache.md | 5 + docs/reference/api/XpackUsageRequest.md | 7 + docs/reference/api/XpackUsageResponse.md | 32 + docs/reference/api/XpackUsageRoleMapping.md | 6 + .../api/XpackUsageRuntimeFieldTypes.md | 5 + .../api/XpackUsageRuntimeFieldsType.md | 18 + .../api/XpackUsageSearchableSnapshots.md | 7 + docs/reference/api/XpackUsageSecurity.md | 16 + docs/reference/api/XpackUsageSecurityRoles.md | 7 + .../api/XpackUsageSecurityRolesDls.md | 5 + .../XpackUsageSecurityRolesDlsBitSetCache.md | 7 + .../api/XpackUsageSecurityRolesFile.md | 7 + .../api/XpackUsageSecurityRolesNative.md | 7 + docs/reference/api/XpackUsageSlm.md | 6 + docs/reference/api/XpackUsageSql.md | 6 + docs/reference/api/XpackUsageSsl.md | 6 + docs/reference/api/XpackUsageVector.md | 7 + docs/reference/api/XpackUsageWatcher.md | 7 + .../api/XpackUsageWatcherActionTotals.md | 6 + .../reference/api/XpackUsageWatcherActions.md | 5 + docs/reference/api/XpackUsageWatcherWatch.md | 8 + .../api/XpackUsageWatcherWatchTrigger.md | 6 + .../XpackUsageWatcherWatchTriggerSchedule.md | 6 + docs/reference/api/byte.md | 4 + docs/reference/api/double.md | 4 + docs/reference/api/float.md | 4 + docs/reference/api/integer.md | 4 + docs/reference/api/long.md | 4 + docs/reference/api/short.md | 4 + docs/reference/api/uint.md | 4 + docs/reference/api/ulong.md | 4 + package.json | 4 +- scripts/docgen.mjs | 343 + 3745 files changed, 30211 insertions(+), 15508 deletions(-) create mode 100644 api-extractor.json create mode 100644 docs/reference/api/API.md create mode 100644 docs/reference/api/AcknowledgedResponseBase.md create mode 100644 docs/reference/api/Action.md create mode 100644 docs/reference/api/AggregateName.md create mode 100644 docs/reference/api/AggregationsAdjacencyMatrixAggregate.md create mode 100644 docs/reference/api/AggregationsAdjacencyMatrixAggregation.md create mode 100644 docs/reference/api/AggregationsAdjacencyMatrixBucket.md create mode 100644 docs/reference/api/AggregationsAdjacencyMatrixBucketKeys.md create mode 100644 docs/reference/api/AggregationsAggregate.md create mode 100644 docs/reference/api/AggregationsAggregateBase.md create mode 100644 docs/reference/api/AggregationsAggregateOrder.md create mode 100644 docs/reference/api/AggregationsAggregation.md create mode 100644 docs/reference/api/AggregationsAggregationContainer.md create mode 100644 docs/reference/api/AggregationsAggregationRange.md create mode 100644 docs/reference/api/AggregationsArrayPercentilesItem.md create mode 100644 docs/reference/api/AggregationsAutoDateHistogramAggregate.md create mode 100644 docs/reference/api/AggregationsAutoDateHistogramAggregation.md create mode 100644 docs/reference/api/AggregationsAverageAggregation.md create mode 100644 docs/reference/api/AggregationsAverageBucketAggregation.md create mode 100644 docs/reference/api/AggregationsAvgAggregate.md create mode 100644 docs/reference/api/AggregationsBoxPlotAggregate.md create mode 100644 docs/reference/api/AggregationsBoxplotAggregation.md create mode 100644 docs/reference/api/AggregationsBucketAggregationBase.md create mode 100644 docs/reference/api/AggregationsBucketCorrelationAggregation.md create mode 100644 docs/reference/api/AggregationsBucketCorrelationFunction.md create mode 100644 docs/reference/api/AggregationsBucketCorrelationFunctionCountCorrelation.md create mode 100644 docs/reference/api/AggregationsBucketCorrelationFunctionCountCorrelationIndicator.md create mode 100644 docs/reference/api/AggregationsBucketKsAggregation.md create mode 100644 docs/reference/api/AggregationsBucketMetricValueAggregate.md create mode 100644 docs/reference/api/AggregationsBucketPathAggregation.md create mode 100644 docs/reference/api/AggregationsBucketScriptAggregation.md create mode 100644 docs/reference/api/AggregationsBucketSelectorAggregation.md create mode 100644 docs/reference/api/AggregationsBucketSortAggregation.md create mode 100644 docs/reference/api/AggregationsBuckets.md create mode 100644 docs/reference/api/AggregationsBucketsPath.md create mode 100644 docs/reference/api/AggregationsCalendarInterval.md create mode 100644 docs/reference/api/AggregationsCardinalityAggregate.md create mode 100644 docs/reference/api/AggregationsCardinalityAggregation.md create mode 100644 docs/reference/api/AggregationsCardinalityExecutionMode.md create mode 100644 docs/reference/api/AggregationsCategorizeTextAggregation.md create mode 100644 docs/reference/api/AggregationsCategorizeTextAnalyzer.md create mode 100644 docs/reference/api/AggregationsChiSquareHeuristic.md create mode 100644 docs/reference/api/AggregationsChildrenAggregate.md create mode 100644 docs/reference/api/AggregationsChildrenAggregateKeys.md create mode 100644 docs/reference/api/AggregationsChildrenAggregation.md create mode 100644 docs/reference/api/AggregationsCompositeAggregate.md create mode 100644 docs/reference/api/AggregationsCompositeAggregateKey.md create mode 100644 docs/reference/api/AggregationsCompositeAggregation.md create mode 100644 docs/reference/api/AggregationsCompositeAggregationBase.md create mode 100644 docs/reference/api/AggregationsCompositeAggregationSource.md create mode 100644 docs/reference/api/AggregationsCompositeBucket.md create mode 100644 docs/reference/api/AggregationsCompositeBucketKeys.md create mode 100644 docs/reference/api/AggregationsCompositeDateHistogramAggregation.md create mode 100644 docs/reference/api/AggregationsCompositeGeoTileGridAggregation.md create mode 100644 docs/reference/api/AggregationsCompositeHistogramAggregation.md create mode 100644 docs/reference/api/AggregationsCompositeTermsAggregation.md create mode 100644 docs/reference/api/AggregationsCumulativeCardinalityAggregate.md create mode 100644 docs/reference/api/AggregationsCumulativeCardinalityAggregation.md create mode 100644 docs/reference/api/AggregationsCumulativeSumAggregation.md create mode 100644 docs/reference/api/AggregationsCustomCategorizeTextAnalyzer.md create mode 100644 docs/reference/api/AggregationsDateHistogramAggregate.md create mode 100644 docs/reference/api/AggregationsDateHistogramAggregation.md create mode 100644 docs/reference/api/AggregationsDateHistogramBucket.md create mode 100644 docs/reference/api/AggregationsDateHistogramBucketKeys.md create mode 100644 docs/reference/api/AggregationsDateRangeAggregate.md create mode 100644 docs/reference/api/AggregationsDateRangeAggregation.md create mode 100644 docs/reference/api/AggregationsDateRangeExpression.md create mode 100644 docs/reference/api/AggregationsDerivativeAggregate.md create mode 100644 docs/reference/api/AggregationsDerivativeAggregation.md create mode 100644 docs/reference/api/AggregationsDiversifiedSamplerAggregation.md create mode 100644 docs/reference/api/AggregationsDoubleTermsAggregate.md create mode 100644 docs/reference/api/AggregationsDoubleTermsBucket.md create mode 100644 docs/reference/api/AggregationsDoubleTermsBucketKeys.md create mode 100644 docs/reference/api/AggregationsEwmaModelSettings.md create mode 100644 docs/reference/api/AggregationsEwmaMovingAverageAggregation.md create mode 100644 docs/reference/api/AggregationsExtendedBounds.md create mode 100644 docs/reference/api/AggregationsExtendedStatsAggregate.md create mode 100644 docs/reference/api/AggregationsExtendedStatsAggregation.md create mode 100644 docs/reference/api/AggregationsExtendedStatsBucketAggregate.md create mode 100644 docs/reference/api/AggregationsExtendedStatsBucketAggregation.md create mode 100644 docs/reference/api/AggregationsFieldDateMath.md create mode 100644 docs/reference/api/AggregationsFilterAggregate.md create mode 100644 docs/reference/api/AggregationsFilterAggregateKeys.md create mode 100644 docs/reference/api/AggregationsFiltersAggregate.md create mode 100644 docs/reference/api/AggregationsFiltersAggregation.md create mode 100644 docs/reference/api/AggregationsFiltersBucket.md create mode 100644 docs/reference/api/AggregationsFiltersBucketKeys.md create mode 100644 docs/reference/api/AggregationsFormatMetricAggregationBase.md create mode 100644 docs/reference/api/AggregationsFormattableMetricAggregation.md create mode 100644 docs/reference/api/AggregationsFrequentItemSetsAggregate.md create mode 100644 docs/reference/api/AggregationsFrequentItemSetsAggregation.md create mode 100644 docs/reference/api/AggregationsFrequentItemSetsBucket.md create mode 100644 docs/reference/api/AggregationsFrequentItemSetsBucketKeys.md create mode 100644 docs/reference/api/AggregationsFrequentItemSetsField.md create mode 100644 docs/reference/api/AggregationsGapPolicy.md create mode 100644 docs/reference/api/AggregationsGeoBoundsAggregate.md create mode 100644 docs/reference/api/AggregationsGeoBoundsAggregation.md create mode 100644 docs/reference/api/AggregationsGeoCentroidAggregate.md create mode 100644 docs/reference/api/AggregationsGeoCentroidAggregation.md create mode 100644 docs/reference/api/AggregationsGeoDistanceAggregate.md create mode 100644 docs/reference/api/AggregationsGeoDistanceAggregation.md create mode 100644 docs/reference/api/AggregationsGeoHashGridAggregate.md create mode 100644 docs/reference/api/AggregationsGeoHashGridAggregation.md create mode 100644 docs/reference/api/AggregationsGeoHashGridBucket.md create mode 100644 docs/reference/api/AggregationsGeoHashGridBucketKeys.md create mode 100644 docs/reference/api/AggregationsGeoHexGridAggregate.md create mode 100644 docs/reference/api/AggregationsGeoHexGridBucket.md create mode 100644 docs/reference/api/AggregationsGeoHexGridBucketKeys.md create mode 100644 docs/reference/api/AggregationsGeoLineAggregate.md create mode 100644 docs/reference/api/AggregationsGeoLineAggregation.md create mode 100644 docs/reference/api/AggregationsGeoLinePoint.md create mode 100644 docs/reference/api/AggregationsGeoLineSort.md create mode 100644 docs/reference/api/AggregationsGeoTileGridAggregate.md create mode 100644 docs/reference/api/AggregationsGeoTileGridAggregation.md create mode 100644 docs/reference/api/AggregationsGeoTileGridBucket.md create mode 100644 docs/reference/api/AggregationsGeoTileGridBucketKeys.md create mode 100644 docs/reference/api/AggregationsGeohexGridAggregation.md create mode 100644 docs/reference/api/AggregationsGlobalAggregate.md create mode 100644 docs/reference/api/AggregationsGlobalAggregateKeys.md create mode 100644 docs/reference/api/AggregationsGlobalAggregation.md create mode 100644 docs/reference/api/AggregationsGoogleNormalizedDistanceHeuristic.md create mode 100644 docs/reference/api/AggregationsHdrMethod.md create mode 100644 docs/reference/api/AggregationsHdrPercentileRanksAggregate.md create mode 100644 docs/reference/api/AggregationsHdrPercentilesAggregate.md create mode 100644 docs/reference/api/AggregationsHistogramAggregate.md create mode 100644 docs/reference/api/AggregationsHistogramAggregation.md create mode 100644 docs/reference/api/AggregationsHistogramBucket.md create mode 100644 docs/reference/api/AggregationsHistogramBucketKeys.md create mode 100644 docs/reference/api/AggregationsHoltLinearModelSettings.md create mode 100644 docs/reference/api/AggregationsHoltMovingAverageAggregation.md create mode 100644 docs/reference/api/AggregationsHoltWintersModelSettings.md create mode 100644 docs/reference/api/AggregationsHoltWintersMovingAverageAggregation.md create mode 100644 docs/reference/api/AggregationsHoltWintersType.md create mode 100644 docs/reference/api/AggregationsInferenceAggregate.md create mode 100644 docs/reference/api/AggregationsInferenceAggregateKeys.md create mode 100644 docs/reference/api/AggregationsInferenceAggregation.md create mode 100644 docs/reference/api/AggregationsInferenceClassImportance.md create mode 100644 docs/reference/api/AggregationsInferenceConfigContainer.md create mode 100644 docs/reference/api/AggregationsInferenceFeatureImportance.md create mode 100644 docs/reference/api/AggregationsInferenceTopClassEntry.md create mode 100644 docs/reference/api/AggregationsIpPrefixAggregate.md create mode 100644 docs/reference/api/AggregationsIpPrefixAggregation.md create mode 100644 docs/reference/api/AggregationsIpPrefixBucket.md create mode 100644 docs/reference/api/AggregationsIpPrefixBucketKeys.md create mode 100644 docs/reference/api/AggregationsIpRangeAggregate.md create mode 100644 docs/reference/api/AggregationsIpRangeAggregation.md create mode 100644 docs/reference/api/AggregationsIpRangeAggregationRange.md create mode 100644 docs/reference/api/AggregationsIpRangeBucket.md create mode 100644 docs/reference/api/AggregationsIpRangeBucketKeys.md create mode 100644 docs/reference/api/AggregationsKeyedPercentiles.md create mode 100644 docs/reference/api/AggregationsLinearMovingAverageAggregation.md create mode 100644 docs/reference/api/AggregationsLongRareTermsAggregate.md create mode 100644 docs/reference/api/AggregationsLongRareTermsBucket.md create mode 100644 docs/reference/api/AggregationsLongRareTermsBucketKeys.md create mode 100644 docs/reference/api/AggregationsLongTermsAggregate.md create mode 100644 docs/reference/api/AggregationsLongTermsBucket.md create mode 100644 docs/reference/api/AggregationsLongTermsBucketKeys.md create mode 100644 docs/reference/api/AggregationsMatrixAggregation.md create mode 100644 docs/reference/api/AggregationsMatrixStatsAggregate.md create mode 100644 docs/reference/api/AggregationsMatrixStatsAggregation.md create mode 100644 docs/reference/api/AggregationsMatrixStatsFields.md create mode 100644 docs/reference/api/AggregationsMaxAggregate.md create mode 100644 docs/reference/api/AggregationsMaxAggregation.md create mode 100644 docs/reference/api/AggregationsMaxBucketAggregation.md create mode 100644 docs/reference/api/AggregationsMedianAbsoluteDeviationAggregate.md create mode 100644 docs/reference/api/AggregationsMedianAbsoluteDeviationAggregation.md create mode 100644 docs/reference/api/AggregationsMetricAggregationBase.md create mode 100644 docs/reference/api/AggregationsMinAggregate.md create mode 100644 docs/reference/api/AggregationsMinAggregation.md create mode 100644 docs/reference/api/AggregationsMinBucketAggregation.md create mode 100644 docs/reference/api/AggregationsMinimumInterval.md create mode 100644 docs/reference/api/AggregationsMissing.md create mode 100644 docs/reference/api/AggregationsMissingAggregate.md create mode 100644 docs/reference/api/AggregationsMissingAggregateKeys.md create mode 100644 docs/reference/api/AggregationsMissingAggregation.md create mode 100644 docs/reference/api/AggregationsMissingOrder.md create mode 100644 docs/reference/api/AggregationsMovingAverageAggregation.md create mode 100644 docs/reference/api/AggregationsMovingAverageAggregationBase.md create mode 100644 docs/reference/api/AggregationsMovingFunctionAggregation.md create mode 100644 docs/reference/api/AggregationsMovingPercentilesAggregation.md create mode 100644 docs/reference/api/AggregationsMultiBucketAggregateBase.md create mode 100644 docs/reference/api/AggregationsMultiBucketBase.md create mode 100644 docs/reference/api/AggregationsMultiTermLookup.md create mode 100644 docs/reference/api/AggregationsMultiTermsAggregate.md create mode 100644 docs/reference/api/AggregationsMultiTermsAggregation.md create mode 100644 docs/reference/api/AggregationsMultiTermsBucket.md create mode 100644 docs/reference/api/AggregationsMultiTermsBucketKeys.md create mode 100644 docs/reference/api/AggregationsMutualInformationHeuristic.md create mode 100644 docs/reference/api/AggregationsNestedAggregate.md create mode 100644 docs/reference/api/AggregationsNestedAggregateKeys.md create mode 100644 docs/reference/api/AggregationsNestedAggregation.md create mode 100644 docs/reference/api/AggregationsNormalizeAggregation.md create mode 100644 docs/reference/api/AggregationsNormalizeMethod.md create mode 100644 docs/reference/api/AggregationsParentAggregate.md create mode 100644 docs/reference/api/AggregationsParentAggregateKeys.md create mode 100644 docs/reference/api/AggregationsParentAggregation.md create mode 100644 docs/reference/api/AggregationsPercentageScoreHeuristic.md create mode 100644 docs/reference/api/AggregationsPercentileRanksAggregation.md create mode 100644 docs/reference/api/AggregationsPercentiles.md create mode 100644 docs/reference/api/AggregationsPercentilesAggregateBase.md create mode 100644 docs/reference/api/AggregationsPercentilesAggregation.md create mode 100644 docs/reference/api/AggregationsPercentilesBucketAggregate.md create mode 100644 docs/reference/api/AggregationsPercentilesBucketAggregation.md create mode 100644 docs/reference/api/AggregationsPipelineAggregationBase.md create mode 100644 docs/reference/api/AggregationsRandomSamplerAggregation.md create mode 100644 docs/reference/api/AggregationsRangeAggregate.md create mode 100644 docs/reference/api/AggregationsRangeAggregation.md create mode 100644 docs/reference/api/AggregationsRangeBucket.md create mode 100644 docs/reference/api/AggregationsRangeBucketKeys.md create mode 100644 docs/reference/api/AggregationsRareTermsAggregation.md create mode 100644 docs/reference/api/AggregationsRateAggregate.md create mode 100644 docs/reference/api/AggregationsRateAggregation.md create mode 100644 docs/reference/api/AggregationsRateMode.md create mode 100644 docs/reference/api/AggregationsReverseNestedAggregate.md create mode 100644 docs/reference/api/AggregationsReverseNestedAggregateKeys.md create mode 100644 docs/reference/api/AggregationsReverseNestedAggregation.md create mode 100644 docs/reference/api/AggregationsSamplerAggregate.md create mode 100644 docs/reference/api/AggregationsSamplerAggregateKeys.md create mode 100644 docs/reference/api/AggregationsSamplerAggregation.md create mode 100644 docs/reference/api/AggregationsSamplerAggregationExecutionHint.md create mode 100644 docs/reference/api/AggregationsScriptedHeuristic.md create mode 100644 docs/reference/api/AggregationsScriptedMetricAggregate.md create mode 100644 docs/reference/api/AggregationsScriptedMetricAggregation.md create mode 100644 docs/reference/api/AggregationsSerialDifferencingAggregation.md create mode 100644 docs/reference/api/AggregationsSignificantLongTermsAggregate.md create mode 100644 docs/reference/api/AggregationsSignificantLongTermsBucket.md create mode 100644 docs/reference/api/AggregationsSignificantLongTermsBucketKeys.md create mode 100644 docs/reference/api/AggregationsSignificantStringTermsAggregate.md create mode 100644 docs/reference/api/AggregationsSignificantStringTermsBucket.md create mode 100644 docs/reference/api/AggregationsSignificantStringTermsBucketKeys.md create mode 100644 docs/reference/api/AggregationsSignificantTermsAggregateBase.md create mode 100644 docs/reference/api/AggregationsSignificantTermsAggregation.md create mode 100644 docs/reference/api/AggregationsSignificantTermsBucketBase.md create mode 100644 docs/reference/api/AggregationsSignificantTextAggregation.md create mode 100644 docs/reference/api/AggregationsSimpleMovingAverageAggregation.md create mode 100644 docs/reference/api/AggregationsSimpleValueAggregate.md create mode 100644 docs/reference/api/AggregationsSingleBucketAggregateBase.md create mode 100644 docs/reference/api/AggregationsSingleMetricAggregateBase.md create mode 100644 docs/reference/api/AggregationsStandardDeviationBounds.md create mode 100644 docs/reference/api/AggregationsStandardDeviationBoundsAsString.md create mode 100644 docs/reference/api/AggregationsStatsAggregate.md create mode 100644 docs/reference/api/AggregationsStatsAggregation.md create mode 100644 docs/reference/api/AggregationsStatsBucketAggregate.md create mode 100644 docs/reference/api/AggregationsStatsBucketAggregation.md create mode 100644 docs/reference/api/AggregationsStringRareTermsAggregate.md create mode 100644 docs/reference/api/AggregationsStringRareTermsBucket.md create mode 100644 docs/reference/api/AggregationsStringRareTermsBucketKeys.md create mode 100644 docs/reference/api/AggregationsStringStatsAggregate.md create mode 100644 docs/reference/api/AggregationsStringStatsAggregation.md create mode 100644 docs/reference/api/AggregationsStringTermsAggregate.md create mode 100644 docs/reference/api/AggregationsStringTermsBucket.md create mode 100644 docs/reference/api/AggregationsStringTermsBucketKeys.md create mode 100644 docs/reference/api/AggregationsSumAggregate.md create mode 100644 docs/reference/api/AggregationsSumAggregation.md create mode 100644 docs/reference/api/AggregationsSumBucketAggregation.md create mode 100644 docs/reference/api/AggregationsTDigest.md create mode 100644 docs/reference/api/AggregationsTDigestPercentileRanksAggregate.md create mode 100644 docs/reference/api/AggregationsTDigestPercentilesAggregate.md create mode 100644 docs/reference/api/AggregationsTTestAggregate.md create mode 100644 docs/reference/api/AggregationsTTestAggregation.md create mode 100644 docs/reference/api/AggregationsTTestType.md create mode 100644 docs/reference/api/AggregationsTermsAggregateBase.md create mode 100644 docs/reference/api/AggregationsTermsAggregation.md create mode 100644 docs/reference/api/AggregationsTermsAggregationCollectMode.md create mode 100644 docs/reference/api/AggregationsTermsAggregationExecutionHint.md create mode 100644 docs/reference/api/AggregationsTermsBucketBase.md create mode 100644 docs/reference/api/AggregationsTermsExclude.md create mode 100644 docs/reference/api/AggregationsTermsInclude.md create mode 100644 docs/reference/api/AggregationsTermsPartition.md create mode 100644 docs/reference/api/AggregationsTestPopulation.md create mode 100644 docs/reference/api/AggregationsTimeSeriesAggregate.md create mode 100644 docs/reference/api/AggregationsTimeSeriesAggregation.md create mode 100644 docs/reference/api/AggregationsTimeSeriesBucket.md create mode 100644 docs/reference/api/AggregationsTimeSeriesBucketKeys.md create mode 100644 docs/reference/api/AggregationsTopHitsAggregate.md create mode 100644 docs/reference/api/AggregationsTopHitsAggregation.md create mode 100644 docs/reference/api/AggregationsTopMetrics.md create mode 100644 docs/reference/api/AggregationsTopMetricsAggregate.md create mode 100644 docs/reference/api/AggregationsTopMetricsAggregation.md create mode 100644 docs/reference/api/AggregationsTopMetricsValue.md create mode 100644 docs/reference/api/AggregationsUnmappedRareTermsAggregate.md create mode 100644 docs/reference/api/AggregationsUnmappedSamplerAggregate.md create mode 100644 docs/reference/api/AggregationsUnmappedSamplerAggregateKeys.md create mode 100644 docs/reference/api/AggregationsUnmappedSignificantTermsAggregate.md create mode 100644 docs/reference/api/AggregationsUnmappedTermsAggregate.md create mode 100644 docs/reference/api/AggregationsValueCountAggregate.md create mode 100644 docs/reference/api/AggregationsValueCountAggregation.md create mode 100644 docs/reference/api/AggregationsValueType.md create mode 100644 docs/reference/api/AggregationsVariableWidthHistogramAggregate.md create mode 100644 docs/reference/api/AggregationsVariableWidthHistogramAggregation.md create mode 100644 docs/reference/api/AggregationsVariableWidthHistogramBucket.md create mode 100644 docs/reference/api/AggregationsVariableWidthHistogramBucketKeys.md create mode 100644 docs/reference/api/AggregationsWeightedAverageAggregation.md create mode 100644 docs/reference/api/AggregationsWeightedAverageValue.md create mode 100644 docs/reference/api/AggregationsWeightedAvgAggregate.md create mode 100644 docs/reference/api/AnalysisAnalyzer.md create mode 100644 docs/reference/api/AnalysisApostropheTokenFilter.md create mode 100644 docs/reference/api/AnalysisArabicAnalyzer.md create mode 100644 docs/reference/api/AnalysisArabicNormalizationTokenFilter.md create mode 100644 docs/reference/api/AnalysisArmenianAnalyzer.md create mode 100644 docs/reference/api/AnalysisAsciiFoldingTokenFilter.md create mode 100644 docs/reference/api/AnalysisBasqueAnalyzer.md create mode 100644 docs/reference/api/AnalysisBengaliAnalyzer.md create mode 100644 docs/reference/api/AnalysisBrazilianAnalyzer.md create mode 100644 docs/reference/api/AnalysisBulgarianAnalyzer.md create mode 100644 docs/reference/api/AnalysisCatalanAnalyzer.md create mode 100644 docs/reference/api/AnalysisCharFilter.md create mode 100644 docs/reference/api/AnalysisCharFilterBase.md create mode 100644 docs/reference/api/AnalysisCharFilterDefinition.md create mode 100644 docs/reference/api/AnalysisCharGroupTokenizer.md create mode 100644 docs/reference/api/AnalysisChineseAnalyzer.md create mode 100644 docs/reference/api/AnalysisCjkAnalyzer.md create mode 100644 docs/reference/api/AnalysisCjkBigramIgnoredScript.md create mode 100644 docs/reference/api/AnalysisCjkBigramTokenFilter.md create mode 100644 docs/reference/api/AnalysisCjkWidthTokenFilter.md create mode 100644 docs/reference/api/AnalysisClassicTokenFilter.md create mode 100644 docs/reference/api/AnalysisClassicTokenizer.md create mode 100644 docs/reference/api/AnalysisCommonGramsTokenFilter.md create mode 100644 docs/reference/api/AnalysisCompoundWordTokenFilterBase.md create mode 100644 docs/reference/api/AnalysisConditionTokenFilter.md create mode 100644 docs/reference/api/AnalysisCustomAnalyzer.md create mode 100644 docs/reference/api/AnalysisCustomNormalizer.md create mode 100644 docs/reference/api/AnalysisCzechAnalyzer.md create mode 100644 docs/reference/api/AnalysisDanishAnalyzer.md create mode 100644 docs/reference/api/AnalysisDecimalDigitTokenFilter.md create mode 100644 docs/reference/api/AnalysisDelimitedPayloadEncoding.md create mode 100644 docs/reference/api/AnalysisDelimitedPayloadTokenFilter.md create mode 100644 docs/reference/api/AnalysisDictionaryDecompounderTokenFilter.md create mode 100644 docs/reference/api/AnalysisDutchAnalyzer.md create mode 100644 docs/reference/api/AnalysisEdgeNGramSide.md create mode 100644 docs/reference/api/AnalysisEdgeNGramTokenFilter.md create mode 100644 docs/reference/api/AnalysisEdgeNGramTokenizer.md create mode 100644 docs/reference/api/AnalysisElisionTokenFilter.md create mode 100644 docs/reference/api/AnalysisEnglishAnalyzer.md create mode 100644 docs/reference/api/AnalysisEstonianAnalyzer.md create mode 100644 docs/reference/api/AnalysisFingerprintAnalyzer.md create mode 100644 docs/reference/api/AnalysisFingerprintTokenFilter.md create mode 100644 docs/reference/api/AnalysisFinnishAnalyzer.md create mode 100644 docs/reference/api/AnalysisFlattenGraphTokenFilter.md create mode 100644 docs/reference/api/AnalysisFrenchAnalyzer.md create mode 100644 docs/reference/api/AnalysisGalicianAnalyzer.md create mode 100644 docs/reference/api/AnalysisGermanAnalyzer.md create mode 100644 docs/reference/api/AnalysisGermanNormalizationTokenFilter.md create mode 100644 docs/reference/api/AnalysisGreekAnalyzer.md create mode 100644 docs/reference/api/AnalysisHindiAnalyzer.md create mode 100644 docs/reference/api/AnalysisHindiNormalizationTokenFilter.md create mode 100644 docs/reference/api/AnalysisHtmlStripCharFilter.md create mode 100644 docs/reference/api/AnalysisHungarianAnalyzer.md create mode 100644 docs/reference/api/AnalysisHunspellTokenFilter.md create mode 100644 docs/reference/api/AnalysisHyphenationDecompounderTokenFilter.md create mode 100644 docs/reference/api/AnalysisIcuAnalyzer.md create mode 100644 docs/reference/api/AnalysisIcuCollationAlternate.md create mode 100644 docs/reference/api/AnalysisIcuCollationCaseFirst.md create mode 100644 docs/reference/api/AnalysisIcuCollationDecomposition.md create mode 100644 docs/reference/api/AnalysisIcuCollationStrength.md create mode 100644 docs/reference/api/AnalysisIcuCollationTokenFilter.md create mode 100644 docs/reference/api/AnalysisIcuFoldingTokenFilter.md create mode 100644 docs/reference/api/AnalysisIcuNormalizationCharFilter.md create mode 100644 docs/reference/api/AnalysisIcuNormalizationMode.md create mode 100644 docs/reference/api/AnalysisIcuNormalizationTokenFilter.md create mode 100644 docs/reference/api/AnalysisIcuNormalizationType.md create mode 100644 docs/reference/api/AnalysisIcuTokenizer.md create mode 100644 docs/reference/api/AnalysisIcuTransformDirection.md create mode 100644 docs/reference/api/AnalysisIcuTransformTokenFilter.md create mode 100644 docs/reference/api/AnalysisIndicNormalizationTokenFilter.md create mode 100644 docs/reference/api/AnalysisIndonesianAnalyzer.md create mode 100644 docs/reference/api/AnalysisIrishAnalyzer.md create mode 100644 docs/reference/api/AnalysisItalianAnalyzer.md create mode 100644 docs/reference/api/AnalysisJaStopTokenFilter.md create mode 100644 docs/reference/api/AnalysisKStemTokenFilter.md create mode 100644 docs/reference/api/AnalysisKeepTypesMode.md create mode 100644 docs/reference/api/AnalysisKeepTypesTokenFilter.md create mode 100644 docs/reference/api/AnalysisKeepWordsTokenFilter.md create mode 100644 docs/reference/api/AnalysisKeywordAnalyzer.md create mode 100644 docs/reference/api/AnalysisKeywordMarkerTokenFilter.md create mode 100644 docs/reference/api/AnalysisKeywordRepeatTokenFilter.md create mode 100644 docs/reference/api/AnalysisKeywordTokenizer.md create mode 100644 docs/reference/api/AnalysisKuromojiAnalyzer.md create mode 100644 docs/reference/api/AnalysisKuromojiIterationMarkCharFilter.md create mode 100644 docs/reference/api/AnalysisKuromojiPartOfSpeechTokenFilter.md create mode 100644 docs/reference/api/AnalysisKuromojiReadingFormTokenFilter.md create mode 100644 docs/reference/api/AnalysisKuromojiStemmerTokenFilter.md create mode 100644 docs/reference/api/AnalysisKuromojiTokenizationMode.md create mode 100644 docs/reference/api/AnalysisKuromojiTokenizer.md create mode 100644 docs/reference/api/AnalysisLatvianAnalyzer.md create mode 100644 docs/reference/api/AnalysisLengthTokenFilter.md create mode 100644 docs/reference/api/AnalysisLetterTokenizer.md create mode 100644 docs/reference/api/AnalysisLimitTokenCountTokenFilter.md create mode 100644 docs/reference/api/AnalysisLithuanianAnalyzer.md create mode 100644 docs/reference/api/AnalysisLowercaseNormalizer.md create mode 100644 docs/reference/api/AnalysisLowercaseTokenFilter.md create mode 100644 docs/reference/api/AnalysisLowercaseTokenFilterLanguages.md create mode 100644 docs/reference/api/AnalysisLowercaseTokenizer.md create mode 100644 docs/reference/api/AnalysisMappingCharFilter.md create mode 100644 docs/reference/api/AnalysisMinHashTokenFilter.md create mode 100644 docs/reference/api/AnalysisMultiplexerTokenFilter.md create mode 100644 docs/reference/api/AnalysisNGramTokenFilter.md create mode 100644 docs/reference/api/AnalysisNGramTokenizer.md create mode 100644 docs/reference/api/AnalysisNoriAnalyzer.md create mode 100644 docs/reference/api/AnalysisNoriDecompoundMode.md create mode 100644 docs/reference/api/AnalysisNoriPartOfSpeechTokenFilter.md create mode 100644 docs/reference/api/AnalysisNoriTokenizer.md create mode 100644 docs/reference/api/AnalysisNormalizer.md create mode 100644 docs/reference/api/AnalysisNorwegianAnalyzer.md create mode 100644 docs/reference/api/AnalysisPathHierarchyTokenizer.md create mode 100644 docs/reference/api/AnalysisPatternAnalyzer.md create mode 100644 docs/reference/api/AnalysisPatternCaptureTokenFilter.md create mode 100644 docs/reference/api/AnalysisPatternReplaceCharFilter.md create mode 100644 docs/reference/api/AnalysisPatternReplaceTokenFilter.md create mode 100644 docs/reference/api/AnalysisPatternTokenizer.md create mode 100644 docs/reference/api/AnalysisPersianAnalyzer.md create mode 100644 docs/reference/api/AnalysisPersianNormalizationTokenFilter.md create mode 100644 docs/reference/api/AnalysisPhoneticEncoder.md create mode 100644 docs/reference/api/AnalysisPhoneticLanguage.md create mode 100644 docs/reference/api/AnalysisPhoneticNameType.md create mode 100644 docs/reference/api/AnalysisPhoneticRuleType.md create mode 100644 docs/reference/api/AnalysisPhoneticTokenFilter.md create mode 100644 docs/reference/api/AnalysisPorterStemTokenFilter.md create mode 100644 docs/reference/api/AnalysisPortugueseAnalyzer.md create mode 100644 docs/reference/api/AnalysisPredicateTokenFilter.md create mode 100644 docs/reference/api/AnalysisRemoveDuplicatesTokenFilter.md create mode 100644 docs/reference/api/AnalysisReverseTokenFilter.md create mode 100644 docs/reference/api/AnalysisRomanianAnalyzer.md create mode 100644 docs/reference/api/AnalysisRussianAnalyzer.md create mode 100644 docs/reference/api/AnalysisScandinavianFoldingTokenFilter.md create mode 100644 docs/reference/api/AnalysisScandinavianNormalizationTokenFilter.md create mode 100644 docs/reference/api/AnalysisSerbianAnalyzer.md create mode 100644 docs/reference/api/AnalysisSerbianNormalizationTokenFilter.md create mode 100644 docs/reference/api/AnalysisShingleTokenFilter.md create mode 100644 docs/reference/api/AnalysisSimpleAnalyzer.md create mode 100644 docs/reference/api/AnalysisSimplePatternSplitTokenizer.md create mode 100644 docs/reference/api/AnalysisSimplePatternTokenizer.md create mode 100644 docs/reference/api/AnalysisSnowballAnalyzer.md create mode 100644 docs/reference/api/AnalysisSnowballLanguage.md create mode 100644 docs/reference/api/AnalysisSnowballTokenFilter.md create mode 100644 docs/reference/api/AnalysisSoraniAnalyzer.md create mode 100644 docs/reference/api/AnalysisSoraniNormalizationTokenFilter.md create mode 100644 docs/reference/api/AnalysisSpanishAnalyzer.md create mode 100644 docs/reference/api/AnalysisStandardAnalyzer.md create mode 100644 docs/reference/api/AnalysisStandardTokenizer.md create mode 100644 docs/reference/api/AnalysisStemmerOverrideTokenFilter.md create mode 100644 docs/reference/api/AnalysisStemmerTokenFilter.md create mode 100644 docs/reference/api/AnalysisStopAnalyzer.md create mode 100644 docs/reference/api/AnalysisStopTokenFilter.md create mode 100644 docs/reference/api/AnalysisStopWordLanguage.md create mode 100644 docs/reference/api/AnalysisStopWords.md create mode 100644 docs/reference/api/AnalysisSwedishAnalyzer.md create mode 100644 docs/reference/api/AnalysisSynonymFormat.md create mode 100644 docs/reference/api/AnalysisSynonymGraphTokenFilter.md create mode 100644 docs/reference/api/AnalysisSynonymTokenFilter.md create mode 100644 docs/reference/api/AnalysisSynonymTokenFilterBase.md create mode 100644 docs/reference/api/AnalysisThaiAnalyzer.md create mode 100644 docs/reference/api/AnalysisThaiTokenizer.md create mode 100644 docs/reference/api/AnalysisTokenChar.md create mode 100644 docs/reference/api/AnalysisTokenFilter.md create mode 100644 docs/reference/api/AnalysisTokenFilterBase.md create mode 100644 docs/reference/api/AnalysisTokenFilterDefinition.md create mode 100644 docs/reference/api/AnalysisTokenizer.md create mode 100644 docs/reference/api/AnalysisTokenizerBase.md create mode 100644 docs/reference/api/AnalysisTokenizerDefinition.md create mode 100644 docs/reference/api/AnalysisTrimTokenFilter.md create mode 100644 docs/reference/api/AnalysisTruncateTokenFilter.md create mode 100644 docs/reference/api/AnalysisTurkishAnalyzer.md create mode 100644 docs/reference/api/AnalysisUaxEmailUrlTokenizer.md create mode 100644 docs/reference/api/AnalysisUniqueTokenFilter.md create mode 100644 docs/reference/api/AnalysisUppercaseTokenFilter.md create mode 100644 docs/reference/api/AnalysisWhitespaceAnalyzer.md create mode 100644 docs/reference/api/AnalysisWhitespaceTokenizer.md create mode 100644 docs/reference/api/AnalysisWordDelimiterGraphTokenFilter.md create mode 100644 docs/reference/api/AnalysisWordDelimiterTokenFilter.md create mode 100644 docs/reference/api/AnalysisWordDelimiterTokenFilterBase.md create mode 100644 docs/reference/api/AsyncSearch.md create mode 100644 docs/reference/api/AsyncSearchAsyncSearch.md create mode 100644 docs/reference/api/AsyncSearchAsyncSearchDocumentResponseBase.md create mode 100644 docs/reference/api/AsyncSearchAsyncSearchResponseBase.md create mode 100644 docs/reference/api/AsyncSearchDeleteRequest.md create mode 100644 docs/reference/api/AsyncSearchDeleteResponse.md create mode 100644 docs/reference/api/AsyncSearchGetRequest.md create mode 100644 docs/reference/api/AsyncSearchGetResponse.md create mode 100644 docs/reference/api/AsyncSearchStatusRequest.md create mode 100644 docs/reference/api/AsyncSearchStatusResponse.md create mode 100644 docs/reference/api/AsyncSearchStatusStatusResponseBase.md create mode 100644 docs/reference/api/AsyncSearchSubmitRequest.md create mode 100644 docs/reference/api/AsyncSearchSubmitResponse.md create mode 100644 docs/reference/api/Autoscaling.md create mode 100644 docs/reference/api/AutoscalingAutoscalingPolicy.md create mode 100644 docs/reference/api/AutoscalingDeleteAutoscalingPolicyRequest.md create mode 100644 docs/reference/api/AutoscalingDeleteAutoscalingPolicyResponse.md create mode 100644 docs/reference/api/AutoscalingGetAutoscalingCapacityAutoscalingCapacity.md create mode 100644 docs/reference/api/AutoscalingGetAutoscalingCapacityAutoscalingDecider.md create mode 100644 docs/reference/api/AutoscalingGetAutoscalingCapacityAutoscalingDeciders.md create mode 100644 docs/reference/api/AutoscalingGetAutoscalingCapacityAutoscalingNode.md create mode 100644 docs/reference/api/AutoscalingGetAutoscalingCapacityAutoscalingResources.md create mode 100644 docs/reference/api/AutoscalingGetAutoscalingCapacityRequest.md create mode 100644 docs/reference/api/AutoscalingGetAutoscalingCapacityResponse.md create mode 100644 docs/reference/api/AutoscalingGetAutoscalingPolicyRequest.md create mode 100644 docs/reference/api/AutoscalingGetAutoscalingPolicyResponse.md create mode 100644 docs/reference/api/AutoscalingPutAutoscalingPolicyRequest.md create mode 100644 docs/reference/api/AutoscalingPutAutoscalingPolicyResponse.md create mode 100644 docs/reference/api/BulkApi_1.md create mode 100644 docs/reference/api/BulkApi_2.md create mode 100644 docs/reference/api/BulkApi_3.md create mode 100644 docs/reference/api/BulkCreateOperation.md create mode 100644 docs/reference/api/BulkDeleteOperation.md create mode 100644 docs/reference/api/BulkFailureStoreStatus.md create mode 100644 docs/reference/api/BulkHelper.md create mode 100644 docs/reference/api/BulkHelperOptions.md create mode 100644 docs/reference/api/BulkIndexByScrollFailure.md create mode 100644 docs/reference/api/BulkIndexOperation.md create mode 100644 docs/reference/api/BulkOperationBase.md create mode 100644 docs/reference/api/BulkOperationContainer.md create mode 100644 docs/reference/api/BulkOperationType.md create mode 100644 docs/reference/api/BulkRequest.md create mode 100644 docs/reference/api/BulkResponse.md create mode 100644 docs/reference/api/BulkResponseItem.md create mode 100644 docs/reference/api/BulkStats.md create mode 100644 docs/reference/api/BulkUpdateAction.md create mode 100644 docs/reference/api/BulkUpdateOperation.md create mode 100644 docs/reference/api/BulkWriteOperation.md create mode 100644 docs/reference/api/ByteSize.md create mode 100644 docs/reference/api/Bytes.md create mode 100644 docs/reference/api/CapabilitiesApi_1.md create mode 100644 docs/reference/api/CapabilitiesApi_2.md create mode 100644 docs/reference/api/CapabilitiesApi_3.md create mode 100644 docs/reference/api/Cat.md create mode 100644 docs/reference/api/CatAliasesAliasesRecord.md create mode 100644 docs/reference/api/CatAliasesRequest.md create mode 100644 docs/reference/api/CatAliasesResponse.md create mode 100644 docs/reference/api/CatAllocationAllocationRecord.md create mode 100644 docs/reference/api/CatAllocationRequest.md create mode 100644 docs/reference/api/CatAllocationResponse.md create mode 100644 docs/reference/api/CatCatAnomalyDetectorColumn.md create mode 100644 docs/reference/api/CatCatAnonalyDetectorColumns.md create mode 100644 docs/reference/api/CatCatDatafeedColumn.md create mode 100644 docs/reference/api/CatCatDatafeedColumns.md create mode 100644 docs/reference/api/CatCatDfaColumn.md create mode 100644 docs/reference/api/CatCatDfaColumns.md create mode 100644 docs/reference/api/CatCatNodeColumn.md create mode 100644 docs/reference/api/CatCatNodeColumns.md create mode 100644 docs/reference/api/CatCatRequestBase.md create mode 100644 docs/reference/api/CatCatTrainedModelsColumn.md create mode 100644 docs/reference/api/CatCatTrainedModelsColumns.md create mode 100644 docs/reference/api/CatCatTransformColumn.md create mode 100644 docs/reference/api/CatCatTransformColumns.md create mode 100644 docs/reference/api/CatComponentTemplatesComponentTemplate.md create mode 100644 docs/reference/api/CatComponentTemplatesRequest.md create mode 100644 docs/reference/api/CatComponentTemplatesResponse.md create mode 100644 docs/reference/api/CatCountCountRecord.md create mode 100644 docs/reference/api/CatCountRequest.md create mode 100644 docs/reference/api/CatCountResponse.md create mode 100644 docs/reference/api/CatFielddataFielddataRecord.md create mode 100644 docs/reference/api/CatFielddataRequest.md create mode 100644 docs/reference/api/CatFielddataResponse.md create mode 100644 docs/reference/api/CatHealthHealthRecord.md create mode 100644 docs/reference/api/CatHealthRequest.md create mode 100644 docs/reference/api/CatHealthResponse.md create mode 100644 docs/reference/api/CatHelpRequest.md create mode 100644 docs/reference/api/CatHelpResponse.md create mode 100644 docs/reference/api/CatIndicesIndicesRecord.md create mode 100644 docs/reference/api/CatIndicesRequest.md create mode 100644 docs/reference/api/CatIndicesResponse.md create mode 100644 docs/reference/api/CatMasterMasterRecord.md create mode 100644 docs/reference/api/CatMasterRequest.md create mode 100644 docs/reference/api/CatMasterResponse.md create mode 100644 docs/reference/api/CatMlDataFrameAnalyticsDataFrameAnalyticsRecord.md create mode 100644 docs/reference/api/CatMlDataFrameAnalyticsRequest.md create mode 100644 docs/reference/api/CatMlDataFrameAnalyticsResponse.md create mode 100644 docs/reference/api/CatMlDatafeedsDatafeedsRecord.md create mode 100644 docs/reference/api/CatMlDatafeedsRequest.md create mode 100644 docs/reference/api/CatMlDatafeedsResponse.md create mode 100644 docs/reference/api/CatMlJobsJobsRecord.md create mode 100644 docs/reference/api/CatMlJobsRequest.md create mode 100644 docs/reference/api/CatMlJobsResponse.md create mode 100644 docs/reference/api/CatMlTrainedModelsRequest.md create mode 100644 docs/reference/api/CatMlTrainedModelsResponse.md create mode 100644 docs/reference/api/CatMlTrainedModelsTrainedModelsRecord.md create mode 100644 docs/reference/api/CatNodeattrsNodeAttributesRecord.md create mode 100644 docs/reference/api/CatNodeattrsRequest.md create mode 100644 docs/reference/api/CatNodeattrsResponse.md create mode 100644 docs/reference/api/CatNodesNodesRecord.md create mode 100644 docs/reference/api/CatNodesRequest.md create mode 100644 docs/reference/api/CatNodesResponse.md create mode 100644 docs/reference/api/CatPendingTasksPendingTasksRecord.md create mode 100644 docs/reference/api/CatPendingTasksRequest.md create mode 100644 docs/reference/api/CatPendingTasksResponse.md create mode 100644 docs/reference/api/CatPluginsPluginsRecord.md create mode 100644 docs/reference/api/CatPluginsRequest.md create mode 100644 docs/reference/api/CatPluginsResponse.md create mode 100644 docs/reference/api/CatRecoveryRecoveryRecord.md create mode 100644 docs/reference/api/CatRecoveryRequest.md create mode 100644 docs/reference/api/CatRecoveryResponse.md create mode 100644 docs/reference/api/CatRepositoriesRepositoriesRecord.md create mode 100644 docs/reference/api/CatRepositoriesRequest.md create mode 100644 docs/reference/api/CatRepositoriesResponse.md create mode 100644 docs/reference/api/CatSegmentsRequest.md create mode 100644 docs/reference/api/CatSegmentsResponse.md create mode 100644 docs/reference/api/CatSegmentsSegmentsRecord.md create mode 100644 docs/reference/api/CatShardsRequest.md create mode 100644 docs/reference/api/CatShardsResponse.md create mode 100644 docs/reference/api/CatShardsShardsRecord.md create mode 100644 docs/reference/api/CatSnapshotsRequest.md create mode 100644 docs/reference/api/CatSnapshotsResponse.md create mode 100644 docs/reference/api/CatSnapshotsSnapshotsRecord.md create mode 100644 docs/reference/api/CatTasksRequest.md create mode 100644 docs/reference/api/CatTasksResponse.md create mode 100644 docs/reference/api/CatTasksTasksRecord.md create mode 100644 docs/reference/api/CatTemplatesRequest.md create mode 100644 docs/reference/api/CatTemplatesResponse.md create mode 100644 docs/reference/api/CatTemplatesTemplatesRecord.md create mode 100644 docs/reference/api/CatThreadPoolRequest.md create mode 100644 docs/reference/api/CatThreadPoolResponse.md create mode 100644 docs/reference/api/CatThreadPoolThreadPoolRecord.md create mode 100644 docs/reference/api/CatTransformsRequest.md create mode 100644 docs/reference/api/CatTransformsResponse.md create mode 100644 docs/reference/api/CatTransformsTransformsRecord.md create mode 100644 docs/reference/api/CategoryId.md create mode 100644 docs/reference/api/Ccr.md create mode 100644 docs/reference/api/CcrDeleteAutoFollowPatternRequest.md create mode 100644 docs/reference/api/CcrDeleteAutoFollowPatternResponse.md create mode 100644 docs/reference/api/CcrFollowIndexStats.md create mode 100644 docs/reference/api/CcrFollowInfoFollowerIndex.md create mode 100644 docs/reference/api/CcrFollowInfoFollowerIndexParameters.md create mode 100644 docs/reference/api/CcrFollowInfoFollowerIndexStatus.md create mode 100644 docs/reference/api/CcrFollowInfoRequest.md create mode 100644 docs/reference/api/CcrFollowInfoResponse.md create mode 100644 docs/reference/api/CcrFollowRequest.md create mode 100644 docs/reference/api/CcrFollowResponse.md create mode 100644 docs/reference/api/CcrFollowStatsRequest.md create mode 100644 docs/reference/api/CcrFollowStatsResponse.md create mode 100644 docs/reference/api/CcrForgetFollowerRequest.md create mode 100644 docs/reference/api/CcrForgetFollowerResponse.md create mode 100644 docs/reference/api/CcrGetAutoFollowPatternAutoFollowPattern.md create mode 100644 docs/reference/api/CcrGetAutoFollowPatternAutoFollowPatternSummary.md create mode 100644 docs/reference/api/CcrGetAutoFollowPatternRequest.md create mode 100644 docs/reference/api/CcrGetAutoFollowPatternResponse.md create mode 100644 docs/reference/api/CcrPauseAutoFollowPatternRequest.md create mode 100644 docs/reference/api/CcrPauseAutoFollowPatternResponse.md create mode 100644 docs/reference/api/CcrPauseFollowRequest.md create mode 100644 docs/reference/api/CcrPauseFollowResponse.md create mode 100644 docs/reference/api/CcrPutAutoFollowPatternRequest.md create mode 100644 docs/reference/api/CcrPutAutoFollowPatternResponse.md create mode 100644 docs/reference/api/CcrReadException.md create mode 100644 docs/reference/api/CcrResumeAutoFollowPatternRequest.md create mode 100644 docs/reference/api/CcrResumeAutoFollowPatternResponse.md create mode 100644 docs/reference/api/CcrResumeFollowRequest.md create mode 100644 docs/reference/api/CcrResumeFollowResponse.md create mode 100644 docs/reference/api/CcrShardStats.md create mode 100644 docs/reference/api/CcrStatsAutoFollowStats.md create mode 100644 docs/reference/api/CcrStatsAutoFollowedCluster.md create mode 100644 docs/reference/api/CcrStatsFollowStats.md create mode 100644 docs/reference/api/CcrStatsRequest.md create mode 100644 docs/reference/api/CcrStatsResponse.md create mode 100644 docs/reference/api/CcrUnfollowRequest.md create mode 100644 docs/reference/api/CcrUnfollowResponse.md create mode 100644 docs/reference/api/ClearScrollApi_1.md create mode 100644 docs/reference/api/ClearScrollApi_2.md create mode 100644 docs/reference/api/ClearScrollApi_3.md create mode 100644 docs/reference/api/ClearScrollRequest.md create mode 100644 docs/reference/api/ClearScrollResponse.md create mode 100644 docs/reference/api/Client.md create mode 100644 docs/reference/api/ClientOptions.md create mode 100644 docs/reference/api/ClosePointInTimeApi_1.md create mode 100644 docs/reference/api/ClosePointInTimeApi_2.md create mode 100644 docs/reference/api/ClosePointInTimeApi_3.md create mode 100644 docs/reference/api/ClosePointInTimeRequest.md create mode 100644 docs/reference/api/ClosePointInTimeResponse.md create mode 100644 docs/reference/api/Cluster.md create mode 100644 docs/reference/api/ClusterAlias.md create mode 100644 docs/reference/api/ClusterAllocationExplainAllocationDecision.md create mode 100644 docs/reference/api/ClusterAllocationExplainAllocationExplainDecision.md create mode 100644 docs/reference/api/ClusterAllocationExplainAllocationStore.md create mode 100644 docs/reference/api/ClusterAllocationExplainClusterInfo.md create mode 100644 docs/reference/api/ClusterAllocationExplainCurrentNode.md create mode 100644 docs/reference/api/ClusterAllocationExplainDecision.md create mode 100644 docs/reference/api/ClusterAllocationExplainDiskUsage.md create mode 100644 docs/reference/api/ClusterAllocationExplainNodeAllocationExplanation.md create mode 100644 docs/reference/api/ClusterAllocationExplainNodeDiskUsage.md create mode 100644 docs/reference/api/ClusterAllocationExplainRequest.md create mode 100644 docs/reference/api/ClusterAllocationExplainReservedSize.md create mode 100644 docs/reference/api/ClusterAllocationExplainResponse.md create mode 100644 docs/reference/api/ClusterAllocationExplainUnassignedInformation.md create mode 100644 docs/reference/api/ClusterAllocationExplainUnassignedInformationReason.md create mode 100644 docs/reference/api/ClusterComponentTemplate.md create mode 100644 docs/reference/api/ClusterComponentTemplateNode.md create mode 100644 docs/reference/api/ClusterComponentTemplateSummary.md create mode 100644 docs/reference/api/ClusterDeleteComponentTemplateRequest.md create mode 100644 docs/reference/api/ClusterDeleteComponentTemplateResponse.md create mode 100644 docs/reference/api/ClusterDeleteVotingConfigExclusionsRequest.md create mode 100644 docs/reference/api/ClusterDeleteVotingConfigExclusionsResponse.md create mode 100644 docs/reference/api/ClusterDetails.md create mode 100644 docs/reference/api/ClusterExistsComponentTemplateRequest.md create mode 100644 docs/reference/api/ClusterExistsComponentTemplateResponse.md create mode 100644 docs/reference/api/ClusterGetComponentTemplateRequest.md create mode 100644 docs/reference/api/ClusterGetComponentTemplateResponse.md create mode 100644 docs/reference/api/ClusterGetSettingsRequest.md create mode 100644 docs/reference/api/ClusterGetSettingsResponse.md create mode 100644 docs/reference/api/ClusterHealthHealthResponseBody.md create mode 100644 docs/reference/api/ClusterHealthIndexHealthStats.md create mode 100644 docs/reference/api/ClusterHealthRequest.md create mode 100644 docs/reference/api/ClusterHealthResponse.md create mode 100644 docs/reference/api/ClusterHealthShardHealthStats.md create mode 100644 docs/reference/api/ClusterHealthWaitForNodes.md create mode 100644 docs/reference/api/ClusterInfoRequest.md create mode 100644 docs/reference/api/ClusterInfoResponse.md create mode 100644 docs/reference/api/ClusterInfoTarget.md create mode 100644 docs/reference/api/ClusterInfoTargets.md create mode 100644 docs/reference/api/ClusterPendingTasksPendingTask.md create mode 100644 docs/reference/api/ClusterPendingTasksRequest.md create mode 100644 docs/reference/api/ClusterPendingTasksResponse.md create mode 100644 docs/reference/api/ClusterPostVotingConfigExclusionsRequest.md create mode 100644 docs/reference/api/ClusterPostVotingConfigExclusionsResponse.md create mode 100644 docs/reference/api/ClusterPutComponentTemplateRequest.md create mode 100644 docs/reference/api/ClusterPutComponentTemplateResponse.md create mode 100644 docs/reference/api/ClusterPutSettingsRequest.md create mode 100644 docs/reference/api/ClusterPutSettingsResponse.md create mode 100644 docs/reference/api/ClusterRemoteInfoClusterRemoteInfo.md create mode 100644 docs/reference/api/ClusterRemoteInfoClusterRemoteProxyInfo.md create mode 100644 docs/reference/api/ClusterRemoteInfoClusterRemoteSniffInfo.md create mode 100644 docs/reference/api/ClusterRemoteInfoRequest.md create mode 100644 docs/reference/api/ClusterRemoteInfoResponse.md create mode 100644 docs/reference/api/ClusterRerouteCommand.md create mode 100644 docs/reference/api/ClusterRerouteCommandAllocatePrimaryAction.md create mode 100644 docs/reference/api/ClusterRerouteCommandAllocateReplicaAction.md create mode 100644 docs/reference/api/ClusterRerouteCommandCancelAction.md create mode 100644 docs/reference/api/ClusterRerouteCommandMoveAction.md create mode 100644 docs/reference/api/ClusterRerouteRequest.md create mode 100644 docs/reference/api/ClusterRerouteRerouteDecision.md create mode 100644 docs/reference/api/ClusterRerouteRerouteExplanation.md create mode 100644 docs/reference/api/ClusterRerouteRerouteParameters.md create mode 100644 docs/reference/api/ClusterRerouteResponse.md create mode 100644 docs/reference/api/ClusterSearchStatus.md create mode 100644 docs/reference/api/ClusterStateRequest.md create mode 100644 docs/reference/api/ClusterStateResponse.md create mode 100644 docs/reference/api/ClusterStatistics.md create mode 100644 docs/reference/api/ClusterStatsCCSStats.md create mode 100644 docs/reference/api/ClusterStatsCCSUsageClusterStats.md create mode 100644 docs/reference/api/ClusterStatsCCSUsageStats.md create mode 100644 docs/reference/api/ClusterStatsCCSUsageTimeValue.md create mode 100644 docs/reference/api/ClusterStatsCharFilterTypes.md create mode 100644 docs/reference/api/ClusterStatsClusterFileSystem.md create mode 100644 docs/reference/api/ClusterStatsClusterIndices.md create mode 100644 docs/reference/api/ClusterStatsClusterIndicesShards.md create mode 100644 docs/reference/api/ClusterStatsClusterIndicesShardsIndex.md create mode 100644 docs/reference/api/ClusterStatsClusterIngest.md create mode 100644 docs/reference/api/ClusterStatsClusterJvm.md create mode 100644 docs/reference/api/ClusterStatsClusterJvmMemory.md create mode 100644 docs/reference/api/ClusterStatsClusterJvmVersion.md create mode 100644 docs/reference/api/ClusterStatsClusterNetworkTypes.md create mode 100644 docs/reference/api/ClusterStatsClusterNodeCount.md create mode 100644 docs/reference/api/ClusterStatsClusterNodes.md create mode 100644 docs/reference/api/ClusterStatsClusterOperatingSystem.md create mode 100644 docs/reference/api/ClusterStatsClusterOperatingSystemArchitecture.md create mode 100644 docs/reference/api/ClusterStatsClusterOperatingSystemName.md create mode 100644 docs/reference/api/ClusterStatsClusterOperatingSystemPrettyName.md create mode 100644 docs/reference/api/ClusterStatsClusterProcess.md create mode 100644 docs/reference/api/ClusterStatsClusterProcessCpu.md create mode 100644 docs/reference/api/ClusterStatsClusterProcessOpenFileDescriptors.md create mode 100644 docs/reference/api/ClusterStatsClusterProcessor.md create mode 100644 docs/reference/api/ClusterStatsClusterShardMetrics.md create mode 100644 docs/reference/api/ClusterStatsFieldTypes.md create mode 100644 docs/reference/api/ClusterStatsFieldTypesMappings.md create mode 100644 docs/reference/api/ClusterStatsIndexingPressure.md create mode 100644 docs/reference/api/ClusterStatsIndexingPressureMemory.md create mode 100644 docs/reference/api/ClusterStatsIndexingPressureMemorySummary.md create mode 100644 docs/reference/api/ClusterStatsIndicesVersions.md create mode 100644 docs/reference/api/ClusterStatsNodePackagingType.md create mode 100644 docs/reference/api/ClusterStatsOperatingSystemMemoryInfo.md create mode 100644 docs/reference/api/ClusterStatsRemoteClusterInfo.md create mode 100644 docs/reference/api/ClusterStatsRequest.md create mode 100644 docs/reference/api/ClusterStatsResponse.md create mode 100644 docs/reference/api/ClusterStatsRuntimeFieldTypes.md create mode 100644 docs/reference/api/ClusterStatsStatsResponseBase.md create mode 100644 docs/reference/api/CompletionStats.md create mode 100644 docs/reference/api/Conflicts.md create mode 100644 docs/reference/api/Connector.md create mode 100644 docs/reference/api/ConnectorCheckInRequest.md create mode 100644 docs/reference/api/ConnectorCheckInResponse.md create mode 100644 docs/reference/api/ConnectorConnector.md create mode 100644 docs/reference/api/ConnectorConnectorConfigProperties.md create mode 100644 docs/reference/api/ConnectorConnectorConfiguration.md create mode 100644 docs/reference/api/ConnectorConnectorCustomScheduling.md create mode 100644 docs/reference/api/ConnectorConnectorFeatures.md create mode 100644 docs/reference/api/ConnectorConnectorFieldType.md create mode 100644 docs/reference/api/ConnectorConnectorScheduling.md create mode 100644 docs/reference/api/ConnectorConnectorStatus.md create mode 100644 docs/reference/api/ConnectorConnectorSyncJob.md create mode 100644 docs/reference/api/ConnectorCustomScheduling.md create mode 100644 docs/reference/api/ConnectorCustomSchedulingConfigurationOverrides.md create mode 100644 docs/reference/api/ConnectorDeleteRequest.md create mode 100644 docs/reference/api/ConnectorDeleteResponse.md create mode 100644 docs/reference/api/ConnectorDependency.md create mode 100644 docs/reference/api/ConnectorDisplayType.md create mode 100644 docs/reference/api/ConnectorFeatureEnabled.md create mode 100644 docs/reference/api/ConnectorFilteringAdvancedSnippet.md create mode 100644 docs/reference/api/ConnectorFilteringConfig.md create mode 100644 docs/reference/api/ConnectorFilteringPolicy.md create mode 100644 docs/reference/api/ConnectorFilteringRule.md create mode 100644 docs/reference/api/ConnectorFilteringRuleRule.md create mode 100644 docs/reference/api/ConnectorFilteringRules.md create mode 100644 docs/reference/api/ConnectorFilteringRulesValidation.md create mode 100644 docs/reference/api/ConnectorFilteringValidation.md create mode 100644 docs/reference/api/ConnectorFilteringValidationState.md create mode 100644 docs/reference/api/ConnectorGetRequest.md create mode 100644 docs/reference/api/ConnectorGetResponse.md create mode 100644 docs/reference/api/ConnectorGreaterThanValidation.md create mode 100644 docs/reference/api/ConnectorIncludedInValidation.md create mode 100644 docs/reference/api/ConnectorIngestPipelineParams.md create mode 100644 docs/reference/api/ConnectorLastSyncRequest.md create mode 100644 docs/reference/api/ConnectorLastSyncResponse.md create mode 100644 docs/reference/api/ConnectorLessThanValidation.md create mode 100644 docs/reference/api/ConnectorListRequest.md create mode 100644 docs/reference/api/ConnectorListResponse.md create mode 100644 docs/reference/api/ConnectorListTypeValidation.md create mode 100644 docs/reference/api/ConnectorPostRequest.md create mode 100644 docs/reference/api/ConnectorPostResponse.md create mode 100644 docs/reference/api/ConnectorPutRequest.md create mode 100644 docs/reference/api/ConnectorPutResponse.md create mode 100644 docs/reference/api/ConnectorRegexValidation.md create mode 100644 docs/reference/api/ConnectorSchedulingConfiguration.md create mode 100644 docs/reference/api/ConnectorSelectOption.md create mode 100644 docs/reference/api/ConnectorSyncJobCancelRequest.md create mode 100644 docs/reference/api/ConnectorSyncJobCancelResponse.md create mode 100644 docs/reference/api/ConnectorSyncJobCheckInRequest.md create mode 100644 docs/reference/api/ConnectorSyncJobCheckInResponse.md create mode 100644 docs/reference/api/ConnectorSyncJobClaimRequest.md create mode 100644 docs/reference/api/ConnectorSyncJobClaimResponse.md create mode 100644 docs/reference/api/ConnectorSyncJobConnectorReference.md create mode 100644 docs/reference/api/ConnectorSyncJobDeleteRequest.md create mode 100644 docs/reference/api/ConnectorSyncJobDeleteResponse.md create mode 100644 docs/reference/api/ConnectorSyncJobErrorRequest.md create mode 100644 docs/reference/api/ConnectorSyncJobErrorResponse.md create mode 100644 docs/reference/api/ConnectorSyncJobGetRequest.md create mode 100644 docs/reference/api/ConnectorSyncJobGetResponse.md create mode 100644 docs/reference/api/ConnectorSyncJobListRequest.md create mode 100644 docs/reference/api/ConnectorSyncJobListResponse.md create mode 100644 docs/reference/api/ConnectorSyncJobPostRequest.md create mode 100644 docs/reference/api/ConnectorSyncJobPostResponse.md create mode 100644 docs/reference/api/ConnectorSyncJobTriggerMethod.md create mode 100644 docs/reference/api/ConnectorSyncJobType.md create mode 100644 docs/reference/api/ConnectorSyncJobUpdateStatsRequest.md create mode 100644 docs/reference/api/ConnectorSyncJobUpdateStatsResponse.md create mode 100644 docs/reference/api/ConnectorSyncRulesFeature.md create mode 100644 docs/reference/api/ConnectorSyncStatus.md create mode 100644 docs/reference/api/ConnectorUpdateActiveFilteringRequest.md create mode 100644 docs/reference/api/ConnectorUpdateActiveFilteringResponse.md create mode 100644 docs/reference/api/ConnectorUpdateApiKeyIdRequest.md create mode 100644 docs/reference/api/ConnectorUpdateApiKeyIdResponse.md create mode 100644 docs/reference/api/ConnectorUpdateConfigurationRequest.md create mode 100644 docs/reference/api/ConnectorUpdateConfigurationResponse.md create mode 100644 docs/reference/api/ConnectorUpdateErrorRequest.md create mode 100644 docs/reference/api/ConnectorUpdateErrorResponse.md create mode 100644 docs/reference/api/ConnectorUpdateFeaturesRequest.md create mode 100644 docs/reference/api/ConnectorUpdateFeaturesResponse.md create mode 100644 docs/reference/api/ConnectorUpdateFilteringRequest.md create mode 100644 docs/reference/api/ConnectorUpdateFilteringResponse.md create mode 100644 docs/reference/api/ConnectorUpdateFilteringValidationRequest.md create mode 100644 docs/reference/api/ConnectorUpdateFilteringValidationResponse.md create mode 100644 docs/reference/api/ConnectorUpdateIndexNameRequest.md create mode 100644 docs/reference/api/ConnectorUpdateIndexNameResponse.md create mode 100644 docs/reference/api/ConnectorUpdateNameRequest.md create mode 100644 docs/reference/api/ConnectorUpdateNameResponse.md create mode 100644 docs/reference/api/ConnectorUpdateNativeRequest.md create mode 100644 docs/reference/api/ConnectorUpdateNativeResponse.md create mode 100644 docs/reference/api/ConnectorUpdatePipelineRequest.md create mode 100644 docs/reference/api/ConnectorUpdatePipelineResponse.md create mode 100644 docs/reference/api/ConnectorUpdateSchedulingRequest.md create mode 100644 docs/reference/api/ConnectorUpdateSchedulingResponse.md create mode 100644 docs/reference/api/ConnectorUpdateServiceTypeRequest.md create mode 100644 docs/reference/api/ConnectorUpdateServiceTypeResponse.md create mode 100644 docs/reference/api/ConnectorUpdateStatusRequest.md create mode 100644 docs/reference/api/ConnectorUpdateStatusResponse.md create mode 100644 docs/reference/api/ConnectorValidation.md create mode 100644 docs/reference/api/CoordsGeoBounds.md create mode 100644 docs/reference/api/CountApi_1.md create mode 100644 docs/reference/api/CountApi_2.md create mode 100644 docs/reference/api/CountApi_3.md create mode 100644 docs/reference/api/CountRequest.md create mode 100644 docs/reference/api/CountResponse.md create mode 100644 docs/reference/api/CreateAction.md create mode 100644 docs/reference/api/CreateActionOperation.md create mode 100644 docs/reference/api/CreateApi_1.md create mode 100644 docs/reference/api/CreateApi_2.md create mode 100644 docs/reference/api/CreateApi_3.md create mode 100644 docs/reference/api/CreateRequest.md create mode 100644 docs/reference/api/CreateResponse.md create mode 100644 docs/reference/api/DFIIndependenceMeasure.md create mode 100644 docs/reference/api/DFRAfterEffect.md create mode 100644 docs/reference/api/DFRBasicModel.md create mode 100644 docs/reference/api/DanglingIndices.md create mode 100644 docs/reference/api/DanglingIndicesDeleteDanglingIndexRequest.md create mode 100644 docs/reference/api/DanglingIndicesDeleteDanglingIndexResponse.md create mode 100644 docs/reference/api/DanglingIndicesImportDanglingIndexRequest.md create mode 100644 docs/reference/api/DanglingIndicesImportDanglingIndexResponse.md create mode 100644 docs/reference/api/DanglingIndicesListDanglingIndicesDanglingIndex.md create mode 100644 docs/reference/api/DanglingIndicesListDanglingIndicesRequest.md create mode 100644 docs/reference/api/DanglingIndicesListDanglingIndicesResponse.md create mode 100644 docs/reference/api/DataStreamName.md create mode 100644 docs/reference/api/DataStreamNames.md create mode 100644 docs/reference/api/DateFormat.md create mode 100644 docs/reference/api/DateMath.md create mode 100644 docs/reference/api/DateTime.md create mode 100644 docs/reference/api/DeleteAction.md create mode 100644 docs/reference/api/DeleteApi_1.md create mode 100644 docs/reference/api/DeleteApi_2.md create mode 100644 docs/reference/api/DeleteApi_3.md create mode 100644 docs/reference/api/DeleteByQueryApi_1.md create mode 100644 docs/reference/api/DeleteByQueryApi_2.md create mode 100644 docs/reference/api/DeleteByQueryApi_3.md create mode 100644 docs/reference/api/DeleteByQueryRequest.md create mode 100644 docs/reference/api/DeleteByQueryResponse.md create mode 100644 docs/reference/api/DeleteByQueryRethrottleApi_1.md create mode 100644 docs/reference/api/DeleteByQueryRethrottleApi_2.md create mode 100644 docs/reference/api/DeleteByQueryRethrottleApi_3.md create mode 100644 docs/reference/api/DeleteByQueryRethrottleRequest.md create mode 100644 docs/reference/api/DeleteByQueryRethrottleResponse.md create mode 100644 docs/reference/api/DeleteRequest.md create mode 100644 docs/reference/api/DeleteResponse.md create mode 100644 docs/reference/api/DeleteScriptApi_1.md create mode 100644 docs/reference/api/DeleteScriptApi_2.md create mode 100644 docs/reference/api/DeleteScriptApi_3.md create mode 100644 docs/reference/api/DeleteScriptRequest.md create mode 100644 docs/reference/api/DeleteScriptResponse.md create mode 100644 docs/reference/api/Distance.md create mode 100644 docs/reference/api/DistanceUnit.md create mode 100644 docs/reference/api/DocStats.md create mode 100644 docs/reference/api/Duration.md create mode 100644 docs/reference/api/DurationLarge.md create mode 100644 docs/reference/api/DurationValue.md create mode 100644 docs/reference/api/ElasticsearchVersionInfo.md create mode 100644 docs/reference/api/ElasticsearchVersionMinInfo.md create mode 100644 docs/reference/api/EmptyObject.md create mode 100644 docs/reference/api/Enrich.md create mode 100644 docs/reference/api/EnrichDeletePolicyRequest.md create mode 100644 docs/reference/api/EnrichDeletePolicyResponse.md create mode 100644 docs/reference/api/EnrichExecutePolicyEnrichPolicyPhase.md create mode 100644 docs/reference/api/EnrichExecutePolicyExecuteEnrichPolicyStatus.md create mode 100644 docs/reference/api/EnrichExecutePolicyRequest.md create mode 100644 docs/reference/api/EnrichExecutePolicyResponse.md create mode 100644 docs/reference/api/EnrichGetPolicyRequest.md create mode 100644 docs/reference/api/EnrichGetPolicyResponse.md create mode 100644 docs/reference/api/EnrichPolicy.md create mode 100644 docs/reference/api/EnrichPolicyType.md create mode 100644 docs/reference/api/EnrichPutPolicyRequest.md create mode 100644 docs/reference/api/EnrichPutPolicyResponse.md create mode 100644 docs/reference/api/EnrichStatsCacheStats.md create mode 100644 docs/reference/api/EnrichStatsCoordinatorStats.md create mode 100644 docs/reference/api/EnrichStatsExecutingPolicy.md create mode 100644 docs/reference/api/EnrichStatsRequest.md create mode 100644 docs/reference/api/EnrichStatsResponse.md create mode 100644 docs/reference/api/EnrichSummary.md create mode 100644 docs/reference/api/EpochTime.md create mode 100644 docs/reference/api/Eql.md create mode 100644 docs/reference/api/EqlDeleteRequest.md create mode 100644 docs/reference/api/EqlDeleteResponse.md create mode 100644 docs/reference/api/EqlEqlHits.md create mode 100644 docs/reference/api/EqlEqlSearchResponseBase.md create mode 100644 docs/reference/api/EqlGetRequest.md create mode 100644 docs/reference/api/EqlGetResponse.md create mode 100644 docs/reference/api/EqlGetStatusRequest.md create mode 100644 docs/reference/api/EqlGetStatusResponse.md create mode 100644 docs/reference/api/EqlHitsEvent.md create mode 100644 docs/reference/api/EqlHitsSequence.md create mode 100644 docs/reference/api/EqlSearchRequest.md create mode 100644 docs/reference/api/EqlSearchResponse.md create mode 100644 docs/reference/api/EqlSearchResultPosition.md create mode 100644 docs/reference/api/ErrorCause.md create mode 100644 docs/reference/api/ErrorCauseKeys.md create mode 100644 docs/reference/api/ErrorResponseBase.md create mode 100644 docs/reference/api/Esql.md create mode 100644 docs/reference/api/EsqlAsyncEsqlResult.md create mode 100644 docs/reference/api/EsqlAsyncQueryDeleteRequest.md create mode 100644 docs/reference/api/EsqlAsyncQueryDeleteResponse.md create mode 100644 docs/reference/api/EsqlAsyncQueryGetRequest.md create mode 100644 docs/reference/api/EsqlAsyncQueryGetResponse.md create mode 100644 docs/reference/api/EsqlAsyncQueryRequest.md create mode 100644 docs/reference/api/EsqlAsyncQueryResponse.md create mode 100644 docs/reference/api/EsqlAsyncQueryStopRequest.md create mode 100644 docs/reference/api/EsqlAsyncQueryStopResponse.md create mode 100644 docs/reference/api/EsqlColumn.md create mode 100644 docs/reference/api/EsqlEsqlClusterDetails.md create mode 100644 docs/reference/api/EsqlEsqlClusterInfo.md create mode 100644 docs/reference/api/EsqlEsqlClusterStatus.md create mode 100644 docs/reference/api/EsqlEsqlColumnInfo.md create mode 100644 docs/reference/api/EsqlEsqlFormat.md create mode 100644 docs/reference/api/EsqlEsqlResult.md create mode 100644 docs/reference/api/EsqlEsqlShardFailure.md create mode 100644 docs/reference/api/EsqlEsqlShardInfo.md create mode 100644 docs/reference/api/EsqlGetQueryRequest.md create mode 100644 docs/reference/api/EsqlGetQueryResponse.md create mode 100644 docs/reference/api/EsqlHelper.md create mode 100644 docs/reference/api/EsqlListQueriesBody.md create mode 100644 docs/reference/api/EsqlListQueriesRequest.md create mode 100644 docs/reference/api/EsqlListQueriesResponse.md create mode 100644 docs/reference/api/EsqlQueryRequest.md create mode 100644 docs/reference/api/EsqlQueryResponse.md create mode 100644 docs/reference/api/EsqlTableValuesContainer.md create mode 100644 docs/reference/api/EsqlTableValuesIntegerValue.md create mode 100644 docs/reference/api/EsqlTableValuesKeywordValue.md create mode 100644 docs/reference/api/EsqlTableValuesLongDouble.md create mode 100644 docs/reference/api/EsqlTableValuesLongValue.md create mode 100644 docs/reference/api/EsqlToRecords.md create mode 100644 docs/reference/api/ExistsApi_1.md create mode 100644 docs/reference/api/ExistsApi_2.md create mode 100644 docs/reference/api/ExistsApi_3.md create mode 100644 docs/reference/api/ExistsRequest.md create mode 100644 docs/reference/api/ExistsResponse.md create mode 100644 docs/reference/api/ExistsSourceApi_1.md create mode 100644 docs/reference/api/ExistsSourceApi_2.md create mode 100644 docs/reference/api/ExistsSourceApi_3.md create mode 100644 docs/reference/api/ExistsSourceRequest.md create mode 100644 docs/reference/api/ExistsSourceResponse.md create mode 100644 docs/reference/api/ExpandWildcard.md create mode 100644 docs/reference/api/ExpandWildcards.md create mode 100644 docs/reference/api/ExplainApi_1.md create mode 100644 docs/reference/api/ExplainApi_2.md create mode 100644 docs/reference/api/ExplainApi_3.md create mode 100644 docs/reference/api/ExplainExplanation.md create mode 100644 docs/reference/api/ExplainExplanationDetail.md create mode 100644 docs/reference/api/ExplainRequest.md create mode 100644 docs/reference/api/ExplainResponse.md create mode 100644 docs/reference/api/Features.md create mode 100644 docs/reference/api/FeaturesFeature.md create mode 100644 docs/reference/api/FeaturesGetFeaturesRequest.md create mode 100644 docs/reference/api/FeaturesGetFeaturesResponse.md create mode 100644 docs/reference/api/FeaturesResetFeaturesRequest.md create mode 100644 docs/reference/api/FeaturesResetFeaturesResponse.md create mode 100644 docs/reference/api/Field.md create mode 100644 docs/reference/api/FieldCapsApi_1.md create mode 100644 docs/reference/api/FieldCapsApi_2.md create mode 100644 docs/reference/api/FieldCapsApi_3.md create mode 100644 docs/reference/api/FieldCapsFieldCapability.md create mode 100644 docs/reference/api/FieldCapsRequest.md create mode 100644 docs/reference/api/FieldCapsResponse.md create mode 100644 docs/reference/api/FieldMemoryUsage.md create mode 100644 docs/reference/api/FieldSizeUsage.md create mode 100644 docs/reference/api/FieldSort.md create mode 100644 docs/reference/api/FieldSortNumericType.md create mode 100644 docs/reference/api/FieldValue.md create mode 100644 docs/reference/api/FielddataStats.md create mode 100644 docs/reference/api/Fields.md create mode 100644 docs/reference/api/Fleet.md create mode 100644 docs/reference/api/FleetCheckpoint.md create mode 100644 docs/reference/api/FleetGlobalCheckpointsRequest.md create mode 100644 docs/reference/api/FleetGlobalCheckpointsResponse.md create mode 100644 docs/reference/api/FleetMsearchRequest.md create mode 100644 docs/reference/api/FleetMsearchResponse.md create mode 100644 docs/reference/api/FleetSearchRequest.md create mode 100644 docs/reference/api/FleetSearchResponse.md create mode 100644 docs/reference/api/FlushStats.md create mode 100644 docs/reference/api/Fuzziness.md create mode 100644 docs/reference/api/GeoBounds.md create mode 100644 docs/reference/api/GeoDistanceSort.md create mode 100644 docs/reference/api/GeoDistanceSortKeys.md create mode 100644 docs/reference/api/GeoDistanceType.md create mode 100644 docs/reference/api/GeoHash.md create mode 100644 docs/reference/api/GeoHashLocation.md create mode 100644 docs/reference/api/GeoHashPrecision.md create mode 100644 docs/reference/api/GeoHexCell.md create mode 100644 docs/reference/api/GeoLine.md create mode 100644 docs/reference/api/GeoLocation.md create mode 100644 docs/reference/api/GeoShape.md create mode 100644 docs/reference/api/GeoShapeRelation.md create mode 100644 docs/reference/api/GeoTile.md create mode 100644 docs/reference/api/GeoTilePrecision.md create mode 100644 docs/reference/api/GetApi_1.md create mode 100644 docs/reference/api/GetApi_2.md create mode 100644 docs/reference/api/GetApi_3.md create mode 100644 docs/reference/api/GetGetResult.md create mode 100644 docs/reference/api/GetRequest.md create mode 100644 docs/reference/api/GetResponse.md create mode 100644 docs/reference/api/GetScriptApi_1.md create mode 100644 docs/reference/api/GetScriptApi_2.md create mode 100644 docs/reference/api/GetScriptApi_3.md create mode 100644 docs/reference/api/GetScriptContextApi_1.md create mode 100644 docs/reference/api/GetScriptContextApi_2.md create mode 100644 docs/reference/api/GetScriptContextApi_3.md create mode 100644 docs/reference/api/GetScriptContextContext.md create mode 100644 docs/reference/api/GetScriptContextContextMethod.md create mode 100644 docs/reference/api/GetScriptContextContextMethodParam.md create mode 100644 docs/reference/api/GetScriptContextRequest.md create mode 100644 docs/reference/api/GetScriptContextResponse.md create mode 100644 docs/reference/api/GetScriptLanguagesApi_1.md create mode 100644 docs/reference/api/GetScriptLanguagesApi_2.md create mode 100644 docs/reference/api/GetScriptLanguagesApi_3.md create mode 100644 docs/reference/api/GetScriptLanguagesLanguageContext.md create mode 100644 docs/reference/api/GetScriptLanguagesRequest.md create mode 100644 docs/reference/api/GetScriptLanguagesResponse.md create mode 100644 docs/reference/api/GetScriptRequest.md create mode 100644 docs/reference/api/GetScriptResponse.md create mode 100644 docs/reference/api/GetSourceApi_1.md create mode 100644 docs/reference/api/GetSourceApi_2.md create mode 100644 docs/reference/api/GetSourceApi_3.md create mode 100644 docs/reference/api/GetSourceRequest.md create mode 100644 docs/reference/api/GetSourceResponse.md create mode 100644 docs/reference/api/GetStats.md create mode 100644 docs/reference/api/Graph.md create mode 100644 docs/reference/api/GraphConnection.md create mode 100644 docs/reference/api/GraphExploreControls.md create mode 100644 docs/reference/api/GraphExploreRequest.md create mode 100644 docs/reference/api/GraphExploreResponse.md create mode 100644 docs/reference/api/GraphHop.md create mode 100644 docs/reference/api/GraphSampleDiversity.md create mode 100644 docs/reference/api/GraphVertex.md create mode 100644 docs/reference/api/GraphVertexDefinition.md create mode 100644 docs/reference/api/GraphVertexInclude.md create mode 100644 docs/reference/api/GrokPattern.md create mode 100644 docs/reference/api/HealthReportApi_1.md create mode 100644 docs/reference/api/HealthReportApi_2.md create mode 100644 docs/reference/api/HealthReportApi_3.md create mode 100644 docs/reference/api/HealthReportBaseIndicator.md create mode 100644 docs/reference/api/HealthReportDataStreamLifecycleDetails.md create mode 100644 docs/reference/api/HealthReportDataStreamLifecycleIndicator.md create mode 100644 docs/reference/api/HealthReportDiagnosis.md create mode 100644 docs/reference/api/HealthReportDiagnosisAffectedResources.md create mode 100644 docs/reference/api/HealthReportDiskIndicator.md create mode 100644 docs/reference/api/HealthReportDiskIndicatorDetails.md create mode 100644 docs/reference/api/HealthReportFileSettingsIndicator.md create mode 100644 docs/reference/api/HealthReportFileSettingsIndicatorDetails.md create mode 100644 docs/reference/api/HealthReportIlmIndicator.md create mode 100644 docs/reference/api/HealthReportIlmIndicatorDetails.md create mode 100644 docs/reference/api/HealthReportImpact.md create mode 100644 docs/reference/api/HealthReportImpactArea.md create mode 100644 docs/reference/api/HealthReportIndicatorHealthStatus.md create mode 100644 docs/reference/api/HealthReportIndicatorNode.md create mode 100644 docs/reference/api/HealthReportIndicators.md create mode 100644 docs/reference/api/HealthReportMasterIsStableIndicator.md create mode 100644 docs/reference/api/HealthReportMasterIsStableIndicatorClusterFormationNode.md create mode 100644 docs/reference/api/HealthReportMasterIsStableIndicatorDetails.md create mode 100644 docs/reference/api/HealthReportMasterIsStableIndicatorExceptionFetchingHistory.md create mode 100644 docs/reference/api/HealthReportRepositoryIntegrityIndicator.md create mode 100644 docs/reference/api/HealthReportRepositoryIntegrityIndicatorDetails.md create mode 100644 docs/reference/api/HealthReportRequest.md create mode 100644 docs/reference/api/HealthReportResponse.md create mode 100644 docs/reference/api/HealthReportShardsAvailabilityIndicator.md create mode 100644 docs/reference/api/HealthReportShardsAvailabilityIndicatorDetails.md create mode 100644 docs/reference/api/HealthReportShardsCapacityIndicator.md create mode 100644 docs/reference/api/HealthReportShardsCapacityIndicatorDetails.md create mode 100644 docs/reference/api/HealthReportShardsCapacityIndicatorTierDetail.md create mode 100644 docs/reference/api/HealthReportSlmIndicator.md create mode 100644 docs/reference/api/HealthReportSlmIndicatorDetails.md create mode 100644 docs/reference/api/HealthReportSlmIndicatorUnhealthyPolicies.md create mode 100644 docs/reference/api/HealthReportStagnatingBackingIndices.md create mode 100644 docs/reference/api/HealthStatus.md create mode 100644 docs/reference/api/Helpers.md create mode 100644 docs/reference/api/HelpersOptions.md create mode 100644 docs/reference/api/Host.md create mode 100644 docs/reference/api/HttpHeaders.md create mode 100644 docs/reference/api/IBDistribution.md create mode 100644 docs/reference/api/IBLambda.md create mode 100644 docs/reference/api/Id.md create mode 100644 docs/reference/api/Ids.md create mode 100644 docs/reference/api/Ilm.md create mode 100644 docs/reference/api/IlmActions.md create mode 100644 docs/reference/api/IlmAllocateAction.md create mode 100644 docs/reference/api/IlmDeleteAction.md create mode 100644 docs/reference/api/IlmDeleteLifecycleRequest.md create mode 100644 docs/reference/api/IlmDeleteLifecycleResponse.md create mode 100644 docs/reference/api/IlmDownsampleAction.md create mode 100644 docs/reference/api/IlmExplainLifecycleLifecycleExplain.md create mode 100644 docs/reference/api/IlmExplainLifecycleLifecycleExplainManaged.md create mode 100644 docs/reference/api/IlmExplainLifecycleLifecycleExplainPhaseExecution.md create mode 100644 docs/reference/api/IlmExplainLifecycleLifecycleExplainUnmanaged.md create mode 100644 docs/reference/api/IlmExplainLifecycleRequest.md create mode 100644 docs/reference/api/IlmExplainLifecycleResponse.md create mode 100644 docs/reference/api/IlmForceMergeAction.md create mode 100644 docs/reference/api/IlmGetLifecycleLifecycle.md create mode 100644 docs/reference/api/IlmGetLifecycleRequest.md create mode 100644 docs/reference/api/IlmGetLifecycleResponse.md create mode 100644 docs/reference/api/IlmGetStatusRequest.md create mode 100644 docs/reference/api/IlmGetStatusResponse.md create mode 100644 docs/reference/api/IlmMigrateAction.md create mode 100644 docs/reference/api/IlmMigrateToDataTiersRequest.md create mode 100644 docs/reference/api/IlmMigrateToDataTiersResponse.md create mode 100644 docs/reference/api/IlmMoveToStepRequest.md create mode 100644 docs/reference/api/IlmMoveToStepResponse.md create mode 100644 docs/reference/api/IlmMoveToStepStepKey.md create mode 100644 docs/reference/api/IlmPhase.md create mode 100644 docs/reference/api/IlmPhases.md create mode 100644 docs/reference/api/IlmPolicy.md create mode 100644 docs/reference/api/IlmPutLifecycleRequest.md create mode 100644 docs/reference/api/IlmPutLifecycleResponse.md create mode 100644 docs/reference/api/IlmRemovePolicyRequest.md create mode 100644 docs/reference/api/IlmRemovePolicyResponse.md create mode 100644 docs/reference/api/IlmRetryRequest.md create mode 100644 docs/reference/api/IlmRetryResponse.md create mode 100644 docs/reference/api/IlmRolloverAction.md create mode 100644 docs/reference/api/IlmSearchableSnapshotAction.md create mode 100644 docs/reference/api/IlmSetPriorityAction.md create mode 100644 docs/reference/api/IlmShrinkAction.md create mode 100644 docs/reference/api/IlmStartRequest.md create mode 100644 docs/reference/api/IlmStartResponse.md create mode 100644 docs/reference/api/IlmStopRequest.md create mode 100644 docs/reference/api/IlmStopResponse.md create mode 100644 docs/reference/api/IlmWaitForSnapshotAction.md create mode 100644 docs/reference/api/IndexAction.md create mode 100644 docs/reference/api/IndexActionOperation.md create mode 100644 docs/reference/api/IndexAlias.md create mode 100644 docs/reference/api/IndexApi_1.md create mode 100644 docs/reference/api/IndexApi_2.md create mode 100644 docs/reference/api/IndexApi_3.md create mode 100644 docs/reference/api/IndexName.md create mode 100644 docs/reference/api/IndexPattern.md create mode 100644 docs/reference/api/IndexPatterns.md create mode 100644 docs/reference/api/IndexRequest.md create mode 100644 docs/reference/api/IndexResponse.md create mode 100644 docs/reference/api/IndexingStats.md create mode 100644 docs/reference/api/Indices.md create mode 100644 docs/reference/api/IndicesAddBlockIndicesBlockOptions.md create mode 100644 docs/reference/api/IndicesAddBlockIndicesBlockStatus.md create mode 100644 docs/reference/api/IndicesAddBlockRequest.md create mode 100644 docs/reference/api/IndicesAddBlockResponse.md create mode 100644 docs/reference/api/IndicesAlias.md create mode 100644 docs/reference/api/IndicesAliasDefinition.md create mode 100644 docs/reference/api/IndicesAnalyzeAnalyzeDetail.md create mode 100644 docs/reference/api/IndicesAnalyzeAnalyzeToken.md create mode 100644 docs/reference/api/IndicesAnalyzeAnalyzerDetail.md create mode 100644 docs/reference/api/IndicesAnalyzeCharFilterDetail.md create mode 100644 docs/reference/api/IndicesAnalyzeExplainAnalyzeToken.md create mode 100644 docs/reference/api/IndicesAnalyzeExplainAnalyzeTokenKeys.md create mode 100644 docs/reference/api/IndicesAnalyzeRequest.md create mode 100644 docs/reference/api/IndicesAnalyzeResponse.md create mode 100644 docs/reference/api/IndicesAnalyzeTextToAnalyze.md create mode 100644 docs/reference/api/IndicesAnalyzeTokenDetail.md create mode 100644 docs/reference/api/IndicesCacheQueries.md create mode 100644 docs/reference/api/IndicesCancelMigrateReindexRequest.md create mode 100644 docs/reference/api/IndicesCancelMigrateReindexResponse.md create mode 100644 docs/reference/api/IndicesClearCacheRequest.md create mode 100644 docs/reference/api/IndicesClearCacheResponse.md create mode 100644 docs/reference/api/IndicesCloneRequest.md create mode 100644 docs/reference/api/IndicesCloneResponse.md create mode 100644 docs/reference/api/IndicesCloseCloseIndexResult.md create mode 100644 docs/reference/api/IndicesCloseCloseShardResult.md create mode 100644 docs/reference/api/IndicesCloseRequest.md create mode 100644 docs/reference/api/IndicesCloseResponse.md create mode 100644 docs/reference/api/IndicesCreateDataStreamRequest.md create mode 100644 docs/reference/api/IndicesCreateDataStreamResponse.md create mode 100644 docs/reference/api/IndicesCreateFromCreateFrom.md create mode 100644 docs/reference/api/IndicesCreateFromRequest.md create mode 100644 docs/reference/api/IndicesCreateFromResponse.md create mode 100644 docs/reference/api/IndicesCreateRequest.md create mode 100644 docs/reference/api/IndicesCreateResponse.md create mode 100644 docs/reference/api/IndicesDataStream.md create mode 100644 docs/reference/api/IndicesDataStreamIndex.md create mode 100644 docs/reference/api/IndicesDataStreamLifecycle.md create mode 100644 docs/reference/api/IndicesDataStreamLifecycleDownsampling.md create mode 100644 docs/reference/api/IndicesDataStreamLifecycleRolloverConditions.md create mode 100644 docs/reference/api/IndicesDataStreamLifecycleWithRollover.md create mode 100644 docs/reference/api/IndicesDataStreamTimestampField.md create mode 100644 docs/reference/api/IndicesDataStreamVisibility.md create mode 100644 docs/reference/api/IndicesDataStreamsStatsDataStreamsStatsItem.md create mode 100644 docs/reference/api/IndicesDataStreamsStatsRequest.md create mode 100644 docs/reference/api/IndicesDataStreamsStatsResponse.md create mode 100644 docs/reference/api/IndicesDeleteAliasRequest.md create mode 100644 docs/reference/api/IndicesDeleteAliasResponse.md create mode 100644 docs/reference/api/IndicesDeleteDataLifecycleRequest.md create mode 100644 docs/reference/api/IndicesDeleteDataLifecycleResponse.md create mode 100644 docs/reference/api/IndicesDeleteDataStreamRequest.md create mode 100644 docs/reference/api/IndicesDeleteDataStreamResponse.md create mode 100644 docs/reference/api/IndicesDeleteIndexTemplateRequest.md create mode 100644 docs/reference/api/IndicesDeleteIndexTemplateResponse.md create mode 100644 docs/reference/api/IndicesDeleteRequest.md create mode 100644 docs/reference/api/IndicesDeleteResponse.md create mode 100644 docs/reference/api/IndicesDeleteTemplateRequest.md create mode 100644 docs/reference/api/IndicesDeleteTemplateResponse.md create mode 100644 docs/reference/api/IndicesDiskUsageRequest.md create mode 100644 docs/reference/api/IndicesDiskUsageResponse.md create mode 100644 docs/reference/api/IndicesDownsampleConfig.md create mode 100644 docs/reference/api/IndicesDownsampleRequest.md create mode 100644 docs/reference/api/IndicesDownsampleResponse.md create mode 100644 docs/reference/api/IndicesDownsamplingRound.md create mode 100644 docs/reference/api/IndicesExistsAliasRequest.md create mode 100644 docs/reference/api/IndicesExistsAliasResponse.md create mode 100644 docs/reference/api/IndicesExistsIndexTemplateRequest.md create mode 100644 docs/reference/api/IndicesExistsIndexTemplateResponse.md create mode 100644 docs/reference/api/IndicesExistsRequest.md create mode 100644 docs/reference/api/IndicesExistsResponse.md create mode 100644 docs/reference/api/IndicesExistsTemplateRequest.md create mode 100644 docs/reference/api/IndicesExistsTemplateResponse.md create mode 100644 docs/reference/api/IndicesExplainDataLifecycleDataStreamLifecycleExplain.md create mode 100644 docs/reference/api/IndicesExplainDataLifecycleRequest.md create mode 100644 docs/reference/api/IndicesExplainDataLifecycleResponse.md create mode 100644 docs/reference/api/IndicesFailureStore.md create mode 100644 docs/reference/api/IndicesFieldUsageStatsFieldSummary.md create mode 100644 docs/reference/api/IndicesFieldUsageStatsFieldsUsageBody.md create mode 100644 docs/reference/api/IndicesFieldUsageStatsFieldsUsageBodyKeys.md create mode 100644 docs/reference/api/IndicesFieldUsageStatsInvertedIndex.md create mode 100644 docs/reference/api/IndicesFieldUsageStatsRequest.md create mode 100644 docs/reference/api/IndicesFieldUsageStatsResponse.md create mode 100644 docs/reference/api/IndicesFieldUsageStatsShardsStats.md create mode 100644 docs/reference/api/IndicesFieldUsageStatsUsageStatsIndex.md create mode 100644 docs/reference/api/IndicesFieldUsageStatsUsageStatsShards.md create mode 100644 docs/reference/api/IndicesFielddataFrequencyFilter.md create mode 100644 docs/reference/api/IndicesFlushRequest.md create mode 100644 docs/reference/api/IndicesFlushResponse.md create mode 100644 docs/reference/api/IndicesForcemergeForceMergeResponseBody.md create mode 100644 docs/reference/api/IndicesForcemergeRequest.md create mode 100644 docs/reference/api/IndicesForcemergeResponse.md create mode 100644 docs/reference/api/IndicesGetAliasIndexAliases.md create mode 100644 docs/reference/api/IndicesGetAliasRequest.md create mode 100644 docs/reference/api/IndicesGetAliasResponse.md create mode 100644 docs/reference/api/IndicesGetDataLifecycleDataStreamWithLifecycle.md create mode 100644 docs/reference/api/IndicesGetDataLifecycleRequest.md create mode 100644 docs/reference/api/IndicesGetDataLifecycleResponse.md create mode 100644 docs/reference/api/IndicesGetDataLifecycleStatsDataStreamStats.md create mode 100644 docs/reference/api/IndicesGetDataLifecycleStatsRequest.md create mode 100644 docs/reference/api/IndicesGetDataLifecycleStatsResponse.md create mode 100644 docs/reference/api/IndicesGetDataStreamRequest.md create mode 100644 docs/reference/api/IndicesGetDataStreamResponse.md create mode 100644 docs/reference/api/IndicesGetFeature.md create mode 100644 docs/reference/api/IndicesGetFeatures.md create mode 100644 docs/reference/api/IndicesGetFieldMappingRequest.md create mode 100644 docs/reference/api/IndicesGetFieldMappingResponse.md create mode 100644 docs/reference/api/IndicesGetFieldMappingTypeFieldMappings.md create mode 100644 docs/reference/api/IndicesGetIndexTemplateIndexTemplateItem.md create mode 100644 docs/reference/api/IndicesGetIndexTemplateRequest.md create mode 100644 docs/reference/api/IndicesGetIndexTemplateResponse.md create mode 100644 docs/reference/api/IndicesGetMappingIndexMappingRecord.md create mode 100644 docs/reference/api/IndicesGetMappingRequest.md create mode 100644 docs/reference/api/IndicesGetMappingResponse.md create mode 100644 docs/reference/api/IndicesGetMigrateReindexStatusRequest.md create mode 100644 docs/reference/api/IndicesGetMigrateReindexStatusResponse.md create mode 100644 docs/reference/api/IndicesGetMigrateReindexStatusStatusError.md create mode 100644 docs/reference/api/IndicesGetMigrateReindexStatusStatusInProgress.md create mode 100644 docs/reference/api/IndicesGetRequest.md create mode 100644 docs/reference/api/IndicesGetResponse.md create mode 100644 docs/reference/api/IndicesGetSettingsRequest.md create mode 100644 docs/reference/api/IndicesGetSettingsResponse.md create mode 100644 docs/reference/api/IndicesGetTemplateRequest.md create mode 100644 docs/reference/api/IndicesGetTemplateResponse.md create mode 100644 docs/reference/api/IndicesIndexCheckOnStartup.md create mode 100644 docs/reference/api/IndicesIndexMode.md create mode 100644 docs/reference/api/IndicesIndexRouting.md create mode 100644 docs/reference/api/IndicesIndexRoutingAllocation.md create mode 100644 docs/reference/api/IndicesIndexRoutingAllocationDisk.md create mode 100644 docs/reference/api/IndicesIndexRoutingAllocationInclude.md create mode 100644 docs/reference/api/IndicesIndexRoutingAllocationInitialRecovery.md create mode 100644 docs/reference/api/IndicesIndexRoutingAllocationOptions.md create mode 100644 docs/reference/api/IndicesIndexRoutingRebalance.md create mode 100644 docs/reference/api/IndicesIndexRoutingRebalanceOptions.md create mode 100644 docs/reference/api/IndicesIndexSegmentSort.md create mode 100644 docs/reference/api/IndicesIndexSettingBlocks.md create mode 100644 docs/reference/api/IndicesIndexSettings.md create mode 100644 docs/reference/api/IndicesIndexSettingsAnalysis.md create mode 100644 docs/reference/api/IndicesIndexSettingsKeys.md create mode 100644 docs/reference/api/IndicesIndexSettingsLifecycle.md create mode 100644 docs/reference/api/IndicesIndexSettingsLifecycleStep.md create mode 100644 docs/reference/api/IndicesIndexSettingsTimeSeries.md create mode 100644 docs/reference/api/IndicesIndexState.md create mode 100644 docs/reference/api/IndicesIndexTemplate.md create mode 100644 docs/reference/api/IndicesIndexTemplateDataStreamConfiguration.md create mode 100644 docs/reference/api/IndicesIndexTemplateSummary.md create mode 100644 docs/reference/api/IndicesIndexVersioning.md create mode 100644 docs/reference/api/IndicesIndexingPressure.md create mode 100644 docs/reference/api/IndicesIndexingPressureMemory.md create mode 100644 docs/reference/api/IndicesIndexingSlowlogSettings.md create mode 100644 docs/reference/api/IndicesIndexingSlowlogTresholds.md create mode 100644 docs/reference/api/IndicesManagedBy.md create mode 100644 docs/reference/api/IndicesMappingLimitSettings.md create mode 100644 docs/reference/api/IndicesMappingLimitSettingsDepth.md create mode 100644 docs/reference/api/IndicesMappingLimitSettingsDimensionFields.md create mode 100644 docs/reference/api/IndicesMappingLimitSettingsFieldNameLength.md create mode 100644 docs/reference/api/IndicesMappingLimitSettingsNestedFields.md create mode 100644 docs/reference/api/IndicesMappingLimitSettingsNestedObjects.md create mode 100644 docs/reference/api/IndicesMappingLimitSettingsSourceFields.md create mode 100644 docs/reference/api/IndicesMappingLimitSettingsTotalFields.md create mode 100644 docs/reference/api/IndicesMerge.md create mode 100644 docs/reference/api/IndicesMergeScheduler.md create mode 100644 docs/reference/api/IndicesMigrateReindexMigrateReindex.md create mode 100644 docs/reference/api/IndicesMigrateReindexModeEnum.md create mode 100644 docs/reference/api/IndicesMigrateReindexRequest.md create mode 100644 docs/reference/api/IndicesMigrateReindexResponse.md create mode 100644 docs/reference/api/IndicesMigrateReindexSourceIndex.md create mode 100644 docs/reference/api/IndicesMigrateToDataStreamRequest.md create mode 100644 docs/reference/api/IndicesMigrateToDataStreamResponse.md create mode 100644 docs/reference/api/IndicesModifyDataStreamAction.md create mode 100644 docs/reference/api/IndicesModifyDataStreamIndexAndDataStreamAction.md create mode 100644 docs/reference/api/IndicesModifyDataStreamRequest.md create mode 100644 docs/reference/api/IndicesModifyDataStreamResponse.md create mode 100644 docs/reference/api/IndicesNumericFielddata.md create mode 100644 docs/reference/api/IndicesNumericFielddataFormat.md create mode 100644 docs/reference/api/IndicesOpenRequest.md create mode 100644 docs/reference/api/IndicesOpenResponse.md create mode 100644 docs/reference/api/IndicesOptions.md create mode 100644 docs/reference/api/IndicesPromoteDataStreamRequest.md create mode 100644 docs/reference/api/IndicesPromoteDataStreamResponse.md create mode 100644 docs/reference/api/IndicesPutAliasRequest.md create mode 100644 docs/reference/api/IndicesPutAliasResponse.md create mode 100644 docs/reference/api/IndicesPutDataLifecycleRequest.md create mode 100644 docs/reference/api/IndicesPutDataLifecycleResponse.md create mode 100644 docs/reference/api/IndicesPutIndexTemplateIndexTemplateMapping.md create mode 100644 docs/reference/api/IndicesPutIndexTemplateRequest.md create mode 100644 docs/reference/api/IndicesPutIndexTemplateResponse.md create mode 100644 docs/reference/api/IndicesPutMappingRequest.md create mode 100644 docs/reference/api/IndicesPutMappingResponse.md create mode 100644 docs/reference/api/IndicesPutSettingsRequest.md create mode 100644 docs/reference/api/IndicesPutSettingsResponse.md create mode 100644 docs/reference/api/IndicesPutTemplateRequest.md create mode 100644 docs/reference/api/IndicesPutTemplateResponse.md create mode 100644 docs/reference/api/IndicesQueries.md create mode 100644 docs/reference/api/IndicesRecoveryFileDetails.md create mode 100644 docs/reference/api/IndicesRecoveryRecoveryBytes.md create mode 100644 docs/reference/api/IndicesRecoveryRecoveryFiles.md create mode 100644 docs/reference/api/IndicesRecoveryRecoveryIndexStatus.md create mode 100644 docs/reference/api/IndicesRecoveryRecoveryOrigin.md create mode 100644 docs/reference/api/IndicesRecoveryRecoveryStartStatus.md create mode 100644 docs/reference/api/IndicesRecoveryRecoveryStatus.md create mode 100644 docs/reference/api/IndicesRecoveryRequest.md create mode 100644 docs/reference/api/IndicesRecoveryResponse.md create mode 100644 docs/reference/api/IndicesRecoveryShardRecovery.md create mode 100644 docs/reference/api/IndicesRecoveryTranslogStatus.md create mode 100644 docs/reference/api/IndicesRecoveryVerifyIndex.md create mode 100644 docs/reference/api/IndicesRefreshRequest.md create mode 100644 docs/reference/api/IndicesRefreshResponse.md create mode 100644 docs/reference/api/IndicesReloadSearchAnalyzersReloadDetails.md create mode 100644 docs/reference/api/IndicesReloadSearchAnalyzersReloadResult.md create mode 100644 docs/reference/api/IndicesReloadSearchAnalyzersRequest.md create mode 100644 docs/reference/api/IndicesReloadSearchAnalyzersResponse.md create mode 100644 docs/reference/api/IndicesResolveClusterRequest.md create mode 100644 docs/reference/api/IndicesResolveClusterResolveClusterInfo.md create mode 100644 docs/reference/api/IndicesResolveClusterResponse.md create mode 100644 docs/reference/api/IndicesResolveIndexRequest.md create mode 100644 docs/reference/api/IndicesResolveIndexResolveIndexAliasItem.md create mode 100644 docs/reference/api/IndicesResolveIndexResolveIndexDataStreamsItem.md create mode 100644 docs/reference/api/IndicesResolveIndexResolveIndexItem.md create mode 100644 docs/reference/api/IndicesResolveIndexResponse.md create mode 100644 docs/reference/api/IndicesResponseBase.md create mode 100644 docs/reference/api/IndicesRetentionLease.md create mode 100644 docs/reference/api/IndicesRolloverRequest.md create mode 100644 docs/reference/api/IndicesRolloverResponse.md create mode 100644 docs/reference/api/IndicesRolloverRolloverConditions.md create mode 100644 docs/reference/api/IndicesSearchIdle.md create mode 100644 docs/reference/api/IndicesSegmentSortMissing.md create mode 100644 docs/reference/api/IndicesSegmentSortMode.md create mode 100644 docs/reference/api/IndicesSegmentSortOrder.md create mode 100644 docs/reference/api/IndicesSegmentsIndexSegment.md create mode 100644 docs/reference/api/IndicesSegmentsRequest.md create mode 100644 docs/reference/api/IndicesSegmentsResponse.md create mode 100644 docs/reference/api/IndicesSegmentsSegment.md create mode 100644 docs/reference/api/IndicesSegmentsShardSegmentRouting.md create mode 100644 docs/reference/api/IndicesSegmentsShardsSegment.md create mode 100644 docs/reference/api/IndicesSettingsAnalyze.md create mode 100644 docs/reference/api/IndicesSettingsHighlight.md create mode 100644 docs/reference/api/IndicesSettingsQueryString.md create mode 100644 docs/reference/api/IndicesSettingsSearch.md create mode 100644 docs/reference/api/IndicesSettingsSimilarity.md create mode 100644 docs/reference/api/IndicesSettingsSimilarityBm25.md create mode 100644 docs/reference/api/IndicesSettingsSimilarityBoolean.md create mode 100644 docs/reference/api/IndicesSettingsSimilarityDfi.md create mode 100644 docs/reference/api/IndicesSettingsSimilarityDfr.md create mode 100644 docs/reference/api/IndicesSettingsSimilarityIb.md create mode 100644 docs/reference/api/IndicesSettingsSimilarityLmd.md create mode 100644 docs/reference/api/IndicesSettingsSimilarityLmj.md create mode 100644 docs/reference/api/IndicesSettingsSimilarityScripted.md create mode 100644 docs/reference/api/IndicesShardStoresIndicesShardStores.md create mode 100644 docs/reference/api/IndicesShardStoresRequest.md create mode 100644 docs/reference/api/IndicesShardStoresResponse.md create mode 100644 docs/reference/api/IndicesShardStoresShardStore.md create mode 100644 docs/reference/api/IndicesShardStoresShardStoreAllocation.md create mode 100644 docs/reference/api/IndicesShardStoresShardStoreException.md create mode 100644 docs/reference/api/IndicesShardStoresShardStoreKeys.md create mode 100644 docs/reference/api/IndicesShardStoresShardStoreNode.md create mode 100644 docs/reference/api/IndicesShardStoresShardStoreStatus.md create mode 100644 docs/reference/api/IndicesShardStoresShardStoreWrapper.md create mode 100644 docs/reference/api/IndicesShrinkRequest.md create mode 100644 docs/reference/api/IndicesShrinkResponse.md create mode 100644 docs/reference/api/IndicesSimulateIndexTemplateRequest.md create mode 100644 docs/reference/api/IndicesSimulateIndexTemplateResponse.md create mode 100644 docs/reference/api/IndicesSimulateTemplateOverlapping.md create mode 100644 docs/reference/api/IndicesSimulateTemplateRequest.md create mode 100644 docs/reference/api/IndicesSimulateTemplateResponse.md create mode 100644 docs/reference/api/IndicesSimulateTemplateTemplate.md create mode 100644 docs/reference/api/IndicesSlowlogSettings.md create mode 100644 docs/reference/api/IndicesSlowlogTresholdLevels.md create mode 100644 docs/reference/api/IndicesSlowlogTresholds.md create mode 100644 docs/reference/api/IndicesSoftDeletes.md create mode 100644 docs/reference/api/IndicesSourceMode.md create mode 100644 docs/reference/api/IndicesSplitRequest.md create mode 100644 docs/reference/api/IndicesSplitResponse.md create mode 100644 docs/reference/api/IndicesStatsIndexMetadataState.md create mode 100644 docs/reference/api/IndicesStatsIndexStats.md create mode 100644 docs/reference/api/IndicesStatsIndicesStats.md create mode 100644 docs/reference/api/IndicesStatsMappingStats.md create mode 100644 docs/reference/api/IndicesStatsRequest.md create mode 100644 docs/reference/api/IndicesStatsResponse.md create mode 100644 docs/reference/api/IndicesStatsShardCommit.md create mode 100644 docs/reference/api/IndicesStatsShardFileSizeInfo.md create mode 100644 docs/reference/api/IndicesStatsShardLease.md create mode 100644 docs/reference/api/IndicesStatsShardPath.md create mode 100644 docs/reference/api/IndicesStatsShardQueryCache.md create mode 100644 docs/reference/api/IndicesStatsShardRetentionLeases.md create mode 100644 docs/reference/api/IndicesStatsShardRouting.md create mode 100644 docs/reference/api/IndicesStatsShardRoutingState.md create mode 100644 docs/reference/api/IndicesStatsShardSequenceNumber.md create mode 100644 docs/reference/api/IndicesStatsShardStats.md create mode 100644 docs/reference/api/IndicesStatsShardsTotalStats.md create mode 100644 docs/reference/api/IndicesStorage.md create mode 100644 docs/reference/api/IndicesStorageType.md create mode 100644 docs/reference/api/IndicesTemplateMapping.md create mode 100644 docs/reference/api/IndicesTranslog.md create mode 100644 docs/reference/api/IndicesTranslogDurability.md create mode 100644 docs/reference/api/IndicesTranslogRetention.md create mode 100644 docs/reference/api/IndicesUpdateAliasesAction.md create mode 100644 docs/reference/api/IndicesUpdateAliasesAddAction.md create mode 100644 docs/reference/api/IndicesUpdateAliasesRemoveAction.md create mode 100644 docs/reference/api/IndicesUpdateAliasesRemoveIndexAction.md create mode 100644 docs/reference/api/IndicesUpdateAliasesRequest.md create mode 100644 docs/reference/api/IndicesUpdateAliasesResponse.md create mode 100644 docs/reference/api/IndicesValidateQueryIndicesValidationExplanation.md create mode 100644 docs/reference/api/IndicesValidateQueryRequest.md create mode 100644 docs/reference/api/IndicesValidateQueryResponse.md create mode 100644 docs/reference/api/Inference.md create mode 100644 docs/reference/api/InferenceAdaptiveAllocations.md create mode 100644 docs/reference/api/InferenceAlibabaCloudServiceSettings.md create mode 100644 docs/reference/api/InferenceAlibabaCloudServiceType.md create mode 100644 docs/reference/api/InferenceAlibabaCloudTaskSettings.md create mode 100644 docs/reference/api/InferenceAlibabaCloudTaskType.md create mode 100644 docs/reference/api/InferenceAmazonBedrockServiceSettings.md create mode 100644 docs/reference/api/InferenceAmazonBedrockServiceType.md create mode 100644 docs/reference/api/InferenceAmazonBedrockTaskSettings.md create mode 100644 docs/reference/api/InferenceAmazonBedrockTaskType.md create mode 100644 docs/reference/api/InferenceAnthropicServiceSettings.md create mode 100644 docs/reference/api/InferenceAnthropicServiceType.md create mode 100644 docs/reference/api/InferenceAnthropicTaskSettings.md create mode 100644 docs/reference/api/InferenceAnthropicTaskType.md create mode 100644 docs/reference/api/InferenceAzureAiStudioServiceSettings.md create mode 100644 docs/reference/api/InferenceAzureAiStudioServiceType.md create mode 100644 docs/reference/api/InferenceAzureAiStudioTaskSettings.md create mode 100644 docs/reference/api/InferenceAzureAiStudioTaskType.md create mode 100644 docs/reference/api/InferenceAzureOpenAIServiceSettings.md create mode 100644 docs/reference/api/InferenceAzureOpenAIServiceType.md create mode 100644 docs/reference/api/InferenceAzureOpenAITaskSettings.md create mode 100644 docs/reference/api/InferenceAzureOpenAITaskType.md create mode 100644 docs/reference/api/InferenceChatCompletionUnifiedRequest.md create mode 100644 docs/reference/api/InferenceChatCompletionUnifiedResponse.md create mode 100644 docs/reference/api/InferenceCohereEmbeddingType.md create mode 100644 docs/reference/api/InferenceCohereInputType.md create mode 100644 docs/reference/api/InferenceCohereServiceSettings.md create mode 100644 docs/reference/api/InferenceCohereServiceType.md create mode 100644 docs/reference/api/InferenceCohereSimilarityType.md create mode 100644 docs/reference/api/InferenceCohereTaskSettings.md create mode 100644 docs/reference/api/InferenceCohereTaskType.md create mode 100644 docs/reference/api/InferenceCohereTruncateType.md create mode 100644 docs/reference/api/InferenceCompletionInferenceResult.md create mode 100644 docs/reference/api/InferenceCompletionRequest.md create mode 100644 docs/reference/api/InferenceCompletionResponse.md create mode 100644 docs/reference/api/InferenceCompletionResult.md create mode 100644 docs/reference/api/InferenceCompletionTool.md create mode 100644 docs/reference/api/InferenceCompletionToolChoice.md create mode 100644 docs/reference/api/InferenceCompletionToolChoiceFunction.md create mode 100644 docs/reference/api/InferenceCompletionToolFunction.md create mode 100644 docs/reference/api/InferenceCompletionToolType.md create mode 100644 docs/reference/api/InferenceContentObject.md create mode 100644 docs/reference/api/InferenceDeleteInferenceEndpointResult.md create mode 100644 docs/reference/api/InferenceDeleteRequest.md create mode 100644 docs/reference/api/InferenceDeleteResponse.md create mode 100644 docs/reference/api/InferenceDenseByteVector.md create mode 100644 docs/reference/api/InferenceDenseVector.md create mode 100644 docs/reference/api/InferenceElasticsearchServiceSettings.md create mode 100644 docs/reference/api/InferenceElasticsearchServiceType.md create mode 100644 docs/reference/api/InferenceElasticsearchTaskSettings.md create mode 100644 docs/reference/api/InferenceElasticsearchTaskType.md create mode 100644 docs/reference/api/InferenceElserServiceSettings.md create mode 100644 docs/reference/api/InferenceElserServiceType.md create mode 100644 docs/reference/api/InferenceElserTaskType.md create mode 100644 docs/reference/api/InferenceGetRequest.md create mode 100644 docs/reference/api/InferenceGetResponse.md create mode 100644 docs/reference/api/InferenceGoogleAiServiceType.md create mode 100644 docs/reference/api/InferenceGoogleAiStudioServiceSettings.md create mode 100644 docs/reference/api/InferenceGoogleAiStudioTaskType.md create mode 100644 docs/reference/api/InferenceGoogleVertexAIServiceSettings.md create mode 100644 docs/reference/api/InferenceGoogleVertexAIServiceType.md create mode 100644 docs/reference/api/InferenceGoogleVertexAITaskSettings.md create mode 100644 docs/reference/api/InferenceGoogleVertexAITaskType.md create mode 100644 docs/reference/api/InferenceHuggingFaceServiceSettings.md create mode 100644 docs/reference/api/InferenceHuggingFaceServiceType.md create mode 100644 docs/reference/api/InferenceHuggingFaceTaskType.md create mode 100644 docs/reference/api/InferenceInferenceChunkingSettings.md create mode 100644 docs/reference/api/InferenceInferenceEndpoint.md create mode 100644 docs/reference/api/InferenceInferenceEndpointInfo.md create mode 100644 docs/reference/api/InferenceInferenceRequest.md create mode 100644 docs/reference/api/InferenceInferenceResponse.md create mode 100644 docs/reference/api/InferenceInferenceResult.md create mode 100644 docs/reference/api/InferenceJinaAIServiceSettings.md create mode 100644 docs/reference/api/InferenceJinaAIServiceType.md create mode 100644 docs/reference/api/InferenceJinaAISimilarityType.md create mode 100644 docs/reference/api/InferenceJinaAITaskSettings.md create mode 100644 docs/reference/api/InferenceJinaAITaskType.md create mode 100644 docs/reference/api/InferenceJinaAITextEmbeddingTask.md create mode 100644 docs/reference/api/InferenceMessage.md create mode 100644 docs/reference/api/InferenceMessageContent.md create mode 100644 docs/reference/api/InferenceMistralServiceSettings.md create mode 100644 docs/reference/api/InferenceMistralServiceType.md create mode 100644 docs/reference/api/InferenceMistralTaskType.md create mode 100644 docs/reference/api/InferenceOpenAIServiceSettings.md create mode 100644 docs/reference/api/InferenceOpenAIServiceType.md create mode 100644 docs/reference/api/InferenceOpenAITaskSettings.md create mode 100644 docs/reference/api/InferenceOpenAITaskType.md create mode 100644 docs/reference/api/InferencePutAlibabacloudRequest.md create mode 100644 docs/reference/api/InferencePutAlibabacloudResponse.md create mode 100644 docs/reference/api/InferencePutAmazonbedrockRequest.md create mode 100644 docs/reference/api/InferencePutAmazonbedrockResponse.md create mode 100644 docs/reference/api/InferencePutAnthropicRequest.md create mode 100644 docs/reference/api/InferencePutAnthropicResponse.md create mode 100644 docs/reference/api/InferencePutAzureaistudioRequest.md create mode 100644 docs/reference/api/InferencePutAzureaistudioResponse.md create mode 100644 docs/reference/api/InferencePutAzureopenaiRequest.md create mode 100644 docs/reference/api/InferencePutAzureopenaiResponse.md create mode 100644 docs/reference/api/InferencePutCohereRequest.md create mode 100644 docs/reference/api/InferencePutCohereResponse.md create mode 100644 docs/reference/api/InferencePutElasticsearchRequest.md create mode 100644 docs/reference/api/InferencePutElasticsearchResponse.md create mode 100644 docs/reference/api/InferencePutElserRequest.md create mode 100644 docs/reference/api/InferencePutElserResponse.md create mode 100644 docs/reference/api/InferencePutGoogleaistudioRequest.md create mode 100644 docs/reference/api/InferencePutGoogleaistudioResponse.md create mode 100644 docs/reference/api/InferencePutGooglevertexaiRequest.md create mode 100644 docs/reference/api/InferencePutGooglevertexaiResponse.md create mode 100644 docs/reference/api/InferencePutHuggingFaceRequest.md create mode 100644 docs/reference/api/InferencePutHuggingFaceResponse.md create mode 100644 docs/reference/api/InferencePutJinaaiRequest.md create mode 100644 docs/reference/api/InferencePutJinaaiResponse.md create mode 100644 docs/reference/api/InferencePutMistralRequest.md create mode 100644 docs/reference/api/InferencePutMistralResponse.md create mode 100644 docs/reference/api/InferencePutOpenaiRequest.md create mode 100644 docs/reference/api/InferencePutOpenaiResponse.md create mode 100644 docs/reference/api/InferencePutRequest.md create mode 100644 docs/reference/api/InferencePutResponse.md create mode 100644 docs/reference/api/InferencePutVoyageaiRequest.md create mode 100644 docs/reference/api/InferencePutVoyageaiResponse.md create mode 100644 docs/reference/api/InferencePutWatsonxRequest.md create mode 100644 docs/reference/api/InferencePutWatsonxResponse.md create mode 100644 docs/reference/api/InferenceRankedDocument.md create mode 100644 docs/reference/api/InferenceRateLimitSetting.md create mode 100644 docs/reference/api/InferenceRequestChatCompletion.md create mode 100644 docs/reference/api/InferenceRerankRequest.md create mode 100644 docs/reference/api/InferenceRerankResponse.md create mode 100644 docs/reference/api/InferenceRerankedInferenceResult.md create mode 100644 docs/reference/api/InferenceServiceSettings.md create mode 100644 docs/reference/api/InferenceSparseEmbeddingInferenceResult.md create mode 100644 docs/reference/api/InferenceSparseEmbeddingRequest.md create mode 100644 docs/reference/api/InferenceSparseEmbeddingResponse.md create mode 100644 docs/reference/api/InferenceSparseEmbeddingResult.md create mode 100644 docs/reference/api/InferenceSparseVector.md create mode 100644 docs/reference/api/InferenceStreamCompletionRequest.md create mode 100644 docs/reference/api/InferenceStreamCompletionResponse.md create mode 100644 docs/reference/api/InferenceTaskSettings.md create mode 100644 docs/reference/api/InferenceTaskType.md create mode 100644 docs/reference/api/InferenceTextEmbeddingByteResult.md create mode 100644 docs/reference/api/InferenceTextEmbeddingInferenceResult.md create mode 100644 docs/reference/api/InferenceTextEmbeddingRequest.md create mode 100644 docs/reference/api/InferenceTextEmbeddingResponse.md create mode 100644 docs/reference/api/InferenceTextEmbeddingResult.md create mode 100644 docs/reference/api/InferenceToolCall.md create mode 100644 docs/reference/api/InferenceToolCallFunction.md create mode 100644 docs/reference/api/InferenceUpdateRequest.md create mode 100644 docs/reference/api/InferenceUpdateResponse.md create mode 100644 docs/reference/api/InferenceVoyageAIServiceSettings.md create mode 100644 docs/reference/api/InferenceVoyageAIServiceType.md create mode 100644 docs/reference/api/InferenceVoyageAITaskSettings.md create mode 100644 docs/reference/api/InferenceVoyageAITaskType.md create mode 100644 docs/reference/api/InferenceWatsonxServiceSettings.md create mode 100644 docs/reference/api/InferenceWatsonxServiceType.md create mode 100644 docs/reference/api/InferenceWatsonxTaskType.md create mode 100644 docs/reference/api/InfoApi_1.md create mode 100644 docs/reference/api/InfoApi_2.md create mode 100644 docs/reference/api/InfoApi_3.md create mode 100644 docs/reference/api/InfoRequest.md create mode 100644 docs/reference/api/InfoResponse.md create mode 100644 docs/reference/api/Ingest.md create mode 100644 docs/reference/api/IngestAppendProcessor.md create mode 100644 docs/reference/api/IngestAttachmentProcessor.md create mode 100644 docs/reference/api/IngestBytesProcessor.md create mode 100644 docs/reference/api/IngestCircleProcessor.md create mode 100644 docs/reference/api/IngestCommunityIDProcessor.md create mode 100644 docs/reference/api/IngestConvertProcessor.md create mode 100644 docs/reference/api/IngestConvertType.md create mode 100644 docs/reference/api/IngestCsvProcessor.md create mode 100644 docs/reference/api/IngestDatabaseConfiguration.md create mode 100644 docs/reference/api/IngestDatabaseConfigurationFull.md create mode 100644 docs/reference/api/IngestDateIndexNameProcessor.md create mode 100644 docs/reference/api/IngestDateProcessor.md create mode 100644 docs/reference/api/IngestDeleteGeoipDatabaseRequest.md create mode 100644 docs/reference/api/IngestDeleteGeoipDatabaseResponse.md create mode 100644 docs/reference/api/IngestDeleteIpLocationDatabaseRequest.md create mode 100644 docs/reference/api/IngestDeleteIpLocationDatabaseResponse.md create mode 100644 docs/reference/api/IngestDeletePipelineRequest.md create mode 100644 docs/reference/api/IngestDeletePipelineResponse.md create mode 100644 docs/reference/api/IngestDissectProcessor.md create mode 100644 docs/reference/api/IngestDocument.md create mode 100644 docs/reference/api/IngestDocumentSimulation.md create mode 100644 docs/reference/api/IngestDocumentSimulationKeys.md create mode 100644 docs/reference/api/IngestDotExpanderProcessor.md create mode 100644 docs/reference/api/IngestDropProcessor.md create mode 100644 docs/reference/api/IngestEnrichProcessor.md create mode 100644 docs/reference/api/IngestFailProcessor.md create mode 100644 docs/reference/api/IngestFingerprintDigest.md create mode 100644 docs/reference/api/IngestFingerprintProcessor.md create mode 100644 docs/reference/api/IngestForeachProcessor.md create mode 100644 docs/reference/api/IngestGeoGridProcessor.md create mode 100644 docs/reference/api/IngestGeoGridTargetFormat.md create mode 100644 docs/reference/api/IngestGeoGridTileType.md create mode 100644 docs/reference/api/IngestGeoIpProcessor.md create mode 100644 docs/reference/api/IngestGeoIpStatsGeoIpDownloadStatistics.md create mode 100644 docs/reference/api/IngestGeoIpStatsGeoIpNodeDatabaseName.md create mode 100644 docs/reference/api/IngestGeoIpStatsGeoIpNodeDatabases.md create mode 100644 docs/reference/api/IngestGeoIpStatsRequest.md create mode 100644 docs/reference/api/IngestGeoIpStatsResponse.md create mode 100644 docs/reference/api/IngestGetGeoipDatabaseDatabaseConfigurationMetadata.md create mode 100644 docs/reference/api/IngestGetGeoipDatabaseRequest.md create mode 100644 docs/reference/api/IngestGetGeoipDatabaseResponse.md create mode 100644 docs/reference/api/IngestGetIpLocationDatabaseDatabaseConfigurationMetadata.md create mode 100644 docs/reference/api/IngestGetIpLocationDatabaseRequest.md create mode 100644 docs/reference/api/IngestGetIpLocationDatabaseResponse.md create mode 100644 docs/reference/api/IngestGetPipelineRequest.md create mode 100644 docs/reference/api/IngestGetPipelineResponse.md create mode 100644 docs/reference/api/IngestGrokProcessor.md create mode 100644 docs/reference/api/IngestGsubProcessor.md create mode 100644 docs/reference/api/IngestHtmlStripProcessor.md create mode 100644 docs/reference/api/IngestInferenceConfig.md create mode 100644 docs/reference/api/IngestInferenceConfigClassification.md create mode 100644 docs/reference/api/IngestInferenceConfigRegression.md create mode 100644 docs/reference/api/IngestInferenceProcessor.md create mode 100644 docs/reference/api/IngestIngest.md create mode 100644 docs/reference/api/IngestInputConfig.md create mode 100644 docs/reference/api/IngestIpLocationProcessor.md create mode 100644 docs/reference/api/IngestIpinfo.md create mode 100644 docs/reference/api/IngestJoinProcessor.md create mode 100644 docs/reference/api/IngestJsonProcessor.md create mode 100644 docs/reference/api/IngestJsonProcessorConflictStrategy.md create mode 100644 docs/reference/api/IngestKeyValueProcessor.md create mode 100644 docs/reference/api/IngestLocal.md create mode 100644 docs/reference/api/IngestLowercaseProcessor.md create mode 100644 docs/reference/api/IngestMaxmind.md create mode 100644 docs/reference/api/IngestNetworkDirectionProcessor.md create mode 100644 docs/reference/api/IngestPipeline.md create mode 100644 docs/reference/api/IngestPipelineConfig.md create mode 100644 docs/reference/api/IngestPipelineProcessor.md create mode 100644 docs/reference/api/IngestPipelineProcessorResult.md create mode 100644 docs/reference/api/IngestPipelineSimulationStatusOptions.md create mode 100644 docs/reference/api/IngestProcessorBase.md create mode 100644 docs/reference/api/IngestProcessorContainer.md create mode 100644 docs/reference/api/IngestProcessorGrokRequest.md create mode 100644 docs/reference/api/IngestProcessorGrokResponse.md create mode 100644 docs/reference/api/IngestPutGeoipDatabaseRequest.md create mode 100644 docs/reference/api/IngestPutGeoipDatabaseResponse.md create mode 100644 docs/reference/api/IngestPutIpLocationDatabaseRequest.md create mode 100644 docs/reference/api/IngestPutIpLocationDatabaseResponse.md create mode 100644 docs/reference/api/IngestPutPipelineRequest.md create mode 100644 docs/reference/api/IngestPutPipelineResponse.md create mode 100644 docs/reference/api/IngestRedact.md create mode 100644 docs/reference/api/IngestRedactProcessor.md create mode 100644 docs/reference/api/IngestRegisteredDomainProcessor.md create mode 100644 docs/reference/api/IngestRemoveProcessor.md create mode 100644 docs/reference/api/IngestRenameProcessor.md create mode 100644 docs/reference/api/IngestRerouteProcessor.md create mode 100644 docs/reference/api/IngestScriptProcessor.md create mode 100644 docs/reference/api/IngestSetProcessor.md create mode 100644 docs/reference/api/IngestSetSecurityUserProcessor.md create mode 100644 docs/reference/api/IngestShapeType.md create mode 100644 docs/reference/api/IngestSimulateDocumentResult.md create mode 100644 docs/reference/api/IngestSimulateRequest.md create mode 100644 docs/reference/api/IngestSimulateResponse.md create mode 100644 docs/reference/api/IngestSortProcessor.md create mode 100644 docs/reference/api/IngestSplitProcessor.md create mode 100644 docs/reference/api/IngestTerminateProcessor.md create mode 100644 docs/reference/api/IngestTrimProcessor.md create mode 100644 docs/reference/api/IngestUppercaseProcessor.md create mode 100644 docs/reference/api/IngestUriPartsProcessor.md create mode 100644 docs/reference/api/IngestUrlDecodeProcessor.md create mode 100644 docs/reference/api/IngestUserAgentProcessor.md create mode 100644 docs/reference/api/IngestUserAgentProperty.md create mode 100644 docs/reference/api/IngestWeb.md create mode 100644 docs/reference/api/InlineGet.md create mode 100644 docs/reference/api/InlineGetKeys.md create mode 100644 docs/reference/api/Ip.md create mode 100644 docs/reference/api/KnnQuery.md create mode 100644 docs/reference/api/KnnRetriever.md create mode 100644 docs/reference/api/KnnSearch.md create mode 100644 docs/reference/api/KnnSearchApi_1.md create mode 100644 docs/reference/api/KnnSearchApi_2.md create mode 100644 docs/reference/api/KnnSearchApi_3.md create mode 100644 docs/reference/api/LatLonGeoLocation.md create mode 100644 docs/reference/api/Level.md create mode 100644 docs/reference/api/License.md create mode 100644 docs/reference/api/LicenseDeleteRequest.md create mode 100644 docs/reference/api/LicenseDeleteResponse.md create mode 100644 docs/reference/api/LicenseGetBasicStatusRequest.md create mode 100644 docs/reference/api/LicenseGetBasicStatusResponse.md create mode 100644 docs/reference/api/LicenseGetLicenseInformation.md create mode 100644 docs/reference/api/LicenseGetRequest.md create mode 100644 docs/reference/api/LicenseGetResponse.md create mode 100644 docs/reference/api/LicenseGetTrialStatusRequest.md create mode 100644 docs/reference/api/LicenseGetTrialStatusResponse.md create mode 100644 docs/reference/api/LicenseLicense.md create mode 100644 docs/reference/api/LicenseLicenseStatus.md create mode 100644 docs/reference/api/LicenseLicenseType.md create mode 100644 docs/reference/api/LicensePostAcknowledgement.md create mode 100644 docs/reference/api/LicensePostRequest.md create mode 100644 docs/reference/api/LicensePostResponse.md create mode 100644 docs/reference/api/LicensePostStartBasicRequest.md create mode 100644 docs/reference/api/LicensePostStartBasicResponse.md create mode 100644 docs/reference/api/LicensePostStartTrialRequest.md create mode 100644 docs/reference/api/LicensePostStartTrialResponse.md create mode 100644 docs/reference/api/LifecycleOperationMode.md create mode 100644 docs/reference/api/Logstash.md create mode 100644 docs/reference/api/LogstashDeletePipelineRequest.md create mode 100644 docs/reference/api/LogstashDeletePipelineResponse.md create mode 100644 docs/reference/api/LogstashGetPipelineRequest.md create mode 100644 docs/reference/api/LogstashGetPipelineResponse.md create mode 100644 docs/reference/api/LogstashPipeline.md create mode 100644 docs/reference/api/LogstashPipelineMetadata.md create mode 100644 docs/reference/api/LogstashPipelineSettings.md create mode 100644 docs/reference/api/LogstashPutPipelineRequest.md create mode 100644 docs/reference/api/LogstashPutPipelineResponse.md create mode 100644 docs/reference/api/MapboxVectorTiles.md create mode 100644 docs/reference/api/MappingAggregateMetricDoubleProperty.md create mode 100644 docs/reference/api/MappingAllField.md create mode 100644 docs/reference/api/MappingBinaryProperty.md create mode 100644 docs/reference/api/MappingBooleanProperty.md create mode 100644 docs/reference/api/MappingByteNumberProperty.md create mode 100644 docs/reference/api/MappingChunkingSettings.md create mode 100644 docs/reference/api/MappingCompletionProperty.md create mode 100644 docs/reference/api/MappingCompositeSubField.md create mode 100644 docs/reference/api/MappingConstantKeywordProperty.md create mode 100644 docs/reference/api/MappingCorePropertyBase.md create mode 100644 docs/reference/api/MappingCountedKeywordProperty.md create mode 100644 docs/reference/api/MappingDataStreamTimestamp.md create mode 100644 docs/reference/api/MappingDateNanosProperty.md create mode 100644 docs/reference/api/MappingDateProperty.md create mode 100644 docs/reference/api/MappingDateRangeProperty.md create mode 100644 docs/reference/api/MappingDenseVectorElementType.md create mode 100644 docs/reference/api/MappingDenseVectorIndexOptions.md create mode 100644 docs/reference/api/MappingDenseVectorIndexOptionsRescoreVector.md create mode 100644 docs/reference/api/MappingDenseVectorIndexOptionsType.md create mode 100644 docs/reference/api/MappingDenseVectorProperty.md create mode 100644 docs/reference/api/MappingDenseVectorSimilarity.md create mode 100644 docs/reference/api/MappingDocValuesPropertyBase.md create mode 100644 docs/reference/api/MappingDoubleNumberProperty.md create mode 100644 docs/reference/api/MappingDoubleRangeProperty.md create mode 100644 docs/reference/api/MappingDynamicMapping.md create mode 100644 docs/reference/api/MappingDynamicProperty.md create mode 100644 docs/reference/api/MappingDynamicTemplate.md create mode 100644 docs/reference/api/MappingFieldAliasProperty.md create mode 100644 docs/reference/api/MappingFieldMapping.md create mode 100644 docs/reference/api/MappingFieldNamesField.md create mode 100644 docs/reference/api/MappingFieldType.md create mode 100644 docs/reference/api/MappingFlattenedProperty.md create mode 100644 docs/reference/api/MappingFloatNumberProperty.md create mode 100644 docs/reference/api/MappingFloatRangeProperty.md create mode 100644 docs/reference/api/MappingGeoOrientation.md create mode 100644 docs/reference/api/MappingGeoPointProperty.md create mode 100644 docs/reference/api/MappingGeoShapeProperty.md create mode 100644 docs/reference/api/MappingGeoStrategy.md create mode 100644 docs/reference/api/MappingHalfFloatNumberProperty.md create mode 100644 docs/reference/api/MappingHistogramProperty.md create mode 100644 docs/reference/api/MappingIcuCollationProperty.md create mode 100644 docs/reference/api/MappingIndexField.md create mode 100644 docs/reference/api/MappingIndexOptions.md create mode 100644 docs/reference/api/MappingIntegerNumberProperty.md create mode 100644 docs/reference/api/MappingIntegerRangeProperty.md create mode 100644 docs/reference/api/MappingIpProperty.md create mode 100644 docs/reference/api/MappingIpRangeProperty.md create mode 100644 docs/reference/api/MappingJoinProperty.md create mode 100644 docs/reference/api/MappingKeywordProperty.md create mode 100644 docs/reference/api/MappingLongNumberProperty.md create mode 100644 docs/reference/api/MappingLongRangeProperty.md create mode 100644 docs/reference/api/MappingMatchOnlyTextProperty.md create mode 100644 docs/reference/api/MappingMatchType.md create mode 100644 docs/reference/api/MappingMurmur3HashProperty.md create mode 100644 docs/reference/api/MappingNestedProperty.md create mode 100644 docs/reference/api/MappingNumberPropertyBase.md create mode 100644 docs/reference/api/MappingObjectProperty.md create mode 100644 docs/reference/api/MappingOnScriptError.md create mode 100644 docs/reference/api/MappingPassthroughObjectProperty.md create mode 100644 docs/reference/api/MappingPercolatorProperty.md create mode 100644 docs/reference/api/MappingPointProperty.md create mode 100644 docs/reference/api/MappingProperty.md create mode 100644 docs/reference/api/MappingPropertyBase.md create mode 100644 docs/reference/api/MappingRangePropertyBase.md create mode 100644 docs/reference/api/MappingRankFeatureProperty.md create mode 100644 docs/reference/api/MappingRankFeaturesProperty.md create mode 100644 docs/reference/api/MappingRoutingField.md create mode 100644 docs/reference/api/MappingRuntimeField.md create mode 100644 docs/reference/api/MappingRuntimeFieldFetchFields.md create mode 100644 docs/reference/api/MappingRuntimeFieldType.md create mode 100644 docs/reference/api/MappingRuntimeFields.md create mode 100644 docs/reference/api/MappingScaledFloatNumberProperty.md create mode 100644 docs/reference/api/MappingSearchAsYouTypeProperty.md create mode 100644 docs/reference/api/MappingSemanticTextProperty.md create mode 100644 docs/reference/api/MappingShapeProperty.md create mode 100644 docs/reference/api/MappingShortNumberProperty.md create mode 100644 docs/reference/api/MappingSizeField.md create mode 100644 docs/reference/api/MappingSourceField.md create mode 100644 docs/reference/api/MappingSourceFieldMode.md create mode 100644 docs/reference/api/MappingSparseVectorProperty.md create mode 100644 docs/reference/api/MappingSubobjects.md create mode 100644 docs/reference/api/MappingSuggestContext.md create mode 100644 docs/reference/api/MappingSyntheticSourceKeepEnum.md create mode 100644 docs/reference/api/MappingTermVectorOption.md create mode 100644 docs/reference/api/MappingTextIndexPrefixes.md create mode 100644 docs/reference/api/MappingTextProperty.md create mode 100644 docs/reference/api/MappingTimeSeriesMetricType.md create mode 100644 docs/reference/api/MappingTokenCountProperty.md create mode 100644 docs/reference/api/MappingTypeMapping.md create mode 100644 docs/reference/api/MappingUnsignedLongNumberProperty.md create mode 100644 docs/reference/api/MappingVersionProperty.md create mode 100644 docs/reference/api/MappingWildcardProperty.md create mode 100644 docs/reference/api/MergesStats.md create mode 100644 docs/reference/api/Metadata.md create mode 100644 docs/reference/api/Metrics.md create mode 100644 docs/reference/api/MgetApi_1.md create mode 100644 docs/reference/api/MgetApi_2.md create mode 100644 docs/reference/api/MgetApi_3.md create mode 100644 docs/reference/api/MgetMultiGetError.md create mode 100644 docs/reference/api/MgetOperation.md create mode 100644 docs/reference/api/MgetRequest.md create mode 100644 docs/reference/api/MgetResponse.md create mode 100644 docs/reference/api/MgetResponseItem.md create mode 100644 docs/reference/api/Migration.md create mode 100644 docs/reference/api/MigrationDeprecationsDeprecation.md create mode 100644 docs/reference/api/MigrationDeprecationsDeprecationLevel.md create mode 100644 docs/reference/api/MigrationDeprecationsRequest.md create mode 100644 docs/reference/api/MigrationDeprecationsResponse.md create mode 100644 docs/reference/api/MigrationGetFeatureUpgradeStatusMigrationFeature.md create mode 100644 docs/reference/api/MigrationGetFeatureUpgradeStatusMigrationFeatureIndexInfo.md create mode 100644 docs/reference/api/MigrationGetFeatureUpgradeStatusMigrationStatus.md create mode 100644 docs/reference/api/MigrationGetFeatureUpgradeStatusRequest.md create mode 100644 docs/reference/api/MigrationGetFeatureUpgradeStatusResponse.md create mode 100644 docs/reference/api/MigrationPostFeatureUpgradeMigrationFeature.md create mode 100644 docs/reference/api/MigrationPostFeatureUpgradeRequest.md create mode 100644 docs/reference/api/MigrationPostFeatureUpgradeResponse.md create mode 100644 docs/reference/api/MinimumShouldMatch.md create mode 100644 docs/reference/api/Ml.md create mode 100644 docs/reference/api/MlAdaptiveAllocationsSettings.md create mode 100644 docs/reference/api/MlAnalysisConfig.md create mode 100644 docs/reference/api/MlAnalysisConfigRead.md create mode 100644 docs/reference/api/MlAnalysisLimits.md create mode 100644 docs/reference/api/MlAnalysisMemoryLimit.md create mode 100644 docs/reference/api/MlAnomaly.md create mode 100644 docs/reference/api/MlAnomalyCause.md create mode 100644 docs/reference/api/MlAnomalyExplanation.md create mode 100644 docs/reference/api/MlApiKeyAuthorization.md create mode 100644 docs/reference/api/MlAppliesTo.md create mode 100644 docs/reference/api/MlBucketInfluencer.md create mode 100644 docs/reference/api/MlBucketSummary.md create mode 100644 docs/reference/api/MlCalendarEvent.md create mode 100644 docs/reference/api/MlCategorizationAnalyzer.md create mode 100644 docs/reference/api/MlCategorizationAnalyzerDefinition.md create mode 100644 docs/reference/api/MlCategorizationStatus.md create mode 100644 docs/reference/api/MlCategory.md create mode 100644 docs/reference/api/MlChunkingConfig.md create mode 100644 docs/reference/api/MlChunkingMode.md create mode 100644 docs/reference/api/MlClassificationInferenceOptions.md create mode 100644 docs/reference/api/MlClearTrainedModelDeploymentCacheRequest.md create mode 100644 docs/reference/api/MlClearTrainedModelDeploymentCacheResponse.md create mode 100644 docs/reference/api/MlCloseJobRequest.md create mode 100644 docs/reference/api/MlCloseJobResponse.md create mode 100644 docs/reference/api/MlCommonTokenizationConfig.md create mode 100644 docs/reference/api/MlConditionOperator.md create mode 100644 docs/reference/api/MlCustomSettings.md create mode 100644 docs/reference/api/MlDataCounts.md create mode 100644 docs/reference/api/MlDataDescription.md create mode 100644 docs/reference/api/MlDatafeed.md create mode 100644 docs/reference/api/MlDatafeedAuthorization.md create mode 100644 docs/reference/api/MlDatafeedConfig.md create mode 100644 docs/reference/api/MlDatafeedRunningState.md create mode 100644 docs/reference/api/MlDatafeedState.md create mode 100644 docs/reference/api/MlDatafeedStats.md create mode 100644 docs/reference/api/MlDatafeedTimingStats.md create mode 100644 docs/reference/api/MlDataframeAnalysis.md create mode 100644 docs/reference/api/MlDataframeAnalysisAnalyzedFields.md create mode 100644 docs/reference/api/MlDataframeAnalysisClassification.md create mode 100644 docs/reference/api/MlDataframeAnalysisContainer.md create mode 100644 docs/reference/api/MlDataframeAnalysisFeatureProcessor.md create mode 100644 docs/reference/api/MlDataframeAnalysisFeatureProcessorFrequencyEncoding.md create mode 100644 docs/reference/api/MlDataframeAnalysisFeatureProcessorMultiEncoding.md create mode 100644 docs/reference/api/MlDataframeAnalysisFeatureProcessorNGramEncoding.md create mode 100644 docs/reference/api/MlDataframeAnalysisFeatureProcessorOneHotEncoding.md create mode 100644 docs/reference/api/MlDataframeAnalysisFeatureProcessorTargetMeanEncoding.md create mode 100644 docs/reference/api/MlDataframeAnalysisOutlierDetection.md create mode 100644 docs/reference/api/MlDataframeAnalysisRegression.md create mode 100644 docs/reference/api/MlDataframeAnalytics.md create mode 100644 docs/reference/api/MlDataframeAnalyticsAuthorization.md create mode 100644 docs/reference/api/MlDataframeAnalyticsDestination.md create mode 100644 docs/reference/api/MlDataframeAnalyticsFieldSelection.md create mode 100644 docs/reference/api/MlDataframeAnalyticsMemoryEstimation.md create mode 100644 docs/reference/api/MlDataframeAnalyticsSource.md create mode 100644 docs/reference/api/MlDataframeAnalyticsStatsContainer.md create mode 100644 docs/reference/api/MlDataframeAnalyticsStatsDataCounts.md create mode 100644 docs/reference/api/MlDataframeAnalyticsStatsHyperparameters.md create mode 100644 docs/reference/api/MlDataframeAnalyticsStatsMemoryUsage.md create mode 100644 docs/reference/api/MlDataframeAnalyticsStatsOutlierDetection.md create mode 100644 docs/reference/api/MlDataframeAnalyticsStatsProgress.md create mode 100644 docs/reference/api/MlDataframeAnalyticsSummary.md create mode 100644 docs/reference/api/MlDataframeEvaluationClassification.md create mode 100644 docs/reference/api/MlDataframeEvaluationClassificationMetrics.md create mode 100644 docs/reference/api/MlDataframeEvaluationClassificationMetricsAucRoc.md create mode 100644 docs/reference/api/MlDataframeEvaluationContainer.md create mode 100644 docs/reference/api/MlDataframeEvaluationMetrics.md create mode 100644 docs/reference/api/MlDataframeEvaluationOutlierDetection.md create mode 100644 docs/reference/api/MlDataframeEvaluationOutlierDetectionMetrics.md create mode 100644 docs/reference/api/MlDataframeEvaluationRegression.md create mode 100644 docs/reference/api/MlDataframeEvaluationRegressionMetrics.md create mode 100644 docs/reference/api/MlDataframeEvaluationRegressionMetricsHuber.md create mode 100644 docs/reference/api/MlDataframeEvaluationRegressionMetricsMsle.md create mode 100644 docs/reference/api/MlDataframeState.md create mode 100644 docs/reference/api/MlDelayedDataCheckConfig.md create mode 100644 docs/reference/api/MlDeleteCalendarEventRequest.md create mode 100644 docs/reference/api/MlDeleteCalendarEventResponse.md create mode 100644 docs/reference/api/MlDeleteCalendarJobRequest.md create mode 100644 docs/reference/api/MlDeleteCalendarJobResponse.md create mode 100644 docs/reference/api/MlDeleteCalendarRequest.md create mode 100644 docs/reference/api/MlDeleteCalendarResponse.md create mode 100644 docs/reference/api/MlDeleteDataFrameAnalyticsRequest.md create mode 100644 docs/reference/api/MlDeleteDataFrameAnalyticsResponse.md create mode 100644 docs/reference/api/MlDeleteDatafeedRequest.md create mode 100644 docs/reference/api/MlDeleteDatafeedResponse.md create mode 100644 docs/reference/api/MlDeleteExpiredDataRequest.md create mode 100644 docs/reference/api/MlDeleteExpiredDataResponse.md create mode 100644 docs/reference/api/MlDeleteFilterRequest.md create mode 100644 docs/reference/api/MlDeleteFilterResponse.md create mode 100644 docs/reference/api/MlDeleteForecastRequest.md create mode 100644 docs/reference/api/MlDeleteForecastResponse.md create mode 100644 docs/reference/api/MlDeleteJobRequest.md create mode 100644 docs/reference/api/MlDeleteJobResponse.md create mode 100644 docs/reference/api/MlDeleteModelSnapshotRequest.md create mode 100644 docs/reference/api/MlDeleteModelSnapshotResponse.md create mode 100644 docs/reference/api/MlDeleteTrainedModelAliasRequest.md create mode 100644 docs/reference/api/MlDeleteTrainedModelAliasResponse.md create mode 100644 docs/reference/api/MlDeleteTrainedModelRequest.md create mode 100644 docs/reference/api/MlDeleteTrainedModelResponse.md create mode 100644 docs/reference/api/MlDeploymentAllocationState.md create mode 100644 docs/reference/api/MlDeploymentAssignmentState.md create mode 100644 docs/reference/api/MlDetectionRule.md create mode 100644 docs/reference/api/MlDetector.md create mode 100644 docs/reference/api/MlDetectorRead.md create mode 100644 docs/reference/api/MlDetectorUpdate.md create mode 100644 docs/reference/api/MlDiscoveryNode.md create mode 100644 docs/reference/api/MlDiscoveryNodeCompact.md create mode 100644 docs/reference/api/MlDiscoveryNodeContent.md create mode 100644 docs/reference/api/MlEstimateModelMemoryRequest.md create mode 100644 docs/reference/api/MlEstimateModelMemoryResponse.md create mode 100644 docs/reference/api/MlEvaluateDataFrameConfusionMatrixItem.md create mode 100644 docs/reference/api/MlEvaluateDataFrameConfusionMatrixPrediction.md create mode 100644 docs/reference/api/MlEvaluateDataFrameConfusionMatrixThreshold.md create mode 100644 docs/reference/api/MlEvaluateDataFrameDataframeClassificationSummary.md create mode 100644 docs/reference/api/MlEvaluateDataFrameDataframeClassificationSummaryAccuracy.md create mode 100644 docs/reference/api/MlEvaluateDataFrameDataframeClassificationSummaryMulticlassConfusionMatrix.md create mode 100644 docs/reference/api/MlEvaluateDataFrameDataframeClassificationSummaryPrecision.md create mode 100644 docs/reference/api/MlEvaluateDataFrameDataframeClassificationSummaryRecall.md create mode 100644 docs/reference/api/MlEvaluateDataFrameDataframeEvaluationClass.md create mode 100644 docs/reference/api/MlEvaluateDataFrameDataframeEvaluationSummaryAucRoc.md create mode 100644 docs/reference/api/MlEvaluateDataFrameDataframeEvaluationSummaryAucRocCurveItem.md create mode 100644 docs/reference/api/MlEvaluateDataFrameDataframeEvaluationValue.md create mode 100644 docs/reference/api/MlEvaluateDataFrameDataframeOutlierDetectionSummary.md create mode 100644 docs/reference/api/MlEvaluateDataFrameDataframeRegressionSummary.md create mode 100644 docs/reference/api/MlEvaluateDataFrameRequest.md create mode 100644 docs/reference/api/MlEvaluateDataFrameResponse.md create mode 100644 docs/reference/api/MlExcludeFrequent.md create mode 100644 docs/reference/api/MlExplainDataFrameAnalyticsRequest.md create mode 100644 docs/reference/api/MlExplainDataFrameAnalyticsResponse.md create mode 100644 docs/reference/api/MlExponentialAverageCalculationContext.md create mode 100644 docs/reference/api/MlFeatureExtractor.md create mode 100644 docs/reference/api/MlFillMaskInferenceOptions.md create mode 100644 docs/reference/api/MlFillMaskInferenceUpdateOptions.md create mode 100644 docs/reference/api/MlFilter.md create mode 100644 docs/reference/api/MlFilterRef.md create mode 100644 docs/reference/api/MlFilterType.md create mode 100644 docs/reference/api/MlFlushJobRequest.md create mode 100644 docs/reference/api/MlFlushJobResponse.md create mode 100644 docs/reference/api/MlForecastRequest.md create mode 100644 docs/reference/api/MlForecastResponse.md create mode 100644 docs/reference/api/MlGeoResults.md create mode 100644 docs/reference/api/MlGetBucketsRequest.md create mode 100644 docs/reference/api/MlGetBucketsResponse.md create mode 100644 docs/reference/api/MlGetCalendarEventsRequest.md create mode 100644 docs/reference/api/MlGetCalendarEventsResponse.md create mode 100644 docs/reference/api/MlGetCalendarsCalendar.md create mode 100644 docs/reference/api/MlGetCalendarsRequest.md create mode 100644 docs/reference/api/MlGetCalendarsResponse.md create mode 100644 docs/reference/api/MlGetCategoriesRequest.md create mode 100644 docs/reference/api/MlGetCategoriesResponse.md create mode 100644 docs/reference/api/MlGetDataFrameAnalyticsRequest.md create mode 100644 docs/reference/api/MlGetDataFrameAnalyticsResponse.md create mode 100644 docs/reference/api/MlGetDataFrameAnalyticsStatsRequest.md create mode 100644 docs/reference/api/MlGetDataFrameAnalyticsStatsResponse.md create mode 100644 docs/reference/api/MlGetDatafeedStatsRequest.md create mode 100644 docs/reference/api/MlGetDatafeedStatsResponse.md create mode 100644 docs/reference/api/MlGetDatafeedsRequest.md create mode 100644 docs/reference/api/MlGetDatafeedsResponse.md create mode 100644 docs/reference/api/MlGetFiltersRequest.md create mode 100644 docs/reference/api/MlGetFiltersResponse.md create mode 100644 docs/reference/api/MlGetInfluencersRequest.md create mode 100644 docs/reference/api/MlGetInfluencersResponse.md create mode 100644 docs/reference/api/MlGetJobStatsRequest.md create mode 100644 docs/reference/api/MlGetJobStatsResponse.md create mode 100644 docs/reference/api/MlGetJobsRequest.md create mode 100644 docs/reference/api/MlGetJobsResponse.md create mode 100644 docs/reference/api/MlGetMemoryStatsJvmStats.md create mode 100644 docs/reference/api/MlGetMemoryStatsMemMlStats.md create mode 100644 docs/reference/api/MlGetMemoryStatsMemStats.md create mode 100644 docs/reference/api/MlGetMemoryStatsMemory.md create mode 100644 docs/reference/api/MlGetMemoryStatsRequest.md create mode 100644 docs/reference/api/MlGetMemoryStatsResponse.md create mode 100644 docs/reference/api/MlGetModelSnapshotUpgradeStatsRequest.md create mode 100644 docs/reference/api/MlGetModelSnapshotUpgradeStatsResponse.md create mode 100644 docs/reference/api/MlGetModelSnapshotsRequest.md create mode 100644 docs/reference/api/MlGetModelSnapshotsResponse.md create mode 100644 docs/reference/api/MlGetOverallBucketsRequest.md create mode 100644 docs/reference/api/MlGetOverallBucketsResponse.md create mode 100644 docs/reference/api/MlGetRecordsRequest.md create mode 100644 docs/reference/api/MlGetRecordsResponse.md create mode 100644 docs/reference/api/MlGetTrainedModelsRequest.md create mode 100644 docs/reference/api/MlGetTrainedModelsResponse.md create mode 100644 docs/reference/api/MlGetTrainedModelsStatsRequest.md create mode 100644 docs/reference/api/MlGetTrainedModelsStatsResponse.md create mode 100644 docs/reference/api/MlHyperparameter.md create mode 100644 docs/reference/api/MlHyperparameters.md create mode 100644 docs/reference/api/MlInclude.md create mode 100644 docs/reference/api/MlInferTrainedModelRequest.md create mode 100644 docs/reference/api/MlInferTrainedModelResponse.md create mode 100644 docs/reference/api/MlInferenceConfigCreateContainer.md create mode 100644 docs/reference/api/MlInferenceConfigUpdateContainer.md create mode 100644 docs/reference/api/MlInferenceResponseResult.md create mode 100644 docs/reference/api/MlInfluence.md create mode 100644 docs/reference/api/MlInfluencer.md create mode 100644 docs/reference/api/MlInfoAnomalyDetectors.md create mode 100644 docs/reference/api/MlInfoDatafeeds.md create mode 100644 docs/reference/api/MlInfoDefaults.md create mode 100644 docs/reference/api/MlInfoLimits.md create mode 100644 docs/reference/api/MlInfoNativeCode.md create mode 100644 docs/reference/api/MlInfoRequest.md create mode 100644 docs/reference/api/MlInfoResponse.md create mode 100644 docs/reference/api/MlJob.md create mode 100644 docs/reference/api/MlJobBlocked.md create mode 100644 docs/reference/api/MlJobBlockedReason.md create mode 100644 docs/reference/api/MlJobConfig.md create mode 100644 docs/reference/api/MlJobForecastStatistics.md create mode 100644 docs/reference/api/MlJobState.md create mode 100644 docs/reference/api/MlJobStatistics.md create mode 100644 docs/reference/api/MlJobStats.md create mode 100644 docs/reference/api/MlJobTimingStats.md create mode 100644 docs/reference/api/MlLearningToRankConfig.md create mode 100644 docs/reference/api/MlMemoryStatus.md create mode 100644 docs/reference/api/MlModelPackageConfig.md create mode 100644 docs/reference/api/MlModelPlotConfig.md create mode 100644 docs/reference/api/MlModelSizeStats.md create mode 100644 docs/reference/api/MlModelSnapshot.md create mode 100644 docs/reference/api/MlModelSnapshotUpgrade.md create mode 100644 docs/reference/api/MlNerInferenceOptions.md create mode 100644 docs/reference/api/MlNerInferenceUpdateOptions.md create mode 100644 docs/reference/api/MlNlpBertTokenizationConfig.md create mode 100644 docs/reference/api/MlNlpRobertaTokenizationConfig.md create mode 100644 docs/reference/api/MlNlpTokenizationUpdateOptions.md create mode 100644 docs/reference/api/MlOpenJobRequest.md create mode 100644 docs/reference/api/MlOpenJobResponse.md create mode 100644 docs/reference/api/MlOutlierDetectionParameters.md create mode 100644 docs/reference/api/MlOverallBucket.md create mode 100644 docs/reference/api/MlOverallBucketJob.md create mode 100644 docs/reference/api/MlPage.md create mode 100644 docs/reference/api/MlPassThroughInferenceOptions.md create mode 100644 docs/reference/api/MlPassThroughInferenceUpdateOptions.md create mode 100644 docs/reference/api/MlPerPartitionCategorization.md create mode 100644 docs/reference/api/MlPostCalendarEventsRequest.md create mode 100644 docs/reference/api/MlPostCalendarEventsResponse.md create mode 100644 docs/reference/api/MlPostDataRequest.md create mode 100644 docs/reference/api/MlPostDataResponse.md create mode 100644 docs/reference/api/MlPredictedValue.md create mode 100644 docs/reference/api/MlPreviewDataFrameAnalyticsDataframePreviewConfig.md create mode 100644 docs/reference/api/MlPreviewDataFrameAnalyticsRequest.md create mode 100644 docs/reference/api/MlPreviewDataFrameAnalyticsResponse.md create mode 100644 docs/reference/api/MlPreviewDatafeedRequest.md create mode 100644 docs/reference/api/MlPreviewDatafeedResponse.md create mode 100644 docs/reference/api/MlPutCalendarJobRequest.md create mode 100644 docs/reference/api/MlPutCalendarJobResponse.md create mode 100644 docs/reference/api/MlPutCalendarRequest.md create mode 100644 docs/reference/api/MlPutCalendarResponse.md create mode 100644 docs/reference/api/MlPutDataFrameAnalyticsRequest.md create mode 100644 docs/reference/api/MlPutDataFrameAnalyticsResponse.md create mode 100644 docs/reference/api/MlPutDatafeedRequest.md create mode 100644 docs/reference/api/MlPutDatafeedResponse.md create mode 100644 docs/reference/api/MlPutFilterRequest.md create mode 100644 docs/reference/api/MlPutFilterResponse.md create mode 100644 docs/reference/api/MlPutJobRequest.md create mode 100644 docs/reference/api/MlPutJobResponse.md create mode 100644 docs/reference/api/MlPutTrainedModelAggregateOutput.md create mode 100644 docs/reference/api/MlPutTrainedModelAliasRequest.md create mode 100644 docs/reference/api/MlPutTrainedModelAliasResponse.md create mode 100644 docs/reference/api/MlPutTrainedModelDefinition.md create mode 100644 docs/reference/api/MlPutTrainedModelDefinitionPartRequest.md create mode 100644 docs/reference/api/MlPutTrainedModelDefinitionPartResponse.md create mode 100644 docs/reference/api/MlPutTrainedModelEnsemble.md create mode 100644 docs/reference/api/MlPutTrainedModelFrequencyEncodingPreprocessor.md create mode 100644 docs/reference/api/MlPutTrainedModelInput.md create mode 100644 docs/reference/api/MlPutTrainedModelOneHotEncodingPreprocessor.md create mode 100644 docs/reference/api/MlPutTrainedModelPreprocessor.md create mode 100644 docs/reference/api/MlPutTrainedModelRequest.md create mode 100644 docs/reference/api/MlPutTrainedModelResponse.md create mode 100644 docs/reference/api/MlPutTrainedModelTargetMeanEncodingPreprocessor.md create mode 100644 docs/reference/api/MlPutTrainedModelTrainedModel.md create mode 100644 docs/reference/api/MlPutTrainedModelTrainedModelTree.md create mode 100644 docs/reference/api/MlPutTrainedModelTrainedModelTreeNode.md create mode 100644 docs/reference/api/MlPutTrainedModelVocabularyRequest.md create mode 100644 docs/reference/api/MlPutTrainedModelVocabularyResponse.md create mode 100644 docs/reference/api/MlPutTrainedModelWeights.md create mode 100644 docs/reference/api/MlQueryFeatureExtractor.md create mode 100644 docs/reference/api/MlQuestionAnsweringInferenceOptions.md create mode 100644 docs/reference/api/MlQuestionAnsweringInferenceUpdateOptions.md create mode 100644 docs/reference/api/MlRegressionInferenceOptions.md create mode 100644 docs/reference/api/MlResetJobRequest.md create mode 100644 docs/reference/api/MlResetJobResponse.md create mode 100644 docs/reference/api/MlRevertModelSnapshotRequest.md create mode 100644 docs/reference/api/MlRevertModelSnapshotResponse.md create mode 100644 docs/reference/api/MlRoutingState.md create mode 100644 docs/reference/api/MlRuleAction.md create mode 100644 docs/reference/api/MlRuleCondition.md create mode 100644 docs/reference/api/MlRunningStateSearchInterval.md create mode 100644 docs/reference/api/MlSetUpgradeModeRequest.md create mode 100644 docs/reference/api/MlSetUpgradeModeResponse.md create mode 100644 docs/reference/api/MlSnapshotUpgradeState.md create mode 100644 docs/reference/api/MlStartDataFrameAnalyticsRequest.md create mode 100644 docs/reference/api/MlStartDataFrameAnalyticsResponse.md create mode 100644 docs/reference/api/MlStartDatafeedRequest.md create mode 100644 docs/reference/api/MlStartDatafeedResponse.md create mode 100644 docs/reference/api/MlStartTrainedModelDeploymentRequest.md create mode 100644 docs/reference/api/MlStartTrainedModelDeploymentResponse.md create mode 100644 docs/reference/api/MlStopDataFrameAnalyticsRequest.md create mode 100644 docs/reference/api/MlStopDataFrameAnalyticsResponse.md create mode 100644 docs/reference/api/MlStopDatafeedRequest.md create mode 100644 docs/reference/api/MlStopDatafeedResponse.md create mode 100644 docs/reference/api/MlStopTrainedModelDeploymentRequest.md create mode 100644 docs/reference/api/MlStopTrainedModelDeploymentResponse.md create mode 100644 docs/reference/api/MlTextClassificationInferenceOptions.md create mode 100644 docs/reference/api/MlTextClassificationInferenceUpdateOptions.md create mode 100644 docs/reference/api/MlTextEmbeddingInferenceOptions.md create mode 100644 docs/reference/api/MlTextEmbeddingInferenceUpdateOptions.md create mode 100644 docs/reference/api/MlTextExpansionInferenceOptions.md create mode 100644 docs/reference/api/MlTextExpansionInferenceUpdateOptions.md create mode 100644 docs/reference/api/MlTimingStats.md create mode 100644 docs/reference/api/MlTokenizationConfigContainer.md create mode 100644 docs/reference/api/MlTokenizationTruncate.md create mode 100644 docs/reference/api/MlTopClassEntry.md create mode 100644 docs/reference/api/MlTotalFeatureImportance.md create mode 100644 docs/reference/api/MlTotalFeatureImportanceClass.md create mode 100644 docs/reference/api/MlTotalFeatureImportanceStatistics.md create mode 100644 docs/reference/api/MlTrainedModelAssignment.md create mode 100644 docs/reference/api/MlTrainedModelAssignmentRoutingStateAndReason.md create mode 100644 docs/reference/api/MlTrainedModelAssignmentRoutingTable.md create mode 100644 docs/reference/api/MlTrainedModelAssignmentTaskParameters.md create mode 100644 docs/reference/api/MlTrainedModelConfig.md create mode 100644 docs/reference/api/MlTrainedModelConfigInput.md create mode 100644 docs/reference/api/MlTrainedModelConfigMetadata.md create mode 100644 docs/reference/api/MlTrainedModelDeploymentAllocationStatus.md create mode 100644 docs/reference/api/MlTrainedModelDeploymentNodesStats.md create mode 100644 docs/reference/api/MlTrainedModelDeploymentStats.md create mode 100644 docs/reference/api/MlTrainedModelEntities.md create mode 100644 docs/reference/api/MlTrainedModelInferenceClassImportance.md create mode 100644 docs/reference/api/MlTrainedModelInferenceFeatureImportance.md create mode 100644 docs/reference/api/MlTrainedModelInferenceStats.md create mode 100644 docs/reference/api/MlTrainedModelLocation.md create mode 100644 docs/reference/api/MlTrainedModelLocationIndex.md create mode 100644 docs/reference/api/MlTrainedModelPrefixStrings.md create mode 100644 docs/reference/api/MlTrainedModelSizeStats.md create mode 100644 docs/reference/api/MlTrainedModelStats.md create mode 100644 docs/reference/api/MlTrainedModelType.md create mode 100644 docs/reference/api/MlTrainingPriority.md create mode 100644 docs/reference/api/MlTransformAuthorization.md create mode 100644 docs/reference/api/MlUpdateDataFrameAnalyticsRequest.md create mode 100644 docs/reference/api/MlUpdateDataFrameAnalyticsResponse.md create mode 100644 docs/reference/api/MlUpdateDatafeedRequest.md create mode 100644 docs/reference/api/MlUpdateDatafeedResponse.md create mode 100644 docs/reference/api/MlUpdateFilterRequest.md create mode 100644 docs/reference/api/MlUpdateFilterResponse.md create mode 100644 docs/reference/api/MlUpdateJobRequest.md create mode 100644 docs/reference/api/MlUpdateJobResponse.md create mode 100644 docs/reference/api/MlUpdateModelSnapshotRequest.md create mode 100644 docs/reference/api/MlUpdateModelSnapshotResponse.md create mode 100644 docs/reference/api/MlUpdateTrainedModelDeploymentRequest.md create mode 100644 docs/reference/api/MlUpdateTrainedModelDeploymentResponse.md create mode 100644 docs/reference/api/MlUpgradeJobSnapshotRequest.md create mode 100644 docs/reference/api/MlUpgradeJobSnapshotResponse.md create mode 100644 docs/reference/api/MlValidateDetectorRequest.md create mode 100644 docs/reference/api/MlValidateDetectorResponse.md create mode 100644 docs/reference/api/MlValidateRequest.md create mode 100644 docs/reference/api/MlValidateResponse.md create mode 100644 docs/reference/api/MlValidationLoss.md create mode 100644 docs/reference/api/MlVocabulary.md create mode 100644 docs/reference/api/MlXlmRobertaTokenizationConfig.md create mode 100644 docs/reference/api/MlZeroShotClassificationInferenceOptions.md create mode 100644 docs/reference/api/MlZeroShotClassificationInferenceUpdateOptions.md create mode 100644 docs/reference/api/Monitoring.md create mode 100644 docs/reference/api/MonitoringBulkRequest.md create mode 100644 docs/reference/api/MonitoringBulkResponse.md create mode 100644 docs/reference/api/MsearchApi_1.md create mode 100644 docs/reference/api/MsearchApi_2.md create mode 100644 docs/reference/api/MsearchApi_3.md create mode 100644 docs/reference/api/MsearchHelper.md create mode 100644 docs/reference/api/MsearchHelperOptions.md create mode 100644 docs/reference/api/MsearchHelperResponse.md create mode 100644 docs/reference/api/MsearchMultiSearchItem.md create mode 100644 docs/reference/api/MsearchMultiSearchResult.md create mode 100644 docs/reference/api/MsearchMultisearchHeader.md create mode 100644 docs/reference/api/MsearchRequest.md create mode 100644 docs/reference/api/MsearchRequestItem.md create mode 100644 docs/reference/api/MsearchResponse.md create mode 100644 docs/reference/api/MsearchResponseItem.md create mode 100644 docs/reference/api/MsearchTemplateApi_1.md create mode 100644 docs/reference/api/MsearchTemplateApi_2.md create mode 100644 docs/reference/api/MsearchTemplateApi_3.md create mode 100644 docs/reference/api/MsearchTemplateRequest.md create mode 100644 docs/reference/api/MsearchTemplateRequestItem.md create mode 100644 docs/reference/api/MsearchTemplateResponse.md create mode 100644 docs/reference/api/MsearchTemplateTemplateConfig.md create mode 100644 docs/reference/api/MtermvectorsApi_1.md create mode 100644 docs/reference/api/MtermvectorsApi_2.md create mode 100644 docs/reference/api/MtermvectorsApi_3.md create mode 100644 docs/reference/api/MtermvectorsOperation.md create mode 100644 docs/reference/api/MtermvectorsRequest.md create mode 100644 docs/reference/api/MtermvectorsResponse.md create mode 100644 docs/reference/api/MtermvectorsTermVectorsResult.md create mode 100644 docs/reference/api/MultiTermQueryRewrite.md create mode 100644 docs/reference/api/Name.md create mode 100644 docs/reference/api/Names.md create mode 100644 docs/reference/api/Namespace.md create mode 100644 docs/reference/api/NestedSortValue.md create mode 100644 docs/reference/api/NodeAttributes.md create mode 100644 docs/reference/api/NodeId.md create mode 100644 docs/reference/api/NodeIds.md create mode 100644 docs/reference/api/NodeName.md create mode 100644 docs/reference/api/NodeOptions.md create mode 100644 docs/reference/api/NodeRole.md create mode 100644 docs/reference/api/NodeRoles.md create mode 100644 docs/reference/api/NodeShard.md create mode 100644 docs/reference/api/NodeStatistics.md create mode 100644 docs/reference/api/Nodes.md create mode 100644 docs/reference/api/NodesAdaptiveSelection.md create mode 100644 docs/reference/api/NodesBreaker.md create mode 100644 docs/reference/api/NodesCgroup.md create mode 100644 docs/reference/api/NodesCgroupCpu.md create mode 100644 docs/reference/api/NodesCgroupCpuStat.md create mode 100644 docs/reference/api/NodesCgroupMemory.md create mode 100644 docs/reference/api/NodesClearRepositoriesMeteringArchiveRequest.md create mode 100644 docs/reference/api/NodesClearRepositoriesMeteringArchiveResponse.md create mode 100644 docs/reference/api/NodesClearRepositoriesMeteringArchiveResponseBase.md create mode 100644 docs/reference/api/NodesClient.md create mode 100644 docs/reference/api/NodesClusterAppliedStats.md create mode 100644 docs/reference/api/NodesClusterStateQueue.md create mode 100644 docs/reference/api/NodesClusterStateUpdate.md create mode 100644 docs/reference/api/NodesContext.md create mode 100644 docs/reference/api/NodesCpu.md create mode 100644 docs/reference/api/NodesCpuAcct.md create mode 100644 docs/reference/api/NodesDataPathStats.md create mode 100644 docs/reference/api/NodesDiscovery.md create mode 100644 docs/reference/api/NodesExtendedMemoryStats.md create mode 100644 docs/reference/api/NodesFileSystem.md create mode 100644 docs/reference/api/NodesFileSystemTotal.md create mode 100644 docs/reference/api/NodesGarbageCollector.md create mode 100644 docs/reference/api/NodesGarbageCollectorTotal.md create mode 100644 docs/reference/api/NodesGetRepositoriesMeteringInfoRequest.md create mode 100644 docs/reference/api/NodesGetRepositoriesMeteringInfoResponse.md create mode 100644 docs/reference/api/NodesGetRepositoriesMeteringInfoResponseBase.md create mode 100644 docs/reference/api/NodesHotThreadsRequest.md create mode 100644 docs/reference/api/NodesHotThreadsResponse.md create mode 100644 docs/reference/api/NodesHttp.md create mode 100644 docs/reference/api/NodesHttpRoute.md create mode 100644 docs/reference/api/NodesHttpRouteRequests.md create mode 100644 docs/reference/api/NodesHttpRouteResponses.md create mode 100644 docs/reference/api/NodesIndexingPressure.md create mode 100644 docs/reference/api/NodesIndexingPressureMemory.md create mode 100644 docs/reference/api/NodesInfoDeprecationIndexing.md create mode 100644 docs/reference/api/NodesInfoNodeInfo.md create mode 100644 docs/reference/api/NodesInfoNodeInfoAction.md create mode 100644 docs/reference/api/NodesInfoNodeInfoAggregation.md create mode 100644 docs/reference/api/NodesInfoNodeInfoBootstrap.md create mode 100644 docs/reference/api/NodesInfoNodeInfoClient.md create mode 100644 docs/reference/api/NodesInfoNodeInfoDiscover.md create mode 100644 docs/reference/api/NodesInfoNodeInfoDiscoverKeys.md create mode 100644 docs/reference/api/NodesInfoNodeInfoHttp.md create mode 100644 docs/reference/api/NodesInfoNodeInfoIngest.md create mode 100644 docs/reference/api/NodesInfoNodeInfoIngestDownloader.md create mode 100644 docs/reference/api/NodesInfoNodeInfoIngestInfo.md create mode 100644 docs/reference/api/NodesInfoNodeInfoIngestProcessor.md create mode 100644 docs/reference/api/NodesInfoNodeInfoJvmMemory.md create mode 100644 docs/reference/api/NodesInfoNodeInfoMemory.md create mode 100644 docs/reference/api/NodesInfoNodeInfoNetwork.md create mode 100644 docs/reference/api/NodesInfoNodeInfoNetworkInterface.md create mode 100644 docs/reference/api/NodesInfoNodeInfoOSCPU.md create mode 100644 docs/reference/api/NodesInfoNodeInfoPath.md create mode 100644 docs/reference/api/NodesInfoNodeInfoRepositories.md create mode 100644 docs/reference/api/NodesInfoNodeInfoRepositoriesUrl.md create mode 100644 docs/reference/api/NodesInfoNodeInfoScript.md create mode 100644 docs/reference/api/NodesInfoNodeInfoSearch.md create mode 100644 docs/reference/api/NodesInfoNodeInfoSearchRemote.md create mode 100644 docs/reference/api/NodesInfoNodeInfoSettings.md create mode 100644 docs/reference/api/NodesInfoNodeInfoSettingsCluster.md create mode 100644 docs/reference/api/NodesInfoNodeInfoSettingsClusterElection.md create mode 100644 docs/reference/api/NodesInfoNodeInfoSettingsHttp.md create mode 100644 docs/reference/api/NodesInfoNodeInfoSettingsHttpType.md create mode 100644 docs/reference/api/NodesInfoNodeInfoSettingsIngest.md create mode 100644 docs/reference/api/NodesInfoNodeInfoSettingsNetwork.md create mode 100644 docs/reference/api/NodesInfoNodeInfoSettingsNode.md create mode 100644 docs/reference/api/NodesInfoNodeInfoSettingsTransport.md create mode 100644 docs/reference/api/NodesInfoNodeInfoSettingsTransportFeatures.md create mode 100644 docs/reference/api/NodesInfoNodeInfoSettingsTransportType.md create mode 100644 docs/reference/api/NodesInfoNodeInfoTransport.md create mode 100644 docs/reference/api/NodesInfoNodeInfoXpack.md create mode 100644 docs/reference/api/NodesInfoNodeInfoXpackLicense.md create mode 100644 docs/reference/api/NodesInfoNodeInfoXpackLicenseType.md create mode 100644 docs/reference/api/NodesInfoNodeInfoXpackMl.md create mode 100644 docs/reference/api/NodesInfoNodeInfoXpackSecurity.md create mode 100644 docs/reference/api/NodesInfoNodeInfoXpackSecurityAuthc.md create mode 100644 docs/reference/api/NodesInfoNodeInfoXpackSecurityAuthcRealms.md create mode 100644 docs/reference/api/NodesInfoNodeInfoXpackSecurityAuthcRealmsStatus.md create mode 100644 docs/reference/api/NodesInfoNodeInfoXpackSecurityAuthcToken.md create mode 100644 docs/reference/api/NodesInfoNodeInfoXpackSecuritySsl.md create mode 100644 docs/reference/api/NodesInfoNodeJvmInfo.md create mode 100644 docs/reference/api/NodesInfoNodeOperatingSystemInfo.md create mode 100644 docs/reference/api/NodesInfoNodeProcessInfo.md create mode 100644 docs/reference/api/NodesInfoNodeThreadPoolInfo.md create mode 100644 docs/reference/api/NodesInfoRequest.md create mode 100644 docs/reference/api/NodesInfoResponse.md create mode 100644 docs/reference/api/NodesInfoResponseBase.md create mode 100644 docs/reference/api/NodesIngest.md create mode 100644 docs/reference/api/NodesIngestStats.md create mode 100644 docs/reference/api/NodesIngestTotal.md create mode 100644 docs/reference/api/NodesIoStatDevice.md create mode 100644 docs/reference/api/NodesIoStats.md create mode 100644 docs/reference/api/NodesJvm.md create mode 100644 docs/reference/api/NodesJvmClasses.md create mode 100644 docs/reference/api/NodesJvmMemoryStats.md create mode 100644 docs/reference/api/NodesJvmThreads.md create mode 100644 docs/reference/api/NodesKeyedProcessor.md create mode 100644 docs/reference/api/NodesMemoryStats.md create mode 100644 docs/reference/api/NodesNodeBufferPool.md create mode 100644 docs/reference/api/NodesNodeReloadResult.md create mode 100644 docs/reference/api/NodesNodesResponseBase.md create mode 100644 docs/reference/api/NodesOperatingSystem.md create mode 100644 docs/reference/api/NodesPool.md create mode 100644 docs/reference/api/NodesPressureMemory.md create mode 100644 docs/reference/api/NodesProcess.md create mode 100644 docs/reference/api/NodesProcessor.md create mode 100644 docs/reference/api/NodesPublishedClusterStates.md create mode 100644 docs/reference/api/NodesRecording.md create mode 100644 docs/reference/api/NodesReloadSecureSettingsRequest.md create mode 100644 docs/reference/api/NodesReloadSecureSettingsResponse.md create mode 100644 docs/reference/api/NodesReloadSecureSettingsResponseBase.md create mode 100644 docs/reference/api/NodesRepositoryLocation.md create mode 100644 docs/reference/api/NodesRepositoryMeteringInformation.md create mode 100644 docs/reference/api/NodesRequestCounts.md create mode 100644 docs/reference/api/NodesScriptCache.md create mode 100644 docs/reference/api/NodesScripting.md create mode 100644 docs/reference/api/NodesSerializedClusterState.md create mode 100644 docs/reference/api/NodesSerializedClusterStateDetail.md create mode 100644 docs/reference/api/NodesSizeHttpHistogram.md create mode 100644 docs/reference/api/NodesStats.md create mode 100644 docs/reference/api/NodesStatsRequest.md create mode 100644 docs/reference/api/NodesStatsResponse.md create mode 100644 docs/reference/api/NodesStatsResponseBase.md create mode 100644 docs/reference/api/NodesThreadCount.md create mode 100644 docs/reference/api/NodesTimeHttpHistogram.md create mode 100644 docs/reference/api/NodesTransport.md create mode 100644 docs/reference/api/NodesTransportHistogram.md create mode 100644 docs/reference/api/NodesUsageNodeUsage.md create mode 100644 docs/reference/api/NodesUsageRequest.md create mode 100644 docs/reference/api/NodesUsageResponse.md create mode 100644 docs/reference/api/NodesUsageResponseBase.md create mode 100644 docs/reference/api/Normalization.md create mode 100644 docs/reference/api/OnDropDocument.md create mode 100644 docs/reference/api/OnSuccessDocument.md create mode 100644 docs/reference/api/OpType.md create mode 100644 docs/reference/api/OpenPointInTimeApi_1.md create mode 100644 docs/reference/api/OpenPointInTimeApi_2.md create mode 100644 docs/reference/api/OpenPointInTimeApi_3.md create mode 100644 docs/reference/api/OpenPointInTimeRequest.md create mode 100644 docs/reference/api/OpenPointInTimeResponse.md create mode 100644 docs/reference/api/Password.md create mode 100644 docs/reference/api/Percentage.md create mode 100644 docs/reference/api/PingApi_1.md create mode 100644 docs/reference/api/PingApi_2.md create mode 100644 docs/reference/api/PingApi_3.md create mode 100644 docs/reference/api/PingRequest.md create mode 100644 docs/reference/api/PingResponse.md create mode 100644 docs/reference/api/PipelineName.md create mode 100644 docs/reference/api/PluginStats.md create mode 100644 docs/reference/api/Profiling.md create mode 100644 docs/reference/api/PropertyName.md create mode 100644 docs/reference/api/PutScriptApi_1.md create mode 100644 docs/reference/api/PutScriptApi_2.md create mode 100644 docs/reference/api/PutScriptApi_3.md create mode 100644 docs/reference/api/PutScriptRequest.md create mode 100644 docs/reference/api/PutScriptResponse.md create mode 100644 docs/reference/api/QueryCacheStats.md create mode 100644 docs/reference/api/QueryDslBoolQuery.md create mode 100644 docs/reference/api/QueryDslBoostingQuery.md create mode 100644 docs/reference/api/QueryDslChildScoreMode.md create mode 100644 docs/reference/api/QueryDslCombinedFieldsOperator.md create mode 100644 docs/reference/api/QueryDslCombinedFieldsQuery.md create mode 100644 docs/reference/api/QueryDslCombinedFieldsZeroTerms.md create mode 100644 docs/reference/api/QueryDslCommonTermsQuery.md create mode 100644 docs/reference/api/QueryDslConstantScoreQuery.md create mode 100644 docs/reference/api/QueryDslDateDecayFunction.md create mode 100644 docs/reference/api/QueryDslDateDecayFunctionKeys.md create mode 100644 docs/reference/api/QueryDslDateDistanceFeatureQuery.md create mode 100644 docs/reference/api/QueryDslDateRangeQuery.md create mode 100644 docs/reference/api/QueryDslDecayFunction.md create mode 100644 docs/reference/api/QueryDslDecayFunctionBase.md create mode 100644 docs/reference/api/QueryDslDecayPlacement.md create mode 100644 docs/reference/api/QueryDslDisMaxQuery.md create mode 100644 docs/reference/api/QueryDslDistanceFeatureQuery.md create mode 100644 docs/reference/api/QueryDslDistanceFeatureQueryBase.md create mode 100644 docs/reference/api/QueryDslExistsQuery.md create mode 100644 docs/reference/api/QueryDslFieldAndFormat.md create mode 100644 docs/reference/api/QueryDslFieldLookup.md create mode 100644 docs/reference/api/QueryDslFieldValueFactorModifier.md create mode 100644 docs/reference/api/QueryDslFieldValueFactorScoreFunction.md create mode 100644 docs/reference/api/QueryDslFunctionBoostMode.md create mode 100644 docs/reference/api/QueryDslFunctionScoreContainer.md create mode 100644 docs/reference/api/QueryDslFunctionScoreMode.md create mode 100644 docs/reference/api/QueryDslFunctionScoreQuery.md create mode 100644 docs/reference/api/QueryDslFuzzyQuery.md create mode 100644 docs/reference/api/QueryDslGeoBoundingBoxQuery.md create mode 100644 docs/reference/api/QueryDslGeoBoundingBoxQueryKeys.md create mode 100644 docs/reference/api/QueryDslGeoDecayFunction.md create mode 100644 docs/reference/api/QueryDslGeoDecayFunctionKeys.md create mode 100644 docs/reference/api/QueryDslGeoDistanceFeatureQuery.md create mode 100644 docs/reference/api/QueryDslGeoDistanceQuery.md create mode 100644 docs/reference/api/QueryDslGeoDistanceQueryKeys.md create mode 100644 docs/reference/api/QueryDslGeoExecution.md create mode 100644 docs/reference/api/QueryDslGeoGridQuery.md create mode 100644 docs/reference/api/QueryDslGeoPolygonPoints.md create mode 100644 docs/reference/api/QueryDslGeoPolygonQuery.md create mode 100644 docs/reference/api/QueryDslGeoPolygonQueryKeys.md create mode 100644 docs/reference/api/QueryDslGeoShapeFieldQuery.md create mode 100644 docs/reference/api/QueryDslGeoShapeQuery.md create mode 100644 docs/reference/api/QueryDslGeoShapeQueryKeys.md create mode 100644 docs/reference/api/QueryDslGeoValidationMethod.md create mode 100644 docs/reference/api/QueryDslHasChildQuery.md create mode 100644 docs/reference/api/QueryDslHasParentQuery.md create mode 100644 docs/reference/api/QueryDslIdsQuery.md create mode 100644 docs/reference/api/QueryDslIntervalsAllOf.md create mode 100644 docs/reference/api/QueryDslIntervalsAnyOf.md create mode 100644 docs/reference/api/QueryDslIntervalsContainer.md create mode 100644 docs/reference/api/QueryDslIntervalsFilter.md create mode 100644 docs/reference/api/QueryDslIntervalsFuzzy.md create mode 100644 docs/reference/api/QueryDslIntervalsMatch.md create mode 100644 docs/reference/api/QueryDslIntervalsPrefix.md create mode 100644 docs/reference/api/QueryDslIntervalsQuery.md create mode 100644 docs/reference/api/QueryDslIntervalsWildcard.md create mode 100644 docs/reference/api/QueryDslLike.md create mode 100644 docs/reference/api/QueryDslLikeDocument.md create mode 100644 docs/reference/api/QueryDslMatchAllQuery.md create mode 100644 docs/reference/api/QueryDslMatchBoolPrefixQuery.md create mode 100644 docs/reference/api/QueryDslMatchNoneQuery.md create mode 100644 docs/reference/api/QueryDslMatchPhrasePrefixQuery.md create mode 100644 docs/reference/api/QueryDslMatchPhraseQuery.md create mode 100644 docs/reference/api/QueryDslMatchQuery.md create mode 100644 docs/reference/api/QueryDslMoreLikeThisQuery.md create mode 100644 docs/reference/api/QueryDslMultiMatchQuery.md create mode 100644 docs/reference/api/QueryDslMultiValueMode.md create mode 100644 docs/reference/api/QueryDslNestedQuery.md create mode 100644 docs/reference/api/QueryDslNumberRangeQuery.md create mode 100644 docs/reference/api/QueryDslNumericDecayFunction.md create mode 100644 docs/reference/api/QueryDslNumericDecayFunctionKeys.md create mode 100644 docs/reference/api/QueryDslOperator.md create mode 100644 docs/reference/api/QueryDslParentIdQuery.md create mode 100644 docs/reference/api/QueryDslPercolateQuery.md create mode 100644 docs/reference/api/QueryDslPinnedDoc.md create mode 100644 docs/reference/api/QueryDslPinnedQuery.md create mode 100644 docs/reference/api/QueryDslPrefixQuery.md create mode 100644 docs/reference/api/QueryDslQueryBase.md create mode 100644 docs/reference/api/QueryDslQueryContainer.md create mode 100644 docs/reference/api/QueryDslQueryStringQuery.md create mode 100644 docs/reference/api/QueryDslRandomScoreFunction.md create mode 100644 docs/reference/api/QueryDslRangeQuery.md create mode 100644 docs/reference/api/QueryDslRangeQueryBase.md create mode 100644 docs/reference/api/QueryDslRangeRelation.md create mode 100644 docs/reference/api/QueryDslRankFeatureFunction.md create mode 100644 docs/reference/api/QueryDslRankFeatureFunctionLinear.md create mode 100644 docs/reference/api/QueryDslRankFeatureFunctionLogarithm.md create mode 100644 docs/reference/api/QueryDslRankFeatureFunctionSaturation.md create mode 100644 docs/reference/api/QueryDslRankFeatureFunctionSigmoid.md create mode 100644 docs/reference/api/QueryDslRankFeatureQuery.md create mode 100644 docs/reference/api/QueryDslRegexpQuery.md create mode 100644 docs/reference/api/QueryDslRuleQuery.md create mode 100644 docs/reference/api/QueryDslScriptQuery.md create mode 100644 docs/reference/api/QueryDslScriptScoreFunction.md create mode 100644 docs/reference/api/QueryDslScriptScoreQuery.md create mode 100644 docs/reference/api/QueryDslSemanticQuery.md create mode 100644 docs/reference/api/QueryDslShapeFieldQuery.md create mode 100644 docs/reference/api/QueryDslShapeQuery.md create mode 100644 docs/reference/api/QueryDslShapeQueryKeys.md create mode 100644 docs/reference/api/QueryDslSimpleQueryStringFlag.md create mode 100644 docs/reference/api/QueryDslSimpleQueryStringFlags.md create mode 100644 docs/reference/api/QueryDslSimpleQueryStringQuery.md create mode 100644 docs/reference/api/QueryDslSpanContainingQuery.md create mode 100644 docs/reference/api/QueryDslSpanFieldMaskingQuery.md create mode 100644 docs/reference/api/QueryDslSpanFirstQuery.md create mode 100644 docs/reference/api/QueryDslSpanGapQuery.md create mode 100644 docs/reference/api/QueryDslSpanMultiTermQuery.md create mode 100644 docs/reference/api/QueryDslSpanNearQuery.md create mode 100644 docs/reference/api/QueryDslSpanNotQuery.md create mode 100644 docs/reference/api/QueryDslSpanOrQuery.md create mode 100644 docs/reference/api/QueryDslSpanQuery.md create mode 100644 docs/reference/api/QueryDslSpanTermQuery.md create mode 100644 docs/reference/api/QueryDslSpanWithinQuery.md create mode 100644 docs/reference/api/QueryDslSparseVectorQuery.md create mode 100644 docs/reference/api/QueryDslTermQuery.md create mode 100644 docs/reference/api/QueryDslTermRangeQuery.md create mode 100644 docs/reference/api/QueryDslTermsLookup.md create mode 100644 docs/reference/api/QueryDslTermsQuery.md create mode 100644 docs/reference/api/QueryDslTermsQueryField.md create mode 100644 docs/reference/api/QueryDslTermsQueryKeys.md create mode 100644 docs/reference/api/QueryDslTermsSetQuery.md create mode 100644 docs/reference/api/QueryDslTextExpansionQuery.md create mode 100644 docs/reference/api/QueryDslTextQueryType.md create mode 100644 docs/reference/api/QueryDslTokenPruningConfig.md create mode 100644 docs/reference/api/QueryDslTypeQuery.md create mode 100644 docs/reference/api/QueryDslUntypedDecayFunction.md create mode 100644 docs/reference/api/QueryDslUntypedDecayFunctionKeys.md create mode 100644 docs/reference/api/QueryDslUntypedDistanceFeatureQuery.md create mode 100644 docs/reference/api/QueryDslUntypedRangeQuery.md create mode 100644 docs/reference/api/QueryDslWeightedTokensQuery.md create mode 100644 docs/reference/api/QueryDslWildcardQuery.md create mode 100644 docs/reference/api/QueryDslWrapperQuery.md create mode 100644 docs/reference/api/QueryDslZeroTermsQuery.md create mode 100644 docs/reference/api/QueryRules.md create mode 100644 docs/reference/api/QueryRulesDeleteRuleRequest.md create mode 100644 docs/reference/api/QueryRulesDeleteRuleResponse.md create mode 100644 docs/reference/api/QueryRulesDeleteRulesetRequest.md create mode 100644 docs/reference/api/QueryRulesDeleteRulesetResponse.md create mode 100644 docs/reference/api/QueryRulesGetRuleRequest.md create mode 100644 docs/reference/api/QueryRulesGetRuleResponse.md create mode 100644 docs/reference/api/QueryRulesGetRulesetRequest.md create mode 100644 docs/reference/api/QueryRulesGetRulesetResponse.md create mode 100644 docs/reference/api/QueryRulesListRulesetsQueryRulesetListItem.md create mode 100644 docs/reference/api/QueryRulesListRulesetsRequest.md create mode 100644 docs/reference/api/QueryRulesListRulesetsResponse.md create mode 100644 docs/reference/api/QueryRulesPutRuleRequest.md create mode 100644 docs/reference/api/QueryRulesPutRuleResponse.md create mode 100644 docs/reference/api/QueryRulesPutRulesetRequest.md create mode 100644 docs/reference/api/QueryRulesPutRulesetResponse.md create mode 100644 docs/reference/api/QueryRulesQueryRule.md create mode 100644 docs/reference/api/QueryRulesQueryRuleActions.md create mode 100644 docs/reference/api/QueryRulesQueryRuleCriteria.md create mode 100644 docs/reference/api/QueryRulesQueryRuleCriteriaType.md create mode 100644 docs/reference/api/QueryRulesQueryRuleType.md create mode 100644 docs/reference/api/QueryRulesQueryRuleset.md create mode 100644 docs/reference/api/QueryRulesTestQueryRulesetMatchedRule.md create mode 100644 docs/reference/api/QueryRulesTestRequest.md create mode 100644 docs/reference/api/QueryRulesTestResponse.md create mode 100644 docs/reference/api/QueryVector.md create mode 100644 docs/reference/api/QueryVectorBuilder.md create mode 100644 docs/reference/api/RRFRetriever.md create mode 100644 docs/reference/api/RankBase.md create mode 100644 docs/reference/api/RankContainer.md create mode 100644 docs/reference/api/RankEvalApi_1.md create mode 100644 docs/reference/api/RankEvalApi_2.md create mode 100644 docs/reference/api/RankEvalApi_3.md create mode 100644 docs/reference/api/RankEvalDocumentRating.md create mode 100644 docs/reference/api/RankEvalRankEvalHit.md create mode 100644 docs/reference/api/RankEvalRankEvalHitItem.md create mode 100644 docs/reference/api/RankEvalRankEvalMetric.md create mode 100644 docs/reference/api/RankEvalRankEvalMetricBase.md create mode 100644 docs/reference/api/RankEvalRankEvalMetricDetail.md create mode 100644 docs/reference/api/RankEvalRankEvalMetricDiscountedCumulativeGain.md create mode 100644 docs/reference/api/RankEvalRankEvalMetricExpectedReciprocalRank.md create mode 100644 docs/reference/api/RankEvalRankEvalMetricMeanReciprocalRank.md create mode 100644 docs/reference/api/RankEvalRankEvalMetricPrecision.md create mode 100644 docs/reference/api/RankEvalRankEvalMetricRatingTreshold.md create mode 100644 docs/reference/api/RankEvalRankEvalMetricRecall.md create mode 100644 docs/reference/api/RankEvalRankEvalQuery.md create mode 100644 docs/reference/api/RankEvalRankEvalRequestItem.md create mode 100644 docs/reference/api/RankEvalRequest.md create mode 100644 docs/reference/api/RankEvalResponse.md create mode 100644 docs/reference/api/RankEvalUnratedDocument.md create mode 100644 docs/reference/api/RecoveryStats.md create mode 100644 docs/reference/api/Refresh.md create mode 100644 docs/reference/api/RefreshStats.md create mode 100644 docs/reference/api/ReindexApi_1.md create mode 100644 docs/reference/api/ReindexApi_2.md create mode 100644 docs/reference/api/ReindexApi_3.md create mode 100644 docs/reference/api/ReindexDestination.md create mode 100644 docs/reference/api/ReindexRemoteSource.md create mode 100644 docs/reference/api/ReindexRequest.md create mode 100644 docs/reference/api/ReindexResponse.md create mode 100644 docs/reference/api/ReindexRethrottleApi_1.md create mode 100644 docs/reference/api/ReindexRethrottleApi_2.md create mode 100644 docs/reference/api/ReindexRethrottleApi_3.md create mode 100644 docs/reference/api/ReindexRethrottleReindexNode.md create mode 100644 docs/reference/api/ReindexRethrottleReindexStatus.md create mode 100644 docs/reference/api/ReindexRethrottleReindexTask.md create mode 100644 docs/reference/api/ReindexRethrottleRequest.md create mode 100644 docs/reference/api/ReindexRethrottleResponse.md create mode 100644 docs/reference/api/ReindexSource.md create mode 100644 docs/reference/api/RelationName.md create mode 100644 docs/reference/api/RelocationFailureInfo.md create mode 100644 docs/reference/api/RenderSearchTemplateApi_1.md create mode 100644 docs/reference/api/RenderSearchTemplateApi_2.md create mode 100644 docs/reference/api/RenderSearchTemplateApi_3.md create mode 100644 docs/reference/api/RenderSearchTemplateRequest.md create mode 100644 docs/reference/api/RenderSearchTemplateResponse.md create mode 100644 docs/reference/api/RequestBase.md create mode 100644 docs/reference/api/RequestCacheStats.md create mode 100644 docs/reference/api/RescoreVector.md create mode 100644 docs/reference/api/Result.md create mode 100644 docs/reference/api/Retries.md create mode 100644 docs/reference/api/RetrieverBase.md create mode 100644 docs/reference/api/RetrieverContainer.md create mode 100644 docs/reference/api/Rollup.md create mode 100644 docs/reference/api/RollupDateHistogramGrouping.md create mode 100644 docs/reference/api/RollupDeleteJobRequest.md create mode 100644 docs/reference/api/RollupDeleteJobResponse.md create mode 100644 docs/reference/api/RollupFieldMetric.md create mode 100644 docs/reference/api/RollupGetJobsIndexingJobState.md create mode 100644 docs/reference/api/RollupGetJobsRequest.md create mode 100644 docs/reference/api/RollupGetJobsResponse.md create mode 100644 docs/reference/api/RollupGetJobsRollupJob.md create mode 100644 docs/reference/api/RollupGetJobsRollupJobConfiguration.md create mode 100644 docs/reference/api/RollupGetJobsRollupJobStats.md create mode 100644 docs/reference/api/RollupGetJobsRollupJobStatus.md create mode 100644 docs/reference/api/RollupGetRollupCapsRequest.md create mode 100644 docs/reference/api/RollupGetRollupCapsResponse.md create mode 100644 docs/reference/api/RollupGetRollupCapsRollupCapabilities.md create mode 100644 docs/reference/api/RollupGetRollupCapsRollupCapabilitySummary.md create mode 100644 docs/reference/api/RollupGetRollupCapsRollupFieldSummary.md create mode 100644 docs/reference/api/RollupGetRollupIndexCapsIndexCapabilities.md create mode 100644 docs/reference/api/RollupGetRollupIndexCapsRequest.md create mode 100644 docs/reference/api/RollupGetRollupIndexCapsResponse.md create mode 100644 docs/reference/api/RollupGetRollupIndexCapsRollupJobSummary.md create mode 100644 docs/reference/api/RollupGetRollupIndexCapsRollupJobSummaryField.md create mode 100644 docs/reference/api/RollupGroupings.md create mode 100644 docs/reference/api/RollupHistogramGrouping.md create mode 100644 docs/reference/api/RollupMetric.md create mode 100644 docs/reference/api/RollupPutJobRequest.md create mode 100644 docs/reference/api/RollupPutJobResponse.md create mode 100644 docs/reference/api/RollupRollupSearchRequest.md create mode 100644 docs/reference/api/RollupRollupSearchResponse.md create mode 100644 docs/reference/api/RollupStartJobRequest.md create mode 100644 docs/reference/api/RollupStartJobResponse.md create mode 100644 docs/reference/api/RollupStopJobRequest.md create mode 100644 docs/reference/api/RollupStopJobResponse.md create mode 100644 docs/reference/api/RollupTermsGrouping.md create mode 100644 docs/reference/api/Routing.md create mode 100644 docs/reference/api/RrfRank.md create mode 100644 docs/reference/api/RuleRetriever.md create mode 100644 docs/reference/api/ScalarValue.md create mode 100644 docs/reference/api/ScoreSort.md create mode 100644 docs/reference/api/Script.md create mode 100644 docs/reference/api/ScriptField.md create mode 100644 docs/reference/api/ScriptLanguage.md create mode 100644 docs/reference/api/ScriptSort.md create mode 100644 docs/reference/api/ScriptSortType.md create mode 100644 docs/reference/api/ScriptSource.md create mode 100644 docs/reference/api/ScriptTransform.md create mode 100644 docs/reference/api/ScriptsPainlessExecuteApi_1.md create mode 100644 docs/reference/api/ScriptsPainlessExecuteApi_2.md create mode 100644 docs/reference/api/ScriptsPainlessExecuteApi_3.md create mode 100644 docs/reference/api/ScriptsPainlessExecutePainlessContext.md create mode 100644 docs/reference/api/ScriptsPainlessExecutePainlessContextSetup.md create mode 100644 docs/reference/api/ScriptsPainlessExecuteRequest.md create mode 100644 docs/reference/api/ScriptsPainlessExecuteResponse.md create mode 100644 docs/reference/api/ScrollApi_1.md create mode 100644 docs/reference/api/ScrollApi_2.md create mode 100644 docs/reference/api/ScrollApi_3.md create mode 100644 docs/reference/api/ScrollId.md create mode 100644 docs/reference/api/ScrollIds.md create mode 100644 docs/reference/api/ScrollRequest.md create mode 100644 docs/reference/api/ScrollResponse.md create mode 100644 docs/reference/api/ScrollSearchOptions.md create mode 100644 docs/reference/api/ScrollSearchResponse.md create mode 100644 docs/reference/api/SearchAggregationBreakdown.md create mode 100644 docs/reference/api/SearchAggregationProfile.md create mode 100644 docs/reference/api/SearchAggregationProfileDebug.md create mode 100644 docs/reference/api/SearchAggregationProfileDelegateDebugFilter.md create mode 100644 docs/reference/api/SearchApi_1.md create mode 100644 docs/reference/api/SearchApi_2.md create mode 100644 docs/reference/api/SearchApi_3.md create mode 100644 docs/reference/api/SearchApplication.md create mode 100644 docs/reference/api/SearchApplicationAnalyticsCollection.md create mode 100644 docs/reference/api/SearchApplicationDeleteBehavioralAnalyticsRequest.md create mode 100644 docs/reference/api/SearchApplicationDeleteBehavioralAnalyticsResponse.md create mode 100644 docs/reference/api/SearchApplicationDeleteRequest.md create mode 100644 docs/reference/api/SearchApplicationDeleteResponse.md create mode 100644 docs/reference/api/SearchApplicationEventDataStream.md create mode 100644 docs/reference/api/SearchApplicationEventType.md create mode 100644 docs/reference/api/SearchApplicationGetBehavioralAnalyticsRequest.md create mode 100644 docs/reference/api/SearchApplicationGetBehavioralAnalyticsResponse.md create mode 100644 docs/reference/api/SearchApplicationGetRequest.md create mode 100644 docs/reference/api/SearchApplicationGetResponse.md create mode 100644 docs/reference/api/SearchApplicationListRequest.md create mode 100644 docs/reference/api/SearchApplicationListResponse.md create mode 100644 docs/reference/api/SearchApplicationPostBehavioralAnalyticsEventRequest.md create mode 100644 docs/reference/api/SearchApplicationPostBehavioralAnalyticsEventResponse.md create mode 100644 docs/reference/api/SearchApplicationPutBehavioralAnalyticsAnalyticsAcknowledgeResponseBase.md create mode 100644 docs/reference/api/SearchApplicationPutBehavioralAnalyticsRequest.md create mode 100644 docs/reference/api/SearchApplicationPutBehavioralAnalyticsResponse.md create mode 100644 docs/reference/api/SearchApplicationPutRequest.md create mode 100644 docs/reference/api/SearchApplicationPutResponse.md create mode 100644 docs/reference/api/SearchApplicationRenderQueryRequest.md create mode 100644 docs/reference/api/SearchApplicationRenderQueryResponse.md create mode 100644 docs/reference/api/SearchApplicationSearchApplication.md create mode 100644 docs/reference/api/SearchApplicationSearchApplicationParameters.md create mode 100644 docs/reference/api/SearchApplicationSearchApplicationTemplate.md create mode 100644 docs/reference/api/SearchApplicationSearchRequest.md create mode 100644 docs/reference/api/SearchApplicationSearchResponse.md create mode 100644 docs/reference/api/SearchBoundaryScanner.md create mode 100644 docs/reference/api/SearchCollector.md create mode 100644 docs/reference/api/SearchCompletionContext.md create mode 100644 docs/reference/api/SearchCompletionSuggest.md create mode 100644 docs/reference/api/SearchCompletionSuggestOption.md create mode 100644 docs/reference/api/SearchCompletionSuggester.md create mode 100644 docs/reference/api/SearchContext.md create mode 100644 docs/reference/api/SearchDfsKnnProfile.md create mode 100644 docs/reference/api/SearchDfsProfile.md create mode 100644 docs/reference/api/SearchDfsStatisticsBreakdown.md create mode 100644 docs/reference/api/SearchDfsStatisticsProfile.md create mode 100644 docs/reference/api/SearchDirectGenerator.md create mode 100644 docs/reference/api/SearchFetchProfile.md create mode 100644 docs/reference/api/SearchFetchProfileBreakdown.md create mode 100644 docs/reference/api/SearchFetchProfileDebug.md create mode 100644 docs/reference/api/SearchFieldCollapse.md create mode 100644 docs/reference/api/SearchFieldSuggester.md create mode 100644 docs/reference/api/SearchHighlight.md create mode 100644 docs/reference/api/SearchHighlightBase.md create mode 100644 docs/reference/api/SearchHighlightField.md create mode 100644 docs/reference/api/SearchHighlighterEncoder.md create mode 100644 docs/reference/api/SearchHighlighterFragmenter.md create mode 100644 docs/reference/api/SearchHighlighterOrder.md create mode 100644 docs/reference/api/SearchHighlighterTagsSchema.md create mode 100644 docs/reference/api/SearchHighlighterType.md create mode 100644 docs/reference/api/SearchHit.md create mode 100644 docs/reference/api/SearchHitsMetadata.md create mode 100644 docs/reference/api/SearchInnerHits.md create mode 100644 docs/reference/api/SearchInnerHitsResult.md create mode 100644 docs/reference/api/SearchKnnCollectorResult.md create mode 100644 docs/reference/api/SearchKnnQueryProfileBreakdown.md create mode 100644 docs/reference/api/SearchKnnQueryProfileResult.md create mode 100644 docs/reference/api/SearchLaplaceSmoothingModel.md create mode 100644 docs/reference/api/SearchLearningToRank.md create mode 100644 docs/reference/api/SearchLinearInterpolationSmoothingModel.md create mode 100644 docs/reference/api/SearchMvtApi_1.md create mode 100644 docs/reference/api/SearchMvtApi_2.md create mode 100644 docs/reference/api/SearchMvtApi_3.md create mode 100644 docs/reference/api/SearchMvtCoordinate.md create mode 100644 docs/reference/api/SearchMvtGridAggregationType.md create mode 100644 docs/reference/api/SearchMvtGridType.md create mode 100644 docs/reference/api/SearchMvtRequest.md create mode 100644 docs/reference/api/SearchMvtResponse.md create mode 100644 docs/reference/api/SearchMvtZoomLevel.md create mode 100644 docs/reference/api/SearchNestedIdentity.md create mode 100644 docs/reference/api/SearchPhraseSuggest.md create mode 100644 docs/reference/api/SearchPhraseSuggestCollate.md create mode 100644 docs/reference/api/SearchPhraseSuggestCollateQuery.md create mode 100644 docs/reference/api/SearchPhraseSuggestHighlight.md create mode 100644 docs/reference/api/SearchPhraseSuggestOption.md create mode 100644 docs/reference/api/SearchPhraseSuggester.md create mode 100644 docs/reference/api/SearchPointInTimeReference.md create mode 100644 docs/reference/api/SearchProfile.md create mode 100644 docs/reference/api/SearchQueryBreakdown.md create mode 100644 docs/reference/api/SearchQueryProfile.md create mode 100644 docs/reference/api/SearchRegexOptions.md create mode 100644 docs/reference/api/SearchRequest.md create mode 100644 docs/reference/api/SearchRescore.md create mode 100644 docs/reference/api/SearchRescoreQuery.md create mode 100644 docs/reference/api/SearchResponse.md create mode 100644 docs/reference/api/SearchResponseBody.md create mode 100644 docs/reference/api/SearchScoreMode.md create mode 100644 docs/reference/api/SearchSearchProfile.md create mode 100644 docs/reference/api/SearchSearchRequestBody.md create mode 100644 docs/reference/api/SearchShardProfile.md create mode 100644 docs/reference/api/SearchShardsApi_1.md create mode 100644 docs/reference/api/SearchShardsApi_2.md create mode 100644 docs/reference/api/SearchShardsApi_3.md create mode 100644 docs/reference/api/SearchShardsRequest.md create mode 100644 docs/reference/api/SearchShardsResponse.md create mode 100644 docs/reference/api/SearchShardsSearchShardsNodeAttributes.md create mode 100644 docs/reference/api/SearchShardsShardStoreIndex.md create mode 100644 docs/reference/api/SearchSmoothingModelContainer.md create mode 100644 docs/reference/api/SearchSourceConfig.md create mode 100644 docs/reference/api/SearchSourceConfigParam.md create mode 100644 docs/reference/api/SearchSourceFilter.md create mode 100644 docs/reference/api/SearchStats.md create mode 100644 docs/reference/api/SearchStringDistance.md create mode 100644 docs/reference/api/SearchStupidBackoffSmoothingModel.md create mode 100644 docs/reference/api/SearchSuggest.md create mode 100644 docs/reference/api/SearchSuggestBase.md create mode 100644 docs/reference/api/SearchSuggestFuzziness.md create mode 100644 docs/reference/api/SearchSuggestSort.md create mode 100644 docs/reference/api/SearchSuggester.md create mode 100644 docs/reference/api/SearchSuggesterBase.md create mode 100644 docs/reference/api/SearchSuggesterKeys.md create mode 100644 docs/reference/api/SearchTemplateApi_1.md create mode 100644 docs/reference/api/SearchTemplateApi_2.md create mode 100644 docs/reference/api/SearchTemplateApi_3.md create mode 100644 docs/reference/api/SearchTemplateRequest.md create mode 100644 docs/reference/api/SearchTemplateResponse.md create mode 100644 docs/reference/api/SearchTermSuggest.md create mode 100644 docs/reference/api/SearchTermSuggestOption.md create mode 100644 docs/reference/api/SearchTermSuggester.md create mode 100644 docs/reference/api/SearchTotalHits.md create mode 100644 docs/reference/api/SearchTotalHitsRelation.md create mode 100644 docs/reference/api/SearchTrackHits.md create mode 100644 docs/reference/api/SearchTransform.md create mode 100644 docs/reference/api/SearchType.md create mode 100644 docs/reference/api/SearchableSnapshots.md create mode 100644 docs/reference/api/SearchableSnapshotsCacheStatsNode.md create mode 100644 docs/reference/api/SearchableSnapshotsCacheStatsRequest.md create mode 100644 docs/reference/api/SearchableSnapshotsCacheStatsResponse.md create mode 100644 docs/reference/api/SearchableSnapshotsCacheStatsShared.md create mode 100644 docs/reference/api/SearchableSnapshotsClearCacheRequest.md create mode 100644 docs/reference/api/SearchableSnapshotsClearCacheResponse.md create mode 100644 docs/reference/api/SearchableSnapshotsMountMountedSnapshot.md create mode 100644 docs/reference/api/SearchableSnapshotsMountRequest.md create mode 100644 docs/reference/api/SearchableSnapshotsMountResponse.md create mode 100644 docs/reference/api/SearchableSnapshotsStatsLevel.md create mode 100644 docs/reference/api/SearchableSnapshotsStatsRequest.md create mode 100644 docs/reference/api/SearchableSnapshotsStatsResponse.md create mode 100644 docs/reference/api/Security.md create mode 100644 docs/reference/api/SecurityAccess.md create mode 100644 docs/reference/api/SecurityActivateUserProfileRequest.md create mode 100644 docs/reference/api/SecurityActivateUserProfileResponse.md create mode 100644 docs/reference/api/SecurityApiKey.md create mode 100644 docs/reference/api/SecurityApiKeyType.md create mode 100644 docs/reference/api/SecurityApplicationGlobalUserPrivileges.md create mode 100644 docs/reference/api/SecurityApplicationPrivileges.md create mode 100644 docs/reference/api/SecurityAuthenticateAuthenticateApiKey.md create mode 100644 docs/reference/api/SecurityAuthenticateRequest.md create mode 100644 docs/reference/api/SecurityAuthenticateResponse.md create mode 100644 docs/reference/api/SecurityAuthenticateToken.md create mode 100644 docs/reference/api/SecurityBulkDeleteRoleRequest.md create mode 100644 docs/reference/api/SecurityBulkDeleteRoleResponse.md create mode 100644 docs/reference/api/SecurityBulkError.md create mode 100644 docs/reference/api/SecurityBulkPutRoleRequest.md create mode 100644 docs/reference/api/SecurityBulkPutRoleResponse.md create mode 100644 docs/reference/api/SecurityBulkUpdateApiKeysRequest.md create mode 100644 docs/reference/api/SecurityBulkUpdateApiKeysResponse.md create mode 100644 docs/reference/api/SecurityChangePasswordRequest.md create mode 100644 docs/reference/api/SecurityChangePasswordResponse.md create mode 100644 docs/reference/api/SecurityClearApiKeyCacheRequest.md create mode 100644 docs/reference/api/SecurityClearApiKeyCacheResponse.md create mode 100644 docs/reference/api/SecurityClearCachedPrivilegesRequest.md create mode 100644 docs/reference/api/SecurityClearCachedPrivilegesResponse.md create mode 100644 docs/reference/api/SecurityClearCachedRealmsRequest.md create mode 100644 docs/reference/api/SecurityClearCachedRealmsResponse.md create mode 100644 docs/reference/api/SecurityClearCachedRolesRequest.md create mode 100644 docs/reference/api/SecurityClearCachedRolesResponse.md create mode 100644 docs/reference/api/SecurityClearCachedServiceTokensRequest.md create mode 100644 docs/reference/api/SecurityClearCachedServiceTokensResponse.md create mode 100644 docs/reference/api/SecurityClusterNode.md create mode 100644 docs/reference/api/SecurityClusterPrivilege.md create mode 100644 docs/reference/api/SecurityCreateApiKeyRequest.md create mode 100644 docs/reference/api/SecurityCreateApiKeyResponse.md create mode 100644 docs/reference/api/SecurityCreateCrossClusterApiKeyRequest.md create mode 100644 docs/reference/api/SecurityCreateCrossClusterApiKeyResponse.md create mode 100644 docs/reference/api/SecurityCreateServiceTokenRequest.md create mode 100644 docs/reference/api/SecurityCreateServiceTokenResponse.md create mode 100644 docs/reference/api/SecurityCreateServiceTokenToken.md create mode 100644 docs/reference/api/SecurityCreatedStatus.md create mode 100644 docs/reference/api/SecurityDelegatePkiAuthentication.md create mode 100644 docs/reference/api/SecurityDelegatePkiAuthenticationRealm.md create mode 100644 docs/reference/api/SecurityDelegatePkiRequest.md create mode 100644 docs/reference/api/SecurityDelegatePkiResponse.md create mode 100644 docs/reference/api/SecurityDeletePrivilegesFoundStatus.md create mode 100644 docs/reference/api/SecurityDeletePrivilegesRequest.md create mode 100644 docs/reference/api/SecurityDeletePrivilegesResponse.md create mode 100644 docs/reference/api/SecurityDeleteRoleMappingRequest.md create mode 100644 docs/reference/api/SecurityDeleteRoleMappingResponse.md create mode 100644 docs/reference/api/SecurityDeleteRoleRequest.md create mode 100644 docs/reference/api/SecurityDeleteRoleResponse.md create mode 100644 docs/reference/api/SecurityDeleteServiceTokenRequest.md create mode 100644 docs/reference/api/SecurityDeleteServiceTokenResponse.md create mode 100644 docs/reference/api/SecurityDeleteUserRequest.md create mode 100644 docs/reference/api/SecurityDeleteUserResponse.md create mode 100644 docs/reference/api/SecurityDisableUserProfileRequest.md create mode 100644 docs/reference/api/SecurityDisableUserProfileResponse.md create mode 100644 docs/reference/api/SecurityDisableUserRequest.md create mode 100644 docs/reference/api/SecurityDisableUserResponse.md create mode 100644 docs/reference/api/SecurityEnableUserProfileRequest.md create mode 100644 docs/reference/api/SecurityEnableUserProfileResponse.md create mode 100644 docs/reference/api/SecurityEnableUserRequest.md create mode 100644 docs/reference/api/SecurityEnableUserResponse.md create mode 100644 docs/reference/api/SecurityEnrollKibanaRequest.md create mode 100644 docs/reference/api/SecurityEnrollKibanaResponse.md create mode 100644 docs/reference/api/SecurityEnrollKibanaToken.md create mode 100644 docs/reference/api/SecurityEnrollNodeRequest.md create mode 100644 docs/reference/api/SecurityEnrollNodeResponse.md create mode 100644 docs/reference/api/SecurityFieldSecurity.md create mode 100644 docs/reference/api/SecurityGetApiKeyRequest.md create mode 100644 docs/reference/api/SecurityGetApiKeyResponse.md create mode 100644 docs/reference/api/SecurityGetBuiltinPrivilegesRequest.md create mode 100644 docs/reference/api/SecurityGetBuiltinPrivilegesResponse.md create mode 100644 docs/reference/api/SecurityGetPrivilegesRequest.md create mode 100644 docs/reference/api/SecurityGetPrivilegesResponse.md create mode 100644 docs/reference/api/SecurityGetRoleMappingRequest.md create mode 100644 docs/reference/api/SecurityGetRoleMappingResponse.md create mode 100644 docs/reference/api/SecurityGetRoleRequest.md create mode 100644 docs/reference/api/SecurityGetRoleResponse.md create mode 100644 docs/reference/api/SecurityGetRoleRole.md create mode 100644 docs/reference/api/SecurityGetServiceAccountsRequest.md create mode 100644 docs/reference/api/SecurityGetServiceAccountsResponse.md create mode 100644 docs/reference/api/SecurityGetServiceAccountsRoleDescriptorWrapper.md create mode 100644 docs/reference/api/SecurityGetServiceCredentialsNodesCredentials.md create mode 100644 docs/reference/api/SecurityGetServiceCredentialsNodesCredentialsFileToken.md create mode 100644 docs/reference/api/SecurityGetServiceCredentialsRequest.md create mode 100644 docs/reference/api/SecurityGetServiceCredentialsResponse.md create mode 100644 docs/reference/api/SecurityGetSettingsRequest.md create mode 100644 docs/reference/api/SecurityGetSettingsResponse.md create mode 100644 docs/reference/api/SecurityGetTokenAccessTokenGrantType.md create mode 100644 docs/reference/api/SecurityGetTokenAuthenticatedUser.md create mode 100644 docs/reference/api/SecurityGetTokenAuthenticationProvider.md create mode 100644 docs/reference/api/SecurityGetTokenRequest.md create mode 100644 docs/reference/api/SecurityGetTokenResponse.md create mode 100644 docs/reference/api/SecurityGetTokenUserRealm.md create mode 100644 docs/reference/api/SecurityGetUserPrivilegesRequest.md create mode 100644 docs/reference/api/SecurityGetUserPrivilegesResponse.md create mode 100644 docs/reference/api/SecurityGetUserProfileGetUserProfileErrors.md create mode 100644 docs/reference/api/SecurityGetUserProfileRequest.md create mode 100644 docs/reference/api/SecurityGetUserProfileResponse.md create mode 100644 docs/reference/api/SecurityGetUserRequest.md create mode 100644 docs/reference/api/SecurityGetUserResponse.md create mode 100644 docs/reference/api/SecurityGlobalPrivilege.md create mode 100644 docs/reference/api/SecurityGrantApiKeyApiKeyGrantType.md create mode 100644 docs/reference/api/SecurityGrantApiKeyGrantApiKey.md create mode 100644 docs/reference/api/SecurityGrantApiKeyRequest.md create mode 100644 docs/reference/api/SecurityGrantApiKeyResponse.md create mode 100644 docs/reference/api/SecurityGrantType.md create mode 100644 docs/reference/api/SecurityHasPrivilegesApplicationPrivilegesCheck.md create mode 100644 docs/reference/api/SecurityHasPrivilegesApplicationsPrivileges.md create mode 100644 docs/reference/api/SecurityHasPrivilegesIndexPrivilegesCheck.md create mode 100644 docs/reference/api/SecurityHasPrivilegesPrivileges.md create mode 100644 docs/reference/api/SecurityHasPrivilegesRequest.md create mode 100644 docs/reference/api/SecurityHasPrivilegesResourcePrivileges.md create mode 100644 docs/reference/api/SecurityHasPrivilegesResponse.md create mode 100644 docs/reference/api/SecurityHasPrivilegesUserProfileHasPrivilegesUserProfileErrors.md create mode 100644 docs/reference/api/SecurityHasPrivilegesUserProfilePrivilegesCheck.md create mode 100644 docs/reference/api/SecurityHasPrivilegesUserProfileRequest.md create mode 100644 docs/reference/api/SecurityHasPrivilegesUserProfileResponse.md create mode 100644 docs/reference/api/SecurityIndexPrivilege.md create mode 100644 docs/reference/api/SecurityIndicesPrivileges.md create mode 100644 docs/reference/api/SecurityIndicesPrivilegesQuery.md create mode 100644 docs/reference/api/SecurityInvalidateApiKeyRequest.md create mode 100644 docs/reference/api/SecurityInvalidateApiKeyResponse.md create mode 100644 docs/reference/api/SecurityInvalidateTokenRequest.md create mode 100644 docs/reference/api/SecurityInvalidateTokenResponse.md create mode 100644 docs/reference/api/SecurityManageUserPrivileges.md create mode 100644 docs/reference/api/SecurityOidcAuthenticateRequest.md create mode 100644 docs/reference/api/SecurityOidcAuthenticateResponse.md create mode 100644 docs/reference/api/SecurityOidcLogoutRequest.md create mode 100644 docs/reference/api/SecurityOidcLogoutResponse.md create mode 100644 docs/reference/api/SecurityOidcPrepareAuthenticationRequest.md create mode 100644 docs/reference/api/SecurityOidcPrepareAuthenticationResponse.md create mode 100644 docs/reference/api/SecurityPutPrivilegesActions.md create mode 100644 docs/reference/api/SecurityPutPrivilegesRequest.md create mode 100644 docs/reference/api/SecurityPutPrivilegesResponse.md create mode 100644 docs/reference/api/SecurityPutRoleMappingRequest.md create mode 100644 docs/reference/api/SecurityPutRoleMappingResponse.md create mode 100644 docs/reference/api/SecurityPutRoleRequest.md create mode 100644 docs/reference/api/SecurityPutRoleResponse.md create mode 100644 docs/reference/api/SecurityPutUserRequest.md create mode 100644 docs/reference/api/SecurityPutUserResponse.md create mode 100644 docs/reference/api/SecurityQueryApiKeysApiKeyAggregate.md create mode 100644 docs/reference/api/SecurityQueryApiKeysApiKeyAggregationContainer.md create mode 100644 docs/reference/api/SecurityQueryApiKeysApiKeyFiltersAggregation.md create mode 100644 docs/reference/api/SecurityQueryApiKeysApiKeyQueryContainer.md create mode 100644 docs/reference/api/SecurityQueryApiKeysRequest.md create mode 100644 docs/reference/api/SecurityQueryApiKeysResponse.md create mode 100644 docs/reference/api/SecurityQueryRoleQueryRole.md create mode 100644 docs/reference/api/SecurityQueryRoleRequest.md create mode 100644 docs/reference/api/SecurityQueryRoleResponse.md create mode 100644 docs/reference/api/SecurityQueryRoleRoleQueryContainer.md create mode 100644 docs/reference/api/SecurityQueryUserQueryUser.md create mode 100644 docs/reference/api/SecurityQueryUserRequest.md create mode 100644 docs/reference/api/SecurityQueryUserResponse.md create mode 100644 docs/reference/api/SecurityQueryUserUserQueryContainer.md create mode 100644 docs/reference/api/SecurityRealmInfo.md create mode 100644 docs/reference/api/SecurityRemoteClusterPrivilege.md create mode 100644 docs/reference/api/SecurityRemoteClusterPrivileges.md create mode 100644 docs/reference/api/SecurityRemoteIndicesPrivileges.md create mode 100644 docs/reference/api/SecurityRemoteUserIndicesPrivileges.md create mode 100644 docs/reference/api/SecurityReplicationAccess.md create mode 100644 docs/reference/api/SecurityRestriction.md create mode 100644 docs/reference/api/SecurityRestrictionWorkflow.md create mode 100644 docs/reference/api/SecurityRoleDescriptor.md create mode 100644 docs/reference/api/SecurityRoleDescriptorRead.md create mode 100644 docs/reference/api/SecurityRoleMapping.md create mode 100644 docs/reference/api/SecurityRoleMappingRule.md create mode 100644 docs/reference/api/SecurityRoleTemplate.md create mode 100644 docs/reference/api/SecurityRoleTemplateInlineQuery.md create mode 100644 docs/reference/api/SecurityRoleTemplateQuery.md create mode 100644 docs/reference/api/SecurityRoleTemplateScript.md create mode 100644 docs/reference/api/SecuritySamlAuthenticateRequest.md create mode 100644 docs/reference/api/SecuritySamlAuthenticateResponse.md create mode 100644 docs/reference/api/SecuritySamlCompleteLogoutRequest.md create mode 100644 docs/reference/api/SecuritySamlCompleteLogoutResponse.md create mode 100644 docs/reference/api/SecuritySamlInvalidateRequest.md create mode 100644 docs/reference/api/SecuritySamlInvalidateResponse.md create mode 100644 docs/reference/api/SecuritySamlLogoutRequest.md create mode 100644 docs/reference/api/SecuritySamlLogoutResponse.md create mode 100644 docs/reference/api/SecuritySamlPrepareAuthenticationRequest.md create mode 100644 docs/reference/api/SecuritySamlPrepareAuthenticationResponse.md create mode 100644 docs/reference/api/SecuritySamlServiceProviderMetadataRequest.md create mode 100644 docs/reference/api/SecuritySamlServiceProviderMetadataResponse.md create mode 100644 docs/reference/api/SecuritySearchAccess.md create mode 100644 docs/reference/api/SecuritySecuritySettings.md create mode 100644 docs/reference/api/SecuritySuggestUserProfilesHint.md create mode 100644 docs/reference/api/SecuritySuggestUserProfilesRequest.md create mode 100644 docs/reference/api/SecuritySuggestUserProfilesResponse.md create mode 100644 docs/reference/api/SecuritySuggestUserProfilesTotalUserProfiles.md create mode 100644 docs/reference/api/SecurityTemplateFormat.md create mode 100644 docs/reference/api/SecurityUpdateApiKeyRequest.md create mode 100644 docs/reference/api/SecurityUpdateApiKeyResponse.md create mode 100644 docs/reference/api/SecurityUpdateCrossClusterApiKeyRequest.md create mode 100644 docs/reference/api/SecurityUpdateCrossClusterApiKeyResponse.md create mode 100644 docs/reference/api/SecurityUpdateSettingsRequest.md create mode 100644 docs/reference/api/SecurityUpdateSettingsResponse.md create mode 100644 docs/reference/api/SecurityUpdateUserProfileDataRequest.md create mode 100644 docs/reference/api/SecurityUpdateUserProfileDataResponse.md create mode 100644 docs/reference/api/SecurityUser.md create mode 100644 docs/reference/api/SecurityUserIndicesPrivileges.md create mode 100644 docs/reference/api/SecurityUserProfile.md create mode 100644 docs/reference/api/SecurityUserProfileHitMetadata.md create mode 100644 docs/reference/api/SecurityUserProfileId.md create mode 100644 docs/reference/api/SecurityUserProfileUser.md create mode 100644 docs/reference/api/SecurityUserProfileWithMetadata.md create mode 100644 docs/reference/api/SegmentsStats.md create mode 100644 docs/reference/api/SequenceNumber.md create mode 100644 docs/reference/api/Service.md create mode 100644 docs/reference/api/ShardFailure.md create mode 100644 docs/reference/api/ShardStatistics.md create mode 100644 docs/reference/api/ShardsOperationResponseBase.md create mode 100644 docs/reference/api/Shutdown.md create mode 100644 docs/reference/api/ShutdownDeleteNodeRequest.md create mode 100644 docs/reference/api/ShutdownDeleteNodeResponse.md create mode 100644 docs/reference/api/ShutdownGetNodeNodeShutdownStatus.md create mode 100644 docs/reference/api/ShutdownGetNodePersistentTaskStatus.md create mode 100644 docs/reference/api/ShutdownGetNodePluginsStatus.md create mode 100644 docs/reference/api/ShutdownGetNodeRequest.md create mode 100644 docs/reference/api/ShutdownGetNodeResponse.md create mode 100644 docs/reference/api/ShutdownGetNodeShardMigrationStatus.md create mode 100644 docs/reference/api/ShutdownGetNodeShutdownStatus.md create mode 100644 docs/reference/api/ShutdownGetNodeShutdownType.md create mode 100644 docs/reference/api/ShutdownPutNodeRequest.md create mode 100644 docs/reference/api/ShutdownPutNodeResponse.md create mode 100644 docs/reference/api/ShutdownType.md create mode 100644 docs/reference/api/Simulate.md create mode 100644 docs/reference/api/SimulateIngestIngestDocumentSimulation.md create mode 100644 docs/reference/api/SimulateIngestIngestDocumentSimulationKeys.md create mode 100644 docs/reference/api/SimulateIngestRequest.md create mode 100644 docs/reference/api/SimulateIngestResponse.md create mode 100644 docs/reference/api/SimulateIngestSimulateIngestDocumentResult.md create mode 100644 docs/reference/api/SlicedScroll.md create mode 100644 docs/reference/api/Slices.md create mode 100644 docs/reference/api/SlicesCalculation.md create mode 100644 docs/reference/api/Slm.md create mode 100644 docs/reference/api/SlmConfiguration.md create mode 100644 docs/reference/api/SlmDeleteLifecycleRequest.md create mode 100644 docs/reference/api/SlmDeleteLifecycleResponse.md create mode 100644 docs/reference/api/SlmExecuteLifecycleRequest.md create mode 100644 docs/reference/api/SlmExecuteLifecycleResponse.md create mode 100644 docs/reference/api/SlmExecuteRetentionRequest.md create mode 100644 docs/reference/api/SlmExecuteRetentionResponse.md create mode 100644 docs/reference/api/SlmGetLifecycleRequest.md create mode 100644 docs/reference/api/SlmGetLifecycleResponse.md create mode 100644 docs/reference/api/SlmGetStatsRequest.md create mode 100644 docs/reference/api/SlmGetStatsResponse.md create mode 100644 docs/reference/api/SlmGetStatusRequest.md create mode 100644 docs/reference/api/SlmGetStatusResponse.md create mode 100644 docs/reference/api/SlmInProgress.md create mode 100644 docs/reference/api/SlmInvocation.md create mode 100644 docs/reference/api/SlmPolicy.md create mode 100644 docs/reference/api/SlmPutLifecycleRequest.md create mode 100644 docs/reference/api/SlmPutLifecycleResponse.md create mode 100644 docs/reference/api/SlmRetention.md create mode 100644 docs/reference/api/SlmSnapshotLifecycle.md create mode 100644 docs/reference/api/SlmStartRequest.md create mode 100644 docs/reference/api/SlmStartResponse.md create mode 100644 docs/reference/api/SlmStatistics.md create mode 100644 docs/reference/api/SlmStopRequest.md create mode 100644 docs/reference/api/SlmStopResponse.md create mode 100644 docs/reference/api/Snapshot.md create mode 100644 docs/reference/api/SnapshotAzureRepository.md create mode 100644 docs/reference/api/SnapshotAzureRepositorySettings.md create mode 100644 docs/reference/api/SnapshotCleanupRepositoryCleanupRepositoryResults.md create mode 100644 docs/reference/api/SnapshotCleanupRepositoryRequest.md create mode 100644 docs/reference/api/SnapshotCleanupRepositoryResponse.md create mode 100644 docs/reference/api/SnapshotCloneRequest.md create mode 100644 docs/reference/api/SnapshotCloneResponse.md create mode 100644 docs/reference/api/SnapshotCreateRepositoryRequest.md create mode 100644 docs/reference/api/SnapshotCreateRepositoryResponse.md create mode 100644 docs/reference/api/SnapshotCreateRequest.md create mode 100644 docs/reference/api/SnapshotCreateResponse.md create mode 100644 docs/reference/api/SnapshotDeleteRepositoryRequest.md create mode 100644 docs/reference/api/SnapshotDeleteRepositoryResponse.md create mode 100644 docs/reference/api/SnapshotDeleteRequest.md create mode 100644 docs/reference/api/SnapshotDeleteResponse.md create mode 100644 docs/reference/api/SnapshotFileCountSnapshotStats.md create mode 100644 docs/reference/api/SnapshotGcsRepository.md create mode 100644 docs/reference/api/SnapshotGcsRepositorySettings.md create mode 100644 docs/reference/api/SnapshotGetRepositoryRequest.md create mode 100644 docs/reference/api/SnapshotGetRepositoryResponse.md create mode 100644 docs/reference/api/SnapshotGetRequest.md create mode 100644 docs/reference/api/SnapshotGetResponse.md create mode 100644 docs/reference/api/SnapshotGetSnapshotResponseItem.md create mode 100644 docs/reference/api/SnapshotIndexDetails.md create mode 100644 docs/reference/api/SnapshotInfoFeatureState.md create mode 100644 docs/reference/api/SnapshotReadOnlyUrlRepository.md create mode 100644 docs/reference/api/SnapshotReadOnlyUrlRepositorySettings.md create mode 100644 docs/reference/api/SnapshotRepository.md create mode 100644 docs/reference/api/SnapshotRepositoryAnalyzeBlobDetails.md create mode 100644 docs/reference/api/SnapshotRepositoryAnalyzeDetailsInfo.md create mode 100644 docs/reference/api/SnapshotRepositoryAnalyzeReadBlobDetails.md create mode 100644 docs/reference/api/SnapshotRepositoryAnalyzeReadSummaryInfo.md create mode 100644 docs/reference/api/SnapshotRepositoryAnalyzeRequest.md create mode 100644 docs/reference/api/SnapshotRepositoryAnalyzeResponse.md create mode 100644 docs/reference/api/SnapshotRepositoryAnalyzeSnapshotNodeInfo.md create mode 100644 docs/reference/api/SnapshotRepositoryAnalyzeSummaryInfo.md create mode 100644 docs/reference/api/SnapshotRepositoryAnalyzeWriteSummaryInfo.md create mode 100644 docs/reference/api/SnapshotRepositoryBase.md create mode 100644 docs/reference/api/SnapshotRepositorySettingsBase.md create mode 100644 docs/reference/api/SnapshotRepositoryVerifyIntegrityRequest.md create mode 100644 docs/reference/api/SnapshotRepositoryVerifyIntegrityResponse.md create mode 100644 docs/reference/api/SnapshotRestoreRequest.md create mode 100644 docs/reference/api/SnapshotRestoreResponse.md create mode 100644 docs/reference/api/SnapshotRestoreSnapshotRestore.md create mode 100644 docs/reference/api/SnapshotS3Repository.md create mode 100644 docs/reference/api/SnapshotS3RepositorySettings.md create mode 100644 docs/reference/api/SnapshotShardsStats.md create mode 100644 docs/reference/api/SnapshotShardsStatsStage.md create mode 100644 docs/reference/api/SnapshotShardsStatsSummary.md create mode 100644 docs/reference/api/SnapshotShardsStatsSummaryItem.md create mode 100644 docs/reference/api/SnapshotSharedFileSystemRepository.md create mode 100644 docs/reference/api/SnapshotSharedFileSystemRepositorySettings.md create mode 100644 docs/reference/api/SnapshotSnapshotIndexStats.md create mode 100644 docs/reference/api/SnapshotSnapshotInfo.md create mode 100644 docs/reference/api/SnapshotSnapshotShardFailure.md create mode 100644 docs/reference/api/SnapshotSnapshotShardsStatus.md create mode 100644 docs/reference/api/SnapshotSnapshotSort.md create mode 100644 docs/reference/api/SnapshotSnapshotStats.md create mode 100644 docs/reference/api/SnapshotSourceOnlyRepository.md create mode 100644 docs/reference/api/SnapshotSourceOnlyRepositorySettings.md create mode 100644 docs/reference/api/SnapshotStatus.md create mode 100644 docs/reference/api/SnapshotStatusRequest.md create mode 100644 docs/reference/api/SnapshotStatusResponse.md create mode 100644 docs/reference/api/SnapshotVerifyRepositoryCompactNodeInfo.md create mode 100644 docs/reference/api/SnapshotVerifyRepositoryRequest.md create mode 100644 docs/reference/api/SnapshotVerifyRepositoryResponse.md create mode 100644 docs/reference/api/SniffingTransport.md create mode 100644 docs/reference/api/Sort.md create mode 100644 docs/reference/api/SortCombinations.md create mode 100644 docs/reference/api/SortMode.md create mode 100644 docs/reference/api/SortOptions.md create mode 100644 docs/reference/api/SortOptionsKeys.md create mode 100644 docs/reference/api/SortOrder.md create mode 100644 docs/reference/api/SortResults.md create mode 100644 docs/reference/api/SpecUtilsAdditionalProperties.md create mode 100644 docs/reference/api/SpecUtilsAdditionalProperty.md create mode 100644 docs/reference/api/SpecUtilsBaseNode.md create mode 100644 docs/reference/api/SpecUtilsCommonCatQueryParameters.md create mode 100644 docs/reference/api/SpecUtilsCommonQueryParameters.md create mode 100644 docs/reference/api/SpecUtilsNullValue.md create mode 100644 docs/reference/api/SpecUtilsOverloadOf.md create mode 100644 docs/reference/api/SpecUtilsPipeSeparatedFlags.md create mode 100644 docs/reference/api/SpecUtilsStringified.md create mode 100644 docs/reference/api/SpecUtilsWithNullValue.md create mode 100644 docs/reference/api/Sql.md create mode 100644 docs/reference/api/SqlClearCursorRequest.md create mode 100644 docs/reference/api/SqlClearCursorResponse.md create mode 100644 docs/reference/api/SqlColumn.md create mode 100644 docs/reference/api/SqlDeleteAsyncRequest.md create mode 100644 docs/reference/api/SqlDeleteAsyncResponse.md create mode 100644 docs/reference/api/SqlGetAsyncRequest.md create mode 100644 docs/reference/api/SqlGetAsyncResponse.md create mode 100644 docs/reference/api/SqlGetAsyncStatusRequest.md create mode 100644 docs/reference/api/SqlGetAsyncStatusResponse.md create mode 100644 docs/reference/api/SqlQueryRequest.md create mode 100644 docs/reference/api/SqlQueryResponse.md create mode 100644 docs/reference/api/SqlQuerySqlFormat.md create mode 100644 docs/reference/api/SqlRow.md create mode 100644 docs/reference/api/SqlTranslateRequest.md create mode 100644 docs/reference/api/SqlTranslateResponse.md create mode 100644 docs/reference/api/Ssl.md create mode 100644 docs/reference/api/SslCertificatesCertificateInformation.md create mode 100644 docs/reference/api/SslCertificatesRequest.md create mode 100644 docs/reference/api/SslCertificatesResponse.md create mode 100644 docs/reference/api/StandardRetriever.md create mode 100644 docs/reference/api/StoreStats.md create mode 100644 docs/reference/api/StoredScript.md create mode 100644 docs/reference/api/StreamResult.md create mode 100644 docs/reference/api/SuggestMode.md create mode 100644 docs/reference/api/SuggestionName.md create mode 100644 docs/reference/api/Synonyms.md create mode 100644 docs/reference/api/SynonymsDeleteSynonymRequest.md create mode 100644 docs/reference/api/SynonymsDeleteSynonymResponse.md create mode 100644 docs/reference/api/SynonymsDeleteSynonymRuleRequest.md create mode 100644 docs/reference/api/SynonymsDeleteSynonymRuleResponse.md create mode 100644 docs/reference/api/SynonymsGetSynonymRequest.md create mode 100644 docs/reference/api/SynonymsGetSynonymResponse.md create mode 100644 docs/reference/api/SynonymsGetSynonymRuleRequest.md create mode 100644 docs/reference/api/SynonymsGetSynonymRuleResponse.md create mode 100644 docs/reference/api/SynonymsGetSynonymsSetsRequest.md create mode 100644 docs/reference/api/SynonymsGetSynonymsSetsResponse.md create mode 100644 docs/reference/api/SynonymsGetSynonymsSetsSynonymsSetItem.md create mode 100644 docs/reference/api/SynonymsPutSynonymRequest.md create mode 100644 docs/reference/api/SynonymsPutSynonymResponse.md create mode 100644 docs/reference/api/SynonymsPutSynonymRuleRequest.md create mode 100644 docs/reference/api/SynonymsPutSynonymRuleResponse.md create mode 100644 docs/reference/api/SynonymsSynonymRule.md create mode 100644 docs/reference/api/SynonymsSynonymRuleRead.md create mode 100644 docs/reference/api/SynonymsSynonymString.md create mode 100644 docs/reference/api/SynonymsSynonymsUpdateResult.md create mode 100644 docs/reference/api/TODO.md create mode 100644 docs/reference/api/TaskFailure.md create mode 100644 docs/reference/api/TaskId.md create mode 100644 docs/reference/api/Tasks.md create mode 100644 docs/reference/api/TasksCancelRequest.md create mode 100644 docs/reference/api/TasksCancelResponse.md create mode 100644 docs/reference/api/TasksGetRequest.md create mode 100644 docs/reference/api/TasksGetResponse.md create mode 100644 docs/reference/api/TasksGroupBy.md create mode 100644 docs/reference/api/TasksListRequest.md create mode 100644 docs/reference/api/TasksListResponse.md create mode 100644 docs/reference/api/TasksNodeTasks.md create mode 100644 docs/reference/api/TasksParentTaskInfo.md create mode 100644 docs/reference/api/TasksTaskInfo.md create mode 100644 docs/reference/api/TasksTaskInfos.md create mode 100644 docs/reference/api/TasksTaskListResponseBase.md create mode 100644 docs/reference/api/TermsEnumApi_1.md create mode 100644 docs/reference/api/TermsEnumApi_2.md create mode 100644 docs/reference/api/TermsEnumApi_3.md create mode 100644 docs/reference/api/TermsEnumRequest.md create mode 100644 docs/reference/api/TermsEnumResponse.md create mode 100644 docs/reference/api/TermvectorsApi_1.md create mode 100644 docs/reference/api/TermvectorsApi_2.md create mode 100644 docs/reference/api/TermvectorsApi_3.md create mode 100644 docs/reference/api/TermvectorsFieldStatistics.md create mode 100644 docs/reference/api/TermvectorsFilter.md create mode 100644 docs/reference/api/TermvectorsRequest.md create mode 100644 docs/reference/api/TermvectorsResponse.md create mode 100644 docs/reference/api/TermvectorsTerm.md create mode 100644 docs/reference/api/TermvectorsTermVector.md create mode 100644 docs/reference/api/TermvectorsToken.md create mode 100644 docs/reference/api/TextEmbedding.md create mode 100644 docs/reference/api/TextSimilarityReranker.md create mode 100644 docs/reference/api/TextStructure.md create mode 100644 docs/reference/api/TextStructureEcsCompatibilityType.md create mode 100644 docs/reference/api/TextStructureFieldStat.md create mode 100644 docs/reference/api/TextStructureFindFieldStructureRequest.md create mode 100644 docs/reference/api/TextStructureFindFieldStructureResponse.md create mode 100644 docs/reference/api/TextStructureFindMessageStructureRequest.md create mode 100644 docs/reference/api/TextStructureFindMessageStructureResponse.md create mode 100644 docs/reference/api/TextStructureFindStructureRequest.md create mode 100644 docs/reference/api/TextStructureFindStructureResponse.md create mode 100644 docs/reference/api/TextStructureFormatType.md create mode 100644 docs/reference/api/TextStructureTestGrokPatternMatchedField.md create mode 100644 docs/reference/api/TextStructureTestGrokPatternMatchedText.md create mode 100644 docs/reference/api/TextStructureTestGrokPatternRequest.md create mode 100644 docs/reference/api/TextStructureTestGrokPatternResponse.md create mode 100644 docs/reference/api/TextStructureTopHit.md create mode 100644 docs/reference/api/That.md create mode 100644 docs/reference/api/That_10.md create mode 100644 docs/reference/api/That_11.md create mode 100644 docs/reference/api/That_12.md create mode 100644 docs/reference/api/That_13.md create mode 100644 docs/reference/api/That_14.md create mode 100644 docs/reference/api/That_15.md create mode 100644 docs/reference/api/That_16.md create mode 100644 docs/reference/api/That_17.md create mode 100644 docs/reference/api/That_18.md create mode 100644 docs/reference/api/That_19.md create mode 100644 docs/reference/api/That_20.md create mode 100644 docs/reference/api/That_21.md create mode 100644 docs/reference/api/That_22.md create mode 100644 docs/reference/api/That_23.md create mode 100644 docs/reference/api/That_24.md create mode 100644 docs/reference/api/That_25.md create mode 100644 docs/reference/api/That_26.md create mode 100644 docs/reference/api/That_27.md create mode 100644 docs/reference/api/That_28.md create mode 100644 docs/reference/api/That_29.md create mode 100644 docs/reference/api/That_3.md create mode 100644 docs/reference/api/That_30.md create mode 100644 docs/reference/api/That_31.md create mode 100644 docs/reference/api/That_32.md create mode 100644 docs/reference/api/That_33.md create mode 100644 docs/reference/api/That_34.md create mode 100644 docs/reference/api/That_35.md create mode 100644 docs/reference/api/That_36.md create mode 100644 docs/reference/api/That_37.md create mode 100644 docs/reference/api/That_38.md create mode 100644 docs/reference/api/That_39.md create mode 100644 docs/reference/api/That_4.md create mode 100644 docs/reference/api/That_40.md create mode 100644 docs/reference/api/That_41.md create mode 100644 docs/reference/api/That_42.md create mode 100644 docs/reference/api/That_43.md create mode 100644 docs/reference/api/That_44.md create mode 100644 docs/reference/api/That_45.md create mode 100644 docs/reference/api/That_46.md create mode 100644 docs/reference/api/That_47.md create mode 100644 docs/reference/api/That_48.md create mode 100644 docs/reference/api/That_49.md create mode 100644 docs/reference/api/That_5.md create mode 100644 docs/reference/api/That_50.md create mode 100644 docs/reference/api/That_51.md create mode 100644 docs/reference/api/That_52.md create mode 100644 docs/reference/api/That_53.md create mode 100644 docs/reference/api/That_54.md create mode 100644 docs/reference/api/That_55.md create mode 100644 docs/reference/api/That_56.md create mode 100644 docs/reference/api/That_57.md create mode 100644 docs/reference/api/That_58.md create mode 100644 docs/reference/api/That_59.md create mode 100644 docs/reference/api/That_6.md create mode 100644 docs/reference/api/That_60.md create mode 100644 docs/reference/api/That_61.md create mode 100644 docs/reference/api/That_62.md create mode 100644 docs/reference/api/That_63.md create mode 100644 docs/reference/api/That_64.md create mode 100644 docs/reference/api/That_65.md create mode 100644 docs/reference/api/That_66.md create mode 100644 docs/reference/api/That_67.md create mode 100644 docs/reference/api/That_68.md create mode 100644 docs/reference/api/That_69.md create mode 100644 docs/reference/api/That_7.md create mode 100644 docs/reference/api/That_70.md create mode 100644 docs/reference/api/That_71.md create mode 100644 docs/reference/api/That_72.md create mode 100644 docs/reference/api/That_73.md create mode 100644 docs/reference/api/That_74.md create mode 100644 docs/reference/api/That_75.md create mode 100644 docs/reference/api/That_76.md create mode 100644 docs/reference/api/That_77.md create mode 100644 docs/reference/api/That_78.md create mode 100644 docs/reference/api/That_79.md create mode 100644 docs/reference/api/That_8.md create mode 100644 docs/reference/api/That_80.md create mode 100644 docs/reference/api/That_81.md create mode 100644 docs/reference/api/That_82.md create mode 100644 docs/reference/api/That_83.md create mode 100644 docs/reference/api/That_84.md create mode 100644 docs/reference/api/That_85.md create mode 100644 docs/reference/api/That_86.md create mode 100644 docs/reference/api/That_9.md create mode 100644 docs/reference/api/ThreadType.md create mode 100644 docs/reference/api/TimeOfDay.md create mode 100644 docs/reference/api/TimeUnit.md create mode 100644 docs/reference/api/TimeZone.md create mode 100644 docs/reference/api/TopLeftBottomRightGeoBounds.md create mode 100644 docs/reference/api/TopRightBottomLeftGeoBounds.md create mode 100644 docs/reference/api/Transform.md create mode 100644 docs/reference/api/TransformContainer.md create mode 100644 docs/reference/api/TransformDeleteTransformRequest.md create mode 100644 docs/reference/api/TransformDeleteTransformResponse.md create mode 100644 docs/reference/api/TransformDestination.md create mode 100644 docs/reference/api/TransformGetTransformRequest.md create mode 100644 docs/reference/api/TransformGetTransformResponse.md create mode 100644 docs/reference/api/TransformGetTransformStatsCheckpointStats.md create mode 100644 docs/reference/api/TransformGetTransformStatsCheckpointing.md create mode 100644 docs/reference/api/TransformGetTransformStatsRequest.md create mode 100644 docs/reference/api/TransformGetTransformStatsResponse.md create mode 100644 docs/reference/api/TransformGetTransformStatsTransformHealthIssue.md create mode 100644 docs/reference/api/TransformGetTransformStatsTransformIndexerStats.md create mode 100644 docs/reference/api/TransformGetTransformStatsTransformProgress.md create mode 100644 docs/reference/api/TransformGetTransformStatsTransformStats.md create mode 100644 docs/reference/api/TransformGetTransformStatsTransformStatsHealth.md create mode 100644 docs/reference/api/TransformGetTransformTransformSummary.md create mode 100644 docs/reference/api/TransformLatest.md create mode 100644 docs/reference/api/TransformPivot.md create mode 100644 docs/reference/api/TransformPivotGroupByContainer.md create mode 100644 docs/reference/api/TransformPreviewTransformRequest.md create mode 100644 docs/reference/api/TransformPreviewTransformResponse.md create mode 100644 docs/reference/api/TransformPutTransformRequest.md create mode 100644 docs/reference/api/TransformPutTransformResponse.md create mode 100644 docs/reference/api/TransformResetTransformRequest.md create mode 100644 docs/reference/api/TransformResetTransformResponse.md create mode 100644 docs/reference/api/TransformRetentionPolicy.md create mode 100644 docs/reference/api/TransformRetentionPolicyContainer.md create mode 100644 docs/reference/api/TransformScheduleNowTransformRequest.md create mode 100644 docs/reference/api/TransformScheduleNowTransformResponse.md create mode 100644 docs/reference/api/TransformSettings.md create mode 100644 docs/reference/api/TransformSource.md create mode 100644 docs/reference/api/TransformStartTransformRequest.md create mode 100644 docs/reference/api/TransformStartTransformResponse.md create mode 100644 docs/reference/api/TransformStopTransformRequest.md create mode 100644 docs/reference/api/TransformStopTransformResponse.md create mode 100644 docs/reference/api/TransformSyncContainer.md create mode 100644 docs/reference/api/TransformTimeSync.md create mode 100644 docs/reference/api/TransformUpdateTransformRequest.md create mode 100644 docs/reference/api/TransformUpdateTransformResponse.md create mode 100644 docs/reference/api/TransformUpgradeTransformsRequest.md create mode 100644 docs/reference/api/TransformUpgradeTransformsResponse.md create mode 100644 docs/reference/api/TranslogStats.md create mode 100644 docs/reference/api/TransportAddress.md create mode 100644 docs/reference/api/UnitFloatMillis.md create mode 100644 docs/reference/api/UnitMillis.md create mode 100644 docs/reference/api/UnitNanos.md create mode 100644 docs/reference/api/UnitSeconds.md create mode 100644 docs/reference/api/UpdateAction.md create mode 100644 docs/reference/api/UpdateActionOperation.md create mode 100644 docs/reference/api/UpdateApi_1.md create mode 100644 docs/reference/api/UpdateApi_2.md create mode 100644 docs/reference/api/UpdateApi_3.md create mode 100644 docs/reference/api/UpdateByQueryApi_1.md create mode 100644 docs/reference/api/UpdateByQueryApi_2.md create mode 100644 docs/reference/api/UpdateByQueryApi_3.md create mode 100644 docs/reference/api/UpdateByQueryRequest.md create mode 100644 docs/reference/api/UpdateByQueryResponse.md create mode 100644 docs/reference/api/UpdateByQueryRethrottleApi_1.md create mode 100644 docs/reference/api/UpdateByQueryRethrottleApi_2.md create mode 100644 docs/reference/api/UpdateByQueryRethrottleApi_3.md create mode 100644 docs/reference/api/UpdateByQueryRethrottleRequest.md create mode 100644 docs/reference/api/UpdateByQueryRethrottleResponse.md create mode 100644 docs/reference/api/UpdateByQueryRethrottleUpdateByQueryRethrottleNode.md create mode 100644 docs/reference/api/UpdateRequest.md create mode 100644 docs/reference/api/UpdateResponse.md create mode 100644 docs/reference/api/UpdateUpdateWriteResponseBase.md create mode 100644 docs/reference/api/Username.md create mode 100644 docs/reference/api/Uuid.md create mode 100644 docs/reference/api/VersionNumber.md create mode 100644 docs/reference/api/VersionString.md create mode 100644 docs/reference/api/VersionType.md create mode 100644 docs/reference/api/WaitForActiveShardOptions.md create mode 100644 docs/reference/api/WaitForActiveShards.md create mode 100644 docs/reference/api/WaitForEvents.md create mode 100644 docs/reference/api/WarmerStats.md create mode 100644 docs/reference/api/Watcher.md create mode 100644 docs/reference/api/WatcherAckWatchRequest.md create mode 100644 docs/reference/api/WatcherAckWatchResponse.md create mode 100644 docs/reference/api/WatcherAcknowledgeState.md create mode 100644 docs/reference/api/WatcherAcknowledgementOptions.md create mode 100644 docs/reference/api/WatcherAction.md create mode 100644 docs/reference/api/WatcherActionExecutionMode.md create mode 100644 docs/reference/api/WatcherActionStatus.md create mode 100644 docs/reference/api/WatcherActionStatusOptions.md create mode 100644 docs/reference/api/WatcherActionType.md create mode 100644 docs/reference/api/WatcherActions.md create mode 100644 docs/reference/api/WatcherActivateWatchRequest.md create mode 100644 docs/reference/api/WatcherActivateWatchResponse.md create mode 100644 docs/reference/api/WatcherActivationState.md create mode 100644 docs/reference/api/WatcherActivationStatus.md create mode 100644 docs/reference/api/WatcherAlwaysCondition.md create mode 100644 docs/reference/api/WatcherArrayCompareCondition.md create mode 100644 docs/reference/api/WatcherArrayCompareConditionKeys.md create mode 100644 docs/reference/api/WatcherArrayCompareOpParams.md create mode 100644 docs/reference/api/WatcherChainInput.md create mode 100644 docs/reference/api/WatcherConditionContainer.md create mode 100644 docs/reference/api/WatcherConditionOp.md create mode 100644 docs/reference/api/WatcherConditionType.md create mode 100644 docs/reference/api/WatcherConnectionScheme.md create mode 100644 docs/reference/api/WatcherCronExpression.md create mode 100644 docs/reference/api/WatcherDailySchedule.md create mode 100644 docs/reference/api/WatcherDataAttachmentFormat.md create mode 100644 docs/reference/api/WatcherDataEmailAttachment.md create mode 100644 docs/reference/api/WatcherDay.md create mode 100644 docs/reference/api/WatcherDeactivateWatchRequest.md create mode 100644 docs/reference/api/WatcherDeactivateWatchResponse.md create mode 100644 docs/reference/api/WatcherDeleteWatchRequest.md create mode 100644 docs/reference/api/WatcherDeleteWatchResponse.md create mode 100644 docs/reference/api/WatcherEmail.md create mode 100644 docs/reference/api/WatcherEmailAction.md create mode 100644 docs/reference/api/WatcherEmailAttachmentContainer.md create mode 100644 docs/reference/api/WatcherEmailBody.md create mode 100644 docs/reference/api/WatcherEmailPriority.md create mode 100644 docs/reference/api/WatcherEmailResult.md create mode 100644 docs/reference/api/WatcherExecuteWatchRequest.md create mode 100644 docs/reference/api/WatcherExecuteWatchResponse.md create mode 100644 docs/reference/api/WatcherExecuteWatchWatchRecord.md create mode 100644 docs/reference/api/WatcherExecutionPhase.md create mode 100644 docs/reference/api/WatcherExecutionResult.md create mode 100644 docs/reference/api/WatcherExecutionResultAction.md create mode 100644 docs/reference/api/WatcherExecutionResultCondition.md create mode 100644 docs/reference/api/WatcherExecutionResultInput.md create mode 100644 docs/reference/api/WatcherExecutionState.md create mode 100644 docs/reference/api/WatcherExecutionStatus.md create mode 100644 docs/reference/api/WatcherExecutionThreadPool.md create mode 100644 docs/reference/api/WatcherGetSettingsRequest.md create mode 100644 docs/reference/api/WatcherGetSettingsResponse.md create mode 100644 docs/reference/api/WatcherGetWatchRequest.md create mode 100644 docs/reference/api/WatcherGetWatchResponse.md create mode 100644 docs/reference/api/WatcherHourAndMinute.md create mode 100644 docs/reference/api/WatcherHourlySchedule.md create mode 100644 docs/reference/api/WatcherHttpEmailAttachment.md create mode 100644 docs/reference/api/WatcherHttpInput.md create mode 100644 docs/reference/api/WatcherHttpInputAuthentication.md create mode 100644 docs/reference/api/WatcherHttpInputBasicAuthentication.md create mode 100644 docs/reference/api/WatcherHttpInputMethod.md create mode 100644 docs/reference/api/WatcherHttpInputProxy.md create mode 100644 docs/reference/api/WatcherHttpInputRequestDefinition.md create mode 100644 docs/reference/api/WatcherHttpInputRequestResult.md create mode 100644 docs/reference/api/WatcherHttpInputResponseResult.md create mode 100644 docs/reference/api/WatcherIndexAction.md create mode 100644 docs/reference/api/WatcherIndexResult.md create mode 100644 docs/reference/api/WatcherIndexResultSummary.md create mode 100644 docs/reference/api/WatcherInputContainer.md create mode 100644 docs/reference/api/WatcherInputType.md create mode 100644 docs/reference/api/WatcherLoggingAction.md create mode 100644 docs/reference/api/WatcherLoggingResult.md create mode 100644 docs/reference/api/WatcherMonth.md create mode 100644 docs/reference/api/WatcherNeverCondition.md create mode 100644 docs/reference/api/WatcherPagerDutyAction.md create mode 100644 docs/reference/api/WatcherPagerDutyContext.md create mode 100644 docs/reference/api/WatcherPagerDutyContextType.md create mode 100644 docs/reference/api/WatcherPagerDutyEvent.md create mode 100644 docs/reference/api/WatcherPagerDutyEventProxy.md create mode 100644 docs/reference/api/WatcherPagerDutyEventType.md create mode 100644 docs/reference/api/WatcherPagerDutyResult.md create mode 100644 docs/reference/api/WatcherPutWatchRequest.md create mode 100644 docs/reference/api/WatcherPutWatchResponse.md create mode 100644 docs/reference/api/WatcherQuantifier.md create mode 100644 docs/reference/api/WatcherQueryWatch.md create mode 100644 docs/reference/api/WatcherQueryWatchesRequest.md create mode 100644 docs/reference/api/WatcherQueryWatchesResponse.md create mode 100644 docs/reference/api/WatcherReportingEmailAttachment.md create mode 100644 docs/reference/api/WatcherResponseContentType.md create mode 100644 docs/reference/api/WatcherScheduleContainer.md create mode 100644 docs/reference/api/WatcherScheduleTimeOfDay.md create mode 100644 docs/reference/api/WatcherScheduleTriggerEvent.md create mode 100644 docs/reference/api/WatcherScriptCondition.md create mode 100644 docs/reference/api/WatcherSearchInput.md create mode 100644 docs/reference/api/WatcherSearchInputRequestBody.md create mode 100644 docs/reference/api/WatcherSearchInputRequestDefinition.md create mode 100644 docs/reference/api/WatcherSearchTemplateRequestBody.md create mode 100644 docs/reference/api/WatcherSimulatedActions.md create mode 100644 docs/reference/api/WatcherSlackAction.md create mode 100644 docs/reference/api/WatcherSlackAttachment.md create mode 100644 docs/reference/api/WatcherSlackAttachmentField.md create mode 100644 docs/reference/api/WatcherSlackDynamicAttachment.md create mode 100644 docs/reference/api/WatcherSlackMessage.md create mode 100644 docs/reference/api/WatcherSlackResult.md create mode 100644 docs/reference/api/WatcherStartRequest.md create mode 100644 docs/reference/api/WatcherStartResponse.md create mode 100644 docs/reference/api/WatcherStatsRequest.md create mode 100644 docs/reference/api/WatcherStatsResponse.md create mode 100644 docs/reference/api/WatcherStatsWatchRecordQueuedStats.md create mode 100644 docs/reference/api/WatcherStatsWatchRecordStats.md create mode 100644 docs/reference/api/WatcherStatsWatcherMetric.md create mode 100644 docs/reference/api/WatcherStatsWatcherNodeStats.md create mode 100644 docs/reference/api/WatcherStatsWatcherState.md create mode 100644 docs/reference/api/WatcherStopRequest.md create mode 100644 docs/reference/api/WatcherStopResponse.md create mode 100644 docs/reference/api/WatcherThrottleState.md create mode 100644 docs/reference/api/WatcherTimeOfMonth.md create mode 100644 docs/reference/api/WatcherTimeOfWeek.md create mode 100644 docs/reference/api/WatcherTimeOfYear.md create mode 100644 docs/reference/api/WatcherTriggerContainer.md create mode 100644 docs/reference/api/WatcherTriggerEventContainer.md create mode 100644 docs/reference/api/WatcherTriggerEventResult.md create mode 100644 docs/reference/api/WatcherUpdateSettingsRequest.md create mode 100644 docs/reference/api/WatcherUpdateSettingsResponse.md create mode 100644 docs/reference/api/WatcherWatch.md create mode 100644 docs/reference/api/WatcherWatchStatus.md create mode 100644 docs/reference/api/WatcherWebhookAction.md create mode 100644 docs/reference/api/WatcherWebhookResult.md create mode 100644 docs/reference/api/WktGeoBounds.md create mode 100644 docs/reference/api/WriteResponseBase.md create mode 100644 docs/reference/api/Xpack.md create mode 100644 docs/reference/api/XpackInfoBuildInformation.md create mode 100644 docs/reference/api/XpackInfoFeature.md create mode 100644 docs/reference/api/XpackInfoFeatures.md create mode 100644 docs/reference/api/XpackInfoMinimalLicenseInformation.md create mode 100644 docs/reference/api/XpackInfoNativeCodeInformation.md create mode 100644 docs/reference/api/XpackInfoRequest.md create mode 100644 docs/reference/api/XpackInfoResponse.md create mode 100644 docs/reference/api/XpackInfoXPackCategory.md create mode 100644 docs/reference/api/XpackUsageAnalytics.md create mode 100644 docs/reference/api/XpackUsageAnalyticsStatistics.md create mode 100644 docs/reference/api/XpackUsageArchive.md create mode 100644 docs/reference/api/XpackUsageAudit.md create mode 100644 docs/reference/api/XpackUsageBase.md create mode 100644 docs/reference/api/XpackUsageCcr.md create mode 100644 docs/reference/api/XpackUsageCounter.md create mode 100644 docs/reference/api/XpackUsageDataStreams.md create mode 100644 docs/reference/api/XpackUsageDataTierPhaseStatistics.md create mode 100644 docs/reference/api/XpackUsageDataTiers.md create mode 100644 docs/reference/api/XpackUsageDatafeed.md create mode 100644 docs/reference/api/XpackUsageEql.md create mode 100644 docs/reference/api/XpackUsageEqlFeatures.md create mode 100644 docs/reference/api/XpackUsageEqlFeaturesJoin.md create mode 100644 docs/reference/api/XpackUsageEqlFeaturesKeys.md create mode 100644 docs/reference/api/XpackUsageEqlFeaturesPipes.md create mode 100644 docs/reference/api/XpackUsageEqlFeaturesSequences.md create mode 100644 docs/reference/api/XpackUsageFeatureToggle.md create mode 100644 docs/reference/api/XpackUsageFlattened.md create mode 100644 docs/reference/api/XpackUsageHealthStatistics.md create mode 100644 docs/reference/api/XpackUsageIlm.md create mode 100644 docs/reference/api/XpackUsageIlmPolicyStatistics.md create mode 100644 docs/reference/api/XpackUsageInvocations.md create mode 100644 docs/reference/api/XpackUsageIpFilter.md create mode 100644 docs/reference/api/XpackUsageJobUsage.md create mode 100644 docs/reference/api/XpackUsageMachineLearning.md create mode 100644 docs/reference/api/XpackUsageMlCounter.md create mode 100644 docs/reference/api/XpackUsageMlDataFrameAnalyticsJobs.md create mode 100644 docs/reference/api/XpackUsageMlDataFrameAnalyticsJobsAnalysis.md create mode 100644 docs/reference/api/XpackUsageMlDataFrameAnalyticsJobsCount.md create mode 100644 docs/reference/api/XpackUsageMlDataFrameAnalyticsJobsMemory.md create mode 100644 docs/reference/api/XpackUsageMlInference.md create mode 100644 docs/reference/api/XpackUsageMlInferenceDeployments.md create mode 100644 docs/reference/api/XpackUsageMlInferenceDeploymentsTimeMs.md create mode 100644 docs/reference/api/XpackUsageMlInferenceIngestProcessor.md create mode 100644 docs/reference/api/XpackUsageMlInferenceIngestProcessorCount.md create mode 100644 docs/reference/api/XpackUsageMlInferenceTrainedModels.md create mode 100644 docs/reference/api/XpackUsageMlInferenceTrainedModelsCount.md create mode 100644 docs/reference/api/XpackUsageMlJobForecasts.md create mode 100644 docs/reference/api/XpackUsageMonitoring.md create mode 100644 docs/reference/api/XpackUsagePhase.md create mode 100644 docs/reference/api/XpackUsagePhases.md create mode 100644 docs/reference/api/XpackUsageQuery.md create mode 100644 docs/reference/api/XpackUsageRealm.md create mode 100644 docs/reference/api/XpackUsageRealmCache.md create mode 100644 docs/reference/api/XpackUsageRequest.md create mode 100644 docs/reference/api/XpackUsageResponse.md create mode 100644 docs/reference/api/XpackUsageRoleMapping.md create mode 100644 docs/reference/api/XpackUsageRuntimeFieldTypes.md create mode 100644 docs/reference/api/XpackUsageRuntimeFieldsType.md create mode 100644 docs/reference/api/XpackUsageSearchableSnapshots.md create mode 100644 docs/reference/api/XpackUsageSecurity.md create mode 100644 docs/reference/api/XpackUsageSecurityRoles.md create mode 100644 docs/reference/api/XpackUsageSecurityRolesDls.md create mode 100644 docs/reference/api/XpackUsageSecurityRolesDlsBitSetCache.md create mode 100644 docs/reference/api/XpackUsageSecurityRolesFile.md create mode 100644 docs/reference/api/XpackUsageSecurityRolesNative.md create mode 100644 docs/reference/api/XpackUsageSlm.md create mode 100644 docs/reference/api/XpackUsageSql.md create mode 100644 docs/reference/api/XpackUsageSsl.md create mode 100644 docs/reference/api/XpackUsageVector.md create mode 100644 docs/reference/api/XpackUsageWatcher.md create mode 100644 docs/reference/api/XpackUsageWatcherActionTotals.md create mode 100644 docs/reference/api/XpackUsageWatcherActions.md create mode 100644 docs/reference/api/XpackUsageWatcherWatch.md create mode 100644 docs/reference/api/XpackUsageWatcherWatchTrigger.md create mode 100644 docs/reference/api/XpackUsageWatcherWatchTriggerSchedule.md create mode 100644 docs/reference/api/byte.md create mode 100644 docs/reference/api/double.md create mode 100644 docs/reference/api/float.md create mode 100644 docs/reference/api/integer.md create mode 100644 docs/reference/api/long.md create mode 100644 docs/reference/api/short.md create mode 100644 docs/reference/api/uint.md create mode 100644 docs/reference/api/ulong.md create mode 100644 scripts/docgen.mjs diff --git a/.gitignore b/.gitignore index 07e49ff7b..e4fe2e2b0 100644 --- a/.gitignore +++ b/.gitignore @@ -72,3 +72,4 @@ rest-api-spec yaml-rest-tests generated-tests schema +api-extractor/* diff --git a/.npmignore b/.npmignore index 3f909d8c7..6eef5c1f0 100644 --- a/.npmignore +++ b/.npmignore @@ -8,23 +8,22 @@ pids *.pid *.seed -# Directory for instrumented libs generated by jscoverage/JSCover +# unit testing and coverage artifacts lib-cov - -# Coverage directory used by tools like istanbul coverage - -# coverage output coverage.lcov - -# nyc test coverage .nyc_output - -# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) .grunt +.tap +rest-api-spec +yaml-rest-tests +generated-tests +junit-output -# node-waf configuration +# lock files .lock-wscript +package-lock.json +bun.lockb # Compiled binary addons (http://nodejs.org/api/addons.html) build/Release @@ -45,8 +44,6 @@ jspm_packages # vim swap files *.swp -package-lock.json - # elasticsearch repo or binary files elasticsearch* @@ -54,8 +51,11 @@ elasticsearch* # because we should copy them in the main .d.ts file api/generated.d.ts -# Ignore doc folder +# documentation docs +CODE_OF_CONDUCT.md +CONTRIBUTING.md +CHANGELOG.md # Ignore test folder test @@ -68,12 +68,14 @@ scripts .buildkite certs .github -CODE_OF_CONDUCT.md -CONTRIBUTING.md +# Uncompiled source src -bun.lockb -.tap -rest-api-spec -yaml-rest-tests -generated-tests + +# repo configurations +.dockerignore +.gitignore +catalog-info.yaml +codecov.yml +renovate.json +tsconfig.json diff --git a/api-extractor.json b/api-extractor.json new file mode 100644 index 000000000..2fb1b64c3 --- /dev/null +++ b/api-extractor.json @@ -0,0 +1,39 @@ +{ + "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json", + "mainEntryPointFilePath": "/lib/client.d.ts", + "bundledPackages": [ + "@elastic/elasticsearch" + ], + "apiReport": { + "enabled": false + }, + "docModel": { + "enabled": true, + "apiJsonFilePath": "/api-extractor/.api.json", + "includeForgottenExports": true + }, + "dtsRollup": { + "enabled": false + }, + "tsdocMetadata": { + "enabled": true, + "tsdocMetadataFilePath": "/api-extractor/tsdoc-metadata.json" + }, + "messages": { + "compilerMessageReporting": { + "default": { + "logLevel": "warning" + } + }, + "extractorMessageReporting": { + "default": { + "logLevel": "warning" + } + }, + "tsdocMessageReporting": { + "default": { + "logLevel": "warning" + } + } + } +} diff --git a/docs/reference/api-reference.md b/docs/reference/api-reference.md index a658dbb00..e07557048 100644 --- a/docs/reference/api-reference.md +++ b/docs/reference/api-reference.md @@ -1,15492 +1,6 @@ --- mapped_pages: - https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/api-reference.html -comment: | - IMPORTANT: This file is autogenerated, DO NOT send pull requests that change this file directly. - You should update the script that does the generation, which can be found in: - https://github.com/elastic/elastic-client-generator-js --- -# API Reference [api-reference] - -## client.bulk [_bulk] -Bulk index or delete documents. -Perform multiple `index`, `create`, `delete`, and `update` actions in a single request. -This reduces overhead and can greatly increase indexing speed. - -If the Elasticsearch security features are enabled, you must have the following index privileges for the target data stream, index, or index alias: - -* To use the `create` action, you must have the `create_doc`, `create`, `index`, or `write` index privilege. Data streams support only the `create` action. -* To use the `index` action, you must have the `create`, `index`, or `write` index privilege. -* To use the `delete` action, you must have the `delete` or `write` index privilege. -* To use the `update` action, you must have the `index` or `write` index privilege. -* To automatically create a data stream or index with a bulk API request, you must have the `auto_configure`, `create_index`, or `manage` index privilege. -* To make the result of a bulk operation visible to search using the `refresh` parameter, you must have the `maintenance` or `manage` index privilege. - -Automatic data stream creation requires a matching index template with data stream enabled. - -The actions are specified in the request body using a newline delimited JSON (NDJSON) structure: - -``` -action_and_meta_data\n -optional_source\n -action_and_meta_data\n -optional_source\n -.... -action_and_meta_data\n -optional_source\n -``` - -The `index` and `create` actions expect a source on the next line and have the same semantics as the `op_type` parameter in the standard index API. -A `create` action fails if a document with the same ID already exists in the target -An `index` action adds or replaces a document as necessary. - -NOTE: Data streams support only the `create` action. -To update or delete a document in a data stream, you must target the backing index containing the document. - -An `update` action expects that the partial doc, upsert, and script and its options are specified on the next line. - -A `delete` action does not expect a source on the next line and has the same semantics as the standard delete API. - -NOTE: The final line of data must end with a newline character (`\n`). -Each newline character may be preceded by a carriage return (`\r`). -When sending NDJSON data to the `_bulk` endpoint, use a `Content-Type` header of `application/json` or `application/x-ndjson`. -Because this format uses literal newline characters (`\n`) as delimiters, make sure that the JSON actions and sources are not pretty printed. - -If you provide a target in the request path, it is used for any actions that don't explicitly specify an `_index` argument. - -A note on the format: the idea here is to make processing as fast as possible. -As some of the actions are redirected to other shards on other nodes, only `action_meta_data` is parsed on the receiving node side. - -Client libraries using this protocol should try and strive to do something similar on the client side, and reduce buffering as much as possible. - -There is no "correct" number of actions to perform in a single bulk request. -Experiment with different settings to find the optimal size for your particular workload. -Note that Elasticsearch limits the maximum size of a HTTP request to 100mb by default so clients must ensure that no request exceeds this size. -It is not possible to index a single document that exceeds the size limit, so you must pre-process any such documents into smaller pieces before sending them to Elasticsearch. -For instance, split documents into pages or chapters before indexing them, or store raw binary data in a system outside Elasticsearch and replace the raw data with a link to the external system in the documents that you send to Elasticsearch. - -**Client suppport for bulk requests** - -Some of the officially supported clients provide helpers to assist with bulk requests and reindexing: - -* Go: Check out `esutil.BulkIndexer` -* Perl: Check out `Search::Elasticsearch::Client::5_0::Bulk` and `Search::Elasticsearch::Client::5_0::Scroll` -* Python: Check out `elasticsearch.helpers.*` -* JavaScript: Check out `client.helpers.*` -* .NET: Check out `BulkAllObservable` -* PHP: Check out bulk indexing. - -**Submitting bulk requests with cURL** - -If you're providing text file input to `curl`, you must use the `--data-binary` flag instead of plain `-d`. -The latter doesn't preserve newlines. For example: - -``` -$ cat requests -{ "index" : { "_index" : "test", "_id" : "1" } } -{ "field1" : "value1" } -$ curl -s -H "Content-Type: application/x-ndjson" -XPOST localhost:9200/_bulk --data-binary "@requests"; echo -{"took":7, "errors": false, "items":[{"index":{"_index":"test","_id":"1","_version":1,"result":"created","forced_refresh":false}}]} -``` - -**Optimistic concurrency control** - -Each `index` and `delete` action within a bulk API call may include the `if_seq_no` and `if_primary_term` parameters in their respective action and meta data lines. -The `if_seq_no` and `if_primary_term` parameters control how operations are run, based on the last modification to existing documents. See Optimistic concurrency control for more details. - -**Versioning** - -Each bulk item can include the version value using the `version` field. -It automatically follows the behavior of the index or delete operation based on the `_version` mapping. -It also support the `version_type`. - -**Routing** - -Each bulk item can include the routing value using the `routing` field. -It automatically follows the behavior of the index or delete operation based on the `_routing` mapping. - -NOTE: Data streams do not support custom routing unless they were created with the `allow_custom_routing` setting enabled in the template. - -**Wait for active shards** - -When making bulk calls, you can set the `wait_for_active_shards` parameter to require a minimum number of shard copies to be active before starting to process the bulk request. - -**Refresh** - -Control when the changes made by this request are visible to search. - -NOTE: Only the shards that receive the bulk request will be affected by refresh. -Imagine a `_bulk?refresh=wait_for` request with three documents in it that happen to be routed to different shards in an index with five shards. -The request will only wait for those three shards to refresh. -The other two shards that make up the index do not participate in the `_bulk` request at all. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-bulk) - -```ts -client.bulk({ ... }) -``` -### Arguments [_arguments_bulk] - -#### Request (object) [_request_bulk] - -- **`index` (Optional, string)**: The name of the data stream, index, or index alias to perform bulk actions on. -- **`operations` (Optional, { index, create, update, delete } \| { detect_noop, doc, doc_as_upsert, script, scripted_upsert, _source, upsert } \| object[])** -- **`include_source_on_error` (Optional, boolean)**: True or false if to include the document source in the error message in case of parsing errors. -- **`list_executed_pipelines` (Optional, boolean)**: If `true`, the response will include the ingest pipelines that were run for each index or create. -- **`pipeline` (Optional, string)**: The pipeline identifier to use to preprocess incoming documents. If the index has a default ingest pipeline specified, setting the value to `_none` turns off the default ingest pipeline for this request. If a final pipeline is configured, it will always run regardless of the value of this parameter. -- **`refresh` (Optional, Enum(true \| false \| "wait_for"))**: If `true`, Elasticsearch refreshes the affected shards to make this operation visible to search. If `wait_for`, wait for a refresh to make this operation visible to search. If `false`, do nothing with refreshes. Valid values: `true`, `false`, `wait_for`. -- **`routing` (Optional, string)**: A custom value that is used to route operations to a specific shard. -- **`_source` (Optional, boolean \| string \| string[])**: Indicates whether to return the `_source` field (`true` or `false`) or contains a list of fields to return. -- **`_source_excludes` (Optional, string \| string[])**: A list of source fields to exclude from the response. You can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter. If the `_source` parameter is `false`, this parameter is ignored. -- **`_source_includes` (Optional, string \| string[])**: A list of source fields to include in the response. If this parameter is specified, only these source fields are returned. You can exclude fields from this subset using the `_source_excludes` query parameter. If the `_source` parameter is `false`, this parameter is ignored. -- **`timeout` (Optional, string \| -1 \| 0)**: The period each action waits for the following operations: automatic index creation, dynamic mapping updates, and waiting for active shards. The default is `1m` (one minute), which guarantees Elasticsearch waits for at least the timeout before failing. The actual wait time could be longer, particularly when multiple waits occur. -- **`wait_for_active_shards` (Optional, number \| Enum("all" \| "index-setting"))**: The number of shard copies that must be active before proceeding with the operation. Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). The default is `1`, which waits for each primary shard to be active. -- **`require_alias` (Optional, boolean)**: If `true`, the request's actions must target an index alias. -- **`require_data_stream` (Optional, boolean)**: If `true`, the request's actions must target a data stream (existing or to be created). - -## client.clearScroll [_clear_scroll] -Clear a scrolling search. -Clear the search context and results for a scrolling search. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-clear-scroll) - -```ts -client.clearScroll({ ... }) -``` -### Arguments [_arguments_clear_scroll] - -#### Request (object) [_request_clear_scroll] - -- **`scroll_id` (Optional, string \| string[])**: A list of scroll IDs to clear. To clear all scroll IDs, use `_all`. IMPORTANT: Scroll IDs can be long. It is recommended to specify scroll IDs in the request body parameter. - -## client.closePointInTime [_close_point_in_time] -Close a point in time. -A point in time must be opened explicitly before being used in search requests. -The `keep_alive` parameter tells Elasticsearch how long it should persist. -A point in time is automatically closed when the `keep_alive` period has elapsed. -However, keeping points in time has a cost; close them as soon as they are no longer required for search requests. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-open-point-in-time) - -```ts -client.closePointInTime({ id }) -``` -### Arguments [_arguments_close_point_in_time] - -#### Request (object) [_request_close_point_in_time] - -- **`id` (string)**: The ID of the point-in-time. - -## client.count [_count] -Count search results. -Get the number of documents matching a query. - -The query can be provided either by using a simple query string as a parameter, or by defining Query DSL within the request body. -The query is optional. When no query is provided, the API uses `match_all` to count all the documents. - -The count API supports multi-target syntax. You can run a single count API search across multiple data streams and indices. - -The operation is broadcast across all shards. -For each shard ID group, a replica is chosen and the search is run against it. -This means that replicas increase the scalability of the count. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-count) - -```ts -client.count({ ... }) -``` -### Arguments [_arguments_count] - -#### Request (object) [_request_count] - -- **`index` (Optional, string \| string[])**: A list of data streams, indices, and aliases to search. It supports wildcards (`*`). To search all data streams and indices, omit this parameter or use `*` or `_all`. -- **`query` (Optional, { bool, boosting, common, combined_fields, constant_score, dis_max, distance_feature, exists, function_score, fuzzy, geo_bounding_box, geo_distance, geo_grid, geo_polygon, geo_shape, has_child, has_parent, ids, intervals, knn, match, match_all, match_bool_prefix, match_none, match_phrase, match_phrase_prefix, more_like_this, multi_match, nested, parent_id, percolate, pinned, prefix, query_string, range, rank_feature, regexp, rule, script, script_score, semantic, shape, simple_query_string, span_containing, span_field_masking, span_first, span_multi, span_near, span_not, span_or, span_term, span_within, sparse_vector, term, terms, terms_set, text_expansion, weighted_tokens, wildcard, wrapper, type })**: Defines the search query using Query DSL. A request body query cannot be used with the `q` query string parameter. -- **`allow_no_indices` (Optional, boolean)**: If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. -- **`analyzer` (Optional, string)**: The analyzer to use for the query string. This parameter can be used only when the `q` query string parameter is specified. -- **`analyze_wildcard` (Optional, boolean)**: If `true`, wildcard and prefix queries are analyzed. This parameter can be used only when the `q` query string parameter is specified. -- **`default_operator` (Optional, Enum("and" \| "or"))**: The default operator for query string query: `AND` or `OR`. This parameter can be used only when the `q` query string parameter is specified. -- **`df` (Optional, string)**: The field to use as a default when no field prefix is given in the query string. This parameter can be used only when the `q` query string parameter is specified. -- **`expand_wildcards` (Optional, Enum("all" \| "open" \| "closed" \| "hidden" \| "none") \| Enum("all" \| "open" \| "closed" \| "hidden" \| "none")[])**: The type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. It supports a list of values, such as `open,hidden`. -- **`ignore_throttled` (Optional, boolean)**: If `true`, concrete, expanded, or aliased indices are ignored when frozen. -- **`ignore_unavailable` (Optional, boolean)**: If `false`, the request returns an error if it targets a missing or closed index. -- **`lenient` (Optional, boolean)**: If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. This parameter can be used only when the `q` query string parameter is specified. -- **`min_score` (Optional, number)**: The minimum `_score` value that documents must have to be included in the result. -- **`preference` (Optional, string)**: The node or shard the operation should be performed on. By default, it is random. -- **`routing` (Optional, string)**: A custom value used to route operations to a specific shard. -- **`terminate_after` (Optional, number)**: The maximum number of documents to collect for each shard. If a query reaches this limit, Elasticsearch terminates the query early. Elasticsearch collects documents before sorting. IMPORTANT: Use with caution. Elasticsearch applies this parameter to each shard handling the request. When possible, let Elasticsearch perform early termination automatically. Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers. -- **`q` (Optional, string)**: The query in Lucene query string syntax. This parameter cannot be used with a request body. - -## client.create [_create] -Create a new document in the index. - -You can index a new JSON document with the `//_doc/` or `//_create/<_id>` APIs -Using `_create` guarantees that the document is indexed only if it does not already exist. -It returns a 409 response when a document with a same ID already exists in the index. -To update an existing document, you must use the `//_doc/` API. - -If the Elasticsearch security features are enabled, you must have the following index privileges for the target data stream, index, or index alias: - -* To add a document using the `PUT //_create/<_id>` or `POST //_create/<_id>` request formats, you must have the `create_doc`, `create`, `index`, or `write` index privilege. -* To automatically create a data stream or index with this API request, you must have the `auto_configure`, `create_index`, or `manage` index privilege. - -Automatic data stream creation requires a matching index template with data stream enabled. - -**Automatically create data streams and indices** - -If the request's target doesn't exist and matches an index template with a `data_stream` definition, the index operation automatically creates the data stream. - -If the target doesn't exist and doesn't match a data stream template, the operation automatically creates the index and applies any matching index templates. - -NOTE: Elasticsearch includes several built-in index templates. To avoid naming collisions with these templates, refer to index pattern documentation. - -If no mapping exists, the index operation creates a dynamic mapping. -By default, new fields and objects are automatically added to the mapping if needed. - -Automatic index creation is controlled by the `action.auto_create_index` setting. -If it is `true`, any index can be created automatically. -You can modify this setting to explicitly allow or block automatic creation of indices that match specified patterns or set it to `false` to turn off automatic index creation entirely. -Specify a list of patterns you want to allow or prefix each pattern with `+` or `-` to indicate whether it should be allowed or blocked. -When a list is specified, the default behaviour is to disallow. - -NOTE: The `action.auto_create_index` setting affects the automatic creation of indices only. -It does not affect the creation of data streams. - -**Routing** - -By default, shard placement — or routing — is controlled by using a hash of the document's ID value. -For more explicit control, the value fed into the hash function used by the router can be directly specified on a per-operation basis using the `routing` parameter. - -When setting up explicit mapping, you can also use the `_routing` field to direct the index operation to extract the routing value from the document itself. -This does come at the (very minimal) cost of an additional document parsing pass. -If the `_routing` mapping is defined and set to be required, the index operation will fail if no routing value is provided or extracted. - -NOTE: Data streams do not support custom routing unless they were created with the `allow_custom_routing` setting enabled in the template. - -**Distributed** - -The index operation is directed to the primary shard based on its route and performed on the actual node containing this shard. -After the primary shard completes the operation, if needed, the update is distributed to applicable replicas. - -**Active shards** - -To improve the resiliency of writes to the system, indexing operations can be configured to wait for a certain number of active shard copies before proceeding with the operation. -If the requisite number of active shard copies are not available, then the write operation must wait and retry, until either the requisite shard copies have started or a timeout occurs. -By default, write operations only wait for the primary shards to be active before proceeding (that is to say `wait_for_active_shards` is `1`). -This default can be overridden in the index settings dynamically by setting `index.write.wait_for_active_shards`. -To alter this behavior per operation, use the `wait_for_active_shards request` parameter. - -Valid values are all or any positive integer up to the total number of configured copies per shard in the index (which is `number_of_replicas`+1). -Specifying a negative value or a number greater than the number of shard copies will throw an error. - -For example, suppose you have a cluster of three nodes, A, B, and C and you create an index index with the number of replicas set to 3 (resulting in 4 shard copies, one more copy than there are nodes). -If you attempt an indexing operation, by default the operation will only ensure the primary copy of each shard is available before proceeding. -This means that even if B and C went down and A hosted the primary shard copies, the indexing operation would still proceed with only one copy of the data. -If `wait_for_active_shards` is set on the request to `3` (and all three nodes are up), the indexing operation will require 3 active shard copies before proceeding. -This requirement should be met because there are 3 active nodes in the cluster, each one holding a copy of the shard. -However, if you set `wait_for_active_shards` to `all` (or to `4`, which is the same in this situation), the indexing operation will not proceed as you do not have all 4 copies of each shard active in the index. -The operation will timeout unless a new node is brought up in the cluster to host the fourth copy of the shard. - -It is important to note that this setting greatly reduces the chances of the write operation not writing to the requisite number of shard copies, but it does not completely eliminate the possibility, because this check occurs before the write operation starts. -After the write operation is underway, it is still possible for replication to fail on any number of shard copies but still succeed on the primary. -The `_shards` section of the API response reveals the number of shard copies on which replication succeeded and failed. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-create) - -```ts -client.create({ id, index }) -``` -### Arguments [_arguments_create] - -#### Request (object) [_request_create] - -- **`id` (string)**: A unique identifier for the document. To automatically generate a document ID, use the `POST //_doc/` request format. -- **`index` (string)**: The name of the data stream or index to target. If the target doesn't exist and matches the name or wildcard (`*`) pattern of an index template with a `data_stream` definition, this request creates the data stream. If the target doesn't exist and doesn’t match a data stream template, this request creates the index. -- **`document` (Optional, object)**: A document. -- **`if_primary_term` (Optional, number)**: Only perform the operation if the document has this primary term. -- **`if_seq_no` (Optional, number)**: Only perform the operation if the document has this sequence number. -- **`include_source_on_error` (Optional, boolean)**: True or false if to include the document source in the error message in case of parsing errors. -- **`op_type` (Optional, Enum("index" \| "create"))**: Set to `create` to only index the document if it does not already exist (put if absent). If a document with the specified `_id` already exists, the indexing operation will fail. The behavior is the same as using the `/_create` endpoint. If a document ID is specified, this paramater defaults to `index`. Otherwise, it defaults to `create`. If the request targets a data stream, an `op_type` of `create` is required. -- **`pipeline` (Optional, string)**: The ID of the pipeline to use to preprocess incoming documents. If the index has a default ingest pipeline specified, setting the value to `_none` turns off the default ingest pipeline for this request. If a final pipeline is configured, it will always run regardless of the value of this parameter. -- **`refresh` (Optional, Enum(true \| false \| "wait_for"))**: If `true`, Elasticsearch refreshes the affected shards to make this operation visible to search. If `wait_for`, it waits for a refresh to make this operation visible to search. If `false`, it does nothing with refreshes. -- **`require_alias` (Optional, boolean)**: If `true`, the destination must be an index alias. -- **`require_data_stream` (Optional, boolean)**: If `true`, the request's actions must target a data stream (existing or to be created). -- **`routing` (Optional, string)**: A custom value that is used to route operations to a specific shard. -- **`timeout` (Optional, string \| -1 \| 0)**: The period the request waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards. Elasticsearch waits for at least the specified timeout period before failing. The actual wait time could be longer, particularly when multiple waits occur. This parameter is useful for situations where the primary shard assigned to perform the operation might not be available when the operation runs. Some reasons for this might be that the primary shard is currently recovering from a gateway or undergoing relocation. By default, the operation will wait on the primary shard to become available for at least 1 minute before failing and responding with an error. The actual wait time could be longer, particularly when multiple waits occur. -- **`version` (Optional, number)**: The explicit version number for concurrency control. It must be a non-negative long number. -- **`version_type` (Optional, Enum("internal" \| "external" \| "external_gte" \| "force"))**: The version type. -- **`wait_for_active_shards` (Optional, number \| Enum("all" \| "index-setting"))**: The number of shard copies that must be active before proceeding with the operation. You can set it to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). The default value of `1` means it waits for each primary shard to be active. - -## client.delete [_delete] -Delete a document. - -Remove a JSON document from the specified index. - -NOTE: You cannot send deletion requests directly to a data stream. -To delete a document in a data stream, you must target the backing index containing the document. - -**Optimistic concurrency control** - -Delete operations can be made conditional and only be performed if the last modification to the document was assigned the sequence number and primary term specified by the `if_seq_no` and `if_primary_term` parameters. -If a mismatch is detected, the operation will result in a `VersionConflictException` and a status code of `409`. - -**Versioning** - -Each document indexed is versioned. -When deleting a document, the version can be specified to make sure the relevant document you are trying to delete is actually being deleted and it has not changed in the meantime. -Every write operation run on a document, deletes included, causes its version to be incremented. -The version number of a deleted document remains available for a short time after deletion to allow for control of concurrent operations. -The length of time for which a deleted document's version remains available is determined by the `index.gc_deletes` index setting. - -**Routing** - -If routing is used during indexing, the routing value also needs to be specified to delete a document. - -If the `_routing` mapping is set to `required` and no routing value is specified, the delete API throws a `RoutingMissingException` and rejects the request. - -For example: - -``` -DELETE /my-index-000001/_doc/1?routing=shard-1 -``` - -This request deletes the document with ID 1, but it is routed based on the user. -The document is not deleted if the correct routing is not specified. - -**Distributed** - -The delete operation gets hashed into a specific shard ID. -It then gets redirected into the primary shard within that ID group and replicated (if needed) to shard replicas within that ID group. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-delete) - -```ts -client.delete({ id, index }) -``` -### Arguments [_arguments_delete] - -#### Request (object) [_request_delete] - -- **`id` (string)**: A unique identifier for the document. -- **`index` (string)**: The name of the target index. -- **`if_primary_term` (Optional, number)**: Only perform the operation if the document has this primary term. -- **`if_seq_no` (Optional, number)**: Only perform the operation if the document has this sequence number. -- **`refresh` (Optional, Enum(true \| false \| "wait_for"))**: If `true`, Elasticsearch refreshes the affected shards to make this operation visible to search. If `wait_for`, it waits for a refresh to make this operation visible to search. If `false`, it does nothing with refreshes. -- **`routing` (Optional, string)**: A custom value used to route operations to a specific shard. -- **`timeout` (Optional, string \| -1 \| 0)**: The period to wait for active shards. This parameter is useful for situations where the primary shard assigned to perform the delete operation might not be available when the delete operation runs. Some reasons for this might be that the primary shard is currently recovering from a store or undergoing relocation. By default, the delete operation will wait on the primary shard to become available for up to 1 minute before failing and responding with an error. -- **`version` (Optional, number)**: An explicit version number for concurrency control. It must match the current version of the document for the request to succeed. -- **`version_type` (Optional, Enum("internal" \| "external" \| "external_gte" \| "force"))**: The version type. -- **`wait_for_active_shards` (Optional, number \| Enum("all" \| "index-setting"))**: The minimum number of shard copies that must be active before proceeding with the operation. You can set it to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). The default value of `1` means it waits for each primary shard to be active. - -## client.deleteByQuery [_delete_by_query] -Delete documents. - -Deletes documents that match the specified query. - -If the Elasticsearch security features are enabled, you must have the following index privileges for the target data stream, index, or alias: - -* `read` -* `delete` or `write` - -You can specify the query criteria in the request URI or the request body using the same syntax as the search API. -When you submit a delete by query request, Elasticsearch gets a snapshot of the data stream or index when it begins processing the request and deletes matching documents using internal versioning. -If a document changes between the time that the snapshot is taken and the delete operation is processed, it results in a version conflict and the delete operation fails. - -NOTE: Documents with a version equal to 0 cannot be deleted using delete by query because internal versioning does not support 0 as a valid version number. - -While processing a delete by query request, Elasticsearch performs multiple search requests sequentially to find all of the matching documents to delete. -A bulk delete request is performed for each batch of matching documents. -If a search or bulk request is rejected, the requests are retried up to 10 times, with exponential back off. -If the maximum retry limit is reached, processing halts and all failed requests are returned in the response. -Any delete requests that completed successfully still stick, they are not rolled back. - -You can opt to count version conflicts instead of halting and returning by setting `conflicts` to `proceed`. -Note that if you opt to count version conflicts the operation could attempt to delete more documents from the source than `max_docs` until it has successfully deleted `max_docs documents`, or it has gone through every document in the source query. - -**Throttling delete requests** - -To control the rate at which delete by query issues batches of delete operations, you can set `requests_per_second` to any positive decimal number. -This pads each batch with a wait time to throttle the rate. -Set `requests_per_second` to `-1` to disable throttling. - -Throttling uses a wait time between batches so that the internal scroll requests can be given a timeout that takes the request padding into account. -The padding time is the difference between the batch size divided by the `requests_per_second` and the time spent writing. -By default the batch size is `1000`, so if `requests_per_second` is set to `500`: - -``` -target_time = 1000 / 500 per second = 2 seconds -wait_time = target_time - write_time = 2 seconds - .5 seconds = 1.5 seconds -``` - -Since the batch is issued as a single `_bulk` request, large batch sizes cause Elasticsearch to create many requests and wait before starting the next set. -This is "bursty" instead of "smooth". - -**Slicing** - -Delete by query supports sliced scroll to parallelize the delete process. -This can improve efficiency and provide a convenient way to break the request down into smaller parts. - -Setting `slices` to `auto` lets Elasticsearch choose the number of slices to use. -This setting will use one slice per shard, up to a certain limit. -If there are multiple source data streams or indices, it will choose the number of slices based on the index or backing index with the smallest number of shards. -Adding slices to the delete by query operation creates sub-requests which means it has some quirks: - -* You can see these requests in the tasks APIs. These sub-requests are "child" tasks of the task for the request with slices. -* Fetching the status of the task for the request with slices only contains the status of completed slices. -* These sub-requests are individually addressable for things like cancellation and rethrottling. -* Rethrottling the request with `slices` will rethrottle the unfinished sub-request proportionally. -* Canceling the request with `slices` will cancel each sub-request. -* Due to the nature of `slices` each sub-request won't get a perfectly even portion of the documents. All documents will be addressed, but some slices may be larger than others. Expect larger slices to have a more even distribution. -* Parameters like `requests_per_second` and `max_docs` on a request with `slices` are distributed proportionally to each sub-request. Combine that with the earlier point about distribution being uneven and you should conclude that using `max_docs` with `slices` might not result in exactly `max_docs` documents being deleted. -* Each sub-request gets a slightly different snapshot of the source data stream or index though these are all taken at approximately the same time. - -If you're slicing manually or otherwise tuning automatic slicing, keep in mind that: - -* Query performance is most efficient when the number of slices is equal to the number of shards in the index or backing index. If that number is large (for example, 500), choose a lower number as too many `slices` hurts performance. Setting `slices` higher than the number of shards generally does not improve efficiency and adds overhead. -* Delete performance scales linearly across available resources with the number of slices. - -Whether query or delete performance dominates the runtime depends on the documents being reindexed and cluster resources. - -**Cancel a delete by query operation** - -Any delete by query can be canceled using the task cancel API. For example: - -``` -POST _tasks/r1A2WoRbTwKZ516z6NEs5A:36619/_cancel -``` - -The task ID can be found by using the get tasks API. - -Cancellation should happen quickly but might take a few seconds. -The get task status API will continue to list the delete by query task until this task checks that it has been cancelled and terminates itself. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-delete-by-query) - -```ts -client.deleteByQuery({ index }) -``` -### Arguments [_arguments_delete_by_query] - -#### Request (object) [_request_delete_by_query] - -- **`index` (string \| string[])**: A list of data streams, indices, and aliases to search. It supports wildcards (`*`). To search all data streams or indices, omit this parameter or use `*` or `_all`. -- **`max_docs` (Optional, number)**: The maximum number of documents to delete. -- **`query` (Optional, { bool, boosting, common, combined_fields, constant_score, dis_max, distance_feature, exists, function_score, fuzzy, geo_bounding_box, geo_distance, geo_grid, geo_polygon, geo_shape, has_child, has_parent, ids, intervals, knn, match, match_all, match_bool_prefix, match_none, match_phrase, match_phrase_prefix, more_like_this, multi_match, nested, parent_id, percolate, pinned, prefix, query_string, range, rank_feature, regexp, rule, script, script_score, semantic, shape, simple_query_string, span_containing, span_field_masking, span_first, span_multi, span_near, span_not, span_or, span_term, span_within, sparse_vector, term, terms, terms_set, text_expansion, weighted_tokens, wildcard, wrapper, type })**: The documents to delete specified with Query DSL. -- **`slice` (Optional, { field, id, max })**: Slice the request manually using the provided slice ID and total number of slices. -- **`allow_no_indices` (Optional, boolean)**: If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. -- **`analyzer` (Optional, string)**: Analyzer to use for the query string. This parameter can be used only when the `q` query string parameter is specified. -- **`analyze_wildcard` (Optional, boolean)**: If `true`, wildcard and prefix queries are analyzed. This parameter can be used only when the `q` query string parameter is specified. -- **`conflicts` (Optional, Enum("abort" \| "proceed"))**: What to do if delete by query hits version conflicts: `abort` or `proceed`. -- **`default_operator` (Optional, Enum("and" \| "or"))**: The default operator for query string query: `AND` or `OR`. This parameter can be used only when the `q` query string parameter is specified. -- **`df` (Optional, string)**: The field to use as default where no field prefix is given in the query string. This parameter can be used only when the `q` query string parameter is specified. -- **`expand_wildcards` (Optional, Enum("all" \| "open" \| "closed" \| "hidden" \| "none") \| Enum("all" \| "open" \| "closed" \| "hidden" \| "none")[])**: The type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. It supports a list of values, such as `open,hidden`. -- **`from` (Optional, number)**: Skips the specified number of documents. -- **`ignore_unavailable` (Optional, boolean)**: If `false`, the request returns an error if it targets a missing or closed index. -- **`lenient` (Optional, boolean)**: If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. This parameter can be used only when the `q` query string parameter is specified. -- **`preference` (Optional, string)**: The node or shard the operation should be performed on. It is random by default. -- **`refresh` (Optional, boolean)**: If `true`, Elasticsearch refreshes all shards involved in the delete by query after the request completes. This is different than the delete API's `refresh` parameter, which causes just the shard that received the delete request to be refreshed. Unlike the delete API, it does not support `wait_for`. -- **`request_cache` (Optional, boolean)**: If `true`, the request cache is used for this request. Defaults to the index-level setting. -- **`requests_per_second` (Optional, float)**: The throttle for this request in sub-requests per second. -- **`routing` (Optional, string)**: A custom value used to route operations to a specific shard. -- **`q` (Optional, string)**: A query in the Lucene query string syntax. -- **`scroll` (Optional, string \| -1 \| 0)**: The period to retain the search context for scrolling. -- **`scroll_size` (Optional, number)**: The size of the scroll request that powers the operation. -- **`search_timeout` (Optional, string \| -1 \| 0)**: The explicit timeout for each search request. It defaults to no timeout. -- **`search_type` (Optional, Enum("query_then_fetch" \| "dfs_query_then_fetch"))**: The type of the search operation. Available options include `query_then_fetch` and `dfs_query_then_fetch`. -- **`slices` (Optional, number \| Enum("auto"))**: The number of slices this task should be divided into. -- **`sort` (Optional, string[])**: A list of `:` pairs. -- **`stats` (Optional, string[])**: The specific `tag` of the request for logging and statistical purposes. -- **`terminate_after` (Optional, number)**: The maximum number of documents to collect for each shard. If a query reaches this limit, Elasticsearch terminates the query early. Elasticsearch collects documents before sorting. Use with caution. Elasticsearch applies this parameter to each shard handling the request. When possible, let Elasticsearch perform early termination automatically. Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers. -- **`timeout` (Optional, string \| -1 \| 0)**: The period each deletion request waits for active shards. -- **`version` (Optional, boolean)**: If `true`, returns the document version as part of a hit. -- **`wait_for_active_shards` (Optional, number \| Enum("all" \| "index-setting"))**: The number of shard copies that must be active before proceeding with the operation. Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). The `timeout` value controls how long each write request waits for unavailable shards to become available. -- **`wait_for_completion` (Optional, boolean)**: If `true`, the request blocks until the operation is complete. If `false`, Elasticsearch performs some preflight checks, launches the request, and returns a task you can use to cancel or get the status of the task. Elasticsearch creates a record of this task as a document at `.tasks/task/${taskId}`. When you are done with a task, you should delete the task document so Elasticsearch can reclaim the space. - -## client.deleteByQueryRethrottle [_delete_by_query_rethrottle] -Throttle a delete by query operation. - -Change the number of requests per second for a particular delete by query operation. -Rethrottling that speeds up the query takes effect immediately but rethrotting that slows down the query takes effect after completing the current batch to prevent scroll timeouts. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-delete-by-query-rethrottle) - -```ts -client.deleteByQueryRethrottle({ task_id }) -``` -### Arguments [_arguments_delete_by_query_rethrottle] - -#### Request (object) [_request_delete_by_query_rethrottle] - -- **`task_id` (string \| number)**: The ID for the task. -- **`requests_per_second` (Optional, float)**: The throttle for this request in sub-requests per second. To disable throttling, set it to `-1`. - -## client.deleteScript [_delete_script] -Delete a script or search template. -Deletes a stored script or search template. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-delete-script) - -```ts -client.deleteScript({ id }) -``` -### Arguments [_arguments_delete_script] - -#### Request (object) [_request_delete_script] - -- **`id` (string)**: The identifier for the stored script or search template. -- **`master_timeout` (Optional, string \| -1 \| 0)**: The period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. It can also be set to `-1` to indicate that the request should never timeout. -- **`timeout` (Optional, string \| -1 \| 0)**: The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. It can also be set to `-1` to indicate that the request should never timeout. - -## client.exists [_exists] -Check a document. - -Verify that a document exists. -For example, check to see if a document with the `_id` 0 exists: - -``` -HEAD my-index-000001/_doc/0 -``` - -If the document exists, the API returns a status code of `200 - OK`. -If the document doesn’t exist, the API returns `404 - Not Found`. - -**Versioning support** - -You can use the `version` parameter to check the document only if its current version is equal to the specified one. - -Internally, Elasticsearch has marked the old document as deleted and added an entirely new document. -The old version of the document doesn't disappear immediately, although you won't be able to access it. -Elasticsearch cleans up deleted documents in the background as you continue to index more data. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-get) - -```ts -client.exists({ id, index }) -``` -### Arguments [_arguments_exists] - -#### Request (object) [_request_exists] - -- **`id` (string)**: A unique document identifier. -- **`index` (string)**: A list of data streams, indices, and aliases. It supports wildcards (`*`). -- **`preference` (Optional, string)**: The node or shard the operation should be performed on. By default, the operation is randomized between the shard replicas. If it is set to `_local`, the operation will prefer to be run on a local allocated shard when possible. If it is set to a custom value, the value is used to guarantee that the same shards will be used for the same custom value. This can help with "jumping values" when hitting different shards in different refresh states. A sample value can be something like the web session ID or the user name. -- **`realtime` (Optional, boolean)**: If `true`, the request is real-time as opposed to near-real-time. -- **`refresh` (Optional, boolean)**: If `true`, the request refreshes the relevant shards before retrieving the document. Setting it to `true` should be done after careful thought and verification that this does not cause a heavy load on the system (and slow down indexing). -- **`routing` (Optional, string)**: A custom value used to route operations to a specific shard. -- **`_source` (Optional, boolean \| string \| string[])**: Indicates whether to return the `_source` field (`true` or `false`) or lists the fields to return. -- **`_source_excludes` (Optional, string \| string[])**: A list of source fields to exclude from the response. You can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter. If the `_source` parameter is `false`, this parameter is ignored. -- **`_source_includes` (Optional, string \| string[])**: A list of source fields to include in the response. If this parameter is specified, only these source fields are returned. You can exclude fields from this subset using the `_source_excludes` query parameter. If the `_source` parameter is `false`, this parameter is ignored. -- **`stored_fields` (Optional, string \| string[])**: A list of stored fields to return as part of a hit. If no fields are specified, no stored fields are included in the response. If this field is specified, the `_source` parameter defaults to `false`. -- **`version` (Optional, number)**: Explicit version number for concurrency control. The specified version must match the current version of the document for the request to succeed. -- **`version_type` (Optional, Enum("internal" \| "external" \| "external_gte" \| "force"))**: The version type. - -## client.existsSource [_exists_source] -Check for a document source. - -Check whether a document source exists in an index. -For example: - -``` -HEAD my-index-000001/_source/1 -``` - -A document's source is not available if it is disabled in the mapping. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-get) - -```ts -client.existsSource({ id, index }) -``` -### Arguments [_arguments_exists_source] - -#### Request (object) [_request_exists_source] - -- **`id` (string)**: A unique identifier for the document. -- **`index` (string)**: A list of data streams, indices, and aliases. It supports wildcards (`*`). -- **`preference` (Optional, string)**: The node or shard the operation should be performed on. By default, the operation is randomized between the shard replicas. -- **`realtime` (Optional, boolean)**: If `true`, the request is real-time as opposed to near-real-time. -- **`refresh` (Optional, boolean)**: If `true`, the request refreshes the relevant shards before retrieving the document. Setting it to `true` should be done after careful thought and verification that this does not cause a heavy load on the system (and slow down indexing). -- **`routing` (Optional, string)**: A custom value used to route operations to a specific shard. -- **`_source` (Optional, boolean \| string \| string[])**: Indicates whether to return the `_source` field (`true` or `false`) or lists the fields to return. -- **`_source_excludes` (Optional, string \| string[])**: A list of source fields to exclude in the response. -- **`_source_includes` (Optional, string \| string[])**: A list of source fields to include in the response. -- **`version` (Optional, number)**: The version number for concurrency control. It must match the current version of the document for the request to succeed. -- **`version_type` (Optional, Enum("internal" \| "external" \| "external_gte" \| "force"))**: The version type. - -## client.explain [_explain] -Explain a document match result. -Get information about why a specific document matches, or doesn't match, a query. -It computes a score explanation for a query and a specific document. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-explain) - -```ts -client.explain({ id, index }) -``` -### Arguments [_arguments_explain] - -#### Request (object) [_request_explain] - -- **`id` (string)**: The document identifier. -- **`index` (string)**: Index names that are used to limit the request. Only a single index name can be provided to this parameter. -- **`query` (Optional, { bool, boosting, common, combined_fields, constant_score, dis_max, distance_feature, exists, function_score, fuzzy, geo_bounding_box, geo_distance, geo_grid, geo_polygon, geo_shape, has_child, has_parent, ids, intervals, knn, match, match_all, match_bool_prefix, match_none, match_phrase, match_phrase_prefix, more_like_this, multi_match, nested, parent_id, percolate, pinned, prefix, query_string, range, rank_feature, regexp, rule, script, script_score, semantic, shape, simple_query_string, span_containing, span_field_masking, span_first, span_multi, span_near, span_not, span_or, span_term, span_within, sparse_vector, term, terms, terms_set, text_expansion, weighted_tokens, wildcard, wrapper, type })**: Defines the search definition using the Query DSL. -- **`analyzer` (Optional, string)**: The analyzer to use for the query string. This parameter can be used only when the `q` query string parameter is specified. -- **`analyze_wildcard` (Optional, boolean)**: If `true`, wildcard and prefix queries are analyzed. This parameter can be used only when the `q` query string parameter is specified. -- **`default_operator` (Optional, Enum("and" \| "or"))**: The default operator for query string query: `AND` or `OR`. This parameter can be used only when the `q` query string parameter is specified. -- **`df` (Optional, string)**: The field to use as default where no field prefix is given in the query string. This parameter can be used only when the `q` query string parameter is specified. -- **`lenient` (Optional, boolean)**: If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. This parameter can be used only when the `q` query string parameter is specified. -- **`preference` (Optional, string)**: The node or shard the operation should be performed on. It is random by default. -- **`routing` (Optional, string)**: A custom value used to route operations to a specific shard. -- **`_source` (Optional, boolean \| string \| string[])**: `True` or `false` to return the `_source` field or not or a list of fields to return. -- **`_source_excludes` (Optional, string \| string[])**: A list of source fields to exclude from the response. You can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter. If the `_source` parameter is `false`, this parameter is ignored. -- **`_source_includes` (Optional, string \| string[])**: A list of source fields to include in the response. If this parameter is specified, only these source fields are returned. You can exclude fields from this subset using the `_source_excludes` query parameter. If the `_source` parameter is `false`, this parameter is ignored. -- **`stored_fields` (Optional, string \| string[])**: A list of stored fields to return in the response. -- **`q` (Optional, string)**: The query in the Lucene query string syntax. - -## client.fieldCaps [_field_caps] -Get the field capabilities. - -Get information about the capabilities of fields among multiple indices. - -For data streams, the API returns field capabilities among the stream’s backing indices. -It returns runtime fields like any other field. -For example, a runtime field with a type of keyword is returned the same as any other field that belongs to the `keyword` family. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-field-caps) - -```ts -client.fieldCaps({ ... }) -``` -### Arguments [_arguments_field_caps] - -#### Request (object) [_request_field_caps] - -- **`index` (Optional, string \| string[])**: A list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indices, omit this parameter or use * or _all. -- **`fields` (Optional, string \| string[])**: A list of fields to retrieve capabilities for. Wildcard (`*`) expressions are supported. -- **`index_filter` (Optional, { bool, boosting, common, combined_fields, constant_score, dis_max, distance_feature, exists, function_score, fuzzy, geo_bounding_box, geo_distance, geo_grid, geo_polygon, geo_shape, has_child, has_parent, ids, intervals, knn, match, match_all, match_bool_prefix, match_none, match_phrase, match_phrase_prefix, more_like_this, multi_match, nested, parent_id, percolate, pinned, prefix, query_string, range, rank_feature, regexp, rule, script, script_score, semantic, shape, simple_query_string, span_containing, span_field_masking, span_first, span_multi, span_near, span_not, span_or, span_term, span_within, sparse_vector, term, terms, terms_set, text_expansion, weighted_tokens, wildcard, wrapper, type })**: Filter indices if the provided query rewrites to `match_none` on every shard. IMPORTANT: The filtering is done on a best-effort basis, it uses index statistics and mappings to rewrite queries to `match_none` instead of fully running the request. For instance a range query over a date field can rewrite to `match_none` if all documents within a shard (including deleted documents) are outside of the provided range. However, not all queries can rewrite to `match_none` so this API may return an index even if the provided filter matches no document. -- **`runtime_mappings` (Optional, Record)**: Define ad-hoc runtime fields in the request similar to the way it is done in search requests. These fields exist only as part of the query and take precedence over fields defined with the same name in the index mappings. -- **`allow_no_indices` (Optional, boolean)**: If false, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting `foo*,bar*` returns an error if an index starts with foo but no index starts with bar. -- **`expand_wildcards` (Optional, Enum("all" \| "open" \| "closed" \| "hidden" \| "none") \| Enum("all" \| "open" \| "closed" \| "hidden" \| "none")[])**: The type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports a list of values, such as `open,hidden`. -- **`ignore_unavailable` (Optional, boolean)**: If `true`, missing or closed indices are not included in the response. -- **`include_unmapped` (Optional, boolean)**: If true, unmapped fields are included in the response. -- **`filters` (Optional, string)**: A list of filters to apply to the response. -- **`types` (Optional, string[])**: A list of field types to include. Any fields that do not match one of these types will be excluded from the results. It defaults to empty, meaning that all field types are returned. -- **`include_empty_fields` (Optional, boolean)**: If false, empty fields are not included in the response. - -## client.get [_get] -Get a document by its ID. - -Get a document and its source or stored fields from an index. - -By default, this API is realtime and is not affected by the refresh rate of the index (when data will become visible for search). -In the case where stored fields are requested with the `stored_fields` parameter and the document has been updated but is not yet refreshed, the API will have to parse and analyze the source to extract the stored fields. -To turn off realtime behavior, set the `realtime` parameter to false. - -**Source filtering** - -By default, the API returns the contents of the `_source` field unless you have used the `stored_fields` parameter or the `_source` field is turned off. -You can turn off `_source` retrieval by using the `_source` parameter: - -``` -GET my-index-000001/_doc/0?_source=false -``` - -If you only need one or two fields from the `_source`, use the `_source_includes` or `_source_excludes` parameters to include or filter out particular fields. -This can be helpful with large documents where partial retrieval can save on network overhead -Both parameters take a comma separated list of fields or wildcard expressions. -For example: - -``` -GET my-index-000001/_doc/0?_source_includes=*.id&_source_excludes=entities -``` - -If you only want to specify includes, you can use a shorter notation: - -``` -GET my-index-000001/_doc/0?_source=*.id -``` - -**Routing** - -If routing is used during indexing, the routing value also needs to be specified to retrieve a document. -For example: - -``` -GET my-index-000001/_doc/2?routing=user1 -``` - -This request gets the document with ID 2, but it is routed based on the user. -The document is not fetched if the correct routing is not specified. - -**Distributed** - -The GET operation is hashed into a specific shard ID. -It is then redirected to one of the replicas within that shard ID and returns the result. -The replicas are the primary shard and its replicas within that shard ID group. -This means that the more replicas you have, the better your GET scaling will be. - -**Versioning support** - -You can use the `version` parameter to retrieve the document only if its current version is equal to the specified one. - -Internally, Elasticsearch has marked the old document as deleted and added an entirely new document. -The old version of the document doesn't disappear immediately, although you won't be able to access it. -Elasticsearch cleans up deleted documents in the background as you continue to index more data. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-get) - -```ts -client.get({ id, index }) -``` -### Arguments [_arguments_get] - -#### Request (object) [_request_get] - -- **`id` (string)**: A unique document identifier. -- **`index` (string)**: The name of the index that contains the document. -- **`force_synthetic_source` (Optional, boolean)**: Indicates whether the request forces synthetic `_source`. Use this paramater to test if the mapping supports synthetic `_source` and to get a sense of the worst case performance. Fetches with this parameter enabled will be slower than enabling synthetic source natively in the index. -- **`preference` (Optional, string)**: The node or shard the operation should be performed on. By default, the operation is randomized between the shard replicas. If it is set to `_local`, the operation will prefer to be run on a local allocated shard when possible. If it is set to a custom value, the value is used to guarantee that the same shards will be used for the same custom value. This can help with "jumping values" when hitting different shards in different refresh states. A sample value can be something like the web session ID or the user name. -- **`realtime` (Optional, boolean)**: If `true`, the request is real-time as opposed to near-real-time. -- **`refresh` (Optional, boolean)**: If `true`, the request refreshes the relevant shards before retrieving the document. Setting it to `true` should be done after careful thought and verification that this does not cause a heavy load on the system (and slow down indexing). -- **`routing` (Optional, string)**: A custom value used to route operations to a specific shard. -- **`_source` (Optional, boolean \| string \| string[])**: Indicates whether to return the `_source` field (`true` or `false`) or lists the fields to return. -- **`_source_excludes` (Optional, string \| string[])**: A list of source fields to exclude from the response. You can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter. If the `_source` parameter is `false`, this parameter is ignored. -- **`_source_includes` (Optional, string \| string[])**: A list of source fields to include in the response. If this parameter is specified, only these source fields are returned. You can exclude fields from this subset using the `_source_excludes` query parameter. If the `_source` parameter is `false`, this parameter is ignored. -- **`stored_fields` (Optional, string \| string[])**: A list of stored fields to return as part of a hit. If no fields are specified, no stored fields are included in the response. If this field is specified, the `_source` parameter defaults to `false`. Only leaf fields can be retrieved with the `stored_field` option. Object fields can't be returned;if specified, the request fails. -- **`version` (Optional, number)**: The version number for concurrency control. It must match the current version of the document for the request to succeed. -- **`version_type` (Optional, Enum("internal" \| "external" \| "external_gte" \| "force"))**: The version type. - -## client.getScript [_get_script] -Get a script or search template. -Retrieves a stored script or search template. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-get-script) - -```ts -client.getScript({ id }) -``` -### Arguments [_arguments_get_script] - -#### Request (object) [_request_get_script] - -- **`id` (string)**: The identifier for the stored script or search template. -- **`master_timeout` (Optional, string \| -1 \| 0)**: The period to wait for the master node. If the master node is not available before the timeout expires, the request fails and returns an error. It can also be set to `-1` to indicate that the request should never timeout. - -## client.getScriptContext [_get_script_context] -Get script contexts. - -Get a list of supported script contexts and their methods. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-get-script-context) - -```ts -client.getScriptContext() -``` - -## client.getScriptLanguages [_get_script_languages] -Get script languages. - -Get a list of available script types, languages, and contexts. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-get-script-languages) - -```ts -client.getScriptLanguages() -``` - -## client.getSource [_get_source] -Get a document's source. - -Get the source of a document. -For example: - -``` -GET my-index-000001/_source/1 -``` - -You can use the source filtering parameters to control which parts of the `_source` are returned: - -``` -GET my-index-000001/_source/1/?_source_includes=*.id&_source_excludes=entities -``` - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-get) - -```ts -client.getSource({ id, index }) -``` -### Arguments [_arguments_get_source] - -#### Request (object) [_request_get_source] - -- **`id` (string)**: A unique document identifier. -- **`index` (string)**: The name of the index that contains the document. -- **`preference` (Optional, string)**: The node or shard the operation should be performed on. By default, the operation is randomized between the shard replicas. -- **`realtime` (Optional, boolean)**: If `true`, the request is real-time as opposed to near-real-time. -- **`refresh` (Optional, boolean)**: If `true`, the request refreshes the relevant shards before retrieving the document. Setting it to `true` should be done after careful thought and verification that this does not cause a heavy load on the system (and slow down indexing). -- **`routing` (Optional, string)**: A custom value used to route operations to a specific shard. -- **`_source` (Optional, boolean \| string \| string[])**: Indicates whether to return the `_source` field (`true` or `false`) or lists the fields to return. -- **`_source_excludes` (Optional, string \| string[])**: A list of source fields to exclude in the response. -- **`_source_includes` (Optional, string \| string[])**: A list of source fields to include in the response. -- **`stored_fields` (Optional, string \| string[])**: A list of stored fields to return as part of a hit. -- **`version` (Optional, number)**: The version number for concurrency control. It must match the current version of the document for the request to succeed. -- **`version_type` (Optional, Enum("internal" \| "external" \| "external_gte" \| "force"))**: The version type. - -## client.healthReport [_health_report] -Get the cluster health. -Get a report with the health status of an Elasticsearch cluster. -The report contains a list of indicators that compose Elasticsearch functionality. - -Each indicator has a health status of: green, unknown, yellow or red. -The indicator will provide an explanation and metadata describing the reason for its current health status. - -The cluster’s status is controlled by the worst indicator status. - -In the event that an indicator’s status is non-green, a list of impacts may be present in the indicator result which detail the functionalities that are negatively affected by the health issue. -Each impact carries with it a severity level, an area of the system that is affected, and a simple description of the impact on the system. - -Some health indicators can determine the root cause of a health problem and prescribe a set of steps that can be performed in order to improve the health of the system. -The root cause and remediation steps are encapsulated in a diagnosis. -A diagnosis contains a cause detailing a root cause analysis, an action containing a brief description of the steps to take to fix the problem, the list of affected resources (if applicable), and a detailed step-by-step troubleshooting guide to fix the diagnosed problem. - -NOTE: The health indicators perform root cause analysis of non-green health statuses. This can be computationally expensive when called frequently. -When setting up automated polling of the API for health status, set verbose to false to disable the more expensive analysis logic. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-health-report) - -```ts -client.healthReport({ ... }) -``` -### Arguments [_arguments_health_report] - -#### Request (object) [_request_health_report] - -- **`feature` (Optional, string \| string[])**: A feature of the cluster, as returned by the top-level health report API. -- **`timeout` (Optional, string \| -1 \| 0)**: Explicit operation timeout. -- **`verbose` (Optional, boolean)**: Opt-in for more information about the health of the system. -- **`size` (Optional, number)**: Limit the number of affected resources the health report API returns. - -## client.index [_index] -Create or update a document in an index. - -Add a JSON document to the specified data stream or index and make it searchable. -If the target is an index and the document already exists, the request updates the document and increments its version. - -NOTE: You cannot use this API to send update requests for existing documents in a data stream. - -If the Elasticsearch security features are enabled, you must have the following index privileges for the target data stream, index, or index alias: - -* To add or overwrite a document using the `PUT //_doc/<_id>` request format, you must have the `create`, `index`, or `write` index privilege. -* To add a document using the `POST //_doc/` request format, you must have the `create_doc`, `create`, `index`, or `write` index privilege. -* To automatically create a data stream or index with this API request, you must have the `auto_configure`, `create_index`, or `manage` index privilege. - -Automatic data stream creation requires a matching index template with data stream enabled. - -NOTE: Replica shards might not all be started when an indexing operation returns successfully. -By default, only the primary is required. Set `wait_for_active_shards` to change this default behavior. - -**Automatically create data streams and indices** - -If the request's target doesn't exist and matches an index template with a `data_stream` definition, the index operation automatically creates the data stream. - -If the target doesn't exist and doesn't match a data stream template, the operation automatically creates the index and applies any matching index templates. - -NOTE: Elasticsearch includes several built-in index templates. To avoid naming collisions with these templates, refer to index pattern documentation. - -If no mapping exists, the index operation creates a dynamic mapping. -By default, new fields and objects are automatically added to the mapping if needed. - -Automatic index creation is controlled by the `action.auto_create_index` setting. -If it is `true`, any index can be created automatically. -You can modify this setting to explicitly allow or block automatic creation of indices that match specified patterns or set it to `false` to turn off automatic index creation entirely. -Specify a list of patterns you want to allow or prefix each pattern with `+` or `-` to indicate whether it should be allowed or blocked. -When a list is specified, the default behaviour is to disallow. - -NOTE: The `action.auto_create_index` setting affects the automatic creation of indices only. -It does not affect the creation of data streams. - -**Optimistic concurrency control** - -Index operations can be made conditional and only be performed if the last modification to the document was assigned the sequence number and primary term specified by the `if_seq_no` and `if_primary_term` parameters. -If a mismatch is detected, the operation will result in a `VersionConflictException` and a status code of `409`. - -**Routing** - -By default, shard placement — or routing — is controlled by using a hash of the document's ID value. -For more explicit control, the value fed into the hash function used by the router can be directly specified on a per-operation basis using the `routing` parameter. - -When setting up explicit mapping, you can also use the `_routing` field to direct the index operation to extract the routing value from the document itself. -This does come at the (very minimal) cost of an additional document parsing pass. -If the `_routing` mapping is defined and set to be required, the index operation will fail if no routing value is provided or extracted. - -NOTE: Data streams do not support custom routing unless they were created with the `allow_custom_routing` setting enabled in the template. - -**Distributed** - -The index operation is directed to the primary shard based on its route and performed on the actual node containing this shard. -After the primary shard completes the operation, if needed, the update is distributed to applicable replicas. - -**Active shards** - -To improve the resiliency of writes to the system, indexing operations can be configured to wait for a certain number of active shard copies before proceeding with the operation. -If the requisite number of active shard copies are not available, then the write operation must wait and retry, until either the requisite shard copies have started or a timeout occurs. -By default, write operations only wait for the primary shards to be active before proceeding (that is to say `wait_for_active_shards` is `1`). -This default can be overridden in the index settings dynamically by setting `index.write.wait_for_active_shards`. -To alter this behavior per operation, use the `wait_for_active_shards request` parameter. - -Valid values are all or any positive integer up to the total number of configured copies per shard in the index (which is `number_of_replicas`+1). -Specifying a negative value or a number greater than the number of shard copies will throw an error. - -For example, suppose you have a cluster of three nodes, A, B, and C and you create an index index with the number of replicas set to 3 (resulting in 4 shard copies, one more copy than there are nodes). -If you attempt an indexing operation, by default the operation will only ensure the primary copy of each shard is available before proceeding. -This means that even if B and C went down and A hosted the primary shard copies, the indexing operation would still proceed with only one copy of the data. -If `wait_for_active_shards` is set on the request to `3` (and all three nodes are up), the indexing operation will require 3 active shard copies before proceeding. -This requirement should be met because there are 3 active nodes in the cluster, each one holding a copy of the shard. -However, if you set `wait_for_active_shards` to `all` (or to `4`, which is the same in this situation), the indexing operation will not proceed as you do not have all 4 copies of each shard active in the index. -The operation will timeout unless a new node is brought up in the cluster to host the fourth copy of the shard. - -It is important to note that this setting greatly reduces the chances of the write operation not writing to the requisite number of shard copies, but it does not completely eliminate the possibility, because this check occurs before the write operation starts. -After the write operation is underway, it is still possible for replication to fail on any number of shard copies but still succeed on the primary. -The `_shards` section of the API response reveals the number of shard copies on which replication succeeded and failed. - -**No operation (noop) updates** - -When updating a document by using this API, a new version of the document is always created even if the document hasn't changed. -If this isn't acceptable use the `_update` API with `detect_noop` set to `true`. -The `detect_noop` option isn't available on this API because it doesn’t fetch the old source and isn't able to compare it against the new source. - -There isn't a definitive rule for when noop updates aren't acceptable. -It's a combination of lots of factors like how frequently your data source sends updates that are actually noops and how many queries per second Elasticsearch runs on the shard receiving the updates. - -**Versioning** - -Each indexed document is given a version number. -By default, internal versioning is used that starts at 1 and increments with each update, deletes included. -Optionally, the version number can be set to an external value (for example, if maintained in a database). -To enable this functionality, `version_type` should be set to `external`. -The value provided must be a numeric, long value greater than or equal to 0, and less than around `9.2e+18`. - -NOTE: Versioning is completely real time, and is not affected by the near real time aspects of search operations. -If no version is provided, the operation runs without any version checks. - -When using the external version type, the system checks to see if the version number passed to the index request is greater than the version of the currently stored document. -If true, the document will be indexed and the new version number used. -If the value provided is less than or equal to the stored document's version number, a version conflict will occur and the index operation will fail. For example: - -``` -PUT my-index-000001/_doc/1?version=2&version_type=external -{ - "user": { - "id": "elkbee" - } -} - -In this example, the operation will succeed since the supplied version of 2 is higher than the current document version of 1. -If the document was already updated and its version was set to 2 or higher, the indexing command will fail and result in a conflict (409 HTTP status code). - -A nice side effect is that there is no need to maintain strict ordering of async indexing operations run as a result of changes to a source database, as long as version numbers from the source database are used. -Even the simple case of updating the Elasticsearch index using data from a database is simplified if external versioning is used, as only the latest version will be used if the index operations arrive out of order. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-create) - -```ts -client.index({ index }) -``` -### Arguments [_arguments_index] - -#### Request (object) [_request_index] - -- **`index` (string)**: The name of the data stream or index to target. If the target doesn't exist and matches the name or wildcard (`*`) pattern of an index template with a `data_stream` definition, this request creates the data stream. If the target doesn't exist and doesn't match a data stream template, this request creates the index. You can check for existing targets with the resolve index API. -- **`id` (Optional, string)**: A unique identifier for the document. To automatically generate a document ID, use the `POST //_doc/` request format and omit this parameter. -- **`document` (Optional, object)**: A document. -- **`if_primary_term` (Optional, number)**: Only perform the operation if the document has this primary term. -- **`if_seq_no` (Optional, number)**: Only perform the operation if the document has this sequence number. -- **`include_source_on_error` (Optional, boolean)**: True or false if to include the document source in the error message in case of parsing errors. -- **`op_type` (Optional, Enum("index" \| "create"))**: Set to `create` to only index the document if it does not already exist (put if absent). If a document with the specified `_id` already exists, the indexing operation will fail. The behavior is the same as using the `/_create` endpoint. If a document ID is specified, this paramater defaults to `index`. Otherwise, it defaults to `create`. If the request targets a data stream, an `op_type` of `create` is required. -- **`pipeline` (Optional, string)**: The ID of the pipeline to use to preprocess incoming documents. If the index has a default ingest pipeline specified, then setting the value to `_none` disables the default ingest pipeline for this request. If a final pipeline is configured it will always run, regardless of the value of this parameter. -- **`refresh` (Optional, Enum(true \| false \| "wait_for"))**: If `true`, Elasticsearch refreshes the affected shards to make this operation visible to search. If `wait_for`, it waits for a refresh to make this operation visible to search. If `false`, it does nothing with refreshes. -- **`routing` (Optional, string)**: A custom value that is used to route operations to a specific shard. -- **`timeout` (Optional, string \| -1 \| 0)**: The period the request waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards. This parameter is useful for situations where the primary shard assigned to perform the operation might not be available when the operation runs. Some reasons for this might be that the primary shard is currently recovering from a gateway or undergoing relocation. By default, the operation will wait on the primary shard to become available for at least 1 minute before failing and responding with an error. The actual wait time could be longer, particularly when multiple waits occur. -- **`version` (Optional, number)**: An explicit version number for concurrency control. It must be a non-negative long number. -- **`version_type` (Optional, Enum("internal" \| "external" \| "external_gte" \| "force"))**: The version type. -- **`wait_for_active_shards` (Optional, number \| Enum("all" \| "index-setting"))**: The number of shard copies that must be active before proceeding with the operation. You can set it to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). The default value of `1` means it waits for each primary shard to be active. -- **`require_alias` (Optional, boolean)**: If `true`, the destination must be an index alias. - -## client.info [_info] -Get cluster info. -Get basic build, version, and cluster information. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-info) - -```ts -client.info() -``` - -## client.knnSearch [_knn_search] -Performs a kNN search. - -[Endpoint documentation](https://www.elastic.co/guide/en/elasticsearch/reference/master/search-search.html) - -```ts -client.knnSearch() -``` - -## client.mget [_mget] -Get multiple documents. - -Get multiple JSON documents by ID from one or more indices. -If you specify an index in the request URI, you only need to specify the document IDs in the request body. -To ensure fast responses, this multi get (mget) API responds with partial results if one or more shards fail. - -**Filter source fields** - -By default, the `_source` field is returned for every document (if stored). -Use the `_source` and `_source_include` or `source_exclude` attributes to filter what fields are returned for a particular document. -You can include the `_source`, `_source_includes`, and `_source_excludes` query parameters in the request URI to specify the defaults to use when there are no per-document instructions. - -**Get stored fields** - -Use the `stored_fields` attribute to specify the set of stored fields you want to retrieve. -Any requested fields that are not stored are ignored. -You can include the `stored_fields` query parameter in the request URI to specify the defaults to use when there are no per-document instructions. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-mget) - -```ts -client.mget({ ... }) -``` -### Arguments [_arguments_mget] - -#### Request (object) [_request_mget] - -- **`index` (Optional, string)**: Name of the index to retrieve documents from when `ids` are specified, or when a document in the `docs` array does not specify an index. -- **`docs` (Optional, { _id, _index, routing, _source, stored_fields, version, version_type }[])**: The documents you want to retrieve. Required if no index is specified in the request URI. -- **`ids` (Optional, string \| string[])**: The IDs of the documents you want to retrieve. Allowed when the index is specified in the request URI. -- **`force_synthetic_source` (Optional, boolean)**: Should this request force synthetic _source? Use this to test if the mapping supports synthetic _source and to get a sense of the worst case performance. Fetches with this enabled will be slower the enabling synthetic source natively in the index. -- **`preference` (Optional, string)**: Specifies the node or shard the operation should be performed on. Random by default. -- **`realtime` (Optional, boolean)**: If `true`, the request is real-time as opposed to near-real-time. -- **`refresh` (Optional, boolean)**: If `true`, the request refreshes relevant shards before retrieving documents. -- **`routing` (Optional, string)**: Custom value used to route operations to a specific shard. -- **`_source` (Optional, boolean \| string \| string[])**: True or false to return the `_source` field or not, or a list of fields to return. -- **`_source_excludes` (Optional, string \| string[])**: A list of source fields to exclude from the response. You can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter. -- **`_source_includes` (Optional, string \| string[])**: A list of source fields to include in the response. If this parameter is specified, only these source fields are returned. You can exclude fields from this subset using the `_source_excludes` query parameter. If the `_source` parameter is `false`, this parameter is ignored. -- **`stored_fields` (Optional, string \| string[])**: If `true`, retrieves the document fields stored in the index rather than the document `_source`. - -## client.msearch [_msearch] -Run multiple searches. - -The format of the request is similar to the bulk API format and makes use of the newline delimited JSON (NDJSON) format. -The structure is as follows: - -``` -header\n -body\n -header\n -body\n -``` - -This structure is specifically optimized to reduce parsing if a specific search ends up redirected to another node. - -IMPORTANT: The final line of data must end with a newline character `\n`. -Each newline character may be preceded by a carriage return `\r`. -When sending requests to this endpoint the `Content-Type` header should be set to `application/x-ndjson`. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-msearch) - -```ts -client.msearch({ ... }) -``` -### Arguments [_arguments_msearch] - -#### Request (object) [_request_msearch] - -- **`index` (Optional, string \| string[])**: List of data streams, indices, and index aliases to search. -- **`searches` (Optional, { allow_no_indices, expand_wildcards, ignore_unavailable, index, preference, request_cache, routing, search_type, ccs_minimize_roundtrips, allow_partial_search_results, ignore_throttled } \| { aggregations, collapse, explain, ext, from, highlight, track_total_hits, indices_boost, docvalue_fields, knn, rank, min_score, post_filter, profile, query, rescore, retriever, script_fields, search_after, size, slice, sort, _source, fields, suggest, terminate_after, timeout, track_scores, version, seq_no_primary_term, stored_fields, pit, runtime_mappings, stats }[])** -- **`allow_no_indices` (Optional, boolean)**: If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar. -- **`ccs_minimize_roundtrips` (Optional, boolean)**: If true, network roundtrips between the coordinating node and remote clusters are minimized for cross-cluster search requests. -- **`expand_wildcards` (Optional, Enum("all" \| "open" \| "closed" \| "hidden" \| "none") \| Enum("all" \| "open" \| "closed" \| "hidden" \| "none")[])**: Type of index that wildcard expressions can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. -- **`ignore_throttled` (Optional, boolean)**: If true, concrete, expanded or aliased indices are ignored when frozen. -- **`ignore_unavailable` (Optional, boolean)**: If true, missing or closed indices are not included in the response. -- **`include_named_queries_score` (Optional, boolean)**: Indicates whether hit.matched_queries should be rendered as a map that includes the name of the matched query associated with its score (true) or as an array containing the name of the matched queries (false) This functionality reruns each named query on every hit in a search response. Typically, this adds a small overhead to a request. However, using computationally expensive named queries on a large number of hits may add significant overhead. -- **`max_concurrent_searches` (Optional, number)**: Maximum number of concurrent searches the multi search API can execute. Defaults to `max(1, (# of data nodes * min(search thread pool size, 10)))`. -- **`max_concurrent_shard_requests` (Optional, number)**: Maximum number of concurrent shard requests that each sub-search request executes per node. -- **`pre_filter_shard_size` (Optional, number)**: Defines a threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method i.e., if date filters are mandatory to match but the shard bounds and the query are disjoint. -- **`rest_total_hits_as_int` (Optional, boolean)**: If true, hits.total are returned as an integer in the response. Defaults to false, which returns an object. -- **`routing` (Optional, string)**: Custom routing value used to route search operations to a specific shard. -- **`search_type` (Optional, Enum("query_then_fetch" \| "dfs_query_then_fetch"))**: Indicates whether global term and document frequencies should be used when scoring returned documents. -- **`typed_keys` (Optional, boolean)**: Specifies whether aggregation and suggester names should be prefixed by their respective types in the response. - -## client.msearchTemplate [_msearch_template] -Run multiple templated searches. - -Run multiple templated searches with a single request. -If you are providing a text file or text input to `curl`, use the `--data-binary` flag instead of `-d` to preserve newlines. -For example: - -``` -$ cat requests -{ "index": "my-index" } -{ "id": "my-search-template", "params": { "query_string": "hello world", "from": 0, "size": 10 }} -{ "index": "my-other-index" } -{ "id": "my-other-search-template", "params": { "query_type": "match_all" }} - -$ curl -H "Content-Type: application/x-ndjson" -XGET localhost:9200/_msearch/template --data-binary "@requests"; echo -``` - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-msearch-template) - -```ts -client.msearchTemplate({ ... }) -``` -### Arguments [_arguments_msearch_template] - -#### Request (object) [_request_msearch_template] - -- **`index` (Optional, string \| string[])**: A list of data streams, indices, and aliases to search. It supports wildcards (`*`). To search all data streams and indices, omit this parameter or use `*`. -- **`search_templates` (Optional, { allow_no_indices, expand_wildcards, ignore_unavailable, index, preference, request_cache, routing, search_type, ccs_minimize_roundtrips, allow_partial_search_results, ignore_throttled } \| { aggregations, collapse, explain, ext, from, highlight, track_total_hits, indices_boost, docvalue_fields, knn, rank, min_score, post_filter, profile, query, rescore, retriever, script_fields, search_after, size, slice, sort, _source, fields, suggest, terminate_after, timeout, track_scores, version, seq_no_primary_term, stored_fields, pit, runtime_mappings, stats }[])** -- **`ccs_minimize_roundtrips` (Optional, boolean)**: If `true`, network round-trips are minimized for cross-cluster search requests. -- **`max_concurrent_searches` (Optional, number)**: The maximum number of concurrent searches the API can run. -- **`search_type` (Optional, Enum("query_then_fetch" \| "dfs_query_then_fetch"))**: The type of the search operation. -- **`rest_total_hits_as_int` (Optional, boolean)**: If `true`, the response returns `hits.total` as an integer. If `false`, it returns `hits.total` as an object. -- **`typed_keys` (Optional, boolean)**: If `true`, the response prefixes aggregation and suggester names with their respective types. - -## client.mtermvectors [_mtermvectors] -Get multiple term vectors. - -Get multiple term vectors with a single request. -You can specify existing documents by index and ID or provide artificial documents in the body of the request. -You can specify the index in the request body or request URI. -The response contains a `docs` array with all the fetched termvectors. -Each element has the structure provided by the termvectors API. - -**Artificial documents** - -You can also use `mtermvectors` to generate term vectors for artificial documents provided in the body of the request. -The mapping used is determined by the specified `_index`. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-mtermvectors) - -```ts -client.mtermvectors({ ... }) -``` -### Arguments [_arguments_mtermvectors] - -#### Request (object) [_request_mtermvectors] - -- **`index` (Optional, string)**: The name of the index that contains the documents. -- **`docs` (Optional, { _id, _index, routing, _source, stored_fields, version, version_type }[])**: An array of existing or artificial documents. -- **`ids` (Optional, string[])**: A simplified syntax to specify documents by their ID if they're in the same index. -- **`fields` (Optional, string \| string[])**: A list or wildcard expressions of fields to include in the statistics. It is used as the default list unless a specific field list is provided in the `completion_fields` or `fielddata_fields` parameters. -- **`field_statistics` (Optional, boolean)**: If `true`, the response includes the document count, sum of document frequencies, and sum of total term frequencies. -- **`offsets` (Optional, boolean)**: If `true`, the response includes term offsets. -- **`payloads` (Optional, boolean)**: If `true`, the response includes term payloads. -- **`positions` (Optional, boolean)**: If `true`, the response includes term positions. -- **`preference` (Optional, string)**: The node or shard the operation should be performed on. It is random by default. -- **`realtime` (Optional, boolean)**: If true, the request is real-time as opposed to near-real-time. -- **`routing` (Optional, string)**: A custom value used to route operations to a specific shard. -- **`term_statistics` (Optional, boolean)**: If true, the response includes term frequency and document frequency. -- **`version` (Optional, number)**: If `true`, returns the document version as part of a hit. -- **`version_type` (Optional, Enum("internal" \| "external" \| "external_gte" \| "force"))**: The version type. - -## client.openPointInTime [_open_point_in_time] -Open a point in time. - -A search request by default runs against the most recent visible data of the target indices, -which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the -state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple -search requests using the same point in time. For example, if refreshes happen between -`search_after` requests, then the results of those requests might not be consistent as changes happening -between searches are only visible to the more recent point in time. - -A point in time must be opened explicitly before being used in search requests. - -A subsequent search request with the `pit` parameter must not specify `index`, `routing`, or `preference` values as these parameters are copied from the point in time. - -Just like regular searches, you can use `from` and `size` to page through point in time search results, up to the first 10,000 hits. -If you want to retrieve more hits, use PIT with `search_after`. - -IMPORTANT: The open point in time request and each subsequent search request can return different identifiers; always use the most recently received ID for the next search request. - -When a PIT that contains shard failures is used in a search request, the missing are always reported in the search response as a `NoShardAvailableActionException` exception. -To get rid of these exceptions, a new PIT needs to be created so that shards missing from the previous PIT can be handled, assuming they become available in the meantime. - -**Keeping point in time alive** - -The `keep_alive` parameter, which is passed to a open point in time request and search request, extends the time to live of the corresponding point in time. -The value does not need to be long enough to process all data — it just needs to be long enough for the next request. - -Normally, the background merge process optimizes the index by merging together smaller segments to create new, bigger segments. -Once the smaller segments are no longer needed they are deleted. -However, open point-in-times prevent the old segments from being deleted since they are still in use. - -TIP: Keeping older segments alive means that more disk space and file handles are needed. -Ensure that you have configured your nodes to have ample free file handles. - -Additionally, if a segment contains deleted or updated documents then the point in time must keep track of whether each document in the segment was live at the time of the initial search request. -Ensure that your nodes have sufficient heap space if you have many open point-in-times on an index that is subject to ongoing deletes or updates. -Note that a point-in-time doesn't prevent its associated indices from being deleted. -You can check how many point-in-times (that is, search contexts) are open with the nodes stats API. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-open-point-in-time) - -```ts -client.openPointInTime({ index, keep_alive }) -``` -### Arguments [_arguments_open_point_in_time] - -#### Request (object) [_request_open_point_in_time] - -- **`index` (string \| string[])**: A list of index names to open point in time; use `_all` or empty string to perform the operation on all indices -- **`keep_alive` (string \| -1 \| 0)**: Extend the length of time that the point in time persists. -- **`index_filter` (Optional, { bool, boosting, common, combined_fields, constant_score, dis_max, distance_feature, exists, function_score, fuzzy, geo_bounding_box, geo_distance, geo_grid, geo_polygon, geo_shape, has_child, has_parent, ids, intervals, knn, match, match_all, match_bool_prefix, match_none, match_phrase, match_phrase_prefix, more_like_this, multi_match, nested, parent_id, percolate, pinned, prefix, query_string, range, rank_feature, regexp, rule, script, script_score, semantic, shape, simple_query_string, span_containing, span_field_masking, span_first, span_multi, span_near, span_not, span_or, span_term, span_within, sparse_vector, term, terms, terms_set, text_expansion, weighted_tokens, wildcard, wrapper, type })**: Filter indices if the provided query rewrites to `match_none` on every shard. -- **`ignore_unavailable` (Optional, boolean)**: If `false`, the request returns an error if it targets a missing or closed index. -- **`preference` (Optional, string)**: The node or shard the operation should be performed on. By default, it is random. -- **`routing` (Optional, string)**: A custom value that is used to route operations to a specific shard. -- **`expand_wildcards` (Optional, Enum("all" \| "open" \| "closed" \| "hidden" \| "none") \| Enum("all" \| "open" \| "closed" \| "hidden" \| "none")[])**: The type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. It supports a list of values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. -- **`allow_partial_search_results` (Optional, boolean)**: Indicates whether the point in time tolerates unavailable shards or shard failures when initially creating the PIT. If `false`, creating a point in time request when a shard is missing or unavailable will throw an exception. If `true`, the point in time will contain all the shards that are available at the time of the request. -- **`max_concurrent_shard_requests` (Optional, number)**: Maximum number of concurrent shard requests that each sub-search request executes per node. - -## client.ping [_ping] -Ping the cluster. -Get information about whether the cluster is running. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-cluster) - -```ts -client.ping() -``` - -## client.putScript [_put_script] -Create or update a script or search template. -Creates or updates a stored script or search template. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-put-script) - -```ts -client.putScript({ id, script }) -``` -### Arguments [_arguments_put_script] - -#### Request (object) [_request_put_script] - -- **`id` (string)**: The identifier for the stored script or search template. It must be unique within the cluster. -- **`script` ({ lang, options, source })**: The script or search template, its parameters, and its language. -- **`context` (Optional, string)**: The context in which the script or search template should run. To prevent errors, the API immediately compiles the script or template in this context. -- **`master_timeout` (Optional, string \| -1 \| 0)**: The period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. It can also be set to `-1` to indicate that the request should never timeout. -- **`timeout` (Optional, string \| -1 \| 0)**: The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. It can also be set to `-1` to indicate that the request should never timeout. - -## client.rankEval [_rank_eval] -Evaluate ranked search results. - -Evaluate the quality of ranked search results over a set of typical search queries. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-rank-eval) - -```ts -client.rankEval({ requests }) -``` -### Arguments [_arguments_rank_eval] - -#### Request (object) [_request_rank_eval] - -- **`requests` ({ id, request, ratings, template_id, params }[])**: A set of typical search requests, together with their provided ratings. -- **`index` (Optional, string \| string[])**: A list of data streams, indices, and index aliases used to limit the request. Wildcard (`*`) expressions are supported. To target all data streams and indices in a cluster, omit this parameter or use `_all` or `*`. -- **`metric` (Optional, { precision, recall, mean_reciprocal_rank, dcg, expected_reciprocal_rank })**: Definition of the evaluation metric to calculate. -- **`allow_no_indices` (Optional, boolean)**: If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. -- **`expand_wildcards` (Optional, Enum("all" \| "open" \| "closed" \| "hidden" \| "none") \| Enum("all" \| "open" \| "closed" \| "hidden" \| "none")[])**: Whether to expand wildcard expression to concrete indices that are open, closed or both. -- **`ignore_unavailable` (Optional, boolean)**: If `true`, missing or closed indices are not included in the response. -- **`search_type` (Optional, string)**: Search operation type - -## client.reindex [_reindex] -Reindex documents. - -Copy documents from a source to a destination. -You can copy all documents to the destination index or reindex a subset of the documents. -The source can be any existing index, alias, or data stream. -The destination must differ from the source. -For example, you cannot reindex a data stream into itself. - -IMPORTANT: Reindex requires `_source` to be enabled for all documents in the source. -The destination should be configured as wanted before calling the reindex API. -Reindex does not copy the settings from the source or its associated template. -Mappings, shard counts, and replicas, for example, must be configured ahead of time. - -If the Elasticsearch security features are enabled, you must have the following security privileges: - -* The `read` index privilege for the source data stream, index, or alias. -* The `write` index privilege for the destination data stream, index, or index alias. -* To automatically create a data stream or index with a reindex API request, you must have the `auto_configure`, `create_index`, or `manage` index privilege for the destination data stream, index, or alias. -* If reindexing from a remote cluster, the `source.remote.user` must have the `monitor` cluster privilege and the `read` index privilege for the source data stream, index, or alias. - -If reindexing from a remote cluster, you must explicitly allow the remote host in the `reindex.remote.whitelist` setting. -Automatic data stream creation requires a matching index template with data stream enabled. - -The `dest` element can be configured like the index API to control optimistic concurrency control. -Omitting `version_type` or setting it to `internal` causes Elasticsearch to blindly dump documents into the destination, overwriting any that happen to have the same ID. - -Setting `version_type` to `external` causes Elasticsearch to preserve the `version` from the source, create any documents that are missing, and update any documents that have an older version in the destination than they do in the source. - -Setting `op_type` to `create` causes the reindex API to create only missing documents in the destination. -All existing documents will cause a version conflict. - -IMPORTANT: Because data streams are append-only, any reindex request to a destination data stream must have an `op_type` of `create`. -A reindex can only add new documents to a destination data stream. -It cannot update existing documents in a destination data stream. - -By default, version conflicts abort the reindex process. -To continue reindexing if there are conflicts, set the `conflicts` request body property to `proceed`. -In this case, the response includes a count of the version conflicts that were encountered. -Note that the handling of other error types is unaffected by the `conflicts` property. -Additionally, if you opt to count version conflicts, the operation could attempt to reindex more documents from the source than `max_docs` until it has successfully indexed `max_docs` documents into the target or it has gone through every document in the source query. - -NOTE: The reindex API makes no effort to handle ID collisions. -The last document written will "win" but the order isn't usually predictable so it is not a good idea to rely on this behavior. -Instead, make sure that IDs are unique by using a script. - -**Running reindex asynchronously** - -If the request contains `wait_for_completion=false`, Elasticsearch performs some preflight checks, launches the request, and returns a task you can use to cancel or get the status of the task. -Elasticsearch creates a record of this task as a document at `_tasks/`. - -**Reindex from multiple sources** - -If you have many sources to reindex it is generally better to reindex them one at a time rather than using a glob pattern to pick up multiple sources. -That way you can resume the process if there are any errors by removing the partially completed source and starting over. -It also makes parallelizing the process fairly simple: split the list of sources to reindex and run each list in parallel. - -For example, you can use a bash script like this: - -``` -for index in i1 i2 i3 i4 i5; do - curl -HContent-Type:application/json -XPOST localhost:9200/_reindex?pretty -d'{ - "source": { - "index": "'$index'" - }, - "dest": { - "index": "'$index'-reindexed" - } - }' -done -``` - -**Throttling** - -Set `requests_per_second` to any positive decimal number (`1.4`, `6`, `1000`, for example) to throttle the rate at which reindex issues batches of index operations. -Requests are throttled by padding each batch with a wait time. -To turn off throttling, set `requests_per_second` to `-1`. - -The throttling is done by waiting between batches so that the scroll that reindex uses internally can be given a timeout that takes into account the padding. -The padding time is the difference between the batch size divided by the `requests_per_second` and the time spent writing. -By default the batch size is `1000`, so if `requests_per_second` is set to `500`: - -``` -target_time = 1000 / 500 per second = 2 seconds -wait_time = target_time - write_time = 2 seconds - .5 seconds = 1.5 seconds -``` - -Since the batch is issued as a single bulk request, large batch sizes cause Elasticsearch to create many requests and then wait for a while before starting the next set. -This is "bursty" instead of "smooth". - -**Slicing** - -Reindex supports sliced scroll to parallelize the reindexing process. -This parallelization can improve efficiency and provide a convenient way to break the request down into smaller parts. - -NOTE: Reindexing from remote clusters does not support manual or automatic slicing. - -You can slice a reindex request manually by providing a slice ID and total number of slices to each request. -You can also let reindex automatically parallelize by using sliced scroll to slice on `_id`. -The `slices` parameter specifies the number of slices to use. - -Adding `slices` to the reindex request just automates the manual process, creating sub-requests which means it has some quirks: - -* You can see these requests in the tasks API. These sub-requests are "child" tasks of the task for the request with slices. -* Fetching the status of the task for the request with `slices` only contains the status of completed slices. -* These sub-requests are individually addressable for things like cancellation and rethrottling. -* Rethrottling the request with `slices` will rethrottle the unfinished sub-request proportionally. -* Canceling the request with `slices` will cancel each sub-request. -* Due to the nature of `slices`, each sub-request won't get a perfectly even portion of the documents. All documents will be addressed, but some slices may be larger than others. Expect larger slices to have a more even distribution. -* Parameters like `requests_per_second` and `max_docs` on a request with `slices` are distributed proportionally to each sub-request. Combine that with the previous point about distribution being uneven and you should conclude that using `max_docs` with `slices` might not result in exactly `max_docs` documents being reindexed. -* Each sub-request gets a slightly different snapshot of the source, though these are all taken at approximately the same time. - -If slicing automatically, setting `slices` to `auto` will choose a reasonable number for most indices. -If slicing manually or otherwise tuning automatic slicing, use the following guidelines. - -Query performance is most efficient when the number of slices is equal to the number of shards in the index. -If that number is large (for example, `500`), choose a lower number as too many slices will hurt performance. -Setting slices higher than the number of shards generally does not improve efficiency and adds overhead. - -Indexing performance scales linearly across available resources with the number of slices. - -Whether query or indexing performance dominates the runtime depends on the documents being reindexed and cluster resources. - -**Modify documents during reindexing** - -Like `_update_by_query`, reindex operations support a script that modifies the document. -Unlike `_update_by_query`, the script is allowed to modify the document's metadata. - -Just as in `_update_by_query`, you can set `ctx.op` to change the operation that is run on the destination. -For example, set `ctx.op` to `noop` if your script decides that the document doesn’t have to be indexed in the destination. This "no operation" will be reported in the `noop` counter in the response body. -Set `ctx.op` to `delete` if your script decides that the document must be deleted from the destination. -The deletion will be reported in the `deleted` counter in the response body. -Setting `ctx.op` to anything else will return an error, as will setting any other field in `ctx`. - -Think of the possibilities! Just be careful; you are able to change: - -* `_id` -* `_index` -* `_version` -* `_routing` - -Setting `_version` to `null` or clearing it from the `ctx` map is just like not sending the version in an indexing request. -It will cause the document to be overwritten in the destination regardless of the version on the target or the version type you use in the reindex API. - -**Reindex from remote** - -Reindex supports reindexing from a remote Elasticsearch cluster. -The `host` parameter must contain a scheme, host, port, and optional path. -The `username` and `password` parameters are optional and when they are present the reindex operation will connect to the remote Elasticsearch node using basic authentication. -Be sure to use HTTPS when using basic authentication or the password will be sent in plain text. -There are a range of settings available to configure the behavior of the HTTPS connection. - -When using Elastic Cloud, it is also possible to authenticate against the remote cluster through the use of a valid API key. -Remote hosts must be explicitly allowed with the `reindex.remote.whitelist` setting. -It can be set to a comma delimited list of allowed remote host and port combinations. -Scheme is ignored; only the host and port are used. -For example: - -``` -reindex.remote.whitelist: [otherhost:9200, another:9200, 127.0.10.*:9200, localhost:*"] -``` - -The list of allowed hosts must be configured on any nodes that will coordinate the reindex. -This feature should work with remote clusters of any version of Elasticsearch. -This should enable you to upgrade from any version of Elasticsearch to the current version by reindexing from a cluster of the old version. - -WARNING: Elasticsearch does not support forward compatibility across major versions. -For example, you cannot reindex from a 7.x cluster into a 6.x cluster. - -To enable queries sent to older versions of Elasticsearch, the `query` parameter is sent directly to the remote host without validation or modification. - -NOTE: Reindexing from remote clusters does not support manual or automatic slicing. - -Reindexing from a remote server uses an on-heap buffer that defaults to a maximum size of 100mb. -If the remote index includes very large documents you'll need to use a smaller batch size. -It is also possible to set the socket read timeout on the remote connection with the `socket_timeout` field and the connection timeout with the `connect_timeout` field. -Both default to 30 seconds. - -**Configuring SSL parameters** - -Reindex from remote supports configurable SSL settings. -These must be specified in the `elasticsearch.yml` file, with the exception of the secure settings, which you add in the Elasticsearch keystore. -It is not possible to configure SSL in the body of the reindex request. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-reindex) - -```ts -client.reindex({ dest, source }) -``` -### Arguments [_arguments_reindex] - -#### Request (object) [_request_reindex] - -- **`dest` ({ index, op_type, pipeline, routing, version_type })**: The destination you are copying to. -- **`source` ({ index, query, remote, size, slice, sort, _source, runtime_mappings })**: The source you are copying from. -- **`conflicts` (Optional, Enum("abort" \| "proceed"))**: Indicates whether to continue reindexing even when there are conflicts. -- **`max_docs` (Optional, number)**: The maximum number of documents to reindex. By default, all documents are reindexed. If it is a value less then or equal to `scroll_size`, a scroll will not be used to retrieve the results for the operation. If `conflicts` is set to `proceed`, the reindex operation could attempt to reindex more documents from the source than `max_docs` until it has successfully indexed `max_docs` documents into the target or it has gone through every document in the source query. -- **`script` (Optional, { source, id, params, lang, options })**: The script to run to update the document source or metadata when reindexing. -- **`size` (Optional, number)** -- **`refresh` (Optional, boolean)**: If `true`, the request refreshes affected shards to make this operation visible to search. -- **`requests_per_second` (Optional, float)**: The throttle for this request in sub-requests per second. By default, there is no throttle. -- **`scroll` (Optional, string \| -1 \| 0)**: The period of time that a consistent view of the index should be maintained for scrolled search. -- **`slices` (Optional, number \| Enum("auto"))**: The number of slices this task should be divided into. It defaults to one slice, which means the task isn't sliced into subtasks. Reindex supports sliced scroll to parallelize the reindexing process. This parallelization can improve efficiency and provide a convenient way to break the request down into smaller parts. NOTE: Reindexing from remote clusters does not support manual or automatic slicing. If set to `auto`, Elasticsearch chooses the number of slices to use. This setting will use one slice per shard, up to a certain limit. If there are multiple sources, it will choose the number of slices based on the index or backing index with the smallest number of shards. -- **`timeout` (Optional, string \| -1 \| 0)**: The period each indexing waits for automatic index creation, dynamic mapping updates, and waiting for active shards. By default, Elasticsearch waits for at least one minute before failing. The actual wait time could be longer, particularly when multiple waits occur. -- **`wait_for_active_shards` (Optional, number \| Enum("all" \| "index-setting"))**: The number of shard copies that must be active before proceeding with the operation. Set it to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). The default value is one, which means it waits for each primary shard to be active. -- **`wait_for_completion` (Optional, boolean)**: If `true`, the request blocks until the operation is complete. -- **`require_alias` (Optional, boolean)**: If `true`, the destination must be an index alias. - -## client.reindexRethrottle [_reindex_rethrottle] -Throttle a reindex operation. - -Change the number of requests per second for a particular reindex operation. -For example: - -``` -POST _reindex/r1A2WoRbTwKZ516z6NEs5A:36619/_rethrottle?requests_per_second=-1 -``` - -Rethrottling that speeds up the query takes effect immediately. -Rethrottling that slows down the query will take effect after completing the current batch. -This behavior prevents scroll timeouts. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-reindex) - -```ts -client.reindexRethrottle({ task_id }) -``` -### Arguments [_arguments_reindex_rethrottle] - -#### Request (object) [_request_reindex_rethrottle] - -- **`task_id` (string)**: The task identifier, which can be found by using the tasks API. -- **`requests_per_second` (Optional, float)**: The throttle for this request in sub-requests per second. It can be either `-1` to turn off throttling or any decimal number like `1.7` or `12` to throttle to that level. - -## client.renderSearchTemplate [_render_search_template] -Render a search template. - -Render a search template as a search request body. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-render-search-template) - -```ts -client.renderSearchTemplate({ ... }) -``` -### Arguments [_arguments_render_search_template] - -#### Request (object) [_request_render_search_template] - -- **`id` (Optional, string)**: The ID of the search template to render. If no `source` is specified, this or the `id` request body parameter is required. -- **`file` (Optional, string)** -- **`params` (Optional, Record)**: Key-value pairs used to replace Mustache variables in the template. The key is the variable name. The value is the variable value. -- **`source` (Optional, string \| { aggregations, collapse, explain, ext, from, highlight, track_total_hits, indices_boost, docvalue_fields, knn, rank, min_score, post_filter, profile, query, rescore, retriever, script_fields, search_after, size, slice, sort, _source, fields, suggest, terminate_after, timeout, track_scores, version, seq_no_primary_term, stored_fields, pit, runtime_mappings, stats })**: An inline search template. It supports the same parameters as the search API's request body. These parameters also support Mustache variables. If no `id` or `` is specified, this parameter is required. - -## client.scriptsPainlessExecute [_scripts_painless_execute] -Run a script. - -Runs a script and returns a result. -Use this API to build and test scripts, such as when defining a script for a runtime field. -This API requires very few dependencies and is especially useful if you don't have permissions to write documents on a cluster. - -The API uses several _contexts_, which control how scripts are run, what variables are available at runtime, and what the return type is. - -Each context requires a script, but additional parameters depend on the context you're using for that script. - -[Endpoint documentation](https://www.elastic.co/docs/reference/scripting-languages/painless/painless-api-examples) - -```ts -client.scriptsPainlessExecute({ ... }) -``` -### Arguments [_arguments_scripts_painless_execute] - -#### Request (object) [_request_scripts_painless_execute] - -- **`context` (Optional, Enum("painless_test" \| "filter" \| "score" \| "boolean_field" \| "date_field" \| "double_field" \| "geo_point_field" \| "ip_field" \| "keyword_field" \| "long_field" \| "composite_field"))**: The context that the script should run in. NOTE: Result ordering in the field contexts is not guaranteed. -- **`context_setup` (Optional, { document, index, query })**: Additional parameters for the `context`. NOTE: This parameter is required for all contexts except `painless_test`, which is the default if no value is provided for `context`. -- **`script` (Optional, { source, id, params, lang, options })**: The Painless script to run. - -## client.scroll [_scroll] -Run a scrolling search. - -IMPORTANT: The scroll API is no longer recommend for deep pagination. If you need to preserve the index state while paging through more than 10,000 hits, use the `search_after` parameter with a point in time (PIT). - -The scroll API gets large sets of results from a single scrolling search request. -To get the necessary scroll ID, submit a search API request that includes an argument for the `scroll` query parameter. -The `scroll` parameter indicates how long Elasticsearch should retain the search context for the request. -The search response returns a scroll ID in the `_scroll_id` response body parameter. -You can then use the scroll ID with the scroll API to retrieve the next batch of results for the request. -If the Elasticsearch security features are enabled, the access to the results of a specific scroll ID is restricted to the user or API key that submitted the search. - -You can also use the scroll API to specify a new scroll parameter that extends or shortens the retention period for the search context. - -IMPORTANT: Results from a scrolling search reflect the state of the index at the time of the initial search request. Subsequent indexing or document changes only affect later search and scroll requests. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-scroll) - -```ts -client.scroll({ scroll_id }) -``` -### Arguments [_arguments_scroll] - -#### Request (object) [_request_scroll] - -- **`scroll_id` (string)**: The scroll ID of the search. -- **`scroll` (Optional, string \| -1 \| 0)**: The period to retain the search context for scrolling. -- **`rest_total_hits_as_int` (Optional, boolean)**: If true, the API response’s hit.total property is returned as an integer. If false, the API response’s hit.total property is returned as an object. - -## client.search [_search] -Run a search. - -Get search hits that match the query defined in the request. -You can provide search queries using the `q` query string parameter or the request body. -If both are specified, only the query parameter is used. - -If the Elasticsearch security features are enabled, you must have the read index privilege for the target data stream, index, or alias. For cross-cluster search, refer to the documentation about configuring CCS privileges. -To search a point in time (PIT) for an alias, you must have the `read` index privilege for the alias's data streams or indices. - -**Search slicing** - -When paging through a large number of documents, it can be helpful to split the search into multiple slices to consume them independently with the `slice` and `pit` properties. -By default the splitting is done first on the shards, then locally on each shard. -The local splitting partitions the shard into contiguous ranges based on Lucene document IDs. - -For instance if the number of shards is equal to 2 and you request 4 slices, the slices 0 and 2 are assigned to the first shard and the slices 1 and 3 are assigned to the second shard. - -IMPORTANT: The same point-in-time ID should be used for all slices. -If different PIT IDs are used, slices can overlap and miss documents. -This situation can occur because the splitting criterion is based on Lucene document IDs, which are not stable across changes to the index. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search) - -```ts -client.search({ ... }) -``` -### Arguments [_arguments_search] - -#### Request (object) [_request_search] - -- **`index` (Optional, string \| string[])**: A list of data streams, indices, and aliases to search. It supports wildcards (`*`). To search all data streams and indices, omit this parameter or use `*` or `_all`. -- **`aggregations` (Optional, Record)**: Defines the aggregations that are run as part of the search request. -- **`collapse` (Optional, { field, inner_hits, max_concurrent_group_searches, collapse })**: Collapses search results the values of the specified field. -- **`explain` (Optional, boolean)**: If `true`, the request returns detailed information about score computation as part of a hit. -- **`ext` (Optional, Record)**: Configuration of search extensions defined by Elasticsearch plugins. -- **`from` (Optional, number)**: The starting document offset, which must be non-negative. By default, you cannot page through more than 10,000 hits using the `from` and `size` parameters. To page through more hits, use the `search_after` parameter. -- **`highlight` (Optional, { encoder, fields })**: Specifies the highlighter to use for retrieving highlighted snippets from one or more fields in your search results. -- **`track_total_hits` (Optional, boolean \| number)**: Number of hits matching the query to count accurately. If `true`, the exact number of hits is returned at the cost of some performance. If `false`, the response does not include the total number of hits matching the query. -- **`indices_boost` (Optional, Record[])**: Boost the `_score` of documents from specified indices. The boost value is the factor by which scores are multiplied. A boost value greater than `1.0` increases the score. A boost value between `0` and `1.0` decreases the score. -- **`docvalue_fields` (Optional, { field, format, include_unmapped }[])**: An array of wildcard (`*`) field patterns. The request returns doc values for field names matching these patterns in the `hits.fields` property of the response. -- **`knn` (Optional, { field, query_vector, query_vector_builder, k, num_candidates, boost, filter, similarity, inner_hits, rescore_vector } \| { field, query_vector, query_vector_builder, k, num_candidates, boost, filter, similarity, inner_hits, rescore_vector }[])**: The approximate kNN search to run. -- **`rank` (Optional, { rrf })**: The Reciprocal Rank Fusion (RRF) to use. -- **`min_score` (Optional, number)**: The minimum `_score` for matching documents. Documents with a lower `_score` are not included in search results and results collected by aggregations. -- **`post_filter` (Optional, { bool, boosting, common, combined_fields, constant_score, dis_max, distance_feature, exists, function_score, fuzzy, geo_bounding_box, geo_distance, geo_grid, geo_polygon, geo_shape, has_child, has_parent, ids, intervals, knn, match, match_all, match_bool_prefix, match_none, match_phrase, match_phrase_prefix, more_like_this, multi_match, nested, parent_id, percolate, pinned, prefix, query_string, range, rank_feature, regexp, rule, script, script_score, semantic, shape, simple_query_string, span_containing, span_field_masking, span_first, span_multi, span_near, span_not, span_or, span_term, span_within, sparse_vector, term, terms, terms_set, text_expansion, weighted_tokens, wildcard, wrapper, type })**: Use the `post_filter` parameter to filter search results. The search hits are filtered after the aggregations are calculated. A post filter has no impact on the aggregation results. -- **`profile` (Optional, boolean)**: Set to `true` to return detailed timing information about the execution of individual components in a search request. NOTE: This is a debugging tool and adds significant overhead to search execution. -- **`query` (Optional, { bool, boosting, common, combined_fields, constant_score, dis_max, distance_feature, exists, function_score, fuzzy, geo_bounding_box, geo_distance, geo_grid, geo_polygon, geo_shape, has_child, has_parent, ids, intervals, knn, match, match_all, match_bool_prefix, match_none, match_phrase, match_phrase_prefix, more_like_this, multi_match, nested, parent_id, percolate, pinned, prefix, query_string, range, rank_feature, regexp, rule, script, script_score, semantic, shape, simple_query_string, span_containing, span_field_masking, span_first, span_multi, span_near, span_not, span_or, span_term, span_within, sparse_vector, term, terms, terms_set, text_expansion, weighted_tokens, wildcard, wrapper, type })**: The search definition using the Query DSL. -- **`rescore` (Optional, { window_size, query, learning_to_rank } \| { window_size, query, learning_to_rank }[])**: Can be used to improve precision by reordering just the top (for example 100 - 500) documents returned by the `query` and `post_filter` phases. -- **`retriever` (Optional, { standard, knn, rrf, text_similarity_reranker, rule })**: A retriever is a specification to describe top documents returned from a search. A retriever replaces other elements of the search API that also return top documents such as `query` and `knn`. -- **`script_fields` (Optional, Record)**: Retrieve a script evaluation (based on different fields) for each hit. -- **`search_after` (Optional, number \| number \| string \| boolean \| null[])**: Used to retrieve the next page of hits using a set of sort values from the previous page. -- **`size` (Optional, number)**: The number of hits to return, which must not be negative. By default, you cannot page through more than 10,000 hits using the `from` and `size` parameters. To page through more hits, use the `search_after` property. -- **`slice` (Optional, { field, id, max })**: Split a scrolled search into multiple slices that can be consumed independently. -- **`sort` (Optional, string \| { _score, _doc, _geo_distance, _script } \| string \| { _score, _doc, _geo_distance, _script }[])**: A list of : pairs. -- **`_source` (Optional, boolean \| { excludes, includes })**: The source fields that are returned for matching documents. These fields are returned in the `hits._source` property of the search response. If the `stored_fields` property is specified, the `_source` property defaults to `false`. Otherwise, it defaults to `true`. -- **`fields` (Optional, { field, format, include_unmapped }[])**: An array of wildcard (`*`) field patterns. The request returns values for field names matching these patterns in the `hits.fields` property of the response. -- **`suggest` (Optional, { text })**: Defines a suggester that provides similar looking terms based on a provided text. -- **`terminate_after` (Optional, number)**: The maximum number of documents to collect for each shard. If a query reaches this limit, Elasticsearch terminates the query early. Elasticsearch collects documents before sorting. IMPORTANT: Use with caution. Elasticsearch applies this property to each shard handling the request. When possible, let Elasticsearch perform early termination automatically. Avoid specifying this property for requests that target data streams with backing indices across multiple data tiers. If set to `0` (default), the query does not terminate early. -- **`timeout` (Optional, string)**: The period of time to wait for a response from each shard. If no response is received before the timeout expires, the request fails and returns an error. Defaults to no timeout. -- **`track_scores` (Optional, boolean)**: If `true`, calculate and return document scores, even if the scores are not used for sorting. -- **`version` (Optional, boolean)**: If `true`, the request returns the document version as part of a hit. -- **`seq_no_primary_term` (Optional, boolean)**: If `true`, the request returns sequence number and primary term of the last modification of each hit. -- **`stored_fields` (Optional, string \| string[])**: A list of stored fields to return as part of a hit. If no fields are specified, no stored fields are included in the response. If this field is specified, the `_source` property defaults to `false`. You can pass `_source: true` to return both source fields and stored fields in the search response. -- **`pit` (Optional, { id, keep_alive })**: Limit the search to a point in time (PIT). If you provide a PIT, you cannot specify an `` in the request path. -- **`runtime_mappings` (Optional, Record)**: One or more runtime fields in the search request. These fields take precedence over mapped fields with the same name. -- **`stats` (Optional, string[])**: The stats groups to associate with the search. Each group maintains a statistics aggregation for its associated searches. You can retrieve these stats using the indices stats API. -- **`allow_no_indices` (Optional, boolean)**: If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. -- **`allow_partial_search_results` (Optional, boolean)**: If `true` and there are shard request timeouts or shard failures, the request returns partial results. If `false`, it returns an error with no partial results. To override the default behavior, you can set the `search.default_allow_partial_results` cluster setting to `false`. -- **`analyzer` (Optional, string)**: The analyzer to use for the query string. This parameter can be used only when the `q` query string parameter is specified. -- **`analyze_wildcard` (Optional, boolean)**: If `true`, wildcard and prefix queries are analyzed. This parameter can be used only when the `q` query string parameter is specified. -- **`batched_reduce_size` (Optional, number)**: The number of shard results that should be reduced at once on the coordinating node. If the potential number of shards in the request can be large, this value should be used as a protection mechanism to reduce the memory overhead per search request. -- **`ccs_minimize_roundtrips` (Optional, boolean)**: If `true`, network round-trips between the coordinating node and the remote clusters are minimized when running cross-cluster search (CCS) requests. -- **`default_operator` (Optional, Enum("and" \| "or"))**: The default operator for the query string query: `AND` or `OR`. This parameter can be used only when the `q` query string parameter is specified. -- **`df` (Optional, string)**: The field to use as a default when no field prefix is given in the query string. This parameter can be used only when the `q` query string parameter is specified. -- **`expand_wildcards` (Optional, Enum("all" \| "open" \| "closed" \| "hidden" \| "none") \| Enum("all" \| "open" \| "closed" \| "hidden" \| "none")[])**: The type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. It supports a list of values such as `open,hidden`. -- **`ignore_throttled` (Optional, boolean)**: If `true`, concrete, expanded or aliased indices will be ignored when frozen. -- **`ignore_unavailable` (Optional, boolean)**: If `false`, the request returns an error if it targets a missing or closed index. -- **`include_named_queries_score` (Optional, boolean)**: If `true`, the response includes the score contribution from any named queries. This functionality reruns each named query on every hit in a search response. Typically, this adds a small overhead to a request. However, using computationally expensive named queries on a large number of hits may add significant overhead. -- **`lenient` (Optional, boolean)**: If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. This parameter can be used only when the `q` query string parameter is specified. -- **`max_concurrent_shard_requests` (Optional, number)**: The number of concurrent shard requests per node that the search runs concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests. -- **`preference` (Optional, string)**: The nodes and shards used for the search. By default, Elasticsearch selects from eligible nodes and shards using adaptive replica selection, accounting for allocation awareness. Valid values are: * `_only_local` to run the search only on shards on the local node. * `_local` to, if possible, run the search on shards on the local node, or if not, select shards using the default method. * `_only_nodes:,` to run the search on only the specified nodes IDs. If suitable shards exist on more than one selected node, use shards on those nodes using the default method. If none of the specified nodes are available, select shards from any available node using the default method. * `_prefer_nodes:,` to if possible, run the search on the specified nodes IDs. If not, select shards using the default method. * `_shards:,` to run the search only on the specified shards. You can combine this value with other `preference` values. However, the `_shards` value must come first. For example: `_shards:2,3|_local`. * `` (any string that does not start with `_`) to route searches with the same `` to the same shards in the same order. -- **`pre_filter_shard_size` (Optional, number)**: A threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method (if date filters are mandatory to match but the shard bounds and the query are disjoint). When unspecified, the pre-filter phase is executed if any of these conditions is met: * The request targets more than 128 shards. * The request targets one or more read-only index. * The primary sort of the query targets an indexed field. -- **`request_cache` (Optional, boolean)**: If `true`, the caching of search results is enabled for requests where `size` is `0`. It defaults to index level settings. -- **`routing` (Optional, string)**: A custom value that is used to route operations to a specific shard. -- **`scroll` (Optional, string \| -1 \| 0)**: The period to retain the search context for scrolling. By default, this value cannot exceed `1d` (24 hours). You can change this limit by using the `search.max_keep_alive` cluster-level setting. -- **`search_type` (Optional, Enum("query_then_fetch" \| "dfs_query_then_fetch"))**: Indicates how distributed term frequencies are calculated for relevance scoring. -- **`suggest_field` (Optional, string)**: The field to use for suggestions. -- **`suggest_mode` (Optional, Enum("missing" \| "popular" \| "always"))**: The suggest mode. This parameter can be used only when the `suggest_field` and `suggest_text` query string parameters are specified. -- **`suggest_size` (Optional, number)**: The number of suggestions to return. This parameter can be used only when the `suggest_field` and `suggest_text` query string parameters are specified. -- **`suggest_text` (Optional, string)**: The source text for which the suggestions should be returned. This parameter can be used only when the `suggest_field` and `suggest_text` query string parameters are specified. -- **`typed_keys` (Optional, boolean)**: If `true`, aggregation and suggester names are be prefixed by their respective types in the response. -- **`rest_total_hits_as_int` (Optional, boolean)**: Indicates whether `hits.total` should be rendered as an integer or an object in the rest search response. -- **`_source_excludes` (Optional, string \| string[])**: A list of source fields to exclude from the response. You can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter. If the `_source` parameter is `false`, this parameter is ignored. -- **`_source_includes` (Optional, string \| string[])**: A list of source fields to include in the response. If this parameter is specified, only these source fields are returned. You can exclude fields from this subset using the `_source_excludes` query parameter. If the `_source` parameter is `false`, this parameter is ignored. -- **`q` (Optional, string)**: A query in the Lucene query string syntax. Query parameter searches do not support the full Elasticsearch Query DSL but are handy for testing. IMPORTANT: This parameter overrides the query parameter in the request body. If both parameters are specified, documents matching the query request body parameter are not returned. -- **`force_synthetic_source` (Optional, boolean)**: Should this request force synthetic _source? Use this to test if the mapping supports synthetic _source and to get a sense of the worst case performance. Fetches with this enabled will be slower the enabling synthetic source natively in the index. - -## client.searchMvt [_search_mvt] -Search a vector tile. - -Search a vector tile for geospatial values. -Before using this API, you should be familiar with the Mapbox vector tile specification. -The API returns results as a binary mapbox vector tile. - -Internally, Elasticsearch translates a vector tile search API request into a search containing: - -* A `geo_bounding_box` query on the ``. The query uses the `//` tile as a bounding box. -* A `geotile_grid` or `geohex_grid` aggregation on the ``. The `grid_agg` parameter determines the aggregation type. The aggregation uses the `//` tile as a bounding box. -* Optionally, a `geo_bounds` aggregation on the ``. The search only includes this aggregation if the `exact_bounds` parameter is `true`. -* If the optional parameter `with_labels` is `true`, the internal search will include a dynamic runtime field that calls the `getLabelPosition` function of the geometry doc value. This enables the generation of new point features containing suggested geometry labels, so that, for example, multi-polygons will have only one label. - -For example, Elasticsearch may translate a vector tile search API request with a `grid_agg` argument of `geotile` and an `exact_bounds` argument of `true` into the following search - -``` -GET my-index/_search -{ - "size": 10000, - "query": { - "geo_bounding_box": { - "my-geo-field": { - "top_left": { - "lat": -40.979898069620134, - "lon": -45 - }, - "bottom_right": { - "lat": -66.51326044311186, - "lon": 0 - } - } - } - }, - "aggregations": { - "grid": { - "geotile_grid": { - "field": "my-geo-field", - "precision": 11, - "size": 65536, - "bounds": { - "top_left": { - "lat": -40.979898069620134, - "lon": -45 - }, - "bottom_right": { - "lat": -66.51326044311186, - "lon": 0 - } - } - } - }, - "bounds": { - "geo_bounds": { - "field": "my-geo-field", - "wrap_longitude": false - } - } - } -} -``` - -The API returns results as a binary Mapbox vector tile. -Mapbox vector tiles are encoded as Google Protobufs (PBF). By default, the tile contains three layers: - -* A `hits` layer containing a feature for each `` value matching the `geo_bounding_box` query. -* An `aggs` layer containing a feature for each cell of the `geotile_grid` or `geohex_grid`. The layer only contains features for cells with matching data. -* A meta layer containing: - * A feature containing a bounding box. By default, this is the bounding box of the tile. - * Value ranges for any sub-aggregations on the `geotile_grid` or `geohex_grid`. - * Metadata for the search. - -The API only returns features that can display at its zoom level. -For example, if a polygon feature has no area at its zoom level, the API omits it. -The API returns errors as UTF-8 encoded JSON. - -IMPORTANT: You can specify several options for this API as either a query parameter or request body parameter. -If you specify both parameters, the query parameter takes precedence. - -**Grid precision for geotile** - -For a `grid_agg` of `geotile`, you can use cells in the `aggs` layer as tiles for lower zoom levels. -`grid_precision` represents the additional zoom levels available through these cells. The final precision is computed by as follows: ` + grid_precision`. -For example, if `` is 7 and `grid_precision` is 8, then the `geotile_grid` aggregation will use a precision of 15. -The maximum final precision is 29. -The `grid_precision` also determines the number of cells for the grid as follows: `(2^grid_precision) x (2^grid_precision)`. -For example, a value of 8 divides the tile into a grid of 256 x 256 cells. -The `aggs` layer only contains features for cells with matching data. - -**Grid precision for geohex** - -For a `grid_agg` of `geohex`, Elasticsearch uses `` and `grid_precision` to calculate a final precision as follows: ` + grid_precision`. - -This precision determines the H3 resolution of the hexagonal cells produced by the `geohex` aggregation. -The following table maps the H3 resolution for each precision. -For example, if `` is 3 and `grid_precision` is 3, the precision is 6. -At a precision of 6, hexagonal cells have an H3 resolution of 2. -If `` is 3 and `grid_precision` is 4, the precision is 7. -At a precision of 7, hexagonal cells have an H3 resolution of 3. - -| Precision | Unique tile bins | H3 resolution | Unique hex bins | Ratio | -| --------- | ---------------- | ------------- | ----------------| ----- | -| 1 | 4 | 0 | 122 | 30.5 | -| 2 | 16 | 0 | 122 | 7.625 | -| 3 | 64 | 1 | 842 | 13.15625 | -| 4 | 256 | 1 | 842 | 3.2890625 | -| 5 | 1024 | 2 | 5882 | 5.744140625 | -| 6 | 4096 | 2 | 5882 | 1.436035156 | -| 7 | 16384 | 3 | 41162 | 2.512329102 | -| 8 | 65536 | 3 | 41162 | 0.6280822754 | -| 9 | 262144 | 4 | 288122 | 1.099098206 | -| 10 | 1048576 | 4 | 288122 | 0.2747745514 | -| 11 | 4194304 | 5 | 2016842 | 0.4808526039 | -| 12 | 16777216 | 6 | 14117882 | 0.8414913416 | -| 13 | 67108864 | 6 | 14117882 | 0.2103728354 | -| 14 | 268435456 | 7 | 98825162 | 0.3681524172 | -| 15 | 1073741824 | 8 | 691776122 | 0.644266719 | -| 16 | 4294967296 | 8 | 691776122 | 0.1610666797 | -| 17 | 17179869184 | 9 | 4842432842 | 0.2818666889 | -| 18 | 68719476736 | 10 | 33897029882 | 0.4932667053 | -| 19 | 274877906944 | 11 | 237279209162 | 0.8632167343 | -| 20 | 1099511627776 | 11 | 237279209162 | 0.2158041836 | -| 21 | 4398046511104 | 12 | 1660954464122 | 0.3776573213 | -| 22 | 17592186044416 | 13 | 11626681248842 | 0.6609003122 | -| 23 | 70368744177664 | 13 | 11626681248842 | 0.165225078 | -| 24 | 281474976710656 | 14 | 81386768741882 | 0.2891438866 | -| 25 | 1125899906842620 | 15 | 569707381193162 | 0.5060018015 | -| 26 | 4503599627370500 | 15 | 569707381193162 | 0.1265004504 | -| 27 | 18014398509482000 | 15 | 569707381193162 | 0.03162511259 | -| 28 | 72057594037927900 | 15 | 569707381193162 | 0.007906278149 | -| 29 | 288230376151712000 | 15 | 569707381193162 | 0.001976569537 | - -Hexagonal cells don't align perfectly on a vector tile. -Some cells may intersect more than one vector tile. -To compute the H3 resolution for each precision, Elasticsearch compares the average density of hexagonal bins at each resolution with the average density of tile bins at each zoom level. -Elasticsearch uses the H3 resolution that is closest to the corresponding geotile density. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-mvt) - -```ts -client.searchMvt({ index, field, zoom, x, y }) -``` -### Arguments [_arguments_search_mvt] - -#### Request (object) [_request_search_mvt] - -- **`index` (string \| string[])**: List of data streams, indices, or aliases to search -- **`field` (string)**: Field containing geospatial data to return -- **`zoom` (number)**: Zoom level for the vector tile to search -- **`x` (number)**: X coordinate for the vector tile to search -- **`y` (number)**: Y coordinate for the vector tile to search -- **`aggs` (Optional, Record)**: Sub-aggregations for the geotile_grid. It supports the following aggregation types: - `avg` - `boxplot` - `cardinality` - `extended stats` - `max` - `median absolute deviation` - `min` - `percentile` - `percentile-rank` - `stats` - `sum` - `value count` The aggregation names can't start with `_mvt_`. The `_mvt_` prefix is reserved for internal aggregations. -- **`buffer` (Optional, number)**: The size, in pixels, of a clipping buffer outside the tile. This allows renderers to avoid outline artifacts from geometries that extend past the extent of the tile. -- **`exact_bounds` (Optional, boolean)**: If `false`, the meta layer's feature is the bounding box of the tile. If `true`, the meta layer's feature is a bounding box resulting from a `geo_bounds` aggregation. The aggregation runs on values that intersect the `//` tile with `wrap_longitude` set to `false`. The resulting bounding box may be larger than the vector tile. -- **`extent` (Optional, number)**: The size, in pixels, of a side of the tile. Vector tiles are square with equal sides. -- **`fields` (Optional, string \| string[])**: The fields to return in the `hits` layer. It supports wildcards (`*`). This parameter does not support fields with array values. Fields with array values may return inconsistent results. -- **`grid_agg` (Optional, Enum("geotile" \| "geohex"))**: The aggregation used to create a grid for the `field`. -- **`grid_precision` (Optional, number)**: Additional zoom levels available through the aggs layer. For example, if `` is `7` and `grid_precision` is `8`, you can zoom in up to level 15. Accepts 0-8. If 0, results don't include the aggs layer. -- **`grid_type` (Optional, Enum("grid" \| "point" \| "centroid"))**: Determines the geometry type for features in the aggs layer. In the aggs layer, each feature represents a `geotile_grid` cell. If `grid, each feature is a polygon of the cells bounding box. If `point`, each feature is a Point that is the centroid of the cell. -- **`query` (Optional, { bool, boosting, common, combined_fields, constant_score, dis_max, distance_feature, exists, function_score, fuzzy, geo_bounding_box, geo_distance, geo_grid, geo_polygon, geo_shape, has_child, has_parent, ids, intervals, knn, match, match_all, match_bool_prefix, match_none, match_phrase, match_phrase_prefix, more_like_this, multi_match, nested, parent_id, percolate, pinned, prefix, query_string, range, rank_feature, regexp, rule, script, script_score, semantic, shape, simple_query_string, span_containing, span_field_masking, span_first, span_multi, span_near, span_not, span_or, span_term, span_within, sparse_vector, term, terms, terms_set, text_expansion, weighted_tokens, wildcard, wrapper, type })**: The query DSL used to filter documents for the search. -- **`runtime_mappings` (Optional, Record)**: Defines one or more runtime fields in the search request. These fields take precedence over mapped fields with the same name. -- **`size` (Optional, number)**: The maximum number of features to return in the hits layer. Accepts 0-10000. If 0, results don't include the hits layer. -- **`sort` (Optional, string \| { _score, _doc, _geo_distance, _script } \| string \| { _score, _doc, _geo_distance, _script }[])**: Sort the features in the hits layer. By default, the API calculates a bounding box for each feature. It sorts features based on this box's diagonal length, from longest to shortest. -- **`track_total_hits` (Optional, boolean \| number)**: The number of hits matching the query to count accurately. If `true`, the exact number of hits is returned at the cost of some performance. If `false`, the response does not include the total number of hits matching the query. -- **`with_labels` (Optional, boolean)**: If `true`, the hits and aggs layers will contain additional point features representing suggested label positions for the original features. * `Point` and `MultiPoint` features will have one of the points selected. * `Polygon` and `MultiPolygon` features will have a single point generated, either the centroid, if it is within the polygon, or another point within the polygon selected from the sorted triangle-tree. * `LineString` features will likewise provide a roughly central point selected from the triangle-tree. * The aggregation results will provide one central point for each aggregation bucket. All attributes from the original features will also be copied to the new label features. In addition, the new features will be distinguishable using the tag `_mvt_label_position`. - -## client.searchShards [_search_shards] -Get the search shards. - -Get the indices and shards that a search request would be run against. -This information can be useful for working out issues or planning optimizations with routing and shard preferences. -When filtered aliases are used, the filter is returned as part of the `indices` section. - -If the Elasticsearch security features are enabled, you must have the `view_index_metadata` or `manage` index privilege for the target data stream, index, or alias. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-shards) - -```ts -client.searchShards({ ... }) -``` -### Arguments [_arguments_search_shards] - -#### Request (object) [_request_search_shards] - -- **`index` (Optional, string \| string[])**: A list of data streams, indices, and aliases to search. It supports wildcards (`*`). To search all data streams and indices, omit this parameter or use `*` or `_all`. -- **`allow_no_indices` (Optional, boolean)**: If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. -- **`expand_wildcards` (Optional, Enum("all" \| "open" \| "closed" \| "hidden" \| "none") \| Enum("all" \| "open" \| "closed" \| "hidden" \| "none")[])**: Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports a list of values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. -- **`ignore_unavailable` (Optional, boolean)**: If `false`, the request returns an error if it targets a missing or closed index. -- **`local` (Optional, boolean)**: If `true`, the request retrieves information from the local node only. -- **`master_timeout` (Optional, string \| -1 \| 0)**: The period to wait for a connection to the master node. If the master node is not available before the timeout expires, the request fails and returns an error. IT can also be set to `-1` to indicate that the request should never timeout. -- **`preference` (Optional, string)**: The node or shard the operation should be performed on. It is random by default. -- **`routing` (Optional, string)**: A custom value used to route operations to a specific shard. - -## client.searchTemplate [_search_template] -Run a search with a search template. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-template) - -```ts -client.searchTemplate({ ... }) -``` -### Arguments [_arguments_search_template] - -#### Request (object) [_request_search_template] - -- **`index` (Optional, string \| string[])**: A list of data streams, indices, and aliases to search. It supports wildcards (`*`). -- **`explain` (Optional, boolean)**: If `true`, returns detailed information about score calculation as part of each hit. If you specify both this and the `explain` query parameter, the API uses only the query parameter. -- **`id` (Optional, string)**: The ID of the search template to use. If no `source` is specified, this parameter is required. -- **`params` (Optional, Record)**: Key-value pairs used to replace Mustache variables in the template. The key is the variable name. The value is the variable value. -- **`profile` (Optional, boolean)**: If `true`, the query execution is profiled. -- **`source` (Optional, string \| { aggregations, collapse, explain, ext, from, highlight, track_total_hits, indices_boost, docvalue_fields, knn, rank, min_score, post_filter, profile, query, rescore, retriever, script_fields, search_after, size, slice, sort, _source, fields, suggest, terminate_after, timeout, track_scores, version, seq_no_primary_term, stored_fields, pit, runtime_mappings, stats })**: An inline search template. Supports the same parameters as the search API's request body. It also supports Mustache variables. If no `id` is specified, this parameter is required. -- **`allow_no_indices` (Optional, boolean)**: If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. -- **`ccs_minimize_roundtrips` (Optional, boolean)**: If `true`, network round-trips are minimized for cross-cluster search requests. -- **`expand_wildcards` (Optional, Enum("all" \| "open" \| "closed" \| "hidden" \| "none") \| Enum("all" \| "open" \| "closed" \| "hidden" \| "none")[])**: The type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports a list of values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. -- **`ignore_throttled` (Optional, boolean)**: If `true`, specified concrete, expanded, or aliased indices are not included in the response when throttled. -- **`ignore_unavailable` (Optional, boolean)**: If `false`, the request returns an error if it targets a missing or closed index. -- **`preference` (Optional, string)**: The node or shard the operation should be performed on. It is random by default. -- **`routing` (Optional, string)**: A custom value used to route operations to a specific shard. -- **`scroll` (Optional, string \| -1 \| 0)**: Specifies how long a consistent view of the index should be maintained for scrolled search. -- **`search_type` (Optional, Enum("query_then_fetch" \| "dfs_query_then_fetch"))**: The type of the search operation. -- **`rest_total_hits_as_int` (Optional, boolean)**: If `true`, `hits.total` is rendered as an integer in the response. If `false`, it is rendered as an object. -- **`typed_keys` (Optional, boolean)**: If `true`, the response prefixes aggregation and suggester names with their respective types. - -## client.termsEnum [_terms_enum] -Get terms in an index. - -Discover terms that match a partial string in an index. -This API is designed for low-latency look-ups used in auto-complete scenarios. - -> info -> The terms enum API may return terms from deleted documents. Deleted documents are initially only marked as deleted. It is not until their segments are merged that documents are actually deleted. Until that happens, the terms enum API will return terms from these documents. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-terms-enum) - -```ts -client.termsEnum({ index, field }) -``` -### Arguments [_arguments_terms_enum] - -#### Request (object) [_request_terms_enum] - -- **`index` (string)**: A list of data streams, indices, and index aliases to search. Wildcard (`*`) expressions are supported. To search all data streams or indices, omit this parameter or use `*` or `_all`. -- **`field` (string)**: The string to match at the start of indexed terms. If not provided, all terms in the field are considered. -- **`size` (Optional, number)**: The number of matching terms to return. -- **`timeout` (Optional, string \| -1 \| 0)**: The maximum length of time to spend collecting results. If the timeout is exceeded the `complete` flag set to `false` in the response and the results may be partial or empty. -- **`case_insensitive` (Optional, boolean)**: When `true`, the provided search string is matched against index terms without case sensitivity. -- **`index_filter` (Optional, { bool, boosting, common, combined_fields, constant_score, dis_max, distance_feature, exists, function_score, fuzzy, geo_bounding_box, geo_distance, geo_grid, geo_polygon, geo_shape, has_child, has_parent, ids, intervals, knn, match, match_all, match_bool_prefix, match_none, match_phrase, match_phrase_prefix, more_like_this, multi_match, nested, parent_id, percolate, pinned, prefix, query_string, range, rank_feature, regexp, rule, script, script_score, semantic, shape, simple_query_string, span_containing, span_field_masking, span_first, span_multi, span_near, span_not, span_or, span_term, span_within, sparse_vector, term, terms, terms_set, text_expansion, weighted_tokens, wildcard, wrapper, type })**: Filter an index shard if the provided query rewrites to `match_none`. -- **`string` (Optional, string)**: The string to match at the start of indexed terms. If it is not provided, all terms in the field are considered. > info > The prefix string cannot be larger than the largest possible keyword value, which is Lucene's term byte-length limit of 32766. -- **`search_after` (Optional, string)**: The string after which terms in the index should be returned. It allows for a form of pagination if the last result from one request is passed as the `search_after` parameter for a subsequent request. - -## client.termvectors [_termvectors] -Get term vector information. - -Get information and statistics about terms in the fields of a particular document. - -You can retrieve term vectors for documents stored in the index or for artificial documents passed in the body of the request. -You can specify the fields you are interested in through the `fields` parameter or by adding the fields to the request body. -For example: - -``` -GET /my-index-000001/_termvectors/1?fields=message -``` - -Fields can be specified using wildcards, similar to the multi match query. - -Term vectors are real-time by default, not near real-time. -This can be changed by setting `realtime` parameter to `false`. - -You can request three types of values: _term information_, _term statistics_, and _field statistics_. -By default, all term information and field statistics are returned for all fields but term statistics are excluded. - -**Term information** - -* term frequency in the field (always returned) -* term positions (`positions: true`) -* start and end offsets (`offsets: true`) -* term payloads (`payloads: true`), as base64 encoded bytes - -If the requested information wasn't stored in the index, it will be computed on the fly if possible. -Additionally, term vectors could be computed for documents not even existing in the index, but instead provided by the user. - -> warn -> Start and end offsets assume UTF-16 encoding is being used. If you want to use these offsets in order to get the original text that produced this token, you should make sure that the string you are taking a sub-string of is also encoded using UTF-16. - -**Behaviour** - -The term and field statistics are not accurate. -Deleted documents are not taken into account. -The information is only retrieved for the shard the requested document resides in. -The term and field statistics are therefore only useful as relative measures whereas the absolute numbers have no meaning in this context. -By default, when requesting term vectors of artificial documents, a shard to get the statistics from is randomly selected. -Use `routing` only to hit a particular shard. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-termvectors) - -```ts -client.termvectors({ index }) -``` -### Arguments [_arguments_termvectors] - -#### Request (object) [_request_termvectors] - -- **`index` (string)**: The name of the index that contains the document. -- **`id` (Optional, string)**: A unique identifier for the document. -- **`doc` (Optional, object)**: An artificial document (a document not present in the index) for which you want to retrieve term vectors. -- **`filter` (Optional, { max_doc_freq, max_num_terms, max_term_freq, max_word_length, min_doc_freq, min_term_freq, min_word_length })**: Filter terms based on their tf-idf scores. This could be useful in order find out a good characteristic vector of a document. This feature works in a similar manner to the second phase of the More Like This Query. -- **`per_field_analyzer` (Optional, Record)**: Override the default per-field analyzer. This is useful in order to generate term vectors in any fashion, especially when using artificial documents. When providing an analyzer for a field that already stores term vectors, the term vectors will be regenerated. -- **`fields` (Optional, string \| string[])**: A list of fields to include in the statistics. It is used as the default list unless a specific field list is provided in the `completion_fields` or `fielddata_fields` parameters. -- **`field_statistics` (Optional, boolean)**: If `true`, the response includes: * The document count (how many documents contain this field). * The sum of document frequencies (the sum of document frequencies for all terms in this field). * The sum of total term frequencies (the sum of total term frequencies of each term in this field). -- **`offsets` (Optional, boolean)**: If `true`, the response includes term offsets. -- **`payloads` (Optional, boolean)**: If `true`, the response includes term payloads. -- **`positions` (Optional, boolean)**: If `true`, the response includes term positions. -- **`term_statistics` (Optional, boolean)**: If `true`, the response includes: * The total term frequency (how often a term occurs in all documents). * The document frequency (the number of documents containing the current term). By default these values are not returned since term statistics can have a serious performance impact. -- **`routing` (Optional, string)**: A custom value that is used to route operations to a specific shard. -- **`version` (Optional, number)**: If `true`, returns the document version as part of a hit. -- **`version_type` (Optional, Enum("internal" \| "external" \| "external_gte" \| "force"))**: The version type. -- **`preference` (Optional, string)**: The node or shard the operation should be performed on. It is random by default. -- **`realtime` (Optional, boolean)**: If true, the request is real-time as opposed to near-real-time. - -## client.update [_update] -Update a document. - -Update a document by running a script or passing a partial document. - -If the Elasticsearch security features are enabled, you must have the `index` or `write` index privilege for the target index or index alias. - -The script can update, delete, or skip modifying the document. -The API also supports passing a partial document, which is merged into the existing document. -To fully replace an existing document, use the index API. -This operation: - -* Gets the document (collocated with the shard) from the index. -* Runs the specified script. -* Indexes the result. - -The document must still be reindexed, but using this API removes some network roundtrips and reduces chances of version conflicts between the GET and the index operation. - -The `_source` field must be enabled to use this API. -In addition to `_source`, you can access the following variables through the `ctx` map: `_index`, `_type`, `_id`, `_version`, `_routing`, and `_now` (the current timestamp). - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-update) - -```ts -client.update({ id, index }) -``` -### Arguments [_arguments_update] - -#### Request (object) [_request_update] - -- **`id` (string)**: A unique identifier for the document to be updated. -- **`index` (string)**: The name of the target index. By default, the index is created automatically if it doesn't exist. -- **`detect_noop` (Optional, boolean)**: If `true`, the `result` in the response is set to `noop` (no operation) when there are no changes to the document. -- **`doc` (Optional, object)**: A partial update to an existing document. If both `doc` and `script` are specified, `doc` is ignored. -- **`doc_as_upsert` (Optional, boolean)**: If `true`, use the contents of 'doc' as the value of 'upsert'. NOTE: Using ingest pipelines with `doc_as_upsert` is not supported. -- **`script` (Optional, { source, id, params, lang, options })**: The script to run to update the document. -- **`scripted_upsert` (Optional, boolean)**: If `true`, run the script whether or not the document exists. -- **`_source` (Optional, boolean \| { excludes, includes })**: If `false`, turn off source retrieval. You can also specify a list of the fields you want to retrieve. -- **`upsert` (Optional, object)**: If the document does not already exist, the contents of 'upsert' are inserted as a new document. If the document exists, the 'script' is run. -- **`if_primary_term` (Optional, number)**: Only perform the operation if the document has this primary term. -- **`if_seq_no` (Optional, number)**: Only perform the operation if the document has this sequence number. -- **`include_source_on_error` (Optional, boolean)**: True or false if to include the document source in the error message in case of parsing errors. -- **`lang` (Optional, string)**: The script language. -- **`refresh` (Optional, Enum(true \| false \| "wait_for"))**: If 'true', Elasticsearch refreshes the affected shards to make this operation visible to search. If 'wait_for', it waits for a refresh to make this operation visible to search. If 'false', it does nothing with refreshes. -- **`require_alias` (Optional, boolean)**: If `true`, the destination must be an index alias. -- **`retry_on_conflict` (Optional, number)**: The number of times the operation should be retried when a conflict occurs. -- **`routing` (Optional, string)**: A custom value used to route operations to a specific shard. -- **`timeout` (Optional, string \| -1 \| 0)**: The period to wait for the following operations: dynamic mapping updates and waiting for active shards. Elasticsearch waits for at least the timeout period before failing. The actual wait time could be longer, particularly when multiple waits occur. -- **`wait_for_active_shards` (Optional, number \| Enum("all" \| "index-setting"))**: The number of copies of each shard that must be active before proceeding with the operation. Set to 'all' or any positive integer up to the total number of shards in the index (`number_of_replicas`+1). The default value of `1` means it waits for each primary shard to be active. -- **`_source_excludes` (Optional, string \| string[])**: The source fields you want to exclude. -- **`_source_includes` (Optional, string \| string[])**: The source fields you want to retrieve. - -## client.updateByQuery [_update_by_query] -Update documents. -Updates documents that match the specified query. -If no query is specified, performs an update on every document in the data stream or index without modifying the source, which is useful for picking up mapping changes. - -If the Elasticsearch security features are enabled, you must have the following index privileges for the target data stream, index, or alias: - -* `read` -* `index` or `write` - -You can specify the query criteria in the request URI or the request body using the same syntax as the search API. - -When you submit an update by query request, Elasticsearch gets a snapshot of the data stream or index when it begins processing the request and updates matching documents using internal versioning. -When the versions match, the document is updated and the version number is incremented. -If a document changes between the time that the snapshot is taken and the update operation is processed, it results in a version conflict and the operation fails. -You can opt to count version conflicts instead of halting and returning by setting `conflicts` to `proceed`. -Note that if you opt to count version conflicts, the operation could attempt to update more documents from the source than `max_docs` until it has successfully updated `max_docs` documents or it has gone through every document in the source query. - -NOTE: Documents with a version equal to 0 cannot be updated using update by query because internal versioning does not support 0 as a valid version number. - -While processing an update by query request, Elasticsearch performs multiple search requests sequentially to find all of the matching documents. -A bulk update request is performed for each batch of matching documents. -Any query or update failures cause the update by query request to fail and the failures are shown in the response. -Any update requests that completed successfully still stick, they are not rolled back. - -**Throttling update requests** - -To control the rate at which update by query issues batches of update operations, you can set `requests_per_second` to any positive decimal number. -This pads each batch with a wait time to throttle the rate. -Set `requests_per_second` to `-1` to turn off throttling. - -Throttling uses a wait time between batches so that the internal scroll requests can be given a timeout that takes the request padding into account. -The padding time is the difference between the batch size divided by the `requests_per_second` and the time spent writing. -By default the batch size is 1000, so if `requests_per_second` is set to `500`: - -``` -target_time = 1000 / 500 per second = 2 seconds -wait_time = target_time - write_time = 2 seconds - .5 seconds = 1.5 seconds -``` - -Since the batch is issued as a single _bulk request, large batch sizes cause Elasticsearch to create many requests and wait before starting the next set. -This is "bursty" instead of "smooth". - -**Slicing** - -Update by query supports sliced scroll to parallelize the update process. -This can improve efficiency and provide a convenient way to break the request down into smaller parts. - -Setting `slices` to `auto` chooses a reasonable number for most data streams and indices. -This setting will use one slice per shard, up to a certain limit. -If there are multiple source data streams or indices, it will choose the number of slices based on the index or backing index with the smallest number of shards. - -Adding `slices` to `_update_by_query` just automates the manual process of creating sub-requests, which means it has some quirks: - -* You can see these requests in the tasks APIs. These sub-requests are "child" tasks of the task for the request with slices. -* Fetching the status of the task for the request with `slices` only contains the status of completed slices. -* These sub-requests are individually addressable for things like cancellation and rethrottling. -* Rethrottling the request with `slices` will rethrottle the unfinished sub-request proportionally. -* Canceling the request with slices will cancel each sub-request. -* Due to the nature of slices each sub-request won't get a perfectly even portion of the documents. All documents will be addressed, but some slices may be larger than others. Expect larger slices to have a more even distribution. -* Parameters like `requests_per_second` and `max_docs` on a request with slices are distributed proportionally to each sub-request. Combine that with the point above about distribution being uneven and you should conclude that using `max_docs` with `slices` might not result in exactly `max_docs` documents being updated. -* Each sub-request gets a slightly different snapshot of the source data stream or index though these are all taken at approximately the same time. - -If you're slicing manually or otherwise tuning automatic slicing, keep in mind that: - -* Query performance is most efficient when the number of slices is equal to the number of shards in the index or backing index. If that number is large (for example, 500), choose a lower number as too many slices hurts performance. Setting slices higher than the number of shards generally does not improve efficiency and adds overhead. -* Update performance scales linearly across available resources with the number of slices. - -Whether query or update performance dominates the runtime depends on the documents being reindexed and cluster resources. - -**Update the document source** - -Update by query supports scripts to update the document source. -As with the update API, you can set `ctx.op` to change the operation that is performed. - -Set `ctx.op = "noop"` if your script decides that it doesn't have to make any changes. -The update by query operation skips updating the document and increments the `noop` counter. - -Set `ctx.op = "delete"` if your script decides that the document should be deleted. -The update by query operation deletes the document and increments the `deleted` counter. - -Update by query supports only `index`, `noop`, and `delete`. -Setting `ctx.op` to anything else is an error. -Setting any other field in `ctx` is an error. -This API enables you to only modify the source of matching documents; you cannot move them. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-update-by-query) - -```ts -client.updateByQuery({ index }) -``` -### Arguments [_arguments_update_by_query] - -#### Request (object) [_request_update_by_query] - -- **`index` (string \| string[])**: A list of data streams, indices, and aliases to search. It supports wildcards (`*`). To search all data streams or indices, omit this parameter or use `*` or `_all`. -- **`max_docs` (Optional, number)**: The maximum number of documents to update. -- **`query` (Optional, { bool, boosting, common, combined_fields, constant_score, dis_max, distance_feature, exists, function_score, fuzzy, geo_bounding_box, geo_distance, geo_grid, geo_polygon, geo_shape, has_child, has_parent, ids, intervals, knn, match, match_all, match_bool_prefix, match_none, match_phrase, match_phrase_prefix, more_like_this, multi_match, nested, parent_id, percolate, pinned, prefix, query_string, range, rank_feature, regexp, rule, script, script_score, semantic, shape, simple_query_string, span_containing, span_field_masking, span_first, span_multi, span_near, span_not, span_or, span_term, span_within, sparse_vector, term, terms, terms_set, text_expansion, weighted_tokens, wildcard, wrapper, type })**: The documents to update using the Query DSL. -- **`script` (Optional, { source, id, params, lang, options })**: The script to run to update the document source or metadata when updating. -- **`slice` (Optional, { field, id, max })**: Slice the request manually using the provided slice ID and total number of slices. -- **`conflicts` (Optional, Enum("abort" \| "proceed"))**: The preferred behavior when update by query hits version conflicts: `abort` or `proceed`. -- **`allow_no_indices` (Optional, boolean)**: If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. -- **`analyzer` (Optional, string)**: The analyzer to use for the query string. This parameter can be used only when the `q` query string parameter is specified. -- **`analyze_wildcard` (Optional, boolean)**: If `true`, wildcard and prefix queries are analyzed. This parameter can be used only when the `q` query string parameter is specified. -- **`default_operator` (Optional, Enum("and" \| "or"))**: The default operator for query string query: `AND` or `OR`. This parameter can be used only when the `q` query string parameter is specified. -- **`df` (Optional, string)**: The field to use as default where no field prefix is given in the query string. This parameter can be used only when the `q` query string parameter is specified. -- **`expand_wildcards` (Optional, Enum("all" \| "open" \| "closed" \| "hidden" \| "none") \| Enum("all" \| "open" \| "closed" \| "hidden" \| "none")[])**: The type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. It supports a list of values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. -- **`from` (Optional, number)**: Skips the specified number of documents. -- **`ignore_unavailable` (Optional, boolean)**: If `false`, the request returns an error if it targets a missing or closed index. -- **`lenient` (Optional, boolean)**: If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. This parameter can be used only when the `q` query string parameter is specified. -- **`pipeline` (Optional, string)**: The ID of the pipeline to use to preprocess incoming documents. If the index has a default ingest pipeline specified, then setting the value to `_none` disables the default ingest pipeline for this request. If a final pipeline is configured it will always run, regardless of the value of this parameter. -- **`preference` (Optional, string)**: The node or shard the operation should be performed on. It is random by default. -- **`q` (Optional, string)**: A query in the Lucene query string syntax. -- **`refresh` (Optional, boolean)**: If `true`, Elasticsearch refreshes affected shards to make the operation visible to search after the request completes. This is different than the update API's `refresh` parameter, which causes just the shard that received the request to be refreshed. -- **`request_cache` (Optional, boolean)**: If `true`, the request cache is used for this request. It defaults to the index-level setting. -- **`requests_per_second` (Optional, float)**: The throttle for this request in sub-requests per second. -- **`routing` (Optional, string)**: A custom value used to route operations to a specific shard. -- **`scroll` (Optional, string \| -1 \| 0)**: The period to retain the search context for scrolling. -- **`scroll_size` (Optional, number)**: The size of the scroll request that powers the operation. -- **`search_timeout` (Optional, string \| -1 \| 0)**: An explicit timeout for each search request. By default, there is no timeout. -- **`search_type` (Optional, Enum("query_then_fetch" \| "dfs_query_then_fetch"))**: The type of the search operation. Available options include `query_then_fetch` and `dfs_query_then_fetch`. -- **`slices` (Optional, number \| Enum("auto"))**: The number of slices this task should be divided into. -- **`sort` (Optional, string[])**: A list of : pairs. -- **`stats` (Optional, string[])**: The specific `tag` of the request for logging and statistical purposes. -- **`terminate_after` (Optional, number)**: The maximum number of documents to collect for each shard. If a query reaches this limit, Elasticsearch terminates the query early. Elasticsearch collects documents before sorting. IMPORTANT: Use with caution. Elasticsearch applies this parameter to each shard handling the request. When possible, let Elasticsearch perform early termination automatically. Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers. -- **`timeout` (Optional, string \| -1 \| 0)**: The period each update request waits for the following operations: dynamic mapping updates, waiting for active shards. By default, it is one minute. This guarantees Elasticsearch waits for at least the timeout before failing. The actual wait time could be longer, particularly when multiple waits occur. -- **`version` (Optional, boolean)**: If `true`, returns the document version as part of a hit. -- **`version_type` (Optional, boolean)**: Should the document increment the version number (internal) on hit or not (reindex) -- **`wait_for_active_shards` (Optional, number \| Enum("all" \| "index-setting"))**: The number of shard copies that must be active before proceeding with the operation. Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). The `timeout` parameter controls how long each write request waits for unavailable shards to become available. Both work exactly the way they work in the bulk API. -- **`wait_for_completion` (Optional, boolean)**: If `true`, the request blocks until the operation is complete. If `false`, Elasticsearch performs some preflight checks, launches the request, and returns a task ID that you can use to cancel or get the status of the task. Elasticsearch creates a record of this task as a document at `.tasks/task/${taskId}`. - -## client.updateByQueryRethrottle [_update_by_query_rethrottle] -Throttle an update by query operation. - -Change the number of requests per second for a particular update by query operation. -Rethrottling that speeds up the query takes effect immediately but rethrotting that slows down the query takes effect after completing the current batch to prevent scroll timeouts. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-update-by-query-rethrottle) - -```ts -client.updateByQueryRethrottle({ task_id }) -``` -### Arguments [_arguments_update_by_query_rethrottle] - -#### Request (object) [_request_update_by_query_rethrottle] - -- **`task_id` (string)**: The ID for the task. -- **`requests_per_second` (Optional, float)**: The throttle for this request in sub-requests per second. To turn off throttling, set it to `-1`. - -## client.asyncSearch.delete [_async_search.delete] -Delete an async search. - -If the asynchronous search is still running, it is cancelled. -Otherwise, the saved search results are deleted. -If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the `cancel_task` cluster privilege. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-async-search-submit) - -```ts -client.asyncSearch.delete({ id }) -``` - -### Arguments [_arguments_async_search.delete] - -#### Request (object) [_request_async_search.delete] -- **`id` (string)**: A unique identifier for the async search. - -## client.asyncSearch.get [_async_search.get] -Get async search results. - -Retrieve the results of a previously submitted asynchronous search request. -If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-async-search-submit) - -```ts -client.asyncSearch.get({ id }) -``` - -### Arguments [_arguments_async_search.get] - -#### Request (object) [_request_async_search.get] -- **`id` (string)**: A unique identifier for the async search. -- **`keep_alive` (Optional, string \| -1 \| 0)**: The length of time that the async search should be available in the cluster. -When not specified, the `keep_alive` set with the corresponding submit async request will be used. -Otherwise, it is possible to override the value and extend the validity of the request. -When this period expires, the search, if still running, is cancelled. -If the search is completed, its saved results are deleted. -- **`typed_keys` (Optional, boolean)**: Specify whether aggregation and suggester names should be prefixed by their respective types in the response -- **`wait_for_completion_timeout` (Optional, string \| -1 \| 0)**: Specifies to wait for the search to be completed up until the provided timeout. -Final results will be returned if available before the timeout expires, otherwise the currently available results will be returned once the timeout expires. -By default no timeout is set meaning that the currently available results will be returned without any additional wait. - -## client.asyncSearch.status [_async_search.status] -Get the async search status. - -Get the status of a previously submitted async search request given its identifier, without retrieving search results. -If the Elasticsearch security features are enabled, the access to the status of a specific async search is restricted to: - -* The user or API key that submitted the original async search request. -* Users that have the `monitor` cluster privilege or greater privileges. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-async-search-submit) - -```ts -client.asyncSearch.status({ id }) -``` - -### Arguments [_arguments_async_search.status] - -#### Request (object) [_request_async_search.status] -- **`id` (string)**: A unique identifier for the async search. -- **`keep_alive` (Optional, string \| -1 \| 0)**: The length of time that the async search needs to be available. -Ongoing async searches and any saved search results are deleted after this period. - -## client.asyncSearch.submit [_async_search.submit] -Run an async search. - -When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field. Partial results become available following the sort criteria that was requested. - -Warning: Asynchronous search does not support scroll or search requests that include only the suggest section. - -By default, Elasticsearch does not allow you to store an async search response larger than 10Mb and an attempt to do this results in an error. -The maximum allowed size for a stored async search response can be set by changing the `search.max_async_search_response_size` cluster level setting. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-async-search-submit) - -```ts -client.asyncSearch.submit({ ... }) -``` - -### Arguments [_arguments_async_search.submit] - -#### Request (object) [_request_async_search.submit] -- **`index` (Optional, string \| string[])**: A list of index names to search; use `_all` or empty string to perform the operation on all indices -- **`aggregations` (Optional, Record)** -- **`collapse` (Optional, { field, inner_hits, max_concurrent_group_searches, collapse })** -- **`explain` (Optional, boolean)**: If true, returns detailed information about score computation as part of a hit. -- **`ext` (Optional, Record)**: Configuration of search extensions defined by Elasticsearch plugins. -- **`from` (Optional, number)**: Starting document offset. By default, you cannot page through more than 10,000 -hits using the from and size parameters. To page through more hits, use the -search_after parameter. -- **`highlight` (Optional, { encoder, fields })** -- **`track_total_hits` (Optional, boolean \| number)**: Number of hits matching the query to count accurately. If true, the exact -number of hits is returned at the cost of some performance. If false, the -response does not include the total number of hits matching the query. -Defaults to 10,000 hits. -- **`indices_boost` (Optional, Record[])**: Boosts the _score of documents from specified indices. -- **`docvalue_fields` (Optional, { field, format, include_unmapped }[])**: Array of wildcard (*) patterns. The request returns doc values for field -names matching these patterns in the hits.fields property of the response. -- **`knn` (Optional, { field, query_vector, query_vector_builder, k, num_candidates, boost, filter, similarity, inner_hits, rescore_vector } \| { field, query_vector, query_vector_builder, k, num_candidates, boost, filter, similarity, inner_hits, rescore_vector }[])**: Defines the approximate kNN search to run. -- **`min_score` (Optional, number)**: Minimum _score for matching documents. Documents with a lower _score are -not included in search results and results collected by aggregations. -- **`post_filter` (Optional, { bool, boosting, common, combined_fields, constant_score, dis_max, distance_feature, exists, function_score, fuzzy, geo_bounding_box, geo_distance, geo_grid, geo_polygon, geo_shape, has_child, has_parent, ids, intervals, knn, match, match_all, match_bool_prefix, match_none, match_phrase, match_phrase_prefix, more_like_this, multi_match, nested, parent_id, percolate, pinned, prefix, query_string, range, rank_feature, regexp, rule, script, script_score, semantic, shape, simple_query_string, span_containing, span_field_masking, span_first, span_multi, span_near, span_not, span_or, span_term, span_within, sparse_vector, term, terms, terms_set, text_expansion, weighted_tokens, wildcard, wrapper, type })** -- **`profile` (Optional, boolean)** -- **`query` (Optional, { bool, boosting, common, combined_fields, constant_score, dis_max, distance_feature, exists, function_score, fuzzy, geo_bounding_box, geo_distance, geo_grid, geo_polygon, geo_shape, has_child, has_parent, ids, intervals, knn, match, match_all, match_bool_prefix, match_none, match_phrase, match_phrase_prefix, more_like_this, multi_match, nested, parent_id, percolate, pinned, prefix, query_string, range, rank_feature, regexp, rule, script, script_score, semantic, shape, simple_query_string, span_containing, span_field_masking, span_first, span_multi, span_near, span_not, span_or, span_term, span_within, sparse_vector, term, terms, terms_set, text_expansion, weighted_tokens, wildcard, wrapper, type })**: Defines the search definition using the Query DSL. -- **`rescore` (Optional, { window_size, query, learning_to_rank } \| { window_size, query, learning_to_rank }[])** -- **`script_fields` (Optional, Record)**: Retrieve a script evaluation (based on different fields) for each hit. -- **`search_after` (Optional, number \| number \| string \| boolean \| null[])** -- **`size` (Optional, number)**: The number of hits to return. By default, you cannot page through more -than 10,000 hits using the from and size parameters. To page through more -hits, use the search_after parameter. -- **`slice` (Optional, { field, id, max })** -- **`sort` (Optional, string \| { _score, _doc, _geo_distance, _script } \| string \| { _score, _doc, _geo_distance, _script }[])** -- **`_source` (Optional, boolean \| { excludes, includes })**: Indicates which source fields are returned for matching documents. These -fields are returned in the hits._source property of the search response. -- **`fields` (Optional, { field, format, include_unmapped }[])**: Array of wildcard (*) patterns. The request returns values for field names -matching these patterns in the hits.fields property of the response. -- **`suggest` (Optional, { text })** -- **`terminate_after` (Optional, number)**: Maximum number of documents to collect for each shard. If a query reaches this -limit, Elasticsearch terminates the query early. Elasticsearch collects documents -before sorting. Defaults to 0, which does not terminate query execution early. -- **`timeout` (Optional, string)**: Specifies the period of time to wait for a response from each shard. If no response -is received before the timeout expires, the request fails and returns an error. -Defaults to no timeout. -- **`track_scores` (Optional, boolean)**: If true, calculate and return document scores, even if the scores are not used for sorting. -- **`version` (Optional, boolean)**: If true, returns document version as part of a hit. -- **`seq_no_primary_term` (Optional, boolean)**: If true, returns sequence number and primary term of the last modification -of each hit. See Optimistic concurrency control. -- **`stored_fields` (Optional, string \| string[])**: List of stored fields to return as part of a hit. If no fields are specified, -no stored fields are included in the response. If this field is specified, the _source -parameter defaults to false. You can pass _source: true to return both source fields -and stored fields in the search response. -- **`pit` (Optional, { id, keep_alive })**: Limits the search to a point in time (PIT). If you provide a PIT, you -cannot specify an in the request path. -- **`runtime_mappings` (Optional, Record)**: Defines one or more runtime fields in the search request. These fields take -precedence over mapped fields with the same name. -- **`stats` (Optional, string[])**: Stats groups to associate with the search. Each group maintains a statistics -aggregation for its associated searches. You can retrieve these stats using -the indices stats API. -- **`wait_for_completion_timeout` (Optional, string \| -1 \| 0)**: Blocks and waits until the search is completed up to a certain timeout. -When the async search completes within the timeout, the response won’t include the ID as the results are not stored in the cluster. -- **`keep_alive` (Optional, string \| -1 \| 0)**: Specifies how long the async search needs to be available. -Ongoing async searches and any saved search results are deleted after this period. -- **`keep_on_completion` (Optional, boolean)**: If `true`, results are stored for later retrieval when the search completes within the `wait_for_completion_timeout`. -- **`allow_no_indices` (Optional, boolean)**: Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) -- **`allow_partial_search_results` (Optional, boolean)**: Indicate if an error should be returned if there is a partial search failure or timeout -- **`analyzer` (Optional, string)**: The analyzer to use for the query string -- **`analyze_wildcard` (Optional, boolean)**: Specify whether wildcard and prefix queries should be analyzed (default: false) -- **`batched_reduce_size` (Optional, number)**: Affects how often partial results become available, which happens whenever shard results are reduced. -A partial reduction is performed every time the coordinating node has received a certain number of new shard responses (5 by default). -- **`ccs_minimize_roundtrips` (Optional, boolean)**: The default value is the only supported value. -- **`default_operator` (Optional, Enum("and" \| "or"))**: The default operator for query string query (AND or OR) -- **`df` (Optional, string)**: The field to use as default where no field prefix is given in the query string -- **`expand_wildcards` (Optional, Enum("all" \| "open" \| "closed" \| "hidden" \| "none") \| Enum("all" \| "open" \| "closed" \| "hidden" \| "none")[])**: Whether to expand wildcard expression to concrete indices that are open, closed or both. -- **`ignore_throttled` (Optional, boolean)**: Whether specified concrete, expanded or aliased indices should be ignored when throttled -- **`ignore_unavailable` (Optional, boolean)**: Whether specified concrete indices should be ignored when unavailable (missing or closed) -- **`lenient` (Optional, boolean)**: Specify whether format-based query failures (such as providing text to a numeric field) should be ignored -- **`max_concurrent_shard_requests` (Optional, number)**: The number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests -- **`preference` (Optional, string)**: Specify the node or shard the operation should be performed on (default: random) -- **`request_cache` (Optional, boolean)**: Specify if request cache should be used for this request or not, defaults to true -- **`routing` (Optional, string)**: A list of specific routing values -- **`search_type` (Optional, Enum("query_then_fetch" \| "dfs_query_then_fetch"))**: Search operation type -- **`suggest_field` (Optional, string)**: Specifies which field to use for suggestions. -- **`suggest_mode` (Optional, Enum("missing" \| "popular" \| "always"))**: Specify suggest mode -- **`suggest_size` (Optional, number)**: How many suggestions to return in response -- **`suggest_text` (Optional, string)**: The source text for which the suggestions should be returned. -- **`typed_keys` (Optional, boolean)**: Specify whether aggregation and suggester names should be prefixed by their respective types in the response -- **`rest_total_hits_as_int` (Optional, boolean)**: Indicates whether hits.total should be rendered as an integer or an object in the rest search response -- **`_source_excludes` (Optional, string \| string[])**: A list of fields to exclude from the returned _source field -- **`_source_includes` (Optional, string \| string[])**: A list of fields to extract and return from the _source field -- **`q` (Optional, string)**: Query in the Lucene query string syntax - -## client.autoscaling.deleteAutoscalingPolicy [_autoscaling.delete_autoscaling_policy] -Delete an autoscaling policy. - -NOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-autoscaling-delete-autoscaling-policy) - -```ts -client.autoscaling.deleteAutoscalingPolicy({ name }) -``` - -### Arguments [_arguments_autoscaling.delete_autoscaling_policy] - -#### Request (object) [_request_autoscaling.delete_autoscaling_policy] -- **`name` (string)**: the name of the autoscaling policy -- **`master_timeout` (Optional, string \| -1 \| 0)**: Period to wait for a connection to the master node. -If no response is received before the timeout expires, the request fails and returns an error. -- **`timeout` (Optional, string \| -1 \| 0)**: Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. - -## client.autoscaling.getAutoscalingCapacity [_autoscaling.get_autoscaling_capacity] -Get the autoscaling capacity. - -NOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported. - -This API gets the current autoscaling capacity based on the configured autoscaling policy. -It will return information to size the cluster appropriately to the current workload. - -The `required_capacity` is calculated as the maximum of the `required_capacity` result of all individual deciders that are enabled for the policy. - -The operator should verify that the `current_nodes` match the operator’s knowledge of the cluster to avoid making autoscaling decisions based on stale or incomplete information. - -The response contains decider-specific information you can use to diagnose how and why autoscaling determined a certain capacity was required. -This information is provided for diagnosis only. -Do not use this information to make autoscaling decisions. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-autoscaling-get-autoscaling-capacity) - -```ts -client.autoscaling.getAutoscalingCapacity({ ... }) -``` - -### Arguments [_arguments_autoscaling.get_autoscaling_capacity] - -#### Request (object) [_request_autoscaling.get_autoscaling_capacity] -- **`master_timeout` (Optional, string \| -1 \| 0)**: Period to wait for a connection to the master node. -If no response is received before the timeout expires, the request fails and returns an error. - -## client.autoscaling.getAutoscalingPolicy [_autoscaling.get_autoscaling_policy] -Get an autoscaling policy. - -NOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-autoscaling-get-autoscaling-capacity) - -```ts -client.autoscaling.getAutoscalingPolicy({ name }) -``` - -### Arguments [_arguments_autoscaling.get_autoscaling_policy] - -#### Request (object) [_request_autoscaling.get_autoscaling_policy] -- **`name` (string)**: the name of the autoscaling policy -- **`master_timeout` (Optional, string \| -1 \| 0)**: Period to wait for a connection to the master node. -If no response is received before the timeout expires, the request fails and returns an error. - -## client.autoscaling.putAutoscalingPolicy [_autoscaling.put_autoscaling_policy] -Create or update an autoscaling policy. - -NOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-autoscaling-put-autoscaling-policy) - -```ts -client.autoscaling.putAutoscalingPolicy({ name }) -``` - -### Arguments [_arguments_autoscaling.put_autoscaling_policy] - -#### Request (object) [_request_autoscaling.put_autoscaling_policy] -- **`name` (string)**: the name of the autoscaling policy -- **`policy` (Optional, { roles, deciders })** -- **`master_timeout` (Optional, string \| -1 \| 0)**: Period to wait for a connection to the master node. -If no response is received before the timeout expires, the request fails and returns an error. -- **`timeout` (Optional, string \| -1 \| 0)**: Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. - -## client.cat.aliases [_cat.aliases] -Get aliases. - -Get the cluster's index aliases, including filter and routing information. -This API does not return data stream aliases. - -IMPORTANT: CAT APIs are only intended for human consumption using the command line or the Kibana console. They are not intended for use by applications. For application consumption, use the aliases API. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-aliases) - -```ts -client.cat.aliases({ ... }) -``` - -### Arguments [_arguments_cat.aliases] - -#### Request (object) [_request_cat.aliases] -- **`name` (Optional, string \| string[])**: A list of aliases to retrieve. Supports wildcards (`*`). To retrieve all aliases, omit this parameter or use `*` or `_all`. -- **`h` (Optional, string \| string[])**: List of columns to appear in the response. Supports simple wildcards. -- **`s` (Optional, string \| string[])**: List of columns that determine how the table should be sorted. -Sorting defaults to ascending and can be changed by setting `:asc` -or `:desc` as a suffix to the column name. -- **`expand_wildcards` (Optional, Enum("all" \| "open" \| "closed" \| "hidden" \| "none") \| Enum("all" \| "open" \| "closed" \| "hidden" \| "none")[])**: The type of index that wildcard patterns can match. -If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. -It supports a list of values, such as `open,hidden`. -- **`master_timeout` (Optional, string \| -1 \| 0)**: The period to wait for a connection to the master node. -If the master node is not available before the timeout expires, the request fails and returns an error. -To indicated that the request should never timeout, you can set it to `-1`. - -## client.cat.allocation [_cat.allocation] -Get shard allocation information. - -Get a snapshot of the number of shards allocated to each data node and their disk space. - -IMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-allocation) - -```ts -client.cat.allocation({ ... }) -``` - -### Arguments [_arguments_cat.allocation] - -#### Request (object) [_request_cat.allocation] -- **`node_id` (Optional, string \| string[])**: A list of node identifiers or names used to limit the returned information. -- **`bytes` (Optional, Enum("b" \| "kb" \| "mb" \| "gb" \| "tb" \| "pb"))**: The unit used to display byte values. -- **`h` (Optional, string \| string[])**: List of columns to appear in the response. Supports simple wildcards. -- **`s` (Optional, string \| string[])**: List of columns that determine how the table should be sorted. -Sorting defaults to ascending and can be changed by setting `:asc` -or `:desc` as a suffix to the column name. -- **`local` (Optional, boolean)**: If `true`, the request computes the list of selected nodes from the -local cluster state. If `false` the list of selected nodes are computed -from the cluster state of the master node. In both cases the coordinating -node will send requests for further information to each selected node. -- **`master_timeout` (Optional, string \| -1 \| 0)**: Period to wait for a connection to the master node. - -## client.cat.componentTemplates [_cat.component_templates] -Get component templates. - -Get information about component templates in a cluster. -Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. - -IMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console. -They are not intended for use by applications. For application consumption, use the get component template API. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-component-templates) - -```ts -client.cat.componentTemplates({ ... }) -``` - -### Arguments [_arguments_cat.component_templates] - -#### Request (object) [_request_cat.component_templates] -- **`name` (Optional, string)**: The name of the component template. -It accepts wildcard expressions. -If it is omitted, all component templates are returned. -- **`h` (Optional, string \| string[])**: List of columns to appear in the response. Supports simple wildcards. -- **`s` (Optional, string \| string[])**: List of columns that determine how the table should be sorted. -Sorting defaults to ascending and can be changed by setting `:asc` -or `:desc` as a suffix to the column name. -- **`local` (Optional, boolean)**: If `true`, the request computes the list of selected nodes from the -local cluster state. If `false` the list of selected nodes are computed -from the cluster state of the master node. In both cases the coordinating -node will send requests for further information to each selected node. -- **`master_timeout` (Optional, string \| -1 \| 0)**: The period to wait for a connection to the master node. - -## client.cat.count [_cat.count] -Get a document count. - -Get quick access to a document count for a data stream, an index, or an entire cluster. -The document count only includes live documents, not deleted documents which have not yet been removed by the merge process. - -IMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console. -They are not intended for use by applications. For application consumption, use the count API. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-count) - -```ts -client.cat.count({ ... }) -``` - -### Arguments [_arguments_cat.count] - -#### Request (object) [_request_cat.count] -- **`index` (Optional, string \| string[])**: A list of data streams, indices, and aliases used to limit the request. -It supports wildcards (`*`). -To target all data streams and indices, omit this parameter or use `*` or `_all`. -- **`h` (Optional, string \| string[])**: List of columns to appear in the response. Supports simple wildcards. -- **`s` (Optional, string \| string[])**: List of columns that determine how the table should be sorted. -Sorting defaults to ascending and can be changed by setting `:asc` -or `:desc` as a suffix to the column name. - -## client.cat.fielddata [_cat.fielddata] -Get field data cache information. - -Get the amount of heap memory currently used by the field data cache on every data node in the cluster. - -IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. -They are not intended for use by applications. For application consumption, use the nodes stats API. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-fielddata) - -```ts -client.cat.fielddata({ ... }) -``` - -### Arguments [_arguments_cat.fielddata] - -#### Request (object) [_request_cat.fielddata] -- **`fields` (Optional, string \| string[])**: List of fields used to limit returned information. -To retrieve all fields, omit this parameter. -- **`bytes` (Optional, Enum("b" \| "kb" \| "mb" \| "gb" \| "tb" \| "pb"))**: The unit used to display byte values. -- **`h` (Optional, string \| string[])**: List of columns to appear in the response. Supports simple wildcards. -- **`s` (Optional, string \| string[])**: List of columns that determine how the table should be sorted. -Sorting defaults to ascending and can be changed by setting `:asc` -or `:desc` as a suffix to the column name. - -## client.cat.health [_cat.health] -Get the cluster health status. - -IMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console. -They are not intended for use by applications. For application consumption, use the cluster health API. -This API is often used to check malfunctioning clusters. -To help you track cluster health alongside log files and alerting systems, the API returns timestamps in two formats: -`HH:MM:SS`, which is human-readable but includes no date information; -`Unix epoch time`, which is machine-sortable and includes date information. -The latter format is useful for cluster recoveries that take multiple days. -You can use the cat health API to verify cluster health across multiple nodes. -You also can use the API to track the recovery of a large cluster over a longer period of time. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-health) - -```ts -client.cat.health({ ... }) -``` - -### Arguments [_arguments_cat.health] - -#### Request (object) [_request_cat.health] -- **`time` (Optional, Enum("nanos" \| "micros" \| "ms" \| "s" \| "m" \| "h" \| "d"))**: The unit used to display time values. -- **`ts` (Optional, boolean)**: If true, returns `HH:MM:SS` and Unix epoch timestamps. -- **`h` (Optional, string \| string[])**: List of columns to appear in the response. Supports simple wildcards. -- **`s` (Optional, string \| string[])**: List of columns that determine how the table should be sorted. -Sorting defaults to ascending and can be changed by setting `:asc` -or `:desc` as a suffix to the column name. - -## client.cat.help [_cat.help] -Get CAT help. - -Get help for the CAT APIs. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-cat) - -```ts -client.cat.help() -``` - - -## client.cat.indices [_cat.indices] -Get index information. - -Get high-level information about indices in a cluster, including backing indices for data streams. - -Use this request to get the following information for each index in a cluster: -- shard count -- document count -- deleted document count -- primary store size -- total store size of all shards, including shard replicas - -These metrics are retrieved directly from Lucene, which Elasticsearch uses internally to power indexing and search. As a result, all document counts include hidden nested documents. -To get an accurate count of Elasticsearch documents, use the cat count or count APIs. - -CAT APIs are only intended for human consumption using the command line or Kibana console. -They are not intended for use by applications. For application consumption, use an index endpoint. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-indices) - -```ts -client.cat.indices({ ... }) -``` - -### Arguments [_arguments_cat.indices] - -#### Request (object) [_request_cat.indices] -- **`index` (Optional, string \| string[])**: List of data streams, indices, and aliases used to limit the request. -Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. -- **`bytes` (Optional, Enum("b" \| "kb" \| "mb" \| "gb" \| "tb" \| "pb"))**: The unit used to display byte values. -- **`expand_wildcards` (Optional, Enum("all" \| "open" \| "closed" \| "hidden" \| "none") \| Enum("all" \| "open" \| "closed" \| "hidden" \| "none")[])**: The type of index that wildcard patterns can match. -- **`health` (Optional, Enum("green" \| "yellow" \| "red"))**: The health status used to limit returned indices. By default, the response includes indices of any health status. -- **`include_unloaded_segments` (Optional, boolean)**: If true, the response includes information from segments that are not loaded into memory. -- **`pri` (Optional, boolean)**: If true, the response only includes information from primary shards. -- **`time` (Optional, Enum("nanos" \| "micros" \| "ms" \| "s" \| "m" \| "h" \| "d"))**: The unit used to display time values. -- **`master_timeout` (Optional, string \| -1 \| 0)**: Period to wait for a connection to the master node. -- **`h` (Optional, string \| string[])**: List of columns to appear in the response. Supports simple wildcards. -- **`s` (Optional, string \| string[])**: List of columns that determine how the table should be sorted. -Sorting defaults to ascending and can be changed by setting `:asc` -or `:desc` as a suffix to the column name. - -## client.cat.master [_cat.master] -Get master node information. - -Get information about the master node, including the ID, bound IP address, and name. - -IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-master) - -```ts -client.cat.master({ ... }) -``` - -### Arguments [_arguments_cat.master] - -#### Request (object) [_request_cat.master] -- **`h` (Optional, string \| string[])**: List of columns to appear in the response. Supports simple wildcards. -- **`s` (Optional, string \| string[])**: List of columns that determine how the table should be sorted. -Sorting defaults to ascending and can be changed by setting `:asc` -or `:desc` as a suffix to the column name. -- **`local` (Optional, boolean)**: If `true`, the request computes the list of selected nodes from the -local cluster state. If `false` the list of selected nodes are computed -from the cluster state of the master node. In both cases the coordinating -node will send requests for further information to each selected node. -- **`master_timeout` (Optional, string \| -1 \| 0)**: Period to wait for a connection to the master node. - -## client.cat.mlDataFrameAnalytics [_cat.ml_data_frame_analytics] -Get data frame analytics jobs. - -Get configuration and usage information about data frame analytics jobs. - -IMPORTANT: CAT APIs are only intended for human consumption using the Kibana -console or command line. They are not intended for use by applications. For -application consumption, use the get data frame analytics jobs statistics API. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-ml-data-frame-analytics) - -```ts -client.cat.mlDataFrameAnalytics({ ... }) -``` - -### Arguments [_arguments_cat.ml_data_frame_analytics] - -#### Request (object) [_request_cat.ml_data_frame_analytics] -- **`id` (Optional, string)**: The ID of the data frame analytics to fetch -- **`allow_no_match` (Optional, boolean)**: Whether to ignore if a wildcard expression matches no configs. (This includes `_all` string or when no configs have been specified) -- **`bytes` (Optional, Enum("b" \| "kb" \| "mb" \| "gb" \| "tb" \| "pb"))**: The unit in which to display byte values -- **`h` (Optional, Enum("assignment_explanation" \| "create_time" \| "description" \| "dest_index" \| "failure_reason" \| "id" \| "model_memory_limit" \| "node.address" \| "node.ephemeral_id" \| "node.id" \| "node.name" \| "progress" \| "source_index" \| "state" \| "type" \| "version") \| Enum("assignment_explanation" \| "create_time" \| "description" \| "dest_index" \| "failure_reason" \| "id" \| "model_memory_limit" \| "node.address" \| "node.ephemeral_id" \| "node.id" \| "node.name" \| "progress" \| "source_index" \| "state" \| "type" \| "version")[])**: List of column names to display. -- **`s` (Optional, Enum("assignment_explanation" \| "create_time" \| "description" \| "dest_index" \| "failure_reason" \| "id" \| "model_memory_limit" \| "node.address" \| "node.ephemeral_id" \| "node.id" \| "node.name" \| "progress" \| "source_index" \| "state" \| "type" \| "version") \| Enum("assignment_explanation" \| "create_time" \| "description" \| "dest_index" \| "failure_reason" \| "id" \| "model_memory_limit" \| "node.address" \| "node.ephemeral_id" \| "node.id" \| "node.name" \| "progress" \| "source_index" \| "state" \| "type" \| "version")[])**: List of column names or column aliases used to sort the -response. -- **`time` (Optional, Enum("nanos" \| "micros" \| "ms" \| "s" \| "m" \| "h" \| "d"))**: Unit used to display time values. - -## client.cat.mlDatafeeds [_cat.ml_datafeeds] -Get datafeeds. - -Get configuration and usage information about datafeeds. -This API returns a maximum of 10,000 datafeeds. -If the Elasticsearch security features are enabled, you must have `monitor_ml`, `monitor`, `manage_ml`, or `manage` -cluster privileges to use this API. - -IMPORTANT: CAT APIs are only intended for human consumption using the Kibana -console or command line. They are not intended for use by applications. For -application consumption, use the get datafeed statistics API. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-ml-datafeeds) - -```ts -client.cat.mlDatafeeds({ ... }) -``` - -### Arguments [_arguments_cat.ml_datafeeds] - -#### Request (object) [_request_cat.ml_datafeeds] -- **`datafeed_id` (Optional, string)**: A numerical character string that uniquely identifies the datafeed. -- **`allow_no_match` (Optional, boolean)**: Specifies what to do when the request: - -* Contains wildcard expressions and there are no datafeeds that match. -* Contains the `_all` string or no identifiers and there are no matches. -* Contains wildcard expressions and there are only partial matches. - -If `true`, the API returns an empty datafeeds array when there are no matches and the subset of results when -there are partial matches. If `false`, the API returns a 404 status code when there are no matches or only -partial matches. -- **`h` (Optional, Enum("ae" \| "bc" \| "id" \| "na" \| "ne" \| "ni" \| "nn" \| "sba" \| "sc" \| "seah" \| "st" \| "s") \| Enum("ae" \| "bc" \| "id" \| "na" \| "ne" \| "ni" \| "nn" \| "sba" \| "sc" \| "seah" \| "st" \| "s")[])**: List of column names to display. -- **`s` (Optional, Enum("ae" \| "bc" \| "id" \| "na" \| "ne" \| "ni" \| "nn" \| "sba" \| "sc" \| "seah" \| "st" \| "s") \| Enum("ae" \| "bc" \| "id" \| "na" \| "ne" \| "ni" \| "nn" \| "sba" \| "sc" \| "seah" \| "st" \| "s")[])**: List of column names or column aliases used to sort the response. -- **`time` (Optional, Enum("nanos" \| "micros" \| "ms" \| "s" \| "m" \| "h" \| "d"))**: The unit used to display time values. - -## client.cat.mlJobs [_cat.ml_jobs] -Get anomaly detection jobs. - -Get configuration and usage information for anomaly detection jobs. -This API returns a maximum of 10,000 jobs. -If the Elasticsearch security features are enabled, you must have `monitor_ml`, -`monitor`, `manage_ml`, or `manage` cluster privileges to use this API. - -IMPORTANT: CAT APIs are only intended for human consumption using the Kibana -console or command line. They are not intended for use by applications. For -application consumption, use the get anomaly detection job statistics API. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-ml-jobs) - -```ts -client.cat.mlJobs({ ... }) -``` - -### Arguments [_arguments_cat.ml_jobs] - -#### Request (object) [_request_cat.ml_jobs] -- **`job_id` (Optional, string)**: Identifier for the anomaly detection job. -- **`allow_no_match` (Optional, boolean)**: Specifies what to do when the request: - -* Contains wildcard expressions and there are no jobs that match. -* Contains the `_all` string or no identifiers and there are no matches. -* Contains wildcard expressions and there are only partial matches. - -If `true`, the API returns an empty jobs array when there are no matches and the subset of results when there -are partial matches. If `false`, the API returns a 404 status code when there are no matches or only partial -matches. -- **`bytes` (Optional, Enum("b" \| "kb" \| "mb" \| "gb" \| "tb" \| "pb"))**: The unit used to display byte values. -- **`h` (Optional, Enum("assignment_explanation" \| "buckets.count" \| "buckets.time.exp_avg" \| "buckets.time.exp_avg_hour" \| "buckets.time.max" \| "buckets.time.min" \| "buckets.time.total" \| "data.buckets" \| "data.earliest_record" \| "data.empty_buckets" \| "data.input_bytes" \| "data.input_fields" \| "data.input_records" \| "data.invalid_dates" \| "data.last" \| "data.last_empty_bucket" \| "data.last_sparse_bucket" \| "data.latest_record" \| "data.missing_fields" \| "data.out_of_order_timestamps" \| "data.processed_fields" \| "data.processed_records" \| "data.sparse_buckets" \| "forecasts.memory.avg" \| "forecasts.memory.max" \| "forecasts.memory.min" \| "forecasts.memory.total" \| "forecasts.records.avg" \| "forecasts.records.max" \| "forecasts.records.min" \| "forecasts.records.total" \| "forecasts.time.avg" \| "forecasts.time.max" \| "forecasts.time.min" \| "forecasts.time.total" \| "forecasts.total" \| "id" \| "model.bucket_allocation_failures" \| "model.by_fields" \| "model.bytes" \| "model.bytes_exceeded" \| "model.categorization_status" \| "model.categorized_doc_count" \| "model.dead_category_count" \| "model.failed_category_count" \| "model.frequent_category_count" \| "model.log_time" \| "model.memory_limit" \| "model.memory_status" \| "model.over_fields" \| "model.partition_fields" \| "model.rare_category_count" \| "model.timestamp" \| "model.total_category_count" \| "node.address" \| "node.ephemeral_id" \| "node.id" \| "node.name" \| "opened_time" \| "state") \| Enum("assignment_explanation" \| "buckets.count" \| "buckets.time.exp_avg" \| "buckets.time.exp_avg_hour" \| "buckets.time.max" \| "buckets.time.min" \| "buckets.time.total" \| "data.buckets" \| "data.earliest_record" \| "data.empty_buckets" \| "data.input_bytes" \| "data.input_fields" \| "data.input_records" \| "data.invalid_dates" \| "data.last" \| "data.last_empty_bucket" \| "data.last_sparse_bucket" \| "data.latest_record" \| "data.missing_fields" \| "data.out_of_order_timestamps" \| "data.processed_fields" \| "data.processed_records" \| "data.sparse_buckets" \| "forecasts.memory.avg" \| "forecasts.memory.max" \| "forecasts.memory.min" \| "forecasts.memory.total" \| "forecasts.records.avg" \| "forecasts.records.max" \| "forecasts.records.min" \| "forecasts.records.total" \| "forecasts.time.avg" \| "forecasts.time.max" \| "forecasts.time.min" \| "forecasts.time.total" \| "forecasts.total" \| "id" \| "model.bucket_allocation_failures" \| "model.by_fields" \| "model.bytes" \| "model.bytes_exceeded" \| "model.categorization_status" \| "model.categorized_doc_count" \| "model.dead_category_count" \| "model.failed_category_count" \| "model.frequent_category_count" \| "model.log_time" \| "model.memory_limit" \| "model.memory_status" \| "model.over_fields" \| "model.partition_fields" \| "model.rare_category_count" \| "model.timestamp" \| "model.total_category_count" \| "node.address" \| "node.ephemeral_id" \| "node.id" \| "node.name" \| "opened_time" \| "state")[])**: List of column names to display. -- **`s` (Optional, Enum("assignment_explanation" \| "buckets.count" \| "buckets.time.exp_avg" \| "buckets.time.exp_avg_hour" \| "buckets.time.max" \| "buckets.time.min" \| "buckets.time.total" \| "data.buckets" \| "data.earliest_record" \| "data.empty_buckets" \| "data.input_bytes" \| "data.input_fields" \| "data.input_records" \| "data.invalid_dates" \| "data.last" \| "data.last_empty_bucket" \| "data.last_sparse_bucket" \| "data.latest_record" \| "data.missing_fields" \| "data.out_of_order_timestamps" \| "data.processed_fields" \| "data.processed_records" \| "data.sparse_buckets" \| "forecasts.memory.avg" \| "forecasts.memory.max" \| "forecasts.memory.min" \| "forecasts.memory.total" \| "forecasts.records.avg" \| "forecasts.records.max" \| "forecasts.records.min" \| "forecasts.records.total" \| "forecasts.time.avg" \| "forecasts.time.max" \| "forecasts.time.min" \| "forecasts.time.total" \| "forecasts.total" \| "id" \| "model.bucket_allocation_failures" \| "model.by_fields" \| "model.bytes" \| "model.bytes_exceeded" \| "model.categorization_status" \| "model.categorized_doc_count" \| "model.dead_category_count" \| "model.failed_category_count" \| "model.frequent_category_count" \| "model.log_time" \| "model.memory_limit" \| "model.memory_status" \| "model.over_fields" \| "model.partition_fields" \| "model.rare_category_count" \| "model.timestamp" \| "model.total_category_count" \| "node.address" \| "node.ephemeral_id" \| "node.id" \| "node.name" \| "opened_time" \| "state") \| Enum("assignment_explanation" \| "buckets.count" \| "buckets.time.exp_avg" \| "buckets.time.exp_avg_hour" \| "buckets.time.max" \| "buckets.time.min" \| "buckets.time.total" \| "data.buckets" \| "data.earliest_record" \| "data.empty_buckets" \| "data.input_bytes" \| "data.input_fields" \| "data.input_records" \| "data.invalid_dates" \| "data.last" \| "data.last_empty_bucket" \| "data.last_sparse_bucket" \| "data.latest_record" \| "data.missing_fields" \| "data.out_of_order_timestamps" \| "data.processed_fields" \| "data.processed_records" \| "data.sparse_buckets" \| "forecasts.memory.avg" \| "forecasts.memory.max" \| "forecasts.memory.min" \| "forecasts.memory.total" \| "forecasts.records.avg" \| "forecasts.records.max" \| "forecasts.records.min" \| "forecasts.records.total" \| "forecasts.time.avg" \| "forecasts.time.max" \| "forecasts.time.min" \| "forecasts.time.total" \| "forecasts.total" \| "id" \| "model.bucket_allocation_failures" \| "model.by_fields" \| "model.bytes" \| "model.bytes_exceeded" \| "model.categorization_status" \| "model.categorized_doc_count" \| "model.dead_category_count" \| "model.failed_category_count" \| "model.frequent_category_count" \| "model.log_time" \| "model.memory_limit" \| "model.memory_status" \| "model.over_fields" \| "model.partition_fields" \| "model.rare_category_count" \| "model.timestamp" \| "model.total_category_count" \| "node.address" \| "node.ephemeral_id" \| "node.id" \| "node.name" \| "opened_time" \| "state")[])**: List of column names or column aliases used to sort the response. -- **`time` (Optional, Enum("nanos" \| "micros" \| "ms" \| "s" \| "m" \| "h" \| "d"))**: The unit used to display time values. - -## client.cat.mlTrainedModels [_cat.ml_trained_models] -Get trained models. - -Get configuration and usage information about inference trained models. - -IMPORTANT: CAT APIs are only intended for human consumption using the Kibana -console or command line. They are not intended for use by applications. For -application consumption, use the get trained models statistics API. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-ml-trained-models) - -```ts -client.cat.mlTrainedModels({ ... }) -``` - -### Arguments [_arguments_cat.ml_trained_models] - -#### Request (object) [_request_cat.ml_trained_models] -- **`model_id` (Optional, string)**: A unique identifier for the trained model. -- **`allow_no_match` (Optional, boolean)**: Specifies what to do when the request: contains wildcard expressions and there are no models that match; contains the `_all` string or no identifiers and there are no matches; contains wildcard expressions and there are only partial matches. -If `true`, the API returns an empty array when there are no matches and the subset of results when there are partial matches. -If `false`, the API returns a 404 status code when there are no matches or only partial matches. -- **`bytes` (Optional, Enum("b" \| "kb" \| "mb" \| "gb" \| "tb" \| "pb"))**: The unit used to display byte values. -- **`h` (Optional, Enum("create_time" \| "created_by" \| "data_frame_analytics_id" \| "description" \| "heap_size" \| "id" \| "ingest.count" \| "ingest.current" \| "ingest.failed" \| "ingest.pipelines" \| "ingest.time" \| "license" \| "operations" \| "version") \| Enum("create_time" \| "created_by" \| "data_frame_analytics_id" \| "description" \| "heap_size" \| "id" \| "ingest.count" \| "ingest.current" \| "ingest.failed" \| "ingest.pipelines" \| "ingest.time" \| "license" \| "operations" \| "version")[])**: A list of column names to display. -- **`s` (Optional, Enum("create_time" \| "created_by" \| "data_frame_analytics_id" \| "description" \| "heap_size" \| "id" \| "ingest.count" \| "ingest.current" \| "ingest.failed" \| "ingest.pipelines" \| "ingest.time" \| "license" \| "operations" \| "version") \| Enum("create_time" \| "created_by" \| "data_frame_analytics_id" \| "description" \| "heap_size" \| "id" \| "ingest.count" \| "ingest.current" \| "ingest.failed" \| "ingest.pipelines" \| "ingest.time" \| "license" \| "operations" \| "version")[])**: A list of column names or aliases used to sort the response. -- **`from` (Optional, number)**: Skips the specified number of transforms. -- **`size` (Optional, number)**: The maximum number of transforms to display. -- **`time` (Optional, Enum("nanos" \| "micros" \| "ms" \| "s" \| "m" \| "h" \| "d"))**: Unit used to display time values. - -## client.cat.nodeattrs [_cat.nodeattrs] -Get node attribute information. - -Get information about custom node attributes. -IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-nodeattrs) - -```ts -client.cat.nodeattrs({ ... }) -``` - -### Arguments [_arguments_cat.nodeattrs] - -#### Request (object) [_request_cat.nodeattrs] -- **`h` (Optional, string \| string[])**: List of columns to appear in the response. Supports simple wildcards. -- **`s` (Optional, string \| string[])**: List of columns that determine how the table should be sorted. -Sorting defaults to ascending and can be changed by setting `:asc` -or `:desc` as a suffix to the column name. -- **`local` (Optional, boolean)**: If `true`, the request computes the list of selected nodes from the -local cluster state. If `false` the list of selected nodes are computed -from the cluster state of the master node. In both cases the coordinating -node will send requests for further information to each selected node. -- **`master_timeout` (Optional, string \| -1 \| 0)**: Period to wait for a connection to the master node. - -## client.cat.nodes [_cat.nodes] -Get node information. - -Get information about the nodes in a cluster. -IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-nodes) - -```ts -client.cat.nodes({ ... }) -``` - -### Arguments [_arguments_cat.nodes] - -#### Request (object) [_request_cat.nodes] -- **`bytes` (Optional, Enum("b" \| "kb" \| "mb" \| "gb" \| "tb" \| "pb"))**: The unit used to display byte values. -- **`full_id` (Optional, boolean \| string)**: If `true`, return the full node ID. If `false`, return the shortened node ID. -- **`include_unloaded_segments` (Optional, boolean)**: If true, the response includes information from segments that are not loaded into memory. -- **`h` (Optional, Enum("build" \| "completion.size" \| "cpu" \| "disk.avail" \| "disk.total" \| "disk.used" \| "disk.used_percent" \| "fielddata.evictions" \| "fielddata.memory_size" \| "file_desc.current" \| "file_desc.max" \| "file_desc.percent" \| "flush.total" \| "flush.total_time" \| "get.current" \| "get.exists_time" \| "get.exists_total" \| "get.missing_time" \| "get.missing_total" \| "get.time" \| "get.total" \| "heap.current" \| "heap.max" \| "heap.percent" \| "http_address" \| "id" \| "indexing.delete_current" \| "indexing.delete_time" \| "indexing.delete_total" \| "indexing.index_current" \| "indexing.index_failed" \| "indexing.index_failed_due_to_version_conflict" \| "indexing.index_time" \| "indexing.index_total" \| "ip" \| "jdk" \| "load_1m" \| "load_5m" \| "load_15m" \| "mappings.total_count" \| "mappings.total_estimated_overhead_in_bytes" \| "master" \| "merges.current" \| "merges.current_docs" \| "merges.current_size" \| "merges.total" \| "merges.total_docs" \| "merges.total_size" \| "merges.total_time" \| "name" \| "node.role" \| "pid" \| "port" \| "query_cache.memory_size" \| "query_cache.evictions" \| "query_cache.hit_count" \| "query_cache.miss_count" \| "ram.current" \| "ram.max" \| "ram.percent" \| "refresh.total" \| "refresh.time" \| "request_cache.memory_size" \| "request_cache.evictions" \| "request_cache.hit_count" \| "request_cache.miss_count" \| "script.compilations" \| "script.cache_evictions" \| "search.fetch_current" \| "search.fetch_time" \| "search.fetch_total" \| "search.open_contexts" \| "search.query_current" \| "search.query_time" \| "search.query_total" \| "search.scroll_current" \| "search.scroll_time" \| "search.scroll_total" \| "segments.count" \| "segments.fixed_bitset_memory" \| "segments.index_writer_memory" \| "segments.memory" \| "segments.version_map_memory" \| "shard_stats.total_count" \| "suggest.current" \| "suggest.time" \| "suggest.total" \| "uptime" \| "version") \| Enum("build" \| "completion.size" \| "cpu" \| "disk.avail" \| "disk.total" \| "disk.used" \| "disk.used_percent" \| "fielddata.evictions" \| "fielddata.memory_size" \| "file_desc.current" \| "file_desc.max" \| "file_desc.percent" \| "flush.total" \| "flush.total_time" \| "get.current" \| "get.exists_time" \| "get.exists_total" \| "get.missing_time" \| "get.missing_total" \| "get.time" \| "get.total" \| "heap.current" \| "heap.max" \| "heap.percent" \| "http_address" \| "id" \| "indexing.delete_current" \| "indexing.delete_time" \| "indexing.delete_total" \| "indexing.index_current" \| "indexing.index_failed" \| "indexing.index_failed_due_to_version_conflict" \| "indexing.index_time" \| "indexing.index_total" \| "ip" \| "jdk" \| "load_1m" \| "load_5m" \| "load_15m" \| "mappings.total_count" \| "mappings.total_estimated_overhead_in_bytes" \| "master" \| "merges.current" \| "merges.current_docs" \| "merges.current_size" \| "merges.total" \| "merges.total_docs" \| "merges.total_size" \| "merges.total_time" \| "name" \| "node.role" \| "pid" \| "port" \| "query_cache.memory_size" \| "query_cache.evictions" \| "query_cache.hit_count" \| "query_cache.miss_count" \| "ram.current" \| "ram.max" \| "ram.percent" \| "refresh.total" \| "refresh.time" \| "request_cache.memory_size" \| "request_cache.evictions" \| "request_cache.hit_count" \| "request_cache.miss_count" \| "script.compilations" \| "script.cache_evictions" \| "search.fetch_current" \| "search.fetch_time" \| "search.fetch_total" \| "search.open_contexts" \| "search.query_current" \| "search.query_time" \| "search.query_total" \| "search.scroll_current" \| "search.scroll_time" \| "search.scroll_total" \| "segments.count" \| "segments.fixed_bitset_memory" \| "segments.index_writer_memory" \| "segments.memory" \| "segments.version_map_memory" \| "shard_stats.total_count" \| "suggest.current" \| "suggest.time" \| "suggest.total" \| "uptime" \| "version")[])**: A list of columns names to display. -It supports simple wildcards. -- **`s` (Optional, string \| string[])**: A list of column names or aliases that determines the sort order. -Sorting defaults to ascending and can be changed by setting `:asc` -or `:desc` as a suffix to the column name. -- **`master_timeout` (Optional, string \| -1 \| 0)**: The period to wait for a connection to the master node. -- **`time` (Optional, Enum("nanos" \| "micros" \| "ms" \| "s" \| "m" \| "h" \| "d"))**: The unit used to display time values. - -## client.cat.pendingTasks [_cat.pending_tasks] -Get pending task information. - -Get information about cluster-level changes that have not yet taken effect. -IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the pending cluster tasks API. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-pending-tasks) - -```ts -client.cat.pendingTasks({ ... }) -``` - -### Arguments [_arguments_cat.pending_tasks] - -#### Request (object) [_request_cat.pending_tasks] -- **`h` (Optional, string \| string[])**: List of columns to appear in the response. Supports simple wildcards. -- **`s` (Optional, string \| string[])**: List of columns that determine how the table should be sorted. -Sorting defaults to ascending and can be changed by setting `:asc` -or `:desc` as a suffix to the column name. -- **`local` (Optional, boolean)**: If `true`, the request computes the list of selected nodes from the -local cluster state. If `false` the list of selected nodes are computed -from the cluster state of the master node. In both cases the coordinating -node will send requests for further information to each selected node. -- **`master_timeout` (Optional, string \| -1 \| 0)**: Period to wait for a connection to the master node. -- **`time` (Optional, Enum("nanos" \| "micros" \| "ms" \| "s" \| "m" \| "h" \| "d"))**: Unit used to display time values. - -## client.cat.plugins [_cat.plugins] -Get plugin information. - -Get a list of plugins running on each node of a cluster. -IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-plugins) - -```ts -client.cat.plugins({ ... }) -``` - -### Arguments [_arguments_cat.plugins] - -#### Request (object) [_request_cat.plugins] -- **`h` (Optional, string \| string[])**: List of columns to appear in the response. Supports simple wildcards. -- **`s` (Optional, string \| string[])**: List of columns that determine how the table should be sorted. -Sorting defaults to ascending and can be changed by setting `:asc` -or `:desc` as a suffix to the column name. -- **`include_bootstrap` (Optional, boolean)**: Include bootstrap plugins in the response -- **`local` (Optional, boolean)**: If `true`, the request computes the list of selected nodes from the -local cluster state. If `false` the list of selected nodes are computed -from the cluster state of the master node. In both cases the coordinating -node will send requests for further information to each selected node. -- **`master_timeout` (Optional, string \| -1 \| 0)**: Period to wait for a connection to the master node. - -## client.cat.recovery [_cat.recovery] -Get shard recovery information. - -Get information about ongoing and completed shard recoveries. -Shard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or syncing a replica shard from a primary shard. When a shard recovery completes, the recovered shard is available for search and indexing. -For data streams, the API returns information about the stream’s backing indices. -IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the index recovery API. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-recovery) - -```ts -client.cat.recovery({ ... }) -``` - -### Arguments [_arguments_cat.recovery] - -#### Request (object) [_request_cat.recovery] -- **`index` (Optional, string \| string[])**: A list of data streams, indices, and aliases used to limit the request. -Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. -- **`active_only` (Optional, boolean)**: If `true`, the response only includes ongoing shard recoveries. -- **`bytes` (Optional, Enum("b" \| "kb" \| "mb" \| "gb" \| "tb" \| "pb"))**: The unit used to display byte values. -- **`detailed` (Optional, boolean)**: If `true`, the response includes detailed information about shard recoveries. -- **`h` (Optional, string \| string[])**: List of columns to appear in the response. Supports simple wildcards. -- **`s` (Optional, string \| string[])**: List of columns that determine how the table should be sorted. -Sorting defaults to ascending and can be changed by setting `:asc` -or `:desc` as a suffix to the column name. -- **`time` (Optional, Enum("nanos" \| "micros" \| "ms" \| "s" \| "m" \| "h" \| "d"))**: Unit used to display time values. - -## client.cat.repositories [_cat.repositories] -Get snapshot repository information. - -Get a list of snapshot repositories for a cluster. -IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get snapshot repository API. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-repositories) - -```ts -client.cat.repositories({ ... }) -``` - -### Arguments [_arguments_cat.repositories] - -#### Request (object) [_request_cat.repositories] -- **`h` (Optional, string \| string[])**: List of columns to appear in the response. Supports simple wildcards. -- **`s` (Optional, string \| string[])**: List of columns that determine how the table should be sorted. -Sorting defaults to ascending and can be changed by setting `:asc` -or `:desc` as a suffix to the column name. -- **`local` (Optional, boolean)**: If `true`, the request computes the list of selected nodes from the -local cluster state. If `false` the list of selected nodes are computed -from the cluster state of the master node. In both cases the coordinating -node will send requests for further information to each selected node. -- **`master_timeout` (Optional, string \| -1 \| 0)**: Period to wait for a connection to the master node. - -## client.cat.segments [_cat.segments] -Get segment information. - -Get low-level information about the Lucene segments in index shards. -For data streams, the API returns information about the backing indices. -IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the index segments API. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-segments) - -```ts -client.cat.segments({ ... }) -``` - -### Arguments [_arguments_cat.segments] - -#### Request (object) [_request_cat.segments] -- **`index` (Optional, string \| string[])**: A list of data streams, indices, and aliases used to limit the request. -Supports wildcards (`*`). -To target all data streams and indices, omit this parameter or use `*` or `_all`. -- **`bytes` (Optional, Enum("b" \| "kb" \| "mb" \| "gb" \| "tb" \| "pb"))**: The unit used to display byte values. -- **`h` (Optional, string \| string[])**: List of columns to appear in the response. Supports simple wildcards. -- **`s` (Optional, string \| string[])**: List of columns that determine how the table should be sorted. -Sorting defaults to ascending and can be changed by setting `:asc` -or `:desc` as a suffix to the column name. -- **`local` (Optional, boolean)**: If `true`, the request computes the list of selected nodes from the -local cluster state. If `false` the list of selected nodes are computed -from the cluster state of the master node. In both cases the coordinating -node will send requests for further information to each selected node. -- **`master_timeout` (Optional, string \| -1 \| 0)**: Period to wait for a connection to the master node. - -## client.cat.shards [_cat.shards] -Get shard information. - -Get information about the shards in a cluster. -For data streams, the API returns information about the backing indices. -IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-shards) - -```ts -client.cat.shards({ ... }) -``` - -### Arguments [_arguments_cat.shards] - -#### Request (object) [_request_cat.shards] -- **`index` (Optional, string \| string[])**: A list of data streams, indices, and aliases used to limit the request. -Supports wildcards (`*`). -To target all data streams and indices, omit this parameter or use `*` or `_all`. -- **`bytes` (Optional, Enum("b" \| "kb" \| "mb" \| "gb" \| "tb" \| "pb"))**: The unit used to display byte values. -- **`h` (Optional, string \| string[])**: List of columns to appear in the response. Supports simple wildcards. -- **`s` (Optional, string \| string[])**: List of columns that determine how the table should be sorted. -Sorting defaults to ascending and can be changed by setting `:asc` -or `:desc` as a suffix to the column name. -- **`master_timeout` (Optional, string \| -1 \| 0)**: Period to wait for a connection to the master node. -- **`time` (Optional, Enum("nanos" \| "micros" \| "ms" \| "s" \| "m" \| "h" \| "d"))**: Unit used to display time values. - -## client.cat.snapshots [_cat.snapshots] -Get snapshot information. - -Get information about the snapshots stored in one or more repositories. -A snapshot is a backup of an index or running Elasticsearch cluster. -IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get snapshot API. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-snapshots) - -```ts -client.cat.snapshots({ ... }) -``` - -### Arguments [_arguments_cat.snapshots] - -#### Request (object) [_request_cat.snapshots] -- **`repository` (Optional, string \| string[])**: A list of snapshot repositories used to limit the request. -Accepts wildcard expressions. -`_all` returns all repositories. -If any repository fails during the request, Elasticsearch returns an error. -- **`ignore_unavailable` (Optional, boolean)**: If `true`, the response does not include information from unavailable snapshots. -- **`h` (Optional, string \| string[])**: List of columns to appear in the response. Supports simple wildcards. -- **`s` (Optional, string \| string[])**: List of columns that determine how the table should be sorted. -Sorting defaults to ascending and can be changed by setting `:asc` -or `:desc` as a suffix to the column name. -- **`master_timeout` (Optional, string \| -1 \| 0)**: Period to wait for a connection to the master node. -- **`time` (Optional, Enum("nanos" \| "micros" \| "ms" \| "s" \| "m" \| "h" \| "d"))**: Unit used to display time values. - -## client.cat.tasks [_cat.tasks] -Get task information. - -Get information about tasks currently running in the cluster. -IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the task management API. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-tasks) - -```ts -client.cat.tasks({ ... }) -``` - -### Arguments [_arguments_cat.tasks] - -#### Request (object) [_request_cat.tasks] -- **`actions` (Optional, string[])**: The task action names, which are used to limit the response. -- **`detailed` (Optional, boolean)**: If `true`, the response includes detailed information about shard recoveries. -- **`nodes` (Optional, string[])**: Unique node identifiers, which are used to limit the response. -- **`parent_task_id` (Optional, string)**: The parent task identifier, which is used to limit the response. -- **`h` (Optional, string \| string[])**: List of columns to appear in the response. Supports simple wildcards. -- **`s` (Optional, string \| string[])**: List of columns that determine how the table should be sorted. -Sorting defaults to ascending and can be changed by setting `:asc` -or `:desc` as a suffix to the column name. -- **`time` (Optional, Enum("nanos" \| "micros" \| "ms" \| "s" \| "m" \| "h" \| "d"))**: Unit used to display time values. -- **`timeout` (Optional, string \| -1 \| 0)**: Period to wait for a response. -If no response is received before the timeout expires, the request fails and returns an error. -- **`wait_for_completion` (Optional, boolean)**: If `true`, the request blocks until the task has completed. - -## client.cat.templates [_cat.templates] -Get index template information. - -Get information about the index templates in a cluster. -You can use index templates to apply index settings and field mappings to new indices at creation. -IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get index template API. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-templates) - -```ts -client.cat.templates({ ... }) -``` - -### Arguments [_arguments_cat.templates] - -#### Request (object) [_request_cat.templates] -- **`name` (Optional, string)**: The name of the template to return. -Accepts wildcard expressions. If omitted, all templates are returned. -- **`h` (Optional, string \| string[])**: List of columns to appear in the response. Supports simple wildcards. -- **`s` (Optional, string \| string[])**: List of columns that determine how the table should be sorted. -Sorting defaults to ascending and can be changed by setting `:asc` -or `:desc` as a suffix to the column name. -- **`local` (Optional, boolean)**: If `true`, the request computes the list of selected nodes from the -local cluster state. If `false` the list of selected nodes are computed -from the cluster state of the master node. In both cases the coordinating -node will send requests for further information to each selected node. -- **`master_timeout` (Optional, string \| -1 \| 0)**: Period to wait for a connection to the master node. - -## client.cat.threadPool [_cat.thread_pool] -Get thread pool statistics. - -Get thread pool statistics for each node in a cluster. -Returned information includes all built-in thread pools and custom thread pools. -IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-thread-pool) - -```ts -client.cat.threadPool({ ... }) -``` - -### Arguments [_arguments_cat.thread_pool] - -#### Request (object) [_request_cat.thread_pool] -- **`thread_pool_patterns` (Optional, string \| string[])**: A list of thread pool names used to limit the request. -Accepts wildcard expressions. -- **`h` (Optional, string \| string[])**: List of columns to appear in the response. Supports simple wildcards. -- **`s` (Optional, string \| string[])**: List of columns that determine how the table should be sorted. -Sorting defaults to ascending and can be changed by setting `:asc` -or `:desc` as a suffix to the column name. -- **`time` (Optional, Enum("nanos" \| "micros" \| "ms" \| "s" \| "m" \| "h" \| "d"))**: The unit used to display time values. -- **`local` (Optional, boolean)**: If `true`, the request computes the list of selected nodes from the -local cluster state. If `false` the list of selected nodes are computed -from the cluster state of the master node. In both cases the coordinating -node will send requests for further information to each selected node. -- **`master_timeout` (Optional, string \| -1 \| 0)**: Period to wait for a connection to the master node. - -## client.cat.transforms [_cat.transforms] -Get transform information. - -Get configuration and usage information about transforms. - -CAT APIs are only intended for human consumption using the Kibana -console or command line. They are not intended for use by applications. For -application consumption, use the get transform statistics API. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-transforms) - -```ts -client.cat.transforms({ ... }) -``` - -### Arguments [_arguments_cat.transforms] - -#### Request (object) [_request_cat.transforms] -- **`transform_id` (Optional, string)**: A transform identifier or a wildcard expression. -If you do not specify one of these options, the API returns information for all transforms. -- **`allow_no_match` (Optional, boolean)**: Specifies what to do when the request: contains wildcard expressions and there are no transforms that match; contains the `_all` string or no identifiers and there are no matches; contains wildcard expressions and there are only partial matches. -If `true`, it returns an empty transforms array when there are no matches and the subset of results when there are partial matches. -If `false`, the request returns a 404 status code when there are no matches or only partial matches. -- **`from` (Optional, number)**: Skips the specified number of transforms. -- **`h` (Optional, Enum("changes_last_detection_time" \| "checkpoint" \| "checkpoint_duration_time_exp_avg" \| "checkpoint_progress" \| "create_time" \| "delete_time" \| "description" \| "dest_index" \| "documents_deleted" \| "documents_indexed" \| "docs_per_second" \| "documents_processed" \| "frequency" \| "id" \| "index_failure" \| "index_time" \| "index_total" \| "indexed_documents_exp_avg" \| "last_search_time" \| "max_page_search_size" \| "pages_processed" \| "pipeline" \| "processed_documents_exp_avg" \| "processing_time" \| "reason" \| "search_failure" \| "search_time" \| "search_total" \| "source_index" \| "state" \| "transform_type" \| "trigger_count" \| "version") \| Enum("changes_last_detection_time" \| "checkpoint" \| "checkpoint_duration_time_exp_avg" \| "checkpoint_progress" \| "create_time" \| "delete_time" \| "description" \| "dest_index" \| "documents_deleted" \| "documents_indexed" \| "docs_per_second" \| "documents_processed" \| "frequency" \| "id" \| "index_failure" \| "index_time" \| "index_total" \| "indexed_documents_exp_avg" \| "last_search_time" \| "max_page_search_size" \| "pages_processed" \| "pipeline" \| "processed_documents_exp_avg" \| "processing_time" \| "reason" \| "search_failure" \| "search_time" \| "search_total" \| "source_index" \| "state" \| "transform_type" \| "trigger_count" \| "version")[])**: List of column names to display. -- **`s` (Optional, Enum("changes_last_detection_time" \| "checkpoint" \| "checkpoint_duration_time_exp_avg" \| "checkpoint_progress" \| "create_time" \| "delete_time" \| "description" \| "dest_index" \| "documents_deleted" \| "documents_indexed" \| "docs_per_second" \| "documents_processed" \| "frequency" \| "id" \| "index_failure" \| "index_time" \| "index_total" \| "indexed_documents_exp_avg" \| "last_search_time" \| "max_page_search_size" \| "pages_processed" \| "pipeline" \| "processed_documents_exp_avg" \| "processing_time" \| "reason" \| "search_failure" \| "search_time" \| "search_total" \| "source_index" \| "state" \| "transform_type" \| "trigger_count" \| "version") \| Enum("changes_last_detection_time" \| "checkpoint" \| "checkpoint_duration_time_exp_avg" \| "checkpoint_progress" \| "create_time" \| "delete_time" \| "description" \| "dest_index" \| "documents_deleted" \| "documents_indexed" \| "docs_per_second" \| "documents_processed" \| "frequency" \| "id" \| "index_failure" \| "index_time" \| "index_total" \| "indexed_documents_exp_avg" \| "last_search_time" \| "max_page_search_size" \| "pages_processed" \| "pipeline" \| "processed_documents_exp_avg" \| "processing_time" \| "reason" \| "search_failure" \| "search_time" \| "search_total" \| "source_index" \| "state" \| "transform_type" \| "trigger_count" \| "version")[])**: List of column names or column aliases used to sort the response. -- **`time` (Optional, Enum("nanos" \| "micros" \| "ms" \| "s" \| "m" \| "h" \| "d"))**: The unit used to display time values. -- **`size` (Optional, number)**: The maximum number of transforms to obtain. - -## client.ccr.deleteAutoFollowPattern [_ccr.delete_auto_follow_pattern] -Delete auto-follow patterns. - -Delete a collection of cross-cluster replication auto-follow patterns. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-delete-auto-follow-pattern) - -```ts -client.ccr.deleteAutoFollowPattern({ name }) -``` - -### Arguments [_arguments_ccr.delete_auto_follow_pattern] - -#### Request (object) [_request_ccr.delete_auto_follow_pattern] -- **`name` (string)**: The auto-follow pattern collection to delete. -- **`master_timeout` (Optional, string \| -1 \| 0)**: The period to wait for a connection to the master node. -If the master node is not available before the timeout expires, the request fails and returns an error. -It can also be set to `-1` to indicate that the request should never timeout. - -## client.ccr.follow [_ccr.follow] -Create a follower. -Create a cross-cluster replication follower index that follows a specific leader index. -When the API returns, the follower index exists and cross-cluster replication starts replicating operations from the leader index to the follower index. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-follow) - -```ts -client.ccr.follow({ index, leader_index, remote_cluster }) -``` - -### Arguments [_arguments_ccr.follow] - -#### Request (object) [_request_ccr.follow] -- **`index` (string)**: The name of the follower index. -- **`leader_index` (string)**: The name of the index in the leader cluster to follow. -- **`remote_cluster` (string)**: The remote cluster containing the leader index. -- **`data_stream_name` (Optional, string)**: If the leader index is part of a data stream, the name to which the local data stream for the followed index should be renamed. -- **`max_outstanding_read_requests` (Optional, number)**: The maximum number of outstanding reads requests from the remote cluster. -- **`max_outstanding_write_requests` (Optional, number)**: The maximum number of outstanding write requests on the follower. -- **`max_read_request_operation_count` (Optional, number)**: The maximum number of operations to pull per read from the remote cluster. -- **`max_read_request_size` (Optional, number \| string)**: The maximum size in bytes of per read of a batch of operations pulled from the remote cluster. -- **`max_retry_delay` (Optional, string \| -1 \| 0)**: The maximum time to wait before retrying an operation that failed exceptionally. An exponential backoff strategy is employed when -retrying. -- **`max_write_buffer_count` (Optional, number)**: The maximum number of operations that can be queued for writing. When this limit is reached, reads from the remote cluster will be -deferred until the number of queued operations goes below the limit. -- **`max_write_buffer_size` (Optional, number \| string)**: The maximum total bytes of operations that can be queued for writing. When this limit is reached, reads from the remote cluster will -be deferred until the total bytes of queued operations goes below the limit. -- **`max_write_request_operation_count` (Optional, number)**: The maximum number of operations per bulk write request executed on the follower. -- **`max_write_request_size` (Optional, number \| string)**: The maximum total bytes of operations per bulk write request executed on the follower. -- **`read_poll_timeout` (Optional, string \| -1 \| 0)**: The maximum time to wait for new operations on the remote cluster when the follower index is synchronized with the leader index. -When the timeout has elapsed, the poll for operations will return to the follower so that it can update some statistics. -Then the follower will immediately attempt to read from the leader again. -- **`settings` (Optional, { index, mode, routing_path, soft_deletes, sort, number_of_shards, number_of_replicas, number_of_routing_shards, check_on_startup, codec, routing_partition_size, load_fixed_bitset_filters_eagerly, hidden, auto_expand_replicas, merge, search, refresh_interval, max_result_window, max_inner_result_window, max_rescore_window, max_docvalue_fields_search, max_script_fields, max_ngram_diff, max_shingle_diff, blocks, max_refresh_listeners, analyze, highlight, max_terms_count, max_regex_length, routing, gc_deletes, default_pipeline, final_pipeline, lifecycle, provided_name, creation_date, creation_date_string, uuid, version, verified_before_close, format, max_slices_per_scroll, translog, query_string, priority, top_metrics_max_size, analysis, settings, time_series, queries, similarity, mapping, indexing.slowlog, indexing_pressure, store })**: Settings to override from the leader index. -- **`master_timeout` (Optional, string \| -1 \| 0)**: Period to wait for a connection to the master node. -- **`wait_for_active_shards` (Optional, number \| Enum("all" \| "index-setting"))**: Specifies the number of shards to wait on being active before responding. This defaults to waiting on none of the shards to be -active. -A shard must be restored from the leader index before being active. Restoring a follower shard requires transferring all the -remote Lucene segment files to the follower index. - -## client.ccr.followInfo [_ccr.follow_info] -Get follower information. - -Get information about all cross-cluster replication follower indices. -For example, the results include follower index names, leader index names, replication options, and whether the follower indices are active or paused. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-follow-info) - -```ts -client.ccr.followInfo({ index }) -``` - -### Arguments [_arguments_ccr.follow_info] - -#### Request (object) [_request_ccr.follow_info] -- **`index` (string \| string[])**: A comma-delimited list of follower index patterns. -- **`master_timeout` (Optional, string \| -1 \| 0)**: The period to wait for a connection to the master node. -If the master node is not available before the timeout expires, the request fails and returns an error. -It can also be set to `-1` to indicate that the request should never timeout. - -## client.ccr.followStats [_ccr.follow_stats] -Get follower stats. - -Get cross-cluster replication follower stats. -The API returns shard-level stats about the "following tasks" associated with each shard for the specified indices. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-follow-stats) - -```ts -client.ccr.followStats({ index }) -``` - -### Arguments [_arguments_ccr.follow_stats] - -#### Request (object) [_request_ccr.follow_stats] -- **`index` (string \| string[])**: A comma-delimited list of index patterns. -- **`timeout` (Optional, string \| -1 \| 0)**: The period to wait for a response. -If no response is received before the timeout expires, the request fails and returns an error. - -## client.ccr.forgetFollower [_ccr.forget_follower] -Forget a follower. -Remove the cross-cluster replication follower retention leases from the leader. - -A following index takes out retention leases on its leader index. -These leases are used to increase the likelihood that the shards of the leader index retain the history of operations that the shards of the following index need to run replication. -When a follower index is converted to a regular index by the unfollow API (either by directly calling the API or by index lifecycle management tasks), these leases are removed. -However, removal of the leases can fail, for example when the remote cluster containing the leader index is unavailable. -While the leases will eventually expire on their own, their extended existence can cause the leader index to hold more history than necessary and prevent index lifecycle management from performing some operations on the leader index. -This API exists to enable manually removing the leases when the unfollow API is unable to do so. - -NOTE: This API does not stop replication by a following index. If you use this API with a follower index that is still actively following, the following index will add back retention leases on the leader. -The only purpose of this API is to handle the case of failure to remove the following retention leases after the unfollow API is invoked. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-forget-follower) - -```ts -client.ccr.forgetFollower({ index }) -``` - -### Arguments [_arguments_ccr.forget_follower] - -#### Request (object) [_request_ccr.forget_follower] -- **`index` (string)**: the name of the leader index for which specified follower retention leases should be removed -- **`follower_cluster` (Optional, string)** -- **`follower_index` (Optional, string)** -- **`follower_index_uuid` (Optional, string)** -- **`leader_remote_cluster` (Optional, string)** -- **`timeout` (Optional, string \| -1 \| 0)**: Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. - -## client.ccr.getAutoFollowPattern [_ccr.get_auto_follow_pattern] -Get auto-follow patterns. - -Get cross-cluster replication auto-follow patterns. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-get-auto-follow-pattern-1) - -```ts -client.ccr.getAutoFollowPattern({ ... }) -``` - -### Arguments [_arguments_ccr.get_auto_follow_pattern] - -#### Request (object) [_request_ccr.get_auto_follow_pattern] -- **`name` (Optional, string)**: The auto-follow pattern collection that you want to retrieve. -If you do not specify a name, the API returns information for all collections. -- **`master_timeout` (Optional, string \| -1 \| 0)**: The period to wait for a connection to the master node. -If the master node is not available before the timeout expires, the request fails and returns an error. -It can also be set to `-1` to indicate that the request should never timeout. - -## client.ccr.pauseAutoFollowPattern [_ccr.pause_auto_follow_pattern] -Pause an auto-follow pattern. - -Pause a cross-cluster replication auto-follow pattern. -When the API returns, the auto-follow pattern is inactive. -New indices that are created on the remote cluster and match the auto-follow patterns are ignored. - -You can resume auto-following with the resume auto-follow pattern API. -When it resumes, the auto-follow pattern is active again and automatically configures follower indices for newly created indices on the remote cluster that match its patterns. -Remote indices that were created while the pattern was paused will also be followed, unless they have been deleted or closed in the interim. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-pause-auto-follow-pattern) - -```ts -client.ccr.pauseAutoFollowPattern({ name }) -``` - -### Arguments [_arguments_ccr.pause_auto_follow_pattern] - -#### Request (object) [_request_ccr.pause_auto_follow_pattern] -- **`name` (string)**: The name of the auto-follow pattern to pause. -- **`master_timeout` (Optional, string \| -1 \| 0)**: The period to wait for a connection to the master node. -If the master node is not available before the timeout expires, the request fails and returns an error. -It can also be set to `-1` to indicate that the request should never timeout. - -## client.ccr.pauseFollow [_ccr.pause_follow] -Pause a follower. - -Pause a cross-cluster replication follower index. -The follower index will not fetch any additional operations from the leader index. -You can resume following with the resume follower API. -You can pause and resume a follower index to change the configuration of the following task. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-pause-follow) - -```ts -client.ccr.pauseFollow({ index }) -``` - -### Arguments [_arguments_ccr.pause_follow] - -#### Request (object) [_request_ccr.pause_follow] -- **`index` (string)**: The name of the follower index. -- **`master_timeout` (Optional, string \| -1 \| 0)**: The period to wait for a connection to the master node. -If the master node is not available before the timeout expires, the request fails and returns an error. -It can also be set to `-1` to indicate that the request should never timeout. - -## client.ccr.putAutoFollowPattern [_ccr.put_auto_follow_pattern] -Create or update auto-follow patterns. -Create a collection of cross-cluster replication auto-follow patterns for a remote cluster. -Newly created indices on the remote cluster that match any of the patterns are automatically configured as follower indices. -Indices on the remote cluster that were created before the auto-follow pattern was created will not be auto-followed even if they match the pattern. - -This API can also be used to update auto-follow patterns. -NOTE: Follower indices that were configured automatically before updating an auto-follow pattern will remain unchanged even if they do not match against the new patterns. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-put-auto-follow-pattern) - -```ts -client.ccr.putAutoFollowPattern({ name, remote_cluster }) -``` - -### Arguments [_arguments_ccr.put_auto_follow_pattern] - -#### Request (object) [_request_ccr.put_auto_follow_pattern] -- **`name` (string)**: The name of the collection of auto-follow patterns. -- **`remote_cluster` (string)**: The remote cluster containing the leader indices to match against. -- **`follow_index_pattern` (Optional, string)**: The name of follower index. The template `leader_index` can be used to derive the name of the follower index from the name of the leader index. When following a data stream, use `leader_index`; CCR does not support changes to the names of a follower data stream’s backing indices. -- **`leader_index_patterns` (Optional, string[])**: An array of simple index patterns to match against indices in the remote cluster specified by the remote_cluster field. -- **`leader_index_exclusion_patterns` (Optional, string[])**: An array of simple index patterns that can be used to exclude indices from being auto-followed. Indices in the remote cluster whose names are matching one or more leader_index_patterns and one or more leader_index_exclusion_patterns won’t be followed. -- **`max_outstanding_read_requests` (Optional, number)**: The maximum number of outstanding reads requests from the remote cluster. -- **`settings` (Optional, Record)**: Settings to override from the leader index. Note that certain settings can not be overrode (e.g., index.number_of_shards). -- **`max_outstanding_write_requests` (Optional, number)**: The maximum number of outstanding reads requests from the remote cluster. -- **`read_poll_timeout` (Optional, string \| -1 \| 0)**: The maximum time to wait for new operations on the remote cluster when the follower index is synchronized with the leader index. When the timeout has elapsed, the poll for operations will return to the follower so that it can update some statistics. Then the follower will immediately attempt to read from the leader again. -- **`max_read_request_operation_count` (Optional, number)**: The maximum number of operations to pull per read from the remote cluster. -- **`max_read_request_size` (Optional, number \| string)**: The maximum size in bytes of per read of a batch of operations pulled from the remote cluster. -- **`max_retry_delay` (Optional, string \| -1 \| 0)**: The maximum time to wait before retrying an operation that failed exceptionally. An exponential backoff strategy is employed when retrying. -- **`max_write_buffer_count` (Optional, number)**: The maximum number of operations that can be queued for writing. When this limit is reached, reads from the remote cluster will be deferred until the number of queued operations goes below the limit. -- **`max_write_buffer_size` (Optional, number \| string)**: The maximum total bytes of operations that can be queued for writing. When this limit is reached, reads from the remote cluster will be deferred until the total bytes of queued operations goes below the limit. -- **`max_write_request_operation_count` (Optional, number)**: The maximum number of operations per bulk write request executed on the follower. -- **`max_write_request_size` (Optional, number \| string)**: The maximum total bytes of operations per bulk write request executed on the follower. -- **`master_timeout` (Optional, string \| -1 \| 0)**: Period to wait for a connection to the master node. - -## client.ccr.resumeAutoFollowPattern [_ccr.resume_auto_follow_pattern] -Resume an auto-follow pattern. - -Resume a cross-cluster replication auto-follow pattern that was paused. -The auto-follow pattern will resume configuring following indices for newly created indices that match its patterns on the remote cluster. -Remote indices created while the pattern was paused will also be followed unless they have been deleted or closed in the interim. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-resume-auto-follow-pattern) - -```ts -client.ccr.resumeAutoFollowPattern({ name }) -``` - -### Arguments [_arguments_ccr.resume_auto_follow_pattern] - -#### Request (object) [_request_ccr.resume_auto_follow_pattern] -- **`name` (string)**: The name of the auto-follow pattern to resume. -- **`master_timeout` (Optional, string \| -1 \| 0)**: The period to wait for a connection to the master node. -If the master node is not available before the timeout expires, the request fails and returns an error. -It can also be set to `-1` to indicate that the request should never timeout. - -## client.ccr.resumeFollow [_ccr.resume_follow] -Resume a follower. -Resume a cross-cluster replication follower index that was paused. -The follower index could have been paused with the pause follower API. -Alternatively it could be paused due to replication that cannot be retried due to failures during following tasks. -When this API returns, the follower index will resume fetching operations from the leader index. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-resume-follow) - -```ts -client.ccr.resumeFollow({ index }) -``` - -### Arguments [_arguments_ccr.resume_follow] - -#### Request (object) [_request_ccr.resume_follow] -- **`index` (string)**: The name of the follow index to resume following. -- **`max_outstanding_read_requests` (Optional, number)** -- **`max_outstanding_write_requests` (Optional, number)** -- **`max_read_request_operation_count` (Optional, number)** -- **`max_read_request_size` (Optional, string)** -- **`max_retry_delay` (Optional, string \| -1 \| 0)** -- **`max_write_buffer_count` (Optional, number)** -- **`max_write_buffer_size` (Optional, string)** -- **`max_write_request_operation_count` (Optional, number)** -- **`max_write_request_size` (Optional, string)** -- **`read_poll_timeout` (Optional, string \| -1 \| 0)** -- **`master_timeout` (Optional, string \| -1 \| 0)**: Period to wait for a connection to the master node. - -## client.ccr.stats [_ccr.stats] -Get cross-cluster replication stats. - -This API returns stats about auto-following and the same shard-level stats as the get follower stats API. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-stats) - -```ts -client.ccr.stats({ ... }) -``` - -### Arguments [_arguments_ccr.stats] - -#### Request (object) [_request_ccr.stats] -- **`master_timeout` (Optional, string \| -1 \| 0)**: The period to wait for a connection to the master node. -If the master node is not available before the timeout expires, the request fails and returns an error. -It can also be set to `-1` to indicate that the request should never timeout. -- **`timeout` (Optional, string \| -1 \| 0)**: The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. - -## client.ccr.unfollow [_ccr.unfollow] -Unfollow an index. - -Convert a cross-cluster replication follower index to a regular index. -The API stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. -The follower index must be paused and closed before you call the unfollow API. - -> info -> Currently cross-cluster replication does not support converting an existing regular index to a follower index. Converting a follower index to a regular index is an irreversible operation. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-unfollow) - -```ts -client.ccr.unfollow({ index }) -``` - -### Arguments [_arguments_ccr.unfollow] - -#### Request (object) [_request_ccr.unfollow] -- **`index` (string)**: The name of the follower index. -- **`master_timeout` (Optional, string \| -1 \| 0)**: The period to wait for a connection to the master node. -If the master node is not available before the timeout expires, the request fails and returns an error. -It can also be set to `-1` to indicate that the request should never timeout. - -## client.cluster.allocationExplain [_cluster.allocation_explain] -Explain the shard allocations. -Get explanations for shard allocations in the cluster. -For unassigned shards, it provides an explanation for why the shard is unassigned. -For assigned shards, it provides an explanation for why the shard is remaining on its current node and has not moved or rebalanced to another node. -This API can be very useful when attempting to diagnose why a shard is unassigned or why a shard continues to remain on its current node when you might expect otherwise. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-allocation-explain) - -```ts -client.cluster.allocationExplain({ ... }) -``` - -### Arguments [_arguments_cluster.allocation_explain] - -#### Request (object) [_request_cluster.allocation_explain] -- **`current_node` (Optional, string)**: Specifies the node ID or the name of the node to only explain a shard that is currently located on the specified node. -- **`index` (Optional, string)**: Specifies the name of the index that you would like an explanation for. -- **`primary` (Optional, boolean)**: If true, returns explanation for the primary shard for the given shard ID. -- **`shard` (Optional, number)**: Specifies the ID of the shard that you would like an explanation for. -- **`include_disk_info` (Optional, boolean)**: If true, returns information about disk usage and shard sizes. -- **`include_yes_decisions` (Optional, boolean)**: If true, returns YES decisions in explanation. -- **`master_timeout` (Optional, string \| -1 \| 0)**: Period to wait for a connection to the master node. - -## client.cluster.deleteComponentTemplate [_cluster.delete_component_template] -Delete component templates. -Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-put-component-template) - -```ts -client.cluster.deleteComponentTemplate({ name }) -``` - -### Arguments [_arguments_cluster.delete_component_template] - -#### Request (object) [_request_cluster.delete_component_template] -- **`name` (string \| string[])**: List or wildcard expression of component template names used to limit the request. -- **`master_timeout` (Optional, string \| -1 \| 0)**: Period to wait for a connection to the master node. -If no response is received before the timeout expires, the request fails and returns an error. -- **`timeout` (Optional, string \| -1 \| 0)**: Period to wait for a response. -If no response is received before the timeout expires, the request fails and returns an error. - -## client.cluster.deleteVotingConfigExclusions [_cluster.delete_voting_config_exclusions] -Clear cluster voting config exclusions. -Remove master-eligible nodes from the voting configuration exclusion list. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-post-voting-config-exclusions) - -```ts -client.cluster.deleteVotingConfigExclusions({ ... }) -``` - -### Arguments [_arguments_cluster.delete_voting_config_exclusions] - -#### Request (object) [_request_cluster.delete_voting_config_exclusions] -- **`master_timeout` (Optional, string \| -1 \| 0)**: Period to wait for a connection to the master node. -- **`wait_for_removal` (Optional, boolean)**: Specifies whether to wait for all excluded nodes to be removed from the -cluster before clearing the voting configuration exclusions list. -Defaults to true, meaning that all excluded nodes must be removed from -the cluster before this API takes any action. If set to false then the -voting configuration exclusions list is cleared even if some excluded -nodes are still in the cluster. - -## client.cluster.existsComponentTemplate [_cluster.exists_component_template] -Check component templates. -Returns information about whether a particular component template exists. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-put-component-template) - -```ts -client.cluster.existsComponentTemplate({ name }) -``` - -### Arguments [_arguments_cluster.exists_component_template] - -#### Request (object) [_request_cluster.exists_component_template] -- **`name` (string \| string[])**: List of component template names used to limit the request. -Wildcard (*) expressions are supported. -- **`master_timeout` (Optional, string \| -1 \| 0)**: Period to wait for a connection to the master node. If no response is -received before the timeout expires, the request fails and returns an -error. -- **`local` (Optional, boolean)**: If true, the request retrieves information from the local node only. -Defaults to false, which means information is retrieved from the master node. - -## client.cluster.getComponentTemplate [_cluster.get_component_template] -Get component templates. -Get information about component templates. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-put-component-template) - -```ts -client.cluster.getComponentTemplate({ ... }) -``` - -### Arguments [_arguments_cluster.get_component_template] - -#### Request (object) [_request_cluster.get_component_template] -- **`name` (Optional, string)**: List of component template names used to limit the request. -Wildcard (`*`) expressions are supported. -- **`flat_settings` (Optional, boolean)**: If `true`, returns settings in flat format. -- **`include_defaults` (Optional, boolean)**: Return all default configurations for the component template (default: false) -- **`local` (Optional, boolean)**: If `true`, the request retrieves information from the local node only. -If `false`, information is retrieved from the master node. -- **`master_timeout` (Optional, string \| -1 \| 0)**: Period to wait for a connection to the master node. -If no response is received before the timeout expires, the request fails and returns an error. - -## client.cluster.getSettings [_cluster.get_settings] -Get cluster-wide settings. -By default, it returns only settings that have been explicitly defined. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-get-settings) - -```ts -client.cluster.getSettings({ ... }) -``` - -### Arguments [_arguments_cluster.get_settings] - -#### Request (object) [_request_cluster.get_settings] -- **`flat_settings` (Optional, boolean)**: If `true`, returns settings in flat format. -- **`include_defaults` (Optional, boolean)**: If `true`, returns default cluster settings from the local node. -- **`master_timeout` (Optional, string \| -1 \| 0)**: Period to wait for a connection to the master node. -If no response is received before the timeout expires, the request fails and returns an error. -- **`timeout` (Optional, string \| -1 \| 0)**: Period to wait for a response. -If no response is received before the timeout expires, the request fails and returns an error. - -## client.cluster.health [_cluster.health] -Get the cluster health status. - -You can also use the API to get the health status of only specified data streams and indices. -For data streams, the API retrieves the health status of the stream’s backing indices. - -The cluster health status is: green, yellow or red. -On the shard level, a red status indicates that the specific shard is not allocated in the cluster. Yellow means that the primary shard is allocated but replicas are not. Green means that all shards are allocated. -The index level status is controlled by the worst shard status. - -One of the main benefits of the API is the ability to wait until the cluster reaches a certain high watermark health level. -The cluster status is controlled by the worst index status. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-health) - -```ts -client.cluster.health({ ... }) -``` - -### Arguments [_arguments_cluster.health] - -#### Request (object) [_request_cluster.health] -- **`index` (Optional, string \| string[])**: List of data streams, indices, and index aliases used to limit the request. Wildcard expressions (`*`) are supported. To target all data streams and indices in a cluster, omit this parameter or use _all or `*`. -- **`expand_wildcards` (Optional, Enum("all" \| "open" \| "closed" \| "hidden" \| "none") \| Enum("all" \| "open" \| "closed" \| "hidden" \| "none")[])**: Whether to expand wildcard expression to concrete indices that are open, closed or both. -- **`level` (Optional, Enum("cluster" \| "indices" \| "shards"))**: Can be one of cluster, indices or shards. Controls the details level of the health information returned. -- **`local` (Optional, boolean)**: If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node. -- **`master_timeout` (Optional, string \| -1 \| 0)**: Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. -- **`timeout` (Optional, string \| -1 \| 0)**: Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. -- **`wait_for_active_shards` (Optional, number \| Enum("all" \| "index-setting"))**: A number controlling to how many active shards to wait for, all to wait for all shards in the cluster to be active, or 0 to not wait. -- **`wait_for_events` (Optional, Enum("immediate" \| "urgent" \| "high" \| "normal" \| "low" \| "languid"))**: Can be one of immediate, urgent, high, normal, low, languid. Wait until all currently queued events with the given priority are processed. -- **`wait_for_nodes` (Optional, string \| number)**: The request waits until the specified number N of nodes is available. It also accepts >=N, <=N, >N and yellow > red. By default, will not wait for any status. - -## client.cluster.info [_cluster.info] -Get cluster info. -Returns basic information about the cluster. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-info) - -```ts -client.cluster.info({ target }) -``` - -### Arguments [_arguments_cluster.info] - -#### Request (object) [_request_cluster.info] -- **`target` (Enum("_all" \| "http" \| "ingest" \| "thread_pool" \| "script") \| Enum("_all" \| "http" \| "ingest" \| "thread_pool" \| "script")[])**: Limits the information returned to the specific target. Supports a list, such as http,ingest. - -## client.cluster.pendingTasks [_cluster.pending_tasks] -Get the pending cluster tasks. -Get information about cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet taken effect. - -NOTE: This API returns a list of any pending updates to the cluster state. -These are distinct from the tasks reported by the task management API which include periodic tasks and tasks initiated by the user, such as node stats, search queries, or create index requests. -However, if a user-initiated task such as a create index command causes a cluster state update, the activity of this task might be reported by both task api and pending cluster tasks API. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-pending-tasks) - -```ts -client.cluster.pendingTasks({ ... }) -``` - -### Arguments [_arguments_cluster.pending_tasks] - -#### Request (object) [_request_cluster.pending_tasks] -- **`local` (Optional, boolean)**: If `true`, the request retrieves information from the local node only. -If `false`, information is retrieved from the master node. -- **`master_timeout` (Optional, string \| -1 \| 0)**: Period to wait for a connection to the master node. -If no response is received before the timeout expires, the request fails and returns an error. - -## client.cluster.postVotingConfigExclusions [_cluster.post_voting_config_exclusions] -Update voting configuration exclusions. -Update the cluster voting config exclusions by node IDs or node names. -By default, if there are more than three master-eligible nodes in the cluster and you remove fewer than half of the master-eligible nodes in the cluster at once, the voting configuration automatically shrinks. -If you want to shrink the voting configuration to contain fewer than three nodes or to remove half or more of the master-eligible nodes in the cluster at once, use this API to remove departing nodes from the voting configuration manually. -The API adds an entry for each specified node to the cluster’s voting configuration exclusions list. -It then waits until the cluster has reconfigured its voting configuration to exclude the specified nodes. - -Clusters should have no voting configuration exclusions in normal operation. -Once the excluded nodes have stopped, clear the voting configuration exclusions with `DELETE /_cluster/voting_config_exclusions`. -This API waits for the nodes to be fully removed from the cluster before it returns. -If your cluster has voting configuration exclusions for nodes that you no longer intend to remove, use `DELETE /_cluster/voting_config_exclusions?wait_for_removal=false` to clear the voting configuration exclusions without waiting for the nodes to leave the cluster. - -A response to `POST /_cluster/voting_config_exclusions` with an HTTP status code of 200 OK guarantees that the node has been removed from the voting configuration and will not be reinstated until the voting configuration exclusions are cleared by calling `DELETE /_cluster/voting_config_exclusions`. -If the call to `POST /_cluster/voting_config_exclusions` fails or returns a response with an HTTP status code other than 200 OK then the node may not have been removed from the voting configuration. -In that case, you may safely retry the call. - -NOTE: Voting exclusions are required only when you remove at least half of the master-eligible nodes from a cluster in a short time period. -They are not required when removing master-ineligible nodes or when removing fewer than half of the master-eligible nodes. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-post-voting-config-exclusions) - -```ts -client.cluster.postVotingConfigExclusions({ ... }) -``` - -### Arguments [_arguments_cluster.post_voting_config_exclusions] - -#### Request (object) [_request_cluster.post_voting_config_exclusions] -- **`node_names` (Optional, string \| string[])**: A list of the names of the nodes to exclude from the -voting configuration. If specified, you may not also specify node_ids. -- **`node_ids` (Optional, string \| string[])**: A list of the persistent ids of the nodes to exclude -from the voting configuration. If specified, you may not also specify node_names. -- **`master_timeout` (Optional, string \| -1 \| 0)**: Period to wait for a connection to the master node. -- **`timeout` (Optional, string \| -1 \| 0)**: When adding a voting configuration exclusion, the API waits for the -specified nodes to be excluded from the voting configuration before -returning. If the timeout expires before the appropriate condition -is satisfied, the request fails and returns an error. - -## client.cluster.putComponentTemplate [_cluster.put_component_template] -Create or update a component template. -Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. - -An index template can be composed of multiple component templates. -To use a component template, specify it in an index template’s `composed_of` list. -Component templates are only applied to new data streams and indices as part of a matching index template. - -Settings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template. - -Component templates are only used during index creation. -For data streams, this includes data stream creation and the creation of a stream’s backing indices. -Changes to component templates do not affect existing indices, including a stream’s backing indices. - -You can use C-style `/* *\/` block comments in component templates. -You can include comments anywhere in the request body except before the opening curly bracket. - -**Applying component templates** - -You cannot directly apply a component template to a data stream or index. -To be applied, a component template must be included in an index template's `composed_of` list. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-put-component-template) - -```ts -client.cluster.putComponentTemplate({ name, template }) -``` - -### Arguments [_arguments_cluster.put_component_template] - -#### Request (object) [_request_cluster.put_component_template] -- **`name` (string)**: Name of the component template to create. -Elasticsearch includes the following built-in component templates: `logs-mappings`; `logs-settings`; `metrics-mappings`; `metrics-settings`;`synthetics-mapping`; `synthetics-settings`. -Elastic Agent uses these templates to configure backing indices for its data streams. -If you use Elastic Agent and want to overwrite one of these templates, set the `version` for your replacement template higher than the current version. -If you don’t use Elastic Agent and want to disable all built-in component and index templates, set `stack.templates.enabled` to `false` using the cluster update settings API. -- **`template` ({ aliases, mappings, settings, defaults, data_stream, lifecycle })**: The template to be applied which includes mappings, settings, or aliases configuration. -- **`version` (Optional, number)**: Version number used to manage component templates externally. -This number isn't automatically generated or incremented by Elasticsearch. -To unset a version, replace the template without specifying a version. -- **`_meta` (Optional, Record)**: Optional user metadata about the component template. -It may have any contents. This map is not automatically generated by Elasticsearch. -This information is stored in the cluster state, so keeping it short is preferable. -To unset `_meta`, replace the template without specifying this information. -- **`deprecated` (Optional, boolean)**: Marks this index template as deprecated. When creating or updating a non-deprecated index template -that uses deprecated components, Elasticsearch will emit a deprecation warning. -- **`create` (Optional, boolean)**: If `true`, this request cannot replace or update existing component templates. -- **`master_timeout` (Optional, string \| -1 \| 0)**: Period to wait for a connection to the master node. -If no response is received before the timeout expires, the request fails and returns an error. - -## client.cluster.putSettings [_cluster.put_settings] -Update the cluster settings. - -Configure and update dynamic settings on a running cluster. -You can also configure dynamic settings locally on an unstarted or shut down node in `elasticsearch.yml`. - -Updates made with this API can be persistent, which apply across cluster restarts, or transient, which reset after a cluster restart. -You can also reset transient or persistent settings by assigning them a null value. - -If you configure the same setting using multiple methods, Elasticsearch applies the settings in following order of precedence: 1) Transient setting; 2) Persistent setting; 3) `elasticsearch.yml` setting; 4) Default setting value. -For example, you can apply a transient setting to override a persistent setting or `elasticsearch.yml` setting. -However, a change to an `elasticsearch.yml` setting will not override a defined transient or persistent setting. - -TIP: In Elastic Cloud, use the user settings feature to configure all cluster settings. This method automatically rejects unsafe settings that could break your cluster. -If you run Elasticsearch on your own hardware, use this API to configure dynamic cluster settings. -Only use `elasticsearch.yml` for static cluster settings and node settings. -The API doesn’t require a restart and ensures a setting’s value is the same on all nodes. - -WARNING: Transient cluster settings are no longer recommended. Use persistent cluster settings instead. -If a cluster becomes unstable, transient settings can clear unexpectedly, resulting in a potentially undesired cluster configuration. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-put-settings) - -```ts -client.cluster.putSettings({ ... }) -``` - -### Arguments [_arguments_cluster.put_settings] - -#### Request (object) [_request_cluster.put_settings] -- **`persistent` (Optional, Record)** -- **`transient` (Optional, Record)** -- **`flat_settings` (Optional, boolean)**: Return settings in flat format (default: false) -- **`master_timeout` (Optional, string \| -1 \| 0)**: Explicit operation timeout for connection to master node -- **`timeout` (Optional, string \| -1 \| 0)**: Explicit operation timeout - -## client.cluster.remoteInfo [_cluster.remote_info] -Get remote cluster information. - -Get information about configured remote clusters. -The API returns connection and endpoint information keyed by the configured remote cluster alias. - -> info -> This API returns information that reflects current state on the local cluster. -> The `connected` field does not necessarily reflect whether a remote cluster is down or unavailable, only whether there is currently an open connection to it. -> Elasticsearch does not spontaneously try to reconnect to a disconnected remote cluster. -> To trigger a reconnection, attempt a cross-cluster search, ES|QL cross-cluster search, or try the [resolve cluster endpoint](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-resolve-cluster). - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-remote-info) - -```ts -client.cluster.remoteInfo() -``` - - -## client.cluster.reroute [_cluster.reroute] -Reroute the cluster. -Manually change the allocation of individual shards in the cluster. -For example, a shard can be moved from one node to another explicitly, an allocation can be canceled, and an unassigned shard can be explicitly allocated to a specific node. - -It is important to note that after processing any reroute commands Elasticsearch will perform rebalancing as normal (respecting the values of settings such as `cluster.routing.rebalance.enable`) in order to remain in a balanced state. -For example, if the requested allocation includes moving a shard from node1 to node2 then this may cause a shard to be moved from node2 back to node1 to even things out. - -The cluster can be set to disable allocations using the `cluster.routing.allocation.enable` setting. -If allocations are disabled then the only allocations that will be performed are explicit ones given using the reroute command, and consequent allocations due to rebalancing. - -The cluster will attempt to allocate a shard a maximum of `index.allocation.max_retries` times in a row (defaults to `5`), before giving up and leaving the shard unallocated. -This scenario can be caused by structural problems such as having an analyzer which refers to a stopwords file which doesn’t exist on all nodes. - -Once the problem has been corrected, allocation can be manually retried by calling the reroute API with the `?retry_failed` URI query parameter, which will attempt a single retry round for these shards. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-reroute) - -```ts -client.cluster.reroute({ ... }) -``` - -### Arguments [_arguments_cluster.reroute] - -#### Request (object) [_request_cluster.reroute] -- **`commands` (Optional, { cancel, move, allocate_replica, allocate_stale_primary, allocate_empty_primary }[])**: Defines the commands to perform. -- **`dry_run` (Optional, boolean)**: If true, then the request simulates the operation. -It will calculate the result of applying the commands to the current cluster state and return the resulting cluster state after the commands (and rebalancing) have been applied; it will not actually perform the requested changes. -- **`explain` (Optional, boolean)**: If true, then the response contains an explanation of why the commands can or cannot run. -- **`metric` (Optional, string \| string[])**: Limits the information returned to the specified metrics. -- **`retry_failed` (Optional, boolean)**: If true, then retries allocation of shards that are blocked due to too many subsequent allocation failures. -- **`master_timeout` (Optional, string \| -1 \| 0)**: Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. -- **`timeout` (Optional, string \| -1 \| 0)**: Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. - -## client.cluster.state [_cluster.state] -Get the cluster state. -Get comprehensive information about the state of the cluster. - -The cluster state is an internal data structure which keeps track of a variety of information needed by every node, including the identity and attributes of the other nodes in the cluster; cluster-wide settings; index metadata, including the mapping and settings for each index; the location and status of every shard copy in the cluster. - -The elected master node ensures that every node in the cluster has a copy of the same cluster state. -This API lets you retrieve a representation of this internal state for debugging or diagnostic purposes. -You may need to consult the Elasticsearch source code to determine the precise meaning of the response. - -By default the API will route requests to the elected master node since this node is the authoritative source of cluster states. -You can also retrieve the cluster state held on the node handling the API request by adding the `?local=true` query parameter. - -Elasticsearch may need to expend significant effort to compute a response to this API in larger clusters, and the response may comprise a very large quantity of data. -If you use this API repeatedly, your cluster may become unstable. - -WARNING: The response is a representation of an internal data structure. -Its format is not subject to the same compatibility guarantees as other more stable APIs and may change from version to version. -Do not query this API using external monitoring tools. -Instead, obtain the information you require using other more stable cluster APIs. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-state) - -```ts -client.cluster.state({ ... }) -``` - -### Arguments [_arguments_cluster.state] - -#### Request (object) [_request_cluster.state] -- **`metric` (Optional, string \| string[])**: Limit the information returned to the specified metrics -- **`index` (Optional, string \| string[])**: A list of index names; use `_all` or empty string to perform the operation on all indices -- **`allow_no_indices` (Optional, boolean)**: Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) -- **`expand_wildcards` (Optional, Enum("all" \| "open" \| "closed" \| "hidden" \| "none") \| Enum("all" \| "open" \| "closed" \| "hidden" \| "none")[])**: Whether to expand wildcard expression to concrete indices that are open, closed or both. -- **`flat_settings` (Optional, boolean)**: Return settings in flat format (default: false) -- **`ignore_unavailable` (Optional, boolean)**: Whether specified concrete indices should be ignored when unavailable (missing or closed) -- **`local` (Optional, boolean)**: Return local information, do not retrieve the state from master node (default: false) -- **`master_timeout` (Optional, string \| -1 \| 0)**: Specify timeout for connection to master -- **`wait_for_metadata_version` (Optional, number)**: Wait for the metadata version to be equal or greater than the specified metadata version -- **`wait_for_timeout` (Optional, string \| -1 \| 0)**: The maximum time to wait for wait_for_metadata_version before timing out - -## client.cluster.stats [_cluster.stats] -Get cluster statistics. -Get basic index metrics (shard numbers, store size, memory usage) and information about the current nodes that form the cluster (number, roles, os, jvm versions, memory usage, cpu and installed plugins). - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-stats) - -```ts -client.cluster.stats({ ... }) -``` - -### Arguments [_arguments_cluster.stats] - -#### Request (object) [_request_cluster.stats] -- **`node_id` (Optional, string \| string[])**: List of node filters used to limit returned information. Defaults to all nodes in the cluster. -- **`include_remotes` (Optional, boolean)**: Include remote cluster data into the response -- **`timeout` (Optional, string \| -1 \| 0)**: Period to wait for each node to respond. -If a node does not respond before its timeout expires, the response does not include its stats. -However, timed out nodes are included in the response’s `_nodes.failed` property. Defaults to no timeout. - -## client.connector.checkIn [_connector.check_in] -Check in a connector. - -Update the `last_seen` field in the connector and set it to the current timestamp. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-check-in) - -```ts -client.connector.checkIn({ connector_id }) -``` - -### Arguments [_arguments_connector.check_in] - -#### Request (object) [_request_connector.check_in] -- **`connector_id` (string)**: The unique identifier of the connector to be checked in - -## client.connector.delete [_connector.delete] -Delete a connector. - -Removes a connector and associated sync jobs. -This is a destructive action that is not recoverable. -NOTE: This action doesn’t delete any API keys, ingest pipelines, or data indices associated with the connector. -These need to be removed manually. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-delete) - -```ts -client.connector.delete({ connector_id }) -``` - -### Arguments [_arguments_connector.delete] - -#### Request (object) [_request_connector.delete] -- **`connector_id` (string)**: The unique identifier of the connector to be deleted -- **`delete_sync_jobs` (Optional, boolean)**: A flag indicating if associated sync jobs should be also removed. Defaults to false. -- **`hard` (Optional, boolean)**: A flag indicating if the connector should be hard deleted. - -## client.connector.get [_connector.get] -Get a connector. - -Get the details about a connector. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-get) - -```ts -client.connector.get({ connector_id }) -``` - -### Arguments [_arguments_connector.get] - -#### Request (object) [_request_connector.get] -- **`connector_id` (string)**: The unique identifier of the connector -- **`include_deleted` (Optional, boolean)**: A flag to indicate if the desired connector should be fetched, even if it was soft-deleted. - -## client.connector.list [_connector.list] -Get all connectors. - -Get information about all connectors. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-list) - -```ts -client.connector.list({ ... }) -``` - -### Arguments [_arguments_connector.list] - -#### Request (object) [_request_connector.list] -- **`from` (Optional, number)**: Starting offset (default: 0) -- **`size` (Optional, number)**: Specifies a max number of results to get -- **`index_name` (Optional, string \| string[])**: A list of connector index names to fetch connector documents for -- **`connector_name` (Optional, string \| string[])**: A list of connector names to fetch connector documents for -- **`service_type` (Optional, string \| string[])**: A list of connector service types to fetch connector documents for -- **`include_deleted` (Optional, boolean)**: A flag to indicate if the desired connector should be fetched, even if it was soft-deleted. -- **`query` (Optional, string)**: A wildcard query string that filters connectors with matching name, description or index name - -## client.connector.post [_connector.post] -Create a connector. - -Connectors are Elasticsearch integrations that bring content from third-party data sources, which can be deployed on Elastic Cloud or hosted on your own infrastructure. -Elastic managed connectors (Native connectors) are a managed service on Elastic Cloud. -Self-managed connectors (Connector clients) are self-managed on your infrastructure. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-put) - -```ts -client.connector.post({ ... }) -``` - -### Arguments [_arguments_connector.post] - -#### Request (object) [_request_connector.post] -- **`description` (Optional, string)** -- **`index_name` (Optional, string)** -- **`is_native` (Optional, boolean)** -- **`language` (Optional, string)** -- **`name` (Optional, string)** -- **`service_type` (Optional, string)** - -## client.connector.put [_connector.put] -Create or update a connector. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-put) - -```ts -client.connector.put({ ... }) -``` - -### Arguments [_arguments_connector.put] - -#### Request (object) [_request_connector.put] -- **`connector_id` (Optional, string)**: The unique identifier of the connector to be created or updated. ID is auto-generated if not provided. -- **`description` (Optional, string)** -- **`index_name` (Optional, string)** -- **`is_native` (Optional, boolean)** -- **`language` (Optional, string)** -- **`name` (Optional, string)** -- **`service_type` (Optional, string)** - -## client.connector.syncJobCancel [_connector.sync_job_cancel] -Cancel a connector sync job. - -Cancel a connector sync job, which sets the status to cancelling and updates `cancellation_requested_at` to the current time. -The connector service is then responsible for setting the status of connector sync jobs to cancelled. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-sync-job-cancel) - -```ts -client.connector.syncJobCancel({ connector_sync_job_id }) -``` - -### Arguments [_arguments_connector.sync_job_cancel] - -#### Request (object) [_request_connector.sync_job_cancel] -- **`connector_sync_job_id` (string)**: The unique identifier of the connector sync job - -## client.connector.syncJobCheckIn [_connector.sync_job_check_in] -Check in a connector sync job. -Check in a connector sync job and set the `last_seen` field to the current time before updating it in the internal index. - -To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure. -This service runs automatically on Elastic Cloud for Elastic managed connectors. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-sync-job-check-in) - -```ts -client.connector.syncJobCheckIn({ connector_sync_job_id }) -``` - -### Arguments [_arguments_connector.sync_job_check_in] - -#### Request (object) [_request_connector.sync_job_check_in] -- **`connector_sync_job_id` (string)**: The unique identifier of the connector sync job to be checked in. - -## client.connector.syncJobClaim [_connector.sync_job_claim] -Claim a connector sync job. -This action updates the job status to `in_progress` and sets the `last_seen` and `started_at` timestamps to the current time. -Additionally, it can set the `sync_cursor` property for the sync job. - -This API is not intended for direct connector management by users. -It supports the implementation of services that utilize the connector protocol to communicate with Elasticsearch. - -To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure. -This service runs automatically on Elastic Cloud for Elastic managed connectors. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-sync-job-claim) - -```ts -client.connector.syncJobClaim({ connector_sync_job_id, worker_hostname }) -``` - -### Arguments [_arguments_connector.sync_job_claim] - -#### Request (object) [_request_connector.sync_job_claim] -- **`connector_sync_job_id` (string)**: The unique identifier of the connector sync job. -- **`worker_hostname` (string)**: The host name of the current system that will run the job. -- **`sync_cursor` (Optional, User-defined value)**: The cursor object from the last incremental sync job. -This should reference the `sync_cursor` field in the connector state for which the job runs. - -## client.connector.syncJobDelete [_connector.sync_job_delete] -Delete a connector sync job. - -Remove a connector sync job and its associated data. -This is a destructive action that is not recoverable. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-sync-job-delete) - -```ts -client.connector.syncJobDelete({ connector_sync_job_id }) -``` - -### Arguments [_arguments_connector.sync_job_delete] - -#### Request (object) [_request_connector.sync_job_delete] -- **`connector_sync_job_id` (string)**: The unique identifier of the connector sync job to be deleted - -## client.connector.syncJobError [_connector.sync_job_error] -Set a connector sync job error. -Set the `error` field for a connector sync job and set its `status` to `error`. - -To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure. -This service runs automatically on Elastic Cloud for Elastic managed connectors. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-sync-job-error) - -```ts -client.connector.syncJobError({ connector_sync_job_id, error }) -``` - -### Arguments [_arguments_connector.sync_job_error] - -#### Request (object) [_request_connector.sync_job_error] -- **`connector_sync_job_id` (string)**: The unique identifier for the connector sync job. -- **`error` (string)**: The error for the connector sync job error field. - -## client.connector.syncJobGet [_connector.sync_job_get] -Get a connector sync job. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-sync-job-get) - -```ts -client.connector.syncJobGet({ connector_sync_job_id }) -``` - -### Arguments [_arguments_connector.sync_job_get] - -#### Request (object) [_request_connector.sync_job_get] -- **`connector_sync_job_id` (string)**: The unique identifier of the connector sync job - -## client.connector.syncJobList [_connector.sync_job_list] -Get all connector sync jobs. - -Get information about all stored connector sync jobs listed by their creation date in ascending order. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-sync-job-list) - -```ts -client.connector.syncJobList({ ... }) -``` - -### Arguments [_arguments_connector.sync_job_list] - -#### Request (object) [_request_connector.sync_job_list] -- **`from` (Optional, number)**: Starting offset (default: 0) -- **`size` (Optional, number)**: Specifies a max number of results to get -- **`status` (Optional, Enum("canceling" \| "canceled" \| "completed" \| "error" \| "in_progress" \| "pending" \| "suspended"))**: A sync job status to fetch connector sync jobs for -- **`connector_id` (Optional, string)**: A connector id to fetch connector sync jobs for -- **`job_type` (Optional, Enum("full" \| "incremental" \| "access_control") \| Enum("full" \| "incremental" \| "access_control")[])**: A list of job types to fetch the sync jobs for - -## client.connector.syncJobPost [_connector.sync_job_post] -Create a connector sync job. - -Create a connector sync job document in the internal index and initialize its counters and timestamps with default values. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-sync-job-post) - -```ts -client.connector.syncJobPost({ id }) -``` - -### Arguments [_arguments_connector.sync_job_post] - -#### Request (object) [_request_connector.sync_job_post] -- **`id` (string)**: The id of the associated connector -- **`job_type` (Optional, Enum("full" \| "incremental" \| "access_control"))** -- **`trigger_method` (Optional, Enum("on_demand" \| "scheduled"))** - -## client.connector.syncJobUpdateStats [_connector.sync_job_update_stats] -Set the connector sync job stats. -Stats include: `deleted_document_count`, `indexed_document_count`, `indexed_document_volume`, and `total_document_count`. -You can also update `last_seen`. -This API is mainly used by the connector service for updating sync job information. - -To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure. -This service runs automatically on Elastic Cloud for Elastic managed connectors. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-sync-job-update-stats) - -```ts -client.connector.syncJobUpdateStats({ connector_sync_job_id, deleted_document_count, indexed_document_count, indexed_document_volume }) -``` - -### Arguments [_arguments_connector.sync_job_update_stats] - -#### Request (object) [_request_connector.sync_job_update_stats] -- **`connector_sync_job_id` (string)**: The unique identifier of the connector sync job. -- **`deleted_document_count` (number)**: The number of documents the sync job deleted. -- **`indexed_document_count` (number)**: The number of documents the sync job indexed. -- **`indexed_document_volume` (number)**: The total size of the data (in MiB) the sync job indexed. -- **`last_seen` (Optional, string \| -1 \| 0)**: The timestamp to use in the `last_seen` property for the connector sync job. -- **`metadata` (Optional, Record)**: The connector-specific metadata. -- **`total_document_count` (Optional, number)**: The total number of documents in the target index after the sync job finished. - -## client.connector.updateActiveFiltering [_connector.update_active_filtering] -Activate the connector draft filter. - -Activates the valid draft filtering for a connector. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-filtering) - -```ts -client.connector.updateActiveFiltering({ connector_id }) -``` - -### Arguments [_arguments_connector.update_active_filtering] - -#### Request (object) [_request_connector.update_active_filtering] -- **`connector_id` (string)**: The unique identifier of the connector to be updated - -## client.connector.updateApiKeyId [_connector.update_api_key_id] -Update the connector API key ID. - -Update the `api_key_id` and `api_key_secret_id` fields of a connector. -You can specify the ID of the API key used for authorization and the ID of the connector secret where the API key is stored. -The connector secret ID is required only for Elastic managed (native) connectors. -Self-managed connectors (connector clients) do not use this field. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-api-key-id) - -```ts -client.connector.updateApiKeyId({ connector_id }) -``` - -### Arguments [_arguments_connector.update_api_key_id] - -#### Request (object) [_request_connector.update_api_key_id] -- **`connector_id` (string)**: The unique identifier of the connector to be updated -- **`api_key_id` (Optional, string)** -- **`api_key_secret_id` (Optional, string)** - -## client.connector.updateConfiguration [_connector.update_configuration] -Update the connector configuration. - -Update the configuration field in the connector document. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-configuration) - -```ts -client.connector.updateConfiguration({ connector_id }) -``` - -### Arguments [_arguments_connector.update_configuration] - -#### Request (object) [_request_connector.update_configuration] -- **`connector_id` (string)**: The unique identifier of the connector to be updated -- **`configuration` (Optional, Record)** -- **`values` (Optional, Record)** - -## client.connector.updateError [_connector.update_error] -Update the connector error field. - -Set the error field for the connector. -If the error provided in the request body is non-null, the connector’s status is updated to error. -Otherwise, if the error is reset to null, the connector status is updated to connected. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-error) - -```ts -client.connector.updateError({ connector_id, error }) -``` - -### Arguments [_arguments_connector.update_error] - -#### Request (object) [_request_connector.update_error] -- **`connector_id` (string)**: The unique identifier of the connector to be updated -- **`error` (T \| null)** - -## client.connector.updateFeatures [_connector.update_features] -Update the connector features. -Update the connector features in the connector document. -This API can be used to control the following aspects of a connector: - -* document-level security -* incremental syncs -* advanced sync rules -* basic sync rules - -Normally, the running connector service automatically manages these features. -However, you can use this API to override the default behavior. - -To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure. -This service runs automatically on Elastic Cloud for Elastic managed connectors. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-features) - -```ts -client.connector.updateFeatures({ connector_id, features }) -``` - -### Arguments [_arguments_connector.update_features] - -#### Request (object) [_request_connector.update_features] -- **`connector_id` (string)**: The unique identifier of the connector to be updated. -- **`features` ({ document_level_security, incremental_sync, native_connector_api_keys, sync_rules })** - -## client.connector.updateFiltering [_connector.update_filtering] -Update the connector filtering. - -Update the draft filtering configuration of a connector and marks the draft validation state as edited. -The filtering draft is activated once validated by the running Elastic connector service. -The filtering property is used to configure sync rules (both basic and advanced) for a connector. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-filtering) - -```ts -client.connector.updateFiltering({ connector_id }) -``` - -### Arguments [_arguments_connector.update_filtering] - -#### Request (object) [_request_connector.update_filtering] -- **`connector_id` (string)**: The unique identifier of the connector to be updated -- **`filtering` (Optional, { active, domain, draft }[])** -- **`rules` (Optional, { created_at, field, id, order, policy, rule, updated_at, value }[])** -- **`advanced_snippet` (Optional, { created_at, updated_at, value })** - -## client.connector.updateFilteringValidation [_connector.update_filtering_validation] -Update the connector draft filtering validation. - -Update the draft filtering validation info for a connector. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-filtering-validation) - -```ts -client.connector.updateFilteringValidation({ connector_id, validation }) -``` - -### Arguments [_arguments_connector.update_filtering_validation] - -#### Request (object) [_request_connector.update_filtering_validation] -- **`connector_id` (string)**: The unique identifier of the connector to be updated -- **`validation` ({ errors, state })** - -## client.connector.updateIndexName [_connector.update_index_name] -Update the connector index name. - -Update the `index_name` field of a connector, specifying the index where the data ingested by the connector is stored. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-index-name) - -```ts -client.connector.updateIndexName({ connector_id, index_name }) -``` - -### Arguments [_arguments_connector.update_index_name] - -#### Request (object) [_request_connector.update_index_name] -- **`connector_id` (string)**: The unique identifier of the connector to be updated -- **`index_name` (T \| null)** - -## client.connector.updateName [_connector.update_name] -Update the connector name and description. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-name) - -```ts -client.connector.updateName({ connector_id }) -``` - -### Arguments [_arguments_connector.update_name] - -#### Request (object) [_request_connector.update_name] -- **`connector_id` (string)**: The unique identifier of the connector to be updated -- **`name` (Optional, string)** -- **`description` (Optional, string)** - -## client.connector.updateNative [_connector.update_native] -Update the connector is_native flag. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-native) - -```ts -client.connector.updateNative({ connector_id, is_native }) -``` - -### Arguments [_arguments_connector.update_native] - -#### Request (object) [_request_connector.update_native] -- **`connector_id` (string)**: The unique identifier of the connector to be updated -- **`is_native` (boolean)** - -## client.connector.updatePipeline [_connector.update_pipeline] -Update the connector pipeline. - -When you create a new connector, the configuration of an ingest pipeline is populated with default settings. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-pipeline) - -```ts -client.connector.updatePipeline({ connector_id, pipeline }) -``` - -### Arguments [_arguments_connector.update_pipeline] - -#### Request (object) [_request_connector.update_pipeline] -- **`connector_id` (string)**: The unique identifier of the connector to be updated -- **`pipeline` ({ extract_binary_content, name, reduce_whitespace, run_ml_inference })** - -## client.connector.updateScheduling [_connector.update_scheduling] -Update the connector scheduling. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-scheduling) - -```ts -client.connector.updateScheduling({ connector_id, scheduling }) -``` - -### Arguments [_arguments_connector.update_scheduling] - -#### Request (object) [_request_connector.update_scheduling] -- **`connector_id` (string)**: The unique identifier of the connector to be updated -- **`scheduling` ({ access_control, full, incremental })** - -## client.connector.updateServiceType [_connector.update_service_type] -Update the connector service type. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-service-type) - -```ts -client.connector.updateServiceType({ connector_id, service_type }) -``` - -### Arguments [_arguments_connector.update_service_type] - -#### Request (object) [_request_connector.update_service_type] -- **`connector_id` (string)**: The unique identifier of the connector to be updated -- **`service_type` (string)** - -## client.connector.updateStatus [_connector.update_status] -Update the connector status. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-status) - -```ts -client.connector.updateStatus({ connector_id, status }) -``` - -### Arguments [_arguments_connector.update_status] - -#### Request (object) [_request_connector.update_status] -- **`connector_id` (string)**: The unique identifier of the connector to be updated -- **`status` (Enum("created" \| "needs_configuration" \| "configured" \| "connected" \| "error"))** - -## client.danglingIndices.deleteDanglingIndex [_dangling_indices.delete_dangling_index] -Delete a dangling index. -If Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling. -For example, this can happen if you delete more than `cluster.indices.tombstones.size` indices while an Elasticsearch node is offline. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-dangling-indices-delete-dangling-index) - -```ts -client.danglingIndices.deleteDanglingIndex({ index_uuid, accept_data_loss }) -``` - -### Arguments [_arguments_dangling_indices.delete_dangling_index] - -#### Request (object) [_request_dangling_indices.delete_dangling_index] -- **`index_uuid` (string)**: The UUID of the index to delete. Use the get dangling indices API to find the UUID. -- **`accept_data_loss` (boolean)**: This parameter must be set to true to acknowledge that it will no longer be possible to recove data from the dangling index. -- **`master_timeout` (Optional, string \| -1 \| 0)**: Specify timeout for connection to master -- **`timeout` (Optional, string \| -1 \| 0)**: Explicit operation timeout - -## client.danglingIndices.importDanglingIndex [_dangling_indices.import_dangling_index] -Import a dangling index. - -If Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling. -For example, this can happen if you delete more than `cluster.indices.tombstones.size` indices while an Elasticsearch node is offline. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-dangling-indices-import-dangling-index) - -```ts -client.danglingIndices.importDanglingIndex({ index_uuid, accept_data_loss }) -``` - -### Arguments [_arguments_dangling_indices.import_dangling_index] - -#### Request (object) [_request_dangling_indices.import_dangling_index] -- **`index_uuid` (string)**: The UUID of the index to import. Use the get dangling indices API to locate the UUID. -- **`accept_data_loss` (boolean)**: This parameter must be set to true to import a dangling index. -Because Elasticsearch cannot know where the dangling index data came from or determine which shard copies are fresh and which are stale, it cannot guarantee that the imported data represents the latest state of the index when it was last in the cluster. -- **`master_timeout` (Optional, string \| -1 \| 0)**: Specify timeout for connection to master -- **`timeout` (Optional, string \| -1 \| 0)**: Explicit operation timeout - -## client.danglingIndices.listDanglingIndices [_dangling_indices.list_dangling_indices] -Get the dangling indices. - -If Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling. -For example, this can happen if you delete more than `cluster.indices.tombstones.size` indices while an Elasticsearch node is offline. - -Use this API to list dangling indices, which you can then import or delete. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-dangling-indices-list-dangling-indices) - -```ts -client.danglingIndices.listDanglingIndices() -``` - - -## client.enrich.deletePolicy [_enrich.delete_policy] -Delete an enrich policy. -Deletes an existing enrich policy and its enrich index. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-enrich-delete-policy) - -```ts -client.enrich.deletePolicy({ name }) -``` - -### Arguments [_arguments_enrich.delete_policy] - -#### Request (object) [_request_enrich.delete_policy] -- **`name` (string)**: Enrich policy to delete. -- **`master_timeout` (Optional, string \| -1 \| 0)**: Period to wait for a connection to the master node. - -## client.enrich.executePolicy [_enrich.execute_policy] -Run an enrich policy. -Create the enrich index for an existing enrich policy. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-enrich-execute-policy) - -```ts -client.enrich.executePolicy({ name }) -``` - -### Arguments [_arguments_enrich.execute_policy] - -#### Request (object) [_request_enrich.execute_policy] -- **`name` (string)**: Enrich policy to execute. -- **`master_timeout` (Optional, string \| -1 \| 0)**: Period to wait for a connection to the master node. -- **`wait_for_completion` (Optional, boolean)**: If `true`, the request blocks other enrich policy execution requests until complete. - -## client.enrich.getPolicy [_enrich.get_policy] -Get an enrich policy. -Returns information about an enrich policy. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-enrich-get-policy) - -```ts -client.enrich.getPolicy({ ... }) -``` - -### Arguments [_arguments_enrich.get_policy] - -#### Request (object) [_request_enrich.get_policy] -- **`name` (Optional, string \| string[])**: List of enrich policy names used to limit the request. -To return information for all enrich policies, omit this parameter. -- **`master_timeout` (Optional, string \| -1 \| 0)**: Period to wait for a connection to the master node. - -## client.enrich.putPolicy [_enrich.put_policy] -Create an enrich policy. -Creates an enrich policy. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-enrich-put-policy) - -```ts -client.enrich.putPolicy({ name }) -``` - -### Arguments [_arguments_enrich.put_policy] - -#### Request (object) [_request_enrich.put_policy] -- **`name` (string)**: Name of the enrich policy to create or update. -- **`geo_match` (Optional, { enrich_fields, indices, match_field, query, name, elasticsearch_version })**: Matches enrich data to incoming documents based on a `geo_shape` query. -- **`match` (Optional, { enrich_fields, indices, match_field, query, name, elasticsearch_version })**: Matches enrich data to incoming documents based on a `term` query. -- **`range` (Optional, { enrich_fields, indices, match_field, query, name, elasticsearch_version })**: Matches a number, date, or IP address in incoming documents to a range in the enrich index based on a `term` query. -- **`master_timeout` (Optional, string \| -1 \| 0)**: Period to wait for a connection to the master node. - -## client.enrich.stats [_enrich.stats] -Get enrich stats. -Returns enrich coordinator statistics and information about enrich policies that are currently executing. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-enrich-stats) - -```ts -client.enrich.stats({ ... }) -``` - -### Arguments [_arguments_enrich.stats] - -#### Request (object) [_request_enrich.stats] -- **`master_timeout` (Optional, string \| -1 \| 0)**: Period to wait for a connection to the master node. - -## client.eql.delete [_eql.delete] -Delete an async EQL search. -Delete an async EQL search or a stored synchronous EQL search. -The API also deletes results for the search. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-eql-delete) - -```ts -client.eql.delete({ id }) -``` - -### Arguments [_arguments_eql.delete] - -#### Request (object) [_request_eql.delete] -- **`id` (string)**: Identifier for the search to delete. -A search ID is provided in the EQL search API's response for an async search. -A search ID is also provided if the request’s `keep_on_completion` parameter is `true`. - -## client.eql.get [_eql.get] -Get async EQL search results. -Get the current status and available results for an async EQL search or a stored synchronous EQL search. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-eql-get) - -```ts -client.eql.get({ id }) -``` - -### Arguments [_arguments_eql.get] - -#### Request (object) [_request_eql.get] -- **`id` (string)**: Identifier for the search. -- **`keep_alive` (Optional, string \| -1 \| 0)**: Period for which the search and its results are stored on the cluster. -Defaults to the keep_alive value set by the search’s EQL search API request. -- **`wait_for_completion_timeout` (Optional, string \| -1 \| 0)**: Timeout duration to wait for the request to finish. -Defaults to no timeout, meaning the request waits for complete search results. - -## client.eql.getStatus [_eql.get_status] -Get the async EQL status. -Get the current status for an async EQL search or a stored synchronous EQL search without returning results. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-eql-get-status) - -```ts -client.eql.getStatus({ id }) -``` - -### Arguments [_arguments_eql.get_status] - -#### Request (object) [_request_eql.get_status] -- **`id` (string)**: Identifier for the search. - -## client.eql.search [_eql.search] -Get EQL search results. -Returns search results for an Event Query Language (EQL) query. -EQL assumes each document in a data stream or index corresponds to an event. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-eql-search) - -```ts -client.eql.search({ index, query }) -``` - -### Arguments [_arguments_eql.search] - -#### Request (object) [_request_eql.search] -- **`index` (string \| string[])**: The name of the index to scope the operation -- **`query` (string)**: EQL query you wish to run. -- **`case_sensitive` (Optional, boolean)** -- **`event_category_field` (Optional, string)**: Field containing the event classification, such as process, file, or network. -- **`tiebreaker_field` (Optional, string)**: Field used to sort hits with the same timestamp in ascending order -- **`timestamp_field` (Optional, string)**: Field containing event timestamp. Default "@timestamp" -- **`fetch_size` (Optional, number)**: Maximum number of events to search at a time for sequence queries. -- **`filter` (Optional, { bool, boosting, common, combined_fields, constant_score, dis_max, distance_feature, exists, function_score, fuzzy, geo_bounding_box, geo_distance, geo_grid, geo_polygon, geo_shape, has_child, has_parent, ids, intervals, knn, match, match_all, match_bool_prefix, match_none, match_phrase, match_phrase_prefix, more_like_this, multi_match, nested, parent_id, percolate, pinned, prefix, query_string, range, rank_feature, regexp, rule, script, script_score, semantic, shape, simple_query_string, span_containing, span_field_masking, span_first, span_multi, span_near, span_not, span_or, span_term, span_within, sparse_vector, term, terms, terms_set, text_expansion, weighted_tokens, wildcard, wrapper, type } \| { bool, boosting, common, combined_fields, constant_score, dis_max, distance_feature, exists, function_score, fuzzy, geo_bounding_box, geo_distance, geo_grid, geo_polygon, geo_shape, has_child, has_parent, ids, intervals, knn, match, match_all, match_bool_prefix, match_none, match_phrase, match_phrase_prefix, more_like_this, multi_match, nested, parent_id, percolate, pinned, prefix, query_string, range, rank_feature, regexp, rule, script, script_score, semantic, shape, simple_query_string, span_containing, span_field_masking, span_first, span_multi, span_near, span_not, span_or, span_term, span_within, sparse_vector, term, terms, terms_set, text_expansion, weighted_tokens, wildcard, wrapper, type }[])**: Query, written in Query DSL, used to filter the events on which the EQL query runs. -- **`keep_alive` (Optional, string \| -1 \| 0)** -- **`keep_on_completion` (Optional, boolean)** -- **`wait_for_completion_timeout` (Optional, string \| -1 \| 0)** -- **`allow_partial_search_results` (Optional, boolean)**: Allow query execution also in case of shard failures. -If true, the query will keep running and will return results based on the available shards. -For sequences, the behavior can be further refined using allow_partial_sequence_results -- **`allow_partial_sequence_results` (Optional, boolean)**: This flag applies only to sequences and has effect only if allow_partial_search_results=true. -If true, the sequence query will return results based on the available shards, ignoring the others. -If false, the sequence query will return successfully, but will always have empty results. -- **`size` (Optional, number)**: For basic queries, the maximum number of matching events to return. Defaults to 10 -- **`fields` (Optional, { field, format, include_unmapped } \| { field, format, include_unmapped }[])**: Array of wildcard (*) patterns. The response returns values for field names matching these patterns in the fields property of each hit. -- **`result_position` (Optional, Enum("tail" \| "head"))** -- **`runtime_mappings` (Optional, Record)** -- **`max_samples_per_key` (Optional, number)**: By default, the response of a sample query contains up to `10` samples, with one sample per unique set of join keys. Use the `size` -parameter to get a smaller or larger set of samples. To retrieve more than one sample per set of join keys, use the -`max_samples_per_key` parameter. Pipes are not supported for sample queries. -- **`allow_no_indices` (Optional, boolean)** -- **`expand_wildcards` (Optional, Enum("all" \| "open" \| "closed" \| "hidden" \| "none") \| Enum("all" \| "open" \| "closed" \| "hidden" \| "none")[])** -- **`ignore_unavailable` (Optional, boolean)**: If true, missing or closed indices are not included in the response. - -## client.esql.asyncQuery [_esql.async_query] -Run an async ES|QL query. -Asynchronously run an ES|QL (Elasticsearch query language) query, monitor its progress, and retrieve results when they become available. - -The API accepts the same parameters and request body as the synchronous query API, along with additional async related properties. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-esql-async-query) - -```ts -client.esql.asyncQuery({ query }) -``` - -### Arguments [_arguments_esql.async_query] - -#### Request (object) [_request_esql.async_query] -- **`query` (string)**: The ES|QL query API accepts an ES|QL query string in the query parameter, runs it, and returns the results. -- **`columnar` (Optional, boolean)**: By default, ES|QL returns results as rows. For example, FROM returns each individual document as one row. For the JSON, YAML, CBOR and smile formats, ES|QL can return the results in a columnar fashion where one row represents all the values of a certain column in the results. -- **`filter` (Optional, { bool, boosting, common, combined_fields, constant_score, dis_max, distance_feature, exists, function_score, fuzzy, geo_bounding_box, geo_distance, geo_grid, geo_polygon, geo_shape, has_child, has_parent, ids, intervals, knn, match, match_all, match_bool_prefix, match_none, match_phrase, match_phrase_prefix, more_like_this, multi_match, nested, parent_id, percolate, pinned, prefix, query_string, range, rank_feature, regexp, rule, script, script_score, semantic, shape, simple_query_string, span_containing, span_field_masking, span_first, span_multi, span_near, span_not, span_or, span_term, span_within, sparse_vector, term, terms, terms_set, text_expansion, weighted_tokens, wildcard, wrapper, type })**: Specify a Query DSL query in the filter parameter to filter the set of documents that an ES|QL query runs on. -- **`locale` (Optional, string)** -- **`params` (Optional, number \| number \| string \| boolean \| null[])**: To avoid any attempts of hacking or code injection, extract the values in a separate list of parameters. Use question mark placeholders (?) in the query string for each of the parameters. -- **`profile` (Optional, boolean)**: If provided and `true` the response will include an extra `profile` object -with information on how the query was executed. This information is for human debugging -and its format can change at any time but it can give some insight into the performance -of each part of the query. -- **`tables` (Optional, Record>)**: Tables to use with the LOOKUP operation. The top level key is the table -name and the next level key is the column name. -- **`include_ccs_metadata` (Optional, boolean)**: When set to `true` and performing a cross-cluster query, the response will include an extra `_clusters` -object with information about the clusters that participated in the search along with info such as shards -count. -- **`wait_for_completion_timeout` (Optional, string \| -1 \| 0)**: The period to wait for the request to finish. -By default, the request waits for 1 second for the query results. -If the query completes during this period, results are returned -Otherwise, a query ID is returned that can later be used to retrieve the results. -- **`allow_partial_results` (Optional, boolean)**: If `true`, partial results will be returned if there are shard failures, but the query can continue to execute on other clusters and shards. -If `false`, the query will fail if there are any failures. - -To override the default behavior, you can set the `esql.query.allow_partial_results` cluster setting to `false`. -- **`delimiter` (Optional, string)**: The character to use between values within a CSV row. -It is valid only for the CSV format. -- **`drop_null_columns` (Optional, boolean)**: Indicates whether columns that are entirely `null` will be removed from the `columns` and `values` portion of the results. -If `true`, the response will include an extra section under the name `all_columns` which has the name of all the columns. -- **`format` (Optional, Enum("csv" \| "json" \| "tsv" \| "txt" \| "yaml" \| "cbor" \| "smile" \| "arrow"))**: A short version of the Accept header, for example `json` or `yaml`. -- **`keep_alive` (Optional, string \| -1 \| 0)**: The period for which the query and its results are stored in the cluster. -The default period is five days. -When this period expires, the query and its results are deleted, even if the query is still ongoing. -If the `keep_on_completion` parameter is false, Elasticsearch only stores async queries that do not complete within the period set by the `wait_for_completion_timeout` parameter, regardless of this value. -- **`keep_on_completion` (Optional, boolean)**: Indicates whether the query and its results are stored in the cluster. -If false, the query and its results are stored in the cluster only if the request does not complete during the period set by the `wait_for_completion_timeout` parameter. - -## client.esql.asyncQueryDelete [_esql.async_query_delete] -Delete an async ES|QL query. -If the query is still running, it is cancelled. -Otherwise, the stored results are deleted. - -If the Elasticsearch security features are enabled, only the following users can use this API to delete a query: - -* The authenticated user that submitted the original query request -* Users with the `cancel_task` cluster privilege - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-esql-async-query-delete) - -```ts -client.esql.asyncQueryDelete({ id }) -``` - -### Arguments [_arguments_esql.async_query_delete] - -#### Request (object) [_request_esql.async_query_delete] -- **`id` (string)**: The unique identifier of the query. -A query ID is provided in the ES|QL async query API response for a query that does not complete in the designated time. -A query ID is also provided when the request was submitted with the `keep_on_completion` parameter set to `true`. - -## client.esql.asyncQueryGet [_esql.async_query_get] -Get async ES|QL query results. -Get the current status and available results or stored results for an ES|QL asynchronous query. -If the Elasticsearch security features are enabled, only the user who first submitted the ES|QL query can retrieve the results using this API. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-esql-async-query-get) - -```ts -client.esql.asyncQueryGet({ id }) -``` - -### Arguments [_arguments_esql.async_query_get] - -#### Request (object) [_request_esql.async_query_get] -- **`id` (string)**: The unique identifier of the query. -A query ID is provided in the ES|QL async query API response for a query that does not complete in the designated time. -A query ID is also provided when the request was submitted with the `keep_on_completion` parameter set to `true`. -- **`drop_null_columns` (Optional, boolean)**: Indicates whether columns that are entirely `null` will be removed from the `columns` and `values` portion of the results. -If `true`, the response will include an extra section under the name `all_columns` which has the name of all the columns. -- **`keep_alive` (Optional, string \| -1 \| 0)**: The period for which the query and its results are stored in the cluster. -When this period expires, the query and its results are deleted, even if the query is still ongoing. -- **`wait_for_completion_timeout` (Optional, string \| -1 \| 0)**: The period to wait for the request to finish. -By default, the request waits for complete query results. -If the request completes during the period specified in this parameter, complete query results are returned. -Otherwise, the response returns an `is_running` value of `true` and no results. - -## client.esql.asyncQueryStop [_esql.async_query_stop] -Stop async ES|QL query. - -This API interrupts the query execution and returns the results so far. -If the Elasticsearch security features are enabled, only the user who first submitted the ES|QL query can stop it. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-esql-async-query-stop) - -```ts -client.esql.asyncQueryStop({ id }) -``` - -### Arguments [_arguments_esql.async_query_stop] - -#### Request (object) [_request_esql.async_query_stop] -- **`id` (string)**: The unique identifier of the query. -A query ID is provided in the ES|QL async query API response for a query that does not complete in the designated time. -A query ID is also provided when the request was submitted with the `keep_on_completion` parameter set to `true`. -- **`drop_null_columns` (Optional, boolean)**: Indicates whether columns that are entirely `null` will be removed from the `columns` and `values` portion of the results. -If `true`, the response will include an extra section under the name `all_columns` which has the name of all the columns. - -## client.esql.getQuery [_esql.get_query] -Get a specific running ES|QL query information. -Returns an object extended information about a running ES|QL query. -```ts -client.esql.getQuery({ id }) -``` - -### Arguments [_arguments_esql.get_query] - -#### Request (object) [_request_esql.get_query] -- **`id` (string)**: The query ID - -## client.esql.listQueries [_esql.list_queries] -Get running ES|QL queries information. -Returns an object containing IDs and other information about the running ES|QL queries. -```ts -client.esql.listQueries() -``` - - -## client.esql.query [_esql.query] -Run an ES|QL query. -Get search results for an ES|QL (Elasticsearch query language) query. - -[Endpoint documentation](https://www.elastic.co/docs/explore-analyze/query-filter/languages/esql-rest) - -```ts -client.esql.query({ query }) -``` - -### Arguments [_arguments_esql.query] - -#### Request (object) [_request_esql.query] -- **`query` (string)**: The ES|QL query API accepts an ES|QL query string in the query parameter, runs it, and returns the results. -- **`columnar` (Optional, boolean)**: By default, ES|QL returns results as rows. For example, FROM returns each individual document as one row. For the JSON, YAML, CBOR and smile formats, ES|QL can return the results in a columnar fashion where one row represents all the values of a certain column in the results. -- **`filter` (Optional, { bool, boosting, common, combined_fields, constant_score, dis_max, distance_feature, exists, function_score, fuzzy, geo_bounding_box, geo_distance, geo_grid, geo_polygon, geo_shape, has_child, has_parent, ids, intervals, knn, match, match_all, match_bool_prefix, match_none, match_phrase, match_phrase_prefix, more_like_this, multi_match, nested, parent_id, percolate, pinned, prefix, query_string, range, rank_feature, regexp, rule, script, script_score, semantic, shape, simple_query_string, span_containing, span_field_masking, span_first, span_multi, span_near, span_not, span_or, span_term, span_within, sparse_vector, term, terms, terms_set, text_expansion, weighted_tokens, wildcard, wrapper, type })**: Specify a Query DSL query in the filter parameter to filter the set of documents that an ES|QL query runs on. -- **`locale` (Optional, string)** -- **`params` (Optional, number \| number \| string \| boolean \| null[])**: To avoid any attempts of hacking or code injection, extract the values in a separate list of parameters. Use question mark placeholders (?) in the query string for each of the parameters. -- **`profile` (Optional, boolean)**: If provided and `true` the response will include an extra `profile` object -with information on how the query was executed. This information is for human debugging -and its format can change at any time but it can give some insight into the performance -of each part of the query. -- **`tables` (Optional, Record>)**: Tables to use with the LOOKUP operation. The top level key is the table -name and the next level key is the column name. -- **`include_ccs_metadata` (Optional, boolean)**: When set to `true` and performing a cross-cluster query, the response will include an extra `_clusters` -object with information about the clusters that participated in the search along with info such as shards -count. -- **`format` (Optional, Enum("csv" \| "json" \| "tsv" \| "txt" \| "yaml" \| "cbor" \| "smile" \| "arrow"))**: A short version of the Accept header, e.g. json, yaml. -- **`delimiter` (Optional, string)**: The character to use between values within a CSV row. Only valid for the CSV format. -- **`drop_null_columns` (Optional, boolean)**: Should columns that are entirely `null` be removed from the `columns` and `values` portion of the results? -Defaults to `false`. If `true` then the response will include an extra section under the name `all_columns` which has the name of all columns. -- **`allow_partial_results` (Optional, boolean)**: If `true`, partial results will be returned if there are shard failures, but the query can continue to execute on other clusters and shards. -If `false`, the query will fail if there are any failures. - -To override the default behavior, you can set the `esql.query.allow_partial_results` cluster setting to `false`. - -## client.features.getFeatures [_features.get_features] -Get the features. -Get a list of features that can be included in snapshots using the `feature_states` field when creating a snapshot. -You can use this API to determine which feature states to include when taking a snapshot. -By default, all feature states are included in a snapshot if that snapshot includes the global state, or none if it does not. - -A feature state includes one or more system indices necessary for a given feature to function. -In order to ensure data integrity, all system indices that comprise a feature state are snapshotted and restored together. - -The features listed by this API are a combination of built-in features and features defined by plugins. -In order for a feature state to be listed in this API and recognized as a valid feature state by the create snapshot API, the plugin that defines that feature must be installed on the master node. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-features-get-features) - -```ts -client.features.getFeatures({ ... }) -``` - -### Arguments [_arguments_features.get_features] - -#### Request (object) [_request_features.get_features] -- **`master_timeout` (Optional, string \| -1 \| 0)**: Period to wait for a connection to the master node. - -## client.features.resetFeatures [_features.reset_features] -Reset the features. -Clear all of the state information stored in system indices by Elasticsearch features, including the security and machine learning indices. - -WARNING: Intended for development and testing use only. Do not reset features on a production cluster. - -Return a cluster to the same state as a new installation by resetting the feature state for all Elasticsearch features. -This deletes all state information stored in system indices. - -The response code is HTTP 200 if the state is successfully reset for all features. -It is HTTP 500 if the reset operation failed for any feature. - -Note that select features might provide a way to reset particular system indices. -Using this API resets all features, both those that are built-in and implemented as plugins. - -To list the features that will be affected, use the get features API. - -IMPORTANT: The features installed on the node you submit this request to are the features that will be reset. Run on the master node if you have any doubts about which plugins are installed on individual nodes. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-features-reset-features) - -```ts -client.features.resetFeatures({ ... }) -``` - -### Arguments [_arguments_features.reset_features] - -#### Request (object) [_request_features.reset_features] -- **`master_timeout` (Optional, string \| -1 \| 0)**: Period to wait for a connection to the master node. - -## client.fleet.globalCheckpoints [_fleet.global_checkpoints] -Get global checkpoints. - -Get the current global checkpoints for an index. -This API is designed for internal use by the Fleet server project. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-fleet) - -```ts -client.fleet.globalCheckpoints({ index }) -``` - -### Arguments [_arguments_fleet.global_checkpoints] - -#### Request (object) [_request_fleet.global_checkpoints] -- **`index` (string \| string)**: A single index or index alias that resolves to a single index. -- **`wait_for_advance` (Optional, boolean)**: A boolean value which controls whether to wait (until the timeout) for the global checkpoints -to advance past the provided `checkpoints`. -- **`wait_for_index` (Optional, boolean)**: A boolean value which controls whether to wait (until the timeout) for the target index to exist -and all primary shards be active. Can only be true when `wait_for_advance` is true. -- **`checkpoints` (Optional, number[])**: A comma separated list of previous global checkpoints. When used in combination with `wait_for_advance`, -the API will only return once the global checkpoints advances past the checkpoints. Providing an empty list -will cause Elasticsearch to immediately return the current global checkpoints. -- **`timeout` (Optional, string \| -1 \| 0)**: Period to wait for a global checkpoints to advance past `checkpoints`. - -## client.fleet.msearch [_fleet.msearch] -Run multiple Fleet searches. -Run several Fleet searches with a single API request. -The API follows the same structure as the multi search API. -However, similar to the Fleet search API, it supports the `wait_for_checkpoints` parameter. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-fleet-msearch) - -```ts -client.fleet.msearch({ ... }) -``` - -### Arguments [_arguments_fleet.msearch] - -#### Request (object) [_request_fleet.msearch] -- **`index` (Optional, string \| string)**: A single target to search. If the target is an index alias, it must resolve to a single index. -- **`searches` (Optional, { allow_no_indices, expand_wildcards, ignore_unavailable, index, preference, request_cache, routing, search_type, ccs_minimize_roundtrips, allow_partial_search_results, ignore_throttled } \| { aggregations, collapse, explain, ext, from, highlight, track_total_hits, indices_boost, docvalue_fields, knn, rank, min_score, post_filter, profile, query, rescore, retriever, script_fields, search_after, size, slice, sort, _source, fields, suggest, terminate_after, timeout, track_scores, version, seq_no_primary_term, stored_fields, pit, runtime_mappings, stats }[])** -- **`allow_no_indices` (Optional, boolean)**: If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar. -- **`ccs_minimize_roundtrips` (Optional, boolean)**: If true, network roundtrips between the coordinating node and remote clusters are minimized for cross-cluster search requests. -- **`expand_wildcards` (Optional, Enum("all" \| "open" \| "closed" \| "hidden" \| "none") \| Enum("all" \| "open" \| "closed" \| "hidden" \| "none")[])**: Type of index that wildcard expressions can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. -- **`ignore_throttled` (Optional, boolean)**: If true, concrete, expanded or aliased indices are ignored when frozen. -- **`ignore_unavailable` (Optional, boolean)**: If true, missing or closed indices are not included in the response. -- **`max_concurrent_searches` (Optional, number)**: Maximum number of concurrent searches the multi search API can execute. -- **`max_concurrent_shard_requests` (Optional, number)**: Maximum number of concurrent shard requests that each sub-search request executes per node. -- **`pre_filter_shard_size` (Optional, number)**: Defines a threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method i.e., if date filters are mandatory to match but the shard bounds and the query are disjoint. -- **`search_type` (Optional, Enum("query_then_fetch" \| "dfs_query_then_fetch"))**: Indicates whether global term and document frequencies should be used when scoring returned documents. -- **`rest_total_hits_as_int` (Optional, boolean)**: If true, hits.total are returned as an integer in the response. Defaults to false, which returns an object. -- **`typed_keys` (Optional, boolean)**: Specifies whether aggregation and suggester names should be prefixed by their respective types in the response. -- **`wait_for_checkpoints` (Optional, number[])**: A comma separated list of checkpoints. When configured, the search API will only be executed on a shard -after the relevant checkpoint has become visible for search. Defaults to an empty list which will cause -Elasticsearch to immediately execute the search. -- **`allow_partial_search_results` (Optional, boolean)**: If true, returns partial results if there are shard request timeouts or shard failures. -If false, returns an error with no partial results. -Defaults to the configured cluster setting `search.default_allow_partial_results`, which is true by default. - -## client.fleet.search [_fleet.search] -Run a Fleet search. -The purpose of the Fleet search API is to provide an API where the search will be run only -after the provided checkpoint has been processed and is visible for searches inside of Elasticsearch. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-fleet-search) - -```ts -client.fleet.search({ index }) -``` - -### Arguments [_arguments_fleet.search] - -#### Request (object) [_request_fleet.search] -- **`index` (string \| string)**: A single target to search. If the target is an index alias, it must resolve to a single index. -- **`aggregations` (Optional, Record)** -- **`collapse` (Optional, { field, inner_hits, max_concurrent_group_searches, collapse })** -- **`explain` (Optional, boolean)**: If true, returns detailed information about score computation as part of a hit. -- **`ext` (Optional, Record)**: Configuration of search extensions defined by Elasticsearch plugins. -- **`from` (Optional, number)**: Starting document offset. By default, you cannot page through more than 10,000 -hits using the from and size parameters. To page through more hits, use the -search_after parameter. -- **`highlight` (Optional, { encoder, fields })** -- **`track_total_hits` (Optional, boolean \| number)**: Number of hits matching the query to count accurately. If true, the exact -number of hits is returned at the cost of some performance. If false, the -response does not include the total number of hits matching the query. -Defaults to 10,000 hits. -- **`indices_boost` (Optional, Record[])**: Boosts the _score of documents from specified indices. -- **`docvalue_fields` (Optional, { field, format, include_unmapped }[])**: Array of wildcard (*) patterns. The request returns doc values for field -names matching these patterns in the hits.fields property of the response. -- **`min_score` (Optional, number)**: Minimum _score for matching documents. Documents with a lower _score are -not included in search results and results collected by aggregations. -- **`post_filter` (Optional, { bool, boosting, common, combined_fields, constant_score, dis_max, distance_feature, exists, function_score, fuzzy, geo_bounding_box, geo_distance, geo_grid, geo_polygon, geo_shape, has_child, has_parent, ids, intervals, knn, match, match_all, match_bool_prefix, match_none, match_phrase, match_phrase_prefix, more_like_this, multi_match, nested, parent_id, percolate, pinned, prefix, query_string, range, rank_feature, regexp, rule, script, script_score, semantic, shape, simple_query_string, span_containing, span_field_masking, span_first, span_multi, span_near, span_not, span_or, span_term, span_within, sparse_vector, term, terms, terms_set, text_expansion, weighted_tokens, wildcard, wrapper, type })** -- **`profile` (Optional, boolean)** -- **`query` (Optional, { bool, boosting, common, combined_fields, constant_score, dis_max, distance_feature, exists, function_score, fuzzy, geo_bounding_box, geo_distance, geo_grid, geo_polygon, geo_shape, has_child, has_parent, ids, intervals, knn, match, match_all, match_bool_prefix, match_none, match_phrase, match_phrase_prefix, more_like_this, multi_match, nested, parent_id, percolate, pinned, prefix, query_string, range, rank_feature, regexp, rule, script, script_score, semantic, shape, simple_query_string, span_containing, span_field_masking, span_first, span_multi, span_near, span_not, span_or, span_term, span_within, sparse_vector, term, terms, terms_set, text_expansion, weighted_tokens, wildcard, wrapper, type })**: Defines the search definition using the Query DSL. -- **`rescore` (Optional, { window_size, query, learning_to_rank } \| { window_size, query, learning_to_rank }[])** -- **`script_fields` (Optional, Record)**: Retrieve a script evaluation (based on different fields) for each hit. -- **`search_after` (Optional, number \| number \| string \| boolean \| null[])** -- **`size` (Optional, number)**: The number of hits to return. By default, you cannot page through more -than 10,000 hits using the from and size parameters. To page through more -hits, use the search_after parameter. -- **`slice` (Optional, { field, id, max })** -- **`sort` (Optional, string \| { _score, _doc, _geo_distance, _script } \| string \| { _score, _doc, _geo_distance, _script }[])** -- **`_source` (Optional, boolean \| { excludes, includes })**: Indicates which source fields are returned for matching documents. These -fields are returned in the hits._source property of the search response. -- **`fields` (Optional, { field, format, include_unmapped }[])**: Array of wildcard (*) patterns. The request returns values for field names -matching these patterns in the hits.fields property of the response. -- **`suggest` (Optional, { text })** -- **`terminate_after` (Optional, number)**: Maximum number of documents to collect for each shard. If a query reaches this -limit, Elasticsearch terminates the query early. Elasticsearch collects documents -before sorting. Defaults to 0, which does not terminate query execution early. -- **`timeout` (Optional, string)**: Specifies the period of time to wait for a response from each shard. If no response -is received before the timeout expires, the request fails and returns an error. -Defaults to no timeout. -- **`track_scores` (Optional, boolean)**: If true, calculate and return document scores, even if the scores are not used for sorting. -- **`version` (Optional, boolean)**: If true, returns document version as part of a hit. -- **`seq_no_primary_term` (Optional, boolean)**: If true, returns sequence number and primary term of the last modification -of each hit. See Optimistic concurrency control. -- **`stored_fields` (Optional, string \| string[])**: List of stored fields to return as part of a hit. If no fields are specified, -no stored fields are included in the response. If this field is specified, the _source -parameter defaults to false. You can pass _source: true to return both source fields -and stored fields in the search response. -- **`pit` (Optional, { id, keep_alive })**: Limits the search to a point in time (PIT). If you provide a PIT, you -cannot specify an in the request path. -- **`runtime_mappings` (Optional, Record)**: Defines one or more runtime fields in the search request. These fields take -precedence over mapped fields with the same name. -- **`stats` (Optional, string[])**: Stats groups to associate with the search. Each group maintains a statistics -aggregation for its associated searches. You can retrieve these stats using -the indices stats API. -- **`allow_no_indices` (Optional, boolean)** -- **`analyzer` (Optional, string)** -- **`analyze_wildcard` (Optional, boolean)** -- **`batched_reduce_size` (Optional, number)** -- **`ccs_minimize_roundtrips` (Optional, boolean)** -- **`default_operator` (Optional, Enum("and" \| "or"))** -- **`df` (Optional, string)** -- **`expand_wildcards` (Optional, Enum("all" \| "open" \| "closed" \| "hidden" \| "none") \| Enum("all" \| "open" \| "closed" \| "hidden" \| "none")[])** -- **`ignore_throttled` (Optional, boolean)** -- **`ignore_unavailable` (Optional, boolean)** -- **`lenient` (Optional, boolean)** -- **`max_concurrent_shard_requests` (Optional, number)** -- **`preference` (Optional, string)** -- **`pre_filter_shard_size` (Optional, number)** -- **`request_cache` (Optional, boolean)** -- **`routing` (Optional, string)** -- **`scroll` (Optional, string \| -1 \| 0)** -- **`search_type` (Optional, Enum("query_then_fetch" \| "dfs_query_then_fetch"))** -- **`suggest_field` (Optional, string)**: Specifies which field to use for suggestions. -- **`suggest_mode` (Optional, Enum("missing" \| "popular" \| "always"))** -- **`suggest_size` (Optional, number)** -- **`suggest_text` (Optional, string)**: The source text for which the suggestions should be returned. -- **`typed_keys` (Optional, boolean)** -- **`rest_total_hits_as_int` (Optional, boolean)** -- **`_source_excludes` (Optional, string \| string[])** -- **`_source_includes` (Optional, string \| string[])** -- **`q` (Optional, string)** -- **`wait_for_checkpoints` (Optional, number[])**: A comma separated list of checkpoints. When configured, the search API will only be executed on a shard -after the relevant checkpoint has become visible for search. Defaults to an empty list which will cause -Elasticsearch to immediately execute the search. -- **`allow_partial_search_results` (Optional, boolean)**: If true, returns partial results if there are shard request timeouts or shard failures. -If false, returns an error with no partial results. -Defaults to the configured cluster setting `search.default_allow_partial_results`, which is true by default. - -## client.graph.explore [_graph.explore] -Explore graph analytics. -Extract and summarize information about the documents and terms in an Elasticsearch data stream or index. -The easiest way to understand the behavior of this API is to use the Graph UI to explore connections. -An initial request to the `_explore` API contains a seed query that identifies the documents of interest and specifies the fields that define the vertices and connections you want to include in the graph. -Subsequent requests enable you to spider out from one more vertices of interest. -You can exclude vertices that have already been returned. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-graph) - -```ts -client.graph.explore({ index }) -``` - -### Arguments [_arguments_graph.explore] - -#### Request (object) [_request_graph.explore] -- **`index` (string \| string[])**: Name of the index. -- **`connections` (Optional, { connections, query, vertices })**: Specifies or more fields from which you want to extract terms that are associated with the specified vertices. -- **`controls` (Optional, { sample_diversity, sample_size, timeout, use_significance })**: Direct the Graph API how to build the graph. -- **`query` (Optional, { bool, boosting, common, combined_fields, constant_score, dis_max, distance_feature, exists, function_score, fuzzy, geo_bounding_box, geo_distance, geo_grid, geo_polygon, geo_shape, has_child, has_parent, ids, intervals, knn, match, match_all, match_bool_prefix, match_none, match_phrase, match_phrase_prefix, more_like_this, multi_match, nested, parent_id, percolate, pinned, prefix, query_string, range, rank_feature, regexp, rule, script, script_score, semantic, shape, simple_query_string, span_containing, span_field_masking, span_first, span_multi, span_near, span_not, span_or, span_term, span_within, sparse_vector, term, terms, terms_set, text_expansion, weighted_tokens, wildcard, wrapper, type })**: A seed query that identifies the documents of interest. Can be any valid Elasticsearch query. -- **`vertices` (Optional, { exclude, field, include, min_doc_count, shard_min_doc_count, size }[])**: Specifies one or more fields that contain the terms you want to include in the graph as vertices. -- **`routing` (Optional, string)**: Custom value used to route operations to a specific shard. -- **`timeout` (Optional, string \| -1 \| 0)**: Specifies the period of time to wait for a response from each shard. -If no response is received before the timeout expires, the request fails and returns an error. -Defaults to no timeout. - -## client.ilm.deleteLifecycle [_ilm.delete_lifecycle] -Delete a lifecycle policy. -You cannot delete policies that are currently in use. If the policy is being used to manage any indices, the request fails and returns an error. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ilm-delete-lifecycle) - -```ts -client.ilm.deleteLifecycle({ policy }) -``` - -### Arguments [_arguments_ilm.delete_lifecycle] - -#### Request (object) [_request_ilm.delete_lifecycle] -- **`policy` (string)**: Identifier for the policy. -- **`master_timeout` (Optional, string \| -1 \| 0)**: Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. -- **`timeout` (Optional, string \| -1 \| 0)**: Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. - -## client.ilm.explainLifecycle [_ilm.explain_lifecycle] -Explain the lifecycle state. -Get the current lifecycle status for one or more indices. -For data streams, the API retrieves the current lifecycle status for the stream's backing indices. - -The response indicates when the index entered each lifecycle state, provides the definition of the running phase, and information about any failures. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ilm-explain-lifecycle) - -```ts -client.ilm.explainLifecycle({ index }) -``` - -### Arguments [_arguments_ilm.explain_lifecycle] - -#### Request (object) [_request_ilm.explain_lifecycle] -- **`index` (string)**: List of data streams, indices, and aliases to target. Supports wildcards (`*`). -To target all data streams and indices, use `*` or `_all`. -- **`only_errors` (Optional, boolean)**: Filters the returned indices to only indices that are managed by ILM and are in an error state, either due to an encountering an error while executing the policy, or attempting to use a policy that does not exist. -- **`only_managed` (Optional, boolean)**: Filters the returned indices to only indices that are managed by ILM. -- **`master_timeout` (Optional, string \| -1 \| 0)**: Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. - -## client.ilm.getLifecycle [_ilm.get_lifecycle] -Get lifecycle policies. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ilm-get-lifecycle) - -```ts -client.ilm.getLifecycle({ ... }) -``` - -### Arguments [_arguments_ilm.get_lifecycle] - -#### Request (object) [_request_ilm.get_lifecycle] -- **`policy` (Optional, string)**: Identifier for the policy. -- **`master_timeout` (Optional, string \| -1 \| 0)**: Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. -- **`timeout` (Optional, string \| -1 \| 0)**: Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. - -## client.ilm.getStatus [_ilm.get_status] -Get the ILM status. - -Get the current index lifecycle management status. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ilm-get-status) - -```ts -client.ilm.getStatus() -``` - - -## client.ilm.migrateToDataTiers [_ilm.migrate_to_data_tiers] -Migrate to data tiers routing. -Switch the indices, ILM policies, and legacy, composable, and component templates from using custom node attributes and attribute-based allocation filters to using data tiers. -Optionally, delete one legacy index template. -Using node roles enables ILM to automatically move the indices between data tiers. - -Migrating away from custom node attributes routing can be manually performed. -This API provides an automated way of performing three out of the four manual steps listed in the migration guide: - -1. Stop setting the custom hot attribute on new indices. -1. Remove custom allocation settings from existing ILM policies. -1. Replace custom allocation settings from existing indices with the corresponding tier preference. - -ILM must be stopped before performing the migration. -Use the stop ILM and get ILM status APIs to wait until the reported operation mode is `STOPPED`. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ilm-migrate-to-data-tiers) - -```ts -client.ilm.migrateToDataTiers({ ... }) -``` - -### Arguments [_arguments_ilm.migrate_to_data_tiers] - -#### Request (object) [_request_ilm.migrate_to_data_tiers] -- **`legacy_template_to_delete` (Optional, string)** -- **`node_attribute` (Optional, string)** -- **`dry_run` (Optional, boolean)**: If true, simulates the migration from node attributes based allocation filters to data tiers, but does not perform the migration. -This provides a way to retrieve the indices and ILM policies that need to be migrated. -- **`master_timeout` (Optional, string \| -1 \| 0)**: The period to wait for a connection to the master node. -If no response is received before the timeout expires, the request fails and returns an error. -It can also be set to `-1` to indicate that the request should never timeout. - -## client.ilm.moveToStep [_ilm.move_to_step] -Move to a lifecycle step. -Manually move an index into a specific step in the lifecycle policy and run that step. - -WARNING: This operation can result in the loss of data. Manually moving an index into a specific step runs that step even if it has already been performed. This is a potentially destructive action and this should be considered an expert level API. - -You must specify both the current step and the step to be executed in the body of the request. -The request will fail if the current step does not match the step currently running for the index -This is to prevent the index from being moved from an unexpected step into the next step. - -When specifying the target (`next_step`) to which the index will be moved, either the name or both the action and name fields are optional. -If only the phase is specified, the index will move to the first step of the first action in the target phase. -If the phase and action are specified, the index will move to the first step of the specified action in the specified phase. -Only actions specified in the ILM policy are considered valid. -An index cannot move to a step that is not part of its policy. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ilm-move-to-step) - -```ts -client.ilm.moveToStep({ index, current_step, next_step }) -``` - -### Arguments [_arguments_ilm.move_to_step] - -#### Request (object) [_request_ilm.move_to_step] -- **`index` (string)**: The name of the index whose lifecycle step is to change -- **`current_step` ({ action, name, phase })**: The step that the index is expected to be in. -- **`next_step` ({ action, name, phase })**: The step that you want to run. - -## client.ilm.putLifecycle [_ilm.put_lifecycle] -Create or update a lifecycle policy. -If the specified policy exists, it is replaced and the policy version is incremented. - -NOTE: Only the latest version of the policy is stored, you cannot revert to previous versions. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ilm-put-lifecycle) - -```ts -client.ilm.putLifecycle({ policy }) -``` - -### Arguments [_arguments_ilm.put_lifecycle] - -#### Request (object) [_request_ilm.put_lifecycle] -- **`policy` (string)**: Identifier for the policy. -- **`master_timeout` (Optional, string \| -1 \| 0)**: Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. -- **`timeout` (Optional, string \| -1 \| 0)**: Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. - -## client.ilm.removePolicy [_ilm.remove_policy] -Remove policies from an index. -Remove the assigned lifecycle policies from an index or a data stream's backing indices. -It also stops managing the indices. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ilm-remove-policy) - -```ts -client.ilm.removePolicy({ index }) -``` - -### Arguments [_arguments_ilm.remove_policy] - -#### Request (object) [_request_ilm.remove_policy] -- **`index` (string)**: The name of the index to remove policy on - -## client.ilm.retry [_ilm.retry] -Retry a policy. -Retry running the lifecycle policy for an index that is in the ERROR step. -The API sets the policy back to the step where the error occurred and runs the step. -Use the explain lifecycle state API to determine whether an index is in the ERROR step. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ilm-retry) - -```ts -client.ilm.retry({ index }) -``` - -### Arguments [_arguments_ilm.retry] - -#### Request (object) [_request_ilm.retry] -- **`index` (string)**: The name of the indices (comma-separated) whose failed lifecycle step is to be retry - -## client.ilm.start [_ilm.start] -Start the ILM plugin. -Start the index lifecycle management plugin if it is currently stopped. -ILM is started automatically when the cluster is formed. -Restarting ILM is necessary only when it has been stopped using the stop ILM API. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ilm-start) - -```ts -client.ilm.start({ ... }) -``` - -### Arguments [_arguments_ilm.start] - -#### Request (object) [_request_ilm.start] -- **`master_timeout` (Optional, string \| -1 \| 0)**: Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. -- **`timeout` (Optional, string \| -1 \| 0)**: Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. - -## client.ilm.stop [_ilm.stop] -Stop the ILM plugin. -Halt all lifecycle management operations and stop the index lifecycle management plugin. -This is useful when you are performing maintenance on the cluster and need to prevent ILM from performing any actions on your indices. - -The API returns as soon as the stop request has been acknowledged, but the plugin might continue to run until in-progress operations complete and the plugin can be safely stopped. -Use the get ILM status API to check whether ILM is running. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ilm-stop) - -```ts -client.ilm.stop({ ... }) -``` - -### Arguments [_arguments_ilm.stop] - -#### Request (object) [_request_ilm.stop] -- **`master_timeout` (Optional, string \| -1 \| 0)**: Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. -- **`timeout` (Optional, string \| -1 \| 0)**: Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. - -## client.indices.addBlock [_indices.add_block] -Add an index block. - -Add an index block to an index. -Index blocks limit the operations allowed on an index by blocking specific operation types. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-add-block) - -```ts -client.indices.addBlock({ index, block }) -``` - -### Arguments [_arguments_indices.add_block] - -#### Request (object) [_request_indices.add_block] -- **`index` (string)**: A list or wildcard expression of index names used to limit the request. -By default, you must explicitly name the indices you are adding blocks to. -To allow the adding of blocks to indices with `_all`, `*`, or other wildcard expressions, change the `action.destructive_requires_name` setting to `false`. -You can update this setting in the `elasticsearch.yml` file or by using the cluster update settings API. -- **`block` (Enum("metadata" \| "read" \| "read_only" \| "write"))**: The block type to add to the index. -- **`allow_no_indices` (Optional, boolean)**: If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. -This behavior applies even if the request targets other open indices. -For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. -- **`expand_wildcards` (Optional, Enum("all" \| "open" \| "closed" \| "hidden" \| "none") \| Enum("all" \| "open" \| "closed" \| "hidden" \| "none")[])**: The type of index that wildcard patterns can match. -If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. -It supports a list of values, such as `open,hidden`. -- **`ignore_unavailable` (Optional, boolean)**: If `false`, the request returns an error if it targets a missing or closed index. -- **`master_timeout` (Optional, string \| -1 \| 0)**: The period to wait for the master node. -If the master node is not available before the timeout expires, the request fails and returns an error. -It can also be set to `-1` to indicate that the request should never timeout. -- **`timeout` (Optional, string \| -1 \| 0)**: The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata. -If no response is received before the timeout expires, the cluster metadata update still applies but the response will indicate that it was not completely acknowledged. -It can also be set to `-1` to indicate that the request should never timeout. - -## client.indices.analyze [_indices.analyze] -Get tokens from text analysis. -The analyze API performs analysis on a text string and returns the resulting tokens. - -Generating excessive amount of tokens may cause a node to run out of memory. -The `index.analyze.max_token_count` setting enables you to limit the number of tokens that can be produced. -If more than this limit of tokens gets generated, an error occurs. -The `_analyze` endpoint without a specified index will always use `10000` as its limit. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-analyze) - -```ts -client.indices.analyze({ ... }) -``` - -### Arguments [_arguments_indices.analyze] - -#### Request (object) [_request_indices.analyze] -- **`index` (Optional, string)**: Index used to derive the analyzer. -If specified, the `analyzer` or field parameter overrides this value. -If no index is specified or the index does not have a default analyzer, the analyze API uses the standard analyzer. -- **`analyzer` (Optional, string)**: The name of the analyzer that should be applied to the provided `text`. -This could be a built-in analyzer, or an analyzer that’s been configured in the index. -- **`attributes` (Optional, string[])**: Array of token attributes used to filter the output of the `explain` parameter. -- **`char_filter` (Optional, string \| { type, escaped_tags } \| { type, mappings, mappings_path } \| { type, flags, pattern, replacement } \| { type, mode, name, unicode_set_filter } \| { type, normalize_kana, normalize_kanji }[])**: Array of character filters used to preprocess characters before the tokenizer. -- **`explain` (Optional, boolean)**: If `true`, the response includes token attributes and additional details. -- **`field` (Optional, string)**: Field used to derive the analyzer. -To use this parameter, you must specify an index. -If specified, the `analyzer` parameter overrides this value. -- **`filter` (Optional, string \| { type } \| { type } \| { type, preserve_original } \| { type, ignored_scripts, output_unigrams } \| { type } \| { type } \| { type, common_words, common_words_path, ignore_case, query_mode } \| { type, filter, script } \| { type } \| { type, delimiter, encoding } \| { type, max_gram, min_gram, side, preserve_original } \| { type, articles, articles_path, articles_case } \| { type, max_output_size, separator } \| { type } \| { type } \| { type } \| { type, dedup, dictionary, locale, longest_only } \| { type, hyphenation_patterns_path, no_sub_matches, no_overlapping_matches } \| { type } \| { type, mode, types } \| { type, keep_words, keep_words_case, keep_words_path } \| { type, ignore_case, keywords, keywords_path, keywords_pattern } \| { type } \| { type } \| { type, max, min } \| { type, consume_all_tokens, max_token_count } \| { type, language } \| { type, bucket_count, hash_count, hash_set_size, with_rotation } \| { type, filters, preserve_original } \| { type, max_gram, min_gram, preserve_original } \| { type, stoptags } \| { type, patterns, preserve_original } \| { type, all, pattern, replacement } \| { type } \| { type } \| { type, script } \| { type } \| { type } \| { type } \| { type } \| { type } \| { type, filler_token, max_shingle_size, min_shingle_size, output_unigrams, output_unigrams_if_no_shingles, token_separator } \| { type, language } \| { type } \| { type, rules, rules_path } \| { type, language } \| { type, ignore_case, remove_trailing, stopwords, stopwords_path } \| { type } \| { type } \| { type } \| { type, length } \| { type, only_on_same_position } \| { type } \| { type, adjust_offsets, ignore_keywords } \| { type } \| { type, stopwords } \| { type, minimum_length } \| { type, use_romaji } \| { type, stoptags } \| { type, alternate, case_first, case_level, country, decomposition, hiragana_quaternary_mode, language, numeric, rules, strength, variable_top, variant } \| { type, unicode_set_filter } \| { type, name } \| { type, dir, id } \| { type, encoder, languageset, max_code_len, name_type, replace, rule_type } \| { type }[])**: Array of token filters used to apply after the tokenizer. -- **`normalizer` (Optional, string)**: Normalizer to use to convert text into a single token. -- **`text` (Optional, string \| string[])**: Text to analyze. -If an array of strings is provided, it is analyzed as a multi-value field. -- **`tokenizer` (Optional, string \| { type, tokenize_on_chars, max_token_length } \| { type, max_token_length } \| { type, custom_token_chars, max_gram, min_gram, token_chars } \| { type, buffer_size } \| { type } \| { type } \| { type, custom_token_chars, max_gram, min_gram, token_chars } \| { type, buffer_size, delimiter, replacement, reverse, skip } \| { type, flags, group, pattern } \| { type, pattern } \| { type, pattern } \| { type, max_token_length } \| { type } \| { type, max_token_length } \| { type, max_token_length } \| { type, rule_files } \| { type, discard_punctuation, mode, nbest_cost, nbest_examples, user_dictionary, user_dictionary_rules, discard_compound_token } \| { type, decompound_mode, discard_punctuation, user_dictionary, user_dictionary_rules })**: Tokenizer to use to convert text into tokens. - -## client.indices.cancelMigrateReindex [_indices.cancel_migrate_reindex] -Cancel a migration reindex operation. - -Cancel a migration reindex attempt for a data stream or index. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-cancel-migrate-reindex) - -```ts -client.indices.cancelMigrateReindex({ index }) -``` - -### Arguments [_arguments_indices.cancel_migrate_reindex] - -#### Request (object) [_request_indices.cancel_migrate_reindex] -- **`index` (string \| string[])**: The index or data stream name - -## client.indices.clearCache [_indices.clear_cache] -Clear the cache. -Clear the cache of one or more indices. -For data streams, the API clears the caches of the stream's backing indices. - -By default, the clear cache API clears all caches. -To clear only specific caches, use the `fielddata`, `query`, or `request` parameters. -To clear the cache only of specific fields, use the `fields` parameter. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-clear-cache) - -```ts -client.indices.clearCache({ ... }) -``` - -### Arguments [_arguments_indices.clear_cache] - -#### Request (object) [_request_indices.clear_cache] -- **`index` (Optional, string \| string[])**: List of data streams, indices, and aliases used to limit the request. -Supports wildcards (`*`). -To target all data streams and indices, omit this parameter or use `*` or `_all`. -- **`allow_no_indices` (Optional, boolean)**: If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. -This behavior applies even if the request targets other open indices. -- **`expand_wildcards` (Optional, Enum("all" \| "open" \| "closed" \| "hidden" \| "none") \| Enum("all" \| "open" \| "closed" \| "hidden" \| "none")[])**: Type of index that wildcard patterns can match. -If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. -Supports a list of values, such as `open,hidden`. -Valid values are: `all`, `open`, `closed`, `hidden`, `none`. -- **`fielddata` (Optional, boolean)**: If `true`, clears the fields cache. -Use the `fields` parameter to clear the cache of specific fields only. -- **`fields` (Optional, string \| string[])**: List of field names used to limit the `fielddata` parameter. -- **`ignore_unavailable` (Optional, boolean)**: If `false`, the request returns an error if it targets a missing or closed index. -- **`query` (Optional, boolean)**: If `true`, clears the query cache. -- **`request` (Optional, boolean)**: If `true`, clears the request cache. - -## client.indices.clone [_indices.clone] -Clone an index. -Clone an existing index into a new index. -Each original primary shard is cloned into a new primary shard in the new index. - -IMPORTANT: Elasticsearch does not apply index templates to the resulting index. -The API also does not copy index metadata from the original index. -Index metadata includes aliases, index lifecycle management phase definitions, and cross-cluster replication (CCR) follower information. -For example, if you clone a CCR follower index, the resulting clone will not be a follower index. - -The clone API copies most index settings from the source index to the resulting index, with the exception of `index.number_of_replicas` and `index.auto_expand_replicas`. -To set the number of replicas in the resulting index, configure these settings in the clone request. - -Cloning works as follows: - -* First, it creates a new target index with the same definition as the source index. -* Then it hard-links segments from the source index into the target index. If the file system does not support hard-linking, all segments are copied into the new index, which is a much more time consuming process. -* Finally, it recovers the target index as though it were a closed index which had just been re-opened. - -IMPORTANT: Indices can only be cloned if they meet the following requirements: - -* The index must be marked as read-only and have a cluster health status of green. -* The target index must not exist. -* The source index must have the same number of primary shards as the target index. -* The node handling the clone process must have sufficient free disk space to accommodate a second copy of the existing index. - -The current write index on a data stream cannot be cloned. -In order to clone the current write index, the data stream must first be rolled over so that a new write index is created and then the previous write index can be cloned. - -NOTE: Mappings cannot be specified in the `_clone` request. The mappings of the source index will be used for the target index. - -**Monitor the cloning process** - -The cloning process can be monitored with the cat recovery API or the cluster health API can be used to wait until all primary shards have been allocated by setting the `wait_for_status` parameter to `yellow`. - -The `_clone` API returns as soon as the target index has been added to the cluster state, before any shards have been allocated. -At this point, all shards are in the state unassigned. -If, for any reason, the target index can't be allocated, its primary shard will remain unassigned until it can be allocated on that node. - -Once the primary shard is allocated, it moves to state initializing, and the clone process begins. -When the clone operation completes, the shard will become active. -At that point, Elasticsearch will try to allocate any replicas and may decide to relocate the primary shard to another node. - -**Wait for active shards** - -Because the clone operation creates a new index to clone the shards to, the wait for active shards setting on index creation applies to the clone index action as well. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-clone) - -```ts -client.indices.clone({ index, target }) -``` - -### Arguments [_arguments_indices.clone] - -#### Request (object) [_request_indices.clone] -- **`index` (string)**: Name of the source index to clone. -- **`target` (string)**: Name of the target index to create. -- **`aliases` (Optional, Record)**: Aliases for the resulting index. -- **`settings` (Optional, Record)**: Configuration options for the target index. -- **`master_timeout` (Optional, string \| -1 \| 0)**: Period to wait for a connection to the master node. -If no response is received before the timeout expires, the request fails and returns an error. -- **`timeout` (Optional, string \| -1 \| 0)**: Period to wait for a response. -If no response is received before the timeout expires, the request fails and returns an error. -- **`wait_for_active_shards` (Optional, number \| Enum("all" \| "index-setting"))**: The number of shard copies that must be active before proceeding with the operation. -Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). - -## client.indices.close [_indices.close] -Close an index. -A closed index is blocked for read or write operations and does not allow all operations that opened indices allow. -It is not possible to index documents or to search for documents in a closed index. -Closed indices do not have to maintain internal data structures for indexing or searching documents, which results in a smaller overhead on the cluster. - -When opening or closing an index, the master node is responsible for restarting the index shards to reflect the new state of the index. -The shards will then go through the normal recovery process. -The data of opened and closed indices is automatically replicated by the cluster to ensure that enough shard copies are safely kept around at all times. - -You can open and close multiple indices. -An error is thrown if the request explicitly refers to a missing index. -This behaviour can be turned off using the `ignore_unavailable=true` parameter. - -By default, you must explicitly name the indices you are opening or closing. -To open or close indices with `_all`, `*`, or other wildcard expressions, change the` action.destructive_requires_name` setting to `false`. This setting can also be changed with the cluster update settings API. - -Closed indices consume a significant amount of disk-space which can cause problems in managed environments. -Closing indices can be turned off with the cluster settings API by setting `cluster.indices.close.enable` to `false`. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-close) - -```ts -client.indices.close({ index }) -``` - -### Arguments [_arguments_indices.close] - -#### Request (object) [_request_indices.close] -- **`index` (string \| string[])**: List or wildcard expression of index names used to limit the request. -- **`allow_no_indices` (Optional, boolean)**: If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. -This behavior applies even if the request targets other open indices. -- **`expand_wildcards` (Optional, Enum("all" \| "open" \| "closed" \| "hidden" \| "none") \| Enum("all" \| "open" \| "closed" \| "hidden" \| "none")[])**: Type of index that wildcard patterns can match. -If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. -Supports a list of values, such as `open,hidden`. -Valid values are: `all`, `open`, `closed`, `hidden`, `none`. -- **`ignore_unavailable` (Optional, boolean)**: If `false`, the request returns an error if it targets a missing or closed index. -- **`master_timeout` (Optional, string \| -1 \| 0)**: Period to wait for a connection to the master node. -If no response is received before the timeout expires, the request fails and returns an error. -- **`timeout` (Optional, string \| -1 \| 0)**: Period to wait for a response. -If no response is received before the timeout expires, the request fails and returns an error. -- **`wait_for_active_shards` (Optional, number \| Enum("all" \| "index-setting"))**: The number of shard copies that must be active before proceeding with the operation. -Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). - -## client.indices.create [_indices.create] -Create an index. -You can use the create index API to add a new index to an Elasticsearch cluster. -When creating an index, you can specify the following: - -* Settings for the index. -* Mappings for fields in the index. -* Index aliases - -**Wait for active shards** - -By default, index creation will only return a response to the client when the primary copies of each shard have been started, or the request times out. -The index creation response will indicate what happened. -For example, `acknowledged` indicates whether the index was successfully created in the cluster, `while shards_acknowledged` indicates whether the requisite number of shard copies were started for each shard in the index before timing out. -Note that it is still possible for either `acknowledged` or `shards_acknowledged` to be `false`, but for the index creation to be successful. -These values simply indicate whether the operation completed before the timeout. -If `acknowledged` is false, the request timed out before the cluster state was updated with the newly created index, but it probably will be created sometime soon. -If `shards_acknowledged` is false, then the request timed out before the requisite number of shards were started (by default just the primaries), even if the cluster state was successfully updated to reflect the newly created index (that is to say, `acknowledged` is `true`). - -You can change the default of only waiting for the primary shards to start through the index setting `index.write.wait_for_active_shards`. -Note that changing this setting will also affect the `wait_for_active_shards` value on all subsequent write operations. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-create) - -```ts -client.indices.create({ index }) -``` - -### Arguments [_arguments_indices.create] - -#### Request (object) [_request_indices.create] -- **`index` (string)**: Name of the index you wish to create. -Index names must meet the following criteria: - -* Lowercase only -* Cannot include `\`, `/`, `*`, `?`, `"`, `<`, `>`, `|`, ` ` (space character), `,`, or `#` -* Indices prior to 7.0 could contain a colon (`:`), but that has been deprecated and will not be supported in later versions -* Cannot start with `-`, `_`, or `+` -* Cannot be `.` or `..` -* Cannot be longer than 255 bytes (note thtat it is bytes, so multi-byte characters will reach the limit faster) -* Names starting with `.` are deprecated, except for hidden indices and internal indices managed by plugins -- **`aliases` (Optional, Record)**: Aliases for the index. -- **`mappings` (Optional, { all_field, date_detection, dynamic, dynamic_date_formats, dynamic_templates, _field_names, index_field, _meta, numeric_detection, properties, _routing, _size, _source, runtime, enabled, subobjects, _data_stream_timestamp })**: Mapping for fields in the index. If specified, this mapping can include: -- Field names -- Field data types -- Mapping parameters -- **`settings` (Optional, { index, mode, routing_path, soft_deletes, sort, number_of_shards, number_of_replicas, number_of_routing_shards, check_on_startup, codec, routing_partition_size, load_fixed_bitset_filters_eagerly, hidden, auto_expand_replicas, merge, search, refresh_interval, max_result_window, max_inner_result_window, max_rescore_window, max_docvalue_fields_search, max_script_fields, max_ngram_diff, max_shingle_diff, blocks, max_refresh_listeners, analyze, highlight, max_terms_count, max_regex_length, routing, gc_deletes, default_pipeline, final_pipeline, lifecycle, provided_name, creation_date, creation_date_string, uuid, version, verified_before_close, format, max_slices_per_scroll, translog, query_string, priority, top_metrics_max_size, analysis, settings, time_series, queries, similarity, mapping, indexing.slowlog, indexing_pressure, store })**: Configuration options for the index. -- **`master_timeout` (Optional, string \| -1 \| 0)**: Period to wait for a connection to the master node. -If no response is received before the timeout expires, the request fails and returns an error. -- **`timeout` (Optional, string \| -1 \| 0)**: Period to wait for a response. -If no response is received before the timeout expires, the request fails and returns an error. -- **`wait_for_active_shards` (Optional, number \| Enum("all" \| "index-setting"))**: The number of shard copies that must be active before proceeding with the operation. -Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). - -## client.indices.createDataStream [_indices.create_data_stream] -Create a data stream. - -You must have a matching index template with data stream enabled. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-create-data-stream) - -```ts -client.indices.createDataStream({ name }) -``` - -### Arguments [_arguments_indices.create_data_stream] - -#### Request (object) [_request_indices.create_data_stream] -- **`name` (string)**: Name of the data stream, which must meet the following criteria: -Lowercase only; -Cannot include `\`, `/`, `*`, `?`, `"`, `<`, `>`, `|`, `,`, `#`, `:`, or a space character; -Cannot start with `-`, `_`, `+`, or `.ds-`; -Cannot be `.` or `..`; -Cannot be longer than 255 bytes. Multi-byte characters count towards this limit faster. -- **`master_timeout` (Optional, string \| -1 \| 0)**: Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. -- **`timeout` (Optional, string \| -1 \| 0)**: Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. - -## client.indices.createFrom [_indices.create_from] -Create an index from a source index. - -Copy the mappings and settings from the source index to a destination index while allowing request settings and mappings to override the source values. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-create-from) - -```ts -client.indices.createFrom({ source, dest }) -``` - -### Arguments [_arguments_indices.create_from] - -#### Request (object) [_request_indices.create_from] -- **`source` (string)**: The source index or data stream name -- **`dest` (string)**: The destination index or data stream name -- **`create_from` (Optional, { mappings_override, settings_override, remove_index_blocks })** - -## client.indices.dataStreamsStats [_indices.data_streams_stats] -Get data stream stats. - -Get statistics for one or more data streams. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-data-streams-stats-1) - -```ts -client.indices.dataStreamsStats({ ... }) -``` - -### Arguments [_arguments_indices.data_streams_stats] - -#### Request (object) [_request_indices.data_streams_stats] -- **`name` (Optional, string)**: List of data streams used to limit the request. -Wildcard expressions (`*`) are supported. -To target all data streams in a cluster, omit this parameter or use `*`. -- **`expand_wildcards` (Optional, Enum("all" \| "open" \| "closed" \| "hidden" \| "none") \| Enum("all" \| "open" \| "closed" \| "hidden" \| "none")[])**: Type of data stream that wildcard patterns can match. -Supports a list of values, such as `open,hidden`. - -## client.indices.delete [_indices.delete] -Delete indices. -Deleting an index deletes its documents, shards, and metadata. -It does not delete related Kibana components, such as data views, visualizations, or dashboards. - -You cannot delete the current write index of a data stream. -To delete the index, you must roll over the data stream so a new write index is created. -You can then use the delete index API to delete the previous write index. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-delete) - -```ts -client.indices.delete({ index }) -``` - -### Arguments [_arguments_indices.delete] - -#### Request (object) [_request_indices.delete] -- **`index` (string \| string[])**: List of indices to delete. -You cannot specify index aliases. -By default, this parameter does not support wildcards (`*`) or `_all`. -To use wildcards or `_all`, set the `action.destructive_requires_name` cluster setting to `false`. -- **`allow_no_indices` (Optional, boolean)**: If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. -This behavior applies even if the request targets other open indices. -- **`expand_wildcards` (Optional, Enum("all" \| "open" \| "closed" \| "hidden" \| "none") \| Enum("all" \| "open" \| "closed" \| "hidden" \| "none")[])**: Type of index that wildcard patterns can match. -If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. -Supports a list of values, such as `open,hidden`. -Valid values are: `all`, `open`, `closed`, `hidden`, `none`. -- **`ignore_unavailable` (Optional, boolean)**: If `false`, the request returns an error if it targets a missing or closed index. -- **`master_timeout` (Optional, string \| -1 \| 0)**: Period to wait for a connection to the master node. -If no response is received before the timeout expires, the request fails and returns an error. -- **`timeout` (Optional, string \| -1 \| 0)**: Period to wait for a response. -If no response is received before the timeout expires, the request fails and returns an error. - -## client.indices.deleteAlias [_indices.delete_alias] -Delete an alias. -Removes a data stream or index from an alias. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-delete-alias) - -```ts -client.indices.deleteAlias({ index, name }) -``` - -### Arguments [_arguments_indices.delete_alias] - -#### Request (object) [_request_indices.delete_alias] -- **`index` (string \| string[])**: List of data streams or indices used to limit the request. -Supports wildcards (`*`). -- **`name` (string \| string[])**: List of aliases to remove. -Supports wildcards (`*`). To remove all aliases, use `*` or `_all`. -- **`master_timeout` (Optional, string \| -1 \| 0)**: Period to wait for a connection to the master node. -If no response is received before the timeout expires, the request fails and returns an error. -- **`timeout` (Optional, string \| -1 \| 0)**: Period to wait for a response. -If no response is received before the timeout expires, the request fails and returns an error. - -## client.indices.deleteDataLifecycle [_indices.delete_data_lifecycle] -Delete data stream lifecycles. -Removes the data stream lifecycle from a data stream, rendering it not managed by the data stream lifecycle. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-delete-data-lifecycle) - -```ts -client.indices.deleteDataLifecycle({ name }) -``` - -### Arguments [_arguments_indices.delete_data_lifecycle] - -#### Request (object) [_request_indices.delete_data_lifecycle] -- **`name` (string \| string[])**: A list of data streams of which the data stream lifecycle will be deleted; use `*` to get all data streams -- **`expand_wildcards` (Optional, Enum("all" \| "open" \| "closed" \| "hidden" \| "none") \| Enum("all" \| "open" \| "closed" \| "hidden" \| "none")[])**: Whether wildcard expressions should get expanded to open or closed indices (default: open) -- **`master_timeout` (Optional, string \| -1 \| 0)**: Specify timeout for connection to master -- **`timeout` (Optional, string \| -1 \| 0)**: Explicit timestamp for the document - -## client.indices.deleteDataStream [_indices.delete_data_stream] -Delete data streams. -Deletes one or more data streams and their backing indices. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-delete-data-stream) - -```ts -client.indices.deleteDataStream({ name }) -``` - -### Arguments [_arguments_indices.delete_data_stream] - -#### Request (object) [_request_indices.delete_data_stream] -- **`name` (string \| string[])**: List of data streams to delete. Wildcard (`*`) expressions are supported. -- **`master_timeout` (Optional, string \| -1 \| 0)**: Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. -- **`expand_wildcards` (Optional, Enum("all" \| "open" \| "closed" \| "hidden" \| "none") \| Enum("all" \| "open" \| "closed" \| "hidden" \| "none")[])**: Type of data stream that wildcard patterns can match. Supports a list of values,such as `open,hidden`. - -## client.indices.deleteDataStreamOptions [_indices.delete_data_stream_options] -Deletes the data stream options of the selected data streams. - -[Endpoint documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html) - -```ts -client.indices.deleteDataStreamOptions() -``` - - -## client.indices.deleteIndexTemplate [_indices.delete_index_template] -Delete an index template. -The provided may contain multiple template names separated by a comma. If multiple template -names are specified then there is no wildcard support and the provided names should match completely with -existing templates. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-delete-index-template) - -```ts -client.indices.deleteIndexTemplate({ name }) -``` - -### Arguments [_arguments_indices.delete_index_template] - -#### Request (object) [_request_indices.delete_index_template] -- **`name` (string \| string[])**: List of index template names used to limit the request. Wildcard (*) expressions are supported. -- **`master_timeout` (Optional, string \| -1 \| 0)**: Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. -- **`timeout` (Optional, string \| -1 \| 0)**: Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. - -## client.indices.deleteTemplate [_indices.delete_template] -Delete a legacy index template. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-delete-template) - -```ts -client.indices.deleteTemplate({ name }) -``` - -### Arguments [_arguments_indices.delete_template] - -#### Request (object) [_request_indices.delete_template] -- **`name` (string)**: The name of the legacy index template to delete. -Wildcard (`*`) expressions are supported. -- **`master_timeout` (Optional, string \| -1 \| 0)**: Period to wait for a connection to the master node. -If no response is received before the timeout expires, the request fails and returns an error. -- **`timeout` (Optional, string \| -1 \| 0)**: Period to wait for a response. -If no response is received before the timeout expires, the request fails and returns an error. - -## client.indices.diskUsage [_indices.disk_usage] -Analyze the index disk usage. -Analyze the disk usage of each field of an index or data stream. -This API might not support indices created in previous Elasticsearch versions. -The result of a small index can be inaccurate as some parts of an index might not be analyzed by the API. - -NOTE: The total size of fields of the analyzed shards of the index in the response is usually smaller than the index `store_size` value because some small metadata files are ignored and some parts of data files might not be scanned by the API. -Since stored fields are stored together in a compressed format, the sizes of stored fields are also estimates and can be inaccurate. -The stored size of the `_id` field is likely underestimated while the `_source` field is overestimated. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-disk-usage) - -```ts -client.indices.diskUsage({ index }) -``` - -### Arguments [_arguments_indices.disk_usage] - -#### Request (object) [_request_indices.disk_usage] -- **`index` (string \| string[])**: List of data streams, indices, and aliases used to limit the request. -It’s recommended to execute this API with a single index (or the latest backing index of a data stream) as the API consumes resources significantly. -- **`allow_no_indices` (Optional, boolean)**: If false, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. -This behavior applies even if the request targets other open indices. -For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. -- **`expand_wildcards` (Optional, Enum("all" \| "open" \| "closed" \| "hidden" \| "none") \| Enum("all" \| "open" \| "closed" \| "hidden" \| "none")[])**: Type of index that wildcard patterns can match. -If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. -Supports a list of values, such as `open,hidden`. -- **`flush` (Optional, boolean)**: If `true`, the API performs a flush before analysis. -If `false`, the response may not include uncommitted data. -- **`ignore_unavailable` (Optional, boolean)**: If `true`, missing or closed indices are not included in the response. -- **`run_expensive_tasks` (Optional, boolean)**: Analyzing field disk usage is resource-intensive. -To use the API, this parameter must be set to `true`. - -## client.indices.downsample [_indices.downsample] -Downsample an index. -Aggregate a time series (TSDS) index and store pre-computed statistical summaries (`min`, `max`, `sum`, `value_count` and `avg`) for each metric field grouped by a configured time interval. -For example, a TSDS index that contains metrics sampled every 10 seconds can be downsampled to an hourly index. -All documents within an hour interval are summarized and stored as a single document in the downsample index. - -NOTE: Only indices in a time series data stream are supported. -Neither field nor document level security can be defined on the source index. -The source index must be read only (`index.blocks.write: true`). - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-downsample) - -```ts -client.indices.downsample({ index, target_index }) -``` - -### Arguments [_arguments_indices.downsample] - -#### Request (object) [_request_indices.downsample] -- **`index` (string)**: Name of the time series index to downsample. -- **`target_index` (string)**: Name of the index to create. -- **`config` (Optional, { fixed_interval })** - -## client.indices.exists [_indices.exists] -Check indices. -Check if one or more indices, index aliases, or data streams exist. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-exists) - -```ts -client.indices.exists({ index }) -``` - -### Arguments [_arguments_indices.exists] - -#### Request (object) [_request_indices.exists] -- **`index` (string \| string[])**: List of data streams, indices, and aliases. Supports wildcards (`*`). -- **`allow_no_indices` (Optional, boolean)**: If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. -This behavior applies even if the request targets other open indices. -- **`expand_wildcards` (Optional, Enum("all" \| "open" \| "closed" \| "hidden" \| "none") \| Enum("all" \| "open" \| "closed" \| "hidden" \| "none")[])**: Type of index that wildcard patterns can match. -If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. -Supports a list of values, such as `open,hidden`. -Valid values are: `all`, `open`, `closed`, `hidden`, `none`. -- **`flat_settings` (Optional, boolean)**: If `true`, returns settings in flat format. -- **`ignore_unavailable` (Optional, boolean)**: If `false`, the request returns an error if it targets a missing or closed index. -- **`include_defaults` (Optional, boolean)**: If `true`, return all default settings in the response. -- **`local` (Optional, boolean)**: If `true`, the request retrieves information from the local node only. - -## client.indices.existsAlias [_indices.exists_alias] -Check aliases. - -Check if one or more data stream or index aliases exist. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-exists-alias) - -```ts -client.indices.existsAlias({ name }) -``` - -### Arguments [_arguments_indices.exists_alias] - -#### Request (object) [_request_indices.exists_alias] -- **`name` (string \| string[])**: List of aliases to check. Supports wildcards (`*`). -- **`index` (Optional, string \| string[])**: List of data streams or indices used to limit the request. Supports wildcards (`*`). -To target all data streams and indices, omit this parameter or use `*` or `_all`. -- **`allow_no_indices` (Optional, boolean)**: If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. -This behavior applies even if the request targets other open indices. -- **`expand_wildcards` (Optional, Enum("all" \| "open" \| "closed" \| "hidden" \| "none") \| Enum("all" \| "open" \| "closed" \| "hidden" \| "none")[])**: Type of index that wildcard patterns can match. -If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. -Supports a list of values, such as `open,hidden`. -Valid values are: `all`, `open`, `closed`, `hidden`, `none`. -- **`ignore_unavailable` (Optional, boolean)**: If `false`, requests that include a missing data stream or index in the target indices or data streams return an error. -- **`master_timeout` (Optional, string \| -1 \| 0)**: Period to wait for a connection to the master node. -If no response is received before the timeout expires, the request fails and returns an error. - -## client.indices.existsIndexTemplate [_indices.exists_index_template] -Check index templates. - -Check whether index templates exist. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-exists-index-template) - -```ts -client.indices.existsIndexTemplate({ name }) -``` - -### Arguments [_arguments_indices.exists_index_template] - -#### Request (object) [_request_indices.exists_index_template] -- **`name` (string)**: List of index template names used to limit the request. Wildcard (*) expressions are supported. -- **`local` (Optional, boolean)**: If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node. -- **`flat_settings` (Optional, boolean)**: If true, returns settings in flat format. -- **`master_timeout` (Optional, string \| -1 \| 0)**: Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. - -## client.indices.existsTemplate [_indices.exists_template] -Check existence of index templates. -Get information about whether index templates exist. -Index templates define settings, mappings, and aliases that can be applied automatically to new indices. - -IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-exists-template) - -```ts -client.indices.existsTemplate({ name }) -``` - -### Arguments [_arguments_indices.exists_template] - -#### Request (object) [_request_indices.exists_template] -- **`name` (string \| string[])**: A list of index template names used to limit the request. -Wildcard (`*`) expressions are supported. -- **`flat_settings` (Optional, boolean)**: Indicates whether to use a flat format for the response. -- **`local` (Optional, boolean)**: Indicates whether to get information from the local node only. -- **`master_timeout` (Optional, string \| -1 \| 0)**: The period to wait for the master node. -If the master node is not available before the timeout expires, the request fails and returns an error. -To indicate that the request should never timeout, set it to `-1`. - -## client.indices.explainDataLifecycle [_indices.explain_data_lifecycle] -Get the status for a data stream lifecycle. -Get information about an index or data stream's current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-explain-data-lifecycle) - -```ts -client.indices.explainDataLifecycle({ index }) -``` - -### Arguments [_arguments_indices.explain_data_lifecycle] - -#### Request (object) [_request_indices.explain_data_lifecycle] -- **`index` (string \| string[])**: The name of the index to explain -- **`include_defaults` (Optional, boolean)**: indicates if the API should return the default values the system uses for the index's lifecycle -- **`master_timeout` (Optional, string \| -1 \| 0)**: Specify timeout for connection to master - -## client.indices.fieldUsageStats [_indices.field_usage_stats] -Get field usage stats. -Get field usage information for each shard and field of an index. -Field usage statistics are automatically captured when queries are running on a cluster. -A shard-level search request that accesses a given field, even if multiple times during that request, is counted as a single use. - -The response body reports the per-shard usage count of the data structures that back the fields in the index. -A given request will increment each count by a maximum value of 1, even if the request accesses the same field multiple times. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-field-usage-stats) - -```ts -client.indices.fieldUsageStats({ index }) -``` - -### Arguments [_arguments_indices.field_usage_stats] - -#### Request (object) [_request_indices.field_usage_stats] -- **`index` (string \| string[])**: List or wildcard expression of index names used to limit the request. -- **`allow_no_indices` (Optional, boolean)**: If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. -This behavior applies even if the request targets other open indices. -For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. -- **`expand_wildcards` (Optional, Enum("all" \| "open" \| "closed" \| "hidden" \| "none") \| Enum("all" \| "open" \| "closed" \| "hidden" \| "none")[])**: Type of index that wildcard patterns can match. -If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. -Supports a list of values, such as `open,hidden`. -- **`ignore_unavailable` (Optional, boolean)**: If `true`, missing or closed indices are not included in the response. -- **`fields` (Optional, string \| string[])**: List or wildcard expressions of fields to include in the statistics. - -## client.indices.flush [_indices.flush] -Flush data streams or indices. -Flushing a data stream or index is the process of making sure that any data that is currently only stored in the transaction log is also permanently stored in the Lucene index. -When restarting, Elasticsearch replays any unflushed operations from the transaction log into the Lucene index to bring it back into the state that it was in before the restart. -Elasticsearch automatically triggers flushes as needed, using heuristics that trade off the size of the unflushed transaction log against the cost of performing each flush. - -After each operation has been flushed it is permanently stored in the Lucene index. -This may mean that there is no need to maintain an additional copy of it in the transaction log. -The transaction log is made up of multiple files, called generations, and Elasticsearch will delete any generation files when they are no longer needed, freeing up disk space. - -It is also possible to trigger a flush on one or more indices using the flush API, although it is rare for users to need to call this API directly. -If you call the flush API after indexing some documents then a successful response indicates that Elasticsearch has flushed all the documents that were indexed before the flush API was called. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-flush) - -```ts -client.indices.flush({ ... }) -``` - -### Arguments [_arguments_indices.flush] - -#### Request (object) [_request_indices.flush] -- **`index` (Optional, string \| string[])**: List of data streams, indices, and aliases to flush. -Supports wildcards (`*`). -To flush all data streams and indices, omit this parameter or use `*` or `_all`. -- **`allow_no_indices` (Optional, boolean)**: If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. -This behavior applies even if the request targets other open indices. -- **`expand_wildcards` (Optional, Enum("all" \| "open" \| "closed" \| "hidden" \| "none") \| Enum("all" \| "open" \| "closed" \| "hidden" \| "none")[])**: Type of index that wildcard patterns can match. -If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. -Supports a list of values, such as `open,hidden`. -Valid values are: `all`, `open`, `closed`, `hidden`, `none`. -- **`force` (Optional, boolean)**: If `true`, the request forces a flush even if there are no changes to commit to the index. -- **`ignore_unavailable` (Optional, boolean)**: If `false`, the request returns an error if it targets a missing or closed index. -- **`wait_if_ongoing` (Optional, boolean)**: If `true`, the flush operation blocks until execution when another flush operation is running. -If `false`, Elasticsearch returns an error if you request a flush when another flush operation is running. - -## client.indices.forcemerge [_indices.forcemerge] -Force a merge. -Perform the force merge operation on the shards of one or more indices. -For data streams, the API forces a merge on the shards of the stream's backing indices. - -Merging reduces the number of segments in each shard by merging some of them together and also frees up the space used by deleted documents. -Merging normally happens automatically, but sometimes it is useful to trigger a merge manually. - -WARNING: We recommend force merging only a read-only index (meaning the index is no longer receiving writes). -When documents are updated or deleted, the old version is not immediately removed but instead soft-deleted and marked with a "tombstone". -These soft-deleted documents are automatically cleaned up during regular segment merges. -But force merge can cause very large (greater than 5 GB) segments to be produced, which are not eligible for regular merges. -So the number of soft-deleted documents can then grow rapidly, resulting in higher disk usage and worse search performance. -If you regularly force merge an index receiving writes, this can also make snapshots more expensive, since the new documents can't be backed up incrementally. - -**Blocks during a force merge** - -Calls to this API block until the merge is complete (unless request contains `wait_for_completion=false`). -If the client connection is lost before completion then the force merge process will continue in the background. -Any new requests to force merge the same indices will also block until the ongoing force merge is complete. - -**Running force merge asynchronously** - -If the request contains `wait_for_completion=false`, Elasticsearch performs some preflight checks, launches the request, and returns a task you can use to get the status of the task. -However, you can not cancel this task as the force merge task is not cancelable. -Elasticsearch creates a record of this task as a document at `_tasks/`. -When you are done with a task, you should delete the task document so Elasticsearch can reclaim the space. - -**Force merging multiple indices** - -You can force merge multiple indices with a single request by targeting: - -* One or more data streams that contain multiple backing indices -* Multiple indices -* One or more aliases -* All data streams and indices in a cluster - -Each targeted shard is force-merged separately using the force_merge threadpool. -By default each node only has a single `force_merge` thread which means that the shards on that node are force-merged one at a time. -If you expand the `force_merge` threadpool on a node then it will force merge its shards in parallel - -Force merge makes the storage for the shard being merged temporarily increase, as it may require free space up to triple its size in case `max_num_segments parameter` is set to `1`, to rewrite all segments into a new one. - -**Data streams and time-based indices** - -Force-merging is useful for managing a data stream's older backing indices and other time-based indices, particularly after a rollover. -In these cases, each index only receives indexing traffic for a certain period of time. -Once an index receive no more writes, its shards can be force-merged to a single segment. -This can be a good idea because single-segment shards can sometimes use simpler and more efficient data structures to perform searches. -For example: - -``` -POST /.ds-my-data-stream-2099.03.07-000001/_forcemerge?max_num_segments=1 -``` - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-forcemerge) - -```ts -client.indices.forcemerge({ ... }) -``` - -### Arguments [_arguments_indices.forcemerge] - -#### Request (object) [_request_indices.forcemerge] -- **`index` (Optional, string \| string[])**: A list of index names; use `_all` or empty string to perform the operation on all indices -- **`allow_no_indices` (Optional, boolean)**: Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) -- **`expand_wildcards` (Optional, Enum("all" \| "open" \| "closed" \| "hidden" \| "none") \| Enum("all" \| "open" \| "closed" \| "hidden" \| "none")[])**: Whether to expand wildcard expression to concrete indices that are open, closed or both. -- **`flush` (Optional, boolean)**: Specify whether the index should be flushed after performing the operation (default: true) -- **`ignore_unavailable` (Optional, boolean)**: Whether specified concrete indices should be ignored when unavailable (missing or closed) -- **`max_num_segments` (Optional, number)**: The number of segments the index should be merged into (default: dynamic) -- **`only_expunge_deletes` (Optional, boolean)**: Specify whether the operation should only expunge deleted documents -- **`wait_for_completion` (Optional, boolean)**: Should the request wait until the force merge is completed. - -## client.indices.get [_indices.get] -Get index information. -Get information about one or more indices. For data streams, the API returns information about the -stream’s backing indices. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get) - -```ts -client.indices.get({ index }) -``` - -### Arguments [_arguments_indices.get] - -#### Request (object) [_request_indices.get] -- **`index` (string \| string[])**: List of data streams, indices, and index aliases used to limit the request. -Wildcard expressions (*) are supported. -- **`allow_no_indices` (Optional, boolean)**: If false, the request returns an error if any wildcard expression, index alias, or _all value targets only -missing or closed indices. This behavior applies even if the request targets other open indices. For example, -a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar. -- **`expand_wildcards` (Optional, Enum("all" \| "open" \| "closed" \| "hidden" \| "none") \| Enum("all" \| "open" \| "closed" \| "hidden" \| "none")[])**: Type of index that wildcard expressions can match. If the request can target data streams, this argument -determines whether wildcard expressions match hidden data streams. Supports a list of values, -such as open,hidden. -- **`flat_settings` (Optional, boolean)**: If true, returns settings in flat format. -- **`ignore_unavailable` (Optional, boolean)**: If false, requests that target a missing index return an error. -- **`include_defaults` (Optional, boolean)**: If true, return all default settings in the response. -- **`local` (Optional, boolean)**: If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node. -- **`master_timeout` (Optional, string \| -1 \| 0)**: Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. -- **`features` (Optional, { name, description } \| { name, description }[])**: Return only information on specified index features - -## client.indices.getAlias [_indices.get_alias] -Get aliases. -Retrieves information for one or more data stream or index aliases. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-alias) - -```ts -client.indices.getAlias({ ... }) -``` - -### Arguments [_arguments_indices.get_alias] - -#### Request (object) [_request_indices.get_alias] -- **`name` (Optional, string \| string[])**: List of aliases to retrieve. -Supports wildcards (`*`). -To retrieve all aliases, omit this parameter or use `*` or `_all`. -- **`index` (Optional, string \| string[])**: List of data streams or indices used to limit the request. -Supports wildcards (`*`). -To target all data streams and indices, omit this parameter or use `*` or `_all`. -- **`allow_no_indices` (Optional, boolean)**: If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. -This behavior applies even if the request targets other open indices. -- **`expand_wildcards` (Optional, Enum("all" \| "open" \| "closed" \| "hidden" \| "none") \| Enum("all" \| "open" \| "closed" \| "hidden" \| "none")[])**: Type of index that wildcard patterns can match. -If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. -Supports a list of values, such as `open,hidden`. -Valid values are: `all`, `open`, `closed`, `hidden`, `none`. -- **`ignore_unavailable` (Optional, boolean)**: If `false`, the request returns an error if it targets a missing or closed index. -- **`master_timeout` (Optional, string \| -1 \| 0)**: Period to wait for a connection to the master node. -If no response is received before the timeout expires, the request fails and returns an error. - -## client.indices.getDataLifecycle [_indices.get_data_lifecycle] -Get data stream lifecycles. - -Get the data stream lifecycle configuration of one or more data streams. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-data-lifecycle) - -```ts -client.indices.getDataLifecycle({ name }) -``` - -### Arguments [_arguments_indices.get_data_lifecycle] - -#### Request (object) [_request_indices.get_data_lifecycle] -- **`name` (string \| string[])**: List of data streams to limit the request. -Supports wildcards (`*`). -To target all data streams, omit this parameter or use `*` or `_all`. -- **`expand_wildcards` (Optional, Enum("all" \| "open" \| "closed" \| "hidden" \| "none") \| Enum("all" \| "open" \| "closed" \| "hidden" \| "none")[])**: Type of data stream that wildcard patterns can match. -Supports a list of values, such as `open,hidden`. -Valid values are: `all`, `open`, `closed`, `hidden`, `none`. -- **`include_defaults` (Optional, boolean)**: If `true`, return all default settings in the response. -- **`master_timeout` (Optional, string \| -1 \| 0)**: Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. - -## client.indices.getDataLifecycleStats [_indices.get_data_lifecycle_stats] -Get data stream lifecycle stats. -Get statistics about the data streams that are managed by a data stream lifecycle. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-data-lifecycle-stats) - -```ts -client.indices.getDataLifecycleStats() -``` - - -## client.indices.getDataStream [_indices.get_data_stream] -Get data streams. - -Get information about one or more data streams. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-data-stream) - -```ts -client.indices.getDataStream({ ... }) -``` - -### Arguments [_arguments_indices.get_data_stream] - -#### Request (object) [_request_indices.get_data_stream] -- **`name` (Optional, string \| string[])**: List of data stream names used to limit the request. -Wildcard (`*`) expressions are supported. If omitted, all data streams are returned. -- **`expand_wildcards` (Optional, Enum("all" \| "open" \| "closed" \| "hidden" \| "none") \| Enum("all" \| "open" \| "closed" \| "hidden" \| "none")[])**: Type of data stream that wildcard patterns can match. -Supports a list of values, such as `open,hidden`. -- **`include_defaults` (Optional, boolean)**: If true, returns all relevant default configurations for the index template. -- **`master_timeout` (Optional, string \| -1 \| 0)**: Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. -- **`verbose` (Optional, boolean)**: Whether the maximum timestamp for each data stream should be calculated and returned. - -## client.indices.getDataStreamOptions [_indices.get_data_stream_options] -Returns the data stream options of the selected data streams. - -[Endpoint documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html) - -```ts -client.indices.getDataStreamOptions() -``` - - -## client.indices.getFieldMapping [_indices.get_field_mapping] -Get mapping definitions. -Retrieves mapping definitions for one or more fields. -For data streams, the API retrieves field mappings for the stream’s backing indices. - -This API is useful if you don't need a complete mapping or if an index mapping contains a large number of fields. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-mapping) - -```ts -client.indices.getFieldMapping({ fields }) -``` - -### Arguments [_arguments_indices.get_field_mapping] - -#### Request (object) [_request_indices.get_field_mapping] -- **`fields` (string \| string[])**: List or wildcard expression of fields used to limit returned information. -Supports wildcards (`*`). -- **`index` (Optional, string \| string[])**: List of data streams, indices, and aliases used to limit the request. -Supports wildcards (`*`). -To target all data streams and indices, omit this parameter or use `*` or `_all`. -- **`allow_no_indices` (Optional, boolean)**: If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. -This behavior applies even if the request targets other open indices. -- **`expand_wildcards` (Optional, Enum("all" \| "open" \| "closed" \| "hidden" \| "none") \| Enum("all" \| "open" \| "closed" \| "hidden" \| "none")[])**: Type of index that wildcard patterns can match. -If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. -Supports a list of values, such as `open,hidden`. -Valid values are: `all`, `open`, `closed`, `hidden`, `none`. -- **`ignore_unavailable` (Optional, boolean)**: If `false`, the request returns an error if it targets a missing or closed index. -- **`include_defaults` (Optional, boolean)**: If `true`, return all default settings in the response. - -## client.indices.getIndexTemplate [_indices.get_index_template] -Get index templates. -Get information about one or more index templates. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-index-template) - -```ts -client.indices.getIndexTemplate({ ... }) -``` - -### Arguments [_arguments_indices.get_index_template] - -#### Request (object) [_request_indices.get_index_template] -- **`name` (Optional, string)**: List of index template names used to limit the request. Wildcard (*) expressions are supported. -- **`local` (Optional, boolean)**: If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node. -- **`flat_settings` (Optional, boolean)**: If true, returns settings in flat format. -- **`master_timeout` (Optional, string \| -1 \| 0)**: Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. -- **`include_defaults` (Optional, boolean)**: If true, returns all relevant default configurations for the index template. - -## client.indices.getMapping [_indices.get_mapping] -Get mapping definitions. -For data streams, the API retrieves mappings for the stream’s backing indices. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-mapping) - -```ts -client.indices.getMapping({ ... }) -``` - -### Arguments [_arguments_indices.get_mapping] - -#### Request (object) [_request_indices.get_mapping] -- **`index` (Optional, string \| string[])**: List of data streams, indices, and aliases used to limit the request. -Supports wildcards (`*`). -To target all data streams and indices, omit this parameter or use `*` or `_all`. -- **`allow_no_indices` (Optional, boolean)**: If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. -This behavior applies even if the request targets other open indices. -- **`expand_wildcards` (Optional, Enum("all" \| "open" \| "closed" \| "hidden" \| "none") \| Enum("all" \| "open" \| "closed" \| "hidden" \| "none")[])**: Type of index that wildcard patterns can match. -If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. -Supports a list of values, such as `open,hidden`. -Valid values are: `all`, `open`, `closed`, `hidden`, `none`. -- **`ignore_unavailable` (Optional, boolean)**: If `false`, the request returns an error if it targets a missing or closed index. -- **`local` (Optional, boolean)**: If `true`, the request retrieves information from the local node only. -- **`master_timeout` (Optional, string \| -1 \| 0)**: Period to wait for a connection to the master node. -If no response is received before the timeout expires, the request fails and returns an error. - -## client.indices.getMigrateReindexStatus [_indices.get_migrate_reindex_status] -Get the migration reindexing status. - -Get the status of a migration reindex attempt for a data stream or index. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-migration) - -```ts -client.indices.getMigrateReindexStatus({ index }) -``` - -### Arguments [_arguments_indices.get_migrate_reindex_status] - -#### Request (object) [_request_indices.get_migrate_reindex_status] -- **`index` (string \| string[])**: The index or data stream name. - -## client.indices.getSettings [_indices.get_settings] -Get index settings. -Get setting information for one or more indices. -For data streams, it returns setting information for the stream's backing indices. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-settings) - -```ts -client.indices.getSettings({ ... }) -``` - -### Arguments [_arguments_indices.get_settings] - -#### Request (object) [_request_indices.get_settings] -- **`index` (Optional, string \| string[])**: List of data streams, indices, and aliases used to limit -the request. Supports wildcards (`*`). To target all data streams and -indices, omit this parameter or use `*` or `_all`. -- **`name` (Optional, string \| string[])**: List or wildcard expression of settings to retrieve. -- **`allow_no_indices` (Optional, boolean)**: If `false`, the request returns an error if any wildcard expression, index -alias, or `_all` value targets only missing or closed indices. This -behavior applies even if the request targets other open indices. For -example, a request targeting `foo*,bar*` returns an error if an index -starts with foo but no index starts with `bar`. -- **`expand_wildcards` (Optional, Enum("all" \| "open" \| "closed" \| "hidden" \| "none") \| Enum("all" \| "open" \| "closed" \| "hidden" \| "none")[])**: Type of index that wildcard patterns can match. -If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. -Supports a list of values, such as `open,hidden`. -- **`flat_settings` (Optional, boolean)**: If `true`, returns settings in flat format. -- **`ignore_unavailable` (Optional, boolean)**: If `false`, the request returns an error if it targets a missing or closed index. -- **`include_defaults` (Optional, boolean)**: If `true`, return all default settings in the response. -- **`local` (Optional, boolean)**: If `true`, the request retrieves information from the local node only. If -`false`, information is retrieved from the master node. -- **`master_timeout` (Optional, string \| -1 \| 0)**: Period to wait for a connection to the master node. If no response is -received before the timeout expires, the request fails and returns an -error. - -## client.indices.getTemplate [_indices.get_template] -Get index templates. -Get information about one or more index templates. - -IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-template) - -```ts -client.indices.getTemplate({ ... }) -``` - -### Arguments [_arguments_indices.get_template] - -#### Request (object) [_request_indices.get_template] -- **`name` (Optional, string \| string[])**: List of index template names used to limit the request. -Wildcard (`*`) expressions are supported. -To return all index templates, omit this parameter or use a value of `_all` or `*`. -- **`flat_settings` (Optional, boolean)**: If `true`, returns settings in flat format. -- **`local` (Optional, boolean)**: If `true`, the request retrieves information from the local node only. -- **`master_timeout` (Optional, string \| -1 \| 0)**: Period to wait for a connection to the master node. -If no response is received before the timeout expires, the request fails and returns an error. - -## client.indices.migrateReindex [_indices.migrate_reindex] -Reindex legacy backing indices. - -Reindex all legacy backing indices for a data stream. -This operation occurs in a persistent task. -The persistent task ID is returned immediately and the reindexing work is completed in that task. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-migrate-reindex) - -```ts -client.indices.migrateReindex({ ... }) -``` - -### Arguments [_arguments_indices.migrate_reindex] - -#### Request (object) [_request_indices.migrate_reindex] -- **`reindex` (Optional, { mode, source })** - -## client.indices.migrateToDataStream [_indices.migrate_to_data_stream] -Convert an index alias to a data stream. -Converts an index alias to a data stream. -You must have a matching index template that is data stream enabled. -The alias must meet the following criteria: -The alias must have a write index; -All indices for the alias must have a `@timestamp` field mapping of a `date` or `date_nanos` field type; -The alias must not have any filters; -The alias must not use custom routing. -If successful, the request removes the alias and creates a data stream with the same name. -The indices for the alias become hidden backing indices for the stream. -The write index for the alias becomes the write index for the stream. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-migrate-to-data-stream) - -```ts -client.indices.migrateToDataStream({ name }) -``` - -### Arguments [_arguments_indices.migrate_to_data_stream] - -#### Request (object) [_request_indices.migrate_to_data_stream] -- **`name` (string)**: Name of the index alias to convert to a data stream. -- **`master_timeout` (Optional, string \| -1 \| 0)**: Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. -- **`timeout` (Optional, string \| -1 \| 0)**: Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. - -## client.indices.modifyDataStream [_indices.modify_data_stream] -Update data streams. -Performs one or more data stream modification actions in a single atomic operation. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-modify-data-stream) - -```ts -client.indices.modifyDataStream({ actions }) -``` - -### Arguments [_arguments_indices.modify_data_stream] - -#### Request (object) [_request_indices.modify_data_stream] -- **`actions` ({ add_backing_index, remove_backing_index }[])**: Actions to perform. - -## client.indices.open [_indices.open] -Open a closed index. -For data streams, the API opens any closed backing indices. - -A closed index is blocked for read/write operations and does not allow all operations that opened indices allow. -It is not possible to index documents or to search for documents in a closed index. -This allows closed indices to not have to maintain internal data structures for indexing or searching documents, resulting in a smaller overhead on the cluster. - -When opening or closing an index, the master is responsible for restarting the index shards to reflect the new state of the index. -The shards will then go through the normal recovery process. -The data of opened or closed indices is automatically replicated by the cluster to ensure that enough shard copies are safely kept around at all times. - -You can open and close multiple indices. -An error is thrown if the request explicitly refers to a missing index. -This behavior can be turned off by using the `ignore_unavailable=true` parameter. - -By default, you must explicitly name the indices you are opening or closing. -To open or close indices with `_all`, `*`, or other wildcard expressions, change the `action.destructive_requires_name` setting to `false`. -This setting can also be changed with the cluster update settings API. - -Closed indices consume a significant amount of disk-space which can cause problems in managed environments. -Closing indices can be turned off with the cluster settings API by setting `cluster.indices.close.enable` to `false`. - -Because opening or closing an index allocates its shards, the `wait_for_active_shards` setting on index creation applies to the `_open` and `_close` index actions as well. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-open) - -```ts -client.indices.open({ index }) -``` - -### Arguments [_arguments_indices.open] - -#### Request (object) [_request_indices.open] -- **`index` (string \| string[])**: List of data streams, indices, and aliases used to limit the request. -Supports wildcards (`*`). -By default, you must explicitly name the indices you using to limit the request. -To limit a request using `_all`, `*`, or other wildcard expressions, change the `action.destructive_requires_name` setting to false. -You can update this setting in the `elasticsearch.yml` file or using the cluster update settings API. -- **`allow_no_indices` (Optional, boolean)**: If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. -This behavior applies even if the request targets other open indices. -- **`expand_wildcards` (Optional, Enum("all" \| "open" \| "closed" \| "hidden" \| "none") \| Enum("all" \| "open" \| "closed" \| "hidden" \| "none")[])**: Type of index that wildcard patterns can match. -If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. -Supports a list of values, such as `open,hidden`. -Valid values are: `all`, `open`, `closed`, `hidden`, `none`. -- **`ignore_unavailable` (Optional, boolean)**: If `false`, the request returns an error if it targets a missing or closed index. -- **`master_timeout` (Optional, string \| -1 \| 0)**: Period to wait for a connection to the master node. -If no response is received before the timeout expires, the request fails and returns an error. -- **`timeout` (Optional, string \| -1 \| 0)**: Period to wait for a response. -If no response is received before the timeout expires, the request fails and returns an error. -- **`wait_for_active_shards` (Optional, number \| Enum("all" \| "index-setting"))**: The number of shard copies that must be active before proceeding with the operation. -Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). - -## client.indices.promoteDataStream [_indices.promote_data_stream] -Promote a data stream. -Promote a data stream from a replicated data stream managed by cross-cluster replication (CCR) to a regular data stream. - -With CCR auto following, a data stream from a remote cluster can be replicated to the local cluster. -These data streams can't be rolled over in the local cluster. -These replicated data streams roll over only if the upstream data stream rolls over. -In the event that the remote cluster is no longer available, the data stream in the local cluster can be promoted to a regular data stream, which allows these data streams to be rolled over in the local cluster. - -NOTE: When promoting a data stream, ensure the local cluster has a data stream enabled index template that matches the data stream. -If this is missing, the data stream will not be able to roll over until a matching index template is created. -This will affect the lifecycle management of the data stream and interfere with the data stream size and retention. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-promote-data-stream) - -```ts -client.indices.promoteDataStream({ name }) -``` - -### Arguments [_arguments_indices.promote_data_stream] - -#### Request (object) [_request_indices.promote_data_stream] -- **`name` (string)**: The name of the data stream -- **`master_timeout` (Optional, string \| -1 \| 0)**: Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. - -## client.indices.putAlias [_indices.put_alias] -Create or update an alias. -Adds a data stream or index to an alias. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-alias) - -```ts -client.indices.putAlias({ index, name }) -``` - -### Arguments [_arguments_indices.put_alias] - -#### Request (object) [_request_indices.put_alias] -- **`index` (string \| string[])**: List of data streams or indices to add. -Supports wildcards (`*`). -Wildcard patterns that match both data streams and indices return an error. -- **`name` (string)**: Alias to update. -If the alias doesn’t exist, the request creates it. -Index alias names support date math. -- **`filter` (Optional, { bool, boosting, common, combined_fields, constant_score, dis_max, distance_feature, exists, function_score, fuzzy, geo_bounding_box, geo_distance, geo_grid, geo_polygon, geo_shape, has_child, has_parent, ids, intervals, knn, match, match_all, match_bool_prefix, match_none, match_phrase, match_phrase_prefix, more_like_this, multi_match, nested, parent_id, percolate, pinned, prefix, query_string, range, rank_feature, regexp, rule, script, script_score, semantic, shape, simple_query_string, span_containing, span_field_masking, span_first, span_multi, span_near, span_not, span_or, span_term, span_within, sparse_vector, term, terms, terms_set, text_expansion, weighted_tokens, wildcard, wrapper, type })**: Query used to limit documents the alias can access. -- **`index_routing` (Optional, string)**: Value used to route indexing operations to a specific shard. -If specified, this overwrites the `routing` value for indexing operations. -Data stream aliases don’t support this parameter. -- **`is_write_index` (Optional, boolean)**: If `true`, sets the write index or data stream for the alias. -If an alias points to multiple indices or data streams and `is_write_index` isn’t set, the alias rejects write requests. -If an index alias points to one index and `is_write_index` isn’t set, the index automatically acts as the write index. -Data stream aliases don’t automatically set a write data stream, even if the alias points to one data stream. -- **`routing` (Optional, string)**: Value used to route indexing and search operations to a specific shard. -Data stream aliases don’t support this parameter. -- **`search_routing` (Optional, string)**: Value used to route search operations to a specific shard. -If specified, this overwrites the `routing` value for search operations. -Data stream aliases don’t support this parameter. -- **`master_timeout` (Optional, string \| -1 \| 0)**: Period to wait for a connection to the master node. -If no response is received before the timeout expires, the request fails and returns an error. -- **`timeout` (Optional, string \| -1 \| 0)**: Period to wait for a response. -If no response is received before the timeout expires, the request fails and returns an error. - -## client.indices.putDataLifecycle [_indices.put_data_lifecycle] -Update data stream lifecycles. -Update the data stream lifecycle of the specified data streams. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-data-lifecycle) - -```ts -client.indices.putDataLifecycle({ name }) -``` - -### Arguments [_arguments_indices.put_data_lifecycle] - -#### Request (object) [_request_indices.put_data_lifecycle] -- **`name` (string \| string[])**: List of data streams used to limit the request. -Supports wildcards (`*`). -To target all data streams use `*` or `_all`. -- **`data_retention` (Optional, string \| -1 \| 0)**: If defined, every document added to this data stream will be stored at least for this time frame. -Any time after this duration the document could be deleted. -When empty, every document in this data stream will be stored indefinitely. -- **`downsampling` (Optional, { rounds })**: The downsampling configuration to execute for the managed backing index after rollover. -- **`enabled` (Optional, boolean)**: If defined, it turns data stream lifecycle on/off (`true`/`false`) for this data stream. A data stream lifecycle -that's disabled (enabled: `false`) will have no effect on the data stream. -- **`expand_wildcards` (Optional, Enum("all" \| "open" \| "closed" \| "hidden" \| "none") \| Enum("all" \| "open" \| "closed" \| "hidden" \| "none")[])**: Type of data stream that wildcard patterns can match. -Supports a list of values, such as `open,hidden`. -Valid values are: `all`, `hidden`, `open`, `closed`, `none`. -- **`master_timeout` (Optional, string \| -1 \| 0)**: Period to wait for a connection to the master node. If no response is -received before the timeout expires, the request fails and returns an -error. -- **`timeout` (Optional, string \| -1 \| 0)**: Period to wait for a response. -If no response is received before the timeout expires, the request fails and returns an error. - -## client.indices.putDataStreamOptions [_indices.put_data_stream_options] -Updates the data stream options of the selected data streams. - -[Endpoint documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html) - -```ts -client.indices.putDataStreamOptions() -``` - - -## client.indices.putIndexTemplate [_indices.put_index_template] -Create or update an index template. -Index templates define settings, mappings, and aliases that can be applied automatically to new indices. - -Elasticsearch applies templates to new indices based on an wildcard pattern that matches the index name. -Index templates are applied during data stream or index creation. -For data streams, these settings and mappings are applied when the stream's backing indices are created. -Settings and mappings specified in a create index API request override any settings or mappings specified in an index template. -Changes to index templates do not affect existing indices, including the existing backing indices of a data stream. - -You can use C-style `/* *\/` block comments in index templates. -You can include comments anywhere in the request body, except before the opening curly bracket. - -**Multiple matching templates** - -If multiple index templates match the name of a new index or data stream, the template with the highest priority is used. - -Multiple templates with overlapping index patterns at the same priority are not allowed and an error will be thrown when attempting to create a template matching an existing index template at identical priorities. - -**Composing aliases, mappings, and settings** - -When multiple component templates are specified in the `composed_of` field for an index template, they are merged in the order specified, meaning that later component templates override earlier component templates. -Any mappings, settings, or aliases from the parent index template are merged in next. -Finally, any configuration on the index request itself is merged. -Mapping definitions are merged recursively, which means that later mapping components can introduce new field mappings and update the mapping configuration. -If a field mapping is already contained in an earlier component, its definition will be completely overwritten by the later one. -This recursive merging strategy applies not only to field mappings, but also root options like `dynamic_templates` and `meta`. -If an earlier component contains a `dynamic_templates` block, then by default new `dynamic_templates` entries are appended onto the end. -If an entry already exists with the same key, then it is overwritten by the new definition. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-index-template) - -```ts -client.indices.putIndexTemplate({ name }) -``` - -### Arguments [_arguments_indices.put_index_template] - -#### Request (object) [_request_indices.put_index_template] -- **`name` (string)**: Index or template name -- **`index_patterns` (Optional, string \| string[])**: Name of the index template to create. -- **`composed_of` (Optional, string[])**: An ordered list of component template names. -Component templates are merged in the order specified, meaning that the last component template specified has the highest precedence. -- **`template` (Optional, { aliases, mappings, settings, lifecycle })**: Template to be applied. -It may optionally include an `aliases`, `mappings`, or `settings` configuration. -- **`data_stream` (Optional, { hidden, allow_custom_routing })**: If this object is included, the template is used to create data streams and their backing indices. -Supports an empty object. -Data streams require a matching index template with a `data_stream` object. -- **`priority` (Optional, number)**: Priority to determine index template precedence when a new data stream or index is created. -The index template with the highest priority is chosen. -If no priority is specified the template is treated as though it is of priority 0 (lowest priority). -This number is not automatically generated by Elasticsearch. -- **`version` (Optional, number)**: Version number used to manage index templates externally. -This number is not automatically generated by Elasticsearch. -External systems can use these version numbers to simplify template management. -To unset a version, replace the template without specifying one. -- **`_meta` (Optional, Record)**: Optional user metadata about the index template. -It may have any contents. -It is not automatically generated or used by Elasticsearch. -This user-defined object is stored in the cluster state, so keeping it short is preferable -To unset the metadata, replace the template without specifying it. -- **`allow_auto_create` (Optional, boolean)**: This setting overrides the value of the `action.auto_create_index` cluster setting. -If set to `true` in a template, then indices can be automatically created using that template even if auto-creation of indices is disabled via `actions.auto_create_index`. -If set to `false`, then indices or data streams matching the template must always be explicitly created, and may never be automatically created. -- **`ignore_missing_component_templates` (Optional, string[])**: The configuration option ignore_missing_component_templates can be used when an index template -references a component template that might not exist -- **`deprecated` (Optional, boolean)**: Marks this index template as deprecated. When creating or updating a non-deprecated index template -that uses deprecated components, Elasticsearch will emit a deprecation warning. -- **`create` (Optional, boolean)**: If `true`, this request cannot replace or update existing index templates. -- **`master_timeout` (Optional, string \| -1 \| 0)**: Period to wait for a connection to the master node. -If no response is received before the timeout expires, the request fails and returns an error. -- **`cause` (Optional, string)**: User defined reason for creating/updating the index template - -## client.indices.putMapping [_indices.put_mapping] -Update field mappings. -Add new fields to an existing data stream or index. -You can also use this API to change the search settings of existing fields and add new properties to existing object fields. -For data streams, these changes are applied to all backing indices by default. - -**Add multi-fields to an existing field** - -Multi-fields let you index the same field in different ways. -You can use this API to update the fields mapping parameter and enable multi-fields for an existing field. -WARNING: If an index (or data stream) contains documents when you add a multi-field, those documents will not have values for the new multi-field. -You can populate the new multi-field with the update by query API. - -**Change supported mapping parameters for an existing field** - -The documentation for each mapping parameter indicates whether you can update it for an existing field using this API. -For example, you can use the update mapping API to update the `ignore_above` parameter. - -**Change the mapping of an existing field** - -Except for supported mapping parameters, you can't change the mapping or field type of an existing field. -Changing an existing field could invalidate data that's already indexed. - -If you need to change the mapping of a field in a data stream's backing indices, refer to documentation about modifying data streams. -If you need to change the mapping of a field in other indices, create a new index with the correct mapping and reindex your data into that index. - -**Rename a field** - -Renaming a field would invalidate data already indexed under the old field name. -Instead, add an alias field to create an alternate field name. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-mapping) - -```ts -client.indices.putMapping({ index }) -``` - -### Arguments [_arguments_indices.put_mapping] - -#### Request (object) [_request_indices.put_mapping] -- **`index` (string \| string[])**: A list of index names the mapping should be added to (supports wildcards); use `_all` or omit to add the mapping on all indices. -- **`date_detection` (Optional, boolean)**: Controls whether dynamic date detection is enabled. -- **`dynamic` (Optional, Enum("strict" \| "runtime" \| true \| false))**: Controls whether new fields are added dynamically. -- **`dynamic_date_formats` (Optional, string[])**: If date detection is enabled then new string fields are checked -against 'dynamic_date_formats' and if the value matches then -a new date field is added instead of string. -- **`dynamic_templates` (Optional, Record[])**: Specify dynamic templates for the mapping. -- **`_field_names` (Optional, { enabled })**: Control whether field names are enabled for the index. -- **`_meta` (Optional, Record)**: A mapping type can have custom meta data associated with it. These are -not used at all by Elasticsearch, but can be used to store -application-specific metadata. -- **`numeric_detection` (Optional, boolean)**: Automatically map strings into numeric data types for all fields. -- **`properties` (Optional, Record)**: Mapping for a field. For new fields, this mapping can include: - -- Field name -- Field data type -- Mapping parameters -- **`_routing` (Optional, { required })**: Enable making a routing value required on indexed documents. -- **`_source` (Optional, { compress, compress_threshold, enabled, excludes, includes, mode })**: Control whether the _source field is enabled on the index. -- **`runtime` (Optional, Record)**: Mapping of runtime fields for the index. -- **`allow_no_indices` (Optional, boolean)**: If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. -This behavior applies even if the request targets other open indices. -- **`expand_wildcards` (Optional, Enum("all" \| "open" \| "closed" \| "hidden" \| "none") \| Enum("all" \| "open" \| "closed" \| "hidden" \| "none")[])**: Type of index that wildcard patterns can match. -If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. -Supports a list of values, such as `open,hidden`. -Valid values are: `all`, `open`, `closed`, `hidden`, `none`. -- **`ignore_unavailable` (Optional, boolean)**: If `false`, the request returns an error if it targets a missing or closed index. -- **`master_timeout` (Optional, string \| -1 \| 0)**: Period to wait for a connection to the master node. -If no response is received before the timeout expires, the request fails and returns an error. -- **`timeout` (Optional, string \| -1 \| 0)**: Period to wait for a response. -If no response is received before the timeout expires, the request fails and returns an error. -- **`write_index_only` (Optional, boolean)**: If `true`, the mappings are applied only to the current write index for the target. - -## client.indices.putSettings [_indices.put_settings] -Update index settings. -Changes dynamic index settings in real time. -For data streams, index setting changes are applied to all backing indices by default. - -To revert a setting to the default value, use a null value. -The list of per-index settings that can be updated dynamically on live indices can be found in index module documentation. -To preserve existing settings from being updated, set the `preserve_existing` parameter to `true`. - -NOTE: You can only define new analyzers on closed indices. -To add an analyzer, you must close the index, define the analyzer, and reopen the index. -You cannot close the write index of a data stream. -To update the analyzer for a data stream's write index and future backing indices, update the analyzer in the index template used by the stream. -Then roll over the data stream to apply the new analyzer to the stream's write index and future backing indices. -This affects searches and any new data added to the stream after the rollover. -However, it does not affect the data stream's backing indices or their existing data. -To change the analyzer for existing backing indices, you must create a new data stream and reindex your data into it. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-settings) - -```ts -client.indices.putSettings({ ... }) -``` - -### Arguments [_arguments_indices.put_settings] - -#### Request (object) [_request_indices.put_settings] -- **`index` (Optional, string \| string[])**: List of data streams, indices, and aliases used to limit -the request. Supports wildcards (`*`). To target all data streams and -indices, omit this parameter or use `*` or `_all`. -- **`settings` (Optional, { index, mode, routing_path, soft_deletes, sort, number_of_shards, number_of_replicas, number_of_routing_shards, check_on_startup, codec, routing_partition_size, load_fixed_bitset_filters_eagerly, hidden, auto_expand_replicas, merge, search, refresh_interval, max_result_window, max_inner_result_window, max_rescore_window, max_docvalue_fields_search, max_script_fields, max_ngram_diff, max_shingle_diff, blocks, max_refresh_listeners, analyze, highlight, max_terms_count, max_regex_length, routing, gc_deletes, default_pipeline, final_pipeline, lifecycle, provided_name, creation_date, creation_date_string, uuid, version, verified_before_close, format, max_slices_per_scroll, translog, query_string, priority, top_metrics_max_size, analysis, settings, time_series, queries, similarity, mapping, indexing.slowlog, indexing_pressure, store })** -- **`allow_no_indices` (Optional, boolean)**: If `false`, the request returns an error if any wildcard expression, index -alias, or `_all` value targets only missing or closed indices. This -behavior applies even if the request targets other open indices. For -example, a request targeting `foo*,bar*` returns an error if an index -starts with `foo` but no index starts with `bar`. -- **`expand_wildcards` (Optional, Enum("all" \| "open" \| "closed" \| "hidden" \| "none") \| Enum("all" \| "open" \| "closed" \| "hidden" \| "none")[])**: Type of index that wildcard patterns can match. If the request can target -data streams, this argument determines whether wildcard expressions match -hidden data streams. Supports a list of values, such as -`open,hidden`. -- **`flat_settings` (Optional, boolean)**: If `true`, returns settings in flat format. -- **`ignore_unavailable` (Optional, boolean)**: If `true`, returns settings in flat format. -- **`master_timeout` (Optional, string \| -1 \| 0)**: Period to wait for a connection to the master node. If no response is -received before the timeout expires, the request fails and returns an -error. -- **`preserve_existing` (Optional, boolean)**: If `true`, existing index settings remain unchanged. -- **`reopen` (Optional, boolean)**: Whether to close and reopen the index to apply non-dynamic settings. -If set to `true` the indices to which the settings are being applied -will be closed temporarily and then reopened in order to apply the changes. -- **`timeout` (Optional, string \| -1 \| 0)**: Period to wait for a response. If no response is received before the - timeout expires, the request fails and returns an error. - -## client.indices.putTemplate [_indices.put_template] -Create or update an index template. -Index templates define settings, mappings, and aliases that can be applied automatically to new indices. -Elasticsearch applies templates to new indices based on an index pattern that matches the index name. - -IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8. - -Composable templates always take precedence over legacy templates. -If no composable template matches a new index, matching legacy templates are applied according to their order. - -Index templates are only applied during index creation. -Changes to index templates do not affect existing indices. -Settings and mappings specified in create index API requests override any settings or mappings specified in an index template. - -You can use C-style `/* *\/` block comments in index templates. -You can include comments anywhere in the request body, except before the opening curly bracket. - -**Indices matching multiple templates** - -Multiple index templates can potentially match an index, in this case, both the settings and mappings are merged into the final configuration of the index. -The order of the merging can be controlled using the order parameter, with lower order being applied first, and higher orders overriding them. -NOTE: Multiple matching templates with the same order value will result in a non-deterministic merging order. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-template) - -```ts -client.indices.putTemplate({ name }) -``` - -### Arguments [_arguments_indices.put_template] - -#### Request (object) [_request_indices.put_template] -- **`name` (string)**: The name of the template -- **`aliases` (Optional, Record)**: Aliases for the index. -- **`index_patterns` (Optional, string \| string[])**: Array of wildcard expressions used to match the names -of indices during creation. -- **`mappings` (Optional, { all_field, date_detection, dynamic, dynamic_date_formats, dynamic_templates, _field_names, index_field, _meta, numeric_detection, properties, _routing, _size, _source, runtime, enabled, subobjects, _data_stream_timestamp })**: Mapping for fields in the index. -- **`order` (Optional, number)**: Order in which Elasticsearch applies this template if index -matches multiple templates. - -Templates with lower 'order' values are merged first. Templates with higher -'order' values are merged later, overriding templates with lower values. -- **`settings` (Optional, { index, mode, routing_path, soft_deletes, sort, number_of_shards, number_of_replicas, number_of_routing_shards, check_on_startup, codec, routing_partition_size, load_fixed_bitset_filters_eagerly, hidden, auto_expand_replicas, merge, search, refresh_interval, max_result_window, max_inner_result_window, max_rescore_window, max_docvalue_fields_search, max_script_fields, max_ngram_diff, max_shingle_diff, blocks, max_refresh_listeners, analyze, highlight, max_terms_count, max_regex_length, routing, gc_deletes, default_pipeline, final_pipeline, lifecycle, provided_name, creation_date, creation_date_string, uuid, version, verified_before_close, format, max_slices_per_scroll, translog, query_string, priority, top_metrics_max_size, analysis, settings, time_series, queries, similarity, mapping, indexing.slowlog, indexing_pressure, store })**: Configuration options for the index. -- **`version` (Optional, number)**: Version number used to manage index templates externally. This number -is not automatically generated by Elasticsearch. -To unset a version, replace the template without specifying one. -- **`create` (Optional, boolean)**: If true, this request cannot replace or update existing index templates. -- **`master_timeout` (Optional, string \| -1 \| 0)**: Period to wait for a connection to the master node. If no response is -received before the timeout expires, the request fails and returns an error. -- **`cause` (Optional, string)**: User defined reason for creating/updating the index template - -## client.indices.recovery [_indices.recovery] -Get index recovery information. -Get information about ongoing and completed shard recoveries for one or more indices. -For data streams, the API returns information for the stream's backing indices. - -All recoveries, whether ongoing or complete, are kept in the cluster state and may be reported on at any time. - -Shard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or creating a replica shard from a primary shard. -When a shard recovery completes, the recovered shard is available for search and indexing. - -Recovery automatically occurs during the following processes: - -* When creating an index for the first time. -* When a node rejoins the cluster and starts up any missing primary shard copies using the data that it holds in its data path. -* Creation of new replica shard copies from the primary. -* Relocation of a shard copy to a different node in the same cluster. -* A snapshot restore operation. -* A clone, shrink, or split operation. - -You can determine the cause of a shard recovery using the recovery or cat recovery APIs. - -The index recovery API reports information about completed recoveries only for shard copies that currently exist in the cluster. -It only reports the last recovery for each shard copy and does not report historical information about earlier recoveries, nor does it report information about the recoveries of shard copies that no longer exist. -This means that if a shard copy completes a recovery and then Elasticsearch relocates it onto a different node then the information about the original recovery will not be shown in the recovery API. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-recovery) - -```ts -client.indices.recovery({ ... }) -``` - -### Arguments [_arguments_indices.recovery] - -#### Request (object) [_request_indices.recovery] -- **`index` (Optional, string \| string[])**: List of data streams, indices, and aliases used to limit the request. -Supports wildcards (`*`). -To target all data streams and indices, omit this parameter or use `*` or `_all`. -- **`active_only` (Optional, boolean)**: If `true`, the response only includes ongoing shard recoveries. -- **`detailed` (Optional, boolean)**: If `true`, the response includes detailed information about shard recoveries. - -## client.indices.refresh [_indices.refresh] -Refresh an index. -A refresh makes recent operations performed on one or more indices available for search. -For data streams, the API runs the refresh operation on the stream’s backing indices. - -By default, Elasticsearch periodically refreshes indices every second, but only on indices that have received one search request or more in the last 30 seconds. -You can change this default interval with the `index.refresh_interval` setting. - -Refresh requests are synchronous and do not return a response until the refresh operation completes. - -Refreshes are resource-intensive. -To ensure good cluster performance, it's recommended to wait for Elasticsearch's periodic refresh rather than performing an explicit refresh when possible. - -If your application workflow indexes documents and then runs a search to retrieve the indexed document, it's recommended to use the index API's `refresh=wait_for` query parameter option. -This option ensures the indexing operation waits for a periodic refresh before running the search. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-refresh) - -```ts -client.indices.refresh({ ... }) -``` - -### Arguments [_arguments_indices.refresh] - -#### Request (object) [_request_indices.refresh] -- **`index` (Optional, string \| string[])**: List of data streams, indices, and aliases used to limit the request. -Supports wildcards (`*`). -To target all data streams and indices, omit this parameter or use `*` or `_all`. -- **`allow_no_indices` (Optional, boolean)**: If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. -This behavior applies even if the request targets other open indices. -- **`expand_wildcards` (Optional, Enum("all" \| "open" \| "closed" \| "hidden" \| "none") \| Enum("all" \| "open" \| "closed" \| "hidden" \| "none")[])**: Type of index that wildcard patterns can match. -If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. -Supports a list of values, such as `open,hidden`. -Valid values are: `all`, `open`, `closed`, `hidden`, `none`. -- **`ignore_unavailable` (Optional, boolean)**: If `false`, the request returns an error if it targets a missing or closed index. - -## client.indices.reloadSearchAnalyzers [_indices.reload_search_analyzers] -Reload search analyzers. -Reload an index's search analyzers and their resources. -For data streams, the API reloads search analyzers and resources for the stream's backing indices. - -IMPORTANT: After reloading the search analyzers you should clear the request cache to make sure it doesn't contain responses derived from the previous versions of the analyzer. - -You can use the reload search analyzers API to pick up changes to synonym files used in the `synonym_graph` or `synonym` token filter of a search analyzer. -To be eligible, the token filter must have an `updateable` flag of `true` and only be used in search analyzers. - -NOTE: This API does not perform a reload for each shard of an index. -Instead, it performs a reload for each node containing index shards. -As a result, the total shard count returned by the API can differ from the number of index shards. -Because reloading affects every node with an index shard, it is important to update the synonym file on every data node in the cluster--including nodes that don't contain a shard replica--before using this API. -This ensures the synonym file is updated everywhere in the cluster in case shards are relocated in the future. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-reload-search-analyzers) - -```ts -client.indices.reloadSearchAnalyzers({ index }) -``` - -### Arguments [_arguments_indices.reload_search_analyzers] - -#### Request (object) [_request_indices.reload_search_analyzers] -- **`index` (string \| string[])**: A list of index names to reload analyzers for -- **`allow_no_indices` (Optional, boolean)**: Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) -- **`expand_wildcards` (Optional, Enum("all" \| "open" \| "closed" \| "hidden" \| "none") \| Enum("all" \| "open" \| "closed" \| "hidden" \| "none")[])**: Whether to expand wildcard expression to concrete indices that are open, closed or both. -- **`ignore_unavailable` (Optional, boolean)**: Whether specified concrete indices should be ignored when unavailable (missing or closed) -- **`resource` (Optional, string)**: Changed resource to reload analyzers from if applicable - -## client.indices.resolveCluster [_indices.resolve_cluster] -Resolve the cluster. - -Resolve the specified index expressions to return information about each cluster, including the local "querying" cluster, if included. -If no index expression is provided, the API will return information about all the remote clusters that are configured on the querying cluster. - -This endpoint is useful before doing a cross-cluster search in order to determine which remote clusters should be included in a search. - -You use the same index expression with this endpoint as you would for cross-cluster search. -Index and cluster exclusions are also supported with this endpoint. - -For each cluster in the index expression, information is returned about: - -* Whether the querying ("local") cluster is currently connected to each remote cluster specified in the index expression. Note that this endpoint actively attempts to contact the remote clusters, unlike the `remote/info` endpoint. -* Whether each remote cluster is configured with `skip_unavailable` as `true` or `false`. -* Whether there are any indices, aliases, or data streams on that cluster that match the index expression. -* Whether the search is likely to have errors returned when you do the cross-cluster search (including any authorization errors if you do not have permission to query the index). -* Cluster version information, including the Elasticsearch server version. - -For example, `GET /_resolve/cluster/my-index-*,cluster*:my-index-*` returns information about the local cluster and all remotely configured clusters that start with the alias `cluster*`. -Each cluster returns information about whether it has any indices, aliases or data streams that match `my-index-*`. - -## Note on backwards compatibility -The ability to query without an index expression was added in version 8.18, so when -querying remote clusters older than that, the local cluster will send the index -expression `dummy*` to those remote clusters. Thus, if an errors occur, you may see a reference -to that index expression even though you didn't request it. If it causes a problem, you can -instead include an index expression like `*:*` to bypass the issue. - -## Advantages of using this endpoint before a cross-cluster search - -You may want to exclude a cluster or index from a search when: - -* A remote cluster is not currently connected and is configured with `skip_unavailable=false`. Running a cross-cluster search under those conditions will cause the entire search to fail. -* A cluster has no matching indices, aliases or data streams for the index expression (or your user does not have permissions to search them). For example, suppose your index expression is `logs*,remote1:logs*` and the remote1 cluster has no indices, aliases or data streams that match `logs*`. In that case, that cluster will return no results from that cluster if you include it in a cross-cluster search. -* The index expression (combined with any query parameters you specify) will likely cause an exception to be thrown when you do the search. In these cases, the "error" field in the `_resolve/cluster` response will be present. (This is also where security/permission errors will be shown.) -* A remote cluster is an older version that does not support the feature you want to use in your search. - -## Test availability of remote clusters - -The `remote/info` endpoint is commonly used to test whether the "local" cluster (the cluster being queried) is connected to its remote clusters, but it does not necessarily reflect whether the remote cluster is available or not. -The remote cluster may be available, while the local cluster is not currently connected to it. - -You can use the `_resolve/cluster` API to attempt to reconnect to remote clusters. -For example with `GET _resolve/cluster` or `GET _resolve/cluster/*:*`. -The `connected` field in the response will indicate whether it was successful. -If a connection was (re-)established, this will also cause the `remote/info` endpoint to now indicate a connected status. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-resolve-cluster) - -```ts -client.indices.resolveCluster({ ... }) -``` - -### Arguments [_arguments_indices.resolve_cluster] - -#### Request (object) [_request_indices.resolve_cluster] -- **`name` (Optional, string \| string[])**: A list of names or index patterns for the indices, aliases, and data streams to resolve. -Resources on remote clusters can be specified using the ``:`` syntax. -Index and cluster exclusions (e.g., `-cluster1:*`) are also supported. -If no index expression is specified, information about all remote clusters configured on the local cluster -is returned without doing any index matching -- **`allow_no_indices` (Optional, boolean)**: If false, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing -or closed indices. This behavior applies even if the request targets other open indices. For example, a request -targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. -NOTE: This option is only supported when specifying an index expression. You will get an error if you specify index -options to the `_resolve/cluster` API endpoint that takes no index expression. -- **`expand_wildcards` (Optional, Enum("all" \| "open" \| "closed" \| "hidden" \| "none") \| Enum("all" \| "open" \| "closed" \| "hidden" \| "none")[])**: Type of index that wildcard patterns can match. -If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. -Supports a list of values, such as `open,hidden`. -Valid values are: `all`, `open`, `closed`, `hidden`, `none`. -NOTE: This option is only supported when specifying an index expression. You will get an error if you specify index -options to the `_resolve/cluster` API endpoint that takes no index expression. -- **`ignore_throttled` (Optional, boolean)**: If true, concrete, expanded, or aliased indices are ignored when frozen. -NOTE: This option is only supported when specifying an index expression. You will get an error if you specify index -options to the `_resolve/cluster` API endpoint that takes no index expression. -- **`ignore_unavailable` (Optional, boolean)**: If false, the request returns an error if it targets a missing or closed index. -NOTE: This option is only supported when specifying an index expression. You will get an error if you specify index -options to the `_resolve/cluster` API endpoint that takes no index expression. -- **`timeout` (Optional, string \| -1 \| 0)**: The maximum time to wait for remote clusters to respond. -If a remote cluster does not respond within this timeout period, the API response -will show the cluster as not connected and include an error message that the -request timed out. - -The default timeout is unset and the query can take -as long as the networking layer is configured to wait for remote clusters that are -not responding (typically 30 seconds). - -## client.indices.resolveIndex [_indices.resolve_index] -Resolve indices. -Resolve the names and/or index patterns for indices, aliases, and data streams. -Multiple patterns and remote clusters are supported. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-resolve-index) - -```ts -client.indices.resolveIndex({ name }) -``` - -### Arguments [_arguments_indices.resolve_index] - -#### Request (object) [_request_indices.resolve_index] -- **`name` (string \| string[])**: Comma-separated name(s) or index pattern(s) of the indices, aliases, and data streams to resolve. -Resources on remote clusters can be specified using the ``:`` syntax. -- **`expand_wildcards` (Optional, Enum("all" \| "open" \| "closed" \| "hidden" \| "none") \| Enum("all" \| "open" \| "closed" \| "hidden" \| "none")[])**: Type of index that wildcard patterns can match. -If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. -Supports a list of values, such as `open,hidden`. -Valid values are: `all`, `open`, `closed`, `hidden`, `none`. -- **`ignore_unavailable` (Optional, boolean)**: If `false`, the request returns an error if it targets a missing or closed index. -- **`allow_no_indices` (Optional, boolean)**: If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. -This behavior applies even if the request targets other open indices. -For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. - -## client.indices.rollover [_indices.rollover] -Roll over to a new index. -TIP: It is recommended to use the index lifecycle rollover action to automate rollovers. - -The rollover API creates a new index for a data stream or index alias. -The API behavior depends on the rollover target. - -**Roll over a data stream** - -If you roll over a data stream, the API creates a new write index for the stream. -The stream's previous write index becomes a regular backing index. -A rollover also increments the data stream's generation. - -**Roll over an index alias with a write index** - -TIP: Prior to Elasticsearch 7.9, you'd typically use an index alias with a write index to manage time series data. -Data streams replace this functionality, require less maintenance, and automatically integrate with data tiers. - -If an index alias points to multiple indices, one of the indices must be a write index. -The rollover API creates a new write index for the alias with `is_write_index` set to `true`. -The API also `sets is_write_index` to `false` for the previous write index. - -**Roll over an index alias with one index** - -If you roll over an index alias that points to only one index, the API creates a new index for the alias and removes the original index from the alias. - -NOTE: A rollover creates a new index and is subject to the `wait_for_active_shards` setting. - -**Increment index names for an alias** - -When you roll over an index alias, you can specify a name for the new index. -If you don't specify a name and the current index ends with `-` and a number, such as `my-index-000001` or `my-index-3`, the new index name increments that number. -For example, if you roll over an alias with a current index of `my-index-000001`, the rollover creates a new index named `my-index-000002`. -This number is always six characters and zero-padded, regardless of the previous index's name. - -If you use an index alias for time series data, you can use date math in the index name to track the rollover date. -For example, you can create an alias that points to an index named ``. -If you create the index on May 6, 2099, the index's name is `my-index-2099.05.06-000001`. -If you roll over the alias on May 7, 2099, the new index's name is `my-index-2099.05.07-000002`. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-rollover) - -```ts -client.indices.rollover({ alias }) -``` - -### Arguments [_arguments_indices.rollover] - -#### Request (object) [_request_indices.rollover] -- **`alias` (string)**: Name of the data stream or index alias to roll over. -- **`new_index` (Optional, string)**: Name of the index to create. -Supports date math. -Data streams do not support this parameter. -- **`aliases` (Optional, Record)**: Aliases for the target index. -Data streams do not support this parameter. -- **`conditions` (Optional, { min_age, max_age, max_age_millis, min_docs, max_docs, max_size, max_size_bytes, min_size, min_size_bytes, max_primary_shard_size, max_primary_shard_size_bytes, min_primary_shard_size, min_primary_shard_size_bytes, max_primary_shard_docs, min_primary_shard_docs })**: Conditions for the rollover. -If specified, Elasticsearch only performs the rollover if the current index satisfies these conditions. -If this parameter is not specified, Elasticsearch performs the rollover unconditionally. -If conditions are specified, at least one of them must be a `max_*` condition. -The index will rollover if any `max_*` condition is satisfied and all `min_*` conditions are satisfied. -- **`mappings` (Optional, { all_field, date_detection, dynamic, dynamic_date_formats, dynamic_templates, _field_names, index_field, _meta, numeric_detection, properties, _routing, _size, _source, runtime, enabled, subobjects, _data_stream_timestamp })**: Mapping for fields in the index. -If specified, this mapping can include field names, field data types, and mapping paramaters. -- **`settings` (Optional, Record)**: Configuration options for the index. -Data streams do not support this parameter. -- **`dry_run` (Optional, boolean)**: If `true`, checks whether the current index satisfies the specified conditions but does not perform a rollover. -- **`master_timeout` (Optional, string \| -1 \| 0)**: Period to wait for a connection to the master node. -If no response is received before the timeout expires, the request fails and returns an error. -- **`timeout` (Optional, string \| -1 \| 0)**: Period to wait for a response. -If no response is received before the timeout expires, the request fails and returns an error. -- **`wait_for_active_shards` (Optional, number \| Enum("all" \| "index-setting"))**: The number of shard copies that must be active before proceeding with the operation. -Set to all or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). -- **`lazy` (Optional, boolean)**: If set to true, the rollover action will only mark a data stream to signal that it needs to be rolled over at the next write. -Only allowed on data streams. - -## client.indices.segments [_indices.segments] -Get index segments. -Get low-level information about the Lucene segments in index shards. -For data streams, the API returns information about the stream's backing indices. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-segments) - -```ts -client.indices.segments({ ... }) -``` - -### Arguments [_arguments_indices.segments] - -#### Request (object) [_request_indices.segments] -- **`index` (Optional, string \| string[])**: List of data streams, indices, and aliases used to limit the request. -Supports wildcards (`*`). -To target all data streams and indices, omit this parameter or use `*` or `_all`. -- **`allow_no_indices` (Optional, boolean)**: If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. -This behavior applies even if the request targets other open indices. -- **`expand_wildcards` (Optional, Enum("all" \| "open" \| "closed" \| "hidden" \| "none") \| Enum("all" \| "open" \| "closed" \| "hidden" \| "none")[])**: Type of index that wildcard patterns can match. -If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. -Supports a list of values, such as `open,hidden`. -Valid values are: `all`, `open`, `closed`, `hidden`, `none`. -- **`ignore_unavailable` (Optional, boolean)**: If `false`, the request returns an error if it targets a missing or closed index. - -## client.indices.shardStores [_indices.shard_stores] -Get index shard stores. -Get store information about replica shards in one or more indices. -For data streams, the API retrieves store information for the stream's backing indices. - -The index shard stores API returns the following information: - -* The node on which each replica shard exists. -* The allocation ID for each replica shard. -* A unique ID for each replica shard. -* Any errors encountered while opening the shard index or from an earlier failure. - -By default, the API returns store information only for primary shards that are unassigned or have one or more unassigned replica shards. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-shard-stores) - -```ts -client.indices.shardStores({ ... }) -``` - -### Arguments [_arguments_indices.shard_stores] - -#### Request (object) [_request_indices.shard_stores] -- **`index` (Optional, string \| string[])**: List of data streams, indices, and aliases used to limit the request. -- **`allow_no_indices` (Optional, boolean)**: If false, the request returns an error if any wildcard expression, index alias, or _all -value targets only missing or closed indices. This behavior applies even if the request -targets other open indices. -- **`expand_wildcards` (Optional, Enum("all" \| "open" \| "closed" \| "hidden" \| "none") \| Enum("all" \| "open" \| "closed" \| "hidden" \| "none")[])**: Type of index that wildcard patterns can match. If the request can target data streams, -this argument determines whether wildcard expressions match hidden data streams. -- **`ignore_unavailable` (Optional, boolean)**: If true, missing or closed indices are not included in the response. -- **`status` (Optional, Enum("green" \| "yellow" \| "red" \| "all") \| Enum("green" \| "yellow" \| "red" \| "all")[])**: List of shard health statuses used to limit the request. - -## client.indices.shrink [_indices.shrink] -Shrink an index. -Shrink an index into a new index with fewer primary shards. - -Before you can shrink an index: - -* The index must be read-only. -* A copy of every shard in the index must reside on the same node. -* The index must have a green health status. - -To make shard allocation easier, we recommend you also remove the index's replica shards. -You can later re-add replica shards as part of the shrink operation. - -The requested number of primary shards in the target index must be a factor of the number of shards in the source index. -For example an index with 8 primary shards can be shrunk into 4, 2 or 1 primary shards or an index with 15 primary shards can be shrunk into 5, 3 or 1. -If the number of shards in the index is a prime number it can only be shrunk into a single primary shard - Before shrinking, a (primary or replica) copy of every shard in the index must be present on the same node. - -The current write index on a data stream cannot be shrunk. In order to shrink the current write index, the data stream must first be rolled over so that a new write index is created and then the previous write index can be shrunk. - -A shrink operation: - -* Creates a new target index with the same definition as the source index, but with a smaller number of primary shards. -* Hard-links segments from the source index into the target index. If the file system does not support hard-linking, then all segments are copied into the new index, which is a much more time consuming process. Also if using multiple data paths, shards on different data paths require a full copy of segment files if they are not on the same disk since hardlinks do not work across disks. -* Recovers the target index as though it were a closed index which had just been re-opened. Recovers shards to the `.routing.allocation.initial_recovery._id` index setting. - -IMPORTANT: Indices can only be shrunk if they satisfy the following requirements: - -* The target index must not exist. -* The source index must have more primary shards than the target index. -* The number of primary shards in the target index must be a factor of the number of primary shards in the source index. The source index must have more primary shards than the target index. -* The index must not contain more than 2,147,483,519 documents in total across all shards that will be shrunk into a single shard on the target index as this is the maximum number of docs that can fit into a single shard. -* The node handling the shrink process must have sufficient free disk space to accommodate a second copy of the existing index. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-shrink) - -```ts -client.indices.shrink({ index, target }) -``` - -### Arguments [_arguments_indices.shrink] - -#### Request (object) [_request_indices.shrink] -- **`index` (string)**: Name of the source index to shrink. -- **`target` (string)**: Name of the target index to create. -- **`aliases` (Optional, Record)**: The key is the alias name. -Index alias names support date math. -- **`settings` (Optional, Record)**: Configuration options for the target index. -- **`master_timeout` (Optional, string \| -1 \| 0)**: Period to wait for a connection to the master node. -If no response is received before the timeout expires, the request fails and returns an error. -- **`timeout` (Optional, string \| -1 \| 0)**: Period to wait for a response. -If no response is received before the timeout expires, the request fails and returns an error. -- **`wait_for_active_shards` (Optional, number \| Enum("all" \| "index-setting"))**: The number of shard copies that must be active before proceeding with the operation. -Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). - -## client.indices.simulateIndexTemplate [_indices.simulate_index_template] -Simulate an index. -Get the index configuration that would be applied to the specified index from an existing index template. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-simulate-index-template) - -```ts -client.indices.simulateIndexTemplate({ name }) -``` - -### Arguments [_arguments_indices.simulate_index_template] - -#### Request (object) [_request_indices.simulate_index_template] -- **`name` (string)**: Name of the index to simulate -- **`create` (Optional, boolean)**: Whether the index template we optionally defined in the body should only be dry-run added if new or can also replace an existing one -- **`cause` (Optional, string)**: User defined reason for dry-run creating the new template for simulation purposes -- **`master_timeout` (Optional, string \| -1 \| 0)**: Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. -- **`include_defaults` (Optional, boolean)**: If true, returns all relevant default configurations for the index template. - -## client.indices.simulateTemplate [_indices.simulate_template] -Simulate an index template. -Get the index configuration that would be applied by a particular index template. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-simulate-template) - -```ts -client.indices.simulateTemplate({ ... }) -``` - -### Arguments [_arguments_indices.simulate_template] - -#### Request (object) [_request_indices.simulate_template] -- **`name` (Optional, string)**: Name of the index template to simulate. To test a template configuration before you add it to the cluster, omit -this parameter and specify the template configuration in the request body. -- **`allow_auto_create` (Optional, boolean)**: This setting overrides the value of the `action.auto_create_index` cluster setting. -If set to `true` in a template, then indices can be automatically created using that template even if auto-creation of indices is disabled via `actions.auto_create_index`. -If set to `false`, then indices or data streams matching the template must always be explicitly created, and may never be automatically created. -- **`index_patterns` (Optional, string \| string[])**: Array of wildcard (`*`) expressions used to match the names of data streams and indices during creation. -- **`composed_of` (Optional, string[])**: An ordered list of component template names. -Component templates are merged in the order specified, meaning that the last component template specified has the highest precedence. -- **`template` (Optional, { aliases, mappings, settings, lifecycle })**: Template to be applied. -It may optionally include an `aliases`, `mappings`, or `settings` configuration. -- **`data_stream` (Optional, { hidden, allow_custom_routing })**: If this object is included, the template is used to create data streams and their backing indices. -Supports an empty object. -Data streams require a matching index template with a `data_stream` object. -- **`priority` (Optional, number)**: Priority to determine index template precedence when a new data stream or index is created. -The index template with the highest priority is chosen. -If no priority is specified the template is treated as though it is of priority 0 (lowest priority). -This number is not automatically generated by Elasticsearch. -- **`version` (Optional, number)**: Version number used to manage index templates externally. -This number is not automatically generated by Elasticsearch. -- **`_meta` (Optional, Record)**: Optional user metadata about the index template. -May have any contents. -This map is not automatically generated by Elasticsearch. -- **`ignore_missing_component_templates` (Optional, string[])**: The configuration option ignore_missing_component_templates can be used when an index template -references a component template that might not exist -- **`deprecated` (Optional, boolean)**: Marks this index template as deprecated. When creating or updating a non-deprecated index template -that uses deprecated components, Elasticsearch will emit a deprecation warning. -- **`create` (Optional, boolean)**: If true, the template passed in the body is only used if no existing templates match the same index patterns. If false, the simulation uses the template with the highest priority. Note that the template is not permanently added or updated in either case; it is only used for the simulation. -- **`cause` (Optional, string)**: User defined reason for dry-run creating the new template for simulation purposes -- **`master_timeout` (Optional, string \| -1 \| 0)**: Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. -- **`include_defaults` (Optional, boolean)**: If true, returns all relevant default configurations for the index template. - -## client.indices.split [_indices.split] -Split an index. -Split an index into a new index with more primary shards. -* Before you can split an index: - -* The index must be read-only. -* The cluster health status must be green. - -You can do make an index read-only with the following request using the add index block API: - -``` -PUT /my_source_index/_block/write -``` - -The current write index on a data stream cannot be split. -In order to split the current write index, the data stream must first be rolled over so that a new write index is created and then the previous write index can be split. - -The number of times the index can be split (and the number of shards that each original shard can be split into) is determined by the `index.number_of_routing_shards` setting. -The number of routing shards specifies the hashing space that is used internally to distribute documents across shards with consistent hashing. -For instance, a 5 shard index with `number_of_routing_shards` set to 30 (5 x 2 x 3) could be split by a factor of 2 or 3. - -A split operation: - -* Creates a new target index with the same definition as the source index, but with a larger number of primary shards. -* Hard-links segments from the source index into the target index. If the file system doesn't support hard-linking, all segments are copied into the new index, which is a much more time consuming process. -* Hashes all documents again, after low level files are created, to delete documents that belong to a different shard. -* Recovers the target index as though it were a closed index which had just been re-opened. - -IMPORTANT: Indices can only be split if they satisfy the following requirements: - -* The target index must not exist. -* The source index must have fewer primary shards than the target index. -* The number of primary shards in the target index must be a multiple of the number of primary shards in the source index. -* The node handling the split process must have sufficient free disk space to accommodate a second copy of the existing index. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-split) - -```ts -client.indices.split({ index, target }) -``` - -### Arguments [_arguments_indices.split] - -#### Request (object) [_request_indices.split] -- **`index` (string)**: Name of the source index to split. -- **`target` (string)**: Name of the target index to create. -- **`aliases` (Optional, Record)**: Aliases for the resulting index. -- **`settings` (Optional, Record)**: Configuration options for the target index. -- **`master_timeout` (Optional, string \| -1 \| 0)**: Period to wait for a connection to the master node. -If no response is received before the timeout expires, the request fails and returns an error. -- **`timeout` (Optional, string \| -1 \| 0)**: Period to wait for a response. -If no response is received before the timeout expires, the request fails and returns an error. -- **`wait_for_active_shards` (Optional, number \| Enum("all" \| "index-setting"))**: The number of shard copies that must be active before proceeding with the operation. -Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). - -## client.indices.stats [_indices.stats] -Get index statistics. -For data streams, the API retrieves statistics for the stream's backing indices. - -By default, the returned statistics are index-level with `primaries` and `total` aggregations. -`primaries` are the values for only the primary shards. -`total` are the accumulated values for both primary and replica shards. - -To get shard-level statistics, set the `level` parameter to `shards`. - -NOTE: When moving to another node, the shard-level statistics for a shard are cleared. -Although the shard is no longer part of the node, that node retains any node-level statistics to which the shard contributed. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-stats) - -```ts -client.indices.stats({ ... }) -``` - -### Arguments [_arguments_indices.stats] - -#### Request (object) [_request_indices.stats] -- **`metric` (Optional, string \| string[])**: Limit the information returned the specific metrics. -- **`index` (Optional, string \| string[])**: A list of index names; use `_all` or empty string to perform the operation on all indices -- **`completion_fields` (Optional, string \| string[])**: List or wildcard expressions of fields to include in fielddata and suggest statistics. -- **`expand_wildcards` (Optional, Enum("all" \| "open" \| "closed" \| "hidden" \| "none") \| Enum("all" \| "open" \| "closed" \| "hidden" \| "none")[])**: Type of index that wildcard patterns can match. If the request can target data streams, this argument -determines whether wildcard expressions match hidden data streams. Supports a list of values, -such as `open,hidden`. -- **`fielddata_fields` (Optional, string \| string[])**: List or wildcard expressions of fields to include in fielddata statistics. -- **`fields` (Optional, string \| string[])**: List or wildcard expressions of fields to include in the statistics. -- **`forbid_closed_indices` (Optional, boolean)**: If true, statistics are not collected from closed indices. -- **`groups` (Optional, string \| string[])**: List of search groups to include in the search statistics. -- **`include_segment_file_sizes` (Optional, boolean)**: If true, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested). -- **`include_unloaded_segments` (Optional, boolean)**: If true, the response includes information from segments that are not loaded into memory. -- **`level` (Optional, Enum("cluster" \| "indices" \| "shards"))**: Indicates whether statistics are aggregated at the cluster, index, or shard level. - -## client.indices.updateAliases [_indices.update_aliases] -Create or update an alias. -Adds a data stream or index to an alias. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-update-aliases) - -```ts -client.indices.updateAliases({ ... }) -``` - -### Arguments [_arguments_indices.update_aliases] - -#### Request (object) [_request_indices.update_aliases] -- **`actions` (Optional, { add_backing_index, remove_backing_index }[])**: Actions to perform. -- **`master_timeout` (Optional, string \| -1 \| 0)**: Period to wait for a connection to the master node. -If no response is received before the timeout expires, the request fails and returns an error. -- **`timeout` (Optional, string \| -1 \| 0)**: Period to wait for a response. -If no response is received before the timeout expires, the request fails and returns an error. - -## client.indices.validateQuery [_indices.validate_query] -Validate a query. -Validates a query without running it. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-validate-query) - -```ts -client.indices.validateQuery({ ... }) -``` - -### Arguments [_arguments_indices.validate_query] - -#### Request (object) [_request_indices.validate_query] -- **`index` (Optional, string \| string[])**: List of data streams, indices, and aliases to search. -Supports wildcards (`*`). -To search all data streams or indices, omit this parameter or use `*` or `_all`. -- **`query` (Optional, { bool, boosting, common, combined_fields, constant_score, dis_max, distance_feature, exists, function_score, fuzzy, geo_bounding_box, geo_distance, geo_grid, geo_polygon, geo_shape, has_child, has_parent, ids, intervals, knn, match, match_all, match_bool_prefix, match_none, match_phrase, match_phrase_prefix, more_like_this, multi_match, nested, parent_id, percolate, pinned, prefix, query_string, range, rank_feature, regexp, rule, script, script_score, semantic, shape, simple_query_string, span_containing, span_field_masking, span_first, span_multi, span_near, span_not, span_or, span_term, span_within, sparse_vector, term, terms, terms_set, text_expansion, weighted_tokens, wildcard, wrapper, type })**: Query in the Lucene query string syntax. -- **`allow_no_indices` (Optional, boolean)**: If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. -This behavior applies even if the request targets other open indices. -- **`all_shards` (Optional, boolean)**: If `true`, the validation is executed on all shards instead of one random shard per index. -- **`analyzer` (Optional, string)**: Analyzer to use for the query string. -This parameter can only be used when the `q` query string parameter is specified. -- **`analyze_wildcard` (Optional, boolean)**: If `true`, wildcard and prefix queries are analyzed. -- **`default_operator` (Optional, Enum("and" \| "or"))**: The default operator for query string query: `AND` or `OR`. -- **`df` (Optional, string)**: Field to use as default where no field prefix is given in the query string. -This parameter can only be used when the `q` query string parameter is specified. -- **`expand_wildcards` (Optional, Enum("all" \| "open" \| "closed" \| "hidden" \| "none") \| Enum("all" \| "open" \| "closed" \| "hidden" \| "none")[])**: Type of index that wildcard patterns can match. -If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. -Supports a list of values, such as `open,hidden`. -Valid values are: `all`, `open`, `closed`, `hidden`, `none`. -- **`explain` (Optional, boolean)**: If `true`, the response returns detailed information if an error has occurred. -- **`ignore_unavailable` (Optional, boolean)**: If `false`, the request returns an error if it targets a missing or closed index. -- **`lenient` (Optional, boolean)**: If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. -- **`rewrite` (Optional, boolean)**: If `true`, returns a more detailed explanation showing the actual Lucene query that will be executed. -- **`q` (Optional, string)**: Query in the Lucene query string syntax. - -## client.inference.chatCompletionUnified [_inference.chat_completion_unified] -Perform chat completion inference - -The chat completion inference API enables real-time responses for chat completion tasks by delivering answers incrementally, reducing response times during computation. -It only works with the `chat_completion` task type for `openai` and `elastic` inference services. - -IMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Azure, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face. -For built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models. However, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs. - -NOTE: The `chat_completion` task type is only available within the _stream API and only supports streaming. -The Chat completion inference API and the Stream inference API differ in their response structure and capabilities. -The Chat completion inference API provides more comprehensive customization options through more fields and function calling support. -If you use the `openai` service or the `elastic` service, use the Chat completion inference API. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-unified-inference) - -```ts -client.inference.chatCompletionUnified({ inference_id }) -``` - -### Arguments [_arguments_inference.chat_completion_unified] - -#### Request (object) [_request_inference.chat_completion_unified] -- **`inference_id` (string)**: The inference Id -- **`chat_completion_request` (Optional, { messages, model, max_completion_tokens, stop, temperature, tool_choice, tools, top_p })** -- **`timeout` (Optional, string \| -1 \| 0)**: Specifies the amount of time to wait for the inference request to complete. - -## client.inference.completion [_inference.completion] -Perform completion inference on the service - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-inference) - -```ts -client.inference.completion({ inference_id, input }) -``` - -### Arguments [_arguments_inference.completion] - -#### Request (object) [_request_inference.completion] -- **`inference_id` (string)**: The inference Id -- **`input` (string \| string[])**: Inference input. -Either a string or an array of strings. -- **`task_settings` (Optional, User-defined value)**: Optional task settings -- **`timeout` (Optional, string \| -1 \| 0)**: Specifies the amount of time to wait for the inference request to complete. - -## client.inference.delete [_inference.delete] -Delete an inference endpoint - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-delete) - -```ts -client.inference.delete({ inference_id }) -``` - -### Arguments [_arguments_inference.delete] - -#### Request (object) [_request_inference.delete] -- **`inference_id` (string)**: The inference identifier. -- **`task_type` (Optional, Enum("sparse_embedding" \| "text_embedding" \| "rerank" \| "completion" \| "chat_completion"))**: The task type -- **`dry_run` (Optional, boolean)**: When true, the endpoint is not deleted and a list of ingest processors which reference this endpoint is returned. -- **`force` (Optional, boolean)**: When true, the inference endpoint is forcefully deleted even if it is still being used by ingest processors or semantic text fields. - -## client.inference.get [_inference.get] -Get an inference endpoint - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-get) - -```ts -client.inference.get({ ... }) -``` - -### Arguments [_arguments_inference.get] - -#### Request (object) [_request_inference.get] -- **`task_type` (Optional, Enum("sparse_embedding" \| "text_embedding" \| "rerank" \| "completion" \| "chat_completion"))**: The task type -- **`inference_id` (Optional, string)**: The inference Id - -## client.inference.inference [_inference.inference] -Perform inference on the service. - -This API enables you to use machine learning models to perform specific tasks on data that you provide as an input. -It returns a response with the results of the tasks. -The inference endpoint you use can perform one specific task that has been defined when the endpoint was created with the create inference API. - -For details about using this API with a service, such as Amazon Bedrock, Anthropic, or HuggingFace, refer to the service-specific documentation. - -> info -> The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Azure, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face. For built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models. However, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-inference) - -```ts -client.inference.inference({ inference_id, input }) -``` - -### Arguments [_arguments_inference.inference] - -#### Request (object) [_request_inference.inference] -- **`inference_id` (string)**: The unique identifier for the inference endpoint. -- **`input` (string \| string[])**: The text on which you want to perform the inference task. -It can be a single string or an array. - -> info -> Inference endpoints for the `completion` task type currently only support a single string as input. -- **`task_type` (Optional, Enum("sparse_embedding" \| "text_embedding" \| "rerank" \| "completion" \| "chat_completion"))**: The type of inference task that the model performs. -- **`query` (Optional, string)**: The query input, which is required only for the `rerank` task. -It is not required for other tasks. -- **`task_settings` (Optional, User-defined value)**: Task settings for the individual inference request. -These settings are specific to the task type you specified and override the task settings specified when initializing the service. -- **`timeout` (Optional, string \| -1 \| 0)**: The amount of time to wait for the inference request to complete. - -## client.inference.put [_inference.put] -Create an inference endpoint. - -IMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Mistral, Azure OpenAI, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face. -For built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models. -However, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put) - -```ts -client.inference.put({ inference_id }) -``` - -### Arguments [_arguments_inference.put] - -#### Request (object) [_request_inference.put] -- **`inference_id` (string)**: The inference Id -- **`task_type` (Optional, Enum("sparse_embedding" \| "text_embedding" \| "rerank" \| "completion" \| "chat_completion"))**: The task type -- **`inference_config` (Optional, { chunking_settings, service, service_settings, task_settings })** - -## client.inference.putAlibabacloud [_inference.put_alibabacloud] -Create an AlibabaCloud AI Search inference endpoint. - -Create an inference endpoint to perform an inference task with the `alibabacloud-ai-search` service. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-alibabacloud) - -```ts -client.inference.putAlibabacloud({ task_type, alibabacloud_inference_id, service, service_settings }) -``` - -### Arguments [_arguments_inference.put_alibabacloud] - -#### Request (object) [_request_inference.put_alibabacloud] -- **`task_type` (Enum("completion" \| "rerank" \| "space_embedding" \| "text_embedding"))**: The type of the inference task that the model will perform. -- **`alibabacloud_inference_id` (string)**: The unique identifier of the inference endpoint. -- **`service` (Enum("alibabacloud-ai-search"))**: The type of service supported for the specified task type. In this case, `alibabacloud-ai-search`. -- **`service_settings` ({ api_key, host, rate_limit, service_id, workspace })**: Settings used to install the inference model. These settings are specific to the `alibabacloud-ai-search` service. -- **`chunking_settings` (Optional, { max_chunk_size, overlap, sentence_overlap, strategy })**: The chunking configuration object. -- **`task_settings` (Optional, { input_type, return_token })**: Settings to configure the inference task. -These settings are specific to the task type you specified. - -## client.inference.putAmazonbedrock [_inference.put_amazonbedrock] -Create an Amazon Bedrock inference endpoint. - -Creates an inference endpoint to perform an inference task with the `amazonbedrock` service. - ->info -> You need to provide the access and secret keys only once, during the inference model creation. The get inference API does not retrieve your access or secret keys. After creating the inference model, you cannot change the associated key pairs. If you want to use a different access and secret key pair, delete the inference model and recreate it with the same name and the updated keys. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-amazonbedrock) - -```ts -client.inference.putAmazonbedrock({ task_type, amazonbedrock_inference_id, service, service_settings }) -``` - -### Arguments [_arguments_inference.put_amazonbedrock] - -#### Request (object) [_request_inference.put_amazonbedrock] -- **`task_type` (Enum("completion" \| "text_embedding"))**: The type of the inference task that the model will perform. -- **`amazonbedrock_inference_id` (string)**: The unique identifier of the inference endpoint. -- **`service` (Enum("amazonbedrock"))**: The type of service supported for the specified task type. In this case, `amazonbedrock`. -- **`service_settings` ({ access_key, model, provider, region, rate_limit, secret_key })**: Settings used to install the inference model. These settings are specific to the `amazonbedrock` service. -- **`chunking_settings` (Optional, { max_chunk_size, overlap, sentence_overlap, strategy })**: The chunking configuration object. -- **`task_settings` (Optional, { max_new_tokens, temperature, top_k, top_p })**: Settings to configure the inference task. -These settings are specific to the task type you specified. - -## client.inference.putAnthropic [_inference.put_anthropic] -Create an Anthropic inference endpoint. - -Create an inference endpoint to perform an inference task with the `anthropic` service. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-anthropic) - -```ts -client.inference.putAnthropic({ task_type, anthropic_inference_id, service, service_settings }) -``` - -### Arguments [_arguments_inference.put_anthropic] - -#### Request (object) [_request_inference.put_anthropic] -- **`task_type` (Enum("completion"))**: The task type. -The only valid task type for the model to perform is `completion`. -- **`anthropic_inference_id` (string)**: The unique identifier of the inference endpoint. -- **`service` (Enum("anthropic"))**: The type of service supported for the specified task type. In this case, `anthropic`. -- **`service_settings` ({ api_key, model_id, rate_limit })**: Settings used to install the inference model. These settings are specific to the `watsonxai` service. -- **`chunking_settings` (Optional, { max_chunk_size, overlap, sentence_overlap, strategy })**: The chunking configuration object. -- **`task_settings` (Optional, { max_tokens, temperature, top_k, top_p })**: Settings to configure the inference task. -These settings are specific to the task type you specified. - -## client.inference.putAzureaistudio [_inference.put_azureaistudio] -Create an Azure AI studio inference endpoint. - -Create an inference endpoint to perform an inference task with the `azureaistudio` service. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-azureaistudio) - -```ts -client.inference.putAzureaistudio({ task_type, azureaistudio_inference_id, service, service_settings }) -``` - -### Arguments [_arguments_inference.put_azureaistudio] - -#### Request (object) [_request_inference.put_azureaistudio] -- **`task_type` (Enum("completion" \| "text_embedding"))**: The type of the inference task that the model will perform. -- **`azureaistudio_inference_id` (string)**: The unique identifier of the inference endpoint. -- **`service` (Enum("azureaistudio"))**: The type of service supported for the specified task type. In this case, `azureaistudio`. -- **`service_settings` ({ api_key, endpoint_type, target, provider, rate_limit })**: Settings used to install the inference model. These settings are specific to the `openai` service. -- **`chunking_settings` (Optional, { max_chunk_size, overlap, sentence_overlap, strategy })**: The chunking configuration object. -- **`task_settings` (Optional, { do_sample, max_new_tokens, temperature, top_p, user })**: Settings to configure the inference task. -These settings are specific to the task type you specified. - -## client.inference.putAzureopenai [_inference.put_azureopenai] -Create an Azure OpenAI inference endpoint. - -Create an inference endpoint to perform an inference task with the `azureopenai` service. - -The list of chat completion models that you can choose from in your Azure OpenAI deployment include: - -* [GPT-4 and GPT-4 Turbo models](https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models?tabs=global-standard%2Cstandard-chat-completions#gpt-4-and-gpt-4-turbo-models) -* [GPT-3.5](https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models?tabs=global-standard%2Cstandard-chat-completions#gpt-35) - -The list of embeddings models that you can choose from in your deployment can be found in the [Azure models documentation](https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models?tabs=global-standard%2Cstandard-chat-completions#embeddings). - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-azureopenai) - -```ts -client.inference.putAzureopenai({ task_type, azureopenai_inference_id, service, service_settings }) -``` - -### Arguments [_arguments_inference.put_azureopenai] - -#### Request (object) [_request_inference.put_azureopenai] -- **`task_type` (Enum("completion" \| "text_embedding"))**: The type of the inference task that the model will perform. -NOTE: The `chat_completion` task type only supports streaming and only through the _stream API. -- **`azureopenai_inference_id` (string)**: The unique identifier of the inference endpoint. -- **`service` (Enum("azureopenai"))**: The type of service supported for the specified task type. In this case, `azureopenai`. -- **`service_settings` ({ api_key, api_version, deployment_id, entra_id, rate_limit, resource_name })**: Settings used to install the inference model. These settings are specific to the `azureopenai` service. -- **`chunking_settings` (Optional, { max_chunk_size, overlap, sentence_overlap, strategy })**: The chunking configuration object. -- **`task_settings` (Optional, { user })**: Settings to configure the inference task. -These settings are specific to the task type you specified. - -## client.inference.putCohere [_inference.put_cohere] -Create a Cohere inference endpoint. - -Create an inference endpoint to perform an inference task with the `cohere` service. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-cohere) - -```ts -client.inference.putCohere({ task_type, cohere_inference_id, service, service_settings }) -``` - -### Arguments [_arguments_inference.put_cohere] - -#### Request (object) [_request_inference.put_cohere] -- **`task_type` (Enum("completion" \| "rerank" \| "text_embedding"))**: The type of the inference task that the model will perform. -- **`cohere_inference_id` (string)**: The unique identifier of the inference endpoint. -- **`service` (Enum("cohere"))**: The type of service supported for the specified task type. In this case, `cohere`. -- **`service_settings` ({ api_key, embedding_type, model_id, rate_limit, similarity })**: Settings used to install the inference model. -These settings are specific to the `cohere` service. -- **`chunking_settings` (Optional, { max_chunk_size, overlap, sentence_overlap, strategy })**: The chunking configuration object. -- **`task_settings` (Optional, { input_type, return_documents, top_n, truncate })**: Settings to configure the inference task. -These settings are specific to the task type you specified. - -## client.inference.putElasticsearch [_inference.put_elasticsearch] -Create an Elasticsearch inference endpoint. - -Create an inference endpoint to perform an inference task with the `elasticsearch` service. - -> info -> Your Elasticsearch deployment contains preconfigured ELSER and E5 inference endpoints, you only need to create the enpoints using the API if you want to customize the settings. - -If you use the ELSER or the E5 model through the `elasticsearch` service, the API request will automatically download and deploy the model if it isn't downloaded yet. - -> info -> You might see a 502 bad gateway error in the response when using the Kibana Console. This error usually just reflects a timeout, while the model downloads in the background. You can check the download progress in the Machine Learning UI. If using the Python client, you can set the timeout parameter to a higher value. - -After creating the endpoint, wait for the model deployment to complete before using it. -To verify the deployment status, use the get trained model statistics API. -Look for `"state": "fully_allocated"` in the response and ensure that the `"allocation_count"` matches the `"target_allocation_count"`. -Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-elasticsearch) - -```ts -client.inference.putElasticsearch({ task_type, elasticsearch_inference_id, service, service_settings }) -``` - -### Arguments [_arguments_inference.put_elasticsearch] - -#### Request (object) [_request_inference.put_elasticsearch] -- **`task_type` (Enum("rerank" \| "sparse_embedding" \| "text_embedding"))**: The type of the inference task that the model will perform. -- **`elasticsearch_inference_id` (string)**: The unique identifier of the inference endpoint. -The must not match the `model_id`. -- **`service` (Enum("elasticsearch"))**: The type of service supported for the specified task type. In this case, `elasticsearch`. -- **`service_settings` ({ adaptive_allocations, deployment_id, model_id, num_allocations, num_threads })**: Settings used to install the inference model. These settings are specific to the `elasticsearch` service. -- **`chunking_settings` (Optional, { max_chunk_size, overlap, sentence_overlap, strategy })**: The chunking configuration object. -- **`task_settings` (Optional, { return_documents })**: Settings to configure the inference task. -These settings are specific to the task type you specified. - -## client.inference.putElser [_inference.put_elser] -Create an ELSER inference endpoint. - -Create an inference endpoint to perform an inference task with the `elser` service. -You can also deploy ELSER by using the Elasticsearch inference integration. - -> info -> Your Elasticsearch deployment contains a preconfigured ELSER inference endpoint, you only need to create the enpoint using the API if you want to customize the settings. - -The API request will automatically download and deploy the ELSER model if it isn't already downloaded. - -> info -> You might see a 502 bad gateway error in the response when using the Kibana Console. This error usually just reflects a timeout, while the model downloads in the background. You can check the download progress in the Machine Learning UI. If using the Python client, you can set the timeout parameter to a higher value. - -After creating the endpoint, wait for the model deployment to complete before using it. -To verify the deployment status, use the get trained model statistics API. -Look for `"state": "fully_allocated"` in the response and ensure that the `"allocation_count"` matches the `"target_allocation_count"`. -Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-elser) - -```ts -client.inference.putElser({ task_type, elser_inference_id, service, service_settings }) -``` - -### Arguments [_arguments_inference.put_elser] - -#### Request (object) [_request_inference.put_elser] -- **`task_type` (Enum("sparse_embedding"))**: The type of the inference task that the model will perform. -- **`elser_inference_id` (string)**: The unique identifier of the inference endpoint. -- **`service` (Enum("elser"))**: The type of service supported for the specified task type. In this case, `elser`. -- **`service_settings` ({ adaptive_allocations, num_allocations, num_threads })**: Settings used to install the inference model. These settings are specific to the `elser` service. -- **`chunking_settings` (Optional, { max_chunk_size, overlap, sentence_overlap, strategy })**: The chunking configuration object. - -## client.inference.putGoogleaistudio [_inference.put_googleaistudio] -Create an Google AI Studio inference endpoint. - -Create an inference endpoint to perform an inference task with the `googleaistudio` service. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-googleaistudio) - -```ts -client.inference.putGoogleaistudio({ task_type, googleaistudio_inference_id, service, service_settings }) -``` - -### Arguments [_arguments_inference.put_googleaistudio] - -#### Request (object) [_request_inference.put_googleaistudio] -- **`task_type` (Enum("completion" \| "text_embedding"))**: The type of the inference task that the model will perform. -- **`googleaistudio_inference_id` (string)**: The unique identifier of the inference endpoint. -- **`service` (Enum("googleaistudio"))**: The type of service supported for the specified task type. In this case, `googleaistudio`. -- **`service_settings` ({ api_key, model_id, rate_limit })**: Settings used to install the inference model. These settings are specific to the `googleaistudio` service. -- **`chunking_settings` (Optional, { max_chunk_size, overlap, sentence_overlap, strategy })**: The chunking configuration object. - -## client.inference.putGooglevertexai [_inference.put_googlevertexai] -Create a Google Vertex AI inference endpoint. - -Create an inference endpoint to perform an inference task with the `googlevertexai` service. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-googlevertexai) - -```ts -client.inference.putGooglevertexai({ task_type, googlevertexai_inference_id, service, service_settings }) -``` - -### Arguments [_arguments_inference.put_googlevertexai] - -#### Request (object) [_request_inference.put_googlevertexai] -- **`task_type` (Enum("rerank" \| "text_embedding"))**: The type of the inference task that the model will perform. -- **`googlevertexai_inference_id` (string)**: The unique identifier of the inference endpoint. -- **`service` (Enum("googlevertexai"))**: The type of service supported for the specified task type. In this case, `googlevertexai`. -- **`service_settings` ({ location, model_id, project_id, rate_limit, service_account_json })**: Settings used to install the inference model. These settings are specific to the `googlevertexai` service. -- **`chunking_settings` (Optional, { max_chunk_size, overlap, sentence_overlap, strategy })**: The chunking configuration object. -- **`task_settings` (Optional, { auto_truncate, top_n })**: Settings to configure the inference task. -These settings are specific to the task type you specified. - -## client.inference.putHuggingFace [_inference.put_hugging_face] -Create a Hugging Face inference endpoint. - -Create an inference endpoint to perform an inference task with the `hugging_face` service. - -You must first create an inference endpoint on the Hugging Face endpoint page to get an endpoint URL. -Select the model you want to use on the new endpoint creation page (for example `intfloat/e5-small-v2`), then select the sentence embeddings task under the advanced configuration section. -Create the endpoint and copy the URL after the endpoint initialization has been finished. - -The following models are recommended for the Hugging Face service: - -* `all-MiniLM-L6-v2` -* `all-MiniLM-L12-v2` -* `all-mpnet-base-v2` -* `e5-base-v2` -* `e5-small-v2` -* `multilingual-e5-base` -* `multilingual-e5-small` - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-hugging-face) - -```ts -client.inference.putHuggingFace({ task_type, huggingface_inference_id, service, service_settings }) -``` - -### Arguments [_arguments_inference.put_hugging_face] - -#### Request (object) [_request_inference.put_hugging_face] -- **`task_type` (Enum("text_embedding"))**: The type of the inference task that the model will perform. -- **`huggingface_inference_id` (string)**: The unique identifier of the inference endpoint. -- **`service` (Enum("hugging_face"))**: The type of service supported for the specified task type. In this case, `hugging_face`. -- **`service_settings` ({ api_key, rate_limit, url })**: Settings used to install the inference model. These settings are specific to the `hugging_face` service. -- **`chunking_settings` (Optional, { max_chunk_size, overlap, sentence_overlap, strategy })**: The chunking configuration object. - -## client.inference.putJinaai [_inference.put_jinaai] -Create an JinaAI inference endpoint. - -Create an inference endpoint to perform an inference task with the `jinaai` service. - -To review the available `rerank` models, refer to . -To review the available `text_embedding` models, refer to the . - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-jinaai) - -```ts -client.inference.putJinaai({ task_type, jinaai_inference_id, service, service_settings }) -``` - -### Arguments [_arguments_inference.put_jinaai] - -#### Request (object) [_request_inference.put_jinaai] -- **`task_type` (Enum("rerank" \| "text_embedding"))**: The type of the inference task that the model will perform. -- **`jinaai_inference_id` (string)**: The unique identifier of the inference endpoint. -- **`service` (Enum("jinaai"))**: The type of service supported for the specified task type. In this case, `jinaai`. -- **`service_settings` ({ api_key, model_id, rate_limit, similarity })**: Settings used to install the inference model. These settings are specific to the `jinaai` service. -- **`chunking_settings` (Optional, { max_chunk_size, overlap, sentence_overlap, strategy })**: The chunking configuration object. -- **`task_settings` (Optional, { return_documents, task, top_n })**: Settings to configure the inference task. -These settings are specific to the task type you specified. - -## client.inference.putMistral [_inference.put_mistral] -Create a Mistral inference endpoint. - -Creates an inference endpoint to perform an inference task with the `mistral` service. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-mistral) - -```ts -client.inference.putMistral({ task_type, mistral_inference_id, service, service_settings }) -``` - -### Arguments [_arguments_inference.put_mistral] - -#### Request (object) [_request_inference.put_mistral] -- **`task_type` (Enum("text_embedding"))**: The task type. -The only valid task type for the model to perform is `text_embedding`. -- **`mistral_inference_id` (string)**: The unique identifier of the inference endpoint. -- **`service` (Enum("mistral"))**: The type of service supported for the specified task type. In this case, `mistral`. -- **`service_settings` ({ api_key, max_input_tokens, model, rate_limit })**: Settings used to install the inference model. These settings are specific to the `mistral` service. -- **`chunking_settings` (Optional, { max_chunk_size, overlap, sentence_overlap, strategy })**: The chunking configuration object. - -## client.inference.putOpenai [_inference.put_openai] -Create an OpenAI inference endpoint. - -Create an inference endpoint to perform an inference task with the `openai` service or `openai` compatible APIs. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-openai) - -```ts -client.inference.putOpenai({ task_type, openai_inference_id, service, service_settings }) -``` - -### Arguments [_arguments_inference.put_openai] - -#### Request (object) [_request_inference.put_openai] -- **`task_type` (Enum("chat_completion" \| "completion" \| "text_embedding"))**: The type of the inference task that the model will perform. -NOTE: The `chat_completion` task type only supports streaming and only through the _stream API. -- **`openai_inference_id` (string)**: The unique identifier of the inference endpoint. -- **`service` (Enum("openai"))**: The type of service supported for the specified task type. In this case, `openai`. -- **`service_settings` ({ api_key, dimensions, model_id, organization_id, rate_limit, url })**: Settings used to install the inference model. These settings are specific to the `openai` service. -- **`chunking_settings` (Optional, { max_chunk_size, overlap, sentence_overlap, strategy })**: The chunking configuration object. -- **`task_settings` (Optional, { user })**: Settings to configure the inference task. -These settings are specific to the task type you specified. - -## client.inference.putVoyageai [_inference.put_voyageai] -Create a VoyageAI inference endpoint. - -Create an inference endpoint to perform an inference task with the `voyageai` service. - -Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-voyageai) - -```ts -client.inference.putVoyageai({ task_type, voyageai_inference_id, service, service_settings }) -``` - -### Arguments [_arguments_inference.put_voyageai] - -#### Request (object) [_request_inference.put_voyageai] -- **`task_type` (Enum("text_embedding" \| "rerank"))**: The type of the inference task that the model will perform. -- **`voyageai_inference_id` (string)**: The unique identifier of the inference endpoint. -- **`service` (Enum("voyageai"))**: The type of service supported for the specified task type. In this case, `voyageai`. -- **`service_settings` ({ dimensions, model_id, rate_limit, embedding_type })**: Settings used to install the inference model. These settings are specific to the `voyageai` service. -- **`chunking_settings` (Optional, { max_chunk_size, overlap, sentence_overlap, strategy })**: The chunking configuration object. -- **`task_settings` (Optional, { input_type, return_documents, top_k, truncation })**: Settings to configure the inference task. -These settings are specific to the task type you specified. - -## client.inference.putWatsonx [_inference.put_watsonx] -Create a Watsonx inference endpoint. - -Create an inference endpoint to perform an inference task with the `watsonxai` service. -You need an IBM Cloud Databases for Elasticsearch deployment to use the `watsonxai` inference service. -You can provision one through the IBM catalog, the Cloud Databases CLI plug-in, the Cloud Databases API, or Terraform. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-watsonx) - -```ts -client.inference.putWatsonx({ task_type, watsonx_inference_id, service, service_settings }) -``` - -### Arguments [_arguments_inference.put_watsonx] - -#### Request (object) [_request_inference.put_watsonx] -- **`task_type` (Enum("text_embedding"))**: The task type. -The only valid task type for the model to perform is `text_embedding`. -- **`watsonx_inference_id` (string)**: The unique identifier of the inference endpoint. -- **`service` (Enum("watsonxai"))**: The type of service supported for the specified task type. In this case, `watsonxai`. -- **`service_settings` ({ api_key, api_version, model_id, project_id, rate_limit, url })**: Settings used to install the inference model. These settings are specific to the `watsonxai` service. - -## client.inference.rerank [_inference.rerank] -Perform rereanking inference on the service - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-inference) - -```ts -client.inference.rerank({ inference_id, query, input }) -``` - -### Arguments [_arguments_inference.rerank] - -#### Request (object) [_request_inference.rerank] -- **`inference_id` (string)**: The unique identifier for the inference endpoint. -- **`query` (string)**: Query input. -- **`input` (string \| string[])**: The text on which you want to perform the inference task. -It can be a single string or an array. - -> info -> Inference endpoints for the `completion` task type currently only support a single string as input. -- **`task_settings` (Optional, User-defined value)**: Task settings for the individual inference request. -These settings are specific to the task type you specified and override the task settings specified when initializing the service. -- **`timeout` (Optional, string \| -1 \| 0)**: The amount of time to wait for the inference request to complete. - -## client.inference.sparseEmbedding [_inference.sparse_embedding] -Perform sparse embedding inference on the service - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-inference) - -```ts -client.inference.sparseEmbedding({ inference_id, input }) -``` - -### Arguments [_arguments_inference.sparse_embedding] - -#### Request (object) [_request_inference.sparse_embedding] -- **`inference_id` (string)**: The inference Id -- **`input` (string \| string[])**: Inference input. -Either a string or an array of strings. -- **`task_settings` (Optional, User-defined value)**: Optional task settings -- **`timeout` (Optional, string \| -1 \| 0)**: Specifies the amount of time to wait for the inference request to complete. - -## client.inference.streamCompletion [_inference.stream_completion] -Perform streaming inference. -Get real-time responses for completion tasks by delivering answers incrementally, reducing response times during computation. -This API works only with the completion task type. - -IMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Azure, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face. For built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models. However, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs. - -This API requires the `monitor_inference` cluster privilege (the built-in `inference_admin` and `inference_user` roles grant this privilege). You must use a client that supports streaming. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-stream-inference) - -```ts -client.inference.streamCompletion({ inference_id, input }) -``` - -### Arguments [_arguments_inference.stream_completion] - -#### Request (object) [_request_inference.stream_completion] -- **`inference_id` (string)**: The unique identifier for the inference endpoint. -- **`input` (string \| string[])**: The text on which you want to perform the inference task. -It can be a single string or an array. - -NOTE: Inference endpoints for the completion task type currently only support a single string as input. -- **`task_settings` (Optional, User-defined value)**: Optional task settings - -## client.inference.textEmbedding [_inference.text_embedding] -Perform text embedding inference on the service - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-inference) - -```ts -client.inference.textEmbedding({ inference_id, input }) -``` - -### Arguments [_arguments_inference.text_embedding] - -#### Request (object) [_request_inference.text_embedding] -- **`inference_id` (string)**: The inference Id -- **`input` (string \| string[])**: Inference input. -Either a string or an array of strings. -- **`task_settings` (Optional, User-defined value)**: Optional task settings -- **`timeout` (Optional, string \| -1 \| 0)**: Specifies the amount of time to wait for the inference request to complete. - -## client.inference.update [_inference.update] -Update an inference endpoint. - -Modify `task_settings`, secrets (within `service_settings`), or `num_allocations` for an inference endpoint, depending on the specific endpoint service and `task_type`. - -IMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Azure, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face. -For built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models. -However, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-update) - -```ts -client.inference.update({ inference_id }) -``` - -### Arguments [_arguments_inference.update] - -#### Request (object) [_request_inference.update] -- **`inference_id` (string)**: The unique identifier of the inference endpoint. -- **`task_type` (Optional, Enum("sparse_embedding" \| "text_embedding" \| "rerank" \| "completion" \| "chat_completion"))**: The type of inference task that the model performs. -- **`inference_config` (Optional, { chunking_settings, service, service_settings, task_settings })** - -## client.ingest.deleteGeoipDatabase [_ingest.delete_geoip_database] -Delete GeoIP database configurations. - -Delete one or more IP geolocation database configurations. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ingest-delete-geoip-database) - -```ts -client.ingest.deleteGeoipDatabase({ id }) -``` - -### Arguments [_arguments_ingest.delete_geoip_database] - -#### Request (object) [_request_ingest.delete_geoip_database] -- **`id` (string \| string[])**: A list of geoip database configurations to delete -- **`master_timeout` (Optional, string \| -1 \| 0)**: The period to wait for a connection to the master node. -If no response is received before the timeout expires, the request fails and returns an error. -- **`timeout` (Optional, string \| -1 \| 0)**: The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. - -## client.ingest.deleteIpLocationDatabase [_ingest.delete_ip_location_database] -Delete IP geolocation database configurations. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ingest-delete-ip-location-database) - -```ts -client.ingest.deleteIpLocationDatabase({ id }) -``` - -### Arguments [_arguments_ingest.delete_ip_location_database] - -#### Request (object) [_request_ingest.delete_ip_location_database] -- **`id` (string \| string[])**: A list of IP location database configurations. -- **`master_timeout` (Optional, string \| -1 \| 0)**: The period to wait for a connection to the master node. -If no response is received before the timeout expires, the request fails and returns an error. -A value of `-1` indicates that the request should never time out. -- **`timeout` (Optional, string \| -1 \| 0)**: The period to wait for a response. -If no response is received before the timeout expires, the request fails and returns an error. -A value of `-1` indicates that the request should never time out. - -## client.ingest.deletePipeline [_ingest.delete_pipeline] -Delete pipelines. -Delete one or more ingest pipelines. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ingest-delete-pipeline) - -```ts -client.ingest.deletePipeline({ id }) -``` - -### Arguments [_arguments_ingest.delete_pipeline] - -#### Request (object) [_request_ingest.delete_pipeline] -- **`id` (string)**: Pipeline ID or wildcard expression of pipeline IDs used to limit the request. -To delete all ingest pipelines in a cluster, use a value of `*`. -- **`master_timeout` (Optional, string \| -1 \| 0)**: Period to wait for a connection to the master node. -If no response is received before the timeout expires, the request fails and returns an error. -- **`timeout` (Optional, string \| -1 \| 0)**: Period to wait for a response. -If no response is received before the timeout expires, the request fails and returns an error. - -## client.ingest.geoIpStats [_ingest.geo_ip_stats] -Get GeoIP statistics. -Get download statistics for GeoIP2 databases that are used with the GeoIP processor. - -[Endpoint documentation](https://www.elastic.co/docs/reference/enrich-processor/geoip-processor) - -```ts -client.ingest.geoIpStats() -``` - - -## client.ingest.getGeoipDatabase [_ingest.get_geoip_database] -Get GeoIP database configurations. - -Get information about one or more IP geolocation database configurations. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ingest-get-geoip-database) - -```ts -client.ingest.getGeoipDatabase({ ... }) -``` - -### Arguments [_arguments_ingest.get_geoip_database] - -#### Request (object) [_request_ingest.get_geoip_database] -- **`id` (Optional, string \| string[])**: A list of database configuration IDs to retrieve. -Wildcard (`*`) expressions are supported. -To get all database configurations, omit this parameter or use `*`. - -## client.ingest.getIpLocationDatabase [_ingest.get_ip_location_database] -Get IP geolocation database configurations. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ingest-get-ip-location-database) - -```ts -client.ingest.getIpLocationDatabase({ ... }) -``` - -### Arguments [_arguments_ingest.get_ip_location_database] - -#### Request (object) [_request_ingest.get_ip_location_database] -- **`id` (Optional, string \| string[])**: List of database configuration IDs to retrieve. -Wildcard (`*`) expressions are supported. -To get all database configurations, omit this parameter or use `*`. -- **`master_timeout` (Optional, string \| -1 \| 0)**: The period to wait for a connection to the master node. -If no response is received before the timeout expires, the request fails and returns an error. -A value of `-1` indicates that the request should never time out. - -## client.ingest.getPipeline [_ingest.get_pipeline] -Get pipelines. - -Get information about one or more ingest pipelines. -This API returns a local reference of the pipeline. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ingest-get-pipeline) - -```ts -client.ingest.getPipeline({ ... }) -``` - -### Arguments [_arguments_ingest.get_pipeline] - -#### Request (object) [_request_ingest.get_pipeline] -- **`id` (Optional, string)**: List of pipeline IDs to retrieve. -Wildcard (`*`) expressions are supported. -To get all ingest pipelines, omit this parameter or use `*`. -- **`master_timeout` (Optional, string \| -1 \| 0)**: Period to wait for a connection to the master node. -If no response is received before the timeout expires, the request fails and returns an error. -- **`summary` (Optional, boolean)**: Return pipelines without their definitions (default: false) - -## client.ingest.processorGrok [_ingest.processor_grok] -Run a grok processor. -Extract structured fields out of a single text field within a document. -You must choose which field to extract matched fields from, as well as the grok pattern you expect will match. -A grok pattern is like a regular expression that supports aliased expressions that can be reused. - -[Endpoint documentation](https://www.elastic.co/docs/reference/enrich-processor/grok-processor) - -```ts -client.ingest.processorGrok() -``` - - -## client.ingest.putGeoipDatabase [_ingest.put_geoip_database] -Create or update a GeoIP database configuration. - -Refer to the create or update IP geolocation database configuration API. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ingest-put-geoip-database) - -```ts -client.ingest.putGeoipDatabase({ id, name, maxmind }) -``` - -### Arguments [_arguments_ingest.put_geoip_database] - -#### Request (object) [_request_ingest.put_geoip_database] -- **`id` (string)**: ID of the database configuration to create or update. -- **`name` (string)**: The provider-assigned name of the IP geolocation database to download. -- **`maxmind` ({ account_id })**: The configuration necessary to identify which IP geolocation provider to use to download the database, as well as any provider-specific configuration necessary for such downloading. -At present, the only supported provider is maxmind, and the maxmind provider requires that an account_id (string) is configured. -- **`master_timeout` (Optional, string \| -1 \| 0)**: Period to wait for a connection to the master node. -If no response is received before the timeout expires, the request fails and returns an error. -- **`timeout` (Optional, string \| -1 \| 0)**: Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. - -## client.ingest.putIpLocationDatabase [_ingest.put_ip_location_database] -Create or update an IP geolocation database configuration. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ingest-put-ip-location-database) - -```ts -client.ingest.putIpLocationDatabase({ id }) -``` - -### Arguments [_arguments_ingest.put_ip_location_database] - -#### Request (object) [_request_ingest.put_ip_location_database] -- **`id` (string)**: The database configuration identifier. -- **`configuration` (Optional, { name, maxmind, ipinfo })** -- **`master_timeout` (Optional, string \| -1 \| 0)**: The period to wait for a connection to the master node. -If no response is received before the timeout expires, the request fails and returns an error. -A value of `-1` indicates that the request should never time out. -- **`timeout` (Optional, string \| -1 \| 0)**: The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata. -If no response is received before the timeout expires, the cluster metadata update still applies but the response indicates that it was not completely acknowledged. -A value of `-1` indicates that the request should never time out. - -## client.ingest.putPipeline [_ingest.put_pipeline] -Create or update a pipeline. -Changes made using this API take effect immediately. - -[Endpoint documentation](https://www.elastic.co/docs/manage-data/ingest/transform-enrich/ingest-pipelines) - -```ts -client.ingest.putPipeline({ id }) -``` - -### Arguments [_arguments_ingest.put_pipeline] - -#### Request (object) [_request_ingest.put_pipeline] -- **`id` (string)**: ID of the ingest pipeline to create or update. -- **`_meta` (Optional, Record)**: Optional metadata about the ingest pipeline. May have any contents. This map is not automatically generated by Elasticsearch. -- **`description` (Optional, string)**: Description of the ingest pipeline. -- **`on_failure` (Optional, { append, attachment, bytes, circle, community_id, convert, csv, date, date_index_name, dissect, dot_expander, drop, enrich, fail, fingerprint, foreach, ip_location, geo_grid, geoip, grok, gsub, html_strip, inference, join, json, kv, lowercase, network_direction, pipeline, redact, registered_domain, remove, rename, reroute, script, set, set_security_user, sort, split, terminate, trim, uppercase, urldecode, uri_parts, user_agent }[])**: Processors to run immediately after a processor failure. Each processor supports a processor-level `on_failure` value. If a processor without an `on_failure` value fails, Elasticsearch uses this pipeline-level parameter as a fallback. The processors in this parameter run sequentially in the order specified. Elasticsearch will not attempt to run the pipeline's remaining processors. -- **`processors` (Optional, { append, attachment, bytes, circle, community_id, convert, csv, date, date_index_name, dissect, dot_expander, drop, enrich, fail, fingerprint, foreach, ip_location, geo_grid, geoip, grok, gsub, html_strip, inference, join, json, kv, lowercase, network_direction, pipeline, redact, registered_domain, remove, rename, reroute, script, set, set_security_user, sort, split, terminate, trim, uppercase, urldecode, uri_parts, user_agent }[])**: Processors used to perform transformations on documents before indexing. Processors run sequentially in the order specified. -- **`version` (Optional, number)**: Version number used by external systems to track ingest pipelines. This parameter is intended for external systems only. Elasticsearch does not use or validate pipeline version numbers. -- **`deprecated` (Optional, boolean)**: Marks this ingest pipeline as deprecated. -When a deprecated ingest pipeline is referenced as the default or final pipeline when creating or updating a non-deprecated index template, Elasticsearch will emit a deprecation warning. -- **`master_timeout` (Optional, string \| -1 \| 0)**: Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. -- **`timeout` (Optional, string \| -1 \| 0)**: Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. -- **`if_version` (Optional, number)**: Required version for optimistic concurrency control for pipeline updates - -## client.ingest.simulate [_ingest.simulate] -Simulate a pipeline. - -Run an ingest pipeline against a set of provided documents. -You can either specify an existing pipeline to use with the provided documents or supply a pipeline definition in the body of the request. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ingest-simulate) - -```ts -client.ingest.simulate({ docs }) -``` - -### Arguments [_arguments_ingest.simulate] - -#### Request (object) [_request_ingest.simulate] -- **`docs` ({ _id, _index, _source }[])**: Sample documents to test in the pipeline. -- **`id` (Optional, string)**: The pipeline to test. -If you don't specify a `pipeline` in the request body, this parameter is required. -- **`pipeline` (Optional, { description, on_failure, processors, version, deprecated, _meta })**: The pipeline to test. -If you don't specify the `pipeline` request path parameter, this parameter is required. -If you specify both this and the request path parameter, the API only uses the request path parameter. -- **`verbose` (Optional, boolean)**: If `true`, the response includes output data for each processor in the executed pipeline. - -## client.license.delete [_license.delete] -Delete the license. - -When the license expires, your subscription level reverts to Basic. - -If the operator privileges feature is enabled, only operator users can use this API. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-license-delete) - -```ts -client.license.delete({ ... }) -``` - -### Arguments [_arguments_license.delete] - -#### Request (object) [_request_license.delete] -- **`master_timeout` (Optional, string \| -1 \| 0)**: The period to wait for a connection to the master node. -- **`timeout` (Optional, string \| -1 \| 0)**: The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. - -## client.license.get [_license.get] -Get license information. - -Get information about your Elastic license including its type, its status, when it was issued, and when it expires. - ->info -> If the master node is generating a new cluster state, the get license API may return a `404 Not Found` response. -> If you receive an unexpected 404 response after cluster startup, wait a short period and retry the request. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-license-get) - -```ts -client.license.get({ ... }) -``` - -### Arguments [_arguments_license.get] - -#### Request (object) [_request_license.get] -- **`accept_enterprise` (Optional, boolean)**: If `true`, this parameter returns enterprise for Enterprise license types. If `false`, this parameter returns platinum for both platinum and enterprise license types. This behavior is maintained for backwards compatibility. -This parameter is deprecated and will always be set to true in 8.x. -- **`local` (Optional, boolean)**: Specifies whether to retrieve local information. The default value is `false`, which means the information is retrieved from the master node. - -## client.license.getBasicStatus [_license.get_basic_status] -Get the basic license status. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-license-get-basic-status) - -```ts -client.license.getBasicStatus() -``` - - -## client.license.getTrialStatus [_license.get_trial_status] -Get the trial status. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-license-get-trial-status) - -```ts -client.license.getTrialStatus() -``` - - -## client.license.post [_license.post] -Update the license. - -You can update your license at runtime without shutting down your nodes. -License updates take effect immediately. -If the license you are installing does not support all of the features that were available with your previous license, however, you are notified in the response. -You must then re-submit the API request with the acknowledge parameter set to true. - -NOTE: If Elasticsearch security features are enabled and you are installing a gold or higher license, you must enable TLS on the transport networking layer before you install the license. -If the operator privileges feature is enabled, only operator users can use this API. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-license-post) - -```ts -client.license.post({ ... }) -``` - -### Arguments [_arguments_license.post] - -#### Request (object) [_request_license.post] -- **`license` (Optional, { expiry_date_in_millis, issue_date_in_millis, start_date_in_millis, issued_to, issuer, max_nodes, max_resource_units, signature, type, uid })** -- **`licenses` (Optional, { expiry_date_in_millis, issue_date_in_millis, start_date_in_millis, issued_to, issuer, max_nodes, max_resource_units, signature, type, uid }[])**: A sequence of one or more JSON documents containing the license information. -- **`acknowledge` (Optional, boolean)**: Specifies whether you acknowledge the license changes. -- **`master_timeout` (Optional, string \| -1 \| 0)**: The period to wait for a connection to the master node. -- **`timeout` (Optional, string \| -1 \| 0)**: The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. - -## client.license.postStartBasic [_license.post_start_basic] -Start a basic license. - -Start an indefinite basic license, which gives access to all the basic features. - -NOTE: In order to start a basic license, you must not currently have a basic license. - -If the basic license does not support all of the features that are available with your current license, however, you are notified in the response. -You must then re-submit the API request with the `acknowledge` parameter set to `true`. - -To check the status of your basic license, use the get basic license API. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-license-post-start-basic) - -```ts -client.license.postStartBasic({ ... }) -``` - -### Arguments [_arguments_license.post_start_basic] - -#### Request (object) [_request_license.post_start_basic] -- **`acknowledge` (Optional, boolean)**: whether the user has acknowledged acknowledge messages (default: false) -- **`master_timeout` (Optional, string \| -1 \| 0)**: Period to wait for a connection to the master node. -- **`timeout` (Optional, string \| -1 \| 0)**: Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. - -## client.license.postStartTrial [_license.post_start_trial] -Start a trial. -Start a 30-day trial, which gives access to all subscription features. - -NOTE: You are allowed to start a trial only if your cluster has not already activated a trial for the current major product version. -For example, if you have already activated a trial for v8.0, you cannot start a new trial until v9.0. You can, however, request an extended trial at https://www.elastic.co/trialextension. - -To check the status of your trial, use the get trial status API. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-license-post-start-trial) - -```ts -client.license.postStartTrial({ ... }) -``` - -### Arguments [_arguments_license.post_start_trial] - -#### Request (object) [_request_license.post_start_trial] -- **`acknowledge` (Optional, boolean)**: whether the user has acknowledged acknowledge messages (default: false) -- **`type_query_string` (Optional, string)** -- **`master_timeout` (Optional, string \| -1 \| 0)**: Period to wait for a connection to the master node. - -## client.logstash.deletePipeline [_logstash.delete_pipeline] -Delete a Logstash pipeline. -Delete a pipeline that is used for Logstash Central Management. -If the request succeeds, you receive an empty response with an appropriate status code. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-logstash-delete-pipeline) - -```ts -client.logstash.deletePipeline({ id }) -``` - -### Arguments [_arguments_logstash.delete_pipeline] - -#### Request (object) [_request_logstash.delete_pipeline] -- **`id` (string)**: An identifier for the pipeline. - -## client.logstash.getPipeline [_logstash.get_pipeline] -Get Logstash pipelines. -Get pipelines that are used for Logstash Central Management. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-logstash-get-pipeline) - -```ts -client.logstash.getPipeline({ ... }) -``` - -### Arguments [_arguments_logstash.get_pipeline] - -#### Request (object) [_request_logstash.get_pipeline] -- **`id` (Optional, string \| string[])**: A list of pipeline identifiers. - -## client.logstash.putPipeline [_logstash.put_pipeline] -Create or update a Logstash pipeline. - -Create a pipeline that is used for Logstash Central Management. -If the specified pipeline exists, it is replaced. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-logstash-put-pipeline) - -```ts -client.logstash.putPipeline({ id }) -``` - -### Arguments [_arguments_logstash.put_pipeline] - -#### Request (object) [_request_logstash.put_pipeline] -- **`id` (string)**: An identifier for the pipeline. -- **`pipeline` (Optional, { description, on_failure, processors, version, deprecated, _meta })** - -## client.migration.deprecations [_migration.deprecations] -Get deprecation information. -Get information about different cluster, node, and index level settings that use deprecated features that will be removed or changed in the next major version. - -TIP: This APIs is designed for indirect use by the Upgrade Assistant. -You are strongly recommended to use the Upgrade Assistant. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-migration-deprecations) - -```ts -client.migration.deprecations({ ... }) -``` - -### Arguments [_arguments_migration.deprecations] - -#### Request (object) [_request_migration.deprecations] -- **`index` (Optional, string)**: Comma-separate list of data streams or indices to check. Wildcard (*) expressions are supported. - -## client.migration.getFeatureUpgradeStatus [_migration.get_feature_upgrade_status] -Get feature migration information. -Version upgrades sometimes require changes to how features store configuration information and data in system indices. -Check which features need to be migrated and the status of any migrations that are in progress. - -TIP: This API is designed for indirect use by the Upgrade Assistant. -You are strongly recommended to use the Upgrade Assistant. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-migration-get-feature-upgrade-status) - -```ts -client.migration.getFeatureUpgradeStatus() -``` - - -## client.migration.postFeatureUpgrade [_migration.post_feature_upgrade] -Start the feature migration. -Version upgrades sometimes require changes to how features store configuration information and data in system indices. -This API starts the automatic migration process. - -Some functionality might be temporarily unavailable during the migration process. - -TIP: The API is designed for indirect use by the Upgrade Assistant. We strongly recommend you use the Upgrade Assistant. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-migration-get-feature-upgrade-status) - -```ts -client.migration.postFeatureUpgrade() -``` - - -## client.ml.clearTrainedModelDeploymentCache [_ml.clear_trained_model_deployment_cache] -Clear trained model deployment cache. - -Cache will be cleared on all nodes where the trained model is assigned. -A trained model deployment may have an inference cache enabled. -As requests are handled by each allocated node, their responses may be cached on that individual node. -Calling this API clears the caches without restarting the deployment. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-clear-trained-model-deployment-cache) - -```ts -client.ml.clearTrainedModelDeploymentCache({ model_id }) -``` - -### Arguments [_arguments_ml.clear_trained_model_deployment_cache] - -#### Request (object) [_request_ml.clear_trained_model_deployment_cache] -- **`model_id` (string)**: The unique identifier of the trained model. - -## client.ml.closeJob [_ml.close_job] -Close anomaly detection jobs. - -A job can be opened and closed multiple times throughout its lifecycle. A closed job cannot receive data or perform analysis operations, but you can still explore and navigate results. -When you close a job, it runs housekeeping tasks such as pruning the model history, flushing buffers, calculating final results and persisting the model snapshots. Depending upon the size of the job, it could take several minutes to close and the equivalent time to re-open. After it is closed, the job has a minimal overhead on the cluster except for maintaining its meta data. Therefore it is a best practice to close jobs that are no longer required to process data. -If you close an anomaly detection job whose datafeed is running, the request first tries to stop the datafeed. This behavior is equivalent to calling stop datafeed API with the same timeout and force parameters as the close job request. -When a datafeed that has a specified end date stops, it automatically closes its associated job. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-close-job) - -```ts -client.ml.closeJob({ job_id }) -``` - -### Arguments [_arguments_ml.close_job] - -#### Request (object) [_request_ml.close_job] -- **`job_id` (string)**: Identifier for the anomaly detection job. It can be a job identifier, a group name, or a wildcard expression. You can close multiple anomaly detection jobs in a single API request by using a group name, a list of jobs, or a wildcard expression. You can close all jobs by using `_all` or by specifying `*` as the job identifier. -- **`allow_no_match` (Optional, boolean)**: Refer to the description for the `allow_no_match` query parameter. -- **`force` (Optional, boolean)**: Refer to the descriptiion for the `force` query parameter. -- **`timeout` (Optional, string \| -1 \| 0)**: Refer to the description for the `timeout` query parameter. - -## client.ml.deleteCalendar [_ml.delete_calendar] -Delete a calendar. - -Remove all scheduled events from a calendar, then delete it. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-calendar) - -```ts -client.ml.deleteCalendar({ calendar_id }) -``` - -### Arguments [_arguments_ml.delete_calendar] - -#### Request (object) [_request_ml.delete_calendar] -- **`calendar_id` (string)**: A string that uniquely identifies a calendar. - -## client.ml.deleteCalendarEvent [_ml.delete_calendar_event] -Delete events from a calendar. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-calendar-event) - -```ts -client.ml.deleteCalendarEvent({ calendar_id, event_id }) -``` - -### Arguments [_arguments_ml.delete_calendar_event] - -#### Request (object) [_request_ml.delete_calendar_event] -- **`calendar_id` (string)**: A string that uniquely identifies a calendar. -- **`event_id` (string)**: Identifier for the scheduled event. -You can obtain this identifier by using the get calendar events API. - -## client.ml.deleteCalendarJob [_ml.delete_calendar_job] -Delete anomaly jobs from a calendar. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-calendar-job) - -```ts -client.ml.deleteCalendarJob({ calendar_id, job_id }) -``` - -### Arguments [_arguments_ml.delete_calendar_job] - -#### Request (object) [_request_ml.delete_calendar_job] -- **`calendar_id` (string)**: A string that uniquely identifies a calendar. -- **`job_id` (string \| string[])**: An identifier for the anomaly detection jobs. It can be a job identifier, a group name, or a -list of jobs or groups. - -## client.ml.deleteDataFrameAnalytics [_ml.delete_data_frame_analytics] -Delete a data frame analytics job. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-data-frame-analytics) - -```ts -client.ml.deleteDataFrameAnalytics({ id }) -``` - -### Arguments [_arguments_ml.delete_data_frame_analytics] - -#### Request (object) [_request_ml.delete_data_frame_analytics] -- **`id` (string)**: Identifier for the data frame analytics job. -- **`force` (Optional, boolean)**: If `true`, it deletes a job that is not stopped; this method is quicker than stopping and deleting the job. -- **`timeout` (Optional, string \| -1 \| 0)**: The time to wait for the job to be deleted. - -## client.ml.deleteDatafeed [_ml.delete_datafeed] -Delete a datafeed. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-datafeed) - -```ts -client.ml.deleteDatafeed({ datafeed_id }) -``` - -### Arguments [_arguments_ml.delete_datafeed] - -#### Request (object) [_request_ml.delete_datafeed] -- **`datafeed_id` (string)**: A numerical character string that uniquely identifies the datafeed. This -identifier can contain lowercase alphanumeric characters (a-z and 0-9), -hyphens, and underscores. It must start and end with alphanumeric -characters. -- **`force` (Optional, boolean)**: Use to forcefully delete a started datafeed; this method is quicker than -stopping and deleting the datafeed. - -## client.ml.deleteExpiredData [_ml.delete_expired_data] -Delete expired ML data. - -Delete all job results, model snapshots and forecast data that have exceeded -their retention days period. Machine learning state documents that are not -associated with any job are also deleted. -You can limit the request to a single or set of anomaly detection jobs by -using a job identifier, a group name, a list of jobs, or a -wildcard expression. You can delete expired data for all anomaly detection -jobs by using `_all`, by specifying `*` as the ``, or by omitting the -``. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-expired-data) - -```ts -client.ml.deleteExpiredData({ ... }) -``` - -### Arguments [_arguments_ml.delete_expired_data] - -#### Request (object) [_request_ml.delete_expired_data] -- **`job_id` (Optional, string)**: Identifier for an anomaly detection job. It can be a job identifier, a -group name, or a wildcard expression. -- **`requests_per_second` (Optional, float)**: The desired requests per second for the deletion processes. The default -behavior is no throttling. -- **`timeout` (Optional, string \| -1 \| 0)**: How long can the underlying delete processes run until they are canceled. - -## client.ml.deleteFilter [_ml.delete_filter] -Delete a filter. - -If an anomaly detection job references the filter, you cannot delete the -filter. You must update or delete the job before you can delete the filter. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-filter) - -```ts -client.ml.deleteFilter({ filter_id }) -``` - -### Arguments [_arguments_ml.delete_filter] - -#### Request (object) [_request_ml.delete_filter] -- **`filter_id` (string)**: A string that uniquely identifies a filter. - -## client.ml.deleteForecast [_ml.delete_forecast] -Delete forecasts from a job. - -By default, forecasts are retained for 14 days. You can specify a -different retention period with the `expires_in` parameter in the forecast -jobs API. The delete forecast API enables you to delete one or more -forecasts before they expire. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-forecast) - -```ts -client.ml.deleteForecast({ job_id }) -``` - -### Arguments [_arguments_ml.delete_forecast] - -#### Request (object) [_request_ml.delete_forecast] -- **`job_id` (string)**: Identifier for the anomaly detection job. -- **`forecast_id` (Optional, string)**: A list of forecast identifiers. If you do not specify -this optional parameter or if you specify `_all` or `*` the API deletes -all forecasts from the job. -- **`allow_no_forecasts` (Optional, boolean)**: Specifies whether an error occurs when there are no forecasts. In -particular, if this parameter is set to `false` and there are no -forecasts associated with the job, attempts to delete all forecasts -return an error. -- **`timeout` (Optional, string \| -1 \| 0)**: Specifies the period of time to wait for the completion of the delete -operation. When this period of time elapses, the API fails and returns an -error. - -## client.ml.deleteJob [_ml.delete_job] -Delete an anomaly detection job. - -All job configuration, model state and results are deleted. -It is not currently possible to delete multiple jobs using wildcards or a -comma separated list. If you delete a job that has a datafeed, the request -first tries to delete the datafeed. This behavior is equivalent to calling -the delete datafeed API with the same timeout and force parameters as the -delete job request. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-job) - -```ts -client.ml.deleteJob({ job_id }) -``` - -### Arguments [_arguments_ml.delete_job] - -#### Request (object) [_request_ml.delete_job] -- **`job_id` (string)**: Identifier for the anomaly detection job. -- **`force` (Optional, boolean)**: Use to forcefully delete an opened job; this method is quicker than -closing and deleting the job. -- **`delete_user_annotations` (Optional, boolean)**: Specifies whether annotations that have been added by the -user should be deleted along with any auto-generated annotations when the job is -reset. -- **`wait_for_completion` (Optional, boolean)**: Specifies whether the request should return immediately or wait until the -job deletion completes. - -## client.ml.deleteModelSnapshot [_ml.delete_model_snapshot] -Delete a model snapshot. - -You cannot delete the active model snapshot. To delete that snapshot, first -revert to a different one. To identify the active model snapshot, refer to -the `model_snapshot_id` in the results from the get jobs API. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-model-snapshot) - -```ts -client.ml.deleteModelSnapshot({ job_id, snapshot_id }) -``` - -### Arguments [_arguments_ml.delete_model_snapshot] - -#### Request (object) [_request_ml.delete_model_snapshot] -- **`job_id` (string)**: Identifier for the anomaly detection job. -- **`snapshot_id` (string)**: Identifier for the model snapshot. - -## client.ml.deleteTrainedModel [_ml.delete_trained_model] -Delete an unreferenced trained model. - -The request deletes a trained inference model that is not referenced by an ingest pipeline. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-trained-model) - -```ts -client.ml.deleteTrainedModel({ model_id }) -``` - -### Arguments [_arguments_ml.delete_trained_model] - -#### Request (object) [_request_ml.delete_trained_model] -- **`model_id` (string)**: The unique identifier of the trained model. -- **`force` (Optional, boolean)**: Forcefully deletes a trained model that is referenced by ingest pipelines or has a started deployment. -- **`timeout` (Optional, string \| -1 \| 0)**: Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. - -## client.ml.deleteTrainedModelAlias [_ml.delete_trained_model_alias] -Delete a trained model alias. - -This API deletes an existing model alias that refers to a trained model. If -the model alias is missing or refers to a model other than the one identified -by the `model_id`, this API returns an error. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-trained-model-alias) - -```ts -client.ml.deleteTrainedModelAlias({ model_alias, model_id }) -``` - -### Arguments [_arguments_ml.delete_trained_model_alias] - -#### Request (object) [_request_ml.delete_trained_model_alias] -- **`model_alias` (string)**: The model alias to delete. -- **`model_id` (string)**: The trained model ID to which the model alias refers. - -## client.ml.estimateModelMemory [_ml.estimate_model_memory] -Estimate job model memory usage. - -Make an estimation of the memory usage for an anomaly detection job model. -The estimate is based on analysis configuration details for the job and cardinality -estimates for the fields it references. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-estimate-model-memory) - -```ts -client.ml.estimateModelMemory({ ... }) -``` - -### Arguments [_arguments_ml.estimate_model_memory] - -#### Request (object) [_request_ml.estimate_model_memory] -- **`analysis_config` (Optional, { bucket_span, categorization_analyzer, categorization_field_name, categorization_filters, detectors, influencers, latency, model_prune_window, multivariate_by_fields, per_partition_categorization, summary_count_field_name })**: For a list of the properties that you can specify in the -`analysis_config` component of the body of this API. -- **`max_bucket_cardinality` (Optional, Record)**: Estimates of the highest cardinality in a single bucket that is observed -for influencer fields over the time period that the job analyzes data. -To produce a good answer, values must be provided for all influencer -fields. Providing values for fields that are not listed as `influencers` -has no effect on the estimation. -- **`overall_cardinality` (Optional, Record)**: Estimates of the cardinality that is observed for fields over the whole -time period that the job analyzes data. To produce a good answer, values -must be provided for fields referenced in the `by_field_name`, -`over_field_name` and `partition_field_name` of any detectors. Providing -values for other fields has no effect on the estimation. It can be -omitted from the request if no detectors have a `by_field_name`, -`over_field_name` or `partition_field_name`. - -## client.ml.evaluateDataFrame [_ml.evaluate_data_frame] -Evaluate data frame analytics. - -The API packages together commonly used evaluation metrics for various types -of machine learning features. This has been designed for use on indexes -created by data frame analytics. Evaluation requires both a ground truth -field and an analytics result field to be present. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-evaluate-data-frame) - -```ts -client.ml.evaluateDataFrame({ evaluation, index }) -``` - -### Arguments [_arguments_ml.evaluate_data_frame] - -#### Request (object) [_request_ml.evaluate_data_frame] -- **`evaluation` ({ classification, outlier_detection, regression })**: Defines the type of evaluation you want to perform. -- **`index` (string)**: Defines the `index` in which the evaluation will be performed. -- **`query` (Optional, { bool, boosting, common, combined_fields, constant_score, dis_max, distance_feature, exists, function_score, fuzzy, geo_bounding_box, geo_distance, geo_grid, geo_polygon, geo_shape, has_child, has_parent, ids, intervals, knn, match, match_all, match_bool_prefix, match_none, match_phrase, match_phrase_prefix, more_like_this, multi_match, nested, parent_id, percolate, pinned, prefix, query_string, range, rank_feature, regexp, rule, script, script_score, semantic, shape, simple_query_string, span_containing, span_field_masking, span_first, span_multi, span_near, span_not, span_or, span_term, span_within, sparse_vector, term, terms, terms_set, text_expansion, weighted_tokens, wildcard, wrapper, type })**: A query clause that retrieves a subset of data from the source index. - -## client.ml.explainDataFrameAnalytics [_ml.explain_data_frame_analytics] -Explain data frame analytics config. - -This API provides explanations for a data frame analytics config that either -exists already or one that has not been created yet. The following -explanations are provided: -* which fields are included or not in the analysis and why, -* how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on. -If you have object fields or fields that are excluded via source filtering, they are not included in the explanation. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-explain-data-frame-analytics) - -```ts -client.ml.explainDataFrameAnalytics({ ... }) -``` - -### Arguments [_arguments_ml.explain_data_frame_analytics] - -#### Request (object) [_request_ml.explain_data_frame_analytics] -- **`id` (Optional, string)**: Identifier for the data frame analytics job. This identifier can contain -lowercase alphanumeric characters (a-z and 0-9), hyphens, and -underscores. It must start and end with alphanumeric characters. -- **`source` (Optional, { index, query, runtime_mappings, _source })**: The configuration of how to source the analysis data. It requires an -index. Optionally, query and _source may be specified. -- **`dest` (Optional, { index, results_field })**: The destination configuration, consisting of index and optionally -results_field (ml by default). -- **`analysis` (Optional, { classification, outlier_detection, regression })**: The analysis configuration, which contains the information necessary to -perform one of the following types of analysis: classification, outlier -detection, or regression. -- **`description` (Optional, string)**: A description of the job. -- **`model_memory_limit` (Optional, string)**: The approximate maximum amount of memory resources that are permitted for -analytical processing. If your `elasticsearch.yml` file contains an -`xpack.ml.max_model_memory_limit` setting, an error occurs when you try to -create data frame analytics jobs that have `model_memory_limit` values -greater than that setting. -- **`max_num_threads` (Optional, number)**: The maximum number of threads to be used by the analysis. Using more -threads may decrease the time necessary to complete the analysis at the -cost of using more CPU. Note that the process may use additional threads -for operational functionality other than the analysis itself. -- **`analyzed_fields` (Optional, { includes, excludes })**: Specify includes and/or excludes patterns to select which fields will be -included in the analysis. The patterns specified in excludes are applied -last, therefore excludes takes precedence. In other words, if the same -field is specified in both includes and excludes, then the field will not -be included in the analysis. -- **`allow_lazy_start` (Optional, boolean)**: Specifies whether this job can start when there is insufficient machine -learning node capacity for it to be immediately assigned to a node. - -## client.ml.flushJob [_ml.flush_job] -Force buffered data to be processed. -The flush jobs API is only applicable when sending data for analysis using -the post data API. Depending on the content of the buffer, then it might -additionally calculate new results. Both flush and close operations are -similar, however the flush is more efficient if you are expecting to send -more data for analysis. When flushing, the job remains open and is available -to continue analyzing data. A close operation additionally prunes and -persists the model state to disk and the job must be opened again before -analyzing further data. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-flush-job) - -```ts -client.ml.flushJob({ job_id }) -``` - -### Arguments [_arguments_ml.flush_job] - -#### Request (object) [_request_ml.flush_job] -- **`job_id` (string)**: Identifier for the anomaly detection job. -- **`advance_time` (Optional, string \| Unit)**: Refer to the description for the `advance_time` query parameter. -- **`calc_interim` (Optional, boolean)**: Refer to the description for the `calc_interim` query parameter. -- **`end` (Optional, string \| Unit)**: Refer to the description for the `end` query parameter. -- **`skip_time` (Optional, string \| Unit)**: Refer to the description for the `skip_time` query parameter. -- **`start` (Optional, string \| Unit)**: Refer to the description for the `start` query parameter. - -## client.ml.forecast [_ml.forecast] -Predict future behavior of a time series. - -Forecasts are not supported for jobs that perform population analysis; an -error occurs if you try to create a forecast for a job that has an -`over_field_name` in its configuration. Forcasts predict future behavior -based on historical data. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-forecast) - -```ts -client.ml.forecast({ job_id }) -``` - -### Arguments [_arguments_ml.forecast] - -#### Request (object) [_request_ml.forecast] -- **`job_id` (string)**: Identifier for the anomaly detection job. The job must be open when you -create a forecast; otherwise, an error occurs. -- **`duration` (Optional, string \| -1 \| 0)**: Refer to the description for the `duration` query parameter. -- **`expires_in` (Optional, string \| -1 \| 0)**: Refer to the description for the `expires_in` query parameter. -- **`max_model_memory` (Optional, string)**: Refer to the description for the `max_model_memory` query parameter. - -## client.ml.getBuckets [_ml.get_buckets] -Get anomaly detection job results for buckets. -The API presents a chronological view of the records, grouped by bucket. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-buckets) - -```ts -client.ml.getBuckets({ job_id }) -``` - -### Arguments [_arguments_ml.get_buckets] - -#### Request (object) [_request_ml.get_buckets] -- **`job_id` (string)**: Identifier for the anomaly detection job. -- **`timestamp` (Optional, string \| Unit)**: The timestamp of a single bucket result. If you do not specify this -parameter, the API returns information about all buckets. -- **`anomaly_score` (Optional, number)**: Refer to the description for the `anomaly_score` query parameter. -- **`desc` (Optional, boolean)**: Refer to the description for the `desc` query parameter. -- **`end` (Optional, string \| Unit)**: Refer to the description for the `end` query parameter. -- **`exclude_interim` (Optional, boolean)**: Refer to the description for the `exclude_interim` query parameter. -- **`expand` (Optional, boolean)**: Refer to the description for the `expand` query parameter. -- **`page` (Optional, { from, size })** -- **`sort` (Optional, string)**: Refer to the desription for the `sort` query parameter. -- **`start` (Optional, string \| Unit)**: Refer to the description for the `start` query parameter. -- **`from` (Optional, number)**: Skips the specified number of buckets. -- **`size` (Optional, number)**: Specifies the maximum number of buckets to obtain. - -## client.ml.getCalendarEvents [_ml.get_calendar_events] -Get info about events in calendars. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-calendar-events) - -```ts -client.ml.getCalendarEvents({ calendar_id }) -``` - -### Arguments [_arguments_ml.get_calendar_events] - -#### Request (object) [_request_ml.get_calendar_events] -- **`calendar_id` (string)**: A string that uniquely identifies a calendar. You can get information for multiple calendars by using a list of ids or a wildcard expression. You can get information for all calendars by using `_all` or `*` or by omitting the calendar identifier. -- **`end` (Optional, string \| Unit)**: Specifies to get events with timestamps earlier than this time. -- **`from` (Optional, number)**: Skips the specified number of events. -- **`job_id` (Optional, string)**: Specifies to get events for a specific anomaly detection job identifier or job group. It must be used with a calendar identifier of `_all` or `*`. -- **`size` (Optional, number)**: Specifies the maximum number of events to obtain. -- **`start` (Optional, string \| Unit)**: Specifies to get events with timestamps after this time. - -## client.ml.getCalendars [_ml.get_calendars] -Get calendar configuration info. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-calendars) - -```ts -client.ml.getCalendars({ ... }) -``` - -### Arguments [_arguments_ml.get_calendars] - -#### Request (object) [_request_ml.get_calendars] -- **`calendar_id` (Optional, string)**: A string that uniquely identifies a calendar. You can get information for multiple calendars by using a list of ids or a wildcard expression. You can get information for all calendars by using `_all` or `*` or by omitting the calendar identifier. -- **`page` (Optional, { from, size })**: This object is supported only when you omit the calendar identifier. -- **`from` (Optional, number)**: Skips the specified number of calendars. This parameter is supported only when you omit the calendar identifier. -- **`size` (Optional, number)**: Specifies the maximum number of calendars to obtain. This parameter is supported only when you omit the calendar identifier. - -## client.ml.getCategories [_ml.get_categories] -Get anomaly detection job results for categories. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-categories) - -```ts -client.ml.getCategories({ job_id }) -``` - -### Arguments [_arguments_ml.get_categories] - -#### Request (object) [_request_ml.get_categories] -- **`job_id` (string)**: Identifier for the anomaly detection job. -- **`category_id` (Optional, string)**: Identifier for the category, which is unique in the job. If you specify -neither the category ID nor the partition_field_value, the API returns -information about all categories. If you specify only the -partition_field_value, it returns information about all categories for -the specified partition. -- **`page` (Optional, { from, size })**: Configures pagination. -This parameter has the `from` and `size` properties. -- **`from` (Optional, number)**: Skips the specified number of categories. -- **`partition_field_value` (Optional, string)**: Only return categories for the specified partition. -- **`size` (Optional, number)**: Specifies the maximum number of categories to obtain. - -## client.ml.getDataFrameAnalytics [_ml.get_data_frame_analytics] -Get data frame analytics job configuration info. -You can get information for multiple data frame analytics jobs in a single -API request by using a list of data frame analytics jobs or a -wildcard expression. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-data-frame-analytics) - -```ts -client.ml.getDataFrameAnalytics({ ... }) -``` - -### Arguments [_arguments_ml.get_data_frame_analytics] - -#### Request (object) [_request_ml.get_data_frame_analytics] -- **`id` (Optional, string)**: Identifier for the data frame analytics job. If you do not specify this -option, the API returns information for the first hundred data frame -analytics jobs. -- **`allow_no_match` (Optional, boolean)**: Specifies what to do when the request: - -1. Contains wildcard expressions and there are no data frame analytics -jobs that match. -2. Contains the `_all` string or no identifiers and there are no matches. -3. Contains wildcard expressions and there are only partial matches. - -The default value returns an empty data_frame_analytics array when there -are no matches and the subset of results when there are partial matches. -If this parameter is `false`, the request returns a 404 status code when -there are no matches or only partial matches. -- **`from` (Optional, number)**: Skips the specified number of data frame analytics jobs. -- **`size` (Optional, number)**: Specifies the maximum number of data frame analytics jobs to obtain. -- **`exclude_generated` (Optional, boolean)**: Indicates if certain fields should be removed from the configuration on -retrieval. This allows the configuration to be in an acceptable format to -be retrieved and then added to another cluster. - -## client.ml.getDataFrameAnalyticsStats [_ml.get_data_frame_analytics_stats] -Get data frame analytics job stats. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-data-frame-analytics-stats) - -```ts -client.ml.getDataFrameAnalyticsStats({ ... }) -``` - -### Arguments [_arguments_ml.get_data_frame_analytics_stats] - -#### Request (object) [_request_ml.get_data_frame_analytics_stats] -- **`id` (Optional, string)**: Identifier for the data frame analytics job. If you do not specify this -option, the API returns information for the first hundred data frame -analytics jobs. -- **`allow_no_match` (Optional, boolean)**: Specifies what to do when the request: - -1. Contains wildcard expressions and there are no data frame analytics -jobs that match. -2. Contains the `_all` string or no identifiers and there are no matches. -3. Contains wildcard expressions and there are only partial matches. - -The default value returns an empty data_frame_analytics array when there -are no matches and the subset of results when there are partial matches. -If this parameter is `false`, the request returns a 404 status code when -there are no matches or only partial matches. -- **`from` (Optional, number)**: Skips the specified number of data frame analytics jobs. -- **`size` (Optional, number)**: Specifies the maximum number of data frame analytics jobs to obtain. -- **`verbose` (Optional, boolean)**: Defines whether the stats response should be verbose. - -## client.ml.getDatafeedStats [_ml.get_datafeed_stats] -Get datafeed stats. -You can get statistics for multiple datafeeds in a single API request by -using a list of datafeeds or a wildcard expression. You can -get statistics for all datafeeds by using `_all`, by specifying `*` as the -``, or by omitting the ``. If the datafeed is stopped, the -only information you receive is the `datafeed_id` and the `state`. -This API returns a maximum of 10,000 datafeeds. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-datafeed-stats) - -```ts -client.ml.getDatafeedStats({ ... }) -``` - -### Arguments [_arguments_ml.get_datafeed_stats] - -#### Request (object) [_request_ml.get_datafeed_stats] -- **`datafeed_id` (Optional, string \| string[])**: Identifier for the datafeed. It can be a datafeed identifier or a -wildcard expression. If you do not specify one of these options, the API -returns information about all datafeeds. -- **`allow_no_match` (Optional, boolean)**: Specifies what to do when the request: - -1. Contains wildcard expressions and there are no datafeeds that match. -2. Contains the `_all` string or no identifiers and there are no matches. -3. Contains wildcard expressions and there are only partial matches. - -The default value is `true`, which returns an empty `datafeeds` array -when there are no matches and the subset of results when there are -partial matches. If this parameter is `false`, the request returns a -`404` status code when there are no matches or only partial matches. - -## client.ml.getDatafeeds [_ml.get_datafeeds] -Get datafeeds configuration info. -You can get information for multiple datafeeds in a single API request by -using a list of datafeeds or a wildcard expression. You can -get information for all datafeeds by using `_all`, by specifying `*` as the -``, or by omitting the ``. -This API returns a maximum of 10,000 datafeeds. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-datafeeds) - -```ts -client.ml.getDatafeeds({ ... }) -``` - -### Arguments [_arguments_ml.get_datafeeds] - -#### Request (object) [_request_ml.get_datafeeds] -- **`datafeed_id` (Optional, string \| string[])**: Identifier for the datafeed. It can be a datafeed identifier or a -wildcard expression. If you do not specify one of these options, the API -returns information about all datafeeds. -- **`allow_no_match` (Optional, boolean)**: Specifies what to do when the request: - -1. Contains wildcard expressions and there are no datafeeds that match. -2. Contains the `_all` string or no identifiers and there are no matches. -3. Contains wildcard expressions and there are only partial matches. - -The default value is `true`, which returns an empty `datafeeds` array -when there are no matches and the subset of results when there are -partial matches. If this parameter is `false`, the request returns a -`404` status code when there are no matches or only partial matches. -- **`exclude_generated` (Optional, boolean)**: Indicates if certain fields should be removed from the configuration on -retrieval. This allows the configuration to be in an acceptable format to -be retrieved and then added to another cluster. - -## client.ml.getFilters [_ml.get_filters] -Get filters. -You can get a single filter or all filters. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-filters) - -```ts -client.ml.getFilters({ ... }) -``` - -### Arguments [_arguments_ml.get_filters] - -#### Request (object) [_request_ml.get_filters] -- **`filter_id` (Optional, string \| string[])**: A string that uniquely identifies a filter. -- **`from` (Optional, number)**: Skips the specified number of filters. -- **`size` (Optional, number)**: Specifies the maximum number of filters to obtain. - -## client.ml.getInfluencers [_ml.get_influencers] -Get anomaly detection job results for influencers. -Influencers are the entities that have contributed to, or are to blame for, -the anomalies. Influencer results are available only if an -`influencer_field_name` is specified in the job configuration. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-influencers) - -```ts -client.ml.getInfluencers({ job_id }) -``` - -### Arguments [_arguments_ml.get_influencers] - -#### Request (object) [_request_ml.get_influencers] -- **`job_id` (string)**: Identifier for the anomaly detection job. -- **`page` (Optional, { from, size })**: Configures pagination. -This parameter has the `from` and `size` properties. -- **`desc` (Optional, boolean)**: If true, the results are sorted in descending order. -- **`end` (Optional, string \| Unit)**: Returns influencers with timestamps earlier than this time. -The default value means it is unset and results are not limited to -specific timestamps. -- **`exclude_interim` (Optional, boolean)**: If true, the output excludes interim results. By default, interim results -are included. -- **`influencer_score` (Optional, number)**: Returns influencers with anomaly scores greater than or equal to this -value. -- **`from` (Optional, number)**: Skips the specified number of influencers. -- **`size` (Optional, number)**: Specifies the maximum number of influencers to obtain. -- **`sort` (Optional, string)**: Specifies the sort field for the requested influencers. By default, the -influencers are sorted by the `influencer_score` value. -- **`start` (Optional, string \| Unit)**: Returns influencers with timestamps after this time. The default value -means it is unset and results are not limited to specific timestamps. - -## client.ml.getJobStats [_ml.get_job_stats] -Get anomaly detection job stats. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-job-stats) - -```ts -client.ml.getJobStats({ ... }) -``` - -### Arguments [_arguments_ml.get_job_stats] - -#### Request (object) [_request_ml.get_job_stats] -- **`job_id` (Optional, string)**: Identifier for the anomaly detection job. It can be a job identifier, a -group name, a list of jobs, or a wildcard expression. If -you do not specify one of these options, the API returns information for -all anomaly detection jobs. -- **`allow_no_match` (Optional, boolean)**: Specifies what to do when the request: - -1. Contains wildcard expressions and there are no jobs that match. -2. Contains the _all string or no identifiers and there are no matches. -3. Contains wildcard expressions and there are only partial matches. - -If `true`, the API returns an empty `jobs` array when -there are no matches and the subset of results when there are partial -matches. If `false`, the API returns a `404` status -code when there are no matches or only partial matches. - -## client.ml.getJobs [_ml.get_jobs] -Get anomaly detection jobs configuration info. -You can get information for multiple anomaly detection jobs in a single API -request by using a group name, a list of jobs, or a wildcard -expression. You can get information for all anomaly detection jobs by using -`_all`, by specifying `*` as the ``, or by omitting the ``. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-jobs) - -```ts -client.ml.getJobs({ ... }) -``` - -### Arguments [_arguments_ml.get_jobs] - -#### Request (object) [_request_ml.get_jobs] -- **`job_id` (Optional, string \| string[])**: Identifier for the anomaly detection job. It can be a job identifier, a -group name, or a wildcard expression. If you do not specify one of these -options, the API returns information for all anomaly detection jobs. -- **`allow_no_match` (Optional, boolean)**: Specifies what to do when the request: - -1. Contains wildcard expressions and there are no jobs that match. -2. Contains the _all string or no identifiers and there are no matches. -3. Contains wildcard expressions and there are only partial matches. - -The default value is `true`, which returns an empty `jobs` array when -there are no matches and the subset of results when there are partial -matches. If this parameter is `false`, the request returns a `404` status -code when there are no matches or only partial matches. -- **`exclude_generated` (Optional, boolean)**: Indicates if certain fields should be removed from the configuration on -retrieval. This allows the configuration to be in an acceptable format to -be retrieved and then added to another cluster. - -## client.ml.getMemoryStats [_ml.get_memory_stats] -Get machine learning memory usage info. -Get information about how machine learning jobs and trained models are using memory, -on each node, both within the JVM heap, and natively, outside of the JVM. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-memory-stats) - -```ts -client.ml.getMemoryStats({ ... }) -``` - -### Arguments [_arguments_ml.get_memory_stats] - -#### Request (object) [_request_ml.get_memory_stats] -- **`node_id` (Optional, string)**: The names of particular nodes in the cluster to target. For example, `nodeId1,nodeId2` or -`ml:true` -- **`master_timeout` (Optional, string \| -1 \| 0)**: Period to wait for a connection to the master node. If no response is received before the timeout -expires, the request fails and returns an error. -- **`timeout` (Optional, string \| -1 \| 0)**: Period to wait for a response. If no response is received before the timeout expires, the request -fails and returns an error. - -## client.ml.getModelSnapshotUpgradeStats [_ml.get_model_snapshot_upgrade_stats] -Get anomaly detection job model snapshot upgrade usage info. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-model-snapshot-upgrade-stats) - -```ts -client.ml.getModelSnapshotUpgradeStats({ job_id, snapshot_id }) -``` - -### Arguments [_arguments_ml.get_model_snapshot_upgrade_stats] - -#### Request (object) [_request_ml.get_model_snapshot_upgrade_stats] -- **`job_id` (string)**: Identifier for the anomaly detection job. -- **`snapshot_id` (string)**: A numerical character string that uniquely identifies the model snapshot. You can get information for multiple -snapshots by using a list or a wildcard expression. You can get all snapshots by using `_all`, -by specifying `*` as the snapshot ID, or by omitting the snapshot ID. -- **`allow_no_match` (Optional, boolean)**: Specifies what to do when the request: - - - Contains wildcard expressions and there are no jobs that match. - - Contains the _all string or no identifiers and there are no matches. - - Contains wildcard expressions and there are only partial matches. - -The default value is true, which returns an empty jobs array when there are no matches and the subset of results -when there are partial matches. If this parameter is false, the request returns a 404 status code when there are -no matches or only partial matches. - -## client.ml.getModelSnapshots [_ml.get_model_snapshots] -Get model snapshots info. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-model-snapshots) - -```ts -client.ml.getModelSnapshots({ job_id }) -``` - -### Arguments [_arguments_ml.get_model_snapshots] - -#### Request (object) [_request_ml.get_model_snapshots] -- **`job_id` (string)**: Identifier for the anomaly detection job. -- **`snapshot_id` (Optional, string)**: A numerical character string that uniquely identifies the model snapshot. You can get information for multiple -snapshots by using a list or a wildcard expression. You can get all snapshots by using `_all`, -by specifying `*` as the snapshot ID, or by omitting the snapshot ID. -- **`desc` (Optional, boolean)**: Refer to the description for the `desc` query parameter. -- **`end` (Optional, string \| Unit)**: Refer to the description for the `end` query parameter. -- **`page` (Optional, { from, size })** -- **`sort` (Optional, string)**: Refer to the description for the `sort` query parameter. -- **`start` (Optional, string \| Unit)**: Refer to the description for the `start` query parameter. -- **`from` (Optional, number)**: Skips the specified number of snapshots. -- **`size` (Optional, number)**: Specifies the maximum number of snapshots to obtain. - -## client.ml.getOverallBuckets [_ml.get_overall_buckets] -Get overall bucket results. - -Retrievs overall bucket results that summarize the bucket results of -multiple anomaly detection jobs. - -The `overall_score` is calculated by combining the scores of all the -buckets within the overall bucket span. First, the maximum -`anomaly_score` per anomaly detection job in the overall bucket is -calculated. Then the `top_n` of those scores are averaged to result in -the `overall_score`. This means that you can fine-tune the -`overall_score` so that it is more or less sensitive to the number of -jobs that detect an anomaly at the same time. For example, if you set -`top_n` to `1`, the `overall_score` is the maximum bucket score in the -overall bucket. Alternatively, if you set `top_n` to the number of jobs, -the `overall_score` is high only when all jobs detect anomalies in that -overall bucket. If you set the `bucket_span` parameter (to a value -greater than its default), the `overall_score` is the maximum -`overall_score` of the overall buckets that have a span equal to the -jobs' largest bucket span. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-overall-buckets) - -```ts -client.ml.getOverallBuckets({ job_id }) -``` - -### Arguments [_arguments_ml.get_overall_buckets] - -#### Request (object) [_request_ml.get_overall_buckets] -- **`job_id` (string)**: Identifier for the anomaly detection job. It can be a job identifier, a -group name, a list of jobs or groups, or a wildcard -expression. - -You can summarize the bucket results for all anomaly detection jobs by -using `_all` or by specifying `*` as the ``. -- **`allow_no_match` (Optional, boolean)**: Refer to the description for the `allow_no_match` query parameter. -- **`bucket_span` (Optional, string \| -1 \| 0)**: Refer to the description for the `bucket_span` query parameter. -- **`end` (Optional, string \| Unit)**: Refer to the description for the `end` query parameter. -- **`exclude_interim` (Optional, boolean)**: Refer to the description for the `exclude_interim` query parameter. -- **`overall_score` (Optional, number \| string)**: Refer to the description for the `overall_score` query parameter. -- **`start` (Optional, string \| Unit)**: Refer to the description for the `start` query parameter. -- **`top_n` (Optional, number)**: Refer to the description for the `top_n` query parameter. - -## client.ml.getRecords [_ml.get_records] -Get anomaly records for an anomaly detection job. -Records contain the detailed analytical results. They describe the anomalous -activity that has been identified in the input data based on the detector -configuration. -There can be many anomaly records depending on the characteristics and size -of the input data. In practice, there are often too many to be able to -manually process them. The machine learning features therefore perform a -sophisticated aggregation of the anomaly records into buckets. -The number of record results depends on the number of anomalies found in each -bucket, which relates to the number of time series being modeled and the -number of detectors. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-records) - -```ts -client.ml.getRecords({ job_id }) -``` - -### Arguments [_arguments_ml.get_records] - -#### Request (object) [_request_ml.get_records] -- **`job_id` (string)**: Identifier for the anomaly detection job. -- **`desc` (Optional, boolean)**: Refer to the description for the `desc` query parameter. -- **`end` (Optional, string \| Unit)**: Refer to the description for the `end` query parameter. -- **`exclude_interim` (Optional, boolean)**: Refer to the description for the `exclude_interim` query parameter. -- **`page` (Optional, { from, size })** -- **`record_score` (Optional, number)**: Refer to the description for the `record_score` query parameter. -- **`sort` (Optional, string)**: Refer to the description for the `sort` query parameter. -- **`start` (Optional, string \| Unit)**: Refer to the description for the `start` query parameter. -- **`from` (Optional, number)**: Skips the specified number of records. -- **`size` (Optional, number)**: Specifies the maximum number of records to obtain. - -## client.ml.getTrainedModels [_ml.get_trained_models] -Get trained model configuration info. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-trained-models) - -```ts -client.ml.getTrainedModels({ ... }) -``` - -### Arguments [_arguments_ml.get_trained_models] - -#### Request (object) [_request_ml.get_trained_models] -- **`model_id` (Optional, string \| string[])**: The unique identifier of the trained model or a model alias. - -You can get information for multiple trained models in a single API -request by using a list of model IDs or a wildcard -expression. -- **`allow_no_match` (Optional, boolean)**: Specifies what to do when the request: - -- Contains wildcard expressions and there are no models that match. -- Contains the _all string or no identifiers and there are no matches. -- Contains wildcard expressions and there are only partial matches. - -If true, it returns an empty array when there are no matches and the -subset of results when there are partial matches. -- **`decompress_definition` (Optional, boolean)**: Specifies whether the included model definition should be returned as a -JSON map (true) or in a custom compressed format (false). -- **`exclude_generated` (Optional, boolean)**: Indicates if certain fields should be removed from the configuration on -retrieval. This allows the configuration to be in an acceptable format to -be retrieved and then added to another cluster. -- **`from` (Optional, number)**: Skips the specified number of models. -- **`include` (Optional, Enum("definition" \| "feature_importance_baseline" \| "hyperparameters" \| "total_feature_importance" \| "definition_status"))**: A comma delimited string of optional fields to include in the response -body. -- **`size` (Optional, number)**: Specifies the maximum number of models to obtain. -- **`tags` (Optional, string \| string[])**: A comma delimited string of tags. A trained model can have many tags, or -none. When supplied, only trained models that contain all the supplied -tags are returned. - -## client.ml.getTrainedModelsStats [_ml.get_trained_models_stats] -Get trained models usage info. -You can get usage information for multiple trained -models in a single API request by using a list of model IDs or a wildcard expression. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-trained-models-stats) - -```ts -client.ml.getTrainedModelsStats({ ... }) -``` - -### Arguments [_arguments_ml.get_trained_models_stats] - -#### Request (object) [_request_ml.get_trained_models_stats] -- **`model_id` (Optional, string \| string[])**: The unique identifier of the trained model or a model alias. It can be a -list or a wildcard expression. -- **`allow_no_match` (Optional, boolean)**: Specifies what to do when the request: - -- Contains wildcard expressions and there are no models that match. -- Contains the _all string or no identifiers and there are no matches. -- Contains wildcard expressions and there are only partial matches. - -If true, it returns an empty array when there are no matches and the -subset of results when there are partial matches. -- **`from` (Optional, number)**: Skips the specified number of models. -- **`size` (Optional, number)**: Specifies the maximum number of models to obtain. - -## client.ml.inferTrainedModel [_ml.infer_trained_model] -Evaluate a trained model. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-infer-trained-model) - -```ts -client.ml.inferTrainedModel({ model_id, docs }) -``` - -### Arguments [_arguments_ml.infer_trained_model] - -#### Request (object) [_request_ml.infer_trained_model] -- **`model_id` (string)**: The unique identifier of the trained model. -- **`docs` (Record[])**: An array of objects to pass to the model for inference. The objects should contain a fields matching your -configured trained model input. Typically, for NLP models, the field name is `text_field`. -Currently, for NLP models, only a single value is allowed. -- **`inference_config` (Optional, { regression, classification, text_classification, zero_shot_classification, fill_mask, ner, pass_through, text_embedding, text_expansion, question_answering })**: The inference configuration updates to apply on the API call -- **`timeout` (Optional, string \| -1 \| 0)**: Controls the amount of time to wait for inference results. - -## client.ml.info [_ml.info] -Get machine learning information. -Get defaults and limits used by machine learning. -This endpoint is designed to be used by a user interface that needs to fully -understand machine learning configurations where some options are not -specified, meaning that the defaults should be used. This endpoint may be -used to find out what those defaults are. It also provides information about -the maximum size of machine learning jobs that could run in the current -cluster configuration. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-info) - -```ts -client.ml.info() -``` - - -## client.ml.openJob [_ml.open_job] -Open anomaly detection jobs. - -An anomaly detection job must be opened to be ready to receive and analyze -data. It can be opened and closed multiple times throughout its lifecycle. -When you open a new job, it starts with an empty model. -When you open an existing job, the most recent model state is automatically -loaded. The job is ready to resume its analysis from where it left off, once -new data is received. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-open-job) - -```ts -client.ml.openJob({ job_id }) -``` - -### Arguments [_arguments_ml.open_job] - -#### Request (object) [_request_ml.open_job] -- **`job_id` (string)**: Identifier for the anomaly detection job. -- **`timeout` (Optional, string \| -1 \| 0)**: Refer to the description for the `timeout` query parameter. - -## client.ml.postCalendarEvents [_ml.post_calendar_events] -Add scheduled events to the calendar. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-post-calendar-events) - -```ts -client.ml.postCalendarEvents({ calendar_id, events }) -``` - -### Arguments [_arguments_ml.post_calendar_events] - -#### Request (object) [_request_ml.post_calendar_events] -- **`calendar_id` (string)**: A string that uniquely identifies a calendar. -- **`events` ({ calendar_id, event_id, description, end_time, start_time, skip_result, skip_model_update, force_time_shift }[])**: A list of one of more scheduled events. The event’s start and end times can be specified as integer milliseconds since the epoch or as a string in ISO 8601 format. - -## client.ml.postData [_ml.post_data] -Send data to an anomaly detection job for analysis. - -IMPORTANT: For each job, data can be accepted from only a single connection at a time. -It is not currently possible to post data to multiple jobs using wildcards or a list. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-post-data) - -```ts -client.ml.postData({ job_id }) -``` - -### Arguments [_arguments_ml.post_data] - -#### Request (object) [_request_ml.post_data] -- **`job_id` (string)**: Identifier for the anomaly detection job. The job must have a state of open to receive and process the data. -- **`data` (Optional, TData[])** -- **`reset_end` (Optional, string \| Unit)**: Specifies the end of the bucket resetting range. -- **`reset_start` (Optional, string \| Unit)**: Specifies the start of the bucket resetting range. - -## client.ml.previewDataFrameAnalytics [_ml.preview_data_frame_analytics] -Preview features used by data frame analytics. -Preview the extracted features used by a data frame analytics config. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-preview-data-frame-analytics) - -```ts -client.ml.previewDataFrameAnalytics({ ... }) -``` - -### Arguments [_arguments_ml.preview_data_frame_analytics] - -#### Request (object) [_request_ml.preview_data_frame_analytics] -- **`id` (Optional, string)**: Identifier for the data frame analytics job. -- **`config` (Optional, { source, analysis, model_memory_limit, max_num_threads, analyzed_fields })**: A data frame analytics config as described in create data frame analytics -jobs. Note that `id` and `dest` don’t need to be provided in the context of -this API. - -## client.ml.previewDatafeed [_ml.preview_datafeed] -Preview a datafeed. -This API returns the first "page" of search results from a datafeed. -You can preview an existing datafeed or provide configuration details for a datafeed -and anomaly detection job in the API. The preview shows the structure of the data -that will be passed to the anomaly detection engine. -IMPORTANT: When Elasticsearch security features are enabled, the preview uses the credentials of the user that -called the API. However, when the datafeed starts it uses the roles of the last user that created or updated the -datafeed. To get a preview that accurately reflects the behavior of the datafeed, use the appropriate credentials. -You can also use secondary authorization headers to supply the credentials. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-preview-datafeed) - -```ts -client.ml.previewDatafeed({ ... }) -``` - -### Arguments [_arguments_ml.preview_datafeed] - -#### Request (object) [_request_ml.preview_datafeed] -- **`datafeed_id` (Optional, string)**: A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase -alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric -characters. NOTE: If you use this path parameter, you cannot provide datafeed or anomaly detection job -configuration details in the request body. -- **`datafeed_config` (Optional, { aggregations, chunking_config, datafeed_id, delayed_data_check_config, frequency, indices, indices_options, job_id, max_empty_searches, query, query_delay, runtime_mappings, script_fields, scroll_size })**: The datafeed definition to preview. -- **`job_config` (Optional, { allow_lazy_open, analysis_config, analysis_limits, background_persist_interval, custom_settings, daily_model_snapshot_retention_after_days, data_description, datafeed_config, description, groups, job_id, job_type, model_plot_config, model_snapshot_retention_days, renormalization_window_days, results_index_name, results_retention_days })**: The configuration details for the anomaly detection job that is associated with the datafeed. If the -`datafeed_config` object does not include a `job_id` that references an existing anomaly detection job, you must -supply this `job_config` object. If you include both a `job_id` and a `job_config`, the latter information is -used. You cannot specify a `job_config` object unless you also supply a `datafeed_config` object. -- **`start` (Optional, string \| Unit)**: The start time from where the datafeed preview should begin -- **`end` (Optional, string \| Unit)**: The end time when the datafeed preview should stop - -## client.ml.putCalendar [_ml.put_calendar] -Create a calendar. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-put-calendar) - -```ts -client.ml.putCalendar({ calendar_id }) -``` - -### Arguments [_arguments_ml.put_calendar] - -#### Request (object) [_request_ml.put_calendar] -- **`calendar_id` (string)**: A string that uniquely identifies a calendar. -- **`job_ids` (Optional, string[])**: An array of anomaly detection job identifiers. -- **`description` (Optional, string)**: A description of the calendar. - -## client.ml.putCalendarJob [_ml.put_calendar_job] -Add anomaly detection job to calendar. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-put-calendar-job) - -```ts -client.ml.putCalendarJob({ calendar_id, job_id }) -``` - -### Arguments [_arguments_ml.put_calendar_job] - -#### Request (object) [_request_ml.put_calendar_job] -- **`calendar_id` (string)**: A string that uniquely identifies a calendar. -- **`job_id` (string \| string[])**: An identifier for the anomaly detection jobs. It can be a job identifier, a group name, or a list of jobs or groups. - -## client.ml.putDataFrameAnalytics [_ml.put_data_frame_analytics] -Create a data frame analytics job. -This API creates a data frame analytics job that performs an analysis on the -source indices and stores the outcome in a destination index. -By default, the query used in the source configuration is `{"match_all": {}}`. - -If the destination index does not exist, it is created automatically when you start the job. - -If you supply only a subset of the regression or classification parameters, hyperparameter optimization occurs. It determines a value for each of the undefined parameters. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-put-data-frame-analytics) - -```ts -client.ml.putDataFrameAnalytics({ id, analysis, dest, source }) -``` - -### Arguments [_arguments_ml.put_data_frame_analytics] - -#### Request (object) [_request_ml.put_data_frame_analytics] -- **`id` (string)**: Identifier for the data frame analytics job. This identifier can contain -lowercase alphanumeric characters (a-z and 0-9), hyphens, and -underscores. It must start and end with alphanumeric characters. -- **`analysis` ({ classification, outlier_detection, regression })**: The analysis configuration, which contains the information necessary to -perform one of the following types of analysis: classification, outlier -detection, or regression. -- **`dest` ({ index, results_field })**: The destination configuration. -- **`source` ({ index, query, runtime_mappings, _source })**: The configuration of how to source the analysis data. -- **`allow_lazy_start` (Optional, boolean)**: Specifies whether this job can start when there is insufficient machine -learning node capacity for it to be immediately assigned to a node. If -set to `false` and a machine learning node with capacity to run the job -cannot be immediately found, the API returns an error. If set to `true`, -the API does not return an error; the job waits in the `starting` state -until sufficient machine learning node capacity is available. This -behavior is also affected by the cluster-wide -`xpack.ml.max_lazy_ml_nodes` setting. -- **`analyzed_fields` (Optional, { includes, excludes })**: Specifies `includes` and/or `excludes` patterns to select which fields -will be included in the analysis. The patterns specified in `excludes` -are applied last, therefore `excludes` takes precedence. In other words, -if the same field is specified in both `includes` and `excludes`, then -the field will not be included in the analysis. If `analyzed_fields` is -not set, only the relevant fields will be included. For example, all the -numeric fields for outlier detection. -The supported fields vary for each type of analysis. Outlier detection -requires numeric or `boolean` data to analyze. The algorithms don’t -support missing values therefore fields that have data types other than -numeric or boolean are ignored. Documents where included fields contain -missing values, null values, or an array are also ignored. Therefore the -`dest` index may contain documents that don’t have an outlier score. -Regression supports fields that are numeric, `boolean`, `text`, -`keyword`, and `ip` data types. It is also tolerant of missing values. -Fields that are supported are included in the analysis, other fields are -ignored. Documents where included fields contain an array with two or -more values are also ignored. Documents in the `dest` index that don’t -contain a results field are not included in the regression analysis. -Classification supports fields that are numeric, `boolean`, `text`, -`keyword`, and `ip` data types. It is also tolerant of missing values. -Fields that are supported are included in the analysis, other fields are -ignored. Documents where included fields contain an array with two or -more values are also ignored. Documents in the `dest` index that don’t -contain a results field are not included in the classification analysis. -Classification analysis can be improved by mapping ordinal variable -values to a single number. For example, in case of age ranges, you can -model the values as `0-14 = 0`, `15-24 = 1`, `25-34 = 2`, and so on. -- **`description` (Optional, string)**: A description of the job. -- **`max_num_threads` (Optional, number)**: The maximum number of threads to be used by the analysis. Using more -threads may decrease the time necessary to complete the analysis at the -cost of using more CPU. Note that the process may use additional threads -for operational functionality other than the analysis itself. -- **`_meta` (Optional, Record)** -- **`model_memory_limit` (Optional, string)**: The approximate maximum amount of memory resources that are permitted for -analytical processing. If your `elasticsearch.yml` file contains an -`xpack.ml.max_model_memory_limit` setting, an error occurs when you try -to create data frame analytics jobs that have `model_memory_limit` values -greater than that setting. -- **`headers` (Optional, Record)** -- **`version` (Optional, string)** - -## client.ml.putDatafeed [_ml.put_datafeed] -Create a datafeed. -Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job. -You can associate only one datafeed with each anomaly detection job. -The datafeed contains a query that runs at a defined interval (`frequency`). -If you are concerned about delayed data, you can add a delay (`query_delay') at each interval. -By default, the datafeed uses the following query: `{"match_all": {"boost": 1}}`. - -When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had -at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, -those credentials are used instead. -You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed -directly to the `.ml-config` index. Do not give users `write` privileges on the `.ml-config` index. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-put-datafeed) - -```ts -client.ml.putDatafeed({ datafeed_id }) -``` - -### Arguments [_arguments_ml.put_datafeed] - -#### Request (object) [_request_ml.put_datafeed] -- **`datafeed_id` (string)**: A numerical character string that uniquely identifies the datafeed. -This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. -It must start and end with alphanumeric characters. -- **`aggregations` (Optional, Record)**: If set, the datafeed performs aggregation searches. -Support for aggregations is limited and should be used only with low cardinality data. -- **`chunking_config` (Optional, { mode, time_span })**: Datafeeds might be required to search over long time periods, for several months or years. -This search is split into time chunks in order to ensure the load on Elasticsearch is managed. -Chunking configuration controls how the size of these time chunks are calculated; -it is an advanced configuration option. -- **`delayed_data_check_config` (Optional, { check_window, enabled })**: Specifies whether the datafeed checks for missing data and the size of the window. -The datafeed can optionally search over indices that have already been read in an effort to determine whether -any data has subsequently been added to the index. If missing data is found, it is a good indication that the -`query_delay` is set too low and the data is being indexed after the datafeed has passed that moment in time. -This check runs only on real-time datafeeds. -- **`frequency` (Optional, string \| -1 \| 0)**: The interval at which scheduled queries are made while the datafeed runs in real time. -The default value is either the bucket span for short bucket spans, or, for longer bucket spans, a sensible -fraction of the bucket span. When `frequency` is shorter than the bucket span, interim results for the last -(partial) bucket are written then eventually overwritten by the full bucket results. If the datafeed uses -aggregations, this value must be divisible by the interval of the date histogram aggregation. -- **`indices` (Optional, string \| string[])**: An array of index names. Wildcards are supported. If any of the indices are in remote clusters, the master -nodes and the machine learning nodes must have the `remote_cluster_client` role. -- **`indices_options` (Optional, { allow_no_indices, expand_wildcards, ignore_unavailable, ignore_throttled })**: Specifies index expansion options that are used during search -- **`job_id` (Optional, string)**: Identifier for the anomaly detection job. -- **`max_empty_searches` (Optional, number)**: If a real-time datafeed has never seen any data (including during any initial training period), it automatically -stops and closes the associated job after this many real-time searches return no documents. In other words, -it stops after `frequency` times `max_empty_searches` of real-time operation. If not set, a datafeed with no -end time that sees no data remains started until it is explicitly stopped. By default, it is not set. -- **`query` (Optional, { bool, boosting, common, combined_fields, constant_score, dis_max, distance_feature, exists, function_score, fuzzy, geo_bounding_box, geo_distance, geo_grid, geo_polygon, geo_shape, has_child, has_parent, ids, intervals, knn, match, match_all, match_bool_prefix, match_none, match_phrase, match_phrase_prefix, more_like_this, multi_match, nested, parent_id, percolate, pinned, prefix, query_string, range, rank_feature, regexp, rule, script, script_score, semantic, shape, simple_query_string, span_containing, span_field_masking, span_first, span_multi, span_near, span_not, span_or, span_term, span_within, sparse_vector, term, terms, terms_set, text_expansion, weighted_tokens, wildcard, wrapper, type })**: The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an -Elasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this -object is passed verbatim to Elasticsearch. -- **`query_delay` (Optional, string \| -1 \| 0)**: The number of seconds behind real time that data is queried. For example, if data from 10:04 a.m. might -not be searchable in Elasticsearch until 10:06 a.m., set this property to 120 seconds. The default -value is randomly selected between `60s` and `120s`. This randomness improves the query performance -when there are multiple jobs running on the same node. -- **`runtime_mappings` (Optional, Record)**: Specifies runtime fields for the datafeed search. -- **`script_fields` (Optional, Record)**: Specifies scripts that evaluate custom expressions and returns script fields to the datafeed. -The detector configuration objects in a job can contain functions that use these script fields. -- **`scroll_size` (Optional, number)**: The size parameter that is used in Elasticsearch searches when the datafeed does not use aggregations. -The maximum value is the value of `index.max_result_window`, which is 10,000 by default. -- **`headers` (Optional, Record)** -- **`allow_no_indices` (Optional, boolean)**: If true, wildcard indices expressions that resolve into no concrete indices are ignored. This includes the `_all` -string or when no indices are specified. -- **`expand_wildcards` (Optional, Enum("all" \| "open" \| "closed" \| "hidden" \| "none") \| Enum("all" \| "open" \| "closed" \| "hidden" \| "none")[])**: Type of index that wildcard patterns can match. If the request can target data streams, this argument determines -whether wildcard expressions match hidden data streams. Supports a list of values. -- **`ignore_throttled` (Optional, boolean)**: If true, concrete, expanded, or aliased indices are ignored when frozen. -- **`ignore_unavailable` (Optional, boolean)**: If true, unavailable indices (missing or closed) are ignored. - -## client.ml.putFilter [_ml.put_filter] -Create a filter. -A filter contains a list of strings. It can be used by one or more anomaly detection jobs. -Specifically, filters are referenced in the `custom_rules` property of detector configuration objects. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-put-filter) - -```ts -client.ml.putFilter({ filter_id }) -``` - -### Arguments [_arguments_ml.put_filter] - -#### Request (object) [_request_ml.put_filter] -- **`filter_id` (string)**: A string that uniquely identifies a filter. -- **`description` (Optional, string)**: A description of the filter. -- **`items` (Optional, string[])**: The items of the filter. A wildcard `*` can be used at the beginning or the end of an item. -Up to 10000 items are allowed in each filter. - -## client.ml.putJob [_ml.put_job] -Create an anomaly detection job. - -If you include a `datafeed_config`, you must have read index privileges on the source index. -If you include a `datafeed_config` but do not provide a query, the datafeed uses `{"match_all": {"boost": 1}}`. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-put-job) - -```ts -client.ml.putJob({ job_id, analysis_config, data_description }) -``` - -### Arguments [_arguments_ml.put_job] - -#### Request (object) [_request_ml.put_job] -- **`job_id` (string)**: The identifier for the anomaly detection job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters. -- **`analysis_config` ({ bucket_span, categorization_analyzer, categorization_field_name, categorization_filters, detectors, influencers, latency, model_prune_window, multivariate_by_fields, per_partition_categorization, summary_count_field_name })**: Specifies how to analyze the data. After you create a job, you cannot change the analysis configuration; all the properties are informational. -- **`data_description` ({ format, time_field, time_format, field_delimiter })**: Defines the format of the input data when you send data to the job by using the post data API. Note that when configure a datafeed, these properties are automatically set. When data is received via the post data API, it is not stored in Elasticsearch. Only the results for anomaly detection are retained. -- **`allow_lazy_open` (Optional, boolean)**: Advanced configuration option. Specifies whether this job can open when there is insufficient machine learning node capacity for it to be immediately assigned to a node. By default, if a machine learning node with capacity to run the job cannot immediately be found, the open anomaly detection jobs API returns an error. However, this is also subject to the cluster-wide `xpack.ml.max_lazy_ml_nodes` setting. If this option is set to true, the open anomaly detection jobs API does not return an error and the job waits in the opening state until sufficient machine learning node capacity is available. -- **`analysis_limits` (Optional, { categorization_examples_limit, model_memory_limit })**: Limits can be applied for the resources required to hold the mathematical models in memory. These limits are approximate and can be set per job. They do not control the memory used by other processes, for example the Elasticsearch Java processes. -- **`background_persist_interval` (Optional, string \| -1 \| 0)**: Advanced configuration option. The time between each periodic persistence of the model. The default value is a randomized value between 3 to 4 hours, which avoids all jobs persisting at exactly the same time. The smallest allowed value is 1 hour. For very large models (several GB), persistence could take 10-20 minutes, so do not set the `background_persist_interval` value too low. -- **`custom_settings` (Optional, User-defined value)**: Advanced configuration option. Contains custom meta data about the job. -- **`daily_model_snapshot_retention_after_days` (Optional, number)**: Advanced configuration option, which affects the automatic removal of old model snapshots for this job. It specifies a period of time (in days) after which only the first snapshot per day is retained. This period is relative to the timestamp of the most recent snapshot for this job. Valid values range from 0 to `model_snapshot_retention_days`. -- **`datafeed_config` (Optional, { aggregations, chunking_config, datafeed_id, delayed_data_check_config, frequency, indices, indices_options, job_id, max_empty_searches, query, query_delay, runtime_mappings, script_fields, scroll_size })**: Defines a datafeed for the anomaly detection job. If Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead. -- **`description` (Optional, string)**: A description of the job. -- **`groups` (Optional, string[])**: A list of job groups. A job can belong to no groups or many. -- **`model_plot_config` (Optional, { annotations_enabled, enabled, terms })**: This advanced configuration option stores model information along with the results. It provides a more detailed view into anomaly detection. If you enable model plot it can add considerable overhead to the performance of the system; it is not feasible for jobs with many entities. Model plot provides a simplified and indicative view of the model and its bounds. It does not display complex features such as multivariate correlations or multimodal data. As such, anomalies may occasionally be reported which cannot be seen in the model plot. Model plot config can be configured when the job is created or updated later. It must be disabled if performance issues are experienced. -- **`model_snapshot_retention_days` (Optional, number)**: Advanced configuration option, which affects the automatic removal of old model snapshots for this job. It specifies the maximum period of time (in days) that snapshots are retained. This period is relative to the timestamp of the most recent snapshot for this job. By default, snapshots ten days older than the newest snapshot are deleted. -- **`renormalization_window_days` (Optional, number)**: Advanced configuration option. The period over which adjustments to the score are applied, as new data is seen. The default value is the longer of 30 days or 100 bucket spans. -- **`results_index_name` (Optional, string)**: A text string that affects the name of the machine learning results index. By default, the job generates an index named `.ml-anomalies-shared`. -- **`results_retention_days` (Optional, number)**: Advanced configuration option. The period of time (in days) that results are retained. Age is calculated relative to the timestamp of the latest bucket result. If this property has a non-null value, once per day at 00:30 (server time), results that are the specified number of days older than the latest bucket result are deleted from Elasticsearch. The default value is null, which means all results are retained. Annotations generated by the system also count as results for retention purposes; they are deleted after the same number of days as results. Annotations added by users are retained forever. -- **`allow_no_indices` (Optional, boolean)**: If `true`, wildcard indices expressions that resolve into no concrete indices are ignored. This includes the -`_all` string or when no indices are specified. -- **`expand_wildcards` (Optional, Enum("all" \| "open" \| "closed" \| "hidden" \| "none") \| Enum("all" \| "open" \| "closed" \| "hidden" \| "none")[])**: Type of index that wildcard patterns can match. If the request can target data streams, this argument determines -whether wildcard expressions match hidden data streams. Supports a list of values. Valid values are: - -* `all`: Match any data stream or index, including hidden ones. -* `closed`: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed. -* `hidden`: Match hidden data streams and hidden indices. Must be combined with `open`, `closed`, or both. -* `none`: Wildcard patterns are not accepted. -* `open`: Match open, non-hidden indices. Also matches any non-hidden data stream. -- **`ignore_throttled` (Optional, boolean)**: If `true`, concrete, expanded or aliased indices are ignored when frozen. -- **`ignore_unavailable` (Optional, boolean)**: If `true`, unavailable indices (missing or closed) are ignored. - -## client.ml.putTrainedModel [_ml.put_trained_model] -Create a trained model. -Enable you to supply a trained model that is not created by data frame analytics. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-put-trained-model) - -```ts -client.ml.putTrainedModel({ model_id }) -``` - -### Arguments [_arguments_ml.put_trained_model] - -#### Request (object) [_request_ml.put_trained_model] -- **`model_id` (string)**: The unique identifier of the trained model. -- **`compressed_definition` (Optional, string)**: The compressed (GZipped and Base64 encoded) inference definition of the -model. If compressed_definition is specified, then definition cannot be -specified. -- **`definition` (Optional, { preprocessors, trained_model })**: The inference definition for the model. If definition is specified, then -compressed_definition cannot be specified. -- **`description` (Optional, string)**: A human-readable description of the inference trained model. -- **`inference_config` (Optional, { regression, classification, text_classification, zero_shot_classification, fill_mask, learning_to_rank, ner, pass_through, text_embedding, text_expansion, question_answering })**: The default configuration for inference. This can be either a regression -or classification configuration. It must match the underlying -definition.trained_model's target_type. For pre-packaged models such as -ELSER the config is not required. -- **`input` (Optional, { field_names })**: The input field names for the model definition. -- **`metadata` (Optional, User-defined value)**: An object map that contains metadata about the model. -- **`model_type` (Optional, Enum("tree_ensemble" \| "lang_ident" \| "pytorch"))**: The model type. -- **`model_size_bytes` (Optional, number)**: The estimated memory usage in bytes to keep the trained model in memory. -This property is supported only if defer_definition_decompression is true -or the model definition is not supplied. -- **`platform_architecture` (Optional, string)**: The platform architecture (if applicable) of the trained mode. If the model -only works on one platform, because it is heavily optimized for a particular -processor architecture and OS combination, then this field specifies which. -The format of the string must match the platform identifiers used by Elasticsearch, -so one of, `linux-x86_64`, `linux-aarch64`, `darwin-x86_64`, `darwin-aarch64`, -or `windows-x86_64`. For portable models (those that work independent of processor -architecture or OS features), leave this field unset. -- **`tags` (Optional, string[])**: An array of tags to organize the model. -- **`prefix_strings` (Optional, { ingest, search })**: Optional prefix strings applied at inference -- **`defer_definition_decompression` (Optional, boolean)**: If set to `true` and a `compressed_definition` is provided, -the request defers definition decompression and skips relevant -validations. -- **`wait_for_completion` (Optional, boolean)**: Whether to wait for all child operations (e.g. model download) -to complete. - -## client.ml.putTrainedModelAlias [_ml.put_trained_model_alias] -Create or update a trained model alias. -A trained model alias is a logical name used to reference a single trained -model. -You can use aliases instead of trained model identifiers to make it easier to -reference your models. For example, you can use aliases in inference -aggregations and processors. -An alias must be unique and refer to only a single trained model. However, -you can have multiple aliases for each trained model. -If you use this API to update an alias such that it references a different -trained model ID and the model uses a different type of data frame analytics, -an error occurs. For example, this situation occurs if you have a trained -model for regression analysis and a trained model for classification -analysis; you cannot reassign an alias from one type of trained model to -another. -If you use this API to update an alias and there are very few input fields in -common between the old and new trained models for the model alias, the API -returns a warning. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-put-trained-model-alias) - -```ts -client.ml.putTrainedModelAlias({ model_alias, model_id }) -``` - -### Arguments [_arguments_ml.put_trained_model_alias] - -#### Request (object) [_request_ml.put_trained_model_alias] -- **`model_alias` (string)**: The alias to create or update. This value cannot end in numbers. -- **`model_id` (string)**: The identifier for the trained model that the alias refers to. -- **`reassign` (Optional, boolean)**: Specifies whether the alias gets reassigned to the specified trained -model if it is already assigned to a different model. If the alias is -already assigned and this parameter is false, the API returns an error. - -## client.ml.putTrainedModelDefinitionPart [_ml.put_trained_model_definition_part] -Create part of a trained model definition. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-put-trained-model-definition-part) - -```ts -client.ml.putTrainedModelDefinitionPart({ model_id, part, definition, total_definition_length, total_parts }) -``` - -### Arguments [_arguments_ml.put_trained_model_definition_part] - -#### Request (object) [_request_ml.put_trained_model_definition_part] -- **`model_id` (string)**: The unique identifier of the trained model. -- **`part` (number)**: The definition part number. When the definition is loaded for inference the definition parts are streamed in the -order of their part number. The first part must be `0` and the final part must be `total_parts - 1`. -- **`definition` (string)**: The definition part for the model. Must be a base64 encoded string. -- **`total_definition_length` (number)**: The total uncompressed definition length in bytes. Not base64 encoded. -- **`total_parts` (number)**: The total number of parts that will be uploaded. Must be greater than 0. - -## client.ml.putTrainedModelVocabulary [_ml.put_trained_model_vocabulary] -Create a trained model vocabulary. -This API is supported only for natural language processing (NLP) models. -The vocabulary is stored in the index as described in `inference_config.*.vocabulary` of the trained model definition. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-put-trained-model-vocabulary) - -```ts -client.ml.putTrainedModelVocabulary({ model_id, vocabulary }) -``` - -### Arguments [_arguments_ml.put_trained_model_vocabulary] - -#### Request (object) [_request_ml.put_trained_model_vocabulary] -- **`model_id` (string)**: The unique identifier of the trained model. -- **`vocabulary` (string[])**: The model vocabulary, which must not be empty. -- **`merges` (Optional, string[])**: The optional model merges if required by the tokenizer. -- **`scores` (Optional, number[])**: The optional vocabulary value scores if required by the tokenizer. - -## client.ml.resetJob [_ml.reset_job] -Reset an anomaly detection job. -All model state and results are deleted. The job is ready to start over as if -it had just been created. -It is not currently possible to reset multiple jobs using wildcards or a -comma separated list. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-reset-job) - -```ts -client.ml.resetJob({ job_id }) -``` - -### Arguments [_arguments_ml.reset_job] - -#### Request (object) [_request_ml.reset_job] -- **`job_id` (string)**: The ID of the job to reset. -- **`wait_for_completion` (Optional, boolean)**: Should this request wait until the operation has completed before -returning. -- **`delete_user_annotations` (Optional, boolean)**: Specifies whether annotations that have been added by the -user should be deleted along with any auto-generated annotations when the job is -reset. - -## client.ml.revertModelSnapshot [_ml.revert_model_snapshot] -Revert to a snapshot. -The machine learning features react quickly to anomalous input, learning new -behaviors in data. Highly anomalous input increases the variance in the -models whilst the system learns whether this is a new step-change in behavior -or a one-off event. In the case where this anomalous input is known to be a -one-off, then it might be appropriate to reset the model state to a time -before this event. For example, you might consider reverting to a saved -snapshot after Black Friday or a critical system failure. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-revert-model-snapshot) - -```ts -client.ml.revertModelSnapshot({ job_id, snapshot_id }) -``` - -### Arguments [_arguments_ml.revert_model_snapshot] - -#### Request (object) [_request_ml.revert_model_snapshot] -- **`job_id` (string)**: Identifier for the anomaly detection job. -- **`snapshot_id` (string)**: You can specify `empty` as the . Reverting to the empty -snapshot means the anomaly detection job starts learning a new model from -scratch when it is started. -- **`delete_intervening_results` (Optional, boolean)**: Refer to the description for the `delete_intervening_results` query parameter. - -## client.ml.setUpgradeMode [_ml.set_upgrade_mode] -Set upgrade_mode for ML indices. -Sets a cluster wide upgrade_mode setting that prepares machine learning -indices for an upgrade. -When upgrading your cluster, in some circumstances you must restart your -nodes and reindex your machine learning indices. In those circumstances, -there must be no machine learning jobs running. You can close the machine -learning jobs, do the upgrade, then open all the jobs again. Alternatively, -you can use this API to temporarily halt tasks associated with the jobs and -datafeeds and prevent new jobs from opening. You can also use this API -during upgrades that do not require you to reindex your machine learning -indices, though stopping jobs is not a requirement in that case. -You can see the current value for the upgrade_mode setting by using the get -machine learning info API. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-set-upgrade-mode) - -```ts -client.ml.setUpgradeMode({ ... }) -``` - -### Arguments [_arguments_ml.set_upgrade_mode] - -#### Request (object) [_request_ml.set_upgrade_mode] -- **`enabled` (Optional, boolean)**: When `true`, it enables `upgrade_mode` which temporarily halts all job -and datafeed tasks and prohibits new job and datafeed tasks from -starting. -- **`timeout` (Optional, string \| -1 \| 0)**: The time to wait for the request to be completed. - -## client.ml.startDataFrameAnalytics [_ml.start_data_frame_analytics] -Start a data frame analytics job. -A data frame analytics job can be started and stopped multiple times -throughout its lifecycle. -If the destination index does not exist, it is created automatically the -first time you start the data frame analytics job. The -`index.number_of_shards` and `index.number_of_replicas` settings for the -destination index are copied from the source index. If there are multiple -source indices, the destination index copies the highest setting values. The -mappings for the destination index are also copied from the source indices. -If there are any mapping conflicts, the job fails to start. -If the destination index exists, it is used as is. You can therefore set up -the destination index in advance with custom settings and mappings. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-start-data-frame-analytics) - -```ts -client.ml.startDataFrameAnalytics({ id }) -``` - -### Arguments [_arguments_ml.start_data_frame_analytics] - -#### Request (object) [_request_ml.start_data_frame_analytics] -- **`id` (string)**: Identifier for the data frame analytics job. This identifier can contain -lowercase alphanumeric characters (a-z and 0-9), hyphens, and -underscores. It must start and end with alphanumeric characters. -- **`timeout` (Optional, string \| -1 \| 0)**: Controls the amount of time to wait until the data frame analytics job -starts. - -## client.ml.startDatafeed [_ml.start_datafeed] -Start datafeeds. - -A datafeed must be started in order to retrieve data from Elasticsearch. A datafeed can be started and stopped -multiple times throughout its lifecycle. - -Before you can start a datafeed, the anomaly detection job must be open. Otherwise, an error occurs. - -If you restart a stopped datafeed, it continues processing input data from the next millisecond after it was stopped. -If new data was indexed for that exact millisecond between stopping and starting, it will be ignored. - -When Elasticsearch security features are enabled, your datafeed remembers which roles the last user to create or -update it had at the time of creation or update and runs the query using those same roles. If you provided secondary -authorization headers when you created or updated the datafeed, those credentials are used instead. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-start-datafeed) - -```ts -client.ml.startDatafeed({ datafeed_id }) -``` - -### Arguments [_arguments_ml.start_datafeed] - -#### Request (object) [_request_ml.start_datafeed] -- **`datafeed_id` (string)**: A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase -alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric -characters. -- **`end` (Optional, string \| Unit)**: Refer to the description for the `end` query parameter. -- **`start` (Optional, string \| Unit)**: Refer to the description for the `start` query parameter. -- **`timeout` (Optional, string \| -1 \| 0)**: Refer to the description for the `timeout` query parameter. - -## client.ml.startTrainedModelDeployment [_ml.start_trained_model_deployment] -Start a trained model deployment. -It allocates the model to every machine learning node. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-start-trained-model-deployment) - -```ts -client.ml.startTrainedModelDeployment({ model_id }) -``` - -### Arguments [_arguments_ml.start_trained_model_deployment] - -#### Request (object) [_request_ml.start_trained_model_deployment] -- **`model_id` (string)**: The unique identifier of the trained model. Currently, only PyTorch models are supported. -- **`adaptive_allocations` (Optional, { enabled, min_number_of_allocations, max_number_of_allocations })**: Adaptive allocations configuration. When enabled, the number of allocations -is set based on the current load. -If adaptive_allocations is enabled, do not set the number of allocations manually. -- **`cache_size` (Optional, number \| string)**: The inference cache size (in memory outside the JVM heap) per node for the model. -The default value is the same size as the `model_size_bytes`. To disable the cache, -`0b` can be provided. -- **`deployment_id` (Optional, string)**: A unique identifier for the deployment of the model. -- **`number_of_allocations` (Optional, number)**: The number of model allocations on each node where the model is deployed. -All allocations on a node share the same copy of the model in memory but use -a separate set of threads to evaluate the model. -Increasing this value generally increases the throughput. -If this setting is greater than the number of hardware threads -it will automatically be changed to a value less than the number of hardware threads. -If adaptive_allocations is enabled, do not set this value, because it’s automatically set. -- **`priority` (Optional, Enum("normal" \| "low"))**: The deployment priority. -- **`queue_capacity` (Optional, number)**: Specifies the number of inference requests that are allowed in the queue. After the number of requests exceeds -this value, new requests are rejected with a 429 error. -- **`threads_per_allocation` (Optional, number)**: Sets the number of threads used by each model allocation during inference. This generally increases -the inference speed. The inference process is a compute-bound process; any number -greater than the number of available hardware threads on the machine does not increase the -inference speed. If this setting is greater than the number of hardware threads -it will automatically be changed to a value less than the number of hardware threads. -- **`timeout` (Optional, string \| -1 \| 0)**: Specifies the amount of time to wait for the model to deploy. -- **`wait_for` (Optional, Enum("started" \| "starting" \| "fully_allocated"))**: Specifies the allocation status to wait for before returning. - -## client.ml.stopDataFrameAnalytics [_ml.stop_data_frame_analytics] -Stop data frame analytics jobs. -A data frame analytics job can be started and stopped multiple times -throughout its lifecycle. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-stop-data-frame-analytics) - -```ts -client.ml.stopDataFrameAnalytics({ id }) -``` - -### Arguments [_arguments_ml.stop_data_frame_analytics] - -#### Request (object) [_request_ml.stop_data_frame_analytics] -- **`id` (string)**: Identifier for the data frame analytics job. This identifier can contain -lowercase alphanumeric characters (a-z and 0-9), hyphens, and -underscores. It must start and end with alphanumeric characters. -- **`allow_no_match` (Optional, boolean)**: Specifies what to do when the request: - -1. Contains wildcard expressions and there are no data frame analytics -jobs that match. -2. Contains the _all string or no identifiers and there are no matches. -3. Contains wildcard expressions and there are only partial matches. - -The default value is true, which returns an empty data_frame_analytics -array when there are no matches and the subset of results when there are -partial matches. If this parameter is false, the request returns a 404 -status code when there are no matches or only partial matches. -- **`force` (Optional, boolean)**: If true, the data frame analytics job is stopped forcefully. -- **`timeout` (Optional, string \| -1 \| 0)**: Controls the amount of time to wait until the data frame analytics job -stops. Defaults to 20 seconds. - -## client.ml.stopDatafeed [_ml.stop_datafeed] -Stop datafeeds. -A datafeed that is stopped ceases to retrieve data from Elasticsearch. A datafeed can be started and stopped -multiple times throughout its lifecycle. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-stop-datafeed) - -```ts -client.ml.stopDatafeed({ datafeed_id }) -``` - -### Arguments [_arguments_ml.stop_datafeed] - -#### Request (object) [_request_ml.stop_datafeed] -- **`datafeed_id` (string)**: Identifier for the datafeed. You can stop multiple datafeeds in a single API request by using a comma-separated -list of datafeeds or a wildcard expression. You can close all datafeeds by using `_all` or by specifying `*` as -the identifier. -- **`allow_no_match` (Optional, boolean)**: Refer to the description for the `allow_no_match` query parameter. -- **`force` (Optional, boolean)**: Refer to the description for the `force` query parameter. -- **`timeout` (Optional, string \| -1 \| 0)**: Refer to the description for the `timeout` query parameter. - -## client.ml.stopTrainedModelDeployment [_ml.stop_trained_model_deployment] -Stop a trained model deployment. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-stop-trained-model-deployment) - -```ts -client.ml.stopTrainedModelDeployment({ model_id }) -``` - -### Arguments [_arguments_ml.stop_trained_model_deployment] - -#### Request (object) [_request_ml.stop_trained_model_deployment] -- **`model_id` (string)**: The unique identifier of the trained model. -- **`allow_no_match` (Optional, boolean)**: Specifies what to do when the request: contains wildcard expressions and there are no deployments that match; -contains the `_all` string or no identifiers and there are no matches; or contains wildcard expressions and -there are only partial matches. By default, it returns an empty array when there are no matches and the subset of results when there are partial matches. -If `false`, the request returns a 404 status code when there are no matches or only partial matches. -- **`force` (Optional, boolean)**: Forcefully stops the deployment, even if it is used by ingest pipelines. You can't use these pipelines until you -restart the model deployment. - -## client.ml.updateDataFrameAnalytics [_ml.update_data_frame_analytics] -Update a data frame analytics job. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-update-data-frame-analytics) - -```ts -client.ml.updateDataFrameAnalytics({ id }) -``` - -### Arguments [_arguments_ml.update_data_frame_analytics] - -#### Request (object) [_request_ml.update_data_frame_analytics] -- **`id` (string)**: Identifier for the data frame analytics job. This identifier can contain -lowercase alphanumeric characters (a-z and 0-9), hyphens, and -underscores. It must start and end with alphanumeric characters. -- **`description` (Optional, string)**: A description of the job. -- **`model_memory_limit` (Optional, string)**: The approximate maximum amount of memory resources that are permitted for -analytical processing. If your `elasticsearch.yml` file contains an -`xpack.ml.max_model_memory_limit` setting, an error occurs when you try -to create data frame analytics jobs that have `model_memory_limit` values -greater than that setting. -- **`max_num_threads` (Optional, number)**: The maximum number of threads to be used by the analysis. Using more -threads may decrease the time necessary to complete the analysis at the -cost of using more CPU. Note that the process may use additional threads -for operational functionality other than the analysis itself. -- **`allow_lazy_start` (Optional, boolean)**: Specifies whether this job can start when there is insufficient machine -learning node capacity for it to be immediately assigned to a node. - -## client.ml.updateDatafeed [_ml.update_datafeed] -Update a datafeed. -You must stop and start the datafeed for the changes to be applied. -When Elasticsearch security features are enabled, your datafeed remembers which roles the user who updated it had at -the time of the update and runs the query using those same roles. If you provide secondary authorization headers, -those credentials are used instead. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-update-datafeed) - -```ts -client.ml.updateDatafeed({ datafeed_id }) -``` - -### Arguments [_arguments_ml.update_datafeed] - -#### Request (object) [_request_ml.update_datafeed] -- **`datafeed_id` (string)**: A numerical character string that uniquely identifies the datafeed. -This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. -It must start and end with alphanumeric characters. -- **`aggregations` (Optional, Record)**: If set, the datafeed performs aggregation searches. Support for aggregations is limited and should be used only -with low cardinality data. -- **`chunking_config` (Optional, { mode, time_span })**: Datafeeds might search over long time periods, for several months or years. This search is split into time -chunks in order to ensure the load on Elasticsearch is managed. Chunking configuration controls how the size of -these time chunks are calculated; it is an advanced configuration option. -- **`delayed_data_check_config` (Optional, { check_window, enabled })**: Specifies whether the datafeed checks for missing data and the size of the window. The datafeed can optionally -search over indices that have already been read in an effort to determine whether any data has subsequently been -added to the index. If missing data is found, it is a good indication that the `query_delay` is set too low and -the data is being indexed after the datafeed has passed that moment in time. This check runs only on real-time -datafeeds. -- **`frequency` (Optional, string \| -1 \| 0)**: The interval at which scheduled queries are made while the datafeed runs in real time. The default value is -either the bucket span for short bucket spans, or, for longer bucket spans, a sensible fraction of the bucket -span. When `frequency` is shorter than the bucket span, interim results for the last (partial) bucket are -written then eventually overwritten by the full bucket results. If the datafeed uses aggregations, this value -must be divisible by the interval of the date histogram aggregation. -- **`indices` (Optional, string[])**: An array of index names. Wildcards are supported. If any of the indices are in remote clusters, the machine -learning nodes must have the `remote_cluster_client` role. -- **`indices_options` (Optional, { allow_no_indices, expand_wildcards, ignore_unavailable, ignore_throttled })**: Specifies index expansion options that are used during search. -- **`job_id` (Optional, string)** -- **`max_empty_searches` (Optional, number)**: If a real-time datafeed has never seen any data (including during any initial training period), it automatically -stops and closes the associated job after this many real-time searches return no documents. In other words, -it stops after `frequency` times `max_empty_searches` of real-time operation. If not set, a datafeed with no -end time that sees no data remains started until it is explicitly stopped. By default, it is not set. -- **`query` (Optional, { bool, boosting, common, combined_fields, constant_score, dis_max, distance_feature, exists, function_score, fuzzy, geo_bounding_box, geo_distance, geo_grid, geo_polygon, geo_shape, has_child, has_parent, ids, intervals, knn, match, match_all, match_bool_prefix, match_none, match_phrase, match_phrase_prefix, more_like_this, multi_match, nested, parent_id, percolate, pinned, prefix, query_string, range, rank_feature, regexp, rule, script, script_score, semantic, shape, simple_query_string, span_containing, span_field_masking, span_first, span_multi, span_near, span_not, span_or, span_term, span_within, sparse_vector, term, terms, terms_set, text_expansion, weighted_tokens, wildcard, wrapper, type })**: The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an -Elasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this -object is passed verbatim to Elasticsearch. Note that if you change the query, the analyzed data is also -changed. Therefore, the time required to learn might be long and the understandability of the results is -unpredictable. If you want to make significant changes to the source data, it is recommended that you -clone the job and datafeed and make the amendments in the clone. Let both run in parallel and close one -when you are satisfied with the results of the job. -- **`query_delay` (Optional, string \| -1 \| 0)**: The number of seconds behind real time that data is queried. For example, if data from 10:04 a.m. might -not be searchable in Elasticsearch until 10:06 a.m., set this property to 120 seconds. The default -value is randomly selected between `60s` and `120s`. This randomness improves the query performance -when there are multiple jobs running on the same node. -- **`runtime_mappings` (Optional, Record)**: Specifies runtime fields for the datafeed search. -- **`script_fields` (Optional, Record)**: Specifies scripts that evaluate custom expressions and returns script fields to the datafeed. -The detector configuration objects in a job can contain functions that use these script fields. -- **`scroll_size` (Optional, number)**: The size parameter that is used in Elasticsearch searches when the datafeed does not use aggregations. -The maximum value is the value of `index.max_result_window`. -- **`allow_no_indices` (Optional, boolean)**: If `true`, wildcard indices expressions that resolve into no concrete indices are ignored. This includes the -`_all` string or when no indices are specified. -- **`expand_wildcards` (Optional, Enum("all" \| "open" \| "closed" \| "hidden" \| "none") \| Enum("all" \| "open" \| "closed" \| "hidden" \| "none")[])**: Type of index that wildcard patterns can match. If the request can target data streams, this argument determines -whether wildcard expressions match hidden data streams. Supports a list of values. Valid values are: - -* `all`: Match any data stream or index, including hidden ones. -* `closed`: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed. -* `hidden`: Match hidden data streams and hidden indices. Must be combined with `open`, `closed`, or both. -* `none`: Wildcard patterns are not accepted. -* `open`: Match open, non-hidden indices. Also matches any non-hidden data stream. -- **`ignore_throttled` (Optional, boolean)**: If `true`, concrete, expanded or aliased indices are ignored when frozen. -- **`ignore_unavailable` (Optional, boolean)**: If `true`, unavailable indices (missing or closed) are ignored. - -## client.ml.updateFilter [_ml.update_filter] -Update a filter. -Updates the description of a filter, adds items, or removes items from the list. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-update-filter) - -```ts -client.ml.updateFilter({ filter_id }) -``` - -### Arguments [_arguments_ml.update_filter] - -#### Request (object) [_request_ml.update_filter] -- **`filter_id` (string)**: A string that uniquely identifies a filter. -- **`add_items` (Optional, string[])**: The items to add to the filter. -- **`description` (Optional, string)**: A description for the filter. -- **`remove_items` (Optional, string[])**: The items to remove from the filter. - -## client.ml.updateJob [_ml.update_job] -Update an anomaly detection job. -Updates certain properties of an anomaly detection job. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-update-job) - -```ts -client.ml.updateJob({ job_id }) -``` - -### Arguments [_arguments_ml.update_job] - -#### Request (object) [_request_ml.update_job] -- **`job_id` (string)**: Identifier for the job. -- **`allow_lazy_open` (Optional, boolean)**: Advanced configuration option. Specifies whether this job can open when -there is insufficient machine learning node capacity for it to be -immediately assigned to a node. If `false` and a machine learning node -with capacity to run the job cannot immediately be found, the open -anomaly detection jobs API returns an error. However, this is also -subject to the cluster-wide `xpack.ml.max_lazy_ml_nodes` setting. If this -option is set to `true`, the open anomaly detection jobs API does not -return an error and the job waits in the opening state until sufficient -machine learning node capacity is available. -- **`analysis_limits` (Optional, { model_memory_limit })** -- **`background_persist_interval` (Optional, string \| -1 \| 0)**: Advanced configuration option. The time between each periodic persistence -of the model. -The default value is a randomized value between 3 to 4 hours, which -avoids all jobs persisting at exactly the same time. The smallest allowed -value is 1 hour. -For very large models (several GB), persistence could take 10-20 minutes, -so do not set the value too low. -If the job is open when you make the update, you must stop the datafeed, -close the job, then reopen the job and restart the datafeed for the -changes to take effect. -- **`custom_settings` (Optional, Record)**: Advanced configuration option. Contains custom meta data about the job. -For example, it can contain custom URL information as shown in Adding -custom URLs to machine learning results. -- **`categorization_filters` (Optional, string[])** -- **`description` (Optional, string)**: A description of the job. -- **`model_plot_config` (Optional, { annotations_enabled, enabled, terms })** -- **`model_prune_window` (Optional, string \| -1 \| 0)** -- **`daily_model_snapshot_retention_after_days` (Optional, number)**: Advanced configuration option, which affects the automatic removal of old -model snapshots for this job. It specifies a period of time (in days) -after which only the first snapshot per day is retained. This period is -relative to the timestamp of the most recent snapshot for this job. Valid -values range from 0 to `model_snapshot_retention_days`. For jobs created -before version 7.8.0, the default value matches -`model_snapshot_retention_days`. -- **`model_snapshot_retention_days` (Optional, number)**: Advanced configuration option, which affects the automatic removal of old -model snapshots for this job. It specifies the maximum period of time (in -days) that snapshots are retained. This period is relative to the -timestamp of the most recent snapshot for this job. -- **`renormalization_window_days` (Optional, number)**: Advanced configuration option. The period over which adjustments to the -score are applied, as new data is seen. -- **`results_retention_days` (Optional, number)**: Advanced configuration option. The period of time (in days) that results -are retained. Age is calculated relative to the timestamp of the latest -bucket result. If this property has a non-null value, once per day at -00:30 (server time), results that are the specified number of days older -than the latest bucket result are deleted from Elasticsearch. The default -value is null, which means all results are retained. -- **`groups` (Optional, string[])**: A list of job groups. A job can belong to no groups or many. -- **`detectors` (Optional, { detector_index, description, custom_rules }[])**: An array of detector update objects. -- **`per_partition_categorization` (Optional, { enabled, stop_on_warn })**: Settings related to how categorization interacts with partition fields. - -## client.ml.updateModelSnapshot [_ml.update_model_snapshot] -Update a snapshot. -Updates certain properties of a snapshot. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-update-model-snapshot) - -```ts -client.ml.updateModelSnapshot({ job_id, snapshot_id }) -``` - -### Arguments [_arguments_ml.update_model_snapshot] - -#### Request (object) [_request_ml.update_model_snapshot] -- **`job_id` (string)**: Identifier for the anomaly detection job. -- **`snapshot_id` (string)**: Identifier for the model snapshot. -- **`description` (Optional, string)**: A description of the model snapshot. -- **`retain` (Optional, boolean)**: If `true`, this snapshot will not be deleted during automatic cleanup of -snapshots older than `model_snapshot_retention_days`. However, this -snapshot will be deleted when the job is deleted. - -## client.ml.updateTrainedModelDeployment [_ml.update_trained_model_deployment] -Update a trained model deployment. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-update-trained-model-deployment) - -```ts -client.ml.updateTrainedModelDeployment({ model_id }) -``` - -### Arguments [_arguments_ml.update_trained_model_deployment] - -#### Request (object) [_request_ml.update_trained_model_deployment] -- **`model_id` (string)**: The unique identifier of the trained model. Currently, only PyTorch models are supported. -- **`number_of_allocations` (Optional, number)**: The number of model allocations on each node where the model is deployed. -All allocations on a node share the same copy of the model in memory but use -a separate set of threads to evaluate the model. -Increasing this value generally increases the throughput. -If this setting is greater than the number of hardware threads -it will automatically be changed to a value less than the number of hardware threads. -If adaptive_allocations is enabled, do not set this value, because it’s automatically set. -- **`adaptive_allocations` (Optional, { enabled, min_number_of_allocations, max_number_of_allocations })**: Adaptive allocations configuration. When enabled, the number of allocations -is set based on the current load. -If adaptive_allocations is enabled, do not set the number of allocations manually. - -## client.ml.upgradeJobSnapshot [_ml.upgrade_job_snapshot] -Upgrade a snapshot. -Upgrade an anomaly detection model snapshot to the latest major version. -Over time, older snapshot formats are deprecated and removed. Anomaly -detection jobs support only snapshots that are from the current or previous -major version. -This API provides a means to upgrade a snapshot to the current major version. -This aids in preparing the cluster for an upgrade to the next major version. -Only one snapshot per anomaly detection job can be upgraded at a time and the -upgraded snapshot cannot be the current snapshot of the anomaly detection -job. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-upgrade-job-snapshot) - -```ts -client.ml.upgradeJobSnapshot({ job_id, snapshot_id }) -``` - -### Arguments [_arguments_ml.upgrade_job_snapshot] - -#### Request (object) [_request_ml.upgrade_job_snapshot] -- **`job_id` (string)**: Identifier for the anomaly detection job. -- **`snapshot_id` (string)**: A numerical character string that uniquely identifies the model snapshot. -- **`wait_for_completion` (Optional, boolean)**: When true, the API won’t respond until the upgrade is complete. -Otherwise, it responds as soon as the upgrade task is assigned to a node. -- **`timeout` (Optional, string \| -1 \| 0)**: Controls the time to wait for the request to complete. - -## client.nodes.clearRepositoriesMeteringArchive [_nodes.clear_repositories_metering_archive] -Clear the archived repositories metering. -Clear the archived repositories metering information in the cluster. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-nodes-clear-repositories-metering-archive) - -```ts -client.nodes.clearRepositoriesMeteringArchive({ node_id, max_archive_version }) -``` - -### Arguments [_arguments_nodes.clear_repositories_metering_archive] - -#### Request (object) [_request_nodes.clear_repositories_metering_archive] -- **`node_id` (string \| string[])**: List of node IDs or names used to limit returned information. -- **`max_archive_version` (number)**: Specifies the maximum `archive_version` to be cleared from the archive. - -## client.nodes.getRepositoriesMeteringInfo [_nodes.get_repositories_metering_info] -Get cluster repositories metering. -Get repositories metering information for a cluster. -This API exposes monotonically non-decreasing counters and it is expected that clients would durably store the information needed to compute aggregations over a period of time. -Additionally, the information exposed by this API is volatile, meaning that it will not be present after node restarts. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-nodes-get-repositories-metering-info) - -```ts -client.nodes.getRepositoriesMeteringInfo({ node_id }) -``` - -### Arguments [_arguments_nodes.get_repositories_metering_info] - -#### Request (object) [_request_nodes.get_repositories_metering_info] -- **`node_id` (string \| string[])**: List of node IDs or names used to limit returned information. - -## client.nodes.hotThreads [_nodes.hot_threads] -Get the hot threads for nodes. -Get a breakdown of the hot threads on each selected node in the cluster. -The output is plain text with a breakdown of the top hot threads for each node. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-nodes-hot-threads) - -```ts -client.nodes.hotThreads({ ... }) -``` - -### Arguments [_arguments_nodes.hot_threads] - -#### Request (object) [_request_nodes.hot_threads] -- **`node_id` (Optional, string \| string[])**: List of node IDs or names used to limit returned information. -- **`ignore_idle_threads` (Optional, boolean)**: If true, known idle threads (e.g. waiting in a socket select, or to get -a task from an empty queue) are filtered out. -- **`interval` (Optional, string \| -1 \| 0)**: The interval to do the second sampling of threads. -- **`snapshots` (Optional, number)**: Number of samples of thread stacktrace. -- **`threads` (Optional, number)**: Specifies the number of hot threads to provide information for. -- **`timeout` (Optional, string \| -1 \| 0)**: Period to wait for a response. If no response is received -before the timeout expires, the request fails and returns an error. -- **`type` (Optional, Enum("cpu" \| "wait" \| "block" \| "gpu" \| "mem"))**: The type to sample. -- **`sort` (Optional, Enum("cpu" \| "wait" \| "block" \| "gpu" \| "mem"))**: The sort order for 'cpu' type (default: total) - -## client.nodes.info [_nodes.info] -Get node information. - -By default, the API returns all attributes and core settings for cluster nodes. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-nodes-info) - -```ts -client.nodes.info({ ... }) -``` - -### Arguments [_arguments_nodes.info] - -#### Request (object) [_request_nodes.info] -- **`node_id` (Optional, string \| string[])**: List of node IDs or names used to limit returned information. -- **`metric` (Optional, string \| string[])**: Limits the information returned to the specific metrics. Supports a list, such as http,ingest. -- **`flat_settings` (Optional, boolean)**: If true, returns settings in flat format. -- **`timeout` (Optional, string \| -1 \| 0)**: Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. - -## client.nodes.reloadSecureSettings [_nodes.reload_secure_settings] -Reload the keystore on nodes in the cluster. - -Secure settings are stored in an on-disk keystore. Certain of these settings are reloadable. -That is, you can change them on disk and reload them without restarting any nodes in the cluster. -When you have updated reloadable secure settings in your keystore, you can use this API to reload those settings on each node. - -When the Elasticsearch keystore is password protected and not simply obfuscated, you must provide the password for the keystore when you reload the secure settings. -Reloading the settings for the whole cluster assumes that the keystores for all nodes are protected with the same password; this method is allowed only when inter-node communications are encrypted. -Alternatively, you can reload the secure settings on each node by locally accessing the API and passing the node-specific Elasticsearch keystore password. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-nodes-reload-secure-settings) - -```ts -client.nodes.reloadSecureSettings({ ... }) -``` - -### Arguments [_arguments_nodes.reload_secure_settings] - -#### Request (object) [_request_nodes.reload_secure_settings] -- **`node_id` (Optional, string \| string[])**: The names of particular nodes in the cluster to target. -- **`secure_settings_password` (Optional, string)**: The password for the Elasticsearch keystore. -- **`timeout` (Optional, string \| -1 \| 0)**: Period to wait for a response. -If no response is received before the timeout expires, the request fails and returns an error. - -## client.nodes.stats [_nodes.stats] -Get node statistics. -Get statistics for nodes in a cluster. -By default, all stats are returned. You can limit the returned information by using metrics. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-nodes-stats) - -```ts -client.nodes.stats({ ... }) -``` - -### Arguments [_arguments_nodes.stats] - -#### Request (object) [_request_nodes.stats] -- **`node_id` (Optional, string \| string[])**: List of node IDs or names used to limit returned information. -- **`metric` (Optional, string \| string[])**: Limit the information returned to the specified metrics -- **`index_metric` (Optional, string \| string[])**: Limit the information returned for indices metric to the specific index metrics. It can be used only if indices (or all) metric is specified. -- **`completion_fields` (Optional, string \| string[])**: List or wildcard expressions of fields to include in fielddata and suggest statistics. -- **`fielddata_fields` (Optional, string \| string[])**: List or wildcard expressions of fields to include in fielddata statistics. -- **`fields` (Optional, string \| string[])**: List or wildcard expressions of fields to include in the statistics. -- **`groups` (Optional, boolean)**: List of search groups to include in the search statistics. -- **`include_segment_file_sizes` (Optional, boolean)**: If true, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested). -- **`level` (Optional, Enum("cluster" \| "indices" \| "shards"))**: Indicates whether statistics are aggregated at the cluster, index, or shard level. -- **`timeout` (Optional, string \| -1 \| 0)**: Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. -- **`types` (Optional, string[])**: A list of document types for the indexing index metric. -- **`include_unloaded_segments` (Optional, boolean)**: If `true`, the response includes information from segments that are not loaded into memory. - -## client.nodes.usage [_nodes.usage] -Get feature usage information. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-nodes-usage) - -```ts -client.nodes.usage({ ... }) -``` - -### Arguments [_arguments_nodes.usage] - -#### Request (object) [_request_nodes.usage] -- **`node_id` (Optional, string \| string[])**: A list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes -- **`metric` (Optional, string \| string[])**: Limits the information returned to the specific metrics. -A list of the following options: `_all`, `rest_actions`. -- **`timeout` (Optional, string \| -1 \| 0)**: Period to wait for a response. -If no response is received before the timeout expires, the request fails and returns an error. - -## client.queryRules.deleteRule [_query_rules.delete_rule] -Delete a query rule. -Delete a query rule within a query ruleset. -This is a destructive action that is only recoverable by re-adding the same rule with the create or update query rule API. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-query-rules-delete-rule) - -```ts -client.queryRules.deleteRule({ ruleset_id, rule_id }) -``` - -### Arguments [_arguments_query_rules.delete_rule] - -#### Request (object) [_request_query_rules.delete_rule] -- **`ruleset_id` (string)**: The unique identifier of the query ruleset containing the rule to delete -- **`rule_id` (string)**: The unique identifier of the query rule within the specified ruleset to delete - -## client.queryRules.deleteRuleset [_query_rules.delete_ruleset] -Delete a query ruleset. -Remove a query ruleset and its associated data. -This is a destructive action that is not recoverable. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-query-rules-delete-ruleset) - -```ts -client.queryRules.deleteRuleset({ ruleset_id }) -``` - -### Arguments [_arguments_query_rules.delete_ruleset] - -#### Request (object) [_request_query_rules.delete_ruleset] -- **`ruleset_id` (string)**: The unique identifier of the query ruleset to delete - -## client.queryRules.getRule [_query_rules.get_rule] -Get a query rule. -Get details about a query rule within a query ruleset. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-query-rules-get-rule) - -```ts -client.queryRules.getRule({ ruleset_id, rule_id }) -``` - -### Arguments [_arguments_query_rules.get_rule] - -#### Request (object) [_request_query_rules.get_rule] -- **`ruleset_id` (string)**: The unique identifier of the query ruleset containing the rule to retrieve -- **`rule_id` (string)**: The unique identifier of the query rule within the specified ruleset to retrieve - -## client.queryRules.getRuleset [_query_rules.get_ruleset] -Get a query ruleset. -Get details about a query ruleset. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-query-rules-get-ruleset) - -```ts -client.queryRules.getRuleset({ ruleset_id }) -``` - -### Arguments [_arguments_query_rules.get_ruleset] - -#### Request (object) [_request_query_rules.get_ruleset] -- **`ruleset_id` (string)**: The unique identifier of the query ruleset - -## client.queryRules.listRulesets [_query_rules.list_rulesets] -Get all query rulesets. -Get summarized information about the query rulesets. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-query-rules-list-rulesets) - -```ts -client.queryRules.listRulesets({ ... }) -``` - -### Arguments [_arguments_query_rules.list_rulesets] - -#### Request (object) [_request_query_rules.list_rulesets] -- **`from` (Optional, number)**: The offset from the first result to fetch. -- **`size` (Optional, number)**: The maximum number of results to retrieve. - -## client.queryRules.putRule [_query_rules.put_rule] -Create or update a query rule. -Create or update a query rule within a query ruleset. - -IMPORTANT: Due to limitations within pinned queries, you can only pin documents using ids or docs, but cannot use both in single rule. -It is advised to use one or the other in query rulesets, to avoid errors. -Additionally, pinned queries have a maximum limit of 100 pinned hits. -If multiple matching rules pin more than 100 documents, only the first 100 documents are pinned in the order they are specified in the ruleset. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-query-rules-put-rule) - -```ts -client.queryRules.putRule({ ruleset_id, rule_id, type, criteria, actions }) -``` - -### Arguments [_arguments_query_rules.put_rule] - -#### Request (object) [_request_query_rules.put_rule] -- **`ruleset_id` (string)**: The unique identifier of the query ruleset containing the rule to be created or updated. -- **`rule_id` (string)**: The unique identifier of the query rule within the specified ruleset to be created or updated. -- **`type` (Enum("pinned" \| "exclude"))**: The type of rule. -- **`criteria` ({ type, metadata, values } \| { type, metadata, values }[])**: The criteria that must be met for the rule to be applied. -If multiple criteria are specified for a rule, all criteria must be met for the rule to be applied. -- **`actions` ({ ids, docs })**: The actions to take when the rule is matched. -The format of this action depends on the rule type. -- **`priority` (Optional, number)** - -## client.queryRules.putRuleset [_query_rules.put_ruleset] -Create or update a query ruleset. -There is a limit of 100 rules per ruleset. -This limit can be increased by using the `xpack.applications.rules.max_rules_per_ruleset` cluster setting. - -IMPORTANT: Due to limitations within pinned queries, you can only select documents using `ids` or `docs`, but cannot use both in single rule. -It is advised to use one or the other in query rulesets, to avoid errors. -Additionally, pinned queries have a maximum limit of 100 pinned hits. -If multiple matching rules pin more than 100 documents, only the first 100 documents are pinned in the order they are specified in the ruleset. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-query-rules-put-ruleset) - -```ts -client.queryRules.putRuleset({ ruleset_id, rules }) -``` - -### Arguments [_arguments_query_rules.put_ruleset] - -#### Request (object) [_request_query_rules.put_ruleset] -- **`ruleset_id` (string)**: The unique identifier of the query ruleset to be created or updated. -- **`rules` ({ rule_id, type, criteria, actions, priority } \| { rule_id, type, criteria, actions, priority }[])** - -## client.queryRules.test [_query_rules.test] -Test a query ruleset. -Evaluate match criteria against a query ruleset to identify the rules that would match that criteria. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-query-rules-test) - -```ts -client.queryRules.test({ ruleset_id, match_criteria }) -``` - -### Arguments [_arguments_query_rules.test] - -#### Request (object) [_request_query_rules.test] -- **`ruleset_id` (string)**: The unique identifier of the query ruleset to be created or updated -- **`match_criteria` (Record)**: The match criteria to apply to rules in the given query ruleset. -Match criteria should match the keys defined in the `criteria.metadata` field of the rule. - -## client.rollup.deleteJob [_rollup.delete_job] -Delete a rollup job. - -A job must be stopped before it can be deleted. -If you attempt to delete a started job, an error occurs. -Similarly, if you attempt to delete a nonexistent job, an exception occurs. - -IMPORTANT: When you delete a job, you remove only the process that is actively monitoring and rolling up data. -The API does not delete any previously rolled up data. -This is by design; a user may wish to roll up a static data set. -Because the data set is static, after it has been fully rolled up there is no need to keep the indexing rollup job around (as there will be no new data). -Thus the job can be deleted, leaving behind the rolled up data for analysis. -If you wish to also remove the rollup data and the rollup index contains the data for only a single job, you can delete the whole rollup index. -If the rollup index stores data from several jobs, you must issue a delete-by-query that targets the rollup job's identifier in the rollup index. For example: - -``` -POST my_rollup_index/_delete_by_query -{ - "query": { - "term": { - "_rollup.id": "the_rollup_job_id" - } - } -} -``` - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-rollup-delete-job) - -```ts -client.rollup.deleteJob({ id }) -``` - -### Arguments [_arguments_rollup.delete_job] - -#### Request (object) [_request_rollup.delete_job] -- **`id` (string)**: Identifier for the job. - -## client.rollup.getJobs [_rollup.get_jobs] -Get rollup job information. -Get the configuration, stats, and status of rollup jobs. - -NOTE: This API returns only active (both `STARTED` and `STOPPED`) jobs. -If a job was created, ran for a while, then was deleted, the API does not return any details about it. -For details about a historical rollup job, the rollup capabilities API may be more useful. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-rollup-get-jobs) - -```ts -client.rollup.getJobs({ ... }) -``` - -### Arguments [_arguments_rollup.get_jobs] - -#### Request (object) [_request_rollup.get_jobs] -- **`id` (Optional, string)**: Identifier for the rollup job. -If it is `_all` or omitted, the API returns all rollup jobs. - -## client.rollup.getRollupCaps [_rollup.get_rollup_caps] -Get the rollup job capabilities. -Get the capabilities of any rollup jobs that have been configured for a specific index or index pattern. - -This API is useful because a rollup job is often configured to rollup only a subset of fields from the source index. -Furthermore, only certain aggregations can be configured for various fields, leading to a limited subset of functionality depending on that configuration. -This API enables you to inspect an index and determine: - -1. Does this index have associated rollup data somewhere in the cluster? -2. If yes to the first question, what fields were rolled up, what aggregations can be performed, and where does the data live? - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-rollup-get-rollup-caps) - -```ts -client.rollup.getRollupCaps({ ... }) -``` - -### Arguments [_arguments_rollup.get_rollup_caps] - -#### Request (object) [_request_rollup.get_rollup_caps] -- **`id` (Optional, string)**: Index, indices or index-pattern to return rollup capabilities for. -`_all` may be used to fetch rollup capabilities from all jobs. - -## client.rollup.getRollupIndexCaps [_rollup.get_rollup_index_caps] -Get the rollup index capabilities. -Get the rollup capabilities of all jobs inside of a rollup index. -A single rollup index may store the data for multiple rollup jobs and may have a variety of capabilities depending on those jobs. This API enables you to determine: - -* What jobs are stored in an index (or indices specified via a pattern)? -* What target indices were rolled up, what fields were used in those rollups, and what aggregations can be performed on each job? - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-rollup-get-rollup-index-caps) - -```ts -client.rollup.getRollupIndexCaps({ index }) -``` - -### Arguments [_arguments_rollup.get_rollup_index_caps] - -#### Request (object) [_request_rollup.get_rollup_index_caps] -- **`index` (string \| string[])**: Data stream or index to check for rollup capabilities. -Wildcard (`*`) expressions are supported. - -## client.rollup.putJob [_rollup.put_job] -Create a rollup job. - -WARNING: From 8.15.0, calling this API in a cluster with no rollup usage will fail with a message about the deprecation and planned removal of rollup features. A cluster needs to contain either a rollup job or a rollup index in order for this API to be allowed to run. - -The rollup job configuration contains all the details about how the job should run, when it indexes documents, and what future queries will be able to run against the rollup index. - -There are three main sections to the job configuration: the logistical details about the job (for example, the cron schedule), the fields that are used for grouping, and what metrics to collect for each group. - -Jobs are created in a `STOPPED` state. You can start them with the start rollup jobs API. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-rollup-put-job) - -```ts -client.rollup.putJob({ id, cron, groups, index_pattern, page_size, rollup_index }) -``` - -### Arguments [_arguments_rollup.put_job] - -#### Request (object) [_request_rollup.put_job] -- **`id` (string)**: Identifier for the rollup job. This can be any alphanumeric string and uniquely identifies the -data that is associated with the rollup job. The ID is persistent; it is stored with the rolled -up data. If you create a job, let it run for a while, then delete the job, the data that the job -rolled up is still be associated with this job ID. You cannot create a new job with the same ID -since that could lead to problems with mismatched job configurations. -- **`cron` (string)**: A cron string which defines the intervals when the rollup job should be executed. When the interval -triggers, the indexer attempts to rollup the data in the index pattern. The cron pattern is unrelated -to the time interval of the data being rolled up. For example, you may wish to create hourly rollups -of your document but to only run the indexer on a daily basis at midnight, as defined by the cron. The -cron pattern is defined just like a Watcher cron schedule. -- **`groups` ({ date_histogram, histogram, terms })**: Defines the grouping fields and aggregations that are defined for this rollup job. These fields will then be -available later for aggregating into buckets. These aggs and fields can be used in any combination. Think of -the groups configuration as defining a set of tools that can later be used in aggregations to partition the -data. Unlike raw data, we have to think ahead to which fields and aggregations might be used. Rollups provide -enough flexibility that you simply need to determine which fields are needed, not in what order they are needed. -- **`index_pattern` (string)**: The index or index pattern to roll up. Supports wildcard-style patterns (`logstash-*`). The job attempts to -rollup the entire index or index-pattern. -- **`page_size` (number)**: The number of bucket results that are processed on each iteration of the rollup indexer. A larger value tends -to execute faster, but requires more memory during processing. This value has no effect on how the data is -rolled up; it is merely used for tweaking the speed or memory cost of the indexer. -- **`rollup_index` (string)**: The index that contains the rollup results. The index can be shared with other rollup jobs. The data is stored so that it doesn’t interfere with unrelated jobs. -- **`metrics` (Optional, { field, metrics }[])**: Defines the metrics to collect for each grouping tuple. By default, only the doc_counts are collected for each -group. To make rollup useful, you will often add metrics like averages, mins, maxes, etc. Metrics are defined -on a per-field basis and for each field you configure which metric should be collected. -- **`timeout` (Optional, string \| -1 \| 0)**: Time to wait for the request to complete. -- **`headers` (Optional, Record)** - -## client.rollup.rollupSearch [_rollup.rollup_search] -Search rolled-up data. -The rollup search endpoint is needed because, internally, rolled-up documents utilize a different document structure than the original data. -It rewrites standard Query DSL into a format that matches the rollup documents then takes the response and rewrites it back to what a client would expect given the original query. - -The request body supports a subset of features from the regular search API. -The following functionality is not available: - -`size`: Because rollups work on pre-aggregated data, no search hits can be returned and so size must be set to zero or omitted entirely. -`highlighter`, `suggestors`, `post_filter`, `profile`, `explain`: These are similarly disallowed. - -**Searching both historical rollup and non-rollup data** - -The rollup search API has the capability to search across both "live" non-rollup data and the aggregated rollup data. -This is done by simply adding the live indices to the URI. For example: - -``` -GET sensor-1,sensor_rollup/_rollup_search -{ - "size": 0, - "aggregations": { - "max_temperature": { - "max": { - "field": "temperature" - } - } - } -} -``` - -The rollup search endpoint does two things when the search runs: - -* The original request is sent to the non-rollup index unaltered. -* A rewritten version of the original request is sent to the rollup index. - -When the two responses are received, the endpoint rewrites the rollup response and merges the two together. -During the merging process, if there is any overlap in buckets between the two responses, the buckets from the non-rollup index are used. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-rollup-rollup-search) - -```ts -client.rollup.rollupSearch({ index }) -``` - -### Arguments [_arguments_rollup.rollup_search] - -#### Request (object) [_request_rollup.rollup_search] -- **`index` (string \| string[])**: A list of data streams and indices used to limit the request. -This parameter has the following rules: - -* At least one data stream, index, or wildcard expression must be specified. This target can include a rollup or non-rollup index. For data streams, the stream's backing indices can only serve as non-rollup indices. Omitting the parameter or using `_all` are not permitted. -* Multiple non-rollup indices may be specified. -* Only one rollup index may be specified. If more than one are supplied, an exception occurs. -* Wildcard expressions (`*`) may be used. If they match more than one rollup index, an exception occurs. However, you can use an expression to match multiple non-rollup indices or data streams. -- **`aggregations` (Optional, Record)**: Specifies aggregations. -- **`query` (Optional, { bool, boosting, common, combined_fields, constant_score, dis_max, distance_feature, exists, function_score, fuzzy, geo_bounding_box, geo_distance, geo_grid, geo_polygon, geo_shape, has_child, has_parent, ids, intervals, knn, match, match_all, match_bool_prefix, match_none, match_phrase, match_phrase_prefix, more_like_this, multi_match, nested, parent_id, percolate, pinned, prefix, query_string, range, rank_feature, regexp, rule, script, script_score, semantic, shape, simple_query_string, span_containing, span_field_masking, span_first, span_multi, span_near, span_not, span_or, span_term, span_within, sparse_vector, term, terms, terms_set, text_expansion, weighted_tokens, wildcard, wrapper, type })**: Specifies a DSL query that is subject to some limitations. -- **`size` (Optional, number)**: Must be zero if set, as rollups work on pre-aggregated data. -- **`rest_total_hits_as_int` (Optional, boolean)**: Indicates whether hits.total should be rendered as an integer or an object in the rest search response -- **`typed_keys` (Optional, boolean)**: Specify whether aggregation and suggester names should be prefixed by their respective types in the response - -## client.rollup.startJob [_rollup.start_job] -Start rollup jobs. -If you try to start a job that does not exist, an exception occurs. -If you try to start a job that is already started, nothing happens. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-rollup-start-job) - -```ts -client.rollup.startJob({ id }) -``` - -### Arguments [_arguments_rollup.start_job] - -#### Request (object) [_request_rollup.start_job] -- **`id` (string)**: Identifier for the rollup job. - -## client.rollup.stopJob [_rollup.stop_job] -Stop rollup jobs. -If you try to stop a job that does not exist, an exception occurs. -If you try to stop a job that is already stopped, nothing happens. - -Since only a stopped job can be deleted, it can be useful to block the API until the indexer has fully stopped. -This is accomplished with the `wait_for_completion` query parameter, and optionally a timeout. For example: - -``` -POST _rollup/job/sensor/_stop?wait_for_completion=true&timeout=10s -``` -The parameter blocks the API call from returning until either the job has moved to STOPPED or the specified time has elapsed. -If the specified time elapses without the job moving to STOPPED, a timeout exception occurs. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-rollup-stop-job) - -```ts -client.rollup.stopJob({ id }) -``` - -### Arguments [_arguments_rollup.stop_job] - -#### Request (object) [_request_rollup.stop_job] -- **`id` (string)**: Identifier for the rollup job. -- **`timeout` (Optional, string \| -1 \| 0)**: If `wait_for_completion` is `true`, the API blocks for (at maximum) the specified duration while waiting for the job to stop. -If more than `timeout` time has passed, the API throws a timeout exception. -NOTE: Even if a timeout occurs, the stop request is still processing and eventually moves the job to STOPPED. -The timeout simply means the API call itself timed out while waiting for the status change. -- **`wait_for_completion` (Optional, boolean)**: If set to `true`, causes the API to block until the indexer state completely stops. -If set to `false`, the API returns immediately and the indexer is stopped asynchronously in the background. - -## client.searchApplication.delete [_search_application.delete] -Delete a search application. - -Remove a search application and its associated alias. Indices attached to the search application are not removed. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-delete) - -```ts -client.searchApplication.delete({ name }) -``` - -### Arguments [_arguments_search_application.delete] - -#### Request (object) [_request_search_application.delete] -- **`name` (string)**: The name of the search application to delete. - -## client.searchApplication.deleteBehavioralAnalytics [_search_application.delete_behavioral_analytics] -Delete a behavioral analytics collection. -The associated data stream is also deleted. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-delete-behavioral-analytics) - -```ts -client.searchApplication.deleteBehavioralAnalytics({ name }) -``` - -### Arguments [_arguments_search_application.delete_behavioral_analytics] - -#### Request (object) [_request_search_application.delete_behavioral_analytics] -- **`name` (string)**: The name of the analytics collection to be deleted - -## client.searchApplication.get [_search_application.get] -Get search application details. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-get) - -```ts -client.searchApplication.get({ name }) -``` - -### Arguments [_arguments_search_application.get] - -#### Request (object) [_request_search_application.get] -- **`name` (string)**: The name of the search application - -## client.searchApplication.getBehavioralAnalytics [_search_application.get_behavioral_analytics] -Get behavioral analytics collections. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-get-behavioral-analytics) - -```ts -client.searchApplication.getBehavioralAnalytics({ ... }) -``` - -### Arguments [_arguments_search_application.get_behavioral_analytics] - -#### Request (object) [_request_search_application.get_behavioral_analytics] -- **`name` (Optional, string[])**: A list of analytics collections to limit the returned information - -## client.searchApplication.list [_search_application.list] -Get search applications. -Get information about search applications. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-get-behavioral-analytics) - -```ts -client.searchApplication.list({ ... }) -``` - -### Arguments [_arguments_search_application.list] - -#### Request (object) [_request_search_application.list] -- **`q` (Optional, string)**: Query in the Lucene query string syntax. -- **`from` (Optional, number)**: Starting offset. -- **`size` (Optional, number)**: Specifies a max number of results to get. - -## client.searchApplication.postBehavioralAnalyticsEvent [_search_application.post_behavioral_analytics_event] -Create a behavioral analytics collection event. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-post-behavioral-analytics-event) - -```ts -client.searchApplication.postBehavioralAnalyticsEvent({ collection_name, event_type }) -``` - -### Arguments [_arguments_search_application.post_behavioral_analytics_event] - -#### Request (object) [_request_search_application.post_behavioral_analytics_event] -- **`collection_name` (string)**: The name of the behavioral analytics collection. -- **`event_type` (Enum("page_view" \| "search" \| "search_click"))**: The analytics event type. -- **`payload` (Optional, User-defined value)** -- **`debug` (Optional, boolean)**: Whether the response type has to include more details - -## client.searchApplication.put [_search_application.put] -Create or update a search application. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-put) - -```ts -client.searchApplication.put({ name }) -``` - -### Arguments [_arguments_search_application.put] - -#### Request (object) [_request_search_application.put] -- **`name` (string)**: The name of the search application to be created or updated. -- **`search_application` (Optional, { indices, analytics_collection_name, template })** -- **`create` (Optional, boolean)**: If `true`, this request cannot replace or update existing Search Applications. - -## client.searchApplication.putBehavioralAnalytics [_search_application.put_behavioral_analytics] -Create a behavioral analytics collection. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-put-behavioral-analytics) - -```ts -client.searchApplication.putBehavioralAnalytics({ name }) -``` - -### Arguments [_arguments_search_application.put_behavioral_analytics] - -#### Request (object) [_request_search_application.put_behavioral_analytics] -- **`name` (string)**: The name of the analytics collection to be created or updated. - -## client.searchApplication.renderQuery [_search_application.render_query] -Render a search application query. -Generate an Elasticsearch query using the specified query parameters and the search template associated with the search application or a default template if none is specified. -If a parameter used in the search template is not specified in `params`, the parameter's default value will be used. -The API returns the specific Elasticsearch query that would be generated and run by calling the search application search API. - -You must have `read` privileges on the backing alias of the search application. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-render-query) - -```ts -client.searchApplication.renderQuery({ name }) -``` - -### Arguments [_arguments_search_application.render_query] - -#### Request (object) [_request_search_application.render_query] -- **`name` (string)**: The name of the search application to render teh query for. -- **`params` (Optional, Record)** - -## client.searchApplication.search [_search_application.search] -Run a search application search. -Generate and run an Elasticsearch query that uses the specified query parameteter and the search template associated with the search application or default template. -Unspecified template parameters are assigned their default values if applicable. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-search) - -```ts -client.searchApplication.search({ name }) -``` - -### Arguments [_arguments_search_application.search] - -#### Request (object) [_request_search_application.search] -- **`name` (string)**: The name of the search application to be searched. -- **`params` (Optional, Record)**: Query parameters specific to this request, which will override any defaults specified in the template. -- **`typed_keys` (Optional, boolean)**: Determines whether aggregation names are prefixed by their respective types in the response. - -## client.searchableSnapshots.cacheStats [_searchable_snapshots.cache_stats] -Get cache statistics. -Get statistics about the shared cache for partially mounted indices. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-searchable-snapshots-cache-stats) - -```ts -client.searchableSnapshots.cacheStats({ ... }) -``` - -### Arguments [_arguments_searchable_snapshots.cache_stats] - -#### Request (object) [_request_searchable_snapshots.cache_stats] -- **`node_id` (Optional, string \| string[])**: The names of the nodes in the cluster to target. -- **`master_timeout` (Optional, string \| -1 \| 0)** - -## client.searchableSnapshots.clearCache [_searchable_snapshots.clear_cache] -Clear the cache. -Clear indices and data streams from the shared cache for partially mounted indices. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-searchable-snapshots-clear-cache) - -```ts -client.searchableSnapshots.clearCache({ ... }) -``` - -### Arguments [_arguments_searchable_snapshots.clear_cache] - -#### Request (object) [_request_searchable_snapshots.clear_cache] -- **`index` (Optional, string \| string[])**: A list of data streams, indices, and aliases to clear from the cache. -It supports wildcards (`*`). -- **`expand_wildcards` (Optional, Enum("all" \| "open" \| "closed" \| "hidden" \| "none") \| Enum("all" \| "open" \| "closed" \| "hidden" \| "none")[])**: Whether to expand wildcard expression to concrete indices that are open, closed or both. -- **`allow_no_indices` (Optional, boolean)**: Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) -- **`ignore_unavailable` (Optional, boolean)**: Whether specified concrete indices should be ignored when unavailable (missing or closed) - -## client.searchableSnapshots.mount [_searchable_snapshots.mount] -Mount a snapshot. -Mount a snapshot as a searchable snapshot index. -Do not use this API for snapshots managed by index lifecycle management (ILM). -Manually mounting ILM-managed snapshots can interfere with ILM processes. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-searchable-snapshots-mount) - -```ts -client.searchableSnapshots.mount({ repository, snapshot, index }) -``` - -### Arguments [_arguments_searchable_snapshots.mount] - -#### Request (object) [_request_searchable_snapshots.mount] -- **`repository` (string)**: The name of the repository containing the snapshot of the index to mount. -- **`snapshot` (string)**: The name of the snapshot of the index to mount. -- **`index` (string)**: The name of the index contained in the snapshot whose data is to be mounted. -If no `renamed_index` is specified, this name will also be used to create the new index. -- **`renamed_index` (Optional, string)**: The name of the index that will be created. -- **`index_settings` (Optional, Record)**: The settings that should be added to the index when it is mounted. -- **`ignore_index_settings` (Optional, string[])**: The names of settings that should be removed from the index when it is mounted. -- **`master_timeout` (Optional, string \| -1 \| 0)**: The period to wait for the master node. -If the master node is not available before the timeout expires, the request fails and returns an error. -To indicate that the request should never timeout, set it to `-1`. -- **`wait_for_completion` (Optional, boolean)**: If true, the request blocks until the operation is complete. -- **`storage` (Optional, string)**: The mount option for the searchable snapshot index. - -## client.searchableSnapshots.stats [_searchable_snapshots.stats] -Get searchable snapshot statistics. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-searchable-snapshots-stats) - -```ts -client.searchableSnapshots.stats({ ... }) -``` - -### Arguments [_arguments_searchable_snapshots.stats] - -#### Request (object) [_request_searchable_snapshots.stats] -- **`index` (Optional, string \| string[])**: A list of data streams and indices to retrieve statistics for. -- **`level` (Optional, Enum("cluster" \| "indices" \| "shards"))**: Return stats aggregated at cluster, index or shard level - -## client.security.activateUserProfile [_security.activate_user_profile] -Activate a user profile. - -Create or update a user profile on behalf of another user. - -NOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions. -Individual users and external applications should not call this API directly. -The calling application must have either an `access_token` or a combination of `username` and `password` for the user that the profile document is intended for. -Elastic reserves the right to change or remove this feature in future releases without prior notice. - -This API creates or updates a profile document for end users with information that is extracted from the user's authentication object including `username`, `full_name,` `roles`, and the authentication realm. -For example, in the JWT `access_token` case, the profile user's `username` is extracted from the JWT token claim pointed to by the `claims.principal` setting of the JWT realm that authenticated the token. - -When updating a profile document, the API enables the document if it was disabled. -Any updates do not change existing content for either the `labels` or `data` fields. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-activate-user-profile) - -```ts -client.security.activateUserProfile({ grant_type }) -``` - -### Arguments [_arguments_security.activate_user_profile] - -#### Request (object) [_request_security.activate_user_profile] -- **`grant_type` (Enum("password" \| "access_token"))**: The type of grant. -- **`access_token` (Optional, string)**: The user's Elasticsearch access token or JWT. -Both `access` and `id` JWT token types are supported and they depend on the underlying JWT realm configuration. -If you specify the `access_token` grant type, this parameter is required. -It is not valid with other grant types. -- **`password` (Optional, string)**: The user's password. -If you specify the `password` grant type, this parameter is required. -It is not valid with other grant types. -- **`username` (Optional, string)**: The username that identifies the user. -If you specify the `password` grant type, this parameter is required. -It is not valid with other grant types. - -## client.security.authenticate [_security.authenticate] -Authenticate a user. - -Authenticates a user and returns information about the authenticated user. -Include the user information in a [basic auth header](https://en.wikipedia.org/wiki/Basic_access_authentication). -A successful call returns a JSON structure that shows user information such as their username, the roles that are assigned to the user, any assigned metadata, and information about the realms that authenticated and authorized the user. -If the user cannot be authenticated, this API returns a 401 status code. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-authenticate) - -```ts -client.security.authenticate() -``` - - -## client.security.bulkDeleteRole [_security.bulk_delete_role] -Bulk delete roles. - -The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. -The bulk delete roles API cannot delete roles that are defined in roles files. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-bulk-delete-role) - -```ts -client.security.bulkDeleteRole({ names }) -``` - -### Arguments [_arguments_security.bulk_delete_role] - -#### Request (object) [_request_security.bulk_delete_role] -- **`names` (string[])**: An array of role names to delete -- **`refresh` (Optional, Enum(true \| false \| "wait_for"))**: If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. - -## client.security.bulkPutRole [_security.bulk_put_role] -Bulk create or update roles. - -The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. -The bulk create or update roles API cannot update roles that are defined in roles files. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-bulk-put-role) - -```ts -client.security.bulkPutRole({ roles }) -``` - -### Arguments [_arguments_security.bulk_put_role] - -#### Request (object) [_request_security.bulk_put_role] -- **`roles` (Record)**: A dictionary of role name to RoleDescriptor objects to add or update -- **`refresh` (Optional, Enum(true \| false \| "wait_for"))**: If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. - -## client.security.bulkUpdateApiKeys [_security.bulk_update_api_keys] -Bulk update API keys. -Update the attributes for multiple API keys. - -IMPORTANT: It is not possible to use an API key as the authentication credential for this API. To update API keys, the owner user's credentials are required. - -This API is similar to the update API key API but enables you to apply the same update to multiple API keys in one API call. This operation can greatly improve performance over making individual updates. - -It is not possible to update expired or invalidated API keys. - -This API supports updates to API key access scope, metadata and expiration. -The access scope of each API key is derived from the `role_descriptors` you specify in the request and a snapshot of the owner user's permissions at the time of the request. -The snapshot of the owner's permissions is updated automatically on every call. - -IMPORTANT: If you don't specify `role_descriptors` in the request, a call to this API might still change an API key's access scope. This change can occur if the owner user's permissions have changed since the API key was created or last modified. - -A successful request returns a JSON structure that contains the IDs of all updated API keys, the IDs of API keys that already had the requested changes and did not require an update, and error details for any failed update. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-bulk-update-api-keys) - -```ts -client.security.bulkUpdateApiKeys({ ids }) -``` - -### Arguments [_arguments_security.bulk_update_api_keys] - -#### Request (object) [_request_security.bulk_update_api_keys] -- **`ids` (string \| string[])**: The API key identifiers. -- **`expiration` (Optional, string \| -1 \| 0)**: Expiration time for the API keys. -By default, API keys never expire. -This property can be omitted to leave the value unchanged. -- **`metadata` (Optional, Record)**: Arbitrary nested metadata to associate with the API keys. -Within the `metadata` object, top-level keys beginning with an underscore (`_`) are reserved for system usage. -Any information specified with this parameter fully replaces metadata previously associated with the API key. -- **`role_descriptors` (Optional, Record)**: The role descriptors to assign to the API keys. -An API key's effective permissions are an intersection of its assigned privileges and the point-in-time snapshot of permissions of the owner user. -You can assign new privileges by specifying them in this parameter. -To remove assigned privileges, supply the `role_descriptors` parameter as an empty object `{}`. -If an API key has no assigned privileges, it inherits the owner user's full permissions. -The snapshot of the owner's permissions is always updated, whether you supply the `role_descriptors` parameter. -The structure of a role descriptor is the same as the request for the create API keys API. - -## client.security.changePassword [_security.change_password] -Change passwords. - -Change the passwords of users in the native realm and built-in users. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-change-password) - -```ts -client.security.changePassword({ ... }) -``` - -### Arguments [_arguments_security.change_password] - -#### Request (object) [_request_security.change_password] -- **`username` (Optional, string)**: The user whose password you want to change. If you do not specify this -parameter, the password is changed for the current user. -- **`password` (Optional, string)**: The new password value. Passwords must be at least 6 characters long. -- **`password_hash` (Optional, string)**: A hash of the new password value. This must be produced using the same -hashing algorithm as has been configured for password storage. For more details, -see the explanation of the `xpack.security.authc.password_hashing.algorithm` -setting. -- **`refresh` (Optional, Enum(true \| false \| "wait_for"))**: If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. - -## client.security.clearApiKeyCache [_security.clear_api_key_cache] -Clear the API key cache. - -Evict a subset of all entries from the API key cache. -The cache is also automatically cleared on state changes of the security index. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-clear-api-key-cache) - -```ts -client.security.clearApiKeyCache({ ids }) -``` - -### Arguments [_arguments_security.clear_api_key_cache] - -#### Request (object) [_request_security.clear_api_key_cache] -- **`ids` (string \| string[])**: List of API key IDs to evict from the API key cache. -To evict all API keys, use `*`. -Does not support other wildcard patterns. - -## client.security.clearCachedPrivileges [_security.clear_cached_privileges] -Clear the privileges cache. - -Evict privileges from the native application privilege cache. -The cache is also automatically cleared for applications that have their privileges updated. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-clear-cached-privileges) - -```ts -client.security.clearCachedPrivileges({ application }) -``` - -### Arguments [_arguments_security.clear_cached_privileges] - -#### Request (object) [_request_security.clear_cached_privileges] -- **`application` (string)**: A list of applications. -To clear all applications, use an asterism (`*`). -It does not support other wildcard patterns. - -## client.security.clearCachedRealms [_security.clear_cached_realms] -Clear the user cache. - -Evict users from the user cache. -You can completely clear the cache or evict specific users. - -User credentials are cached in memory on each node to avoid connecting to a remote authentication service or hitting the disk for every incoming request. -There are realm settings that you can use to configure the user cache. -For more information, refer to the documentation about controlling the user cache. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-clear-cached-realms) - -```ts -client.security.clearCachedRealms({ realms }) -``` - -### Arguments [_arguments_security.clear_cached_realms] - -#### Request (object) [_request_security.clear_cached_realms] -- **`realms` (string \| string[])**: A list of realms. -To clear all realms, use an asterisk (`*`). -It does not support other wildcard patterns. -- **`usernames` (Optional, string[])**: A list of the users to clear from the cache. -If you do not specify this parameter, the API evicts all users from the user cache. - -## client.security.clearCachedRoles [_security.clear_cached_roles] -Clear the roles cache. - -Evict roles from the native role cache. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-clear-cached-roles) - -```ts -client.security.clearCachedRoles({ name }) -``` - -### Arguments [_arguments_security.clear_cached_roles] - -#### Request (object) [_request_security.clear_cached_roles] -- **`name` (string \| string[])**: A list of roles to evict from the role cache. -To evict all roles, use an asterisk (`*`). -It does not support other wildcard patterns. - -## client.security.clearCachedServiceTokens [_security.clear_cached_service_tokens] -Clear service account token caches. - -Evict a subset of all entries from the service account token caches. -Two separate caches exist for service account tokens: one cache for tokens backed by the `service_tokens` file, and another for tokens backed by the `.security` index. -This API clears matching entries from both caches. - -The cache for service account tokens backed by the `.security` index is cleared automatically on state changes of the security index. -The cache for tokens backed by the `service_tokens` file is cleared automatically on file changes. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-clear-cached-service-tokens) - -```ts -client.security.clearCachedServiceTokens({ namespace, service, name }) -``` - -### Arguments [_arguments_security.clear_cached_service_tokens] - -#### Request (object) [_request_security.clear_cached_service_tokens] -- **`namespace` (string)**: The namespace, which is a top-level grouping of service accounts. -- **`service` (string)**: The name of the service, which must be unique within its namespace. -- **`name` (string \| string[])**: A list of token names to evict from the service account token caches. -Use a wildcard (`*`) to evict all tokens that belong to a service account. -It does not support other wildcard patterns. - -## client.security.createApiKey [_security.create_api_key] -Create an API key. - -Create an API key for access without requiring basic authentication. - -IMPORTANT: If the credential that is used to authenticate this request is an API key, the derived API key cannot have any privileges. -If you specify privileges, the API returns an error. - -A successful request returns a JSON structure that contains the API key, its unique id, and its name. -If applicable, it also returns expiration information for the API key in milliseconds. - -NOTE: By default, API keys never expire. You can specify expiration information when you create the API keys. - -The API keys are created by the Elasticsearch API key service, which is automatically enabled. -To configure or turn off the API key service, refer to API key service setting documentation. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-create-api-key) - -```ts -client.security.createApiKey({ ... }) -``` - -### Arguments [_arguments_security.create_api_key] - -#### Request (object) [_request_security.create_api_key] -- **`expiration` (Optional, string \| -1 \| 0)**: The expiration time for the API key. -By default, API keys never expire. -- **`name` (Optional, string)**: A name for the API key. -- **`role_descriptors` (Optional, Record)**: An array of role descriptors for this API key. -When it is not specified or it is an empty array, the API key will have a point in time snapshot of permissions of the authenticated user. -If you supply role descriptors, the resultant permissions are an intersection of API keys permissions and the authenticated user's permissions thereby limiting the access scope for API keys. -The structure of role descriptor is the same as the request for the create role API. -For more details, refer to the create or update roles API. - -NOTE: Due to the way in which this permission intersection is calculated, it is not possible to create an API key that is a child of another API key, unless the derived key is created without any privileges. -In this case, you must explicitly specify a role descriptor with no privileges. -The derived API key can be used for authentication; it will not have authority to call Elasticsearch APIs. -- **`metadata` (Optional, Record)**: Arbitrary metadata that you want to associate with the API key. It supports nested data structure. Within the metadata object, keys beginning with `_` are reserved for system usage. -- **`refresh` (Optional, Enum(true \| false \| "wait_for"))**: If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. - -## client.security.createCrossClusterApiKey [_security.create_cross_cluster_api_key] -Create a cross-cluster API key. - -Create an API key of the `cross_cluster` type for the API key based remote cluster access. -A `cross_cluster` API key cannot be used to authenticate through the REST interface. - -IMPORTANT: To authenticate this request you must use a credential that is not an API key. Even if you use an API key that has the required privilege, the API returns an error. - -Cross-cluster API keys are created by the Elasticsearch API key service, which is automatically enabled. - -NOTE: Unlike REST API keys, a cross-cluster API key does not capture permissions of the authenticated user. The API key’s effective permission is exactly as specified with the `access` property. - -A successful request returns a JSON structure that contains the API key, its unique ID, and its name. If applicable, it also returns expiration information for the API key in milliseconds. - -By default, API keys never expire. You can specify expiration information when you create the API keys. - -Cross-cluster API keys can only be updated with the update cross-cluster API key API. -Attempting to update them with the update REST API key API or the bulk update REST API keys API will result in an error. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-create-cross-cluster-api-key) - -```ts -client.security.createCrossClusterApiKey({ access, name }) -``` - -### Arguments [_arguments_security.create_cross_cluster_api_key] - -#### Request (object) [_request_security.create_cross_cluster_api_key] -- **`access` ({ replication, search })**: The access to be granted to this API key. -The access is composed of permissions for cross-cluster search and cross-cluster replication. -At least one of them must be specified. - -NOTE: No explicit privileges should be specified for either search or replication access. -The creation process automatically converts the access specification to a role descriptor which has relevant privileges assigned accordingly. -- **`name` (string)**: Specifies the name for this API key. -- **`expiration` (Optional, string \| -1 \| 0)**: Expiration time for the API key. -By default, API keys never expire. -- **`metadata` (Optional, Record)**: Arbitrary metadata that you want to associate with the API key. -It supports nested data structure. -Within the metadata object, keys beginning with `_` are reserved for system usage. - -## client.security.createServiceToken [_security.create_service_token] -Create a service account token. - -Create a service accounts token for access without requiring basic authentication. - -NOTE: Service account tokens never expire. -You must actively delete them if they are no longer needed. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-create-service-token) - -```ts -client.security.createServiceToken({ namespace, service }) -``` - -### Arguments [_arguments_security.create_service_token] - -#### Request (object) [_request_security.create_service_token] -- **`namespace` (string)**: The name of the namespace, which is a top-level grouping of service accounts. -- **`service` (string)**: The name of the service. -- **`name` (Optional, string)**: The name for the service account token. -If omitted, a random name will be generated. - -Token names must be at least one and no more than 256 characters. -They can contain alphanumeric characters (a-z, A-Z, 0-9), dashes (`-`), and underscores (`_`), but cannot begin with an underscore. - -NOTE: Token names must be unique in the context of the associated service account. -They must also be globally unique with their fully qualified names, which are comprised of the service account principal and token name, such as `//`. -- **`refresh` (Optional, Enum(true \| false \| "wait_for"))**: If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` (the default) then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. - -## client.security.delegatePki [_security.delegate_pki] -Delegate PKI authentication. - -This API implements the exchange of an X509Certificate chain for an Elasticsearch access token. -The certificate chain is validated, according to RFC 5280, by sequentially considering the trust configuration of every installed PKI realm that has `delegation.enabled` set to `true`. -A successfully trusted client certificate is also subject to the validation of the subject distinguished name according to thw `username_pattern` of the respective realm. - -This API is called by smart and trusted proxies, such as Kibana, which terminate the user's TLS session but still want to authenticate the user by using a PKI realm—-​as if the user connected directly to Elasticsearch. - -IMPORTANT: The association between the subject public key in the target certificate and the corresponding private key is not validated. -This is part of the TLS authentication process and it is delegated to the proxy that calls this API. -The proxy is trusted to have performed the TLS authentication and this API translates that authentication into an Elasticsearch access token. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-delegate-pki) - -```ts -client.security.delegatePki({ x509_certificate_chain }) -``` - -### Arguments [_arguments_security.delegate_pki] - -#### Request (object) [_request_security.delegate_pki] -- **`x509_certificate_chain` (string[])**: The X509Certificate chain, which is represented as an ordered string array. -Each string in the array is a base64-encoded (Section 4 of RFC4648 - not base64url-encoded) of the certificate's DER encoding. - -The first element is the target certificate that contains the subject distinguished name that is requesting access. -This may be followed by additional certificates; each subsequent certificate is used to certify the previous one. - -## client.security.deletePrivileges [_security.delete_privileges] -Delete application privileges. - -To use this API, you must have one of the following privileges: - -* The `manage_security` cluster privilege (or a greater privilege such as `all`). -* The "Manage Application Privileges" global privilege for the application being referenced in the request. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-delete-privileges) - -```ts -client.security.deletePrivileges({ application, name }) -``` - -### Arguments [_arguments_security.delete_privileges] - -#### Request (object) [_request_security.delete_privileges] -- **`application` (string)**: The name of the application. -Application privileges are always associated with exactly one application. -- **`name` (string \| string[])**: The name of the privilege. -- **`refresh` (Optional, Enum(true \| false \| "wait_for"))**: If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. - -## client.security.deleteRole [_security.delete_role] -Delete roles. - -Delete roles in the native realm. -The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. -The delete roles API cannot remove roles that are defined in roles files. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-delete-role) - -```ts -client.security.deleteRole({ name }) -``` - -### Arguments [_arguments_security.delete_role] - -#### Request (object) [_request_security.delete_role] -- **`name` (string)**: The name of the role. -- **`refresh` (Optional, Enum(true \| false \| "wait_for"))**: If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. - -## client.security.deleteRoleMapping [_security.delete_role_mapping] -Delete role mappings. - -Role mappings define which roles are assigned to each user. -The role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files. -The delete role mappings API cannot remove role mappings that are defined in role mapping files. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-delete-role-mapping) - -```ts -client.security.deleteRoleMapping({ name }) -``` - -### Arguments [_arguments_security.delete_role_mapping] - -#### Request (object) [_request_security.delete_role_mapping] -- **`name` (string)**: The distinct name that identifies the role mapping. -The name is used solely as an identifier to facilitate interaction via the API; it does not affect the behavior of the mapping in any way. -- **`refresh` (Optional, Enum(true \| false \| "wait_for"))**: If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. - -## client.security.deleteServiceToken [_security.delete_service_token] -Delete service account tokens. - -Delete service account tokens for a service in a specified namespace. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-delete-service-token) - -```ts -client.security.deleteServiceToken({ namespace, service, name }) -``` - -### Arguments [_arguments_security.delete_service_token] - -#### Request (object) [_request_security.delete_service_token] -- **`namespace` (string)**: The namespace, which is a top-level grouping of service accounts. -- **`service` (string)**: The service name. -- **`name` (string)**: The name of the service account token. -- **`refresh` (Optional, Enum(true \| false \| "wait_for"))**: If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` (the default) then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. - -## client.security.deleteUser [_security.delete_user] -Delete users. - -Delete users from the native realm. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-delete-user) - -```ts -client.security.deleteUser({ username }) -``` - -### Arguments [_arguments_security.delete_user] - -#### Request (object) [_request_security.delete_user] -- **`username` (string)**: An identifier for the user. -- **`refresh` (Optional, Enum(true \| false \| "wait_for"))**: If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. - -## client.security.disableUser [_security.disable_user] -Disable users. - -Disable users in the native realm. -By default, when you create users, they are enabled. -You can use this API to revoke a user's access to Elasticsearch. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-disable-user) - -```ts -client.security.disableUser({ username }) -``` - -### Arguments [_arguments_security.disable_user] - -#### Request (object) [_request_security.disable_user] -- **`username` (string)**: An identifier for the user. -- **`refresh` (Optional, Enum(true \| false \| "wait_for"))**: If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. - -## client.security.disableUserProfile [_security.disable_user_profile] -Disable a user profile. - -Disable user profiles so that they are not visible in user profile searches. - -NOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions. -Individual users and external applications should not call this API directly. -Elastic reserves the right to change or remove this feature in future releases without prior notice. - -When you activate a user profile, its automatically enabled and visible in user profile searches. You can use the disable user profile API to disable a user profile so it’s not visible in these searches. -To re-enable a disabled user profile, use the enable user profile API . - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-disable-user-profile) - -```ts -client.security.disableUserProfile({ uid }) -``` - -### Arguments [_arguments_security.disable_user_profile] - -#### Request (object) [_request_security.disable_user_profile] -- **`uid` (string)**: Unique identifier for the user profile. -- **`refresh` (Optional, Enum(true \| false \| "wait_for"))**: If 'true', Elasticsearch refreshes the affected shards to make this operation visible to search. -If 'wait_for', it waits for a refresh to make this operation visible to search. -If 'false', it does nothing with refreshes. - -## client.security.enableUser [_security.enable_user] -Enable users. - -Enable users in the native realm. -By default, when you create users, they are enabled. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-enable-user) - -```ts -client.security.enableUser({ username }) -``` - -### Arguments [_arguments_security.enable_user] - -#### Request (object) [_request_security.enable_user] -- **`username` (string)**: An identifier for the user. -- **`refresh` (Optional, Enum(true \| false \| "wait_for"))**: If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. - -## client.security.enableUserProfile [_security.enable_user_profile] -Enable a user profile. - -Enable user profiles to make them visible in user profile searches. - -NOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions. -Individual users and external applications should not call this API directly. -Elastic reserves the right to change or remove this feature in future releases without prior notice. - -When you activate a user profile, it's automatically enabled and visible in user profile searches. -If you later disable the user profile, you can use the enable user profile API to make the profile visible in these searches again. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-enable-user-profile) - -```ts -client.security.enableUserProfile({ uid }) -``` - -### Arguments [_arguments_security.enable_user_profile] - -#### Request (object) [_request_security.enable_user_profile] -- **`uid` (string)**: A unique identifier for the user profile. -- **`refresh` (Optional, Enum(true \| false \| "wait_for"))**: If 'true', Elasticsearch refreshes the affected shards to make this operation -visible to search. -If 'wait_for', it waits for a refresh to make this operation visible to search. -If 'false', nothing is done with refreshes. - -## client.security.enrollKibana [_security.enroll_kibana] -Enroll Kibana. - -Enable a Kibana instance to configure itself for communication with a secured Elasticsearch cluster. - -NOTE: This API is currently intended for internal use only by Kibana. -Kibana uses this API internally to configure itself for communications with an Elasticsearch cluster that already has security features enabled. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-enroll-kibana) - -```ts -client.security.enrollKibana() -``` - - -## client.security.enrollNode [_security.enroll_node] -Enroll a node. - -Enroll a new node to allow it to join an existing cluster with security features enabled. - -The response contains all the necessary information for the joining node to bootstrap discovery and security related settings so that it can successfully join the cluster. -The response contains key and certificate material that allows the caller to generate valid signed certificates for the HTTP layer of all nodes in the cluster. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-enroll-node) - -```ts -client.security.enrollNode() -``` - - -## client.security.getApiKey [_security.get_api_key] -Get API key information. - -Retrieves information for one or more API keys. -NOTE: If you have only the `manage_own_api_key` privilege, this API returns only the API keys that you own. -If you have `read_security`, `manage_api_key` or greater privileges (including `manage_security`), this API returns all API keys regardless of ownership. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-get-api-key) - -```ts -client.security.getApiKey({ ... }) -``` - -### Arguments [_arguments_security.get_api_key] - -#### Request (object) [_request_security.get_api_key] -- **`id` (Optional, string)**: An API key id. -This parameter cannot be used with any of `name`, `realm_name` or `username`. -- **`name` (Optional, string)**: An API key name. -This parameter cannot be used with any of `id`, `realm_name` or `username`. -It supports prefix search with wildcard. -- **`owner` (Optional, boolean)**: A boolean flag that can be used to query API keys owned by the currently authenticated user. -The `realm_name` or `username` parameters cannot be specified when this parameter is set to `true` as they are assumed to be the currently authenticated ones. -- **`realm_name` (Optional, string)**: The name of an authentication realm. -This parameter cannot be used with either `id` or `name` or when `owner` flag is set to `true`. -- **`username` (Optional, string)**: The username of a user. -This parameter cannot be used with either `id` or `name` or when `owner` flag is set to `true`. -- **`with_limited_by` (Optional, boolean)**: Return the snapshot of the owner user's role descriptors -associated with the API key. An API key's actual -permission is the intersection of its assigned role -descriptors and the owner user's role descriptors. -- **`active_only` (Optional, boolean)**: A boolean flag that can be used to query API keys that are currently active. An API key is considered active if it is neither invalidated, nor expired at query time. You can specify this together with other parameters such as `owner` or `name`. If `active_only` is false, the response will include both active and inactive (expired or invalidated) keys. -- **`with_profile_uid` (Optional, boolean)**: Determines whether to also retrieve the profile uid, for the API key owner principal, if it exists. - -## client.security.getBuiltinPrivileges [_security.get_builtin_privileges] -Get builtin privileges. - -Get the list of cluster privileges and index privileges that are available in this version of Elasticsearch. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-get-builtin-privileges) - -```ts -client.security.getBuiltinPrivileges() -``` - - -## client.security.getPrivileges [_security.get_privileges] -Get application privileges. - -To use this API, you must have one of the following privileges: - -* The `read_security` cluster privilege (or a greater privilege such as `manage_security` or `all`). -* The "Manage Application Privileges" global privilege for the application being referenced in the request. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-get-privileges) - -```ts -client.security.getPrivileges({ ... }) -``` - -### Arguments [_arguments_security.get_privileges] - -#### Request (object) [_request_security.get_privileges] -- **`application` (Optional, string)**: The name of the application. -Application privileges are always associated with exactly one application. -If you do not specify this parameter, the API returns information about all privileges for all applications. -- **`name` (Optional, string \| string[])**: The name of the privilege. -If you do not specify this parameter, the API returns information about all privileges for the requested application. - -## client.security.getRole [_security.get_role] -Get roles. - -Get roles in the native realm. -The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. -The get roles API cannot retrieve roles that are defined in roles files. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-get-role) - -```ts -client.security.getRole({ ... }) -``` - -### Arguments [_arguments_security.get_role] - -#### Request (object) [_request_security.get_role] -- **`name` (Optional, string \| string[])**: The name of the role. -You can specify multiple roles as a list. -If you do not specify this parameter, the API returns information about all roles. - -## client.security.getRoleMapping [_security.get_role_mapping] -Get role mappings. - -Role mappings define which roles are assigned to each user. -The role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files. -The get role mappings API cannot retrieve role mappings that are defined in role mapping files. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-get-role-mapping) - -```ts -client.security.getRoleMapping({ ... }) -``` - -### Arguments [_arguments_security.get_role_mapping] - -#### Request (object) [_request_security.get_role_mapping] -- **`name` (Optional, string \| string[])**: The distinct name that identifies the role mapping. The name is used solely as an identifier to facilitate interaction via the API; it does not affect the behavior of the mapping in any way. You can specify multiple mapping names as a list. If you do not specify this parameter, the API returns information about all role mappings. - -## client.security.getServiceAccounts [_security.get_service_accounts] -Get service accounts. - -Get a list of service accounts that match the provided path parameters. - -NOTE: Currently, only the `elastic/fleet-server` service account is available. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-get-service-accounts) - -```ts -client.security.getServiceAccounts({ ... }) -``` - -### Arguments [_arguments_security.get_service_accounts] - -#### Request (object) [_request_security.get_service_accounts] -- **`namespace` (Optional, string)**: The name of the namespace. -Omit this parameter to retrieve information about all service accounts. -If you omit this parameter, you must also omit the `service` parameter. -- **`service` (Optional, string)**: The service name. -Omit this parameter to retrieve information about all service accounts that belong to the specified `namespace`. - -## client.security.getServiceCredentials [_security.get_service_credentials] -Get service account credentials. - -To use this API, you must have at least the `read_security` cluster privilege (or a greater privilege such as `manage_service_account` or `manage_security`). - -The response includes service account tokens that were created with the create service account tokens API as well as file-backed tokens from all nodes of the cluster. - -NOTE: For tokens backed by the `service_tokens` file, the API collects them from all nodes of the cluster. -Tokens with the same name from different nodes are assumed to be the same token and are only counted once towards the total number of service tokens. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-get-service-credentials) - -```ts -client.security.getServiceCredentials({ namespace, service }) -``` - -### Arguments [_arguments_security.get_service_credentials] - -#### Request (object) [_request_security.get_service_credentials] -- **`namespace` (string)**: The name of the namespace. -- **`service` (string)**: The service name. - -## client.security.getSettings [_security.get_settings] -Get security index settings. - -Get the user-configurable settings for the security internal index (`.security` and associated indices). -Only a subset of the index settings — those that are user-configurable—will be shown. -This includes: - -* `index.auto_expand_replicas` -* `index.number_of_replicas` - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-get-settings) - -```ts -client.security.getSettings({ ... }) -``` - -### Arguments [_arguments_security.get_settings] - -#### Request (object) [_request_security.get_settings] -- **`master_timeout` (Optional, string \| -1 \| 0)**: Period to wait for a connection to the master node. -If no response is received before the timeout expires, the request fails and returns an error. - -## client.security.getToken [_security.get_token] -Get a token. - -Create a bearer token for access without requiring basic authentication. -The tokens are created by the Elasticsearch Token Service, which is automatically enabled when you configure TLS on the HTTP interface. -Alternatively, you can explicitly enable the `xpack.security.authc.token.enabled` setting. -When you are running in production mode, a bootstrap check prevents you from enabling the token service unless you also enable TLS on the HTTP interface. - -The get token API takes the same parameters as a typical OAuth 2.0 token API except for the use of a JSON request body. - -A successful get token API call returns a JSON structure that contains the access token, the amount of time (seconds) that the token expires in, the type, and the scope if available. - -The tokens returned by the get token API have a finite period of time for which they are valid and after that time period, they can no longer be used. -That time period is defined by the `xpack.security.authc.token.timeout` setting. -If you want to invalidate a token immediately, you can do so by using the invalidate token API. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-get-token) - -```ts -client.security.getToken({ ... }) -``` - -### Arguments [_arguments_security.get_token] - -#### Request (object) [_request_security.get_token] -- **`grant_type` (Optional, Enum("password" \| "client_credentials" \| "_kerberos" \| "refresh_token"))**: The type of grant. -Supported grant types are: `password`, `_kerberos`, `client_credentials`, and `refresh_token`. -- **`scope` (Optional, string)**: The scope of the token. -Currently tokens are only issued for a scope of FULL regardless of the value sent with the request. -- **`password` (Optional, string)**: The user's password. -If you specify the `password` grant type, this parameter is required. -This parameter is not valid with any other supported grant type. -- **`kerberos_ticket` (Optional, string)**: The base64 encoded kerberos ticket. -If you specify the `_kerberos` grant type, this parameter is required. -This parameter is not valid with any other supported grant type. -- **`refresh_token` (Optional, string)**: The string that was returned when you created the token, which enables you to extend its life. -If you specify the `refresh_token` grant type, this parameter is required. -This parameter is not valid with any other supported grant type. -- **`username` (Optional, string)**: The username that identifies the user. -If you specify the `password` grant type, this parameter is required. -This parameter is not valid with any other supported grant type. - -## client.security.getUser [_security.get_user] -Get users. - -Get information about users in the native realm and built-in users. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-get-user) - -```ts -client.security.getUser({ ... }) -``` - -### Arguments [_arguments_security.get_user] - -#### Request (object) [_request_security.get_user] -- **`username` (Optional, string \| string[])**: An identifier for the user. You can specify multiple usernames as a list. If you omit this parameter, the API retrieves information about all users. -- **`with_profile_uid` (Optional, boolean)**: Determines whether to retrieve the user profile UID, if it exists, for the users. - -## client.security.getUserPrivileges [_security.get_user_privileges] -Get user privileges. - -Get the security privileges for the logged in user. -All users can use this API, but only to determine their own privileges. -To check the privileges of other users, you must use the run as feature. -To check whether a user has a specific list of privileges, use the has privileges API. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-get-user-privileges) - -```ts -client.security.getUserPrivileges({ ... }) -``` - -### Arguments [_arguments_security.get_user_privileges] - -#### Request (object) [_request_security.get_user_privileges] -- **`application` (Optional, string)**: The name of the application. Application privileges are always associated with exactly one application. If you do not specify this parameter, the API returns information about all privileges for all applications. -- **`priviledge` (Optional, string)**: The name of the privilege. If you do not specify this parameter, the API returns information about all privileges for the requested application. -- **`username` (Optional, string \| null)** - -## client.security.getUserProfile [_security.get_user_profile] -Get a user profile. - -Get a user's profile using the unique profile ID. - -NOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions. -Individual users and external applications should not call this API directly. -Elastic reserves the right to change or remove this feature in future releases without prior notice. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-get-user-profile) - -```ts -client.security.getUserProfile({ uid }) -``` - -### Arguments [_arguments_security.get_user_profile] - -#### Request (object) [_request_security.get_user_profile] -- **`uid` (string \| string[])**: A unique identifier for the user profile. -- **`data` (Optional, string \| string[])**: A list of filters for the `data` field of the profile document. -To return all content use `data=*`. -To return a subset of content use `data=` to retrieve content nested under the specified ``. -By default returns no `data` content. - -## client.security.grantApiKey [_security.grant_api_key] -Grant an API key. - -Create an API key on behalf of another user. -This API is similar to the create API keys API, however it creates the API key for a user that is different than the user that runs the API. -The caller must have authentication credentials for the user on whose behalf the API key will be created. -It is not possible to use this API to create an API key without that user's credentials. -The supported user authentication credential types are: - -* username and password -* Elasticsearch access tokens -* JWTs - -The user, for whom the authentication credentials is provided, can optionally "run as" (impersonate) another user. -In this case, the API key will be created on behalf of the impersonated user. - -This API is intended be used by applications that need to create and manage API keys for end users, but cannot guarantee that those users have permission to create API keys on their own behalf. -The API keys are created by the Elasticsearch API key service, which is automatically enabled. - -A successful grant API key API call returns a JSON structure that contains the API key, its unique id, and its name. -If applicable, it also returns expiration information for the API key in milliseconds. - -By default, API keys never expire. You can specify expiration information when you create the API keys. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-grant-api-key) - -```ts -client.security.grantApiKey({ api_key, grant_type }) -``` - -### Arguments [_arguments_security.grant_api_key] - -#### Request (object) [_request_security.grant_api_key] -- **`api_key` ({ name, expiration, role_descriptors, metadata })**: The API key. -- **`grant_type` (Enum("access_token" \| "password"))**: The type of grant. Supported grant types are: `access_token`, `password`. -- **`access_token` (Optional, string)**: The user's access token. -If you specify the `access_token` grant type, this parameter is required. -It is not valid with other grant types. -- **`username` (Optional, string)**: The user name that identifies the user. -If you specify the `password` grant type, this parameter is required. -It is not valid with other grant types. -- **`password` (Optional, string)**: The user's password. -If you specify the `password` grant type, this parameter is required. -It is not valid with other grant types. -- **`run_as` (Optional, string)**: The name of the user to be impersonated. - -## client.security.hasPrivileges [_security.has_privileges] -Check user privileges. - -Determine whether the specified user has a specified list of privileges. -All users can use this API, but only to determine their own privileges. -To check the privileges of other users, you must use the run as feature. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-has-privileges) - -```ts -client.security.hasPrivileges({ ... }) -``` - -### Arguments [_arguments_security.has_privileges] - -#### Request (object) [_request_security.has_privileges] -- **`user` (Optional, string)**: Username -- **`application` (Optional, { application, privileges, resources }[])** -- **`cluster` (Optional, Enum("all" \| "cancel_task" \| "create_snapshot" \| "cross_cluster_replication" \| "cross_cluster_search" \| "delegate_pki" \| "grant_api_key" \| "manage" \| "manage_api_key" \| "manage_autoscaling" \| "manage_behavioral_analytics" \| "manage_ccr" \| "manage_data_frame_transforms" \| "manage_data_stream_global_retention" \| "manage_enrich" \| "manage_esql" \| "manage_ilm" \| "manage_index_templates" \| "manage_inference" \| "manage_ingest_pipelines" \| "manage_logstash_pipelines" \| "manage_ml" \| "manage_oidc" \| "manage_own_api_key" \| "manage_pipeline" \| "manage_rollup" \| "manage_saml" \| "manage_search_application" \| "manage_search_query_rules" \| "manage_search_synonyms" \| "manage_security" \| "manage_service_account" \| "manage_slm" \| "manage_token" \| "manage_transform" \| "manage_user_profile" \| "manage_watcher" \| "monitor" \| "monitor_data_frame_transforms" \| "monitor_data_stream_global_retention" \| "monitor_enrich" \| "monitor_esql" \| "monitor_inference" \| "monitor_ml" \| "monitor_rollup" \| "monitor_snapshot" \| "monitor_stats" \| "monitor_text_structure" \| "monitor_transform" \| "monitor_watcher" \| "none" \| "post_behavioral_analytics_event" \| "read_ccr" \| "read_fleet_secrets" \| "read_ilm" \| "read_pipeline" \| "read_security" \| "read_slm" \| "transport_client" \| "write_connector_secrets" \| "write_fleet_secrets")[])**: A list of the cluster privileges that you want to check. -- **`index` (Optional, { names, privileges, allow_restricted_indices }[])** - -## client.security.hasPrivilegesUserProfile [_security.has_privileges_user_profile] -Check user profile privileges. - -Determine whether the users associated with the specified user profile IDs have all the requested privileges. - -NOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions. Individual users and external applications should not call this API directly. -Elastic reserves the right to change or remove this feature in future releases without prior notice. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-has-privileges-user-profile) - -```ts -client.security.hasPrivilegesUserProfile({ uids, privileges }) -``` - -### Arguments [_arguments_security.has_privileges_user_profile] - -#### Request (object) [_request_security.has_privileges_user_profile] -- **`uids` (string[])**: A list of profile IDs. The privileges are checked for associated users of the profiles. -- **`privileges` ({ application, cluster, index })**: An object containing all the privileges to be checked. - -## client.security.invalidateApiKey [_security.invalidate_api_key] -Invalidate API keys. - -This API invalidates API keys created by the create API key or grant API key APIs. -Invalidated API keys fail authentication, but they can still be viewed using the get API key information and query API key information APIs, for at least the configured retention period, until they are automatically deleted. - -To use this API, you must have at least the `manage_security`, `manage_api_key`, or `manage_own_api_key` cluster privileges. -The `manage_security` privilege allows deleting any API key, including both REST and cross cluster API keys. -The `manage_api_key` privilege allows deleting any REST API key, but not cross cluster API keys. -The `manage_own_api_key` only allows deleting REST API keys that are owned by the user. -In addition, with the `manage_own_api_key` privilege, an invalidation request must be issued in one of the three formats: - -- Set the parameter `owner=true`. -- Or, set both `username` and `realm_name` to match the user's identity. -- Or, if the request is issued by an API key, that is to say an API key invalidates itself, specify its ID in the `ids` field. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-invalidate-api-key) - -```ts -client.security.invalidateApiKey({ ... }) -``` - -### Arguments [_arguments_security.invalidate_api_key] - -#### Request (object) [_request_security.invalidate_api_key] -- **`id` (Optional, string)** -- **`ids` (Optional, string[])**: A list of API key ids. -This parameter cannot be used with any of `name`, `realm_name`, or `username`. -- **`name` (Optional, string)**: An API key name. -This parameter cannot be used with any of `ids`, `realm_name` or `username`. -- **`owner` (Optional, boolean)**: Query API keys owned by the currently authenticated user. -The `realm_name` or `username` parameters cannot be specified when this parameter is set to `true` as they are assumed to be the currently authenticated ones. - -NOTE: At least one of `ids`, `name`, `username`, and `realm_name` must be specified if `owner` is `false`. -- **`realm_name` (Optional, string)**: The name of an authentication realm. -This parameter cannot be used with either `ids` or `name`, or when `owner` flag is set to `true`. -- **`username` (Optional, string)**: The username of a user. -This parameter cannot be used with either `ids` or `name` or when `owner` flag is set to `true`. - -## client.security.invalidateToken [_security.invalidate_token] -Invalidate a token. - -The access tokens returned by the get token API have a finite period of time for which they are valid. -After that time period, they can no longer be used. -The time period is defined by the `xpack.security.authc.token.timeout` setting. - -The refresh tokens returned by the get token API are only valid for 24 hours. -They can also be used exactly once. -If you want to invalidate one or more access or refresh tokens immediately, use this invalidate token API. - -NOTE: While all parameters are optional, at least one of them is required. -More specifically, either one of `token` or `refresh_token` parameters is required. -If none of these two are specified, then `realm_name` and/or `username` need to be specified. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-invalidate-token) - -```ts -client.security.invalidateToken({ ... }) -``` - -### Arguments [_arguments_security.invalidate_token] - -#### Request (object) [_request_security.invalidate_token] -- **`token` (Optional, string)**: An access token. -This parameter cannot be used if any of `refresh_token`, `realm_name`, or `username` are used. -- **`refresh_token` (Optional, string)**: A refresh token. -This parameter cannot be used if any of `refresh_token`, `realm_name`, or `username` are used. -- **`realm_name` (Optional, string)**: The name of an authentication realm. -This parameter cannot be used with either `refresh_token` or `token`. -- **`username` (Optional, string)**: The username of a user. -This parameter cannot be used with either `refresh_token` or `token`. - -## client.security.oidcAuthenticate [_security.oidc_authenticate] -Authenticate OpenID Connect. - -Exchange an OpenID Connect authentication response message for an Elasticsearch internal access token and refresh token that can be subsequently used for authentication. - -Elasticsearch exposes all the necessary OpenID Connect related functionality with the OpenID Connect APIs. -These APIs are used internally by Kibana in order to provide OpenID Connect based authentication, but can also be used by other, custom web applications or other clients. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-oidc-authenticate) - -```ts -client.security.oidcAuthenticate({ nonce, redirect_uri, state }) -``` - -### Arguments [_arguments_security.oidc_authenticate] - -#### Request (object) [_request_security.oidc_authenticate] -- **`nonce` (string)**: Associate a client session with an ID token and mitigate replay attacks. -This value needs to be the same as the one that was provided to the `/_security/oidc/prepare` API or the one that was generated by Elasticsearch and included in the response to that call. -- **`redirect_uri` (string)**: The URL to which the OpenID Connect Provider redirected the User Agent in response to an authentication request after a successful authentication. -This URL must be provided as-is (URL encoded), taken from the body of the response or as the value of a location header in the response from the OpenID Connect Provider. -- **`state` (string)**: Maintain state between the authentication request and the response. -This value needs to be the same as the one that was provided to the `/_security/oidc/prepare` API or the one that was generated by Elasticsearch and included in the response to that call. -- **`realm` (Optional, string)**: The name of the OpenID Connect realm. -This property is useful in cases where multiple realms are defined. - -## client.security.oidcLogout [_security.oidc_logout] -Logout of OpenID Connect. - -Invalidate an access token and a refresh token that were generated as a response to the `/_security/oidc/authenticate` API. - -If the OpenID Connect authentication realm in Elasticsearch is accordingly configured, the response to this call will contain a URI pointing to the end session endpoint of the OpenID Connect Provider in order to perform single logout. - -Elasticsearch exposes all the necessary OpenID Connect related functionality with the OpenID Connect APIs. -These APIs are used internally by Kibana in order to provide OpenID Connect based authentication, but can also be used by other, custom web applications or other clients. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-oidc-logout) - -```ts -client.security.oidcLogout({ token }) -``` - -### Arguments [_arguments_security.oidc_logout] - -#### Request (object) [_request_security.oidc_logout] -- **`token` (string)**: The access token to be invalidated. -- **`refresh_token` (Optional, string)**: The refresh token to be invalidated. - -## client.security.oidcPrepareAuthentication [_security.oidc_prepare_authentication] -Prepare OpenID connect authentication. - -Create an oAuth 2.0 authentication request as a URL string based on the configuration of the OpenID Connect authentication realm in Elasticsearch. - -The response of this API is a URL pointing to the Authorization Endpoint of the configured OpenID Connect Provider, which can be used to redirect the browser of the user in order to continue the authentication process. - -Elasticsearch exposes all the necessary OpenID Connect related functionality with the OpenID Connect APIs. -These APIs are used internally by Kibana in order to provide OpenID Connect based authentication, but can also be used by other, custom web applications or other clients. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-oidc-prepare-authentication) - -```ts -client.security.oidcPrepareAuthentication({ ... }) -``` - -### Arguments [_arguments_security.oidc_prepare_authentication] - -#### Request (object) [_request_security.oidc_prepare_authentication] -- **`iss` (Optional, string)**: In the case of a third party initiated single sign on, this is the issuer identifier for the OP that the RP is to send the authentication request to. -It cannot be specified when *realm* is specified. -One of *realm* or *iss* is required. -- **`login_hint` (Optional, string)**: In the case of a third party initiated single sign on, it is a string value that is included in the authentication request as the *login_hint* parameter. -This parameter is not valid when *realm* is specified. -- **`nonce` (Optional, string)**: The value used to associate a client session with an ID token and to mitigate replay attacks. -If the caller of the API does not provide a value, Elasticsearch will generate one with sufficient entropy and return it in the response. -- **`realm` (Optional, string)**: The name of the OpenID Connect realm in Elasticsearch the configuration of which should be used in order to generate the authentication request. -It cannot be specified when *iss* is specified. -One of *realm* or *iss* is required. -- **`state` (Optional, string)**: The value used to maintain state between the authentication request and the response, typically used as a Cross-Site Request Forgery mitigation. -If the caller of the API does not provide a value, Elasticsearch will generate one with sufficient entropy and return it in the response. - -## client.security.putPrivileges [_security.put_privileges] -Create or update application privileges. - -To use this API, you must have one of the following privileges: - -* The `manage_security` cluster privilege (or a greater privilege such as `all`). -* The "Manage Application Privileges" global privilege for the application being referenced in the request. - -Application names are formed from a prefix, with an optional suffix that conform to the following rules: - -* The prefix must begin with a lowercase ASCII letter. -* The prefix must contain only ASCII letters or digits. -* The prefix must be at least 3 characters long. -* If the suffix exists, it must begin with either a dash `-` or `_`. -* The suffix cannot contain any of the following characters: `\`, `/`, `*`, `?`, `"`, `<`, `>`, `|`, `,`, `*`. -* No part of the name can contain whitespace. - -Privilege names must begin with a lowercase ASCII letter and must contain only ASCII letters and digits along with the characters `_`, `-`, and `.`. - -Action names can contain any number of printable ASCII characters and must contain at least one of the following characters: `/`, `*`, `:`. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-put-privileges) - -```ts -client.security.putPrivileges({ ... }) -``` - -### Arguments [_arguments_security.put_privileges] - -#### Request (object) [_request_security.put_privileges] -- **`privileges` (Optional, Record>)** -- **`refresh` (Optional, Enum(true \| false \| "wait_for"))**: If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. - -## client.security.putRole [_security.put_role] -Create or update roles. - -The role management APIs are generally the preferred way to manage roles in the native realm, rather than using file-based role management. -The create or update roles API cannot update roles that are defined in roles files. -File-based role management is not available in Elastic Serverless. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-put-role) - -```ts -client.security.putRole({ name }) -``` - -### Arguments [_arguments_security.put_role] - -#### Request (object) [_request_security.put_role] -- **`name` (string)**: The name of the role that is being created or updated. On Elasticsearch Serverless, the role name must begin with a letter or digit and can only contain letters, digits and the characters '_', '-', and '.'. Each role must have a unique name, as this will serve as the identifier for that role. -- **`applications` (Optional, { application, privileges, resources }[])**: A list of application privilege entries. -- **`cluster` (Optional, Enum("all" \| "cancel_task" \| "create_snapshot" \| "cross_cluster_replication" \| "cross_cluster_search" \| "delegate_pki" \| "grant_api_key" \| "manage" \| "manage_api_key" \| "manage_autoscaling" \| "manage_behavioral_analytics" \| "manage_ccr" \| "manage_data_frame_transforms" \| "manage_data_stream_global_retention" \| "manage_enrich" \| "manage_esql" \| "manage_ilm" \| "manage_index_templates" \| "manage_inference" \| "manage_ingest_pipelines" \| "manage_logstash_pipelines" \| "manage_ml" \| "manage_oidc" \| "manage_own_api_key" \| "manage_pipeline" \| "manage_rollup" \| "manage_saml" \| "manage_search_application" \| "manage_search_query_rules" \| "manage_search_synonyms" \| "manage_security" \| "manage_service_account" \| "manage_slm" \| "manage_token" \| "manage_transform" \| "manage_user_profile" \| "manage_watcher" \| "monitor" \| "monitor_data_frame_transforms" \| "monitor_data_stream_global_retention" \| "monitor_enrich" \| "monitor_esql" \| "monitor_inference" \| "monitor_ml" \| "monitor_rollup" \| "monitor_snapshot" \| "monitor_stats" \| "monitor_text_structure" \| "monitor_transform" \| "monitor_watcher" \| "none" \| "post_behavioral_analytics_event" \| "read_ccr" \| "read_fleet_secrets" \| "read_ilm" \| "read_pipeline" \| "read_security" \| "read_slm" \| "transport_client" \| "write_connector_secrets" \| "write_fleet_secrets")[])**: A list of cluster privileges. These privileges define the cluster-level actions for users with this role. -- **`global` (Optional, Record)**: An object defining global privileges. A global privilege is a form of cluster privilege that is request-aware. Support for global privileges is currently limited to the management of application privileges. -- **`indices` (Optional, { field_security, names, privileges, query, allow_restricted_indices }[])**: A list of indices permissions entries. -- **`remote_indices` (Optional, { clusters, field_security, names, privileges, query, allow_restricted_indices }[])**: A list of remote indices permissions entries. - -NOTE: Remote indices are effective for remote clusters configured with the API key based model. -They have no effect for remote clusters configured with the certificate based model. -- **`remote_cluster` (Optional, { clusters, privileges }[])**: A list of remote cluster permissions entries. -- **`metadata` (Optional, Record)**: Optional metadata. Within the metadata object, keys that begin with an underscore (`_`) are reserved for system use. -- **`run_as` (Optional, string[])**: A list of users that the owners of this role can impersonate. *Note*: in Serverless, the run-as feature is disabled. For API compatibility, you can still specify an empty `run_as` field, but a non-empty list will be rejected. -- **`description` (Optional, string)**: Optional description of the role descriptor -- **`transient_metadata` (Optional, Record)**: Indicates roles that might be incompatible with the current cluster license, specifically roles with document and field level security. When the cluster license doesn’t allow certain features for a given role, this parameter is updated dynamically to list the incompatible features. If `enabled` is `false`, the role is ignored, but is still listed in the response from the authenticate API. -- **`refresh` (Optional, Enum(true \| false \| "wait_for"))**: If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. - -## client.security.putRoleMapping [_security.put_role_mapping] -Create or update role mappings. - -Role mappings define which roles are assigned to each user. -Each mapping has rules that identify users and a list of roles that are granted to those users. -The role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files. The create or update role mappings API cannot update role mappings that are defined in role mapping files. - -NOTE: This API does not create roles. Rather, it maps users to existing roles. -Roles can be created by using the create or update roles API or roles files. - -**Role templates** - -The most common use for role mappings is to create a mapping from a known value on the user to a fixed role name. -For example, all users in the `cn=admin,dc=example,dc=com` LDAP group should be given the superuser role in Elasticsearch. -The `roles` field is used for this purpose. - -For more complex needs, it is possible to use Mustache templates to dynamically determine the names of the roles that should be granted to the user. -The `role_templates` field is used for this purpose. - -NOTE: To use role templates successfully, the relevant scripting feature must be enabled. -Otherwise, all attempts to create a role mapping with role templates fail. - -All of the user fields that are available in the role mapping rules are also available in the role templates. -Thus it is possible to assign a user to a role that reflects their username, their groups, or the name of the realm to which they authenticated. - -By default a template is evaluated to produce a single string that is the name of the role which should be assigned to the user. -If the format of the template is set to "json" then the template is expected to produce a JSON string or an array of JSON strings for the role names. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-put-role-mapping) - -```ts -client.security.putRoleMapping({ name }) -``` - -### Arguments [_arguments_security.put_role_mapping] - -#### Request (object) [_request_security.put_role_mapping] -- **`name` (string)**: The distinct name that identifies the role mapping. -The name is used solely as an identifier to facilitate interaction via the API; it does not affect the behavior of the mapping in any way. -- **`enabled` (Optional, boolean)**: Mappings that have `enabled` set to `false` are ignored when role mapping is performed. -- **`metadata` (Optional, Record)**: Additional metadata that helps define which roles are assigned to each user. -Within the metadata object, keys beginning with `_` are reserved for system usage. -- **`roles` (Optional, string[])**: A list of role names that are granted to the users that match the role mapping rules. -Exactly one of `roles` or `role_templates` must be specified. -- **`role_templates` (Optional, { format, template }[])**: A list of Mustache templates that will be evaluated to determine the roles names that should granted to the users that match the role mapping rules. -Exactly one of `roles` or `role_templates` must be specified. -- **`rules` (Optional, { any, all, field, except })**: The rules that determine which users should be matched by the mapping. -A rule is a logical condition that is expressed by using a JSON DSL. -- **`run_as` (Optional, string[])** -- **`refresh` (Optional, Enum(true \| false \| "wait_for"))**: If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. - -## client.security.putUser [_security.put_user] -Create or update users. - -Add and update users in the native realm. -A password is required for adding a new user but is optional when updating an existing user. -To change a user's password without updating any other fields, use the change password API. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-put-user) - -```ts -client.security.putUser({ username }) -``` - -### Arguments [_arguments_security.put_user] - -#### Request (object) [_request_security.put_user] -- **`username` (string)**: An identifier for the user. - -NOTE: Usernames must be at least 1 and no more than 507 characters. -They can contain alphanumeric characters (a-z, A-Z, 0-9), spaces, punctuation, and printable symbols in the Basic Latin (ASCII) block. -Leading or trailing whitespace is not allowed. -- **`email` (Optional, string \| null)**: The email of the user. -- **`full_name` (Optional, string \| null)**: The full name of the user. -- **`metadata` (Optional, Record)**: Arbitrary metadata that you want to associate with the user. -- **`password` (Optional, string)**: The user's password. -Passwords must be at least 6 characters long. -When adding a user, one of `password` or `password_hash` is required. -When updating an existing user, the password is optional, so that other fields on the user (such as their roles) may be updated without modifying the user's password -- **`password_hash` (Optional, string)**: A hash of the user's password. -This must be produced using the same hashing algorithm as has been configured for password storage. -For more details, see the explanation of the `xpack.security.authc.password_hashing.algorithm` setting in the user cache and password hash algorithm documentation. -Using this parameter allows the client to pre-hash the password for performance and/or confidentiality reasons. -The `password` parameter and the `password_hash` parameter cannot be used in the same request. -- **`roles` (Optional, string[])**: A set of roles the user has. -The roles determine the user's access permissions. -To create a user without any roles, specify an empty list (`[]`). -- **`enabled` (Optional, boolean)**: Specifies whether the user is enabled. -- **`refresh` (Optional, Enum(true \| false \| "wait_for"))**: Valid values are `true`, `false`, and `wait_for`. -These values have the same meaning as in the index API, but the default value for this API is true. - -## client.security.queryApiKeys [_security.query_api_keys] -Find API keys with a query. - -Get a paginated list of API keys and their information. -You can optionally filter the results with a query. - -To use this API, you must have at least the `manage_own_api_key` or the `read_security` cluster privileges. -If you have only the `manage_own_api_key` privilege, this API returns only the API keys that you own. -If you have the `read_security`, `manage_api_key`, or greater privileges (including `manage_security`), this API returns all API keys regardless of ownership. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-query-api-keys) - -```ts -client.security.queryApiKeys({ ... }) -``` - -### Arguments [_arguments_security.query_api_keys] - -#### Request (object) [_request_security.query_api_keys] -- **`aggregations` (Optional, Record)**: Any aggregations to run over the corpus of returned API keys. -Aggregations and queries work together. Aggregations are computed only on the API keys that match the query. -This supports only a subset of aggregation types, namely: `terms`, `range`, `date_range`, `missing`, -`cardinality`, `value_count`, `composite`, `filter`, and `filters`. -Additionally, aggregations only run over the same subset of fields that query works with. -- **`query` (Optional, { bool, exists, ids, match, match_all, prefix, range, simple_query_string, term, terms, wildcard })**: A query to filter which API keys to return. -If the query parameter is missing, it is equivalent to a `match_all` query. -The query supports a subset of query types, including `match_all`, `bool`, `term`, `terms`, `match`, -`ids`, `prefix`, `wildcard`, `exists`, `range`, and `simple_query_string`. -You can query the following public information associated with an API key: `id`, `type`, `name`, -`creation`, `expiration`, `invalidated`, `invalidation`, `username`, `realm`, and `metadata`. - -NOTE: The queryable string values associated with API keys are internally mapped as keywords. -Consequently, if no `analyzer` parameter is specified for a `match` query, then the provided match query string is interpreted as a single keyword value. -Such a match query is hence equivalent to a `term` query. -- **`from` (Optional, number)**: The starting document offset. -It must not be negative. -By default, you cannot page through more than 10,000 hits using the `from` and `size` parameters. -To page through more hits, use the `search_after` parameter. -- **`sort` (Optional, string \| { _score, _doc, _geo_distance, _script } \| string \| { _score, _doc, _geo_distance, _script }[])**: The sort definition. -Other than `id`, all public fields of an API key are eligible for sorting. -In addition, sort can also be applied to the `_doc` field to sort by index order. -- **`size` (Optional, number)**: The number of hits to return. -It must not be negative. -The `size` parameter can be set to `0`, in which case no API key matches are returned, only the aggregation results. -By default, you cannot page through more than 10,000 hits using the `from` and `size` parameters. -To page through more hits, use the `search_after` parameter. -- **`search_after` (Optional, number \| number \| string \| boolean \| null[])**: The search after definition. -- **`with_limited_by` (Optional, boolean)**: Return the snapshot of the owner user's role descriptors associated with the API key. -An API key's actual permission is the intersection of its assigned role descriptors and the owner user's role descriptors (effectively limited by it). -An API key cannot retrieve any API key’s limited-by role descriptors (including itself) unless it has `manage_api_key` or higher privileges. -- **`with_profile_uid` (Optional, boolean)**: Determines whether to also retrieve the profile UID for the API key owner principal. -If it exists, the profile UID is returned under the `profile_uid` response field for each API key. -- **`typed_keys` (Optional, boolean)**: Determines whether aggregation names are prefixed by their respective types in the response. - -## client.security.queryRole [_security.query_role] -Find roles with a query. - -Get roles in a paginated manner. -The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. -The query roles API does not retrieve roles that are defined in roles files, nor built-in ones. -You can optionally filter the results with a query. -Also, the results can be paginated and sorted. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-query-role) - -```ts -client.security.queryRole({ ... }) -``` - -### Arguments [_arguments_security.query_role] - -#### Request (object) [_request_security.query_role] -- **`query` (Optional, { bool, exists, ids, match, match_all, prefix, range, simple_query_string, term, terms, wildcard })**: A query to filter which roles to return. -If the query parameter is missing, it is equivalent to a `match_all` query. -The query supports a subset of query types, including `match_all`, `bool`, `term`, `terms`, `match`, -`ids`, `prefix`, `wildcard`, `exists`, `range`, and `simple_query_string`. -You can query the following information associated with roles: `name`, `description`, `metadata`, -`applications.application`, `applications.privileges`, and `applications.resources`. -- **`from` (Optional, number)**: The starting document offset. -It must not be negative. -By default, you cannot page through more than 10,000 hits using the `from` and `size` parameters. -To page through more hits, use the `search_after` parameter. -- **`sort` (Optional, string \| { _score, _doc, _geo_distance, _script } \| string \| { _score, _doc, _geo_distance, _script }[])**: The sort definition. -You can sort on `username`, `roles`, or `enabled`. -In addition, sort can also be applied to the `_doc` field to sort by index order. -- **`size` (Optional, number)**: The number of hits to return. -It must not be negative. -By default, you cannot page through more than 10,000 hits using the `from` and `size` parameters. -To page through more hits, use the `search_after` parameter. -- **`search_after` (Optional, number \| number \| string \| boolean \| null[])**: The search after definition. - -## client.security.queryUser [_security.query_user] -Find users with a query. - -Get information for users in a paginated manner. -You can optionally filter the results with a query. - -NOTE: As opposed to the get user API, built-in users are excluded from the result. -This API is only for native users. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-query-user) - -```ts -client.security.queryUser({ ... }) -``` - -### Arguments [_arguments_security.query_user] - -#### Request (object) [_request_security.query_user] -- **`query` (Optional, { ids, bool, exists, match, match_all, prefix, range, simple_query_string, term, terms, wildcard })**: A query to filter which users to return. -If the query parameter is missing, it is equivalent to a `match_all` query. -The query supports a subset of query types, including `match_all`, `bool`, `term`, `terms`, `match`, -`ids`, `prefix`, `wildcard`, `exists`, `range`, and `simple_query_string`. -You can query the following information associated with user: `username`, `roles`, `enabled`, `full_name`, and `email`. -- **`from` (Optional, number)**: The starting document offset. -It must not be negative. -By default, you cannot page through more than 10,000 hits using the `from` and `size` parameters. -To page through more hits, use the `search_after` parameter. -- **`sort` (Optional, string \| { _score, _doc, _geo_distance, _script } \| string \| { _score, _doc, _geo_distance, _script }[])**: The sort definition. -Fields eligible for sorting are: `username`, `roles`, `enabled`. -In addition, sort can also be applied to the `_doc` field to sort by index order. -- **`size` (Optional, number)**: The number of hits to return. -It must not be negative. -By default, you cannot page through more than 10,000 hits using the `from` and `size` parameters. -To page through more hits, use the `search_after` parameter. -- **`search_after` (Optional, number \| number \| string \| boolean \| null[])**: The search after definition -- **`with_profile_uid` (Optional, boolean)**: Determines whether to retrieve the user profile UID, if it exists, for the users. - -## client.security.samlAuthenticate [_security.saml_authenticate] -Authenticate SAML. - -Submit a SAML response message to Elasticsearch for consumption. - -NOTE: This API is intended for use by custom web applications other than Kibana. -If you are using Kibana, refer to the documentation for configuring SAML single-sign-on on the Elastic Stack. - -The SAML message that is submitted can be: - -* A response to a SAML authentication request that was previously created using the SAML prepare authentication API. -* An unsolicited SAML message in the case of an IdP-initiated single sign-on (SSO) flow. - -In either case, the SAML message needs to be a base64 encoded XML document with a root element of ``. - -After successful validation, Elasticsearch responds with an Elasticsearch internal access token and refresh token that can be subsequently used for authentication. -This API endpoint essentially exchanges SAML responses that indicate successful authentication in the IdP for Elasticsearch access and refresh tokens, which can be used for authentication against Elasticsearch. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-saml-authenticate) - -```ts -client.security.samlAuthenticate({ content, ids }) -``` - -### Arguments [_arguments_security.saml_authenticate] - -#### Request (object) [_request_security.saml_authenticate] -- **`content` (string)**: The SAML response as it was sent by the user's browser, usually a Base64 encoded XML document. -- **`ids` (string \| string[])**: A JSON array with all the valid SAML Request Ids that the caller of the API has for the current user. -- **`realm` (Optional, string)**: The name of the realm that should authenticate the SAML response. Useful in cases where many SAML realms are defined. - -## client.security.samlCompleteLogout [_security.saml_complete_logout] -Logout of SAML completely. - -Verifies the logout response sent from the SAML IdP. - -NOTE: This API is intended for use by custom web applications other than Kibana. -If you are using Kibana, refer to the documentation for configuring SAML single-sign-on on the Elastic Stack. - -The SAML IdP may send a logout response back to the SP after handling the SP-initiated SAML Single Logout. -This API verifies the response by ensuring the content is relevant and validating its signature. -An empty response is returned if the verification process is successful. -The response can be sent by the IdP with either the HTTP-Redirect or the HTTP-Post binding. -The caller of this API must prepare the request accordingly so that this API can handle either of them. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-saml-complete-logout) - -```ts -client.security.samlCompleteLogout({ realm, ids }) -``` - -### Arguments [_arguments_security.saml_complete_logout] - -#### Request (object) [_request_security.saml_complete_logout] -- **`realm` (string)**: The name of the SAML realm in Elasticsearch for which the configuration is used to verify the logout response. -- **`ids` (string \| string[])**: A JSON array with all the valid SAML Request Ids that the caller of the API has for the current user. -- **`query_string` (Optional, string)**: If the SAML IdP sends the logout response with the HTTP-Redirect binding, this field must be set to the query string of the redirect URI. -- **`content` (Optional, string)**: If the SAML IdP sends the logout response with the HTTP-Post binding, this field must be set to the value of the SAMLResponse form parameter from the logout response. - -## client.security.samlInvalidate [_security.saml_invalidate] -Invalidate SAML. - -Submit a SAML LogoutRequest message to Elasticsearch for consumption. - -NOTE: This API is intended for use by custom web applications other than Kibana. -If you are using Kibana, refer to the documentation for configuring SAML single-sign-on on the Elastic Stack. - -The logout request comes from the SAML IdP during an IdP initiated Single Logout. -The custom web application can use this API to have Elasticsearch process the `LogoutRequest`. -After successful validation of the request, Elasticsearch invalidates the access token and refresh token that corresponds to that specific SAML principal and provides a URL that contains a SAML LogoutResponse message. -Thus the user can be redirected back to their IdP. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-saml-invalidate) - -```ts -client.security.samlInvalidate({ query_string }) -``` - -### Arguments [_arguments_security.saml_invalidate] - -#### Request (object) [_request_security.saml_invalidate] -- **`query_string` (string)**: The query part of the URL that the user was redirected to by the SAML IdP to initiate the Single Logout. -This query should include a single parameter named `SAMLRequest` that contains a SAML logout request that is deflated and Base64 encoded. -If the SAML IdP has signed the logout request, the URL should include two extra parameters named `SigAlg` and `Signature` that contain the algorithm used for the signature and the signature value itself. -In order for Elasticsearch to be able to verify the IdP's signature, the value of the `query_string` field must be an exact match to the string provided by the browser. -The client application must not attempt to parse or process the string in any way. -- **`acs` (Optional, string)**: The Assertion Consumer Service URL that matches the one of the SAML realm in Elasticsearch that should be used. You must specify either this parameter or the `realm` parameter. -- **`realm` (Optional, string)**: The name of the SAML realm in Elasticsearch the configuration. You must specify either this parameter or the `acs` parameter. - -## client.security.samlLogout [_security.saml_logout] -Logout of SAML. - -Submits a request to invalidate an access token and refresh token. - -NOTE: This API is intended for use by custom web applications other than Kibana. -If you are using Kibana, refer to the documentation for configuring SAML single-sign-on on the Elastic Stack. - -This API invalidates the tokens that were generated for a user by the SAML authenticate API. -If the SAML realm in Elasticsearch is configured accordingly and the SAML IdP supports this, the Elasticsearch response contains a URL to redirect the user to the IdP that contains a SAML logout request (starting an SP-initiated SAML Single Logout). - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-saml-logout) - -```ts -client.security.samlLogout({ token }) -``` - -### Arguments [_arguments_security.saml_logout] - -#### Request (object) [_request_security.saml_logout] -- **`token` (string)**: The access token that was returned as a response to calling the SAML authenticate API. -Alternatively, the most recent token that was received after refreshing the original one by using a `refresh_token`. -- **`refresh_token` (Optional, string)**: The refresh token that was returned as a response to calling the SAML authenticate API. -Alternatively, the most recent refresh token that was received after refreshing the original access token. - -## client.security.samlPrepareAuthentication [_security.saml_prepare_authentication] -Prepare SAML authentication. - -Create a SAML authentication request (``) as a URL string based on the configuration of the respective SAML realm in Elasticsearch. - -NOTE: This API is intended for use by custom web applications other than Kibana. -If you are using Kibana, refer to the documentation for configuring SAML single-sign-on on the Elastic Stack. - -This API returns a URL pointing to the SAML Identity Provider. -You can use the URL to redirect the browser of the user in order to continue the authentication process. -The URL includes a single parameter named `SAMLRequest`, which contains a SAML Authentication request that is deflated and Base64 encoded. -If the configuration dictates that SAML authentication requests should be signed, the URL has two extra parameters named `SigAlg` and `Signature`. -These parameters contain the algorithm used for the signature and the signature value itself. -It also returns a random string that uniquely identifies this SAML Authentication request. -The caller of this API needs to store this identifier as it needs to be used in a following step of the authentication process. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-saml-prepare-authentication) - -```ts -client.security.samlPrepareAuthentication({ ... }) -``` - -### Arguments [_arguments_security.saml_prepare_authentication] - -#### Request (object) [_request_security.saml_prepare_authentication] -- **`acs` (Optional, string)**: The Assertion Consumer Service URL that matches the one of the SAML realms in Elasticsearch. -The realm is used to generate the authentication request. You must specify either this parameter or the `realm` parameter. -- **`realm` (Optional, string)**: The name of the SAML realm in Elasticsearch for which the configuration is used to generate the authentication request. -You must specify either this parameter or the `acs` parameter. -- **`relay_state` (Optional, string)**: A string that will be included in the redirect URL that this API returns as the `RelayState` query parameter. -If the Authentication Request is signed, this value is used as part of the signature computation. - -## client.security.samlServiceProviderMetadata [_security.saml_service_provider_metadata] -Create SAML service provider metadata. - -Generate SAML metadata for a SAML 2.0 Service Provider. - -The SAML 2.0 specification provides a mechanism for Service Providers to describe their capabilities and configuration using a metadata file. -This API generates Service Provider metadata based on the configuration of a SAML realm in Elasticsearch. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-saml-service-provider-metadata) - -```ts -client.security.samlServiceProviderMetadata({ realm_name }) -``` - -### Arguments [_arguments_security.saml_service_provider_metadata] - -#### Request (object) [_request_security.saml_service_provider_metadata] -- **`realm_name` (string)**: The name of the SAML realm in Elasticsearch. - -## client.security.suggestUserProfiles [_security.suggest_user_profiles] -Suggest a user profile. - -Get suggestions for user profiles that match specified search criteria. - -NOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions. -Individual users and external applications should not call this API directly. -Elastic reserves the right to change or remove this feature in future releases without prior notice. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-suggest-user-profiles) - -```ts -client.security.suggestUserProfiles({ ... }) -``` - -### Arguments [_arguments_security.suggest_user_profiles] - -#### Request (object) [_request_security.suggest_user_profiles] -- **`name` (Optional, string)**: A query string used to match name-related fields in user profile documents. -Name-related fields are the user's `username`, `full_name`, and `email`. -- **`size` (Optional, number)**: The number of profiles to return. -- **`data` (Optional, string \| string[])**: A list of filters for the `data` field of the profile document. -To return all content use `data=*`. -To return a subset of content, use `data=` to retrieve content nested under the specified ``. -By default, the API returns no `data` content. -It is an error to specify `data` as both the query parameter and the request body field. -- **`hint` (Optional, { uids, labels })**: Extra search criteria to improve relevance of the suggestion result. -Profiles matching the spcified hint are ranked higher in the response. -Profiles not matching the hint aren't excluded from the response as long as the profile matches the `name` field query. - -## client.security.updateApiKey [_security.update_api_key] -Update an API key. - -Update attributes of an existing API key. -This API supports updates to an API key's access scope, expiration, and metadata. - -To use this API, you must have at least the `manage_own_api_key` cluster privilege. -Users can only update API keys that they created or that were granted to them. -To update another user’s API key, use the `run_as` feature to submit a request on behalf of another user. - -IMPORTANT: It's not possible to use an API key as the authentication credential for this API. The owner user’s credentials are required. - -Use this API to update API keys created by the create API key or grant API Key APIs. -If you need to apply the same update to many API keys, you can use the bulk update API keys API to reduce overhead. -It's not possible to update expired API keys or API keys that have been invalidated by the invalidate API key API. - -The access scope of an API key is derived from the `role_descriptors` you specify in the request and a snapshot of the owner user's permissions at the time of the request. -The snapshot of the owner's permissions is updated automatically on every call. - -IMPORTANT: If you don't specify `role_descriptors` in the request, a call to this API might still change the API key's access scope. -This change can occur if the owner user's permissions have changed since the API key was created or last modified. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-update-api-key) - -```ts -client.security.updateApiKey({ id }) -``` - -### Arguments [_arguments_security.update_api_key] - -#### Request (object) [_request_security.update_api_key] -- **`id` (string)**: The ID of the API key to update. -- **`role_descriptors` (Optional, Record)**: The role descriptors to assign to this API key. -The API key's effective permissions are an intersection of its assigned privileges and the point in time snapshot of permissions of the owner user. -You can assign new privileges by specifying them in this parameter. -To remove assigned privileges, you can supply an empty `role_descriptors` parameter, that is to say, an empty object `{}`. -If an API key has no assigned privileges, it inherits the owner user's full permissions. -The snapshot of the owner's permissions is always updated, whether you supply the `role_descriptors` parameter or not. -The structure of a role descriptor is the same as the request for the create API keys API. -- **`metadata` (Optional, Record)**: Arbitrary metadata that you want to associate with the API key. -It supports a nested data structure. -Within the metadata object, keys beginning with `_` are reserved for system usage. -When specified, this value fully replaces the metadata previously associated with the API key. -- **`expiration` (Optional, string \| -1 \| 0)**: The expiration time for the API key. -By default, API keys never expire. -This property can be omitted to leave the expiration unchanged. - -## client.security.updateCrossClusterApiKey [_security.update_cross_cluster_api_key] -Update a cross-cluster API key. - -Update the attributes of an existing cross-cluster API key, which is used for API key based remote cluster access. - -To use this API, you must have at least the `manage_security` cluster privilege. -Users can only update API keys that they created. -To update another user's API key, use the `run_as` feature to submit a request on behalf of another user. - -IMPORTANT: It's not possible to use an API key as the authentication credential for this API. -To update an API key, the owner user's credentials are required. - -It's not possible to update expired API keys, or API keys that have been invalidated by the invalidate API key API. - -This API supports updates to an API key's access scope, metadata, and expiration. -The owner user's information, such as the `username` and `realm`, is also updated automatically on every call. - -NOTE: This API cannot update REST API keys, which should be updated by either the update API key or bulk update API keys API. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-update-cross-cluster-api-key) - -```ts -client.security.updateCrossClusterApiKey({ id, access }) -``` - -### Arguments [_arguments_security.update_cross_cluster_api_key] - -#### Request (object) [_request_security.update_cross_cluster_api_key] -- **`id` (string)**: The ID of the cross-cluster API key to update. -- **`access` ({ replication, search })**: The access to be granted to this API key. -The access is composed of permissions for cross cluster search and cross cluster replication. -At least one of them must be specified. -When specified, the new access assignment fully replaces the previously assigned access. -- **`expiration` (Optional, string \| -1 \| 0)**: The expiration time for the API key. -By default, API keys never expire. This property can be omitted to leave the value unchanged. -- **`metadata` (Optional, Record)**: Arbitrary metadata that you want to associate with the API key. -It supports nested data structure. -Within the metadata object, keys beginning with `_` are reserved for system usage. -When specified, this information fully replaces metadata previously associated with the API key. - -## client.security.updateSettings [_security.update_settings] -Update security index settings. - -Update the user-configurable settings for the security internal index (`.security` and associated indices). Only a subset of settings are allowed to be modified. This includes `index.auto_expand_replicas` and `index.number_of_replicas`. - -NOTE: If `index.auto_expand_replicas` is set, `index.number_of_replicas` will be ignored during updates. - -If a specific index is not in use on the system and settings are provided for it, the request will be rejected. -This API does not yet support configuring the settings for indices before they are in use. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-update-settings) - -```ts -client.security.updateSettings({ ... }) -``` - -### Arguments [_arguments_security.update_settings] - -#### Request (object) [_request_security.update_settings] -- **`security` (Optional, { index })**: Settings for the index used for most security configuration, including native realm users and roles configured with the API. -- **`security-profile` (Optional, { index })**: Settings for the index used to store profile information. -- **`security-tokens` (Optional, { index })**: Settings for the index used to store tokens. -- **`master_timeout` (Optional, string \| -1 \| 0)**: The period to wait for a connection to the master node. -If no response is received before the timeout expires, the request fails and returns an error. -- **`timeout` (Optional, string \| -1 \| 0)**: The period to wait for a response. -If no response is received before the timeout expires, the request fails and returns an error. - -## client.security.updateUserProfileData [_security.update_user_profile_data] -Update user profile data. - -Update specific data for the user profile that is associated with a unique ID. - -NOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions. -Individual users and external applications should not call this API directly. -Elastic reserves the right to change or remove this feature in future releases without prior notice. - -To use this API, you must have one of the following privileges: - -* The `manage_user_profile` cluster privilege. -* The `update_profile_data` global privilege for the namespaces that are referenced in the request. - -This API updates the `labels` and `data` fields of an existing user profile document with JSON objects. -New keys and their values are added to the profile document and conflicting keys are replaced by data that's included in the request. - -For both labels and data, content is namespaced by the top-level fields. -The `update_profile_data` global privilege grants privileges for updating only the allowed namespaces. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-update-user-profile-data) - -```ts -client.security.updateUserProfileData({ uid }) -``` - -### Arguments [_arguments_security.update_user_profile_data] - -#### Request (object) [_request_security.update_user_profile_data] -- **`uid` (string)**: A unique identifier for the user profile. -- **`labels` (Optional, Record)**: Searchable data that you want to associate with the user profile. -This field supports a nested data structure. -Within the labels object, top-level keys cannot begin with an underscore (`_`) or contain a period (`.`). -- **`data` (Optional, Record)**: Non-searchable data that you want to associate with the user profile. -This field supports a nested data structure. -Within the `data` object, top-level keys cannot begin with an underscore (`_`) or contain a period (`.`). -The data object is not searchable, but can be retrieved with the get user profile API. -- **`if_seq_no` (Optional, number)**: Only perform the operation if the document has this sequence number. -- **`if_primary_term` (Optional, number)**: Only perform the operation if the document has this primary term. -- **`refresh` (Optional, Enum(true \| false \| "wait_for"))**: If 'true', Elasticsearch refreshes the affected shards to make this operation -visible to search. -If 'wait_for', it waits for a refresh to make this operation visible to search. -If 'false', nothing is done with refreshes. - -## client.shutdown.deleteNode [_shutdown.delete_node] -Cancel node shutdown preparations. -Remove a node from the shutdown list so it can resume normal operations. -You must explicitly clear the shutdown request when a node rejoins the cluster or when a node has permanently left the cluster. -Shutdown requests are never removed automatically by Elasticsearch. - -NOTE: This feature is designed for indirect use by Elastic Cloud, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. -Direct use is not supported. - -If the operator privileges feature is enabled, you must be an operator to use this API. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-shutdown-delete-node) - -```ts -client.shutdown.deleteNode({ node_id }) -``` - -### Arguments [_arguments_shutdown.delete_node] - -#### Request (object) [_request_shutdown.delete_node] -- **`node_id` (string)**: The node id of node to be removed from the shutdown state -- **`master_timeout` (Optional, Enum("nanos" \| "micros" \| "ms" \| "s" \| "m" \| "h" \| "d"))**: Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. -- **`timeout` (Optional, Enum("nanos" \| "micros" \| "ms" \| "s" \| "m" \| "h" \| "d"))**: Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. - -## client.shutdown.getNode [_shutdown.get_node] -Get the shutdown status. - -Get information about nodes that are ready to be shut down, have shut down preparations still in progress, or have stalled. -The API returns status information for each part of the shut down process. - -NOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported. - -If the operator privileges feature is enabled, you must be an operator to use this API. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-shutdown-get-node) - -```ts -client.shutdown.getNode({ ... }) -``` - -### Arguments [_arguments_shutdown.get_node] - -#### Request (object) [_request_shutdown.get_node] -- **`node_id` (Optional, string \| string[])**: Which node for which to retrieve the shutdown status -- **`master_timeout` (Optional, Enum("nanos" \| "micros" \| "ms" \| "s" \| "m" \| "h" \| "d"))**: Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. - -## client.shutdown.putNode [_shutdown.put_node] -Prepare a node to be shut down. - -NOTE: This feature is designed for indirect use by Elastic Cloud, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported. - -If you specify a node that is offline, it will be prepared for shut down when it rejoins the cluster. - -If the operator privileges feature is enabled, you must be an operator to use this API. - -The API migrates ongoing tasks and index shards to other nodes as needed to prepare a node to be restarted or shut down and removed from the cluster. -This ensures that Elasticsearch can be stopped safely with minimal disruption to the cluster. - -You must specify the type of shutdown: `restart`, `remove`, or `replace`. -If a node is already being prepared for shutdown, you can use this API to change the shutdown type. - -IMPORTANT: This API does NOT terminate the Elasticsearch process. -Monitor the node shutdown status to determine when it is safe to stop Elasticsearch. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-shutdown-put-node) - -```ts -client.shutdown.putNode({ node_id, type, reason }) -``` - -### Arguments [_arguments_shutdown.put_node] - -#### Request (object) [_request_shutdown.put_node] -- **`node_id` (string)**: The node identifier. -This parameter is not validated against the cluster's active nodes. -This enables you to register a node for shut down while it is offline. -No error is thrown if you specify an invalid node ID. -- **`type` (Enum("restart" \| "remove" \| "replace"))**: Valid values are restart, remove, or replace. -Use restart when you need to temporarily shut down a node to perform an upgrade, make configuration changes, or perform other maintenance. -Because the node is expected to rejoin the cluster, data is not migrated off of the node. -Use remove when you need to permanently remove a node from the cluster. -The node is not marked ready for shutdown until data is migrated off of the node Use replace to do a 1:1 replacement of a node with another node. -Certain allocation decisions will be ignored (such as disk watermarks) in the interest of true replacement of the source node with the target node. -During a replace-type shutdown, rollover and index creation may result in unassigned shards, and shrink may fail until the replacement is complete. -- **`reason` (string)**: A human-readable reason that the node is being shut down. -This field provides information for other cluster operators; it does not affect the shut down process. -- **`allocation_delay` (Optional, string)**: Only valid if type is restart. -Controls how long Elasticsearch will wait for the node to restart and join the cluster before reassigning its shards to other nodes. -This works the same as delaying allocation with the index.unassigned.node_left.delayed_timeout setting. -If you specify both a restart allocation delay and an index-level allocation delay, the longer of the two is used. -- **`target_node_name` (Optional, string)**: Only valid if type is replace. -Specifies the name of the node that is replacing the node being shut down. -Shards from the shut down node are only allowed to be allocated to the target node, and no other data will be allocated to the target node. -During relocation of data certain allocation rules are ignored, such as disk watermarks or user attribute filtering rules. -- **`master_timeout` (Optional, Enum("nanos" \| "micros" \| "ms" \| "s" \| "m" \| "h" \| "d"))**: The period to wait for a connection to the master node. -If no response is received before the timeout expires, the request fails and returns an error. -- **`timeout` (Optional, Enum("nanos" \| "micros" \| "ms" \| "s" \| "m" \| "h" \| "d"))**: The period to wait for a response. -If no response is received before the timeout expires, the request fails and returns an error. - -## client.simulate.ingest [_simulate.ingest] -Simulate data ingestion. -Run ingest pipelines against a set of provided documents, optionally with substitute pipeline definitions, to simulate ingesting data into an index. - -This API is meant to be used for troubleshooting or pipeline development, as it does not actually index any data into Elasticsearch. - -The API runs the default and final pipeline for that index against a set of documents provided in the body of the request. -If a pipeline contains a reroute processor, it follows that reroute processor to the new index, running that index's pipelines as well the same way that a non-simulated ingest would. -No data is indexed into Elasticsearch. -Instead, the transformed document is returned, along with the list of pipelines that have been run and the name of the index where the document would have been indexed if this were not a simulation. -The transformed document is validated against the mappings that would apply to this index, and any validation error is reported in the result. - -This API differs from the simulate pipeline API in that you specify a single pipeline for that API, and it runs only that one pipeline. -The simulate pipeline API is more useful for developing a single pipeline, while the simulate ingest API is more useful for troubleshooting the interaction of the various pipelines that get applied when ingesting into an index. - -By default, the pipeline definitions that are currently in the system are used. -However, you can supply substitute pipeline definitions in the body of the request. -These will be used in place of the pipeline definitions that are already in the system. This can be used to replace existing pipeline definitions or to create new ones. The pipeline substitutions are used only within this request. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-simulate-ingest) - -```ts -client.simulate.ingest({ docs }) -``` - -### Arguments [_arguments_simulate.ingest] - -#### Request (object) [_request_simulate.ingest] -- **`docs` ({ _id, _index, _source }[])**: Sample documents to test in the pipeline. -- **`index` (Optional, string)**: The index to simulate ingesting into. -This value can be overridden by specifying an index on each document. -If you specify this parameter in the request path, it is used for any documents that do not explicitly specify an index argument. -- **`component_template_substitutions` (Optional, Record)**: A map of component template names to substitute component template definition objects. -- **`index_template_substitutions` (Optional, Record)**: A map of index template names to substitute index template definition objects. -- **`mapping_addition` (Optional, { all_field, date_detection, dynamic, dynamic_date_formats, dynamic_templates, _field_names, index_field, _meta, numeric_detection, properties, _routing, _size, _source, runtime, enabled, subobjects, _data_stream_timestamp })** -- **`pipeline_substitutions` (Optional, Record)**: Pipelines to test. -If you don’t specify the `pipeline` request path parameter, this parameter is required. -If you specify both this and the request path parameter, the API only uses the request path parameter. -- **`pipeline` (Optional, string)**: The pipeline to use as the default pipeline. -This value can be used to override the default pipeline of the index. - -## client.slm.deleteLifecycle [_slm.delete_lifecycle] -Delete a policy. -Delete a snapshot lifecycle policy definition. -This operation prevents any future snapshots from being taken but does not cancel in-progress snapshots or remove previously-taken snapshots. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-slm-delete-lifecycle) - -```ts -client.slm.deleteLifecycle({ policy_id }) -``` - -### Arguments [_arguments_slm.delete_lifecycle] - -#### Request (object) [_request_slm.delete_lifecycle] -- **`policy_id` (string)**: The id of the snapshot lifecycle policy to remove -- **`master_timeout` (Optional, string \| -1 \| 0)**: The period to wait for a connection to the master node. -If no response is received before the timeout expires, the request fails and returns an error. -- **`timeout` (Optional, string \| -1 \| 0)**: The period to wait for a response. -If no response is received before the timeout expires, the request fails and returns an error. - -## client.slm.executeLifecycle [_slm.execute_lifecycle] -Run a policy. -Immediately create a snapshot according to the snapshot lifecycle policy without waiting for the scheduled time. -The snapshot policy is normally applied according to its schedule, but you might want to manually run a policy before performing an upgrade or other maintenance. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-slm-execute-lifecycle) - -```ts -client.slm.executeLifecycle({ policy_id }) -``` - -### Arguments [_arguments_slm.execute_lifecycle] - -#### Request (object) [_request_slm.execute_lifecycle] -- **`policy_id` (string)**: The id of the snapshot lifecycle policy to be executed -- **`master_timeout` (Optional, string \| -1 \| 0)**: The period to wait for a connection to the master node. -If no response is received before the timeout expires, the request fails and returns an error. -- **`timeout` (Optional, string \| -1 \| 0)**: The period to wait for a response. -If no response is received before the timeout expires, the request fails and returns an error. - -## client.slm.executeRetention [_slm.execute_retention] -Run a retention policy. -Manually apply the retention policy to force immediate removal of snapshots that are expired according to the snapshot lifecycle policy retention rules. -The retention policy is normally applied according to its schedule. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-slm-execute-retention) - -```ts -client.slm.executeRetention({ ... }) -``` - -### Arguments [_arguments_slm.execute_retention] - -#### Request (object) [_request_slm.execute_retention] -- **`master_timeout` (Optional, string \| -1 \| 0)**: The period to wait for a connection to the master node. -If no response is received before the timeout expires, the request fails and returns an error. -- **`timeout` (Optional, string \| -1 \| 0)**: The period to wait for a response. -If no response is received before the timeout expires, the request fails and returns an error. - -## client.slm.getLifecycle [_slm.get_lifecycle] -Get policy information. -Get snapshot lifecycle policy definitions and information about the latest snapshot attempts. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-slm-get-lifecycle) - -```ts -client.slm.getLifecycle({ ... }) -``` - -### Arguments [_arguments_slm.get_lifecycle] - -#### Request (object) [_request_slm.get_lifecycle] -- **`policy_id` (Optional, string \| string[])**: List of snapshot lifecycle policies to retrieve -- **`master_timeout` (Optional, string \| -1 \| 0)**: The period to wait for a connection to the master node. -If no response is received before the timeout expires, the request fails and returns an error. -- **`timeout` (Optional, string \| -1 \| 0)**: The period to wait for a response. -If no response is received before the timeout expires, the request fails and returns an error. - -## client.slm.getStats [_slm.get_stats] -Get snapshot lifecycle management statistics. -Get global and policy-level statistics about actions taken by snapshot lifecycle management. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-slm-get-stats) - -```ts -client.slm.getStats({ ... }) -``` - -### Arguments [_arguments_slm.get_stats] - -#### Request (object) [_request_slm.get_stats] -- **`master_timeout` (Optional, string \| -1 \| 0)**: Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. -- **`timeout` (Optional, string \| -1 \| 0)**: Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. - -## client.slm.getStatus [_slm.get_status] -Get the snapshot lifecycle management status. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-slm-get-status) - -```ts -client.slm.getStatus({ ... }) -``` - -### Arguments [_arguments_slm.get_status] - -#### Request (object) [_request_slm.get_status] -- **`master_timeout` (Optional, string \| -1 \| 0)**: The period to wait for a connection to the master node. -If no response is received before the timeout expires, the request fails and returns an error. -To indicate that the request should never timeout, set it to `-1`. -- **`timeout` (Optional, string \| -1 \| 0)**: The period to wait for a response. -If no response is received before the timeout expires, the request fails and returns an error. -To indicate that the request should never timeout, set it to `-1`. - -## client.slm.putLifecycle [_slm.put_lifecycle] -Create or update a policy. -Create or update a snapshot lifecycle policy. -If the policy already exists, this request increments the policy version. -Only the latest version of a policy is stored. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-slm-put-lifecycle) - -```ts -client.slm.putLifecycle({ policy_id }) -``` - -### Arguments [_arguments_slm.put_lifecycle] - -#### Request (object) [_request_slm.put_lifecycle] -- **`policy_id` (string)**: The identifier for the snapshot lifecycle policy you want to create or update. -- **`config` (Optional, { ignore_unavailable, indices, include_global_state, feature_states, metadata, partial })**: Configuration for each snapshot created by the policy. -- **`name` (Optional, string)**: Name automatically assigned to each snapshot created by the policy. Date math is supported. To prevent conflicting snapshot names, a UUID is automatically appended to each snapshot name. -- **`repository` (Optional, string)**: Repository used to store snapshots created by this policy. This repository must exist prior to the policy’s creation. You can create a repository using the snapshot repository API. -- **`retention` (Optional, { expire_after, max_count, min_count })**: Retention rules used to retain and delete snapshots created by the policy. -- **`schedule` (Optional, string)**: Periodic or absolute schedule at which the policy creates snapshots. SLM applies schedule changes immediately. -- **`master_timeout` (Optional, string \| -1 \| 0)**: The period to wait for a connection to the master node. -If no response is received before the timeout expires, the request fails and returns an error. -To indicate that the request should never timeout, set it to `-1`. -- **`timeout` (Optional, string \| -1 \| 0)**: The period to wait for a response. -If no response is received before the timeout expires, the request fails and returns an error. -To indicate that the request should never timeout, set it to `-1`. - -## client.slm.start [_slm.start] -Start snapshot lifecycle management. -Snapshot lifecycle management (SLM) starts automatically when a cluster is formed. -Manually starting SLM is necessary only if it has been stopped using the stop SLM API. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-slm-start) - -```ts -client.slm.start({ ... }) -``` - -### Arguments [_arguments_slm.start] - -#### Request (object) [_request_slm.start] -- **`master_timeout` (Optional, string \| -1 \| 0)**: The period to wait for a connection to the master node. -If no response is received before the timeout expires, the request fails and returns an error. -To indicate that the request should never timeout, set it to `-1`. -- **`timeout` (Optional, string \| -1 \| 0)**: The period to wait for a response. -If no response is received before the timeout expires, the request fails and returns an error. -To indicate that the request should never timeout, set it to `-1`. - -## client.slm.stop [_slm.stop] -Stop snapshot lifecycle management. -Stop all snapshot lifecycle management (SLM) operations and the SLM plugin. -This API is useful when you are performing maintenance on a cluster and need to prevent SLM from performing any actions on your data streams or indices. -Stopping SLM does not stop any snapshots that are in progress. -You can manually trigger snapshots with the run snapshot lifecycle policy API even if SLM is stopped. - -The API returns a response as soon as the request is acknowledged, but the plugin might continue to run until in-progress operations complete and it can be safely stopped. -Use the get snapshot lifecycle management status API to see if SLM is running. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-slm-stop) - -```ts -client.slm.stop({ ... }) -``` - -### Arguments [_arguments_slm.stop] - -#### Request (object) [_request_slm.stop] -- **`master_timeout` (Optional, string \| -1 \| 0)**: The period to wait for a connection to the master node. -If no response is received before the timeout expires, the request fails and returns an error. -To indicate that the request should never timeout, set it to `-1`. -- **`timeout` (Optional, string \| -1 \| 0)**: The period to wait for a response. -If no response is received before the timeout expires, the request fails and returns an error. -To indicate that the request should never timeout, set it to `-1`. - -## client.snapshot.cleanupRepository [_snapshot.cleanup_repository] -Clean up the snapshot repository. -Trigger the review of the contents of a snapshot repository and delete any stale data not referenced by existing snapshots. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-cleanup-repository) - -```ts -client.snapshot.cleanupRepository({ repository }) -``` - -### Arguments [_arguments_snapshot.cleanup_repository] - -#### Request (object) [_request_snapshot.cleanup_repository] -- **`repository` (string)**: The name of the snapshot repository to clean up. -- **`master_timeout` (Optional, string \| -1 \| 0)**: The period to wait for a connection to the master node. -If the master node is not available before the timeout expires, the request fails and returns an error. -To indicate that the request should never timeout, set it to `-1` -- **`timeout` (Optional, string \| -1 \| 0)**: The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata. -If no response is received before the timeout expires, the cluster metadata update still applies but the response will indicate that it was not completely acknowledged. -To indicate that the request should never timeout, set it to `-1`. - -## client.snapshot.clone [_snapshot.clone] -Clone a snapshot. -Clone part of all of a snapshot into another snapshot in the same repository. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-clone) - -```ts -client.snapshot.clone({ repository, snapshot, target_snapshot, indices }) -``` - -### Arguments [_arguments_snapshot.clone] - -#### Request (object) [_request_snapshot.clone] -- **`repository` (string)**: The name of the snapshot repository that both source and target snapshot belong to. -- **`snapshot` (string)**: The source snapshot name. -- **`target_snapshot` (string)**: The target snapshot name. -- **`indices` (string)**: A list of indices to include in the snapshot. -Multi-target syntax is supported. -- **`master_timeout` (Optional, string \| -1 \| 0)**: The period to wait for the master node. -If the master node is not available before the timeout expires, the request fails and returns an error. -To indicate that the request should never timeout, set it to `-1`. - -## client.snapshot.create [_snapshot.create] -Create a snapshot. -Take a snapshot of a cluster or of data streams and indices. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-create) - -```ts -client.snapshot.create({ repository, snapshot }) -``` - -### Arguments [_arguments_snapshot.create] - -#### Request (object) [_request_snapshot.create] -- **`repository` (string)**: The name of the repository for the snapshot. -- **`snapshot` (string)**: The name of the snapshot. -It supportes date math. -It must be unique in the repository. -- **`expand_wildcards` (Optional, Enum("all" \| "open" \| "closed" \| "hidden" \| "none") \| Enum("all" \| "open" \| "closed" \| "hidden" \| "none")[])**: Determines how wildcard patterns in the `indices` parameter match data streams and indices. -It supports a list of values such as `open,hidden`. -- **`feature_states` (Optional, string[])**: The feature states to include in the snapshot. -Each feature state includes one or more system indices containing related data. -You can view a list of eligible features using the get features API. - -If `include_global_state` is `true`, all current feature states are included by default. -If `include_global_state` is `false`, no feature states are included by default. - -Note that specifying an empty array will result in the default behavior. -To exclude all feature states, regardless of the `include_global_state` value, specify an array with only the value `none` (`["none"]`). -- **`ignore_unavailable` (Optional, boolean)**: If `true`, the request ignores data streams and indices in `indices` that are missing or closed. -If `false`, the request returns an error for any data stream or index that is missing or closed. -- **`include_global_state` (Optional, boolean)**: If `true`, the current cluster state is included in the snapshot. -The cluster state includes persistent cluster settings, composable index templates, legacy index templates, ingest pipelines, and ILM policies. -It also includes data stored in system indices, such as Watches and task records (configurable via `feature_states`). -- **`indices` (Optional, string \| string[])**: A list of data streams and indices to include in the snapshot. -It supports a multi-target syntax. -The default is an empty array (`[]`), which includes all regular data streams and regular indices. -To exclude all data streams and indices, use `-*`. - -You can't use this parameter to include or exclude system indices or system data streams from a snapshot. -Use `feature_states` instead. -- **`metadata` (Optional, Record)**: Arbitrary metadata to the snapshot, such as a record of who took the snapshot, why it was taken, or any other useful data. -It can have any contents but it must be less than 1024 bytes. -This information is not automatically generated by Elasticsearch. -- **`partial` (Optional, boolean)**: If `true`, it enables you to restore a partial snapshot of indices with unavailable shards. -Only shards that were successfully included in the snapshot will be restored. -All missing shards will be recreated as empty. - -If `false`, the entire restore operation will fail if one or more indices included in the snapshot do not have all primary shards available. -- **`master_timeout` (Optional, string \| -1 \| 0)**: The period to wait for a connection to the master node. -If no response is received before the timeout expires, the request fails and returns an error. -- **`wait_for_completion` (Optional, boolean)**: If `true`, the request returns a response when the snapshot is complete. -If `false`, the request returns a response when the snapshot initializes. - -## client.snapshot.createRepository [_snapshot.create_repository] -Create or update a snapshot repository. -IMPORTANT: If you are migrating searchable snapshots, the repository name must be identical in the source and destination clusters. -To register a snapshot repository, the cluster's global metadata must be writeable. -Ensure there are no cluster blocks (for example, `cluster.blocks.read_only` and `clsuter.blocks.read_only_allow_delete` settings) that prevent write access. - -Several options for this API can be specified using a query parameter or a request body parameter. -If both parameters are specified, only the query parameter is used. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-create-repository) - -```ts -client.snapshot.createRepository({ repository }) -``` - -### Arguments [_arguments_snapshot.create_repository] - -#### Request (object) [_request_snapshot.create_repository] -- **`repository` (string)**: The name of the snapshot repository to register or update. -- **`master_timeout` (Optional, string \| -1 \| 0)**: The period to wait for the master node. -If the master node is not available before the timeout expires, the request fails and returns an error. -To indicate that the request should never timeout, set it to `-1`. -- **`timeout` (Optional, string \| -1 \| 0)**: The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata. -If no response is received before the timeout expires, the cluster metadata update still applies but the response will indicate that it was not completely acknowledged. -To indicate that the request should never timeout, set it to `-1`. -- **`verify` (Optional, boolean)**: If `true`, the request verifies the repository is functional on all master and data nodes in the cluster. -If `false`, this verification is skipped. -You can also perform this verification with the verify snapshot repository API. - -## client.snapshot.delete [_snapshot.delete] -Delete snapshots. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-delete) - -```ts -client.snapshot.delete({ repository, snapshot }) -``` - -### Arguments [_arguments_snapshot.delete] - -#### Request (object) [_request_snapshot.delete] -- **`repository` (string)**: The name of the repository to delete a snapshot from. -- **`snapshot` (string)**: A list of snapshot names to delete. -It also accepts wildcards (`*`). -- **`master_timeout` (Optional, string \| -1 \| 0)**: The period to wait for the master node. -If the master node is not available before the timeout expires, the request fails and returns an error. -To indicate that the request should never timeout, set it to `-1`. - -## client.snapshot.deleteRepository [_snapshot.delete_repository] -Delete snapshot repositories. -When a repository is unregistered, Elasticsearch removes only the reference to the location where the repository is storing the snapshots. -The snapshots themselves are left untouched and in place. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-delete-repository) - -```ts -client.snapshot.deleteRepository({ repository }) -``` - -### Arguments [_arguments_snapshot.delete_repository] - -#### Request (object) [_request_snapshot.delete_repository] -- **`repository` (string \| string[])**: The ame of the snapshot repositories to unregister. -Wildcard (`*`) patterns are supported. -- **`master_timeout` (Optional, string \| -1 \| 0)**: The period to wait for the master node. -If the master node is not available before the timeout expires, the request fails and returns an error. -To indicate that the request should never timeout, set it to `-1`. -- **`timeout` (Optional, string \| -1 \| 0)**: The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata. -If no response is received before the timeout expires, the cluster metadata update still applies but the response will indicate that it was not completely acknowledged. -To indicate that the request should never timeout, set it to `-1`. - -## client.snapshot.get [_snapshot.get] -Get snapshot information. - -NOTE: The `after` parameter and `next` field enable you to iterate through snapshots with some consistency guarantees regarding concurrent creation or deletion of snapshots. -It is guaranteed that any snapshot that exists at the beginning of the iteration and is not concurrently deleted will be seen during the iteration. -Snapshots concurrently created may be seen during an iteration. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-get) - -```ts -client.snapshot.get({ repository, snapshot }) -``` - -### Arguments [_arguments_snapshot.get] - -#### Request (object) [_request_snapshot.get] -- **`repository` (string)**: A list of snapshot repository names used to limit the request. -Wildcard (`*`) expressions are supported. -- **`snapshot` (string \| string[])**: A list of snapshot names to retrieve -Wildcards (`*`) are supported. - -* To get information about all snapshots in a registered repository, use a wildcard (`*`) or `_all`. -* To get information about any snapshots that are currently running, use `_current`. -- **`after` (Optional, string)**: An offset identifier to start pagination from as returned by the next field in the response body. -- **`from_sort_value` (Optional, string)**: The value of the current sort column at which to start retrieval. -It can be a string `snapshot-` or a repository name when sorting by snapshot or repository name. -It can be a millisecond time value or a number when sorting by `index-` or shard count. -- **`ignore_unavailable` (Optional, boolean)**: If `false`, the request returns an error for any snapshots that are unavailable. -- **`index_details` (Optional, boolean)**: If `true`, the response includes additional information about each index in the snapshot comprising the number of shards in the index, the total size of the index in bytes, and the maximum number of segments per shard in the index. -The default is `false`, meaning that this information is omitted. -- **`index_names` (Optional, boolean)**: If `true`, the response includes the name of each index in each snapshot. -- **`include_repository` (Optional, boolean)**: If `true`, the response includes the repository name in each snapshot. -- **`master_timeout` (Optional, string \| -1 \| 0)**: The period to wait for a connection to the master node. -If no response is received before the timeout expires, the request fails and returns an error. -- **`order` (Optional, Enum("asc" \| "desc"))**: The sort order. -Valid values are `asc` for ascending and `desc` for descending order. -The default behavior is ascending order. -- **`offset` (Optional, number)**: Numeric offset to start pagination from based on the snapshots matching this request. Using a non-zero value for this parameter is mutually exclusive with using the after parameter. Defaults to 0. -- **`size` (Optional, number)**: The maximum number of snapshots to return. -The default is 0, which means to return all that match the request without limit. -- **`slm_policy_filter` (Optional, string)**: Filter snapshots by a list of snapshot lifecycle management (SLM) policy names that snapshots belong to. - -You can use wildcards (`*`) and combinations of wildcards followed by exclude patterns starting with `-`. -For example, the pattern `*,-policy-a-\*` will return all snapshots except for those that were created by an SLM policy with a name starting with `policy-a-`. -Note that the wildcard pattern `*` matches all snapshots created by an SLM policy but not those snapshots that were not created by an SLM policy. -To include snapshots that were not created by an SLM policy, you can use the special pattern `_none` that will match all snapshots without an SLM policy. -- **`sort` (Optional, Enum("start_time" \| "duration" \| "name" \| "index_count" \| "repository" \| "shard_count" \| "failed_shard_count"))**: The sort order for the result. -The default behavior is sorting by snapshot start time stamp. -- **`verbose` (Optional, boolean)**: If `true`, returns additional information about each snapshot such as the version of Elasticsearch which took the snapshot, the start and end times of the snapshot, and the number of shards snapshotted. - -NOTE: The parameters `size`, `order`, `after`, `from_sort_value`, `offset`, `slm_policy_filter`, and `sort` are not supported when you set `verbose=false` and the sort order for requests with `verbose=false` is undefined. - -## client.snapshot.getRepository [_snapshot.get_repository] -Get snapshot repository information. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-get-repository) - -```ts -client.snapshot.getRepository({ ... }) -``` - -### Arguments [_arguments_snapshot.get_repository] - -#### Request (object) [_request_snapshot.get_repository] -- **`repository` (Optional, string \| string[])**: A list of snapshot repository names used to limit the request. -Wildcard (`*`) expressions are supported including combining wildcards with exclude patterns starting with `-`. - -To get information about all snapshot repositories registered in the cluster, omit this parameter or use `*` or `_all`. -- **`local` (Optional, boolean)**: If `true`, the request gets information from the local node only. -If `false`, the request gets information from the master node. -- **`master_timeout` (Optional, string \| -1 \| 0)**: The period to wait for the master node. -If the master node is not available before the timeout expires, the request fails and returns an error. -To indicate that the request should never timeout, set it to `-1`. - -## client.snapshot.repositoryAnalyze [_snapshot.repository_analyze] -Analyze a snapshot repository. -Analyze the performance characteristics and any incorrect behaviour found in a repository. - -The response exposes implementation details of the analysis which may change from version to version. -The response body format is therefore not considered stable and may be different in newer versions. - -There are a large number of third-party storage systems available, not all of which are suitable for use as a snapshot repository by Elasticsearch. -Some storage systems behave incorrectly, or perform poorly, especially when accessed concurrently by multiple clients as the nodes of an Elasticsearch cluster do. This API performs a collection of read and write operations on your repository which are designed to detect incorrect behaviour and to measure the performance characteristics of your storage system. - -The default values for the parameters are deliberately low to reduce the impact of running an analysis inadvertently and to provide a sensible starting point for your investigations. -Run your first analysis with the default parameter values to check for simple problems. -If successful, run a sequence of increasingly large analyses until you encounter a failure or you reach a `blob_count` of at least `2000`, a `max_blob_size` of at least `2gb`, a `max_total_data_size` of at least `1tb`, and a `register_operation_count` of at least `100`. -Always specify a generous timeout, possibly `1h` or longer, to allow time for each analysis to run to completion. -Perform the analyses using a multi-node cluster of a similar size to your production cluster so that it can detect any problems that only arise when the repository is accessed by many nodes at once. - -If the analysis fails, Elasticsearch detected that your repository behaved unexpectedly. -This usually means you are using a third-party storage system with an incorrect or incompatible implementation of the API it claims to support. -If so, this storage system is not suitable for use as a snapshot repository. -You will need to work with the supplier of your storage system to address the incompatibilities that Elasticsearch detects. - -If the analysis is successful, the API returns details of the testing process, optionally including how long each operation took. -You can use this information to determine the performance of your storage system. -If any operation fails or returns an incorrect result, the API returns an error. -If the API returns an error, it may not have removed all the data it wrote to the repository. -The error will indicate the location of any leftover data and this path is also recorded in the Elasticsearch logs. -You should verify that this location has been cleaned up correctly. -If there is still leftover data at the specified location, you should manually remove it. - -If the connection from your client to Elasticsearch is closed while the client is waiting for the result of the analysis, the test is cancelled. -Some clients are configured to close their connection if no response is received within a certain timeout. -An analysis takes a long time to complete so you might need to relax any such client-side timeouts. -On cancellation the analysis attempts to clean up the data it was writing, but it may not be able to remove it all. -The path to the leftover data is recorded in the Elasticsearch logs. -You should verify that this location has been cleaned up correctly. -If there is still leftover data at the specified location, you should manually remove it. - -If the analysis is successful then it detected no incorrect behaviour, but this does not mean that correct behaviour is guaranteed. -The analysis attempts to detect common bugs but it does not offer 100% coverage. -Additionally, it does not test the following: - -* Your repository must perform durable writes. Once a blob has been written it must remain in place until it is deleted, even after a power loss or similar disaster. -* Your repository must not suffer from silent data corruption. Once a blob has been written, its contents must remain unchanged until it is deliberately modified or deleted. -* Your repository must behave correctly even if connectivity from the cluster is disrupted. Reads and writes may fail in this case, but they must not return incorrect results. - -IMPORTANT: An analysis writes a substantial amount of data to your repository and then reads it back again. -This consumes bandwidth on the network between the cluster and the repository, and storage space and I/O bandwidth on the repository itself. -You must ensure this load does not affect other users of these systems. -Analyses respect the repository settings `max_snapshot_bytes_per_sec` and `max_restore_bytes_per_sec` if available and the cluster setting `indices.recovery.max_bytes_per_sec` which you can use to limit the bandwidth they consume. - -NOTE: This API is intended for exploratory use by humans. You should expect the request parameters and the response format to vary in future versions. - -NOTE: Different versions of Elasticsearch may perform different checks for repository compatibility, with newer versions typically being stricter than older ones. -A storage system that passes repository analysis with one version of Elasticsearch may fail with a different version. -This indicates it behaves incorrectly in ways that the former version did not detect. -You must work with the supplier of your storage system to address the incompatibilities detected by the repository analysis API in any version of Elasticsearch. - -NOTE: This API may not work correctly in a mixed-version cluster. - -*Implementation details* - -NOTE: This section of documentation describes how the repository analysis API works in this version of Elasticsearch, but you should expect the implementation to vary between versions. The request parameters and response format depend on details of the implementation so may also be different in newer versions. - -The analysis comprises a number of blob-level tasks, as set by the `blob_count` parameter and a number of compare-and-exchange operations on linearizable registers, as set by the `register_operation_count` parameter. -These tasks are distributed over the data and master-eligible nodes in the cluster for execution. - -For most blob-level tasks, the executing node first writes a blob to the repository and then instructs some of the other nodes in the cluster to attempt to read the data it just wrote. -The size of the blob is chosen randomly, according to the `max_blob_size` and `max_total_data_size` parameters. -If any of these reads fails then the repository does not implement the necessary read-after-write semantics that Elasticsearch requires. - -For some blob-level tasks, the executing node will instruct some of its peers to attempt to read the data before the writing process completes. -These reads are permitted to fail, but must not return partial data. -If any read returns partial data then the repository does not implement the necessary atomicity semantics that Elasticsearch requires. - -For some blob-level tasks, the executing node will overwrite the blob while its peers are reading it. -In this case the data read may come from either the original or the overwritten blob, but the read operation must not return partial data or a mix of data from the two blobs. -If any of these reads returns partial data or a mix of the two blobs then the repository does not implement the necessary atomicity semantics that Elasticsearch requires for overwrites. - -The executing node will use a variety of different methods to write the blob. -For instance, where applicable, it will use both single-part and multi-part uploads. -Similarly, the reading nodes will use a variety of different methods to read the data back again. -For instance they may read the entire blob from start to end or may read only a subset of the data. - -For some blob-level tasks, the executing node will cancel the write before it is complete. -In this case, it still instructs some of the other nodes in the cluster to attempt to read the blob but all of these reads must fail to find the blob. - -Linearizable registers are special blobs that Elasticsearch manipulates using an atomic compare-and-exchange operation. -This operation ensures correct and strongly-consistent behavior even when the blob is accessed by multiple nodes at the same time. -The detailed implementation of the compare-and-exchange operation on linearizable registers varies by repository type. -Repository analysis verifies that that uncontended compare-and-exchange operations on a linearizable register blob always succeed. -Repository analysis also verifies that contended operations either succeed or report the contention but do not return incorrect results. -If an operation fails due to contention, Elasticsearch retries the operation until it succeeds. -Most of the compare-and-exchange operations performed by repository analysis atomically increment a counter which is represented as an 8-byte blob. -Some operations also verify the behavior on small blobs with sizes other than 8 bytes. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-repository-analyze) - -```ts -client.snapshot.repositoryAnalyze({ repository }) -``` - -### Arguments [_arguments_snapshot.repository_analyze] - -#### Request (object) [_request_snapshot.repository_analyze] -- **`repository` (string)**: The name of the repository. -- **`blob_count` (Optional, number)**: The total number of blobs to write to the repository during the test. -For realistic experiments, you should set it to at least `2000`. -- **`concurrency` (Optional, number)**: The number of operations to run concurrently during the test. -- **`detailed` (Optional, boolean)**: Indicates whether to return detailed results, including timing information for every operation performed during the analysis. -If false, it returns only a summary of the analysis. -- **`early_read_node_count` (Optional, number)**: The number of nodes on which to perform an early read operation while writing each blob. -Early read operations are only rarely performed. -- **`max_blob_size` (Optional, number \| string)**: The maximum size of a blob to be written during the test. -For realistic experiments, you should set it to at least `2gb`. -- **`max_total_data_size` (Optional, number \| string)**: An upper limit on the total size of all the blobs written during the test. -For realistic experiments, you should set it to at least `1tb`. -- **`rare_action_probability` (Optional, number)**: The probability of performing a rare action such as an early read, an overwrite, or an aborted write on each blob. -- **`rarely_abort_writes` (Optional, boolean)**: Indicates whether to rarely cancel writes before they complete. -- **`read_node_count` (Optional, number)**: The number of nodes on which to read a blob after writing. -- **`register_operation_count` (Optional, number)**: The minimum number of linearizable register operations to perform in total. -For realistic experiments, you should set it to at least `100`. -- **`seed` (Optional, number)**: The seed for the pseudo-random number generator used to generate the list of operations performed during the test. -To repeat the same set of operations in multiple experiments, use the same seed in each experiment. -Note that the operations are performed concurrently so might not always happen in the same order on each run. -- **`timeout` (Optional, string \| -1 \| 0)**: The period of time to wait for the test to complete. -If no response is received before the timeout expires, the test is cancelled and returns an error. - -## client.snapshot.restore [_snapshot.restore] -Restore a snapshot. -Restore a snapshot of a cluster or data streams and indices. - -You can restore a snapshot only to a running cluster with an elected master node. -The snapshot repository must be registered and available to the cluster. -The snapshot and cluster versions must be compatible. - -To restore a snapshot, the cluster's global metadata must be writable. Ensure there are't any cluster blocks that prevent writes. The restore operation ignores index blocks. - -Before you restore a data stream, ensure the cluster contains a matching index template with data streams enabled. To check, use the index management feature in Kibana or the get index template API: - -``` -GET _index_template/*?filter_path=index_templates.name,index_templates.index_template.index_patterns,index_templates.index_template.data_stream -``` - -If no such template exists, you can create one or restore a cluster state that contains one. Without a matching index template, a data stream can't roll over or create backing indices. - -If your snapshot contains data from App Search or Workplace Search, you must restore the Enterprise Search encryption key before you restore the snapshot. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-restore) - -```ts -client.snapshot.restore({ repository, snapshot }) -``` - -### Arguments [_arguments_snapshot.restore] - -#### Request (object) [_request_snapshot.restore] -- **`repository` (string)**: The name of the repository to restore a snapshot from. -- **`snapshot` (string)**: The name of the snapshot to restore. -- **`feature_states` (Optional, string[])**: The feature states to restore. -If `include_global_state` is `true`, the request restores all feature states in the snapshot by default. -If `include_global_state` is `false`, the request restores no feature states by default. -Note that specifying an empty array will result in the default behavior. -To restore no feature states, regardless of the `include_global_state` value, specify an array containing only the value `none` (`["none"]`). -- **`ignore_index_settings` (Optional, string[])**: The index settings to not restore from the snapshot. -You can't use this option to ignore `index.number_of_shards`. - -For data streams, this option applies only to restored backing indices. -New backing indices are configured using the data stream's matching index template. -- **`ignore_unavailable` (Optional, boolean)**: If `true`, the request ignores any index or data stream in indices that's missing from the snapshot. -If `false`, the request returns an error for any missing index or data stream. -- **`include_aliases` (Optional, boolean)**: If `true`, the request restores aliases for any restored data streams and indices. -If `false`, the request doesn’t restore aliases. -- **`include_global_state` (Optional, boolean)**: If `true`, restore the cluster state. The cluster state includes: - -* Persistent cluster settings -* Index templates -* Legacy index templates -* Ingest pipelines -* Index lifecycle management (ILM) policies -* Stored scripts -* For snapshots taken after 7.12.0, feature states - -If `include_global_state` is `true`, the restore operation merges the legacy index templates in your cluster with the templates contained in the snapshot, replacing any existing ones whose name matches one in the snapshot. -It completely removes all persistent settings, non-legacy index templates, ingest pipelines, and ILM lifecycle policies that exist in your cluster and replaces them with the corresponding items from the snapshot. - -Use the `feature_states` parameter to configure how feature states are restored. - -If `include_global_state` is `true` and a snapshot was created without a global state then the restore request will fail. -- **`index_settings` (Optional, { index, mode, routing_path, soft_deletes, sort, number_of_shards, number_of_replicas, number_of_routing_shards, check_on_startup, codec, routing_partition_size, load_fixed_bitset_filters_eagerly, hidden, auto_expand_replicas, merge, search, refresh_interval, max_result_window, max_inner_result_window, max_rescore_window, max_docvalue_fields_search, max_script_fields, max_ngram_diff, max_shingle_diff, blocks, max_refresh_listeners, analyze, highlight, max_terms_count, max_regex_length, routing, gc_deletes, default_pipeline, final_pipeline, lifecycle, provided_name, creation_date, creation_date_string, uuid, version, verified_before_close, format, max_slices_per_scroll, translog, query_string, priority, top_metrics_max_size, analysis, settings, time_series, queries, similarity, mapping, indexing.slowlog, indexing_pressure, store })**: Index settings to add or change in restored indices, including backing indices. -You can't use this option to change `index.number_of_shards`. - -For data streams, this option applies only to restored backing indices. -New backing indices are configured using the data stream's matching index template. -- **`indices` (Optional, string \| string[])**: A list of indices and data streams to restore. -It supports a multi-target syntax. -The default behavior is all regular indices and regular data streams in the snapshot. - -You can't use this parameter to restore system indices or system data streams. -Use `feature_states` instead. -- **`partial` (Optional, boolean)**: If `false`, the entire restore operation will fail if one or more indices included in the snapshot do not have all primary shards available. - -If true, it allows restoring a partial snapshot of indices with unavailable shards. -Only shards that were successfully included in the snapshot will be restored. -All missing shards will be recreated as empty. -- **`rename_pattern` (Optional, string)**: A rename pattern to apply to restored data streams and indices. -Data streams and indices matching the rename pattern will be renamed according to `rename_replacement`. - -The rename pattern is applied as defined by the regular expression that supports referencing the original text, according to the `appendReplacement` logic. -- **`rename_replacement` (Optional, string)**: The rename replacement string that is used with the `rename_pattern`. -- **`master_timeout` (Optional, string \| -1 \| 0)**: The period to wait for the master node. -If the master node is not available before the timeout expires, the request fails and returns an error. -To indicate that the request should never timeout, set it to `-1`. -- **`wait_for_completion` (Optional, boolean)**: If `true`, the request returns a response when the restore operation completes. -The operation is complete when it finishes all attempts to recover primary shards for restored indices. -This applies even if one or more of the recovery attempts fail. - -If `false`, the request returns a response when the restore operation initializes. - -## client.snapshot.status [_snapshot.status] -Get the snapshot status. -Get a detailed description of the current state for each shard participating in the snapshot. - -Note that this API should be used only to obtain detailed shard-level information for ongoing snapshots. -If this detail is not needed or you want to obtain information about one or more existing snapshots, use the get snapshot API. - -If you omit the `` request path parameter, the request retrieves information only for currently running snapshots. -This usage is preferred. -If needed, you can specify `` and `` to retrieve information for specific snapshots, even if they're not currently running. - -WARNING: Using the API to return the status of any snapshots other than currently running snapshots can be expensive. -The API requires a read from the repository for each shard in each snapshot. -For example, if you have 100 snapshots with 1,000 shards each, an API request that includes all snapshots will require 100,000 reads (100 snapshots x 1,000 shards). - -Depending on the latency of your storage, such requests can take an extremely long time to return results. -These requests can also tax machine resources and, when using cloud storage, incur high processing costs. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-status) - -```ts -client.snapshot.status({ ... }) -``` - -### Arguments [_arguments_snapshot.status] - -#### Request (object) [_request_snapshot.status] -- **`repository` (Optional, string)**: The snapshot repository name used to limit the request. -It supports wildcards (`*`) if `` isn't specified. -- **`snapshot` (Optional, string \| string[])**: A list of snapshots to retrieve status for. -The default is currently running snapshots. -Wildcards (`*`) are not supported. -- **`ignore_unavailable` (Optional, boolean)**: If `false`, the request returns an error for any snapshots that are unavailable. -If `true`, the request ignores snapshots that are unavailable, such as those that are corrupted or temporarily cannot be returned. -- **`master_timeout` (Optional, string \| -1 \| 0)**: The period to wait for the master node. -If the master node is not available before the timeout expires, the request fails and returns an error. -To indicate that the request should never timeout, set it to `-1`. - -## client.snapshot.verifyRepository [_snapshot.verify_repository] -Verify a snapshot repository. -Check for common misconfigurations in a snapshot repository. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-verify-repository) - -```ts -client.snapshot.verifyRepository({ repository }) -``` - -### Arguments [_arguments_snapshot.verify_repository] - -#### Request (object) [_request_snapshot.verify_repository] -- **`repository` (string)**: The name of the snapshot repository to verify. -- **`master_timeout` (Optional, string \| -1 \| 0)**: The period to wait for the master node. -If the master node is not available before the timeout expires, the request fails and returns an error. -To indicate that the request should never timeout, set it to `-1`. -- **`timeout` (Optional, string \| -1 \| 0)**: The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata. -If no response is received before the timeout expires, the cluster metadata update still applies but the response will indicate that it was not completely acknowledged. -To indicate that the request should never timeout, set it to `-1`. - -## client.sql.clearCursor [_sql.clear_cursor] -Clear an SQL search cursor. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-sql-clear-cursor) - -```ts -client.sql.clearCursor({ cursor }) -``` - -### Arguments [_arguments_sql.clear_cursor] - -#### Request (object) [_request_sql.clear_cursor] -- **`cursor` (string)**: Cursor to clear. - -## client.sql.deleteAsync [_sql.delete_async] -Delete an async SQL search. -Delete an async SQL search or a stored synchronous SQL search. -If the search is still running, the API cancels it. - -If the Elasticsearch security features are enabled, only the following users can use this API to delete a search: - -* Users with the `cancel_task` cluster privilege. -* The user who first submitted the search. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-sql-delete-async) - -```ts -client.sql.deleteAsync({ id }) -``` - -### Arguments [_arguments_sql.delete_async] - -#### Request (object) [_request_sql.delete_async] -- **`id` (string)**: The identifier for the search. - -## client.sql.getAsync [_sql.get_async] -Get async SQL search results. -Get the current status and available results for an async SQL search or stored synchronous SQL search. - -If the Elasticsearch security features are enabled, only the user who first submitted the SQL search can retrieve the search using this API. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-sql-get-async) - -```ts -client.sql.getAsync({ id }) -``` - -### Arguments [_arguments_sql.get_async] - -#### Request (object) [_request_sql.get_async] -- **`id` (string)**: The identifier for the search. -- **`delimiter` (Optional, string)**: The separator for CSV results. -The API supports this parameter only for CSV responses. -- **`format` (Optional, string)**: The format for the response. -You must specify a format using this parameter or the `Accept` HTTP header. -If you specify both, the API uses this parameter. -- **`keep_alive` (Optional, string \| -1 \| 0)**: The retention period for the search and its results. -It defaults to the `keep_alive` period for the original SQL search. -- **`wait_for_completion_timeout` (Optional, string \| -1 \| 0)**: The period to wait for complete results. -It defaults to no timeout, meaning the request waits for complete search results. - -## client.sql.getAsyncStatus [_sql.get_async_status] -Get the async SQL search status. -Get the current status of an async SQL search or a stored synchronous SQL search. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-sql-get-async-status) - -```ts -client.sql.getAsyncStatus({ id }) -``` - -### Arguments [_arguments_sql.get_async_status] - -#### Request (object) [_request_sql.get_async_status] -- **`id` (string)**: The identifier for the search. - -## client.sql.query [_sql.query] -Get SQL search results. -Run an SQL request. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-sql-query) - -```ts -client.sql.query({ ... }) -``` - -### Arguments [_arguments_sql.query] - -#### Request (object) [_request_sql.query] -- **`allow_partial_search_results` (Optional, boolean)**: If `true`, the response has partial results when there are shard request timeouts or shard failures. -If `false`, the API returns an error with no partial results. -- **`catalog` (Optional, string)**: The default catalog (cluster) for queries. -If unspecified, the queries execute on the data in the local cluster only. -- **`columnar` (Optional, boolean)**: If `true`, the results are in a columnar fashion: one row represents all the values of a certain column from the current page of results. -The API supports this parameter only for CBOR, JSON, SMILE, and YAML responses. -- **`cursor` (Optional, string)**: The cursor used to retrieve a set of paginated results. -If you specify a cursor, the API only uses the `columnar` and `time_zone` request body parameters. -It ignores other request body parameters. -- **`fetch_size` (Optional, number)**: The maximum number of rows (or entries) to return in one response. -- **`field_multi_value_leniency` (Optional, boolean)**: If `false`, the API returns an exception when encountering multiple values for a field. -If `true`, the API is lenient and returns the first value from the array with no guarantee of consistent results. -- **`filter` (Optional, { bool, boosting, common, combined_fields, constant_score, dis_max, distance_feature, exists, function_score, fuzzy, geo_bounding_box, geo_distance, geo_grid, geo_polygon, geo_shape, has_child, has_parent, ids, intervals, knn, match, match_all, match_bool_prefix, match_none, match_phrase, match_phrase_prefix, more_like_this, multi_match, nested, parent_id, percolate, pinned, prefix, query_string, range, rank_feature, regexp, rule, script, script_score, semantic, shape, simple_query_string, span_containing, span_field_masking, span_first, span_multi, span_near, span_not, span_or, span_term, span_within, sparse_vector, term, terms, terms_set, text_expansion, weighted_tokens, wildcard, wrapper, type })**: The Elasticsearch query DSL for additional filtering. -- **`index_using_frozen` (Optional, boolean)**: If `true`, the search can run on frozen indices. -- **`keep_alive` (Optional, string \| -1 \| 0)**: The retention period for an async or saved synchronous search. -- **`keep_on_completion` (Optional, boolean)**: If `true`, Elasticsearch stores synchronous searches if you also specify the `wait_for_completion_timeout` parameter. -If `false`, Elasticsearch only stores async searches that don't finish before the `wait_for_completion_timeout`. -- **`page_timeout` (Optional, string \| -1 \| 0)**: The minimum retention period for the scroll cursor. -After this time period, a pagination request might fail because the scroll cursor is no longer available. -Subsequent scroll requests prolong the lifetime of the scroll cursor by the duration of `page_timeout` in the scroll request. -- **`params` (Optional, Record)**: The values for parameters in the query. -- **`query` (Optional, string)**: The SQL query to run. -- **`request_timeout` (Optional, string \| -1 \| 0)**: The timeout before the request fails. -- **`runtime_mappings` (Optional, Record)**: One or more runtime fields for the search request. -These fields take precedence over mapped fields with the same name. -- **`time_zone` (Optional, string)**: The ISO-8601 time zone ID for the search. -- **`wait_for_completion_timeout` (Optional, string \| -1 \| 0)**: The period to wait for complete results. -It defaults to no timeout, meaning the request waits for complete search results. -If the search doesn't finish within this period, the search becomes async. - -To save a synchronous search, you must specify this parameter and the `keep_on_completion` parameter. -- **`format` (Optional, Enum("csv" \| "json" \| "tsv" \| "txt" \| "yaml" \| "cbor" \| "smile"))**: The format for the response. -You can also specify a format using the `Accept` HTTP header. -If you specify both this parameter and the `Accept` HTTP header, this parameter takes precedence. - -## client.sql.translate [_sql.translate] -Translate SQL into Elasticsearch queries. -Translate an SQL search into a search API request containing Query DSL. -It accepts the same request body parameters as the SQL search API, excluding `cursor`. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-sql-translate) - -```ts -client.sql.translate({ query }) -``` - -### Arguments [_arguments_sql.translate] - -#### Request (object) [_request_sql.translate] -- **`query` (string)**: The SQL query to run. -- **`fetch_size` (Optional, number)**: The maximum number of rows (or entries) to return in one response. -- **`filter` (Optional, { bool, boosting, common, combined_fields, constant_score, dis_max, distance_feature, exists, function_score, fuzzy, geo_bounding_box, geo_distance, geo_grid, geo_polygon, geo_shape, has_child, has_parent, ids, intervals, knn, match, match_all, match_bool_prefix, match_none, match_phrase, match_phrase_prefix, more_like_this, multi_match, nested, parent_id, percolate, pinned, prefix, query_string, range, rank_feature, regexp, rule, script, script_score, semantic, shape, simple_query_string, span_containing, span_field_masking, span_first, span_multi, span_near, span_not, span_or, span_term, span_within, sparse_vector, term, terms, terms_set, text_expansion, weighted_tokens, wildcard, wrapper, type })**: The Elasticsearch query DSL for additional filtering. -- **`time_zone` (Optional, string)**: The ISO-8601 time zone ID for the search. - -## client.ssl.certificates [_ssl.certificates] -Get SSL certificates. - -Get information about the X.509 certificates that are used to encrypt communications in the cluster. -The API returns a list that includes certificates from all TLS contexts including: - -- Settings for transport and HTTP interfaces -- TLS settings that are used within authentication realms -- TLS settings for remote monitoring exporters - -The list includes certificates that are used for configuring trust, such as those configured in the `xpack.security.transport.ssl.truststore` and `xpack.security.transport.ssl.certificate_authorities` settings. -It also includes certificates that are used for configuring server identity, such as `xpack.security.http.ssl.keystore` and `xpack.security.http.ssl.certificate settings`. - -The list does not include certificates that are sourced from the default SSL context of the Java Runtime Environment (JRE), even if those certificates are in use within Elasticsearch. - -NOTE: When a PKCS#11 token is configured as the truststore of the JRE, the API returns all the certificates that are included in the PKCS#11 token irrespective of whether these are used in the Elasticsearch TLS configuration. - -If Elasticsearch is configured to use a keystore or truststore, the API output includes all certificates in that store, even though some of the certificates might not be in active use within the cluster. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ssl-certificates) - -```ts -client.ssl.certificates() -``` - - -## client.synonyms.deleteSynonym [_synonyms.delete_synonym] -Delete a synonym set. - -You can only delete a synonyms set that is not in use by any index analyzer. - -Synonyms sets can be used in synonym graph token filters and synonym token filters. -These synonym filters can be used as part of search analyzers. - -Analyzers need to be loaded when an index is restored (such as when a node starts, or the index becomes open). -Even if the analyzer is not used on any field mapping, it still needs to be loaded on the index recovery phase. - -If any analyzers cannot be loaded, the index becomes unavailable and the cluster status becomes red or yellow as index shards are not available. -To prevent that, synonyms sets that are used in analyzers can't be deleted. -A delete request in this case will return a 400 response code. - -To remove a synonyms set, you must first remove all indices that contain analyzers using it. -You can migrate an index by creating a new index that does not contain the token filter with the synonyms set, and use the reindex API in order to copy over the index data. -Once finished, you can delete the index. -When the synonyms set is not used in analyzers, you will be able to delete it. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-synonyms-delete-synonym) - -```ts -client.synonyms.deleteSynonym({ id }) -``` - -### Arguments [_arguments_synonyms.delete_synonym] - -#### Request (object) [_request_synonyms.delete_synonym] -- **`id` (string)**: The synonyms set identifier to delete. - -## client.synonyms.deleteSynonymRule [_synonyms.delete_synonym_rule] -Delete a synonym rule. -Delete a synonym rule from a synonym set. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-synonyms-delete-synonym-rule) - -```ts -client.synonyms.deleteSynonymRule({ set_id, rule_id }) -``` - -### Arguments [_arguments_synonyms.delete_synonym_rule] - -#### Request (object) [_request_synonyms.delete_synonym_rule] -- **`set_id` (string)**: The ID of the synonym set to update. -- **`rule_id` (string)**: The ID of the synonym rule to delete. -- **`refresh` (Optional, boolean)**: If `true`, the request will refresh the analyzers with the deleted synonym rule and wait for the new synonyms to be available before returning. -If `false`, analyzers will not be reloaded with the deleted synonym rule - -## client.synonyms.getSynonym [_synonyms.get_synonym] -Get a synonym set. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-synonyms-get-synonym) - -```ts -client.synonyms.getSynonym({ id }) -``` - -### Arguments [_arguments_synonyms.get_synonym] - -#### Request (object) [_request_synonyms.get_synonym] -- **`id` (string)**: The synonyms set identifier to retrieve. -- **`from` (Optional, number)**: The starting offset for query rules to retrieve. -- **`size` (Optional, number)**: The max number of query rules to retrieve. - -## client.synonyms.getSynonymRule [_synonyms.get_synonym_rule] -Get a synonym rule. -Get a synonym rule from a synonym set. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-synonyms-get-synonym-rule) - -```ts -client.synonyms.getSynonymRule({ set_id, rule_id }) -``` - -### Arguments [_arguments_synonyms.get_synonym_rule] - -#### Request (object) [_request_synonyms.get_synonym_rule] -- **`set_id` (string)**: The ID of the synonym set to retrieve the synonym rule from. -- **`rule_id` (string)**: The ID of the synonym rule to retrieve. - -## client.synonyms.getSynonymsSets [_synonyms.get_synonyms_sets] -Get all synonym sets. -Get a summary of all defined synonym sets. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-synonyms-get-synonym) - -```ts -client.synonyms.getSynonymsSets({ ... }) -``` - -### Arguments [_arguments_synonyms.get_synonyms_sets] - -#### Request (object) [_request_synonyms.get_synonyms_sets] -- **`from` (Optional, number)**: The starting offset for synonyms sets to retrieve. -- **`size` (Optional, number)**: The maximum number of synonyms sets to retrieve. - -## client.synonyms.putSynonym [_synonyms.put_synonym] -Create or update a synonym set. -Synonyms sets are limited to a maximum of 10,000 synonym rules per set. -If you need to manage more synonym rules, you can create multiple synonym sets. - -When an existing synonyms set is updated, the search analyzers that use the synonyms set are reloaded automatically for all indices. -This is equivalent to invoking the reload search analyzers API for all indices that use the synonyms set. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-synonyms-put-synonym) - -```ts -client.synonyms.putSynonym({ id, synonyms_set }) -``` - -### Arguments [_arguments_synonyms.put_synonym] - -#### Request (object) [_request_synonyms.put_synonym] -- **`id` (string)**: The ID of the synonyms set to be created or updated. -- **`synonyms_set` ({ id, synonyms } \| { id, synonyms }[])**: The synonym rules definitions for the synonyms set. -- **`refresh` (Optional, boolean)**: If `true`, the request will refresh the analyzers with the new synonyms set and wait for the new synonyms to be available before returning. -If `false`, analyzers will not be reloaded with the new synonym set - -## client.synonyms.putSynonymRule [_synonyms.put_synonym_rule] -Create or update a synonym rule. -Create or update a synonym rule in a synonym set. - -If any of the synonym rules included is invalid, the API returns an error. - -When you update a synonym rule, all analyzers using the synonyms set will be reloaded automatically to reflect the new rule. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-synonyms-put-synonym-rule) - -```ts -client.synonyms.putSynonymRule({ set_id, rule_id, synonyms }) -``` - -### Arguments [_arguments_synonyms.put_synonym_rule] - -#### Request (object) [_request_synonyms.put_synonym_rule] -- **`set_id` (string)**: The ID of the synonym set. -- **`rule_id` (string)**: The ID of the synonym rule to be updated or created. -- **`synonyms` (string)**: The synonym rule information definition, which must be in Solr format. -- **`refresh` (Optional, boolean)**: If `true`, the request will refresh the analyzers with the new synonym rule and wait for the new synonyms to be available before returning. -If `false`, analyzers will not be reloaded with the new synonym rule - -## client.tasks.cancel [_tasks.cancel] -Cancel a task. - -WARNING: The task management API is new and should still be considered a beta feature. -The API may change in ways that are not backwards compatible. - -A task may continue to run for some time after it has been cancelled because it may not be able to safely stop its current activity straight away. -It is also possible that Elasticsearch must complete its work on other tasks before it can process the cancellation. -The get task information API will continue to list these cancelled tasks until they complete. -The cancelled flag in the response indicates that the cancellation command has been processed and the task will stop as soon as possible. - -To troubleshoot why a cancelled task does not complete promptly, use the get task information API with the `?detailed` parameter to identify the other tasks the system is running. -You can also use the node hot threads API to obtain detailed information about the work the system is doing instead of completing the cancelled task. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-tasks) - -```ts -client.tasks.cancel({ ... }) -``` - -### Arguments [_arguments_tasks.cancel] - -#### Request (object) [_request_tasks.cancel] -- **`task_id` (Optional, string \| number)**: The task identifier. -- **`actions` (Optional, string \| string[])**: A list or wildcard expression of actions that is used to limit the request. -- **`nodes` (Optional, string[])**: A list of node IDs or names that is used to limit the request. -- **`parent_task_id` (Optional, string)**: A parent task ID that is used to limit the tasks. -- **`wait_for_completion` (Optional, boolean)**: If true, the request blocks until all found tasks are complete. - -## client.tasks.get [_tasks.get] -Get task information. -Get information about a task currently running in the cluster. - -WARNING: The task management API is new and should still be considered a beta feature. -The API may change in ways that are not backwards compatible. - -If the task identifier is not found, a 404 response code indicates that there are no resources that match the request. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-tasks) - -```ts -client.tasks.get({ task_id }) -``` - -### Arguments [_arguments_tasks.get] - -#### Request (object) [_request_tasks.get] -- **`task_id` (string)**: The task identifier. -- **`timeout` (Optional, string \| -1 \| 0)**: The period to wait for a response. -If no response is received before the timeout expires, the request fails and returns an error. -- **`wait_for_completion` (Optional, boolean)**: If `true`, the request blocks until the task has completed. - -## client.tasks.list [_tasks.list] -Get all tasks. -Get information about the tasks currently running on one or more nodes in the cluster. - -WARNING: The task management API is new and should still be considered a beta feature. -The API may change in ways that are not backwards compatible. - -**Identifying running tasks** - -The `X-Opaque-Id header`, when provided on the HTTP request header, is going to be returned as a header in the response as well as in the headers field for in the task information. -This enables you to track certain calls or associate certain tasks with the client that started them. -For example: - -``` -curl -i -H "X-Opaque-Id: 123456" "http://localhost:9200/_tasks?group_by=parents" -``` - -The API returns the following result: - -``` -HTTP/1.1 200 OK -X-Opaque-Id: 123456 -content-type: application/json; charset=UTF-8 -content-length: 831 - -{ - "tasks" : { - "u5lcZHqcQhu-rUoFaqDphA:45" : { - "node" : "u5lcZHqcQhu-rUoFaqDphA", - "id" : 45, - "type" : "transport", - "action" : "cluster:monitor/tasks/lists", - "start_time_in_millis" : 1513823752749, - "running_time_in_nanos" : 293139, - "cancellable" : false, - "headers" : { - "X-Opaque-Id" : "123456" - }, - "children" : [ - { - "node" : "u5lcZHqcQhu-rUoFaqDphA", - "id" : 46, - "type" : "direct", - "action" : "cluster:monitor/tasks/lists[n]", - "start_time_in_millis" : 1513823752750, - "running_time_in_nanos" : 92133, - "cancellable" : false, - "parent_task_id" : "u5lcZHqcQhu-rUoFaqDphA:45", - "headers" : { - "X-Opaque-Id" : "123456" - } - } - ] - } - } - } -``` -In this example, `X-Opaque-Id: 123456` is the ID as a part of the response header. -The `X-Opaque-Id` in the task `headers` is the ID for the task that was initiated by the REST request. -The `X-Opaque-Id` in the children `headers` is the child task of the task that was initiated by the REST request. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-tasks) - -```ts -client.tasks.list({ ... }) -``` - -### Arguments [_arguments_tasks.list] - -#### Request (object) [_request_tasks.list] -- **`actions` (Optional, string \| string[])**: A list or wildcard expression of actions used to limit the request. -For example, you can use `cluser:*` to retrieve all cluster-related tasks. -- **`detailed` (Optional, boolean)**: If `true`, the response includes detailed information about the running tasks. -This information is useful to distinguish tasks from each other but is more costly to run. -- **`group_by` (Optional, Enum("nodes" \| "parents" \| "none"))**: A key that is used to group tasks in the response. -The task lists can be grouped either by nodes or by parent tasks. -- **`nodes` (Optional, string \| string[])**: A list of node IDs or names that is used to limit the returned information. -- **`parent_task_id` (Optional, string)**: A parent task identifier that is used to limit returned information. -To return all tasks, omit this parameter or use a value of `-1`. -If the parent task is not found, the API does not return a 404 response code. -- **`timeout` (Optional, string \| -1 \| 0)**: The period to wait for each node to respond. -If a node does not respond before its timeout expires, the response does not include its information. -However, timed out nodes are included in the `node_failures` property. -- **`wait_for_completion` (Optional, boolean)**: If `true`, the request blocks until the operation is complete. - -## client.textStructure.findFieldStructure [_text_structure.find_field_structure] -Find the structure of a text field. -Find the structure of a text field in an Elasticsearch index. - -This API provides a starting point for extracting further information from log messages already ingested into Elasticsearch. -For example, if you have ingested data into a very simple index that has just `@timestamp` and message fields, you can use this API to see what common structure exists in the message field. - -The response from the API contains: - -* Sample messages. -* Statistics that reveal the most common values for all fields detected within the text and basic numeric statistics for numeric fields. -* Information about the structure of the text, which is useful when you write ingest configurations to index it or similarly formatted text. -* Appropriate mappings for an Elasticsearch index, which you could use to ingest the text. - -All this information can be calculated by the structure finder with no guidance. -However, you can optionally override some of the decisions about the text structure by specifying one or more query parameters. - -If the structure finder produces unexpected results, specify the `explain` query parameter and an explanation will appear in the response. -It helps determine why the returned structure was chosen. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-text_structure) - -```ts -client.textStructure.findFieldStructure({ field, index }) -``` - -### Arguments [_arguments_text_structure.find_field_structure] - -#### Request (object) [_request_text_structure.find_field_structure] -- **`field` (string)**: The field that should be analyzed. -- **`index` (string)**: The name of the index that contains the analyzed field. -- **`column_names` (Optional, string)**: If `format` is set to `delimited`, you can specify the column names in a list. -If this parameter is not specified, the structure finder uses the column names from the header row of the text. -If the text does not have a header row, columns are named "column1", "column2", "column3", for example. -- **`delimiter` (Optional, string)**: If you have set `format` to `delimited`, you can specify the character used to delimit the values in each row. -Only a single character is supported; the delimiter cannot have multiple characters. -By default, the API considers the following possibilities: comma, tab, semi-colon, and pipe (`|`). -In this default scenario, all rows must have the same number of fields for the delimited format to be detected. -If you specify a delimiter, up to 10% of the rows can have a different number of columns than the first row. -- **`documents_to_sample` (Optional, number)**: The number of documents to include in the structural analysis. -The minimum value is 2. -- **`ecs_compatibility` (Optional, Enum("disabled" \| "v1"))**: The mode of compatibility with ECS compliant Grok patterns. -Use this parameter to specify whether to use ECS Grok patterns instead of legacy ones when the structure finder creates a Grok pattern. -This setting primarily has an impact when a whole message Grok pattern such as `%{CATALINALOG}` matches the input. -If the structure finder identifies a common structure but has no idea of the meaning then generic field names such as `path`, `ipaddress`, `field1`, and `field2` are used in the `grok_pattern` output. -The intention in that situation is that a user who knows the meanings will rename the fields before using them. -- **`explain` (Optional, boolean)**: If `true`, the response includes a field named `explanation`, which is an array of strings that indicate how the structure finder produced its result. -- **`format` (Optional, Enum("delimited" \| "ndjson" \| "semi_structured_text" \| "xml"))**: The high level structure of the text. -By default, the API chooses the format. -In this default scenario, all rows must have the same number of fields for a delimited format to be detected. -If the format is set to delimited and the delimiter is not set, however, the API tolerates up to 5% of rows that have a different number of columns than the first row. -- **`grok_pattern` (Optional, string)**: If the format is `semi_structured_text`, you can specify a Grok pattern that is used to extract fields from every message in the text. -The name of the timestamp field in the Grok pattern must match what is specified in the `timestamp_field` parameter. -If that parameter is not specified, the name of the timestamp field in the Grok pattern must match "timestamp". -If `grok_pattern` is not specified, the structure finder creates a Grok pattern. -- **`quote` (Optional, string)**: If the format is `delimited`, you can specify the character used to quote the values in each row if they contain newlines or the delimiter character. -Only a single character is supported. -If this parameter is not specified, the default value is a double quote (`"`). -If your delimited text format does not use quoting, a workaround is to set this argument to a character that does not appear anywhere in the sample. -- **`should_trim_fields` (Optional, boolean)**: If the format is `delimited`, you can specify whether values between delimiters should have whitespace trimmed from them. -If this parameter is not specified and the delimiter is pipe (`|`), the default value is true. -Otherwise, the default value is `false`. -- **`timeout` (Optional, string \| -1 \| 0)**: The maximum amount of time that the structure analysis can take. -If the analysis is still running when the timeout expires, it will be stopped. -- **`timestamp_field` (Optional, string)**: The name of the field that contains the primary timestamp of each record in the text. -In particular, if the text was ingested into an index, this is the field that would be used to populate the `@timestamp` field. - -If the format is `semi_structured_text`, this field must match the name of the appropriate extraction in the `grok_pattern`. -Therefore, for semi-structured text, it is best not to specify this parameter unless `grok_pattern` is also specified. - -For structured text, if you specify this parameter, the field must exist within the text. - -If this parameter is not specified, the structure finder makes a decision about which field (if any) is the primary timestamp field. -For structured text, it is not compulsory to have a timestamp in the text. -- **`timestamp_format` (Optional, string)**: The Java time format of the timestamp field in the text. -Only a subset of Java time format letter groups are supported: - -* `a` -* `d` -* `dd` -* `EEE` -* `EEEE` -* `H` -* `HH` -* `h` -* `M` -* `MM` -* `MMM` -* `MMMM` -* `mm` -* `ss` -* `XX` -* `XXX` -* `yy` -* `yyyy` -* `zzz` - -Additionally `S` letter groups (fractional seconds) of length one to nine are supported providing they occur after `ss` and are separated from the `ss` by a period (`.`), comma (`,`), or colon (`:`). -Spacing and punctuation is also permitted with the exception a question mark (`?`), newline, and carriage return, together with literal text enclosed in single quotes. -For example, `MM/dd HH.mm.ss,SSSSSS 'in' yyyy` is a valid override format. - -One valuable use case for this parameter is when the format is semi-structured text, there are multiple timestamp formats in the text, and you know which format corresponds to the primary timestamp, but you do not want to specify the full `grok_pattern`. -Another is when the timestamp format is one that the structure finder does not consider by default. - -If this parameter is not specified, the structure finder chooses the best format from a built-in set. - -If the special value `null` is specified, the structure finder will not look for a primary timestamp in the text. -When the format is semi-structured text, this will result in the structure finder treating the text as single-line messages. - -## client.textStructure.findMessageStructure [_text_structure.find_message_structure] -Find the structure of text messages. -Find the structure of a list of text messages. -The messages must contain data that is suitable to be ingested into Elasticsearch. - -This API provides a starting point for ingesting data into Elasticsearch in a format that is suitable for subsequent use with other Elastic Stack functionality. -Use this API rather than the find text structure API if your input text has already been split up into separate messages by some other process. - -The response from the API contains: - -* Sample messages. -* Statistics that reveal the most common values for all fields detected within the text and basic numeric statistics for numeric fields. -* Information about the structure of the text, which is useful when you write ingest configurations to index it or similarly formatted text. -Appropriate mappings for an Elasticsearch index, which you could use to ingest the text. - -All this information can be calculated by the structure finder with no guidance. -However, you can optionally override some of the decisions about the text structure by specifying one or more query parameters. - -If the structure finder produces unexpected results, specify the `explain` query parameter and an explanation will appear in the response. -It helps determine why the returned structure was chosen. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-text-structure-find-message-structure) - -```ts -client.textStructure.findMessageStructure({ messages }) -``` - -### Arguments [_arguments_text_structure.find_message_structure] - -#### Request (object) [_request_text_structure.find_message_structure] -- **`messages` (string[])**: The list of messages you want to analyze. -- **`column_names` (Optional, string)**: If the format is `delimited`, you can specify the column names in a list. -If this parameter is not specified, the structure finder uses the column names from the header row of the text. -If the text does not have a header role, columns are named "column1", "column2", "column3", for example. -- **`delimiter` (Optional, string)**: If you the format is `delimited`, you can specify the character used to delimit the values in each row. -Only a single character is supported; the delimiter cannot have multiple characters. -By default, the API considers the following possibilities: comma, tab, semi-colon, and pipe (`|`). -In this default scenario, all rows must have the same number of fields for the delimited format to be detected. -If you specify a delimiter, up to 10% of the rows can have a different number of columns than the first row. -- **`ecs_compatibility` (Optional, Enum("disabled" \| "v1"))**: The mode of compatibility with ECS compliant Grok patterns. -Use this parameter to specify whether to use ECS Grok patterns instead of legacy ones when the structure finder creates a Grok pattern. -This setting primarily has an impact when a whole message Grok pattern such as `%{CATALINALOG}` matches the input. -If the structure finder identifies a common structure but has no idea of meaning then generic field names such as `path`, `ipaddress`, `field1`, and `field2` are used in the `grok_pattern` output, with the intention that a user who knows the meanings rename these fields before using it. -- **`explain` (Optional, boolean)**: If this parameter is set to true, the response includes a field named `explanation`, which is an array of strings that indicate how the structure finder produced its result. -- **`format` (Optional, Enum("delimited" \| "ndjson" \| "semi_structured_text" \| "xml"))**: The high level structure of the text. -By default, the API chooses the format. -In this default scenario, all rows must have the same number of fields for a delimited format to be detected. -If the format is `delimited` and the delimiter is not set, however, the API tolerates up to 5% of rows that have a different number of columns than the first row. -- **`grok_pattern` (Optional, string)**: If the format is `semi_structured_text`, you can specify a Grok pattern that is used to extract fields from every message in the text. -The name of the timestamp field in the Grok pattern must match what is specified in the `timestamp_field` parameter. -If that parameter is not specified, the name of the timestamp field in the Grok pattern must match "timestamp". -If `grok_pattern` is not specified, the structure finder creates a Grok pattern. -- **`quote` (Optional, string)**: If the format is `delimited`, you can specify the character used to quote the values in each row if they contain newlines or the delimiter character. -Only a single character is supported. -If this parameter is not specified, the default value is a double quote (`"`). -If your delimited text format does not use quoting, a workaround is to set this argument to a character that does not appear anywhere in the sample. -- **`should_trim_fields` (Optional, boolean)**: If the format is `delimited`, you can specify whether values between delimiters should have whitespace trimmed from them. -If this parameter is not specified and the delimiter is pipe (`|`), the default value is true. -Otherwise, the default value is `false`. -- **`timeout` (Optional, string \| -1 \| 0)**: The maximum amount of time that the structure analysis can take. -If the analysis is still running when the timeout expires, it will be stopped. -- **`timestamp_field` (Optional, string)**: The name of the field that contains the primary timestamp of each record in the text. -In particular, if the text was ingested into an index, this is the field that would be used to populate the `@timestamp` field. - -If the format is `semi_structured_text`, this field must match the name of the appropriate extraction in the `grok_pattern`. -Therefore, for semi-structured text, it is best not to specify this parameter unless `grok_pattern` is also specified. - -For structured text, if you specify this parameter, the field must exist within the text. - -If this parameter is not specified, the structure finder makes a decision about which field (if any) is the primary timestamp field. -For structured text, it is not compulsory to have a timestamp in the text. -- **`timestamp_format` (Optional, string)**: The Java time format of the timestamp field in the text. -Only a subset of Java time format letter groups are supported: - -* `a` -* `d` -* `dd` -* `EEE` -* `EEEE` -* `H` -* `HH` -* `h` -* `M` -* `MM` -* `MMM` -* `MMMM` -* `mm` -* `ss` -* `XX` -* `XXX` -* `yy` -* `yyyy` -* `zzz` - -Additionally `S` letter groups (fractional seconds) of length one to nine are supported providing they occur after `ss` and are separated from the `ss` by a period (`.`), comma (`,`), or colon (`:`). -Spacing and punctuation is also permitted with the exception a question mark (`?`), newline, and carriage return, together with literal text enclosed in single quotes. -For example, `MM/dd HH.mm.ss,SSSSSS 'in' yyyy` is a valid override format. - -One valuable use case for this parameter is when the format is semi-structured text, there are multiple timestamp formats in the text, and you know which format corresponds to the primary timestamp, but you do not want to specify the full `grok_pattern`. -Another is when the timestamp format is one that the structure finder does not consider by default. - -If this parameter is not specified, the structure finder chooses the best format from a built-in set. - -If the special value `null` is specified, the structure finder will not look for a primary timestamp in the text. -When the format is semi-structured text, this will result in the structure finder treating the text as single-line messages. - -## client.textStructure.findStructure [_text_structure.find_structure] -Find the structure of a text file. -The text file must contain data that is suitable to be ingested into Elasticsearch. - -This API provides a starting point for ingesting data into Elasticsearch in a format that is suitable for subsequent use with other Elastic Stack functionality. -Unlike other Elasticsearch endpoints, the data that is posted to this endpoint does not need to be UTF-8 encoded and in JSON format. -It must, however, be text; binary text formats are not currently supported. -The size is limited to the Elasticsearch HTTP receive buffer size, which defaults to 100 Mb. - -The response from the API contains: - -* A couple of messages from the beginning of the text. -* Statistics that reveal the most common values for all fields detected within the text and basic numeric statistics for numeric fields. -* Information about the structure of the text, which is useful when you write ingest configurations to index it or similarly formatted text. -* Appropriate mappings for an Elasticsearch index, which you could use to ingest the text. - -All this information can be calculated by the structure finder with no guidance. -However, you can optionally override some of the decisions about the text structure by specifying one or more query parameters. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-text-structure-find-structure) - -```ts -client.textStructure.findStructure({ ... }) -``` - -### Arguments [_arguments_text_structure.find_structure] - -#### Request (object) [_request_text_structure.find_structure] -- **`text_files` (Optional, TJsonDocument[])** -- **`charset` (Optional, string)**: The text's character set. -It must be a character set that is supported by the JVM that Elasticsearch uses. -For example, `UTF-8`, `UTF-16LE`, `windows-1252`, or `EUC-JP`. -If this parameter is not specified, the structure finder chooses an appropriate character set. -- **`column_names` (Optional, string)**: If you have set format to `delimited`, you can specify the column names in a list. -If this parameter is not specified, the structure finder uses the column names from the header row of the text. -If the text does not have a header role, columns are named "column1", "column2", "column3", for example. -- **`delimiter` (Optional, string)**: If you have set `format` to `delimited`, you can specify the character used to delimit the values in each row. -Only a single character is supported; the delimiter cannot have multiple characters. -By default, the API considers the following possibilities: comma, tab, semi-colon, and pipe (`|`). -In this default scenario, all rows must have the same number of fields for the delimited format to be detected. -If you specify a delimiter, up to 10% of the rows can have a different number of columns than the first row. -- **`ecs_compatibility` (Optional, string)**: The mode of compatibility with ECS compliant Grok patterns. -Use this parameter to specify whether to use ECS Grok patterns instead of legacy ones when the structure finder creates a Grok pattern. -Valid values are `disabled` and `v1`. -This setting primarily has an impact when a whole message Grok pattern such as `%{CATALINALOG}` matches the input. -If the structure finder identifies a common structure but has no idea of meaning then generic field names such as `path`, `ipaddress`, `field1`, and `field2` are used in the `grok_pattern` output, with the intention that a user who knows the meanings rename these fields before using it. -- **`explain` (Optional, boolean)**: If this parameter is set to `true`, the response includes a field named explanation, which is an array of strings that indicate how the structure finder produced its result. -If the structure finder produces unexpected results for some text, use this query parameter to help you determine why the returned structure was chosen. -- **`format` (Optional, string)**: The high level structure of the text. -Valid values are `ndjson`, `xml`, `delimited`, and `semi_structured_text`. -By default, the API chooses the format. -In this default scenario, all rows must have the same number of fields for a delimited format to be detected. -If the format is set to `delimited` and the delimiter is not set, however, the API tolerates up to 5% of rows that have a different number of columns than the first row. -- **`grok_pattern` (Optional, string)**: If you have set `format` to `semi_structured_text`, you can specify a Grok pattern that is used to extract fields from every message in the text. -The name of the timestamp field in the Grok pattern must match what is specified in the `timestamp_field` parameter. -If that parameter is not specified, the name of the timestamp field in the Grok pattern must match "timestamp". -If `grok_pattern` is not specified, the structure finder creates a Grok pattern. -- **`has_header_row` (Optional, boolean)**: If you have set `format` to `delimited`, you can use this parameter to indicate whether the column names are in the first row of the text. -If this parameter is not specified, the structure finder guesses based on the similarity of the first row of the text to other rows. -- **`line_merge_size_limit` (Optional, number)**: The maximum number of characters in a message when lines are merged to form messages while analyzing semi-structured text. -If you have extremely long messages you may need to increase this, but be aware that this may lead to very long processing times if the way to group lines into messages is misdetected. -- **`lines_to_sample` (Optional, number)**: The number of lines to include in the structural analysis, starting from the beginning of the text. -The minimum is 2. -If the value of this parameter is greater than the number of lines in the text, the analysis proceeds (as long as there are at least two lines in the text) for all of the lines. - -NOTE: The number of lines and the variation of the lines affects the speed of the analysis. -For example, if you upload text where the first 1000 lines are all variations on the same message, the analysis will find more commonality than would be seen with a bigger sample. -If possible, however, it is more efficient to upload sample text with more variety in the first 1000 lines than to request analysis of 100000 lines to achieve some variety. -- **`quote` (Optional, string)**: If you have set `format` to `delimited`, you can specify the character used to quote the values in each row if they contain newlines or the delimiter character. -Only a single character is supported. -If this parameter is not specified, the default value is a double quote (`"`). -If your delimited text format does not use quoting, a workaround is to set this argument to a character that does not appear anywhere in the sample. -- **`should_trim_fields` (Optional, boolean)**: If you have set `format` to `delimited`, you can specify whether values between delimiters should have whitespace trimmed from them. -If this parameter is not specified and the delimiter is pipe (`|`), the default value is `true`. -Otherwise, the default value is `false`. -- **`timeout` (Optional, string \| -1 \| 0)**: The maximum amount of time that the structure analysis can take. -If the analysis is still running when the timeout expires then it will be stopped. -- **`timestamp_field` (Optional, string)**: The name of the field that contains the primary timestamp of each record in the text. -In particular, if the text were ingested into an index, this is the field that would be used to populate the `@timestamp` field. - -If the `format` is `semi_structured_text`, this field must match the name of the appropriate extraction in the `grok_pattern`. -Therefore, for semi-structured text, it is best not to specify this parameter unless `grok_pattern` is also specified. - -For structured text, if you specify this parameter, the field must exist within the text. - -If this parameter is not specified, the structure finder makes a decision about which field (if any) is the primary timestamp field. -For structured text, it is not compulsory to have a timestamp in the text. -- **`timestamp_format` (Optional, string)**: The Java time format of the timestamp field in the text. - -Only a subset of Java time format letter groups are supported: - -* `a` -* `d` -* `dd` -* `EEE` -* `EEEE` -* `H` -* `HH` -* `h` -* `M` -* `MM` -* `MMM` -* `MMMM` -* `mm` -* `ss` -* `XX` -* `XXX` -* `yy` -* `yyyy` -* `zzz` - -Additionally `S` letter groups (fractional seconds) of length one to nine are supported providing they occur after `ss` and separated from the `ss` by a `.`, `,` or `:`. -Spacing and punctuation is also permitted with the exception of `?`, newline and carriage return, together with literal text enclosed in single quotes. -For example, `MM/dd HH.mm.ss,SSSSSS 'in' yyyy` is a valid override format. - -One valuable use case for this parameter is when the format is semi-structured text, there are multiple timestamp formats in the text, and you know which format corresponds to the primary timestamp, but you do not want to specify the full `grok_pattern`. -Another is when the timestamp format is one that the structure finder does not consider by default. - -If this parameter is not specified, the structure finder chooses the best format from a built-in set. - -If the special value `null` is specified the structure finder will not look for a primary timestamp in the text. -When the format is semi-structured text this will result in the structure finder treating the text as single-line messages. - -## client.textStructure.testGrokPattern [_text_structure.test_grok_pattern] -Test a Grok pattern. -Test a Grok pattern on one or more lines of text. -The API indicates whether the lines match the pattern together with the offsets and lengths of the matched substrings. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-text-structure-test-grok-pattern) - -```ts -client.textStructure.testGrokPattern({ grok_pattern, text }) -``` - -### Arguments [_arguments_text_structure.test_grok_pattern] - -#### Request (object) [_request_text_structure.test_grok_pattern] -- **`grok_pattern` (string)**: The Grok pattern to run on the text. -- **`text` (string[])**: The lines of text to run the Grok pattern on. -- **`ecs_compatibility` (Optional, string)**: The mode of compatibility with ECS compliant Grok patterns. -Use this parameter to specify whether to use ECS Grok patterns instead of legacy ones when the structure finder creates a Grok pattern. -Valid values are `disabled` and `v1`. - -## client.transform.deleteTransform [_transform.delete_transform] -Delete a transform. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-delete-transform) - -```ts -client.transform.deleteTransform({ transform_id }) -``` - -### Arguments [_arguments_transform.delete_transform] - -#### Request (object) [_request_transform.delete_transform] -- **`transform_id` (string)**: Identifier for the transform. -- **`force` (Optional, boolean)**: If this value is false, the transform must be stopped before it can be deleted. If true, the transform is -deleted regardless of its current state. -- **`delete_dest_index` (Optional, boolean)**: If this value is true, the destination index is deleted together with the transform. If false, the destination -index will not be deleted -- **`timeout` (Optional, string \| -1 \| 0)**: Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. - -## client.transform.getNodeStats [_transform.get_node_stats] -Retrieves transform usage information for transform nodes. - -[Endpoint documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform-node-stats.html) - -```ts -client.transform.getNodeStats() -``` - - -## client.transform.getTransform [_transform.get_transform] -Get transforms. -Get configuration information for transforms. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-get-transform) - -```ts -client.transform.getTransform({ ... }) -``` - -### Arguments [_arguments_transform.get_transform] - -#### Request (object) [_request_transform.get_transform] -- **`transform_id` (Optional, string \| string[])**: Identifier for the transform. It can be a transform identifier or a -wildcard expression. You can get information for all transforms by using -`_all`, by specifying `*` as the ``, or by omitting the -``. -- **`allow_no_match` (Optional, boolean)**: Specifies what to do when the request: - -1. Contains wildcard expressions and there are no transforms that match. -2. Contains the _all string or no identifiers and there are no matches. -3. Contains wildcard expressions and there are only partial matches. - -If this parameter is false, the request returns a 404 status code when -there are no matches or only partial matches. -- **`from` (Optional, number)**: Skips the specified number of transforms. -- **`size` (Optional, number)**: Specifies the maximum number of transforms to obtain. -- **`exclude_generated` (Optional, boolean)**: Excludes fields that were automatically added when creating the -transform. This allows the configuration to be in an acceptable format to -be retrieved and then added to another cluster. - -## client.transform.getTransformStats [_transform.get_transform_stats] -Get transform stats. - -Get usage information for transforms. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-get-transform-stats) - -```ts -client.transform.getTransformStats({ transform_id }) -``` - -### Arguments [_arguments_transform.get_transform_stats] - -#### Request (object) [_request_transform.get_transform_stats] -- **`transform_id` (string \| string[])**: Identifier for the transform. It can be a transform identifier or a -wildcard expression. You can get information for all transforms by using -`_all`, by specifying `*` as the ``, or by omitting the -``. -- **`allow_no_match` (Optional, boolean)**: Specifies what to do when the request: - -1. Contains wildcard expressions and there are no transforms that match. -2. Contains the _all string or no identifiers and there are no matches. -3. Contains wildcard expressions and there are only partial matches. - -If this parameter is false, the request returns a 404 status code when -there are no matches or only partial matches. -- **`from` (Optional, number)**: Skips the specified number of transforms. -- **`size` (Optional, number)**: Specifies the maximum number of transforms to obtain. -- **`timeout` (Optional, string \| -1 \| 0)**: Controls the time to wait for the stats - -## client.transform.previewTransform [_transform.preview_transform] -Preview a transform. -Generates a preview of the results that you will get when you create a transform with the same configuration. - -It returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also -generates a list of mappings and settings for the destination index. These values are determined based on the field -types of the source index and the transform aggregations. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-preview-transform) - -```ts -client.transform.previewTransform({ ... }) -``` - -### Arguments [_arguments_transform.preview_transform] - -#### Request (object) [_request_transform.preview_transform] -- **`transform_id` (Optional, string)**: Identifier for the transform to preview. If you specify this path parameter, you cannot provide transform -configuration details in the request body. -- **`dest` (Optional, { index, op_type, pipeline, routing, version_type })**: The destination for the transform. -- **`description` (Optional, string)**: Free text description of the transform. -- **`frequency` (Optional, string \| -1 \| 0)**: The interval between checks for changes in the source indices when the -transform is running continuously. Also determines the retry interval in -the event of transient failures while the transform is searching or -indexing. The minimum value is 1s and the maximum is 1h. -- **`pivot` (Optional, { aggregations, group_by })**: The pivot method transforms the data by aggregating and grouping it. -These objects define the group by fields and the aggregation to reduce -the data. -- **`source` (Optional, { index, query, remote, size, slice, sort, _source, runtime_mappings })**: The source of the data for the transform. -- **`settings` (Optional, { align_checkpoints, dates_as_epoch_millis, deduce_mappings, docs_per_second, max_page_search_size, unattended })**: Defines optional transform settings. -- **`sync` (Optional, { time })**: Defines the properties transforms require to run continuously. -- **`retention_policy` (Optional, { time })**: Defines a retention policy for the transform. Data that meets the defined -criteria is deleted from the destination index. -- **`latest` (Optional, { sort, unique_key })**: The latest method transforms the data by finding the latest document for -each unique key. -- **`timeout` (Optional, string \| -1 \| 0)**: Period to wait for a response. If no response is received before the -timeout expires, the request fails and returns an error. - -## client.transform.putTransform [_transform.put_transform] -Create a transform. -Creates a transform. - -A transform copies data from source indices, transforms it, and persists it into an entity-centric destination index. You can also think of the destination index as a two-dimensional tabular data structure (known as -a data frame). The ID for each document in the data frame is generated from a hash of the entity, so there is a -unique row per entity. - -You must choose either the latest or pivot method for your transform; you cannot use both in a single transform. If -you choose to use the pivot method for your transform, the entities are defined by the set of `group_by` fields in -the pivot object. If you choose to use the latest method, the entities are defined by the `unique_key` field values -in the latest object. - -You must have `create_index`, `index`, and `read` privileges on the destination index and `read` and -`view_index_metadata` privileges on the source indices. When Elasticsearch security features are enabled, the -transform remembers which roles the user that created it had at the time of creation and uses those same roles. If -those roles do not have the required privileges on the source and destination indices, the transform fails when it -attempts unauthorized operations. - -NOTE: You must use Kibana or this API to create a transform. Do not add a transform directly into any -`.transform-internal*` indices using the Elasticsearch index API. If Elasticsearch security features are enabled, do -not give users any privileges on `.transform-internal*` indices. If you used transforms prior to 7.5, also do not -give users any privileges on `.data-frame-internal*` indices. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-put-transform) - -```ts -client.transform.putTransform({ transform_id, dest, source }) -``` - -### Arguments [_arguments_transform.put_transform] - -#### Request (object) [_request_transform.put_transform] -- **`transform_id` (string)**: Identifier for the transform. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), -hyphens, and underscores. It has a 64 character limit and must start and end with alphanumeric characters. -- **`dest` ({ index, op_type, pipeline, routing, version_type })**: The destination for the transform. -- **`source` ({ index, query, remote, size, slice, sort, _source, runtime_mappings })**: The source of the data for the transform. -- **`description` (Optional, string)**: Free text description of the transform. -- **`frequency` (Optional, string \| -1 \| 0)**: The interval between checks for changes in the source indices when the transform is running continuously. Also -determines the retry interval in the event of transient failures while the transform is searching or indexing. -The minimum value is `1s` and the maximum is `1h`. -- **`latest` (Optional, { sort, unique_key })**: The latest method transforms the data by finding the latest document for each unique key. -- **`_meta` (Optional, Record)**: Defines optional transform metadata. -- **`pivot` (Optional, { aggregations, group_by })**: The pivot method transforms the data by aggregating and grouping it. These objects define the group by fields -and the aggregation to reduce the data. -- **`retention_policy` (Optional, { time })**: Defines a retention policy for the transform. Data that meets the defined criteria is deleted from the -destination index. -- **`settings` (Optional, { align_checkpoints, dates_as_epoch_millis, deduce_mappings, docs_per_second, max_page_search_size, unattended })**: Defines optional transform settings. -- **`sync` (Optional, { time })**: Defines the properties transforms require to run continuously. -- **`defer_validation` (Optional, boolean)**: When the transform is created, a series of validations occur to ensure its success. For example, there is a -check for the existence of the source indices and a check that the destination index is not part of the source -index pattern. You can use this parameter to skip the checks, for example when the source index does not exist -until after the transform is created. The validations are always run when you start the transform, however, with -the exception of privilege checks. -- **`timeout` (Optional, string \| -1 \| 0)**: Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. - -## client.transform.resetTransform [_transform.reset_transform] -Reset a transform. - -Before you can reset it, you must stop it; alternatively, use the `force` query parameter. -If the destination index was created by the transform, it is deleted. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-reset-transform) - -```ts -client.transform.resetTransform({ transform_id }) -``` - -### Arguments [_arguments_transform.reset_transform] - -#### Request (object) [_request_transform.reset_transform] -- **`transform_id` (string)**: Identifier for the transform. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), -hyphens, and underscores. It has a 64 character limit and must start and end with alphanumeric characters. -- **`force` (Optional, boolean)**: If this value is `true`, the transform is reset regardless of its current state. If it's `false`, the transform -must be stopped before it can be reset. -- **`timeout` (Optional, string \| -1 \| 0)**: Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. - -## client.transform.scheduleNowTransform [_transform.schedule_now_transform] -Schedule a transform to start now. - -Instantly run a transform to process data. -If you run this API, the transform will process the new data instantly, -without waiting for the configured frequency interval. After the API is called, -the transform will be processed again at `now + frequency` unless the API -is called again in the meantime. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-schedule-now-transform) - -```ts -client.transform.scheduleNowTransform({ transform_id }) -``` - -### Arguments [_arguments_transform.schedule_now_transform] - -#### Request (object) [_request_transform.schedule_now_transform] -- **`transform_id` (string)**: Identifier for the transform. -- **`timeout` (Optional, string \| -1 \| 0)**: Controls the time to wait for the scheduling to take place - -## client.transform.startTransform [_transform.start_transform] -Start a transform. - -When you start a transform, it creates the destination index if it does not already exist. The `number_of_shards` is -set to `1` and the `auto_expand_replicas` is set to `0-1`. If it is a pivot transform, it deduces the mapping -definitions for the destination index from the source indices and the transform aggregations. If fields in the -destination index are derived from scripts (as in the case of `scripted_metric` or `bucket_script` aggregations), -the transform uses dynamic mappings unless an index template exists. If it is a latest transform, it does not deduce -mapping definitions; it uses dynamic mappings. To use explicit mappings, create the destination index before you -start the transform. Alternatively, you can create an index template, though it does not affect the deduced mappings -in a pivot transform. - -When the transform starts, a series of validations occur to ensure its success. If you deferred validation when you -created the transform, they occur when you start the transform—​with the exception of privilege checks. When -Elasticsearch security features are enabled, the transform remembers which roles the user that created it had at the -time of creation and uses those same roles. If those roles do not have the required privileges on the source and -destination indices, the transform fails when it attempts unauthorized operations. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-start-transform) - -```ts -client.transform.startTransform({ transform_id }) -``` - -### Arguments [_arguments_transform.start_transform] - -#### Request (object) [_request_transform.start_transform] -- **`transform_id` (string)**: Identifier for the transform. -- **`timeout` (Optional, string \| -1 \| 0)**: Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. -- **`from` (Optional, string)**: Restricts the set of transformed entities to those changed after this time. Relative times like now-30d are supported. Only applicable for continuous transforms. - -## client.transform.stopTransform [_transform.stop_transform] -Stop transforms. -Stops one or more transforms. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-stop-transform) - -```ts -client.transform.stopTransform({ transform_id }) -``` - -### Arguments [_arguments_transform.stop_transform] - -#### Request (object) [_request_transform.stop_transform] -- **`transform_id` (string)**: Identifier for the transform. To stop multiple transforms, use a list or a wildcard expression. -To stop all transforms, use `_all` or `*` as the identifier. -- **`allow_no_match` (Optional, boolean)**: Specifies what to do when the request: contains wildcard expressions and there are no transforms that match; -contains the `_all` string or no identifiers and there are no matches; contains wildcard expressions and there -are only partial matches. - -If it is true, the API returns a successful acknowledgement message when there are no matches. When there are -only partial matches, the API stops the appropriate transforms. - -If it is false, the request returns a 404 status code when there are no matches or only partial matches. -- **`force` (Optional, boolean)**: If it is true, the API forcefully stops the transforms. -- **`timeout` (Optional, string \| -1 \| 0)**: Period to wait for a response when `wait_for_completion` is `true`. If no response is received before the -timeout expires, the request returns a timeout exception. However, the request continues processing and -eventually moves the transform to a STOPPED state. -- **`wait_for_checkpoint` (Optional, boolean)**: If it is true, the transform does not completely stop until the current checkpoint is completed. If it is false, -the transform stops as soon as possible. -- **`wait_for_completion` (Optional, boolean)**: If it is true, the API blocks until the indexer state completely stops. If it is false, the API returns -immediately and the indexer is stopped asynchronously in the background. - -## client.transform.updateTransform [_transform.update_transform] -Update a transform. -Updates certain properties of a transform. - -All updated properties except `description` do not take effect until after the transform starts the next checkpoint, -thus there is data consistency in each checkpoint. To use this API, you must have `read` and `view_index_metadata` -privileges for the source indices. You must also have `index` and `read` privileges for the destination index. When -Elasticsearch security features are enabled, the transform remembers which roles the user who updated it had at the -time of update and runs with those privileges. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-update-transform) - -```ts -client.transform.updateTransform({ transform_id }) -``` - -### Arguments [_arguments_transform.update_transform] - -#### Request (object) [_request_transform.update_transform] -- **`transform_id` (string)**: Identifier for the transform. -- **`dest` (Optional, { index, op_type, pipeline, routing, version_type })**: The destination for the transform. -- **`description` (Optional, string)**: Free text description of the transform. -- **`frequency` (Optional, string \| -1 \| 0)**: The interval between checks for changes in the source indices when the -transform is running continuously. Also determines the retry interval in -the event of transient failures while the transform is searching or -indexing. The minimum value is 1s and the maximum is 1h. -- **`_meta` (Optional, Record)**: Defines optional transform metadata. -- **`source` (Optional, { index, query, remote, size, slice, sort, _source, runtime_mappings })**: The source of the data for the transform. -- **`settings` (Optional, { align_checkpoints, dates_as_epoch_millis, deduce_mappings, docs_per_second, max_page_search_size, unattended })**: Defines optional transform settings. -- **`sync` (Optional, { time })**: Defines the properties transforms require to run continuously. -- **`retention_policy` (Optional, { time } \| null)**: Defines a retention policy for the transform. Data that meets the defined -criteria is deleted from the destination index. -- **`defer_validation` (Optional, boolean)**: When true, deferrable validations are not run. This behavior may be -desired if the source index does not exist until after the transform is -created. -- **`timeout` (Optional, string \| -1 \| 0)**: Period to wait for a response. If no response is received before the -timeout expires, the request fails and returns an error. - -## client.transform.upgradeTransforms [_transform.upgrade_transforms] -Upgrade all transforms. - -Transforms are compatible across minor versions and between supported major versions. -However, over time, the format of transform configuration information may change. -This API identifies transforms that have a legacy configuration format and upgrades them to the latest version. -It also cleans up the internal data structures that store the transform state and checkpoints. -The upgrade does not affect the source and destination indices. -The upgrade also does not affect the roles that transforms use when Elasticsearch security features are enabled; the role used to read source data and write to the destination index remains unchanged. - -If a transform upgrade step fails, the upgrade stops and an error is returned about the underlying issue. -Resolve the issue then re-run the process again. -A summary is returned when the upgrade is finished. - -To ensure continuous transforms remain running during a major version upgrade of the cluster – for example, from 7.16 to 8.0 – it is recommended to upgrade transforms before upgrading the cluster. -You may want to perform a recent cluster backup prior to the upgrade. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-upgrade-transforms) - -```ts -client.transform.upgradeTransforms({ ... }) -``` - -### Arguments [_arguments_transform.upgrade_transforms] - -#### Request (object) [_request_transform.upgrade_transforms] -- **`dry_run` (Optional, boolean)**: When true, the request checks for updates but does not run them. -- **`timeout` (Optional, string \| -1 \| 0)**: Period to wait for a response. If no response is received before the timeout expires, the request fails and -returns an error. - -## client.watcher.ackWatch [_watcher.ack_watch] -Acknowledge a watch. -Acknowledging a watch enables you to manually throttle the execution of the watch's actions. - -The acknowledgement state of an action is stored in the `status.actions..ack.state` structure. - -IMPORTANT: If the specified watch is currently being executed, this API will return an error -The reason for this behavior is to prevent overwriting the watch status from a watch execution. - -Acknowledging an action throttles further executions of that action until its `ack.state` is reset to `awaits_successful_execution`. -This happens when the condition of the watch is not met (the condition evaluates to false). - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-ack-watch) - -```ts -client.watcher.ackWatch({ watch_id }) -``` - -### Arguments [_arguments_watcher.ack_watch] - -#### Request (object) [_request_watcher.ack_watch] -- **`watch_id` (string)**: The watch identifier. -- **`action_id` (Optional, string \| string[])**: A list of the action identifiers to acknowledge. -If you omit this parameter, all of the actions of the watch are acknowledged. - -## client.watcher.activateWatch [_watcher.activate_watch] -Activate a watch. -A watch can be either active or inactive. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-activate-watch) - -```ts -client.watcher.activateWatch({ watch_id }) -``` - -### Arguments [_arguments_watcher.activate_watch] - -#### Request (object) [_request_watcher.activate_watch] -- **`watch_id` (string)**: The watch identifier. - -## client.watcher.deactivateWatch [_watcher.deactivate_watch] -Deactivate a watch. -A watch can be either active or inactive. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-deactivate-watch) - -```ts -client.watcher.deactivateWatch({ watch_id }) -``` - -### Arguments [_arguments_watcher.deactivate_watch] - -#### Request (object) [_request_watcher.deactivate_watch] -- **`watch_id` (string)**: The watch identifier. - -## client.watcher.deleteWatch [_watcher.delete_watch] -Delete a watch. -When the watch is removed, the document representing the watch in the `.watches` index is gone and it will never be run again. - -Deleting a watch does not delete any watch execution records related to this watch from the watch history. - -IMPORTANT: Deleting a watch must be done by using only this API. -Do not delete the watch directly from the `.watches` index using the Elasticsearch delete document API -When Elasticsearch security features are enabled, make sure no write privileges are granted to anyone for the `.watches` index. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-delete-watch) - -```ts -client.watcher.deleteWatch({ id }) -``` - -### Arguments [_arguments_watcher.delete_watch] - -#### Request (object) [_request_watcher.delete_watch] -- **`id` (string)**: The watch identifier. - -## client.watcher.executeWatch [_watcher.execute_watch] -Run a watch. -This API can be used to force execution of the watch outside of its triggering logic or to simulate the watch execution for debugging purposes. - -For testing and debugging purposes, you also have fine-grained control on how the watch runs. -You can run the watch without running all of its actions or alternatively by simulating them. -You can also force execution by ignoring the watch condition and control whether a watch record would be written to the watch history after it runs. - -You can use the run watch API to run watches that are not yet registered by specifying the watch definition inline. -This serves as great tool for testing and debugging your watches prior to adding them to Watcher. - -When Elasticsearch security features are enabled on your cluster, watches are run with the privileges of the user that stored the watches. -If your user is allowed to read index `a`, but not index `b`, then the exact same set of rules will apply during execution of a watch. - -When using the run watch API, the authorization data of the user that called the API will be used as a base, instead of the information who stored the watch. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-execute-watch) - -```ts -client.watcher.executeWatch({ ... }) -``` - -### Arguments [_arguments_watcher.execute_watch] - -#### Request (object) [_request_watcher.execute_watch] -- **`id` (Optional, string)**: The watch identifier. -- **`action_modes` (Optional, Record)**: Determines how to handle the watch actions as part of the watch execution. -- **`alternative_input` (Optional, Record)**: When present, the watch uses this object as a payload instead of executing its own input. -- **`ignore_condition` (Optional, boolean)**: When set to `true`, the watch execution uses the always condition. This can also be specified as an HTTP parameter. -- **`record_execution` (Optional, boolean)**: When set to `true`, the watch record representing the watch execution result is persisted to the `.watcher-history` index for the current time. -In addition, the status of the watch is updated, possibly throttling subsequent runs. -This can also be specified as an HTTP parameter. -- **`simulated_actions` (Optional, { actions, all, use_all })** -- **`trigger_data` (Optional, { scheduled_time, triggered_time })**: This structure is parsed as the data of the trigger event that will be used during the watch execution. -- **`watch` (Optional, { actions, condition, input, metadata, status, throttle_period, throttle_period_in_millis, transform, trigger })**: When present, this watch is used instead of the one specified in the request. -This watch is not persisted to the index and `record_execution` cannot be set. -- **`debug` (Optional, boolean)**: Defines whether the watch runs in debug mode. - -## client.watcher.getSettings [_watcher.get_settings] -Get Watcher index settings. -Get settings for the Watcher internal index (`.watches`). -Only a subset of settings are shown, for example `index.auto_expand_replicas` and `index.number_of_replicas`. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-get-settings) - -```ts -client.watcher.getSettings({ ... }) -``` - -### Arguments [_arguments_watcher.get_settings] - -#### Request (object) [_request_watcher.get_settings] -- **`master_timeout` (Optional, string \| -1 \| 0)**: The period to wait for a connection to the master node. -If no response is received before the timeout expires, the request fails and returns an error. - -## client.watcher.getWatch [_watcher.get_watch] -Get a watch. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-get-watch) - -```ts -client.watcher.getWatch({ id }) -``` - -### Arguments [_arguments_watcher.get_watch] - -#### Request (object) [_request_watcher.get_watch] -- **`id` (string)**: The watch identifier. - -## client.watcher.putWatch [_watcher.put_watch] -Create or update a watch. -When a watch is registered, a new document that represents the watch is added to the `.watches` index and its trigger is immediately registered with the relevant trigger engine. -Typically for the `schedule` trigger, the scheduler is the trigger engine. - -IMPORTANT: You must use Kibana or this API to create a watch. -Do not add a watch directly to the `.watches` index by using the Elasticsearch index API. -If Elasticsearch security features are enabled, do not give users write privileges on the `.watches` index. - -When you add a watch you can also define its initial active state by setting the *active* parameter. - -When Elasticsearch security features are enabled, your watch can index or search only on indices for which the user that stored the watch has privileges. -If the user is able to read index `a`, but not index `b`, the same will apply when the watch runs. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-put-watch) - -```ts -client.watcher.putWatch({ id }) -``` - -### Arguments [_arguments_watcher.put_watch] - -#### Request (object) [_request_watcher.put_watch] -- **`id` (string)**: The identifier for the watch. -- **`actions` (Optional, Record)**: The list of actions that will be run if the condition matches. -- **`condition` (Optional, { always, array_compare, compare, never, script })**: The condition that defines if the actions should be run. -- **`input` (Optional, { chain, http, search, simple })**: The input that defines the input that loads the data for the watch. -- **`metadata` (Optional, Record)**: Metadata JSON that will be copied into the history entries. -- **`throttle_period` (Optional, string \| -1 \| 0)**: The minimum time between actions being run. -The default is 5 seconds. -This default can be changed in the config file with the setting `xpack.watcher.throttle.period.default_period`. -If both this value and the `throttle_period_in_millis` parameter are specified, Watcher uses the last parameter included in the request. -- **`throttle_period_in_millis` (Optional, Unit)**: Minimum time in milliseconds between actions being run. Defaults to 5000. If both this value and the throttle_period parameter are specified, Watcher uses the last parameter included in the request. -- **`transform` (Optional, { chain, script, search })**: The transform that processes the watch payload to prepare it for the watch actions. -- **`trigger` (Optional, { schedule })**: The trigger that defines when the watch should run. -- **`active` (Optional, boolean)**: The initial state of the watch. -The default value is `true`, which means the watch is active by default. -- **`if_primary_term` (Optional, number)**: only update the watch if the last operation that has changed the watch has the specified primary term -- **`if_seq_no` (Optional, number)**: only update the watch if the last operation that has changed the watch has the specified sequence number -- **`version` (Optional, number)**: Explicit version number for concurrency control - -## client.watcher.queryWatches [_watcher.query_watches] -Query watches. -Get all registered watches in a paginated manner and optionally filter watches by a query. - -Note that only the `_id` and `metadata.*` fields are queryable or sortable. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-query-watches) - -```ts -client.watcher.queryWatches({ ... }) -``` - -### Arguments [_arguments_watcher.query_watches] - -#### Request (object) [_request_watcher.query_watches] -- **`from` (Optional, number)**: The offset from the first result to fetch. -It must be non-negative. -- **`size` (Optional, number)**: The number of hits to return. -It must be non-negative. -- **`query` (Optional, { bool, boosting, common, combined_fields, constant_score, dis_max, distance_feature, exists, function_score, fuzzy, geo_bounding_box, geo_distance, geo_grid, geo_polygon, geo_shape, has_child, has_parent, ids, intervals, knn, match, match_all, match_bool_prefix, match_none, match_phrase, match_phrase_prefix, more_like_this, multi_match, nested, parent_id, percolate, pinned, prefix, query_string, range, rank_feature, regexp, rule, script, script_score, semantic, shape, simple_query_string, span_containing, span_field_masking, span_first, span_multi, span_near, span_not, span_or, span_term, span_within, sparse_vector, term, terms, terms_set, text_expansion, weighted_tokens, wildcard, wrapper, type })**: A query that filters the watches to be returned. -- **`sort` (Optional, string \| { _score, _doc, _geo_distance, _script } \| string \| { _score, _doc, _geo_distance, _script }[])**: One or more fields used to sort the search results. -- **`search_after` (Optional, number \| number \| string \| boolean \| null[])**: Retrieve the next page of hits using a set of sort values from the previous page. - -## client.watcher.start [_watcher.start] -Start the watch service. -Start the Watcher service if it is not already running. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-start) - -```ts -client.watcher.start({ ... }) -``` - -### Arguments [_arguments_watcher.start] - -#### Request (object) [_request_watcher.start] -- **`master_timeout` (Optional, string \| -1 \| 0)**: Period to wait for a connection to the master node. - -## client.watcher.stats [_watcher.stats] -Get Watcher statistics. -This API always returns basic metrics. -You retrieve more metrics by using the metric parameter. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-stats) - -```ts -client.watcher.stats({ ... }) -``` - -### Arguments [_arguments_watcher.stats] - -#### Request (object) [_request_watcher.stats] -- **`metric` (Optional, Enum("_all" \| "queued_watches" \| "current_watches" \| "pending_watches") \| Enum("_all" \| "queued_watches" \| "current_watches" \| "pending_watches")[])**: Defines which additional metrics are included in the response. -- **`emit_stacktraces` (Optional, boolean)**: Defines whether stack traces are generated for each watch that is running. - -## client.watcher.stop [_watcher.stop] -Stop the watch service. -Stop the Watcher service if it is running. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-stop) - -```ts -client.watcher.stop({ ... }) -``` - -### Arguments [_arguments_watcher.stop] - -#### Request (object) [_request_watcher.stop] -- **`master_timeout` (Optional, string \| -1 \| 0)**: The period to wait for the master node. -If the master node is not available before the timeout expires, the request fails and returns an error. -To indicate that the request should never timeout, set it to `-1`. - -## client.watcher.updateSettings [_watcher.update_settings] -Update Watcher index settings. -Update settings for the Watcher internal index (`.watches`). -Only a subset of settings can be modified. -This includes `index.auto_expand_replicas`, `index.number_of_replicas`, `index.routing.allocation.exclude.*`, -`index.routing.allocation.include.*` and `index.routing.allocation.require.*`. -Modification of `index.routing.allocation.include._tier_preference` is an exception and is not allowed as the -Watcher shards must always be in the `data_content` tier. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-update-settings) - -```ts -client.watcher.updateSettings({ ... }) -``` - -### Arguments [_arguments_watcher.update_settings] - -#### Request (object) [_request_watcher.update_settings] -- **`index.auto_expand_replicas` (Optional, string)** -- **`index.number_of_replicas` (Optional, number)** -- **`master_timeout` (Optional, string \| -1 \| 0)**: The period to wait for a connection to the master node. -If no response is received before the timeout expires, the request fails and returns an error. -- **`timeout` (Optional, string \| -1 \| 0)**: The period to wait for a response. -If no response is received before the timeout expires, the request fails and returns an error. - -## client.xpack.info [_xpack.info] -Get information. -The information provided by the API includes: - -* Build information including the build number and timestamp. -* License information about the currently installed license. -* Feature information for the features that are currently enabled and available under the current license. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-info) - -```ts -client.xpack.info({ ... }) -``` - -### Arguments [_arguments_xpack.info] - -#### Request (object) [_request_xpack.info] -- **`categories` (Optional, Enum("build" \| "features" \| "license")[])**: A list of the information categories to include in the response. -For example, `build,license,features`. -- **`accept_enterprise` (Optional, boolean)**: If this param is used it must be set to true -- **`human` (Optional, boolean)**: Defines whether additional human-readable information is included in the response. -In particular, it adds descriptions and a tag line. - -## client.xpack.usage [_xpack.usage] -Get usage information. -Get information about the features that are currently enabled and available under the current license. -The API also provides some usage statistics. - -[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-xpack) - -```ts -client.xpack.usage({ ... }) -``` - -### Arguments [_arguments_xpack.usage] - -#### Request (object) [_request_xpack.usage] -- **`master_timeout` (Optional, string \| -1 \| 0)**: The period to wait for a connection to the master node. -If no response is received before the timeout expires, the request fails and returns an error. -To indicate that the request should never timeout, set it to `-1`. - +See API documentation [here](./api/Client.md) diff --git a/docs/reference/api/API.md b/docs/reference/api/API.md new file mode 100644 index 000000000..84562a11b --- /dev/null +++ b/docs/reference/api/API.md @@ -0,0 +1,90 @@ +## Interface `API` + +| Name | Type | Description | +| - | - | - | +| `asyncSearch` | [AsyncSearchApi](./AsyncSearchApi.md) |   | +| `autoscaling` | [AutoscalingApi](./AutoscalingApi.md) |   | +| `bulk` | typeof [bulkApi](./bulkApi.md) |   | +| `capabilities` | typeof [capabilitiesApi](./capabilitiesApi.md) |   | +| `cat` | [CatApi](./CatApi.md) |   | +| `ccr` | [CcrApi](./CcrApi.md) |   | +| `clearScroll` | typeof [clearScrollApi](./clearScrollApi.md) |   | +| `closePointInTime` | typeof [closePointInTimeApi](./closePointInTimeApi.md) |   | +| `cluster` | [ClusterApi](./ClusterApi.md) |   | +| `connector` | [ConnectorApi](./ConnectorApi.md) |   | +| `count` | typeof [countApi](./countApi.md) |   | +| `create` | typeof [createApi](./createApi.md) |   | +| `danglingIndices` | [DanglingIndicesApi](./DanglingIndicesApi.md) |   | +| `delete` | typeof [deleteApi](./deleteApi.md) |   | +| `deleteByQuery` | typeof [deleteByQueryApi](./deleteByQueryApi.md) |   | +| `deleteByQueryRethrottle` | typeof [deleteByQueryRethrottleApi](./deleteByQueryRethrottleApi.md) |   | +| `deleteScript` | typeof [deleteScriptApi](./deleteScriptApi.md) |   | +| `enrich` | [EnrichApi](./EnrichApi.md) |   | +| `eql` | [EqlApi](./EqlApi.md) |   | +| `esql` | [EsqlApi](./EsqlApi.md) |   | +| `exists` | typeof [existsApi](./existsApi.md) |   | +| `existsSource` | typeof [existsSourceApi](./existsSourceApi.md) |   | +| `explain` | typeof [explainApi](./explainApi.md) |   | +| `features` | [FeaturesApi](./FeaturesApi.md) |   | +| `fieldCaps` | typeof [fieldCapsApi](./fieldCapsApi.md) |   | +| `fleet` | [FleetApi](./FleetApi.md) |   | +| `get` | typeof [getApi](./getApi.md) |   | +| `getScript` | typeof [getScriptApi](./getScriptApi.md) |   | +| `getScriptContext` | typeof [getScriptContextApi](./getScriptContextApi.md) |   | +| `getScriptLanguages` | typeof [getScriptLanguagesApi](./getScriptLanguagesApi.md) |   | +| `getSource` | typeof [getSourceApi](./getSourceApi.md) |   | +| `graph` | [GraphApi](./GraphApi.md) |   | +| `healthReport` | typeof [healthReportApi](./healthReportApi.md) |   | +| `ilm` | [IlmApi](./IlmApi.md) |   | +| `index` | typeof [indexApi](./indexApi.md) |   | +| `indices` | [IndicesApi](./IndicesApi.md) |   | +| `inference` | [InferenceApi](./InferenceApi.md) |   | +| `info` | typeof [infoApi](./infoApi.md) |   | +| `ingest` | [IngestApi](./IngestApi.md) |   | +| `knnSearch` | typeof [knnSearchApi](./knnSearchApi.md) |   | +| `license` | [LicenseApi](./LicenseApi.md) |   | +| `logstash` | [LogstashApi](./LogstashApi.md) |   | +| `mget` | typeof [mgetApi](./mgetApi.md) |   | +| `migration` | [MigrationApi](./MigrationApi.md) |   | +| `ml` | [MlApi](./MlApi.md) |   | +| `monitoring` | [MonitoringApi](./MonitoringApi.md) |   | +| `msearch` | typeof [msearchApi](./msearchApi.md) |   | +| `msearchTemplate` | typeof [msearchTemplateApi](./msearchTemplateApi.md) |   | +| `mtermvectors` | typeof [mtermvectorsApi](./mtermvectorsApi.md) |   | +| `nodes` | [NodesApi](./NodesApi.md) |   | +| `openPointInTime` | typeof [openPointInTimeApi](./openPointInTimeApi.md) |   | +| `ping` | typeof [pingApi](./pingApi.md) |   | +| `profiling` | [ProfilingApi](./ProfilingApi.md) |   | +| `putScript` | typeof [putScriptApi](./putScriptApi.md) |   | +| `queryRules` | [QueryRulesApi](./QueryRulesApi.md) |   | +| `rankEval` | typeof [rankEvalApi](./rankEvalApi.md) |   | +| `reindex` | typeof [reindexApi](./reindexApi.md) |   | +| `reindexRethrottle` | typeof [reindexRethrottleApi](./reindexRethrottleApi.md) |   | +| `renderSearchTemplate` | typeof [renderSearchTemplateApi](./renderSearchTemplateApi.md) |   | +| `rollup` | [RollupApi](./RollupApi.md) |   | +| `scriptsPainlessExecute` | typeof [scriptsPainlessExecuteApi](./scriptsPainlessExecuteApi.md) |   | +| `scroll` | typeof [scrollApi](./scrollApi.md) |   | +| `search` | typeof [searchApi](./searchApi.md) |   | +| `searchableSnapshots` | [SearchableSnapshotsApi](./SearchableSnapshotsApi.md) |   | +| `searchApplication` | [SearchApplicationApi](./SearchApplicationApi.md) |   | +| `searchMvt` | typeof [searchMvtApi](./searchMvtApi.md) |   | +| `searchShards` | typeof [searchShardsApi](./searchShardsApi.md) |   | +| `searchTemplate` | typeof [searchTemplateApi](./searchTemplateApi.md) |   | +| `security` | [SecurityApi](./SecurityApi.md) |   | +| `shutdown` | [ShutdownApi](./ShutdownApi.md) |   | +| `simulate` | [SimulateApi](./SimulateApi.md) |   | +| `slm` | [SlmApi](./SlmApi.md) |   | +| `snapshot` | [SnapshotApi](./SnapshotApi.md) |   | +| `sql` | [SqlApi](./SqlApi.md) |   | +| `ssl` | [SslApi](./SslApi.md) |   | +| `synonyms` | [SynonymsApi](./SynonymsApi.md) |   | +| `tasks` | [TasksApi](./TasksApi.md) |   | +| `termsEnum` | typeof [termsEnumApi](./termsEnumApi.md) |   | +| `termvectors` | typeof [termvectorsApi](./termvectorsApi.md) |   | +| `textStructure` | [TextStructureApi](./TextStructureApi.md) |   | +| `transform` | [TransformApi](./TransformApi.md) |   | +| `update` | typeof [updateApi](./updateApi.md) |   | +| `updateByQuery` | typeof [updateByQueryApi](./updateByQueryApi.md) |   | +| `updateByQueryRethrottle` | typeof [updateByQueryRethrottleApi](./updateByQueryRethrottleApi.md) |   | +| `watcher` | [WatcherApi](./WatcherApi.md) |   | +| `xpack` | [XpackApi](./XpackApi.md) |   | diff --git a/docs/reference/api/AcknowledgedResponseBase.md b/docs/reference/api/AcknowledgedResponseBase.md new file mode 100644 index 000000000..bf1f8d932 --- /dev/null +++ b/docs/reference/api/AcknowledgedResponseBase.md @@ -0,0 +1,5 @@ +## Interface `AcknowledgedResponseBase` + +| Name | Type | Description | +| - | - | - | +| `acknowledged` | boolean | For a successful response, this value is always true. On failure, an exception is returned instead. | diff --git a/docs/reference/api/Action.md b/docs/reference/api/Action.md new file mode 100644 index 000000000..becfb8034 --- /dev/null +++ b/docs/reference/api/Action.md @@ -0,0 +1,4 @@ +## `Action` +::: +type Action = [IndexAction](./IndexAction.md) | [CreateAction](./CreateAction.md) | [UpdateAction](./UpdateAction.md) | [DeleteAction](./DeleteAction.md); +::: diff --git a/docs/reference/api/AggregateName.md b/docs/reference/api/AggregateName.md new file mode 100644 index 000000000..9c1fd5077 --- /dev/null +++ b/docs/reference/api/AggregateName.md @@ -0,0 +1,4 @@ +## `AggregateName` +::: +type AggregateName = string; +::: diff --git a/docs/reference/api/AggregationsAdjacencyMatrixAggregate.md b/docs/reference/api/AggregationsAdjacencyMatrixAggregate.md new file mode 100644 index 000000000..fb626e398 --- /dev/null +++ b/docs/reference/api/AggregationsAdjacencyMatrixAggregate.md @@ -0,0 +1,4 @@ +## Interface `AggregationsAdjacencyMatrixAggregate` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/AggregationsAdjacencyMatrixAggregation.md b/docs/reference/api/AggregationsAdjacencyMatrixAggregation.md new file mode 100644 index 000000000..b4bc5bbb0 --- /dev/null +++ b/docs/reference/api/AggregationsAdjacencyMatrixAggregation.md @@ -0,0 +1,6 @@ +## Interface `AggregationsAdjacencyMatrixAggregation` + +| Name | Type | Description | +| - | - | - | +| `filters` | Record | Filters used to create buckets. At least one filter is required. | +| `separator` | string | Separator used to concatenate filter names. Defaults to &. | diff --git a/docs/reference/api/AggregationsAdjacencyMatrixBucket.md b/docs/reference/api/AggregationsAdjacencyMatrixBucket.md new file mode 100644 index 000000000..f5eefdeb0 --- /dev/null +++ b/docs/reference/api/AggregationsAdjacencyMatrixBucket.md @@ -0,0 +1,4 @@ +## `AggregationsAdjacencyMatrixBucket` +::: +type AggregationsAdjacencyMatrixBucket = [AggregationsAdjacencyMatrixBucketKeys](./AggregationsAdjacencyMatrixBucketKeys.md) & { [property: string]: [AggregationsAggregate](./AggregationsAggregate.md) | string | [long](./long.md);}; +::: diff --git a/docs/reference/api/AggregationsAdjacencyMatrixBucketKeys.md b/docs/reference/api/AggregationsAdjacencyMatrixBucketKeys.md new file mode 100644 index 000000000..ab6fb4a19 --- /dev/null +++ b/docs/reference/api/AggregationsAdjacencyMatrixBucketKeys.md @@ -0,0 +1,5 @@ +## Interface `AggregationsAdjacencyMatrixBucketKeys` + +| Name | Type | Description | +| - | - | - | +| `key` | string |   | diff --git a/docs/reference/api/AggregationsAggregate.md b/docs/reference/api/AggregationsAggregate.md new file mode 100644 index 000000000..c95020134 --- /dev/null +++ b/docs/reference/api/AggregationsAggregate.md @@ -0,0 +1,4 @@ +## `AggregationsAggregate` +::: +type AggregationsAggregate = [AggregationsCardinalityAggregate](./AggregationsCardinalityAggregate.md) | [AggregationsHdrPercentilesAggregate](./AggregationsHdrPercentilesAggregate.md) | [AggregationsHdrPercentileRanksAggregate](./AggregationsHdrPercentileRanksAggregate.md) | [AggregationsTDigestPercentilesAggregate](./AggregationsTDigestPercentilesAggregate.md) | [AggregationsTDigestPercentileRanksAggregate](./AggregationsTDigestPercentileRanksAggregate.md) | [AggregationsPercentilesBucketAggregate](./AggregationsPercentilesBucketAggregate.md) | [AggregationsMedianAbsoluteDeviationAggregate](./AggregationsMedianAbsoluteDeviationAggregate.md) | [AggregationsMinAggregate](./AggregationsMinAggregate.md) | [AggregationsMaxAggregate](./AggregationsMaxAggregate.md) | [AggregationsSumAggregate](./AggregationsSumAggregate.md) | [AggregationsAvgAggregate](./AggregationsAvgAggregate.md) | [AggregationsWeightedAvgAggregate](./AggregationsWeightedAvgAggregate.md) | [AggregationsValueCountAggregate](./AggregationsValueCountAggregate.md) | [AggregationsSimpleValueAggregate](./AggregationsSimpleValueAggregate.md) | [AggregationsDerivativeAggregate](./AggregationsDerivativeAggregate.md) | [AggregationsBucketMetricValueAggregate](./AggregationsBucketMetricValueAggregate.md) | [AggregationsStatsAggregate](./AggregationsStatsAggregate.md) | [AggregationsStatsBucketAggregate](./AggregationsStatsBucketAggregate.md) | [AggregationsExtendedStatsAggregate](./AggregationsExtendedStatsAggregate.md) | [AggregationsExtendedStatsBucketAggregate](./AggregationsExtendedStatsBucketAggregate.md) | [AggregationsGeoBoundsAggregate](./AggregationsGeoBoundsAggregate.md) | [AggregationsGeoCentroidAggregate](./AggregationsGeoCentroidAggregate.md) | [AggregationsHistogramAggregate](./AggregationsHistogramAggregate.md) | [AggregationsDateHistogramAggregate](./AggregationsDateHistogramAggregate.md) | [AggregationsAutoDateHistogramAggregate](./AggregationsAutoDateHistogramAggregate.md) | [AggregationsVariableWidthHistogramAggregate](./AggregationsVariableWidthHistogramAggregate.md) | [AggregationsStringTermsAggregate](./AggregationsStringTermsAggregate.md) | [AggregationsLongTermsAggregate](./AggregationsLongTermsAggregate.md) | [AggregationsDoubleTermsAggregate](./AggregationsDoubleTermsAggregate.md) | [AggregationsUnmappedTermsAggregate](./AggregationsUnmappedTermsAggregate.md) | [AggregationsLongRareTermsAggregate](./AggregationsLongRareTermsAggregate.md) | [AggregationsStringRareTermsAggregate](./AggregationsStringRareTermsAggregate.md) | [AggregationsUnmappedRareTermsAggregate](./AggregationsUnmappedRareTermsAggregate.md) | [AggregationsMultiTermsAggregate](./AggregationsMultiTermsAggregate.md) | [AggregationsMissingAggregate](./AggregationsMissingAggregate.md) | [AggregationsNestedAggregate](./AggregationsNestedAggregate.md) | [AggregationsReverseNestedAggregate](./AggregationsReverseNestedAggregate.md) | [AggregationsGlobalAggregate](./AggregationsGlobalAggregate.md) | [AggregationsFilterAggregate](./AggregationsFilterAggregate.md) | [AggregationsChildrenAggregate](./AggregationsChildrenAggregate.md) | [AggregationsParentAggregate](./AggregationsParentAggregate.md) | [AggregationsSamplerAggregate](./AggregationsSamplerAggregate.md) | [AggregationsUnmappedSamplerAggregate](./AggregationsUnmappedSamplerAggregate.md) | [AggregationsGeoHashGridAggregate](./AggregationsGeoHashGridAggregate.md) | [AggregationsGeoTileGridAggregate](./AggregationsGeoTileGridAggregate.md) | [AggregationsGeoHexGridAggregate](./AggregationsGeoHexGridAggregate.md) | [AggregationsRangeAggregate](./AggregationsRangeAggregate.md) | [AggregationsDateRangeAggregate](./AggregationsDateRangeAggregate.md) | [AggregationsGeoDistanceAggregate](./AggregationsGeoDistanceAggregate.md) | [AggregationsIpRangeAggregate](./AggregationsIpRangeAggregate.md) | [AggregationsIpPrefixAggregate](./AggregationsIpPrefixAggregate.md) | [AggregationsFiltersAggregate](./AggregationsFiltersAggregate.md) | [AggregationsAdjacencyMatrixAggregate](./AggregationsAdjacencyMatrixAggregate.md) | [AggregationsSignificantLongTermsAggregate](./AggregationsSignificantLongTermsAggregate.md) | [AggregationsSignificantStringTermsAggregate](./AggregationsSignificantStringTermsAggregate.md) | [AggregationsUnmappedSignificantTermsAggregate](./AggregationsUnmappedSignificantTermsAggregate.md) | [AggregationsCompositeAggregate](./AggregationsCompositeAggregate.md) | [AggregationsFrequentItemSetsAggregate](./AggregationsFrequentItemSetsAggregate.md) | [AggregationsTimeSeriesAggregate](./AggregationsTimeSeriesAggregate.md) | [AggregationsScriptedMetricAggregate](./AggregationsScriptedMetricAggregate.md) | [AggregationsTopHitsAggregate](./AggregationsTopHitsAggregate.md) | [AggregationsInferenceAggregate](./AggregationsInferenceAggregate.md) | [AggregationsStringStatsAggregate](./AggregationsStringStatsAggregate.md) | [AggregationsBoxPlotAggregate](./AggregationsBoxPlotAggregate.md) | [AggregationsTopMetricsAggregate](./AggregationsTopMetricsAggregate.md) | [AggregationsTTestAggregate](./AggregationsTTestAggregate.md) | [AggregationsRateAggregate](./AggregationsRateAggregate.md) | [AggregationsCumulativeCardinalityAggregate](./AggregationsCumulativeCardinalityAggregate.md) | [AggregationsMatrixStatsAggregate](./AggregationsMatrixStatsAggregate.md) | [AggregationsGeoLineAggregate](./AggregationsGeoLineAggregate.md); +::: diff --git a/docs/reference/api/AggregationsAggregateBase.md b/docs/reference/api/AggregationsAggregateBase.md new file mode 100644 index 000000000..9f16a5c0b --- /dev/null +++ b/docs/reference/api/AggregationsAggregateBase.md @@ -0,0 +1,5 @@ +## Interface `AggregationsAggregateBase` + +| Name | Type | Description | +| - | - | - | +| `meta` | [Metadata](./Metadata.md) |   | diff --git a/docs/reference/api/AggregationsAggregateOrder.md b/docs/reference/api/AggregationsAggregateOrder.md new file mode 100644 index 000000000..36bc9db21 --- /dev/null +++ b/docs/reference/api/AggregationsAggregateOrder.md @@ -0,0 +1,4 @@ +## `AggregationsAggregateOrder` +::: +type AggregationsAggregateOrder = [Partial](./Partial.md)> | [Partial](./Partial.md)>[]; +::: diff --git a/docs/reference/api/AggregationsAggregation.md b/docs/reference/api/AggregationsAggregation.md new file mode 100644 index 000000000..a6c17e10d --- /dev/null +++ b/docs/reference/api/AggregationsAggregation.md @@ -0,0 +1,4 @@ +## Interface `AggregationsAggregation` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/AggregationsAggregationContainer.md b/docs/reference/api/AggregationsAggregationContainer.md new file mode 100644 index 000000000..f2ee16502 --- /dev/null +++ b/docs/reference/api/AggregationsAggregationContainer.md @@ -0,0 +1,85 @@ +## Interface `AggregationsAggregationContainer` + +| Name | Type | Description | +| - | - | - | +| `adjacency_matrix` | [AggregationsAdjacencyMatrixAggregation](./AggregationsAdjacencyMatrixAggregation.md) | A bucket aggregation returning a form of adjacency matrix. The request provides a collection of named filter expressions, similar to the `filters` aggregation. Each bucket in the response represents a non-empty cell in the matrix of intersecting filters. | +| `aggregations` | Record | Sub-aggregations for this aggregation. Only applies to bucket aggregations. | +| `aggs` | Record | Sub-aggregations for this aggregation. Only applies to bucket aggregations. aggregations | +| `auto_date_histogram` | [AggregationsAutoDateHistogramAggregation](./AggregationsAutoDateHistogramAggregation.md) | A multi-bucket aggregation similar to the date histogram, except instead of providing an interval to use as the width of each bucket, a target number of buckets is provided. | +| `avg_bucket` | [AggregationsAverageBucketAggregation](./AggregationsAverageBucketAggregation.md) | A sibling pipeline aggregation which calculates the mean value of a specified metric in a sibling aggregation. The specified metric must be numeric and the sibling aggregation must be a multi-bucket aggregation. | +| `avg` | [AggregationsAverageAggregation](./AggregationsAverageAggregation.md) | A single-value metrics aggregation that computes the average of numeric values that are extracted from the aggregated documents. | +| `boxplot` | [AggregationsBoxplotAggregation](./AggregationsBoxplotAggregation.md) | A metrics aggregation that computes a box plot of numeric values extracted from the aggregated documents. | +| `bucket_correlation` | [AggregationsBucketCorrelationAggregation](./AggregationsBucketCorrelationAggregation.md) | A sibling pipeline aggregation which runs a correlation function on the configured sibling multi-bucket aggregation. | +| `bucket_count_ks_test` | [AggregationsBucketKsAggregation](./AggregationsBucketKsAggregation.md) | A sibling pipeline aggregation which runs a two sample Kolmogorov–Smirnov test ("K-S test") against a provided distribution and the distribution implied by the documents counts in the configured sibling aggregation. | +| `bucket_script` | [AggregationsBucketScriptAggregation](./AggregationsBucketScriptAggregation.md) | A parent pipeline aggregation which runs a script which can perform per bucket computations on metrics in the parent multi-bucket aggregation. | +| `bucket_selector` | [AggregationsBucketSelectorAggregation](./AggregationsBucketSelectorAggregation.md) | A parent pipeline aggregation which runs a script to determine whether the current bucket will be retained in the parent multi-bucket aggregation. | +| `bucket_sort` | [AggregationsBucketSortAggregation](./AggregationsBucketSortAggregation.md) | A parent pipeline aggregation which sorts the buckets of its parent multi-bucket aggregation. | +| `cardinality` | [AggregationsCardinalityAggregation](./AggregationsCardinalityAggregation.md) | A single-value metrics aggregation that calculates an approximate count of distinct values. | +| `categorize_text` | [AggregationsCategorizeTextAggregation](./AggregationsCategorizeTextAggregation.md) | A multi-bucket aggregation that groups semi-structured text into buckets. | +| `children` | [AggregationsChildrenAggregation](./AggregationsChildrenAggregation.md) | A single bucket aggregation that selects child documents that have the specified type, as defined in a `join` field. | +| `composite` | [AggregationsCompositeAggregation](./AggregationsCompositeAggregation.md) | A multi-bucket aggregation that creates composite buckets from different sources. Unlike the other multi-bucket aggregations, you can use the `composite` aggregation to paginate *all* buckets from a multi-level aggregation efficiently. | +| `cumulative_cardinality` | [AggregationsCumulativeCardinalityAggregation](./AggregationsCumulativeCardinalityAggregation.md) | A parent pipeline aggregation which calculates the cumulative cardinality in a parent `histogram` or `date_histogram` aggregation. | +| `cumulative_sum` | [AggregationsCumulativeSumAggregation](./AggregationsCumulativeSumAggregation.md) | A parent pipeline aggregation which calculates the cumulative sum of a specified metric in a parent `histogram` or `date_histogram` aggregation. | +| `date_histogram` | [AggregationsDateHistogramAggregation](./AggregationsDateHistogramAggregation.md) | A multi-bucket values source based aggregation that can be applied on date values or date range values extracted from the documents. It dynamically builds fixed size (interval) buckets over the values. | +| `date_range` | [AggregationsDateRangeAggregation](./AggregationsDateRangeAggregation.md) | A multi-bucket value source based aggregation that enables the user to define a set of date ranges - each representing a bucket. | +| `derivative` | [AggregationsDerivativeAggregation](./AggregationsDerivativeAggregation.md) | A parent pipeline aggregation which calculates the derivative of a specified metric in a parent `histogram` or `date_histogram` aggregation. | +| `diversified_sampler` | [AggregationsDiversifiedSamplerAggregation](./AggregationsDiversifiedSamplerAggregation.md) | A filtering aggregation used to limit any sub aggregations' processing to a sample of the top-scoring documents. Similar to the `sampler` aggregation, but adds the ability to limit the number of matches that share a common value. | +| `extended_stats_bucket` | [AggregationsExtendedStatsBucketAggregation](./AggregationsExtendedStatsBucketAggregation.md) | A sibling pipeline aggregation which calculates a variety of stats across all bucket of a specified metric in a sibling aggregation. | +| `extended_stats` | [AggregationsExtendedStatsAggregation](./AggregationsExtendedStatsAggregation.md) | A multi-value metrics aggregation that computes stats over numeric values extracted from the aggregated documents. | +| `filter` | [QueryDslQueryContainer](./QueryDslQueryContainer.md) | A single bucket aggregation that narrows the set of documents to those that match a query. | +| `filters` | [AggregationsFiltersAggregation](./AggregationsFiltersAggregation.md) | A multi-bucket aggregation where each bucket contains the documents that match a query. | +| `frequent_item_sets` | [AggregationsFrequentItemSetsAggregation](./AggregationsFrequentItemSetsAggregation.md) | A bucket aggregation which finds frequent item sets, a form of association rules mining that identifies items that often occur together. | +| `geo_bounds` | [AggregationsGeoBoundsAggregation](./AggregationsGeoBoundsAggregation.md) | A metric aggregation that computes the geographic bounding box containing all values for a Geopoint or Geoshape field. | +| `geo_centroid` | [AggregationsGeoCentroidAggregation](./AggregationsGeoCentroidAggregation.md) | A metric aggregation that computes the weighted centroid from all coordinate values for geo fields. | +| `geo_distance` | [AggregationsGeoDistanceAggregation](./AggregationsGeoDistanceAggregation.md) | A multi-bucket aggregation that works on `geo_point` fields. Evaluates the distance of each document value from an origin point and determines the buckets it belongs to, based on ranges defined in the request. | +| `geo_line` | [AggregationsGeoLineAggregation](./AggregationsGeoLineAggregation.md) | Aggregates all `geo_point` values within a bucket into a `LineString` ordered by the chosen sort field. | +| `geohash_grid` | [AggregationsGeoHashGridAggregation](./AggregationsGeoHashGridAggregation.md) | A multi-bucket aggregation that groups `geo_point` and `geo_shape` values into buckets that represent a grid. Each cell is labeled using a geohash which is of user-definable precision. | +| `geohex_grid` | [AggregationsGeohexGridAggregation](./AggregationsGeohexGridAggregation.md) | A multi-bucket aggregation that groups `geo_point` and `geo_shape` values into buckets that represent a grid. Each cell corresponds to a H3 cell index and is labeled using the H3Index representation. | +| `geotile_grid` | [AggregationsGeoTileGridAggregation](./AggregationsGeoTileGridAggregation.md) | A multi-bucket aggregation that groups `geo_point` and `geo_shape` values into buckets that represent a grid. Each cell corresponds to a map tile as used by many online map sites. | +| `global` | [AggregationsGlobalAggregation](./AggregationsGlobalAggregation.md) | Defines a single bucket of all the documents within the search execution context. This context is defined by the indices and the document types you’re searching on, but is not influenced by the search query itself. | +| `histogram` | [AggregationsHistogramAggregation](./AggregationsHistogramAggregation.md) | A multi-bucket values source based aggregation that can be applied on numeric values or numeric range values extracted from the documents. It dynamically builds fixed size (interval) buckets over the values. | +| `inference` | [AggregationsInferenceAggregation](./AggregationsInferenceAggregation.md) | A parent pipeline aggregation which loads a pre-trained model and performs inference on the collated result fields from the parent bucket aggregation. | +| `ip_prefix` | [AggregationsIpPrefixAggregation](./AggregationsIpPrefixAggregation.md) | A bucket aggregation that groups documents based on the network or sub-network of an IP address. | +| `ip_range` | [AggregationsIpRangeAggregation](./AggregationsIpRangeAggregation.md) | A multi-bucket value source based aggregation that enables the user to define a set of IP ranges - each representing a bucket. | +| `line` | [AggregationsGeoLineAggregation](./AggregationsGeoLineAggregation.md) |   | +| `matrix_stats` | [AggregationsMatrixStatsAggregation](./AggregationsMatrixStatsAggregation.md) | A numeric aggregation that computes the following statistics over a set of document fields: `count`, `mean`, `variance`, `skewness`, `kurtosis`, `covariance`, and `covariance`. | +| `max_bucket` | [AggregationsMaxBucketAggregation](./AggregationsMaxBucketAggregation.md) | A sibling pipeline aggregation which identifies the bucket(s) with the maximum value of a specified metric in a sibling aggregation and outputs both the value and the key(s) of the bucket(s). | +| `max` | [AggregationsMaxAggregation](./AggregationsMaxAggregation.md) | A single-value metrics aggregation that returns the maximum value among the numeric values extracted from the aggregated documents. | +| `median_absolute_deviation` | [AggregationsMedianAbsoluteDeviationAggregation](./AggregationsMedianAbsoluteDeviationAggregation.md) | A single-value aggregation that approximates the median absolute deviation of its search results. | +| `meta` | [Metadata](./Metadata.md) |   | +| `min_bucket` | [AggregationsMinBucketAggregation](./AggregationsMinBucketAggregation.md) | A sibling pipeline aggregation which identifies the bucket(s) with the minimum value of a specified metric in a sibling aggregation and outputs both the value and the key(s) of the bucket(s). | +| `min` | [AggregationsMinAggregation](./AggregationsMinAggregation.md) | A single-value metrics aggregation that returns the minimum value among numeric values extracted from the aggregated documents. | +| `missing` | [AggregationsMissingAggregation](./AggregationsMissingAggregation.md) | A field data based single bucket aggregation, that creates a bucket of all documents in the current document set context that are missing a field value (effectively, missing a field or having the configured NULL value set). | +| `moving_avg` | [AggregationsMovingAverageAggregation](./AggregationsMovingAverageAggregation.md) |   | +| `moving_fn` | [AggregationsMovingFunctionAggregation](./AggregationsMovingFunctionAggregation.md) | Given an ordered series of data, "slides" a window across the data and runs a custom script on each window of data. For convenience, a number of common functions are predefined such as `min`, `max`, and moving averages. | +| `moving_percentiles` | [AggregationsMovingPercentilesAggregation](./AggregationsMovingPercentilesAggregation.md) | Given an ordered series of percentiles, "slides" a window across those percentiles and computes cumulative percentiles. | +| `multi_terms` | [AggregationsMultiTermsAggregation](./AggregationsMultiTermsAggregation.md) | A multi-bucket value source based aggregation where buckets are dynamically built - one per unique set of values. | +| `nested` | [AggregationsNestedAggregation](./AggregationsNestedAggregation.md) | A special single bucket aggregation that enables aggregating nested documents. | +| `normalize` | [AggregationsNormalizeAggregation](./AggregationsNormalizeAggregation.md) | A parent pipeline aggregation which calculates the specific normalized/rescaled value for a specific bucket value. | +| `parent` | [AggregationsParentAggregation](./AggregationsParentAggregation.md) | A special single bucket aggregation that selects parent documents that have the specified type, as defined in a `join` field. | +| `percentile_ranks` | [AggregationsPercentileRanksAggregation](./AggregationsPercentileRanksAggregation.md) | A multi-value metrics aggregation that calculates one or more percentile ranks over numeric values extracted from the aggregated documents. | +| `percentiles_bucket` | [AggregationsPercentilesBucketAggregation](./AggregationsPercentilesBucketAggregation.md) | A sibling pipeline aggregation which calculates percentiles across all bucket of a specified metric in a sibling aggregation. | +| `percentiles` | [AggregationsPercentilesAggregation](./AggregationsPercentilesAggregation.md) | A multi-value metrics aggregation that calculates one or more percentiles over numeric values extracted from the aggregated documents. | +| `random_sampler` | [AggregationsRandomSamplerAggregation](./AggregationsRandomSamplerAggregation.md) | A single bucket aggregation that randomly includes documents in the aggregated results. Sampling provides significant speed improvement at the cost of accuracy. | +| `range` | [AggregationsRangeAggregation](./AggregationsRangeAggregation.md) | A multi-bucket value source based aggregation that enables the user to define a set of ranges - each representing a bucket. | +| `rare_terms` | [AggregationsRareTermsAggregation](./AggregationsRareTermsAggregation.md) | A multi-bucket value source based aggregation which finds "rare" terms—terms that are at the long-tail of the distribution and are not frequent. | +| `rate` | [AggregationsRateAggregation](./AggregationsRateAggregation.md) | Calculates a rate of documents or a field in each bucket. Can only be used inside a `date_histogram` or `composite` aggregation. | +| `reverse_nested` | [AggregationsReverseNestedAggregation](./AggregationsReverseNestedAggregation.md) | A special single bucket aggregation that enables aggregating on parent documents from nested documents. Should only be defined inside a `nested` aggregation. | +| `sampler` | [AggregationsSamplerAggregation](./AggregationsSamplerAggregation.md) | A filtering aggregation used to limit any sub aggregations' processing to a sample of the top-scoring documents. | +| `scripted_metric` | [AggregationsScriptedMetricAggregation](./AggregationsScriptedMetricAggregation.md) | A metric aggregation that uses scripts to provide a metric output. | +| `serial_diff` | [AggregationsSerialDifferencingAggregation](./AggregationsSerialDifferencingAggregation.md) | An aggregation that subtracts values in a time series from themselves at different time lags or periods. | +| `significant_terms` | [AggregationsSignificantTermsAggregation](./AggregationsSignificantTermsAggregation.md) | Returns interesting or unusual occurrences of terms in a set. | +| `significant_text` | [AggregationsSignificantTextAggregation](./AggregationsSignificantTextAggregation.md) | Returns interesting or unusual occurrences of free-text terms in a set. | +| `stats_bucket` | [AggregationsStatsBucketAggregation](./AggregationsStatsBucketAggregation.md) | A sibling pipeline aggregation which calculates a variety of stats across all bucket of a specified metric in a sibling aggregation. | +| `stats` | [AggregationsStatsAggregation](./AggregationsStatsAggregation.md) | A multi-value metrics aggregation that computes stats over numeric values extracted from the aggregated documents. | +| `string_stats` | [AggregationsStringStatsAggregation](./AggregationsStringStatsAggregation.md) | A multi-value metrics aggregation that computes statistics over string values extracted from the aggregated documents. | +| `sum_bucket` | [AggregationsSumBucketAggregation](./AggregationsSumBucketAggregation.md) | A sibling pipeline aggregation which calculates the sum of a specified metric across all buckets in a sibling aggregation. | +| `sum` | [AggregationsSumAggregation](./AggregationsSumAggregation.md) | A single-value metrics aggregation that sums numeric values that are extracted from the aggregated documents. | +| `t_test` | [AggregationsTTestAggregation](./AggregationsTTestAggregation.md) | A metrics aggregation that performs a statistical hypothesis test in which the test statistic follows a Student’s t-distribution under the null hypothesis on numeric values extracted from the aggregated documents. | +| `terms` | [AggregationsTermsAggregation](./AggregationsTermsAggregation.md) | A multi-bucket value source based aggregation where buckets are dynamically built - one per unique value. | +| `time_series` | [AggregationsTimeSeriesAggregation](./AggregationsTimeSeriesAggregation.md) | The time series aggregation queries data created using a time series index. This is typically data such as metrics or other data streams with a time component, and requires creating an index using the time series mode. | +| `top_hits` | [AggregationsTopHitsAggregation](./AggregationsTopHitsAggregation.md) | A metric aggregation that returns the top matching documents per bucket. | +| `top_metrics` | [AggregationsTopMetricsAggregation](./AggregationsTopMetricsAggregation.md) | A metric aggregation that selects metrics from the document with the largest or smallest sort value. | +| `value_count` | [AggregationsValueCountAggregation](./AggregationsValueCountAggregation.md) | A single-value metrics aggregation that counts the number of values that are extracted from the aggregated documents. | +| `variable_width_histogram` | [AggregationsVariableWidthHistogramAggregation](./AggregationsVariableWidthHistogramAggregation.md) | A multi-bucket aggregation similar to the histogram, except instead of providing an interval to use as the width of each bucket, a target number of buckets is provided. | +| `weighted_avg` | [AggregationsWeightedAverageAggregation](./AggregationsWeightedAverageAggregation.md) | A single-value metrics aggregation that computes the weighted average of numeric values that are extracted from the aggregated documents. | diff --git a/docs/reference/api/AggregationsAggregationRange.md b/docs/reference/api/AggregationsAggregationRange.md new file mode 100644 index 000000000..5b9275c9b --- /dev/null +++ b/docs/reference/api/AggregationsAggregationRange.md @@ -0,0 +1,7 @@ +## Interface `AggregationsAggregationRange` + +| Name | Type | Description | +| - | - | - | +| `from` | [double](./double.md) | null | Start of the range (inclusive). | +| `key` | string | Custom key to return the range with. | +| `to` | [double](./double.md) | null | End of the range (exclusive). | diff --git a/docs/reference/api/AggregationsArrayPercentilesItem.md b/docs/reference/api/AggregationsArrayPercentilesItem.md new file mode 100644 index 000000000..b03d277f5 --- /dev/null +++ b/docs/reference/api/AggregationsArrayPercentilesItem.md @@ -0,0 +1,7 @@ +## Interface `AggregationsArrayPercentilesItem` + +| Name | Type | Description | +| - | - | - | +| `key` | string |   | +| `value_as_string` | string |   | +| `value` | [double](./double.md) | null |   | diff --git a/docs/reference/api/AggregationsAutoDateHistogramAggregate.md b/docs/reference/api/AggregationsAutoDateHistogramAggregate.md new file mode 100644 index 000000000..08f862956 --- /dev/null +++ b/docs/reference/api/AggregationsAutoDateHistogramAggregate.md @@ -0,0 +1,5 @@ +## Interface `AggregationsAutoDateHistogramAggregate` + +| Name | Type | Description | +| - | - | - | +| `interval` | [DurationLarge](./DurationLarge.md) |   | diff --git a/docs/reference/api/AggregationsAutoDateHistogramAggregation.md b/docs/reference/api/AggregationsAutoDateHistogramAggregation.md new file mode 100644 index 000000000..eb9fd3f7e --- /dev/null +++ b/docs/reference/api/AggregationsAutoDateHistogramAggregation.md @@ -0,0 +1,13 @@ +## Interface `AggregationsAutoDateHistogramAggregation` + +| Name | Type | Description | +| - | - | - | +| `buckets` | [integer](./integer.md) | The target number of buckets. | +| `field` | [Field](./Field.md) | The field on which to run the aggregation. | +| `format` | string | The date format used to format `key_as_string` in the response. If no `format` is specified, the first date format specified in the field mapping is used. | +| `minimum_interval` | [AggregationsMinimumInterval](./AggregationsMinimumInterval.md) | The minimum rounding interval. This can make the collection process more efficient, as the aggregation will not attempt to round at any interval lower than `minimum_interval`. | +| `missing` | [DateTime](./DateTime.md) | The value to apply to documents that do not have a value. By default, documents without a value are ignored. | +| `offset` | string | Time zone specified as a ISO 8601 UTC offset. | +| `params` | Record |   | +| `script` | [Script](./Script.md) | [ScriptSource](./ScriptSource.md) |   | +| `time_zone` | [TimeZone](./TimeZone.md) | Time zone ID. | diff --git a/docs/reference/api/AggregationsAverageAggregation.md b/docs/reference/api/AggregationsAverageAggregation.md new file mode 100644 index 000000000..88dcdef9f --- /dev/null +++ b/docs/reference/api/AggregationsAverageAggregation.md @@ -0,0 +1,4 @@ +## Interface `AggregationsAverageAggregation` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/AggregationsAverageBucketAggregation.md b/docs/reference/api/AggregationsAverageBucketAggregation.md new file mode 100644 index 000000000..1e71c2336 --- /dev/null +++ b/docs/reference/api/AggregationsAverageBucketAggregation.md @@ -0,0 +1,4 @@ +## Interface `AggregationsAverageBucketAggregation` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/AggregationsAvgAggregate.md b/docs/reference/api/AggregationsAvgAggregate.md new file mode 100644 index 000000000..42c3bc744 --- /dev/null +++ b/docs/reference/api/AggregationsAvgAggregate.md @@ -0,0 +1,4 @@ +## Interface `AggregationsAvgAggregate` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/AggregationsBoxPlotAggregate.md b/docs/reference/api/AggregationsBoxPlotAggregate.md new file mode 100644 index 000000000..f99b70f9f --- /dev/null +++ b/docs/reference/api/AggregationsBoxPlotAggregate.md @@ -0,0 +1,18 @@ +## Interface `AggregationsBoxPlotAggregate` + +| Name | Type | Description | +| - | - | - | +| `lower_as_string` | string |   | +| `lower` | [double](./double.md) |   | +| `max_as_string` | string |   | +| `max` | [double](./double.md) |   | +| `min_as_string` | string |   | +| `min` | [double](./double.md) |   | +| `q1_as_string` | string |   | +| `q1` | [double](./double.md) |   | +| `q2_as_string` | string |   | +| `q2` | [double](./double.md) |   | +| `q3_as_string` | string |   | +| `q3` | [double](./double.md) |   | +| `upper_as_string` | string |   | +| `upper` | [double](./double.md) |   | diff --git a/docs/reference/api/AggregationsBoxplotAggregation.md b/docs/reference/api/AggregationsBoxplotAggregation.md new file mode 100644 index 000000000..3870d5b41 --- /dev/null +++ b/docs/reference/api/AggregationsBoxplotAggregation.md @@ -0,0 +1,5 @@ +## Interface `AggregationsBoxplotAggregation` + +| Name | Type | Description | +| - | - | - | +| `compression` | [double](./double.md) | Limits the maximum number of nodes used by the underlying TDigest algorithm to `20 * compression`, enabling control of memory usage and approximation error. | diff --git a/docs/reference/api/AggregationsBucketAggregationBase.md b/docs/reference/api/AggregationsBucketAggregationBase.md new file mode 100644 index 000000000..575601551 --- /dev/null +++ b/docs/reference/api/AggregationsBucketAggregationBase.md @@ -0,0 +1,4 @@ +## Interface `AggregationsBucketAggregationBase` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/AggregationsBucketCorrelationAggregation.md b/docs/reference/api/AggregationsBucketCorrelationAggregation.md new file mode 100644 index 000000000..233828aa8 --- /dev/null +++ b/docs/reference/api/AggregationsBucketCorrelationAggregation.md @@ -0,0 +1,5 @@ +## Interface `AggregationsBucketCorrelationAggregation` + +| Name | Type | Description | +| - | - | - | +| `function` | [AggregationsBucketCorrelationFunction](./AggregationsBucketCorrelationFunction.md) | The correlation function to execute. | diff --git a/docs/reference/api/AggregationsBucketCorrelationFunction.md b/docs/reference/api/AggregationsBucketCorrelationFunction.md new file mode 100644 index 000000000..210fe79bc --- /dev/null +++ b/docs/reference/api/AggregationsBucketCorrelationFunction.md @@ -0,0 +1,5 @@ +## Interface `AggregationsBucketCorrelationFunction` + +| Name | Type | Description | +| - | - | - | +| `count_correlation` | [AggregationsBucketCorrelationFunctionCountCorrelation](./AggregationsBucketCorrelationFunctionCountCorrelation.md) | The configuration to calculate a count correlation. This function is designed for determining the correlation of a term value and a given metric. | diff --git a/docs/reference/api/AggregationsBucketCorrelationFunctionCountCorrelation.md b/docs/reference/api/AggregationsBucketCorrelationFunctionCountCorrelation.md new file mode 100644 index 000000000..e68e82e49 --- /dev/null +++ b/docs/reference/api/AggregationsBucketCorrelationFunctionCountCorrelation.md @@ -0,0 +1,5 @@ +## Interface `AggregationsBucketCorrelationFunctionCountCorrelation` + +| Name | Type | Description | +| - | - | - | +| `indicator` | [AggregationsBucketCorrelationFunctionCountCorrelationIndicator](./AggregationsBucketCorrelationFunctionCountCorrelationIndicator.md) | The indicator with which to correlate the configured `bucket_path` values. | diff --git a/docs/reference/api/AggregationsBucketCorrelationFunctionCountCorrelationIndicator.md b/docs/reference/api/AggregationsBucketCorrelationFunctionCountCorrelationIndicator.md new file mode 100644 index 000000000..544e71411 --- /dev/null +++ b/docs/reference/api/AggregationsBucketCorrelationFunctionCountCorrelationIndicator.md @@ -0,0 +1,7 @@ +## Interface `AggregationsBucketCorrelationFunctionCountCorrelationIndicator` + +| Name | Type | Description | +| - | - | - | +| `doc_count` | [integer](./integer.md) | The total number of documents that initially created the expectations. It’s required to be greater than or equal to the sum of all values in the buckets_path as this is the originating superset of data to which the term values are correlated. | +| `expectations` | [double](./double.md)[] | An array of numbers with which to correlate the configured `bucket_path` values. The length of this value must always equal the number of buckets returned by the `bucket_path`. | +| `fractions` | [double](./double.md)[] | An array of fractions to use when averaging and calculating variance. This should be used if the pre-calculated data and the buckets_path have known gaps. The length of fractions, if provided, must equal expectations. | diff --git a/docs/reference/api/AggregationsBucketKsAggregation.md b/docs/reference/api/AggregationsBucketKsAggregation.md new file mode 100644 index 000000000..fbf67d4fc --- /dev/null +++ b/docs/reference/api/AggregationsBucketKsAggregation.md @@ -0,0 +1,7 @@ +## Interface `AggregationsBucketKsAggregation` + +| Name | Type | Description | +| - | - | - | +| `alternative` | string[] | A list of string values indicating which K-S test alternative to calculate. The valid values are: "greater", "less", "two_sided". This parameter is key for determining the K-S statistic used when calculating the K-S test. Default value is all possible alternative hypotheses. | +| `fractions` | [double](./double.md)[] | A list of doubles indicating the distribution of the samples with which to compare to the `buckets_path` results. In typical usage this is the overall proportion of documents in each bucket, which is compared with the actual document proportions in each bucket from the sibling aggregation counts. The default is to assume that overall documents are uniformly distributed on these buckets, which they would be if one used equal percentiles of a metric to define the bucket end points. | +| `sampling_method` | string | Indicates the sampling methodology when calculating the K-S test. Note, this is sampling of the returned values. This determines the cumulative distribution function (CDF) points used comparing the two samples. Default is `upper_tail`, which emphasizes the upper end of the CDF points. Valid options are: `upper_tail`, `uniform`, and `lower_tail`. | diff --git a/docs/reference/api/AggregationsBucketMetricValueAggregate.md b/docs/reference/api/AggregationsBucketMetricValueAggregate.md new file mode 100644 index 000000000..07b2df370 --- /dev/null +++ b/docs/reference/api/AggregationsBucketMetricValueAggregate.md @@ -0,0 +1,5 @@ +## Interface `AggregationsBucketMetricValueAggregate` + +| Name | Type | Description | +| - | - | - | +| `keys` | string[] |   | diff --git a/docs/reference/api/AggregationsBucketPathAggregation.md b/docs/reference/api/AggregationsBucketPathAggregation.md new file mode 100644 index 000000000..341db9797 --- /dev/null +++ b/docs/reference/api/AggregationsBucketPathAggregation.md @@ -0,0 +1,5 @@ +## Interface `AggregationsBucketPathAggregation` + +| Name | Type | Description | +| - | - | - | +| `buckets_path` | [AggregationsBucketsPath](./AggregationsBucketsPath.md) | Path to the buckets that contain one set of values to correlate. | diff --git a/docs/reference/api/AggregationsBucketScriptAggregation.md b/docs/reference/api/AggregationsBucketScriptAggregation.md new file mode 100644 index 000000000..22609f05b --- /dev/null +++ b/docs/reference/api/AggregationsBucketScriptAggregation.md @@ -0,0 +1,5 @@ +## Interface `AggregationsBucketScriptAggregation` + +| Name | Type | Description | +| - | - | - | +| `script` | [Script](./Script.md) | [ScriptSource](./ScriptSource.md) | The script to run for this aggregation. | diff --git a/docs/reference/api/AggregationsBucketSelectorAggregation.md b/docs/reference/api/AggregationsBucketSelectorAggregation.md new file mode 100644 index 000000000..0bc2d0ce3 --- /dev/null +++ b/docs/reference/api/AggregationsBucketSelectorAggregation.md @@ -0,0 +1,5 @@ +## Interface `AggregationsBucketSelectorAggregation` + +| Name | Type | Description | +| - | - | - | +| `script` | [Script](./Script.md) | [ScriptSource](./ScriptSource.md) | The script to run for this aggregation. | diff --git a/docs/reference/api/AggregationsBucketSortAggregation.md b/docs/reference/api/AggregationsBucketSortAggregation.md new file mode 100644 index 000000000..01835e7c2 --- /dev/null +++ b/docs/reference/api/AggregationsBucketSortAggregation.md @@ -0,0 +1,8 @@ +## Interface `AggregationsBucketSortAggregation` + +| Name | Type | Description | +| - | - | - | +| `from` | [integer](./integer.md) | Buckets in positions prior to `from` will be truncated. | +| `gap_policy` | [AggregationsGapPolicy](./AggregationsGapPolicy.md) | The policy to apply when gaps are found in the data. | +| `size` | [integer](./integer.md) | The number of buckets to return. Defaults to all buckets of the parent aggregation. | +| `sort` | [Sort](./Sort.md) | The list of fields to sort on. | diff --git a/docs/reference/api/AggregationsBuckets.md b/docs/reference/api/AggregationsBuckets.md new file mode 100644 index 000000000..cee16d45a --- /dev/null +++ b/docs/reference/api/AggregationsBuckets.md @@ -0,0 +1,4 @@ +## `AggregationsBuckets` +::: +type AggregationsBuckets = Record | TBucket[]; +::: diff --git a/docs/reference/api/AggregationsBucketsPath.md b/docs/reference/api/AggregationsBucketsPath.md new file mode 100644 index 000000000..45002eea6 --- /dev/null +++ b/docs/reference/api/AggregationsBucketsPath.md @@ -0,0 +1,4 @@ +## `AggregationsBucketsPath` +::: +type AggregationsBucketsPath = string | string[] | Record; +::: diff --git a/docs/reference/api/AggregationsCalendarInterval.md b/docs/reference/api/AggregationsCalendarInterval.md new file mode 100644 index 000000000..a6bb000d9 --- /dev/null +++ b/docs/reference/api/AggregationsCalendarInterval.md @@ -0,0 +1,4 @@ +## `AggregationsCalendarInterval` +::: +type AggregationsCalendarInterval = 'second' | '1s' | 'minute' | '1m' | 'hour' | '1h' | 'day' | '1d' | 'week' | '1w' | 'month' | '1M' | 'quarter' | '1q' | 'year' | '1y'; +::: diff --git a/docs/reference/api/AggregationsCardinalityAggregate.md b/docs/reference/api/AggregationsCardinalityAggregate.md new file mode 100644 index 000000000..17dda94fb --- /dev/null +++ b/docs/reference/api/AggregationsCardinalityAggregate.md @@ -0,0 +1,5 @@ +## Interface `AggregationsCardinalityAggregate` + +| Name | Type | Description | +| - | - | - | +| `value` | [long](./long.md) |   | diff --git a/docs/reference/api/AggregationsCardinalityAggregation.md b/docs/reference/api/AggregationsCardinalityAggregation.md new file mode 100644 index 000000000..134a2a8f4 --- /dev/null +++ b/docs/reference/api/AggregationsCardinalityAggregation.md @@ -0,0 +1,7 @@ +## Interface `AggregationsCardinalityAggregation` + +| Name | Type | Description | +| - | - | - | +| `execution_hint` | [AggregationsCardinalityExecutionMode](./AggregationsCardinalityExecutionMode.md) | Mechanism by which cardinality aggregations is run. | +| `precision_threshold` | [integer](./integer.md) | A unique count below which counts are expected to be close to accurate. This allows to trade memory for accuracy. | +| `rehash` | boolean |   | diff --git a/docs/reference/api/AggregationsCardinalityExecutionMode.md b/docs/reference/api/AggregationsCardinalityExecutionMode.md new file mode 100644 index 000000000..ee27db9ed --- /dev/null +++ b/docs/reference/api/AggregationsCardinalityExecutionMode.md @@ -0,0 +1,4 @@ +## `AggregationsCardinalityExecutionMode` +::: +type AggregationsCardinalityExecutionMode = 'global_ordinals' | 'segment_ordinals' | 'direct' | 'save_memory_heuristic' | 'save_time_heuristic'; +::: diff --git a/docs/reference/api/AggregationsCategorizeTextAggregation.md b/docs/reference/api/AggregationsCategorizeTextAggregation.md new file mode 100644 index 000000000..2570d4810 --- /dev/null +++ b/docs/reference/api/AggregationsCategorizeTextAggregation.md @@ -0,0 +1,14 @@ +## Interface `AggregationsCategorizeTextAggregation` + +| Name | Type | Description | +| - | - | - | +| `categorization_analyzer` | [AggregationsCategorizeTextAnalyzer](./AggregationsCategorizeTextAnalyzer.md) | The categorization analyzer specifies how the text is analyzed and tokenized before being categorized. The syntax is very similar to that used to define the analyzer in the analyze API. This property cannot be used at the same time as `categorization_filters`. | +| `categorization_filters` | string[] | This property expects an array of regular expressions. The expressions are used to filter out matching sequences from the categorization field values. You can use this functionality to fine tune the categorization by excluding sequences from consideration when categories are defined. For example, you can exclude SQL statements that appear in your log files. This property cannot be used at the same time as categorization_analyzer. If you only want to define simple regular expression filters that are applied prior to tokenization, setting this property is the easiest method. If you also want to customize the tokenizer or post-tokenization filtering, use the categorization_analyzer property instead and include the filters as pattern_replace character filters. | +| `field` | [Field](./Field.md) | The semi-structured text field to categorize. | +| `max_matched_tokens` | [integer](./integer.md) | The maximum number of token positions to match on before attempting to merge categories. Larger values will use more memory and create narrower categories. Max allowed value is 100. | +| `max_unique_tokens` | [integer](./integer.md) | The maximum number of unique tokens at any position up to max_matched_tokens. Must be larger than 1. Smaller values use less memory and create fewer categories. Larger values will use more memory and create narrower categories. Max allowed value is 100. | +| `min_doc_count` | [integer](./integer.md) | The minimum number of documents in a bucket to be returned to the results. | +| `shard_min_doc_count` | [integer](./integer.md) | The minimum number of documents in a bucket to be returned from the shard before merging. | +| `shard_size` | [integer](./integer.md) | The number of categorization buckets to return from each shard before merging all the results. | +| `similarity_threshold` | [integer](./integer.md) | The minimum percentage of tokens that must match for text to be added to the category bucket. Must be between 1 and 100. The larger the value the narrower the categories. Larger values will increase memory usage and create narrower categories. | +| `size` | [integer](./integer.md) | The number of buckets to return. | diff --git a/docs/reference/api/AggregationsCategorizeTextAnalyzer.md b/docs/reference/api/AggregationsCategorizeTextAnalyzer.md new file mode 100644 index 000000000..4ef93a62b --- /dev/null +++ b/docs/reference/api/AggregationsCategorizeTextAnalyzer.md @@ -0,0 +1,4 @@ +## `AggregationsCategorizeTextAnalyzer` +::: +type AggregationsCategorizeTextAnalyzer = string | [AggregationsCustomCategorizeTextAnalyzer](./AggregationsCustomCategorizeTextAnalyzer.md); +::: diff --git a/docs/reference/api/AggregationsChiSquareHeuristic.md b/docs/reference/api/AggregationsChiSquareHeuristic.md new file mode 100644 index 000000000..f56f13ffa --- /dev/null +++ b/docs/reference/api/AggregationsChiSquareHeuristic.md @@ -0,0 +1,6 @@ +## Interface `AggregationsChiSquareHeuristic` + +| Name | Type | Description | +| - | - | - | +| `background_is_superset` | boolean | Set to `false` if you defined a custom background filter that represents a different set of documents that you want to compare to. | +| `include_negatives` | boolean | Set to `false` to filter out the terms that appear less often in the subset than in documents outside the subset. | diff --git a/docs/reference/api/AggregationsChildrenAggregate.md b/docs/reference/api/AggregationsChildrenAggregate.md new file mode 100644 index 000000000..54e902007 --- /dev/null +++ b/docs/reference/api/AggregationsChildrenAggregate.md @@ -0,0 +1,4 @@ +## `AggregationsChildrenAggregate` +::: +type AggregationsChildrenAggregate = [AggregationsChildrenAggregateKeys](./AggregationsChildrenAggregateKeys.md) & { [property: string]: [AggregationsAggregate](./AggregationsAggregate.md) | [long](./long.md) | [Metadata](./Metadata.md);}; +::: diff --git a/docs/reference/api/AggregationsChildrenAggregateKeys.md b/docs/reference/api/AggregationsChildrenAggregateKeys.md new file mode 100644 index 000000000..fa5e026f3 --- /dev/null +++ b/docs/reference/api/AggregationsChildrenAggregateKeys.md @@ -0,0 +1,4 @@ +## Interface `AggregationsChildrenAggregateKeys` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/AggregationsChildrenAggregation.md b/docs/reference/api/AggregationsChildrenAggregation.md new file mode 100644 index 000000000..cf359ff10 --- /dev/null +++ b/docs/reference/api/AggregationsChildrenAggregation.md @@ -0,0 +1,5 @@ +## Interface `AggregationsChildrenAggregation` + +| Name | Type | Description | +| - | - | - | +| `type` | [RelationName](./RelationName.md) | The child type that should be selected. | diff --git a/docs/reference/api/AggregationsCompositeAggregate.md b/docs/reference/api/AggregationsCompositeAggregate.md new file mode 100644 index 000000000..a811a9859 --- /dev/null +++ b/docs/reference/api/AggregationsCompositeAggregate.md @@ -0,0 +1,5 @@ +## Interface `AggregationsCompositeAggregate` + +| Name | Type | Description | +| - | - | - | +| `after_key` | [AggregationsCompositeAggregateKey](./AggregationsCompositeAggregateKey.md) |   | diff --git a/docs/reference/api/AggregationsCompositeAggregateKey.md b/docs/reference/api/AggregationsCompositeAggregateKey.md new file mode 100644 index 000000000..fbc739ec6 --- /dev/null +++ b/docs/reference/api/AggregationsCompositeAggregateKey.md @@ -0,0 +1,4 @@ +## `AggregationsCompositeAggregateKey` +::: +type AggregationsCompositeAggregateKey = Record<[Field](./Field.md), [FieldValue](./FieldValue.md)>; +::: diff --git a/docs/reference/api/AggregationsCompositeAggregation.md b/docs/reference/api/AggregationsCompositeAggregation.md new file mode 100644 index 000000000..74a70f6c0 --- /dev/null +++ b/docs/reference/api/AggregationsCompositeAggregation.md @@ -0,0 +1,7 @@ +## Interface `AggregationsCompositeAggregation` + +| Name | Type | Description | +| - | - | - | +| `after` | [AggregationsCompositeAggregateKey](./AggregationsCompositeAggregateKey.md) | When paginating, use the `after_key` value returned in the previous response to retrieve the next page. | +| `size` | [integer](./integer.md) | The number of composite buckets that should be returned. | +| `sources` | Record[] | The value sources used to build composite buckets. Keys are returned in the order of the `sources` definition. | diff --git a/docs/reference/api/AggregationsCompositeAggregationBase.md b/docs/reference/api/AggregationsCompositeAggregationBase.md new file mode 100644 index 000000000..0335cf445 --- /dev/null +++ b/docs/reference/api/AggregationsCompositeAggregationBase.md @@ -0,0 +1,10 @@ +## Interface `AggregationsCompositeAggregationBase` + +| Name | Type | Description | +| - | - | - | +| `field` | [Field](./Field.md) | Either `field` or `script` must be present | +| `missing_bucket` | boolean |   | +| `missing_order` | [AggregationsMissingOrder](./AggregationsMissingOrder.md) |   | +| `order` | [SortOrder](./SortOrder.md) |   | +| `script` | [Script](./Script.md) | [ScriptSource](./ScriptSource.md) | Either `field` or `script` must be present | +| `value_type` | [AggregationsValueType](./AggregationsValueType.md) |   | diff --git a/docs/reference/api/AggregationsCompositeAggregationSource.md b/docs/reference/api/AggregationsCompositeAggregationSource.md new file mode 100644 index 000000000..f40ca1e19 --- /dev/null +++ b/docs/reference/api/AggregationsCompositeAggregationSource.md @@ -0,0 +1,8 @@ +## Interface `AggregationsCompositeAggregationSource` + +| Name | Type | Description | +| - | - | - | +| `date_histogram` | [AggregationsCompositeDateHistogramAggregation](./AggregationsCompositeDateHistogramAggregation.md) | A date histogram aggregation. | +| `geotile_grid` | [AggregationsCompositeGeoTileGridAggregation](./AggregationsCompositeGeoTileGridAggregation.md) | A geotile grid aggregation. | +| `histogram` | [AggregationsCompositeHistogramAggregation](./AggregationsCompositeHistogramAggregation.md) | A histogram aggregation. | +| `terms` | [AggregationsCompositeTermsAggregation](./AggregationsCompositeTermsAggregation.md) | A terms aggregation. | diff --git a/docs/reference/api/AggregationsCompositeBucket.md b/docs/reference/api/AggregationsCompositeBucket.md new file mode 100644 index 000000000..1f87da5dc --- /dev/null +++ b/docs/reference/api/AggregationsCompositeBucket.md @@ -0,0 +1,4 @@ +## `AggregationsCompositeBucket` +::: +type AggregationsCompositeBucket = [AggregationsCompositeBucketKeys](./AggregationsCompositeBucketKeys.md) & { [property: string]: [AggregationsAggregate](./AggregationsAggregate.md) | [AggregationsCompositeAggregateKey](./AggregationsCompositeAggregateKey.md) | [long](./long.md);}; +::: diff --git a/docs/reference/api/AggregationsCompositeBucketKeys.md b/docs/reference/api/AggregationsCompositeBucketKeys.md new file mode 100644 index 000000000..1a537cc5f --- /dev/null +++ b/docs/reference/api/AggregationsCompositeBucketKeys.md @@ -0,0 +1,5 @@ +## Interface `AggregationsCompositeBucketKeys` + +| Name | Type | Description | +| - | - | - | +| `key` | [AggregationsCompositeAggregateKey](./AggregationsCompositeAggregateKey.md) |   | diff --git a/docs/reference/api/AggregationsCompositeDateHistogramAggregation.md b/docs/reference/api/AggregationsCompositeDateHistogramAggregation.md new file mode 100644 index 000000000..2e987455c --- /dev/null +++ b/docs/reference/api/AggregationsCompositeDateHistogramAggregation.md @@ -0,0 +1,9 @@ +## Interface `AggregationsCompositeDateHistogramAggregation` + +| Name | Type | Description | +| - | - | - | +| `calendar_interval` | [DurationLarge](./DurationLarge.md) | Either `calendar_interval` or `fixed_interval` must be present | +| `fixed_interval` | [DurationLarge](./DurationLarge.md) | Either `calendar_interval` or `fixed_interval` must be present | +| `format` | string |   | +| `offset` | [Duration](./Duration.md) |   | +| `time_zone` | [TimeZone](./TimeZone.md) |   | diff --git a/docs/reference/api/AggregationsCompositeGeoTileGridAggregation.md b/docs/reference/api/AggregationsCompositeGeoTileGridAggregation.md new file mode 100644 index 000000000..db08c3a15 --- /dev/null +++ b/docs/reference/api/AggregationsCompositeGeoTileGridAggregation.md @@ -0,0 +1,6 @@ +## Interface `AggregationsCompositeGeoTileGridAggregation` + +| Name | Type | Description | +| - | - | - | +| `bounds` | [GeoBounds](./GeoBounds.md) |   | +| `precision` | [integer](./integer.md) |   | diff --git a/docs/reference/api/AggregationsCompositeHistogramAggregation.md b/docs/reference/api/AggregationsCompositeHistogramAggregation.md new file mode 100644 index 000000000..1633d1cf2 --- /dev/null +++ b/docs/reference/api/AggregationsCompositeHistogramAggregation.md @@ -0,0 +1,5 @@ +## Interface `AggregationsCompositeHistogramAggregation` + +| Name | Type | Description | +| - | - | - | +| `interval` | [double](./double.md) |   | diff --git a/docs/reference/api/AggregationsCompositeTermsAggregation.md b/docs/reference/api/AggregationsCompositeTermsAggregation.md new file mode 100644 index 000000000..55312c28f --- /dev/null +++ b/docs/reference/api/AggregationsCompositeTermsAggregation.md @@ -0,0 +1,4 @@ +## Interface `AggregationsCompositeTermsAggregation` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/AggregationsCumulativeCardinalityAggregate.md b/docs/reference/api/AggregationsCumulativeCardinalityAggregate.md new file mode 100644 index 000000000..3f9a86a48 --- /dev/null +++ b/docs/reference/api/AggregationsCumulativeCardinalityAggregate.md @@ -0,0 +1,6 @@ +## Interface `AggregationsCumulativeCardinalityAggregate` + +| Name | Type | Description | +| - | - | - | +| `value_as_string` | string |   | +| `value` | [long](./long.md) |   | diff --git a/docs/reference/api/AggregationsCumulativeCardinalityAggregation.md b/docs/reference/api/AggregationsCumulativeCardinalityAggregation.md new file mode 100644 index 000000000..2aa8c29ff --- /dev/null +++ b/docs/reference/api/AggregationsCumulativeCardinalityAggregation.md @@ -0,0 +1,4 @@ +## Interface `AggregationsCumulativeCardinalityAggregation` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/AggregationsCumulativeSumAggregation.md b/docs/reference/api/AggregationsCumulativeSumAggregation.md new file mode 100644 index 000000000..c70d6e6c7 --- /dev/null +++ b/docs/reference/api/AggregationsCumulativeSumAggregation.md @@ -0,0 +1,4 @@ +## Interface `AggregationsCumulativeSumAggregation` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/AggregationsCustomCategorizeTextAnalyzer.md b/docs/reference/api/AggregationsCustomCategorizeTextAnalyzer.md new file mode 100644 index 000000000..f47ba05af --- /dev/null +++ b/docs/reference/api/AggregationsCustomCategorizeTextAnalyzer.md @@ -0,0 +1,7 @@ +## Interface `AggregationsCustomCategorizeTextAnalyzer` + +| Name | Type | Description | +| - | - | - | +| `char_filter` | string[] |   | +| `filter` | string[] |   | +| `tokenizer` | string |   | diff --git a/docs/reference/api/AggregationsDateHistogramAggregate.md b/docs/reference/api/AggregationsDateHistogramAggregate.md new file mode 100644 index 000000000..b0e4d6cf7 --- /dev/null +++ b/docs/reference/api/AggregationsDateHistogramAggregate.md @@ -0,0 +1,4 @@ +## Interface `AggregationsDateHistogramAggregate` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/AggregationsDateHistogramAggregation.md b/docs/reference/api/AggregationsDateHistogramAggregation.md new file mode 100644 index 000000000..f93942b43 --- /dev/null +++ b/docs/reference/api/AggregationsDateHistogramAggregation.md @@ -0,0 +1,19 @@ +## Interface `AggregationsDateHistogramAggregation` + +| Name | Type | Description | +| - | - | - | +| `calendar_interval` | [AggregationsCalendarInterval](./AggregationsCalendarInterval.md) | Calendar-aware interval. Can be specified using the unit name, such as `month`, or as a single unit quantity, such as `1M`. | +| `extended_bounds` | [AggregationsExtendedBounds](./AggregationsExtendedBounds.md)<[AggregationsFieldDateMath](./AggregationsFieldDateMath.md)> | Enables extending the bounds of the histogram beyond the data itself. | +| `field` | [Field](./Field.md) | The date field whose values are use to build a histogram. | +| `fixed_interval` | [Duration](./Duration.md) | Fixed intervals: a fixed number of SI units and never deviate, regardless of where they fall on the calendar. | +| `format` | string | The date format used to format `key_as_string` in the response. If no `format` is specified, the first date format specified in the field mapping is used. | +| `hard_bounds` | [AggregationsExtendedBounds](./AggregationsExtendedBounds.md)<[AggregationsFieldDateMath](./AggregationsFieldDateMath.md)> | Limits the histogram to specified bounds. | +| `interval` | [Duration](./Duration.md) |   | +| `keyed` | boolean | Set to `true` to associate a unique string key with each bucket and return the ranges as a hash rather than an array. | +| `min_doc_count` | [integer](./integer.md) | Only returns buckets that have `min_doc_count` number of documents. By default, all buckets between the first bucket that matches documents and the last one are returned. | +| `missing` | [DateTime](./DateTime.md) | The value to apply to documents that do not have a value. By default, documents without a value are ignored. | +| `offset` | [Duration](./Duration.md) | Changes the start value of each bucket by the specified positive ( `+`) or negative offset ( `-`) duration. | +| `order` | [AggregationsAggregateOrder](./AggregationsAggregateOrder.md) | The sort order of the returned buckets. | +| `params` | Record |   | +| `script` | [Script](./Script.md) | [ScriptSource](./ScriptSource.md) |   | +| `time_zone` | [TimeZone](./TimeZone.md) | Time zone used for bucketing and rounding. Defaults to Coordinated Universal Time (UTC). | diff --git a/docs/reference/api/AggregationsDateHistogramBucket.md b/docs/reference/api/AggregationsDateHistogramBucket.md new file mode 100644 index 000000000..ed01d82a2 --- /dev/null +++ b/docs/reference/api/AggregationsDateHistogramBucket.md @@ -0,0 +1,4 @@ +## `AggregationsDateHistogramBucket` +::: +type AggregationsDateHistogramBucket = [AggregationsDateHistogramBucketKeys](./AggregationsDateHistogramBucketKeys.md) & { [property: string]: [AggregationsAggregate](./AggregationsAggregate.md) | string | [EpochTime](./EpochTime.md)<[UnitMillis](./UnitMillis.md)> | [long](./long.md);}; +::: diff --git a/docs/reference/api/AggregationsDateHistogramBucketKeys.md b/docs/reference/api/AggregationsDateHistogramBucketKeys.md new file mode 100644 index 000000000..039fe506f --- /dev/null +++ b/docs/reference/api/AggregationsDateHistogramBucketKeys.md @@ -0,0 +1,6 @@ +## Interface `AggregationsDateHistogramBucketKeys` + +| Name | Type | Description | +| - | - | - | +| `key_as_string` | string |   | +| `key` | [EpochTime](./EpochTime.md)<[UnitMillis](./UnitMillis.md)> |   | diff --git a/docs/reference/api/AggregationsDateRangeAggregate.md b/docs/reference/api/AggregationsDateRangeAggregate.md new file mode 100644 index 000000000..b35f7041a --- /dev/null +++ b/docs/reference/api/AggregationsDateRangeAggregate.md @@ -0,0 +1,4 @@ +## Interface `AggregationsDateRangeAggregate` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/AggregationsDateRangeAggregation.md b/docs/reference/api/AggregationsDateRangeAggregation.md new file mode 100644 index 000000000..fde258317 --- /dev/null +++ b/docs/reference/api/AggregationsDateRangeAggregation.md @@ -0,0 +1,10 @@ +## Interface `AggregationsDateRangeAggregation` + +| Name | Type | Description | +| - | - | - | +| `field` | [Field](./Field.md) | The date field whose values are use to build ranges. | +| `format` | string | The date format used to format `from` and `to` in the response. | +| `keyed` | boolean | Set to `true` to associate a unique string key with each bucket and returns the ranges as a hash rather than an array. | +| `missing` | [AggregationsMissing](./AggregationsMissing.md) | The value to apply to documents that do not have a value. By default, documents without a value are ignored. | +| `ranges` | [AggregationsDateRangeExpression](./AggregationsDateRangeExpression.md)[] | Array of date ranges. | +| `time_zone` | [TimeZone](./TimeZone.md) | Time zone used to convert dates from another time zone to UTC. | diff --git a/docs/reference/api/AggregationsDateRangeExpression.md b/docs/reference/api/AggregationsDateRangeExpression.md new file mode 100644 index 000000000..2027da1bc --- /dev/null +++ b/docs/reference/api/AggregationsDateRangeExpression.md @@ -0,0 +1,7 @@ +## Interface `AggregationsDateRangeExpression` + +| Name | Type | Description | +| - | - | - | +| `from` | [AggregationsFieldDateMath](./AggregationsFieldDateMath.md) | Start of the range (inclusive). | +| `key` | string | Custom key to return the range with. | +| `to` | [AggregationsFieldDateMath](./AggregationsFieldDateMath.md) | End of the range (exclusive). | diff --git a/docs/reference/api/AggregationsDerivativeAggregate.md b/docs/reference/api/AggregationsDerivativeAggregate.md new file mode 100644 index 000000000..d936c7c48 --- /dev/null +++ b/docs/reference/api/AggregationsDerivativeAggregate.md @@ -0,0 +1,6 @@ +## Interface `AggregationsDerivativeAggregate` + +| Name | Type | Description | +| - | - | - | +| `normalized_value_as_string` | string |   | +| `normalized_value` | [double](./double.md) |   | diff --git a/docs/reference/api/AggregationsDerivativeAggregation.md b/docs/reference/api/AggregationsDerivativeAggregation.md new file mode 100644 index 000000000..2a3c476cf --- /dev/null +++ b/docs/reference/api/AggregationsDerivativeAggregation.md @@ -0,0 +1,4 @@ +## Interface `AggregationsDerivativeAggregation` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/AggregationsDiversifiedSamplerAggregation.md b/docs/reference/api/AggregationsDiversifiedSamplerAggregation.md new file mode 100644 index 000000000..f8f53d58a --- /dev/null +++ b/docs/reference/api/AggregationsDiversifiedSamplerAggregation.md @@ -0,0 +1,9 @@ +## Interface `AggregationsDiversifiedSamplerAggregation` + +| Name | Type | Description | +| - | - | - | +| `execution_hint` | [AggregationsSamplerAggregationExecutionHint](./AggregationsSamplerAggregationExecutionHint.md) | The type of value used for de-duplication. | +| `field` | [Field](./Field.md) | The field used to provide values used for de-duplication. | +| `max_docs_per_value` | [integer](./integer.md) | Limits how many documents are permitted per choice of de-duplicating value. | +| `script` | [Script](./Script.md) | [ScriptSource](./ScriptSource.md) |   | +| `shard_size` | [integer](./integer.md) | Limits how many top-scoring documents are collected in the sample processed on each shard. | diff --git a/docs/reference/api/AggregationsDoubleTermsAggregate.md b/docs/reference/api/AggregationsDoubleTermsAggregate.md new file mode 100644 index 000000000..fc60b0297 --- /dev/null +++ b/docs/reference/api/AggregationsDoubleTermsAggregate.md @@ -0,0 +1,4 @@ +## Interface `AggregationsDoubleTermsAggregate` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/AggregationsDoubleTermsBucket.md b/docs/reference/api/AggregationsDoubleTermsBucket.md new file mode 100644 index 000000000..397dc3e04 --- /dev/null +++ b/docs/reference/api/AggregationsDoubleTermsBucket.md @@ -0,0 +1,4 @@ +## `AggregationsDoubleTermsBucket` +::: +type AggregationsDoubleTermsBucket = [AggregationsDoubleTermsBucketKeys](./AggregationsDoubleTermsBucketKeys.md) & { [property: string]: [AggregationsAggregate](./AggregationsAggregate.md) | [double](./double.md) | string | [long](./long.md);}; +::: diff --git a/docs/reference/api/AggregationsDoubleTermsBucketKeys.md b/docs/reference/api/AggregationsDoubleTermsBucketKeys.md new file mode 100644 index 000000000..e3b3a25b1 --- /dev/null +++ b/docs/reference/api/AggregationsDoubleTermsBucketKeys.md @@ -0,0 +1,6 @@ +## Interface `AggregationsDoubleTermsBucketKeys` + +| Name | Type | Description | +| - | - | - | +| `key_as_string` | string |   | +| `key` | [double](./double.md) |   | diff --git a/docs/reference/api/AggregationsEwmaModelSettings.md b/docs/reference/api/AggregationsEwmaModelSettings.md new file mode 100644 index 000000000..ead3e5d1f --- /dev/null +++ b/docs/reference/api/AggregationsEwmaModelSettings.md @@ -0,0 +1,5 @@ +## Interface `AggregationsEwmaModelSettings` + +| Name | Type | Description | +| - | - | - | +| `alpha` | [float](./float.md) |   | diff --git a/docs/reference/api/AggregationsEwmaMovingAverageAggregation.md b/docs/reference/api/AggregationsEwmaMovingAverageAggregation.md new file mode 100644 index 000000000..0a09d0259 --- /dev/null +++ b/docs/reference/api/AggregationsEwmaMovingAverageAggregation.md @@ -0,0 +1,6 @@ +## Interface `AggregationsEwmaMovingAverageAggregation` + +| Name | Type | Description | +| - | - | - | +| `model` | 'ewma' |   | +| `settings` | [AggregationsEwmaModelSettings](./AggregationsEwmaModelSettings.md) |   | diff --git a/docs/reference/api/AggregationsExtendedBounds.md b/docs/reference/api/AggregationsExtendedBounds.md new file mode 100644 index 000000000..821e1971b --- /dev/null +++ b/docs/reference/api/AggregationsExtendedBounds.md @@ -0,0 +1,6 @@ +## Interface `AggregationsExtendedBounds` + +| Name | Type | Description | +| - | - | - | +| `max` | T | Maximum value for the bound. | +| `min` | T | Minimum value for the bound. | diff --git a/docs/reference/api/AggregationsExtendedStatsAggregate.md b/docs/reference/api/AggregationsExtendedStatsAggregate.md new file mode 100644 index 000000000..306171a21 --- /dev/null +++ b/docs/reference/api/AggregationsExtendedStatsAggregate.md @@ -0,0 +1,18 @@ +## Interface `AggregationsExtendedStatsAggregate` + +| Name | Type | Description | +| - | - | - | +| `std_deviation_as_string` | string |   | +| `std_deviation_bounds_as_string` | [AggregationsStandardDeviationBoundsAsString](./AggregationsStandardDeviationBoundsAsString.md) |   | +| `std_deviation_bounds` | [AggregationsStandardDeviationBounds](./AggregationsStandardDeviationBounds.md) |   | +| `std_deviation_population` | [double](./double.md) | null |   | +| `std_deviation_sampling` | [double](./double.md) | null |   | +| `std_deviation` | [double](./double.md) | null |   | +| `sum_of_squares_as_string` | string |   | +| `sum_of_squares` | [double](./double.md) | null |   | +| `variance_as_string` | string |   | +| `variance_population_as_string` | string |   | +| `variance_population` | [double](./double.md) | null |   | +| `variance_sampling_as_string` | string |   | +| `variance_sampling` | [double](./double.md) | null |   | +| `variance` | [double](./double.md) | null |   | diff --git a/docs/reference/api/AggregationsExtendedStatsAggregation.md b/docs/reference/api/AggregationsExtendedStatsAggregation.md new file mode 100644 index 000000000..adac76dd8 --- /dev/null +++ b/docs/reference/api/AggregationsExtendedStatsAggregation.md @@ -0,0 +1,5 @@ +## Interface `AggregationsExtendedStatsAggregation` + +| Name | Type | Description | +| - | - | - | +| `sigma` | [double](./double.md) | The number of standard deviations above/below the mean to display. | diff --git a/docs/reference/api/AggregationsExtendedStatsBucketAggregate.md b/docs/reference/api/AggregationsExtendedStatsBucketAggregate.md new file mode 100644 index 000000000..2f843054c --- /dev/null +++ b/docs/reference/api/AggregationsExtendedStatsBucketAggregate.md @@ -0,0 +1,4 @@ +## Interface `AggregationsExtendedStatsBucketAggregate` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/AggregationsExtendedStatsBucketAggregation.md b/docs/reference/api/AggregationsExtendedStatsBucketAggregation.md new file mode 100644 index 000000000..5aa6433f7 --- /dev/null +++ b/docs/reference/api/AggregationsExtendedStatsBucketAggregation.md @@ -0,0 +1,5 @@ +## Interface `AggregationsExtendedStatsBucketAggregation` + +| Name | Type | Description | +| - | - | - | +| `sigma` | [double](./double.md) | The number of standard deviations above/below the mean to display. | diff --git a/docs/reference/api/AggregationsFieldDateMath.md b/docs/reference/api/AggregationsFieldDateMath.md new file mode 100644 index 000000000..75f846145 --- /dev/null +++ b/docs/reference/api/AggregationsFieldDateMath.md @@ -0,0 +1,4 @@ +## `AggregationsFieldDateMath` +::: +type AggregationsFieldDateMath = [DateMath](./DateMath.md) | [double](./double.md); +::: diff --git a/docs/reference/api/AggregationsFilterAggregate.md b/docs/reference/api/AggregationsFilterAggregate.md new file mode 100644 index 000000000..ba02beab1 --- /dev/null +++ b/docs/reference/api/AggregationsFilterAggregate.md @@ -0,0 +1,4 @@ +## `AggregationsFilterAggregate` +::: +type AggregationsFilterAggregate = [AggregationsFilterAggregateKeys](./AggregationsFilterAggregateKeys.md) & { [property: string]: [AggregationsAggregate](./AggregationsAggregate.md) | [long](./long.md) | [Metadata](./Metadata.md);}; +::: diff --git a/docs/reference/api/AggregationsFilterAggregateKeys.md b/docs/reference/api/AggregationsFilterAggregateKeys.md new file mode 100644 index 000000000..0e8d70458 --- /dev/null +++ b/docs/reference/api/AggregationsFilterAggregateKeys.md @@ -0,0 +1,4 @@ +## Interface `AggregationsFilterAggregateKeys` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/AggregationsFiltersAggregate.md b/docs/reference/api/AggregationsFiltersAggregate.md new file mode 100644 index 000000000..e7865967b --- /dev/null +++ b/docs/reference/api/AggregationsFiltersAggregate.md @@ -0,0 +1,4 @@ +## Interface `AggregationsFiltersAggregate` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/AggregationsFiltersAggregation.md b/docs/reference/api/AggregationsFiltersAggregation.md new file mode 100644 index 000000000..bc9d33db5 --- /dev/null +++ b/docs/reference/api/AggregationsFiltersAggregation.md @@ -0,0 +1,8 @@ +## Interface `AggregationsFiltersAggregation` + +| Name | Type | Description | +| - | - | - | +| `filters` | [AggregationsBuckets](./AggregationsBuckets.md)<[QueryDslQueryContainer](./QueryDslQueryContainer.md)> | Collection of queries from which to build buckets. | +| `keyed` | boolean | By default, the named filters aggregation returns the buckets as an object. Set to `false` to return the buckets as an array of objects. | +| `other_bucket_key` | string | The key with which the other bucket is returned. | +| `other_bucket` | boolean | Set to `true` to add a bucket to the response which will contain all documents that do not match any of the given filters. | diff --git a/docs/reference/api/AggregationsFiltersBucket.md b/docs/reference/api/AggregationsFiltersBucket.md new file mode 100644 index 000000000..293a28755 --- /dev/null +++ b/docs/reference/api/AggregationsFiltersBucket.md @@ -0,0 +1,4 @@ +## `AggregationsFiltersBucket` +::: +type AggregationsFiltersBucket = [AggregationsFiltersBucketKeys](./AggregationsFiltersBucketKeys.md) & { [property: string]: [AggregationsAggregate](./AggregationsAggregate.md) | [long](./long.md);}; +::: diff --git a/docs/reference/api/AggregationsFiltersBucketKeys.md b/docs/reference/api/AggregationsFiltersBucketKeys.md new file mode 100644 index 000000000..29dcf558a --- /dev/null +++ b/docs/reference/api/AggregationsFiltersBucketKeys.md @@ -0,0 +1,4 @@ +## Interface `AggregationsFiltersBucketKeys` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/AggregationsFormatMetricAggregationBase.md b/docs/reference/api/AggregationsFormatMetricAggregationBase.md new file mode 100644 index 000000000..a8f6ad71b --- /dev/null +++ b/docs/reference/api/AggregationsFormatMetricAggregationBase.md @@ -0,0 +1,5 @@ +## Interface `AggregationsFormatMetricAggregationBase` + +| Name | Type | Description | +| - | - | - | +| `format` | string |   | diff --git a/docs/reference/api/AggregationsFormattableMetricAggregation.md b/docs/reference/api/AggregationsFormattableMetricAggregation.md new file mode 100644 index 000000000..d59f5133f --- /dev/null +++ b/docs/reference/api/AggregationsFormattableMetricAggregation.md @@ -0,0 +1,5 @@ +## Interface `AggregationsFormattableMetricAggregation` + +| Name | Type | Description | +| - | - | - | +| `format` | string |   | diff --git a/docs/reference/api/AggregationsFrequentItemSetsAggregate.md b/docs/reference/api/AggregationsFrequentItemSetsAggregate.md new file mode 100644 index 000000000..a9ba62c0c --- /dev/null +++ b/docs/reference/api/AggregationsFrequentItemSetsAggregate.md @@ -0,0 +1,4 @@ +## Interface `AggregationsFrequentItemSetsAggregate` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/AggregationsFrequentItemSetsAggregation.md b/docs/reference/api/AggregationsFrequentItemSetsAggregation.md new file mode 100644 index 000000000..3d93719ca --- /dev/null +++ b/docs/reference/api/AggregationsFrequentItemSetsAggregation.md @@ -0,0 +1,9 @@ +## Interface `AggregationsFrequentItemSetsAggregation` + +| Name | Type | Description | +| - | - | - | +| `fields` | [AggregationsFrequentItemSetsField](./AggregationsFrequentItemSetsField.md)[] | Fields to analyze. | +| `filter` | [QueryDslQueryContainer](./QueryDslQueryContainer.md) | Query that filters documents from analysis. | +| `minimum_set_size` | [integer](./integer.md) | The minimum size of one item set. | +| `minimum_support` | [double](./double.md) | The minimum support of one item set. | +| `size` | [integer](./integer.md) | The number of top item sets to return. | diff --git a/docs/reference/api/AggregationsFrequentItemSetsBucket.md b/docs/reference/api/AggregationsFrequentItemSetsBucket.md new file mode 100644 index 000000000..479dc1060 --- /dev/null +++ b/docs/reference/api/AggregationsFrequentItemSetsBucket.md @@ -0,0 +1,4 @@ +## `AggregationsFrequentItemSetsBucket` +::: +type AggregationsFrequentItemSetsBucket = [AggregationsFrequentItemSetsBucketKeys](./AggregationsFrequentItemSetsBucketKeys.md) & { [property: string]: [AggregationsAggregate](./AggregationsAggregate.md) | Record<[Field](./Field.md), string[]> | [double](./double.md) | [long](./long.md);}; +::: diff --git a/docs/reference/api/AggregationsFrequentItemSetsBucketKeys.md b/docs/reference/api/AggregationsFrequentItemSetsBucketKeys.md new file mode 100644 index 000000000..5570a746a --- /dev/null +++ b/docs/reference/api/AggregationsFrequentItemSetsBucketKeys.md @@ -0,0 +1,6 @@ +## Interface `AggregationsFrequentItemSetsBucketKeys` + +| Name | Type | Description | +| - | - | - | +| `key` | Record<[Field](./Field.md), string[]> |   | +| `support` | [double](./double.md) |   | diff --git a/docs/reference/api/AggregationsFrequentItemSetsField.md b/docs/reference/api/AggregationsFrequentItemSetsField.md new file mode 100644 index 000000000..552def2c8 --- /dev/null +++ b/docs/reference/api/AggregationsFrequentItemSetsField.md @@ -0,0 +1,7 @@ +## Interface `AggregationsFrequentItemSetsField` + +| Name | Type | Description | +| - | - | - | +| `exclude` | [AggregationsTermsExclude](./AggregationsTermsExclude.md) | Values to exclude. Can be regular expression strings or arrays of strings of exact terms. | +| `field` | [Field](./Field.md) |   | +| `include` | [AggregationsTermsInclude](./AggregationsTermsInclude.md) | Values to include. Can be regular expression strings or arrays of strings of exact terms. | diff --git a/docs/reference/api/AggregationsGapPolicy.md b/docs/reference/api/AggregationsGapPolicy.md new file mode 100644 index 000000000..9ab01d9e5 --- /dev/null +++ b/docs/reference/api/AggregationsGapPolicy.md @@ -0,0 +1,4 @@ +## `AggregationsGapPolicy` +::: +type AggregationsGapPolicy = 'skip' | 'insert_zeros' | 'keep_values'; +::: diff --git a/docs/reference/api/AggregationsGeoBoundsAggregate.md b/docs/reference/api/AggregationsGeoBoundsAggregate.md new file mode 100644 index 000000000..f4df56fd1 --- /dev/null +++ b/docs/reference/api/AggregationsGeoBoundsAggregate.md @@ -0,0 +1,5 @@ +## Interface `AggregationsGeoBoundsAggregate` + +| Name | Type | Description | +| - | - | - | +| `bounds` | [GeoBounds](./GeoBounds.md) |   | diff --git a/docs/reference/api/AggregationsGeoBoundsAggregation.md b/docs/reference/api/AggregationsGeoBoundsAggregation.md new file mode 100644 index 000000000..e94f11697 --- /dev/null +++ b/docs/reference/api/AggregationsGeoBoundsAggregation.md @@ -0,0 +1,5 @@ +## Interface `AggregationsGeoBoundsAggregation` + +| Name | Type | Description | +| - | - | - | +| `wrap_longitude` | boolean | Specifies whether the bounding box should be allowed to overlap the international date line. | diff --git a/docs/reference/api/AggregationsGeoCentroidAggregate.md b/docs/reference/api/AggregationsGeoCentroidAggregate.md new file mode 100644 index 000000000..38f031bd6 --- /dev/null +++ b/docs/reference/api/AggregationsGeoCentroidAggregate.md @@ -0,0 +1,6 @@ +## Interface `AggregationsGeoCentroidAggregate` + +| Name | Type | Description | +| - | - | - | +| `count` | [long](./long.md) |   | +| `location` | [GeoLocation](./GeoLocation.md) |   | diff --git a/docs/reference/api/AggregationsGeoCentroidAggregation.md b/docs/reference/api/AggregationsGeoCentroidAggregation.md new file mode 100644 index 000000000..bfb1069f3 --- /dev/null +++ b/docs/reference/api/AggregationsGeoCentroidAggregation.md @@ -0,0 +1,6 @@ +## Interface `AggregationsGeoCentroidAggregation` + +| Name | Type | Description | +| - | - | - | +| `count` | [long](./long.md) |   | +| `location` | [GeoLocation](./GeoLocation.md) |   | diff --git a/docs/reference/api/AggregationsGeoDistanceAggregate.md b/docs/reference/api/AggregationsGeoDistanceAggregate.md new file mode 100644 index 000000000..e44872c76 --- /dev/null +++ b/docs/reference/api/AggregationsGeoDistanceAggregate.md @@ -0,0 +1,4 @@ +## Interface `AggregationsGeoDistanceAggregate` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/AggregationsGeoDistanceAggregation.md b/docs/reference/api/AggregationsGeoDistanceAggregation.md new file mode 100644 index 000000000..225174fe2 --- /dev/null +++ b/docs/reference/api/AggregationsGeoDistanceAggregation.md @@ -0,0 +1,9 @@ +## Interface `AggregationsGeoDistanceAggregation` + +| Name | Type | Description | +| - | - | - | +| `distance_type` | [GeoDistanceType](./GeoDistanceType.md) | The distance calculation type. | +| `field` | [Field](./Field.md) | A field of type `geo_point` used to evaluate the distance. | +| `origin` | [GeoLocation](./GeoLocation.md) | The origin used to evaluate the distance. | +| `ranges` | [AggregationsAggregationRange](./AggregationsAggregationRange.md)[] | An array of ranges used to bucket documents. | +| `unit` | [DistanceUnit](./DistanceUnit.md) | The distance unit. | diff --git a/docs/reference/api/AggregationsGeoHashGridAggregate.md b/docs/reference/api/AggregationsGeoHashGridAggregate.md new file mode 100644 index 000000000..b88d95f13 --- /dev/null +++ b/docs/reference/api/AggregationsGeoHashGridAggregate.md @@ -0,0 +1,4 @@ +## Interface `AggregationsGeoHashGridAggregate` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/AggregationsGeoHashGridAggregation.md b/docs/reference/api/AggregationsGeoHashGridAggregation.md new file mode 100644 index 000000000..514645594 --- /dev/null +++ b/docs/reference/api/AggregationsGeoHashGridAggregation.md @@ -0,0 +1,9 @@ +## Interface `AggregationsGeoHashGridAggregation` + +| Name | Type | Description | +| - | - | - | +| `bounds` | [GeoBounds](./GeoBounds.md) | The bounding box to filter the points in each bucket. | +| `field` | [Field](./Field.md) | Field containing indexed `geo_point` or `geo_shape` values. If the field contains an array, `geohash_grid` aggregates all array values. | +| `precision` | [GeoHashPrecision](./GeoHashPrecision.md) | The string length of the geohashes used to define cells/buckets in the results. | +| `shard_size` | [integer](./integer.md) | Allows for more accurate counting of the top cells returned in the final result the aggregation. Defaults to returning `max(10,(size x number-of-shards))` buckets from each shard. | +| `size` | [integer](./integer.md) | The maximum number of geohash buckets to return. | diff --git a/docs/reference/api/AggregationsGeoHashGridBucket.md b/docs/reference/api/AggregationsGeoHashGridBucket.md new file mode 100644 index 000000000..ab489c24c --- /dev/null +++ b/docs/reference/api/AggregationsGeoHashGridBucket.md @@ -0,0 +1,4 @@ +## `AggregationsGeoHashGridBucket` +::: +type AggregationsGeoHashGridBucket = [AggregationsGeoHashGridBucketKeys](./AggregationsGeoHashGridBucketKeys.md) & { [property: string]: [AggregationsAggregate](./AggregationsAggregate.md) | [GeoHash](./GeoHash.md) | [long](./long.md);}; +::: diff --git a/docs/reference/api/AggregationsGeoHashGridBucketKeys.md b/docs/reference/api/AggregationsGeoHashGridBucketKeys.md new file mode 100644 index 000000000..86e2b60cb --- /dev/null +++ b/docs/reference/api/AggregationsGeoHashGridBucketKeys.md @@ -0,0 +1,5 @@ +## Interface `AggregationsGeoHashGridBucketKeys` + +| Name | Type | Description | +| - | - | - | +| `key` | [GeoHash](./GeoHash.md) |   | diff --git a/docs/reference/api/AggregationsGeoHexGridAggregate.md b/docs/reference/api/AggregationsGeoHexGridAggregate.md new file mode 100644 index 000000000..29e63e360 --- /dev/null +++ b/docs/reference/api/AggregationsGeoHexGridAggregate.md @@ -0,0 +1,4 @@ +## Interface `AggregationsGeoHexGridAggregate` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/AggregationsGeoHexGridBucket.md b/docs/reference/api/AggregationsGeoHexGridBucket.md new file mode 100644 index 000000000..6b36e88c8 --- /dev/null +++ b/docs/reference/api/AggregationsGeoHexGridBucket.md @@ -0,0 +1,4 @@ +## `AggregationsGeoHexGridBucket` +::: +type AggregationsGeoHexGridBucket = [AggregationsGeoHexGridBucketKeys](./AggregationsGeoHexGridBucketKeys.md) & { [property: string]: [AggregationsAggregate](./AggregationsAggregate.md) | [GeoHexCell](./GeoHexCell.md) | [long](./long.md);}; +::: diff --git a/docs/reference/api/AggregationsGeoHexGridBucketKeys.md b/docs/reference/api/AggregationsGeoHexGridBucketKeys.md new file mode 100644 index 000000000..0ec2bf8f5 --- /dev/null +++ b/docs/reference/api/AggregationsGeoHexGridBucketKeys.md @@ -0,0 +1,5 @@ +## Interface `AggregationsGeoHexGridBucketKeys` + +| Name | Type | Description | +| - | - | - | +| `key` | [GeoHexCell](./GeoHexCell.md) |   | diff --git a/docs/reference/api/AggregationsGeoLineAggregate.md b/docs/reference/api/AggregationsGeoLineAggregate.md new file mode 100644 index 000000000..3c477fdb9 --- /dev/null +++ b/docs/reference/api/AggregationsGeoLineAggregate.md @@ -0,0 +1,7 @@ +## Interface `AggregationsGeoLineAggregate` + +| Name | Type | Description | +| - | - | - | +| `geometry` | [GeoLine](./GeoLine.md) |   | +| `properties` | any |   | +| `type` | string |   | diff --git a/docs/reference/api/AggregationsGeoLineAggregation.md b/docs/reference/api/AggregationsGeoLineAggregation.md new file mode 100644 index 000000000..3f3da7ace --- /dev/null +++ b/docs/reference/api/AggregationsGeoLineAggregation.md @@ -0,0 +1,9 @@ +## Interface `AggregationsGeoLineAggregation` + +| Name | Type | Description | +| - | - | - | +| `include_sort` | boolean | When `true`, returns an additional array of the sort values in the feature properties. | +| `point` | [AggregationsGeoLinePoint](./AggregationsGeoLinePoint.md) | The name of the geo_point field. | +| `size` | [integer](./integer.md) | The maximum length of the line represented in the aggregation. Valid sizes are between 1 and 10000. | +| `sort_order` | [SortOrder](./SortOrder.md) | The order in which the line is sorted (ascending or descending). | +| `sort` | [AggregationsGeoLineSort](./AggregationsGeoLineSort.md) | The name of the numeric field to use as the sort key for ordering the points. When the `geo_line` aggregation is nested inside a `time_series` aggregation, this field defaults to `@timestamp`, and any other value will result in error. | diff --git a/docs/reference/api/AggregationsGeoLinePoint.md b/docs/reference/api/AggregationsGeoLinePoint.md new file mode 100644 index 000000000..d0b2c73c9 --- /dev/null +++ b/docs/reference/api/AggregationsGeoLinePoint.md @@ -0,0 +1,5 @@ +## Interface `AggregationsGeoLinePoint` + +| Name | Type | Description | +| - | - | - | +| `field` | [Field](./Field.md) | The name of the geo_point field. | diff --git a/docs/reference/api/AggregationsGeoLineSort.md b/docs/reference/api/AggregationsGeoLineSort.md new file mode 100644 index 000000000..cf71d8c83 --- /dev/null +++ b/docs/reference/api/AggregationsGeoLineSort.md @@ -0,0 +1,5 @@ +## Interface `AggregationsGeoLineSort` + +| Name | Type | Description | +| - | - | - | +| `field` | [Field](./Field.md) | The name of the numeric field to use as the sort key for ordering the points. | diff --git a/docs/reference/api/AggregationsGeoTileGridAggregate.md b/docs/reference/api/AggregationsGeoTileGridAggregate.md new file mode 100644 index 000000000..c73897e73 --- /dev/null +++ b/docs/reference/api/AggregationsGeoTileGridAggregate.md @@ -0,0 +1,4 @@ +## Interface `AggregationsGeoTileGridAggregate` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/AggregationsGeoTileGridAggregation.md b/docs/reference/api/AggregationsGeoTileGridAggregation.md new file mode 100644 index 000000000..b184e6243 --- /dev/null +++ b/docs/reference/api/AggregationsGeoTileGridAggregation.md @@ -0,0 +1,9 @@ +## Interface `AggregationsGeoTileGridAggregation` + +| Name | Type | Description | +| - | - | - | +| `bounds` | [GeoBounds](./GeoBounds.md) | A bounding box to filter the geo-points or geo-shapes in each bucket. | +| `field` | [Field](./Field.md) | Field containing indexed `geo_point` or `geo_shape` values. If the field contains an array, `geotile_grid` aggregates all array values. | +| `precision` | [GeoTilePrecision](./GeoTilePrecision.md) | Integer zoom of the key used to define cells/buckets in the results. Values outside of the range [0,29] will be rejected. | +| `shard_size` | [integer](./integer.md) | Allows for more accurate counting of the top cells returned in the final result the aggregation. Defaults to returning `max(10,(size x number-of-shards))` buckets from each shard. | +| `size` | [integer](./integer.md) | The maximum number of buckets to return. | diff --git a/docs/reference/api/AggregationsGeoTileGridBucket.md b/docs/reference/api/AggregationsGeoTileGridBucket.md new file mode 100644 index 000000000..5af797251 --- /dev/null +++ b/docs/reference/api/AggregationsGeoTileGridBucket.md @@ -0,0 +1,4 @@ +## `AggregationsGeoTileGridBucket` +::: +type AggregationsGeoTileGridBucket = [AggregationsGeoTileGridBucketKeys](./AggregationsGeoTileGridBucketKeys.md) & { [property: string]: [AggregationsAggregate](./AggregationsAggregate.md) | [GeoTile](./GeoTile.md) | [long](./long.md);}; +::: diff --git a/docs/reference/api/AggregationsGeoTileGridBucketKeys.md b/docs/reference/api/AggregationsGeoTileGridBucketKeys.md new file mode 100644 index 000000000..4fb14c5d6 --- /dev/null +++ b/docs/reference/api/AggregationsGeoTileGridBucketKeys.md @@ -0,0 +1,5 @@ +## Interface `AggregationsGeoTileGridBucketKeys` + +| Name | Type | Description | +| - | - | - | +| `key` | [GeoTile](./GeoTile.md) |   | diff --git a/docs/reference/api/AggregationsGeohexGridAggregation.md b/docs/reference/api/AggregationsGeohexGridAggregation.md new file mode 100644 index 000000000..9ce91a69e --- /dev/null +++ b/docs/reference/api/AggregationsGeohexGridAggregation.md @@ -0,0 +1,9 @@ +## Interface `AggregationsGeohexGridAggregation` + +| Name | Type | Description | +| - | - | - | +| `bounds` | [GeoBounds](./GeoBounds.md) | Bounding box used to filter the geo-points in each bucket. | +| `field` | [Field](./Field.md) | Field containing indexed `geo_point` or `geo_shape` values. If the field contains an array, `geohex_grid` aggregates all array values. | +| `precision` | [integer](./integer.md) | Integer zoom of the key used to defined cells or buckets in the results. Value should be between 0-15. | +| `shard_size` | [integer](./integer.md) | Number of buckets returned from each shard. | +| `size` | [integer](./integer.md) | Maximum number of buckets to return. | diff --git a/docs/reference/api/AggregationsGlobalAggregate.md b/docs/reference/api/AggregationsGlobalAggregate.md new file mode 100644 index 000000000..a54062ca1 --- /dev/null +++ b/docs/reference/api/AggregationsGlobalAggregate.md @@ -0,0 +1,4 @@ +## `AggregationsGlobalAggregate` +::: +type AggregationsGlobalAggregate = [AggregationsGlobalAggregateKeys](./AggregationsGlobalAggregateKeys.md) & { [property: string]: [AggregationsAggregate](./AggregationsAggregate.md) | [long](./long.md) | [Metadata](./Metadata.md);}; +::: diff --git a/docs/reference/api/AggregationsGlobalAggregateKeys.md b/docs/reference/api/AggregationsGlobalAggregateKeys.md new file mode 100644 index 000000000..6cd872f5d --- /dev/null +++ b/docs/reference/api/AggregationsGlobalAggregateKeys.md @@ -0,0 +1,4 @@ +## Interface `AggregationsGlobalAggregateKeys` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/AggregationsGlobalAggregation.md b/docs/reference/api/AggregationsGlobalAggregation.md new file mode 100644 index 000000000..0509574f8 --- /dev/null +++ b/docs/reference/api/AggregationsGlobalAggregation.md @@ -0,0 +1,4 @@ +## Interface `AggregationsGlobalAggregation` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/AggregationsGoogleNormalizedDistanceHeuristic.md b/docs/reference/api/AggregationsGoogleNormalizedDistanceHeuristic.md new file mode 100644 index 000000000..651b54381 --- /dev/null +++ b/docs/reference/api/AggregationsGoogleNormalizedDistanceHeuristic.md @@ -0,0 +1,5 @@ +## Interface `AggregationsGoogleNormalizedDistanceHeuristic` + +| Name | Type | Description | +| - | - | - | +| `background_is_superset` | boolean | Set to `false` if you defined a custom background filter that represents a different set of documents that you want to compare to. | diff --git a/docs/reference/api/AggregationsHdrMethod.md b/docs/reference/api/AggregationsHdrMethod.md new file mode 100644 index 000000000..c13332207 --- /dev/null +++ b/docs/reference/api/AggregationsHdrMethod.md @@ -0,0 +1,5 @@ +## Interface `AggregationsHdrMethod` + +| Name | Type | Description | +| - | - | - | +| `number_of_significant_value_digits` | [integer](./integer.md) | Specifies the resolution of values for the histogram in number of significant digits. | diff --git a/docs/reference/api/AggregationsHdrPercentileRanksAggregate.md b/docs/reference/api/AggregationsHdrPercentileRanksAggregate.md new file mode 100644 index 000000000..98095cbb5 --- /dev/null +++ b/docs/reference/api/AggregationsHdrPercentileRanksAggregate.md @@ -0,0 +1,4 @@ +## Interface `AggregationsHdrPercentileRanksAggregate` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/AggregationsHdrPercentilesAggregate.md b/docs/reference/api/AggregationsHdrPercentilesAggregate.md new file mode 100644 index 000000000..74759823e --- /dev/null +++ b/docs/reference/api/AggregationsHdrPercentilesAggregate.md @@ -0,0 +1,4 @@ +## Interface `AggregationsHdrPercentilesAggregate` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/AggregationsHistogramAggregate.md b/docs/reference/api/AggregationsHistogramAggregate.md new file mode 100644 index 000000000..1d3d6fa97 --- /dev/null +++ b/docs/reference/api/AggregationsHistogramAggregate.md @@ -0,0 +1,4 @@ +## Interface `AggregationsHistogramAggregate` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/AggregationsHistogramAggregation.md b/docs/reference/api/AggregationsHistogramAggregation.md new file mode 100644 index 000000000..af4570bb1 --- /dev/null +++ b/docs/reference/api/AggregationsHistogramAggregation.md @@ -0,0 +1,15 @@ +## Interface `AggregationsHistogramAggregation` + +| Name | Type | Description | +| - | - | - | +| `extended_bounds` | [AggregationsExtendedBounds](./AggregationsExtendedBounds.md)<[double](./double.md)> | Enables extending the bounds of the histogram beyond the data itself. | +| `field` | [Field](./Field.md) | The name of the field to aggregate on. | +| `format` | string |   | +| `hard_bounds` | [AggregationsExtendedBounds](./AggregationsExtendedBounds.md)<[double](./double.md)> | Limits the range of buckets in the histogram. It is particularly useful in the case of open data ranges that can result in a very large number of buckets. | +| `interval` | [double](./double.md) | The interval for the buckets. Must be a positive decimal. | +| `keyed` | boolean | If `true`, returns buckets as a hash instead of an array, keyed by the bucket keys. | +| `min_doc_count` | [integer](./integer.md) | Only returns buckets that have `min_doc_count` number of documents. By default, the response will fill gaps in the histogram with empty buckets. | +| `missing` | [double](./double.md) | The value to apply to documents that do not have a value. By default, documents without a value are ignored. | +| `offset` | [double](./double.md) | By default, the bucket keys start with 0 and then continue in even spaced steps of `interval`. The bucket boundaries can be shifted by using the `offset` option. | +| `order` | [AggregationsAggregateOrder](./AggregationsAggregateOrder.md) | The sort order of the returned buckets. By default, the returned buckets are sorted by their key ascending. | +| `script` | [Script](./Script.md) | [ScriptSource](./ScriptSource.md) |   | diff --git a/docs/reference/api/AggregationsHistogramBucket.md b/docs/reference/api/AggregationsHistogramBucket.md new file mode 100644 index 000000000..b019ff8ae --- /dev/null +++ b/docs/reference/api/AggregationsHistogramBucket.md @@ -0,0 +1,4 @@ +## `AggregationsHistogramBucket` +::: +type AggregationsHistogramBucket = [AggregationsHistogramBucketKeys](./AggregationsHistogramBucketKeys.md) & { [property: string]: [AggregationsAggregate](./AggregationsAggregate.md) | string | [double](./double.md) | [long](./long.md);}; +::: diff --git a/docs/reference/api/AggregationsHistogramBucketKeys.md b/docs/reference/api/AggregationsHistogramBucketKeys.md new file mode 100644 index 000000000..4fecc2e8a --- /dev/null +++ b/docs/reference/api/AggregationsHistogramBucketKeys.md @@ -0,0 +1,6 @@ +## Interface `AggregationsHistogramBucketKeys` + +| Name | Type | Description | +| - | - | - | +| `key_as_string` | string |   | +| `key` | [double](./double.md) |   | diff --git a/docs/reference/api/AggregationsHoltLinearModelSettings.md b/docs/reference/api/AggregationsHoltLinearModelSettings.md new file mode 100644 index 000000000..60926ef4f --- /dev/null +++ b/docs/reference/api/AggregationsHoltLinearModelSettings.md @@ -0,0 +1,6 @@ +## Interface `AggregationsHoltLinearModelSettings` + +| Name | Type | Description | +| - | - | - | +| `alpha` | [float](./float.md) |   | +| `beta` | [float](./float.md) |   | diff --git a/docs/reference/api/AggregationsHoltMovingAverageAggregation.md b/docs/reference/api/AggregationsHoltMovingAverageAggregation.md new file mode 100644 index 000000000..8c56867a7 --- /dev/null +++ b/docs/reference/api/AggregationsHoltMovingAverageAggregation.md @@ -0,0 +1,6 @@ +## Interface `AggregationsHoltMovingAverageAggregation` + +| Name | Type | Description | +| - | - | - | +| `model` | 'holt' |   | +| `settings` | [AggregationsHoltLinearModelSettings](./AggregationsHoltLinearModelSettings.md) |   | diff --git a/docs/reference/api/AggregationsHoltWintersModelSettings.md b/docs/reference/api/AggregationsHoltWintersModelSettings.md new file mode 100644 index 000000000..5a04168e2 --- /dev/null +++ b/docs/reference/api/AggregationsHoltWintersModelSettings.md @@ -0,0 +1,10 @@ +## Interface `AggregationsHoltWintersModelSettings` + +| Name | Type | Description | +| - | - | - | +| `alpha` | [float](./float.md) |   | +| `beta` | [float](./float.md) |   | +| `gamma` | [float](./float.md) |   | +| `pad` | boolean |   | +| `period` | [integer](./integer.md) |   | +| `type` | [AggregationsHoltWintersType](./AggregationsHoltWintersType.md) |   | diff --git a/docs/reference/api/AggregationsHoltWintersMovingAverageAggregation.md b/docs/reference/api/AggregationsHoltWintersMovingAverageAggregation.md new file mode 100644 index 000000000..3b6a1f88a --- /dev/null +++ b/docs/reference/api/AggregationsHoltWintersMovingAverageAggregation.md @@ -0,0 +1,6 @@ +## Interface `AggregationsHoltWintersMovingAverageAggregation` + +| Name | Type | Description | +| - | - | - | +| `model` | 'holt_winters' |   | +| `settings` | [AggregationsHoltWintersModelSettings](./AggregationsHoltWintersModelSettings.md) |   | diff --git a/docs/reference/api/AggregationsHoltWintersType.md b/docs/reference/api/AggregationsHoltWintersType.md new file mode 100644 index 000000000..c207f6e9d --- /dev/null +++ b/docs/reference/api/AggregationsHoltWintersType.md @@ -0,0 +1,4 @@ +## `AggregationsHoltWintersType` +::: +type AggregationsHoltWintersType = 'add' | 'mult'; +::: diff --git a/docs/reference/api/AggregationsInferenceAggregate.md b/docs/reference/api/AggregationsInferenceAggregate.md new file mode 100644 index 000000000..6b202be4f --- /dev/null +++ b/docs/reference/api/AggregationsInferenceAggregate.md @@ -0,0 +1,4 @@ +## `AggregationsInferenceAggregate` +::: +type AggregationsInferenceAggregate = [AggregationsInferenceAggregateKeys](./AggregationsInferenceAggregateKeys.md) & { [property: string]: any;}; +::: diff --git a/docs/reference/api/AggregationsInferenceAggregateKeys.md b/docs/reference/api/AggregationsInferenceAggregateKeys.md new file mode 100644 index 000000000..5d2b6baa2 --- /dev/null +++ b/docs/reference/api/AggregationsInferenceAggregateKeys.md @@ -0,0 +1,8 @@ +## Interface `AggregationsInferenceAggregateKeys` + +| Name | Type | Description | +| - | - | - | +| `feature_importance` | [AggregationsInferenceFeatureImportance](./AggregationsInferenceFeatureImportance.md)[] |   | +| `top_classes` | [AggregationsInferenceTopClassEntry](./AggregationsInferenceTopClassEntry.md)[] |   | +| `value` | [FieldValue](./FieldValue.md) |   | +| `warning` | string |   | diff --git a/docs/reference/api/AggregationsInferenceAggregation.md b/docs/reference/api/AggregationsInferenceAggregation.md new file mode 100644 index 000000000..519e81d1b --- /dev/null +++ b/docs/reference/api/AggregationsInferenceAggregation.md @@ -0,0 +1,6 @@ +## Interface `AggregationsInferenceAggregation` + +| Name | Type | Description | +| - | - | - | +| `inference_config` | [AggregationsInferenceConfigContainer](./AggregationsInferenceConfigContainer.md) | Contains the inference type and its options. | +| `model_id` | [Name](./Name.md) | The ID or alias for the trained model. | diff --git a/docs/reference/api/AggregationsInferenceClassImportance.md b/docs/reference/api/AggregationsInferenceClassImportance.md new file mode 100644 index 000000000..ca258e704 --- /dev/null +++ b/docs/reference/api/AggregationsInferenceClassImportance.md @@ -0,0 +1,6 @@ +## Interface `AggregationsInferenceClassImportance` + +| Name | Type | Description | +| - | - | - | +| `class_name` | string |   | +| `importance` | [double](./double.md) |   | diff --git a/docs/reference/api/AggregationsInferenceConfigContainer.md b/docs/reference/api/AggregationsInferenceConfigContainer.md new file mode 100644 index 000000000..18e750654 --- /dev/null +++ b/docs/reference/api/AggregationsInferenceConfigContainer.md @@ -0,0 +1,6 @@ +## Interface `AggregationsInferenceConfigContainer` + +| Name | Type | Description | +| - | - | - | +| `classification` | [MlClassificationInferenceOptions](./MlClassificationInferenceOptions.md) | Classification configuration for inference. | +| `regression` | [MlRegressionInferenceOptions](./MlRegressionInferenceOptions.md) | Regression configuration for inference. | diff --git a/docs/reference/api/AggregationsInferenceFeatureImportance.md b/docs/reference/api/AggregationsInferenceFeatureImportance.md new file mode 100644 index 000000000..ba2eecc7d --- /dev/null +++ b/docs/reference/api/AggregationsInferenceFeatureImportance.md @@ -0,0 +1,7 @@ +## Interface `AggregationsInferenceFeatureImportance` + +| Name | Type | Description | +| - | - | - | +| `classes` | [AggregationsInferenceClassImportance](./AggregationsInferenceClassImportance.md)[] |   | +| `feature_name` | string |   | +| `importance` | [double](./double.md) |   | diff --git a/docs/reference/api/AggregationsInferenceTopClassEntry.md b/docs/reference/api/AggregationsInferenceTopClassEntry.md new file mode 100644 index 000000000..cd67773cd --- /dev/null +++ b/docs/reference/api/AggregationsInferenceTopClassEntry.md @@ -0,0 +1,7 @@ +## Interface `AggregationsInferenceTopClassEntry` + +| Name | Type | Description | +| - | - | - | +| `class_name` | [FieldValue](./FieldValue.md) |   | +| `class_probability` | [double](./double.md) |   | +| `class_score` | [double](./double.md) |   | diff --git a/docs/reference/api/AggregationsIpPrefixAggregate.md b/docs/reference/api/AggregationsIpPrefixAggregate.md new file mode 100644 index 000000000..5e272baf1 --- /dev/null +++ b/docs/reference/api/AggregationsIpPrefixAggregate.md @@ -0,0 +1,4 @@ +## Interface `AggregationsIpPrefixAggregate` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/AggregationsIpPrefixAggregation.md b/docs/reference/api/AggregationsIpPrefixAggregation.md new file mode 100644 index 000000000..6df56f68b --- /dev/null +++ b/docs/reference/api/AggregationsIpPrefixAggregation.md @@ -0,0 +1,10 @@ +## Interface `AggregationsIpPrefixAggregation` + +| Name | Type | Description | +| - | - | - | +| `append_prefix_length` | boolean | Defines whether the prefix length is appended to IP address keys in the response. | +| `field` | [Field](./Field.md) | The IP address field to aggregation on. The field mapping type must be `ip`. | +| `is_ipv6` | boolean | Defines whether the prefix applies to IPv6 addresses. | +| `keyed` | boolean | Defines whether buckets are returned as a hash rather than an array in the response. | +| `min_doc_count` | [long](./long.md) | Minimum number of documents in a bucket for it to be included in the response. | +| `prefix_length` | [integer](./integer.md) | Length of the network prefix. For IPv4 addresses the accepted range is [0, 32]. For IPv6 addresses the accepted range is [0, 128]. | diff --git a/docs/reference/api/AggregationsIpPrefixBucket.md b/docs/reference/api/AggregationsIpPrefixBucket.md new file mode 100644 index 000000000..392d80f1a --- /dev/null +++ b/docs/reference/api/AggregationsIpPrefixBucket.md @@ -0,0 +1,4 @@ +## `AggregationsIpPrefixBucket` +::: +type AggregationsIpPrefixBucket = [AggregationsIpPrefixBucketKeys](./AggregationsIpPrefixBucketKeys.md) & { [property: string]: [AggregationsAggregate](./AggregationsAggregate.md) | boolean | string | [integer](./integer.md) | [long](./long.md);}; +::: diff --git a/docs/reference/api/AggregationsIpPrefixBucketKeys.md b/docs/reference/api/AggregationsIpPrefixBucketKeys.md new file mode 100644 index 000000000..7dc2811ea --- /dev/null +++ b/docs/reference/api/AggregationsIpPrefixBucketKeys.md @@ -0,0 +1,8 @@ +## Interface `AggregationsIpPrefixBucketKeys` + +| Name | Type | Description | +| - | - | - | +| `is_ipv6` | boolean |   | +| `key` | string |   | +| `netmask` | string |   | +| `prefix_length` | [integer](./integer.md) |   | diff --git a/docs/reference/api/AggregationsIpRangeAggregate.md b/docs/reference/api/AggregationsIpRangeAggregate.md new file mode 100644 index 000000000..f3bd5bd40 --- /dev/null +++ b/docs/reference/api/AggregationsIpRangeAggregate.md @@ -0,0 +1,4 @@ +## Interface `AggregationsIpRangeAggregate` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/AggregationsIpRangeAggregation.md b/docs/reference/api/AggregationsIpRangeAggregation.md new file mode 100644 index 000000000..82f042f91 --- /dev/null +++ b/docs/reference/api/AggregationsIpRangeAggregation.md @@ -0,0 +1,6 @@ +## Interface `AggregationsIpRangeAggregation` + +| Name | Type | Description | +| - | - | - | +| `field` | [Field](./Field.md) | The date field whose values are used to build ranges. | +| `ranges` | [AggregationsIpRangeAggregationRange](./AggregationsIpRangeAggregationRange.md)[] | Array of IP ranges. | diff --git a/docs/reference/api/AggregationsIpRangeAggregationRange.md b/docs/reference/api/AggregationsIpRangeAggregationRange.md new file mode 100644 index 000000000..49755db8d --- /dev/null +++ b/docs/reference/api/AggregationsIpRangeAggregationRange.md @@ -0,0 +1,7 @@ +## Interface `AggregationsIpRangeAggregationRange` + +| Name | Type | Description | +| - | - | - | +| `from` | string | null | Start of the range. | +| `mask` | string | IP range defined as a CIDR mask. | +| `to` | string | null | End of the range. | diff --git a/docs/reference/api/AggregationsIpRangeBucket.md b/docs/reference/api/AggregationsIpRangeBucket.md new file mode 100644 index 000000000..a3ce0bf0a --- /dev/null +++ b/docs/reference/api/AggregationsIpRangeBucket.md @@ -0,0 +1,4 @@ +## `AggregationsIpRangeBucket` +::: +type AggregationsIpRangeBucket = [AggregationsIpRangeBucketKeys](./AggregationsIpRangeBucketKeys.md) & { [property: string]: [AggregationsAggregate](./AggregationsAggregate.md) | string | [long](./long.md);}; +::: diff --git a/docs/reference/api/AggregationsIpRangeBucketKeys.md b/docs/reference/api/AggregationsIpRangeBucketKeys.md new file mode 100644 index 000000000..6b8feb930 --- /dev/null +++ b/docs/reference/api/AggregationsIpRangeBucketKeys.md @@ -0,0 +1,7 @@ +## Interface `AggregationsIpRangeBucketKeys` + +| Name | Type | Description | +| - | - | - | +| `from` | string |   | +| `key` | string |   | +| `to` | string |   | diff --git a/docs/reference/api/AggregationsKeyedPercentiles.md b/docs/reference/api/AggregationsKeyedPercentiles.md new file mode 100644 index 000000000..424189914 --- /dev/null +++ b/docs/reference/api/AggregationsKeyedPercentiles.md @@ -0,0 +1,4 @@ +## `AggregationsKeyedPercentiles` +::: +type AggregationsKeyedPercentiles = Record; +::: diff --git a/docs/reference/api/AggregationsLinearMovingAverageAggregation.md b/docs/reference/api/AggregationsLinearMovingAverageAggregation.md new file mode 100644 index 000000000..f270f1d7f --- /dev/null +++ b/docs/reference/api/AggregationsLinearMovingAverageAggregation.md @@ -0,0 +1,6 @@ +## Interface `AggregationsLinearMovingAverageAggregation` + +| Name | Type | Description | +| - | - | - | +| `model` | 'linear' |   | +| `settings` | [EmptyObject](./EmptyObject.md) |   | diff --git a/docs/reference/api/AggregationsLongRareTermsAggregate.md b/docs/reference/api/AggregationsLongRareTermsAggregate.md new file mode 100644 index 000000000..550562f0f --- /dev/null +++ b/docs/reference/api/AggregationsLongRareTermsAggregate.md @@ -0,0 +1,4 @@ +## Interface `AggregationsLongRareTermsAggregate` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/AggregationsLongRareTermsBucket.md b/docs/reference/api/AggregationsLongRareTermsBucket.md new file mode 100644 index 000000000..dcd329475 --- /dev/null +++ b/docs/reference/api/AggregationsLongRareTermsBucket.md @@ -0,0 +1,4 @@ +## `AggregationsLongRareTermsBucket` +::: +type AggregationsLongRareTermsBucket = [AggregationsLongRareTermsBucketKeys](./AggregationsLongRareTermsBucketKeys.md) & { [property: string]: [AggregationsAggregate](./AggregationsAggregate.md) | [long](./long.md) | string;}; +::: diff --git a/docs/reference/api/AggregationsLongRareTermsBucketKeys.md b/docs/reference/api/AggregationsLongRareTermsBucketKeys.md new file mode 100644 index 000000000..4edd53b9e --- /dev/null +++ b/docs/reference/api/AggregationsLongRareTermsBucketKeys.md @@ -0,0 +1,6 @@ +## Interface `AggregationsLongRareTermsBucketKeys` + +| Name | Type | Description | +| - | - | - | +| `key_as_string` | string |   | +| `key` | [long](./long.md) |   | diff --git a/docs/reference/api/AggregationsLongTermsAggregate.md b/docs/reference/api/AggregationsLongTermsAggregate.md new file mode 100644 index 000000000..b20816b7f --- /dev/null +++ b/docs/reference/api/AggregationsLongTermsAggregate.md @@ -0,0 +1,4 @@ +## Interface `AggregationsLongTermsAggregate` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/AggregationsLongTermsBucket.md b/docs/reference/api/AggregationsLongTermsBucket.md new file mode 100644 index 000000000..026d74788 --- /dev/null +++ b/docs/reference/api/AggregationsLongTermsBucket.md @@ -0,0 +1,4 @@ +## `AggregationsLongTermsBucket` +::: +type AggregationsLongTermsBucket = [AggregationsLongTermsBucketKeys](./AggregationsLongTermsBucketKeys.md) & { [property: string]: [AggregationsAggregate](./AggregationsAggregate.md) | [long](./long.md) | string;}; +::: diff --git a/docs/reference/api/AggregationsLongTermsBucketKeys.md b/docs/reference/api/AggregationsLongTermsBucketKeys.md new file mode 100644 index 000000000..b2eeb5bcd --- /dev/null +++ b/docs/reference/api/AggregationsLongTermsBucketKeys.md @@ -0,0 +1,6 @@ +## Interface `AggregationsLongTermsBucketKeys` + +| Name | Type | Description | +| - | - | - | +| `key_as_string` | string |   | +| `key` | [long](./long.md) |   | diff --git a/docs/reference/api/AggregationsMatrixAggregation.md b/docs/reference/api/AggregationsMatrixAggregation.md new file mode 100644 index 000000000..e7d312720 --- /dev/null +++ b/docs/reference/api/AggregationsMatrixAggregation.md @@ -0,0 +1,6 @@ +## Interface `AggregationsMatrixAggregation` + +| Name | Type | Description | +| - | - | - | +| `fields` | [Fields](./Fields.md) | An array of fields for computing the statistics. | +| `missing` | Record<[Field](./Field.md), [double](./double.md)> | The value to apply to documents that do not have a value. By default, documents without a value are ignored. | diff --git a/docs/reference/api/AggregationsMatrixStatsAggregate.md b/docs/reference/api/AggregationsMatrixStatsAggregate.md new file mode 100644 index 000000000..90a2bf35c --- /dev/null +++ b/docs/reference/api/AggregationsMatrixStatsAggregate.md @@ -0,0 +1,6 @@ +## Interface `AggregationsMatrixStatsAggregate` + +| Name | Type | Description | +| - | - | - | +| `doc_count` | [long](./long.md) |   | +| `fields` | [AggregationsMatrixStatsFields](./AggregationsMatrixStatsFields.md)[] |   | diff --git a/docs/reference/api/AggregationsMatrixStatsAggregation.md b/docs/reference/api/AggregationsMatrixStatsAggregation.md new file mode 100644 index 000000000..5431c28dc --- /dev/null +++ b/docs/reference/api/AggregationsMatrixStatsAggregation.md @@ -0,0 +1,5 @@ +## Interface `AggregationsMatrixStatsAggregation` + +| Name | Type | Description | +| - | - | - | +| `mode` | [SortMode](./SortMode.md) | Array value the aggregation will use for array or multi-valued fields. | diff --git a/docs/reference/api/AggregationsMatrixStatsFields.md b/docs/reference/api/AggregationsMatrixStatsFields.md new file mode 100644 index 000000000..2ea0cda70 --- /dev/null +++ b/docs/reference/api/AggregationsMatrixStatsFields.md @@ -0,0 +1,12 @@ +## Interface `AggregationsMatrixStatsFields` + +| Name | Type | Description | +| - | - | - | +| `correlation` | Record<[Field](./Field.md), [double](./double.md)> |   | +| `count` | [long](./long.md) |   | +| `covariance` | Record<[Field](./Field.md), [double](./double.md)> |   | +| `kurtosis` | [double](./double.md) |   | +| `mean` | [double](./double.md) |   | +| `name` | [Field](./Field.md) |   | +| `skewness` | [double](./double.md) |   | +| `variance` | [double](./double.md) |   | diff --git a/docs/reference/api/AggregationsMaxAggregate.md b/docs/reference/api/AggregationsMaxAggregate.md new file mode 100644 index 000000000..a61aa4a5e --- /dev/null +++ b/docs/reference/api/AggregationsMaxAggregate.md @@ -0,0 +1,4 @@ +## Interface `AggregationsMaxAggregate` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/AggregationsMaxAggregation.md b/docs/reference/api/AggregationsMaxAggregation.md new file mode 100644 index 000000000..fef312852 --- /dev/null +++ b/docs/reference/api/AggregationsMaxAggregation.md @@ -0,0 +1,4 @@ +## Interface `AggregationsMaxAggregation` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/AggregationsMaxBucketAggregation.md b/docs/reference/api/AggregationsMaxBucketAggregation.md new file mode 100644 index 000000000..b4d829e7e --- /dev/null +++ b/docs/reference/api/AggregationsMaxBucketAggregation.md @@ -0,0 +1,4 @@ +## Interface `AggregationsMaxBucketAggregation` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/AggregationsMedianAbsoluteDeviationAggregate.md b/docs/reference/api/AggregationsMedianAbsoluteDeviationAggregate.md new file mode 100644 index 000000000..c45b19ce1 --- /dev/null +++ b/docs/reference/api/AggregationsMedianAbsoluteDeviationAggregate.md @@ -0,0 +1,4 @@ +## Interface `AggregationsMedianAbsoluteDeviationAggregate` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/AggregationsMedianAbsoluteDeviationAggregation.md b/docs/reference/api/AggregationsMedianAbsoluteDeviationAggregation.md new file mode 100644 index 000000000..e97e12d8b --- /dev/null +++ b/docs/reference/api/AggregationsMedianAbsoluteDeviationAggregation.md @@ -0,0 +1,5 @@ +## Interface `AggregationsMedianAbsoluteDeviationAggregation` + +| Name | Type | Description | +| - | - | - | +| `compression` | [double](./double.md) | Limits the maximum number of nodes used by the underlying TDigest algorithm to `20 * compression`, enabling control of memory usage and approximation error. | diff --git a/docs/reference/api/AggregationsMetricAggregationBase.md b/docs/reference/api/AggregationsMetricAggregationBase.md new file mode 100644 index 000000000..240c90b7c --- /dev/null +++ b/docs/reference/api/AggregationsMetricAggregationBase.md @@ -0,0 +1,7 @@ +## Interface `AggregationsMetricAggregationBase` + +| Name | Type | Description | +| - | - | - | +| `field` | [Field](./Field.md) | The field on which to run the aggregation. | +| `missing` | [AggregationsMissing](./AggregationsMissing.md) | The value to apply to documents that do not have a value. By default, documents without a value are ignored. | +| `script` | [Script](./Script.md) | [ScriptSource](./ScriptSource.md) |   | diff --git a/docs/reference/api/AggregationsMinAggregate.md b/docs/reference/api/AggregationsMinAggregate.md new file mode 100644 index 000000000..c4f4ad114 --- /dev/null +++ b/docs/reference/api/AggregationsMinAggregate.md @@ -0,0 +1,4 @@ +## Interface `AggregationsMinAggregate` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/AggregationsMinAggregation.md b/docs/reference/api/AggregationsMinAggregation.md new file mode 100644 index 000000000..d3a062a75 --- /dev/null +++ b/docs/reference/api/AggregationsMinAggregation.md @@ -0,0 +1,4 @@ +## Interface `AggregationsMinAggregation` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/AggregationsMinBucketAggregation.md b/docs/reference/api/AggregationsMinBucketAggregation.md new file mode 100644 index 000000000..9e91f85b7 --- /dev/null +++ b/docs/reference/api/AggregationsMinBucketAggregation.md @@ -0,0 +1,4 @@ +## Interface `AggregationsMinBucketAggregation` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/AggregationsMinimumInterval.md b/docs/reference/api/AggregationsMinimumInterval.md new file mode 100644 index 000000000..3cfc8e128 --- /dev/null +++ b/docs/reference/api/AggregationsMinimumInterval.md @@ -0,0 +1,4 @@ +## `AggregationsMinimumInterval` +::: +type AggregationsMinimumInterval = 'second' | 'minute' | 'hour' | 'day' | 'month' | 'year'; +::: diff --git a/docs/reference/api/AggregationsMissing.md b/docs/reference/api/AggregationsMissing.md new file mode 100644 index 000000000..9c551fc3a --- /dev/null +++ b/docs/reference/api/AggregationsMissing.md @@ -0,0 +1,4 @@ +## `AggregationsMissing` +::: +type AggregationsMissing = string | [integer](./integer.md) | [double](./double.md) | boolean; +::: diff --git a/docs/reference/api/AggregationsMissingAggregate.md b/docs/reference/api/AggregationsMissingAggregate.md new file mode 100644 index 000000000..b549ef379 --- /dev/null +++ b/docs/reference/api/AggregationsMissingAggregate.md @@ -0,0 +1,4 @@ +## `AggregationsMissingAggregate` +::: +type AggregationsMissingAggregate = [AggregationsMissingAggregateKeys](./AggregationsMissingAggregateKeys.md) & { [property: string]: [AggregationsAggregate](./AggregationsAggregate.md) | [long](./long.md) | [Metadata](./Metadata.md);}; +::: diff --git a/docs/reference/api/AggregationsMissingAggregateKeys.md b/docs/reference/api/AggregationsMissingAggregateKeys.md new file mode 100644 index 000000000..60cb74bd8 --- /dev/null +++ b/docs/reference/api/AggregationsMissingAggregateKeys.md @@ -0,0 +1,4 @@ +## Interface `AggregationsMissingAggregateKeys` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/AggregationsMissingAggregation.md b/docs/reference/api/AggregationsMissingAggregation.md new file mode 100644 index 000000000..a11a38f15 --- /dev/null +++ b/docs/reference/api/AggregationsMissingAggregation.md @@ -0,0 +1,6 @@ +## Interface `AggregationsMissingAggregation` + +| Name | Type | Description | +| - | - | - | +| `field` | [Field](./Field.md) | The name of the field. | +| `missing` | [AggregationsMissing](./AggregationsMissing.md) |   | diff --git a/docs/reference/api/AggregationsMissingOrder.md b/docs/reference/api/AggregationsMissingOrder.md new file mode 100644 index 000000000..c0097e8f0 --- /dev/null +++ b/docs/reference/api/AggregationsMissingOrder.md @@ -0,0 +1,4 @@ +## `AggregationsMissingOrder` +::: +type AggregationsMissingOrder = 'first' | 'last' | 'default'; +::: diff --git a/docs/reference/api/AggregationsMovingAverageAggregation.md b/docs/reference/api/AggregationsMovingAverageAggregation.md new file mode 100644 index 000000000..ac7e81363 --- /dev/null +++ b/docs/reference/api/AggregationsMovingAverageAggregation.md @@ -0,0 +1,4 @@ +## `AggregationsMovingAverageAggregation` +::: +type AggregationsMovingAverageAggregation = [AggregationsLinearMovingAverageAggregation](./AggregationsLinearMovingAverageAggregation.md) | [AggregationsSimpleMovingAverageAggregation](./AggregationsSimpleMovingAverageAggregation.md) | [AggregationsEwmaMovingAverageAggregation](./AggregationsEwmaMovingAverageAggregation.md) | [AggregationsHoltMovingAverageAggregation](./AggregationsHoltMovingAverageAggregation.md) | [AggregationsHoltWintersMovingAverageAggregation](./AggregationsHoltWintersMovingAverageAggregation.md); +::: diff --git a/docs/reference/api/AggregationsMovingAverageAggregationBase.md b/docs/reference/api/AggregationsMovingAverageAggregationBase.md new file mode 100644 index 000000000..c28ac02ba --- /dev/null +++ b/docs/reference/api/AggregationsMovingAverageAggregationBase.md @@ -0,0 +1,7 @@ +## Interface `AggregationsMovingAverageAggregationBase` + +| Name | Type | Description | +| - | - | - | +| `minimize` | boolean |   | +| `predict` | [integer](./integer.md) |   | +| `window` | [integer](./integer.md) |   | diff --git a/docs/reference/api/AggregationsMovingFunctionAggregation.md b/docs/reference/api/AggregationsMovingFunctionAggregation.md new file mode 100644 index 000000000..3abb9e7ff --- /dev/null +++ b/docs/reference/api/AggregationsMovingFunctionAggregation.md @@ -0,0 +1,7 @@ +## Interface `AggregationsMovingFunctionAggregation` + +| Name | Type | Description | +| - | - | - | +| `script` | string | The script that should be executed on each window of data. | +| `shift` | [integer](./integer.md) | By default, the window consists of the last n values excluding the current bucket. Increasing `shift` by 1, moves the starting window position by 1 to the right. | +| `window` | [integer](./integer.md) | The size of window to "slide" across the histogram. | diff --git a/docs/reference/api/AggregationsMovingPercentilesAggregation.md b/docs/reference/api/AggregationsMovingPercentilesAggregation.md new file mode 100644 index 000000000..82dd7d5d0 --- /dev/null +++ b/docs/reference/api/AggregationsMovingPercentilesAggregation.md @@ -0,0 +1,7 @@ +## Interface `AggregationsMovingPercentilesAggregation` + +| Name | Type | Description | +| - | - | - | +| `keyed` | boolean |   | +| `shift` | [integer](./integer.md) | By default, the window consists of the last n values excluding the current bucket. Increasing `shift` by 1, moves the starting window position by 1 to the right. | +| `window` | [integer](./integer.md) | The size of window to "slide" across the histogram. | diff --git a/docs/reference/api/AggregationsMultiBucketAggregateBase.md b/docs/reference/api/AggregationsMultiBucketAggregateBase.md new file mode 100644 index 000000000..e2daff018 --- /dev/null +++ b/docs/reference/api/AggregationsMultiBucketAggregateBase.md @@ -0,0 +1,5 @@ +## Interface `AggregationsMultiBucketAggregateBase` + +| Name | Type | Description | +| - | - | - | +| `buckets` | [AggregationsBuckets](./AggregationsBuckets.md) |   | diff --git a/docs/reference/api/AggregationsMultiBucketBase.md b/docs/reference/api/AggregationsMultiBucketBase.md new file mode 100644 index 000000000..af258f11f --- /dev/null +++ b/docs/reference/api/AggregationsMultiBucketBase.md @@ -0,0 +1,5 @@ +## Interface `AggregationsMultiBucketBase` + +| Name | Type | Description | +| - | - | - | +| `doc_count` | [long](./long.md) |   | diff --git a/docs/reference/api/AggregationsMultiTermLookup.md b/docs/reference/api/AggregationsMultiTermLookup.md new file mode 100644 index 000000000..6e76380b9 --- /dev/null +++ b/docs/reference/api/AggregationsMultiTermLookup.md @@ -0,0 +1,6 @@ +## Interface `AggregationsMultiTermLookup` + +| Name | Type | Description | +| - | - | - | +| `field` | [Field](./Field.md) | A fields from which to retrieve terms. | +| `missing` | [AggregationsMissing](./AggregationsMissing.md) | The value to apply to documents that do not have a value. By default, documents without a value are ignored. | diff --git a/docs/reference/api/AggregationsMultiTermsAggregate.md b/docs/reference/api/AggregationsMultiTermsAggregate.md new file mode 100644 index 000000000..3ae7a7ea7 --- /dev/null +++ b/docs/reference/api/AggregationsMultiTermsAggregate.md @@ -0,0 +1,4 @@ +## Interface `AggregationsMultiTermsAggregate` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/AggregationsMultiTermsAggregation.md b/docs/reference/api/AggregationsMultiTermsAggregation.md new file mode 100644 index 000000000..f66eb802d --- /dev/null +++ b/docs/reference/api/AggregationsMultiTermsAggregation.md @@ -0,0 +1,12 @@ +## Interface `AggregationsMultiTermsAggregation` + +| Name | Type | Description | +| - | - | - | +| `collect_mode` | [AggregationsTermsAggregationCollectMode](./AggregationsTermsAggregationCollectMode.md) | Specifies the strategy for data collection. | +| `min_doc_count` | [long](./long.md) | The minimum number of documents in a bucket for it to be returned. | +| `order` | [AggregationsAggregateOrder](./AggregationsAggregateOrder.md) | Specifies the sort order of the buckets. Defaults to sorting by descending document count. | +| `shard_min_doc_count` | [long](./long.md) | The minimum number of documents in a bucket on each shard for it to be returned. | +| `shard_size` | [integer](./integer.md) | The number of candidate terms produced by each shard. By default, `shard_size` will be automatically estimated based on the number of shards and the `size` parameter. | +| `show_term_doc_count_error` | boolean | Calculates the doc count error on per term basis. | +| `size` | [integer](./integer.md) | The number of term buckets should be returned out of the overall terms list. | +| `terms` | [AggregationsMultiTermLookup](./AggregationsMultiTermLookup.md)[] | The field from which to generate sets of terms. | diff --git a/docs/reference/api/AggregationsMultiTermsBucket.md b/docs/reference/api/AggregationsMultiTermsBucket.md new file mode 100644 index 000000000..835711b83 --- /dev/null +++ b/docs/reference/api/AggregationsMultiTermsBucket.md @@ -0,0 +1,4 @@ +## `AggregationsMultiTermsBucket` +::: +type AggregationsMultiTermsBucket = [AggregationsMultiTermsBucketKeys](./AggregationsMultiTermsBucketKeys.md) & { [property: string]: [AggregationsAggregate](./AggregationsAggregate.md) | [FieldValue](./FieldValue.md)[] | string | [long](./long.md);}; +::: diff --git a/docs/reference/api/AggregationsMultiTermsBucketKeys.md b/docs/reference/api/AggregationsMultiTermsBucketKeys.md new file mode 100644 index 000000000..dc743d191 --- /dev/null +++ b/docs/reference/api/AggregationsMultiTermsBucketKeys.md @@ -0,0 +1,7 @@ +## Interface `AggregationsMultiTermsBucketKeys` + +| Name | Type | Description | +| - | - | - | +| `doc_count_error_upper_bound` | [long](./long.md) |   | +| `key_as_string` | string |   | +| `key` | [FieldValue](./FieldValue.md)[] |   | diff --git a/docs/reference/api/AggregationsMutualInformationHeuristic.md b/docs/reference/api/AggregationsMutualInformationHeuristic.md new file mode 100644 index 000000000..a5e4163bf --- /dev/null +++ b/docs/reference/api/AggregationsMutualInformationHeuristic.md @@ -0,0 +1,6 @@ +## Interface `AggregationsMutualInformationHeuristic` + +| Name | Type | Description | +| - | - | - | +| `background_is_superset` | boolean | Set to `false` if you defined a custom background filter that represents a different set of documents that you want to compare to. | +| `include_negatives` | boolean | Set to `false` to filter out the terms that appear less often in the subset than in documents outside the subset. | diff --git a/docs/reference/api/AggregationsNestedAggregate.md b/docs/reference/api/AggregationsNestedAggregate.md new file mode 100644 index 000000000..b7a806f39 --- /dev/null +++ b/docs/reference/api/AggregationsNestedAggregate.md @@ -0,0 +1,4 @@ +## `AggregationsNestedAggregate` +::: +type AggregationsNestedAggregate = [AggregationsNestedAggregateKeys](./AggregationsNestedAggregateKeys.md) & { [property: string]: [AggregationsAggregate](./AggregationsAggregate.md) | [long](./long.md) | [Metadata](./Metadata.md);}; +::: diff --git a/docs/reference/api/AggregationsNestedAggregateKeys.md b/docs/reference/api/AggregationsNestedAggregateKeys.md new file mode 100644 index 000000000..890d82f43 --- /dev/null +++ b/docs/reference/api/AggregationsNestedAggregateKeys.md @@ -0,0 +1,4 @@ +## Interface `AggregationsNestedAggregateKeys` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/AggregationsNestedAggregation.md b/docs/reference/api/AggregationsNestedAggregation.md new file mode 100644 index 000000000..a253bc1bb --- /dev/null +++ b/docs/reference/api/AggregationsNestedAggregation.md @@ -0,0 +1,5 @@ +## Interface `AggregationsNestedAggregation` + +| Name | Type | Description | +| - | - | - | +| `path` | [Field](./Field.md) | The path to the field of type `nested`. | diff --git a/docs/reference/api/AggregationsNormalizeAggregation.md b/docs/reference/api/AggregationsNormalizeAggregation.md new file mode 100644 index 000000000..604150578 --- /dev/null +++ b/docs/reference/api/AggregationsNormalizeAggregation.md @@ -0,0 +1,5 @@ +## Interface `AggregationsNormalizeAggregation` + +| Name | Type | Description | +| - | - | - | +| `method` | [AggregationsNormalizeMethod](./AggregationsNormalizeMethod.md) | The specific method to apply. | diff --git a/docs/reference/api/AggregationsNormalizeMethod.md b/docs/reference/api/AggregationsNormalizeMethod.md new file mode 100644 index 000000000..b386bfab1 --- /dev/null +++ b/docs/reference/api/AggregationsNormalizeMethod.md @@ -0,0 +1,4 @@ +## `AggregationsNormalizeMethod` +::: +type AggregationsNormalizeMethod = 'rescale_0_1' | 'rescale_0_100' | 'percent_of_sum' | 'mean' | 'z-score' | 'softmax'; +::: diff --git a/docs/reference/api/AggregationsParentAggregate.md b/docs/reference/api/AggregationsParentAggregate.md new file mode 100644 index 000000000..7bff81894 --- /dev/null +++ b/docs/reference/api/AggregationsParentAggregate.md @@ -0,0 +1,4 @@ +## `AggregationsParentAggregate` +::: +type AggregationsParentAggregate = [AggregationsParentAggregateKeys](./AggregationsParentAggregateKeys.md) & { [property: string]: [AggregationsAggregate](./AggregationsAggregate.md) | [long](./long.md) | [Metadata](./Metadata.md);}; +::: diff --git a/docs/reference/api/AggregationsParentAggregateKeys.md b/docs/reference/api/AggregationsParentAggregateKeys.md new file mode 100644 index 000000000..188558304 --- /dev/null +++ b/docs/reference/api/AggregationsParentAggregateKeys.md @@ -0,0 +1,4 @@ +## Interface `AggregationsParentAggregateKeys` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/AggregationsParentAggregation.md b/docs/reference/api/AggregationsParentAggregation.md new file mode 100644 index 000000000..6ef05e20c --- /dev/null +++ b/docs/reference/api/AggregationsParentAggregation.md @@ -0,0 +1,5 @@ +## Interface `AggregationsParentAggregation` + +| Name | Type | Description | +| - | - | - | +| `type` | [RelationName](./RelationName.md) | The child type that should be selected. | diff --git a/docs/reference/api/AggregationsPercentageScoreHeuristic.md b/docs/reference/api/AggregationsPercentageScoreHeuristic.md new file mode 100644 index 000000000..f0dcb3468 --- /dev/null +++ b/docs/reference/api/AggregationsPercentageScoreHeuristic.md @@ -0,0 +1,4 @@ +## Interface `AggregationsPercentageScoreHeuristic` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/AggregationsPercentileRanksAggregation.md b/docs/reference/api/AggregationsPercentileRanksAggregation.md new file mode 100644 index 000000000..80d7b7c3c --- /dev/null +++ b/docs/reference/api/AggregationsPercentileRanksAggregation.md @@ -0,0 +1,8 @@ +## Interface `AggregationsPercentileRanksAggregation` + +| Name | Type | Description | +| - | - | - | +| `hdr` | [AggregationsHdrMethod](./AggregationsHdrMethod.md) | Uses the alternative High Dynamic Range Histogram algorithm to calculate percentile ranks. | +| `keyed` | boolean | By default, the aggregation associates a unique string key with each bucket and returns the ranges as a hash rather than an array. Set to `false` to disable this behavior. | +| `tdigest` | [AggregationsTDigest](./AggregationsTDigest.md) | Sets parameters for the default TDigest algorithm used to calculate percentile ranks. | +| `values` | [double](./double.md)[] | null | An array of values for which to calculate the percentile ranks. | diff --git a/docs/reference/api/AggregationsPercentiles.md b/docs/reference/api/AggregationsPercentiles.md new file mode 100644 index 000000000..9a8294a45 --- /dev/null +++ b/docs/reference/api/AggregationsPercentiles.md @@ -0,0 +1,4 @@ +## `AggregationsPercentiles` +::: +type AggregationsPercentiles = [AggregationsKeyedPercentiles](./AggregationsKeyedPercentiles.md) | [AggregationsArrayPercentilesItem](./AggregationsArrayPercentilesItem.md)[]; +::: diff --git a/docs/reference/api/AggregationsPercentilesAggregateBase.md b/docs/reference/api/AggregationsPercentilesAggregateBase.md new file mode 100644 index 000000000..a33a094f1 --- /dev/null +++ b/docs/reference/api/AggregationsPercentilesAggregateBase.md @@ -0,0 +1,5 @@ +## Interface `AggregationsPercentilesAggregateBase` + +| Name | Type | Description | +| - | - | - | +| `values` | [AggregationsPercentiles](./AggregationsPercentiles.md) |   | diff --git a/docs/reference/api/AggregationsPercentilesAggregation.md b/docs/reference/api/AggregationsPercentilesAggregation.md new file mode 100644 index 000000000..927ba373d --- /dev/null +++ b/docs/reference/api/AggregationsPercentilesAggregation.md @@ -0,0 +1,8 @@ +## Interface `AggregationsPercentilesAggregation` + +| Name | Type | Description | +| - | - | - | +| `hdr` | [AggregationsHdrMethod](./AggregationsHdrMethod.md) | Uses the alternative High Dynamic Range Histogram algorithm to calculate percentiles. | +| `keyed` | boolean | By default, the aggregation associates a unique string key with each bucket and returns the ranges as a hash rather than an array. Set to `false` to disable this behavior. | +| `percents` | [double](./double.md)[] | The percentiles to calculate. | +| `tdigest` | [AggregationsTDigest](./AggregationsTDigest.md) | Sets parameters for the default TDigest algorithm used to calculate percentiles. | diff --git a/docs/reference/api/AggregationsPercentilesBucketAggregate.md b/docs/reference/api/AggregationsPercentilesBucketAggregate.md new file mode 100644 index 000000000..54d4e1ad8 --- /dev/null +++ b/docs/reference/api/AggregationsPercentilesBucketAggregate.md @@ -0,0 +1,4 @@ +## Interface `AggregationsPercentilesBucketAggregate` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/AggregationsPercentilesBucketAggregation.md b/docs/reference/api/AggregationsPercentilesBucketAggregation.md new file mode 100644 index 000000000..122fe43c8 --- /dev/null +++ b/docs/reference/api/AggregationsPercentilesBucketAggregation.md @@ -0,0 +1,5 @@ +## Interface `AggregationsPercentilesBucketAggregation` + +| Name | Type | Description | +| - | - | - | +| `percents` | [double](./double.md)[] | The list of percentiles to calculate. | diff --git a/docs/reference/api/AggregationsPipelineAggregationBase.md b/docs/reference/api/AggregationsPipelineAggregationBase.md new file mode 100644 index 000000000..7ca8d7bd1 --- /dev/null +++ b/docs/reference/api/AggregationsPipelineAggregationBase.md @@ -0,0 +1,6 @@ +## Interface `AggregationsPipelineAggregationBase` + +| Name | Type | Description | +| - | - | - | +| `format` | string | `DecimalFormat` pattern for the output value. If specified, the formatted value is returned in the aggregation’s `value_as_string` property. | +| `gap_policy` | [AggregationsGapPolicy](./AggregationsGapPolicy.md) | Policy to apply when gaps are found in the data. | diff --git a/docs/reference/api/AggregationsRandomSamplerAggregation.md b/docs/reference/api/AggregationsRandomSamplerAggregation.md new file mode 100644 index 000000000..e38216327 --- /dev/null +++ b/docs/reference/api/AggregationsRandomSamplerAggregation.md @@ -0,0 +1,7 @@ +## Interface `AggregationsRandomSamplerAggregation` + +| Name | Type | Description | +| - | - | - | +| `probability` | [double](./double.md) | The probability that a document will be included in the aggregated data. Must be greater than 0, less than 0.5, or exactly 1. The lower the probability, the fewer documents are matched. | +| `seed` | [integer](./integer.md) | The seed to generate the random sampling of documents. When a seed is provided, the random subset of documents is the same between calls. | +| `shard_seed` | [integer](./integer.md) | When combined with seed, setting shard_seed ensures 100% consistent sampling over shards where data is exactly the same. | diff --git a/docs/reference/api/AggregationsRangeAggregate.md b/docs/reference/api/AggregationsRangeAggregate.md new file mode 100644 index 000000000..7e9ca369d --- /dev/null +++ b/docs/reference/api/AggregationsRangeAggregate.md @@ -0,0 +1,4 @@ +## Interface `AggregationsRangeAggregate` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/AggregationsRangeAggregation.md b/docs/reference/api/AggregationsRangeAggregation.md new file mode 100644 index 000000000..adf52d4da --- /dev/null +++ b/docs/reference/api/AggregationsRangeAggregation.md @@ -0,0 +1,10 @@ +## Interface `AggregationsRangeAggregation` + +| Name | Type | Description | +| - | - | - | +| `field` | [Field](./Field.md) | The date field whose values are use to build ranges. | +| `format` | string |   | +| `keyed` | boolean | Set to `true` to associate a unique string key with each bucket and return the ranges as a hash rather than an array. | +| `missing` | [integer](./integer.md) | The value to apply to documents that do not have a value. By default, documents without a value are ignored. | +| `ranges` | [AggregationsAggregationRange](./AggregationsAggregationRange.md)[] | An array of ranges used to bucket documents. | +| `script` | [Script](./Script.md) | [ScriptSource](./ScriptSource.md) |   | diff --git a/docs/reference/api/AggregationsRangeBucket.md b/docs/reference/api/AggregationsRangeBucket.md new file mode 100644 index 000000000..a3afdd010 --- /dev/null +++ b/docs/reference/api/AggregationsRangeBucket.md @@ -0,0 +1,4 @@ +## `AggregationsRangeBucket` +::: +type AggregationsRangeBucket = [AggregationsRangeBucketKeys](./AggregationsRangeBucketKeys.md) & { [property: string]: [AggregationsAggregate](./AggregationsAggregate.md) | [double](./double.md) | string | [long](./long.md);}; +::: diff --git a/docs/reference/api/AggregationsRangeBucketKeys.md b/docs/reference/api/AggregationsRangeBucketKeys.md new file mode 100644 index 000000000..aa72726e8 --- /dev/null +++ b/docs/reference/api/AggregationsRangeBucketKeys.md @@ -0,0 +1,9 @@ +## Interface `AggregationsRangeBucketKeys` + +| Name | Type | Description | +| - | - | - | +| `from_as_string` | string |   | +| `from` | [double](./double.md) |   | +| `key` | string | The bucket key. Present if the aggregation is _not_ keyed | +| `to_as_string` | string |   | +| `to` | [double](./double.md) |   | diff --git a/docs/reference/api/AggregationsRareTermsAggregation.md b/docs/reference/api/AggregationsRareTermsAggregation.md new file mode 100644 index 000000000..4f4d7a89f --- /dev/null +++ b/docs/reference/api/AggregationsRareTermsAggregation.md @@ -0,0 +1,11 @@ +## Interface `AggregationsRareTermsAggregation` + +| Name | Type | Description | +| - | - | - | +| `exclude` | [AggregationsTermsExclude](./AggregationsTermsExclude.md) | Terms that should be excluded from the aggregation. | +| `field` | [Field](./Field.md) | The field from which to return rare terms. | +| `include` | [AggregationsTermsInclude](./AggregationsTermsInclude.md) | Terms that should be included in the aggregation. | +| `max_doc_count` | [long](./long.md) | The maximum number of documents a term should appear in. | +| `missing` | [AggregationsMissing](./AggregationsMissing.md) | The value to apply to documents that do not have a value. By default, documents without a value are ignored. | +| `precision` | [double](./double.md) | The precision of the internal CuckooFilters. Smaller precision leads to better approximation, but higher memory usage. | +| `value_type` | string |   | diff --git a/docs/reference/api/AggregationsRateAggregate.md b/docs/reference/api/AggregationsRateAggregate.md new file mode 100644 index 000000000..994da3d3c --- /dev/null +++ b/docs/reference/api/AggregationsRateAggregate.md @@ -0,0 +1,6 @@ +## Interface `AggregationsRateAggregate` + +| Name | Type | Description | +| - | - | - | +| `value_as_string` | string |   | +| `value` | [double](./double.md) |   | diff --git a/docs/reference/api/AggregationsRateAggregation.md b/docs/reference/api/AggregationsRateAggregation.md new file mode 100644 index 000000000..dbe40e7f8 --- /dev/null +++ b/docs/reference/api/AggregationsRateAggregation.md @@ -0,0 +1,6 @@ +## Interface `AggregationsRateAggregation` + +| Name | Type | Description | +| - | - | - | +| `mode` | [AggregationsRateMode](./AggregationsRateMode.md) | How the rate is calculated. | +| `unit` | [AggregationsCalendarInterval](./AggregationsCalendarInterval.md) | The interval used to calculate the rate. By default, the interval of the `date_histogram` is used. | diff --git a/docs/reference/api/AggregationsRateMode.md b/docs/reference/api/AggregationsRateMode.md new file mode 100644 index 000000000..81c492d06 --- /dev/null +++ b/docs/reference/api/AggregationsRateMode.md @@ -0,0 +1,4 @@ +## `AggregationsRateMode` +::: +type AggregationsRateMode = 'sum' | 'value_count'; +::: diff --git a/docs/reference/api/AggregationsReverseNestedAggregate.md b/docs/reference/api/AggregationsReverseNestedAggregate.md new file mode 100644 index 000000000..5ec524e75 --- /dev/null +++ b/docs/reference/api/AggregationsReverseNestedAggregate.md @@ -0,0 +1,4 @@ +## `AggregationsReverseNestedAggregate` +::: +type AggregationsReverseNestedAggregate = [AggregationsReverseNestedAggregateKeys](./AggregationsReverseNestedAggregateKeys.md) & { [property: string]: [AggregationsAggregate](./AggregationsAggregate.md) | [long](./long.md) | [Metadata](./Metadata.md);}; +::: diff --git a/docs/reference/api/AggregationsReverseNestedAggregateKeys.md b/docs/reference/api/AggregationsReverseNestedAggregateKeys.md new file mode 100644 index 000000000..d2e1410b8 --- /dev/null +++ b/docs/reference/api/AggregationsReverseNestedAggregateKeys.md @@ -0,0 +1,4 @@ +## Interface `AggregationsReverseNestedAggregateKeys` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/AggregationsReverseNestedAggregation.md b/docs/reference/api/AggregationsReverseNestedAggregation.md new file mode 100644 index 000000000..0afd60b96 --- /dev/null +++ b/docs/reference/api/AggregationsReverseNestedAggregation.md @@ -0,0 +1,5 @@ +## Interface `AggregationsReverseNestedAggregation` + +| Name | Type | Description | +| - | - | - | +| `path` | [Field](./Field.md) | Defines the nested object field that should be joined back to. The default is empty, which means that it joins back to the root/main document level. | diff --git a/docs/reference/api/AggregationsSamplerAggregate.md b/docs/reference/api/AggregationsSamplerAggregate.md new file mode 100644 index 000000000..ef65d8d86 --- /dev/null +++ b/docs/reference/api/AggregationsSamplerAggregate.md @@ -0,0 +1,4 @@ +## `AggregationsSamplerAggregate` +::: +type AggregationsSamplerAggregate = [AggregationsSamplerAggregateKeys](./AggregationsSamplerAggregateKeys.md) & { [property: string]: [AggregationsAggregate](./AggregationsAggregate.md) | [long](./long.md) | [Metadata](./Metadata.md);}; +::: diff --git a/docs/reference/api/AggregationsSamplerAggregateKeys.md b/docs/reference/api/AggregationsSamplerAggregateKeys.md new file mode 100644 index 000000000..1a8bef963 --- /dev/null +++ b/docs/reference/api/AggregationsSamplerAggregateKeys.md @@ -0,0 +1,4 @@ +## Interface `AggregationsSamplerAggregateKeys` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/AggregationsSamplerAggregation.md b/docs/reference/api/AggregationsSamplerAggregation.md new file mode 100644 index 000000000..6077f619a --- /dev/null +++ b/docs/reference/api/AggregationsSamplerAggregation.md @@ -0,0 +1,5 @@ +## Interface `AggregationsSamplerAggregation` + +| Name | Type | Description | +| - | - | - | +| `shard_size` | [integer](./integer.md) | Limits how many top-scoring documents are collected in the sample processed on each shard. | diff --git a/docs/reference/api/AggregationsSamplerAggregationExecutionHint.md b/docs/reference/api/AggregationsSamplerAggregationExecutionHint.md new file mode 100644 index 000000000..dc2090af7 --- /dev/null +++ b/docs/reference/api/AggregationsSamplerAggregationExecutionHint.md @@ -0,0 +1,4 @@ +## `AggregationsSamplerAggregationExecutionHint` +::: +type AggregationsSamplerAggregationExecutionHint = 'map' | 'global_ordinals' | 'bytes_hash'; +::: diff --git a/docs/reference/api/AggregationsScriptedHeuristic.md b/docs/reference/api/AggregationsScriptedHeuristic.md new file mode 100644 index 000000000..1bc6b7779 --- /dev/null +++ b/docs/reference/api/AggregationsScriptedHeuristic.md @@ -0,0 +1,5 @@ +## Interface `AggregationsScriptedHeuristic` + +| Name | Type | Description | +| - | - | - | +| `script` | [Script](./Script.md) | [ScriptSource](./ScriptSource.md) |   | diff --git a/docs/reference/api/AggregationsScriptedMetricAggregate.md b/docs/reference/api/AggregationsScriptedMetricAggregate.md new file mode 100644 index 000000000..e03807554 --- /dev/null +++ b/docs/reference/api/AggregationsScriptedMetricAggregate.md @@ -0,0 +1,5 @@ +## Interface `AggregationsScriptedMetricAggregate` + +| Name | Type | Description | +| - | - | - | +| `value` | any |   | diff --git a/docs/reference/api/AggregationsScriptedMetricAggregation.md b/docs/reference/api/AggregationsScriptedMetricAggregation.md new file mode 100644 index 000000000..9640ea0e4 --- /dev/null +++ b/docs/reference/api/AggregationsScriptedMetricAggregation.md @@ -0,0 +1,9 @@ +## Interface `AggregationsScriptedMetricAggregation` + +| Name | Type | Description | +| - | - | - | +| `combine_script` | [Script](./Script.md) | [ScriptSource](./ScriptSource.md) | Runs once on each shard after document collection is complete. Allows the aggregation to consolidate the state returned from each shard. | +| `init_script` | [Script](./Script.md) | [ScriptSource](./ScriptSource.md) | Runs prior to any collection of documents. Allows the aggregation to set up any initial state. | +| `map_script` | [Script](./Script.md) | [ScriptSource](./ScriptSource.md) | Run once per document collected. If no `combine_script` is specified, the resulting state needs to be stored in the `state` object. | +| `params` | Record | A global object with script parameters for `init`, `map` and `combine` scripts. It is shared between the scripts. | +| `reduce_script` | [Script](./Script.md) | [ScriptSource](./ScriptSource.md) | Runs once on the coordinating node after all shards have returned their results. The script is provided with access to a variable `states`, which is an array of the result of the `combine_script` on each shard. | diff --git a/docs/reference/api/AggregationsSerialDifferencingAggregation.md b/docs/reference/api/AggregationsSerialDifferencingAggregation.md new file mode 100644 index 000000000..973c85b25 --- /dev/null +++ b/docs/reference/api/AggregationsSerialDifferencingAggregation.md @@ -0,0 +1,5 @@ +## Interface `AggregationsSerialDifferencingAggregation` + +| Name | Type | Description | +| - | - | - | +| `lag` | [integer](./integer.md) | The historical bucket to subtract from the current value. Must be a positive, non-zero integer. | diff --git a/docs/reference/api/AggregationsSignificantLongTermsAggregate.md b/docs/reference/api/AggregationsSignificantLongTermsAggregate.md new file mode 100644 index 000000000..4629020f5 --- /dev/null +++ b/docs/reference/api/AggregationsSignificantLongTermsAggregate.md @@ -0,0 +1,4 @@ +## Interface `AggregationsSignificantLongTermsAggregate` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/AggregationsSignificantLongTermsBucket.md b/docs/reference/api/AggregationsSignificantLongTermsBucket.md new file mode 100644 index 000000000..364cbb3fa --- /dev/null +++ b/docs/reference/api/AggregationsSignificantLongTermsBucket.md @@ -0,0 +1,4 @@ +## `AggregationsSignificantLongTermsBucket` +::: +type AggregationsSignificantLongTermsBucket = [AggregationsSignificantLongTermsBucketKeys](./AggregationsSignificantLongTermsBucketKeys.md) & { [property: string]: [AggregationsAggregate](./AggregationsAggregate.md) | [long](./long.md) | string | [double](./double.md);}; +::: diff --git a/docs/reference/api/AggregationsSignificantLongTermsBucketKeys.md b/docs/reference/api/AggregationsSignificantLongTermsBucketKeys.md new file mode 100644 index 000000000..776c24ea1 --- /dev/null +++ b/docs/reference/api/AggregationsSignificantLongTermsBucketKeys.md @@ -0,0 +1,6 @@ +## Interface `AggregationsSignificantLongTermsBucketKeys` + +| Name | Type | Description | +| - | - | - | +| `key_as_string` | string |   | +| `key` | [long](./long.md) |   | diff --git a/docs/reference/api/AggregationsSignificantStringTermsAggregate.md b/docs/reference/api/AggregationsSignificantStringTermsAggregate.md new file mode 100644 index 000000000..f0acf3b1a --- /dev/null +++ b/docs/reference/api/AggregationsSignificantStringTermsAggregate.md @@ -0,0 +1,4 @@ +## Interface `AggregationsSignificantStringTermsAggregate` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/AggregationsSignificantStringTermsBucket.md b/docs/reference/api/AggregationsSignificantStringTermsBucket.md new file mode 100644 index 000000000..ff2268342 --- /dev/null +++ b/docs/reference/api/AggregationsSignificantStringTermsBucket.md @@ -0,0 +1,4 @@ +## `AggregationsSignificantStringTermsBucket` +::: +type AggregationsSignificantStringTermsBucket = [AggregationsSignificantStringTermsBucketKeys](./AggregationsSignificantStringTermsBucketKeys.md) & { [property: string]: [AggregationsAggregate](./AggregationsAggregate.md) | string | [double](./double.md) | [long](./long.md);}; +::: diff --git a/docs/reference/api/AggregationsSignificantStringTermsBucketKeys.md b/docs/reference/api/AggregationsSignificantStringTermsBucketKeys.md new file mode 100644 index 000000000..d1bffaedd --- /dev/null +++ b/docs/reference/api/AggregationsSignificantStringTermsBucketKeys.md @@ -0,0 +1,5 @@ +## Interface `AggregationsSignificantStringTermsBucketKeys` + +| Name | Type | Description | +| - | - | - | +| `key` | string |   | diff --git a/docs/reference/api/AggregationsSignificantTermsAggregateBase.md b/docs/reference/api/AggregationsSignificantTermsAggregateBase.md new file mode 100644 index 000000000..8d750614e --- /dev/null +++ b/docs/reference/api/AggregationsSignificantTermsAggregateBase.md @@ -0,0 +1,6 @@ +## Interface `AggregationsSignificantTermsAggregateBase` + +| Name | Type | Description | +| - | - | - | +| `bg_count` | [long](./long.md) |   | +| `doc_count` | [long](./long.md) |   | diff --git a/docs/reference/api/AggregationsSignificantTermsAggregation.md b/docs/reference/api/AggregationsSignificantTermsAggregation.md new file mode 100644 index 000000000..1b9bb9685 --- /dev/null +++ b/docs/reference/api/AggregationsSignificantTermsAggregation.md @@ -0,0 +1,19 @@ +## Interface `AggregationsSignificantTermsAggregation` + +| Name | Type | Description | +| - | - | - | +| `background_filter` | [QueryDslQueryContainer](./QueryDslQueryContainer.md) | A background filter that can be used to focus in on significant terms within a narrower context, instead of the entire index. | +| `chi_square` | [AggregationsChiSquareHeuristic](./AggregationsChiSquareHeuristic.md) | Use Chi square, as described in "Information Retrieval", Manning et al., Chapter 13.5.2, as the significance score. | +| `exclude` | [AggregationsTermsExclude](./AggregationsTermsExclude.md) | Terms to exclude. | +| `execution_hint` | [AggregationsTermsAggregationExecutionHint](./AggregationsTermsAggregationExecutionHint.md) | Mechanism by which the aggregation should be executed: using field values directly or using global ordinals. | +| `field` | [Field](./Field.md) | The field from which to return significant terms. | +| `gnd` | [AggregationsGoogleNormalizedDistanceHeuristic](./AggregationsGoogleNormalizedDistanceHeuristic.md) | Use Google normalized distance as described in "The Google Similarity Distance", Cilibrasi and Vitanyi, 2007, as the significance score. | +| `include` | [AggregationsTermsInclude](./AggregationsTermsInclude.md) | Terms to include. | +| `jlh` | [EmptyObject](./EmptyObject.md) | Use JLH score as the significance score. | +| `min_doc_count` | [long](./long.md) | Only return terms that are found in more than `min_doc_count` hits. | +| `mutual_information` | [AggregationsMutualInformationHeuristic](./AggregationsMutualInformationHeuristic.md) | Use mutual information as described in "Information Retrieval", Manning et al., Chapter 13.5.1, as the significance score. | +| `percentage` | [AggregationsPercentageScoreHeuristic](./AggregationsPercentageScoreHeuristic.md) | A simple calculation of the number of documents in the foreground sample with a term divided by the number of documents in the background with the term. | +| `script_heuristic` | [AggregationsScriptedHeuristic](./AggregationsScriptedHeuristic.md) | Customized score, implemented via a script. | +| `shard_min_doc_count` | [long](./long.md) | Regulates the certainty a shard has if the term should actually be added to the candidate list or not with respect to the `min_doc_count`. Terms will only be considered if their local shard frequency within the set is higher than the `shard_min_doc_count`. | +| `shard_size` | [integer](./integer.md) | Can be used to control the volumes of candidate terms produced by each shard. By default, `shard_size` will be automatically estimated based on the number of shards and the `size` parameter. | +| `size` | [integer](./integer.md) | The number of buckets returned out of the overall terms list. | diff --git a/docs/reference/api/AggregationsSignificantTermsBucketBase.md b/docs/reference/api/AggregationsSignificantTermsBucketBase.md new file mode 100644 index 000000000..defbfeb09 --- /dev/null +++ b/docs/reference/api/AggregationsSignificantTermsBucketBase.md @@ -0,0 +1,6 @@ +## Interface `AggregationsSignificantTermsBucketBase` + +| Name | Type | Description | +| - | - | - | +| `bg_count` | [long](./long.md) |   | +| `score` | [double](./double.md) |   | diff --git a/docs/reference/api/AggregationsSignificantTextAggregation.md b/docs/reference/api/AggregationsSignificantTextAggregation.md new file mode 100644 index 000000000..4371cfd84 --- /dev/null +++ b/docs/reference/api/AggregationsSignificantTextAggregation.md @@ -0,0 +1,21 @@ +## Interface `AggregationsSignificantTextAggregation` + +| Name | Type | Description | +| - | - | - | +| `background_filter` | [QueryDslQueryContainer](./QueryDslQueryContainer.md) | A background filter that can be used to focus in on significant terms within a narrower context, instead of the entire index. | +| `chi_square` | [AggregationsChiSquareHeuristic](./AggregationsChiSquareHeuristic.md) | Use Chi square, as described in "Information Retrieval", Manning et al., Chapter 13.5.2, as the significance score. | +| `exclude` | [AggregationsTermsExclude](./AggregationsTermsExclude.md) | Values to exclude. | +| `execution_hint` | [AggregationsTermsAggregationExecutionHint](./AggregationsTermsAggregationExecutionHint.md) | Determines whether the aggregation will use field values directly or global ordinals. | +| `field` | [Field](./Field.md) | The field from which to return significant text. | +| `filter_duplicate_text` | boolean | Whether to out duplicate text to deal with noisy data. | +| `gnd` | [AggregationsGoogleNormalizedDistanceHeuristic](./AggregationsGoogleNormalizedDistanceHeuristic.md) | Use Google normalized distance as described in "The Google Similarity Distance", Cilibrasi and Vitanyi, 2007, as the significance score. | +| `include` | [AggregationsTermsInclude](./AggregationsTermsInclude.md) | Values to include. | +| `jlh` | [EmptyObject](./EmptyObject.md) | Use JLH score as the significance score. | +| `min_doc_count` | [long](./long.md) | Only return values that are found in more than `min_doc_count` hits. | +| `mutual_information` | [AggregationsMutualInformationHeuristic](./AggregationsMutualInformationHeuristic.md) | Use mutual information as described in "Information Retrieval", Manning et al., Chapter 13.5.1, as the significance score. | +| `percentage` | [AggregationsPercentageScoreHeuristic](./AggregationsPercentageScoreHeuristic.md) | A simple calculation of the number of documents in the foreground sample with a term divided by the number of documents in the background with the term. | +| `script_heuristic` | [AggregationsScriptedHeuristic](./AggregationsScriptedHeuristic.md) | Customized score, implemented via a script. | +| `shard_min_doc_count` | [long](./long.md) | Regulates the certainty a shard has if the values should actually be added to the candidate list or not with respect to the min_doc_count. Values will only be considered if their local shard frequency within the set is higher than the `shard_min_doc_count`. | +| `shard_size` | [integer](./integer.md) | The number of candidate terms produced by each shard. By default, `shard_size` will be automatically estimated based on the number of shards and the `size` parameter. | +| `size` | [integer](./integer.md) | The number of buckets returned out of the overall terms list. | +| `source_fields` | [Fields](./Fields.md) | Overrides the JSON `_source` fields from which text will be analyzed. | diff --git a/docs/reference/api/AggregationsSimpleMovingAverageAggregation.md b/docs/reference/api/AggregationsSimpleMovingAverageAggregation.md new file mode 100644 index 000000000..a90f1aaf4 --- /dev/null +++ b/docs/reference/api/AggregationsSimpleMovingAverageAggregation.md @@ -0,0 +1,6 @@ +## Interface `AggregationsSimpleMovingAverageAggregation` + +| Name | Type | Description | +| - | - | - | +| `model` | 'simple' |   | +| `settings` | [EmptyObject](./EmptyObject.md) |   | diff --git a/docs/reference/api/AggregationsSimpleValueAggregate.md b/docs/reference/api/AggregationsSimpleValueAggregate.md new file mode 100644 index 000000000..15644ce2e --- /dev/null +++ b/docs/reference/api/AggregationsSimpleValueAggregate.md @@ -0,0 +1,4 @@ +## Interface `AggregationsSimpleValueAggregate` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/AggregationsSingleBucketAggregateBase.md b/docs/reference/api/AggregationsSingleBucketAggregateBase.md new file mode 100644 index 000000000..1b39842ab --- /dev/null +++ b/docs/reference/api/AggregationsSingleBucketAggregateBase.md @@ -0,0 +1,5 @@ +## Interface `AggregationsSingleBucketAggregateBase` + +| Name | Type | Description | +| - | - | - | +| `doc_count` | [long](./long.md) |   | diff --git a/docs/reference/api/AggregationsSingleMetricAggregateBase.md b/docs/reference/api/AggregationsSingleMetricAggregateBase.md new file mode 100644 index 000000000..f16ebd418 --- /dev/null +++ b/docs/reference/api/AggregationsSingleMetricAggregateBase.md @@ -0,0 +1,6 @@ +## Interface `AggregationsSingleMetricAggregateBase` + +| Name | Type | Description | +| - | - | - | +| `value_as_string` | string |   | +| `value` | [double](./double.md) | null | The metric value. A missing value generally means that there was no data to aggregate, unless specified otherwise. | diff --git a/docs/reference/api/AggregationsStandardDeviationBounds.md b/docs/reference/api/AggregationsStandardDeviationBounds.md new file mode 100644 index 000000000..d2c4661d6 --- /dev/null +++ b/docs/reference/api/AggregationsStandardDeviationBounds.md @@ -0,0 +1,10 @@ +## Interface `AggregationsStandardDeviationBounds` + +| Name | Type | Description | +| - | - | - | +| `lower_population` | [double](./double.md) | null |   | +| `lower_sampling` | [double](./double.md) | null |   | +| `lower` | [double](./double.md) | null |   | +| `upper_population` | [double](./double.md) | null |   | +| `upper_sampling` | [double](./double.md) | null |   | +| `upper` | [double](./double.md) | null |   | diff --git a/docs/reference/api/AggregationsStandardDeviationBoundsAsString.md b/docs/reference/api/AggregationsStandardDeviationBoundsAsString.md new file mode 100644 index 000000000..d8f3dc518 --- /dev/null +++ b/docs/reference/api/AggregationsStandardDeviationBoundsAsString.md @@ -0,0 +1,10 @@ +## Interface `AggregationsStandardDeviationBoundsAsString` + +| Name | Type | Description | +| - | - | - | +| `lower_population` | string |   | +| `lower_sampling` | string |   | +| `lower` | string |   | +| `upper_population` | string |   | +| `upper_sampling` | string |   | +| `upper` | string |   | diff --git a/docs/reference/api/AggregationsStatsAggregate.md b/docs/reference/api/AggregationsStatsAggregate.md new file mode 100644 index 000000000..a6a0a5b46 --- /dev/null +++ b/docs/reference/api/AggregationsStatsAggregate.md @@ -0,0 +1,13 @@ +## Interface `AggregationsStatsAggregate` + +| Name | Type | Description | +| - | - | - | +| `avg_as_string` | string |   | +| `avg` | [double](./double.md) | null |   | +| `count` | [long](./long.md) |   | +| `max_as_string` | string |   | +| `max` | [double](./double.md) | null |   | +| `min_as_string` | string |   | +| `min` | [double](./double.md) | null |   | +| `sum_as_string` | string |   | +| `sum` | [double](./double.md) |   | diff --git a/docs/reference/api/AggregationsStatsAggregation.md b/docs/reference/api/AggregationsStatsAggregation.md new file mode 100644 index 000000000..2b91b3d32 --- /dev/null +++ b/docs/reference/api/AggregationsStatsAggregation.md @@ -0,0 +1,4 @@ +## Interface `AggregationsStatsAggregation` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/AggregationsStatsBucketAggregate.md b/docs/reference/api/AggregationsStatsBucketAggregate.md new file mode 100644 index 000000000..983064b99 --- /dev/null +++ b/docs/reference/api/AggregationsStatsBucketAggregate.md @@ -0,0 +1,4 @@ +## Interface `AggregationsStatsBucketAggregate` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/AggregationsStatsBucketAggregation.md b/docs/reference/api/AggregationsStatsBucketAggregation.md new file mode 100644 index 000000000..dd1a1b8f3 --- /dev/null +++ b/docs/reference/api/AggregationsStatsBucketAggregation.md @@ -0,0 +1,4 @@ +## Interface `AggregationsStatsBucketAggregation` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/AggregationsStringRareTermsAggregate.md b/docs/reference/api/AggregationsStringRareTermsAggregate.md new file mode 100644 index 000000000..1632f17c1 --- /dev/null +++ b/docs/reference/api/AggregationsStringRareTermsAggregate.md @@ -0,0 +1,4 @@ +## Interface `AggregationsStringRareTermsAggregate` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/AggregationsStringRareTermsBucket.md b/docs/reference/api/AggregationsStringRareTermsBucket.md new file mode 100644 index 000000000..f7ee13f19 --- /dev/null +++ b/docs/reference/api/AggregationsStringRareTermsBucket.md @@ -0,0 +1,4 @@ +## `AggregationsStringRareTermsBucket` +::: +type AggregationsStringRareTermsBucket = [AggregationsStringRareTermsBucketKeys](./AggregationsStringRareTermsBucketKeys.md) & { [property: string]: [AggregationsAggregate](./AggregationsAggregate.md) | string | [long](./long.md);}; +::: diff --git a/docs/reference/api/AggregationsStringRareTermsBucketKeys.md b/docs/reference/api/AggregationsStringRareTermsBucketKeys.md new file mode 100644 index 000000000..f368b6f66 --- /dev/null +++ b/docs/reference/api/AggregationsStringRareTermsBucketKeys.md @@ -0,0 +1,5 @@ +## Interface `AggregationsStringRareTermsBucketKeys` + +| Name | Type | Description | +| - | - | - | +| `key` | string |   | diff --git a/docs/reference/api/AggregationsStringStatsAggregate.md b/docs/reference/api/AggregationsStringStatsAggregate.md new file mode 100644 index 000000000..ce7ab8988 --- /dev/null +++ b/docs/reference/api/AggregationsStringStatsAggregate.md @@ -0,0 +1,13 @@ +## Interface `AggregationsStringStatsAggregate` + +| Name | Type | Description | +| - | - | - | +| `avg_length_as_string` | string |   | +| `avg_length` | [double](./double.md) | null |   | +| `count` | [long](./long.md) |   | +| `distribution` | Record | null |   | +| `entropy` | [double](./double.md) | null |   | +| `max_length_as_string` | string |   | +| `max_length` | [integer](./integer.md) | null |   | +| `min_length_as_string` | string |   | +| `min_length` | [integer](./integer.md) | null |   | diff --git a/docs/reference/api/AggregationsStringStatsAggregation.md b/docs/reference/api/AggregationsStringStatsAggregation.md new file mode 100644 index 000000000..766c127c9 --- /dev/null +++ b/docs/reference/api/AggregationsStringStatsAggregation.md @@ -0,0 +1,5 @@ +## Interface `AggregationsStringStatsAggregation` + +| Name | Type | Description | +| - | - | - | +| `show_distribution` | boolean | Shows the probability distribution for all characters. | diff --git a/docs/reference/api/AggregationsStringTermsAggregate.md b/docs/reference/api/AggregationsStringTermsAggregate.md new file mode 100644 index 000000000..81d010fb2 --- /dev/null +++ b/docs/reference/api/AggregationsStringTermsAggregate.md @@ -0,0 +1,4 @@ +## Interface `AggregationsStringTermsAggregate` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/AggregationsStringTermsBucket.md b/docs/reference/api/AggregationsStringTermsBucket.md new file mode 100644 index 000000000..34f945d79 --- /dev/null +++ b/docs/reference/api/AggregationsStringTermsBucket.md @@ -0,0 +1,4 @@ +## `AggregationsStringTermsBucket` +::: +type AggregationsStringTermsBucket = [AggregationsStringTermsBucketKeys](./AggregationsStringTermsBucketKeys.md) & { [property: string]: [AggregationsAggregate](./AggregationsAggregate.md) | [FieldValue](./FieldValue.md) | [long](./long.md);}; +::: diff --git a/docs/reference/api/AggregationsStringTermsBucketKeys.md b/docs/reference/api/AggregationsStringTermsBucketKeys.md new file mode 100644 index 000000000..37d2c970b --- /dev/null +++ b/docs/reference/api/AggregationsStringTermsBucketKeys.md @@ -0,0 +1,5 @@ +## Interface `AggregationsStringTermsBucketKeys` + +| Name | Type | Description | +| - | - | - | +| `key` | [FieldValue](./FieldValue.md) |   | diff --git a/docs/reference/api/AggregationsSumAggregate.md b/docs/reference/api/AggregationsSumAggregate.md new file mode 100644 index 000000000..e2f467d2a --- /dev/null +++ b/docs/reference/api/AggregationsSumAggregate.md @@ -0,0 +1,4 @@ +## Interface `AggregationsSumAggregate` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/AggregationsSumAggregation.md b/docs/reference/api/AggregationsSumAggregation.md new file mode 100644 index 000000000..8d05bc452 --- /dev/null +++ b/docs/reference/api/AggregationsSumAggregation.md @@ -0,0 +1,4 @@ +## Interface `AggregationsSumAggregation` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/AggregationsSumBucketAggregation.md b/docs/reference/api/AggregationsSumBucketAggregation.md new file mode 100644 index 000000000..6d744b20e --- /dev/null +++ b/docs/reference/api/AggregationsSumBucketAggregation.md @@ -0,0 +1,4 @@ +## Interface `AggregationsSumBucketAggregation` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/AggregationsTDigest.md b/docs/reference/api/AggregationsTDigest.md new file mode 100644 index 000000000..387a2ff69 --- /dev/null +++ b/docs/reference/api/AggregationsTDigest.md @@ -0,0 +1,5 @@ +## Interface `AggregationsTDigest` + +| Name | Type | Description | +| - | - | - | +| `compression` | [integer](./integer.md) | Limits the maximum number of nodes used by the underlying TDigest algorithm to `20 * compression`, enabling control of memory usage and approximation error. | diff --git a/docs/reference/api/AggregationsTDigestPercentileRanksAggregate.md b/docs/reference/api/AggregationsTDigestPercentileRanksAggregate.md new file mode 100644 index 000000000..a8bd60bfb --- /dev/null +++ b/docs/reference/api/AggregationsTDigestPercentileRanksAggregate.md @@ -0,0 +1,4 @@ +## Interface `AggregationsTDigestPercentileRanksAggregate` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/AggregationsTDigestPercentilesAggregate.md b/docs/reference/api/AggregationsTDigestPercentilesAggregate.md new file mode 100644 index 000000000..403edd265 --- /dev/null +++ b/docs/reference/api/AggregationsTDigestPercentilesAggregate.md @@ -0,0 +1,4 @@ +## Interface `AggregationsTDigestPercentilesAggregate` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/AggregationsTTestAggregate.md b/docs/reference/api/AggregationsTTestAggregate.md new file mode 100644 index 000000000..e3405eea0 --- /dev/null +++ b/docs/reference/api/AggregationsTTestAggregate.md @@ -0,0 +1,6 @@ +## Interface `AggregationsTTestAggregate` + +| Name | Type | Description | +| - | - | - | +| `value_as_string` | string |   | +| `value` | [double](./double.md) | null |   | diff --git a/docs/reference/api/AggregationsTTestAggregation.md b/docs/reference/api/AggregationsTTestAggregation.md new file mode 100644 index 000000000..480b2432d --- /dev/null +++ b/docs/reference/api/AggregationsTTestAggregation.md @@ -0,0 +1,7 @@ +## Interface `AggregationsTTestAggregation` + +| Name | Type | Description | +| - | - | - | +| `a` | [AggregationsTestPopulation](./AggregationsTestPopulation.md) | Test population A. | +| `b` | [AggregationsTestPopulation](./AggregationsTestPopulation.md) | Test population B. | +| `type` | [AggregationsTTestType](./AggregationsTTestType.md) | The type of test. | diff --git a/docs/reference/api/AggregationsTTestType.md b/docs/reference/api/AggregationsTTestType.md new file mode 100644 index 000000000..416c82a29 --- /dev/null +++ b/docs/reference/api/AggregationsTTestType.md @@ -0,0 +1,4 @@ +## `AggregationsTTestType` +::: +type AggregationsTTestType = 'paired' | 'homoscedastic' | 'heteroscedastic'; +::: diff --git a/docs/reference/api/AggregationsTermsAggregateBase.md b/docs/reference/api/AggregationsTermsAggregateBase.md new file mode 100644 index 000000000..7554576d1 --- /dev/null +++ b/docs/reference/api/AggregationsTermsAggregateBase.md @@ -0,0 +1,6 @@ +## Interface `AggregationsTermsAggregateBase` + +| Name | Type | Description | +| - | - | - | +| `doc_count_error_upper_bound` | [long](./long.md) |   | +| `sum_other_doc_count` | [long](./long.md) |   | diff --git a/docs/reference/api/AggregationsTermsAggregation.md b/docs/reference/api/AggregationsTermsAggregation.md new file mode 100644 index 000000000..64befaff6 --- /dev/null +++ b/docs/reference/api/AggregationsTermsAggregation.md @@ -0,0 +1,21 @@ +## Interface `AggregationsTermsAggregation` + +| Name | Type | Description | +| - | - | - | +| `collect_mode` | [AggregationsTermsAggregationCollectMode](./AggregationsTermsAggregationCollectMode.md) | Determines how child aggregations should be calculated: breadth-first or depth-first. | +| `exclude` | [AggregationsTermsExclude](./AggregationsTermsExclude.md) | Values to exclude. Accepts regular expressions and partitions. | +| `execution_hint` | [AggregationsTermsAggregationExecutionHint](./AggregationsTermsAggregationExecutionHint.md) | Determines whether the aggregation will use field values directly or global ordinals. | +| `field` | [Field](./Field.md) | The field from which to return terms. | +| `format` | string |   | +| `include` | [AggregationsTermsInclude](./AggregationsTermsInclude.md) | Values to include. Accepts regular expressions and partitions. | +| `min_doc_count` | [integer](./integer.md) | Only return values that are found in more than `min_doc_count` hits. | +| `missing_bucket` | boolean |   | +| `missing_order` | [AggregationsMissingOrder](./AggregationsMissingOrder.md) |   | +| `missing` | [AggregationsMissing](./AggregationsMissing.md) | The value to apply to documents that do not have a value. By default, documents without a value are ignored. | +| `order` | [AggregationsAggregateOrder](./AggregationsAggregateOrder.md) | Specifies the sort order of the buckets. Defaults to sorting by descending document count. | +| `script` | [Script](./Script.md) | [ScriptSource](./ScriptSource.md) |   | +| `shard_min_doc_count` | [long](./long.md) | Regulates the certainty a shard has if the term should actually be added to the candidate list or not with respect to the `min_doc_count`. Terms will only be considered if their local shard frequency within the set is higher than the `shard_min_doc_count`. | +| `shard_size` | [integer](./integer.md) | The number of candidate terms produced by each shard. By default, `shard_size` will be automatically estimated based on the number of shards and the `size` parameter. | +| `show_term_doc_count_error` | boolean | Set to `true` to return the `doc_count_error_upper_bound`, which is an upper bound to the error on the `doc_count` returned by each shard. | +| `size` | [integer](./integer.md) | The number of buckets returned out of the overall terms list. | +| `value_type` | string | Coerced unmapped fields into the specified type. | diff --git a/docs/reference/api/AggregationsTermsAggregationCollectMode.md b/docs/reference/api/AggregationsTermsAggregationCollectMode.md new file mode 100644 index 000000000..d1fb8c5b3 --- /dev/null +++ b/docs/reference/api/AggregationsTermsAggregationCollectMode.md @@ -0,0 +1,4 @@ +## `AggregationsTermsAggregationCollectMode` +::: +type AggregationsTermsAggregationCollectMode = 'depth_first' | 'breadth_first'; +::: diff --git a/docs/reference/api/AggregationsTermsAggregationExecutionHint.md b/docs/reference/api/AggregationsTermsAggregationExecutionHint.md new file mode 100644 index 000000000..b6b010c3d --- /dev/null +++ b/docs/reference/api/AggregationsTermsAggregationExecutionHint.md @@ -0,0 +1,4 @@ +## `AggregationsTermsAggregationExecutionHint` +::: +type AggregationsTermsAggregationExecutionHint = 'map' | 'global_ordinals' | 'global_ordinals_hash' | 'global_ordinals_low_cardinality'; +::: diff --git a/docs/reference/api/AggregationsTermsBucketBase.md b/docs/reference/api/AggregationsTermsBucketBase.md new file mode 100644 index 000000000..05e0621bb --- /dev/null +++ b/docs/reference/api/AggregationsTermsBucketBase.md @@ -0,0 +1,5 @@ +## Interface `AggregationsTermsBucketBase` + +| Name | Type | Description | +| - | - | - | +| `doc_count_error_upper_bound` | [long](./long.md) |   | diff --git a/docs/reference/api/AggregationsTermsExclude.md b/docs/reference/api/AggregationsTermsExclude.md new file mode 100644 index 000000000..b66c3b563 --- /dev/null +++ b/docs/reference/api/AggregationsTermsExclude.md @@ -0,0 +1,4 @@ +## `AggregationsTermsExclude` +::: +type AggregationsTermsExclude = string | string[]; +::: diff --git a/docs/reference/api/AggregationsTermsInclude.md b/docs/reference/api/AggregationsTermsInclude.md new file mode 100644 index 000000000..487aafe49 --- /dev/null +++ b/docs/reference/api/AggregationsTermsInclude.md @@ -0,0 +1,4 @@ +## `AggregationsTermsInclude` +::: +type AggregationsTermsInclude = string | string[] | [AggregationsTermsPartition](./AggregationsTermsPartition.md); +::: diff --git a/docs/reference/api/AggregationsTermsPartition.md b/docs/reference/api/AggregationsTermsPartition.md new file mode 100644 index 000000000..3522943a6 --- /dev/null +++ b/docs/reference/api/AggregationsTermsPartition.md @@ -0,0 +1,6 @@ +## Interface `AggregationsTermsPartition` + +| Name | Type | Description | +| - | - | - | +| `num_partitions` | [long](./long.md) | The number of partitions. | +| `partition` | [long](./long.md) | The partition number for this request. | diff --git a/docs/reference/api/AggregationsTestPopulation.md b/docs/reference/api/AggregationsTestPopulation.md new file mode 100644 index 000000000..1b5c6e3fc --- /dev/null +++ b/docs/reference/api/AggregationsTestPopulation.md @@ -0,0 +1,7 @@ +## Interface `AggregationsTestPopulation` + +| Name | Type | Description | +| - | - | - | +| `field` | [Field](./Field.md) | The field to aggregate. | +| `filter` | [QueryDslQueryContainer](./QueryDslQueryContainer.md) | A filter used to define a set of records to run unpaired t-test on. | +| `script` | [Script](./Script.md) | [ScriptSource](./ScriptSource.md) |   | diff --git a/docs/reference/api/AggregationsTimeSeriesAggregate.md b/docs/reference/api/AggregationsTimeSeriesAggregate.md new file mode 100644 index 000000000..00df653d3 --- /dev/null +++ b/docs/reference/api/AggregationsTimeSeriesAggregate.md @@ -0,0 +1,4 @@ +## Interface `AggregationsTimeSeriesAggregate` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/AggregationsTimeSeriesAggregation.md b/docs/reference/api/AggregationsTimeSeriesAggregation.md new file mode 100644 index 000000000..c3b98e4f0 --- /dev/null +++ b/docs/reference/api/AggregationsTimeSeriesAggregation.md @@ -0,0 +1,6 @@ +## Interface `AggregationsTimeSeriesAggregation` + +| Name | Type | Description | +| - | - | - | +| `keyed` | boolean | Set to `true` to associate a unique string key with each bucket and returns the ranges as a hash rather than an array. | +| `size` | [integer](./integer.md) | The maximum number of results to return. | diff --git a/docs/reference/api/AggregationsTimeSeriesBucket.md b/docs/reference/api/AggregationsTimeSeriesBucket.md new file mode 100644 index 000000000..05e2b167e --- /dev/null +++ b/docs/reference/api/AggregationsTimeSeriesBucket.md @@ -0,0 +1,4 @@ +## `AggregationsTimeSeriesBucket` +::: +type AggregationsTimeSeriesBucket = [AggregationsTimeSeriesBucketKeys](./AggregationsTimeSeriesBucketKeys.md) & { [property: string]: [AggregationsAggregate](./AggregationsAggregate.md) | Record<[Field](./Field.md), [FieldValue](./FieldValue.md)> | [long](./long.md);}; +::: diff --git a/docs/reference/api/AggregationsTimeSeriesBucketKeys.md b/docs/reference/api/AggregationsTimeSeriesBucketKeys.md new file mode 100644 index 000000000..267fb5062 --- /dev/null +++ b/docs/reference/api/AggregationsTimeSeriesBucketKeys.md @@ -0,0 +1,5 @@ +## Interface `AggregationsTimeSeriesBucketKeys` + +| Name | Type | Description | +| - | - | - | +| `key` | Record<[Field](./Field.md), [FieldValue](./FieldValue.md)> |   | diff --git a/docs/reference/api/AggregationsTopHitsAggregate.md b/docs/reference/api/AggregationsTopHitsAggregate.md new file mode 100644 index 000000000..9e9e0646a --- /dev/null +++ b/docs/reference/api/AggregationsTopHitsAggregate.md @@ -0,0 +1,5 @@ +## Interface `AggregationsTopHitsAggregate` + +| Name | Type | Description | +| - | - | - | +| `hits` | [SearchHitsMetadata](./SearchHitsMetadata.md) |   | diff --git a/docs/reference/api/AggregationsTopHitsAggregation.md b/docs/reference/api/AggregationsTopHitsAggregation.md new file mode 100644 index 000000000..b84aba351 --- /dev/null +++ b/docs/reference/api/AggregationsTopHitsAggregation.md @@ -0,0 +1,17 @@ +## Interface `AggregationsTopHitsAggregation` + +| Name | Type | Description | +| - | - | - | +| `_source` | [SearchSourceConfig](./SearchSourceConfig.md) | Selects the fields of the source that are returned. | +| `docvalue_fields` | ([QueryDslFieldAndFormat](./QueryDslFieldAndFormat.md) | [Field](./Field.md))[] | Fields for which to return doc values. | +| `explain` | boolean | If `true`, returns detailed information about score computation as part of a hit. | +| `fields` | ([QueryDslFieldAndFormat](./QueryDslFieldAndFormat.md) | [Field](./Field.md))[] | Array of wildcard (*) patterns. The request returns values for field names matching these patterns in the hits.fields property of the response. | +| `from` | [integer](./integer.md) | Starting document offset. | +| `highlight` | [SearchHighlight](./SearchHighlight.md) | Specifies the highlighter to use for retrieving highlighted snippets from one or more fields in the search results. | +| `script_fields` | Record | Returns the result of one or more script evaluations for each hit. | +| `seq_no_primary_term` | boolean | If `true`, returns sequence number and primary term of the last modification of each hit. | +| `size` | [integer](./integer.md) | The maximum number of top matching hits to return per bucket. | +| `sort` | [Sort](./Sort.md) | Sort order of the top matching hits. By default, the hits are sorted by the score of the main query. | +| `stored_fields` | [Fields](./Fields.md) | Returns values for the specified stored fields (fields that use the `store` mapping option). | +| `track_scores` | boolean | If `true`, calculates and returns document scores, even if the scores are not used for sorting. | +| `version` | boolean | If `true`, returns document version as part of a hit. | diff --git a/docs/reference/api/AggregationsTopMetrics.md b/docs/reference/api/AggregationsTopMetrics.md new file mode 100644 index 000000000..7b2edfd60 --- /dev/null +++ b/docs/reference/api/AggregationsTopMetrics.md @@ -0,0 +1,6 @@ +## Interface `AggregationsTopMetrics` + +| Name | Type | Description | +| - | - | - | +| `metrics` | Record |   | +| `sort` | ([FieldValue](./FieldValue.md) | null)[] |   | diff --git a/docs/reference/api/AggregationsTopMetricsAggregate.md b/docs/reference/api/AggregationsTopMetricsAggregate.md new file mode 100644 index 000000000..01f0c51e6 --- /dev/null +++ b/docs/reference/api/AggregationsTopMetricsAggregate.md @@ -0,0 +1,5 @@ +## Interface `AggregationsTopMetricsAggregate` + +| Name | Type | Description | +| - | - | - | +| `top` | [AggregationsTopMetrics](./AggregationsTopMetrics.md)[] |   | diff --git a/docs/reference/api/AggregationsTopMetricsAggregation.md b/docs/reference/api/AggregationsTopMetricsAggregation.md new file mode 100644 index 000000000..f1588f49c --- /dev/null +++ b/docs/reference/api/AggregationsTopMetricsAggregation.md @@ -0,0 +1,7 @@ +## Interface `AggregationsTopMetricsAggregation` + +| Name | Type | Description | +| - | - | - | +| `metrics` | [AggregationsTopMetricsValue](./AggregationsTopMetricsValue.md) | [AggregationsTopMetricsValue](./AggregationsTopMetricsValue.md)[] | The fields of the top document to return. | +| `size` | [integer](./integer.md) | The number of top documents from which to return metrics. | +| `sort` | [Sort](./Sort.md) | The sort order of the documents. | diff --git a/docs/reference/api/AggregationsTopMetricsValue.md b/docs/reference/api/AggregationsTopMetricsValue.md new file mode 100644 index 000000000..45144600a --- /dev/null +++ b/docs/reference/api/AggregationsTopMetricsValue.md @@ -0,0 +1,5 @@ +## Interface `AggregationsTopMetricsValue` + +| Name | Type | Description | +| - | - | - | +| `field` | [Field](./Field.md) | A field to return as a metric. | diff --git a/docs/reference/api/AggregationsUnmappedRareTermsAggregate.md b/docs/reference/api/AggregationsUnmappedRareTermsAggregate.md new file mode 100644 index 000000000..db9cdfd5d --- /dev/null +++ b/docs/reference/api/AggregationsUnmappedRareTermsAggregate.md @@ -0,0 +1,4 @@ +## Interface `AggregationsUnmappedRareTermsAggregate` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/AggregationsUnmappedSamplerAggregate.md b/docs/reference/api/AggregationsUnmappedSamplerAggregate.md new file mode 100644 index 000000000..63492b647 --- /dev/null +++ b/docs/reference/api/AggregationsUnmappedSamplerAggregate.md @@ -0,0 +1,4 @@ +## `AggregationsUnmappedSamplerAggregate` +::: +type AggregationsUnmappedSamplerAggregate = [AggregationsUnmappedSamplerAggregateKeys](./AggregationsUnmappedSamplerAggregateKeys.md) & { [property: string]: [AggregationsAggregate](./AggregationsAggregate.md) | [long](./long.md) | [Metadata](./Metadata.md);}; +::: diff --git a/docs/reference/api/AggregationsUnmappedSamplerAggregateKeys.md b/docs/reference/api/AggregationsUnmappedSamplerAggregateKeys.md new file mode 100644 index 000000000..44485597a --- /dev/null +++ b/docs/reference/api/AggregationsUnmappedSamplerAggregateKeys.md @@ -0,0 +1,4 @@ +## Interface `AggregationsUnmappedSamplerAggregateKeys` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/AggregationsUnmappedSignificantTermsAggregate.md b/docs/reference/api/AggregationsUnmappedSignificantTermsAggregate.md new file mode 100644 index 000000000..c3745b65b --- /dev/null +++ b/docs/reference/api/AggregationsUnmappedSignificantTermsAggregate.md @@ -0,0 +1,4 @@ +## Interface `AggregationsUnmappedSignificantTermsAggregate` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/AggregationsUnmappedTermsAggregate.md b/docs/reference/api/AggregationsUnmappedTermsAggregate.md new file mode 100644 index 000000000..a3a35f0f2 --- /dev/null +++ b/docs/reference/api/AggregationsUnmappedTermsAggregate.md @@ -0,0 +1,4 @@ +## Interface `AggregationsUnmappedTermsAggregate` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/AggregationsValueCountAggregate.md b/docs/reference/api/AggregationsValueCountAggregate.md new file mode 100644 index 000000000..da6f8ef57 --- /dev/null +++ b/docs/reference/api/AggregationsValueCountAggregate.md @@ -0,0 +1,4 @@ +## Interface `AggregationsValueCountAggregate` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/AggregationsValueCountAggregation.md b/docs/reference/api/AggregationsValueCountAggregation.md new file mode 100644 index 000000000..7c41921db --- /dev/null +++ b/docs/reference/api/AggregationsValueCountAggregation.md @@ -0,0 +1,4 @@ +## Interface `AggregationsValueCountAggregation` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/AggregationsValueType.md b/docs/reference/api/AggregationsValueType.md new file mode 100644 index 000000000..1bec330ad --- /dev/null +++ b/docs/reference/api/AggregationsValueType.md @@ -0,0 +1,4 @@ +## `AggregationsValueType` +::: +type AggregationsValueType = 'string' | 'long' | 'double' | 'number' | 'date' | 'date_nanos' | 'ip' | 'numeric' | 'geo_point' | 'boolean'; +::: diff --git a/docs/reference/api/AggregationsVariableWidthHistogramAggregate.md b/docs/reference/api/AggregationsVariableWidthHistogramAggregate.md new file mode 100644 index 000000000..2399c8e4f --- /dev/null +++ b/docs/reference/api/AggregationsVariableWidthHistogramAggregate.md @@ -0,0 +1,4 @@ +## Interface `AggregationsVariableWidthHistogramAggregate` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/AggregationsVariableWidthHistogramAggregation.md b/docs/reference/api/AggregationsVariableWidthHistogramAggregation.md new file mode 100644 index 000000000..8bc802341 --- /dev/null +++ b/docs/reference/api/AggregationsVariableWidthHistogramAggregation.md @@ -0,0 +1,9 @@ +## Interface `AggregationsVariableWidthHistogramAggregation` + +| Name | Type | Description | +| - | - | - | +| `buckets` | [integer](./integer.md) | The target number of buckets. | +| `field` | [Field](./Field.md) | The name of the field. | +| `initial_buffer` | [integer](./integer.md) | Specifies the number of individual documents that will be stored in memory on a shard before the initial bucketing algorithm is run. Defaults to `min(10 * shard_size, 50000)`. | +| `script` | [Script](./Script.md) | [ScriptSource](./ScriptSource.md) |   | +| `shard_size` | [integer](./integer.md) | The number of buckets that the coordinating node will request from each shard. Defaults to `buckets * 50`. | diff --git a/docs/reference/api/AggregationsVariableWidthHistogramBucket.md b/docs/reference/api/AggregationsVariableWidthHistogramBucket.md new file mode 100644 index 000000000..f4a2531bf --- /dev/null +++ b/docs/reference/api/AggregationsVariableWidthHistogramBucket.md @@ -0,0 +1,4 @@ +## `AggregationsVariableWidthHistogramBucket` +::: +type AggregationsVariableWidthHistogramBucket = [AggregationsVariableWidthHistogramBucketKeys](./AggregationsVariableWidthHistogramBucketKeys.md) & { [property: string]: [AggregationsAggregate](./AggregationsAggregate.md) | [double](./double.md) | string | [long](./long.md);}; +::: diff --git a/docs/reference/api/AggregationsVariableWidthHistogramBucketKeys.md b/docs/reference/api/AggregationsVariableWidthHistogramBucketKeys.md new file mode 100644 index 000000000..bc5686aad --- /dev/null +++ b/docs/reference/api/AggregationsVariableWidthHistogramBucketKeys.md @@ -0,0 +1,10 @@ +## Interface `AggregationsVariableWidthHistogramBucketKeys` + +| Name | Type | Description | +| - | - | - | +| `key_as_string` | string |   | +| `key` | [double](./double.md) |   | +| `max_as_string` | string |   | +| `max` | [double](./double.md) |   | +| `min_as_string` | string |   | +| `min` | [double](./double.md) |   | diff --git a/docs/reference/api/AggregationsWeightedAverageAggregation.md b/docs/reference/api/AggregationsWeightedAverageAggregation.md new file mode 100644 index 000000000..454789266 --- /dev/null +++ b/docs/reference/api/AggregationsWeightedAverageAggregation.md @@ -0,0 +1,8 @@ +## Interface `AggregationsWeightedAverageAggregation` + +| Name | Type | Description | +| - | - | - | +| `format` | string | A numeric response formatter. | +| `value_type` | [AggregationsValueType](./AggregationsValueType.md) |   | +| `value` | [AggregationsWeightedAverageValue](./AggregationsWeightedAverageValue.md) | Configuration for the field that provides the values. | +| `weight` | [AggregationsWeightedAverageValue](./AggregationsWeightedAverageValue.md) | Configuration for the field or script that provides the weights. | diff --git a/docs/reference/api/AggregationsWeightedAverageValue.md b/docs/reference/api/AggregationsWeightedAverageValue.md new file mode 100644 index 000000000..2265fa4df --- /dev/null +++ b/docs/reference/api/AggregationsWeightedAverageValue.md @@ -0,0 +1,7 @@ +## Interface `AggregationsWeightedAverageValue` + +| Name | Type | Description | +| - | - | - | +| `field` | [Field](./Field.md) | The field from which to extract the values or weights. | +| `missing` | [double](./double.md) | A value or weight to use if the field is missing. | +| `script` | [Script](./Script.md) | [ScriptSource](./ScriptSource.md) |   | diff --git a/docs/reference/api/AggregationsWeightedAvgAggregate.md b/docs/reference/api/AggregationsWeightedAvgAggregate.md new file mode 100644 index 000000000..0090f2b64 --- /dev/null +++ b/docs/reference/api/AggregationsWeightedAvgAggregate.md @@ -0,0 +1,4 @@ +## Interface `AggregationsWeightedAvgAggregate` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/AnalysisAnalyzer.md b/docs/reference/api/AnalysisAnalyzer.md new file mode 100644 index 000000000..44cfe1d35 --- /dev/null +++ b/docs/reference/api/AnalysisAnalyzer.md @@ -0,0 +1,4 @@ +## `AnalysisAnalyzer` +::: +type AnalysisAnalyzer = [AnalysisCustomAnalyzer](./AnalysisCustomAnalyzer.md) | [AnalysisFingerprintAnalyzer](./AnalysisFingerprintAnalyzer.md) | [AnalysisKeywordAnalyzer](./AnalysisKeywordAnalyzer.md) | [AnalysisNoriAnalyzer](./AnalysisNoriAnalyzer.md) | [AnalysisPatternAnalyzer](./AnalysisPatternAnalyzer.md) | [AnalysisSimpleAnalyzer](./AnalysisSimpleAnalyzer.md) | [AnalysisStandardAnalyzer](./AnalysisStandardAnalyzer.md) | [AnalysisStopAnalyzer](./AnalysisStopAnalyzer.md) | [AnalysisWhitespaceAnalyzer](./AnalysisWhitespaceAnalyzer.md) | [AnalysisIcuAnalyzer](./AnalysisIcuAnalyzer.md) | [AnalysisKuromojiAnalyzer](./AnalysisKuromojiAnalyzer.md) | [AnalysisSnowballAnalyzer](./AnalysisSnowballAnalyzer.md) | [AnalysisArabicAnalyzer](./AnalysisArabicAnalyzer.md) | [AnalysisArmenianAnalyzer](./AnalysisArmenianAnalyzer.md) | [AnalysisBasqueAnalyzer](./AnalysisBasqueAnalyzer.md) | [AnalysisBengaliAnalyzer](./AnalysisBengaliAnalyzer.md) | [AnalysisBrazilianAnalyzer](./AnalysisBrazilianAnalyzer.md) | [AnalysisBulgarianAnalyzer](./AnalysisBulgarianAnalyzer.md) | [AnalysisCatalanAnalyzer](./AnalysisCatalanAnalyzer.md) | [AnalysisChineseAnalyzer](./AnalysisChineseAnalyzer.md) | [AnalysisCjkAnalyzer](./AnalysisCjkAnalyzer.md) | [AnalysisCzechAnalyzer](./AnalysisCzechAnalyzer.md) | [AnalysisDanishAnalyzer](./AnalysisDanishAnalyzer.md) | [AnalysisDutchAnalyzer](./AnalysisDutchAnalyzer.md) | [AnalysisEnglishAnalyzer](./AnalysisEnglishAnalyzer.md) | [AnalysisEstonianAnalyzer](./AnalysisEstonianAnalyzer.md) | [AnalysisFinnishAnalyzer](./AnalysisFinnishAnalyzer.md) | [AnalysisFrenchAnalyzer](./AnalysisFrenchAnalyzer.md) | [AnalysisGalicianAnalyzer](./AnalysisGalicianAnalyzer.md) | [AnalysisGermanAnalyzer](./AnalysisGermanAnalyzer.md) | [AnalysisGreekAnalyzer](./AnalysisGreekAnalyzer.md) | [AnalysisHindiAnalyzer](./AnalysisHindiAnalyzer.md) | [AnalysisHungarianAnalyzer](./AnalysisHungarianAnalyzer.md) | [AnalysisIndonesianAnalyzer](./AnalysisIndonesianAnalyzer.md) | [AnalysisIrishAnalyzer](./AnalysisIrishAnalyzer.md) | [AnalysisItalianAnalyzer](./AnalysisItalianAnalyzer.md) | [AnalysisLatvianAnalyzer](./AnalysisLatvianAnalyzer.md) | [AnalysisLithuanianAnalyzer](./AnalysisLithuanianAnalyzer.md) | [AnalysisNorwegianAnalyzer](./AnalysisNorwegianAnalyzer.md) | [AnalysisPersianAnalyzer](./AnalysisPersianAnalyzer.md) | [AnalysisPortugueseAnalyzer](./AnalysisPortugueseAnalyzer.md) | [AnalysisRomanianAnalyzer](./AnalysisRomanianAnalyzer.md) | [AnalysisRussianAnalyzer](./AnalysisRussianAnalyzer.md) | [AnalysisSerbianAnalyzer](./AnalysisSerbianAnalyzer.md) | [AnalysisSoraniAnalyzer](./AnalysisSoraniAnalyzer.md) | [AnalysisSpanishAnalyzer](./AnalysisSpanishAnalyzer.md) | [AnalysisSwedishAnalyzer](./AnalysisSwedishAnalyzer.md) | [AnalysisTurkishAnalyzer](./AnalysisTurkishAnalyzer.md) | [AnalysisThaiAnalyzer](./AnalysisThaiAnalyzer.md); +::: diff --git a/docs/reference/api/AnalysisApostropheTokenFilter.md b/docs/reference/api/AnalysisApostropheTokenFilter.md new file mode 100644 index 000000000..136bb00c4 --- /dev/null +++ b/docs/reference/api/AnalysisApostropheTokenFilter.md @@ -0,0 +1,5 @@ +## Interface `AnalysisApostropheTokenFilter` + +| Name | Type | Description | +| - | - | - | +| `type` | 'apostrophe' |   | diff --git a/docs/reference/api/AnalysisArabicAnalyzer.md b/docs/reference/api/AnalysisArabicAnalyzer.md new file mode 100644 index 000000000..4e5c78751 --- /dev/null +++ b/docs/reference/api/AnalysisArabicAnalyzer.md @@ -0,0 +1,8 @@ +## Interface `AnalysisArabicAnalyzer` + +| Name | Type | Description | +| - | - | - | +| `stem_exclusion` | string[] |   | +| `stopwords_path` | string |   | +| `stopwords` | [AnalysisStopWords](./AnalysisStopWords.md) |   | +| `type` | 'arabic' |   | diff --git a/docs/reference/api/AnalysisArabicNormalizationTokenFilter.md b/docs/reference/api/AnalysisArabicNormalizationTokenFilter.md new file mode 100644 index 000000000..bde929a63 --- /dev/null +++ b/docs/reference/api/AnalysisArabicNormalizationTokenFilter.md @@ -0,0 +1,5 @@ +## Interface `AnalysisArabicNormalizationTokenFilter` + +| Name | Type | Description | +| - | - | - | +| `type` | 'arabic_normalization' |   | diff --git a/docs/reference/api/AnalysisArmenianAnalyzer.md b/docs/reference/api/AnalysisArmenianAnalyzer.md new file mode 100644 index 000000000..f02e7e5f6 --- /dev/null +++ b/docs/reference/api/AnalysisArmenianAnalyzer.md @@ -0,0 +1,8 @@ +## Interface `AnalysisArmenianAnalyzer` + +| Name | Type | Description | +| - | - | - | +| `stem_exclusion` | string[] |   | +| `stopwords_path` | string |   | +| `stopwords` | [AnalysisStopWords](./AnalysisStopWords.md) |   | +| `type` | 'armenian' |   | diff --git a/docs/reference/api/AnalysisAsciiFoldingTokenFilter.md b/docs/reference/api/AnalysisAsciiFoldingTokenFilter.md new file mode 100644 index 000000000..87c1c7719 --- /dev/null +++ b/docs/reference/api/AnalysisAsciiFoldingTokenFilter.md @@ -0,0 +1,6 @@ +## Interface `AnalysisAsciiFoldingTokenFilter` + +| Name | Type | Description | +| - | - | - | +| `preserve_original` | [SpecUtilsStringified](./SpecUtilsStringified.md) | If `true`, emit both original tokens and folded tokens. Defaults to `false`. | +| `type` | 'asciifolding' |   | diff --git a/docs/reference/api/AnalysisBasqueAnalyzer.md b/docs/reference/api/AnalysisBasqueAnalyzer.md new file mode 100644 index 000000000..6b03d2aa6 --- /dev/null +++ b/docs/reference/api/AnalysisBasqueAnalyzer.md @@ -0,0 +1,8 @@ +## Interface `AnalysisBasqueAnalyzer` + +| Name | Type | Description | +| - | - | - | +| `stem_exclusion` | string[] |   | +| `stopwords_path` | string |   | +| `stopwords` | [AnalysisStopWords](./AnalysisStopWords.md) |   | +| `type` | 'basque' |   | diff --git a/docs/reference/api/AnalysisBengaliAnalyzer.md b/docs/reference/api/AnalysisBengaliAnalyzer.md new file mode 100644 index 000000000..cc0922ba4 --- /dev/null +++ b/docs/reference/api/AnalysisBengaliAnalyzer.md @@ -0,0 +1,8 @@ +## Interface `AnalysisBengaliAnalyzer` + +| Name | Type | Description | +| - | - | - | +| `stem_exclusion` | string[] |   | +| `stopwords_path` | string |   | +| `stopwords` | [AnalysisStopWords](./AnalysisStopWords.md) |   | +| `type` | 'bengali' |   | diff --git a/docs/reference/api/AnalysisBrazilianAnalyzer.md b/docs/reference/api/AnalysisBrazilianAnalyzer.md new file mode 100644 index 000000000..a58c347de --- /dev/null +++ b/docs/reference/api/AnalysisBrazilianAnalyzer.md @@ -0,0 +1,7 @@ +## Interface `AnalysisBrazilianAnalyzer` + +| Name | Type | Description | +| - | - | - | +| `stopwords_path` | string |   | +| `stopwords` | [AnalysisStopWords](./AnalysisStopWords.md) |   | +| `type` | 'brazilian' |   | diff --git a/docs/reference/api/AnalysisBulgarianAnalyzer.md b/docs/reference/api/AnalysisBulgarianAnalyzer.md new file mode 100644 index 000000000..fb1e1db38 --- /dev/null +++ b/docs/reference/api/AnalysisBulgarianAnalyzer.md @@ -0,0 +1,8 @@ +## Interface `AnalysisBulgarianAnalyzer` + +| Name | Type | Description | +| - | - | - | +| `stem_exclusion` | string[] |   | +| `stopwords_path` | string |   | +| `stopwords` | [AnalysisStopWords](./AnalysisStopWords.md) |   | +| `type` | 'bulgarian' |   | diff --git a/docs/reference/api/AnalysisCatalanAnalyzer.md b/docs/reference/api/AnalysisCatalanAnalyzer.md new file mode 100644 index 000000000..ccb1dfe84 --- /dev/null +++ b/docs/reference/api/AnalysisCatalanAnalyzer.md @@ -0,0 +1,8 @@ +## Interface `AnalysisCatalanAnalyzer` + +| Name | Type | Description | +| - | - | - | +| `stem_exclusion` | string[] |   | +| `stopwords_path` | string |   | +| `stopwords` | [AnalysisStopWords](./AnalysisStopWords.md) |   | +| `type` | 'catalan' |   | diff --git a/docs/reference/api/AnalysisCharFilter.md b/docs/reference/api/AnalysisCharFilter.md new file mode 100644 index 000000000..93ebeaf90 --- /dev/null +++ b/docs/reference/api/AnalysisCharFilter.md @@ -0,0 +1,4 @@ +## `AnalysisCharFilter` +::: +type AnalysisCharFilter = string | [AnalysisCharFilterDefinition](./AnalysisCharFilterDefinition.md); +::: diff --git a/docs/reference/api/AnalysisCharFilterBase.md b/docs/reference/api/AnalysisCharFilterBase.md new file mode 100644 index 000000000..0652f823b --- /dev/null +++ b/docs/reference/api/AnalysisCharFilterBase.md @@ -0,0 +1,5 @@ +## Interface `AnalysisCharFilterBase` + +| Name | Type | Description | +| - | - | - | +| `version` | [VersionString](./VersionString.md) |   | diff --git a/docs/reference/api/AnalysisCharFilterDefinition.md b/docs/reference/api/AnalysisCharFilterDefinition.md new file mode 100644 index 000000000..744ec7c49 --- /dev/null +++ b/docs/reference/api/AnalysisCharFilterDefinition.md @@ -0,0 +1,4 @@ +## `AnalysisCharFilterDefinition` +::: +type AnalysisCharFilterDefinition = [AnalysisHtmlStripCharFilter](./AnalysisHtmlStripCharFilter.md) | [AnalysisMappingCharFilter](./AnalysisMappingCharFilter.md) | [AnalysisPatternReplaceCharFilter](./AnalysisPatternReplaceCharFilter.md) | [AnalysisIcuNormalizationCharFilter](./AnalysisIcuNormalizationCharFilter.md) | [AnalysisKuromojiIterationMarkCharFilter](./AnalysisKuromojiIterationMarkCharFilter.md); +::: diff --git a/docs/reference/api/AnalysisCharGroupTokenizer.md b/docs/reference/api/AnalysisCharGroupTokenizer.md new file mode 100644 index 000000000..e81d1eb02 --- /dev/null +++ b/docs/reference/api/AnalysisCharGroupTokenizer.md @@ -0,0 +1,7 @@ +## Interface `AnalysisCharGroupTokenizer` + +| Name | Type | Description | +| - | - | - | +| `max_token_length` | [integer](./integer.md) |   | +| `tokenize_on_chars` | string[] |   | +| `type` | 'char_group' |   | diff --git a/docs/reference/api/AnalysisChineseAnalyzer.md b/docs/reference/api/AnalysisChineseAnalyzer.md new file mode 100644 index 000000000..dee52e6f0 --- /dev/null +++ b/docs/reference/api/AnalysisChineseAnalyzer.md @@ -0,0 +1,7 @@ +## Interface `AnalysisChineseAnalyzer` + +| Name | Type | Description | +| - | - | - | +| `stopwords_path` | string |   | +| `stopwords` | [AnalysisStopWords](./AnalysisStopWords.md) |   | +| `type` | 'chinese' |   | diff --git a/docs/reference/api/AnalysisCjkAnalyzer.md b/docs/reference/api/AnalysisCjkAnalyzer.md new file mode 100644 index 000000000..7399afb69 --- /dev/null +++ b/docs/reference/api/AnalysisCjkAnalyzer.md @@ -0,0 +1,7 @@ +## Interface `AnalysisCjkAnalyzer` + +| Name | Type | Description | +| - | - | - | +| `stopwords_path` | string |   | +| `stopwords` | [AnalysisStopWords](./AnalysisStopWords.md) |   | +| `type` | 'cjk' |   | diff --git a/docs/reference/api/AnalysisCjkBigramIgnoredScript.md b/docs/reference/api/AnalysisCjkBigramIgnoredScript.md new file mode 100644 index 000000000..89238454e --- /dev/null +++ b/docs/reference/api/AnalysisCjkBigramIgnoredScript.md @@ -0,0 +1,4 @@ +## `AnalysisCjkBigramIgnoredScript` +::: +type AnalysisCjkBigramIgnoredScript = 'han' | 'hangul' | 'hiragana' | 'katakana'; +::: diff --git a/docs/reference/api/AnalysisCjkBigramTokenFilter.md b/docs/reference/api/AnalysisCjkBigramTokenFilter.md new file mode 100644 index 000000000..51aba3a1f --- /dev/null +++ b/docs/reference/api/AnalysisCjkBigramTokenFilter.md @@ -0,0 +1,7 @@ +## Interface `AnalysisCjkBigramTokenFilter` + +| Name | Type | Description | +| - | - | - | +| `ignored_scripts` | [AnalysisCjkBigramIgnoredScript](./AnalysisCjkBigramIgnoredScript.md)[] | Array of character scripts for which to disable bigrams. | +| `output_unigrams` | boolean | If `true`, emit tokens in both bigram and unigram form. If `false`, a CJK character is output in unigram form when it has no adjacent characters. Defaults to `false`. | +| `type` | 'cjk_bigram' |   | diff --git a/docs/reference/api/AnalysisCjkWidthTokenFilter.md b/docs/reference/api/AnalysisCjkWidthTokenFilter.md new file mode 100644 index 000000000..fb632ee09 --- /dev/null +++ b/docs/reference/api/AnalysisCjkWidthTokenFilter.md @@ -0,0 +1,5 @@ +## Interface `AnalysisCjkWidthTokenFilter` + +| Name | Type | Description | +| - | - | - | +| `type` | 'cjk_width' |   | diff --git a/docs/reference/api/AnalysisClassicTokenFilter.md b/docs/reference/api/AnalysisClassicTokenFilter.md new file mode 100644 index 000000000..3a23a3750 --- /dev/null +++ b/docs/reference/api/AnalysisClassicTokenFilter.md @@ -0,0 +1,5 @@ +## Interface `AnalysisClassicTokenFilter` + +| Name | Type | Description | +| - | - | - | +| `type` | 'classic' |   | diff --git a/docs/reference/api/AnalysisClassicTokenizer.md b/docs/reference/api/AnalysisClassicTokenizer.md new file mode 100644 index 000000000..ead51f034 --- /dev/null +++ b/docs/reference/api/AnalysisClassicTokenizer.md @@ -0,0 +1,6 @@ +## Interface `AnalysisClassicTokenizer` + +| Name | Type | Description | +| - | - | - | +| `max_token_length` | [integer](./integer.md) |   | +| `type` | 'classic' |   | diff --git a/docs/reference/api/AnalysisCommonGramsTokenFilter.md b/docs/reference/api/AnalysisCommonGramsTokenFilter.md new file mode 100644 index 000000000..553cb2ed4 --- /dev/null +++ b/docs/reference/api/AnalysisCommonGramsTokenFilter.md @@ -0,0 +1,9 @@ +## Interface `AnalysisCommonGramsTokenFilter` + +| Name | Type | Description | +| - | - | - | +| `common_words_path` | string | Path to a file containing a list of tokens. The filter generates bigrams for these tokens. This path must be absolute or relative to the `config` location. The file must be UTF-8 encoded. Each token in the file must be separated by a line break. Either this or the `common_words` parameter is required. | +| `common_words` | string[] | A list of tokens. The filter generates bigrams for these tokens. Either this or the `common_words_path` parameter is required. | +| `ignore_case` | boolean | If `true`, matches for common words matching are case-insensitive. Defaults to `false`. | +| `query_mode` | boolean | If `true`, the filter excludes the following tokens from the output: - Unigrams for common words - Unigrams for terms followed by common words Defaults to `false`. We recommend enabling this parameter for search analyzers. | +| `type` | 'common_grams' |   | diff --git a/docs/reference/api/AnalysisCompoundWordTokenFilterBase.md b/docs/reference/api/AnalysisCompoundWordTokenFilterBase.md new file mode 100644 index 000000000..de8ab629a --- /dev/null +++ b/docs/reference/api/AnalysisCompoundWordTokenFilterBase.md @@ -0,0 +1,10 @@ +## Interface `AnalysisCompoundWordTokenFilterBase` + +| Name | Type | Description | +| - | - | - | +| `max_subword_size` | [integer](./integer.md) | Maximum subword character length. Longer subword tokens are excluded from the output. Defaults to `15`. | +| `min_subword_size` | [integer](./integer.md) | Minimum subword character length. Shorter subword tokens are excluded from the output. Defaults to `2`. | +| `min_word_size` | [integer](./integer.md) | Minimum word character length. Shorter word tokens are excluded from the output. Defaults to `5`. | +| `only_longest_match` | boolean | If `true`, only include the longest matching subword. Defaults to `false`. | +| `word_list_path` | string | Path to a file that contains a list of subwords to find in the token stream. If found, the subword is included in the token output. This path must be absolute or relative to the config location, and the file must be UTF-8 encoded. Each token in the file must be separated by a line break. Either this parameter or `word_list` must be specified. | +| `word_list` | string[] | A list of subwords to look for in the token stream. If found, the subword is included in the token output. Either this parameter or `word_list_path` must be specified. | diff --git a/docs/reference/api/AnalysisConditionTokenFilter.md b/docs/reference/api/AnalysisConditionTokenFilter.md new file mode 100644 index 000000000..2a1c6b6e2 --- /dev/null +++ b/docs/reference/api/AnalysisConditionTokenFilter.md @@ -0,0 +1,7 @@ +## Interface `AnalysisConditionTokenFilter` + +| Name | Type | Description | +| - | - | - | +| `filter` | string[] | Array of token filters. If a token matches the predicate script in the `script` parameter, these filters are applied to the token in the order provided. | +| `script` | [Script](./Script.md) | [ScriptSource](./ScriptSource.md) | Predicate script used to apply token filters. If a token matches this script, the filters in the `filter` parameter are applied to the token. | +| `type` | 'condition' |   | diff --git a/docs/reference/api/AnalysisCustomAnalyzer.md b/docs/reference/api/AnalysisCustomAnalyzer.md new file mode 100644 index 000000000..e00dfdb21 --- /dev/null +++ b/docs/reference/api/AnalysisCustomAnalyzer.md @@ -0,0 +1,10 @@ +## Interface `AnalysisCustomAnalyzer` + +| Name | Type | Description | +| - | - | - | +| `char_filter` | string | string[] |   | +| `filter` | string | string[] |   | +| `position_increment_gap` | [integer](./integer.md) |   | +| `position_offset_gap` | [integer](./integer.md) |   | +| `tokenizer` | string |   | +| `type` | 'custom' |   | diff --git a/docs/reference/api/AnalysisCustomNormalizer.md b/docs/reference/api/AnalysisCustomNormalizer.md new file mode 100644 index 000000000..ee6582a64 --- /dev/null +++ b/docs/reference/api/AnalysisCustomNormalizer.md @@ -0,0 +1,7 @@ +## Interface `AnalysisCustomNormalizer` + +| Name | Type | Description | +| - | - | - | +| `char_filter` | string[] |   | +| `filter` | string[] |   | +| `type` | 'custom' |   | diff --git a/docs/reference/api/AnalysisCzechAnalyzer.md b/docs/reference/api/AnalysisCzechAnalyzer.md new file mode 100644 index 000000000..daf3a569f --- /dev/null +++ b/docs/reference/api/AnalysisCzechAnalyzer.md @@ -0,0 +1,8 @@ +## Interface `AnalysisCzechAnalyzer` + +| Name | Type | Description | +| - | - | - | +| `stem_exclusion` | string[] |   | +| `stopwords_path` | string |   | +| `stopwords` | [AnalysisStopWords](./AnalysisStopWords.md) |   | +| `type` | 'czech' |   | diff --git a/docs/reference/api/AnalysisDanishAnalyzer.md b/docs/reference/api/AnalysisDanishAnalyzer.md new file mode 100644 index 000000000..d3441ed2b --- /dev/null +++ b/docs/reference/api/AnalysisDanishAnalyzer.md @@ -0,0 +1,7 @@ +## Interface `AnalysisDanishAnalyzer` + +| Name | Type | Description | +| - | - | - | +| `stopwords_path` | string |   | +| `stopwords` | [AnalysisStopWords](./AnalysisStopWords.md) |   | +| `type` | 'danish' |   | diff --git a/docs/reference/api/AnalysisDecimalDigitTokenFilter.md b/docs/reference/api/AnalysisDecimalDigitTokenFilter.md new file mode 100644 index 000000000..f320eb325 --- /dev/null +++ b/docs/reference/api/AnalysisDecimalDigitTokenFilter.md @@ -0,0 +1,5 @@ +## Interface `AnalysisDecimalDigitTokenFilter` + +| Name | Type | Description | +| - | - | - | +| `type` | 'decimal_digit' |   | diff --git a/docs/reference/api/AnalysisDelimitedPayloadEncoding.md b/docs/reference/api/AnalysisDelimitedPayloadEncoding.md new file mode 100644 index 000000000..962d44ca3 --- /dev/null +++ b/docs/reference/api/AnalysisDelimitedPayloadEncoding.md @@ -0,0 +1,4 @@ +## `AnalysisDelimitedPayloadEncoding` +::: +type AnalysisDelimitedPayloadEncoding = 'int' | 'float' | 'identity'; +::: diff --git a/docs/reference/api/AnalysisDelimitedPayloadTokenFilter.md b/docs/reference/api/AnalysisDelimitedPayloadTokenFilter.md new file mode 100644 index 000000000..1d9db166e --- /dev/null +++ b/docs/reference/api/AnalysisDelimitedPayloadTokenFilter.md @@ -0,0 +1,7 @@ +## Interface `AnalysisDelimitedPayloadTokenFilter` + +| Name | Type | Description | +| - | - | - | +| `delimiter` | string | Character used to separate tokens from payloads. Defaults to `|`. | +| `encoding` | [AnalysisDelimitedPayloadEncoding](./AnalysisDelimitedPayloadEncoding.md) | Data type for the stored payload. | +| `type` | 'delimited_payload' |   | diff --git a/docs/reference/api/AnalysisDictionaryDecompounderTokenFilter.md b/docs/reference/api/AnalysisDictionaryDecompounderTokenFilter.md new file mode 100644 index 000000000..0d53fa720 --- /dev/null +++ b/docs/reference/api/AnalysisDictionaryDecompounderTokenFilter.md @@ -0,0 +1,5 @@ +## Interface `AnalysisDictionaryDecompounderTokenFilter` + +| Name | Type | Description | +| - | - | - | +| `type` | 'dictionary_decompounder' |   | diff --git a/docs/reference/api/AnalysisDutchAnalyzer.md b/docs/reference/api/AnalysisDutchAnalyzer.md new file mode 100644 index 000000000..8af2e56da --- /dev/null +++ b/docs/reference/api/AnalysisDutchAnalyzer.md @@ -0,0 +1,8 @@ +## Interface `AnalysisDutchAnalyzer` + +| Name | Type | Description | +| - | - | - | +| `stem_exclusion` | string[] |   | +| `stopwords_path` | string |   | +| `stopwords` | [AnalysisStopWords](./AnalysisStopWords.md) |   | +| `type` | 'dutch' |   | diff --git a/docs/reference/api/AnalysisEdgeNGramSide.md b/docs/reference/api/AnalysisEdgeNGramSide.md new file mode 100644 index 000000000..814218f99 --- /dev/null +++ b/docs/reference/api/AnalysisEdgeNGramSide.md @@ -0,0 +1,4 @@ +## `AnalysisEdgeNGramSide` +::: +type AnalysisEdgeNGramSide = 'front' | 'back'; +::: diff --git a/docs/reference/api/AnalysisEdgeNGramTokenFilter.md b/docs/reference/api/AnalysisEdgeNGramTokenFilter.md new file mode 100644 index 000000000..02ce3f671 --- /dev/null +++ b/docs/reference/api/AnalysisEdgeNGramTokenFilter.md @@ -0,0 +1,9 @@ +## Interface `AnalysisEdgeNGramTokenFilter` + +| Name | Type | Description | +| - | - | - | +| `max_gram` | [integer](./integer.md) | Maximum character length of a gram. For custom token filters, defaults to `2`. For the built-in edge_ngram filter, defaults to `1`. | +| `min_gram` | [integer](./integer.md) | Minimum character length of a gram. Defaults to `1`. | +| `preserve_original` | [SpecUtilsStringified](./SpecUtilsStringified.md) | Emits original token when set to `true`. Defaults to `false`. | +| `side` | [AnalysisEdgeNGramSide](./AnalysisEdgeNGramSide.md) | Indicates whether to truncate tokens from the `front` or `back`. Defaults to `front`. | +| `type` | 'edge_ngram' |   | diff --git a/docs/reference/api/AnalysisEdgeNGramTokenizer.md b/docs/reference/api/AnalysisEdgeNGramTokenizer.md new file mode 100644 index 000000000..3598cabd8 --- /dev/null +++ b/docs/reference/api/AnalysisEdgeNGramTokenizer.md @@ -0,0 +1,9 @@ +## Interface `AnalysisEdgeNGramTokenizer` + +| Name | Type | Description | +| - | - | - | +| `custom_token_chars` | string |   | +| `max_gram` | [integer](./integer.md) |   | +| `min_gram` | [integer](./integer.md) |   | +| `token_chars` | [AnalysisTokenChar](./AnalysisTokenChar.md)[] |   | +| `type` | 'edge_ngram' |   | diff --git a/docs/reference/api/AnalysisElisionTokenFilter.md b/docs/reference/api/AnalysisElisionTokenFilter.md new file mode 100644 index 000000000..0a08837e3 --- /dev/null +++ b/docs/reference/api/AnalysisElisionTokenFilter.md @@ -0,0 +1,8 @@ +## Interface `AnalysisElisionTokenFilter` + +| Name | Type | Description | +| - | - | - | +| `articles_case` | [SpecUtilsStringified](./SpecUtilsStringified.md) | If `true`, elision matching is case insensitive. If `false`, elision matching is case sensitive. Defaults to `false`. | +| `articles_path` | string | Path to a file that contains a list of elisions to remove. This path must be absolute or relative to the `config` location, and the file must be UTF-8 encoded. Each elision in the file must be separated by a line break. To be removed, the elision must be at the beginning of a token and be immediately followed by an apostrophe. Both the elision and apostrophe are removed. For custom `elision` filters, either this parameter or `articles` must be specified. | +| `articles` | string[] | List of elisions to remove. To be removed, the elision must be at the beginning of a token and be immediately followed by an apostrophe. Both the elision and apostrophe are removed. For custom `elision` filters, either this parameter or `articles_path` must be specified. | +| `type` | 'elision' |   | diff --git a/docs/reference/api/AnalysisEnglishAnalyzer.md b/docs/reference/api/AnalysisEnglishAnalyzer.md new file mode 100644 index 000000000..1526aca3e --- /dev/null +++ b/docs/reference/api/AnalysisEnglishAnalyzer.md @@ -0,0 +1,8 @@ +## Interface `AnalysisEnglishAnalyzer` + +| Name | Type | Description | +| - | - | - | +| `stem_exclusion` | string[] |   | +| `stopwords_path` | string |   | +| `stopwords` | [AnalysisStopWords](./AnalysisStopWords.md) |   | +| `type` | 'english' |   | diff --git a/docs/reference/api/AnalysisEstonianAnalyzer.md b/docs/reference/api/AnalysisEstonianAnalyzer.md new file mode 100644 index 000000000..0af5380b5 --- /dev/null +++ b/docs/reference/api/AnalysisEstonianAnalyzer.md @@ -0,0 +1,7 @@ +## Interface `AnalysisEstonianAnalyzer` + +| Name | Type | Description | +| - | - | - | +| `stopwords_path` | string |   | +| `stopwords` | [AnalysisStopWords](./AnalysisStopWords.md) |   | +| `type` | 'estonian' |   | diff --git a/docs/reference/api/AnalysisFingerprintAnalyzer.md b/docs/reference/api/AnalysisFingerprintAnalyzer.md new file mode 100644 index 000000000..957b30c39 --- /dev/null +++ b/docs/reference/api/AnalysisFingerprintAnalyzer.md @@ -0,0 +1,10 @@ +## Interface `AnalysisFingerprintAnalyzer` + +| Name | Type | Description | +| - | - | - | +| `max_output_size` | [integer](./integer.md) | The maximum token size to emit. Tokens larger than this size will be discarded. Defaults to `255` | +| `separator` | string | The character to use to concatenate the terms. Defaults to a space. | +| `stopwords_path` | string | The path to a file containing stop words. | +| `stopwords` | [AnalysisStopWords](./AnalysisStopWords.md) | A pre-defined stop words list like `_english_` or an array containing a list of stop words. Defaults to `_none_`. | +| `type` | 'fingerprint' |   | +| `version` | [VersionString](./VersionString.md) |   | diff --git a/docs/reference/api/AnalysisFingerprintTokenFilter.md b/docs/reference/api/AnalysisFingerprintTokenFilter.md new file mode 100644 index 000000000..3d39d7442 --- /dev/null +++ b/docs/reference/api/AnalysisFingerprintTokenFilter.md @@ -0,0 +1,7 @@ +## Interface `AnalysisFingerprintTokenFilter` + +| Name | Type | Description | +| - | - | - | +| `max_output_size` | [integer](./integer.md) | Maximum character length, including whitespace, of the output token. Defaults to `255`. Concatenated tokens longer than this will result in no token output. | +| `separator` | string | Character to use to concatenate the token stream input. Defaults to a space. | +| `type` | 'fingerprint' |   | diff --git a/docs/reference/api/AnalysisFinnishAnalyzer.md b/docs/reference/api/AnalysisFinnishAnalyzer.md new file mode 100644 index 000000000..2657cdd33 --- /dev/null +++ b/docs/reference/api/AnalysisFinnishAnalyzer.md @@ -0,0 +1,8 @@ +## Interface `AnalysisFinnishAnalyzer` + +| Name | Type | Description | +| - | - | - | +| `stem_exclusion` | string[] |   | +| `stopwords_path` | string |   | +| `stopwords` | [AnalysisStopWords](./AnalysisStopWords.md) |   | +| `type` | 'finnish' |   | diff --git a/docs/reference/api/AnalysisFlattenGraphTokenFilter.md b/docs/reference/api/AnalysisFlattenGraphTokenFilter.md new file mode 100644 index 000000000..628c29d0c --- /dev/null +++ b/docs/reference/api/AnalysisFlattenGraphTokenFilter.md @@ -0,0 +1,5 @@ +## Interface `AnalysisFlattenGraphTokenFilter` + +| Name | Type | Description | +| - | - | - | +| `type` | 'flatten_graph' |   | diff --git a/docs/reference/api/AnalysisFrenchAnalyzer.md b/docs/reference/api/AnalysisFrenchAnalyzer.md new file mode 100644 index 000000000..52cf61c50 --- /dev/null +++ b/docs/reference/api/AnalysisFrenchAnalyzer.md @@ -0,0 +1,8 @@ +## Interface `AnalysisFrenchAnalyzer` + +| Name | Type | Description | +| - | - | - | +| `stem_exclusion` | string[] |   | +| `stopwords_path` | string |   | +| `stopwords` | [AnalysisStopWords](./AnalysisStopWords.md) |   | +| `type` | 'french' |   | diff --git a/docs/reference/api/AnalysisGalicianAnalyzer.md b/docs/reference/api/AnalysisGalicianAnalyzer.md new file mode 100644 index 000000000..6241af166 --- /dev/null +++ b/docs/reference/api/AnalysisGalicianAnalyzer.md @@ -0,0 +1,8 @@ +## Interface `AnalysisGalicianAnalyzer` + +| Name | Type | Description | +| - | - | - | +| `stem_exclusion` | string[] |   | +| `stopwords_path` | string |   | +| `stopwords` | [AnalysisStopWords](./AnalysisStopWords.md) |   | +| `type` | 'galician' |   | diff --git a/docs/reference/api/AnalysisGermanAnalyzer.md b/docs/reference/api/AnalysisGermanAnalyzer.md new file mode 100644 index 000000000..70ed807a5 --- /dev/null +++ b/docs/reference/api/AnalysisGermanAnalyzer.md @@ -0,0 +1,8 @@ +## Interface `AnalysisGermanAnalyzer` + +| Name | Type | Description | +| - | - | - | +| `stem_exclusion` | string[] |   | +| `stopwords_path` | string |   | +| `stopwords` | [AnalysisStopWords](./AnalysisStopWords.md) |   | +| `type` | 'german' |   | diff --git a/docs/reference/api/AnalysisGermanNormalizationTokenFilter.md b/docs/reference/api/AnalysisGermanNormalizationTokenFilter.md new file mode 100644 index 000000000..70745905b --- /dev/null +++ b/docs/reference/api/AnalysisGermanNormalizationTokenFilter.md @@ -0,0 +1,5 @@ +## Interface `AnalysisGermanNormalizationTokenFilter` + +| Name | Type | Description | +| - | - | - | +| `type` | 'german_normalization' |   | diff --git a/docs/reference/api/AnalysisGreekAnalyzer.md b/docs/reference/api/AnalysisGreekAnalyzer.md new file mode 100644 index 000000000..930bc7951 --- /dev/null +++ b/docs/reference/api/AnalysisGreekAnalyzer.md @@ -0,0 +1,7 @@ +## Interface `AnalysisGreekAnalyzer` + +| Name | Type | Description | +| - | - | - | +| `stopwords_path` | string |   | +| `stopwords` | [AnalysisStopWords](./AnalysisStopWords.md) |   | +| `type` | 'greek' |   | diff --git a/docs/reference/api/AnalysisHindiAnalyzer.md b/docs/reference/api/AnalysisHindiAnalyzer.md new file mode 100644 index 000000000..9136a2cb6 --- /dev/null +++ b/docs/reference/api/AnalysisHindiAnalyzer.md @@ -0,0 +1,8 @@ +## Interface `AnalysisHindiAnalyzer` + +| Name | Type | Description | +| - | - | - | +| `stem_exclusion` | string[] |   | +| `stopwords_path` | string |   | +| `stopwords` | [AnalysisStopWords](./AnalysisStopWords.md) |   | +| `type` | 'hindi' |   | diff --git a/docs/reference/api/AnalysisHindiNormalizationTokenFilter.md b/docs/reference/api/AnalysisHindiNormalizationTokenFilter.md new file mode 100644 index 000000000..9c85dd18d --- /dev/null +++ b/docs/reference/api/AnalysisHindiNormalizationTokenFilter.md @@ -0,0 +1,5 @@ +## Interface `AnalysisHindiNormalizationTokenFilter` + +| Name | Type | Description | +| - | - | - | +| `type` | 'hindi_normalization' |   | diff --git a/docs/reference/api/AnalysisHtmlStripCharFilter.md b/docs/reference/api/AnalysisHtmlStripCharFilter.md new file mode 100644 index 000000000..92ac943cb --- /dev/null +++ b/docs/reference/api/AnalysisHtmlStripCharFilter.md @@ -0,0 +1,6 @@ +## Interface `AnalysisHtmlStripCharFilter` + +| Name | Type | Description | +| - | - | - | +| `escaped_tags` | string[] |   | +| `type` | 'html_strip' |   | diff --git a/docs/reference/api/AnalysisHungarianAnalyzer.md b/docs/reference/api/AnalysisHungarianAnalyzer.md new file mode 100644 index 000000000..77297b08c --- /dev/null +++ b/docs/reference/api/AnalysisHungarianAnalyzer.md @@ -0,0 +1,8 @@ +## Interface `AnalysisHungarianAnalyzer` + +| Name | Type | Description | +| - | - | - | +| `stem_exclusion` | string[] |   | +| `stopwords_path` | string |   | +| `stopwords` | [AnalysisStopWords](./AnalysisStopWords.md) |   | +| `type` | 'hungarian' |   | diff --git a/docs/reference/api/AnalysisHunspellTokenFilter.md b/docs/reference/api/AnalysisHunspellTokenFilter.md new file mode 100644 index 000000000..46e270f8d --- /dev/null +++ b/docs/reference/api/AnalysisHunspellTokenFilter.md @@ -0,0 +1,11 @@ +## Interface `AnalysisHunspellTokenFilter` + +| Name | Type | Description | +| - | - | - | +| `dedup` | boolean | If `true`, duplicate tokens are removed from the filter’s output. Defaults to `true`. | +| `dictionary` | string | One or more `.dic` files (e.g, `en_US.dic`, my_custom.dic) to use for the Hunspell dictionary. By default, the `hunspell` filter uses all `.dic` files in the `<$ES_PATH_CONF>/hunspell/` directory specified using the `lang`, `language`, or `locale` parameter. | +| `lang` | string | Locale directory used to specify the `.aff` and `.dic` files for a Hunspell dictionary. locale | +| `language` | string | Locale directory used to specify the `.aff` and `.dic` files for a Hunspell dictionary. locale | +| `locale` | string | Locale directory used to specify the `.aff` and `.dic` files for a Hunspell dictionary. | +| `longest_only` | boolean | If `true`, only the longest stemmed version of each token is included in the output. If `false`, all stemmed versions of the token are included. Defaults to `false`. | +| `type` | 'hunspell' |   | diff --git a/docs/reference/api/AnalysisHyphenationDecompounderTokenFilter.md b/docs/reference/api/AnalysisHyphenationDecompounderTokenFilter.md new file mode 100644 index 000000000..813ca66e2 --- /dev/null +++ b/docs/reference/api/AnalysisHyphenationDecompounderTokenFilter.md @@ -0,0 +1,8 @@ +## Interface `AnalysisHyphenationDecompounderTokenFilter` + +| Name | Type | Description | +| - | - | - | +| `hyphenation_patterns_path` | string | Path to an Apache FOP (Formatting Objects Processor) XML hyphenation pattern file. This path must be absolute or relative to the `config` location. Only FOP v1.2 compatible files are supported. | +| `no_overlapping_matches` | boolean | If `true`, do not allow overlapping tokens. Defaults to `false`. | +| `no_sub_matches` | boolean | If `true`, do not match sub tokens in tokens that are in the word list. Defaults to `false`. | +| `type` | 'hyphenation_decompounder' |   | diff --git a/docs/reference/api/AnalysisIcuAnalyzer.md b/docs/reference/api/AnalysisIcuAnalyzer.md new file mode 100644 index 000000000..bb8975abe --- /dev/null +++ b/docs/reference/api/AnalysisIcuAnalyzer.md @@ -0,0 +1,7 @@ +## Interface `AnalysisIcuAnalyzer` + +| Name | Type | Description | +| - | - | - | +| `method` | [AnalysisIcuNormalizationType](./AnalysisIcuNormalizationType.md) |   | +| `mode` | [AnalysisIcuNormalizationMode](./AnalysisIcuNormalizationMode.md) |   | +| `type` | 'icu_analyzer' |   | diff --git a/docs/reference/api/AnalysisIcuCollationAlternate.md b/docs/reference/api/AnalysisIcuCollationAlternate.md new file mode 100644 index 000000000..acd1e984d --- /dev/null +++ b/docs/reference/api/AnalysisIcuCollationAlternate.md @@ -0,0 +1,4 @@ +## `AnalysisIcuCollationAlternate` +::: +type AnalysisIcuCollationAlternate = 'shifted' | 'non-ignorable'; +::: diff --git a/docs/reference/api/AnalysisIcuCollationCaseFirst.md b/docs/reference/api/AnalysisIcuCollationCaseFirst.md new file mode 100644 index 000000000..7bcd99e96 --- /dev/null +++ b/docs/reference/api/AnalysisIcuCollationCaseFirst.md @@ -0,0 +1,4 @@ +## `AnalysisIcuCollationCaseFirst` +::: +type AnalysisIcuCollationCaseFirst = 'lower' | 'upper'; +::: diff --git a/docs/reference/api/AnalysisIcuCollationDecomposition.md b/docs/reference/api/AnalysisIcuCollationDecomposition.md new file mode 100644 index 000000000..f5710a378 --- /dev/null +++ b/docs/reference/api/AnalysisIcuCollationDecomposition.md @@ -0,0 +1,4 @@ +## `AnalysisIcuCollationDecomposition` +::: +type AnalysisIcuCollationDecomposition = 'no' | 'identical'; +::: diff --git a/docs/reference/api/AnalysisIcuCollationStrength.md b/docs/reference/api/AnalysisIcuCollationStrength.md new file mode 100644 index 000000000..bca08521a --- /dev/null +++ b/docs/reference/api/AnalysisIcuCollationStrength.md @@ -0,0 +1,4 @@ +## `AnalysisIcuCollationStrength` +::: +type AnalysisIcuCollationStrength = 'primary' | 'secondary' | 'tertiary' | 'quaternary' | 'identical'; +::: diff --git a/docs/reference/api/AnalysisIcuCollationTokenFilter.md b/docs/reference/api/AnalysisIcuCollationTokenFilter.md new file mode 100644 index 000000000..ac6bde71a --- /dev/null +++ b/docs/reference/api/AnalysisIcuCollationTokenFilter.md @@ -0,0 +1,17 @@ +## Interface `AnalysisIcuCollationTokenFilter` + +| Name | Type | Description | +| - | - | - | +| `alternate` | [AnalysisIcuCollationAlternate](./AnalysisIcuCollationAlternate.md) |   | +| `case_first` | [AnalysisIcuCollationCaseFirst](./AnalysisIcuCollationCaseFirst.md) |   | +| `case_level` | boolean |   | +| `country` | string |   | +| `decomposition` | [AnalysisIcuCollationDecomposition](./AnalysisIcuCollationDecomposition.md) |   | +| `hiragana_quaternary_mode` | boolean |   | +| `language` | string |   | +| `numeric` | boolean |   | +| `rules` | string |   | +| `strength` | [AnalysisIcuCollationStrength](./AnalysisIcuCollationStrength.md) |   | +| `type` | 'icu_collation' |   | +| `variable_top` | string |   | +| `variant` | string |   | diff --git a/docs/reference/api/AnalysisIcuFoldingTokenFilter.md b/docs/reference/api/AnalysisIcuFoldingTokenFilter.md new file mode 100644 index 000000000..185c3a1ed --- /dev/null +++ b/docs/reference/api/AnalysisIcuFoldingTokenFilter.md @@ -0,0 +1,6 @@ +## Interface `AnalysisIcuFoldingTokenFilter` + +| Name | Type | Description | +| - | - | - | +| `type` | 'icu_folding' |   | +| `unicode_set_filter` | string |   | diff --git a/docs/reference/api/AnalysisIcuNormalizationCharFilter.md b/docs/reference/api/AnalysisIcuNormalizationCharFilter.md new file mode 100644 index 000000000..85a0045af --- /dev/null +++ b/docs/reference/api/AnalysisIcuNormalizationCharFilter.md @@ -0,0 +1,8 @@ +## Interface `AnalysisIcuNormalizationCharFilter` + +| Name | Type | Description | +| - | - | - | +| `mode` | [AnalysisIcuNormalizationMode](./AnalysisIcuNormalizationMode.md) |   | +| `name` | [AnalysisIcuNormalizationType](./AnalysisIcuNormalizationType.md) |   | +| `type` | 'icu_normalizer' |   | +| `unicode_set_filter` | string |   | diff --git a/docs/reference/api/AnalysisIcuNormalizationMode.md b/docs/reference/api/AnalysisIcuNormalizationMode.md new file mode 100644 index 000000000..dd7ba1ce3 --- /dev/null +++ b/docs/reference/api/AnalysisIcuNormalizationMode.md @@ -0,0 +1,4 @@ +## `AnalysisIcuNormalizationMode` +::: +type AnalysisIcuNormalizationMode = 'decompose' | 'compose'; +::: diff --git a/docs/reference/api/AnalysisIcuNormalizationTokenFilter.md b/docs/reference/api/AnalysisIcuNormalizationTokenFilter.md new file mode 100644 index 000000000..327a8b212 --- /dev/null +++ b/docs/reference/api/AnalysisIcuNormalizationTokenFilter.md @@ -0,0 +1,6 @@ +## Interface `AnalysisIcuNormalizationTokenFilter` + +| Name | Type | Description | +| - | - | - | +| `name` | [AnalysisIcuNormalizationType](./AnalysisIcuNormalizationType.md) |   | +| `type` | 'icu_normalizer' |   | diff --git a/docs/reference/api/AnalysisIcuNormalizationType.md b/docs/reference/api/AnalysisIcuNormalizationType.md new file mode 100644 index 000000000..1ecad1481 --- /dev/null +++ b/docs/reference/api/AnalysisIcuNormalizationType.md @@ -0,0 +1,4 @@ +## `AnalysisIcuNormalizationType` +::: +type AnalysisIcuNormalizationType = 'nfc' | 'nfkc' | 'nfkc_cf'; +::: diff --git a/docs/reference/api/AnalysisIcuTokenizer.md b/docs/reference/api/AnalysisIcuTokenizer.md new file mode 100644 index 000000000..6d041a957 --- /dev/null +++ b/docs/reference/api/AnalysisIcuTokenizer.md @@ -0,0 +1,6 @@ +## Interface `AnalysisIcuTokenizer` + +| Name | Type | Description | +| - | - | - | +| `rule_files` | string |   | +| `type` | 'icu_tokenizer' |   | diff --git a/docs/reference/api/AnalysisIcuTransformDirection.md b/docs/reference/api/AnalysisIcuTransformDirection.md new file mode 100644 index 000000000..f2bc4d599 --- /dev/null +++ b/docs/reference/api/AnalysisIcuTransformDirection.md @@ -0,0 +1,4 @@ +## `AnalysisIcuTransformDirection` +::: +type AnalysisIcuTransformDirection = 'forward' | 'reverse'; +::: diff --git a/docs/reference/api/AnalysisIcuTransformTokenFilter.md b/docs/reference/api/AnalysisIcuTransformTokenFilter.md new file mode 100644 index 000000000..00152ef39 --- /dev/null +++ b/docs/reference/api/AnalysisIcuTransformTokenFilter.md @@ -0,0 +1,7 @@ +## Interface `AnalysisIcuTransformTokenFilter` + +| Name | Type | Description | +| - | - | - | +| `dir` | [AnalysisIcuTransformDirection](./AnalysisIcuTransformDirection.md) |   | +| `id` | string |   | +| `type` | 'icu_transform' |   | diff --git a/docs/reference/api/AnalysisIndicNormalizationTokenFilter.md b/docs/reference/api/AnalysisIndicNormalizationTokenFilter.md new file mode 100644 index 000000000..cd7aca579 --- /dev/null +++ b/docs/reference/api/AnalysisIndicNormalizationTokenFilter.md @@ -0,0 +1,5 @@ +## Interface `AnalysisIndicNormalizationTokenFilter` + +| Name | Type | Description | +| - | - | - | +| `type` | 'indic_normalization' |   | diff --git a/docs/reference/api/AnalysisIndonesianAnalyzer.md b/docs/reference/api/AnalysisIndonesianAnalyzer.md new file mode 100644 index 000000000..059fb579e --- /dev/null +++ b/docs/reference/api/AnalysisIndonesianAnalyzer.md @@ -0,0 +1,8 @@ +## Interface `AnalysisIndonesianAnalyzer` + +| Name | Type | Description | +| - | - | - | +| `stem_exclusion` | string[] |   | +| `stopwords_path` | string |   | +| `stopwords` | [AnalysisStopWords](./AnalysisStopWords.md) |   | +| `type` | 'indonesian' |   | diff --git a/docs/reference/api/AnalysisIrishAnalyzer.md b/docs/reference/api/AnalysisIrishAnalyzer.md new file mode 100644 index 000000000..3d6265961 --- /dev/null +++ b/docs/reference/api/AnalysisIrishAnalyzer.md @@ -0,0 +1,8 @@ +## Interface `AnalysisIrishAnalyzer` + +| Name | Type | Description | +| - | - | - | +| `stem_exclusion` | string[] |   | +| `stopwords_path` | string |   | +| `stopwords` | [AnalysisStopWords](./AnalysisStopWords.md) |   | +| `type` | 'irish' |   | diff --git a/docs/reference/api/AnalysisItalianAnalyzer.md b/docs/reference/api/AnalysisItalianAnalyzer.md new file mode 100644 index 000000000..394a5fb9c --- /dev/null +++ b/docs/reference/api/AnalysisItalianAnalyzer.md @@ -0,0 +1,8 @@ +## Interface `AnalysisItalianAnalyzer` + +| Name | Type | Description | +| - | - | - | +| `stem_exclusion` | string[] |   | +| `stopwords_path` | string |   | +| `stopwords` | [AnalysisStopWords](./AnalysisStopWords.md) |   | +| `type` | 'italian' |   | diff --git a/docs/reference/api/AnalysisJaStopTokenFilter.md b/docs/reference/api/AnalysisJaStopTokenFilter.md new file mode 100644 index 000000000..2aface2aa --- /dev/null +++ b/docs/reference/api/AnalysisJaStopTokenFilter.md @@ -0,0 +1,6 @@ +## Interface `AnalysisJaStopTokenFilter` + +| Name | Type | Description | +| - | - | - | +| `stopwords` | [AnalysisStopWords](./AnalysisStopWords.md) |   | +| `type` | 'ja_stop' |   | diff --git a/docs/reference/api/AnalysisKStemTokenFilter.md b/docs/reference/api/AnalysisKStemTokenFilter.md new file mode 100644 index 000000000..f1de5265d --- /dev/null +++ b/docs/reference/api/AnalysisKStemTokenFilter.md @@ -0,0 +1,5 @@ +## Interface `AnalysisKStemTokenFilter` + +| Name | Type | Description | +| - | - | - | +| `type` | 'kstem' |   | diff --git a/docs/reference/api/AnalysisKeepTypesMode.md b/docs/reference/api/AnalysisKeepTypesMode.md new file mode 100644 index 000000000..71eab376b --- /dev/null +++ b/docs/reference/api/AnalysisKeepTypesMode.md @@ -0,0 +1,4 @@ +## `AnalysisKeepTypesMode` +::: +type AnalysisKeepTypesMode = 'include' | 'exclude'; +::: diff --git a/docs/reference/api/AnalysisKeepTypesTokenFilter.md b/docs/reference/api/AnalysisKeepTypesTokenFilter.md new file mode 100644 index 000000000..ba4b86aaf --- /dev/null +++ b/docs/reference/api/AnalysisKeepTypesTokenFilter.md @@ -0,0 +1,7 @@ +## Interface `AnalysisKeepTypesTokenFilter` + +| Name | Type | Description | +| - | - | - | +| `mode` | [AnalysisKeepTypesMode](./AnalysisKeepTypesMode.md) | Indicates whether to keep or remove the specified token types. | +| `type` | 'keep_types' |   | +| `types` | string[] | List of token types to keep or remove. | diff --git a/docs/reference/api/AnalysisKeepWordsTokenFilter.md b/docs/reference/api/AnalysisKeepWordsTokenFilter.md new file mode 100644 index 000000000..902ee6038 --- /dev/null +++ b/docs/reference/api/AnalysisKeepWordsTokenFilter.md @@ -0,0 +1,8 @@ +## Interface `AnalysisKeepWordsTokenFilter` + +| Name | Type | Description | +| - | - | - | +| `keep_words_case` | boolean | If `true`, lowercase all keep words. Defaults to `false`. | +| `keep_words_path` | string | Path to a file that contains a list of words to keep. Only tokens that match words in this list are included in the output. This path must be absolute or relative to the `config` location, and the file must be UTF-8 encoded. Each word in the file must be separated by a line break. Either this parameter or `keep_words` must be specified. | +| `keep_words` | string[] | List of words to keep. Only tokens that match words in this list are included in the output. Either this parameter or `keep_words_path` must be specified. | +| `type` | 'keep' |   | diff --git a/docs/reference/api/AnalysisKeywordAnalyzer.md b/docs/reference/api/AnalysisKeywordAnalyzer.md new file mode 100644 index 000000000..ac1876aed --- /dev/null +++ b/docs/reference/api/AnalysisKeywordAnalyzer.md @@ -0,0 +1,6 @@ +## Interface `AnalysisKeywordAnalyzer` + +| Name | Type | Description | +| - | - | - | +| `type` | 'keyword' |   | +| `version` | [VersionString](./VersionString.md) |   | diff --git a/docs/reference/api/AnalysisKeywordMarkerTokenFilter.md b/docs/reference/api/AnalysisKeywordMarkerTokenFilter.md new file mode 100644 index 000000000..2e5265ad0 --- /dev/null +++ b/docs/reference/api/AnalysisKeywordMarkerTokenFilter.md @@ -0,0 +1,9 @@ +## Interface `AnalysisKeywordMarkerTokenFilter` + +| Name | Type | Description | +| - | - | - | +| `ignore_case` | boolean | If `true`, matching for the `keywords` and `keywords_path` parameters ignores letter case. Defaults to `false`. | +| `keywords_path` | string | Path to a file that contains a list of keywords. Tokens that match these keywords are not stemmed. This path must be absolute or relative to the `config` location, and the file must be UTF-8 encoded. Each word in the file must be separated by a line break. This parameter, `keywords`, or `keywords_pattern` must be specified. You cannot specify this parameter and `keywords_pattern`. | +| `keywords_pattern` | string | Java regular expression used to match tokens. Tokens that match this expression are marked as keywords and not stemmed. This parameter, `keywords`, or `keywords_path` must be specified. You cannot specify this parameter and `keywords` or `keywords_pattern`. | +| `keywords` | string | string[] | Array of keywords. Tokens that match these keywords are not stemmed. This parameter, `keywords_path`, or `keywords_pattern` must be specified. You cannot specify this parameter and `keywords_pattern`. | +| `type` | 'keyword_marker' |   | diff --git a/docs/reference/api/AnalysisKeywordRepeatTokenFilter.md b/docs/reference/api/AnalysisKeywordRepeatTokenFilter.md new file mode 100644 index 000000000..c394a5df4 --- /dev/null +++ b/docs/reference/api/AnalysisKeywordRepeatTokenFilter.md @@ -0,0 +1,5 @@ +## Interface `AnalysisKeywordRepeatTokenFilter` + +| Name | Type | Description | +| - | - | - | +| `type` | 'keyword_repeat' |   | diff --git a/docs/reference/api/AnalysisKeywordTokenizer.md b/docs/reference/api/AnalysisKeywordTokenizer.md new file mode 100644 index 000000000..88bba70eb --- /dev/null +++ b/docs/reference/api/AnalysisKeywordTokenizer.md @@ -0,0 +1,6 @@ +## Interface `AnalysisKeywordTokenizer` + +| Name | Type | Description | +| - | - | - | +| `buffer_size` | [integer](./integer.md) |   | +| `type` | 'keyword' |   | diff --git a/docs/reference/api/AnalysisKuromojiAnalyzer.md b/docs/reference/api/AnalysisKuromojiAnalyzer.md new file mode 100644 index 000000000..7edc8ca28 --- /dev/null +++ b/docs/reference/api/AnalysisKuromojiAnalyzer.md @@ -0,0 +1,7 @@ +## Interface `AnalysisKuromojiAnalyzer` + +| Name | Type | Description | +| - | - | - | +| `mode` | [AnalysisKuromojiTokenizationMode](./AnalysisKuromojiTokenizationMode.md) |   | +| `type` | 'kuromoji' |   | +| `user_dictionary` | string |   | diff --git a/docs/reference/api/AnalysisKuromojiIterationMarkCharFilter.md b/docs/reference/api/AnalysisKuromojiIterationMarkCharFilter.md new file mode 100644 index 000000000..df15cc894 --- /dev/null +++ b/docs/reference/api/AnalysisKuromojiIterationMarkCharFilter.md @@ -0,0 +1,7 @@ +## Interface `AnalysisKuromojiIterationMarkCharFilter` + +| Name | Type | Description | +| - | - | - | +| `normalize_kana` | boolean |   | +| `normalize_kanji` | boolean |   | +| `type` | 'kuromoji_iteration_mark' |   | diff --git a/docs/reference/api/AnalysisKuromojiPartOfSpeechTokenFilter.md b/docs/reference/api/AnalysisKuromojiPartOfSpeechTokenFilter.md new file mode 100644 index 000000000..f26d181c3 --- /dev/null +++ b/docs/reference/api/AnalysisKuromojiPartOfSpeechTokenFilter.md @@ -0,0 +1,6 @@ +## Interface `AnalysisKuromojiPartOfSpeechTokenFilter` + +| Name | Type | Description | +| - | - | - | +| `stoptags` | string[] |   | +| `type` | 'kuromoji_part_of_speech' |   | diff --git a/docs/reference/api/AnalysisKuromojiReadingFormTokenFilter.md b/docs/reference/api/AnalysisKuromojiReadingFormTokenFilter.md new file mode 100644 index 000000000..f027be704 --- /dev/null +++ b/docs/reference/api/AnalysisKuromojiReadingFormTokenFilter.md @@ -0,0 +1,6 @@ +## Interface `AnalysisKuromojiReadingFormTokenFilter` + +| Name | Type | Description | +| - | - | - | +| `type` | 'kuromoji_readingform' |   | +| `use_romaji` | boolean |   | diff --git a/docs/reference/api/AnalysisKuromojiStemmerTokenFilter.md b/docs/reference/api/AnalysisKuromojiStemmerTokenFilter.md new file mode 100644 index 000000000..86a5a3426 --- /dev/null +++ b/docs/reference/api/AnalysisKuromojiStemmerTokenFilter.md @@ -0,0 +1,6 @@ +## Interface `AnalysisKuromojiStemmerTokenFilter` + +| Name | Type | Description | +| - | - | - | +| `minimum_length` | [integer](./integer.md) |   | +| `type` | 'kuromoji_stemmer' |   | diff --git a/docs/reference/api/AnalysisKuromojiTokenizationMode.md b/docs/reference/api/AnalysisKuromojiTokenizationMode.md new file mode 100644 index 000000000..c8fa65cfb --- /dev/null +++ b/docs/reference/api/AnalysisKuromojiTokenizationMode.md @@ -0,0 +1,4 @@ +## `AnalysisKuromojiTokenizationMode` +::: +type AnalysisKuromojiTokenizationMode = 'normal' | 'search' | 'extended'; +::: diff --git a/docs/reference/api/AnalysisKuromojiTokenizer.md b/docs/reference/api/AnalysisKuromojiTokenizer.md new file mode 100644 index 000000000..62bcb80b1 --- /dev/null +++ b/docs/reference/api/AnalysisKuromojiTokenizer.md @@ -0,0 +1,12 @@ +## Interface `AnalysisKuromojiTokenizer` + +| Name | Type | Description | +| - | - | - | +| `discard_compound_token` | boolean |   | +| `discard_punctuation` | boolean |   | +| `mode` | [AnalysisKuromojiTokenizationMode](./AnalysisKuromojiTokenizationMode.md) |   | +| `nbest_cost` | [integer](./integer.md) |   | +| `nbest_examples` | string |   | +| `type` | 'kuromoji_tokenizer' |   | +| `user_dictionary_rules` | string[] |   | +| `user_dictionary` | string |   | diff --git a/docs/reference/api/AnalysisLatvianAnalyzer.md b/docs/reference/api/AnalysisLatvianAnalyzer.md new file mode 100644 index 000000000..c2ae06fe1 --- /dev/null +++ b/docs/reference/api/AnalysisLatvianAnalyzer.md @@ -0,0 +1,8 @@ +## Interface `AnalysisLatvianAnalyzer` + +| Name | Type | Description | +| - | - | - | +| `stem_exclusion` | string[] |   | +| `stopwords_path` | string |   | +| `stopwords` | [AnalysisStopWords](./AnalysisStopWords.md) |   | +| `type` | 'latvian' |   | diff --git a/docs/reference/api/AnalysisLengthTokenFilter.md b/docs/reference/api/AnalysisLengthTokenFilter.md new file mode 100644 index 000000000..2d2b80714 --- /dev/null +++ b/docs/reference/api/AnalysisLengthTokenFilter.md @@ -0,0 +1,7 @@ +## Interface `AnalysisLengthTokenFilter` + +| Name | Type | Description | +| - | - | - | +| `max` | [integer](./integer.md) | Maximum character length of a token. Longer tokens are excluded from the output. Defaults to `Integer.MAX_VALUE`, which is `2^31-1` or `2147483647`. | +| `min` | [integer](./integer.md) | Minimum character length of a token. Shorter tokens are excluded from the output. Defaults to `0`. | +| `type` | 'length' |   | diff --git a/docs/reference/api/AnalysisLetterTokenizer.md b/docs/reference/api/AnalysisLetterTokenizer.md new file mode 100644 index 000000000..f6dfdfc43 --- /dev/null +++ b/docs/reference/api/AnalysisLetterTokenizer.md @@ -0,0 +1,5 @@ +## Interface `AnalysisLetterTokenizer` + +| Name | Type | Description | +| - | - | - | +| `type` | 'letter' |   | diff --git a/docs/reference/api/AnalysisLimitTokenCountTokenFilter.md b/docs/reference/api/AnalysisLimitTokenCountTokenFilter.md new file mode 100644 index 000000000..bea22989b --- /dev/null +++ b/docs/reference/api/AnalysisLimitTokenCountTokenFilter.md @@ -0,0 +1,7 @@ +## Interface `AnalysisLimitTokenCountTokenFilter` + +| Name | Type | Description | +| - | - | - | +| `consume_all_tokens` | boolean | If `true`, the limit filter exhausts the token stream, even if the `max_token_count` has already been reached. Defaults to `false`. | +| `max_token_count` | [SpecUtilsStringified](./SpecUtilsStringified.md)<[integer](./integer.md)> | Maximum number of tokens to keep. Once this limit is reached, any remaining tokens are excluded from the output. Defaults to `1`. | +| `type` | 'limit' |   | diff --git a/docs/reference/api/AnalysisLithuanianAnalyzer.md b/docs/reference/api/AnalysisLithuanianAnalyzer.md new file mode 100644 index 000000000..67c47bf0b --- /dev/null +++ b/docs/reference/api/AnalysisLithuanianAnalyzer.md @@ -0,0 +1,8 @@ +## Interface `AnalysisLithuanianAnalyzer` + +| Name | Type | Description | +| - | - | - | +| `stem_exclusion` | string[] |   | +| `stopwords_path` | string |   | +| `stopwords` | [AnalysisStopWords](./AnalysisStopWords.md) |   | +| `type` | 'lithuanian' |   | diff --git a/docs/reference/api/AnalysisLowercaseNormalizer.md b/docs/reference/api/AnalysisLowercaseNormalizer.md new file mode 100644 index 000000000..6b0ce5185 --- /dev/null +++ b/docs/reference/api/AnalysisLowercaseNormalizer.md @@ -0,0 +1,5 @@ +## Interface `AnalysisLowercaseNormalizer` + +| Name | Type | Description | +| - | - | - | +| `type` | 'lowercase' |   | diff --git a/docs/reference/api/AnalysisLowercaseTokenFilter.md b/docs/reference/api/AnalysisLowercaseTokenFilter.md new file mode 100644 index 000000000..e14e6e63a --- /dev/null +++ b/docs/reference/api/AnalysisLowercaseTokenFilter.md @@ -0,0 +1,6 @@ +## Interface `AnalysisLowercaseTokenFilter` + +| Name | Type | Description | +| - | - | - | +| `language` | [AnalysisLowercaseTokenFilterLanguages](./AnalysisLowercaseTokenFilterLanguages.md) | Language-specific lowercase token filter to use. | +| `type` | 'lowercase' |   | diff --git a/docs/reference/api/AnalysisLowercaseTokenFilterLanguages.md b/docs/reference/api/AnalysisLowercaseTokenFilterLanguages.md new file mode 100644 index 000000000..f8afdabef --- /dev/null +++ b/docs/reference/api/AnalysisLowercaseTokenFilterLanguages.md @@ -0,0 +1,4 @@ +## `AnalysisLowercaseTokenFilterLanguages` +::: +type AnalysisLowercaseTokenFilterLanguages = 'greek' | 'irish' | 'turkish'; +::: diff --git a/docs/reference/api/AnalysisLowercaseTokenizer.md b/docs/reference/api/AnalysisLowercaseTokenizer.md new file mode 100644 index 000000000..855b08d6e --- /dev/null +++ b/docs/reference/api/AnalysisLowercaseTokenizer.md @@ -0,0 +1,5 @@ +## Interface `AnalysisLowercaseTokenizer` + +| Name | Type | Description | +| - | - | - | +| `type` | 'lowercase' |   | diff --git a/docs/reference/api/AnalysisMappingCharFilter.md b/docs/reference/api/AnalysisMappingCharFilter.md new file mode 100644 index 000000000..b89c73500 --- /dev/null +++ b/docs/reference/api/AnalysisMappingCharFilter.md @@ -0,0 +1,7 @@ +## Interface `AnalysisMappingCharFilter` + +| Name | Type | Description | +| - | - | - | +| `mappings_path` | string |   | +| `mappings` | string[] |   | +| `type` | 'mapping' |   | diff --git a/docs/reference/api/AnalysisMinHashTokenFilter.md b/docs/reference/api/AnalysisMinHashTokenFilter.md new file mode 100644 index 000000000..1231edfa8 --- /dev/null +++ b/docs/reference/api/AnalysisMinHashTokenFilter.md @@ -0,0 +1,9 @@ +## Interface `AnalysisMinHashTokenFilter` + +| Name | Type | Description | +| - | - | - | +| `bucket_count` | [integer](./integer.md) | Number of buckets to which hashes are assigned. Defaults to `512`. | +| `hash_count` | [integer](./integer.md) | Number of ways to hash each token in the stream. Defaults to `1`. | +| `hash_set_size` | [integer](./integer.md) | Number of hashes to keep from each bucket. Defaults to `1`. Hashes are retained by ascending size, starting with the bucket’s smallest hash first. | +| `type` | 'min_hash' |   | +| `with_rotation` | boolean | If `true`, the filter fills empty buckets with the value of the first non-empty bucket to its circular right if the `hash_set_size` is `1`. If the `bucket_count` argument is greater than 1, this parameter defaults to `true`. Otherwise, this parameter defaults to `false`. | diff --git a/docs/reference/api/AnalysisMultiplexerTokenFilter.md b/docs/reference/api/AnalysisMultiplexerTokenFilter.md new file mode 100644 index 000000000..0282c73d6 --- /dev/null +++ b/docs/reference/api/AnalysisMultiplexerTokenFilter.md @@ -0,0 +1,7 @@ +## Interface `AnalysisMultiplexerTokenFilter` + +| Name | Type | Description | +| - | - | - | +| `filters` | string[] | A list of token filters to apply to incoming tokens. | +| `preserve_original` | [SpecUtilsStringified](./SpecUtilsStringified.md) | If `true` (the default) then emit the original token in addition to the filtered tokens. | +| `type` | 'multiplexer' |   | diff --git a/docs/reference/api/AnalysisNGramTokenFilter.md b/docs/reference/api/AnalysisNGramTokenFilter.md new file mode 100644 index 000000000..829a63095 --- /dev/null +++ b/docs/reference/api/AnalysisNGramTokenFilter.md @@ -0,0 +1,8 @@ +## Interface `AnalysisNGramTokenFilter` + +| Name | Type | Description | +| - | - | - | +| `max_gram` | [integer](./integer.md) | Maximum length of characters in a gram. Defaults to `2`. | +| `min_gram` | [integer](./integer.md) | Minimum length of characters in a gram. Defaults to `1`. | +| `preserve_original` | [SpecUtilsStringified](./SpecUtilsStringified.md) | Emits original token when set to `true`. Defaults to `false`. | +| `type` | 'ngram' |   | diff --git a/docs/reference/api/AnalysisNGramTokenizer.md b/docs/reference/api/AnalysisNGramTokenizer.md new file mode 100644 index 000000000..74b328cb1 --- /dev/null +++ b/docs/reference/api/AnalysisNGramTokenizer.md @@ -0,0 +1,9 @@ +## Interface `AnalysisNGramTokenizer` + +| Name | Type | Description | +| - | - | - | +| `custom_token_chars` | string |   | +| `max_gram` | [integer](./integer.md) |   | +| `min_gram` | [integer](./integer.md) |   | +| `token_chars` | [AnalysisTokenChar](./AnalysisTokenChar.md)[] |   | +| `type` | 'ngram' |   | diff --git a/docs/reference/api/AnalysisNoriAnalyzer.md b/docs/reference/api/AnalysisNoriAnalyzer.md new file mode 100644 index 000000000..7c2b9bb64 --- /dev/null +++ b/docs/reference/api/AnalysisNoriAnalyzer.md @@ -0,0 +1,9 @@ +## Interface `AnalysisNoriAnalyzer` + +| Name | Type | Description | +| - | - | - | +| `decompound_mode` | [AnalysisNoriDecompoundMode](./AnalysisNoriDecompoundMode.md) |   | +| `stoptags` | string[] |   | +| `type` | 'nori' |   | +| `user_dictionary` | string |   | +| `version` | [VersionString](./VersionString.md) |   | diff --git a/docs/reference/api/AnalysisNoriDecompoundMode.md b/docs/reference/api/AnalysisNoriDecompoundMode.md new file mode 100644 index 000000000..5c075647f --- /dev/null +++ b/docs/reference/api/AnalysisNoriDecompoundMode.md @@ -0,0 +1,4 @@ +## `AnalysisNoriDecompoundMode` +::: +type AnalysisNoriDecompoundMode = 'discard' | 'none' | 'mixed'; +::: diff --git a/docs/reference/api/AnalysisNoriPartOfSpeechTokenFilter.md b/docs/reference/api/AnalysisNoriPartOfSpeechTokenFilter.md new file mode 100644 index 000000000..a535c48fd --- /dev/null +++ b/docs/reference/api/AnalysisNoriPartOfSpeechTokenFilter.md @@ -0,0 +1,6 @@ +## Interface `AnalysisNoriPartOfSpeechTokenFilter` + +| Name | Type | Description | +| - | - | - | +| `stoptags` | string[] | An array of part-of-speech tags that should be removed. | +| `type` | 'nori_part_of_speech' |   | diff --git a/docs/reference/api/AnalysisNoriTokenizer.md b/docs/reference/api/AnalysisNoriTokenizer.md new file mode 100644 index 000000000..4fc8af49b --- /dev/null +++ b/docs/reference/api/AnalysisNoriTokenizer.md @@ -0,0 +1,9 @@ +## Interface `AnalysisNoriTokenizer` + +| Name | Type | Description | +| - | - | - | +| `decompound_mode` | [AnalysisNoriDecompoundMode](./AnalysisNoriDecompoundMode.md) |   | +| `discard_punctuation` | boolean |   | +| `type` | 'nori_tokenizer' |   | +| `user_dictionary_rules` | string[] |   | +| `user_dictionary` | string |   | diff --git a/docs/reference/api/AnalysisNormalizer.md b/docs/reference/api/AnalysisNormalizer.md new file mode 100644 index 000000000..46279996f --- /dev/null +++ b/docs/reference/api/AnalysisNormalizer.md @@ -0,0 +1,4 @@ +## `AnalysisNormalizer` +::: +type AnalysisNormalizer = [AnalysisLowercaseNormalizer](./AnalysisLowercaseNormalizer.md) | [AnalysisCustomNormalizer](./AnalysisCustomNormalizer.md); +::: diff --git a/docs/reference/api/AnalysisNorwegianAnalyzer.md b/docs/reference/api/AnalysisNorwegianAnalyzer.md new file mode 100644 index 000000000..12025deca --- /dev/null +++ b/docs/reference/api/AnalysisNorwegianAnalyzer.md @@ -0,0 +1,8 @@ +## Interface `AnalysisNorwegianAnalyzer` + +| Name | Type | Description | +| - | - | - | +| `stem_exclusion` | string[] |   | +| `stopwords_path` | string |   | +| `stopwords` | [AnalysisStopWords](./AnalysisStopWords.md) |   | +| `type` | 'norwegian' |   | diff --git a/docs/reference/api/AnalysisPathHierarchyTokenizer.md b/docs/reference/api/AnalysisPathHierarchyTokenizer.md new file mode 100644 index 000000000..1d684d29b --- /dev/null +++ b/docs/reference/api/AnalysisPathHierarchyTokenizer.md @@ -0,0 +1,10 @@ +## Interface `AnalysisPathHierarchyTokenizer` + +| Name | Type | Description | +| - | - | - | +| `buffer_size` | [SpecUtilsStringified](./SpecUtilsStringified.md)<[integer](./integer.md)> |   | +| `delimiter` | string |   | +| `replacement` | string |   | +| `reverse` | [SpecUtilsStringified](./SpecUtilsStringified.md) |   | +| `skip` | [SpecUtilsStringified](./SpecUtilsStringified.md)<[integer](./integer.md)> |   | +| `type` | 'path_hierarchy' |   | diff --git a/docs/reference/api/AnalysisPatternAnalyzer.md b/docs/reference/api/AnalysisPatternAnalyzer.md new file mode 100644 index 000000000..b335e2864 --- /dev/null +++ b/docs/reference/api/AnalysisPatternAnalyzer.md @@ -0,0 +1,11 @@ +## Interface `AnalysisPatternAnalyzer` + +| Name | Type | Description | +| - | - | - | +| `flags` | string | Java regular expression flags. Flags should be pipe-separated, eg "CASE_INSENSITIVE|COMMENTS". | +| `lowercase` | boolean | Should terms be lowercased or not. Defaults to `true`. | +| `pattern` | string | A Java regular expression. Defaults to `\W+`. | +| `stopwords_path` | string | The path to a file containing stop words. | +| `stopwords` | [AnalysisStopWords](./AnalysisStopWords.md) | A pre-defined stop words list like `_english_` or an array containing a list of stop words. Defaults to `_none_`. | +| `type` | 'pattern' |   | +| `version` | [VersionString](./VersionString.md) |   | diff --git a/docs/reference/api/AnalysisPatternCaptureTokenFilter.md b/docs/reference/api/AnalysisPatternCaptureTokenFilter.md new file mode 100644 index 000000000..7a0400ca5 --- /dev/null +++ b/docs/reference/api/AnalysisPatternCaptureTokenFilter.md @@ -0,0 +1,7 @@ +## Interface `AnalysisPatternCaptureTokenFilter` + +| Name | Type | Description | +| - | - | - | +| `patterns` | string[] | A list of regular expressions to match. | +| `preserve_original` | [SpecUtilsStringified](./SpecUtilsStringified.md) | If set to `true` (the default) it will emit the original token. | +| `type` | 'pattern_capture' |   | diff --git a/docs/reference/api/AnalysisPatternReplaceCharFilter.md b/docs/reference/api/AnalysisPatternReplaceCharFilter.md new file mode 100644 index 000000000..fc91882d2 --- /dev/null +++ b/docs/reference/api/AnalysisPatternReplaceCharFilter.md @@ -0,0 +1,8 @@ +## Interface `AnalysisPatternReplaceCharFilter` + +| Name | Type | Description | +| - | - | - | +| `flags` | string |   | +| `pattern` | string |   | +| `replacement` | string |   | +| `type` | 'pattern_replace' |   | diff --git a/docs/reference/api/AnalysisPatternReplaceTokenFilter.md b/docs/reference/api/AnalysisPatternReplaceTokenFilter.md new file mode 100644 index 000000000..d4f65114f --- /dev/null +++ b/docs/reference/api/AnalysisPatternReplaceTokenFilter.md @@ -0,0 +1,8 @@ +## Interface `AnalysisPatternReplaceTokenFilter` + +| Name | Type | Description | +| - | - | - | +| `all` | boolean | If `true`, all substrings matching the pattern parameter’s regular expression are replaced. If `false`, the filter replaces only the first matching substring in each token. Defaults to `true`. | +| `pattern` | string | Regular expression, written in Java’s regular expression syntax. The filter replaces token substrings matching this pattern with the substring in the `replacement` parameter. | +| `replacement` | string | Replacement substring. Defaults to an empty substring ( `""`). | +| `type` | 'pattern_replace' |   | diff --git a/docs/reference/api/AnalysisPatternTokenizer.md b/docs/reference/api/AnalysisPatternTokenizer.md new file mode 100644 index 000000000..a6bbb4a23 --- /dev/null +++ b/docs/reference/api/AnalysisPatternTokenizer.md @@ -0,0 +1,8 @@ +## Interface `AnalysisPatternTokenizer` + +| Name | Type | Description | +| - | - | - | +| `flags` | string |   | +| `group` | [integer](./integer.md) |   | +| `pattern` | string |   | +| `type` | 'pattern' |   | diff --git a/docs/reference/api/AnalysisPersianAnalyzer.md b/docs/reference/api/AnalysisPersianAnalyzer.md new file mode 100644 index 000000000..2bec97b77 --- /dev/null +++ b/docs/reference/api/AnalysisPersianAnalyzer.md @@ -0,0 +1,7 @@ +## Interface `AnalysisPersianAnalyzer` + +| Name | Type | Description | +| - | - | - | +| `stopwords_path` | string |   | +| `stopwords` | [AnalysisStopWords](./AnalysisStopWords.md) |   | +| `type` | 'persian' |   | diff --git a/docs/reference/api/AnalysisPersianNormalizationTokenFilter.md b/docs/reference/api/AnalysisPersianNormalizationTokenFilter.md new file mode 100644 index 000000000..85e247194 --- /dev/null +++ b/docs/reference/api/AnalysisPersianNormalizationTokenFilter.md @@ -0,0 +1,5 @@ +## Interface `AnalysisPersianNormalizationTokenFilter` + +| Name | Type | Description | +| - | - | - | +| `type` | 'persian_normalization' |   | diff --git a/docs/reference/api/AnalysisPhoneticEncoder.md b/docs/reference/api/AnalysisPhoneticEncoder.md new file mode 100644 index 000000000..fa31086e6 --- /dev/null +++ b/docs/reference/api/AnalysisPhoneticEncoder.md @@ -0,0 +1,4 @@ +## `AnalysisPhoneticEncoder` +::: +type AnalysisPhoneticEncoder = 'metaphone' | 'double_metaphone' | 'soundex' | 'refined_soundex' | 'caverphone1' | 'caverphone2' | 'cologne' | 'nysiis' | 'koelnerphonetik' | 'haasephonetik' | 'beider_morse' | 'daitch_mokotoff'; +::: diff --git a/docs/reference/api/AnalysisPhoneticLanguage.md b/docs/reference/api/AnalysisPhoneticLanguage.md new file mode 100644 index 000000000..ff978d8da --- /dev/null +++ b/docs/reference/api/AnalysisPhoneticLanguage.md @@ -0,0 +1,4 @@ +## `AnalysisPhoneticLanguage` +::: +type AnalysisPhoneticLanguage = 'any' | 'common' | 'cyrillic' | 'english' | 'french' | 'german' | 'hebrew' | 'hungarian' | 'polish' | 'romanian' | 'russian' | 'spanish'; +::: diff --git a/docs/reference/api/AnalysisPhoneticNameType.md b/docs/reference/api/AnalysisPhoneticNameType.md new file mode 100644 index 000000000..4f755d5f9 --- /dev/null +++ b/docs/reference/api/AnalysisPhoneticNameType.md @@ -0,0 +1,4 @@ +## `AnalysisPhoneticNameType` +::: +type AnalysisPhoneticNameType = 'generic' | 'ashkenazi' | 'sephardic'; +::: diff --git a/docs/reference/api/AnalysisPhoneticRuleType.md b/docs/reference/api/AnalysisPhoneticRuleType.md new file mode 100644 index 000000000..9d65dc339 --- /dev/null +++ b/docs/reference/api/AnalysisPhoneticRuleType.md @@ -0,0 +1,4 @@ +## `AnalysisPhoneticRuleType` +::: +type AnalysisPhoneticRuleType = 'approx' | 'exact'; +::: diff --git a/docs/reference/api/AnalysisPhoneticTokenFilter.md b/docs/reference/api/AnalysisPhoneticTokenFilter.md new file mode 100644 index 000000000..50d851929 --- /dev/null +++ b/docs/reference/api/AnalysisPhoneticTokenFilter.md @@ -0,0 +1,11 @@ +## Interface `AnalysisPhoneticTokenFilter` + +| Name | Type | Description | +| - | - | - | +| `encoder` | [AnalysisPhoneticEncoder](./AnalysisPhoneticEncoder.md) |   | +| `languageset` | [AnalysisPhoneticLanguage](./AnalysisPhoneticLanguage.md) | [AnalysisPhoneticLanguage](./AnalysisPhoneticLanguage.md)[] |   | +| `max_code_len` | [integer](./integer.md) |   | +| `name_type` | [AnalysisPhoneticNameType](./AnalysisPhoneticNameType.md) |   | +| `replace` | boolean |   | +| `rule_type` | [AnalysisPhoneticRuleType](./AnalysisPhoneticRuleType.md) |   | +| `type` | 'phonetic' |   | diff --git a/docs/reference/api/AnalysisPorterStemTokenFilter.md b/docs/reference/api/AnalysisPorterStemTokenFilter.md new file mode 100644 index 000000000..fd624f980 --- /dev/null +++ b/docs/reference/api/AnalysisPorterStemTokenFilter.md @@ -0,0 +1,5 @@ +## Interface `AnalysisPorterStemTokenFilter` + +| Name | Type | Description | +| - | - | - | +| `type` | 'porter_stem' |   | diff --git a/docs/reference/api/AnalysisPortugueseAnalyzer.md b/docs/reference/api/AnalysisPortugueseAnalyzer.md new file mode 100644 index 000000000..e443bc953 --- /dev/null +++ b/docs/reference/api/AnalysisPortugueseAnalyzer.md @@ -0,0 +1,8 @@ +## Interface `AnalysisPortugueseAnalyzer` + +| Name | Type | Description | +| - | - | - | +| `stem_exclusion` | string[] |   | +| `stopwords_path` | string |   | +| `stopwords` | [AnalysisStopWords](./AnalysisStopWords.md) |   | +| `type` | 'portuguese' |   | diff --git a/docs/reference/api/AnalysisPredicateTokenFilter.md b/docs/reference/api/AnalysisPredicateTokenFilter.md new file mode 100644 index 000000000..b6c96c20f --- /dev/null +++ b/docs/reference/api/AnalysisPredicateTokenFilter.md @@ -0,0 +1,6 @@ +## Interface `AnalysisPredicateTokenFilter` + +| Name | Type | Description | +| - | - | - | +| `script` | [Script](./Script.md) | [ScriptSource](./ScriptSource.md) | Script containing a condition used to filter incoming tokens. Only tokens that match this script are included in the output. | +| `type` | 'predicate_token_filter' |   | diff --git a/docs/reference/api/AnalysisRemoveDuplicatesTokenFilter.md b/docs/reference/api/AnalysisRemoveDuplicatesTokenFilter.md new file mode 100644 index 000000000..c115984cb --- /dev/null +++ b/docs/reference/api/AnalysisRemoveDuplicatesTokenFilter.md @@ -0,0 +1,5 @@ +## Interface `AnalysisRemoveDuplicatesTokenFilter` + +| Name | Type | Description | +| - | - | - | +| `type` | 'remove_duplicates' |   | diff --git a/docs/reference/api/AnalysisReverseTokenFilter.md b/docs/reference/api/AnalysisReverseTokenFilter.md new file mode 100644 index 000000000..dd73229f8 --- /dev/null +++ b/docs/reference/api/AnalysisReverseTokenFilter.md @@ -0,0 +1,5 @@ +## Interface `AnalysisReverseTokenFilter` + +| Name | Type | Description | +| - | - | - | +| `type` | 'reverse' |   | diff --git a/docs/reference/api/AnalysisRomanianAnalyzer.md b/docs/reference/api/AnalysisRomanianAnalyzer.md new file mode 100644 index 000000000..934a3c6ce --- /dev/null +++ b/docs/reference/api/AnalysisRomanianAnalyzer.md @@ -0,0 +1,8 @@ +## Interface `AnalysisRomanianAnalyzer` + +| Name | Type | Description | +| - | - | - | +| `stem_exclusion` | string[] |   | +| `stopwords_path` | string |   | +| `stopwords` | [AnalysisStopWords](./AnalysisStopWords.md) |   | +| `type` | 'romanian' |   | diff --git a/docs/reference/api/AnalysisRussianAnalyzer.md b/docs/reference/api/AnalysisRussianAnalyzer.md new file mode 100644 index 000000000..17e6024f0 --- /dev/null +++ b/docs/reference/api/AnalysisRussianAnalyzer.md @@ -0,0 +1,8 @@ +## Interface `AnalysisRussianAnalyzer` + +| Name | Type | Description | +| - | - | - | +| `stem_exclusion` | string[] |   | +| `stopwords_path` | string |   | +| `stopwords` | [AnalysisStopWords](./AnalysisStopWords.md) |   | +| `type` | 'russian' |   | diff --git a/docs/reference/api/AnalysisScandinavianFoldingTokenFilter.md b/docs/reference/api/AnalysisScandinavianFoldingTokenFilter.md new file mode 100644 index 000000000..7742822f1 --- /dev/null +++ b/docs/reference/api/AnalysisScandinavianFoldingTokenFilter.md @@ -0,0 +1,5 @@ +## Interface `AnalysisScandinavianFoldingTokenFilter` + +| Name | Type | Description | +| - | - | - | +| `type` | 'scandinavian_folding' |   | diff --git a/docs/reference/api/AnalysisScandinavianNormalizationTokenFilter.md b/docs/reference/api/AnalysisScandinavianNormalizationTokenFilter.md new file mode 100644 index 000000000..671679e34 --- /dev/null +++ b/docs/reference/api/AnalysisScandinavianNormalizationTokenFilter.md @@ -0,0 +1,5 @@ +## Interface `AnalysisScandinavianNormalizationTokenFilter` + +| Name | Type | Description | +| - | - | - | +| `type` | 'scandinavian_normalization' |   | diff --git a/docs/reference/api/AnalysisSerbianAnalyzer.md b/docs/reference/api/AnalysisSerbianAnalyzer.md new file mode 100644 index 000000000..db747314b --- /dev/null +++ b/docs/reference/api/AnalysisSerbianAnalyzer.md @@ -0,0 +1,8 @@ +## Interface `AnalysisSerbianAnalyzer` + +| Name | Type | Description | +| - | - | - | +| `stem_exclusion` | string[] |   | +| `stopwords_path` | string |   | +| `stopwords` | [AnalysisStopWords](./AnalysisStopWords.md) |   | +| `type` | 'serbian' |   | diff --git a/docs/reference/api/AnalysisSerbianNormalizationTokenFilter.md b/docs/reference/api/AnalysisSerbianNormalizationTokenFilter.md new file mode 100644 index 000000000..2e18bcef5 --- /dev/null +++ b/docs/reference/api/AnalysisSerbianNormalizationTokenFilter.md @@ -0,0 +1,5 @@ +## Interface `AnalysisSerbianNormalizationTokenFilter` + +| Name | Type | Description | +| - | - | - | +| `type` | 'serbian_normalization' |   | diff --git a/docs/reference/api/AnalysisShingleTokenFilter.md b/docs/reference/api/AnalysisShingleTokenFilter.md new file mode 100644 index 000000000..9141c184f --- /dev/null +++ b/docs/reference/api/AnalysisShingleTokenFilter.md @@ -0,0 +1,11 @@ +## Interface `AnalysisShingleTokenFilter` + +| Name | Type | Description | +| - | - | - | +| `filler_token` | string | String used in shingles as a replacement for empty positions that do not contain a token. This filler token is only used in shingles, not original unigrams. Defaults to an underscore ( `_`). | +| `max_shingle_size` | [SpecUtilsStringified](./SpecUtilsStringified.md)<[integer](./integer.md)> | Maximum number of tokens to concatenate when creating shingles. Defaults to `2`. | +| `min_shingle_size` | [SpecUtilsStringified](./SpecUtilsStringified.md)<[integer](./integer.md)> | Minimum number of tokens to concatenate when creating shingles. Defaults to `2`. | +| `output_unigrams_if_no_shingles` | boolean | If `true`, the output includes the original input tokens only if no shingles are produced; if shingles are produced, the output only includes shingles. Defaults to `false`. | +| `output_unigrams` | boolean | If `true`, the output includes the original input tokens. If `false`, the output only includes shingles; the original input tokens are removed. Defaults to `true`. | +| `token_separator` | string | Separator used to concatenate adjacent tokens to form a shingle. Defaults to a space ( `" "`). | +| `type` | 'shingle' |   | diff --git a/docs/reference/api/AnalysisSimpleAnalyzer.md b/docs/reference/api/AnalysisSimpleAnalyzer.md new file mode 100644 index 000000000..84f493fa7 --- /dev/null +++ b/docs/reference/api/AnalysisSimpleAnalyzer.md @@ -0,0 +1,6 @@ +## Interface `AnalysisSimpleAnalyzer` + +| Name | Type | Description | +| - | - | - | +| `type` | 'simple' |   | +| `version` | [VersionString](./VersionString.md) |   | diff --git a/docs/reference/api/AnalysisSimplePatternSplitTokenizer.md b/docs/reference/api/AnalysisSimplePatternSplitTokenizer.md new file mode 100644 index 000000000..706c4b107 --- /dev/null +++ b/docs/reference/api/AnalysisSimplePatternSplitTokenizer.md @@ -0,0 +1,6 @@ +## Interface `AnalysisSimplePatternSplitTokenizer` + +| Name | Type | Description | +| - | - | - | +| `pattern` | string |   | +| `type` | 'simple_pattern_split' |   | diff --git a/docs/reference/api/AnalysisSimplePatternTokenizer.md b/docs/reference/api/AnalysisSimplePatternTokenizer.md new file mode 100644 index 000000000..100f2002c --- /dev/null +++ b/docs/reference/api/AnalysisSimplePatternTokenizer.md @@ -0,0 +1,6 @@ +## Interface `AnalysisSimplePatternTokenizer` + +| Name | Type | Description | +| - | - | - | +| `pattern` | string |   | +| `type` | 'simple_pattern' |   | diff --git a/docs/reference/api/AnalysisSnowballAnalyzer.md b/docs/reference/api/AnalysisSnowballAnalyzer.md new file mode 100644 index 000000000..68732f811 --- /dev/null +++ b/docs/reference/api/AnalysisSnowballAnalyzer.md @@ -0,0 +1,8 @@ +## Interface `AnalysisSnowballAnalyzer` + +| Name | Type | Description | +| - | - | - | +| `language` | [AnalysisSnowballLanguage](./AnalysisSnowballLanguage.md) |   | +| `stopwords` | [AnalysisStopWords](./AnalysisStopWords.md) |   | +| `type` | 'snowball' |   | +| `version` | [VersionString](./VersionString.md) |   | diff --git a/docs/reference/api/AnalysisSnowballLanguage.md b/docs/reference/api/AnalysisSnowballLanguage.md new file mode 100644 index 000000000..eb0c04ce6 --- /dev/null +++ b/docs/reference/api/AnalysisSnowballLanguage.md @@ -0,0 +1,4 @@ +## `AnalysisSnowballLanguage` +::: +type AnalysisSnowballLanguage = 'Arabic' | 'Armenian' | 'Basque' | 'Catalan' | 'Danish' | 'Dutch' | 'English' | 'Estonian' | 'Finnish' | 'French' | 'German' | 'German2' | 'Hungarian' | 'Italian' | 'Irish' | 'Kp' | 'Lithuanian' | 'Lovins' | 'Norwegian' | 'Porter' | 'Portuguese' | 'Romanian' | 'Russian' | 'Serbian' | 'Spanish' | 'Swedish' | 'Turkish'; +::: diff --git a/docs/reference/api/AnalysisSnowballTokenFilter.md b/docs/reference/api/AnalysisSnowballTokenFilter.md new file mode 100644 index 000000000..73a5f6b03 --- /dev/null +++ b/docs/reference/api/AnalysisSnowballTokenFilter.md @@ -0,0 +1,6 @@ +## Interface `AnalysisSnowballTokenFilter` + +| Name | Type | Description | +| - | - | - | +| `language` | [AnalysisSnowballLanguage](./AnalysisSnowballLanguage.md) | Controls the language used by the stemmer. | +| `type` | 'snowball' |   | diff --git a/docs/reference/api/AnalysisSoraniAnalyzer.md b/docs/reference/api/AnalysisSoraniAnalyzer.md new file mode 100644 index 000000000..40e8f423b --- /dev/null +++ b/docs/reference/api/AnalysisSoraniAnalyzer.md @@ -0,0 +1,8 @@ +## Interface `AnalysisSoraniAnalyzer` + +| Name | Type | Description | +| - | - | - | +| `stem_exclusion` | string[] |   | +| `stopwords_path` | string |   | +| `stopwords` | [AnalysisStopWords](./AnalysisStopWords.md) |   | +| `type` | 'sorani' |   | diff --git a/docs/reference/api/AnalysisSoraniNormalizationTokenFilter.md b/docs/reference/api/AnalysisSoraniNormalizationTokenFilter.md new file mode 100644 index 000000000..e8f0acdc6 --- /dev/null +++ b/docs/reference/api/AnalysisSoraniNormalizationTokenFilter.md @@ -0,0 +1,5 @@ +## Interface `AnalysisSoraniNormalizationTokenFilter` + +| Name | Type | Description | +| - | - | - | +| `type` | 'sorani_normalization' |   | diff --git a/docs/reference/api/AnalysisSpanishAnalyzer.md b/docs/reference/api/AnalysisSpanishAnalyzer.md new file mode 100644 index 000000000..7810da4e9 --- /dev/null +++ b/docs/reference/api/AnalysisSpanishAnalyzer.md @@ -0,0 +1,8 @@ +## Interface `AnalysisSpanishAnalyzer` + +| Name | Type | Description | +| - | - | - | +| `stem_exclusion` | string[] |   | +| `stopwords_path` | string |   | +| `stopwords` | [AnalysisStopWords](./AnalysisStopWords.md) |   | +| `type` | 'spanish' |   | diff --git a/docs/reference/api/AnalysisStandardAnalyzer.md b/docs/reference/api/AnalysisStandardAnalyzer.md new file mode 100644 index 000000000..10d2a474c --- /dev/null +++ b/docs/reference/api/AnalysisStandardAnalyzer.md @@ -0,0 +1,8 @@ +## Interface `AnalysisStandardAnalyzer` + +| Name | Type | Description | +| - | - | - | +| `max_token_length` | [integer](./integer.md) | The maximum token length. If a token is seen that exceeds this length then it is split at `max_token_length` intervals. Defaults to `255`. | +| `stopwords_path` | string | The path to a file containing stop words. | +| `stopwords` | [AnalysisStopWords](./AnalysisStopWords.md) | A pre-defined stop words list like `_english_` or an array containing a list of stop words. Defaults to `_none_`. | +| `type` | 'standard' |   | diff --git a/docs/reference/api/AnalysisStandardTokenizer.md b/docs/reference/api/AnalysisStandardTokenizer.md new file mode 100644 index 000000000..187e53cf0 --- /dev/null +++ b/docs/reference/api/AnalysisStandardTokenizer.md @@ -0,0 +1,6 @@ +## Interface `AnalysisStandardTokenizer` + +| Name | Type | Description | +| - | - | - | +| `max_token_length` | [integer](./integer.md) |   | +| `type` | 'standard' |   | diff --git a/docs/reference/api/AnalysisStemmerOverrideTokenFilter.md b/docs/reference/api/AnalysisStemmerOverrideTokenFilter.md new file mode 100644 index 000000000..270d5bc03 --- /dev/null +++ b/docs/reference/api/AnalysisStemmerOverrideTokenFilter.md @@ -0,0 +1,7 @@ +## Interface `AnalysisStemmerOverrideTokenFilter` + +| Name | Type | Description | +| - | - | - | +| `rules_path` | string | A path (either relative to `config` location, or absolute) to a list of mappings. | +| `rules` | string[] | A list of mapping rules to use. | +| `type` | 'stemmer_override' |   | diff --git a/docs/reference/api/AnalysisStemmerTokenFilter.md b/docs/reference/api/AnalysisStemmerTokenFilter.md new file mode 100644 index 000000000..978edb06f --- /dev/null +++ b/docs/reference/api/AnalysisStemmerTokenFilter.md @@ -0,0 +1,7 @@ +## Interface `AnalysisStemmerTokenFilter` + +| Name | Type | Description | +| - | - | - | +| `language` | string |   | +| `name` | string | language | +| `type` | 'stemmer' |   | diff --git a/docs/reference/api/AnalysisStopAnalyzer.md b/docs/reference/api/AnalysisStopAnalyzer.md new file mode 100644 index 000000000..7e5ad6d24 --- /dev/null +++ b/docs/reference/api/AnalysisStopAnalyzer.md @@ -0,0 +1,8 @@ +## Interface `AnalysisStopAnalyzer` + +| Name | Type | Description | +| - | - | - | +| `stopwords_path` | string | The path to a file containing stop words. | +| `stopwords` | [AnalysisStopWords](./AnalysisStopWords.md) | A pre-defined stop words list like `_english_` or an array containing a list of stop words. Defaults to `_none_`. | +| `type` | 'stop' |   | +| `version` | [VersionString](./VersionString.md) |   | diff --git a/docs/reference/api/AnalysisStopTokenFilter.md b/docs/reference/api/AnalysisStopTokenFilter.md new file mode 100644 index 000000000..26c86ef32 --- /dev/null +++ b/docs/reference/api/AnalysisStopTokenFilter.md @@ -0,0 +1,9 @@ +## Interface `AnalysisStopTokenFilter` + +| Name | Type | Description | +| - | - | - | +| `ignore_case` | boolean | If `true`, stop word matching is case insensitive. For example, if `true`, a stop word of the matches and removes `The`, `THE`, or `the`. Defaults to `false`. | +| `remove_trailing` | boolean | If `true`, the last token of a stream is removed if it’s a stop word. Defaults to `true`. | +| `stopwords_path` | string | Path to a file that contains a list of stop words to remove. This path must be absolute or relative to the `config` location, and the file must be UTF-8 encoded. Each stop word in the file must be separated by a line break. | +| `stopwords` | [AnalysisStopWords](./AnalysisStopWords.md) | Language value, such as `_arabic_` or `_thai_`. Defaults to `_english_`. | +| `type` | 'stop' |   | diff --git a/docs/reference/api/AnalysisStopWordLanguage.md b/docs/reference/api/AnalysisStopWordLanguage.md new file mode 100644 index 000000000..330a7609d --- /dev/null +++ b/docs/reference/api/AnalysisStopWordLanguage.md @@ -0,0 +1,4 @@ +## `AnalysisStopWordLanguage` +::: +type AnalysisStopWordLanguage = '_arabic_' | '_armenian_' | '_basque_' | '_bengali_' | '_brazilian_' | '_bulgarian_' | '_catalan_' | '_cjk_' | '_czech_' | '_danish_' | '_dutch_' | '_english_' | '_estonian_' | '_finnish_' | '_french_' | '_galician_' | '_german_' | '_greek_' | '_hindi_' | '_hungarian_' | '_indonesian_' | '_irish_' | '_italian_' | '_latvian_' | '_lithuanian_' | '_norwegian_' | '_persian_' | '_portuguese_' | '_romanian_' | '_russian_' | '_serbian_' | '_sorani_' | '_spanish_' | '_swedish_' | '_thai_' | '_turkish_' | '_none_'; +::: diff --git a/docs/reference/api/AnalysisStopWords.md b/docs/reference/api/AnalysisStopWords.md new file mode 100644 index 000000000..7f9d7fa3e --- /dev/null +++ b/docs/reference/api/AnalysisStopWords.md @@ -0,0 +1,4 @@ +## `AnalysisStopWords` +::: +type AnalysisStopWords = [AnalysisStopWordLanguage](./AnalysisStopWordLanguage.md) | string[]; +::: diff --git a/docs/reference/api/AnalysisSwedishAnalyzer.md b/docs/reference/api/AnalysisSwedishAnalyzer.md new file mode 100644 index 000000000..86e4301c1 --- /dev/null +++ b/docs/reference/api/AnalysisSwedishAnalyzer.md @@ -0,0 +1,8 @@ +## Interface `AnalysisSwedishAnalyzer` + +| Name | Type | Description | +| - | - | - | +| `stem_exclusion` | string[] |   | +| `stopwords_path` | string |   | +| `stopwords` | [AnalysisStopWords](./AnalysisStopWords.md) |   | +| `type` | 'swedish' |   | diff --git a/docs/reference/api/AnalysisSynonymFormat.md b/docs/reference/api/AnalysisSynonymFormat.md new file mode 100644 index 000000000..ca6ac77ae --- /dev/null +++ b/docs/reference/api/AnalysisSynonymFormat.md @@ -0,0 +1,4 @@ +## `AnalysisSynonymFormat` +::: +type AnalysisSynonymFormat = 'solr' | 'wordnet'; +::: diff --git a/docs/reference/api/AnalysisSynonymGraphTokenFilter.md b/docs/reference/api/AnalysisSynonymGraphTokenFilter.md new file mode 100644 index 000000000..f976e4480 --- /dev/null +++ b/docs/reference/api/AnalysisSynonymGraphTokenFilter.md @@ -0,0 +1,5 @@ +## Interface `AnalysisSynonymGraphTokenFilter` + +| Name | Type | Description | +| - | - | - | +| `type` | 'synonym_graph' |   | diff --git a/docs/reference/api/AnalysisSynonymTokenFilter.md b/docs/reference/api/AnalysisSynonymTokenFilter.md new file mode 100644 index 000000000..abce4c672 --- /dev/null +++ b/docs/reference/api/AnalysisSynonymTokenFilter.md @@ -0,0 +1,5 @@ +## Interface `AnalysisSynonymTokenFilter` + +| Name | Type | Description | +| - | - | - | +| `type` | 'synonym' |   | diff --git a/docs/reference/api/AnalysisSynonymTokenFilterBase.md b/docs/reference/api/AnalysisSynonymTokenFilterBase.md new file mode 100644 index 000000000..1049f75ef --- /dev/null +++ b/docs/reference/api/AnalysisSynonymTokenFilterBase.md @@ -0,0 +1,12 @@ +## Interface `AnalysisSynonymTokenFilterBase` + +| Name | Type | Description | +| - | - | - | +| `expand` | boolean | Expands definitions for equivalent synonym rules. Defaults to `true`. | +| `format` | [AnalysisSynonymFormat](./AnalysisSynonymFormat.md) | Sets the synonym rules format. | +| `lenient` | boolean | If `true` ignores errors while parsing the synonym rules. It is important to note that only those synonym rules which cannot get parsed are ignored. Defaults to the value of the `updateable` setting. | +| `synonyms_path` | string | Used to provide a synonym file. This path must be absolute or relative to the `config` location. | +| `synonyms_set` | string | Provide a synonym set created via Synonyms Management APIs. | +| `synonyms` | string[] | Used to define inline synonyms. | +| `tokenizer` | string | Controls the tokenizers that will be used to tokenize the synonym, this parameter is for backwards compatibility for indices that created before 6.0. | +| `updateable` | boolean | If `true` allows reloading search analyzers to pick up changes to synonym files. Only to be used for search analyzers. Defaults to `false`. | diff --git a/docs/reference/api/AnalysisThaiAnalyzer.md b/docs/reference/api/AnalysisThaiAnalyzer.md new file mode 100644 index 000000000..8e9dc4f56 --- /dev/null +++ b/docs/reference/api/AnalysisThaiAnalyzer.md @@ -0,0 +1,7 @@ +## Interface `AnalysisThaiAnalyzer` + +| Name | Type | Description | +| - | - | - | +| `stopwords_path` | string |   | +| `stopwords` | [AnalysisStopWords](./AnalysisStopWords.md) |   | +| `type` | 'thai' |   | diff --git a/docs/reference/api/AnalysisThaiTokenizer.md b/docs/reference/api/AnalysisThaiTokenizer.md new file mode 100644 index 000000000..2a54cc01d --- /dev/null +++ b/docs/reference/api/AnalysisThaiTokenizer.md @@ -0,0 +1,5 @@ +## Interface `AnalysisThaiTokenizer` + +| Name | Type | Description | +| - | - | - | +| `type` | 'thai' |   | diff --git a/docs/reference/api/AnalysisTokenChar.md b/docs/reference/api/AnalysisTokenChar.md new file mode 100644 index 000000000..12d9d3cb7 --- /dev/null +++ b/docs/reference/api/AnalysisTokenChar.md @@ -0,0 +1,4 @@ +## `AnalysisTokenChar` +::: +type AnalysisTokenChar = 'letter' | 'digit' | 'whitespace' | 'punctuation' | 'symbol' | 'custom'; +::: diff --git a/docs/reference/api/AnalysisTokenFilter.md b/docs/reference/api/AnalysisTokenFilter.md new file mode 100644 index 000000000..7a643b4c3 --- /dev/null +++ b/docs/reference/api/AnalysisTokenFilter.md @@ -0,0 +1,4 @@ +## `AnalysisTokenFilter` +::: +type AnalysisTokenFilter = string | [AnalysisTokenFilterDefinition](./AnalysisTokenFilterDefinition.md); +::: diff --git a/docs/reference/api/AnalysisTokenFilterBase.md b/docs/reference/api/AnalysisTokenFilterBase.md new file mode 100644 index 000000000..50128e97c --- /dev/null +++ b/docs/reference/api/AnalysisTokenFilterBase.md @@ -0,0 +1,5 @@ +## Interface `AnalysisTokenFilterBase` + +| Name | Type | Description | +| - | - | - | +| `version` | [VersionString](./VersionString.md) |   | diff --git a/docs/reference/api/AnalysisTokenFilterDefinition.md b/docs/reference/api/AnalysisTokenFilterDefinition.md new file mode 100644 index 000000000..cb6967659 --- /dev/null +++ b/docs/reference/api/AnalysisTokenFilterDefinition.md @@ -0,0 +1,4 @@ +## `AnalysisTokenFilterDefinition` +::: +type AnalysisTokenFilterDefinition = [AnalysisApostropheTokenFilter](./AnalysisApostropheTokenFilter.md) | [AnalysisArabicNormalizationTokenFilter](./AnalysisArabicNormalizationTokenFilter.md) | [AnalysisAsciiFoldingTokenFilter](./AnalysisAsciiFoldingTokenFilter.md) | [AnalysisCjkBigramTokenFilter](./AnalysisCjkBigramTokenFilter.md) | [AnalysisCjkWidthTokenFilter](./AnalysisCjkWidthTokenFilter.md) | [AnalysisClassicTokenFilter](./AnalysisClassicTokenFilter.md) | [AnalysisCommonGramsTokenFilter](./AnalysisCommonGramsTokenFilter.md) | [AnalysisConditionTokenFilter](./AnalysisConditionTokenFilter.md) | [AnalysisDecimalDigitTokenFilter](./AnalysisDecimalDigitTokenFilter.md) | [AnalysisDelimitedPayloadTokenFilter](./AnalysisDelimitedPayloadTokenFilter.md) | [AnalysisEdgeNGramTokenFilter](./AnalysisEdgeNGramTokenFilter.md) | [AnalysisElisionTokenFilter](./AnalysisElisionTokenFilter.md) | [AnalysisFingerprintTokenFilter](./AnalysisFingerprintTokenFilter.md) | [AnalysisFlattenGraphTokenFilter](./AnalysisFlattenGraphTokenFilter.md) | [AnalysisGermanNormalizationTokenFilter](./AnalysisGermanNormalizationTokenFilter.md) | [AnalysisHindiNormalizationTokenFilter](./AnalysisHindiNormalizationTokenFilter.md) | [AnalysisHunspellTokenFilter](./AnalysisHunspellTokenFilter.md) | [AnalysisHyphenationDecompounderTokenFilter](./AnalysisHyphenationDecompounderTokenFilter.md) | [AnalysisIndicNormalizationTokenFilter](./AnalysisIndicNormalizationTokenFilter.md) | [AnalysisKeepTypesTokenFilter](./AnalysisKeepTypesTokenFilter.md) | [AnalysisKeepWordsTokenFilter](./AnalysisKeepWordsTokenFilter.md) | [AnalysisKeywordMarkerTokenFilter](./AnalysisKeywordMarkerTokenFilter.md) | [AnalysisKeywordRepeatTokenFilter](./AnalysisKeywordRepeatTokenFilter.md) | [AnalysisKStemTokenFilter](./AnalysisKStemTokenFilter.md) | [AnalysisLengthTokenFilter](./AnalysisLengthTokenFilter.md) | [AnalysisLimitTokenCountTokenFilter](./AnalysisLimitTokenCountTokenFilter.md) | [AnalysisLowercaseTokenFilter](./AnalysisLowercaseTokenFilter.md) | [AnalysisMinHashTokenFilter](./AnalysisMinHashTokenFilter.md) | [AnalysisMultiplexerTokenFilter](./AnalysisMultiplexerTokenFilter.md) | [AnalysisNGramTokenFilter](./AnalysisNGramTokenFilter.md) | [AnalysisNoriPartOfSpeechTokenFilter](./AnalysisNoriPartOfSpeechTokenFilter.md) | [AnalysisPatternCaptureTokenFilter](./AnalysisPatternCaptureTokenFilter.md) | [AnalysisPatternReplaceTokenFilter](./AnalysisPatternReplaceTokenFilter.md) | [AnalysisPersianNormalizationTokenFilter](./AnalysisPersianNormalizationTokenFilter.md) | [AnalysisPorterStemTokenFilter](./AnalysisPorterStemTokenFilter.md) | [AnalysisPredicateTokenFilter](./AnalysisPredicateTokenFilter.md) | [AnalysisRemoveDuplicatesTokenFilter](./AnalysisRemoveDuplicatesTokenFilter.md) | [AnalysisReverseTokenFilter](./AnalysisReverseTokenFilter.md) | [AnalysisScandinavianFoldingTokenFilter](./AnalysisScandinavianFoldingTokenFilter.md) | [AnalysisScandinavianNormalizationTokenFilter](./AnalysisScandinavianNormalizationTokenFilter.md) | [AnalysisSerbianNormalizationTokenFilter](./AnalysisSerbianNormalizationTokenFilter.md) | [AnalysisShingleTokenFilter](./AnalysisShingleTokenFilter.md) | [AnalysisSnowballTokenFilter](./AnalysisSnowballTokenFilter.md) | [AnalysisSoraniNormalizationTokenFilter](./AnalysisSoraniNormalizationTokenFilter.md) | [AnalysisStemmerOverrideTokenFilter](./AnalysisStemmerOverrideTokenFilter.md) | [AnalysisStemmerTokenFilter](./AnalysisStemmerTokenFilter.md) | [AnalysisStopTokenFilter](./AnalysisStopTokenFilter.md) | [AnalysisSynonymGraphTokenFilter](./AnalysisSynonymGraphTokenFilter.md) | [AnalysisSynonymTokenFilter](./AnalysisSynonymTokenFilter.md) | [AnalysisTrimTokenFilter](./AnalysisTrimTokenFilter.md) | [AnalysisTruncateTokenFilter](./AnalysisTruncateTokenFilter.md) | [AnalysisUniqueTokenFilter](./AnalysisUniqueTokenFilter.md) | [AnalysisUppercaseTokenFilter](./AnalysisUppercaseTokenFilter.md) | [AnalysisWordDelimiterGraphTokenFilter](./AnalysisWordDelimiterGraphTokenFilter.md) | [AnalysisWordDelimiterTokenFilter](./AnalysisWordDelimiterTokenFilter.md) | [AnalysisJaStopTokenFilter](./AnalysisJaStopTokenFilter.md) | [AnalysisKuromojiStemmerTokenFilter](./AnalysisKuromojiStemmerTokenFilter.md) | [AnalysisKuromojiReadingFormTokenFilter](./AnalysisKuromojiReadingFormTokenFilter.md) | [AnalysisKuromojiPartOfSpeechTokenFilter](./AnalysisKuromojiPartOfSpeechTokenFilter.md) | [AnalysisIcuCollationTokenFilter](./AnalysisIcuCollationTokenFilter.md) | [AnalysisIcuFoldingTokenFilter](./AnalysisIcuFoldingTokenFilter.md) | [AnalysisIcuNormalizationTokenFilter](./AnalysisIcuNormalizationTokenFilter.md) | [AnalysisIcuTransformTokenFilter](./AnalysisIcuTransformTokenFilter.md) | [AnalysisPhoneticTokenFilter](./AnalysisPhoneticTokenFilter.md) | [AnalysisDictionaryDecompounderTokenFilter](./AnalysisDictionaryDecompounderTokenFilter.md); +::: diff --git a/docs/reference/api/AnalysisTokenizer.md b/docs/reference/api/AnalysisTokenizer.md new file mode 100644 index 000000000..e58b579f7 --- /dev/null +++ b/docs/reference/api/AnalysisTokenizer.md @@ -0,0 +1,4 @@ +## `AnalysisTokenizer` +::: +type AnalysisTokenizer = string | [AnalysisTokenizerDefinition](./AnalysisTokenizerDefinition.md); +::: diff --git a/docs/reference/api/AnalysisTokenizerBase.md b/docs/reference/api/AnalysisTokenizerBase.md new file mode 100644 index 000000000..aa56f40c6 --- /dev/null +++ b/docs/reference/api/AnalysisTokenizerBase.md @@ -0,0 +1,5 @@ +## Interface `AnalysisTokenizerBase` + +| Name | Type | Description | +| - | - | - | +| `version` | [VersionString](./VersionString.md) |   | diff --git a/docs/reference/api/AnalysisTokenizerDefinition.md b/docs/reference/api/AnalysisTokenizerDefinition.md new file mode 100644 index 000000000..b1ccf089a --- /dev/null +++ b/docs/reference/api/AnalysisTokenizerDefinition.md @@ -0,0 +1,4 @@ +## `AnalysisTokenizerDefinition` +::: +type AnalysisTokenizerDefinition = [AnalysisCharGroupTokenizer](./AnalysisCharGroupTokenizer.md) | [AnalysisClassicTokenizer](./AnalysisClassicTokenizer.md) | [AnalysisEdgeNGramTokenizer](./AnalysisEdgeNGramTokenizer.md) | [AnalysisKeywordTokenizer](./AnalysisKeywordTokenizer.md) | [AnalysisLetterTokenizer](./AnalysisLetterTokenizer.md) | [AnalysisLowercaseTokenizer](./AnalysisLowercaseTokenizer.md) | [AnalysisNGramTokenizer](./AnalysisNGramTokenizer.md) | [AnalysisPathHierarchyTokenizer](./AnalysisPathHierarchyTokenizer.md) | [AnalysisPatternTokenizer](./AnalysisPatternTokenizer.md) | [AnalysisSimplePatternTokenizer](./AnalysisSimplePatternTokenizer.md) | [AnalysisSimplePatternSplitTokenizer](./AnalysisSimplePatternSplitTokenizer.md) | [AnalysisStandardTokenizer](./AnalysisStandardTokenizer.md) | [AnalysisThaiTokenizer](./AnalysisThaiTokenizer.md) | [AnalysisUaxEmailUrlTokenizer](./AnalysisUaxEmailUrlTokenizer.md) | [AnalysisWhitespaceTokenizer](./AnalysisWhitespaceTokenizer.md) | [AnalysisIcuTokenizer](./AnalysisIcuTokenizer.md) | [AnalysisKuromojiTokenizer](./AnalysisKuromojiTokenizer.md) | [AnalysisNoriTokenizer](./AnalysisNoriTokenizer.md); +::: diff --git a/docs/reference/api/AnalysisTrimTokenFilter.md b/docs/reference/api/AnalysisTrimTokenFilter.md new file mode 100644 index 000000000..5710e7eca --- /dev/null +++ b/docs/reference/api/AnalysisTrimTokenFilter.md @@ -0,0 +1,5 @@ +## Interface `AnalysisTrimTokenFilter` + +| Name | Type | Description | +| - | - | - | +| `type` | 'trim' |   | diff --git a/docs/reference/api/AnalysisTruncateTokenFilter.md b/docs/reference/api/AnalysisTruncateTokenFilter.md new file mode 100644 index 000000000..bcd8dcc8d --- /dev/null +++ b/docs/reference/api/AnalysisTruncateTokenFilter.md @@ -0,0 +1,6 @@ +## Interface `AnalysisTruncateTokenFilter` + +| Name | Type | Description | +| - | - | - | +| `length` | [integer](./integer.md) | Character limit for each token. Tokens exceeding this limit are truncated. Defaults to `10`. | +| `type` | 'truncate' |   | diff --git a/docs/reference/api/AnalysisTurkishAnalyzer.md b/docs/reference/api/AnalysisTurkishAnalyzer.md new file mode 100644 index 000000000..6a7c7def0 --- /dev/null +++ b/docs/reference/api/AnalysisTurkishAnalyzer.md @@ -0,0 +1,8 @@ +## Interface `AnalysisTurkishAnalyzer` + +| Name | Type | Description | +| - | - | - | +| `stem_exclusion` | string[] |   | +| `stopwords_path` | string |   | +| `stopwords` | [AnalysisStopWords](./AnalysisStopWords.md) |   | +| `type` | 'turkish' |   | diff --git a/docs/reference/api/AnalysisUaxEmailUrlTokenizer.md b/docs/reference/api/AnalysisUaxEmailUrlTokenizer.md new file mode 100644 index 000000000..4ebe87e3c --- /dev/null +++ b/docs/reference/api/AnalysisUaxEmailUrlTokenizer.md @@ -0,0 +1,6 @@ +## Interface `AnalysisUaxEmailUrlTokenizer` + +| Name | Type | Description | +| - | - | - | +| `max_token_length` | [integer](./integer.md) |   | +| `type` | 'uax_url_email' |   | diff --git a/docs/reference/api/AnalysisUniqueTokenFilter.md b/docs/reference/api/AnalysisUniqueTokenFilter.md new file mode 100644 index 000000000..7af8d753f --- /dev/null +++ b/docs/reference/api/AnalysisUniqueTokenFilter.md @@ -0,0 +1,6 @@ +## Interface `AnalysisUniqueTokenFilter` + +| Name | Type | Description | +| - | - | - | +| `only_on_same_position` | boolean | If `true`, only remove duplicate tokens in the same position. Defaults to `false`. | +| `type` | 'unique' |   | diff --git a/docs/reference/api/AnalysisUppercaseTokenFilter.md b/docs/reference/api/AnalysisUppercaseTokenFilter.md new file mode 100644 index 000000000..0c98b42ae --- /dev/null +++ b/docs/reference/api/AnalysisUppercaseTokenFilter.md @@ -0,0 +1,5 @@ +## Interface `AnalysisUppercaseTokenFilter` + +| Name | Type | Description | +| - | - | - | +| `type` | 'uppercase' |   | diff --git a/docs/reference/api/AnalysisWhitespaceAnalyzer.md b/docs/reference/api/AnalysisWhitespaceAnalyzer.md new file mode 100644 index 000000000..44591f5f7 --- /dev/null +++ b/docs/reference/api/AnalysisWhitespaceAnalyzer.md @@ -0,0 +1,6 @@ +## Interface `AnalysisWhitespaceAnalyzer` + +| Name | Type | Description | +| - | - | - | +| `type` | 'whitespace' |   | +| `version` | [VersionString](./VersionString.md) |   | diff --git a/docs/reference/api/AnalysisWhitespaceTokenizer.md b/docs/reference/api/AnalysisWhitespaceTokenizer.md new file mode 100644 index 000000000..8e88297e1 --- /dev/null +++ b/docs/reference/api/AnalysisWhitespaceTokenizer.md @@ -0,0 +1,6 @@ +## Interface `AnalysisWhitespaceTokenizer` + +| Name | Type | Description | +| - | - | - | +| `max_token_length` | [integer](./integer.md) |   | +| `type` | 'whitespace' |   | diff --git a/docs/reference/api/AnalysisWordDelimiterGraphTokenFilter.md b/docs/reference/api/AnalysisWordDelimiterGraphTokenFilter.md new file mode 100644 index 000000000..11ad43457 --- /dev/null +++ b/docs/reference/api/AnalysisWordDelimiterGraphTokenFilter.md @@ -0,0 +1,7 @@ +## Interface `AnalysisWordDelimiterGraphTokenFilter` + +| Name | Type | Description | +| - | - | - | +| `adjust_offsets` | boolean | If `true`, the filter adjusts the offsets of split or catenated tokens to better reflect their actual position in the token stream. Defaults to `true`. | +| `ignore_keywords` | boolean | If `true`, the filter skips tokens with a keyword attribute of true. Defaults to `false`. | +| `type` | 'word_delimiter_graph' |   | diff --git a/docs/reference/api/AnalysisWordDelimiterTokenFilter.md b/docs/reference/api/AnalysisWordDelimiterTokenFilter.md new file mode 100644 index 000000000..2b4e75666 --- /dev/null +++ b/docs/reference/api/AnalysisWordDelimiterTokenFilter.md @@ -0,0 +1,5 @@ +## Interface `AnalysisWordDelimiterTokenFilter` + +| Name | Type | Description | +| - | - | - | +| `type` | 'word_delimiter' |   | diff --git a/docs/reference/api/AnalysisWordDelimiterTokenFilterBase.md b/docs/reference/api/AnalysisWordDelimiterTokenFilterBase.md new file mode 100644 index 000000000..694ffe351 --- /dev/null +++ b/docs/reference/api/AnalysisWordDelimiterTokenFilterBase.md @@ -0,0 +1,17 @@ +## Interface `AnalysisWordDelimiterTokenFilterBase` + +| Name | Type | Description | +| - | - | - | +| `catenate_all` | boolean | If `true`, the filter produces catenated tokens for chains of alphanumeric characters separated by non-alphabetic delimiters. Defaults to `false`. | +| `catenate_numbers` | boolean | If `true`, the filter produces catenated tokens for chains of numeric characters separated by non-alphabetic delimiters. Defaults to `false`. | +| `catenate_words` | boolean | If `true`, the filter produces catenated tokens for chains of alphabetical characters separated by non-alphabetic delimiters. Defaults to `false`. | +| `generate_number_parts` | boolean | If `true`, the filter includes tokens consisting of only numeric characters in the output. If `false`, the filter excludes these tokens from the output. Defaults to `true`. | +| `generate_word_parts` | boolean | If `true`, the filter includes tokens consisting of only alphabetical characters in the output. If `false`, the filter excludes these tokens from the output. Defaults to `true`. | +| `preserve_original` | [SpecUtilsStringified](./SpecUtilsStringified.md) | If `true`, the filter includes the original version of any split tokens in the output. This original version includes non-alphanumeric delimiters. Defaults to `false`. | +| `protected_words_path` | string | Path to a file that contains a list of tokens the filter won’t split. This path must be absolute or relative to the `config` location, and the file must be UTF-8 encoded. Each token in the file must be separated by a line break. | +| `protected_words` | string[] | Array of tokens the filter won’t split. | +| `split_on_case_change` | boolean | If `true`, the filter splits tokens at letter case transitions. For example: camelCase - > [ camel, Case ]. Defaults to `true`. | +| `split_on_numerics` | boolean | If `true`, the filter splits tokens at letter-number transitions. For example: j2se - > [ j, 2, se ]. Defaults to `true`. | +| `stem_english_possessive` | boolean | If `true`, the filter removes the English possessive ( `'s`) from the end of each token. For example: O'Neil's - > [ O, Neil ]. Defaults to `true`. | +| `type_table_path` | string | Path to a file that contains custom type mappings for characters. This allows you to map non-alphanumeric characters as numeric or alphanumeric to avoid splitting on those characters. | +| `type_table` | string[] | Array of custom type mappings for characters. This allows you to map non-alphanumeric characters as numeric or alphanumeric to avoid splitting on those characters. | diff --git a/docs/reference/api/AsyncSearch.md b/docs/reference/api/AsyncSearch.md new file mode 100644 index 000000000..bc704c4bc --- /dev/null +++ b/docs/reference/api/AsyncSearch.md @@ -0,0 +1,20 @@ +## `AsyncSearch` + +### Constructor + +::: +new AsyncSearch(transport: [Transport](./Transport.md)); +::: + +### Properties + +| Name | Type | Description | +| - | - | - | +| `acceptedParams` | Record |   | +| `transport` | [Transport](./Transport.md) |   | + +### Methods + +| Name | Signature | Description | +| - | - | - | +| `delete` | `delete(this: [That](./That.md), params: [AsyncSearchDeleteRequest](./AsyncSearchDeleteRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[AsyncSearchDeleteResponse](./AsyncSearchDeleteResponse.md)>;` | Delete an async search. If the asynchronous search is still running, it is cancelled. Otherwise, the saved search results are deleted. If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the `cancel_task` cluster privilege. || `delete` | `delete(this: [That](./That.md), params: [AsyncSearchDeleteRequest](./AsyncSearchDeleteRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[AsyncSearchDeleteResponse](./AsyncSearchDeleteResponse.md), unknown>>;` |   || `delete` | `delete(this: [That](./That.md), params: [AsyncSearchDeleteRequest](./AsyncSearchDeleteRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[AsyncSearchDeleteResponse](./AsyncSearchDeleteResponse.md)>;` |   || `get` | `get>(this: [That](./That.md), params: [AsyncSearchGetRequest](./AsyncSearchGetRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[AsyncSearchGetResponse](./AsyncSearchGetResponse.md)>;` | Get async search results. Retrieve the results of a previously submitted asynchronous search request. If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it. || `get` | `get>(this: [That](./That.md), params: [AsyncSearchGetRequest](./AsyncSearchGetRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[AsyncSearchGetResponse](./AsyncSearchGetResponse.md), unknown>>;` |   || `get` | `get>(this: [That](./That.md), params: [AsyncSearchGetRequest](./AsyncSearchGetRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[AsyncSearchGetResponse](./AsyncSearchGetResponse.md)>;` |   || `status` | `status(this: [That](./That.md), params: [AsyncSearchStatusRequest](./AsyncSearchStatusRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[AsyncSearchStatusResponse](./AsyncSearchStatusResponse.md)>;` | Get the async search status. Get the status of a previously submitted async search request given its identifier, without retrieving search results. If the Elasticsearch security features are enabled, the access to the status of a specific async search is restricted to: * The user or API key that submitted the original async search request. * Users that have the `monitor` cluster privilege or greater privileges. || `status` | `status(this: [That](./That.md), params: [AsyncSearchStatusRequest](./AsyncSearchStatusRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[AsyncSearchStatusResponse](./AsyncSearchStatusResponse.md), unknown>>;` |   || `status` | `status(this: [That](./That.md), params: [AsyncSearchStatusRequest](./AsyncSearchStatusRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[AsyncSearchStatusResponse](./AsyncSearchStatusResponse.md)>;` |   || `submit` | `submit>(this: [That](./That.md), params?: [AsyncSearchSubmitRequest](./AsyncSearchSubmitRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[AsyncSearchSubmitResponse](./AsyncSearchSubmitResponse.md)>;` | Run an async search. When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field. Partial results become available following the sort criteria that was requested. Warning: Asynchronous search does not support scroll or search requests that include only the suggest section. By default, Elasticsearch does not allow you to store an async search response larger than 10Mb and an attempt to do this results in an error. The maximum allowed size for a stored async search response can be set by changing the `search.max_async_search_response_size` cluster level setting. || `submit` | `submit>(this: [That](./That.md), params?: [AsyncSearchSubmitRequest](./AsyncSearchSubmitRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[AsyncSearchSubmitResponse](./AsyncSearchSubmitResponse.md), unknown>>;` |   || `submit` | `submit>(this: [That](./That.md), params?: [AsyncSearchSubmitRequest](./AsyncSearchSubmitRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[AsyncSearchSubmitResponse](./AsyncSearchSubmitResponse.md)>;` |   | \ No newline at end of file diff --git a/docs/reference/api/AsyncSearchAsyncSearch.md b/docs/reference/api/AsyncSearchAsyncSearch.md new file mode 100644 index 000000000..b5f8dd8ce --- /dev/null +++ b/docs/reference/api/AsyncSearchAsyncSearch.md @@ -0,0 +1,18 @@ +## Interface `AsyncSearchAsyncSearch` + +| Name | Type | Description | +| - | - | - | +| `_clusters` | [ClusterStatistics](./ClusterStatistics.md) |   | +| `_scroll_id` | [ScrollId](./ScrollId.md) |   | +| `_shards` | [ShardStatistics](./ShardStatistics.md) | Indicates how many shards have run the query. Note that in order for shard results to be included in the search response, they need to be reduced first. | +| `aggregations` | TAggregations | Partial aggregations results, coming from the shards that have already completed running the query. | +| `fields` | Record |   | +| `hits` | [SearchHitsMetadata](./SearchHitsMetadata.md) |   | +| `max_score` | [double](./double.md) |   | +| `num_reduce_phases` | [long](./long.md) | Indicates how many reductions of the results have been performed. If this number increases compared to the last retrieved results for a get asynch search request, you can expect additional results included in the search response. | +| `pit_id` | [Id](./Id.md) |   | +| `profile` | [SearchProfile](./SearchProfile.md) |   | +| `suggest` | Record<[SuggestionName](./SuggestionName.md), [SearchSuggest](./SearchSuggest.md)[]> |   | +| `terminated_early` | boolean |   | +| `timed_out` | boolean |   | +| `took` | [long](./long.md) |   | diff --git a/docs/reference/api/AsyncSearchAsyncSearchDocumentResponseBase.md b/docs/reference/api/AsyncSearchAsyncSearchDocumentResponseBase.md new file mode 100644 index 000000000..b0f1ac3a1 --- /dev/null +++ b/docs/reference/api/AsyncSearchAsyncSearchDocumentResponseBase.md @@ -0,0 +1,5 @@ +## Interface `AsyncSearchAsyncSearchDocumentResponseBase` + +| Name | Type | Description | +| - | - | - | +| `response` | [AsyncSearchAsyncSearch](./AsyncSearchAsyncSearch.md) |   | diff --git a/docs/reference/api/AsyncSearchAsyncSearchResponseBase.md b/docs/reference/api/AsyncSearchAsyncSearchResponseBase.md new file mode 100644 index 000000000..a52268c55 --- /dev/null +++ b/docs/reference/api/AsyncSearchAsyncSearchResponseBase.md @@ -0,0 +1,13 @@ +## Interface `AsyncSearchAsyncSearchResponseBase` + +| Name | Type | Description | +| - | - | - | +| `completion_time_in_millis` | [EpochTime](./EpochTime.md)<[UnitMillis](./UnitMillis.md)> |   | +| `completion_time` | [DateTime](./DateTime.md) | Indicates when the async search completed. It is present only when the search has completed. | +| `expiration_time_in_millis` | [EpochTime](./EpochTime.md)<[UnitMillis](./UnitMillis.md)> |   | +| `expiration_time` | [DateTime](./DateTime.md) | Indicates when the async search will expire. | +| `id` | [Id](./Id.md) |   | +| `is_partial` | boolean | When the query is no longer running, this property indicates whether the search failed or was successfully completed on all shards. While the query is running, `is_partial` is always set to `true`. | +| `is_running` | boolean | Indicates whether the search is still running or has completed. > info > If the search failed after some shards returned their results or the node that is coordinating the async search dies, results may be partial even though `is_running` is `false`. | +| `start_time_in_millis` | [EpochTime](./EpochTime.md)<[UnitMillis](./UnitMillis.md)> |   | +| `start_time` | [DateTime](./DateTime.md) |   | diff --git a/docs/reference/api/AsyncSearchDeleteRequest.md b/docs/reference/api/AsyncSearchDeleteRequest.md new file mode 100644 index 000000000..ef6cf0679 --- /dev/null +++ b/docs/reference/api/AsyncSearchDeleteRequest.md @@ -0,0 +1,7 @@ +## Interface `AsyncSearchDeleteRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { id?: never; }) | All values in `body` will be added to the request body. | +| `id` | [Id](./Id.md) | A unique identifier for the async search. | +| `querystring` | { [key: string]: any; } & { id?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/AsyncSearchDeleteResponse.md b/docs/reference/api/AsyncSearchDeleteResponse.md new file mode 100644 index 000000000..67e2ecf96 --- /dev/null +++ b/docs/reference/api/AsyncSearchDeleteResponse.md @@ -0,0 +1,4 @@ +## `AsyncSearchDeleteResponse` +::: +type AsyncSearchDeleteResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); +::: diff --git a/docs/reference/api/AsyncSearchGetRequest.md b/docs/reference/api/AsyncSearchGetRequest.md new file mode 100644 index 000000000..2d3619686 --- /dev/null +++ b/docs/reference/api/AsyncSearchGetRequest.md @@ -0,0 +1,10 @@ +## Interface `AsyncSearchGetRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { id?: never; keep_alive?: never; typed_keys?: never; wait_for_completion_timeout?: never; }) | All values in `body` will be added to the request body. | +| `id` | [Id](./Id.md) | A unique identifier for the async search. | +| `keep_alive` | [Duration](./Duration.md) | The length of time that the async search should be available in the cluster. When not specified, the `keep_alive` set with the corresponding submit async request will be used. Otherwise, it is possible to override the value and extend the validity of the request. When this period expires, the search, if still running, is cancelled. If the search is completed, its saved results are deleted. | +| `querystring` | { [key: string]: any; } & { id?: never; keep_alive?: never; typed_keys?: never; wait_for_completion_timeout?: never; } | All values in `querystring` will be added to the request querystring. | +| `typed_keys` | boolean | Specify whether aggregation and suggester names should be prefixed by their respective types in the response | +| `wait_for_completion_timeout` | [Duration](./Duration.md) | Specifies to wait for the search to be completed up until the provided timeout. Final results will be returned if available before the timeout expires, otherwise the currently available results will be returned once the timeout expires. By default no timeout is set meaning that the currently available results will be returned without any additional wait. | diff --git a/docs/reference/api/AsyncSearchGetResponse.md b/docs/reference/api/AsyncSearchGetResponse.md new file mode 100644 index 000000000..4d1794ac1 --- /dev/null +++ b/docs/reference/api/AsyncSearchGetResponse.md @@ -0,0 +1,4 @@ +## `AsyncSearchGetResponse` +::: +type AsyncSearchGetResponse> = [AsyncSearchAsyncSearchDocumentResponseBase](./AsyncSearchAsyncSearchDocumentResponseBase.md); +::: diff --git a/docs/reference/api/AsyncSearchStatusRequest.md b/docs/reference/api/AsyncSearchStatusRequest.md new file mode 100644 index 000000000..53281c5ea --- /dev/null +++ b/docs/reference/api/AsyncSearchStatusRequest.md @@ -0,0 +1,8 @@ +## Interface `AsyncSearchStatusRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { id?: never; keep_alive?: never; }) | All values in `body` will be added to the request body. | +| `id` | [Id](./Id.md) | A unique identifier for the async search. | +| `keep_alive` | [Duration](./Duration.md) | The length of time that the async search needs to be available. Ongoing async searches and any saved search results are deleted after this period. | +| `querystring` | { [key: string]: any; } & { id?: never; keep_alive?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/AsyncSearchStatusResponse.md b/docs/reference/api/AsyncSearchStatusResponse.md new file mode 100644 index 000000000..f803a49f9 --- /dev/null +++ b/docs/reference/api/AsyncSearchStatusResponse.md @@ -0,0 +1,4 @@ +## `AsyncSearchStatusResponse` +::: +type AsyncSearchStatusResponse = [AsyncSearchStatusStatusResponseBase](./AsyncSearchStatusStatusResponseBase.md); +::: diff --git a/docs/reference/api/AsyncSearchStatusStatusResponseBase.md b/docs/reference/api/AsyncSearchStatusStatusResponseBase.md new file mode 100644 index 000000000..4a371f062 --- /dev/null +++ b/docs/reference/api/AsyncSearchStatusStatusResponseBase.md @@ -0,0 +1,7 @@ +## Interface `AsyncSearchStatusStatusResponseBase` + +| Name | Type | Description | +| - | - | - | +| `_clusters` | [ClusterStatistics](./ClusterStatistics.md) | Metadata about clusters involved in the cross-cluster search. It is not shown for local-only searches. | +| `_shards` | [ShardStatistics](./ShardStatistics.md) | The number of shards that have run the query so far. | +| `completion_status` | [integer](./integer.md) | If the async search completed, this field shows the status code of the search. For example, `200` indicates that the async search was successfully completed. `503` indicates that the async search was completed with an error. | diff --git a/docs/reference/api/AsyncSearchSubmitRequest.md b/docs/reference/api/AsyncSearchSubmitRequest.md new file mode 100644 index 000000000..63d95b6af --- /dev/null +++ b/docs/reference/api/AsyncSearchSubmitRequest.md @@ -0,0 +1,69 @@ +## Interface `AsyncSearchSubmitRequest` + +| Name | Type | Description | +| - | - | - | +| `_source_excludes` | [Fields](./Fields.md) | A list of fields to exclude from the returned _source field | +| `_source_includes` | [Fields](./Fields.md) | A list of fields to extract and return from the _source field | +| `_source` | [SearchSourceConfig](./SearchSourceConfig.md) | Indicates which source fields are returned for matching documents. These fields are returned in the hits._source property of the search response. | +| `aggregations` | Record |   | +| `aggs` | Record | aggregations | +| `allow_no_indices` | boolean | Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) | +| `allow_partial_search_results` | boolean | Indicate if an error should be returned if there is a partial search failure or timeout | +| `analyze_wildcard` | boolean | Specify whether wildcard and prefix queries should be analyzed (default: false) | +| `analyzer` | string | The analyzer to use for the query string | +| `batched_reduce_size` | [long](./long.md) | Affects how often partial results become available, which happens whenever shard results are reduced. A partial reduction is performed every time the coordinating node has received a certain number of new shard responses (5 by default). | +| `body` | string | ({ [key: string]: any; } & { index?: never; wait_for_completion_timeout?: never; keep_alive?: never; keep_on_completion?: never; allow_no_indices?: never; allow_partial_search_results?: never; analyzer?: never; analyze_wildcard?: never; batched_reduce_size?: never; ccs_minimize_roundtrips?: never; default_operator?: never; df?: never; expand_wildcards?: never; ignore_throttled?: never; ignore_unavailable?: never; lenient?: never; max_concurrent_shard_requests?: never; preference?: never; request_cache?: never; routing?: never; search_type?: never; suggest_field?: never; suggest_mode?: never; suggest_size?: never; suggest_text?: never; typed_keys?: never; rest_total_hits_as_int?: never; _source_excludes?: never; _source_includes?: never; q?: never; aggregations?: never; aggs?: never; collapse?: never; explain?: never; ext?: never; from?: never; highlight?: never; track_total_hits?: never; indices_boost?: never; docvalue_fields?: never; knn?: never; min_score?: never; post_filter?: never; profile?: never; query?: never; rescore?: never; script_fields?: never; search_after?: never; size?: never; slice?: never; sort?: never; _source?: never; fields?: never; suggest?: never; terminate_after?: never; timeout?: never; track_scores?: never; version?: never; seq_no_primary_term?: never; stored_fields?: never; pit?: never; runtime_mappings?: never; stats?: never; }) | All values in `body` will be added to the request body. | +| `ccs_minimize_roundtrips` | boolean | The default value is the only supported value. | +| `collapse` | [SearchFieldCollapse](./SearchFieldCollapse.md) |   | +| `default_operator` | [QueryDslOperator](./QueryDslOperator.md) | The default operator for query string query (AND or OR) | +| `df` | string | The field to use as default where no field prefix is given in the query string | +| `docvalue_fields` | ([QueryDslFieldAndFormat](./QueryDslFieldAndFormat.md) | [Field](./Field.md))[] | Array of wildcard (*) patterns. The request returns doc values for field names matching these patterns in the hits.fields property of the response. | +| `expand_wildcards` | [ExpandWildcards](./ExpandWildcards.md) | Whether to expand wildcard expression to concrete indices that are open, closed or both. | +| `explain` | boolean | If true, returns detailed information about score computation as part of a hit. | +| `ext` | Record | Configuration of search extensions defined by Elasticsearch plugins. | +| `fields` | ([QueryDslFieldAndFormat](./QueryDslFieldAndFormat.md) | [Field](./Field.md))[] | Array of wildcard (*) patterns. The request returns values for field names matching these patterns in the hits.fields property of the response. | +| `from` | [integer](./integer.md) | Starting document offset. By default, you cannot page through more than 10,000 hits using the from and size parameters. To page through more hits, use the search_after parameter. | +| `highlight` | [SearchHighlight](./SearchHighlight.md) |   | +| `ignore_throttled` | boolean | Whether specified concrete, expanded or aliased indices should be ignored when throttled | +| `ignore_unavailable` | boolean | Whether specified concrete indices should be ignored when unavailable (missing or closed) | +| `index` | [Indices](./Indices.md) | A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices | +| `indices_boost` | [Partial](./Partial.md)>[] | Boosts the _score of documents from specified indices. | +| `keep_alive` | [Duration](./Duration.md) | Specifies how long the async search needs to be available. Ongoing async searches and any saved search results are deleted after this period. | +| `keep_on_completion` | boolean | If `true`, results are stored for later retrieval when the search completes within the `wait_for_completion_timeout`. | +| `knn` | [KnnSearch](./KnnSearch.md) | [KnnSearch](./KnnSearch.md)[] | Defines the approximate kNN search to run. | +| `lenient` | boolean | Specify whether format-based query failures (such as providing text to a numeric field) should be ignored | +| `max_concurrent_shard_requests` | [integer](./integer.md) | The number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests | +| `min_score` | [double](./double.md) | Minimum _score for matching documents. Documents with a lower _score are not included in search results and results collected by aggregations. | +| `pit` | [SearchPointInTimeReference](./SearchPointInTimeReference.md) | Limits the search to a point in time (PIT). If you provide a PIT, you cannot specify an in the request path. | +| `post_filter` | [QueryDslQueryContainer](./QueryDslQueryContainer.md) |   | +| `preference` | string | Specify the node or shard the operation should be performed on (default: random) | +| `profile` | boolean |   | +| `q` | string | Query in the Lucene query string syntax | +| `query` | [QueryDslQueryContainer](./QueryDslQueryContainer.md) | Defines the search definition using the Query DSL. | +| `querystring` | { [key: string]: any; } & { index?: never; wait_for_completion_timeout?: never; keep_alive?: never; keep_on_completion?: never; allow_no_indices?: never; allow_partial_search_results?: never; analyzer?: never; analyze_wildcard?: never; batched_reduce_size?: never; ccs_minimize_roundtrips?: never; default_operator?: never; df?: never; expand_wildcards?: never; ignore_throttled?: never; ignore_unavailable?: never; lenient?: never; max_concurrent_shard_requests?: never; preference?: never; request_cache?: never; routing?: never; search_type?: never; suggest_field?: never; suggest_mode?: never; suggest_size?: never; suggest_text?: never; typed_keys?: never; rest_total_hits_as_int?: never; _source_excludes?: never; _source_includes?: never; q?: never; aggregations?: never; aggs?: never; collapse?: never; explain?: never; ext?: never; from?: never; highlight?: never; track_total_hits?: never; indices_boost?: never; docvalue_fields?: never; knn?: never; min_score?: never; post_filter?: never; profile?: never; query?: never; rescore?: never; script_fields?: never; search_after?: never; size?: never; slice?: never; sort?: never; _source?: never; fields?: never; suggest?: never; terminate_after?: never; timeout?: never; track_scores?: never; version?: never; seq_no_primary_term?: never; stored_fields?: never; pit?: never; runtime_mappings?: never; stats?: never; } | All values in `querystring` will be added to the request querystring. | +| `request_cache` | boolean | Specify if request cache should be used for this request or not, defaults to true | +| `rescore` | [SearchRescore](./SearchRescore.md) | [SearchRescore](./SearchRescore.md)[] |   | +| `rest_total_hits_as_int` | boolean | Indicates whether hits.total should be rendered as an integer or an object in the rest search response | +| `routing` | [Routing](./Routing.md) | A comma-separated list of specific routing values | +| `runtime_mappings` | [MappingRuntimeFields](./MappingRuntimeFields.md) | Defines one or more runtime fields in the search request. These fields take precedence over mapped fields with the same name. | +| `script_fields` | Record | Retrieve a script evaluation (based on different fields) for each hit. | +| `search_after` | [SortResults](./SortResults.md) |   | +| `search_type` | [SearchType](./SearchType.md) | Search operation type | +| `seq_no_primary_term` | boolean | If true, returns sequence number and primary term of the last modification of each hit. See Optimistic concurrency control. | +| `size` | [integer](./integer.md) | The number of hits to return. By default, you cannot page through more than 10,000 hits using the from and size parameters. To page through more hits, use the search_after parameter. | +| `slice` | [SlicedScroll](./SlicedScroll.md) |   | +| `sort` | [Sort](./Sort.md) |   | +| `stats` | string[] | Stats groups to associate with the search. Each group maintains a statistics aggregation for its associated searches. You can retrieve these stats using the indices stats API. | +| `stored_fields` | [Fields](./Fields.md) | List of stored fields to return as part of a hit. If no fields are specified, no stored fields are included in the response. If this field is specified, the _source parameter defaults to false. You can pass _source: true to return both source fields and stored fields in the search response. | +| `suggest_field` | [Field](./Field.md) | Specifies which field to use for suggestions. | +| `suggest_mode` | [SuggestMode](./SuggestMode.md) | Specify suggest mode | +| `suggest_size` | [long](./long.md) | How many suggestions to return in response | +| `suggest_text` | string | The source text for which the suggestions should be returned. | +| `suggest` | [SearchSuggester](./SearchSuggester.md) |   | +| `terminate_after` | [long](./long.md) | Maximum number of documents to collect for each shard. If a query reaches this limit, Elasticsearch terminates the query early. Elasticsearch collects documents before sorting. Defaults to 0, which does not terminate query execution early. | +| `timeout` | string | Specifies the period of time to wait for a response from each shard. If no response is received before the timeout expires, the request fails and returns an error. Defaults to no timeout. | +| `track_scores` | boolean | If true, calculate and return document scores, even if the scores are not used for sorting. | +| `track_total_hits` | [SearchTrackHits](./SearchTrackHits.md) | Number of hits matching the query to count accurately. If true, the exact number of hits is returned at the cost of some performance. If false, the response does not include the total number of hits matching the query. Defaults to 10,000 hits. | +| `typed_keys` | boolean | Specify whether aggregation and suggester names should be prefixed by their respective types in the response | +| `version` | boolean | If true, returns document version as part of a hit. | +| `wait_for_completion_timeout` | [Duration](./Duration.md) | Blocks and waits until the search is completed up to a certain timeout. When the async search completes within the timeout, the response won’t include the ID as the results are not stored in the cluster. | diff --git a/docs/reference/api/AsyncSearchSubmitResponse.md b/docs/reference/api/AsyncSearchSubmitResponse.md new file mode 100644 index 000000000..dbf472039 --- /dev/null +++ b/docs/reference/api/AsyncSearchSubmitResponse.md @@ -0,0 +1,4 @@ +## `AsyncSearchSubmitResponse` +::: +type AsyncSearchSubmitResponse> = [AsyncSearchAsyncSearchDocumentResponseBase](./AsyncSearchAsyncSearchDocumentResponseBase.md); +::: diff --git a/docs/reference/api/Autoscaling.md b/docs/reference/api/Autoscaling.md new file mode 100644 index 000000000..2518f5866 --- /dev/null +++ b/docs/reference/api/Autoscaling.md @@ -0,0 +1,20 @@ +## `Autoscaling` + +### Constructor + +::: +new Autoscaling(transport: [Transport](./Transport.md)); +::: + +### Properties + +| Name | Type | Description | +| - | - | - | +| `acceptedParams` | Record |   | +| `transport` | [Transport](./Transport.md) |   | + +### Methods + +| Name | Signature | Description | +| - | - | - | +| `deleteAutoscalingPolicy` | `deleteAutoscalingPolicy(this: [That](./That.md), params: [AutoscalingDeleteAutoscalingPolicyRequest](./AutoscalingDeleteAutoscalingPolicyRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[AutoscalingDeleteAutoscalingPolicyResponse](./AutoscalingDeleteAutoscalingPolicyResponse.md)>;` | Delete an autoscaling policy. NOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported. || `deleteAutoscalingPolicy` | `deleteAutoscalingPolicy(this: [That](./That.md), params: [AutoscalingDeleteAutoscalingPolicyRequest](./AutoscalingDeleteAutoscalingPolicyRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[AutoscalingDeleteAutoscalingPolicyResponse](./AutoscalingDeleteAutoscalingPolicyResponse.md), unknown>>;` |   || `deleteAutoscalingPolicy` | `deleteAutoscalingPolicy(this: [That](./That.md), params: [AutoscalingDeleteAutoscalingPolicyRequest](./AutoscalingDeleteAutoscalingPolicyRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[AutoscalingDeleteAutoscalingPolicyResponse](./AutoscalingDeleteAutoscalingPolicyResponse.md)>;` |   || `getAutoscalingCapacity` | `getAutoscalingCapacity(this: [That](./That.md), params?: [AutoscalingGetAutoscalingCapacityRequest](./AutoscalingGetAutoscalingCapacityRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[AutoscalingGetAutoscalingCapacityResponse](./AutoscalingGetAutoscalingCapacityResponse.md)>;` | Get the autoscaling capacity. NOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported. This API gets the current autoscaling capacity based on the configured autoscaling policy. It will return information to size the cluster appropriately to the current workload. The `required_capacity` is calculated as the maximum of the `required_capacity` result of all individual deciders that are enabled for the policy. The operator should verify that the `current_nodes` match the operator’s knowledge of the cluster to avoid making autoscaling decisions based on stale or incomplete information. The response contains decider-specific information you can use to diagnose how and why autoscaling determined a certain capacity was required. This information is provided for diagnosis only. Do not use this information to make autoscaling decisions. || `getAutoscalingCapacity` | `getAutoscalingCapacity(this: [That](./That.md), params?: [AutoscalingGetAutoscalingCapacityRequest](./AutoscalingGetAutoscalingCapacityRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[AutoscalingGetAutoscalingCapacityResponse](./AutoscalingGetAutoscalingCapacityResponse.md), unknown>>;` |   || `getAutoscalingCapacity` | `getAutoscalingCapacity(this: [That](./That.md), params?: [AutoscalingGetAutoscalingCapacityRequest](./AutoscalingGetAutoscalingCapacityRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[AutoscalingGetAutoscalingCapacityResponse](./AutoscalingGetAutoscalingCapacityResponse.md)>;` |   || `getAutoscalingPolicy` | `getAutoscalingPolicy(this: [That](./That.md), params: [AutoscalingGetAutoscalingPolicyRequest](./AutoscalingGetAutoscalingPolicyRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[AutoscalingGetAutoscalingPolicyResponse](./AutoscalingGetAutoscalingPolicyResponse.md)>;` | Get an autoscaling policy. NOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported. || `getAutoscalingPolicy` | `getAutoscalingPolicy(this: [That](./That.md), params: [AutoscalingGetAutoscalingPolicyRequest](./AutoscalingGetAutoscalingPolicyRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[AutoscalingGetAutoscalingPolicyResponse](./AutoscalingGetAutoscalingPolicyResponse.md), unknown>>;` |   || `getAutoscalingPolicy` | `getAutoscalingPolicy(this: [That](./That.md), params: [AutoscalingGetAutoscalingPolicyRequest](./AutoscalingGetAutoscalingPolicyRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[AutoscalingGetAutoscalingPolicyResponse](./AutoscalingGetAutoscalingPolicyResponse.md)>;` |   || `putAutoscalingPolicy` | `putAutoscalingPolicy(this: [That](./That.md), params: [AutoscalingPutAutoscalingPolicyRequest](./AutoscalingPutAutoscalingPolicyRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[AutoscalingPutAutoscalingPolicyResponse](./AutoscalingPutAutoscalingPolicyResponse.md)>;` | Create or update an autoscaling policy. NOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported. || `putAutoscalingPolicy` | `putAutoscalingPolicy(this: [That](./That.md), params: [AutoscalingPutAutoscalingPolicyRequest](./AutoscalingPutAutoscalingPolicyRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[AutoscalingPutAutoscalingPolicyResponse](./AutoscalingPutAutoscalingPolicyResponse.md), unknown>>;` |   || `putAutoscalingPolicy` | `putAutoscalingPolicy(this: [That](./That.md), params: [AutoscalingPutAutoscalingPolicyRequest](./AutoscalingPutAutoscalingPolicyRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[AutoscalingPutAutoscalingPolicyResponse](./AutoscalingPutAutoscalingPolicyResponse.md)>;` |   | \ No newline at end of file diff --git a/docs/reference/api/AutoscalingAutoscalingPolicy.md b/docs/reference/api/AutoscalingAutoscalingPolicy.md new file mode 100644 index 000000000..634c2fa7b --- /dev/null +++ b/docs/reference/api/AutoscalingAutoscalingPolicy.md @@ -0,0 +1,6 @@ +## Interface `AutoscalingAutoscalingPolicy` + +| Name | Type | Description | +| - | - | - | +| `deciders` | Record | Decider settings. | +| `roles` | string[] |   | diff --git a/docs/reference/api/AutoscalingDeleteAutoscalingPolicyRequest.md b/docs/reference/api/AutoscalingDeleteAutoscalingPolicyRequest.md new file mode 100644 index 000000000..c35fe2bcf --- /dev/null +++ b/docs/reference/api/AutoscalingDeleteAutoscalingPolicyRequest.md @@ -0,0 +1,9 @@ +## Interface `AutoscalingDeleteAutoscalingPolicyRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { name?: never; master_timeout?: never; timeout?: never; }) | All values in `body` will be added to the request body. | +| `master_timeout` | [Duration](./Duration.md) | Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. | +| `name` | [Name](./Name.md) | the name of the autoscaling policy | +| `querystring` | { [key: string]: any; } & { name?: never; master_timeout?: never; timeout?: never; } | All values in `querystring` will be added to the request querystring. | +| `timeout` | [Duration](./Duration.md) | Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. | diff --git a/docs/reference/api/AutoscalingDeleteAutoscalingPolicyResponse.md b/docs/reference/api/AutoscalingDeleteAutoscalingPolicyResponse.md new file mode 100644 index 000000000..76b1a88e6 --- /dev/null +++ b/docs/reference/api/AutoscalingDeleteAutoscalingPolicyResponse.md @@ -0,0 +1,4 @@ +## `AutoscalingDeleteAutoscalingPolicyResponse` +::: +type AutoscalingDeleteAutoscalingPolicyResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); +::: diff --git a/docs/reference/api/AutoscalingGetAutoscalingCapacityAutoscalingCapacity.md b/docs/reference/api/AutoscalingGetAutoscalingCapacityAutoscalingCapacity.md new file mode 100644 index 000000000..2b63d6329 --- /dev/null +++ b/docs/reference/api/AutoscalingGetAutoscalingCapacityAutoscalingCapacity.md @@ -0,0 +1,6 @@ +## Interface `AutoscalingGetAutoscalingCapacityAutoscalingCapacity` + +| Name | Type | Description | +| - | - | - | +| `node` | [AutoscalingGetAutoscalingCapacityAutoscalingResources](./AutoscalingGetAutoscalingCapacityAutoscalingResources.md) |   | +| `total` | [AutoscalingGetAutoscalingCapacityAutoscalingResources](./AutoscalingGetAutoscalingCapacityAutoscalingResources.md) |   | diff --git a/docs/reference/api/AutoscalingGetAutoscalingCapacityAutoscalingDecider.md b/docs/reference/api/AutoscalingGetAutoscalingCapacityAutoscalingDecider.md new file mode 100644 index 000000000..6c1b23a2c --- /dev/null +++ b/docs/reference/api/AutoscalingGetAutoscalingCapacityAutoscalingDecider.md @@ -0,0 +1,7 @@ +## Interface `AutoscalingGetAutoscalingCapacityAutoscalingDecider` + +| Name | Type | Description | +| - | - | - | +| `reason_details` | any |   | +| `reason_summary` | string |   | +| `required_capacity` | [AutoscalingGetAutoscalingCapacityAutoscalingCapacity](./AutoscalingGetAutoscalingCapacityAutoscalingCapacity.md) |   | diff --git a/docs/reference/api/AutoscalingGetAutoscalingCapacityAutoscalingDeciders.md b/docs/reference/api/AutoscalingGetAutoscalingCapacityAutoscalingDeciders.md new file mode 100644 index 000000000..0b0d9eb35 --- /dev/null +++ b/docs/reference/api/AutoscalingGetAutoscalingCapacityAutoscalingDeciders.md @@ -0,0 +1,8 @@ +## Interface `AutoscalingGetAutoscalingCapacityAutoscalingDeciders` + +| Name | Type | Description | +| - | - | - | +| `current_capacity` | [AutoscalingGetAutoscalingCapacityAutoscalingCapacity](./AutoscalingGetAutoscalingCapacityAutoscalingCapacity.md) |   | +| `current_nodes` | [AutoscalingGetAutoscalingCapacityAutoscalingNode](./AutoscalingGetAutoscalingCapacityAutoscalingNode.md)[] |   | +| `deciders` | Record |   | +| `required_capacity` | [AutoscalingGetAutoscalingCapacityAutoscalingCapacity](./AutoscalingGetAutoscalingCapacityAutoscalingCapacity.md) |   | diff --git a/docs/reference/api/AutoscalingGetAutoscalingCapacityAutoscalingNode.md b/docs/reference/api/AutoscalingGetAutoscalingCapacityAutoscalingNode.md new file mode 100644 index 000000000..c3153a2c6 --- /dev/null +++ b/docs/reference/api/AutoscalingGetAutoscalingCapacityAutoscalingNode.md @@ -0,0 +1,5 @@ +## Interface `AutoscalingGetAutoscalingCapacityAutoscalingNode` + +| Name | Type | Description | +| - | - | - | +| `name` | [NodeName](./NodeName.md) |   | diff --git a/docs/reference/api/AutoscalingGetAutoscalingCapacityAutoscalingResources.md b/docs/reference/api/AutoscalingGetAutoscalingCapacityAutoscalingResources.md new file mode 100644 index 000000000..acdbe6cc9 --- /dev/null +++ b/docs/reference/api/AutoscalingGetAutoscalingCapacityAutoscalingResources.md @@ -0,0 +1,6 @@ +## Interface `AutoscalingGetAutoscalingCapacityAutoscalingResources` + +| Name | Type | Description | +| - | - | - | +| `memory` | [integer](./integer.md) |   | +| `storage` | [integer](./integer.md) |   | diff --git a/docs/reference/api/AutoscalingGetAutoscalingCapacityRequest.md b/docs/reference/api/AutoscalingGetAutoscalingCapacityRequest.md new file mode 100644 index 000000000..1322661ad --- /dev/null +++ b/docs/reference/api/AutoscalingGetAutoscalingCapacityRequest.md @@ -0,0 +1,7 @@ +## Interface `AutoscalingGetAutoscalingCapacityRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { master_timeout?: never; }) | All values in `body` will be added to the request body. | +| `master_timeout` | [Duration](./Duration.md) | Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. | +| `querystring` | { [key: string]: any; } & { master_timeout?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/AutoscalingGetAutoscalingCapacityResponse.md b/docs/reference/api/AutoscalingGetAutoscalingCapacityResponse.md new file mode 100644 index 000000000..4c91c8716 --- /dev/null +++ b/docs/reference/api/AutoscalingGetAutoscalingCapacityResponse.md @@ -0,0 +1,5 @@ +## Interface `AutoscalingGetAutoscalingCapacityResponse` + +| Name | Type | Description | +| - | - | - | +| `policies` | Record |   | diff --git a/docs/reference/api/AutoscalingGetAutoscalingPolicyRequest.md b/docs/reference/api/AutoscalingGetAutoscalingPolicyRequest.md new file mode 100644 index 000000000..ff4925cb3 --- /dev/null +++ b/docs/reference/api/AutoscalingGetAutoscalingPolicyRequest.md @@ -0,0 +1,8 @@ +## Interface `AutoscalingGetAutoscalingPolicyRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { name?: never; master_timeout?: never; }) | All values in `body` will be added to the request body. | +| `master_timeout` | [Duration](./Duration.md) | Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. | +| `name` | [Name](./Name.md) | the name of the autoscaling policy | +| `querystring` | { [key: string]: any; } & { name?: never; master_timeout?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/AutoscalingGetAutoscalingPolicyResponse.md b/docs/reference/api/AutoscalingGetAutoscalingPolicyResponse.md new file mode 100644 index 000000000..26ad6ccc1 --- /dev/null +++ b/docs/reference/api/AutoscalingGetAutoscalingPolicyResponse.md @@ -0,0 +1,4 @@ +## `AutoscalingGetAutoscalingPolicyResponse` +::: +type AutoscalingGetAutoscalingPolicyResponse = [AutoscalingAutoscalingPolicy](./AutoscalingAutoscalingPolicy.md); +::: diff --git a/docs/reference/api/AutoscalingPutAutoscalingPolicyRequest.md b/docs/reference/api/AutoscalingPutAutoscalingPolicyRequest.md new file mode 100644 index 000000000..bd77d27db --- /dev/null +++ b/docs/reference/api/AutoscalingPutAutoscalingPolicyRequest.md @@ -0,0 +1,10 @@ +## Interface `AutoscalingPutAutoscalingPolicyRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { name?: never; master_timeout?: never; timeout?: never; policy?: never; }) | All values in `body` will be added to the request body. | +| `master_timeout` | [Duration](./Duration.md) | Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. | +| `name` | [Name](./Name.md) | the name of the autoscaling policy | +| `policy` | [AutoscalingAutoscalingPolicy](./AutoscalingAutoscalingPolicy.md) |   | +| `querystring` | { [key: string]: any; } & { name?: never; master_timeout?: never; timeout?: never; policy?: never; } | All values in `querystring` will be added to the request querystring. | +| `timeout` | [Duration](./Duration.md) | Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. | diff --git a/docs/reference/api/AutoscalingPutAutoscalingPolicyResponse.md b/docs/reference/api/AutoscalingPutAutoscalingPolicyResponse.md new file mode 100644 index 000000000..77a1fa543 --- /dev/null +++ b/docs/reference/api/AutoscalingPutAutoscalingPolicyResponse.md @@ -0,0 +1,4 @@ +## `AutoscalingPutAutoscalingPolicyResponse` +::: +type AutoscalingPutAutoscalingPolicyResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); +::: diff --git a/docs/reference/api/BulkApi_1.md b/docs/reference/api/BulkApi_1.md new file mode 100644 index 000000000..e36e367d7 --- /dev/null +++ b/docs/reference/api/BulkApi_1.md @@ -0,0 +1,3 @@ +::: +default function BulkApi(this: [That](./That.md), params: [BulkRequest](./BulkRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[BulkResponse](./BulkResponse.md)>; +::: diff --git a/docs/reference/api/BulkApi_2.md b/docs/reference/api/BulkApi_2.md new file mode 100644 index 000000000..eb99682ca --- /dev/null +++ b/docs/reference/api/BulkApi_2.md @@ -0,0 +1,3 @@ +::: +default function BulkApi(this: [That](./That.md), params: [BulkRequest](./BulkRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[BulkResponse](./BulkResponse.md), unknown>>; +::: diff --git a/docs/reference/api/BulkApi_3.md b/docs/reference/api/BulkApi_3.md new file mode 100644 index 000000000..14140b0f1 --- /dev/null +++ b/docs/reference/api/BulkApi_3.md @@ -0,0 +1,3 @@ +::: +default function BulkApi(this: [That](./That.md), params: [BulkRequest](./BulkRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[BulkResponse](./BulkResponse.md)>; +::: diff --git a/docs/reference/api/BulkCreateOperation.md b/docs/reference/api/BulkCreateOperation.md new file mode 100644 index 000000000..8bc2752cf --- /dev/null +++ b/docs/reference/api/BulkCreateOperation.md @@ -0,0 +1,4 @@ +## Interface `BulkCreateOperation` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/BulkDeleteOperation.md b/docs/reference/api/BulkDeleteOperation.md new file mode 100644 index 000000000..d3533875c --- /dev/null +++ b/docs/reference/api/BulkDeleteOperation.md @@ -0,0 +1,4 @@ +## Interface `BulkDeleteOperation` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/BulkFailureStoreStatus.md b/docs/reference/api/BulkFailureStoreStatus.md new file mode 100644 index 000000000..4c5152ee6 --- /dev/null +++ b/docs/reference/api/BulkFailureStoreStatus.md @@ -0,0 +1,4 @@ +## `BulkFailureStoreStatus` +::: +type BulkFailureStoreStatus = 'not_applicable_or_unknown' | 'used' | 'not_enabled' | 'failed'; +::: diff --git a/docs/reference/api/BulkHelper.md b/docs/reference/api/BulkHelper.md new file mode 100644 index 000000000..0d9d08851 --- /dev/null +++ b/docs/reference/api/BulkHelper.md @@ -0,0 +1,6 @@ +## Interface `BulkHelper` + +| Name | Type | Description | +| - | - | - | +| `abort` | () => [BulkHelper](./BulkHelper.md) |   | +| `stats` | [BulkStats](./BulkStats.md) |   | diff --git a/docs/reference/api/BulkHelperOptions.md b/docs/reference/api/BulkHelperOptions.md new file mode 100644 index 000000000..52f7b6007 --- /dev/null +++ b/docs/reference/api/BulkHelperOptions.md @@ -0,0 +1,14 @@ +## Interface `BulkHelperOptions` + +| Name | Type | Description | +| - | - | - | +| `concurrency` | number |   | +| `datasource` | TDocument[] | [Buffer](./Buffer.md) | [Readable](./Readable.md) | [AsyncIterator](./AsyncIterator.md) |   | +| `flushBytes` | number |   | +| `flushInterval` | number |   | +| `onDocument` | (doc: TDocument) => [Action](./Action.md) |   | +| `onDrop` | (doc: [OnDropDocument](./OnDropDocument.md)) => void |   | +| `onSuccess` | (doc: [OnSuccessDocument](./OnSuccessDocument.md)) => void |   | +| `refreshOnCompletion` | boolean | string |   | +| `retries` | number |   | +| `wait` | number |   | diff --git a/docs/reference/api/BulkIndexByScrollFailure.md b/docs/reference/api/BulkIndexByScrollFailure.md new file mode 100644 index 000000000..9c498f27f --- /dev/null +++ b/docs/reference/api/BulkIndexByScrollFailure.md @@ -0,0 +1,8 @@ +## Interface `BulkIndexByScrollFailure` + +| Name | Type | Description | +| - | - | - | +| `cause` | [ErrorCause](./ErrorCause.md) |   | +| `id` | [Id](./Id.md) |   | +| `index` | [IndexName](./IndexName.md) |   | +| `status` | [integer](./integer.md) |   | diff --git a/docs/reference/api/BulkIndexOperation.md b/docs/reference/api/BulkIndexOperation.md new file mode 100644 index 000000000..02243672a --- /dev/null +++ b/docs/reference/api/BulkIndexOperation.md @@ -0,0 +1,4 @@ +## Interface `BulkIndexOperation` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/BulkOperationBase.md b/docs/reference/api/BulkOperationBase.md new file mode 100644 index 000000000..8e8f1c47b --- /dev/null +++ b/docs/reference/api/BulkOperationBase.md @@ -0,0 +1,11 @@ +## Interface `BulkOperationBase` + +| Name | Type | Description | +| - | - | - | +| `_id` | [Id](./Id.md) | The document ID. | +| `_index` | [IndexName](./IndexName.md) | The name of the index or index alias to perform the action on. | +| `if_primary_term` | [long](./long.md) |   | +| `if_seq_no` | [SequenceNumber](./SequenceNumber.md) |   | +| `routing` | [Routing](./Routing.md) | A custom value used to route operations to a specific shard. | +| `version_type` | [VersionType](./VersionType.md) |   | +| `version` | [VersionNumber](./VersionNumber.md) |   | diff --git a/docs/reference/api/BulkOperationContainer.md b/docs/reference/api/BulkOperationContainer.md new file mode 100644 index 000000000..5f0d8bf1c --- /dev/null +++ b/docs/reference/api/BulkOperationContainer.md @@ -0,0 +1,8 @@ +## Interface `BulkOperationContainer` + +| Name | Type | Description | +| - | - | - | +| `create` | [BulkCreateOperation](./BulkCreateOperation.md) | Index the specified document if it does not already exist. The following line must contain the source data to be indexed. | +| `delete` | [BulkDeleteOperation](./BulkDeleteOperation.md) | Remove the specified document from the index. | +| `index` | [BulkIndexOperation](./BulkIndexOperation.md) | Index the specified document. If the document exists, it replaces the document and increments the version. The following line must contain the source data to be indexed. | +| `update` | [BulkUpdateOperation](./BulkUpdateOperation.md) | Perform a partial document update. The following line must contain the partial document and update options. | diff --git a/docs/reference/api/BulkOperationType.md b/docs/reference/api/BulkOperationType.md new file mode 100644 index 000000000..49941d1ab --- /dev/null +++ b/docs/reference/api/BulkOperationType.md @@ -0,0 +1,4 @@ +## `BulkOperationType` +::: +type BulkOperationType = 'index' | 'create' | 'update' | 'delete'; +::: diff --git a/docs/reference/api/BulkRequest.md b/docs/reference/api/BulkRequest.md new file mode 100644 index 000000000..8d2407e55 --- /dev/null +++ b/docs/reference/api/BulkRequest.md @@ -0,0 +1,20 @@ +## Interface `BulkRequest` + +| Name | Type | Description | +| - | - | - | +| `_source_excludes` | [Fields](./Fields.md) | A comma-separated list of source fields to exclude from the response. You can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter. If the `_source` parameter is `false`, this parameter is ignored. | +| `_source_includes` | [Fields](./Fields.md) | A comma-separated list of source fields to include in the response. If this parameter is specified, only these source fields are returned. You can exclude fields from this subset using the `_source_excludes` query parameter. If the `_source` parameter is `false`, this parameter is ignored. | +| `_source` | [SearchSourceConfigParam](./SearchSourceConfigParam.md) | Indicates whether to return the `_source` field ( `true` or `false`) or contains a list of fields to return. | +| `body` | string | ({ [key: string]: any; } & { index?: never; include_source_on_error?: never; list_executed_pipelines?: never; pipeline?: never; refresh?: never; routing?: never; _source?: never; _source_excludes?: never; _source_includes?: never; timeout?: never; wait_for_active_shards?: never; require_alias?: never; require_data_stream?: never; operations?: never; }) | All values in `body` will be added to the request body. | +| `include_source_on_error` | boolean | True or false if to include the document source in the error message in case of parsing errors. | +| `index` | [IndexName](./IndexName.md) | The name of the data stream, index, or index alias to perform bulk actions on. | +| `list_executed_pipelines` | boolean | If `true`, the response will include the ingest pipelines that were run for each index or create. | +| `operations` | ([BulkOperationContainer](./BulkOperationContainer.md) | [BulkUpdateAction](./BulkUpdateAction.md) | TDocument)[] |   | +| `pipeline` | string | The pipeline identifier to use to preprocess incoming documents. If the index has a default ingest pipeline specified, setting the value to `_none` turns off the default ingest pipeline for this request. If a final pipeline is configured, it will always run regardless of the value of this parameter. | +| `querystring` | { [key: string]: any; } & { index?: never; include_source_on_error?: never; list_executed_pipelines?: never; pipeline?: never; refresh?: never; routing?: never; _source?: never; _source_excludes?: never; _source_includes?: never; timeout?: never; wait_for_active_shards?: never; require_alias?: never; require_data_stream?: never; operations?: never; } | All values in `querystring` will be added to the request querystring. | +| `refresh` | [Refresh](./Refresh.md) | If `true`, Elasticsearch refreshes the affected shards to make this operation visible to search. If `wait_for`, wait for a refresh to make this operation visible to search. If `false`, do nothing with refreshes. Valid values: `true`, `false`, `wait_for`. | +| `require_alias` | boolean | If `true`, the request's actions must target an index alias. | +| `require_data_stream` | boolean | If `true`, the request's actions must target a data stream (existing or to be created). | +| `routing` | [Routing](./Routing.md) | A custom value that is used to route operations to a specific shard. | +| `timeout` | [Duration](./Duration.md) | The period each action waits for the following operations: automatic index creation, dynamic mapping updates, and waiting for active shards. The default is `1m` (one minute), which guarantees Elasticsearch waits for at least the timeout before failing. The actual wait time could be longer, particularly when multiple waits occur. | +| `wait_for_active_shards` | [WaitForActiveShards](./WaitForActiveShards.md) | The number of shard copies that must be active before proceeding with the operation. Set to `all` or any positive integer up to the total number of shards in the index ( `number_of_replicas+1`). The default is `1`, which waits for each primary shard to be active. | diff --git a/docs/reference/api/BulkResponse.md b/docs/reference/api/BulkResponse.md new file mode 100644 index 000000000..bd02c53ba --- /dev/null +++ b/docs/reference/api/BulkResponse.md @@ -0,0 +1,8 @@ +## Interface `BulkResponse` + +| Name | Type | Description | +| - | - | - | +| `errors` | boolean | If `true`, one or more of the operations in the bulk request did not complete successfully. | +| `ingest_took` | [long](./long.md) |   | +| `items` | [Partial](./Partial.md)>[] | The result of each operation in the bulk request, in the order they were submitted. | +| `took` | [long](./long.md) | The length of time, in milliseconds, it took to process the bulk request. | diff --git a/docs/reference/api/BulkResponseItem.md b/docs/reference/api/BulkResponseItem.md new file mode 100644 index 000000000..d073ca581 --- /dev/null +++ b/docs/reference/api/BulkResponseItem.md @@ -0,0 +1,16 @@ +## Interface `BulkResponseItem` + +| Name | Type | Description | +| - | - | - | +| `_id` | string | null | The document ID associated with the operation. | +| `_index` | string | The name of the index associated with the operation. If the operation targeted a data stream, this is the backing index into which the document was written. | +| `_primary_term` | [long](./long.md) | The primary term assigned to the document for the operation. This property is returned only for successful operations. | +| `_seq_no` | [SequenceNumber](./SequenceNumber.md) | The sequence number assigned to the document for the operation. Sequence numbers are used to ensure an older version of a document doesn't overwrite a newer version. | +| `_shards` | [ShardStatistics](./ShardStatistics.md) | Shard information for the operation. | +| `_version` | [VersionNumber](./VersionNumber.md) | The document version associated with the operation. The document version is incremented each time the document is updated. This property is returned only for successful actions. | +| `error` | [ErrorCause](./ErrorCause.md) | Additional information about the failed operation. The property is returned only for failed operations. | +| `failure_store` | [BulkFailureStoreStatus](./BulkFailureStoreStatus.md) |   | +| `forced_refresh` | boolean |   | +| `get` | [InlineGet](./InlineGet.md)> |   | +| `result` | string | The result of the operation. Successful values are `created`, `deleted`, and `updated`. | +| `status` | [integer](./integer.md) | The HTTP status code returned for the operation. | diff --git a/docs/reference/api/BulkStats.md b/docs/reference/api/BulkStats.md new file mode 100644 index 000000000..5ad29f696 --- /dev/null +++ b/docs/reference/api/BulkStats.md @@ -0,0 +1,13 @@ +## Interface `BulkStats` + +| Name | Type | Description | +| - | - | - | +| `avg_size_in_bytes` | [long](./long.md) |   | +| `avg_size` | [ByteSize](./ByteSize.md) |   | +| `avg_time_in_millis` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> |   | +| `avg_time` | [Duration](./Duration.md) |   | +| `total_operations` | [long](./long.md) |   | +| `total_size_in_bytes` | [long](./long.md) |   | +| `total_size` | [ByteSize](./ByteSize.md) |   | +| `total_time_in_millis` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> |   | +| `total_time` | [Duration](./Duration.md) |   | diff --git a/docs/reference/api/BulkUpdateAction.md b/docs/reference/api/BulkUpdateAction.md new file mode 100644 index 000000000..a358bd320 --- /dev/null +++ b/docs/reference/api/BulkUpdateAction.md @@ -0,0 +1,11 @@ +## Interface `BulkUpdateAction` + +| Name | Type | Description | +| - | - | - | +| `_source` | [SearchSourceConfig](./SearchSourceConfig.md) | If `false`, source retrieval is turned off. You can also specify a comma-separated list of the fields you want to retrieve. | +| `detect_noop` | boolean | If true, the `result` in the response is set to 'noop' when no changes to the document occur. | +| `doc_as_upsert` | boolean | Set to `true` to use the contents of `doc` as the value of `upsert`. | +| `doc` | TPartialDocument | A partial update to an existing document. | +| `script` | [Script](./Script.md) | [ScriptSource](./ScriptSource.md) | The script to run to update the document. | +| `scripted_upsert` | boolean | Set to `true` to run the script whether or not the document exists. | +| `upsert` | TDocument | If the document does not already exist, the contents of `upsert` are inserted as a new document. If the document exists, the `script` is run. | diff --git a/docs/reference/api/BulkUpdateOperation.md b/docs/reference/api/BulkUpdateOperation.md new file mode 100644 index 000000000..44fbd57b6 --- /dev/null +++ b/docs/reference/api/BulkUpdateOperation.md @@ -0,0 +1,6 @@ +## Interface `BulkUpdateOperation` + +| Name | Type | Description | +| - | - | - | +| `require_alias` | boolean | If `true`, the request's actions must target an index alias. | +| `retry_on_conflict` | [integer](./integer.md) | The number of times an update should be retried in the case of a version conflict. | diff --git a/docs/reference/api/BulkWriteOperation.md b/docs/reference/api/BulkWriteOperation.md new file mode 100644 index 000000000..df1d455bc --- /dev/null +++ b/docs/reference/api/BulkWriteOperation.md @@ -0,0 +1,7 @@ +## Interface `BulkWriteOperation` + +| Name | Type | Description | +| - | - | - | +| `dynamic_templates` | Record | A map from the full name of fields to the name of dynamic templates. It defaults to an empty map. If a name matches a dynamic template, that template will be applied regardless of other match predicates defined in the template. If a field is already defined in the mapping, then this parameter won't be used. | +| `pipeline` | string | The ID of the pipeline to use to preprocess incoming documents. If the index has a default ingest pipeline specified, setting the value to `_none` turns off the default ingest pipeline for this request. If a final pipeline is configured, it will always run regardless of the value of this parameter. | +| `require_alias` | boolean | If `true`, the request's actions must target an index alias. | diff --git a/docs/reference/api/ByteSize.md b/docs/reference/api/ByteSize.md new file mode 100644 index 000000000..e9cd47861 --- /dev/null +++ b/docs/reference/api/ByteSize.md @@ -0,0 +1,4 @@ +## `ByteSize` +::: +type ByteSize = [long](./long.md) | string; +::: diff --git a/docs/reference/api/Bytes.md b/docs/reference/api/Bytes.md new file mode 100644 index 000000000..8d2716194 --- /dev/null +++ b/docs/reference/api/Bytes.md @@ -0,0 +1,4 @@ +## `Bytes` +::: +type Bytes = 'b' | 'kb' | 'mb' | 'gb' | 'tb' | 'pb'; +::: diff --git a/docs/reference/api/CapabilitiesApi_1.md b/docs/reference/api/CapabilitiesApi_1.md new file mode 100644 index 000000000..ef21fcb31 --- /dev/null +++ b/docs/reference/api/CapabilitiesApi_1.md @@ -0,0 +1,3 @@ +::: +default function CapabilitiesApi(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TODO](./TODO.md)>; +::: diff --git a/docs/reference/api/CapabilitiesApi_2.md b/docs/reference/api/CapabilitiesApi_2.md new file mode 100644 index 000000000..9d82b89d4 --- /dev/null +++ b/docs/reference/api/CapabilitiesApi_2.md @@ -0,0 +1,3 @@ +::: +default function CapabilitiesApi(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TODO](./TODO.md), unknown>>; +::: diff --git a/docs/reference/api/CapabilitiesApi_3.md b/docs/reference/api/CapabilitiesApi_3.md new file mode 100644 index 000000000..249b2276a --- /dev/null +++ b/docs/reference/api/CapabilitiesApi_3.md @@ -0,0 +1,3 @@ +::: +default function CapabilitiesApi(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TODO](./TODO.md)>; +::: diff --git a/docs/reference/api/Cat.md b/docs/reference/api/Cat.md new file mode 100644 index 000000000..925daa4f6 --- /dev/null +++ b/docs/reference/api/Cat.md @@ -0,0 +1,20 @@ +## `Cat` + +### Constructor + +::: +new Cat(transport: [Transport](./Transport.md)); +::: + +### Properties + +| Name | Type | Description | +| - | - | - | +| `acceptedParams` | Record |   | +| `transport` | [Transport](./Transport.md) |   | + +### Methods + +| Name | Signature | Description | +| - | - | - | +| `aliases` | `aliases(this: [That](./That.md), params?: [CatAliasesRequest](./CatAliasesRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatAliasesResponse](./CatAliasesResponse.md)>;` | Get aliases. Get the cluster's index aliases, including filter and routing information. This API does not return data stream aliases. IMPORTANT: CAT APIs are only intended for human consumption using the command line or the Kibana console. They are not intended for use by applications. For application consumption, use the aliases API. || `aliases` | `aliases(this: [That](./That.md), params?: [CatAliasesRequest](./CatAliasesRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatAliasesResponse](./CatAliasesResponse.md), unknown>>;` |   || `aliases` | `aliases(this: [That](./That.md), params?: [CatAliasesRequest](./CatAliasesRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatAliasesResponse](./CatAliasesResponse.md)>;` |   || `allocation` | `allocation(this: [That](./That.md), params?: [CatAllocationRequest](./CatAllocationRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatAllocationResponse](./CatAllocationResponse.md)>;` | Get shard allocation information. Get a snapshot of the number of shards allocated to each data node and their disk space. IMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. || `allocation` | `allocation(this: [That](./That.md), params?: [CatAllocationRequest](./CatAllocationRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatAllocationResponse](./CatAllocationResponse.md), unknown>>;` |   || `allocation` | `allocation(this: [That](./That.md), params?: [CatAllocationRequest](./CatAllocationRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatAllocationResponse](./CatAllocationResponse.md)>;` |   || `componentTemplates` | `componentTemplates(this: [That](./That.md), params?: [CatComponentTemplatesRequest](./CatComponentTemplatesRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatComponentTemplatesResponse](./CatComponentTemplatesResponse.md)>;` | Get component templates. Get information about component templates in a cluster. Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. IMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get component template API. || `componentTemplates` | `componentTemplates(this: [That](./That.md), params?: [CatComponentTemplatesRequest](./CatComponentTemplatesRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatComponentTemplatesResponse](./CatComponentTemplatesResponse.md), unknown>>;` |   || `componentTemplates` | `componentTemplates(this: [That](./That.md), params?: [CatComponentTemplatesRequest](./CatComponentTemplatesRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatComponentTemplatesResponse](./CatComponentTemplatesResponse.md)>;` |   || `count` | `count(this: [That](./That.md), params?: [CatCountRequest](./CatCountRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatCountResponse](./CatCountResponse.md)>;` | Get a document count. Get quick access to a document count for a data stream, an index, or an entire cluster. The document count only includes live documents, not deleted documents which have not yet been removed by the merge process. IMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the count API. || `count` | `count(this: [That](./That.md), params?: [CatCountRequest](./CatCountRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatCountResponse](./CatCountResponse.md), unknown>>;` |   || `count` | `count(this: [That](./That.md), params?: [CatCountRequest](./CatCountRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatCountResponse](./CatCountResponse.md)>;` |   || `fielddata` | `fielddata(this: [That](./That.md), params?: [CatFielddataRequest](./CatFielddataRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatFielddataResponse](./CatFielddataResponse.md)>;` | Get field data cache information. Get the amount of heap memory currently used by the field data cache on every data node in the cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes stats API. || `fielddata` | `fielddata(this: [That](./That.md), params?: [CatFielddataRequest](./CatFielddataRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatFielddataResponse](./CatFielddataResponse.md), unknown>>;` |   || `fielddata` | `fielddata(this: [That](./That.md), params?: [CatFielddataRequest](./CatFielddataRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatFielddataResponse](./CatFielddataResponse.md)>;` |   || `health` | `health(this: [That](./That.md), params?: [CatHealthRequest](./CatHealthRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatHealthResponse](./CatHealthResponse.md)>;` | Get the cluster health status. IMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the cluster health API. This API is often used to check malfunctioning clusters. To help you track cluster health alongside log files and alerting systems, the API returns timestamps in two formats: `HH:MM:SS`, which is human-readable but includes no date information; `Unix epoch time`, which is machine-sortable and includes date information. The latter format is useful for cluster recoveries that take multiple days. You can use the cat health API to verify cluster health across multiple nodes. You also can use the API to track the recovery of a large cluster over a longer period of time. || `health` | `health(this: [That](./That.md), params?: [CatHealthRequest](./CatHealthRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatHealthResponse](./CatHealthResponse.md), unknown>>;` |   || `health` | `health(this: [That](./That.md), params?: [CatHealthRequest](./CatHealthRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatHealthResponse](./CatHealthResponse.md)>;` |   || `help` | `help(this: [That](./That.md), params?: [CatHelpRequest](./CatHelpRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatHelpResponse](./CatHelpResponse.md)>;` | Get CAT help. Get help for the CAT APIs. || `help` | `help(this: [That](./That.md), params?: [CatHelpRequest](./CatHelpRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatHelpResponse](./CatHelpResponse.md), unknown>>;` |   || `help` | `help(this: [That](./That.md), params?: [CatHelpRequest](./CatHelpRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatHelpResponse](./CatHelpResponse.md)>;` |   || `indices` | `indices(this: [That](./That.md), params?: [CatIndicesRequest](./CatIndicesRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatIndicesResponse](./CatIndicesResponse.md)>;` | Get index information. Get high-level information about indices in a cluster, including backing indices for data streams. Use this request to get the following information for each index in a cluster: - shard count - document count - deleted document count - primary store size - total store size of all shards, including shard replicas These metrics are retrieved directly from Lucene, which Elasticsearch uses internally to power indexing and search. As a result, all document counts include hidden nested documents. To get an accurate count of Elasticsearch documents, use the cat count or count APIs. CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use an index endpoint. || `indices` | `indices(this: [That](./That.md), params?: [CatIndicesRequest](./CatIndicesRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatIndicesResponse](./CatIndicesResponse.md), unknown>>;` |   || `indices` | `indices(this: [That](./That.md), params?: [CatIndicesRequest](./CatIndicesRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatIndicesResponse](./CatIndicesResponse.md)>;` |   || `master` | `master(this: [That](./That.md), params?: [CatMasterRequest](./CatMasterRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatMasterResponse](./CatMasterResponse.md)>;` | Get master node information. Get information about the master node, including the ID, bound IP address, and name. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API. || `master` | `master(this: [That](./That.md), params?: [CatMasterRequest](./CatMasterRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatMasterResponse](./CatMasterResponse.md), unknown>>;` |   || `master` | `master(this: [That](./That.md), params?: [CatMasterRequest](./CatMasterRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatMasterResponse](./CatMasterResponse.md)>;` |   || `mlDatafeeds` | `mlDatafeeds(this: [That](./That.md), params?: [CatMlDatafeedsRequest](./CatMlDatafeedsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatMlDatafeedsResponse](./CatMlDatafeedsResponse.md)>;` | Get datafeeds. Get configuration and usage information about datafeeds. This API returns a maximum of 10,000 datafeeds. If the Elasticsearch security features are enabled, you must have `monitor_ml`, `monitor`, `manage_ml`, or `manage` cluster privileges to use this API. IMPORTANT: CAT APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get datafeed statistics API. || `mlDatafeeds` | `mlDatafeeds(this: [That](./That.md), params?: [CatMlDatafeedsRequest](./CatMlDatafeedsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatMlDatafeedsResponse](./CatMlDatafeedsResponse.md), unknown>>;` |   || `mlDatafeeds` | `mlDatafeeds(this: [That](./That.md), params?: [CatMlDatafeedsRequest](./CatMlDatafeedsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatMlDatafeedsResponse](./CatMlDatafeedsResponse.md)>;` |   || `mlDataFrameAnalytics` | `mlDataFrameAnalytics(this: [That](./That.md), params?: [CatMlDataFrameAnalyticsRequest](./CatMlDataFrameAnalyticsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatMlDataFrameAnalyticsResponse](./CatMlDataFrameAnalyticsResponse.md)>;` | Get data frame analytics jobs. Get configuration and usage information about data frame analytics jobs. IMPORTANT: CAT APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get data frame analytics jobs statistics API. || `mlDataFrameAnalytics` | `mlDataFrameAnalytics(this: [That](./That.md), params?: [CatMlDataFrameAnalyticsRequest](./CatMlDataFrameAnalyticsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatMlDataFrameAnalyticsResponse](./CatMlDataFrameAnalyticsResponse.md), unknown>>;` |   || `mlDataFrameAnalytics` | `mlDataFrameAnalytics(this: [That](./That.md), params?: [CatMlDataFrameAnalyticsRequest](./CatMlDataFrameAnalyticsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatMlDataFrameAnalyticsResponse](./CatMlDataFrameAnalyticsResponse.md)>;` |   || `mlJobs` | `mlJobs(this: [That](./That.md), params?: [CatMlJobsRequest](./CatMlJobsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatMlJobsResponse](./CatMlJobsResponse.md)>;` | Get anomaly detection jobs. Get configuration and usage information for anomaly detection jobs. This API returns a maximum of 10,000 jobs. If the Elasticsearch security features are enabled, you must have `monitor_ml`, `monitor`, `manage_ml`, or `manage` cluster privileges to use this API. IMPORTANT: CAT APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get anomaly detection job statistics API. || `mlJobs` | `mlJobs(this: [That](./That.md), params?: [CatMlJobsRequest](./CatMlJobsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatMlJobsResponse](./CatMlJobsResponse.md), unknown>>;` |   || `mlJobs` | `mlJobs(this: [That](./That.md), params?: [CatMlJobsRequest](./CatMlJobsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatMlJobsResponse](./CatMlJobsResponse.md)>;` |   || `mlTrainedModels` | `mlTrainedModels(this: [That](./That.md), params?: [CatMlTrainedModelsRequest](./CatMlTrainedModelsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatMlTrainedModelsResponse](./CatMlTrainedModelsResponse.md)>;` | Get trained models. Get configuration and usage information about inference trained models. IMPORTANT: CAT APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get trained models statistics API. || `mlTrainedModels` | `mlTrainedModels(this: [That](./That.md), params?: [CatMlTrainedModelsRequest](./CatMlTrainedModelsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatMlTrainedModelsResponse](./CatMlTrainedModelsResponse.md), unknown>>;` |   || `mlTrainedModels` | `mlTrainedModels(this: [That](./That.md), params?: [CatMlTrainedModelsRequest](./CatMlTrainedModelsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatMlTrainedModelsResponse](./CatMlTrainedModelsResponse.md)>;` |   || `nodeattrs` | `nodeattrs(this: [That](./That.md), params?: [CatNodeattrsRequest](./CatNodeattrsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatNodeattrsResponse](./CatNodeattrsResponse.md)>;` | Get node attribute information. Get information about custom node attributes. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API. || `nodeattrs` | `nodeattrs(this: [That](./That.md), params?: [CatNodeattrsRequest](./CatNodeattrsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatNodeattrsResponse](./CatNodeattrsResponse.md), unknown>>;` |   || `nodeattrs` | `nodeattrs(this: [That](./That.md), params?: [CatNodeattrsRequest](./CatNodeattrsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatNodeattrsResponse](./CatNodeattrsResponse.md)>;` |   || `nodes` | `nodes(this: [That](./That.md), params?: [CatNodesRequest](./CatNodesRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatNodesResponse](./CatNodesResponse.md)>;` | Get node information. Get information about the nodes in a cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API. || `nodes` | `nodes(this: [That](./That.md), params?: [CatNodesRequest](./CatNodesRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatNodesResponse](./CatNodesResponse.md), unknown>>;` |   || `nodes` | `nodes(this: [That](./That.md), params?: [CatNodesRequest](./CatNodesRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatNodesResponse](./CatNodesResponse.md)>;` |   || `pendingTasks` | `pendingTasks(this: [That](./That.md), params?: [CatPendingTasksRequest](./CatPendingTasksRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatPendingTasksResponse](./CatPendingTasksResponse.md)>;` | Get pending task information. Get information about cluster-level changes that have not yet taken effect. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the pending cluster tasks API. || `pendingTasks` | `pendingTasks(this: [That](./That.md), params?: [CatPendingTasksRequest](./CatPendingTasksRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatPendingTasksResponse](./CatPendingTasksResponse.md), unknown>>;` |   || `pendingTasks` | `pendingTasks(this: [That](./That.md), params?: [CatPendingTasksRequest](./CatPendingTasksRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatPendingTasksResponse](./CatPendingTasksResponse.md)>;` |   || `plugins` | `plugins(this: [That](./That.md), params?: [CatPluginsRequest](./CatPluginsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatPluginsResponse](./CatPluginsResponse.md)>;` | Get plugin information. Get a list of plugins running on each node of a cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API. || `plugins` | `plugins(this: [That](./That.md), params?: [CatPluginsRequest](./CatPluginsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatPluginsResponse](./CatPluginsResponse.md), unknown>>;` |   || `plugins` | `plugins(this: [That](./That.md), params?: [CatPluginsRequest](./CatPluginsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatPluginsResponse](./CatPluginsResponse.md)>;` |   || `recovery` | `recovery(this: [That](./That.md), params?: [CatRecoveryRequest](./CatRecoveryRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatRecoveryResponse](./CatRecoveryResponse.md)>;` | Get shard recovery information. Get information about ongoing and completed shard recoveries. Shard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or syncing a replica shard from a primary shard. When a shard recovery completes, the recovered shard is available for search and indexing. For data streams, the API returns information about the stream’s backing indices. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the index recovery API. || `recovery` | `recovery(this: [That](./That.md), params?: [CatRecoveryRequest](./CatRecoveryRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatRecoveryResponse](./CatRecoveryResponse.md), unknown>>;` |   || `recovery` | `recovery(this: [That](./That.md), params?: [CatRecoveryRequest](./CatRecoveryRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatRecoveryResponse](./CatRecoveryResponse.md)>;` |   || `repositories` | `repositories(this: [That](./That.md), params?: [CatRepositoriesRequest](./CatRepositoriesRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatRepositoriesResponse](./CatRepositoriesResponse.md)>;` | Get snapshot repository information. Get a list of snapshot repositories for a cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get snapshot repository API. || `repositories` | `repositories(this: [That](./That.md), params?: [CatRepositoriesRequest](./CatRepositoriesRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatRepositoriesResponse](./CatRepositoriesResponse.md), unknown>>;` |   || `repositories` | `repositories(this: [That](./That.md), params?: [CatRepositoriesRequest](./CatRepositoriesRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatRepositoriesResponse](./CatRepositoriesResponse.md)>;` |   || `segments` | `segments(this: [That](./That.md), params?: [CatSegmentsRequest](./CatSegmentsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatSegmentsResponse](./CatSegmentsResponse.md)>;` | Get segment information. Get low-level information about the Lucene segments in index shards. For data streams, the API returns information about the backing indices. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the index segments API. || `segments` | `segments(this: [That](./That.md), params?: [CatSegmentsRequest](./CatSegmentsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatSegmentsResponse](./CatSegmentsResponse.md), unknown>>;` |   || `segments` | `segments(this: [That](./That.md), params?: [CatSegmentsRequest](./CatSegmentsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatSegmentsResponse](./CatSegmentsResponse.md)>;` |   || `shards` | `shards(this: [That](./That.md), params?: [CatShardsRequest](./CatShardsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatShardsResponse](./CatShardsResponse.md)>;` | Get shard information. Get information about the shards in a cluster. For data streams, the API returns information about the backing indices. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. || `shards` | `shards(this: [That](./That.md), params?: [CatShardsRequest](./CatShardsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatShardsResponse](./CatShardsResponse.md), unknown>>;` |   || `shards` | `shards(this: [That](./That.md), params?: [CatShardsRequest](./CatShardsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatShardsResponse](./CatShardsResponse.md)>;` |   || `snapshots` | `snapshots(this: [That](./That.md), params?: [CatSnapshotsRequest](./CatSnapshotsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatSnapshotsResponse](./CatSnapshotsResponse.md)>;` | Get snapshot information. Get information about the snapshots stored in one or more repositories. A snapshot is a backup of an index or running Elasticsearch cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get snapshot API. || `snapshots` | `snapshots(this: [That](./That.md), params?: [CatSnapshotsRequest](./CatSnapshotsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatSnapshotsResponse](./CatSnapshotsResponse.md), unknown>>;` |   || `snapshots` | `snapshots(this: [That](./That.md), params?: [CatSnapshotsRequest](./CatSnapshotsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatSnapshotsResponse](./CatSnapshotsResponse.md)>;` |   || `tasks` | `tasks(this: [That](./That.md), params?: [CatTasksRequest](./CatTasksRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatTasksResponse](./CatTasksResponse.md)>;` | Get task information. Get information about tasks currently running in the cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the task management API. || `tasks` | `tasks(this: [That](./That.md), params?: [CatTasksRequest](./CatTasksRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatTasksResponse](./CatTasksResponse.md), unknown>>;` |   || `tasks` | `tasks(this: [That](./That.md), params?: [CatTasksRequest](./CatTasksRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatTasksResponse](./CatTasksResponse.md)>;` |   || `templates` | `templates(this: [That](./That.md), params?: [CatTemplatesRequest](./CatTemplatesRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatTemplatesResponse](./CatTemplatesResponse.md)>;` | Get index template information. Get information about the index templates in a cluster. You can use index templates to apply index settings and field mappings to new indices at creation. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get index template API. || `templates` | `templates(this: [That](./That.md), params?: [CatTemplatesRequest](./CatTemplatesRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatTemplatesResponse](./CatTemplatesResponse.md), unknown>>;` |   || `templates` | `templates(this: [That](./That.md), params?: [CatTemplatesRequest](./CatTemplatesRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatTemplatesResponse](./CatTemplatesResponse.md)>;` |   || `threadPool` | `threadPool(this: [That](./That.md), params?: [CatThreadPoolRequest](./CatThreadPoolRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatThreadPoolResponse](./CatThreadPoolResponse.md)>;` | Get thread pool statistics. Get thread pool statistics for each node in a cluster. Returned information includes all built-in thread pools and custom thread pools. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API. || `threadPool` | `threadPool(this: [That](./That.md), params?: [CatThreadPoolRequest](./CatThreadPoolRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatThreadPoolResponse](./CatThreadPoolResponse.md), unknown>>;` |   || `threadPool` | `threadPool(this: [That](./That.md), params?: [CatThreadPoolRequest](./CatThreadPoolRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatThreadPoolResponse](./CatThreadPoolResponse.md)>;` |   || `transforms` | `transforms(this: [That](./That.md), params?: [CatTransformsRequest](./CatTransformsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatTransformsResponse](./CatTransformsResponse.md)>;` | Get transform information. Get configuration and usage information about transforms. CAT APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get transform statistics API. || `transforms` | `transforms(this: [That](./That.md), params?: [CatTransformsRequest](./CatTransformsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatTransformsResponse](./CatTransformsResponse.md), unknown>>;` |   || `transforms` | `transforms(this: [That](./That.md), params?: [CatTransformsRequest](./CatTransformsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatTransformsResponse](./CatTransformsResponse.md)>;` |   | \ No newline at end of file diff --git a/docs/reference/api/CatAliasesAliasesRecord.md b/docs/reference/api/CatAliasesAliasesRecord.md new file mode 100644 index 000000000..98480fb93 --- /dev/null +++ b/docs/reference/api/CatAliasesAliasesRecord.md @@ -0,0 +1,21 @@ +## Interface `CatAliasesAliasesRecord` + +| Name | Type | Description | +| - | - | - | +| `"routing.index"` | string | index routing | +| `"routing.search"` | string | search routing | +| `a` | string | alias name alias | +| `alias` | string | alias name | +| `f` | string | filter filter | +| `fi` | string | filter filter | +| `filter` | string | filter | +| `i` | [IndexName](./IndexName.md) | index alias points to index | +| `idx` | [IndexName](./IndexName.md) | index alias points to index | +| `index` | [IndexName](./IndexName.md) | index alias points to | +| `is_write_index` | string | write index | +| `isWriteIndex` | string | write index is_write_index | +| `ri` | string | index routing 'routing.index' | +| `routingIndex` | string | index routing 'routing.index' | +| `routingSearch` | string | search routing 'routing.search' | +| `rs` | string | search routing 'routing.search' | +| `w` | string | write index is_write_index | diff --git a/docs/reference/api/CatAliasesRequest.md b/docs/reference/api/CatAliasesRequest.md new file mode 100644 index 000000000..3cd000eac --- /dev/null +++ b/docs/reference/api/CatAliasesRequest.md @@ -0,0 +1,11 @@ +## Interface `CatAliasesRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { name?: never; h?: never; s?: never; expand_wildcards?: never; master_timeout?: never; }) | All values in `body` will be added to the request body. | +| `expand_wildcards` | [ExpandWildcards](./ExpandWildcards.md) | The type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. It supports comma-separated values, such as `open,hidden`. | +| `h` | [Names](./Names.md) | List of columns to appear in the response. Supports simple wildcards. | +| `master_timeout` | [Duration](./Duration.md) | The period to wait for a connection to the master node. If the master node is not available before the timeout expires, the request fails and returns an error. To indicated that the request should never timeout, you can set it to `-1`. | +| `name` | [Names](./Names.md) | A comma-separated list of aliases to retrieve. Supports wildcards ( `*`). To retrieve all aliases, omit this parameter or use `*` or `_all`. | +| `querystring` | { [key: string]: any; } & { name?: never; h?: never; s?: never; expand_wildcards?: never; master_timeout?: never; } | All values in `querystring` will be added to the request querystring. | +| `s` | [Names](./Names.md) | List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name. | diff --git a/docs/reference/api/CatAliasesResponse.md b/docs/reference/api/CatAliasesResponse.md new file mode 100644 index 000000000..eb0f9eb54 --- /dev/null +++ b/docs/reference/api/CatAliasesResponse.md @@ -0,0 +1,4 @@ +## `CatAliasesResponse` +::: +type CatAliasesResponse = [CatAliasesAliasesRecord](./CatAliasesAliasesRecord.md)[]; +::: diff --git a/docs/reference/api/CatAllocationAllocationRecord.md b/docs/reference/api/CatAllocationAllocationRecord.md new file mode 100644 index 000000000..47e672675 --- /dev/null +++ b/docs/reference/api/CatAllocationAllocationRecord.md @@ -0,0 +1,37 @@ +## Interface `CatAllocationAllocationRecord` + +| Name | Type | Description | +| - | - | - | +| `"disk.avail"` | [ByteSize](./ByteSize.md) | null | Free disk space available to Elasticsearch. Elasticsearch retrieves this metric from the node’s operating system. Disk-based shard allocation uses this metric to assign shards to nodes based on available disk space. | +| `"disk.indices.forecast"` | [ByteSize](./ByteSize.md) | null | Sum of shard size forecasts | +| `"disk.indices"` | [ByteSize](./ByteSize.md) | null | Disk space used by the node’s shards. Does not include disk space for the translog or unassigned shards. IMPORTANT: This metric double-counts disk space for hard-linked files, such as those created when shrinking, splitting, or cloning an index. | +| `"disk.percent"` | [Percentage](./Percentage.md) | null | Total percentage of disk space in use. Calculated as `disk.used / disk.total`. | +| `"disk.total"` | [ByteSize](./ByteSize.md) | null | Total disk space for the node, including in-use and available space. | +| `"disk.used"` | [ByteSize](./ByteSize.md) | null | Total disk space in use. Elasticsearch retrieves this metric from the node’s operating system (OS). The metric includes disk space for: Elasticsearch, including the translog and unassigned shards; the node’s operating system; any other applications or files on the node. Unlike `disk.indices`, this metric does not double-count disk space for hard-linked files. | +| `"node.role"` | string | null | Node roles | +| `"shards.undesired"` | string | null | Amount of shards that are scheduled to be moved elsewhere in the cluster or -1 other than desired balance allocator is used | +| `"write_load.forecast"` | [SpecUtilsStringified](./SpecUtilsStringified.md)<[double](./double.md)> | null | Sum of index write load forecasts | +| `da` | [ByteSize](./ByteSize.md) | null | Free disk space available to Elasticsearch. Elasticsearch retrieves this metric from the node’s operating system. Disk-based shard allocation uses this metric to assign shards to nodes based on available disk space. 'disk.avail' | +| `di` | [ByteSize](./ByteSize.md) | null | Disk space used by the node’s shards. Does not include disk space for the translog or unassigned shards. IMPORTANT: This metric double-counts disk space for hard-linked files, such as those created when shrinking, splitting, or cloning an index. 'disk.indices' | +| `dif` | [ByteSize](./ByteSize.md) | null | Sum of shard size forecasts 'disk.indices.forecast' | +| `diskAvail` | [ByteSize](./ByteSize.md) | null | Free disk space available to Elasticsearch. Elasticsearch retrieves this metric from the node’s operating system. Disk-based shard allocation uses this metric to assign shards to nodes based on available disk space. 'disk.avail' | +| `diskIndices` | [ByteSize](./ByteSize.md) | null | Disk space used by the node’s shards. Does not include disk space for the translog or unassigned shards. IMPORTANT: This metric double-counts disk space for hard-linked files, such as those created when shrinking, splitting, or cloning an index. 'disk.indices' | +| `diskIndicesForecast` | [ByteSize](./ByteSize.md) | null | Sum of shard size forecasts 'disk.indices.forecast' | +| `diskPercent` | [Percentage](./Percentage.md) | null | Total percentage of disk space in use. Calculated as `disk.used / disk.total`. 'disk.percent' | +| `diskTotal` | [ByteSize](./ByteSize.md) | null | Total disk space for the node, including in-use and available space. 'disk.total' | +| `diskUsed` | [ByteSize](./ByteSize.md) | null | Total disk space in use. Elasticsearch retrieves this metric from the node’s operating system (OS). The metric includes disk space for: Elasticsearch, including the translog and unassigned shards; the node’s operating system; any other applications or files on the node. Unlike `disk.indices`, this metric does not double-count disk space for hard-linked files. 'disk.used' | +| `dp` | [Percentage](./Percentage.md) | null | Total percentage of disk space in use. Calculated as `disk.used / disk.total`. 'disk.percent' | +| `dt` | [ByteSize](./ByteSize.md) | null | Total disk space for the node, including in-use and available space. 'disk.total' | +| `du` | [ByteSize](./ByteSize.md) | null | Total disk space in use. Elasticsearch retrieves this metric from the node’s operating system (OS). The metric includes disk space for: Elasticsearch, including the translog and unassigned shards; the node’s operating system; any other applications or files on the node. Unlike `disk.indices`, this metric does not double-count disk space for hard-linked files. 'disk.used' | +| `h` | [Host](./Host.md) | null | Network host for the node. Set using the `network.host` setting. host | +| `host` | [Host](./Host.md) | null | Network host for the node. Set using the `network.host` setting. | +| `ip` | [Ip](./Ip.md) | null | IP address and port for the node. | +| `n` | string | Name for the node. Set using the `node.name` setting. node | +| `node` | string | Name for the node. Set using the `node.name` setting. | +| `nodeRole` | string | null | Node roles 'node.role' | +| `r` | string | null | Node roles 'node.role' | +| `role` | string | null | Node roles 'node.role' | +| `s` | string | Number of primary and replica shards assigned to the node. shards | +| `shards` | string | Number of primary and replica shards assigned to the node. | +| `wlf` | [SpecUtilsStringified](./SpecUtilsStringified.md)<[double](./double.md)> | null | Sum of index write load forecasts 'write_load.forecast' | +| `writeLoadForecast` | [SpecUtilsStringified](./SpecUtilsStringified.md)<[double](./double.md)> | null | Sum of index write load forecasts 'write_load.forecast' | diff --git a/docs/reference/api/CatAllocationRequest.md b/docs/reference/api/CatAllocationRequest.md new file mode 100644 index 000000000..08b2ee8c7 --- /dev/null +++ b/docs/reference/api/CatAllocationRequest.md @@ -0,0 +1,12 @@ +## Interface `CatAllocationRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { node_id?: never; bytes?: never; h?: never; s?: never; local?: never; master_timeout?: never; }) | All values in `body` will be added to the request body. | +| `bytes` | [Bytes](./Bytes.md) | The unit used to display byte values. | +| `h` | [Names](./Names.md) | List of columns to appear in the response. Supports simple wildcards. | +| `local` | boolean | If `true`, the request computes the list of selected nodes from the local cluster state. If `false` the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node. | +| `master_timeout` | [Duration](./Duration.md) | Period to wait for a connection to the master node. | +| `node_id` | [NodeIds](./NodeIds.md) | A comma-separated list of node identifiers or names used to limit the returned information. | +| `querystring` | { [key: string]: any; } & { node_id?: never; bytes?: never; h?: never; s?: never; local?: never; master_timeout?: never; } | All values in `querystring` will be added to the request querystring. | +| `s` | [Names](./Names.md) | List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name. | diff --git a/docs/reference/api/CatAllocationResponse.md b/docs/reference/api/CatAllocationResponse.md new file mode 100644 index 000000000..46c038160 --- /dev/null +++ b/docs/reference/api/CatAllocationResponse.md @@ -0,0 +1,4 @@ +## `CatAllocationResponse` +::: +type CatAllocationResponse = [CatAllocationAllocationRecord](./CatAllocationAllocationRecord.md)[]; +::: diff --git a/docs/reference/api/CatCatAnomalyDetectorColumn.md b/docs/reference/api/CatCatAnomalyDetectorColumn.md new file mode 100644 index 000000000..32d1b30f3 --- /dev/null +++ b/docs/reference/api/CatCatAnomalyDetectorColumn.md @@ -0,0 +1,4 @@ +## `CatCatAnomalyDetectorColumn` +::: +type CatCatAnomalyDetectorColumn = 'assignment_explanation' | 'ae' | 'buckets.count' | 'bc' | 'bucketsCount' | 'buckets.time.exp_avg' | 'btea' | 'bucketsTimeExpAvg' | 'buckets.time.exp_avg_hour' | 'bteah' | 'bucketsTimeExpAvgHour' | 'buckets.time.max' | 'btmax' | 'bucketsTimeMax' | 'buckets.time.min' | 'btmin' | 'bucketsTimeMin' | 'buckets.time.total' | 'btt' | 'bucketsTimeTotal' | 'data.buckets' | 'db' | 'dataBuckets' | 'data.earliest_record' | 'der' | 'dataEarliestRecord' | 'data.empty_buckets' | 'deb' | 'dataEmptyBuckets' | 'data.input_bytes' | 'dib' | 'dataInputBytes' | 'data.input_fields' | 'dif' | 'dataInputFields' | 'data.input_records' | 'dir' | 'dataInputRecords' | 'data.invalid_dates' | 'did' | 'dataInvalidDates' | 'data.last' | 'dl' | 'dataLast' | 'data.last_empty_bucket' | 'dleb' | 'dataLastEmptyBucket' | 'data.last_sparse_bucket' | 'dlsb' | 'dataLastSparseBucket' | 'data.latest_record' | 'dlr' | 'dataLatestRecord' | 'data.missing_fields' | 'dmf' | 'dataMissingFields' | 'data.out_of_order_timestamps' | 'doot' | 'dataOutOfOrderTimestamps' | 'data.processed_fields' | 'dpf' | 'dataProcessedFields' | 'data.processed_records' | 'dpr' | 'dataProcessedRecords' | 'data.sparse_buckets' | 'dsb' | 'dataSparseBuckets' | 'forecasts.memory.avg' | 'fmavg' | 'forecastsMemoryAvg' | 'forecasts.memory.max' | 'fmmax' | 'forecastsMemoryMax' | 'forecasts.memory.min' | 'fmmin' | 'forecastsMemoryMin' | 'forecasts.memory.total' | 'fmt' | 'forecastsMemoryTotal' | 'forecasts.records.avg' | 'fravg' | 'forecastsRecordsAvg' | 'forecasts.records.max' | 'frmax' | 'forecastsRecordsMax' | 'forecasts.records.min' | 'frmin' | 'forecastsRecordsMin' | 'forecasts.records.total' | 'frt' | 'forecastsRecordsTotal' | 'forecasts.time.avg' | 'ftavg' | 'forecastsTimeAvg' | 'forecasts.time.max' | 'ftmax' | 'forecastsTimeMax' | 'forecasts.time.min' | 'ftmin' | 'forecastsTimeMin' | 'forecasts.time.total' | 'ftt' | 'forecastsTimeTotal' | 'forecasts.total' | 'ft' | 'forecastsTotal' | 'id' | 'model.bucket_allocation_failures' | 'mbaf' | 'modelBucketAllocationFailures' | 'model.by_fields' | 'mbf' | 'modelByFields' | 'model.bytes' | 'mb' | 'modelBytes' | 'model.bytes_exceeded' | 'mbe' | 'modelBytesExceeded' | 'model.categorization_status' | 'mcs' | 'modelCategorizationStatus' | 'model.categorized_doc_count' | 'mcdc' | 'modelCategorizedDocCount' | 'model.dead_category_count' | 'mdcc' | 'modelDeadCategoryCount' | 'model.failed_category_count' | 'mdcc' | 'modelFailedCategoryCount' | 'model.frequent_category_count' | 'mfcc' | 'modelFrequentCategoryCount' | 'model.log_time' | 'mlt' | 'modelLogTime' | 'model.memory_limit' | 'mml' | 'modelMemoryLimit' | 'model.memory_status' | 'mms' | 'modelMemoryStatus' | 'model.over_fields' | 'mof' | 'modelOverFields' | 'model.partition_fields' | 'mpf' | 'modelPartitionFields' | 'model.rare_category_count' | 'mrcc' | 'modelRareCategoryCount' | 'model.timestamp' | 'mt' | 'modelTimestamp' | 'model.total_category_count' | 'mtcc' | 'modelTotalCategoryCount' | 'node.address' | 'na' | 'nodeAddress' | 'node.ephemeral_id' | 'ne' | 'nodeEphemeralId' | 'node.id' | 'ni' | 'nodeId' | 'node.name' | 'nn' | 'nodeName' | 'opened_time' | 'ot' | 'state' | 's'; +::: diff --git a/docs/reference/api/CatCatAnonalyDetectorColumns.md b/docs/reference/api/CatCatAnonalyDetectorColumns.md new file mode 100644 index 000000000..f18e36649 --- /dev/null +++ b/docs/reference/api/CatCatAnonalyDetectorColumns.md @@ -0,0 +1,4 @@ +## `CatCatAnonalyDetectorColumns` +::: +type CatCatAnonalyDetectorColumns = [CatCatAnomalyDetectorColumn](./CatCatAnomalyDetectorColumn.md) | [CatCatAnomalyDetectorColumn](./CatCatAnomalyDetectorColumn.md)[]; +::: diff --git a/docs/reference/api/CatCatDatafeedColumn.md b/docs/reference/api/CatCatDatafeedColumn.md new file mode 100644 index 000000000..bddf115dd --- /dev/null +++ b/docs/reference/api/CatCatDatafeedColumn.md @@ -0,0 +1,4 @@ +## `CatCatDatafeedColumn` +::: +type CatCatDatafeedColumn = 'ae' | 'assignment_explanation' | 'bc' | 'buckets.count' | 'bucketsCount' | 'id' | 'na' | 'node.address' | 'nodeAddress' | 'ne' | 'node.ephemeral_id' | 'nodeEphemeralId' | 'ni' | 'node.id' | 'nodeId' | 'nn' | 'node.name' | 'nodeName' | 'sba' | 'search.bucket_avg' | 'searchBucketAvg' | 'sc' | 'search.count' | 'searchCount' | 'seah' | 'search.exp_avg_hour' | 'searchExpAvgHour' | 'st' | 'search.time' | 'searchTime' | 's' | 'state'; +::: diff --git a/docs/reference/api/CatCatDatafeedColumns.md b/docs/reference/api/CatCatDatafeedColumns.md new file mode 100644 index 000000000..a1155886d --- /dev/null +++ b/docs/reference/api/CatCatDatafeedColumns.md @@ -0,0 +1,4 @@ +## `CatCatDatafeedColumns` +::: +type CatCatDatafeedColumns = [CatCatDatafeedColumn](./CatCatDatafeedColumn.md) | [CatCatDatafeedColumn](./CatCatDatafeedColumn.md)[]; +::: diff --git a/docs/reference/api/CatCatDfaColumn.md b/docs/reference/api/CatCatDfaColumn.md new file mode 100644 index 000000000..beb64fc20 --- /dev/null +++ b/docs/reference/api/CatCatDfaColumn.md @@ -0,0 +1,4 @@ +## `CatCatDfaColumn` +::: +type CatCatDfaColumn = 'assignment_explanation' | 'ae' | 'create_time' | 'ct' | 'createTime' | 'description' | 'd' | 'dest_index' | 'di' | 'destIndex' | 'failure_reason' | 'fr' | 'failureReason' | 'id' | 'model_memory_limit' | 'mml' | 'modelMemoryLimit' | 'node.address' | 'na' | 'nodeAddress' | 'node.ephemeral_id' | 'ne' | 'nodeEphemeralId' | 'node.id' | 'ni' | 'nodeId' | 'node.name' | 'nn' | 'nodeName' | 'progress' | 'p' | 'source_index' | 'si' | 'sourceIndex' | 'state' | 's' | 'type' | 't' | 'version' | 'v'; +::: diff --git a/docs/reference/api/CatCatDfaColumns.md b/docs/reference/api/CatCatDfaColumns.md new file mode 100644 index 000000000..9036177c6 --- /dev/null +++ b/docs/reference/api/CatCatDfaColumns.md @@ -0,0 +1,4 @@ +## `CatCatDfaColumns` +::: +type CatCatDfaColumns = [CatCatDfaColumn](./CatCatDfaColumn.md) | [CatCatDfaColumn](./CatCatDfaColumn.md)[]; +::: diff --git a/docs/reference/api/CatCatNodeColumn.md b/docs/reference/api/CatCatNodeColumn.md new file mode 100644 index 000000000..bab302955 --- /dev/null +++ b/docs/reference/api/CatCatNodeColumn.md @@ -0,0 +1,4 @@ +## `CatCatNodeColumn` +::: +type CatCatNodeColumn = 'build' | 'b' | 'completion.size' | 'cs' | 'completionSize' | 'cpu' | 'disk.avail' | 'd' | 'disk' | 'diskAvail' | 'disk.total' | 'dt' | 'diskTotal' | 'disk.used' | 'du' | 'diskUsed' | 'disk.used_percent' | 'dup' | 'diskUsedPercent' | 'fielddata.evictions' | 'fe' | 'fielddataEvictions' | 'fielddata.memory_size' | 'fm' | 'fielddataMemory' | 'file_desc.current' | 'fdc' | 'fileDescriptorCurrent' | 'file_desc.max' | 'fdm' | 'fileDescriptorMax' | 'file_desc.percent' | 'fdp' | 'fileDescriptorPercent' | 'flush.total' | 'ft' | 'flushTotal' | 'flush.total_time' | 'ftt' | 'flushTotalTime' | 'get.current' | 'gc' | 'getCurrent' | 'get.exists_time' | 'geti' | 'getExistsTime' | 'get.exists_total' | 'geto' | 'getExistsTotal' | 'get.missing_time' | 'gmti' | 'getMissingTime' | 'get.missing_total' | 'gmto' | 'getMissingTotal' | 'get.time' | 'gti' | 'getTime' | 'get.total' | 'gto' | 'getTotal' | 'heap.current' | 'hc' | 'heapCurrent' | 'heap.max' | 'hm' | 'heapMax' | 'heap.percent' | 'hp' | 'heapPercent' | 'http_address' | 'http' | 'id' | 'nodeId' | 'indexing.delete_current' | 'idc' | 'indexingDeleteCurrent' | 'indexing.delete_time' | 'idti' | 'indexingDeleteTime' | 'indexing.delete_total' | 'idto' | 'indexingDeleteTotal' | 'indexing.index_current' | 'iic' | 'indexingIndexCurrent' | 'indexing.index_failed' | 'iif' | 'indexingIndexFailed' | 'indexing.index_failed_due_to_version_conflict' | 'iifvc' | 'indexingIndexFailedDueToVersionConflict' | 'indexing.index_time' | 'iiti' | 'indexingIndexTime' | 'indexing.index_total' | 'iito' | 'indexingIndexTotal' | 'ip' | 'i' | 'jdk' | 'j' | 'load_1m' | 'l' | 'load_5m' | 'l' | 'load_15m' | 'l' | 'mappings.total_count' | 'mtc' | 'mappingsTotalCount' | 'mappings.total_estimated_overhead_in_bytes' | 'mteo' | 'mappingsTotalEstimatedOverheadInBytes' | 'master' | 'm' | 'merges.current' | 'mc' | 'mergesCurrent' | 'merges.current_docs' | 'mcd' | 'mergesCurrentDocs' | 'merges.current_size' | 'mcs' | 'mergesCurrentSize' | 'merges.total' | 'mt' | 'mergesTotal' | 'merges.total_docs' | 'mtd' | 'mergesTotalDocs' | 'merges.total_size' | 'mts' | 'mergesTotalSize' | 'merges.total_time' | 'mtt' | 'mergesTotalTime' | 'name' | 'n' | 'node.role' | 'r' | 'role' | 'nodeRole' | 'pid' | 'p' | 'port' | 'po' | 'query_cache.memory_size' | 'qcm' | 'queryCacheMemory' | 'query_cache.evictions' | 'qce' | 'queryCacheEvictions' | 'query_cache.hit_count' | 'qchc' | 'queryCacheHitCount' | 'query_cache.miss_count' | 'qcmc' | 'queryCacheMissCount' | 'ram.current' | 'rc' | 'ramCurrent' | 'ram.max' | 'rm' | 'ramMax' | 'ram.percent' | 'rp' | 'ramPercent' | 'refresh.total' | 'rto' | 'refreshTotal' | 'refresh.time' | 'rti' | 'refreshTime' | 'request_cache.memory_size' | 'rcm' | 'requestCacheMemory' | 'request_cache.evictions' | 'rce' | 'requestCacheEvictions' | 'request_cache.hit_count' | 'rchc' | 'requestCacheHitCount' | 'request_cache.miss_count' | 'rcmc' | 'requestCacheMissCount' | 'script.compilations' | 'scrcc' | 'scriptCompilations' | 'script.cache_evictions' | 'scrce' | 'scriptCacheEvictions' | 'search.fetch_current' | 'sfc' | 'searchFetchCurrent' | 'search.fetch_time' | 'sfti' | 'searchFetchTime' | 'search.fetch_total' | 'sfto' | 'searchFetchTotal' | 'search.open_contexts' | 'so' | 'searchOpenContexts' | 'search.query_current' | 'sqc' | 'searchQueryCurrent' | 'search.query_time' | 'sqti' | 'searchQueryTime' | 'search.query_total' | 'sqto' | 'searchQueryTotal' | 'search.scroll_current' | 'scc' | 'searchScrollCurrent' | 'search.scroll_time' | 'scti' | 'searchScrollTime' | 'search.scroll_total' | 'scto' | 'searchScrollTotal' | 'segments.count' | 'sc' | 'segmentsCount' | 'segments.fixed_bitset_memory' | 'sfbm' | 'fixedBitsetMemory' | 'segments.index_writer_memory' | 'siwm' | 'segmentsIndexWriterMemory' | 'segments.memory' | 'sm' | 'segmentsMemory' | 'segments.version_map_memory' | 'svmm' | 'segmentsVersionMapMemory' | 'shard_stats.total_count' | 'sstc' | 'shards' | 'shardStatsTotalCount' | 'suggest.current' | 'suc' | 'suggestCurrent' | 'suggest.time' | 'suti' | 'suggestTime' | 'suggest.total' | 'suto' | 'suggestTotal' | 'uptime' | 'u' | 'version' | 'v' | string; +::: diff --git a/docs/reference/api/CatCatNodeColumns.md b/docs/reference/api/CatCatNodeColumns.md new file mode 100644 index 000000000..9a9516efb --- /dev/null +++ b/docs/reference/api/CatCatNodeColumns.md @@ -0,0 +1,4 @@ +## `CatCatNodeColumns` +::: +type CatCatNodeColumns = [CatCatNodeColumn](./CatCatNodeColumn.md) | [CatCatNodeColumn](./CatCatNodeColumn.md)[]; +::: diff --git a/docs/reference/api/CatCatRequestBase.md b/docs/reference/api/CatCatRequestBase.md new file mode 100644 index 000000000..b05e2754a --- /dev/null +++ b/docs/reference/api/CatCatRequestBase.md @@ -0,0 +1,4 @@ +## Interface `CatCatRequestBase` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/CatCatTrainedModelsColumn.md b/docs/reference/api/CatCatTrainedModelsColumn.md new file mode 100644 index 000000000..d75efa650 --- /dev/null +++ b/docs/reference/api/CatCatTrainedModelsColumn.md @@ -0,0 +1,4 @@ +## `CatCatTrainedModelsColumn` +::: +type CatCatTrainedModelsColumn = 'create_time' | 'ct' | 'created_by' | 'c' | 'createdBy' | 'data_frame_analytics_id' | 'df' | 'dataFrameAnalytics' | 'dfid' | 'description' | 'd' | 'heap_size' | 'hs' | 'modelHeapSize' | 'id' | 'ingest.count' | 'ic' | 'ingestCount' | 'ingest.current' | 'icurr' | 'ingestCurrent' | 'ingest.failed' | 'if' | 'ingestFailed' | 'ingest.pipelines' | 'ip' | 'ingestPipelines' | 'ingest.time' | 'it' | 'ingestTime' | 'license' | 'l' | 'operations' | 'o' | 'modelOperations' | 'version' | 'v'; +::: diff --git a/docs/reference/api/CatCatTrainedModelsColumns.md b/docs/reference/api/CatCatTrainedModelsColumns.md new file mode 100644 index 000000000..e2864fa0f --- /dev/null +++ b/docs/reference/api/CatCatTrainedModelsColumns.md @@ -0,0 +1,4 @@ +## `CatCatTrainedModelsColumns` +::: +type CatCatTrainedModelsColumns = [CatCatTrainedModelsColumn](./CatCatTrainedModelsColumn.md) | [CatCatTrainedModelsColumn](./CatCatTrainedModelsColumn.md)[]; +::: diff --git a/docs/reference/api/CatCatTransformColumn.md b/docs/reference/api/CatCatTransformColumn.md new file mode 100644 index 000000000..c0482d714 --- /dev/null +++ b/docs/reference/api/CatCatTransformColumn.md @@ -0,0 +1,4 @@ +## `CatCatTransformColumn` +::: +type CatCatTransformColumn = 'changes_last_detection_time' | 'cldt' | 'checkpoint' | 'cp' | 'checkpoint_duration_time_exp_avg' | 'cdtea' | 'checkpointTimeExpAvg' | 'checkpoint_progress' | 'c' | 'checkpointProgress' | 'create_time' | 'ct' | 'createTime' | 'delete_time' | 'dtime' | 'description' | 'd' | 'dest_index' | 'di' | 'destIndex' | 'documents_deleted' | 'docd' | 'documents_indexed' | 'doci' | 'docs_per_second' | 'dps' | 'documents_processed' | 'docp' | 'frequency' | 'f' | 'id' | 'index_failure' | 'if' | 'index_time' | 'itime' | 'index_total' | 'it' | 'indexed_documents_exp_avg' | 'idea' | 'last_search_time' | 'lst' | 'lastSearchTime' | 'max_page_search_size' | 'mpsz' | 'pages_processed' | 'pp' | 'pipeline' | 'p' | 'processed_documents_exp_avg' | 'pdea' | 'processing_time' | 'pt' | 'reason' | 'r' | 'search_failure' | 'sf' | 'search_time' | 'stime' | 'search_total' | 'st' | 'source_index' | 'si' | 'sourceIndex' | 'state' | 's' | 'transform_type' | 'tt' | 'trigger_count' | 'tc' | 'version' | 'v'; +::: diff --git a/docs/reference/api/CatCatTransformColumns.md b/docs/reference/api/CatCatTransformColumns.md new file mode 100644 index 000000000..3bd17e6e9 --- /dev/null +++ b/docs/reference/api/CatCatTransformColumns.md @@ -0,0 +1,4 @@ +## `CatCatTransformColumns` +::: +type CatCatTransformColumns = [CatCatTransformColumn](./CatCatTransformColumn.md) | [CatCatTransformColumn](./CatCatTransformColumn.md)[]; +::: diff --git a/docs/reference/api/CatComponentTemplatesComponentTemplate.md b/docs/reference/api/CatComponentTemplatesComponentTemplate.md new file mode 100644 index 000000000..f7b04b03a --- /dev/null +++ b/docs/reference/api/CatComponentTemplatesComponentTemplate.md @@ -0,0 +1,11 @@ +## Interface `CatComponentTemplatesComponentTemplate` + +| Name | Type | Description | +| - | - | - | +| `alias_count` | string |   | +| `included_in` | string |   | +| `mapping_count` | string |   | +| `metadata_count` | string |   | +| `name` | string |   | +| `settings_count` | string |   | +| `version` | string | null |   | diff --git a/docs/reference/api/CatComponentTemplatesRequest.md b/docs/reference/api/CatComponentTemplatesRequest.md new file mode 100644 index 000000000..4456a1eb8 --- /dev/null +++ b/docs/reference/api/CatComponentTemplatesRequest.md @@ -0,0 +1,11 @@ +## Interface `CatComponentTemplatesRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { name?: never; h?: never; s?: never; local?: never; master_timeout?: never; }) | All values in `body` will be added to the request body. | +| `h` | [Names](./Names.md) | List of columns to appear in the response. Supports simple wildcards. | +| `local` | boolean | If `true`, the request computes the list of selected nodes from the local cluster state. If `false` the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node. | +| `master_timeout` | [Duration](./Duration.md) | The period to wait for a connection to the master node. | +| `name` | string | The name of the component template. It accepts wildcard expressions. If it is omitted, all component templates are returned. | +| `querystring` | { [key: string]: any; } & { name?: never; h?: never; s?: never; local?: never; master_timeout?: never; } | All values in `querystring` will be added to the request querystring. | +| `s` | [Names](./Names.md) | List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name. | diff --git a/docs/reference/api/CatComponentTemplatesResponse.md b/docs/reference/api/CatComponentTemplatesResponse.md new file mode 100644 index 000000000..a8093b810 --- /dev/null +++ b/docs/reference/api/CatComponentTemplatesResponse.md @@ -0,0 +1,4 @@ +## `CatComponentTemplatesResponse` +::: +type CatComponentTemplatesResponse = [CatComponentTemplatesComponentTemplate](./CatComponentTemplatesComponentTemplate.md)[]; +::: diff --git a/docs/reference/api/CatCountCountRecord.md b/docs/reference/api/CatCountCountRecord.md new file mode 100644 index 000000000..310ac3532 --- /dev/null +++ b/docs/reference/api/CatCountCountRecord.md @@ -0,0 +1,15 @@ +## Interface `CatCountCountRecord` + +| Name | Type | Description | +| - | - | - | +| `"docs.count"` | string | the document count count | +| `count` | string | the document count | +| `dc` | string | the document count count | +| `docsCount` | string | the document count count | +| `epoch` | [SpecUtilsStringified](./SpecUtilsStringified.md)<[EpochTime](./EpochTime.md)<[UnitSeconds](./UnitSeconds.md)>> | seconds since 1970-01-01 00:00:00 | +| `hhmmss` | [TimeOfDay](./TimeOfDay.md) | time in HH:MM:SS timestamp | +| `hms` | [TimeOfDay](./TimeOfDay.md) | time in HH:MM:SS timestamp | +| `t` | [SpecUtilsStringified](./SpecUtilsStringified.md)<[EpochTime](./EpochTime.md)<[UnitSeconds](./UnitSeconds.md)>> | seconds since 1970-01-01 00:00:00 epoch | +| `time` | [SpecUtilsStringified](./SpecUtilsStringified.md)<[EpochTime](./EpochTime.md)<[UnitSeconds](./UnitSeconds.md)>> | seconds since 1970-01-01 00:00:00 epoch | +| `timestamp` | [TimeOfDay](./TimeOfDay.md) | time in HH:MM:SS | +| `ts` | [TimeOfDay](./TimeOfDay.md) | time in HH:MM:SS timestamp | diff --git a/docs/reference/api/CatCountRequest.md b/docs/reference/api/CatCountRequest.md new file mode 100644 index 000000000..3b38c74de --- /dev/null +++ b/docs/reference/api/CatCountRequest.md @@ -0,0 +1,9 @@ +## Interface `CatCountRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { index?: never; h?: never; s?: never; }) | All values in `body` will be added to the request body. | +| `h` | [Names](./Names.md) | List of columns to appear in the response. Supports simple wildcards. | +| `index` | [Indices](./Indices.md) | A comma-separated list of data streams, indices, and aliases used to limit the request. It supports wildcards ( `*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. | +| `querystring` | { [key: string]: any; } & { index?: never; h?: never; s?: never; } | All values in `querystring` will be added to the request querystring. | +| `s` | [Names](./Names.md) | List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name. | diff --git a/docs/reference/api/CatCountResponse.md b/docs/reference/api/CatCountResponse.md new file mode 100644 index 000000000..2e5c67de5 --- /dev/null +++ b/docs/reference/api/CatCountResponse.md @@ -0,0 +1,4 @@ +## `CatCountResponse` +::: +type CatCountResponse = [CatCountCountRecord](./CatCountCountRecord.md)[]; +::: diff --git a/docs/reference/api/CatFielddataFielddataRecord.md b/docs/reference/api/CatFielddataFielddataRecord.md new file mode 100644 index 000000000..54bd7c8ff --- /dev/null +++ b/docs/reference/api/CatFielddataFielddataRecord.md @@ -0,0 +1,13 @@ +## Interface `CatFielddataFielddataRecord` + +| Name | Type | Description | +| - | - | - | +| `f` | string | field name field | +| `field` | string | field name | +| `h` | string | host name host | +| `host` | string | host name | +| `id` | string | node id | +| `ip` | string | ip address | +| `n` | string | node name node | +| `node` | string | node name | +| `size` | string | field data usage | diff --git a/docs/reference/api/CatFielddataRequest.md b/docs/reference/api/CatFielddataRequest.md new file mode 100644 index 000000000..20b556f7d --- /dev/null +++ b/docs/reference/api/CatFielddataRequest.md @@ -0,0 +1,10 @@ +## Interface `CatFielddataRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { fields?: never; bytes?: never; h?: never; s?: never; }) | All values in `body` will be added to the request body. | +| `bytes` | [Bytes](./Bytes.md) | The unit used to display byte values. | +| `fields` | [Fields](./Fields.md) | Comma-separated list of fields used to limit returned information. To retrieve all fields, omit this parameter. | +| `h` | [Names](./Names.md) | List of columns to appear in the response. Supports simple wildcards. | +| `querystring` | { [key: string]: any; } & { fields?: never; bytes?: never; h?: never; s?: never; } | All values in `querystring` will be added to the request querystring. | +| `s` | [Names](./Names.md) | List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name. | diff --git a/docs/reference/api/CatFielddataResponse.md b/docs/reference/api/CatFielddataResponse.md new file mode 100644 index 000000000..e8e65472b --- /dev/null +++ b/docs/reference/api/CatFielddataResponse.md @@ -0,0 +1,4 @@ +## `CatFielddataResponse` +::: +type CatFielddataResponse = [CatFielddataFielddataRecord](./CatFielddataFielddataRecord.md)[]; +::: diff --git a/docs/reference/api/CatHealthHealthRecord.md b/docs/reference/api/CatHealthHealthRecord.md new file mode 100644 index 000000000..92662580b --- /dev/null +++ b/docs/reference/api/CatHealthHealthRecord.md @@ -0,0 +1,54 @@ +## Interface `CatHealthHealthRecord` + +| Name | Type | Description | +| - | - | - | +| `"node.data"` | string | number of nodes that can store data | +| `"node.total"` | string | total number of nodes | +| `"shards.initializing"` | string | number of initializing nodes init | +| `"shards.primary"` | string | number of primary shards pri | +| `"shards.relocating"` | string | number of relocating nodes relo | +| `"shards.total"` | string | total number of shards shards | +| `"shards.unassigned.primary"` | string | number of unassigned primary shards 'unassign.pri' | +| `"shards.unassigned"` | string | number of unassigned shards unassign | +| `"unassign.pri"` | string | number of unassigned primary shards | +| `active_shards_percent` | string | active number of shards in percent | +| `activeShardsPercent` | string | active number of shards in percent active_shards_percent | +| `asp` | string | active number of shards in percent active_shards_percent | +| `cl` | string | cluster name cluster | +| `cluster` | string | cluster name | +| `epoch` | [SpecUtilsStringified](./SpecUtilsStringified.md)<[EpochTime](./EpochTime.md)<[UnitSeconds](./UnitSeconds.md)>> | seconds since 1970-01-01 00:00:00 | +| `hhmmss` | [TimeOfDay](./TimeOfDay.md) | time in HH:MM:SS timestamp | +| `hms` | [TimeOfDay](./TimeOfDay.md) | time in HH:MM:SS timestamp | +| `i` | string | number of initializing nodes init | +| `init` | string | number of initializing nodes | +| `max_task_wait_time` | string | wait time of longest task pending | +| `maxTaskWaitTime` | string | wait time of longest task pending max_task_wait_time | +| `mtwt` | string | wait time of longest task pending max_task_wait_time | +| `nd` | string | number of nodes that can store data 'node.data' | +| `nodeData` | string | number of nodes that can store data 'node.data' | +| `nodeTotal` | string | total number of nodes 'node.total' | +| `nt` | string | total number of nodes 'node.total' | +| `p` | string | number of primary shards pri | +| `pending_tasks` | string | number of pending tasks | +| `pendingTasks` | string | number of pending tasks pending_tasks | +| `pri` | string | number of primary shards | +| `pt` | string | number of pending tasks pending_tasks | +| `r` | string | number of relocating nodes relo | +| `relo` | string | number of relocating nodes | +| `sh` | string | total number of shards shards | +| `shards` | string | total number of shards | +| `shardsInitializing` | string | number of initializing nodes init | +| `shardsPrimary` | string | number of primary shards pri | +| `shardsRelocating` | string | number of relocating nodes relo | +| `shardsTotal` | string | total number of shards shards | +| `shardsUnassigned` | string | number of unassigned shards unassign | +| `shardsUnassignedPrimary` | string | number of unassigned primary shards 'unassign.pri' | +| `st` | string | health status status | +| `status` | string | health status | +| `t` | string | total number of shards shards | +| `time` | [SpecUtilsStringified](./SpecUtilsStringified.md)<[EpochTime](./EpochTime.md)<[UnitSeconds](./UnitSeconds.md)>> | seconds since 1970-01-01 00:00:00 epoch | +| `timestamp` | [TimeOfDay](./TimeOfDay.md) | time in HH:MM:SS | +| `ts` | [TimeOfDay](./TimeOfDay.md) | time in HH:MM:SS timestamp | +| `u` | string | number of unassigned shards unassign | +| `unassign` | string | number of unassigned shards | +| `up` | string | number of unassigned primary shards 'unassign.pri' | diff --git a/docs/reference/api/CatHealthRequest.md b/docs/reference/api/CatHealthRequest.md new file mode 100644 index 000000000..2f9faddb3 --- /dev/null +++ b/docs/reference/api/CatHealthRequest.md @@ -0,0 +1,10 @@ +## Interface `CatHealthRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { time?: never; ts?: never; h?: never; s?: never; }) | All values in `body` will be added to the request body. | +| `h` | [Names](./Names.md) | List of columns to appear in the response. Supports simple wildcards. | +| `querystring` | { [key: string]: any; } & { time?: never; ts?: never; h?: never; s?: never; } | All values in `querystring` will be added to the request querystring. | +| `s` | [Names](./Names.md) | List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name. | +| `time` | [TimeUnit](./TimeUnit.md) | The unit used to display time values. | +| `ts` | boolean | If true, returns `HH:MM:SS` and Unix epoch timestamps. | diff --git a/docs/reference/api/CatHealthResponse.md b/docs/reference/api/CatHealthResponse.md new file mode 100644 index 000000000..7c1fa475c --- /dev/null +++ b/docs/reference/api/CatHealthResponse.md @@ -0,0 +1,4 @@ +## `CatHealthResponse` +::: +type CatHealthResponse = [CatHealthHealthRecord](./CatHealthHealthRecord.md)[]; +::: diff --git a/docs/reference/api/CatHelpRequest.md b/docs/reference/api/CatHelpRequest.md new file mode 100644 index 000000000..41b6d60fd --- /dev/null +++ b/docs/reference/api/CatHelpRequest.md @@ -0,0 +1,6 @@ +## Interface `CatHelpRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | { [key: string]: any; } | All values in `body` will be added to the request body. | +| `querystring` | { [key: string]: any; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/CatHelpResponse.md b/docs/reference/api/CatHelpResponse.md new file mode 100644 index 000000000..bc681cb60 --- /dev/null +++ b/docs/reference/api/CatHelpResponse.md @@ -0,0 +1,4 @@ +## Interface `CatHelpResponse` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/CatIndicesIndicesRecord.md b/docs/reference/api/CatIndicesIndicesRecord.md new file mode 100644 index 000000000..a9cc8dd4c --- /dev/null +++ b/docs/reference/api/CatIndicesIndicesRecord.md @@ -0,0 +1,292 @@ +## Interface `CatIndicesIndicesRecord` + +| Name | Type | Description | +| - | - | - | +| `"bulk.avg_size_in_bytes"` | string | average size in bytes of shard bulk | +| `"bulk.avg_time"` | string | average time spend in shard bulk | +| `"bulk.total_operations"` | string | number of bulk shard ops | +| `"bulk.total_size_in_bytes"` | string | total size in bytes of shard bulk | +| `"bulk.total_time"` | string | time spend in shard bulk | +| `"completion.size"` | string | size of completion | +| `"creation.date.string"` | string | index creation date (as string) | +| `"creation.date"` | string | index creation date (millisecond value) | +| `"dataset.size"` | string | null | total size of dataset (including the cache for partially mounted indices) | +| `"docs.count"` | string | null | available docs | +| `"docs.deleted"` | string | null | deleted docs | +| `"fielddata.evictions"` | string | fielddata evictions | +| `"fielddata.memory_size"` | string | used fielddata cache | +| `"flush.total_time"` | string | time spent in flush | +| `"flush.total"` | string | number of flushes | +| `"get.current"` | string | number of current get ops | +| `"get.exists_time"` | string | time spent in successful gets | +| `"get.exists_total"` | string | number of successful gets | +| `"get.missing_time"` | string | time spent in failed gets | +| `"get.missing_total"` | string | number of failed gets | +| `"get.time"` | string | time spent in get | +| `"get.total"` | string | number of get ops | +| `"indexing.delete_current"` | string | number of current deletions | +| `"indexing.delete_time"` | string | time spent in deletions | +| `"indexing.delete_total"` | string | number of delete ops | +| `"indexing.index_current"` | string | number of current indexing ops | +| `"indexing.index_failed"` | string | number of failed indexing ops | +| `"indexing.index_time"` | string | time spent in indexing | +| `"indexing.index_total"` | string | number of indexing ops | +| `"memory.total"` | string | total used memory | +| `"merges.current_docs"` | string | number of current merging docs | +| `"merges.current_size"` | string | size of current merges | +| `"merges.current"` | string | number of current merges | +| `"merges.total_docs"` | string | docs merged | +| `"merges.total_size"` | string | size merged | +| `"merges.total_time"` | string | time spent in merges | +| `"merges.total"` | string | number of completed merge ops | +| `"pri.bulk.avg_size_in_bytes"` | string | average size in bytes of shard bulk | +| `"pri.bulk.avg_time"` | string | average time spend in shard bulk | +| `"pri.bulk.total_operations"` | string | number of bulk shard ops | +| `"pri.bulk.total_size_in_bytes"` | string | total size in bytes of shard bulk | +| `"pri.bulk.total_time"` | string | time spend in shard bulk | +| `"pri.completion.size"` | string | size of completion | +| `"pri.fielddata.evictions"` | string | fielddata evictions | +| `"pri.fielddata.memory_size"` | string | used fielddata cache | +| `"pri.flush.total_time"` | string | time spent in flush | +| `"pri.flush.total"` | string | number of flushes | +| `"pri.get.current"` | string | number of current get ops | +| `"pri.get.exists_time"` | string | time spent in successful gets | +| `"pri.get.exists_total"` | string | number of successful gets | +| `"pri.get.missing_time"` | string | time spent in failed gets | +| `"pri.get.missing_total"` | string | number of failed gets | +| `"pri.get.time"` | string | time spent in get | +| `"pri.get.total"` | string | number of get ops | +| `"pri.indexing.delete_current"` | string | number of current deletions | +| `"pri.indexing.delete_time"` | string | time spent in deletions | +| `"pri.indexing.delete_total"` | string | number of delete ops | +| `"pri.indexing.index_current"` | string | number of current indexing ops | +| `"pri.indexing.index_failed"` | string | number of failed indexing ops | +| `"pri.indexing.index_time"` | string | time spent in indexing | +| `"pri.indexing.index_total"` | string | number of indexing ops | +| `"pri.memory.total"` | string | total user memory | +| `"pri.merges.current_docs"` | string | number of current merging docs | +| `"pri.merges.current_size"` | string | size of current merges | +| `"pri.merges.current"` | string | number of current merges | +| `"pri.merges.total_docs"` | string | docs merged | +| `"pri.merges.total_size"` | string | size merged | +| `"pri.merges.total_time"` | string | time spent in merges | +| `"pri.merges.total"` | string | number of completed merge ops | +| `"pri.query_cache.evictions"` | string | query cache evictions | +| `"pri.query_cache.memory_size"` | string | used query cache | +| `"pri.refresh.external_time"` | string | time spent in external refreshes | +| `"pri.refresh.external_total"` | string | total external refreshes | +| `"pri.refresh.listeners"` | string | number of pending refresh listeners | +| `"pri.refresh.time"` | string | time spent in refreshes | +| `"pri.refresh.total"` | string | total refreshes | +| `"pri.request_cache.evictions"` | string | request cache evictions | +| `"pri.request_cache.hit_count"` | string | request cache hit count | +| `"pri.request_cache.memory_size"` | string | used request cache | +| `"pri.request_cache.miss_count"` | string | request cache miss count | +| `"pri.search.fetch_current"` | string | current fetch phase ops | +| `"pri.search.fetch_time"` | string | time spent in fetch phase | +| `"pri.search.fetch_total"` | string | total fetch ops | +| `"pri.search.open_contexts"` | string | open search contexts | +| `"pri.search.query_current"` | string | current query phase ops | +| `"pri.search.query_time"` | string | time spent in query phase | +| `"pri.search.query_total"` | string | total query phase ops | +| `"pri.search.scroll_current"` | string | open scroll contexts | +| `"pri.search.scroll_time"` | string | time scroll contexts held open | +| `"pri.search.scroll_total"` | string | completed scroll contexts | +| `"pri.segments.count"` | string | number of segments | +| `"pri.segments.fixed_bitset_memory"` | string | memory used by fixed bit sets for nested object field types and export type filters for types referred in _parent fields | +| `"pri.segments.index_writer_memory"` | string | memory used by index writer | +| `"pri.segments.memory"` | string | memory used by segments | +| `"pri.segments.version_map_memory"` | string | memory used by version map | +| `"pri.store.size"` | string | null | store size of primaries | +| `"pri.suggest.current"` | string | number of current suggest ops | +| `"pri.suggest.time"` | string | time spend in suggest | +| `"pri.suggest.total"` | string | number of suggest ops | +| `"pri.warmer.current"` | string | current warmer ops | +| `"pri.warmer.total_time"` | string | time spent in warmers | +| `"pri.warmer.total"` | string | total warmer ops | +| `"query_cache.evictions"` | string | query cache evictions | +| `"query_cache.memory_size"` | string | used query cache | +| `"refresh.external_time"` | string | time spent in external refreshes | +| `"refresh.external_total"` | string | total external refreshes | +| `"refresh.listeners"` | string | number of pending refresh listeners | +| `"refresh.time"` | string | time spent in refreshes | +| `"refresh.total"` | string | total refreshes | +| `"request_cache.evictions"` | string | request cache evictions | +| `"request_cache.hit_count"` | string | request cache hit count | +| `"request_cache.memory_size"` | string | used request cache | +| `"request_cache.miss_count"` | string | request cache miss count | +| `"search.fetch_current"` | string | current fetch phase ops | +| `"search.fetch_time"` | string | time spent in fetch phase | +| `"search.fetch_total"` | string | total fetch ops | +| `"search.open_contexts"` | string | open search contexts | +| `"search.query_current"` | string | current query phase ops | +| `"search.query_time"` | string | time spent in query phase | +| `"search.query_total"` | string | total query phase ops | +| `"search.scroll_current"` | string | open scroll contexts | +| `"search.scroll_time"` | string | time scroll contexts held open | +| `"search.scroll_total"` | string | completed scroll contexts | +| `"search.throttled"` | string | indicates if the index is search throttled | +| `"segments.count"` | string | number of segments | +| `"segments.fixed_bitset_memory"` | string | memory used by fixed bit sets for nested object field types and export type filters for types referred in _parent fields | +| `"segments.index_writer_memory"` | string | memory used by index writer | +| `"segments.memory"` | string | memory used by segments | +| `"segments.version_map_memory"` | string | memory used by version map | +| `"shards.primary"` | string | number of primary shards pri | +| `"shards.replica"` | string | number of replica shards rep | +| `"store.size"` | string | null | store size of primaries & replicas | +| `"suggest.current"` | string | number of current suggest ops | +| `"suggest.time"` | string | time spend in suggest | +| `"suggest.total"` | string | number of suggest ops | +| `"warmer.current"` | string | current warmer ops | +| `"warmer.total_time"` | string | time spent in warmers | +| `"warmer.total"` | string | total warmer ops | +| `basi` | string | average size in bytes of shard bulk 'bulk.avg_size_in_bytes' | +| `bati` | string | average time spend in shard bulk 'bulk.avg_time' | +| `bto` | string | number of bulk shard ops 'bulk.total_operations' | +| `btsi` | string | total size in bytes of shard bulk 'bulk.total_size_in_bytes' | +| `btti` | string | time spend in shard bulk 'bulk.total_time' | +| `bulkAvgSizeInBytes` | string | average size in bytes of shard bulk 'bulk.avg_size_in_bytes' | +| `bulkAvgTime` | string | average time spend in shard bulk 'bulk.avg_time' | +| `bulkTotalOperation` | string | number of bulk shard ops 'bulk.total_operations' | +| `bulkTotalSizeInBytes` | string | total size in bytes of shard bulk 'bulk.total_size_in_bytes' | +| `bulkTotalTime` | string | time spend in shard bulk 'bulk.total_time' | +| `cd` | string | index creation date (millisecond value) 'creation.date' | +| `cds` | string | index creation date (as string) 'creation.date.string' | +| `completionSize` | string | size of completion 'completion.size' | +| `cs` | string | size of completion 'completion.size' | +| `dc` | string | null | available docs 'docs.count' | +| `dd` | string | null | deleted docs 'docs.deleted' | +| `docsCount` | string | null | available docs 'docs.count' | +| `docsDeleted` | string | null | deleted docs 'docs.deleted' | +| `fe` | string | fielddata evictions 'fielddata.evictions' | +| `fielddataEvictions` | string | fielddata evictions 'fielddata.evictions' | +| `fielddataMemory` | string | used fielddata cache 'fielddata.memory_size' | +| `fixedBitsetMemory` | string | memory used by fixed bit sets for nested object field types and export type filters for types referred in _parent fields 'segments.fixed_bitset_memory' | +| `flushTotal` | string | number of flushes 'flush.total' | +| `flushTotalTime` | string | time spent in flush 'flush.total_time' | +| `fm` | string | used fielddata cache 'fielddata.memory_size' | +| `ft` | string | number of flushes 'flush.total' | +| `ftt` | string | time spent in flush 'flush.total_time' | +| `gc` | string | number of current get ops 'get.current' | +| `getCurrent` | string | number of current get ops 'get.current' | +| `getExistsTime` | string | time spent in successful gets 'get.exists_time' | +| `getExistsTotal` | string | number of successful gets 'get.exists_total' | +| `geti` | string | time spent in successful gets 'get.exists_time' | +| `getMissingTime` | string | time spent in failed gets 'get.missing_time' | +| `getMissingTotal` | string | number of failed gets 'get.missing_total' | +| `geto` | string | number of successful gets 'get.exists_total' | +| `getTime` | string | time spent in get 'get.time' | +| `getTotal` | string | number of get ops 'get.total' | +| `gmti` | string | time spent in failed gets 'get.missing_time' | +| `gmto` | string | number of failed gets 'get.missing_total' | +| `gti` | string | time spent in get 'get.time' | +| `gto` | string | number of get ops 'get.total' | +| `h` | string | current health status health | +| `health` | string | current health status | +| `i` | string | index name index | +| `id` | string | index uuid uuid | +| `idc` | string | number of current deletions 'indexing.delete_current' | +| `idti` | string | time spent in deletions 'indexing.delete_time' | +| `idto` | string | number of delete ops 'indexing.delete_total' | +| `idx` | string | index name index | +| `iic` | string | number of current indexing ops 'indexing.index_current' | +| `iif` | string | number of failed indexing ops 'indexing.index_failed' | +| `iiti` | string | time spent in indexing 'indexing.index_time' | +| `iito` | string | number of indexing ops 'indexing.index_total' | +| `index` | string | index name | +| `indexingDeleteCurrent` | string | number of current deletions 'indexing.delete_current' | +| `indexingDeleteTime` | string | time spent in deletions 'indexing.delete_time' | +| `indexingDeleteTotal` | string | number of delete ops 'indexing.delete_total' | +| `indexingIndexCurrent` | string | number of current indexing ops 'indexing.index_current' | +| `indexingIndexFailed` | string | number of failed indexing ops 'indexing.index_failed' | +| `indexingIndexTime` | string | time spent in indexing 'indexing.index_time' | +| `indexingIndexTotal` | string | number of indexing ops 'indexing.index_total' | +| `mc` | string | number of current merges 'merges.current' | +| `mcd` | string | number of current merging docs 'merges.current_docs' | +| `mcs` | string | size of current merges 'merges.current_size' | +| `memoryTotal` | string | total used memory 'memory.total' | +| `mergesCurrent` | string | number of current merges 'merges.current' | +| `mergesCurrentDocs` | string | number of current merging docs 'merges.current_docs' | +| `mergesCurrentSize` | string | size of current merges 'merges.current_size' | +| `mergesTotal` | string | number of completed merge ops 'merges.total' | +| `mergesTotalDocs` | string | docs merged 'merges.total_docs' | +| `mergesTotalSize` | string | size merged 'merges.total_size' | +| `mergesTotalTime` | string | time spent in merges 'merges.total_time' | +| `mt` | string | number of completed merge ops 'merges.total' | +| `mtd` | string | docs merged 'merges.total_docs' | +| `mts` | string | size merged 'merges.total_size' | +| `mtt` | string | time spent in merges 'merges.total_time' | +| `p` | string | number of primary shards pri | +| `pri` | string | number of primary shards | +| `qce` | string | query cache evictions 'query_cache.evictions' | +| `qcm` | string | used query cache 'query_cache.memory_size' | +| `queryCacheEvictions` | string | query cache evictions 'query_cache.evictions' | +| `queryCacheMemory` | string | used query cache 'query_cache.memory_size' | +| `r` | string | number of replica shards rep | +| `rce` | string | request cache evictions 'request_cache.evictions' | +| `rchc` | string | request cache hit count 'request_cache.hit_count' | +| `rcm` | string | used request cache 'request_cache.memory_size' | +| `rcmc` | string | request cache miss count 'request_cache.miss_count' | +| `refreshListeners` | string | number of pending refresh listeners 'refresh.listeners' | +| `refreshTime` | string | time spent in refreshes 'refresh.time' | +| `refreshTotal` | string | total refreshes 'refresh.total' | +| `rep` | string | number of replica shards | +| `requestCacheEvictions` | string | request cache evictions 'request_cache.evictions' | +| `requestCacheHitCount` | string | request cache hit count 'request_cache.hit_count' | +| `requestCacheMemory` | string | used request cache 'request_cache.memory_size' | +| `requestCacheMissCount` | string | request cache miss count 'request_cache.miss_count' | +| `reti` | string | time spent in external refreshes 'refresh.external_time' | +| `reto` | string | total external refreshes 'refresh.external_total' | +| `rli` | string | number of pending refresh listeners 'refresh.listeners' | +| `rti` | string | time spent in refreshes 'refresh.time' | +| `rto` | string | total refreshes 'refresh.total' | +| `s` | string | open/close status status | +| `sc` | string | number of segments 'segments.count' | +| `scc` | string | open scroll contexts 'search.scroll_current' | +| `scti` | string | time scroll contexts held open 'search.scroll_time' | +| `scto` | string | completed scroll contexts 'search.scroll_total' | +| `searchFetchCurrent` | string | current fetch phase ops 'search.fetch_current' | +| `searchFetchTime` | string | time spent in fetch phase 'search.fetch_time' | +| `searchFetchTotal` | string | total fetch ops 'search.fetch_total' | +| `searchOpenContexts` | string | open search contexts 'search.open_contexts' | +| `searchQueryCurrent` | string | current query phase ops 'search.query_current' | +| `searchQueryTime` | string | time spent in query phase 'search.query_time' | +| `searchQueryTotal` | string | total query phase ops 'search.query_total' | +| `searchScrollCurrent` | string | open scroll contexts 'search.scroll_current' | +| `searchScrollTime` | string | time scroll contexts held open 'search.scroll_time' | +| `searchScrollTotal` | string | completed scroll contexts 'search.scroll_total' | +| `segmentsCount` | string | number of segments 'segments.count' | +| `segmentsIndexWriterMemory` | string | memory used by index writer 'segments.index_writer_memory' | +| `segmentsMemory` | string | memory used by segments 'segments.memory' | +| `segmentsVersionMapMemory` | string | memory used by version map 'segments.version_map_memory' | +| `sfbm` | string | memory used by fixed bit sets for nested object field types and export type filters for types referred in _parent fields 'segments.fixed_bitset_memory' | +| `sfc` | string | current fetch phase ops 'search.fetch_current' | +| `sfti` | string | time spent in fetch phase 'search.fetch_time' | +| `sfto` | string | total fetch ops 'search.fetch_total' | +| `shardsPrimary` | string | number of primary shards pri | +| `shardsReplica` | string | number of replica shards rep | +| `siwm` | string | memory used by index writer 'segments.index_writer_memory' | +| `sm` | string | memory used by segments 'segments.memory' | +| `so` | string | open search contexts 'search.open_contexts' | +| `sqc` | string | current query phase ops 'search.query_current' | +| `sqti` | string | time spent in query phase 'search.query_time' | +| `sqto` | string | total query phase ops 'search.query_total' | +| `ss` | string | null | store size of primaries & replicas 'store.size' | +| `status` | string | open/close status | +| `sth` | string | indicates if the index is search throttled 'search.throttled' | +| `storeSize` | string | null | store size of primaries & replicas 'store.size' | +| `suc` | string | number of current suggest ops 'suggest.current' | +| `suggestCurrent` | string | number of current suggest ops 'suggest.current' | +| `suggestTime` | string | time spend in suggest 'suggest.time' | +| `suggestTotal` | string | number of suggest ops 'suggest.total' | +| `suti` | string | time spend in suggest 'suggest.time' | +| `suto` | string | number of suggest ops 'suggest.total' | +| `svmm` | string | memory used by version map 'segments.version_map_memory' | +| `tm` | string | total used memory 'memory.total' | +| `uuid` | string | index uuid | +| `warmerCurrent` | string | current warmer ops 'warmer.current' | +| `warmerTotal` | string | total warmer ops 'warmer.total' | +| `warmerTotalTime` | string | time spent in warmers 'warmer.total_time' | +| `wc` | string | current warmer ops 'warmer.current' | +| `wto` | string | total warmer ops 'warmer.total' | +| `wtt` | string | time spent in warmers 'warmer.total_time' | diff --git a/docs/reference/api/CatIndicesRequest.md b/docs/reference/api/CatIndicesRequest.md new file mode 100644 index 000000000..4caac879d --- /dev/null +++ b/docs/reference/api/CatIndicesRequest.md @@ -0,0 +1,16 @@ +## Interface `CatIndicesRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { index?: never; bytes?: never; expand_wildcards?: never; health?: never; include_unloaded_segments?: never; pri?: never; time?: never; master_timeout?: never; h?: never; s?: never; }) | All values in `body` will be added to the request body. | +| `bytes` | [Bytes](./Bytes.md) | The unit used to display byte values. | +| `expand_wildcards` | [ExpandWildcards](./ExpandWildcards.md) | The type of index that wildcard patterns can match. | +| `h` | [Names](./Names.md) | List of columns to appear in the response. Supports simple wildcards. | +| `health` | [HealthStatus](./HealthStatus.md) | The health status used to limit returned indices. By default, the response includes indices of any health status. | +| `include_unloaded_segments` | boolean | If true, the response includes information from segments that are not loaded into memory. | +| `index` | [Indices](./Indices.md) | Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards ( `*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. | +| `master_timeout` | [Duration](./Duration.md) | Period to wait for a connection to the master node. | +| `pri` | boolean | If true, the response only includes information from primary shards. | +| `querystring` | { [key: string]: any; } & { index?: never; bytes?: never; expand_wildcards?: never; health?: never; include_unloaded_segments?: never; pri?: never; time?: never; master_timeout?: never; h?: never; s?: never; } | All values in `querystring` will be added to the request querystring. | +| `s` | [Names](./Names.md) | List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name. | +| `time` | [TimeUnit](./TimeUnit.md) | The unit used to display time values. | diff --git a/docs/reference/api/CatIndicesResponse.md b/docs/reference/api/CatIndicesResponse.md new file mode 100644 index 000000000..0323091fd --- /dev/null +++ b/docs/reference/api/CatIndicesResponse.md @@ -0,0 +1,4 @@ +## `CatIndicesResponse` +::: +type CatIndicesResponse = [CatIndicesIndicesRecord](./CatIndicesIndicesRecord.md)[]; +::: diff --git a/docs/reference/api/CatMasterMasterRecord.md b/docs/reference/api/CatMasterMasterRecord.md new file mode 100644 index 000000000..ddf118c33 --- /dev/null +++ b/docs/reference/api/CatMasterMasterRecord.md @@ -0,0 +1,10 @@ +## Interface `CatMasterMasterRecord` + +| Name | Type | Description | +| - | - | - | +| `h` | string | host name host | +| `host` | string | host name | +| `id` | string | node id | +| `ip` | string | ip address | +| `n` | string | node name node | +| `node` | string | node name | diff --git a/docs/reference/api/CatMasterRequest.md b/docs/reference/api/CatMasterRequest.md new file mode 100644 index 000000000..75e057fd6 --- /dev/null +++ b/docs/reference/api/CatMasterRequest.md @@ -0,0 +1,10 @@ +## Interface `CatMasterRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { h?: never; s?: never; local?: never; master_timeout?: never; }) | All values in `body` will be added to the request body. | +| `h` | [Names](./Names.md) | List of columns to appear in the response. Supports simple wildcards. | +| `local` | boolean | If `true`, the request computes the list of selected nodes from the local cluster state. If `false` the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node. | +| `master_timeout` | [Duration](./Duration.md) | Period to wait for a connection to the master node. | +| `querystring` | { [key: string]: any; } & { h?: never; s?: never; local?: never; master_timeout?: never; } | All values in `querystring` will be added to the request querystring. | +| `s` | [Names](./Names.md) | List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name. | diff --git a/docs/reference/api/CatMasterResponse.md b/docs/reference/api/CatMasterResponse.md new file mode 100644 index 000000000..498edaabe --- /dev/null +++ b/docs/reference/api/CatMasterResponse.md @@ -0,0 +1,4 @@ +## `CatMasterResponse` +::: +type CatMasterResponse = [CatMasterMasterRecord](./CatMasterMasterRecord.md)[]; +::: diff --git a/docs/reference/api/CatMlDataFrameAnalyticsDataFrameAnalyticsRecord.md b/docs/reference/api/CatMlDataFrameAnalyticsDataFrameAnalyticsRecord.md new file mode 100644 index 000000000..04e5ac050 --- /dev/null +++ b/docs/reference/api/CatMlDataFrameAnalyticsDataFrameAnalyticsRecord.md @@ -0,0 +1,45 @@ +## Interface `CatMlDataFrameAnalyticsDataFrameAnalyticsRecord` + +| Name | Type | Description | +| - | - | - | +| `"node.address"` | string | The network address of the assigned node. | +| `"node.ephemeral_id"` | [Id](./Id.md) | The ephemeral identifier of the assigned node. | +| `"node.id"` | [Id](./Id.md) | The unique identifier of the assigned node. | +| `"node.name"` | [Name](./Name.md) | The name of the assigned node. | +| `ae` | string | Messages related to the selection of a node. assignment_explanation | +| `assignment_explanation` | string | Messages related to the selection of a node. | +| `assignmentExplanation` | string | Messages related to the selection of a node. assignment_explanation | +| `create_time` | string | The time when the job was created. | +| `createTime` | string | The time when the job was created. create_time | +| `ct` | string | The time when the job was created. create_time | +| `d` | string | A description of the job. description | +| `description` | string | A description of the job. | +| `dest_index` | [IndexName](./IndexName.md) | The name of the destination index. | +| `destIndex` | [IndexName](./IndexName.md) | The name of the destination index. dest_index | +| `di` | [IndexName](./IndexName.md) | The name of the destination index. dest_index | +| `failure_reason` | string | Messages about the reason why the job failed. | +| `failureReason` | string | Messages about the reason why the job failed. failure_reason | +| `fr` | string | Messages about the reason why the job failed. failure_reason | +| `id` | [Id](./Id.md) | The identifier for the job. | +| `mml` | string | The approximate maximum amount of memory resources that are permitted for the job. model_memory_limit | +| `model_memory_limit` | string | The approximate maximum amount of memory resources that are permitted for the job. | +| `modelMemoryLimit` | string | The approximate maximum amount of memory resources that are permitted for the job. model_memory_limit | +| `na` | string | The network address of the assigned node. 'node.address' | +| `ne` | [Id](./Id.md) | The ephemeral identifier of the assigned node. 'node.ephemeral_id' | +| `ni` | [Id](./Id.md) | The unique identifier of the assigned node. 'node.id' | +| `nn` | [Name](./Name.md) | The name of the assigned node. 'node.name' | +| `nodeAddress` | string | The network address of the assigned node. 'node.address' | +| `nodeEphemeralId` | [Id](./Id.md) | The ephemeral identifier of the assigned node. 'node.ephemeral_id' | +| `nodeId` | [Id](./Id.md) | The unique identifier of the assigned node. 'node.id' | +| `nodeName` | [Name](./Name.md) | The name of the assigned node. 'node.name' | +| `p` | string | The progress report for the job by phase. progress | +| `progress` | string | The progress report for the job by phase. | +| `s` | string | The current status of the job. state | +| `si` | [IndexName](./IndexName.md) | The name of the source index. source_index | +| `source_index` | [IndexName](./IndexName.md) | The name of the source index. | +| `sourceIndex` | [IndexName](./IndexName.md) | The name of the source index. source_index | +| `state` | string | The current status of the job. | +| `t` | string | The type of analysis that the job performs. type | +| `type` | string | The type of analysis that the job performs. | +| `v` | [VersionString](./VersionString.md) | The version of Elasticsearch when the job was created. version | +| `version` | [VersionString](./VersionString.md) | The version of Elasticsearch when the job was created. | diff --git a/docs/reference/api/CatMlDataFrameAnalyticsRequest.md b/docs/reference/api/CatMlDataFrameAnalyticsRequest.md new file mode 100644 index 000000000..c3fd757ae --- /dev/null +++ b/docs/reference/api/CatMlDataFrameAnalyticsRequest.md @@ -0,0 +1,12 @@ +## Interface `CatMlDataFrameAnalyticsRequest` + +| Name | Type | Description | +| - | - | - | +| `allow_no_match` | boolean | Whether to ignore if a wildcard expression matches no configs. (This includes `_all` string or when no configs have been specified) | +| `body` | string | ({ [key: string]: any; } & { id?: never; allow_no_match?: never; bytes?: never; h?: never; s?: never; time?: never; }) | All values in `body` will be added to the request body. | +| `bytes` | [Bytes](./Bytes.md) | The unit in which to display byte values | +| `h` | [CatCatDfaColumns](./CatCatDfaColumns.md) | Comma-separated list of column names to display. | +| `id` | [Id](./Id.md) | The ID of the data frame analytics to fetch | +| `querystring` | { [key: string]: any; } & { id?: never; allow_no_match?: never; bytes?: never; h?: never; s?: never; time?: never; } | All values in `querystring` will be added to the request querystring. | +| `s` | [CatCatDfaColumns](./CatCatDfaColumns.md) | Comma-separated list of column names or column aliases used to sort the response. | +| `time` | [TimeUnit](./TimeUnit.md) | Unit used to display time values. | diff --git a/docs/reference/api/CatMlDataFrameAnalyticsResponse.md b/docs/reference/api/CatMlDataFrameAnalyticsResponse.md new file mode 100644 index 000000000..2e681a119 --- /dev/null +++ b/docs/reference/api/CatMlDataFrameAnalyticsResponse.md @@ -0,0 +1,4 @@ +## `CatMlDataFrameAnalyticsResponse` +::: +type CatMlDataFrameAnalyticsResponse = [CatMlDataFrameAnalyticsDataFrameAnalyticsRecord](./CatMlDataFrameAnalyticsDataFrameAnalyticsRecord.md)[]; +::: diff --git a/docs/reference/api/CatMlDatafeedsDatafeedsRecord.md b/docs/reference/api/CatMlDatafeedsDatafeedsRecord.md new file mode 100644 index 000000000..b8cec2aa5 --- /dev/null +++ b/docs/reference/api/CatMlDatafeedsDatafeedsRecord.md @@ -0,0 +1,36 @@ +## Interface `CatMlDatafeedsDatafeedsRecord` + +| Name | Type | Description | +| - | - | - | +| `"buckets.count"` | string | The number of buckets processed. | +| `"node.address"` | string | The network address of the assigned node. For started datafeeds only, this information pertains to the node upon which the datafeed is started. | +| `"node.ephemeral_id"` | string | The ephemeral identifier of the assigned node. For started datafeeds only, this information pertains to the node upon which the datafeed is started. | +| `"node.id"` | string | The unique identifier of the assigned node. For started datafeeds only, this information pertains to the node upon which the datafeed is started. | +| `"node.name"` | string | The name of the assigned node. For started datafeeds only, this information pertains to the node upon which the datafeed is started. | +| `"search.bucket_avg"` | string | The average search time per bucket, in milliseconds. | +| `"search.count"` | string | The number of searches run by the datafeed. | +| `"search.exp_avg_hour"` | string | The exponential average search time per hour, in milliseconds. | +| `"search.time"` | string | The total time the datafeed spent searching, in milliseconds. | +| `ae` | string | For started datafeeds only, contains messages relating to the selection of a node. assignment_explanation | +| `assignment_explanation` | string | For started datafeeds only, contains messages relating to the selection of a node. | +| `bc` | string | The number of buckets processed. 'buckets.count' | +| `bucketsCount` | string | The number of buckets processed. 'buckets.count' | +| `id` | string | The datafeed identifier. | +| `na` | string | The network address of the assigned node. For started datafeeds only, this information pertains to the node upon which the datafeed is started. 'node.address' | +| `ne` | string | The ephemeral identifier of the assigned node. For started datafeeds only, this information pertains to the node upon which the datafeed is started. 'node.ephemeral_id' | +| `ni` | string | The unique identifier of the assigned node. For started datafeeds only, this information pertains to the node upon which the datafeed is started. 'node.id' | +| `nn` | string | The name of the assigned node. For started datafeeds only, this information pertains to the node upon which the datafeed is started. 'node.name' | +| `nodeAddress` | string | The network address of the assigned node. For started datafeeds only, this information pertains to the node upon which the datafeed is started. 'node.address' | +| `nodeEphemeralId` | string | The ephemeral identifier of the assigned node. For started datafeeds only, this information pertains to the node upon which the datafeed is started. 'node.ephemeral_id' | +| `nodeId` | string | The unique identifier of the assigned node. For started datafeeds only, this information pertains to the node upon which the datafeed is started. 'node.id' | +| `nodeName` | string | The name of the assigned node. For started datafeeds only, this information pertains to the node upon which the datafeed is started. 'node.name' | +| `s` | [MlDatafeedState](./MlDatafeedState.md) | The status of the datafeed. state | +| `sba` | string | The average search time per bucket, in milliseconds. 'search.bucket_avg' | +| `sc` | string | The number of searches run by the datafeed. 'search.count' | +| `seah` | string | The exponential average search time per hour, in milliseconds. 'search.exp_avg_hour' | +| `searchBucketAvg` | string | The average search time per bucket, in milliseconds. 'search.bucket_avg' | +| `searchCount` | string | The number of searches run by the datafeed. 'search.count' | +| `searchExpAvgHour` | string | The exponential average search time per hour, in milliseconds. 'search.exp_avg_hour' | +| `searchTime` | string | The total time the datafeed spent searching, in milliseconds. 'search.time' | +| `st` | string | The total time the datafeed spent searching, in milliseconds. 'search.time' | +| `state` | [MlDatafeedState](./MlDatafeedState.md) | The status of the datafeed. | diff --git a/docs/reference/api/CatMlDatafeedsRequest.md b/docs/reference/api/CatMlDatafeedsRequest.md new file mode 100644 index 000000000..d54a7270b --- /dev/null +++ b/docs/reference/api/CatMlDatafeedsRequest.md @@ -0,0 +1,11 @@ +## Interface `CatMlDatafeedsRequest` + +| Name | Type | Description | +| - | - | - | +| `allow_no_match` | boolean | Specifies what to do when the request: * Contains wildcard expressions and there are no datafeeds that match. * Contains the `_all` string or no identifiers and there are no matches. * Contains wildcard expressions and there are only partial matches. If `true`, the API returns an empty datafeeds array when there are no matches and the subset of results when there are partial matches. If `false`, the API returns a 404 status code when there are no matches or only partial matches. | +| `body` | string | ({ [key: string]: any; } & { datafeed_id?: never; allow_no_match?: never; h?: never; s?: never; time?: never; }) | All values in `body` will be added to the request body. | +| `datafeed_id` | [Id](./Id.md) | A numerical character string that uniquely identifies the datafeed. | +| `h` | [CatCatDatafeedColumns](./CatCatDatafeedColumns.md) | Comma-separated list of column names to display. | +| `querystring` | { [key: string]: any; } & { datafeed_id?: never; allow_no_match?: never; h?: never; s?: never; time?: never; } | All values in `querystring` will be added to the request querystring. | +| `s` | [CatCatDatafeedColumns](./CatCatDatafeedColumns.md) | Comma-separated list of column names or column aliases used to sort the response. | +| `time` | [TimeUnit](./TimeUnit.md) | The unit used to display time values. | diff --git a/docs/reference/api/CatMlDatafeedsResponse.md b/docs/reference/api/CatMlDatafeedsResponse.md new file mode 100644 index 000000000..a86cead69 --- /dev/null +++ b/docs/reference/api/CatMlDatafeedsResponse.md @@ -0,0 +1,4 @@ +## `CatMlDatafeedsResponse` +::: +type CatMlDatafeedsResponse = [CatMlDatafeedsDatafeedsRecord](./CatMlDatafeedsDatafeedsRecord.md)[]; +::: diff --git a/docs/reference/api/CatMlJobsJobsRecord.md b/docs/reference/api/CatMlJobsJobsRecord.md new file mode 100644 index 000000000..06f7eef0a --- /dev/null +++ b/docs/reference/api/CatMlJobsJobsRecord.md @@ -0,0 +1,178 @@ +## Interface `CatMlJobsJobsRecord` + +| Name | Type | Description | +| - | - | - | +| `"buckets.count"` | string | The number of bucket results produced by the job. | +| `"buckets.time.exp_avg_hour"` | string | The exponential moving average of bucket processing times calculated in a one hour time window, in milliseconds. | +| `"buckets.time.exp_avg"` | string | The exponential moving average of all bucket processing times, in milliseconds. | +| `"buckets.time.max"` | string | The maximum of all bucket processing times, in milliseconds. | +| `"buckets.time.min"` | string | The minimum of all bucket processing times, in milliseconds. | +| `"buckets.time.total"` | string | The sum of all bucket processing times, in milliseconds. | +| `"data.buckets"` | string | The total number of buckets processed. | +| `"data.earliest_record"` | string | The timestamp of the earliest chronologically input document. | +| `"data.empty_buckets"` | string | The number of buckets which did not contain any data. If your data contains many empty buckets, consider increasing your `bucket_span` or using functions that are tolerant to gaps in data such as mean, `non_null_sum` or `non_zero_count`. | +| `"data.input_bytes"` | [ByteSize](./ByteSize.md) | The number of bytes of input data posted to the anomaly detection job. | +| `"data.input_fields"` | string | The total number of fields in input documents posted to the anomaly detection job. This count includes fields that are not used in the analysis. However, be aware that if you are using a datafeed, it extracts only the required fields from the documents it retrieves before posting them to the job. | +| `"data.input_records"` | string | The number of input documents posted to the anomaly detection job. | +| `"data.invalid_dates"` | string | The number of input documents with either a missing date field or a date that could not be parsed. | +| `"data.last_empty_bucket"` | string | The timestamp of the last bucket that did not contain any data. | +| `"data.last_sparse_bucket"` | string | The timestamp of the last bucket that was considered sparse. | +| `"data.last"` | string | The timestamp at which data was last analyzed, according to server time. | +| `"data.latest_record"` | string | The timestamp of the latest chronologically input document. | +| `"data.missing_fields"` | string | The number of input documents that are missing a field that the anomaly detection job is configured to analyze. Input documents with missing fields are still processed because it is possible that not all fields are missing. If you are using datafeeds or posting data to the job in JSON format, a high `missing_field_count` is often not an indication of data issues. It is not necessarily a cause for concern. | +| `"data.out_of_order_timestamps"` | string | The number of input documents that have a timestamp chronologically preceding the start of the current anomaly detection bucket offset by the latency window. This information is applicable only when you provide data to the anomaly detection job by using the post data API. These out of order documents are discarded, since jobs require time series data to be in ascending chronological order. | +| `"data.processed_fields"` | string | The total number of fields in all the documents that have been processed by the anomaly detection job. Only fields that are specified in the detector configuration object contribute to this count. The timestamp is not included in this count. | +| `"data.processed_records"` | string | The number of input documents that have been processed by the anomaly detection job. This value includes documents with missing fields, since they are nonetheless analyzed. If you use datafeeds and have aggregations in your search query, the `processed_record_count` is the number of aggregation results processed, not the number of Elasticsearch documents. | +| `"data.sparse_buckets"` | string | The number of buckets that contained few data points compared to the expected number of data points. If your data contains many sparse buckets, consider using a longer `bucket_span`. | +| `"forecasts.memory.avg"` | string | The average memory usage in bytes for forecasts related to the anomaly detection job. | +| `"forecasts.memory.max"` | string | The maximum memory usage in bytes for forecasts related to the anomaly detection job. | +| `"forecasts.memory.min"` | string | The minimum memory usage in bytes for forecasts related to the anomaly detection job. | +| `"forecasts.memory.total"` | string | The total memory usage in bytes for forecasts related to the anomaly detection job. | +| `"forecasts.records.avg"` | string | The average number of `model_forecast` documents written for forecasts related to the anomaly detection job. | +| `"forecasts.records.max"` | string | The maximum number of `model_forecast` documents written for forecasts related to the anomaly detection job. | +| `"forecasts.records.min"` | string | The minimum number of `model_forecast` documents written for forecasts related to the anomaly detection job. | +| `"forecasts.records.total"` | string | The total number of `model_forecast` documents written for forecasts related to the anomaly detection job. | +| `"forecasts.time.avg"` | string | The average runtime in milliseconds for forecasts related to the anomaly detection job. | +| `"forecasts.time.max"` | string | The maximum runtime in milliseconds for forecasts related to the anomaly detection job. | +| `"forecasts.time.min"` | string | The minimum runtime in milliseconds for forecasts related to the anomaly detection job. | +| `"forecasts.time.total"` | string | The total runtime in milliseconds for forecasts related to the anomaly detection job. | +| `"forecasts.total"` | string | The number of individual forecasts currently available for the job. A value of one or more indicates that forecasts exist. | +| `"model.bucket_allocation_failures"` | string | The number of buckets for which new entities in incoming data were not processed due to insufficient model memory. This situation is also signified by a `hard_limit: memory_status` property value. | +| `"model.by_fields"` | string | The number of `by` field values that were analyzed by the models. This value is cumulative for all detectors in the job. | +| `"model.bytes_exceeded"` | [ByteSize](./ByteSize.md) | The number of bytes over the high limit for memory usage at the last allocation failure. | +| `"model.bytes"` | [ByteSize](./ByteSize.md) | The number of bytes of memory used by the models. This is the maximum value since the last time the model was persisted. If the job is closed, this value indicates the latest size. | +| `"model.categorization_status"` | [MlCategorizationStatus](./MlCategorizationStatus.md) | The status of categorization for the job. | +| `"model.categorized_doc_count"` | string | The number of documents that have had a field categorized. | +| `"model.dead_category_count"` | string | The number of categories created by categorization that will never be assigned again because another category’s definition makes it a superset of the dead category. Dead categories are a side effect of the way categorization has no prior training. | +| `"model.failed_category_count"` | string | The number of times that categorization wanted to create a new category but couldn’t because the job had hit its `model_memory_limit`. This count does not track which specific categories failed to be created. Therefore you cannot use this value to determine the number of unique categories that were missed. | +| `"model.frequent_category_count"` | string | The number of categories that match more than 1% of categorized documents. | +| `"model.log_time"` | string | The timestamp when the model stats were gathered, according to server time. | +| `"model.memory_limit"` | string | The upper limit for model memory usage, checked on increasing values. | +| `"model.memory_status"` | [MlMemoryStatus](./MlMemoryStatus.md) | The status of the mathematical models. | +| `"model.over_fields"` | string | The number of `over` field values that were analyzed by the models. This value is cumulative for all detectors in the job. | +| `"model.partition_fields"` | string | The number of `partition` field values that were analyzed by the models. This value is cumulative for all detectors in the job. | +| `"model.rare_category_count"` | string | The number of categories that match just one categorized document. | +| `"model.timestamp"` | string | The timestamp of the last record when the model stats were gathered. | +| `"model.total_category_count"` | string | The number of categories created by categorization. | +| `"node.address"` | string | The network address of the assigned node. | +| `"node.ephemeral_id"` | [NodeId](./NodeId.md) | The ephemeral identifier of the assigned node. | +| `"node.id"` | [NodeId](./NodeId.md) | The uniqe identifier of the assigned node. | +| `"node.name"` | string | The name of the assigned node. | +| `ae` | string | For open anomaly detection jobs only, contains messages relating to the selection of a node to run the job. assignment_explanation | +| `assignment_explanation` | string | For open anomaly detection jobs only, contains messages relating to the selection of a node to run the job. | +| `bc` | string | The number of bucket results produced by the job. 'buckets.count' | +| `btea` | string | The exponential moving average of all bucket processing times, in milliseconds. 'buckets.time.exp_avg' | +| `bteah` | string | The exponential moving average of bucket processing times calculated in a one hour time window, in milliseconds. 'buckets.time.exp_avg_hour' | +| `btmax` | string | The maximum of all bucket processing times, in milliseconds. 'buckets.time.max' | +| `btmin` | string | The minimum of all bucket processing times, in milliseconds. 'buckets.time.min' | +| `btt` | string | The sum of all bucket processing times, in milliseconds. 'buckets.time.total' | +| `bucketsCount` | string | The number of bucket results produced by the job. 'buckets.count' | +| `bucketsTimeExpAvg` | string | The exponential moving average of all bucket processing times, in milliseconds. 'buckets.time.exp_avg' | +| `bucketsTimeExpAvgHour` | string | The exponential moving average of bucket processing times calculated in a one hour time window, in milliseconds. 'buckets.time.exp_avg_hour' | +| `bucketsTimeMax` | string | The maximum of all bucket processing times, in milliseconds. 'buckets.time.max' | +| `bucketsTimeMin` | string | The minimum of all bucket processing times, in milliseconds. 'buckets.time.min' | +| `bucketsTimeTotal` | string | The sum of all bucket processing times, in milliseconds. 'buckets.time.total' | +| `dataBuckets` | string | The total number of buckets processed. 'data.buckets' | +| `dataEarliestRecord` | string | The timestamp of the earliest chronologically input document. 'data.earliest_record' | +| `dataEmptyBuckets` | string | The number of buckets which did not contain any data. If your data contains many empty buckets, consider increasing your `bucket_span` or using functions that are tolerant to gaps in data such as mean, `non_null_sum` or `non_zero_count`. 'data.empty_buckets' | +| `dataInputBytes` | [ByteSize](./ByteSize.md) | The number of bytes of input data posted to the anomaly detection job. 'data.input_bytes' | +| `dataInputFields` | string | The total number of fields in input documents posted to the anomaly detection job. This count includes fields that are not used in the analysis. However, be aware that if you are using a datafeed, it extracts only the required fields from the documents it retrieves before posting them to the job. 'data.input_fields' | +| `dataInputRecords` | string | The number of input documents posted to the anomaly detection job. 'data.input_records' | +| `dataInvalidDates` | string | The number of input documents with either a missing date field or a date that could not be parsed. 'data.invalid_dates' | +| `dataLast` | string | The timestamp at which data was last analyzed, according to server time. 'data.last' | +| `dataLastEmptyBucket` | string | The timestamp of the last bucket that did not contain any data. 'data.last_empty_bucket' | +| `dataLastSparseBucket` | string | The timestamp of the last bucket that was considered sparse. 'data.last_sparse_bucket' | +| `dataLatestRecord` | string | The timestamp of the latest chronologically input document. 'data.latest_record' | +| `dataMissingFields` | string | The number of input documents that are missing a field that the anomaly detection job is configured to analyze. Input documents with missing fields are still processed because it is possible that not all fields are missing. If you are using datafeeds or posting data to the job in JSON format, a high `missing_field_count` is often not an indication of data issues. It is not necessarily a cause for concern. 'data.missing_fields' | +| `dataOutOfOrderTimestamps` | string | The number of input documents that have a timestamp chronologically preceding the start of the current anomaly detection bucket offset by the latency window. This information is applicable only when you provide data to the anomaly detection job by using the post data API. These out of order documents are discarded, since jobs require time series data to be in ascending chronological order. 'data.out_of_order_timestamps' | +| `dataProcessedFields` | string | The total number of fields in all the documents that have been processed by the anomaly detection job. Only fields that are specified in the detector configuration object contribute to this count. The timestamp is not included in this count. 'data.processed_fields' | +| `dataProcessedRecords` | string | The number of input documents that have been processed by the anomaly detection job. This value includes documents with missing fields, since they are nonetheless analyzed. If you use datafeeds and have aggregations in your search query, the `processed_record_count` is the number of aggregation results processed, not the number of Elasticsearch documents. 'data.processed_records' | +| `dataSparseBuckets` | string | The number of buckets that contained few data points compared to the expected number of data points. If your data contains many sparse buckets, consider using a longer `bucket_span`. 'data.sparse_buckets' | +| `db` | string | The total number of buckets processed. 'data.buckets' | +| `deb` | string | The number of buckets which did not contain any data. If your data contains many empty buckets, consider increasing your `bucket_span` or using functions that are tolerant to gaps in data such as mean, `non_null_sum` or `non_zero_count`. 'data.empty_buckets' | +| `der` | string | The timestamp of the earliest chronologically input document. 'data.earliest_record' | +| `dib` | [ByteSize](./ByteSize.md) | The number of bytes of input data posted to the anomaly detection job. 'data.input_bytes' | +| `did` | string | The number of input documents with either a missing date field or a date that could not be parsed. 'data.invalid_dates' | +| `dif` | string | The total number of fields in input documents posted to the anomaly detection job. This count includes fields that are not used in the analysis. However, be aware that if you are using a datafeed, it extracts only the required fields from the documents it retrieves before posting them to the job. 'data.input_fields' | +| `dir` | string | The number of input documents posted to the anomaly detection job. 'data.input_records' | +| `dl` | string | The timestamp at which data was last analyzed, according to server time. 'data.last' | +| `dleb` | string | The timestamp of the last bucket that did not contain any data. 'data.last_empty_bucket' | +| `dlr` | string | The timestamp of the latest chronologically input document. 'data.latest_record' | +| `dlsb` | string | The timestamp of the last bucket that was considered sparse. 'data.last_sparse_bucket' | +| `dmf` | string | The number of input documents that are missing a field that the anomaly detection job is configured to analyze. Input documents with missing fields are still processed because it is possible that not all fields are missing. If you are using datafeeds or posting data to the job in JSON format, a high `missing_field_count` is often not an indication of data issues. It is not necessarily a cause for concern. 'data.missing_fields' | +| `doot` | string | The number of input documents that have a timestamp chronologically preceding the start of the current anomaly detection bucket offset by the latency window. This information is applicable only when you provide data to the anomaly detection job by using the post data API. These out of order documents are discarded, since jobs require time series data to be in ascending chronological order. 'data.out_of_order_timestamps' | +| `dpf` | string | The total number of fields in all the documents that have been processed by the anomaly detection job. Only fields that are specified in the detector configuration object contribute to this count. The timestamp is not included in this count. 'data.processed_fields' | +| `dpr` | string | The number of input documents that have been processed by the anomaly detection job. This value includes documents with missing fields, since they are nonetheless analyzed. If you use datafeeds and have aggregations in your search query, the `processed_record_count` is the number of aggregation results processed, not the number of Elasticsearch documents. 'data.processed_records' | +| `dsb` | string | The number of buckets that contained few data points compared to the expected number of data points. If your data contains many sparse buckets, consider using a longer `bucket_span`. 'data.sparse_buckets' | +| `fmavg` | string | The average memory usage in bytes for forecasts related to the anomaly detection job. 'forecasts.memory.avg' | +| `fmmax` | string | The maximum memory usage in bytes for forecasts related to the anomaly detection job. 'forecasts.memory.max' | +| `fmmin` | string | The minimum memory usage in bytes for forecasts related to the anomaly detection job. 'forecasts.memory.min' | +| `fmt` | string | The total memory usage in bytes for forecasts related to the anomaly detection job. 'forecasts.memory.total' | +| `forecastsMemoryAvg` | string | The average memory usage in bytes for forecasts related to the anomaly detection job. 'forecasts.memory.avg' | +| `forecastsMemoryMax` | string | The maximum memory usage in bytes for forecasts related to the anomaly detection job. 'forecasts.memory.max' | +| `forecastsMemoryMin` | string | The minimum memory usage in bytes for forecasts related to the anomaly detection job. 'forecasts.memory.min' | +| `forecastsMemoryTotal` | string | The total memory usage in bytes for forecasts related to the anomaly detection job. 'forecasts.memory.total' | +| `forecastsRecordsAvg` | string | The average number of `model_forecast` documents written for forecasts related to the anomaly detection job. 'forecasts.records.avg' | +| `forecastsRecordsMax` | string | The maximum number of `model_forecast` documents written for forecasts related to the anomaly detection job. 'forecasts.records.max' | +| `forecastsRecordsMin` | string | The minimum number of `model_forecast` documents written for forecasts related to the anomaly detection job. 'forecasts.records.min' | +| `forecastsRecordsTotal` | string | The total number of `model_forecast` documents written for forecasts related to the anomaly detection job. 'forecasts.records.total' | +| `forecastsTimeAvg` | string | The average runtime in milliseconds for forecasts related to the anomaly detection job. 'forecasts.time.avg' | +| `forecastsTimeMax` | string | The maximum runtime in milliseconds for forecasts related to the anomaly detection job. 'forecasts.time.max' | +| `forecastsTimeMin` | string | The minimum runtime in milliseconds for forecasts related to the anomaly detection job. 'forecasts.time.min' | +| `forecastsTimeTotal` | string | The total runtime in milliseconds for forecasts related to the anomaly detection job. 'forecasts.time.total' | +| `forecastsTotal` | string | The number of individual forecasts currently available for the job. A value of one or more indicates that forecasts exist. 'forecasts.total' | +| `fravg` | string | The average number of `model_forecast` documents written for forecasts related to the anomaly detection job. 'forecasts.records.avg' | +| `frmax` | string | The maximum number of `model_forecast` documents written for forecasts related to the anomaly detection job. 'forecasts.records.max' | +| `frmin` | string | The minimum number of `model_forecast` documents written for forecasts related to the anomaly detection job. 'forecasts.records.min' | +| `frt` | string | The total number of `model_forecast` documents written for forecasts related to the anomaly detection job. 'forecasts.records.total' | +| `ft` | string | The number of individual forecasts currently available for the job. A value of one or more indicates that forecasts exist. 'forecasts.total' | +| `ftavg` | string | The average runtime in milliseconds for forecasts related to the anomaly detection job. 'forecasts.time.avg' | +| `ftmax` | string | The maximum runtime in milliseconds for forecasts related to the anomaly detection job. 'forecasts.time.max' | +| `ftmin` | string | The minimum runtime in milliseconds for forecasts related to the anomaly detection job. 'forecasts.time.min' | +| `ftt` | string | The total runtime in milliseconds for forecasts related to the anomaly detection job. 'forecasts.time.total' | +| `id` | [Id](./Id.md) | The anomaly detection job identifier. | +| `mb` | [ByteSize](./ByteSize.md) | The number of bytes of memory used by the models. This is the maximum value since the last time the model was persisted. If the job is closed, this value indicates the latest size. 'model.bytes' | +| `mbaf` | string | The number of buckets for which new entities in incoming data were not processed due to insufficient model memory. This situation is also signified by a `hard_limit: memory_status` property value. 'model.bucket_allocation_failures' | +| `mbe` | [ByteSize](./ByteSize.md) | The number of bytes over the high limit for memory usage at the last allocation failure. 'model.bytes_exceeded' | +| `mbf` | string | The number of `by` field values that were analyzed by the models. This value is cumulative for all detectors in the job. 'model.by_fields' | +| `mcdc` | string | The number of documents that have had a field categorized. 'model.categorized_doc_count' | +| `mcs` | [MlCategorizationStatus](./MlCategorizationStatus.md) | The status of categorization for the job. 'model.categorization_status' | +| `mdcc` | string | The number of categories created by categorization that will never be assigned again because another category’s definition makes it a superset of the dead category. Dead categories are a side effect of the way categorization has no prior training. 'model.dead_category_count' | +| `mfcc` | string | The number of times that categorization wanted to create a new category but couldn’t because the job had hit its `model_memory_limit`. This count does not track which specific categories failed to be created. Therefore you cannot use this value to determine the number of unique categories that were missed. 'model.failed_category_count' | +| `mlt` | string | The timestamp when the model stats were gathered, according to server time. 'model.log_time' | +| `mml` | string | The upper limit for model memory usage, checked on increasing values. 'model.memory_limit' | +| `mms` | [MlMemoryStatus](./MlMemoryStatus.md) | The status of the mathematical models. 'model.memory_status' | +| `modelBucketAllocationFailures` | string | The number of buckets for which new entities in incoming data were not processed due to insufficient model memory. This situation is also signified by a `hard_limit: memory_status` property value. 'model.bucket_allocation_failures' | +| `modelByFields` | string | The number of `by` field values that were analyzed by the models. This value is cumulative for all detectors in the job. 'model.by_fields' | +| `modelBytes` | [ByteSize](./ByteSize.md) | The number of bytes of memory used by the models. This is the maximum value since the last time the model was persisted. If the job is closed, this value indicates the latest size. 'model.bytes' | +| `modelBytesExceeded` | [ByteSize](./ByteSize.md) | The number of bytes over the high limit for memory usage at the last allocation failure. 'model.bytes_exceeded' | +| `modelCategorizationStatus` | [MlCategorizationStatus](./MlCategorizationStatus.md) | The status of categorization for the job. 'model.categorization_status' | +| `modelCategorizedDocCount` | string | The number of documents that have had a field categorized. 'model.categorized_doc_count' | +| `modelDeadCategoryCount` | string | The number of categories created by categorization that will never be assigned again because another category’s definition makes it a superset of the dead category. Dead categories are a side effect of the way categorization has no prior training. 'model.dead_category_count' | +| `modelFailedCategoryCount` | string | The number of times that categorization wanted to create a new category but couldn’t because the job had hit its `model_memory_limit`. This count does not track which specific categories failed to be created. Therefore you cannot use this value to determine the number of unique categories that were missed. 'model.failed_category_count' | +| `modelFrequentCategoryCount` | string | The number of categories that match more than 1% of categorized documents. 'model.frequent_category_count' | +| `modelLogTime` | string | The timestamp when the model stats were gathered, according to server time. 'model.log_time' | +| `modelMemoryLimit` | string | The upper limit for model memory usage, checked on increasing values. 'model.memory_limit' | +| `modelMemoryStatus` | [MlMemoryStatus](./MlMemoryStatus.md) | The status of the mathematical models. 'model.memory_status' | +| `modelOverFields` | string | The number of `over` field values that were analyzed by the models. This value is cumulative for all detectors in the job. 'model.over_fields' | +| `modelPartitionFields` | string | The number of `partition` field values that were analyzed by the models. This value is cumulative for all detectors in the job. 'model.partition_fields' | +| `modelRareCategoryCount` | string | The number of categories that match just one categorized document. 'model.rare_category_count' | +| `modelTimestamp` | string | The timestamp of the last record when the model stats were gathered. 'model.timestamp' | +| `modelTotalCategoryCount` | string | The number of categories created by categorization. 'model.total_category_count' | +| `mof` | string | The number of `over` field values that were analyzed by the models. This value is cumulative for all detectors in the job. 'model.over_fields' | +| `mpf` | string | The number of `partition` field values that were analyzed by the models. This value is cumulative for all detectors in the job. 'model.partition_fields' | +| `mrcc` | string | The number of categories that match just one categorized document. 'model.rare_category_count' | +| `mt` | string | The timestamp of the last record when the model stats were gathered. 'model.timestamp' | +| `mtcc` | string | The number of categories created by categorization. 'model.total_category_count' | +| `na` | string | The network address of the assigned node. 'node.address' | +| `ne` | [NodeId](./NodeId.md) | The ephemeral identifier of the assigned node. 'node.ephemeral_id' | +| `ni` | [NodeId](./NodeId.md) | The uniqe identifier of the assigned node. 'node.id' | +| `nn` | string | The name of the assigned node. 'node.name' | +| `nodeAddress` | string | The network address of the assigned node. 'node.address' | +| `nodeEphemeralId` | [NodeId](./NodeId.md) | The ephemeral identifier of the assigned node. 'node.ephemeral_id' | +| `nodeId` | [NodeId](./NodeId.md) | The uniqe identifier of the assigned node. 'node.id' | +| `nodeName` | string | The name of the assigned node. 'node.name' | +| `opened_time` | string | For open jobs only, the amount of time the job has been opened. | +| `ot` | string | For open jobs only, the amount of time the job has been opened. opened_time | +| `s` | [MlJobState](./MlJobState.md) | The status of the anomaly detection job. state | +| `state` | [MlJobState](./MlJobState.md) | The status of the anomaly detection job. | diff --git a/docs/reference/api/CatMlJobsRequest.md b/docs/reference/api/CatMlJobsRequest.md new file mode 100644 index 000000000..a3fab502a --- /dev/null +++ b/docs/reference/api/CatMlJobsRequest.md @@ -0,0 +1,12 @@ +## Interface `CatMlJobsRequest` + +| Name | Type | Description | +| - | - | - | +| `allow_no_match` | boolean | Specifies what to do when the request: * Contains wildcard expressions and there are no jobs that match. * Contains the `_all` string or no identifiers and there are no matches. * Contains wildcard expressions and there are only partial matches. If `true`, the API returns an empty jobs array when there are no matches and the subset of results when there are partial matches. If `false`, the API returns a 404 status code when there are no matches or only partial matches. | +| `body` | string | ({ [key: string]: any; } & { job_id?: never; allow_no_match?: never; bytes?: never; h?: never; s?: never; time?: never; }) | All values in `body` will be added to the request body. | +| `bytes` | [Bytes](./Bytes.md) | The unit used to display byte values. | +| `h` | [CatCatAnonalyDetectorColumns](./CatCatAnonalyDetectorColumns.md) | Comma-separated list of column names to display. | +| `job_id` | [Id](./Id.md) | Identifier for the anomaly detection job. | +| `querystring` | { [key: string]: any; } & { job_id?: never; allow_no_match?: never; bytes?: never; h?: never; s?: never; time?: never; } | All values in `querystring` will be added to the request querystring. | +| `s` | [CatCatAnonalyDetectorColumns](./CatCatAnonalyDetectorColumns.md) | Comma-separated list of column names or column aliases used to sort the response. | +| `time` | [TimeUnit](./TimeUnit.md) | The unit used to display time values. | diff --git a/docs/reference/api/CatMlJobsResponse.md b/docs/reference/api/CatMlJobsResponse.md new file mode 100644 index 000000000..039389c79 --- /dev/null +++ b/docs/reference/api/CatMlJobsResponse.md @@ -0,0 +1,4 @@ +## `CatMlJobsResponse` +::: +type CatMlJobsResponse = [CatMlJobsJobsRecord](./CatMlJobsJobsRecord.md)[]; +::: diff --git a/docs/reference/api/CatMlTrainedModelsRequest.md b/docs/reference/api/CatMlTrainedModelsRequest.md new file mode 100644 index 000000000..031f2cd6a --- /dev/null +++ b/docs/reference/api/CatMlTrainedModelsRequest.md @@ -0,0 +1,14 @@ +## Interface `CatMlTrainedModelsRequest` + +| Name | Type | Description | +| - | - | - | +| `allow_no_match` | boolean | Specifies what to do when the request: contains wildcard expressions and there are no models that match; contains the `_all` string or no identifiers and there are no matches; contains wildcard expressions and there are only partial matches. If `true`, the API returns an empty array when there are no matches and the subset of results when there are partial matches. If `false`, the API returns a 404 status code when there are no matches or only partial matches. | +| `body` | string | ({ [key: string]: any; } & { model_id?: never; allow_no_match?: never; bytes?: never; h?: never; s?: never; from?: never; size?: never; time?: never; }) | All values in `body` will be added to the request body. | +| `bytes` | [Bytes](./Bytes.md) | The unit used to display byte values. | +| `from` | [integer](./integer.md) | Skips the specified number of transforms. | +| `h` | [CatCatTrainedModelsColumns](./CatCatTrainedModelsColumns.md) | A comma-separated list of column names to display. | +| `model_id` | [Id](./Id.md) | A unique identifier for the trained model. | +| `querystring` | { [key: string]: any; } & { model_id?: never; allow_no_match?: never; bytes?: never; h?: never; s?: never; from?: never; size?: never; time?: never; } | All values in `querystring` will be added to the request querystring. | +| `s` | [CatCatTrainedModelsColumns](./CatCatTrainedModelsColumns.md) | A comma-separated list of column names or aliases used to sort the response. | +| `size` | [integer](./integer.md) | The maximum number of transforms to display. | +| `time` | [TimeUnit](./TimeUnit.md) | Unit used to display time values. | diff --git a/docs/reference/api/CatMlTrainedModelsResponse.md b/docs/reference/api/CatMlTrainedModelsResponse.md new file mode 100644 index 000000000..e97a55e4d --- /dev/null +++ b/docs/reference/api/CatMlTrainedModelsResponse.md @@ -0,0 +1,4 @@ +## `CatMlTrainedModelsResponse` +::: +type CatMlTrainedModelsResponse = [CatMlTrainedModelsTrainedModelsRecord](./CatMlTrainedModelsTrainedModelsRecord.md)[]; +::: diff --git a/docs/reference/api/CatMlTrainedModelsTrainedModelsRecord.md b/docs/reference/api/CatMlTrainedModelsTrainedModelsRecord.md new file mode 100644 index 000000000..f24620b5b --- /dev/null +++ b/docs/reference/api/CatMlTrainedModelsTrainedModelsRecord.md @@ -0,0 +1,50 @@ +## Interface `CatMlTrainedModelsTrainedModelsRecord` + +| Name | Type | Description | +| - | - | - | +| `"data_frame.analysis"` | string | The analysis used by the data frame to build the model. | +| `"data_frame.create_time"` | string | The time the data frame analytics job was created. | +| `"data_frame.id"` | string | The identifier for the data frame analytics job that created the model. Only displayed if the job is still available. | +| `"data_frame.source_index"` | string | The source index used to train in the data frame analysis. | +| `"ingest.count"` | string | The total number of documents that are processed by the model. | +| `"ingest.current"` | string | The total number of documents that are currently being handled by the model. | +| `"ingest.failed"` | string | The total number of failed ingest attempts with the model. | +| `"ingest.pipelines"` | string | The number of pipelines that are referencing the model. | +| `"ingest.time"` | string | The total time spent processing documents with thie model. | +| `c` | string | Information about the creator of the model. created_by | +| `create_time` | [DateTime](./DateTime.md) | The time the model was created. | +| `created_by` | string | Information about the creator of the model. | +| `createdBy` | string | Information about the creator of the model. created_by | +| `ct` | [DateTime](./DateTime.md) | The time the model was created. create_time | +| `d` | string | A description of the model. description | +| `dataFrameAnalytics` | string | The identifier for the data frame analytics job that created the model. Only displayed if the job is still available. 'data_frame.id' | +| `dataFrameAnalyticsAnalysis` | string | The analysis used by the data frame to build the model. 'data_frame.analysis' | +| `dataFrameAnalyticsSrcIndex` | string | The source index used to train in the data frame analysis. 'data_frame.source_index' | +| `dataFrameAnalyticsTime` | string | The time the data frame analytics job was created. 'data_frame.create_time' | +| `description` | string | A description of the model. | +| `dfa` | string | The analysis used by the data frame to build the model. 'data_frame.analysis' | +| `dfid` | string | The identifier for the data frame analytics job that created the model. Only displayed if the job is still available. 'data_frame.id' | +| `dfsi` | string | The source index used to train in the data frame analysis. 'data_frame.source_index' | +| `dft` | string | The time the data frame analytics job was created. 'data_frame.create_time' | +| `heap_size` | [ByteSize](./ByteSize.md) | The estimated heap size to keep the model in memory. | +| `hs` | [ByteSize](./ByteSize.md) | The estimated heap size to keep the model in memory. heap_size | +| `ic` | string | The total number of documents that are processed by the model. 'ingest.count' | +| `icurr` | string | The total number of documents that are currently being handled by the model. 'ingest.current' | +| `id` | [Id](./Id.md) | The model identifier. | +| `if` | string | The total number of failed ingest attempts with the model. 'ingest.failed' | +| `ingestCount` | string | The total number of documents that are processed by the model. 'ingest.count' | +| `ingestCurrent` | string | The total number of documents that are currently being handled by the model. 'ingest.current' | +| `ingestFailed` | string | The total number of failed ingest attempts with the model. 'ingest.failed' | +| `ingestPipelines` | string | The number of pipelines that are referencing the model. 'ingest.pipelines' | +| `ingestTime` | string | The total time spent processing documents with thie model. 'ingest.time' | +| `ip` | string | The number of pipelines that are referencing the model. 'ingest.pipelines' | +| `it` | string | The total time spent processing documents with thie model. 'ingest.time' | +| `l` | string | The license level of the model. license | +| `license` | string | The license level of the model. | +| `modelHeapSize` | [ByteSize](./ByteSize.md) | The estimated heap size to keep the model in memory. heap_size | +| `modelOperations` | string | The estimated number of operations to use the model. This number helps to measure the computational complexity of the model. operations | +| `o` | string | The estimated number of operations to use the model. This number helps to measure the computational complexity of the model. operations | +| `operations` | string | The estimated number of operations to use the model. This number helps to measure the computational complexity of the model. | +| `type` | string |   | +| `v` | [VersionString](./VersionString.md) | The version of Elasticsearch when the model was created. version | +| `version` | [VersionString](./VersionString.md) | The version of Elasticsearch when the model was created. | diff --git a/docs/reference/api/CatNodeattrsNodeAttributesRecord.md b/docs/reference/api/CatNodeattrsNodeAttributesRecord.md new file mode 100644 index 000000000..02d5563a1 --- /dev/null +++ b/docs/reference/api/CatNodeattrsNodeAttributesRecord.md @@ -0,0 +1,14 @@ +## Interface `CatNodeattrsNodeAttributesRecord` + +| Name | Type | Description | +| - | - | - | +| `attr` | string | The attribute name. | +| `h` | string | The host name. host | +| `host` | string | The host name. | +| `i` | string | The IP address. ip | +| `id` | string | The unique node identifier. | +| `ip` | string | The IP address. | +| `node` | string | The node name. | +| `pid` | string | The process identifier. | +| `port` | string | The bound transport port. | +| `value` | string | The attribute value. | diff --git a/docs/reference/api/CatNodeattrsRequest.md b/docs/reference/api/CatNodeattrsRequest.md new file mode 100644 index 000000000..29d4a0bae --- /dev/null +++ b/docs/reference/api/CatNodeattrsRequest.md @@ -0,0 +1,10 @@ +## Interface `CatNodeattrsRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { h?: never; s?: never; local?: never; master_timeout?: never; }) | All values in `body` will be added to the request body. | +| `h` | [Names](./Names.md) | List of columns to appear in the response. Supports simple wildcards. | +| `local` | boolean | If `true`, the request computes the list of selected nodes from the local cluster state. If `false` the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node. | +| `master_timeout` | [Duration](./Duration.md) | Period to wait for a connection to the master node. | +| `querystring` | { [key: string]: any; } & { h?: never; s?: never; local?: never; master_timeout?: never; } | All values in `querystring` will be added to the request querystring. | +| `s` | [Names](./Names.md) | List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name. | diff --git a/docs/reference/api/CatNodeattrsResponse.md b/docs/reference/api/CatNodeattrsResponse.md new file mode 100644 index 000000000..8930d95f4 --- /dev/null +++ b/docs/reference/api/CatNodeattrsResponse.md @@ -0,0 +1,4 @@ +## `CatNodeattrsResponse` +::: +type CatNodeattrsResponse = [CatNodeattrsNodeAttributesRecord](./CatNodeattrsNodeAttributesRecord.md)[]; +::: diff --git a/docs/reference/api/CatNodesNodesRecord.md b/docs/reference/api/CatNodesNodesRecord.md new file mode 100644 index 000000000..a40eb369b --- /dev/null +++ b/docs/reference/api/CatNodesNodesRecord.md @@ -0,0 +1,271 @@ +## Interface `CatNodesNodesRecord` + +| Name | Type | Description | +| - | - | - | +| `"bulk.avg_size_in_bytes"` | string | The average size in bytes of shard bulk. | +| `"bulk.avg_time"` | string | The average time spend in shard bulk. | +| `"bulk.total_operations"` | string | The number of bulk shard operations. | +| `"bulk.total_size_in_bytes"` | string | The total size in bytes of shard bulk. | +| `"bulk.total_time"` | string | The time spend in shard bulk. | +| `"completion.size"` | string | The size of completion. | +| `"disk.avail"` | [ByteSize](./ByteSize.md) | The available disk space. | +| `"disk.total"` | [ByteSize](./ByteSize.md) | The total disk space. | +| `"disk.used_percent"` | [Percentage](./Percentage.md) | The used disk space percentage. | +| `"disk.used"` | [ByteSize](./ByteSize.md) | The used disk space. | +| `"fielddata.evictions"` | string | The fielddata evictions. | +| `"fielddata.memory_size"` | string | The used fielddata cache. | +| `"file_desc.current"` | string | The used file descriptors. | +| `"file_desc.max"` | string | The maximum number of file descriptors. | +| `"file_desc.percent"` | [Percentage](./Percentage.md) | The used file descriptor ratio. | +| `"flush.total_time"` | string | The time spent in flush. | +| `"flush.total"` | string | The number of flushes. | +| `"get.current"` | string | The number of current get ops. | +| `"get.exists_time"` | string | The time spent in successful gets. | +| `"get.exists_total"` | string | The number of successful get operations. | +| `"get.missing_time"` | string | The time spent in failed gets. | +| `"get.missing_total"` | string | The number of failed gets. | +| `"get.time"` | string | The time spent in get. | +| `"get.total"` | string | The number of get ops. | +| `"heap.current"` | string | The used heap. | +| `"heap.max"` | string | The maximum configured heap. | +| `"heap.percent"` | [Percentage](./Percentage.md) | The used heap ratio. | +| `"indexing.delete_current"` | string | The number of current deletions. | +| `"indexing.delete_time"` | string | The time spent in deletions. | +| `"indexing.delete_total"` | string | The number of delete operations. | +| `"indexing.index_current"` | string | The number of current indexing operations. | +| `"indexing.index_failed"` | string | The number of failed indexing operations. | +| `"indexing.index_time"` | string | The time spent in indexing. | +| `"indexing.index_total"` | string | The number of indexing operations. | +| `"merges.current_docs"` | string | The number of current merging docs. | +| `"merges.current_size"` | string | The size of current merges. | +| `"merges.current"` | string | The number of current merges. | +| `"merges.total_docs"` | string | The docs merged. | +| `"merges.total_size"` | string | The size merged. | +| `"merges.total_time"` | string | The time spent in merges. | +| `"merges.total"` | string | The number of completed merge operations. | +| `"node.role"` | string | The roles of the node. Returned values include `c`(cold node), `d`(data node), `f`(frozen node), `h`(hot node), `i`(ingest node), `l`(machine learning node), `m` (master eligible node), `r`(remote cluster client node), `s`(content node), `t`(transform node), `v`(voting-only node), `w`(warm node),and `-`(coordinating node only). | +| `"query_cache.evictions"` | string | The query cache evictions. | +| `"query_cache.hit_count"` | string | The query cache hit counts. | +| `"query_cache.memory_size"` | string | The used query cache. | +| `"query_cache.miss_count"` | string | The query cache miss counts. | +| `"ram.current"` | string | The used machine memory. | +| `"ram.max"` | string | The total machine memory. | +| `"ram.percent"` | [Percentage](./Percentage.md) | The used machine memory ratio. | +| `"refresh.external_time"` | string | The time spent in external refreshes. | +| `"refresh.external_total"` | string | The total external refreshes. | +| `"refresh.listeners"` | string | The number of pending refresh listeners. | +| `"refresh.time"` | string | The time spent in refreshes. | +| `"refresh.total"` | string | The total refreshes. | +| `"request_cache.evictions"` | string | The request cache evictions. | +| `"request_cache.hit_count"` | string | The request cache hit counts. | +| `"request_cache.memory_size"` | string | The used request cache. | +| `"request_cache.miss_count"` | string | The request cache miss counts. | +| `"script.cache_evictions"` | string | The total compiled scripts evicted from the cache. | +| `"script.compilation_limit_triggered"` | string | The script cache compilation limit triggered. | +| `"script.compilations"` | string | The total script compilations. | +| `"search.fetch_current"` | string | The current fetch phase operations. | +| `"search.fetch_time"` | string | The time spent in fetch phase. | +| `"search.fetch_total"` | string | The total fetch operations. | +| `"search.open_contexts"` | string | The open search contexts. | +| `"search.query_current"` | string | The current query phase operations. | +| `"search.query_time"` | string | The time spent in query phase. | +| `"search.query_total"` | string | The total query phase operations. | +| `"search.scroll_current"` | string | The open scroll contexts. | +| `"search.scroll_time"` | string | The time scroll contexts held open. | +| `"search.scroll_total"` | string | The completed scroll contexts. | +| `"segments.count"` | string | The number of segments. | +| `"segments.fixed_bitset_memory"` | string | The memory used by fixed bit sets for nested object field types and export type filters for types referred in _parent fields. | +| `"segments.index_writer_memory"` | string | The memory used by the index writer. | +| `"segments.memory"` | string | The memory used by segments. | +| `"segments.version_map_memory"` | string | The memory used by the version map. | +| `"suggest.current"` | string | The number of current suggest operations. | +| `"suggest.time"` | string | The time spend in suggest. | +| `"suggest.total"` | string | The number of suggest operations. | +| `b` | string | The Elasticsearch build hash. build | +| `basi` | string | The average size in bytes of shard bulk. 'bulk.avg_size_in_bytes' | +| `bati` | string | The average time spend in shard bulk. 'bulk.avg_time' | +| `bto` | string | The number of bulk shard operations. 'bulk.total_operations' | +| `btsi` | string | The total size in bytes of shard bulk. 'bulk.total_size_in_bytes' | +| `btti` | string | The time spend in shard bulk. 'bulk.total_time' | +| `build` | string | The Elasticsearch build hash. | +| `bulkAvgSizeInBytes` | string | The average size in bytes of shard bulk. 'bulk.avg_size_in_bytes' | +| `bulkAvgTime` | string | The average time spend in shard bulk. 'bulk.avg_time' | +| `bulkTotalOperations` | string | The number of bulk shard operations. 'bulk.total_operations' | +| `bulkTotalSizeInBytes` | string | The total size in bytes of shard bulk. 'bulk.total_size_in_bytes' | +| `bulkTotalTime` | string | The time spend in shard bulk. 'bulk.total_time' | +| `completionSize` | string | The size of completion. 'completion.size' | +| `cpu` | string | The recent system CPU usage as a percentage. | +| `cs` | string | The size of completion. 'completion.size' | +| `d` | [ByteSize](./ByteSize.md) | The available disk space. 'disk.avail' | +| `da` | [ByteSize](./ByteSize.md) | The available disk space. 'disk.avail' | +| `disk` | [ByteSize](./ByteSize.md) | The available disk space. 'disk.avail' | +| `diskAvail` | [ByteSize](./ByteSize.md) | The available disk space. 'disk.avail' | +| `diskTotal` | [ByteSize](./ByteSize.md) | The total disk space. 'disk.total' | +| `diskUsed` | [ByteSize](./ByteSize.md) | The used disk space. 'disk.used' | +| `diskUsedPercent` | [Percentage](./Percentage.md) | The used disk space percentage. 'disk.used_percent' | +| `dt` | [ByteSize](./ByteSize.md) | The total disk space. 'disk.total' | +| `du` | [ByteSize](./ByteSize.md) | The used disk space. 'disk.used' | +| `dup` | [Percentage](./Percentage.md) | The used disk space percentage. 'disk.used_percent' | +| `f` | string | The Elasticsearch distribution flavor. flavor | +| `fdc` | string | The used file descriptors. 'file_desc.current' | +| `fdm` | string | The maximum number of file descriptors. 'file_desc.max' | +| `fdp` | [Percentage](./Percentage.md) | The used file descriptor ratio. 'file_desc.percent' | +| `fe` | string | The fielddata evictions. 'fielddata.evictions' | +| `fielddataEvictions` | string | The fielddata evictions. 'fielddata.evictions' | +| `fielddataMemory` | string | The used fielddata cache. 'fielddata.memory_size' | +| `fileDescriptorCurrent` | string | The used file descriptors. 'file_desc.current' | +| `fileDescriptorMax` | string | The maximum number of file descriptors. 'file_desc.max' | +| `fileDescriptorPercent` | [Percentage](./Percentage.md) | The used file descriptor ratio. 'file_desc.percent' | +| `fixedBitsetMemory` | string | The memory used by fixed bit sets for nested object field types and export type filters for types referred in _parent fields. 'segments.fixed_bitset_memory' | +| `flavor` | string | The Elasticsearch distribution flavor. | +| `flushTotal` | string | The number of flushes. 'flush.total' | +| `flushTotalTime` | string | The time spent in flush. 'flush.total_time' | +| `fm` | string | The used fielddata cache. 'fielddata.memory_size' | +| `ft` | string | The number of flushes. 'flush.total' | +| `ftt` | string | The time spent in flush. 'flush.total_time' | +| `gc` | string | The number of current get ops. 'get.current' | +| `getCurrent` | string | The number of current get ops. 'get.current' | +| `getExistsTime` | string | The time spent in successful gets. 'get.exists_time' | +| `getExistsTotal` | string | The number of successful get operations. 'get.exists_total' | +| `geti` | string | The time spent in successful gets. 'get.exists_time' | +| `getMissingTime` | string | The time spent in failed gets. 'get.missing_time' | +| `getMissingTotal` | string | The number of failed gets. 'get.missing_total' | +| `geto` | string | The number of successful get operations. 'get.exists_total' | +| `getTime` | string | The time spent in get. 'get.time' | +| `getTotal` | string | The number of get ops. 'get.total' | +| `gmti` | string | The time spent in failed gets. 'get.missing_time' | +| `gmto` | string | The number of failed gets. 'get.missing_total' | +| `gti` | string | The time spent in get. 'get.time' | +| `gto` | string | The number of get ops. 'get.total' | +| `hc` | string | The used heap. 'heap.current' | +| `heapCurrent` | string | The used heap. 'heap.current' | +| `heapMax` | string | The maximum configured heap. 'heap.max' | +| `heapPercent` | [Percentage](./Percentage.md) | The used heap ratio. 'heap.percent' | +| `hm` | string | The maximum configured heap. 'heap.max' | +| `hp` | [Percentage](./Percentage.md) | The used heap ratio. 'heap.percent' | +| `http_address` | string | The bound HTTP address. | +| `http` | string | The bound HTTP address. http_address | +| `i` | string | The IP address. ip | +| `id` | [Id](./Id.md) | The unique node identifier. | +| `idc` | string | The number of current deletions. 'indexing.delete_current' | +| `idti` | string | The time spent in deletions. 'indexing.delete_time' | +| `idto` | string | The number of delete operations. 'indexing.delete_total' | +| `iic` | string | The number of current indexing operations. 'indexing.index_current' | +| `iif` | string | The number of failed indexing operations. 'indexing.index_failed' | +| `iiti` | string | The time spent in indexing. 'indexing.index_time' | +| `iito` | string | The number of indexing operations. 'indexing.index_total' | +| `indexingDeleteCurrent` | string | The number of current deletions. 'indexing.delete_current' | +| `indexingDeleteTime` | string | The time spent in deletions. 'indexing.delete_time' | +| `indexingDeleteTotal` | string | The number of delete operations. 'indexing.delete_total' | +| `indexingIndexCurrent` | string | The number of current indexing operations. 'indexing.index_current' | +| `indexingIndexFailed` | string | The number of failed indexing operations. 'indexing.index_failed' | +| `indexingIndexTime` | string | The time spent in indexing. 'indexing.index_time' | +| `indexingIndexTotal` | string | The number of indexing operations. 'indexing.index_total' | +| `ip` | string | The IP address. | +| `j` | string | The Java version. jdk | +| `jdk` | string | The Java version. | +| `l` | string | The load average for the last fifteen minutes. load_15m | +| `load_15m` | string | The load average for the last fifteen minutes. | +| `load_1m` | string | The load average for the most recent minute. | +| `load_5m` | string | The load average for the last five minutes. | +| `m` | string | Indicates whether the node is the elected master node. Returned values include `*`(elected master) and `-`(not elected master). master | +| `master` | string | Indicates whether the node is the elected master node. Returned values include `*`(elected master) and `-`(not elected master). | +| `mc` | string | The number of current merges. 'merges.current' | +| `mcd` | string | The number of current merging docs. 'merges.current_docs' | +| `mcs` | string | The size of current merges. 'merges.current_size' | +| `mergesCurrent` | string | The number of current merges. 'merges.current' | +| `mergesCurrentDocs` | string | The number of current merging docs. 'merges.current_docs' | +| `mergesCurrentSize` | string | The size of current merges. 'merges.current_size' | +| `mergesTotal` | string | The number of completed merge operations. 'merges.total' | +| `mergesTotalDocs` | string | The docs merged. 'merges.total_docs' | +| `mergesTotalSize` | string | The size merged. 'merges.total_size' | +| `mergesTotalTime` | string | The time spent in merges. 'merges.total_time' | +| `mt` | string | The number of completed merge operations. 'merges.total' | +| `mtd` | string | The docs merged. 'merges.total_docs' | +| `mts` | string | The size merged. 'merges.total_size' | +| `mtt` | string | The time spent in merges. 'merges.total_time' | +| `n` | [Name](./Name.md) | The node name. name | +| `name` | [Name](./Name.md) | The node name. | +| `nodeId` | [Id](./Id.md) | The unique node identifier. id | +| `nodeRole` | string | The roles of the node. Returned values include `c`(cold node), `d`(data node), `f`(frozen node), `h`(hot node), `i`(ingest node), `l`(machine learning node), `m` (master eligible node), `r`(remote cluster client node), `s`(content node), `t`(transform node), `v`(voting-only node), `w`(warm node),and `-`(coordinating node only). 'node.role' | +| `p` | string | The process identifier. pid | +| `pid` | string | The process identifier. | +| `po` | string | The bound transport port. port | +| `port` | string | The bound transport port. | +| `qce` | string | The query cache evictions. 'query_cache.evictions' | +| `qchc` | string | The query cache hit counts. 'query_cache.hit_count' | +| `qcm` | string | The used query cache. 'query_cache.memory_size' | +| `qcmc` | string | The query cache miss counts. 'query_cache.miss_count' | +| `queryCacheEvictions` | string | The query cache evictions. 'query_cache.evictions' | +| `queryCacheHitCount` | string | The query cache hit counts. 'query_cache.hit_count' | +| `queryCacheMemory` | string | The used query cache. 'query_cache.memory_size' | +| `queryCacheMissCount` | string | The query cache miss counts. 'query_cache.miss_count' | +| `r` | string | The roles of the node. Returned values include `c`(cold node), `d`(data node), `f`(frozen node), `h`(hot node), `i`(ingest node), `l`(machine learning node), `m` (master eligible node), `r`(remote cluster client node), `s`(content node), `t`(transform node), `v`(voting-only node), `w`(warm node),and `-`(coordinating node only). 'node.role' | +| `ramCurrent` | string | The used machine memory. 'ram.current' | +| `ramMax` | string | The total machine memory. 'ram.max' | +| `ramPercent` | [Percentage](./Percentage.md) | The used machine memory ratio. 'ram.percent' | +| `rc` | string | The used machine memory. 'ram.current' | +| `rce` | string | The request cache evictions. 'request_cache.evictions' | +| `rchc` | string | The request cache hit counts. 'request_cache.hit_count' | +| `rcm` | string | The used request cache. 'request_cache.memory_size' | +| `rcmc` | string | The request cache miss counts. 'request_cache.miss_count' | +| `refreshListeners` | string | The number of pending refresh listeners. 'refresh.listeners' | +| `refreshTime` | string | The time spent in external refreshes. 'refresh.external_time' | +| `refreshTotal` | string | The total external refreshes. 'refresh.external_total' | +| `requestCacheEvictions` | string | The request cache evictions. 'request_cache.evictions' | +| `requestCacheHitCount` | string | The request cache hit counts. 'request_cache.hit_count' | +| `requestCacheMemory` | string | The used request cache. 'request_cache.memory_size' | +| `requestCacheMissCount` | string | The request cache miss counts. 'request_cache.miss_count' | +| `rli` | string | The number of pending refresh listeners. 'refresh.listeners' | +| `rn` | string | The total machine memory. 'ram.max' | +| `role` | string | The roles of the node. Returned values include `c`(cold node), `d`(data node), `f`(frozen node), `h`(hot node), `i`(ingest node), `l`(machine learning node), `m` (master eligible node), `r`(remote cluster client node), `s`(content node), `t`(transform node), `v`(voting-only node), `w`(warm node),and `-`(coordinating node only). 'node.role' | +| `rp` | [Percentage](./Percentage.md) | The used machine memory ratio. 'ram.percent' | +| `rti` | string | The time spent in external refreshes. 'refresh.external_time' | +| `rto` | string | The total external refreshes. 'refresh.external_total' | +| `sc` | string | The number of segments. 'segments.count' | +| `scc` | string | The open scroll contexts. 'search.scroll_current' | +| `scrcc` | string | The total script compilations. 'script.compilations' | +| `scrce` | string | The total compiled scripts evicted from the cache. 'script.cache_evictions' | +| `scrclt` | string | The script cache compilation limit triggered. 'script.compilation_limit_triggered' | +| `scriptCacheCompilationLimitTriggered` | string | The script cache compilation limit triggered. 'script.compilation_limit_triggered' | +| `scriptCacheEvictions` | string | The total compiled scripts evicted from the cache. 'script.cache_evictions' | +| `scriptCompilations` | string | The total script compilations. 'script.compilations' | +| `scti` | string | The time scroll contexts held open. 'search.scroll_time' | +| `scto` | string | The completed scroll contexts. 'search.scroll_total' | +| `searchFetchCurrent` | string | The current fetch phase operations. 'search.fetch_current' | +| `searchFetchTime` | string | The time spent in fetch phase. 'search.fetch_time' | +| `searchFetchTotal` | string | The total fetch operations. 'search.fetch_total' | +| `searchOpenContexts` | string | The open search contexts. 'search.open_contexts' | +| `searchQueryCurrent` | string | The current query phase operations. 'search.query_current' | +| `searchQueryTime` | string | The time spent in query phase. 'search.query_time' | +| `searchQueryTotal` | string | The total query phase operations. 'search.query_total' | +| `searchScrollCurrent` | string | The open scroll contexts. 'search.scroll_current' | +| `searchScrollTime` | string | The time scroll contexts held open. 'search.scroll_time' | +| `searchScrollTotal` | string | The completed scroll contexts. 'search.scroll_total' | +| `segmentsCount` | string | The number of segments. 'segments.count' | +| `segmentsIndexWriterMemory` | string | The memory used by the index writer. 'segments.index_writer_memory' | +| `segmentsMemory` | string | The memory used by segments. 'segments.memory' | +| `segmentsVersionMapMemory` | string | The memory used by the version map. 'segments.version_map_memory' | +| `sfbm` | string | The memory used by fixed bit sets for nested object field types and export type filters for types referred in _parent fields. 'segments.fixed_bitset_memory' | +| `sfc` | string | The current fetch phase operations. 'search.fetch_current' | +| `sfti` | string | The time spent in fetch phase. 'search.fetch_time' | +| `sfto` | string | The total fetch operations. 'search.fetch_total' | +| `siwm` | string | The memory used by the index writer. 'segments.index_writer_memory' | +| `sm` | string | The memory used by segments. 'segments.memory' | +| `so` | string | The open search contexts. 'search.open_contexts' | +| `sqc` | string | The current query phase operations. 'search.query_current' | +| `sqti` | string | The time spent in query phase. 'search.query_time' | +| `sqto` | string | The total query phase operations. 'search.query_total' | +| `suc` | string | The number of current suggest operations. 'suggest.current' | +| `suggestCurrent` | string | The number of current suggest operations. 'suggest.current' | +| `suggestTime` | string | The time spend in suggest. 'suggest.time' | +| `suggestTotal` | string | The number of suggest operations. 'suggest.total' | +| `suti` | string | The time spend in suggest. 'suggest.time' | +| `suto` | string | The number of suggest operations. 'suggest.total' | +| `svmm` | string | The memory used by the version map. 'segments.version_map_memory' | +| `t` | string | The Elasticsearch distribution type. type | +| `type` | string | The Elasticsearch distribution type. | +| `u` | string | The node uptime. uptime | +| `uptime` | string | The node uptime. | +| `v` | [VersionString](./VersionString.md) | The Elasticsearch version. version | +| `version` | [VersionString](./VersionString.md) | The Elasticsearch version. | diff --git a/docs/reference/api/CatNodesRequest.md b/docs/reference/api/CatNodesRequest.md new file mode 100644 index 000000000..01f720c0e --- /dev/null +++ b/docs/reference/api/CatNodesRequest.md @@ -0,0 +1,13 @@ +## Interface `CatNodesRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { bytes?: never; full_id?: never; include_unloaded_segments?: never; h?: never; s?: never; master_timeout?: never; time?: never; }) | All values in `body` will be added to the request body. | +| `bytes` | [Bytes](./Bytes.md) | The unit used to display byte values. | +| `full_id` | boolean | string | If `true`, return the full node ID. If `false`, return the shortened node ID. | +| `h` | [CatCatNodeColumns](./CatCatNodeColumns.md) | A comma-separated list of columns names to display. It supports simple wildcards. | +| `include_unloaded_segments` | boolean | If true, the response includes information from segments that are not loaded into memory. | +| `master_timeout` | [Duration](./Duration.md) | The period to wait for a connection to the master node. | +| `querystring` | { [key: string]: any; } & { bytes?: never; full_id?: never; include_unloaded_segments?: never; h?: never; s?: never; master_timeout?: never; time?: never; } | All values in `querystring` will be added to the request querystring. | +| `s` | [Names](./Names.md) | A comma-separated list of column names or aliases that determines the sort order. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name. | +| `time` | [TimeUnit](./TimeUnit.md) | The unit used to display time values. | diff --git a/docs/reference/api/CatNodesResponse.md b/docs/reference/api/CatNodesResponse.md new file mode 100644 index 000000000..9398c0b83 --- /dev/null +++ b/docs/reference/api/CatNodesResponse.md @@ -0,0 +1,4 @@ +## `CatNodesResponse` +::: +type CatNodesResponse = [CatNodesNodesRecord](./CatNodesNodesRecord.md)[]; +::: diff --git a/docs/reference/api/CatPendingTasksPendingTasksRecord.md b/docs/reference/api/CatPendingTasksPendingTasksRecord.md new file mode 100644 index 000000000..31a0071ed --- /dev/null +++ b/docs/reference/api/CatPendingTasksPendingTasksRecord.md @@ -0,0 +1,12 @@ +## Interface `CatPendingTasksPendingTasksRecord` + +| Name | Type | Description | +| - | - | - | +| `insertOrder` | string | The task insertion order. | +| `o` | string | The task insertion order. insertOrder | +| `p` | string | The task priority. priority | +| `priority` | string | The task priority. | +| `s` | string | The task source. source | +| `source` | string | The task source. | +| `t` | string | Indicates how long the task has been in queue. timeInQueue | +| `timeInQueue` | string | Indicates how long the task has been in queue. | diff --git a/docs/reference/api/CatPendingTasksRequest.md b/docs/reference/api/CatPendingTasksRequest.md new file mode 100644 index 000000000..792f92f34 --- /dev/null +++ b/docs/reference/api/CatPendingTasksRequest.md @@ -0,0 +1,11 @@ +## Interface `CatPendingTasksRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { h?: never; s?: never; local?: never; master_timeout?: never; time?: never; }) | All values in `body` will be added to the request body. | +| `h` | [Names](./Names.md) | List of columns to appear in the response. Supports simple wildcards. | +| `local` | boolean | If `true`, the request computes the list of selected nodes from the local cluster state. If `false` the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node. | +| `master_timeout` | [Duration](./Duration.md) | Period to wait for a connection to the master node. | +| `querystring` | { [key: string]: any; } & { h?: never; s?: never; local?: never; master_timeout?: never; time?: never; } | All values in `querystring` will be added to the request querystring. | +| `s` | [Names](./Names.md) | List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name. | +| `time` | [TimeUnit](./TimeUnit.md) | Unit used to display time values. | diff --git a/docs/reference/api/CatPendingTasksResponse.md b/docs/reference/api/CatPendingTasksResponse.md new file mode 100644 index 000000000..866bfa88d --- /dev/null +++ b/docs/reference/api/CatPendingTasksResponse.md @@ -0,0 +1,4 @@ +## `CatPendingTasksResponse` +::: +type CatPendingTasksResponse = [CatPendingTasksPendingTasksRecord](./CatPendingTasksPendingTasksRecord.md)[]; +::: diff --git a/docs/reference/api/CatPluginsPluginsRecord.md b/docs/reference/api/CatPluginsPluginsRecord.md new file mode 100644 index 000000000..75e723477 --- /dev/null +++ b/docs/reference/api/CatPluginsPluginsRecord.md @@ -0,0 +1,15 @@ +## Interface `CatPluginsPluginsRecord` + +| Name | Type | Description | +| - | - | - | +| `c` | string | The component name. component | +| `component` | string | The component name. | +| `d` | string | The plugin details. description | +| `description` | string | The plugin details. | +| `id` | [NodeId](./NodeId.md) | The unique node identifier. | +| `n` | [Name](./Name.md) | The node name. name | +| `name` | [Name](./Name.md) | The node name. | +| `t` | string | The plugin type. type | +| `type` | string | The plugin type. | +| `v` | [VersionString](./VersionString.md) | The component version. version | +| `version` | [VersionString](./VersionString.md) | The component version. | diff --git a/docs/reference/api/CatPluginsRequest.md b/docs/reference/api/CatPluginsRequest.md new file mode 100644 index 000000000..4c32eb525 --- /dev/null +++ b/docs/reference/api/CatPluginsRequest.md @@ -0,0 +1,11 @@ +## Interface `CatPluginsRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { h?: never; s?: never; include_bootstrap?: never; local?: never; master_timeout?: never; }) | All values in `body` will be added to the request body. | +| `h` | [Names](./Names.md) | List of columns to appear in the response. Supports simple wildcards. | +| `include_bootstrap` | boolean | Include bootstrap plugins in the response | +| `local` | boolean | If `true`, the request computes the list of selected nodes from the local cluster state. If `false` the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node. | +| `master_timeout` | [Duration](./Duration.md) | Period to wait for a connection to the master node. | +| `querystring` | { [key: string]: any; } & { h?: never; s?: never; include_bootstrap?: never; local?: never; master_timeout?: never; } | All values in `querystring` will be added to the request querystring. | +| `s` | [Names](./Names.md) | List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name. | diff --git a/docs/reference/api/CatPluginsResponse.md b/docs/reference/api/CatPluginsResponse.md new file mode 100644 index 000000000..3e6499d79 --- /dev/null +++ b/docs/reference/api/CatPluginsResponse.md @@ -0,0 +1,4 @@ +## `CatPluginsResponse` +::: +type CatPluginsResponse = [CatPluginsPluginsRecord](./CatPluginsPluginsRecord.md)[]; +::: diff --git a/docs/reference/api/CatRecoveryRecoveryRecord.md b/docs/reference/api/CatRecoveryRecoveryRecord.md new file mode 100644 index 000000000..d20d6c039 --- /dev/null +++ b/docs/reference/api/CatRecoveryRecoveryRecord.md @@ -0,0 +1,59 @@ +## Interface `CatRecoveryRecoveryRecord` + +| Name | Type | Description | +| - | - | - | +| `b` | string | The number of bytes to recover. bytes | +| `bp` | [Percentage](./Percentage.md) | The ratio of bytes recovered. bytes_percent | +| `br` | string | The bytes recovered. bytes_recovered | +| `bytes_percent` | [Percentage](./Percentage.md) | The ratio of bytes recovered. | +| `bytes_recovered` | string | The bytes recovered. | +| `bytes_total` | string | The total number of bytes. | +| `bytes` | string | The number of bytes to recover. | +| `f` | string | The number of files to recover. files | +| `files_percent` | [Percentage](./Percentage.md) | The ratio of files recovered. | +| `files_recovered` | string | The files recovered. | +| `files_total` | string | The total number of files. | +| `files` | string | The number of files to recover. | +| `fp` | [Percentage](./Percentage.md) | The ratio of files recovered. files_percent | +| `fr` | string | The files recovered. files_recovered | +| `i` | [IndexName](./IndexName.md) | The index name. index | +| `idx` | [IndexName](./IndexName.md) | The index name. index | +| `index` | [IndexName](./IndexName.md) | The index name. | +| `rep` | string | The repository name. repository | +| `repository` | string | The repository name. | +| `s` | string | The shard name. shard | +| `sh` | string | The shard name. shard | +| `shard` | string | The shard name. | +| `shost` | string | The source host. source_host | +| `snap` | string | The snapshot name. snapshot | +| `snapshot` | string | The snapshot name. | +| `snode` | string | The source node name. source_node | +| `source_host` | string | The source host. | +| `source_node` | string | The source node name. | +| `st` | string | The recovery stage. stage | +| `stage` | string | The recovery stage. | +| `start_millis` | [EpochTime](./EpochTime.md)<[UnitMillis](./UnitMillis.md)> | The recovery start time in epoch milliseconds. start_time_millis | +| `start_time_millis` | [EpochTime](./EpochTime.md)<[UnitMillis](./UnitMillis.md)> | The recovery start time in epoch milliseconds. | +| `start_time` | [DateTime](./DateTime.md) | The recovery start time. | +| `start` | [DateTime](./DateTime.md) | The recovery start time. start_time | +| `stop_millis` | [EpochTime](./EpochTime.md)<[UnitMillis](./UnitMillis.md)> | The recovery stop time in epoch milliseconds. stop_time_millis | +| `stop_time_millis` | [EpochTime](./EpochTime.md)<[UnitMillis](./UnitMillis.md)> | The recovery stop time in epoch milliseconds. | +| `stop_time` | [DateTime](./DateTime.md) | The recovery stop time. | +| `stop` | [DateTime](./DateTime.md) | The recovery stop time. stop_time | +| `t` | [Duration](./Duration.md) | The recovery time. time | +| `target_host` | string | The target host. | +| `target_node` | string | The target node name. | +| `tb` | string | The total number of bytes. bytes_total | +| `tf` | string | The total number of files. files_total | +| `thost` | string | The target host. target_host | +| `ti` | [Duration](./Duration.md) | The recovery time. time | +| `time` | [Duration](./Duration.md) | The recovery time. | +| `tnode` | string | The target node name. target_node | +| `to` | string | The number of translog operations to recover. translog_ops | +| `top` | [Percentage](./Percentage.md) | The ratio of translog operations recovered. translog_ops_percent | +| `tor` | string | The translog operations recovered. translog_ops_recovered | +| `translog_ops_percent` | [Percentage](./Percentage.md) | The ratio of translog operations recovered. | +| `translog_ops_recovered` | string | The translog operations recovered. | +| `translog_ops` | string | The number of translog operations to recover. | +| `ty` | string | The recovery type. type | +| `type` | string | The recovery type. | diff --git a/docs/reference/api/CatRecoveryRequest.md b/docs/reference/api/CatRecoveryRequest.md new file mode 100644 index 000000000..32a01f834 --- /dev/null +++ b/docs/reference/api/CatRecoveryRequest.md @@ -0,0 +1,13 @@ +## Interface `CatRecoveryRequest` + +| Name | Type | Description | +| - | - | - | +| `active_only` | boolean | If `true`, the response only includes ongoing shard recoveries. | +| `body` | string | ({ [key: string]: any; } & { index?: never; active_only?: never; bytes?: never; detailed?: never; h?: never; s?: never; time?: never; }) | All values in `body` will be added to the request body. | +| `bytes` | [Bytes](./Bytes.md) | The unit used to display byte values. | +| `detailed` | boolean | If `true`, the response includes detailed information about shard recoveries. | +| `h` | [Names](./Names.md) | List of columns to appear in the response. Supports simple wildcards. | +| `index` | [Indices](./Indices.md) | A comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards ( `*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. | +| `querystring` | { [key: string]: any; } & { index?: never; active_only?: never; bytes?: never; detailed?: never; h?: never; s?: never; time?: never; } | All values in `querystring` will be added to the request querystring. | +| `s` | [Names](./Names.md) | List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name. | +| `time` | [TimeUnit](./TimeUnit.md) | Unit used to display time values. | diff --git a/docs/reference/api/CatRecoveryResponse.md b/docs/reference/api/CatRecoveryResponse.md new file mode 100644 index 000000000..d87801f44 --- /dev/null +++ b/docs/reference/api/CatRecoveryResponse.md @@ -0,0 +1,4 @@ +## `CatRecoveryResponse` +::: +type CatRecoveryResponse = [CatRecoveryRecoveryRecord](./CatRecoveryRecoveryRecord.md)[]; +::: diff --git a/docs/reference/api/CatRepositoriesRepositoriesRecord.md b/docs/reference/api/CatRepositoriesRepositoriesRecord.md new file mode 100644 index 000000000..7acc4cb7f --- /dev/null +++ b/docs/reference/api/CatRepositoriesRepositoriesRecord.md @@ -0,0 +1,8 @@ +## Interface `CatRepositoriesRepositoriesRecord` + +| Name | Type | Description | +| - | - | - | +| `id` | string | The unique repository identifier. | +| `repoId` | string | The unique repository identifier. id | +| `t` | string | The repository type. type | +| `type` | string | The repository type. | diff --git a/docs/reference/api/CatRepositoriesRequest.md b/docs/reference/api/CatRepositoriesRequest.md new file mode 100644 index 000000000..1b971523e --- /dev/null +++ b/docs/reference/api/CatRepositoriesRequest.md @@ -0,0 +1,10 @@ +## Interface `CatRepositoriesRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { h?: never; s?: never; local?: never; master_timeout?: never; }) | All values in `body` will be added to the request body. | +| `h` | [Names](./Names.md) | List of columns to appear in the response. Supports simple wildcards. | +| `local` | boolean | If `true`, the request computes the list of selected nodes from the local cluster state. If `false` the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node. | +| `master_timeout` | [Duration](./Duration.md) | Period to wait for a connection to the master node. | +| `querystring` | { [key: string]: any; } & { h?: never; s?: never; local?: never; master_timeout?: never; } | All values in `querystring` will be added to the request querystring. | +| `s` | [Names](./Names.md) | List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name. | diff --git a/docs/reference/api/CatRepositoriesResponse.md b/docs/reference/api/CatRepositoriesResponse.md new file mode 100644 index 000000000..f704850ab --- /dev/null +++ b/docs/reference/api/CatRepositoriesResponse.md @@ -0,0 +1,4 @@ +## `CatRepositoriesResponse` +::: +type CatRepositoriesResponse = [CatRepositoriesRepositoriesRecord](./CatRepositoriesRepositoriesRecord.md)[]; +::: diff --git a/docs/reference/api/CatSegmentsRequest.md b/docs/reference/api/CatSegmentsRequest.md new file mode 100644 index 000000000..5c43a1651 --- /dev/null +++ b/docs/reference/api/CatSegmentsRequest.md @@ -0,0 +1,12 @@ +## Interface `CatSegmentsRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { index?: never; bytes?: never; h?: never; s?: never; local?: never; master_timeout?: never; }) | All values in `body` will be added to the request body. | +| `bytes` | [Bytes](./Bytes.md) | The unit used to display byte values. | +| `h` | [Names](./Names.md) | List of columns to appear in the response. Supports simple wildcards. | +| `index` | [Indices](./Indices.md) | A comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards ( `*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. | +| `local` | boolean | If `true`, the request computes the list of selected nodes from the local cluster state. If `false` the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node. | +| `master_timeout` | [Duration](./Duration.md) | Period to wait for a connection to the master node. | +| `querystring` | { [key: string]: any; } & { index?: never; bytes?: never; h?: never; s?: never; local?: never; master_timeout?: never; } | All values in `querystring` will be added to the request querystring. | +| `s` | [Names](./Names.md) | List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name. | diff --git a/docs/reference/api/CatSegmentsResponse.md b/docs/reference/api/CatSegmentsResponse.md new file mode 100644 index 000000000..788112c5b --- /dev/null +++ b/docs/reference/api/CatSegmentsResponse.md @@ -0,0 +1,4 @@ +## `CatSegmentsResponse` +::: +type CatSegmentsResponse = [CatSegmentsSegmentsRecord](./CatSegmentsSegmentsRecord.md)[]; +::: diff --git a/docs/reference/api/CatSegmentsSegmentsRecord.md b/docs/reference/api/CatSegmentsSegmentsRecord.md new file mode 100644 index 000000000..ead5e2b1d --- /dev/null +++ b/docs/reference/api/CatSegmentsSegmentsRecord.md @@ -0,0 +1,43 @@ +## Interface `CatSegmentsSegmentsRecord` + +| Name | Type | Description | +| - | - | - | +| `"docs.count"` | string | The number of documents in the segment. This excludes deleted documents and counts any nested documents separately from their parents. It also excludes documents which were indexed recently and do not yet belong to a segment. | +| `"docs.deleted"` | string | The number of deleted documents in the segment, which might be higher or lower than the number of delete operations you have performed. This number excludes deletes that were performed recently and do not yet belong to a segment. Deleted documents are cleaned up by the automatic merge process if it makes sense to do so. Also, Elasticsearch creates extra deleted documents to internally track the recent history of operations on a shard. | +| `"size.memory"` | [ByteSize](./ByteSize.md) | The segment memory in bytes. A value of `-1` indicates Elasticsearch was unable to compute this number. | +| `committed` | string | If `true`, the segment is synced to disk. Segments that are synced can survive a hard reboot. If `false`, the data from uncommitted segments is also stored in the transaction log so that Elasticsearch is able to replay changes on the next start. | +| `compound` | string | If `true`, the segment is stored in a compound file. This means Lucene merged all files from the segment in a single file to save file descriptors. | +| `dc` | string | The number of documents in the segment. This excludes deleted documents and counts any nested documents separately from their parents. It also excludes documents which were indexed recently and do not yet belong to a segment. 'docs.count' | +| `dd` | string | The number of deleted documents in the segment, which might be higher or lower than the number of delete operations you have performed. This number excludes deletes that were performed recently and do not yet belong to a segment. Deleted documents are cleaned up by the automatic merge process if it makes sense to do so. Also, Elasticsearch creates extra deleted documents to internally track the recent history of operations on a shard. 'docs.deleted' | +| `docsCount` | string | The number of documents in the segment. This excludes deleted documents and counts any nested documents separately from their parents. It also excludes documents which were indexed recently and do not yet belong to a segment. 'docs.count' | +| `docsDeleted` | string | The number of deleted documents in the segment, which might be higher or lower than the number of delete operations you have performed. This number excludes deletes that were performed recently and do not yet belong to a segment. Deleted documents are cleaned up by the automatic merge process if it makes sense to do so. Also, Elasticsearch creates extra deleted documents to internally track the recent history of operations on a shard. 'docs.deleted' | +| `g` | string | The segment generation number. Elasticsearch increments this generation number for each segment written then uses this number to derive the segment name. generation | +| `gen` | string | The segment generation number. Elasticsearch increments this generation number for each segment written then uses this number to derive the segment name. generation | +| `generation` | string | The segment generation number. Elasticsearch increments this generation number for each segment written then uses this number to derive the segment name. | +| `i` | [IndexName](./IndexName.md) | The index name. index | +| `ic` | string | If `true`, the segment is synced to disk. Segments that are synced can survive a hard reboot. If `false`, the data from uncommitted segments is also stored in the transaction log so that Elasticsearch is able to replay changes on the next start. committed | +| `ico` | string | If `true`, the segment is stored in a compound file. This means Lucene merged all files from the segment in a single file to save file descriptors. compound | +| `id` | [NodeId](./NodeId.md) | The unique identifier of the node where it lives. | +| `idx` | [IndexName](./IndexName.md) | The index name. index | +| `index` | [IndexName](./IndexName.md) | The index name. | +| `ip` | string | The IP address of the node where it lives. | +| `is` | string | If `true`, the segment is searchable. If `false`, the segment has most likely been written to disk but needs a refresh to be searchable. searchable | +| `isCommitted` | string | If `true`, the segment is synced to disk. Segments that are synced can survive a hard reboot. If `false`, the data from uncommitted segments is also stored in the transaction log so that Elasticsearch is able to replay changes on the next start. committed | +| `isCompound` | string | If `true`, the segment is stored in a compound file. This means Lucene merged all files from the segment in a single file to save file descriptors. compound | +| `isSearchable` | string | If `true`, the segment is searchable. If `false`, the segment has most likely been written to disk but needs a refresh to be searchable. searchable | +| `p` | string | The shard type: `primary` or `replica`. prirep | +| `pr` | string | The shard type: `primary` or `replica`. prirep | +| `primaryOrReplica` | string | The shard type: `primary` or `replica`. prirep | +| `prirep` | string | The shard type: `primary` or `replica`. | +| `s` | string | The shard name. shard | +| `searchable` | string | If `true`, the segment is searchable. If `false`, the segment has most likely been written to disk but needs a refresh to be searchable. | +| `seg` | string | The segment name, which is derived from the segment generation and used internally to create file names in the directory of the shard. segment | +| `segment` | string | The segment name, which is derived from the segment generation and used internally to create file names in the directory of the shard. | +| `sh` | string | The shard name. shard | +| `shard` | string | The shard name. | +| `si` | [ByteSize](./ByteSize.md) | The segment size in bytes. size | +| `size` | [ByteSize](./ByteSize.md) | The segment size in bytes. | +| `sizeMemory` | [ByteSize](./ByteSize.md) | The segment memory in bytes. A value of `-1` indicates Elasticsearch was unable to compute this number. 'size.memory' | +| `sm` | [ByteSize](./ByteSize.md) | The segment memory in bytes. A value of `-1` indicates Elasticsearch was unable to compute this number. 'size.memory' | +| `v` | [VersionString](./VersionString.md) | The version of Lucene used to write the segment. version | +| `version` | [VersionString](./VersionString.md) | The version of Lucene used to write the segment. | diff --git a/docs/reference/api/CatShardsRequest.md b/docs/reference/api/CatShardsRequest.md new file mode 100644 index 000000000..4092d3802 --- /dev/null +++ b/docs/reference/api/CatShardsRequest.md @@ -0,0 +1,12 @@ +## Interface `CatShardsRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { index?: never; bytes?: never; h?: never; s?: never; master_timeout?: never; time?: never; }) | All values in `body` will be added to the request body. | +| `bytes` | [Bytes](./Bytes.md) | The unit used to display byte values. | +| `h` | [Names](./Names.md) | List of columns to appear in the response. Supports simple wildcards. | +| `index` | [Indices](./Indices.md) | A comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards ( `*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. | +| `master_timeout` | [Duration](./Duration.md) | Period to wait for a connection to the master node. | +| `querystring` | { [key: string]: any; } & { index?: never; bytes?: never; h?: never; s?: never; master_timeout?: never; time?: never; } | All values in `querystring` will be added to the request querystring. | +| `s` | [Names](./Names.md) | List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name. | +| `time` | [TimeUnit](./TimeUnit.md) | Unit used to display time values. | diff --git a/docs/reference/api/CatShardsResponse.md b/docs/reference/api/CatShardsResponse.md new file mode 100644 index 000000000..57ad8a71d --- /dev/null +++ b/docs/reference/api/CatShardsResponse.md @@ -0,0 +1,4 @@ +## `CatShardsResponse` +::: +type CatShardsResponse = [CatShardsShardsRecord](./CatShardsShardsRecord.md)[]; +::: diff --git a/docs/reference/api/CatShardsShardsRecord.md b/docs/reference/api/CatShardsShardsRecord.md new file mode 100644 index 000000000..ca66ea3c1 --- /dev/null +++ b/docs/reference/api/CatShardsShardsRecord.md @@ -0,0 +1,216 @@ +## Interface `CatShardsShardsRecord` + +| Name | Type | Description | +| - | - | - | +| `"bulk.avg_size_in_bytes"` | string | The average size in bytes of shard bulk operations. | +| `"bulk.avg_time"` | string | The average time spent in shard bulk operations. | +| `"bulk.total_operations"` | string | The number of bulk shard operations. | +| `"bulk.total_size_in_bytes"` | string | The total size in bytes of shard bulk operations. | +| `"bulk.total_time"` | string | The time spent in shard bulk operations. | +| `"completion.size"` | string | The size of completion. | +| `"fielddata.evictions"` | string | The fielddata cache evictions. | +| `"fielddata.memory_size"` | string | The used fielddata cache memory. | +| `"flush.total_time"` | string | The time spent in flush. | +| `"flush.total"` | string | The number of flushes. | +| `"get.current"` | string | The number of current get operations. | +| `"get.exists_time"` | string | The time spent in successful get operations. | +| `"get.exists_total"` | string | The number of successful get operations. | +| `"get.missing_time"` | string | The time spent in failed get operations. | +| `"get.missing_total"` | string | The number of failed get operations. | +| `"get.time"` | string | The time spent in get operations. | +| `"get.total"` | string | The number of get operations. | +| `"indexing.delete_current"` | string | The number of current deletion operations. | +| `"indexing.delete_time"` | string | The time spent in deletion operations. | +| `"indexing.delete_total"` | string | The number of delete operations. | +| `"indexing.index_current"` | string | The number of current indexing operations. | +| `"indexing.index_failed"` | string | The number of failed indexing operations. | +| `"indexing.index_time"` | string | The time spent in indexing operations. | +| `"indexing.index_total"` | string | The number of indexing operations. | +| `"merges.current_docs"` | string | The number of current merging documents. | +| `"merges.current_size"` | string | The size of current merge operations. | +| `"merges.current"` | string | The number of current merge operations. | +| `"merges.total_docs"` | string | The nuber of merged documents. | +| `"merges.total_size"` | string | The size of current merges. | +| `"merges.total_time"` | string | The time spent merging documents. | +| `"merges.total"` | string | The number of completed merge operations. | +| `"path.data"` | string | The shard data path. | +| `"path.state"` | string | The shard state path. | +| `"query_cache.evictions"` | string | The query cache evictions. | +| `"query_cache.memory_size"` | string | The used query cache memory. | +| `"recoverysource.type"` | string | The type of recovery source. | +| `"refresh.external_time"` | string | The time spent in external refreshes. | +| `"refresh.external_total"` | string | The total nunber of external refreshes. | +| `"refresh.listeners"` | string | The number of pending refresh listeners. | +| `"refresh.time"` | string | The time spent in refreshes. | +| `"refresh.total"` | string | The total number of refreshes. | +| `"search.fetch_current"` | string | The current fetch phase operations. | +| `"search.fetch_time"` | string | The time spent in fetch phase. | +| `"search.fetch_total"` | string | The total number of fetch operations. | +| `"search.open_contexts"` | string | The number of open search contexts. | +| `"search.query_current"` | string | The current query phase operations. | +| `"search.query_time"` | string | The time spent in query phase. | +| `"search.query_total"` | string | The total number of query phase operations. | +| `"search.scroll_current"` | string | The open scroll contexts. | +| `"search.scroll_time"` | string | The time scroll contexts were held open. | +| `"search.scroll_total"` | string | The number of completed scroll contexts. | +| `"segments.count"` | string | The number of segments. | +| `"segments.fixed_bitset_memory"` | string | The memory used by fixed bit sets for nested object field types and export type filters for types referred in `_parent` fields. | +| `"segments.index_writer_memory"` | string | The memory used by the index writer. | +| `"segments.memory"` | string | The memory used by segments. | +| `"segments.version_map_memory"` | string | The memory used by the version map. | +| `"seq_no.global_checkpoint"` | string | The global checkpoint. | +| `"seq_no.local_checkpoint"` | string | The local checkpoint. | +| `"seq_no.max"` | string | The maximum sequence number. | +| `"unassigned.at"` | string | The time at which the shard became unassigned in Coordinated Universal Time (UTC). | +| `"unassigned.details"` | string | Additional details as to why the shard became unassigned. It does not explain why the shard is not assigned; use the cluster allocation explain API for that information. | +| `"unassigned.for"` | string | The time at which the shard was requested to be unassigned in Coordinated Universal Time (UTC). | +| `"unassigned.reason"` | string | The reason for the last change to the state of an unassigned shard. It does not explain why the shard is currently unassigned; use the cluster allocation explain API for that information. Returned values include: `ALLOCATION_FAILED`: Unassigned as a result of a failed allocation of the shard. `CLUSTER_RECOVERED`: Unassigned as a result of a full cluster recovery. `DANGLING_INDEX_IMPORTED`: Unassigned as a result of importing a dangling index. `EXISTING_INDEX_RESTORED`: Unassigned as a result of restoring into a closed index. `FORCED_EMPTY_PRIMARY`: The shard’s allocation was last modified by forcing an empty primary using the cluster reroute API. `INDEX_CLOSED`: Unassigned because the index was closed. `INDEX_CREATED`: Unassigned as a result of an API creation of an index. `INDEX_REOPENED`: Unassigned as a result of opening a closed index. `MANUAL_ALLOCATION`: The shard’s allocation was last modified by the cluster reroute API. `NEW_INDEX_RESTORED`: Unassigned as a result of restoring into a new index. `NODE_LEFT`: Unassigned as a result of the node hosting it leaving the cluster. `NODE_RESTARTING`: Similar to `NODE_LEFT`, except that the node was registered as restarting using the node shutdown API. `PRIMARY_FAILED`: The shard was initializing as a replica, but the primary shard failed before the initialization completed. `REALLOCATED_REPLICA`: A better replica location is identified and causes the existing replica allocation to be cancelled. `REINITIALIZED`: When a shard moves from started back to initializing. `REPLICA_ADDED`: Unassigned as a result of explicit addition of a replica. `REROUTE_CANCELLED`: Unassigned as a result of explicit cancel reroute command. | +| `"warmer.current"` | string | The number of current warmer operations. | +| `"warmer.total_time"` | string | The time spent in warmer operations. | +| `"warmer.total"` | string | The total number of warmer operations. | +| `basi` | string | The average size in bytes of shard bulk operations. 'bulk.avg_size_in_bytes' | +| `bati` | string | The average time spent in shard bulk operations. 'bulk.avg_time' | +| `bto` | string | The number of bulk shard operations. 'bulk.total_operations' | +| `btsi` | string | The total size in bytes of shard bulk operations. 'bulk.total_size_in_bytes' | +| `btti` | string | The time spent in shard bulk operations. 'bulk.total_time' | +| `bulkAvgSizeInBytes` | string | The average size in bytes of shard bulk operations. 'bulk.avg_size_in_bytes' | +| `bulkAvgTime` | string | The average time spent in shard bulk operations. 'bulk.avg_time' | +| `bulkTotalOperations` | string | The number of bulk shard operations. 'bulk.total_operations' | +| `bulkTotalSizeInBytes` | string | The total size in bytes of shard bulk operations. 'bulk.total_size_in_bytes' | +| `bulkTotalTime` | string | The time spent in shard bulk operations. 'bulk.total_time' | +| `completionSize` | string | The size of completion. 'completion.size' | +| `cs` | string | The size of completion. 'completion.size' | +| `d` | string | null | The number of documents in the shard. docs | +| `dataPath` | string | The shard data path. 'path.data' | +| `dataset` | string | null | total size of dataset (including the cache for partially mounted indices) | +| `dc` | string | null | The number of documents in the shard. docs | +| `docs` | string | null | The number of documents in the shard. | +| `fe` | string | The fielddata cache evictions. 'fielddata.evictions' | +| `fielddataEvictions` | string | The fielddata cache evictions. 'fielddata.evictions' | +| `fielddataMemory` | string | The used fielddata cache memory. 'fielddata.memory_size' | +| `fixedBitsetMemory` | string | The memory used by fixed bit sets for nested object field types and export type filters for types referred in `_parent` fields. 'segments.fixed_bitset_memory' | +| `flushTotal` | string | The number of flushes. 'flush.total' | +| `flushTotalTime` | string | The time spent in flush. 'flush.total_time' | +| `fm` | string | The used fielddata cache memory. 'fielddata.memory_size' | +| `ft` | string | The number of flushes. 'flush.total' | +| `ftt` | string | The time spent in flush. 'flush.total_time' | +| `gc` | string | The number of current get operations. 'get.current' | +| `getCurrent` | string | The number of current get operations. 'get.current' | +| `getExistsTime` | string | The time spent in successful get operations. 'get.exists_time' | +| `getExistsTotal` | string | The number of successful get operations. 'get.exists_total' | +| `geti` | string | The time spent in successful get operations. 'get.exists_time' | +| `getMissingTime` | string | The time spent in failed get operations. 'get.missing_time' | +| `getMissingTotal` | string | The number of failed get operations. 'get.missing_total' | +| `geto` | string | The number of successful get operations. 'get.exists_total' | +| `getTime` | string | The time spent in get operations. 'get.time' | +| `getTotal` | string | The number of get operations. 'get.total' | +| `globalCheckpoint` | string | The global checkpoint. 'seq_no.global_checkpoint' | +| `gmti` | string | The time spent in failed get operations. 'get.missing_time' | +| `gmto` | string | The number of failed get operations. 'get.missing_total' | +| `gti` | string | The time spent in get operations. 'get.time' | +| `gto` | string | The number of get operations. 'get.total' | +| `i` | string | The index name. index | +| `id` | string | The unique identifier for the node. | +| `idc` | string | The number of current deletion operations. 'indexing.delete_current' | +| `idti` | string | The time spent in deletion operations. 'indexing.delete_time' | +| `idto` | string | The number of delete operations. 'indexing.delete_total' | +| `idx` | string | The index name. index | +| `iic` | string | The number of current indexing operations. 'indexing.index_current' | +| `iif` | string | The number of failed indexing operations. 'indexing.index_failed' | +| `iiti` | string | The time spent in indexing operations. 'indexing.index_time' | +| `iito` | string | The number of indexing operations. 'indexing.index_total' | +| `index` | string | The index name. | +| `indexingDeleteCurrent` | string | The number of current deletion operations. 'indexing.delete_current' | +| `indexingDeleteTime` | string | The time spent in deletion operations. 'indexing.delete_time' | +| `indexingDeleteTotal` | string | The number of delete operations. 'indexing.delete_total' | +| `indexingIndexCurrent` | string | The number of current indexing operations. 'indexing.index_current' | +| `indexingIndexFailed` | string | The number of failed indexing operations. 'indexing.index_failed' | +| `indexingIndexTime` | string | The time spent in indexing operations. 'indexing.index_time' | +| `indexingIndexTotal` | string | The number of indexing operations. 'indexing.index_total' | +| `ip` | string | null | The IP address of the node. | +| `localCheckpoint` | string | The local checkpoint. 'seq_no.local_checkpoint' | +| `maxSeqNo` | string | The maximum sequence number. 'seq_no.max' | +| `mc` | string | The number of current merge operations. 'merges.current' | +| `mcd` | string | The number of current merging documents. 'merges.current_docs' | +| `mcs` | string | The size of current merge operations. 'merges.current_size' | +| `mergesCurrent` | string | The number of current merge operations. 'merges.current' | +| `mergesCurrentDocs` | string | The number of current merging documents. 'merges.current_docs' | +| `mergesCurrentSize` | string | The size of current merge operations. 'merges.current_size' | +| `mergesTotal` | string | The number of completed merge operations. 'merges.total' | +| `mergesTotalDocs` | string | The nuber of merged documents. 'merges.total_docs' | +| `mergesTotalSize` | string | The size of current merges. 'merges.total_size' | +| `mergesTotalTime` | string | The time spent merging documents. 'merges.total_time' | +| `mt` | string | The number of completed merge operations. 'merges.total' | +| `mtd` | string | The nuber of merged documents. 'merges.total_docs' | +| `mts` | string | The size of current merges. 'merges.total_size' | +| `mtt` | string | The time spent merging documents. 'merges.total_time' | +| `n` | string | null | The name of node. node | +| `node` | string | null | The name of node. | +| `p` | string | The shard type: `primary` or `replica`. prirep | +| `pd` | string | The shard data path. 'path.data' | +| `pr` | string | The shard type: `primary` or `replica`. prirep | +| `primaryOrReplica` | string | The shard type: `primary` or `replica`. prirep | +| `prirep` | string | The shard type: `primary` or `replica`. | +| `ps` | string | The shard state path. 'path.state' | +| `qce` | string | The query cache evictions. 'query_cache.evictions' | +| `qcm` | string | The used query cache memory. 'query_cache.memory_size' | +| `queryCacheEvictions` | string | The query cache evictions. 'query_cache.evictions' | +| `queryCacheMemory` | string | The used query cache memory. 'query_cache.memory_size' | +| `refreshListeners` | string | The number of pending refresh listeners. 'refresh.listeners' | +| `refreshTime` | string | The time spent in external refreshes. 'refresh.external_time' | +| `refreshTotal` | string | The total nunber of external refreshes. 'refresh.external_total' | +| `rli` | string | The number of pending refresh listeners. 'refresh.listeners' | +| `rs` | string | The type of recovery source. 'recoverysource.type' | +| `rti` | string | The time spent in external refreshes. 'refresh.external_time' | +| `rto` | string | The total nunber of external refreshes. 'refresh.external_total' | +| `s` | string | The shard name. shard | +| `sc` | string | The number of segments. 'segments.count' | +| `scc` | string | The open scroll contexts. 'search.scroll_current' | +| `scti` | string | The time scroll contexts were held open. 'search.scroll_time' | +| `scto` | string | The number of completed scroll contexts. 'search.scroll_total' | +| `searchFetchCurrent` | string | The current fetch phase operations. 'search.fetch_current' | +| `searchFetchTime` | string | The time spent in fetch phase. 'search.fetch_time' | +| `searchFetchTotal` | string | The total number of fetch operations. 'search.fetch_total' | +| `searchOpenContexts` | string | The number of open search contexts. 'search.open_contexts' | +| `searchQueryCurrent` | string | The current query phase operations. 'search.query_current' | +| `searchQueryTime` | string | The time spent in query phase. 'search.query_time' | +| `searchQueryTotal` | string | The total number of query phase operations. 'search.query_total' | +| `searchScrollCurrent` | string | The open scroll contexts. 'search.scroll_current' | +| `searchScrollTime` | string | The time scroll contexts were held open. 'search.scroll_time' | +| `searchScrollTotal` | string | The number of completed scroll contexts. 'search.scroll_total' | +| `segmentsCount` | string | The number of segments. 'segments.count' | +| `segmentsIndexWriterMemory` | string | The memory used by the index writer. 'segments.index_writer_memory' | +| `segmentsMemory` | string | The memory used by segments. 'segments.memory' | +| `segmentsVersionMapMemory` | string | The memory used by the version map. 'segments.version_map_memory' | +| `sfbm` | string | The memory used by fixed bit sets for nested object field types and export type filters for types referred in `_parent` fields. 'segments.fixed_bitset_memory' | +| `sfc` | string | The current fetch phase operations. 'search.fetch_current' | +| `sfti` | string | The time spent in fetch phase. 'search.fetch_time' | +| `sfto` | string | The total number of fetch operations. 'search.fetch_total' | +| `sh` | string | The shard name. shard | +| `shard` | string | The shard name. | +| `siwm` | string | The memory used by the index writer. 'segments.index_writer_memory' | +| `sm` | string | The memory used by segments. 'segments.memory' | +| `so` | string | The number of open search contexts. 'search.open_contexts' | +| `sqc` | string | The current query phase operations. 'search.query_current' | +| `sqg` | string | The global checkpoint. 'seq_no.global_checkpoint' | +| `sql` | string | The local checkpoint. 'seq_no.local_checkpoint' | +| `sqm` | string | The maximum sequence number. 'seq_no.max' | +| `sqti` | string | The time spent in query phase. 'search.query_time' | +| `sqto` | string | The total number of query phase operations. 'search.query_total' | +| `st` | string | The shard state. Returned values include: `INITIALIZING`: The shard is recovering from a peer shard or gateway. `RELOCATING`: The shard is relocating. `STARTED`: The shard has started. `UNASSIGNED`: The shard is not assigned to any node. state | +| `state` | string | The shard state. Returned values include: `INITIALIZING`: The shard is recovering from a peer shard or gateway. `RELOCATING`: The shard is relocating. `STARTED`: The shard has started. `UNASSIGNED`: The shard is not assigned to any node. | +| `statsPath` | string | The shard state path. 'path.state' | +| `sto` | string | null | The disk space used by the shard. store | +| `store` | string | null | The disk space used by the shard. | +| `svmm` | string | The memory used by the version map. 'segments.version_map_memory' | +| `sync_id` | string | The sync identifier. | +| `ua` | string | The time at which the shard became unassigned in Coordinated Universal Time (UTC). 'unassigned.at' | +| `ud` | string | Additional details as to why the shard became unassigned. It does not explain why the shard is not assigned; use the cluster allocation explain API for that information. 'unassigned.details' | +| `uf` | string | The time at which the shard was requested to be unassigned in Coordinated Universal Time (UTC). 'unassigned.for' | +| `ur` | string | The reason for the last change to the state of an unassigned shard. It does not explain why the shard is currently unassigned; use the cluster allocation explain API for that information. Returned values include: `ALLOCATION_FAILED`: Unassigned as a result of a failed allocation of the shard. `CLUSTER_RECOVERED`: Unassigned as a result of a full cluster recovery. `DANGLING_INDEX_IMPORTED`: Unassigned as a result of importing a dangling index. `EXISTING_INDEX_RESTORED`: Unassigned as a result of restoring into a closed index. `FORCED_EMPTY_PRIMARY`: The shard’s allocation was last modified by forcing an empty primary using the cluster reroute API. `INDEX_CLOSED`: Unassigned because the index was closed. `INDEX_CREATED`: Unassigned as a result of an API creation of an index. `INDEX_REOPENED`: Unassigned as a result of opening a closed index. `MANUAL_ALLOCATION`: The shard’s allocation was last modified by the cluster reroute API. `NEW_INDEX_RESTORED`: Unassigned as a result of restoring into a new index. `NODE_LEFT`: Unassigned as a result of the node hosting it leaving the cluster. `NODE_RESTARTING`: Similar to `NODE_LEFT`, except that the node was registered as restarting using the node shutdown API. `PRIMARY_FAILED`: The shard was initializing as a replica, but the primary shard failed before the initialization completed. `REALLOCATED_REPLICA`: A better replica location is identified and causes the existing replica allocation to be cancelled. `REINITIALIZED`: When a shard moves from started back to initializing. `REPLICA_ADDED`: Unassigned as a result of explicit addition of a replica. `REROUTE_CANCELLED`: Unassigned as a result of explicit cancel reroute command. 'unassigned.reason' | +| `warmerCurrent` | string | The number of current warmer operations. 'warmer.current' | +| `warmerTotal` | string | The total number of warmer operations. 'warmer.total' | +| `warmerTotalTime` | string | The time spent in warmer operations. 'warmer.total_time' | +| `wc` | string | The number of current warmer operations. 'warmer.current' | +| `wto` | string | The total number of warmer operations. 'warmer.total' | +| `wtt` | string | The time spent in warmer operations. 'warmer.total_time' | diff --git a/docs/reference/api/CatSnapshotsRequest.md b/docs/reference/api/CatSnapshotsRequest.md new file mode 100644 index 000000000..6e110f693 --- /dev/null +++ b/docs/reference/api/CatSnapshotsRequest.md @@ -0,0 +1,12 @@ +## Interface `CatSnapshotsRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { repository?: never; ignore_unavailable?: never; h?: never; s?: never; master_timeout?: never; time?: never; }) | All values in `body` will be added to the request body. | +| `h` | [Names](./Names.md) | List of columns to appear in the response. Supports simple wildcards. | +| `ignore_unavailable` | boolean | If `true`, the response does not include information from unavailable snapshots. | +| `master_timeout` | [Duration](./Duration.md) | Period to wait for a connection to the master node. | +| `querystring` | { [key: string]: any; } & { repository?: never; ignore_unavailable?: never; h?: never; s?: never; master_timeout?: never; time?: never; } | All values in `querystring` will be added to the request querystring. | +| `repository` | [Names](./Names.md) | A comma-separated list of snapshot repositories used to limit the request. Accepts wildcard expressions. `_all` returns all repositories. If any repository fails during the request, Elasticsearch returns an error. | +| `s` | [Names](./Names.md) | List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name. | +| `time` | [TimeUnit](./TimeUnit.md) | Unit used to display time values. | diff --git a/docs/reference/api/CatSnapshotsResponse.md b/docs/reference/api/CatSnapshotsResponse.md new file mode 100644 index 000000000..3bfc3e78b --- /dev/null +++ b/docs/reference/api/CatSnapshotsResponse.md @@ -0,0 +1,4 @@ +## `CatSnapshotsResponse` +::: +type CatSnapshotsResponse = [CatSnapshotsSnapshotsRecord](./CatSnapshotsSnapshotsRecord.md)[]; +::: diff --git a/docs/reference/api/CatSnapshotsSnapshotsRecord.md b/docs/reference/api/CatSnapshotsSnapshotsRecord.md new file mode 100644 index 000000000..71f8af661 --- /dev/null +++ b/docs/reference/api/CatSnapshotsSnapshotsRecord.md @@ -0,0 +1,35 @@ +## Interface `CatSnapshotsSnapshotsRecord` + +| Name | Type | Description | +| - | - | - | +| `dur` | [Duration](./Duration.md) | The time it took the snapshot process to complete, in time units. duration | +| `duration` | [Duration](./Duration.md) | The time it took the snapshot process to complete, in time units. | +| `end_epoch` | [SpecUtilsStringified](./SpecUtilsStringified.md)<[EpochTime](./EpochTime.md)<[UnitSeconds](./UnitSeconds.md)>> | The Unix epoch time (seconds since 1970-01-01 00:00:00) at which the snapshot process ended. | +| `end_time` | [TimeOfDay](./TimeOfDay.md) | The time (HH:MM:SS) at which the snapshot process ended. | +| `endEpoch` | [SpecUtilsStringified](./SpecUtilsStringified.md)<[EpochTime](./EpochTime.md)<[UnitSeconds](./UnitSeconds.md)>> | The Unix epoch time (seconds since 1970-01-01 00:00:00) at which the snapshot process ended. end_epoch | +| `endTime` | [TimeOfDay](./TimeOfDay.md) | The time (HH:MM:SS) at which the snapshot process ended. end_time | +| `ete` | [SpecUtilsStringified](./SpecUtilsStringified.md)<[EpochTime](./EpochTime.md)<[UnitSeconds](./UnitSeconds.md)>> | The Unix epoch time (seconds since 1970-01-01 00:00:00) at which the snapshot process ended. end_epoch | +| `eti` | [TimeOfDay](./TimeOfDay.md) | The time (HH:MM:SS) at which the snapshot process ended. end_time | +| `failed_shards` | string | The number of failed shards in the snapshot. | +| `fs` | string | The number of failed shards in the snapshot. failed_shards | +| `i` | string | The number of indices in the snapshot. indices | +| `id` | string | The unique identifier for the snapshot. | +| `indices` | string | The number of indices in the snapshot. | +| `r` | string | The reason for any snapshot failures. reason | +| `re` | string | The repository name. repository | +| `reason` | string | The reason for any snapshot failures. | +| `repo` | string | The repository name. repository | +| `repository` | string | The repository name. | +| `s` | string | The state of the snapshot process. Returned values include: `FAILED`: The snapshot process failed. `INCOMPATIBLE`: The snapshot process is incompatible with the current cluster version. `IN_PROGRESS`: The snapshot process started but has not completed. `PARTIAL`: The snapshot process completed with a partial success. `SUCCESS`: The snapshot process completed with a full success. status | +| `snapshot` | string | The unique identifier for the snapshot. id | +| `ss` | string | The number of successful shards in the snapshot. successful_shards | +| `start_epoch` | [SpecUtilsStringified](./SpecUtilsStringified.md)<[EpochTime](./EpochTime.md)<[UnitSeconds](./UnitSeconds.md)>> | The Unix epoch time (seconds since 1970-01-01 00:00:00) at which the snapshot process started. | +| `start_time` | [WatcherScheduleTimeOfDay](./WatcherScheduleTimeOfDay.md) | The time (HH:MM:SS) at which the snapshot process started. | +| `startEpoch` | [SpecUtilsStringified](./SpecUtilsStringified.md)<[EpochTime](./EpochTime.md)<[UnitSeconds](./UnitSeconds.md)>> | The Unix epoch time (seconds since 1970-01-01 00:00:00) at which the snapshot process started. start_epoch | +| `startTime` | [WatcherScheduleTimeOfDay](./WatcherScheduleTimeOfDay.md) | The time (HH:MM:SS) at which the snapshot process started. start_time | +| `status` | string | The state of the snapshot process. Returned values include: `FAILED`: The snapshot process failed. `INCOMPATIBLE`: The snapshot process is incompatible with the current cluster version. `IN_PROGRESS`: The snapshot process started but has not completed. `PARTIAL`: The snapshot process completed with a partial success. `SUCCESS`: The snapshot process completed with a full success. | +| `ste` | [SpecUtilsStringified](./SpecUtilsStringified.md)<[EpochTime](./EpochTime.md)<[UnitSeconds](./UnitSeconds.md)>> | The Unix epoch time (seconds since 1970-01-01 00:00:00) at which the snapshot process started. start_epoch | +| `sti` | [WatcherScheduleTimeOfDay](./WatcherScheduleTimeOfDay.md) | The time (HH:MM:SS) at which the snapshot process started. start_time | +| `successful_shards` | string | The number of successful shards in the snapshot. | +| `total_shards` | string | The total number of shards in the snapshot. | +| `ts` | string | The total number of shards in the snapshot. total_shards | diff --git a/docs/reference/api/CatTasksRequest.md b/docs/reference/api/CatTasksRequest.md new file mode 100644 index 000000000..169fd0da3 --- /dev/null +++ b/docs/reference/api/CatTasksRequest.md @@ -0,0 +1,15 @@ +## Interface `CatTasksRequest` + +| Name | Type | Description | +| - | - | - | +| `actions` | string[] | The task action names, which are used to limit the response. | +| `body` | string | ({ [key: string]: any; } & { actions?: never; detailed?: never; nodes?: never; parent_task_id?: never; h?: never; s?: never; time?: never; timeout?: never; wait_for_completion?: never; }) | All values in `body` will be added to the request body. | +| `detailed` | boolean | If `true`, the response includes detailed information about shard recoveries. | +| `h` | [Names](./Names.md) | List of columns to appear in the response. Supports simple wildcards. | +| `nodes` | string[] | Unique node identifiers, which are used to limit the response. | +| `parent_task_id` | string | The parent task identifier, which is used to limit the response. | +| `querystring` | { [key: string]: any; } & { actions?: never; detailed?: never; nodes?: never; parent_task_id?: never; h?: never; s?: never; time?: never; timeout?: never; wait_for_completion?: never; } | All values in `querystring` will be added to the request querystring. | +| `s` | [Names](./Names.md) | List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name. | +| `time` | [TimeUnit](./TimeUnit.md) | Unit used to display time values. | +| `timeout` | [Duration](./Duration.md) | Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. | +| `wait_for_completion` | boolean | If `true`, the request blocks until the task has completed. | diff --git a/docs/reference/api/CatTasksResponse.md b/docs/reference/api/CatTasksResponse.md new file mode 100644 index 000000000..d4b385f5d --- /dev/null +++ b/docs/reference/api/CatTasksResponse.md @@ -0,0 +1,4 @@ +## `CatTasksResponse` +::: +type CatTasksResponse = [CatTasksTasksRecord](./CatTasksTasksRecord.md)[]; +::: diff --git a/docs/reference/api/CatTasksTasksRecord.md b/docs/reference/api/CatTasksTasksRecord.md new file mode 100644 index 000000000..1fc54fe0f --- /dev/null +++ b/docs/reference/api/CatTasksTasksRecord.md @@ -0,0 +1,36 @@ +## Interface `CatTasksTasksRecord` + +| Name | Type | Description | +| - | - | - | +| `ac` | string | The task action. action | +| `action` | string | The task action. | +| `desc` | string | The task action description. description | +| `description` | string | The task action description. | +| `hhmmss` | string | The start time in `HH:MM:SS` format. timestamp | +| `hms` | string | The start time in `HH:MM:SS` format. timestamp | +| `i` | string | The IP address for the node. ip | +| `id` | [Id](./Id.md) | The identifier of the task with the node. | +| `ip` | string | The IP address for the node. | +| `n` | string | The node name. node | +| `ni` | [NodeId](./NodeId.md) | The unique node identifier. node_id | +| `node_id` | [NodeId](./NodeId.md) | The unique node identifier. | +| `node` | string | The node name. | +| `parent_task_id` | string | The parent task identifier. | +| `po` | string | The bound transport port for the node. port | +| `port` | string | The bound transport port for the node. | +| `pti` | string | The parent task identifier. parent_task_id | +| `running_time_ns` | string | The running time in nanoseconds. | +| `running_time` | string | The running time. | +| `start_time` | string | The start time in milliseconds. | +| `start` | string | The start time in milliseconds. start_time | +| `task_id` | [Id](./Id.md) | The unique task identifier. | +| `ti` | [Id](./Id.md) | The unique task identifier. task_id | +| `time` | string | The running time. running_time | +| `timestamp` | string | The start time in `HH:MM:SS` format. | +| `ts` | string | The start time in `HH:MM:SS` format. timestamp | +| `ty` | string | The task type. type | +| `type` | string | The task type. | +| `v` | [VersionString](./VersionString.md) | The Elasticsearch version. version | +| `version` | [VersionString](./VersionString.md) | The Elasticsearch version. | +| `x_opaque_id` | string | The X-Opaque-ID header. | +| `x` | string | The X-Opaque-ID header. x_opaque_id | diff --git a/docs/reference/api/CatTemplatesRequest.md b/docs/reference/api/CatTemplatesRequest.md new file mode 100644 index 000000000..41e1993cf --- /dev/null +++ b/docs/reference/api/CatTemplatesRequest.md @@ -0,0 +1,11 @@ +## Interface `CatTemplatesRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { name?: never; h?: never; s?: never; local?: never; master_timeout?: never; }) | All values in `body` will be added to the request body. | +| `h` | [Names](./Names.md) | List of columns to appear in the response. Supports simple wildcards. | +| `local` | boolean | If `true`, the request computes the list of selected nodes from the local cluster state. If `false` the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node. | +| `master_timeout` | [Duration](./Duration.md) | Period to wait for a connection to the master node. | +| `name` | [Name](./Name.md) | The name of the template to return. Accepts wildcard expressions. If omitted, all templates are returned. | +| `querystring` | { [key: string]: any; } & { name?: never; h?: never; s?: never; local?: never; master_timeout?: never; } | All values in `querystring` will be added to the request querystring. | +| `s` | [Names](./Names.md) | List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name. | diff --git a/docs/reference/api/CatTemplatesResponse.md b/docs/reference/api/CatTemplatesResponse.md new file mode 100644 index 000000000..61f7dff8b --- /dev/null +++ b/docs/reference/api/CatTemplatesResponse.md @@ -0,0 +1,4 @@ +## `CatTemplatesResponse` +::: +type CatTemplatesResponse = [CatTemplatesTemplatesRecord](./CatTemplatesTemplatesRecord.md)[]; +::: diff --git a/docs/reference/api/CatTemplatesTemplatesRecord.md b/docs/reference/api/CatTemplatesTemplatesRecord.md new file mode 100644 index 000000000..2e4119bbd --- /dev/null +++ b/docs/reference/api/CatTemplatesTemplatesRecord.md @@ -0,0 +1,15 @@ +## Interface `CatTemplatesTemplatesRecord` + +| Name | Type | Description | +| - | - | - | +| `c` | string | The component templates that comprise the index template. composed_of | +| `composed_of` | string | The component templates that comprise the index template. | +| `index_patterns` | string | The template index patterns. | +| `n` | [Name](./Name.md) | The template name. name | +| `name` | [Name](./Name.md) | The template name. | +| `o` | string | The template application order or priority number. order | +| `order` | string | The template application order or priority number. | +| `p` | string | The template application order or priority number. order | +| `t` | string | The template index patterns. index_patterns | +| `v` | [VersionString](./VersionString.md) | null | The template version. version | +| `version` | [VersionString](./VersionString.md) | null | The template version. | diff --git a/docs/reference/api/CatThreadPoolRequest.md b/docs/reference/api/CatThreadPoolRequest.md new file mode 100644 index 000000000..975abb37c --- /dev/null +++ b/docs/reference/api/CatThreadPoolRequest.md @@ -0,0 +1,12 @@ +## Interface `CatThreadPoolRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { thread_pool_patterns?: never; h?: never; s?: never; time?: never; local?: never; master_timeout?: never; }) | All values in `body` will be added to the request body. | +| `h` | [Names](./Names.md) | List of columns to appear in the response. Supports simple wildcards. | +| `local` | boolean | If `true`, the request computes the list of selected nodes from the local cluster state. If `false` the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node. | +| `master_timeout` | [Duration](./Duration.md) | Period to wait for a connection to the master node. | +| `querystring` | { [key: string]: any; } & { thread_pool_patterns?: never; h?: never; s?: never; time?: never; local?: never; master_timeout?: never; } | All values in `querystring` will be added to the request querystring. | +| `s` | [Names](./Names.md) | List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name. | +| `thread_pool_patterns` | [Names](./Names.md) | A comma-separated list of thread pool names used to limit the request. Accepts wildcard expressions. | +| `time` | [TimeUnit](./TimeUnit.md) | The unit used to display time values. | diff --git a/docs/reference/api/CatThreadPoolResponse.md b/docs/reference/api/CatThreadPoolResponse.md new file mode 100644 index 000000000..f13a4ecd4 --- /dev/null +++ b/docs/reference/api/CatThreadPoolResponse.md @@ -0,0 +1,4 @@ +## `CatThreadPoolResponse` +::: +type CatThreadPoolResponse = [CatThreadPoolThreadPoolRecord](./CatThreadPoolThreadPoolRecord.md)[]; +::: diff --git a/docs/reference/api/CatThreadPoolThreadPoolRecord.md b/docs/reference/api/CatThreadPoolThreadPoolRecord.md new file mode 100644 index 000000000..cddab7144 --- /dev/null +++ b/docs/reference/api/CatThreadPoolThreadPoolRecord.md @@ -0,0 +1,44 @@ +## Interface `CatThreadPoolThreadPoolRecord` + +| Name | Type | Description | +| - | - | - | +| `a` | string | The number of active threads in the current thread pool. active | +| `active` | string | The number of active threads in the current thread pool. | +| `c` | string | The number of completed tasks. completed | +| `completed` | string | The number of completed tasks. | +| `core` | string | null | The core number of active threads allowed in a scaling thread pool. | +| `cr` | string | null | The core number of active threads allowed in a scaling thread pool. core | +| `eid` | string | The ephemeral node identifier. ephemeral_node_id | +| `ephemeral_node_id` | string | The ephemeral node identifier. | +| `h` | string | The host name for the current node. host | +| `host` | string | The host name for the current node. | +| `i` | string | The IP address for the current node. ip | +| `id` | [NodeId](./NodeId.md) | The persistent node identifier. node_id | +| `ip` | string | The IP address for the current node. | +| `ka` | string | null | The thread keep alive time. keep_alive | +| `keep_alive` | string | null | The thread keep alive time. | +| `l` | string | The highest number of active threads in the current thread pool. largest | +| `largest` | string | The highest number of active threads in the current thread pool. | +| `max` | string | null | The maximum number of active threads allowed in a scaling thread pool. | +| `mx` | string | null | The maximum number of active threads allowed in a scaling thread pool. max | +| `n` | string | The thread pool name. name | +| `name` | string | The thread pool name. | +| `nn` | string | The node name. node_name | +| `node_id` | [NodeId](./NodeId.md) | The persistent node identifier. | +| `node_name` | string | The node name. | +| `p` | string | The process identifier. pid | +| `pid` | string | The process identifier. | +| `po` | string | The bound transport port for the current node. port | +| `pool_size` | string | The number of threads in the current thread pool. | +| `port` | string | The bound transport port for the current node. | +| `psz` | string | The number of threads in the current thread pool. pool_size | +| `q` | string | The number of tasks currently in queue. queue | +| `qs` | string | The maximum number of tasks permitted in the queue. queue_size | +| `queue_size` | string | The maximum number of tasks permitted in the queue. | +| `queue` | string | The number of tasks currently in queue. | +| `r` | string | The number of rejected tasks. rejected | +| `rejected` | string | The number of rejected tasks. | +| `size` | string | null | The number of active threads allowed in a fixed thread pool. | +| `sz` | string | null | The number of active threads allowed in a fixed thread pool. size | +| `t` | string | The thread pool type. Returned values include `fixed`, `fixed_auto_queue_size`, `direct`, and `scaling`. type | +| `type` | string | The thread pool type. Returned values include `fixed`, `fixed_auto_queue_size`, `direct`, and `scaling`. | diff --git a/docs/reference/api/CatTransformsRequest.md b/docs/reference/api/CatTransformsRequest.md new file mode 100644 index 000000000..1adb91be3 --- /dev/null +++ b/docs/reference/api/CatTransformsRequest.md @@ -0,0 +1,13 @@ +## Interface `CatTransformsRequest` + +| Name | Type | Description | +| - | - | - | +| `allow_no_match` | boolean | Specifies what to do when the request: contains wildcard expressions and there are no transforms that match; contains the `_all` string or no identifiers and there are no matches; contains wildcard expressions and there are only partial matches. If `true`, it returns an empty transforms array when there are no matches and the subset of results when there are partial matches. If `false`, the request returns a 404 status code when there are no matches or only partial matches. | +| `body` | string | ({ [key: string]: any; } & { transform_id?: never; allow_no_match?: never; from?: never; h?: never; s?: never; time?: never; size?: never; }) | All values in `body` will be added to the request body. | +| `from` | [integer](./integer.md) | Skips the specified number of transforms. | +| `h` | [CatCatTransformColumns](./CatCatTransformColumns.md) | Comma-separated list of column names to display. | +| `querystring` | { [key: string]: any; } & { transform_id?: never; allow_no_match?: never; from?: never; h?: never; s?: never; time?: never; size?: never; } | All values in `querystring` will be added to the request querystring. | +| `s` | [CatCatTransformColumns](./CatCatTransformColumns.md) | Comma-separated list of column names or column aliases used to sort the response. | +| `size` | [integer](./integer.md) | The maximum number of transforms to obtain. | +| `time` | [TimeUnit](./TimeUnit.md) | The unit used to display time values. | +| `transform_id` | [Id](./Id.md) | A transform identifier or a wildcard expression. If you do not specify one of these options, the API returns information for all transforms. | diff --git a/docs/reference/api/CatTransformsResponse.md b/docs/reference/api/CatTransformsResponse.md new file mode 100644 index 000000000..13d4c2dc2 --- /dev/null +++ b/docs/reference/api/CatTransformsResponse.md @@ -0,0 +1,4 @@ +## `CatTransformsResponse` +::: +type CatTransformsResponse = [CatTransformsTransformsRecord](./CatTransformsTransformsRecord.md)[]; +::: diff --git a/docs/reference/api/CatTransformsTransformsRecord.md b/docs/reference/api/CatTransformsTransformsRecord.md new file mode 100644 index 000000000..942bf24a8 --- /dev/null +++ b/docs/reference/api/CatTransformsTransformsRecord.md @@ -0,0 +1,76 @@ +## Interface `CatTransformsTransformsRecord` + +| Name | Type | Description | +| - | - | - | +| `c` | string | The sequence number for the checkpoint. checkpoint | +| `cdtea` | string | The exponential moving average of the duration of the checkpoint, in milliseconds. checkpoint_duration_time_exp_avg | +| `changes_last_detection_time` | string | null | The timestamp when changes were last detected in the source indices. | +| `checkpoint_duration_time_exp_avg` | string | The exponential moving average of the duration of the checkpoint, in milliseconds. | +| `checkpoint_progress` | string | null | The progress of the next checkpoint that is currently in progress. | +| `checkpoint` | string | The sequence number for the checkpoint. | +| `checkpointProgress` | string | null | The progress of the next checkpoint that is currently in progress. checkpoint_progress | +| `checkpointTimeExpAvg` | string | The exponential moving average of the duration of the checkpoint, in milliseconds. checkpoint_duration_time_exp_avg | +| `cldt` | string | null | The timestamp when changes were last detected in the source indices. changes_last_detection_time | +| `cp` | string | null | The progress of the next checkpoint that is currently in progress. checkpoint_progress | +| `create_time` | string | The time the transform was created. | +| `createTime` | string | The time the transform was created. create_time | +| `ct` | string | The time the transform was created. create_time | +| `d` | string | The description of the transform. description | +| `delete_time` | string | The total time spent deleting documents, in milliseconds. | +| `description` | string | The description of the transform. | +| `dest_index` | string | The destination index for the transform. | +| `destIndex` | string | The destination index for the transform. dest_index | +| `di` | string | The destination index for the transform. dest_index | +| `docd` | string | The number of documents deleted from the destination index due to the retention policy for the transform. documents_deleted | +| `doci` | string | The number of documents that have been indexed into the destination index for the transform. documents_indexed | +| `docp` | string | The number of documents that have been processed from the source index of the transform. documents_processed | +| `docs_per_second` | string | The number of input documents per second. | +| `documents_deleted` | string | The number of documents deleted from the destination index due to the retention policy for the transform. | +| `documents_indexed` | string | The number of documents that have been indexed into the destination index for the transform. | +| `documents_processed` | string | The number of documents that have been processed from the source index of the transform. | +| `documentsProcessed` | string | The number of documents that have been processed from the source index of the transform. documents_processed | +| `dps` | string | The number of input documents per second. docs_per_second | +| `dtime` | string | The total time spent deleting documents, in milliseconds. delete_time | +| `f` | string | The interval between checks for changes in the source indices when the transform is running continuously. frequency | +| `frequency` | string | The interval between checks for changes in the source indices when the transform is running continuously. | +| `id` | [Id](./Id.md) | The transform identifier. | +| `idea` | string | The exponential moving average of the number of new documents that have been indexed. indexed_documents_exp_avg | +| `if` | string | The total number of indexing failures. index_failure | +| `index_failure` | string | The total number of indexing failures. | +| `index_time` | string | The total time spent indexing documents, in milliseconds. | +| `index_total` | string | The total number of index operations done by the transform. | +| `indexed_documents_exp_avg` | string | The exponential moving average of the number of new documents that have been indexed. | +| `it` | string | The total number of index operations done by the transform. index_total | +| `itime` | string | The total time spent indexing documents, in milliseconds. index_time | +| `last_search_time` | string | null | The timestamp of the last search in the source indices. This field is shown only if the transform is running. | +| `lastSearchTime` | string | null | The timestamp of the last search in the source indices. This field is shown only if the transform is running. last_search_time | +| `lst` | string | null | The timestamp of the last search in the source indices. This field is shown only if the transform is running. last_search_time | +| `max_page_search_size` | string | The initial page size that is used for the composite aggregation for each checkpoint. | +| `mpsz` | string | The initial page size that is used for the composite aggregation for each checkpoint. max_page_search_size | +| `p` | string | The unique identifier for the ingest pipeline. pipeline | +| `pages_processed` | string | The number of search or bulk index operations processed. Documents are processed in batches instead of individually. | +| `pdea` | string | The exponential moving average of the number of documents that have been processed. processed_documents_exp_avg | +| `pipeline` | string | The unique identifier for the ingest pipeline. | +| `pp` | string | The number of search or bulk index operations processed. Documents are processed in batches instead of individually. pages_processed | +| `processed_documents_exp_avg` | string | The exponential moving average of the number of documents that have been processed. | +| `processing_time` | string | The total time spent processing results, in milliseconds. | +| `pt` | string | The total time spent processing results, in milliseconds. processing_time | +| `r` | string | If a transform has a `failed` state, these details describe the reason for failure. reason | +| `reason` | string | If a transform has a `failed` state, these details describe the reason for failure. | +| `s` | string | The status of the transform. Returned values include: `aborting`: The transform is aborting. `failed: The transform failed. For more information about the failure, check the `reason ` field. `indexing `: The transform is actively processing data and creating new documents. `started `: The transform is running but not actively indexing data. `stopped `: The transform is stopped. `stopping ` : The transform is stopping. state | +| `search_failure` | string | The total number of search failures. | +| `search_time` | string | The total amount of search time, in milliseconds. | +| `search_total` | string | The total number of search operations on the source index for the transform. | +| `sf` | string | The total number of search failures. search_failure | +| `si` | string | The source indices for the transform. source_index | +| `source_index` | string | The source indices for the transform. | +| `sourceIndex` | string | The source indices for the transform. source_index | +| `st` | string | The total number of search operations on the source index for the transform. search_total | +| `state` | string | The status of the transform. Returned values include: `aborting`: The transform is aborting. `failed: The transform failed. For more information about the failure, check the `reason ` field. `indexing `: The transform is actively processing data and creating new documents. `started `: The transform is running but not actively indexing data. `stopped `: The transform is stopped. `stopping ` : The transform is stopping. | +| `stime` | string | The total amount of search time, in milliseconds. search_time | +| `tc` | string | The number of times the transform has been triggered by the scheduler. For example, the scheduler triggers the transform indexer to check for updates or ingest new data at an interval specified in the `frequency` property. trigger_count | +| `transform_type` | string | The type of transform: `batch` or `continuous`. | +| `trigger_count` | string | The number of times the transform has been triggered by the scheduler. For example, the scheduler triggers the transform indexer to check for updates or ingest new data at an interval specified in the `frequency` property. | +| `tt` | string | The type of transform: `batch` or `continuous`. transform_type | +| `v` | [VersionString](./VersionString.md) | The version of Elasticsearch that existed on the node when the transform was created. version | +| `version` | [VersionString](./VersionString.md) | The version of Elasticsearch that existed on the node when the transform was created. | diff --git a/docs/reference/api/CategoryId.md b/docs/reference/api/CategoryId.md new file mode 100644 index 000000000..e685e7cb7 --- /dev/null +++ b/docs/reference/api/CategoryId.md @@ -0,0 +1,4 @@ +## `CategoryId` +::: +type CategoryId = string; +::: diff --git a/docs/reference/api/Ccr.md b/docs/reference/api/Ccr.md new file mode 100644 index 000000000..bb4103936 --- /dev/null +++ b/docs/reference/api/Ccr.md @@ -0,0 +1,20 @@ +## `Ccr` + +### Constructor + +::: +new Ccr(transport: [Transport](./Transport.md)); +::: + +### Properties + +| Name | Type | Description | +| - | - | - | +| `acceptedParams` | Record |   | +| `transport` | [Transport](./Transport.md) |   | + +### Methods + +| Name | Signature | Description | +| - | - | - | +| `deleteAutoFollowPattern` | `deleteAutoFollowPattern(this: [That](./That.md), params: [CcrDeleteAutoFollowPatternRequest](./CcrDeleteAutoFollowPatternRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CcrDeleteAutoFollowPatternResponse](./CcrDeleteAutoFollowPatternResponse.md)>;` | Delete auto-follow patterns. Delete a collection of cross-cluster replication auto-follow patterns. || `deleteAutoFollowPattern` | `deleteAutoFollowPattern(this: [That](./That.md), params: [CcrDeleteAutoFollowPatternRequest](./CcrDeleteAutoFollowPatternRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CcrDeleteAutoFollowPatternResponse](./CcrDeleteAutoFollowPatternResponse.md), unknown>>;` |   || `deleteAutoFollowPattern` | `deleteAutoFollowPattern(this: [That](./That.md), params: [CcrDeleteAutoFollowPatternRequest](./CcrDeleteAutoFollowPatternRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CcrDeleteAutoFollowPatternResponse](./CcrDeleteAutoFollowPatternResponse.md)>;` |   || `follow` | `follow(this: [That](./That.md), params: [CcrFollowRequest](./CcrFollowRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CcrFollowResponse](./CcrFollowResponse.md)>;` | Create a follower. Create a cross-cluster replication follower index that follows a specific leader index. When the API returns, the follower index exists and cross-cluster replication starts replicating operations from the leader index to the follower index. || `follow` | `follow(this: [That](./That.md), params: [CcrFollowRequest](./CcrFollowRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CcrFollowResponse](./CcrFollowResponse.md), unknown>>;` |   || `follow` | `follow(this: [That](./That.md), params: [CcrFollowRequest](./CcrFollowRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CcrFollowResponse](./CcrFollowResponse.md)>;` |   || `followInfo` | `followInfo(this: [That](./That.md), params: [CcrFollowInfoRequest](./CcrFollowInfoRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CcrFollowInfoResponse](./CcrFollowInfoResponse.md)>;` | Get follower information. Get information about all cross-cluster replication follower indices. For example, the results include follower index names, leader index names, replication options, and whether the follower indices are active or paused. || `followInfo` | `followInfo(this: [That](./That.md), params: [CcrFollowInfoRequest](./CcrFollowInfoRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CcrFollowInfoResponse](./CcrFollowInfoResponse.md), unknown>>;` |   || `followInfo` | `followInfo(this: [That](./That.md), params: [CcrFollowInfoRequest](./CcrFollowInfoRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CcrFollowInfoResponse](./CcrFollowInfoResponse.md)>;` |   || `followStats` | `followStats(this: [That](./That.md), params: [CcrFollowStatsRequest](./CcrFollowStatsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CcrFollowStatsResponse](./CcrFollowStatsResponse.md)>;` | Get follower stats. Get cross-cluster replication follower stats. The API returns shard-level stats about the "following tasks" associated with each shard for the specified indices. || `followStats` | `followStats(this: [That](./That.md), params: [CcrFollowStatsRequest](./CcrFollowStatsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CcrFollowStatsResponse](./CcrFollowStatsResponse.md), unknown>>;` |   || `followStats` | `followStats(this: [That](./That.md), params: [CcrFollowStatsRequest](./CcrFollowStatsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CcrFollowStatsResponse](./CcrFollowStatsResponse.md)>;` |   || `forgetFollower` | `forgetFollower(this: [That](./That.md), params: [CcrForgetFollowerRequest](./CcrForgetFollowerRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CcrForgetFollowerResponse](./CcrForgetFollowerResponse.md)>;` | Forget a follower. Remove the cross-cluster replication follower retention leases from the leader. A following index takes out retention leases on its leader index. These leases are used to increase the likelihood that the shards of the leader index retain the history of operations that the shards of the following index need to run replication. When a follower index is converted to a regular index by the unfollow API (either by directly calling the API or by index lifecycle management tasks), these leases are removed. However, removal of the leases can fail, for example when the remote cluster containing the leader index is unavailable. While the leases will eventually expire on their own, their extended existence can cause the leader index to hold more history than necessary and prevent index lifecycle management from performing some operations on the leader index. This API exists to enable manually removing the leases when the unfollow API is unable to do so. NOTE: This API does not stop replication by a following index. If you use this API with a follower index that is still actively following, the following index will add back retention leases on the leader. The only purpose of this API is to handle the case of failure to remove the following retention leases after the unfollow API is invoked. || `forgetFollower` | `forgetFollower(this: [That](./That.md), params: [CcrForgetFollowerRequest](./CcrForgetFollowerRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CcrForgetFollowerResponse](./CcrForgetFollowerResponse.md), unknown>>;` |   || `forgetFollower` | `forgetFollower(this: [That](./That.md), params: [CcrForgetFollowerRequest](./CcrForgetFollowerRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CcrForgetFollowerResponse](./CcrForgetFollowerResponse.md)>;` |   || `getAutoFollowPattern` | `getAutoFollowPattern(this: [That](./That.md), params?: [CcrGetAutoFollowPatternRequest](./CcrGetAutoFollowPatternRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CcrGetAutoFollowPatternResponse](./CcrGetAutoFollowPatternResponse.md)>;` | Get auto-follow patterns. Get cross-cluster replication auto-follow patterns. || `getAutoFollowPattern` | `getAutoFollowPattern(this: [That](./That.md), params?: [CcrGetAutoFollowPatternRequest](./CcrGetAutoFollowPatternRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CcrGetAutoFollowPatternResponse](./CcrGetAutoFollowPatternResponse.md), unknown>>;` |   || `getAutoFollowPattern` | `getAutoFollowPattern(this: [That](./That.md), params?: [CcrGetAutoFollowPatternRequest](./CcrGetAutoFollowPatternRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CcrGetAutoFollowPatternResponse](./CcrGetAutoFollowPatternResponse.md)>;` |   || `pauseAutoFollowPattern` | `pauseAutoFollowPattern(this: [That](./That.md), params: [CcrPauseAutoFollowPatternRequest](./CcrPauseAutoFollowPatternRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CcrPauseAutoFollowPatternResponse](./CcrPauseAutoFollowPatternResponse.md)>;` | Pause an auto-follow pattern. Pause a cross-cluster replication auto-follow pattern. When the API returns, the auto-follow pattern is inactive. New indices that are created on the remote cluster and match the auto-follow patterns are ignored. You can resume auto-following with the resume auto-follow pattern API. When it resumes, the auto-follow pattern is active again and automatically configures follower indices for newly created indices on the remote cluster that match its patterns. Remote indices that were created while the pattern was paused will also be followed, unless they have been deleted or closed in the interim. || `pauseAutoFollowPattern` | `pauseAutoFollowPattern(this: [That](./That.md), params: [CcrPauseAutoFollowPatternRequest](./CcrPauseAutoFollowPatternRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CcrPauseAutoFollowPatternResponse](./CcrPauseAutoFollowPatternResponse.md), unknown>>;` |   || `pauseAutoFollowPattern` | `pauseAutoFollowPattern(this: [That](./That.md), params: [CcrPauseAutoFollowPatternRequest](./CcrPauseAutoFollowPatternRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CcrPauseAutoFollowPatternResponse](./CcrPauseAutoFollowPatternResponse.md)>;` |   || `pauseFollow` | `pauseFollow(this: [That](./That.md), params: [CcrPauseFollowRequest](./CcrPauseFollowRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CcrPauseFollowResponse](./CcrPauseFollowResponse.md)>;` | Pause a follower. Pause a cross-cluster replication follower index. The follower index will not fetch any additional operations from the leader index. You can resume following with the resume follower API. You can pause and resume a follower index to change the configuration of the following task. || `pauseFollow` | `pauseFollow(this: [That](./That.md), params: [CcrPauseFollowRequest](./CcrPauseFollowRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CcrPauseFollowResponse](./CcrPauseFollowResponse.md), unknown>>;` |   || `pauseFollow` | `pauseFollow(this: [That](./That.md), params: [CcrPauseFollowRequest](./CcrPauseFollowRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CcrPauseFollowResponse](./CcrPauseFollowResponse.md)>;` |   || `putAutoFollowPattern` | `putAutoFollowPattern(this: [That](./That.md), params: [CcrPutAutoFollowPatternRequest](./CcrPutAutoFollowPatternRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CcrPutAutoFollowPatternResponse](./CcrPutAutoFollowPatternResponse.md)>;` | Create or update auto-follow patterns. Create a collection of cross-cluster replication auto-follow patterns for a remote cluster. Newly created indices on the remote cluster that match any of the patterns are automatically configured as follower indices. Indices on the remote cluster that were created before the auto-follow pattern was created will not be auto-followed even if they match the pattern. This API can also be used to update auto-follow patterns. NOTE: Follower indices that were configured automatically before updating an auto-follow pattern will remain unchanged even if they do not match against the new patterns. || `putAutoFollowPattern` | `putAutoFollowPattern(this: [That](./That.md), params: [CcrPutAutoFollowPatternRequest](./CcrPutAutoFollowPatternRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CcrPutAutoFollowPatternResponse](./CcrPutAutoFollowPatternResponse.md), unknown>>;` |   || `putAutoFollowPattern` | `putAutoFollowPattern(this: [That](./That.md), params: [CcrPutAutoFollowPatternRequest](./CcrPutAutoFollowPatternRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CcrPutAutoFollowPatternResponse](./CcrPutAutoFollowPatternResponse.md)>;` |   || `resumeAutoFollowPattern` | `resumeAutoFollowPattern(this: [That](./That.md), params: [CcrResumeAutoFollowPatternRequest](./CcrResumeAutoFollowPatternRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CcrResumeAutoFollowPatternResponse](./CcrResumeAutoFollowPatternResponse.md)>;` | Resume an auto-follow pattern. Resume a cross-cluster replication auto-follow pattern that was paused. The auto-follow pattern will resume configuring following indices for newly created indices that match its patterns on the remote cluster. Remote indices created while the pattern was paused will also be followed unless they have been deleted or closed in the interim. || `resumeAutoFollowPattern` | `resumeAutoFollowPattern(this: [That](./That.md), params: [CcrResumeAutoFollowPatternRequest](./CcrResumeAutoFollowPatternRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CcrResumeAutoFollowPatternResponse](./CcrResumeAutoFollowPatternResponse.md), unknown>>;` |   || `resumeAutoFollowPattern` | `resumeAutoFollowPattern(this: [That](./That.md), params: [CcrResumeAutoFollowPatternRequest](./CcrResumeAutoFollowPatternRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CcrResumeAutoFollowPatternResponse](./CcrResumeAutoFollowPatternResponse.md)>;` |   || `resumeFollow` | `resumeFollow(this: [That](./That.md), params: [CcrResumeFollowRequest](./CcrResumeFollowRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CcrResumeFollowResponse](./CcrResumeFollowResponse.md)>;` | Resume a follower. Resume a cross-cluster replication follower index that was paused. The follower index could have been paused with the pause follower API. Alternatively it could be paused due to replication that cannot be retried due to failures during following tasks. When this API returns, the follower index will resume fetching operations from the leader index. || `resumeFollow` | `resumeFollow(this: [That](./That.md), params: [CcrResumeFollowRequest](./CcrResumeFollowRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CcrResumeFollowResponse](./CcrResumeFollowResponse.md), unknown>>;` |   || `resumeFollow` | `resumeFollow(this: [That](./That.md), params: [CcrResumeFollowRequest](./CcrResumeFollowRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CcrResumeFollowResponse](./CcrResumeFollowResponse.md)>;` |   || `stats` | `stats(this: [That](./That.md), params?: [CcrStatsRequest](./CcrStatsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CcrStatsResponse](./CcrStatsResponse.md)>;` | Get cross-cluster replication stats. This API returns stats about auto-following and the same shard-level stats as the get follower stats API. || `stats` | `stats(this: [That](./That.md), params?: [CcrStatsRequest](./CcrStatsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CcrStatsResponse](./CcrStatsResponse.md), unknown>>;` |   || `stats` | `stats(this: [That](./That.md), params?: [CcrStatsRequest](./CcrStatsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CcrStatsResponse](./CcrStatsResponse.md)>;` |   || `unfollow` | `unfollow(this: [That](./That.md), params: [CcrUnfollowRequest](./CcrUnfollowRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CcrUnfollowResponse](./CcrUnfollowResponse.md)>;` | Unfollow an index. Convert a cross-cluster replication follower index to a regular index. The API stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. The follower index must be paused and closed before you call the unfollow API. > info > Currently cross-cluster replication does not support converting an existing regular index to a follower index. Converting a follower index to a regular index is an irreversible operation. || `unfollow` | `unfollow(this: [That](./That.md), params: [CcrUnfollowRequest](./CcrUnfollowRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CcrUnfollowResponse](./CcrUnfollowResponse.md), unknown>>;` |   || `unfollow` | `unfollow(this: [That](./That.md), params: [CcrUnfollowRequest](./CcrUnfollowRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CcrUnfollowResponse](./CcrUnfollowResponse.md)>;` |   | \ No newline at end of file diff --git a/docs/reference/api/CcrDeleteAutoFollowPatternRequest.md b/docs/reference/api/CcrDeleteAutoFollowPatternRequest.md new file mode 100644 index 000000000..96a0bee3b --- /dev/null +++ b/docs/reference/api/CcrDeleteAutoFollowPatternRequest.md @@ -0,0 +1,8 @@ +## Interface `CcrDeleteAutoFollowPatternRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { name?: never; master_timeout?: never; }) | All values in `body` will be added to the request body. | +| `master_timeout` | [Duration](./Duration.md) | The period to wait for a connection to the master node. If the master node is not available before the timeout expires, the request fails and returns an error. It can also be set to `-1` to indicate that the request should never timeout. | +| `name` | [Name](./Name.md) | The auto-follow pattern collection to delete. | +| `querystring` | { [key: string]: any; } & { name?: never; master_timeout?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/CcrDeleteAutoFollowPatternResponse.md b/docs/reference/api/CcrDeleteAutoFollowPatternResponse.md new file mode 100644 index 000000000..649f9ef0d --- /dev/null +++ b/docs/reference/api/CcrDeleteAutoFollowPatternResponse.md @@ -0,0 +1,4 @@ +## `CcrDeleteAutoFollowPatternResponse` +::: +type CcrDeleteAutoFollowPatternResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); +::: diff --git a/docs/reference/api/CcrFollowIndexStats.md b/docs/reference/api/CcrFollowIndexStats.md new file mode 100644 index 000000000..c909609a1 --- /dev/null +++ b/docs/reference/api/CcrFollowIndexStats.md @@ -0,0 +1,6 @@ +## Interface `CcrFollowIndexStats` + +| Name | Type | Description | +| - | - | - | +| `index` | [IndexName](./IndexName.md) | The name of the follower index. | +| `shards` | [CcrShardStats](./CcrShardStats.md)[] | An array of shard-level following task statistics. | diff --git a/docs/reference/api/CcrFollowInfoFollowerIndex.md b/docs/reference/api/CcrFollowInfoFollowerIndex.md new file mode 100644 index 000000000..68282da1b --- /dev/null +++ b/docs/reference/api/CcrFollowInfoFollowerIndex.md @@ -0,0 +1,9 @@ +## Interface `CcrFollowInfoFollowerIndex` + +| Name | Type | Description | +| - | - | - | +| `follower_index` | [IndexName](./IndexName.md) | The name of the follower index. | +| `leader_index` | [IndexName](./IndexName.md) | The name of the index in the leader cluster that is followed. | +| `parameters` | [CcrFollowInfoFollowerIndexParameters](./CcrFollowInfoFollowerIndexParameters.md) | An object that encapsulates cross-cluster replication parameters. If the follower index's status is paused, this object is omitted. | +| `remote_cluster` | [Name](./Name.md) | The remote cluster that contains the leader index. | +| `status` | [CcrFollowInfoFollowerIndexStatus](./CcrFollowInfoFollowerIndexStatus.md) | The status of the index following: `active` or `paused`. | diff --git a/docs/reference/api/CcrFollowInfoFollowerIndexParameters.md b/docs/reference/api/CcrFollowInfoFollowerIndexParameters.md new file mode 100644 index 000000000..dc163f84d --- /dev/null +++ b/docs/reference/api/CcrFollowInfoFollowerIndexParameters.md @@ -0,0 +1,14 @@ +## Interface `CcrFollowInfoFollowerIndexParameters` + +| Name | Type | Description | +| - | - | - | +| `max_outstanding_read_requests` | [long](./long.md) | The maximum number of outstanding reads requests from the remote cluster. | +| `max_outstanding_write_requests` | [integer](./integer.md) | The maximum number of outstanding write requests on the follower. | +| `max_read_request_operation_count` | [integer](./integer.md) | The maximum number of operations to pull per read from the remote cluster. | +| `max_read_request_size` | [ByteSize](./ByteSize.md) | The maximum size in bytes of per read of a batch of operations pulled from the remote cluster. | +| `max_retry_delay` | [Duration](./Duration.md) | The maximum time to wait before retrying an operation that failed exceptionally. An exponential backoff strategy is employed when retrying. | +| `max_write_buffer_count` | [integer](./integer.md) | The maximum number of operations that can be queued for writing. When this limit is reached, reads from the remote cluster will be deferred until the number of queued operations goes below the limit. | +| `max_write_buffer_size` | [ByteSize](./ByteSize.md) | The maximum total bytes of operations that can be queued for writing. When this limit is reached, reads from the remote cluster will be deferred until the total bytes of queued operations goes below the limit. | +| `max_write_request_operation_count` | [integer](./integer.md) | The maximum number of operations per bulk write request executed on the follower. | +| `max_write_request_size` | [ByteSize](./ByteSize.md) | The maximum total bytes of operations per bulk write request executed on the follower. | +| `read_poll_timeout` | [Duration](./Duration.md) | The maximum time to wait for new operations on the remote cluster when the follower index is synchronized with the leader index. When the timeout has elapsed, the poll for operations will return to the follower so that it can update some statistics. Then the follower will immediately attempt to read from the leader again. | diff --git a/docs/reference/api/CcrFollowInfoFollowerIndexStatus.md b/docs/reference/api/CcrFollowInfoFollowerIndexStatus.md new file mode 100644 index 000000000..8b89fcda6 --- /dev/null +++ b/docs/reference/api/CcrFollowInfoFollowerIndexStatus.md @@ -0,0 +1,4 @@ +## `CcrFollowInfoFollowerIndexStatus` +::: +type CcrFollowInfoFollowerIndexStatus = 'active' | 'paused'; +::: diff --git a/docs/reference/api/CcrFollowInfoRequest.md b/docs/reference/api/CcrFollowInfoRequest.md new file mode 100644 index 000000000..f1ae2b231 --- /dev/null +++ b/docs/reference/api/CcrFollowInfoRequest.md @@ -0,0 +1,8 @@ +## Interface `CcrFollowInfoRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { index?: never; master_timeout?: never; }) | All values in `body` will be added to the request body. | +| `index` | [Indices](./Indices.md) | A comma-delimited list of follower index patterns. | +| `master_timeout` | [Duration](./Duration.md) | The period to wait for a connection to the master node. If the master node is not available before the timeout expires, the request fails and returns an error. It can also be set to `-1` to indicate that the request should never timeout. | +| `querystring` | { [key: string]: any; } & { index?: never; master_timeout?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/CcrFollowInfoResponse.md b/docs/reference/api/CcrFollowInfoResponse.md new file mode 100644 index 000000000..7d552e7e5 --- /dev/null +++ b/docs/reference/api/CcrFollowInfoResponse.md @@ -0,0 +1,5 @@ +## Interface `CcrFollowInfoResponse` + +| Name | Type | Description | +| - | - | - | +| `follower_indices` | [CcrFollowInfoFollowerIndex](./CcrFollowInfoFollowerIndex.md)[] |   | diff --git a/docs/reference/api/CcrFollowRequest.md b/docs/reference/api/CcrFollowRequest.md new file mode 100644 index 000000000..4ed187ab9 --- /dev/null +++ b/docs/reference/api/CcrFollowRequest.md @@ -0,0 +1,23 @@ +## Interface `CcrFollowRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { index?: never; master_timeout?: never; wait_for_active_shards?: never; data_stream_name?: never; leader_index?: never; max_outstanding_read_requests?: never; max_outstanding_write_requests?: never; max_read_request_operation_count?: never; max_read_request_size?: never; max_retry_delay?: never; max_write_buffer_count?: never; max_write_buffer_size?: never; max_write_request_operation_count?: never; max_write_request_size?: never; read_poll_timeout?: never; remote_cluster?: never; settings?: never; }) | All values in `body` will be added to the request body. | +| `data_stream_name` | string | If the leader index is part of a data stream, the name to which the local data stream for the followed index should be renamed. | +| `index` | [IndexName](./IndexName.md) | The name of the follower index. | +| `leader_index` | [IndexName](./IndexName.md) | The name of the index in the leader cluster to follow. | +| `master_timeout` | [Duration](./Duration.md) | Period to wait for a connection to the master node. | +| `max_outstanding_read_requests` | [long](./long.md) | The maximum number of outstanding reads requests from the remote cluster. | +| `max_outstanding_write_requests` | [integer](./integer.md) | The maximum number of outstanding write requests on the follower. | +| `max_read_request_operation_count` | [integer](./integer.md) | The maximum number of operations to pull per read from the remote cluster. | +| `max_read_request_size` | [ByteSize](./ByteSize.md) | The maximum size in bytes of per read of a batch of operations pulled from the remote cluster. | +| `max_retry_delay` | [Duration](./Duration.md) | The maximum time to wait before retrying an operation that failed exceptionally. An exponential backoff strategy is employed when retrying. | +| `max_write_buffer_count` | [integer](./integer.md) | The maximum number of operations that can be queued for writing. When this limit is reached, reads from the remote cluster will be deferred until the number of queued operations goes below the limit. | +| `max_write_buffer_size` | [ByteSize](./ByteSize.md) | The maximum total bytes of operations that can be queued for writing. When this limit is reached, reads from the remote cluster will be deferred until the total bytes of queued operations goes below the limit. | +| `max_write_request_operation_count` | [integer](./integer.md) | The maximum number of operations per bulk write request executed on the follower. | +| `max_write_request_size` | [ByteSize](./ByteSize.md) | The maximum total bytes of operations per bulk write request executed on the follower. | +| `querystring` | { [key: string]: any; } & { index?: never; master_timeout?: never; wait_for_active_shards?: never; data_stream_name?: never; leader_index?: never; max_outstanding_read_requests?: never; max_outstanding_write_requests?: never; max_read_request_operation_count?: never; max_read_request_size?: never; max_retry_delay?: never; max_write_buffer_count?: never; max_write_buffer_size?: never; max_write_request_operation_count?: never; max_write_request_size?: never; read_poll_timeout?: never; remote_cluster?: never; settings?: never; } | All values in `querystring` will be added to the request querystring. | +| `read_poll_timeout` | [Duration](./Duration.md) | The maximum time to wait for new operations on the remote cluster when the follower index is synchronized with the leader index. When the timeout has elapsed, the poll for operations will return to the follower so that it can update some statistics. Then the follower will immediately attempt to read from the leader again. | +| `remote_cluster` | string | The remote cluster containing the leader index. | +| `settings` | [IndicesIndexSettings](./IndicesIndexSettings.md) | Settings to override from the leader index. | +| `wait_for_active_shards` | [WaitForActiveShards](./WaitForActiveShards.md) | Specifies the number of shards to wait on being active before responding. This defaults to waiting on none of the shards to be active. A shard must be restored from the leader index before being active. Restoring a follower shard requires transferring all the remote Lucene segment files to the follower index. | diff --git a/docs/reference/api/CcrFollowResponse.md b/docs/reference/api/CcrFollowResponse.md new file mode 100644 index 000000000..164ac5764 --- /dev/null +++ b/docs/reference/api/CcrFollowResponse.md @@ -0,0 +1,7 @@ +## Interface `CcrFollowResponse` + +| Name | Type | Description | +| - | - | - | +| `follow_index_created` | boolean |   | +| `follow_index_shards_acked` | boolean |   | +| `index_following_started` | boolean |   | diff --git a/docs/reference/api/CcrFollowStatsRequest.md b/docs/reference/api/CcrFollowStatsRequest.md new file mode 100644 index 000000000..4101e0ace --- /dev/null +++ b/docs/reference/api/CcrFollowStatsRequest.md @@ -0,0 +1,8 @@ +## Interface `CcrFollowStatsRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { index?: never; timeout?: never; }) | All values in `body` will be added to the request body. | +| `index` | [Indices](./Indices.md) | A comma-delimited list of index patterns. | +| `querystring` | { [key: string]: any; } & { index?: never; timeout?: never; } | All values in `querystring` will be added to the request querystring. | +| `timeout` | [Duration](./Duration.md) | The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. | diff --git a/docs/reference/api/CcrFollowStatsResponse.md b/docs/reference/api/CcrFollowStatsResponse.md new file mode 100644 index 000000000..1c602130e --- /dev/null +++ b/docs/reference/api/CcrFollowStatsResponse.md @@ -0,0 +1,5 @@ +## Interface `CcrFollowStatsResponse` + +| Name | Type | Description | +| - | - | - | +| `indices` | [CcrFollowIndexStats](./CcrFollowIndexStats.md)[] | An array of follower index statistics. | diff --git a/docs/reference/api/CcrForgetFollowerRequest.md b/docs/reference/api/CcrForgetFollowerRequest.md new file mode 100644 index 000000000..17637c0c7 --- /dev/null +++ b/docs/reference/api/CcrForgetFollowerRequest.md @@ -0,0 +1,12 @@ +## Interface `CcrForgetFollowerRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { index?: never; timeout?: never; follower_cluster?: never; follower_index?: never; follower_index_uuid?: never; leader_remote_cluster?: never; }) | All values in `body` will be added to the request body. | +| `follower_cluster` | string |   | +| `follower_index_uuid` | [Uuid](./Uuid.md) |   | +| `follower_index` | [IndexName](./IndexName.md) |   | +| `index` | [IndexName](./IndexName.md) | the name of the leader index for which specified follower retention leases should be removed | +| `leader_remote_cluster` | string |   | +| `querystring` | { [key: string]: any; } & { index?: never; timeout?: never; follower_cluster?: never; follower_index?: never; follower_index_uuid?: never; leader_remote_cluster?: never; } | All values in `querystring` will be added to the request querystring. | +| `timeout` | [Duration](./Duration.md) | Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. | diff --git a/docs/reference/api/CcrForgetFollowerResponse.md b/docs/reference/api/CcrForgetFollowerResponse.md new file mode 100644 index 000000000..70cfde3ed --- /dev/null +++ b/docs/reference/api/CcrForgetFollowerResponse.md @@ -0,0 +1,5 @@ +## Interface `CcrForgetFollowerResponse` + +| Name | Type | Description | +| - | - | - | +| `_shards` | [ShardStatistics](./ShardStatistics.md) |   | diff --git a/docs/reference/api/CcrGetAutoFollowPatternAutoFollowPattern.md b/docs/reference/api/CcrGetAutoFollowPatternAutoFollowPattern.md new file mode 100644 index 000000000..0af365570 --- /dev/null +++ b/docs/reference/api/CcrGetAutoFollowPatternAutoFollowPattern.md @@ -0,0 +1,6 @@ +## Interface `CcrGetAutoFollowPatternAutoFollowPattern` + +| Name | Type | Description | +| - | - | - | +| `name` | [Name](./Name.md) |   | +| `pattern` | [CcrGetAutoFollowPatternAutoFollowPatternSummary](./CcrGetAutoFollowPatternAutoFollowPatternSummary.md) |   | diff --git a/docs/reference/api/CcrGetAutoFollowPatternAutoFollowPatternSummary.md b/docs/reference/api/CcrGetAutoFollowPatternAutoFollowPatternSummary.md new file mode 100644 index 000000000..058fdc56d --- /dev/null +++ b/docs/reference/api/CcrGetAutoFollowPatternAutoFollowPatternSummary.md @@ -0,0 +1,10 @@ +## Interface `CcrGetAutoFollowPatternAutoFollowPatternSummary` + +| Name | Type | Description | +| - | - | - | +| `active` | boolean |   | +| `follow_index_pattern` | [IndexPattern](./IndexPattern.md) | The name of follower index. | +| `leader_index_exclusion_patterns` | [IndexPatterns](./IndexPatterns.md) | An array of simple index patterns that can be used to exclude indices from being auto-followed. | +| `leader_index_patterns` | [IndexPatterns](./IndexPatterns.md) | An array of simple index patterns to match against indices in the remote cluster specified by the remote_cluster field. | +| `max_outstanding_read_requests` | [integer](./integer.md) | The maximum number of outstanding reads requests from the remote cluster. | +| `remote_cluster` | string | The remote cluster containing the leader indices to match against. | diff --git a/docs/reference/api/CcrGetAutoFollowPatternRequest.md b/docs/reference/api/CcrGetAutoFollowPatternRequest.md new file mode 100644 index 000000000..bfa4d80c1 --- /dev/null +++ b/docs/reference/api/CcrGetAutoFollowPatternRequest.md @@ -0,0 +1,8 @@ +## Interface `CcrGetAutoFollowPatternRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { name?: never; master_timeout?: never; }) | All values in `body` will be added to the request body. | +| `master_timeout` | [Duration](./Duration.md) | The period to wait for a connection to the master node. If the master node is not available before the timeout expires, the request fails and returns an error. It can also be set to `-1` to indicate that the request should never timeout. | +| `name` | [Name](./Name.md) | The auto-follow pattern collection that you want to retrieve. If you do not specify a name, the API returns information for all collections. | +| `querystring` | { [key: string]: any; } & { name?: never; master_timeout?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/CcrGetAutoFollowPatternResponse.md b/docs/reference/api/CcrGetAutoFollowPatternResponse.md new file mode 100644 index 000000000..2e18e1540 --- /dev/null +++ b/docs/reference/api/CcrGetAutoFollowPatternResponse.md @@ -0,0 +1,5 @@ +## Interface `CcrGetAutoFollowPatternResponse` + +| Name | Type | Description | +| - | - | - | +| `patterns` | [CcrGetAutoFollowPatternAutoFollowPattern](./CcrGetAutoFollowPatternAutoFollowPattern.md)[] |   | diff --git a/docs/reference/api/CcrPauseAutoFollowPatternRequest.md b/docs/reference/api/CcrPauseAutoFollowPatternRequest.md new file mode 100644 index 000000000..69670af41 --- /dev/null +++ b/docs/reference/api/CcrPauseAutoFollowPatternRequest.md @@ -0,0 +1,8 @@ +## Interface `CcrPauseAutoFollowPatternRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { name?: never; master_timeout?: never; }) | All values in `body` will be added to the request body. | +| `master_timeout` | [Duration](./Duration.md) | The period to wait for a connection to the master node. If the master node is not available before the timeout expires, the request fails and returns an error. It can also be set to `-1` to indicate that the request should never timeout. | +| `name` | [Name](./Name.md) | The name of the auto-follow pattern to pause. | +| `querystring` | { [key: string]: any; } & { name?: never; master_timeout?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/CcrPauseAutoFollowPatternResponse.md b/docs/reference/api/CcrPauseAutoFollowPatternResponse.md new file mode 100644 index 000000000..e29c13d4b --- /dev/null +++ b/docs/reference/api/CcrPauseAutoFollowPatternResponse.md @@ -0,0 +1,4 @@ +## `CcrPauseAutoFollowPatternResponse` +::: +type CcrPauseAutoFollowPatternResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); +::: diff --git a/docs/reference/api/CcrPauseFollowRequest.md b/docs/reference/api/CcrPauseFollowRequest.md new file mode 100644 index 000000000..260a0944a --- /dev/null +++ b/docs/reference/api/CcrPauseFollowRequest.md @@ -0,0 +1,8 @@ +## Interface `CcrPauseFollowRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { index?: never; master_timeout?: never; }) | All values in `body` will be added to the request body. | +| `index` | [IndexName](./IndexName.md) | The name of the follower index. | +| `master_timeout` | [Duration](./Duration.md) | The period to wait for a connection to the master node. If the master node is not available before the timeout expires, the request fails and returns an error. It can also be set to `-1` to indicate that the request should never timeout. | +| `querystring` | { [key: string]: any; } & { index?: never; master_timeout?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/CcrPauseFollowResponse.md b/docs/reference/api/CcrPauseFollowResponse.md new file mode 100644 index 000000000..5e5e2fb1a --- /dev/null +++ b/docs/reference/api/CcrPauseFollowResponse.md @@ -0,0 +1,4 @@ +## `CcrPauseFollowResponse` +::: +type CcrPauseFollowResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); +::: diff --git a/docs/reference/api/CcrPutAutoFollowPatternRequest.md b/docs/reference/api/CcrPutAutoFollowPatternRequest.md new file mode 100644 index 000000000..5b78ed59d --- /dev/null +++ b/docs/reference/api/CcrPutAutoFollowPatternRequest.md @@ -0,0 +1,23 @@ +## Interface `CcrPutAutoFollowPatternRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { name?: never; master_timeout?: never; remote_cluster?: never; follow_index_pattern?: never; leader_index_patterns?: never; leader_index_exclusion_patterns?: never; max_outstanding_read_requests?: never; settings?: never; max_outstanding_write_requests?: never; read_poll_timeout?: never; max_read_request_operation_count?: never; max_read_request_size?: never; max_retry_delay?: never; max_write_buffer_count?: never; max_write_buffer_size?: never; max_write_request_operation_count?: never; max_write_request_size?: never; }) | All values in `body` will be added to the request body. | +| `follow_index_pattern` | [IndexPattern](./IndexPattern.md) | The name of follower index. The template { { leader_index } } can be used to derive the name of the follower index from the name of the leader index. When following a data stream, use { { leader_index } } ; CCR does not support changes to the names of a follower data stream’s backing indices. | +| `leader_index_exclusion_patterns` | [IndexPatterns](./IndexPatterns.md) | An array of simple index patterns that can be used to exclude indices from being auto-followed. Indices in the remote cluster whose names are matching one or more leader_index_patterns and one or more leader_index_exclusion_patterns won’t be followed. | +| `leader_index_patterns` | [IndexPatterns](./IndexPatterns.md) | An array of simple index patterns to match against indices in the remote cluster specified by the remote_cluster field. | +| `master_timeout` | [Duration](./Duration.md) | Period to wait for a connection to the master node. | +| `max_outstanding_read_requests` | [integer](./integer.md) | The maximum number of outstanding reads requests from the remote cluster. | +| `max_outstanding_write_requests` | [integer](./integer.md) | The maximum number of outstanding reads requests from the remote cluster. | +| `max_read_request_operation_count` | [integer](./integer.md) | The maximum number of operations to pull per read from the remote cluster. | +| `max_read_request_size` | [ByteSize](./ByteSize.md) | The maximum size in bytes of per read of a batch of operations pulled from the remote cluster. | +| `max_retry_delay` | [Duration](./Duration.md) | The maximum time to wait before retrying an operation that failed exceptionally. An exponential backoff strategy is employed when retrying. | +| `max_write_buffer_count` | [integer](./integer.md) | The maximum number of operations that can be queued for writing. When this limit is reached, reads from the remote cluster will be deferred until the number of queued operations goes below the limit. | +| `max_write_buffer_size` | [ByteSize](./ByteSize.md) | The maximum total bytes of operations that can be queued for writing. When this limit is reached, reads from the remote cluster will be deferred until the total bytes of queued operations goes below the limit. | +| `max_write_request_operation_count` | [integer](./integer.md) | The maximum number of operations per bulk write request executed on the follower. | +| `max_write_request_size` | [ByteSize](./ByteSize.md) | The maximum total bytes of operations per bulk write request executed on the follower. | +| `name` | [Name](./Name.md) | The name of the collection of auto-follow patterns. | +| `querystring` | { [key: string]: any; } & { name?: never; master_timeout?: never; remote_cluster?: never; follow_index_pattern?: never; leader_index_patterns?: never; leader_index_exclusion_patterns?: never; max_outstanding_read_requests?: never; settings?: never; max_outstanding_write_requests?: never; read_poll_timeout?: never; max_read_request_operation_count?: never; max_read_request_size?: never; max_retry_delay?: never; max_write_buffer_count?: never; max_write_buffer_size?: never; max_write_request_operation_count?: never; max_write_request_size?: never; } | All values in `querystring` will be added to the request querystring. | +| `read_poll_timeout` | [Duration](./Duration.md) | The maximum time to wait for new operations on the remote cluster when the follower index is synchronized with the leader index. When the timeout has elapsed, the poll for operations will return to the follower so that it can update some statistics. Then the follower will immediately attempt to read from the leader again. | +| `remote_cluster` | string | The remote cluster containing the leader indices to match against. | +| `settings` | Record | Settings to override from the leader index. Note that certain settings can not be overrode (e.g., index.number_of_shards). | diff --git a/docs/reference/api/CcrPutAutoFollowPatternResponse.md b/docs/reference/api/CcrPutAutoFollowPatternResponse.md new file mode 100644 index 000000000..aec5d57c1 --- /dev/null +++ b/docs/reference/api/CcrPutAutoFollowPatternResponse.md @@ -0,0 +1,4 @@ +## `CcrPutAutoFollowPatternResponse` +::: +type CcrPutAutoFollowPatternResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); +::: diff --git a/docs/reference/api/CcrReadException.md b/docs/reference/api/CcrReadException.md new file mode 100644 index 000000000..a2dbcb67e --- /dev/null +++ b/docs/reference/api/CcrReadException.md @@ -0,0 +1,7 @@ +## Interface `CcrReadException` + +| Name | Type | Description | +| - | - | - | +| `exception` | [ErrorCause](./ErrorCause.md) | The exception that caused the read to fail. | +| `from_seq_no` | [SequenceNumber](./SequenceNumber.md) | The starting sequence number of the batch requested from the leader. | +| `retries` | [integer](./integer.md) | The number of times the batch has been retried. | diff --git a/docs/reference/api/CcrResumeAutoFollowPatternRequest.md b/docs/reference/api/CcrResumeAutoFollowPatternRequest.md new file mode 100644 index 000000000..cbc188d68 --- /dev/null +++ b/docs/reference/api/CcrResumeAutoFollowPatternRequest.md @@ -0,0 +1,8 @@ +## Interface `CcrResumeAutoFollowPatternRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { name?: never; master_timeout?: never; }) | All values in `body` will be added to the request body. | +| `master_timeout` | [Duration](./Duration.md) | The period to wait for a connection to the master node. If the master node is not available before the timeout expires, the request fails and returns an error. It can also be set to `-1` to indicate that the request should never timeout. | +| `name` | [Name](./Name.md) | The name of the auto-follow pattern to resume. | +| `querystring` | { [key: string]: any; } & { name?: never; master_timeout?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/CcrResumeAutoFollowPatternResponse.md b/docs/reference/api/CcrResumeAutoFollowPatternResponse.md new file mode 100644 index 000000000..ef43ef10b --- /dev/null +++ b/docs/reference/api/CcrResumeAutoFollowPatternResponse.md @@ -0,0 +1,4 @@ +## `CcrResumeAutoFollowPatternResponse` +::: +type CcrResumeAutoFollowPatternResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); +::: diff --git a/docs/reference/api/CcrResumeFollowRequest.md b/docs/reference/api/CcrResumeFollowRequest.md new file mode 100644 index 000000000..0c585944d --- /dev/null +++ b/docs/reference/api/CcrResumeFollowRequest.md @@ -0,0 +1,18 @@ +## Interface `CcrResumeFollowRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { index?: never; master_timeout?: never; max_outstanding_read_requests?: never; max_outstanding_write_requests?: never; max_read_request_operation_count?: never; max_read_request_size?: never; max_retry_delay?: never; max_write_buffer_count?: never; max_write_buffer_size?: never; max_write_request_operation_count?: never; max_write_request_size?: never; read_poll_timeout?: never; }) | All values in `body` will be added to the request body. | +| `index` | [IndexName](./IndexName.md) | The name of the follow index to resume following. | +| `master_timeout` | [Duration](./Duration.md) | Period to wait for a connection to the master node. | +| `max_outstanding_read_requests` | [long](./long.md) |   | +| `max_outstanding_write_requests` | [long](./long.md) |   | +| `max_read_request_operation_count` | [long](./long.md) |   | +| `max_read_request_size` | string |   | +| `max_retry_delay` | [Duration](./Duration.md) |   | +| `max_write_buffer_count` | [long](./long.md) |   | +| `max_write_buffer_size` | string |   | +| `max_write_request_operation_count` | [long](./long.md) |   | +| `max_write_request_size` | string |   | +| `querystring` | { [key: string]: any; } & { index?: never; master_timeout?: never; max_outstanding_read_requests?: never; max_outstanding_write_requests?: never; max_read_request_operation_count?: never; max_read_request_size?: never; max_retry_delay?: never; max_write_buffer_count?: never; max_write_buffer_size?: never; max_write_request_operation_count?: never; max_write_request_size?: never; read_poll_timeout?: never; } | All values in `querystring` will be added to the request querystring. | +| `read_poll_timeout` | [Duration](./Duration.md) |   | diff --git a/docs/reference/api/CcrResumeFollowResponse.md b/docs/reference/api/CcrResumeFollowResponse.md new file mode 100644 index 000000000..ecf383d62 --- /dev/null +++ b/docs/reference/api/CcrResumeFollowResponse.md @@ -0,0 +1,4 @@ +## `CcrResumeFollowResponse` +::: +type CcrResumeFollowResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); +::: diff --git a/docs/reference/api/CcrShardStats.md b/docs/reference/api/CcrShardStats.md new file mode 100644 index 000000000..418abc915 --- /dev/null +++ b/docs/reference/api/CcrShardStats.md @@ -0,0 +1,37 @@ +## Interface `CcrShardStats` + +| Name | Type | Description | +| - | - | - | +| `bytes_read` | [long](./long.md) | The total of transferred bytes read from the leader. This is only an estimate and does not account for compression if enabled. | +| `failed_read_requests` | [long](./long.md) | The number of failed reads. | +| `failed_write_requests` | [long](./long.md) | The number of failed bulk write requests on the follower. | +| `fatal_exception` | [ErrorCause](./ErrorCause.md) |   | +| `follower_aliases_version` | [VersionNumber](./VersionNumber.md) | The index aliases version the follower is synced up to. | +| `follower_global_checkpoint` | [long](./long.md) | The current global checkpoint on the follower. The difference between the `leader_global_checkpoint` and the `follower_global_checkpoint` is an indication of how much the follower is lagging the leader. | +| `follower_index` | string | The name of the follower index. | +| `follower_mapping_version` | [VersionNumber](./VersionNumber.md) | The mapping version the follower is synced up to. | +| `follower_max_seq_no` | [SequenceNumber](./SequenceNumber.md) | The current maximum sequence number on the follower. | +| `follower_settings_version` | [VersionNumber](./VersionNumber.md) | The index settings version the follower is synced up to. | +| `last_requested_seq_no` | [SequenceNumber](./SequenceNumber.md) | The starting sequence number of the last batch of operations requested from the leader. | +| `leader_global_checkpoint` | [long](./long.md) | The current global checkpoint on the leader known to the follower task. | +| `leader_index` | string | The name of the index in the leader cluster being followed. | +| `leader_max_seq_no` | [SequenceNumber](./SequenceNumber.md) | The current maximum sequence number on the leader known to the follower task. | +| `operations_read` | [long](./long.md) | The total number of operations read from the leader. | +| `operations_written` | [long](./long.md) | The number of operations written on the follower. | +| `outstanding_read_requests` | [integer](./integer.md) | The number of active read requests from the follower. | +| `outstanding_write_requests` | [integer](./integer.md) | The number of active bulk write requests on the follower. | +| `read_exceptions` | [CcrReadException](./CcrReadException.md)[] | An array of objects representing failed reads. | +| `remote_cluster` | string | The remote cluster containing the leader index. | +| `shard_id` | [integer](./integer.md) | The numerical shard ID, with values from 0 to one less than the number of replicas. | +| `successful_read_requests` | [long](./long.md) | The number of successful fetches. | +| `successful_write_requests` | [long](./long.md) | The number of bulk write requests run on the follower. | +| `time_since_last_read_millis` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> | The number of milliseconds since a read request was sent to the leader. When the follower is caught up to the leader, this number will increase up to the configured `read_poll_timeout` at which point another read request will be sent to the leader. | +| `time_since_last_read` | [Duration](./Duration.md) |   | +| `total_read_remote_exec_time_millis` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> | The total time reads spent running on the remote cluster. | +| `total_read_remote_exec_time` | [Duration](./Duration.md) |   | +| `total_read_time_millis` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> | The total time reads were outstanding, measured from the time a read was sent to the leader to the time a reply was returned to the follower. | +| `total_read_time` | [Duration](./Duration.md) |   | +| `total_write_time_millis` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> | The total time spent writing on the follower. | +| `total_write_time` | [Duration](./Duration.md) |   | +| `write_buffer_operation_count` | [long](./long.md) | The number of write operations queued on the follower. | +| `write_buffer_size_in_bytes` | [ByteSize](./ByteSize.md) | The total number of bytes of operations currently queued for writing. | diff --git a/docs/reference/api/CcrStatsAutoFollowStats.md b/docs/reference/api/CcrStatsAutoFollowStats.md new file mode 100644 index 000000000..3b3edd3d4 --- /dev/null +++ b/docs/reference/api/CcrStatsAutoFollowStats.md @@ -0,0 +1,9 @@ +## Interface `CcrStatsAutoFollowStats` + +| Name | Type | Description | +| - | - | - | +| `auto_followed_clusters` | [CcrStatsAutoFollowedCluster](./CcrStatsAutoFollowedCluster.md)[] |   | +| `number_of_failed_follow_indices` | [long](./long.md) | The number of indices that the auto-follow coordinator failed to automatically follow. The causes of recent failures are captured in the logs of the elected master node and in the `auto_follow_stats.recent_auto_follow_errors` field. | +| `number_of_failed_remote_cluster_state_requests` | [long](./long.md) | The number of times that the auto-follow coordinator failed to retrieve the cluster state from a remote cluster registered in a collection of auto-follow patterns. | +| `number_of_successful_follow_indices` | [long](./long.md) | The number of indices that the auto-follow coordinator successfully followed. | +| `recent_auto_follow_errors` | [ErrorCause](./ErrorCause.md)[] | An array of objects representing failures by the auto-follow coordinator. | diff --git a/docs/reference/api/CcrStatsAutoFollowedCluster.md b/docs/reference/api/CcrStatsAutoFollowedCluster.md new file mode 100644 index 000000000..be41e7896 --- /dev/null +++ b/docs/reference/api/CcrStatsAutoFollowedCluster.md @@ -0,0 +1,7 @@ +## Interface `CcrStatsAutoFollowedCluster` + +| Name | Type | Description | +| - | - | - | +| `cluster_name` | [Name](./Name.md) |   | +| `last_seen_metadata_version` | [VersionNumber](./VersionNumber.md) |   | +| `time_since_last_check_millis` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> |   | diff --git a/docs/reference/api/CcrStatsFollowStats.md b/docs/reference/api/CcrStatsFollowStats.md new file mode 100644 index 000000000..d1f679f59 --- /dev/null +++ b/docs/reference/api/CcrStatsFollowStats.md @@ -0,0 +1,5 @@ +## Interface `CcrStatsFollowStats` + +| Name | Type | Description | +| - | - | - | +| `indices` | [CcrFollowIndexStats](./CcrFollowIndexStats.md)[] |   | diff --git a/docs/reference/api/CcrStatsRequest.md b/docs/reference/api/CcrStatsRequest.md new file mode 100644 index 000000000..706646421 --- /dev/null +++ b/docs/reference/api/CcrStatsRequest.md @@ -0,0 +1,8 @@ +## Interface `CcrStatsRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { master_timeout?: never; timeout?: never; }) | All values in `body` will be added to the request body. | +| `master_timeout` | [Duration](./Duration.md) | The period to wait for a connection to the master node. If the master node is not available before the timeout expires, the request fails and returns an error. It can also be set to `-1` to indicate that the request should never timeout. | +| `querystring` | { [key: string]: any; } & { master_timeout?: never; timeout?: never; } | All values in `querystring` will be added to the request querystring. | +| `timeout` | [Duration](./Duration.md) | The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. | diff --git a/docs/reference/api/CcrStatsResponse.md b/docs/reference/api/CcrStatsResponse.md new file mode 100644 index 000000000..476dd1e52 --- /dev/null +++ b/docs/reference/api/CcrStatsResponse.md @@ -0,0 +1,6 @@ +## Interface `CcrStatsResponse` + +| Name | Type | Description | +| - | - | - | +| `auto_follow_stats` | [CcrStatsAutoFollowStats](./CcrStatsAutoFollowStats.md) | Statistics for the auto-follow coordinator. | +| `follow_stats` | [CcrStatsFollowStats](./CcrStatsFollowStats.md) | Shard-level statistics for follower indices. | diff --git a/docs/reference/api/CcrUnfollowRequest.md b/docs/reference/api/CcrUnfollowRequest.md new file mode 100644 index 000000000..5be7d33e3 --- /dev/null +++ b/docs/reference/api/CcrUnfollowRequest.md @@ -0,0 +1,8 @@ +## Interface `CcrUnfollowRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { index?: never; master_timeout?: never; }) | All values in `body` will be added to the request body. | +| `index` | [IndexName](./IndexName.md) | The name of the follower index. | +| `master_timeout` | [Duration](./Duration.md) | The period to wait for a connection to the master node. If the master node is not available before the timeout expires, the request fails and returns an error. It can also be set to `-1` to indicate that the request should never timeout. | +| `querystring` | { [key: string]: any; } & { index?: never; master_timeout?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/CcrUnfollowResponse.md b/docs/reference/api/CcrUnfollowResponse.md new file mode 100644 index 000000000..e60546901 --- /dev/null +++ b/docs/reference/api/CcrUnfollowResponse.md @@ -0,0 +1,4 @@ +## `CcrUnfollowResponse` +::: +type CcrUnfollowResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); +::: diff --git a/docs/reference/api/ClearScrollApi_1.md b/docs/reference/api/ClearScrollApi_1.md new file mode 100644 index 000000000..984acb6a4 --- /dev/null +++ b/docs/reference/api/ClearScrollApi_1.md @@ -0,0 +1,3 @@ +::: +default function ClearScrollApi(this: [That](./That.md), params?: [ClearScrollRequest](./ClearScrollRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ClearScrollResponse](./ClearScrollResponse.md)>; +::: diff --git a/docs/reference/api/ClearScrollApi_2.md b/docs/reference/api/ClearScrollApi_2.md new file mode 100644 index 000000000..7cbd44737 --- /dev/null +++ b/docs/reference/api/ClearScrollApi_2.md @@ -0,0 +1,3 @@ +::: +default function ClearScrollApi(this: [That](./That.md), params?: [ClearScrollRequest](./ClearScrollRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ClearScrollResponse](./ClearScrollResponse.md), unknown>>; +::: diff --git a/docs/reference/api/ClearScrollApi_3.md b/docs/reference/api/ClearScrollApi_3.md new file mode 100644 index 000000000..c5b636ea4 --- /dev/null +++ b/docs/reference/api/ClearScrollApi_3.md @@ -0,0 +1,3 @@ +::: +default function ClearScrollApi(this: [That](./That.md), params?: [ClearScrollRequest](./ClearScrollRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ClearScrollResponse](./ClearScrollResponse.md)>; +::: diff --git a/docs/reference/api/ClearScrollRequest.md b/docs/reference/api/ClearScrollRequest.md new file mode 100644 index 000000000..5304c32a4 --- /dev/null +++ b/docs/reference/api/ClearScrollRequest.md @@ -0,0 +1,7 @@ +## Interface `ClearScrollRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { scroll_id?: never; }) | All values in `body` will be added to the request body. | +| `querystring` | { [key: string]: any; } & { scroll_id?: never; } | All values in `querystring` will be added to the request querystring. | +| `scroll_id` | [ScrollIds](./ScrollIds.md) | A comma-separated list of scroll IDs to clear. To clear all scroll IDs, use `_all`. IMPORTANT: Scroll IDs can be long. It is recommended to specify scroll IDs in the request body parameter. | diff --git a/docs/reference/api/ClearScrollResponse.md b/docs/reference/api/ClearScrollResponse.md new file mode 100644 index 000000000..6783b517f --- /dev/null +++ b/docs/reference/api/ClearScrollResponse.md @@ -0,0 +1,6 @@ +## Interface `ClearScrollResponse` + +| Name | Type | Description | +| - | - | - | +| `num_freed` | [integer](./integer.md) | The number of scrolling search requests cleared. | +| `succeeded` | boolean | If `true`, the request succeeded. This does not indicate whether any scrolling search requests were cleared. | diff --git a/docs/reference/api/Client.md b/docs/reference/api/Client.md new file mode 100644 index 000000000..a638a6855 --- /dev/null +++ b/docs/reference/api/Client.md @@ -0,0 +1,24 @@ +## `Client` + +### Constructor + +::: +new Client(opts: [ClientOptions](./ClientOptions.md)); +::: + +### Properties + +| Name | Type | Description | +| - | - | - | +| `connectionPool` | [BaseConnectionPool](./BaseConnectionPool.md) |   | +| `diagnostic` | [Diagnostic](./Diagnostic.md) |   | +| `helpers` | [Helpers](./Helpers.md) |   | +| `name` | string | symbol |   | +| `serializer` | [Serializer](./Serializer.md) |   | +| `transport` | [SniffingTransport](./SniffingTransport.md) |   | + +### Methods + +| Name | Signature | Description | +| - | - | - | +| `child` | `child(opts: [ClientOptions](./ClientOptions.md)): [Client](./Client.md);` | Creates a child client instance that shared its connection pool with the parent client || `close` | `close(): Promise;` | Closes all connections in the connection pool. Connections shared with any parent or child instances will also be closed. | diff --git a/docs/reference/api/ClientOptions.md b/docs/reference/api/ClientOptions.md new file mode 100644 index 000000000..487f54f8e --- /dev/null +++ b/docs/reference/api/ClientOptions.md @@ -0,0 +1,102 @@ +## Interface `ClientOptions` + +| Name | Type | Description | +| - | - | - | +| `agent` | [HttpAgentOptions](./HttpAgentOptions.md) | [UndiciAgentOptions](./UndiciAgentOptions.md) | [agentFn](./agentFn.md) | false | agent Custom HTTP agent options + +Default value: null | +| `auth` | [BasicAuth](./BasicAuth.md) | [ApiKeyAuth](./ApiKeyAuth.md) | [BearerAuth](./BearerAuth.md) | auth Authentication options for this Elasticsearch cluster + +Default value: null | +| `caFingerprint` | string | caFingerprint If configured, verifies that the fingerprint of the CA certificate that has signed the certificate of the server matches the supplied fingerprint; only accepts SHA256 digest fingerprints + +Default value: null | +| `cloud` | { id: string; } | cloud Custom configuration for connecting to Elastic Cloud, in lieu of a `node` or `nodes` configuration + +Default value: null | +| `compression` | boolean | compression Enables gzip request body compression + +Default value: `true` if connecting to Elastic Cloud, otherwise `false`. | +| `Connection` | typeof [BaseConnection](./BaseConnection.md) | Connection HTTP connection class to use + +Default value: `UndiciConnection` | +| `ConnectionPool` | typeof [BaseConnectionPool](./BaseConnectionPool.md) | ConnectionPool HTTP connection pool class to use + +Default value: `CloudConnectionPool`, if connecting to Elastic Cloud, otherwise `WeightedConnectionPool` | +| `context` | [Context](./Context.md) | context A custom object attached to each request that can be used to pass data to client events + +Default value: null | +| `disablePrototypePoisoningProtection` | boolean | 'proto' | 'constructor' | disablePrototypePoisoningProtection Disables safe JSON parsing that protects execution of prototype poisoning attacks; disabled by default, as it can introduce a performance penalty + +Default value: true | +| `enableMetaHeader` | boolean | enableMetaHeader If true, adds an header named `x-elastic-client-meta`, containing a small amount of high-level telemetry data, such as the client and platform version + +Default value: true | +| `generateRequestId` | [generateRequestIdFn](./generateRequestIdFn.md) | generateRequestId A custom function for generating unique IDs for each request, to make it easier to associate each API request to a single response + +Default value: A function that increments a number counter starting from 1 | +| `headers` | Record | headers Custom HTTP headers that should be sent with each request + +Default value: An object with a custom `user-agent` header | +| `maxCompressedResponseSize` | number | maxCompressedResponseSize When configured, verifies that the compressed response size is lower than the configured number. If it's higher, it will abort the request. It cannot be higher than `buffer.constants.MAX_LENGTH` + +Default value: null | +| `maxResponseSize` | number | maxResponseSize When configured, verifies that the uncompressed response size is lower than the configured number. If it's higher, it will abort the request. It cannot be higher than `buffer.constants.MAX_STRING_LENGTH` + +Default value: null | +| `maxRetries` | number | maxRetries Max number of retries for each request + +Default value: 3 | +| `name` | string | symbol | name A name for this client + +Default value: 'elasticsearch-js' | +| `node` | string | string[] | [NodeOptions](./NodeOptions.md) | [NodeOptions](./NodeOptions.md)[] | node Elasticsearch node settings, if there is only one node. Required if `nodes` or `cloud` is not set. | +| `nodeFilter` | [nodeFilterFn](./nodeFilterFn.md) | nodeFilter A custom function used by the connection pool to determine which nodes are qualified to receive a request + +Default value: A function that uses the Connection `roles` property to avoid master-only nodes | +| `nodes` | string | string[] | [NodeOptions](./NodeOptions.md) | [NodeOptions](./NodeOptions.md)[] | nodes Elasticsearch node settings, if there are multiple nodes. Required if `node` or `cloud` is not set. | +| `nodeSelector` | [nodeSelectorFn](./nodeSelectorFn.md) | nodeSelector A custom function used by the connection pool to determine which node should receive the next request + +Default value: A "round robin" function that loops sequentially through each node in the pool. | +| `opaqueIdPrefix` | string | opaqueIdPrefix A string prefix to apply to every generated X-Opaque-Id header + +Default value: null | +| `pingTimeout` | number | pingTimeout Max number of milliseconds a `ClusterConnectionPool` will wait when pinging nodes before marking them dead + +Default value: 3000 | +| `proxy` | string | URL | proxy A proxy URL that, when provided, the client will automatically send all requests through + +Default value: null | +| `redaction` | [RedactionOptions](./RedactionOptions.md) | redaction Options for how to redact potentially sensitive data from metadata attached to `Error` objects + +Default value: Configuration that will replace known sources of sensitive data | +| `requestTimeout` | number | requestTimeout Max request timeout in milliseconds for each request + +Default value: No timeout | +| `resurrectStrategy` | 'ping' | 'optimistic' | 'none' | resurrectStrategy Strategy for resurrecting dead nodes when using `ClusterConnectionPool`. 'ping' will issue a test request to a node and resurrect it if it responds. 'optimistic' marks a node as alive without testing it. 'none ` will never attempt to revive a dead connection. + +Default value: 'ping' | +| `Serializer` | typeof [Serializer](./Serializer.md) | Serializer Serialization class to use + +Default value: `Serializer` | +| `serverMode` | 'stack' | 'serverless' | serverMode Setting to "serverless" will change some default behavior, like enabling compression and disabling features that assume the possibility of multiple Elasticsearch nodes. + +Default value: "stack", which sets defaults for a traditional (non-serverless) Elasticsearch instance. | +| `sniffEndpoint` | string | sniffEndpoint Endpoint to ping during a sniff + +Default value: "_nodes/_all/http" | +| `sniffInterval` | number | boolean | sniffInterval Perform a sniff operation every `n` milliseconds + +Default value: false | +| `sniffOnConnectionFault` | boolean | sniffOnConnectionFault Perform a sniff on connection fault + +Default value: false | +| `sniffOnStart` | boolean | sniffOnStart Perform a sniff once the client is started + +Default value: false | +| `tls` | [TlsConnectionOptions](./TlsConnectionOptions.md) | tls [TLS configuraton](https://nodejs.org/api/tls.html) + +Default value: null | +| `Transport` | typeof [Transport](./Transport.md) | Transport Elastic transport class to use + +Default value: `Transport` | diff --git a/docs/reference/api/ClosePointInTimeApi_1.md b/docs/reference/api/ClosePointInTimeApi_1.md new file mode 100644 index 000000000..8b03ccc60 --- /dev/null +++ b/docs/reference/api/ClosePointInTimeApi_1.md @@ -0,0 +1,3 @@ +::: +default function ClosePointInTimeApi(this: [That](./That.md), params: [ClosePointInTimeRequest](./ClosePointInTimeRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ClosePointInTimeResponse](./ClosePointInTimeResponse.md)>; +::: diff --git a/docs/reference/api/ClosePointInTimeApi_2.md b/docs/reference/api/ClosePointInTimeApi_2.md new file mode 100644 index 000000000..6e25c35eb --- /dev/null +++ b/docs/reference/api/ClosePointInTimeApi_2.md @@ -0,0 +1,3 @@ +::: +default function ClosePointInTimeApi(this: [That](./That.md), params: [ClosePointInTimeRequest](./ClosePointInTimeRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ClosePointInTimeResponse](./ClosePointInTimeResponse.md), unknown>>; +::: diff --git a/docs/reference/api/ClosePointInTimeApi_3.md b/docs/reference/api/ClosePointInTimeApi_3.md new file mode 100644 index 000000000..aeecba84a --- /dev/null +++ b/docs/reference/api/ClosePointInTimeApi_3.md @@ -0,0 +1,3 @@ +::: +default function ClosePointInTimeApi(this: [That](./That.md), params: [ClosePointInTimeRequest](./ClosePointInTimeRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ClosePointInTimeResponse](./ClosePointInTimeResponse.md)>; +::: diff --git a/docs/reference/api/ClosePointInTimeRequest.md b/docs/reference/api/ClosePointInTimeRequest.md new file mode 100644 index 000000000..08bc21615 --- /dev/null +++ b/docs/reference/api/ClosePointInTimeRequest.md @@ -0,0 +1,7 @@ +## Interface `ClosePointInTimeRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { id?: never; }) | All values in `body` will be added to the request body. | +| `id` | [Id](./Id.md) | The ID of the point-in-time. | +| `querystring` | { [key: string]: any; } & { id?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/ClosePointInTimeResponse.md b/docs/reference/api/ClosePointInTimeResponse.md new file mode 100644 index 000000000..fc4c43403 --- /dev/null +++ b/docs/reference/api/ClosePointInTimeResponse.md @@ -0,0 +1,6 @@ +## Interface `ClosePointInTimeResponse` + +| Name | Type | Description | +| - | - | - | +| `num_freed` | [integer](./integer.md) | The number of search contexts that were successfully closed. | +| `succeeded` | boolean | If `true`, all search contexts associated with the point-in-time ID were successfully closed. | diff --git a/docs/reference/api/Cluster.md b/docs/reference/api/Cluster.md new file mode 100644 index 000000000..486626c6a --- /dev/null +++ b/docs/reference/api/Cluster.md @@ -0,0 +1,20 @@ +## `Cluster` + +### Constructor + +::: +new Cluster(transport: [Transport](./Transport.md)); +::: + +### Properties + +| Name | Type | Description | +| - | - | - | +| `acceptedParams` | Record |   | +| `transport` | [Transport](./Transport.md) |   | + +### Methods + +| Name | Signature | Description | +| - | - | - | +| `allocationExplain` | `allocationExplain(this: [That](./That.md), params?: [ClusterAllocationExplainRequest](./ClusterAllocationExplainRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ClusterAllocationExplainResponse](./ClusterAllocationExplainResponse.md)>;` | Explain the shard allocations. Get explanations for shard allocations in the cluster. For unassigned shards, it provides an explanation for why the shard is unassigned. For assigned shards, it provides an explanation for why the shard is remaining on its current node and has not moved or rebalanced to another node. This API can be very useful when attempting to diagnose why a shard is unassigned or why a shard continues to remain on its current node when you might expect otherwise. || `allocationExplain` | `allocationExplain(this: [That](./That.md), params?: [ClusterAllocationExplainRequest](./ClusterAllocationExplainRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ClusterAllocationExplainResponse](./ClusterAllocationExplainResponse.md), unknown>>;` |   || `allocationExplain` | `allocationExplain(this: [That](./That.md), params?: [ClusterAllocationExplainRequest](./ClusterAllocationExplainRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ClusterAllocationExplainResponse](./ClusterAllocationExplainResponse.md)>;` |   || `deleteComponentTemplate` | `deleteComponentTemplate(this: [That](./That.md), params: [ClusterDeleteComponentTemplateRequest](./ClusterDeleteComponentTemplateRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ClusterDeleteComponentTemplateResponse](./ClusterDeleteComponentTemplateResponse.md)>;` | Delete component templates. Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. || `deleteComponentTemplate` | `deleteComponentTemplate(this: [That](./That.md), params: [ClusterDeleteComponentTemplateRequest](./ClusterDeleteComponentTemplateRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ClusterDeleteComponentTemplateResponse](./ClusterDeleteComponentTemplateResponse.md), unknown>>;` |   || `deleteComponentTemplate` | `deleteComponentTemplate(this: [That](./That.md), params: [ClusterDeleteComponentTemplateRequest](./ClusterDeleteComponentTemplateRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ClusterDeleteComponentTemplateResponse](./ClusterDeleteComponentTemplateResponse.md)>;` |   || `deleteVotingConfigExclusions` | `deleteVotingConfigExclusions(this: [That](./That.md), params?: [ClusterDeleteVotingConfigExclusionsRequest](./ClusterDeleteVotingConfigExclusionsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ClusterDeleteVotingConfigExclusionsResponse](./ClusterDeleteVotingConfigExclusionsResponse.md)>;` | Clear cluster voting config exclusions. Remove master-eligible nodes from the voting configuration exclusion list. || `deleteVotingConfigExclusions` | `deleteVotingConfigExclusions(this: [That](./That.md), params?: [ClusterDeleteVotingConfigExclusionsRequest](./ClusterDeleteVotingConfigExclusionsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ClusterDeleteVotingConfigExclusionsResponse](./ClusterDeleteVotingConfigExclusionsResponse.md), unknown>>;` |   || `deleteVotingConfigExclusions` | `deleteVotingConfigExclusions(this: [That](./That.md), params?: [ClusterDeleteVotingConfigExclusionsRequest](./ClusterDeleteVotingConfigExclusionsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ClusterDeleteVotingConfigExclusionsResponse](./ClusterDeleteVotingConfigExclusionsResponse.md)>;` |   || `existsComponentTemplate` | `existsComponentTemplate(this: [That](./That.md), params: [ClusterExistsComponentTemplateRequest](./ClusterExistsComponentTemplateRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ClusterExistsComponentTemplateResponse](./ClusterExistsComponentTemplateResponse.md)>;` | Check component templates. Returns information about whether a particular component template exists. || `existsComponentTemplate` | `existsComponentTemplate(this: [That](./That.md), params: [ClusterExistsComponentTemplateRequest](./ClusterExistsComponentTemplateRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ClusterExistsComponentTemplateResponse](./ClusterExistsComponentTemplateResponse.md), unknown>>;` |   || `existsComponentTemplate` | `existsComponentTemplate(this: [That](./That.md), params: [ClusterExistsComponentTemplateRequest](./ClusterExistsComponentTemplateRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ClusterExistsComponentTemplateResponse](./ClusterExistsComponentTemplateResponse.md)>;` |   || `getComponentTemplate` | `getComponentTemplate(this: [That](./That.md), params?: [ClusterGetComponentTemplateRequest](./ClusterGetComponentTemplateRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ClusterGetComponentTemplateResponse](./ClusterGetComponentTemplateResponse.md)>;` | Get component templates. Get information about component templates. || `getComponentTemplate` | `getComponentTemplate(this: [That](./That.md), params?: [ClusterGetComponentTemplateRequest](./ClusterGetComponentTemplateRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ClusterGetComponentTemplateResponse](./ClusterGetComponentTemplateResponse.md), unknown>>;` |   || `getComponentTemplate` | `getComponentTemplate(this: [That](./That.md), params?: [ClusterGetComponentTemplateRequest](./ClusterGetComponentTemplateRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ClusterGetComponentTemplateResponse](./ClusterGetComponentTemplateResponse.md)>;` |   || `getSettings` | `getSettings(this: [That](./That.md), params?: [ClusterGetSettingsRequest](./ClusterGetSettingsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ClusterGetSettingsResponse](./ClusterGetSettingsResponse.md)>;` | Get cluster-wide settings. By default, it returns only settings that have been explicitly defined. || `getSettings` | `getSettings(this: [That](./That.md), params?: [ClusterGetSettingsRequest](./ClusterGetSettingsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ClusterGetSettingsResponse](./ClusterGetSettingsResponse.md), unknown>>;` |   || `getSettings` | `getSettings(this: [That](./That.md), params?: [ClusterGetSettingsRequest](./ClusterGetSettingsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ClusterGetSettingsResponse](./ClusterGetSettingsResponse.md)>;` |   || `health` | `health(this: [That](./That.md), params?: [ClusterHealthRequest](./ClusterHealthRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ClusterHealthResponse](./ClusterHealthResponse.md)>;` | Get the cluster health status. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices. The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster. Yellow means that the primary shard is allocated but replicas are not. Green means that all shards are allocated. The index level status is controlled by the worst shard status. One of the main benefits of the API is the ability to wait until the cluster reaches a certain high watermark health level. The cluster status is controlled by the worst index status. || `health` | `health(this: [That](./That.md), params?: [ClusterHealthRequest](./ClusterHealthRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ClusterHealthResponse](./ClusterHealthResponse.md), unknown>>;` |   || `health` | `health(this: [That](./That.md), params?: [ClusterHealthRequest](./ClusterHealthRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ClusterHealthResponse](./ClusterHealthResponse.md)>;` |   || `info` | `info(this: [That](./That.md), params: [ClusterInfoRequest](./ClusterInfoRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ClusterInfoResponse](./ClusterInfoResponse.md)>;` | Get cluster info. Returns basic information about the cluster. || `info` | `info(this: [That](./That.md), params: [ClusterInfoRequest](./ClusterInfoRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ClusterInfoResponse](./ClusterInfoResponse.md), unknown>>;` |   || `info` | `info(this: [That](./That.md), params: [ClusterInfoRequest](./ClusterInfoRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ClusterInfoResponse](./ClusterInfoResponse.md)>;` |   || `pendingTasks` | `pendingTasks(this: [That](./That.md), params?: [ClusterPendingTasksRequest](./ClusterPendingTasksRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ClusterPendingTasksResponse](./ClusterPendingTasksResponse.md)>;` | Get the pending cluster tasks. Get information about cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet taken effect. NOTE: This API returns a list of any pending updates to the cluster state. These are distinct from the tasks reported by the task management API which include periodic tasks and tasks initiated by the user, such as node stats, search queries, or create index requests. However, if a user-initiated task such as a create index command causes a cluster state update, the activity of this task might be reported by both task api and pending cluster tasks API. || `pendingTasks` | `pendingTasks(this: [That](./That.md), params?: [ClusterPendingTasksRequest](./ClusterPendingTasksRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ClusterPendingTasksResponse](./ClusterPendingTasksResponse.md), unknown>>;` |   || `pendingTasks` | `pendingTasks(this: [That](./That.md), params?: [ClusterPendingTasksRequest](./ClusterPendingTasksRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ClusterPendingTasksResponse](./ClusterPendingTasksResponse.md)>;` |   || `postVotingConfigExclusions` | `postVotingConfigExclusions(this: [That](./That.md), params?: [ClusterPostVotingConfigExclusionsRequest](./ClusterPostVotingConfigExclusionsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ClusterPostVotingConfigExclusionsResponse](./ClusterPostVotingConfigExclusionsResponse.md)>;` | Update voting configuration exclusions. Update the cluster voting config exclusions by node IDs or node names. By default, if there are more than three master-eligible nodes in the cluster and you remove fewer than half of the master-eligible nodes in the cluster at once, the voting configuration automatically shrinks. If you want to shrink the voting configuration to contain fewer than three nodes or to remove half or more of the master-eligible nodes in the cluster at once, use this API to remove departing nodes from the voting configuration manually. The API adds an entry for each specified node to the cluster’s voting configuration exclusions list. It then waits until the cluster has reconfigured its voting configuration to exclude the specified nodes. Clusters should have no voting configuration exclusions in normal operation. Once the excluded nodes have stopped, clear the voting configuration exclusions with `DELETE /_cluster/voting_config_exclusions`. This API waits for the nodes to be fully removed from the cluster before it returns. If your cluster has voting configuration exclusions for nodes that you no longer intend to remove, use `DELETE /_cluster/voting_config_exclusions?wait_for_removal=false` to clear the voting configuration exclusions without waiting for the nodes to leave the cluster. A response to `POST /_cluster/voting_config_exclusions` with an HTTP status code of 200 OK guarantees that the node has been removed from the voting configuration and will not be reinstated until the voting configuration exclusions are cleared by calling `DELETE /_cluster/voting_config_exclusions`. If the call to `POST /_cluster/voting_config_exclusions` fails or returns a response with an HTTP status code other than 200 OK then the node may not have been removed from the voting configuration. In that case, you may safely retry the call. NOTE: Voting exclusions are required only when you remove at least half of the master-eligible nodes from a cluster in a short time period. They are not required when removing master-ineligible nodes or when removing fewer than half of the master-eligible nodes. || `postVotingConfigExclusions` | `postVotingConfigExclusions(this: [That](./That.md), params?: [ClusterPostVotingConfigExclusionsRequest](./ClusterPostVotingConfigExclusionsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ClusterPostVotingConfigExclusionsResponse](./ClusterPostVotingConfigExclusionsResponse.md), unknown>>;` |   || `postVotingConfigExclusions` | `postVotingConfigExclusions(this: [That](./That.md), params?: [ClusterPostVotingConfigExclusionsRequest](./ClusterPostVotingConfigExclusionsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ClusterPostVotingConfigExclusionsResponse](./ClusterPostVotingConfigExclusionsResponse.md)>;` |   || `putComponentTemplate` | `putComponentTemplate(this: [That](./That.md), params: [ClusterPutComponentTemplateRequest](./ClusterPutComponentTemplateRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ClusterPutComponentTemplateResponse](./ClusterPutComponentTemplateResponse.md)>;` | Create or update a component template. Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. An index template can be composed of multiple component templates. To use a component template, specify it in an index template’s `composed_of` list. Component templates are only applied to new data streams and indices as part of a matching index template. Settings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template. Component templates are only used during index creation. For data streams, this includes data stream creation and the creation of a stream’s backing indices. Changes to component templates do not affect existing indices, including a stream’s backing indices. You can use C-style `/* *\/` block comments in component templates. You can include comments anywhere in the request body except before the opening curly bracket. **Applying component templates** You cannot directly apply a component template to a data stream or index. To be applied, a component template must be included in an index template's `composed_of` list. || `putComponentTemplate` | `putComponentTemplate(this: [That](./That.md), params: [ClusterPutComponentTemplateRequest](./ClusterPutComponentTemplateRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ClusterPutComponentTemplateResponse](./ClusterPutComponentTemplateResponse.md), unknown>>;` |   || `putComponentTemplate` | `putComponentTemplate(this: [That](./That.md), params: [ClusterPutComponentTemplateRequest](./ClusterPutComponentTemplateRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ClusterPutComponentTemplateResponse](./ClusterPutComponentTemplateResponse.md)>;` |   || `putSettings` | `putSettings(this: [That](./That.md), params?: [ClusterPutSettingsRequest](./ClusterPutSettingsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ClusterPutSettingsResponse](./ClusterPutSettingsResponse.md)>;` | Update the cluster settings. Configure and update dynamic settings on a running cluster. You can also configure dynamic settings locally on an unstarted or shut down node in `elasticsearch.yml`. Updates made with this API can be persistent, which apply across cluster restarts, or transient, which reset after a cluster restart. You can also reset transient or persistent settings by assigning them a null value. If you configure the same setting using multiple methods, Elasticsearch applies the settings in following order of precedence: 1) Transient setting; 2) Persistent setting; 3) `elasticsearch.yml` setting; 4) Default setting value. For example, you can apply a transient setting to override a persistent setting or `elasticsearch.yml` setting. However, a change to an `elasticsearch.yml` setting will not override a defined transient or persistent setting. TIP: In Elastic Cloud, use the user settings feature to configure all cluster settings. This method automatically rejects unsafe settings that could break your cluster. If you run Elasticsearch on your own hardware, use this API to configure dynamic cluster settings. Only use `elasticsearch.yml` for static cluster settings and node settings. The API doesn’t require a restart and ensures a setting’s value is the same on all nodes. WARNING: Transient cluster settings are no longer recommended. Use persistent cluster settings instead. If a cluster becomes unstable, transient settings can clear unexpectedly, resulting in a potentially undesired cluster configuration. || `putSettings` | `putSettings(this: [That](./That.md), params?: [ClusterPutSettingsRequest](./ClusterPutSettingsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ClusterPutSettingsResponse](./ClusterPutSettingsResponse.md), unknown>>;` |   || `putSettings` | `putSettings(this: [That](./That.md), params?: [ClusterPutSettingsRequest](./ClusterPutSettingsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ClusterPutSettingsResponse](./ClusterPutSettingsResponse.md)>;` |   || `remoteInfo` | `remoteInfo(this: [That](./That.md), params?: [ClusterRemoteInfoRequest](./ClusterRemoteInfoRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ClusterRemoteInfoResponse](./ClusterRemoteInfoResponse.md)>;` | Get remote cluster information. Get information about configured remote clusters. The API returns connection and endpoint information keyed by the configured remote cluster alias. > info > This API returns information that reflects current state on the local cluster. > The `connected` field does not necessarily reflect whether a remote cluster is down or unavailable, only whether there is currently an open connection to it. > Elasticsearch does not spontaneously try to reconnect to a disconnected remote cluster. > To trigger a reconnection, attempt a cross-cluster search, ES|QL cross-cluster search, or try the [resolve cluster endpoint](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-resolve-cluster). || `remoteInfo` | `remoteInfo(this: [That](./That.md), params?: [ClusterRemoteInfoRequest](./ClusterRemoteInfoRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ClusterRemoteInfoResponse](./ClusterRemoteInfoResponse.md), unknown>>;` |   || `remoteInfo` | `remoteInfo(this: [That](./That.md), params?: [ClusterRemoteInfoRequest](./ClusterRemoteInfoRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ClusterRemoteInfoResponse](./ClusterRemoteInfoResponse.md)>;` |   || `reroute` | `reroute(this: [That](./That.md), params?: [ClusterRerouteRequest](./ClusterRerouteRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ClusterRerouteResponse](./ClusterRerouteResponse.md)>;` | Reroute the cluster. Manually change the allocation of individual shards in the cluster. For example, a shard can be moved from one node to another explicitly, an allocation can be canceled, and an unassigned shard can be explicitly allocated to a specific node. It is important to note that after processing any reroute commands Elasticsearch will perform rebalancing as normal (respecting the values of settings such as `cluster.routing.rebalance.enable`) in order to remain in a balanced state. For example, if the requested allocation includes moving a shard from node1 to node2 then this may cause a shard to be moved from node2 back to node1 to even things out. The cluster can be set to disable allocations using the `cluster.routing.allocation.enable` setting. If allocations are disabled then the only allocations that will be performed are explicit ones given using the reroute command, and consequent allocations due to rebalancing. The cluster will attempt to allocate a shard a maximum of `index.allocation.max_retries` times in a row (defaults to `5`), before giving up and leaving the shard unallocated. This scenario can be caused by structural problems such as having an analyzer which refers to a stopwords file which doesn’t exist on all nodes. Once the problem has been corrected, allocation can be manually retried by calling the reroute API with the `?retry_failed` URI query parameter, which will attempt a single retry round for these shards. || `reroute` | `reroute(this: [That](./That.md), params?: [ClusterRerouteRequest](./ClusterRerouteRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ClusterRerouteResponse](./ClusterRerouteResponse.md), unknown>>;` |   || `reroute` | `reroute(this: [That](./That.md), params?: [ClusterRerouteRequest](./ClusterRerouteRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ClusterRerouteResponse](./ClusterRerouteResponse.md)>;` |   || `state` | `state(this: [That](./That.md), params?: [ClusterStateRequest](./ClusterStateRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ClusterStateResponse](./ClusterStateResponse.md)>;` | Get the cluster state. Get comprehensive information about the state of the cluster. The cluster state is an internal data structure which keeps track of a variety of information needed by every node, including the identity and attributes of the other nodes in the cluster; cluster-wide settings; index metadata, including the mapping and settings for each index; the location and status of every shard copy in the cluster. The elected master node ensures that every node in the cluster has a copy of the same cluster state. This API lets you retrieve a representation of this internal state for debugging or diagnostic purposes. You may need to consult the Elasticsearch source code to determine the precise meaning of the response. By default the API will route requests to the elected master node since this node is the authoritative source of cluster states. You can also retrieve the cluster state held on the node handling the API request by adding the `?local=true` query parameter. Elasticsearch may need to expend significant effort to compute a response to this API in larger clusters, and the response may comprise a very large quantity of data. If you use this API repeatedly, your cluster may become unstable. WARNING: The response is a representation of an internal data structure. Its format is not subject to the same compatibility guarantees as other more stable APIs and may change from version to version. Do not query this API using external monitoring tools. Instead, obtain the information you require using other more stable cluster APIs. || `state` | `state(this: [That](./That.md), params?: [ClusterStateRequest](./ClusterStateRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ClusterStateResponse](./ClusterStateResponse.md), unknown>>;` |   || `state` | `state(this: [That](./That.md), params?: [ClusterStateRequest](./ClusterStateRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ClusterStateResponse](./ClusterStateResponse.md)>;` |   || `stats` | `stats(this: [That](./That.md), params?: [ClusterStatsRequest](./ClusterStatsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ClusterStatsResponse](./ClusterStatsResponse.md)>;` | Get cluster statistics. Get basic index metrics (shard numbers, store size, memory usage) and information about the current nodes that form the cluster (number, roles, os, jvm versions, memory usage, cpu and installed plugins). || `stats` | `stats(this: [That](./That.md), params?: [ClusterStatsRequest](./ClusterStatsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ClusterStatsResponse](./ClusterStatsResponse.md), unknown>>;` |   || `stats` | `stats(this: [That](./That.md), params?: [ClusterStatsRequest](./ClusterStatsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ClusterStatsResponse](./ClusterStatsResponse.md)>;` |   | \ No newline at end of file diff --git a/docs/reference/api/ClusterAlias.md b/docs/reference/api/ClusterAlias.md new file mode 100644 index 000000000..eabe0eb18 --- /dev/null +++ b/docs/reference/api/ClusterAlias.md @@ -0,0 +1,4 @@ +## `ClusterAlias` +::: +type ClusterAlias = string; +::: diff --git a/docs/reference/api/ClusterAllocationExplainAllocationDecision.md b/docs/reference/api/ClusterAllocationExplainAllocationDecision.md new file mode 100644 index 000000000..5b8ea01a3 --- /dev/null +++ b/docs/reference/api/ClusterAllocationExplainAllocationDecision.md @@ -0,0 +1,7 @@ +## Interface `ClusterAllocationExplainAllocationDecision` + +| Name | Type | Description | +| - | - | - | +| `decider` | string |   | +| `decision` | [ClusterAllocationExplainAllocationExplainDecision](./ClusterAllocationExplainAllocationExplainDecision.md) |   | +| `explanation` | string |   | diff --git a/docs/reference/api/ClusterAllocationExplainAllocationExplainDecision.md b/docs/reference/api/ClusterAllocationExplainAllocationExplainDecision.md new file mode 100644 index 000000000..e32f6ef8f --- /dev/null +++ b/docs/reference/api/ClusterAllocationExplainAllocationExplainDecision.md @@ -0,0 +1,4 @@ +## `ClusterAllocationExplainAllocationExplainDecision` +::: +type ClusterAllocationExplainAllocationExplainDecision = 'NO' | 'YES' | 'THROTTLE' | 'ALWAYS'; +::: diff --git a/docs/reference/api/ClusterAllocationExplainAllocationStore.md b/docs/reference/api/ClusterAllocationExplainAllocationStore.md new file mode 100644 index 000000000..823f78ba8 --- /dev/null +++ b/docs/reference/api/ClusterAllocationExplainAllocationStore.md @@ -0,0 +1,10 @@ +## Interface `ClusterAllocationExplainAllocationStore` + +| Name | Type | Description | +| - | - | - | +| `allocation_id` | string |   | +| `found` | boolean |   | +| `in_sync` | boolean |   | +| `matching_size_in_bytes` | [long](./long.md) |   | +| `matching_sync_id` | boolean |   | +| `store_exception` | string |   | diff --git a/docs/reference/api/ClusterAllocationExplainClusterInfo.md b/docs/reference/api/ClusterAllocationExplainClusterInfo.md new file mode 100644 index 000000000..a8982579c --- /dev/null +++ b/docs/reference/api/ClusterAllocationExplainClusterInfo.md @@ -0,0 +1,9 @@ +## Interface `ClusterAllocationExplainClusterInfo` + +| Name | Type | Description | +| - | - | - | +| `nodes` | Record |   | +| `reserved_sizes` | [ClusterAllocationExplainReservedSize](./ClusterAllocationExplainReservedSize.md)[] |   | +| `shard_data_set_sizes` | Record |   | +| `shard_paths` | Record |   | +| `shard_sizes` | Record |   | diff --git a/docs/reference/api/ClusterAllocationExplainCurrentNode.md b/docs/reference/api/ClusterAllocationExplainCurrentNode.md new file mode 100644 index 000000000..7604f6ec1 --- /dev/null +++ b/docs/reference/api/ClusterAllocationExplainCurrentNode.md @@ -0,0 +1,10 @@ +## Interface `ClusterAllocationExplainCurrentNode` + +| Name | Type | Description | +| - | - | - | +| `attributes` | Record |   | +| `id` | [Id](./Id.md) |   | +| `name` | [Name](./Name.md) |   | +| `roles` | [NodeRoles](./NodeRoles.md) |   | +| `transport_address` | [TransportAddress](./TransportAddress.md) |   | +| `weight_ranking` | [integer](./integer.md) |   | diff --git a/docs/reference/api/ClusterAllocationExplainDecision.md b/docs/reference/api/ClusterAllocationExplainDecision.md new file mode 100644 index 000000000..42ccde372 --- /dev/null +++ b/docs/reference/api/ClusterAllocationExplainDecision.md @@ -0,0 +1,4 @@ +## `ClusterAllocationExplainDecision` +::: +type ClusterAllocationExplainDecision = 'yes' | 'no' | 'worse_balance' | 'throttled' | 'awaiting_info' | 'allocation_delayed' | 'no_valid_shard_copy' | 'no_attempt'; +::: diff --git a/docs/reference/api/ClusterAllocationExplainDiskUsage.md b/docs/reference/api/ClusterAllocationExplainDiskUsage.md new file mode 100644 index 000000000..eaaef3bfd --- /dev/null +++ b/docs/reference/api/ClusterAllocationExplainDiskUsage.md @@ -0,0 +1,10 @@ +## Interface `ClusterAllocationExplainDiskUsage` + +| Name | Type | Description | +| - | - | - | +| `free_bytes` | [long](./long.md) |   | +| `free_disk_percent` | [double](./double.md) |   | +| `path` | string |   | +| `total_bytes` | [long](./long.md) |   | +| `used_bytes` | [long](./long.md) |   | +| `used_disk_percent` | [double](./double.md) |   | diff --git a/docs/reference/api/ClusterAllocationExplainNodeAllocationExplanation.md b/docs/reference/api/ClusterAllocationExplainNodeAllocationExplanation.md new file mode 100644 index 000000000..c5b441ef2 --- /dev/null +++ b/docs/reference/api/ClusterAllocationExplainNodeAllocationExplanation.md @@ -0,0 +1,13 @@ +## Interface `ClusterAllocationExplainNodeAllocationExplanation` + +| Name | Type | Description | +| - | - | - | +| `deciders` | [ClusterAllocationExplainAllocationDecision](./ClusterAllocationExplainAllocationDecision.md)[] |   | +| `node_attributes` | Record |   | +| `node_decision` | [ClusterAllocationExplainDecision](./ClusterAllocationExplainDecision.md) |   | +| `node_id` | [Id](./Id.md) |   | +| `node_name` | [Name](./Name.md) |   | +| `roles` | [NodeRoles](./NodeRoles.md) |   | +| `store` | [ClusterAllocationExplainAllocationStore](./ClusterAllocationExplainAllocationStore.md) |   | +| `transport_address` | [TransportAddress](./TransportAddress.md) |   | +| `weight_ranking` | [integer](./integer.md) |   | diff --git a/docs/reference/api/ClusterAllocationExplainNodeDiskUsage.md b/docs/reference/api/ClusterAllocationExplainNodeDiskUsage.md new file mode 100644 index 000000000..e60a378a7 --- /dev/null +++ b/docs/reference/api/ClusterAllocationExplainNodeDiskUsage.md @@ -0,0 +1,7 @@ +## Interface `ClusterAllocationExplainNodeDiskUsage` + +| Name | Type | Description | +| - | - | - | +| `least_available` | [ClusterAllocationExplainDiskUsage](./ClusterAllocationExplainDiskUsage.md) |   | +| `most_available` | [ClusterAllocationExplainDiskUsage](./ClusterAllocationExplainDiskUsage.md) |   | +| `node_name` | [Name](./Name.md) |   | diff --git a/docs/reference/api/ClusterAllocationExplainRequest.md b/docs/reference/api/ClusterAllocationExplainRequest.md new file mode 100644 index 000000000..9cd099306 --- /dev/null +++ b/docs/reference/api/ClusterAllocationExplainRequest.md @@ -0,0 +1,13 @@ +## Interface `ClusterAllocationExplainRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { include_disk_info?: never; include_yes_decisions?: never; master_timeout?: never; current_node?: never; index?: never; primary?: never; shard?: never; }) | All values in `body` will be added to the request body. | +| `current_node` | string | Specifies the node ID or the name of the node to only explain a shard that is currently located on the specified node. | +| `include_disk_info` | boolean | If true, returns information about disk usage and shard sizes. | +| `include_yes_decisions` | boolean | If true, returns YES decisions in explanation. | +| `index` | [IndexName](./IndexName.md) | Specifies the name of the index that you would like an explanation for. | +| `master_timeout` | [Duration](./Duration.md) | Period to wait for a connection to the master node. | +| `primary` | boolean | If true, returns explanation for the primary shard for the given shard ID. | +| `querystring` | { [key: string]: any; } & { include_disk_info?: never; include_yes_decisions?: never; master_timeout?: never; current_node?: never; index?: never; primary?: never; shard?: never; } | All values in `querystring` will be added to the request querystring. | +| `shard` | [integer](./integer.md) | Specifies the ID of the shard that you would like an explanation for. | diff --git a/docs/reference/api/ClusterAllocationExplainReservedSize.md b/docs/reference/api/ClusterAllocationExplainReservedSize.md new file mode 100644 index 000000000..175b84c39 --- /dev/null +++ b/docs/reference/api/ClusterAllocationExplainReservedSize.md @@ -0,0 +1,8 @@ +## Interface `ClusterAllocationExplainReservedSize` + +| Name | Type | Description | +| - | - | - | +| `node_id` | [Id](./Id.md) |   | +| `path` | string |   | +| `shards` | string[] |   | +| `total` | [long](./long.md) |   | diff --git a/docs/reference/api/ClusterAllocationExplainResponse.md b/docs/reference/api/ClusterAllocationExplainResponse.md new file mode 100644 index 000000000..ec5779c9f --- /dev/null +++ b/docs/reference/api/ClusterAllocationExplainResponse.md @@ -0,0 +1,29 @@ +## Interface `ClusterAllocationExplainResponse` + +| Name | Type | Description | +| - | - | - | +| `allocate_explanation` | string |   | +| `allocation_delay_in_millis` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> |   | +| `allocation_delay` | [Duration](./Duration.md) |   | +| `can_allocate` | [ClusterAllocationExplainDecision](./ClusterAllocationExplainDecision.md) |   | +| `can_move_to_other_node` | [ClusterAllocationExplainDecision](./ClusterAllocationExplainDecision.md) |   | +| `can_rebalance_cluster_decisions` | [ClusterAllocationExplainAllocationDecision](./ClusterAllocationExplainAllocationDecision.md)[] |   | +| `can_rebalance_cluster` | [ClusterAllocationExplainDecision](./ClusterAllocationExplainDecision.md) |   | +| `can_rebalance_to_other_node` | [ClusterAllocationExplainDecision](./ClusterAllocationExplainDecision.md) |   | +| `can_remain_decisions` | [ClusterAllocationExplainAllocationDecision](./ClusterAllocationExplainAllocationDecision.md)[] |   | +| `can_remain_on_current_node` | [ClusterAllocationExplainDecision](./ClusterAllocationExplainDecision.md) |   | +| `cluster_info` | [ClusterAllocationExplainClusterInfo](./ClusterAllocationExplainClusterInfo.md) |   | +| `configured_delay_in_millis` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> |   | +| `configured_delay` | [Duration](./Duration.md) |   | +| `current_node` | [ClusterAllocationExplainCurrentNode](./ClusterAllocationExplainCurrentNode.md) |   | +| `current_state` | string |   | +| `index` | [IndexName](./IndexName.md) |   | +| `move_explanation` | string |   | +| `node_allocation_decisions` | [ClusterAllocationExplainNodeAllocationExplanation](./ClusterAllocationExplainNodeAllocationExplanation.md)[] |   | +| `note` | string |   | +| `primary` | boolean |   | +| `rebalance_explanation` | string |   | +| `remaining_delay_in_millis` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> |   | +| `remaining_delay` | [Duration](./Duration.md) |   | +| `shard` | [integer](./integer.md) |   | +| `unassigned_info` | [ClusterAllocationExplainUnassignedInformation](./ClusterAllocationExplainUnassignedInformation.md) |   | diff --git a/docs/reference/api/ClusterAllocationExplainUnassignedInformation.md b/docs/reference/api/ClusterAllocationExplainUnassignedInformation.md new file mode 100644 index 000000000..a7e75eea2 --- /dev/null +++ b/docs/reference/api/ClusterAllocationExplainUnassignedInformation.md @@ -0,0 +1,11 @@ +## Interface `ClusterAllocationExplainUnassignedInformation` + +| Name | Type | Description | +| - | - | - | +| `allocation_status` | string |   | +| `at` | [DateTime](./DateTime.md) |   | +| `delayed` | boolean |   | +| `details` | string |   | +| `failed_allocation_attempts` | [integer](./integer.md) |   | +| `last_allocation_status` | string |   | +| `reason` | [ClusterAllocationExplainUnassignedInformationReason](./ClusterAllocationExplainUnassignedInformationReason.md) |   | diff --git a/docs/reference/api/ClusterAllocationExplainUnassignedInformationReason.md b/docs/reference/api/ClusterAllocationExplainUnassignedInformationReason.md new file mode 100644 index 000000000..cca48a0d2 --- /dev/null +++ b/docs/reference/api/ClusterAllocationExplainUnassignedInformationReason.md @@ -0,0 +1,4 @@ +## `ClusterAllocationExplainUnassignedInformationReason` +::: +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'; +::: diff --git a/docs/reference/api/ClusterComponentTemplate.md b/docs/reference/api/ClusterComponentTemplate.md new file mode 100644 index 000000000..0a333f8e3 --- /dev/null +++ b/docs/reference/api/ClusterComponentTemplate.md @@ -0,0 +1,6 @@ +## Interface `ClusterComponentTemplate` + +| Name | Type | Description | +| - | - | - | +| `component_template` | [ClusterComponentTemplateNode](./ClusterComponentTemplateNode.md) |   | +| `name` | [Name](./Name.md) |   | diff --git a/docs/reference/api/ClusterComponentTemplateNode.md b/docs/reference/api/ClusterComponentTemplateNode.md new file mode 100644 index 000000000..f6cbbc4d5 --- /dev/null +++ b/docs/reference/api/ClusterComponentTemplateNode.md @@ -0,0 +1,8 @@ +## Interface `ClusterComponentTemplateNode` + +| Name | Type | Description | +| - | - | - | +| `_meta` | [Metadata](./Metadata.md) |   | +| `deprecated` | boolean |   | +| `template` | [ClusterComponentTemplateSummary](./ClusterComponentTemplateSummary.md) |   | +| `version` | [VersionNumber](./VersionNumber.md) |   | diff --git a/docs/reference/api/ClusterComponentTemplateSummary.md b/docs/reference/api/ClusterComponentTemplateSummary.md new file mode 100644 index 000000000..cf338840c --- /dev/null +++ b/docs/reference/api/ClusterComponentTemplateSummary.md @@ -0,0 +1,10 @@ +## Interface `ClusterComponentTemplateSummary` + +| Name | Type | Description | +| - | - | - | +| `_meta` | [Metadata](./Metadata.md) |   | +| `aliases` | Record |   | +| `lifecycle` | [IndicesDataStreamLifecycleWithRollover](./IndicesDataStreamLifecycleWithRollover.md) |   | +| `mappings` | [MappingTypeMapping](./MappingTypeMapping.md) |   | +| `settings` | Record<[IndexName](./IndexName.md), [IndicesIndexSettings](./IndicesIndexSettings.md)> |   | +| `version` | [VersionNumber](./VersionNumber.md) |   | diff --git a/docs/reference/api/ClusterDeleteComponentTemplateRequest.md b/docs/reference/api/ClusterDeleteComponentTemplateRequest.md new file mode 100644 index 000000000..eb34e88ae --- /dev/null +++ b/docs/reference/api/ClusterDeleteComponentTemplateRequest.md @@ -0,0 +1,9 @@ +## Interface `ClusterDeleteComponentTemplateRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { name?: never; master_timeout?: never; timeout?: never; }) | All values in `body` will be added to the request body. | +| `master_timeout` | [Duration](./Duration.md) | Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. | +| `name` | [Names](./Names.md) | Comma-separated list or wildcard expression of component template names used to limit the request. | +| `querystring` | { [key: string]: any; } & { name?: never; master_timeout?: never; timeout?: never; } | All values in `querystring` will be added to the request querystring. | +| `timeout` | [Duration](./Duration.md) | Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. | diff --git a/docs/reference/api/ClusterDeleteComponentTemplateResponse.md b/docs/reference/api/ClusterDeleteComponentTemplateResponse.md new file mode 100644 index 000000000..cfc4e30be --- /dev/null +++ b/docs/reference/api/ClusterDeleteComponentTemplateResponse.md @@ -0,0 +1,4 @@ +## `ClusterDeleteComponentTemplateResponse` +::: +type ClusterDeleteComponentTemplateResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); +::: diff --git a/docs/reference/api/ClusterDeleteVotingConfigExclusionsRequest.md b/docs/reference/api/ClusterDeleteVotingConfigExclusionsRequest.md new file mode 100644 index 000000000..a4760ee81 --- /dev/null +++ b/docs/reference/api/ClusterDeleteVotingConfigExclusionsRequest.md @@ -0,0 +1,8 @@ +## Interface `ClusterDeleteVotingConfigExclusionsRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { master_timeout?: never; wait_for_removal?: never; }) | All values in `body` will be added to the request body. | +| `master_timeout` | [Duration](./Duration.md) | Period to wait for a connection to the master node. | +| `querystring` | { [key: string]: any; } & { master_timeout?: never; wait_for_removal?: never; } | All values in `querystring` will be added to the request querystring. | +| `wait_for_removal` | boolean | Specifies whether to wait for all excluded nodes to be removed from the cluster before clearing the voting configuration exclusions list. Defaults to true, meaning that all excluded nodes must be removed from the cluster before this API takes any action. If set to false then the voting configuration exclusions list is cleared even if some excluded nodes are still in the cluster. | diff --git a/docs/reference/api/ClusterDeleteVotingConfigExclusionsResponse.md b/docs/reference/api/ClusterDeleteVotingConfigExclusionsResponse.md new file mode 100644 index 000000000..943f3c6b1 --- /dev/null +++ b/docs/reference/api/ClusterDeleteVotingConfigExclusionsResponse.md @@ -0,0 +1,4 @@ +## `ClusterDeleteVotingConfigExclusionsResponse` +::: +type ClusterDeleteVotingConfigExclusionsResponse = boolean; +::: diff --git a/docs/reference/api/ClusterDetails.md b/docs/reference/api/ClusterDetails.md new file mode 100644 index 000000000..a61233ec0 --- /dev/null +++ b/docs/reference/api/ClusterDetails.md @@ -0,0 +1,10 @@ +## Interface `ClusterDetails` + +| Name | Type | Description | +| - | - | - | +| `_shards` | [ShardStatistics](./ShardStatistics.md) |   | +| `failures` | [ShardFailure](./ShardFailure.md)[] |   | +| `indices` | string |   | +| `status` | [ClusterSearchStatus](./ClusterSearchStatus.md) |   | +| `timed_out` | boolean |   | +| `took` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> |   | diff --git a/docs/reference/api/ClusterExistsComponentTemplateRequest.md b/docs/reference/api/ClusterExistsComponentTemplateRequest.md new file mode 100644 index 000000000..656eea97b --- /dev/null +++ b/docs/reference/api/ClusterExistsComponentTemplateRequest.md @@ -0,0 +1,9 @@ +## Interface `ClusterExistsComponentTemplateRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { name?: never; master_timeout?: never; local?: never; }) | All values in `body` will be added to the request body. | +| `local` | boolean | If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node. | +| `master_timeout` | [Duration](./Duration.md) | Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. | +| `name` | [Names](./Names.md) | Comma-separated list of component template names used to limit the request. Wildcard (*) expressions are supported. | +| `querystring` | { [key: string]: any; } & { name?: never; master_timeout?: never; local?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/ClusterExistsComponentTemplateResponse.md b/docs/reference/api/ClusterExistsComponentTemplateResponse.md new file mode 100644 index 000000000..27be92f22 --- /dev/null +++ b/docs/reference/api/ClusterExistsComponentTemplateResponse.md @@ -0,0 +1,4 @@ +## `ClusterExistsComponentTemplateResponse` +::: +type ClusterExistsComponentTemplateResponse = boolean; +::: diff --git a/docs/reference/api/ClusterGetComponentTemplateRequest.md b/docs/reference/api/ClusterGetComponentTemplateRequest.md new file mode 100644 index 000000000..aeb120df1 --- /dev/null +++ b/docs/reference/api/ClusterGetComponentTemplateRequest.md @@ -0,0 +1,11 @@ +## Interface `ClusterGetComponentTemplateRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { name?: never; flat_settings?: never; include_defaults?: never; local?: never; master_timeout?: never; }) | All values in `body` will be added to the request body. | +| `flat_settings` | boolean | If `true`, returns settings in flat format. | +| `include_defaults` | boolean | Return all default configurations for the component template (default: false) | +| `local` | boolean | If `true`, the request retrieves information from the local node only. If `false`, information is retrieved from the master node. | +| `master_timeout` | [Duration](./Duration.md) | Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. | +| `name` | [Name](./Name.md) | Comma-separated list of component template names used to limit the request. Wildcard ( `*`) expressions are supported. | +| `querystring` | { [key: string]: any; } & { name?: never; flat_settings?: never; include_defaults?: never; local?: never; master_timeout?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/ClusterGetComponentTemplateResponse.md b/docs/reference/api/ClusterGetComponentTemplateResponse.md new file mode 100644 index 000000000..d307c9e12 --- /dev/null +++ b/docs/reference/api/ClusterGetComponentTemplateResponse.md @@ -0,0 +1,5 @@ +## Interface `ClusterGetComponentTemplateResponse` + +| Name | Type | Description | +| - | - | - | +| `component_templates` | [ClusterComponentTemplate](./ClusterComponentTemplate.md)[] |   | diff --git a/docs/reference/api/ClusterGetSettingsRequest.md b/docs/reference/api/ClusterGetSettingsRequest.md new file mode 100644 index 000000000..6a6281749 --- /dev/null +++ b/docs/reference/api/ClusterGetSettingsRequest.md @@ -0,0 +1,10 @@ +## Interface `ClusterGetSettingsRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { flat_settings?: never; include_defaults?: never; master_timeout?: never; timeout?: never; }) | All values in `body` will be added to the request body. | +| `flat_settings` | boolean | If `true`, returns settings in flat format. | +| `include_defaults` | boolean | If `true`, returns default cluster settings from the local node. | +| `master_timeout` | [Duration](./Duration.md) | Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. | +| `querystring` | { [key: string]: any; } & { flat_settings?: never; include_defaults?: never; master_timeout?: never; timeout?: never; } | All values in `querystring` will be added to the request querystring. | +| `timeout` | [Duration](./Duration.md) | Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. | diff --git a/docs/reference/api/ClusterGetSettingsResponse.md b/docs/reference/api/ClusterGetSettingsResponse.md new file mode 100644 index 000000000..20d33d0e5 --- /dev/null +++ b/docs/reference/api/ClusterGetSettingsResponse.md @@ -0,0 +1,7 @@ +## Interface `ClusterGetSettingsResponse` + +| Name | Type | Description | +| - | - | - | +| `defaults` | Record |   | +| `persistent` | Record |   | +| `transient` | Record |   | diff --git a/docs/reference/api/ClusterHealthHealthResponseBody.md b/docs/reference/api/ClusterHealthHealthResponseBody.md new file mode 100644 index 000000000..dca7658e5 --- /dev/null +++ b/docs/reference/api/ClusterHealthHealthResponseBody.md @@ -0,0 +1,23 @@ +## Interface `ClusterHealthHealthResponseBody` + +| Name | Type | Description | +| - | - | - | +| `active_primary_shards` | [integer](./integer.md) | The number of active primary shards. | +| `active_shards_percent_as_number` | [double](./double.md) | The ratio of active shards in the cluster expressed as a percentage. | +| `active_shards_percent` | string | The ratio of active shards in the cluster expressed as a string formatted percentage. | +| `active_shards` | [integer](./integer.md) | The total number of active primary and replica shards. | +| `cluster_name` | [Name](./Name.md) | The name of the cluster. | +| `delayed_unassigned_shards` | [integer](./integer.md) | The number of shards whose allocation has been delayed by the timeout settings. | +| `indices` | Record<[IndexName](./IndexName.md), [ClusterHealthIndexHealthStats](./ClusterHealthIndexHealthStats.md)> |   | +| `initializing_shards` | [integer](./integer.md) | The number of shards that are under initialization. | +| `number_of_data_nodes` | [integer](./integer.md) | The number of nodes that are dedicated data nodes. | +| `number_of_in_flight_fetch` | [integer](./integer.md) | The number of unfinished fetches. | +| `number_of_nodes` | [integer](./integer.md) | The number of nodes within the cluster. | +| `number_of_pending_tasks` | [integer](./integer.md) | The number of cluster-level changes that have not yet been executed. | +| `relocating_shards` | [integer](./integer.md) | The number of shards that are under relocation. | +| `status` | [HealthStatus](./HealthStatus.md) |   | +| `task_max_waiting_in_queue_millis` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> | The time expressed in milliseconds since the earliest initiated task is waiting for being performed. | +| `task_max_waiting_in_queue` | [Duration](./Duration.md) | The time since the earliest initiated task is waiting for being performed. | +| `timed_out` | boolean | If false the response returned within the period of time that is specified by the timeout parameter (30s by default) | +| `unassigned_primary_shards` | [integer](./integer.md) | The number of primary shards that are not allocated. | +| `unassigned_shards` | [integer](./integer.md) | The number of shards that are not allocated. | diff --git a/docs/reference/api/ClusterHealthIndexHealthStats.md b/docs/reference/api/ClusterHealthIndexHealthStats.md new file mode 100644 index 000000000..2f92954cb --- /dev/null +++ b/docs/reference/api/ClusterHealthIndexHealthStats.md @@ -0,0 +1,14 @@ +## Interface `ClusterHealthIndexHealthStats` + +| Name | Type | Description | +| - | - | - | +| `active_primary_shards` | [integer](./integer.md) |   | +| `active_shards` | [integer](./integer.md) |   | +| `initializing_shards` | [integer](./integer.md) |   | +| `number_of_replicas` | [integer](./integer.md) |   | +| `number_of_shards` | [integer](./integer.md) |   | +| `relocating_shards` | [integer](./integer.md) |   | +| `shards` | Record |   | +| `status` | [HealthStatus](./HealthStatus.md) |   | +| `unassigned_primary_shards` | [integer](./integer.md) |   | +| `unassigned_shards` | [integer](./integer.md) |   | diff --git a/docs/reference/api/ClusterHealthRequest.md b/docs/reference/api/ClusterHealthRequest.md new file mode 100644 index 000000000..21d9e4b2e --- /dev/null +++ b/docs/reference/api/ClusterHealthRequest.md @@ -0,0 +1,18 @@ +## Interface `ClusterHealthRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { index?: never; expand_wildcards?: never; level?: never; local?: never; master_timeout?: never; timeout?: never; wait_for_active_shards?: never; wait_for_events?: never; wait_for_nodes?: never; wait_for_no_initializing_shards?: never; wait_for_no_relocating_shards?: never; wait_for_status?: never; }) | All values in `body` will be added to the request body. | +| `expand_wildcards` | [ExpandWildcards](./ExpandWildcards.md) | Whether to expand wildcard expression to concrete indices that are open, closed or both. | +| `index` | [Indices](./Indices.md) | Comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard expressions ( `*`) are supported. To target all data streams and indices in a cluster, omit this parameter or use _all or `*`. | +| `level` | [Level](./Level.md) | Can be one of cluster, indices or shards. Controls the details level of the health information returned. | +| `local` | boolean | If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node. | +| `master_timeout` | [Duration](./Duration.md) | Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. | +| `querystring` | { [key: string]: any; } & { index?: never; expand_wildcards?: never; level?: never; local?: never; master_timeout?: never; timeout?: never; wait_for_active_shards?: never; wait_for_events?: never; wait_for_nodes?: never; wait_for_no_initializing_shards?: never; wait_for_no_relocating_shards?: never; wait_for_status?: never; } | All values in `querystring` will be added to the request querystring. | +| `timeout` | [Duration](./Duration.md) | Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. | +| `wait_for_active_shards` | [WaitForActiveShards](./WaitForActiveShards.md) | A number controlling to how many active shards to wait for, all to wait for all shards in the cluster to be active, or 0 to not wait. | +| `wait_for_events` | [WaitForEvents](./WaitForEvents.md) | Can be one of immediate, urgent, high, normal, low, languid. Wait until all currently queued events with the given priority are processed. | +| `wait_for_no_initializing_shards` | boolean | A boolean value which controls whether to wait (until the timeout provided) for the cluster to have no shard initializations. Defaults to false, which means it will not wait for initializing shards. | +| `wait_for_no_relocating_shards` | boolean | A boolean value which controls whether to wait (until the timeout provided) for the cluster to have no shard relocations. Defaults to false, which means it will not wait for relocating shards. | +| `wait_for_nodes` | [ClusterHealthWaitForNodes](./ClusterHealthWaitForNodes.md) | The request waits until the specified number N of nodes is available. It also accepts > =N, < =N, > N and < N. Alternatively, it is possible to use ge(N), le(N), gt(N) and lt(N) notation. | +| `wait_for_status` | [HealthStatus](./HealthStatus.md) | One of green, yellow or red. Will wait (until the timeout provided) until the status of the cluster changes to the one provided or better, i.e. green > yellow > red. By default, will not wait for any status. | diff --git a/docs/reference/api/ClusterHealthResponse.md b/docs/reference/api/ClusterHealthResponse.md new file mode 100644 index 000000000..1bc8759c2 --- /dev/null +++ b/docs/reference/api/ClusterHealthResponse.md @@ -0,0 +1,4 @@ +## `ClusterHealthResponse` +::: +type ClusterHealthResponse = [ClusterHealthHealthResponseBody](./ClusterHealthHealthResponseBody.md); +::: diff --git a/docs/reference/api/ClusterHealthShardHealthStats.md b/docs/reference/api/ClusterHealthShardHealthStats.md new file mode 100644 index 000000000..cd908eb3a --- /dev/null +++ b/docs/reference/api/ClusterHealthShardHealthStats.md @@ -0,0 +1,11 @@ +## Interface `ClusterHealthShardHealthStats` + +| Name | Type | Description | +| - | - | - | +| `active_shards` | [integer](./integer.md) |   | +| `initializing_shards` | [integer](./integer.md) |   | +| `primary_active` | boolean |   | +| `relocating_shards` | [integer](./integer.md) |   | +| `status` | [HealthStatus](./HealthStatus.md) |   | +| `unassigned_primary_shards` | [integer](./integer.md) |   | +| `unassigned_shards` | [integer](./integer.md) |   | diff --git a/docs/reference/api/ClusterHealthWaitForNodes.md b/docs/reference/api/ClusterHealthWaitForNodes.md new file mode 100644 index 000000000..378d6c262 --- /dev/null +++ b/docs/reference/api/ClusterHealthWaitForNodes.md @@ -0,0 +1,4 @@ +## `ClusterHealthWaitForNodes` +::: +type ClusterHealthWaitForNodes = string | [integer](./integer.md); +::: diff --git a/docs/reference/api/ClusterInfoRequest.md b/docs/reference/api/ClusterInfoRequest.md new file mode 100644 index 000000000..9e638873e --- /dev/null +++ b/docs/reference/api/ClusterInfoRequest.md @@ -0,0 +1,7 @@ +## Interface `ClusterInfoRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { target?: never; }) | All values in `body` will be added to the request body. | +| `querystring` | { [key: string]: any; } & { target?: never; } | All values in `querystring` will be added to the request querystring. | +| `target` | [ClusterInfoTargets](./ClusterInfoTargets.md) | Limits the information returned to the specific target. Supports a comma-separated list, such as http,ingest. | diff --git a/docs/reference/api/ClusterInfoResponse.md b/docs/reference/api/ClusterInfoResponse.md new file mode 100644 index 000000000..7a73caac3 --- /dev/null +++ b/docs/reference/api/ClusterInfoResponse.md @@ -0,0 +1,9 @@ +## Interface `ClusterInfoResponse` + +| Name | Type | Description | +| - | - | - | +| `cluster_name` | [Name](./Name.md) |   | +| `http` | [NodesHttp](./NodesHttp.md) |   | +| `ingest` | [NodesIngest](./NodesIngest.md) |   | +| `script` | [NodesScripting](./NodesScripting.md) |   | +| `thread_pool` | Record |   | diff --git a/docs/reference/api/ClusterInfoTarget.md b/docs/reference/api/ClusterInfoTarget.md new file mode 100644 index 000000000..f704957fe --- /dev/null +++ b/docs/reference/api/ClusterInfoTarget.md @@ -0,0 +1,4 @@ +## `ClusterInfoTarget` +::: +type ClusterInfoTarget = '_all' | 'http' | 'ingest' | 'thread_pool' | 'script'; +::: diff --git a/docs/reference/api/ClusterInfoTargets.md b/docs/reference/api/ClusterInfoTargets.md new file mode 100644 index 000000000..92b06030c --- /dev/null +++ b/docs/reference/api/ClusterInfoTargets.md @@ -0,0 +1,4 @@ +## `ClusterInfoTargets` +::: +type ClusterInfoTargets = [ClusterInfoTarget](./ClusterInfoTarget.md) | [ClusterInfoTarget](./ClusterInfoTarget.md)[]; +::: diff --git a/docs/reference/api/ClusterPendingTasksPendingTask.md b/docs/reference/api/ClusterPendingTasksPendingTask.md new file mode 100644 index 000000000..681d25ed8 --- /dev/null +++ b/docs/reference/api/ClusterPendingTasksPendingTask.md @@ -0,0 +1,10 @@ +## Interface `ClusterPendingTasksPendingTask` + +| Name | Type | Description | +| - | - | - | +| `executing` | boolean | Indicates whether the pending tasks are currently executing or not. | +| `insert_order` | [integer](./integer.md) | The number that represents when the task has been inserted into the task queue. | +| `priority` | string | The priority of the pending task. The valid priorities in descending priority order are: `IMMEDIATE` > `URGENT` > `HIGH` > `NORMAL` > `LOW` > `LANGUID`. | +| `source` | string | A general description of the cluster task that may include a reason and origin. | +| `time_in_queue_millis` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> | The time expressed in milliseconds since the task is waiting for being performed. | +| `time_in_queue` | [Duration](./Duration.md) | The time since the task is waiting for being performed. | diff --git a/docs/reference/api/ClusterPendingTasksRequest.md b/docs/reference/api/ClusterPendingTasksRequest.md new file mode 100644 index 000000000..250544131 --- /dev/null +++ b/docs/reference/api/ClusterPendingTasksRequest.md @@ -0,0 +1,8 @@ +## Interface `ClusterPendingTasksRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { local?: never; master_timeout?: never; }) | All values in `body` will be added to the request body. | +| `local` | boolean | If `true`, the request retrieves information from the local node only. If `false`, information is retrieved from the master node. | +| `master_timeout` | [Duration](./Duration.md) | Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. | +| `querystring` | { [key: string]: any; } & { local?: never; master_timeout?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/ClusterPendingTasksResponse.md b/docs/reference/api/ClusterPendingTasksResponse.md new file mode 100644 index 000000000..fd11bb9f6 --- /dev/null +++ b/docs/reference/api/ClusterPendingTasksResponse.md @@ -0,0 +1,5 @@ +## Interface `ClusterPendingTasksResponse` + +| Name | Type | Description | +| - | - | - | +| `tasks` | [ClusterPendingTasksPendingTask](./ClusterPendingTasksPendingTask.md)[] |   | diff --git a/docs/reference/api/ClusterPostVotingConfigExclusionsRequest.md b/docs/reference/api/ClusterPostVotingConfigExclusionsRequest.md new file mode 100644 index 000000000..0c478a77d --- /dev/null +++ b/docs/reference/api/ClusterPostVotingConfigExclusionsRequest.md @@ -0,0 +1,10 @@ +## Interface `ClusterPostVotingConfigExclusionsRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { node_names?: never; node_ids?: never; master_timeout?: never; timeout?: never; }) | All values in `body` will be added to the request body. | +| `master_timeout` | [Duration](./Duration.md) | Period to wait for a connection to the master node. | +| `node_ids` | [Ids](./Ids.md) | A comma-separated list of the persistent ids of the nodes to exclude from the voting configuration. If specified, you may not also specify node_names. | +| `node_names` | [Names](./Names.md) | A comma-separated list of the names of the nodes to exclude from the voting configuration. If specified, you may not also specify node_ids. | +| `querystring` | { [key: string]: any; } & { node_names?: never; node_ids?: never; master_timeout?: never; timeout?: never; } | All values in `querystring` will be added to the request querystring. | +| `timeout` | [Duration](./Duration.md) | When adding a voting configuration exclusion, the API waits for the specified nodes to be excluded from the voting configuration before returning. If the timeout expires before the appropriate condition is satisfied, the request fails and returns an error. | diff --git a/docs/reference/api/ClusterPostVotingConfigExclusionsResponse.md b/docs/reference/api/ClusterPostVotingConfigExclusionsResponse.md new file mode 100644 index 000000000..63cf5f689 --- /dev/null +++ b/docs/reference/api/ClusterPostVotingConfigExclusionsResponse.md @@ -0,0 +1,4 @@ +## `ClusterPostVotingConfigExclusionsResponse` +::: +type ClusterPostVotingConfigExclusionsResponse = boolean; +::: diff --git a/docs/reference/api/ClusterPutComponentTemplateRequest.md b/docs/reference/api/ClusterPutComponentTemplateRequest.md new file mode 100644 index 000000000..baf485705 --- /dev/null +++ b/docs/reference/api/ClusterPutComponentTemplateRequest.md @@ -0,0 +1,13 @@ +## Interface `ClusterPutComponentTemplateRequest` + +| Name | Type | Description | +| - | - | - | +| `_meta` | [Metadata](./Metadata.md) | Optional user metadata about the component template. It may have any contents. This map is not automatically generated by Elasticsearch. This information is stored in the cluster state, so keeping it short is preferable. To unset `_meta`, replace the template without specifying this information. | +| `body` | string | ({ [key: string]: any; } & { name?: never; create?: never; master_timeout?: never; template?: never; version?: never; _meta?: never; deprecated?: never; }) | All values in `body` will be added to the request body. | +| `create` | boolean | If `true`, this request cannot replace or update existing component templates. | +| `deprecated` | boolean | Marks this index template as deprecated. When creating or updating a non-deprecated index template that uses deprecated components, Elasticsearch will emit a deprecation warning. | +| `master_timeout` | [Duration](./Duration.md) | Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. | +| `name` | [Name](./Name.md) | Name of the component template to create. Elasticsearch includes the following built-in component templates: `logs-mappings`; `logs-settings`; `metrics-mappings`; `metrics-settings`; `synthetics-mapping`; `synthetics-settings`. Elastic Agent uses these templates to configure backing indices for its data streams. If you use Elastic Agent and want to overwrite one of these templates, set the `version` for your replacement template higher than the current version. If you don’t use Elastic Agent and want to disable all built-in component and index templates, set `stack.templates.enabled` to `false` using the cluster update settings API. | +| `querystring` | { [key: string]: any; } & { name?: never; create?: never; master_timeout?: never; template?: never; version?: never; _meta?: never; deprecated?: never; } | All values in `querystring` will be added to the request querystring. | +| `template` | [IndicesIndexState](./IndicesIndexState.md) | The template to be applied which includes mappings, settings, or aliases configuration. | +| `version` | [VersionNumber](./VersionNumber.md) | Version number used to manage component templates externally. This number isn't automatically generated or incremented by Elasticsearch. To unset a version, replace the template without specifying a version. | diff --git a/docs/reference/api/ClusterPutComponentTemplateResponse.md b/docs/reference/api/ClusterPutComponentTemplateResponse.md new file mode 100644 index 000000000..15904ef3d --- /dev/null +++ b/docs/reference/api/ClusterPutComponentTemplateResponse.md @@ -0,0 +1,4 @@ +## `ClusterPutComponentTemplateResponse` +::: +type ClusterPutComponentTemplateResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); +::: diff --git a/docs/reference/api/ClusterPutSettingsRequest.md b/docs/reference/api/ClusterPutSettingsRequest.md new file mode 100644 index 000000000..3f9b74509 --- /dev/null +++ b/docs/reference/api/ClusterPutSettingsRequest.md @@ -0,0 +1,11 @@ +## Interface `ClusterPutSettingsRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { flat_settings?: never; master_timeout?: never; timeout?: never; persistent?: never; transient?: never; }) | All values in `body` will be added to the request body. | +| `flat_settings` | boolean | Return settings in flat format (default: false) | +| `master_timeout` | [Duration](./Duration.md) | Explicit operation timeout for connection to master node | +| `persistent` | Record |   | +| `querystring` | { [key: string]: any; } & { flat_settings?: never; master_timeout?: never; timeout?: never; persistent?: never; transient?: never; } | All values in `querystring` will be added to the request querystring. | +| `timeout` | [Duration](./Duration.md) | Explicit operation timeout | +| `transient` | Record |   | diff --git a/docs/reference/api/ClusterPutSettingsResponse.md b/docs/reference/api/ClusterPutSettingsResponse.md new file mode 100644 index 000000000..df41ca8dc --- /dev/null +++ b/docs/reference/api/ClusterPutSettingsResponse.md @@ -0,0 +1,7 @@ +## Interface `ClusterPutSettingsResponse` + +| Name | Type | Description | +| - | - | - | +| `acknowledged` | boolean |   | +| `persistent` | Record |   | +| `transient` | Record |   | diff --git a/docs/reference/api/ClusterRemoteInfoClusterRemoteInfo.md b/docs/reference/api/ClusterRemoteInfoClusterRemoteInfo.md new file mode 100644 index 000000000..c2567fc5f --- /dev/null +++ b/docs/reference/api/ClusterRemoteInfoClusterRemoteInfo.md @@ -0,0 +1,4 @@ +## `ClusterRemoteInfoClusterRemoteInfo` +::: +type ClusterRemoteInfoClusterRemoteInfo = [ClusterRemoteInfoClusterRemoteSniffInfo](./ClusterRemoteInfoClusterRemoteSniffInfo.md) | [ClusterRemoteInfoClusterRemoteProxyInfo](./ClusterRemoteInfoClusterRemoteProxyInfo.md); +::: diff --git a/docs/reference/api/ClusterRemoteInfoClusterRemoteProxyInfo.md b/docs/reference/api/ClusterRemoteInfoClusterRemoteProxyInfo.md new file mode 100644 index 000000000..10b76718a --- /dev/null +++ b/docs/reference/api/ClusterRemoteInfoClusterRemoteProxyInfo.md @@ -0,0 +1,13 @@ +## Interface `ClusterRemoteInfoClusterRemoteProxyInfo` + +| Name | Type | Description | +| - | - | - | +| `cluster_credentials` | string | This field is present and has a value of `::es_redacted::` only when the remote cluster is configured with the API key based model. Otherwise, the field is not present. | +| `connected` | boolean | If it is `true`, there is at least one open connection to the remote cluster. If it is `false`, it means that the cluster no longer has an open connection to the remote cluster. It does not necessarily mean that the remote cluster is down or unavailable, just that at some point a connection was lost. | +| `initial_connect_timeout` | [Duration](./Duration.md) | The initial connect timeout for remote cluster connections. | +| `max_proxy_socket_connections` | [integer](./integer.md) | The maximum number of socket connections to the remote cluster when proxy mode is configured. | +| `mode` | 'proxy' | The connection mode for the remote cluster. | +| `num_proxy_sockets_connected` | [integer](./integer.md) | The number of open socket connections to the remote cluster when proxy mode is configured. | +| `proxy_address` | string | The address for remote connections when proxy mode is configured. | +| `server_name` | string |   | +| `skip_unavailable` | boolean | If `true`, cross-cluster search skips the remote cluster when its nodes are unavailable during the search and ignores errors returned by the remote cluster. | diff --git a/docs/reference/api/ClusterRemoteInfoClusterRemoteSniffInfo.md b/docs/reference/api/ClusterRemoteInfoClusterRemoteSniffInfo.md new file mode 100644 index 000000000..96046614a --- /dev/null +++ b/docs/reference/api/ClusterRemoteInfoClusterRemoteSniffInfo.md @@ -0,0 +1,11 @@ +## Interface `ClusterRemoteInfoClusterRemoteSniffInfo` + +| Name | Type | Description | +| - | - | - | +| `connected` | boolean | If it is `true`, there is at least one open connection to the remote cluster. If it is `false`, it means that the cluster no longer has an open connection to the remote cluster. It does not necessarily mean that the remote cluster is down or unavailable, just that at some point a connection was lost. | +| `initial_connect_timeout` | [Duration](./Duration.md) | The initial connect timeout for remote cluster connections. | +| `max_connections_per_cluster` | [integer](./integer.md) | The maximum number of connections maintained for the remote cluster when sniff mode is configured. | +| `mode` | 'sniff' | The connection mode for the remote cluster. | +| `num_nodes_connected` | [long](./long.md) | The number of connected nodes in the remote cluster when sniff mode is configured. | +| `seeds` | string[] | The initial seed transport addresses of the remote cluster when sniff mode is configured. | +| `skip_unavailable` | boolean | If `true`, cross-cluster search skips the remote cluster when its nodes are unavailable during the search and ignores errors returned by the remote cluster. | diff --git a/docs/reference/api/ClusterRemoteInfoRequest.md b/docs/reference/api/ClusterRemoteInfoRequest.md new file mode 100644 index 000000000..63f442848 --- /dev/null +++ b/docs/reference/api/ClusterRemoteInfoRequest.md @@ -0,0 +1,6 @@ +## Interface `ClusterRemoteInfoRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | { [key: string]: any; } | All values in `body` will be added to the request body. | +| `querystring` | { [key: string]: any; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/ClusterRemoteInfoResponse.md b/docs/reference/api/ClusterRemoteInfoResponse.md new file mode 100644 index 000000000..099dac0ee --- /dev/null +++ b/docs/reference/api/ClusterRemoteInfoResponse.md @@ -0,0 +1,4 @@ +## `ClusterRemoteInfoResponse` +::: +type ClusterRemoteInfoResponse = Record; +::: diff --git a/docs/reference/api/ClusterRerouteCommand.md b/docs/reference/api/ClusterRerouteCommand.md new file mode 100644 index 000000000..c9fd264fe --- /dev/null +++ b/docs/reference/api/ClusterRerouteCommand.md @@ -0,0 +1,9 @@ +## Interface `ClusterRerouteCommand` + +| Name | Type | Description | +| - | - | - | +| `allocate_empty_primary` | [ClusterRerouteCommandAllocatePrimaryAction](./ClusterRerouteCommandAllocatePrimaryAction.md) | Allocate an empty primary shard to a node. Accepts the index and shard for index name and shard number, and node to allocate the shard to. Using this command leads to a complete loss of all data that was indexed into this shard, if it was previously started. If a node which has a copy of the data rejoins the cluster later on, that data will be deleted. To ensure that these implications are well-understood, this command requires the flag accept_data_loss to be explicitly set to true. | +| `allocate_replica` | [ClusterRerouteCommandAllocateReplicaAction](./ClusterRerouteCommandAllocateReplicaAction.md) | Allocate an unassigned replica shard to a node. Accepts index and shard for index name and shard number, and node to allocate the shard to. Takes allocation deciders into account. | +| `allocate_stale_primary` | [ClusterRerouteCommandAllocatePrimaryAction](./ClusterRerouteCommandAllocatePrimaryAction.md) | Allocate a primary shard to a node that holds a stale copy. Accepts the index and shard for index name and shard number, and node to allocate the shard to. Using this command may lead to data loss for the provided shard id. If a node which has the good copy of the data rejoins the cluster later on, that data will be deleted or overwritten with the data of the stale copy that was forcefully allocated with this command. To ensure that these implications are well-understood, this command requires the flag accept_data_loss to be explicitly set to true. | +| `cancel` | [ClusterRerouteCommandCancelAction](./ClusterRerouteCommandCancelAction.md) | Cancel allocation of a shard (or recovery). Accepts index and shard for index name and shard number, and node for the node to cancel the shard allocation on. This can be used to force resynchronization of existing replicas from the primary shard by cancelling them and allowing them to be reinitialized through the standard recovery process. By default only replica shard allocations can be cancelled. If it is necessary to cancel the allocation of a primary shard then the allow_primary flag must also be included in the request. | +| `move` | [ClusterRerouteCommandMoveAction](./ClusterRerouteCommandMoveAction.md) | Move a started shard from one node to another node. Accepts index and shard for index name and shard number, from_node for the node to move the shard from, and to_node for the node to move the shard to. | diff --git a/docs/reference/api/ClusterRerouteCommandAllocatePrimaryAction.md b/docs/reference/api/ClusterRerouteCommandAllocatePrimaryAction.md new file mode 100644 index 000000000..53dfbea5a --- /dev/null +++ b/docs/reference/api/ClusterRerouteCommandAllocatePrimaryAction.md @@ -0,0 +1,8 @@ +## Interface `ClusterRerouteCommandAllocatePrimaryAction` + +| Name | Type | Description | +| - | - | - | +| `accept_data_loss` | boolean | If a node which has a copy of the data rejoins the cluster later on, that data will be deleted. To ensure that these implications are well-understood, this command requires the flag accept_data_loss to be explicitly set to true | +| `index` | [IndexName](./IndexName.md) |   | +| `node` | string |   | +| `shard` | [integer](./integer.md) |   | diff --git a/docs/reference/api/ClusterRerouteCommandAllocateReplicaAction.md b/docs/reference/api/ClusterRerouteCommandAllocateReplicaAction.md new file mode 100644 index 000000000..fdfbff13b --- /dev/null +++ b/docs/reference/api/ClusterRerouteCommandAllocateReplicaAction.md @@ -0,0 +1,7 @@ +## Interface `ClusterRerouteCommandAllocateReplicaAction` + +| Name | Type | Description | +| - | - | - | +| `index` | [IndexName](./IndexName.md) |   | +| `node` | string |   | +| `shard` | [integer](./integer.md) |   | diff --git a/docs/reference/api/ClusterRerouteCommandCancelAction.md b/docs/reference/api/ClusterRerouteCommandCancelAction.md new file mode 100644 index 000000000..a63f2077d --- /dev/null +++ b/docs/reference/api/ClusterRerouteCommandCancelAction.md @@ -0,0 +1,8 @@ +## Interface `ClusterRerouteCommandCancelAction` + +| Name | Type | Description | +| - | - | - | +| `allow_primary` | boolean |   | +| `index` | [IndexName](./IndexName.md) |   | +| `node` | string |   | +| `shard` | [integer](./integer.md) |   | diff --git a/docs/reference/api/ClusterRerouteCommandMoveAction.md b/docs/reference/api/ClusterRerouteCommandMoveAction.md new file mode 100644 index 000000000..cfd01ae0a --- /dev/null +++ b/docs/reference/api/ClusterRerouteCommandMoveAction.md @@ -0,0 +1,8 @@ +## Interface `ClusterRerouteCommandMoveAction` + +| Name | Type | Description | +| - | - | - | +| `from_node` | string | The node to move the shard from | +| `index` | [IndexName](./IndexName.md) |   | +| `shard` | [integer](./integer.md) |   | +| `to_node` | string | The node to move the shard to | diff --git a/docs/reference/api/ClusterRerouteRequest.md b/docs/reference/api/ClusterRerouteRequest.md new file mode 100644 index 000000000..707a95a51 --- /dev/null +++ b/docs/reference/api/ClusterRerouteRequest.md @@ -0,0 +1,13 @@ +## Interface `ClusterRerouteRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { dry_run?: never; explain?: never; metric?: never; retry_failed?: never; master_timeout?: never; timeout?: never; commands?: never; }) | All values in `body` will be added to the request body. | +| `commands` | [ClusterRerouteCommand](./ClusterRerouteCommand.md)[] | Defines the commands to perform. | +| `dry_run` | boolean | If true, then the request simulates the operation. It will calculate the result of applying the commands to the current cluster state and return the resulting cluster state after the commands (and rebalancing) have been applied; it will not actually perform the requested changes. | +| `explain` | boolean | If true, then the response contains an explanation of why the commands can or cannot run. | +| `master_timeout` | [Duration](./Duration.md) | Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. | +| `metric` | [Metrics](./Metrics.md) | Limits the information returned to the specified metrics. | +| `querystring` | { [key: string]: any; } & { dry_run?: never; explain?: never; metric?: never; retry_failed?: never; master_timeout?: never; timeout?: never; commands?: never; } | All values in `querystring` will be added to the request querystring. | +| `retry_failed` | boolean | If true, then retries allocation of shards that are blocked due to too many subsequent allocation failures. | +| `timeout` | [Duration](./Duration.md) | Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. | diff --git a/docs/reference/api/ClusterRerouteRerouteDecision.md b/docs/reference/api/ClusterRerouteRerouteDecision.md new file mode 100644 index 000000000..cf2e25a95 --- /dev/null +++ b/docs/reference/api/ClusterRerouteRerouteDecision.md @@ -0,0 +1,7 @@ +## Interface `ClusterRerouteRerouteDecision` + +| Name | Type | Description | +| - | - | - | +| `decider` | string |   | +| `decision` | string |   | +| `explanation` | string |   | diff --git a/docs/reference/api/ClusterRerouteRerouteExplanation.md b/docs/reference/api/ClusterRerouteRerouteExplanation.md new file mode 100644 index 000000000..e286414db --- /dev/null +++ b/docs/reference/api/ClusterRerouteRerouteExplanation.md @@ -0,0 +1,7 @@ +## Interface `ClusterRerouteRerouteExplanation` + +| Name | Type | Description | +| - | - | - | +| `command` | string |   | +| `decisions` | [ClusterRerouteRerouteDecision](./ClusterRerouteRerouteDecision.md)[] |   | +| `parameters` | [ClusterRerouteRerouteParameters](./ClusterRerouteRerouteParameters.md) |   | diff --git a/docs/reference/api/ClusterRerouteRerouteParameters.md b/docs/reference/api/ClusterRerouteRerouteParameters.md new file mode 100644 index 000000000..dd9dc04da --- /dev/null +++ b/docs/reference/api/ClusterRerouteRerouteParameters.md @@ -0,0 +1,10 @@ +## Interface `ClusterRerouteRerouteParameters` + +| Name | Type | Description | +| - | - | - | +| `allow_primary` | boolean |   | +| `from_node` | [NodeName](./NodeName.md) |   | +| `index` | [IndexName](./IndexName.md) |   | +| `node` | [NodeName](./NodeName.md) |   | +| `shard` | [integer](./integer.md) |   | +| `to_node` | [NodeName](./NodeName.md) |   | diff --git a/docs/reference/api/ClusterRerouteResponse.md b/docs/reference/api/ClusterRerouteResponse.md new file mode 100644 index 000000000..1ad5bc6d9 --- /dev/null +++ b/docs/reference/api/ClusterRerouteResponse.md @@ -0,0 +1,7 @@ +## Interface `ClusterRerouteResponse` + +| Name | Type | Description | +| - | - | - | +| `acknowledged` | boolean |   | +| `explanations` | [ClusterRerouteRerouteExplanation](./ClusterRerouteRerouteExplanation.md)[] |   | +| `state` | any | There aren't any guarantees on the output/structure of the raw cluster state. Here you will find the internal representation of the cluster, which can differ from the external representation. | diff --git a/docs/reference/api/ClusterSearchStatus.md b/docs/reference/api/ClusterSearchStatus.md new file mode 100644 index 000000000..68f553b97 --- /dev/null +++ b/docs/reference/api/ClusterSearchStatus.md @@ -0,0 +1,4 @@ +## `ClusterSearchStatus` +::: +type ClusterSearchStatus = 'running' | 'successful' | 'partial' | 'skipped' | 'failed'; +::: diff --git a/docs/reference/api/ClusterStateRequest.md b/docs/reference/api/ClusterStateRequest.md new file mode 100644 index 000000000..1184067c3 --- /dev/null +++ b/docs/reference/api/ClusterStateRequest.md @@ -0,0 +1,16 @@ +## Interface `ClusterStateRequest` + +| Name | Type | Description | +| - | - | - | +| `allow_no_indices` | boolean | Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) | +| `body` | string | ({ [key: string]: any; } & { metric?: never; index?: never; allow_no_indices?: never; expand_wildcards?: never; flat_settings?: never; ignore_unavailable?: never; local?: never; master_timeout?: never; wait_for_metadata_version?: never; wait_for_timeout?: never; }) | All values in `body` will be added to the request body. | +| `expand_wildcards` | [ExpandWildcards](./ExpandWildcards.md) | Whether to expand wildcard expression to concrete indices that are open, closed or both. | +| `flat_settings` | boolean | Return settings in flat format (default: false) | +| `ignore_unavailable` | boolean | Whether specified concrete indices should be ignored when unavailable (missing or closed) | +| `index` | [Indices](./Indices.md) | A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices | +| `local` | boolean | Return local information, do not retrieve the state from master node (default: false) | +| `master_timeout` | [Duration](./Duration.md) | Specify timeout for connection to master | +| `metric` | [Metrics](./Metrics.md) | Limit the information returned to the specified metrics | +| `querystring` | { [key: string]: any; } & { metric?: never; index?: never; allow_no_indices?: never; expand_wildcards?: never; flat_settings?: never; ignore_unavailable?: never; local?: never; master_timeout?: never; wait_for_metadata_version?: never; wait_for_timeout?: never; } | All values in `querystring` will be added to the request querystring. | +| `wait_for_metadata_version` | [VersionNumber](./VersionNumber.md) | Wait for the metadata version to be equal or greater than the specified metadata version | +| `wait_for_timeout` | [Duration](./Duration.md) | The maximum time to wait for wait_for_metadata_version before timing out | diff --git a/docs/reference/api/ClusterStateResponse.md b/docs/reference/api/ClusterStateResponse.md new file mode 100644 index 000000000..9547e4ce3 --- /dev/null +++ b/docs/reference/api/ClusterStateResponse.md @@ -0,0 +1,4 @@ +## `ClusterStateResponse` +::: +type ClusterStateResponse = any; +::: diff --git a/docs/reference/api/ClusterStatistics.md b/docs/reference/api/ClusterStatistics.md new file mode 100644 index 000000000..5e832fb17 --- /dev/null +++ b/docs/reference/api/ClusterStatistics.md @@ -0,0 +1,11 @@ +## Interface `ClusterStatistics` + +| Name | Type | Description | +| - | - | - | +| `details` | Record<[ClusterAlias](./ClusterAlias.md), [ClusterDetails](./ClusterDetails.md)> |   | +| `failed` | [integer](./integer.md) |   | +| `partial` | [integer](./integer.md) |   | +| `running` | [integer](./integer.md) |   | +| `skipped` | [integer](./integer.md) |   | +| `successful` | [integer](./integer.md) |   | +| `total` | [integer](./integer.md) |   | diff --git a/docs/reference/api/ClusterStatsCCSStats.md b/docs/reference/api/ClusterStatsCCSStats.md new file mode 100644 index 000000000..0a58e4f51 --- /dev/null +++ b/docs/reference/api/ClusterStatsCCSStats.md @@ -0,0 +1,7 @@ +## Interface `ClusterStatsCCSStats` + +| Name | Type | Description | +| - | - | - | +| `_esql` | [ClusterStatsCCSUsageStats](./ClusterStatsCCSUsageStats.md) | Information about ES|QL cross-cluster query usage. | +| `_search` | [ClusterStatsCCSUsageStats](./ClusterStatsCCSUsageStats.md) | Information about cross-cluster search usage. | +| `clusters` | Record | Contains remote cluster settings and metrics collected from them. The keys are cluster names, and the values are per-cluster data. Only present if `include_remotes` option is set to true. | diff --git a/docs/reference/api/ClusterStatsCCSUsageClusterStats.md b/docs/reference/api/ClusterStatsCCSUsageClusterStats.md new file mode 100644 index 000000000..bdd35c2fd --- /dev/null +++ b/docs/reference/api/ClusterStatsCCSUsageClusterStats.md @@ -0,0 +1,7 @@ +## Interface `ClusterStatsCCSUsageClusterStats` + +| Name | Type | Description | +| - | - | - | +| `skipped` | [integer](./integer.md) | The total number of cross-cluster search requests for which this cluster was skipped. | +| `took` | [ClusterStatsCCSUsageTimeValue](./ClusterStatsCCSUsageTimeValue.md) | Statistics about the time taken to execute requests against this cluster. | +| `total` | [integer](./integer.md) | The total number of successful (not skipped) cross-cluster search requests that were executed against this cluster. This may include requests where partial results were returned, but not requests in which the cluster has been skipped entirely. | diff --git a/docs/reference/api/ClusterStatsCCSUsageStats.md b/docs/reference/api/ClusterStatsCCSUsageStats.md new file mode 100644 index 000000000..734ef9f03 --- /dev/null +++ b/docs/reference/api/ClusterStatsCCSUsageStats.md @@ -0,0 +1,16 @@ +## Interface `ClusterStatsCCSUsageStats` + +| Name | Type | Description | +| - | - | - | +| `clients` | Record | Statistics about the clients that executed cross-cluster search requests. The keys are the names of the clients, and the values are the number of requests that were executed by that client. Only known clients (such as `kibana` or `elasticsearch`) are counted. | +| `clusters` | Record | Statistics about the clusters that were queried in cross-cluster search requests. The keys are cluster names, and the values are per-cluster telemetry data. This also includes the local cluster itself, which uses the name `(local)`. | +| `failure_reasons` | Record | Statistics about the reasons for cross-cluster search request failures. The keys are the failure reason names and the values are the number of requests that failed for that reason. | +| `features` | Record | The keys are the names of the search feature, and the values are the number of requests that used that feature. Single request can use more than one feature (e.g. both `async` and `wildcard`). | +| `remotes_per_search_avg` | [double](./double.md) | The average number of remote clusters that were queried in a single cross-cluster search request. | +| `remotes_per_search_max` | [integer](./integer.md) | The maximum number of remote clusters that were queried in a single cross-cluster search request. | +| `skipped` | [integer](./integer.md) | The total number of cross-cluster search requests (successful or failed) that had at least one remote cluster skipped. | +| `success` | [integer](./integer.md) | The total number of cross-cluster search requests that have been successfully executed by the cluster. | +| `took_mrt_false` | [ClusterStatsCCSUsageTimeValue](./ClusterStatsCCSUsageTimeValue.md) | Statistics about the time taken to execute cross-cluster search requests for which the `ccs_minimize_roundtrips` setting was set to `false`. | +| `took_mrt_true` | [ClusterStatsCCSUsageTimeValue](./ClusterStatsCCSUsageTimeValue.md) | Statistics about the time taken to execute cross-cluster search requests for which the `ccs_minimize_roundtrips` setting was set to `true`. | +| `took` | [ClusterStatsCCSUsageTimeValue](./ClusterStatsCCSUsageTimeValue.md) | Statistics about the time taken to execute cross-cluster search requests. | +| `total` | [integer](./integer.md) | The total number of cross-cluster search requests that have been executed by the cluster. | diff --git a/docs/reference/api/ClusterStatsCCSUsageTimeValue.md b/docs/reference/api/ClusterStatsCCSUsageTimeValue.md new file mode 100644 index 000000000..4413912a8 --- /dev/null +++ b/docs/reference/api/ClusterStatsCCSUsageTimeValue.md @@ -0,0 +1,7 @@ +## Interface `ClusterStatsCCSUsageTimeValue` + +| Name | Type | Description | +| - | - | - | +| `avg` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> | The average time taken to execute a request, in milliseconds. | +| `max` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> | The maximum time taken to execute a request, in milliseconds. | +| `p90` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> | The 90th percentile of the time taken to execute requests, in milliseconds. | diff --git a/docs/reference/api/ClusterStatsCharFilterTypes.md b/docs/reference/api/ClusterStatsCharFilterTypes.md new file mode 100644 index 000000000..e0bf5074c --- /dev/null +++ b/docs/reference/api/ClusterStatsCharFilterTypes.md @@ -0,0 +1,12 @@ +## Interface `ClusterStatsCharFilterTypes` + +| Name | Type | Description | +| - | - | - | +| `analyzer_types` | [ClusterStatsFieldTypes](./ClusterStatsFieldTypes.md)[] | Contains statistics about analyzer types used in selected nodes. | +| `built_in_analyzers` | [ClusterStatsFieldTypes](./ClusterStatsFieldTypes.md)[] | Contains statistics about built-in analyzers used in selected nodes. | +| `built_in_char_filters` | [ClusterStatsFieldTypes](./ClusterStatsFieldTypes.md)[] | Contains statistics about built-in character filters used in selected nodes. | +| `built_in_filters` | [ClusterStatsFieldTypes](./ClusterStatsFieldTypes.md)[] | Contains statistics about built-in token filters used in selected nodes. | +| `built_in_tokenizers` | [ClusterStatsFieldTypes](./ClusterStatsFieldTypes.md)[] | Contains statistics about built-in tokenizers used in selected nodes. | +| `char_filter_types` | [ClusterStatsFieldTypes](./ClusterStatsFieldTypes.md)[] | Contains statistics about character filter types used in selected nodes. | +| `filter_types` | [ClusterStatsFieldTypes](./ClusterStatsFieldTypes.md)[] | Contains statistics about token filter types used in selected nodes. | +| `tokenizer_types` | [ClusterStatsFieldTypes](./ClusterStatsFieldTypes.md)[] | Contains statistics about tokenizer types used in selected nodes. | diff --git a/docs/reference/api/ClusterStatsClusterFileSystem.md b/docs/reference/api/ClusterStatsClusterFileSystem.md new file mode 100644 index 000000000..917a05fa6 --- /dev/null +++ b/docs/reference/api/ClusterStatsClusterFileSystem.md @@ -0,0 +1,7 @@ +## Interface `ClusterStatsClusterFileSystem` + +| Name | Type | Description | +| - | - | - | +| `available_in_bytes` | [long](./long.md) | Total number of bytes available to JVM in file stores across all selected nodes. Depending on operating system or process-level restrictions, this number may be less than `nodes.fs.free_in_byes`. This is the actual amount of free disk space the selected Elasticsearch nodes can use. | +| `free_in_bytes` | [long](./long.md) | Total number of unallocated bytes in file stores across all selected nodes. | +| `total_in_bytes` | [long](./long.md) | Total size, in bytes, of all file stores across all selected nodes. | diff --git a/docs/reference/api/ClusterStatsClusterIndices.md b/docs/reference/api/ClusterStatsClusterIndices.md new file mode 100644 index 000000000..66ec0a701 --- /dev/null +++ b/docs/reference/api/ClusterStatsClusterIndices.md @@ -0,0 +1,15 @@ +## Interface `ClusterStatsClusterIndices` + +| Name | Type | Description | +| - | - | - | +| `analysis` | [ClusterStatsCharFilterTypes](./ClusterStatsCharFilterTypes.md) | Contains statistics about analyzers and analyzer components used in selected nodes. | +| `completion` | [CompletionStats](./CompletionStats.md) | Contains statistics about memory used for completion in selected nodes. | +| `count` | [long](./long.md) | Total number of indices with shards assigned to selected nodes. | +| `docs` | [DocStats](./DocStats.md) | Contains counts for documents in selected nodes. | +| `fielddata` | [FielddataStats](./FielddataStats.md) | Contains statistics about the field data cache of selected nodes. | +| `mappings` | [ClusterStatsFieldTypesMappings](./ClusterStatsFieldTypesMappings.md) | Contains statistics about field mappings in selected nodes. | +| `query_cache` | [QueryCacheStats](./QueryCacheStats.md) | Contains statistics about the query cache of selected nodes. | +| `segments` | [SegmentsStats](./SegmentsStats.md) | Contains statistics about segments in selected nodes. | +| `shards` | [ClusterStatsClusterIndicesShards](./ClusterStatsClusterIndicesShards.md) | Contains statistics about indices with shards assigned to selected nodes. | +| `store` | [StoreStats](./StoreStats.md) | Contains statistics about the size of shards assigned to selected nodes. | +| `versions` | [ClusterStatsIndicesVersions](./ClusterStatsIndicesVersions.md)[] | Contains statistics about analyzers and analyzer components used in selected nodes. | diff --git a/docs/reference/api/ClusterStatsClusterIndicesShards.md b/docs/reference/api/ClusterStatsClusterIndicesShards.md new file mode 100644 index 000000000..78c7ed6d3 --- /dev/null +++ b/docs/reference/api/ClusterStatsClusterIndicesShards.md @@ -0,0 +1,8 @@ +## Interface `ClusterStatsClusterIndicesShards` + +| Name | Type | Description | +| - | - | - | +| `index` | [ClusterStatsClusterIndicesShardsIndex](./ClusterStatsClusterIndicesShardsIndex.md) | Contains statistics about shards assigned to selected nodes. | +| `primaries` | [double](./double.md) | Number of primary shards assigned to selected nodes. | +| `replication` | [double](./double.md) | Ratio of replica shards to primary shards across all selected nodes. | +| `total` | [double](./double.md) | Total number of shards assigned to selected nodes. | diff --git a/docs/reference/api/ClusterStatsClusterIndicesShardsIndex.md b/docs/reference/api/ClusterStatsClusterIndicesShardsIndex.md new file mode 100644 index 000000000..ac1c50dcb --- /dev/null +++ b/docs/reference/api/ClusterStatsClusterIndicesShardsIndex.md @@ -0,0 +1,7 @@ +## Interface `ClusterStatsClusterIndicesShardsIndex` + +| Name | Type | Description | +| - | - | - | +| `primaries` | [ClusterStatsClusterShardMetrics](./ClusterStatsClusterShardMetrics.md) | Contains statistics about the number of primary shards assigned to selected nodes. | +| `replication` | [ClusterStatsClusterShardMetrics](./ClusterStatsClusterShardMetrics.md) | Contains statistics about the number of replication shards assigned to selected nodes. | +| `shards` | [ClusterStatsClusterShardMetrics](./ClusterStatsClusterShardMetrics.md) | Contains statistics about the number of shards assigned to selected nodes. | diff --git a/docs/reference/api/ClusterStatsClusterIngest.md b/docs/reference/api/ClusterStatsClusterIngest.md new file mode 100644 index 000000000..cf7dfa331 --- /dev/null +++ b/docs/reference/api/ClusterStatsClusterIngest.md @@ -0,0 +1,6 @@ +## Interface `ClusterStatsClusterIngest` + +| Name | Type | Description | +| - | - | - | +| `number_of_pipelines` | [integer](./integer.md) |   | +| `processor_stats` | Record |   | diff --git a/docs/reference/api/ClusterStatsClusterJvm.md b/docs/reference/api/ClusterStatsClusterJvm.md new file mode 100644 index 000000000..0c4eeec3b --- /dev/null +++ b/docs/reference/api/ClusterStatsClusterJvm.md @@ -0,0 +1,8 @@ +## Interface `ClusterStatsClusterJvm` + +| Name | Type | Description | +| - | - | - | +| `max_uptime_in_millis` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> | Uptime duration, in milliseconds, since JVM last started. | +| `mem` | [ClusterStatsClusterJvmMemory](./ClusterStatsClusterJvmMemory.md) | Contains statistics about memory used by selected nodes. | +| `threads` | [long](./long.md) | Number of active threads in use by JVM across all selected nodes. | +| `versions` | [ClusterStatsClusterJvmVersion](./ClusterStatsClusterJvmVersion.md)[] | Contains statistics about the JVM versions used by selected nodes. | diff --git a/docs/reference/api/ClusterStatsClusterJvmMemory.md b/docs/reference/api/ClusterStatsClusterJvmMemory.md new file mode 100644 index 000000000..d69f5cda6 --- /dev/null +++ b/docs/reference/api/ClusterStatsClusterJvmMemory.md @@ -0,0 +1,6 @@ +## Interface `ClusterStatsClusterJvmMemory` + +| Name | Type | Description | +| - | - | - | +| `heap_max_in_bytes` | [long](./long.md) | Maximum amount of memory, in bytes, available for use by the heap across all selected nodes. | +| `heap_used_in_bytes` | [long](./long.md) | Memory, in bytes, currently in use by the heap across all selected nodes. | diff --git a/docs/reference/api/ClusterStatsClusterJvmVersion.md b/docs/reference/api/ClusterStatsClusterJvmVersion.md new file mode 100644 index 000000000..cb3cc4487 --- /dev/null +++ b/docs/reference/api/ClusterStatsClusterJvmVersion.md @@ -0,0 +1,11 @@ +## Interface `ClusterStatsClusterJvmVersion` + +| Name | Type | Description | +| - | - | - | +| `bundled_jdk` | boolean | Always `true`. All distributions come with a bundled Java Development Kit (JDK). | +| `count` | [integer](./integer.md) | Total number of selected nodes using JVM. | +| `using_bundled_jdk` | boolean | If `true`, a bundled JDK is in use by JVM. | +| `version` | [VersionString](./VersionString.md) | Version of JVM used by one or more selected nodes. | +| `vm_name` | string | Name of the JVM. | +| `vm_vendor` | string | Vendor of the JVM. | +| `vm_version` | [VersionString](./VersionString.md) | Full version number of JVM. The full version number includes a plus sign (+) followed by the build number. | diff --git a/docs/reference/api/ClusterStatsClusterNetworkTypes.md b/docs/reference/api/ClusterStatsClusterNetworkTypes.md new file mode 100644 index 000000000..72e8d4d62 --- /dev/null +++ b/docs/reference/api/ClusterStatsClusterNetworkTypes.md @@ -0,0 +1,6 @@ +## Interface `ClusterStatsClusterNetworkTypes` + +| Name | Type | Description | +| - | - | - | +| `http_types` | Record | Contains statistics about the HTTP network types used by selected nodes. | +| `transport_types` | Record | Contains statistics about the transport network types used by selected nodes. | diff --git a/docs/reference/api/ClusterStatsClusterNodeCount.md b/docs/reference/api/ClusterStatsClusterNodeCount.md new file mode 100644 index 000000000..b5fc06dfa --- /dev/null +++ b/docs/reference/api/ClusterStatsClusterNodeCount.md @@ -0,0 +1,18 @@ +## Interface `ClusterStatsClusterNodeCount` + +| Name | Type | Description | +| - | - | - | +| `coordinating_only` | [integer](./integer.md) |   | +| `data_cold` | [integer](./integer.md) |   | +| `data_content` | [integer](./integer.md) |   | +| `data_frozen` | [integer](./integer.md) |   | +| `data_hot` | [integer](./integer.md) |   | +| `data_warm` | [integer](./integer.md) |   | +| `data` | [integer](./integer.md) |   | +| `ingest` | [integer](./integer.md) |   | +| `master` | [integer](./integer.md) |   | +| `ml` | [integer](./integer.md) |   | +| `remote_cluster_client` | [integer](./integer.md) |   | +| `total` | [integer](./integer.md) |   | +| `transform` | [integer](./integer.md) |   | +| `voting_only` | [integer](./integer.md) |   | diff --git a/docs/reference/api/ClusterStatsClusterNodes.md b/docs/reference/api/ClusterStatsClusterNodes.md new file mode 100644 index 000000000..08b17c9ad --- /dev/null +++ b/docs/reference/api/ClusterStatsClusterNodes.md @@ -0,0 +1,16 @@ +## Interface `ClusterStatsClusterNodes` + +| Name | Type | Description | +| - | - | - | +| `count` | [ClusterStatsClusterNodeCount](./ClusterStatsClusterNodeCount.md) | Contains counts for nodes selected by the request’s node filters. | +| `discovery_types` | Record | Contains statistics about the discovery types used by selected nodes. | +| `fs` | [ClusterStatsClusterFileSystem](./ClusterStatsClusterFileSystem.md) | Contains statistics about file stores by selected nodes. | +| `indexing_pressure` | [ClusterStatsIndexingPressure](./ClusterStatsIndexingPressure.md) |   | +| `ingest` | [ClusterStatsClusterIngest](./ClusterStatsClusterIngest.md) |   | +| `jvm` | [ClusterStatsClusterJvm](./ClusterStatsClusterJvm.md) | Contains statistics about the Java Virtual Machines (JVMs) used by selected nodes. | +| `network_types` | [ClusterStatsClusterNetworkTypes](./ClusterStatsClusterNetworkTypes.md) | Contains statistics about the transport and HTTP networks used by selected nodes. | +| `os` | [ClusterStatsClusterOperatingSystem](./ClusterStatsClusterOperatingSystem.md) | Contains statistics about the operating systems used by selected nodes. | +| `packaging_types` | [ClusterStatsNodePackagingType](./ClusterStatsNodePackagingType.md)[] | Contains statistics about Elasticsearch distributions installed on selected nodes. | +| `plugins` | [PluginStats](./PluginStats.md)[] | Contains statistics about installed plugins and modules by selected nodes. If no plugins or modules are installed, this array is empty. | +| `process` | [ClusterStatsClusterProcess](./ClusterStatsClusterProcess.md) | Contains statistics about processes used by selected nodes. | +| `versions` | [VersionString](./VersionString.md)[] | Array of Elasticsearch versions used on selected nodes. | diff --git a/docs/reference/api/ClusterStatsClusterOperatingSystem.md b/docs/reference/api/ClusterStatsClusterOperatingSystem.md new file mode 100644 index 000000000..86eda33e2 --- /dev/null +++ b/docs/reference/api/ClusterStatsClusterOperatingSystem.md @@ -0,0 +1,10 @@ +## Interface `ClusterStatsClusterOperatingSystem` + +| Name | Type | Description | +| - | - | - | +| `allocated_processors` | [integer](./integer.md) | Number of processors used to calculate thread pool size across all selected nodes. This number can be set with the processors setting of a node and defaults to the number of processors reported by the operating system. In both cases, this number will never be larger than 32. | +| `architectures` | [ClusterStatsClusterOperatingSystemArchitecture](./ClusterStatsClusterOperatingSystemArchitecture.md)[] | Contains statistics about processor architectures (for example, x86_64 or aarch64) used by selected nodes. | +| `available_processors` | [integer](./integer.md) | Number of processors available to JVM across all selected nodes. | +| `mem` | [ClusterStatsOperatingSystemMemoryInfo](./ClusterStatsOperatingSystemMemoryInfo.md) | Contains statistics about memory used by selected nodes. | +| `names` | [ClusterStatsClusterOperatingSystemName](./ClusterStatsClusterOperatingSystemName.md)[] | Contains statistics about operating systems used by selected nodes. | +| `pretty_names` | [ClusterStatsClusterOperatingSystemPrettyName](./ClusterStatsClusterOperatingSystemPrettyName.md)[] | Contains statistics about operating systems used by selected nodes. | diff --git a/docs/reference/api/ClusterStatsClusterOperatingSystemArchitecture.md b/docs/reference/api/ClusterStatsClusterOperatingSystemArchitecture.md new file mode 100644 index 000000000..05146ea60 --- /dev/null +++ b/docs/reference/api/ClusterStatsClusterOperatingSystemArchitecture.md @@ -0,0 +1,6 @@ +## Interface `ClusterStatsClusterOperatingSystemArchitecture` + +| Name | Type | Description | +| - | - | - | +| `arch` | string | Name of an architecture used by one or more selected nodes. | +| `count` | [integer](./integer.md) | Number of selected nodes using the architecture. | diff --git a/docs/reference/api/ClusterStatsClusterOperatingSystemName.md b/docs/reference/api/ClusterStatsClusterOperatingSystemName.md new file mode 100644 index 000000000..369fa472b --- /dev/null +++ b/docs/reference/api/ClusterStatsClusterOperatingSystemName.md @@ -0,0 +1,6 @@ +## Interface `ClusterStatsClusterOperatingSystemName` + +| Name | Type | Description | +| - | - | - | +| `count` | [integer](./integer.md) | Number of selected nodes using the operating system. | +| `name` | [Name](./Name.md) | Name of an operating system used by one or more selected nodes. | diff --git a/docs/reference/api/ClusterStatsClusterOperatingSystemPrettyName.md b/docs/reference/api/ClusterStatsClusterOperatingSystemPrettyName.md new file mode 100644 index 000000000..c6c44d6c0 --- /dev/null +++ b/docs/reference/api/ClusterStatsClusterOperatingSystemPrettyName.md @@ -0,0 +1,6 @@ +## Interface `ClusterStatsClusterOperatingSystemPrettyName` + +| Name | Type | Description | +| - | - | - | +| `count` | [integer](./integer.md) | Number of selected nodes using the operating system. | +| `pretty_name` | [Name](./Name.md) | Human-readable name of an operating system used by one or more selected nodes. | diff --git a/docs/reference/api/ClusterStatsClusterProcess.md b/docs/reference/api/ClusterStatsClusterProcess.md new file mode 100644 index 000000000..1c4b529bd --- /dev/null +++ b/docs/reference/api/ClusterStatsClusterProcess.md @@ -0,0 +1,6 @@ +## Interface `ClusterStatsClusterProcess` + +| Name | Type | Description | +| - | - | - | +| `cpu` | [ClusterStatsClusterProcessCpu](./ClusterStatsClusterProcessCpu.md) | Contains statistics about CPU used by selected nodes. | +| `open_file_descriptors` | [ClusterStatsClusterProcessOpenFileDescriptors](./ClusterStatsClusterProcessOpenFileDescriptors.md) | Contains statistics about open file descriptors in selected nodes. | diff --git a/docs/reference/api/ClusterStatsClusterProcessCpu.md b/docs/reference/api/ClusterStatsClusterProcessCpu.md new file mode 100644 index 000000000..248af65b5 --- /dev/null +++ b/docs/reference/api/ClusterStatsClusterProcessCpu.md @@ -0,0 +1,5 @@ +## Interface `ClusterStatsClusterProcessCpu` + +| Name | Type | Description | +| - | - | - | +| `percent` | [integer](./integer.md) | Percentage of CPU used across all selected nodes. Returns `-1` if not supported. | diff --git a/docs/reference/api/ClusterStatsClusterProcessOpenFileDescriptors.md b/docs/reference/api/ClusterStatsClusterProcessOpenFileDescriptors.md new file mode 100644 index 000000000..3a280bd1e --- /dev/null +++ b/docs/reference/api/ClusterStatsClusterProcessOpenFileDescriptors.md @@ -0,0 +1,7 @@ +## Interface `ClusterStatsClusterProcessOpenFileDescriptors` + +| Name | Type | Description | +| - | - | - | +| `avg` | [long](./long.md) | Average number of concurrently open file descriptors. Returns `-1` if not supported. | +| `max` | [long](./long.md) | Maximum number of concurrently open file descriptors allowed across all selected nodes. Returns `-1` if not supported. | +| `min` | [long](./long.md) | Minimum number of concurrently open file descriptors across all selected nodes. Returns -1 if not supported. | diff --git a/docs/reference/api/ClusterStatsClusterProcessor.md b/docs/reference/api/ClusterStatsClusterProcessor.md new file mode 100644 index 000000000..e32f063de --- /dev/null +++ b/docs/reference/api/ClusterStatsClusterProcessor.md @@ -0,0 +1,9 @@ +## Interface `ClusterStatsClusterProcessor` + +| Name | Type | Description | +| - | - | - | +| `count` | [long](./long.md) |   | +| `current` | [long](./long.md) |   | +| `failed` | [long](./long.md) |   | +| `time_in_millis` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> |   | +| `time` | [Duration](./Duration.md) |   | diff --git a/docs/reference/api/ClusterStatsClusterShardMetrics.md b/docs/reference/api/ClusterStatsClusterShardMetrics.md new file mode 100644 index 000000000..48f26eb94 --- /dev/null +++ b/docs/reference/api/ClusterStatsClusterShardMetrics.md @@ -0,0 +1,7 @@ +## Interface `ClusterStatsClusterShardMetrics` + +| Name | Type | Description | +| - | - | - | +| `avg` | [double](./double.md) | Mean number of shards in an index, counting only shards assigned to selected nodes. | +| `max` | [double](./double.md) | Maximum number of shards in an index, counting only shards assigned to selected nodes. | +| `min` | [double](./double.md) | Minimum number of shards in an index, counting only shards assigned to selected nodes. | diff --git a/docs/reference/api/ClusterStatsFieldTypes.md b/docs/reference/api/ClusterStatsFieldTypes.md new file mode 100644 index 000000000..8abdf32e2 --- /dev/null +++ b/docs/reference/api/ClusterStatsFieldTypes.md @@ -0,0 +1,11 @@ +## Interface `ClusterStatsFieldTypes` + +| Name | Type | Description | +| - | - | - | +| `count` | [integer](./integer.md) | The number of occurrences of the field type in selected nodes. | +| `index_count` | [integer](./integer.md) | The number of indices containing the field type in selected nodes. | +| `indexed_vector_count` | [long](./long.md) | For dense_vector field types, number of indexed vector types in selected nodes. | +| `indexed_vector_dim_max` | [long](./long.md) | For dense_vector field types, the maximum dimension of all indexed vector types in selected nodes. | +| `indexed_vector_dim_min` | [long](./long.md) | For dense_vector field types, the minimum dimension of all indexed vector types in selected nodes. | +| `name` | [Name](./Name.md) | The name for the field type in selected nodes. | +| `script_count` | [integer](./integer.md) | The number of fields that declare a script. | diff --git a/docs/reference/api/ClusterStatsFieldTypesMappings.md b/docs/reference/api/ClusterStatsFieldTypesMappings.md new file mode 100644 index 000000000..5e21af46d --- /dev/null +++ b/docs/reference/api/ClusterStatsFieldTypesMappings.md @@ -0,0 +1,10 @@ +## Interface `ClusterStatsFieldTypesMappings` + +| Name | Type | Description | +| - | - | - | +| `field_types` | [ClusterStatsFieldTypes](./ClusterStatsFieldTypes.md)[] | Contains statistics about field data types used in selected nodes. | +| `runtime_field_types` | [ClusterStatsRuntimeFieldTypes](./ClusterStatsRuntimeFieldTypes.md)[] | Contains statistics about runtime field data types used in selected nodes. | +| `total_deduplicated_field_count` | [integer](./integer.md) | Total number of fields in all non-system indices, accounting for mapping deduplication. | +| `total_deduplicated_mapping_size_in_bytes` | [long](./long.md) | Total size of all mappings, in bytes, after deduplication and compression. | +| `total_deduplicated_mapping_size` | [ByteSize](./ByteSize.md) | Total size of all mappings after deduplication and compression. | +| `total_field_count` | [integer](./integer.md) | Total number of fields in all non-system indices. | diff --git a/docs/reference/api/ClusterStatsIndexingPressure.md b/docs/reference/api/ClusterStatsIndexingPressure.md new file mode 100644 index 000000000..a7f5a7b9e --- /dev/null +++ b/docs/reference/api/ClusterStatsIndexingPressure.md @@ -0,0 +1,5 @@ +## Interface `ClusterStatsIndexingPressure` + +| Name | Type | Description | +| - | - | - | +| `memory` | [ClusterStatsIndexingPressureMemory](./ClusterStatsIndexingPressureMemory.md) |   | diff --git a/docs/reference/api/ClusterStatsIndexingPressureMemory.md b/docs/reference/api/ClusterStatsIndexingPressureMemory.md new file mode 100644 index 000000000..cb0db93ad --- /dev/null +++ b/docs/reference/api/ClusterStatsIndexingPressureMemory.md @@ -0,0 +1,7 @@ +## Interface `ClusterStatsIndexingPressureMemory` + +| Name | Type | Description | +| - | - | - | +| `current` | [ClusterStatsIndexingPressureMemorySummary](./ClusterStatsIndexingPressureMemorySummary.md) |   | +| `limit_in_bytes` | [long](./long.md) |   | +| `total` | [ClusterStatsIndexingPressureMemorySummary](./ClusterStatsIndexingPressureMemorySummary.md) |   | diff --git a/docs/reference/api/ClusterStatsIndexingPressureMemorySummary.md b/docs/reference/api/ClusterStatsIndexingPressureMemorySummary.md new file mode 100644 index 000000000..d38f53b99 --- /dev/null +++ b/docs/reference/api/ClusterStatsIndexingPressureMemorySummary.md @@ -0,0 +1,12 @@ +## Interface `ClusterStatsIndexingPressureMemorySummary` + +| Name | Type | Description | +| - | - | - | +| `all_in_bytes` | [long](./long.md) |   | +| `combined_coordinating_and_primary_in_bytes` | [long](./long.md) |   | +| `coordinating_in_bytes` | [long](./long.md) |   | +| `coordinating_rejections` | [long](./long.md) |   | +| `primary_in_bytes` | [long](./long.md) |   | +| `primary_rejections` | [long](./long.md) |   | +| `replica_in_bytes` | [long](./long.md) |   | +| `replica_rejections` | [long](./long.md) |   | diff --git a/docs/reference/api/ClusterStatsIndicesVersions.md b/docs/reference/api/ClusterStatsIndicesVersions.md new file mode 100644 index 000000000..9ef4a0f8e --- /dev/null +++ b/docs/reference/api/ClusterStatsIndicesVersions.md @@ -0,0 +1,8 @@ +## Interface `ClusterStatsIndicesVersions` + +| Name | Type | Description | +| - | - | - | +| `index_count` | [integer](./integer.md) |   | +| `primary_shard_count` | [integer](./integer.md) |   | +| `total_primary_bytes` | [long](./long.md) |   | +| `version` | [VersionString](./VersionString.md) |   | diff --git a/docs/reference/api/ClusterStatsNodePackagingType.md b/docs/reference/api/ClusterStatsNodePackagingType.md new file mode 100644 index 000000000..6317947a9 --- /dev/null +++ b/docs/reference/api/ClusterStatsNodePackagingType.md @@ -0,0 +1,7 @@ +## Interface `ClusterStatsNodePackagingType` + +| Name | Type | Description | +| - | - | - | +| `count` | [integer](./integer.md) | Number of selected nodes using the distribution flavor and file type. | +| `flavor` | string | Type of Elasticsearch distribution. This is always `default`. | +| `type` | string | File type (such as `tar` or `zip`) used for the distribution package. | diff --git a/docs/reference/api/ClusterStatsOperatingSystemMemoryInfo.md b/docs/reference/api/ClusterStatsOperatingSystemMemoryInfo.md new file mode 100644 index 000000000..e3b6e18f6 --- /dev/null +++ b/docs/reference/api/ClusterStatsOperatingSystemMemoryInfo.md @@ -0,0 +1,10 @@ +## Interface `ClusterStatsOperatingSystemMemoryInfo` + +| Name | Type | Description | +| - | - | - | +| `adjusted_total_in_bytes` | [long](./long.md) | Total amount, in bytes, of memory across all selected nodes, but using the value specified using the `es.total_memory_bytes` system property instead of measured total memory for those nodes where that system property was set. | +| `free_in_bytes` | [long](./long.md) | Amount, in bytes, of free physical memory across all selected nodes. | +| `free_percent` | [integer](./integer.md) | Percentage of free physical memory across all selected nodes. | +| `total_in_bytes` | [long](./long.md) | Total amount, in bytes, of physical memory across all selected nodes. | +| `used_in_bytes` | [long](./long.md) | Amount, in bytes, of physical memory in use across all selected nodes. | +| `used_percent` | [integer](./integer.md) | Percentage of physical memory in use across all selected nodes. | diff --git a/docs/reference/api/ClusterStatsRemoteClusterInfo.md b/docs/reference/api/ClusterStatsRemoteClusterInfo.md new file mode 100644 index 000000000..c3b5ac2ab --- /dev/null +++ b/docs/reference/api/ClusterStatsRemoteClusterInfo.md @@ -0,0 +1,19 @@ +## Interface `ClusterStatsRemoteClusterInfo` + +| Name | Type | Description | +| - | - | - | +| `cluster_uuid` | string | The UUID of the remote cluster. | +| `indices_count` | [integer](./integer.md) | The total number of indices in the remote cluster. | +| `indices_total_size_in_bytes` | [long](./long.md) | Total data set size, in bytes, of all shards assigned to selected nodes. | +| `indices_total_size` | string | Total data set size of all shards assigned to selected nodes, as a human-readable string. | +| `max_heap_in_bytes` | [long](./long.md) | Maximum amount of memory, in bytes, available for use by the heap across the nodes of the remote cluster. | +| `max_heap` | string | Maximum amount of memory available for use by the heap across the nodes of the remote cluster, as a human-readable string. | +| `mem_total_in_bytes` | [long](./long.md) | Total amount, in bytes, of physical memory across the nodes of the remote cluster. | +| `mem_total` | string | Total amount of physical memory across the nodes of the remote cluster, as a human-readable string. | +| `mode` | string | The connection mode used to communicate with the remote cluster. | +| `nodes_count` | [integer](./integer.md) | The total count of nodes in the remote cluster. | +| `shards_count` | [integer](./integer.md) | The total number of shards in the remote cluster. | +| `skip_unavailable` | boolean | The `skip_unavailable` setting used for this remote cluster. | +| `status` | [HealthStatus](./HealthStatus.md) | Health status of the cluster, based on the state of its primary and replica shards. | +| `transport_compress` | string | Transport compression setting used for this remote cluster. | +| `version` | [VersionString](./VersionString.md)[] | The list of Elasticsearch versions used by the nodes on the remote cluster. | diff --git a/docs/reference/api/ClusterStatsRequest.md b/docs/reference/api/ClusterStatsRequest.md new file mode 100644 index 000000000..b088600c3 --- /dev/null +++ b/docs/reference/api/ClusterStatsRequest.md @@ -0,0 +1,9 @@ +## Interface `ClusterStatsRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { node_id?: never; include_remotes?: never; timeout?: never; }) | All values in `body` will be added to the request body. | +| `include_remotes` | boolean | Include remote cluster data into the response | +| `node_id` | [NodeIds](./NodeIds.md) | Comma-separated list of node filters used to limit returned information. Defaults to all nodes in the cluster. | +| `querystring` | { [key: string]: any; } & { node_id?: never; include_remotes?: never; timeout?: never; } | All values in `querystring` will be added to the request querystring. | +| `timeout` | [Duration](./Duration.md) | Period to wait for each node to respond. If a node does not respond before its timeout expires, the response does not include its stats. However, timed out nodes are included in the response’s `_nodes.failed` property. Defaults to no timeout. | diff --git a/docs/reference/api/ClusterStatsResponse.md b/docs/reference/api/ClusterStatsResponse.md new file mode 100644 index 000000000..c2d4967a3 --- /dev/null +++ b/docs/reference/api/ClusterStatsResponse.md @@ -0,0 +1,4 @@ +## `ClusterStatsResponse` +::: +type ClusterStatsResponse = [ClusterStatsStatsResponseBase](./ClusterStatsStatsResponseBase.md); +::: diff --git a/docs/reference/api/ClusterStatsRuntimeFieldTypes.md b/docs/reference/api/ClusterStatsRuntimeFieldTypes.md new file mode 100644 index 000000000..0d76f6794 --- /dev/null +++ b/docs/reference/api/ClusterStatsRuntimeFieldTypes.md @@ -0,0 +1,18 @@ +## Interface `ClusterStatsRuntimeFieldTypes` + +| Name | Type | Description | +| - | - | - | +| `chars_max` | [integer](./integer.md) | Maximum number of characters for a single runtime field script. | +| `chars_total` | [integer](./integer.md) | Total number of characters for the scripts that define the current runtime field data type. | +| `count` | [integer](./integer.md) | Number of runtime fields mapped to the field data type in selected nodes. | +| `doc_max` | [integer](./integer.md) | Maximum number of accesses to doc_values for a single runtime field script | +| `doc_total` | [integer](./integer.md) | Total number of accesses to doc_values for the scripts that define the current runtime field data type. | +| `index_count` | [integer](./integer.md) | Number of indices containing a mapping of the runtime field data type in selected nodes. | +| `lang` | string[] | Script languages used for the runtime fields scripts. | +| `lines_max` | [integer](./integer.md) | Maximum number of lines for a single runtime field script. | +| `lines_total` | [integer](./integer.md) | Total number of lines for the scripts that define the current runtime field data type. | +| `name` | [Name](./Name.md) | Field data type used in selected nodes. | +| `scriptless_count` | [integer](./integer.md) | Number of runtime fields that don’t declare a script. | +| `shadowed_count` | [integer](./integer.md) | Number of runtime fields that shadow an indexed field. | +| `source_max` | [integer](./integer.md) | Maximum number of accesses to _source for a single runtime field script. | +| `source_total` | [integer](./integer.md) | Total number of accesses to _source for the scripts that define the current runtime field data type. | diff --git a/docs/reference/api/ClusterStatsStatsResponseBase.md b/docs/reference/api/ClusterStatsStatsResponseBase.md new file mode 100644 index 000000000..d53ecbca3 --- /dev/null +++ b/docs/reference/api/ClusterStatsStatsResponseBase.md @@ -0,0 +1,11 @@ +## Interface `ClusterStatsStatsResponseBase` + +| Name | Type | Description | +| - | - | - | +| `ccs` | [ClusterStatsCCSStats](./ClusterStatsCCSStats.md) | Cross-cluster stats | +| `cluster_name` | [Name](./Name.md) | Name of the cluster, based on the cluster name setting. | +| `cluster_uuid` | [Uuid](./Uuid.md) | Unique identifier for the cluster. | +| `indices` | [ClusterStatsClusterIndices](./ClusterStatsClusterIndices.md) | Contains statistics about indices with shards assigned to selected nodes. | +| `nodes` | [ClusterStatsClusterNodes](./ClusterStatsClusterNodes.md) | Contains statistics about nodes selected by the request’s node filters. | +| `status` | [HealthStatus](./HealthStatus.md) | Health status of the cluster, based on the state of its primary and replica shards. | +| `timestamp` | [long](./long.md) | Unix timestamp, in milliseconds, for the last time the cluster statistics were refreshed. | diff --git a/docs/reference/api/CompletionStats.md b/docs/reference/api/CompletionStats.md new file mode 100644 index 000000000..5a3778d97 --- /dev/null +++ b/docs/reference/api/CompletionStats.md @@ -0,0 +1,7 @@ +## Interface `CompletionStats` + +| Name | Type | Description | +| - | - | - | +| `fields` | Record<[Field](./Field.md), [FieldSizeUsage](./FieldSizeUsage.md)> |   | +| `size_in_bytes` | [long](./long.md) | Total amount, in bytes, of memory used for completion across all shards assigned to selected nodes. | +| `size` | [ByteSize](./ByteSize.md) | Total amount of memory used for completion across all shards assigned to selected nodes. | diff --git a/docs/reference/api/Conflicts.md b/docs/reference/api/Conflicts.md new file mode 100644 index 000000000..f7ae441c0 --- /dev/null +++ b/docs/reference/api/Conflicts.md @@ -0,0 +1,4 @@ +## `Conflicts` +::: +type Conflicts = 'abort' | 'proceed'; +::: diff --git a/docs/reference/api/Connector.md b/docs/reference/api/Connector.md new file mode 100644 index 000000000..07777ae5c --- /dev/null +++ b/docs/reference/api/Connector.md @@ -0,0 +1,20 @@ +## `Connector` + +### Constructor + +::: +new Connector(transport: [Transport](./Transport.md)); +::: + +### Properties + +| Name | Type | Description | +| - | - | - | +| `acceptedParams` | Record |   | +| `transport` | [Transport](./Transport.md) |   | + +### Methods + +| Name | Signature | Description | +| - | - | - | +| `checkIn` | `checkIn(this: [That](./That.md), params: [ConnectorCheckInRequest](./ConnectorCheckInRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorCheckInResponse](./ConnectorCheckInResponse.md)>;` | Check in a connector. Update the `last_seen` field in the connector and set it to the current timestamp. || `checkIn` | `checkIn(this: [That](./That.md), params: [ConnectorCheckInRequest](./ConnectorCheckInRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorCheckInResponse](./ConnectorCheckInResponse.md), unknown>>;` |   || `checkIn` | `checkIn(this: [That](./That.md), params: [ConnectorCheckInRequest](./ConnectorCheckInRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorCheckInResponse](./ConnectorCheckInResponse.md)>;` |   || `delete` | `delete(this: [That](./That.md), params: [ConnectorDeleteRequest](./ConnectorDeleteRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorDeleteResponse](./ConnectorDeleteResponse.md)>;` | Delete a connector. Removes a connector and associated sync jobs. This is a destructive action that is not recoverable. NOTE: This action doesn’t delete any API keys, ingest pipelines, or data indices associated with the connector. These need to be removed manually. || `delete` | `delete(this: [That](./That.md), params: [ConnectorDeleteRequest](./ConnectorDeleteRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorDeleteResponse](./ConnectorDeleteResponse.md), unknown>>;` |   || `delete` | `delete(this: [That](./That.md), params: [ConnectorDeleteRequest](./ConnectorDeleteRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorDeleteResponse](./ConnectorDeleteResponse.md)>;` |   || `get` | `get(this: [That](./That.md), params: [ConnectorGetRequest](./ConnectorGetRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorGetResponse](./ConnectorGetResponse.md)>;` | Get a connector. Get the details about a connector. || `get` | `get(this: [That](./That.md), params: [ConnectorGetRequest](./ConnectorGetRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorGetResponse](./ConnectorGetResponse.md), unknown>>;` |   || `get` | `get(this: [That](./That.md), params: [ConnectorGetRequest](./ConnectorGetRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorGetResponse](./ConnectorGetResponse.md)>;` |   || `lastSync` | `lastSync(this: [That](./That.md), params: [ConnectorLastSyncRequest](./ConnectorLastSyncRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorLastSyncResponse](./ConnectorLastSyncResponse.md)>;` | Update the connector last sync stats. Update the fields related to the last sync of a connector. This action is used for analytics and monitoring. || `lastSync` | `lastSync(this: [That](./That.md), params: [ConnectorLastSyncRequest](./ConnectorLastSyncRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorLastSyncResponse](./ConnectorLastSyncResponse.md), unknown>>;` |   || `lastSync` | `lastSync(this: [That](./That.md), params: [ConnectorLastSyncRequest](./ConnectorLastSyncRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorLastSyncResponse](./ConnectorLastSyncResponse.md)>;` |   || `list` | `list(this: [That](./That.md), params?: [ConnectorListRequest](./ConnectorListRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorListResponse](./ConnectorListResponse.md)>;` | Get all connectors. Get information about all connectors. || `list` | `list(this: [That](./That.md), params?: [ConnectorListRequest](./ConnectorListRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorListResponse](./ConnectorListResponse.md), unknown>>;` |   || `list` | `list(this: [That](./That.md), params?: [ConnectorListRequest](./ConnectorListRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorListResponse](./ConnectorListResponse.md)>;` |   || `post` | `post(this: [That](./That.md), params?: [ConnectorPostRequest](./ConnectorPostRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorPostResponse](./ConnectorPostResponse.md)>;` | Create a connector. Connectors are Elasticsearch integrations that bring content from third-party data sources, which can be deployed on Elastic Cloud or hosted on your own infrastructure. Elastic managed connectors (Native connectors) are a managed service on Elastic Cloud. Self-managed connectors (Connector clients) are self-managed on your infrastructure. || `post` | `post(this: [That](./That.md), params?: [ConnectorPostRequest](./ConnectorPostRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorPostResponse](./ConnectorPostResponse.md), unknown>>;` |   || `post` | `post(this: [That](./That.md), params?: [ConnectorPostRequest](./ConnectorPostRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorPostResponse](./ConnectorPostResponse.md)>;` |   || `put` | `put(this: [That](./That.md), params?: [ConnectorPutRequest](./ConnectorPutRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorPutResponse](./ConnectorPutResponse.md)>;` | Create or update a connector. || `put` | `put(this: [That](./That.md), params?: [ConnectorPutRequest](./ConnectorPutRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorPutResponse](./ConnectorPutResponse.md), unknown>>;` |   || `put` | `put(this: [That](./That.md), params?: [ConnectorPutRequest](./ConnectorPutRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorPutResponse](./ConnectorPutResponse.md)>;` |   || `secretDelete` | `secretDelete(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TODO](./TODO.md)>;` | Deletes a connector secret. || `secretDelete` | `secretDelete(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TODO](./TODO.md), unknown>>;` |   || `secretDelete` | `secretDelete(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TODO](./TODO.md)>;` |   || `secretGet` | `secretGet(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TODO](./TODO.md)>;` | Retrieves a secret stored by Connectors. || `secretGet` | `secretGet(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TODO](./TODO.md), unknown>>;` |   || `secretGet` | `secretGet(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TODO](./TODO.md)>;` |   || `secretPost` | `secretPost(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TODO](./TODO.md)>;` | Creates a secret for a Connector. || `secretPost` | `secretPost(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TODO](./TODO.md), unknown>>;` |   || `secretPost` | `secretPost(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TODO](./TODO.md)>;` |   || `secretPut` | `secretPut(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TODO](./TODO.md)>;` | Creates or updates a secret for a Connector. || `secretPut` | `secretPut(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TODO](./TODO.md), unknown>>;` |   || `secretPut` | `secretPut(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TODO](./TODO.md)>;` |   || `syncJobCancel` | `syncJobCancel(this: [That](./That.md), params: [ConnectorSyncJobCancelRequest](./ConnectorSyncJobCancelRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorSyncJobCancelResponse](./ConnectorSyncJobCancelResponse.md)>;` | Cancel a connector sync job. Cancel a connector sync job, which sets the status to cancelling and updates `cancellation_requested_at` to the current time. The connector service is then responsible for setting the status of connector sync jobs to cancelled. || `syncJobCancel` | `syncJobCancel(this: [That](./That.md), params: [ConnectorSyncJobCancelRequest](./ConnectorSyncJobCancelRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorSyncJobCancelResponse](./ConnectorSyncJobCancelResponse.md), unknown>>;` |   || `syncJobCancel` | `syncJobCancel(this: [That](./That.md), params: [ConnectorSyncJobCancelRequest](./ConnectorSyncJobCancelRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorSyncJobCancelResponse](./ConnectorSyncJobCancelResponse.md)>;` |   || `syncJobCheckIn` | `syncJobCheckIn(this: [That](./That.md), params: [ConnectorSyncJobCheckInRequest](./ConnectorSyncJobCheckInRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorSyncJobCheckInResponse](./ConnectorSyncJobCheckInResponse.md)>;` | Check in a connector sync job. Check in a connector sync job and set the `last_seen` field to the current time before updating it in the internal index. To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure. This service runs automatically on Elastic Cloud for Elastic managed connectors. || `syncJobCheckIn` | `syncJobCheckIn(this: [That](./That.md), params: [ConnectorSyncJobCheckInRequest](./ConnectorSyncJobCheckInRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorSyncJobCheckInResponse](./ConnectorSyncJobCheckInResponse.md), unknown>>;` |   || `syncJobCheckIn` | `syncJobCheckIn(this: [That](./That.md), params: [ConnectorSyncJobCheckInRequest](./ConnectorSyncJobCheckInRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorSyncJobCheckInResponse](./ConnectorSyncJobCheckInResponse.md)>;` |   || `syncJobClaim` | `syncJobClaim(this: [That](./That.md), params: [ConnectorSyncJobClaimRequest](./ConnectorSyncJobClaimRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorSyncJobClaimResponse](./ConnectorSyncJobClaimResponse.md)>;` | Claim a connector sync job. This action updates the job status to `in_progress` and sets the `last_seen` and `started_at` timestamps to the current time. Additionally, it can set the `sync_cursor` property for the sync job. This API is not intended for direct connector management by users. It supports the implementation of services that utilize the connector protocol to communicate with Elasticsearch. To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure. This service runs automatically on Elastic Cloud for Elastic managed connectors. || `syncJobClaim` | `syncJobClaim(this: [That](./That.md), params: [ConnectorSyncJobClaimRequest](./ConnectorSyncJobClaimRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorSyncJobClaimResponse](./ConnectorSyncJobClaimResponse.md), unknown>>;` |   || `syncJobClaim` | `syncJobClaim(this: [That](./That.md), params: [ConnectorSyncJobClaimRequest](./ConnectorSyncJobClaimRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorSyncJobClaimResponse](./ConnectorSyncJobClaimResponse.md)>;` |   || `syncJobDelete` | `syncJobDelete(this: [That](./That.md), params: [ConnectorSyncJobDeleteRequest](./ConnectorSyncJobDeleteRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorSyncJobDeleteResponse](./ConnectorSyncJobDeleteResponse.md)>;` | Delete a connector sync job. Remove a connector sync job and its associated data. This is a destructive action that is not recoverable. || `syncJobDelete` | `syncJobDelete(this: [That](./That.md), params: [ConnectorSyncJobDeleteRequest](./ConnectorSyncJobDeleteRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorSyncJobDeleteResponse](./ConnectorSyncJobDeleteResponse.md), unknown>>;` |   || `syncJobDelete` | `syncJobDelete(this: [That](./That.md), params: [ConnectorSyncJobDeleteRequest](./ConnectorSyncJobDeleteRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorSyncJobDeleteResponse](./ConnectorSyncJobDeleteResponse.md)>;` |   || `syncJobError` | `syncJobError(this: [That](./That.md), params: [ConnectorSyncJobErrorRequest](./ConnectorSyncJobErrorRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorSyncJobErrorResponse](./ConnectorSyncJobErrorResponse.md)>;` | Set a connector sync job error. Set the `error` field for a connector sync job and set its `status` to `error`. To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure. This service runs automatically on Elastic Cloud for Elastic managed connectors. || `syncJobError` | `syncJobError(this: [That](./That.md), params: [ConnectorSyncJobErrorRequest](./ConnectorSyncJobErrorRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorSyncJobErrorResponse](./ConnectorSyncJobErrorResponse.md), unknown>>;` |   || `syncJobError` | `syncJobError(this: [That](./That.md), params: [ConnectorSyncJobErrorRequest](./ConnectorSyncJobErrorRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorSyncJobErrorResponse](./ConnectorSyncJobErrorResponse.md)>;` |   || `syncJobGet` | `syncJobGet(this: [That](./That.md), params: [ConnectorSyncJobGetRequest](./ConnectorSyncJobGetRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorSyncJobGetResponse](./ConnectorSyncJobGetResponse.md)>;` | Get a connector sync job. || `syncJobGet` | `syncJobGet(this: [That](./That.md), params: [ConnectorSyncJobGetRequest](./ConnectorSyncJobGetRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorSyncJobGetResponse](./ConnectorSyncJobGetResponse.md), unknown>>;` |   || `syncJobGet` | `syncJobGet(this: [That](./That.md), params: [ConnectorSyncJobGetRequest](./ConnectorSyncJobGetRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorSyncJobGetResponse](./ConnectorSyncJobGetResponse.md)>;` |   || `syncJobList` | `syncJobList(this: [That](./That.md), params?: [ConnectorSyncJobListRequest](./ConnectorSyncJobListRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorSyncJobListResponse](./ConnectorSyncJobListResponse.md)>;` | Get all connector sync jobs. Get information about all stored connector sync jobs listed by their creation date in ascending order. || `syncJobList` | `syncJobList(this: [That](./That.md), params?: [ConnectorSyncJobListRequest](./ConnectorSyncJobListRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorSyncJobListResponse](./ConnectorSyncJobListResponse.md), unknown>>;` |   || `syncJobList` | `syncJobList(this: [That](./That.md), params?: [ConnectorSyncJobListRequest](./ConnectorSyncJobListRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorSyncJobListResponse](./ConnectorSyncJobListResponse.md)>;` |   || `syncJobPost` | `syncJobPost(this: [That](./That.md), params: [ConnectorSyncJobPostRequest](./ConnectorSyncJobPostRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorSyncJobPostResponse](./ConnectorSyncJobPostResponse.md)>;` | Create a connector sync job. Create a connector sync job document in the internal index and initialize its counters and timestamps with default values. || `syncJobPost` | `syncJobPost(this: [That](./That.md), params: [ConnectorSyncJobPostRequest](./ConnectorSyncJobPostRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorSyncJobPostResponse](./ConnectorSyncJobPostResponse.md), unknown>>;` |   || `syncJobPost` | `syncJobPost(this: [That](./That.md), params: [ConnectorSyncJobPostRequest](./ConnectorSyncJobPostRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorSyncJobPostResponse](./ConnectorSyncJobPostResponse.md)>;` |   || `syncJobUpdateStats` | `syncJobUpdateStats(this: [That](./That.md), params: [ConnectorSyncJobUpdateStatsRequest](./ConnectorSyncJobUpdateStatsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorSyncJobUpdateStatsResponse](./ConnectorSyncJobUpdateStatsResponse.md)>;` | Set the connector sync job stats. Stats include: `deleted_document_count`, `indexed_document_count`, `indexed_document_volume`, and `total_document_count`. You can also update `last_seen`. This API is mainly used by the connector service for updating sync job information. To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure. This service runs automatically on Elastic Cloud for Elastic managed connectors. || `syncJobUpdateStats` | `syncJobUpdateStats(this: [That](./That.md), params: [ConnectorSyncJobUpdateStatsRequest](./ConnectorSyncJobUpdateStatsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorSyncJobUpdateStatsResponse](./ConnectorSyncJobUpdateStatsResponse.md), unknown>>;` |   || `syncJobUpdateStats` | `syncJobUpdateStats(this: [That](./That.md), params: [ConnectorSyncJobUpdateStatsRequest](./ConnectorSyncJobUpdateStatsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorSyncJobUpdateStatsResponse](./ConnectorSyncJobUpdateStatsResponse.md)>;` |   || `updateActiveFiltering` | `updateActiveFiltering(this: [That](./That.md), params: [ConnectorUpdateActiveFilteringRequest](./ConnectorUpdateActiveFilteringRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorUpdateActiveFilteringResponse](./ConnectorUpdateActiveFilteringResponse.md)>;` | Activate the connector draft filter. Activates the valid draft filtering for a connector. || `updateActiveFiltering` | `updateActiveFiltering(this: [That](./That.md), params: [ConnectorUpdateActiveFilteringRequest](./ConnectorUpdateActiveFilteringRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorUpdateActiveFilteringResponse](./ConnectorUpdateActiveFilteringResponse.md), unknown>>;` |   || `updateActiveFiltering` | `updateActiveFiltering(this: [That](./That.md), params: [ConnectorUpdateActiveFilteringRequest](./ConnectorUpdateActiveFilteringRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorUpdateActiveFilteringResponse](./ConnectorUpdateActiveFilteringResponse.md)>;` |   || `updateApiKeyId` | `updateApiKeyId(this: [That](./That.md), params: [ConnectorUpdateApiKeyIdRequest](./ConnectorUpdateApiKeyIdRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorUpdateApiKeyIdResponse](./ConnectorUpdateApiKeyIdResponse.md)>;` | Update the connector API key ID. Update the `api_key_id` and `api_key_secret_id` fields of a connector. You can specify the ID of the API key used for authorization and the ID of the connector secret where the API key is stored. The connector secret ID is required only for Elastic managed (native) connectors. Self-managed connectors (connector clients) do not use this field. || `updateApiKeyId` | `updateApiKeyId(this: [That](./That.md), params: [ConnectorUpdateApiKeyIdRequest](./ConnectorUpdateApiKeyIdRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorUpdateApiKeyIdResponse](./ConnectorUpdateApiKeyIdResponse.md), unknown>>;` |   || `updateApiKeyId` | `updateApiKeyId(this: [That](./That.md), params: [ConnectorUpdateApiKeyIdRequest](./ConnectorUpdateApiKeyIdRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorUpdateApiKeyIdResponse](./ConnectorUpdateApiKeyIdResponse.md)>;` |   || `updateConfiguration` | `updateConfiguration(this: [That](./That.md), params: [ConnectorUpdateConfigurationRequest](./ConnectorUpdateConfigurationRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorUpdateConfigurationResponse](./ConnectorUpdateConfigurationResponse.md)>;` | Update the connector configuration. Update the configuration field in the connector document. || `updateConfiguration` | `updateConfiguration(this: [That](./That.md), params: [ConnectorUpdateConfigurationRequest](./ConnectorUpdateConfigurationRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorUpdateConfigurationResponse](./ConnectorUpdateConfigurationResponse.md), unknown>>;` |   || `updateConfiguration` | `updateConfiguration(this: [That](./That.md), params: [ConnectorUpdateConfigurationRequest](./ConnectorUpdateConfigurationRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorUpdateConfigurationResponse](./ConnectorUpdateConfigurationResponse.md)>;` |   || `updateError` | `updateError(this: [That](./That.md), params: [ConnectorUpdateErrorRequest](./ConnectorUpdateErrorRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorUpdateErrorResponse](./ConnectorUpdateErrorResponse.md)>;` | Update the connector error field. Set the error field for the connector. If the error provided in the request body is non-null, the connector’s status is updated to error. Otherwise, if the error is reset to null, the connector status is updated to connected. || `updateError` | `updateError(this: [That](./That.md), params: [ConnectorUpdateErrorRequest](./ConnectorUpdateErrorRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorUpdateErrorResponse](./ConnectorUpdateErrorResponse.md), unknown>>;` |   || `updateError` | `updateError(this: [That](./That.md), params: [ConnectorUpdateErrorRequest](./ConnectorUpdateErrorRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorUpdateErrorResponse](./ConnectorUpdateErrorResponse.md)>;` |   || `updateFeatures` | `updateFeatures(this: [That](./That.md), params: [ConnectorUpdateFeaturesRequest](./ConnectorUpdateFeaturesRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorUpdateFeaturesResponse](./ConnectorUpdateFeaturesResponse.md)>;` | Update the connector features. Update the connector features in the connector document. This API can be used to control the following aspects of a connector: * document-level security * incremental syncs * advanced sync rules * basic sync rules Normally, the running connector service automatically manages these features. However, you can use this API to override the default behavior. To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure. This service runs automatically on Elastic Cloud for Elastic managed connectors. || `updateFeatures` | `updateFeatures(this: [That](./That.md), params: [ConnectorUpdateFeaturesRequest](./ConnectorUpdateFeaturesRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorUpdateFeaturesResponse](./ConnectorUpdateFeaturesResponse.md), unknown>>;` |   || `updateFeatures` | `updateFeatures(this: [That](./That.md), params: [ConnectorUpdateFeaturesRequest](./ConnectorUpdateFeaturesRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorUpdateFeaturesResponse](./ConnectorUpdateFeaturesResponse.md)>;` |   || `updateFiltering` | `updateFiltering(this: [That](./That.md), params: [ConnectorUpdateFilteringRequest](./ConnectorUpdateFilteringRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorUpdateFilteringResponse](./ConnectorUpdateFilteringResponse.md)>;` | Update the connector filtering. Update the draft filtering configuration of a connector and marks the draft validation state as edited. The filtering draft is activated once validated by the running Elastic connector service. The filtering property is used to configure sync rules (both basic and advanced) for a connector. || `updateFiltering` | `updateFiltering(this: [That](./That.md), params: [ConnectorUpdateFilteringRequest](./ConnectorUpdateFilteringRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorUpdateFilteringResponse](./ConnectorUpdateFilteringResponse.md), unknown>>;` |   || `updateFiltering` | `updateFiltering(this: [That](./That.md), params: [ConnectorUpdateFilteringRequest](./ConnectorUpdateFilteringRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorUpdateFilteringResponse](./ConnectorUpdateFilteringResponse.md)>;` |   || `updateFilteringValidation` | `updateFilteringValidation(this: [That](./That.md), params: [ConnectorUpdateFilteringValidationRequest](./ConnectorUpdateFilteringValidationRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorUpdateFilteringValidationResponse](./ConnectorUpdateFilteringValidationResponse.md)>;` | Update the connector draft filtering validation. Update the draft filtering validation info for a connector. || `updateFilteringValidation` | `updateFilteringValidation(this: [That](./That.md), params: [ConnectorUpdateFilteringValidationRequest](./ConnectorUpdateFilteringValidationRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorUpdateFilteringValidationResponse](./ConnectorUpdateFilteringValidationResponse.md), unknown>>;` |   || `updateFilteringValidation` | `updateFilteringValidation(this: [That](./That.md), params: [ConnectorUpdateFilteringValidationRequest](./ConnectorUpdateFilteringValidationRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorUpdateFilteringValidationResponse](./ConnectorUpdateFilteringValidationResponse.md)>;` |   || `updateIndexName` | `updateIndexName(this: [That](./That.md), params: [ConnectorUpdateIndexNameRequest](./ConnectorUpdateIndexNameRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorUpdateIndexNameResponse](./ConnectorUpdateIndexNameResponse.md)>;` | Update the connector index name. Update the `index_name` field of a connector, specifying the index where the data ingested by the connector is stored. || `updateIndexName` | `updateIndexName(this: [That](./That.md), params: [ConnectorUpdateIndexNameRequest](./ConnectorUpdateIndexNameRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorUpdateIndexNameResponse](./ConnectorUpdateIndexNameResponse.md), unknown>>;` |   || `updateIndexName` | `updateIndexName(this: [That](./That.md), params: [ConnectorUpdateIndexNameRequest](./ConnectorUpdateIndexNameRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorUpdateIndexNameResponse](./ConnectorUpdateIndexNameResponse.md)>;` |   || `updateName` | `updateName(this: [That](./That.md), params: [ConnectorUpdateNameRequest](./ConnectorUpdateNameRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorUpdateNameResponse](./ConnectorUpdateNameResponse.md)>;` | Update the connector name and description. || `updateName` | `updateName(this: [That](./That.md), params: [ConnectorUpdateNameRequest](./ConnectorUpdateNameRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorUpdateNameResponse](./ConnectorUpdateNameResponse.md), unknown>>;` |   || `updateName` | `updateName(this: [That](./That.md), params: [ConnectorUpdateNameRequest](./ConnectorUpdateNameRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorUpdateNameResponse](./ConnectorUpdateNameResponse.md)>;` |   || `updateNative` | `updateNative(this: [That](./That.md), params: [ConnectorUpdateNativeRequest](./ConnectorUpdateNativeRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorUpdateNativeResponse](./ConnectorUpdateNativeResponse.md)>;` | Update the connector is_native flag. || `updateNative` | `updateNative(this: [That](./That.md), params: [ConnectorUpdateNativeRequest](./ConnectorUpdateNativeRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorUpdateNativeResponse](./ConnectorUpdateNativeResponse.md), unknown>>;` |   || `updateNative` | `updateNative(this: [That](./That.md), params: [ConnectorUpdateNativeRequest](./ConnectorUpdateNativeRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorUpdateNativeResponse](./ConnectorUpdateNativeResponse.md)>;` |   || `updatePipeline` | `updatePipeline(this: [That](./That.md), params: [ConnectorUpdatePipelineRequest](./ConnectorUpdatePipelineRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorUpdatePipelineResponse](./ConnectorUpdatePipelineResponse.md)>;` | Update the connector pipeline. When you create a new connector, the configuration of an ingest pipeline is populated with default settings. || `updatePipeline` | `updatePipeline(this: [That](./That.md), params: [ConnectorUpdatePipelineRequest](./ConnectorUpdatePipelineRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorUpdatePipelineResponse](./ConnectorUpdatePipelineResponse.md), unknown>>;` |   || `updatePipeline` | `updatePipeline(this: [That](./That.md), params: [ConnectorUpdatePipelineRequest](./ConnectorUpdatePipelineRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorUpdatePipelineResponse](./ConnectorUpdatePipelineResponse.md)>;` |   || `updateScheduling` | `updateScheduling(this: [That](./That.md), params: [ConnectorUpdateSchedulingRequest](./ConnectorUpdateSchedulingRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorUpdateSchedulingResponse](./ConnectorUpdateSchedulingResponse.md)>;` | Update the connector scheduling. || `updateScheduling` | `updateScheduling(this: [That](./That.md), params: [ConnectorUpdateSchedulingRequest](./ConnectorUpdateSchedulingRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorUpdateSchedulingResponse](./ConnectorUpdateSchedulingResponse.md), unknown>>;` |   || `updateScheduling` | `updateScheduling(this: [That](./That.md), params: [ConnectorUpdateSchedulingRequest](./ConnectorUpdateSchedulingRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorUpdateSchedulingResponse](./ConnectorUpdateSchedulingResponse.md)>;` |   || `updateServiceType` | `updateServiceType(this: [That](./That.md), params: [ConnectorUpdateServiceTypeRequest](./ConnectorUpdateServiceTypeRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorUpdateServiceTypeResponse](./ConnectorUpdateServiceTypeResponse.md)>;` | Update the connector service type. || `updateServiceType` | `updateServiceType(this: [That](./That.md), params: [ConnectorUpdateServiceTypeRequest](./ConnectorUpdateServiceTypeRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorUpdateServiceTypeResponse](./ConnectorUpdateServiceTypeResponse.md), unknown>>;` |   || `updateServiceType` | `updateServiceType(this: [That](./That.md), params: [ConnectorUpdateServiceTypeRequest](./ConnectorUpdateServiceTypeRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorUpdateServiceTypeResponse](./ConnectorUpdateServiceTypeResponse.md)>;` |   || `updateStatus` | `updateStatus(this: [That](./That.md), params: [ConnectorUpdateStatusRequest](./ConnectorUpdateStatusRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorUpdateStatusResponse](./ConnectorUpdateStatusResponse.md)>;` | Update the connector status. || `updateStatus` | `updateStatus(this: [That](./That.md), params: [ConnectorUpdateStatusRequest](./ConnectorUpdateStatusRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorUpdateStatusResponse](./ConnectorUpdateStatusResponse.md), unknown>>;` |   || `updateStatus` | `updateStatus(this: [That](./That.md), params: [ConnectorUpdateStatusRequest](./ConnectorUpdateStatusRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorUpdateStatusResponse](./ConnectorUpdateStatusResponse.md)>;` |   | \ No newline at end of file diff --git a/docs/reference/api/ConnectorCheckInRequest.md b/docs/reference/api/ConnectorCheckInRequest.md new file mode 100644 index 000000000..630bdd9a7 --- /dev/null +++ b/docs/reference/api/ConnectorCheckInRequest.md @@ -0,0 +1,7 @@ +## Interface `ConnectorCheckInRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { connector_id?: never; }) | All values in `body` will be added to the request body. | +| `connector_id` | [Id](./Id.md) | The unique identifier of the connector to be checked in | +| `querystring` | { [key: string]: any; } & { connector_id?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/ConnectorCheckInResponse.md b/docs/reference/api/ConnectorCheckInResponse.md new file mode 100644 index 000000000..740f4362a --- /dev/null +++ b/docs/reference/api/ConnectorCheckInResponse.md @@ -0,0 +1,5 @@ +## Interface `ConnectorCheckInResponse` + +| Name | Type | Description | +| - | - | - | +| `result` | [Result](./Result.md) |   | diff --git a/docs/reference/api/ConnectorConnector.md b/docs/reference/api/ConnectorConnector.md new file mode 100644 index 000000000..bdf6fcd41 --- /dev/null +++ b/docs/reference/api/ConnectorConnector.md @@ -0,0 +1,35 @@ +## Interface `ConnectorConnector` + +| Name | Type | Description | +| - | - | - | +| `api_key_id` | string |   | +| `api_key_secret_id` | string |   | +| `configuration` | [ConnectorConnectorConfiguration](./ConnectorConnectorConfiguration.md) |   | +| `custom_scheduling` | [ConnectorConnectorCustomScheduling](./ConnectorConnectorCustomScheduling.md) |   | +| `deleted` | boolean |   | +| `description` | string |   | +| `error` | string | null |   | +| `features` | [ConnectorConnectorFeatures](./ConnectorConnectorFeatures.md) |   | +| `filtering` | [ConnectorFilteringConfig](./ConnectorFilteringConfig.md)[] |   | +| `id` | [Id](./Id.md) |   | +| `index_name` | [IndexName](./IndexName.md) | null |   | +| `is_native` | boolean |   | +| `language` | string |   | +| `last_access_control_sync_error` | string |   | +| `last_access_control_sync_scheduled_at` | [DateTime](./DateTime.md) |   | +| `last_access_control_sync_status` | [ConnectorSyncStatus](./ConnectorSyncStatus.md) |   | +| `last_deleted_document_count` | [long](./long.md) |   | +| `last_incremental_sync_scheduled_at` | [DateTime](./DateTime.md) |   | +| `last_indexed_document_count` | [long](./long.md) |   | +| `last_seen` | [DateTime](./DateTime.md) |   | +| `last_sync_error` | string |   | +| `last_sync_scheduled_at` | [DateTime](./DateTime.md) |   | +| `last_sync_status` | [ConnectorSyncStatus](./ConnectorSyncStatus.md) |   | +| `last_synced` | [DateTime](./DateTime.md) |   | +| `name` | string |   | +| `pipeline` | [ConnectorIngestPipelineParams](./ConnectorIngestPipelineParams.md) |   | +| `scheduling` | [ConnectorSchedulingConfiguration](./ConnectorSchedulingConfiguration.md) |   | +| `service_type` | string |   | +| `status` | [ConnectorConnectorStatus](./ConnectorConnectorStatus.md) |   | +| `sync_cursor` | any |   | +| `sync_now` | boolean |   | diff --git a/docs/reference/api/ConnectorConnectorConfigProperties.md b/docs/reference/api/ConnectorConnectorConfigProperties.md new file mode 100644 index 000000000..5ee4157c4 --- /dev/null +++ b/docs/reference/api/ConnectorConnectorConfigProperties.md @@ -0,0 +1,19 @@ +## Interface `ConnectorConnectorConfigProperties` + +| Name | Type | Description | +| - | - | - | +| `category` | string |   | +| `default_value` | [ScalarValue](./ScalarValue.md) |   | +| `depends_on` | [ConnectorDependency](./ConnectorDependency.md)[] |   | +| `display` | [ConnectorDisplayType](./ConnectorDisplayType.md) |   | +| `label` | string |   | +| `options` | [ConnectorSelectOption](./ConnectorSelectOption.md)[] |   | +| `order` | [integer](./integer.md) |   | +| `placeholder` | string |   | +| `required` | boolean |   | +| `sensitive` | boolean |   | +| `tooltip` | string | null |   | +| `type` | [ConnectorConnectorFieldType](./ConnectorConnectorFieldType.md) |   | +| `ui_restrictions` | string[] |   | +| `validations` | [ConnectorValidation](./ConnectorValidation.md)[] |   | +| `value` | any |   | diff --git a/docs/reference/api/ConnectorConnectorConfiguration.md b/docs/reference/api/ConnectorConnectorConfiguration.md new file mode 100644 index 000000000..2d5617d0d --- /dev/null +++ b/docs/reference/api/ConnectorConnectorConfiguration.md @@ -0,0 +1,4 @@ +## `ConnectorConnectorConfiguration` +::: +type ConnectorConnectorConfiguration = Record; +::: diff --git a/docs/reference/api/ConnectorConnectorCustomScheduling.md b/docs/reference/api/ConnectorConnectorCustomScheduling.md new file mode 100644 index 000000000..863194cc7 --- /dev/null +++ b/docs/reference/api/ConnectorConnectorCustomScheduling.md @@ -0,0 +1,4 @@ +## `ConnectorConnectorCustomScheduling` +::: +type ConnectorConnectorCustomScheduling = Record; +::: diff --git a/docs/reference/api/ConnectorConnectorFeatures.md b/docs/reference/api/ConnectorConnectorFeatures.md new file mode 100644 index 000000000..c121e5456 --- /dev/null +++ b/docs/reference/api/ConnectorConnectorFeatures.md @@ -0,0 +1,8 @@ +## Interface `ConnectorConnectorFeatures` + +| Name | Type | Description | +| - | - | - | +| `document_level_security` | [ConnectorFeatureEnabled](./ConnectorFeatureEnabled.md) | Indicates whether document-level security is enabled. | +| `incremental_sync` | [ConnectorFeatureEnabled](./ConnectorFeatureEnabled.md) | Indicates whether incremental syncs are enabled. | +| `native_connector_api_keys` | [ConnectorFeatureEnabled](./ConnectorFeatureEnabled.md) | Indicates whether managed connector API keys are enabled. | +| `sync_rules` | [ConnectorSyncRulesFeature](./ConnectorSyncRulesFeature.md) |   | diff --git a/docs/reference/api/ConnectorConnectorFieldType.md b/docs/reference/api/ConnectorConnectorFieldType.md new file mode 100644 index 000000000..149625253 --- /dev/null +++ b/docs/reference/api/ConnectorConnectorFieldType.md @@ -0,0 +1,4 @@ +## `ConnectorConnectorFieldType` +::: +type ConnectorConnectorFieldType = 'str' | 'int' | 'list' | 'bool'; +::: diff --git a/docs/reference/api/ConnectorConnectorScheduling.md b/docs/reference/api/ConnectorConnectorScheduling.md new file mode 100644 index 000000000..da6d5effc --- /dev/null +++ b/docs/reference/api/ConnectorConnectorScheduling.md @@ -0,0 +1,6 @@ +## Interface `ConnectorConnectorScheduling` + +| Name | Type | Description | +| - | - | - | +| `enabled` | boolean |   | +| `interval` | string | The interval is expressed using the crontab syntax | diff --git a/docs/reference/api/ConnectorConnectorStatus.md b/docs/reference/api/ConnectorConnectorStatus.md new file mode 100644 index 000000000..b40fd797e --- /dev/null +++ b/docs/reference/api/ConnectorConnectorStatus.md @@ -0,0 +1,4 @@ +## `ConnectorConnectorStatus` +::: +type ConnectorConnectorStatus = 'created' | 'needs_configuration' | 'configured' | 'connected' | 'error'; +::: diff --git a/docs/reference/api/ConnectorConnectorSyncJob.md b/docs/reference/api/ConnectorConnectorSyncJob.md new file mode 100644 index 000000000..c6a35fca0 --- /dev/null +++ b/docs/reference/api/ConnectorConnectorSyncJob.md @@ -0,0 +1,22 @@ +## Interface `ConnectorConnectorSyncJob` + +| Name | Type | Description | +| - | - | - | +| `cancelation_requested_at` | [DateTime](./DateTime.md) |   | +| `canceled_at` | [DateTime](./DateTime.md) |   | +| `completed_at` | [DateTime](./DateTime.md) |   | +| `connector` | [ConnectorSyncJobConnectorReference](./ConnectorSyncJobConnectorReference.md) |   | +| `created_at` | [DateTime](./DateTime.md) |   | +| `deleted_document_count` | [long](./long.md) |   | +| `error` | string |   | +| `id` | [Id](./Id.md) |   | +| `indexed_document_count` | [long](./long.md) |   | +| `indexed_document_volume` | [long](./long.md) |   | +| `job_type` | [ConnectorSyncJobType](./ConnectorSyncJobType.md) |   | +| `last_seen` | [DateTime](./DateTime.md) |   | +| `metadata` | Record |   | +| `started_at` | [DateTime](./DateTime.md) |   | +| `status` | [ConnectorSyncStatus](./ConnectorSyncStatus.md) |   | +| `total_document_count` | [long](./long.md) |   | +| `trigger_method` | [ConnectorSyncJobTriggerMethod](./ConnectorSyncJobTriggerMethod.md) |   | +| `worker_hostname` | string |   | diff --git a/docs/reference/api/ConnectorCustomScheduling.md b/docs/reference/api/ConnectorCustomScheduling.md new file mode 100644 index 000000000..fb6b69d8b --- /dev/null +++ b/docs/reference/api/ConnectorCustomScheduling.md @@ -0,0 +1,9 @@ +## Interface `ConnectorCustomScheduling` + +| Name | Type | Description | +| - | - | - | +| `configuration_overrides` | [ConnectorCustomSchedulingConfigurationOverrides](./ConnectorCustomSchedulingConfigurationOverrides.md) |   | +| `enabled` | boolean |   | +| `interval` | string |   | +| `last_synced` | [DateTime](./DateTime.md) |   | +| `name` | string |   | diff --git a/docs/reference/api/ConnectorCustomSchedulingConfigurationOverrides.md b/docs/reference/api/ConnectorCustomSchedulingConfigurationOverrides.md new file mode 100644 index 000000000..fa4ca6e36 --- /dev/null +++ b/docs/reference/api/ConnectorCustomSchedulingConfigurationOverrides.md @@ -0,0 +1,9 @@ +## Interface `ConnectorCustomSchedulingConfigurationOverrides` + +| Name | Type | Description | +| - | - | - | +| `domain_allowlist` | string[] |   | +| `max_crawl_depth` | [integer](./integer.md) |   | +| `seed_urls` | string[] |   | +| `sitemap_discovery_disabled` | boolean |   | +| `sitemap_urls` | string[] |   | diff --git a/docs/reference/api/ConnectorDeleteRequest.md b/docs/reference/api/ConnectorDeleteRequest.md new file mode 100644 index 000000000..d09af8ccb --- /dev/null +++ b/docs/reference/api/ConnectorDeleteRequest.md @@ -0,0 +1,9 @@ +## Interface `ConnectorDeleteRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { connector_id?: never; delete_sync_jobs?: never; hard?: never; }) | All values in `body` will be added to the request body. | +| `connector_id` | [Id](./Id.md) | The unique identifier of the connector to be deleted | +| `delete_sync_jobs` | boolean | A flag indicating if associated sync jobs should be also removed. Defaults to false. | +| `hard` | boolean | A flag indicating if the connector should be hard deleted. | +| `querystring` | { [key: string]: any; } & { connector_id?: never; delete_sync_jobs?: never; hard?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/ConnectorDeleteResponse.md b/docs/reference/api/ConnectorDeleteResponse.md new file mode 100644 index 000000000..d332c0098 --- /dev/null +++ b/docs/reference/api/ConnectorDeleteResponse.md @@ -0,0 +1,4 @@ +## `ConnectorDeleteResponse` +::: +type ConnectorDeleteResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); +::: diff --git a/docs/reference/api/ConnectorDependency.md b/docs/reference/api/ConnectorDependency.md new file mode 100644 index 000000000..edbae2906 --- /dev/null +++ b/docs/reference/api/ConnectorDependency.md @@ -0,0 +1,6 @@ +## Interface `ConnectorDependency` + +| Name | Type | Description | +| - | - | - | +| `field` | string |   | +| `value` | [ScalarValue](./ScalarValue.md) |   | diff --git a/docs/reference/api/ConnectorDisplayType.md b/docs/reference/api/ConnectorDisplayType.md new file mode 100644 index 000000000..c5eee31c1 --- /dev/null +++ b/docs/reference/api/ConnectorDisplayType.md @@ -0,0 +1,4 @@ +## `ConnectorDisplayType` +::: +type ConnectorDisplayType = 'textbox' | 'textarea' | 'numeric' | 'toggle' | 'dropdown'; +::: diff --git a/docs/reference/api/ConnectorFeatureEnabled.md b/docs/reference/api/ConnectorFeatureEnabled.md new file mode 100644 index 000000000..5123d5675 --- /dev/null +++ b/docs/reference/api/ConnectorFeatureEnabled.md @@ -0,0 +1,5 @@ +## Interface `ConnectorFeatureEnabled` + +| Name | Type | Description | +| - | - | - | +| `enabled` | boolean |   | diff --git a/docs/reference/api/ConnectorFilteringAdvancedSnippet.md b/docs/reference/api/ConnectorFilteringAdvancedSnippet.md new file mode 100644 index 000000000..806d1ee70 --- /dev/null +++ b/docs/reference/api/ConnectorFilteringAdvancedSnippet.md @@ -0,0 +1,7 @@ +## Interface `ConnectorFilteringAdvancedSnippet` + +| Name | Type | Description | +| - | - | - | +| `created_at` | [DateTime](./DateTime.md) |   | +| `updated_at` | [DateTime](./DateTime.md) |   | +| `value` | any |   | diff --git a/docs/reference/api/ConnectorFilteringConfig.md b/docs/reference/api/ConnectorFilteringConfig.md new file mode 100644 index 000000000..e1a9d7c78 --- /dev/null +++ b/docs/reference/api/ConnectorFilteringConfig.md @@ -0,0 +1,7 @@ +## Interface `ConnectorFilteringConfig` + +| Name | Type | Description | +| - | - | - | +| `active` | [ConnectorFilteringRules](./ConnectorFilteringRules.md) |   | +| `domain` | string |   | +| `draft` | [ConnectorFilteringRules](./ConnectorFilteringRules.md) |   | diff --git a/docs/reference/api/ConnectorFilteringPolicy.md b/docs/reference/api/ConnectorFilteringPolicy.md new file mode 100644 index 000000000..ff18cdbd6 --- /dev/null +++ b/docs/reference/api/ConnectorFilteringPolicy.md @@ -0,0 +1,4 @@ +## `ConnectorFilteringPolicy` +::: +type ConnectorFilteringPolicy = 'exclude' | 'include'; +::: diff --git a/docs/reference/api/ConnectorFilteringRule.md b/docs/reference/api/ConnectorFilteringRule.md new file mode 100644 index 000000000..69f260692 --- /dev/null +++ b/docs/reference/api/ConnectorFilteringRule.md @@ -0,0 +1,12 @@ +## Interface `ConnectorFilteringRule` + +| Name | Type | Description | +| - | - | - | +| `created_at` | [DateTime](./DateTime.md) |   | +| `field` | [Field](./Field.md) |   | +| `id` | [Id](./Id.md) |   | +| `order` | [integer](./integer.md) |   | +| `policy` | [ConnectorFilteringPolicy](./ConnectorFilteringPolicy.md) |   | +| `rule` | [ConnectorFilteringRuleRule](./ConnectorFilteringRuleRule.md) |   | +| `updated_at` | [DateTime](./DateTime.md) |   | +| `value` | string |   | diff --git a/docs/reference/api/ConnectorFilteringRuleRule.md b/docs/reference/api/ConnectorFilteringRuleRule.md new file mode 100644 index 000000000..356f0a132 --- /dev/null +++ b/docs/reference/api/ConnectorFilteringRuleRule.md @@ -0,0 +1,4 @@ +## `ConnectorFilteringRuleRule` +::: +type ConnectorFilteringRuleRule = 'contains' | 'ends_with' | 'equals' | 'regex' | 'starts_with' | '>' | '<'; +::: diff --git a/docs/reference/api/ConnectorFilteringRules.md b/docs/reference/api/ConnectorFilteringRules.md new file mode 100644 index 000000000..b0763a72c --- /dev/null +++ b/docs/reference/api/ConnectorFilteringRules.md @@ -0,0 +1,7 @@ +## Interface `ConnectorFilteringRules` + +| Name | Type | Description | +| - | - | - | +| `advanced_snippet` | [ConnectorFilteringAdvancedSnippet](./ConnectorFilteringAdvancedSnippet.md) |   | +| `rules` | [ConnectorFilteringRule](./ConnectorFilteringRule.md)[] |   | +| `validation` | [ConnectorFilteringRulesValidation](./ConnectorFilteringRulesValidation.md) |   | diff --git a/docs/reference/api/ConnectorFilteringRulesValidation.md b/docs/reference/api/ConnectorFilteringRulesValidation.md new file mode 100644 index 000000000..0e48ce67b --- /dev/null +++ b/docs/reference/api/ConnectorFilteringRulesValidation.md @@ -0,0 +1,6 @@ +## Interface `ConnectorFilteringRulesValidation` + +| Name | Type | Description | +| - | - | - | +| `errors` | [ConnectorFilteringValidation](./ConnectorFilteringValidation.md)[] |   | +| `state` | [ConnectorFilteringValidationState](./ConnectorFilteringValidationState.md) |   | diff --git a/docs/reference/api/ConnectorFilteringValidation.md b/docs/reference/api/ConnectorFilteringValidation.md new file mode 100644 index 000000000..53f8d7628 --- /dev/null +++ b/docs/reference/api/ConnectorFilteringValidation.md @@ -0,0 +1,6 @@ +## Interface `ConnectorFilteringValidation` + +| Name | Type | Description | +| - | - | - | +| `ids` | [Id](./Id.md)[] |   | +| `messages` | string[] |   | diff --git a/docs/reference/api/ConnectorFilteringValidationState.md b/docs/reference/api/ConnectorFilteringValidationState.md new file mode 100644 index 000000000..fb183139a --- /dev/null +++ b/docs/reference/api/ConnectorFilteringValidationState.md @@ -0,0 +1,4 @@ +## `ConnectorFilteringValidationState` +::: +type ConnectorFilteringValidationState = 'edited' | 'invalid' | 'valid'; +::: diff --git a/docs/reference/api/ConnectorGetRequest.md b/docs/reference/api/ConnectorGetRequest.md new file mode 100644 index 000000000..7ce84599f --- /dev/null +++ b/docs/reference/api/ConnectorGetRequest.md @@ -0,0 +1,8 @@ +## Interface `ConnectorGetRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { connector_id?: never; include_deleted?: never; }) | All values in `body` will be added to the request body. | +| `connector_id` | [Id](./Id.md) | The unique identifier of the connector | +| `include_deleted` | boolean | A flag to indicate if the desired connector should be fetched, even if it was soft-deleted. | +| `querystring` | { [key: string]: any; } & { connector_id?: never; include_deleted?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/ConnectorGetResponse.md b/docs/reference/api/ConnectorGetResponse.md new file mode 100644 index 000000000..9f9755643 --- /dev/null +++ b/docs/reference/api/ConnectorGetResponse.md @@ -0,0 +1,4 @@ +## `ConnectorGetResponse` +::: +type ConnectorGetResponse = [ConnectorConnector](./ConnectorConnector.md); +::: diff --git a/docs/reference/api/ConnectorGreaterThanValidation.md b/docs/reference/api/ConnectorGreaterThanValidation.md new file mode 100644 index 000000000..9af2193bc --- /dev/null +++ b/docs/reference/api/ConnectorGreaterThanValidation.md @@ -0,0 +1,6 @@ +## Interface `ConnectorGreaterThanValidation` + +| Name | Type | Description | +| - | - | - | +| `constraint` | [double](./double.md) |   | +| `type` | 'greater_than' |   | diff --git a/docs/reference/api/ConnectorIncludedInValidation.md b/docs/reference/api/ConnectorIncludedInValidation.md new file mode 100644 index 000000000..b3cd7a207 --- /dev/null +++ b/docs/reference/api/ConnectorIncludedInValidation.md @@ -0,0 +1,6 @@ +## Interface `ConnectorIncludedInValidation` + +| Name | Type | Description | +| - | - | - | +| `constraint` | [ScalarValue](./ScalarValue.md)[] |   | +| `type` | 'included_in' |   | diff --git a/docs/reference/api/ConnectorIngestPipelineParams.md b/docs/reference/api/ConnectorIngestPipelineParams.md new file mode 100644 index 000000000..5ba2e5a30 --- /dev/null +++ b/docs/reference/api/ConnectorIngestPipelineParams.md @@ -0,0 +1,8 @@ +## Interface `ConnectorIngestPipelineParams` + +| Name | Type | Description | +| - | - | - | +| `extract_binary_content` | boolean |   | +| `name` | string |   | +| `reduce_whitespace` | boolean |   | +| `run_ml_inference` | boolean |   | diff --git a/docs/reference/api/ConnectorLastSyncRequest.md b/docs/reference/api/ConnectorLastSyncRequest.md new file mode 100644 index 000000000..cafe2b4e9 --- /dev/null +++ b/docs/reference/api/ConnectorLastSyncRequest.md @@ -0,0 +1,19 @@ +## Interface `ConnectorLastSyncRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { connector_id?: never; last_access_control_sync_error?: never; last_access_control_sync_scheduled_at?: never; last_access_control_sync_status?: never; last_deleted_document_count?: never; last_incremental_sync_scheduled_at?: never; last_indexed_document_count?: never; last_seen?: never; last_sync_error?: never; last_sync_scheduled_at?: never; last_sync_status?: never; last_synced?: never; sync_cursor?: never; }) | All values in `body` will be added to the request body. | +| `connector_id` | [Id](./Id.md) | The unique identifier of the connector to be updated | +| `last_access_control_sync_error` | string |   | +| `last_access_control_sync_scheduled_at` | [DateTime](./DateTime.md) |   | +| `last_access_control_sync_status` | [ConnectorSyncStatus](./ConnectorSyncStatus.md) |   | +| `last_deleted_document_count` | [long](./long.md) |   | +| `last_incremental_sync_scheduled_at` | [DateTime](./DateTime.md) |   | +| `last_indexed_document_count` | [long](./long.md) |   | +| `last_seen` | [DateTime](./DateTime.md) |   | +| `last_sync_error` | string |   | +| `last_sync_scheduled_at` | [DateTime](./DateTime.md) |   | +| `last_sync_status` | [ConnectorSyncStatus](./ConnectorSyncStatus.md) |   | +| `last_synced` | [DateTime](./DateTime.md) |   | +| `querystring` | { [key: string]: any; } & { connector_id?: never; last_access_control_sync_error?: never; last_access_control_sync_scheduled_at?: never; last_access_control_sync_status?: never; last_deleted_document_count?: never; last_incremental_sync_scheduled_at?: never; last_indexed_document_count?: never; last_seen?: never; last_sync_error?: never; last_sync_scheduled_at?: never; last_sync_status?: never; last_synced?: never; sync_cursor?: never; } | All values in `querystring` will be added to the request querystring. | +| `sync_cursor` | any |   | diff --git a/docs/reference/api/ConnectorLastSyncResponse.md b/docs/reference/api/ConnectorLastSyncResponse.md new file mode 100644 index 000000000..2e4016734 --- /dev/null +++ b/docs/reference/api/ConnectorLastSyncResponse.md @@ -0,0 +1,5 @@ +## Interface `ConnectorLastSyncResponse` + +| Name | Type | Description | +| - | - | - | +| `result` | [Result](./Result.md) |   | diff --git a/docs/reference/api/ConnectorLessThanValidation.md b/docs/reference/api/ConnectorLessThanValidation.md new file mode 100644 index 000000000..3f3068eaa --- /dev/null +++ b/docs/reference/api/ConnectorLessThanValidation.md @@ -0,0 +1,6 @@ +## Interface `ConnectorLessThanValidation` + +| Name | Type | Description | +| - | - | - | +| `constraint` | [double](./double.md) |   | +| `type` | 'less_than' |   | diff --git a/docs/reference/api/ConnectorListRequest.md b/docs/reference/api/ConnectorListRequest.md new file mode 100644 index 000000000..3556cf0c2 --- /dev/null +++ b/docs/reference/api/ConnectorListRequest.md @@ -0,0 +1,13 @@ +## Interface `ConnectorListRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { from?: never; size?: never; index_name?: never; connector_name?: never; service_type?: never; include_deleted?: never; query?: never; }) | All values in `body` will be added to the request body. | +| `connector_name` | [Names](./Names.md) | A comma-separated list of connector names to fetch connector documents for | +| `from` | [integer](./integer.md) | Starting offset (default: 0) | +| `include_deleted` | boolean | A flag to indicate if the desired connector should be fetched, even if it was soft-deleted. | +| `index_name` | [Indices](./Indices.md) | A comma-separated list of connector index names to fetch connector documents for | +| `query` | string | A wildcard query string that filters connectors with matching name, description or index name | +| `querystring` | { [key: string]: any; } & { from?: never; size?: never; index_name?: never; connector_name?: never; service_type?: never; include_deleted?: never; query?: never; } | All values in `querystring` will be added to the request querystring. | +| `service_type` | [Names](./Names.md) | A comma-separated list of connector service types to fetch connector documents for | +| `size` | [integer](./integer.md) | Specifies a max number of results to get | diff --git a/docs/reference/api/ConnectorListResponse.md b/docs/reference/api/ConnectorListResponse.md new file mode 100644 index 000000000..b2c53cd25 --- /dev/null +++ b/docs/reference/api/ConnectorListResponse.md @@ -0,0 +1,6 @@ +## Interface `ConnectorListResponse` + +| Name | Type | Description | +| - | - | - | +| `count` | [long](./long.md) |   | +| `results` | [ConnectorConnector](./ConnectorConnector.md)[] |   | diff --git a/docs/reference/api/ConnectorListTypeValidation.md b/docs/reference/api/ConnectorListTypeValidation.md new file mode 100644 index 000000000..eeb51d3f0 --- /dev/null +++ b/docs/reference/api/ConnectorListTypeValidation.md @@ -0,0 +1,6 @@ +## Interface `ConnectorListTypeValidation` + +| Name | Type | Description | +| - | - | - | +| `constraint` | string |   | +| `type` | 'list_type' |   | diff --git a/docs/reference/api/ConnectorPostRequest.md b/docs/reference/api/ConnectorPostRequest.md new file mode 100644 index 000000000..d88e7f3ec --- /dev/null +++ b/docs/reference/api/ConnectorPostRequest.md @@ -0,0 +1,12 @@ +## Interface `ConnectorPostRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { description?: never; index_name?: never; is_native?: never; language?: never; name?: never; service_type?: never; }) | All values in `body` will be added to the request body. | +| `description` | string |   | +| `index_name` | [IndexName](./IndexName.md) |   | +| `is_native` | boolean |   | +| `language` | string |   | +| `name` | string |   | +| `querystring` | { [key: string]: any; } & { description?: never; index_name?: never; is_native?: never; language?: never; name?: never; service_type?: never; } | All values in `querystring` will be added to the request querystring. | +| `service_type` | string |   | diff --git a/docs/reference/api/ConnectorPostResponse.md b/docs/reference/api/ConnectorPostResponse.md new file mode 100644 index 000000000..cf71cb721 --- /dev/null +++ b/docs/reference/api/ConnectorPostResponse.md @@ -0,0 +1,6 @@ +## Interface `ConnectorPostResponse` + +| Name | Type | Description | +| - | - | - | +| `id` | [Id](./Id.md) |   | +| `result` | [Result](./Result.md) |   | diff --git a/docs/reference/api/ConnectorPutRequest.md b/docs/reference/api/ConnectorPutRequest.md new file mode 100644 index 000000000..c83330776 --- /dev/null +++ b/docs/reference/api/ConnectorPutRequest.md @@ -0,0 +1,13 @@ +## Interface `ConnectorPutRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { connector_id?: never; description?: never; index_name?: never; is_native?: never; language?: never; name?: never; service_type?: never; }) | All values in `body` will be added to the request body. | +| `connector_id` | [Id](./Id.md) | The unique identifier of the connector to be created or updated. ID is auto-generated if not provided. | +| `description` | string |   | +| `index_name` | [IndexName](./IndexName.md) |   | +| `is_native` | boolean |   | +| `language` | string |   | +| `name` | string |   | +| `querystring` | { [key: string]: any; } & { connector_id?: never; description?: never; index_name?: never; is_native?: never; language?: never; name?: never; service_type?: never; } | All values in `querystring` will be added to the request querystring. | +| `service_type` | string |   | diff --git a/docs/reference/api/ConnectorPutResponse.md b/docs/reference/api/ConnectorPutResponse.md new file mode 100644 index 000000000..008506ec8 --- /dev/null +++ b/docs/reference/api/ConnectorPutResponse.md @@ -0,0 +1,6 @@ +## Interface `ConnectorPutResponse` + +| Name | Type | Description | +| - | - | - | +| `id` | [Id](./Id.md) |   | +| `result` | [Result](./Result.md) |   | diff --git a/docs/reference/api/ConnectorRegexValidation.md b/docs/reference/api/ConnectorRegexValidation.md new file mode 100644 index 000000000..28e024755 --- /dev/null +++ b/docs/reference/api/ConnectorRegexValidation.md @@ -0,0 +1,6 @@ +## Interface `ConnectorRegexValidation` + +| Name | Type | Description | +| - | - | - | +| `constraint` | string |   | +| `type` | 'regex' |   | diff --git a/docs/reference/api/ConnectorSchedulingConfiguration.md b/docs/reference/api/ConnectorSchedulingConfiguration.md new file mode 100644 index 000000000..f287c5e99 --- /dev/null +++ b/docs/reference/api/ConnectorSchedulingConfiguration.md @@ -0,0 +1,7 @@ +## Interface `ConnectorSchedulingConfiguration` + +| Name | Type | Description | +| - | - | - | +| `access_control` | [ConnectorConnectorScheduling](./ConnectorConnectorScheduling.md) |   | +| `full` | [ConnectorConnectorScheduling](./ConnectorConnectorScheduling.md) |   | +| `incremental` | [ConnectorConnectorScheduling](./ConnectorConnectorScheduling.md) |   | diff --git a/docs/reference/api/ConnectorSelectOption.md b/docs/reference/api/ConnectorSelectOption.md new file mode 100644 index 000000000..c1b276038 --- /dev/null +++ b/docs/reference/api/ConnectorSelectOption.md @@ -0,0 +1,6 @@ +## Interface `ConnectorSelectOption` + +| Name | Type | Description | +| - | - | - | +| `label` | string |   | +| `value` | [ScalarValue](./ScalarValue.md) |   | diff --git a/docs/reference/api/ConnectorSyncJobCancelRequest.md b/docs/reference/api/ConnectorSyncJobCancelRequest.md new file mode 100644 index 000000000..371ecd9bd --- /dev/null +++ b/docs/reference/api/ConnectorSyncJobCancelRequest.md @@ -0,0 +1,7 @@ +## Interface `ConnectorSyncJobCancelRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { connector_sync_job_id?: never; }) | All values in `body` will be added to the request body. | +| `connector_sync_job_id` | [Id](./Id.md) | The unique identifier of the connector sync job | +| `querystring` | { [key: string]: any; } & { connector_sync_job_id?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/ConnectorSyncJobCancelResponse.md b/docs/reference/api/ConnectorSyncJobCancelResponse.md new file mode 100644 index 000000000..81d2b9a89 --- /dev/null +++ b/docs/reference/api/ConnectorSyncJobCancelResponse.md @@ -0,0 +1,5 @@ +## Interface `ConnectorSyncJobCancelResponse` + +| Name | Type | Description | +| - | - | - | +| `result` | [Result](./Result.md) |   | diff --git a/docs/reference/api/ConnectorSyncJobCheckInRequest.md b/docs/reference/api/ConnectorSyncJobCheckInRequest.md new file mode 100644 index 000000000..427fc91ed --- /dev/null +++ b/docs/reference/api/ConnectorSyncJobCheckInRequest.md @@ -0,0 +1,7 @@ +## Interface `ConnectorSyncJobCheckInRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { connector_sync_job_id?: never; }) | All values in `body` will be added to the request body. | +| `connector_sync_job_id` | [Id](./Id.md) | The unique identifier of the connector sync job to be checked in. | +| `querystring` | { [key: string]: any; } & { connector_sync_job_id?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/ConnectorSyncJobCheckInResponse.md b/docs/reference/api/ConnectorSyncJobCheckInResponse.md new file mode 100644 index 000000000..5184a6a6d --- /dev/null +++ b/docs/reference/api/ConnectorSyncJobCheckInResponse.md @@ -0,0 +1,4 @@ +## Interface `ConnectorSyncJobCheckInResponse` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/ConnectorSyncJobClaimRequest.md b/docs/reference/api/ConnectorSyncJobClaimRequest.md new file mode 100644 index 000000000..17f5bae9e --- /dev/null +++ b/docs/reference/api/ConnectorSyncJobClaimRequest.md @@ -0,0 +1,9 @@ +## Interface `ConnectorSyncJobClaimRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { connector_sync_job_id?: never; sync_cursor?: never; worker_hostname?: never; }) | All values in `body` will be added to the request body. | +| `connector_sync_job_id` | [Id](./Id.md) | The unique identifier of the connector sync job. | +| `querystring` | { [key: string]: any; } & { connector_sync_job_id?: never; sync_cursor?: never; worker_hostname?: never; } | All values in `querystring` will be added to the request querystring. | +| `sync_cursor` | any | The cursor object from the last incremental sync job. This should reference the `sync_cursor` field in the connector state for which the job runs. | +| `worker_hostname` | string | The host name of the current system that will run the job. | diff --git a/docs/reference/api/ConnectorSyncJobClaimResponse.md b/docs/reference/api/ConnectorSyncJobClaimResponse.md new file mode 100644 index 000000000..d8c539ab8 --- /dev/null +++ b/docs/reference/api/ConnectorSyncJobClaimResponse.md @@ -0,0 +1,4 @@ +## Interface `ConnectorSyncJobClaimResponse` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/ConnectorSyncJobConnectorReference.md b/docs/reference/api/ConnectorSyncJobConnectorReference.md new file mode 100644 index 000000000..55b758651 --- /dev/null +++ b/docs/reference/api/ConnectorSyncJobConnectorReference.md @@ -0,0 +1,12 @@ +## Interface `ConnectorSyncJobConnectorReference` + +| Name | Type | Description | +| - | - | - | +| `configuration` | [ConnectorConnectorConfiguration](./ConnectorConnectorConfiguration.md) |   | +| `filtering` | [ConnectorFilteringRules](./ConnectorFilteringRules.md) |   | +| `id` | [Id](./Id.md) |   | +| `index_name` | string |   | +| `language` | string |   | +| `pipeline` | [ConnectorIngestPipelineParams](./ConnectorIngestPipelineParams.md) |   | +| `service_type` | string |   | +| `sync_cursor` | any |   | diff --git a/docs/reference/api/ConnectorSyncJobDeleteRequest.md b/docs/reference/api/ConnectorSyncJobDeleteRequest.md new file mode 100644 index 000000000..011d9e36d --- /dev/null +++ b/docs/reference/api/ConnectorSyncJobDeleteRequest.md @@ -0,0 +1,7 @@ +## Interface `ConnectorSyncJobDeleteRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { connector_sync_job_id?: never; }) | All values in `body` will be added to the request body. | +| `connector_sync_job_id` | [Id](./Id.md) | The unique identifier of the connector sync job to be deleted | +| `querystring` | { [key: string]: any; } & { connector_sync_job_id?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/ConnectorSyncJobDeleteResponse.md b/docs/reference/api/ConnectorSyncJobDeleteResponse.md new file mode 100644 index 000000000..2121a6327 --- /dev/null +++ b/docs/reference/api/ConnectorSyncJobDeleteResponse.md @@ -0,0 +1,4 @@ +## `ConnectorSyncJobDeleteResponse` +::: +type ConnectorSyncJobDeleteResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); +::: diff --git a/docs/reference/api/ConnectorSyncJobErrorRequest.md b/docs/reference/api/ConnectorSyncJobErrorRequest.md new file mode 100644 index 000000000..594059f6a --- /dev/null +++ b/docs/reference/api/ConnectorSyncJobErrorRequest.md @@ -0,0 +1,8 @@ +## Interface `ConnectorSyncJobErrorRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { connector_sync_job_id?: never; error?: never; }) | All values in `body` will be added to the request body. | +| `connector_sync_job_id` | [Id](./Id.md) | The unique identifier for the connector sync job. | +| `error` | string | The error for the connector sync job error field. | +| `querystring` | { [key: string]: any; } & { connector_sync_job_id?: never; error?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/ConnectorSyncJobErrorResponse.md b/docs/reference/api/ConnectorSyncJobErrorResponse.md new file mode 100644 index 000000000..00b73067c --- /dev/null +++ b/docs/reference/api/ConnectorSyncJobErrorResponse.md @@ -0,0 +1,4 @@ +## Interface `ConnectorSyncJobErrorResponse` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/ConnectorSyncJobGetRequest.md b/docs/reference/api/ConnectorSyncJobGetRequest.md new file mode 100644 index 000000000..c2732f2c5 --- /dev/null +++ b/docs/reference/api/ConnectorSyncJobGetRequest.md @@ -0,0 +1,7 @@ +## Interface `ConnectorSyncJobGetRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { connector_sync_job_id?: never; }) | All values in `body` will be added to the request body. | +| `connector_sync_job_id` | [Id](./Id.md) | The unique identifier of the connector sync job | +| `querystring` | { [key: string]: any; } & { connector_sync_job_id?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/ConnectorSyncJobGetResponse.md b/docs/reference/api/ConnectorSyncJobGetResponse.md new file mode 100644 index 000000000..1cd7d37de --- /dev/null +++ b/docs/reference/api/ConnectorSyncJobGetResponse.md @@ -0,0 +1,4 @@ +## `ConnectorSyncJobGetResponse` +::: +type ConnectorSyncJobGetResponse = [ConnectorConnectorSyncJob](./ConnectorConnectorSyncJob.md); +::: diff --git a/docs/reference/api/ConnectorSyncJobListRequest.md b/docs/reference/api/ConnectorSyncJobListRequest.md new file mode 100644 index 000000000..22124ab9e --- /dev/null +++ b/docs/reference/api/ConnectorSyncJobListRequest.md @@ -0,0 +1,11 @@ +## Interface `ConnectorSyncJobListRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { from?: never; size?: never; status?: never; connector_id?: never; job_type?: never; }) | All values in `body` will be added to the request body. | +| `connector_id` | [Id](./Id.md) | A connector id to fetch connector sync jobs for | +| `from` | [integer](./integer.md) | Starting offset (default: 0) | +| `job_type` | [ConnectorSyncJobType](./ConnectorSyncJobType.md) | [ConnectorSyncJobType](./ConnectorSyncJobType.md)[] | A comma-separated list of job types to fetch the sync jobs for | +| `querystring` | { [key: string]: any; } & { from?: never; size?: never; status?: never; connector_id?: never; job_type?: never; } | All values in `querystring` will be added to the request querystring. | +| `size` | [integer](./integer.md) | Specifies a max number of results to get | +| `status` | [ConnectorSyncStatus](./ConnectorSyncStatus.md) | A sync job status to fetch connector sync jobs for | diff --git a/docs/reference/api/ConnectorSyncJobListResponse.md b/docs/reference/api/ConnectorSyncJobListResponse.md new file mode 100644 index 000000000..4746f5b1f --- /dev/null +++ b/docs/reference/api/ConnectorSyncJobListResponse.md @@ -0,0 +1,6 @@ +## Interface `ConnectorSyncJobListResponse` + +| Name | Type | Description | +| - | - | - | +| `count` | [long](./long.md) |   | +| `results` | [ConnectorConnectorSyncJob](./ConnectorConnectorSyncJob.md)[] |   | diff --git a/docs/reference/api/ConnectorSyncJobPostRequest.md b/docs/reference/api/ConnectorSyncJobPostRequest.md new file mode 100644 index 000000000..fd4230a68 --- /dev/null +++ b/docs/reference/api/ConnectorSyncJobPostRequest.md @@ -0,0 +1,9 @@ +## Interface `ConnectorSyncJobPostRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { id?: never; job_type?: never; trigger_method?: never; }) | All values in `body` will be added to the request body. | +| `id` | [Id](./Id.md) | The id of the associated connector | +| `job_type` | [ConnectorSyncJobType](./ConnectorSyncJobType.md) |   | +| `querystring` | { [key: string]: any; } & { id?: never; job_type?: never; trigger_method?: never; } | All values in `querystring` will be added to the request querystring. | +| `trigger_method` | [ConnectorSyncJobTriggerMethod](./ConnectorSyncJobTriggerMethod.md) |   | diff --git a/docs/reference/api/ConnectorSyncJobPostResponse.md b/docs/reference/api/ConnectorSyncJobPostResponse.md new file mode 100644 index 000000000..42239429a --- /dev/null +++ b/docs/reference/api/ConnectorSyncJobPostResponse.md @@ -0,0 +1,5 @@ +## Interface `ConnectorSyncJobPostResponse` + +| Name | Type | Description | +| - | - | - | +| `id` | [Id](./Id.md) |   | diff --git a/docs/reference/api/ConnectorSyncJobTriggerMethod.md b/docs/reference/api/ConnectorSyncJobTriggerMethod.md new file mode 100644 index 000000000..dd80f1fc3 --- /dev/null +++ b/docs/reference/api/ConnectorSyncJobTriggerMethod.md @@ -0,0 +1,4 @@ +## `ConnectorSyncJobTriggerMethod` +::: +type ConnectorSyncJobTriggerMethod = 'on_demand' | 'scheduled'; +::: diff --git a/docs/reference/api/ConnectorSyncJobType.md b/docs/reference/api/ConnectorSyncJobType.md new file mode 100644 index 000000000..e44afce47 --- /dev/null +++ b/docs/reference/api/ConnectorSyncJobType.md @@ -0,0 +1,4 @@ +## `ConnectorSyncJobType` +::: +type ConnectorSyncJobType = 'full' | 'incremental' | 'access_control'; +::: diff --git a/docs/reference/api/ConnectorSyncJobUpdateStatsRequest.md b/docs/reference/api/ConnectorSyncJobUpdateStatsRequest.md new file mode 100644 index 000000000..47b72d102 --- /dev/null +++ b/docs/reference/api/ConnectorSyncJobUpdateStatsRequest.md @@ -0,0 +1,13 @@ +## Interface `ConnectorSyncJobUpdateStatsRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { connector_sync_job_id?: never; deleted_document_count?: never; indexed_document_count?: never; indexed_document_volume?: never; last_seen?: never; metadata?: never; total_document_count?: never; }) | All values in `body` will be added to the request body. | +| `connector_sync_job_id` | [Id](./Id.md) | The unique identifier of the connector sync job. | +| `deleted_document_count` | [long](./long.md) | The number of documents the sync job deleted. | +| `indexed_document_count` | [long](./long.md) | The number of documents the sync job indexed. | +| `indexed_document_volume` | [long](./long.md) | The total size of the data (in MiB) the sync job indexed. | +| `last_seen` | [Duration](./Duration.md) | The timestamp to use in the `last_seen` property for the connector sync job. | +| `metadata` | [Metadata](./Metadata.md) | The connector-specific metadata. | +| `querystring` | { [key: string]: any; } & { connector_sync_job_id?: never; deleted_document_count?: never; indexed_document_count?: never; indexed_document_volume?: never; last_seen?: never; metadata?: never; total_document_count?: never; } | All values in `querystring` will be added to the request querystring. | +| `total_document_count` | [integer](./integer.md) | The total number of documents in the target index after the sync job finished. | diff --git a/docs/reference/api/ConnectorSyncJobUpdateStatsResponse.md b/docs/reference/api/ConnectorSyncJobUpdateStatsResponse.md new file mode 100644 index 000000000..5f3f5578d --- /dev/null +++ b/docs/reference/api/ConnectorSyncJobUpdateStatsResponse.md @@ -0,0 +1,4 @@ +## Interface `ConnectorSyncJobUpdateStatsResponse` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/ConnectorSyncRulesFeature.md b/docs/reference/api/ConnectorSyncRulesFeature.md new file mode 100644 index 000000000..091108e93 --- /dev/null +++ b/docs/reference/api/ConnectorSyncRulesFeature.md @@ -0,0 +1,6 @@ +## Interface `ConnectorSyncRulesFeature` + +| Name | Type | Description | +| - | - | - | +| `advanced` | [ConnectorFeatureEnabled](./ConnectorFeatureEnabled.md) | Indicates whether advanced sync rules are enabled. | +| `basic` | [ConnectorFeatureEnabled](./ConnectorFeatureEnabled.md) | Indicates whether basic sync rules are enabled. | diff --git a/docs/reference/api/ConnectorSyncStatus.md b/docs/reference/api/ConnectorSyncStatus.md new file mode 100644 index 000000000..77dfc29ac --- /dev/null +++ b/docs/reference/api/ConnectorSyncStatus.md @@ -0,0 +1,4 @@ +## `ConnectorSyncStatus` +::: +type ConnectorSyncStatus = 'canceling' | 'canceled' | 'completed' | 'error' | 'in_progress' | 'pending' | 'suspended'; +::: diff --git a/docs/reference/api/ConnectorUpdateActiveFilteringRequest.md b/docs/reference/api/ConnectorUpdateActiveFilteringRequest.md new file mode 100644 index 000000000..32bbe4282 --- /dev/null +++ b/docs/reference/api/ConnectorUpdateActiveFilteringRequest.md @@ -0,0 +1,7 @@ +## Interface `ConnectorUpdateActiveFilteringRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { connector_id?: never; }) | All values in `body` will be added to the request body. | +| `connector_id` | [Id](./Id.md) | The unique identifier of the connector to be updated | +| `querystring` | { [key: string]: any; } & { connector_id?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/ConnectorUpdateActiveFilteringResponse.md b/docs/reference/api/ConnectorUpdateActiveFilteringResponse.md new file mode 100644 index 000000000..91c257cbc --- /dev/null +++ b/docs/reference/api/ConnectorUpdateActiveFilteringResponse.md @@ -0,0 +1,5 @@ +## Interface `ConnectorUpdateActiveFilteringResponse` + +| Name | Type | Description | +| - | - | - | +| `result` | [Result](./Result.md) |   | diff --git a/docs/reference/api/ConnectorUpdateApiKeyIdRequest.md b/docs/reference/api/ConnectorUpdateApiKeyIdRequest.md new file mode 100644 index 000000000..1c6f65172 --- /dev/null +++ b/docs/reference/api/ConnectorUpdateApiKeyIdRequest.md @@ -0,0 +1,9 @@ +## Interface `ConnectorUpdateApiKeyIdRequest` + +| Name | Type | Description | +| - | - | - | +| `api_key_id` | string |   | +| `api_key_secret_id` | string |   | +| `body` | string | ({ [key: string]: any; } & { connector_id?: never; api_key_id?: never; api_key_secret_id?: never; }) | All values in `body` will be added to the request body. | +| `connector_id` | [Id](./Id.md) | The unique identifier of the connector to be updated | +| `querystring` | { [key: string]: any; } & { connector_id?: never; api_key_id?: never; api_key_secret_id?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/ConnectorUpdateApiKeyIdResponse.md b/docs/reference/api/ConnectorUpdateApiKeyIdResponse.md new file mode 100644 index 000000000..404cd13cf --- /dev/null +++ b/docs/reference/api/ConnectorUpdateApiKeyIdResponse.md @@ -0,0 +1,5 @@ +## Interface `ConnectorUpdateApiKeyIdResponse` + +| Name | Type | Description | +| - | - | - | +| `result` | [Result](./Result.md) |   | diff --git a/docs/reference/api/ConnectorUpdateConfigurationRequest.md b/docs/reference/api/ConnectorUpdateConfigurationRequest.md new file mode 100644 index 000000000..da4565541 --- /dev/null +++ b/docs/reference/api/ConnectorUpdateConfigurationRequest.md @@ -0,0 +1,9 @@ +## Interface `ConnectorUpdateConfigurationRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { connector_id?: never; configuration?: never; values?: never; }) | All values in `body` will be added to the request body. | +| `configuration` | [ConnectorConnectorConfiguration](./ConnectorConnectorConfiguration.md) |   | +| `connector_id` | [Id](./Id.md) | The unique identifier of the connector to be updated | +| `querystring` | { [key: string]: any; } & { connector_id?: never; configuration?: never; values?: never; } | All values in `querystring` will be added to the request querystring. | +| `values` | Record |   | diff --git a/docs/reference/api/ConnectorUpdateConfigurationResponse.md b/docs/reference/api/ConnectorUpdateConfigurationResponse.md new file mode 100644 index 000000000..217066506 --- /dev/null +++ b/docs/reference/api/ConnectorUpdateConfigurationResponse.md @@ -0,0 +1,5 @@ +## Interface `ConnectorUpdateConfigurationResponse` + +| Name | Type | Description | +| - | - | - | +| `result` | [Result](./Result.md) |   | diff --git a/docs/reference/api/ConnectorUpdateErrorRequest.md b/docs/reference/api/ConnectorUpdateErrorRequest.md new file mode 100644 index 000000000..7c4fef2e4 --- /dev/null +++ b/docs/reference/api/ConnectorUpdateErrorRequest.md @@ -0,0 +1,8 @@ +## Interface `ConnectorUpdateErrorRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { connector_id?: never; error?: never; }) | All values in `body` will be added to the request body. | +| `connector_id` | [Id](./Id.md) | The unique identifier of the connector to be updated | +| `error` | [SpecUtilsWithNullValue](./SpecUtilsWithNullValue.md) |   | +| `querystring` | { [key: string]: any; } & { connector_id?: never; error?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/ConnectorUpdateErrorResponse.md b/docs/reference/api/ConnectorUpdateErrorResponse.md new file mode 100644 index 000000000..efcb9552b --- /dev/null +++ b/docs/reference/api/ConnectorUpdateErrorResponse.md @@ -0,0 +1,5 @@ +## Interface `ConnectorUpdateErrorResponse` + +| Name | Type | Description | +| - | - | - | +| `result` | [Result](./Result.md) |   | diff --git a/docs/reference/api/ConnectorUpdateFeaturesRequest.md b/docs/reference/api/ConnectorUpdateFeaturesRequest.md new file mode 100644 index 000000000..6e9d49846 --- /dev/null +++ b/docs/reference/api/ConnectorUpdateFeaturesRequest.md @@ -0,0 +1,8 @@ +## Interface `ConnectorUpdateFeaturesRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { connector_id?: never; features?: never; }) | All values in `body` will be added to the request body. | +| `connector_id` | [Id](./Id.md) | The unique identifier of the connector to be updated. | +| `features` | [ConnectorConnectorFeatures](./ConnectorConnectorFeatures.md) |   | +| `querystring` | { [key: string]: any; } & { connector_id?: never; features?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/ConnectorUpdateFeaturesResponse.md b/docs/reference/api/ConnectorUpdateFeaturesResponse.md new file mode 100644 index 000000000..8c77b65fc --- /dev/null +++ b/docs/reference/api/ConnectorUpdateFeaturesResponse.md @@ -0,0 +1,5 @@ +## Interface `ConnectorUpdateFeaturesResponse` + +| Name | Type | Description | +| - | - | - | +| `result` | [Result](./Result.md) |   | diff --git a/docs/reference/api/ConnectorUpdateFilteringRequest.md b/docs/reference/api/ConnectorUpdateFilteringRequest.md new file mode 100644 index 000000000..4778f5e65 --- /dev/null +++ b/docs/reference/api/ConnectorUpdateFilteringRequest.md @@ -0,0 +1,10 @@ +## Interface `ConnectorUpdateFilteringRequest` + +| Name | Type | Description | +| - | - | - | +| `advanced_snippet` | [ConnectorFilteringAdvancedSnippet](./ConnectorFilteringAdvancedSnippet.md) |   | +| `body` | string | ({ [key: string]: any; } & { connector_id?: never; filtering?: never; rules?: never; advanced_snippet?: never; }) | All values in `body` will be added to the request body. | +| `connector_id` | [Id](./Id.md) | The unique identifier of the connector to be updated | +| `filtering` | [ConnectorFilteringConfig](./ConnectorFilteringConfig.md)[] |   | +| `querystring` | { [key: string]: any; } & { connector_id?: never; filtering?: never; rules?: never; advanced_snippet?: never; } | All values in `querystring` will be added to the request querystring. | +| `rules` | [ConnectorFilteringRule](./ConnectorFilteringRule.md)[] |   | diff --git a/docs/reference/api/ConnectorUpdateFilteringResponse.md b/docs/reference/api/ConnectorUpdateFilteringResponse.md new file mode 100644 index 000000000..97a90f4a6 --- /dev/null +++ b/docs/reference/api/ConnectorUpdateFilteringResponse.md @@ -0,0 +1,5 @@ +## Interface `ConnectorUpdateFilteringResponse` + +| Name | Type | Description | +| - | - | - | +| `result` | [Result](./Result.md) |   | diff --git a/docs/reference/api/ConnectorUpdateFilteringValidationRequest.md b/docs/reference/api/ConnectorUpdateFilteringValidationRequest.md new file mode 100644 index 000000000..87198a044 --- /dev/null +++ b/docs/reference/api/ConnectorUpdateFilteringValidationRequest.md @@ -0,0 +1,8 @@ +## Interface `ConnectorUpdateFilteringValidationRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { connector_id?: never; validation?: never; }) | All values in `body` will be added to the request body. | +| `connector_id` | [Id](./Id.md) | The unique identifier of the connector to be updated | +| `querystring` | { [key: string]: any; } & { connector_id?: never; validation?: never; } | All values in `querystring` will be added to the request querystring. | +| `validation` | [ConnectorFilteringRulesValidation](./ConnectorFilteringRulesValidation.md) |   | diff --git a/docs/reference/api/ConnectorUpdateFilteringValidationResponse.md b/docs/reference/api/ConnectorUpdateFilteringValidationResponse.md new file mode 100644 index 000000000..d04776b91 --- /dev/null +++ b/docs/reference/api/ConnectorUpdateFilteringValidationResponse.md @@ -0,0 +1,5 @@ +## Interface `ConnectorUpdateFilteringValidationResponse` + +| Name | Type | Description | +| - | - | - | +| `result` | [Result](./Result.md) |   | diff --git a/docs/reference/api/ConnectorUpdateIndexNameRequest.md b/docs/reference/api/ConnectorUpdateIndexNameRequest.md new file mode 100644 index 000000000..54b55348b --- /dev/null +++ b/docs/reference/api/ConnectorUpdateIndexNameRequest.md @@ -0,0 +1,8 @@ +## Interface `ConnectorUpdateIndexNameRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { connector_id?: never; index_name?: never; }) | All values in `body` will be added to the request body. | +| `connector_id` | [Id](./Id.md) | The unique identifier of the connector to be updated | +| `index_name` | [SpecUtilsWithNullValue](./SpecUtilsWithNullValue.md)<[IndexName](./IndexName.md)> |   | +| `querystring` | { [key: string]: any; } & { connector_id?: never; index_name?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/ConnectorUpdateIndexNameResponse.md b/docs/reference/api/ConnectorUpdateIndexNameResponse.md new file mode 100644 index 000000000..60342a837 --- /dev/null +++ b/docs/reference/api/ConnectorUpdateIndexNameResponse.md @@ -0,0 +1,5 @@ +## Interface `ConnectorUpdateIndexNameResponse` + +| Name | Type | Description | +| - | - | - | +| `result` | [Result](./Result.md) |   | diff --git a/docs/reference/api/ConnectorUpdateNameRequest.md b/docs/reference/api/ConnectorUpdateNameRequest.md new file mode 100644 index 000000000..c5e75ffc9 --- /dev/null +++ b/docs/reference/api/ConnectorUpdateNameRequest.md @@ -0,0 +1,9 @@ +## Interface `ConnectorUpdateNameRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { connector_id?: never; name?: never; description?: never; }) | All values in `body` will be added to the request body. | +| `connector_id` | [Id](./Id.md) | The unique identifier of the connector to be updated | +| `description` | string |   | +| `name` | string |   | +| `querystring` | { [key: string]: any; } & { connector_id?: never; name?: never; description?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/ConnectorUpdateNameResponse.md b/docs/reference/api/ConnectorUpdateNameResponse.md new file mode 100644 index 000000000..75d94b6ad --- /dev/null +++ b/docs/reference/api/ConnectorUpdateNameResponse.md @@ -0,0 +1,5 @@ +## Interface `ConnectorUpdateNameResponse` + +| Name | Type | Description | +| - | - | - | +| `result` | [Result](./Result.md) |   | diff --git a/docs/reference/api/ConnectorUpdateNativeRequest.md b/docs/reference/api/ConnectorUpdateNativeRequest.md new file mode 100644 index 000000000..b309c656e --- /dev/null +++ b/docs/reference/api/ConnectorUpdateNativeRequest.md @@ -0,0 +1,8 @@ +## Interface `ConnectorUpdateNativeRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { connector_id?: never; is_native?: never; }) | All values in `body` will be added to the request body. | +| `connector_id` | [Id](./Id.md) | The unique identifier of the connector to be updated | +| `is_native` | boolean |   | +| `querystring` | { [key: string]: any; } & { connector_id?: never; is_native?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/ConnectorUpdateNativeResponse.md b/docs/reference/api/ConnectorUpdateNativeResponse.md new file mode 100644 index 000000000..4da9efc8b --- /dev/null +++ b/docs/reference/api/ConnectorUpdateNativeResponse.md @@ -0,0 +1,5 @@ +## Interface `ConnectorUpdateNativeResponse` + +| Name | Type | Description | +| - | - | - | +| `result` | [Result](./Result.md) |   | diff --git a/docs/reference/api/ConnectorUpdatePipelineRequest.md b/docs/reference/api/ConnectorUpdatePipelineRequest.md new file mode 100644 index 000000000..37fe7617c --- /dev/null +++ b/docs/reference/api/ConnectorUpdatePipelineRequest.md @@ -0,0 +1,8 @@ +## Interface `ConnectorUpdatePipelineRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { connector_id?: never; pipeline?: never; }) | All values in `body` will be added to the request body. | +| `connector_id` | [Id](./Id.md) | The unique identifier of the connector to be updated | +| `pipeline` | [ConnectorIngestPipelineParams](./ConnectorIngestPipelineParams.md) |   | +| `querystring` | { [key: string]: any; } & { connector_id?: never; pipeline?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/ConnectorUpdatePipelineResponse.md b/docs/reference/api/ConnectorUpdatePipelineResponse.md new file mode 100644 index 000000000..8441e66ba --- /dev/null +++ b/docs/reference/api/ConnectorUpdatePipelineResponse.md @@ -0,0 +1,5 @@ +## Interface `ConnectorUpdatePipelineResponse` + +| Name | Type | Description | +| - | - | - | +| `result` | [Result](./Result.md) |   | diff --git a/docs/reference/api/ConnectorUpdateSchedulingRequest.md b/docs/reference/api/ConnectorUpdateSchedulingRequest.md new file mode 100644 index 000000000..7d2ec00a1 --- /dev/null +++ b/docs/reference/api/ConnectorUpdateSchedulingRequest.md @@ -0,0 +1,8 @@ +## Interface `ConnectorUpdateSchedulingRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { connector_id?: never; scheduling?: never; }) | All values in `body` will be added to the request body. | +| `connector_id` | [Id](./Id.md) | The unique identifier of the connector to be updated | +| `querystring` | { [key: string]: any; } & { connector_id?: never; scheduling?: never; } | All values in `querystring` will be added to the request querystring. | +| `scheduling` | [ConnectorSchedulingConfiguration](./ConnectorSchedulingConfiguration.md) |   | diff --git a/docs/reference/api/ConnectorUpdateSchedulingResponse.md b/docs/reference/api/ConnectorUpdateSchedulingResponse.md new file mode 100644 index 000000000..697829ab3 --- /dev/null +++ b/docs/reference/api/ConnectorUpdateSchedulingResponse.md @@ -0,0 +1,5 @@ +## Interface `ConnectorUpdateSchedulingResponse` + +| Name | Type | Description | +| - | - | - | +| `result` | [Result](./Result.md) |   | diff --git a/docs/reference/api/ConnectorUpdateServiceTypeRequest.md b/docs/reference/api/ConnectorUpdateServiceTypeRequest.md new file mode 100644 index 000000000..259482b96 --- /dev/null +++ b/docs/reference/api/ConnectorUpdateServiceTypeRequest.md @@ -0,0 +1,8 @@ +## Interface `ConnectorUpdateServiceTypeRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { connector_id?: never; service_type?: never; }) | All values in `body` will be added to the request body. | +| `connector_id` | [Id](./Id.md) | The unique identifier of the connector to be updated | +| `querystring` | { [key: string]: any; } & { connector_id?: never; service_type?: never; } | All values in `querystring` will be added to the request querystring. | +| `service_type` | string |   | diff --git a/docs/reference/api/ConnectorUpdateServiceTypeResponse.md b/docs/reference/api/ConnectorUpdateServiceTypeResponse.md new file mode 100644 index 000000000..6f4f8dd11 --- /dev/null +++ b/docs/reference/api/ConnectorUpdateServiceTypeResponse.md @@ -0,0 +1,5 @@ +## Interface `ConnectorUpdateServiceTypeResponse` + +| Name | Type | Description | +| - | - | - | +| `result` | [Result](./Result.md) |   | diff --git a/docs/reference/api/ConnectorUpdateStatusRequest.md b/docs/reference/api/ConnectorUpdateStatusRequest.md new file mode 100644 index 000000000..bca80871e --- /dev/null +++ b/docs/reference/api/ConnectorUpdateStatusRequest.md @@ -0,0 +1,8 @@ +## Interface `ConnectorUpdateStatusRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { connector_id?: never; status?: never; }) | All values in `body` will be added to the request body. | +| `connector_id` | [Id](./Id.md) | The unique identifier of the connector to be updated | +| `querystring` | { [key: string]: any; } & { connector_id?: never; status?: never; } | All values in `querystring` will be added to the request querystring. | +| `status` | [ConnectorConnectorStatus](./ConnectorConnectorStatus.md) |   | diff --git a/docs/reference/api/ConnectorUpdateStatusResponse.md b/docs/reference/api/ConnectorUpdateStatusResponse.md new file mode 100644 index 000000000..2eb2a4256 --- /dev/null +++ b/docs/reference/api/ConnectorUpdateStatusResponse.md @@ -0,0 +1,5 @@ +## Interface `ConnectorUpdateStatusResponse` + +| Name | Type | Description | +| - | - | - | +| `result` | [Result](./Result.md) |   | diff --git a/docs/reference/api/ConnectorValidation.md b/docs/reference/api/ConnectorValidation.md new file mode 100644 index 000000000..7a0da9720 --- /dev/null +++ b/docs/reference/api/ConnectorValidation.md @@ -0,0 +1,4 @@ +## `ConnectorValidation` +::: +type ConnectorValidation = [ConnectorLessThanValidation](./ConnectorLessThanValidation.md) | [ConnectorGreaterThanValidation](./ConnectorGreaterThanValidation.md) | [ConnectorListTypeValidation](./ConnectorListTypeValidation.md) | [ConnectorIncludedInValidation](./ConnectorIncludedInValidation.md) | [ConnectorRegexValidation](./ConnectorRegexValidation.md); +::: diff --git a/docs/reference/api/CoordsGeoBounds.md b/docs/reference/api/CoordsGeoBounds.md new file mode 100644 index 000000000..b08d8a7d6 --- /dev/null +++ b/docs/reference/api/CoordsGeoBounds.md @@ -0,0 +1,8 @@ +## Interface `CoordsGeoBounds` + +| Name | Type | Description | +| - | - | - | +| `bottom` | [double](./double.md) |   | +| `left` | [double](./double.md) |   | +| `right` | [double](./double.md) |   | +| `top` | [double](./double.md) |   | diff --git a/docs/reference/api/CountApi_1.md b/docs/reference/api/CountApi_1.md new file mode 100644 index 000000000..62c2a55f5 --- /dev/null +++ b/docs/reference/api/CountApi_1.md @@ -0,0 +1,3 @@ +::: +default function CountApi(this: [That](./That.md), params?: [CountRequest](./CountRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CountResponse](./CountResponse.md)>; +::: diff --git a/docs/reference/api/CountApi_2.md b/docs/reference/api/CountApi_2.md new file mode 100644 index 000000000..77424fcea --- /dev/null +++ b/docs/reference/api/CountApi_2.md @@ -0,0 +1,3 @@ +::: +default function CountApi(this: [That](./That.md), params?: [CountRequest](./CountRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CountResponse](./CountResponse.md), unknown>>; +::: diff --git a/docs/reference/api/CountApi_3.md b/docs/reference/api/CountApi_3.md new file mode 100644 index 000000000..edaec1b7d --- /dev/null +++ b/docs/reference/api/CountApi_3.md @@ -0,0 +1,3 @@ +::: +default function CountApi(this: [That](./That.md), params?: [CountRequest](./CountRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CountResponse](./CountResponse.md)>; +::: diff --git a/docs/reference/api/CountRequest.md b/docs/reference/api/CountRequest.md new file mode 100644 index 000000000..dd632e962 --- /dev/null +++ b/docs/reference/api/CountRequest.md @@ -0,0 +1,22 @@ +## Interface `CountRequest` + +| Name | Type | Description | +| - | - | - | +| `allow_no_indices` | boolean | If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. | +| `analyze_wildcard` | boolean | If `true`, wildcard and prefix queries are analyzed. This parameter can be used only when the `q` query string parameter is specified. | +| `analyzer` | string | The analyzer to use for the query string. This parameter can be used only when the `q` query string parameter is specified. | +| `body` | string | ({ [key: string]: any; } & { index?: never; allow_no_indices?: never; analyzer?: never; analyze_wildcard?: never; default_operator?: never; df?: never; expand_wildcards?: never; ignore_throttled?: never; ignore_unavailable?: never; lenient?: never; min_score?: never; preference?: never; routing?: never; terminate_after?: never; q?: never; query?: never; }) | All values in `body` will be added to the request body. | +| `default_operator` | [QueryDslOperator](./QueryDslOperator.md) | The default operator for query string query: `AND` or `OR`. This parameter can be used only when the `q` query string parameter is specified. | +| `df` | string | The field to use as a default when no field prefix is given in the query string. This parameter can be used only when the `q` query string parameter is specified. | +| `expand_wildcards` | [ExpandWildcards](./ExpandWildcards.md) | The type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. It supports comma-separated values, such as `open,hidden`. | +| `ignore_throttled` | boolean | If `true`, concrete, expanded, or aliased indices are ignored when frozen. | +| `ignore_unavailable` | boolean | If `false`, the request returns an error if it targets a missing or closed index. | +| `index` | [Indices](./Indices.md) | A comma-separated list of data streams, indices, and aliases to search. It supports wildcards ( `*`). To search all data streams and indices, omit this parameter or use `*` or `_all`. | +| `lenient` | boolean | If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. This parameter can be used only when the `q` query string parameter is specified. | +| `min_score` | [double](./double.md) | The minimum `_score` value that documents must have to be included in the result. | +| `preference` | string | The node or shard the operation should be performed on. By default, it is random. | +| `q` | string | The query in Lucene query string syntax. This parameter cannot be used with a request body. | +| `query` | [QueryDslQueryContainer](./QueryDslQueryContainer.md) | Defines the search query using Query DSL. A request body query cannot be used with the `q` query string parameter. | +| `querystring` | { [key: string]: any; } & { index?: never; allow_no_indices?: never; analyzer?: never; analyze_wildcard?: never; default_operator?: never; df?: never; expand_wildcards?: never; ignore_throttled?: never; ignore_unavailable?: never; lenient?: never; min_score?: never; preference?: never; routing?: never; terminate_after?: never; q?: never; query?: never; } | All values in `querystring` will be added to the request querystring. | +| `routing` | [Routing](./Routing.md) | A custom value used to route operations to a specific shard. | +| `terminate_after` | [long](./long.md) | The maximum number of documents to collect for each shard. If a query reaches this limit, Elasticsearch terminates the query early. Elasticsearch collects documents before sorting. IMPORTANT: Use with caution. Elasticsearch applies this parameter to each shard handling the request. When possible, let Elasticsearch perform early termination automatically. Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers. | diff --git a/docs/reference/api/CountResponse.md b/docs/reference/api/CountResponse.md new file mode 100644 index 000000000..6dd4fc54f --- /dev/null +++ b/docs/reference/api/CountResponse.md @@ -0,0 +1,6 @@ +## Interface `CountResponse` + +| Name | Type | Description | +| - | - | - | +| `_shards` | [ShardStatistics](./ShardStatistics.md) |   | +| `count` | [long](./long.md) |   | diff --git a/docs/reference/api/CreateAction.md b/docs/reference/api/CreateAction.md new file mode 100644 index 000000000..74e7b092d --- /dev/null +++ b/docs/reference/api/CreateAction.md @@ -0,0 +1,4 @@ +## `CreateAction` +::: +type CreateAction = [CreateActionOperation](./CreateActionOperation.md) | [[CreateActionOperation](./CreateActionOperation.md), unknown]; +::: diff --git a/docs/reference/api/CreateActionOperation.md b/docs/reference/api/CreateActionOperation.md new file mode 100644 index 000000000..995feebc4 --- /dev/null +++ b/docs/reference/api/CreateActionOperation.md @@ -0,0 +1,5 @@ +## Interface `CreateActionOperation` + +| Name | Type | Description | +| - | - | - | +| `create` | [BulkCreateOperation](./BulkCreateOperation.md) |   | diff --git a/docs/reference/api/CreateApi_1.md b/docs/reference/api/CreateApi_1.md new file mode 100644 index 000000000..722dda8ab --- /dev/null +++ b/docs/reference/api/CreateApi_1.md @@ -0,0 +1,3 @@ +::: +default function CreateApi(this: [That](./That.md), params: [CreateRequest](./CreateRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CreateResponse](./CreateResponse.md)>; +::: diff --git a/docs/reference/api/CreateApi_2.md b/docs/reference/api/CreateApi_2.md new file mode 100644 index 000000000..404affe73 --- /dev/null +++ b/docs/reference/api/CreateApi_2.md @@ -0,0 +1,3 @@ +::: +default function CreateApi(this: [That](./That.md), params: [CreateRequest](./CreateRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CreateResponse](./CreateResponse.md), unknown>>; +::: diff --git a/docs/reference/api/CreateApi_3.md b/docs/reference/api/CreateApi_3.md new file mode 100644 index 000000000..f940e4937 --- /dev/null +++ b/docs/reference/api/CreateApi_3.md @@ -0,0 +1,3 @@ +::: +default function CreateApi(this: [That](./That.md), params: [CreateRequest](./CreateRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CreateResponse](./CreateResponse.md)>; +::: diff --git a/docs/reference/api/CreateRequest.md b/docs/reference/api/CreateRequest.md new file mode 100644 index 000000000..0e9597de9 --- /dev/null +++ b/docs/reference/api/CreateRequest.md @@ -0,0 +1,22 @@ +## Interface `CreateRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { id?: never; index?: never; if_primary_term?: never; if_seq_no?: never; include_source_on_error?: never; op_type?: never; pipeline?: never; refresh?: never; require_alias?: never; require_data_stream?: never; routing?: never; timeout?: never; version?: never; version_type?: never; wait_for_active_shards?: never; document?: never; }) | All values in `body` will be added to the request body. | +| `document` | TDocument |   | +| `id` | [Id](./Id.md) | A unique identifier for the document. To automatically generate a document ID, use the `POST //_doc/` request format. | +| `if_primary_term` | [long](./long.md) | Only perform the operation if the document has this primary term. | +| `if_seq_no` | [SequenceNumber](./SequenceNumber.md) | Only perform the operation if the document has this sequence number. | +| `include_source_on_error` | boolean | True or false if to include the document source in the error message in case of parsing errors. | +| `index` | [IndexName](./IndexName.md) | The name of the data stream or index to target. If the target doesn't exist and matches the name or wildcard ( `*`) pattern of an index template with a `data_stream` definition, this request creates the data stream. If the target doesn't exist and doesn’t match a data stream template, this request creates the index. | +| `op_type` | [OpType](./OpType.md) | Set to `create` to only index the document if it does not already exist (put if absent). If a document with the specified `_id` already exists, the indexing operation will fail. The behavior is the same as using the `/_create` endpoint. If a document ID is specified, this paramater defaults to `index`. Otherwise, it defaults to `create`. If the request targets a data stream, an `op_type` of `create` is required. | +| `pipeline` | string | The ID of the pipeline to use to preprocess incoming documents. If the index has a default ingest pipeline specified, setting the value to `_none` turns off the default ingest pipeline for this request. If a final pipeline is configured, it will always run regardless of the value of this parameter. | +| `querystring` | { [key: string]: any; } & { id?: never; index?: never; if_primary_term?: never; if_seq_no?: never; include_source_on_error?: never; op_type?: never; pipeline?: never; refresh?: never; require_alias?: never; require_data_stream?: never; routing?: never; timeout?: never; version?: never; version_type?: never; wait_for_active_shards?: never; document?: never; } | All values in `querystring` will be added to the request querystring. | +| `refresh` | [Refresh](./Refresh.md) | If `true`, Elasticsearch refreshes the affected shards to make this operation visible to search. If `wait_for`, it waits for a refresh to make this operation visible to search. If `false`, it does nothing with refreshes. | +| `require_alias` | boolean | If `true`, the destination must be an index alias. | +| `require_data_stream` | boolean | If `true`, the request's actions must target a data stream (existing or to be created). | +| `routing` | [Routing](./Routing.md) | A custom value that is used to route operations to a specific shard. | +| `timeout` | [Duration](./Duration.md) | The period the request waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards. Elasticsearch waits for at least the specified timeout period before failing. The actual wait time could be longer, particularly when multiple waits occur. This parameter is useful for situations where the primary shard assigned to perform the operation might not be available when the operation runs. Some reasons for this might be that the primary shard is currently recovering from a gateway or undergoing relocation. By default, the operation will wait on the primary shard to become available for at least 1 minute before failing and responding with an error. The actual wait time could be longer, particularly when multiple waits occur. | +| `version_type` | [VersionType](./VersionType.md) | The version type. | +| `version` | [VersionNumber](./VersionNumber.md) | The explicit version number for concurrency control. It must be a non-negative long number. | +| `wait_for_active_shards` | [WaitForActiveShards](./WaitForActiveShards.md) | The number of shard copies that must be active before proceeding with the operation. You can set it to `all` or any positive integer up to the total number of shards in the index ( `number_of_replicas+1`). The default value of `1` means it waits for each primary shard to be active. | diff --git a/docs/reference/api/CreateResponse.md b/docs/reference/api/CreateResponse.md new file mode 100644 index 000000000..dbbb09fce --- /dev/null +++ b/docs/reference/api/CreateResponse.md @@ -0,0 +1,4 @@ +## `CreateResponse` +::: +type CreateResponse = [WriteResponseBase](./WriteResponseBase.md); +::: diff --git a/docs/reference/api/DFIIndependenceMeasure.md b/docs/reference/api/DFIIndependenceMeasure.md new file mode 100644 index 000000000..75e6bfb5d --- /dev/null +++ b/docs/reference/api/DFIIndependenceMeasure.md @@ -0,0 +1,4 @@ +## `DFIIndependenceMeasure` +::: +type DFIIndependenceMeasure = 'standardized' | 'saturated' | 'chisquared'; +::: diff --git a/docs/reference/api/DFRAfterEffect.md b/docs/reference/api/DFRAfterEffect.md new file mode 100644 index 000000000..201bbf9e8 --- /dev/null +++ b/docs/reference/api/DFRAfterEffect.md @@ -0,0 +1,4 @@ +## `DFRAfterEffect` +::: +type DFRAfterEffect = 'no' | 'b' | 'l'; +::: diff --git a/docs/reference/api/DFRBasicModel.md b/docs/reference/api/DFRBasicModel.md new file mode 100644 index 000000000..1cffe83c1 --- /dev/null +++ b/docs/reference/api/DFRBasicModel.md @@ -0,0 +1,4 @@ +## `DFRBasicModel` +::: +type DFRBasicModel = 'be' | 'd' | 'g' | 'if' | 'in' | 'ine' | 'p'; +::: diff --git a/docs/reference/api/DanglingIndices.md b/docs/reference/api/DanglingIndices.md new file mode 100644 index 000000000..80b869dae --- /dev/null +++ b/docs/reference/api/DanglingIndices.md @@ -0,0 +1,20 @@ +## `DanglingIndices` + +### Constructor + +::: +new DanglingIndices(transport: [Transport](./Transport.md)); +::: + +### Properties + +| Name | Type | Description | +| - | - | - | +| `acceptedParams` | Record |   | +| `transport` | [Transport](./Transport.md) |   | + +### Methods + +| Name | Signature | Description | +| - | - | - | +| `deleteDanglingIndex` | `deleteDanglingIndex(this: [That](./That.md), params: [DanglingIndicesDeleteDanglingIndexRequest](./DanglingIndicesDeleteDanglingIndexRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[DanglingIndicesDeleteDanglingIndexResponse](./DanglingIndicesDeleteDanglingIndexResponse.md)>;` | Delete a dangling index. If Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling. For example, this can happen if you delete more than `cluster.indices.tombstones.size` indices while an Elasticsearch node is offline. || `deleteDanglingIndex` | `deleteDanglingIndex(this: [That](./That.md), params: [DanglingIndicesDeleteDanglingIndexRequest](./DanglingIndicesDeleteDanglingIndexRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[DanglingIndicesDeleteDanglingIndexResponse](./DanglingIndicesDeleteDanglingIndexResponse.md), unknown>>;` |   || `deleteDanglingIndex` | `deleteDanglingIndex(this: [That](./That.md), params: [DanglingIndicesDeleteDanglingIndexRequest](./DanglingIndicesDeleteDanglingIndexRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[DanglingIndicesDeleteDanglingIndexResponse](./DanglingIndicesDeleteDanglingIndexResponse.md)>;` |   || `importDanglingIndex` | `importDanglingIndex(this: [That](./That.md), params: [DanglingIndicesImportDanglingIndexRequest](./DanglingIndicesImportDanglingIndexRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[DanglingIndicesImportDanglingIndexResponse](./DanglingIndicesImportDanglingIndexResponse.md)>;` | Import a dangling index. If Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling. For example, this can happen if you delete more than `cluster.indices.tombstones.size` indices while an Elasticsearch node is offline. || `importDanglingIndex` | `importDanglingIndex(this: [That](./That.md), params: [DanglingIndicesImportDanglingIndexRequest](./DanglingIndicesImportDanglingIndexRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[DanglingIndicesImportDanglingIndexResponse](./DanglingIndicesImportDanglingIndexResponse.md), unknown>>;` |   || `importDanglingIndex` | `importDanglingIndex(this: [That](./That.md), params: [DanglingIndicesImportDanglingIndexRequest](./DanglingIndicesImportDanglingIndexRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[DanglingIndicesImportDanglingIndexResponse](./DanglingIndicesImportDanglingIndexResponse.md)>;` |   || `listDanglingIndices` | `listDanglingIndices(this: [That](./That.md), params?: [DanglingIndicesListDanglingIndicesRequest](./DanglingIndicesListDanglingIndicesRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[DanglingIndicesListDanglingIndicesResponse](./DanglingIndicesListDanglingIndicesResponse.md)>;` | Get the dangling indices. If Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling. For example, this can happen if you delete more than `cluster.indices.tombstones.size` indices while an Elasticsearch node is offline. Use this API to list dangling indices, which you can then import or delete. || `listDanglingIndices` | `listDanglingIndices(this: [That](./That.md), params?: [DanglingIndicesListDanglingIndicesRequest](./DanglingIndicesListDanglingIndicesRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[DanglingIndicesListDanglingIndicesResponse](./DanglingIndicesListDanglingIndicesResponse.md), unknown>>;` |   || `listDanglingIndices` | `listDanglingIndices(this: [That](./That.md), params?: [DanglingIndicesListDanglingIndicesRequest](./DanglingIndicesListDanglingIndicesRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[DanglingIndicesListDanglingIndicesResponse](./DanglingIndicesListDanglingIndicesResponse.md)>;` |   | \ No newline at end of file diff --git a/docs/reference/api/DanglingIndicesDeleteDanglingIndexRequest.md b/docs/reference/api/DanglingIndicesDeleteDanglingIndexRequest.md new file mode 100644 index 000000000..56043c983 --- /dev/null +++ b/docs/reference/api/DanglingIndicesDeleteDanglingIndexRequest.md @@ -0,0 +1,10 @@ +## Interface `DanglingIndicesDeleteDanglingIndexRequest` + +| Name | Type | Description | +| - | - | - | +| `accept_data_loss` | boolean | This parameter must be set to true to acknowledge that it will no longer be possible to recove data from the dangling index. | +| `body` | string | ({ [key: string]: any; } & { index_uuid?: never; accept_data_loss?: never; master_timeout?: never; timeout?: never; }) | All values in `body` will be added to the request body. | +| `index_uuid` | [Uuid](./Uuid.md) | The UUID of the index to delete. Use the get dangling indices API to find the UUID. | +| `master_timeout` | [Duration](./Duration.md) | Specify timeout for connection to master | +| `querystring` | { [key: string]: any; } & { index_uuid?: never; accept_data_loss?: never; master_timeout?: never; timeout?: never; } | All values in `querystring` will be added to the request querystring. | +| `timeout` | [Duration](./Duration.md) | Explicit operation timeout | diff --git a/docs/reference/api/DanglingIndicesDeleteDanglingIndexResponse.md b/docs/reference/api/DanglingIndicesDeleteDanglingIndexResponse.md new file mode 100644 index 000000000..e809c81ff --- /dev/null +++ b/docs/reference/api/DanglingIndicesDeleteDanglingIndexResponse.md @@ -0,0 +1,4 @@ +## `DanglingIndicesDeleteDanglingIndexResponse` +::: +type DanglingIndicesDeleteDanglingIndexResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); +::: diff --git a/docs/reference/api/DanglingIndicesImportDanglingIndexRequest.md b/docs/reference/api/DanglingIndicesImportDanglingIndexRequest.md new file mode 100644 index 000000000..71171c4da --- /dev/null +++ b/docs/reference/api/DanglingIndicesImportDanglingIndexRequest.md @@ -0,0 +1,10 @@ +## Interface `DanglingIndicesImportDanglingIndexRequest` + +| Name | Type | Description | +| - | - | - | +| `accept_data_loss` | boolean | This parameter must be set to true to import a dangling index. Because Elasticsearch cannot know where the dangling index data came from or determine which shard copies are fresh and which are stale, it cannot guarantee that the imported data represents the latest state of the index when it was last in the cluster. | +| `body` | string | ({ [key: string]: any; } & { index_uuid?: never; accept_data_loss?: never; master_timeout?: never; timeout?: never; }) | All values in `body` will be added to the request body. | +| `index_uuid` | [Uuid](./Uuid.md) | The UUID of the index to import. Use the get dangling indices API to locate the UUID. | +| `master_timeout` | [Duration](./Duration.md) | Specify timeout for connection to master | +| `querystring` | { [key: string]: any; } & { index_uuid?: never; accept_data_loss?: never; master_timeout?: never; timeout?: never; } | All values in `querystring` will be added to the request querystring. | +| `timeout` | [Duration](./Duration.md) | Explicit operation timeout | diff --git a/docs/reference/api/DanglingIndicesImportDanglingIndexResponse.md b/docs/reference/api/DanglingIndicesImportDanglingIndexResponse.md new file mode 100644 index 000000000..4eae4185d --- /dev/null +++ b/docs/reference/api/DanglingIndicesImportDanglingIndexResponse.md @@ -0,0 +1,4 @@ +## `DanglingIndicesImportDanglingIndexResponse` +::: +type DanglingIndicesImportDanglingIndexResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); +::: diff --git a/docs/reference/api/DanglingIndicesListDanglingIndicesDanglingIndex.md b/docs/reference/api/DanglingIndicesListDanglingIndicesDanglingIndex.md new file mode 100644 index 000000000..8f3e2ebaa --- /dev/null +++ b/docs/reference/api/DanglingIndicesListDanglingIndicesDanglingIndex.md @@ -0,0 +1,8 @@ +## Interface `DanglingIndicesListDanglingIndicesDanglingIndex` + +| Name | Type | Description | +| - | - | - | +| `creation_date_millis` | [EpochTime](./EpochTime.md)<[UnitMillis](./UnitMillis.md)> |   | +| `index_name` | string |   | +| `index_uuid` | string |   | +| `node_ids` | [Ids](./Ids.md) |   | diff --git a/docs/reference/api/DanglingIndicesListDanglingIndicesRequest.md b/docs/reference/api/DanglingIndicesListDanglingIndicesRequest.md new file mode 100644 index 000000000..a61704761 --- /dev/null +++ b/docs/reference/api/DanglingIndicesListDanglingIndicesRequest.md @@ -0,0 +1,6 @@ +## Interface `DanglingIndicesListDanglingIndicesRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | { [key: string]: any; } | All values in `body` will be added to the request body. | +| `querystring` | { [key: string]: any; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/DanglingIndicesListDanglingIndicesResponse.md b/docs/reference/api/DanglingIndicesListDanglingIndicesResponse.md new file mode 100644 index 000000000..f7671a803 --- /dev/null +++ b/docs/reference/api/DanglingIndicesListDanglingIndicesResponse.md @@ -0,0 +1,5 @@ +## Interface `DanglingIndicesListDanglingIndicesResponse` + +| Name | Type | Description | +| - | - | - | +| `dangling_indices` | [DanglingIndicesListDanglingIndicesDanglingIndex](./DanglingIndicesListDanglingIndicesDanglingIndex.md)[] |   | diff --git a/docs/reference/api/DataStreamName.md b/docs/reference/api/DataStreamName.md new file mode 100644 index 000000000..0797bc0e0 --- /dev/null +++ b/docs/reference/api/DataStreamName.md @@ -0,0 +1,4 @@ +## `DataStreamName` +::: +type DataStreamName = string; +::: diff --git a/docs/reference/api/DataStreamNames.md b/docs/reference/api/DataStreamNames.md new file mode 100644 index 000000000..db15334cf --- /dev/null +++ b/docs/reference/api/DataStreamNames.md @@ -0,0 +1,4 @@ +## `DataStreamNames` +::: +type DataStreamNames = [DataStreamName](./DataStreamName.md) | [DataStreamName](./DataStreamName.md)[]; +::: diff --git a/docs/reference/api/DateFormat.md b/docs/reference/api/DateFormat.md new file mode 100644 index 000000000..9e15f2e49 --- /dev/null +++ b/docs/reference/api/DateFormat.md @@ -0,0 +1,4 @@ +## `DateFormat` +::: +type DateFormat = string; +::: diff --git a/docs/reference/api/DateMath.md b/docs/reference/api/DateMath.md new file mode 100644 index 000000000..5507c3ec6 --- /dev/null +++ b/docs/reference/api/DateMath.md @@ -0,0 +1,4 @@ +## `DateMath` +::: +type DateMath = string | [Date](./Date.md); +::: diff --git a/docs/reference/api/DateTime.md b/docs/reference/api/DateTime.md new file mode 100644 index 000000000..d1ecc0e7d --- /dev/null +++ b/docs/reference/api/DateTime.md @@ -0,0 +1,4 @@ +## `DateTime` +::: +type DateTime = string | [EpochTime](./EpochTime.md)<[UnitMillis](./UnitMillis.md)> | [Date](./Date.md); +::: diff --git a/docs/reference/api/DeleteAction.md b/docs/reference/api/DeleteAction.md new file mode 100644 index 000000000..7f61e3767 --- /dev/null +++ b/docs/reference/api/DeleteAction.md @@ -0,0 +1,5 @@ +## Interface `DeleteAction` + +| Name | Type | Description | +| - | - | - | +| `delete` | [BulkDeleteOperation](./BulkDeleteOperation.md) |   | diff --git a/docs/reference/api/DeleteApi_1.md b/docs/reference/api/DeleteApi_1.md new file mode 100644 index 000000000..f5844be66 --- /dev/null +++ b/docs/reference/api/DeleteApi_1.md @@ -0,0 +1,3 @@ +::: +default function DeleteApi(this: [That](./That.md), params: [DeleteRequest](./DeleteRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[DeleteResponse](./DeleteResponse.md)>; +::: diff --git a/docs/reference/api/DeleteApi_2.md b/docs/reference/api/DeleteApi_2.md new file mode 100644 index 000000000..fd2f1e276 --- /dev/null +++ b/docs/reference/api/DeleteApi_2.md @@ -0,0 +1,3 @@ +::: +default function DeleteApi(this: [That](./That.md), params: [DeleteRequest](./DeleteRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[DeleteResponse](./DeleteResponse.md), unknown>>; +::: diff --git a/docs/reference/api/DeleteApi_3.md b/docs/reference/api/DeleteApi_3.md new file mode 100644 index 000000000..d03130325 --- /dev/null +++ b/docs/reference/api/DeleteApi_3.md @@ -0,0 +1,3 @@ +::: +default function DeleteApi(this: [That](./That.md), params: [DeleteRequest](./DeleteRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[DeleteResponse](./DeleteResponse.md)>; +::: diff --git a/docs/reference/api/DeleteByQueryApi_1.md b/docs/reference/api/DeleteByQueryApi_1.md new file mode 100644 index 000000000..f8fe5939e --- /dev/null +++ b/docs/reference/api/DeleteByQueryApi_1.md @@ -0,0 +1,3 @@ +::: +default function DeleteByQueryApi(this: [That](./That.md), params: [DeleteByQueryRequest](./DeleteByQueryRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[DeleteByQueryResponse](./DeleteByQueryResponse.md)>; +::: diff --git a/docs/reference/api/DeleteByQueryApi_2.md b/docs/reference/api/DeleteByQueryApi_2.md new file mode 100644 index 000000000..81f3d635e --- /dev/null +++ b/docs/reference/api/DeleteByQueryApi_2.md @@ -0,0 +1,3 @@ +::: +default function DeleteByQueryApi(this: [That](./That.md), params: [DeleteByQueryRequest](./DeleteByQueryRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[DeleteByQueryResponse](./DeleteByQueryResponse.md), unknown>>; +::: diff --git a/docs/reference/api/DeleteByQueryApi_3.md b/docs/reference/api/DeleteByQueryApi_3.md new file mode 100644 index 000000000..b93a836c5 --- /dev/null +++ b/docs/reference/api/DeleteByQueryApi_3.md @@ -0,0 +1,3 @@ +::: +default function DeleteByQueryApi(this: [That](./That.md), params: [DeleteByQueryRequest](./DeleteByQueryRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[DeleteByQueryResponse](./DeleteByQueryResponse.md)>; +::: diff --git a/docs/reference/api/DeleteByQueryRequest.md b/docs/reference/api/DeleteByQueryRequest.md new file mode 100644 index 000000000..f4103127a --- /dev/null +++ b/docs/reference/api/DeleteByQueryRequest.md @@ -0,0 +1,38 @@ +## Interface `DeleteByQueryRequest` + +| Name | Type | Description | +| - | - | - | +| `allow_no_indices` | boolean | If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. | +| `analyze_wildcard` | boolean | If `true`, wildcard and prefix queries are analyzed. This parameter can be used only when the `q` query string parameter is specified. | +| `analyzer` | string | Analyzer to use for the query string. This parameter can be used only when the `q` query string parameter is specified. | +| `body` | string | ({ [key: string]: any; } & { index?: never; allow_no_indices?: never; analyzer?: never; analyze_wildcard?: never; conflicts?: never; default_operator?: never; df?: never; expand_wildcards?: never; from?: never; ignore_unavailable?: never; lenient?: never; preference?: never; refresh?: never; request_cache?: never; requests_per_second?: never; routing?: never; q?: never; scroll?: never; scroll_size?: never; search_timeout?: never; search_type?: never; slices?: never; sort?: never; stats?: never; terminate_after?: never; timeout?: never; version?: never; wait_for_active_shards?: never; wait_for_completion?: never; max_docs?: never; query?: never; slice?: never; }) | All values in `body` will be added to the request body. | +| `conflicts` | [Conflicts](./Conflicts.md) | What to do if delete by query hits version conflicts: `abort` or `proceed`. | +| `default_operator` | [QueryDslOperator](./QueryDslOperator.md) | The default operator for query string query: `AND` or `OR`. This parameter can be used only when the `q` query string parameter is specified. | +| `df` | string | The field to use as default where no field prefix is given in the query string. This parameter can be used only when the `q` query string parameter is specified. | +| `expand_wildcards` | [ExpandWildcards](./ExpandWildcards.md) | The type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. It supports comma-separated values, such as `open,hidden`. | +| `from` | [long](./long.md) | Skips the specified number of documents. | +| `ignore_unavailable` | boolean | If `false`, the request returns an error if it targets a missing or closed index. | +| `index` | [Indices](./Indices.md) | A comma-separated list of data streams, indices, and aliases to search. It supports wildcards ( `*`). To search all data streams or indices, omit this parameter or use `*` or `_all`. | +| `lenient` | boolean | If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. This parameter can be used only when the `q` query string parameter is specified. | +| `max_docs` | [long](./long.md) | The maximum number of documents to delete. | +| `preference` | string | The node or shard the operation should be performed on. It is random by default. | +| `q` | string | A query in the Lucene query string syntax. | +| `query` | [QueryDslQueryContainer](./QueryDslQueryContainer.md) | The documents to delete specified with Query DSL. | +| `querystring` | { [key: string]: any; } & { index?: never; allow_no_indices?: never; analyzer?: never; analyze_wildcard?: never; conflicts?: never; default_operator?: never; df?: never; expand_wildcards?: never; from?: never; ignore_unavailable?: never; lenient?: never; preference?: never; refresh?: never; request_cache?: never; requests_per_second?: never; routing?: never; q?: never; scroll?: never; scroll_size?: never; search_timeout?: never; search_type?: never; slices?: never; sort?: never; stats?: never; terminate_after?: never; timeout?: never; version?: never; wait_for_active_shards?: never; wait_for_completion?: never; max_docs?: never; query?: never; slice?: never; } | All values in `querystring` will be added to the request querystring. | +| `refresh` | boolean | If `true`, Elasticsearch refreshes all shards involved in the delete by query after the request completes. This is different than the delete API's `refresh` parameter, which causes just the shard that received the delete request to be refreshed. Unlike the delete API, it does not support `wait_for`. | +| `request_cache` | boolean | If `true`, the request cache is used for this request. Defaults to the index-level setting. | +| `requests_per_second` | [float](./float.md) | The throttle for this request in sub-requests per second. | +| `routing` | [Routing](./Routing.md) | A custom value used to route operations to a specific shard. | +| `scroll_size` | [long](./long.md) | The size of the scroll request that powers the operation. | +| `scroll` | [Duration](./Duration.md) | The period to retain the search context for scrolling. | +| `search_timeout` | [Duration](./Duration.md) | The explicit timeout for each search request. It defaults to no timeout. | +| `search_type` | [SearchType](./SearchType.md) | The type of the search operation. Available options include `query_then_fetch` and `dfs_query_then_fetch`. | +| `slice` | [SlicedScroll](./SlicedScroll.md) | Slice the request manually using the provided slice ID and total number of slices. | +| `slices` | [Slices](./Slices.md) | The number of slices this task should be divided into. | +| `sort` | string[] | A comma-separated list of `:` pairs. | +| `stats` | string[] | The specific `tag` of the request for logging and statistical purposes. | +| `terminate_after` | [long](./long.md) | The maximum number of documents to collect for each shard. If a query reaches this limit, Elasticsearch terminates the query early. Elasticsearch collects documents before sorting. Use with caution. Elasticsearch applies this parameter to each shard handling the request. When possible, let Elasticsearch perform early termination automatically. Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers. | +| `timeout` | [Duration](./Duration.md) | The period each deletion request waits for active shards. | +| `version` | boolean | If `true`, returns the document version as part of a hit. | +| `wait_for_active_shards` | [WaitForActiveShards](./WaitForActiveShards.md) | The number of shard copies that must be active before proceeding with the operation. Set to `all` or any positive integer up to the total number of shards in the index ( `number_of_replicas+1`). The `timeout` value controls how long each write request waits for unavailable shards to become available. | +| `wait_for_completion` | boolean | If `true`, the request blocks until the operation is complete. If `false`, Elasticsearch performs some preflight checks, launches the request, and returns a task you can use to cancel or get the status of the task. Elasticsearch creates a record of this task as a document at `.tasks/task/${taskId}`. When you are done with a task, you should delete the task document so Elasticsearch can reclaim the space. | diff --git a/docs/reference/api/DeleteByQueryResponse.md b/docs/reference/api/DeleteByQueryResponse.md new file mode 100644 index 000000000..d51b6a577 --- /dev/null +++ b/docs/reference/api/DeleteByQueryResponse.md @@ -0,0 +1,20 @@ +## Interface `DeleteByQueryResponse` + +| Name | Type | Description | +| - | - | - | +| `batches` | [long](./long.md) | The number of scroll responses pulled back by the delete by query. | +| `deleted` | [long](./long.md) | The number of documents that were successfully deleted. | +| `failures` | [BulkIndexByScrollFailure](./BulkIndexByScrollFailure.md)[] | An array of failures if there were any unrecoverable errors during the process. If this array is not empty, the request ended abnormally because of those failures. Delete by query is implemented using batches and any failures cause the entire process to end but all failures in the current batch are collected into the array. You can use the `conflicts` option to prevent reindex from ending on version conflicts. | +| `noops` | [long](./long.md) | This field is always equal to zero for delete by query. It exists only so that delete by query, update by query, and reindex APIs return responses with the same structure. | +| `requests_per_second` | [float](./float.md) | The number of requests per second effectively run during the delete by query. | +| `retries` | [Retries](./Retries.md) | The number of retries attempted by delete by query. `bulk` is the number of bulk actions retried. `search` is the number of search actions retried. | +| `slice_id` | [integer](./integer.md) |   | +| `task` | [TaskId](./TaskId.md) |   | +| `throttled_millis` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> | The number of milliseconds the request slept to conform to `requests_per_second`. | +| `throttled_until_millis` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> | This field should always be equal to zero in a `_delete_by_query` response. It has meaning only when using the task API, where it indicates the next time (in milliseconds since epoch) a throttled request will be run again in order to conform to `requests_per_second`. | +| `throttled_until` | [Duration](./Duration.md) |   | +| `throttled` | [Duration](./Duration.md) |   | +| `timed_out` | boolean | If `true`, some requests run during the delete by query operation timed out. | +| `took` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> | The number of milliseconds from start to end of the whole operation. | +| `total` | [long](./long.md) | The number of documents that were successfully processed. | +| `version_conflicts` | [long](./long.md) | The number of version conflicts that the delete by query hit. | diff --git a/docs/reference/api/DeleteByQueryRethrottleApi_1.md b/docs/reference/api/DeleteByQueryRethrottleApi_1.md new file mode 100644 index 000000000..431a53aa7 --- /dev/null +++ b/docs/reference/api/DeleteByQueryRethrottleApi_1.md @@ -0,0 +1,3 @@ +::: +default function DeleteByQueryRethrottleApi(this: [That](./That.md), params: [DeleteByQueryRethrottleRequest](./DeleteByQueryRethrottleRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[DeleteByQueryRethrottleResponse](./DeleteByQueryRethrottleResponse.md)>; +::: diff --git a/docs/reference/api/DeleteByQueryRethrottleApi_2.md b/docs/reference/api/DeleteByQueryRethrottleApi_2.md new file mode 100644 index 000000000..6c7afd0f5 --- /dev/null +++ b/docs/reference/api/DeleteByQueryRethrottleApi_2.md @@ -0,0 +1,3 @@ +::: +default function DeleteByQueryRethrottleApi(this: [That](./That.md), params: [DeleteByQueryRethrottleRequest](./DeleteByQueryRethrottleRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[DeleteByQueryRethrottleResponse](./DeleteByQueryRethrottleResponse.md), unknown>>; +::: diff --git a/docs/reference/api/DeleteByQueryRethrottleApi_3.md b/docs/reference/api/DeleteByQueryRethrottleApi_3.md new file mode 100644 index 000000000..e9f5c4e3f --- /dev/null +++ b/docs/reference/api/DeleteByQueryRethrottleApi_3.md @@ -0,0 +1,3 @@ +::: +default function DeleteByQueryRethrottleApi(this: [That](./That.md), params: [DeleteByQueryRethrottleRequest](./DeleteByQueryRethrottleRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[DeleteByQueryRethrottleResponse](./DeleteByQueryRethrottleResponse.md)>; +::: diff --git a/docs/reference/api/DeleteByQueryRethrottleRequest.md b/docs/reference/api/DeleteByQueryRethrottleRequest.md new file mode 100644 index 000000000..c2f917367 --- /dev/null +++ b/docs/reference/api/DeleteByQueryRethrottleRequest.md @@ -0,0 +1,8 @@ +## Interface `DeleteByQueryRethrottleRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { task_id?: never; requests_per_second?: never; }) | All values in `body` will be added to the request body. | +| `querystring` | { [key: string]: any; } & { task_id?: never; requests_per_second?: never; } | All values in `querystring` will be added to the request querystring. | +| `requests_per_second` | [float](./float.md) | The throttle for this request in sub-requests per second. To disable throttling, set it to `-1`. | +| `task_id` | [TaskId](./TaskId.md) | The ID for the task. | diff --git a/docs/reference/api/DeleteByQueryRethrottleResponse.md b/docs/reference/api/DeleteByQueryRethrottleResponse.md new file mode 100644 index 000000000..23e0287e7 --- /dev/null +++ b/docs/reference/api/DeleteByQueryRethrottleResponse.md @@ -0,0 +1,4 @@ +## `DeleteByQueryRethrottleResponse` +::: +type DeleteByQueryRethrottleResponse = [TasksTaskListResponseBase](./TasksTaskListResponseBase.md); +::: diff --git a/docs/reference/api/DeleteRequest.md b/docs/reference/api/DeleteRequest.md new file mode 100644 index 000000000..0667c74f3 --- /dev/null +++ b/docs/reference/api/DeleteRequest.md @@ -0,0 +1,16 @@ +## Interface `DeleteRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { id?: never; index?: never; if_primary_term?: never; if_seq_no?: never; refresh?: never; routing?: never; timeout?: never; version?: never; version_type?: never; wait_for_active_shards?: never; }) | All values in `body` will be added to the request body. | +| `id` | [Id](./Id.md) | A unique identifier for the document. | +| `if_primary_term` | [long](./long.md) | Only perform the operation if the document has this primary term. | +| `if_seq_no` | [SequenceNumber](./SequenceNumber.md) | Only perform the operation if the document has this sequence number. | +| `index` | [IndexName](./IndexName.md) | The name of the target index. | +| `querystring` | { [key: string]: any; } & { id?: never; index?: never; if_primary_term?: never; if_seq_no?: never; refresh?: never; routing?: never; timeout?: never; version?: never; version_type?: never; wait_for_active_shards?: never; } | All values in `querystring` will be added to the request querystring. | +| `refresh` | [Refresh](./Refresh.md) | If `true`, Elasticsearch refreshes the affected shards to make this operation visible to search. If `wait_for`, it waits for a refresh to make this operation visible to search. If `false`, it does nothing with refreshes. | +| `routing` | [Routing](./Routing.md) | A custom value used to route operations to a specific shard. | +| `timeout` | [Duration](./Duration.md) | The period to wait for active shards. This parameter is useful for situations where the primary shard assigned to perform the delete operation might not be available when the delete operation runs. Some reasons for this might be that the primary shard is currently recovering from a store or undergoing relocation. By default, the delete operation will wait on the primary shard to become available for up to 1 minute before failing and responding with an error. | +| `version_type` | [VersionType](./VersionType.md) | The version type. | +| `version` | [VersionNumber](./VersionNumber.md) | An explicit version number for concurrency control. It must match the current version of the document for the request to succeed. | +| `wait_for_active_shards` | [WaitForActiveShards](./WaitForActiveShards.md) | The minimum number of shard copies that must be active before proceeding with the operation. You can set it to `all` or any positive integer up to the total number of shards in the index ( `number_of_replicas+1`). The default value of `1` means it waits for each primary shard to be active. | diff --git a/docs/reference/api/DeleteResponse.md b/docs/reference/api/DeleteResponse.md new file mode 100644 index 000000000..9db48cc74 --- /dev/null +++ b/docs/reference/api/DeleteResponse.md @@ -0,0 +1,4 @@ +## `DeleteResponse` +::: +type DeleteResponse = [WriteResponseBase](./WriteResponseBase.md); +::: diff --git a/docs/reference/api/DeleteScriptApi_1.md b/docs/reference/api/DeleteScriptApi_1.md new file mode 100644 index 000000000..53bad8dce --- /dev/null +++ b/docs/reference/api/DeleteScriptApi_1.md @@ -0,0 +1,3 @@ +::: +default function DeleteScriptApi(this: [That](./That.md), params: [DeleteScriptRequest](./DeleteScriptRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[DeleteScriptResponse](./DeleteScriptResponse.md)>; +::: diff --git a/docs/reference/api/DeleteScriptApi_2.md b/docs/reference/api/DeleteScriptApi_2.md new file mode 100644 index 000000000..b66639fc5 --- /dev/null +++ b/docs/reference/api/DeleteScriptApi_2.md @@ -0,0 +1,3 @@ +::: +default function DeleteScriptApi(this: [That](./That.md), params: [DeleteScriptRequest](./DeleteScriptRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[DeleteScriptResponse](./DeleteScriptResponse.md), unknown>>; +::: diff --git a/docs/reference/api/DeleteScriptApi_3.md b/docs/reference/api/DeleteScriptApi_3.md new file mode 100644 index 000000000..0b85e37bd --- /dev/null +++ b/docs/reference/api/DeleteScriptApi_3.md @@ -0,0 +1,3 @@ +::: +default function DeleteScriptApi(this: [That](./That.md), params: [DeleteScriptRequest](./DeleteScriptRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[DeleteScriptResponse](./DeleteScriptResponse.md)>; +::: diff --git a/docs/reference/api/DeleteScriptRequest.md b/docs/reference/api/DeleteScriptRequest.md new file mode 100644 index 000000000..8cb6201eb --- /dev/null +++ b/docs/reference/api/DeleteScriptRequest.md @@ -0,0 +1,9 @@ +## Interface `DeleteScriptRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { id?: never; master_timeout?: never; timeout?: never; }) | All values in `body` will be added to the request body. | +| `id` | [Id](./Id.md) | The identifier for the stored script or search template. | +| `master_timeout` | [Duration](./Duration.md) | The period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. It can also be set to `-1` to indicate that the request should never timeout. | +| `querystring` | { [key: string]: any; } & { id?: never; master_timeout?: never; timeout?: never; } | All values in `querystring` will be added to the request querystring. | +| `timeout` | [Duration](./Duration.md) | The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. It can also be set to `-1` to indicate that the request should never timeout. | diff --git a/docs/reference/api/DeleteScriptResponse.md b/docs/reference/api/DeleteScriptResponse.md new file mode 100644 index 000000000..4460bad7c --- /dev/null +++ b/docs/reference/api/DeleteScriptResponse.md @@ -0,0 +1,4 @@ +## `DeleteScriptResponse` +::: +type DeleteScriptResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); +::: diff --git a/docs/reference/api/Distance.md b/docs/reference/api/Distance.md new file mode 100644 index 000000000..c0e0c9010 --- /dev/null +++ b/docs/reference/api/Distance.md @@ -0,0 +1,4 @@ +## `Distance` +::: +type Distance = string; +::: diff --git a/docs/reference/api/DistanceUnit.md b/docs/reference/api/DistanceUnit.md new file mode 100644 index 000000000..c1356f0d1 --- /dev/null +++ b/docs/reference/api/DistanceUnit.md @@ -0,0 +1,4 @@ +## `DistanceUnit` +::: +type DistanceUnit = 'in' | 'ft' | 'yd' | 'mi' | 'nmi' | 'km' | 'm' | 'cm' | 'mm'; +::: diff --git a/docs/reference/api/DocStats.md b/docs/reference/api/DocStats.md new file mode 100644 index 000000000..e5e4de566 --- /dev/null +++ b/docs/reference/api/DocStats.md @@ -0,0 +1,6 @@ +## Interface `DocStats` + +| Name | Type | Description | +| - | - | - | +| `count` | [long](./long.md) | Total number of non-deleted documents across all primary shards assigned to selected nodes. This number is based on documents in Lucene segments and may include documents from nested fields. | +| `deleted` | [long](./long.md) | Total number of deleted documents across all primary shards assigned to selected nodes. This number is based on documents in Lucene segments. Elasticsearch reclaims the disk space of deleted Lucene documents when a segment is merged. | diff --git a/docs/reference/api/Duration.md b/docs/reference/api/Duration.md new file mode 100644 index 000000000..3f29386bb --- /dev/null +++ b/docs/reference/api/Duration.md @@ -0,0 +1,4 @@ +## `Duration` +::: +type Duration = string | -1 | 0; +::: diff --git a/docs/reference/api/DurationLarge.md b/docs/reference/api/DurationLarge.md new file mode 100644 index 000000000..d722dd095 --- /dev/null +++ b/docs/reference/api/DurationLarge.md @@ -0,0 +1,4 @@ +## `DurationLarge` +::: +type DurationLarge = string; +::: diff --git a/docs/reference/api/DurationValue.md b/docs/reference/api/DurationValue.md new file mode 100644 index 000000000..df98a7610 --- /dev/null +++ b/docs/reference/api/DurationValue.md @@ -0,0 +1,4 @@ +## `DurationValue` +::: +type DurationValue = Unit; +::: diff --git a/docs/reference/api/ElasticsearchVersionInfo.md b/docs/reference/api/ElasticsearchVersionInfo.md new file mode 100644 index 000000000..813c3d08c --- /dev/null +++ b/docs/reference/api/ElasticsearchVersionInfo.md @@ -0,0 +1,13 @@ +## Interface `ElasticsearchVersionInfo` + +| Name | Type | Description | +| - | - | - | +| `build_date` | [DateTime](./DateTime.md) | The Elasticsearch Git commit's date. | +| `build_flavor` | string | The build flavor. For example, `default`. | +| `build_hash` | string | The Elasticsearch Git commit's SHA hash. | +| `build_snapshot` | boolean | Indicates whether the Elasticsearch build was a snapshot. | +| `build_type` | string | The build type that corresponds to how Elasticsearch was installed. For example, `docker`, `rpm`, or `tar`. | +| `lucene_version` | [VersionString](./VersionString.md) | The version number of Elasticsearch's underlying Lucene software. | +| `minimum_index_compatibility_version` | [VersionString](./VersionString.md) | The minimum index version with which the responding node can read from disk. | +| `minimum_wire_compatibility_version` | [VersionString](./VersionString.md) | The minimum node version with which the responding node can communicate. Also the minimum version from which you can perform a rolling upgrade. | +| `number` | string | The Elasticsearch version number. | diff --git a/docs/reference/api/ElasticsearchVersionMinInfo.md b/docs/reference/api/ElasticsearchVersionMinInfo.md new file mode 100644 index 000000000..80069ee09 --- /dev/null +++ b/docs/reference/api/ElasticsearchVersionMinInfo.md @@ -0,0 +1,8 @@ +## Interface `ElasticsearchVersionMinInfo` + +| Name | Type | Description | +| - | - | - | +| `build_flavor` | string |   | +| `minimum_index_compatibility_version` | [VersionString](./VersionString.md) |   | +| `minimum_wire_compatibility_version` | [VersionString](./VersionString.md) |   | +| `number` | string |   | diff --git a/docs/reference/api/EmptyObject.md b/docs/reference/api/EmptyObject.md new file mode 100644 index 000000000..de563b81c --- /dev/null +++ b/docs/reference/api/EmptyObject.md @@ -0,0 +1,4 @@ +## Interface `EmptyObject` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/Enrich.md b/docs/reference/api/Enrich.md new file mode 100644 index 000000000..9fb9194ce --- /dev/null +++ b/docs/reference/api/Enrich.md @@ -0,0 +1,20 @@ +## `Enrich` + +### Constructor + +::: +new Enrich(transport: [Transport](./Transport.md)); +::: + +### Properties + +| Name | Type | Description | +| - | - | - | +| `acceptedParams` | Record |   | +| `transport` | [Transport](./Transport.md) |   | + +### Methods + +| Name | Signature | Description | +| - | - | - | +| `deletePolicy` | `deletePolicy(this: [That](./That.md), params: [EnrichDeletePolicyRequest](./EnrichDeletePolicyRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[EnrichDeletePolicyResponse](./EnrichDeletePolicyResponse.md)>;` | Delete an enrich policy. Deletes an existing enrich policy and its enrich index. || `deletePolicy` | `deletePolicy(this: [That](./That.md), params: [EnrichDeletePolicyRequest](./EnrichDeletePolicyRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[EnrichDeletePolicyResponse](./EnrichDeletePolicyResponse.md), unknown>>;` |   || `deletePolicy` | `deletePolicy(this: [That](./That.md), params: [EnrichDeletePolicyRequest](./EnrichDeletePolicyRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[EnrichDeletePolicyResponse](./EnrichDeletePolicyResponse.md)>;` |   || `executePolicy` | `executePolicy(this: [That](./That.md), params: [EnrichExecutePolicyRequest](./EnrichExecutePolicyRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[EnrichExecutePolicyResponse](./EnrichExecutePolicyResponse.md)>;` | Run an enrich policy. Create the enrich index for an existing enrich policy. || `executePolicy` | `executePolicy(this: [That](./That.md), params: [EnrichExecutePolicyRequest](./EnrichExecutePolicyRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[EnrichExecutePolicyResponse](./EnrichExecutePolicyResponse.md), unknown>>;` |   || `executePolicy` | `executePolicy(this: [That](./That.md), params: [EnrichExecutePolicyRequest](./EnrichExecutePolicyRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[EnrichExecutePolicyResponse](./EnrichExecutePolicyResponse.md)>;` |   || `getPolicy` | `getPolicy(this: [That](./That.md), params?: [EnrichGetPolicyRequest](./EnrichGetPolicyRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[EnrichGetPolicyResponse](./EnrichGetPolicyResponse.md)>;` | Get an enrich policy. Returns information about an enrich policy. || `getPolicy` | `getPolicy(this: [That](./That.md), params?: [EnrichGetPolicyRequest](./EnrichGetPolicyRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[EnrichGetPolicyResponse](./EnrichGetPolicyResponse.md), unknown>>;` |   || `getPolicy` | `getPolicy(this: [That](./That.md), params?: [EnrichGetPolicyRequest](./EnrichGetPolicyRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[EnrichGetPolicyResponse](./EnrichGetPolicyResponse.md)>;` |   || `putPolicy` | `putPolicy(this: [That](./That.md), params: [EnrichPutPolicyRequest](./EnrichPutPolicyRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[EnrichPutPolicyResponse](./EnrichPutPolicyResponse.md)>;` | Create an enrich policy. Creates an enrich policy. || `putPolicy` | `putPolicy(this: [That](./That.md), params: [EnrichPutPolicyRequest](./EnrichPutPolicyRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[EnrichPutPolicyResponse](./EnrichPutPolicyResponse.md), unknown>>;` |   || `putPolicy` | `putPolicy(this: [That](./That.md), params: [EnrichPutPolicyRequest](./EnrichPutPolicyRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[EnrichPutPolicyResponse](./EnrichPutPolicyResponse.md)>;` |   || `stats` | `stats(this: [That](./That.md), params?: [EnrichStatsRequest](./EnrichStatsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[EnrichStatsResponse](./EnrichStatsResponse.md)>;` | Get enrich stats. Returns enrich coordinator statistics and information about enrich policies that are currently executing. || `stats` | `stats(this: [That](./That.md), params?: [EnrichStatsRequest](./EnrichStatsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[EnrichStatsResponse](./EnrichStatsResponse.md), unknown>>;` |   || `stats` | `stats(this: [That](./That.md), params?: [EnrichStatsRequest](./EnrichStatsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[EnrichStatsResponse](./EnrichStatsResponse.md)>;` |   | \ No newline at end of file diff --git a/docs/reference/api/EnrichDeletePolicyRequest.md b/docs/reference/api/EnrichDeletePolicyRequest.md new file mode 100644 index 000000000..9a9ab2a68 --- /dev/null +++ b/docs/reference/api/EnrichDeletePolicyRequest.md @@ -0,0 +1,8 @@ +## Interface `EnrichDeletePolicyRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { name?: never; master_timeout?: never; }) | All values in `body` will be added to the request body. | +| `master_timeout` | [Duration](./Duration.md) | Period to wait for a connection to the master node. | +| `name` | [Name](./Name.md) | Enrich policy to delete. | +| `querystring` | { [key: string]: any; } & { name?: never; master_timeout?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/EnrichDeletePolicyResponse.md b/docs/reference/api/EnrichDeletePolicyResponse.md new file mode 100644 index 000000000..83c2bd0cb --- /dev/null +++ b/docs/reference/api/EnrichDeletePolicyResponse.md @@ -0,0 +1,4 @@ +## `EnrichDeletePolicyResponse` +::: +type EnrichDeletePolicyResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); +::: diff --git a/docs/reference/api/EnrichExecutePolicyEnrichPolicyPhase.md b/docs/reference/api/EnrichExecutePolicyEnrichPolicyPhase.md new file mode 100644 index 000000000..329702e00 --- /dev/null +++ b/docs/reference/api/EnrichExecutePolicyEnrichPolicyPhase.md @@ -0,0 +1,4 @@ +## `EnrichExecutePolicyEnrichPolicyPhase` +::: +type EnrichExecutePolicyEnrichPolicyPhase = 'SCHEDULED' | 'RUNNING' | 'COMPLETE' | 'FAILED' | 'CANCELLED'; +::: diff --git a/docs/reference/api/EnrichExecutePolicyExecuteEnrichPolicyStatus.md b/docs/reference/api/EnrichExecutePolicyExecuteEnrichPolicyStatus.md new file mode 100644 index 000000000..00c611645 --- /dev/null +++ b/docs/reference/api/EnrichExecutePolicyExecuteEnrichPolicyStatus.md @@ -0,0 +1,6 @@ +## Interface `EnrichExecutePolicyExecuteEnrichPolicyStatus` + +| Name | Type | Description | +| - | - | - | +| `phase` | [EnrichExecutePolicyEnrichPolicyPhase](./EnrichExecutePolicyEnrichPolicyPhase.md) |   | +| `step` | string |   | diff --git a/docs/reference/api/EnrichExecutePolicyRequest.md b/docs/reference/api/EnrichExecutePolicyRequest.md new file mode 100644 index 000000000..cd332c440 --- /dev/null +++ b/docs/reference/api/EnrichExecutePolicyRequest.md @@ -0,0 +1,9 @@ +## Interface `EnrichExecutePolicyRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { name?: never; master_timeout?: never; wait_for_completion?: never; }) | All values in `body` will be added to the request body. | +| `master_timeout` | [Duration](./Duration.md) | Period to wait for a connection to the master node. | +| `name` | [Name](./Name.md) | Enrich policy to execute. | +| `querystring` | { [key: string]: any; } & { name?: never; master_timeout?: never; wait_for_completion?: never; } | All values in `querystring` will be added to the request querystring. | +| `wait_for_completion` | boolean | If `true`, the request blocks other enrich policy execution requests until complete. | diff --git a/docs/reference/api/EnrichExecutePolicyResponse.md b/docs/reference/api/EnrichExecutePolicyResponse.md new file mode 100644 index 000000000..4f0d9cc8e --- /dev/null +++ b/docs/reference/api/EnrichExecutePolicyResponse.md @@ -0,0 +1,6 @@ +## Interface `EnrichExecutePolicyResponse` + +| Name | Type | Description | +| - | - | - | +| `status` | [EnrichExecutePolicyExecuteEnrichPolicyStatus](./EnrichExecutePolicyExecuteEnrichPolicyStatus.md) |   | +| `task` | [TaskId](./TaskId.md) |   | diff --git a/docs/reference/api/EnrichGetPolicyRequest.md b/docs/reference/api/EnrichGetPolicyRequest.md new file mode 100644 index 000000000..5f2580c5f --- /dev/null +++ b/docs/reference/api/EnrichGetPolicyRequest.md @@ -0,0 +1,8 @@ +## Interface `EnrichGetPolicyRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { name?: never; master_timeout?: never; }) | All values in `body` will be added to the request body. | +| `master_timeout` | [Duration](./Duration.md) | Period to wait for a connection to the master node. | +| `name` | [Names](./Names.md) | Comma-separated list of enrich policy names used to limit the request. To return information for all enrich policies, omit this parameter. | +| `querystring` | { [key: string]: any; } & { name?: never; master_timeout?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/EnrichGetPolicyResponse.md b/docs/reference/api/EnrichGetPolicyResponse.md new file mode 100644 index 000000000..0dc6ba991 --- /dev/null +++ b/docs/reference/api/EnrichGetPolicyResponse.md @@ -0,0 +1,5 @@ +## Interface `EnrichGetPolicyResponse` + +| Name | Type | Description | +| - | - | - | +| `policies` | [EnrichSummary](./EnrichSummary.md)[] |   | diff --git a/docs/reference/api/EnrichPolicy.md b/docs/reference/api/EnrichPolicy.md new file mode 100644 index 000000000..0758d9f08 --- /dev/null +++ b/docs/reference/api/EnrichPolicy.md @@ -0,0 +1,10 @@ +## Interface `EnrichPolicy` + +| Name | Type | Description | +| - | - | - | +| `elasticsearch_version` | string |   | +| `enrich_fields` | [Fields](./Fields.md) |   | +| `indices` | [Indices](./Indices.md) |   | +| `match_field` | [Field](./Field.md) |   | +| `name` | [Name](./Name.md) |   | +| `query` | [QueryDslQueryContainer](./QueryDslQueryContainer.md) |   | diff --git a/docs/reference/api/EnrichPolicyType.md b/docs/reference/api/EnrichPolicyType.md new file mode 100644 index 000000000..514037c73 --- /dev/null +++ b/docs/reference/api/EnrichPolicyType.md @@ -0,0 +1,4 @@ +## `EnrichPolicyType` +::: +type EnrichPolicyType = 'geo_match' | 'match' | 'range'; +::: diff --git a/docs/reference/api/EnrichPutPolicyRequest.md b/docs/reference/api/EnrichPutPolicyRequest.md new file mode 100644 index 000000000..86920afb8 --- /dev/null +++ b/docs/reference/api/EnrichPutPolicyRequest.md @@ -0,0 +1,11 @@ +## Interface `EnrichPutPolicyRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { name?: never; master_timeout?: never; geo_match?: never; match?: never; range?: never; }) | All values in `body` will be added to the request body. | +| `geo_match` | [EnrichPolicy](./EnrichPolicy.md) | Matches enrich data to incoming documents based on a `geo_shape` query. | +| `master_timeout` | [Duration](./Duration.md) | Period to wait for a connection to the master node. | +| `match` | [EnrichPolicy](./EnrichPolicy.md) | Matches enrich data to incoming documents based on a `term` query. | +| `name` | [Name](./Name.md) | Name of the enrich policy to create or update. | +| `querystring` | { [key: string]: any; } & { name?: never; master_timeout?: never; geo_match?: never; match?: never; range?: never; } | All values in `querystring` will be added to the request querystring. | +| `range` | [EnrichPolicy](./EnrichPolicy.md) | Matches a number, date, or IP address in incoming documents to a range in the enrich index based on a `term` query. | diff --git a/docs/reference/api/EnrichPutPolicyResponse.md b/docs/reference/api/EnrichPutPolicyResponse.md new file mode 100644 index 000000000..8f9d7ddb5 --- /dev/null +++ b/docs/reference/api/EnrichPutPolicyResponse.md @@ -0,0 +1,4 @@ +## `EnrichPutPolicyResponse` +::: +type EnrichPutPolicyResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); +::: diff --git a/docs/reference/api/EnrichStatsCacheStats.md b/docs/reference/api/EnrichStatsCacheStats.md new file mode 100644 index 000000000..2864640a4 --- /dev/null +++ b/docs/reference/api/EnrichStatsCacheStats.md @@ -0,0 +1,12 @@ +## Interface `EnrichStatsCacheStats` + +| Name | Type | Description | +| - | - | - | +| `count` | [integer](./integer.md) |   | +| `evictions` | [integer](./integer.md) |   | +| `hits_time_in_millis` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> |   | +| `hits` | [integer](./integer.md) |   | +| `misses_time_in_millis` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> |   | +| `misses` | [integer](./integer.md) |   | +| `node_id` | [Id](./Id.md) |   | +| `size_in_bytes` | [long](./long.md) |   | diff --git a/docs/reference/api/EnrichStatsCoordinatorStats.md b/docs/reference/api/EnrichStatsCoordinatorStats.md new file mode 100644 index 000000000..9229337fa --- /dev/null +++ b/docs/reference/api/EnrichStatsCoordinatorStats.md @@ -0,0 +1,9 @@ +## Interface `EnrichStatsCoordinatorStats` + +| Name | Type | Description | +| - | - | - | +| `executed_searches_total` | [long](./long.md) |   | +| `node_id` | [Id](./Id.md) |   | +| `queue_size` | [integer](./integer.md) |   | +| `remote_requests_current` | [integer](./integer.md) |   | +| `remote_requests_total` | [long](./long.md) |   | diff --git a/docs/reference/api/EnrichStatsExecutingPolicy.md b/docs/reference/api/EnrichStatsExecutingPolicy.md new file mode 100644 index 000000000..1b277c0d2 --- /dev/null +++ b/docs/reference/api/EnrichStatsExecutingPolicy.md @@ -0,0 +1,6 @@ +## Interface `EnrichStatsExecutingPolicy` + +| Name | Type | Description | +| - | - | - | +| `name` | [Name](./Name.md) |   | +| `task` | [TasksTaskInfo](./TasksTaskInfo.md) |   | diff --git a/docs/reference/api/EnrichStatsRequest.md b/docs/reference/api/EnrichStatsRequest.md new file mode 100644 index 000000000..759d29ad2 --- /dev/null +++ b/docs/reference/api/EnrichStatsRequest.md @@ -0,0 +1,7 @@ +## Interface `EnrichStatsRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { master_timeout?: never; }) | All values in `body` will be added to the request body. | +| `master_timeout` | [Duration](./Duration.md) | Period to wait for a connection to the master node. | +| `querystring` | { [key: string]: any; } & { master_timeout?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/EnrichStatsResponse.md b/docs/reference/api/EnrichStatsResponse.md new file mode 100644 index 000000000..8f203b38a --- /dev/null +++ b/docs/reference/api/EnrichStatsResponse.md @@ -0,0 +1,7 @@ +## Interface `EnrichStatsResponse` + +| Name | Type | Description | +| - | - | - | +| `cache_stats` | [EnrichStatsCacheStats](./EnrichStatsCacheStats.md)[] | Objects containing information about the enrich cache stats on each ingest node. | +| `coordinator_stats` | [EnrichStatsCoordinatorStats](./EnrichStatsCoordinatorStats.md)[] | Objects containing information about each coordinating ingest node for configured enrich processors. | +| `executing_policies` | [EnrichStatsExecutingPolicy](./EnrichStatsExecutingPolicy.md)[] | Objects containing information about each enrich policy that is currently executing. | diff --git a/docs/reference/api/EnrichSummary.md b/docs/reference/api/EnrichSummary.md new file mode 100644 index 000000000..2626ad099 --- /dev/null +++ b/docs/reference/api/EnrichSummary.md @@ -0,0 +1,5 @@ +## Interface `EnrichSummary` + +| Name | Type | Description | +| - | - | - | +| `config` | [Partial](./Partial.md)> |   | diff --git a/docs/reference/api/EpochTime.md b/docs/reference/api/EpochTime.md new file mode 100644 index 000000000..e6f446485 --- /dev/null +++ b/docs/reference/api/EpochTime.md @@ -0,0 +1,4 @@ +## `EpochTime` +::: +type EpochTime = Unit; +::: diff --git a/docs/reference/api/Eql.md b/docs/reference/api/Eql.md new file mode 100644 index 000000000..da6243bf0 --- /dev/null +++ b/docs/reference/api/Eql.md @@ -0,0 +1,20 @@ +## `Eql` + +### Constructor + +::: +new Eql(transport: [Transport](./Transport.md)); +::: + +### Properties + +| Name | Type | Description | +| - | - | - | +| `acceptedParams` | Record |   | +| `transport` | [Transport](./Transport.md) |   | + +### Methods + +| Name | Signature | Description | +| - | - | - | +| `delete` | `delete(this: [That](./That.md), params: [EqlDeleteRequest](./EqlDeleteRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[EqlDeleteResponse](./EqlDeleteResponse.md)>;` | Delete an async EQL search. Delete an async EQL search or a stored synchronous EQL search. The API also deletes results for the search. || `delete` | `delete(this: [That](./That.md), params: [EqlDeleteRequest](./EqlDeleteRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[EqlDeleteResponse](./EqlDeleteResponse.md), unknown>>;` |   || `delete` | `delete(this: [That](./That.md), params: [EqlDeleteRequest](./EqlDeleteRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[EqlDeleteResponse](./EqlDeleteResponse.md)>;` |   || `get` | `get(this: [That](./That.md), params: [EqlGetRequest](./EqlGetRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[EqlGetResponse](./EqlGetResponse.md)>;` | Get async EQL search results. Get the current status and available results for an async EQL search or a stored synchronous EQL search. || `get` | `get(this: [That](./That.md), params: [EqlGetRequest](./EqlGetRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[EqlGetResponse](./EqlGetResponse.md), unknown>>;` |   || `get` | `get(this: [That](./That.md), params: [EqlGetRequest](./EqlGetRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[EqlGetResponse](./EqlGetResponse.md)>;` |   || `getStatus` | `getStatus(this: [That](./That.md), params: [EqlGetStatusRequest](./EqlGetStatusRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[EqlGetStatusResponse](./EqlGetStatusResponse.md)>;` | Get the async EQL status. Get the current status for an async EQL search or a stored synchronous EQL search without returning results. || `getStatus` | `getStatus(this: [That](./That.md), params: [EqlGetStatusRequest](./EqlGetStatusRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[EqlGetStatusResponse](./EqlGetStatusResponse.md), unknown>>;` |   || `getStatus` | `getStatus(this: [That](./That.md), params: [EqlGetStatusRequest](./EqlGetStatusRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[EqlGetStatusResponse](./EqlGetStatusResponse.md)>;` |   || `search` | `search(this: [That](./That.md), params: [EqlSearchRequest](./EqlSearchRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[EqlSearchResponse](./EqlSearchResponse.md)>;` | Get EQL search results. Returns search results for an Event Query Language (EQL) query. EQL assumes each document in a data stream or index corresponds to an event. || `search` | `search(this: [That](./That.md), params: [EqlSearchRequest](./EqlSearchRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[EqlSearchResponse](./EqlSearchResponse.md), unknown>>;` |   || `search` | `search(this: [That](./That.md), params: [EqlSearchRequest](./EqlSearchRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[EqlSearchResponse](./EqlSearchResponse.md)>;` |   | \ No newline at end of file diff --git a/docs/reference/api/EqlDeleteRequest.md b/docs/reference/api/EqlDeleteRequest.md new file mode 100644 index 000000000..f144804d7 --- /dev/null +++ b/docs/reference/api/EqlDeleteRequest.md @@ -0,0 +1,7 @@ +## Interface `EqlDeleteRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { id?: never; }) | All values in `body` will be added to the request body. | +| `id` | [Id](./Id.md) | Identifier for the search to delete. A search ID is provided in the EQL search API's response for an async search. A search ID is also provided if the request’s `keep_on_completion` parameter is `true`. | +| `querystring` | { [key: string]: any; } & { id?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/EqlDeleteResponse.md b/docs/reference/api/EqlDeleteResponse.md new file mode 100644 index 000000000..8fd958654 --- /dev/null +++ b/docs/reference/api/EqlDeleteResponse.md @@ -0,0 +1,4 @@ +## `EqlDeleteResponse` +::: +type EqlDeleteResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); +::: diff --git a/docs/reference/api/EqlEqlHits.md b/docs/reference/api/EqlEqlHits.md new file mode 100644 index 000000000..42e7f321d --- /dev/null +++ b/docs/reference/api/EqlEqlHits.md @@ -0,0 +1,7 @@ +## Interface `EqlEqlHits` + +| Name | Type | Description | +| - | - | - | +| `events` | [EqlHitsEvent](./EqlHitsEvent.md)[] | Contains events matching the query. Each object represents a matching event. | +| `sequences` | [EqlHitsSequence](./EqlHitsSequence.md)[] | Contains event sequences matching the query. Each object represents a matching sequence. This parameter is only returned for EQL queries containing a sequence. | +| `total` | [SearchTotalHits](./SearchTotalHits.md) | Metadata about the number of matching events or sequences. | diff --git a/docs/reference/api/EqlEqlSearchResponseBase.md b/docs/reference/api/EqlEqlSearchResponseBase.md new file mode 100644 index 000000000..9d4320e83 --- /dev/null +++ b/docs/reference/api/EqlEqlSearchResponseBase.md @@ -0,0 +1,11 @@ +## Interface `EqlEqlSearchResponseBase` + +| Name | Type | Description | +| - | - | - | +| `hits` | [EqlEqlHits](./EqlEqlHits.md) | Contains matching events and sequences. Also contains related metadata. | +| `id` | [Id](./Id.md) | Identifier for the search. | +| `is_partial` | boolean | If true, the response does not contain complete search results. | +| `is_running` | boolean | If true, the search request is still executing. | +| `shard_failures` | [ShardFailure](./ShardFailure.md)[] | Contains information about shard failures (if any), in case allow_partial_search_results=true | +| `timed_out` | boolean | If true, the request timed out before completion. | +| `took` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> | Milliseconds it took Elasticsearch to execute the request. | diff --git a/docs/reference/api/EqlGetRequest.md b/docs/reference/api/EqlGetRequest.md new file mode 100644 index 000000000..83fb557da --- /dev/null +++ b/docs/reference/api/EqlGetRequest.md @@ -0,0 +1,9 @@ +## Interface `EqlGetRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { id?: never; keep_alive?: never; wait_for_completion_timeout?: never; }) | All values in `body` will be added to the request body. | +| `id` | [Id](./Id.md) | Identifier for the search. | +| `keep_alive` | [Duration](./Duration.md) | Period for which the search and its results are stored on the cluster. Defaults to the keep_alive value set by the search’s EQL search API request. | +| `querystring` | { [key: string]: any; } & { id?: never; keep_alive?: never; wait_for_completion_timeout?: never; } | All values in `querystring` will be added to the request querystring. | +| `wait_for_completion_timeout` | [Duration](./Duration.md) | Timeout duration to wait for the request to finish. Defaults to no timeout, meaning the request waits for complete search results. | diff --git a/docs/reference/api/EqlGetResponse.md b/docs/reference/api/EqlGetResponse.md new file mode 100644 index 000000000..f7888d9f7 --- /dev/null +++ b/docs/reference/api/EqlGetResponse.md @@ -0,0 +1,4 @@ +## `EqlGetResponse` +::: +type EqlGetResponse = [EqlEqlSearchResponseBase](./EqlEqlSearchResponseBase.md); +::: diff --git a/docs/reference/api/EqlGetStatusRequest.md b/docs/reference/api/EqlGetStatusRequest.md new file mode 100644 index 000000000..eb17445e1 --- /dev/null +++ b/docs/reference/api/EqlGetStatusRequest.md @@ -0,0 +1,7 @@ +## Interface `EqlGetStatusRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { id?: never; }) | All values in `body` will be added to the request body. | +| `id` | [Id](./Id.md) | Identifier for the search. | +| `querystring` | { [key: string]: any; } & { id?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/EqlGetStatusResponse.md b/docs/reference/api/EqlGetStatusResponse.md new file mode 100644 index 000000000..262f6845c --- /dev/null +++ b/docs/reference/api/EqlGetStatusResponse.md @@ -0,0 +1,10 @@ +## Interface `EqlGetStatusResponse` + +| Name | Type | Description | +| - | - | - | +| `completion_status` | [integer](./integer.md) | For a completed search shows the http status code of the completed search. | +| `expiration_time_in_millis` | [EpochTime](./EpochTime.md)<[UnitMillis](./UnitMillis.md)> | Shows a timestamp when the eql search will be expired, in milliseconds since the Unix epoch. When this time is reached, the search and its results are deleted, even if the search is still ongoing. | +| `id` | [Id](./Id.md) | Identifier for the search. | +| `is_partial` | boolean | If true, the search request is still executing. If false, the search is completed. | +| `is_running` | boolean | If true, the response does not contain complete search results. This could be because either the search is still running (is_running status is false), or because it is already completed (is_running status is true) and results are partial due to failures or timeouts. | +| `start_time_in_millis` | [EpochTime](./EpochTime.md)<[UnitMillis](./UnitMillis.md)> | For a running search shows a timestamp when the eql search started, in milliseconds since the Unix epoch. | diff --git a/docs/reference/api/EqlHitsEvent.md b/docs/reference/api/EqlHitsEvent.md new file mode 100644 index 000000000..cf03e67a5 --- /dev/null +++ b/docs/reference/api/EqlHitsEvent.md @@ -0,0 +1,9 @@ +## Interface `EqlHitsEvent` + +| Name | Type | Description | +| - | - | - | +| `_id` | [Id](./Id.md) | Unique identifier for the event. This ID is only unique within the index. | +| `_index` | [IndexName](./IndexName.md) | Name of the index containing the event. | +| `_source` | TEvent | Original JSON body passed for the event at index time. | +| `fields` | Record<[Field](./Field.md), any[]> |   | +| `missing` | boolean | Set to `true` for events in a timespan-constrained sequence that do not meet a given condition. | diff --git a/docs/reference/api/EqlHitsSequence.md b/docs/reference/api/EqlHitsSequence.md new file mode 100644 index 000000000..7c33c9960 --- /dev/null +++ b/docs/reference/api/EqlHitsSequence.md @@ -0,0 +1,6 @@ +## Interface `EqlHitsSequence` + +| Name | Type | Description | +| - | - | - | +| `events` | [EqlHitsEvent](./EqlHitsEvent.md)[] | Contains events matching the query. Each object represents a matching event. | +| `join_keys` | any[] | Shared field values used to constrain matches in the sequence. These are defined using the by keyword in the EQL query syntax. | diff --git a/docs/reference/api/EqlSearchRequest.md b/docs/reference/api/EqlSearchRequest.md new file mode 100644 index 000000000..3a2b2438a --- /dev/null +++ b/docs/reference/api/EqlSearchRequest.md @@ -0,0 +1,27 @@ +## Interface `EqlSearchRequest` + +| Name | Type | Description | +| - | - | - | +| `allow_no_indices` | boolean |   | +| `allow_partial_search_results` | boolean | Allow query execution also in case of shard failures. If true, the query will keep running and will return results based on the available shards. For sequences, the behavior can be further refined using allow_partial_sequence_results | +| `allow_partial_sequence_results` | boolean | This flag applies only to sequences and has effect only if allow_partial_search_results=true. If true, the sequence query will return results based on the available shards, ignoring the others. If false, the sequence query will return successfully, but will always have empty results. | +| `body` | string | ({ [key: string]: any; } & { index?: never; allow_no_indices?: never; expand_wildcards?: never; ignore_unavailable?: never; query?: never; case_sensitive?: never; event_category_field?: never; tiebreaker_field?: never; timestamp_field?: never; fetch_size?: never; filter?: never; keep_alive?: never; keep_on_completion?: never; wait_for_completion_timeout?: never; allow_partial_search_results?: never; allow_partial_sequence_results?: never; size?: never; fields?: never; result_position?: never; runtime_mappings?: never; max_samples_per_key?: never; }) | All values in `body` will be added to the request body. | +| `case_sensitive` | boolean |   | +| `event_category_field` | [Field](./Field.md) | Field containing the event classification, such as process, file, or network. | +| `expand_wildcards` | [ExpandWildcards](./ExpandWildcards.md) |   | +| `fetch_size` | [uint](./uint.md) | Maximum number of events to search at a time for sequence queries. | +| `fields` | [QueryDslFieldAndFormat](./QueryDslFieldAndFormat.md) | [Field](./Field.md) | ([QueryDslFieldAndFormat](./QueryDslFieldAndFormat.md) | [Field](./Field.md))[] | Array of wildcard (*) patterns. The response returns values for field names matching these patterns in the fields property of each hit. | +| `filter` | [QueryDslQueryContainer](./QueryDslQueryContainer.md) | [QueryDslQueryContainer](./QueryDslQueryContainer.md)[] | Query, written in Query DSL, used to filter the events on which the EQL query runs. | +| `ignore_unavailable` | boolean | If true, missing or closed indices are not included in the response. | +| `index` | [Indices](./Indices.md) | The name of the index to scope the operation | +| `keep_alive` | [Duration](./Duration.md) |   | +| `keep_on_completion` | boolean |   | +| `max_samples_per_key` | [integer](./integer.md) | By default, the response of a sample query contains up to `10` samples, with one sample per unique set of join keys. Use the `size` parameter to get a smaller or larger set of samples. To retrieve more than one sample per set of join keys, use the `max_samples_per_key` parameter. Pipes are not supported for sample queries. | +| `query` | string | EQL query you wish to run. | +| `querystring` | { [key: string]: any; } & { index?: never; allow_no_indices?: never; expand_wildcards?: never; ignore_unavailable?: never; query?: never; case_sensitive?: never; event_category_field?: never; tiebreaker_field?: never; timestamp_field?: never; fetch_size?: never; filter?: never; keep_alive?: never; keep_on_completion?: never; wait_for_completion_timeout?: never; allow_partial_search_results?: never; allow_partial_sequence_results?: never; size?: never; fields?: never; result_position?: never; runtime_mappings?: never; max_samples_per_key?: never; } | All values in `querystring` will be added to the request querystring. | +| `result_position` | [EqlSearchResultPosition](./EqlSearchResultPosition.md) |   | +| `runtime_mappings` | [MappingRuntimeFields](./MappingRuntimeFields.md) |   | +| `size` | [uint](./uint.md) | For basic queries, the maximum number of matching events to return. Defaults to 10 | +| `tiebreaker_field` | [Field](./Field.md) | Field used to sort hits with the same timestamp in ascending order | +| `timestamp_field` | [Field](./Field.md) | Field containing event timestamp. Default " @ timestamp" | +| `wait_for_completion_timeout` | [Duration](./Duration.md) |   | diff --git a/docs/reference/api/EqlSearchResponse.md b/docs/reference/api/EqlSearchResponse.md new file mode 100644 index 000000000..c5532179c --- /dev/null +++ b/docs/reference/api/EqlSearchResponse.md @@ -0,0 +1,4 @@ +## `EqlSearchResponse` +::: +type EqlSearchResponse = [EqlEqlSearchResponseBase](./EqlEqlSearchResponseBase.md); +::: diff --git a/docs/reference/api/EqlSearchResultPosition.md b/docs/reference/api/EqlSearchResultPosition.md new file mode 100644 index 000000000..6c2ff5c39 --- /dev/null +++ b/docs/reference/api/EqlSearchResultPosition.md @@ -0,0 +1,4 @@ +## `EqlSearchResultPosition` +::: +type EqlSearchResultPosition = 'tail' | 'head'; +::: diff --git a/docs/reference/api/ErrorCause.md b/docs/reference/api/ErrorCause.md new file mode 100644 index 000000000..e8d31362f --- /dev/null +++ b/docs/reference/api/ErrorCause.md @@ -0,0 +1,4 @@ +## `ErrorCause` +::: +type ErrorCause = [ErrorCauseKeys](./ErrorCauseKeys.md) & { [property: string]: any;}; +::: diff --git a/docs/reference/api/ErrorCauseKeys.md b/docs/reference/api/ErrorCauseKeys.md new file mode 100644 index 000000000..8f93e8a1b --- /dev/null +++ b/docs/reference/api/ErrorCauseKeys.md @@ -0,0 +1,10 @@ +## Interface `ErrorCauseKeys` + +| Name | Type | Description | +| - | - | - | +| `caused_by` | [ErrorCause](./ErrorCause.md) |   | +| `reason` | string | A human-readable explanation of the error, in English. | +| `root_cause` | [ErrorCause](./ErrorCause.md)[] |   | +| `stack_trace` | string | The server stack trace. Present only if the `error_trace=true` parameter was sent with the request. | +| `suppressed` | [ErrorCause](./ErrorCause.md)[] |   | +| `type` | string | The type of error | diff --git a/docs/reference/api/ErrorResponseBase.md b/docs/reference/api/ErrorResponseBase.md new file mode 100644 index 000000000..16e687479 --- /dev/null +++ b/docs/reference/api/ErrorResponseBase.md @@ -0,0 +1,6 @@ +## Interface `ErrorResponseBase` + +| Name | Type | Description | +| - | - | - | +| `error` | [ErrorCause](./ErrorCause.md) |   | +| `status` | [integer](./integer.md) |   | diff --git a/docs/reference/api/Esql.md b/docs/reference/api/Esql.md new file mode 100644 index 000000000..41530489f --- /dev/null +++ b/docs/reference/api/Esql.md @@ -0,0 +1,20 @@ +## `Esql` + +### Constructor + +::: +new Esql(transport: [Transport](./Transport.md)); +::: + +### Properties + +| Name | Type | Description | +| - | - | - | +| `acceptedParams` | Record |   | +| `transport` | [Transport](./Transport.md) |   | + +### Methods + +| Name | Signature | Description | +| - | - | - | +| `asyncQuery` | `asyncQuery(this: [That](./That.md), params: [EsqlAsyncQueryRequest](./EsqlAsyncQueryRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[EsqlAsyncQueryResponse](./EsqlAsyncQueryResponse.md)>;` | Run an async ES|QL query. Asynchronously run an ES|QL (Elasticsearch query language) query, monitor its progress, and retrieve results when they become available. The API accepts the same parameters and request body as the synchronous query API, along with additional async related properties. || `asyncQuery` | `asyncQuery(this: [That](./That.md), params: [EsqlAsyncQueryRequest](./EsqlAsyncQueryRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[EsqlAsyncQueryResponse](./EsqlAsyncQueryResponse.md), unknown>>;` |   || `asyncQuery` | `asyncQuery(this: [That](./That.md), params: [EsqlAsyncQueryRequest](./EsqlAsyncQueryRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[EsqlAsyncQueryResponse](./EsqlAsyncQueryResponse.md)>;` |   || `asyncQueryDelete` | `asyncQueryDelete(this: [That](./That.md), params: [EsqlAsyncQueryDeleteRequest](./EsqlAsyncQueryDeleteRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[EsqlAsyncQueryDeleteResponse](./EsqlAsyncQueryDeleteResponse.md)>;` | Delete an async ES|QL query. If the query is still running, it is cancelled. Otherwise, the stored results are deleted. If the Elasticsearch security features are enabled, only the following users can use this API to delete a query: * The authenticated user that submitted the original query request * Users with the `cancel_task` cluster privilege || `asyncQueryDelete` | `asyncQueryDelete(this: [That](./That.md), params: [EsqlAsyncQueryDeleteRequest](./EsqlAsyncQueryDeleteRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[EsqlAsyncQueryDeleteResponse](./EsqlAsyncQueryDeleteResponse.md), unknown>>;` |   || `asyncQueryDelete` | `asyncQueryDelete(this: [That](./That.md), params: [EsqlAsyncQueryDeleteRequest](./EsqlAsyncQueryDeleteRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[EsqlAsyncQueryDeleteResponse](./EsqlAsyncQueryDeleteResponse.md)>;` |   || `asyncQueryGet` | `asyncQueryGet(this: [That](./That.md), params: [EsqlAsyncQueryGetRequest](./EsqlAsyncQueryGetRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[EsqlAsyncQueryGetResponse](./EsqlAsyncQueryGetResponse.md)>;` | Get async ES|QL query results. Get the current status and available results or stored results for an ES|QL asynchronous query. If the Elasticsearch security features are enabled, only the user who first submitted the ES|QL query can retrieve the results using this API. || `asyncQueryGet` | `asyncQueryGet(this: [That](./That.md), params: [EsqlAsyncQueryGetRequest](./EsqlAsyncQueryGetRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[EsqlAsyncQueryGetResponse](./EsqlAsyncQueryGetResponse.md), unknown>>;` |   || `asyncQueryGet` | `asyncQueryGet(this: [That](./That.md), params: [EsqlAsyncQueryGetRequest](./EsqlAsyncQueryGetRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[EsqlAsyncQueryGetResponse](./EsqlAsyncQueryGetResponse.md)>;` |   || `asyncQueryStop` | `asyncQueryStop(this: [That](./That.md), params: [EsqlAsyncQueryStopRequest](./EsqlAsyncQueryStopRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[EsqlAsyncQueryStopResponse](./EsqlAsyncQueryStopResponse.md)>;` | Stop async ES|QL query. This API interrupts the query execution and returns the results so far. If the Elasticsearch security features are enabled, only the user who first submitted the ES|QL query can stop it. || `asyncQueryStop` | `asyncQueryStop(this: [That](./That.md), params: [EsqlAsyncQueryStopRequest](./EsqlAsyncQueryStopRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[EsqlAsyncQueryStopResponse](./EsqlAsyncQueryStopResponse.md), unknown>>;` |   || `asyncQueryStop` | `asyncQueryStop(this: [That](./That.md), params: [EsqlAsyncQueryStopRequest](./EsqlAsyncQueryStopRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[EsqlAsyncQueryStopResponse](./EsqlAsyncQueryStopResponse.md)>;` |   || `getQuery` | `getQuery(this: [That](./That.md), params: [EsqlGetQueryRequest](./EsqlGetQueryRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[EsqlGetQueryResponse](./EsqlGetQueryResponse.md)>;` | Get a specific running ES|QL query information. Returns an object extended information about a running ES|QL query. || `getQuery` | `getQuery(this: [That](./That.md), params: [EsqlGetQueryRequest](./EsqlGetQueryRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[EsqlGetQueryResponse](./EsqlGetQueryResponse.md), unknown>>;` |   || `getQuery` | `getQuery(this: [That](./That.md), params: [EsqlGetQueryRequest](./EsqlGetQueryRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[EsqlGetQueryResponse](./EsqlGetQueryResponse.md)>;` |   || `listQueries` | `listQueries(this: [That](./That.md), params?: [EsqlListQueriesRequest](./EsqlListQueriesRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[EsqlListQueriesResponse](./EsqlListQueriesResponse.md)>;` | Get running ES|QL queries information. Returns an object containing IDs and other information about the running ES|QL queries. || `listQueries` | `listQueries(this: [That](./That.md), params?: [EsqlListQueriesRequest](./EsqlListQueriesRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[EsqlListQueriesResponse](./EsqlListQueriesResponse.md), unknown>>;` |   || `listQueries` | `listQueries(this: [That](./That.md), params?: [EsqlListQueriesRequest](./EsqlListQueriesRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[EsqlListQueriesResponse](./EsqlListQueriesResponse.md)>;` |   || `query` | `query(this: [That](./That.md), params: [EsqlQueryRequest](./EsqlQueryRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[EsqlQueryResponse](./EsqlQueryResponse.md)>;` | Run an ES|QL query. Get search results for an ES|QL (Elasticsearch query language) query. || `query` | `query(this: [That](./That.md), params: [EsqlQueryRequest](./EsqlQueryRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[EsqlQueryResponse](./EsqlQueryResponse.md), unknown>>;` |   || `query` | `query(this: [That](./That.md), params: [EsqlQueryRequest](./EsqlQueryRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[EsqlQueryResponse](./EsqlQueryResponse.md)>;` |   | \ No newline at end of file diff --git a/docs/reference/api/EsqlAsyncEsqlResult.md b/docs/reference/api/EsqlAsyncEsqlResult.md new file mode 100644 index 000000000..e0880b234 --- /dev/null +++ b/docs/reference/api/EsqlAsyncEsqlResult.md @@ -0,0 +1,6 @@ +## Interface `EsqlAsyncEsqlResult` + +| Name | Type | Description | +| - | - | - | +| `id` | string |   | +| `is_running` | boolean |   | diff --git a/docs/reference/api/EsqlAsyncQueryDeleteRequest.md b/docs/reference/api/EsqlAsyncQueryDeleteRequest.md new file mode 100644 index 000000000..42a3dbef5 --- /dev/null +++ b/docs/reference/api/EsqlAsyncQueryDeleteRequest.md @@ -0,0 +1,7 @@ +## Interface `EsqlAsyncQueryDeleteRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { id?: never; }) | All values in `body` will be added to the request body. | +| `id` | [Id](./Id.md) | The unique identifier of the query. A query ID is provided in the ES|QL async query API response for a query that does not complete in the designated time. A query ID is also provided when the request was submitted with the `keep_on_completion` parameter set to `true`. | +| `querystring` | { [key: string]: any; } & { id?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/EsqlAsyncQueryDeleteResponse.md b/docs/reference/api/EsqlAsyncQueryDeleteResponse.md new file mode 100644 index 000000000..8f2455a91 --- /dev/null +++ b/docs/reference/api/EsqlAsyncQueryDeleteResponse.md @@ -0,0 +1,4 @@ +## `EsqlAsyncQueryDeleteResponse` +::: +type EsqlAsyncQueryDeleteResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); +::: diff --git a/docs/reference/api/EsqlAsyncQueryGetRequest.md b/docs/reference/api/EsqlAsyncQueryGetRequest.md new file mode 100644 index 000000000..1ff8018b5 --- /dev/null +++ b/docs/reference/api/EsqlAsyncQueryGetRequest.md @@ -0,0 +1,10 @@ +## Interface `EsqlAsyncQueryGetRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { id?: never; drop_null_columns?: never; keep_alive?: never; wait_for_completion_timeout?: never; }) | All values in `body` will be added to the request body. | +| `drop_null_columns` | boolean | Indicates whether columns that are entirely `null` will be removed from the `columns` and `values` portion of the results. If `true`, the response will include an extra section under the name `all_columns` which has the name of all the columns. | +| `id` | [Id](./Id.md) | The unique identifier of the query. A query ID is provided in the ES|QL async query API response for a query that does not complete in the designated time. A query ID is also provided when the request was submitted with the `keep_on_completion` parameter set to `true`. | +| `keep_alive` | [Duration](./Duration.md) | The period for which the query and its results are stored in the cluster. When this period expires, the query and its results are deleted, even if the query is still ongoing. | +| `querystring` | { [key: string]: any; } & { id?: never; drop_null_columns?: never; keep_alive?: never; wait_for_completion_timeout?: never; } | All values in `querystring` will be added to the request querystring. | +| `wait_for_completion_timeout` | [Duration](./Duration.md) | The period to wait for the request to finish. By default, the request waits for complete query results. If the request completes during the period specified in this parameter, complete query results are returned. Otherwise, the response returns an `is_running` value of `true` and no results. | diff --git a/docs/reference/api/EsqlAsyncQueryGetResponse.md b/docs/reference/api/EsqlAsyncQueryGetResponse.md new file mode 100644 index 000000000..1e8db8131 --- /dev/null +++ b/docs/reference/api/EsqlAsyncQueryGetResponse.md @@ -0,0 +1,4 @@ +## `EsqlAsyncQueryGetResponse` +::: +type EsqlAsyncQueryGetResponse = [EsqlAsyncEsqlResult](./EsqlAsyncEsqlResult.md); +::: diff --git a/docs/reference/api/EsqlAsyncQueryRequest.md b/docs/reference/api/EsqlAsyncQueryRequest.md new file mode 100644 index 000000000..f7505b046 --- /dev/null +++ b/docs/reference/api/EsqlAsyncQueryRequest.md @@ -0,0 +1,21 @@ +## Interface `EsqlAsyncQueryRequest` + +| Name | Type | Description | +| - | - | - | +| `allow_partial_results` | boolean | If `true`, partial results will be returned if there are shard failures, but the query can continue to execute on other clusters and shards. If `false`, the query will fail if there are any failures. To override the default behavior, you can set the `esql.query.allow_partial_results` cluster setting to `false`. | +| `body` | string | ({ [key: string]: any; } & { allow_partial_results?: never; delimiter?: never; drop_null_columns?: never; format?: never; keep_alive?: never; keep_on_completion?: never; columnar?: never; filter?: never; locale?: never; params?: never; profile?: never; query?: never; tables?: never; include_ccs_metadata?: never; wait_for_completion_timeout?: never; }) | All values in `body` will be added to the request body. | +| `columnar` | boolean | By default, ES|QL returns results as rows. For example, FROM returns each individual document as one row. For the JSON, YAML, CBOR and smile formats, ES|QL can return the results in a columnar fashion where one row represents all the values of a certain column in the results. | +| `delimiter` | string | The character to use between values within a CSV row. It is valid only for the CSV format. | +| `drop_null_columns` | boolean | Indicates whether columns that are entirely `null` will be removed from the `columns` and `values` portion of the results. If `true`, the response will include an extra section under the name `all_columns` which has the name of all the columns. | +| `filter` | [QueryDslQueryContainer](./QueryDslQueryContainer.md) | Specify a Query DSL query in the filter parameter to filter the set of documents that an ES|QL query runs on. | +| `format` | [EsqlEsqlFormat](./EsqlEsqlFormat.md) | A short version of the Accept header, for example `json` or `yaml`. | +| `include_ccs_metadata` | boolean | When set to `true` and performing a cross-cluster query, the response will include an extra `_clusters` object with information about the clusters that participated in the search along with info such as shards count. | +| `keep_alive` | [Duration](./Duration.md) | The period for which the query and its results are stored in the cluster. The default period is five days. When this period expires, the query and its results are deleted, even if the query is still ongoing. If the `keep_on_completion` parameter is false, Elasticsearch only stores async queries that do not complete within the period set by the `wait_for_completion_timeout` parameter, regardless of this value. | +| `keep_on_completion` | boolean | Indicates whether the query and its results are stored in the cluster. If false, the query and its results are stored in the cluster only if the request does not complete during the period set by the `wait_for_completion_timeout` parameter. | +| `locale` | string |   | +| `params` | [FieldValue](./FieldValue.md)[] | To avoid any attempts of hacking or code injection, extract the values in a separate list of parameters. Use question mark placeholders (?) in the query string for each of the parameters. | +| `profile` | boolean | If provided and `true` the response will include an extra `profile` object with information on how the query was executed. This information is for human debugging and its format can change at any time but it can give some insight into the performance of each part of the query. | +| `query` | string | The ES|QL query API accepts an ES|QL query string in the query parameter, runs it, and returns the results. | +| `querystring` | { [key: string]: any; } & { allow_partial_results?: never; delimiter?: never; drop_null_columns?: never; format?: never; keep_alive?: never; keep_on_completion?: never; columnar?: never; filter?: never; locale?: never; params?: never; profile?: never; query?: never; tables?: never; include_ccs_metadata?: never; wait_for_completion_timeout?: never; } | All values in `querystring` will be added to the request querystring. | +| `tables` | Record> | Tables to use with the LOOKUP operation. The top level key is the table name and the next level key is the column name. | +| `wait_for_completion_timeout` | [Duration](./Duration.md) | The period to wait for the request to finish. By default, the request waits for 1 second for the query results. If the query completes during this period, results are returned Otherwise, a query ID is returned that can later be used to retrieve the results. | diff --git a/docs/reference/api/EsqlAsyncQueryResponse.md b/docs/reference/api/EsqlAsyncQueryResponse.md new file mode 100644 index 000000000..7750afc77 --- /dev/null +++ b/docs/reference/api/EsqlAsyncQueryResponse.md @@ -0,0 +1,4 @@ +## `EsqlAsyncQueryResponse` +::: +type EsqlAsyncQueryResponse = [EsqlAsyncEsqlResult](./EsqlAsyncEsqlResult.md); +::: diff --git a/docs/reference/api/EsqlAsyncQueryStopRequest.md b/docs/reference/api/EsqlAsyncQueryStopRequest.md new file mode 100644 index 000000000..436021d4b --- /dev/null +++ b/docs/reference/api/EsqlAsyncQueryStopRequest.md @@ -0,0 +1,8 @@ +## Interface `EsqlAsyncQueryStopRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { id?: never; drop_null_columns?: never; }) | All values in `body` will be added to the request body. | +| `drop_null_columns` | boolean | Indicates whether columns that are entirely `null` will be removed from the `columns` and `values` portion of the results. If `true`, the response will include an extra section under the name `all_columns` which has the name of all the columns. | +| `id` | [Id](./Id.md) | The unique identifier of the query. A query ID is provided in the ES|QL async query API response for a query that does not complete in the designated time. A query ID is also provided when the request was submitted with the `keep_on_completion` parameter set to `true`. | +| `querystring` | { [key: string]: any; } & { id?: never; drop_null_columns?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/EsqlAsyncQueryStopResponse.md b/docs/reference/api/EsqlAsyncQueryStopResponse.md new file mode 100644 index 000000000..7e84effc7 --- /dev/null +++ b/docs/reference/api/EsqlAsyncQueryStopResponse.md @@ -0,0 +1,4 @@ +## `EsqlAsyncQueryStopResponse` +::: +type EsqlAsyncQueryStopResponse = [EsqlEsqlResult](./EsqlEsqlResult.md); +::: diff --git a/docs/reference/api/EsqlColumn.md b/docs/reference/api/EsqlColumn.md new file mode 100644 index 000000000..f436e77f5 --- /dev/null +++ b/docs/reference/api/EsqlColumn.md @@ -0,0 +1,6 @@ +## Interface `EsqlColumn` + +| Name | Type | Description | +| - | - | - | +| `name` | string |   | +| `type` | string |   | diff --git a/docs/reference/api/EsqlEsqlClusterDetails.md b/docs/reference/api/EsqlEsqlClusterDetails.md new file mode 100644 index 000000000..657cd6660 --- /dev/null +++ b/docs/reference/api/EsqlEsqlClusterDetails.md @@ -0,0 +1,8 @@ +## Interface `EsqlEsqlClusterDetails` + +| Name | Type | Description | +| - | - | - | +| `_shards` | [EsqlEsqlShardInfo](./EsqlEsqlShardInfo.md) |   | +| `indices` | string |   | +| `status` | [EsqlEsqlClusterStatus](./EsqlEsqlClusterStatus.md) |   | +| `took` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> |   | diff --git a/docs/reference/api/EsqlEsqlClusterInfo.md b/docs/reference/api/EsqlEsqlClusterInfo.md new file mode 100644 index 000000000..77e76f631 --- /dev/null +++ b/docs/reference/api/EsqlEsqlClusterInfo.md @@ -0,0 +1,11 @@ +## Interface `EsqlEsqlClusterInfo` + +| Name | Type | Description | +| - | - | - | +| `details` | Record |   | +| `failed` | [integer](./integer.md) |   | +| `partial` | [integer](./integer.md) |   | +| `running` | [integer](./integer.md) |   | +| `skipped` | [integer](./integer.md) |   | +| `successful` | [integer](./integer.md) |   | +| `total` | [integer](./integer.md) |   | diff --git a/docs/reference/api/EsqlEsqlClusterStatus.md b/docs/reference/api/EsqlEsqlClusterStatus.md new file mode 100644 index 000000000..1a7b3877b --- /dev/null +++ b/docs/reference/api/EsqlEsqlClusterStatus.md @@ -0,0 +1,4 @@ +## `EsqlEsqlClusterStatus` +::: +type EsqlEsqlClusterStatus = 'running' | 'successful' | 'partial' | 'skipped' | 'failed'; +::: diff --git a/docs/reference/api/EsqlEsqlColumnInfo.md b/docs/reference/api/EsqlEsqlColumnInfo.md new file mode 100644 index 000000000..3c297d3a7 --- /dev/null +++ b/docs/reference/api/EsqlEsqlColumnInfo.md @@ -0,0 +1,6 @@ +## Interface `EsqlEsqlColumnInfo` + +| Name | Type | Description | +| - | - | - | +| `name` | string |   | +| `type` | string |   | diff --git a/docs/reference/api/EsqlEsqlFormat.md b/docs/reference/api/EsqlEsqlFormat.md new file mode 100644 index 000000000..3063399bf --- /dev/null +++ b/docs/reference/api/EsqlEsqlFormat.md @@ -0,0 +1,4 @@ +## `EsqlEsqlFormat` +::: +type EsqlEsqlFormat = 'csv' | 'json' | 'tsv' | 'txt' | 'yaml' | 'cbor' | 'smile' | 'arrow'; +::: diff --git a/docs/reference/api/EsqlEsqlResult.md b/docs/reference/api/EsqlEsqlResult.md new file mode 100644 index 000000000..405371aee --- /dev/null +++ b/docs/reference/api/EsqlEsqlResult.md @@ -0,0 +1,11 @@ +## Interface `EsqlEsqlResult` + +| Name | Type | Description | +| - | - | - | +| `_clusters` | [EsqlEsqlClusterInfo](./EsqlEsqlClusterInfo.md) | Cross-cluster search information. Present if `include_ccs_metadata` was `true` in the request and a cross-cluster search was performed. | +| `all_columns` | [EsqlEsqlColumnInfo](./EsqlEsqlColumnInfo.md)[] |   | +| `columns` | [EsqlEsqlColumnInfo](./EsqlEsqlColumnInfo.md)[] |   | +| `is_partial` | boolean |   | +| `profile` | any | Profiling information. Present if `profile` was `true` in the request. The contents of this field are currently unstable. | +| `took` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> |   | +| `values` | [FieldValue](./FieldValue.md)[][] |   | diff --git a/docs/reference/api/EsqlEsqlShardFailure.md b/docs/reference/api/EsqlEsqlShardFailure.md new file mode 100644 index 000000000..5785f3269 --- /dev/null +++ b/docs/reference/api/EsqlEsqlShardFailure.md @@ -0,0 +1,8 @@ +## Interface `EsqlEsqlShardFailure` + +| Name | Type | Description | +| - | - | - | +| `index` | [IndexName](./IndexName.md) |   | +| `node` | [NodeId](./NodeId.md) |   | +| `reason` | [ErrorCause](./ErrorCause.md) |   | +| `shard` | [Id](./Id.md) |   | diff --git a/docs/reference/api/EsqlEsqlShardInfo.md b/docs/reference/api/EsqlEsqlShardInfo.md new file mode 100644 index 000000000..de085e70a --- /dev/null +++ b/docs/reference/api/EsqlEsqlShardInfo.md @@ -0,0 +1,9 @@ +## Interface `EsqlEsqlShardInfo` + +| Name | Type | Description | +| - | - | - | +| `failed` | [integer](./integer.md) |   | +| `failures` | [EsqlEsqlShardFailure](./EsqlEsqlShardFailure.md)[] |   | +| `skipped` | [integer](./integer.md) |   | +| `successful` | [integer](./integer.md) |   | +| `total` | [integer](./integer.md) |   | diff --git a/docs/reference/api/EsqlGetQueryRequest.md b/docs/reference/api/EsqlGetQueryRequest.md new file mode 100644 index 000000000..b09dee07b --- /dev/null +++ b/docs/reference/api/EsqlGetQueryRequest.md @@ -0,0 +1,7 @@ +## Interface `EsqlGetQueryRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { id?: never; }) | All values in `body` will be added to the request body. | +| `id` | [Id](./Id.md) | The query ID | +| `querystring` | { [key: string]: any; } & { id?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/EsqlGetQueryResponse.md b/docs/reference/api/EsqlGetQueryResponse.md new file mode 100644 index 000000000..9f955f019 --- /dev/null +++ b/docs/reference/api/EsqlGetQueryResponse.md @@ -0,0 +1,11 @@ +## Interface `EsqlGetQueryResponse` + +| Name | Type | Description | +| - | - | - | +| `coordinating_node` | [NodeId](./NodeId.md) |   | +| `data_nodes` | [NodeId](./NodeId.md)[] |   | +| `id` | [long](./long.md) |   | +| `node` | [NodeId](./NodeId.md) |   | +| `query` | string |   | +| `running_time_nanos` | [long](./long.md) |   | +| `start_time_millis` | [long](./long.md) |   | diff --git a/docs/reference/api/EsqlHelper.md b/docs/reference/api/EsqlHelper.md new file mode 100644 index 000000000..dbdeee413 --- /dev/null +++ b/docs/reference/api/EsqlHelper.md @@ -0,0 +1,7 @@ +## Interface `EsqlHelper` + +| Name | Type | Description | +| - | - | - | +| `toArrowReader` | () => Promise<[AsyncRecordBatchStreamReader](./AsyncRecordBatchStreamReader.md)> |   | +| `toArrowTable` | () => Promise<[Table](./Table.md)<[TypeMap](./TypeMap.md)>> |   | +| `toRecords` | () => Promise<[EsqlToRecords](./EsqlToRecords.md)> |   | diff --git a/docs/reference/api/EsqlListQueriesBody.md b/docs/reference/api/EsqlListQueriesBody.md new file mode 100644 index 000000000..2dd051c65 --- /dev/null +++ b/docs/reference/api/EsqlListQueriesBody.md @@ -0,0 +1,9 @@ +## Interface `EsqlListQueriesBody` + +| Name | Type | Description | +| - | - | - | +| `id` | [long](./long.md) |   | +| `node` | [NodeId](./NodeId.md) |   | +| `query` | string |   | +| `running_time_nanos` | [long](./long.md) |   | +| `start_time_millis` | [long](./long.md) |   | diff --git a/docs/reference/api/EsqlListQueriesRequest.md b/docs/reference/api/EsqlListQueriesRequest.md new file mode 100644 index 000000000..ead55e2c4 --- /dev/null +++ b/docs/reference/api/EsqlListQueriesRequest.md @@ -0,0 +1,6 @@ +## Interface `EsqlListQueriesRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | { [key: string]: any; } | All values in `body` will be added to the request body. | +| `querystring` | { [key: string]: any; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/EsqlListQueriesResponse.md b/docs/reference/api/EsqlListQueriesResponse.md new file mode 100644 index 000000000..07d24f59d --- /dev/null +++ b/docs/reference/api/EsqlListQueriesResponse.md @@ -0,0 +1,5 @@ +## Interface `EsqlListQueriesResponse` + +| Name | Type | Description | +| - | - | - | +| `queries` | Record<[TaskId](./TaskId.md), [EsqlListQueriesBody](./EsqlListQueriesBody.md)> |   | diff --git a/docs/reference/api/EsqlQueryRequest.md b/docs/reference/api/EsqlQueryRequest.md new file mode 100644 index 000000000..b162062a5 --- /dev/null +++ b/docs/reference/api/EsqlQueryRequest.md @@ -0,0 +1,18 @@ +## Interface `EsqlQueryRequest` + +| Name | Type | Description | +| - | - | - | +| `allow_partial_results` | boolean | If `true`, partial results will be returned if there are shard failures, but the query can continue to execute on other clusters and shards. If `false`, the query will fail if there are any failures. To override the default behavior, you can set the `esql.query.allow_partial_results` cluster setting to `false`. | +| `body` | string | ({ [key: string]: any; } & { format?: never; delimiter?: never; drop_null_columns?: never; allow_partial_results?: never; columnar?: never; filter?: never; locale?: never; params?: never; profile?: never; query?: never; tables?: never; include_ccs_metadata?: never; }) | All values in `body` will be added to the request body. | +| `columnar` | boolean | By default, ES|QL returns results as rows. For example, FROM returns each individual document as one row. For the JSON, YAML, CBOR and smile formats, ES|QL can return the results in a columnar fashion where one row represents all the values of a certain column in the results. | +| `delimiter` | string | The character to use between values within a CSV row. Only valid for the CSV format. | +| `drop_null_columns` | boolean | Should columns that are entirely `null` be removed from the `columns` and `values` portion of the results? Defaults to `false`. If `true` then the response will include an extra section under the name `all_columns` which has the name of all columns. | +| `filter` | [QueryDslQueryContainer](./QueryDslQueryContainer.md) | Specify a Query DSL query in the filter parameter to filter the set of documents that an ES|QL query runs on. | +| `format` | [EsqlEsqlFormat](./EsqlEsqlFormat.md) | A short version of the Accept header, e.g. json, yaml. | +| `include_ccs_metadata` | boolean | When set to `true` and performing a cross-cluster query, the response will include an extra `_clusters` object with information about the clusters that participated in the search along with info such as shards count. | +| `locale` | string |   | +| `params` | [FieldValue](./FieldValue.md)[] | To avoid any attempts of hacking or code injection, extract the values in a separate list of parameters. Use question mark placeholders (?) in the query string for each of the parameters. | +| `profile` | boolean | If provided and `true` the response will include an extra `profile` object with information on how the query was executed. This information is for human debugging and its format can change at any time but it can give some insight into the performance of each part of the query. | +| `query` | string | The ES|QL query API accepts an ES|QL query string in the query parameter, runs it, and returns the results. | +| `querystring` | { [key: string]: any; } & { format?: never; delimiter?: never; drop_null_columns?: never; allow_partial_results?: never; columnar?: never; filter?: never; locale?: never; params?: never; profile?: never; query?: never; tables?: never; include_ccs_metadata?: never; } | All values in `querystring` will be added to the request querystring. | +| `tables` | Record> | Tables to use with the LOOKUP operation. The top level key is the table name and the next level key is the column name. | diff --git a/docs/reference/api/EsqlQueryResponse.md b/docs/reference/api/EsqlQueryResponse.md new file mode 100644 index 000000000..6f0edd5e9 --- /dev/null +++ b/docs/reference/api/EsqlQueryResponse.md @@ -0,0 +1,4 @@ +## `EsqlQueryResponse` +::: +type EsqlQueryResponse = [EsqlEsqlResult](./EsqlEsqlResult.md); +::: diff --git a/docs/reference/api/EsqlTableValuesContainer.md b/docs/reference/api/EsqlTableValuesContainer.md new file mode 100644 index 000000000..0d528155e --- /dev/null +++ b/docs/reference/api/EsqlTableValuesContainer.md @@ -0,0 +1,8 @@ +## Interface `EsqlTableValuesContainer` + +| Name | Type | Description | +| - | - | - | +| `double` | [EsqlTableValuesLongDouble](./EsqlTableValuesLongDouble.md)[] |   | +| `integer` | [EsqlTableValuesIntegerValue](./EsqlTableValuesIntegerValue.md)[] |   | +| `keyword` | [EsqlTableValuesKeywordValue](./EsqlTableValuesKeywordValue.md)[] |   | +| `long` | [EsqlTableValuesLongValue](./EsqlTableValuesLongValue.md)[] |   | diff --git a/docs/reference/api/EsqlTableValuesIntegerValue.md b/docs/reference/api/EsqlTableValuesIntegerValue.md new file mode 100644 index 000000000..b3b41d6c8 --- /dev/null +++ b/docs/reference/api/EsqlTableValuesIntegerValue.md @@ -0,0 +1,4 @@ +## `EsqlTableValuesIntegerValue` +::: +type EsqlTableValuesIntegerValue = [integer](./integer.md) | [integer](./integer.md)[]; +::: diff --git a/docs/reference/api/EsqlTableValuesKeywordValue.md b/docs/reference/api/EsqlTableValuesKeywordValue.md new file mode 100644 index 000000000..34f54807a --- /dev/null +++ b/docs/reference/api/EsqlTableValuesKeywordValue.md @@ -0,0 +1,4 @@ +## `EsqlTableValuesKeywordValue` +::: +type EsqlTableValuesKeywordValue = string | string[]; +::: diff --git a/docs/reference/api/EsqlTableValuesLongDouble.md b/docs/reference/api/EsqlTableValuesLongDouble.md new file mode 100644 index 000000000..a7fb608b4 --- /dev/null +++ b/docs/reference/api/EsqlTableValuesLongDouble.md @@ -0,0 +1,4 @@ +## `EsqlTableValuesLongDouble` +::: +type EsqlTableValuesLongDouble = [double](./double.md) | [double](./double.md)[]; +::: diff --git a/docs/reference/api/EsqlTableValuesLongValue.md b/docs/reference/api/EsqlTableValuesLongValue.md new file mode 100644 index 000000000..032ac2cc0 --- /dev/null +++ b/docs/reference/api/EsqlTableValuesLongValue.md @@ -0,0 +1,4 @@ +## `EsqlTableValuesLongValue` +::: +type EsqlTableValuesLongValue = [long](./long.md) | [long](./long.md)[]; +::: diff --git a/docs/reference/api/EsqlToRecords.md b/docs/reference/api/EsqlToRecords.md new file mode 100644 index 000000000..525be86d7 --- /dev/null +++ b/docs/reference/api/EsqlToRecords.md @@ -0,0 +1,6 @@ +## Interface `EsqlToRecords` + +| Name | Type | Description | +| - | - | - | +| `columns` | [EsqlColumn](./EsqlColumn.md)[] |   | +| `records` | TDocument[] |   | diff --git a/docs/reference/api/ExistsApi_1.md b/docs/reference/api/ExistsApi_1.md new file mode 100644 index 000000000..2e26103b4 --- /dev/null +++ b/docs/reference/api/ExistsApi_1.md @@ -0,0 +1,3 @@ +::: +default function ExistsApi(this: [That](./That.md), params: [ExistsRequest](./ExistsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ExistsResponse](./ExistsResponse.md)>; +::: diff --git a/docs/reference/api/ExistsApi_2.md b/docs/reference/api/ExistsApi_2.md new file mode 100644 index 000000000..8e7f26b45 --- /dev/null +++ b/docs/reference/api/ExistsApi_2.md @@ -0,0 +1,3 @@ +::: +default function ExistsApi(this: [That](./That.md), params: [ExistsRequest](./ExistsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ExistsResponse](./ExistsResponse.md), unknown>>; +::: diff --git a/docs/reference/api/ExistsApi_3.md b/docs/reference/api/ExistsApi_3.md new file mode 100644 index 000000000..4787d0d5f --- /dev/null +++ b/docs/reference/api/ExistsApi_3.md @@ -0,0 +1,3 @@ +::: +default function ExistsApi(this: [That](./That.md), params: [ExistsRequest](./ExistsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ExistsResponse](./ExistsResponse.md)>; +::: diff --git a/docs/reference/api/ExistsRequest.md b/docs/reference/api/ExistsRequest.md new file mode 100644 index 000000000..6b274db71 --- /dev/null +++ b/docs/reference/api/ExistsRequest.md @@ -0,0 +1,18 @@ +## Interface `ExistsRequest` + +| Name | Type | Description | +| - | - | - | +| `_source_excludes` | [Fields](./Fields.md) | A comma-separated list of source fields to exclude from the response. You can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter. If the `_source` parameter is `false`, this parameter is ignored. | +| `_source_includes` | [Fields](./Fields.md) | A comma-separated list of source fields to include in the response. If this parameter is specified, only these source fields are returned. You can exclude fields from this subset using the `_source_excludes` query parameter. If the `_source` parameter is `false`, this parameter is ignored. | +| `_source` | [SearchSourceConfigParam](./SearchSourceConfigParam.md) | Indicates whether to return the `_source` field ( `true` or `false`) or lists the fields to return. | +| `body` | string | ({ [key: string]: any; } & { id?: never; index?: never; preference?: never; realtime?: never; refresh?: never; routing?: never; _source?: never; _source_excludes?: never; _source_includes?: never; stored_fields?: never; version?: never; version_type?: never; }) | All values in `body` will be added to the request body. | +| `id` | [Id](./Id.md) | A unique document identifier. | +| `index` | [IndexName](./IndexName.md) | A comma-separated list of data streams, indices, and aliases. It supports wildcards ( `*`). | +| `preference` | string | The node or shard the operation should be performed on. By default, the operation is randomized between the shard replicas. If it is set to `_local`, the operation will prefer to be run on a local allocated shard when possible. If it is set to a custom value, the value is used to guarantee that the same shards will be used for the same custom value. This can help with "jumping values" when hitting different shards in different refresh states. A sample value can be something like the web session ID or the user name. | +| `querystring` | { [key: string]: any; } & { id?: never; index?: never; preference?: never; realtime?: never; refresh?: never; routing?: never; _source?: never; _source_excludes?: never; _source_includes?: never; stored_fields?: never; version?: never; version_type?: never; } | All values in `querystring` will be added to the request querystring. | +| `realtime` | boolean | If `true`, the request is real-time as opposed to near-real-time. | +| `refresh` | boolean | If `true`, the request refreshes the relevant shards before retrieving the document. Setting it to `true` should be done after careful thought and verification that this does not cause a heavy load on the system (and slow down indexing). | +| `routing` | [Routing](./Routing.md) | A custom value used to route operations to a specific shard. | +| `stored_fields` | [Fields](./Fields.md) | A comma-separated list of stored fields to return as part of a hit. If no fields are specified, no stored fields are included in the response. If this field is specified, the `_source` parameter defaults to `false`. | +| `version_type` | [VersionType](./VersionType.md) | The version type. | +| `version` | [VersionNumber](./VersionNumber.md) | Explicit version number for concurrency control. The specified version must match the current version of the document for the request to succeed. | diff --git a/docs/reference/api/ExistsResponse.md b/docs/reference/api/ExistsResponse.md new file mode 100644 index 000000000..e562d8e90 --- /dev/null +++ b/docs/reference/api/ExistsResponse.md @@ -0,0 +1,4 @@ +## `ExistsResponse` +::: +type ExistsResponse = boolean; +::: diff --git a/docs/reference/api/ExistsSourceApi_1.md b/docs/reference/api/ExistsSourceApi_1.md new file mode 100644 index 000000000..c05901cb5 --- /dev/null +++ b/docs/reference/api/ExistsSourceApi_1.md @@ -0,0 +1,3 @@ +::: +default function ExistsSourceApi(this: [That](./That.md), params: [ExistsSourceRequest](./ExistsSourceRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ExistsSourceResponse](./ExistsSourceResponse.md)>; +::: diff --git a/docs/reference/api/ExistsSourceApi_2.md b/docs/reference/api/ExistsSourceApi_2.md new file mode 100644 index 000000000..5e559cfcf --- /dev/null +++ b/docs/reference/api/ExistsSourceApi_2.md @@ -0,0 +1,3 @@ +::: +default function ExistsSourceApi(this: [That](./That.md), params: [ExistsSourceRequest](./ExistsSourceRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ExistsSourceResponse](./ExistsSourceResponse.md), unknown>>; +::: diff --git a/docs/reference/api/ExistsSourceApi_3.md b/docs/reference/api/ExistsSourceApi_3.md new file mode 100644 index 000000000..478f15687 --- /dev/null +++ b/docs/reference/api/ExistsSourceApi_3.md @@ -0,0 +1,3 @@ +::: +default function ExistsSourceApi(this: [That](./That.md), params: [ExistsSourceRequest](./ExistsSourceRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ExistsSourceResponse](./ExistsSourceResponse.md)>; +::: diff --git a/docs/reference/api/ExistsSourceRequest.md b/docs/reference/api/ExistsSourceRequest.md new file mode 100644 index 000000000..153f1a4bb --- /dev/null +++ b/docs/reference/api/ExistsSourceRequest.md @@ -0,0 +1,17 @@ +## Interface `ExistsSourceRequest` + +| Name | Type | Description | +| - | - | - | +| `_source_excludes` | [Fields](./Fields.md) | A comma-separated list of source fields to exclude in the response. | +| `_source_includes` | [Fields](./Fields.md) | A comma-separated list of source fields to include in the response. | +| `_source` | [SearchSourceConfigParam](./SearchSourceConfigParam.md) | Indicates whether to return the `_source` field ( `true` or `false`) or lists the fields to return. | +| `body` | string | ({ [key: string]: any; } & { id?: never; index?: never; preference?: never; realtime?: never; refresh?: never; routing?: never; _source?: never; _source_excludes?: never; _source_includes?: never; version?: never; version_type?: never; }) | All values in `body` will be added to the request body. | +| `id` | [Id](./Id.md) | A unique identifier for the document. | +| `index` | [IndexName](./IndexName.md) | A comma-separated list of data streams, indices, and aliases. It supports wildcards ( `*`). | +| `preference` | string | The node or shard the operation should be performed on. By default, the operation is randomized between the shard replicas. | +| `querystring` | { [key: string]: any; } & { id?: never; index?: never; preference?: never; realtime?: never; refresh?: never; routing?: never; _source?: never; _source_excludes?: never; _source_includes?: never; version?: never; version_type?: never; } | All values in `querystring` will be added to the request querystring. | +| `realtime` | boolean | If `true`, the request is real-time as opposed to near-real-time. | +| `refresh` | boolean | If `true`, the request refreshes the relevant shards before retrieving the document. Setting it to `true` should be done after careful thought and verification that this does not cause a heavy load on the system (and slow down indexing). | +| `routing` | [Routing](./Routing.md) | A custom value used to route operations to a specific shard. | +| `version_type` | [VersionType](./VersionType.md) | The version type. | +| `version` | [VersionNumber](./VersionNumber.md) | The version number for concurrency control. It must match the current version of the document for the request to succeed. | diff --git a/docs/reference/api/ExistsSourceResponse.md b/docs/reference/api/ExistsSourceResponse.md new file mode 100644 index 000000000..50cc7f675 --- /dev/null +++ b/docs/reference/api/ExistsSourceResponse.md @@ -0,0 +1,4 @@ +## `ExistsSourceResponse` +::: +type ExistsSourceResponse = boolean; +::: diff --git a/docs/reference/api/ExpandWildcard.md b/docs/reference/api/ExpandWildcard.md new file mode 100644 index 000000000..4f70e66fe --- /dev/null +++ b/docs/reference/api/ExpandWildcard.md @@ -0,0 +1,4 @@ +## `ExpandWildcard` +::: +type ExpandWildcard = 'all' | 'open' | 'closed' | 'hidden' | 'none'; +::: diff --git a/docs/reference/api/ExpandWildcards.md b/docs/reference/api/ExpandWildcards.md new file mode 100644 index 000000000..a6b8643bb --- /dev/null +++ b/docs/reference/api/ExpandWildcards.md @@ -0,0 +1,4 @@ +## `ExpandWildcards` +::: +type ExpandWildcards = [ExpandWildcard](./ExpandWildcard.md) | [ExpandWildcard](./ExpandWildcard.md)[]; +::: diff --git a/docs/reference/api/ExplainApi_1.md b/docs/reference/api/ExplainApi_1.md new file mode 100644 index 000000000..3ee44a0cc --- /dev/null +++ b/docs/reference/api/ExplainApi_1.md @@ -0,0 +1,3 @@ +::: +default function ExplainApi(this: [That](./That.md), params: [ExplainRequest](./ExplainRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ExplainResponse](./ExplainResponse.md)>; +::: diff --git a/docs/reference/api/ExplainApi_2.md b/docs/reference/api/ExplainApi_2.md new file mode 100644 index 000000000..b4d3a00bd --- /dev/null +++ b/docs/reference/api/ExplainApi_2.md @@ -0,0 +1,3 @@ +::: +default function ExplainApi(this: [That](./That.md), params: [ExplainRequest](./ExplainRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ExplainResponse](./ExplainResponse.md), unknown>>; +::: diff --git a/docs/reference/api/ExplainApi_3.md b/docs/reference/api/ExplainApi_3.md new file mode 100644 index 000000000..fdb481510 --- /dev/null +++ b/docs/reference/api/ExplainApi_3.md @@ -0,0 +1,3 @@ +::: +default function ExplainApi(this: [That](./That.md), params: [ExplainRequest](./ExplainRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ExplainResponse](./ExplainResponse.md)>; +::: diff --git a/docs/reference/api/ExplainExplanation.md b/docs/reference/api/ExplainExplanation.md new file mode 100644 index 000000000..43a4447ff --- /dev/null +++ b/docs/reference/api/ExplainExplanation.md @@ -0,0 +1,7 @@ +## Interface `ExplainExplanation` + +| Name | Type | Description | +| - | - | - | +| `description` | string |   | +| `details` | [ExplainExplanationDetail](./ExplainExplanationDetail.md)[] |   | +| `value` | [float](./float.md) |   | diff --git a/docs/reference/api/ExplainExplanationDetail.md b/docs/reference/api/ExplainExplanationDetail.md new file mode 100644 index 000000000..6064a909e --- /dev/null +++ b/docs/reference/api/ExplainExplanationDetail.md @@ -0,0 +1,7 @@ +## Interface `ExplainExplanationDetail` + +| Name | Type | Description | +| - | - | - | +| `description` | string |   | +| `details` | [ExplainExplanationDetail](./ExplainExplanationDetail.md)[] |   | +| `value` | [float](./float.md) |   | diff --git a/docs/reference/api/ExplainRequest.md b/docs/reference/api/ExplainRequest.md new file mode 100644 index 000000000..d5304a673 --- /dev/null +++ b/docs/reference/api/ExplainRequest.md @@ -0,0 +1,21 @@ +## Interface `ExplainRequest` + +| Name | Type | Description | +| - | - | - | +| `_source_excludes` | [Fields](./Fields.md) | A comma-separated list of source fields to exclude from the response. You can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter. If the `_source` parameter is `false`, this parameter is ignored. | +| `_source_includes` | [Fields](./Fields.md) | A comma-separated list of source fields to include in the response. If this parameter is specified, only these source fields are returned. You can exclude fields from this subset using the `_source_excludes` query parameter. If the `_source` parameter is `false`, this parameter is ignored. | +| `_source` | [SearchSourceConfigParam](./SearchSourceConfigParam.md) | `True` or `false` to return the `_source` field or not or a list of fields to return. | +| `analyze_wildcard` | boolean | If `true`, wildcard and prefix queries are analyzed. This parameter can be used only when the `q` query string parameter is specified. | +| `analyzer` | string | The analyzer to use for the query string. This parameter can be used only when the `q` query string parameter is specified. | +| `body` | string | ({ [key: string]: any; } & { id?: never; index?: never; analyzer?: never; analyze_wildcard?: never; default_operator?: never; df?: never; lenient?: never; preference?: never; routing?: never; _source?: never; _source_excludes?: never; _source_includes?: never; stored_fields?: never; q?: never; query?: never; }) | All values in `body` will be added to the request body. | +| `default_operator` | [QueryDslOperator](./QueryDslOperator.md) | The default operator for query string query: `AND` or `OR`. This parameter can be used only when the `q` query string parameter is specified. | +| `df` | string | The field to use as default where no field prefix is given in the query string. This parameter can be used only when the `q` query string parameter is specified. | +| `id` | [Id](./Id.md) | The document identifier. | +| `index` | [IndexName](./IndexName.md) | Index names that are used to limit the request. Only a single index name can be provided to this parameter. | +| `lenient` | boolean | If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. This parameter can be used only when the `q` query string parameter is specified. | +| `preference` | string | The node or shard the operation should be performed on. It is random by default. | +| `q` | string | The query in the Lucene query string syntax. | +| `query` | [QueryDslQueryContainer](./QueryDslQueryContainer.md) | Defines the search definition using the Query DSL. | +| `querystring` | { [key: string]: any; } & { id?: never; index?: never; analyzer?: never; analyze_wildcard?: never; default_operator?: never; df?: never; lenient?: never; preference?: never; routing?: never; _source?: never; _source_excludes?: never; _source_includes?: never; stored_fields?: never; q?: never; query?: never; } | All values in `querystring` will be added to the request querystring. | +| `routing` | [Routing](./Routing.md) | A custom value used to route operations to a specific shard. | +| `stored_fields` | [Fields](./Fields.md) | A comma-separated list of stored fields to return in the response. | diff --git a/docs/reference/api/ExplainResponse.md b/docs/reference/api/ExplainResponse.md new file mode 100644 index 000000000..3e72e7733 --- /dev/null +++ b/docs/reference/api/ExplainResponse.md @@ -0,0 +1,9 @@ +## Interface `ExplainResponse` + +| Name | Type | Description | +| - | - | - | +| `_id` | [Id](./Id.md) |   | +| `_index` | [IndexName](./IndexName.md) |   | +| `explanation` | [ExplainExplanationDetail](./ExplainExplanationDetail.md) |   | +| `get` | [InlineGet](./InlineGet.md) |   | +| `matched` | boolean |   | diff --git a/docs/reference/api/Features.md b/docs/reference/api/Features.md new file mode 100644 index 000000000..09c0b79b0 --- /dev/null +++ b/docs/reference/api/Features.md @@ -0,0 +1,20 @@ +## `Features` + +### Constructor + +::: +new Features(transport: [Transport](./Transport.md)); +::: + +### Properties + +| Name | Type | Description | +| - | - | - | +| `acceptedParams` | Record |   | +| `transport` | [Transport](./Transport.md) |   | + +### Methods + +| Name | Signature | Description | +| - | - | - | +| `getFeatures` | `getFeatures(this: [That](./That.md), params?: [FeaturesGetFeaturesRequest](./FeaturesGetFeaturesRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[FeaturesGetFeaturesResponse](./FeaturesGetFeaturesResponse.md)>;` | Get the features. Get a list of features that can be included in snapshots using the `feature_states` field when creating a snapshot. You can use this API to determine which feature states to include when taking a snapshot. By default, all feature states are included in a snapshot if that snapshot includes the global state, or none if it does not. A feature state includes one or more system indices necessary for a given feature to function. In order to ensure data integrity, all system indices that comprise a feature state are snapshotted and restored together. The features listed by this API are a combination of built-in features and features defined by plugins. In order for a feature state to be listed in this API and recognized as a valid feature state by the create snapshot API, the plugin that defines that feature must be installed on the master node. || `getFeatures` | `getFeatures(this: [That](./That.md), params?: [FeaturesGetFeaturesRequest](./FeaturesGetFeaturesRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[FeaturesGetFeaturesResponse](./FeaturesGetFeaturesResponse.md), unknown>>;` |   || `getFeatures` | `getFeatures(this: [That](./That.md), params?: [FeaturesGetFeaturesRequest](./FeaturesGetFeaturesRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[FeaturesGetFeaturesResponse](./FeaturesGetFeaturesResponse.md)>;` |   || `resetFeatures` | `resetFeatures(this: [That](./That.md), params?: [FeaturesResetFeaturesRequest](./FeaturesResetFeaturesRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[FeaturesResetFeaturesResponse](./FeaturesResetFeaturesResponse.md)>;` | Reset the features. Clear all of the state information stored in system indices by Elasticsearch features, including the security and machine learning indices. WARNING: Intended for development and testing use only. Do not reset features on a production cluster. Return a cluster to the same state as a new installation by resetting the feature state for all Elasticsearch features. This deletes all state information stored in system indices. The response code is HTTP 200 if the state is successfully reset for all features. It is HTTP 500 if the reset operation failed for any feature. Note that select features might provide a way to reset particular system indices. Using this API resets all features, both those that are built-in and implemented as plugins. To list the features that will be affected, use the get features API. IMPORTANT: The features installed on the node you submit this request to are the features that will be reset. Run on the master node if you have any doubts about which plugins are installed on individual nodes. || `resetFeatures` | `resetFeatures(this: [That](./That.md), params?: [FeaturesResetFeaturesRequest](./FeaturesResetFeaturesRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[FeaturesResetFeaturesResponse](./FeaturesResetFeaturesResponse.md), unknown>>;` |   || `resetFeatures` | `resetFeatures(this: [That](./That.md), params?: [FeaturesResetFeaturesRequest](./FeaturesResetFeaturesRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[FeaturesResetFeaturesResponse](./FeaturesResetFeaturesResponse.md)>;` |   | \ No newline at end of file diff --git a/docs/reference/api/FeaturesFeature.md b/docs/reference/api/FeaturesFeature.md new file mode 100644 index 000000000..664620cab --- /dev/null +++ b/docs/reference/api/FeaturesFeature.md @@ -0,0 +1,6 @@ +## Interface `FeaturesFeature` + +| Name | Type | Description | +| - | - | - | +| `description` | string |   | +| `name` | string |   | diff --git a/docs/reference/api/FeaturesGetFeaturesRequest.md b/docs/reference/api/FeaturesGetFeaturesRequest.md new file mode 100644 index 000000000..41758c574 --- /dev/null +++ b/docs/reference/api/FeaturesGetFeaturesRequest.md @@ -0,0 +1,7 @@ +## Interface `FeaturesGetFeaturesRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { master_timeout?: never; }) | All values in `body` will be added to the request body. | +| `master_timeout` | [Duration](./Duration.md) | Period to wait for a connection to the master node. | +| `querystring` | { [key: string]: any; } & { master_timeout?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/FeaturesGetFeaturesResponse.md b/docs/reference/api/FeaturesGetFeaturesResponse.md new file mode 100644 index 000000000..fb2818038 --- /dev/null +++ b/docs/reference/api/FeaturesGetFeaturesResponse.md @@ -0,0 +1,5 @@ +## Interface `FeaturesGetFeaturesResponse` + +| Name | Type | Description | +| - | - | - | +| `features` | [FeaturesFeature](./FeaturesFeature.md)[] |   | diff --git a/docs/reference/api/FeaturesResetFeaturesRequest.md b/docs/reference/api/FeaturesResetFeaturesRequest.md new file mode 100644 index 000000000..ae24f8ee6 --- /dev/null +++ b/docs/reference/api/FeaturesResetFeaturesRequest.md @@ -0,0 +1,7 @@ +## Interface `FeaturesResetFeaturesRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { master_timeout?: never; }) | All values in `body` will be added to the request body. | +| `master_timeout` | [Duration](./Duration.md) | Period to wait for a connection to the master node. | +| `querystring` | { [key: string]: any; } & { master_timeout?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/FeaturesResetFeaturesResponse.md b/docs/reference/api/FeaturesResetFeaturesResponse.md new file mode 100644 index 000000000..fd3154a47 --- /dev/null +++ b/docs/reference/api/FeaturesResetFeaturesResponse.md @@ -0,0 +1,5 @@ +## Interface `FeaturesResetFeaturesResponse` + +| Name | Type | Description | +| - | - | - | +| `features` | [FeaturesFeature](./FeaturesFeature.md)[] |   | diff --git a/docs/reference/api/Field.md b/docs/reference/api/Field.md new file mode 100644 index 000000000..e8caad181 --- /dev/null +++ b/docs/reference/api/Field.md @@ -0,0 +1,4 @@ +## `Field` +::: +type Field = string; +::: diff --git a/docs/reference/api/FieldCapsApi_1.md b/docs/reference/api/FieldCapsApi_1.md new file mode 100644 index 000000000..96612ede2 --- /dev/null +++ b/docs/reference/api/FieldCapsApi_1.md @@ -0,0 +1,3 @@ +::: +default function FieldCapsApi(this: [That](./That.md), params?: [FieldCapsRequest](./FieldCapsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[FieldCapsResponse](./FieldCapsResponse.md)>; +::: diff --git a/docs/reference/api/FieldCapsApi_2.md b/docs/reference/api/FieldCapsApi_2.md new file mode 100644 index 000000000..920dd26fd --- /dev/null +++ b/docs/reference/api/FieldCapsApi_2.md @@ -0,0 +1,3 @@ +::: +default function FieldCapsApi(this: [That](./That.md), params?: [FieldCapsRequest](./FieldCapsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[FieldCapsResponse](./FieldCapsResponse.md), unknown>>; +::: diff --git a/docs/reference/api/FieldCapsApi_3.md b/docs/reference/api/FieldCapsApi_3.md new file mode 100644 index 000000000..d5db849ce --- /dev/null +++ b/docs/reference/api/FieldCapsApi_3.md @@ -0,0 +1,3 @@ +::: +default function FieldCapsApi(this: [That](./That.md), params?: [FieldCapsRequest](./FieldCapsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[FieldCapsResponse](./FieldCapsResponse.md)>; +::: diff --git a/docs/reference/api/FieldCapsFieldCapability.md b/docs/reference/api/FieldCapsFieldCapability.md new file mode 100644 index 000000000..3ed906542 --- /dev/null +++ b/docs/reference/api/FieldCapsFieldCapability.md @@ -0,0 +1,16 @@ +## Interface `FieldCapsFieldCapability` + +| Name | Type | Description | +| - | - | - | +| `aggregatable` | boolean | Whether this field can be aggregated on all indices. | +| `indices` | [Indices](./Indices.md) | The list of indices where this field has the same type family, or null if all indices have the same type family for the field. | +| `meta` | [Metadata](./Metadata.md) | Merged metadata across all indices as a map of string keys to arrays of values. A value length of 1 indicates that all indices had the same value for this key, while a length of 2 or more indicates that not all indices had the same value for this key. | +| `metadata_field` | boolean | Whether this field is registered as a metadata field. | +| `metric_conflicts_indices` | [IndexName](./IndexName.md)[] | The list of indices where this field is present if these indices don’t have the same `time_series_metric` value for this field. | +| `non_aggregatable_indices` | [Indices](./Indices.md) | The list of indices where this field is not aggregatable, or null if all indices have the same definition for the field. | +| `non_dimension_indices` | [IndexName](./IndexName.md)[] | If this list is present in response then some indices have the field marked as a dimension and other indices, the ones in this list, do not. | +| `non_searchable_indices` | [Indices](./Indices.md) | The list of indices where this field is not searchable, or null if all indices have the same definition for the field. | +| `searchable` | boolean | Whether this field is indexed for search on all indices. | +| `time_series_dimension` | boolean | Whether this field is used as a time series dimension. | +| `time_series_metric` | [MappingTimeSeriesMetricType](./MappingTimeSeriesMetricType.md) | Contains metric type if this fields is used as a time series metrics, absent if the field is not used as metric. | +| `type` | string |   | diff --git a/docs/reference/api/FieldCapsRequest.md b/docs/reference/api/FieldCapsRequest.md new file mode 100644 index 000000000..18e87357d --- /dev/null +++ b/docs/reference/api/FieldCapsRequest.md @@ -0,0 +1,17 @@ +## Interface `FieldCapsRequest` + +| Name | Type | Description | +| - | - | - | +| `allow_no_indices` | boolean | If false, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting `foo*,bar*` returns an error if an index starts with foo but no index starts with bar. | +| `body` | string | ({ [key: string]: any; } & { index?: never; allow_no_indices?: never; expand_wildcards?: never; ignore_unavailable?: never; include_unmapped?: never; filters?: never; types?: never; include_empty_fields?: never; fields?: never; index_filter?: never; runtime_mappings?: never; }) | All values in `body` will be added to the request body. | +| `expand_wildcards` | [ExpandWildcards](./ExpandWildcards.md) | The type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. | +| `fields` | [Fields](./Fields.md) | A list of fields to retrieve capabilities for. Wildcard ( `*`) expressions are supported. | +| `filters` | string | A comma-separated list of filters to apply to the response. | +| `ignore_unavailable` | boolean | If `true`, missing or closed indices are not included in the response. | +| `include_empty_fields` | boolean | If false, empty fields are not included in the response. | +| `include_unmapped` | boolean | If true, unmapped fields are included in the response. | +| `index_filter` | [QueryDslQueryContainer](./QueryDslQueryContainer.md) | Filter indices if the provided query rewrites to `match_none` on every shard. IMPORTANT: The filtering is done on a best-effort basis, it uses index statistics and mappings to rewrite queries to `match_none` instead of fully running the request. For instance a range query over a date field can rewrite to `match_none` if all documents within a shard (including deleted documents) are outside of the provided range. However, not all queries can rewrite to `match_none` so this API may return an index even if the provided filter matches no document. | +| `index` | [Indices](./Indices.md) | A comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indices, omit this parameter or use * or _all. | +| `querystring` | { [key: string]: any; } & { index?: never; allow_no_indices?: never; expand_wildcards?: never; ignore_unavailable?: never; include_unmapped?: never; filters?: never; types?: never; include_empty_fields?: never; fields?: never; index_filter?: never; runtime_mappings?: never; } | All values in `querystring` will be added to the request querystring. | +| `runtime_mappings` | [MappingRuntimeFields](./MappingRuntimeFields.md) | Define ad-hoc runtime fields in the request similar to the way it is done in search requests. These fields exist only as part of the query and take precedence over fields defined with the same name in the index mappings. | +| `types` | string[] | A comma-separated list of field types to include. Any fields that do not match one of these types will be excluded from the results. It defaults to empty, meaning that all field types are returned. | diff --git a/docs/reference/api/FieldCapsResponse.md b/docs/reference/api/FieldCapsResponse.md new file mode 100644 index 000000000..d69d57d91 --- /dev/null +++ b/docs/reference/api/FieldCapsResponse.md @@ -0,0 +1,6 @@ +## Interface `FieldCapsResponse` + +| Name | Type | Description | +| - | - | - | +| `fields` | Record<[Field](./Field.md), Record> |   | +| `indices` | [Indices](./Indices.md) | The list of indices where this field has the same type family, or null if all indices have the same type family for the field. | diff --git a/docs/reference/api/FieldMemoryUsage.md b/docs/reference/api/FieldMemoryUsage.md new file mode 100644 index 000000000..793afb78b --- /dev/null +++ b/docs/reference/api/FieldMemoryUsage.md @@ -0,0 +1,6 @@ +## Interface `FieldMemoryUsage` + +| Name | Type | Description | +| - | - | - | +| `memory_size_in_bytes` | [long](./long.md) |   | +| `memory_size` | [ByteSize](./ByteSize.md) |   | diff --git a/docs/reference/api/FieldSizeUsage.md b/docs/reference/api/FieldSizeUsage.md new file mode 100644 index 000000000..a323072b5 --- /dev/null +++ b/docs/reference/api/FieldSizeUsage.md @@ -0,0 +1,6 @@ +## Interface `FieldSizeUsage` + +| Name | Type | Description | +| - | - | - | +| `size_in_bytes` | [long](./long.md) |   | +| `size` | [ByteSize](./ByteSize.md) |   | diff --git a/docs/reference/api/FieldSort.md b/docs/reference/api/FieldSort.md new file mode 100644 index 000000000..9ee243d35 --- /dev/null +++ b/docs/reference/api/FieldSort.md @@ -0,0 +1,11 @@ +## Interface `FieldSort` + +| Name | Type | Description | +| - | - | - | +| `format` | string |   | +| `missing` | [AggregationsMissing](./AggregationsMissing.md) |   | +| `mode` | [SortMode](./SortMode.md) |   | +| `nested` | [NestedSortValue](./NestedSortValue.md) |   | +| `numeric_type` | [FieldSortNumericType](./FieldSortNumericType.md) |   | +| `order` | [SortOrder](./SortOrder.md) |   | +| `unmapped_type` | [MappingFieldType](./MappingFieldType.md) |   | diff --git a/docs/reference/api/FieldSortNumericType.md b/docs/reference/api/FieldSortNumericType.md new file mode 100644 index 000000000..fedef0217 --- /dev/null +++ b/docs/reference/api/FieldSortNumericType.md @@ -0,0 +1,4 @@ +## `FieldSortNumericType` +::: +type FieldSortNumericType = 'long' | 'double' | 'date' | 'date_nanos'; +::: diff --git a/docs/reference/api/FieldValue.md b/docs/reference/api/FieldValue.md new file mode 100644 index 000000000..83b13eea6 --- /dev/null +++ b/docs/reference/api/FieldValue.md @@ -0,0 +1,4 @@ +## `FieldValue` +::: +type FieldValue = [long](./long.md) | [double](./double.md) | string | boolean | null; +::: diff --git a/docs/reference/api/FielddataStats.md b/docs/reference/api/FielddataStats.md new file mode 100644 index 000000000..a97573440 --- /dev/null +++ b/docs/reference/api/FielddataStats.md @@ -0,0 +1,8 @@ +## Interface `FielddataStats` + +| Name | Type | Description | +| - | - | - | +| `evictions` | [long](./long.md) |   | +| `fields` | Record<[Field](./Field.md), [FieldMemoryUsage](./FieldMemoryUsage.md)> |   | +| `memory_size_in_bytes` | [long](./long.md) |   | +| `memory_size` | [ByteSize](./ByteSize.md) |   | diff --git a/docs/reference/api/Fields.md b/docs/reference/api/Fields.md new file mode 100644 index 000000000..1d7948357 --- /dev/null +++ b/docs/reference/api/Fields.md @@ -0,0 +1,4 @@ +## `Fields` +::: +type Fields = [Field](./Field.md) | [Field](./Field.md)[]; +::: diff --git a/docs/reference/api/Fleet.md b/docs/reference/api/Fleet.md new file mode 100644 index 000000000..99e9067ed --- /dev/null +++ b/docs/reference/api/Fleet.md @@ -0,0 +1,20 @@ +## `Fleet` + +### Constructor + +::: +new Fleet(transport: [Transport](./Transport.md)); +::: + +### Properties + +| Name | Type | Description | +| - | - | - | +| `acceptedParams` | Record |   | +| `transport` | [Transport](./Transport.md) |   | + +### Methods + +| Name | Signature | Description | +| - | - | - | +| `deleteSecret` | `deleteSecret(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TODO](./TODO.md)>;` | Deletes a secret stored by Fleet. || `deleteSecret` | `deleteSecret(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TODO](./TODO.md), unknown>>;` |   || `deleteSecret` | `deleteSecret(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TODO](./TODO.md)>;` |   || `getSecret` | `getSecret(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TODO](./TODO.md)>;` | Retrieves a secret stored by Fleet. || `getSecret` | `getSecret(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TODO](./TODO.md), unknown>>;` |   || `getSecret` | `getSecret(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TODO](./TODO.md)>;` |   || `globalCheckpoints` | `globalCheckpoints(this: [That](./That.md), params: [FleetGlobalCheckpointsRequest](./FleetGlobalCheckpointsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[FleetGlobalCheckpointsResponse](./FleetGlobalCheckpointsResponse.md)>;` | Get global checkpoints. Get the current global checkpoints for an index. This API is designed for internal use by the Fleet server project. || `globalCheckpoints` | `globalCheckpoints(this: [That](./That.md), params: [FleetGlobalCheckpointsRequest](./FleetGlobalCheckpointsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[FleetGlobalCheckpointsResponse](./FleetGlobalCheckpointsResponse.md), unknown>>;` |   || `globalCheckpoints` | `globalCheckpoints(this: [That](./That.md), params: [FleetGlobalCheckpointsRequest](./FleetGlobalCheckpointsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[FleetGlobalCheckpointsResponse](./FleetGlobalCheckpointsResponse.md)>;` |   || `msearch` | `msearch(this: [That](./That.md), params: [FleetMsearchRequest](./FleetMsearchRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[FleetMsearchResponse](./FleetMsearchResponse.md)>;` | Run multiple Fleet searches. Run several Fleet searches with a single API request. The API follows the same structure as the multi search API. However, similar to the Fleet search API, it supports the `wait_for_checkpoints` parameter. || `msearch` | `msearch(this: [That](./That.md), params: [FleetMsearchRequest](./FleetMsearchRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[FleetMsearchResponse](./FleetMsearchResponse.md), unknown>>;` |   || `msearch` | `msearch(this: [That](./That.md), params: [FleetMsearchRequest](./FleetMsearchRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[FleetMsearchResponse](./FleetMsearchResponse.md)>;` |   || `postSecret` | `postSecret(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TODO](./TODO.md)>;` | Creates a secret stored by Fleet. || `postSecret` | `postSecret(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TODO](./TODO.md), unknown>>;` |   || `postSecret` | `postSecret(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TODO](./TODO.md)>;` |   || `search` | `search(this: [That](./That.md), params: [FleetSearchRequest](./FleetSearchRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[FleetSearchResponse](./FleetSearchResponse.md)>;` | Run a Fleet search. The purpose of the Fleet search API is to provide an API where the search will be run only after the provided checkpoint has been processed and is visible for searches inside of Elasticsearch. || `search` | `search(this: [That](./That.md), params: [FleetSearchRequest](./FleetSearchRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[FleetSearchResponse](./FleetSearchResponse.md), unknown>>;` |   || `search` | `search(this: [That](./That.md), params: [FleetSearchRequest](./FleetSearchRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[FleetSearchResponse](./FleetSearchResponse.md)>;` |   | \ No newline at end of file diff --git a/docs/reference/api/FleetCheckpoint.md b/docs/reference/api/FleetCheckpoint.md new file mode 100644 index 000000000..7920af644 --- /dev/null +++ b/docs/reference/api/FleetCheckpoint.md @@ -0,0 +1,4 @@ +## `FleetCheckpoint` +::: +type FleetCheckpoint = [long](./long.md); +::: diff --git a/docs/reference/api/FleetGlobalCheckpointsRequest.md b/docs/reference/api/FleetGlobalCheckpointsRequest.md new file mode 100644 index 000000000..397fc66dd --- /dev/null +++ b/docs/reference/api/FleetGlobalCheckpointsRequest.md @@ -0,0 +1,11 @@ +## Interface `FleetGlobalCheckpointsRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { index?: never; wait_for_advance?: never; wait_for_index?: never; checkpoints?: never; timeout?: never; }) | All values in `body` will be added to the request body. | +| `checkpoints` | [FleetCheckpoint](./FleetCheckpoint.md)[] | A comma separated list of previous global checkpoints. When used in combination with `wait_for_advance`, the API will only return once the global checkpoints advances past the checkpoints. Providing an empty list will cause Elasticsearch to immediately return the current global checkpoints. | +| `index` | [IndexName](./IndexName.md) | [IndexAlias](./IndexAlias.md) | A single index or index alias that resolves to a single index. | +| `querystring` | { [key: string]: any; } & { index?: never; wait_for_advance?: never; wait_for_index?: never; checkpoints?: never; timeout?: never; } | All values in `querystring` will be added to the request querystring. | +| `timeout` | [Duration](./Duration.md) | Period to wait for a global checkpoints to advance past `checkpoints`. | +| `wait_for_advance` | boolean | A boolean value which controls whether to wait (until the timeout) for the global checkpoints to advance past the provided `checkpoints`. | +| `wait_for_index` | boolean | A boolean value which controls whether to wait (until the timeout) for the target index to exist and all primary shards be active. Can only be true when `wait_for_advance` is true. | diff --git a/docs/reference/api/FleetGlobalCheckpointsResponse.md b/docs/reference/api/FleetGlobalCheckpointsResponse.md new file mode 100644 index 000000000..5c21f0716 --- /dev/null +++ b/docs/reference/api/FleetGlobalCheckpointsResponse.md @@ -0,0 +1,6 @@ +## Interface `FleetGlobalCheckpointsResponse` + +| Name | Type | Description | +| - | - | - | +| `global_checkpoints` | [FleetCheckpoint](./FleetCheckpoint.md)[] |   | +| `timed_out` | boolean |   | diff --git a/docs/reference/api/FleetMsearchRequest.md b/docs/reference/api/FleetMsearchRequest.md new file mode 100644 index 000000000..b20160260 --- /dev/null +++ b/docs/reference/api/FleetMsearchRequest.md @@ -0,0 +1,21 @@ +## Interface `FleetMsearchRequest` + +| Name | Type | Description | +| - | - | - | +| `allow_no_indices` | boolean | If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar. | +| `allow_partial_search_results` | boolean | If true, returns partial results if there are shard request timeouts or shard failures. If false, returns an error with no partial results. Defaults to the configured cluster setting `search.default_allow_partial_results`, which is true by default. | +| `body` | string | ({ [key: string]: any; } & { index?: never; allow_no_indices?: never; ccs_minimize_roundtrips?: never; expand_wildcards?: never; ignore_throttled?: never; ignore_unavailable?: never; max_concurrent_searches?: never; max_concurrent_shard_requests?: never; pre_filter_shard_size?: never; search_type?: never; rest_total_hits_as_int?: never; typed_keys?: never; wait_for_checkpoints?: never; allow_partial_search_results?: never; searches?: never; }) | All values in `body` will be added to the request body. | +| `ccs_minimize_roundtrips` | boolean | If true, network roundtrips between the coordinating node and remote clusters are minimized for cross-cluster search requests. | +| `expand_wildcards` | [ExpandWildcards](./ExpandWildcards.md) | Type of index that wildcard expressions can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. | +| `ignore_throttled` | boolean | If true, concrete, expanded or aliased indices are ignored when frozen. | +| `ignore_unavailable` | boolean | If true, missing or closed indices are not included in the response. | +| `index` | [IndexName](./IndexName.md) | [IndexAlias](./IndexAlias.md) | A single target to search. If the target is an index alias, it must resolve to a single index. | +| `max_concurrent_searches` | [integer](./integer.md) | Maximum number of concurrent searches the multi search API can execute. | +| `max_concurrent_shard_requests` | [integer](./integer.md) | Maximum number of concurrent shard requests that each sub-search request executes per node. | +| `pre_filter_shard_size` | [long](./long.md) | Defines a threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method i.e., if date filters are mandatory to match but the shard bounds and the query are disjoint. | +| `querystring` | { [key: string]: any; } & { index?: never; allow_no_indices?: never; ccs_minimize_roundtrips?: never; expand_wildcards?: never; ignore_throttled?: never; ignore_unavailable?: never; max_concurrent_searches?: never; max_concurrent_shard_requests?: never; pre_filter_shard_size?: never; search_type?: never; rest_total_hits_as_int?: never; typed_keys?: never; wait_for_checkpoints?: never; allow_partial_search_results?: never; searches?: never; } | All values in `querystring` will be added to the request querystring. | +| `rest_total_hits_as_int` | boolean | If true, hits.total are returned as an integer in the response. Defaults to false, which returns an object. | +| `search_type` | [SearchType](./SearchType.md) | Indicates whether global term and document frequencies should be used when scoring returned documents. | +| `searches` | [MsearchRequestItem](./MsearchRequestItem.md)[] |   | +| `typed_keys` | boolean | Specifies whether aggregation and suggester names should be prefixed by their respective types in the response. | +| `wait_for_checkpoints` | [FleetCheckpoint](./FleetCheckpoint.md)[] | A comma separated list of checkpoints. When configured, the search API will only be executed on a shard after the relevant checkpoint has become visible for search. Defaults to an empty list which will cause Elasticsearch to immediately execute the search. | diff --git a/docs/reference/api/FleetMsearchResponse.md b/docs/reference/api/FleetMsearchResponse.md new file mode 100644 index 000000000..be53fe44d --- /dev/null +++ b/docs/reference/api/FleetMsearchResponse.md @@ -0,0 +1,5 @@ +## Interface `FleetMsearchResponse` + +| Name | Type | Description | +| - | - | - | +| `docs` | [MsearchResponseItem](./MsearchResponseItem.md)[] |   | diff --git a/docs/reference/api/FleetSearchRequest.md b/docs/reference/api/FleetSearchRequest.md new file mode 100644 index 000000000..b005d6cb4 --- /dev/null +++ b/docs/reference/api/FleetSearchRequest.md @@ -0,0 +1,68 @@ +## Interface `FleetSearchRequest` + +| Name | Type | Description | +| - | - | - | +| `_source_excludes` | [Fields](./Fields.md) |   | +| `_source_includes` | [Fields](./Fields.md) |   | +| `_source` | [SearchSourceConfig](./SearchSourceConfig.md) | Indicates which source fields are returned for matching documents. These fields are returned in the hits._source property of the search response. | +| `aggregations` | Record |   | +| `aggs` | Record | aggregations | +| `allow_no_indices` | boolean |   | +| `allow_partial_search_results` | boolean | If true, returns partial results if there are shard request timeouts or shard failures. If false, returns an error with no partial results. Defaults to the configured cluster setting `search.default_allow_partial_results`, which is true by default. | +| `analyze_wildcard` | boolean |   | +| `analyzer` | string |   | +| `batched_reduce_size` | [long](./long.md) |   | +| `body` | string | ({ [key: string]: any; } & { index?: never; allow_no_indices?: never; analyzer?: never; analyze_wildcard?: never; batched_reduce_size?: never; ccs_minimize_roundtrips?: never; default_operator?: never; df?: never; expand_wildcards?: never; ignore_throttled?: never; ignore_unavailable?: never; lenient?: never; max_concurrent_shard_requests?: never; preference?: never; pre_filter_shard_size?: never; request_cache?: never; routing?: never; scroll?: never; search_type?: never; suggest_field?: never; suggest_mode?: never; suggest_size?: never; suggest_text?: never; typed_keys?: never; rest_total_hits_as_int?: never; _source_excludes?: never; _source_includes?: never; q?: never; wait_for_checkpoints?: never; allow_partial_search_results?: never; aggregations?: never; aggs?: never; collapse?: never; explain?: never; ext?: never; from?: never; highlight?: never; track_total_hits?: never; indices_boost?: never; docvalue_fields?: never; min_score?: never; post_filter?: never; profile?: never; query?: never; rescore?: never; script_fields?: never; search_after?: never; size?: never; slice?: never; sort?: never; _source?: never; fields?: never; suggest?: never; terminate_after?: never; timeout?: never; track_scores?: never; version?: never; seq_no_primary_term?: never; stored_fields?: never; pit?: never; runtime_mappings?: never; stats?: never; }) | All values in `body` will be added to the request body. | +| `ccs_minimize_roundtrips` | boolean |   | +| `collapse` | [SearchFieldCollapse](./SearchFieldCollapse.md) |   | +| `default_operator` | [QueryDslOperator](./QueryDslOperator.md) |   | +| `df` | string |   | +| `docvalue_fields` | ([QueryDslFieldAndFormat](./QueryDslFieldAndFormat.md) | [Field](./Field.md))[] | Array of wildcard (*) patterns. The request returns doc values for field names matching these patterns in the hits.fields property of the response. | +| `expand_wildcards` | [ExpandWildcards](./ExpandWildcards.md) |   | +| `explain` | boolean | If true, returns detailed information about score computation as part of a hit. | +| `ext` | Record | Configuration of search extensions defined by Elasticsearch plugins. | +| `fields` | ([QueryDslFieldAndFormat](./QueryDslFieldAndFormat.md) | [Field](./Field.md))[] | Array of wildcard (*) patterns. The request returns values for field names matching these patterns in the hits.fields property of the response. | +| `from` | [integer](./integer.md) | Starting document offset. By default, you cannot page through more than 10,000 hits using the from and size parameters. To page through more hits, use the search_after parameter. | +| `highlight` | [SearchHighlight](./SearchHighlight.md) |   | +| `ignore_throttled` | boolean |   | +| `ignore_unavailable` | boolean |   | +| `index` | [IndexName](./IndexName.md) | [IndexAlias](./IndexAlias.md) | A single target to search. If the target is an index alias, it must resolve to a single index. | +| `indices_boost` | [Partial](./Partial.md)>[] | Boosts the _score of documents from specified indices. | +| `lenient` | boolean |   | +| `max_concurrent_shard_requests` | [integer](./integer.md) |   | +| `min_score` | [double](./double.md) | Minimum _score for matching documents. Documents with a lower _score are not included in search results and results collected by aggregations. | +| `pit` | [SearchPointInTimeReference](./SearchPointInTimeReference.md) | Limits the search to a point in time (PIT). If you provide a PIT, you cannot specify an in the request path. | +| `post_filter` | [QueryDslQueryContainer](./QueryDslQueryContainer.md) |   | +| `pre_filter_shard_size` | [long](./long.md) |   | +| `preference` | string |   | +| `profile` | boolean |   | +| `q` | string |   | +| `query` | [QueryDslQueryContainer](./QueryDslQueryContainer.md) | Defines the search definition using the Query DSL. | +| `querystring` | { [key: string]: any; } & { index?: never; allow_no_indices?: never; analyzer?: never; analyze_wildcard?: never; batched_reduce_size?: never; ccs_minimize_roundtrips?: never; default_operator?: never; df?: never; expand_wildcards?: never; ignore_throttled?: never; ignore_unavailable?: never; lenient?: never; max_concurrent_shard_requests?: never; preference?: never; pre_filter_shard_size?: never; request_cache?: never; routing?: never; scroll?: never; search_type?: never; suggest_field?: never; suggest_mode?: never; suggest_size?: never; suggest_text?: never; typed_keys?: never; rest_total_hits_as_int?: never; _source_excludes?: never; _source_includes?: never; q?: never; wait_for_checkpoints?: never; allow_partial_search_results?: never; aggregations?: never; aggs?: never; collapse?: never; explain?: never; ext?: never; from?: never; highlight?: never; track_total_hits?: never; indices_boost?: never; docvalue_fields?: never; min_score?: never; post_filter?: never; profile?: never; query?: never; rescore?: never; script_fields?: never; search_after?: never; size?: never; slice?: never; sort?: never; _source?: never; fields?: never; suggest?: never; terminate_after?: never; timeout?: never; track_scores?: never; version?: never; seq_no_primary_term?: never; stored_fields?: never; pit?: never; runtime_mappings?: never; stats?: never; } | All values in `querystring` will be added to the request querystring. | +| `request_cache` | boolean |   | +| `rescore` | [SearchRescore](./SearchRescore.md) | [SearchRescore](./SearchRescore.md)[] |   | +| `rest_total_hits_as_int` | boolean |   | +| `routing` | [Routing](./Routing.md) |   | +| `runtime_mappings` | [MappingRuntimeFields](./MappingRuntimeFields.md) | Defines one or more runtime fields in the search request. These fields take precedence over mapped fields with the same name. | +| `script_fields` | Record | Retrieve a script evaluation (based on different fields) for each hit. | +| `scroll` | [Duration](./Duration.md) |   | +| `search_after` | [SortResults](./SortResults.md) |   | +| `search_type` | [SearchType](./SearchType.md) |   | +| `seq_no_primary_term` | boolean | If true, returns sequence number and primary term of the last modification of each hit. See Optimistic concurrency control. | +| `size` | [integer](./integer.md) | The number of hits to return. By default, you cannot page through more than 10,000 hits using the from and size parameters. To page through more hits, use the search_after parameter. | +| `slice` | [SlicedScroll](./SlicedScroll.md) |   | +| `sort` | [Sort](./Sort.md) |   | +| `stats` | string[] | Stats groups to associate with the search. Each group maintains a statistics aggregation for its associated searches. You can retrieve these stats using the indices stats API. | +| `stored_fields` | [Fields](./Fields.md) | List of stored fields to return as part of a hit. If no fields are specified, no stored fields are included in the response. If this field is specified, the _source parameter defaults to false. You can pass _source: true to return both source fields and stored fields in the search response. | +| `suggest_field` | [Field](./Field.md) | Specifies which field to use for suggestions. | +| `suggest_mode` | [SuggestMode](./SuggestMode.md) |   | +| `suggest_size` | [long](./long.md) |   | +| `suggest_text` | string | The source text for which the suggestions should be returned. | +| `suggest` | [SearchSuggester](./SearchSuggester.md) |   | +| `terminate_after` | [long](./long.md) | Maximum number of documents to collect for each shard. If a query reaches this limit, Elasticsearch terminates the query early. Elasticsearch collects documents before sorting. Defaults to 0, which does not terminate query execution early. | +| `timeout` | string | Specifies the period of time to wait for a response from each shard. If no response is received before the timeout expires, the request fails and returns an error. Defaults to no timeout. | +| `track_scores` | boolean | If true, calculate and return document scores, even if the scores are not used for sorting. | +| `track_total_hits` | [SearchTrackHits](./SearchTrackHits.md) | Number of hits matching the query to count accurately. If true, the exact number of hits is returned at the cost of some performance. If false, the response does not include the total number of hits matching the query. Defaults to 10,000 hits. | +| `typed_keys` | boolean |   | +| `version` | boolean | If true, returns document version as part of a hit. | +| `wait_for_checkpoints` | [FleetCheckpoint](./FleetCheckpoint.md)[] | A comma separated list of checkpoints. When configured, the search API will only be executed on a shard after the relevant checkpoint has become visible for search. Defaults to an empty list which will cause Elasticsearch to immediately execute the search. | diff --git a/docs/reference/api/FleetSearchResponse.md b/docs/reference/api/FleetSearchResponse.md new file mode 100644 index 000000000..f05615b81 --- /dev/null +++ b/docs/reference/api/FleetSearchResponse.md @@ -0,0 +1,18 @@ +## Interface `FleetSearchResponse` + +| Name | Type | Description | +| - | - | - | +| `_clusters` | [ClusterStatistics](./ClusterStatistics.md) |   | +| `_scroll_id` | [ScrollId](./ScrollId.md) |   | +| `_shards` | [ShardStatistics](./ShardStatistics.md) |   | +| `aggregations` | Record<[AggregateName](./AggregateName.md), [AggregationsAggregate](./AggregationsAggregate.md)> |   | +| `fields` | Record |   | +| `hits` | [SearchHitsMetadata](./SearchHitsMetadata.md) |   | +| `max_score` | [double](./double.md) |   | +| `num_reduce_phases` | [long](./long.md) |   | +| `pit_id` | [Id](./Id.md) |   | +| `profile` | [SearchProfile](./SearchProfile.md) |   | +| `suggest` | Record<[SuggestionName](./SuggestionName.md), [SearchSuggest](./SearchSuggest.md)[]> |   | +| `terminated_early` | boolean |   | +| `timed_out` | boolean |   | +| `took` | [long](./long.md) |   | diff --git a/docs/reference/api/FlushStats.md b/docs/reference/api/FlushStats.md new file mode 100644 index 000000000..a42f102d7 --- /dev/null +++ b/docs/reference/api/FlushStats.md @@ -0,0 +1,8 @@ +## Interface `FlushStats` + +| Name | Type | Description | +| - | - | - | +| `periodic` | [long](./long.md) |   | +| `total_time_in_millis` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> |   | +| `total_time` | [Duration](./Duration.md) |   | +| `total` | [long](./long.md) |   | diff --git a/docs/reference/api/Fuzziness.md b/docs/reference/api/Fuzziness.md new file mode 100644 index 000000000..588ad12f5 --- /dev/null +++ b/docs/reference/api/Fuzziness.md @@ -0,0 +1,4 @@ +## `Fuzziness` +::: +type Fuzziness = string | [integer](./integer.md); +::: diff --git a/docs/reference/api/GeoBounds.md b/docs/reference/api/GeoBounds.md new file mode 100644 index 000000000..bfb1ba12d --- /dev/null +++ b/docs/reference/api/GeoBounds.md @@ -0,0 +1,4 @@ +## `GeoBounds` +::: +type GeoBounds = [CoordsGeoBounds](./CoordsGeoBounds.md) | [TopLeftBottomRightGeoBounds](./TopLeftBottomRightGeoBounds.md) | [TopRightBottomLeftGeoBounds](./TopRightBottomLeftGeoBounds.md) | [WktGeoBounds](./WktGeoBounds.md); +::: diff --git a/docs/reference/api/GeoDistanceSort.md b/docs/reference/api/GeoDistanceSort.md new file mode 100644 index 000000000..5b3633684 --- /dev/null +++ b/docs/reference/api/GeoDistanceSort.md @@ -0,0 +1,4 @@ +## `GeoDistanceSort` +::: +type GeoDistanceSort = [GeoDistanceSortKeys](./GeoDistanceSortKeys.md) & { [property: string]: [GeoLocation](./GeoLocation.md) | [GeoLocation](./GeoLocation.md)[] | [SortMode](./SortMode.md) | [GeoDistanceType](./GeoDistanceType.md) | boolean | [SortOrder](./SortOrder.md) | [DistanceUnit](./DistanceUnit.md) | [NestedSortValue](./NestedSortValue.md);}; +::: diff --git a/docs/reference/api/GeoDistanceSortKeys.md b/docs/reference/api/GeoDistanceSortKeys.md new file mode 100644 index 000000000..17355b8d1 --- /dev/null +++ b/docs/reference/api/GeoDistanceSortKeys.md @@ -0,0 +1,10 @@ +## Interface `GeoDistanceSortKeys` + +| Name | Type | Description | +| - | - | - | +| `distance_type` | [GeoDistanceType](./GeoDistanceType.md) |   | +| `ignore_unmapped` | boolean |   | +| `mode` | [SortMode](./SortMode.md) |   | +| `nested` | [NestedSortValue](./NestedSortValue.md) |   | +| `order` | [SortOrder](./SortOrder.md) |   | +| `unit` | [DistanceUnit](./DistanceUnit.md) |   | diff --git a/docs/reference/api/GeoDistanceType.md b/docs/reference/api/GeoDistanceType.md new file mode 100644 index 000000000..0678f12fa --- /dev/null +++ b/docs/reference/api/GeoDistanceType.md @@ -0,0 +1,4 @@ +## `GeoDistanceType` +::: +type GeoDistanceType = 'arc' | 'plane'; +::: diff --git a/docs/reference/api/GeoHash.md b/docs/reference/api/GeoHash.md new file mode 100644 index 000000000..a7e411e19 --- /dev/null +++ b/docs/reference/api/GeoHash.md @@ -0,0 +1,4 @@ +## `GeoHash` +::: +type GeoHash = string; +::: diff --git a/docs/reference/api/GeoHashLocation.md b/docs/reference/api/GeoHashLocation.md new file mode 100644 index 000000000..07b1a66ca --- /dev/null +++ b/docs/reference/api/GeoHashLocation.md @@ -0,0 +1,5 @@ +## Interface `GeoHashLocation` + +| Name | Type | Description | +| - | - | - | +| `geohash` | [GeoHash](./GeoHash.md) |   | diff --git a/docs/reference/api/GeoHashPrecision.md b/docs/reference/api/GeoHashPrecision.md new file mode 100644 index 000000000..3f21eba22 --- /dev/null +++ b/docs/reference/api/GeoHashPrecision.md @@ -0,0 +1,4 @@ +## `GeoHashPrecision` +::: +type GeoHashPrecision = number | string; +::: diff --git a/docs/reference/api/GeoHexCell.md b/docs/reference/api/GeoHexCell.md new file mode 100644 index 000000000..e61ee4029 --- /dev/null +++ b/docs/reference/api/GeoHexCell.md @@ -0,0 +1,4 @@ +## `GeoHexCell` +::: +type GeoHexCell = string; +::: diff --git a/docs/reference/api/GeoLine.md b/docs/reference/api/GeoLine.md new file mode 100644 index 000000000..a577baa7a --- /dev/null +++ b/docs/reference/api/GeoLine.md @@ -0,0 +1,6 @@ +## Interface `GeoLine` + +| Name | Type | Description | +| - | - | - | +| `coordinates` | [double](./double.md)[][] | Array of `[lon, lat]` coordinates | +| `type` | string | Always `"LineString"` | diff --git a/docs/reference/api/GeoLocation.md b/docs/reference/api/GeoLocation.md new file mode 100644 index 000000000..cdeaf7d8a --- /dev/null +++ b/docs/reference/api/GeoLocation.md @@ -0,0 +1,4 @@ +## `GeoLocation` +::: +type GeoLocation = [LatLonGeoLocation](./LatLonGeoLocation.md) | [GeoHashLocation](./GeoHashLocation.md) | [double](./double.md)[] | string; +::: diff --git a/docs/reference/api/GeoShape.md b/docs/reference/api/GeoShape.md new file mode 100644 index 000000000..27ecaab90 --- /dev/null +++ b/docs/reference/api/GeoShape.md @@ -0,0 +1,4 @@ +## `GeoShape` +::: +type GeoShape = any; +::: diff --git a/docs/reference/api/GeoShapeRelation.md b/docs/reference/api/GeoShapeRelation.md new file mode 100644 index 000000000..c745b446f --- /dev/null +++ b/docs/reference/api/GeoShapeRelation.md @@ -0,0 +1,4 @@ +## `GeoShapeRelation` +::: +type GeoShapeRelation = 'intersects' | 'disjoint' | 'within' | 'contains'; +::: diff --git a/docs/reference/api/GeoTile.md b/docs/reference/api/GeoTile.md new file mode 100644 index 000000000..f47e5f1b2 --- /dev/null +++ b/docs/reference/api/GeoTile.md @@ -0,0 +1,4 @@ +## `GeoTile` +::: +type GeoTile = string; +::: diff --git a/docs/reference/api/GeoTilePrecision.md b/docs/reference/api/GeoTilePrecision.md new file mode 100644 index 000000000..413d38bdd --- /dev/null +++ b/docs/reference/api/GeoTilePrecision.md @@ -0,0 +1,4 @@ +## `GeoTilePrecision` +::: +type GeoTilePrecision = number; +::: diff --git a/docs/reference/api/GetApi_1.md b/docs/reference/api/GetApi_1.md new file mode 100644 index 000000000..69d20b083 --- /dev/null +++ b/docs/reference/api/GetApi_1.md @@ -0,0 +1,3 @@ +::: +default function GetApi(this: [That](./That.md), params: [GetRequest](./GetRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[GetResponse](./GetResponse.md)>; +::: diff --git a/docs/reference/api/GetApi_2.md b/docs/reference/api/GetApi_2.md new file mode 100644 index 000000000..b3ee00f3c --- /dev/null +++ b/docs/reference/api/GetApi_2.md @@ -0,0 +1,3 @@ +::: +default function GetApi(this: [That](./That.md), params: [GetRequest](./GetRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[GetResponse](./GetResponse.md), unknown>>; +::: diff --git a/docs/reference/api/GetApi_3.md b/docs/reference/api/GetApi_3.md new file mode 100644 index 000000000..99c831157 --- /dev/null +++ b/docs/reference/api/GetApi_3.md @@ -0,0 +1,3 @@ +::: +default function GetApi(this: [That](./That.md), params: [GetRequest](./GetRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[GetResponse](./GetResponse.md)>; +::: diff --git a/docs/reference/api/GetGetResult.md b/docs/reference/api/GetGetResult.md new file mode 100644 index 000000000..7f31f7a4f --- /dev/null +++ b/docs/reference/api/GetGetResult.md @@ -0,0 +1,14 @@ +## Interface `GetGetResult` + +| Name | Type | Description | +| - | - | - | +| `_id` | [Id](./Id.md) | The unique identifier for the document. | +| `_ignored` | string[] |   | +| `_index` | [IndexName](./IndexName.md) | The name of the index the document belongs to. | +| `_primary_term` | [long](./long.md) | The primary term assigned to the document for the indexing operation. | +| `_routing` | string | The explicit routing, if set. | +| `_seq_no` | [SequenceNumber](./SequenceNumber.md) | The sequence number assigned to the document for the indexing operation. Sequence numbers are used to ensure an older version of a document doesn't overwrite a newer version. | +| `_source` | TDocument | If `found` is `true`, it contains the document data formatted in JSON. If the `_source` parameter is set to `false` or the `stored_fields` parameter is set to `true`, it is excluded. | +| `_version` | [VersionNumber](./VersionNumber.md) | The document version, which is ncremented each time the document is updated. | +| `fields` | Record | If the `stored_fields` parameter is set to `true` and `found` is `true`, it contains the document fields stored in the index. | +| `found` | boolean | Indicates whether the document exists. | diff --git a/docs/reference/api/GetRequest.md b/docs/reference/api/GetRequest.md new file mode 100644 index 000000000..33ff7dbde --- /dev/null +++ b/docs/reference/api/GetRequest.md @@ -0,0 +1,19 @@ +## Interface `GetRequest` + +| Name | Type | Description | +| - | - | - | +| `_source_excludes` | [Fields](./Fields.md) | A comma-separated list of source fields to exclude from the response. You can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter. If the `_source` parameter is `false`, this parameter is ignored. | +| `_source_includes` | [Fields](./Fields.md) | A comma-separated list of source fields to include in the response. If this parameter is specified, only these source fields are returned. You can exclude fields from this subset using the `_source_excludes` query parameter. If the `_source` parameter is `false`, this parameter is ignored. | +| `_source` | [SearchSourceConfigParam](./SearchSourceConfigParam.md) | Indicates whether to return the `_source` field ( `true` or `false`) or lists the fields to return. | +| `body` | string | ({ [key: string]: any; } & { id?: never; index?: never; force_synthetic_source?: never; preference?: never; realtime?: never; refresh?: never; routing?: never; _source?: never; _source_excludes?: never; _source_includes?: never; stored_fields?: never; version?: never; version_type?: never; }) | All values in `body` will be added to the request body. | +| `force_synthetic_source` | boolean | Indicates whether the request forces synthetic `_source`. Use this paramater to test if the mapping supports synthetic `_source` and to get a sense of the worst case performance. Fetches with this parameter enabled will be slower than enabling synthetic source natively in the index. | +| `id` | [Id](./Id.md) | A unique document identifier. | +| `index` | [IndexName](./IndexName.md) | The name of the index that contains the document. | +| `preference` | string | The node or shard the operation should be performed on. By default, the operation is randomized between the shard replicas. If it is set to `_local`, the operation will prefer to be run on a local allocated shard when possible. If it is set to a custom value, the value is used to guarantee that the same shards will be used for the same custom value. This can help with "jumping values" when hitting different shards in different refresh states. A sample value can be something like the web session ID or the user name. | +| `querystring` | { [key: string]: any; } & { id?: never; index?: never; force_synthetic_source?: never; preference?: never; realtime?: never; refresh?: never; routing?: never; _source?: never; _source_excludes?: never; _source_includes?: never; stored_fields?: never; version?: never; version_type?: never; } | All values in `querystring` will be added to the request querystring. | +| `realtime` | boolean | If `true`, the request is real-time as opposed to near-real-time. | +| `refresh` | boolean | If `true`, the request refreshes the relevant shards before retrieving the document. Setting it to `true` should be done after careful thought and verification that this does not cause a heavy load on the system (and slow down indexing). | +| `routing` | [Routing](./Routing.md) | A custom value used to route operations to a specific shard. | +| `stored_fields` | [Fields](./Fields.md) | A comma-separated list of stored fields to return as part of a hit. If no fields are specified, no stored fields are included in the response. If this field is specified, the `_source` parameter defaults to `false`. Only leaf fields can be retrieved with the `stored_field` option. Object fields can't be returned;if specified, the request fails. | +| `version_type` | [VersionType](./VersionType.md) | The version type. | +| `version` | [VersionNumber](./VersionNumber.md) | The version number for concurrency control. It must match the current version of the document for the request to succeed. | diff --git a/docs/reference/api/GetResponse.md b/docs/reference/api/GetResponse.md new file mode 100644 index 000000000..52d889fc9 --- /dev/null +++ b/docs/reference/api/GetResponse.md @@ -0,0 +1,4 @@ +## `GetResponse` +::: +type GetResponse = [GetGetResult](./GetGetResult.md); +::: diff --git a/docs/reference/api/GetScriptApi_1.md b/docs/reference/api/GetScriptApi_1.md new file mode 100644 index 000000000..35666903d --- /dev/null +++ b/docs/reference/api/GetScriptApi_1.md @@ -0,0 +1,3 @@ +::: +default function GetScriptApi(this: [That](./That.md), params: [GetScriptRequest](./GetScriptRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[GetScriptResponse](./GetScriptResponse.md)>; +::: diff --git a/docs/reference/api/GetScriptApi_2.md b/docs/reference/api/GetScriptApi_2.md new file mode 100644 index 000000000..cd4bad5d1 --- /dev/null +++ b/docs/reference/api/GetScriptApi_2.md @@ -0,0 +1,3 @@ +::: +default function GetScriptApi(this: [That](./That.md), params: [GetScriptRequest](./GetScriptRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[GetScriptResponse](./GetScriptResponse.md), unknown>>; +::: diff --git a/docs/reference/api/GetScriptApi_3.md b/docs/reference/api/GetScriptApi_3.md new file mode 100644 index 000000000..52279c45b --- /dev/null +++ b/docs/reference/api/GetScriptApi_3.md @@ -0,0 +1,3 @@ +::: +default function GetScriptApi(this: [That](./That.md), params: [GetScriptRequest](./GetScriptRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[GetScriptResponse](./GetScriptResponse.md)>; +::: diff --git a/docs/reference/api/GetScriptContextApi_1.md b/docs/reference/api/GetScriptContextApi_1.md new file mode 100644 index 000000000..936b6c1b0 --- /dev/null +++ b/docs/reference/api/GetScriptContextApi_1.md @@ -0,0 +1,3 @@ +::: +default function GetScriptContextApi(this: [That](./That.md), params?: [GetScriptContextRequest](./GetScriptContextRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[GetScriptContextResponse](./GetScriptContextResponse.md)>; +::: diff --git a/docs/reference/api/GetScriptContextApi_2.md b/docs/reference/api/GetScriptContextApi_2.md new file mode 100644 index 000000000..bbb7ec450 --- /dev/null +++ b/docs/reference/api/GetScriptContextApi_2.md @@ -0,0 +1,3 @@ +::: +default function GetScriptContextApi(this: [That](./That.md), params?: [GetScriptContextRequest](./GetScriptContextRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[GetScriptContextResponse](./GetScriptContextResponse.md), unknown>>; +::: diff --git a/docs/reference/api/GetScriptContextApi_3.md b/docs/reference/api/GetScriptContextApi_3.md new file mode 100644 index 000000000..d662b6aa1 --- /dev/null +++ b/docs/reference/api/GetScriptContextApi_3.md @@ -0,0 +1,3 @@ +::: +default function GetScriptContextApi(this: [That](./That.md), params?: [GetScriptContextRequest](./GetScriptContextRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[GetScriptContextResponse](./GetScriptContextResponse.md)>; +::: diff --git a/docs/reference/api/GetScriptContextContext.md b/docs/reference/api/GetScriptContextContext.md new file mode 100644 index 000000000..442e4c740 --- /dev/null +++ b/docs/reference/api/GetScriptContextContext.md @@ -0,0 +1,6 @@ +## Interface `GetScriptContextContext` + +| Name | Type | Description | +| - | - | - | +| `methods` | [GetScriptContextContextMethod](./GetScriptContextContextMethod.md)[] |   | +| `name` | [Name](./Name.md) |   | diff --git a/docs/reference/api/GetScriptContextContextMethod.md b/docs/reference/api/GetScriptContextContextMethod.md new file mode 100644 index 000000000..51548e285 --- /dev/null +++ b/docs/reference/api/GetScriptContextContextMethod.md @@ -0,0 +1,7 @@ +## Interface `GetScriptContextContextMethod` + +| Name | Type | Description | +| - | - | - | +| `name` | [Name](./Name.md) |   | +| `params` | [GetScriptContextContextMethodParam](./GetScriptContextContextMethodParam.md)[] |   | +| `return_type` | string |   | diff --git a/docs/reference/api/GetScriptContextContextMethodParam.md b/docs/reference/api/GetScriptContextContextMethodParam.md new file mode 100644 index 000000000..90d7cbb71 --- /dev/null +++ b/docs/reference/api/GetScriptContextContextMethodParam.md @@ -0,0 +1,6 @@ +## Interface `GetScriptContextContextMethodParam` + +| Name | Type | Description | +| - | - | - | +| `name` | [Name](./Name.md) |   | +| `type` | string |   | diff --git a/docs/reference/api/GetScriptContextRequest.md b/docs/reference/api/GetScriptContextRequest.md new file mode 100644 index 000000000..19f92a3c3 --- /dev/null +++ b/docs/reference/api/GetScriptContextRequest.md @@ -0,0 +1,6 @@ +## Interface `GetScriptContextRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | { [key: string]: any; } | All values in `body` will be added to the request body. | +| `querystring` | { [key: string]: any; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/GetScriptContextResponse.md b/docs/reference/api/GetScriptContextResponse.md new file mode 100644 index 000000000..2c856681c --- /dev/null +++ b/docs/reference/api/GetScriptContextResponse.md @@ -0,0 +1,5 @@ +## Interface `GetScriptContextResponse` + +| Name | Type | Description | +| - | - | - | +| `contexts` | [GetScriptContextContext](./GetScriptContextContext.md)[] |   | diff --git a/docs/reference/api/GetScriptLanguagesApi_1.md b/docs/reference/api/GetScriptLanguagesApi_1.md new file mode 100644 index 000000000..4195f1a2d --- /dev/null +++ b/docs/reference/api/GetScriptLanguagesApi_1.md @@ -0,0 +1,3 @@ +::: +default function GetScriptLanguagesApi(this: [That](./That.md), params?: [GetScriptLanguagesRequest](./GetScriptLanguagesRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[GetScriptLanguagesResponse](./GetScriptLanguagesResponse.md)>; +::: diff --git a/docs/reference/api/GetScriptLanguagesApi_2.md b/docs/reference/api/GetScriptLanguagesApi_2.md new file mode 100644 index 000000000..6c62c49f4 --- /dev/null +++ b/docs/reference/api/GetScriptLanguagesApi_2.md @@ -0,0 +1,3 @@ +::: +default function GetScriptLanguagesApi(this: [That](./That.md), params?: [GetScriptLanguagesRequest](./GetScriptLanguagesRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[GetScriptLanguagesResponse](./GetScriptLanguagesResponse.md), unknown>>; +::: diff --git a/docs/reference/api/GetScriptLanguagesApi_3.md b/docs/reference/api/GetScriptLanguagesApi_3.md new file mode 100644 index 000000000..b544b5f64 --- /dev/null +++ b/docs/reference/api/GetScriptLanguagesApi_3.md @@ -0,0 +1,3 @@ +::: +default function GetScriptLanguagesApi(this: [That](./That.md), params?: [GetScriptLanguagesRequest](./GetScriptLanguagesRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[GetScriptLanguagesResponse](./GetScriptLanguagesResponse.md)>; +::: diff --git a/docs/reference/api/GetScriptLanguagesLanguageContext.md b/docs/reference/api/GetScriptLanguagesLanguageContext.md new file mode 100644 index 000000000..d095387ef --- /dev/null +++ b/docs/reference/api/GetScriptLanguagesLanguageContext.md @@ -0,0 +1,6 @@ +## Interface `GetScriptLanguagesLanguageContext` + +| Name | Type | Description | +| - | - | - | +| `contexts` | string[] |   | +| `language` | [ScriptLanguage](./ScriptLanguage.md) |   | diff --git a/docs/reference/api/GetScriptLanguagesRequest.md b/docs/reference/api/GetScriptLanguagesRequest.md new file mode 100644 index 000000000..be4274289 --- /dev/null +++ b/docs/reference/api/GetScriptLanguagesRequest.md @@ -0,0 +1,6 @@ +## Interface `GetScriptLanguagesRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | { [key: string]: any; } | All values in `body` will be added to the request body. | +| `querystring` | { [key: string]: any; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/GetScriptLanguagesResponse.md b/docs/reference/api/GetScriptLanguagesResponse.md new file mode 100644 index 000000000..dc9cd60c7 --- /dev/null +++ b/docs/reference/api/GetScriptLanguagesResponse.md @@ -0,0 +1,6 @@ +## Interface `GetScriptLanguagesResponse` + +| Name | Type | Description | +| - | - | - | +| `language_contexts` | [GetScriptLanguagesLanguageContext](./GetScriptLanguagesLanguageContext.md)[] |   | +| `types_allowed` | string[] |   | diff --git a/docs/reference/api/GetScriptRequest.md b/docs/reference/api/GetScriptRequest.md new file mode 100644 index 000000000..1a800538d --- /dev/null +++ b/docs/reference/api/GetScriptRequest.md @@ -0,0 +1,8 @@ +## Interface `GetScriptRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { id?: never; master_timeout?: never; }) | All values in `body` will be added to the request body. | +| `id` | [Id](./Id.md) | The identifier for the stored script or search template. | +| `master_timeout` | [Duration](./Duration.md) | The period to wait for the master node. If the master node is not available before the timeout expires, the request fails and returns an error. It can also be set to `-1` to indicate that the request should never timeout. | +| `querystring` | { [key: string]: any; } & { id?: never; master_timeout?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/GetScriptResponse.md b/docs/reference/api/GetScriptResponse.md new file mode 100644 index 000000000..39aa9825f --- /dev/null +++ b/docs/reference/api/GetScriptResponse.md @@ -0,0 +1,7 @@ +## Interface `GetScriptResponse` + +| Name | Type | Description | +| - | - | - | +| `_id` | [Id](./Id.md) |   | +| `found` | boolean |   | +| `script` | [StoredScript](./StoredScript.md) |   | diff --git a/docs/reference/api/GetSourceApi_1.md b/docs/reference/api/GetSourceApi_1.md new file mode 100644 index 000000000..e2446711c --- /dev/null +++ b/docs/reference/api/GetSourceApi_1.md @@ -0,0 +1,3 @@ +::: +default function GetSourceApi(this: [That](./That.md), params: [GetSourceRequest](./GetSourceRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[GetSourceResponse](./GetSourceResponse.md)>; +::: diff --git a/docs/reference/api/GetSourceApi_2.md b/docs/reference/api/GetSourceApi_2.md new file mode 100644 index 000000000..afd005bb6 --- /dev/null +++ b/docs/reference/api/GetSourceApi_2.md @@ -0,0 +1,3 @@ +::: +default function GetSourceApi(this: [That](./That.md), params: [GetSourceRequest](./GetSourceRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[GetSourceResponse](./GetSourceResponse.md), unknown>>; +::: diff --git a/docs/reference/api/GetSourceApi_3.md b/docs/reference/api/GetSourceApi_3.md new file mode 100644 index 000000000..8e1de9878 --- /dev/null +++ b/docs/reference/api/GetSourceApi_3.md @@ -0,0 +1,3 @@ +::: +default function GetSourceApi(this: [That](./That.md), params: [GetSourceRequest](./GetSourceRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[GetSourceResponse](./GetSourceResponse.md)>; +::: diff --git a/docs/reference/api/GetSourceRequest.md b/docs/reference/api/GetSourceRequest.md new file mode 100644 index 000000000..6f91363e7 --- /dev/null +++ b/docs/reference/api/GetSourceRequest.md @@ -0,0 +1,18 @@ +## Interface `GetSourceRequest` + +| Name | Type | Description | +| - | - | - | +| `_source_excludes` | [Fields](./Fields.md) | A comma-separated list of source fields to exclude in the response. | +| `_source_includes` | [Fields](./Fields.md) | A comma-separated list of source fields to include in the response. | +| `_source` | [SearchSourceConfigParam](./SearchSourceConfigParam.md) | Indicates whether to return the `_source` field ( `true` or `false`) or lists the fields to return. | +| `body` | string | ({ [key: string]: any; } & { id?: never; index?: never; preference?: never; realtime?: never; refresh?: never; routing?: never; _source?: never; _source_excludes?: never; _source_includes?: never; stored_fields?: never; version?: never; version_type?: never; }) | All values in `body` will be added to the request body. | +| `id` | [Id](./Id.md) | A unique document identifier. | +| `index` | [IndexName](./IndexName.md) | The name of the index that contains the document. | +| `preference` | string | The node or shard the operation should be performed on. By default, the operation is randomized between the shard replicas. | +| `querystring` | { [key: string]: any; } & { id?: never; index?: never; preference?: never; realtime?: never; refresh?: never; routing?: never; _source?: never; _source_excludes?: never; _source_includes?: never; stored_fields?: never; version?: never; version_type?: never; } | All values in `querystring` will be added to the request querystring. | +| `realtime` | boolean | If `true`, the request is real-time as opposed to near-real-time. | +| `refresh` | boolean | If `true`, the request refreshes the relevant shards before retrieving the document. Setting it to `true` should be done after careful thought and verification that this does not cause a heavy load on the system (and slow down indexing). | +| `routing` | [Routing](./Routing.md) | A custom value used to route operations to a specific shard. | +| `stored_fields` | [Fields](./Fields.md) | A comma-separated list of stored fields to return as part of a hit. | +| `version_type` | [VersionType](./VersionType.md) | The version type. | +| `version` | [VersionNumber](./VersionNumber.md) | The version number for concurrency control. It must match the current version of the document for the request to succeed. | diff --git a/docs/reference/api/GetSourceResponse.md b/docs/reference/api/GetSourceResponse.md new file mode 100644 index 000000000..c8483ae61 --- /dev/null +++ b/docs/reference/api/GetSourceResponse.md @@ -0,0 +1,4 @@ +## `GetSourceResponse` +::: +type GetSourceResponse = TDocument; +::: diff --git a/docs/reference/api/GetStats.md b/docs/reference/api/GetStats.md new file mode 100644 index 000000000..25315aaec --- /dev/null +++ b/docs/reference/api/GetStats.md @@ -0,0 +1,14 @@ +## Interface `GetStats` + +| Name | Type | Description | +| - | - | - | +| `current` | [long](./long.md) |   | +| `exists_time_in_millis` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> |   | +| `exists_time` | [Duration](./Duration.md) |   | +| `exists_total` | [long](./long.md) |   | +| `missing_time_in_millis` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> |   | +| `missing_time` | [Duration](./Duration.md) |   | +| `missing_total` | [long](./long.md) |   | +| `time_in_millis` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> |   | +| `time` | [Duration](./Duration.md) |   | +| `total` | [long](./long.md) |   | diff --git a/docs/reference/api/Graph.md b/docs/reference/api/Graph.md new file mode 100644 index 000000000..060841fa4 --- /dev/null +++ b/docs/reference/api/Graph.md @@ -0,0 +1,20 @@ +## `Graph` + +### Constructor + +::: +new Graph(transport: [Transport](./Transport.md)); +::: + +### Properties + +| Name | Type | Description | +| - | - | - | +| `acceptedParams` | Record |   | +| `transport` | [Transport](./Transport.md) |   | + +### Methods + +| Name | Signature | Description | +| - | - | - | +| `explore` | `explore(this: [That](./That.md), params: [GraphExploreRequest](./GraphExploreRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[GraphExploreResponse](./GraphExploreResponse.md)>;` | Explore graph analytics. Extract and summarize information about the documents and terms in an Elasticsearch data stream or index. The easiest way to understand the behavior of this API is to use the Graph UI to explore connections. An initial request to the `_explore` API contains a seed query that identifies the documents of interest and specifies the fields that define the vertices and connections you want to include in the graph. Subsequent requests enable you to spider out from one more vertices of interest. You can exclude vertices that have already been returned. || `explore` | `explore(this: [That](./That.md), params: [GraphExploreRequest](./GraphExploreRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[GraphExploreResponse](./GraphExploreResponse.md), unknown>>;` |   || `explore` | `explore(this: [That](./That.md), params: [GraphExploreRequest](./GraphExploreRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[GraphExploreResponse](./GraphExploreResponse.md)>;` |   | \ No newline at end of file diff --git a/docs/reference/api/GraphConnection.md b/docs/reference/api/GraphConnection.md new file mode 100644 index 000000000..9a39f0f8b --- /dev/null +++ b/docs/reference/api/GraphConnection.md @@ -0,0 +1,8 @@ +## Interface `GraphConnection` + +| Name | Type | Description | +| - | - | - | +| `doc_count` | [long](./long.md) |   | +| `source` | [long](./long.md) |   | +| `target` | [long](./long.md) |   | +| `weight` | [double](./double.md) |   | diff --git a/docs/reference/api/GraphExploreControls.md b/docs/reference/api/GraphExploreControls.md new file mode 100644 index 000000000..9bfe85cb7 --- /dev/null +++ b/docs/reference/api/GraphExploreControls.md @@ -0,0 +1,8 @@ +## Interface `GraphExploreControls` + +| Name | Type | Description | +| - | - | - | +| `sample_diversity` | [GraphSampleDiversity](./GraphSampleDiversity.md) | To avoid the top-matching documents sample being dominated by a single source of results, it is sometimes necessary to request diversity in the sample. You can do this by selecting a single-value field and setting a maximum number of documents per value for that field. | +| `sample_size` | [integer](./integer.md) | Each hop considers a sample of the best-matching documents on each shard. Using samples improves the speed of execution and keeps exploration focused on meaningfully-connected terms. Very small values (less than 50) might not provide sufficient weight-of-evidence to identify significant connections between terms. Very large sample sizes can dilute the quality of the results and increase execution times. | +| `timeout` | [Duration](./Duration.md) | The length of time in milliseconds after which exploration will be halted and the results gathered so far are returned. This timeout is honored on a best-effort basis. Execution might overrun this timeout if, for example, a long pause is encountered while FieldData is loaded for a field. | +| `use_significance` | boolean | Filters associated terms so only those that are significantly associated with your query are included. | diff --git a/docs/reference/api/GraphExploreRequest.md b/docs/reference/api/GraphExploreRequest.md new file mode 100644 index 000000000..470a64f8e --- /dev/null +++ b/docs/reference/api/GraphExploreRequest.md @@ -0,0 +1,13 @@ +## Interface `GraphExploreRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { index?: never; routing?: never; timeout?: never; connections?: never; controls?: never; query?: never; vertices?: never; }) | All values in `body` will be added to the request body. | +| `connections` | [GraphHop](./GraphHop.md) | Specifies or more fields from which you want to extract terms that are associated with the specified vertices. | +| `controls` | [GraphExploreControls](./GraphExploreControls.md) | Direct the Graph API how to build the graph. | +| `index` | [Indices](./Indices.md) | Name of the index. | +| `query` | [QueryDslQueryContainer](./QueryDslQueryContainer.md) | A seed query that identifies the documents of interest. Can be any valid Elasticsearch query. | +| `querystring` | { [key: string]: any; } & { index?: never; routing?: never; timeout?: never; connections?: never; controls?: never; query?: never; vertices?: never; } | All values in `querystring` will be added to the request querystring. | +| `routing` | [Routing](./Routing.md) | Custom value used to route operations to a specific shard. | +| `timeout` | [Duration](./Duration.md) | Specifies the period of time to wait for a response from each shard. If no response is received before the timeout expires, the request fails and returns an error. Defaults to no timeout. | +| `vertices` | [GraphVertexDefinition](./GraphVertexDefinition.md)[] | Specifies one or more fields that contain the terms you want to include in the graph as vertices. | diff --git a/docs/reference/api/GraphExploreResponse.md b/docs/reference/api/GraphExploreResponse.md new file mode 100644 index 000000000..b4841d63b --- /dev/null +++ b/docs/reference/api/GraphExploreResponse.md @@ -0,0 +1,9 @@ +## Interface `GraphExploreResponse` + +| Name | Type | Description | +| - | - | - | +| `connections` | [GraphConnection](./GraphConnection.md)[] |   | +| `failures` | [ShardFailure](./ShardFailure.md)[] |   | +| `timed_out` | boolean |   | +| `took` | [long](./long.md) |   | +| `vertices` | [GraphVertex](./GraphVertex.md)[] |   | diff --git a/docs/reference/api/GraphHop.md b/docs/reference/api/GraphHop.md new file mode 100644 index 000000000..d4a411473 --- /dev/null +++ b/docs/reference/api/GraphHop.md @@ -0,0 +1,7 @@ +## Interface `GraphHop` + +| Name | Type | Description | +| - | - | - | +| `connections` | [GraphHop](./GraphHop.md) | Specifies one or more fields from which you want to extract terms that are associated with the specified vertices. | +| `query` | [QueryDslQueryContainer](./QueryDslQueryContainer.md) | An optional guiding query that constrains the Graph API as it explores connected terms. | +| `vertices` | [GraphVertexDefinition](./GraphVertexDefinition.md)[] | Contains the fields you are interested in. | diff --git a/docs/reference/api/GraphSampleDiversity.md b/docs/reference/api/GraphSampleDiversity.md new file mode 100644 index 000000000..b2925007b --- /dev/null +++ b/docs/reference/api/GraphSampleDiversity.md @@ -0,0 +1,6 @@ +## Interface `GraphSampleDiversity` + +| Name | Type | Description | +| - | - | - | +| `field` | [Field](./Field.md) |   | +| `max_docs_per_value` | [integer](./integer.md) |   | diff --git a/docs/reference/api/GraphVertex.md b/docs/reference/api/GraphVertex.md new file mode 100644 index 000000000..052cf3ec4 --- /dev/null +++ b/docs/reference/api/GraphVertex.md @@ -0,0 +1,8 @@ +## Interface `GraphVertex` + +| Name | Type | Description | +| - | - | - | +| `depth` | [long](./long.md) |   | +| `field` | [Field](./Field.md) |   | +| `term` | string |   | +| `weight` | [double](./double.md) |   | diff --git a/docs/reference/api/GraphVertexDefinition.md b/docs/reference/api/GraphVertexDefinition.md new file mode 100644 index 000000000..a8a445fa1 --- /dev/null +++ b/docs/reference/api/GraphVertexDefinition.md @@ -0,0 +1,10 @@ +## Interface `GraphVertexDefinition` + +| Name | Type | Description | +| - | - | - | +| `exclude` | string[] | Prevents the specified terms from being included in the results. | +| `field` | [Field](./Field.md) | Identifies a field in the documents of interest. | +| `include` | ([GraphVertexInclude](./GraphVertexInclude.md) | string)[] | Identifies the terms of interest that form the starting points from which you want to spider out. | +| `min_doc_count` | [long](./long.md) | Specifies how many documents must contain a pair of terms before it is considered to be a useful connection. This setting acts as a certainty threshold. | +| `shard_min_doc_count` | [long](./long.md) | Controls how many documents on a particular shard have to contain a pair of terms before the connection is returned for global consideration. | +| `size` | [integer](./integer.md) | Specifies the maximum number of vertex terms returned for each field. | diff --git a/docs/reference/api/GraphVertexInclude.md b/docs/reference/api/GraphVertexInclude.md new file mode 100644 index 000000000..23fedcf04 --- /dev/null +++ b/docs/reference/api/GraphVertexInclude.md @@ -0,0 +1,6 @@ +## Interface `GraphVertexInclude` + +| Name | Type | Description | +| - | - | - | +| `boost` | [double](./double.md) |   | +| `term` | string |   | diff --git a/docs/reference/api/GrokPattern.md b/docs/reference/api/GrokPattern.md new file mode 100644 index 000000000..4d4372e3d --- /dev/null +++ b/docs/reference/api/GrokPattern.md @@ -0,0 +1,4 @@ +## `GrokPattern` +::: +type GrokPattern = string; +::: diff --git a/docs/reference/api/HealthReportApi_1.md b/docs/reference/api/HealthReportApi_1.md new file mode 100644 index 000000000..8a6d04c53 --- /dev/null +++ b/docs/reference/api/HealthReportApi_1.md @@ -0,0 +1,3 @@ +::: +default function HealthReportApi(this: [That](./That.md), params?: [HealthReportRequest](./HealthReportRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[HealthReportResponse](./HealthReportResponse.md)>; +::: diff --git a/docs/reference/api/HealthReportApi_2.md b/docs/reference/api/HealthReportApi_2.md new file mode 100644 index 000000000..0cf714790 --- /dev/null +++ b/docs/reference/api/HealthReportApi_2.md @@ -0,0 +1,3 @@ +::: +default function HealthReportApi(this: [That](./That.md), params?: [HealthReportRequest](./HealthReportRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[HealthReportResponse](./HealthReportResponse.md), unknown>>; +::: diff --git a/docs/reference/api/HealthReportApi_3.md b/docs/reference/api/HealthReportApi_3.md new file mode 100644 index 000000000..2feb8c759 --- /dev/null +++ b/docs/reference/api/HealthReportApi_3.md @@ -0,0 +1,3 @@ +::: +default function HealthReportApi(this: [That](./That.md), params?: [HealthReportRequest](./HealthReportRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[HealthReportResponse](./HealthReportResponse.md)>; +::: diff --git a/docs/reference/api/HealthReportBaseIndicator.md b/docs/reference/api/HealthReportBaseIndicator.md new file mode 100644 index 000000000..b26cdc79d --- /dev/null +++ b/docs/reference/api/HealthReportBaseIndicator.md @@ -0,0 +1,8 @@ +## Interface `HealthReportBaseIndicator` + +| Name | Type | Description | +| - | - | - | +| `diagnosis` | [HealthReportDiagnosis](./HealthReportDiagnosis.md)[] |   | +| `impacts` | [HealthReportImpact](./HealthReportImpact.md)[] |   | +| `status` | [HealthReportIndicatorHealthStatus](./HealthReportIndicatorHealthStatus.md) |   | +| `symptom` | string |   | diff --git a/docs/reference/api/HealthReportDataStreamLifecycleDetails.md b/docs/reference/api/HealthReportDataStreamLifecycleDetails.md new file mode 100644 index 000000000..83f02460b --- /dev/null +++ b/docs/reference/api/HealthReportDataStreamLifecycleDetails.md @@ -0,0 +1,7 @@ +## Interface `HealthReportDataStreamLifecycleDetails` + +| Name | Type | Description | +| - | - | - | +| `stagnating_backing_indices_count` | [integer](./integer.md) |   | +| `stagnating_backing_indices` | [HealthReportStagnatingBackingIndices](./HealthReportStagnatingBackingIndices.md)[] |   | +| `total_backing_indices_in_error` | [integer](./integer.md) |   | diff --git a/docs/reference/api/HealthReportDataStreamLifecycleIndicator.md b/docs/reference/api/HealthReportDataStreamLifecycleIndicator.md new file mode 100644 index 000000000..816b90248 --- /dev/null +++ b/docs/reference/api/HealthReportDataStreamLifecycleIndicator.md @@ -0,0 +1,5 @@ +## Interface `HealthReportDataStreamLifecycleIndicator` + +| Name | Type | Description | +| - | - | - | +| `details` | [HealthReportDataStreamLifecycleDetails](./HealthReportDataStreamLifecycleDetails.md) |   | diff --git a/docs/reference/api/HealthReportDiagnosis.md b/docs/reference/api/HealthReportDiagnosis.md new file mode 100644 index 000000000..f3781003a --- /dev/null +++ b/docs/reference/api/HealthReportDiagnosis.md @@ -0,0 +1,9 @@ +## Interface `HealthReportDiagnosis` + +| Name | Type | Description | +| - | - | - | +| `action` | string |   | +| `affected_resources` | [HealthReportDiagnosisAffectedResources](./HealthReportDiagnosisAffectedResources.md) |   | +| `cause` | string |   | +| `help_url` | string |   | +| `id` | string |   | diff --git a/docs/reference/api/HealthReportDiagnosisAffectedResources.md b/docs/reference/api/HealthReportDiagnosisAffectedResources.md new file mode 100644 index 000000000..937c01513 --- /dev/null +++ b/docs/reference/api/HealthReportDiagnosisAffectedResources.md @@ -0,0 +1,9 @@ +## Interface `HealthReportDiagnosisAffectedResources` + +| Name | Type | Description | +| - | - | - | +| `feature_states` | string[] |   | +| `indices` | [Indices](./Indices.md) |   | +| `nodes` | [HealthReportIndicatorNode](./HealthReportIndicatorNode.md)[] |   | +| `slm_policies` | string[] |   | +| `snapshot_repositories` | string[] |   | diff --git a/docs/reference/api/HealthReportDiskIndicator.md b/docs/reference/api/HealthReportDiskIndicator.md new file mode 100644 index 000000000..78751bf6d --- /dev/null +++ b/docs/reference/api/HealthReportDiskIndicator.md @@ -0,0 +1,5 @@ +## Interface `HealthReportDiskIndicator` + +| Name | Type | Description | +| - | - | - | +| `details` | [HealthReportDiskIndicatorDetails](./HealthReportDiskIndicatorDetails.md) |   | diff --git a/docs/reference/api/HealthReportDiskIndicatorDetails.md b/docs/reference/api/HealthReportDiskIndicatorDetails.md new file mode 100644 index 000000000..e9aa0d896 --- /dev/null +++ b/docs/reference/api/HealthReportDiskIndicatorDetails.md @@ -0,0 +1,9 @@ +## Interface `HealthReportDiskIndicatorDetails` + +| Name | Type | Description | +| - | - | - | +| `indices_with_readonly_block` | [long](./long.md) |   | +| `nodes_over_flood_stage_watermark` | [long](./long.md) |   | +| `nodes_over_high_watermark` | [long](./long.md) |   | +| `nodes_with_enough_disk_space` | [long](./long.md) |   | +| `nodes_with_unknown_disk_status` | [long](./long.md) |   | diff --git a/docs/reference/api/HealthReportFileSettingsIndicator.md b/docs/reference/api/HealthReportFileSettingsIndicator.md new file mode 100644 index 000000000..0c1bd1be0 --- /dev/null +++ b/docs/reference/api/HealthReportFileSettingsIndicator.md @@ -0,0 +1,5 @@ +## Interface `HealthReportFileSettingsIndicator` + +| Name | Type | Description | +| - | - | - | +| `details` | [HealthReportFileSettingsIndicatorDetails](./HealthReportFileSettingsIndicatorDetails.md) |   | diff --git a/docs/reference/api/HealthReportFileSettingsIndicatorDetails.md b/docs/reference/api/HealthReportFileSettingsIndicatorDetails.md new file mode 100644 index 000000000..7e4d05abe --- /dev/null +++ b/docs/reference/api/HealthReportFileSettingsIndicatorDetails.md @@ -0,0 +1,6 @@ +## Interface `HealthReportFileSettingsIndicatorDetails` + +| Name | Type | Description | +| - | - | - | +| `failure_streak` | [long](./long.md) |   | +| `most_recent_failure` | string |   | diff --git a/docs/reference/api/HealthReportIlmIndicator.md b/docs/reference/api/HealthReportIlmIndicator.md new file mode 100644 index 000000000..ad55add54 --- /dev/null +++ b/docs/reference/api/HealthReportIlmIndicator.md @@ -0,0 +1,5 @@ +## Interface `HealthReportIlmIndicator` + +| Name | Type | Description | +| - | - | - | +| `details` | [HealthReportIlmIndicatorDetails](./HealthReportIlmIndicatorDetails.md) |   | diff --git a/docs/reference/api/HealthReportIlmIndicatorDetails.md b/docs/reference/api/HealthReportIlmIndicatorDetails.md new file mode 100644 index 000000000..048780330 --- /dev/null +++ b/docs/reference/api/HealthReportIlmIndicatorDetails.md @@ -0,0 +1,7 @@ +## Interface `HealthReportIlmIndicatorDetails` + +| Name | Type | Description | +| - | - | - | +| `ilm_status` | [LifecycleOperationMode](./LifecycleOperationMode.md) |   | +| `policies` | [long](./long.md) |   | +| `stagnating_indices` | [integer](./integer.md) |   | diff --git a/docs/reference/api/HealthReportImpact.md b/docs/reference/api/HealthReportImpact.md new file mode 100644 index 000000000..6a3b0469f --- /dev/null +++ b/docs/reference/api/HealthReportImpact.md @@ -0,0 +1,8 @@ +## Interface `HealthReportImpact` + +| Name | Type | Description | +| - | - | - | +| `description` | string |   | +| `id` | string |   | +| `impact_areas` | [HealthReportImpactArea](./HealthReportImpactArea.md)[] |   | +| `severity` | [integer](./integer.md) |   | diff --git a/docs/reference/api/HealthReportImpactArea.md b/docs/reference/api/HealthReportImpactArea.md new file mode 100644 index 000000000..e04bf08da --- /dev/null +++ b/docs/reference/api/HealthReportImpactArea.md @@ -0,0 +1,4 @@ +## `HealthReportImpactArea` +::: +type HealthReportImpactArea = 'search' | 'ingest' | 'backup' | 'deployment_management'; +::: diff --git a/docs/reference/api/HealthReportIndicatorHealthStatus.md b/docs/reference/api/HealthReportIndicatorHealthStatus.md new file mode 100644 index 000000000..3c872bf50 --- /dev/null +++ b/docs/reference/api/HealthReportIndicatorHealthStatus.md @@ -0,0 +1,4 @@ +## `HealthReportIndicatorHealthStatus` +::: +type HealthReportIndicatorHealthStatus = 'green' | 'yellow' | 'red' | 'unknown'; +::: diff --git a/docs/reference/api/HealthReportIndicatorNode.md b/docs/reference/api/HealthReportIndicatorNode.md new file mode 100644 index 000000000..153aa3d4b --- /dev/null +++ b/docs/reference/api/HealthReportIndicatorNode.md @@ -0,0 +1,6 @@ +## Interface `HealthReportIndicatorNode` + +| Name | Type | Description | +| - | - | - | +| `name` | string | null |   | +| `node_id` | string | null |   | diff --git a/docs/reference/api/HealthReportIndicators.md b/docs/reference/api/HealthReportIndicators.md new file mode 100644 index 000000000..5d4c83233 --- /dev/null +++ b/docs/reference/api/HealthReportIndicators.md @@ -0,0 +1,13 @@ +## Interface `HealthReportIndicators` + +| Name | Type | Description | +| - | - | - | +| `data_stream_lifecycle` | [HealthReportDataStreamLifecycleIndicator](./HealthReportDataStreamLifecycleIndicator.md) |   | +| `disk` | [HealthReportDiskIndicator](./HealthReportDiskIndicator.md) |   | +| `file_settings` | [HealthReportFileSettingsIndicator](./HealthReportFileSettingsIndicator.md) |   | +| `ilm` | [HealthReportIlmIndicator](./HealthReportIlmIndicator.md) |   | +| `master_is_stable` | [HealthReportMasterIsStableIndicator](./HealthReportMasterIsStableIndicator.md) |   | +| `repository_integrity` | [HealthReportRepositoryIntegrityIndicator](./HealthReportRepositoryIntegrityIndicator.md) |   | +| `shards_availability` | [HealthReportShardsAvailabilityIndicator](./HealthReportShardsAvailabilityIndicator.md) |   | +| `shards_capacity` | [HealthReportShardsCapacityIndicator](./HealthReportShardsCapacityIndicator.md) |   | +| `slm` | [HealthReportSlmIndicator](./HealthReportSlmIndicator.md) |   | diff --git a/docs/reference/api/HealthReportMasterIsStableIndicator.md b/docs/reference/api/HealthReportMasterIsStableIndicator.md new file mode 100644 index 000000000..a82d95302 --- /dev/null +++ b/docs/reference/api/HealthReportMasterIsStableIndicator.md @@ -0,0 +1,5 @@ +## Interface `HealthReportMasterIsStableIndicator` + +| Name | Type | Description | +| - | - | - | +| `details` | [HealthReportMasterIsStableIndicatorDetails](./HealthReportMasterIsStableIndicatorDetails.md) |   | diff --git a/docs/reference/api/HealthReportMasterIsStableIndicatorClusterFormationNode.md b/docs/reference/api/HealthReportMasterIsStableIndicatorClusterFormationNode.md new file mode 100644 index 000000000..372e9b456 --- /dev/null +++ b/docs/reference/api/HealthReportMasterIsStableIndicatorClusterFormationNode.md @@ -0,0 +1,7 @@ +## Interface `HealthReportMasterIsStableIndicatorClusterFormationNode` + +| Name | Type | Description | +| - | - | - | +| `cluster_formation_message` | string |   | +| `name` | string |   | +| `node_id` | string |   | diff --git a/docs/reference/api/HealthReportMasterIsStableIndicatorDetails.md b/docs/reference/api/HealthReportMasterIsStableIndicatorDetails.md new file mode 100644 index 000000000..6ca2edada --- /dev/null +++ b/docs/reference/api/HealthReportMasterIsStableIndicatorDetails.md @@ -0,0 +1,8 @@ +## Interface `HealthReportMasterIsStableIndicatorDetails` + +| Name | Type | Description | +| - | - | - | +| `cluster_formation` | [HealthReportMasterIsStableIndicatorClusterFormationNode](./HealthReportMasterIsStableIndicatorClusterFormationNode.md)[] |   | +| `current_master` | [HealthReportIndicatorNode](./HealthReportIndicatorNode.md) |   | +| `exception_fetching_history` | [HealthReportMasterIsStableIndicatorExceptionFetchingHistory](./HealthReportMasterIsStableIndicatorExceptionFetchingHistory.md) |   | +| `recent_masters` | [HealthReportIndicatorNode](./HealthReportIndicatorNode.md)[] |   | diff --git a/docs/reference/api/HealthReportMasterIsStableIndicatorExceptionFetchingHistory.md b/docs/reference/api/HealthReportMasterIsStableIndicatorExceptionFetchingHistory.md new file mode 100644 index 000000000..b83d6214f --- /dev/null +++ b/docs/reference/api/HealthReportMasterIsStableIndicatorExceptionFetchingHistory.md @@ -0,0 +1,6 @@ +## Interface `HealthReportMasterIsStableIndicatorExceptionFetchingHistory` + +| Name | Type | Description | +| - | - | - | +| `message` | string |   | +| `stack_trace` | string |   | diff --git a/docs/reference/api/HealthReportRepositoryIntegrityIndicator.md b/docs/reference/api/HealthReportRepositoryIntegrityIndicator.md new file mode 100644 index 000000000..5e783ac2b --- /dev/null +++ b/docs/reference/api/HealthReportRepositoryIntegrityIndicator.md @@ -0,0 +1,5 @@ +## Interface `HealthReportRepositoryIntegrityIndicator` + +| Name | Type | Description | +| - | - | - | +| `details` | [HealthReportRepositoryIntegrityIndicatorDetails](./HealthReportRepositoryIntegrityIndicatorDetails.md) |   | diff --git a/docs/reference/api/HealthReportRepositoryIntegrityIndicatorDetails.md b/docs/reference/api/HealthReportRepositoryIntegrityIndicatorDetails.md new file mode 100644 index 000000000..9839402e3 --- /dev/null +++ b/docs/reference/api/HealthReportRepositoryIntegrityIndicatorDetails.md @@ -0,0 +1,7 @@ +## Interface `HealthReportRepositoryIntegrityIndicatorDetails` + +| Name | Type | Description | +| - | - | - | +| `corrupted_repositories` | [long](./long.md) |   | +| `corrupted` | string[] |   | +| `total_repositories` | [long](./long.md) |   | diff --git a/docs/reference/api/HealthReportRequest.md b/docs/reference/api/HealthReportRequest.md new file mode 100644 index 000000000..4477ea8a8 --- /dev/null +++ b/docs/reference/api/HealthReportRequest.md @@ -0,0 +1,10 @@ +## Interface `HealthReportRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { feature?: never; timeout?: never; verbose?: never; size?: never; }) | All values in `body` will be added to the request body. | +| `feature` | string | string[] | A feature of the cluster, as returned by the top-level health report API. | +| `querystring` | { [key: string]: any; } & { feature?: never; timeout?: never; verbose?: never; size?: never; } | All values in `querystring` will be added to the request querystring. | +| `size` | [integer](./integer.md) | Limit the number of affected resources the health report API returns. | +| `timeout` | [Duration](./Duration.md) | Explicit operation timeout. | +| `verbose` | boolean | Opt-in for more information about the health of the system. | diff --git a/docs/reference/api/HealthReportResponse.md b/docs/reference/api/HealthReportResponse.md new file mode 100644 index 000000000..95d882828 --- /dev/null +++ b/docs/reference/api/HealthReportResponse.md @@ -0,0 +1,7 @@ +## Interface `HealthReportResponse` + +| Name | Type | Description | +| - | - | - | +| `cluster_name` | string |   | +| `indicators` | [HealthReportIndicators](./HealthReportIndicators.md) |   | +| `status` | [HealthReportIndicatorHealthStatus](./HealthReportIndicatorHealthStatus.md) |   | diff --git a/docs/reference/api/HealthReportShardsAvailabilityIndicator.md b/docs/reference/api/HealthReportShardsAvailabilityIndicator.md new file mode 100644 index 000000000..7f3338c8e --- /dev/null +++ b/docs/reference/api/HealthReportShardsAvailabilityIndicator.md @@ -0,0 +1,5 @@ +## Interface `HealthReportShardsAvailabilityIndicator` + +| Name | Type | Description | +| - | - | - | +| `details` | [HealthReportShardsAvailabilityIndicatorDetails](./HealthReportShardsAvailabilityIndicatorDetails.md) |   | diff --git a/docs/reference/api/HealthReportShardsAvailabilityIndicatorDetails.md b/docs/reference/api/HealthReportShardsAvailabilityIndicatorDetails.md new file mode 100644 index 000000000..5c313923d --- /dev/null +++ b/docs/reference/api/HealthReportShardsAvailabilityIndicatorDetails.md @@ -0,0 +1,14 @@ +## Interface `HealthReportShardsAvailabilityIndicatorDetails` + +| Name | Type | Description | +| - | - | - | +| `creating_primaries` | [long](./long.md) |   | +| `creating_replicas` | [long](./long.md) |   | +| `initializing_primaries` | [long](./long.md) |   | +| `initializing_replicas` | [long](./long.md) |   | +| `restarting_primaries` | [long](./long.md) |   | +| `restarting_replicas` | [long](./long.md) |   | +| `started_primaries` | [long](./long.md) |   | +| `started_replicas` | [long](./long.md) |   | +| `unassigned_primaries` | [long](./long.md) |   | +| `unassigned_replicas` | [long](./long.md) |   | diff --git a/docs/reference/api/HealthReportShardsCapacityIndicator.md b/docs/reference/api/HealthReportShardsCapacityIndicator.md new file mode 100644 index 000000000..4e2391265 --- /dev/null +++ b/docs/reference/api/HealthReportShardsCapacityIndicator.md @@ -0,0 +1,5 @@ +## Interface `HealthReportShardsCapacityIndicator` + +| Name | Type | Description | +| - | - | - | +| `details` | [HealthReportShardsCapacityIndicatorDetails](./HealthReportShardsCapacityIndicatorDetails.md) |   | diff --git a/docs/reference/api/HealthReportShardsCapacityIndicatorDetails.md b/docs/reference/api/HealthReportShardsCapacityIndicatorDetails.md new file mode 100644 index 000000000..5f99cf5ba --- /dev/null +++ b/docs/reference/api/HealthReportShardsCapacityIndicatorDetails.md @@ -0,0 +1,6 @@ +## Interface `HealthReportShardsCapacityIndicatorDetails` + +| Name | Type | Description | +| - | - | - | +| `data` | [HealthReportShardsCapacityIndicatorTierDetail](./HealthReportShardsCapacityIndicatorTierDetail.md) |   | +| `frozen` | [HealthReportShardsCapacityIndicatorTierDetail](./HealthReportShardsCapacityIndicatorTierDetail.md) |   | diff --git a/docs/reference/api/HealthReportShardsCapacityIndicatorTierDetail.md b/docs/reference/api/HealthReportShardsCapacityIndicatorTierDetail.md new file mode 100644 index 000000000..625ad7c65 --- /dev/null +++ b/docs/reference/api/HealthReportShardsCapacityIndicatorTierDetail.md @@ -0,0 +1,6 @@ +## Interface `HealthReportShardsCapacityIndicatorTierDetail` + +| Name | Type | Description | +| - | - | - | +| `current_used_shards` | [integer](./integer.md) |   | +| `max_shards_in_cluster` | [integer](./integer.md) |   | diff --git a/docs/reference/api/HealthReportSlmIndicator.md b/docs/reference/api/HealthReportSlmIndicator.md new file mode 100644 index 000000000..145a3da93 --- /dev/null +++ b/docs/reference/api/HealthReportSlmIndicator.md @@ -0,0 +1,5 @@ +## Interface `HealthReportSlmIndicator` + +| Name | Type | Description | +| - | - | - | +| `details` | [HealthReportSlmIndicatorDetails](./HealthReportSlmIndicatorDetails.md) |   | diff --git a/docs/reference/api/HealthReportSlmIndicatorDetails.md b/docs/reference/api/HealthReportSlmIndicatorDetails.md new file mode 100644 index 000000000..e53bb9722 --- /dev/null +++ b/docs/reference/api/HealthReportSlmIndicatorDetails.md @@ -0,0 +1,7 @@ +## Interface `HealthReportSlmIndicatorDetails` + +| Name | Type | Description | +| - | - | - | +| `policies` | [long](./long.md) |   | +| `slm_status` | [LifecycleOperationMode](./LifecycleOperationMode.md) |   | +| `unhealthy_policies` | [HealthReportSlmIndicatorUnhealthyPolicies](./HealthReportSlmIndicatorUnhealthyPolicies.md) |   | diff --git a/docs/reference/api/HealthReportSlmIndicatorUnhealthyPolicies.md b/docs/reference/api/HealthReportSlmIndicatorUnhealthyPolicies.md new file mode 100644 index 000000000..1b0d08e6e --- /dev/null +++ b/docs/reference/api/HealthReportSlmIndicatorUnhealthyPolicies.md @@ -0,0 +1,6 @@ +## Interface `HealthReportSlmIndicatorUnhealthyPolicies` + +| Name | Type | Description | +| - | - | - | +| `count` | [long](./long.md) |   | +| `invocations_since_last_success` | Record |   | diff --git a/docs/reference/api/HealthReportStagnatingBackingIndices.md b/docs/reference/api/HealthReportStagnatingBackingIndices.md new file mode 100644 index 000000000..1e58996a9 --- /dev/null +++ b/docs/reference/api/HealthReportStagnatingBackingIndices.md @@ -0,0 +1,7 @@ +## Interface `HealthReportStagnatingBackingIndices` + +| Name | Type | Description | +| - | - | - | +| `first_occurrence_timestamp` | [long](./long.md) |   | +| `index_name` | [IndexName](./IndexName.md) |   | +| `retry_count` | [integer](./integer.md) |   | diff --git a/docs/reference/api/HealthStatus.md b/docs/reference/api/HealthStatus.md new file mode 100644 index 000000000..a6adeba68 --- /dev/null +++ b/docs/reference/api/HealthStatus.md @@ -0,0 +1,4 @@ +## `HealthStatus` +::: +type HealthStatus = 'green' | 'GREEN' | 'yellow' | 'YELLOW' | 'red' | 'RED'; +::: diff --git a/docs/reference/api/Helpers.md b/docs/reference/api/Helpers.md new file mode 100644 index 000000000..c14e4e6a8 --- /dev/null +++ b/docs/reference/api/Helpers.md @@ -0,0 +1,18 @@ +## `Helpers` + +### Constructor + +::: +new Helpers(opts: [HelpersOptions](./HelpersOptions.md)); +::: + +### Properties + +| Name | Type | Description | +| - | - | - | + +### Methods + +| Name | Signature | Description | +| - | - | - | +| `bulk` | `bulk(options: [BulkHelperOptions](./BulkHelperOptions.md), reqOptions?: [TransportRequestOptions](./TransportRequestOptions.md)): [BulkHelper](./BulkHelper.md);` | Creates a bulk helper instance. Once you configure it, you can pick which operation to execute with the given dataset, index, create, update, and delete. || `esql` | `esql(params: [EsqlQueryRequest](./EsqlQueryRequest.md), reqOptions?: [TransportRequestOptions](./TransportRequestOptions.md)): [EsqlHelper](./EsqlHelper.md);` | Creates an ES|QL helper instance, to help transform the data returned by an ES|QL query into easy-to-use formats. || `msearch` | `msearch(options?: [MsearchHelperOptions](./MsearchHelperOptions.md), reqOptions?: [TransportRequestOptions](./TransportRequestOptions.md)): [MsearchHelper](./MsearchHelper.md);` | Creates a msearch helper instance. Once you configure it, you can use the provided `search` method to add new searches in the queue. || `scrollDocuments` | `scrollDocuments(params: [SearchRequest](./SearchRequest.md), options?: [ScrollSearchOptions](./ScrollSearchOptions.md)): [AsyncIterable](./AsyncIterable.md);` | Runs a scroll search operation. This function returns an async iterator, allowing the user to use a for await loop to get all the documents of a given search. Each document is what you will find by running a scrollSearch and iterating on the hits array. This helper automatically adds `filter_path=hits.hits._source` to the querystring, as it will only need the documents source. || `scrollSearch` | `scrollSearch(params: [SearchRequest](./SearchRequest.md), options?: [ScrollSearchOptions](./ScrollSearchOptions.md)): [AsyncIterable](./AsyncIterable.md)<[ScrollSearchResponse](./ScrollSearchResponse.md)>;` | Runs a scroll search operation. This function returns an async iterator, allowing the user to use a for await loop to get all the results of a given search. Each result represents the entire body of a single scroll search request, if you just need to scroll the results, use scrollDocuments. This function handles automatically retries on 429 status code. || `search` | `search(params: [SearchRequest](./SearchRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise>;` | Runs a search operation. The only difference between client.search and this utility, is that we are only returning the hits to the user and not the full ES response. This helper automatically adds `filter_path=hits.hits._source` to the querystring, as it will only need the documents source. | \ No newline at end of file diff --git a/docs/reference/api/HelpersOptions.md b/docs/reference/api/HelpersOptions.md new file mode 100644 index 000000000..00b6181b0 --- /dev/null +++ b/docs/reference/api/HelpersOptions.md @@ -0,0 +1,7 @@ +## Interface `HelpersOptions` + +| Name | Type | Description | +| - | - | - | +| `client` | [Client](./Client.md) |   | +| `maxRetries` | number |   | +| `metaHeader` | string | null |   | diff --git a/docs/reference/api/Host.md b/docs/reference/api/Host.md new file mode 100644 index 000000000..a5776edde --- /dev/null +++ b/docs/reference/api/Host.md @@ -0,0 +1,4 @@ +## `Host` +::: +type Host = string; +::: diff --git a/docs/reference/api/HttpHeaders.md b/docs/reference/api/HttpHeaders.md new file mode 100644 index 000000000..61980b450 --- /dev/null +++ b/docs/reference/api/HttpHeaders.md @@ -0,0 +1,4 @@ +## `HttpHeaders` +::: +type HttpHeaders = Record; +::: diff --git a/docs/reference/api/IBDistribution.md b/docs/reference/api/IBDistribution.md new file mode 100644 index 000000000..aee923fe8 --- /dev/null +++ b/docs/reference/api/IBDistribution.md @@ -0,0 +1,4 @@ +## `IBDistribution` +::: +type IBDistribution = 'll' | 'spl'; +::: diff --git a/docs/reference/api/IBLambda.md b/docs/reference/api/IBLambda.md new file mode 100644 index 000000000..acc824309 --- /dev/null +++ b/docs/reference/api/IBLambda.md @@ -0,0 +1,4 @@ +## `IBLambda` +::: +type IBLambda = 'df' | 'ttf'; +::: diff --git a/docs/reference/api/Id.md b/docs/reference/api/Id.md new file mode 100644 index 000000000..403a3d115 --- /dev/null +++ b/docs/reference/api/Id.md @@ -0,0 +1,4 @@ +## `Id` +::: +type Id = string; +::: diff --git a/docs/reference/api/Ids.md b/docs/reference/api/Ids.md new file mode 100644 index 000000000..f623dd0c8 --- /dev/null +++ b/docs/reference/api/Ids.md @@ -0,0 +1,4 @@ +## `Ids` +::: +type Ids = [Id](./Id.md) | [Id](./Id.md)[]; +::: diff --git a/docs/reference/api/Ilm.md b/docs/reference/api/Ilm.md new file mode 100644 index 000000000..86e21e219 --- /dev/null +++ b/docs/reference/api/Ilm.md @@ -0,0 +1,20 @@ +## `Ilm` + +### Constructor + +::: +new Ilm(transport: [Transport](./Transport.md)); +::: + +### Properties + +| Name | Type | Description | +| - | - | - | +| `acceptedParams` | Record |   | +| `transport` | [Transport](./Transport.md) |   | + +### Methods + +| Name | Signature | Description | +| - | - | - | +| `deleteLifecycle` | `deleteLifecycle(this: [That](./That.md), params: [IlmDeleteLifecycleRequest](./IlmDeleteLifecycleRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[IlmDeleteLifecycleResponse](./IlmDeleteLifecycleResponse.md)>;` | Delete a lifecycle policy. You cannot delete policies that are currently in use. If the policy is being used to manage any indices, the request fails and returns an error. || `deleteLifecycle` | `deleteLifecycle(this: [That](./That.md), params: [IlmDeleteLifecycleRequest](./IlmDeleteLifecycleRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[IlmDeleteLifecycleResponse](./IlmDeleteLifecycleResponse.md), unknown>>;` |   || `deleteLifecycle` | `deleteLifecycle(this: [That](./That.md), params: [IlmDeleteLifecycleRequest](./IlmDeleteLifecycleRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[IlmDeleteLifecycleResponse](./IlmDeleteLifecycleResponse.md)>;` |   || `explainLifecycle` | `explainLifecycle(this: [That](./That.md), params: [IlmExplainLifecycleRequest](./IlmExplainLifecycleRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[IlmExplainLifecycleResponse](./IlmExplainLifecycleResponse.md)>;` | Explain the lifecycle state. Get the current lifecycle status for one or more indices. For data streams, the API retrieves the current lifecycle status for the stream's backing indices. The response indicates when the index entered each lifecycle state, provides the definition of the running phase, and information about any failures. || `explainLifecycle` | `explainLifecycle(this: [That](./That.md), params: [IlmExplainLifecycleRequest](./IlmExplainLifecycleRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[IlmExplainLifecycleResponse](./IlmExplainLifecycleResponse.md), unknown>>;` |   || `explainLifecycle` | `explainLifecycle(this: [That](./That.md), params: [IlmExplainLifecycleRequest](./IlmExplainLifecycleRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[IlmExplainLifecycleResponse](./IlmExplainLifecycleResponse.md)>;` |   || `getLifecycle` | `getLifecycle(this: [That](./That.md), params?: [IlmGetLifecycleRequest](./IlmGetLifecycleRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[IlmGetLifecycleResponse](./IlmGetLifecycleResponse.md)>;` | Get lifecycle policies. || `getLifecycle` | `getLifecycle(this: [That](./That.md), params?: [IlmGetLifecycleRequest](./IlmGetLifecycleRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[IlmGetLifecycleResponse](./IlmGetLifecycleResponse.md), unknown>>;` |   || `getLifecycle` | `getLifecycle(this: [That](./That.md), params?: [IlmGetLifecycleRequest](./IlmGetLifecycleRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[IlmGetLifecycleResponse](./IlmGetLifecycleResponse.md)>;` |   || `getStatus` | `getStatus(this: [That](./That.md), params?: [IlmGetStatusRequest](./IlmGetStatusRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[IlmGetStatusResponse](./IlmGetStatusResponse.md)>;` | Get the ILM status. Get the current index lifecycle management status. || `getStatus` | `getStatus(this: [That](./That.md), params?: [IlmGetStatusRequest](./IlmGetStatusRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[IlmGetStatusResponse](./IlmGetStatusResponse.md), unknown>>;` |   || `getStatus` | `getStatus(this: [That](./That.md), params?: [IlmGetStatusRequest](./IlmGetStatusRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[IlmGetStatusResponse](./IlmGetStatusResponse.md)>;` |   || `migrateToDataTiers` | `migrateToDataTiers(this: [That](./That.md), params?: [IlmMigrateToDataTiersRequest](./IlmMigrateToDataTiersRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[IlmMigrateToDataTiersResponse](./IlmMigrateToDataTiersResponse.md)>;` | Migrate to data tiers routing. Switch the indices, ILM policies, and legacy, composable, and component templates from using custom node attributes and attribute-based allocation filters to using data tiers. Optionally, delete one legacy index template. Using node roles enables ILM to automatically move the indices between data tiers. Migrating away from custom node attributes routing can be manually performed. This API provides an automated way of performing three out of the four manual steps listed in the migration guide: 1. Stop setting the custom hot attribute on new indices. 1. Remove custom allocation settings from existing ILM policies. 1. Replace custom allocation settings from existing indices with the corresponding tier preference. ILM must be stopped before performing the migration. Use the stop ILM and get ILM status APIs to wait until the reported operation mode is `STOPPED`. || `migrateToDataTiers` | `migrateToDataTiers(this: [That](./That.md), params?: [IlmMigrateToDataTiersRequest](./IlmMigrateToDataTiersRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[IlmMigrateToDataTiersResponse](./IlmMigrateToDataTiersResponse.md), unknown>>;` |   || `migrateToDataTiers` | `migrateToDataTiers(this: [That](./That.md), params?: [IlmMigrateToDataTiersRequest](./IlmMigrateToDataTiersRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[IlmMigrateToDataTiersResponse](./IlmMigrateToDataTiersResponse.md)>;` |   || `moveToStep` | `moveToStep(this: [That](./That.md), params: [IlmMoveToStepRequest](./IlmMoveToStepRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[IlmMoveToStepResponse](./IlmMoveToStepResponse.md)>;` | Move to a lifecycle step. Manually move an index into a specific step in the lifecycle policy and run that step. WARNING: This operation can result in the loss of data. Manually moving an index into a specific step runs that step even if it has already been performed. This is a potentially destructive action and this should be considered an expert level API. You must specify both the current step and the step to be executed in the body of the request. The request will fail if the current step does not match the step currently running for the index This is to prevent the index from being moved from an unexpected step into the next step. When specifying the target ( `next_step`) to which the index will be moved, either the name or both the action and name fields are optional. If only the phase is specified, the index will move to the first step of the first action in the target phase. If the phase and action are specified, the index will move to the first step of the specified action in the specified phase. Only actions specified in the ILM policy are considered valid. An index cannot move to a step that is not part of its policy. || `moveToStep` | `moveToStep(this: [That](./That.md), params: [IlmMoveToStepRequest](./IlmMoveToStepRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[IlmMoveToStepResponse](./IlmMoveToStepResponse.md), unknown>>;` |   || `moveToStep` | `moveToStep(this: [That](./That.md), params: [IlmMoveToStepRequest](./IlmMoveToStepRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[IlmMoveToStepResponse](./IlmMoveToStepResponse.md)>;` |   || `putLifecycle` | `putLifecycle(this: [That](./That.md), params: [IlmPutLifecycleRequest](./IlmPutLifecycleRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[IlmPutLifecycleResponse](./IlmPutLifecycleResponse.md)>;` | Create or update a lifecycle policy. If the specified policy exists, it is replaced and the policy version is incremented. NOTE: Only the latest version of the policy is stored, you cannot revert to previous versions. || `putLifecycle` | `putLifecycle(this: [That](./That.md), params: [IlmPutLifecycleRequest](./IlmPutLifecycleRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[IlmPutLifecycleResponse](./IlmPutLifecycleResponse.md), unknown>>;` |   || `putLifecycle` | `putLifecycle(this: [That](./That.md), params: [IlmPutLifecycleRequest](./IlmPutLifecycleRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[IlmPutLifecycleResponse](./IlmPutLifecycleResponse.md)>;` |   || `removePolicy` | `removePolicy(this: [That](./That.md), params: [IlmRemovePolicyRequest](./IlmRemovePolicyRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[IlmRemovePolicyResponse](./IlmRemovePolicyResponse.md)>;` | Remove policies from an index. Remove the assigned lifecycle policies from an index or a data stream's backing indices. It also stops managing the indices. || `removePolicy` | `removePolicy(this: [That](./That.md), params: [IlmRemovePolicyRequest](./IlmRemovePolicyRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[IlmRemovePolicyResponse](./IlmRemovePolicyResponse.md), unknown>>;` |   || `removePolicy` | `removePolicy(this: [That](./That.md), params: [IlmRemovePolicyRequest](./IlmRemovePolicyRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[IlmRemovePolicyResponse](./IlmRemovePolicyResponse.md)>;` |   || `retry` | `retry(this: [That](./That.md), params: [IlmRetryRequest](./IlmRetryRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[IlmRetryResponse](./IlmRetryResponse.md)>;` | Retry a policy. Retry running the lifecycle policy for an index that is in the ERROR step. The API sets the policy back to the step where the error occurred and runs the step. Use the explain lifecycle state API to determine whether an index is in the ERROR step. || `retry` | `retry(this: [That](./That.md), params: [IlmRetryRequest](./IlmRetryRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[IlmRetryResponse](./IlmRetryResponse.md), unknown>>;` |   || `retry` | `retry(this: [That](./That.md), params: [IlmRetryRequest](./IlmRetryRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[IlmRetryResponse](./IlmRetryResponse.md)>;` |   || `start` | `start(this: [That](./That.md), params?: [IlmStartRequest](./IlmStartRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[IlmStartResponse](./IlmStartResponse.md)>;` | Start the ILM plugin. Start the index lifecycle management plugin if it is currently stopped. ILM is started automatically when the cluster is formed. Restarting ILM is necessary only when it has been stopped using the stop ILM API. || `start` | `start(this: [That](./That.md), params?: [IlmStartRequest](./IlmStartRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[IlmStartResponse](./IlmStartResponse.md), unknown>>;` |   || `start` | `start(this: [That](./That.md), params?: [IlmStartRequest](./IlmStartRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[IlmStartResponse](./IlmStartResponse.md)>;` |   || `stop` | `stop(this: [That](./That.md), params?: [IlmStopRequest](./IlmStopRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[IlmStopResponse](./IlmStopResponse.md)>;` | Stop the ILM plugin. Halt all lifecycle management operations and stop the index lifecycle management plugin. This is useful when you are performing maintenance on the cluster and need to prevent ILM from performing any actions on your indices. The API returns as soon as the stop request has been acknowledged, but the plugin might continue to run until in-progress operations complete and the plugin can be safely stopped. Use the get ILM status API to check whether ILM is running. || `stop` | `stop(this: [That](./That.md), params?: [IlmStopRequest](./IlmStopRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[IlmStopResponse](./IlmStopResponse.md), unknown>>;` |   || `stop` | `stop(this: [That](./That.md), params?: [IlmStopRequest](./IlmStopRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[IlmStopResponse](./IlmStopResponse.md)>;` |   | \ No newline at end of file diff --git a/docs/reference/api/IlmActions.md b/docs/reference/api/IlmActions.md new file mode 100644 index 000000000..eee25490d --- /dev/null +++ b/docs/reference/api/IlmActions.md @@ -0,0 +1,17 @@ +## Interface `IlmActions` + +| Name | Type | Description | +| - | - | - | +| `allocate` | [IlmAllocateAction](./IlmAllocateAction.md) | Phases allowed: warm, cold. | +| `delete` | [IlmDeleteAction](./IlmDeleteAction.md) | Phases allowed: delete. | +| `downsample` | [IlmDownsampleAction](./IlmDownsampleAction.md) | Phases allowed: hot, warm, cold. | +| `forcemerge` | [IlmForceMergeAction](./IlmForceMergeAction.md) | Phases allowed: hot, warm. | +| `freeze` | [EmptyObject](./EmptyObject.md) | The freeze action is a noop in 8.x | +| `migrate` | [IlmMigrateAction](./IlmMigrateAction.md) | Phases allowed: warm, cold. | +| `readonly` | [EmptyObject](./EmptyObject.md) | Phases allowed: hot, warm, cold. | +| `rollover` | [IlmRolloverAction](./IlmRolloverAction.md) | Phases allowed: hot. | +| `searchable_snapshot` | [IlmSearchableSnapshotAction](./IlmSearchableSnapshotAction.md) | Phases allowed: hot, cold, frozen. | +| `set_priority` | [IlmSetPriorityAction](./IlmSetPriorityAction.md) | Phases allowed: hot, warm, cold. | +| `shrink` | [IlmShrinkAction](./IlmShrinkAction.md) | Phases allowed: hot, warm. | +| `unfollow` | [EmptyObject](./EmptyObject.md) | Phases allowed: hot, warm, cold, frozen. | +| `wait_for_snapshot` | [IlmWaitForSnapshotAction](./IlmWaitForSnapshotAction.md) | Phases allowed: delete. | diff --git a/docs/reference/api/IlmAllocateAction.md b/docs/reference/api/IlmAllocateAction.md new file mode 100644 index 000000000..8ef0c5772 --- /dev/null +++ b/docs/reference/api/IlmAllocateAction.md @@ -0,0 +1,9 @@ +## Interface `IlmAllocateAction` + +| Name | Type | Description | +| - | - | - | +| `exclude` | Record |   | +| `include` | Record |   | +| `number_of_replicas` | [integer](./integer.md) |   | +| `require` | Record |   | +| `total_shards_per_node` | [integer](./integer.md) |   | diff --git a/docs/reference/api/IlmDeleteAction.md b/docs/reference/api/IlmDeleteAction.md new file mode 100644 index 000000000..ec10bc61d --- /dev/null +++ b/docs/reference/api/IlmDeleteAction.md @@ -0,0 +1,5 @@ +## Interface `IlmDeleteAction` + +| Name | Type | Description | +| - | - | - | +| `delete_searchable_snapshot` | boolean |   | diff --git a/docs/reference/api/IlmDeleteLifecycleRequest.md b/docs/reference/api/IlmDeleteLifecycleRequest.md new file mode 100644 index 000000000..9c1948ebb --- /dev/null +++ b/docs/reference/api/IlmDeleteLifecycleRequest.md @@ -0,0 +1,9 @@ +## Interface `IlmDeleteLifecycleRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { name?: never; master_timeout?: never; timeout?: never; }) | All values in `body` will be added to the request body. | +| `master_timeout` | [Duration](./Duration.md) | Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. | +| `name` | [Name](./Name.md) | Identifier for the policy. | +| `querystring` | { [key: string]: any; } & { name?: never; master_timeout?: never; timeout?: never; } | All values in `querystring` will be added to the request querystring. | +| `timeout` | [Duration](./Duration.md) | Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. | diff --git a/docs/reference/api/IlmDeleteLifecycleResponse.md b/docs/reference/api/IlmDeleteLifecycleResponse.md new file mode 100644 index 000000000..6bfaf84d1 --- /dev/null +++ b/docs/reference/api/IlmDeleteLifecycleResponse.md @@ -0,0 +1,4 @@ +## `IlmDeleteLifecycleResponse` +::: +type IlmDeleteLifecycleResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); +::: diff --git a/docs/reference/api/IlmDownsampleAction.md b/docs/reference/api/IlmDownsampleAction.md new file mode 100644 index 000000000..1e850d8e5 --- /dev/null +++ b/docs/reference/api/IlmDownsampleAction.md @@ -0,0 +1,6 @@ +## Interface `IlmDownsampleAction` + +| Name | Type | Description | +| - | - | - | +| `fixed_interval` | [DurationLarge](./DurationLarge.md) |   | +| `wait_timeout` | [Duration](./Duration.md) |   | diff --git a/docs/reference/api/IlmExplainLifecycleLifecycleExplain.md b/docs/reference/api/IlmExplainLifecycleLifecycleExplain.md new file mode 100644 index 000000000..5beb9ddd5 --- /dev/null +++ b/docs/reference/api/IlmExplainLifecycleLifecycleExplain.md @@ -0,0 +1,4 @@ +## `IlmExplainLifecycleLifecycleExplain` +::: +type IlmExplainLifecycleLifecycleExplain = [IlmExplainLifecycleLifecycleExplainManaged](./IlmExplainLifecycleLifecycleExplainManaged.md) | [IlmExplainLifecycleLifecycleExplainUnmanaged](./IlmExplainLifecycleLifecycleExplainUnmanaged.md); +::: diff --git a/docs/reference/api/IlmExplainLifecycleLifecycleExplainManaged.md b/docs/reference/api/IlmExplainLifecycleLifecycleExplainManaged.md new file mode 100644 index 000000000..4d374d317 --- /dev/null +++ b/docs/reference/api/IlmExplainLifecycleLifecycleExplainManaged.md @@ -0,0 +1,31 @@ +## Interface `IlmExplainLifecycleLifecycleExplainManaged` + +| Name | Type | Description | +| - | - | - | +| `action_time_millis` | [EpochTime](./EpochTime.md)<[UnitMillis](./UnitMillis.md)> |   | +| `action_time` | [DateTime](./DateTime.md) |   | +| `action` | [Name](./Name.md) |   | +| `age` | [Duration](./Duration.md) |   | +| `failed_step_retry_count` | [integer](./integer.md) |   | +| `failed_step` | [Name](./Name.md) |   | +| `index_creation_date_millis` | [EpochTime](./EpochTime.md)<[UnitMillis](./UnitMillis.md)> |   | +| `index_creation_date` | [DateTime](./DateTime.md) |   | +| `index` | [IndexName](./IndexName.md) |   | +| `is_auto_retryable_error` | boolean |   | +| `lifecycle_date_millis` | [EpochTime](./EpochTime.md)<[UnitMillis](./UnitMillis.md)> |   | +| `lifecycle_date` | [DateTime](./DateTime.md) |   | +| `managed` | true |   | +| `phase_execution` | [IlmExplainLifecycleLifecycleExplainPhaseExecution](./IlmExplainLifecycleLifecycleExplainPhaseExecution.md) |   | +| `phase_time_millis` | [EpochTime](./EpochTime.md)<[UnitMillis](./UnitMillis.md)> |   | +| `phase_time` | [DateTime](./DateTime.md) |   | +| `phase` | [Name](./Name.md) |   | +| `policy` | [Name](./Name.md) |   | +| `previous_step_info` | Record |   | +| `repository_name` | string |   | +| `shrink_index_name` | string |   | +| `snapshot_name` | string |   | +| `step_info` | Record |   | +| `step_time_millis` | [EpochTime](./EpochTime.md)<[UnitMillis](./UnitMillis.md)> |   | +| `step_time` | [DateTime](./DateTime.md) |   | +| `step` | [Name](./Name.md) |   | +| `time_since_index_creation` | [Duration](./Duration.md) |   | diff --git a/docs/reference/api/IlmExplainLifecycleLifecycleExplainPhaseExecution.md b/docs/reference/api/IlmExplainLifecycleLifecycleExplainPhaseExecution.md new file mode 100644 index 000000000..35b50e430 --- /dev/null +++ b/docs/reference/api/IlmExplainLifecycleLifecycleExplainPhaseExecution.md @@ -0,0 +1,8 @@ +## Interface `IlmExplainLifecycleLifecycleExplainPhaseExecution` + +| Name | Type | Description | +| - | - | - | +| `modified_date_in_millis` | [EpochTime](./EpochTime.md)<[UnitMillis](./UnitMillis.md)> |   | +| `phase_definition` | [IlmPhase](./IlmPhase.md) |   | +| `policy` | [Name](./Name.md) |   | +| `version` | [VersionNumber](./VersionNumber.md) |   | diff --git a/docs/reference/api/IlmExplainLifecycleLifecycleExplainUnmanaged.md b/docs/reference/api/IlmExplainLifecycleLifecycleExplainUnmanaged.md new file mode 100644 index 000000000..4f2425123 --- /dev/null +++ b/docs/reference/api/IlmExplainLifecycleLifecycleExplainUnmanaged.md @@ -0,0 +1,6 @@ +## Interface `IlmExplainLifecycleLifecycleExplainUnmanaged` + +| Name | Type | Description | +| - | - | - | +| `index` | [IndexName](./IndexName.md) |   | +| `managed` | false |   | diff --git a/docs/reference/api/IlmExplainLifecycleRequest.md b/docs/reference/api/IlmExplainLifecycleRequest.md new file mode 100644 index 000000000..15632b2be --- /dev/null +++ b/docs/reference/api/IlmExplainLifecycleRequest.md @@ -0,0 +1,10 @@ +## Interface `IlmExplainLifecycleRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { index?: never; only_errors?: never; only_managed?: never; master_timeout?: never; }) | All values in `body` will be added to the request body. | +| `index` | [IndexName](./IndexName.md) | Comma-separated list of data streams, indices, and aliases to target. Supports wildcards ( `*`). To target all data streams and indices, use `*` or `_all`. | +| `master_timeout` | [Duration](./Duration.md) | Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. | +| `only_errors` | boolean | Filters the returned indices to only indices that are managed by ILM and are in an error state, either due to an encountering an error while executing the policy, or attempting to use a policy that does not exist. | +| `only_managed` | boolean | Filters the returned indices to only indices that are managed by ILM. | +| `querystring` | { [key: string]: any; } & { index?: never; only_errors?: never; only_managed?: never; master_timeout?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/IlmExplainLifecycleResponse.md b/docs/reference/api/IlmExplainLifecycleResponse.md new file mode 100644 index 000000000..2d22098ee --- /dev/null +++ b/docs/reference/api/IlmExplainLifecycleResponse.md @@ -0,0 +1,5 @@ +## Interface `IlmExplainLifecycleResponse` + +| Name | Type | Description | +| - | - | - | +| `indices` | Record<[IndexName](./IndexName.md), [IlmExplainLifecycleLifecycleExplain](./IlmExplainLifecycleLifecycleExplain.md)> |   | diff --git a/docs/reference/api/IlmForceMergeAction.md b/docs/reference/api/IlmForceMergeAction.md new file mode 100644 index 000000000..3ef7ebdd1 --- /dev/null +++ b/docs/reference/api/IlmForceMergeAction.md @@ -0,0 +1,6 @@ +## Interface `IlmForceMergeAction` + +| Name | Type | Description | +| - | - | - | +| `index_codec` | string |   | +| `max_num_segments` | [integer](./integer.md) |   | diff --git a/docs/reference/api/IlmGetLifecycleLifecycle.md b/docs/reference/api/IlmGetLifecycleLifecycle.md new file mode 100644 index 000000000..9c6a1daf0 --- /dev/null +++ b/docs/reference/api/IlmGetLifecycleLifecycle.md @@ -0,0 +1,7 @@ +## Interface `IlmGetLifecycleLifecycle` + +| Name | Type | Description | +| - | - | - | +| `modified_date` | [DateTime](./DateTime.md) |   | +| `policy` | [IlmPolicy](./IlmPolicy.md) |   | +| `version` | [VersionNumber](./VersionNumber.md) |   | diff --git a/docs/reference/api/IlmGetLifecycleRequest.md b/docs/reference/api/IlmGetLifecycleRequest.md new file mode 100644 index 000000000..3ea5fa940 --- /dev/null +++ b/docs/reference/api/IlmGetLifecycleRequest.md @@ -0,0 +1,9 @@ +## Interface `IlmGetLifecycleRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { name?: never; master_timeout?: never; timeout?: never; }) | All values in `body` will be added to the request body. | +| `master_timeout` | [Duration](./Duration.md) | Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. | +| `name` | [Name](./Name.md) | Identifier for the policy. | +| `querystring` | { [key: string]: any; } & { name?: never; master_timeout?: never; timeout?: never; } | All values in `querystring` will be added to the request querystring. | +| `timeout` | [Duration](./Duration.md) | Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. | diff --git a/docs/reference/api/IlmGetLifecycleResponse.md b/docs/reference/api/IlmGetLifecycleResponse.md new file mode 100644 index 000000000..21aa8cebc --- /dev/null +++ b/docs/reference/api/IlmGetLifecycleResponse.md @@ -0,0 +1,4 @@ +## `IlmGetLifecycleResponse` +::: +type IlmGetLifecycleResponse = Record; +::: diff --git a/docs/reference/api/IlmGetStatusRequest.md b/docs/reference/api/IlmGetStatusRequest.md new file mode 100644 index 000000000..6143565c3 --- /dev/null +++ b/docs/reference/api/IlmGetStatusRequest.md @@ -0,0 +1,6 @@ +## Interface `IlmGetStatusRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | { [key: string]: any; } | All values in `body` will be added to the request body. | +| `querystring` | { [key: string]: any; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/IlmGetStatusResponse.md b/docs/reference/api/IlmGetStatusResponse.md new file mode 100644 index 000000000..d2c54f3d6 --- /dev/null +++ b/docs/reference/api/IlmGetStatusResponse.md @@ -0,0 +1,5 @@ +## Interface `IlmGetStatusResponse` + +| Name | Type | Description | +| - | - | - | +| `operation_mode` | [LifecycleOperationMode](./LifecycleOperationMode.md) |   | diff --git a/docs/reference/api/IlmMigrateAction.md b/docs/reference/api/IlmMigrateAction.md new file mode 100644 index 000000000..a3e5a6ee4 --- /dev/null +++ b/docs/reference/api/IlmMigrateAction.md @@ -0,0 +1,5 @@ +## Interface `IlmMigrateAction` + +| Name | Type | Description | +| - | - | - | +| `enabled` | boolean |   | diff --git a/docs/reference/api/IlmMigrateToDataTiersRequest.md b/docs/reference/api/IlmMigrateToDataTiersRequest.md new file mode 100644 index 000000000..68c9a7fd1 --- /dev/null +++ b/docs/reference/api/IlmMigrateToDataTiersRequest.md @@ -0,0 +1,10 @@ +## Interface `IlmMigrateToDataTiersRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { dry_run?: never; master_timeout?: never; legacy_template_to_delete?: never; node_attribute?: never; }) | All values in `body` will be added to the request body. | +| `dry_run` | boolean | If true, simulates the migration from node attributes based allocation filters to data tiers, but does not perform the migration. This provides a way to retrieve the indices and ILM policies that need to be migrated. | +| `legacy_template_to_delete` | string |   | +| `master_timeout` | [Duration](./Duration.md) | The period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. It can also be set to `-1` to indicate that the request should never timeout. | +| `node_attribute` | string |   | +| `querystring` | { [key: string]: any; } & { dry_run?: never; master_timeout?: never; legacy_template_to_delete?: never; node_attribute?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/IlmMigrateToDataTiersResponse.md b/docs/reference/api/IlmMigrateToDataTiersResponse.md new file mode 100644 index 000000000..6d4f70119 --- /dev/null +++ b/docs/reference/api/IlmMigrateToDataTiersResponse.md @@ -0,0 +1,11 @@ +## Interface `IlmMigrateToDataTiersResponse` + +| Name | Type | Description | +| - | - | - | +| `dry_run` | boolean |   | +| `migrated_component_templates` | string[] | The component templates that were updated to not contain custom routing settings for the provided data attribute. | +| `migrated_composable_templates` | string[] | The composable index templates that were updated to not contain custom routing settings for the provided data attribute. | +| `migrated_ilm_policies` | string[] | The ILM policies that were updated. | +| `migrated_indices` | [Indices](./Indices.md) | The indices that were migrated to tier preference routing. | +| `migrated_legacy_templates` | string[] | The legacy index templates that were updated to not contain custom routing settings for the provided data attribute. | +| `removed_legacy_template` | string | The name of the legacy index template that was deleted. This information is missing if no legacy index templates were deleted. | diff --git a/docs/reference/api/IlmMoveToStepRequest.md b/docs/reference/api/IlmMoveToStepRequest.md new file mode 100644 index 000000000..ab02c6da4 --- /dev/null +++ b/docs/reference/api/IlmMoveToStepRequest.md @@ -0,0 +1,9 @@ +## Interface `IlmMoveToStepRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { index?: never; current_step?: never; next_step?: never; }) | All values in `body` will be added to the request body. | +| `current_step` | [IlmMoveToStepStepKey](./IlmMoveToStepStepKey.md) | The step that the index is expected to be in. | +| `index` | [IndexName](./IndexName.md) | The name of the index whose lifecycle step is to change | +| `next_step` | [IlmMoveToStepStepKey](./IlmMoveToStepStepKey.md) | The step that you want to run. | +| `querystring` | { [key: string]: any; } & { index?: never; current_step?: never; next_step?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/IlmMoveToStepResponse.md b/docs/reference/api/IlmMoveToStepResponse.md new file mode 100644 index 000000000..f5465ea4f --- /dev/null +++ b/docs/reference/api/IlmMoveToStepResponse.md @@ -0,0 +1,4 @@ +## `IlmMoveToStepResponse` +::: +type IlmMoveToStepResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); +::: diff --git a/docs/reference/api/IlmMoveToStepStepKey.md b/docs/reference/api/IlmMoveToStepStepKey.md new file mode 100644 index 000000000..0bbcb3f89 --- /dev/null +++ b/docs/reference/api/IlmMoveToStepStepKey.md @@ -0,0 +1,7 @@ +## Interface `IlmMoveToStepStepKey` + +| Name | Type | Description | +| - | - | - | +| `action` | string | The optional action to which the index will be moved. | +| `name` | string | The optional step name to which the index will be moved. | +| `phase` | string |   | diff --git a/docs/reference/api/IlmPhase.md b/docs/reference/api/IlmPhase.md new file mode 100644 index 000000000..b83726fcd --- /dev/null +++ b/docs/reference/api/IlmPhase.md @@ -0,0 +1,6 @@ +## Interface `IlmPhase` + +| Name | Type | Description | +| - | - | - | +| `actions` | [IlmActions](./IlmActions.md) |   | +| `min_age` | [Duration](./Duration.md) |   | diff --git a/docs/reference/api/IlmPhases.md b/docs/reference/api/IlmPhases.md new file mode 100644 index 000000000..18d49517d --- /dev/null +++ b/docs/reference/api/IlmPhases.md @@ -0,0 +1,9 @@ +## Interface `IlmPhases` + +| Name | Type | Description | +| - | - | - | +| `cold` | [IlmPhase](./IlmPhase.md) |   | +| `delete` | [IlmPhase](./IlmPhase.md) |   | +| `frozen` | [IlmPhase](./IlmPhase.md) |   | +| `hot` | [IlmPhase](./IlmPhase.md) |   | +| `warm` | [IlmPhase](./IlmPhase.md) |   | diff --git a/docs/reference/api/IlmPolicy.md b/docs/reference/api/IlmPolicy.md new file mode 100644 index 000000000..78e5f30c1 --- /dev/null +++ b/docs/reference/api/IlmPolicy.md @@ -0,0 +1,6 @@ +## Interface `IlmPolicy` + +| Name | Type | Description | +| - | - | - | +| `_meta` | [Metadata](./Metadata.md) | Arbitrary metadata that is not automatically generated or used by Elasticsearch. | +| `phases` | [IlmPhases](./IlmPhases.md) |   | diff --git a/docs/reference/api/IlmPutLifecycleRequest.md b/docs/reference/api/IlmPutLifecycleRequest.md new file mode 100644 index 000000000..fc8f6649a --- /dev/null +++ b/docs/reference/api/IlmPutLifecycleRequest.md @@ -0,0 +1,10 @@ +## Interface `IlmPutLifecycleRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { name?: never; master_timeout?: never; timeout?: never; policy?: never; }) | All values in `body` will be added to the request body. | +| `master_timeout` | [Duration](./Duration.md) | Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. | +| `name` | [Name](./Name.md) | Identifier for the policy. | +| `policy` | [IlmPolicy](./IlmPolicy.md) |   | +| `querystring` | { [key: string]: any; } & { name?: never; master_timeout?: never; timeout?: never; policy?: never; } | All values in `querystring` will be added to the request querystring. | +| `timeout` | [Duration](./Duration.md) | Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. | diff --git a/docs/reference/api/IlmPutLifecycleResponse.md b/docs/reference/api/IlmPutLifecycleResponse.md new file mode 100644 index 000000000..235ab244b --- /dev/null +++ b/docs/reference/api/IlmPutLifecycleResponse.md @@ -0,0 +1,4 @@ +## `IlmPutLifecycleResponse` +::: +type IlmPutLifecycleResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); +::: diff --git a/docs/reference/api/IlmRemovePolicyRequest.md b/docs/reference/api/IlmRemovePolicyRequest.md new file mode 100644 index 000000000..34f7d0e5a --- /dev/null +++ b/docs/reference/api/IlmRemovePolicyRequest.md @@ -0,0 +1,7 @@ +## Interface `IlmRemovePolicyRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { index?: never; }) | All values in `body` will be added to the request body. | +| `index` | [IndexName](./IndexName.md) | The name of the index to remove policy on | +| `querystring` | { [key: string]: any; } & { index?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/IlmRemovePolicyResponse.md b/docs/reference/api/IlmRemovePolicyResponse.md new file mode 100644 index 000000000..41d31e2e4 --- /dev/null +++ b/docs/reference/api/IlmRemovePolicyResponse.md @@ -0,0 +1,6 @@ +## Interface `IlmRemovePolicyResponse` + +| Name | Type | Description | +| - | - | - | +| `failed_indexes` | [IndexName](./IndexName.md)[] |   | +| `has_failures` | boolean |   | diff --git a/docs/reference/api/IlmRetryRequest.md b/docs/reference/api/IlmRetryRequest.md new file mode 100644 index 000000000..ca65ee8c7 --- /dev/null +++ b/docs/reference/api/IlmRetryRequest.md @@ -0,0 +1,7 @@ +## Interface `IlmRetryRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { index?: never; }) | All values in `body` will be added to the request body. | +| `index` | [IndexName](./IndexName.md) | The name of the indices (comma-separated) whose failed lifecycle step is to be retry | +| `querystring` | { [key: string]: any; } & { index?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/IlmRetryResponse.md b/docs/reference/api/IlmRetryResponse.md new file mode 100644 index 000000000..e25f5a641 --- /dev/null +++ b/docs/reference/api/IlmRetryResponse.md @@ -0,0 +1,4 @@ +## `IlmRetryResponse` +::: +type IlmRetryResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); +::: diff --git a/docs/reference/api/IlmRolloverAction.md b/docs/reference/api/IlmRolloverAction.md new file mode 100644 index 000000000..5a63822b3 --- /dev/null +++ b/docs/reference/api/IlmRolloverAction.md @@ -0,0 +1,14 @@ +## Interface `IlmRolloverAction` + +| Name | Type | Description | +| - | - | - | +| `max_age` | [Duration](./Duration.md) |   | +| `max_docs` | [long](./long.md) |   | +| `max_primary_shard_docs` | [long](./long.md) |   | +| `max_primary_shard_size` | [ByteSize](./ByteSize.md) |   | +| `max_size` | [ByteSize](./ByteSize.md) |   | +| `min_age` | [Duration](./Duration.md) |   | +| `min_docs` | [long](./long.md) |   | +| `min_primary_shard_docs` | [long](./long.md) |   | +| `min_primary_shard_size` | [ByteSize](./ByteSize.md) |   | +| `min_size` | [ByteSize](./ByteSize.md) |   | diff --git a/docs/reference/api/IlmSearchableSnapshotAction.md b/docs/reference/api/IlmSearchableSnapshotAction.md new file mode 100644 index 000000000..ab78509aa --- /dev/null +++ b/docs/reference/api/IlmSearchableSnapshotAction.md @@ -0,0 +1,6 @@ +## Interface `IlmSearchableSnapshotAction` + +| Name | Type | Description | +| - | - | - | +| `force_merge_index` | boolean |   | +| `snapshot_repository` | string |   | diff --git a/docs/reference/api/IlmSetPriorityAction.md b/docs/reference/api/IlmSetPriorityAction.md new file mode 100644 index 000000000..02a517a8c --- /dev/null +++ b/docs/reference/api/IlmSetPriorityAction.md @@ -0,0 +1,5 @@ +## Interface `IlmSetPriorityAction` + +| Name | Type | Description | +| - | - | - | +| `priority` | [integer](./integer.md) |   | diff --git a/docs/reference/api/IlmShrinkAction.md b/docs/reference/api/IlmShrinkAction.md new file mode 100644 index 000000000..f0518dfca --- /dev/null +++ b/docs/reference/api/IlmShrinkAction.md @@ -0,0 +1,7 @@ +## Interface `IlmShrinkAction` + +| Name | Type | Description | +| - | - | - | +| `allow_write_after_shrink` | boolean |   | +| `max_primary_shard_size` | [ByteSize](./ByteSize.md) |   | +| `number_of_shards` | [integer](./integer.md) |   | diff --git a/docs/reference/api/IlmStartRequest.md b/docs/reference/api/IlmStartRequest.md new file mode 100644 index 000000000..dc712a3e2 --- /dev/null +++ b/docs/reference/api/IlmStartRequest.md @@ -0,0 +1,8 @@ +## Interface `IlmStartRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { master_timeout?: never; timeout?: never; }) | All values in `body` will be added to the request body. | +| `master_timeout` | [Duration](./Duration.md) | Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. | +| `querystring` | { [key: string]: any; } & { master_timeout?: never; timeout?: never; } | All values in `querystring` will be added to the request querystring. | +| `timeout` | [Duration](./Duration.md) | Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. | diff --git a/docs/reference/api/IlmStartResponse.md b/docs/reference/api/IlmStartResponse.md new file mode 100644 index 000000000..c62579f7f --- /dev/null +++ b/docs/reference/api/IlmStartResponse.md @@ -0,0 +1,4 @@ +## `IlmStartResponse` +::: +type IlmStartResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); +::: diff --git a/docs/reference/api/IlmStopRequest.md b/docs/reference/api/IlmStopRequest.md new file mode 100644 index 000000000..d95c67ef2 --- /dev/null +++ b/docs/reference/api/IlmStopRequest.md @@ -0,0 +1,8 @@ +## Interface `IlmStopRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { master_timeout?: never; timeout?: never; }) | All values in `body` will be added to the request body. | +| `master_timeout` | [Duration](./Duration.md) | Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. | +| `querystring` | { [key: string]: any; } & { master_timeout?: never; timeout?: never; } | All values in `querystring` will be added to the request querystring. | +| `timeout` | [Duration](./Duration.md) | Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. | diff --git a/docs/reference/api/IlmStopResponse.md b/docs/reference/api/IlmStopResponse.md new file mode 100644 index 000000000..960c4d0f5 --- /dev/null +++ b/docs/reference/api/IlmStopResponse.md @@ -0,0 +1,4 @@ +## `IlmStopResponse` +::: +type IlmStopResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); +::: diff --git a/docs/reference/api/IlmWaitForSnapshotAction.md b/docs/reference/api/IlmWaitForSnapshotAction.md new file mode 100644 index 000000000..af4b8f02f --- /dev/null +++ b/docs/reference/api/IlmWaitForSnapshotAction.md @@ -0,0 +1,5 @@ +## Interface `IlmWaitForSnapshotAction` + +| Name | Type | Description | +| - | - | - | +| `policy` | string |   | diff --git a/docs/reference/api/IndexAction.md b/docs/reference/api/IndexAction.md new file mode 100644 index 000000000..dc950a114 --- /dev/null +++ b/docs/reference/api/IndexAction.md @@ -0,0 +1,4 @@ +## `IndexAction` +::: +type IndexAction = [IndexActionOperation](./IndexActionOperation.md) | [[IndexActionOperation](./IndexActionOperation.md), unknown]; +::: diff --git a/docs/reference/api/IndexActionOperation.md b/docs/reference/api/IndexActionOperation.md new file mode 100644 index 000000000..fc1f602e7 --- /dev/null +++ b/docs/reference/api/IndexActionOperation.md @@ -0,0 +1,5 @@ +## Interface `IndexActionOperation` + +| Name | Type | Description | +| - | - | - | +| `index` | [BulkIndexOperation](./BulkIndexOperation.md) |   | diff --git a/docs/reference/api/IndexAlias.md b/docs/reference/api/IndexAlias.md new file mode 100644 index 000000000..fb9052888 --- /dev/null +++ b/docs/reference/api/IndexAlias.md @@ -0,0 +1,4 @@ +## `IndexAlias` +::: +type IndexAlias = string; +::: diff --git a/docs/reference/api/IndexApi_1.md b/docs/reference/api/IndexApi_1.md new file mode 100644 index 000000000..acd77a7b4 --- /dev/null +++ b/docs/reference/api/IndexApi_1.md @@ -0,0 +1,3 @@ +::: +default function IndexApi(this: [That](./That.md), params: [IndexRequest](./IndexRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[IndexResponse](./IndexResponse.md)>; +::: diff --git a/docs/reference/api/IndexApi_2.md b/docs/reference/api/IndexApi_2.md new file mode 100644 index 000000000..401355e93 --- /dev/null +++ b/docs/reference/api/IndexApi_2.md @@ -0,0 +1,3 @@ +::: +default function IndexApi(this: [That](./That.md), params: [IndexRequest](./IndexRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[IndexResponse](./IndexResponse.md), unknown>>; +::: diff --git a/docs/reference/api/IndexApi_3.md b/docs/reference/api/IndexApi_3.md new file mode 100644 index 000000000..9f495f7c1 --- /dev/null +++ b/docs/reference/api/IndexApi_3.md @@ -0,0 +1,3 @@ +::: +default function IndexApi(this: [That](./That.md), params: [IndexRequest](./IndexRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[IndexResponse](./IndexResponse.md)>; +::: diff --git a/docs/reference/api/IndexName.md b/docs/reference/api/IndexName.md new file mode 100644 index 000000000..2361aaa74 --- /dev/null +++ b/docs/reference/api/IndexName.md @@ -0,0 +1,4 @@ +## `IndexName` +::: +type IndexName = string; +::: diff --git a/docs/reference/api/IndexPattern.md b/docs/reference/api/IndexPattern.md new file mode 100644 index 000000000..25ebe087f --- /dev/null +++ b/docs/reference/api/IndexPattern.md @@ -0,0 +1,4 @@ +## `IndexPattern` +::: +type IndexPattern = string; +::: diff --git a/docs/reference/api/IndexPatterns.md b/docs/reference/api/IndexPatterns.md new file mode 100644 index 000000000..588a1a1d1 --- /dev/null +++ b/docs/reference/api/IndexPatterns.md @@ -0,0 +1,4 @@ +## `IndexPatterns` +::: +type IndexPatterns = [IndexPattern](./IndexPattern.md)[]; +::: diff --git a/docs/reference/api/IndexRequest.md b/docs/reference/api/IndexRequest.md new file mode 100644 index 000000000..f2e334b58 --- /dev/null +++ b/docs/reference/api/IndexRequest.md @@ -0,0 +1,21 @@ +## Interface `IndexRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { id?: never; index?: never; if_primary_term?: never; if_seq_no?: never; include_source_on_error?: never; op_type?: never; pipeline?: never; refresh?: never; routing?: never; timeout?: never; version?: never; version_type?: never; wait_for_active_shards?: never; require_alias?: never; document?: never; }) | All values in `body` will be added to the request body. | +| `document` | TDocument |   | +| `id` | [Id](./Id.md) | A unique identifier for the document. To automatically generate a document ID, use the `POST //_doc/` request format and omit this parameter. | +| `if_primary_term` | [long](./long.md) | Only perform the operation if the document has this primary term. | +| `if_seq_no` | [SequenceNumber](./SequenceNumber.md) | Only perform the operation if the document has this sequence number. | +| `include_source_on_error` | boolean | True or false if to include the document source in the error message in case of parsing errors. | +| `index` | [IndexName](./IndexName.md) | The name of the data stream or index to target. If the target doesn't exist and matches the name or wildcard ( `*`) pattern of an index template with a `data_stream` definition, this request creates the data stream. If the target doesn't exist and doesn't match a data stream template, this request creates the index. You can check for existing targets with the resolve index API. | +| `op_type` | [OpType](./OpType.md) | Set to `create` to only index the document if it does not already exist (put if absent). If a document with the specified `_id` already exists, the indexing operation will fail. The behavior is the same as using the `/_create` endpoint. If a document ID is specified, this paramater defaults to `index`. Otherwise, it defaults to `create`. If the request targets a data stream, an `op_type` of `create` is required. | +| `pipeline` | string | The ID of the pipeline to use to preprocess incoming documents. If the index has a default ingest pipeline specified, then setting the value to `_none` disables the default ingest pipeline for this request. If a final pipeline is configured it will always run, regardless of the value of this parameter. | +| `querystring` | { [key: string]: any; } & { id?: never; index?: never; if_primary_term?: never; if_seq_no?: never; include_source_on_error?: never; op_type?: never; pipeline?: never; refresh?: never; routing?: never; timeout?: never; version?: never; version_type?: never; wait_for_active_shards?: never; require_alias?: never; document?: never; } | All values in `querystring` will be added to the request querystring. | +| `refresh` | [Refresh](./Refresh.md) | If `true`, Elasticsearch refreshes the affected shards to make this operation visible to search. If `wait_for`, it waits for a refresh to make this operation visible to search. If `false`, it does nothing with refreshes. | +| `require_alias` | boolean | If `true`, the destination must be an index alias. | +| `routing` | [Routing](./Routing.md) | A custom value that is used to route operations to a specific shard. | +| `timeout` | [Duration](./Duration.md) | The period the request waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards. This parameter is useful for situations where the primary shard assigned to perform the operation might not be available when the operation runs. Some reasons for this might be that the primary shard is currently recovering from a gateway or undergoing relocation. By default, the operation will wait on the primary shard to become available for at least 1 minute before failing and responding with an error. The actual wait time could be longer, particularly when multiple waits occur. | +| `version_type` | [VersionType](./VersionType.md) | The version type. | +| `version` | [VersionNumber](./VersionNumber.md) | An explicit version number for concurrency control. It must be a non-negative long number. | +| `wait_for_active_shards` | [WaitForActiveShards](./WaitForActiveShards.md) | The number of shard copies that must be active before proceeding with the operation. You can set it to `all` or any positive integer up to the total number of shards in the index ( `number_of_replicas+1`). The default value of `1` means it waits for each primary shard to be active. | diff --git a/docs/reference/api/IndexResponse.md b/docs/reference/api/IndexResponse.md new file mode 100644 index 000000000..8d70fe2e5 --- /dev/null +++ b/docs/reference/api/IndexResponse.md @@ -0,0 +1,4 @@ +## `IndexResponse` +::: +type IndexResponse = [WriteResponseBase](./WriteResponseBase.md); +::: diff --git a/docs/reference/api/IndexingStats.md b/docs/reference/api/IndexingStats.md new file mode 100644 index 000000000..677299613 --- /dev/null +++ b/docs/reference/api/IndexingStats.md @@ -0,0 +1,21 @@ +## Interface `IndexingStats` + +| Name | Type | Description | +| - | - | - | +| `delete_current` | [long](./long.md) |   | +| `delete_time_in_millis` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> |   | +| `delete_time` | [Duration](./Duration.md) |   | +| `delete_total` | [long](./long.md) |   | +| `index_current` | [long](./long.md) |   | +| `index_failed` | [long](./long.md) |   | +| `index_time_in_millis` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> |   | +| `index_time` | [Duration](./Duration.md) |   | +| `index_total` | [long](./long.md) |   | +| `is_throttled` | boolean |   | +| `noop_update_total` | [long](./long.md) |   | +| `peak_write_load` | [double](./double.md) |   | +| `recent_write_load` | [double](./double.md) |   | +| `throttle_time_in_millis` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> |   | +| `throttle_time` | [Duration](./Duration.md) |   | +| `types` | Record |   | +| `write_load` | [double](./double.md) |   | diff --git a/docs/reference/api/Indices.md b/docs/reference/api/Indices.md new file mode 100644 index 000000000..afdc9d564 --- /dev/null +++ b/docs/reference/api/Indices.md @@ -0,0 +1,4 @@ +## `Indices` +::: +type Indices = [IndexName](./IndexName.md) | [IndexName](./IndexName.md)[]; +::: diff --git a/docs/reference/api/IndicesAddBlockIndicesBlockOptions.md b/docs/reference/api/IndicesAddBlockIndicesBlockOptions.md new file mode 100644 index 000000000..fc4b80c65 --- /dev/null +++ b/docs/reference/api/IndicesAddBlockIndicesBlockOptions.md @@ -0,0 +1,4 @@ +## `IndicesAddBlockIndicesBlockOptions` +::: +type IndicesAddBlockIndicesBlockOptions = 'metadata' | 'read' | 'read_only' | 'write'; +::: diff --git a/docs/reference/api/IndicesAddBlockIndicesBlockStatus.md b/docs/reference/api/IndicesAddBlockIndicesBlockStatus.md new file mode 100644 index 000000000..2192c00a0 --- /dev/null +++ b/docs/reference/api/IndicesAddBlockIndicesBlockStatus.md @@ -0,0 +1,6 @@ +## Interface `IndicesAddBlockIndicesBlockStatus` + +| Name | Type | Description | +| - | - | - | +| `blocked` | boolean |   | +| `name` | [IndexName](./IndexName.md) |   | diff --git a/docs/reference/api/IndicesAddBlockRequest.md b/docs/reference/api/IndicesAddBlockRequest.md new file mode 100644 index 000000000..77d6fca60 --- /dev/null +++ b/docs/reference/api/IndicesAddBlockRequest.md @@ -0,0 +1,13 @@ +## Interface `IndicesAddBlockRequest` + +| Name | Type | Description | +| - | - | - | +| `allow_no_indices` | boolean | If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. | +| `block` | [IndicesAddBlockIndicesBlockOptions](./IndicesAddBlockIndicesBlockOptions.md) | The block type to add to the index. | +| `body` | string | ({ [key: string]: any; } & { index?: never; block?: never; allow_no_indices?: never; expand_wildcards?: never; ignore_unavailable?: never; master_timeout?: never; timeout?: never; }) | All values in `body` will be added to the request body. | +| `expand_wildcards` | [ExpandWildcards](./ExpandWildcards.md) | The type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. It supports comma-separated values, such as `open,hidden`. | +| `ignore_unavailable` | boolean | If `false`, the request returns an error if it targets a missing or closed index. | +| `index` | [IndexName](./IndexName.md) | A comma-separated list or wildcard expression of index names used to limit the request. By default, you must explicitly name the indices you are adding blocks to. To allow the adding of blocks to indices with `_all`, `*`, or other wildcard expressions, change the `action.destructive_requires_name` setting to `false`. You can update this setting in the `elasticsearch.yml` file or by using the cluster update settings API. | +| `master_timeout` | [Duration](./Duration.md) | The period to wait for the master node. If the master node is not available before the timeout expires, the request fails and returns an error. It can also be set to `-1` to indicate that the request should never timeout. | +| `querystring` | { [key: string]: any; } & { index?: never; block?: never; allow_no_indices?: never; expand_wildcards?: never; ignore_unavailable?: never; master_timeout?: never; timeout?: never; } | All values in `querystring` will be added to the request querystring. | +| `timeout` | [Duration](./Duration.md) | The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata. If no response is received before the timeout expires, the cluster metadata update still applies but the response will indicate that it was not completely acknowledged. It can also be set to `-1` to indicate that the request should never timeout. | diff --git a/docs/reference/api/IndicesAddBlockResponse.md b/docs/reference/api/IndicesAddBlockResponse.md new file mode 100644 index 000000000..860ec20e0 --- /dev/null +++ b/docs/reference/api/IndicesAddBlockResponse.md @@ -0,0 +1,7 @@ +## Interface `IndicesAddBlockResponse` + +| Name | Type | Description | +| - | - | - | +| `acknowledged` | boolean |   | +| `indices` | [IndicesAddBlockIndicesBlockStatus](./IndicesAddBlockIndicesBlockStatus.md)[] |   | +| `shards_acknowledged` | boolean |   | diff --git a/docs/reference/api/IndicesAlias.md b/docs/reference/api/IndicesAlias.md new file mode 100644 index 000000000..f459cebc2 --- /dev/null +++ b/docs/reference/api/IndicesAlias.md @@ -0,0 +1,10 @@ +## Interface `IndicesAlias` + +| Name | Type | Description | +| - | - | - | +| `filter` | [QueryDslQueryContainer](./QueryDslQueryContainer.md) | Query used to limit documents the alias can access. | +| `index_routing` | [Routing](./Routing.md) | Value used to route indexing operations to a specific shard. If specified, this overwrites the `routing` value for indexing operations. | +| `is_hidden` | boolean | If `true`, the alias is hidden. All indices for the alias must have the same `is_hidden` value. | +| `is_write_index` | boolean | If `true`, the index is the write index for the alias. | +| `routing` | [Routing](./Routing.md) | Value used to route indexing and search operations to a specific shard. | +| `search_routing` | [Routing](./Routing.md) | Value used to route search operations to a specific shard. If specified, this overwrites the `routing` value for search operations. | diff --git a/docs/reference/api/IndicesAliasDefinition.md b/docs/reference/api/IndicesAliasDefinition.md new file mode 100644 index 000000000..6ed4ffa5a --- /dev/null +++ b/docs/reference/api/IndicesAliasDefinition.md @@ -0,0 +1,10 @@ +## Interface `IndicesAliasDefinition` + +| Name | Type | Description | +| - | - | - | +| `filter` | [QueryDslQueryContainer](./QueryDslQueryContainer.md) | Query used to limit documents the alias can access. | +| `index_routing` | string | Value used to route indexing operations to a specific shard. If specified, this overwrites the `routing` value for indexing operations. | +| `is_hidden` | boolean | If `true`, the alias is hidden. All indices for the alias must have the same `is_hidden` value. | +| `is_write_index` | boolean | If `true`, the index is the write index for the alias. | +| `routing` | string | Value used to route indexing and search operations to a specific shard. | +| `search_routing` | string | Value used to route search operations to a specific shard. If specified, this overwrites the `routing` value for search operations. | diff --git a/docs/reference/api/IndicesAnalyzeAnalyzeDetail.md b/docs/reference/api/IndicesAnalyzeAnalyzeDetail.md new file mode 100644 index 000000000..47289c421 --- /dev/null +++ b/docs/reference/api/IndicesAnalyzeAnalyzeDetail.md @@ -0,0 +1,9 @@ +## Interface `IndicesAnalyzeAnalyzeDetail` + +| Name | Type | Description | +| - | - | - | +| `analyzer` | [IndicesAnalyzeAnalyzerDetail](./IndicesAnalyzeAnalyzerDetail.md) |   | +| `charfilters` | [IndicesAnalyzeCharFilterDetail](./IndicesAnalyzeCharFilterDetail.md)[] |   | +| `custom_analyzer` | boolean |   | +| `tokenfilters` | [IndicesAnalyzeTokenDetail](./IndicesAnalyzeTokenDetail.md)[] |   | +| `tokenizer` | [IndicesAnalyzeTokenDetail](./IndicesAnalyzeTokenDetail.md) |   | diff --git a/docs/reference/api/IndicesAnalyzeAnalyzeToken.md b/docs/reference/api/IndicesAnalyzeAnalyzeToken.md new file mode 100644 index 000000000..98512f895 --- /dev/null +++ b/docs/reference/api/IndicesAnalyzeAnalyzeToken.md @@ -0,0 +1,10 @@ +## Interface `IndicesAnalyzeAnalyzeToken` + +| Name | Type | Description | +| - | - | - | +| `end_offset` | [long](./long.md) |   | +| `position` | [long](./long.md) |   | +| `positionLength` | [long](./long.md) |   | +| `start_offset` | [long](./long.md) |   | +| `token` | string |   | +| `type` | string |   | diff --git a/docs/reference/api/IndicesAnalyzeAnalyzerDetail.md b/docs/reference/api/IndicesAnalyzeAnalyzerDetail.md new file mode 100644 index 000000000..1db4eb8bf --- /dev/null +++ b/docs/reference/api/IndicesAnalyzeAnalyzerDetail.md @@ -0,0 +1,6 @@ +## Interface `IndicesAnalyzeAnalyzerDetail` + +| Name | Type | Description | +| - | - | - | +| `name` | string |   | +| `tokens` | [IndicesAnalyzeExplainAnalyzeToken](./IndicesAnalyzeExplainAnalyzeToken.md)[] |   | diff --git a/docs/reference/api/IndicesAnalyzeCharFilterDetail.md b/docs/reference/api/IndicesAnalyzeCharFilterDetail.md new file mode 100644 index 000000000..06e9203ab --- /dev/null +++ b/docs/reference/api/IndicesAnalyzeCharFilterDetail.md @@ -0,0 +1,6 @@ +## Interface `IndicesAnalyzeCharFilterDetail` + +| Name | Type | Description | +| - | - | - | +| `filtered_text` | string[] |   | +| `name` | string |   | diff --git a/docs/reference/api/IndicesAnalyzeExplainAnalyzeToken.md b/docs/reference/api/IndicesAnalyzeExplainAnalyzeToken.md new file mode 100644 index 000000000..4b241cdaa --- /dev/null +++ b/docs/reference/api/IndicesAnalyzeExplainAnalyzeToken.md @@ -0,0 +1,4 @@ +## `IndicesAnalyzeExplainAnalyzeToken` +::: +type IndicesAnalyzeExplainAnalyzeToken = [IndicesAnalyzeExplainAnalyzeTokenKeys](./IndicesAnalyzeExplainAnalyzeTokenKeys.md) & { [property: string]: any;}; +::: diff --git a/docs/reference/api/IndicesAnalyzeExplainAnalyzeTokenKeys.md b/docs/reference/api/IndicesAnalyzeExplainAnalyzeTokenKeys.md new file mode 100644 index 000000000..13d3cf170 --- /dev/null +++ b/docs/reference/api/IndicesAnalyzeExplainAnalyzeTokenKeys.md @@ -0,0 +1,13 @@ +## Interface `IndicesAnalyzeExplainAnalyzeTokenKeys` + +| Name | Type | Description | +| - | - | - | +| `bytes` | string |   | +| `end_offset` | [long](./long.md) |   | +| `keyword` | boolean |   | +| `position` | [long](./long.md) |   | +| `positionLength` | [long](./long.md) |   | +| `start_offset` | [long](./long.md) |   | +| `termFrequency` | [long](./long.md) |   | +| `token` | string |   | +| `type` | string |   | diff --git a/docs/reference/api/IndicesAnalyzeRequest.md b/docs/reference/api/IndicesAnalyzeRequest.md new file mode 100644 index 000000000..50cba70c5 --- /dev/null +++ b/docs/reference/api/IndicesAnalyzeRequest.md @@ -0,0 +1,16 @@ +## Interface `IndicesAnalyzeRequest` + +| Name | Type | Description | +| - | - | - | +| `analyzer` | string | The name of the analyzer that should be applied to the provided `text`. This could be a built-in analyzer, or an analyzer that’s been configured in the index. | +| `attributes` | string[] | Array of token attributes used to filter the output of the `explain` parameter. | +| `body` | string | ({ [key: string]: any; } & { index?: never; analyzer?: never; attributes?: never; char_filter?: never; explain?: never; field?: never; filter?: never; normalizer?: never; text?: never; tokenizer?: never; }) | All values in `body` will be added to the request body. | +| `char_filter` | [AnalysisCharFilter](./AnalysisCharFilter.md)[] | Array of character filters used to preprocess characters before the tokenizer. | +| `explain` | boolean | If `true`, the response includes token attributes and additional details. | +| `field` | [Field](./Field.md) | Field used to derive the analyzer. To use this parameter, you must specify an index. If specified, the `analyzer` parameter overrides this value. | +| `filter` | [AnalysisTokenFilter](./AnalysisTokenFilter.md)[] | Array of token filters used to apply after the tokenizer. | +| `index` | [IndexName](./IndexName.md) | Index used to derive the analyzer. If specified, the `analyzer` or field parameter overrides this value. If no index is specified or the index does not have a default analyzer, the analyze API uses the standard analyzer. | +| `normalizer` | string | Normalizer to use to convert text into a single token. | +| `querystring` | { [key: string]: any; } & { index?: never; analyzer?: never; attributes?: never; char_filter?: never; explain?: never; field?: never; filter?: never; normalizer?: never; text?: never; tokenizer?: never; } | All values in `querystring` will be added to the request querystring. | +| `text` | [IndicesAnalyzeTextToAnalyze](./IndicesAnalyzeTextToAnalyze.md) | Text to analyze. If an array of strings is provided, it is analyzed as a multi-value field. | +| `tokenizer` | [AnalysisTokenizer](./AnalysisTokenizer.md) | Tokenizer to use to convert text into tokens. | diff --git a/docs/reference/api/IndicesAnalyzeResponse.md b/docs/reference/api/IndicesAnalyzeResponse.md new file mode 100644 index 000000000..f2d100d0c --- /dev/null +++ b/docs/reference/api/IndicesAnalyzeResponse.md @@ -0,0 +1,6 @@ +## Interface `IndicesAnalyzeResponse` + +| Name | Type | Description | +| - | - | - | +| `detail` | [IndicesAnalyzeAnalyzeDetail](./IndicesAnalyzeAnalyzeDetail.md) |   | +| `tokens` | [IndicesAnalyzeAnalyzeToken](./IndicesAnalyzeAnalyzeToken.md)[] |   | diff --git a/docs/reference/api/IndicesAnalyzeTextToAnalyze.md b/docs/reference/api/IndicesAnalyzeTextToAnalyze.md new file mode 100644 index 000000000..40cea9ed8 --- /dev/null +++ b/docs/reference/api/IndicesAnalyzeTextToAnalyze.md @@ -0,0 +1,4 @@ +## `IndicesAnalyzeTextToAnalyze` +::: +type IndicesAnalyzeTextToAnalyze = string | string[]; +::: diff --git a/docs/reference/api/IndicesAnalyzeTokenDetail.md b/docs/reference/api/IndicesAnalyzeTokenDetail.md new file mode 100644 index 000000000..6c7afa2c7 --- /dev/null +++ b/docs/reference/api/IndicesAnalyzeTokenDetail.md @@ -0,0 +1,6 @@ +## Interface `IndicesAnalyzeTokenDetail` + +| Name | Type | Description | +| - | - | - | +| `name` | string |   | +| `tokens` | [IndicesAnalyzeExplainAnalyzeToken](./IndicesAnalyzeExplainAnalyzeToken.md)[] |   | diff --git a/docs/reference/api/IndicesCacheQueries.md b/docs/reference/api/IndicesCacheQueries.md new file mode 100644 index 000000000..1f2869a06 --- /dev/null +++ b/docs/reference/api/IndicesCacheQueries.md @@ -0,0 +1,5 @@ +## Interface `IndicesCacheQueries` + +| Name | Type | Description | +| - | - | - | +| `enabled` | boolean |   | diff --git a/docs/reference/api/IndicesCancelMigrateReindexRequest.md b/docs/reference/api/IndicesCancelMigrateReindexRequest.md new file mode 100644 index 000000000..3b4ee3f8a --- /dev/null +++ b/docs/reference/api/IndicesCancelMigrateReindexRequest.md @@ -0,0 +1,7 @@ +## Interface `IndicesCancelMigrateReindexRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { index?: never; }) | All values in `body` will be added to the request body. | +| `index` | [Indices](./Indices.md) | The index or data stream name | +| `querystring` | { [key: string]: any; } & { index?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/IndicesCancelMigrateReindexResponse.md b/docs/reference/api/IndicesCancelMigrateReindexResponse.md new file mode 100644 index 000000000..4400f14aa --- /dev/null +++ b/docs/reference/api/IndicesCancelMigrateReindexResponse.md @@ -0,0 +1,4 @@ +## `IndicesCancelMigrateReindexResponse` +::: +type IndicesCancelMigrateReindexResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); +::: diff --git a/docs/reference/api/IndicesClearCacheRequest.md b/docs/reference/api/IndicesClearCacheRequest.md new file mode 100644 index 000000000..d3b5c0f8f --- /dev/null +++ b/docs/reference/api/IndicesClearCacheRequest.md @@ -0,0 +1,14 @@ +## Interface `IndicesClearCacheRequest` + +| Name | Type | Description | +| - | - | - | +| `allow_no_indices` | boolean | If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. | +| `body` | string | ({ [key: string]: any; } & { index?: never; allow_no_indices?: never; expand_wildcards?: never; fielddata?: never; fields?: never; ignore_unavailable?: never; query?: never; request?: never; }) | All values in `body` will be added to the request body. | +| `expand_wildcards` | [ExpandWildcards](./ExpandWildcards.md) | Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. | +| `fielddata` | boolean | If `true`, clears the fields cache. Use the `fields` parameter to clear the cache of specific fields only. | +| `fields` | [Fields](./Fields.md) | Comma-separated list of field names used to limit the `fielddata` parameter. | +| `ignore_unavailable` | boolean | If `false`, the request returns an error if it targets a missing or closed index. | +| `index` | [Indices](./Indices.md) | Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards ( `*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. | +| `query` | boolean | If `true`, clears the query cache. | +| `querystring` | { [key: string]: any; } & { index?: never; allow_no_indices?: never; expand_wildcards?: never; fielddata?: never; fields?: never; ignore_unavailable?: never; query?: never; request?: never; } | All values in `querystring` will be added to the request querystring. | +| `request` | boolean | If `true`, clears the request cache. | diff --git a/docs/reference/api/IndicesClearCacheResponse.md b/docs/reference/api/IndicesClearCacheResponse.md new file mode 100644 index 000000000..7f84c9895 --- /dev/null +++ b/docs/reference/api/IndicesClearCacheResponse.md @@ -0,0 +1,4 @@ +## `IndicesClearCacheResponse` +::: +type IndicesClearCacheResponse = [ShardsOperationResponseBase](./ShardsOperationResponseBase.md); +::: diff --git a/docs/reference/api/IndicesCloneRequest.md b/docs/reference/api/IndicesCloneRequest.md new file mode 100644 index 000000000..77fbf1ddf --- /dev/null +++ b/docs/reference/api/IndicesCloneRequest.md @@ -0,0 +1,13 @@ +## Interface `IndicesCloneRequest` + +| Name | Type | Description | +| - | - | - | +| `aliases` | Record<[IndexName](./IndexName.md), [IndicesAlias](./IndicesAlias.md)> | Aliases for the resulting index. | +| `body` | string | ({ [key: string]: any; } & { index?: never; target?: never; master_timeout?: never; timeout?: never; wait_for_active_shards?: never; aliases?: never; settings?: never; }) | All values in `body` will be added to the request body. | +| `index` | [IndexName](./IndexName.md) | Name of the source index to clone. | +| `master_timeout` | [Duration](./Duration.md) | Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. | +| `querystring` | { [key: string]: any; } & { index?: never; target?: never; master_timeout?: never; timeout?: never; wait_for_active_shards?: never; aliases?: never; settings?: never; } | All values in `querystring` will be added to the request querystring. | +| `settings` | Record | Configuration options for the target index. | +| `target` | [Name](./Name.md) | Name of the target index to create. | +| `timeout` | [Duration](./Duration.md) | Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. | +| `wait_for_active_shards` | [WaitForActiveShards](./WaitForActiveShards.md) | The number of shard copies that must be active before proceeding with the operation. Set to `all` or any positive integer up to the total number of shards in the index ( `number_of_replicas+1`). | diff --git a/docs/reference/api/IndicesCloneResponse.md b/docs/reference/api/IndicesCloneResponse.md new file mode 100644 index 000000000..6b10e5a56 --- /dev/null +++ b/docs/reference/api/IndicesCloneResponse.md @@ -0,0 +1,7 @@ +## Interface `IndicesCloneResponse` + +| Name | Type | Description | +| - | - | - | +| `acknowledged` | boolean |   | +| `index` | [IndexName](./IndexName.md) |   | +| `shards_acknowledged` | boolean |   | diff --git a/docs/reference/api/IndicesCloseCloseIndexResult.md b/docs/reference/api/IndicesCloseCloseIndexResult.md new file mode 100644 index 000000000..411ab4cb3 --- /dev/null +++ b/docs/reference/api/IndicesCloseCloseIndexResult.md @@ -0,0 +1,6 @@ +## Interface `IndicesCloseCloseIndexResult` + +| Name | Type | Description | +| - | - | - | +| `closed` | boolean |   | +| `shards` | Record |   | diff --git a/docs/reference/api/IndicesCloseCloseShardResult.md b/docs/reference/api/IndicesCloseCloseShardResult.md new file mode 100644 index 000000000..3e076a469 --- /dev/null +++ b/docs/reference/api/IndicesCloseCloseShardResult.md @@ -0,0 +1,5 @@ +## Interface `IndicesCloseCloseShardResult` + +| Name | Type | Description | +| - | - | - | +| `failures` | [ShardFailure](./ShardFailure.md)[] |   | diff --git a/docs/reference/api/IndicesCloseRequest.md b/docs/reference/api/IndicesCloseRequest.md new file mode 100644 index 000000000..455bcd46e --- /dev/null +++ b/docs/reference/api/IndicesCloseRequest.md @@ -0,0 +1,13 @@ +## Interface `IndicesCloseRequest` + +| Name | Type | Description | +| - | - | - | +| `allow_no_indices` | boolean | If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. | +| `body` | string | ({ [key: string]: any; } & { index?: never; allow_no_indices?: never; expand_wildcards?: never; ignore_unavailable?: never; master_timeout?: never; timeout?: never; wait_for_active_shards?: never; }) | All values in `body` will be added to the request body. | +| `expand_wildcards` | [ExpandWildcards](./ExpandWildcards.md) | Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. | +| `ignore_unavailable` | boolean | If `false`, the request returns an error if it targets a missing or closed index. | +| `index` | [Indices](./Indices.md) | Comma-separated list or wildcard expression of index names used to limit the request. | +| `master_timeout` | [Duration](./Duration.md) | Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. | +| `querystring` | { [key: string]: any; } & { index?: never; allow_no_indices?: never; expand_wildcards?: never; ignore_unavailable?: never; master_timeout?: never; timeout?: never; wait_for_active_shards?: never; } | All values in `querystring` will be added to the request querystring. | +| `timeout` | [Duration](./Duration.md) | Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. | +| `wait_for_active_shards` | [WaitForActiveShards](./WaitForActiveShards.md) | The number of shard copies that must be active before proceeding with the operation. Set to `all` or any positive integer up to the total number of shards in the index ( `number_of_replicas+1`). | diff --git a/docs/reference/api/IndicesCloseResponse.md b/docs/reference/api/IndicesCloseResponse.md new file mode 100644 index 000000000..1fe3cd022 --- /dev/null +++ b/docs/reference/api/IndicesCloseResponse.md @@ -0,0 +1,7 @@ +## Interface `IndicesCloseResponse` + +| Name | Type | Description | +| - | - | - | +| `acknowledged` | boolean |   | +| `indices` | Record<[IndexName](./IndexName.md), [IndicesCloseCloseIndexResult](./IndicesCloseCloseIndexResult.md)> |   | +| `shards_acknowledged` | boolean |   | diff --git a/docs/reference/api/IndicesCreateDataStreamRequest.md b/docs/reference/api/IndicesCreateDataStreamRequest.md new file mode 100644 index 000000000..5f7c0bba3 --- /dev/null +++ b/docs/reference/api/IndicesCreateDataStreamRequest.md @@ -0,0 +1,9 @@ +## Interface `IndicesCreateDataStreamRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { name?: never; master_timeout?: never; timeout?: never; }) | All values in `body` will be added to the request body. | +| `master_timeout` | [Duration](./Duration.md) | Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. | +| `name` | [DataStreamName](./DataStreamName.md) | Name of the data stream, which must meet the following criteria: Lowercase only; Cannot include `\`, `/`, `*`, `?`, `"`, `<`, `>`, `|`, `,`, `#`, `:`, or a space character; Cannot start with `-`, `_`, `+`, or `.ds-`; Cannot be `.` or `..`; Cannot be longer than 255 bytes. Multi-byte characters count towards this limit faster. | +| `querystring` | { [key: string]: any; } & { name?: never; master_timeout?: never; timeout?: never; } | All values in `querystring` will be added to the request querystring. | +| `timeout` | [Duration](./Duration.md) | Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. | diff --git a/docs/reference/api/IndicesCreateDataStreamResponse.md b/docs/reference/api/IndicesCreateDataStreamResponse.md new file mode 100644 index 000000000..a3878b37f --- /dev/null +++ b/docs/reference/api/IndicesCreateDataStreamResponse.md @@ -0,0 +1,4 @@ +## `IndicesCreateDataStreamResponse` +::: +type IndicesCreateDataStreamResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); +::: diff --git a/docs/reference/api/IndicesCreateFromCreateFrom.md b/docs/reference/api/IndicesCreateFromCreateFrom.md new file mode 100644 index 000000000..e4d66706e --- /dev/null +++ b/docs/reference/api/IndicesCreateFromCreateFrom.md @@ -0,0 +1,7 @@ +## Interface `IndicesCreateFromCreateFrom` + +| Name | Type | Description | +| - | - | - | +| `mappings_override` | [MappingTypeMapping](./MappingTypeMapping.md) | Mappings overrides to be applied to the destination index (optional) | +| `remove_index_blocks` | boolean | If index blocks should be removed when creating destination index (optional) | +| `settings_override` | [IndicesIndexSettings](./IndicesIndexSettings.md) | Settings overrides to be applied to the destination index (optional) | diff --git a/docs/reference/api/IndicesCreateFromRequest.md b/docs/reference/api/IndicesCreateFromRequest.md new file mode 100644 index 000000000..0b7911190 --- /dev/null +++ b/docs/reference/api/IndicesCreateFromRequest.md @@ -0,0 +1,9 @@ +## Interface `IndicesCreateFromRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { source?: never; dest?: never; create_from?: never; }) | All values in `body` will be added to the request body. | +| `create_from` | [IndicesCreateFromCreateFrom](./IndicesCreateFromCreateFrom.md) |   | +| `dest` | [IndexName](./IndexName.md) | The destination index or data stream name | +| `querystring` | { [key: string]: any; } & { source?: never; dest?: never; create_from?: never; } | All values in `querystring` will be added to the request querystring. | +| `source` | [IndexName](./IndexName.md) | The source index or data stream name | diff --git a/docs/reference/api/IndicesCreateFromResponse.md b/docs/reference/api/IndicesCreateFromResponse.md new file mode 100644 index 000000000..a6109d74c --- /dev/null +++ b/docs/reference/api/IndicesCreateFromResponse.md @@ -0,0 +1,7 @@ +## Interface `IndicesCreateFromResponse` + +| Name | Type | Description | +| - | - | - | +| `acknowledged` | boolean |   | +| `index` | [IndexName](./IndexName.md) |   | +| `shards_acknowledged` | boolean |   | diff --git a/docs/reference/api/IndicesCreateRequest.md b/docs/reference/api/IndicesCreateRequest.md new file mode 100644 index 000000000..6f92ad3ae --- /dev/null +++ b/docs/reference/api/IndicesCreateRequest.md @@ -0,0 +1,13 @@ +## Interface `IndicesCreateRequest` + +| Name | Type | Description | +| - | - | - | +| `aliases` | Record<[Name](./Name.md), [IndicesAlias](./IndicesAlias.md)> | Aliases for the index. | +| `body` | string | ({ [key: string]: any; } & { index?: never; master_timeout?: never; timeout?: never; wait_for_active_shards?: never; aliases?: never; mappings?: never; settings?: never; }) | All values in `body` will be added to the request body. | +| `index` | [IndexName](./IndexName.md) | Name of the index you wish to create. Index names must meet the following criteria: * Lowercase only * Cannot include `\`, `/`, `*`, `?`, `"`, `<`, `>`, `|`, ` ` (space character), `,`, or `#` * Indices prior to 7.0 could contain a colon ( `:`), but that has been deprecated and will not be supported in later versions * Cannot start with `-`, `_`, or `+` * Cannot be `.` or `..` * Cannot be longer than 255 bytes (note thtat it is bytes, so multi-byte characters will reach the limit faster) * Names starting with `.` are deprecated, except for hidden indices and internal indices managed by plugins | +| `mappings` | [MappingTypeMapping](./MappingTypeMapping.md) | Mapping for fields in the index. If specified, this mapping can include: - Field names - Field data types - Mapping parameters | +| `master_timeout` | [Duration](./Duration.md) | Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. | +| `querystring` | { [key: string]: any; } & { index?: never; master_timeout?: never; timeout?: never; wait_for_active_shards?: never; aliases?: never; mappings?: never; settings?: never; } | All values in `querystring` will be added to the request querystring. | +| `settings` | [IndicesIndexSettings](./IndicesIndexSettings.md) | Configuration options for the index. | +| `timeout` | [Duration](./Duration.md) | Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. | +| `wait_for_active_shards` | [WaitForActiveShards](./WaitForActiveShards.md) | The number of shard copies that must be active before proceeding with the operation. Set to `all` or any positive integer up to the total number of shards in the index ( `number_of_replicas+1`). | diff --git a/docs/reference/api/IndicesCreateResponse.md b/docs/reference/api/IndicesCreateResponse.md new file mode 100644 index 000000000..7fde4b3ab --- /dev/null +++ b/docs/reference/api/IndicesCreateResponse.md @@ -0,0 +1,7 @@ +## Interface `IndicesCreateResponse` + +| Name | Type | Description | +| - | - | - | +| `acknowledged` | boolean |   | +| `index` | [IndexName](./IndexName.md) |   | +| `shards_acknowledged` | boolean |   | diff --git a/docs/reference/api/IndicesDataStream.md b/docs/reference/api/IndicesDataStream.md new file mode 100644 index 000000000..278775db4 --- /dev/null +++ b/docs/reference/api/IndicesDataStream.md @@ -0,0 +1,22 @@ +## Interface `IndicesDataStream` + +| Name | Type | Description | +| - | - | - | +| `_meta` | [Metadata](./Metadata.md) | Custom metadata for the stream, copied from the `_meta` object of the stream’s matching index template. If empty, the response omits this property. | +| `allow_custom_routing` | boolean | If `true`, the data stream allows custom routing on write request. | +| `failure_store` | [IndicesFailureStore](./IndicesFailureStore.md) | Information about failure store backing indices | +| `generation` | [integer](./integer.md) | Current generation for the data stream. This number acts as a cumulative count of the stream’s rollovers, starting at 1. | +| `hidden` | boolean | If `true`, the data stream is hidden. | +| `ilm_policy` | [Name](./Name.md) | Name of the current ILM lifecycle policy in the stream’s matching index template. This lifecycle policy is set in the `index.lifecycle.name` setting. If the template does not include a lifecycle policy, this property is not included in the response. NOTE: A data stream’s backing indices may be assigned different lifecycle policies. To retrieve the lifecycle policy for individual backing indices, use the get index settings API. | +| `index_mode` | [IndicesIndexMode](./IndicesIndexMode.md) | The index mode for the data stream that will be used for newly created backing indices. | +| `indices` | [IndicesDataStreamIndex](./IndicesDataStreamIndex.md)[] | Array of objects containing information about the data stream’s backing indices. The last item in this array contains information about the stream’s current write index. | +| `lifecycle` | [IndicesDataStreamLifecycleWithRollover](./IndicesDataStreamLifecycleWithRollover.md) | Contains the configuration for the data stream lifecycle of this data stream. | +| `name` | [DataStreamName](./DataStreamName.md) | Name of the data stream. | +| `next_generation_managed_by` | [IndicesManagedBy](./IndicesManagedBy.md) | Name of the lifecycle system that'll manage the next generation of the data stream. | +| `prefer_ilm` | boolean | Indicates if ILM should take precedence over DSL in case both are configured to managed this data stream. | +| `replicated` | boolean | If `true`, the data stream is created and managed by cross-cluster replication and the local cluster can not write into this data stream or change its mappings. | +| `rollover_on_write` | boolean | If `true`, the next write to this data stream will trigger a rollover first and the document will be indexed in the new backing index. If the rollover fails the indexing request will fail too. | +| `status` | [HealthStatus](./HealthStatus.md) | Health status of the data stream. This health status is based on the state of the primary and replica shards of the stream’s backing indices. | +| `system` | boolean | If `true`, the data stream is created and managed by an Elastic stack component and cannot be modified through normal user interaction. | +| `template` | [Name](./Name.md) | Name of the index template used to create the data stream’s backing indices. The template’s index pattern must match the name of this data stream. | +| `timestamp_field` | [IndicesDataStreamTimestampField](./IndicesDataStreamTimestampField.md) | Information about the `@timestamp` field in the data stream. | diff --git a/docs/reference/api/IndicesDataStreamIndex.md b/docs/reference/api/IndicesDataStreamIndex.md new file mode 100644 index 000000000..ca2f458cf --- /dev/null +++ b/docs/reference/api/IndicesDataStreamIndex.md @@ -0,0 +1,10 @@ +## Interface `IndicesDataStreamIndex` + +| Name | Type | Description | +| - | - | - | +| `ilm_policy` | [Name](./Name.md) | Name of the current ILM lifecycle policy configured for this backing index. | +| `index_mode` | [IndicesIndexMode](./IndicesIndexMode.md) | The index mode of this backing index of the data stream. | +| `index_name` | [IndexName](./IndexName.md) | Name of the backing index. | +| `index_uuid` | [Uuid](./Uuid.md) | Universally unique identifier (UUID) for the index. | +| `managed_by` | [IndicesManagedBy](./IndicesManagedBy.md) | Name of the lifecycle system that's currently managing this backing index. | +| `prefer_ilm` | boolean | Indicates if ILM should take precedence over DSL in case both are configured to manage this index. | diff --git a/docs/reference/api/IndicesDataStreamLifecycle.md b/docs/reference/api/IndicesDataStreamLifecycle.md new file mode 100644 index 000000000..5470b280a --- /dev/null +++ b/docs/reference/api/IndicesDataStreamLifecycle.md @@ -0,0 +1,7 @@ +## Interface `IndicesDataStreamLifecycle` + +| Name | Type | Description | +| - | - | - | +| `data_retention` | [Duration](./Duration.md) | If defined, every document added to this data stream will be stored at least for this time frame. Any time after this duration the document could be deleted. When empty, every document in this data stream will be stored indefinitely. | +| `downsampling` | [IndicesDataStreamLifecycleDownsampling](./IndicesDataStreamLifecycleDownsampling.md) | The downsampling configuration to execute for the managed backing index after rollover. | +| `enabled` | boolean | If defined, it turns data stream lifecycle on/off ( `true`/ `false`) for this data stream. A data stream lifecycle that's disabled (enabled: `false`) will have no effect on the data stream. | diff --git a/docs/reference/api/IndicesDataStreamLifecycleDownsampling.md b/docs/reference/api/IndicesDataStreamLifecycleDownsampling.md new file mode 100644 index 000000000..75571e8b7 --- /dev/null +++ b/docs/reference/api/IndicesDataStreamLifecycleDownsampling.md @@ -0,0 +1,5 @@ +## Interface `IndicesDataStreamLifecycleDownsampling` + +| Name | Type | Description | +| - | - | - | +| `rounds` | [IndicesDownsamplingRound](./IndicesDownsamplingRound.md)[] | The list of downsampling rounds to execute as part of this downsampling configuration | diff --git a/docs/reference/api/IndicesDataStreamLifecycleRolloverConditions.md b/docs/reference/api/IndicesDataStreamLifecycleRolloverConditions.md new file mode 100644 index 000000000..78cc670b3 --- /dev/null +++ b/docs/reference/api/IndicesDataStreamLifecycleRolloverConditions.md @@ -0,0 +1,14 @@ +## Interface `IndicesDataStreamLifecycleRolloverConditions` + +| Name | Type | Description | +| - | - | - | +| `max_age` | string |   | +| `max_docs` | [long](./long.md) |   | +| `max_primary_shard_docs` | [long](./long.md) |   | +| `max_primary_shard_size` | [ByteSize](./ByteSize.md) |   | +| `max_size` | [ByteSize](./ByteSize.md) |   | +| `min_age` | [Duration](./Duration.md) |   | +| `min_docs` | [long](./long.md) |   | +| `min_primary_shard_docs` | [long](./long.md) |   | +| `min_primary_shard_size` | [ByteSize](./ByteSize.md) |   | +| `min_size` | [ByteSize](./ByteSize.md) |   | diff --git a/docs/reference/api/IndicesDataStreamLifecycleWithRollover.md b/docs/reference/api/IndicesDataStreamLifecycleWithRollover.md new file mode 100644 index 000000000..e1e761d80 --- /dev/null +++ b/docs/reference/api/IndicesDataStreamLifecycleWithRollover.md @@ -0,0 +1,5 @@ +## Interface `IndicesDataStreamLifecycleWithRollover` + +| Name | Type | Description | +| - | - | - | +| `rollover` | [IndicesDataStreamLifecycleRolloverConditions](./IndicesDataStreamLifecycleRolloverConditions.md) | The conditions which will trigger the rollover of a backing index as configured by the cluster setting `cluster.lifecycle.default.rollover`. This property is an implementation detail and it will only be retrieved when the query param `include_defaults` is set to true. The contents of this field are subject to change. | diff --git a/docs/reference/api/IndicesDataStreamTimestampField.md b/docs/reference/api/IndicesDataStreamTimestampField.md new file mode 100644 index 000000000..83cf29de5 --- /dev/null +++ b/docs/reference/api/IndicesDataStreamTimestampField.md @@ -0,0 +1,5 @@ +## Interface `IndicesDataStreamTimestampField` + +| Name | Type | Description | +| - | - | - | +| `name` | [Field](./Field.md) | Name of the timestamp field for the data stream, which must be `@timestamp`. The `@timestamp` field must be included in every document indexed to the data stream. | diff --git a/docs/reference/api/IndicesDataStreamVisibility.md b/docs/reference/api/IndicesDataStreamVisibility.md new file mode 100644 index 000000000..63aeb9025 --- /dev/null +++ b/docs/reference/api/IndicesDataStreamVisibility.md @@ -0,0 +1,6 @@ +## Interface `IndicesDataStreamVisibility` + +| Name | Type | Description | +| - | - | - | +| `allow_custom_routing` | boolean |   | +| `hidden` | boolean |   | diff --git a/docs/reference/api/IndicesDataStreamsStatsDataStreamsStatsItem.md b/docs/reference/api/IndicesDataStreamsStatsDataStreamsStatsItem.md new file mode 100644 index 000000000..e4f23b012 --- /dev/null +++ b/docs/reference/api/IndicesDataStreamsStatsDataStreamsStatsItem.md @@ -0,0 +1,9 @@ +## Interface `IndicesDataStreamsStatsDataStreamsStatsItem` + +| Name | Type | Description | +| - | - | - | +| `backing_indices` | [integer](./integer.md) | Current number of backing indices for the data stream. | +| `data_stream` | [Name](./Name.md) | Name of the data stream. | +| `maximum_timestamp` | [EpochTime](./EpochTime.md)<[UnitMillis](./UnitMillis.md)> | The data stream’s highest `@timestamp` value, converted to milliseconds since the Unix epoch. NOTE: This timestamp is provided as a best effort. The data stream may contain `@timestamp` values higher than this if one or more of the following conditions are met: The stream contains closed backing indices; Backing indices with a lower generation contain higher `@timestamp` values. | +| `store_size_bytes` | [long](./long.md) | Total size, in bytes, of all shards for the data stream’s backing indices. | +| `store_size` | [ByteSize](./ByteSize.md) | Total size of all shards for the data stream’s backing indices. This parameter is only returned if the `human` query parameter is `true`. | diff --git a/docs/reference/api/IndicesDataStreamsStatsRequest.md b/docs/reference/api/IndicesDataStreamsStatsRequest.md new file mode 100644 index 000000000..6a3dcdc35 --- /dev/null +++ b/docs/reference/api/IndicesDataStreamsStatsRequest.md @@ -0,0 +1,8 @@ +## Interface `IndicesDataStreamsStatsRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { name?: never; expand_wildcards?: never; }) | All values in `body` will be added to the request body. | +| `expand_wildcards` | [ExpandWildcards](./ExpandWildcards.md) | Type of data stream that wildcard patterns can match. Supports comma-separated values, such as `open,hidden`. | +| `name` | [IndexName](./IndexName.md) | Comma-separated list of data streams used to limit the request. Wildcard expressions ( `*`) are supported. To target all data streams in a cluster, omit this parameter or use `*`. | +| `querystring` | { [key: string]: any; } & { name?: never; expand_wildcards?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/IndicesDataStreamsStatsResponse.md b/docs/reference/api/IndicesDataStreamsStatsResponse.md new file mode 100644 index 000000000..3f09cf17c --- /dev/null +++ b/docs/reference/api/IndicesDataStreamsStatsResponse.md @@ -0,0 +1,10 @@ +## Interface `IndicesDataStreamsStatsResponse` + +| Name | Type | Description | +| - | - | - | +| `_shards` | [ShardStatistics](./ShardStatistics.md) | Contains information about shards that attempted to execute the request. | +| `backing_indices` | [integer](./integer.md) | Total number of backing indices for the selected data streams. | +| `data_stream_count` | [integer](./integer.md) | Total number of selected data streams. | +| `data_streams` | [IndicesDataStreamsStatsDataStreamsStatsItem](./IndicesDataStreamsStatsDataStreamsStatsItem.md)[] | Contains statistics for the selected data streams. | +| `total_store_size_bytes` | [long](./long.md) | Total size, in bytes, of all shards for the selected data streams. | +| `total_store_sizes` | [ByteSize](./ByteSize.md) | Total size of all shards for the selected data streams. This property is included only if the `human` query parameter is `true` | diff --git a/docs/reference/api/IndicesDeleteAliasRequest.md b/docs/reference/api/IndicesDeleteAliasRequest.md new file mode 100644 index 000000000..1a595d979 --- /dev/null +++ b/docs/reference/api/IndicesDeleteAliasRequest.md @@ -0,0 +1,10 @@ +## Interface `IndicesDeleteAliasRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { index?: never; name?: never; master_timeout?: never; timeout?: never; }) | All values in `body` will be added to the request body. | +| `index` | [Indices](./Indices.md) | Comma-separated list of data streams or indices used to limit the request. Supports wildcards ( `*`). | +| `master_timeout` | [Duration](./Duration.md) | Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. | +| `name` | [Names](./Names.md) | Comma-separated list of aliases to remove. Supports wildcards ( `*`). To remove all aliases, use `*` or `_all`. | +| `querystring` | { [key: string]: any; } & { index?: never; name?: never; master_timeout?: never; timeout?: never; } | All values in `querystring` will be added to the request querystring. | +| `timeout` | [Duration](./Duration.md) | Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. | diff --git a/docs/reference/api/IndicesDeleteAliasResponse.md b/docs/reference/api/IndicesDeleteAliasResponse.md new file mode 100644 index 000000000..c074f4d05 --- /dev/null +++ b/docs/reference/api/IndicesDeleteAliasResponse.md @@ -0,0 +1,4 @@ +## `IndicesDeleteAliasResponse` +::: +type IndicesDeleteAliasResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); +::: diff --git a/docs/reference/api/IndicesDeleteDataLifecycleRequest.md b/docs/reference/api/IndicesDeleteDataLifecycleRequest.md new file mode 100644 index 000000000..dfcbc592c --- /dev/null +++ b/docs/reference/api/IndicesDeleteDataLifecycleRequest.md @@ -0,0 +1,10 @@ +## Interface `IndicesDeleteDataLifecycleRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { name?: never; expand_wildcards?: never; master_timeout?: never; timeout?: never; }) | All values in `body` will be added to the request body. | +| `expand_wildcards` | [ExpandWildcards](./ExpandWildcards.md) | Whether wildcard expressions should get expanded to open or closed indices (default: open) | +| `master_timeout` | [Duration](./Duration.md) | Specify timeout for connection to master | +| `name` | [DataStreamNames](./DataStreamNames.md) | A comma-separated list of data streams of which the data stream lifecycle will be deleted; use `*` to get all data streams | +| `querystring` | { [key: string]: any; } & { name?: never; expand_wildcards?: never; master_timeout?: never; timeout?: never; } | All values in `querystring` will be added to the request querystring. | +| `timeout` | [Duration](./Duration.md) | Explicit timestamp for the document | diff --git a/docs/reference/api/IndicesDeleteDataLifecycleResponse.md b/docs/reference/api/IndicesDeleteDataLifecycleResponse.md new file mode 100644 index 000000000..36c26832e --- /dev/null +++ b/docs/reference/api/IndicesDeleteDataLifecycleResponse.md @@ -0,0 +1,4 @@ +## `IndicesDeleteDataLifecycleResponse` +::: +type IndicesDeleteDataLifecycleResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); +::: diff --git a/docs/reference/api/IndicesDeleteDataStreamRequest.md b/docs/reference/api/IndicesDeleteDataStreamRequest.md new file mode 100644 index 000000000..741fa3bb8 --- /dev/null +++ b/docs/reference/api/IndicesDeleteDataStreamRequest.md @@ -0,0 +1,9 @@ +## Interface `IndicesDeleteDataStreamRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { name?: never; master_timeout?: never; expand_wildcards?: never; }) | All values in `body` will be added to the request body. | +| `expand_wildcards` | [ExpandWildcards](./ExpandWildcards.md) | Type of data stream that wildcard patterns can match. Supports comma-separated values,such as `open,hidden`. | +| `master_timeout` | [Duration](./Duration.md) | Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. | +| `name` | [DataStreamNames](./DataStreamNames.md) | Comma-separated list of data streams to delete. Wildcard ( `*`) expressions are supported. | +| `querystring` | { [key: string]: any; } & { name?: never; master_timeout?: never; expand_wildcards?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/IndicesDeleteDataStreamResponse.md b/docs/reference/api/IndicesDeleteDataStreamResponse.md new file mode 100644 index 000000000..d42ccd1de --- /dev/null +++ b/docs/reference/api/IndicesDeleteDataStreamResponse.md @@ -0,0 +1,4 @@ +## `IndicesDeleteDataStreamResponse` +::: +type IndicesDeleteDataStreamResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); +::: diff --git a/docs/reference/api/IndicesDeleteIndexTemplateRequest.md b/docs/reference/api/IndicesDeleteIndexTemplateRequest.md new file mode 100644 index 000000000..c7b8f0116 --- /dev/null +++ b/docs/reference/api/IndicesDeleteIndexTemplateRequest.md @@ -0,0 +1,9 @@ +## Interface `IndicesDeleteIndexTemplateRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { name?: never; master_timeout?: never; timeout?: never; }) | All values in `body` will be added to the request body. | +| `master_timeout` | [Duration](./Duration.md) | Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. | +| `name` | [Names](./Names.md) | Comma-separated list of index template names used to limit the request. Wildcard (*) expressions are supported. | +| `querystring` | { [key: string]: any; } & { name?: never; master_timeout?: never; timeout?: never; } | All values in `querystring` will be added to the request querystring. | +| `timeout` | [Duration](./Duration.md) | Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. | diff --git a/docs/reference/api/IndicesDeleteIndexTemplateResponse.md b/docs/reference/api/IndicesDeleteIndexTemplateResponse.md new file mode 100644 index 000000000..32604b0fb --- /dev/null +++ b/docs/reference/api/IndicesDeleteIndexTemplateResponse.md @@ -0,0 +1,4 @@ +## `IndicesDeleteIndexTemplateResponse` +::: +type IndicesDeleteIndexTemplateResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); +::: diff --git a/docs/reference/api/IndicesDeleteRequest.md b/docs/reference/api/IndicesDeleteRequest.md new file mode 100644 index 000000000..20c8da195 --- /dev/null +++ b/docs/reference/api/IndicesDeleteRequest.md @@ -0,0 +1,12 @@ +## Interface `IndicesDeleteRequest` + +| Name | Type | Description | +| - | - | - | +| `allow_no_indices` | boolean | If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. | +| `body` | string | ({ [key: string]: any; } & { index?: never; allow_no_indices?: never; expand_wildcards?: never; ignore_unavailable?: never; master_timeout?: never; timeout?: never; }) | All values in `body` will be added to the request body. | +| `expand_wildcards` | [ExpandWildcards](./ExpandWildcards.md) | Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. | +| `ignore_unavailable` | boolean | If `false`, the request returns an error if it targets a missing or closed index. | +| `index` | [Indices](./Indices.md) | Comma-separated list of indices to delete. You cannot specify index aliases. By default, this parameter does not support wildcards ( `*`) or `_all`. To use wildcards or `_all`, set the `action.destructive_requires_name` cluster setting to `false`. | +| `master_timeout` | [Duration](./Duration.md) | Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. | +| `querystring` | { [key: string]: any; } & { index?: never; allow_no_indices?: never; expand_wildcards?: never; ignore_unavailable?: never; master_timeout?: never; timeout?: never; } | All values in `querystring` will be added to the request querystring. | +| `timeout` | [Duration](./Duration.md) | Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. | diff --git a/docs/reference/api/IndicesDeleteResponse.md b/docs/reference/api/IndicesDeleteResponse.md new file mode 100644 index 000000000..38306e11c --- /dev/null +++ b/docs/reference/api/IndicesDeleteResponse.md @@ -0,0 +1,4 @@ +## `IndicesDeleteResponse` +::: +type IndicesDeleteResponse = [IndicesResponseBase](./IndicesResponseBase.md); +::: diff --git a/docs/reference/api/IndicesDeleteTemplateRequest.md b/docs/reference/api/IndicesDeleteTemplateRequest.md new file mode 100644 index 000000000..ccbfffb58 --- /dev/null +++ b/docs/reference/api/IndicesDeleteTemplateRequest.md @@ -0,0 +1,9 @@ +## Interface `IndicesDeleteTemplateRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { name?: never; master_timeout?: never; timeout?: never; }) | All values in `body` will be added to the request body. | +| `master_timeout` | [Duration](./Duration.md) | Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. | +| `name` | [Name](./Name.md) | The name of the legacy index template to delete. Wildcard ( `*`) expressions are supported. | +| `querystring` | { [key: string]: any; } & { name?: never; master_timeout?: never; timeout?: never; } | All values in `querystring` will be added to the request querystring. | +| `timeout` | [Duration](./Duration.md) | Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. | diff --git a/docs/reference/api/IndicesDeleteTemplateResponse.md b/docs/reference/api/IndicesDeleteTemplateResponse.md new file mode 100644 index 000000000..f20fcbb94 --- /dev/null +++ b/docs/reference/api/IndicesDeleteTemplateResponse.md @@ -0,0 +1,4 @@ +## `IndicesDeleteTemplateResponse` +::: +type IndicesDeleteTemplateResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); +::: diff --git a/docs/reference/api/IndicesDiskUsageRequest.md b/docs/reference/api/IndicesDiskUsageRequest.md new file mode 100644 index 000000000..b63be1c3b --- /dev/null +++ b/docs/reference/api/IndicesDiskUsageRequest.md @@ -0,0 +1,12 @@ +## Interface `IndicesDiskUsageRequest` + +| Name | Type | Description | +| - | - | - | +| `allow_no_indices` | boolean | If false, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. | +| `body` | string | ({ [key: string]: any; } & { index?: never; allow_no_indices?: never; expand_wildcards?: never; flush?: never; ignore_unavailable?: never; run_expensive_tasks?: never; }) | All values in `body` will be added to the request body. | +| `expand_wildcards` | [ExpandWildcards](./ExpandWildcards.md) | Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. | +| `flush` | boolean | If `true`, the API performs a flush before analysis. If `false`, the response may not include uncommitted data. | +| `ignore_unavailable` | boolean | If `true`, missing or closed indices are not included in the response. | +| `index` | [Indices](./Indices.md) | Comma-separated list of data streams, indices, and aliases used to limit the request. It’s recommended to execute this API with a single index (or the latest backing index of a data stream) as the API consumes resources significantly. | +| `querystring` | { [key: string]: any; } & { index?: never; allow_no_indices?: never; expand_wildcards?: never; flush?: never; ignore_unavailable?: never; run_expensive_tasks?: never; } | All values in `querystring` will be added to the request querystring. | +| `run_expensive_tasks` | boolean | Analyzing field disk usage is resource-intensive. To use the API, this parameter must be set to `true`. | diff --git a/docs/reference/api/IndicesDiskUsageResponse.md b/docs/reference/api/IndicesDiskUsageResponse.md new file mode 100644 index 000000000..72c2e669b --- /dev/null +++ b/docs/reference/api/IndicesDiskUsageResponse.md @@ -0,0 +1,4 @@ +## `IndicesDiskUsageResponse` +::: +type IndicesDiskUsageResponse = any; +::: diff --git a/docs/reference/api/IndicesDownsampleConfig.md b/docs/reference/api/IndicesDownsampleConfig.md new file mode 100644 index 000000000..a61c8879f --- /dev/null +++ b/docs/reference/api/IndicesDownsampleConfig.md @@ -0,0 +1,5 @@ +## Interface `IndicesDownsampleConfig` + +| Name | Type | Description | +| - | - | - | +| `fixed_interval` | [DurationLarge](./DurationLarge.md) | The interval at which to aggregate the original time series index. | diff --git a/docs/reference/api/IndicesDownsampleRequest.md b/docs/reference/api/IndicesDownsampleRequest.md new file mode 100644 index 000000000..c3f929ca9 --- /dev/null +++ b/docs/reference/api/IndicesDownsampleRequest.md @@ -0,0 +1,9 @@ +## Interface `IndicesDownsampleRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { index?: never; target_index?: never; config?: never; }) | All values in `body` will be added to the request body. | +| `config` | [IndicesDownsampleConfig](./IndicesDownsampleConfig.md) |   | +| `index` | [IndexName](./IndexName.md) | Name of the time series index to downsample. | +| `querystring` | { [key: string]: any; } & { index?: never; target_index?: never; config?: never; } | All values in `querystring` will be added to the request querystring. | +| `target_index` | [IndexName](./IndexName.md) | Name of the index to create. | diff --git a/docs/reference/api/IndicesDownsampleResponse.md b/docs/reference/api/IndicesDownsampleResponse.md new file mode 100644 index 000000000..df619f247 --- /dev/null +++ b/docs/reference/api/IndicesDownsampleResponse.md @@ -0,0 +1,4 @@ +## `IndicesDownsampleResponse` +::: +type IndicesDownsampleResponse = any; +::: diff --git a/docs/reference/api/IndicesDownsamplingRound.md b/docs/reference/api/IndicesDownsamplingRound.md new file mode 100644 index 000000000..d97366871 --- /dev/null +++ b/docs/reference/api/IndicesDownsamplingRound.md @@ -0,0 +1,6 @@ +## Interface `IndicesDownsamplingRound` + +| Name | Type | Description | +| - | - | - | +| `after` | [Duration](./Duration.md) | The duration since rollover when this downsampling round should execute | +| `config` | [IndicesDownsampleConfig](./IndicesDownsampleConfig.md) | The downsample configuration to execute. | diff --git a/docs/reference/api/IndicesExistsAliasRequest.md b/docs/reference/api/IndicesExistsAliasRequest.md new file mode 100644 index 000000000..abff5fb58 --- /dev/null +++ b/docs/reference/api/IndicesExistsAliasRequest.md @@ -0,0 +1,12 @@ +## Interface `IndicesExistsAliasRequest` + +| Name | Type | Description | +| - | - | - | +| `allow_no_indices` | boolean | If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. | +| `body` | string | ({ [key: string]: any; } & { name?: never; index?: never; allow_no_indices?: never; expand_wildcards?: never; ignore_unavailable?: never; master_timeout?: never; }) | All values in `body` will be added to the request body. | +| `expand_wildcards` | [ExpandWildcards](./ExpandWildcards.md) | Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. | +| `ignore_unavailable` | boolean | If `false`, requests that include a missing data stream or index in the target indices or data streams return an error. | +| `index` | [Indices](./Indices.md) | Comma-separated list of data streams or indices used to limit the request. Supports wildcards ( `*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. | +| `master_timeout` | [Duration](./Duration.md) | Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. | +| `name` | [Names](./Names.md) | Comma-separated list of aliases to check. Supports wildcards ( `*`). | +| `querystring` | { [key: string]: any; } & { name?: never; index?: never; allow_no_indices?: never; expand_wildcards?: never; ignore_unavailable?: never; master_timeout?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/IndicesExistsAliasResponse.md b/docs/reference/api/IndicesExistsAliasResponse.md new file mode 100644 index 000000000..bfd8d6c4d --- /dev/null +++ b/docs/reference/api/IndicesExistsAliasResponse.md @@ -0,0 +1,4 @@ +## `IndicesExistsAliasResponse` +::: +type IndicesExistsAliasResponse = boolean; +::: diff --git a/docs/reference/api/IndicesExistsIndexTemplateRequest.md b/docs/reference/api/IndicesExistsIndexTemplateRequest.md new file mode 100644 index 000000000..89f8361d2 --- /dev/null +++ b/docs/reference/api/IndicesExistsIndexTemplateRequest.md @@ -0,0 +1,10 @@ +## Interface `IndicesExistsIndexTemplateRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { name?: never; local?: never; flat_settings?: never; master_timeout?: never; }) | All values in `body` will be added to the request body. | +| `flat_settings` | boolean | If true, returns settings in flat format. | +| `local` | boolean | If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node. | +| `master_timeout` | [Duration](./Duration.md) | Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. | +| `name` | [Name](./Name.md) | Comma-separated list of index template names used to limit the request. Wildcard (*) expressions are supported. | +| `querystring` | { [key: string]: any; } & { name?: never; local?: never; flat_settings?: never; master_timeout?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/IndicesExistsIndexTemplateResponse.md b/docs/reference/api/IndicesExistsIndexTemplateResponse.md new file mode 100644 index 000000000..841a0d313 --- /dev/null +++ b/docs/reference/api/IndicesExistsIndexTemplateResponse.md @@ -0,0 +1,4 @@ +## `IndicesExistsIndexTemplateResponse` +::: +type IndicesExistsIndexTemplateResponse = boolean; +::: diff --git a/docs/reference/api/IndicesExistsRequest.md b/docs/reference/api/IndicesExistsRequest.md new file mode 100644 index 000000000..8181048a6 --- /dev/null +++ b/docs/reference/api/IndicesExistsRequest.md @@ -0,0 +1,13 @@ +## Interface `IndicesExistsRequest` + +| Name | Type | Description | +| - | - | - | +| `allow_no_indices` | boolean | If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. | +| `body` | string | ({ [key: string]: any; } & { index?: never; allow_no_indices?: never; expand_wildcards?: never; flat_settings?: never; ignore_unavailable?: never; include_defaults?: never; local?: never; }) | All values in `body` will be added to the request body. | +| `expand_wildcards` | [ExpandWildcards](./ExpandWildcards.md) | Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. | +| `flat_settings` | boolean | If `true`, returns settings in flat format. | +| `ignore_unavailable` | boolean | If `false`, the request returns an error if it targets a missing or closed index. | +| `include_defaults` | boolean | If `true`, return all default settings in the response. | +| `index` | [Indices](./Indices.md) | Comma-separated list of data streams, indices, and aliases. Supports wildcards ( `*`). | +| `local` | boolean | If `true`, the request retrieves information from the local node only. | +| `querystring` | { [key: string]: any; } & { index?: never; allow_no_indices?: never; expand_wildcards?: never; flat_settings?: never; ignore_unavailable?: never; include_defaults?: never; local?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/IndicesExistsResponse.md b/docs/reference/api/IndicesExistsResponse.md new file mode 100644 index 000000000..4da8d3ec1 --- /dev/null +++ b/docs/reference/api/IndicesExistsResponse.md @@ -0,0 +1,4 @@ +## `IndicesExistsResponse` +::: +type IndicesExistsResponse = boolean; +::: diff --git a/docs/reference/api/IndicesExistsTemplateRequest.md b/docs/reference/api/IndicesExistsTemplateRequest.md new file mode 100644 index 000000000..160b87179 --- /dev/null +++ b/docs/reference/api/IndicesExistsTemplateRequest.md @@ -0,0 +1,10 @@ +## Interface `IndicesExistsTemplateRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { name?: never; flat_settings?: never; local?: never; master_timeout?: never; }) | All values in `body` will be added to the request body. | +| `flat_settings` | boolean | Indicates whether to use a flat format for the response. | +| `local` | boolean | Indicates whether to get information from the local node only. | +| `master_timeout` | [Duration](./Duration.md) | The period to wait for the master node. If the master node is not available before the timeout expires, the request fails and returns an error. To indicate that the request should never timeout, set it to `-1`. | +| `name` | [Names](./Names.md) | A comma-separated list of index template names used to limit the request. Wildcard ( `*`) expressions are supported. | +| `querystring` | { [key: string]: any; } & { name?: never; flat_settings?: never; local?: never; master_timeout?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/IndicesExistsTemplateResponse.md b/docs/reference/api/IndicesExistsTemplateResponse.md new file mode 100644 index 000000000..8c2766bdd --- /dev/null +++ b/docs/reference/api/IndicesExistsTemplateResponse.md @@ -0,0 +1,4 @@ +## `IndicesExistsTemplateResponse` +::: +type IndicesExistsTemplateResponse = boolean; +::: diff --git a/docs/reference/api/IndicesExplainDataLifecycleDataStreamLifecycleExplain.md b/docs/reference/api/IndicesExplainDataLifecycleDataStreamLifecycleExplain.md new file mode 100644 index 000000000..2b9c96b20 --- /dev/null +++ b/docs/reference/api/IndicesExplainDataLifecycleDataStreamLifecycleExplain.md @@ -0,0 +1,13 @@ +## Interface `IndicesExplainDataLifecycleDataStreamLifecycleExplain` + +| Name | Type | Description | +| - | - | - | +| `error` | string |   | +| `generation_time` | [Duration](./Duration.md) |   | +| `index_creation_date_millis` | [EpochTime](./EpochTime.md)<[UnitMillis](./UnitMillis.md)> |   | +| `index` | [IndexName](./IndexName.md) |   | +| `lifecycle` | [IndicesDataStreamLifecycleWithRollover](./IndicesDataStreamLifecycleWithRollover.md) |   | +| `managed_by_lifecycle` | boolean |   | +| `rollover_date_millis` | [EpochTime](./EpochTime.md)<[UnitMillis](./UnitMillis.md)> |   | +| `time_since_index_creation` | [Duration](./Duration.md) |   | +| `time_since_rollover` | [Duration](./Duration.md) |   | diff --git a/docs/reference/api/IndicesExplainDataLifecycleRequest.md b/docs/reference/api/IndicesExplainDataLifecycleRequest.md new file mode 100644 index 000000000..591a82aaf --- /dev/null +++ b/docs/reference/api/IndicesExplainDataLifecycleRequest.md @@ -0,0 +1,9 @@ +## Interface `IndicesExplainDataLifecycleRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { index?: never; include_defaults?: never; master_timeout?: never; }) | All values in `body` will be added to the request body. | +| `include_defaults` | boolean | indicates if the API should return the default values the system uses for the index's lifecycle | +| `index` | [Indices](./Indices.md) | The name of the index to explain | +| `master_timeout` | [Duration](./Duration.md) | Specify timeout for connection to master | +| `querystring` | { [key: string]: any; } & { index?: never; include_defaults?: never; master_timeout?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/IndicesExplainDataLifecycleResponse.md b/docs/reference/api/IndicesExplainDataLifecycleResponse.md new file mode 100644 index 000000000..2d56252bd --- /dev/null +++ b/docs/reference/api/IndicesExplainDataLifecycleResponse.md @@ -0,0 +1,5 @@ +## Interface `IndicesExplainDataLifecycleResponse` + +| Name | Type | Description | +| - | - | - | +| `indices` | Record<[IndexName](./IndexName.md), [IndicesExplainDataLifecycleDataStreamLifecycleExplain](./IndicesExplainDataLifecycleDataStreamLifecycleExplain.md)> |   | diff --git a/docs/reference/api/IndicesFailureStore.md b/docs/reference/api/IndicesFailureStore.md new file mode 100644 index 000000000..3600aad54 --- /dev/null +++ b/docs/reference/api/IndicesFailureStore.md @@ -0,0 +1,7 @@ +## Interface `IndicesFailureStore` + +| Name | Type | Description | +| - | - | - | +| `enabled` | boolean |   | +| `indices` | [IndicesDataStreamIndex](./IndicesDataStreamIndex.md)[] |   | +| `rollover_on_write` | boolean |   | diff --git a/docs/reference/api/IndicesFieldUsageStatsFieldSummary.md b/docs/reference/api/IndicesFieldUsageStatsFieldSummary.md new file mode 100644 index 000000000..e807e44bd --- /dev/null +++ b/docs/reference/api/IndicesFieldUsageStatsFieldSummary.md @@ -0,0 +1,12 @@ +## Interface `IndicesFieldUsageStatsFieldSummary` + +| Name | Type | Description | +| - | - | - | +| `any` | [uint](./uint.md) |   | +| `doc_values` | [uint](./uint.md) |   | +| `inverted_index` | [IndicesFieldUsageStatsInvertedIndex](./IndicesFieldUsageStatsInvertedIndex.md) |   | +| `knn_vectors` | [uint](./uint.md) |   | +| `norms` | [uint](./uint.md) |   | +| `points` | [uint](./uint.md) |   | +| `stored_fields` | [uint](./uint.md) |   | +| `term_vectors` | [uint](./uint.md) |   | diff --git a/docs/reference/api/IndicesFieldUsageStatsFieldsUsageBody.md b/docs/reference/api/IndicesFieldUsageStatsFieldsUsageBody.md new file mode 100644 index 000000000..4ac997e9e --- /dev/null +++ b/docs/reference/api/IndicesFieldUsageStatsFieldsUsageBody.md @@ -0,0 +1,4 @@ +## `IndicesFieldUsageStatsFieldsUsageBody` +::: +type IndicesFieldUsageStatsFieldsUsageBody = [IndicesFieldUsageStatsFieldsUsageBodyKeys](./IndicesFieldUsageStatsFieldsUsageBodyKeys.md) & { [property: string]: [IndicesFieldUsageStatsUsageStatsIndex](./IndicesFieldUsageStatsUsageStatsIndex.md) | [ShardStatistics](./ShardStatistics.md);}; +::: diff --git a/docs/reference/api/IndicesFieldUsageStatsFieldsUsageBodyKeys.md b/docs/reference/api/IndicesFieldUsageStatsFieldsUsageBodyKeys.md new file mode 100644 index 000000000..73aa6dfd2 --- /dev/null +++ b/docs/reference/api/IndicesFieldUsageStatsFieldsUsageBodyKeys.md @@ -0,0 +1,5 @@ +## Interface `IndicesFieldUsageStatsFieldsUsageBodyKeys` + +| Name | Type | Description | +| - | - | - | +| `_shards` | [ShardStatistics](./ShardStatistics.md) |   | diff --git a/docs/reference/api/IndicesFieldUsageStatsInvertedIndex.md b/docs/reference/api/IndicesFieldUsageStatsInvertedIndex.md new file mode 100644 index 000000000..707ff2085 --- /dev/null +++ b/docs/reference/api/IndicesFieldUsageStatsInvertedIndex.md @@ -0,0 +1,11 @@ +## Interface `IndicesFieldUsageStatsInvertedIndex` + +| Name | Type | Description | +| - | - | - | +| `offsets` | [uint](./uint.md) |   | +| `payloads` | [uint](./uint.md) |   | +| `positions` | [uint](./uint.md) |   | +| `postings` | [uint](./uint.md) |   | +| `proximity` | [uint](./uint.md) |   | +| `term_frequencies` | [uint](./uint.md) |   | +| `terms` | [uint](./uint.md) |   | diff --git a/docs/reference/api/IndicesFieldUsageStatsRequest.md b/docs/reference/api/IndicesFieldUsageStatsRequest.md new file mode 100644 index 000000000..977182324 --- /dev/null +++ b/docs/reference/api/IndicesFieldUsageStatsRequest.md @@ -0,0 +1,11 @@ +## Interface `IndicesFieldUsageStatsRequest` + +| Name | Type | Description | +| - | - | - | +| `allow_no_indices` | boolean | If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. | +| `body` | string | ({ [key: string]: any; } & { index?: never; allow_no_indices?: never; expand_wildcards?: never; ignore_unavailable?: never; fields?: never; }) | All values in `body` will be added to the request body. | +| `expand_wildcards` | [ExpandWildcards](./ExpandWildcards.md) | Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. | +| `fields` | [Fields](./Fields.md) | Comma-separated list or wildcard expressions of fields to include in the statistics. | +| `ignore_unavailable` | boolean | If `true`, missing or closed indices are not included in the response. | +| `index` | [Indices](./Indices.md) | Comma-separated list or wildcard expression of index names used to limit the request. | +| `querystring` | { [key: string]: any; } & { index?: never; allow_no_indices?: never; expand_wildcards?: never; ignore_unavailable?: never; fields?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/IndicesFieldUsageStatsResponse.md b/docs/reference/api/IndicesFieldUsageStatsResponse.md new file mode 100644 index 000000000..47e35c067 --- /dev/null +++ b/docs/reference/api/IndicesFieldUsageStatsResponse.md @@ -0,0 +1,4 @@ +## `IndicesFieldUsageStatsResponse` +::: +type IndicesFieldUsageStatsResponse = [IndicesFieldUsageStatsFieldsUsageBody](./IndicesFieldUsageStatsFieldsUsageBody.md); +::: diff --git a/docs/reference/api/IndicesFieldUsageStatsShardsStats.md b/docs/reference/api/IndicesFieldUsageStatsShardsStats.md new file mode 100644 index 000000000..1d072a114 --- /dev/null +++ b/docs/reference/api/IndicesFieldUsageStatsShardsStats.md @@ -0,0 +1,6 @@ +## Interface `IndicesFieldUsageStatsShardsStats` + +| Name | Type | Description | +| - | - | - | +| `all_fields` | [IndicesFieldUsageStatsFieldSummary](./IndicesFieldUsageStatsFieldSummary.md) |   | +| `fields` | Record<[Field](./Field.md), [IndicesFieldUsageStatsFieldSummary](./IndicesFieldUsageStatsFieldSummary.md)> |   | diff --git a/docs/reference/api/IndicesFieldUsageStatsUsageStatsIndex.md b/docs/reference/api/IndicesFieldUsageStatsUsageStatsIndex.md new file mode 100644 index 000000000..5afbe7133 --- /dev/null +++ b/docs/reference/api/IndicesFieldUsageStatsUsageStatsIndex.md @@ -0,0 +1,5 @@ +## Interface `IndicesFieldUsageStatsUsageStatsIndex` + +| Name | Type | Description | +| - | - | - | +| `shards` | [IndicesFieldUsageStatsUsageStatsShards](./IndicesFieldUsageStatsUsageStatsShards.md)[] |   | diff --git a/docs/reference/api/IndicesFieldUsageStatsUsageStatsShards.md b/docs/reference/api/IndicesFieldUsageStatsUsageStatsShards.md new file mode 100644 index 000000000..0cbcd2535 --- /dev/null +++ b/docs/reference/api/IndicesFieldUsageStatsUsageStatsShards.md @@ -0,0 +1,8 @@ +## Interface `IndicesFieldUsageStatsUsageStatsShards` + +| Name | Type | Description | +| - | - | - | +| `routing` | [IndicesStatsShardRouting](./IndicesStatsShardRouting.md) |   | +| `stats` | [IndicesFieldUsageStatsShardsStats](./IndicesFieldUsageStatsShardsStats.md) |   | +| `tracking_id` | string |   | +| `tracking_started_at_millis` | [EpochTime](./EpochTime.md)<[UnitMillis](./UnitMillis.md)> |   | diff --git a/docs/reference/api/IndicesFielddataFrequencyFilter.md b/docs/reference/api/IndicesFielddataFrequencyFilter.md new file mode 100644 index 000000000..c173cd27a --- /dev/null +++ b/docs/reference/api/IndicesFielddataFrequencyFilter.md @@ -0,0 +1,7 @@ +## Interface `IndicesFielddataFrequencyFilter` + +| Name | Type | Description | +| - | - | - | +| `max` | [double](./double.md) |   | +| `min_segment_size` | [integer](./integer.md) |   | +| `min` | [double](./double.md) |   | diff --git a/docs/reference/api/IndicesFlushRequest.md b/docs/reference/api/IndicesFlushRequest.md new file mode 100644 index 000000000..ab7916ade --- /dev/null +++ b/docs/reference/api/IndicesFlushRequest.md @@ -0,0 +1,12 @@ +## Interface `IndicesFlushRequest` + +| Name | Type | Description | +| - | - | - | +| `allow_no_indices` | boolean | If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. | +| `body` | string | ({ [key: string]: any; } & { index?: never; allow_no_indices?: never; expand_wildcards?: never; force?: never; ignore_unavailable?: never; wait_if_ongoing?: never; }) | All values in `body` will be added to the request body. | +| `expand_wildcards` | [ExpandWildcards](./ExpandWildcards.md) | Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. | +| `force` | boolean | If `true`, the request forces a flush even if there are no changes to commit to the index. | +| `ignore_unavailable` | boolean | If `false`, the request returns an error if it targets a missing or closed index. | +| `index` | [Indices](./Indices.md) | Comma-separated list of data streams, indices, and aliases to flush. Supports wildcards ( `*`). To flush all data streams and indices, omit this parameter or use `*` or `_all`. | +| `querystring` | { [key: string]: any; } & { index?: never; allow_no_indices?: never; expand_wildcards?: never; force?: never; ignore_unavailable?: never; wait_if_ongoing?: never; } | All values in `querystring` will be added to the request querystring. | +| `wait_if_ongoing` | boolean | If `true`, the flush operation blocks until execution when another flush operation is running. If `false`, Elasticsearch returns an error if you request a flush when another flush operation is running. | diff --git a/docs/reference/api/IndicesFlushResponse.md b/docs/reference/api/IndicesFlushResponse.md new file mode 100644 index 000000000..662224b66 --- /dev/null +++ b/docs/reference/api/IndicesFlushResponse.md @@ -0,0 +1,4 @@ +## `IndicesFlushResponse` +::: +type IndicesFlushResponse = [ShardsOperationResponseBase](./ShardsOperationResponseBase.md); +::: diff --git a/docs/reference/api/IndicesForcemergeForceMergeResponseBody.md b/docs/reference/api/IndicesForcemergeForceMergeResponseBody.md new file mode 100644 index 000000000..a9d6e1e4a --- /dev/null +++ b/docs/reference/api/IndicesForcemergeForceMergeResponseBody.md @@ -0,0 +1,5 @@ +## Interface `IndicesForcemergeForceMergeResponseBody` + +| Name | Type | Description | +| - | - | - | +| `task` | string | task contains a task id returned when wait_for_completion=false, you can use the task_id to get the status of the task at _tasks/ < task_id > | diff --git a/docs/reference/api/IndicesForcemergeRequest.md b/docs/reference/api/IndicesForcemergeRequest.md new file mode 100644 index 000000000..1f4232788 --- /dev/null +++ b/docs/reference/api/IndicesForcemergeRequest.md @@ -0,0 +1,14 @@ +## Interface `IndicesForcemergeRequest` + +| Name | Type | Description | +| - | - | - | +| `allow_no_indices` | boolean | Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) | +| `body` | string | ({ [key: string]: any; } & { index?: never; allow_no_indices?: never; expand_wildcards?: never; flush?: never; ignore_unavailable?: never; max_num_segments?: never; only_expunge_deletes?: never; wait_for_completion?: never; }) | All values in `body` will be added to the request body. | +| `expand_wildcards` | [ExpandWildcards](./ExpandWildcards.md) | Whether to expand wildcard expression to concrete indices that are open, closed or both. | +| `flush` | boolean | Specify whether the index should be flushed after performing the operation (default: true) | +| `ignore_unavailable` | boolean | Whether specified concrete indices should be ignored when unavailable (missing or closed) | +| `index` | [Indices](./Indices.md) | A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices | +| `max_num_segments` | [long](./long.md) | The number of segments the index should be merged into (default: dynamic) | +| `only_expunge_deletes` | boolean | Specify whether the operation should only expunge deleted documents | +| `querystring` | { [key: string]: any; } & { index?: never; allow_no_indices?: never; expand_wildcards?: never; flush?: never; ignore_unavailable?: never; max_num_segments?: never; only_expunge_deletes?: never; wait_for_completion?: never; } | All values in `querystring` will be added to the request querystring. | +| `wait_for_completion` | boolean | Should the request wait until the force merge is completed. | diff --git a/docs/reference/api/IndicesForcemergeResponse.md b/docs/reference/api/IndicesForcemergeResponse.md new file mode 100644 index 000000000..5f70ede27 --- /dev/null +++ b/docs/reference/api/IndicesForcemergeResponse.md @@ -0,0 +1,4 @@ +## `IndicesForcemergeResponse` +::: +type IndicesForcemergeResponse = [IndicesForcemergeForceMergeResponseBody](./IndicesForcemergeForceMergeResponseBody.md); +::: diff --git a/docs/reference/api/IndicesGetAliasIndexAliases.md b/docs/reference/api/IndicesGetAliasIndexAliases.md new file mode 100644 index 000000000..05b3b332c --- /dev/null +++ b/docs/reference/api/IndicesGetAliasIndexAliases.md @@ -0,0 +1,5 @@ +## Interface `IndicesGetAliasIndexAliases` + +| Name | Type | Description | +| - | - | - | +| `aliases` | Record |   | diff --git a/docs/reference/api/IndicesGetAliasRequest.md b/docs/reference/api/IndicesGetAliasRequest.md new file mode 100644 index 000000000..76d415f40 --- /dev/null +++ b/docs/reference/api/IndicesGetAliasRequest.md @@ -0,0 +1,12 @@ +## Interface `IndicesGetAliasRequest` + +| Name | Type | Description | +| - | - | - | +| `allow_no_indices` | boolean | If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. | +| `body` | string | ({ [key: string]: any; } & { name?: never; index?: never; allow_no_indices?: never; expand_wildcards?: never; ignore_unavailable?: never; master_timeout?: never; }) | All values in `body` will be added to the request body. | +| `expand_wildcards` | [ExpandWildcards](./ExpandWildcards.md) | Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. | +| `ignore_unavailable` | boolean | If `false`, the request returns an error if it targets a missing or closed index. | +| `index` | [Indices](./Indices.md) | Comma-separated list of data streams or indices used to limit the request. Supports wildcards ( `*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. | +| `master_timeout` | [Duration](./Duration.md) | Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. | +| `name` | [Names](./Names.md) | Comma-separated list of aliases to retrieve. Supports wildcards ( `*`). To retrieve all aliases, omit this parameter or use `*` or `_all`. | +| `querystring` | { [key: string]: any; } & { name?: never; index?: never; allow_no_indices?: never; expand_wildcards?: never; ignore_unavailable?: never; master_timeout?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/IndicesGetAliasResponse.md b/docs/reference/api/IndicesGetAliasResponse.md new file mode 100644 index 000000000..553c42ac3 --- /dev/null +++ b/docs/reference/api/IndicesGetAliasResponse.md @@ -0,0 +1,4 @@ +## `IndicesGetAliasResponse` +::: +type IndicesGetAliasResponse = Record<[IndexName](./IndexName.md), [IndicesGetAliasIndexAliases](./IndicesGetAliasIndexAliases.md)>; +::: diff --git a/docs/reference/api/IndicesGetDataLifecycleDataStreamWithLifecycle.md b/docs/reference/api/IndicesGetDataLifecycleDataStreamWithLifecycle.md new file mode 100644 index 000000000..c674ef1c3 --- /dev/null +++ b/docs/reference/api/IndicesGetDataLifecycleDataStreamWithLifecycle.md @@ -0,0 +1,6 @@ +## Interface `IndicesGetDataLifecycleDataStreamWithLifecycle` + +| Name | Type | Description | +| - | - | - | +| `lifecycle` | [IndicesDataStreamLifecycleWithRollover](./IndicesDataStreamLifecycleWithRollover.md) |   | +| `name` | [DataStreamName](./DataStreamName.md) |   | diff --git a/docs/reference/api/IndicesGetDataLifecycleRequest.md b/docs/reference/api/IndicesGetDataLifecycleRequest.md new file mode 100644 index 000000000..7d7f87c0d --- /dev/null +++ b/docs/reference/api/IndicesGetDataLifecycleRequest.md @@ -0,0 +1,10 @@ +## Interface `IndicesGetDataLifecycleRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { name?: never; expand_wildcards?: never; include_defaults?: never; master_timeout?: never; }) | All values in `body` will be added to the request body. | +| `expand_wildcards` | [ExpandWildcards](./ExpandWildcards.md) | Type of data stream that wildcard patterns can match. Supports comma-separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. | +| `include_defaults` | boolean | If `true`, return all default settings in the response. | +| `master_timeout` | [Duration](./Duration.md) | Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. | +| `name` | [DataStreamNames](./DataStreamNames.md) | Comma-separated list of data streams to limit the request. Supports wildcards ( `*`). To target all data streams, omit this parameter or use `*` or `_all`. | +| `querystring` | { [key: string]: any; } & { name?: never; expand_wildcards?: never; include_defaults?: never; master_timeout?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/IndicesGetDataLifecycleResponse.md b/docs/reference/api/IndicesGetDataLifecycleResponse.md new file mode 100644 index 000000000..e5e64d678 --- /dev/null +++ b/docs/reference/api/IndicesGetDataLifecycleResponse.md @@ -0,0 +1,5 @@ +## Interface `IndicesGetDataLifecycleResponse` + +| Name | Type | Description | +| - | - | - | +| `data_streams` | [IndicesGetDataLifecycleDataStreamWithLifecycle](./IndicesGetDataLifecycleDataStreamWithLifecycle.md)[] |   | diff --git a/docs/reference/api/IndicesGetDataLifecycleStatsDataStreamStats.md b/docs/reference/api/IndicesGetDataLifecycleStatsDataStreamStats.md new file mode 100644 index 000000000..56a340996 --- /dev/null +++ b/docs/reference/api/IndicesGetDataLifecycleStatsDataStreamStats.md @@ -0,0 +1,7 @@ +## Interface `IndicesGetDataLifecycleStatsDataStreamStats` + +| Name | Type | Description | +| - | - | - | +| `backing_indices_in_error` | [integer](./integer.md) | The count of the backing indices for the data stream. | +| `backing_indices_in_total` | [integer](./integer.md) | The count of the backing indices for the data stream that have encountered an error. | +| `name` | [DataStreamName](./DataStreamName.md) | The name of the data stream. | diff --git a/docs/reference/api/IndicesGetDataLifecycleStatsRequest.md b/docs/reference/api/IndicesGetDataLifecycleStatsRequest.md new file mode 100644 index 000000000..ad413f884 --- /dev/null +++ b/docs/reference/api/IndicesGetDataLifecycleStatsRequest.md @@ -0,0 +1,6 @@ +## Interface `IndicesGetDataLifecycleStatsRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | { [key: string]: any; } | All values in `body` will be added to the request body. | +| `querystring` | { [key: string]: any; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/IndicesGetDataLifecycleStatsResponse.md b/docs/reference/api/IndicesGetDataLifecycleStatsResponse.md new file mode 100644 index 000000000..f7a69bfb1 --- /dev/null +++ b/docs/reference/api/IndicesGetDataLifecycleStatsResponse.md @@ -0,0 +1,8 @@ +## Interface `IndicesGetDataLifecycleStatsResponse` + +| Name | Type | Description | +| - | - | - | +| `data_stream_count` | [integer](./integer.md) | The count of data streams currently being managed by the data stream lifecycle. | +| `data_streams` | [IndicesGetDataLifecycleStatsDataStreamStats](./IndicesGetDataLifecycleStatsDataStreamStats.md)[] | Information about the data streams that are managed by the data stream lifecycle. | +| `last_run_duration_in_millis` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> | The duration of the last data stream lifecycle execution. | +| `time_between_starts_in_millis` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> | The time that passed between the start of the last two data stream lifecycle executions. This value should amount approximately to `data_streams.lifecycle.poll_interval`. | diff --git a/docs/reference/api/IndicesGetDataStreamRequest.md b/docs/reference/api/IndicesGetDataStreamRequest.md new file mode 100644 index 000000000..4ba29cea3 --- /dev/null +++ b/docs/reference/api/IndicesGetDataStreamRequest.md @@ -0,0 +1,11 @@ +## Interface `IndicesGetDataStreamRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { name?: never; expand_wildcards?: never; include_defaults?: never; master_timeout?: never; verbose?: never; }) | All values in `body` will be added to the request body. | +| `expand_wildcards` | [ExpandWildcards](./ExpandWildcards.md) | Type of data stream that wildcard patterns can match. Supports comma-separated values, such as `open,hidden`. | +| `include_defaults` | boolean | If true, returns all relevant default configurations for the index template. | +| `master_timeout` | [Duration](./Duration.md) | Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. | +| `name` | [DataStreamNames](./DataStreamNames.md) | Comma-separated list of data stream names used to limit the request. Wildcard ( `*`) expressions are supported. If omitted, all data streams are returned. | +| `querystring` | { [key: string]: any; } & { name?: never; expand_wildcards?: never; include_defaults?: never; master_timeout?: never; verbose?: never; } | All values in `querystring` will be added to the request querystring. | +| `verbose` | boolean | Whether the maximum timestamp for each data stream should be calculated and returned. | diff --git a/docs/reference/api/IndicesGetDataStreamResponse.md b/docs/reference/api/IndicesGetDataStreamResponse.md new file mode 100644 index 000000000..6f0da2f2e --- /dev/null +++ b/docs/reference/api/IndicesGetDataStreamResponse.md @@ -0,0 +1,5 @@ +## Interface `IndicesGetDataStreamResponse` + +| Name | Type | Description | +| - | - | - | +| `data_streams` | [IndicesDataStream](./IndicesDataStream.md)[] |   | diff --git a/docs/reference/api/IndicesGetFeature.md b/docs/reference/api/IndicesGetFeature.md new file mode 100644 index 000000000..b50d4442f --- /dev/null +++ b/docs/reference/api/IndicesGetFeature.md @@ -0,0 +1,4 @@ +## `IndicesGetFeature` +::: +type IndicesGetFeature = 'aliases' | 'mappings' | 'settings'; +::: diff --git a/docs/reference/api/IndicesGetFeatures.md b/docs/reference/api/IndicesGetFeatures.md new file mode 100644 index 000000000..841ffafc9 --- /dev/null +++ b/docs/reference/api/IndicesGetFeatures.md @@ -0,0 +1,4 @@ +## `IndicesGetFeatures` +::: +type IndicesGetFeatures = [IndicesGetFeature](./IndicesGetFeature.md) | [IndicesGetFeature](./IndicesGetFeature.md)[]; +::: diff --git a/docs/reference/api/IndicesGetFieldMappingRequest.md b/docs/reference/api/IndicesGetFieldMappingRequest.md new file mode 100644 index 000000000..e980571fe --- /dev/null +++ b/docs/reference/api/IndicesGetFieldMappingRequest.md @@ -0,0 +1,12 @@ +## Interface `IndicesGetFieldMappingRequest` + +| Name | Type | Description | +| - | - | - | +| `allow_no_indices` | boolean | If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. | +| `body` | string | ({ [key: string]: any; } & { fields?: never; index?: never; allow_no_indices?: never; expand_wildcards?: never; ignore_unavailable?: never; include_defaults?: never; }) | All values in `body` will be added to the request body. | +| `expand_wildcards` | [ExpandWildcards](./ExpandWildcards.md) | Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. | +| `fields` | [Fields](./Fields.md) | Comma-separated list or wildcard expression of fields used to limit returned information. Supports wildcards ( `*`). | +| `ignore_unavailable` | boolean | If `false`, the request returns an error if it targets a missing or closed index. | +| `include_defaults` | boolean | If `true`, return all default settings in the response. | +| `index` | [Indices](./Indices.md) | Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards ( `*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. | +| `querystring` | { [key: string]: any; } & { fields?: never; index?: never; allow_no_indices?: never; expand_wildcards?: never; ignore_unavailable?: never; include_defaults?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/IndicesGetFieldMappingResponse.md b/docs/reference/api/IndicesGetFieldMappingResponse.md new file mode 100644 index 000000000..ea48b9fd6 --- /dev/null +++ b/docs/reference/api/IndicesGetFieldMappingResponse.md @@ -0,0 +1,4 @@ +## `IndicesGetFieldMappingResponse` +::: +type IndicesGetFieldMappingResponse = Record<[IndexName](./IndexName.md), [IndicesGetFieldMappingTypeFieldMappings](./IndicesGetFieldMappingTypeFieldMappings.md)>; +::: diff --git a/docs/reference/api/IndicesGetFieldMappingTypeFieldMappings.md b/docs/reference/api/IndicesGetFieldMappingTypeFieldMappings.md new file mode 100644 index 000000000..30095a05a --- /dev/null +++ b/docs/reference/api/IndicesGetFieldMappingTypeFieldMappings.md @@ -0,0 +1,5 @@ +## Interface `IndicesGetFieldMappingTypeFieldMappings` + +| Name | Type | Description | +| - | - | - | +| `mappings` | Record<[Field](./Field.md), [MappingFieldMapping](./MappingFieldMapping.md)> |   | diff --git a/docs/reference/api/IndicesGetIndexTemplateIndexTemplateItem.md b/docs/reference/api/IndicesGetIndexTemplateIndexTemplateItem.md new file mode 100644 index 000000000..85b677371 --- /dev/null +++ b/docs/reference/api/IndicesGetIndexTemplateIndexTemplateItem.md @@ -0,0 +1,6 @@ +## Interface `IndicesGetIndexTemplateIndexTemplateItem` + +| Name | Type | Description | +| - | - | - | +| `index_template` | [IndicesIndexTemplate](./IndicesIndexTemplate.md) |   | +| `name` | [Name](./Name.md) |   | diff --git a/docs/reference/api/IndicesGetIndexTemplateRequest.md b/docs/reference/api/IndicesGetIndexTemplateRequest.md new file mode 100644 index 000000000..979e04a15 --- /dev/null +++ b/docs/reference/api/IndicesGetIndexTemplateRequest.md @@ -0,0 +1,11 @@ +## Interface `IndicesGetIndexTemplateRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { name?: never; local?: never; flat_settings?: never; master_timeout?: never; include_defaults?: never; }) | All values in `body` will be added to the request body. | +| `flat_settings` | boolean | If true, returns settings in flat format. | +| `include_defaults` | boolean | If true, returns all relevant default configurations for the index template. | +| `local` | boolean | If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node. | +| `master_timeout` | [Duration](./Duration.md) | Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. | +| `name` | [Name](./Name.md) | Comma-separated list of index template names used to limit the request. Wildcard (*) expressions are supported. | +| `querystring` | { [key: string]: any; } & { name?: never; local?: never; flat_settings?: never; master_timeout?: never; include_defaults?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/IndicesGetIndexTemplateResponse.md b/docs/reference/api/IndicesGetIndexTemplateResponse.md new file mode 100644 index 000000000..174dbbfde --- /dev/null +++ b/docs/reference/api/IndicesGetIndexTemplateResponse.md @@ -0,0 +1,5 @@ +## Interface `IndicesGetIndexTemplateResponse` + +| Name | Type | Description | +| - | - | - | +| `index_templates` | [IndicesGetIndexTemplateIndexTemplateItem](./IndicesGetIndexTemplateIndexTemplateItem.md)[] |   | diff --git a/docs/reference/api/IndicesGetMappingIndexMappingRecord.md b/docs/reference/api/IndicesGetMappingIndexMappingRecord.md new file mode 100644 index 000000000..0137a713d --- /dev/null +++ b/docs/reference/api/IndicesGetMappingIndexMappingRecord.md @@ -0,0 +1,6 @@ +## Interface `IndicesGetMappingIndexMappingRecord` + +| Name | Type | Description | +| - | - | - | +| `item` | [MappingTypeMapping](./MappingTypeMapping.md) |   | +| `mappings` | [MappingTypeMapping](./MappingTypeMapping.md) |   | diff --git a/docs/reference/api/IndicesGetMappingRequest.md b/docs/reference/api/IndicesGetMappingRequest.md new file mode 100644 index 000000000..0f159b8c9 --- /dev/null +++ b/docs/reference/api/IndicesGetMappingRequest.md @@ -0,0 +1,12 @@ +## Interface `IndicesGetMappingRequest` + +| Name | Type | Description | +| - | - | - | +| `allow_no_indices` | boolean | If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. | +| `body` | string | ({ [key: string]: any; } & { index?: never; allow_no_indices?: never; expand_wildcards?: never; ignore_unavailable?: never; local?: never; master_timeout?: never; }) | All values in `body` will be added to the request body. | +| `expand_wildcards` | [ExpandWildcards](./ExpandWildcards.md) | Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. | +| `ignore_unavailable` | boolean | If `false`, the request returns an error if it targets a missing or closed index. | +| `index` | [Indices](./Indices.md) | Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards ( `*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. | +| `local` | boolean | If `true`, the request retrieves information from the local node only. | +| `master_timeout` | [Duration](./Duration.md) | Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. | +| `querystring` | { [key: string]: any; } & { index?: never; allow_no_indices?: never; expand_wildcards?: never; ignore_unavailable?: never; local?: never; master_timeout?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/IndicesGetMappingResponse.md b/docs/reference/api/IndicesGetMappingResponse.md new file mode 100644 index 000000000..ee2a07b9a --- /dev/null +++ b/docs/reference/api/IndicesGetMappingResponse.md @@ -0,0 +1,4 @@ +## `IndicesGetMappingResponse` +::: +type IndicesGetMappingResponse = Record<[IndexName](./IndexName.md), [IndicesGetMappingIndexMappingRecord](./IndicesGetMappingIndexMappingRecord.md)>; +::: diff --git a/docs/reference/api/IndicesGetMigrateReindexStatusRequest.md b/docs/reference/api/IndicesGetMigrateReindexStatusRequest.md new file mode 100644 index 000000000..6968fb202 --- /dev/null +++ b/docs/reference/api/IndicesGetMigrateReindexStatusRequest.md @@ -0,0 +1,7 @@ +## Interface `IndicesGetMigrateReindexStatusRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { index?: never; }) | All values in `body` will be added to the request body. | +| `index` | [Indices](./Indices.md) | The index or data stream name. | +| `querystring` | { [key: string]: any; } & { index?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/IndicesGetMigrateReindexStatusResponse.md b/docs/reference/api/IndicesGetMigrateReindexStatusResponse.md new file mode 100644 index 000000000..7c644781b --- /dev/null +++ b/docs/reference/api/IndicesGetMigrateReindexStatusResponse.md @@ -0,0 +1,14 @@ +## Interface `IndicesGetMigrateReindexStatusResponse` + +| Name | Type | Description | +| - | - | - | +| `complete` | boolean |   | +| `errors` | [IndicesGetMigrateReindexStatusStatusError](./IndicesGetMigrateReindexStatusStatusError.md)[] |   | +| `exception` | string |   | +| `in_progress` | [IndicesGetMigrateReindexStatusStatusInProgress](./IndicesGetMigrateReindexStatusStatusInProgress.md)[] |   | +| `pending` | [integer](./integer.md) |   | +| `start_time_millis` | [EpochTime](./EpochTime.md)<[UnitMillis](./UnitMillis.md)> |   | +| `start_time` | [DateTime](./DateTime.md) |   | +| `successes` | [integer](./integer.md) |   | +| `total_indices_in_data_stream` | [integer](./integer.md) |   | +| `total_indices_requiring_upgrade` | [integer](./integer.md) |   | diff --git a/docs/reference/api/IndicesGetMigrateReindexStatusStatusError.md b/docs/reference/api/IndicesGetMigrateReindexStatusStatusError.md new file mode 100644 index 000000000..577451aab --- /dev/null +++ b/docs/reference/api/IndicesGetMigrateReindexStatusStatusError.md @@ -0,0 +1,6 @@ +## Interface `IndicesGetMigrateReindexStatusStatusError` + +| Name | Type | Description | +| - | - | - | +| `index` | string |   | +| `message` | string |   | diff --git a/docs/reference/api/IndicesGetMigrateReindexStatusStatusInProgress.md b/docs/reference/api/IndicesGetMigrateReindexStatusStatusInProgress.md new file mode 100644 index 000000000..2cfbadd96 --- /dev/null +++ b/docs/reference/api/IndicesGetMigrateReindexStatusStatusInProgress.md @@ -0,0 +1,7 @@ +## Interface `IndicesGetMigrateReindexStatusStatusInProgress` + +| Name | Type | Description | +| - | - | - | +| `index` | string |   | +| `reindexed_doc_count` | [long](./long.md) |   | +| `total_doc_count` | [long](./long.md) |   | diff --git a/docs/reference/api/IndicesGetRequest.md b/docs/reference/api/IndicesGetRequest.md new file mode 100644 index 000000000..bb0111aa1 --- /dev/null +++ b/docs/reference/api/IndicesGetRequest.md @@ -0,0 +1,15 @@ +## Interface `IndicesGetRequest` + +| Name | Type | Description | +| - | - | - | +| `allow_no_indices` | boolean | If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar. | +| `body` | string | ({ [key: string]: any; } & { index?: never; allow_no_indices?: never; expand_wildcards?: never; flat_settings?: never; ignore_unavailable?: never; include_defaults?: never; local?: never; master_timeout?: never; features?: never; }) | All values in `body` will be added to the request body. | +| `expand_wildcards` | [ExpandWildcards](./ExpandWildcards.md) | Type of index that wildcard expressions can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden. | +| `features` | [IndicesGetFeatures](./IndicesGetFeatures.md) | Return only information on specified index features | +| `flat_settings` | boolean | If true, returns settings in flat format. | +| `ignore_unavailable` | boolean | If false, requests that target a missing index return an error. | +| `include_defaults` | boolean | If true, return all default settings in the response. | +| `index` | [Indices](./Indices.md) | Comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard expressions (*) are supported. | +| `local` | boolean | If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node. | +| `master_timeout` | [Duration](./Duration.md) | Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. | +| `querystring` | { [key: string]: any; } & { index?: never; allow_no_indices?: never; expand_wildcards?: never; flat_settings?: never; ignore_unavailable?: never; include_defaults?: never; local?: never; master_timeout?: never; features?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/IndicesGetResponse.md b/docs/reference/api/IndicesGetResponse.md new file mode 100644 index 000000000..d9327f30d --- /dev/null +++ b/docs/reference/api/IndicesGetResponse.md @@ -0,0 +1,4 @@ +## `IndicesGetResponse` +::: +type IndicesGetResponse = Record<[IndexName](./IndexName.md), [IndicesIndexState](./IndicesIndexState.md)>; +::: diff --git a/docs/reference/api/IndicesGetSettingsRequest.md b/docs/reference/api/IndicesGetSettingsRequest.md new file mode 100644 index 000000000..c3a1b6748 --- /dev/null +++ b/docs/reference/api/IndicesGetSettingsRequest.md @@ -0,0 +1,15 @@ +## Interface `IndicesGetSettingsRequest` + +| Name | Type | Description | +| - | - | - | +| `allow_no_indices` | boolean | If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting `foo*,bar*` returns an error if an index starts with foo but no index starts with `bar`. | +| `body` | string | ({ [key: string]: any; } & { index?: never; name?: never; allow_no_indices?: never; expand_wildcards?: never; flat_settings?: never; ignore_unavailable?: never; include_defaults?: never; local?: never; master_timeout?: never; }) | All values in `body` will be added to the request body. | +| `expand_wildcards` | [ExpandWildcards](./ExpandWildcards.md) | Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. | +| `flat_settings` | boolean | If `true`, returns settings in flat format. | +| `ignore_unavailable` | boolean | If `false`, the request returns an error if it targets a missing or closed index. | +| `include_defaults` | boolean | If `true`, return all default settings in the response. | +| `index` | [Indices](./Indices.md) | Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards ( `*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. | +| `local` | boolean | If `true`, the request retrieves information from the local node only. If `false`, information is retrieved from the master node. | +| `master_timeout` | [Duration](./Duration.md) | Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. | +| `name` | [Names](./Names.md) | Comma-separated list or wildcard expression of settings to retrieve. | +| `querystring` | { [key: string]: any; } & { index?: never; name?: never; allow_no_indices?: never; expand_wildcards?: never; flat_settings?: never; ignore_unavailable?: never; include_defaults?: never; local?: never; master_timeout?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/IndicesGetSettingsResponse.md b/docs/reference/api/IndicesGetSettingsResponse.md new file mode 100644 index 000000000..7a9d03914 --- /dev/null +++ b/docs/reference/api/IndicesGetSettingsResponse.md @@ -0,0 +1,4 @@ +## `IndicesGetSettingsResponse` +::: +type IndicesGetSettingsResponse = Record<[IndexName](./IndexName.md), [IndicesIndexState](./IndicesIndexState.md)>; +::: diff --git a/docs/reference/api/IndicesGetTemplateRequest.md b/docs/reference/api/IndicesGetTemplateRequest.md new file mode 100644 index 000000000..5208e0a1c --- /dev/null +++ b/docs/reference/api/IndicesGetTemplateRequest.md @@ -0,0 +1,10 @@ +## Interface `IndicesGetTemplateRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { name?: never; flat_settings?: never; local?: never; master_timeout?: never; }) | All values in `body` will be added to the request body. | +| `flat_settings` | boolean | If `true`, returns settings in flat format. | +| `local` | boolean | If `true`, the request retrieves information from the local node only. | +| `master_timeout` | [Duration](./Duration.md) | Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. | +| `name` | [Names](./Names.md) | Comma-separated list of index template names used to limit the request. Wildcard ( `*`) expressions are supported. To return all index templates, omit this parameter or use a value of `_all` or `*`. | +| `querystring` | { [key: string]: any; } & { name?: never; flat_settings?: never; local?: never; master_timeout?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/IndicesGetTemplateResponse.md b/docs/reference/api/IndicesGetTemplateResponse.md new file mode 100644 index 000000000..f56376a14 --- /dev/null +++ b/docs/reference/api/IndicesGetTemplateResponse.md @@ -0,0 +1,4 @@ +## `IndicesGetTemplateResponse` +::: +type IndicesGetTemplateResponse = Record; +::: diff --git a/docs/reference/api/IndicesIndexCheckOnStartup.md b/docs/reference/api/IndicesIndexCheckOnStartup.md new file mode 100644 index 000000000..ae97fce53 --- /dev/null +++ b/docs/reference/api/IndicesIndexCheckOnStartup.md @@ -0,0 +1,4 @@ +## `IndicesIndexCheckOnStartup` +::: +type IndicesIndexCheckOnStartup = boolean | 'true' | 'false' | 'checksum'; +::: diff --git a/docs/reference/api/IndicesIndexMode.md b/docs/reference/api/IndicesIndexMode.md new file mode 100644 index 000000000..d1fccdb8e --- /dev/null +++ b/docs/reference/api/IndicesIndexMode.md @@ -0,0 +1,4 @@ +## `IndicesIndexMode` +::: +type IndicesIndexMode = 'standard' | 'time_series' | 'logsdb' | 'lookup'; +::: diff --git a/docs/reference/api/IndicesIndexRouting.md b/docs/reference/api/IndicesIndexRouting.md new file mode 100644 index 000000000..be65dfe65 --- /dev/null +++ b/docs/reference/api/IndicesIndexRouting.md @@ -0,0 +1,6 @@ +## Interface `IndicesIndexRouting` + +| Name | Type | Description | +| - | - | - | +| `allocation` | [IndicesIndexRoutingAllocation](./IndicesIndexRoutingAllocation.md) |   | +| `rebalance` | [IndicesIndexRoutingRebalance](./IndicesIndexRoutingRebalance.md) |   | diff --git a/docs/reference/api/IndicesIndexRoutingAllocation.md b/docs/reference/api/IndicesIndexRoutingAllocation.md new file mode 100644 index 000000000..7511d6216 --- /dev/null +++ b/docs/reference/api/IndicesIndexRoutingAllocation.md @@ -0,0 +1,8 @@ +## Interface `IndicesIndexRoutingAllocation` + +| Name | Type | Description | +| - | - | - | +| `disk` | [IndicesIndexRoutingAllocationDisk](./IndicesIndexRoutingAllocationDisk.md) |   | +| `enable` | [IndicesIndexRoutingAllocationOptions](./IndicesIndexRoutingAllocationOptions.md) |   | +| `include` | [IndicesIndexRoutingAllocationInclude](./IndicesIndexRoutingAllocationInclude.md) |   | +| `initial_recovery` | [IndicesIndexRoutingAllocationInitialRecovery](./IndicesIndexRoutingAllocationInitialRecovery.md) |   | diff --git a/docs/reference/api/IndicesIndexRoutingAllocationDisk.md b/docs/reference/api/IndicesIndexRoutingAllocationDisk.md new file mode 100644 index 000000000..795ca5ee5 --- /dev/null +++ b/docs/reference/api/IndicesIndexRoutingAllocationDisk.md @@ -0,0 +1,5 @@ +## Interface `IndicesIndexRoutingAllocationDisk` + +| Name | Type | Description | +| - | - | - | +| `threshold_enabled` | boolean | string |   | diff --git a/docs/reference/api/IndicesIndexRoutingAllocationInclude.md b/docs/reference/api/IndicesIndexRoutingAllocationInclude.md new file mode 100644 index 000000000..3d906623c --- /dev/null +++ b/docs/reference/api/IndicesIndexRoutingAllocationInclude.md @@ -0,0 +1,6 @@ +## Interface `IndicesIndexRoutingAllocationInclude` + +| Name | Type | Description | +| - | - | - | +| `_id` | [Id](./Id.md) |   | +| `_tier_preference` | string |   | diff --git a/docs/reference/api/IndicesIndexRoutingAllocationInitialRecovery.md b/docs/reference/api/IndicesIndexRoutingAllocationInitialRecovery.md new file mode 100644 index 000000000..b04eff3f4 --- /dev/null +++ b/docs/reference/api/IndicesIndexRoutingAllocationInitialRecovery.md @@ -0,0 +1,5 @@ +## Interface `IndicesIndexRoutingAllocationInitialRecovery` + +| Name | Type | Description | +| - | - | - | +| `_id` | [Id](./Id.md) |   | diff --git a/docs/reference/api/IndicesIndexRoutingAllocationOptions.md b/docs/reference/api/IndicesIndexRoutingAllocationOptions.md new file mode 100644 index 000000000..ca9cd5818 --- /dev/null +++ b/docs/reference/api/IndicesIndexRoutingAllocationOptions.md @@ -0,0 +1,4 @@ +## `IndicesIndexRoutingAllocationOptions` +::: +type IndicesIndexRoutingAllocationOptions = 'all' | 'primaries' | 'new_primaries' | 'none'; +::: diff --git a/docs/reference/api/IndicesIndexRoutingRebalance.md b/docs/reference/api/IndicesIndexRoutingRebalance.md new file mode 100644 index 000000000..65ee6f2e8 --- /dev/null +++ b/docs/reference/api/IndicesIndexRoutingRebalance.md @@ -0,0 +1,5 @@ +## Interface `IndicesIndexRoutingRebalance` + +| Name | Type | Description | +| - | - | - | +| `enable` | [IndicesIndexRoutingRebalanceOptions](./IndicesIndexRoutingRebalanceOptions.md) |   | diff --git a/docs/reference/api/IndicesIndexRoutingRebalanceOptions.md b/docs/reference/api/IndicesIndexRoutingRebalanceOptions.md new file mode 100644 index 000000000..689a6fd9f --- /dev/null +++ b/docs/reference/api/IndicesIndexRoutingRebalanceOptions.md @@ -0,0 +1,4 @@ +## `IndicesIndexRoutingRebalanceOptions` +::: +type IndicesIndexRoutingRebalanceOptions = 'all' | 'primaries' | 'replicas' | 'none'; +::: diff --git a/docs/reference/api/IndicesIndexSegmentSort.md b/docs/reference/api/IndicesIndexSegmentSort.md new file mode 100644 index 000000000..f8e8aa18f --- /dev/null +++ b/docs/reference/api/IndicesIndexSegmentSort.md @@ -0,0 +1,8 @@ +## Interface `IndicesIndexSegmentSort` + +| Name | Type | Description | +| - | - | - | +| `field` | [Fields](./Fields.md) |   | +| `missing` | [IndicesSegmentSortMissing](./IndicesSegmentSortMissing.md) | [IndicesSegmentSortMissing](./IndicesSegmentSortMissing.md)[] |   | +| `mode` | [IndicesSegmentSortMode](./IndicesSegmentSortMode.md) | [IndicesSegmentSortMode](./IndicesSegmentSortMode.md)[] |   | +| `order` | [IndicesSegmentSortOrder](./IndicesSegmentSortOrder.md) | [IndicesSegmentSortOrder](./IndicesSegmentSortOrder.md)[] |   | diff --git a/docs/reference/api/IndicesIndexSettingBlocks.md b/docs/reference/api/IndicesIndexSettingBlocks.md new file mode 100644 index 000000000..722cf1828 --- /dev/null +++ b/docs/reference/api/IndicesIndexSettingBlocks.md @@ -0,0 +1,9 @@ +## Interface `IndicesIndexSettingBlocks` + +| Name | Type | Description | +| - | - | - | +| `metadata` | [SpecUtilsStringified](./SpecUtilsStringified.md) |   | +| `read_only_allow_delete` | [SpecUtilsStringified](./SpecUtilsStringified.md) |   | +| `read_only` | [SpecUtilsStringified](./SpecUtilsStringified.md) |   | +| `read` | [SpecUtilsStringified](./SpecUtilsStringified.md) |   | +| `write` | [SpecUtilsStringified](./SpecUtilsStringified.md) |   | diff --git a/docs/reference/api/IndicesIndexSettings.md b/docs/reference/api/IndicesIndexSettings.md new file mode 100644 index 000000000..58cc460b1 --- /dev/null +++ b/docs/reference/api/IndicesIndexSettings.md @@ -0,0 +1,4 @@ +## `IndicesIndexSettings` +::: +type IndicesIndexSettings = [IndicesIndexSettingsKeys](./IndicesIndexSettingsKeys.md) & { [property: string]: any;}; +::: diff --git a/docs/reference/api/IndicesIndexSettingsAnalysis.md b/docs/reference/api/IndicesIndexSettingsAnalysis.md new file mode 100644 index 000000000..ee045c6bd --- /dev/null +++ b/docs/reference/api/IndicesIndexSettingsAnalysis.md @@ -0,0 +1,9 @@ +## Interface `IndicesIndexSettingsAnalysis` + +| Name | Type | Description | +| - | - | - | +| `analyzer` | Record |   | +| `char_filter` | Record |   | +| `filter` | Record |   | +| `normalizer` | Record |   | +| `tokenizer` | Record |   | diff --git a/docs/reference/api/IndicesIndexSettingsKeys.md b/docs/reference/api/IndicesIndexSettingsKeys.md new file mode 100644 index 000000000..293c720b7 --- /dev/null +++ b/docs/reference/api/IndicesIndexSettingsKeys.md @@ -0,0 +1,60 @@ +## Interface `IndicesIndexSettingsKeys` + +| Name | Type | Description | +| - | - | - | +| `"indexing.slowlog"` | [IndicesIndexingSlowlogSettings](./IndicesIndexingSlowlogSettings.md) |   | +| `analysis` | [IndicesIndexSettingsAnalysis](./IndicesIndexSettingsAnalysis.md) |   | +| `analyze` | [IndicesSettingsAnalyze](./IndicesSettingsAnalyze.md) | Settings to define analyzers, tokenizers, token filters and character filters. | +| `auto_expand_replicas` | [SpecUtilsWithNullValue](./SpecUtilsWithNullValue.md) |   | +| `blocks` | [IndicesIndexSettingBlocks](./IndicesIndexSettingBlocks.md) |   | +| `check_on_startup` | [IndicesIndexCheckOnStartup](./IndicesIndexCheckOnStartup.md) |   | +| `codec` | string |   | +| `creation_date_string` | [DateTime](./DateTime.md) |   | +| `creation_date` | [SpecUtilsStringified](./SpecUtilsStringified.md)<[EpochTime](./EpochTime.md)<[UnitMillis](./UnitMillis.md)>> |   | +| `default_pipeline` | [PipelineName](./PipelineName.md) |   | +| `final_pipeline` | [PipelineName](./PipelineName.md) |   | +| `format` | string | [integer](./integer.md) |   | +| `gc_deletes` | [Duration](./Duration.md) |   | +| `hidden` | boolean | string |   | +| `highlight` | [IndicesSettingsHighlight](./IndicesSettingsHighlight.md) |   | +| `index` | [IndicesIndexSettings](./IndicesIndexSettings.md) |   | +| `indexing_pressure` | [IndicesIndexingPressure](./IndicesIndexingPressure.md) | Configure indexing back pressure limits. | +| `lifecycle` | [IndicesIndexSettingsLifecycle](./IndicesIndexSettingsLifecycle.md) |   | +| `load_fixed_bitset_filters_eagerly` | boolean |   | +| `mapping` | [IndicesMappingLimitSettings](./IndicesMappingLimitSettings.md) | Enable or disable dynamic mapping for an index. | +| `max_docvalue_fields_search` | [integer](./integer.md) |   | +| `max_inner_result_window` | [integer](./integer.md) |   | +| `max_ngram_diff` | [integer](./integer.md) |   | +| `max_refresh_listeners` | [integer](./integer.md) |   | +| `max_regex_length` | [integer](./integer.md) |   | +| `max_rescore_window` | [integer](./integer.md) |   | +| `max_result_window` | [integer](./integer.md) |   | +| `max_script_fields` | [integer](./integer.md) |   | +| `max_shingle_diff` | [integer](./integer.md) |   | +| `max_slices_per_scroll` | [integer](./integer.md) |   | +| `max_terms_count` | [integer](./integer.md) |   | +| `merge` | [IndicesMerge](./IndicesMerge.md) |   | +| `mode` | string |   | +| `number_of_replicas` | [integer](./integer.md) | string |   | +| `number_of_routing_shards` | [integer](./integer.md) |   | +| `number_of_shards` | [integer](./integer.md) | string |   | +| `priority` | [integer](./integer.md) | string |   | +| `provided_name` | [Name](./Name.md) |   | +| `queries` | [IndicesQueries](./IndicesQueries.md) |   | +| `query_string` | [IndicesSettingsQueryString](./IndicesSettingsQueryString.md) |   | +| `refresh_interval` | [Duration](./Duration.md) |   | +| `routing_partition_size` | [SpecUtilsStringified](./SpecUtilsStringified.md)<[integer](./integer.md)> |   | +| `routing_path` | string | string[] |   | +| `routing` | [IndicesIndexRouting](./IndicesIndexRouting.md) |   | +| `search` | [IndicesSettingsSearch](./IndicesSettingsSearch.md) |   | +| `settings` | [IndicesIndexSettings](./IndicesIndexSettings.md) |   | +| `similarity` | Record | Configure custom similarity settings to customize how search results are scored. | +| `soft_deletes` | [IndicesSoftDeletes](./IndicesSoftDeletes.md) |   | +| `sort` | [IndicesIndexSegmentSort](./IndicesIndexSegmentSort.md) |   | +| `store` | [IndicesStorage](./IndicesStorage.md) | The store module allows you to control how index data is stored and accessed on disk. | +| `time_series` | [IndicesIndexSettingsTimeSeries](./IndicesIndexSettingsTimeSeries.md) |   | +| `top_metrics_max_size` | [integer](./integer.md) |   | +| `translog` | [IndicesTranslog](./IndicesTranslog.md) |   | +| `uuid` | [Uuid](./Uuid.md) |   | +| `verified_before_close` | boolean | string |   | +| `version` | [IndicesIndexVersioning](./IndicesIndexVersioning.md) |   | diff --git a/docs/reference/api/IndicesIndexSettingsLifecycle.md b/docs/reference/api/IndicesIndexSettingsLifecycle.md new file mode 100644 index 000000000..882752861 --- /dev/null +++ b/docs/reference/api/IndicesIndexSettingsLifecycle.md @@ -0,0 +1,11 @@ +## Interface `IndicesIndexSettingsLifecycle` + +| Name | Type | Description | +| - | - | - | +| `indexing_complete` | [SpecUtilsStringified](./SpecUtilsStringified.md) | Indicates whether or not the index has been rolled over. Automatically set to true when ILM completes the rollover action. You can explicitly set it to skip rollover. | +| `name` | [Name](./Name.md) | The name of the policy to use to manage the index. For information about how Elasticsearch applies policy changes, see Policy updates. | +| `origination_date` | [long](./long.md) | If specified, this is the timestamp used to calculate the index age for its phase transitions. Use this setting if you create a new index that contains old data and want to use the original creation date to calculate the index age. Specified as a Unix epoch value in milliseconds. | +| `parse_origination_date` | boolean | Set to true to parse the origination date from the index name. This origination date is used to calculate the index age for its phase transitions. The index name must match the pattern ^.*- { date_format } - d+, where the date_format is yyyy.MM.dd and the trailing digits are optional. An index that was rolled over would normally match the full format, for example logs-2016.10.31-000002). If the index name doesn’t match the pattern, index creation fails. | +| `prefer_ilm` | boolean | string | Preference for the system that manages a data stream backing index (preferring ILM when both ILM and DLM are applicable for an index). | +| `rollover_alias` | string | The index alias to update when the index rolls over. Specify when using a policy that contains a rollover action. When the index rolls over, the alias is updated to reflect that the index is no longer the write index. For more information about rolling indices, see Rollover. | +| `step` | [IndicesIndexSettingsLifecycleStep](./IndicesIndexSettingsLifecycleStep.md) |   | diff --git a/docs/reference/api/IndicesIndexSettingsLifecycleStep.md b/docs/reference/api/IndicesIndexSettingsLifecycleStep.md new file mode 100644 index 000000000..6857c7a58 --- /dev/null +++ b/docs/reference/api/IndicesIndexSettingsLifecycleStep.md @@ -0,0 +1,5 @@ +## Interface `IndicesIndexSettingsLifecycleStep` + +| Name | Type | Description | +| - | - | - | +| `wait_time_threshold` | [Duration](./Duration.md) | Time to wait for the cluster to resolve allocation issues during an ILM shrink action. Must be greater than 1h (1 hour). See Shard allocation for shrink. | diff --git a/docs/reference/api/IndicesIndexSettingsTimeSeries.md b/docs/reference/api/IndicesIndexSettingsTimeSeries.md new file mode 100644 index 000000000..37900e7da --- /dev/null +++ b/docs/reference/api/IndicesIndexSettingsTimeSeries.md @@ -0,0 +1,6 @@ +## Interface `IndicesIndexSettingsTimeSeries` + +| Name | Type | Description | +| - | - | - | +| `end_time` | [DateTime](./DateTime.md) |   | +| `start_time` | [DateTime](./DateTime.md) |   | diff --git a/docs/reference/api/IndicesIndexState.md b/docs/reference/api/IndicesIndexState.md new file mode 100644 index 000000000..51780aa92 --- /dev/null +++ b/docs/reference/api/IndicesIndexState.md @@ -0,0 +1,10 @@ +## Interface `IndicesIndexState` + +| Name | Type | Description | +| - | - | - | +| `aliases` | Record<[IndexName](./IndexName.md), [IndicesAlias](./IndicesAlias.md)> |   | +| `data_stream` | [DataStreamName](./DataStreamName.md) |   | +| `defaults` | [IndicesIndexSettings](./IndicesIndexSettings.md) | Default settings, included when the request's `include_default` is `true`. | +| `lifecycle` | [IndicesDataStreamLifecycle](./IndicesDataStreamLifecycle.md) | Data stream lifecycle applicable if this is a data stream. | +| `mappings` | [MappingTypeMapping](./MappingTypeMapping.md) |   | +| `settings` | [IndicesIndexSettings](./IndicesIndexSettings.md) |   | diff --git a/docs/reference/api/IndicesIndexTemplate.md b/docs/reference/api/IndicesIndexTemplate.md new file mode 100644 index 000000000..b390032c3 --- /dev/null +++ b/docs/reference/api/IndicesIndexTemplate.md @@ -0,0 +1,14 @@ +## Interface `IndicesIndexTemplate` + +| Name | Type | Description | +| - | - | - | +| `_meta` | [Metadata](./Metadata.md) | Optional user metadata about the index template. May have any contents. This map is not automatically generated by Elasticsearch. | +| `allow_auto_create` | boolean |   | +| `composed_of` | [Name](./Name.md)[] | An ordered list of component template names. Component templates are merged in the order specified, meaning that the last component template specified has the highest precedence. | +| `data_stream` | [IndicesIndexTemplateDataStreamConfiguration](./IndicesIndexTemplateDataStreamConfiguration.md) | If this object is included, the template is used to create data streams and their backing indices. Supports an empty object. Data streams require a matching index template with a `data_stream` object. | +| `deprecated` | boolean | Marks this index template as deprecated. When creating or updating a non-deprecated index template that uses deprecated components, Elasticsearch will emit a deprecation warning. | +| `ignore_missing_component_templates` | [Names](./Names.md) | A list of component template names that are allowed to be absent. | +| `index_patterns` | [Names](./Names.md) | Name of the index template. | +| `priority` | [long](./long.md) | Priority to determine index template precedence when a new data stream or index is created. The index template with the highest priority is chosen. If no priority is specified the template is treated as though it is of priority 0 (lowest priority). This number is not automatically generated by Elasticsearch. | +| `template` | [IndicesIndexTemplateSummary](./IndicesIndexTemplateSummary.md) | Template to be applied. It may optionally include an `aliases`, `mappings`, or `settings` configuration. | +| `version` | [VersionNumber](./VersionNumber.md) | Version number used to manage index templates externally. This number is not automatically generated by Elasticsearch. | diff --git a/docs/reference/api/IndicesIndexTemplateDataStreamConfiguration.md b/docs/reference/api/IndicesIndexTemplateDataStreamConfiguration.md new file mode 100644 index 000000000..bf6145dc1 --- /dev/null +++ b/docs/reference/api/IndicesIndexTemplateDataStreamConfiguration.md @@ -0,0 +1,6 @@ +## Interface `IndicesIndexTemplateDataStreamConfiguration` + +| Name | Type | Description | +| - | - | - | +| `allow_custom_routing` | boolean | If true, the data stream supports custom routing. | +| `hidden` | boolean | If true, the data stream is hidden. | diff --git a/docs/reference/api/IndicesIndexTemplateSummary.md b/docs/reference/api/IndicesIndexTemplateSummary.md new file mode 100644 index 000000000..02274996a --- /dev/null +++ b/docs/reference/api/IndicesIndexTemplateSummary.md @@ -0,0 +1,8 @@ +## Interface `IndicesIndexTemplateSummary` + +| Name | Type | Description | +| - | - | - | +| `aliases` | Record<[IndexName](./IndexName.md), [IndicesAlias](./IndicesAlias.md)> | Aliases to add. If the index template includes a `data_stream` object, these are data stream aliases. Otherwise, these are index aliases. Data stream aliases ignore the `index_routing`, `routing`, and `search_routing` options. | +| `lifecycle` | [IndicesDataStreamLifecycleWithRollover](./IndicesDataStreamLifecycleWithRollover.md) |   | +| `mappings` | [MappingTypeMapping](./MappingTypeMapping.md) | Mapping for fields in the index. If specified, this mapping can include field names, field data types, and mapping parameters. | +| `settings` | [IndicesIndexSettings](./IndicesIndexSettings.md) | Configuration options for the index. | diff --git a/docs/reference/api/IndicesIndexVersioning.md b/docs/reference/api/IndicesIndexVersioning.md new file mode 100644 index 000000000..9ef15a5d8 --- /dev/null +++ b/docs/reference/api/IndicesIndexVersioning.md @@ -0,0 +1,6 @@ +## Interface `IndicesIndexVersioning` + +| Name | Type | Description | +| - | - | - | +| `created_string` | string |   | +| `created` | [VersionString](./VersionString.md) |   | diff --git a/docs/reference/api/IndicesIndexingPressure.md b/docs/reference/api/IndicesIndexingPressure.md new file mode 100644 index 000000000..c435f9768 --- /dev/null +++ b/docs/reference/api/IndicesIndexingPressure.md @@ -0,0 +1,5 @@ +## Interface `IndicesIndexingPressure` + +| Name | Type | Description | +| - | - | - | +| `memory` | [IndicesIndexingPressureMemory](./IndicesIndexingPressureMemory.md) |   | diff --git a/docs/reference/api/IndicesIndexingPressureMemory.md b/docs/reference/api/IndicesIndexingPressureMemory.md new file mode 100644 index 000000000..5c45b49ea --- /dev/null +++ b/docs/reference/api/IndicesIndexingPressureMemory.md @@ -0,0 +1,5 @@ +## Interface `IndicesIndexingPressureMemory` + +| Name | Type | Description | +| - | - | - | +| `limit` | [integer](./integer.md) | Number of outstanding bytes that may be consumed by indexing requests. When this limit is reached or exceeded, the node will reject new coordinating and primary operations. When replica operations consume 1.5x this limit, the node will reject new replica operations. Defaults to 10% of the heap. | diff --git a/docs/reference/api/IndicesIndexingSlowlogSettings.md b/docs/reference/api/IndicesIndexingSlowlogSettings.md new file mode 100644 index 000000000..55da376b1 --- /dev/null +++ b/docs/reference/api/IndicesIndexingSlowlogSettings.md @@ -0,0 +1,8 @@ +## Interface `IndicesIndexingSlowlogSettings` + +| Name | Type | Description | +| - | - | - | +| `level` | string |   | +| `reformat` | boolean |   | +| `source` | [integer](./integer.md) |   | +| `threshold` | [IndicesIndexingSlowlogTresholds](./IndicesIndexingSlowlogTresholds.md) |   | diff --git a/docs/reference/api/IndicesIndexingSlowlogTresholds.md b/docs/reference/api/IndicesIndexingSlowlogTresholds.md new file mode 100644 index 000000000..5b348dadf --- /dev/null +++ b/docs/reference/api/IndicesIndexingSlowlogTresholds.md @@ -0,0 +1,5 @@ +## Interface `IndicesIndexingSlowlogTresholds` + +| Name | Type | Description | +| - | - | - | +| `index` | [IndicesSlowlogTresholdLevels](./IndicesSlowlogTresholdLevels.md) | The indexing slow log, similar in functionality to the search slow log. The log file name ends with `_index_indexing_slowlog.json`. Log and the thresholds are configured in the same way as the search slowlog. | diff --git a/docs/reference/api/IndicesManagedBy.md b/docs/reference/api/IndicesManagedBy.md new file mode 100644 index 000000000..73d4ecdd7 --- /dev/null +++ b/docs/reference/api/IndicesManagedBy.md @@ -0,0 +1,4 @@ +## `IndicesManagedBy` +::: +type IndicesManagedBy = 'Index Lifecycle Management' | 'Data stream lifecycle' | 'Unmanaged'; +::: diff --git a/docs/reference/api/IndicesMappingLimitSettings.md b/docs/reference/api/IndicesMappingLimitSettings.md new file mode 100644 index 000000000..d155e5cd0 --- /dev/null +++ b/docs/reference/api/IndicesMappingLimitSettings.md @@ -0,0 +1,13 @@ +## Interface `IndicesMappingLimitSettings` + +| Name | Type | Description | +| - | - | - | +| `coerce` | boolean |   | +| `depth` | [IndicesMappingLimitSettingsDepth](./IndicesMappingLimitSettingsDepth.md) |   | +| `dimension_fields` | [IndicesMappingLimitSettingsDimensionFields](./IndicesMappingLimitSettingsDimensionFields.md) |   | +| `field_name_length` | [IndicesMappingLimitSettingsFieldNameLength](./IndicesMappingLimitSettingsFieldNameLength.md) |   | +| `ignore_malformed` | boolean | string |   | +| `nested_fields` | [IndicesMappingLimitSettingsNestedFields](./IndicesMappingLimitSettingsNestedFields.md) |   | +| `nested_objects` | [IndicesMappingLimitSettingsNestedObjects](./IndicesMappingLimitSettingsNestedObjects.md) |   | +| `source` | [IndicesMappingLimitSettingsSourceFields](./IndicesMappingLimitSettingsSourceFields.md) |   | +| `total_fields` | [IndicesMappingLimitSettingsTotalFields](./IndicesMappingLimitSettingsTotalFields.md) |   | diff --git a/docs/reference/api/IndicesMappingLimitSettingsDepth.md b/docs/reference/api/IndicesMappingLimitSettingsDepth.md new file mode 100644 index 000000000..6e7a5bb80 --- /dev/null +++ b/docs/reference/api/IndicesMappingLimitSettingsDepth.md @@ -0,0 +1,5 @@ +## Interface `IndicesMappingLimitSettingsDepth` + +| Name | Type | Description | +| - | - | - | +| `limit` | [long](./long.md) | The maximum depth for a field, which is measured as the number of inner objects. For instance, if all fields are defined at the root object level, then the depth is 1. If there is one object mapping, then the depth is 2, etc. | diff --git a/docs/reference/api/IndicesMappingLimitSettingsDimensionFields.md b/docs/reference/api/IndicesMappingLimitSettingsDimensionFields.md new file mode 100644 index 000000000..85ede244f --- /dev/null +++ b/docs/reference/api/IndicesMappingLimitSettingsDimensionFields.md @@ -0,0 +1,5 @@ +## Interface `IndicesMappingLimitSettingsDimensionFields` + +| Name | Type | Description | +| - | - | - | +| `limit` | [long](./long.md) | [preview] This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. | diff --git a/docs/reference/api/IndicesMappingLimitSettingsFieldNameLength.md b/docs/reference/api/IndicesMappingLimitSettingsFieldNameLength.md new file mode 100644 index 000000000..8963b0dfb --- /dev/null +++ b/docs/reference/api/IndicesMappingLimitSettingsFieldNameLength.md @@ -0,0 +1,5 @@ +## Interface `IndicesMappingLimitSettingsFieldNameLength` + +| Name | Type | Description | +| - | - | - | +| `limit` | [long](./long.md) | Setting for the maximum length of a field name. This setting isn’t really something that addresses mappings explosion but might still be useful if you want to limit the field length. It usually shouldn’t be necessary to set this setting. The default is okay unless a user starts to add a huge number of fields with really long names. Default is `Long.MAX_VALUE` (no limit). | diff --git a/docs/reference/api/IndicesMappingLimitSettingsNestedFields.md b/docs/reference/api/IndicesMappingLimitSettingsNestedFields.md new file mode 100644 index 000000000..3383442ca --- /dev/null +++ b/docs/reference/api/IndicesMappingLimitSettingsNestedFields.md @@ -0,0 +1,5 @@ +## Interface `IndicesMappingLimitSettingsNestedFields` + +| Name | Type | Description | +| - | - | - | +| `limit` | [long](./long.md) | The maximum number of distinct nested mappings in an index. The nested type should only be used in special cases, when arrays of objects need to be queried independently of each other. To safeguard against poorly designed mappings, this setting limits the number of unique nested types per index. | diff --git a/docs/reference/api/IndicesMappingLimitSettingsNestedObjects.md b/docs/reference/api/IndicesMappingLimitSettingsNestedObjects.md new file mode 100644 index 000000000..ad2959ba5 --- /dev/null +++ b/docs/reference/api/IndicesMappingLimitSettingsNestedObjects.md @@ -0,0 +1,5 @@ +## Interface `IndicesMappingLimitSettingsNestedObjects` + +| Name | Type | Description | +| - | - | - | +| `limit` | [long](./long.md) | The maximum number of nested JSON objects that a single document can contain across all nested types. This limit helps to prevent out of memory errors when a document contains too many nested objects. | diff --git a/docs/reference/api/IndicesMappingLimitSettingsSourceFields.md b/docs/reference/api/IndicesMappingLimitSettingsSourceFields.md new file mode 100644 index 000000000..23502e881 --- /dev/null +++ b/docs/reference/api/IndicesMappingLimitSettingsSourceFields.md @@ -0,0 +1,5 @@ +## Interface `IndicesMappingLimitSettingsSourceFields` + +| Name | Type | Description | +| - | - | - | +| `mode` | [IndicesSourceMode](./IndicesSourceMode.md) |   | diff --git a/docs/reference/api/IndicesMappingLimitSettingsTotalFields.md b/docs/reference/api/IndicesMappingLimitSettingsTotalFields.md new file mode 100644 index 000000000..f5a1ab49a --- /dev/null +++ b/docs/reference/api/IndicesMappingLimitSettingsTotalFields.md @@ -0,0 +1,6 @@ +## Interface `IndicesMappingLimitSettingsTotalFields` + +| Name | Type | Description | +| - | - | - | +| `ignore_dynamic_beyond_limit` | boolean | string | This setting determines what happens when a dynamically mapped field would exceed the total fields limit. When set to false (the default), the index request of the document that tries to add a dynamic field to the mapping will fail with the message Limit of total fields [X] has been exceeded. When set to true, the index request will not fail. Instead, fields that would exceed the limit are not added to the mapping, similar to dynamic: false. The fields that were not added to the mapping will be added to the _ignored field. | +| `limit` | [long](./long.md) | string | The maximum number of fields in an index. Field and object mappings, as well as field aliases count towards this limit. The limit is in place to prevent mappings and searches from becoming too large. Higher values can lead to performance degradations and memory issues, especially in clusters with a high load or few resources. | diff --git a/docs/reference/api/IndicesMerge.md b/docs/reference/api/IndicesMerge.md new file mode 100644 index 000000000..7855731b2 --- /dev/null +++ b/docs/reference/api/IndicesMerge.md @@ -0,0 +1,5 @@ +## Interface `IndicesMerge` + +| Name | Type | Description | +| - | - | - | +| `scheduler` | [IndicesMergeScheduler](./IndicesMergeScheduler.md) |   | diff --git a/docs/reference/api/IndicesMergeScheduler.md b/docs/reference/api/IndicesMergeScheduler.md new file mode 100644 index 000000000..118e605a1 --- /dev/null +++ b/docs/reference/api/IndicesMergeScheduler.md @@ -0,0 +1,6 @@ +## Interface `IndicesMergeScheduler` + +| Name | Type | Description | +| - | - | - | +| `max_merge_count` | [SpecUtilsStringified](./SpecUtilsStringified.md)<[integer](./integer.md)> |   | +| `max_thread_count` | [SpecUtilsStringified](./SpecUtilsStringified.md)<[integer](./integer.md)> |   | diff --git a/docs/reference/api/IndicesMigrateReindexMigrateReindex.md b/docs/reference/api/IndicesMigrateReindexMigrateReindex.md new file mode 100644 index 000000000..ade1296fd --- /dev/null +++ b/docs/reference/api/IndicesMigrateReindexMigrateReindex.md @@ -0,0 +1,6 @@ +## Interface `IndicesMigrateReindexMigrateReindex` + +| Name | Type | Description | +| - | - | - | +| `mode` | [IndicesMigrateReindexModeEnum](./IndicesMigrateReindexModeEnum.md) | Reindex mode. Currently only 'upgrade' is supported. | +| `source` | [IndicesMigrateReindexSourceIndex](./IndicesMigrateReindexSourceIndex.md) | The source index or data stream (only data streams are currently supported). | diff --git a/docs/reference/api/IndicesMigrateReindexModeEnum.md b/docs/reference/api/IndicesMigrateReindexModeEnum.md new file mode 100644 index 000000000..e0aacb2c7 --- /dev/null +++ b/docs/reference/api/IndicesMigrateReindexModeEnum.md @@ -0,0 +1,4 @@ +## `IndicesMigrateReindexModeEnum` +::: +type IndicesMigrateReindexModeEnum = 'upgrade'; +::: diff --git a/docs/reference/api/IndicesMigrateReindexRequest.md b/docs/reference/api/IndicesMigrateReindexRequest.md new file mode 100644 index 000000000..9dc28c28b --- /dev/null +++ b/docs/reference/api/IndicesMigrateReindexRequest.md @@ -0,0 +1,7 @@ +## Interface `IndicesMigrateReindexRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { reindex?: never; }) | All values in `body` will be added to the request body. | +| `querystring` | { [key: string]: any; } & { reindex?: never; } | All values in `querystring` will be added to the request querystring. | +| `reindex` | [IndicesMigrateReindexMigrateReindex](./IndicesMigrateReindexMigrateReindex.md) |   | diff --git a/docs/reference/api/IndicesMigrateReindexResponse.md b/docs/reference/api/IndicesMigrateReindexResponse.md new file mode 100644 index 000000000..e132b4e83 --- /dev/null +++ b/docs/reference/api/IndicesMigrateReindexResponse.md @@ -0,0 +1,4 @@ +## `IndicesMigrateReindexResponse` +::: +type IndicesMigrateReindexResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); +::: diff --git a/docs/reference/api/IndicesMigrateReindexSourceIndex.md b/docs/reference/api/IndicesMigrateReindexSourceIndex.md new file mode 100644 index 000000000..2ba65866d --- /dev/null +++ b/docs/reference/api/IndicesMigrateReindexSourceIndex.md @@ -0,0 +1,5 @@ +## Interface `IndicesMigrateReindexSourceIndex` + +| Name | Type | Description | +| - | - | - | +| `index` | [IndexName](./IndexName.md) |   | diff --git a/docs/reference/api/IndicesMigrateToDataStreamRequest.md b/docs/reference/api/IndicesMigrateToDataStreamRequest.md new file mode 100644 index 000000000..204b9bfb8 --- /dev/null +++ b/docs/reference/api/IndicesMigrateToDataStreamRequest.md @@ -0,0 +1,9 @@ +## Interface `IndicesMigrateToDataStreamRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { name?: never; master_timeout?: never; timeout?: never; }) | All values in `body` will be added to the request body. | +| `master_timeout` | [Duration](./Duration.md) | Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. | +| `name` | [IndexName](./IndexName.md) | Name of the index alias to convert to a data stream. | +| `querystring` | { [key: string]: any; } & { name?: never; master_timeout?: never; timeout?: never; } | All values in `querystring` will be added to the request querystring. | +| `timeout` | [Duration](./Duration.md) | Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. | diff --git a/docs/reference/api/IndicesMigrateToDataStreamResponse.md b/docs/reference/api/IndicesMigrateToDataStreamResponse.md new file mode 100644 index 000000000..b2bc272bd --- /dev/null +++ b/docs/reference/api/IndicesMigrateToDataStreamResponse.md @@ -0,0 +1,4 @@ +## `IndicesMigrateToDataStreamResponse` +::: +type IndicesMigrateToDataStreamResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); +::: diff --git a/docs/reference/api/IndicesModifyDataStreamAction.md b/docs/reference/api/IndicesModifyDataStreamAction.md new file mode 100644 index 000000000..3210bc6f7 --- /dev/null +++ b/docs/reference/api/IndicesModifyDataStreamAction.md @@ -0,0 +1,6 @@ +## Interface `IndicesModifyDataStreamAction` + +| Name | Type | Description | +| - | - | - | +| `add_backing_index` | [IndicesModifyDataStreamIndexAndDataStreamAction](./IndicesModifyDataStreamIndexAndDataStreamAction.md) | Adds an existing index as a backing index for a data stream. The index is hidden as part of this operation. WARNING: Adding indices with the `add_backing_index` action can potentially result in improper data stream behavior. This should be considered an expert level API. | +| `remove_backing_index` | [IndicesModifyDataStreamIndexAndDataStreamAction](./IndicesModifyDataStreamIndexAndDataStreamAction.md) | Removes a backing index from a data stream. The index is unhidden as part of this operation. A data stream’s write index cannot be removed. | diff --git a/docs/reference/api/IndicesModifyDataStreamIndexAndDataStreamAction.md b/docs/reference/api/IndicesModifyDataStreamIndexAndDataStreamAction.md new file mode 100644 index 000000000..22426e12d --- /dev/null +++ b/docs/reference/api/IndicesModifyDataStreamIndexAndDataStreamAction.md @@ -0,0 +1,6 @@ +## Interface `IndicesModifyDataStreamIndexAndDataStreamAction` + +| Name | Type | Description | +| - | - | - | +| `data_stream` | [DataStreamName](./DataStreamName.md) | Data stream targeted by the action. | +| `index` | [IndexName](./IndexName.md) | Index for the action. | diff --git a/docs/reference/api/IndicesModifyDataStreamRequest.md b/docs/reference/api/IndicesModifyDataStreamRequest.md new file mode 100644 index 000000000..fe41eced4 --- /dev/null +++ b/docs/reference/api/IndicesModifyDataStreamRequest.md @@ -0,0 +1,7 @@ +## Interface `IndicesModifyDataStreamRequest` + +| Name | Type | Description | +| - | - | - | +| `actions` | [IndicesModifyDataStreamAction](./IndicesModifyDataStreamAction.md)[] | Actions to perform. | +| `body` | string | ({ [key: string]: any; } & { actions?: never; }) | All values in `body` will be added to the request body. | +| `querystring` | { [key: string]: any; } & { actions?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/IndicesModifyDataStreamResponse.md b/docs/reference/api/IndicesModifyDataStreamResponse.md new file mode 100644 index 000000000..b74dd312b --- /dev/null +++ b/docs/reference/api/IndicesModifyDataStreamResponse.md @@ -0,0 +1,4 @@ +## `IndicesModifyDataStreamResponse` +::: +type IndicesModifyDataStreamResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); +::: diff --git a/docs/reference/api/IndicesNumericFielddata.md b/docs/reference/api/IndicesNumericFielddata.md new file mode 100644 index 000000000..752decfe3 --- /dev/null +++ b/docs/reference/api/IndicesNumericFielddata.md @@ -0,0 +1,5 @@ +## Interface `IndicesNumericFielddata` + +| Name | Type | Description | +| - | - | - | +| `format` | [IndicesNumericFielddataFormat](./IndicesNumericFielddataFormat.md) |   | diff --git a/docs/reference/api/IndicesNumericFielddataFormat.md b/docs/reference/api/IndicesNumericFielddataFormat.md new file mode 100644 index 000000000..bee1245a3 --- /dev/null +++ b/docs/reference/api/IndicesNumericFielddataFormat.md @@ -0,0 +1,4 @@ +## `IndicesNumericFielddataFormat` +::: +type IndicesNumericFielddataFormat = 'array' | 'disabled'; +::: diff --git a/docs/reference/api/IndicesOpenRequest.md b/docs/reference/api/IndicesOpenRequest.md new file mode 100644 index 000000000..7ff98fd42 --- /dev/null +++ b/docs/reference/api/IndicesOpenRequest.md @@ -0,0 +1,13 @@ +## Interface `IndicesOpenRequest` + +| Name | Type | Description | +| - | - | - | +| `allow_no_indices` | boolean | If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. | +| `body` | string | ({ [key: string]: any; } & { index?: never; allow_no_indices?: never; expand_wildcards?: never; ignore_unavailable?: never; master_timeout?: never; timeout?: never; wait_for_active_shards?: never; }) | All values in `body` will be added to the request body. | +| `expand_wildcards` | [ExpandWildcards](./ExpandWildcards.md) | Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. | +| `ignore_unavailable` | boolean | If `false`, the request returns an error if it targets a missing or closed index. | +| `index` | [Indices](./Indices.md) | Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards ( `*`). By default, you must explicitly name the indices you using to limit the request. To limit a request using `_all`, `*`, or other wildcard expressions, change the `action.destructive_requires_name` setting to false. You can update this setting in the `elasticsearch.yml` file or using the cluster update settings API. | +| `master_timeout` | [Duration](./Duration.md) | Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. | +| `querystring` | { [key: string]: any; } & { index?: never; allow_no_indices?: never; expand_wildcards?: never; ignore_unavailable?: never; master_timeout?: never; timeout?: never; wait_for_active_shards?: never; } | All values in `querystring` will be added to the request querystring. | +| `timeout` | [Duration](./Duration.md) | Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. | +| `wait_for_active_shards` | [WaitForActiveShards](./WaitForActiveShards.md) | The number of shard copies that must be active before proceeding with the operation. Set to `all` or any positive integer up to the total number of shards in the index ( `number_of_replicas+1`). | diff --git a/docs/reference/api/IndicesOpenResponse.md b/docs/reference/api/IndicesOpenResponse.md new file mode 100644 index 000000000..3c07301ca --- /dev/null +++ b/docs/reference/api/IndicesOpenResponse.md @@ -0,0 +1,6 @@ +## Interface `IndicesOpenResponse` + +| Name | Type | Description | +| - | - | - | +| `acknowledged` | boolean |   | +| `shards_acknowledged` | boolean |   | diff --git a/docs/reference/api/IndicesOptions.md b/docs/reference/api/IndicesOptions.md new file mode 100644 index 000000000..287a77398 --- /dev/null +++ b/docs/reference/api/IndicesOptions.md @@ -0,0 +1,8 @@ +## Interface `IndicesOptions` + +| Name | Type | Description | +| - | - | - | +| `allow_no_indices` | boolean | If false, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. | +| `expand_wildcards` | [ExpandWildcards](./ExpandWildcards.md) | Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. | +| `ignore_throttled` | boolean | If true, concrete, expanded or aliased indices are ignored when frozen. | +| `ignore_unavailable` | boolean | If true, missing or closed indices are not included in the response. | diff --git a/docs/reference/api/IndicesPromoteDataStreamRequest.md b/docs/reference/api/IndicesPromoteDataStreamRequest.md new file mode 100644 index 000000000..3217cc28c --- /dev/null +++ b/docs/reference/api/IndicesPromoteDataStreamRequest.md @@ -0,0 +1,8 @@ +## Interface `IndicesPromoteDataStreamRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { name?: never; master_timeout?: never; }) | All values in `body` will be added to the request body. | +| `master_timeout` | [Duration](./Duration.md) | Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. | +| `name` | [IndexName](./IndexName.md) | The name of the data stream | +| `querystring` | { [key: string]: any; } & { name?: never; master_timeout?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/IndicesPromoteDataStreamResponse.md b/docs/reference/api/IndicesPromoteDataStreamResponse.md new file mode 100644 index 000000000..67ae6e4c8 --- /dev/null +++ b/docs/reference/api/IndicesPromoteDataStreamResponse.md @@ -0,0 +1,4 @@ +## `IndicesPromoteDataStreamResponse` +::: +type IndicesPromoteDataStreamResponse = any; +::: diff --git a/docs/reference/api/IndicesPutAliasRequest.md b/docs/reference/api/IndicesPutAliasRequest.md new file mode 100644 index 000000000..98f4cbd48 --- /dev/null +++ b/docs/reference/api/IndicesPutAliasRequest.md @@ -0,0 +1,15 @@ +## Interface `IndicesPutAliasRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { index?: never; name?: never; master_timeout?: never; timeout?: never; filter?: never; index_routing?: never; is_write_index?: never; routing?: never; search_routing?: never; }) | All values in `body` will be added to the request body. | +| `filter` | [QueryDslQueryContainer](./QueryDslQueryContainer.md) | Query used to limit documents the alias can access. | +| `index_routing` | [Routing](./Routing.md) | Value used to route indexing operations to a specific shard. If specified, this overwrites the `routing` value for indexing operations. Data stream aliases don’t support this parameter. | +| `index` | [Indices](./Indices.md) | Comma-separated list of data streams or indices to add. Supports wildcards ( `*`). Wildcard patterns that match both data streams and indices return an error. | +| `is_write_index` | boolean | If `true`, sets the write index or data stream for the alias. If an alias points to multiple indices or data streams and `is_write_index` isn’t set, the alias rejects write requests. If an index alias points to one index and `is_write_index` isn’t set, the index automatically acts as the write index. Data stream aliases don’t automatically set a write data stream, even if the alias points to one data stream. | +| `master_timeout` | [Duration](./Duration.md) | Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. | +| `name` | [Name](./Name.md) | Alias to update. If the alias doesn’t exist, the request creates it. Index alias names support date math. | +| `querystring` | { [key: string]: any; } & { index?: never; name?: never; master_timeout?: never; timeout?: never; filter?: never; index_routing?: never; is_write_index?: never; routing?: never; search_routing?: never; } | All values in `querystring` will be added to the request querystring. | +| `routing` | [Routing](./Routing.md) | Value used to route indexing and search operations to a specific shard. Data stream aliases don’t support this parameter. | +| `search_routing` | [Routing](./Routing.md) | Value used to route search operations to a specific shard. If specified, this overwrites the `routing` value for search operations. Data stream aliases don’t support this parameter. | +| `timeout` | [Duration](./Duration.md) | Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. | diff --git a/docs/reference/api/IndicesPutAliasResponse.md b/docs/reference/api/IndicesPutAliasResponse.md new file mode 100644 index 000000000..56604c9bf --- /dev/null +++ b/docs/reference/api/IndicesPutAliasResponse.md @@ -0,0 +1,4 @@ +## `IndicesPutAliasResponse` +::: +type IndicesPutAliasResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); +::: diff --git a/docs/reference/api/IndicesPutDataLifecycleRequest.md b/docs/reference/api/IndicesPutDataLifecycleRequest.md new file mode 100644 index 000000000..45a8edb6c --- /dev/null +++ b/docs/reference/api/IndicesPutDataLifecycleRequest.md @@ -0,0 +1,13 @@ +## Interface `IndicesPutDataLifecycleRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { name?: never; expand_wildcards?: never; master_timeout?: never; timeout?: never; data_retention?: never; downsampling?: never; enabled?: never; }) | All values in `body` will be added to the request body. | +| `data_retention` | [Duration](./Duration.md) | If defined, every document added to this data stream will be stored at least for this time frame. Any time after this duration the document could be deleted. When empty, every document in this data stream will be stored indefinitely. | +| `downsampling` | [IndicesDataStreamLifecycleDownsampling](./IndicesDataStreamLifecycleDownsampling.md) | The downsampling configuration to execute for the managed backing index after rollover. | +| `enabled` | boolean | If defined, it turns data stream lifecycle on/off ( `true`/ `false`) for this data stream. A data stream lifecycle that's disabled (enabled: `false`) will have no effect on the data stream. | +| `expand_wildcards` | [ExpandWildcards](./ExpandWildcards.md) | Type of data stream that wildcard patterns can match. Supports comma-separated values, such as `open,hidden`. Valid values are: `all`, `hidden`, `open`, `closed`, `none`. | +| `master_timeout` | [Duration](./Duration.md) | Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. | +| `name` | [DataStreamNames](./DataStreamNames.md) | Comma-separated list of data streams used to limit the request. Supports wildcards ( `*`). To target all data streams use `*` or `_all`. | +| `querystring` | { [key: string]: any; } & { name?: never; expand_wildcards?: never; master_timeout?: never; timeout?: never; data_retention?: never; downsampling?: never; enabled?: never; } | All values in `querystring` will be added to the request querystring. | +| `timeout` | [Duration](./Duration.md) | Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. | diff --git a/docs/reference/api/IndicesPutDataLifecycleResponse.md b/docs/reference/api/IndicesPutDataLifecycleResponse.md new file mode 100644 index 000000000..13292e82f --- /dev/null +++ b/docs/reference/api/IndicesPutDataLifecycleResponse.md @@ -0,0 +1,4 @@ +## `IndicesPutDataLifecycleResponse` +::: +type IndicesPutDataLifecycleResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); +::: diff --git a/docs/reference/api/IndicesPutIndexTemplateIndexTemplateMapping.md b/docs/reference/api/IndicesPutIndexTemplateIndexTemplateMapping.md new file mode 100644 index 000000000..48eb797cc --- /dev/null +++ b/docs/reference/api/IndicesPutIndexTemplateIndexTemplateMapping.md @@ -0,0 +1,8 @@ +## Interface `IndicesPutIndexTemplateIndexTemplateMapping` + +| Name | Type | Description | +| - | - | - | +| `aliases` | Record<[IndexName](./IndexName.md), [IndicesAlias](./IndicesAlias.md)> | Aliases to add. If the index template includes a `data_stream` object, these are data stream aliases. Otherwise, these are index aliases. Data stream aliases ignore the `index_routing`, `routing`, and `search_routing` options. | +| `lifecycle` | [IndicesDataStreamLifecycle](./IndicesDataStreamLifecycle.md) |   | +| `mappings` | [MappingTypeMapping](./MappingTypeMapping.md) | Mapping for fields in the index. If specified, this mapping can include field names, field data types, and mapping parameters. | +| `settings` | [IndicesIndexSettings](./IndicesIndexSettings.md) | Configuration options for the index. | diff --git a/docs/reference/api/IndicesPutIndexTemplateRequest.md b/docs/reference/api/IndicesPutIndexTemplateRequest.md new file mode 100644 index 000000000..9ff54696d --- /dev/null +++ b/docs/reference/api/IndicesPutIndexTemplateRequest.md @@ -0,0 +1,20 @@ +## Interface `IndicesPutIndexTemplateRequest` + +| Name | Type | Description | +| - | - | - | +| `_meta` | [Metadata](./Metadata.md) | Optional user metadata about the index template. It may have any contents. It is not automatically generated or used by Elasticsearch. This user-defined object is stored in the cluster state, so keeping it short is preferable To unset the metadata, replace the template without specifying it. | +| `allow_auto_create` | boolean | This setting overrides the value of the `action.auto_create_index` cluster setting. If set to `true` in a template, then indices can be automatically created using that template even if auto-creation of indices is disabled via `actions.auto_create_index`. If set to `false`, then indices or data streams matching the template must always be explicitly created, and may never be automatically created. | +| `body` | string | ({ [key: string]: any; } & { name?: never; create?: never; master_timeout?: never; cause?: never; index_patterns?: never; composed_of?: never; template?: never; data_stream?: never; priority?: never; version?: never; _meta?: never; allow_auto_create?: never; ignore_missing_component_templates?: never; deprecated?: never; }) | All values in `body` will be added to the request body. | +| `cause` | string | User defined reason for creating/updating the index template | +| `composed_of` | [Name](./Name.md)[] | An ordered list of component template names. Component templates are merged in the order specified, meaning that the last component template specified has the highest precedence. | +| `create` | boolean | If `true`, this request cannot replace or update existing index templates. | +| `data_stream` | [IndicesDataStreamVisibility](./IndicesDataStreamVisibility.md) | If this object is included, the template is used to create data streams and their backing indices. Supports an empty object. Data streams require a matching index template with a `data_stream` object. | +| `deprecated` | boolean | Marks this index template as deprecated. When creating or updating a non-deprecated index template that uses deprecated components, Elasticsearch will emit a deprecation warning. | +| `ignore_missing_component_templates` | string[] | The configuration option ignore_missing_component_templates can be used when an index template references a component template that might not exist | +| `index_patterns` | [Indices](./Indices.md) | Name of the index template to create. | +| `master_timeout` | [Duration](./Duration.md) | Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. | +| `name` | [Name](./Name.md) | Index or template name | +| `priority` | [long](./long.md) | Priority to determine index template precedence when a new data stream or index is created. The index template with the highest priority is chosen. If no priority is specified the template is treated as though it is of priority 0 (lowest priority). This number is not automatically generated by Elasticsearch. | +| `querystring` | { [key: string]: any; } & { name?: never; create?: never; master_timeout?: never; cause?: never; index_patterns?: never; composed_of?: never; template?: never; data_stream?: never; priority?: never; version?: never; _meta?: never; allow_auto_create?: never; ignore_missing_component_templates?: never; deprecated?: never; } | All values in `querystring` will be added to the request querystring. | +| `template` | [IndicesPutIndexTemplateIndexTemplateMapping](./IndicesPutIndexTemplateIndexTemplateMapping.md) | Template to be applied. It may optionally include an `aliases`, `mappings`, or `settings` configuration. | +| `version` | [VersionNumber](./VersionNumber.md) | Version number used to manage index templates externally. This number is not automatically generated by Elasticsearch. External systems can use these version numbers to simplify template management. To unset a version, replace the template without specifying one. | diff --git a/docs/reference/api/IndicesPutIndexTemplateResponse.md b/docs/reference/api/IndicesPutIndexTemplateResponse.md new file mode 100644 index 000000000..c3a781caf --- /dev/null +++ b/docs/reference/api/IndicesPutIndexTemplateResponse.md @@ -0,0 +1,4 @@ +## `IndicesPutIndexTemplateResponse` +::: +type IndicesPutIndexTemplateResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); +::: diff --git a/docs/reference/api/IndicesPutMappingRequest.md b/docs/reference/api/IndicesPutMappingRequest.md new file mode 100644 index 000000000..f34fe59f1 --- /dev/null +++ b/docs/reference/api/IndicesPutMappingRequest.md @@ -0,0 +1,24 @@ +## Interface `IndicesPutMappingRequest` + +| Name | Type | Description | +| - | - | - | +| `_field_names` | [MappingFieldNamesField](./MappingFieldNamesField.md) | Control whether field names are enabled for the index. | +| `_meta` | [Metadata](./Metadata.md) | A mapping type can have custom meta data associated with it. These are not used at all by Elasticsearch, but can be used to store application-specific metadata. | +| `_routing` | [MappingRoutingField](./MappingRoutingField.md) | Enable making a routing value required on indexed documents. | +| `_source` | [MappingSourceField](./MappingSourceField.md) | Control whether the _source field is enabled on the index. | +| `allow_no_indices` | boolean | If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. | +| `body` | string | ({ [key: string]: any; } & { index?: never; allow_no_indices?: never; expand_wildcards?: never; ignore_unavailable?: never; master_timeout?: never; timeout?: never; write_index_only?: never; date_detection?: never; dynamic?: never; dynamic_date_formats?: never; dynamic_templates?: never; _field_names?: never; _meta?: never; numeric_detection?: never; properties?: never; _routing?: never; _source?: never; runtime?: never; }) | All values in `body` will be added to the request body. | +| `date_detection` | boolean | Controls whether dynamic date detection is enabled. | +| `dynamic_date_formats` | string[] | If date detection is enabled then new string fields are checked against 'dynamic_date_formats' and if the value matches then a new date field is added instead of string. | +| `dynamic_templates` | [Partial](./Partial.md)>[] | Specify dynamic templates for the mapping. | +| `dynamic` | [MappingDynamicMapping](./MappingDynamicMapping.md) | Controls whether new fields are added dynamically. | +| `expand_wildcards` | [ExpandWildcards](./ExpandWildcards.md) | Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. | +| `ignore_unavailable` | boolean | If `false`, the request returns an error if it targets a missing or closed index. | +| `index` | [Indices](./Indices.md) | A comma-separated list of index names the mapping should be added to (supports wildcards); use `_all` or omit to add the mapping on all indices. | +| `master_timeout` | [Duration](./Duration.md) | Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. | +| `numeric_detection` | boolean | Automatically map strings into numeric data types for all fields. | +| `properties` | Record<[PropertyName](./PropertyName.md), [MappingProperty](./MappingProperty.md)> | Mapping for a field. For new fields, this mapping can include: - Field name - Field data type - Mapping parameters | +| `querystring` | { [key: string]: any; } & { index?: never; allow_no_indices?: never; expand_wildcards?: never; ignore_unavailable?: never; master_timeout?: never; timeout?: never; write_index_only?: never; date_detection?: never; dynamic?: never; dynamic_date_formats?: never; dynamic_templates?: never; _field_names?: never; _meta?: never; numeric_detection?: never; properties?: never; _routing?: never; _source?: never; runtime?: never; } | All values in `querystring` will be added to the request querystring. | +| `runtime` | [MappingRuntimeFields](./MappingRuntimeFields.md) | Mapping of runtime fields for the index. | +| `timeout` | [Duration](./Duration.md) | Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. | +| `write_index_only` | boolean | If `true`, the mappings are applied only to the current write index for the target. | diff --git a/docs/reference/api/IndicesPutMappingResponse.md b/docs/reference/api/IndicesPutMappingResponse.md new file mode 100644 index 000000000..a33810780 --- /dev/null +++ b/docs/reference/api/IndicesPutMappingResponse.md @@ -0,0 +1,4 @@ +## `IndicesPutMappingResponse` +::: +type IndicesPutMappingResponse = [IndicesResponseBase](./IndicesResponseBase.md); +::: diff --git a/docs/reference/api/IndicesPutSettingsRequest.md b/docs/reference/api/IndicesPutSettingsRequest.md new file mode 100644 index 000000000..5f40e8946 --- /dev/null +++ b/docs/reference/api/IndicesPutSettingsRequest.md @@ -0,0 +1,16 @@ +## Interface `IndicesPutSettingsRequest` + +| Name | Type | Description | +| - | - | - | +| `allow_no_indices` | boolean | If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. | +| `body` | string | ({ [key: string]: any; } & { index?: never; allow_no_indices?: never; expand_wildcards?: never; flat_settings?: never; ignore_unavailable?: never; master_timeout?: never; preserve_existing?: never; reopen?: never; timeout?: never; settings?: never; }) | All values in `body` will be added to the request body. | +| `expand_wildcards` | [ExpandWildcards](./ExpandWildcards.md) | Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. | +| `flat_settings` | boolean | If `true`, returns settings in flat format. | +| `ignore_unavailable` | boolean | If `true`, returns settings in flat format. | +| `index` | [Indices](./Indices.md) | Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards ( `*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. | +| `master_timeout` | [Duration](./Duration.md) | Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. | +| `preserve_existing` | boolean | If `true`, existing index settings remain unchanged. | +| `querystring` | { [key: string]: any; } & { index?: never; allow_no_indices?: never; expand_wildcards?: never; flat_settings?: never; ignore_unavailable?: never; master_timeout?: never; preserve_existing?: never; reopen?: never; timeout?: never; settings?: never; } | All values in `querystring` will be added to the request querystring. | +| `reopen` | boolean | Whether to close and reopen the index to apply non-dynamic settings. If set to `true` the indices to which the settings are being applied will be closed temporarily and then reopened in order to apply the changes. | +| `settings` | [IndicesIndexSettings](./IndicesIndexSettings.md) |   | +| `timeout` | [Duration](./Duration.md) | Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. | diff --git a/docs/reference/api/IndicesPutSettingsResponse.md b/docs/reference/api/IndicesPutSettingsResponse.md new file mode 100644 index 000000000..dfb9ec68b --- /dev/null +++ b/docs/reference/api/IndicesPutSettingsResponse.md @@ -0,0 +1,4 @@ +## `IndicesPutSettingsResponse` +::: +type IndicesPutSettingsResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); +::: diff --git a/docs/reference/api/IndicesPutTemplateRequest.md b/docs/reference/api/IndicesPutTemplateRequest.md new file mode 100644 index 000000000..2f429b9fc --- /dev/null +++ b/docs/reference/api/IndicesPutTemplateRequest.md @@ -0,0 +1,16 @@ +## Interface `IndicesPutTemplateRequest` + +| Name | Type | Description | +| - | - | - | +| `aliases` | Record<[IndexName](./IndexName.md), [IndicesAlias](./IndicesAlias.md)> | Aliases for the index. | +| `body` | string | ({ [key: string]: any; } & { name?: never; create?: never; master_timeout?: never; cause?: never; aliases?: never; index_patterns?: never; mappings?: never; order?: never; settings?: never; version?: never; }) | All values in `body` will be added to the request body. | +| `cause` | string | User defined reason for creating/updating the index template | +| `create` | boolean | If true, this request cannot replace or update existing index templates. | +| `index_patterns` | string | string[] | Array of wildcard expressions used to match the names of indices during creation. | +| `mappings` | [MappingTypeMapping](./MappingTypeMapping.md) | Mapping for fields in the index. | +| `master_timeout` | [Duration](./Duration.md) | Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. | +| `name` | [Name](./Name.md) | The name of the template | +| `order` | [integer](./integer.md) | Order in which Elasticsearch applies this template if index matches multiple templates. Templates with lower 'order' values are merged first. Templates with higher 'order' values are merged later, overriding templates with lower values. | +| `querystring` | { [key: string]: any; } & { name?: never; create?: never; master_timeout?: never; cause?: never; aliases?: never; index_patterns?: never; mappings?: never; order?: never; settings?: never; version?: never; } | All values in `querystring` will be added to the request querystring. | +| `settings` | [IndicesIndexSettings](./IndicesIndexSettings.md) | Configuration options for the index. | +| `version` | [VersionNumber](./VersionNumber.md) | Version number used to manage index templates externally. This number is not automatically generated by Elasticsearch. To unset a version, replace the template without specifying one. | diff --git a/docs/reference/api/IndicesPutTemplateResponse.md b/docs/reference/api/IndicesPutTemplateResponse.md new file mode 100644 index 000000000..af81a9e2c --- /dev/null +++ b/docs/reference/api/IndicesPutTemplateResponse.md @@ -0,0 +1,4 @@ +## `IndicesPutTemplateResponse` +::: +type IndicesPutTemplateResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); +::: diff --git a/docs/reference/api/IndicesQueries.md b/docs/reference/api/IndicesQueries.md new file mode 100644 index 000000000..99c00d0ab --- /dev/null +++ b/docs/reference/api/IndicesQueries.md @@ -0,0 +1,5 @@ +## Interface `IndicesQueries` + +| Name | Type | Description | +| - | - | - | +| `cache` | [IndicesCacheQueries](./IndicesCacheQueries.md) |   | diff --git a/docs/reference/api/IndicesRecoveryFileDetails.md b/docs/reference/api/IndicesRecoveryFileDetails.md new file mode 100644 index 000000000..a55e7bcc1 --- /dev/null +++ b/docs/reference/api/IndicesRecoveryFileDetails.md @@ -0,0 +1,7 @@ +## Interface `IndicesRecoveryFileDetails` + +| Name | Type | Description | +| - | - | - | +| `length` | [long](./long.md) |   | +| `name` | string |   | +| `recovered` | [long](./long.md) |   | diff --git a/docs/reference/api/IndicesRecoveryRecoveryBytes.md b/docs/reference/api/IndicesRecoveryRecoveryBytes.md new file mode 100644 index 000000000..a4bf6ed51 --- /dev/null +++ b/docs/reference/api/IndicesRecoveryRecoveryBytes.md @@ -0,0 +1,13 @@ +## Interface `IndicesRecoveryRecoveryBytes` + +| Name | Type | Description | +| - | - | - | +| `percent` | [Percentage](./Percentage.md) |   | +| `recovered_from_snapshot_in_bytes` | [ByteSize](./ByteSize.md) |   | +| `recovered_from_snapshot` | [ByteSize](./ByteSize.md) |   | +| `recovered_in_bytes` | [ByteSize](./ByteSize.md) |   | +| `recovered` | [ByteSize](./ByteSize.md) |   | +| `reused_in_bytes` | [ByteSize](./ByteSize.md) |   | +| `reused` | [ByteSize](./ByteSize.md) |   | +| `total_in_bytes` | [ByteSize](./ByteSize.md) |   | +| `total` | [ByteSize](./ByteSize.md) |   | diff --git a/docs/reference/api/IndicesRecoveryRecoveryFiles.md b/docs/reference/api/IndicesRecoveryRecoveryFiles.md new file mode 100644 index 000000000..9fc117b3d --- /dev/null +++ b/docs/reference/api/IndicesRecoveryRecoveryFiles.md @@ -0,0 +1,9 @@ +## Interface `IndicesRecoveryRecoveryFiles` + +| Name | Type | Description | +| - | - | - | +| `details` | [IndicesRecoveryFileDetails](./IndicesRecoveryFileDetails.md)[] |   | +| `percent` | [Percentage](./Percentage.md) |   | +| `recovered` | [long](./long.md) |   | +| `reused` | [long](./long.md) |   | +| `total` | [long](./long.md) |   | diff --git a/docs/reference/api/IndicesRecoveryRecoveryIndexStatus.md b/docs/reference/api/IndicesRecoveryRecoveryIndexStatus.md new file mode 100644 index 000000000..677a22ceb --- /dev/null +++ b/docs/reference/api/IndicesRecoveryRecoveryIndexStatus.md @@ -0,0 +1,13 @@ +## Interface `IndicesRecoveryRecoveryIndexStatus` + +| Name | Type | Description | +| - | - | - | +| `bytes` | [IndicesRecoveryRecoveryBytes](./IndicesRecoveryRecoveryBytes.md) |   | +| `files` | [IndicesRecoveryRecoveryFiles](./IndicesRecoveryRecoveryFiles.md) |   | +| `size` | [IndicesRecoveryRecoveryBytes](./IndicesRecoveryRecoveryBytes.md) |   | +| `source_throttle_time_in_millis` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> |   | +| `source_throttle_time` | [Duration](./Duration.md) |   | +| `target_throttle_time_in_millis` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> |   | +| `target_throttle_time` | [Duration](./Duration.md) |   | +| `total_time_in_millis` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> |   | +| `total_time` | [Duration](./Duration.md) |   | diff --git a/docs/reference/api/IndicesRecoveryRecoveryOrigin.md b/docs/reference/api/IndicesRecoveryRecoveryOrigin.md new file mode 100644 index 000000000..f8679b822 --- /dev/null +++ b/docs/reference/api/IndicesRecoveryRecoveryOrigin.md @@ -0,0 +1,16 @@ +## Interface `IndicesRecoveryRecoveryOrigin` + +| Name | Type | Description | +| - | - | - | +| `bootstrap_new_history_uuid` | boolean |   | +| `host` | [Host](./Host.md) |   | +| `hostname` | string |   | +| `id` | [Id](./Id.md) |   | +| `index` | [IndexName](./IndexName.md) |   | +| `ip` | [Ip](./Ip.md) |   | +| `name` | [Name](./Name.md) |   | +| `repository` | [Name](./Name.md) |   | +| `restoreUUID` | [Uuid](./Uuid.md) |   | +| `snapshot` | [Name](./Name.md) |   | +| `transport_address` | [TransportAddress](./TransportAddress.md) |   | +| `version` | [VersionString](./VersionString.md) |   | diff --git a/docs/reference/api/IndicesRecoveryRecoveryStartStatus.md b/docs/reference/api/IndicesRecoveryRecoveryStartStatus.md new file mode 100644 index 000000000..a3347f19a --- /dev/null +++ b/docs/reference/api/IndicesRecoveryRecoveryStartStatus.md @@ -0,0 +1,8 @@ +## Interface `IndicesRecoveryRecoveryStartStatus` + +| Name | Type | Description | +| - | - | - | +| `check_index_time_in_millis` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> |   | +| `check_index_time` | [Duration](./Duration.md) |   | +| `total_time_in_millis` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> |   | +| `total_time` | [Duration](./Duration.md) |   | diff --git a/docs/reference/api/IndicesRecoveryRecoveryStatus.md b/docs/reference/api/IndicesRecoveryRecoveryStatus.md new file mode 100644 index 000000000..c10879456 --- /dev/null +++ b/docs/reference/api/IndicesRecoveryRecoveryStatus.md @@ -0,0 +1,5 @@ +## Interface `IndicesRecoveryRecoveryStatus` + +| Name | Type | Description | +| - | - | - | +| `shards` | [IndicesRecoveryShardRecovery](./IndicesRecoveryShardRecovery.md)[] |   | diff --git a/docs/reference/api/IndicesRecoveryRequest.md b/docs/reference/api/IndicesRecoveryRequest.md new file mode 100644 index 000000000..381cbd092 --- /dev/null +++ b/docs/reference/api/IndicesRecoveryRequest.md @@ -0,0 +1,9 @@ +## Interface `IndicesRecoveryRequest` + +| Name | Type | Description | +| - | - | - | +| `active_only` | boolean | If `true`, the response only includes ongoing shard recoveries. | +| `body` | string | ({ [key: string]: any; } & { index?: never; active_only?: never; detailed?: never; }) | All values in `body` will be added to the request body. | +| `detailed` | boolean | If `true`, the response includes detailed information about shard recoveries. | +| `index` | [Indices](./Indices.md) | Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards ( `*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. | +| `querystring` | { [key: string]: any; } & { index?: never; active_only?: never; detailed?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/IndicesRecoveryResponse.md b/docs/reference/api/IndicesRecoveryResponse.md new file mode 100644 index 000000000..5466ae902 --- /dev/null +++ b/docs/reference/api/IndicesRecoveryResponse.md @@ -0,0 +1,4 @@ +## `IndicesRecoveryResponse` +::: +type IndicesRecoveryResponse = Record<[IndexName](./IndexName.md), [IndicesRecoveryRecoveryStatus](./IndicesRecoveryRecoveryStatus.md)>; +::: diff --git a/docs/reference/api/IndicesRecoveryShardRecovery.md b/docs/reference/api/IndicesRecoveryShardRecovery.md new file mode 100644 index 000000000..3dffeb7ff --- /dev/null +++ b/docs/reference/api/IndicesRecoveryShardRecovery.md @@ -0,0 +1,20 @@ +## Interface `IndicesRecoveryShardRecovery` + +| Name | Type | Description | +| - | - | - | +| `id` | [long](./long.md) |   | +| `index` | [IndicesRecoveryRecoveryIndexStatus](./IndicesRecoveryRecoveryIndexStatus.md) |   | +| `primary` | boolean |   | +| `source` | [IndicesRecoveryRecoveryOrigin](./IndicesRecoveryRecoveryOrigin.md) |   | +| `stage` | string |   | +| `start_time_in_millis` | [EpochTime](./EpochTime.md)<[UnitMillis](./UnitMillis.md)> |   | +| `start_time` | [DateTime](./DateTime.md) |   | +| `start` | [IndicesRecoveryRecoveryStartStatus](./IndicesRecoveryRecoveryStartStatus.md) |   | +| `stop_time_in_millis` | [EpochTime](./EpochTime.md)<[UnitMillis](./UnitMillis.md)> |   | +| `stop_time` | [DateTime](./DateTime.md) |   | +| `target` | [IndicesRecoveryRecoveryOrigin](./IndicesRecoveryRecoveryOrigin.md) |   | +| `total_time_in_millis` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> |   | +| `total_time` | [Duration](./Duration.md) |   | +| `translog` | [IndicesRecoveryTranslogStatus](./IndicesRecoveryTranslogStatus.md) |   | +| `type` | string |   | +| `verify_index` | [IndicesRecoveryVerifyIndex](./IndicesRecoveryVerifyIndex.md) |   | diff --git a/docs/reference/api/IndicesRecoveryTranslogStatus.md b/docs/reference/api/IndicesRecoveryTranslogStatus.md new file mode 100644 index 000000000..723923c98 --- /dev/null +++ b/docs/reference/api/IndicesRecoveryTranslogStatus.md @@ -0,0 +1,10 @@ +## Interface `IndicesRecoveryTranslogStatus` + +| Name | Type | Description | +| - | - | - | +| `percent` | [Percentage](./Percentage.md) |   | +| `recovered` | [long](./long.md) |   | +| `total_on_start` | [long](./long.md) |   | +| `total_time_in_millis` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> |   | +| `total_time` | [Duration](./Duration.md) |   | +| `total` | [long](./long.md) |   | diff --git a/docs/reference/api/IndicesRecoveryVerifyIndex.md b/docs/reference/api/IndicesRecoveryVerifyIndex.md new file mode 100644 index 000000000..3ad6effc0 --- /dev/null +++ b/docs/reference/api/IndicesRecoveryVerifyIndex.md @@ -0,0 +1,8 @@ +## Interface `IndicesRecoveryVerifyIndex` + +| Name | Type | Description | +| - | - | - | +| `check_index_time_in_millis` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> |   | +| `check_index_time` | [Duration](./Duration.md) |   | +| `total_time_in_millis` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> |   | +| `total_time` | [Duration](./Duration.md) |   | diff --git a/docs/reference/api/IndicesRefreshRequest.md b/docs/reference/api/IndicesRefreshRequest.md new file mode 100644 index 000000000..eb19e5efe --- /dev/null +++ b/docs/reference/api/IndicesRefreshRequest.md @@ -0,0 +1,10 @@ +## Interface `IndicesRefreshRequest` + +| Name | Type | Description | +| - | - | - | +| `allow_no_indices` | boolean | If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. | +| `body` | string | ({ [key: string]: any; } & { index?: never; allow_no_indices?: never; expand_wildcards?: never; ignore_unavailable?: never; }) | All values in `body` will be added to the request body. | +| `expand_wildcards` | [ExpandWildcards](./ExpandWildcards.md) | Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. | +| `ignore_unavailable` | boolean | If `false`, the request returns an error if it targets a missing or closed index. | +| `index` | [Indices](./Indices.md) | Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards ( `*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. | +| `querystring` | { [key: string]: any; } & { index?: never; allow_no_indices?: never; expand_wildcards?: never; ignore_unavailable?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/IndicesRefreshResponse.md b/docs/reference/api/IndicesRefreshResponse.md new file mode 100644 index 000000000..c0d086096 --- /dev/null +++ b/docs/reference/api/IndicesRefreshResponse.md @@ -0,0 +1,4 @@ +## `IndicesRefreshResponse` +::: +type IndicesRefreshResponse = [ShardsOperationResponseBase](./ShardsOperationResponseBase.md); +::: diff --git a/docs/reference/api/IndicesReloadSearchAnalyzersReloadDetails.md b/docs/reference/api/IndicesReloadSearchAnalyzersReloadDetails.md new file mode 100644 index 000000000..2a033652e --- /dev/null +++ b/docs/reference/api/IndicesReloadSearchAnalyzersReloadDetails.md @@ -0,0 +1,7 @@ +## Interface `IndicesReloadSearchAnalyzersReloadDetails` + +| Name | Type | Description | +| - | - | - | +| `index` | string |   | +| `reloaded_analyzers` | string[] |   | +| `reloaded_node_ids` | string[] |   | diff --git a/docs/reference/api/IndicesReloadSearchAnalyzersReloadResult.md b/docs/reference/api/IndicesReloadSearchAnalyzersReloadResult.md new file mode 100644 index 000000000..317cba9d2 --- /dev/null +++ b/docs/reference/api/IndicesReloadSearchAnalyzersReloadResult.md @@ -0,0 +1,6 @@ +## Interface `IndicesReloadSearchAnalyzersReloadResult` + +| Name | Type | Description | +| - | - | - | +| `_shards` | [ShardStatistics](./ShardStatistics.md) |   | +| `reload_details` | [IndicesReloadSearchAnalyzersReloadDetails](./IndicesReloadSearchAnalyzersReloadDetails.md)[] |   | diff --git a/docs/reference/api/IndicesReloadSearchAnalyzersRequest.md b/docs/reference/api/IndicesReloadSearchAnalyzersRequest.md new file mode 100644 index 000000000..f43927fd4 --- /dev/null +++ b/docs/reference/api/IndicesReloadSearchAnalyzersRequest.md @@ -0,0 +1,11 @@ +## Interface `IndicesReloadSearchAnalyzersRequest` + +| Name | Type | Description | +| - | - | - | +| `allow_no_indices` | boolean | Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) | +| `body` | string | ({ [key: string]: any; } & { index?: never; allow_no_indices?: never; expand_wildcards?: never; ignore_unavailable?: never; resource?: never; }) | All values in `body` will be added to the request body. | +| `expand_wildcards` | [ExpandWildcards](./ExpandWildcards.md) | Whether to expand wildcard expression to concrete indices that are open, closed or both. | +| `ignore_unavailable` | boolean | Whether specified concrete indices should be ignored when unavailable (missing or closed) | +| `index` | [Indices](./Indices.md) | A comma-separated list of index names to reload analyzers for | +| `querystring` | { [key: string]: any; } & { index?: never; allow_no_indices?: never; expand_wildcards?: never; ignore_unavailable?: never; resource?: never; } | All values in `querystring` will be added to the request querystring. | +| `resource` | string | Changed resource to reload analyzers from if applicable | diff --git a/docs/reference/api/IndicesReloadSearchAnalyzersResponse.md b/docs/reference/api/IndicesReloadSearchAnalyzersResponse.md new file mode 100644 index 000000000..d7e915c12 --- /dev/null +++ b/docs/reference/api/IndicesReloadSearchAnalyzersResponse.md @@ -0,0 +1,4 @@ +## `IndicesReloadSearchAnalyzersResponse` +::: +type IndicesReloadSearchAnalyzersResponse = [IndicesReloadSearchAnalyzersReloadResult](./IndicesReloadSearchAnalyzersReloadResult.md); +::: diff --git a/docs/reference/api/IndicesResolveClusterRequest.md b/docs/reference/api/IndicesResolveClusterRequest.md new file mode 100644 index 000000000..367e15a54 --- /dev/null +++ b/docs/reference/api/IndicesResolveClusterRequest.md @@ -0,0 +1,12 @@ +## Interface `IndicesResolveClusterRequest` + +| Name | Type | Description | +| - | - | - | +| `allow_no_indices` | boolean | If false, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. NOTE: This option is only supported when specifying an index expression. You will get an error if you specify index options to the `_resolve/cluster` API endpoint that takes no index expression. | +| `body` | string | ({ [key: string]: any; } & { name?: never; allow_no_indices?: never; expand_wildcards?: never; ignore_throttled?: never; ignore_unavailable?: never; timeout?: never; }) | All values in `body` will be added to the request body. | +| `expand_wildcards` | [ExpandWildcards](./ExpandWildcards.md) | Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. NOTE: This option is only supported when specifying an index expression. You will get an error if you specify index options to the `_resolve/cluster` API endpoint that takes no index expression. | +| `ignore_throttled` | boolean | If true, concrete, expanded, or aliased indices are ignored when frozen. NOTE: This option is only supported when specifying an index expression. You will get an error if you specify index options to the `_resolve/cluster` API endpoint that takes no index expression. | +| `ignore_unavailable` | boolean | If false, the request returns an error if it targets a missing or closed index. NOTE: This option is only supported when specifying an index expression. You will get an error if you specify index options to the `_resolve/cluster` API endpoint that takes no index expression. | +| `name` | [Names](./Names.md) | A comma-separated list of names or index patterns for the indices, aliases, and data streams to resolve. Resources on remote clusters can be specified using the ``: `` syntax. Index and cluster exclusions (e.g., `-cluster1:*`) are also supported. If no index expression is specified, information about all remote clusters configured on the local cluster is returned without doing any index matching | +| `querystring` | { [key: string]: any; } & { name?: never; allow_no_indices?: never; expand_wildcards?: never; ignore_throttled?: never; ignore_unavailable?: never; timeout?: never; } | All values in `querystring` will be added to the request querystring. | +| `timeout` | [Duration](./Duration.md) | The maximum time to wait for remote clusters to respond. If a remote cluster does not respond within this timeout period, the API response will show the cluster as not connected and include an error message that the request timed out. The default timeout is unset and the query can take as long as the networking layer is configured to wait for remote clusters that are not responding (typically 30 seconds). | diff --git a/docs/reference/api/IndicesResolveClusterResolveClusterInfo.md b/docs/reference/api/IndicesResolveClusterResolveClusterInfo.md new file mode 100644 index 000000000..2a9dc7e3c --- /dev/null +++ b/docs/reference/api/IndicesResolveClusterResolveClusterInfo.md @@ -0,0 +1,9 @@ +## Interface `IndicesResolveClusterResolveClusterInfo` + +| Name | Type | Description | +| - | - | - | +| `connected` | boolean | Whether the remote cluster is connected to the local (querying) cluster. | +| `error` | string | Provides error messages that are likely to occur if you do a search with this index expression on the specified cluster (for example, lack of security privileges to query an index). | +| `matching_indices` | boolean | Whether the index expression provided in the request matches any indices, aliases or data streams on the cluster. | +| `skip_unavailable` | boolean | The `skip_unavailable` setting for a remote cluster. | +| `version` | [ElasticsearchVersionMinInfo](./ElasticsearchVersionMinInfo.md) | Provides version information about the cluster. | diff --git a/docs/reference/api/IndicesResolveClusterResponse.md b/docs/reference/api/IndicesResolveClusterResponse.md new file mode 100644 index 000000000..5cc472faf --- /dev/null +++ b/docs/reference/api/IndicesResolveClusterResponse.md @@ -0,0 +1,4 @@ +## `IndicesResolveClusterResponse` +::: +type IndicesResolveClusterResponse = Record<[ClusterAlias](./ClusterAlias.md), [IndicesResolveClusterResolveClusterInfo](./IndicesResolveClusterResolveClusterInfo.md)>; +::: diff --git a/docs/reference/api/IndicesResolveIndexRequest.md b/docs/reference/api/IndicesResolveIndexRequest.md new file mode 100644 index 000000000..1a0b00c29 --- /dev/null +++ b/docs/reference/api/IndicesResolveIndexRequest.md @@ -0,0 +1,10 @@ +## Interface `IndicesResolveIndexRequest` + +| Name | Type | Description | +| - | - | - | +| `allow_no_indices` | boolean | If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. | +| `body` | string | ({ [key: string]: any; } & { name?: never; expand_wildcards?: never; ignore_unavailable?: never; allow_no_indices?: never; }) | All values in `body` will be added to the request body. | +| `expand_wildcards` | [ExpandWildcards](./ExpandWildcards.md) | Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. | +| `ignore_unavailable` | boolean | If `false`, the request returns an error if it targets a missing or closed index. | +| `name` | [Names](./Names.md) | Comma-separated name(s) or index pattern(s) of the indices, aliases, and data streams to resolve. Resources on remote clusters can be specified using the ``: `` syntax. | +| `querystring` | { [key: string]: any; } & { name?: never; expand_wildcards?: never; ignore_unavailable?: never; allow_no_indices?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/IndicesResolveIndexResolveIndexAliasItem.md b/docs/reference/api/IndicesResolveIndexResolveIndexAliasItem.md new file mode 100644 index 000000000..49e9bbf01 --- /dev/null +++ b/docs/reference/api/IndicesResolveIndexResolveIndexAliasItem.md @@ -0,0 +1,6 @@ +## Interface `IndicesResolveIndexResolveIndexAliasItem` + +| Name | Type | Description | +| - | - | - | +| `indices` | [Indices](./Indices.md) |   | +| `name` | [Name](./Name.md) |   | diff --git a/docs/reference/api/IndicesResolveIndexResolveIndexDataStreamsItem.md b/docs/reference/api/IndicesResolveIndexResolveIndexDataStreamsItem.md new file mode 100644 index 000000000..cf5663ccb --- /dev/null +++ b/docs/reference/api/IndicesResolveIndexResolveIndexDataStreamsItem.md @@ -0,0 +1,7 @@ +## Interface `IndicesResolveIndexResolveIndexDataStreamsItem` + +| Name | Type | Description | +| - | - | - | +| `backing_indices` | [Indices](./Indices.md) |   | +| `name` | [DataStreamName](./DataStreamName.md) |   | +| `timestamp_field` | [Field](./Field.md) |   | diff --git a/docs/reference/api/IndicesResolveIndexResolveIndexItem.md b/docs/reference/api/IndicesResolveIndexResolveIndexItem.md new file mode 100644 index 000000000..e5d2347d3 --- /dev/null +++ b/docs/reference/api/IndicesResolveIndexResolveIndexItem.md @@ -0,0 +1,8 @@ +## Interface `IndicesResolveIndexResolveIndexItem` + +| Name | Type | Description | +| - | - | - | +| `aliases` | string[] |   | +| `attributes` | string[] |   | +| `data_stream` | [DataStreamName](./DataStreamName.md) |   | +| `name` | [Name](./Name.md) |   | diff --git a/docs/reference/api/IndicesResolveIndexResponse.md b/docs/reference/api/IndicesResolveIndexResponse.md new file mode 100644 index 000000000..8b50bee74 --- /dev/null +++ b/docs/reference/api/IndicesResolveIndexResponse.md @@ -0,0 +1,7 @@ +## Interface `IndicesResolveIndexResponse` + +| Name | Type | Description | +| - | - | - | +| `aliases` | [IndicesResolveIndexResolveIndexAliasItem](./IndicesResolveIndexResolveIndexAliasItem.md)[] |   | +| `data_streams` | [IndicesResolveIndexResolveIndexDataStreamsItem](./IndicesResolveIndexResolveIndexDataStreamsItem.md)[] |   | +| `indices` | [IndicesResolveIndexResolveIndexItem](./IndicesResolveIndexResolveIndexItem.md)[] |   | diff --git a/docs/reference/api/IndicesResponseBase.md b/docs/reference/api/IndicesResponseBase.md new file mode 100644 index 000000000..8bfe5fb89 --- /dev/null +++ b/docs/reference/api/IndicesResponseBase.md @@ -0,0 +1,5 @@ +## Interface `IndicesResponseBase` + +| Name | Type | Description | +| - | - | - | +| `_shards` | [ShardStatistics](./ShardStatistics.md) |   | diff --git a/docs/reference/api/IndicesRetentionLease.md b/docs/reference/api/IndicesRetentionLease.md new file mode 100644 index 000000000..00f96faef --- /dev/null +++ b/docs/reference/api/IndicesRetentionLease.md @@ -0,0 +1,5 @@ +## Interface `IndicesRetentionLease` + +| Name | Type | Description | +| - | - | - | +| `period` | [Duration](./Duration.md) |   | diff --git a/docs/reference/api/IndicesRolloverRequest.md b/docs/reference/api/IndicesRolloverRequest.md new file mode 100644 index 000000000..cd1d20509 --- /dev/null +++ b/docs/reference/api/IndicesRolloverRequest.md @@ -0,0 +1,17 @@ +## Interface `IndicesRolloverRequest` + +| Name | Type | Description | +| - | - | - | +| `alias` | [IndexAlias](./IndexAlias.md) | Name of the data stream or index alias to roll over. | +| `aliases` | Record<[IndexName](./IndexName.md), [IndicesAlias](./IndicesAlias.md)> | Aliases for the target index. Data streams do not support this parameter. | +| `body` | string | ({ [key: string]: any; } & { alias?: never; new_index?: never; dry_run?: never; master_timeout?: never; timeout?: never; wait_for_active_shards?: never; lazy?: never; aliases?: never; conditions?: never; mappings?: never; settings?: never; }) | All values in `body` will be added to the request body. | +| `conditions` | [IndicesRolloverRolloverConditions](./IndicesRolloverRolloverConditions.md) | Conditions for the rollover. If specified, Elasticsearch only performs the rollover if the current index satisfies these conditions. If this parameter is not specified, Elasticsearch performs the rollover unconditionally. If conditions are specified, at least one of them must be a `max_*` condition. The index will rollover if any `max_*` condition is satisfied and all `min_*` conditions are satisfied. | +| `dry_run` | boolean | If `true`, checks whether the current index satisfies the specified conditions but does not perform a rollover. | +| `lazy` | boolean | If set to true, the rollover action will only mark a data stream to signal that it needs to be rolled over at the next write. Only allowed on data streams. | +| `mappings` | [MappingTypeMapping](./MappingTypeMapping.md) | Mapping for fields in the index. If specified, this mapping can include field names, field data types, and mapping paramaters. | +| `master_timeout` | [Duration](./Duration.md) | Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. | +| `new_index` | [IndexName](./IndexName.md) | Name of the index to create. Supports date math. Data streams do not support this parameter. | +| `querystring` | { [key: string]: any; } & { alias?: never; new_index?: never; dry_run?: never; master_timeout?: never; timeout?: never; wait_for_active_shards?: never; lazy?: never; aliases?: never; conditions?: never; mappings?: never; settings?: never; } | All values in `querystring` will be added to the request querystring. | +| `settings` | Record | Configuration options for the index. Data streams do not support this parameter. | +| `timeout` | [Duration](./Duration.md) | Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. | +| `wait_for_active_shards` | [WaitForActiveShards](./WaitForActiveShards.md) | The number of shard copies that must be active before proceeding with the operation. Set to all or any positive integer up to the total number of shards in the index ( `number_of_replicas+1`). | diff --git a/docs/reference/api/IndicesRolloverResponse.md b/docs/reference/api/IndicesRolloverResponse.md new file mode 100644 index 000000000..0bb46b3b1 --- /dev/null +++ b/docs/reference/api/IndicesRolloverResponse.md @@ -0,0 +1,11 @@ +## Interface `IndicesRolloverResponse` + +| Name | Type | Description | +| - | - | - | +| `acknowledged` | boolean |   | +| `conditions` | Record |   | +| `dry_run` | boolean |   | +| `new_index` | string |   | +| `old_index` | string |   | +| `rolled_over` | boolean |   | +| `shards_acknowledged` | boolean |   | diff --git a/docs/reference/api/IndicesRolloverRolloverConditions.md b/docs/reference/api/IndicesRolloverRolloverConditions.md new file mode 100644 index 000000000..9aa8ccd23 --- /dev/null +++ b/docs/reference/api/IndicesRolloverRolloverConditions.md @@ -0,0 +1,19 @@ +## Interface `IndicesRolloverRolloverConditions` + +| Name | Type | Description | +| - | - | - | +| `max_age_millis` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> |   | +| `max_age` | [Duration](./Duration.md) |   | +| `max_docs` | [long](./long.md) |   | +| `max_primary_shard_docs` | [long](./long.md) |   | +| `max_primary_shard_size_bytes` | [long](./long.md) |   | +| `max_primary_shard_size` | [ByteSize](./ByteSize.md) |   | +| `max_size_bytes` | [long](./long.md) |   | +| `max_size` | [ByteSize](./ByteSize.md) |   | +| `min_age` | [Duration](./Duration.md) |   | +| `min_docs` | [long](./long.md) |   | +| `min_primary_shard_docs` | [long](./long.md) |   | +| `min_primary_shard_size_bytes` | [long](./long.md) |   | +| `min_primary_shard_size` | [ByteSize](./ByteSize.md) |   | +| `min_size_bytes` | [long](./long.md) |   | +| `min_size` | [ByteSize](./ByteSize.md) |   | diff --git a/docs/reference/api/IndicesSearchIdle.md b/docs/reference/api/IndicesSearchIdle.md new file mode 100644 index 000000000..b914fbb8f --- /dev/null +++ b/docs/reference/api/IndicesSearchIdle.md @@ -0,0 +1,5 @@ +## Interface `IndicesSearchIdle` + +| Name | Type | Description | +| - | - | - | +| `after` | [Duration](./Duration.md) |   | diff --git a/docs/reference/api/IndicesSegmentSortMissing.md b/docs/reference/api/IndicesSegmentSortMissing.md new file mode 100644 index 000000000..4b51fbf0d --- /dev/null +++ b/docs/reference/api/IndicesSegmentSortMissing.md @@ -0,0 +1,4 @@ +## `IndicesSegmentSortMissing` +::: +type IndicesSegmentSortMissing = '_last' | '_first'; +::: diff --git a/docs/reference/api/IndicesSegmentSortMode.md b/docs/reference/api/IndicesSegmentSortMode.md new file mode 100644 index 000000000..8127daddc --- /dev/null +++ b/docs/reference/api/IndicesSegmentSortMode.md @@ -0,0 +1,4 @@ +## `IndicesSegmentSortMode` +::: +type IndicesSegmentSortMode = 'min' | 'MIN' | 'max' | 'MAX'; +::: diff --git a/docs/reference/api/IndicesSegmentSortOrder.md b/docs/reference/api/IndicesSegmentSortOrder.md new file mode 100644 index 000000000..c14671772 --- /dev/null +++ b/docs/reference/api/IndicesSegmentSortOrder.md @@ -0,0 +1,4 @@ +## `IndicesSegmentSortOrder` +::: +type IndicesSegmentSortOrder = 'asc' | 'ASC' | 'desc' | 'DESC'; +::: diff --git a/docs/reference/api/IndicesSegmentsIndexSegment.md b/docs/reference/api/IndicesSegmentsIndexSegment.md new file mode 100644 index 000000000..e2f87ca23 --- /dev/null +++ b/docs/reference/api/IndicesSegmentsIndexSegment.md @@ -0,0 +1,5 @@ +## Interface `IndicesSegmentsIndexSegment` + +| Name | Type | Description | +| - | - | - | +| `shards` | Record |   | diff --git a/docs/reference/api/IndicesSegmentsRequest.md b/docs/reference/api/IndicesSegmentsRequest.md new file mode 100644 index 000000000..98cdbf902 --- /dev/null +++ b/docs/reference/api/IndicesSegmentsRequest.md @@ -0,0 +1,10 @@ +## Interface `IndicesSegmentsRequest` + +| Name | Type | Description | +| - | - | - | +| `allow_no_indices` | boolean | If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. | +| `body` | string | ({ [key: string]: any; } & { index?: never; allow_no_indices?: never; expand_wildcards?: never; ignore_unavailable?: never; }) | All values in `body` will be added to the request body. | +| `expand_wildcards` | [ExpandWildcards](./ExpandWildcards.md) | Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. | +| `ignore_unavailable` | boolean | If `false`, the request returns an error if it targets a missing or closed index. | +| `index` | [Indices](./Indices.md) | Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards ( `*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. | +| `querystring` | { [key: string]: any; } & { index?: never; allow_no_indices?: never; expand_wildcards?: never; ignore_unavailable?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/IndicesSegmentsResponse.md b/docs/reference/api/IndicesSegmentsResponse.md new file mode 100644 index 000000000..6fbb7ee72 --- /dev/null +++ b/docs/reference/api/IndicesSegmentsResponse.md @@ -0,0 +1,6 @@ +## Interface `IndicesSegmentsResponse` + +| Name | Type | Description | +| - | - | - | +| `_shards` | [ShardStatistics](./ShardStatistics.md) |   | +| `indices` | Record |   | diff --git a/docs/reference/api/IndicesSegmentsSegment.md b/docs/reference/api/IndicesSegmentsSegment.md new file mode 100644 index 000000000..5e77bd129 --- /dev/null +++ b/docs/reference/api/IndicesSegmentsSegment.md @@ -0,0 +1,13 @@ +## Interface `IndicesSegmentsSegment` + +| Name | Type | Description | +| - | - | - | +| `attributes` | Record |   | +| `committed` | boolean |   | +| `compound` | boolean |   | +| `deleted_docs` | [long](./long.md) |   | +| `generation` | [integer](./integer.md) |   | +| `num_docs` | [long](./long.md) |   | +| `search` | boolean |   | +| `size_in_bytes` | [double](./double.md) |   | +| `version` | [VersionString](./VersionString.md) |   | diff --git a/docs/reference/api/IndicesSegmentsShardSegmentRouting.md b/docs/reference/api/IndicesSegmentsShardSegmentRouting.md new file mode 100644 index 000000000..3022d6508 --- /dev/null +++ b/docs/reference/api/IndicesSegmentsShardSegmentRouting.md @@ -0,0 +1,7 @@ +## Interface `IndicesSegmentsShardSegmentRouting` + +| Name | Type | Description | +| - | - | - | +| `node` | string |   | +| `primary` | boolean |   | +| `state` | string |   | diff --git a/docs/reference/api/IndicesSegmentsShardsSegment.md b/docs/reference/api/IndicesSegmentsShardsSegment.md new file mode 100644 index 000000000..9d091f60a --- /dev/null +++ b/docs/reference/api/IndicesSegmentsShardsSegment.md @@ -0,0 +1,8 @@ +## Interface `IndicesSegmentsShardsSegment` + +| Name | Type | Description | +| - | - | - | +| `num_committed_segments` | [integer](./integer.md) |   | +| `num_search_segments` | [integer](./integer.md) |   | +| `routing` | [IndicesSegmentsShardSegmentRouting](./IndicesSegmentsShardSegmentRouting.md) |   | +| `segments` | Record |   | diff --git a/docs/reference/api/IndicesSettingsAnalyze.md b/docs/reference/api/IndicesSettingsAnalyze.md new file mode 100644 index 000000000..2ee4a53ef --- /dev/null +++ b/docs/reference/api/IndicesSettingsAnalyze.md @@ -0,0 +1,5 @@ +## Interface `IndicesSettingsAnalyze` + +| Name | Type | Description | +| - | - | - | +| `max_token_count` | [SpecUtilsStringified](./SpecUtilsStringified.md)<[integer](./integer.md)> |   | diff --git a/docs/reference/api/IndicesSettingsHighlight.md b/docs/reference/api/IndicesSettingsHighlight.md new file mode 100644 index 000000000..df4aa6d8a --- /dev/null +++ b/docs/reference/api/IndicesSettingsHighlight.md @@ -0,0 +1,5 @@ +## Interface `IndicesSettingsHighlight` + +| Name | Type | Description | +| - | - | - | +| `max_analyzed_offset` | [integer](./integer.md) |   | diff --git a/docs/reference/api/IndicesSettingsQueryString.md b/docs/reference/api/IndicesSettingsQueryString.md new file mode 100644 index 000000000..32adc28f4 --- /dev/null +++ b/docs/reference/api/IndicesSettingsQueryString.md @@ -0,0 +1,5 @@ +## Interface `IndicesSettingsQueryString` + +| Name | Type | Description | +| - | - | - | +| `lenient` | [SpecUtilsStringified](./SpecUtilsStringified.md) |   | diff --git a/docs/reference/api/IndicesSettingsSearch.md b/docs/reference/api/IndicesSettingsSearch.md new file mode 100644 index 000000000..fa70ad20b --- /dev/null +++ b/docs/reference/api/IndicesSettingsSearch.md @@ -0,0 +1,6 @@ +## Interface `IndicesSettingsSearch` + +| Name | Type | Description | +| - | - | - | +| `idle` | [IndicesSearchIdle](./IndicesSearchIdle.md) |   | +| `slowlog` | [IndicesSlowlogSettings](./IndicesSlowlogSettings.md) |   | diff --git a/docs/reference/api/IndicesSettingsSimilarity.md b/docs/reference/api/IndicesSettingsSimilarity.md new file mode 100644 index 000000000..ff4ab730f --- /dev/null +++ b/docs/reference/api/IndicesSettingsSimilarity.md @@ -0,0 +1,4 @@ +## `IndicesSettingsSimilarity` +::: +type IndicesSettingsSimilarity = [IndicesSettingsSimilarityBm25](./IndicesSettingsSimilarityBm25.md) | [IndicesSettingsSimilarityBoolean](./IndicesSettingsSimilarityBoolean.md) | [IndicesSettingsSimilarityDfi](./IndicesSettingsSimilarityDfi.md) | [IndicesSettingsSimilarityDfr](./IndicesSettingsSimilarityDfr.md) | [IndicesSettingsSimilarityIb](./IndicesSettingsSimilarityIb.md) | [IndicesSettingsSimilarityLmd](./IndicesSettingsSimilarityLmd.md) | [IndicesSettingsSimilarityLmj](./IndicesSettingsSimilarityLmj.md) | [IndicesSettingsSimilarityScripted](./IndicesSettingsSimilarityScripted.md); +::: diff --git a/docs/reference/api/IndicesSettingsSimilarityBm25.md b/docs/reference/api/IndicesSettingsSimilarityBm25.md new file mode 100644 index 000000000..0f4fb884d --- /dev/null +++ b/docs/reference/api/IndicesSettingsSimilarityBm25.md @@ -0,0 +1,8 @@ +## Interface `IndicesSettingsSimilarityBm25` + +| Name | Type | Description | +| - | - | - | +| `b` | [double](./double.md) |   | +| `discount_overlaps` | boolean |   | +| `k1` | [double](./double.md) |   | +| `type` | 'BM25' |   | diff --git a/docs/reference/api/IndicesSettingsSimilarityBoolean.md b/docs/reference/api/IndicesSettingsSimilarityBoolean.md new file mode 100644 index 000000000..1ab91ea93 --- /dev/null +++ b/docs/reference/api/IndicesSettingsSimilarityBoolean.md @@ -0,0 +1,5 @@ +## Interface `IndicesSettingsSimilarityBoolean` + +| Name | Type | Description | +| - | - | - | +| `type` | 'boolean' |   | diff --git a/docs/reference/api/IndicesSettingsSimilarityDfi.md b/docs/reference/api/IndicesSettingsSimilarityDfi.md new file mode 100644 index 000000000..7f455800c --- /dev/null +++ b/docs/reference/api/IndicesSettingsSimilarityDfi.md @@ -0,0 +1,6 @@ +## Interface `IndicesSettingsSimilarityDfi` + +| Name | Type | Description | +| - | - | - | +| `independence_measure` | [DFIIndependenceMeasure](./DFIIndependenceMeasure.md) |   | +| `type` | 'DFI' |   | diff --git a/docs/reference/api/IndicesSettingsSimilarityDfr.md b/docs/reference/api/IndicesSettingsSimilarityDfr.md new file mode 100644 index 000000000..4aab7c729 --- /dev/null +++ b/docs/reference/api/IndicesSettingsSimilarityDfr.md @@ -0,0 +1,8 @@ +## Interface `IndicesSettingsSimilarityDfr` + +| Name | Type | Description | +| - | - | - | +| `after_effect` | [DFRAfterEffect](./DFRAfterEffect.md) |   | +| `basic_model` | [DFRBasicModel](./DFRBasicModel.md) |   | +| `normalization` | [Normalization](./Normalization.md) |   | +| `type` | 'DFR' |   | diff --git a/docs/reference/api/IndicesSettingsSimilarityIb.md b/docs/reference/api/IndicesSettingsSimilarityIb.md new file mode 100644 index 000000000..23f924c50 --- /dev/null +++ b/docs/reference/api/IndicesSettingsSimilarityIb.md @@ -0,0 +1,8 @@ +## Interface `IndicesSettingsSimilarityIb` + +| Name | Type | Description | +| - | - | - | +| `distribution` | [IBDistribution](./IBDistribution.md) |   | +| `lambda` | [IBLambda](./IBLambda.md) |   | +| `normalization` | [Normalization](./Normalization.md) |   | +| `type` | 'IB' |   | diff --git a/docs/reference/api/IndicesSettingsSimilarityLmd.md b/docs/reference/api/IndicesSettingsSimilarityLmd.md new file mode 100644 index 000000000..822940b82 --- /dev/null +++ b/docs/reference/api/IndicesSettingsSimilarityLmd.md @@ -0,0 +1,6 @@ +## Interface `IndicesSettingsSimilarityLmd` + +| Name | Type | Description | +| - | - | - | +| `mu` | [double](./double.md) |   | +| `type` | 'LMDirichlet' |   | diff --git a/docs/reference/api/IndicesSettingsSimilarityLmj.md b/docs/reference/api/IndicesSettingsSimilarityLmj.md new file mode 100644 index 000000000..091bad49e --- /dev/null +++ b/docs/reference/api/IndicesSettingsSimilarityLmj.md @@ -0,0 +1,6 @@ +## Interface `IndicesSettingsSimilarityLmj` + +| Name | Type | Description | +| - | - | - | +| `lambda` | [double](./double.md) |   | +| `type` | 'LMJelinekMercer' |   | diff --git a/docs/reference/api/IndicesSettingsSimilarityScripted.md b/docs/reference/api/IndicesSettingsSimilarityScripted.md new file mode 100644 index 000000000..ed45ba6d3 --- /dev/null +++ b/docs/reference/api/IndicesSettingsSimilarityScripted.md @@ -0,0 +1,7 @@ +## Interface `IndicesSettingsSimilarityScripted` + +| Name | Type | Description | +| - | - | - | +| `script` | [Script](./Script.md) | [ScriptSource](./ScriptSource.md) |   | +| `type` | 'scripted' |   | +| `weight_script` | [Script](./Script.md) | [ScriptSource](./ScriptSource.md) |   | diff --git a/docs/reference/api/IndicesShardStoresIndicesShardStores.md b/docs/reference/api/IndicesShardStoresIndicesShardStores.md new file mode 100644 index 000000000..c5a468997 --- /dev/null +++ b/docs/reference/api/IndicesShardStoresIndicesShardStores.md @@ -0,0 +1,5 @@ +## Interface `IndicesShardStoresIndicesShardStores` + +| Name | Type | Description | +| - | - | - | +| `shards` | Record |   | diff --git a/docs/reference/api/IndicesShardStoresRequest.md b/docs/reference/api/IndicesShardStoresRequest.md new file mode 100644 index 000000000..7ac5fb698 --- /dev/null +++ b/docs/reference/api/IndicesShardStoresRequest.md @@ -0,0 +1,11 @@ +## Interface `IndicesShardStoresRequest` + +| Name | Type | Description | +| - | - | - | +| `allow_no_indices` | boolean | If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices. | +| `body` | string | ({ [key: string]: any; } & { index?: never; allow_no_indices?: never; expand_wildcards?: never; ignore_unavailable?: never; status?: never; }) | All values in `body` will be added to the request body. | +| `expand_wildcards` | [ExpandWildcards](./ExpandWildcards.md) | Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. | +| `ignore_unavailable` | boolean | If true, missing or closed indices are not included in the response. | +| `index` | [Indices](./Indices.md) | List of data streams, indices, and aliases used to limit the request. | +| `querystring` | { [key: string]: any; } & { index?: never; allow_no_indices?: never; expand_wildcards?: never; ignore_unavailable?: never; status?: never; } | All values in `querystring` will be added to the request querystring. | +| `status` | [IndicesShardStoresShardStoreStatus](./IndicesShardStoresShardStoreStatus.md) | [IndicesShardStoresShardStoreStatus](./IndicesShardStoresShardStoreStatus.md)[] | List of shard health statuses used to limit the request. | diff --git a/docs/reference/api/IndicesShardStoresResponse.md b/docs/reference/api/IndicesShardStoresResponse.md new file mode 100644 index 000000000..7407e8249 --- /dev/null +++ b/docs/reference/api/IndicesShardStoresResponse.md @@ -0,0 +1,5 @@ +## Interface `IndicesShardStoresResponse` + +| Name | Type | Description | +| - | - | - | +| `indices` | Record<[IndexName](./IndexName.md), [IndicesShardStoresIndicesShardStores](./IndicesShardStoresIndicesShardStores.md)> |   | diff --git a/docs/reference/api/IndicesShardStoresShardStore.md b/docs/reference/api/IndicesShardStoresShardStore.md new file mode 100644 index 000000000..8f60a47d6 --- /dev/null +++ b/docs/reference/api/IndicesShardStoresShardStore.md @@ -0,0 +1,4 @@ +## `IndicesShardStoresShardStore` +::: +type IndicesShardStoresShardStore = [IndicesShardStoresShardStoreKeys](./IndicesShardStoresShardStoreKeys.md) & { [property: string]: [IndicesShardStoresShardStoreNode](./IndicesShardStoresShardStoreNode.md) | [IndicesShardStoresShardStoreAllocation](./IndicesShardStoresShardStoreAllocation.md) | [Id](./Id.md) | [IndicesShardStoresShardStoreException](./IndicesShardStoresShardStoreException.md);}; +::: diff --git a/docs/reference/api/IndicesShardStoresShardStoreAllocation.md b/docs/reference/api/IndicesShardStoresShardStoreAllocation.md new file mode 100644 index 000000000..b7cb152a0 --- /dev/null +++ b/docs/reference/api/IndicesShardStoresShardStoreAllocation.md @@ -0,0 +1,4 @@ +## `IndicesShardStoresShardStoreAllocation` +::: +type IndicesShardStoresShardStoreAllocation = 'primary' | 'replica' | 'unused'; +::: diff --git a/docs/reference/api/IndicesShardStoresShardStoreException.md b/docs/reference/api/IndicesShardStoresShardStoreException.md new file mode 100644 index 000000000..5b4533e14 --- /dev/null +++ b/docs/reference/api/IndicesShardStoresShardStoreException.md @@ -0,0 +1,6 @@ +## Interface `IndicesShardStoresShardStoreException` + +| Name | Type | Description | +| - | - | - | +| `reason` | string |   | +| `type` | string |   | diff --git a/docs/reference/api/IndicesShardStoresShardStoreKeys.md b/docs/reference/api/IndicesShardStoresShardStoreKeys.md new file mode 100644 index 000000000..6c344cc64 --- /dev/null +++ b/docs/reference/api/IndicesShardStoresShardStoreKeys.md @@ -0,0 +1,7 @@ +## Interface `IndicesShardStoresShardStoreKeys` + +| Name | Type | Description | +| - | - | - | +| `allocation_id` | [Id](./Id.md) |   | +| `allocation` | [IndicesShardStoresShardStoreAllocation](./IndicesShardStoresShardStoreAllocation.md) |   | +| `store_exception` | [IndicesShardStoresShardStoreException](./IndicesShardStoresShardStoreException.md) |   | diff --git a/docs/reference/api/IndicesShardStoresShardStoreNode.md b/docs/reference/api/IndicesShardStoresShardStoreNode.md new file mode 100644 index 000000000..30862c820 --- /dev/null +++ b/docs/reference/api/IndicesShardStoresShardStoreNode.md @@ -0,0 +1,10 @@ +## Interface `IndicesShardStoresShardStoreNode` + +| Name | Type | Description | +| - | - | - | +| `attributes` | Record |   | +| `ephemeral_id` | string |   | +| `external_id` | string |   | +| `name` | [Name](./Name.md) |   | +| `roles` | string[] |   | +| `transport_address` | [TransportAddress](./TransportAddress.md) |   | diff --git a/docs/reference/api/IndicesShardStoresShardStoreStatus.md b/docs/reference/api/IndicesShardStoresShardStoreStatus.md new file mode 100644 index 000000000..f6f3fdd6d --- /dev/null +++ b/docs/reference/api/IndicesShardStoresShardStoreStatus.md @@ -0,0 +1,4 @@ +## `IndicesShardStoresShardStoreStatus` +::: +type IndicesShardStoresShardStoreStatus = 'green' | 'yellow' | 'red' | 'all'; +::: diff --git a/docs/reference/api/IndicesShardStoresShardStoreWrapper.md b/docs/reference/api/IndicesShardStoresShardStoreWrapper.md new file mode 100644 index 000000000..04e4d0cd1 --- /dev/null +++ b/docs/reference/api/IndicesShardStoresShardStoreWrapper.md @@ -0,0 +1,5 @@ +## Interface `IndicesShardStoresShardStoreWrapper` + +| Name | Type | Description | +| - | - | - | +| `stores` | [IndicesShardStoresShardStore](./IndicesShardStoresShardStore.md)[] |   | diff --git a/docs/reference/api/IndicesShrinkRequest.md b/docs/reference/api/IndicesShrinkRequest.md new file mode 100644 index 000000000..36fd11b4f --- /dev/null +++ b/docs/reference/api/IndicesShrinkRequest.md @@ -0,0 +1,13 @@ +## Interface `IndicesShrinkRequest` + +| Name | Type | Description | +| - | - | - | +| `aliases` | Record<[IndexName](./IndexName.md), [IndicesAlias](./IndicesAlias.md)> | The key is the alias name. Index alias names support date math. | +| `body` | string | ({ [key: string]: any; } & { index?: never; target?: never; master_timeout?: never; timeout?: never; wait_for_active_shards?: never; aliases?: never; settings?: never; }) | All values in `body` will be added to the request body. | +| `index` | [IndexName](./IndexName.md) | Name of the source index to shrink. | +| `master_timeout` | [Duration](./Duration.md) | Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. | +| `querystring` | { [key: string]: any; } & { index?: never; target?: never; master_timeout?: never; timeout?: never; wait_for_active_shards?: never; aliases?: never; settings?: never; } | All values in `querystring` will be added to the request querystring. | +| `settings` | Record | Configuration options for the target index. | +| `target` | [IndexName](./IndexName.md) | Name of the target index to create. | +| `timeout` | [Duration](./Duration.md) | Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. | +| `wait_for_active_shards` | [WaitForActiveShards](./WaitForActiveShards.md) | The number of shard copies that must be active before proceeding with the operation. Set to `all` or any positive integer up to the total number of shards in the index ( `number_of_replicas+1`). | diff --git a/docs/reference/api/IndicesShrinkResponse.md b/docs/reference/api/IndicesShrinkResponse.md new file mode 100644 index 000000000..0032b17fd --- /dev/null +++ b/docs/reference/api/IndicesShrinkResponse.md @@ -0,0 +1,7 @@ +## Interface `IndicesShrinkResponse` + +| Name | Type | Description | +| - | - | - | +| `acknowledged` | boolean |   | +| `index` | [IndexName](./IndexName.md) |   | +| `shards_acknowledged` | boolean |   | diff --git a/docs/reference/api/IndicesSimulateIndexTemplateRequest.md b/docs/reference/api/IndicesSimulateIndexTemplateRequest.md new file mode 100644 index 000000000..a7fe69920 --- /dev/null +++ b/docs/reference/api/IndicesSimulateIndexTemplateRequest.md @@ -0,0 +1,11 @@ +## Interface `IndicesSimulateIndexTemplateRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { name?: never; create?: never; cause?: never; master_timeout?: never; include_defaults?: never; }) | All values in `body` will be added to the request body. | +| `cause` | string | User defined reason for dry-run creating the new template for simulation purposes | +| `create` | boolean | Whether the index template we optionally defined in the body should only be dry-run added if new or can also replace an existing one | +| `include_defaults` | boolean | If true, returns all relevant default configurations for the index template. | +| `master_timeout` | [Duration](./Duration.md) | Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. | +| `name` | [Name](./Name.md) | Name of the index to simulate | +| `querystring` | { [key: string]: any; } & { name?: never; create?: never; cause?: never; master_timeout?: never; include_defaults?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/IndicesSimulateIndexTemplateResponse.md b/docs/reference/api/IndicesSimulateIndexTemplateResponse.md new file mode 100644 index 000000000..d5f008d77 --- /dev/null +++ b/docs/reference/api/IndicesSimulateIndexTemplateResponse.md @@ -0,0 +1,6 @@ +## Interface `IndicesSimulateIndexTemplateResponse` + +| Name | Type | Description | +| - | - | - | +| `overlapping` | [IndicesSimulateTemplateOverlapping](./IndicesSimulateTemplateOverlapping.md)[] |   | +| `template` | [IndicesSimulateTemplateTemplate](./IndicesSimulateTemplateTemplate.md) |   | diff --git a/docs/reference/api/IndicesSimulateTemplateOverlapping.md b/docs/reference/api/IndicesSimulateTemplateOverlapping.md new file mode 100644 index 000000000..a7bba81b7 --- /dev/null +++ b/docs/reference/api/IndicesSimulateTemplateOverlapping.md @@ -0,0 +1,6 @@ +## Interface `IndicesSimulateTemplateOverlapping` + +| Name | Type | Description | +| - | - | - | +| `index_patterns` | string[] |   | +| `name` | [Name](./Name.md) |   | diff --git a/docs/reference/api/IndicesSimulateTemplateRequest.md b/docs/reference/api/IndicesSimulateTemplateRequest.md new file mode 100644 index 000000000..d5750efca --- /dev/null +++ b/docs/reference/api/IndicesSimulateTemplateRequest.md @@ -0,0 +1,21 @@ +## Interface `IndicesSimulateTemplateRequest` + +| Name | Type | Description | +| - | - | - | +| `_meta` | [Metadata](./Metadata.md) | Optional user metadata about the index template. May have any contents. This map is not automatically generated by Elasticsearch. | +| `allow_auto_create` | boolean | This setting overrides the value of the `action.auto_create_index` cluster setting. If set to `true` in a template, then indices can be automatically created using that template even if auto-creation of indices is disabled via `actions.auto_create_index`. If set to `false`, then indices or data streams matching the template must always be explicitly created, and may never be automatically created. | +| `body` | string | ({ [key: string]: any; } & { name?: never; create?: never; cause?: never; master_timeout?: never; include_defaults?: never; allow_auto_create?: never; index_patterns?: never; composed_of?: never; template?: never; data_stream?: never; priority?: never; version?: never; _meta?: never; ignore_missing_component_templates?: never; deprecated?: never; }) | All values in `body` will be added to the request body. | +| `cause` | string | User defined reason for dry-run creating the new template for simulation purposes | +| `composed_of` | [Name](./Name.md)[] | An ordered list of component template names. Component templates are merged in the order specified, meaning that the last component template specified has the highest precedence. | +| `create` | boolean | If true, the template passed in the body is only used if no existing templates match the same index patterns. If false, the simulation uses the template with the highest priority. Note that the template is not permanently added or updated in either case; it is only used for the simulation. | +| `data_stream` | [IndicesDataStreamVisibility](./IndicesDataStreamVisibility.md) | If this object is included, the template is used to create data streams and their backing indices. Supports an empty object. Data streams require a matching index template with a `data_stream` object. | +| `deprecated` | boolean | Marks this index template as deprecated. When creating or updating a non-deprecated index template that uses deprecated components, Elasticsearch will emit a deprecation warning. | +| `ignore_missing_component_templates` | string[] | The configuration option ignore_missing_component_templates can be used when an index template references a component template that might not exist | +| `include_defaults` | boolean | If true, returns all relevant default configurations for the index template. | +| `index_patterns` | [Indices](./Indices.md) | Array of wildcard ( `*`) expressions used to match the names of data streams and indices during creation. | +| `master_timeout` | [Duration](./Duration.md) | Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. | +| `name` | [Name](./Name.md) | Name of the index template to simulate. To test a template configuration before you add it to the cluster, omit this parameter and specify the template configuration in the request body. | +| `priority` | [long](./long.md) | Priority to determine index template precedence when a new data stream or index is created. The index template with the highest priority is chosen. If no priority is specified the template is treated as though it is of priority 0 (lowest priority). This number is not automatically generated by Elasticsearch. | +| `querystring` | { [key: string]: any; } & { name?: never; create?: never; cause?: never; master_timeout?: never; include_defaults?: never; allow_auto_create?: never; index_patterns?: never; composed_of?: never; template?: never; data_stream?: never; priority?: never; version?: never; _meta?: never; ignore_missing_component_templates?: never; deprecated?: never; } | All values in `querystring` will be added to the request querystring. | +| `template` | [IndicesPutIndexTemplateIndexTemplateMapping](./IndicesPutIndexTemplateIndexTemplateMapping.md) | Template to be applied. It may optionally include an `aliases`, `mappings`, or `settings` configuration. | +| `version` | [VersionNumber](./VersionNumber.md) | Version number used to manage index templates externally. This number is not automatically generated by Elasticsearch. | diff --git a/docs/reference/api/IndicesSimulateTemplateResponse.md b/docs/reference/api/IndicesSimulateTemplateResponse.md new file mode 100644 index 000000000..74cf7559c --- /dev/null +++ b/docs/reference/api/IndicesSimulateTemplateResponse.md @@ -0,0 +1,6 @@ +## Interface `IndicesSimulateTemplateResponse` + +| Name | Type | Description | +| - | - | - | +| `overlapping` | [IndicesSimulateTemplateOverlapping](./IndicesSimulateTemplateOverlapping.md)[] |   | +| `template` | [IndicesSimulateTemplateTemplate](./IndicesSimulateTemplateTemplate.md) |   | diff --git a/docs/reference/api/IndicesSimulateTemplateTemplate.md b/docs/reference/api/IndicesSimulateTemplateTemplate.md new file mode 100644 index 000000000..d9bb2cf04 --- /dev/null +++ b/docs/reference/api/IndicesSimulateTemplateTemplate.md @@ -0,0 +1,7 @@ +## Interface `IndicesSimulateTemplateTemplate` + +| Name | Type | Description | +| - | - | - | +| `aliases` | Record<[IndexName](./IndexName.md), [IndicesAlias](./IndicesAlias.md)> |   | +| `mappings` | [MappingTypeMapping](./MappingTypeMapping.md) |   | +| `settings` | [IndicesIndexSettings](./IndicesIndexSettings.md) |   | diff --git a/docs/reference/api/IndicesSlowlogSettings.md b/docs/reference/api/IndicesSlowlogSettings.md new file mode 100644 index 000000000..5174f97a2 --- /dev/null +++ b/docs/reference/api/IndicesSlowlogSettings.md @@ -0,0 +1,8 @@ +## Interface `IndicesSlowlogSettings` + +| Name | Type | Description | +| - | - | - | +| `level` | string |   | +| `reformat` | boolean |   | +| `source` | [integer](./integer.md) |   | +| `threshold` | [IndicesSlowlogTresholds](./IndicesSlowlogTresholds.md) |   | diff --git a/docs/reference/api/IndicesSlowlogTresholdLevels.md b/docs/reference/api/IndicesSlowlogTresholdLevels.md new file mode 100644 index 000000000..658abc191 --- /dev/null +++ b/docs/reference/api/IndicesSlowlogTresholdLevels.md @@ -0,0 +1,8 @@ +## Interface `IndicesSlowlogTresholdLevels` + +| Name | Type | Description | +| - | - | - | +| `debug` | [Duration](./Duration.md) |   | +| `info` | [Duration](./Duration.md) |   | +| `trace` | [Duration](./Duration.md) |   | +| `warn` | [Duration](./Duration.md) |   | diff --git a/docs/reference/api/IndicesSlowlogTresholds.md b/docs/reference/api/IndicesSlowlogTresholds.md new file mode 100644 index 000000000..3e328c456 --- /dev/null +++ b/docs/reference/api/IndicesSlowlogTresholds.md @@ -0,0 +1,6 @@ +## Interface `IndicesSlowlogTresholds` + +| Name | Type | Description | +| - | - | - | +| `fetch` | [IndicesSlowlogTresholdLevels](./IndicesSlowlogTresholdLevels.md) |   | +| `query` | [IndicesSlowlogTresholdLevels](./IndicesSlowlogTresholdLevels.md) |   | diff --git a/docs/reference/api/IndicesSoftDeletes.md b/docs/reference/api/IndicesSoftDeletes.md new file mode 100644 index 000000000..7f7f1a69f --- /dev/null +++ b/docs/reference/api/IndicesSoftDeletes.md @@ -0,0 +1,6 @@ +## Interface `IndicesSoftDeletes` + +| Name | Type | Description | +| - | - | - | +| `enabled` | boolean | Indicates whether soft deletes are enabled on the index. | +| `retention_lease` | [IndicesRetentionLease](./IndicesRetentionLease.md) | The maximum period to retain a shard history retention lease before it is considered expired. Shard history retention leases ensure that soft deletes are retained during merges on the Lucene index. If a soft delete is merged away before it can be replicated to a follower the following process will fail due to incomplete history on the leader. | diff --git a/docs/reference/api/IndicesSourceMode.md b/docs/reference/api/IndicesSourceMode.md new file mode 100644 index 000000000..28f734bc2 --- /dev/null +++ b/docs/reference/api/IndicesSourceMode.md @@ -0,0 +1,4 @@ +## `IndicesSourceMode` +::: +type IndicesSourceMode = 'disabled' | 'stored' | 'synthetic'; +::: diff --git a/docs/reference/api/IndicesSplitRequest.md b/docs/reference/api/IndicesSplitRequest.md new file mode 100644 index 000000000..c238db684 --- /dev/null +++ b/docs/reference/api/IndicesSplitRequest.md @@ -0,0 +1,13 @@ +## Interface `IndicesSplitRequest` + +| Name | Type | Description | +| - | - | - | +| `aliases` | Record<[IndexName](./IndexName.md), [IndicesAlias](./IndicesAlias.md)> | Aliases for the resulting index. | +| `body` | string | ({ [key: string]: any; } & { index?: never; target?: never; master_timeout?: never; timeout?: never; wait_for_active_shards?: never; aliases?: never; settings?: never; }) | All values in `body` will be added to the request body. | +| `index` | [IndexName](./IndexName.md) | Name of the source index to split. | +| `master_timeout` | [Duration](./Duration.md) | Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. | +| `querystring` | { [key: string]: any; } & { index?: never; target?: never; master_timeout?: never; timeout?: never; wait_for_active_shards?: never; aliases?: never; settings?: never; } | All values in `querystring` will be added to the request querystring. | +| `settings` | Record | Configuration options for the target index. | +| `target` | [IndexName](./IndexName.md) | Name of the target index to create. | +| `timeout` | [Duration](./Duration.md) | Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. | +| `wait_for_active_shards` | [WaitForActiveShards](./WaitForActiveShards.md) | The number of shard copies that must be active before proceeding with the operation. Set to `all` or any positive integer up to the total number of shards in the index ( `number_of_replicas+1`). | diff --git a/docs/reference/api/IndicesSplitResponse.md b/docs/reference/api/IndicesSplitResponse.md new file mode 100644 index 000000000..9f0ddf779 --- /dev/null +++ b/docs/reference/api/IndicesSplitResponse.md @@ -0,0 +1,7 @@ +## Interface `IndicesSplitResponse` + +| Name | Type | Description | +| - | - | - | +| `acknowledged` | boolean |   | +| `index` | [IndexName](./IndexName.md) |   | +| `shards_acknowledged` | boolean |   | diff --git a/docs/reference/api/IndicesStatsIndexMetadataState.md b/docs/reference/api/IndicesStatsIndexMetadataState.md new file mode 100644 index 000000000..77df7c4be --- /dev/null +++ b/docs/reference/api/IndicesStatsIndexMetadataState.md @@ -0,0 +1,4 @@ +## `IndicesStatsIndexMetadataState` +::: +type IndicesStatsIndexMetadataState = 'open' | 'close'; +::: diff --git a/docs/reference/api/IndicesStatsIndexStats.md b/docs/reference/api/IndicesStatsIndexStats.md new file mode 100644 index 000000000..e78b3055c --- /dev/null +++ b/docs/reference/api/IndicesStatsIndexStats.md @@ -0,0 +1,23 @@ +## Interface `IndicesStatsIndexStats` + +| Name | Type | Description | +| - | - | - | +| `bulk` | [BulkStats](./BulkStats.md) |   | +| `completion` | [CompletionStats](./CompletionStats.md) | Contains statistics about completions across all shards assigned to the node. | +| `docs` | [DocStats](./DocStats.md) | Contains statistics about documents across all primary shards assigned to the node. | +| `fielddata` | [FielddataStats](./FielddataStats.md) | Contains statistics about the field data cache across all shards assigned to the node. | +| `flush` | [FlushStats](./FlushStats.md) | Contains statistics about flush operations for the node. | +| `get` | [GetStats](./GetStats.md) | Contains statistics about get operations for the node. | +| `indexing` | [IndexingStats](./IndexingStats.md) | Contains statistics about indexing operations for the node. | +| `indices` | [IndicesStatsIndicesStats](./IndicesStatsIndicesStats.md) | Contains statistics about indices operations for the node. | +| `merges` | [MergesStats](./MergesStats.md) | Contains statistics about merge operations for the node. | +| `query_cache` | [QueryCacheStats](./QueryCacheStats.md) | Contains statistics about the query cache across all shards assigned to the node. | +| `recovery` | [RecoveryStats](./RecoveryStats.md) | Contains statistics about recovery operations for the node. | +| `refresh` | [RefreshStats](./RefreshStats.md) | Contains statistics about refresh operations for the node. | +| `request_cache` | [RequestCacheStats](./RequestCacheStats.md) | Contains statistics about the request cache across all shards assigned to the node. | +| `search` | [SearchStats](./SearchStats.md) | Contains statistics about search operations for the node. | +| `segments` | [SegmentsStats](./SegmentsStats.md) | Contains statistics about segments across all shards assigned to the node. | +| `shard_stats` | [IndicesStatsShardsTotalStats](./IndicesStatsShardsTotalStats.md) |   | +| `store` | [StoreStats](./StoreStats.md) | Contains statistics about the size of shards assigned to the node. | +| `translog` | [TranslogStats](./TranslogStats.md) | Contains statistics about transaction log operations for the node. | +| `warmer` | [WarmerStats](./WarmerStats.md) | Contains statistics about index warming operations for the node. | diff --git a/docs/reference/api/IndicesStatsIndicesStats.md b/docs/reference/api/IndicesStatsIndicesStats.md new file mode 100644 index 000000000..ce1954a93 --- /dev/null +++ b/docs/reference/api/IndicesStatsIndicesStats.md @@ -0,0 +1,10 @@ +## Interface `IndicesStatsIndicesStats` + +| Name | Type | Description | +| - | - | - | +| `health` | [HealthStatus](./HealthStatus.md) |   | +| `primaries` | [IndicesStatsIndexStats](./IndicesStatsIndexStats.md) |   | +| `shards` | Record |   | +| `status` | [IndicesStatsIndexMetadataState](./IndicesStatsIndexMetadataState.md) |   | +| `total` | [IndicesStatsIndexStats](./IndicesStatsIndexStats.md) |   | +| `uuid` | [Uuid](./Uuid.md) |   | diff --git a/docs/reference/api/IndicesStatsMappingStats.md b/docs/reference/api/IndicesStatsMappingStats.md new file mode 100644 index 000000000..495e3cb03 --- /dev/null +++ b/docs/reference/api/IndicesStatsMappingStats.md @@ -0,0 +1,7 @@ +## Interface `IndicesStatsMappingStats` + +| Name | Type | Description | +| - | - | - | +| `total_count` | [long](./long.md) |   | +| `total_estimated_overhead_in_bytes` | [long](./long.md) |   | +| `total_estimated_overhead` | [ByteSize](./ByteSize.md) |   | diff --git a/docs/reference/api/IndicesStatsRequest.md b/docs/reference/api/IndicesStatsRequest.md new file mode 100644 index 000000000..aa0e8935a --- /dev/null +++ b/docs/reference/api/IndicesStatsRequest.md @@ -0,0 +1,17 @@ +## Interface `IndicesStatsRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { metric?: never; index?: never; completion_fields?: never; expand_wildcards?: never; fielddata_fields?: never; fields?: never; forbid_closed_indices?: never; groups?: never; include_segment_file_sizes?: never; include_unloaded_segments?: never; level?: never; }) | All values in `body` will be added to the request body. | +| `completion_fields` | [Fields](./Fields.md) | Comma-separated list or wildcard expressions of fields to include in fielddata and suggest statistics. | +| `expand_wildcards` | [ExpandWildcards](./ExpandWildcards.md) | Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. | +| `fielddata_fields` | [Fields](./Fields.md) | Comma-separated list or wildcard expressions of fields to include in fielddata statistics. | +| `fields` | [Fields](./Fields.md) | Comma-separated list or wildcard expressions of fields to include in the statistics. | +| `forbid_closed_indices` | boolean | If true, statistics are not collected from closed indices. | +| `groups` | string | string[] | Comma-separated list of search groups to include in the search statistics. | +| `include_segment_file_sizes` | boolean | If true, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested). | +| `include_unloaded_segments` | boolean | If true, the response includes information from segments that are not loaded into memory. | +| `index` | [Indices](./Indices.md) | A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices | +| `level` | [Level](./Level.md) | Indicates whether statistics are aggregated at the cluster, index, or shard level. | +| `metric` | [Metrics](./Metrics.md) | Limit the information returned the specific metrics. | +| `querystring` | { [key: string]: any; } & { metric?: never; index?: never; completion_fields?: never; expand_wildcards?: never; fielddata_fields?: never; fields?: never; forbid_closed_indices?: never; groups?: never; include_segment_file_sizes?: never; include_unloaded_segments?: never; level?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/IndicesStatsResponse.md b/docs/reference/api/IndicesStatsResponse.md new file mode 100644 index 000000000..78e9b9bac --- /dev/null +++ b/docs/reference/api/IndicesStatsResponse.md @@ -0,0 +1,7 @@ +## Interface `IndicesStatsResponse` + +| Name | Type | Description | +| - | - | - | +| `_all` | [IndicesStatsIndicesStats](./IndicesStatsIndicesStats.md) |   | +| `_shards` | [ShardStatistics](./ShardStatistics.md) |   | +| `indices` | Record |   | diff --git a/docs/reference/api/IndicesStatsShardCommit.md b/docs/reference/api/IndicesStatsShardCommit.md new file mode 100644 index 000000000..5799cdd2e --- /dev/null +++ b/docs/reference/api/IndicesStatsShardCommit.md @@ -0,0 +1,8 @@ +## Interface `IndicesStatsShardCommit` + +| Name | Type | Description | +| - | - | - | +| `generation` | [integer](./integer.md) |   | +| `id` | [Id](./Id.md) |   | +| `num_docs` | [long](./long.md) |   | +| `user_data` | Record |   | diff --git a/docs/reference/api/IndicesStatsShardFileSizeInfo.md b/docs/reference/api/IndicesStatsShardFileSizeInfo.md new file mode 100644 index 000000000..de836a7a6 --- /dev/null +++ b/docs/reference/api/IndicesStatsShardFileSizeInfo.md @@ -0,0 +1,10 @@ +## Interface `IndicesStatsShardFileSizeInfo` + +| Name | Type | Description | +| - | - | - | +| `average_size_in_bytes` | [long](./long.md) |   | +| `count` | [long](./long.md) |   | +| `description` | string |   | +| `max_size_in_bytes` | [long](./long.md) |   | +| `min_size_in_bytes` | [long](./long.md) |   | +| `size_in_bytes` | [long](./long.md) |   | diff --git a/docs/reference/api/IndicesStatsShardLease.md b/docs/reference/api/IndicesStatsShardLease.md new file mode 100644 index 000000000..85c47dbcb --- /dev/null +++ b/docs/reference/api/IndicesStatsShardLease.md @@ -0,0 +1,8 @@ +## Interface `IndicesStatsShardLease` + +| Name | Type | Description | +| - | - | - | +| `id` | [Id](./Id.md) |   | +| `retaining_seq_no` | [SequenceNumber](./SequenceNumber.md) |   | +| `source` | string |   | +| `timestamp` | [long](./long.md) |   | diff --git a/docs/reference/api/IndicesStatsShardPath.md b/docs/reference/api/IndicesStatsShardPath.md new file mode 100644 index 000000000..9da5bd67b --- /dev/null +++ b/docs/reference/api/IndicesStatsShardPath.md @@ -0,0 +1,7 @@ +## Interface `IndicesStatsShardPath` + +| Name | Type | Description | +| - | - | - | +| `data_path` | string |   | +| `is_custom_data_path` | boolean |   | +| `state_path` | string |   | diff --git a/docs/reference/api/IndicesStatsShardQueryCache.md b/docs/reference/api/IndicesStatsShardQueryCache.md new file mode 100644 index 000000000..26e1cdf43 --- /dev/null +++ b/docs/reference/api/IndicesStatsShardQueryCache.md @@ -0,0 +1,11 @@ +## Interface `IndicesStatsShardQueryCache` + +| Name | Type | Description | +| - | - | - | +| `cache_count` | [long](./long.md) |   | +| `cache_size` | [long](./long.md) |   | +| `evictions` | [long](./long.md) |   | +| `hit_count` | [long](./long.md) |   | +| `memory_size_in_bytes` | [long](./long.md) |   | +| `miss_count` | [long](./long.md) |   | +| `total_count` | [long](./long.md) |   | diff --git a/docs/reference/api/IndicesStatsShardRetentionLeases.md b/docs/reference/api/IndicesStatsShardRetentionLeases.md new file mode 100644 index 000000000..44b5c7a08 --- /dev/null +++ b/docs/reference/api/IndicesStatsShardRetentionLeases.md @@ -0,0 +1,7 @@ +## Interface `IndicesStatsShardRetentionLeases` + +| Name | Type | Description | +| - | - | - | +| `leases` | [IndicesStatsShardLease](./IndicesStatsShardLease.md)[] |   | +| `primary_term` | [long](./long.md) |   | +| `version` | [VersionNumber](./VersionNumber.md) |   | diff --git a/docs/reference/api/IndicesStatsShardRouting.md b/docs/reference/api/IndicesStatsShardRouting.md new file mode 100644 index 000000000..1c9fd0af7 --- /dev/null +++ b/docs/reference/api/IndicesStatsShardRouting.md @@ -0,0 +1,8 @@ +## Interface `IndicesStatsShardRouting` + +| Name | Type | Description | +| - | - | - | +| `node` | string |   | +| `primary` | boolean |   | +| `relocating_node` | string | null |   | +| `state` | [IndicesStatsShardRoutingState](./IndicesStatsShardRoutingState.md) |   | diff --git a/docs/reference/api/IndicesStatsShardRoutingState.md b/docs/reference/api/IndicesStatsShardRoutingState.md new file mode 100644 index 000000000..985085bac --- /dev/null +++ b/docs/reference/api/IndicesStatsShardRoutingState.md @@ -0,0 +1,4 @@ +## `IndicesStatsShardRoutingState` +::: +type IndicesStatsShardRoutingState = 'UNASSIGNED' | 'INITIALIZING' | 'STARTED' | 'RELOCATING'; +::: diff --git a/docs/reference/api/IndicesStatsShardSequenceNumber.md b/docs/reference/api/IndicesStatsShardSequenceNumber.md new file mode 100644 index 000000000..034cd100c --- /dev/null +++ b/docs/reference/api/IndicesStatsShardSequenceNumber.md @@ -0,0 +1,7 @@ +## Interface `IndicesStatsShardSequenceNumber` + +| Name | Type | Description | +| - | - | - | +| `global_checkpoint` | [long](./long.md) |   | +| `local_checkpoint` | [long](./long.md) |   | +| `max_seq_no` | [SequenceNumber](./SequenceNumber.md) |   | diff --git a/docs/reference/api/IndicesStatsShardStats.md b/docs/reference/api/IndicesStatsShardStats.md new file mode 100644 index 000000000..8372cf314 --- /dev/null +++ b/docs/reference/api/IndicesStatsShardStats.md @@ -0,0 +1,30 @@ +## Interface `IndicesStatsShardStats` + +| Name | Type | Description | +| - | - | - | +| `bulk` | [BulkStats](./BulkStats.md) |   | +| `commit` | [IndicesStatsShardCommit](./IndicesStatsShardCommit.md) |   | +| `completion` | [CompletionStats](./CompletionStats.md) |   | +| `docs` | [DocStats](./DocStats.md) |   | +| `fielddata` | [FielddataStats](./FielddataStats.md) |   | +| `flush` | [FlushStats](./FlushStats.md) |   | +| `get` | [GetStats](./GetStats.md) |   | +| `indexing` | [IndexingStats](./IndexingStats.md) |   | +| `indices` | [IndicesStatsIndicesStats](./IndicesStatsIndicesStats.md) |   | +| `mappings` | [IndicesStatsMappingStats](./IndicesStatsMappingStats.md) |   | +| `merges` | [MergesStats](./MergesStats.md) |   | +| `query_cache` | [IndicesStatsShardQueryCache](./IndicesStatsShardQueryCache.md) |   | +| `recovery` | [RecoveryStats](./RecoveryStats.md) |   | +| `refresh` | [RefreshStats](./RefreshStats.md) |   | +| `request_cache` | [RequestCacheStats](./RequestCacheStats.md) |   | +| `retention_leases` | [IndicesStatsShardRetentionLeases](./IndicesStatsShardRetentionLeases.md) |   | +| `routing` | [IndicesStatsShardRouting](./IndicesStatsShardRouting.md) |   | +| `search` | [SearchStats](./SearchStats.md) |   | +| `segments` | [SegmentsStats](./SegmentsStats.md) |   | +| `seq_no` | [IndicesStatsShardSequenceNumber](./IndicesStatsShardSequenceNumber.md) |   | +| `shard_path` | [IndicesStatsShardPath](./IndicesStatsShardPath.md) |   | +| `shard_stats` | [IndicesStatsShardsTotalStats](./IndicesStatsShardsTotalStats.md) |   | +| `shards` | Record<[IndexName](./IndexName.md), any> |   | +| `store` | [StoreStats](./StoreStats.md) |   | +| `translog` | [TranslogStats](./TranslogStats.md) |   | +| `warmer` | [WarmerStats](./WarmerStats.md) |   | diff --git a/docs/reference/api/IndicesStatsShardsTotalStats.md b/docs/reference/api/IndicesStatsShardsTotalStats.md new file mode 100644 index 000000000..dfa01494c --- /dev/null +++ b/docs/reference/api/IndicesStatsShardsTotalStats.md @@ -0,0 +1,5 @@ +## Interface `IndicesStatsShardsTotalStats` + +| Name | Type | Description | +| - | - | - | +| `total_count` | [long](./long.md) |   | diff --git a/docs/reference/api/IndicesStorage.md b/docs/reference/api/IndicesStorage.md new file mode 100644 index 000000000..26aedc06a --- /dev/null +++ b/docs/reference/api/IndicesStorage.md @@ -0,0 +1,6 @@ +## Interface `IndicesStorage` + +| Name | Type | Description | +| - | - | - | +| `allow_mmap` | boolean | You can restrict the use of the mmapfs and the related hybridfs store type via the setting node.store.allow_mmap. This is a boolean setting indicating whether or not memory-mapping is allowed. The default is to allow it. This setting is useful, for example, if you are in an environment where you can not control the ability to create a lot of memory maps so you need disable the ability to use memory-mapping. | +| `type` | [IndicesStorageType](./IndicesStorageType.md) |   | diff --git a/docs/reference/api/IndicesStorageType.md b/docs/reference/api/IndicesStorageType.md new file mode 100644 index 000000000..c711559bf --- /dev/null +++ b/docs/reference/api/IndicesStorageType.md @@ -0,0 +1,4 @@ +## `IndicesStorageType` +::: +type IndicesStorageType = 'fs' | 'niofs' | 'mmapfs' | 'hybridfs' | string; +::: diff --git a/docs/reference/api/IndicesTemplateMapping.md b/docs/reference/api/IndicesTemplateMapping.md new file mode 100644 index 000000000..13ce338e8 --- /dev/null +++ b/docs/reference/api/IndicesTemplateMapping.md @@ -0,0 +1,10 @@ +## Interface `IndicesTemplateMapping` + +| Name | Type | Description | +| - | - | - | +| `aliases` | Record<[IndexName](./IndexName.md), [IndicesAlias](./IndicesAlias.md)> |   | +| `index_patterns` | [Name](./Name.md)[] |   | +| `mappings` | [MappingTypeMapping](./MappingTypeMapping.md) |   | +| `order` | [integer](./integer.md) |   | +| `settings` | Record |   | +| `version` | [VersionNumber](./VersionNumber.md) |   | diff --git a/docs/reference/api/IndicesTranslog.md b/docs/reference/api/IndicesTranslog.md new file mode 100644 index 000000000..7d94fde1f --- /dev/null +++ b/docs/reference/api/IndicesTranslog.md @@ -0,0 +1,8 @@ +## Interface `IndicesTranslog` + +| Name | Type | Description | +| - | - | - | +| `durability` | [IndicesTranslogDurability](./IndicesTranslogDurability.md) | Whether or not to `fsync` and commit the translog after every index, delete, update, or bulk request. | +| `flush_threshold_size` | [ByteSize](./ByteSize.md) | The translog stores all operations that are not yet safely persisted in Lucene (i.e., are not part of a Lucene commit point). Although these operations are available for reads, they will need to be replayed if the shard was stopped and had to be recovered. This setting controls the maximum total size of these operations, to prevent recoveries from taking too long. Once the maximum size has been reached a flush will happen, generating a new Lucene commit point. | +| `retention` | [IndicesTranslogRetention](./IndicesTranslogRetention.md) |   | +| `sync_interval` | [Duration](./Duration.md) | How often the translog is fsynced to disk and committed, regardless of write operations. Values less than 100ms are not allowed. | diff --git a/docs/reference/api/IndicesTranslogDurability.md b/docs/reference/api/IndicesTranslogDurability.md new file mode 100644 index 000000000..d2d3fa7b0 --- /dev/null +++ b/docs/reference/api/IndicesTranslogDurability.md @@ -0,0 +1,4 @@ +## `IndicesTranslogDurability` +::: +type IndicesTranslogDurability = 'request' | 'REQUEST' | 'async' | 'ASYNC'; +::: diff --git a/docs/reference/api/IndicesTranslogRetention.md b/docs/reference/api/IndicesTranslogRetention.md new file mode 100644 index 000000000..e1df8db19 --- /dev/null +++ b/docs/reference/api/IndicesTranslogRetention.md @@ -0,0 +1,6 @@ +## Interface `IndicesTranslogRetention` + +| Name | Type | Description | +| - | - | - | +| `age` | [Duration](./Duration.md) | This controls the maximum duration for which translog files are kept by each shard. Keeping more translog files increases the chance of performing an operation based sync when recovering replicas. If the translog files are not sufficient, replica recovery will fall back to a file based sync. This setting is ignored, and should not be set, if soft deletes are enabled. Soft deletes are enabled by default in indices created in Elasticsearch versions 7.0.0 and later. | +| `size` | [ByteSize](./ByteSize.md) | This controls the total size of translog files to keep for each shard. Keeping more translog files increases the chance of performing an operation based sync when recovering a replica. If the translog files are not sufficient, replica recovery will fall back to a file based sync. This setting is ignored, and should not be set, if soft deletes are enabled. Soft deletes are enabled by default in indices created in Elasticsearch versions 7.0.0 and later. | diff --git a/docs/reference/api/IndicesUpdateAliasesAction.md b/docs/reference/api/IndicesUpdateAliasesAction.md new file mode 100644 index 000000000..274649992 --- /dev/null +++ b/docs/reference/api/IndicesUpdateAliasesAction.md @@ -0,0 +1,7 @@ +## Interface `IndicesUpdateAliasesAction` + +| Name | Type | Description | +| - | - | - | +| `add` | [IndicesUpdateAliasesAddAction](./IndicesUpdateAliasesAddAction.md) | Adds a data stream or index to an alias. If the alias doesn’t exist, the `add` action creates it. | +| `remove_index` | [IndicesUpdateAliasesRemoveIndexAction](./IndicesUpdateAliasesRemoveIndexAction.md) | Deletes an index. You cannot use this action on aliases or data streams. | +| `remove` | [IndicesUpdateAliasesRemoveAction](./IndicesUpdateAliasesRemoveAction.md) | Removes a data stream or index from an alias. | diff --git a/docs/reference/api/IndicesUpdateAliasesAddAction.md b/docs/reference/api/IndicesUpdateAliasesAddAction.md new file mode 100644 index 000000000..28a91b619 --- /dev/null +++ b/docs/reference/api/IndicesUpdateAliasesAddAction.md @@ -0,0 +1,15 @@ +## Interface `IndicesUpdateAliasesAddAction` + +| Name | Type | Description | +| - | - | - | +| `alias` | [IndexAlias](./IndexAlias.md) | Alias for the action. Index alias names support date math. | +| `aliases` | [IndexAlias](./IndexAlias.md) | [IndexAlias](./IndexAlias.md)[] | Aliases for the action. Index alias names support date math. | +| `filter` | [QueryDslQueryContainer](./QueryDslQueryContainer.md) | Query used to limit documents the alias can access. | +| `index_routing` | [Routing](./Routing.md) | Value used to route indexing operations to a specific shard. If specified, this overwrites the `routing` value for indexing operations. Data stream aliases don’t support this parameter. | +| `index` | [IndexName](./IndexName.md) | Data stream or index for the action. Supports wildcards ( `*`). | +| `indices` | [Indices](./Indices.md) | Data streams or indices for the action. Supports wildcards ( `*`). | +| `is_hidden` | boolean | If `true`, the alias is hidden. | +| `is_write_index` | boolean | If `true`, sets the write index or data stream for the alias. | +| `must_exist` | boolean | If `true`, the alias must exist to perform the action. | +| `routing` | [Routing](./Routing.md) | Value used to route indexing and search operations to a specific shard. Data stream aliases don’t support this parameter. | +| `search_routing` | [Routing](./Routing.md) | Value used to route search operations to a specific shard. If specified, this overwrites the `routing` value for search operations. Data stream aliases don’t support this parameter. | diff --git a/docs/reference/api/IndicesUpdateAliasesRemoveAction.md b/docs/reference/api/IndicesUpdateAliasesRemoveAction.md new file mode 100644 index 000000000..d686193cc --- /dev/null +++ b/docs/reference/api/IndicesUpdateAliasesRemoveAction.md @@ -0,0 +1,9 @@ +## Interface `IndicesUpdateAliasesRemoveAction` + +| Name | Type | Description | +| - | - | - | +| `alias` | [IndexAlias](./IndexAlias.md) | Alias for the action. Index alias names support date math. | +| `aliases` | [IndexAlias](./IndexAlias.md) | [IndexAlias](./IndexAlias.md)[] | Aliases for the action. Index alias names support date math. | +| `index` | [IndexName](./IndexName.md) | Data stream or index for the action. Supports wildcards ( `*`). | +| `indices` | [Indices](./Indices.md) | Data streams or indices for the action. Supports wildcards ( `*`). | +| `must_exist` | boolean | If `true`, the alias must exist to perform the action. | diff --git a/docs/reference/api/IndicesUpdateAliasesRemoveIndexAction.md b/docs/reference/api/IndicesUpdateAliasesRemoveIndexAction.md new file mode 100644 index 000000000..5376a706f --- /dev/null +++ b/docs/reference/api/IndicesUpdateAliasesRemoveIndexAction.md @@ -0,0 +1,7 @@ +## Interface `IndicesUpdateAliasesRemoveIndexAction` + +| Name | Type | Description | +| - | - | - | +| `index` | [IndexName](./IndexName.md) | Data stream or index for the action. Supports wildcards ( `*`). | +| `indices` | [Indices](./Indices.md) | Data streams or indices for the action. Supports wildcards ( `*`). | +| `must_exist` | boolean | If `true`, the alias must exist to perform the action. | diff --git a/docs/reference/api/IndicesUpdateAliasesRequest.md b/docs/reference/api/IndicesUpdateAliasesRequest.md new file mode 100644 index 000000000..bae5d2b81 --- /dev/null +++ b/docs/reference/api/IndicesUpdateAliasesRequest.md @@ -0,0 +1,9 @@ +## Interface `IndicesUpdateAliasesRequest` + +| Name | Type | Description | +| - | - | - | +| `actions` | [IndicesUpdateAliasesAction](./IndicesUpdateAliasesAction.md)[] | Actions to perform. | +| `body` | string | ({ [key: string]: any; } & { master_timeout?: never; timeout?: never; actions?: never; }) | All values in `body` will be added to the request body. | +| `master_timeout` | [Duration](./Duration.md) | Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. | +| `querystring` | { [key: string]: any; } & { master_timeout?: never; timeout?: never; actions?: never; } | All values in `querystring` will be added to the request querystring. | +| `timeout` | [Duration](./Duration.md) | Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. | diff --git a/docs/reference/api/IndicesUpdateAliasesResponse.md b/docs/reference/api/IndicesUpdateAliasesResponse.md new file mode 100644 index 000000000..030dcf607 --- /dev/null +++ b/docs/reference/api/IndicesUpdateAliasesResponse.md @@ -0,0 +1,4 @@ +## `IndicesUpdateAliasesResponse` +::: +type IndicesUpdateAliasesResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); +::: diff --git a/docs/reference/api/IndicesValidateQueryIndicesValidationExplanation.md b/docs/reference/api/IndicesValidateQueryIndicesValidationExplanation.md new file mode 100644 index 000000000..8c911f2fa --- /dev/null +++ b/docs/reference/api/IndicesValidateQueryIndicesValidationExplanation.md @@ -0,0 +1,8 @@ +## Interface `IndicesValidateQueryIndicesValidationExplanation` + +| Name | Type | Description | +| - | - | - | +| `error` | string |   | +| `explanation` | string |   | +| `index` | [IndexName](./IndexName.md) |   | +| `valid` | boolean |   | diff --git a/docs/reference/api/IndicesValidateQueryRequest.md b/docs/reference/api/IndicesValidateQueryRequest.md new file mode 100644 index 000000000..55c517325 --- /dev/null +++ b/docs/reference/api/IndicesValidateQueryRequest.md @@ -0,0 +1,20 @@ +## Interface `IndicesValidateQueryRequest` + +| Name | Type | Description | +| - | - | - | +| `all_shards` | boolean | If `true`, the validation is executed on all shards instead of one random shard per index. | +| `allow_no_indices` | boolean | If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. | +| `analyze_wildcard` | boolean | If `true`, wildcard and prefix queries are analyzed. | +| `analyzer` | string | Analyzer to use for the query string. This parameter can only be used when the `q` query string parameter is specified. | +| `body` | string | ({ [key: string]: any; } & { index?: never; allow_no_indices?: never; all_shards?: never; analyzer?: never; analyze_wildcard?: never; default_operator?: never; df?: never; expand_wildcards?: never; explain?: never; ignore_unavailable?: never; lenient?: never; rewrite?: never; q?: never; query?: never; }) | All values in `body` will be added to the request body. | +| `default_operator` | [QueryDslOperator](./QueryDslOperator.md) | The default operator for query string query: `AND` or `OR`. | +| `df` | string | Field to use as default where no field prefix is given in the query string. This parameter can only be used when the `q` query string parameter is specified. | +| `expand_wildcards` | [ExpandWildcards](./ExpandWildcards.md) | Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. | +| `explain` | boolean | If `true`, the response returns detailed information if an error has occurred. | +| `ignore_unavailable` | boolean | If `false`, the request returns an error if it targets a missing or closed index. | +| `index` | [Indices](./Indices.md) | Comma-separated list of data streams, indices, and aliases to search. Supports wildcards ( `*`). To search all data streams or indices, omit this parameter or use `*` or `_all`. | +| `lenient` | boolean | If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. | +| `q` | string | Query in the Lucene query string syntax. | +| `query` | [QueryDslQueryContainer](./QueryDslQueryContainer.md) | Query in the Lucene query string syntax. | +| `querystring` | { [key: string]: any; } & { index?: never; allow_no_indices?: never; all_shards?: never; analyzer?: never; analyze_wildcard?: never; default_operator?: never; df?: never; expand_wildcards?: never; explain?: never; ignore_unavailable?: never; lenient?: never; rewrite?: never; q?: never; query?: never; } | All values in `querystring` will be added to the request querystring. | +| `rewrite` | boolean | If `true`, returns a more detailed explanation showing the actual Lucene query that will be executed. | diff --git a/docs/reference/api/IndicesValidateQueryResponse.md b/docs/reference/api/IndicesValidateQueryResponse.md new file mode 100644 index 000000000..9d84097d7 --- /dev/null +++ b/docs/reference/api/IndicesValidateQueryResponse.md @@ -0,0 +1,8 @@ +## Interface `IndicesValidateQueryResponse` + +| Name | Type | Description | +| - | - | - | +| `_shards` | [ShardStatistics](./ShardStatistics.md) |   | +| `error` | string |   | +| `explanations` | [IndicesValidateQueryIndicesValidationExplanation](./IndicesValidateQueryIndicesValidationExplanation.md)[] |   | +| `valid` | boolean |   | diff --git a/docs/reference/api/Inference.md b/docs/reference/api/Inference.md new file mode 100644 index 000000000..6b8013990 --- /dev/null +++ b/docs/reference/api/Inference.md @@ -0,0 +1,20 @@ +## `Inference` + +### Constructor + +::: +new Inference(transport: [Transport](./Transport.md)); +::: + +### Properties + +| Name | Type | Description | +| - | - | - | +| `acceptedParams` | Record |   | +| `transport` | [Transport](./Transport.md) |   | + +### Methods + +| Name | Signature | Description | +| - | - | - | +| `chatCompletionUnified` | `chatCompletionUnified(this: [That](./That.md), params: [InferenceChatCompletionUnifiedRequest](./InferenceChatCompletionUnifiedRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[InferenceChatCompletionUnifiedResponse](./InferenceChatCompletionUnifiedResponse.md)>;` | Perform chat completion inference The chat completion inference API enables real-time responses for chat completion tasks by delivering answers incrementally, reducing response times during computation. It only works with the `chat_completion` task type for `openai` and `elastic` inference services. IMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Azure, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face. For built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models. However, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs. NOTE: The `chat_completion` task type is only available within the _stream API and only supports streaming. The Chat completion inference API and the Stream inference API differ in their response structure and capabilities. The Chat completion inference API provides more comprehensive customization options through more fields and function calling support. If you use the `openai` service or the `elastic` service, use the Chat completion inference API. || `chatCompletionUnified` | `chatCompletionUnified(this: [That](./That.md), params: [InferenceChatCompletionUnifiedRequest](./InferenceChatCompletionUnifiedRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[InferenceChatCompletionUnifiedResponse](./InferenceChatCompletionUnifiedResponse.md), unknown>>;` |   || `chatCompletionUnified` | `chatCompletionUnified(this: [That](./That.md), params: [InferenceChatCompletionUnifiedRequest](./InferenceChatCompletionUnifiedRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[InferenceChatCompletionUnifiedResponse](./InferenceChatCompletionUnifiedResponse.md)>;` |   || `completion` | `completion(this: [That](./That.md), params: [InferenceCompletionRequest](./InferenceCompletionRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[InferenceCompletionResponse](./InferenceCompletionResponse.md)>;` | Perform completion inference on the service || `completion` | `completion(this: [That](./That.md), params: [InferenceCompletionRequest](./InferenceCompletionRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[InferenceCompletionResponse](./InferenceCompletionResponse.md), unknown>>;` |   || `completion` | `completion(this: [That](./That.md), params: [InferenceCompletionRequest](./InferenceCompletionRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[InferenceCompletionResponse](./InferenceCompletionResponse.md)>;` |   || `delete` | `delete(this: [That](./That.md), params: [InferenceDeleteRequest](./InferenceDeleteRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[InferenceDeleteResponse](./InferenceDeleteResponse.md)>;` | Delete an inference endpoint || `delete` | `delete(this: [That](./That.md), params: [InferenceDeleteRequest](./InferenceDeleteRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[InferenceDeleteResponse](./InferenceDeleteResponse.md), unknown>>;` |   || `delete` | `delete(this: [That](./That.md), params: [InferenceDeleteRequest](./InferenceDeleteRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[InferenceDeleteResponse](./InferenceDeleteResponse.md)>;` |   || `get` | `get(this: [That](./That.md), params?: [InferenceGetRequest](./InferenceGetRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[InferenceGetResponse](./InferenceGetResponse.md)>;` | Get an inference endpoint || `get` | `get(this: [That](./That.md), params?: [InferenceGetRequest](./InferenceGetRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[InferenceGetResponse](./InferenceGetResponse.md), unknown>>;` |   || `get` | `get(this: [That](./That.md), params?: [InferenceGetRequest](./InferenceGetRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[InferenceGetResponse](./InferenceGetResponse.md)>;` |   || `inference` | `inference(this: [That](./That.md), params: [InferenceInferenceRequest](./InferenceInferenceRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[InferenceInferenceResponse](./InferenceInferenceResponse.md)>;` | Perform inference on the service. This API enables you to use machine learning models to perform specific tasks on data that you provide as an input. It returns a response with the results of the tasks. The inference endpoint you use can perform one specific task that has been defined when the endpoint was created with the create inference API. For details about using this API with a service, such as Amazon Bedrock, Anthropic, or HuggingFace, refer to the service-specific documentation. > info > The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Azure, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face. For built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models. However, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs. || `inference` | `inference(this: [That](./That.md), params: [InferenceInferenceRequest](./InferenceInferenceRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[InferenceInferenceResponse](./InferenceInferenceResponse.md), unknown>>;` |   || `inference` | `inference(this: [That](./That.md), params: [InferenceInferenceRequest](./InferenceInferenceRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[InferenceInferenceResponse](./InferenceInferenceResponse.md)>;` |   || `put` | `put(this: [That](./That.md), params: [InferencePutRequest](./InferencePutRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[InferencePutResponse](./InferencePutResponse.md)>;` | Create an inference endpoint. IMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Mistral, Azure OpenAI, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face. For built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models. However, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs. || `put` | `put(this: [That](./That.md), params: [InferencePutRequest](./InferencePutRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[InferencePutResponse](./InferencePutResponse.md), unknown>>;` |   || `put` | `put(this: [That](./That.md), params: [InferencePutRequest](./InferencePutRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[InferencePutResponse](./InferencePutResponse.md)>;` |   || `putAlibabacloud` | `putAlibabacloud(this: [That](./That.md), params: [InferencePutAlibabacloudRequest](./InferencePutAlibabacloudRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[InferencePutAlibabacloudResponse](./InferencePutAlibabacloudResponse.md)>;` | Create an AlibabaCloud AI Search inference endpoint. Create an inference endpoint to perform an inference task with the `alibabacloud-ai-search` service. || `putAlibabacloud` | `putAlibabacloud(this: [That](./That.md), params: [InferencePutAlibabacloudRequest](./InferencePutAlibabacloudRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[InferencePutAlibabacloudResponse](./InferencePutAlibabacloudResponse.md), unknown>>;` |   || `putAlibabacloud` | `putAlibabacloud(this: [That](./That.md), params: [InferencePutAlibabacloudRequest](./InferencePutAlibabacloudRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[InferencePutAlibabacloudResponse](./InferencePutAlibabacloudResponse.md)>;` |   || `putAmazonbedrock` | `putAmazonbedrock(this: [That](./That.md), params: [InferencePutAmazonbedrockRequest](./InferencePutAmazonbedrockRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[InferencePutAmazonbedrockResponse](./InferencePutAmazonbedrockResponse.md)>;` | Create an Amazon Bedrock inference endpoint. Creates an inference endpoint to perform an inference task with the `amazonbedrock` service. > info > You need to provide the access and secret keys only once, during the inference model creation. The get inference API does not retrieve your access or secret keys. After creating the inference model, you cannot change the associated key pairs. If you want to use a different access and secret key pair, delete the inference model and recreate it with the same name and the updated keys. || `putAmazonbedrock` | `putAmazonbedrock(this: [That](./That.md), params: [InferencePutAmazonbedrockRequest](./InferencePutAmazonbedrockRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[InferencePutAmazonbedrockResponse](./InferencePutAmazonbedrockResponse.md), unknown>>;` |   || `putAmazonbedrock` | `putAmazonbedrock(this: [That](./That.md), params: [InferencePutAmazonbedrockRequest](./InferencePutAmazonbedrockRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[InferencePutAmazonbedrockResponse](./InferencePutAmazonbedrockResponse.md)>;` |   || `putAnthropic` | `putAnthropic(this: [That](./That.md), params: [InferencePutAnthropicRequest](./InferencePutAnthropicRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[InferencePutAnthropicResponse](./InferencePutAnthropicResponse.md)>;` | Create an Anthropic inference endpoint. Create an inference endpoint to perform an inference task with the `anthropic` service. || `putAnthropic` | `putAnthropic(this: [That](./That.md), params: [InferencePutAnthropicRequest](./InferencePutAnthropicRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[InferencePutAnthropicResponse](./InferencePutAnthropicResponse.md), unknown>>;` |   || `putAnthropic` | `putAnthropic(this: [That](./That.md), params: [InferencePutAnthropicRequest](./InferencePutAnthropicRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[InferencePutAnthropicResponse](./InferencePutAnthropicResponse.md)>;` |   || `putAzureaistudio` | `putAzureaistudio(this: [That](./That.md), params: [InferencePutAzureaistudioRequest](./InferencePutAzureaistudioRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[InferencePutAzureaistudioResponse](./InferencePutAzureaistudioResponse.md)>;` | Create an Azure AI studio inference endpoint. Create an inference endpoint to perform an inference task with the `azureaistudio` service. || `putAzureaistudio` | `putAzureaistudio(this: [That](./That.md), params: [InferencePutAzureaistudioRequest](./InferencePutAzureaistudioRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[InferencePutAzureaistudioResponse](./InferencePutAzureaistudioResponse.md), unknown>>;` |   || `putAzureaistudio` | `putAzureaistudio(this: [That](./That.md), params: [InferencePutAzureaistudioRequest](./InferencePutAzureaistudioRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[InferencePutAzureaistudioResponse](./InferencePutAzureaistudioResponse.md)>;` |   || `putAzureopenai` | `putAzureopenai(this: [That](./That.md), params: [InferencePutAzureopenaiRequest](./InferencePutAzureopenaiRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[InferencePutAzureopenaiResponse](./InferencePutAzureopenaiResponse.md)>;` | Create an Azure OpenAI inference endpoint. Create an inference endpoint to perform an inference task with the `azureopenai` service. The list of chat completion models that you can choose from in your Azure OpenAI deployment include: * [GPT-4 and GPT-4 Turbo models](https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models?tabs=global-standard%2Cstandard-chat-completions#gpt-4-and-gpt-4-turbo-models) * [GPT-3.5](https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models?tabs=global-standard%2Cstandard-chat-completions#gpt-35) The list of embeddings models that you can choose from in your deployment can be found in the [Azure models documentation](https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models?tabs=global-standard%2Cstandard-chat-completions#embeddings). || `putAzureopenai` | `putAzureopenai(this: [That](./That.md), params: [InferencePutAzureopenaiRequest](./InferencePutAzureopenaiRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[InferencePutAzureopenaiResponse](./InferencePutAzureopenaiResponse.md), unknown>>;` |   || `putAzureopenai` | `putAzureopenai(this: [That](./That.md), params: [InferencePutAzureopenaiRequest](./InferencePutAzureopenaiRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[InferencePutAzureopenaiResponse](./InferencePutAzureopenaiResponse.md)>;` |   || `putCohere` | `putCohere(this: [That](./That.md), params: [InferencePutCohereRequest](./InferencePutCohereRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[InferencePutCohereResponse](./InferencePutCohereResponse.md)>;` | Create a Cohere inference endpoint. Create an inference endpoint to perform an inference task with the `cohere` service. || `putCohere` | `putCohere(this: [That](./That.md), params: [InferencePutCohereRequest](./InferencePutCohereRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[InferencePutCohereResponse](./InferencePutCohereResponse.md), unknown>>;` |   || `putCohere` | `putCohere(this: [That](./That.md), params: [InferencePutCohereRequest](./InferencePutCohereRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[InferencePutCohereResponse](./InferencePutCohereResponse.md)>;` |   || `putElasticsearch` | `putElasticsearch(this: [That](./That.md), params: [InferencePutElasticsearchRequest](./InferencePutElasticsearchRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[InferencePutElasticsearchResponse](./InferencePutElasticsearchResponse.md)>;` | Create an Elasticsearch inference endpoint. Create an inference endpoint to perform an inference task with the `elasticsearch` service. > info > Your Elasticsearch deployment contains preconfigured ELSER and E5 inference endpoints, you only need to create the enpoints using the API if you want to customize the settings. If you use the ELSER or the E5 model through the `elasticsearch` service, the API request will automatically download and deploy the model if it isn't downloaded yet. > info > You might see a 502 bad gateway error in the response when using the Kibana Console. This error usually just reflects a timeout, while the model downloads in the background. You can check the download progress in the Machine Learning UI. If using the Python client, you can set the timeout parameter to a higher value. After creating the endpoint, wait for the model deployment to complete before using it. To verify the deployment status, use the get trained model statistics API. Look for `"state": "fully_allocated"` in the response and ensure that the `"allocation_count"` matches the `"target_allocation_count"`. Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources. || `putElasticsearch` | `putElasticsearch(this: [That](./That.md), params: [InferencePutElasticsearchRequest](./InferencePutElasticsearchRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[InferencePutElasticsearchResponse](./InferencePutElasticsearchResponse.md), unknown>>;` |   || `putElasticsearch` | `putElasticsearch(this: [That](./That.md), params: [InferencePutElasticsearchRequest](./InferencePutElasticsearchRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[InferencePutElasticsearchResponse](./InferencePutElasticsearchResponse.md)>;` |   || `putElser` | `putElser(this: [That](./That.md), params: [InferencePutElserRequest](./InferencePutElserRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[InferencePutElserResponse](./InferencePutElserResponse.md)>;` | Create an ELSER inference endpoint. Create an inference endpoint to perform an inference task with the `elser` service. You can also deploy ELSER by using the Elasticsearch inference integration. > info > Your Elasticsearch deployment contains a preconfigured ELSER inference endpoint, you only need to create the enpoint using the API if you want to customize the settings. The API request will automatically download and deploy the ELSER model if it isn't already downloaded. > info > You might see a 502 bad gateway error in the response when using the Kibana Console. This error usually just reflects a timeout, while the model downloads in the background. You can check the download progress in the Machine Learning UI. If using the Python client, you can set the timeout parameter to a higher value. After creating the endpoint, wait for the model deployment to complete before using it. To verify the deployment status, use the get trained model statistics API. Look for `"state": "fully_allocated"` in the response and ensure that the `"allocation_count"` matches the `"target_allocation_count"`. Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources. || `putElser` | `putElser(this: [That](./That.md), params: [InferencePutElserRequest](./InferencePutElserRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[InferencePutElserResponse](./InferencePutElserResponse.md), unknown>>;` |   || `putElser` | `putElser(this: [That](./That.md), params: [InferencePutElserRequest](./InferencePutElserRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[InferencePutElserResponse](./InferencePutElserResponse.md)>;` |   || `putGoogleaistudio` | `putGoogleaistudio(this: [That](./That.md), params: [InferencePutGoogleaistudioRequest](./InferencePutGoogleaistudioRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[InferencePutGoogleaistudioResponse](./InferencePutGoogleaistudioResponse.md)>;` | Create an Google AI Studio inference endpoint. Create an inference endpoint to perform an inference task with the `googleaistudio` service. || `putGoogleaistudio` | `putGoogleaistudio(this: [That](./That.md), params: [InferencePutGoogleaistudioRequest](./InferencePutGoogleaistudioRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[InferencePutGoogleaistudioResponse](./InferencePutGoogleaistudioResponse.md), unknown>>;` |   || `putGoogleaistudio` | `putGoogleaistudio(this: [That](./That.md), params: [InferencePutGoogleaistudioRequest](./InferencePutGoogleaistudioRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[InferencePutGoogleaistudioResponse](./InferencePutGoogleaistudioResponse.md)>;` |   || `putGooglevertexai` | `putGooglevertexai(this: [That](./That.md), params: [InferencePutGooglevertexaiRequest](./InferencePutGooglevertexaiRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[InferencePutGooglevertexaiResponse](./InferencePutGooglevertexaiResponse.md)>;` | Create a Google Vertex AI inference endpoint. Create an inference endpoint to perform an inference task with the `googlevertexai` service. || `putGooglevertexai` | `putGooglevertexai(this: [That](./That.md), params: [InferencePutGooglevertexaiRequest](./InferencePutGooglevertexaiRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[InferencePutGooglevertexaiResponse](./InferencePutGooglevertexaiResponse.md), unknown>>;` |   || `putGooglevertexai` | `putGooglevertexai(this: [That](./That.md), params: [InferencePutGooglevertexaiRequest](./InferencePutGooglevertexaiRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[InferencePutGooglevertexaiResponse](./InferencePutGooglevertexaiResponse.md)>;` |   || `putHuggingFace` | `putHuggingFace(this: [That](./That.md), params: [InferencePutHuggingFaceRequest](./InferencePutHuggingFaceRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[InferencePutHuggingFaceResponse](./InferencePutHuggingFaceResponse.md)>;` | Create a Hugging Face inference endpoint. Create an inference endpoint to perform an inference task with the `hugging_face` service. You must first create an inference endpoint on the Hugging Face endpoint page to get an endpoint URL. Select the model you want to use on the new endpoint creation page (for example `intfloat/e5-small-v2`), then select the sentence embeddings task under the advanced configuration section. Create the endpoint and copy the URL after the endpoint initialization has been finished. The following models are recommended for the Hugging Face service: * `all-MiniLM-L6-v2` * `all-MiniLM-L12-v2` * `all-mpnet-base-v2` * `e5-base-v2` * `e5-small-v2` * `multilingual-e5-base` * `multilingual-e5-small` || `putHuggingFace` | `putHuggingFace(this: [That](./That.md), params: [InferencePutHuggingFaceRequest](./InferencePutHuggingFaceRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[InferencePutHuggingFaceResponse](./InferencePutHuggingFaceResponse.md), unknown>>;` |   || `putHuggingFace` | `putHuggingFace(this: [That](./That.md), params: [InferencePutHuggingFaceRequest](./InferencePutHuggingFaceRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[InferencePutHuggingFaceResponse](./InferencePutHuggingFaceResponse.md)>;` |   || `putJinaai` | `putJinaai(this: [That](./That.md), params: [InferencePutJinaaiRequest](./InferencePutJinaaiRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[InferencePutJinaaiResponse](./InferencePutJinaaiResponse.md)>;` | Create an JinaAI inference endpoint. Create an inference endpoint to perform an inference task with the `jinaai` service. To review the available `rerank` models, refer to < https://jina.ai/reranker > . To review the available `text_embedding` models, refer to the < https://jina.ai/embeddings/ > . || `putJinaai` | `putJinaai(this: [That](./That.md), params: [InferencePutJinaaiRequest](./InferencePutJinaaiRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[InferencePutJinaaiResponse](./InferencePutJinaaiResponse.md), unknown>>;` |   || `putJinaai` | `putJinaai(this: [That](./That.md), params: [InferencePutJinaaiRequest](./InferencePutJinaaiRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[InferencePutJinaaiResponse](./InferencePutJinaaiResponse.md)>;` |   || `putMistral` | `putMistral(this: [That](./That.md), params: [InferencePutMistralRequest](./InferencePutMistralRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[InferencePutMistralResponse](./InferencePutMistralResponse.md)>;` | Create a Mistral inference endpoint. Creates an inference endpoint to perform an inference task with the `mistral` service. || `putMistral` | `putMistral(this: [That](./That.md), params: [InferencePutMistralRequest](./InferencePutMistralRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[InferencePutMistralResponse](./InferencePutMistralResponse.md), unknown>>;` |   || `putMistral` | `putMistral(this: [That](./That.md), params: [InferencePutMistralRequest](./InferencePutMistralRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[InferencePutMistralResponse](./InferencePutMistralResponse.md)>;` |   || `putOpenai` | `putOpenai(this: [That](./That.md), params: [InferencePutOpenaiRequest](./InferencePutOpenaiRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[InferencePutOpenaiResponse](./InferencePutOpenaiResponse.md)>;` | Create an OpenAI inference endpoint. Create an inference endpoint to perform an inference task with the `openai` service or `openai` compatible APIs. || `putOpenai` | `putOpenai(this: [That](./That.md), params: [InferencePutOpenaiRequest](./InferencePutOpenaiRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[InferencePutOpenaiResponse](./InferencePutOpenaiResponse.md), unknown>>;` |   || `putOpenai` | `putOpenai(this: [That](./That.md), params: [InferencePutOpenaiRequest](./InferencePutOpenaiRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[InferencePutOpenaiResponse](./InferencePutOpenaiResponse.md)>;` |   || `putVoyageai` | `putVoyageai(this: [That](./That.md), params: [InferencePutVoyageaiRequest](./InferencePutVoyageaiRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[InferencePutVoyageaiResponse](./InferencePutVoyageaiResponse.md)>;` | Create a VoyageAI inference endpoint. Create an inference endpoint to perform an inference task with the `voyageai` service. Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources. || `putVoyageai` | `putVoyageai(this: [That](./That.md), params: [InferencePutVoyageaiRequest](./InferencePutVoyageaiRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[InferencePutVoyageaiResponse](./InferencePutVoyageaiResponse.md), unknown>>;` |   || `putVoyageai` | `putVoyageai(this: [That](./That.md), params: [InferencePutVoyageaiRequest](./InferencePutVoyageaiRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[InferencePutVoyageaiResponse](./InferencePutVoyageaiResponse.md)>;` |   || `putWatsonx` | `putWatsonx(this: [That](./That.md), params: [InferencePutWatsonxRequest](./InferencePutWatsonxRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[InferencePutWatsonxResponse](./InferencePutWatsonxResponse.md)>;` | Create a Watsonx inference endpoint. Create an inference endpoint to perform an inference task with the `watsonxai` service. You need an IBM Cloud Databases for Elasticsearch deployment to use the `watsonxai` inference service. You can provision one through the IBM catalog, the Cloud Databases CLI plug-in, the Cloud Databases API, or Terraform. || `putWatsonx` | `putWatsonx(this: [That](./That.md), params: [InferencePutWatsonxRequest](./InferencePutWatsonxRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[InferencePutWatsonxResponse](./InferencePutWatsonxResponse.md), unknown>>;` |   || `putWatsonx` | `putWatsonx(this: [That](./That.md), params: [InferencePutWatsonxRequest](./InferencePutWatsonxRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[InferencePutWatsonxResponse](./InferencePutWatsonxResponse.md)>;` |   || `rerank` | `rerank(this: [That](./That.md), params: [InferenceRerankRequest](./InferenceRerankRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[InferenceRerankResponse](./InferenceRerankResponse.md)>;` | Perform rereanking inference on the service || `rerank` | `rerank(this: [That](./That.md), params: [InferenceRerankRequest](./InferenceRerankRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[InferenceRerankResponse](./InferenceRerankResponse.md), unknown>>;` |   || `rerank` | `rerank(this: [That](./That.md), params: [InferenceRerankRequest](./InferenceRerankRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[InferenceRerankResponse](./InferenceRerankResponse.md)>;` |   || `sparseEmbedding` | `sparseEmbedding(this: [That](./That.md), params: [InferenceSparseEmbeddingRequest](./InferenceSparseEmbeddingRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[InferenceSparseEmbeddingResponse](./InferenceSparseEmbeddingResponse.md)>;` | Perform sparse embedding inference on the service || `sparseEmbedding` | `sparseEmbedding(this: [That](./That.md), params: [InferenceSparseEmbeddingRequest](./InferenceSparseEmbeddingRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[InferenceSparseEmbeddingResponse](./InferenceSparseEmbeddingResponse.md), unknown>>;` |   || `sparseEmbedding` | `sparseEmbedding(this: [That](./That.md), params: [InferenceSparseEmbeddingRequest](./InferenceSparseEmbeddingRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[InferenceSparseEmbeddingResponse](./InferenceSparseEmbeddingResponse.md)>;` |   || `streamCompletion` | `streamCompletion(this: [That](./That.md), params: [InferenceStreamCompletionRequest](./InferenceStreamCompletionRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[InferenceStreamCompletionResponse](./InferenceStreamCompletionResponse.md)>;` | Perform streaming inference. Get real-time responses for completion tasks by delivering answers incrementally, reducing response times during computation. This API works only with the completion task type. IMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Azure, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face. For built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models. However, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs. This API requires the `monitor_inference` cluster privilege (the built-in `inference_admin` and `inference_user` roles grant this privilege). You must use a client that supports streaming. || `streamCompletion` | `streamCompletion(this: [That](./That.md), params: [InferenceStreamCompletionRequest](./InferenceStreamCompletionRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[InferenceStreamCompletionResponse](./InferenceStreamCompletionResponse.md), unknown>>;` |   || `streamCompletion` | `streamCompletion(this: [That](./That.md), params: [InferenceStreamCompletionRequest](./InferenceStreamCompletionRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[InferenceStreamCompletionResponse](./InferenceStreamCompletionResponse.md)>;` |   || `textEmbedding` | `textEmbedding(this: [That](./That.md), params: [InferenceTextEmbeddingRequest](./InferenceTextEmbeddingRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[InferenceTextEmbeddingResponse](./InferenceTextEmbeddingResponse.md)>;` | Perform text embedding inference on the service || `textEmbedding` | `textEmbedding(this: [That](./That.md), params: [InferenceTextEmbeddingRequest](./InferenceTextEmbeddingRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[InferenceTextEmbeddingResponse](./InferenceTextEmbeddingResponse.md), unknown>>;` |   || `textEmbedding` | `textEmbedding(this: [That](./That.md), params: [InferenceTextEmbeddingRequest](./InferenceTextEmbeddingRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[InferenceTextEmbeddingResponse](./InferenceTextEmbeddingResponse.md)>;` |   || `update` | `update(this: [That](./That.md), params: [InferenceUpdateRequest](./InferenceUpdateRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[InferenceUpdateResponse](./InferenceUpdateResponse.md)>;` | Update an inference endpoint. Modify `task_settings`, secrets (within `service_settings`), or `num_allocations` for an inference endpoint, depending on the specific endpoint service and `task_type`. IMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Azure, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face. For built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models. However, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs. || `update` | `update(this: [That](./That.md), params: [InferenceUpdateRequest](./InferenceUpdateRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[InferenceUpdateResponse](./InferenceUpdateResponse.md), unknown>>;` |   || `update` | `update(this: [That](./That.md), params: [InferenceUpdateRequest](./InferenceUpdateRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[InferenceUpdateResponse](./InferenceUpdateResponse.md)>;` |   | \ No newline at end of file diff --git a/docs/reference/api/InferenceAdaptiveAllocations.md b/docs/reference/api/InferenceAdaptiveAllocations.md new file mode 100644 index 000000000..bb8893188 --- /dev/null +++ b/docs/reference/api/InferenceAdaptiveAllocations.md @@ -0,0 +1,7 @@ +## Interface `InferenceAdaptiveAllocations` + +| Name | Type | Description | +| - | - | - | +| `enabled` | boolean | Turn on `adaptive_allocations`. | +| `max_number_of_allocations` | [integer](./integer.md) | The maximum number of allocations to scale to. If set, it must be greater than or equal to `min_number_of_allocations`. | +| `min_number_of_allocations` | [integer](./integer.md) | The minimum number of allocations to scale to. If set, it must be greater than or equal to 0. If not defined, the deployment scales to 0. | diff --git a/docs/reference/api/InferenceAlibabaCloudServiceSettings.md b/docs/reference/api/InferenceAlibabaCloudServiceSettings.md new file mode 100644 index 000000000..355dcf467 --- /dev/null +++ b/docs/reference/api/InferenceAlibabaCloudServiceSettings.md @@ -0,0 +1,9 @@ +## Interface `InferenceAlibabaCloudServiceSettings` + +| Name | Type | Description | +| - | - | - | +| `api_key` | string | A valid API key for the AlibabaCloud AI Search API. | +| `host` | string | The name of the host address used for the inference task. You can find the host address in the API keys section of the documentation. | +| `rate_limit` | [InferenceRateLimitSetting](./InferenceRateLimitSetting.md) | This setting helps to minimize the number of rate limit errors returned from AlibabaCloud AI Search. By default, the `alibabacloud-ai-search` service sets the number of requests allowed per minute to `1000`. | +| `service_id` | string | The name of the model service to use for the inference task. The following service IDs are available for the `completion` task: * `ops-qwen-turbo` * `qwen-turbo` * `qwen-plus` * `qwen-max ÷ qwen-max-longcontext`The following service ID is available for the `rerank` task: * `ops-bge-reranker-larger`The following service ID is available for the `sparse_embedding` task: * `ops-text-sparse-embedding-001`The following service IDs are available for the `text_embedding` task: `ops-text-embedding-001` `ops-text-embedding-zh-001` `ops-text-embedding-en-001` `ops-text-embedding-002` | +| `workspace` | string | The name of the workspace used for the inference task. | diff --git a/docs/reference/api/InferenceAlibabaCloudServiceType.md b/docs/reference/api/InferenceAlibabaCloudServiceType.md new file mode 100644 index 000000000..ee2d6b65c --- /dev/null +++ b/docs/reference/api/InferenceAlibabaCloudServiceType.md @@ -0,0 +1,4 @@ +## `InferenceAlibabaCloudServiceType` +::: +type InferenceAlibabaCloudServiceType = 'alibabacloud-ai-search'; +::: diff --git a/docs/reference/api/InferenceAlibabaCloudTaskSettings.md b/docs/reference/api/InferenceAlibabaCloudTaskSettings.md new file mode 100644 index 000000000..381dd591f --- /dev/null +++ b/docs/reference/api/InferenceAlibabaCloudTaskSettings.md @@ -0,0 +1,6 @@ +## Interface `InferenceAlibabaCloudTaskSettings` + +| Name | Type | Description | +| - | - | - | +| `input_type` | string | For a `sparse_embedding` or `text_embedding` task, specify the type of input passed to the model. Valid values are: * `ingest` for storing document embeddings in a vector database. * `search` for storing embeddings of search queries run against a vector database to find relevant documents. | +| `return_token` | boolean | For a `sparse_embedding` task, it affects whether the token name will be returned in the response. It defaults to `false`, which means only the token ID will be returned in the response. | diff --git a/docs/reference/api/InferenceAlibabaCloudTaskType.md b/docs/reference/api/InferenceAlibabaCloudTaskType.md new file mode 100644 index 000000000..ec64cc24e --- /dev/null +++ b/docs/reference/api/InferenceAlibabaCloudTaskType.md @@ -0,0 +1,4 @@ +## `InferenceAlibabaCloudTaskType` +::: +type InferenceAlibabaCloudTaskType = 'completion' | 'rerank' | 'space_embedding' | 'text_embedding'; +::: diff --git a/docs/reference/api/InferenceAmazonBedrockServiceSettings.md b/docs/reference/api/InferenceAmazonBedrockServiceSettings.md new file mode 100644 index 000000000..a23bf0080 --- /dev/null +++ b/docs/reference/api/InferenceAmazonBedrockServiceSettings.md @@ -0,0 +1,10 @@ +## Interface `InferenceAmazonBedrockServiceSettings` + +| Name | Type | Description | +| - | - | - | +| `access_key` | string | A valid AWS access key that has permissions to use Amazon Bedrock and access to models for inference requests. | +| `model` | string | The base model ID or an ARN to a custom model based on a foundational model. The base model IDs can be found in the Amazon Bedrock documentation. Note that the model ID must be available for the provider chosen and your IAM user must have access to the model. | +| `provider` | string | The model provider for your deployment. Note that some providers may support only certain task types. Supported providers include: * `amazontitan` - available for `text_embedding` and `completion` task types * `anthropic` - available for `completion` task type only * `ai21labs` - available for `completion` task type only * `cohere` - available for `text_embedding` and `completion` task types * `meta` - available for `completion` task type only * `mistral` - available for `completion` task type only | +| `rate_limit` | [InferenceRateLimitSetting](./InferenceRateLimitSetting.md) | This setting helps to minimize the number of rate limit errors returned from Watsonx. By default, the `watsonxai` service sets the number of requests allowed per minute to 120. | +| `region` | string | The region that your model or ARN is deployed in. The list of available regions per model can be found in the Amazon Bedrock documentation. | +| `secret_key` | string | A valid AWS secret key that is paired with the `access_key`. For informationg about creating and managing access and secret keys, refer to the AWS documentation. | diff --git a/docs/reference/api/InferenceAmazonBedrockServiceType.md b/docs/reference/api/InferenceAmazonBedrockServiceType.md new file mode 100644 index 000000000..984eb2676 --- /dev/null +++ b/docs/reference/api/InferenceAmazonBedrockServiceType.md @@ -0,0 +1,4 @@ +## `InferenceAmazonBedrockServiceType` +::: +type InferenceAmazonBedrockServiceType = 'amazonbedrock'; +::: diff --git a/docs/reference/api/InferenceAmazonBedrockTaskSettings.md b/docs/reference/api/InferenceAmazonBedrockTaskSettings.md new file mode 100644 index 000000000..747f42bb9 --- /dev/null +++ b/docs/reference/api/InferenceAmazonBedrockTaskSettings.md @@ -0,0 +1,8 @@ +## Interface `InferenceAmazonBedrockTaskSettings` + +| Name | Type | Description | +| - | - | - | +| `max_new_tokens` | [integer](./integer.md) | For a `completion` task, it sets the maximum number for the output tokens to be generated. | +| `temperature` | [float](./float.md) | For a `completion` task, it is a number between 0.0 and 1.0 that controls the apparent creativity of the results. At temperature 0.0 the model is most deterministic, at temperature 1.0 most random. It should not be used if `top_p` or `top_k` is specified. | +| `top_k` | [float](./float.md) | For a `completion` task, it limits samples to the top-K most likely words, balancing coherence and variability. It is only available for anthropic, cohere, and mistral providers. It is an alternative to `temperature`; it should not be used if `temperature` is specified. | +| `top_p` | [float](./float.md) | For a `completion` task, it is a number in the range of 0.0 to 1.0, to eliminate low-probability tokens. Top-p uses nucleus sampling to select top tokens whose sum of likelihoods does not exceed a certain value, ensuring both variety and coherence. It is an alternative to `temperature`; it should not be used if `temperature` is specified. | diff --git a/docs/reference/api/InferenceAmazonBedrockTaskType.md b/docs/reference/api/InferenceAmazonBedrockTaskType.md new file mode 100644 index 000000000..2ef473b95 --- /dev/null +++ b/docs/reference/api/InferenceAmazonBedrockTaskType.md @@ -0,0 +1,4 @@ +## `InferenceAmazonBedrockTaskType` +::: +type InferenceAmazonBedrockTaskType = 'completion' | 'text_embedding'; +::: diff --git a/docs/reference/api/InferenceAnthropicServiceSettings.md b/docs/reference/api/InferenceAnthropicServiceSettings.md new file mode 100644 index 000000000..bcc47a020 --- /dev/null +++ b/docs/reference/api/InferenceAnthropicServiceSettings.md @@ -0,0 +1,7 @@ +## Interface `InferenceAnthropicServiceSettings` + +| Name | Type | Description | +| - | - | - | +| `api_key` | string | A valid API key for the Anthropic API. | +| `model_id` | string | The name of the model to use for the inference task. Refer to the Anthropic documentation for the list of supported models. | +| `rate_limit` | [InferenceRateLimitSetting](./InferenceRateLimitSetting.md) | This setting helps to minimize the number of rate limit errors returned from Anthropic. By default, the `anthropic` service sets the number of requests allowed per minute to 50. | diff --git a/docs/reference/api/InferenceAnthropicServiceType.md b/docs/reference/api/InferenceAnthropicServiceType.md new file mode 100644 index 000000000..8f18f511a --- /dev/null +++ b/docs/reference/api/InferenceAnthropicServiceType.md @@ -0,0 +1,4 @@ +## `InferenceAnthropicServiceType` +::: +type InferenceAnthropicServiceType = 'anthropic'; +::: diff --git a/docs/reference/api/InferenceAnthropicTaskSettings.md b/docs/reference/api/InferenceAnthropicTaskSettings.md new file mode 100644 index 000000000..a0dfc5edc --- /dev/null +++ b/docs/reference/api/InferenceAnthropicTaskSettings.md @@ -0,0 +1,8 @@ +## Interface `InferenceAnthropicTaskSettings` + +| Name | Type | Description | +| - | - | - | +| `max_tokens` | [integer](./integer.md) | For a `completion` task, it is the maximum number of tokens to generate before stopping. | +| `temperature` | [float](./float.md) | For a `completion` task, it is the amount of randomness injected into the response. For more details about the supported range, refer to Anthropic documentation. | +| `top_k` | [integer](./integer.md) | For a `completion` task, it specifies to only sample from the top K options for each subsequent token. It is recommended for advanced use cases only. You usually only need to use `temperature`. | +| `top_p` | [float](./float.md) | For a `completion` task, it specifies to use Anthropic's nucleus sampling. In nucleus sampling, Anthropic computes the cumulative distribution over all the options for each subsequent token in decreasing probability order and cuts it off once it reaches the specified probability. You should either alter `temperature` or `top_p`, but not both. It is recommended for advanced use cases only. You usually only need to use `temperature`. | diff --git a/docs/reference/api/InferenceAnthropicTaskType.md b/docs/reference/api/InferenceAnthropicTaskType.md new file mode 100644 index 000000000..28157ae85 --- /dev/null +++ b/docs/reference/api/InferenceAnthropicTaskType.md @@ -0,0 +1,4 @@ +## `InferenceAnthropicTaskType` +::: +type InferenceAnthropicTaskType = 'completion'; +::: diff --git a/docs/reference/api/InferenceAzureAiStudioServiceSettings.md b/docs/reference/api/InferenceAzureAiStudioServiceSettings.md new file mode 100644 index 000000000..6a0eacdc8 --- /dev/null +++ b/docs/reference/api/InferenceAzureAiStudioServiceSettings.md @@ -0,0 +1,9 @@ +## Interface `InferenceAzureAiStudioServiceSettings` + +| Name | Type | Description | +| - | - | - | +| `api_key` | string | A valid API key of your Azure AI Studio model deployment. This key can be found on the overview page for your deployment in the management section of your Azure AI Studio account. IMPORTANT: You need to provide the API key only once, during the inference model creation. The get inference endpoint API does not retrieve your API key. After creating the inference model, you cannot change the associated API key. If you want to use a different API key, delete the inference model and recreate it with the same name and the updated API key. | +| `endpoint_type` | string | The type of endpoint that is available for deployment through Azure AI Studio: `token` or `realtime`. The `token` endpoint type is for "pay as you go" endpoints that are billed per token. The `realtime` endpoint type is for "real-time" endpoints that are billed per hour of usage. | +| `provider` | string | The model provider for your deployment. Note that some providers may support only certain task types. Supported providers include: * `cohere` - available for `text_embedding` and `completion` task types * `databricks` - available for `completion` task type only * `meta` - available for `completion` task type only * `microsoft_phi` - available for `completion` task type only * `mistral` - available for `completion` task type only * `openai` - available for `text_embedding` and `completion` task types | +| `rate_limit` | [InferenceRateLimitSetting](./InferenceRateLimitSetting.md) | This setting helps to minimize the number of rate limit errors returned from Azure AI Studio. By default, the `azureaistudio` service sets the number of requests allowed per minute to 240. | +| `target` | string | The target URL of your Azure AI Studio model deployment. This can be found on the overview page for your deployment in the management section of your Azure AI Studio account. | diff --git a/docs/reference/api/InferenceAzureAiStudioServiceType.md b/docs/reference/api/InferenceAzureAiStudioServiceType.md new file mode 100644 index 000000000..87b42a4c0 --- /dev/null +++ b/docs/reference/api/InferenceAzureAiStudioServiceType.md @@ -0,0 +1,4 @@ +## `InferenceAzureAiStudioServiceType` +::: +type InferenceAzureAiStudioServiceType = 'azureaistudio'; +::: diff --git a/docs/reference/api/InferenceAzureAiStudioTaskSettings.md b/docs/reference/api/InferenceAzureAiStudioTaskSettings.md new file mode 100644 index 000000000..122c07008 --- /dev/null +++ b/docs/reference/api/InferenceAzureAiStudioTaskSettings.md @@ -0,0 +1,9 @@ +## Interface `InferenceAzureAiStudioTaskSettings` + +| Name | Type | Description | +| - | - | - | +| `do_sample` | [float](./float.md) | For a `completion` task, instruct the inference process to perform sampling. It has no effect unless `temperature` or `top_p` is specified. | +| `max_new_tokens` | [integer](./integer.md) | For a `completion` task, provide a hint for the maximum number of output tokens to be generated. | +| `temperature` | [float](./float.md) | For a `completion` task, control the apparent creativity of generated completions with a sampling temperature. It must be a number in the range of 0.0 to 2.0. It should not be used if `top_p` is specified. | +| `top_p` | [float](./float.md) | For a `completion` task, make the model consider the results of the tokens with nucleus sampling probability. It is an alternative value to `temperature` and must be a number in the range of 0.0 to 2.0. It should not be used if `temperature` is specified. | +| `user` | string | For a `text_embedding` task, specify the user issuing the request. This information can be used for abuse detection. | diff --git a/docs/reference/api/InferenceAzureAiStudioTaskType.md b/docs/reference/api/InferenceAzureAiStudioTaskType.md new file mode 100644 index 000000000..70f861efd --- /dev/null +++ b/docs/reference/api/InferenceAzureAiStudioTaskType.md @@ -0,0 +1,4 @@ +## `InferenceAzureAiStudioTaskType` +::: +type InferenceAzureAiStudioTaskType = 'completion' | 'text_embedding'; +::: diff --git a/docs/reference/api/InferenceAzureOpenAIServiceSettings.md b/docs/reference/api/InferenceAzureOpenAIServiceSettings.md new file mode 100644 index 000000000..f83aab7ae --- /dev/null +++ b/docs/reference/api/InferenceAzureOpenAIServiceSettings.md @@ -0,0 +1,10 @@ +## Interface `InferenceAzureOpenAIServiceSettings` + +| Name | Type | Description | +| - | - | - | +| `api_key` | string | A valid API key for your Azure OpenAI account. You must specify either `api_key` or `entra_id`. If you do not provide either or you provide both, you will receive an error when you try to create your model. IMPORTANT: You need to provide the API key only once, during the inference model creation. The get inference endpoint API does not retrieve your API key. After creating the inference model, you cannot change the associated API key. If you want to use a different API key, delete the inference model and recreate it with the same name and the updated API key. | +| `api_version` | string | The Azure API version ID to use. It is recommended to use the latest supported non-preview version. | +| `deployment_id` | string | The deployment name of your deployed models. Your Azure OpenAI deployments can be found though the Azure OpenAI Studio portal that is linked to your subscription. | +| `entra_id` | string | A valid Microsoft Entra token. You must specify either `api_key` or `entra_id`. If you do not provide either or you provide both, you will receive an error when you try to create your model. | +| `rate_limit` | [InferenceRateLimitSetting](./InferenceRateLimitSetting.md) | This setting helps to minimize the number of rate limit errors returned from Azure. The `azureopenai` service sets a default number of requests allowed per minute depending on the task type. For `text_embedding`, it is set to `1440`. For `completion`, it is set to `120`. | +| `resource_name` | string | The name of your Azure OpenAI resource. You can find this from the list of resources in the Azure Portal for your subscription. | diff --git a/docs/reference/api/InferenceAzureOpenAIServiceType.md b/docs/reference/api/InferenceAzureOpenAIServiceType.md new file mode 100644 index 000000000..fb98514a0 --- /dev/null +++ b/docs/reference/api/InferenceAzureOpenAIServiceType.md @@ -0,0 +1,4 @@ +## `InferenceAzureOpenAIServiceType` +::: +type InferenceAzureOpenAIServiceType = 'azureopenai'; +::: diff --git a/docs/reference/api/InferenceAzureOpenAITaskSettings.md b/docs/reference/api/InferenceAzureOpenAITaskSettings.md new file mode 100644 index 000000000..f7ff032a7 --- /dev/null +++ b/docs/reference/api/InferenceAzureOpenAITaskSettings.md @@ -0,0 +1,5 @@ +## Interface `InferenceAzureOpenAITaskSettings` + +| Name | Type | Description | +| - | - | - | +| `user` | string | For a `completion` or `text_embedding` task, specify the user issuing the request. This information can be used for abuse detection. | diff --git a/docs/reference/api/InferenceAzureOpenAITaskType.md b/docs/reference/api/InferenceAzureOpenAITaskType.md new file mode 100644 index 000000000..2728e70eb --- /dev/null +++ b/docs/reference/api/InferenceAzureOpenAITaskType.md @@ -0,0 +1,4 @@ +## `InferenceAzureOpenAITaskType` +::: +type InferenceAzureOpenAITaskType = 'completion' | 'text_embedding'; +::: diff --git a/docs/reference/api/InferenceChatCompletionUnifiedRequest.md b/docs/reference/api/InferenceChatCompletionUnifiedRequest.md new file mode 100644 index 000000000..cca6a8377 --- /dev/null +++ b/docs/reference/api/InferenceChatCompletionUnifiedRequest.md @@ -0,0 +1,9 @@ +## Interface `InferenceChatCompletionUnifiedRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { inference_id?: never; timeout?: never; chat_completion_request?: never; }) | All values in `body` will be added to the request body. | +| `chat_completion_request` | [InferenceRequestChatCompletion](./InferenceRequestChatCompletion.md) |   | +| `inference_id` | [Id](./Id.md) | The inference Id | +| `querystring` | { [key: string]: any; } & { inference_id?: never; timeout?: never; chat_completion_request?: never; } | All values in `querystring` will be added to the request querystring. | +| `timeout` | [Duration](./Duration.md) | Specifies the amount of time to wait for the inference request to complete. | diff --git a/docs/reference/api/InferenceChatCompletionUnifiedResponse.md b/docs/reference/api/InferenceChatCompletionUnifiedResponse.md new file mode 100644 index 000000000..e681780a5 --- /dev/null +++ b/docs/reference/api/InferenceChatCompletionUnifiedResponse.md @@ -0,0 +1,4 @@ +## `InferenceChatCompletionUnifiedResponse` +::: +type InferenceChatCompletionUnifiedResponse = [StreamResult](./StreamResult.md); +::: diff --git a/docs/reference/api/InferenceCohereEmbeddingType.md b/docs/reference/api/InferenceCohereEmbeddingType.md new file mode 100644 index 000000000..542210af6 --- /dev/null +++ b/docs/reference/api/InferenceCohereEmbeddingType.md @@ -0,0 +1,4 @@ +## `InferenceCohereEmbeddingType` +::: +type InferenceCohereEmbeddingType = 'byte' | 'float' | 'int8'; +::: diff --git a/docs/reference/api/InferenceCohereInputType.md b/docs/reference/api/InferenceCohereInputType.md new file mode 100644 index 000000000..af0fecf50 --- /dev/null +++ b/docs/reference/api/InferenceCohereInputType.md @@ -0,0 +1,4 @@ +## `InferenceCohereInputType` +::: +type InferenceCohereInputType = 'classification' | 'clustering' | 'ingest' | 'search'; +::: diff --git a/docs/reference/api/InferenceCohereServiceSettings.md b/docs/reference/api/InferenceCohereServiceSettings.md new file mode 100644 index 000000000..16616052d --- /dev/null +++ b/docs/reference/api/InferenceCohereServiceSettings.md @@ -0,0 +1,9 @@ +## Interface `InferenceCohereServiceSettings` + +| Name | Type | Description | +| - | - | - | +| `api_key` | string | A valid API key for your Cohere account. You can find or create your Cohere API keys on the Cohere API key settings page. IMPORTANT: You need to provide the API key only once, during the inference model creation. The get inference endpoint API does not retrieve your API key. After creating the inference model, you cannot change the associated API key. If you want to use a different API key, delete the inference model and recreate it with the same name and the updated API key. | +| `embedding_type` | [InferenceCohereEmbeddingType](./InferenceCohereEmbeddingType.md) | For a `text_embedding` task, the types of embeddings you want to get back. Use `byte` for signed int8 embeddings (this is a synonym of `int8`). Use `float` for the default float embeddings. Use `int8` for signed int8 embeddings. | +| `model_id` | string | For a `completion`, `rerank`, or `text_embedding` task, the name of the model to use for the inference task. * For the available `completion` models, refer to the [Cohere command docs](https://docs.cohere.com/docs/models#command). * For the available `rerank` models, refer to the [Cohere rerank docs](https://docs.cohere.com/reference/rerank-1). * For the available `text_embedding` models, refer to [Cohere embed docs](https://docs.cohere.com/reference/embed). The default value for a text embedding task is `embed-english-v2.0`. | +| `rate_limit` | [InferenceRateLimitSetting](./InferenceRateLimitSetting.md) | This setting helps to minimize the number of rate limit errors returned from Cohere. By default, the `cohere` service sets the number of requests allowed per minute to 10000. | +| `similarity` | [InferenceCohereSimilarityType](./InferenceCohereSimilarityType.md) | The similarity measure. If the `embedding_type` is `float`, the default value is `dot_product`. If the `embedding_type` is `int8` or `byte`, the default value is `cosine`. | diff --git a/docs/reference/api/InferenceCohereServiceType.md b/docs/reference/api/InferenceCohereServiceType.md new file mode 100644 index 000000000..07f99bb9f --- /dev/null +++ b/docs/reference/api/InferenceCohereServiceType.md @@ -0,0 +1,4 @@ +## `InferenceCohereServiceType` +::: +type InferenceCohereServiceType = 'cohere'; +::: diff --git a/docs/reference/api/InferenceCohereSimilarityType.md b/docs/reference/api/InferenceCohereSimilarityType.md new file mode 100644 index 000000000..98f877c03 --- /dev/null +++ b/docs/reference/api/InferenceCohereSimilarityType.md @@ -0,0 +1,4 @@ +## `InferenceCohereSimilarityType` +::: +type InferenceCohereSimilarityType = 'cosine' | 'dot_product' | 'l2_norm'; +::: diff --git a/docs/reference/api/InferenceCohereTaskSettings.md b/docs/reference/api/InferenceCohereTaskSettings.md new file mode 100644 index 000000000..b06237645 --- /dev/null +++ b/docs/reference/api/InferenceCohereTaskSettings.md @@ -0,0 +1,8 @@ +## Interface `InferenceCohereTaskSettings` + +| Name | Type | Description | +| - | - | - | +| `input_type` | [InferenceCohereInputType](./InferenceCohereInputType.md) | For a `text_embedding` task, the type of input passed to the model. Valid values are: * `classification`: Use it for embeddings passed through a text classifier. * `clustering`: Use it for the embeddings run through a clustering algorithm. * `ingest`: Use it for storing document embeddings in a vector database. * `search`: Use it for storing embeddings of search queries run against a vector database to find relevant documents. IMPORTANT: The `input_type` field is required when using embedding models `v3` and higher. | +| `return_documents` | boolean | For a `rerank` task, return doc text within the results. | +| `top_n` | [integer](./integer.md) | For a `rerank` task, the number of most relevant documents to return. It defaults to the number of the documents. If this inference endpoint is used in a `text_similarity_reranker` retriever query and `top_n` is set, it must be greater than or equal to `rank_window_size` in the query. | +| `truncate` | [InferenceCohereTruncateType](./InferenceCohereTruncateType.md) | For a `text_embedding` task, the method to handle inputs longer than the maximum token length. Valid values are: * `END`: When the input exceeds the maximum input token length, the end of the input is discarded. * `NONE`: When the input exceeds the maximum input token length, an error is returned. * `START`: When the input exceeds the maximum input token length, the start of the input is discarded. | diff --git a/docs/reference/api/InferenceCohereTaskType.md b/docs/reference/api/InferenceCohereTaskType.md new file mode 100644 index 000000000..7c176077d --- /dev/null +++ b/docs/reference/api/InferenceCohereTaskType.md @@ -0,0 +1,4 @@ +## `InferenceCohereTaskType` +::: +type InferenceCohereTaskType = 'completion' | 'rerank' | 'text_embedding'; +::: diff --git a/docs/reference/api/InferenceCohereTruncateType.md b/docs/reference/api/InferenceCohereTruncateType.md new file mode 100644 index 000000000..e3d22e39a --- /dev/null +++ b/docs/reference/api/InferenceCohereTruncateType.md @@ -0,0 +1,4 @@ +## `InferenceCohereTruncateType` +::: +type InferenceCohereTruncateType = 'END' | 'NONE' | 'START'; +::: diff --git a/docs/reference/api/InferenceCompletionInferenceResult.md b/docs/reference/api/InferenceCompletionInferenceResult.md new file mode 100644 index 000000000..013b3d674 --- /dev/null +++ b/docs/reference/api/InferenceCompletionInferenceResult.md @@ -0,0 +1,5 @@ +## Interface `InferenceCompletionInferenceResult` + +| Name | Type | Description | +| - | - | - | +| `completion` | [InferenceCompletionResult](./InferenceCompletionResult.md)[] |   | diff --git a/docs/reference/api/InferenceCompletionRequest.md b/docs/reference/api/InferenceCompletionRequest.md new file mode 100644 index 000000000..e7e2c0693 --- /dev/null +++ b/docs/reference/api/InferenceCompletionRequest.md @@ -0,0 +1,10 @@ +## Interface `InferenceCompletionRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { inference_id?: never; timeout?: never; input?: never; task_settings?: never; }) | All values in `body` will be added to the request body. | +| `inference_id` | [Id](./Id.md) | The inference Id | +| `input` | string | string[] | Inference input. Either a string or an array of strings. | +| `querystring` | { [key: string]: any; } & { inference_id?: never; timeout?: never; input?: never; task_settings?: never; } | All values in `querystring` will be added to the request querystring. | +| `task_settings` | [InferenceTaskSettings](./InferenceTaskSettings.md) | Optional task settings | +| `timeout` | [Duration](./Duration.md) | Specifies the amount of time to wait for the inference request to complete. | diff --git a/docs/reference/api/InferenceCompletionResponse.md b/docs/reference/api/InferenceCompletionResponse.md new file mode 100644 index 000000000..bce396617 --- /dev/null +++ b/docs/reference/api/InferenceCompletionResponse.md @@ -0,0 +1,4 @@ +## `InferenceCompletionResponse` +::: +type InferenceCompletionResponse = [InferenceCompletionInferenceResult](./InferenceCompletionInferenceResult.md); +::: diff --git a/docs/reference/api/InferenceCompletionResult.md b/docs/reference/api/InferenceCompletionResult.md new file mode 100644 index 000000000..decb733c9 --- /dev/null +++ b/docs/reference/api/InferenceCompletionResult.md @@ -0,0 +1,5 @@ +## Interface `InferenceCompletionResult` + +| Name | Type | Description | +| - | - | - | +| `result` | string |   | diff --git a/docs/reference/api/InferenceCompletionTool.md b/docs/reference/api/InferenceCompletionTool.md new file mode 100644 index 000000000..11ae92873 --- /dev/null +++ b/docs/reference/api/InferenceCompletionTool.md @@ -0,0 +1,6 @@ +## Interface `InferenceCompletionTool` + +| Name | Type | Description | +| - | - | - | +| `function` | [InferenceCompletionToolFunction](./InferenceCompletionToolFunction.md) | The function definition. | +| `type` | string | The type of tool. | diff --git a/docs/reference/api/InferenceCompletionToolChoice.md b/docs/reference/api/InferenceCompletionToolChoice.md new file mode 100644 index 000000000..ac036bf94 --- /dev/null +++ b/docs/reference/api/InferenceCompletionToolChoice.md @@ -0,0 +1,6 @@ +## Interface `InferenceCompletionToolChoice` + +| Name | Type | Description | +| - | - | - | +| `function` | [InferenceCompletionToolChoiceFunction](./InferenceCompletionToolChoiceFunction.md) | The tool choice function. | +| `type` | string | The type of the tool. | diff --git a/docs/reference/api/InferenceCompletionToolChoiceFunction.md b/docs/reference/api/InferenceCompletionToolChoiceFunction.md new file mode 100644 index 000000000..1ba04445d --- /dev/null +++ b/docs/reference/api/InferenceCompletionToolChoiceFunction.md @@ -0,0 +1,5 @@ +## Interface `InferenceCompletionToolChoiceFunction` + +| Name | Type | Description | +| - | - | - | +| `name` | string | The name of the function to call. | diff --git a/docs/reference/api/InferenceCompletionToolFunction.md b/docs/reference/api/InferenceCompletionToolFunction.md new file mode 100644 index 000000000..9a1a013bc --- /dev/null +++ b/docs/reference/api/InferenceCompletionToolFunction.md @@ -0,0 +1,8 @@ +## Interface `InferenceCompletionToolFunction` + +| Name | Type | Description | +| - | - | - | +| `description` | string | A description of what the function does. This is used by the model to choose when and how to call the function. | +| `name` | string | The name of the function. | +| `parameters` | any | The parameters the functional accepts. This should be formatted as a JSON object. | +| `strict` | boolean | Whether to enable schema adherence when generating the function call. | diff --git a/docs/reference/api/InferenceCompletionToolType.md b/docs/reference/api/InferenceCompletionToolType.md new file mode 100644 index 000000000..e80c3ae48 --- /dev/null +++ b/docs/reference/api/InferenceCompletionToolType.md @@ -0,0 +1,4 @@ +## `InferenceCompletionToolType` +::: +type InferenceCompletionToolType = string | [InferenceCompletionToolChoice](./InferenceCompletionToolChoice.md); +::: diff --git a/docs/reference/api/InferenceContentObject.md b/docs/reference/api/InferenceContentObject.md new file mode 100644 index 000000000..03f7135b5 --- /dev/null +++ b/docs/reference/api/InferenceContentObject.md @@ -0,0 +1,6 @@ +## Interface `InferenceContentObject` + +| Name | Type | Description | +| - | - | - | +| `text` | string | The text content. | +| `type` | string | The type of content. | diff --git a/docs/reference/api/InferenceDeleteInferenceEndpointResult.md b/docs/reference/api/InferenceDeleteInferenceEndpointResult.md new file mode 100644 index 000000000..706a8a9de --- /dev/null +++ b/docs/reference/api/InferenceDeleteInferenceEndpointResult.md @@ -0,0 +1,5 @@ +## Interface `InferenceDeleteInferenceEndpointResult` + +| Name | Type | Description | +| - | - | - | +| `pipelines` | string[] |   | diff --git a/docs/reference/api/InferenceDeleteRequest.md b/docs/reference/api/InferenceDeleteRequest.md new file mode 100644 index 000000000..2896a1e97 --- /dev/null +++ b/docs/reference/api/InferenceDeleteRequest.md @@ -0,0 +1,10 @@ +## Interface `InferenceDeleteRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { task_type?: never; inference_id?: never; dry_run?: never; force?: never; }) | All values in `body` will be added to the request body. | +| `dry_run` | boolean | When true, the endpoint is not deleted and a list of ingest processors which reference this endpoint is returned. | +| `force` | boolean | When true, the inference endpoint is forcefully deleted even if it is still being used by ingest processors or semantic text fields. | +| `inference_id` | [Id](./Id.md) | The inference identifier. | +| `querystring` | { [key: string]: any; } & { task_type?: never; inference_id?: never; dry_run?: never; force?: never; } | All values in `querystring` will be added to the request querystring. | +| `task_type` | [InferenceTaskType](./InferenceTaskType.md) | The task type | diff --git a/docs/reference/api/InferenceDeleteResponse.md b/docs/reference/api/InferenceDeleteResponse.md new file mode 100644 index 000000000..d6ce69dd4 --- /dev/null +++ b/docs/reference/api/InferenceDeleteResponse.md @@ -0,0 +1,4 @@ +## `InferenceDeleteResponse` +::: +type InferenceDeleteResponse = [InferenceDeleteInferenceEndpointResult](./InferenceDeleteInferenceEndpointResult.md); +::: diff --git a/docs/reference/api/InferenceDenseByteVector.md b/docs/reference/api/InferenceDenseByteVector.md new file mode 100644 index 000000000..6c484daa6 --- /dev/null +++ b/docs/reference/api/InferenceDenseByteVector.md @@ -0,0 +1,4 @@ +## `InferenceDenseByteVector` +::: +type InferenceDenseByteVector = [byte](./byte.md)[]; +::: diff --git a/docs/reference/api/InferenceDenseVector.md b/docs/reference/api/InferenceDenseVector.md new file mode 100644 index 000000000..ab0399d29 --- /dev/null +++ b/docs/reference/api/InferenceDenseVector.md @@ -0,0 +1,4 @@ +## `InferenceDenseVector` +::: +type InferenceDenseVector = [float](./float.md)[]; +::: diff --git a/docs/reference/api/InferenceElasticsearchServiceSettings.md b/docs/reference/api/InferenceElasticsearchServiceSettings.md new file mode 100644 index 000000000..272de8c37 --- /dev/null +++ b/docs/reference/api/InferenceElasticsearchServiceSettings.md @@ -0,0 +1,9 @@ +## Interface `InferenceElasticsearchServiceSettings` + +| Name | Type | Description | +| - | - | - | +| `adaptive_allocations` | [InferenceAdaptiveAllocations](./InferenceAdaptiveAllocations.md) | Adaptive allocations configuration details. If `enabled` is true, the number of allocations of the model is set based on the current load the process gets. When the load is high, a new model allocation is automatically created, respecting the value of `max_number_of_allocations` if it's set. When the load is low, a model allocation is automatically removed, respecting the value of `min_number_of_allocations` if it's set. If `enabled` is true, do not set the number of allocations manually. | +| `deployment_id` | string | The deployment identifier for a trained model deployment. When `deployment_id` is used the `model_id` is optional. | +| `model_id` | string | The name of the model to use for the inference task. It can be the ID of a built-in model (for example, `.multilingual-e5-small` for E5) or a text embedding model that was uploaded by using the Eland client. | +| `num_allocations` | [integer](./integer.md) | The total number of allocations that are assigned to the model across machine learning nodes. Increasing this value generally increases the throughput. If adaptive allocations are enabled, do not set this value because it's automatically set. | +| `num_threads` | [integer](./integer.md) | The number of threads used by each model allocation during inference. This setting generally increases the speed per inference request. The inference process is a compute-bound process; `threads_per_allocations` must not exceed the number of available allocated processors per node. The value must be a power of 2. The maximum value is 32. | diff --git a/docs/reference/api/InferenceElasticsearchServiceType.md b/docs/reference/api/InferenceElasticsearchServiceType.md new file mode 100644 index 000000000..700512cab --- /dev/null +++ b/docs/reference/api/InferenceElasticsearchServiceType.md @@ -0,0 +1,4 @@ +## `InferenceElasticsearchServiceType` +::: +type InferenceElasticsearchServiceType = 'elasticsearch'; +::: diff --git a/docs/reference/api/InferenceElasticsearchTaskSettings.md b/docs/reference/api/InferenceElasticsearchTaskSettings.md new file mode 100644 index 000000000..4d8978050 --- /dev/null +++ b/docs/reference/api/InferenceElasticsearchTaskSettings.md @@ -0,0 +1,5 @@ +## Interface `InferenceElasticsearchTaskSettings` + +| Name | Type | Description | +| - | - | - | +| `return_documents` | boolean | For a `rerank` task, return the document instead of only the index. | diff --git a/docs/reference/api/InferenceElasticsearchTaskType.md b/docs/reference/api/InferenceElasticsearchTaskType.md new file mode 100644 index 000000000..9b1d58e71 --- /dev/null +++ b/docs/reference/api/InferenceElasticsearchTaskType.md @@ -0,0 +1,4 @@ +## `InferenceElasticsearchTaskType` +::: +type InferenceElasticsearchTaskType = 'rerank' | 'sparse_embedding' | 'text_embedding'; +::: diff --git a/docs/reference/api/InferenceElserServiceSettings.md b/docs/reference/api/InferenceElserServiceSettings.md new file mode 100644 index 000000000..aff203ad5 --- /dev/null +++ b/docs/reference/api/InferenceElserServiceSettings.md @@ -0,0 +1,7 @@ +## Interface `InferenceElserServiceSettings` + +| Name | Type | Description | +| - | - | - | +| `adaptive_allocations` | [InferenceAdaptiveAllocations](./InferenceAdaptiveAllocations.md) | Adaptive allocations configuration details. If `enabled` is true, the number of allocations of the model is set based on the current load the process gets. When the load is high, a new model allocation is automatically created, respecting the value of `max_number_of_allocations` if it's set. When the load is low, a model allocation is automatically removed, respecting the value of `min_number_of_allocations` if it's set. If `enabled` is true, do not set the number of allocations manually. | +| `num_allocations` | [integer](./integer.md) | The total number of allocations this model is assigned across machine learning nodes. Increasing this value generally increases the throughput. If adaptive allocations is enabled, do not set this value because it's automatically set. | +| `num_threads` | [integer](./integer.md) | The number of threads used by each model allocation during inference. Increasing this value generally increases the speed per inference request. The inference process is a compute-bound process; `threads_per_allocations` must not exceed the number of available allocated processors per node. The value must be a power of 2. The maximum value is 32. > info > If you want to optimize your ELSER endpoint for ingest, set the number of threads to 1. If you want to optimize your ELSER endpoint for search, set the number of threads to greater than 1. | diff --git a/docs/reference/api/InferenceElserServiceType.md b/docs/reference/api/InferenceElserServiceType.md new file mode 100644 index 000000000..20cb23d87 --- /dev/null +++ b/docs/reference/api/InferenceElserServiceType.md @@ -0,0 +1,4 @@ +## `InferenceElserServiceType` +::: +type InferenceElserServiceType = 'elser'; +::: diff --git a/docs/reference/api/InferenceElserTaskType.md b/docs/reference/api/InferenceElserTaskType.md new file mode 100644 index 000000000..91bac1f59 --- /dev/null +++ b/docs/reference/api/InferenceElserTaskType.md @@ -0,0 +1,4 @@ +## `InferenceElserTaskType` +::: +type InferenceElserTaskType = 'sparse_embedding'; +::: diff --git a/docs/reference/api/InferenceGetRequest.md b/docs/reference/api/InferenceGetRequest.md new file mode 100644 index 000000000..13dd87683 --- /dev/null +++ b/docs/reference/api/InferenceGetRequest.md @@ -0,0 +1,8 @@ +## Interface `InferenceGetRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { task_type?: never; inference_id?: never; }) | All values in `body` will be added to the request body. | +| `inference_id` | [Id](./Id.md) | The inference Id | +| `querystring` | { [key: string]: any; } & { task_type?: never; inference_id?: never; } | All values in `querystring` will be added to the request querystring. | +| `task_type` | [InferenceTaskType](./InferenceTaskType.md) | The task type | diff --git a/docs/reference/api/InferenceGetResponse.md b/docs/reference/api/InferenceGetResponse.md new file mode 100644 index 000000000..69305b7ed --- /dev/null +++ b/docs/reference/api/InferenceGetResponse.md @@ -0,0 +1,5 @@ +## Interface `InferenceGetResponse` + +| Name | Type | Description | +| - | - | - | +| `endpoints` | [InferenceInferenceEndpointInfo](./InferenceInferenceEndpointInfo.md)[] |   | diff --git a/docs/reference/api/InferenceGoogleAiServiceType.md b/docs/reference/api/InferenceGoogleAiServiceType.md new file mode 100644 index 000000000..44967278d --- /dev/null +++ b/docs/reference/api/InferenceGoogleAiServiceType.md @@ -0,0 +1,4 @@ +## `InferenceGoogleAiServiceType` +::: +type InferenceGoogleAiServiceType = 'googleaistudio'; +::: diff --git a/docs/reference/api/InferenceGoogleAiStudioServiceSettings.md b/docs/reference/api/InferenceGoogleAiStudioServiceSettings.md new file mode 100644 index 000000000..9669af95e --- /dev/null +++ b/docs/reference/api/InferenceGoogleAiStudioServiceSettings.md @@ -0,0 +1,7 @@ +## Interface `InferenceGoogleAiStudioServiceSettings` + +| Name | Type | Description | +| - | - | - | +| `api_key` | string | A valid API key of your Google Gemini account. | +| `model_id` | string | The name of the model to use for the inference task. Refer to the Google documentation for the list of supported models. | +| `rate_limit` | [InferenceRateLimitSetting](./InferenceRateLimitSetting.md) | This setting helps to minimize the number of rate limit errors returned from Google AI Studio. By default, the `googleaistudio` service sets the number of requests allowed per minute to 360. | diff --git a/docs/reference/api/InferenceGoogleAiStudioTaskType.md b/docs/reference/api/InferenceGoogleAiStudioTaskType.md new file mode 100644 index 000000000..20242502c --- /dev/null +++ b/docs/reference/api/InferenceGoogleAiStudioTaskType.md @@ -0,0 +1,4 @@ +## `InferenceGoogleAiStudioTaskType` +::: +type InferenceGoogleAiStudioTaskType = 'completion' | 'text_embedding'; +::: diff --git a/docs/reference/api/InferenceGoogleVertexAIServiceSettings.md b/docs/reference/api/InferenceGoogleVertexAIServiceSettings.md new file mode 100644 index 000000000..e2caaf9c0 --- /dev/null +++ b/docs/reference/api/InferenceGoogleVertexAIServiceSettings.md @@ -0,0 +1,9 @@ +## Interface `InferenceGoogleVertexAIServiceSettings` + +| Name | Type | Description | +| - | - | - | +| `location` | string | The name of the location to use for the inference task. Refer to the Google documentation for the list of supported locations. | +| `model_id` | string | The name of the model to use for the inference task. Refer to the Google documentation for the list of supported models. | +| `project_id` | string | The name of the project to use for the inference task. | +| `rate_limit` | [InferenceRateLimitSetting](./InferenceRateLimitSetting.md) | This setting helps to minimize the number of rate limit errors returned from Google Vertex AI. By default, the `googlevertexai` service sets the number of requests allowed per minute to 30.000. | +| `service_account_json` | string | A valid service account in JSON format for the Google Vertex AI API. | diff --git a/docs/reference/api/InferenceGoogleVertexAIServiceType.md b/docs/reference/api/InferenceGoogleVertexAIServiceType.md new file mode 100644 index 000000000..d77710a5c --- /dev/null +++ b/docs/reference/api/InferenceGoogleVertexAIServiceType.md @@ -0,0 +1,4 @@ +## `InferenceGoogleVertexAIServiceType` +::: +type InferenceGoogleVertexAIServiceType = 'googlevertexai'; +::: diff --git a/docs/reference/api/InferenceGoogleVertexAITaskSettings.md b/docs/reference/api/InferenceGoogleVertexAITaskSettings.md new file mode 100644 index 000000000..7a6ebed40 --- /dev/null +++ b/docs/reference/api/InferenceGoogleVertexAITaskSettings.md @@ -0,0 +1,6 @@ +## Interface `InferenceGoogleVertexAITaskSettings` + +| Name | Type | Description | +| - | - | - | +| `auto_truncate` | boolean | For a `text_embedding` task, truncate inputs longer than the maximum token length automatically. | +| `top_n` | [integer](./integer.md) | For a `rerank` task, the number of the top N documents that should be returned. | diff --git a/docs/reference/api/InferenceGoogleVertexAITaskType.md b/docs/reference/api/InferenceGoogleVertexAITaskType.md new file mode 100644 index 000000000..9a2f75b74 --- /dev/null +++ b/docs/reference/api/InferenceGoogleVertexAITaskType.md @@ -0,0 +1,4 @@ +## `InferenceGoogleVertexAITaskType` +::: +type InferenceGoogleVertexAITaskType = 'rerank' | 'text_embedding'; +::: diff --git a/docs/reference/api/InferenceHuggingFaceServiceSettings.md b/docs/reference/api/InferenceHuggingFaceServiceSettings.md new file mode 100644 index 000000000..838c6a2b6 --- /dev/null +++ b/docs/reference/api/InferenceHuggingFaceServiceSettings.md @@ -0,0 +1,7 @@ +## Interface `InferenceHuggingFaceServiceSettings` + +| Name | Type | Description | +| - | - | - | +| `api_key` | string | A valid access token for your HuggingFace account. You can create or find your access tokens on the HuggingFace settings page. IMPORTANT: You need to provide the API key only once, during the inference model creation. The get inference endpoint API does not retrieve your API key. After creating the inference model, you cannot change the associated API key. If you want to use a different API key, delete the inference model and recreate it with the same name and the updated API key. | +| `rate_limit` | [InferenceRateLimitSetting](./InferenceRateLimitSetting.md) | This setting helps to minimize the number of rate limit errors returned from Hugging Face. By default, the `hugging_face` service sets the number of requests allowed per minute to 3000. | +| `url` | string | The URL endpoint to use for the requests. | diff --git a/docs/reference/api/InferenceHuggingFaceServiceType.md b/docs/reference/api/InferenceHuggingFaceServiceType.md new file mode 100644 index 000000000..3da5a3fab --- /dev/null +++ b/docs/reference/api/InferenceHuggingFaceServiceType.md @@ -0,0 +1,4 @@ +## `InferenceHuggingFaceServiceType` +::: +type InferenceHuggingFaceServiceType = 'hugging_face'; +::: diff --git a/docs/reference/api/InferenceHuggingFaceTaskType.md b/docs/reference/api/InferenceHuggingFaceTaskType.md new file mode 100644 index 000000000..06d3add0f --- /dev/null +++ b/docs/reference/api/InferenceHuggingFaceTaskType.md @@ -0,0 +1,4 @@ +## `InferenceHuggingFaceTaskType` +::: +type InferenceHuggingFaceTaskType = 'text_embedding'; +::: diff --git a/docs/reference/api/InferenceInferenceChunkingSettings.md b/docs/reference/api/InferenceInferenceChunkingSettings.md new file mode 100644 index 000000000..55223f5ce --- /dev/null +++ b/docs/reference/api/InferenceInferenceChunkingSettings.md @@ -0,0 +1,8 @@ +## Interface `InferenceInferenceChunkingSettings` + +| Name | Type | Description | +| - | - | - | +| `max_chunk_size` | [integer](./integer.md) | The maximum size of a chunk in words. This value cannot be higher than `300` or lower than `20` (for `sentence` strategy) or `10` (for `word` strategy). | +| `overlap` | [integer](./integer.md) | The number of overlapping words for chunks. It is applicable only to a `word` chunking strategy. This value cannot be higher than half the `max_chunk_size` value. | +| `sentence_overlap` | [integer](./integer.md) | The number of overlapping sentences for chunks. It is applicable only for a `sentence` chunking strategy. It can be either `1` or `0`. | +| `strategy` | string | The chunking strategy: `sentence` or `word`. | diff --git a/docs/reference/api/InferenceInferenceEndpoint.md b/docs/reference/api/InferenceInferenceEndpoint.md new file mode 100644 index 000000000..3e3cd6ebe --- /dev/null +++ b/docs/reference/api/InferenceInferenceEndpoint.md @@ -0,0 +1,8 @@ +## Interface `InferenceInferenceEndpoint` + +| Name | Type | Description | +| - | - | - | +| `chunking_settings` | [InferenceInferenceChunkingSettings](./InferenceInferenceChunkingSettings.md) | Chunking configuration object | +| `service_settings` | [InferenceServiceSettings](./InferenceServiceSettings.md) | Settings specific to the service | +| `service` | string | The service type | +| `task_settings` | [InferenceTaskSettings](./InferenceTaskSettings.md) | Task settings specific to the service and task type | diff --git a/docs/reference/api/InferenceInferenceEndpointInfo.md b/docs/reference/api/InferenceInferenceEndpointInfo.md new file mode 100644 index 000000000..f0bb2f41a --- /dev/null +++ b/docs/reference/api/InferenceInferenceEndpointInfo.md @@ -0,0 +1,6 @@ +## Interface `InferenceInferenceEndpointInfo` + +| Name | Type | Description | +| - | - | - | +| `inference_id` | string | The inference Id | +| `task_type` | [InferenceTaskType](./InferenceTaskType.md) | The task type | diff --git a/docs/reference/api/InferenceInferenceRequest.md b/docs/reference/api/InferenceInferenceRequest.md new file mode 100644 index 000000000..144e10b31 --- /dev/null +++ b/docs/reference/api/InferenceInferenceRequest.md @@ -0,0 +1,12 @@ +## Interface `InferenceInferenceRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { task_type?: never; inference_id?: never; timeout?: never; query?: never; input?: never; task_settings?: never; }) | All values in `body` will be added to the request body. | +| `inference_id` | [Id](./Id.md) | The unique identifier for the inference endpoint. | +| `input` | string | string[] | The text on which you want to perform the inference task. It can be a single string or an array. > info > Inference endpoints for the `completion` task type currently only support a single string as input. | +| `query` | string | The query input, which is required only for the `rerank` task. It is not required for other tasks. | +| `querystring` | { [key: string]: any; } & { task_type?: never; inference_id?: never; timeout?: never; query?: never; input?: never; task_settings?: never; } | All values in `querystring` will be added to the request querystring. | +| `task_settings` | [InferenceTaskSettings](./InferenceTaskSettings.md) | Task settings for the individual inference request. These settings are specific to the task type you specified and override the task settings specified when initializing the service. | +| `task_type` | [InferenceTaskType](./InferenceTaskType.md) | The type of inference task that the model performs. | +| `timeout` | [Duration](./Duration.md) | The amount of time to wait for the inference request to complete. | diff --git a/docs/reference/api/InferenceInferenceResponse.md b/docs/reference/api/InferenceInferenceResponse.md new file mode 100644 index 000000000..6c4fcc004 --- /dev/null +++ b/docs/reference/api/InferenceInferenceResponse.md @@ -0,0 +1,4 @@ +## `InferenceInferenceResponse` +::: +type InferenceInferenceResponse = [InferenceInferenceResult](./InferenceInferenceResult.md); +::: diff --git a/docs/reference/api/InferenceInferenceResult.md b/docs/reference/api/InferenceInferenceResult.md new file mode 100644 index 000000000..2bfed3140 --- /dev/null +++ b/docs/reference/api/InferenceInferenceResult.md @@ -0,0 +1,10 @@ +## Interface `InferenceInferenceResult` + +| Name | Type | Description | +| - | - | - | +| `completion` | [InferenceCompletionResult](./InferenceCompletionResult.md)[] |   | +| `rerank` | [InferenceRankedDocument](./InferenceRankedDocument.md)[] |   | +| `sparse_embedding` | [InferenceSparseEmbeddingResult](./InferenceSparseEmbeddingResult.md)[] |   | +| `text_embedding_bits` | [InferenceTextEmbeddingByteResult](./InferenceTextEmbeddingByteResult.md)[] |   | +| `text_embedding_bytes` | [InferenceTextEmbeddingByteResult](./InferenceTextEmbeddingByteResult.md)[] |   | +| `text_embedding` | [InferenceTextEmbeddingResult](./InferenceTextEmbeddingResult.md)[] |   | diff --git a/docs/reference/api/InferenceJinaAIServiceSettings.md b/docs/reference/api/InferenceJinaAIServiceSettings.md new file mode 100644 index 000000000..948d7204c --- /dev/null +++ b/docs/reference/api/InferenceJinaAIServiceSettings.md @@ -0,0 +1,8 @@ +## Interface `InferenceJinaAIServiceSettings` + +| Name | Type | Description | +| - | - | - | +| `api_key` | string | A valid API key of your JinaAI account. IMPORTANT: You need to provide the API key only once, during the inference model creation. The get inference endpoint API does not retrieve your API key. After creating the inference model, you cannot change the associated API key. If you want to use a different API key, delete the inference model and recreate it with the same name and the updated API key. | +| `model_id` | string | The name of the model to use for the inference task. For a `rerank` task, it is required. For a `text_embedding` task, it is optional. | +| `rate_limit` | [InferenceRateLimitSetting](./InferenceRateLimitSetting.md) | This setting helps to minimize the number of rate limit errors returned from JinaAI. By default, the `jinaai` service sets the number of requests allowed per minute to 2000 for all task types. | +| `similarity` | [InferenceJinaAISimilarityType](./InferenceJinaAISimilarityType.md) | For a `text_embedding` task, the similarity measure. One of cosine, dot_product, l2_norm. The default values varies with the embedding type. For example, a float embedding type uses a `dot_product` similarity measure by default. | diff --git a/docs/reference/api/InferenceJinaAIServiceType.md b/docs/reference/api/InferenceJinaAIServiceType.md new file mode 100644 index 000000000..3ace6e193 --- /dev/null +++ b/docs/reference/api/InferenceJinaAIServiceType.md @@ -0,0 +1,4 @@ +## `InferenceJinaAIServiceType` +::: +type InferenceJinaAIServiceType = 'jinaai'; +::: diff --git a/docs/reference/api/InferenceJinaAISimilarityType.md b/docs/reference/api/InferenceJinaAISimilarityType.md new file mode 100644 index 000000000..820749c9f --- /dev/null +++ b/docs/reference/api/InferenceJinaAISimilarityType.md @@ -0,0 +1,4 @@ +## `InferenceJinaAISimilarityType` +::: +type InferenceJinaAISimilarityType = 'cosine' | 'dot_product' | 'l2_norm'; +::: diff --git a/docs/reference/api/InferenceJinaAITaskSettings.md b/docs/reference/api/InferenceJinaAITaskSettings.md new file mode 100644 index 000000000..408466ba3 --- /dev/null +++ b/docs/reference/api/InferenceJinaAITaskSettings.md @@ -0,0 +1,7 @@ +## Interface `InferenceJinaAITaskSettings` + +| Name | Type | Description | +| - | - | - | +| `return_documents` | boolean | For a `rerank` task, return the doc text within the results. | +| `task` | [InferenceJinaAITextEmbeddingTask](./InferenceJinaAITextEmbeddingTask.md) | For a `text_embedding` task, the task passed to the model. Valid values are: * `classification`: Use it for embeddings passed through a text classifier. * `clustering`: Use it for the embeddings run through a clustering algorithm. * `ingest`: Use it for storing document embeddings in a vector database. * `search`: Use it for storing embeddings of search queries run against a vector database to find relevant documents. | +| `top_n` | [integer](./integer.md) | For a `rerank` task, the number of most relevant documents to return. It defaults to the number of the documents. If this inference endpoint is used in a `text_similarity_reranker` retriever query and `top_n` is set, it must be greater than or equal to `rank_window_size` in the query. | diff --git a/docs/reference/api/InferenceJinaAITaskType.md b/docs/reference/api/InferenceJinaAITaskType.md new file mode 100644 index 000000000..e15be196f --- /dev/null +++ b/docs/reference/api/InferenceJinaAITaskType.md @@ -0,0 +1,4 @@ +## `InferenceJinaAITaskType` +::: +type InferenceJinaAITaskType = 'rerank' | 'text_embedding'; +::: diff --git a/docs/reference/api/InferenceJinaAITextEmbeddingTask.md b/docs/reference/api/InferenceJinaAITextEmbeddingTask.md new file mode 100644 index 000000000..bf2e5b108 --- /dev/null +++ b/docs/reference/api/InferenceJinaAITextEmbeddingTask.md @@ -0,0 +1,4 @@ +## `InferenceJinaAITextEmbeddingTask` +::: +type InferenceJinaAITextEmbeddingTask = 'classification' | 'clustering' | 'ingest' | 'search'; +::: diff --git a/docs/reference/api/InferenceMessage.md b/docs/reference/api/InferenceMessage.md new file mode 100644 index 000000000..7b802d522 --- /dev/null +++ b/docs/reference/api/InferenceMessage.md @@ -0,0 +1,8 @@ +## Interface `InferenceMessage` + +| Name | Type | Description | +| - | - | - | +| `content` | [InferenceMessageContent](./InferenceMessageContent.md) | The content of the message. | +| `role` | string | The role of the message author. | +| `tool_call_id` | [Id](./Id.md) | The tool call that this message is responding to. | +| `tool_calls` | [InferenceToolCall](./InferenceToolCall.md)[] | The tool calls generated by the model. | diff --git a/docs/reference/api/InferenceMessageContent.md b/docs/reference/api/InferenceMessageContent.md new file mode 100644 index 000000000..782a1eaa5 --- /dev/null +++ b/docs/reference/api/InferenceMessageContent.md @@ -0,0 +1,4 @@ +## `InferenceMessageContent` +::: +type InferenceMessageContent = string | [InferenceContentObject](./InferenceContentObject.md)[]; +::: diff --git a/docs/reference/api/InferenceMistralServiceSettings.md b/docs/reference/api/InferenceMistralServiceSettings.md new file mode 100644 index 000000000..d5066cf1c --- /dev/null +++ b/docs/reference/api/InferenceMistralServiceSettings.md @@ -0,0 +1,8 @@ +## Interface `InferenceMistralServiceSettings` + +| Name | Type | Description | +| - | - | - | +| `api_key` | string | A valid API key of your Mistral account. You can find your Mistral API keys or you can create a new one on the API Keys page. IMPORTANT: You need to provide the API key only once, during the inference model creation. The get inference endpoint API does not retrieve your API key. After creating the inference model, you cannot change the associated API key. If you want to use a different API key, delete the inference model and recreate it with the same name and the updated API key. | +| `max_input_tokens` | [integer](./integer.md) | The maximum number of tokens per input before chunking occurs. | +| `model` | string | The name of the model to use for the inference task. Refer to the Mistral models documentation for the list of available text embedding models. | +| `rate_limit` | [InferenceRateLimitSetting](./InferenceRateLimitSetting.md) | This setting helps to minimize the number of rate limit errors returned from the Mistral API. By default, the `mistral` service sets the number of requests allowed per minute to 240. | diff --git a/docs/reference/api/InferenceMistralServiceType.md b/docs/reference/api/InferenceMistralServiceType.md new file mode 100644 index 000000000..843246129 --- /dev/null +++ b/docs/reference/api/InferenceMistralServiceType.md @@ -0,0 +1,4 @@ +## `InferenceMistralServiceType` +::: +type InferenceMistralServiceType = 'mistral'; +::: diff --git a/docs/reference/api/InferenceMistralTaskType.md b/docs/reference/api/InferenceMistralTaskType.md new file mode 100644 index 000000000..af01491e5 --- /dev/null +++ b/docs/reference/api/InferenceMistralTaskType.md @@ -0,0 +1,4 @@ +## `InferenceMistralTaskType` +::: +type InferenceMistralTaskType = 'text_embedding'; +::: diff --git a/docs/reference/api/InferenceOpenAIServiceSettings.md b/docs/reference/api/InferenceOpenAIServiceSettings.md new file mode 100644 index 000000000..bc154e3ba --- /dev/null +++ b/docs/reference/api/InferenceOpenAIServiceSettings.md @@ -0,0 +1,10 @@ +## Interface `InferenceOpenAIServiceSettings` + +| Name | Type | Description | +| - | - | - | +| `api_key` | string | A valid API key of your OpenAI account. You can find your OpenAI API keys in your OpenAI account under the API keys section. IMPORTANT: You need to provide the API key only once, during the inference model creation. The get inference endpoint API does not retrieve your API key. After creating the inference model, you cannot change the associated API key. If you want to use a different API key, delete the inference model and recreate it with the same name and the updated API key. | +| `dimensions` | [integer](./integer.md) | The number of dimensions the resulting output embeddings should have. It is supported only in `text-embedding-3` and later models. If it is not set, the OpenAI defined default for the model is used. | +| `model_id` | string | The name of the model to use for the inference task. Refer to the OpenAI documentation for the list of available text embedding models. | +| `organization_id` | string | The unique identifier for your organization. You can find the Organization ID in your OpenAI account under *Settings > Organizations*. | +| `rate_limit` | [InferenceRateLimitSetting](./InferenceRateLimitSetting.md) | This setting helps to minimize the number of rate limit errors returned from OpenAI. The `openai` service sets a default number of requests allowed per minute depending on the task type. For `text_embedding`, it is set to `3000`. For `completion`, it is set to `500`. | +| `url` | string | The URL endpoint to use for the requests. It can be changed for testing purposes. | diff --git a/docs/reference/api/InferenceOpenAIServiceType.md b/docs/reference/api/InferenceOpenAIServiceType.md new file mode 100644 index 000000000..3e31b6526 --- /dev/null +++ b/docs/reference/api/InferenceOpenAIServiceType.md @@ -0,0 +1,4 @@ +## `InferenceOpenAIServiceType` +::: +type InferenceOpenAIServiceType = 'openai'; +::: diff --git a/docs/reference/api/InferenceOpenAITaskSettings.md b/docs/reference/api/InferenceOpenAITaskSettings.md new file mode 100644 index 000000000..8969b8edb --- /dev/null +++ b/docs/reference/api/InferenceOpenAITaskSettings.md @@ -0,0 +1,5 @@ +## Interface `InferenceOpenAITaskSettings` + +| Name | Type | Description | +| - | - | - | +| `user` | string | For a `completion` or `text_embedding` task, specify the user issuing the request. This information can be used for abuse detection. | diff --git a/docs/reference/api/InferenceOpenAITaskType.md b/docs/reference/api/InferenceOpenAITaskType.md new file mode 100644 index 000000000..6b8c5897d --- /dev/null +++ b/docs/reference/api/InferenceOpenAITaskType.md @@ -0,0 +1,4 @@ +## `InferenceOpenAITaskType` +::: +type InferenceOpenAITaskType = 'chat_completion' | 'completion' | 'text_embedding'; +::: diff --git a/docs/reference/api/InferencePutAlibabacloudRequest.md b/docs/reference/api/InferencePutAlibabacloudRequest.md new file mode 100644 index 000000000..190110c5c --- /dev/null +++ b/docs/reference/api/InferencePutAlibabacloudRequest.md @@ -0,0 +1,12 @@ +## Interface `InferencePutAlibabacloudRequest` + +| Name | Type | Description | +| - | - | - | +| `alibabacloud_inference_id` | [Id](./Id.md) | The unique identifier of the inference endpoint. | +| `body` | string | ({ [key: string]: any; } & { task_type?: never; alibabacloud_inference_id?: never; chunking_settings?: never; service?: never; service_settings?: never; task_settings?: never; }) | All values in `body` will be added to the request body. | +| `chunking_settings` | [InferenceInferenceChunkingSettings](./InferenceInferenceChunkingSettings.md) | The chunking configuration object. | +| `querystring` | { [key: string]: any; } & { task_type?: never; alibabacloud_inference_id?: never; chunking_settings?: never; service?: never; service_settings?: never; task_settings?: never; } | All values in `querystring` will be added to the request querystring. | +| `service_settings` | [InferenceAlibabaCloudServiceSettings](./InferenceAlibabaCloudServiceSettings.md) | Settings used to install the inference model. These settings are specific to the `alibabacloud-ai-search` service. | +| `service` | [InferenceAlibabaCloudServiceType](./InferenceAlibabaCloudServiceType.md) | The type of service supported for the specified task type. In this case, `alibabacloud-ai-search`. | +| `task_settings` | [InferenceAlibabaCloudTaskSettings](./InferenceAlibabaCloudTaskSettings.md) | Settings to configure the inference task. These settings are specific to the task type you specified. | +| `task_type` | [InferenceAlibabaCloudTaskType](./InferenceAlibabaCloudTaskType.md) | The type of the inference task that the model will perform. | diff --git a/docs/reference/api/InferencePutAlibabacloudResponse.md b/docs/reference/api/InferencePutAlibabacloudResponse.md new file mode 100644 index 000000000..c52d57f1f --- /dev/null +++ b/docs/reference/api/InferencePutAlibabacloudResponse.md @@ -0,0 +1,4 @@ +## `InferencePutAlibabacloudResponse` +::: +type InferencePutAlibabacloudResponse = [InferenceInferenceEndpointInfo](./InferenceInferenceEndpointInfo.md); +::: diff --git a/docs/reference/api/InferencePutAmazonbedrockRequest.md b/docs/reference/api/InferencePutAmazonbedrockRequest.md new file mode 100644 index 000000000..ea5b1e0a1 --- /dev/null +++ b/docs/reference/api/InferencePutAmazonbedrockRequest.md @@ -0,0 +1,12 @@ +## Interface `InferencePutAmazonbedrockRequest` + +| Name | Type | Description | +| - | - | - | +| `amazonbedrock_inference_id` | [Id](./Id.md) | The unique identifier of the inference endpoint. | +| `body` | string | ({ [key: string]: any; } & { task_type?: never; amazonbedrock_inference_id?: never; chunking_settings?: never; service?: never; service_settings?: never; task_settings?: never; }) | All values in `body` will be added to the request body. | +| `chunking_settings` | [InferenceInferenceChunkingSettings](./InferenceInferenceChunkingSettings.md) | The chunking configuration object. | +| `querystring` | { [key: string]: any; } & { task_type?: never; amazonbedrock_inference_id?: never; chunking_settings?: never; service?: never; service_settings?: never; task_settings?: never; } | All values in `querystring` will be added to the request querystring. | +| `service_settings` | [InferenceAmazonBedrockServiceSettings](./InferenceAmazonBedrockServiceSettings.md) | Settings used to install the inference model. These settings are specific to the `amazonbedrock` service. | +| `service` | [InferenceAmazonBedrockServiceType](./InferenceAmazonBedrockServiceType.md) | The type of service supported for the specified task type. In this case, `amazonbedrock`. | +| `task_settings` | [InferenceAmazonBedrockTaskSettings](./InferenceAmazonBedrockTaskSettings.md) | Settings to configure the inference task. These settings are specific to the task type you specified. | +| `task_type` | [InferenceAmazonBedrockTaskType](./InferenceAmazonBedrockTaskType.md) | The type of the inference task that the model will perform. | diff --git a/docs/reference/api/InferencePutAmazonbedrockResponse.md b/docs/reference/api/InferencePutAmazonbedrockResponse.md new file mode 100644 index 000000000..c2d031460 --- /dev/null +++ b/docs/reference/api/InferencePutAmazonbedrockResponse.md @@ -0,0 +1,4 @@ +## `InferencePutAmazonbedrockResponse` +::: +type InferencePutAmazonbedrockResponse = [InferenceInferenceEndpointInfo](./InferenceInferenceEndpointInfo.md); +::: diff --git a/docs/reference/api/InferencePutAnthropicRequest.md b/docs/reference/api/InferencePutAnthropicRequest.md new file mode 100644 index 000000000..95cabb363 --- /dev/null +++ b/docs/reference/api/InferencePutAnthropicRequest.md @@ -0,0 +1,12 @@ +## Interface `InferencePutAnthropicRequest` + +| Name | Type | Description | +| - | - | - | +| `anthropic_inference_id` | [Id](./Id.md) | The unique identifier of the inference endpoint. | +| `body` | string | ({ [key: string]: any; } & { task_type?: never; anthropic_inference_id?: never; chunking_settings?: never; service?: never; service_settings?: never; task_settings?: never; }) | All values in `body` will be added to the request body. | +| `chunking_settings` | [InferenceInferenceChunkingSettings](./InferenceInferenceChunkingSettings.md) | The chunking configuration object. | +| `querystring` | { [key: string]: any; } & { task_type?: never; anthropic_inference_id?: never; chunking_settings?: never; service?: never; service_settings?: never; task_settings?: never; } | All values in `querystring` will be added to the request querystring. | +| `service_settings` | [InferenceAnthropicServiceSettings](./InferenceAnthropicServiceSettings.md) | Settings used to install the inference model. These settings are specific to the `watsonxai` service. | +| `service` | [InferenceAnthropicServiceType](./InferenceAnthropicServiceType.md) | The type of service supported for the specified task type. In this case, `anthropic`. | +| `task_settings` | [InferenceAnthropicTaskSettings](./InferenceAnthropicTaskSettings.md) | Settings to configure the inference task. These settings are specific to the task type you specified. | +| `task_type` | [InferenceAnthropicTaskType](./InferenceAnthropicTaskType.md) | The task type. The only valid task type for the model to perform is `completion`. | diff --git a/docs/reference/api/InferencePutAnthropicResponse.md b/docs/reference/api/InferencePutAnthropicResponse.md new file mode 100644 index 000000000..0e12930c1 --- /dev/null +++ b/docs/reference/api/InferencePutAnthropicResponse.md @@ -0,0 +1,4 @@ +## `InferencePutAnthropicResponse` +::: +type InferencePutAnthropicResponse = [InferenceInferenceEndpointInfo](./InferenceInferenceEndpointInfo.md); +::: diff --git a/docs/reference/api/InferencePutAzureaistudioRequest.md b/docs/reference/api/InferencePutAzureaistudioRequest.md new file mode 100644 index 000000000..ea15ccdf6 --- /dev/null +++ b/docs/reference/api/InferencePutAzureaistudioRequest.md @@ -0,0 +1,12 @@ +## Interface `InferencePutAzureaistudioRequest` + +| Name | Type | Description | +| - | - | - | +| `azureaistudio_inference_id` | [Id](./Id.md) | The unique identifier of the inference endpoint. | +| `body` | string | ({ [key: string]: any; } & { task_type?: never; azureaistudio_inference_id?: never; chunking_settings?: never; service?: never; service_settings?: never; task_settings?: never; }) | All values in `body` will be added to the request body. | +| `chunking_settings` | [InferenceInferenceChunkingSettings](./InferenceInferenceChunkingSettings.md) | The chunking configuration object. | +| `querystring` | { [key: string]: any; } & { task_type?: never; azureaistudio_inference_id?: never; chunking_settings?: never; service?: never; service_settings?: never; task_settings?: never; } | All values in `querystring` will be added to the request querystring. | +| `service_settings` | [InferenceAzureAiStudioServiceSettings](./InferenceAzureAiStudioServiceSettings.md) | Settings used to install the inference model. These settings are specific to the `openai` service. | +| `service` | [InferenceAzureAiStudioServiceType](./InferenceAzureAiStudioServiceType.md) | The type of service supported for the specified task type. In this case, `azureaistudio`. | +| `task_settings` | [InferenceAzureAiStudioTaskSettings](./InferenceAzureAiStudioTaskSettings.md) | Settings to configure the inference task. These settings are specific to the task type you specified. | +| `task_type` | [InferenceAzureAiStudioTaskType](./InferenceAzureAiStudioTaskType.md) | The type of the inference task that the model will perform. | diff --git a/docs/reference/api/InferencePutAzureaistudioResponse.md b/docs/reference/api/InferencePutAzureaistudioResponse.md new file mode 100644 index 000000000..443b9e3e3 --- /dev/null +++ b/docs/reference/api/InferencePutAzureaistudioResponse.md @@ -0,0 +1,4 @@ +## `InferencePutAzureaistudioResponse` +::: +type InferencePutAzureaistudioResponse = [InferenceInferenceEndpointInfo](./InferenceInferenceEndpointInfo.md); +::: diff --git a/docs/reference/api/InferencePutAzureopenaiRequest.md b/docs/reference/api/InferencePutAzureopenaiRequest.md new file mode 100644 index 000000000..cf8879a4e --- /dev/null +++ b/docs/reference/api/InferencePutAzureopenaiRequest.md @@ -0,0 +1,12 @@ +## Interface `InferencePutAzureopenaiRequest` + +| Name | Type | Description | +| - | - | - | +| `azureopenai_inference_id` | [Id](./Id.md) | The unique identifier of the inference endpoint. | +| `body` | string | ({ [key: string]: any; } & { task_type?: never; azureopenai_inference_id?: never; chunking_settings?: never; service?: never; service_settings?: never; task_settings?: never; }) | All values in `body` will be added to the request body. | +| `chunking_settings` | [InferenceInferenceChunkingSettings](./InferenceInferenceChunkingSettings.md) | The chunking configuration object. | +| `querystring` | { [key: string]: any; } & { task_type?: never; azureopenai_inference_id?: never; chunking_settings?: never; service?: never; service_settings?: never; task_settings?: never; } | All values in `querystring` will be added to the request querystring. | +| `service_settings` | [InferenceAzureOpenAIServiceSettings](./InferenceAzureOpenAIServiceSettings.md) | Settings used to install the inference model. These settings are specific to the `azureopenai` service. | +| `service` | [InferenceAzureOpenAIServiceType](./InferenceAzureOpenAIServiceType.md) | The type of service supported for the specified task type. In this case, `azureopenai`. | +| `task_settings` | [InferenceAzureOpenAITaskSettings](./InferenceAzureOpenAITaskSettings.md) | Settings to configure the inference task. These settings are specific to the task type you specified. | +| `task_type` | [InferenceAzureOpenAITaskType](./InferenceAzureOpenAITaskType.md) | The type of the inference task that the model will perform. NOTE: The `chat_completion` task type only supports streaming and only through the _stream API. | diff --git a/docs/reference/api/InferencePutAzureopenaiResponse.md b/docs/reference/api/InferencePutAzureopenaiResponse.md new file mode 100644 index 000000000..53a61a52f --- /dev/null +++ b/docs/reference/api/InferencePutAzureopenaiResponse.md @@ -0,0 +1,4 @@ +## `InferencePutAzureopenaiResponse` +::: +type InferencePutAzureopenaiResponse = [InferenceInferenceEndpointInfo](./InferenceInferenceEndpointInfo.md); +::: diff --git a/docs/reference/api/InferencePutCohereRequest.md b/docs/reference/api/InferencePutCohereRequest.md new file mode 100644 index 000000000..16bd48072 --- /dev/null +++ b/docs/reference/api/InferencePutCohereRequest.md @@ -0,0 +1,12 @@ +## Interface `InferencePutCohereRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { task_type?: never; cohere_inference_id?: never; chunking_settings?: never; service?: never; service_settings?: never; task_settings?: never; }) | All values in `body` will be added to the request body. | +| `chunking_settings` | [InferenceInferenceChunkingSettings](./InferenceInferenceChunkingSettings.md) | The chunking configuration object. | +| `cohere_inference_id` | [Id](./Id.md) | The unique identifier of the inference endpoint. | +| `querystring` | { [key: string]: any; } & { task_type?: never; cohere_inference_id?: never; chunking_settings?: never; service?: never; service_settings?: never; task_settings?: never; } | All values in `querystring` will be added to the request querystring. | +| `service_settings` | [InferenceCohereServiceSettings](./InferenceCohereServiceSettings.md) | Settings used to install the inference model. These settings are specific to the `cohere` service. | +| `service` | [InferenceCohereServiceType](./InferenceCohereServiceType.md) | The type of service supported for the specified task type. In this case, `cohere`. | +| `task_settings` | [InferenceCohereTaskSettings](./InferenceCohereTaskSettings.md) | Settings to configure the inference task. These settings are specific to the task type you specified. | +| `task_type` | [InferenceCohereTaskType](./InferenceCohereTaskType.md) | The type of the inference task that the model will perform. | diff --git a/docs/reference/api/InferencePutCohereResponse.md b/docs/reference/api/InferencePutCohereResponse.md new file mode 100644 index 000000000..f7d670bc4 --- /dev/null +++ b/docs/reference/api/InferencePutCohereResponse.md @@ -0,0 +1,4 @@ +## `InferencePutCohereResponse` +::: +type InferencePutCohereResponse = [InferenceInferenceEndpointInfo](./InferenceInferenceEndpointInfo.md); +::: diff --git a/docs/reference/api/InferencePutElasticsearchRequest.md b/docs/reference/api/InferencePutElasticsearchRequest.md new file mode 100644 index 000000000..f5987a4d8 --- /dev/null +++ b/docs/reference/api/InferencePutElasticsearchRequest.md @@ -0,0 +1,12 @@ +## Interface `InferencePutElasticsearchRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { task_type?: never; elasticsearch_inference_id?: never; chunking_settings?: never; service?: never; service_settings?: never; task_settings?: never; }) | All values in `body` will be added to the request body. | +| `chunking_settings` | [InferenceInferenceChunkingSettings](./InferenceInferenceChunkingSettings.md) | The chunking configuration object. | +| `elasticsearch_inference_id` | [Id](./Id.md) | The unique identifier of the inference endpoint. The must not match the `model_id`. | +| `querystring` | { [key: string]: any; } & { task_type?: never; elasticsearch_inference_id?: never; chunking_settings?: never; service?: never; service_settings?: never; task_settings?: never; } | All values in `querystring` will be added to the request querystring. | +| `service_settings` | [InferenceElasticsearchServiceSettings](./InferenceElasticsearchServiceSettings.md) | Settings used to install the inference model. These settings are specific to the `elasticsearch` service. | +| `service` | [InferenceElasticsearchServiceType](./InferenceElasticsearchServiceType.md) | The type of service supported for the specified task type. In this case, `elasticsearch`. | +| `task_settings` | [InferenceElasticsearchTaskSettings](./InferenceElasticsearchTaskSettings.md) | Settings to configure the inference task. These settings are specific to the task type you specified. | +| `task_type` | [InferenceElasticsearchTaskType](./InferenceElasticsearchTaskType.md) | The type of the inference task that the model will perform. | diff --git a/docs/reference/api/InferencePutElasticsearchResponse.md b/docs/reference/api/InferencePutElasticsearchResponse.md new file mode 100644 index 000000000..689ab1d25 --- /dev/null +++ b/docs/reference/api/InferencePutElasticsearchResponse.md @@ -0,0 +1,4 @@ +## `InferencePutElasticsearchResponse` +::: +type InferencePutElasticsearchResponse = [InferenceInferenceEndpointInfo](./InferenceInferenceEndpointInfo.md); +::: diff --git a/docs/reference/api/InferencePutElserRequest.md b/docs/reference/api/InferencePutElserRequest.md new file mode 100644 index 000000000..9eeff33ae --- /dev/null +++ b/docs/reference/api/InferencePutElserRequest.md @@ -0,0 +1,11 @@ +## Interface `InferencePutElserRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { task_type?: never; elser_inference_id?: never; chunking_settings?: never; service?: never; service_settings?: never; }) | All values in `body` will be added to the request body. | +| `chunking_settings` | [InferenceInferenceChunkingSettings](./InferenceInferenceChunkingSettings.md) | The chunking configuration object. | +| `elser_inference_id` | [Id](./Id.md) | The unique identifier of the inference endpoint. | +| `querystring` | { [key: string]: any; } & { task_type?: never; elser_inference_id?: never; chunking_settings?: never; service?: never; service_settings?: never; } | All values in `querystring` will be added to the request querystring. | +| `service_settings` | [InferenceElserServiceSettings](./InferenceElserServiceSettings.md) | Settings used to install the inference model. These settings are specific to the `elser` service. | +| `service` | [InferenceElserServiceType](./InferenceElserServiceType.md) | The type of service supported for the specified task type. In this case, `elser`. | +| `task_type` | [InferenceElserTaskType](./InferenceElserTaskType.md) | The type of the inference task that the model will perform. | diff --git a/docs/reference/api/InferencePutElserResponse.md b/docs/reference/api/InferencePutElserResponse.md new file mode 100644 index 000000000..9bc6f7c10 --- /dev/null +++ b/docs/reference/api/InferencePutElserResponse.md @@ -0,0 +1,4 @@ +## `InferencePutElserResponse` +::: +type InferencePutElserResponse = [InferenceInferenceEndpointInfo](./InferenceInferenceEndpointInfo.md); +::: diff --git a/docs/reference/api/InferencePutGoogleaistudioRequest.md b/docs/reference/api/InferencePutGoogleaistudioRequest.md new file mode 100644 index 000000000..db7b8ca03 --- /dev/null +++ b/docs/reference/api/InferencePutGoogleaistudioRequest.md @@ -0,0 +1,11 @@ +## Interface `InferencePutGoogleaistudioRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { task_type?: never; googleaistudio_inference_id?: never; chunking_settings?: never; service?: never; service_settings?: never; }) | All values in `body` will be added to the request body. | +| `chunking_settings` | [InferenceInferenceChunkingSettings](./InferenceInferenceChunkingSettings.md) | The chunking configuration object. | +| `googleaistudio_inference_id` | [Id](./Id.md) | The unique identifier of the inference endpoint. | +| `querystring` | { [key: string]: any; } & { task_type?: never; googleaistudio_inference_id?: never; chunking_settings?: never; service?: never; service_settings?: never; } | All values in `querystring` will be added to the request querystring. | +| `service_settings` | [InferenceGoogleAiStudioServiceSettings](./InferenceGoogleAiStudioServiceSettings.md) | Settings used to install the inference model. These settings are specific to the `googleaistudio` service. | +| `service` | [InferenceGoogleAiServiceType](./InferenceGoogleAiServiceType.md) | The type of service supported for the specified task type. In this case, `googleaistudio`. | +| `task_type` | [InferenceGoogleAiStudioTaskType](./InferenceGoogleAiStudioTaskType.md) | The type of the inference task that the model will perform. | diff --git a/docs/reference/api/InferencePutGoogleaistudioResponse.md b/docs/reference/api/InferencePutGoogleaistudioResponse.md new file mode 100644 index 000000000..1e893cf1e --- /dev/null +++ b/docs/reference/api/InferencePutGoogleaistudioResponse.md @@ -0,0 +1,4 @@ +## `InferencePutGoogleaistudioResponse` +::: +type InferencePutGoogleaistudioResponse = [InferenceInferenceEndpointInfo](./InferenceInferenceEndpointInfo.md); +::: diff --git a/docs/reference/api/InferencePutGooglevertexaiRequest.md b/docs/reference/api/InferencePutGooglevertexaiRequest.md new file mode 100644 index 000000000..f13502342 --- /dev/null +++ b/docs/reference/api/InferencePutGooglevertexaiRequest.md @@ -0,0 +1,12 @@ +## Interface `InferencePutGooglevertexaiRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { task_type?: never; googlevertexai_inference_id?: never; chunking_settings?: never; service?: never; service_settings?: never; task_settings?: never; }) | All values in `body` will be added to the request body. | +| `chunking_settings` | [InferenceInferenceChunkingSettings](./InferenceInferenceChunkingSettings.md) | The chunking configuration object. | +| `googlevertexai_inference_id` | [Id](./Id.md) | The unique identifier of the inference endpoint. | +| `querystring` | { [key: string]: any; } & { task_type?: never; googlevertexai_inference_id?: never; chunking_settings?: never; service?: never; service_settings?: never; task_settings?: never; } | All values in `querystring` will be added to the request querystring. | +| `service_settings` | [InferenceGoogleVertexAIServiceSettings](./InferenceGoogleVertexAIServiceSettings.md) | Settings used to install the inference model. These settings are specific to the `googlevertexai` service. | +| `service` | [InferenceGoogleVertexAIServiceType](./InferenceGoogleVertexAIServiceType.md) | The type of service supported for the specified task type. In this case, `googlevertexai`. | +| `task_settings` | [InferenceGoogleVertexAITaskSettings](./InferenceGoogleVertexAITaskSettings.md) | Settings to configure the inference task. These settings are specific to the task type you specified. | +| `task_type` | [InferenceGoogleVertexAITaskType](./InferenceGoogleVertexAITaskType.md) | The type of the inference task that the model will perform. | diff --git a/docs/reference/api/InferencePutGooglevertexaiResponse.md b/docs/reference/api/InferencePutGooglevertexaiResponse.md new file mode 100644 index 000000000..29453ce1b --- /dev/null +++ b/docs/reference/api/InferencePutGooglevertexaiResponse.md @@ -0,0 +1,4 @@ +## `InferencePutGooglevertexaiResponse` +::: +type InferencePutGooglevertexaiResponse = [InferenceInferenceEndpointInfo](./InferenceInferenceEndpointInfo.md); +::: diff --git a/docs/reference/api/InferencePutHuggingFaceRequest.md b/docs/reference/api/InferencePutHuggingFaceRequest.md new file mode 100644 index 000000000..6b3e4676e --- /dev/null +++ b/docs/reference/api/InferencePutHuggingFaceRequest.md @@ -0,0 +1,11 @@ +## Interface `InferencePutHuggingFaceRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { task_type?: never; huggingface_inference_id?: never; chunking_settings?: never; service?: never; service_settings?: never; }) | All values in `body` will be added to the request body. | +| `chunking_settings` | [InferenceInferenceChunkingSettings](./InferenceInferenceChunkingSettings.md) | The chunking configuration object. | +| `huggingface_inference_id` | [Id](./Id.md) | The unique identifier of the inference endpoint. | +| `querystring` | { [key: string]: any; } & { task_type?: never; huggingface_inference_id?: never; chunking_settings?: never; service?: never; service_settings?: never; } | All values in `querystring` will be added to the request querystring. | +| `service_settings` | [InferenceHuggingFaceServiceSettings](./InferenceHuggingFaceServiceSettings.md) | Settings used to install the inference model. These settings are specific to the `hugging_face` service. | +| `service` | [InferenceHuggingFaceServiceType](./InferenceHuggingFaceServiceType.md) | The type of service supported for the specified task type. In this case, `hugging_face`. | +| `task_type` | [InferenceHuggingFaceTaskType](./InferenceHuggingFaceTaskType.md) | The type of the inference task that the model will perform. | diff --git a/docs/reference/api/InferencePutHuggingFaceResponse.md b/docs/reference/api/InferencePutHuggingFaceResponse.md new file mode 100644 index 000000000..17b0682bb --- /dev/null +++ b/docs/reference/api/InferencePutHuggingFaceResponse.md @@ -0,0 +1,4 @@ +## `InferencePutHuggingFaceResponse` +::: +type InferencePutHuggingFaceResponse = [InferenceInferenceEndpointInfo](./InferenceInferenceEndpointInfo.md); +::: diff --git a/docs/reference/api/InferencePutJinaaiRequest.md b/docs/reference/api/InferencePutJinaaiRequest.md new file mode 100644 index 000000000..f0eb533be --- /dev/null +++ b/docs/reference/api/InferencePutJinaaiRequest.md @@ -0,0 +1,12 @@ +## Interface `InferencePutJinaaiRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { task_type?: never; jinaai_inference_id?: never; chunking_settings?: never; service?: never; service_settings?: never; task_settings?: never; }) | All values in `body` will be added to the request body. | +| `chunking_settings` | [InferenceInferenceChunkingSettings](./InferenceInferenceChunkingSettings.md) | The chunking configuration object. | +| `jinaai_inference_id` | [Id](./Id.md) | The unique identifier of the inference endpoint. | +| `querystring` | { [key: string]: any; } & { task_type?: never; jinaai_inference_id?: never; chunking_settings?: never; service?: never; service_settings?: never; task_settings?: never; } | All values in `querystring` will be added to the request querystring. | +| `service_settings` | [InferenceJinaAIServiceSettings](./InferenceJinaAIServiceSettings.md) | Settings used to install the inference model. These settings are specific to the `jinaai` service. | +| `service` | [InferenceJinaAIServiceType](./InferenceJinaAIServiceType.md) | The type of service supported for the specified task type. In this case, `jinaai`. | +| `task_settings` | [InferenceJinaAITaskSettings](./InferenceJinaAITaskSettings.md) | Settings to configure the inference task. These settings are specific to the task type you specified. | +| `task_type` | [InferenceJinaAITaskType](./InferenceJinaAITaskType.md) | The type of the inference task that the model will perform. | diff --git a/docs/reference/api/InferencePutJinaaiResponse.md b/docs/reference/api/InferencePutJinaaiResponse.md new file mode 100644 index 000000000..c6542dbf4 --- /dev/null +++ b/docs/reference/api/InferencePutJinaaiResponse.md @@ -0,0 +1,4 @@ +## `InferencePutJinaaiResponse` +::: +type InferencePutJinaaiResponse = [InferenceInferenceEndpointInfo](./InferenceInferenceEndpointInfo.md); +::: diff --git a/docs/reference/api/InferencePutMistralRequest.md b/docs/reference/api/InferencePutMistralRequest.md new file mode 100644 index 000000000..4a5d27a67 --- /dev/null +++ b/docs/reference/api/InferencePutMistralRequest.md @@ -0,0 +1,11 @@ +## Interface `InferencePutMistralRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { task_type?: never; mistral_inference_id?: never; chunking_settings?: never; service?: never; service_settings?: never; }) | All values in `body` will be added to the request body. | +| `chunking_settings` | [InferenceInferenceChunkingSettings](./InferenceInferenceChunkingSettings.md) | The chunking configuration object. | +| `mistral_inference_id` | [Id](./Id.md) | The unique identifier of the inference endpoint. | +| `querystring` | { [key: string]: any; } & { task_type?: never; mistral_inference_id?: never; chunking_settings?: never; service?: never; service_settings?: never; } | All values in `querystring` will be added to the request querystring. | +| `service_settings` | [InferenceMistralServiceSettings](./InferenceMistralServiceSettings.md) | Settings used to install the inference model. These settings are specific to the `mistral` service. | +| `service` | [InferenceMistralServiceType](./InferenceMistralServiceType.md) | The type of service supported for the specified task type. In this case, `mistral`. | +| `task_type` | [InferenceMistralTaskType](./InferenceMistralTaskType.md) | The task type. The only valid task type for the model to perform is `text_embedding`. | diff --git a/docs/reference/api/InferencePutMistralResponse.md b/docs/reference/api/InferencePutMistralResponse.md new file mode 100644 index 000000000..623bd058d --- /dev/null +++ b/docs/reference/api/InferencePutMistralResponse.md @@ -0,0 +1,4 @@ +## `InferencePutMistralResponse` +::: +type InferencePutMistralResponse = [InferenceInferenceEndpointInfo](./InferenceInferenceEndpointInfo.md); +::: diff --git a/docs/reference/api/InferencePutOpenaiRequest.md b/docs/reference/api/InferencePutOpenaiRequest.md new file mode 100644 index 000000000..6518821ce --- /dev/null +++ b/docs/reference/api/InferencePutOpenaiRequest.md @@ -0,0 +1,12 @@ +## Interface `InferencePutOpenaiRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { task_type?: never; openai_inference_id?: never; chunking_settings?: never; service?: never; service_settings?: never; task_settings?: never; }) | All values in `body` will be added to the request body. | +| `chunking_settings` | [InferenceInferenceChunkingSettings](./InferenceInferenceChunkingSettings.md) | The chunking configuration object. | +| `openai_inference_id` | [Id](./Id.md) | The unique identifier of the inference endpoint. | +| `querystring` | { [key: string]: any; } & { task_type?: never; openai_inference_id?: never; chunking_settings?: never; service?: never; service_settings?: never; task_settings?: never; } | All values in `querystring` will be added to the request querystring. | +| `service_settings` | [InferenceOpenAIServiceSettings](./InferenceOpenAIServiceSettings.md) | Settings used to install the inference model. These settings are specific to the `openai` service. | +| `service` | [InferenceOpenAIServiceType](./InferenceOpenAIServiceType.md) | The type of service supported for the specified task type. In this case, `openai`. | +| `task_settings` | [InferenceOpenAITaskSettings](./InferenceOpenAITaskSettings.md) | Settings to configure the inference task. These settings are specific to the task type you specified. | +| `task_type` | [InferenceOpenAITaskType](./InferenceOpenAITaskType.md) | The type of the inference task that the model will perform. NOTE: The `chat_completion` task type only supports streaming and only through the _stream API. | diff --git a/docs/reference/api/InferencePutOpenaiResponse.md b/docs/reference/api/InferencePutOpenaiResponse.md new file mode 100644 index 000000000..3f94fc474 --- /dev/null +++ b/docs/reference/api/InferencePutOpenaiResponse.md @@ -0,0 +1,4 @@ +## `InferencePutOpenaiResponse` +::: +type InferencePutOpenaiResponse = [InferenceInferenceEndpointInfo](./InferenceInferenceEndpointInfo.md); +::: diff --git a/docs/reference/api/InferencePutRequest.md b/docs/reference/api/InferencePutRequest.md new file mode 100644 index 000000000..957aa5d27 --- /dev/null +++ b/docs/reference/api/InferencePutRequest.md @@ -0,0 +1,9 @@ +## Interface `InferencePutRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { task_type?: never; inference_id?: never; inference_config?: never; }) | All values in `body` will be added to the request body. | +| `inference_config` | [InferenceInferenceEndpoint](./InferenceInferenceEndpoint.md) |   | +| `inference_id` | [Id](./Id.md) | The inference Id | +| `querystring` | { [key: string]: any; } & { task_type?: never; inference_id?: never; inference_config?: never; } | All values in `querystring` will be added to the request querystring. | +| `task_type` | [InferenceTaskType](./InferenceTaskType.md) | The task type | diff --git a/docs/reference/api/InferencePutResponse.md b/docs/reference/api/InferencePutResponse.md new file mode 100644 index 000000000..836eb0d27 --- /dev/null +++ b/docs/reference/api/InferencePutResponse.md @@ -0,0 +1,4 @@ +## `InferencePutResponse` +::: +type InferencePutResponse = [InferenceInferenceEndpointInfo](./InferenceInferenceEndpointInfo.md); +::: diff --git a/docs/reference/api/InferencePutVoyageaiRequest.md b/docs/reference/api/InferencePutVoyageaiRequest.md new file mode 100644 index 000000000..d521b3058 --- /dev/null +++ b/docs/reference/api/InferencePutVoyageaiRequest.md @@ -0,0 +1,12 @@ +## Interface `InferencePutVoyageaiRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { task_type?: never; voyageai_inference_id?: never; chunking_settings?: never; service?: never; service_settings?: never; task_settings?: never; }) | All values in `body` will be added to the request body. | +| `chunking_settings` | [InferenceInferenceChunkingSettings](./InferenceInferenceChunkingSettings.md) | The chunking configuration object. | +| `querystring` | { [key: string]: any; } & { task_type?: never; voyageai_inference_id?: never; chunking_settings?: never; service?: never; service_settings?: never; task_settings?: never; } | All values in `querystring` will be added to the request querystring. | +| `service_settings` | [InferenceVoyageAIServiceSettings](./InferenceVoyageAIServiceSettings.md) | Settings used to install the inference model. These settings are specific to the `voyageai` service. | +| `service` | [InferenceVoyageAIServiceType](./InferenceVoyageAIServiceType.md) | The type of service supported for the specified task type. In this case, `voyageai`. | +| `task_settings` | [InferenceVoyageAITaskSettings](./InferenceVoyageAITaskSettings.md) | Settings to configure the inference task. These settings are specific to the task type you specified. | +| `task_type` | [InferenceVoyageAITaskType](./InferenceVoyageAITaskType.md) | The type of the inference task that the model will perform. | +| `voyageai_inference_id` | [Id](./Id.md) | The unique identifier of the inference endpoint. | diff --git a/docs/reference/api/InferencePutVoyageaiResponse.md b/docs/reference/api/InferencePutVoyageaiResponse.md new file mode 100644 index 000000000..1d2a942f2 --- /dev/null +++ b/docs/reference/api/InferencePutVoyageaiResponse.md @@ -0,0 +1,4 @@ +## `InferencePutVoyageaiResponse` +::: +type InferencePutVoyageaiResponse = [InferenceInferenceEndpointInfo](./InferenceInferenceEndpointInfo.md); +::: diff --git a/docs/reference/api/InferencePutWatsonxRequest.md b/docs/reference/api/InferencePutWatsonxRequest.md new file mode 100644 index 000000000..6d393c707 --- /dev/null +++ b/docs/reference/api/InferencePutWatsonxRequest.md @@ -0,0 +1,10 @@ +## Interface `InferencePutWatsonxRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { task_type?: never; watsonx_inference_id?: never; service?: never; service_settings?: never; }) | All values in `body` will be added to the request body. | +| `querystring` | { [key: string]: any; } & { task_type?: never; watsonx_inference_id?: never; service?: never; service_settings?: never; } | All values in `querystring` will be added to the request querystring. | +| `service_settings` | [InferenceWatsonxServiceSettings](./InferenceWatsonxServiceSettings.md) | Settings used to install the inference model. These settings are specific to the `watsonxai` service. | +| `service` | [InferenceWatsonxServiceType](./InferenceWatsonxServiceType.md) | The type of service supported for the specified task type. In this case, `watsonxai`. | +| `task_type` | [InferenceWatsonxTaskType](./InferenceWatsonxTaskType.md) | The task type. The only valid task type for the model to perform is `text_embedding`. | +| `watsonx_inference_id` | [Id](./Id.md) | The unique identifier of the inference endpoint. | diff --git a/docs/reference/api/InferencePutWatsonxResponse.md b/docs/reference/api/InferencePutWatsonxResponse.md new file mode 100644 index 000000000..3e25844a9 --- /dev/null +++ b/docs/reference/api/InferencePutWatsonxResponse.md @@ -0,0 +1,4 @@ +## `InferencePutWatsonxResponse` +::: +type InferencePutWatsonxResponse = [InferenceInferenceEndpointInfo](./InferenceInferenceEndpointInfo.md); +::: diff --git a/docs/reference/api/InferenceRankedDocument.md b/docs/reference/api/InferenceRankedDocument.md new file mode 100644 index 000000000..1e79f5f37 --- /dev/null +++ b/docs/reference/api/InferenceRankedDocument.md @@ -0,0 +1,7 @@ +## Interface `InferenceRankedDocument` + +| Name | Type | Description | +| - | - | - | +| `index` | [integer](./integer.md) |   | +| `relevance_score` | [float](./float.md) |   | +| `text` | string |   | diff --git a/docs/reference/api/InferenceRateLimitSetting.md b/docs/reference/api/InferenceRateLimitSetting.md new file mode 100644 index 000000000..4a643375f --- /dev/null +++ b/docs/reference/api/InferenceRateLimitSetting.md @@ -0,0 +1,5 @@ +## Interface `InferenceRateLimitSetting` + +| Name | Type | Description | +| - | - | - | +| `requests_per_minute` | [integer](./integer.md) | The number of requests allowed per minute. | diff --git a/docs/reference/api/InferenceRequestChatCompletion.md b/docs/reference/api/InferenceRequestChatCompletion.md new file mode 100644 index 000000000..d62b1365b --- /dev/null +++ b/docs/reference/api/InferenceRequestChatCompletion.md @@ -0,0 +1,12 @@ +## Interface `InferenceRequestChatCompletion` + +| Name | Type | Description | +| - | - | - | +| `max_completion_tokens` | [long](./long.md) | The upper bound limit for the number of tokens that can be generated for a completion request. | +| `messages` | [InferenceMessage](./InferenceMessage.md)[] | A list of objects representing the conversation. Requests should generally only add new messages from the user (role `user`). The other message roles ( `assistant`, `system`, or `tool`) should generally only be copied from the response to a previous completion request, such that the messages array is built up throughout a conversation. | +| `model` | string | The ID of the model to use. | +| `stop` | string[] | A sequence of strings to control when the model should stop generating additional tokens. | +| `temperature` | [float](./float.md) | The sampling temperature to use. | +| `tool_choice` | [InferenceCompletionToolType](./InferenceCompletionToolType.md) | Controls which tool is called by the model. | +| `tools` | [InferenceCompletionTool](./InferenceCompletionTool.md)[] | A list of tools that the model can call. | +| `top_p` | [float](./float.md) | Nucleus sampling, an alternative to sampling with temperature. | diff --git a/docs/reference/api/InferenceRerankRequest.md b/docs/reference/api/InferenceRerankRequest.md new file mode 100644 index 000000000..8249c4d56 --- /dev/null +++ b/docs/reference/api/InferenceRerankRequest.md @@ -0,0 +1,11 @@ +## Interface `InferenceRerankRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { inference_id?: never; timeout?: never; query?: never; input?: never; task_settings?: never; }) | All values in `body` will be added to the request body. | +| `inference_id` | [Id](./Id.md) | The unique identifier for the inference endpoint. | +| `input` | string | string[] | The text on which you want to perform the inference task. It can be a single string or an array. > info > Inference endpoints for the `completion` task type currently only support a single string as input. | +| `query` | string | Query input. | +| `querystring` | { [key: string]: any; } & { inference_id?: never; timeout?: never; query?: never; input?: never; task_settings?: never; } | All values in `querystring` will be added to the request querystring. | +| `task_settings` | [InferenceTaskSettings](./InferenceTaskSettings.md) | Task settings for the individual inference request. These settings are specific to the task type you specified and override the task settings specified when initializing the service. | +| `timeout` | [Duration](./Duration.md) | The amount of time to wait for the inference request to complete. | diff --git a/docs/reference/api/InferenceRerankResponse.md b/docs/reference/api/InferenceRerankResponse.md new file mode 100644 index 000000000..7192605c1 --- /dev/null +++ b/docs/reference/api/InferenceRerankResponse.md @@ -0,0 +1,4 @@ +## `InferenceRerankResponse` +::: +type InferenceRerankResponse = [InferenceRerankedInferenceResult](./InferenceRerankedInferenceResult.md); +::: diff --git a/docs/reference/api/InferenceRerankedInferenceResult.md b/docs/reference/api/InferenceRerankedInferenceResult.md new file mode 100644 index 000000000..37fe124f7 --- /dev/null +++ b/docs/reference/api/InferenceRerankedInferenceResult.md @@ -0,0 +1,5 @@ +## Interface `InferenceRerankedInferenceResult` + +| Name | Type | Description | +| - | - | - | +| `rerank` | [InferenceRankedDocument](./InferenceRankedDocument.md)[] |   | diff --git a/docs/reference/api/InferenceServiceSettings.md b/docs/reference/api/InferenceServiceSettings.md new file mode 100644 index 000000000..2b9ca0d2a --- /dev/null +++ b/docs/reference/api/InferenceServiceSettings.md @@ -0,0 +1,4 @@ +## `InferenceServiceSettings` +::: +type InferenceServiceSettings = any; +::: diff --git a/docs/reference/api/InferenceSparseEmbeddingInferenceResult.md b/docs/reference/api/InferenceSparseEmbeddingInferenceResult.md new file mode 100644 index 000000000..808e9afff --- /dev/null +++ b/docs/reference/api/InferenceSparseEmbeddingInferenceResult.md @@ -0,0 +1,5 @@ +## Interface `InferenceSparseEmbeddingInferenceResult` + +| Name | Type | Description | +| - | - | - | +| `sparse_embedding` | [InferenceSparseEmbeddingResult](./InferenceSparseEmbeddingResult.md)[] |   | diff --git a/docs/reference/api/InferenceSparseEmbeddingRequest.md b/docs/reference/api/InferenceSparseEmbeddingRequest.md new file mode 100644 index 000000000..b95db5187 --- /dev/null +++ b/docs/reference/api/InferenceSparseEmbeddingRequest.md @@ -0,0 +1,10 @@ +## Interface `InferenceSparseEmbeddingRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { inference_id?: never; timeout?: never; input?: never; task_settings?: never; }) | All values in `body` will be added to the request body. | +| `inference_id` | [Id](./Id.md) | The inference Id | +| `input` | string | string[] | Inference input. Either a string or an array of strings. | +| `querystring` | { [key: string]: any; } & { inference_id?: never; timeout?: never; input?: never; task_settings?: never; } | All values in `querystring` will be added to the request querystring. | +| `task_settings` | [InferenceTaskSettings](./InferenceTaskSettings.md) | Optional task settings | +| `timeout` | [Duration](./Duration.md) | Specifies the amount of time to wait for the inference request to complete. | diff --git a/docs/reference/api/InferenceSparseEmbeddingResponse.md b/docs/reference/api/InferenceSparseEmbeddingResponse.md new file mode 100644 index 000000000..67f2bc240 --- /dev/null +++ b/docs/reference/api/InferenceSparseEmbeddingResponse.md @@ -0,0 +1,4 @@ +## `InferenceSparseEmbeddingResponse` +::: +type InferenceSparseEmbeddingResponse = [InferenceSparseEmbeddingInferenceResult](./InferenceSparseEmbeddingInferenceResult.md); +::: diff --git a/docs/reference/api/InferenceSparseEmbeddingResult.md b/docs/reference/api/InferenceSparseEmbeddingResult.md new file mode 100644 index 000000000..1d6688a40 --- /dev/null +++ b/docs/reference/api/InferenceSparseEmbeddingResult.md @@ -0,0 +1,5 @@ +## Interface `InferenceSparseEmbeddingResult` + +| Name | Type | Description | +| - | - | - | +| `embedding` | [InferenceSparseVector](./InferenceSparseVector.md) |   | diff --git a/docs/reference/api/InferenceSparseVector.md b/docs/reference/api/InferenceSparseVector.md new file mode 100644 index 000000000..8c39bb607 --- /dev/null +++ b/docs/reference/api/InferenceSparseVector.md @@ -0,0 +1,4 @@ +## `InferenceSparseVector` +::: +type InferenceSparseVector = Record; +::: diff --git a/docs/reference/api/InferenceStreamCompletionRequest.md b/docs/reference/api/InferenceStreamCompletionRequest.md new file mode 100644 index 000000000..94a9d27b9 --- /dev/null +++ b/docs/reference/api/InferenceStreamCompletionRequest.md @@ -0,0 +1,9 @@ +## Interface `InferenceStreamCompletionRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { inference_id?: never; input?: never; task_settings?: never; }) | All values in `body` will be added to the request body. | +| `inference_id` | [Id](./Id.md) | The unique identifier for the inference endpoint. | +| `input` | string | string[] | The text on which you want to perform the inference task. It can be a single string or an array. NOTE: Inference endpoints for the completion task type currently only support a single string as input. | +| `querystring` | { [key: string]: any; } & { inference_id?: never; input?: never; task_settings?: never; } | All values in `querystring` will be added to the request querystring. | +| `task_settings` | [InferenceTaskSettings](./InferenceTaskSettings.md) | Optional task settings | diff --git a/docs/reference/api/InferenceStreamCompletionResponse.md b/docs/reference/api/InferenceStreamCompletionResponse.md new file mode 100644 index 000000000..df3482014 --- /dev/null +++ b/docs/reference/api/InferenceStreamCompletionResponse.md @@ -0,0 +1,4 @@ +## `InferenceStreamCompletionResponse` +::: +type InferenceStreamCompletionResponse = [StreamResult](./StreamResult.md); +::: diff --git a/docs/reference/api/InferenceTaskSettings.md b/docs/reference/api/InferenceTaskSettings.md new file mode 100644 index 000000000..bd0e19e6b --- /dev/null +++ b/docs/reference/api/InferenceTaskSettings.md @@ -0,0 +1,4 @@ +## `InferenceTaskSettings` +::: +type InferenceTaskSettings = any; +::: diff --git a/docs/reference/api/InferenceTaskType.md b/docs/reference/api/InferenceTaskType.md new file mode 100644 index 000000000..4cd397e87 --- /dev/null +++ b/docs/reference/api/InferenceTaskType.md @@ -0,0 +1,4 @@ +## `InferenceTaskType` +::: +type InferenceTaskType = 'sparse_embedding' | 'text_embedding' | 'rerank' | 'completion' | 'chat_completion'; +::: diff --git a/docs/reference/api/InferenceTextEmbeddingByteResult.md b/docs/reference/api/InferenceTextEmbeddingByteResult.md new file mode 100644 index 000000000..b07bf9302 --- /dev/null +++ b/docs/reference/api/InferenceTextEmbeddingByteResult.md @@ -0,0 +1,5 @@ +## Interface `InferenceTextEmbeddingByteResult` + +| Name | Type | Description | +| - | - | - | +| `embedding` | [InferenceDenseByteVector](./InferenceDenseByteVector.md) |   | diff --git a/docs/reference/api/InferenceTextEmbeddingInferenceResult.md b/docs/reference/api/InferenceTextEmbeddingInferenceResult.md new file mode 100644 index 000000000..af8392f6b --- /dev/null +++ b/docs/reference/api/InferenceTextEmbeddingInferenceResult.md @@ -0,0 +1,7 @@ +## Interface `InferenceTextEmbeddingInferenceResult` + +| Name | Type | Description | +| - | - | - | +| `text_embedding_bits` | [InferenceTextEmbeddingByteResult](./InferenceTextEmbeddingByteResult.md)[] |   | +| `text_embedding_bytes` | [InferenceTextEmbeddingByteResult](./InferenceTextEmbeddingByteResult.md)[] |   | +| `text_embedding` | [InferenceTextEmbeddingResult](./InferenceTextEmbeddingResult.md)[] |   | diff --git a/docs/reference/api/InferenceTextEmbeddingRequest.md b/docs/reference/api/InferenceTextEmbeddingRequest.md new file mode 100644 index 000000000..16b26b1df --- /dev/null +++ b/docs/reference/api/InferenceTextEmbeddingRequest.md @@ -0,0 +1,10 @@ +## Interface `InferenceTextEmbeddingRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { inference_id?: never; timeout?: never; input?: never; task_settings?: never; }) | All values in `body` will be added to the request body. | +| `inference_id` | [Id](./Id.md) | The inference Id | +| `input` | string | string[] | Inference input. Either a string or an array of strings. | +| `querystring` | { [key: string]: any; } & { inference_id?: never; timeout?: never; input?: never; task_settings?: never; } | All values in `querystring` will be added to the request querystring. | +| `task_settings` | [InferenceTaskSettings](./InferenceTaskSettings.md) | Optional task settings | +| `timeout` | [Duration](./Duration.md) | Specifies the amount of time to wait for the inference request to complete. | diff --git a/docs/reference/api/InferenceTextEmbeddingResponse.md b/docs/reference/api/InferenceTextEmbeddingResponse.md new file mode 100644 index 000000000..d729b7e54 --- /dev/null +++ b/docs/reference/api/InferenceTextEmbeddingResponse.md @@ -0,0 +1,4 @@ +## `InferenceTextEmbeddingResponse` +::: +type InferenceTextEmbeddingResponse = [InferenceTextEmbeddingInferenceResult](./InferenceTextEmbeddingInferenceResult.md); +::: diff --git a/docs/reference/api/InferenceTextEmbeddingResult.md b/docs/reference/api/InferenceTextEmbeddingResult.md new file mode 100644 index 000000000..4481cd7b3 --- /dev/null +++ b/docs/reference/api/InferenceTextEmbeddingResult.md @@ -0,0 +1,5 @@ +## Interface `InferenceTextEmbeddingResult` + +| Name | Type | Description | +| - | - | - | +| `embedding` | [InferenceDenseVector](./InferenceDenseVector.md) |   | diff --git a/docs/reference/api/InferenceToolCall.md b/docs/reference/api/InferenceToolCall.md new file mode 100644 index 000000000..f8698dd56 --- /dev/null +++ b/docs/reference/api/InferenceToolCall.md @@ -0,0 +1,7 @@ +## Interface `InferenceToolCall` + +| Name | Type | Description | +| - | - | - | +| `function` | [InferenceToolCallFunction](./InferenceToolCallFunction.md) | The function that the model called. | +| `id` | [Id](./Id.md) | The identifier of the tool call. | +| `type` | string | The type of the tool call. | diff --git a/docs/reference/api/InferenceToolCallFunction.md b/docs/reference/api/InferenceToolCallFunction.md new file mode 100644 index 000000000..69455b0b4 --- /dev/null +++ b/docs/reference/api/InferenceToolCallFunction.md @@ -0,0 +1,6 @@ +## Interface `InferenceToolCallFunction` + +| Name | Type | Description | +| - | - | - | +| `arguments` | string | The arguments to call the function with in JSON format. | +| `name` | string | The name of the function to call. | diff --git a/docs/reference/api/InferenceUpdateRequest.md b/docs/reference/api/InferenceUpdateRequest.md new file mode 100644 index 000000000..16b80eca0 --- /dev/null +++ b/docs/reference/api/InferenceUpdateRequest.md @@ -0,0 +1,9 @@ +## Interface `InferenceUpdateRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { inference_id?: never; task_type?: never; inference_config?: never; }) | All values in `body` will be added to the request body. | +| `inference_config` | [InferenceInferenceEndpoint](./InferenceInferenceEndpoint.md) |   | +| `inference_id` | [Id](./Id.md) | The unique identifier of the inference endpoint. | +| `querystring` | { [key: string]: any; } & { inference_id?: never; task_type?: never; inference_config?: never; } | All values in `querystring` will be added to the request querystring. | +| `task_type` | [InferenceTaskType](./InferenceTaskType.md) | The type of inference task that the model performs. | diff --git a/docs/reference/api/InferenceUpdateResponse.md b/docs/reference/api/InferenceUpdateResponse.md new file mode 100644 index 000000000..c6f71d63f --- /dev/null +++ b/docs/reference/api/InferenceUpdateResponse.md @@ -0,0 +1,4 @@ +## `InferenceUpdateResponse` +::: +type InferenceUpdateResponse = [InferenceInferenceEndpointInfo](./InferenceInferenceEndpointInfo.md); +::: diff --git a/docs/reference/api/InferenceVoyageAIServiceSettings.md b/docs/reference/api/InferenceVoyageAIServiceSettings.md new file mode 100644 index 000000000..eb7921df4 --- /dev/null +++ b/docs/reference/api/InferenceVoyageAIServiceSettings.md @@ -0,0 +1,8 @@ +## Interface `InferenceVoyageAIServiceSettings` + +| Name | Type | Description | +| - | - | - | +| `dimensions` | [integer](./integer.md) | The number of dimensions for resulting output embeddings. This setting maps to `output_dimension` in the VoyageAI documentation. Only for the `text_embedding` task type. | +| `embedding_type` | [float](./float.md) | The data type for the embeddings to be returned. This setting maps to `output_dtype` in the VoyageAI documentation. Permitted values: float, int8, bit. `int8` is a synonym of `byte` in the VoyageAI documentation. `bit` is a synonym of `binary` in the VoyageAI documentation. Only for the `text_embedding` task type. | +| `model_id` | string | The name of the model to use for the inference task. Refer to the VoyageAI documentation for the list of available text embedding and rerank models. | +| `rate_limit` | [InferenceRateLimitSetting](./InferenceRateLimitSetting.md) | This setting helps to minimize the number of rate limit errors returned from VoyageAI. The `voyageai` service sets a default number of requests allowed per minute depending on the task type. For both `text_embedding` and `rerank`, it is set to `2000`. | diff --git a/docs/reference/api/InferenceVoyageAIServiceType.md b/docs/reference/api/InferenceVoyageAIServiceType.md new file mode 100644 index 000000000..91404fe9d --- /dev/null +++ b/docs/reference/api/InferenceVoyageAIServiceType.md @@ -0,0 +1,4 @@ +## `InferenceVoyageAIServiceType` +::: +type InferenceVoyageAIServiceType = 'voyageai'; +::: diff --git a/docs/reference/api/InferenceVoyageAITaskSettings.md b/docs/reference/api/InferenceVoyageAITaskSettings.md new file mode 100644 index 000000000..c8180abe6 --- /dev/null +++ b/docs/reference/api/InferenceVoyageAITaskSettings.md @@ -0,0 +1,8 @@ +## Interface `InferenceVoyageAITaskSettings` + +| Name | Type | Description | +| - | - | - | +| `input_type` | string | Type of the input text. Permitted values: `ingest` (maps to `document` in the VoyageAI documentation), `search` (maps to `query` in the VoyageAI documentation). Only for the `text_embedding` task type. | +| `return_documents` | boolean | Whether to return the source documents in the response. Only for the `rerank` task type. | +| `top_k` | [integer](./integer.md) | The number of most relevant documents to return. If not specified, the reranking results of all documents will be returned. Only for the `rerank` task type. | +| `truncation` | boolean | Whether to truncate the input texts to fit within the context length. | diff --git a/docs/reference/api/InferenceVoyageAITaskType.md b/docs/reference/api/InferenceVoyageAITaskType.md new file mode 100644 index 000000000..46ab9e173 --- /dev/null +++ b/docs/reference/api/InferenceVoyageAITaskType.md @@ -0,0 +1,4 @@ +## `InferenceVoyageAITaskType` +::: +type InferenceVoyageAITaskType = 'text_embedding' | 'rerank'; +::: diff --git a/docs/reference/api/InferenceWatsonxServiceSettings.md b/docs/reference/api/InferenceWatsonxServiceSettings.md new file mode 100644 index 000000000..f9e70cac5 --- /dev/null +++ b/docs/reference/api/InferenceWatsonxServiceSettings.md @@ -0,0 +1,10 @@ +## Interface `InferenceWatsonxServiceSettings` + +| Name | Type | Description | +| - | - | - | +| `api_key` | string | A valid API key of your Watsonx account. You can find your Watsonx API keys or you can create a new one on the API keys page. IMPORTANT: You need to provide the API key only once, during the inference model creation. The get inference endpoint API does not retrieve your API key. After creating the inference model, you cannot change the associated API key. If you want to use a different API key, delete the inference model and recreate it with the same name and the updated API key. | +| `api_version` | string | A version parameter that takes a version date in the format of `YYYY-MM-DD`. For the active version data parameters, refer to the Wastonx documentation. | +| `model_id` | string | The name of the model to use for the inference task. Refer to the IBM Embedding Models section in the Watsonx documentation for the list of available text embedding models. | +| `project_id` | string | The identifier of the IBM Cloud project to use for the inference task. | +| `rate_limit` | [InferenceRateLimitSetting](./InferenceRateLimitSetting.md) | This setting helps to minimize the number of rate limit errors returned from Watsonx. By default, the `watsonxai` service sets the number of requests allowed per minute to 120. | +| `url` | string | The URL of the inference endpoint that you created on Watsonx. | diff --git a/docs/reference/api/InferenceWatsonxServiceType.md b/docs/reference/api/InferenceWatsonxServiceType.md new file mode 100644 index 000000000..18018d665 --- /dev/null +++ b/docs/reference/api/InferenceWatsonxServiceType.md @@ -0,0 +1,4 @@ +## `InferenceWatsonxServiceType` +::: +type InferenceWatsonxServiceType = 'watsonxai'; +::: diff --git a/docs/reference/api/InferenceWatsonxTaskType.md b/docs/reference/api/InferenceWatsonxTaskType.md new file mode 100644 index 000000000..d71520a77 --- /dev/null +++ b/docs/reference/api/InferenceWatsonxTaskType.md @@ -0,0 +1,4 @@ +## `InferenceWatsonxTaskType` +::: +type InferenceWatsonxTaskType = 'text_embedding'; +::: diff --git a/docs/reference/api/InfoApi_1.md b/docs/reference/api/InfoApi_1.md new file mode 100644 index 000000000..d4faa65b8 --- /dev/null +++ b/docs/reference/api/InfoApi_1.md @@ -0,0 +1,3 @@ +::: +default function InfoApi(this: [That](./That.md), params?: [InfoRequest](./InfoRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[InfoResponse](./InfoResponse.md)>; +::: diff --git a/docs/reference/api/InfoApi_2.md b/docs/reference/api/InfoApi_2.md new file mode 100644 index 000000000..f0a0f7229 --- /dev/null +++ b/docs/reference/api/InfoApi_2.md @@ -0,0 +1,3 @@ +::: +default function InfoApi(this: [That](./That.md), params?: [InfoRequest](./InfoRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[InfoResponse](./InfoResponse.md), unknown>>; +::: diff --git a/docs/reference/api/InfoApi_3.md b/docs/reference/api/InfoApi_3.md new file mode 100644 index 000000000..6268aa1d9 --- /dev/null +++ b/docs/reference/api/InfoApi_3.md @@ -0,0 +1,3 @@ +::: +default function InfoApi(this: [That](./That.md), params?: [InfoRequest](./InfoRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[InfoResponse](./InfoResponse.md)>; +::: diff --git a/docs/reference/api/InfoRequest.md b/docs/reference/api/InfoRequest.md new file mode 100644 index 000000000..9a1532658 --- /dev/null +++ b/docs/reference/api/InfoRequest.md @@ -0,0 +1,6 @@ +## Interface `InfoRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | { [key: string]: any; } | All values in `body` will be added to the request body. | +| `querystring` | { [key: string]: any; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/InfoResponse.md b/docs/reference/api/InfoResponse.md new file mode 100644 index 000000000..6f98b0574 --- /dev/null +++ b/docs/reference/api/InfoResponse.md @@ -0,0 +1,9 @@ +## Interface `InfoResponse` + +| Name | Type | Description | +| - | - | - | +| `cluster_name` | [Name](./Name.md) | The responding cluster's name. | +| `cluster_uuid` | [Uuid](./Uuid.md) |   | +| `name` | [Name](./Name.md) | The responding node's name. | +| `tagline` | string |   | +| `version` | [ElasticsearchVersionInfo](./ElasticsearchVersionInfo.md) | The running version of Elasticsearch. | diff --git a/docs/reference/api/Ingest.md b/docs/reference/api/Ingest.md new file mode 100644 index 000000000..5a6da0139 --- /dev/null +++ b/docs/reference/api/Ingest.md @@ -0,0 +1,20 @@ +## `Ingest` + +### Constructor + +::: +new Ingest(transport: [Transport](./Transport.md)); +::: + +### Properties + +| Name | Type | Description | +| - | - | - | +| `acceptedParams` | Record |   | +| `transport` | [Transport](./Transport.md) |   | + +### Methods + +| Name | Signature | Description | +| - | - | - | +| `deleteGeoipDatabase` | `deleteGeoipDatabase(this: [That](./That.md), params: [IngestDeleteGeoipDatabaseRequest](./IngestDeleteGeoipDatabaseRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[IngestDeleteGeoipDatabaseResponse](./IngestDeleteGeoipDatabaseResponse.md)>;` | Delete GeoIP database configurations. Delete one or more IP geolocation database configurations. || `deleteGeoipDatabase` | `deleteGeoipDatabase(this: [That](./That.md), params: [IngestDeleteGeoipDatabaseRequest](./IngestDeleteGeoipDatabaseRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[IngestDeleteGeoipDatabaseResponse](./IngestDeleteGeoipDatabaseResponse.md), unknown>>;` |   || `deleteGeoipDatabase` | `deleteGeoipDatabase(this: [That](./That.md), params: [IngestDeleteGeoipDatabaseRequest](./IngestDeleteGeoipDatabaseRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[IngestDeleteGeoipDatabaseResponse](./IngestDeleteGeoipDatabaseResponse.md)>;` |   || `deleteIpLocationDatabase` | `deleteIpLocationDatabase(this: [That](./That.md), params: [IngestDeleteIpLocationDatabaseRequest](./IngestDeleteIpLocationDatabaseRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[IngestDeleteIpLocationDatabaseResponse](./IngestDeleteIpLocationDatabaseResponse.md)>;` | Delete IP geolocation database configurations. || `deleteIpLocationDatabase` | `deleteIpLocationDatabase(this: [That](./That.md), params: [IngestDeleteIpLocationDatabaseRequest](./IngestDeleteIpLocationDatabaseRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[IngestDeleteIpLocationDatabaseResponse](./IngestDeleteIpLocationDatabaseResponse.md), unknown>>;` |   || `deleteIpLocationDatabase` | `deleteIpLocationDatabase(this: [That](./That.md), params: [IngestDeleteIpLocationDatabaseRequest](./IngestDeleteIpLocationDatabaseRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[IngestDeleteIpLocationDatabaseResponse](./IngestDeleteIpLocationDatabaseResponse.md)>;` |   || `deletePipeline` | `deletePipeline(this: [That](./That.md), params: [IngestDeletePipelineRequest](./IngestDeletePipelineRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[IngestDeletePipelineResponse](./IngestDeletePipelineResponse.md)>;` | Delete pipelines. Delete one or more ingest pipelines. || `deletePipeline` | `deletePipeline(this: [That](./That.md), params: [IngestDeletePipelineRequest](./IngestDeletePipelineRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[IngestDeletePipelineResponse](./IngestDeletePipelineResponse.md), unknown>>;` |   || `deletePipeline` | `deletePipeline(this: [That](./That.md), params: [IngestDeletePipelineRequest](./IngestDeletePipelineRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[IngestDeletePipelineResponse](./IngestDeletePipelineResponse.md)>;` |   || `geoIpStats` | `geoIpStats(this: [That](./That.md), params?: [IngestGeoIpStatsRequest](./IngestGeoIpStatsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[IngestGeoIpStatsResponse](./IngestGeoIpStatsResponse.md)>;` | Get GeoIP statistics. Get download statistics for GeoIP2 databases that are used with the GeoIP processor. || `geoIpStats` | `geoIpStats(this: [That](./That.md), params?: [IngestGeoIpStatsRequest](./IngestGeoIpStatsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[IngestGeoIpStatsResponse](./IngestGeoIpStatsResponse.md), unknown>>;` |   || `geoIpStats` | `geoIpStats(this: [That](./That.md), params?: [IngestGeoIpStatsRequest](./IngestGeoIpStatsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[IngestGeoIpStatsResponse](./IngestGeoIpStatsResponse.md)>;` |   || `getGeoipDatabase` | `getGeoipDatabase(this: [That](./That.md), params?: [IngestGetGeoipDatabaseRequest](./IngestGetGeoipDatabaseRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[IngestGetGeoipDatabaseResponse](./IngestGetGeoipDatabaseResponse.md)>;` | Get GeoIP database configurations. Get information about one or more IP geolocation database configurations. || `getGeoipDatabase` | `getGeoipDatabase(this: [That](./That.md), params?: [IngestGetGeoipDatabaseRequest](./IngestGetGeoipDatabaseRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[IngestGetGeoipDatabaseResponse](./IngestGetGeoipDatabaseResponse.md), unknown>>;` |   || `getGeoipDatabase` | `getGeoipDatabase(this: [That](./That.md), params?: [IngestGetGeoipDatabaseRequest](./IngestGetGeoipDatabaseRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[IngestGetGeoipDatabaseResponse](./IngestGetGeoipDatabaseResponse.md)>;` |   || `getIpLocationDatabase` | `getIpLocationDatabase(this: [That](./That.md), params?: [IngestGetIpLocationDatabaseRequest](./IngestGetIpLocationDatabaseRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[IngestGetIpLocationDatabaseResponse](./IngestGetIpLocationDatabaseResponse.md)>;` | Get IP geolocation database configurations. || `getIpLocationDatabase` | `getIpLocationDatabase(this: [That](./That.md), params?: [IngestGetIpLocationDatabaseRequest](./IngestGetIpLocationDatabaseRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[IngestGetIpLocationDatabaseResponse](./IngestGetIpLocationDatabaseResponse.md), unknown>>;` |   || `getIpLocationDatabase` | `getIpLocationDatabase(this: [That](./That.md), params?: [IngestGetIpLocationDatabaseRequest](./IngestGetIpLocationDatabaseRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[IngestGetIpLocationDatabaseResponse](./IngestGetIpLocationDatabaseResponse.md)>;` |   || `getPipeline` | `getPipeline(this: [That](./That.md), params?: [IngestGetPipelineRequest](./IngestGetPipelineRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[IngestGetPipelineResponse](./IngestGetPipelineResponse.md)>;` | Get pipelines. Get information about one or more ingest pipelines. This API returns a local reference of the pipeline. || `getPipeline` | `getPipeline(this: [That](./That.md), params?: [IngestGetPipelineRequest](./IngestGetPipelineRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[IngestGetPipelineResponse](./IngestGetPipelineResponse.md), unknown>>;` |   || `getPipeline` | `getPipeline(this: [That](./That.md), params?: [IngestGetPipelineRequest](./IngestGetPipelineRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[IngestGetPipelineResponse](./IngestGetPipelineResponse.md)>;` |   || `processorGrok` | `processorGrok(this: [That](./That.md), params?: [IngestProcessorGrokRequest](./IngestProcessorGrokRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[IngestProcessorGrokResponse](./IngestProcessorGrokResponse.md)>;` | Run a grok processor. Extract structured fields out of a single text field within a document. You must choose which field to extract matched fields from, as well as the grok pattern you expect will match. A grok pattern is like a regular expression that supports aliased expressions that can be reused. || `processorGrok` | `processorGrok(this: [That](./That.md), params?: [IngestProcessorGrokRequest](./IngestProcessorGrokRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[IngestProcessorGrokResponse](./IngestProcessorGrokResponse.md), unknown>>;` |   || `processorGrok` | `processorGrok(this: [That](./That.md), params?: [IngestProcessorGrokRequest](./IngestProcessorGrokRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[IngestProcessorGrokResponse](./IngestProcessorGrokResponse.md)>;` |   || `putGeoipDatabase` | `putGeoipDatabase(this: [That](./That.md), params: [IngestPutGeoipDatabaseRequest](./IngestPutGeoipDatabaseRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[IngestPutGeoipDatabaseResponse](./IngestPutGeoipDatabaseResponse.md)>;` | Create or update a GeoIP database configuration. Refer to the create or update IP geolocation database configuration API. || `putGeoipDatabase` | `putGeoipDatabase(this: [That](./That.md), params: [IngestPutGeoipDatabaseRequest](./IngestPutGeoipDatabaseRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[IngestPutGeoipDatabaseResponse](./IngestPutGeoipDatabaseResponse.md), unknown>>;` |   || `putGeoipDatabase` | `putGeoipDatabase(this: [That](./That.md), params: [IngestPutGeoipDatabaseRequest](./IngestPutGeoipDatabaseRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[IngestPutGeoipDatabaseResponse](./IngestPutGeoipDatabaseResponse.md)>;` |   || `putIpLocationDatabase` | `putIpLocationDatabase(this: [That](./That.md), params: [IngestPutIpLocationDatabaseRequest](./IngestPutIpLocationDatabaseRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[IngestPutIpLocationDatabaseResponse](./IngestPutIpLocationDatabaseResponse.md)>;` | Create or update an IP geolocation database configuration. || `putIpLocationDatabase` | `putIpLocationDatabase(this: [That](./That.md), params: [IngestPutIpLocationDatabaseRequest](./IngestPutIpLocationDatabaseRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[IngestPutIpLocationDatabaseResponse](./IngestPutIpLocationDatabaseResponse.md), unknown>>;` |   || `putIpLocationDatabase` | `putIpLocationDatabase(this: [That](./That.md), params: [IngestPutIpLocationDatabaseRequest](./IngestPutIpLocationDatabaseRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[IngestPutIpLocationDatabaseResponse](./IngestPutIpLocationDatabaseResponse.md)>;` |   || `putPipeline` | `putPipeline(this: [That](./That.md), params: [IngestPutPipelineRequest](./IngestPutPipelineRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[IngestPutPipelineResponse](./IngestPutPipelineResponse.md)>;` | Create or update a pipeline. Changes made using this API take effect immediately. || `putPipeline` | `putPipeline(this: [That](./That.md), params: [IngestPutPipelineRequest](./IngestPutPipelineRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[IngestPutPipelineResponse](./IngestPutPipelineResponse.md), unknown>>;` |   || `putPipeline` | `putPipeline(this: [That](./That.md), params: [IngestPutPipelineRequest](./IngestPutPipelineRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[IngestPutPipelineResponse](./IngestPutPipelineResponse.md)>;` |   || `simulate` | `simulate(this: [That](./That.md), params: [IngestSimulateRequest](./IngestSimulateRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[IngestSimulateResponse](./IngestSimulateResponse.md)>;` | Simulate a pipeline. Run an ingest pipeline against a set of provided documents. You can either specify an existing pipeline to use with the provided documents or supply a pipeline definition in the body of the request. || `simulate` | `simulate(this: [That](./That.md), params: [IngestSimulateRequest](./IngestSimulateRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[IngestSimulateResponse](./IngestSimulateResponse.md), unknown>>;` |   || `simulate` | `simulate(this: [That](./That.md), params: [IngestSimulateRequest](./IngestSimulateRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[IngestSimulateResponse](./IngestSimulateResponse.md)>;` |   | \ No newline at end of file diff --git a/docs/reference/api/IngestAppendProcessor.md b/docs/reference/api/IngestAppendProcessor.md new file mode 100644 index 000000000..993fbab23 --- /dev/null +++ b/docs/reference/api/IngestAppendProcessor.md @@ -0,0 +1,7 @@ +## Interface `IngestAppendProcessor` + +| Name | Type | Description | +| - | - | - | +| `allow_duplicates` | boolean | If `false`, the processor does not append values already present in the field. | +| `field` | [Field](./Field.md) | The field to be appended to. Supports template snippets. | +| `value` | any | any[] | The value to be appended. Supports template snippets. | diff --git a/docs/reference/api/IngestAttachmentProcessor.md b/docs/reference/api/IngestAttachmentProcessor.md new file mode 100644 index 000000000..50b567f26 --- /dev/null +++ b/docs/reference/api/IngestAttachmentProcessor.md @@ -0,0 +1,12 @@ +## Interface `IngestAttachmentProcessor` + +| Name | Type | Description | +| - | - | - | +| `field` | [Field](./Field.md) | The field to get the base64 encoded field from. | +| `ignore_missing` | boolean | If `true` and field does not exist, the processor quietly exits without modifying the document. | +| `indexed_chars_field` | [Field](./Field.md) | Field name from which you can overwrite the number of chars being used for extraction. | +| `indexed_chars` | [long](./long.md) | The number of chars being used for extraction to prevent huge fields. Use `-1` for no limit. | +| `properties` | string[] | Array of properties to select to be stored. Can be `content`, `title`, `name`, `author`, `keywords`, `date`, `content_type`, `content_length`, `language`. | +| `remove_binary` | boolean | If true, the binary field will be removed from the document | +| `resource_name` | string | Field containing the name of the resource to decode. If specified, the processor passes this resource name to the underlying Tika library to enable Resource Name Based Detection. | +| `target_field` | [Field](./Field.md) | The field that will hold the attachment information. | diff --git a/docs/reference/api/IngestBytesProcessor.md b/docs/reference/api/IngestBytesProcessor.md new file mode 100644 index 000000000..6708dd87c --- /dev/null +++ b/docs/reference/api/IngestBytesProcessor.md @@ -0,0 +1,7 @@ +## Interface `IngestBytesProcessor` + +| Name | Type | Description | +| - | - | - | +| `field` | [Field](./Field.md) | The field to convert. | +| `ignore_missing` | boolean | If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. | +| `target_field` | [Field](./Field.md) | The field to assign the converted value to. By default, the field is updated in-place. | diff --git a/docs/reference/api/IngestCircleProcessor.md b/docs/reference/api/IngestCircleProcessor.md new file mode 100644 index 000000000..6d1993900 --- /dev/null +++ b/docs/reference/api/IngestCircleProcessor.md @@ -0,0 +1,9 @@ +## Interface `IngestCircleProcessor` + +| Name | Type | Description | +| - | - | - | +| `error_distance` | [double](./double.md) | The difference between the resulting inscribed distance from center to side and the circle’s radius (measured in meters for `geo_shape`, unit-less for `shape`). | +| `field` | [Field](./Field.md) | The field to interpret as a circle. Either a string in WKT format or a map for GeoJSON. | +| `ignore_missing` | boolean | If `true` and `field` does not exist, the processor quietly exits without modifying the document. | +| `shape_type` | [IngestShapeType](./IngestShapeType.md) | Which field mapping type is to be used when processing the circle: `geo_shape` or `shape`. | +| `target_field` | [Field](./Field.md) | The field to assign the polygon shape to By default, the field is updated in-place. | diff --git a/docs/reference/api/IngestCommunityIDProcessor.md b/docs/reference/api/IngestCommunityIDProcessor.md new file mode 100644 index 000000000..9ae73ba52 --- /dev/null +++ b/docs/reference/api/IngestCommunityIDProcessor.md @@ -0,0 +1,15 @@ +## Interface `IngestCommunityIDProcessor` + +| Name | Type | Description | +| - | - | - | +| `destination_ip` | [Field](./Field.md) | Field containing the destination IP address. | +| `destination_port` | [Field](./Field.md) | Field containing the destination port. | +| `iana_number` | [Field](./Field.md) | Field containing the IANA number. | +| `icmp_code` | [Field](./Field.md) | Field containing the ICMP code. | +| `icmp_type` | [Field](./Field.md) | Field containing the ICMP type. | +| `ignore_missing` | boolean | If true and any required fields are missing, the processor quietly exits without modifying the document. | +| `seed` | [integer](./integer.md) | Seed for the community ID hash. Must be between 0 and 65535 (inclusive). The seed can prevent hash collisions between network domains, such as a staging and production network that use the same addressing scheme. | +| `source_ip` | [Field](./Field.md) | Field containing the source IP address. | +| `source_port` | [Field](./Field.md) | Field containing the source port. | +| `target_field` | [Field](./Field.md) | Output field for the community ID. | +| `transport` | [Field](./Field.md) | Field containing the transport protocol name or number. Used only when the iana_number field is not present. The following protocol names are currently supported: eigrp, gre, icmp, icmpv6, igmp, ipv6-icmp, ospf, pim, sctp, tcp, udp | diff --git a/docs/reference/api/IngestConvertProcessor.md b/docs/reference/api/IngestConvertProcessor.md new file mode 100644 index 000000000..89817c474 --- /dev/null +++ b/docs/reference/api/IngestConvertProcessor.md @@ -0,0 +1,8 @@ +## Interface `IngestConvertProcessor` + +| Name | Type | Description | +| - | - | - | +| `field` | [Field](./Field.md) | The field whose value is to be converted. | +| `ignore_missing` | boolean | If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. | +| `target_field` | [Field](./Field.md) | The field to assign the converted value to. By default, the `field` is updated in-place. | +| `type` | [IngestConvertType](./IngestConvertType.md) | The type to convert the existing value to. | diff --git a/docs/reference/api/IngestConvertType.md b/docs/reference/api/IngestConvertType.md new file mode 100644 index 000000000..b773077c9 --- /dev/null +++ b/docs/reference/api/IngestConvertType.md @@ -0,0 +1,4 @@ +## `IngestConvertType` +::: +type IngestConvertType = 'integer' | 'long' | 'double' | 'float' | 'boolean' | 'ip' | 'string' | 'auto'; +::: diff --git a/docs/reference/api/IngestCsvProcessor.md b/docs/reference/api/IngestCsvProcessor.md new file mode 100644 index 000000000..e29a1ee32 --- /dev/null +++ b/docs/reference/api/IngestCsvProcessor.md @@ -0,0 +1,11 @@ +## Interface `IngestCsvProcessor` + +| Name | Type | Description | +| - | - | - | +| `empty_value` | any | Value used to fill empty fields. Empty fields are skipped if this is not provided. An empty field is one with no value (2 consecutive separators) or empty quotes ( `""`). | +| `field` | [Field](./Field.md) | The field to extract data from. | +| `ignore_missing` | boolean | If `true` and `field` does not exist, the processor quietly exits without modifying the document. | +| `quote` | string | Quote used in CSV, has to be single character string. | +| `separator` | string | Separator used in CSV, has to be single character string. | +| `target_fields` | [Fields](./Fields.md) | The array of fields to assign extracted values to. | +| `trim` | boolean | Trim whitespaces in unquoted fields. | diff --git a/docs/reference/api/IngestDatabaseConfiguration.md b/docs/reference/api/IngestDatabaseConfiguration.md new file mode 100644 index 000000000..a497b6e48 --- /dev/null +++ b/docs/reference/api/IngestDatabaseConfiguration.md @@ -0,0 +1,7 @@ +## Interface `IngestDatabaseConfiguration` + +| Name | Type | Description | +| - | - | - | +| `ipinfo` | [IngestIpinfo](./IngestIpinfo.md) |   | +| `maxmind` | [IngestMaxmind](./IngestMaxmind.md) |   | +| `name` | [Name](./Name.md) | The provider-assigned name of the IP geolocation database to download. | diff --git a/docs/reference/api/IngestDatabaseConfigurationFull.md b/docs/reference/api/IngestDatabaseConfigurationFull.md new file mode 100644 index 000000000..031e32dd4 --- /dev/null +++ b/docs/reference/api/IngestDatabaseConfigurationFull.md @@ -0,0 +1,9 @@ +## Interface `IngestDatabaseConfigurationFull` + +| Name | Type | Description | +| - | - | - | +| `ipinfo` | [IngestIpinfo](./IngestIpinfo.md) |   | +| `local` | [IngestLocal](./IngestLocal.md) |   | +| `maxmind` | [IngestMaxmind](./IngestMaxmind.md) |   | +| `name` | [Name](./Name.md) | The provider-assigned name of the IP geolocation database to download. | +| `web` | [IngestWeb](./IngestWeb.md) |   | diff --git a/docs/reference/api/IngestDateIndexNameProcessor.md b/docs/reference/api/IngestDateIndexNameProcessor.md new file mode 100644 index 000000000..2e28480bb --- /dev/null +++ b/docs/reference/api/IngestDateIndexNameProcessor.md @@ -0,0 +1,11 @@ +## Interface `IngestDateIndexNameProcessor` + +| Name | Type | Description | +| - | - | - | +| `date_formats` | string[] | An array of the expected date formats for parsing dates / timestamps in the document being preprocessed. Can be a java time pattern or one of the following formats: ISO8601, UNIX, UNIX_MS, or TAI64N. | +| `date_rounding` | string | How to round the date when formatting the date into the index name. Valid values are: `y` (year), `M` (month), `w` (week), `d` (day), `h` (hour), `m` (minute) and `s` (second). Supports template snippets. | +| `field` | [Field](./Field.md) | The field to get the date or timestamp from. | +| `index_name_format` | string | The format to be used when printing the parsed date into the index name. A valid java time pattern is expected here. Supports template snippets. | +| `index_name_prefix` | string | A prefix of the index name to be prepended before the printed date. Supports template snippets. | +| `locale` | string | The locale to use when parsing the date from the document being preprocessed, relevant when parsing month names or week days. | +| `timezone` | string | The timezone to use when parsing the date and when date math index supports resolves expressions into concrete index names. | diff --git a/docs/reference/api/IngestDateProcessor.md b/docs/reference/api/IngestDateProcessor.md new file mode 100644 index 000000000..bf2bf7161 --- /dev/null +++ b/docs/reference/api/IngestDateProcessor.md @@ -0,0 +1,10 @@ +## Interface `IngestDateProcessor` + +| Name | Type | Description | +| - | - | - | +| `field` | [Field](./Field.md) | The field to get the date from. | +| `formats` | string[] | An array of the expected date formats. Can be a java time pattern or one of the following formats: ISO8601, UNIX, UNIX_MS, or TAI64N. | +| `locale` | string | The locale to use when parsing the date, relevant when parsing month names or week days. Supports template snippets. | +| `output_format` | string | The format to use when writing the date to target_field. Must be a valid java time pattern. | +| `target_field` | [Field](./Field.md) | The field that will hold the parsed date. | +| `timezone` | string | The timezone to use when parsing the date. Supports template snippets. | diff --git a/docs/reference/api/IngestDeleteGeoipDatabaseRequest.md b/docs/reference/api/IngestDeleteGeoipDatabaseRequest.md new file mode 100644 index 000000000..dbd143862 --- /dev/null +++ b/docs/reference/api/IngestDeleteGeoipDatabaseRequest.md @@ -0,0 +1,9 @@ +## Interface `IngestDeleteGeoipDatabaseRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { id?: never; master_timeout?: never; timeout?: never; }) | All values in `body` will be added to the request body. | +| `id` | [Ids](./Ids.md) | A comma-separated list of geoip database configurations to delete | +| `master_timeout` | [Duration](./Duration.md) | The period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. | +| `querystring` | { [key: string]: any; } & { id?: never; master_timeout?: never; timeout?: never; } | All values in `querystring` will be added to the request querystring. | +| `timeout` | [Duration](./Duration.md) | The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. | diff --git a/docs/reference/api/IngestDeleteGeoipDatabaseResponse.md b/docs/reference/api/IngestDeleteGeoipDatabaseResponse.md new file mode 100644 index 000000000..718856739 --- /dev/null +++ b/docs/reference/api/IngestDeleteGeoipDatabaseResponse.md @@ -0,0 +1,4 @@ +## `IngestDeleteGeoipDatabaseResponse` +::: +type IngestDeleteGeoipDatabaseResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); +::: diff --git a/docs/reference/api/IngestDeleteIpLocationDatabaseRequest.md b/docs/reference/api/IngestDeleteIpLocationDatabaseRequest.md new file mode 100644 index 000000000..960e9787e --- /dev/null +++ b/docs/reference/api/IngestDeleteIpLocationDatabaseRequest.md @@ -0,0 +1,9 @@ +## Interface `IngestDeleteIpLocationDatabaseRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { id?: never; master_timeout?: never; timeout?: never; }) | All values in `body` will be added to the request body. | +| `id` | [Ids](./Ids.md) | A comma-separated list of IP location database configurations. | +| `master_timeout` | [Duration](./Duration.md) | The period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. A value of `-1` indicates that the request should never time out. | +| `querystring` | { [key: string]: any; } & { id?: never; master_timeout?: never; timeout?: never; } | All values in `querystring` will be added to the request querystring. | +| `timeout` | [Duration](./Duration.md) | The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. A value of `-1` indicates that the request should never time out. | diff --git a/docs/reference/api/IngestDeleteIpLocationDatabaseResponse.md b/docs/reference/api/IngestDeleteIpLocationDatabaseResponse.md new file mode 100644 index 000000000..b96af4706 --- /dev/null +++ b/docs/reference/api/IngestDeleteIpLocationDatabaseResponse.md @@ -0,0 +1,4 @@ +## `IngestDeleteIpLocationDatabaseResponse` +::: +type IngestDeleteIpLocationDatabaseResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); +::: diff --git a/docs/reference/api/IngestDeletePipelineRequest.md b/docs/reference/api/IngestDeletePipelineRequest.md new file mode 100644 index 000000000..97b81a45c --- /dev/null +++ b/docs/reference/api/IngestDeletePipelineRequest.md @@ -0,0 +1,9 @@ +## Interface `IngestDeletePipelineRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { id?: never; master_timeout?: never; timeout?: never; }) | All values in `body` will be added to the request body. | +| `id` | [Id](./Id.md) | Pipeline ID or wildcard expression of pipeline IDs used to limit the request. To delete all ingest pipelines in a cluster, use a value of `*`. | +| `master_timeout` | [Duration](./Duration.md) | Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. | +| `querystring` | { [key: string]: any; } & { id?: never; master_timeout?: never; timeout?: never; } | All values in `querystring` will be added to the request querystring. | +| `timeout` | [Duration](./Duration.md) | Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. | diff --git a/docs/reference/api/IngestDeletePipelineResponse.md b/docs/reference/api/IngestDeletePipelineResponse.md new file mode 100644 index 000000000..caebb1912 --- /dev/null +++ b/docs/reference/api/IngestDeletePipelineResponse.md @@ -0,0 +1,4 @@ +## `IngestDeletePipelineResponse` +::: +type IngestDeletePipelineResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); +::: diff --git a/docs/reference/api/IngestDissectProcessor.md b/docs/reference/api/IngestDissectProcessor.md new file mode 100644 index 000000000..cd13dbf52 --- /dev/null +++ b/docs/reference/api/IngestDissectProcessor.md @@ -0,0 +1,8 @@ +## Interface `IngestDissectProcessor` + +| Name | Type | Description | +| - | - | - | +| `append_separator` | string | The character(s) that separate the appended fields. | +| `field` | [Field](./Field.md) | The field to dissect. | +| `ignore_missing` | boolean | If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. | +| `pattern` | string | The pattern to apply to the field. | diff --git a/docs/reference/api/IngestDocument.md b/docs/reference/api/IngestDocument.md new file mode 100644 index 000000000..e1bc88a0c --- /dev/null +++ b/docs/reference/api/IngestDocument.md @@ -0,0 +1,7 @@ +## Interface `IngestDocument` + +| Name | Type | Description | +| - | - | - | +| `_id` | [Id](./Id.md) | Unique identifier for the document. This ID must be unique within the `_index`. | +| `_index` | [IndexName](./IndexName.md) | Name of the index containing the document. | +| `_source` | any | JSON body for the document. | diff --git a/docs/reference/api/IngestDocumentSimulation.md b/docs/reference/api/IngestDocumentSimulation.md new file mode 100644 index 000000000..275eedc87 --- /dev/null +++ b/docs/reference/api/IngestDocumentSimulation.md @@ -0,0 +1,4 @@ +## `IngestDocumentSimulation` +::: +type IngestDocumentSimulation = [IngestDocumentSimulationKeys](./IngestDocumentSimulationKeys.md) & { [property: string]: string | [Id](./Id.md) | [IndexName](./IndexName.md) | [IngestIngest](./IngestIngest.md) | Record | [SpecUtilsStringified](./SpecUtilsStringified.md)<[VersionNumber](./VersionNumber.md)> | [VersionType](./VersionType.md);}; +::: diff --git a/docs/reference/api/IngestDocumentSimulationKeys.md b/docs/reference/api/IngestDocumentSimulationKeys.md new file mode 100644 index 000000000..df9569512 --- /dev/null +++ b/docs/reference/api/IngestDocumentSimulationKeys.md @@ -0,0 +1,11 @@ +## Interface `IngestDocumentSimulationKeys` + +| Name | Type | Description | +| - | - | - | +| `_id` | [Id](./Id.md) | Unique identifier for the document. This ID must be unique within the `_index`. | +| `_index` | [IndexName](./IndexName.md) | Name of the index containing the document. | +| `_ingest` | [IngestIngest](./IngestIngest.md) |   | +| `_routing` | string | Value used to send the document to a specific primary shard. | +| `_source` | Record | JSON body for the document. | +| `_version_type` | [VersionType](./VersionType.md) |   | +| `_version` | [SpecUtilsStringified](./SpecUtilsStringified.md)<[VersionNumber](./VersionNumber.md)> |   | diff --git a/docs/reference/api/IngestDotExpanderProcessor.md b/docs/reference/api/IngestDotExpanderProcessor.md new file mode 100644 index 000000000..47fefb449 --- /dev/null +++ b/docs/reference/api/IngestDotExpanderProcessor.md @@ -0,0 +1,7 @@ +## Interface `IngestDotExpanderProcessor` + +| Name | Type | Description | +| - | - | - | +| `field` | [Field](./Field.md) | The field to expand into an object field. If set to `*`, all top-level fields will be expanded. | +| `override` | boolean | Controls the behavior when there is already an existing nested object that conflicts with the expanded field. When `false`, the processor will merge conflicts by combining the old and the new values into an array. When `true`, the value from the expanded field will overwrite the existing value. | +| `path` | string | The field that contains the field to expand. Only required if the field to expand is part another object field, because the `field` option can only understand leaf fields. | diff --git a/docs/reference/api/IngestDropProcessor.md b/docs/reference/api/IngestDropProcessor.md new file mode 100644 index 000000000..169a295a7 --- /dev/null +++ b/docs/reference/api/IngestDropProcessor.md @@ -0,0 +1,4 @@ +## Interface `IngestDropProcessor` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/IngestEnrichProcessor.md b/docs/reference/api/IngestEnrichProcessor.md new file mode 100644 index 000000000..4d0707392 --- /dev/null +++ b/docs/reference/api/IngestEnrichProcessor.md @@ -0,0 +1,11 @@ +## Interface `IngestEnrichProcessor` + +| Name | Type | Description | +| - | - | - | +| `field` | [Field](./Field.md) | The field in the input document that matches the policies match_field used to retrieve the enrichment data. Supports template snippets. | +| `ignore_missing` | boolean | If `true` and `field` does not exist, the processor quietly exits without modifying the document. | +| `max_matches` | [integer](./integer.md) | The maximum number of matched documents to include under the configured target field. The `target_field` will be turned into a json array if `max_matches` is higher than 1, otherwise `target_field` will become a json object. In order to avoid documents getting too large, the maximum allowed value is 128. | +| `override` | boolean | If processor will update fields with pre-existing non-null-valued field. When set to `false`, such fields will not be touched. | +| `policy_name` | string | The name of the enrich policy to use. | +| `shape_relation` | [GeoShapeRelation](./GeoShapeRelation.md) | A spatial relation operator used to match the geoshape of incoming documents to documents in the enrich index. This option is only used for `geo_match` enrich policy types. | +| `target_field` | [Field](./Field.md) | Field added to incoming documents to contain enrich data. This field contains both the `match_field` and `enrich_fields` specified in the enrich policy. Supports template snippets. | diff --git a/docs/reference/api/IngestFailProcessor.md b/docs/reference/api/IngestFailProcessor.md new file mode 100644 index 000000000..a191ed5c4 --- /dev/null +++ b/docs/reference/api/IngestFailProcessor.md @@ -0,0 +1,5 @@ +## Interface `IngestFailProcessor` + +| Name | Type | Description | +| - | - | - | +| `message` | string | The error message thrown by the processor. Supports template snippets. | diff --git a/docs/reference/api/IngestFingerprintDigest.md b/docs/reference/api/IngestFingerprintDigest.md new file mode 100644 index 000000000..13f9c2b19 --- /dev/null +++ b/docs/reference/api/IngestFingerprintDigest.md @@ -0,0 +1,4 @@ +## `IngestFingerprintDigest` +::: +type IngestFingerprintDigest = 'MD5' | 'SHA-1' | 'SHA-256' | 'SHA-512' | 'MurmurHash3'; +::: diff --git a/docs/reference/api/IngestFingerprintProcessor.md b/docs/reference/api/IngestFingerprintProcessor.md new file mode 100644 index 000000000..38160d370 --- /dev/null +++ b/docs/reference/api/IngestFingerprintProcessor.md @@ -0,0 +1,9 @@ +## Interface `IngestFingerprintProcessor` + +| Name | Type | Description | +| - | - | - | +| `fields` | [Fields](./Fields.md) | Array of fields to include in the fingerprint. For objects, the processor hashes both the field key and value. For other fields, the processor hashes only the field value. | +| `ignore_missing` | boolean | If true, the processor ignores any missing fields. If all fields are missing, the processor silently exits without modifying the document. | +| `method` | [IngestFingerprintDigest](./IngestFingerprintDigest.md) | The hash method used to compute the fingerprint. Must be one of MD5, SHA-1, SHA-256, SHA-512, or MurmurHash3. | +| `salt` | string | Salt value for the hash function. | +| `target_field` | [Field](./Field.md) | Output field for the fingerprint. | diff --git a/docs/reference/api/IngestForeachProcessor.md b/docs/reference/api/IngestForeachProcessor.md new file mode 100644 index 000000000..690b09748 --- /dev/null +++ b/docs/reference/api/IngestForeachProcessor.md @@ -0,0 +1,7 @@ +## Interface `IngestForeachProcessor` + +| Name | Type | Description | +| - | - | - | +| `field` | [Field](./Field.md) | Field containing array or object values. | +| `ignore_missing` | boolean | If `true`, the processor silently exits without changing the document if the `field` is `null` or missing. | +| `processor` | [IngestProcessorContainer](./IngestProcessorContainer.md) | Ingest processor to run on each element. | diff --git a/docs/reference/api/IngestGeoGridProcessor.md b/docs/reference/api/IngestGeoGridProcessor.md new file mode 100644 index 000000000..fc50aecf4 --- /dev/null +++ b/docs/reference/api/IngestGeoGridProcessor.md @@ -0,0 +1,13 @@ +## Interface `IngestGeoGridProcessor` + +| Name | Type | Description | +| - | - | - | +| `children_field` | [Field](./Field.md) | If specified and children tiles exist, save those tile addresses to this field as an array of strings. | +| `field` | string | The field to interpret as a geo-tile.= The field format is determined by the `tile_type`. | +| `ignore_missing` | boolean | If `true` and `field` does not exist, the processor quietly exits without modifying the document. | +| `non_children_field` | [Field](./Field.md) | If specified and intersecting non-child tiles exist, save their addresses to this field as an array of strings. | +| `parent_field` | [Field](./Field.md) | If specified and a parent tile exists, save that tile address to this field. | +| `precision_field` | [Field](./Field.md) | If specified, save the tile precision (zoom) as an integer to this field. | +| `target_field` | [Field](./Field.md) | The field to assign the polygon shape to, by default, the `field` is updated in-place. | +| `target_format` | [IngestGeoGridTargetFormat](./IngestGeoGridTargetFormat.md) | Which format to save the generated polygon in. | +| `tile_type` | [IngestGeoGridTileType](./IngestGeoGridTileType.md) | Three tile formats are understood: geohash, geotile and geohex. | diff --git a/docs/reference/api/IngestGeoGridTargetFormat.md b/docs/reference/api/IngestGeoGridTargetFormat.md new file mode 100644 index 000000000..d82c469fa --- /dev/null +++ b/docs/reference/api/IngestGeoGridTargetFormat.md @@ -0,0 +1,4 @@ +## `IngestGeoGridTargetFormat` +::: +type IngestGeoGridTargetFormat = 'geojson' | 'wkt'; +::: diff --git a/docs/reference/api/IngestGeoGridTileType.md b/docs/reference/api/IngestGeoGridTileType.md new file mode 100644 index 000000000..7d06684da --- /dev/null +++ b/docs/reference/api/IngestGeoGridTileType.md @@ -0,0 +1,4 @@ +## `IngestGeoGridTileType` +::: +type IngestGeoGridTileType = 'geotile' | 'geohex' | 'geohash'; +::: diff --git a/docs/reference/api/IngestGeoIpProcessor.md b/docs/reference/api/IngestGeoIpProcessor.md new file mode 100644 index 000000000..a24ab9709 --- /dev/null +++ b/docs/reference/api/IngestGeoIpProcessor.md @@ -0,0 +1,11 @@ +## Interface `IngestGeoIpProcessor` + +| Name | Type | Description | +| - | - | - | +| `database_file` | string | The database filename referring to a database the module ships with (GeoLite2-City.mmdb, GeoLite2-Country.mmdb, or GeoLite2-ASN.mmdb) or a custom database in the ingest-geoip config directory. | +| `download_database_on_pipeline_creation` | boolean | If `true` (and if `ingest.geoip.downloader.eager.download` is `false`), the missing database is downloaded when the pipeline is created. Else, the download is triggered by when the pipeline is used as the `default_pipeline` or `final_pipeline` in an index. | +| `field` | [Field](./Field.md) | The field to get the ip address from for the geographical lookup. | +| `first_only` | boolean | If `true`, only the first found geoip data will be returned, even if the field contains an array. | +| `ignore_missing` | boolean | If `true` and `field` does not exist, the processor quietly exits without modifying the document. | +| `properties` | string[] | Controls what properties are added to the `target_field` based on the geoip lookup. | +| `target_field` | [Field](./Field.md) | The field that will hold the geographical information looked up from the MaxMind database. | diff --git a/docs/reference/api/IngestGeoIpStatsGeoIpDownloadStatistics.md b/docs/reference/api/IngestGeoIpStatsGeoIpDownloadStatistics.md new file mode 100644 index 000000000..bcf03db86 --- /dev/null +++ b/docs/reference/api/IngestGeoIpStatsGeoIpDownloadStatistics.md @@ -0,0 +1,10 @@ +## Interface `IngestGeoIpStatsGeoIpDownloadStatistics` + +| Name | Type | Description | +| - | - | - | +| `databases_count` | [integer](./integer.md) | Current number of databases available for use. | +| `expired_databases` | [integer](./integer.md) | Total number of databases not updated after 30 days | +| `failed_downloads` | [integer](./integer.md) | Total number of failed database downloads. | +| `skipped_updates` | [integer](./integer.md) | Total number of database updates skipped. | +| `successful_downloads` | [integer](./integer.md) | Total number of successful database downloads. | +| `total_download_time` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> | Total milliseconds spent downloading databases. | diff --git a/docs/reference/api/IngestGeoIpStatsGeoIpNodeDatabaseName.md b/docs/reference/api/IngestGeoIpStatsGeoIpNodeDatabaseName.md new file mode 100644 index 000000000..fae2ec780 --- /dev/null +++ b/docs/reference/api/IngestGeoIpStatsGeoIpNodeDatabaseName.md @@ -0,0 +1,5 @@ +## Interface `IngestGeoIpStatsGeoIpNodeDatabaseName` + +| Name | Type | Description | +| - | - | - | +| `name` | [Name](./Name.md) | Name of the database. | diff --git a/docs/reference/api/IngestGeoIpStatsGeoIpNodeDatabases.md b/docs/reference/api/IngestGeoIpStatsGeoIpNodeDatabases.md new file mode 100644 index 000000000..31a118dd7 --- /dev/null +++ b/docs/reference/api/IngestGeoIpStatsGeoIpNodeDatabases.md @@ -0,0 +1,6 @@ +## Interface `IngestGeoIpStatsGeoIpNodeDatabases` + +| Name | Type | Description | +| - | - | - | +| `databases` | [IngestGeoIpStatsGeoIpNodeDatabaseName](./IngestGeoIpStatsGeoIpNodeDatabaseName.md)[] | Downloaded databases for the node. | +| `files_in_temp` | string[] | Downloaded database files, including related license files. Elasticsearch stores these files in the node’s temporary directory: $ES_TMPDIR/geoip-databases/ < node_id > . | diff --git a/docs/reference/api/IngestGeoIpStatsRequest.md b/docs/reference/api/IngestGeoIpStatsRequest.md new file mode 100644 index 000000000..054319b02 --- /dev/null +++ b/docs/reference/api/IngestGeoIpStatsRequest.md @@ -0,0 +1,6 @@ +## Interface `IngestGeoIpStatsRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | { [key: string]: any; } | All values in `body` will be added to the request body. | +| `querystring` | { [key: string]: any; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/IngestGeoIpStatsResponse.md b/docs/reference/api/IngestGeoIpStatsResponse.md new file mode 100644 index 000000000..ab35ba885 --- /dev/null +++ b/docs/reference/api/IngestGeoIpStatsResponse.md @@ -0,0 +1,6 @@ +## Interface `IngestGeoIpStatsResponse` + +| Name | Type | Description | +| - | - | - | +| `nodes` | Record<[Id](./Id.md), [IngestGeoIpStatsGeoIpNodeDatabases](./IngestGeoIpStatsGeoIpNodeDatabases.md)> | Downloaded GeoIP2 databases for each node. | +| `stats` | [IngestGeoIpStatsGeoIpDownloadStatistics](./IngestGeoIpStatsGeoIpDownloadStatistics.md) | Download statistics for all GeoIP2 databases. | diff --git a/docs/reference/api/IngestGetGeoipDatabaseDatabaseConfigurationMetadata.md b/docs/reference/api/IngestGetGeoipDatabaseDatabaseConfigurationMetadata.md new file mode 100644 index 000000000..84919cda1 --- /dev/null +++ b/docs/reference/api/IngestGetGeoipDatabaseDatabaseConfigurationMetadata.md @@ -0,0 +1,8 @@ +## Interface `IngestGetGeoipDatabaseDatabaseConfigurationMetadata` + +| Name | Type | Description | +| - | - | - | +| `database` | [IngestDatabaseConfiguration](./IngestDatabaseConfiguration.md) |   | +| `id` | [Id](./Id.md) |   | +| `modified_date_millis` | [EpochTime](./EpochTime.md)<[UnitMillis](./UnitMillis.md)> |   | +| `version` | [long](./long.md) |   | diff --git a/docs/reference/api/IngestGetGeoipDatabaseRequest.md b/docs/reference/api/IngestGetGeoipDatabaseRequest.md new file mode 100644 index 000000000..929924a21 --- /dev/null +++ b/docs/reference/api/IngestGetGeoipDatabaseRequest.md @@ -0,0 +1,7 @@ +## Interface `IngestGetGeoipDatabaseRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { id?: never; }) | All values in `body` will be added to the request body. | +| `id` | [Ids](./Ids.md) | A comma-separated list of database configuration IDs to retrieve. Wildcard ( `*`) expressions are supported. To get all database configurations, omit this parameter or use `*`. | +| `querystring` | { [key: string]: any; } & { id?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/IngestGetGeoipDatabaseResponse.md b/docs/reference/api/IngestGetGeoipDatabaseResponse.md new file mode 100644 index 000000000..7491bf942 --- /dev/null +++ b/docs/reference/api/IngestGetGeoipDatabaseResponse.md @@ -0,0 +1,5 @@ +## Interface `IngestGetGeoipDatabaseResponse` + +| Name | Type | Description | +| - | - | - | +| `databases` | [IngestGetGeoipDatabaseDatabaseConfigurationMetadata](./IngestGetGeoipDatabaseDatabaseConfigurationMetadata.md)[] |   | diff --git a/docs/reference/api/IngestGetIpLocationDatabaseDatabaseConfigurationMetadata.md b/docs/reference/api/IngestGetIpLocationDatabaseDatabaseConfigurationMetadata.md new file mode 100644 index 000000000..7c905bf24 --- /dev/null +++ b/docs/reference/api/IngestGetIpLocationDatabaseDatabaseConfigurationMetadata.md @@ -0,0 +1,9 @@ +## Interface `IngestGetIpLocationDatabaseDatabaseConfigurationMetadata` + +| Name | Type | Description | +| - | - | - | +| `database` | [IngestDatabaseConfigurationFull](./IngestDatabaseConfigurationFull.md) |   | +| `id` | [Id](./Id.md) |   | +| `modified_date_millis` | [EpochTime](./EpochTime.md)<[UnitMillis](./UnitMillis.md)> |   | +| `modified_date` | [EpochTime](./EpochTime.md)<[UnitMillis](./UnitMillis.md)> |   | +| `version` | [VersionNumber](./VersionNumber.md) |   | diff --git a/docs/reference/api/IngestGetIpLocationDatabaseRequest.md b/docs/reference/api/IngestGetIpLocationDatabaseRequest.md new file mode 100644 index 000000000..f2c1e05a8 --- /dev/null +++ b/docs/reference/api/IngestGetIpLocationDatabaseRequest.md @@ -0,0 +1,8 @@ +## Interface `IngestGetIpLocationDatabaseRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { id?: never; master_timeout?: never; }) | All values in `body` will be added to the request body. | +| `id` | [Ids](./Ids.md) | Comma-separated list of database configuration IDs to retrieve. Wildcard ( `*`) expressions are supported. To get all database configurations, omit this parameter or use `*`. | +| `master_timeout` | [Duration](./Duration.md) | The period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. A value of `-1` indicates that the request should never time out. | +| `querystring` | { [key: string]: any; } & { id?: never; master_timeout?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/IngestGetIpLocationDatabaseResponse.md b/docs/reference/api/IngestGetIpLocationDatabaseResponse.md new file mode 100644 index 000000000..852b96094 --- /dev/null +++ b/docs/reference/api/IngestGetIpLocationDatabaseResponse.md @@ -0,0 +1,5 @@ +## Interface `IngestGetIpLocationDatabaseResponse` + +| Name | Type | Description | +| - | - | - | +| `databases` | [IngestGetIpLocationDatabaseDatabaseConfigurationMetadata](./IngestGetIpLocationDatabaseDatabaseConfigurationMetadata.md)[] |   | diff --git a/docs/reference/api/IngestGetPipelineRequest.md b/docs/reference/api/IngestGetPipelineRequest.md new file mode 100644 index 000000000..530baf5bf --- /dev/null +++ b/docs/reference/api/IngestGetPipelineRequest.md @@ -0,0 +1,9 @@ +## Interface `IngestGetPipelineRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { id?: never; master_timeout?: never; summary?: never; }) | All values in `body` will be added to the request body. | +| `id` | [Id](./Id.md) | Comma-separated list of pipeline IDs to retrieve. Wildcard ( `*`) expressions are supported. To get all ingest pipelines, omit this parameter or use `*`. | +| `master_timeout` | [Duration](./Duration.md) | Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. | +| `querystring` | { [key: string]: any; } & { id?: never; master_timeout?: never; summary?: never; } | All values in `querystring` will be added to the request querystring. | +| `summary` | boolean | Return pipelines without their definitions (default: false) | diff --git a/docs/reference/api/IngestGetPipelineResponse.md b/docs/reference/api/IngestGetPipelineResponse.md new file mode 100644 index 000000000..4e8fa0b9c --- /dev/null +++ b/docs/reference/api/IngestGetPipelineResponse.md @@ -0,0 +1,4 @@ +## `IngestGetPipelineResponse` +::: +type IngestGetPipelineResponse = Record; +::: diff --git a/docs/reference/api/IngestGrokProcessor.md b/docs/reference/api/IngestGrokProcessor.md new file mode 100644 index 000000000..4701a00ed --- /dev/null +++ b/docs/reference/api/IngestGrokProcessor.md @@ -0,0 +1,10 @@ +## Interface `IngestGrokProcessor` + +| Name | Type | Description | +| - | - | - | +| `ecs_compatibility` | string | Must be disabled or v1. If v1, the processor uses patterns with Elastic Common Schema (ECS) field names. | +| `field` | [Field](./Field.md) | The field to use for grok expression parsing. | +| `ignore_missing` | boolean | If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. | +| `pattern_definitions` | Record | A map of pattern-name and pattern tuples defining custom patterns to be used by the current processor. Patterns matching existing names will override the pre-existing definition. | +| `patterns` | [GrokPattern](./GrokPattern.md)[] | An ordered list of grok expression to match and extract named captures with. Returns on the first expression in the list that matches. | +| `trace_match` | boolean | When `true`, `_ingest._grok_match_index` will be inserted into your matched document’s metadata with the index into the pattern found in `patterns` that matched. | diff --git a/docs/reference/api/IngestGsubProcessor.md b/docs/reference/api/IngestGsubProcessor.md new file mode 100644 index 000000000..9debfa931 --- /dev/null +++ b/docs/reference/api/IngestGsubProcessor.md @@ -0,0 +1,9 @@ +## Interface `IngestGsubProcessor` + +| Name | Type | Description | +| - | - | - | +| `field` | [Field](./Field.md) | The field to apply the replacement to. | +| `ignore_missing` | boolean | If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. | +| `pattern` | string | The pattern to be replaced. | +| `replacement` | string | The string to replace the matching patterns with. | +| `target_field` | [Field](./Field.md) | The field to assign the converted value to By default, the `field` is updated in-place. | diff --git a/docs/reference/api/IngestHtmlStripProcessor.md b/docs/reference/api/IngestHtmlStripProcessor.md new file mode 100644 index 000000000..4e811c6e2 --- /dev/null +++ b/docs/reference/api/IngestHtmlStripProcessor.md @@ -0,0 +1,7 @@ +## Interface `IngestHtmlStripProcessor` + +| Name | Type | Description | +| - | - | - | +| `field` | [Field](./Field.md) | The string-valued field to remove HTML tags from. | +| `ignore_missing` | boolean | If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document, | +| `target_field` | [Field](./Field.md) | The field to assign the converted value to By default, the `field` is updated in-place. | diff --git a/docs/reference/api/IngestInferenceConfig.md b/docs/reference/api/IngestInferenceConfig.md new file mode 100644 index 000000000..8e20a379a --- /dev/null +++ b/docs/reference/api/IngestInferenceConfig.md @@ -0,0 +1,6 @@ +## Interface `IngestInferenceConfig` + +| Name | Type | Description | +| - | - | - | +| `classification` | [IngestInferenceConfigClassification](./IngestInferenceConfigClassification.md) | Classification configuration for inference. | +| `regression` | [IngestInferenceConfigRegression](./IngestInferenceConfigRegression.md) | Regression configuration for inference. | diff --git a/docs/reference/api/IngestInferenceConfigClassification.md b/docs/reference/api/IngestInferenceConfigClassification.md new file mode 100644 index 000000000..98c56c9bd --- /dev/null +++ b/docs/reference/api/IngestInferenceConfigClassification.md @@ -0,0 +1,9 @@ +## Interface `IngestInferenceConfigClassification` + +| Name | Type | Description | +| - | - | - | +| `num_top_classes` | [integer](./integer.md) | Specifies the number of top class predictions to return. | +| `num_top_feature_importance_values` | [integer](./integer.md) | Specifies the maximum number of feature importance values per document. | +| `prediction_field_type` | string | Specifies the type of the predicted field to write. Valid values are: `string`, `number`, `boolean`. | +| `results_field` | [Field](./Field.md) | The field that is added to incoming documents to contain the inference prediction. | +| `top_classes_results_field` | [Field](./Field.md) | Specifies the field to which the top classes are written. | diff --git a/docs/reference/api/IngestInferenceConfigRegression.md b/docs/reference/api/IngestInferenceConfigRegression.md new file mode 100644 index 000000000..3660f40e2 --- /dev/null +++ b/docs/reference/api/IngestInferenceConfigRegression.md @@ -0,0 +1,6 @@ +## Interface `IngestInferenceConfigRegression` + +| Name | Type | Description | +| - | - | - | +| `num_top_feature_importance_values` | [integer](./integer.md) | Specifies the maximum number of feature importance values per document. | +| `results_field` | [Field](./Field.md) | The field that is added to incoming documents to contain the inference prediction. | diff --git a/docs/reference/api/IngestInferenceProcessor.md b/docs/reference/api/IngestInferenceProcessor.md new file mode 100644 index 000000000..ab26c42b9 --- /dev/null +++ b/docs/reference/api/IngestInferenceProcessor.md @@ -0,0 +1,10 @@ +## Interface `IngestInferenceProcessor` + +| Name | Type | Description | +| - | - | - | +| `field_map` | Record<[Field](./Field.md), any> | Maps the document field names to the known field names of the model. This mapping takes precedence over any default mappings provided in the model configuration. | +| `ignore_missing` | boolean | If true and any of the input fields defined in input_ouput are missing then those missing fields are quietly ignored, otherwise a missing field causes a failure. Only applies when using input_output configurations to explicitly list the input fields. | +| `inference_config` | [IngestInferenceConfig](./IngestInferenceConfig.md) | Contains the inference type and its options. | +| `input_output` | [IngestInputConfig](./IngestInputConfig.md) | [IngestInputConfig](./IngestInputConfig.md)[] | Input fields for inference and output (destination) fields for the inference results. This option is incompatible with the target_field and field_map options. | +| `model_id` | [Id](./Id.md) | The ID or alias for the trained model, or the ID of the deployment. | +| `target_field` | [Field](./Field.md) | Field added to incoming documents to contain results objects. | diff --git a/docs/reference/api/IngestIngest.md b/docs/reference/api/IngestIngest.md new file mode 100644 index 000000000..bb8135501 --- /dev/null +++ b/docs/reference/api/IngestIngest.md @@ -0,0 +1,7 @@ +## Interface `IngestIngest` + +| Name | Type | Description | +| - | - | - | +| `_redact` | [IngestRedact](./IngestRedact.md) |   | +| `pipeline` | [Name](./Name.md) |   | +| `timestamp` | [DateTime](./DateTime.md) |   | diff --git a/docs/reference/api/IngestInputConfig.md b/docs/reference/api/IngestInputConfig.md new file mode 100644 index 000000000..3bef4b640 --- /dev/null +++ b/docs/reference/api/IngestInputConfig.md @@ -0,0 +1,6 @@ +## Interface `IngestInputConfig` + +| Name | Type | Description | +| - | - | - | +| `input_field` | string |   | +| `output_field` | string |   | diff --git a/docs/reference/api/IngestIpLocationProcessor.md b/docs/reference/api/IngestIpLocationProcessor.md new file mode 100644 index 000000000..7ea87caf5 --- /dev/null +++ b/docs/reference/api/IngestIpLocationProcessor.md @@ -0,0 +1,11 @@ +## Interface `IngestIpLocationProcessor` + +| Name | Type | Description | +| - | - | - | +| `database_file` | string | The database filename referring to a database the module ships with (GeoLite2-City.mmdb, GeoLite2-Country.mmdb, or GeoLite2-ASN.mmdb) or a custom database in the ingest-geoip config directory. | +| `download_database_on_pipeline_creation` | boolean | If `true` (and if `ingest.geoip.downloader.eager.download` is `false`), the missing database is downloaded when the pipeline is created. Else, the download is triggered by when the pipeline is used as the `default_pipeline` or `final_pipeline` in an index. | +| `field` | [Field](./Field.md) | The field to get the ip address from for the geographical lookup. | +| `first_only` | boolean | If `true`, only the first found IP location data will be returned, even if the field contains an array. | +| `ignore_missing` | boolean | If `true` and `field` does not exist, the processor quietly exits without modifying the document. | +| `properties` | string[] | Controls what properties are added to the `target_field` based on the IP location lookup. | +| `target_field` | [Field](./Field.md) | The field that will hold the geographical information looked up from the MaxMind database. | diff --git a/docs/reference/api/IngestIpinfo.md b/docs/reference/api/IngestIpinfo.md new file mode 100644 index 000000000..107dfafa8 --- /dev/null +++ b/docs/reference/api/IngestIpinfo.md @@ -0,0 +1,4 @@ +## Interface `IngestIpinfo` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/IngestJoinProcessor.md b/docs/reference/api/IngestJoinProcessor.md new file mode 100644 index 000000000..e10a9920c --- /dev/null +++ b/docs/reference/api/IngestJoinProcessor.md @@ -0,0 +1,7 @@ +## Interface `IngestJoinProcessor` + +| Name | Type | Description | +| - | - | - | +| `field` | [Field](./Field.md) | Field containing array values to join. | +| `separator` | string | The separator character. | +| `target_field` | [Field](./Field.md) | The field to assign the joined value to. By default, the field is updated in-place. | diff --git a/docs/reference/api/IngestJsonProcessor.md b/docs/reference/api/IngestJsonProcessor.md new file mode 100644 index 000000000..3dbcb41d3 --- /dev/null +++ b/docs/reference/api/IngestJsonProcessor.md @@ -0,0 +1,9 @@ +## Interface `IngestJsonProcessor` + +| Name | Type | Description | +| - | - | - | +| `add_to_root_conflict_strategy` | [IngestJsonProcessorConflictStrategy](./IngestJsonProcessorConflictStrategy.md) | When set to `replace`, root fields that conflict with fields from the parsed JSON will be overridden. When set to `merge`, conflicting fields will be merged. Only applicable `if add_to_root` is set to true. | +| `add_to_root` | boolean | Flag that forces the parsed JSON to be added at the top level of the document. `target_field` must not be set when this option is chosen. | +| `allow_duplicate_keys` | boolean | When set to `true`, the JSON parser will not fail if the JSON contains duplicate keys. Instead, the last encountered value for any duplicate key wins. | +| `field` | [Field](./Field.md) | The field to be parsed. | +| `target_field` | [Field](./Field.md) | The field that the converted structured object will be written into. Any existing content in this field will be overwritten. | diff --git a/docs/reference/api/IngestJsonProcessorConflictStrategy.md b/docs/reference/api/IngestJsonProcessorConflictStrategy.md new file mode 100644 index 000000000..19cc77956 --- /dev/null +++ b/docs/reference/api/IngestJsonProcessorConflictStrategy.md @@ -0,0 +1,4 @@ +## `IngestJsonProcessorConflictStrategy` +::: +type IngestJsonProcessorConflictStrategy = 'replace' | 'merge'; +::: diff --git a/docs/reference/api/IngestKeyValueProcessor.md b/docs/reference/api/IngestKeyValueProcessor.md new file mode 100644 index 000000000..c0ef648dc --- /dev/null +++ b/docs/reference/api/IngestKeyValueProcessor.md @@ -0,0 +1,15 @@ +## Interface `IngestKeyValueProcessor` + +| Name | Type | Description | +| - | - | - | +| `exclude_keys` | string[] | List of keys to exclude from document. | +| `field_split` | string | Regex pattern to use for splitting key-value pairs. | +| `field` | [Field](./Field.md) | The field to be parsed. Supports template snippets. | +| `ignore_missing` | boolean | If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. | +| `include_keys` | string[] | List of keys to filter and insert into document. Defaults to including all keys. | +| `prefix` | string | Prefix to be added to extracted keys. | +| `strip_brackets` | boolean | If `true`. strip brackets `()`, `<>`, `[]` as well as quotes `'` and `"` from extracted values. | +| `target_field` | [Field](./Field.md) | The field to insert the extracted keys into. Defaults to the root of the document. Supports template snippets. | +| `trim_key` | string | String of characters to trim from extracted keys. | +| `trim_value` | string | String of characters to trim from extracted values. | +| `value_split` | string | Regex pattern to use for splitting the key from the value within a key-value pair. | diff --git a/docs/reference/api/IngestLocal.md b/docs/reference/api/IngestLocal.md new file mode 100644 index 000000000..989afa5bc --- /dev/null +++ b/docs/reference/api/IngestLocal.md @@ -0,0 +1,5 @@ +## Interface `IngestLocal` + +| Name | Type | Description | +| - | - | - | +| `type` | string |   | diff --git a/docs/reference/api/IngestLowercaseProcessor.md b/docs/reference/api/IngestLowercaseProcessor.md new file mode 100644 index 000000000..b367828b0 --- /dev/null +++ b/docs/reference/api/IngestLowercaseProcessor.md @@ -0,0 +1,7 @@ +## Interface `IngestLowercaseProcessor` + +| Name | Type | Description | +| - | - | - | +| `field` | [Field](./Field.md) | The field to make lowercase. | +| `ignore_missing` | boolean | If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. | +| `target_field` | [Field](./Field.md) | The field to assign the converted value to. By default, the field is updated in-place. | diff --git a/docs/reference/api/IngestMaxmind.md b/docs/reference/api/IngestMaxmind.md new file mode 100644 index 000000000..4c59a9502 --- /dev/null +++ b/docs/reference/api/IngestMaxmind.md @@ -0,0 +1,5 @@ +## Interface `IngestMaxmind` + +| Name | Type | Description | +| - | - | - | +| `account_id` | [Id](./Id.md) |   | diff --git a/docs/reference/api/IngestNetworkDirectionProcessor.md b/docs/reference/api/IngestNetworkDirectionProcessor.md new file mode 100644 index 000000000..bb6b9885e --- /dev/null +++ b/docs/reference/api/IngestNetworkDirectionProcessor.md @@ -0,0 +1,10 @@ +## Interface `IngestNetworkDirectionProcessor` + +| Name | Type | Description | +| - | - | - | +| `destination_ip` | [Field](./Field.md) | Field containing the destination IP address. | +| `ignore_missing` | boolean | If true and any required fields are missing, the processor quietly exits without modifying the document. | +| `internal_networks_field` | [Field](./Field.md) | A field on the given document to read the internal_networks configuration from. | +| `internal_networks` | string[] | List of internal networks. Supports IPv4 and IPv6 addresses and ranges in CIDR notation. Also supports the named ranges listed below. These may be constructed with template snippets. Must specify only one of internal_networks or internal_networks_field. | +| `source_ip` | [Field](./Field.md) | Field containing the source IP address. | +| `target_field` | [Field](./Field.md) | Output field for the network direction. | diff --git a/docs/reference/api/IngestPipeline.md b/docs/reference/api/IngestPipeline.md new file mode 100644 index 000000000..6a2332cc5 --- /dev/null +++ b/docs/reference/api/IngestPipeline.md @@ -0,0 +1,10 @@ +## Interface `IngestPipeline` + +| Name | Type | Description | +| - | - | - | +| `_meta` | [Metadata](./Metadata.md) | Arbitrary metadata about the ingest pipeline. This map is not automatically generated by Elasticsearch. | +| `deprecated` | boolean | Marks this ingest pipeline as deprecated. When a deprecated ingest pipeline is referenced as the default or final pipeline when creating or updating a non-deprecated index template, Elasticsearch will emit a deprecation warning. | +| `description` | string | Description of the ingest pipeline. | +| `on_failure` | [IngestProcessorContainer](./IngestProcessorContainer.md)[] | Processors to run immediately after a processor failure. | +| `processors` | [IngestProcessorContainer](./IngestProcessorContainer.md)[] | Processors used to perform transformations on documents before indexing. Processors run sequentially in the order specified. | +| `version` | [VersionNumber](./VersionNumber.md) | Version number used by external systems to track ingest pipelines. | diff --git a/docs/reference/api/IngestPipelineConfig.md b/docs/reference/api/IngestPipelineConfig.md new file mode 100644 index 000000000..93ac46004 --- /dev/null +++ b/docs/reference/api/IngestPipelineConfig.md @@ -0,0 +1,7 @@ +## Interface `IngestPipelineConfig` + +| Name | Type | Description | +| - | - | - | +| `description` | string | Description of the ingest pipeline. | +| `processors` | [IngestProcessorContainer](./IngestProcessorContainer.md)[] | Processors used to perform transformations on documents before indexing. Processors run sequentially in the order specified. | +| `version` | [VersionNumber](./VersionNumber.md) | Version number used by external systems to track ingest pipelines. | diff --git a/docs/reference/api/IngestPipelineProcessor.md b/docs/reference/api/IngestPipelineProcessor.md new file mode 100644 index 000000000..d997ab3ef --- /dev/null +++ b/docs/reference/api/IngestPipelineProcessor.md @@ -0,0 +1,6 @@ +## Interface `IngestPipelineProcessor` + +| Name | Type | Description | +| - | - | - | +| `ignore_missing_pipeline` | boolean | Whether to ignore missing pipelines instead of failing. | +| `name` | [Name](./Name.md) | The name of the pipeline to execute. Supports template snippets. | diff --git a/docs/reference/api/IngestPipelineProcessorResult.md b/docs/reference/api/IngestPipelineProcessorResult.md new file mode 100644 index 000000000..62c7f427b --- /dev/null +++ b/docs/reference/api/IngestPipelineProcessorResult.md @@ -0,0 +1,11 @@ +## Interface `IngestPipelineProcessorResult` + +| Name | Type | Description | +| - | - | - | +| `description` | string |   | +| `doc` | [IngestDocumentSimulation](./IngestDocumentSimulation.md) |   | +| `error` | [ErrorCause](./ErrorCause.md) |   | +| `ignored_error` | [ErrorCause](./ErrorCause.md) |   | +| `processor_type` | string |   | +| `status` | [IngestPipelineSimulationStatusOptions](./IngestPipelineSimulationStatusOptions.md) |   | +| `tag` | string |   | diff --git a/docs/reference/api/IngestPipelineSimulationStatusOptions.md b/docs/reference/api/IngestPipelineSimulationStatusOptions.md new file mode 100644 index 000000000..091cc34c3 --- /dev/null +++ b/docs/reference/api/IngestPipelineSimulationStatusOptions.md @@ -0,0 +1,4 @@ +## `IngestPipelineSimulationStatusOptions` +::: +type IngestPipelineSimulationStatusOptions = 'success' | 'error' | 'error_ignored' | 'skipped' | 'dropped'; +::: diff --git a/docs/reference/api/IngestProcessorBase.md b/docs/reference/api/IngestProcessorBase.md new file mode 100644 index 000000000..3efbdf357 --- /dev/null +++ b/docs/reference/api/IngestProcessorBase.md @@ -0,0 +1,9 @@ +## Interface `IngestProcessorBase` + +| Name | Type | Description | +| - | - | - | +| `description` | string | Description of the processor. Useful for describing the purpose of the processor or its configuration. | +| `if` | [Script](./Script.md) | [ScriptSource](./ScriptSource.md) | Conditionally execute the processor. | +| `ignore_failure` | boolean | Ignore failures for the processor. | +| `on_failure` | [IngestProcessorContainer](./IngestProcessorContainer.md)[] | Handle failures for the processor. | +| `tag` | string | Identifier for the processor. Useful for debugging and metrics. | diff --git a/docs/reference/api/IngestProcessorContainer.md b/docs/reference/api/IngestProcessorContainer.md new file mode 100644 index 000000000..fba1758dc --- /dev/null +++ b/docs/reference/api/IngestProcessorContainer.md @@ -0,0 +1,49 @@ +## Interface `IngestProcessorContainer` + +| Name | Type | Description | +| - | - | - | +| `append` | [IngestAppendProcessor](./IngestAppendProcessor.md) | Appends one or more values to an existing array if the field already exists and it is an array. Converts a scalar to an array and appends one or more values to it if the field exists and it is a scalar. Creates an array containing the provided values if the field doesn’t exist. Accepts a single value or an array of values. | +| `attachment` | [IngestAttachmentProcessor](./IngestAttachmentProcessor.md) | The attachment processor lets Elasticsearch extract file attachments in common formats (such as PPT, XLS, and PDF) by using the Apache text extraction library Tika. | +| `bytes` | [IngestBytesProcessor](./IngestBytesProcessor.md) | Converts a human readable byte value (for example `1kb`) to its value in bytes (for example `1024`). If the field is an array of strings, all members of the array will be converted. Supported human readable units are "b", "kb", "mb", "gb", "tb", "pb" case insensitive. An error will occur if the field is not a supported format or resultant value exceeds 2^63. | +| `circle` | [IngestCircleProcessor](./IngestCircleProcessor.md) | Converts circle definitions of shapes to regular polygons which approximate them. | +| `community_id` | [IngestCommunityIDProcessor](./IngestCommunityIDProcessor.md) | Computes the Community ID for network flow data as defined in the Community ID Specification. You can use a community ID to correlate network events related to a single flow. | +| `convert` | [IngestConvertProcessor](./IngestConvertProcessor.md) | Converts a field in the currently ingested document to a different type, such as converting a string to an integer. If the field value is an array, all members will be converted. | +| `csv` | [IngestCsvProcessor](./IngestCsvProcessor.md) | Extracts fields from CSV line out of a single text field within a document. Any empty field in CSV will be skipped. | +| `date_index_name` | [IngestDateIndexNameProcessor](./IngestDateIndexNameProcessor.md) | The purpose of this processor is to point documents to the right time based index based on a date or timestamp field in a document by using the date math index name support. | +| `date` | [IngestDateProcessor](./IngestDateProcessor.md) | Parses dates from fields, and then uses the date or timestamp as the timestamp for the document. | +| `dissect` | [IngestDissectProcessor](./IngestDissectProcessor.md) | Extracts structured fields out of a single text field by matching the text field against a delimiter-based pattern. | +| `dot_expander` | [IngestDotExpanderProcessor](./IngestDotExpanderProcessor.md) | Expands a field with dots into an object field. This processor allows fields with dots in the name to be accessible by other processors in the pipeline. Otherwise these fields can’t be accessed by any processor. | +| `drop` | [IngestDropProcessor](./IngestDropProcessor.md) | Drops the document without raising any errors. This is useful to prevent the document from getting indexed based on some condition. | +| `enrich` | [IngestEnrichProcessor](./IngestEnrichProcessor.md) | The `enrich` processor can enrich documents with data from another index. | +| `fail` | [IngestFailProcessor](./IngestFailProcessor.md) | Raises an exception. This is useful for when you expect a pipeline to fail and want to relay a specific message to the requester. | +| `fingerprint` | [IngestFingerprintProcessor](./IngestFingerprintProcessor.md) | Computes a hash of the document’s content. You can use this hash for content fingerprinting. | +| `foreach` | [IngestForeachProcessor](./IngestForeachProcessor.md) | Runs an ingest processor on each element of an array or object. | +| `geo_grid` | [IngestGeoGridProcessor](./IngestGeoGridProcessor.md) | Converts geo-grid definitions of grid tiles or cells to regular bounding boxes or polygons which describe their shape. This is useful if there is a need to interact with the tile shapes as spatially indexable fields. | +| `geoip` | [IngestGeoIpProcessor](./IngestGeoIpProcessor.md) | The `geoip` processor adds information about the geographical location of an IPv4 or IPv6 address. | +| `grok` | [IngestGrokProcessor](./IngestGrokProcessor.md) | Extracts structured fields out of a single text field within a document. You choose which field to extract matched fields from, as well as the grok pattern you expect will match. A grok pattern is like a regular expression that supports aliased expressions that can be reused. | +| `gsub` | [IngestGsubProcessor](./IngestGsubProcessor.md) | Converts a string field by applying a regular expression and a replacement. If the field is an array of string, all members of the array will be converted. If any non-string values are encountered, the processor will throw an exception. | +| `html_strip` | [IngestHtmlStripProcessor](./IngestHtmlStripProcessor.md) | Removes HTML tags from the field. If the field is an array of strings, HTML tags will be removed from all members of the array. | +| `inference` | [IngestInferenceProcessor](./IngestInferenceProcessor.md) | Uses a pre-trained data frame analytics model or a model deployed for natural language processing tasks to infer against the data that is being ingested in the pipeline. | +| `ip_location` | [IngestIpLocationProcessor](./IngestIpLocationProcessor.md) | Currently an undocumented alias for GeoIP Processor. | +| `join` | [IngestJoinProcessor](./IngestJoinProcessor.md) | Joins each element of an array into a single string using a separator character between each element. Throws an error when the field is not an array. | +| `json` | [IngestJsonProcessor](./IngestJsonProcessor.md) | Converts a JSON string into a structured JSON object. | +| `kv` | [IngestKeyValueProcessor](./IngestKeyValueProcessor.md) | This processor helps automatically parse messages (or specific event fields) which are of the `foo=bar` variety. | +| `lowercase` | [IngestLowercaseProcessor](./IngestLowercaseProcessor.md) | Converts a string to its lowercase equivalent. If the field is an array of strings, all members of the array will be converted. | +| `network_direction` | [IngestNetworkDirectionProcessor](./IngestNetworkDirectionProcessor.md) | Calculates the network direction given a source IP address, destination IP address, and a list of internal networks. | +| `pipeline` | [IngestPipelineProcessor](./IngestPipelineProcessor.md) | Executes another pipeline. | +| `redact` | [IngestRedactProcessor](./IngestRedactProcessor.md) | The Redact processor uses the Grok rules engine to obscure text in the input document matching the given Grok patterns. The processor can be used to obscure Personal Identifying Information (PII) by configuring it to detect known patterns such as email or IP addresses. Text that matches a Grok pattern is replaced with a configurable string such as `` where an email address is matched or simply replace all matches with the text `` if preferred. | +| `registered_domain` | [IngestRegisteredDomainProcessor](./IngestRegisteredDomainProcessor.md) | Extracts the registered domain (also known as the effective top-level domain or eTLD), sub-domain, and top-level domain from a fully qualified domain name (FQDN). Uses the registered domains defined in the Mozilla Public Suffix List. | +| `remove` | [IngestRemoveProcessor](./IngestRemoveProcessor.md) | Removes existing fields. If one field doesn’t exist, an exception will be thrown. | +| `rename` | [IngestRenameProcessor](./IngestRenameProcessor.md) | Renames an existing field. If the field doesn’t exist or the new name is already used, an exception will be thrown. | +| `reroute` | [IngestRerouteProcessor](./IngestRerouteProcessor.md) | Routes a document to another target index or data stream. When setting the `destination` option, the target is explicitly specified and the dataset and namespace options can’t be set. When the `destination` option is not set, this processor is in a data stream mode. Note that in this mode, the reroute processor can only be used on data streams that follow the data stream naming scheme. | +| `script` | [IngestScriptProcessor](./IngestScriptProcessor.md) | Runs an inline or stored script on incoming documents. The script runs in the `ingest` context. | +| `set_security_user` | [IngestSetSecurityUserProcessor](./IngestSetSecurityUserProcessor.md) | Sets user-related details (such as `username`, `roles`, `email`, `full_name`, `metadata`, `api_key`, `realm` and `authentication_type`) from the current authenticated user to the current document by pre-processing the ingest. | +| `set` | [IngestSetProcessor](./IngestSetProcessor.md) | Adds a field with the specified value. If the field already exists, its value will be replaced with the provided one. | +| `sort` | [IngestSortProcessor](./IngestSortProcessor.md) | Sorts the elements of an array ascending or descending. Homogeneous arrays of numbers will be sorted numerically, while arrays of strings or heterogeneous arrays of strings + numbers will be sorted lexicographically. Throws an error when the field is not an array. | +| `split` | [IngestSplitProcessor](./IngestSplitProcessor.md) | Splits a field into an array using a separator character. Only works on string fields. | +| `terminate` | [IngestTerminateProcessor](./IngestTerminateProcessor.md) | Terminates the current ingest pipeline, causing no further processors to be run. This will normally be executed conditionally, using the `if` option. | +| `trim` | [IngestTrimProcessor](./IngestTrimProcessor.md) | Trims whitespace from a field. If the field is an array of strings, all members of the array will be trimmed. This only works on leading and trailing whitespace. | +| `uppercase` | [IngestUppercaseProcessor](./IngestUppercaseProcessor.md) | Converts a string to its uppercase equivalent. If the field is an array of strings, all members of the array will be converted. | +| `uri_parts` | [IngestUriPartsProcessor](./IngestUriPartsProcessor.md) | Parses a Uniform Resource Identifier (URI) string and extracts its components as an object. This URI object includes properties for the URI’s domain, path, fragment, port, query, scheme, user info, username, and password. | +| `urldecode` | [IngestUrlDecodeProcessor](./IngestUrlDecodeProcessor.md) | URL-decodes a string. If the field is an array of strings, all members of the array will be decoded. | +| `user_agent` | [IngestUserAgentProcessor](./IngestUserAgentProcessor.md) | The `user_agent` processor extracts details from the user agent string a browser sends with its web requests. This processor adds this information by default under the `user_agent` field. | diff --git a/docs/reference/api/IngestProcessorGrokRequest.md b/docs/reference/api/IngestProcessorGrokRequest.md new file mode 100644 index 000000000..ce7ef5408 --- /dev/null +++ b/docs/reference/api/IngestProcessorGrokRequest.md @@ -0,0 +1,6 @@ +## Interface `IngestProcessorGrokRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | { [key: string]: any; } | All values in `body` will be added to the request body. | +| `querystring` | { [key: string]: any; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/IngestProcessorGrokResponse.md b/docs/reference/api/IngestProcessorGrokResponse.md new file mode 100644 index 000000000..667894d0e --- /dev/null +++ b/docs/reference/api/IngestProcessorGrokResponse.md @@ -0,0 +1,5 @@ +## Interface `IngestProcessorGrokResponse` + +| Name | Type | Description | +| - | - | - | +| `patterns` | Record |   | diff --git a/docs/reference/api/IngestPutGeoipDatabaseRequest.md b/docs/reference/api/IngestPutGeoipDatabaseRequest.md new file mode 100644 index 000000000..57617ad40 --- /dev/null +++ b/docs/reference/api/IngestPutGeoipDatabaseRequest.md @@ -0,0 +1,11 @@ +## Interface `IngestPutGeoipDatabaseRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { id?: never; master_timeout?: never; timeout?: never; name?: never; maxmind?: never; }) | All values in `body` will be added to the request body. | +| `id` | [Id](./Id.md) | ID of the database configuration to create or update. | +| `master_timeout` | [Duration](./Duration.md) | Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. | +| `maxmind` | [IngestMaxmind](./IngestMaxmind.md) | The configuration necessary to identify which IP geolocation provider to use to download the database, as well as any provider-specific configuration necessary for such downloading. At present, the only supported provider is maxmind, and the maxmind provider requires that an account_id (string) is configured. | +| `name` | [Name](./Name.md) | The provider-assigned name of the IP geolocation database to download. | +| `querystring` | { [key: string]: any; } & { id?: never; master_timeout?: never; timeout?: never; name?: never; maxmind?: never; } | All values in `querystring` will be added to the request querystring. | +| `timeout` | [Duration](./Duration.md) | Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. | diff --git a/docs/reference/api/IngestPutGeoipDatabaseResponse.md b/docs/reference/api/IngestPutGeoipDatabaseResponse.md new file mode 100644 index 000000000..7cc4338e1 --- /dev/null +++ b/docs/reference/api/IngestPutGeoipDatabaseResponse.md @@ -0,0 +1,4 @@ +## `IngestPutGeoipDatabaseResponse` +::: +type IngestPutGeoipDatabaseResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); +::: diff --git a/docs/reference/api/IngestPutIpLocationDatabaseRequest.md b/docs/reference/api/IngestPutIpLocationDatabaseRequest.md new file mode 100644 index 000000000..be923c9fe --- /dev/null +++ b/docs/reference/api/IngestPutIpLocationDatabaseRequest.md @@ -0,0 +1,10 @@ +## Interface `IngestPutIpLocationDatabaseRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { id?: never; master_timeout?: never; timeout?: never; configuration?: never; }) | All values in `body` will be added to the request body. | +| `configuration` | [IngestDatabaseConfiguration](./IngestDatabaseConfiguration.md) |   | +| `id` | [Id](./Id.md) | The database configuration identifier. | +| `master_timeout` | [Duration](./Duration.md) | The period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. A value of `-1` indicates that the request should never time out. | +| `querystring` | { [key: string]: any; } & { id?: never; master_timeout?: never; timeout?: never; configuration?: never; } | All values in `querystring` will be added to the request querystring. | +| `timeout` | [Duration](./Duration.md) | The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata. If no response is received before the timeout expires, the cluster metadata update still applies but the response indicates that it was not completely acknowledged. A value of `-1` indicates that the request should never time out. | diff --git a/docs/reference/api/IngestPutIpLocationDatabaseResponse.md b/docs/reference/api/IngestPutIpLocationDatabaseResponse.md new file mode 100644 index 000000000..0fe04f453 --- /dev/null +++ b/docs/reference/api/IngestPutIpLocationDatabaseResponse.md @@ -0,0 +1,4 @@ +## `IngestPutIpLocationDatabaseResponse` +::: +type IngestPutIpLocationDatabaseResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); +::: diff --git a/docs/reference/api/IngestPutPipelineRequest.md b/docs/reference/api/IngestPutPipelineRequest.md new file mode 100644 index 000000000..870ca6ca6 --- /dev/null +++ b/docs/reference/api/IngestPutPipelineRequest.md @@ -0,0 +1,16 @@ +## Interface `IngestPutPipelineRequest` + +| Name | Type | Description | +| - | - | - | +| `_meta` | [Metadata](./Metadata.md) | Optional metadata about the ingest pipeline. May have any contents. This map is not automatically generated by Elasticsearch. | +| `body` | string | ({ [key: string]: any; } & { id?: never; master_timeout?: never; timeout?: never; if_version?: never; _meta?: never; description?: never; on_failure?: never; processors?: never; version?: never; deprecated?: never; }) | All values in `body` will be added to the request body. | +| `deprecated` | boolean | Marks this ingest pipeline as deprecated. When a deprecated ingest pipeline is referenced as the default or final pipeline when creating or updating a non-deprecated index template, Elasticsearch will emit a deprecation warning. | +| `description` | string | Description of the ingest pipeline. | +| `id` | [Id](./Id.md) | ID of the ingest pipeline to create or update. | +| `if_version` | [VersionNumber](./VersionNumber.md) | Required version for optimistic concurrency control for pipeline updates | +| `master_timeout` | [Duration](./Duration.md) | Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. | +| `on_failure` | [IngestProcessorContainer](./IngestProcessorContainer.md)[] | Processors to run immediately after a processor failure. Each processor supports a processor-level `on_failure` value. If a processor without an `on_failure` value fails, Elasticsearch uses this pipeline-level parameter as a fallback. The processors in this parameter run sequentially in the order specified. Elasticsearch will not attempt to run the pipeline's remaining processors. | +| `processors` | [IngestProcessorContainer](./IngestProcessorContainer.md)[] | Processors used to perform transformations on documents before indexing. Processors run sequentially in the order specified. | +| `querystring` | { [key: string]: any; } & { id?: never; master_timeout?: never; timeout?: never; if_version?: never; _meta?: never; description?: never; on_failure?: never; processors?: never; version?: never; deprecated?: never; } | All values in `querystring` will be added to the request querystring. | +| `timeout` | [Duration](./Duration.md) | Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. | +| `version` | [VersionNumber](./VersionNumber.md) | Version number used by external systems to track ingest pipelines. This parameter is intended for external systems only. Elasticsearch does not use or validate pipeline version numbers. | diff --git a/docs/reference/api/IngestPutPipelineResponse.md b/docs/reference/api/IngestPutPipelineResponse.md new file mode 100644 index 000000000..53b31e50a --- /dev/null +++ b/docs/reference/api/IngestPutPipelineResponse.md @@ -0,0 +1,4 @@ +## `IngestPutPipelineResponse` +::: +type IngestPutPipelineResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); +::: diff --git a/docs/reference/api/IngestRedact.md b/docs/reference/api/IngestRedact.md new file mode 100644 index 000000000..54dd437ed --- /dev/null +++ b/docs/reference/api/IngestRedact.md @@ -0,0 +1,5 @@ +## Interface `IngestRedact` + +| Name | Type | Description | +| - | - | - | +| `_is_redacted` | boolean | indicates if document has been redacted | diff --git a/docs/reference/api/IngestRedactProcessor.md b/docs/reference/api/IngestRedactProcessor.md new file mode 100644 index 000000000..af10c40c2 --- /dev/null +++ b/docs/reference/api/IngestRedactProcessor.md @@ -0,0 +1,12 @@ +## Interface `IngestRedactProcessor` + +| Name | Type | Description | +| - | - | - | +| `field` | [Field](./Field.md) | The field to be redacted | +| `ignore_missing` | boolean | If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. | +| `pattern_definitions` | Record |   | +| `patterns` | [GrokPattern](./GrokPattern.md)[] | A list of grok expressions to match and redact named captures with | +| `prefix` | string | Start a redacted section with this token | +| `skip_if_unlicensed` | boolean | If `true` and the current license does not support running redact processors, then the processor quietly exits without modifying the document | +| `suffix` | string | End a redacted section with this token | +| `trace_redact` | boolean | If `true` then ingest metadata `_ingest._redact._is_redacted` is set to `true` if the document has been redacted | diff --git a/docs/reference/api/IngestRegisteredDomainProcessor.md b/docs/reference/api/IngestRegisteredDomainProcessor.md new file mode 100644 index 000000000..761220de1 --- /dev/null +++ b/docs/reference/api/IngestRegisteredDomainProcessor.md @@ -0,0 +1,7 @@ +## Interface `IngestRegisteredDomainProcessor` + +| Name | Type | Description | +| - | - | - | +| `field` | [Field](./Field.md) | Field containing the source FQDN. | +| `ignore_missing` | boolean | If true and any required fields are missing, the processor quietly exits without modifying the document. | +| `target_field` | [Field](./Field.md) | Object field containing extracted domain components. If an empty string, the processor adds components to the document’s root. | diff --git a/docs/reference/api/IngestRemoveProcessor.md b/docs/reference/api/IngestRemoveProcessor.md new file mode 100644 index 000000000..27e237cd3 --- /dev/null +++ b/docs/reference/api/IngestRemoveProcessor.md @@ -0,0 +1,7 @@ +## Interface `IngestRemoveProcessor` + +| Name | Type | Description | +| - | - | - | +| `field` | [Fields](./Fields.md) | Fields to be removed. Supports template snippets. | +| `ignore_missing` | boolean | If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. | +| `keep` | [Fields](./Fields.md) | Fields to be kept. When set, all fields other than those specified are removed. | diff --git a/docs/reference/api/IngestRenameProcessor.md b/docs/reference/api/IngestRenameProcessor.md new file mode 100644 index 000000000..43e63e1ec --- /dev/null +++ b/docs/reference/api/IngestRenameProcessor.md @@ -0,0 +1,7 @@ +## Interface `IngestRenameProcessor` + +| Name | Type | Description | +| - | - | - | +| `field` | [Field](./Field.md) | The field to be renamed. Supports template snippets. | +| `ignore_missing` | boolean | If `true` and `field` does not exist, the processor quietly exits without modifying the document. | +| `target_field` | [Field](./Field.md) | The new name of the field. Supports template snippets. | diff --git a/docs/reference/api/IngestRerouteProcessor.md b/docs/reference/api/IngestRerouteProcessor.md new file mode 100644 index 000000000..1ffb45cbb --- /dev/null +++ b/docs/reference/api/IngestRerouteProcessor.md @@ -0,0 +1,7 @@ +## Interface `IngestRerouteProcessor` + +| Name | Type | Description | +| - | - | - | +| `dataset` | string | string[] | Field references or a static value for the dataset part of the data stream name. In addition to the criteria for index names, cannot contain - and must be no longer than 100 characters. Example values are nginx.access and nginx.error. Supports field references with a mustache-like syntax (denoted as { { double } } or { { { triple } } } curly braces). When resolving field references, the processor replaces invalid characters with _. Uses the part of the index name as a fallback if all field references resolve to a null, missing, or non-string value. default { { data_stream.dataset } } | +| `destination` | string | A static value for the target. Can’t be set when the dataset or namespace option is set. | +| `namespace` | string | string[] | Field references or a static value for the namespace part of the data stream name. See the criteria for index names for allowed characters. Must be no longer than 100 characters. Supports field references with a mustache-like syntax (denoted as { { double } } or { { { triple } } } curly braces). When resolving field references, the processor replaces invalid characters with _. Uses the part of the index name as a fallback if all field references resolve to a null, missing, or non-string value. default { { data_stream.namespace } } | diff --git a/docs/reference/api/IngestScriptProcessor.md b/docs/reference/api/IngestScriptProcessor.md new file mode 100644 index 000000000..d663bd559 --- /dev/null +++ b/docs/reference/api/IngestScriptProcessor.md @@ -0,0 +1,8 @@ +## Interface `IngestScriptProcessor` + +| Name | Type | Description | +| - | - | - | +| `id` | [Id](./Id.md) | ID of a stored script. If no `source` is specified, this parameter is required. | +| `lang` | [ScriptLanguage](./ScriptLanguage.md) | Script language. | +| `params` | Record | Object containing parameters for the script. | +| `source` | [ScriptSource](./ScriptSource.md) | Inline script. If no `id` is specified, this parameter is required. | diff --git a/docs/reference/api/IngestSetProcessor.md b/docs/reference/api/IngestSetProcessor.md new file mode 100644 index 000000000..c518cefcb --- /dev/null +++ b/docs/reference/api/IngestSetProcessor.md @@ -0,0 +1,10 @@ +## Interface `IngestSetProcessor` + +| Name | Type | Description | +| - | - | - | +| `copy_from` | [Field](./Field.md) | The origin field which will be copied to `field`, cannot set `value` simultaneously. Supported data types are `boolean`, `number`, `array`, `object`, `string`, `date`, etc. | +| `field` | [Field](./Field.md) | The field to insert, upsert, or update. Supports template snippets. | +| `ignore_empty_value` | boolean | If `true` and `value` is a template snippet that evaluates to `null` or the empty string, the processor quietly exits without modifying the document. | +| `media_type` | string | The media type for encoding `value`. Applies only when value is a template snippet. Must be one of `application/json`, `text/plain`, or `application/x-www-form-urlencoded`. | +| `override` | boolean | If `true` processor will update fields with pre-existing non-null-valued field. When set to `false`, such fields will not be touched. | +| `value` | any | The value to be set for the field. Supports template snippets. May specify only one of `value` or `copy_from`. | diff --git a/docs/reference/api/IngestSetSecurityUserProcessor.md b/docs/reference/api/IngestSetSecurityUserProcessor.md new file mode 100644 index 000000000..e41a826b5 --- /dev/null +++ b/docs/reference/api/IngestSetSecurityUserProcessor.md @@ -0,0 +1,6 @@ +## Interface `IngestSetSecurityUserProcessor` + +| Name | Type | Description | +| - | - | - | +| `field` | [Field](./Field.md) | The field to store the user information into. | +| `properties` | string[] | Controls what user related properties are added to the field. | diff --git a/docs/reference/api/IngestShapeType.md b/docs/reference/api/IngestShapeType.md new file mode 100644 index 000000000..87893f4d7 --- /dev/null +++ b/docs/reference/api/IngestShapeType.md @@ -0,0 +1,4 @@ +## `IngestShapeType` +::: +type IngestShapeType = 'geo_shape' | 'shape'; +::: diff --git a/docs/reference/api/IngestSimulateDocumentResult.md b/docs/reference/api/IngestSimulateDocumentResult.md new file mode 100644 index 000000000..b82306034 --- /dev/null +++ b/docs/reference/api/IngestSimulateDocumentResult.md @@ -0,0 +1,7 @@ +## Interface `IngestSimulateDocumentResult` + +| Name | Type | Description | +| - | - | - | +| `doc` | [IngestDocumentSimulation](./IngestDocumentSimulation.md) |   | +| `error` | [ErrorCause](./ErrorCause.md) |   | +| `processor_results` | [IngestPipelineProcessorResult](./IngestPipelineProcessorResult.md)[] |   | diff --git a/docs/reference/api/IngestSimulateRequest.md b/docs/reference/api/IngestSimulateRequest.md new file mode 100644 index 000000000..1619447ff --- /dev/null +++ b/docs/reference/api/IngestSimulateRequest.md @@ -0,0 +1,10 @@ +## Interface `IngestSimulateRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { id?: never; verbose?: never; docs?: never; pipeline?: never; }) | All values in `body` will be added to the request body. | +| `docs` | [IngestDocument](./IngestDocument.md)[] | Sample documents to test in the pipeline. | +| `id` | [Id](./Id.md) | The pipeline to test. If you don't specify a `pipeline` in the request body, this parameter is required. | +| `pipeline` | [IngestPipeline](./IngestPipeline.md) | The pipeline to test. If you don't specify the `pipeline` request path parameter, this parameter is required. If you specify both this and the request path parameter, the API only uses the request path parameter. | +| `querystring` | { [key: string]: any; } & { id?: never; verbose?: never; docs?: never; pipeline?: never; } | All values in `querystring` will be added to the request querystring. | +| `verbose` | boolean | If `true`, the response includes output data for each processor in the executed pipeline. | diff --git a/docs/reference/api/IngestSimulateResponse.md b/docs/reference/api/IngestSimulateResponse.md new file mode 100644 index 000000000..3eee6bc8c --- /dev/null +++ b/docs/reference/api/IngestSimulateResponse.md @@ -0,0 +1,5 @@ +## Interface `IngestSimulateResponse` + +| Name | Type | Description | +| - | - | - | +| `docs` | [IngestSimulateDocumentResult](./IngestSimulateDocumentResult.md)[] |   | diff --git a/docs/reference/api/IngestSortProcessor.md b/docs/reference/api/IngestSortProcessor.md new file mode 100644 index 000000000..47f0d5724 --- /dev/null +++ b/docs/reference/api/IngestSortProcessor.md @@ -0,0 +1,7 @@ +## Interface `IngestSortProcessor` + +| Name | Type | Description | +| - | - | - | +| `field` | [Field](./Field.md) | The field to be sorted. | +| `order` | [SortOrder](./SortOrder.md) | The sort order to use. Accepts `"asc"` or `"desc"`. | +| `target_field` | [Field](./Field.md) | The field to assign the sorted value to. By default, the field is updated in-place. | diff --git a/docs/reference/api/IngestSplitProcessor.md b/docs/reference/api/IngestSplitProcessor.md new file mode 100644 index 000000000..afa561f59 --- /dev/null +++ b/docs/reference/api/IngestSplitProcessor.md @@ -0,0 +1,9 @@ +## Interface `IngestSplitProcessor` + +| Name | Type | Description | +| - | - | - | +| `field` | [Field](./Field.md) | The field to split. | +| `ignore_missing` | boolean | If `true` and `field` does not exist, the processor quietly exits without modifying the document. | +| `preserve_trailing` | boolean | Preserves empty trailing fields, if any. | +| `separator` | string | A regex which matches the separator, for example, `,` or `\s+`. | +| `target_field` | [Field](./Field.md) | The field to assign the split value to. By default, the field is updated in-place. | diff --git a/docs/reference/api/IngestTerminateProcessor.md b/docs/reference/api/IngestTerminateProcessor.md new file mode 100644 index 000000000..d82b5d9c8 --- /dev/null +++ b/docs/reference/api/IngestTerminateProcessor.md @@ -0,0 +1,4 @@ +## Interface `IngestTerminateProcessor` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/IngestTrimProcessor.md b/docs/reference/api/IngestTrimProcessor.md new file mode 100644 index 000000000..de7aaf325 --- /dev/null +++ b/docs/reference/api/IngestTrimProcessor.md @@ -0,0 +1,7 @@ +## Interface `IngestTrimProcessor` + +| Name | Type | Description | +| - | - | - | +| `field` | [Field](./Field.md) | The string-valued field to trim whitespace from. | +| `ignore_missing` | boolean | If `true` and `field` does not exist, the processor quietly exits without modifying the document. | +| `target_field` | [Field](./Field.md) | The field to assign the trimmed value to. By default, the field is updated in-place. | diff --git a/docs/reference/api/IngestUppercaseProcessor.md b/docs/reference/api/IngestUppercaseProcessor.md new file mode 100644 index 000000000..bbaf071e1 --- /dev/null +++ b/docs/reference/api/IngestUppercaseProcessor.md @@ -0,0 +1,7 @@ +## Interface `IngestUppercaseProcessor` + +| Name | Type | Description | +| - | - | - | +| `field` | [Field](./Field.md) | The field to make uppercase. | +| `ignore_missing` | boolean | If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. | +| `target_field` | [Field](./Field.md) | The field to assign the converted value to. By default, the field is updated in-place. | diff --git a/docs/reference/api/IngestUriPartsProcessor.md b/docs/reference/api/IngestUriPartsProcessor.md new file mode 100644 index 000000000..c259acae8 --- /dev/null +++ b/docs/reference/api/IngestUriPartsProcessor.md @@ -0,0 +1,9 @@ +## Interface `IngestUriPartsProcessor` + +| Name | Type | Description | +| - | - | - | +| `field` | [Field](./Field.md) | Field containing the URI string. | +| `ignore_missing` | boolean | If `true` and `field` does not exist, the processor quietly exits without modifying the document. | +| `keep_original` | boolean | If `true`, the processor copies the unparsed URI to `.original`. | +| `remove_if_successful` | boolean | If `true`, the processor removes the `field` after parsing the URI string. If parsing fails, the processor does not remove the `field`. | +| `target_field` | [Field](./Field.md) | Output field for the URI object. | diff --git a/docs/reference/api/IngestUrlDecodeProcessor.md b/docs/reference/api/IngestUrlDecodeProcessor.md new file mode 100644 index 000000000..b97ab6710 --- /dev/null +++ b/docs/reference/api/IngestUrlDecodeProcessor.md @@ -0,0 +1,7 @@ +## Interface `IngestUrlDecodeProcessor` + +| Name | Type | Description | +| - | - | - | +| `field` | [Field](./Field.md) | The field to decode. | +| `ignore_missing` | boolean | If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. | +| `target_field` | [Field](./Field.md) | The field to assign the converted value to. By default, the field is updated in-place. | diff --git a/docs/reference/api/IngestUserAgentProcessor.md b/docs/reference/api/IngestUserAgentProcessor.md new file mode 100644 index 000000000..945015bfd --- /dev/null +++ b/docs/reference/api/IngestUserAgentProcessor.md @@ -0,0 +1,10 @@ +## Interface `IngestUserAgentProcessor` + +| Name | Type | Description | +| - | - | - | +| `extract_device_type` | boolean | Extracts device type from the user agent string on a best-effort basis. | +| `field` | [Field](./Field.md) | The field containing the user agent string. | +| `ignore_missing` | boolean | If `true` and `field` does not exist, the processor quietly exits without modifying the document. | +| `properties` | [IngestUserAgentProperty](./IngestUserAgentProperty.md)[] | Controls what properties are added to `target_field`. | +| `regex_file` | string | The name of the file in the `config/ingest-user-agent` directory containing the regular expressions for parsing the user agent string. Both the directory and the file have to be created before starting Elasticsearch. If not specified, ingest-user-agent will use the `regexes.yaml` from uap-core it ships with. | +| `target_field` | [Field](./Field.md) | The field that will be filled with the user agent details. | diff --git a/docs/reference/api/IngestUserAgentProperty.md b/docs/reference/api/IngestUserAgentProperty.md new file mode 100644 index 000000000..6f5e92854 --- /dev/null +++ b/docs/reference/api/IngestUserAgentProperty.md @@ -0,0 +1,4 @@ +## `IngestUserAgentProperty` +::: +type IngestUserAgentProperty = 'name' | 'os' | 'device' | 'original' | 'version'; +::: diff --git a/docs/reference/api/IngestWeb.md b/docs/reference/api/IngestWeb.md new file mode 100644 index 000000000..d6b42b0cf --- /dev/null +++ b/docs/reference/api/IngestWeb.md @@ -0,0 +1,4 @@ +## Interface `IngestWeb` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/InlineGet.md b/docs/reference/api/InlineGet.md new file mode 100644 index 000000000..b6273c4c3 --- /dev/null +++ b/docs/reference/api/InlineGet.md @@ -0,0 +1,4 @@ +## `InlineGet` +::: +type InlineGet = [InlineGetKeys](./InlineGetKeys.md) & { [property: string]: any;}; +::: diff --git a/docs/reference/api/InlineGetKeys.md b/docs/reference/api/InlineGetKeys.md new file mode 100644 index 000000000..a095747e0 --- /dev/null +++ b/docs/reference/api/InlineGetKeys.md @@ -0,0 +1,10 @@ +## Interface `InlineGetKeys` + +| Name | Type | Description | +| - | - | - | +| `_primary_term` | [long](./long.md) |   | +| `_routing` | [Routing](./Routing.md) |   | +| `_seq_no` | [SequenceNumber](./SequenceNumber.md) |   | +| `_source` | TDocument |   | +| `fields` | Record |   | +| `found` | boolean |   | diff --git a/docs/reference/api/Ip.md b/docs/reference/api/Ip.md new file mode 100644 index 000000000..581c4ea80 --- /dev/null +++ b/docs/reference/api/Ip.md @@ -0,0 +1,4 @@ +## `Ip` +::: +type Ip = string; +::: diff --git a/docs/reference/api/KnnQuery.md b/docs/reference/api/KnnQuery.md new file mode 100644 index 000000000..6bf5b1db9 --- /dev/null +++ b/docs/reference/api/KnnQuery.md @@ -0,0 +1,12 @@ +## Interface `KnnQuery` + +| Name | Type | Description | +| - | - | - | +| `field` | [Field](./Field.md) | The name of the vector field to search against | +| `filter` | [QueryDslQueryContainer](./QueryDslQueryContainer.md) | [QueryDslQueryContainer](./QueryDslQueryContainer.md)[] | Filters for the kNN search query | +| `k` | [integer](./integer.md) | The final number of nearest neighbors to return as top hits | +| `num_candidates` | [integer](./integer.md) | The number of nearest neighbor candidates to consider per shard | +| `query_vector_builder` | [QueryVectorBuilder](./QueryVectorBuilder.md) | The query vector builder. You must provide a query_vector_builder or query_vector, but not both. | +| `query_vector` | [QueryVector](./QueryVector.md) | The query vector | +| `rescore_vector` | [RescoreVector](./RescoreVector.md) | Apply oversampling and rescoring to quantized vectors | +| `similarity` | [float](./float.md) | The minimum similarity for a vector to be considered a match | diff --git a/docs/reference/api/KnnRetriever.md b/docs/reference/api/KnnRetriever.md new file mode 100644 index 000000000..0496c66e6 --- /dev/null +++ b/docs/reference/api/KnnRetriever.md @@ -0,0 +1,11 @@ +## Interface `KnnRetriever` + +| Name | Type | Description | +| - | - | - | +| `field` | string | The name of the vector field to search against. | +| `k` | [integer](./integer.md) | Number of nearest neighbors to return as top hits. | +| `num_candidates` | [integer](./integer.md) | Number of nearest neighbor candidates to consider per shard. | +| `query_vector_builder` | [QueryVectorBuilder](./QueryVectorBuilder.md) | Defines a model to build a query vector. | +| `query_vector` | [QueryVector](./QueryVector.md) | Query vector. Must have the same number of dimensions as the vector field you are searching against. You must provide a query_vector_builder or query_vector, but not both. | +| `rescore_vector` | [RescoreVector](./RescoreVector.md) | Apply oversampling and rescoring to quantized vectors | +| `similarity` | [float](./float.md) | The minimum similarity required for a document to be considered a match. | diff --git a/docs/reference/api/KnnSearch.md b/docs/reference/api/KnnSearch.md new file mode 100644 index 000000000..616840b14 --- /dev/null +++ b/docs/reference/api/KnnSearch.md @@ -0,0 +1,14 @@ +## Interface `KnnSearch` + +| Name | Type | Description | +| - | - | - | +| `boost` | [float](./float.md) | Boost value to apply to kNN scores | +| `field` | [Field](./Field.md) | The name of the vector field to search against | +| `filter` | [QueryDslQueryContainer](./QueryDslQueryContainer.md) | [QueryDslQueryContainer](./QueryDslQueryContainer.md)[] | Filters for the kNN search query | +| `inner_hits` | [SearchInnerHits](./SearchInnerHits.md) | If defined, each search hit will contain inner hits. | +| `k` | [integer](./integer.md) | The final number of nearest neighbors to return as top hits | +| `num_candidates` | [integer](./integer.md) | The number of nearest neighbor candidates to consider per shard | +| `query_vector_builder` | [QueryVectorBuilder](./QueryVectorBuilder.md) | The query vector builder. You must provide a query_vector_builder or query_vector, but not both. | +| `query_vector` | [QueryVector](./QueryVector.md) | The query vector | +| `rescore_vector` | [RescoreVector](./RescoreVector.md) | Apply oversampling and rescoring to quantized vectors | +| `similarity` | [float](./float.md) | The minimum similarity for a vector to be considered a match | diff --git a/docs/reference/api/KnnSearchApi_1.md b/docs/reference/api/KnnSearchApi_1.md new file mode 100644 index 000000000..2cabff590 --- /dev/null +++ b/docs/reference/api/KnnSearchApi_1.md @@ -0,0 +1,3 @@ +::: +default function KnnSearchApi(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TODO](./TODO.md)>; +::: diff --git a/docs/reference/api/KnnSearchApi_2.md b/docs/reference/api/KnnSearchApi_2.md new file mode 100644 index 000000000..44c32557c --- /dev/null +++ b/docs/reference/api/KnnSearchApi_2.md @@ -0,0 +1,3 @@ +::: +default function KnnSearchApi(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TODO](./TODO.md), unknown>>; +::: diff --git a/docs/reference/api/KnnSearchApi_3.md b/docs/reference/api/KnnSearchApi_3.md new file mode 100644 index 000000000..c57f4f2ea --- /dev/null +++ b/docs/reference/api/KnnSearchApi_3.md @@ -0,0 +1,3 @@ +::: +default function KnnSearchApi(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TODO](./TODO.md)>; +::: diff --git a/docs/reference/api/LatLonGeoLocation.md b/docs/reference/api/LatLonGeoLocation.md new file mode 100644 index 000000000..fab1b9f3a --- /dev/null +++ b/docs/reference/api/LatLonGeoLocation.md @@ -0,0 +1,6 @@ +## Interface `LatLonGeoLocation` + +| Name | Type | Description | +| - | - | - | +| `lat` | [double](./double.md) | Latitude | +| `lon` | [double](./double.md) | Longitude | diff --git a/docs/reference/api/Level.md b/docs/reference/api/Level.md new file mode 100644 index 000000000..838c2d377 --- /dev/null +++ b/docs/reference/api/Level.md @@ -0,0 +1,4 @@ +## `Level` +::: +type Level = 'cluster' | 'indices' | 'shards'; +::: diff --git a/docs/reference/api/License.md b/docs/reference/api/License.md new file mode 100644 index 000000000..e3c95d626 --- /dev/null +++ b/docs/reference/api/License.md @@ -0,0 +1,20 @@ +## `License` + +### Constructor + +::: +new License(transport: [Transport](./Transport.md)); +::: + +### Properties + +| Name | Type | Description | +| - | - | - | +| `acceptedParams` | Record |   | +| `transport` | [Transport](./Transport.md) |   | + +### Methods + +| Name | Signature | Description | +| - | - | - | +| `delete` | `delete(this: [That](./That.md), params?: [LicenseDeleteRequest](./LicenseDeleteRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[LicenseDeleteResponse](./LicenseDeleteResponse.md)>;` | Delete the license. When the license expires, your subscription level reverts to Basic. If the operator privileges feature is enabled, only operator users can use this API. || `delete` | `delete(this: [That](./That.md), params?: [LicenseDeleteRequest](./LicenseDeleteRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[LicenseDeleteResponse](./LicenseDeleteResponse.md), unknown>>;` |   || `delete` | `delete(this: [That](./That.md), params?: [LicenseDeleteRequest](./LicenseDeleteRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[LicenseDeleteResponse](./LicenseDeleteResponse.md)>;` |   || `get` | `get(this: [That](./That.md), params?: [LicenseGetRequest](./LicenseGetRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[LicenseGetResponse](./LicenseGetResponse.md)>;` | Get license information. Get information about your Elastic license including its type, its status, when it was issued, and when it expires. > info > If the master node is generating a new cluster state, the get license API may return a `404 Not Found` response. > If you receive an unexpected 404 response after cluster startup, wait a short period and retry the request. || `get` | `get(this: [That](./That.md), params?: [LicenseGetRequest](./LicenseGetRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[LicenseGetResponse](./LicenseGetResponse.md), unknown>>;` |   || `get` | `get(this: [That](./That.md), params?: [LicenseGetRequest](./LicenseGetRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[LicenseGetResponse](./LicenseGetResponse.md)>;` |   || `getBasicStatus` | `getBasicStatus(this: [That](./That.md), params?: [LicenseGetBasicStatusRequest](./LicenseGetBasicStatusRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[LicenseGetBasicStatusResponse](./LicenseGetBasicStatusResponse.md)>;` | Get the basic license status. || `getBasicStatus` | `getBasicStatus(this: [That](./That.md), params?: [LicenseGetBasicStatusRequest](./LicenseGetBasicStatusRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[LicenseGetBasicStatusResponse](./LicenseGetBasicStatusResponse.md), unknown>>;` |   || `getBasicStatus` | `getBasicStatus(this: [That](./That.md), params?: [LicenseGetBasicStatusRequest](./LicenseGetBasicStatusRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[LicenseGetBasicStatusResponse](./LicenseGetBasicStatusResponse.md)>;` |   || `getTrialStatus` | `getTrialStatus(this: [That](./That.md), params?: [LicenseGetTrialStatusRequest](./LicenseGetTrialStatusRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[LicenseGetTrialStatusResponse](./LicenseGetTrialStatusResponse.md)>;` | Get the trial status. || `getTrialStatus` | `getTrialStatus(this: [That](./That.md), params?: [LicenseGetTrialStatusRequest](./LicenseGetTrialStatusRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[LicenseGetTrialStatusResponse](./LicenseGetTrialStatusResponse.md), unknown>>;` |   || `getTrialStatus` | `getTrialStatus(this: [That](./That.md), params?: [LicenseGetTrialStatusRequest](./LicenseGetTrialStatusRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[LicenseGetTrialStatusResponse](./LicenseGetTrialStatusResponse.md)>;` |   || `post` | `post(this: [That](./That.md), params?: [LicensePostRequest](./LicensePostRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[LicensePostResponse](./LicensePostResponse.md)>;` | Update the license. You can update your license at runtime without shutting down your nodes. License updates take effect immediately. If the license you are installing does not support all of the features that were available with your previous license, however, you are notified in the response. You must then re-submit the API request with the acknowledge parameter set to true. NOTE: If Elasticsearch security features are enabled and you are installing a gold or higher license, you must enable TLS on the transport networking layer before you install the license. If the operator privileges feature is enabled, only operator users can use this API. || `post` | `post(this: [That](./That.md), params?: [LicensePostRequest](./LicensePostRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[LicensePostResponse](./LicensePostResponse.md), unknown>>;` |   || `post` | `post(this: [That](./That.md), params?: [LicensePostRequest](./LicensePostRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[LicensePostResponse](./LicensePostResponse.md)>;` |   || `postStartBasic` | `postStartBasic(this: [That](./That.md), params?: [LicensePostStartBasicRequest](./LicensePostStartBasicRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[LicensePostStartBasicResponse](./LicensePostStartBasicResponse.md)>;` | Start a basic license. Start an indefinite basic license, which gives access to all the basic features. NOTE: In order to start a basic license, you must not currently have a basic license. If the basic license does not support all of the features that are available with your current license, however, you are notified in the response. You must then re-submit the API request with the `acknowledge` parameter set to `true`. To check the status of your basic license, use the get basic license API. || `postStartBasic` | `postStartBasic(this: [That](./That.md), params?: [LicensePostStartBasicRequest](./LicensePostStartBasicRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[LicensePostStartBasicResponse](./LicensePostStartBasicResponse.md), unknown>>;` |   || `postStartBasic` | `postStartBasic(this: [That](./That.md), params?: [LicensePostStartBasicRequest](./LicensePostStartBasicRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[LicensePostStartBasicResponse](./LicensePostStartBasicResponse.md)>;` |   || `postStartTrial` | `postStartTrial(this: [That](./That.md), params?: [LicensePostStartTrialRequest](./LicensePostStartTrialRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[LicensePostStartTrialResponse](./LicensePostStartTrialResponse.md)>;` | Start a trial. Start a 30-day trial, which gives access to all subscription features. NOTE: You are allowed to start a trial only if your cluster has not already activated a trial for the current major product version. For example, if you have already activated a trial for v8.0, you cannot start a new trial until v9.0. You can, however, request an extended trial at https://www.elastic.co/trialextension. To check the status of your trial, use the get trial status API. || `postStartTrial` | `postStartTrial(this: [That](./That.md), params?: [LicensePostStartTrialRequest](./LicensePostStartTrialRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[LicensePostStartTrialResponse](./LicensePostStartTrialResponse.md), unknown>>;` |   || `postStartTrial` | `postStartTrial(this: [That](./That.md), params?: [LicensePostStartTrialRequest](./LicensePostStartTrialRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[LicensePostStartTrialResponse](./LicensePostStartTrialResponse.md)>;` |   | \ No newline at end of file diff --git a/docs/reference/api/LicenseDeleteRequest.md b/docs/reference/api/LicenseDeleteRequest.md new file mode 100644 index 000000000..811bcff15 --- /dev/null +++ b/docs/reference/api/LicenseDeleteRequest.md @@ -0,0 +1,8 @@ +## Interface `LicenseDeleteRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { master_timeout?: never; timeout?: never; }) | All values in `body` will be added to the request body. | +| `master_timeout` | [Duration](./Duration.md) | The period to wait for a connection to the master node. | +| `querystring` | { [key: string]: any; } & { master_timeout?: never; timeout?: never; } | All values in `querystring` will be added to the request querystring. | +| `timeout` | [Duration](./Duration.md) | The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. | diff --git a/docs/reference/api/LicenseDeleteResponse.md b/docs/reference/api/LicenseDeleteResponse.md new file mode 100644 index 000000000..8232f9e3c --- /dev/null +++ b/docs/reference/api/LicenseDeleteResponse.md @@ -0,0 +1,4 @@ +## `LicenseDeleteResponse` +::: +type LicenseDeleteResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); +::: diff --git a/docs/reference/api/LicenseGetBasicStatusRequest.md b/docs/reference/api/LicenseGetBasicStatusRequest.md new file mode 100644 index 000000000..7c7f11d60 --- /dev/null +++ b/docs/reference/api/LicenseGetBasicStatusRequest.md @@ -0,0 +1,6 @@ +## Interface `LicenseGetBasicStatusRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | { [key: string]: any; } | All values in `body` will be added to the request body. | +| `querystring` | { [key: string]: any; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/LicenseGetBasicStatusResponse.md b/docs/reference/api/LicenseGetBasicStatusResponse.md new file mode 100644 index 000000000..19fc0ddb7 --- /dev/null +++ b/docs/reference/api/LicenseGetBasicStatusResponse.md @@ -0,0 +1,5 @@ +## Interface `LicenseGetBasicStatusResponse` + +| Name | Type | Description | +| - | - | - | +| `eligible_to_start_basic` | boolean |   | diff --git a/docs/reference/api/LicenseGetLicenseInformation.md b/docs/reference/api/LicenseGetLicenseInformation.md new file mode 100644 index 000000000..056bc5e0f --- /dev/null +++ b/docs/reference/api/LicenseGetLicenseInformation.md @@ -0,0 +1,16 @@ +## Interface `LicenseGetLicenseInformation` + +| Name | Type | Description | +| - | - | - | +| `expiry_date_in_millis` | [EpochTime](./EpochTime.md)<[UnitMillis](./UnitMillis.md)> |   | +| `expiry_date` | [DateTime](./DateTime.md) |   | +| `issue_date_in_millis` | [EpochTime](./EpochTime.md)<[UnitMillis](./UnitMillis.md)> |   | +| `issue_date` | [DateTime](./DateTime.md) |   | +| `issued_to` | string |   | +| `issuer` | string |   | +| `max_nodes` | [long](./long.md) | null |   | +| `max_resource_units` | [integer](./integer.md) | null |   | +| `start_date_in_millis` | [EpochTime](./EpochTime.md)<[UnitMillis](./UnitMillis.md)> |   | +| `status` | [LicenseLicenseStatus](./LicenseLicenseStatus.md) |   | +| `type` | [LicenseLicenseType](./LicenseLicenseType.md) |   | +| `uid` | [Uuid](./Uuid.md) |   | diff --git a/docs/reference/api/LicenseGetRequest.md b/docs/reference/api/LicenseGetRequest.md new file mode 100644 index 000000000..cde8df8ab --- /dev/null +++ b/docs/reference/api/LicenseGetRequest.md @@ -0,0 +1,8 @@ +## Interface `LicenseGetRequest` + +| Name | Type | Description | +| - | - | - | +| `accept_enterprise` | boolean | If `true`, this parameter returns enterprise for Enterprise license types. If `false`, this parameter returns platinum for both platinum and enterprise license types. This behavior is maintained for backwards compatibility. This parameter is deprecated and will always be set to true in 8.x. | +| `body` | string | ({ [key: string]: any; } & { accept_enterprise?: never; local?: never; }) | All values in `body` will be added to the request body. | +| `local` | boolean | Specifies whether to retrieve local information. The default value is `false`, which means the information is retrieved from the master node. | +| `querystring` | { [key: string]: any; } & { accept_enterprise?: never; local?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/LicenseGetResponse.md b/docs/reference/api/LicenseGetResponse.md new file mode 100644 index 000000000..c61942ec0 --- /dev/null +++ b/docs/reference/api/LicenseGetResponse.md @@ -0,0 +1,5 @@ +## Interface `LicenseGetResponse` + +| Name | Type | Description | +| - | - | - | +| `license` | [LicenseGetLicenseInformation](./LicenseGetLicenseInformation.md) |   | diff --git a/docs/reference/api/LicenseGetTrialStatusRequest.md b/docs/reference/api/LicenseGetTrialStatusRequest.md new file mode 100644 index 000000000..d731cc5c5 --- /dev/null +++ b/docs/reference/api/LicenseGetTrialStatusRequest.md @@ -0,0 +1,6 @@ +## Interface `LicenseGetTrialStatusRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | { [key: string]: any; } | All values in `body` will be added to the request body. | +| `querystring` | { [key: string]: any; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/LicenseGetTrialStatusResponse.md b/docs/reference/api/LicenseGetTrialStatusResponse.md new file mode 100644 index 000000000..35aef1588 --- /dev/null +++ b/docs/reference/api/LicenseGetTrialStatusResponse.md @@ -0,0 +1,5 @@ +## Interface `LicenseGetTrialStatusResponse` + +| Name | Type | Description | +| - | - | - | +| `eligible_to_start_trial` | boolean |   | diff --git a/docs/reference/api/LicenseLicense.md b/docs/reference/api/LicenseLicense.md new file mode 100644 index 000000000..29d364f30 --- /dev/null +++ b/docs/reference/api/LicenseLicense.md @@ -0,0 +1,14 @@ +## Interface `LicenseLicense` + +| Name | Type | Description | +| - | - | - | +| `expiry_date_in_millis` | [EpochTime](./EpochTime.md)<[UnitMillis](./UnitMillis.md)> |   | +| `issue_date_in_millis` | [EpochTime](./EpochTime.md)<[UnitMillis](./UnitMillis.md)> |   | +| `issued_to` | string |   | +| `issuer` | string |   | +| `max_nodes` | [long](./long.md) | null |   | +| `max_resource_units` | [long](./long.md) |   | +| `signature` | string |   | +| `start_date_in_millis` | [EpochTime](./EpochTime.md)<[UnitMillis](./UnitMillis.md)> |   | +| `type` | [LicenseLicenseType](./LicenseLicenseType.md) |   | +| `uid` | string |   | diff --git a/docs/reference/api/LicenseLicenseStatus.md b/docs/reference/api/LicenseLicenseStatus.md new file mode 100644 index 000000000..06d51f5e6 --- /dev/null +++ b/docs/reference/api/LicenseLicenseStatus.md @@ -0,0 +1,4 @@ +## `LicenseLicenseStatus` +::: +type LicenseLicenseStatus = 'active' | 'valid' | 'invalid' | 'expired'; +::: diff --git a/docs/reference/api/LicenseLicenseType.md b/docs/reference/api/LicenseLicenseType.md new file mode 100644 index 000000000..e29946ddb --- /dev/null +++ b/docs/reference/api/LicenseLicenseType.md @@ -0,0 +1,4 @@ +## `LicenseLicenseType` +::: +type LicenseLicenseType = 'missing' | 'trial' | 'basic' | 'standard' | 'dev' | 'silver' | 'gold' | 'platinum' | 'enterprise'; +::: diff --git a/docs/reference/api/LicensePostAcknowledgement.md b/docs/reference/api/LicensePostAcknowledgement.md new file mode 100644 index 000000000..7da6fc09b --- /dev/null +++ b/docs/reference/api/LicensePostAcknowledgement.md @@ -0,0 +1,6 @@ +## Interface `LicensePostAcknowledgement` + +| Name | Type | Description | +| - | - | - | +| `license` | string[] |   | +| `message` | string |   | diff --git a/docs/reference/api/LicensePostRequest.md b/docs/reference/api/LicensePostRequest.md new file mode 100644 index 000000000..81aa593d0 --- /dev/null +++ b/docs/reference/api/LicensePostRequest.md @@ -0,0 +1,11 @@ +## Interface `LicensePostRequest` + +| Name | Type | Description | +| - | - | - | +| `acknowledge` | boolean | Specifies whether you acknowledge the license changes. | +| `body` | string | ({ [key: string]: any; } & { acknowledge?: never; master_timeout?: never; timeout?: never; license?: never; licenses?: never; }) | All values in `body` will be added to the request body. | +| `license` | [LicenseLicense](./LicenseLicense.md) |   | +| `licenses` | [LicenseLicense](./LicenseLicense.md)[] | A sequence of one or more JSON documents containing the license information. | +| `master_timeout` | [Duration](./Duration.md) | The period to wait for a connection to the master node. | +| `querystring` | { [key: string]: any; } & { acknowledge?: never; master_timeout?: never; timeout?: never; license?: never; licenses?: never; } | All values in `querystring` will be added to the request querystring. | +| `timeout` | [Duration](./Duration.md) | The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. | diff --git a/docs/reference/api/LicensePostResponse.md b/docs/reference/api/LicensePostResponse.md new file mode 100644 index 000000000..c0127a787 --- /dev/null +++ b/docs/reference/api/LicensePostResponse.md @@ -0,0 +1,7 @@ +## Interface `LicensePostResponse` + +| Name | Type | Description | +| - | - | - | +| `acknowledge` | [LicensePostAcknowledgement](./LicensePostAcknowledgement.md) |   | +| `acknowledged` | boolean |   | +| `license_status` | [LicenseLicenseStatus](./LicenseLicenseStatus.md) |   | diff --git a/docs/reference/api/LicensePostStartBasicRequest.md b/docs/reference/api/LicensePostStartBasicRequest.md new file mode 100644 index 000000000..807c5e335 --- /dev/null +++ b/docs/reference/api/LicensePostStartBasicRequest.md @@ -0,0 +1,9 @@ +## Interface `LicensePostStartBasicRequest` + +| Name | Type | Description | +| - | - | - | +| `acknowledge` | boolean | whether the user has acknowledged acknowledge messages (default: false) | +| `body` | string | ({ [key: string]: any; } & { acknowledge?: never; master_timeout?: never; timeout?: never; }) | All values in `body` will be added to the request body. | +| `master_timeout` | [Duration](./Duration.md) | Period to wait for a connection to the master node. | +| `querystring` | { [key: string]: any; } & { acknowledge?: never; master_timeout?: never; timeout?: never; } | All values in `querystring` will be added to the request querystring. | +| `timeout` | [Duration](./Duration.md) | Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. | diff --git a/docs/reference/api/LicensePostStartBasicResponse.md b/docs/reference/api/LicensePostStartBasicResponse.md new file mode 100644 index 000000000..702b4985f --- /dev/null +++ b/docs/reference/api/LicensePostStartBasicResponse.md @@ -0,0 +1,9 @@ +## Interface `LicensePostStartBasicResponse` + +| Name | Type | Description | +| - | - | - | +| `acknowledge` | Record |   | +| `acknowledged` | boolean |   | +| `basic_was_started` | boolean |   | +| `error_message` | string |   | +| `type` | [LicenseLicenseType](./LicenseLicenseType.md) |   | diff --git a/docs/reference/api/LicensePostStartTrialRequest.md b/docs/reference/api/LicensePostStartTrialRequest.md new file mode 100644 index 000000000..c45b7fcae --- /dev/null +++ b/docs/reference/api/LicensePostStartTrialRequest.md @@ -0,0 +1,9 @@ +## Interface `LicensePostStartTrialRequest` + +| Name | Type | Description | +| - | - | - | +| `acknowledge` | boolean | whether the user has acknowledged acknowledge messages (default: false) | +| `body` | string | ({ [key: string]: any; } & { acknowledge?: never; type_query_string?: never; master_timeout?: never; }) | All values in `body` will be added to the request body. | +| `master_timeout` | [Duration](./Duration.md) | Period to wait for a connection to the master node. | +| `querystring` | { [key: string]: any; } & { acknowledge?: never; type_query_string?: never; master_timeout?: never; } | All values in `querystring` will be added to the request querystring. | +| `type_query_string` | string |   | diff --git a/docs/reference/api/LicensePostStartTrialResponse.md b/docs/reference/api/LicensePostStartTrialResponse.md new file mode 100644 index 000000000..48c8c21fd --- /dev/null +++ b/docs/reference/api/LicensePostStartTrialResponse.md @@ -0,0 +1,8 @@ +## Interface `LicensePostStartTrialResponse` + +| Name | Type | Description | +| - | - | - | +| `acknowledged` | boolean |   | +| `error_message` | string |   | +| `trial_was_started` | boolean |   | +| `type` | [LicenseLicenseType](./LicenseLicenseType.md) |   | diff --git a/docs/reference/api/LifecycleOperationMode.md b/docs/reference/api/LifecycleOperationMode.md new file mode 100644 index 000000000..08da635ac --- /dev/null +++ b/docs/reference/api/LifecycleOperationMode.md @@ -0,0 +1,4 @@ +## `LifecycleOperationMode` +::: +type LifecycleOperationMode = 'RUNNING' | 'STOPPING' | 'STOPPED'; +::: diff --git a/docs/reference/api/Logstash.md b/docs/reference/api/Logstash.md new file mode 100644 index 000000000..de53bba7b --- /dev/null +++ b/docs/reference/api/Logstash.md @@ -0,0 +1,20 @@ +## `Logstash` + +### Constructor + +::: +new Logstash(transport: [Transport](./Transport.md)); +::: + +### Properties + +| Name | Type | Description | +| - | - | - | +| `acceptedParams` | Record |   | +| `transport` | [Transport](./Transport.md) |   | + +### Methods + +| Name | Signature | Description | +| - | - | - | +| `deletePipeline` | `deletePipeline(this: [That](./That.md), params: [LogstashDeletePipelineRequest](./LogstashDeletePipelineRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[LogstashDeletePipelineResponse](./LogstashDeletePipelineResponse.md)>;` | Delete a Logstash pipeline. Delete a pipeline that is used for Logstash Central Management. If the request succeeds, you receive an empty response with an appropriate status code. || `deletePipeline` | `deletePipeline(this: [That](./That.md), params: [LogstashDeletePipelineRequest](./LogstashDeletePipelineRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[LogstashDeletePipelineResponse](./LogstashDeletePipelineResponse.md), unknown>>;` |   || `deletePipeline` | `deletePipeline(this: [That](./That.md), params: [LogstashDeletePipelineRequest](./LogstashDeletePipelineRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[LogstashDeletePipelineResponse](./LogstashDeletePipelineResponse.md)>;` |   || `getPipeline` | `getPipeline(this: [That](./That.md), params?: [LogstashGetPipelineRequest](./LogstashGetPipelineRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[LogstashGetPipelineResponse](./LogstashGetPipelineResponse.md)>;` | Get Logstash pipelines. Get pipelines that are used for Logstash Central Management. || `getPipeline` | `getPipeline(this: [That](./That.md), params?: [LogstashGetPipelineRequest](./LogstashGetPipelineRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[LogstashGetPipelineResponse](./LogstashGetPipelineResponse.md), unknown>>;` |   || `getPipeline` | `getPipeline(this: [That](./That.md), params?: [LogstashGetPipelineRequest](./LogstashGetPipelineRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[LogstashGetPipelineResponse](./LogstashGetPipelineResponse.md)>;` |   || `putPipeline` | `putPipeline(this: [That](./That.md), params: [LogstashPutPipelineRequest](./LogstashPutPipelineRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[LogstashPutPipelineResponse](./LogstashPutPipelineResponse.md)>;` | Create or update a Logstash pipeline. Create a pipeline that is used for Logstash Central Management. If the specified pipeline exists, it is replaced. || `putPipeline` | `putPipeline(this: [That](./That.md), params: [LogstashPutPipelineRequest](./LogstashPutPipelineRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[LogstashPutPipelineResponse](./LogstashPutPipelineResponse.md), unknown>>;` |   || `putPipeline` | `putPipeline(this: [That](./That.md), params: [LogstashPutPipelineRequest](./LogstashPutPipelineRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[LogstashPutPipelineResponse](./LogstashPutPipelineResponse.md)>;` |   | \ No newline at end of file diff --git a/docs/reference/api/LogstashDeletePipelineRequest.md b/docs/reference/api/LogstashDeletePipelineRequest.md new file mode 100644 index 000000000..c115d52b0 --- /dev/null +++ b/docs/reference/api/LogstashDeletePipelineRequest.md @@ -0,0 +1,7 @@ +## Interface `LogstashDeletePipelineRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { id?: never; }) | All values in `body` will be added to the request body. | +| `id` | [Id](./Id.md) | An identifier for the pipeline. | +| `querystring` | { [key: string]: any; } & { id?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/LogstashDeletePipelineResponse.md b/docs/reference/api/LogstashDeletePipelineResponse.md new file mode 100644 index 000000000..3324b5810 --- /dev/null +++ b/docs/reference/api/LogstashDeletePipelineResponse.md @@ -0,0 +1,4 @@ +## `LogstashDeletePipelineResponse` +::: +type LogstashDeletePipelineResponse = boolean; +::: diff --git a/docs/reference/api/LogstashGetPipelineRequest.md b/docs/reference/api/LogstashGetPipelineRequest.md new file mode 100644 index 000000000..b81828c46 --- /dev/null +++ b/docs/reference/api/LogstashGetPipelineRequest.md @@ -0,0 +1,7 @@ +## Interface `LogstashGetPipelineRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { id?: never; }) | All values in `body` will be added to the request body. | +| `id` | [Ids](./Ids.md) | A comma-separated list of pipeline identifiers. | +| `querystring` | { [key: string]: any; } & { id?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/LogstashGetPipelineResponse.md b/docs/reference/api/LogstashGetPipelineResponse.md new file mode 100644 index 000000000..eb0642aff --- /dev/null +++ b/docs/reference/api/LogstashGetPipelineResponse.md @@ -0,0 +1,4 @@ +## `LogstashGetPipelineResponse` +::: +type LogstashGetPipelineResponse = Record<[Id](./Id.md), [LogstashPipeline](./LogstashPipeline.md)>; +::: diff --git a/docs/reference/api/LogstashPipeline.md b/docs/reference/api/LogstashPipeline.md new file mode 100644 index 000000000..8425868c9 --- /dev/null +++ b/docs/reference/api/LogstashPipeline.md @@ -0,0 +1,10 @@ +## Interface `LogstashPipeline` + +| Name | Type | Description | +| - | - | - | +| `description` | string | A description of the pipeline. This description is not used by Elasticsearch or Logstash. | +| `last_modified` | [DateTime](./DateTime.md) | The date the pipeline was last updated. It must be in the `yyyy-MM-dd'T'HH:mm:ss.SSSZZ` strict_date_time format. | +| `pipeline_metadata` | [LogstashPipelineMetadata](./LogstashPipelineMetadata.md) | Optional metadata about the pipeline, which can have any contents. This metadata is not generated or used by Elasticsearch or Logstash. | +| `pipeline_settings` | [LogstashPipelineSettings](./LogstashPipelineSettings.md) | Settings for the pipeline. It supports only flat keys in dot notation. | +| `pipeline` | string | The configuration for the pipeline. | +| `username` | string | The user who last updated the pipeline. | diff --git a/docs/reference/api/LogstashPipelineMetadata.md b/docs/reference/api/LogstashPipelineMetadata.md new file mode 100644 index 000000000..152b05b6a --- /dev/null +++ b/docs/reference/api/LogstashPipelineMetadata.md @@ -0,0 +1,6 @@ +## Interface `LogstashPipelineMetadata` + +| Name | Type | Description | +| - | - | - | +| `type` | string |   | +| `version` | string |   | diff --git a/docs/reference/api/LogstashPipelineSettings.md b/docs/reference/api/LogstashPipelineSettings.md new file mode 100644 index 000000000..e68fc09ab --- /dev/null +++ b/docs/reference/api/LogstashPipelineSettings.md @@ -0,0 +1,10 @@ +## Interface `LogstashPipelineSettings` + +| Name | Type | Description | +| - | - | - | +| `"pipeline.batch.delay"` | [integer](./integer.md) | When creating pipeline event batches, how long in milliseconds to wait for each event before dispatching an undersized batch to pipeline workers. | +| `"pipeline.batch.size"` | [integer](./integer.md) | The maximum number of events an individual worker thread will collect from inputs before attempting to execute its filters and outputs. | +| `"pipeline.workers"` | [integer](./integer.md) | The number of workers that will, in parallel, execute the filter and output stages of the pipeline. | +| `"queue.checkpoint.writes"` | [integer](./integer.md) | The maximum number of written events before forcing a checkpoint when persistent queues are enabled ( `queue.type: persisted`). | +| `"queue.max_bytes"` | string | The total capacity of the queue ( `queue.type: persisted`) in number of bytes. | +| `"queue.type"` | string | The internal queuing model to use for event buffering. | diff --git a/docs/reference/api/LogstashPutPipelineRequest.md b/docs/reference/api/LogstashPutPipelineRequest.md new file mode 100644 index 000000000..b18aee406 --- /dev/null +++ b/docs/reference/api/LogstashPutPipelineRequest.md @@ -0,0 +1,8 @@ +## Interface `LogstashPutPipelineRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { id?: never; pipeline?: never; }) | All values in `body` will be added to the request body. | +| `id` | [Id](./Id.md) | An identifier for the pipeline. | +| `pipeline` | [LogstashPipeline](./LogstashPipeline.md) |   | +| `querystring` | { [key: string]: any; } & { id?: never; pipeline?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/LogstashPutPipelineResponse.md b/docs/reference/api/LogstashPutPipelineResponse.md new file mode 100644 index 000000000..bcf9d5687 --- /dev/null +++ b/docs/reference/api/LogstashPutPipelineResponse.md @@ -0,0 +1,4 @@ +## `LogstashPutPipelineResponse` +::: +type LogstashPutPipelineResponse = boolean; +::: diff --git a/docs/reference/api/MapboxVectorTiles.md b/docs/reference/api/MapboxVectorTiles.md new file mode 100644 index 000000000..21ebac20c --- /dev/null +++ b/docs/reference/api/MapboxVectorTiles.md @@ -0,0 +1,4 @@ +## `MapboxVectorTiles` +::: +type MapboxVectorTiles = [ArrayBuffer](./ArrayBuffer.md); +::: diff --git a/docs/reference/api/MappingAggregateMetricDoubleProperty.md b/docs/reference/api/MappingAggregateMetricDoubleProperty.md new file mode 100644 index 000000000..756bd23ae --- /dev/null +++ b/docs/reference/api/MappingAggregateMetricDoubleProperty.md @@ -0,0 +1,8 @@ +## Interface `MappingAggregateMetricDoubleProperty` + +| Name | Type | Description | +| - | - | - | +| `default_metric` | string |   | +| `metrics` | string[] |   | +| `time_series_metric` | [MappingTimeSeriesMetricType](./MappingTimeSeriesMetricType.md) |   | +| `type` | 'aggregate_metric_double' |   | diff --git a/docs/reference/api/MappingAllField.md b/docs/reference/api/MappingAllField.md new file mode 100644 index 000000000..38bd61936 --- /dev/null +++ b/docs/reference/api/MappingAllField.md @@ -0,0 +1,14 @@ +## Interface `MappingAllField` + +| Name | Type | Description | +| - | - | - | +| `analyzer` | string |   | +| `enabled` | boolean |   | +| `omit_norms` | boolean |   | +| `search_analyzer` | string |   | +| `similarity` | string |   | +| `store_term_vector_offsets` | boolean |   | +| `store_term_vector_payloads` | boolean |   | +| `store_term_vector_positions` | boolean |   | +| `store_term_vectors` | boolean |   | +| `store` | boolean |   | diff --git a/docs/reference/api/MappingBinaryProperty.md b/docs/reference/api/MappingBinaryProperty.md new file mode 100644 index 000000000..4c9dc5094 --- /dev/null +++ b/docs/reference/api/MappingBinaryProperty.md @@ -0,0 +1,5 @@ +## Interface `MappingBinaryProperty` + +| Name | Type | Description | +| - | - | - | +| `type` | 'binary' |   | diff --git a/docs/reference/api/MappingBooleanProperty.md b/docs/reference/api/MappingBooleanProperty.md new file mode 100644 index 000000000..459a87bd3 --- /dev/null +++ b/docs/reference/api/MappingBooleanProperty.md @@ -0,0 +1,13 @@ +## Interface `MappingBooleanProperty` + +| Name | Type | Description | +| - | - | - | +| `boost` | [double](./double.md) |   | +| `fielddata` | [IndicesNumericFielddata](./IndicesNumericFielddata.md) |   | +| `ignore_malformed` | boolean |   | +| `index` | boolean |   | +| `null_value` | boolean |   | +| `on_script_error` | [MappingOnScriptError](./MappingOnScriptError.md) |   | +| `script` | [Script](./Script.md) | [ScriptSource](./ScriptSource.md) |   | +| `time_series_dimension` | boolean | For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. | +| `type` | 'boolean' |   | diff --git a/docs/reference/api/MappingByteNumberProperty.md b/docs/reference/api/MappingByteNumberProperty.md new file mode 100644 index 000000000..5018f0d49 --- /dev/null +++ b/docs/reference/api/MappingByteNumberProperty.md @@ -0,0 +1,6 @@ +## Interface `MappingByteNumberProperty` + +| Name | Type | Description | +| - | - | - | +| `null_value` | [byte](./byte.md) |   | +| `type` | 'byte' |   | diff --git a/docs/reference/api/MappingChunkingSettings.md b/docs/reference/api/MappingChunkingSettings.md new file mode 100644 index 000000000..1c79bea42 --- /dev/null +++ b/docs/reference/api/MappingChunkingSettings.md @@ -0,0 +1,8 @@ +## Interface `MappingChunkingSettings` + +| Name | Type | Description | +| - | - | - | +| `max_chunk_size` | [integer](./integer.md) | The maximum size of a chunk in words. This value cannot be higher than `300` or lower than `20` (for `sentence` strategy) or `10` (for `word` strategy). | +| `overlap` | [integer](./integer.md) | The number of overlapping words for chunks. It is applicable only to a `word` chunking strategy. This value cannot be higher than half the `max_chunk_size` value. | +| `sentence_overlap` | [integer](./integer.md) | The number of overlapping sentences for chunks. It is applicable only for a `sentence` chunking strategy. It can be either `1` or `0`. | +| `strategy` | string | The chunking strategy: `sentence` or `word`. | diff --git a/docs/reference/api/MappingCompletionProperty.md b/docs/reference/api/MappingCompletionProperty.md new file mode 100644 index 000000000..5db5449ff --- /dev/null +++ b/docs/reference/api/MappingCompletionProperty.md @@ -0,0 +1,11 @@ +## Interface `MappingCompletionProperty` + +| Name | Type | Description | +| - | - | - | +| `analyzer` | string |   | +| `contexts` | [MappingSuggestContext](./MappingSuggestContext.md)[] |   | +| `max_input_length` | [integer](./integer.md) |   | +| `preserve_position_increments` | boolean |   | +| `preserve_separators` | boolean |   | +| `search_analyzer` | string |   | +| `type` | 'completion' |   | diff --git a/docs/reference/api/MappingCompositeSubField.md b/docs/reference/api/MappingCompositeSubField.md new file mode 100644 index 000000000..32db0a0d6 --- /dev/null +++ b/docs/reference/api/MappingCompositeSubField.md @@ -0,0 +1,5 @@ +## Interface `MappingCompositeSubField` + +| Name | Type | Description | +| - | - | - | +| `type` | [MappingRuntimeFieldType](./MappingRuntimeFieldType.md) |   | diff --git a/docs/reference/api/MappingConstantKeywordProperty.md b/docs/reference/api/MappingConstantKeywordProperty.md new file mode 100644 index 000000000..9a975a389 --- /dev/null +++ b/docs/reference/api/MappingConstantKeywordProperty.md @@ -0,0 +1,6 @@ +## Interface `MappingConstantKeywordProperty` + +| Name | Type | Description | +| - | - | - | +| `type` | 'constant_keyword' |   | +| `value` | any |   | diff --git a/docs/reference/api/MappingCorePropertyBase.md b/docs/reference/api/MappingCorePropertyBase.md new file mode 100644 index 000000000..79c3bcdb6 --- /dev/null +++ b/docs/reference/api/MappingCorePropertyBase.md @@ -0,0 +1,6 @@ +## Interface `MappingCorePropertyBase` + +| Name | Type | Description | +| - | - | - | +| `copy_to` | [Fields](./Fields.md) |   | +| `store` | boolean |   | diff --git a/docs/reference/api/MappingCountedKeywordProperty.md b/docs/reference/api/MappingCountedKeywordProperty.md new file mode 100644 index 000000000..37ce8c56e --- /dev/null +++ b/docs/reference/api/MappingCountedKeywordProperty.md @@ -0,0 +1,6 @@ +## Interface `MappingCountedKeywordProperty` + +| Name | Type | Description | +| - | - | - | +| `index` | boolean |   | +| `type` | 'counted_keyword' |   | diff --git a/docs/reference/api/MappingDataStreamTimestamp.md b/docs/reference/api/MappingDataStreamTimestamp.md new file mode 100644 index 000000000..d4003b609 --- /dev/null +++ b/docs/reference/api/MappingDataStreamTimestamp.md @@ -0,0 +1,5 @@ +## Interface `MappingDataStreamTimestamp` + +| Name | Type | Description | +| - | - | - | +| `enabled` | boolean |   | diff --git a/docs/reference/api/MappingDateNanosProperty.md b/docs/reference/api/MappingDateNanosProperty.md new file mode 100644 index 000000000..bff7aedf8 --- /dev/null +++ b/docs/reference/api/MappingDateNanosProperty.md @@ -0,0 +1,13 @@ +## Interface `MappingDateNanosProperty` + +| Name | Type | Description | +| - | - | - | +| `boost` | [double](./double.md) |   | +| `format` | string |   | +| `ignore_malformed` | boolean |   | +| `index` | boolean |   | +| `null_value` | [DateTime](./DateTime.md) |   | +| `on_script_error` | [MappingOnScriptError](./MappingOnScriptError.md) |   | +| `precision_step` | [integer](./integer.md) |   | +| `script` | [Script](./Script.md) | [ScriptSource](./ScriptSource.md) |   | +| `type` | 'date_nanos' |   | diff --git a/docs/reference/api/MappingDateProperty.md b/docs/reference/api/MappingDateProperty.md new file mode 100644 index 000000000..7fb3b35eb --- /dev/null +++ b/docs/reference/api/MappingDateProperty.md @@ -0,0 +1,15 @@ +## Interface `MappingDateProperty` + +| Name | Type | Description | +| - | - | - | +| `boost` | [double](./double.md) |   | +| `fielddata` | [IndicesNumericFielddata](./IndicesNumericFielddata.md) |   | +| `format` | string |   | +| `ignore_malformed` | boolean |   | +| `index` | boolean |   | +| `locale` | string |   | +| `null_value` | [DateTime](./DateTime.md) |   | +| `on_script_error` | [MappingOnScriptError](./MappingOnScriptError.md) |   | +| `precision_step` | [integer](./integer.md) |   | +| `script` | [Script](./Script.md) | [ScriptSource](./ScriptSource.md) |   | +| `type` | 'date' |   | diff --git a/docs/reference/api/MappingDateRangeProperty.md b/docs/reference/api/MappingDateRangeProperty.md new file mode 100644 index 000000000..eaa720838 --- /dev/null +++ b/docs/reference/api/MappingDateRangeProperty.md @@ -0,0 +1,6 @@ +## Interface `MappingDateRangeProperty` + +| Name | Type | Description | +| - | - | - | +| `format` | string |   | +| `type` | 'date_range' |   | diff --git a/docs/reference/api/MappingDenseVectorElementType.md b/docs/reference/api/MappingDenseVectorElementType.md new file mode 100644 index 000000000..fd69e8844 --- /dev/null +++ b/docs/reference/api/MappingDenseVectorElementType.md @@ -0,0 +1,4 @@ +## `MappingDenseVectorElementType` +::: +type MappingDenseVectorElementType = 'bit' | 'byte' | 'float'; +::: diff --git a/docs/reference/api/MappingDenseVectorIndexOptions.md b/docs/reference/api/MappingDenseVectorIndexOptions.md new file mode 100644 index 000000000..5d316f0c0 --- /dev/null +++ b/docs/reference/api/MappingDenseVectorIndexOptions.md @@ -0,0 +1,9 @@ +## Interface `MappingDenseVectorIndexOptions` + +| Name | Type | Description | +| - | - | - | +| `confidence_interval` | [float](./float.md) | The confidence interval to use when quantizing the vectors. Can be any value between and including `0.90` and `1.0` or exactly `0`. When the value is `0`, this indicates that dynamic quantiles should be calculated for optimized quantization. When between `0.90` and `1.0`, this value restricts the values used when calculating the quantization thresholds. For example, a value of `0.95` will only use the middle `95%` of the values when calculating the quantization thresholds (e.g. the highest and lowest `2.5%` of values will be ignored). Defaults to `1/(dims + 1)` for `int8` quantized vectors and `0` for `int4` for dynamic quantile calculation. Only applicable to `int8_hnsw`, `int4_hnsw`, `int8_flat`, and `int4_flat` index types. | +| `ef_construction` | [integer](./integer.md) | The number of candidates to track while assembling the list of nearest neighbors for each new node. Only applicable to `hnsw`, `int8_hnsw`, `bbq_hnsw`, and `int4_hnsw` index types. | +| `m` | [integer](./integer.md) | The number of neighbors each node will be connected to in the HNSW graph. Only applicable to `hnsw`, `int8_hnsw`, `bbq_hnsw`, and `int4_hnsw` index types. | +| `rescore_vector` | [MappingDenseVectorIndexOptionsRescoreVector](./MappingDenseVectorIndexOptionsRescoreVector.md) | The rescore vector options. This is only applicable to `bbq_hnsw`, `int4_hnsw`, `int8_hnsw`, `bbq_flat`, `int4_flat`, and `int8_flat` index types. | +| `type` | [MappingDenseVectorIndexOptionsType](./MappingDenseVectorIndexOptionsType.md) | The type of kNN algorithm to use. | diff --git a/docs/reference/api/MappingDenseVectorIndexOptionsRescoreVector.md b/docs/reference/api/MappingDenseVectorIndexOptionsRescoreVector.md new file mode 100644 index 000000000..82c790c61 --- /dev/null +++ b/docs/reference/api/MappingDenseVectorIndexOptionsRescoreVector.md @@ -0,0 +1,5 @@ +## Interface `MappingDenseVectorIndexOptionsRescoreVector` + +| Name | Type | Description | +| - | - | - | +| `oversample` | [float](./float.md) | The oversampling factor to use when searching for the nearest neighbor. This is only applicable to the quantized formats: `bbq_*`, `int4_*`, and `int8_*`. When provided, `oversample * k` vectors will be gathered and then their scores will be re-computed with the original vectors. valid values are between `1.0` and `10.0` (inclusive), or `0` exactly to disable oversampling. | diff --git a/docs/reference/api/MappingDenseVectorIndexOptionsType.md b/docs/reference/api/MappingDenseVectorIndexOptionsType.md new file mode 100644 index 000000000..181a75957 --- /dev/null +++ b/docs/reference/api/MappingDenseVectorIndexOptionsType.md @@ -0,0 +1,4 @@ +## `MappingDenseVectorIndexOptionsType` +::: +type MappingDenseVectorIndexOptionsType = 'bbq_flat' | 'bbq_hnsw' | 'flat' | 'hnsw' | 'int4_flat' | 'int4_hnsw' | 'int8_flat' | 'int8_hnsw'; +::: diff --git a/docs/reference/api/MappingDenseVectorProperty.md b/docs/reference/api/MappingDenseVectorProperty.md new file mode 100644 index 000000000..28727bbdd --- /dev/null +++ b/docs/reference/api/MappingDenseVectorProperty.md @@ -0,0 +1,10 @@ +## Interface `MappingDenseVectorProperty` + +| Name | Type | Description | +| - | - | - | +| `dims` | [integer](./integer.md) | Number of vector dimensions. Can't exceed `4096`. If `dims` is not specified, it will be set to the length of the first vector added to the field. | +| `element_type` | [MappingDenseVectorElementType](./MappingDenseVectorElementType.md) | The data type used to encode vectors. The supported data types are `float` (default), `byte`, and `bit`. | +| `index_options` | [MappingDenseVectorIndexOptions](./MappingDenseVectorIndexOptions.md) | An optional section that configures the kNN indexing algorithm. The HNSW algorithm has two internal parameters that influence how the data structure is built. These can be adjusted to improve the accuracy of results, at the expense of slower indexing speed. This parameter can only be specified when `index` is `true`. | +| `index` | boolean | If `true`, you can search this field using the kNN search API. | +| `similarity` | [MappingDenseVectorSimilarity](./MappingDenseVectorSimilarity.md) | The vector similarity metric to use in kNN search. Documents are ranked by their vector field's similarity to the query vector. The `_score` of each document will be derived from the similarity, in a way that ensures scores are positive and that a larger score corresponds to a higher ranking. Defaults to `l2_norm` when `element_type` is `bit` otherwise defaults to `cosine`. `bit` vectors only support `l2_norm` as their similarity metric. This parameter can only be specified when `index` is `true`. | +| `type` | 'dense_vector' |   | diff --git a/docs/reference/api/MappingDenseVectorSimilarity.md b/docs/reference/api/MappingDenseVectorSimilarity.md new file mode 100644 index 000000000..6d4ef8742 --- /dev/null +++ b/docs/reference/api/MappingDenseVectorSimilarity.md @@ -0,0 +1,4 @@ +## `MappingDenseVectorSimilarity` +::: +type MappingDenseVectorSimilarity = 'cosine' | 'dot_product' | 'l2_norm' | 'max_inner_product'; +::: diff --git a/docs/reference/api/MappingDocValuesPropertyBase.md b/docs/reference/api/MappingDocValuesPropertyBase.md new file mode 100644 index 000000000..176ee9195 --- /dev/null +++ b/docs/reference/api/MappingDocValuesPropertyBase.md @@ -0,0 +1,5 @@ +## Interface `MappingDocValuesPropertyBase` + +| Name | Type | Description | +| - | - | - | +| `doc_values` | boolean |   | diff --git a/docs/reference/api/MappingDoubleNumberProperty.md b/docs/reference/api/MappingDoubleNumberProperty.md new file mode 100644 index 000000000..62b9ef542 --- /dev/null +++ b/docs/reference/api/MappingDoubleNumberProperty.md @@ -0,0 +1,6 @@ +## Interface `MappingDoubleNumberProperty` + +| Name | Type | Description | +| - | - | - | +| `null_value` | [double](./double.md) |   | +| `type` | 'double' |   | diff --git a/docs/reference/api/MappingDoubleRangeProperty.md b/docs/reference/api/MappingDoubleRangeProperty.md new file mode 100644 index 000000000..c3af1603e --- /dev/null +++ b/docs/reference/api/MappingDoubleRangeProperty.md @@ -0,0 +1,5 @@ +## Interface `MappingDoubleRangeProperty` + +| Name | Type | Description | +| - | - | - | +| `type` | 'double_range' |   | diff --git a/docs/reference/api/MappingDynamicMapping.md b/docs/reference/api/MappingDynamicMapping.md new file mode 100644 index 000000000..c748d3385 --- /dev/null +++ b/docs/reference/api/MappingDynamicMapping.md @@ -0,0 +1,4 @@ +## `MappingDynamicMapping` +::: +type MappingDynamicMapping = boolean | 'strict' | 'runtime' | 'true' | 'false'; +::: diff --git a/docs/reference/api/MappingDynamicProperty.md b/docs/reference/api/MappingDynamicProperty.md new file mode 100644 index 000000000..b03e89155 --- /dev/null +++ b/docs/reference/api/MappingDynamicProperty.md @@ -0,0 +1,27 @@ +## Interface `MappingDynamicProperty` + +| Name | Type | Description | +| - | - | - | +| `analyzer` | string |   | +| `boost` | [double](./double.md) |   | +| `coerce` | boolean |   | +| `eager_global_ordinals` | boolean |   | +| `enabled` | boolean |   | +| `format` | string |   | +| `ignore_malformed` | boolean |   | +| `index_options` | [MappingIndexOptions](./MappingIndexOptions.md) |   | +| `index_phrases` | boolean |   | +| `index_prefixes` | [MappingTextIndexPrefixes](./MappingTextIndexPrefixes.md) | null |   | +| `index` | boolean |   | +| `locale` | string |   | +| `norms` | boolean |   | +| `null_value` | [FieldValue](./FieldValue.md) |   | +| `on_script_error` | [MappingOnScriptError](./MappingOnScriptError.md) |   | +| `position_increment_gap` | [integer](./integer.md) |   | +| `precision_step` | [integer](./integer.md) |   | +| `script` | [Script](./Script.md) | [ScriptSource](./ScriptSource.md) |   | +| `search_analyzer` | string |   | +| `search_quote_analyzer` | string |   | +| `term_vector` | [MappingTermVectorOption](./MappingTermVectorOption.md) |   | +| `time_series_metric` | [MappingTimeSeriesMetricType](./MappingTimeSeriesMetricType.md) |   | +| `type` | '{dynamic_type}' |   | diff --git a/docs/reference/api/MappingDynamicTemplate.md b/docs/reference/api/MappingDynamicTemplate.md new file mode 100644 index 000000000..426cc3088 --- /dev/null +++ b/docs/reference/api/MappingDynamicTemplate.md @@ -0,0 +1,13 @@ +## Interface `MappingDynamicTemplate` + +| Name | Type | Description | +| - | - | - | +| `mapping` | [MappingProperty](./MappingProperty.md) |   | +| `match_mapping_type` | string | string[] |   | +| `match_pattern` | [MappingMatchType](./MappingMatchType.md) |   | +| `match` | string | string[] |   | +| `path_match` | string | string[] |   | +| `path_unmatch` | string | string[] |   | +| `runtime` | [MappingRuntimeField](./MappingRuntimeField.md) |   | +| `unmatch_mapping_type` | string | string[] |   | +| `unmatch` | string | string[] |   | diff --git a/docs/reference/api/MappingFieldAliasProperty.md b/docs/reference/api/MappingFieldAliasProperty.md new file mode 100644 index 000000000..a1a939205 --- /dev/null +++ b/docs/reference/api/MappingFieldAliasProperty.md @@ -0,0 +1,6 @@ +## Interface `MappingFieldAliasProperty` + +| Name | Type | Description | +| - | - | - | +| `path` | [Field](./Field.md) |   | +| `type` | 'alias' |   | diff --git a/docs/reference/api/MappingFieldMapping.md b/docs/reference/api/MappingFieldMapping.md new file mode 100644 index 000000000..fb763288c --- /dev/null +++ b/docs/reference/api/MappingFieldMapping.md @@ -0,0 +1,6 @@ +## Interface `MappingFieldMapping` + +| Name | Type | Description | +| - | - | - | +| `full_name` | string |   | +| `mapping` | [Partial](./Partial.md)> |   | diff --git a/docs/reference/api/MappingFieldNamesField.md b/docs/reference/api/MappingFieldNamesField.md new file mode 100644 index 000000000..10d5c573c --- /dev/null +++ b/docs/reference/api/MappingFieldNamesField.md @@ -0,0 +1,5 @@ +## Interface `MappingFieldNamesField` + +| Name | Type | Description | +| - | - | - | +| `enabled` | boolean |   | diff --git a/docs/reference/api/MappingFieldType.md b/docs/reference/api/MappingFieldType.md new file mode 100644 index 000000000..ce15a68c6 --- /dev/null +++ b/docs/reference/api/MappingFieldType.md @@ -0,0 +1,4 @@ +## `MappingFieldType` +::: +type MappingFieldType = 'none' | 'geo_point' | 'geo_shape' | 'ip' | 'binary' | 'keyword' | 'text' | 'search_as_you_type' | 'date' | 'date_nanos' | 'boolean' | 'completion' | 'nested' | 'object' | 'passthrough' | 'version' | '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' | 'counted_keyword' | 'aggregate_metric_double' | 'dense_vector' | 'semantic_text' | 'sparse_vector' | 'match_only_text' | 'icu_collation_keyword'; +::: diff --git a/docs/reference/api/MappingFlattenedProperty.md b/docs/reference/api/MappingFlattenedProperty.md new file mode 100644 index 000000000..4cfa47112 --- /dev/null +++ b/docs/reference/api/MappingFlattenedProperty.md @@ -0,0 +1,14 @@ +## Interface `MappingFlattenedProperty` + +| Name | Type | Description | +| - | - | - | +| `boost` | [double](./double.md) |   | +| `depth_limit` | [integer](./integer.md) |   | +| `doc_values` | boolean |   | +| `eager_global_ordinals` | boolean |   | +| `index_options` | [MappingIndexOptions](./MappingIndexOptions.md) |   | +| `index` | boolean |   | +| `null_value` | string |   | +| `similarity` | string |   | +| `split_queries_on_whitespace` | boolean |   | +| `type` | 'flattened' |   | diff --git a/docs/reference/api/MappingFloatNumberProperty.md b/docs/reference/api/MappingFloatNumberProperty.md new file mode 100644 index 000000000..b484d0518 --- /dev/null +++ b/docs/reference/api/MappingFloatNumberProperty.md @@ -0,0 +1,6 @@ +## Interface `MappingFloatNumberProperty` + +| Name | Type | Description | +| - | - | - | +| `null_value` | [float](./float.md) |   | +| `type` | 'float' |   | diff --git a/docs/reference/api/MappingFloatRangeProperty.md b/docs/reference/api/MappingFloatRangeProperty.md new file mode 100644 index 000000000..60543db48 --- /dev/null +++ b/docs/reference/api/MappingFloatRangeProperty.md @@ -0,0 +1,5 @@ +## Interface `MappingFloatRangeProperty` + +| Name | Type | Description | +| - | - | - | +| `type` | 'float_range' |   | diff --git a/docs/reference/api/MappingGeoOrientation.md b/docs/reference/api/MappingGeoOrientation.md new file mode 100644 index 000000000..0b9aa141e --- /dev/null +++ b/docs/reference/api/MappingGeoOrientation.md @@ -0,0 +1,4 @@ +## `MappingGeoOrientation` +::: +type MappingGeoOrientation = 'right' | 'RIGHT' | 'counterclockwise' | 'ccw' | 'left' | 'LEFT' | 'clockwise' | 'cw'; +::: diff --git a/docs/reference/api/MappingGeoPointProperty.md b/docs/reference/api/MappingGeoPointProperty.md new file mode 100644 index 000000000..47129d1fd --- /dev/null +++ b/docs/reference/api/MappingGeoPointProperty.md @@ -0,0 +1,11 @@ +## Interface `MappingGeoPointProperty` + +| Name | Type | Description | +| - | - | - | +| `ignore_malformed` | boolean |   | +| `ignore_z_value` | boolean |   | +| `index` | boolean |   | +| `null_value` | [GeoLocation](./GeoLocation.md) |   | +| `on_script_error` | [MappingOnScriptError](./MappingOnScriptError.md) |   | +| `script` | [Script](./Script.md) | [ScriptSource](./ScriptSource.md) |   | +| `type` | 'geo_point' |   | diff --git a/docs/reference/api/MappingGeoShapeProperty.md b/docs/reference/api/MappingGeoShapeProperty.md new file mode 100644 index 000000000..a2edfde48 --- /dev/null +++ b/docs/reference/api/MappingGeoShapeProperty.md @@ -0,0 +1,11 @@ +## Interface `MappingGeoShapeProperty` + +| Name | Type | Description | +| - | - | - | +| `coerce` | boolean |   | +| `ignore_malformed` | boolean |   | +| `ignore_z_value` | boolean |   | +| `index` | boolean |   | +| `orientation` | [MappingGeoOrientation](./MappingGeoOrientation.md) |   | +| `strategy` | [MappingGeoStrategy](./MappingGeoStrategy.md) |   | +| `type` | 'geo_shape' |   | diff --git a/docs/reference/api/MappingGeoStrategy.md b/docs/reference/api/MappingGeoStrategy.md new file mode 100644 index 000000000..6e2bea3b7 --- /dev/null +++ b/docs/reference/api/MappingGeoStrategy.md @@ -0,0 +1,4 @@ +## `MappingGeoStrategy` +::: +type MappingGeoStrategy = 'recursive' | 'term'; +::: diff --git a/docs/reference/api/MappingHalfFloatNumberProperty.md b/docs/reference/api/MappingHalfFloatNumberProperty.md new file mode 100644 index 000000000..490f7109e --- /dev/null +++ b/docs/reference/api/MappingHalfFloatNumberProperty.md @@ -0,0 +1,6 @@ +## Interface `MappingHalfFloatNumberProperty` + +| Name | Type | Description | +| - | - | - | +| `null_value` | [float](./float.md) |   | +| `type` | 'half_float' |   | diff --git a/docs/reference/api/MappingHistogramProperty.md b/docs/reference/api/MappingHistogramProperty.md new file mode 100644 index 000000000..6caac0b06 --- /dev/null +++ b/docs/reference/api/MappingHistogramProperty.md @@ -0,0 +1,6 @@ +## Interface `MappingHistogramProperty` + +| Name | Type | Description | +| - | - | - | +| `ignore_malformed` | boolean |   | +| `type` | 'histogram' |   | diff --git a/docs/reference/api/MappingIcuCollationProperty.md b/docs/reference/api/MappingIcuCollationProperty.md new file mode 100644 index 000000000..abb23d02d --- /dev/null +++ b/docs/reference/api/MappingIcuCollationProperty.md @@ -0,0 +1,21 @@ +## Interface `MappingIcuCollationProperty` + +| Name | Type | Description | +| - | - | - | +| `alternate` | [AnalysisIcuCollationAlternate](./AnalysisIcuCollationAlternate.md) |   | +| `case_first` | [AnalysisIcuCollationCaseFirst](./AnalysisIcuCollationCaseFirst.md) |   | +| `case_level` | boolean |   | +| `country` | string |   | +| `decomposition` | [AnalysisIcuCollationDecomposition](./AnalysisIcuCollationDecomposition.md) |   | +| `hiragana_quaternary_mode` | boolean |   | +| `index_options` | [MappingIndexOptions](./MappingIndexOptions.md) |   | +| `index` | boolean | Should the field be searchable? | +| `language` | string |   | +| `norms` | boolean |   | +| `null_value` | string | Accepts a string value which is substituted for any explicit null values. Defaults to null, which means the field is treated as missing. | +| `numeric` | boolean |   | +| `rules` | string |   | +| `strength` | [AnalysisIcuCollationStrength](./AnalysisIcuCollationStrength.md) |   | +| `type` | 'icu_collation_keyword' |   | +| `variable_top` | string |   | +| `variant` | string |   | diff --git a/docs/reference/api/MappingIndexField.md b/docs/reference/api/MappingIndexField.md new file mode 100644 index 000000000..afeb02483 --- /dev/null +++ b/docs/reference/api/MappingIndexField.md @@ -0,0 +1,5 @@ +## Interface `MappingIndexField` + +| Name | Type | Description | +| - | - | - | +| `enabled` | boolean |   | diff --git a/docs/reference/api/MappingIndexOptions.md b/docs/reference/api/MappingIndexOptions.md new file mode 100644 index 000000000..f9995468f --- /dev/null +++ b/docs/reference/api/MappingIndexOptions.md @@ -0,0 +1,4 @@ +## `MappingIndexOptions` +::: +type MappingIndexOptions = 'docs' | 'freqs' | 'positions' | 'offsets'; +::: diff --git a/docs/reference/api/MappingIntegerNumberProperty.md b/docs/reference/api/MappingIntegerNumberProperty.md new file mode 100644 index 000000000..af421dcc9 --- /dev/null +++ b/docs/reference/api/MappingIntegerNumberProperty.md @@ -0,0 +1,6 @@ +## Interface `MappingIntegerNumberProperty` + +| Name | Type | Description | +| - | - | - | +| `null_value` | [integer](./integer.md) |   | +| `type` | 'integer' |   | diff --git a/docs/reference/api/MappingIntegerRangeProperty.md b/docs/reference/api/MappingIntegerRangeProperty.md new file mode 100644 index 000000000..ddf78774d --- /dev/null +++ b/docs/reference/api/MappingIntegerRangeProperty.md @@ -0,0 +1,5 @@ +## Interface `MappingIntegerRangeProperty` + +| Name | Type | Description | +| - | - | - | +| `type` | 'integer_range' |   | diff --git a/docs/reference/api/MappingIpProperty.md b/docs/reference/api/MappingIpProperty.md new file mode 100644 index 000000000..e1f578d6b --- /dev/null +++ b/docs/reference/api/MappingIpProperty.md @@ -0,0 +1,12 @@ +## Interface `MappingIpProperty` + +| Name | Type | Description | +| - | - | - | +| `boost` | [double](./double.md) |   | +| `ignore_malformed` | boolean |   | +| `index` | boolean |   | +| `null_value` | string |   | +| `on_script_error` | [MappingOnScriptError](./MappingOnScriptError.md) |   | +| `script` | [Script](./Script.md) | [ScriptSource](./ScriptSource.md) |   | +| `time_series_dimension` | boolean | For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. | +| `type` | 'ip' |   | diff --git a/docs/reference/api/MappingIpRangeProperty.md b/docs/reference/api/MappingIpRangeProperty.md new file mode 100644 index 000000000..7b4447681 --- /dev/null +++ b/docs/reference/api/MappingIpRangeProperty.md @@ -0,0 +1,5 @@ +## Interface `MappingIpRangeProperty` + +| Name | Type | Description | +| - | - | - | +| `type` | 'ip_range' |   | diff --git a/docs/reference/api/MappingJoinProperty.md b/docs/reference/api/MappingJoinProperty.md new file mode 100644 index 000000000..f12cc9cab --- /dev/null +++ b/docs/reference/api/MappingJoinProperty.md @@ -0,0 +1,7 @@ +## Interface `MappingJoinProperty` + +| Name | Type | Description | +| - | - | - | +| `eager_global_ordinals` | boolean |   | +| `relations` | Record<[RelationName](./RelationName.md), [RelationName](./RelationName.md) | [RelationName](./RelationName.md)[]> |   | +| `type` | 'join' |   | diff --git a/docs/reference/api/MappingKeywordProperty.md b/docs/reference/api/MappingKeywordProperty.md new file mode 100644 index 000000000..197e415c0 --- /dev/null +++ b/docs/reference/api/MappingKeywordProperty.md @@ -0,0 +1,17 @@ +## Interface `MappingKeywordProperty` + +| Name | Type | Description | +| - | - | - | +| `boost` | [double](./double.md) |   | +| `eager_global_ordinals` | boolean |   | +| `index_options` | [MappingIndexOptions](./MappingIndexOptions.md) |   | +| `index` | boolean |   | +| `normalizer` | string |   | +| `norms` | boolean |   | +| `null_value` | string |   | +| `on_script_error` | [MappingOnScriptError](./MappingOnScriptError.md) |   | +| `script` | [Script](./Script.md) | [ScriptSource](./ScriptSource.md) |   | +| `similarity` | string | null |   | +| `split_queries_on_whitespace` | boolean |   | +| `time_series_dimension` | boolean | For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. | +| `type` | 'keyword' |   | diff --git a/docs/reference/api/MappingLongNumberProperty.md b/docs/reference/api/MappingLongNumberProperty.md new file mode 100644 index 000000000..1f8e1b658 --- /dev/null +++ b/docs/reference/api/MappingLongNumberProperty.md @@ -0,0 +1,6 @@ +## Interface `MappingLongNumberProperty` + +| Name | Type | Description | +| - | - | - | +| `null_value` | [long](./long.md) |   | +| `type` | 'long' |   | diff --git a/docs/reference/api/MappingLongRangeProperty.md b/docs/reference/api/MappingLongRangeProperty.md new file mode 100644 index 000000000..33ee6b802 --- /dev/null +++ b/docs/reference/api/MappingLongRangeProperty.md @@ -0,0 +1,5 @@ +## Interface `MappingLongRangeProperty` + +| Name | Type | Description | +| - | - | - | +| `type` | 'long_range' |   | diff --git a/docs/reference/api/MappingMatchOnlyTextProperty.md b/docs/reference/api/MappingMatchOnlyTextProperty.md new file mode 100644 index 000000000..3a80fff69 --- /dev/null +++ b/docs/reference/api/MappingMatchOnlyTextProperty.md @@ -0,0 +1,8 @@ +## Interface `MappingMatchOnlyTextProperty` + +| Name | Type | Description | +| - | - | - | +| `copy_to` | [Fields](./Fields.md) | Allows you to copy the values of multiple fields into a group field, which can then be queried as a single field. | +| `fields` | Record<[PropertyName](./PropertyName.md), [MappingProperty](./MappingProperty.md)> | Multi-fields allow the same string value to be indexed in multiple ways for different purposes, such as one field for search and a multi-field for sorting and aggregations, or the same string value analyzed by different analyzers. | +| `meta` | Record | Metadata about the field. | +| `type` | 'match_only_text' |   | diff --git a/docs/reference/api/MappingMatchType.md b/docs/reference/api/MappingMatchType.md new file mode 100644 index 000000000..9d139287e --- /dev/null +++ b/docs/reference/api/MappingMatchType.md @@ -0,0 +1,4 @@ +## `MappingMatchType` +::: +type MappingMatchType = 'simple' | 'regex'; +::: diff --git a/docs/reference/api/MappingMurmur3HashProperty.md b/docs/reference/api/MappingMurmur3HashProperty.md new file mode 100644 index 000000000..408a82bde --- /dev/null +++ b/docs/reference/api/MappingMurmur3HashProperty.md @@ -0,0 +1,5 @@ +## Interface `MappingMurmur3HashProperty` + +| Name | Type | Description | +| - | - | - | +| `type` | 'murmur3' |   | diff --git a/docs/reference/api/MappingNestedProperty.md b/docs/reference/api/MappingNestedProperty.md new file mode 100644 index 000000000..d9f7a05e3 --- /dev/null +++ b/docs/reference/api/MappingNestedProperty.md @@ -0,0 +1,8 @@ +## Interface `MappingNestedProperty` + +| Name | Type | Description | +| - | - | - | +| `enabled` | boolean |   | +| `include_in_parent` | boolean |   | +| `include_in_root` | boolean |   | +| `type` | 'nested' |   | diff --git a/docs/reference/api/MappingNumberPropertyBase.md b/docs/reference/api/MappingNumberPropertyBase.md new file mode 100644 index 000000000..1d826a501 --- /dev/null +++ b/docs/reference/api/MappingNumberPropertyBase.md @@ -0,0 +1,12 @@ +## Interface `MappingNumberPropertyBase` + +| Name | Type | Description | +| - | - | - | +| `boost` | [double](./double.md) |   | +| `coerce` | boolean |   | +| `ignore_malformed` | boolean |   | +| `index` | boolean |   | +| `on_script_error` | [MappingOnScriptError](./MappingOnScriptError.md) |   | +| `script` | [Script](./Script.md) | [ScriptSource](./ScriptSource.md) |   | +| `time_series_dimension` | boolean | For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. | +| `time_series_metric` | [MappingTimeSeriesMetricType](./MappingTimeSeriesMetricType.md) | For internal use by Elastic only. Marks the field as a time series dimension. Defaults to false. | diff --git a/docs/reference/api/MappingObjectProperty.md b/docs/reference/api/MappingObjectProperty.md new file mode 100644 index 000000000..c31bc911f --- /dev/null +++ b/docs/reference/api/MappingObjectProperty.md @@ -0,0 +1,7 @@ +## Interface `MappingObjectProperty` + +| Name | Type | Description | +| - | - | - | +| `enabled` | boolean |   | +| `subobjects` | [MappingSubobjects](./MappingSubobjects.md) |   | +| `type` | 'object' |   | diff --git a/docs/reference/api/MappingOnScriptError.md b/docs/reference/api/MappingOnScriptError.md new file mode 100644 index 000000000..a548430a1 --- /dev/null +++ b/docs/reference/api/MappingOnScriptError.md @@ -0,0 +1,4 @@ +## `MappingOnScriptError` +::: +type MappingOnScriptError = 'fail' | 'continue'; +::: diff --git a/docs/reference/api/MappingPassthroughObjectProperty.md b/docs/reference/api/MappingPassthroughObjectProperty.md new file mode 100644 index 000000000..b8c313e0a --- /dev/null +++ b/docs/reference/api/MappingPassthroughObjectProperty.md @@ -0,0 +1,8 @@ +## Interface `MappingPassthroughObjectProperty` + +| Name | Type | Description | +| - | - | - | +| `enabled` | boolean |   | +| `priority` | [integer](./integer.md) |   | +| `time_series_dimension` | boolean |   | +| `type` | 'passthrough' |   | diff --git a/docs/reference/api/MappingPercolatorProperty.md b/docs/reference/api/MappingPercolatorProperty.md new file mode 100644 index 000000000..dc2a426a9 --- /dev/null +++ b/docs/reference/api/MappingPercolatorProperty.md @@ -0,0 +1,5 @@ +## Interface `MappingPercolatorProperty` + +| Name | Type | Description | +| - | - | - | +| `type` | 'percolator' |   | diff --git a/docs/reference/api/MappingPointProperty.md b/docs/reference/api/MappingPointProperty.md new file mode 100644 index 000000000..cfece523c --- /dev/null +++ b/docs/reference/api/MappingPointProperty.md @@ -0,0 +1,8 @@ +## Interface `MappingPointProperty` + +| Name | Type | Description | +| - | - | - | +| `ignore_malformed` | boolean |   | +| `ignore_z_value` | boolean |   | +| `null_value` | string |   | +| `type` | 'point' |   | diff --git a/docs/reference/api/MappingProperty.md b/docs/reference/api/MappingProperty.md new file mode 100644 index 000000000..1193df07a --- /dev/null +++ b/docs/reference/api/MappingProperty.md @@ -0,0 +1,4 @@ +## `MappingProperty` +::: +type MappingProperty = [MappingBinaryProperty](./MappingBinaryProperty.md) | [MappingBooleanProperty](./MappingBooleanProperty.md) | [MappingDynamicProperty](./MappingDynamicProperty.md) | [MappingJoinProperty](./MappingJoinProperty.md) | [MappingKeywordProperty](./MappingKeywordProperty.md) | [MappingMatchOnlyTextProperty](./MappingMatchOnlyTextProperty.md) | [MappingPercolatorProperty](./MappingPercolatorProperty.md) | [MappingRankFeatureProperty](./MappingRankFeatureProperty.md) | [MappingRankFeaturesProperty](./MappingRankFeaturesProperty.md) | [MappingSearchAsYouTypeProperty](./MappingSearchAsYouTypeProperty.md) | [MappingTextProperty](./MappingTextProperty.md) | [MappingVersionProperty](./MappingVersionProperty.md) | [MappingWildcardProperty](./MappingWildcardProperty.md) | [MappingDateNanosProperty](./MappingDateNanosProperty.md) | [MappingDateProperty](./MappingDateProperty.md) | [MappingAggregateMetricDoubleProperty](./MappingAggregateMetricDoubleProperty.md) | [MappingDenseVectorProperty](./MappingDenseVectorProperty.md) | [MappingFlattenedProperty](./MappingFlattenedProperty.md) | [MappingNestedProperty](./MappingNestedProperty.md) | [MappingObjectProperty](./MappingObjectProperty.md) | [MappingPassthroughObjectProperty](./MappingPassthroughObjectProperty.md) | [MappingSemanticTextProperty](./MappingSemanticTextProperty.md) | [MappingSparseVectorProperty](./MappingSparseVectorProperty.md) | [MappingCompletionProperty](./MappingCompletionProperty.md) | [MappingConstantKeywordProperty](./MappingConstantKeywordProperty.md) | [MappingCountedKeywordProperty](./MappingCountedKeywordProperty.md) | [MappingFieldAliasProperty](./MappingFieldAliasProperty.md) | [MappingHistogramProperty](./MappingHistogramProperty.md) | [MappingIpProperty](./MappingIpProperty.md) | [MappingMurmur3HashProperty](./MappingMurmur3HashProperty.md) | [MappingTokenCountProperty](./MappingTokenCountProperty.md) | [MappingGeoPointProperty](./MappingGeoPointProperty.md) | [MappingGeoShapeProperty](./MappingGeoShapeProperty.md) | [MappingPointProperty](./MappingPointProperty.md) | [MappingShapeProperty](./MappingShapeProperty.md) | [MappingByteNumberProperty](./MappingByteNumberProperty.md) | [MappingDoubleNumberProperty](./MappingDoubleNumberProperty.md) | [MappingFloatNumberProperty](./MappingFloatNumberProperty.md) | [MappingHalfFloatNumberProperty](./MappingHalfFloatNumberProperty.md) | [MappingIntegerNumberProperty](./MappingIntegerNumberProperty.md) | [MappingLongNumberProperty](./MappingLongNumberProperty.md) | [MappingScaledFloatNumberProperty](./MappingScaledFloatNumberProperty.md) | [MappingShortNumberProperty](./MappingShortNumberProperty.md) | [MappingUnsignedLongNumberProperty](./MappingUnsignedLongNumberProperty.md) | [MappingDateRangeProperty](./MappingDateRangeProperty.md) | [MappingDoubleRangeProperty](./MappingDoubleRangeProperty.md) | [MappingFloatRangeProperty](./MappingFloatRangeProperty.md) | [MappingIntegerRangeProperty](./MappingIntegerRangeProperty.md) | [MappingIpRangeProperty](./MappingIpRangeProperty.md) | [MappingLongRangeProperty](./MappingLongRangeProperty.md) | [MappingIcuCollationProperty](./MappingIcuCollationProperty.md); +::: diff --git a/docs/reference/api/MappingPropertyBase.md b/docs/reference/api/MappingPropertyBase.md new file mode 100644 index 000000000..b12741054 --- /dev/null +++ b/docs/reference/api/MappingPropertyBase.md @@ -0,0 +1,10 @@ +## Interface `MappingPropertyBase` + +| Name | Type | Description | +| - | - | - | +| `dynamic` | [MappingDynamicMapping](./MappingDynamicMapping.md) |   | +| `fields` | Record<[PropertyName](./PropertyName.md), [MappingProperty](./MappingProperty.md)> |   | +| `ignore_above` | [integer](./integer.md) |   | +| `meta` | Record | Metadata about the field. | +| `properties` | Record<[PropertyName](./PropertyName.md), [MappingProperty](./MappingProperty.md)> |   | +| `synthetic_source_keep` | [MappingSyntheticSourceKeepEnum](./MappingSyntheticSourceKeepEnum.md) |   | diff --git a/docs/reference/api/MappingRangePropertyBase.md b/docs/reference/api/MappingRangePropertyBase.md new file mode 100644 index 000000000..5635dabc8 --- /dev/null +++ b/docs/reference/api/MappingRangePropertyBase.md @@ -0,0 +1,7 @@ +## Interface `MappingRangePropertyBase` + +| Name | Type | Description | +| - | - | - | +| `boost` | [double](./double.md) |   | +| `coerce` | boolean |   | +| `index` | boolean |   | diff --git a/docs/reference/api/MappingRankFeatureProperty.md b/docs/reference/api/MappingRankFeatureProperty.md new file mode 100644 index 000000000..bd2876073 --- /dev/null +++ b/docs/reference/api/MappingRankFeatureProperty.md @@ -0,0 +1,6 @@ +## Interface `MappingRankFeatureProperty` + +| Name | Type | Description | +| - | - | - | +| `positive_score_impact` | boolean |   | +| `type` | 'rank_feature' |   | diff --git a/docs/reference/api/MappingRankFeaturesProperty.md b/docs/reference/api/MappingRankFeaturesProperty.md new file mode 100644 index 000000000..4515ec672 --- /dev/null +++ b/docs/reference/api/MappingRankFeaturesProperty.md @@ -0,0 +1,6 @@ +## Interface `MappingRankFeaturesProperty` + +| Name | Type | Description | +| - | - | - | +| `positive_score_impact` | boolean |   | +| `type` | 'rank_features' |   | diff --git a/docs/reference/api/MappingRoutingField.md b/docs/reference/api/MappingRoutingField.md new file mode 100644 index 000000000..376479854 --- /dev/null +++ b/docs/reference/api/MappingRoutingField.md @@ -0,0 +1,5 @@ +## Interface `MappingRoutingField` + +| Name | Type | Description | +| - | - | - | +| `required` | boolean |   | diff --git a/docs/reference/api/MappingRuntimeField.md b/docs/reference/api/MappingRuntimeField.md new file mode 100644 index 000000000..0ac004b2b --- /dev/null +++ b/docs/reference/api/MappingRuntimeField.md @@ -0,0 +1,12 @@ +## Interface `MappingRuntimeField` + +| Name | Type | Description | +| - | - | - | +| `fetch_fields` | ([MappingRuntimeFieldFetchFields](./MappingRuntimeFieldFetchFields.md) | [Field](./Field.md))[] | For type `lookup` | +| `fields` | Record | For type `composite` | +| `format` | string | A custom format for `date` type runtime fields. | +| `input_field` | [Field](./Field.md) | For type `lookup` | +| `script` | [Script](./Script.md) | [ScriptSource](./ScriptSource.md) | Painless script executed at query time. | +| `target_field` | [Field](./Field.md) | For type `lookup` | +| `target_index` | [IndexName](./IndexName.md) | For type `lookup` | +| `type` | [MappingRuntimeFieldType](./MappingRuntimeFieldType.md) | Field type, which can be: `boolean`, `composite`, `date`, `double`, `geo_point`, `ip`, `keyword`, `long`, or `lookup`. | diff --git a/docs/reference/api/MappingRuntimeFieldFetchFields.md b/docs/reference/api/MappingRuntimeFieldFetchFields.md new file mode 100644 index 000000000..511e17556 --- /dev/null +++ b/docs/reference/api/MappingRuntimeFieldFetchFields.md @@ -0,0 +1,6 @@ +## Interface `MappingRuntimeFieldFetchFields` + +| Name | Type | Description | +| - | - | - | +| `field` | [Field](./Field.md) |   | +| `format` | string |   | diff --git a/docs/reference/api/MappingRuntimeFieldType.md b/docs/reference/api/MappingRuntimeFieldType.md new file mode 100644 index 000000000..80aa48948 --- /dev/null +++ b/docs/reference/api/MappingRuntimeFieldType.md @@ -0,0 +1,4 @@ +## `MappingRuntimeFieldType` +::: +type MappingRuntimeFieldType = 'boolean' | 'composite' | 'date' | 'double' | 'geo_point' | 'geo_shape' | 'ip' | 'keyword' | 'long' | 'lookup'; +::: diff --git a/docs/reference/api/MappingRuntimeFields.md b/docs/reference/api/MappingRuntimeFields.md new file mode 100644 index 000000000..feb91814c --- /dev/null +++ b/docs/reference/api/MappingRuntimeFields.md @@ -0,0 +1,4 @@ +## `MappingRuntimeFields` +::: +type MappingRuntimeFields = Record<[Field](./Field.md), [MappingRuntimeField](./MappingRuntimeField.md)>; +::: diff --git a/docs/reference/api/MappingScaledFloatNumberProperty.md b/docs/reference/api/MappingScaledFloatNumberProperty.md new file mode 100644 index 000000000..9c343ba96 --- /dev/null +++ b/docs/reference/api/MappingScaledFloatNumberProperty.md @@ -0,0 +1,7 @@ +## Interface `MappingScaledFloatNumberProperty` + +| Name | Type | Description | +| - | - | - | +| `null_value` | [double](./double.md) |   | +| `scaling_factor` | [double](./double.md) |   | +| `type` | 'scaled_float' |   | diff --git a/docs/reference/api/MappingSearchAsYouTypeProperty.md b/docs/reference/api/MappingSearchAsYouTypeProperty.md new file mode 100644 index 000000000..57d3ecba5 --- /dev/null +++ b/docs/reference/api/MappingSearchAsYouTypeProperty.md @@ -0,0 +1,14 @@ +## Interface `MappingSearchAsYouTypeProperty` + +| Name | Type | Description | +| - | - | - | +| `analyzer` | string |   | +| `index_options` | [MappingIndexOptions](./MappingIndexOptions.md) |   | +| `index` | boolean |   | +| `max_shingle_size` | [integer](./integer.md) |   | +| `norms` | boolean |   | +| `search_analyzer` | string |   | +| `search_quote_analyzer` | string |   | +| `similarity` | string | null |   | +| `term_vector` | [MappingTermVectorOption](./MappingTermVectorOption.md) |   | +| `type` | 'search_as_you_type' |   | diff --git a/docs/reference/api/MappingSemanticTextProperty.md b/docs/reference/api/MappingSemanticTextProperty.md new file mode 100644 index 000000000..e35bace32 --- /dev/null +++ b/docs/reference/api/MappingSemanticTextProperty.md @@ -0,0 +1,9 @@ +## Interface `MappingSemanticTextProperty` + +| Name | Type | Description | +| - | - | - | +| `chunking_settings` | [MappingChunkingSettings](./MappingChunkingSettings.md) | Settings for chunking text into smaller passages. If specified, these will override the chunking settings sent in the inference endpoint associated with inference_id. If chunking settings are updated, they will not be applied to existing documents until they are reindexed. | +| `inference_id` | [Id](./Id.md) | Inference endpoint that will be used to generate embeddings for the field. This parameter cannot be updated. Use the Create inference API to create the endpoint. If `search_inference_id` is specified, the inference endpoint will only be used at index time. | +| `meta` | Record |   | +| `search_inference_id` | [Id](./Id.md) | Inference endpoint that will be used to generate embeddings at query time. You can update this parameter by using the Update mapping API. Use the Create inference API to create the endpoint. If not specified, the inference endpoint defined by inference_id will be used at both index and query time. | +| `type` | 'semantic_text' |   | diff --git a/docs/reference/api/MappingShapeProperty.md b/docs/reference/api/MappingShapeProperty.md new file mode 100644 index 000000000..d98a711f6 --- /dev/null +++ b/docs/reference/api/MappingShapeProperty.md @@ -0,0 +1,9 @@ +## Interface `MappingShapeProperty` + +| Name | Type | Description | +| - | - | - | +| `coerce` | boolean |   | +| `ignore_malformed` | boolean |   | +| `ignore_z_value` | boolean |   | +| `orientation` | [MappingGeoOrientation](./MappingGeoOrientation.md) |   | +| `type` | 'shape' |   | diff --git a/docs/reference/api/MappingShortNumberProperty.md b/docs/reference/api/MappingShortNumberProperty.md new file mode 100644 index 000000000..aee2e1f5b --- /dev/null +++ b/docs/reference/api/MappingShortNumberProperty.md @@ -0,0 +1,6 @@ +## Interface `MappingShortNumberProperty` + +| Name | Type | Description | +| - | - | - | +| `null_value` | [short](./short.md) |   | +| `type` | 'short' |   | diff --git a/docs/reference/api/MappingSizeField.md b/docs/reference/api/MappingSizeField.md new file mode 100644 index 000000000..b367e66d7 --- /dev/null +++ b/docs/reference/api/MappingSizeField.md @@ -0,0 +1,5 @@ +## Interface `MappingSizeField` + +| Name | Type | Description | +| - | - | - | +| `enabled` | boolean |   | diff --git a/docs/reference/api/MappingSourceField.md b/docs/reference/api/MappingSourceField.md new file mode 100644 index 000000000..cf15cb18f --- /dev/null +++ b/docs/reference/api/MappingSourceField.md @@ -0,0 +1,10 @@ +## Interface `MappingSourceField` + +| Name | Type | Description | +| - | - | - | +| `compress_threshold` | string |   | +| `compress` | boolean |   | +| `enabled` | boolean |   | +| `excludes` | string[] |   | +| `includes` | string[] |   | +| `mode` | [MappingSourceFieldMode](./MappingSourceFieldMode.md) |   | diff --git a/docs/reference/api/MappingSourceFieldMode.md b/docs/reference/api/MappingSourceFieldMode.md new file mode 100644 index 000000000..46672025b --- /dev/null +++ b/docs/reference/api/MappingSourceFieldMode.md @@ -0,0 +1,4 @@ +## `MappingSourceFieldMode` +::: +type MappingSourceFieldMode = 'disabled' | 'stored' | 'synthetic'; +::: diff --git a/docs/reference/api/MappingSparseVectorProperty.md b/docs/reference/api/MappingSparseVectorProperty.md new file mode 100644 index 000000000..a43c4b74d --- /dev/null +++ b/docs/reference/api/MappingSparseVectorProperty.md @@ -0,0 +1,5 @@ +## Interface `MappingSparseVectorProperty` + +| Name | Type | Description | +| - | - | - | +| `type` | 'sparse_vector' |   | diff --git a/docs/reference/api/MappingSubobjects.md b/docs/reference/api/MappingSubobjects.md new file mode 100644 index 000000000..6baaaf429 --- /dev/null +++ b/docs/reference/api/MappingSubobjects.md @@ -0,0 +1,4 @@ +## `MappingSubobjects` +::: +type MappingSubobjects = boolean | 'true' | 'false' | 'auto'; +::: diff --git a/docs/reference/api/MappingSuggestContext.md b/docs/reference/api/MappingSuggestContext.md new file mode 100644 index 000000000..9fb649031 --- /dev/null +++ b/docs/reference/api/MappingSuggestContext.md @@ -0,0 +1,8 @@ +## Interface `MappingSuggestContext` + +| Name | Type | Description | +| - | - | - | +| `name` | [Name](./Name.md) |   | +| `path` | [Field](./Field.md) |   | +| `precision` | [integer](./integer.md) | string |   | +| `type` | string |   | diff --git a/docs/reference/api/MappingSyntheticSourceKeepEnum.md b/docs/reference/api/MappingSyntheticSourceKeepEnum.md new file mode 100644 index 000000000..aae989ec0 --- /dev/null +++ b/docs/reference/api/MappingSyntheticSourceKeepEnum.md @@ -0,0 +1,4 @@ +## `MappingSyntheticSourceKeepEnum` +::: +type MappingSyntheticSourceKeepEnum = 'none' | 'arrays' | 'all'; +::: diff --git a/docs/reference/api/MappingTermVectorOption.md b/docs/reference/api/MappingTermVectorOption.md new file mode 100644 index 000000000..ca5c24e84 --- /dev/null +++ b/docs/reference/api/MappingTermVectorOption.md @@ -0,0 +1,4 @@ +## `MappingTermVectorOption` +::: +type MappingTermVectorOption = 'no' | 'yes' | 'with_offsets' | 'with_positions' | 'with_positions_offsets' | 'with_positions_offsets_payloads' | 'with_positions_payloads'; +::: diff --git a/docs/reference/api/MappingTextIndexPrefixes.md b/docs/reference/api/MappingTextIndexPrefixes.md new file mode 100644 index 000000000..4a14be607 --- /dev/null +++ b/docs/reference/api/MappingTextIndexPrefixes.md @@ -0,0 +1,6 @@ +## Interface `MappingTextIndexPrefixes` + +| Name | Type | Description | +| - | - | - | +| `max_chars` | [integer](./integer.md) |   | +| `min_chars` | [integer](./integer.md) |   | diff --git a/docs/reference/api/MappingTextProperty.md b/docs/reference/api/MappingTextProperty.md new file mode 100644 index 000000000..eae39cccf --- /dev/null +++ b/docs/reference/api/MappingTextProperty.md @@ -0,0 +1,20 @@ +## Interface `MappingTextProperty` + +| Name | Type | Description | +| - | - | - | +| `analyzer` | string |   | +| `boost` | [double](./double.md) |   | +| `eager_global_ordinals` | boolean |   | +| `fielddata_frequency_filter` | [IndicesFielddataFrequencyFilter](./IndicesFielddataFrequencyFilter.md) |   | +| `fielddata` | boolean |   | +| `index_options` | [MappingIndexOptions](./MappingIndexOptions.md) |   | +| `index_phrases` | boolean |   | +| `index_prefixes` | [MappingTextIndexPrefixes](./MappingTextIndexPrefixes.md) | null |   | +| `index` | boolean |   | +| `norms` | boolean |   | +| `position_increment_gap` | [integer](./integer.md) |   | +| `search_analyzer` | string |   | +| `search_quote_analyzer` | string |   | +| `similarity` | string | null |   | +| `term_vector` | [MappingTermVectorOption](./MappingTermVectorOption.md) |   | +| `type` | 'text' |   | diff --git a/docs/reference/api/MappingTimeSeriesMetricType.md b/docs/reference/api/MappingTimeSeriesMetricType.md new file mode 100644 index 000000000..0e93c03c4 --- /dev/null +++ b/docs/reference/api/MappingTimeSeriesMetricType.md @@ -0,0 +1,4 @@ +## `MappingTimeSeriesMetricType` +::: +type MappingTimeSeriesMetricType = 'gauge' | 'counter' | 'summary' | 'histogram' | 'position'; +::: diff --git a/docs/reference/api/MappingTokenCountProperty.md b/docs/reference/api/MappingTokenCountProperty.md new file mode 100644 index 000000000..b2f6f1baa --- /dev/null +++ b/docs/reference/api/MappingTokenCountProperty.md @@ -0,0 +1,10 @@ +## Interface `MappingTokenCountProperty` + +| Name | Type | Description | +| - | - | - | +| `analyzer` | string |   | +| `boost` | [double](./double.md) |   | +| `enable_position_increments` | boolean |   | +| `index` | boolean |   | +| `null_value` | [double](./double.md) |   | +| `type` | 'token_count' |   | diff --git a/docs/reference/api/MappingTypeMapping.md b/docs/reference/api/MappingTypeMapping.md new file mode 100644 index 000000000..7a3b01c66 --- /dev/null +++ b/docs/reference/api/MappingTypeMapping.md @@ -0,0 +1,21 @@ +## Interface `MappingTypeMapping` + +| Name | Type | Description | +| - | - | - | +| `_data_stream_timestamp` | [MappingDataStreamTimestamp](./MappingDataStreamTimestamp.md) |   | +| `_field_names` | [MappingFieldNamesField](./MappingFieldNamesField.md) |   | +| `_meta` | [Metadata](./Metadata.md) |   | +| `_routing` | [MappingRoutingField](./MappingRoutingField.md) |   | +| `_size` | [MappingSizeField](./MappingSizeField.md) |   | +| `_source` | [MappingSourceField](./MappingSourceField.md) |   | +| `all_field` | [MappingAllField](./MappingAllField.md) |   | +| `date_detection` | boolean |   | +| `dynamic_date_formats` | string[] |   | +| `dynamic_templates` | [Partial](./Partial.md)>[] |   | +| `dynamic` | [MappingDynamicMapping](./MappingDynamicMapping.md) |   | +| `enabled` | boolean |   | +| `index_field` | [MappingIndexField](./MappingIndexField.md) |   | +| `numeric_detection` | boolean |   | +| `properties` | Record<[PropertyName](./PropertyName.md), [MappingProperty](./MappingProperty.md)> |   | +| `runtime` | Record |   | +| `subobjects` | [MappingSubobjects](./MappingSubobjects.md) |   | diff --git a/docs/reference/api/MappingUnsignedLongNumberProperty.md b/docs/reference/api/MappingUnsignedLongNumberProperty.md new file mode 100644 index 000000000..7f85e0ec5 --- /dev/null +++ b/docs/reference/api/MappingUnsignedLongNumberProperty.md @@ -0,0 +1,6 @@ +## Interface `MappingUnsignedLongNumberProperty` + +| Name | Type | Description | +| - | - | - | +| `null_value` | [ulong](./ulong.md) |   | +| `type` | 'unsigned_long' |   | diff --git a/docs/reference/api/MappingVersionProperty.md b/docs/reference/api/MappingVersionProperty.md new file mode 100644 index 000000000..0b90dbb7c --- /dev/null +++ b/docs/reference/api/MappingVersionProperty.md @@ -0,0 +1,5 @@ +## Interface `MappingVersionProperty` + +| Name | Type | Description | +| - | - | - | +| `type` | 'version' |   | diff --git a/docs/reference/api/MappingWildcardProperty.md b/docs/reference/api/MappingWildcardProperty.md new file mode 100644 index 000000000..382cfc067 --- /dev/null +++ b/docs/reference/api/MappingWildcardProperty.md @@ -0,0 +1,6 @@ +## Interface `MappingWildcardProperty` + +| Name | Type | Description | +| - | - | - | +| `null_value` | string |   | +| `type` | 'wildcard' |   | diff --git a/docs/reference/api/MergesStats.md b/docs/reference/api/MergesStats.md new file mode 100644 index 000000000..43e24ded4 --- /dev/null +++ b/docs/reference/api/MergesStats.md @@ -0,0 +1,20 @@ +## Interface `MergesStats` + +| Name | Type | Description | +| - | - | - | +| `current_docs` | [long](./long.md) |   | +| `current_size_in_bytes` | [long](./long.md) |   | +| `current_size` | string |   | +| `current` | [long](./long.md) |   | +| `total_auto_throttle_in_bytes` | [long](./long.md) |   | +| `total_auto_throttle` | string |   | +| `total_docs` | [long](./long.md) |   | +| `total_size_in_bytes` | [long](./long.md) |   | +| `total_size` | string |   | +| `total_stopped_time_in_millis` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> |   | +| `total_stopped_time` | [Duration](./Duration.md) |   | +| `total_throttled_time_in_millis` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> |   | +| `total_throttled_time` | [Duration](./Duration.md) |   | +| `total_time_in_millis` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> |   | +| `total_time` | [Duration](./Duration.md) |   | +| `total` | [long](./long.md) |   | diff --git a/docs/reference/api/Metadata.md b/docs/reference/api/Metadata.md new file mode 100644 index 000000000..6906100c7 --- /dev/null +++ b/docs/reference/api/Metadata.md @@ -0,0 +1,4 @@ +## `Metadata` +::: +type Metadata = Record; +::: diff --git a/docs/reference/api/Metrics.md b/docs/reference/api/Metrics.md new file mode 100644 index 000000000..6a941c7c1 --- /dev/null +++ b/docs/reference/api/Metrics.md @@ -0,0 +1,4 @@ +## `Metrics` +::: +type Metrics = string | string[]; +::: diff --git a/docs/reference/api/MgetApi_1.md b/docs/reference/api/MgetApi_1.md new file mode 100644 index 000000000..4ae359648 --- /dev/null +++ b/docs/reference/api/MgetApi_1.md @@ -0,0 +1,3 @@ +::: +default function MgetApi(this: [That](./That.md), params?: [MgetRequest](./MgetRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MgetResponse](./MgetResponse.md)>; +::: diff --git a/docs/reference/api/MgetApi_2.md b/docs/reference/api/MgetApi_2.md new file mode 100644 index 000000000..55074e15b --- /dev/null +++ b/docs/reference/api/MgetApi_2.md @@ -0,0 +1,3 @@ +::: +default function MgetApi(this: [That](./That.md), params?: [MgetRequest](./MgetRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MgetResponse](./MgetResponse.md), unknown>>; +::: diff --git a/docs/reference/api/MgetApi_3.md b/docs/reference/api/MgetApi_3.md new file mode 100644 index 000000000..e337f5cac --- /dev/null +++ b/docs/reference/api/MgetApi_3.md @@ -0,0 +1,3 @@ +::: +default function MgetApi(this: [That](./That.md), params?: [MgetRequest](./MgetRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MgetResponse](./MgetResponse.md)>; +::: diff --git a/docs/reference/api/MgetMultiGetError.md b/docs/reference/api/MgetMultiGetError.md new file mode 100644 index 000000000..8b1f32b0e --- /dev/null +++ b/docs/reference/api/MgetMultiGetError.md @@ -0,0 +1,7 @@ +## Interface `MgetMultiGetError` + +| Name | Type | Description | +| - | - | - | +| `_id` | [Id](./Id.md) |   | +| `_index` | [IndexName](./IndexName.md) |   | +| `error` | [ErrorCause](./ErrorCause.md) |   | diff --git a/docs/reference/api/MgetOperation.md b/docs/reference/api/MgetOperation.md new file mode 100644 index 000000000..d50c52112 --- /dev/null +++ b/docs/reference/api/MgetOperation.md @@ -0,0 +1,11 @@ +## Interface `MgetOperation` + +| Name | Type | Description | +| - | - | - | +| `_id` | [Id](./Id.md) | The unique document ID. | +| `_index` | [IndexName](./IndexName.md) | The index that contains the document. | +| `_source` | [SearchSourceConfig](./SearchSourceConfig.md) | If `false`, excludes all _source fields. | +| `routing` | [Routing](./Routing.md) | The key for the primary shard the document resides on. Required if routing is used during indexing. | +| `stored_fields` | [Fields](./Fields.md) | The stored fields you want to retrieve. | +| `version_type` | [VersionType](./VersionType.md) |   | +| `version` | [VersionNumber](./VersionNumber.md) |   | diff --git a/docs/reference/api/MgetRequest.md b/docs/reference/api/MgetRequest.md new file mode 100644 index 000000000..b3acc9edc --- /dev/null +++ b/docs/reference/api/MgetRequest.md @@ -0,0 +1,18 @@ +## Interface `MgetRequest` + +| Name | Type | Description | +| - | - | - | +| `_source_excludes` | [Fields](./Fields.md) | A comma-separated list of source fields to exclude from the response. You can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter. | +| `_source_includes` | [Fields](./Fields.md) | A comma-separated list of source fields to include in the response. If this parameter is specified, only these source fields are returned. You can exclude fields from this subset using the `_source_excludes` query parameter. If the `_source` parameter is `false`, this parameter is ignored. | +| `_source` | [SearchSourceConfigParam](./SearchSourceConfigParam.md) | True or false to return the `_source` field or not, or a list of fields to return. | +| `body` | string | ({ [key: string]: any; } & { index?: never; force_synthetic_source?: never; preference?: never; realtime?: never; refresh?: never; routing?: never; _source?: never; _source_excludes?: never; _source_includes?: never; stored_fields?: never; docs?: never; ids?: never; }) | All values in `body` will be added to the request body. | +| `docs` | [MgetOperation](./MgetOperation.md)[] | The documents you want to retrieve. Required if no index is specified in the request URI. | +| `force_synthetic_source` | boolean | Should this request force synthetic _source? Use this to test if the mapping supports synthetic _source and to get a sense of the worst case performance. Fetches with this enabled will be slower the enabling synthetic source natively in the index. | +| `ids` | [Ids](./Ids.md) | The IDs of the documents you want to retrieve. Allowed when the index is specified in the request URI. | +| `index` | [IndexName](./IndexName.md) | Name of the index to retrieve documents from when `ids` are specified, or when a document in the `docs` array does not specify an index. | +| `preference` | string | Specifies the node or shard the operation should be performed on. Random by default. | +| `querystring` | { [key: string]: any; } & { index?: never; force_synthetic_source?: never; preference?: never; realtime?: never; refresh?: never; routing?: never; _source?: never; _source_excludes?: never; _source_includes?: never; stored_fields?: never; docs?: never; ids?: never; } | All values in `querystring` will be added to the request querystring. | +| `realtime` | boolean | If `true`, the request is real-time as opposed to near-real-time. | +| `refresh` | boolean | If `true`, the request refreshes relevant shards before retrieving documents. | +| `routing` | [Routing](./Routing.md) | Custom value used to route operations to a specific shard. | +| `stored_fields` | [Fields](./Fields.md) | If `true`, retrieves the document fields stored in the index rather than the document `_source`. | diff --git a/docs/reference/api/MgetResponse.md b/docs/reference/api/MgetResponse.md new file mode 100644 index 000000000..db11ce46f --- /dev/null +++ b/docs/reference/api/MgetResponse.md @@ -0,0 +1,5 @@ +## Interface `MgetResponse` + +| Name | Type | Description | +| - | - | - | +| `docs` | [MgetResponseItem](./MgetResponseItem.md)[] | The response includes a docs array that contains the documents in the order specified in the request. The structure of the returned documents is similar to that returned by the get API. If there is a failure getting a particular document, the error is included in place of the document. | diff --git a/docs/reference/api/MgetResponseItem.md b/docs/reference/api/MgetResponseItem.md new file mode 100644 index 000000000..ee2173e8b --- /dev/null +++ b/docs/reference/api/MgetResponseItem.md @@ -0,0 +1,4 @@ +## `MgetResponseItem` +::: +type MgetResponseItem = [GetGetResult](./GetGetResult.md) | [MgetMultiGetError](./MgetMultiGetError.md); +::: diff --git a/docs/reference/api/Migration.md b/docs/reference/api/Migration.md new file mode 100644 index 000000000..4805da27f --- /dev/null +++ b/docs/reference/api/Migration.md @@ -0,0 +1,20 @@ +## `Migration` + +### Constructor + +::: +new Migration(transport: [Transport](./Transport.md)); +::: + +### Properties + +| Name | Type | Description | +| - | - | - | +| `acceptedParams` | Record |   | +| `transport` | [Transport](./Transport.md) |   | + +### Methods + +| Name | Signature | Description | +| - | - | - | +| `deprecations` | `deprecations(this: [That](./That.md), params?: [MigrationDeprecationsRequest](./MigrationDeprecationsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MigrationDeprecationsResponse](./MigrationDeprecationsResponse.md)>;` | Get deprecation information. Get information about different cluster, node, and index level settings that use deprecated features that will be removed or changed in the next major version. TIP: This APIs is designed for indirect use by the Upgrade Assistant. You are strongly recommended to use the Upgrade Assistant. || `deprecations` | `deprecations(this: [That](./That.md), params?: [MigrationDeprecationsRequest](./MigrationDeprecationsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MigrationDeprecationsResponse](./MigrationDeprecationsResponse.md), unknown>>;` |   || `deprecations` | `deprecations(this: [That](./That.md), params?: [MigrationDeprecationsRequest](./MigrationDeprecationsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MigrationDeprecationsResponse](./MigrationDeprecationsResponse.md)>;` |   || `getFeatureUpgradeStatus` | `getFeatureUpgradeStatus(this: [That](./That.md), params?: [MigrationGetFeatureUpgradeStatusRequest](./MigrationGetFeatureUpgradeStatusRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MigrationGetFeatureUpgradeStatusResponse](./MigrationGetFeatureUpgradeStatusResponse.md)>;` | Get feature migration information. Version upgrades sometimes require changes to how features store configuration information and data in system indices. Check which features need to be migrated and the status of any migrations that are in progress. TIP: This API is designed for indirect use by the Upgrade Assistant. You are strongly recommended to use the Upgrade Assistant. || `getFeatureUpgradeStatus` | `getFeatureUpgradeStatus(this: [That](./That.md), params?: [MigrationGetFeatureUpgradeStatusRequest](./MigrationGetFeatureUpgradeStatusRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MigrationGetFeatureUpgradeStatusResponse](./MigrationGetFeatureUpgradeStatusResponse.md), unknown>>;` |   || `getFeatureUpgradeStatus` | `getFeatureUpgradeStatus(this: [That](./That.md), params?: [MigrationGetFeatureUpgradeStatusRequest](./MigrationGetFeatureUpgradeStatusRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MigrationGetFeatureUpgradeStatusResponse](./MigrationGetFeatureUpgradeStatusResponse.md)>;` |   || `postFeatureUpgrade` | `postFeatureUpgrade(this: [That](./That.md), params?: [MigrationPostFeatureUpgradeRequest](./MigrationPostFeatureUpgradeRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MigrationPostFeatureUpgradeResponse](./MigrationPostFeatureUpgradeResponse.md)>;` | Start the feature migration. Version upgrades sometimes require changes to how features store configuration information and data in system indices. This API starts the automatic migration process. Some functionality might be temporarily unavailable during the migration process. TIP: The API is designed for indirect use by the Upgrade Assistant. We strongly recommend you use the Upgrade Assistant. || `postFeatureUpgrade` | `postFeatureUpgrade(this: [That](./That.md), params?: [MigrationPostFeatureUpgradeRequest](./MigrationPostFeatureUpgradeRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MigrationPostFeatureUpgradeResponse](./MigrationPostFeatureUpgradeResponse.md), unknown>>;` |   || `postFeatureUpgrade` | `postFeatureUpgrade(this: [That](./That.md), params?: [MigrationPostFeatureUpgradeRequest](./MigrationPostFeatureUpgradeRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MigrationPostFeatureUpgradeResponse](./MigrationPostFeatureUpgradeResponse.md)>;` |   | \ No newline at end of file diff --git a/docs/reference/api/MigrationDeprecationsDeprecation.md b/docs/reference/api/MigrationDeprecationsDeprecation.md new file mode 100644 index 000000000..2b0481f17 --- /dev/null +++ b/docs/reference/api/MigrationDeprecationsDeprecation.md @@ -0,0 +1,10 @@ +## Interface `MigrationDeprecationsDeprecation` + +| Name | Type | Description | +| - | - | - | +| `_meta` | Record |   | +| `details` | string | Optional details about the deprecation warning. | +| `level` | [MigrationDeprecationsDeprecationLevel](./MigrationDeprecationsDeprecationLevel.md) | The level property describes the significance of the issue. | +| `message` | string | Descriptive information about the deprecation warning. | +| `resolve_during_rolling_upgrade` | boolean |   | +| `url` | string | A link to the breaking change documentation, where you can find more information about this change. | diff --git a/docs/reference/api/MigrationDeprecationsDeprecationLevel.md b/docs/reference/api/MigrationDeprecationsDeprecationLevel.md new file mode 100644 index 000000000..4add57682 --- /dev/null +++ b/docs/reference/api/MigrationDeprecationsDeprecationLevel.md @@ -0,0 +1,4 @@ +## `MigrationDeprecationsDeprecationLevel` +::: +type MigrationDeprecationsDeprecationLevel = 'none' | 'info' | 'warning' | 'critical'; +::: diff --git a/docs/reference/api/MigrationDeprecationsRequest.md b/docs/reference/api/MigrationDeprecationsRequest.md new file mode 100644 index 000000000..54f29b10a --- /dev/null +++ b/docs/reference/api/MigrationDeprecationsRequest.md @@ -0,0 +1,7 @@ +## Interface `MigrationDeprecationsRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { index?: never; }) | All values in `body` will be added to the request body. | +| `index` | [IndexName](./IndexName.md) | Comma-separate list of data streams or indices to check. Wildcard (*) expressions are supported. | +| `querystring` | { [key: string]: any; } & { index?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/MigrationDeprecationsResponse.md b/docs/reference/api/MigrationDeprecationsResponse.md new file mode 100644 index 000000000..5ce77c00e --- /dev/null +++ b/docs/reference/api/MigrationDeprecationsResponse.md @@ -0,0 +1,11 @@ +## Interface `MigrationDeprecationsResponse` + +| Name | Type | Description | +| - | - | - | +| `cluster_settings` | [MigrationDeprecationsDeprecation](./MigrationDeprecationsDeprecation.md)[] | Cluster-level deprecation warnings. | +| `data_streams` | Record |   | +| `ilm_policies` | Record | ILM policy warnings are sectioned off per policy. | +| `index_settings` | Record | Index warnings are sectioned off per index and can be filtered using an index-pattern in the query. This section includes warnings for the backing indices of data streams specified in the request path. | +| `ml_settings` | [MigrationDeprecationsDeprecation](./MigrationDeprecationsDeprecation.md)[] | Machine learning-related deprecation warnings. | +| `node_settings` | [MigrationDeprecationsDeprecation](./MigrationDeprecationsDeprecation.md)[] | Node-level deprecation warnings. Since only a subset of your nodes might incorporate these settings, it is important to read the details section for more information about which nodes are affected. | +| `templates` | Record | Template warnings are sectioned off per template and include deprecations for both component templates and index templates. | diff --git a/docs/reference/api/MigrationGetFeatureUpgradeStatusMigrationFeature.md b/docs/reference/api/MigrationGetFeatureUpgradeStatusMigrationFeature.md new file mode 100644 index 000000000..27d47a560 --- /dev/null +++ b/docs/reference/api/MigrationGetFeatureUpgradeStatusMigrationFeature.md @@ -0,0 +1,8 @@ +## Interface `MigrationGetFeatureUpgradeStatusMigrationFeature` + +| Name | Type | Description | +| - | - | - | +| `feature_name` | string |   | +| `indices` | [MigrationGetFeatureUpgradeStatusMigrationFeatureIndexInfo](./MigrationGetFeatureUpgradeStatusMigrationFeatureIndexInfo.md)[] |   | +| `migration_status` | [MigrationGetFeatureUpgradeStatusMigrationStatus](./MigrationGetFeatureUpgradeStatusMigrationStatus.md) |   | +| `minimum_index_version` | [VersionString](./VersionString.md) |   | diff --git a/docs/reference/api/MigrationGetFeatureUpgradeStatusMigrationFeatureIndexInfo.md b/docs/reference/api/MigrationGetFeatureUpgradeStatusMigrationFeatureIndexInfo.md new file mode 100644 index 000000000..514176ba9 --- /dev/null +++ b/docs/reference/api/MigrationGetFeatureUpgradeStatusMigrationFeatureIndexInfo.md @@ -0,0 +1,7 @@ +## Interface `MigrationGetFeatureUpgradeStatusMigrationFeatureIndexInfo` + +| Name | Type | Description | +| - | - | - | +| `failure_cause` | [ErrorCause](./ErrorCause.md) |   | +| `index` | [IndexName](./IndexName.md) |   | +| `version` | [VersionString](./VersionString.md) |   | diff --git a/docs/reference/api/MigrationGetFeatureUpgradeStatusMigrationStatus.md b/docs/reference/api/MigrationGetFeatureUpgradeStatusMigrationStatus.md new file mode 100644 index 000000000..0cf881c77 --- /dev/null +++ b/docs/reference/api/MigrationGetFeatureUpgradeStatusMigrationStatus.md @@ -0,0 +1,4 @@ +## `MigrationGetFeatureUpgradeStatusMigrationStatus` +::: +type MigrationGetFeatureUpgradeStatusMigrationStatus = 'NO_MIGRATION_NEEDED' | 'MIGRATION_NEEDED' | 'IN_PROGRESS' | 'ERROR'; +::: diff --git a/docs/reference/api/MigrationGetFeatureUpgradeStatusRequest.md b/docs/reference/api/MigrationGetFeatureUpgradeStatusRequest.md new file mode 100644 index 000000000..d756ccf67 --- /dev/null +++ b/docs/reference/api/MigrationGetFeatureUpgradeStatusRequest.md @@ -0,0 +1,6 @@ +## Interface `MigrationGetFeatureUpgradeStatusRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | { [key: string]: any; } | All values in `body` will be added to the request body. | +| `querystring` | { [key: string]: any; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/MigrationGetFeatureUpgradeStatusResponse.md b/docs/reference/api/MigrationGetFeatureUpgradeStatusResponse.md new file mode 100644 index 000000000..f35b3ca7b --- /dev/null +++ b/docs/reference/api/MigrationGetFeatureUpgradeStatusResponse.md @@ -0,0 +1,6 @@ +## Interface `MigrationGetFeatureUpgradeStatusResponse` + +| Name | Type | Description | +| - | - | - | +| `features` | [MigrationGetFeatureUpgradeStatusMigrationFeature](./MigrationGetFeatureUpgradeStatusMigrationFeature.md)[] |   | +| `migration_status` | [MigrationGetFeatureUpgradeStatusMigrationStatus](./MigrationGetFeatureUpgradeStatusMigrationStatus.md) |   | diff --git a/docs/reference/api/MigrationPostFeatureUpgradeMigrationFeature.md b/docs/reference/api/MigrationPostFeatureUpgradeMigrationFeature.md new file mode 100644 index 000000000..ba45d9891 --- /dev/null +++ b/docs/reference/api/MigrationPostFeatureUpgradeMigrationFeature.md @@ -0,0 +1,5 @@ +## Interface `MigrationPostFeatureUpgradeMigrationFeature` + +| Name | Type | Description | +| - | - | - | +| `feature_name` | string |   | diff --git a/docs/reference/api/MigrationPostFeatureUpgradeRequest.md b/docs/reference/api/MigrationPostFeatureUpgradeRequest.md new file mode 100644 index 000000000..d9763851c --- /dev/null +++ b/docs/reference/api/MigrationPostFeatureUpgradeRequest.md @@ -0,0 +1,6 @@ +## Interface `MigrationPostFeatureUpgradeRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | { [key: string]: any; } | All values in `body` will be added to the request body. | +| `querystring` | { [key: string]: any; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/MigrationPostFeatureUpgradeResponse.md b/docs/reference/api/MigrationPostFeatureUpgradeResponse.md new file mode 100644 index 000000000..96dea468c --- /dev/null +++ b/docs/reference/api/MigrationPostFeatureUpgradeResponse.md @@ -0,0 +1,7 @@ +## Interface `MigrationPostFeatureUpgradeResponse` + +| Name | Type | Description | +| - | - | - | +| `accepted` | boolean |   | +| `features` | [MigrationPostFeatureUpgradeMigrationFeature](./MigrationPostFeatureUpgradeMigrationFeature.md)[] |   | +| `reason` | string |   | diff --git a/docs/reference/api/MinimumShouldMatch.md b/docs/reference/api/MinimumShouldMatch.md new file mode 100644 index 000000000..55cc3519d --- /dev/null +++ b/docs/reference/api/MinimumShouldMatch.md @@ -0,0 +1,4 @@ +## `MinimumShouldMatch` +::: +type MinimumShouldMatch = [integer](./integer.md) | string; +::: diff --git a/docs/reference/api/Ml.md b/docs/reference/api/Ml.md new file mode 100644 index 000000000..25ca76cc8 --- /dev/null +++ b/docs/reference/api/Ml.md @@ -0,0 +1,20 @@ +## `Ml` + +### Constructor + +::: +new Ml(transport: [Transport](./Transport.md)); +::: + +### Properties + +| Name | Type | Description | +| - | - | - | +| `acceptedParams` | Record |   | +| `transport` | [Transport](./Transport.md) |   | + +### Methods + +| Name | Signature | Description | +| - | - | - | +| `clearTrainedModelDeploymentCache` | `clearTrainedModelDeploymentCache(this: [That](./That.md), params: [MlClearTrainedModelDeploymentCacheRequest](./MlClearTrainedModelDeploymentCacheRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlClearTrainedModelDeploymentCacheResponse](./MlClearTrainedModelDeploymentCacheResponse.md)>;` | Clear trained model deployment cache. Cache will be cleared on all nodes where the trained model is assigned. A trained model deployment may have an inference cache enabled. As requests are handled by each allocated node, their responses may be cached on that individual node. Calling this API clears the caches without restarting the deployment. || `clearTrainedModelDeploymentCache` | `clearTrainedModelDeploymentCache(this: [That](./That.md), params: [MlClearTrainedModelDeploymentCacheRequest](./MlClearTrainedModelDeploymentCacheRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlClearTrainedModelDeploymentCacheResponse](./MlClearTrainedModelDeploymentCacheResponse.md), unknown>>;` |   || `clearTrainedModelDeploymentCache` | `clearTrainedModelDeploymentCache(this: [That](./That.md), params: [MlClearTrainedModelDeploymentCacheRequest](./MlClearTrainedModelDeploymentCacheRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlClearTrainedModelDeploymentCacheResponse](./MlClearTrainedModelDeploymentCacheResponse.md)>;` |   || `closeJob` | `closeJob(this: [That](./That.md), params: [MlCloseJobRequest](./MlCloseJobRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlCloseJobResponse](./MlCloseJobResponse.md)>;` | Close anomaly detection jobs. A job can be opened and closed multiple times throughout its lifecycle. A closed job cannot receive data or perform analysis operations, but you can still explore and navigate results. When you close a job, it runs housekeeping tasks such as pruning the model history, flushing buffers, calculating final results and persisting the model snapshots. Depending upon the size of the job, it could take several minutes to close and the equivalent time to re-open. After it is closed, the job has a minimal overhead on the cluster except for maintaining its meta data. Therefore it is a best practice to close jobs that are no longer required to process data. If you close an anomaly detection job whose datafeed is running, the request first tries to stop the datafeed. This behavior is equivalent to calling stop datafeed API with the same timeout and force parameters as the close job request. When a datafeed that has a specified end date stops, it automatically closes its associated job. || `closeJob` | `closeJob(this: [That](./That.md), params: [MlCloseJobRequest](./MlCloseJobRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlCloseJobResponse](./MlCloseJobResponse.md), unknown>>;` |   || `closeJob` | `closeJob(this: [That](./That.md), params: [MlCloseJobRequest](./MlCloseJobRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlCloseJobResponse](./MlCloseJobResponse.md)>;` |   || `deleteCalendar` | `deleteCalendar(this: [That](./That.md), params: [MlDeleteCalendarRequest](./MlDeleteCalendarRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlDeleteCalendarResponse](./MlDeleteCalendarResponse.md)>;` | Delete a calendar. Remove all scheduled events from a calendar, then delete it. || `deleteCalendar` | `deleteCalendar(this: [That](./That.md), params: [MlDeleteCalendarRequest](./MlDeleteCalendarRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlDeleteCalendarResponse](./MlDeleteCalendarResponse.md), unknown>>;` |   || `deleteCalendar` | `deleteCalendar(this: [That](./That.md), params: [MlDeleteCalendarRequest](./MlDeleteCalendarRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlDeleteCalendarResponse](./MlDeleteCalendarResponse.md)>;` |   || `deleteCalendarEvent` | `deleteCalendarEvent(this: [That](./That.md), params: [MlDeleteCalendarEventRequest](./MlDeleteCalendarEventRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlDeleteCalendarEventResponse](./MlDeleteCalendarEventResponse.md)>;` | Delete events from a calendar. || `deleteCalendarEvent` | `deleteCalendarEvent(this: [That](./That.md), params: [MlDeleteCalendarEventRequest](./MlDeleteCalendarEventRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlDeleteCalendarEventResponse](./MlDeleteCalendarEventResponse.md), unknown>>;` |   || `deleteCalendarEvent` | `deleteCalendarEvent(this: [That](./That.md), params: [MlDeleteCalendarEventRequest](./MlDeleteCalendarEventRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlDeleteCalendarEventResponse](./MlDeleteCalendarEventResponse.md)>;` |   || `deleteCalendarJob` | `deleteCalendarJob(this: [That](./That.md), params: [MlDeleteCalendarJobRequest](./MlDeleteCalendarJobRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlDeleteCalendarJobResponse](./MlDeleteCalendarJobResponse.md)>;` | Delete anomaly jobs from a calendar. || `deleteCalendarJob` | `deleteCalendarJob(this: [That](./That.md), params: [MlDeleteCalendarJobRequest](./MlDeleteCalendarJobRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlDeleteCalendarJobResponse](./MlDeleteCalendarJobResponse.md), unknown>>;` |   || `deleteCalendarJob` | `deleteCalendarJob(this: [That](./That.md), params: [MlDeleteCalendarJobRequest](./MlDeleteCalendarJobRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlDeleteCalendarJobResponse](./MlDeleteCalendarJobResponse.md)>;` |   || `deleteDatafeed` | `deleteDatafeed(this: [That](./That.md), params: [MlDeleteDatafeedRequest](./MlDeleteDatafeedRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlDeleteDatafeedResponse](./MlDeleteDatafeedResponse.md)>;` | Delete a datafeed. || `deleteDatafeed` | `deleteDatafeed(this: [That](./That.md), params: [MlDeleteDatafeedRequest](./MlDeleteDatafeedRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlDeleteDatafeedResponse](./MlDeleteDatafeedResponse.md), unknown>>;` |   || `deleteDatafeed` | `deleteDatafeed(this: [That](./That.md), params: [MlDeleteDatafeedRequest](./MlDeleteDatafeedRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlDeleteDatafeedResponse](./MlDeleteDatafeedResponse.md)>;` |   || `deleteDataFrameAnalytics` | `deleteDataFrameAnalytics(this: [That](./That.md), params: [MlDeleteDataFrameAnalyticsRequest](./MlDeleteDataFrameAnalyticsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlDeleteDataFrameAnalyticsResponse](./MlDeleteDataFrameAnalyticsResponse.md)>;` | Delete a data frame analytics job. || `deleteDataFrameAnalytics` | `deleteDataFrameAnalytics(this: [That](./That.md), params: [MlDeleteDataFrameAnalyticsRequest](./MlDeleteDataFrameAnalyticsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlDeleteDataFrameAnalyticsResponse](./MlDeleteDataFrameAnalyticsResponse.md), unknown>>;` |   || `deleteDataFrameAnalytics` | `deleteDataFrameAnalytics(this: [That](./That.md), params: [MlDeleteDataFrameAnalyticsRequest](./MlDeleteDataFrameAnalyticsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlDeleteDataFrameAnalyticsResponse](./MlDeleteDataFrameAnalyticsResponse.md)>;` |   || `deleteExpiredData` | `deleteExpiredData(this: [That](./That.md), params?: [MlDeleteExpiredDataRequest](./MlDeleteExpiredDataRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlDeleteExpiredDataResponse](./MlDeleteExpiredDataResponse.md)>;` | Delete expired ML data. Delete all job results, model snapshots and forecast data that have exceeded their retention days period. Machine learning state documents that are not associated with any job are also deleted. You can limit the request to a single or set of anomaly detection jobs by using a job identifier, a group name, a comma-separated list of jobs, or a wildcard expression. You can delete expired data for all anomaly detection jobs by using `_all`, by specifying `*` as the ``, or by omitting the ``. || `deleteExpiredData` | `deleteExpiredData(this: [That](./That.md), params?: [MlDeleteExpiredDataRequest](./MlDeleteExpiredDataRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlDeleteExpiredDataResponse](./MlDeleteExpiredDataResponse.md), unknown>>;` |   || `deleteExpiredData` | `deleteExpiredData(this: [That](./That.md), params?: [MlDeleteExpiredDataRequest](./MlDeleteExpiredDataRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlDeleteExpiredDataResponse](./MlDeleteExpiredDataResponse.md)>;` |   || `deleteFilter` | `deleteFilter(this: [That](./That.md), params: [MlDeleteFilterRequest](./MlDeleteFilterRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlDeleteFilterResponse](./MlDeleteFilterResponse.md)>;` | Delete a filter. If an anomaly detection job references the filter, you cannot delete the filter. You must update or delete the job before you can delete the filter. || `deleteFilter` | `deleteFilter(this: [That](./That.md), params: [MlDeleteFilterRequest](./MlDeleteFilterRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlDeleteFilterResponse](./MlDeleteFilterResponse.md), unknown>>;` |   || `deleteFilter` | `deleteFilter(this: [That](./That.md), params: [MlDeleteFilterRequest](./MlDeleteFilterRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlDeleteFilterResponse](./MlDeleteFilterResponse.md)>;` |   || `deleteForecast` | `deleteForecast(this: [That](./That.md), params: [MlDeleteForecastRequest](./MlDeleteForecastRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlDeleteForecastResponse](./MlDeleteForecastResponse.md)>;` | Delete forecasts from a job. By default, forecasts are retained for 14 days. You can specify a different retention period with the `expires_in` parameter in the forecast jobs API. The delete forecast API enables you to delete one or more forecasts before they expire. || `deleteForecast` | `deleteForecast(this: [That](./That.md), params: [MlDeleteForecastRequest](./MlDeleteForecastRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlDeleteForecastResponse](./MlDeleteForecastResponse.md), unknown>>;` |   || `deleteForecast` | `deleteForecast(this: [That](./That.md), params: [MlDeleteForecastRequest](./MlDeleteForecastRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlDeleteForecastResponse](./MlDeleteForecastResponse.md)>;` |   || `deleteJob` | `deleteJob(this: [That](./That.md), params: [MlDeleteJobRequest](./MlDeleteJobRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlDeleteJobResponse](./MlDeleteJobResponse.md)>;` | Delete an anomaly detection job. All job configuration, model state and results are deleted. It is not currently possible to delete multiple jobs using wildcards or a comma separated list. If you delete a job that has a datafeed, the request first tries to delete the datafeed. This behavior is equivalent to calling the delete datafeed API with the same timeout and force parameters as the delete job request. || `deleteJob` | `deleteJob(this: [That](./That.md), params: [MlDeleteJobRequest](./MlDeleteJobRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlDeleteJobResponse](./MlDeleteJobResponse.md), unknown>>;` |   || `deleteJob` | `deleteJob(this: [That](./That.md), params: [MlDeleteJobRequest](./MlDeleteJobRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlDeleteJobResponse](./MlDeleteJobResponse.md)>;` |   || `deleteModelSnapshot` | `deleteModelSnapshot(this: [That](./That.md), params: [MlDeleteModelSnapshotRequest](./MlDeleteModelSnapshotRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlDeleteModelSnapshotResponse](./MlDeleteModelSnapshotResponse.md)>;` | Delete a model snapshot. You cannot delete the active model snapshot. To delete that snapshot, first revert to a different one. To identify the active model snapshot, refer to the `model_snapshot_id` in the results from the get jobs API. || `deleteModelSnapshot` | `deleteModelSnapshot(this: [That](./That.md), params: [MlDeleteModelSnapshotRequest](./MlDeleteModelSnapshotRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlDeleteModelSnapshotResponse](./MlDeleteModelSnapshotResponse.md), unknown>>;` |   || `deleteModelSnapshot` | `deleteModelSnapshot(this: [That](./That.md), params: [MlDeleteModelSnapshotRequest](./MlDeleteModelSnapshotRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlDeleteModelSnapshotResponse](./MlDeleteModelSnapshotResponse.md)>;` |   || `deleteTrainedModel` | `deleteTrainedModel(this: [That](./That.md), params: [MlDeleteTrainedModelRequest](./MlDeleteTrainedModelRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlDeleteTrainedModelResponse](./MlDeleteTrainedModelResponse.md)>;` | Delete an unreferenced trained model. The request deletes a trained inference model that is not referenced by an ingest pipeline. || `deleteTrainedModel` | `deleteTrainedModel(this: [That](./That.md), params: [MlDeleteTrainedModelRequest](./MlDeleteTrainedModelRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlDeleteTrainedModelResponse](./MlDeleteTrainedModelResponse.md), unknown>>;` |   || `deleteTrainedModel` | `deleteTrainedModel(this: [That](./That.md), params: [MlDeleteTrainedModelRequest](./MlDeleteTrainedModelRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlDeleteTrainedModelResponse](./MlDeleteTrainedModelResponse.md)>;` |   || `deleteTrainedModelAlias` | `deleteTrainedModelAlias(this: [That](./That.md), params: [MlDeleteTrainedModelAliasRequest](./MlDeleteTrainedModelAliasRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlDeleteTrainedModelAliasResponse](./MlDeleteTrainedModelAliasResponse.md)>;` | Delete a trained model alias. This API deletes an existing model alias that refers to a trained model. If the model alias is missing or refers to a model other than the one identified by the `model_id`, this API returns an error. || `deleteTrainedModelAlias` | `deleteTrainedModelAlias(this: [That](./That.md), params: [MlDeleteTrainedModelAliasRequest](./MlDeleteTrainedModelAliasRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlDeleteTrainedModelAliasResponse](./MlDeleteTrainedModelAliasResponse.md), unknown>>;` |   || `deleteTrainedModelAlias` | `deleteTrainedModelAlias(this: [That](./That.md), params: [MlDeleteTrainedModelAliasRequest](./MlDeleteTrainedModelAliasRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlDeleteTrainedModelAliasResponse](./MlDeleteTrainedModelAliasResponse.md)>;` |   || `estimateModelMemory` | `estimateModelMemory(this: [That](./That.md), params?: [MlEstimateModelMemoryRequest](./MlEstimateModelMemoryRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlEstimateModelMemoryResponse](./MlEstimateModelMemoryResponse.md)>;` | Estimate job model memory usage. Make an estimation of the memory usage for an anomaly detection job model. The estimate is based on analysis configuration details for the job and cardinality estimates for the fields it references. || `estimateModelMemory` | `estimateModelMemory(this: [That](./That.md), params?: [MlEstimateModelMemoryRequest](./MlEstimateModelMemoryRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlEstimateModelMemoryResponse](./MlEstimateModelMemoryResponse.md), unknown>>;` |   || `estimateModelMemory` | `estimateModelMemory(this: [That](./That.md), params?: [MlEstimateModelMemoryRequest](./MlEstimateModelMemoryRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlEstimateModelMemoryResponse](./MlEstimateModelMemoryResponse.md)>;` |   || `evaluateDataFrame` | `evaluateDataFrame(this: [That](./That.md), params: [MlEvaluateDataFrameRequest](./MlEvaluateDataFrameRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlEvaluateDataFrameResponse](./MlEvaluateDataFrameResponse.md)>;` | Evaluate data frame analytics. The API packages together commonly used evaluation metrics for various types of machine learning features. This has been designed for use on indexes created by data frame analytics. Evaluation requires both a ground truth field and an analytics result field to be present. || `evaluateDataFrame` | `evaluateDataFrame(this: [That](./That.md), params: [MlEvaluateDataFrameRequest](./MlEvaluateDataFrameRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlEvaluateDataFrameResponse](./MlEvaluateDataFrameResponse.md), unknown>>;` |   || `evaluateDataFrame` | `evaluateDataFrame(this: [That](./That.md), params: [MlEvaluateDataFrameRequest](./MlEvaluateDataFrameRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlEvaluateDataFrameResponse](./MlEvaluateDataFrameResponse.md)>;` |   || `explainDataFrameAnalytics` | `explainDataFrameAnalytics(this: [That](./That.md), params?: [MlExplainDataFrameAnalyticsRequest](./MlExplainDataFrameAnalyticsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlExplainDataFrameAnalyticsResponse](./MlExplainDataFrameAnalyticsResponse.md)>;` | Explain data frame analytics config. This API provides explanations for a data frame analytics config that either exists already or one that has not been created yet. The following explanations are provided: * which fields are included or not in the analysis and why, * how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on. If you have object fields or fields that are excluded via source filtering, they are not included in the explanation. || `explainDataFrameAnalytics` | `explainDataFrameAnalytics(this: [That](./That.md), params?: [MlExplainDataFrameAnalyticsRequest](./MlExplainDataFrameAnalyticsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlExplainDataFrameAnalyticsResponse](./MlExplainDataFrameAnalyticsResponse.md), unknown>>;` |   || `explainDataFrameAnalytics` | `explainDataFrameAnalytics(this: [That](./That.md), params?: [MlExplainDataFrameAnalyticsRequest](./MlExplainDataFrameAnalyticsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlExplainDataFrameAnalyticsResponse](./MlExplainDataFrameAnalyticsResponse.md)>;` |   || `flushJob` | `flushJob(this: [That](./That.md), params: [MlFlushJobRequest](./MlFlushJobRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlFlushJobResponse](./MlFlushJobResponse.md)>;` | Force buffered data to be processed. The flush jobs API is only applicable when sending data for analysis using the post data API. Depending on the content of the buffer, then it might additionally calculate new results. Both flush and close operations are similar, however the flush is more efficient if you are expecting to send more data for analysis. When flushing, the job remains open and is available to continue analyzing data. A close operation additionally prunes and persists the model state to disk and the job must be opened again before analyzing further data. || `flushJob` | `flushJob(this: [That](./That.md), params: [MlFlushJobRequest](./MlFlushJobRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlFlushJobResponse](./MlFlushJobResponse.md), unknown>>;` |   || `flushJob` | `flushJob(this: [That](./That.md), params: [MlFlushJobRequest](./MlFlushJobRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlFlushJobResponse](./MlFlushJobResponse.md)>;` |   || `forecast` | `forecast(this: [That](./That.md), params: [MlForecastRequest](./MlForecastRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlForecastResponse](./MlForecastResponse.md)>;` | Predict future behavior of a time series. Forecasts are not supported for jobs that perform population analysis; an error occurs if you try to create a forecast for a job that has an `over_field_name` in its configuration. Forcasts predict future behavior based on historical data. || `forecast` | `forecast(this: [That](./That.md), params: [MlForecastRequest](./MlForecastRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlForecastResponse](./MlForecastResponse.md), unknown>>;` |   || `forecast` | `forecast(this: [That](./That.md), params: [MlForecastRequest](./MlForecastRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlForecastResponse](./MlForecastResponse.md)>;` |   || `getBuckets` | `getBuckets(this: [That](./That.md), params: [MlGetBucketsRequest](./MlGetBucketsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlGetBucketsResponse](./MlGetBucketsResponse.md)>;` | Get anomaly detection job results for buckets. The API presents a chronological view of the records, grouped by bucket. || `getBuckets` | `getBuckets(this: [That](./That.md), params: [MlGetBucketsRequest](./MlGetBucketsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlGetBucketsResponse](./MlGetBucketsResponse.md), unknown>>;` |   || `getBuckets` | `getBuckets(this: [That](./That.md), params: [MlGetBucketsRequest](./MlGetBucketsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlGetBucketsResponse](./MlGetBucketsResponse.md)>;` |   || `getCalendarEvents` | `getCalendarEvents(this: [That](./That.md), params: [MlGetCalendarEventsRequest](./MlGetCalendarEventsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlGetCalendarEventsResponse](./MlGetCalendarEventsResponse.md)>;` | Get info about events in calendars. || `getCalendarEvents` | `getCalendarEvents(this: [That](./That.md), params: [MlGetCalendarEventsRequest](./MlGetCalendarEventsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlGetCalendarEventsResponse](./MlGetCalendarEventsResponse.md), unknown>>;` |   || `getCalendarEvents` | `getCalendarEvents(this: [That](./That.md), params: [MlGetCalendarEventsRequest](./MlGetCalendarEventsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlGetCalendarEventsResponse](./MlGetCalendarEventsResponse.md)>;` |   || `getCalendars` | `getCalendars(this: [That](./That.md), params?: [MlGetCalendarsRequest](./MlGetCalendarsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlGetCalendarsResponse](./MlGetCalendarsResponse.md)>;` | Get calendar configuration info. || `getCalendars` | `getCalendars(this: [That](./That.md), params?: [MlGetCalendarsRequest](./MlGetCalendarsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlGetCalendarsResponse](./MlGetCalendarsResponse.md), unknown>>;` |   || `getCalendars` | `getCalendars(this: [That](./That.md), params?: [MlGetCalendarsRequest](./MlGetCalendarsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlGetCalendarsResponse](./MlGetCalendarsResponse.md)>;` |   || `getCategories` | `getCategories(this: [That](./That.md), params: [MlGetCategoriesRequest](./MlGetCategoriesRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlGetCategoriesResponse](./MlGetCategoriesResponse.md)>;` | Get anomaly detection job results for categories. || `getCategories` | `getCategories(this: [That](./That.md), params: [MlGetCategoriesRequest](./MlGetCategoriesRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlGetCategoriesResponse](./MlGetCategoriesResponse.md), unknown>>;` |   || `getCategories` | `getCategories(this: [That](./That.md), params: [MlGetCategoriesRequest](./MlGetCategoriesRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlGetCategoriesResponse](./MlGetCategoriesResponse.md)>;` |   || `getDatafeeds` | `getDatafeeds(this: [That](./That.md), params?: [MlGetDatafeedsRequest](./MlGetDatafeedsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlGetDatafeedsResponse](./MlGetDatafeedsResponse.md)>;` | Get datafeeds configuration info. You can get information for multiple datafeeds in a single API request by using a comma-separated list of datafeeds or a wildcard expression. You can get information for all datafeeds by using `_all`, by specifying `*` as the ``, or by omitting the ``. This API returns a maximum of 10,000 datafeeds. || `getDatafeeds` | `getDatafeeds(this: [That](./That.md), params?: [MlGetDatafeedsRequest](./MlGetDatafeedsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlGetDatafeedsResponse](./MlGetDatafeedsResponse.md), unknown>>;` |   || `getDatafeeds` | `getDatafeeds(this: [That](./That.md), params?: [MlGetDatafeedsRequest](./MlGetDatafeedsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlGetDatafeedsResponse](./MlGetDatafeedsResponse.md)>;` |   || `getDatafeedStats` | `getDatafeedStats(this: [That](./That.md), params?: [MlGetDatafeedStatsRequest](./MlGetDatafeedStatsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlGetDatafeedStatsResponse](./MlGetDatafeedStatsResponse.md)>;` | Get datafeed stats. You can get statistics for multiple datafeeds in a single API request by using a comma-separated list of datafeeds or a wildcard expression. You can get statistics for all datafeeds by using `_all`, by specifying `*` as the ``, or by omitting the ``. If the datafeed is stopped, the only information you receive is the `datafeed_id` and the `state`. This API returns a maximum of 10,000 datafeeds. || `getDatafeedStats` | `getDatafeedStats(this: [That](./That.md), params?: [MlGetDatafeedStatsRequest](./MlGetDatafeedStatsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlGetDatafeedStatsResponse](./MlGetDatafeedStatsResponse.md), unknown>>;` |   || `getDatafeedStats` | `getDatafeedStats(this: [That](./That.md), params?: [MlGetDatafeedStatsRequest](./MlGetDatafeedStatsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlGetDatafeedStatsResponse](./MlGetDatafeedStatsResponse.md)>;` |   || `getDataFrameAnalytics` | `getDataFrameAnalytics(this: [That](./That.md), params?: [MlGetDataFrameAnalyticsRequest](./MlGetDataFrameAnalyticsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlGetDataFrameAnalyticsResponse](./MlGetDataFrameAnalyticsResponse.md)>;` | Get data frame analytics job configuration info. You can get information for multiple data frame analytics jobs in a single API request by using a comma-separated list of data frame analytics jobs or a wildcard expression. || `getDataFrameAnalytics` | `getDataFrameAnalytics(this: [That](./That.md), params?: [MlGetDataFrameAnalyticsRequest](./MlGetDataFrameAnalyticsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlGetDataFrameAnalyticsResponse](./MlGetDataFrameAnalyticsResponse.md), unknown>>;` |   || `getDataFrameAnalytics` | `getDataFrameAnalytics(this: [That](./That.md), params?: [MlGetDataFrameAnalyticsRequest](./MlGetDataFrameAnalyticsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlGetDataFrameAnalyticsResponse](./MlGetDataFrameAnalyticsResponse.md)>;` |   || `getDataFrameAnalyticsStats` | `getDataFrameAnalyticsStats(this: [That](./That.md), params?: [MlGetDataFrameAnalyticsStatsRequest](./MlGetDataFrameAnalyticsStatsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlGetDataFrameAnalyticsStatsResponse](./MlGetDataFrameAnalyticsStatsResponse.md)>;` | Get data frame analytics job stats. || `getDataFrameAnalyticsStats` | `getDataFrameAnalyticsStats(this: [That](./That.md), params?: [MlGetDataFrameAnalyticsStatsRequest](./MlGetDataFrameAnalyticsStatsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlGetDataFrameAnalyticsStatsResponse](./MlGetDataFrameAnalyticsStatsResponse.md), unknown>>;` |   || `getDataFrameAnalyticsStats` | `getDataFrameAnalyticsStats(this: [That](./That.md), params?: [MlGetDataFrameAnalyticsStatsRequest](./MlGetDataFrameAnalyticsStatsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlGetDataFrameAnalyticsStatsResponse](./MlGetDataFrameAnalyticsStatsResponse.md)>;` |   || `getFilters` | `getFilters(this: [That](./That.md), params?: [MlGetFiltersRequest](./MlGetFiltersRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlGetFiltersResponse](./MlGetFiltersResponse.md)>;` | Get filters. You can get a single filter or all filters. || `getFilters` | `getFilters(this: [That](./That.md), params?: [MlGetFiltersRequest](./MlGetFiltersRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlGetFiltersResponse](./MlGetFiltersResponse.md), unknown>>;` |   || `getFilters` | `getFilters(this: [That](./That.md), params?: [MlGetFiltersRequest](./MlGetFiltersRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlGetFiltersResponse](./MlGetFiltersResponse.md)>;` |   || `getInfluencers` | `getInfluencers(this: [That](./That.md), params: [MlGetInfluencersRequest](./MlGetInfluencersRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlGetInfluencersResponse](./MlGetInfluencersResponse.md)>;` | Get anomaly detection job results for influencers. Influencers are the entities that have contributed to, or are to blame for, the anomalies. Influencer results are available only if an `influencer_field_name` is specified in the job configuration. || `getInfluencers` | `getInfluencers(this: [That](./That.md), params: [MlGetInfluencersRequest](./MlGetInfluencersRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlGetInfluencersResponse](./MlGetInfluencersResponse.md), unknown>>;` |   || `getInfluencers` | `getInfluencers(this: [That](./That.md), params: [MlGetInfluencersRequest](./MlGetInfluencersRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlGetInfluencersResponse](./MlGetInfluencersResponse.md)>;` |   || `getJobs` | `getJobs(this: [That](./That.md), params?: [MlGetJobsRequest](./MlGetJobsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlGetJobsResponse](./MlGetJobsResponse.md)>;` | Get anomaly detection jobs configuration info. You can get information for multiple anomaly detection jobs in a single API request by using a group name, a comma-separated list of jobs, or a wildcard expression. You can get information for all anomaly detection jobs by using `_all`, by specifying `*` as the ``, or by omitting the ``. || `getJobs` | `getJobs(this: [That](./That.md), params?: [MlGetJobsRequest](./MlGetJobsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlGetJobsResponse](./MlGetJobsResponse.md), unknown>>;` |   || `getJobs` | `getJobs(this: [That](./That.md), params?: [MlGetJobsRequest](./MlGetJobsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlGetJobsResponse](./MlGetJobsResponse.md)>;` |   || `getJobStats` | `getJobStats(this: [That](./That.md), params?: [MlGetJobStatsRequest](./MlGetJobStatsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlGetJobStatsResponse](./MlGetJobStatsResponse.md)>;` | Get anomaly detection job stats. || `getJobStats` | `getJobStats(this: [That](./That.md), params?: [MlGetJobStatsRequest](./MlGetJobStatsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlGetJobStatsResponse](./MlGetJobStatsResponse.md), unknown>>;` |   || `getJobStats` | `getJobStats(this: [That](./That.md), params?: [MlGetJobStatsRequest](./MlGetJobStatsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlGetJobStatsResponse](./MlGetJobStatsResponse.md)>;` |   || `getMemoryStats` | `getMemoryStats(this: [That](./That.md), params?: [MlGetMemoryStatsRequest](./MlGetMemoryStatsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlGetMemoryStatsResponse](./MlGetMemoryStatsResponse.md)>;` | Get machine learning memory usage info. Get information about how machine learning jobs and trained models are using memory, on each node, both within the JVM heap, and natively, outside of the JVM. || `getMemoryStats` | `getMemoryStats(this: [That](./That.md), params?: [MlGetMemoryStatsRequest](./MlGetMemoryStatsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlGetMemoryStatsResponse](./MlGetMemoryStatsResponse.md), unknown>>;` |   || `getMemoryStats` | `getMemoryStats(this: [That](./That.md), params?: [MlGetMemoryStatsRequest](./MlGetMemoryStatsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlGetMemoryStatsResponse](./MlGetMemoryStatsResponse.md)>;` |   || `getModelSnapshots` | `getModelSnapshots(this: [That](./That.md), params: [MlGetModelSnapshotsRequest](./MlGetModelSnapshotsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlGetModelSnapshotsResponse](./MlGetModelSnapshotsResponse.md)>;` | Get model snapshots info. || `getModelSnapshots` | `getModelSnapshots(this: [That](./That.md), params: [MlGetModelSnapshotsRequest](./MlGetModelSnapshotsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlGetModelSnapshotsResponse](./MlGetModelSnapshotsResponse.md), unknown>>;` |   || `getModelSnapshots` | `getModelSnapshots(this: [That](./That.md), params: [MlGetModelSnapshotsRequest](./MlGetModelSnapshotsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlGetModelSnapshotsResponse](./MlGetModelSnapshotsResponse.md)>;` |   || `getModelSnapshotUpgradeStats` | `getModelSnapshotUpgradeStats(this: [That](./That.md), params: [MlGetModelSnapshotUpgradeStatsRequest](./MlGetModelSnapshotUpgradeStatsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlGetModelSnapshotUpgradeStatsResponse](./MlGetModelSnapshotUpgradeStatsResponse.md)>;` | Get anomaly detection job model snapshot upgrade usage info. || `getModelSnapshotUpgradeStats` | `getModelSnapshotUpgradeStats(this: [That](./That.md), params: [MlGetModelSnapshotUpgradeStatsRequest](./MlGetModelSnapshotUpgradeStatsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlGetModelSnapshotUpgradeStatsResponse](./MlGetModelSnapshotUpgradeStatsResponse.md), unknown>>;` |   || `getModelSnapshotUpgradeStats` | `getModelSnapshotUpgradeStats(this: [That](./That.md), params: [MlGetModelSnapshotUpgradeStatsRequest](./MlGetModelSnapshotUpgradeStatsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlGetModelSnapshotUpgradeStatsResponse](./MlGetModelSnapshotUpgradeStatsResponse.md)>;` |   || `getOverallBuckets` | `getOverallBuckets(this: [That](./That.md), params: [MlGetOverallBucketsRequest](./MlGetOverallBucketsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlGetOverallBucketsResponse](./MlGetOverallBucketsResponse.md)>;` | Get overall bucket results. Retrievs overall bucket results that summarize the bucket results of multiple anomaly detection jobs. The `overall_score` is calculated by combining the scores of all the buckets within the overall bucket span. First, the maximum `anomaly_score` per anomaly detection job in the overall bucket is calculated. Then the `top_n` of those scores are averaged to result in the `overall_score`. This means that you can fine-tune the `overall_score` so that it is more or less sensitive to the number of jobs that detect an anomaly at the same time. For example, if you set `top_n` to `1`, the `overall_score` is the maximum bucket score in the overall bucket. Alternatively, if you set `top_n` to the number of jobs, the `overall_score` is high only when all jobs detect anomalies in that overall bucket. If you set the `bucket_span` parameter (to a value greater than its default), the `overall_score` is the maximum `overall_score` of the overall buckets that have a span equal to the jobs' largest bucket span. || `getOverallBuckets` | `getOverallBuckets(this: [That](./That.md), params: [MlGetOverallBucketsRequest](./MlGetOverallBucketsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlGetOverallBucketsResponse](./MlGetOverallBucketsResponse.md), unknown>>;` |   || `getOverallBuckets` | `getOverallBuckets(this: [That](./That.md), params: [MlGetOverallBucketsRequest](./MlGetOverallBucketsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlGetOverallBucketsResponse](./MlGetOverallBucketsResponse.md)>;` |   || `getRecords` | `getRecords(this: [That](./That.md), params: [MlGetRecordsRequest](./MlGetRecordsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlGetRecordsResponse](./MlGetRecordsResponse.md)>;` | Get anomaly records for an anomaly detection job. Records contain the detailed analytical results. They describe the anomalous activity that has been identified in the input data based on the detector configuration. There can be many anomaly records depending on the characteristics and size of the input data. In practice, there are often too many to be able to manually process them. The machine learning features therefore perform a sophisticated aggregation of the anomaly records into buckets. The number of record results depends on the number of anomalies found in each bucket, which relates to the number of time series being modeled and the number of detectors. || `getRecords` | `getRecords(this: [That](./That.md), params: [MlGetRecordsRequest](./MlGetRecordsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlGetRecordsResponse](./MlGetRecordsResponse.md), unknown>>;` |   || `getRecords` | `getRecords(this: [That](./That.md), params: [MlGetRecordsRequest](./MlGetRecordsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlGetRecordsResponse](./MlGetRecordsResponse.md)>;` |   || `getTrainedModels` | `getTrainedModels(this: [That](./That.md), params?: [MlGetTrainedModelsRequest](./MlGetTrainedModelsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlGetTrainedModelsResponse](./MlGetTrainedModelsResponse.md)>;` | Get trained model configuration info. || `getTrainedModels` | `getTrainedModels(this: [That](./That.md), params?: [MlGetTrainedModelsRequest](./MlGetTrainedModelsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlGetTrainedModelsResponse](./MlGetTrainedModelsResponse.md), unknown>>;` |   || `getTrainedModels` | `getTrainedModels(this: [That](./That.md), params?: [MlGetTrainedModelsRequest](./MlGetTrainedModelsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlGetTrainedModelsResponse](./MlGetTrainedModelsResponse.md)>;` |   || `getTrainedModelsStats` | `getTrainedModelsStats(this: [That](./That.md), params?: [MlGetTrainedModelsStatsRequest](./MlGetTrainedModelsStatsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlGetTrainedModelsStatsResponse](./MlGetTrainedModelsStatsResponse.md)>;` | Get trained models usage info. You can get usage information for multiple trained models in a single API request by using a comma-separated list of model IDs or a wildcard expression. || `getTrainedModelsStats` | `getTrainedModelsStats(this: [That](./That.md), params?: [MlGetTrainedModelsStatsRequest](./MlGetTrainedModelsStatsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlGetTrainedModelsStatsResponse](./MlGetTrainedModelsStatsResponse.md), unknown>>;` |   || `getTrainedModelsStats` | `getTrainedModelsStats(this: [That](./That.md), params?: [MlGetTrainedModelsStatsRequest](./MlGetTrainedModelsStatsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlGetTrainedModelsStatsResponse](./MlGetTrainedModelsStatsResponse.md)>;` |   || `inferTrainedModel` | `inferTrainedModel(this: [That](./That.md), params: [MlInferTrainedModelRequest](./MlInferTrainedModelRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlInferTrainedModelResponse](./MlInferTrainedModelResponse.md)>;` | Evaluate a trained model. || `inferTrainedModel` | `inferTrainedModel(this: [That](./That.md), params: [MlInferTrainedModelRequest](./MlInferTrainedModelRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlInferTrainedModelResponse](./MlInferTrainedModelResponse.md), unknown>>;` |   || `inferTrainedModel` | `inferTrainedModel(this: [That](./That.md), params: [MlInferTrainedModelRequest](./MlInferTrainedModelRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlInferTrainedModelResponse](./MlInferTrainedModelResponse.md)>;` |   || `info` | `info(this: [That](./That.md), params?: [MlInfoRequest](./MlInfoRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlInfoResponse](./MlInfoResponse.md)>;` | Get machine learning information. Get defaults and limits used by machine learning. This endpoint is designed to be used by a user interface that needs to fully understand machine learning configurations where some options are not specified, meaning that the defaults should be used. This endpoint may be used to find out what those defaults are. It also provides information about the maximum size of machine learning jobs that could run in the current cluster configuration. || `info` | `info(this: [That](./That.md), params?: [MlInfoRequest](./MlInfoRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlInfoResponse](./MlInfoResponse.md), unknown>>;` |   || `info` | `info(this: [That](./That.md), params?: [MlInfoRequest](./MlInfoRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlInfoResponse](./MlInfoResponse.md)>;` |   || `openJob` | `openJob(this: [That](./That.md), params: [MlOpenJobRequest](./MlOpenJobRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlOpenJobResponse](./MlOpenJobResponse.md)>;` | Open anomaly detection jobs. An anomaly detection job must be opened to be ready to receive and analyze data. It can be opened and closed multiple times throughout its lifecycle. When you open a new job, it starts with an empty model. When you open an existing job, the most recent model state is automatically loaded. The job is ready to resume its analysis from where it left off, once new data is received. || `openJob` | `openJob(this: [That](./That.md), params: [MlOpenJobRequest](./MlOpenJobRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlOpenJobResponse](./MlOpenJobResponse.md), unknown>>;` |   || `openJob` | `openJob(this: [That](./That.md), params: [MlOpenJobRequest](./MlOpenJobRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlOpenJobResponse](./MlOpenJobResponse.md)>;` |   || `postCalendarEvents` | `postCalendarEvents(this: [That](./That.md), params: [MlPostCalendarEventsRequest](./MlPostCalendarEventsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlPostCalendarEventsResponse](./MlPostCalendarEventsResponse.md)>;` | Add scheduled events to the calendar. || `postCalendarEvents` | `postCalendarEvents(this: [That](./That.md), params: [MlPostCalendarEventsRequest](./MlPostCalendarEventsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlPostCalendarEventsResponse](./MlPostCalendarEventsResponse.md), unknown>>;` |   || `postCalendarEvents` | `postCalendarEvents(this: [That](./That.md), params: [MlPostCalendarEventsRequest](./MlPostCalendarEventsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlPostCalendarEventsResponse](./MlPostCalendarEventsResponse.md)>;` |   || `postData` | `postData(this: [That](./That.md), params: [MlPostDataRequest](./MlPostDataRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlPostDataResponse](./MlPostDataResponse.md)>;` | Send data to an anomaly detection job for analysis. IMPORTANT: For each job, data can be accepted from only a single connection at a time. It is not currently possible to post data to multiple jobs using wildcards or a comma-separated list. || `postData` | `postData(this: [That](./That.md), params: [MlPostDataRequest](./MlPostDataRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlPostDataResponse](./MlPostDataResponse.md), unknown>>;` |   || `postData` | `postData(this: [That](./That.md), params: [MlPostDataRequest](./MlPostDataRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlPostDataResponse](./MlPostDataResponse.md)>;` |   || `previewDatafeed` | `previewDatafeed(this: [That](./That.md), params?: [MlPreviewDatafeedRequest](./MlPreviewDatafeedRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlPreviewDatafeedResponse](./MlPreviewDatafeedResponse.md)>;` | Preview a datafeed. This API returns the first "page" of search results from a datafeed. You can preview an existing datafeed or provide configuration details for a datafeed and anomaly detection job in the API. The preview shows the structure of the data that will be passed to the anomaly detection engine. IMPORTANT: When Elasticsearch security features are enabled, the preview uses the credentials of the user that called the API. However, when the datafeed starts it uses the roles of the last user that created or updated the datafeed. To get a preview that accurately reflects the behavior of the datafeed, use the appropriate credentials. You can also use secondary authorization headers to supply the credentials. || `previewDatafeed` | `previewDatafeed(this: [That](./That.md), params?: [MlPreviewDatafeedRequest](./MlPreviewDatafeedRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlPreviewDatafeedResponse](./MlPreviewDatafeedResponse.md), unknown>>;` |   || `previewDatafeed` | `previewDatafeed(this: [That](./That.md), params?: [MlPreviewDatafeedRequest](./MlPreviewDatafeedRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlPreviewDatafeedResponse](./MlPreviewDatafeedResponse.md)>;` |   || `previewDataFrameAnalytics` | `previewDataFrameAnalytics(this: [That](./That.md), params?: [MlPreviewDataFrameAnalyticsRequest](./MlPreviewDataFrameAnalyticsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlPreviewDataFrameAnalyticsResponse](./MlPreviewDataFrameAnalyticsResponse.md)>;` | Preview features used by data frame analytics. Preview the extracted features used by a data frame analytics config. || `previewDataFrameAnalytics` | `previewDataFrameAnalytics(this: [That](./That.md), params?: [MlPreviewDataFrameAnalyticsRequest](./MlPreviewDataFrameAnalyticsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlPreviewDataFrameAnalyticsResponse](./MlPreviewDataFrameAnalyticsResponse.md), unknown>>;` |   || `previewDataFrameAnalytics` | `previewDataFrameAnalytics(this: [That](./That.md), params?: [MlPreviewDataFrameAnalyticsRequest](./MlPreviewDataFrameAnalyticsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlPreviewDataFrameAnalyticsResponse](./MlPreviewDataFrameAnalyticsResponse.md)>;` |   || `putCalendar` | `putCalendar(this: [That](./That.md), params: [MlPutCalendarRequest](./MlPutCalendarRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlPutCalendarResponse](./MlPutCalendarResponse.md)>;` | Create a calendar. || `putCalendar` | `putCalendar(this: [That](./That.md), params: [MlPutCalendarRequest](./MlPutCalendarRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlPutCalendarResponse](./MlPutCalendarResponse.md), unknown>>;` |   || `putCalendar` | `putCalendar(this: [That](./That.md), params: [MlPutCalendarRequest](./MlPutCalendarRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlPutCalendarResponse](./MlPutCalendarResponse.md)>;` |   || `putCalendarJob` | `putCalendarJob(this: [That](./That.md), params: [MlPutCalendarJobRequest](./MlPutCalendarJobRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlPutCalendarJobResponse](./MlPutCalendarJobResponse.md)>;` | Add anomaly detection job to calendar. || `putCalendarJob` | `putCalendarJob(this: [That](./That.md), params: [MlPutCalendarJobRequest](./MlPutCalendarJobRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlPutCalendarJobResponse](./MlPutCalendarJobResponse.md), unknown>>;` |   || `putCalendarJob` | `putCalendarJob(this: [That](./That.md), params: [MlPutCalendarJobRequest](./MlPutCalendarJobRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlPutCalendarJobResponse](./MlPutCalendarJobResponse.md)>;` |   || `putDatafeed` | `putDatafeed(this: [That](./That.md), params: [MlPutDatafeedRequest](./MlPutDatafeedRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlPutDatafeedResponse](./MlPutDatafeedResponse.md)>;` | Create a datafeed. Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job. You can associate only one datafeed with each anomaly detection job. The datafeed contains a query that runs at a defined interval ( `frequency`). If you are concerned about delayed data, you can add a delay ( `query_delay') at each interval. By default, the datafeed uses the following query: `{ "match_all": { "boost": 1 } } `. When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead. You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed directly to the `.ml-config ` index. Do not give users `write ` privileges on the `.ml-config ` index. || `putDatafeed` | `putDatafeed(this: [That](./That.md), params: [MlPutDatafeedRequest](./MlPutDatafeedRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlPutDatafeedResponse](./MlPutDatafeedResponse.md), unknown>>;` |   || `putDatafeed` | `putDatafeed(this: [That](./That.md), params: [MlPutDatafeedRequest](./MlPutDatafeedRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlPutDatafeedResponse](./MlPutDatafeedResponse.md)>;` |   || `putDataFrameAnalytics` | `putDataFrameAnalytics(this: [That](./That.md), params: [MlPutDataFrameAnalyticsRequest](./MlPutDataFrameAnalyticsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlPutDataFrameAnalyticsResponse](./MlPutDataFrameAnalyticsResponse.md)>;` | Create a data frame analytics job. This API creates a data frame analytics job that performs an analysis on the source indices and stores the outcome in a destination index. By default, the query used in the source configuration is `{"match_all": {}}`. If the destination index does not exist, it is created automatically when you start the job. If you supply only a subset of the regression or classification parameters, hyperparameter optimization occurs. It determines a value for each of the undefined parameters. || `putDataFrameAnalytics` | `putDataFrameAnalytics(this: [That](./That.md), params: [MlPutDataFrameAnalyticsRequest](./MlPutDataFrameAnalyticsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlPutDataFrameAnalyticsResponse](./MlPutDataFrameAnalyticsResponse.md), unknown>>;` |   || `putDataFrameAnalytics` | `putDataFrameAnalytics(this: [That](./That.md), params: [MlPutDataFrameAnalyticsRequest](./MlPutDataFrameAnalyticsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlPutDataFrameAnalyticsResponse](./MlPutDataFrameAnalyticsResponse.md)>;` |   || `putFilter` | `putFilter(this: [That](./That.md), params: [MlPutFilterRequest](./MlPutFilterRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlPutFilterResponse](./MlPutFilterResponse.md)>;` | Create a filter. A filter contains a list of strings. It can be used by one or more anomaly detection jobs. Specifically, filters are referenced in the `custom_rules` property of detector configuration objects. || `putFilter` | `putFilter(this: [That](./That.md), params: [MlPutFilterRequest](./MlPutFilterRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlPutFilterResponse](./MlPutFilterResponse.md), unknown>>;` |   || `putFilter` | `putFilter(this: [That](./That.md), params: [MlPutFilterRequest](./MlPutFilterRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlPutFilterResponse](./MlPutFilterResponse.md)>;` |   || `putJob` | `putJob(this: [That](./That.md), params: [MlPutJobRequest](./MlPutJobRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlPutJobResponse](./MlPutJobResponse.md)>;` | Create an anomaly detection job. If you include a `datafeed_config`, you must have read index privileges on the source index. If you include a `datafeed_config` but do not provide a query, the datafeed uses `{"match_all": {"boost": 1}}`. || `putJob` | `putJob(this: [That](./That.md), params: [MlPutJobRequest](./MlPutJobRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlPutJobResponse](./MlPutJobResponse.md), unknown>>;` |   || `putJob` | `putJob(this: [That](./That.md), params: [MlPutJobRequest](./MlPutJobRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlPutJobResponse](./MlPutJobResponse.md)>;` |   || `putTrainedModel` | `putTrainedModel(this: [That](./That.md), params: [MlPutTrainedModelRequest](./MlPutTrainedModelRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlPutTrainedModelResponse](./MlPutTrainedModelResponse.md)>;` | Create a trained model. Enable you to supply a trained model that is not created by data frame analytics. || `putTrainedModel` | `putTrainedModel(this: [That](./That.md), params: [MlPutTrainedModelRequest](./MlPutTrainedModelRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlPutTrainedModelResponse](./MlPutTrainedModelResponse.md), unknown>>;` |   || `putTrainedModel` | `putTrainedModel(this: [That](./That.md), params: [MlPutTrainedModelRequest](./MlPutTrainedModelRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlPutTrainedModelResponse](./MlPutTrainedModelResponse.md)>;` |   || `putTrainedModelAlias` | `putTrainedModelAlias(this: [That](./That.md), params: [MlPutTrainedModelAliasRequest](./MlPutTrainedModelAliasRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlPutTrainedModelAliasResponse](./MlPutTrainedModelAliasResponse.md)>;` | Create or update a trained model alias. A trained model alias is a logical name used to reference a single trained model. You can use aliases instead of trained model identifiers to make it easier to reference your models. For example, you can use aliases in inference aggregations and processors. An alias must be unique and refer to only a single trained model. However, you can have multiple aliases for each trained model. If you use this API to update an alias such that it references a different trained model ID and the model uses a different type of data frame analytics, an error occurs. For example, this situation occurs if you have a trained model for regression analysis and a trained model for classification analysis; you cannot reassign an alias from one type of trained model to another. If you use this API to update an alias and there are very few input fields in common between the old and new trained models for the model alias, the API returns a warning. || `putTrainedModelAlias` | `putTrainedModelAlias(this: [That](./That.md), params: [MlPutTrainedModelAliasRequest](./MlPutTrainedModelAliasRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlPutTrainedModelAliasResponse](./MlPutTrainedModelAliasResponse.md), unknown>>;` |   || `putTrainedModelAlias` | `putTrainedModelAlias(this: [That](./That.md), params: [MlPutTrainedModelAliasRequest](./MlPutTrainedModelAliasRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlPutTrainedModelAliasResponse](./MlPutTrainedModelAliasResponse.md)>;` |   || `putTrainedModelDefinitionPart` | `putTrainedModelDefinitionPart(this: [That](./That.md), params: [MlPutTrainedModelDefinitionPartRequest](./MlPutTrainedModelDefinitionPartRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlPutTrainedModelDefinitionPartResponse](./MlPutTrainedModelDefinitionPartResponse.md)>;` | Create part of a trained model definition. || `putTrainedModelDefinitionPart` | `putTrainedModelDefinitionPart(this: [That](./That.md), params: [MlPutTrainedModelDefinitionPartRequest](./MlPutTrainedModelDefinitionPartRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlPutTrainedModelDefinitionPartResponse](./MlPutTrainedModelDefinitionPartResponse.md), unknown>>;` |   || `putTrainedModelDefinitionPart` | `putTrainedModelDefinitionPart(this: [That](./That.md), params: [MlPutTrainedModelDefinitionPartRequest](./MlPutTrainedModelDefinitionPartRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlPutTrainedModelDefinitionPartResponse](./MlPutTrainedModelDefinitionPartResponse.md)>;` |   || `putTrainedModelVocabulary` | `putTrainedModelVocabulary(this: [That](./That.md), params: [MlPutTrainedModelVocabularyRequest](./MlPutTrainedModelVocabularyRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlPutTrainedModelVocabularyResponse](./MlPutTrainedModelVocabularyResponse.md)>;` | Create a trained model vocabulary. This API is supported only for natural language processing (NLP) models. The vocabulary is stored in the index as described in `inference_config.*.vocabulary` of the trained model definition. || `putTrainedModelVocabulary` | `putTrainedModelVocabulary(this: [That](./That.md), params: [MlPutTrainedModelVocabularyRequest](./MlPutTrainedModelVocabularyRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlPutTrainedModelVocabularyResponse](./MlPutTrainedModelVocabularyResponse.md), unknown>>;` |   || `putTrainedModelVocabulary` | `putTrainedModelVocabulary(this: [That](./That.md), params: [MlPutTrainedModelVocabularyRequest](./MlPutTrainedModelVocabularyRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlPutTrainedModelVocabularyResponse](./MlPutTrainedModelVocabularyResponse.md)>;` |   || `resetJob` | `resetJob(this: [That](./That.md), params: [MlResetJobRequest](./MlResetJobRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlResetJobResponse](./MlResetJobResponse.md)>;` | Reset an anomaly detection job. All model state and results are deleted. The job is ready to start over as if it had just been created. It is not currently possible to reset multiple jobs using wildcards or a comma separated list. || `resetJob` | `resetJob(this: [That](./That.md), params: [MlResetJobRequest](./MlResetJobRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlResetJobResponse](./MlResetJobResponse.md), unknown>>;` |   || `resetJob` | `resetJob(this: [That](./That.md), params: [MlResetJobRequest](./MlResetJobRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlResetJobResponse](./MlResetJobResponse.md)>;` |   || `revertModelSnapshot` | `revertModelSnapshot(this: [That](./That.md), params: [MlRevertModelSnapshotRequest](./MlRevertModelSnapshotRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlRevertModelSnapshotResponse](./MlRevertModelSnapshotResponse.md)>;` | Revert to a snapshot. The machine learning features react quickly to anomalous input, learning new behaviors in data. Highly anomalous input increases the variance in the models whilst the system learns whether this is a new step-change in behavior or a one-off event. In the case where this anomalous input is known to be a one-off, then it might be appropriate to reset the model state to a time before this event. For example, you might consider reverting to a saved snapshot after Black Friday or a critical system failure. || `revertModelSnapshot` | `revertModelSnapshot(this: [That](./That.md), params: [MlRevertModelSnapshotRequest](./MlRevertModelSnapshotRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlRevertModelSnapshotResponse](./MlRevertModelSnapshotResponse.md), unknown>>;` |   || `revertModelSnapshot` | `revertModelSnapshot(this: [That](./That.md), params: [MlRevertModelSnapshotRequest](./MlRevertModelSnapshotRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlRevertModelSnapshotResponse](./MlRevertModelSnapshotResponse.md)>;` |   || `setUpgradeMode` | `setUpgradeMode(this: [That](./That.md), params?: [MlSetUpgradeModeRequest](./MlSetUpgradeModeRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlSetUpgradeModeResponse](./MlSetUpgradeModeResponse.md)>;` | Set upgrade_mode for ML indices. Sets a cluster wide upgrade_mode setting that prepares machine learning indices for an upgrade. When upgrading your cluster, in some circumstances you must restart your nodes and reindex your machine learning indices. In those circumstances, there must be no machine learning jobs running. You can close the machine learning jobs, do the upgrade, then open all the jobs again. Alternatively, you can use this API to temporarily halt tasks associated with the jobs and datafeeds and prevent new jobs from opening. You can also use this API during upgrades that do not require you to reindex your machine learning indices, though stopping jobs is not a requirement in that case. You can see the current value for the upgrade_mode setting by using the get machine learning info API. || `setUpgradeMode` | `setUpgradeMode(this: [That](./That.md), params?: [MlSetUpgradeModeRequest](./MlSetUpgradeModeRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlSetUpgradeModeResponse](./MlSetUpgradeModeResponse.md), unknown>>;` |   || `setUpgradeMode` | `setUpgradeMode(this: [That](./That.md), params?: [MlSetUpgradeModeRequest](./MlSetUpgradeModeRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlSetUpgradeModeResponse](./MlSetUpgradeModeResponse.md)>;` |   || `startDatafeed` | `startDatafeed(this: [That](./That.md), params: [MlStartDatafeedRequest](./MlStartDatafeedRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlStartDatafeedResponse](./MlStartDatafeedResponse.md)>;` | Start datafeeds. A datafeed must be started in order to retrieve data from Elasticsearch. A datafeed can be started and stopped multiple times throughout its lifecycle. Before you can start a datafeed, the anomaly detection job must be open. Otherwise, an error occurs. If you restart a stopped datafeed, it continues processing input data from the next millisecond after it was stopped. If new data was indexed for that exact millisecond between stopping and starting, it will be ignored. When Elasticsearch security features are enabled, your datafeed remembers which roles the last user to create or update it had at the time of creation or update and runs the query using those same roles. If you provided secondary authorization headers when you created or updated the datafeed, those credentials are used instead. || `startDatafeed` | `startDatafeed(this: [That](./That.md), params: [MlStartDatafeedRequest](./MlStartDatafeedRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlStartDatafeedResponse](./MlStartDatafeedResponse.md), unknown>>;` |   || `startDatafeed` | `startDatafeed(this: [That](./That.md), params: [MlStartDatafeedRequest](./MlStartDatafeedRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlStartDatafeedResponse](./MlStartDatafeedResponse.md)>;` |   || `startDataFrameAnalytics` | `startDataFrameAnalytics(this: [That](./That.md), params: [MlStartDataFrameAnalyticsRequest](./MlStartDataFrameAnalyticsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlStartDataFrameAnalyticsResponse](./MlStartDataFrameAnalyticsResponse.md)>;` | Start a data frame analytics job. A data frame analytics job can be started and stopped multiple times throughout its lifecycle. If the destination index does not exist, it is created automatically the first time you start the data frame analytics job. The `index.number_of_shards` and `index.number_of_replicas` settings for the destination index are copied from the source index. If there are multiple source indices, the destination index copies the highest setting values. The mappings for the destination index are also copied from the source indices. If there are any mapping conflicts, the job fails to start. If the destination index exists, it is used as is. You can therefore set up the destination index in advance with custom settings and mappings. || `startDataFrameAnalytics` | `startDataFrameAnalytics(this: [That](./That.md), params: [MlStartDataFrameAnalyticsRequest](./MlStartDataFrameAnalyticsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlStartDataFrameAnalyticsResponse](./MlStartDataFrameAnalyticsResponse.md), unknown>>;` |   || `startDataFrameAnalytics` | `startDataFrameAnalytics(this: [That](./That.md), params: [MlStartDataFrameAnalyticsRequest](./MlStartDataFrameAnalyticsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlStartDataFrameAnalyticsResponse](./MlStartDataFrameAnalyticsResponse.md)>;` |   || `startTrainedModelDeployment` | `startTrainedModelDeployment(this: [That](./That.md), params: [MlStartTrainedModelDeploymentRequest](./MlStartTrainedModelDeploymentRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlStartTrainedModelDeploymentResponse](./MlStartTrainedModelDeploymentResponse.md)>;` | Start a trained model deployment. It allocates the model to every machine learning node. || `startTrainedModelDeployment` | `startTrainedModelDeployment(this: [That](./That.md), params: [MlStartTrainedModelDeploymentRequest](./MlStartTrainedModelDeploymentRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlStartTrainedModelDeploymentResponse](./MlStartTrainedModelDeploymentResponse.md), unknown>>;` |   || `startTrainedModelDeployment` | `startTrainedModelDeployment(this: [That](./That.md), params: [MlStartTrainedModelDeploymentRequest](./MlStartTrainedModelDeploymentRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlStartTrainedModelDeploymentResponse](./MlStartTrainedModelDeploymentResponse.md)>;` |   || `stopDatafeed` | `stopDatafeed(this: [That](./That.md), params: [MlStopDatafeedRequest](./MlStopDatafeedRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlStopDatafeedResponse](./MlStopDatafeedResponse.md)>;` | Stop datafeeds. A datafeed that is stopped ceases to retrieve data from Elasticsearch. A datafeed can be started and stopped multiple times throughout its lifecycle. || `stopDatafeed` | `stopDatafeed(this: [That](./That.md), params: [MlStopDatafeedRequest](./MlStopDatafeedRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlStopDatafeedResponse](./MlStopDatafeedResponse.md), unknown>>;` |   || `stopDatafeed` | `stopDatafeed(this: [That](./That.md), params: [MlStopDatafeedRequest](./MlStopDatafeedRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlStopDatafeedResponse](./MlStopDatafeedResponse.md)>;` |   || `stopDataFrameAnalytics` | `stopDataFrameAnalytics(this: [That](./That.md), params: [MlStopDataFrameAnalyticsRequest](./MlStopDataFrameAnalyticsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlStopDataFrameAnalyticsResponse](./MlStopDataFrameAnalyticsResponse.md)>;` | Stop data frame analytics jobs. A data frame analytics job can be started and stopped multiple times throughout its lifecycle. || `stopDataFrameAnalytics` | `stopDataFrameAnalytics(this: [That](./That.md), params: [MlStopDataFrameAnalyticsRequest](./MlStopDataFrameAnalyticsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlStopDataFrameAnalyticsResponse](./MlStopDataFrameAnalyticsResponse.md), unknown>>;` |   || `stopDataFrameAnalytics` | `stopDataFrameAnalytics(this: [That](./That.md), params: [MlStopDataFrameAnalyticsRequest](./MlStopDataFrameAnalyticsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlStopDataFrameAnalyticsResponse](./MlStopDataFrameAnalyticsResponse.md)>;` |   || `stopTrainedModelDeployment` | `stopTrainedModelDeployment(this: [That](./That.md), params: [MlStopTrainedModelDeploymentRequest](./MlStopTrainedModelDeploymentRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlStopTrainedModelDeploymentResponse](./MlStopTrainedModelDeploymentResponse.md)>;` | Stop a trained model deployment. || `stopTrainedModelDeployment` | `stopTrainedModelDeployment(this: [That](./That.md), params: [MlStopTrainedModelDeploymentRequest](./MlStopTrainedModelDeploymentRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlStopTrainedModelDeploymentResponse](./MlStopTrainedModelDeploymentResponse.md), unknown>>;` |   || `stopTrainedModelDeployment` | `stopTrainedModelDeployment(this: [That](./That.md), params: [MlStopTrainedModelDeploymentRequest](./MlStopTrainedModelDeploymentRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlStopTrainedModelDeploymentResponse](./MlStopTrainedModelDeploymentResponse.md)>;` |   || `updateDatafeed` | `updateDatafeed(this: [That](./That.md), params: [MlUpdateDatafeedRequest](./MlUpdateDatafeedRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlUpdateDatafeedResponse](./MlUpdateDatafeedResponse.md)>;` | Update a datafeed. You must stop and start the datafeed for the changes to be applied. When Elasticsearch security features are enabled, your datafeed remembers which roles the user who updated it had at the time of the update and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead. || `updateDatafeed` | `updateDatafeed(this: [That](./That.md), params: [MlUpdateDatafeedRequest](./MlUpdateDatafeedRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlUpdateDatafeedResponse](./MlUpdateDatafeedResponse.md), unknown>>;` |   || `updateDatafeed` | `updateDatafeed(this: [That](./That.md), params: [MlUpdateDatafeedRequest](./MlUpdateDatafeedRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlUpdateDatafeedResponse](./MlUpdateDatafeedResponse.md)>;` |   || `updateDataFrameAnalytics` | `updateDataFrameAnalytics(this: [That](./That.md), params: [MlUpdateDataFrameAnalyticsRequest](./MlUpdateDataFrameAnalyticsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlUpdateDataFrameAnalyticsResponse](./MlUpdateDataFrameAnalyticsResponse.md)>;` | Update a data frame analytics job. || `updateDataFrameAnalytics` | `updateDataFrameAnalytics(this: [That](./That.md), params: [MlUpdateDataFrameAnalyticsRequest](./MlUpdateDataFrameAnalyticsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlUpdateDataFrameAnalyticsResponse](./MlUpdateDataFrameAnalyticsResponse.md), unknown>>;` |   || `updateDataFrameAnalytics` | `updateDataFrameAnalytics(this: [That](./That.md), params: [MlUpdateDataFrameAnalyticsRequest](./MlUpdateDataFrameAnalyticsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlUpdateDataFrameAnalyticsResponse](./MlUpdateDataFrameAnalyticsResponse.md)>;` |   || `updateFilter` | `updateFilter(this: [That](./That.md), params: [MlUpdateFilterRequest](./MlUpdateFilterRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlUpdateFilterResponse](./MlUpdateFilterResponse.md)>;` | Update a filter. Updates the description of a filter, adds items, or removes items from the list. || `updateFilter` | `updateFilter(this: [That](./That.md), params: [MlUpdateFilterRequest](./MlUpdateFilterRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlUpdateFilterResponse](./MlUpdateFilterResponse.md), unknown>>;` |   || `updateFilter` | `updateFilter(this: [That](./That.md), params: [MlUpdateFilterRequest](./MlUpdateFilterRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlUpdateFilterResponse](./MlUpdateFilterResponse.md)>;` |   || `updateJob` | `updateJob(this: [That](./That.md), params: [MlUpdateJobRequest](./MlUpdateJobRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlUpdateJobResponse](./MlUpdateJobResponse.md)>;` | Update an anomaly detection job. Updates certain properties of an anomaly detection job. || `updateJob` | `updateJob(this: [That](./That.md), params: [MlUpdateJobRequest](./MlUpdateJobRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlUpdateJobResponse](./MlUpdateJobResponse.md), unknown>>;` |   || `updateJob` | `updateJob(this: [That](./That.md), params: [MlUpdateJobRequest](./MlUpdateJobRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlUpdateJobResponse](./MlUpdateJobResponse.md)>;` |   || `updateModelSnapshot` | `updateModelSnapshot(this: [That](./That.md), params: [MlUpdateModelSnapshotRequest](./MlUpdateModelSnapshotRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlUpdateModelSnapshotResponse](./MlUpdateModelSnapshotResponse.md)>;` | Update a snapshot. Updates certain properties of a snapshot. || `updateModelSnapshot` | `updateModelSnapshot(this: [That](./That.md), params: [MlUpdateModelSnapshotRequest](./MlUpdateModelSnapshotRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlUpdateModelSnapshotResponse](./MlUpdateModelSnapshotResponse.md), unknown>>;` |   || `updateModelSnapshot` | `updateModelSnapshot(this: [That](./That.md), params: [MlUpdateModelSnapshotRequest](./MlUpdateModelSnapshotRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlUpdateModelSnapshotResponse](./MlUpdateModelSnapshotResponse.md)>;` |   || `updateTrainedModelDeployment` | `updateTrainedModelDeployment(this: [That](./That.md), params: [MlUpdateTrainedModelDeploymentRequest](./MlUpdateTrainedModelDeploymentRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlUpdateTrainedModelDeploymentResponse](./MlUpdateTrainedModelDeploymentResponse.md)>;` | Update a trained model deployment. || `updateTrainedModelDeployment` | `updateTrainedModelDeployment(this: [That](./That.md), params: [MlUpdateTrainedModelDeploymentRequest](./MlUpdateTrainedModelDeploymentRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlUpdateTrainedModelDeploymentResponse](./MlUpdateTrainedModelDeploymentResponse.md), unknown>>;` |   || `updateTrainedModelDeployment` | `updateTrainedModelDeployment(this: [That](./That.md), params: [MlUpdateTrainedModelDeploymentRequest](./MlUpdateTrainedModelDeploymentRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlUpdateTrainedModelDeploymentResponse](./MlUpdateTrainedModelDeploymentResponse.md)>;` |   || `upgradeJobSnapshot` | `upgradeJobSnapshot(this: [That](./That.md), params: [MlUpgradeJobSnapshotRequest](./MlUpgradeJobSnapshotRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlUpgradeJobSnapshotResponse](./MlUpgradeJobSnapshotResponse.md)>;` | Upgrade a snapshot. Upgrade an anomaly detection model snapshot to the latest major version. Over time, older snapshot formats are deprecated and removed. Anomaly detection jobs support only snapshots that are from the current or previous major version. This API provides a means to upgrade a snapshot to the current major version. This aids in preparing the cluster for an upgrade to the next major version. Only one snapshot per anomaly detection job can be upgraded at a time and the upgraded snapshot cannot be the current snapshot of the anomaly detection job. || `upgradeJobSnapshot` | `upgradeJobSnapshot(this: [That](./That.md), params: [MlUpgradeJobSnapshotRequest](./MlUpgradeJobSnapshotRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlUpgradeJobSnapshotResponse](./MlUpgradeJobSnapshotResponse.md), unknown>>;` |   || `upgradeJobSnapshot` | `upgradeJobSnapshot(this: [That](./That.md), params: [MlUpgradeJobSnapshotRequest](./MlUpgradeJobSnapshotRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlUpgradeJobSnapshotResponse](./MlUpgradeJobSnapshotResponse.md)>;` |   || `validate` | `validate(this: [That](./That.md), params?: [MlValidateRequest](./MlValidateRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlValidateResponse](./MlValidateResponse.md)>;` | Validate an anomaly detection job. || `validate` | `validate(this: [That](./That.md), params?: [MlValidateRequest](./MlValidateRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlValidateResponse](./MlValidateResponse.md), unknown>>;` |   || `validate` | `validate(this: [That](./That.md), params?: [MlValidateRequest](./MlValidateRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlValidateResponse](./MlValidateResponse.md)>;` |   || `validateDetector` | `validateDetector(this: [That](./That.md), params: [MlValidateDetectorRequest](./MlValidateDetectorRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlValidateDetectorResponse](./MlValidateDetectorResponse.md)>;` | Validate an anomaly detection job. || `validateDetector` | `validateDetector(this: [That](./That.md), params: [MlValidateDetectorRequest](./MlValidateDetectorRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlValidateDetectorResponse](./MlValidateDetectorResponse.md), unknown>>;` |   || `validateDetector` | `validateDetector(this: [That](./That.md), params: [MlValidateDetectorRequest](./MlValidateDetectorRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlValidateDetectorResponse](./MlValidateDetectorResponse.md)>;` |   | \ No newline at end of file diff --git a/docs/reference/api/MlAdaptiveAllocationsSettings.md b/docs/reference/api/MlAdaptiveAllocationsSettings.md new file mode 100644 index 000000000..e035abc4d --- /dev/null +++ b/docs/reference/api/MlAdaptiveAllocationsSettings.md @@ -0,0 +1,7 @@ +## Interface `MlAdaptiveAllocationsSettings` + +| Name | Type | Description | +| - | - | - | +| `enabled` | boolean | If true, adaptive_allocations is enabled | +| `max_number_of_allocations` | [integer](./integer.md) | Specifies the maximum number of allocations to scale to. If set, it must be greater than or equal to min_number_of_allocations. | +| `min_number_of_allocations` | [integer](./integer.md) | Specifies the minimum number of allocations to scale to. If set, it must be greater than or equal to 0. If not defined, the deployment scales to 0. | diff --git a/docs/reference/api/MlAnalysisConfig.md b/docs/reference/api/MlAnalysisConfig.md new file mode 100644 index 000000000..36f953b30 --- /dev/null +++ b/docs/reference/api/MlAnalysisConfig.md @@ -0,0 +1,15 @@ +## Interface `MlAnalysisConfig` + +| Name | Type | Description | +| - | - | - | +| `bucket_span` | [Duration](./Duration.md) | The size of the interval that the analysis is aggregated into, typically between `5m` and `1h`. This value should be either a whole number of days or equate to a whole number of buckets in one day. If the anomaly detection job uses a datafeed with aggregations, this value must also be divisible by the interval of the date histogram aggregation. | +| `categorization_analyzer` | [MlCategorizationAnalyzer](./MlCategorizationAnalyzer.md) | If `categorization_field_name` is specified, you can also define the analyzer that is used to interpret the categorization field. This property cannot be used at the same time as `categorization_filters`. The categorization analyzer specifies how the `categorization_field` is interpreted by the categorization process. The `categorization_analyzer` field can be specified either as a string or as an object. If it is a string, it must refer to a built-in analyzer or one added by another plugin. | +| `categorization_field_name` | [Field](./Field.md) | If this property is specified, the values of the specified field will be categorized. The resulting categories must be used in a detector by setting `by_field_name`, `over_field_name`, or `partition_field_name` to the keyword `mlcategory`. | +| `categorization_filters` | string[] | If `categorization_field_name` is specified, you can also define optional filters. This property expects an array of regular expressions. The expressions are used to filter out matching sequences from the categorization field values. You can use this functionality to fine tune the categorization by excluding sequences from consideration when categories are defined. For example, you can exclude SQL statements that appear in your log files. This property cannot be used at the same time as `categorization_analyzer`. If you only want to define simple regular expression filters that are applied prior to tokenization, setting this property is the easiest method. If you also want to customize the tokenizer or post-tokenization filtering, use the `categorization_analyzer` property instead and include the filters as pattern_replace character filters. The effect is exactly the same. | +| `detectors` | [MlDetector](./MlDetector.md)[] | Detector configuration objects specify which data fields a job analyzes. They also specify which analytical functions are used. You can specify multiple detectors for a job. If the detectors array does not contain at least one detector, no analysis can occur and an error is returned. | +| `influencers` | [Field](./Field.md)[] | A comma separated list of influencer field names. Typically these can be the by, over, or partition fields that are used in the detector configuration. You might also want to use a field name that is not specifically named in a detector, but is available as part of the input data. When you use multiple detectors, the use of influencers is recommended as it aggregates results for each influencer entity. | +| `latency` | [Duration](./Duration.md) | The size of the window in which to expect data that is out of time order. If you specify a non-zero value, it must be greater than or equal to one second. NOTE: Latency is applicable only when you send data by using the post data API. | +| `model_prune_window` | [Duration](./Duration.md) | Advanced configuration option. Affects the pruning of models that have not been updated for the given time duration. The value must be set to a multiple of the `bucket_span`. If set too low, important information may be removed from the model. For jobs created in 8.1 and later, the default value is the greater of `30d` or 20 times `bucket_span`. | +| `multivariate_by_fields` | boolean | This functionality is reserved for internal use. It is not supported for use in customer environments and is not subject to the support SLA of official GA features. If set to `true`, the analysis will automatically find correlations between metrics for a given by field value and report anomalies when those correlations cease to hold. For example, suppose CPU and memory usage on host A is usually highly correlated with the same metrics on host B. Perhaps this correlation occurs because they are running a load-balanced application. If you enable this property, anomalies will be reported when, for example, CPU usage on host A is high and the value of CPU usage on host B is low. That is to say, you’ll see an anomaly when the CPU of host A is unusual given the CPU of host B. To use the `multivariate_by_fields` property, you must also specify `by_field_name` in your detector. | +| `per_partition_categorization` | [MlPerPartitionCategorization](./MlPerPartitionCategorization.md) | Settings related to how categorization interacts with partition fields. | +| `summary_count_field_name` | [Field](./Field.md) | If this property is specified, the data that is fed to the job is expected to be pre-summarized. This property value is the name of the field that contains the count of raw data points that have been summarized. The same `summary_count_field_name` applies to all detectors in the job. NOTE: The `summary_count_field_name` property cannot be used with the `metric` function. | diff --git a/docs/reference/api/MlAnalysisConfigRead.md b/docs/reference/api/MlAnalysisConfigRead.md new file mode 100644 index 000000000..473fff930 --- /dev/null +++ b/docs/reference/api/MlAnalysisConfigRead.md @@ -0,0 +1,15 @@ +## Interface `MlAnalysisConfigRead` + +| Name | Type | Description | +| - | - | - | +| `bucket_span` | [Duration](./Duration.md) | The size of the interval that the analysis is aggregated into, typically between `5m` and `1h`. | +| `categorization_analyzer` | [MlCategorizationAnalyzer](./MlCategorizationAnalyzer.md) | If `categorization_field_name` is specified, you can also define the analyzer that is used to interpret the categorization field. This property cannot be used at the same time as `categorization_filters`. The categorization analyzer specifies how the `categorization_field` is interpreted by the categorization process. | +| `categorization_field_name` | [Field](./Field.md) | If this property is specified, the values of the specified field will be categorized. The resulting categories must be used in a detector by setting `by_field_name`, `over_field_name`, or `partition_field_name` to the keyword `mlcategory`. | +| `categorization_filters` | string[] | If `categorization_field_name` is specified, you can also define optional filters. This property expects an array of regular expressions. The expressions are used to filter out matching sequences from the categorization field values. | +| `detectors` | [MlDetectorRead](./MlDetectorRead.md)[] | An array of detector configuration objects. Detector configuration objects specify which data fields a job analyzes. They also specify which analytical functions are used. You can specify multiple detectors for a job. | +| `influencers` | [Field](./Field.md)[] | A comma separated list of influencer field names. Typically these can be the by, over, or partition fields that are used in the detector configuration. You might also want to use a field name that is not specifically named in a detector, but is available as part of the input data. When you use multiple detectors, the use of influencers is recommended as it aggregates results for each influencer entity. | +| `latency` | [Duration](./Duration.md) | The size of the window in which to expect data that is out of time order. Defaults to no latency. If you specify a non-zero value, it must be greater than or equal to one second. | +| `model_prune_window` | [Duration](./Duration.md) | Advanced configuration option. Affects the pruning of models that have not been updated for the given time duration. The value must be set to a multiple of the `bucket_span`. If set too low, important information may be removed from the model. Typically, set to `30d` or longer. If not set, model pruning only occurs if the model memory status reaches the soft limit or the hard limit. For jobs created in 8.1 and later, the default value is the greater of `30d` or 20 times `bucket_span`. | +| `multivariate_by_fields` | boolean | This functionality is reserved for internal use. It is not supported for use in customer environments and is not subject to the support SLA of official GA features. If set to `true`, the analysis will automatically find correlations between metrics for a given by field value and report anomalies when those correlations cease to hold. | +| `per_partition_categorization` | [MlPerPartitionCategorization](./MlPerPartitionCategorization.md) | Settings related to how categorization interacts with partition fields. | +| `summary_count_field_name` | [Field](./Field.md) | If this property is specified, the data that is fed to the job is expected to be pre-summarized. This property value is the name of the field that contains the count of raw data points that have been summarized. The same `summary_count_field_name` applies to all detectors in the job. | diff --git a/docs/reference/api/MlAnalysisLimits.md b/docs/reference/api/MlAnalysisLimits.md new file mode 100644 index 000000000..f177fee24 --- /dev/null +++ b/docs/reference/api/MlAnalysisLimits.md @@ -0,0 +1,6 @@ +## Interface `MlAnalysisLimits` + +| Name | Type | Description | +| - | - | - | +| `categorization_examples_limit` | [long](./long.md) | The maximum number of examples stored per category in memory and in the results data store. If you increase this value, more examples are available, however it requires that you have more storage available. If you set this value to 0, no examples are stored. NOTE: The `categorization_examples_limit` applies only to analysis that uses categorization. | +| `model_memory_limit` | [ByteSize](./ByteSize.md) | The approximate maximum amount of memory resources that are required for analytical processing. Once this limit is approached, data pruning becomes more aggressive. Upon exceeding this limit, new entities are not modeled. If the `xpack.ml.max_model_memory_limit` setting has a value greater than 0 and less than 1024mb, that value is used instead of the default. The default value is relatively small to ensure that high resource usage is a conscious decision. If you have jobs that are expected to analyze high cardinality fields, you will likely need to use a higher value. If you specify a number instead of a string, the units are assumed to be MiB. Specifying a string is recommended for clarity. If you specify a byte size unit of `b` or `kb` and the number does not equate to a discrete number of megabytes, it is rounded down to the closest MiB. The minimum valid value is 1 MiB. If you specify a value less than 1 MiB, an error occurs. If you specify a value for the `xpack.ml.max_model_memory_limit` setting, an error occurs when you try to create jobs that have `model_memory_limit` values greater than that setting value. | diff --git a/docs/reference/api/MlAnalysisMemoryLimit.md b/docs/reference/api/MlAnalysisMemoryLimit.md new file mode 100644 index 000000000..17525576e --- /dev/null +++ b/docs/reference/api/MlAnalysisMemoryLimit.md @@ -0,0 +1,5 @@ +## Interface `MlAnalysisMemoryLimit` + +| Name | Type | Description | +| - | - | - | +| `model_memory_limit` | string | Limits can be applied for the resources required to hold the mathematical models in memory. These limits are approximate and can be set per job. They do not control the memory used by other processes, for example the Elasticsearch Java processes. | diff --git a/docs/reference/api/MlAnomaly.md b/docs/reference/api/MlAnomaly.md new file mode 100644 index 000000000..4f3a86d2b --- /dev/null +++ b/docs/reference/api/MlAnomaly.md @@ -0,0 +1,28 @@ +## Interface `MlAnomaly` + +| Name | Type | Description | +| - | - | - | +| `actual` | [double](./double.md)[] | The actual value for the bucket. | +| `anomaly_score_explanation` | [MlAnomalyExplanation](./MlAnomalyExplanation.md) | Information about the factors impacting the initial anomaly score. | +| `bucket_span` | [DurationValue](./DurationValue.md)<[UnitSeconds](./UnitSeconds.md)> | The length of the bucket in seconds. This value matches the `bucket_span` that is specified in the job. | +| `by_field_name` | string | The field used to split the data. In particular, this property is used for analyzing the splits with respect to their own history. It is used for finding unusual values in the context of the split. | +| `by_field_value` | string | The value of `by_field_name`. | +| `causes` | [MlAnomalyCause](./MlAnomalyCause.md)[] | For population analysis, an over field must be specified in the detector. This property contains an array of anomaly records that are the causes for the anomaly that has been identified for the over field. This sub-resource contains the most anomalous records for the `over_field_name`. For scalability reasons, a maximum of the 10 most significant causes of the anomaly are returned. As part of the core analytical modeling, these low-level anomaly records are aggregated for their parent over field record. The `causes` resource contains similar elements to the record resource, namely `actual`, `typical`, `geo_results.actual_point`, `geo_results.typical_point`, `*_field_name` and `*_field_value`. Probability and scores are not applicable to causes. | +| `detector_index` | [integer](./integer.md) | A unique identifier for the detector. | +| `field_name` | string | Certain functions require a field to operate on, for example, `sum()`. For those functions, this value is the name of the field to be analyzed. | +| `function_description` | string | The description of the function in which the anomaly occurs, as specified in the detector configuration. | +| `function` | string | The function in which the anomaly occurs, as specified in the detector configuration. For example, `max`. | +| `geo_results` | [MlGeoResults](./MlGeoResults.md) | If the detector function is `lat_long`, this object contains comma delimited strings for the latitude and longitude of the actual and typical values. | +| `influencers` | [MlInfluence](./MlInfluence.md)[] | If influencers were specified in the detector configuration, this array contains influencers that contributed to or were to blame for an anomaly. | +| `initial_record_score` | [double](./double.md) | A normalized score between 0-100, which is based on the probability of the anomalousness of this record. This is the initial value that was calculated at the time the bucket was processed. | +| `is_interim` | boolean | If true, this is an interim result. In other words, the results are calculated based on partial input data. | +| `job_id` | string | Identifier for the anomaly detection job. | +| `over_field_name` | string | The field used to split the data. In particular, this property is used for analyzing the splits with respect to the history of all splits. It is used for finding unusual values in the population of all splits. | +| `over_field_value` | string | The value of `over_field_name`. | +| `partition_field_name` | string | The field used to segment the analysis. When you use this property, you have completely independent baselines for each value of this field. | +| `partition_field_value` | string | The value of `partition_field_name`. | +| `probability` | [double](./double.md) | The probability of the individual anomaly occurring, in the range 0 to 1. For example, `0.0000772031`. This value can be held to a high precision of over 300 decimal places, so the `record_score` is provided as a human-readable and friendly interpretation of this. | +| `record_score` | [double](./double.md) | A normalized score between 0-100, which is based on the probability of the anomalousness of this record. Unlike `initial_record_score`, this value will be updated by a re-normalization process as new data is analyzed. | +| `result_type` | string | Internal. This is always set to `record`. | +| `timestamp` | [EpochTime](./EpochTime.md)<[UnitMillis](./UnitMillis.md)> | The start time of the bucket for which these results were calculated. | +| `typical` | [double](./double.md)[] | The typical value for the bucket, according to analytical modeling. | diff --git a/docs/reference/api/MlAnomalyCause.md b/docs/reference/api/MlAnomalyCause.md new file mode 100644 index 000000000..9d833487c --- /dev/null +++ b/docs/reference/api/MlAnomalyCause.md @@ -0,0 +1,19 @@ +## Interface `MlAnomalyCause` + +| Name | Type | Description | +| - | - | - | +| `actual` | [double](./double.md)[] |   | +| `by_field_name` | [Name](./Name.md) |   | +| `by_field_value` | string |   | +| `correlated_by_field_value` | string |   | +| `field_name` | [Field](./Field.md) |   | +| `function_description` | string |   | +| `function` | string |   | +| `geo_results` | [MlGeoResults](./MlGeoResults.md) |   | +| `influencers` | [MlInfluence](./MlInfluence.md)[] |   | +| `over_field_name` | [Name](./Name.md) |   | +| `over_field_value` | string |   | +| `partition_field_name` | string |   | +| `partition_field_value` | string |   | +| `probability` | [double](./double.md) |   | +| `typical` | [double](./double.md)[] |   | diff --git a/docs/reference/api/MlAnomalyExplanation.md b/docs/reference/api/MlAnomalyExplanation.md new file mode 100644 index 000000000..f923f995c --- /dev/null +++ b/docs/reference/api/MlAnomalyExplanation.md @@ -0,0 +1,14 @@ +## Interface `MlAnomalyExplanation` + +| Name | Type | Description | +| - | - | - | +| `anomaly_characteristics_impact` | [integer](./integer.md) | Impact from the duration and magnitude of the detected anomaly relative to the historical average. | +| `anomaly_length` | [integer](./integer.md) | Length of the detected anomaly in the number of buckets. | +| `anomaly_type` | string | Type of the detected anomaly: `spike` or `dip`. | +| `high_variance_penalty` | boolean | Indicates reduction of anomaly score for the bucket with large confidence intervals. If a bucket has large confidence intervals, the score is reduced. | +| `incomplete_bucket_penalty` | boolean | If the bucket contains fewer samples than expected, the score is reduced. | +| `lower_confidence_bound` | [double](./double.md) | Lower bound of the 95% confidence interval. | +| `multi_bucket_impact` | [integer](./integer.md) | Impact of the deviation between actual and typical values in the past 12 buckets. | +| `single_bucket_impact` | [integer](./integer.md) | Impact of the deviation between actual and typical values in the current bucket. | +| `typical_value` | [double](./double.md) | Typical (expected) value for this bucket. | +| `upper_confidence_bound` | [double](./double.md) | Upper bound of the 95% confidence interval. | diff --git a/docs/reference/api/MlApiKeyAuthorization.md b/docs/reference/api/MlApiKeyAuthorization.md new file mode 100644 index 000000000..286c83ed9 --- /dev/null +++ b/docs/reference/api/MlApiKeyAuthorization.md @@ -0,0 +1,6 @@ +## Interface `MlApiKeyAuthorization` + +| Name | Type | Description | +| - | - | - | +| `id` | string | The identifier for the API key. | +| `name` | string | The name of the API key. | diff --git a/docs/reference/api/MlAppliesTo.md b/docs/reference/api/MlAppliesTo.md new file mode 100644 index 000000000..ecc768c77 --- /dev/null +++ b/docs/reference/api/MlAppliesTo.md @@ -0,0 +1,4 @@ +## `MlAppliesTo` +::: +type MlAppliesTo = 'actual' | 'typical' | 'diff_from_typical' | 'time'; +::: diff --git a/docs/reference/api/MlBucketInfluencer.md b/docs/reference/api/MlBucketInfluencer.md new file mode 100644 index 000000000..cca4f404b --- /dev/null +++ b/docs/reference/api/MlBucketInfluencer.md @@ -0,0 +1,15 @@ +## Interface `MlBucketInfluencer` + +| Name | Type | Description | +| - | - | - | +| `anomaly_score` | [double](./double.md) | A normalized score between 0-100, which is calculated for each bucket influencer. This score might be updated as newer data is analyzed. | +| `bucket_span` | [DurationValue](./DurationValue.md)<[UnitSeconds](./UnitSeconds.md)> | The length of the bucket in seconds. This value matches the bucket span that is specified in the job. | +| `influencer_field_name` | [Field](./Field.md) | The field name of the influencer. | +| `initial_anomaly_score` | [double](./double.md) | The score between 0-100 for each bucket influencer. This score is the initial value that was calculated at the time the bucket was processed. | +| `is_interim` | boolean | If true, this is an interim result. In other words, the results are calculated based on partial input data. | +| `job_id` | [Id](./Id.md) | Identifier for the anomaly detection job. | +| `probability` | [double](./double.md) | The probability that the bucket has this behavior, in the range 0 to 1. This value can be held to a high precision of over 300 decimal places, so the `anomaly_score` is provided as a human-readable and friendly interpretation of this. | +| `raw_anomaly_score` | [double](./double.md) | Internal. | +| `result_type` | string | Internal. This value is always set to `bucket_influencer`. | +| `timestamp_string` | [DateTime](./DateTime.md) | The start time of the bucket for which these results were calculated. | +| `timestamp` | [EpochTime](./EpochTime.md)<[UnitMillis](./UnitMillis.md)> | The start time of the bucket for which these results were calculated. | diff --git a/docs/reference/api/MlBucketSummary.md b/docs/reference/api/MlBucketSummary.md new file mode 100644 index 000000000..5ea621a0f --- /dev/null +++ b/docs/reference/api/MlBucketSummary.md @@ -0,0 +1,15 @@ +## Interface `MlBucketSummary` + +| Name | Type | Description | +| - | - | - | +| `anomaly_score` | [double](./double.md) | The maximum anomaly score, between 0-100, for any of the bucket influencers. This is an overall, rate-limited score for the job. All the anomaly records in the bucket contribute to this score. This value might be updated as new data is analyzed. | +| `bucket_influencers` | [MlBucketInfluencer](./MlBucketInfluencer.md)[] |   | +| `bucket_span` | [DurationValue](./DurationValue.md)<[UnitSeconds](./UnitSeconds.md)> | The length of the bucket in seconds. This value matches the bucket span that is specified in the job. | +| `event_count` | [long](./long.md) | The number of input data records processed in this bucket. | +| `initial_anomaly_score` | [double](./double.md) | The maximum anomaly score for any of the bucket influencers. This is the initial value that was calculated at the time the bucket was processed. | +| `is_interim` | boolean | If true, this is an interim result. In other words, the results are calculated based on partial input data. | +| `job_id` | [Id](./Id.md) | Identifier for the anomaly detection job. | +| `processing_time_ms` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> | The amount of time, in milliseconds, that it took to analyze the bucket contents and calculate results. | +| `result_type` | string | Internal. This value is always set to bucket. | +| `timestamp_string` | [DateTime](./DateTime.md) | The start time of the bucket. This timestamp uniquely identifies the bucket. Events that occur exactly at the timestamp of the bucket are included in the results for the bucket. | +| `timestamp` | [EpochTime](./EpochTime.md)<[UnitMillis](./UnitMillis.md)> | The start time of the bucket. This timestamp uniquely identifies the bucket. Events that occur exactly at the timestamp of the bucket are included in the results for the bucket. | diff --git a/docs/reference/api/MlCalendarEvent.md b/docs/reference/api/MlCalendarEvent.md new file mode 100644 index 000000000..ea0d813b4 --- /dev/null +++ b/docs/reference/api/MlCalendarEvent.md @@ -0,0 +1,12 @@ +## Interface `MlCalendarEvent` + +| Name | Type | Description | +| - | - | - | +| `calendar_id` | [Id](./Id.md) | A string that uniquely identifies a calendar. | +| `description` | string | A description of the scheduled event. | +| `end_time` | [DateTime](./DateTime.md) | The timestamp for the end of the scheduled event in milliseconds since the epoch or ISO 8601 format. | +| `event_id` | [Id](./Id.md) |   | +| `force_time_shift` | [integer](./integer.md) | Shift time by this many seconds. For example adjust time for daylight savings changes | +| `skip_model_update` | boolean | When true the model will not be updated for this calendar period. | +| `skip_result` | boolean | When true the model will not create results for this calendar period. | +| `start_time` | [DateTime](./DateTime.md) | The timestamp for the beginning of the scheduled event in milliseconds since the epoch or ISO 8601 format. | diff --git a/docs/reference/api/MlCategorizationAnalyzer.md b/docs/reference/api/MlCategorizationAnalyzer.md new file mode 100644 index 000000000..237aa342a --- /dev/null +++ b/docs/reference/api/MlCategorizationAnalyzer.md @@ -0,0 +1,4 @@ +## `MlCategorizationAnalyzer` +::: +type MlCategorizationAnalyzer = string | [MlCategorizationAnalyzerDefinition](./MlCategorizationAnalyzerDefinition.md); +::: diff --git a/docs/reference/api/MlCategorizationAnalyzerDefinition.md b/docs/reference/api/MlCategorizationAnalyzerDefinition.md new file mode 100644 index 000000000..c998b0f4b --- /dev/null +++ b/docs/reference/api/MlCategorizationAnalyzerDefinition.md @@ -0,0 +1,7 @@ +## Interface `MlCategorizationAnalyzerDefinition` + +| Name | Type | Description | +| - | - | - | +| `char_filter` | [AnalysisCharFilter](./AnalysisCharFilter.md)[] | One or more character filters. In addition to the built-in character filters, other plugins can provide more character filters. If this property is not specified, no character filters are applied prior to categorization. If you are customizing some other aspect of the analyzer and you need to achieve the equivalent of `categorization_filters` (which are not permitted when some other aspect of the analyzer is customized), add them here as pattern replace character filters. | +| `filter` | [AnalysisTokenFilter](./AnalysisTokenFilter.md)[] | One or more token filters. In addition to the built-in token filters, other plugins can provide more token filters. If this property is not specified, no token filters are applied prior to categorization. | +| `tokenizer` | [AnalysisTokenizer](./AnalysisTokenizer.md) | The name or definition of the tokenizer to use after character filters are applied. This property is compulsory if `categorization_analyzer` is specified as an object. Machine learning provides a tokenizer called `ml_standard` that tokenizes in a way that has been determined to produce good categorization results on a variety of log file formats for logs in English. If you want to use that tokenizer but change the character or token filters, specify "tokenizer": "ml_standard" in your `categorization_analyzer`. Additionally, the `ml_classic` tokenizer is available, which tokenizes in the same way as the non-customizable tokenizer in old versions of the product (before 6.2). `ml_classic` was the default categorization tokenizer in versions 6.2 to 7.13, so if you need categorization identical to the default for jobs created in these versions, specify "tokenizer": "ml_classic" in your `categorization_analyzer`. | diff --git a/docs/reference/api/MlCategorizationStatus.md b/docs/reference/api/MlCategorizationStatus.md new file mode 100644 index 000000000..27688e673 --- /dev/null +++ b/docs/reference/api/MlCategorizationStatus.md @@ -0,0 +1,4 @@ +## `MlCategorizationStatus` +::: +type MlCategorizationStatus = 'ok' | 'warn'; +::: diff --git a/docs/reference/api/MlCategory.md b/docs/reference/api/MlCategory.md new file mode 100644 index 000000000..0a85eb257 --- /dev/null +++ b/docs/reference/api/MlCategory.md @@ -0,0 +1,18 @@ +## Interface `MlCategory` + +| Name | Type | Description | +| - | - | - | +| `category_id` | [ulong](./ulong.md) | A unique identifier for the category. category_id is unique at the job level, even when per-partition categorization is enabled. | +| `examples` | string[] | A list of examples of actual values that matched the category. | +| `grok_pattern` | [GrokPattern](./GrokPattern.md) | [experimental] A Grok pattern that could be used in Logstash or an ingest pipeline to extract fields from messages that match the category. This field is experimental and may be changed or removed in a future release. The Grok patterns that are found are not optimal, but are often a good starting point for manual tweaking. | +| `job_id` | [Id](./Id.md) | Identifier for the anomaly detection job. | +| `max_matching_length` | [ulong](./ulong.md) | The maximum length of the fields that matched the category. The value is increased by 10% to enable matching for similar fields that have not been analyzed. | +| `mlcategory` | string |   | +| `num_matches` | [long](./long.md) | The number of messages that have been matched by this category. This is only guaranteed to have the latest accurate count after a job _flush or _close | +| `p` | string |   | +| `partition_field_name` | string | If per-partition categorization is enabled, this property identifies the field used to segment the categorization. It is not present when per-partition categorization is disabled. | +| `partition_field_value` | string | If per-partition categorization is enabled, this property identifies the value of the partition_field_name for the category. It is not present when per-partition categorization is disabled. | +| `preferred_to_categories` | [Id](./Id.md)[] | A list of category_id entries that this current category encompasses. Any new message that is processed by the categorizer will match against this category and not any of the categories in this list. This is only guaranteed to have the latest accurate list of categories after a job _flush or _close | +| `regex` | string | A regular expression that is used to search for values that match the category. | +| `result_type` | string |   | +| `terms` | string | A space separated list of the common tokens that are matched in values of the category. | diff --git a/docs/reference/api/MlChunkingConfig.md b/docs/reference/api/MlChunkingConfig.md new file mode 100644 index 000000000..d0e156c3c --- /dev/null +++ b/docs/reference/api/MlChunkingConfig.md @@ -0,0 +1,6 @@ +## Interface `MlChunkingConfig` + +| Name | Type | Description | +| - | - | - | +| `mode` | [MlChunkingMode](./MlChunkingMode.md) | If the mode is `auto`, the chunk size is dynamically calculated; this is the recommended value when the datafeed does not use aggregations. If the mode is `manual`, chunking is applied according to the specified `time_span`; use this mode when the datafeed uses aggregations. If the mode is `off`, no chunking is applied. | +| `time_span` | [Duration](./Duration.md) | The time span that each search will be querying. This setting is applicable only when the `mode` is set to `manual`. | diff --git a/docs/reference/api/MlChunkingMode.md b/docs/reference/api/MlChunkingMode.md new file mode 100644 index 000000000..b116e4bb2 --- /dev/null +++ b/docs/reference/api/MlChunkingMode.md @@ -0,0 +1,4 @@ +## `MlChunkingMode` +::: +type MlChunkingMode = 'auto' | 'manual' | 'off'; +::: diff --git a/docs/reference/api/MlClassificationInferenceOptions.md b/docs/reference/api/MlClassificationInferenceOptions.md new file mode 100644 index 000000000..e2b7a5d45 --- /dev/null +++ b/docs/reference/api/MlClassificationInferenceOptions.md @@ -0,0 +1,9 @@ +## Interface `MlClassificationInferenceOptions` + +| Name | Type | Description | +| - | - | - | +| `num_top_classes` | [integer](./integer.md) | Specifies the number of top class predictions to return. Defaults to 0. | +| `num_top_feature_importance_values` | [integer](./integer.md) | Specifies the maximum number of feature importance values per document. | +| `prediction_field_type` | string | Specifies the type of the predicted field to write. Acceptable values are: string, number, boolean. When boolean is provided 1.0 is transformed to true and 0.0 to false. | +| `results_field` | string | The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. | +| `top_classes_results_field` | string | Specifies the field to which the top classes are written. Defaults to top_classes. | diff --git a/docs/reference/api/MlClearTrainedModelDeploymentCacheRequest.md b/docs/reference/api/MlClearTrainedModelDeploymentCacheRequest.md new file mode 100644 index 000000000..a249fe5f6 --- /dev/null +++ b/docs/reference/api/MlClearTrainedModelDeploymentCacheRequest.md @@ -0,0 +1,7 @@ +## Interface `MlClearTrainedModelDeploymentCacheRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { model_id?: never; }) | All values in `body` will be added to the request body. | +| `model_id` | [Id](./Id.md) | The unique identifier of the trained model. | +| `querystring` | { [key: string]: any; } & { model_id?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/MlClearTrainedModelDeploymentCacheResponse.md b/docs/reference/api/MlClearTrainedModelDeploymentCacheResponse.md new file mode 100644 index 000000000..dab1afb2f --- /dev/null +++ b/docs/reference/api/MlClearTrainedModelDeploymentCacheResponse.md @@ -0,0 +1,5 @@ +## Interface `MlClearTrainedModelDeploymentCacheResponse` + +| Name | Type | Description | +| - | - | - | +| `cleared` | boolean |   | diff --git a/docs/reference/api/MlCloseJobRequest.md b/docs/reference/api/MlCloseJobRequest.md new file mode 100644 index 000000000..12c251890 --- /dev/null +++ b/docs/reference/api/MlCloseJobRequest.md @@ -0,0 +1,10 @@ +## Interface `MlCloseJobRequest` + +| Name | Type | Description | +| - | - | - | +| `allow_no_match` | boolean | Refer to the description for the `allow_no_match` query parameter. | +| `body` | string | ({ [key: string]: any; } & { job_id?: never; allow_no_match?: never; force?: never; timeout?: never; }) | All values in `body` will be added to the request body. | +| `force` | boolean | Refer to the descriptiion for the `force` query parameter. | +| `job_id` | [Id](./Id.md) | Identifier for the anomaly detection job. It can be a job identifier, a group name, or a wildcard expression. You can close multiple anomaly detection jobs in a single API request by using a group name, a comma-separated list of jobs, or a wildcard expression. You can close all jobs by using `_all` or by specifying `*` as the job identifier. | +| `querystring` | { [key: string]: any; } & { job_id?: never; allow_no_match?: never; force?: never; timeout?: never; } | All values in `querystring` will be added to the request querystring. | +| `timeout` | [Duration](./Duration.md) | Refer to the description for the `timeout` query parameter. | diff --git a/docs/reference/api/MlCloseJobResponse.md b/docs/reference/api/MlCloseJobResponse.md new file mode 100644 index 000000000..ab74ee195 --- /dev/null +++ b/docs/reference/api/MlCloseJobResponse.md @@ -0,0 +1,5 @@ +## Interface `MlCloseJobResponse` + +| Name | Type | Description | +| - | - | - | +| `closed` | boolean |   | diff --git a/docs/reference/api/MlCommonTokenizationConfig.md b/docs/reference/api/MlCommonTokenizationConfig.md new file mode 100644 index 000000000..8097ec1ed --- /dev/null +++ b/docs/reference/api/MlCommonTokenizationConfig.md @@ -0,0 +1,9 @@ +## Interface `MlCommonTokenizationConfig` + +| Name | Type | Description | +| - | - | - | +| `do_lower_case` | boolean | Should the tokenizer lower case the text | +| `max_sequence_length` | [integer](./integer.md) | Maximum input sequence length for the model | +| `span` | [integer](./integer.md) | Tokenization spanning options. Special value of -1 indicates no spanning takes place | +| `truncate` | [MlTokenizationTruncate](./MlTokenizationTruncate.md) | Should tokenization input be automatically truncated before sending to the model for inference | +| `with_special_tokens` | boolean | Is tokenization completed with special tokens | diff --git a/docs/reference/api/MlConditionOperator.md b/docs/reference/api/MlConditionOperator.md new file mode 100644 index 000000000..99dc39432 --- /dev/null +++ b/docs/reference/api/MlConditionOperator.md @@ -0,0 +1,4 @@ +## `MlConditionOperator` +::: +type MlConditionOperator = 'gt' | 'gte' | 'lt' | 'lte'; +::: diff --git a/docs/reference/api/MlCustomSettings.md b/docs/reference/api/MlCustomSettings.md new file mode 100644 index 000000000..6ada95792 --- /dev/null +++ b/docs/reference/api/MlCustomSettings.md @@ -0,0 +1,4 @@ +## `MlCustomSettings` +::: +type MlCustomSettings = any; +::: diff --git a/docs/reference/api/MlDataCounts.md b/docs/reference/api/MlDataCounts.md new file mode 100644 index 000000000..afbf7d396 --- /dev/null +++ b/docs/reference/api/MlDataCounts.md @@ -0,0 +1,23 @@ +## Interface `MlDataCounts` + +| Name | Type | Description | +| - | - | - | +| `bucket_count` | [long](./long.md) |   | +| `earliest_record_timestamp` | [long](./long.md) |   | +| `empty_bucket_count` | [long](./long.md) |   | +| `input_bytes` | [long](./long.md) |   | +| `input_field_count` | [long](./long.md) |   | +| `input_record_count` | [long](./long.md) |   | +| `invalid_date_count` | [long](./long.md) |   | +| `job_id` | [Id](./Id.md) |   | +| `last_data_time` | [long](./long.md) |   | +| `latest_bucket_timestamp` | [long](./long.md) |   | +| `latest_empty_bucket_timestamp` | [long](./long.md) |   | +| `latest_record_timestamp` | [long](./long.md) |   | +| `latest_sparse_bucket_timestamp` | [long](./long.md) |   | +| `log_time` | [long](./long.md) |   | +| `missing_field_count` | [long](./long.md) |   | +| `out_of_order_timestamp_count` | [long](./long.md) |   | +| `processed_field_count` | [long](./long.md) |   | +| `processed_record_count` | [long](./long.md) |   | +| `sparse_bucket_count` | [long](./long.md) |   | diff --git a/docs/reference/api/MlDataDescription.md b/docs/reference/api/MlDataDescription.md new file mode 100644 index 000000000..b20a47baa --- /dev/null +++ b/docs/reference/api/MlDataDescription.md @@ -0,0 +1,8 @@ +## Interface `MlDataDescription` + +| Name | Type | Description | +| - | - | - | +| `field_delimiter` | string |   | +| `format` | string | Only JSON format is supported at this time. | +| `time_field` | [Field](./Field.md) | The name of the field that contains the timestamp. | +| `time_format` | string | The time format, which can be `epoch`, `epoch_ms`, or a custom pattern. The value `epoch` refers to UNIX or Epoch time (the number of seconds since 1 Jan 1970). The value `epoch_ms` indicates that time is measured in milliseconds since the epoch. The `epoch` and `epoch_ms` time formats accept either integer or real values. Custom patterns must conform to the Java DateTimeFormatter class. When you use date-time formatting patterns, it is recommended that you provide the full date, time and time zone. For example: `yyyy-MM-dd'T'HH:mm:ssX`. If the pattern that you specify is not sufficient to produce a complete timestamp, job creation fails. | diff --git a/docs/reference/api/MlDatafeed.md b/docs/reference/api/MlDatafeed.md new file mode 100644 index 000000000..503d0daa4 --- /dev/null +++ b/docs/reference/api/MlDatafeed.md @@ -0,0 +1,21 @@ +## Interface `MlDatafeed` + +| Name | Type | Description | +| - | - | - | +| `aggregations` | Record |   | +| `aggs` | Record | aggregations | +| `authorization` | [MlDatafeedAuthorization](./MlDatafeedAuthorization.md) | The security privileges that the datafeed uses to run its queries. If Elastic Stack security features were disabled at the time of the most recent update to the datafeed, this property is omitted. | +| `chunking_config` | [MlChunkingConfig](./MlChunkingConfig.md) |   | +| `datafeed_id` | [Id](./Id.md) |   | +| `delayed_data_check_config` | [MlDelayedDataCheckConfig](./MlDelayedDataCheckConfig.md) |   | +| `frequency` | [Duration](./Duration.md) |   | +| `indexes` | string[] |   | +| `indices_options` | [IndicesOptions](./IndicesOptions.md) |   | +| `indices` | string[] |   | +| `job_id` | [Id](./Id.md) |   | +| `max_empty_searches` | [integer](./integer.md) |   | +| `query_delay` | [Duration](./Duration.md) |   | +| `query` | [QueryDslQueryContainer](./QueryDslQueryContainer.md) |   | +| `runtime_mappings` | [MappingRuntimeFields](./MappingRuntimeFields.md) |   | +| `script_fields` | Record |   | +| `scroll_size` | [integer](./integer.md) |   | diff --git a/docs/reference/api/MlDatafeedAuthorization.md b/docs/reference/api/MlDatafeedAuthorization.md new file mode 100644 index 000000000..9914aecb6 --- /dev/null +++ b/docs/reference/api/MlDatafeedAuthorization.md @@ -0,0 +1,7 @@ +## Interface `MlDatafeedAuthorization` + +| Name | Type | Description | +| - | - | - | +| `api_key` | [MlApiKeyAuthorization](./MlApiKeyAuthorization.md) | If an API key was used for the most recent update to the datafeed, its name and identifier are listed in the response. | +| `roles` | string[] | If a user ID was used for the most recent update to the datafeed, its roles at the time of the update are listed in the response. | +| `service_account` | string | If a service account was used for the most recent update to the datafeed, the account name is listed in the response. | diff --git a/docs/reference/api/MlDatafeedConfig.md b/docs/reference/api/MlDatafeedConfig.md new file mode 100644 index 000000000..c6de3e0ed --- /dev/null +++ b/docs/reference/api/MlDatafeedConfig.md @@ -0,0 +1,20 @@ +## Interface `MlDatafeedConfig` + +| Name | Type | Description | +| - | - | - | +| `aggregations` | Record | If set, the datafeed performs aggregation searches. Support for aggregations is limited and should be used only with low cardinality data. | +| `aggs` | Record | If set, the datafeed performs aggregation searches. Support for aggregations is limited and should be used only with low cardinality data. aggregations | +| `chunking_config` | [MlChunkingConfig](./MlChunkingConfig.md) | Datafeeds might be required to search over long time periods, for several months or years. This search is split into time chunks in order to ensure the load on Elasticsearch is managed. Chunking configuration controls how the size of these time chunks are calculated and is an advanced configuration option. | +| `datafeed_id` | [Id](./Id.md) | A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters. The default value is the job identifier. | +| `delayed_data_check_config` | [MlDelayedDataCheckConfig](./MlDelayedDataCheckConfig.md) | Specifies whether the datafeed checks for missing data and the size of the window. The datafeed can optionally search over indices that have already been read in an effort to determine whether any data has subsequently been added to the index. If missing data is found, it is a good indication that the `query_delay` option is set too low and the data is being indexed after the datafeed has passed that moment in time. This check runs only on real-time datafeeds. | +| `frequency` | [Duration](./Duration.md) | The interval at which scheduled queries are made while the datafeed runs in real time. The default value is either the bucket span for short bucket spans, or, for longer bucket spans, a sensible fraction of the bucket span. For example: `150s`. When `frequency` is shorter than the bucket span, interim results for the last (partial) bucket are written then eventually overwritten by the full bucket results. If the datafeed uses aggregations, this value must be divisible by the interval of the date histogram aggregation. | +| `indexes` | [Indices](./Indices.md) | An array of index names. Wildcards are supported. If any indices are in remote clusters, the machine learning nodes must have the `remote_cluster_client` role. indices | +| `indices_options` | [IndicesOptions](./IndicesOptions.md) | Specifies index expansion options that are used during search. | +| `indices` | [Indices](./Indices.md) | An array of index names. Wildcards are supported. If any indices are in remote clusters, the machine learning nodes must have the `remote_cluster_client` role. | +| `job_id` | [Id](./Id.md) |   | +| `max_empty_searches` | [integer](./integer.md) | If a real-time datafeed has never seen any data (including during any initial training period) then it will automatically stop itself and close its associated job after this many real-time searches that return no documents. In other words, it will stop after `frequency` times `max_empty_searches` of real-time operation. If not set then a datafeed with no end time that sees no data will remain started until it is explicitly stopped. | +| `query_delay` | [Duration](./Duration.md) | The number of seconds behind real time that data is queried. For example, if data from 10:04 a.m. might not be searchable in Elasticsearch until 10:06 a.m., set this property to 120 seconds. The default value is randomly selected between `60s` and `120s`. This randomness improves the query performance when there are multiple jobs running on the same node. | +| `query` | [QueryDslQueryContainer](./QueryDslQueryContainer.md) | The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an Elasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this object is passed verbatim to Elasticsearch. | +| `runtime_mappings` | [MappingRuntimeFields](./MappingRuntimeFields.md) | Specifies runtime fields for the datafeed search. | +| `script_fields` | Record | Specifies scripts that evaluate custom expressions and returns script fields to the datafeed. The detector configuration objects in a job can contain functions that use these script fields. | +| `scroll_size` | [integer](./integer.md) | The size parameter that is used in Elasticsearch searches when the datafeed does not use aggregations. The maximum value is the value of `index.max_result_window`, which is 10,000 by default. | diff --git a/docs/reference/api/MlDatafeedRunningState.md b/docs/reference/api/MlDatafeedRunningState.md new file mode 100644 index 000000000..977d674e4 --- /dev/null +++ b/docs/reference/api/MlDatafeedRunningState.md @@ -0,0 +1,7 @@ +## Interface `MlDatafeedRunningState` + +| Name | Type | Description | +| - | - | - | +| `real_time_configured` | boolean | Indicates if the datafeed is "real-time"; meaning that the datafeed has no configured `end` time. | +| `real_time_running` | boolean | Indicates whether the datafeed has finished running on the available past data. For datafeeds without a configured `end` time, this means that the datafeed is now running on "real-time" data. | +| `search_interval` | [MlRunningStateSearchInterval](./MlRunningStateSearchInterval.md) | Provides the latest time interval the datafeed has searched. | diff --git a/docs/reference/api/MlDatafeedState.md b/docs/reference/api/MlDatafeedState.md new file mode 100644 index 000000000..c71e31272 --- /dev/null +++ b/docs/reference/api/MlDatafeedState.md @@ -0,0 +1,4 @@ +## `MlDatafeedState` +::: +type MlDatafeedState = 'started' | 'stopped' | 'starting' | 'stopping'; +::: diff --git a/docs/reference/api/MlDatafeedStats.md b/docs/reference/api/MlDatafeedStats.md new file mode 100644 index 000000000..8bc054018 --- /dev/null +++ b/docs/reference/api/MlDatafeedStats.md @@ -0,0 +1,10 @@ +## Interface `MlDatafeedStats` + +| Name | Type | Description | +| - | - | - | +| `assignment_explanation` | string | For started datafeeds only, contains messages relating to the selection of a node. | +| `datafeed_id` | [Id](./Id.md) | A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters. | +| `node` | [MlDiscoveryNodeCompact](./MlDiscoveryNodeCompact.md) | For started datafeeds only, this information pertains to the node upon which the datafeed is started. | +| `running_state` | [MlDatafeedRunningState](./MlDatafeedRunningState.md) | An object containing the running state for this datafeed. It is only provided if the datafeed is started. | +| `state` | [MlDatafeedState](./MlDatafeedState.md) | The status of the datafeed, which can be one of the following values: `starting`, `started`, `stopping`, `stopped`. | +| `timing_stats` | [MlDatafeedTimingStats](./MlDatafeedTimingStats.md) | An object that provides statistical information about timing aspect of this datafeed. | diff --git a/docs/reference/api/MlDatafeedTimingStats.md b/docs/reference/api/MlDatafeedTimingStats.md new file mode 100644 index 000000000..27ae9da2b --- /dev/null +++ b/docs/reference/api/MlDatafeedTimingStats.md @@ -0,0 +1,11 @@ +## Interface `MlDatafeedTimingStats` + +| Name | Type | Description | +| - | - | - | +| `average_search_time_per_bucket_ms` | [DurationValue](./DurationValue.md)<[UnitFloatMillis](./UnitFloatMillis.md)> | The average search time per bucket, in milliseconds. | +| `bucket_count` | [long](./long.md) | The number of buckets processed. | +| `exponential_average_calculation_context` | [MlExponentialAverageCalculationContext](./MlExponentialAverageCalculationContext.md) |   | +| `exponential_average_search_time_per_hour_ms` | [DurationValue](./DurationValue.md)<[UnitFloatMillis](./UnitFloatMillis.md)> | The exponential average search time per hour, in milliseconds. | +| `job_id` | [Id](./Id.md) | Identifier for the anomaly detection job. | +| `search_count` | [long](./long.md) | The number of searches run by the datafeed. | +| `total_search_time_ms` | [DurationValue](./DurationValue.md)<[UnitFloatMillis](./UnitFloatMillis.md)> | The total time the datafeed spent searching, in milliseconds. | diff --git a/docs/reference/api/MlDataframeAnalysis.md b/docs/reference/api/MlDataframeAnalysis.md new file mode 100644 index 000000000..1c4147fc1 --- /dev/null +++ b/docs/reference/api/MlDataframeAnalysis.md @@ -0,0 +1,23 @@ +## Interface `MlDataframeAnalysis` + +| Name | Type | Description | +| - | - | - | +| `alpha` | [double](./double.md) | Advanced configuration option. Machine learning uses loss guided tree growing, which means that the decision trees grow where the regularized loss decreases most quickly. This parameter affects loss calculations by acting as a multiplier of the tree depth. Higher alpha values result in shallower trees and faster training times. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to zero. | +| `dependent_variable` | string | Defines which field of the document is to be predicted. It must match one of the fields in the index being used to train. If this field is missing from a document, then that document will not be used for training, but a prediction with the trained model will be generated for it. It is also known as continuous target variable. For classification analysis, the data type of the field must be numeric ( `integer`, `short`, `long`, `byte`), categorical ( `ip` or `keyword`), or `boolean`. There must be no more than 30 different values in this field. For regression analysis, the data type of the field must be numeric. | +| `downsample_factor` | [double](./double.md) | Advanced configuration option. Controls the fraction of data that is used to compute the derivatives of the loss function for tree training. A small value results in the use of a small fraction of the data. If this value is set to be less than 1, accuracy typically improves. However, too small a value may result in poor convergence for the ensemble and so require more trees. By default, this value is calculated during hyperparameter optimization. It must be greater than zero and less than or equal to 1. | +| `early_stopping_enabled` | boolean | Advanced configuration option. Specifies whether the training process should finish if it is not finding any better performing models. If disabled, the training process can take significantly longer and the chance of finding a better performing model is unremarkable. | +| `eta_growth_rate_per_tree` | [double](./double.md) | Advanced configuration option. Specifies the rate at which `eta` increases for each new tree that is added to the forest. For example, a rate of 1.05 increases `eta` by 5% for each extra tree. By default, this value is calculated during hyperparameter optimization. It must be between 0.5 and 2. | +| `eta` | [double](./double.md) | Advanced configuration option. The shrinkage applied to the weights. Smaller values result in larger forests which have a better generalization error. However, larger forests cause slower training. By default, this value is calculated during hyperparameter optimization. It must be a value between 0.001 and 1. | +| `feature_bag_fraction` | [double](./double.md) | Advanced configuration option. Defines the fraction of features that will be used when selecting a random bag for each candidate split. By default, this value is calculated during hyperparameter optimization. | +| `feature_processors` | [MlDataframeAnalysisFeatureProcessor](./MlDataframeAnalysisFeatureProcessor.md)[] | Advanced configuration option. A collection of feature preprocessors that modify one or more included fields. The analysis uses the resulting one or more features instead of the original document field. However, these features are ephemeral; they are not stored in the destination index. Multiple `feature_processors` entries can refer to the same document fields. Automatic categorical feature encoding still occurs for the fields that are unprocessed by a custom processor or that have categorical values. Use this property only if you want to override the automatic feature encoding of the specified fields. | +| `gamma` | [double](./double.md) | Advanced configuration option. Regularization parameter to prevent overfitting on the training data set. Multiplies a linear penalty associated with the size of individual trees in the forest. A high gamma value causes training to prefer small trees. A small gamma value results in larger individual trees and slower training. By default, this value is calculated during hyperparameter optimization. It must be a nonnegative value. | +| `lambda` | [double](./double.md) | Advanced configuration option. Regularization parameter to prevent overfitting on the training data set. Multiplies an L2 regularization term which applies to leaf weights of the individual trees in the forest. A high lambda value causes training to favor small leaf weights. This behavior makes the prediction function smoother at the expense of potentially not being able to capture relevant relationships between the features and the dependent variable. A small lambda value results in large individual trees and slower training. By default, this value is calculated during hyperparameter optimization. It must be a nonnegative value. | +| `max_optimization_rounds_per_hyperparameter` | [integer](./integer.md) | Advanced configuration option. A multiplier responsible for determining the maximum number of hyperparameter optimization steps in the Bayesian optimization procedure. The maximum number of steps is determined based on the number of undefined hyperparameters times the maximum optimization rounds per hyperparameter. By default, this value is calculated during hyperparameter optimization. | +| `max_trees` | [integer](./integer.md) | Advanced configuration option. Defines the maximum number of decision trees in the forest. The maximum value is 2000. By default, this value is calculated during hyperparameter optimization. | +| `maximum_number_trees` | [integer](./integer.md) | Advanced configuration option. Defines the maximum number of decision trees in the forest. The maximum value is 2000. By default, this value is calculated during hyperparameter optimization. max_trees | +| `num_top_feature_importance_values` | [integer](./integer.md) | Advanced configuration option. Specifies the maximum number of feature importance values per document to return. By default, no feature importance calculation occurs. | +| `prediction_field_name` | [Field](./Field.md) | Defines the name of the prediction field in the results. Defaults to `_prediction`. | +| `randomize_seed` | [double](./double.md) | Defines the seed for the random generator that is used to pick training data. By default, it is randomly generated. Set it to a specific value to use the same training data each time you start a job (assuming other related parameters such as `source` and `analyzed_fields` are the same). | +| `soft_tree_depth_limit` | [integer](./integer.md) | Advanced configuration option. Machine learning uses loss guided tree growing, which means that the decision trees grow where the regularized loss decreases most quickly. This soft limit combines with the `soft_tree_depth_tolerance` to penalize trees that exceed the specified depth; the regularized loss increases quickly beyond this depth. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to 0. | +| `soft_tree_depth_tolerance` | [double](./double.md) | Advanced configuration option. This option controls how quickly the regularized loss increases when the tree depth exceeds `soft_tree_depth_limit`. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to 0.01. | +| `training_percent` | [Percentage](./Percentage.md) | Defines what percentage of the eligible documents that will be used for training. Documents that are ignored by the analysis (for example those that contain arrays with more than one value) won’t be included in the calculation for used percentage. | diff --git a/docs/reference/api/MlDataframeAnalysisAnalyzedFields.md b/docs/reference/api/MlDataframeAnalysisAnalyzedFields.md new file mode 100644 index 000000000..250e15cbb --- /dev/null +++ b/docs/reference/api/MlDataframeAnalysisAnalyzedFields.md @@ -0,0 +1,6 @@ +## Interface `MlDataframeAnalysisAnalyzedFields` + +| Name | Type | Description | +| - | - | - | +| `excludes` | string[] | An array of strings that defines the fields that will be included in the analysis. | +| `includes` | string[] | An array of strings that defines the fields that will be excluded from the analysis. You do not need to add fields with unsupported data types to excludes, these fields are excluded from the analysis automatically. | diff --git a/docs/reference/api/MlDataframeAnalysisClassification.md b/docs/reference/api/MlDataframeAnalysisClassification.md new file mode 100644 index 000000000..43b239be8 --- /dev/null +++ b/docs/reference/api/MlDataframeAnalysisClassification.md @@ -0,0 +1,6 @@ +## Interface `MlDataframeAnalysisClassification` + +| Name | Type | Description | +| - | - | - | +| `class_assignment_objective` | string |   | +| `num_top_classes` | [integer](./integer.md) | Defines the number of categories for which the predicted probabilities are reported. It must be non-negative or -1. If it is -1 or greater than the total number of categories, probabilities are reported for all categories; if you have a large number of categories, there could be a significant effect on the size of your destination index. NOTE: To use the AUC ROC evaluation method, `num_top_classes` must be set to -1 or a value greater than or equal to the total number of categories. | diff --git a/docs/reference/api/MlDataframeAnalysisContainer.md b/docs/reference/api/MlDataframeAnalysisContainer.md new file mode 100644 index 000000000..3ceb4931c --- /dev/null +++ b/docs/reference/api/MlDataframeAnalysisContainer.md @@ -0,0 +1,7 @@ +## Interface `MlDataframeAnalysisContainer` + +| Name | Type | Description | +| - | - | - | +| `classification` | [MlDataframeAnalysisClassification](./MlDataframeAnalysisClassification.md) | The configuration information necessary to perform classification. | +| `outlier_detection` | [MlDataframeAnalysisOutlierDetection](./MlDataframeAnalysisOutlierDetection.md) | The configuration information necessary to perform outlier detection. NOTE: Advanced parameters are for fine-tuning classification analysis. They are set automatically by hyperparameter optimization to give the minimum validation error. It is highly recommended to use the default values unless you fully understand the function of these parameters. | +| `regression` | [MlDataframeAnalysisRegression](./MlDataframeAnalysisRegression.md) | The configuration information necessary to perform regression. NOTE: Advanced parameters are for fine-tuning regression analysis. They are set automatically by hyperparameter optimization to give the minimum validation error. It is highly recommended to use the default values unless you fully understand the function of these parameters. | diff --git a/docs/reference/api/MlDataframeAnalysisFeatureProcessor.md b/docs/reference/api/MlDataframeAnalysisFeatureProcessor.md new file mode 100644 index 000000000..bea6b0def --- /dev/null +++ b/docs/reference/api/MlDataframeAnalysisFeatureProcessor.md @@ -0,0 +1,9 @@ +## Interface `MlDataframeAnalysisFeatureProcessor` + +| Name | Type | Description | +| - | - | - | +| `frequency_encoding` | [MlDataframeAnalysisFeatureProcessorFrequencyEncoding](./MlDataframeAnalysisFeatureProcessorFrequencyEncoding.md) | The configuration information necessary to perform frequency encoding. | +| `multi_encoding` | [MlDataframeAnalysisFeatureProcessorMultiEncoding](./MlDataframeAnalysisFeatureProcessorMultiEncoding.md) | The configuration information necessary to perform multi encoding. It allows multiple processors to be changed together. This way the output of a processor can then be passed to another as an input. | +| `n_gram_encoding` | [MlDataframeAnalysisFeatureProcessorNGramEncoding](./MlDataframeAnalysisFeatureProcessorNGramEncoding.md) | The configuration information necessary to perform n-gram encoding. Features created by this encoder have the following name format: < feature_prefix > . < string position > . For example, if the feature_prefix is f, the feature name for the second unigram in a string is f.11. | +| `one_hot_encoding` | [MlDataframeAnalysisFeatureProcessorOneHotEncoding](./MlDataframeAnalysisFeatureProcessorOneHotEncoding.md) | The configuration information necessary to perform one hot encoding. | +| `target_mean_encoding` | [MlDataframeAnalysisFeatureProcessorTargetMeanEncoding](./MlDataframeAnalysisFeatureProcessorTargetMeanEncoding.md) | The configuration information necessary to perform target mean encoding. | diff --git a/docs/reference/api/MlDataframeAnalysisFeatureProcessorFrequencyEncoding.md b/docs/reference/api/MlDataframeAnalysisFeatureProcessorFrequencyEncoding.md new file mode 100644 index 000000000..3c48c6e28 --- /dev/null +++ b/docs/reference/api/MlDataframeAnalysisFeatureProcessorFrequencyEncoding.md @@ -0,0 +1,7 @@ +## Interface `MlDataframeAnalysisFeatureProcessorFrequencyEncoding` + +| Name | Type | Description | +| - | - | - | +| `feature_name` | [Name](./Name.md) | The resulting feature name. | +| `field` | [Field](./Field.md) |   | +| `frequency_map` | Record | The resulting frequency map for the field value. If the field value is missing from the frequency_map, the resulting value is 0. | diff --git a/docs/reference/api/MlDataframeAnalysisFeatureProcessorMultiEncoding.md b/docs/reference/api/MlDataframeAnalysisFeatureProcessorMultiEncoding.md new file mode 100644 index 000000000..97d09d687 --- /dev/null +++ b/docs/reference/api/MlDataframeAnalysisFeatureProcessorMultiEncoding.md @@ -0,0 +1,5 @@ +## Interface `MlDataframeAnalysisFeatureProcessorMultiEncoding` + +| Name | Type | Description | +| - | - | - | +| `processors` | [integer](./integer.md)[] | The ordered array of custom processors to execute. Must be more than 1. | diff --git a/docs/reference/api/MlDataframeAnalysisFeatureProcessorNGramEncoding.md b/docs/reference/api/MlDataframeAnalysisFeatureProcessorNGramEncoding.md new file mode 100644 index 000000000..f1be49ba1 --- /dev/null +++ b/docs/reference/api/MlDataframeAnalysisFeatureProcessorNGramEncoding.md @@ -0,0 +1,10 @@ +## Interface `MlDataframeAnalysisFeatureProcessorNGramEncoding` + +| Name | Type | Description | +| - | - | - | +| `custom` | boolean |   | +| `feature_prefix` | string | The feature name prefix. Defaults to ngram_ _ . | +| `field` | [Field](./Field.md) | The name of the text field to encode. | +| `length` | [integer](./integer.md) | Specifies the length of the n-gram substring. Defaults to 50. Must be greater than 0. | +| `n_grams` | [integer](./integer.md)[] | Specifies which n-grams to gather. It’s an array of integer values where the minimum value is 1, and a maximum value is 5. | +| `start` | [integer](./integer.md) | Specifies the zero-indexed start of the n-gram substring. Negative values are allowed for encoding n-grams of string suffixes. Defaults to 0. | diff --git a/docs/reference/api/MlDataframeAnalysisFeatureProcessorOneHotEncoding.md b/docs/reference/api/MlDataframeAnalysisFeatureProcessorOneHotEncoding.md new file mode 100644 index 000000000..89429f080 --- /dev/null +++ b/docs/reference/api/MlDataframeAnalysisFeatureProcessorOneHotEncoding.md @@ -0,0 +1,6 @@ +## Interface `MlDataframeAnalysisFeatureProcessorOneHotEncoding` + +| Name | Type | Description | +| - | - | - | +| `field` | [Field](./Field.md) | The name of the field to encode. | +| `hot_map` | string | The one hot map mapping the field value with the column name. | diff --git a/docs/reference/api/MlDataframeAnalysisFeatureProcessorTargetMeanEncoding.md b/docs/reference/api/MlDataframeAnalysisFeatureProcessorTargetMeanEncoding.md new file mode 100644 index 000000000..52250cfd6 --- /dev/null +++ b/docs/reference/api/MlDataframeAnalysisFeatureProcessorTargetMeanEncoding.md @@ -0,0 +1,8 @@ +## Interface `MlDataframeAnalysisFeatureProcessorTargetMeanEncoding` + +| Name | Type | Description | +| - | - | - | +| `default_value` | [integer](./integer.md) | The default value if field value is not found in the target_map. | +| `feature_name` | [Name](./Name.md) | The resulting feature name. | +| `field` | [Field](./Field.md) | The name of the field to encode. | +| `target_map` | Record | The field value to target mean transition map. | diff --git a/docs/reference/api/MlDataframeAnalysisOutlierDetection.md b/docs/reference/api/MlDataframeAnalysisOutlierDetection.md new file mode 100644 index 000000000..0c59cc3f4 --- /dev/null +++ b/docs/reference/api/MlDataframeAnalysisOutlierDetection.md @@ -0,0 +1,10 @@ +## Interface `MlDataframeAnalysisOutlierDetection` + +| Name | Type | Description | +| - | - | - | +| `compute_feature_influence` | boolean | Specifies whether the feature influence calculation is enabled. | +| `feature_influence_threshold` | [double](./double.md) | The minimum outlier score that a document needs to have in order to calculate its feature influence score. Value range: 0-1. | +| `method` | string | The method that outlier detection uses. Available methods are `lof`, `ldof`, `distance_kth_nn`, `distance_knn`, and `ensemble`. The default value is ensemble, which means that outlier detection uses an ensemble of different methods and normalises and combines their individual outlier scores to obtain the overall outlier score. | +| `n_neighbors` | [integer](./integer.md) | Defines the value for how many nearest neighbors each method of outlier detection uses to calculate its outlier score. When the value is not set, different values are used for different ensemble members. This default behavior helps improve the diversity in the ensemble; only override it if you are confident that the value you choose is appropriate for the data set. | +| `outlier_fraction` | [double](./double.md) | The proportion of the data set that is assumed to be outlying prior to outlier detection. For example, 0.05 means it is assumed that 5% of values are real outliers and 95% are inliers. | +| `standardization_enabled` | boolean | If true, the following operation is performed on the columns before computing outlier scores: `(x_i - mean(x_i)) / sd(x_i)`. | diff --git a/docs/reference/api/MlDataframeAnalysisRegression.md b/docs/reference/api/MlDataframeAnalysisRegression.md new file mode 100644 index 000000000..ac50d0534 --- /dev/null +++ b/docs/reference/api/MlDataframeAnalysisRegression.md @@ -0,0 +1,6 @@ +## Interface `MlDataframeAnalysisRegression` + +| Name | Type | Description | +| - | - | - | +| `loss_function_parameter` | [double](./double.md) | A positive number that is used as a parameter to the `loss_function`. | +| `loss_function` | string | The loss function used during regression. Available options are `mse` (mean squared error), `msle` (mean squared logarithmic error), `huber` (Pseudo-Huber loss). | diff --git a/docs/reference/api/MlDataframeAnalytics.md b/docs/reference/api/MlDataframeAnalytics.md new file mode 100644 index 000000000..ace056acc --- /dev/null +++ b/docs/reference/api/MlDataframeAnalytics.md @@ -0,0 +1,12 @@ +## Interface `MlDataframeAnalytics` + +| Name | Type | Description | +| - | - | - | +| `analysis_stats` | [MlDataframeAnalyticsStatsContainer](./MlDataframeAnalyticsStatsContainer.md) | An object containing information about the analysis job. | +| `assignment_explanation` | string | For running jobs only, contains messages relating to the selection of a node to run the job. | +| `data_counts` | [MlDataframeAnalyticsStatsDataCounts](./MlDataframeAnalyticsStatsDataCounts.md) | An object that provides counts for the quantity of documents skipped, used in training, or available for testing. | +| `id` | [Id](./Id.md) | The unique identifier of the data frame analytics job. | +| `memory_usage` | [MlDataframeAnalyticsStatsMemoryUsage](./MlDataframeAnalyticsStatsMemoryUsage.md) | An object describing memory usage of the analytics. It is present only after the job is started and memory usage is reported. | +| `node` | [NodeAttributes](./NodeAttributes.md) | Contains properties for the node that runs the job. This information is available only for running jobs. | +| `progress` | [MlDataframeAnalyticsStatsProgress](./MlDataframeAnalyticsStatsProgress.md)[] | The progress report of the data frame analytics job by phase. | +| `state` | [MlDataframeState](./MlDataframeState.md) | The status of the data frame analytics job, which can be one of the following values: failed, started, starting, stopping, stopped. | diff --git a/docs/reference/api/MlDataframeAnalyticsAuthorization.md b/docs/reference/api/MlDataframeAnalyticsAuthorization.md new file mode 100644 index 000000000..232eb1212 --- /dev/null +++ b/docs/reference/api/MlDataframeAnalyticsAuthorization.md @@ -0,0 +1,7 @@ +## Interface `MlDataframeAnalyticsAuthorization` + +| Name | Type | Description | +| - | - | - | +| `api_key` | [MlApiKeyAuthorization](./MlApiKeyAuthorization.md) | If an API key was used for the most recent update to the job, its name and identifier are listed in the response. | +| `roles` | string[] | If a user ID was used for the most recent update to the job, its roles at the time of the update are listed in the response. | +| `service_account` | string | If a service account was used for the most recent update to the job, the account name is listed in the response. | diff --git a/docs/reference/api/MlDataframeAnalyticsDestination.md b/docs/reference/api/MlDataframeAnalyticsDestination.md new file mode 100644 index 000000000..184062f90 --- /dev/null +++ b/docs/reference/api/MlDataframeAnalyticsDestination.md @@ -0,0 +1,6 @@ +## Interface `MlDataframeAnalyticsDestination` + +| Name | Type | Description | +| - | - | - | +| `index` | [IndexName](./IndexName.md) | Defines the destination index to store the results of the data frame analytics job. | +| `results_field` | [Field](./Field.md) | Defines the name of the field in which to store the results of the analysis. Defaults to `ml`. | diff --git a/docs/reference/api/MlDataframeAnalyticsFieldSelection.md b/docs/reference/api/MlDataframeAnalyticsFieldSelection.md new file mode 100644 index 000000000..d6723f78a --- /dev/null +++ b/docs/reference/api/MlDataframeAnalyticsFieldSelection.md @@ -0,0 +1,10 @@ +## Interface `MlDataframeAnalyticsFieldSelection` + +| Name | Type | Description | +| - | - | - | +| `feature_type` | string | The feature type of this field for the analysis. May be categorical or numerical. | +| `is_included` | boolean | Whether the field is selected to be included in the analysis. | +| `is_required` | boolean | Whether the field is required. | +| `mapping_types` | string[] | The mapping types of the field. | +| `name` | [Field](./Field.md) | The field name. | +| `reason` | string | The reason a field is not selected to be included in the analysis. | diff --git a/docs/reference/api/MlDataframeAnalyticsMemoryEstimation.md b/docs/reference/api/MlDataframeAnalyticsMemoryEstimation.md new file mode 100644 index 000000000..2ff96e4b3 --- /dev/null +++ b/docs/reference/api/MlDataframeAnalyticsMemoryEstimation.md @@ -0,0 +1,6 @@ +## Interface `MlDataframeAnalyticsMemoryEstimation` + +| Name | Type | Description | +| - | - | - | +| `expected_memory_with_disk` | string | Estimated memory usage under the assumption that overflowing to disk is allowed during data frame analytics. expected_memory_with_disk is usually smaller than expected_memory_without_disk as using disk allows to limit the main memory needed to perform data frame analytics. | +| `expected_memory_without_disk` | string | Estimated memory usage under the assumption that the whole data frame analytics should happen in memory (i.e. without overflowing to disk). | diff --git a/docs/reference/api/MlDataframeAnalyticsSource.md b/docs/reference/api/MlDataframeAnalyticsSource.md new file mode 100644 index 000000000..dc00a4f86 --- /dev/null +++ b/docs/reference/api/MlDataframeAnalyticsSource.md @@ -0,0 +1,8 @@ +## Interface `MlDataframeAnalyticsSource` + +| Name | Type | Description | +| - | - | - | +| `_source` | [MlDataframeAnalysisAnalyzedFields](./MlDataframeAnalysisAnalyzedFields.md) | string[] | Specify `includes` and/or ` excludes patterns to select which fields will be present in the destination. Fields that are excluded cannot be included in the analysis. | +| `index` | [Indices](./Indices.md) | Index or indices on which to perform the analysis. It can be a single index or index pattern as well as an array of indices or patterns. NOTE: If your source indices contain documents with the same IDs, only the document that is indexed last appears in the destination index. | +| `query` | [QueryDslQueryContainer](./QueryDslQueryContainer.md) | The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an Elasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this object is passed verbatim to Elasticsearch. By default, this property has the following value: { "match_all": { } } . | +| `runtime_mappings` | [MappingRuntimeFields](./MappingRuntimeFields.md) | Definitions of runtime fields that will become part of the mapping of the destination index. | diff --git a/docs/reference/api/MlDataframeAnalyticsStatsContainer.md b/docs/reference/api/MlDataframeAnalyticsStatsContainer.md new file mode 100644 index 000000000..c7e626908 --- /dev/null +++ b/docs/reference/api/MlDataframeAnalyticsStatsContainer.md @@ -0,0 +1,7 @@ +## Interface `MlDataframeAnalyticsStatsContainer` + +| Name | Type | Description | +| - | - | - | +| `classification_stats` | [MlDataframeAnalyticsStatsHyperparameters](./MlDataframeAnalyticsStatsHyperparameters.md) | An object containing information about the classification analysis job. | +| `outlier_detection_stats` | [MlDataframeAnalyticsStatsOutlierDetection](./MlDataframeAnalyticsStatsOutlierDetection.md) | An object containing information about the outlier detection job. | +| `regression_stats` | [MlDataframeAnalyticsStatsHyperparameters](./MlDataframeAnalyticsStatsHyperparameters.md) | An object containing information about the regression analysis. | diff --git a/docs/reference/api/MlDataframeAnalyticsStatsDataCounts.md b/docs/reference/api/MlDataframeAnalyticsStatsDataCounts.md new file mode 100644 index 000000000..ea2b0cb69 --- /dev/null +++ b/docs/reference/api/MlDataframeAnalyticsStatsDataCounts.md @@ -0,0 +1,7 @@ +## Interface `MlDataframeAnalyticsStatsDataCounts` + +| Name | Type | Description | +| - | - | - | +| `skipped_docs_count` | [integer](./integer.md) | The number of documents that are skipped during the analysis because they contained values that are not supported by the analysis. For example, outlier detection does not support missing fields so it skips documents with missing fields. Likewise, all types of analysis skip documents that contain arrays with more than one element. | +| `test_docs_count` | [integer](./integer.md) | The number of documents that are not used for training the model and can be used for testing. | +| `training_docs_count` | [integer](./integer.md) | The number of documents that are used for training the model. | diff --git a/docs/reference/api/MlDataframeAnalyticsStatsHyperparameters.md b/docs/reference/api/MlDataframeAnalyticsStatsHyperparameters.md new file mode 100644 index 000000000..d340c35e8 --- /dev/null +++ b/docs/reference/api/MlDataframeAnalyticsStatsHyperparameters.md @@ -0,0 +1,9 @@ +## Interface `MlDataframeAnalyticsStatsHyperparameters` + +| Name | Type | Description | +| - | - | - | +| `hyperparameters` | [MlHyperparameters](./MlHyperparameters.md) | An object containing the parameters of the classification analysis job. | +| `iteration` | [integer](./integer.md) | The number of iterations on the analysis. | +| `timestamp` | [EpochTime](./EpochTime.md)<[UnitMillis](./UnitMillis.md)> | The timestamp when the statistics were reported in milliseconds since the epoch. | +| `timing_stats` | [MlTimingStats](./MlTimingStats.md) | An object containing time statistics about the data frame analytics job. | +| `validation_loss` | [MlValidationLoss](./MlValidationLoss.md) | An object containing information about validation loss. | diff --git a/docs/reference/api/MlDataframeAnalyticsStatsMemoryUsage.md b/docs/reference/api/MlDataframeAnalyticsStatsMemoryUsage.md new file mode 100644 index 000000000..ed355657c --- /dev/null +++ b/docs/reference/api/MlDataframeAnalyticsStatsMemoryUsage.md @@ -0,0 +1,8 @@ +## Interface `MlDataframeAnalyticsStatsMemoryUsage` + +| Name | Type | Description | +| - | - | - | +| `memory_reestimate_bytes` | [long](./long.md) | This value is present when the status is hard_limit and it is a new estimate of how much memory the job needs. | +| `peak_usage_bytes` | [long](./long.md) | The number of bytes used at the highest peak of memory usage. | +| `status` | string | The memory usage status. | +| `timestamp` | [EpochTime](./EpochTime.md)<[UnitMillis](./UnitMillis.md)> | The timestamp when memory usage was calculated. | diff --git a/docs/reference/api/MlDataframeAnalyticsStatsOutlierDetection.md b/docs/reference/api/MlDataframeAnalyticsStatsOutlierDetection.md new file mode 100644 index 000000000..3f89e0c7b --- /dev/null +++ b/docs/reference/api/MlDataframeAnalyticsStatsOutlierDetection.md @@ -0,0 +1,7 @@ +## Interface `MlDataframeAnalyticsStatsOutlierDetection` + +| Name | Type | Description | +| - | - | - | +| `parameters` | [MlOutlierDetectionParameters](./MlOutlierDetectionParameters.md) | The list of job parameters specified by the user or determined by algorithmic heuristics. | +| `timestamp` | [EpochTime](./EpochTime.md)<[UnitMillis](./UnitMillis.md)> | The timestamp when the statistics were reported in milliseconds since the epoch. | +| `timing_stats` | [MlTimingStats](./MlTimingStats.md) | An object containing time statistics about the data frame analytics job. | diff --git a/docs/reference/api/MlDataframeAnalyticsStatsProgress.md b/docs/reference/api/MlDataframeAnalyticsStatsProgress.md new file mode 100644 index 000000000..e649df98f --- /dev/null +++ b/docs/reference/api/MlDataframeAnalyticsStatsProgress.md @@ -0,0 +1,6 @@ +## Interface `MlDataframeAnalyticsStatsProgress` + +| Name | Type | Description | +| - | - | - | +| `phase` | string | Defines the phase of the data frame analytics job. | +| `progress_percent` | [integer](./integer.md) | The progress that the data frame analytics job has made expressed in percentage. | diff --git a/docs/reference/api/MlDataframeAnalyticsSummary.md b/docs/reference/api/MlDataframeAnalyticsSummary.md new file mode 100644 index 000000000..35dac0d52 --- /dev/null +++ b/docs/reference/api/MlDataframeAnalyticsSummary.md @@ -0,0 +1,17 @@ +## Interface `MlDataframeAnalyticsSummary` + +| Name | Type | Description | +| - | - | - | +| `_meta` | [Metadata](./Metadata.md) |   | +| `allow_lazy_start` | boolean |   | +| `analysis` | [MlDataframeAnalysisContainer](./MlDataframeAnalysisContainer.md) |   | +| `analyzed_fields` | [MlDataframeAnalysisAnalyzedFields](./MlDataframeAnalysisAnalyzedFields.md) | string[] |   | +| `authorization` | [MlDataframeAnalyticsAuthorization](./MlDataframeAnalyticsAuthorization.md) | The security privileges that the job uses to run its queries. If Elastic Stack security features were disabled at the time of the most recent update to the job, this property is omitted. | +| `create_time` | [EpochTime](./EpochTime.md)<[UnitMillis](./UnitMillis.md)> |   | +| `description` | string |   | +| `dest` | [MlDataframeAnalyticsDestination](./MlDataframeAnalyticsDestination.md) |   | +| `id` | [Id](./Id.md) |   | +| `max_num_threads` | [integer](./integer.md) |   | +| `model_memory_limit` | string |   | +| `source` | [MlDataframeAnalyticsSource](./MlDataframeAnalyticsSource.md) |   | +| `version` | [VersionString](./VersionString.md) |   | diff --git a/docs/reference/api/MlDataframeEvaluationClassification.md b/docs/reference/api/MlDataframeEvaluationClassification.md new file mode 100644 index 000000000..def9bc9d8 --- /dev/null +++ b/docs/reference/api/MlDataframeEvaluationClassification.md @@ -0,0 +1,8 @@ +## Interface `MlDataframeEvaluationClassification` + +| Name | Type | Description | +| - | - | - | +| `actual_field` | [Field](./Field.md) | The field of the index which contains the ground truth. The data type of this field can be boolean or integer. If the data type is integer, the value has to be either 0 (false) or 1 (true). | +| `metrics` | [MlDataframeEvaluationClassificationMetrics](./MlDataframeEvaluationClassificationMetrics.md) | Specifies the metrics that are used for the evaluation. | +| `predicted_field` | [Field](./Field.md) | The field in the index which contains the predicted value, in other words the results of the classification analysis. | +| `top_classes_field` | [Field](./Field.md) | The field of the index which is an array of documents of the form { "class_name": XXX, "class_probability": YYY } . This field must be defined as nested in the mappings. | diff --git a/docs/reference/api/MlDataframeEvaluationClassificationMetrics.md b/docs/reference/api/MlDataframeEvaluationClassificationMetrics.md new file mode 100644 index 000000000..7fcf33e82 --- /dev/null +++ b/docs/reference/api/MlDataframeEvaluationClassificationMetrics.md @@ -0,0 +1,6 @@ +## Interface `MlDataframeEvaluationClassificationMetrics` + +| Name | Type | Description | +| - | - | - | +| `accuracy` | Record | Accuracy of predictions (per-class and overall). | +| `multiclass_confusion_matrix` | Record | Multiclass confusion matrix. | diff --git a/docs/reference/api/MlDataframeEvaluationClassificationMetricsAucRoc.md b/docs/reference/api/MlDataframeEvaluationClassificationMetricsAucRoc.md new file mode 100644 index 000000000..0f6f33682 --- /dev/null +++ b/docs/reference/api/MlDataframeEvaluationClassificationMetricsAucRoc.md @@ -0,0 +1,6 @@ +## Interface `MlDataframeEvaluationClassificationMetricsAucRoc` + +| Name | Type | Description | +| - | - | - | +| `class_name` | [Name](./Name.md) | Name of the only class that is treated as positive during AUC ROC calculation. Other classes are treated as negative ("one-vs-all" strategy). All the evaluated documents must have class_name in the list of their top classes. | +| `include_curve` | boolean | Whether or not the curve should be returned in addition to the score. Default value is false. | diff --git a/docs/reference/api/MlDataframeEvaluationContainer.md b/docs/reference/api/MlDataframeEvaluationContainer.md new file mode 100644 index 000000000..64a3b89b6 --- /dev/null +++ b/docs/reference/api/MlDataframeEvaluationContainer.md @@ -0,0 +1,7 @@ +## Interface `MlDataframeEvaluationContainer` + +| Name | Type | Description | +| - | - | - | +| `classification` | [MlDataframeEvaluationClassification](./MlDataframeEvaluationClassification.md) | Classification evaluation evaluates the results of a classification analysis which outputs a prediction that identifies to which of the classes each document belongs. | +| `outlier_detection` | [MlDataframeEvaluationOutlierDetection](./MlDataframeEvaluationOutlierDetection.md) | Outlier detection evaluates the results of an outlier detection analysis which outputs the probability that each document is an outlier. | +| `regression` | [MlDataframeEvaluationRegression](./MlDataframeEvaluationRegression.md) | Regression evaluation evaluates the results of a regression analysis which outputs a prediction of values. | diff --git a/docs/reference/api/MlDataframeEvaluationMetrics.md b/docs/reference/api/MlDataframeEvaluationMetrics.md new file mode 100644 index 000000000..71bbee464 --- /dev/null +++ b/docs/reference/api/MlDataframeEvaluationMetrics.md @@ -0,0 +1,7 @@ +## Interface `MlDataframeEvaluationMetrics` + +| Name | Type | Description | +| - | - | - | +| `auc_roc` | [MlDataframeEvaluationClassificationMetricsAucRoc](./MlDataframeEvaluationClassificationMetricsAucRoc.md) | The AUC ROC (area under the curve of the receiver operating characteristic) score and optionally the curve. It is calculated for a specific class (provided as "class_name") treated as positive. | +| `precision` | Record | Precision of predictions (per-class and average). | +| `recall` | Record | Recall of predictions (per-class and average). | diff --git a/docs/reference/api/MlDataframeEvaluationOutlierDetection.md b/docs/reference/api/MlDataframeEvaluationOutlierDetection.md new file mode 100644 index 000000000..a0e6939e1 --- /dev/null +++ b/docs/reference/api/MlDataframeEvaluationOutlierDetection.md @@ -0,0 +1,7 @@ +## Interface `MlDataframeEvaluationOutlierDetection` + +| Name | Type | Description | +| - | - | - | +| `actual_field` | [Field](./Field.md) | The field of the index which contains the ground truth. The data type of this field can be boolean or integer. If the data type is integer, the value has to be either 0 (false) or 1 (true). | +| `metrics` | [MlDataframeEvaluationOutlierDetectionMetrics](./MlDataframeEvaluationOutlierDetectionMetrics.md) | Specifies the metrics that are used for the evaluation. | +| `predicted_probability_field` | [Field](./Field.md) | The field of the index that defines the probability of whether the item belongs to the class in question or not. It’s the field that contains the results of the analysis. | diff --git a/docs/reference/api/MlDataframeEvaluationOutlierDetectionMetrics.md b/docs/reference/api/MlDataframeEvaluationOutlierDetectionMetrics.md new file mode 100644 index 000000000..16f1656db --- /dev/null +++ b/docs/reference/api/MlDataframeEvaluationOutlierDetectionMetrics.md @@ -0,0 +1,5 @@ +## Interface `MlDataframeEvaluationOutlierDetectionMetrics` + +| Name | Type | Description | +| - | - | - | +| `confusion_matrix` | Record | Accuracy of predictions (per-class and overall). | diff --git a/docs/reference/api/MlDataframeEvaluationRegression.md b/docs/reference/api/MlDataframeEvaluationRegression.md new file mode 100644 index 000000000..8a16567a8 --- /dev/null +++ b/docs/reference/api/MlDataframeEvaluationRegression.md @@ -0,0 +1,7 @@ +## Interface `MlDataframeEvaluationRegression` + +| Name | Type | Description | +| - | - | - | +| `actual_field` | [Field](./Field.md) | The field of the index which contains the ground truth. The data type of this field must be numerical. | +| `metrics` | [MlDataframeEvaluationRegressionMetrics](./MlDataframeEvaluationRegressionMetrics.md) | Specifies the metrics that are used for the evaluation. For more information on mse, msle, and huber, consult the Jupyter notebook on regression loss functions. | +| `predicted_field` | [Field](./Field.md) | The field in the index that contains the predicted value, in other words the results of the regression analysis. | diff --git a/docs/reference/api/MlDataframeEvaluationRegressionMetrics.md b/docs/reference/api/MlDataframeEvaluationRegressionMetrics.md new file mode 100644 index 000000000..421b9c54c --- /dev/null +++ b/docs/reference/api/MlDataframeEvaluationRegressionMetrics.md @@ -0,0 +1,8 @@ +## Interface `MlDataframeEvaluationRegressionMetrics` + +| Name | Type | Description | +| - | - | - | +| `huber` | [MlDataframeEvaluationRegressionMetricsHuber](./MlDataframeEvaluationRegressionMetricsHuber.md) | Pseudo Huber loss function. | +| `mse` | Record | Average squared difference between the predicted values and the actual (ground truth) value. For more information, read this wiki article. | +| `msle` | [MlDataframeEvaluationRegressionMetricsMsle](./MlDataframeEvaluationRegressionMetricsMsle.md) | Average squared difference between the logarithm of the predicted values and the logarithm of the actual (ground truth) value. | +| `r_squared` | Record | Proportion of the variance in the dependent variable that is predictable from the independent variables. | diff --git a/docs/reference/api/MlDataframeEvaluationRegressionMetricsHuber.md b/docs/reference/api/MlDataframeEvaluationRegressionMetricsHuber.md new file mode 100644 index 000000000..041aeef18 --- /dev/null +++ b/docs/reference/api/MlDataframeEvaluationRegressionMetricsHuber.md @@ -0,0 +1,5 @@ +## Interface `MlDataframeEvaluationRegressionMetricsHuber` + +| Name | Type | Description | +| - | - | - | +| `delta` | [double](./double.md) | Approximates 1/2 (prediction - actual)2 for values much less than delta and approximates a straight line with slope delta for values much larger than delta. Defaults to 1. Delta needs to be greater than 0. | diff --git a/docs/reference/api/MlDataframeEvaluationRegressionMetricsMsle.md b/docs/reference/api/MlDataframeEvaluationRegressionMetricsMsle.md new file mode 100644 index 000000000..af34ca5f3 --- /dev/null +++ b/docs/reference/api/MlDataframeEvaluationRegressionMetricsMsle.md @@ -0,0 +1,5 @@ +## Interface `MlDataframeEvaluationRegressionMetricsMsle` + +| Name | Type | Description | +| - | - | - | +| `offset` | [double](./double.md) | Defines the transition point at which you switch from minimizing quadratic error to minimizing quadratic log error. Defaults to 1. | diff --git a/docs/reference/api/MlDataframeState.md b/docs/reference/api/MlDataframeState.md new file mode 100644 index 000000000..6dd5b7b6b --- /dev/null +++ b/docs/reference/api/MlDataframeState.md @@ -0,0 +1,4 @@ +## `MlDataframeState` +::: +type MlDataframeState = 'started' | 'stopped' | 'starting' | 'stopping' | 'failed'; +::: diff --git a/docs/reference/api/MlDelayedDataCheckConfig.md b/docs/reference/api/MlDelayedDataCheckConfig.md new file mode 100644 index 000000000..e78f04ef1 --- /dev/null +++ b/docs/reference/api/MlDelayedDataCheckConfig.md @@ -0,0 +1,6 @@ +## Interface `MlDelayedDataCheckConfig` + +| Name | Type | Description | +| - | - | - | +| `check_window` | [Duration](./Duration.md) | The window of time that is searched for late data. This window of time ends with the latest finalized bucket. It defaults to null, which causes an appropriate `check_window` to be calculated when the real-time datafeed runs. In particular, the default `check_window` span calculation is based on the maximum of `2h` or `8 * bucket_span`. | +| `enabled` | boolean | Specifies whether the datafeed periodically checks for delayed data. | diff --git a/docs/reference/api/MlDeleteCalendarEventRequest.md b/docs/reference/api/MlDeleteCalendarEventRequest.md new file mode 100644 index 000000000..2811eb080 --- /dev/null +++ b/docs/reference/api/MlDeleteCalendarEventRequest.md @@ -0,0 +1,8 @@ +## Interface `MlDeleteCalendarEventRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { calendar_id?: never; event_id?: never; }) | All values in `body` will be added to the request body. | +| `calendar_id` | [Id](./Id.md) | A string that uniquely identifies a calendar. | +| `event_id` | [Id](./Id.md) | Identifier for the scheduled event. You can obtain this identifier by using the get calendar events API. | +| `querystring` | { [key: string]: any; } & { calendar_id?: never; event_id?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/MlDeleteCalendarEventResponse.md b/docs/reference/api/MlDeleteCalendarEventResponse.md new file mode 100644 index 000000000..64dd3e72e --- /dev/null +++ b/docs/reference/api/MlDeleteCalendarEventResponse.md @@ -0,0 +1,4 @@ +## `MlDeleteCalendarEventResponse` +::: +type MlDeleteCalendarEventResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); +::: diff --git a/docs/reference/api/MlDeleteCalendarJobRequest.md b/docs/reference/api/MlDeleteCalendarJobRequest.md new file mode 100644 index 000000000..a3bee4051 --- /dev/null +++ b/docs/reference/api/MlDeleteCalendarJobRequest.md @@ -0,0 +1,8 @@ +## Interface `MlDeleteCalendarJobRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { calendar_id?: never; job_id?: never; }) | All values in `body` will be added to the request body. | +| `calendar_id` | [Id](./Id.md) | A string that uniquely identifies a calendar. | +| `job_id` | [Ids](./Ids.md) | An identifier for the anomaly detection jobs. It can be a job identifier, a group name, or a comma-separated list of jobs or groups. | +| `querystring` | { [key: string]: any; } & { calendar_id?: never; job_id?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/MlDeleteCalendarJobResponse.md b/docs/reference/api/MlDeleteCalendarJobResponse.md new file mode 100644 index 000000000..d337fa48c --- /dev/null +++ b/docs/reference/api/MlDeleteCalendarJobResponse.md @@ -0,0 +1,7 @@ +## Interface `MlDeleteCalendarJobResponse` + +| Name | Type | Description | +| - | - | - | +| `calendar_id` | [Id](./Id.md) | A string that uniquely identifies a calendar. | +| `description` | string | A description of the calendar. | +| `job_ids` | [Ids](./Ids.md) | A list of anomaly detection job identifiers or group names. | diff --git a/docs/reference/api/MlDeleteCalendarRequest.md b/docs/reference/api/MlDeleteCalendarRequest.md new file mode 100644 index 000000000..0abd52836 --- /dev/null +++ b/docs/reference/api/MlDeleteCalendarRequest.md @@ -0,0 +1,7 @@ +## Interface `MlDeleteCalendarRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { calendar_id?: never; }) | All values in `body` will be added to the request body. | +| `calendar_id` | [Id](./Id.md) | A string that uniquely identifies a calendar. | +| `querystring` | { [key: string]: any; } & { calendar_id?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/MlDeleteCalendarResponse.md b/docs/reference/api/MlDeleteCalendarResponse.md new file mode 100644 index 000000000..0191904ff --- /dev/null +++ b/docs/reference/api/MlDeleteCalendarResponse.md @@ -0,0 +1,4 @@ +## `MlDeleteCalendarResponse` +::: +type MlDeleteCalendarResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); +::: diff --git a/docs/reference/api/MlDeleteDataFrameAnalyticsRequest.md b/docs/reference/api/MlDeleteDataFrameAnalyticsRequest.md new file mode 100644 index 000000000..7d394dc83 --- /dev/null +++ b/docs/reference/api/MlDeleteDataFrameAnalyticsRequest.md @@ -0,0 +1,9 @@ +## Interface `MlDeleteDataFrameAnalyticsRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { id?: never; force?: never; timeout?: never; }) | All values in `body` will be added to the request body. | +| `force` | boolean | If `true`, it deletes a job that is not stopped; this method is quicker than stopping and deleting the job. | +| `id` | [Id](./Id.md) | Identifier for the data frame analytics job. | +| `querystring` | { [key: string]: any; } & { id?: never; force?: never; timeout?: never; } | All values in `querystring` will be added to the request querystring. | +| `timeout` | [Duration](./Duration.md) | The time to wait for the job to be deleted. | diff --git a/docs/reference/api/MlDeleteDataFrameAnalyticsResponse.md b/docs/reference/api/MlDeleteDataFrameAnalyticsResponse.md new file mode 100644 index 000000000..dfe5e5181 --- /dev/null +++ b/docs/reference/api/MlDeleteDataFrameAnalyticsResponse.md @@ -0,0 +1,4 @@ +## `MlDeleteDataFrameAnalyticsResponse` +::: +type MlDeleteDataFrameAnalyticsResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); +::: diff --git a/docs/reference/api/MlDeleteDatafeedRequest.md b/docs/reference/api/MlDeleteDatafeedRequest.md new file mode 100644 index 000000000..b3a128e0f --- /dev/null +++ b/docs/reference/api/MlDeleteDatafeedRequest.md @@ -0,0 +1,8 @@ +## Interface `MlDeleteDatafeedRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { datafeed_id?: never; force?: never; }) | All values in `body` will be added to the request body. | +| `datafeed_id` | [Id](./Id.md) | A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters. | +| `force` | boolean | Use to forcefully delete a started datafeed; this method is quicker than stopping and deleting the datafeed. | +| `querystring` | { [key: string]: any; } & { datafeed_id?: never; force?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/MlDeleteDatafeedResponse.md b/docs/reference/api/MlDeleteDatafeedResponse.md new file mode 100644 index 000000000..4bf44932d --- /dev/null +++ b/docs/reference/api/MlDeleteDatafeedResponse.md @@ -0,0 +1,4 @@ +## `MlDeleteDatafeedResponse` +::: +type MlDeleteDatafeedResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); +::: diff --git a/docs/reference/api/MlDeleteExpiredDataRequest.md b/docs/reference/api/MlDeleteExpiredDataRequest.md new file mode 100644 index 000000000..9b543f368 --- /dev/null +++ b/docs/reference/api/MlDeleteExpiredDataRequest.md @@ -0,0 +1,9 @@ +## Interface `MlDeleteExpiredDataRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { job_id?: never; requests_per_second?: never; timeout?: never; }) | All values in `body` will be added to the request body. | +| `job_id` | [Id](./Id.md) | Identifier for an anomaly detection job. It can be a job identifier, a group name, or a wildcard expression. | +| `querystring` | { [key: string]: any; } & { job_id?: never; requests_per_second?: never; timeout?: never; } | All values in `querystring` will be added to the request querystring. | +| `requests_per_second` | [float](./float.md) | The desired requests per second for the deletion processes. The default behavior is no throttling. | +| `timeout` | [Duration](./Duration.md) | How long can the underlying delete processes run until they are canceled. | diff --git a/docs/reference/api/MlDeleteExpiredDataResponse.md b/docs/reference/api/MlDeleteExpiredDataResponse.md new file mode 100644 index 000000000..96c38328e --- /dev/null +++ b/docs/reference/api/MlDeleteExpiredDataResponse.md @@ -0,0 +1,5 @@ +## Interface `MlDeleteExpiredDataResponse` + +| Name | Type | Description | +| - | - | - | +| `deleted` | boolean |   | diff --git a/docs/reference/api/MlDeleteFilterRequest.md b/docs/reference/api/MlDeleteFilterRequest.md new file mode 100644 index 000000000..59d768669 --- /dev/null +++ b/docs/reference/api/MlDeleteFilterRequest.md @@ -0,0 +1,7 @@ +## Interface `MlDeleteFilterRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { filter_id?: never; }) | All values in `body` will be added to the request body. | +| `filter_id` | [Id](./Id.md) | A string that uniquely identifies a filter. | +| `querystring` | { [key: string]: any; } & { filter_id?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/MlDeleteFilterResponse.md b/docs/reference/api/MlDeleteFilterResponse.md new file mode 100644 index 000000000..72b6e67d6 --- /dev/null +++ b/docs/reference/api/MlDeleteFilterResponse.md @@ -0,0 +1,4 @@ +## `MlDeleteFilterResponse` +::: +type MlDeleteFilterResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); +::: diff --git a/docs/reference/api/MlDeleteForecastRequest.md b/docs/reference/api/MlDeleteForecastRequest.md new file mode 100644 index 000000000..2ae4ccba0 --- /dev/null +++ b/docs/reference/api/MlDeleteForecastRequest.md @@ -0,0 +1,10 @@ +## Interface `MlDeleteForecastRequest` + +| Name | Type | Description | +| - | - | - | +| `allow_no_forecasts` | boolean | Specifies whether an error occurs when there are no forecasts. In particular, if this parameter is set to `false` and there are no forecasts associated with the job, attempts to delete all forecasts return an error. | +| `body` | string | ({ [key: string]: any; } & { job_id?: never; forecast_id?: never; allow_no_forecasts?: never; timeout?: never; }) | All values in `body` will be added to the request body. | +| `forecast_id` | [Id](./Id.md) | A comma-separated list of forecast identifiers. If you do not specify this optional parameter or if you specify `_all` or `*` the API deletes all forecasts from the job. | +| `job_id` | [Id](./Id.md) | Identifier for the anomaly detection job. | +| `querystring` | { [key: string]: any; } & { job_id?: never; forecast_id?: never; allow_no_forecasts?: never; timeout?: never; } | All values in `querystring` will be added to the request querystring. | +| `timeout` | [Duration](./Duration.md) | Specifies the period of time to wait for the completion of the delete operation. When this period of time elapses, the API fails and returns an error. | diff --git a/docs/reference/api/MlDeleteForecastResponse.md b/docs/reference/api/MlDeleteForecastResponse.md new file mode 100644 index 000000000..bac02c193 --- /dev/null +++ b/docs/reference/api/MlDeleteForecastResponse.md @@ -0,0 +1,4 @@ +## `MlDeleteForecastResponse` +::: +type MlDeleteForecastResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); +::: diff --git a/docs/reference/api/MlDeleteJobRequest.md b/docs/reference/api/MlDeleteJobRequest.md new file mode 100644 index 000000000..125e45974 --- /dev/null +++ b/docs/reference/api/MlDeleteJobRequest.md @@ -0,0 +1,10 @@ +## Interface `MlDeleteJobRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { job_id?: never; force?: never; delete_user_annotations?: never; wait_for_completion?: never; }) | All values in `body` will be added to the request body. | +| `delete_user_annotations` | boolean | Specifies whether annotations that have been added by the user should be deleted along with any auto-generated annotations when the job is reset. | +| `force` | boolean | Use to forcefully delete an opened job; this method is quicker than closing and deleting the job. | +| `job_id` | [Id](./Id.md) | Identifier for the anomaly detection job. | +| `querystring` | { [key: string]: any; } & { job_id?: never; force?: never; delete_user_annotations?: never; wait_for_completion?: never; } | All values in `querystring` will be added to the request querystring. | +| `wait_for_completion` | boolean | Specifies whether the request should return immediately or wait until the job deletion completes. | diff --git a/docs/reference/api/MlDeleteJobResponse.md b/docs/reference/api/MlDeleteJobResponse.md new file mode 100644 index 000000000..ba60c21b3 --- /dev/null +++ b/docs/reference/api/MlDeleteJobResponse.md @@ -0,0 +1,4 @@ +## `MlDeleteJobResponse` +::: +type MlDeleteJobResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); +::: diff --git a/docs/reference/api/MlDeleteModelSnapshotRequest.md b/docs/reference/api/MlDeleteModelSnapshotRequest.md new file mode 100644 index 000000000..c61a8b540 --- /dev/null +++ b/docs/reference/api/MlDeleteModelSnapshotRequest.md @@ -0,0 +1,8 @@ +## Interface `MlDeleteModelSnapshotRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { job_id?: never; snapshot_id?: never; }) | All values in `body` will be added to the request body. | +| `job_id` | [Id](./Id.md) | Identifier for the anomaly detection job. | +| `querystring` | { [key: string]: any; } & { job_id?: never; snapshot_id?: never; } | All values in `querystring` will be added to the request querystring. | +| `snapshot_id` | [Id](./Id.md) | Identifier for the model snapshot. | diff --git a/docs/reference/api/MlDeleteModelSnapshotResponse.md b/docs/reference/api/MlDeleteModelSnapshotResponse.md new file mode 100644 index 000000000..b86e6e703 --- /dev/null +++ b/docs/reference/api/MlDeleteModelSnapshotResponse.md @@ -0,0 +1,4 @@ +## `MlDeleteModelSnapshotResponse` +::: +type MlDeleteModelSnapshotResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); +::: diff --git a/docs/reference/api/MlDeleteTrainedModelAliasRequest.md b/docs/reference/api/MlDeleteTrainedModelAliasRequest.md new file mode 100644 index 000000000..4e4c1e209 --- /dev/null +++ b/docs/reference/api/MlDeleteTrainedModelAliasRequest.md @@ -0,0 +1,8 @@ +## Interface `MlDeleteTrainedModelAliasRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { model_alias?: never; model_id?: never; }) | All values in `body` will be added to the request body. | +| `model_alias` | [Name](./Name.md) | The model alias to delete. | +| `model_id` | [Id](./Id.md) | The trained model ID to which the model alias refers. | +| `querystring` | { [key: string]: any; } & { model_alias?: never; model_id?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/MlDeleteTrainedModelAliasResponse.md b/docs/reference/api/MlDeleteTrainedModelAliasResponse.md new file mode 100644 index 000000000..0e7b4465f --- /dev/null +++ b/docs/reference/api/MlDeleteTrainedModelAliasResponse.md @@ -0,0 +1,4 @@ +## `MlDeleteTrainedModelAliasResponse` +::: +type MlDeleteTrainedModelAliasResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); +::: diff --git a/docs/reference/api/MlDeleteTrainedModelRequest.md b/docs/reference/api/MlDeleteTrainedModelRequest.md new file mode 100644 index 000000000..c4d9b2267 --- /dev/null +++ b/docs/reference/api/MlDeleteTrainedModelRequest.md @@ -0,0 +1,9 @@ +## Interface `MlDeleteTrainedModelRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { model_id?: never; force?: never; timeout?: never; }) | All values in `body` will be added to the request body. | +| `force` | boolean | Forcefully deletes a trained model that is referenced by ingest pipelines or has a started deployment. | +| `model_id` | [Id](./Id.md) | The unique identifier of the trained model. | +| `querystring` | { [key: string]: any; } & { model_id?: never; force?: never; timeout?: never; } | All values in `querystring` will be added to the request querystring. | +| `timeout` | [Duration](./Duration.md) | Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. | diff --git a/docs/reference/api/MlDeleteTrainedModelResponse.md b/docs/reference/api/MlDeleteTrainedModelResponse.md new file mode 100644 index 000000000..88b34bf50 --- /dev/null +++ b/docs/reference/api/MlDeleteTrainedModelResponse.md @@ -0,0 +1,4 @@ +## `MlDeleteTrainedModelResponse` +::: +type MlDeleteTrainedModelResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); +::: diff --git a/docs/reference/api/MlDeploymentAllocationState.md b/docs/reference/api/MlDeploymentAllocationState.md new file mode 100644 index 000000000..f0a3eaf8a --- /dev/null +++ b/docs/reference/api/MlDeploymentAllocationState.md @@ -0,0 +1,4 @@ +## `MlDeploymentAllocationState` +::: +type MlDeploymentAllocationState = 'started' | 'starting' | 'fully_allocated'; +::: diff --git a/docs/reference/api/MlDeploymentAssignmentState.md b/docs/reference/api/MlDeploymentAssignmentState.md new file mode 100644 index 000000000..5e09b81bd --- /dev/null +++ b/docs/reference/api/MlDeploymentAssignmentState.md @@ -0,0 +1,4 @@ +## `MlDeploymentAssignmentState` +::: +type MlDeploymentAssignmentState = 'started' | 'starting' | 'stopping' | 'failed'; +::: diff --git a/docs/reference/api/MlDetectionRule.md b/docs/reference/api/MlDetectionRule.md new file mode 100644 index 000000000..1fb085f94 --- /dev/null +++ b/docs/reference/api/MlDetectionRule.md @@ -0,0 +1,7 @@ +## Interface `MlDetectionRule` + +| Name | Type | Description | +| - | - | - | +| `actions` | [MlRuleAction](./MlRuleAction.md)[] | The set of actions to be triggered when the rule applies. If more than one action is specified the effects of all actions are combined. | +| `conditions` | [MlRuleCondition](./MlRuleCondition.md)[] | An array of numeric conditions when the rule applies. A rule must either have a non-empty scope or at least one condition. Multiple conditions are combined together with a logical AND. | +| `scope` | Record<[Field](./Field.md), [MlFilterRef](./MlFilterRef.md)> | A scope of series where the rule applies. A rule must either have a non-empty scope or at least one condition. By default, the scope includes all series. Scoping is allowed for any of the fields that are also specified in `by_field_name`, `over_field_name`, or `partition_field_name`. | diff --git a/docs/reference/api/MlDetector.md b/docs/reference/api/MlDetector.md new file mode 100644 index 000000000..07eeffd72 --- /dev/null +++ b/docs/reference/api/MlDetector.md @@ -0,0 +1,14 @@ +## Interface `MlDetector` + +| Name | Type | Description | +| - | - | - | +| `by_field_name` | [Field](./Field.md) | The field used to split the data. In particular, this property is used for analyzing the splits with respect to their own history. It is used for finding unusual values in the context of the split. | +| `custom_rules` | [MlDetectionRule](./MlDetectionRule.md)[] | Custom rules enable you to customize the way detectors operate. For example, a rule may dictate conditions under which results should be skipped. Kibana refers to custom rules as job rules. | +| `detector_description` | string | A description of the detector. | +| `detector_index` | [integer](./integer.md) | A unique identifier for the detector. This identifier is based on the order of the detectors in the `analysis_config`, starting at zero. If you specify a value for this property, it is ignored. | +| `exclude_frequent` | [MlExcludeFrequent](./MlExcludeFrequent.md) | If set, frequent entities are excluded from influencing the anomaly results. Entities can be considered frequent over time or frequent in a population. If you are working with both over and by fields, you can set `exclude_frequent` to `all` for both fields, or to `by` or `over` for those specific fields. | +| `field_name` | [Field](./Field.md) | The field that the detector uses in the function. If you use an event rate function such as count or rare, do not specify this field. The `field_name` cannot contain double quotes or backslashes. | +| `function` | string | The analysis function that is used. For example, `count`, `rare`, `mean`, `min`, `max`, or `sum`. | +| `over_field_name` | [Field](./Field.md) | The field used to split the data. In particular, this property is used for analyzing the splits with respect to the history of all splits. It is used for finding unusual values in the population of all splits. | +| `partition_field_name` | [Field](./Field.md) | The field used to segment the analysis. When you use this property, you have completely independent baselines for each value of this field. | +| `use_null` | boolean | Defines whether a new series is used as the null series when there is no value for the by or partition fields. | diff --git a/docs/reference/api/MlDetectorRead.md b/docs/reference/api/MlDetectorRead.md new file mode 100644 index 000000000..57b7b3bf0 --- /dev/null +++ b/docs/reference/api/MlDetectorRead.md @@ -0,0 +1,14 @@ +## Interface `MlDetectorRead` + +| Name | Type | Description | +| - | - | - | +| `by_field_name` | [Field](./Field.md) | The field used to split the data. In particular, this property is used for analyzing the splits with respect to their own history. It is used for finding unusual values in the context of the split. | +| `custom_rules` | [MlDetectionRule](./MlDetectionRule.md)[] | An array of custom rule objects, which enable you to customize the way detectors operate. For example, a rule may dictate to the detector conditions under which results should be skipped. Kibana refers to custom rules as job rules. | +| `detector_description` | string | A description of the detector. | +| `detector_index` | [integer](./integer.md) | A unique identifier for the detector. This identifier is based on the order of the detectors in the `analysis_config`, starting at zero. | +| `exclude_frequent` | [MlExcludeFrequent](./MlExcludeFrequent.md) | Contains one of the following values: `all`, `none`, `by`, or `over`. If set, frequent entities are excluded from influencing the anomaly results. Entities can be considered frequent over time or frequent in a population. If you are working with both over and by fields, then you can set `exclude_frequent` to all for both fields, or to `by` or `over` for those specific fields. | +| `field_name` | [Field](./Field.md) | The field that the detector uses in the function. If you use an event rate function such as `count` or `rare`, do not specify this field. | +| `function` | string | The analysis function that is used. For example, `count`, `rare`, `mean`, `min`, `max`, and `sum`. | +| `over_field_name` | [Field](./Field.md) | The field used to split the data. In particular, this property is used for analyzing the splits with respect to the history of all splits. It is used for finding unusual values in the population of all splits. | +| `partition_field_name` | [Field](./Field.md) | The field used to segment the analysis. When you use this property, you have completely independent baselines for each value of this field. | +| `use_null` | boolean | Defines whether a new series is used as the null series when there is no value for the by or partition fields. | diff --git a/docs/reference/api/MlDetectorUpdate.md b/docs/reference/api/MlDetectorUpdate.md new file mode 100644 index 000000000..017dc2cee --- /dev/null +++ b/docs/reference/api/MlDetectorUpdate.md @@ -0,0 +1,7 @@ +## Interface `MlDetectorUpdate` + +| Name | Type | Description | +| - | - | - | +| `custom_rules` | [MlDetectionRule](./MlDetectionRule.md)[] | An array of custom rule objects, which enable you to customize the way detectors operate. For example, a rule may dictate to the detector conditions under which results should be skipped. Kibana refers to custom rules as job rules. | +| `description` | string | A description of the detector. | +| `detector_index` | [integer](./integer.md) | A unique identifier for the detector. This identifier is based on the order of the detectors in the `analysis_config`, starting at zero. | diff --git a/docs/reference/api/MlDiscoveryNode.md b/docs/reference/api/MlDiscoveryNode.md new file mode 100644 index 000000000..5bd943d7d --- /dev/null +++ b/docs/reference/api/MlDiscoveryNode.md @@ -0,0 +1,4 @@ +## `MlDiscoveryNode` +::: +type MlDiscoveryNode = [Partial](./Partial.md)>; +::: diff --git a/docs/reference/api/MlDiscoveryNodeCompact.md b/docs/reference/api/MlDiscoveryNodeCompact.md new file mode 100644 index 000000000..9865910d3 --- /dev/null +++ b/docs/reference/api/MlDiscoveryNodeCompact.md @@ -0,0 +1,9 @@ +## Interface `MlDiscoveryNodeCompact` + +| Name | Type | Description | +| - | - | - | +| `attributes` | Record |   | +| `ephemeral_id` | [Id](./Id.md) |   | +| `id` | [Id](./Id.md) |   | +| `name` | [Name](./Name.md) |   | +| `transport_address` | [TransportAddress](./TransportAddress.md) |   | diff --git a/docs/reference/api/MlDiscoveryNodeContent.md b/docs/reference/api/MlDiscoveryNodeContent.md new file mode 100644 index 000000000..3848971fb --- /dev/null +++ b/docs/reference/api/MlDiscoveryNodeContent.md @@ -0,0 +1,13 @@ +## Interface `MlDiscoveryNodeContent` + +| Name | Type | Description | +| - | - | - | +| `attributes` | Record |   | +| `ephemeral_id` | [Id](./Id.md) |   | +| `external_id` | string |   | +| `max_index_version` | [integer](./integer.md) |   | +| `min_index_version` | [integer](./integer.md) |   | +| `name` | [Name](./Name.md) |   | +| `roles` | string[] |   | +| `transport_address` | [TransportAddress](./TransportAddress.md) |   | +| `version` | [VersionString](./VersionString.md) |   | diff --git a/docs/reference/api/MlEstimateModelMemoryRequest.md b/docs/reference/api/MlEstimateModelMemoryRequest.md new file mode 100644 index 000000000..7c7af659d --- /dev/null +++ b/docs/reference/api/MlEstimateModelMemoryRequest.md @@ -0,0 +1,9 @@ +## Interface `MlEstimateModelMemoryRequest` + +| Name | Type | Description | +| - | - | - | +| `analysis_config` | [MlAnalysisConfig](./MlAnalysisConfig.md) | For a list of the properties that you can specify in the `analysis_config` component of the body of this API. | +| `body` | string | ({ [key: string]: any; } & { analysis_config?: never; max_bucket_cardinality?: never; overall_cardinality?: never; }) | All values in `body` will be added to the request body. | +| `max_bucket_cardinality` | Record<[Field](./Field.md), [long](./long.md)> | Estimates of the highest cardinality in a single bucket that is observed for influencer fields over the time period that the job analyzes data. To produce a good answer, values must be provided for all influencer fields. Providing values for fields that are not listed as `influencers` has no effect on the estimation. | +| `overall_cardinality` | Record<[Field](./Field.md), [long](./long.md)> | Estimates of the cardinality that is observed for fields over the whole time period that the job analyzes data. To produce a good answer, values must be provided for fields referenced in the `by_field_name`, `over_field_name` and `partition_field_name` of any detectors. Providing values for other fields has no effect on the estimation. It can be omitted from the request if no detectors have a `by_field_name`, `over_field_name` or `partition_field_name`. | +| `querystring` | { [key: string]: any; } & { analysis_config?: never; max_bucket_cardinality?: never; overall_cardinality?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/MlEstimateModelMemoryResponse.md b/docs/reference/api/MlEstimateModelMemoryResponse.md new file mode 100644 index 000000000..bf9526ebc --- /dev/null +++ b/docs/reference/api/MlEstimateModelMemoryResponse.md @@ -0,0 +1,5 @@ +## Interface `MlEstimateModelMemoryResponse` + +| Name | Type | Description | +| - | - | - | +| `model_memory_estimate` | string |   | diff --git a/docs/reference/api/MlEvaluateDataFrameConfusionMatrixItem.md b/docs/reference/api/MlEvaluateDataFrameConfusionMatrixItem.md new file mode 100644 index 000000000..b8906a47c --- /dev/null +++ b/docs/reference/api/MlEvaluateDataFrameConfusionMatrixItem.md @@ -0,0 +1,8 @@ +## Interface `MlEvaluateDataFrameConfusionMatrixItem` + +| Name | Type | Description | +| - | - | - | +| `actual_class_doc_count` | [integer](./integer.md) |   | +| `actual_class` | [Name](./Name.md) |   | +| `other_predicted_class_doc_count` | [integer](./integer.md) |   | +| `predicted_classes` | [MlEvaluateDataFrameConfusionMatrixPrediction](./MlEvaluateDataFrameConfusionMatrixPrediction.md)[] |   | diff --git a/docs/reference/api/MlEvaluateDataFrameConfusionMatrixPrediction.md b/docs/reference/api/MlEvaluateDataFrameConfusionMatrixPrediction.md new file mode 100644 index 000000000..de7400e2d --- /dev/null +++ b/docs/reference/api/MlEvaluateDataFrameConfusionMatrixPrediction.md @@ -0,0 +1,6 @@ +## Interface `MlEvaluateDataFrameConfusionMatrixPrediction` + +| Name | Type | Description | +| - | - | - | +| `count` | [integer](./integer.md) |   | +| `predicted_class` | [Name](./Name.md) |   | diff --git a/docs/reference/api/MlEvaluateDataFrameConfusionMatrixThreshold.md b/docs/reference/api/MlEvaluateDataFrameConfusionMatrixThreshold.md new file mode 100644 index 000000000..c06d763d6 --- /dev/null +++ b/docs/reference/api/MlEvaluateDataFrameConfusionMatrixThreshold.md @@ -0,0 +1,8 @@ +## Interface `MlEvaluateDataFrameConfusionMatrixThreshold` + +| Name | Type | Description | +| - | - | - | +| `fn` | [integer](./integer.md) | False Negative | +| `fp` | [integer](./integer.md) | False Positive | +| `tn` | [integer](./integer.md) | True Negative | +| `tp` | [integer](./integer.md) | True Positive | diff --git a/docs/reference/api/MlEvaluateDataFrameDataframeClassificationSummary.md b/docs/reference/api/MlEvaluateDataFrameDataframeClassificationSummary.md new file mode 100644 index 000000000..313b8b11c --- /dev/null +++ b/docs/reference/api/MlEvaluateDataFrameDataframeClassificationSummary.md @@ -0,0 +1,9 @@ +## Interface `MlEvaluateDataFrameDataframeClassificationSummary` + +| Name | Type | Description | +| - | - | - | +| `accuracy` | [MlEvaluateDataFrameDataframeClassificationSummaryAccuracy](./MlEvaluateDataFrameDataframeClassificationSummaryAccuracy.md) | Accuracy of predictions (per-class and overall). | +| `auc_roc` | [MlEvaluateDataFrameDataframeEvaluationSummaryAucRoc](./MlEvaluateDataFrameDataframeEvaluationSummaryAucRoc.md) | The AUC ROC (area under the curve of the receiver operating characteristic) score and optionally the curve. It is calculated for a specific class (provided as "class_name") treated as positive. | +| `multiclass_confusion_matrix` | [MlEvaluateDataFrameDataframeClassificationSummaryMulticlassConfusionMatrix](./MlEvaluateDataFrameDataframeClassificationSummaryMulticlassConfusionMatrix.md) | Multiclass confusion matrix. | +| `precision` | [MlEvaluateDataFrameDataframeClassificationSummaryPrecision](./MlEvaluateDataFrameDataframeClassificationSummaryPrecision.md) | Precision of predictions (per-class and average). | +| `recall` | [MlEvaluateDataFrameDataframeClassificationSummaryRecall](./MlEvaluateDataFrameDataframeClassificationSummaryRecall.md) | Recall of predictions (per-class and average). | diff --git a/docs/reference/api/MlEvaluateDataFrameDataframeClassificationSummaryAccuracy.md b/docs/reference/api/MlEvaluateDataFrameDataframeClassificationSummaryAccuracy.md new file mode 100644 index 000000000..c3f88829d --- /dev/null +++ b/docs/reference/api/MlEvaluateDataFrameDataframeClassificationSummaryAccuracy.md @@ -0,0 +1,6 @@ +## Interface `MlEvaluateDataFrameDataframeClassificationSummaryAccuracy` + +| Name | Type | Description | +| - | - | - | +| `classes` | [MlEvaluateDataFrameDataframeEvaluationClass](./MlEvaluateDataFrameDataframeEvaluationClass.md)[] |   | +| `overall_accuracy` | [double](./double.md) |   | diff --git a/docs/reference/api/MlEvaluateDataFrameDataframeClassificationSummaryMulticlassConfusionMatrix.md b/docs/reference/api/MlEvaluateDataFrameDataframeClassificationSummaryMulticlassConfusionMatrix.md new file mode 100644 index 000000000..bc71b832f --- /dev/null +++ b/docs/reference/api/MlEvaluateDataFrameDataframeClassificationSummaryMulticlassConfusionMatrix.md @@ -0,0 +1,6 @@ +## Interface `MlEvaluateDataFrameDataframeClassificationSummaryMulticlassConfusionMatrix` + +| Name | Type | Description | +| - | - | - | +| `confusion_matrix` | [MlEvaluateDataFrameConfusionMatrixItem](./MlEvaluateDataFrameConfusionMatrixItem.md)[] |   | +| `other_actual_class_count` | [integer](./integer.md) |   | diff --git a/docs/reference/api/MlEvaluateDataFrameDataframeClassificationSummaryPrecision.md b/docs/reference/api/MlEvaluateDataFrameDataframeClassificationSummaryPrecision.md new file mode 100644 index 000000000..0f9adf8c1 --- /dev/null +++ b/docs/reference/api/MlEvaluateDataFrameDataframeClassificationSummaryPrecision.md @@ -0,0 +1,6 @@ +## Interface `MlEvaluateDataFrameDataframeClassificationSummaryPrecision` + +| Name | Type | Description | +| - | - | - | +| `avg_precision` | [double](./double.md) |   | +| `classes` | [MlEvaluateDataFrameDataframeEvaluationClass](./MlEvaluateDataFrameDataframeEvaluationClass.md)[] |   | diff --git a/docs/reference/api/MlEvaluateDataFrameDataframeClassificationSummaryRecall.md b/docs/reference/api/MlEvaluateDataFrameDataframeClassificationSummaryRecall.md new file mode 100644 index 000000000..0c29aff0c --- /dev/null +++ b/docs/reference/api/MlEvaluateDataFrameDataframeClassificationSummaryRecall.md @@ -0,0 +1,6 @@ +## Interface `MlEvaluateDataFrameDataframeClassificationSummaryRecall` + +| Name | Type | Description | +| - | - | - | +| `avg_recall` | [double](./double.md) |   | +| `classes` | [MlEvaluateDataFrameDataframeEvaluationClass](./MlEvaluateDataFrameDataframeEvaluationClass.md)[] |   | diff --git a/docs/reference/api/MlEvaluateDataFrameDataframeEvaluationClass.md b/docs/reference/api/MlEvaluateDataFrameDataframeEvaluationClass.md new file mode 100644 index 000000000..4f5ba990c --- /dev/null +++ b/docs/reference/api/MlEvaluateDataFrameDataframeEvaluationClass.md @@ -0,0 +1,5 @@ +## Interface `MlEvaluateDataFrameDataframeEvaluationClass` + +| Name | Type | Description | +| - | - | - | +| `class_name` | [Name](./Name.md) |   | diff --git a/docs/reference/api/MlEvaluateDataFrameDataframeEvaluationSummaryAucRoc.md b/docs/reference/api/MlEvaluateDataFrameDataframeEvaluationSummaryAucRoc.md new file mode 100644 index 000000000..7a41812aa --- /dev/null +++ b/docs/reference/api/MlEvaluateDataFrameDataframeEvaluationSummaryAucRoc.md @@ -0,0 +1,5 @@ +## Interface `MlEvaluateDataFrameDataframeEvaluationSummaryAucRoc` + +| Name | Type | Description | +| - | - | - | +| `curve` | [MlEvaluateDataFrameDataframeEvaluationSummaryAucRocCurveItem](./MlEvaluateDataFrameDataframeEvaluationSummaryAucRocCurveItem.md)[] |   | diff --git a/docs/reference/api/MlEvaluateDataFrameDataframeEvaluationSummaryAucRocCurveItem.md b/docs/reference/api/MlEvaluateDataFrameDataframeEvaluationSummaryAucRocCurveItem.md new file mode 100644 index 000000000..f5401d9c2 --- /dev/null +++ b/docs/reference/api/MlEvaluateDataFrameDataframeEvaluationSummaryAucRocCurveItem.md @@ -0,0 +1,7 @@ +## Interface `MlEvaluateDataFrameDataframeEvaluationSummaryAucRocCurveItem` + +| Name | Type | Description | +| - | - | - | +| `fpr` | [double](./double.md) |   | +| `threshold` | [double](./double.md) |   | +| `tpr` | [double](./double.md) |   | diff --git a/docs/reference/api/MlEvaluateDataFrameDataframeEvaluationValue.md b/docs/reference/api/MlEvaluateDataFrameDataframeEvaluationValue.md new file mode 100644 index 000000000..d314aa0b8 --- /dev/null +++ b/docs/reference/api/MlEvaluateDataFrameDataframeEvaluationValue.md @@ -0,0 +1,5 @@ +## Interface `MlEvaluateDataFrameDataframeEvaluationValue` + +| Name | Type | Description | +| - | - | - | +| `value` | [double](./double.md) |   | diff --git a/docs/reference/api/MlEvaluateDataFrameDataframeOutlierDetectionSummary.md b/docs/reference/api/MlEvaluateDataFrameDataframeOutlierDetectionSummary.md new file mode 100644 index 000000000..7c137c674 --- /dev/null +++ b/docs/reference/api/MlEvaluateDataFrameDataframeOutlierDetectionSummary.md @@ -0,0 +1,8 @@ +## Interface `MlEvaluateDataFrameDataframeOutlierDetectionSummary` + +| Name | Type | Description | +| - | - | - | +| `auc_roc` | [MlEvaluateDataFrameDataframeEvaluationSummaryAucRoc](./MlEvaluateDataFrameDataframeEvaluationSummaryAucRoc.md) | The AUC ROC (area under the curve of the receiver operating characteristic) score and optionally the curve. | +| `confusion_matrix` | Record | Set the different thresholds of the outlier score at where the metrics ( `tp` - true positive, `fp` - false positive, `tn` - true negative, `fn` - false negative) are calculated. | +| `precision` | Record | Set the different thresholds of the outlier score at where the metric is calculated. | +| `recall` | Record | Set the different thresholds of the outlier score at where the metric is calculated. | diff --git a/docs/reference/api/MlEvaluateDataFrameDataframeRegressionSummary.md b/docs/reference/api/MlEvaluateDataFrameDataframeRegressionSummary.md new file mode 100644 index 000000000..76b215768 --- /dev/null +++ b/docs/reference/api/MlEvaluateDataFrameDataframeRegressionSummary.md @@ -0,0 +1,8 @@ +## Interface `MlEvaluateDataFrameDataframeRegressionSummary` + +| Name | Type | Description | +| - | - | - | +| `huber` | [MlEvaluateDataFrameDataframeEvaluationValue](./MlEvaluateDataFrameDataframeEvaluationValue.md) | Pseudo Huber loss function. | +| `mse` | [MlEvaluateDataFrameDataframeEvaluationValue](./MlEvaluateDataFrameDataframeEvaluationValue.md) | Average squared difference between the predicted values and the actual ( `ground truth`) value. | +| `msle` | [MlEvaluateDataFrameDataframeEvaluationValue](./MlEvaluateDataFrameDataframeEvaluationValue.md) | Average squared difference between the logarithm of the predicted values and the logarithm of the actual ( `ground truth`) value. | +| `r_squared` | [MlEvaluateDataFrameDataframeEvaluationValue](./MlEvaluateDataFrameDataframeEvaluationValue.md) | Proportion of the variance in the dependent variable that is predictable from the independent variables. | diff --git a/docs/reference/api/MlEvaluateDataFrameRequest.md b/docs/reference/api/MlEvaluateDataFrameRequest.md new file mode 100644 index 000000000..3f2e4d8c2 --- /dev/null +++ b/docs/reference/api/MlEvaluateDataFrameRequest.md @@ -0,0 +1,9 @@ +## Interface `MlEvaluateDataFrameRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { evaluation?: never; index?: never; query?: never; }) | All values in `body` will be added to the request body. | +| `evaluation` | [MlDataframeEvaluationContainer](./MlDataframeEvaluationContainer.md) | Defines the type of evaluation you want to perform. | +| `index` | [IndexName](./IndexName.md) | Defines the `index` in which the evaluation will be performed. | +| `query` | [QueryDslQueryContainer](./QueryDslQueryContainer.md) | A query clause that retrieves a subset of data from the source index. | +| `querystring` | { [key: string]: any; } & { evaluation?: never; index?: never; query?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/MlEvaluateDataFrameResponse.md b/docs/reference/api/MlEvaluateDataFrameResponse.md new file mode 100644 index 000000000..9e0cc007c --- /dev/null +++ b/docs/reference/api/MlEvaluateDataFrameResponse.md @@ -0,0 +1,7 @@ +## Interface `MlEvaluateDataFrameResponse` + +| Name | Type | Description | +| - | - | - | +| `classification` | [MlEvaluateDataFrameDataframeClassificationSummary](./MlEvaluateDataFrameDataframeClassificationSummary.md) | Evaluation results for a classification analysis. It outputs a prediction that identifies to which of the classes each document belongs. | +| `outlier_detection` | [MlEvaluateDataFrameDataframeOutlierDetectionSummary](./MlEvaluateDataFrameDataframeOutlierDetectionSummary.md) | Evaluation results for an outlier detection analysis. It outputs the probability that each document is an outlier. | +| `regression` | [MlEvaluateDataFrameDataframeRegressionSummary](./MlEvaluateDataFrameDataframeRegressionSummary.md) | Evaluation results for a regression analysis which outputs a prediction of values. | diff --git a/docs/reference/api/MlExcludeFrequent.md b/docs/reference/api/MlExcludeFrequent.md new file mode 100644 index 000000000..915b6d90d --- /dev/null +++ b/docs/reference/api/MlExcludeFrequent.md @@ -0,0 +1,4 @@ +## `MlExcludeFrequent` +::: +type MlExcludeFrequent = 'all' | 'none' | 'by' | 'over'; +::: diff --git a/docs/reference/api/MlExplainDataFrameAnalyticsRequest.md b/docs/reference/api/MlExplainDataFrameAnalyticsRequest.md new file mode 100644 index 000000000..d18cb0287 --- /dev/null +++ b/docs/reference/api/MlExplainDataFrameAnalyticsRequest.md @@ -0,0 +1,15 @@ +## Interface `MlExplainDataFrameAnalyticsRequest` + +| Name | Type | Description | +| - | - | - | +| `allow_lazy_start` | boolean | Specifies whether this job can start when there is insufficient machine learning node capacity for it to be immediately assigned to a node. | +| `analysis` | [MlDataframeAnalysisContainer](./MlDataframeAnalysisContainer.md) | The analysis configuration, which contains the information necessary to perform one of the following types of analysis: classification, outlier detection, or regression. | +| `analyzed_fields` | [MlDataframeAnalysisAnalyzedFields](./MlDataframeAnalysisAnalyzedFields.md) | string[] | Specify includes and/or excludes patterns to select which fields will be included in the analysis. The patterns specified in excludes are applied last, therefore excludes takes precedence. In other words, if the same field is specified in both includes and excludes, then the field will not be included in the analysis. | +| `body` | string | ({ [key: string]: any; } & { id?: never; source?: never; dest?: never; analysis?: never; description?: never; model_memory_limit?: never; max_num_threads?: never; analyzed_fields?: never; allow_lazy_start?: never; }) | All values in `body` will be added to the request body. | +| `description` | string | A description of the job. | +| `dest` | [MlDataframeAnalyticsDestination](./MlDataframeAnalyticsDestination.md) | The destination configuration, consisting of index and optionally results_field (ml by default). | +| `id` | [Id](./Id.md) | Identifier for the data frame analytics job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters. | +| `max_num_threads` | [integer](./integer.md) | The maximum number of threads to be used by the analysis. Using more threads may decrease the time necessary to complete the analysis at the cost of using more CPU. Note that the process may use additional threads for operational functionality other than the analysis itself. | +| `model_memory_limit` | string | The approximate maximum amount of memory resources that are permitted for analytical processing. If your `elasticsearch.yml` file contains an `xpack.ml.max_model_memory_limit` setting, an error occurs when you try to create data frame analytics jobs that have `model_memory_limit` values greater than that setting. | +| `querystring` | { [key: string]: any; } & { id?: never; source?: never; dest?: never; analysis?: never; description?: never; model_memory_limit?: never; max_num_threads?: never; analyzed_fields?: never; allow_lazy_start?: never; } | All values in `querystring` will be added to the request querystring. | +| `source` | [MlDataframeAnalyticsSource](./MlDataframeAnalyticsSource.md) | The configuration of how to source the analysis data. It requires an index. Optionally, query and _source may be specified. | diff --git a/docs/reference/api/MlExplainDataFrameAnalyticsResponse.md b/docs/reference/api/MlExplainDataFrameAnalyticsResponse.md new file mode 100644 index 000000000..b40cc833f --- /dev/null +++ b/docs/reference/api/MlExplainDataFrameAnalyticsResponse.md @@ -0,0 +1,6 @@ +## Interface `MlExplainDataFrameAnalyticsResponse` + +| Name | Type | Description | +| - | - | - | +| `field_selection` | [MlDataframeAnalyticsFieldSelection](./MlDataframeAnalyticsFieldSelection.md)[] | An array of objects that explain selection for each field, sorted by the field names. | +| `memory_estimation` | [MlDataframeAnalyticsMemoryEstimation](./MlDataframeAnalyticsMemoryEstimation.md) | An array of objects that explain selection for each field, sorted by the field names. | diff --git a/docs/reference/api/MlExponentialAverageCalculationContext.md b/docs/reference/api/MlExponentialAverageCalculationContext.md new file mode 100644 index 000000000..82a73b37a --- /dev/null +++ b/docs/reference/api/MlExponentialAverageCalculationContext.md @@ -0,0 +1,7 @@ +## Interface `MlExponentialAverageCalculationContext` + +| Name | Type | Description | +| - | - | - | +| `incremental_metric_value_ms` | [DurationValue](./DurationValue.md)<[UnitFloatMillis](./UnitFloatMillis.md)> |   | +| `latest_timestamp` | [EpochTime](./EpochTime.md)<[UnitMillis](./UnitMillis.md)> |   | +| `previous_exponential_average_ms` | [DurationValue](./DurationValue.md)<[UnitFloatMillis](./UnitFloatMillis.md)> |   | diff --git a/docs/reference/api/MlFeatureExtractor.md b/docs/reference/api/MlFeatureExtractor.md new file mode 100644 index 000000000..37d8ee7fa --- /dev/null +++ b/docs/reference/api/MlFeatureExtractor.md @@ -0,0 +1,4 @@ +## `MlFeatureExtractor` +::: +type MlFeatureExtractor = [MlQueryFeatureExtractor](./MlQueryFeatureExtractor.md); +::: diff --git a/docs/reference/api/MlFillMaskInferenceOptions.md b/docs/reference/api/MlFillMaskInferenceOptions.md new file mode 100644 index 000000000..83d82b2a7 --- /dev/null +++ b/docs/reference/api/MlFillMaskInferenceOptions.md @@ -0,0 +1,9 @@ +## Interface `MlFillMaskInferenceOptions` + +| Name | Type | Description | +| - | - | - | +| `mask_token` | string | The string/token which will be removed from incoming documents and replaced with the inference prediction(s). In a response, this field contains the mask token for the specified model/tokenizer. Each model and tokenizer has a predefined mask token which cannot be changed. Thus, it is recommended not to set this value in requests. However, if this field is present in a request, its value must match the predefined value for that model/tokenizer, otherwise the request will fail. | +| `num_top_classes` | [integer](./integer.md) | Specifies the number of top class predictions to return. Defaults to 0. | +| `results_field` | string | The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. | +| `tokenization` | [MlTokenizationConfigContainer](./MlTokenizationConfigContainer.md) | The tokenization options to update when inferring | +| `vocabulary` | [MlVocabulary](./MlVocabulary.md) |   | diff --git a/docs/reference/api/MlFillMaskInferenceUpdateOptions.md b/docs/reference/api/MlFillMaskInferenceUpdateOptions.md new file mode 100644 index 000000000..ca8505889 --- /dev/null +++ b/docs/reference/api/MlFillMaskInferenceUpdateOptions.md @@ -0,0 +1,7 @@ +## Interface `MlFillMaskInferenceUpdateOptions` + +| Name | Type | Description | +| - | - | - | +| `num_top_classes` | [integer](./integer.md) | Specifies the number of top class predictions to return. Defaults to 0. | +| `results_field` | string | The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. | +| `tokenization` | [MlNlpTokenizationUpdateOptions](./MlNlpTokenizationUpdateOptions.md) | The tokenization options to update when inferring | diff --git a/docs/reference/api/MlFilter.md b/docs/reference/api/MlFilter.md new file mode 100644 index 000000000..53971c0ba --- /dev/null +++ b/docs/reference/api/MlFilter.md @@ -0,0 +1,7 @@ +## Interface `MlFilter` + +| Name | Type | Description | +| - | - | - | +| `description` | string | A description of the filter. | +| `filter_id` | [Id](./Id.md) | A string that uniquely identifies a filter. | +| `items` | string[] | An array of strings which is the filter item list. | diff --git a/docs/reference/api/MlFilterRef.md b/docs/reference/api/MlFilterRef.md new file mode 100644 index 000000000..d438c14d9 --- /dev/null +++ b/docs/reference/api/MlFilterRef.md @@ -0,0 +1,6 @@ +## Interface `MlFilterRef` + +| Name | Type | Description | +| - | - | - | +| `filter_id` | [Id](./Id.md) | The identifier for the filter. | +| `filter_type` | [MlFilterType](./MlFilterType.md) | If set to `include`, the rule applies for values in the filter. If set to `exclude`, the rule applies for values not in the filter. | diff --git a/docs/reference/api/MlFilterType.md b/docs/reference/api/MlFilterType.md new file mode 100644 index 000000000..5b9b422f1 --- /dev/null +++ b/docs/reference/api/MlFilterType.md @@ -0,0 +1,4 @@ +## `MlFilterType` +::: +type MlFilterType = 'include' | 'exclude'; +::: diff --git a/docs/reference/api/MlFlushJobRequest.md b/docs/reference/api/MlFlushJobRequest.md new file mode 100644 index 000000000..e71a1c522 --- /dev/null +++ b/docs/reference/api/MlFlushJobRequest.md @@ -0,0 +1,12 @@ +## Interface `MlFlushJobRequest` + +| Name | Type | Description | +| - | - | - | +| `advance_time` | [DateTime](./DateTime.md) | Refer to the description for the `advance_time` query parameter. | +| `body` | string | ({ [key: string]: any; } & { job_id?: never; advance_time?: never; calc_interim?: never; end?: never; skip_time?: never; start?: never; }) | All values in `body` will be added to the request body. | +| `calc_interim` | boolean | Refer to the description for the `calc_interim` query parameter. | +| `end` | [DateTime](./DateTime.md) | Refer to the description for the `end` query parameter. | +| `job_id` | [Id](./Id.md) | Identifier for the anomaly detection job. | +| `querystring` | { [key: string]: any; } & { job_id?: never; advance_time?: never; calc_interim?: never; end?: never; skip_time?: never; start?: never; } | All values in `querystring` will be added to the request querystring. | +| `skip_time` | [DateTime](./DateTime.md) | Refer to the description for the `skip_time` query parameter. | +| `start` | [DateTime](./DateTime.md) | Refer to the description for the `start` query parameter. | diff --git a/docs/reference/api/MlFlushJobResponse.md b/docs/reference/api/MlFlushJobResponse.md new file mode 100644 index 000000000..63626a144 --- /dev/null +++ b/docs/reference/api/MlFlushJobResponse.md @@ -0,0 +1,6 @@ +## Interface `MlFlushJobResponse` + +| Name | Type | Description | +| - | - | - | +| `flushed` | boolean |   | +| `last_finalized_bucket_end` | [integer](./integer.md) | Provides the timestamp (in milliseconds since the epoch) of the end of the last bucket that was processed. | diff --git a/docs/reference/api/MlForecastRequest.md b/docs/reference/api/MlForecastRequest.md new file mode 100644 index 000000000..35969d2b7 --- /dev/null +++ b/docs/reference/api/MlForecastRequest.md @@ -0,0 +1,10 @@ +## Interface `MlForecastRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { job_id?: never; duration?: never; expires_in?: never; max_model_memory?: never; }) | All values in `body` will be added to the request body. | +| `duration` | [Duration](./Duration.md) | Refer to the description for the `duration` query parameter. | +| `expires_in` | [Duration](./Duration.md) | Refer to the description for the `expires_in` query parameter. | +| `job_id` | [Id](./Id.md) | Identifier for the anomaly detection job. The job must be open when you create a forecast; otherwise, an error occurs. | +| `max_model_memory` | string | Refer to the description for the `max_model_memory` query parameter. | +| `querystring` | { [key: string]: any; } & { job_id?: never; duration?: never; expires_in?: never; max_model_memory?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/MlForecastResponse.md b/docs/reference/api/MlForecastResponse.md new file mode 100644 index 000000000..ee3446162 --- /dev/null +++ b/docs/reference/api/MlForecastResponse.md @@ -0,0 +1,6 @@ +## Interface `MlForecastResponse` + +| Name | Type | Description | +| - | - | - | +| `acknowledged` | boolean |   | +| `forecast_id` | [Id](./Id.md) |   | diff --git a/docs/reference/api/MlGeoResults.md b/docs/reference/api/MlGeoResults.md new file mode 100644 index 000000000..c0661ae8d --- /dev/null +++ b/docs/reference/api/MlGeoResults.md @@ -0,0 +1,6 @@ +## Interface `MlGeoResults` + +| Name | Type | Description | +| - | - | - | +| `actual_point` | string | The actual value for the bucket formatted as a `geo_point`. | +| `typical_point` | string | The typical value for the bucket formatted as a `geo_point`. | diff --git a/docs/reference/api/MlGetBucketsRequest.md b/docs/reference/api/MlGetBucketsRequest.md new file mode 100644 index 000000000..2fcf8e4d8 --- /dev/null +++ b/docs/reference/api/MlGetBucketsRequest.md @@ -0,0 +1,18 @@ +## Interface `MlGetBucketsRequest` + +| Name | Type | Description | +| - | - | - | +| `anomaly_score` | [double](./double.md) | Refer to the description for the `anomaly_score` query parameter. | +| `body` | string | ({ [key: string]: any; } & { job_id?: never; timestamp?: never; from?: never; size?: never; anomaly_score?: never; desc?: never; end?: never; exclude_interim?: never; expand?: never; page?: never; sort?: never; start?: never; }) | All values in `body` will be added to the request body. | +| `desc` | boolean | Refer to the description for the `desc` query parameter. | +| `end` | [DateTime](./DateTime.md) | Refer to the description for the `end` query parameter. | +| `exclude_interim` | boolean | Refer to the description for the `exclude_interim` query parameter. | +| `expand` | boolean | Refer to the description for the `expand` query parameter. | +| `from` | [integer](./integer.md) | Skips the specified number of buckets. | +| `job_id` | [Id](./Id.md) | Identifier for the anomaly detection job. | +| `page` | [MlPage](./MlPage.md) |   | +| `querystring` | { [key: string]: any; } & { job_id?: never; timestamp?: never; from?: never; size?: never; anomaly_score?: never; desc?: never; end?: never; exclude_interim?: never; expand?: never; page?: never; sort?: never; start?: never; } | All values in `querystring` will be added to the request querystring. | +| `size` | [integer](./integer.md) | Specifies the maximum number of buckets to obtain. | +| `sort` | [Field](./Field.md) | Refer to the desription for the `sort` query parameter. | +| `start` | [DateTime](./DateTime.md) | Refer to the description for the `start` query parameter. | +| `timestamp` | [DateTime](./DateTime.md) | The timestamp of a single bucket result. If you do not specify this parameter, the API returns information about all buckets. | diff --git a/docs/reference/api/MlGetBucketsResponse.md b/docs/reference/api/MlGetBucketsResponse.md new file mode 100644 index 000000000..8fbb65975 --- /dev/null +++ b/docs/reference/api/MlGetBucketsResponse.md @@ -0,0 +1,6 @@ +## Interface `MlGetBucketsResponse` + +| Name | Type | Description | +| - | - | - | +| `buckets` | [MlBucketSummary](./MlBucketSummary.md)[] |   | +| `count` | [long](./long.md) |   | diff --git a/docs/reference/api/MlGetCalendarEventsRequest.md b/docs/reference/api/MlGetCalendarEventsRequest.md new file mode 100644 index 000000000..3faf42f42 --- /dev/null +++ b/docs/reference/api/MlGetCalendarEventsRequest.md @@ -0,0 +1,12 @@ +## Interface `MlGetCalendarEventsRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { calendar_id?: never; end?: never; from?: never; job_id?: never; size?: never; start?: never; }) | All values in `body` will be added to the request body. | +| `calendar_id` | [Id](./Id.md) | A string that uniquely identifies a calendar. You can get information for multiple calendars by using a comma-separated list of ids or a wildcard expression. You can get information for all calendars by using `_all` or `*` or by omitting the calendar identifier. | +| `end` | [DateTime](./DateTime.md) | Specifies to get events with timestamps earlier than this time. | +| `from` | [integer](./integer.md) | Skips the specified number of events. | +| `job_id` | [Id](./Id.md) | Specifies to get events for a specific anomaly detection job identifier or job group. It must be used with a calendar identifier of `_all` or `*`. | +| `querystring` | { [key: string]: any; } & { calendar_id?: never; end?: never; from?: never; job_id?: never; size?: never; start?: never; } | All values in `querystring` will be added to the request querystring. | +| `size` | [integer](./integer.md) | Specifies the maximum number of events to obtain. | +| `start` | [DateTime](./DateTime.md) | Specifies to get events with timestamps after this time. | diff --git a/docs/reference/api/MlGetCalendarEventsResponse.md b/docs/reference/api/MlGetCalendarEventsResponse.md new file mode 100644 index 000000000..568675699 --- /dev/null +++ b/docs/reference/api/MlGetCalendarEventsResponse.md @@ -0,0 +1,6 @@ +## Interface `MlGetCalendarEventsResponse` + +| Name | Type | Description | +| - | - | - | +| `count` | [long](./long.md) |   | +| `events` | [MlCalendarEvent](./MlCalendarEvent.md)[] |   | diff --git a/docs/reference/api/MlGetCalendarsCalendar.md b/docs/reference/api/MlGetCalendarsCalendar.md new file mode 100644 index 000000000..063a7c507 --- /dev/null +++ b/docs/reference/api/MlGetCalendarsCalendar.md @@ -0,0 +1,7 @@ +## Interface `MlGetCalendarsCalendar` + +| Name | Type | Description | +| - | - | - | +| `calendar_id` | [Id](./Id.md) | A string that uniquely identifies a calendar. | +| `description` | string | A description of the calendar. | +| `job_ids` | [Id](./Id.md)[] | An array of anomaly detection job identifiers. | diff --git a/docs/reference/api/MlGetCalendarsRequest.md b/docs/reference/api/MlGetCalendarsRequest.md new file mode 100644 index 000000000..e87c30933 --- /dev/null +++ b/docs/reference/api/MlGetCalendarsRequest.md @@ -0,0 +1,10 @@ +## Interface `MlGetCalendarsRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { calendar_id?: never; from?: never; size?: never; page?: never; }) | All values in `body` will be added to the request body. | +| `calendar_id` | [Id](./Id.md) | A string that uniquely identifies a calendar. You can get information for multiple calendars by using a comma-separated list of ids or a wildcard expression. You can get information for all calendars by using `_all` or `*` or by omitting the calendar identifier. | +| `from` | [integer](./integer.md) | Skips the specified number of calendars. This parameter is supported only when you omit the calendar identifier. | +| `page` | [MlPage](./MlPage.md) | This object is supported only when you omit the calendar identifier. | +| `querystring` | { [key: string]: any; } & { calendar_id?: never; from?: never; size?: never; page?: never; } | All values in `querystring` will be added to the request querystring. | +| `size` | [integer](./integer.md) | Specifies the maximum number of calendars to obtain. This parameter is supported only when you omit the calendar identifier. | diff --git a/docs/reference/api/MlGetCalendarsResponse.md b/docs/reference/api/MlGetCalendarsResponse.md new file mode 100644 index 000000000..d75f774be --- /dev/null +++ b/docs/reference/api/MlGetCalendarsResponse.md @@ -0,0 +1,6 @@ +## Interface `MlGetCalendarsResponse` + +| Name | Type | Description | +| - | - | - | +| `calendars` | [MlGetCalendarsCalendar](./MlGetCalendarsCalendar.md)[] |   | +| `count` | [long](./long.md) |   | diff --git a/docs/reference/api/MlGetCategoriesRequest.md b/docs/reference/api/MlGetCategoriesRequest.md new file mode 100644 index 000000000..c2797dda7 --- /dev/null +++ b/docs/reference/api/MlGetCategoriesRequest.md @@ -0,0 +1,12 @@ +## Interface `MlGetCategoriesRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { job_id?: never; category_id?: never; from?: never; partition_field_value?: never; size?: never; page?: never; }) | All values in `body` will be added to the request body. | +| `category_id` | [CategoryId](./CategoryId.md) | Identifier for the category, which is unique in the job. If you specify neither the category ID nor the partition_field_value, the API returns information about all categories. If you specify only the partition_field_value, it returns information about all categories for the specified partition. | +| `from` | [integer](./integer.md) | Skips the specified number of categories. | +| `job_id` | [Id](./Id.md) | Identifier for the anomaly detection job. | +| `page` | [MlPage](./MlPage.md) | Configures pagination. This parameter has the `from` and `size` properties. | +| `partition_field_value` | string | Only return categories for the specified partition. | +| `querystring` | { [key: string]: any; } & { job_id?: never; category_id?: never; from?: never; partition_field_value?: never; size?: never; page?: never; } | All values in `querystring` will be added to the request querystring. | +| `size` | [integer](./integer.md) | Specifies the maximum number of categories to obtain. | diff --git a/docs/reference/api/MlGetCategoriesResponse.md b/docs/reference/api/MlGetCategoriesResponse.md new file mode 100644 index 000000000..c34ce1f76 --- /dev/null +++ b/docs/reference/api/MlGetCategoriesResponse.md @@ -0,0 +1,6 @@ +## Interface `MlGetCategoriesResponse` + +| Name | Type | Description | +| - | - | - | +| `categories` | [MlCategory](./MlCategory.md)[] |   | +| `count` | [long](./long.md) |   | diff --git a/docs/reference/api/MlGetDataFrameAnalyticsRequest.md b/docs/reference/api/MlGetDataFrameAnalyticsRequest.md new file mode 100644 index 000000000..23d39ef24 --- /dev/null +++ b/docs/reference/api/MlGetDataFrameAnalyticsRequest.md @@ -0,0 +1,11 @@ +## Interface `MlGetDataFrameAnalyticsRequest` + +| Name | Type | Description | +| - | - | - | +| `allow_no_match` | boolean | Specifies what to do when the request: 1. Contains wildcard expressions and there are no data frame analytics jobs that match. 2. Contains the `_all` string or no identifiers and there are no matches. 3. Contains wildcard expressions and there are only partial matches. The default value returns an empty data_frame_analytics array when there are no matches and the subset of results when there are partial matches. If this parameter is `false`, the request returns a 404 status code when there are no matches or only partial matches. | +| `body` | string | ({ [key: string]: any; } & { id?: never; allow_no_match?: never; from?: never; size?: never; exclude_generated?: never; }) | All values in `body` will be added to the request body. | +| `exclude_generated` | boolean | Indicates if certain fields should be removed from the configuration on retrieval. This allows the configuration to be in an acceptable format to be retrieved and then added to another cluster. | +| `from` | [integer](./integer.md) | Skips the specified number of data frame analytics jobs. | +| `id` | [Id](./Id.md) | Identifier for the data frame analytics job. If you do not specify this option, the API returns information for the first hundred data frame analytics jobs. | +| `querystring` | { [key: string]: any; } & { id?: never; allow_no_match?: never; from?: never; size?: never; exclude_generated?: never; } | All values in `querystring` will be added to the request querystring. | +| `size` | [integer](./integer.md) | Specifies the maximum number of data frame analytics jobs to obtain. | diff --git a/docs/reference/api/MlGetDataFrameAnalyticsResponse.md b/docs/reference/api/MlGetDataFrameAnalyticsResponse.md new file mode 100644 index 000000000..9567e6a6f --- /dev/null +++ b/docs/reference/api/MlGetDataFrameAnalyticsResponse.md @@ -0,0 +1,6 @@ +## Interface `MlGetDataFrameAnalyticsResponse` + +| Name | Type | Description | +| - | - | - | +| `count` | [integer](./integer.md) |   | +| `data_frame_analytics` | [MlDataframeAnalyticsSummary](./MlDataframeAnalyticsSummary.md)[] | An array of data frame analytics job resources, which are sorted by the id value in ascending order. | diff --git a/docs/reference/api/MlGetDataFrameAnalyticsStatsRequest.md b/docs/reference/api/MlGetDataFrameAnalyticsStatsRequest.md new file mode 100644 index 000000000..4bb5b169b --- /dev/null +++ b/docs/reference/api/MlGetDataFrameAnalyticsStatsRequest.md @@ -0,0 +1,11 @@ +## Interface `MlGetDataFrameAnalyticsStatsRequest` + +| Name | Type | Description | +| - | - | - | +| `allow_no_match` | boolean | Specifies what to do when the request: 1. Contains wildcard expressions and there are no data frame analytics jobs that match. 2. Contains the `_all` string or no identifiers and there are no matches. 3. Contains wildcard expressions and there are only partial matches. The default value returns an empty data_frame_analytics array when there are no matches and the subset of results when there are partial matches. If this parameter is `false`, the request returns a 404 status code when there are no matches or only partial matches. | +| `body` | string | ({ [key: string]: any; } & { id?: never; allow_no_match?: never; from?: never; size?: never; verbose?: never; }) | All values in `body` will be added to the request body. | +| `from` | [integer](./integer.md) | Skips the specified number of data frame analytics jobs. | +| `id` | [Id](./Id.md) | Identifier for the data frame analytics job. If you do not specify this option, the API returns information for the first hundred data frame analytics jobs. | +| `querystring` | { [key: string]: any; } & { id?: never; allow_no_match?: never; from?: never; size?: never; verbose?: never; } | All values in `querystring` will be added to the request querystring. | +| `size` | [integer](./integer.md) | Specifies the maximum number of data frame analytics jobs to obtain. | +| `verbose` | boolean | Defines whether the stats response should be verbose. | diff --git a/docs/reference/api/MlGetDataFrameAnalyticsStatsResponse.md b/docs/reference/api/MlGetDataFrameAnalyticsStatsResponse.md new file mode 100644 index 000000000..465b91877 --- /dev/null +++ b/docs/reference/api/MlGetDataFrameAnalyticsStatsResponse.md @@ -0,0 +1,6 @@ +## Interface `MlGetDataFrameAnalyticsStatsResponse` + +| Name | Type | Description | +| - | - | - | +| `count` | [long](./long.md) |   | +| `data_frame_analytics` | [MlDataframeAnalytics](./MlDataframeAnalytics.md)[] | An array of objects that contain usage information for data frame analytics jobs, which are sorted by the id value in ascending order. | diff --git a/docs/reference/api/MlGetDatafeedStatsRequest.md b/docs/reference/api/MlGetDatafeedStatsRequest.md new file mode 100644 index 000000000..29196de21 --- /dev/null +++ b/docs/reference/api/MlGetDatafeedStatsRequest.md @@ -0,0 +1,8 @@ +## Interface `MlGetDatafeedStatsRequest` + +| Name | Type | Description | +| - | - | - | +| `allow_no_match` | boolean | Specifies what to do when the request: 1. Contains wildcard expressions and there are no datafeeds that match. 2. Contains the `_all` string or no identifiers and there are no matches. 3. Contains wildcard expressions and there are only partial matches. The default value is `true`, which returns an empty `datafeeds` array when there are no matches and the subset of results when there are partial matches. If this parameter is `false`, the request returns a `404` status code when there are no matches or only partial matches. | +| `body` | string | ({ [key: string]: any; } & { datafeed_id?: never; allow_no_match?: never; }) | All values in `body` will be added to the request body. | +| `datafeed_id` | [Ids](./Ids.md) | Identifier for the datafeed. It can be a datafeed identifier or a wildcard expression. If you do not specify one of these options, the API returns information about all datafeeds. | +| `querystring` | { [key: string]: any; } & { datafeed_id?: never; allow_no_match?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/MlGetDatafeedStatsResponse.md b/docs/reference/api/MlGetDatafeedStatsResponse.md new file mode 100644 index 000000000..301736e2c --- /dev/null +++ b/docs/reference/api/MlGetDatafeedStatsResponse.md @@ -0,0 +1,6 @@ +## Interface `MlGetDatafeedStatsResponse` + +| Name | Type | Description | +| - | - | - | +| `count` | [long](./long.md) |   | +| `datafeeds` | [MlDatafeedStats](./MlDatafeedStats.md)[] |   | diff --git a/docs/reference/api/MlGetDatafeedsRequest.md b/docs/reference/api/MlGetDatafeedsRequest.md new file mode 100644 index 000000000..af552e22a --- /dev/null +++ b/docs/reference/api/MlGetDatafeedsRequest.md @@ -0,0 +1,9 @@ +## Interface `MlGetDatafeedsRequest` + +| Name | Type | Description | +| - | - | - | +| `allow_no_match` | boolean | Specifies what to do when the request: 1. Contains wildcard expressions and there are no datafeeds that match. 2. Contains the `_all` string or no identifiers and there are no matches. 3. Contains wildcard expressions and there are only partial matches. The default value is `true`, which returns an empty `datafeeds` array when there are no matches and the subset of results when there are partial matches. If this parameter is `false`, the request returns a `404` status code when there are no matches or only partial matches. | +| `body` | string | ({ [key: string]: any; } & { datafeed_id?: never; allow_no_match?: never; exclude_generated?: never; }) | All values in `body` will be added to the request body. | +| `datafeed_id` | [Ids](./Ids.md) | Identifier for the datafeed. It can be a datafeed identifier or a wildcard expression. If you do not specify one of these options, the API returns information about all datafeeds. | +| `exclude_generated` | boolean | Indicates if certain fields should be removed from the configuration on retrieval. This allows the configuration to be in an acceptable format to be retrieved and then added to another cluster. | +| `querystring` | { [key: string]: any; } & { datafeed_id?: never; allow_no_match?: never; exclude_generated?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/MlGetDatafeedsResponse.md b/docs/reference/api/MlGetDatafeedsResponse.md new file mode 100644 index 000000000..6f8e27fbc --- /dev/null +++ b/docs/reference/api/MlGetDatafeedsResponse.md @@ -0,0 +1,6 @@ +## Interface `MlGetDatafeedsResponse` + +| Name | Type | Description | +| - | - | - | +| `count` | [long](./long.md) |   | +| `datafeeds` | [MlDatafeed](./MlDatafeed.md)[] |   | diff --git a/docs/reference/api/MlGetFiltersRequest.md b/docs/reference/api/MlGetFiltersRequest.md new file mode 100644 index 000000000..06f63ab61 --- /dev/null +++ b/docs/reference/api/MlGetFiltersRequest.md @@ -0,0 +1,9 @@ +## Interface `MlGetFiltersRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { filter_id?: never; from?: never; size?: never; }) | All values in `body` will be added to the request body. | +| `filter_id` | [Ids](./Ids.md) | A string that uniquely identifies a filter. | +| `from` | [integer](./integer.md) | Skips the specified number of filters. | +| `querystring` | { [key: string]: any; } & { filter_id?: never; from?: never; size?: never; } | All values in `querystring` will be added to the request querystring. | +| `size` | [integer](./integer.md) | Specifies the maximum number of filters to obtain. | diff --git a/docs/reference/api/MlGetFiltersResponse.md b/docs/reference/api/MlGetFiltersResponse.md new file mode 100644 index 000000000..4099d21a2 --- /dev/null +++ b/docs/reference/api/MlGetFiltersResponse.md @@ -0,0 +1,6 @@ +## Interface `MlGetFiltersResponse` + +| Name | Type | Description | +| - | - | - | +| `count` | [long](./long.md) |   | +| `filters` | [MlFilter](./MlFilter.md)[] |   | diff --git a/docs/reference/api/MlGetInfluencersRequest.md b/docs/reference/api/MlGetInfluencersRequest.md new file mode 100644 index 000000000..a0fc89862 --- /dev/null +++ b/docs/reference/api/MlGetInfluencersRequest.md @@ -0,0 +1,16 @@ +## Interface `MlGetInfluencersRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { job_id?: never; desc?: never; end?: never; exclude_interim?: never; influencer_score?: never; from?: never; size?: never; sort?: never; start?: never; page?: never; }) | All values in `body` will be added to the request body. | +| `desc` | boolean | If true, the results are sorted in descending order. | +| `end` | [DateTime](./DateTime.md) | Returns influencers with timestamps earlier than this time. The default value means it is unset and results are not limited to specific timestamps. | +| `exclude_interim` | boolean | If true, the output excludes interim results. By default, interim results are included. | +| `from` | [integer](./integer.md) | Skips the specified number of influencers. | +| `influencer_score` | [double](./double.md) | Returns influencers with anomaly scores greater than or equal to this value. | +| `job_id` | [Id](./Id.md) | Identifier for the anomaly detection job. | +| `page` | [MlPage](./MlPage.md) | Configures pagination. This parameter has the `from` and `size` properties. | +| `querystring` | { [key: string]: any; } & { job_id?: never; desc?: never; end?: never; exclude_interim?: never; influencer_score?: never; from?: never; size?: never; sort?: never; start?: never; page?: never; } | All values in `querystring` will be added to the request querystring. | +| `size` | [integer](./integer.md) | Specifies the maximum number of influencers to obtain. | +| `sort` | [Field](./Field.md) | Specifies the sort field for the requested influencers. By default, the influencers are sorted by the `influencer_score` value. | +| `start` | [DateTime](./DateTime.md) | Returns influencers with timestamps after this time. The default value means it is unset and results are not limited to specific timestamps. | diff --git a/docs/reference/api/MlGetInfluencersResponse.md b/docs/reference/api/MlGetInfluencersResponse.md new file mode 100644 index 000000000..78386e25d --- /dev/null +++ b/docs/reference/api/MlGetInfluencersResponse.md @@ -0,0 +1,6 @@ +## Interface `MlGetInfluencersResponse` + +| Name | Type | Description | +| - | - | - | +| `count` | [long](./long.md) |   | +| `influencers` | [MlInfluencer](./MlInfluencer.md)[] | Array of influencer objects | diff --git a/docs/reference/api/MlGetJobStatsRequest.md b/docs/reference/api/MlGetJobStatsRequest.md new file mode 100644 index 000000000..e475eecea --- /dev/null +++ b/docs/reference/api/MlGetJobStatsRequest.md @@ -0,0 +1,8 @@ +## Interface `MlGetJobStatsRequest` + +| Name | Type | Description | +| - | - | - | +| `allow_no_match` | boolean | Specifies what to do when the request: 1. Contains wildcard expressions and there are no jobs that match. 2. Contains the _all string or no identifiers and there are no matches. 3. Contains wildcard expressions and there are only partial matches. If `true`, the API returns an empty `jobs` array when there are no matches and the subset of results when there are partial matches. If `false`, the API returns a `404` status code when there are no matches or only partial matches. | +| `body` | string | ({ [key: string]: any; } & { job_id?: never; allow_no_match?: never; }) | All values in `body` will be added to the request body. | +| `job_id` | [Id](./Id.md) | Identifier for the anomaly detection job. It can be a job identifier, a group name, a comma-separated list of jobs, or a wildcard expression. If you do not specify one of these options, the API returns information for all anomaly detection jobs. | +| `querystring` | { [key: string]: any; } & { job_id?: never; allow_no_match?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/MlGetJobStatsResponse.md b/docs/reference/api/MlGetJobStatsResponse.md new file mode 100644 index 000000000..2dae75012 --- /dev/null +++ b/docs/reference/api/MlGetJobStatsResponse.md @@ -0,0 +1,6 @@ +## Interface `MlGetJobStatsResponse` + +| Name | Type | Description | +| - | - | - | +| `count` | [long](./long.md) |   | +| `jobs` | [MlJobStats](./MlJobStats.md)[] |   | diff --git a/docs/reference/api/MlGetJobsRequest.md b/docs/reference/api/MlGetJobsRequest.md new file mode 100644 index 000000000..2389a0a91 --- /dev/null +++ b/docs/reference/api/MlGetJobsRequest.md @@ -0,0 +1,9 @@ +## Interface `MlGetJobsRequest` + +| Name | Type | Description | +| - | - | - | +| `allow_no_match` | boolean | Specifies what to do when the request: 1. Contains wildcard expressions and there are no jobs that match. 2. Contains the _all string or no identifiers and there are no matches. 3. Contains wildcard expressions and there are only partial matches. The default value is `true`, which returns an empty `jobs` array when there are no matches and the subset of results when there are partial matches. If this parameter is `false`, the request returns a `404` status code when there are no matches or only partial matches. | +| `body` | string | ({ [key: string]: any; } & { job_id?: never; allow_no_match?: never; exclude_generated?: never; }) | All values in `body` will be added to the request body. | +| `exclude_generated` | boolean | Indicates if certain fields should be removed from the configuration on retrieval. This allows the configuration to be in an acceptable format to be retrieved and then added to another cluster. | +| `job_id` | [Ids](./Ids.md) | Identifier for the anomaly detection job. It can be a job identifier, a group name, or a wildcard expression. If you do not specify one of these options, the API returns information for all anomaly detection jobs. | +| `querystring` | { [key: string]: any; } & { job_id?: never; allow_no_match?: never; exclude_generated?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/MlGetJobsResponse.md b/docs/reference/api/MlGetJobsResponse.md new file mode 100644 index 000000000..664f49d46 --- /dev/null +++ b/docs/reference/api/MlGetJobsResponse.md @@ -0,0 +1,6 @@ +## Interface `MlGetJobsResponse` + +| Name | Type | Description | +| - | - | - | +| `count` | [long](./long.md) |   | +| `jobs` | [MlJob](./MlJob.md)[] |   | diff --git a/docs/reference/api/MlGetMemoryStatsJvmStats.md b/docs/reference/api/MlGetMemoryStatsJvmStats.md new file mode 100644 index 000000000..71b8619e3 --- /dev/null +++ b/docs/reference/api/MlGetMemoryStatsJvmStats.md @@ -0,0 +1,10 @@ +## Interface `MlGetMemoryStatsJvmStats` + +| Name | Type | Description | +| - | - | - | +| `heap_max_in_bytes` | [integer](./integer.md) | Maximum amount of memory, in bytes, available for use by the heap. | +| `heap_max` | [ByteSize](./ByteSize.md) | Maximum amount of memory available for use by the heap. | +| `java_inference_in_bytes` | [integer](./integer.md) | Amount of Java heap, in bytes, currently being used for caching inference models. | +| `java_inference_max_in_bytes` | [integer](./integer.md) | Maximum amount of Java heap, in bytes, to be used for caching inference models. | +| `java_inference_max` | [ByteSize](./ByteSize.md) | Maximum amount of Java heap to be used for caching inference models. | +| `java_inference` | [ByteSize](./ByteSize.md) | Amount of Java heap currently being used for caching inference models. | diff --git a/docs/reference/api/MlGetMemoryStatsMemMlStats.md b/docs/reference/api/MlGetMemoryStatsMemMlStats.md new file mode 100644 index 000000000..0f8e734df --- /dev/null +++ b/docs/reference/api/MlGetMemoryStatsMemMlStats.md @@ -0,0 +1,14 @@ +## Interface `MlGetMemoryStatsMemMlStats` + +| Name | Type | Description | +| - | - | - | +| `anomaly_detectors_in_bytes` | [integer](./integer.md) | Amount of native memory, in bytes, set aside for anomaly detection jobs. | +| `anomaly_detectors` | [ByteSize](./ByteSize.md) | Amount of native memory set aside for anomaly detection jobs. | +| `data_frame_analytics_in_bytes` | [integer](./integer.md) | Amount of native memory, in bytes, set aside for data frame analytics jobs. | +| `data_frame_analytics` | [ByteSize](./ByteSize.md) | Amount of native memory set aside for data frame analytics jobs. | +| `max_in_bytes` | [integer](./integer.md) | Maximum amount of native memory (separate to the JVM heap), in bytes, that may be used by machine learning native processes. | +| `max` | [ByteSize](./ByteSize.md) | Maximum amount of native memory (separate to the JVM heap) that may be used by machine learning native processes. | +| `native_code_overhead_in_bytes` | [integer](./integer.md) | Amount of native memory, in bytes, set aside for loading machine learning native code shared libraries. | +| `native_code_overhead` | [ByteSize](./ByteSize.md) | Amount of native memory set aside for loading machine learning native code shared libraries. | +| `native_inference_in_bytes` | [integer](./integer.md) | Amount of native memory, in bytes, set aside for trained models that have a PyTorch model_type. | +| `native_inference` | [ByteSize](./ByteSize.md) | Amount of native memory set aside for trained models that have a PyTorch model_type. | diff --git a/docs/reference/api/MlGetMemoryStatsMemStats.md b/docs/reference/api/MlGetMemoryStatsMemStats.md new file mode 100644 index 000000000..aa78101c8 --- /dev/null +++ b/docs/reference/api/MlGetMemoryStatsMemStats.md @@ -0,0 +1,9 @@ +## Interface `MlGetMemoryStatsMemStats` + +| Name | Type | Description | +| - | - | - | +| `adjusted_total_in_bytes` | [integer](./integer.md) | If the amount of physical memory has been overridden using the `es.total_memory_bytes` system property then this reports the overridden value in bytes. Otherwise it reports the same value as `total_in_bytes`. | +| `adjusted_total` | [ByteSize](./ByteSize.md) | If the amount of physical memory has been overridden using the es.total_memory_bytes system property then this reports the overridden value. Otherwise it reports the same value as total. | +| `ml` | [MlGetMemoryStatsMemMlStats](./MlGetMemoryStatsMemMlStats.md) | Contains statistics about machine learning use of native memory on the node. | +| `total_in_bytes` | [integer](./integer.md) | Total amount of physical memory in bytes. | +| `total` | [ByteSize](./ByteSize.md) | Total amount of physical memory. | diff --git a/docs/reference/api/MlGetMemoryStatsMemory.md b/docs/reference/api/MlGetMemoryStatsMemory.md new file mode 100644 index 000000000..32d04bccb --- /dev/null +++ b/docs/reference/api/MlGetMemoryStatsMemory.md @@ -0,0 +1,11 @@ +## Interface `MlGetMemoryStatsMemory` + +| Name | Type | Description | +| - | - | - | +| `attributes` | Record |   | +| `ephemeral_id` | [Id](./Id.md) |   | +| `jvm` | [MlGetMemoryStatsJvmStats](./MlGetMemoryStatsJvmStats.md) | Contains Java Virtual Machine (JVM) statistics for the node. | +| `mem` | [MlGetMemoryStatsMemStats](./MlGetMemoryStatsMemStats.md) | Contains statistics about memory usage for the node. | +| `name` | [Name](./Name.md) | Human-readable identifier for the node. Based on the Node name setting setting. | +| `roles` | string[] | Roles assigned to the node. | +| `transport_address` | [TransportAddress](./TransportAddress.md) | The host and port where transport HTTP connections are accepted. | diff --git a/docs/reference/api/MlGetMemoryStatsRequest.md b/docs/reference/api/MlGetMemoryStatsRequest.md new file mode 100644 index 000000000..a953a70f3 --- /dev/null +++ b/docs/reference/api/MlGetMemoryStatsRequest.md @@ -0,0 +1,9 @@ +## Interface `MlGetMemoryStatsRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { node_id?: never; master_timeout?: never; timeout?: never; }) | All values in `body` will be added to the request body. | +| `master_timeout` | [Duration](./Duration.md) | Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. | +| `node_id` | [Id](./Id.md) | The names of particular nodes in the cluster to target. For example, `nodeId1,nodeId2` or `ml:true` | +| `querystring` | { [key: string]: any; } & { node_id?: never; master_timeout?: never; timeout?: never; } | All values in `querystring` will be added to the request querystring. | +| `timeout` | [Duration](./Duration.md) | Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. | diff --git a/docs/reference/api/MlGetMemoryStatsResponse.md b/docs/reference/api/MlGetMemoryStatsResponse.md new file mode 100644 index 000000000..7ed3040ef --- /dev/null +++ b/docs/reference/api/MlGetMemoryStatsResponse.md @@ -0,0 +1,7 @@ +## Interface `MlGetMemoryStatsResponse` + +| Name | Type | Description | +| - | - | - | +| `_nodes` | [NodeStatistics](./NodeStatistics.md) |   | +| `cluster_name` | [Name](./Name.md) |   | +| `nodes` | Record<[Id](./Id.md), [MlGetMemoryStatsMemory](./MlGetMemoryStatsMemory.md)> |   | diff --git a/docs/reference/api/MlGetModelSnapshotUpgradeStatsRequest.md b/docs/reference/api/MlGetModelSnapshotUpgradeStatsRequest.md new file mode 100644 index 000000000..c12c87ea3 --- /dev/null +++ b/docs/reference/api/MlGetModelSnapshotUpgradeStatsRequest.md @@ -0,0 +1,9 @@ +## Interface `MlGetModelSnapshotUpgradeStatsRequest` + +| Name | Type | Description | +| - | - | - | +| `allow_no_match` | boolean | Specifies what to do when the request: - Contains wildcard expressions and there are no jobs that match. - Contains the _all string or no identifiers and there are no matches. - Contains wildcard expressions and there are only partial matches. The default value is true, which returns an empty jobs array when there are no matches and the subset of results when there are partial matches. If this parameter is false, the request returns a 404 status code when there are no matches or only partial matches. | +| `body` | string | ({ [key: string]: any; } & { job_id?: never; snapshot_id?: never; allow_no_match?: never; }) | All values in `body` will be added to the request body. | +| `job_id` | [Id](./Id.md) | Identifier for the anomaly detection job. | +| `querystring` | { [key: string]: any; } & { job_id?: never; snapshot_id?: never; allow_no_match?: never; } | All values in `querystring` will be added to the request querystring. | +| `snapshot_id` | [Id](./Id.md) | A numerical character string that uniquely identifies the model snapshot. You can get information for multiple snapshots by using a comma-separated list or a wildcard expression. You can get all snapshots by using `_all`, by specifying `*` as the snapshot ID, or by omitting the snapshot ID. | diff --git a/docs/reference/api/MlGetModelSnapshotUpgradeStatsResponse.md b/docs/reference/api/MlGetModelSnapshotUpgradeStatsResponse.md new file mode 100644 index 000000000..4fec2ec74 --- /dev/null +++ b/docs/reference/api/MlGetModelSnapshotUpgradeStatsResponse.md @@ -0,0 +1,6 @@ +## Interface `MlGetModelSnapshotUpgradeStatsResponse` + +| Name | Type | Description | +| - | - | - | +| `count` | [long](./long.md) |   | +| `model_snapshot_upgrades` | [MlModelSnapshotUpgrade](./MlModelSnapshotUpgrade.md)[] |   | diff --git a/docs/reference/api/MlGetModelSnapshotsRequest.md b/docs/reference/api/MlGetModelSnapshotsRequest.md new file mode 100644 index 000000000..eedf1a833 --- /dev/null +++ b/docs/reference/api/MlGetModelSnapshotsRequest.md @@ -0,0 +1,15 @@ +## Interface `MlGetModelSnapshotsRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { job_id?: never; snapshot_id?: never; from?: never; size?: never; desc?: never; end?: never; page?: never; sort?: never; start?: never; }) | All values in `body` will be added to the request body. | +| `desc` | boolean | Refer to the description for the `desc` query parameter. | +| `end` | [DateTime](./DateTime.md) | Refer to the description for the `end` query parameter. | +| `from` | [integer](./integer.md) | Skips the specified number of snapshots. | +| `job_id` | [Id](./Id.md) | Identifier for the anomaly detection job. | +| `page` | [MlPage](./MlPage.md) |   | +| `querystring` | { [key: string]: any; } & { job_id?: never; snapshot_id?: never; from?: never; size?: never; desc?: never; end?: never; page?: never; sort?: never; start?: never; } | All values in `querystring` will be added to the request querystring. | +| `size` | [integer](./integer.md) | Specifies the maximum number of snapshots to obtain. | +| `snapshot_id` | [Id](./Id.md) | A numerical character string that uniquely identifies the model snapshot. You can get information for multiple snapshots by using a comma-separated list or a wildcard expression. You can get all snapshots by using `_all`, by specifying `*` as the snapshot ID, or by omitting the snapshot ID. | +| `sort` | [Field](./Field.md) | Refer to the description for the `sort` query parameter. | +| `start` | [DateTime](./DateTime.md) | Refer to the description for the `start` query parameter. | diff --git a/docs/reference/api/MlGetModelSnapshotsResponse.md b/docs/reference/api/MlGetModelSnapshotsResponse.md new file mode 100644 index 000000000..b17683846 --- /dev/null +++ b/docs/reference/api/MlGetModelSnapshotsResponse.md @@ -0,0 +1,6 @@ +## Interface `MlGetModelSnapshotsResponse` + +| Name | Type | Description | +| - | - | - | +| `count` | [long](./long.md) |   | +| `model_snapshots` | [MlModelSnapshot](./MlModelSnapshot.md)[] |   | diff --git a/docs/reference/api/MlGetOverallBucketsRequest.md b/docs/reference/api/MlGetOverallBucketsRequest.md new file mode 100644 index 000000000..9aa923560 --- /dev/null +++ b/docs/reference/api/MlGetOverallBucketsRequest.md @@ -0,0 +1,14 @@ +## Interface `MlGetOverallBucketsRequest` + +| Name | Type | Description | +| - | - | - | +| `allow_no_match` | boolean | Refer to the description for the `allow_no_match` query parameter. | +| `body` | string | ({ [key: string]: any; } & { job_id?: never; allow_no_match?: never; bucket_span?: never; end?: never; exclude_interim?: never; overall_score?: never; start?: never; top_n?: never; }) | All values in `body` will be added to the request body. | +| `bucket_span` | [Duration](./Duration.md) | Refer to the description for the `bucket_span` query parameter. | +| `end` | [DateTime](./DateTime.md) | Refer to the description for the `end` query parameter. | +| `exclude_interim` | boolean | Refer to the description for the `exclude_interim` query parameter. | +| `job_id` | [Id](./Id.md) | Identifier for the anomaly detection job. It can be a job identifier, a group name, a comma-separated list of jobs or groups, or a wildcard expression. You can summarize the bucket results for all anomaly detection jobs by using `_all` or by specifying `*` as the ``. | +| `overall_score` | [double](./double.md) | string | Refer to the description for the `overall_score` query parameter. | +| `querystring` | { [key: string]: any; } & { job_id?: never; allow_no_match?: never; bucket_span?: never; end?: never; exclude_interim?: never; overall_score?: never; start?: never; top_n?: never; } | All values in `querystring` will be added to the request querystring. | +| `start` | [DateTime](./DateTime.md) | Refer to the description for the `start` query parameter. | +| `top_n` | [integer](./integer.md) | Refer to the description for the `top_n` query parameter. | diff --git a/docs/reference/api/MlGetOverallBucketsResponse.md b/docs/reference/api/MlGetOverallBucketsResponse.md new file mode 100644 index 000000000..a15617928 --- /dev/null +++ b/docs/reference/api/MlGetOverallBucketsResponse.md @@ -0,0 +1,6 @@ +## Interface `MlGetOverallBucketsResponse` + +| Name | Type | Description | +| - | - | - | +| `count` | [long](./long.md) |   | +| `overall_buckets` | [MlOverallBucket](./MlOverallBucket.md)[] | Array of overall bucket objects | diff --git a/docs/reference/api/MlGetRecordsRequest.md b/docs/reference/api/MlGetRecordsRequest.md new file mode 100644 index 000000000..b83ffed63 --- /dev/null +++ b/docs/reference/api/MlGetRecordsRequest.md @@ -0,0 +1,16 @@ +## Interface `MlGetRecordsRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { job_id?: never; from?: never; size?: never; desc?: never; end?: never; exclude_interim?: never; page?: never; record_score?: never; sort?: never; start?: never; }) | All values in `body` will be added to the request body. | +| `desc` | boolean | Refer to the description for the `desc` query parameter. | +| `end` | [DateTime](./DateTime.md) | Refer to the description for the `end` query parameter. | +| `exclude_interim` | boolean | Refer to the description for the `exclude_interim` query parameter. | +| `from` | [integer](./integer.md) | Skips the specified number of records. | +| `job_id` | [Id](./Id.md) | Identifier for the anomaly detection job. | +| `page` | [MlPage](./MlPage.md) |   | +| `querystring` | { [key: string]: any; } & { job_id?: never; from?: never; size?: never; desc?: never; end?: never; exclude_interim?: never; page?: never; record_score?: never; sort?: never; start?: never; } | All values in `querystring` will be added to the request querystring. | +| `record_score` | [double](./double.md) | Refer to the description for the `record_score` query parameter. | +| `size` | [integer](./integer.md) | Specifies the maximum number of records to obtain. | +| `sort` | [Field](./Field.md) | Refer to the description for the `sort` query parameter. | +| `start` | [DateTime](./DateTime.md) | Refer to the description for the `start` query parameter. | diff --git a/docs/reference/api/MlGetRecordsResponse.md b/docs/reference/api/MlGetRecordsResponse.md new file mode 100644 index 000000000..a33b0af34 --- /dev/null +++ b/docs/reference/api/MlGetRecordsResponse.md @@ -0,0 +1,6 @@ +## Interface `MlGetRecordsResponse` + +| Name | Type | Description | +| - | - | - | +| `count` | [long](./long.md) |   | +| `records` | [MlAnomaly](./MlAnomaly.md)[] |   | diff --git a/docs/reference/api/MlGetTrainedModelsRequest.md b/docs/reference/api/MlGetTrainedModelsRequest.md new file mode 100644 index 000000000..1bd8b6e3e --- /dev/null +++ b/docs/reference/api/MlGetTrainedModelsRequest.md @@ -0,0 +1,14 @@ +## Interface `MlGetTrainedModelsRequest` + +| Name | Type | Description | +| - | - | - | +| `allow_no_match` | boolean | Specifies what to do when the request: - Contains wildcard expressions and there are no models that match. - Contains the _all string or no identifiers and there are no matches. - Contains wildcard expressions and there are only partial matches. If true, it returns an empty array when there are no matches and the subset of results when there are partial matches. | +| `body` | string | ({ [key: string]: any; } & { model_id?: never; allow_no_match?: never; decompress_definition?: never; exclude_generated?: never; from?: never; include?: never; size?: never; tags?: never; }) | All values in `body` will be added to the request body. | +| `decompress_definition` | boolean | Specifies whether the included model definition should be returned as a JSON map (true) or in a custom compressed format (false). | +| `exclude_generated` | boolean | Indicates if certain fields should be removed from the configuration on retrieval. This allows the configuration to be in an acceptable format to be retrieved and then added to another cluster. | +| `from` | [integer](./integer.md) | Skips the specified number of models. | +| `include` | [MlInclude](./MlInclude.md) | A comma delimited string of optional fields to include in the response body. | +| `model_id` | [Ids](./Ids.md) | The unique identifier of the trained model or a model alias. You can get information for multiple trained models in a single API request by using a comma-separated list of model IDs or a wildcard expression. | +| `querystring` | { [key: string]: any; } & { model_id?: never; allow_no_match?: never; decompress_definition?: never; exclude_generated?: never; from?: never; include?: never; size?: never; tags?: never; } | All values in `querystring` will be added to the request querystring. | +| `size` | [integer](./integer.md) | Specifies the maximum number of models to obtain. | +| `tags` | string | string[] | A comma delimited string of tags. A trained model can have many tags, or none. When supplied, only trained models that contain all the supplied tags are returned. | diff --git a/docs/reference/api/MlGetTrainedModelsResponse.md b/docs/reference/api/MlGetTrainedModelsResponse.md new file mode 100644 index 000000000..f9d53be0b --- /dev/null +++ b/docs/reference/api/MlGetTrainedModelsResponse.md @@ -0,0 +1,6 @@ +## Interface `MlGetTrainedModelsResponse` + +| Name | Type | Description | +| - | - | - | +| `count` | [integer](./integer.md) |   | +| `trained_model_configs` | [MlTrainedModelConfig](./MlTrainedModelConfig.md)[] | An array of trained model resources, which are sorted by the model_id value in ascending order. | diff --git a/docs/reference/api/MlGetTrainedModelsStatsRequest.md b/docs/reference/api/MlGetTrainedModelsStatsRequest.md new file mode 100644 index 000000000..5b416d91b --- /dev/null +++ b/docs/reference/api/MlGetTrainedModelsStatsRequest.md @@ -0,0 +1,10 @@ +## Interface `MlGetTrainedModelsStatsRequest` + +| Name | Type | Description | +| - | - | - | +| `allow_no_match` | boolean | Specifies what to do when the request: - Contains wildcard expressions and there are no models that match. - Contains the _all string or no identifiers and there are no matches. - Contains wildcard expressions and there are only partial matches. If true, it returns an empty array when there are no matches and the subset of results when there are partial matches. | +| `body` | string | ({ [key: string]: any; } & { model_id?: never; allow_no_match?: never; from?: never; size?: never; }) | All values in `body` will be added to the request body. | +| `from` | [integer](./integer.md) | Skips the specified number of models. | +| `model_id` | [Ids](./Ids.md) | The unique identifier of the trained model or a model alias. It can be a comma-separated list or a wildcard expression. | +| `querystring` | { [key: string]: any; } & { model_id?: never; allow_no_match?: never; from?: never; size?: never; } | All values in `querystring` will be added to the request querystring. | +| `size` | [integer](./integer.md) | Specifies the maximum number of models to obtain. | diff --git a/docs/reference/api/MlGetTrainedModelsStatsResponse.md b/docs/reference/api/MlGetTrainedModelsStatsResponse.md new file mode 100644 index 000000000..d3c2092b6 --- /dev/null +++ b/docs/reference/api/MlGetTrainedModelsStatsResponse.md @@ -0,0 +1,6 @@ +## Interface `MlGetTrainedModelsStatsResponse` + +| Name | Type | Description | +| - | - | - | +| `count` | [integer](./integer.md) | The total number of trained model statistics that matched the requested ID patterns. Could be higher than the number of items in the trained_model_stats array as the size of the array is restricted by the supplied size parameter. | +| `trained_model_stats` | [MlTrainedModelStats](./MlTrainedModelStats.md)[] | An array of trained model statistics, which are sorted by the model_id value in ascending order. | diff --git a/docs/reference/api/MlHyperparameter.md b/docs/reference/api/MlHyperparameter.md new file mode 100644 index 000000000..804399163 --- /dev/null +++ b/docs/reference/api/MlHyperparameter.md @@ -0,0 +1,9 @@ +## Interface `MlHyperparameter` + +| Name | Type | Description | +| - | - | - | +| `absolute_importance` | [double](./double.md) | A positive number showing how much the parameter influences the variation of the loss function. For hyperparameters with values that are not specified by the user but tuned during hyperparameter optimization. | +| `name` | [Name](./Name.md) | Name of the hyperparameter. | +| `relative_importance` | [double](./double.md) | A number between 0 and 1 showing the proportion of influence on the variation of the loss function among all tuned hyperparameters. For hyperparameters with values that are not specified by the user but tuned during hyperparameter optimization. | +| `supplied` | boolean | Indicates if the hyperparameter is specified by the user (true) or optimized (false). | +| `value` | [double](./double.md) | The value of the hyperparameter, either optimized or specified by the user. | diff --git a/docs/reference/api/MlHyperparameters.md b/docs/reference/api/MlHyperparameters.md new file mode 100644 index 000000000..e4b7870e1 --- /dev/null +++ b/docs/reference/api/MlHyperparameters.md @@ -0,0 +1,18 @@ +## Interface `MlHyperparameters` + +| Name | Type | Description | +| - | - | - | +| `alpha` | [double](./double.md) | Advanced configuration option. Machine learning uses loss guided tree growing, which means that the decision trees grow where the regularized loss decreases most quickly. This parameter affects loss calculations by acting as a multiplier of the tree depth. Higher alpha values result in shallower trees and faster training times. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to zero. | +| `downsample_factor` | [double](./double.md) | Advanced configuration option. Controls the fraction of data that is used to compute the derivatives of the loss function for tree training. A small value results in the use of a small fraction of the data. If this value is set to be less than 1, accuracy typically improves. However, too small a value may result in poor convergence for the ensemble and so require more trees. By default, this value is calculated during hyperparameter optimization. It must be greater than zero and less than or equal to 1. | +| `eta_growth_rate_per_tree` | [double](./double.md) | Advanced configuration option. Specifies the rate at which `eta` increases for each new tree that is added to the forest. For example, a rate of 1.05 increases `eta` by 5% for each extra tree. By default, this value is calculated during hyperparameter optimization. It must be between `0.5` and `2`. | +| `eta` | [double](./double.md) | Advanced configuration option. The shrinkage applied to the weights. Smaller values result in larger forests which have a better generalization error. However, larger forests cause slower training. By default, this value is calculated during hyperparameter optimization. It must be a value between `0.001` and `1`. | +| `feature_bag_fraction` | [double](./double.md) | Advanced configuration option. Defines the fraction of features that will be used when selecting a random bag for each candidate split. By default, this value is calculated during hyperparameter optimization. | +| `gamma` | [double](./double.md) | Advanced configuration option. Regularization parameter to prevent overfitting on the training data set. Multiplies a linear penalty associated with the size of individual trees in the forest. A high gamma value causes training to prefer small trees. A small gamma value results in larger individual trees and slower training. By default, this value is calculated during hyperparameter optimization. It must be a nonnegative value. | +| `lambda` | [double](./double.md) | Advanced configuration option. Regularization parameter to prevent overfitting on the training data set. Multiplies an L2 regularization term which applies to leaf weights of the individual trees in the forest. A high lambda value causes training to favor small leaf weights. This behavior makes the prediction function smoother at the expense of potentially not being able to capture relevant relationships between the features and the dependent variable. A small lambda value results in large individual trees and slower training. By default, this value is calculated during hyperparameter optimization. It must be a nonnegative value. | +| `max_attempts_to_add_tree` | [integer](./integer.md) | If the algorithm fails to determine a non-trivial tree (more than a single leaf), this parameter determines how many of such consecutive failures are tolerated. Once the number of attempts exceeds the threshold, the forest training stops. | +| `max_optimization_rounds_per_hyperparameter` | [integer](./integer.md) | Advanced configuration option. A multiplier responsible for determining the maximum number of hyperparameter optimization steps in the Bayesian optimization procedure. The maximum number of steps is determined based on the number of undefined hyperparameters times the maximum optimization rounds per hyperparameter. By default, this value is calculated during hyperparameter optimization. | +| `max_trees` | [integer](./integer.md) | Advanced configuration option. Defines the maximum number of decision trees in the forest. The maximum value is 2000. By default, this value is calculated during hyperparameter optimization. | +| `num_folds` | [integer](./integer.md) | The maximum number of folds for the cross-validation procedure. | +| `num_splits_per_feature` | [integer](./integer.md) | Determines the maximum number of splits for every feature that can occur in a decision tree when the tree is trained. | +| `soft_tree_depth_limit` | [integer](./integer.md) | Advanced configuration option. Machine learning uses loss guided tree growing, which means that the decision trees grow where the regularized loss decreases most quickly. This soft limit combines with the `soft_tree_depth_tolerance` to penalize trees that exceed the specified depth; the regularized loss increases quickly beyond this depth. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to 0. | +| `soft_tree_depth_tolerance` | [double](./double.md) | Advanced configuration option. This option controls how quickly the regularized loss increases when the tree depth exceeds `soft_tree_depth_limit`. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to 0.01. | diff --git a/docs/reference/api/MlInclude.md b/docs/reference/api/MlInclude.md new file mode 100644 index 000000000..cd442795c --- /dev/null +++ b/docs/reference/api/MlInclude.md @@ -0,0 +1,4 @@ +## `MlInclude` +::: +type MlInclude = 'definition' | 'feature_importance_baseline' | 'hyperparameters' | 'total_feature_importance' | 'definition_status'; +::: diff --git a/docs/reference/api/MlInferTrainedModelRequest.md b/docs/reference/api/MlInferTrainedModelRequest.md new file mode 100644 index 000000000..1f1c758a5 --- /dev/null +++ b/docs/reference/api/MlInferTrainedModelRequest.md @@ -0,0 +1,10 @@ +## Interface `MlInferTrainedModelRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { model_id?: never; timeout?: never; docs?: never; inference_config?: never; }) | All values in `body` will be added to the request body. | +| `docs` | Record[] | An array of objects to pass to the model for inference. The objects should contain a fields matching your configured trained model input. Typically, for NLP models, the field name is `text_field`. Currently, for NLP models, only a single value is allowed. | +| `inference_config` | [MlInferenceConfigUpdateContainer](./MlInferenceConfigUpdateContainer.md) | The inference configuration updates to apply on the API call | +| `model_id` | [Id](./Id.md) | The unique identifier of the trained model. | +| `querystring` | { [key: string]: any; } & { model_id?: never; timeout?: never; docs?: never; inference_config?: never; } | All values in `querystring` will be added to the request querystring. | +| `timeout` | [Duration](./Duration.md) | Controls the amount of time to wait for inference results. | diff --git a/docs/reference/api/MlInferTrainedModelResponse.md b/docs/reference/api/MlInferTrainedModelResponse.md new file mode 100644 index 000000000..923902d13 --- /dev/null +++ b/docs/reference/api/MlInferTrainedModelResponse.md @@ -0,0 +1,5 @@ +## Interface `MlInferTrainedModelResponse` + +| Name | Type | Description | +| - | - | - | +| `inference_results` | [MlInferenceResponseResult](./MlInferenceResponseResult.md)[] |   | diff --git a/docs/reference/api/MlInferenceConfigCreateContainer.md b/docs/reference/api/MlInferenceConfigCreateContainer.md new file mode 100644 index 000000000..40c2cc89e --- /dev/null +++ b/docs/reference/api/MlInferenceConfigCreateContainer.md @@ -0,0 +1,15 @@ +## Interface `MlInferenceConfigCreateContainer` + +| Name | Type | Description | +| - | - | - | +| `classification` | [MlClassificationInferenceOptions](./MlClassificationInferenceOptions.md) | Classification configuration for inference. | +| `fill_mask` | [MlFillMaskInferenceOptions](./MlFillMaskInferenceOptions.md) | Fill mask configuration for inference. | +| `learning_to_rank` | [MlLearningToRankConfig](./MlLearningToRankConfig.md) |   | +| `ner` | [MlNerInferenceOptions](./MlNerInferenceOptions.md) | Named entity recognition configuration for inference. | +| `pass_through` | [MlPassThroughInferenceOptions](./MlPassThroughInferenceOptions.md) | Pass through configuration for inference. | +| `question_answering` | [MlQuestionAnsweringInferenceOptions](./MlQuestionAnsweringInferenceOptions.md) | Question answering configuration for inference. | +| `regression` | [MlRegressionInferenceOptions](./MlRegressionInferenceOptions.md) | Regression configuration for inference. | +| `text_classification` | [MlTextClassificationInferenceOptions](./MlTextClassificationInferenceOptions.md) | Text classification configuration for inference. | +| `text_embedding` | [MlTextEmbeddingInferenceOptions](./MlTextEmbeddingInferenceOptions.md) | Text embedding configuration for inference. | +| `text_expansion` | [MlTextExpansionInferenceOptions](./MlTextExpansionInferenceOptions.md) | Text expansion configuration for inference. | +| `zero_shot_classification` | [MlZeroShotClassificationInferenceOptions](./MlZeroShotClassificationInferenceOptions.md) | Zeroshot classification configuration for inference. | diff --git a/docs/reference/api/MlInferenceConfigUpdateContainer.md b/docs/reference/api/MlInferenceConfigUpdateContainer.md new file mode 100644 index 000000000..97ea03655 --- /dev/null +++ b/docs/reference/api/MlInferenceConfigUpdateContainer.md @@ -0,0 +1,14 @@ +## Interface `MlInferenceConfigUpdateContainer` + +| Name | Type | Description | +| - | - | - | +| `classification` | [MlClassificationInferenceOptions](./MlClassificationInferenceOptions.md) | Classification configuration for inference. | +| `fill_mask` | [MlFillMaskInferenceUpdateOptions](./MlFillMaskInferenceUpdateOptions.md) | Fill mask configuration for inference. | +| `ner` | [MlNerInferenceUpdateOptions](./MlNerInferenceUpdateOptions.md) | Named entity recognition configuration for inference. | +| `pass_through` | [MlPassThroughInferenceUpdateOptions](./MlPassThroughInferenceUpdateOptions.md) | Pass through configuration for inference. | +| `question_answering` | [MlQuestionAnsweringInferenceUpdateOptions](./MlQuestionAnsweringInferenceUpdateOptions.md) | Question answering configuration for inference | +| `regression` | [MlRegressionInferenceOptions](./MlRegressionInferenceOptions.md) | Regression configuration for inference. | +| `text_classification` | [MlTextClassificationInferenceUpdateOptions](./MlTextClassificationInferenceUpdateOptions.md) | Text classification configuration for inference. | +| `text_embedding` | [MlTextEmbeddingInferenceUpdateOptions](./MlTextEmbeddingInferenceUpdateOptions.md) | Text embedding configuration for inference. | +| `text_expansion` | [MlTextExpansionInferenceUpdateOptions](./MlTextExpansionInferenceUpdateOptions.md) | Text expansion configuration for inference. | +| `zero_shot_classification` | [MlZeroShotClassificationInferenceUpdateOptions](./MlZeroShotClassificationInferenceUpdateOptions.md) | Zeroshot classification configuration for inference. | diff --git a/docs/reference/api/MlInferenceResponseResult.md b/docs/reference/api/MlInferenceResponseResult.md new file mode 100644 index 000000000..46453675f --- /dev/null +++ b/docs/reference/api/MlInferenceResponseResult.md @@ -0,0 +1,13 @@ +## Interface `MlInferenceResponseResult` + +| Name | Type | Description | +| - | - | - | +| `entities` | [MlTrainedModelEntities](./MlTrainedModelEntities.md)[] | If the model is trained for named entity recognition (NER) tasks, the response contains the recognized entities. | +| `feature_importance` | [MlTrainedModelInferenceFeatureImportance](./MlTrainedModelInferenceFeatureImportance.md)[] | The feature importance for the inference results. Relevant only for classification or regression models | +| `is_truncated` | boolean | Indicates whether the input text was truncated to meet the model's maximum sequence length limit. This property is present only when it is true. | +| `predicted_value_sequence` | string | For fill mask tasks, the response contains the input text sequence with the mask token replaced by the predicted value. Additionally | +| `predicted_value` | [MlPredictedValue](./MlPredictedValue.md) | [MlPredictedValue](./MlPredictedValue.md)[] | If the model is trained for a text classification or zero shot classification task, the response is the predicted class. For named entity recognition (NER) tasks, it contains the annotated text output. For fill mask tasks, it contains the top prediction for replacing the mask token. For text embedding tasks, it contains the raw numerical text embedding values. For regression models, its a numerical value For classification models, it may be an integer, double, boolean or string depending on prediction type | +| `prediction_probability` | [double](./double.md) | Specifies a probability for the predicted value. | +| `prediction_score` | [double](./double.md) | Specifies a confidence score for the predicted value. | +| `top_classes` | [MlTopClassEntry](./MlTopClassEntry.md)[] | For fill mask, text classification, and zero shot classification tasks, the response contains a list of top class entries. | +| `warning` | string | If the request failed, the response contains the reason for the failure. | diff --git a/docs/reference/api/MlInfluence.md b/docs/reference/api/MlInfluence.md new file mode 100644 index 000000000..75eb6a08d --- /dev/null +++ b/docs/reference/api/MlInfluence.md @@ -0,0 +1,6 @@ +## Interface `MlInfluence` + +| Name | Type | Description | +| - | - | - | +| `influencer_field_name` | string |   | +| `influencer_field_values` | string[] |   | diff --git a/docs/reference/api/MlInfluencer.md b/docs/reference/api/MlInfluencer.md new file mode 100644 index 000000000..3081a1a77 --- /dev/null +++ b/docs/reference/api/MlInfluencer.md @@ -0,0 +1,15 @@ +## Interface `MlInfluencer` + +| Name | Type | Description | +| - | - | - | +| `bucket_span` | [DurationValue](./DurationValue.md)<[UnitSeconds](./UnitSeconds.md)> | The length of the bucket in seconds. This value matches the bucket span that is specified in the job. | +| `foo` | string | Additional influencer properties are added, depending on the fields being analyzed. For example, if it’s analyzing `user_name` as an influencer, a field `user_name` is added to the result document. This information enables you to filter the anomaly results more easily. | +| `influencer_field_name` | [Field](./Field.md) | The field name of the influencer. | +| `influencer_field_value` | string | The entity that influenced, contributed to, or was to blame for the anomaly. | +| `influencer_score` | [double](./double.md) | A normalized score between 0-100, which is based on the probability of the influencer in this bucket aggregated across detectors. Unlike `initial_influencer_score`, this value is updated by a re-normalization process as new data is analyzed. | +| `initial_influencer_score` | [double](./double.md) | A normalized score between 0-100, which is based on the probability of the influencer aggregated across detectors. This is the initial value that was calculated at the time the bucket was processed. | +| `is_interim` | boolean | If true, this is an interim result. In other words, the results are calculated based on partial input data. | +| `job_id` | [Id](./Id.md) | Identifier for the anomaly detection job. | +| `probability` | [double](./double.md) | The probability that the influencer has this behavior, in the range 0 to 1. This value can be held to a high precision of over 300 decimal places, so the `influencer_score` is provided as a human-readable and friendly interpretation of this value. | +| `result_type` | string | Internal. This value is always set to `influencer`. | +| `timestamp` | [EpochTime](./EpochTime.md)<[UnitMillis](./UnitMillis.md)> | The start time of the bucket for which these results were calculated. | diff --git a/docs/reference/api/MlInfoAnomalyDetectors.md b/docs/reference/api/MlInfoAnomalyDetectors.md new file mode 100644 index 000000000..837238383 --- /dev/null +++ b/docs/reference/api/MlInfoAnomalyDetectors.md @@ -0,0 +1,9 @@ +## Interface `MlInfoAnomalyDetectors` + +| Name | Type | Description | +| - | - | - | +| `categorization_analyzer` | [MlCategorizationAnalyzer](./MlCategorizationAnalyzer.md) |   | +| `categorization_examples_limit` | [integer](./integer.md) |   | +| `daily_model_snapshot_retention_after_days` | [integer](./integer.md) |   | +| `model_memory_limit` | string |   | +| `model_snapshot_retention_days` | [integer](./integer.md) |   | diff --git a/docs/reference/api/MlInfoDatafeeds.md b/docs/reference/api/MlInfoDatafeeds.md new file mode 100644 index 000000000..0b067500d --- /dev/null +++ b/docs/reference/api/MlInfoDatafeeds.md @@ -0,0 +1,5 @@ +## Interface `MlInfoDatafeeds` + +| Name | Type | Description | +| - | - | - | +| `scroll_size` | [integer](./integer.md) |   | diff --git a/docs/reference/api/MlInfoDefaults.md b/docs/reference/api/MlInfoDefaults.md new file mode 100644 index 000000000..dc6763198 --- /dev/null +++ b/docs/reference/api/MlInfoDefaults.md @@ -0,0 +1,6 @@ +## Interface `MlInfoDefaults` + +| Name | Type | Description | +| - | - | - | +| `anomaly_detectors` | [MlInfoAnomalyDetectors](./MlInfoAnomalyDetectors.md) |   | +| `datafeeds` | [MlInfoDatafeeds](./MlInfoDatafeeds.md) |   | diff --git a/docs/reference/api/MlInfoLimits.md b/docs/reference/api/MlInfoLimits.md new file mode 100644 index 000000000..143655aca --- /dev/null +++ b/docs/reference/api/MlInfoLimits.md @@ -0,0 +1,9 @@ +## Interface `MlInfoLimits` + +| Name | Type | Description | +| - | - | - | +| `effective_max_model_memory_limit` | [ByteSize](./ByteSize.md) |   | +| `max_model_memory_limit` | [ByteSize](./ByteSize.md) |   | +| `max_single_ml_node_processors` | [integer](./integer.md) |   | +| `total_ml_memory` | [ByteSize](./ByteSize.md) |   | +| `total_ml_processors` | [integer](./integer.md) |   | diff --git a/docs/reference/api/MlInfoNativeCode.md b/docs/reference/api/MlInfoNativeCode.md new file mode 100644 index 000000000..288b5812d --- /dev/null +++ b/docs/reference/api/MlInfoNativeCode.md @@ -0,0 +1,6 @@ +## Interface `MlInfoNativeCode` + +| Name | Type | Description | +| - | - | - | +| `build_hash` | string |   | +| `version` | [VersionString](./VersionString.md) |   | diff --git a/docs/reference/api/MlInfoRequest.md b/docs/reference/api/MlInfoRequest.md new file mode 100644 index 000000000..0a8eb8b54 --- /dev/null +++ b/docs/reference/api/MlInfoRequest.md @@ -0,0 +1,6 @@ +## Interface `MlInfoRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | { [key: string]: any; } | All values in `body` will be added to the request body. | +| `querystring` | { [key: string]: any; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/MlInfoResponse.md b/docs/reference/api/MlInfoResponse.md new file mode 100644 index 000000000..9b2049c36 --- /dev/null +++ b/docs/reference/api/MlInfoResponse.md @@ -0,0 +1,8 @@ +## Interface `MlInfoResponse` + +| Name | Type | Description | +| - | - | - | +| `defaults` | [MlInfoDefaults](./MlInfoDefaults.md) |   | +| `limits` | [MlInfoLimits](./MlInfoLimits.md) |   | +| `native_code` | [MlInfoNativeCode](./MlInfoNativeCode.md) |   | +| `upgrade_mode` | boolean |   | diff --git a/docs/reference/api/MlJob.md b/docs/reference/api/MlJob.md new file mode 100644 index 000000000..a81f45932 --- /dev/null +++ b/docs/reference/api/MlJob.md @@ -0,0 +1,27 @@ +## Interface `MlJob` + +| Name | Type | Description | +| - | - | - | +| `allow_lazy_open` | boolean | Advanced configuration option. Specifies whether this job can open when there is insufficient machine learning node capacity for it to be immediately assigned to a node. | +| `analysis_config` | [MlAnalysisConfig](./MlAnalysisConfig.md) | The analysis configuration, which specifies how to analyze the data. After you create a job, you cannot change the analysis configuration; all the properties are informational. | +| `analysis_limits` | [MlAnalysisLimits](./MlAnalysisLimits.md) | Limits can be applied for the resources required to hold the mathematical models in memory. These limits are approximate and can be set per job. They do not control the memory used by other processes, for example the Elasticsearch Java processes. | +| `background_persist_interval` | [Duration](./Duration.md) | Advanced configuration option. The time between each periodic persistence of the model. The default value is a randomized value between 3 to 4 hours, which avoids all jobs persisting at exactly the same time. The smallest allowed value is 1 hour. | +| `blocked` | [MlJobBlocked](./MlJobBlocked.md) |   | +| `create_time` | [DateTime](./DateTime.md) |   | +| `custom_settings` | [MlCustomSettings](./MlCustomSettings.md) | Advanced configuration option. Contains custom metadata about the job. | +| `daily_model_snapshot_retention_after_days` | [long](./long.md) | Advanced configuration option, which affects the automatic removal of old model snapshots for this job. It specifies a period of time (in days) after which only the first snapshot per day is retained. This period is relative to the timestamp of the most recent snapshot for this job. Valid values range from 0 to `model_snapshot_retention_days`. | +| `data_description` | [MlDataDescription](./MlDataDescription.md) | The data description defines the format of the input data when you send data to the job by using the post data API. Note that when configuring a datafeed, these properties are automatically set. When data is received via the post data API, it is not stored in Elasticsearch. Only the results for anomaly detection are retained. | +| `datafeed_config` | [MlDatafeed](./MlDatafeed.md) | The datafeed, which retrieves data from Elasticsearch for analysis by the job. You can associate only one datafeed with each anomaly detection job. | +| `deleting` | boolean | Indicates that the process of deleting the job is in progress but not yet completed. It is only reported when `true`. | +| `description` | string | A description of the job. | +| `finished_time` | [DateTime](./DateTime.md) | If the job closed or failed, this is the time the job finished, otherwise it is `null`. This property is informational; you cannot change its value. | +| `groups` | string[] | A list of job groups. A job can belong to no groups or many. | +| `job_id` | [Id](./Id.md) | Identifier for the anomaly detection job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters. | +| `job_type` | string | Reserved for future use, currently set to `anomaly_detector`. | +| `job_version` | [VersionString](./VersionString.md) | The machine learning configuration version number at which the the job was created. | +| `model_plot_config` | [MlModelPlotConfig](./MlModelPlotConfig.md) | This advanced configuration option stores model information along with the results. It provides a more detailed view into anomaly detection. Model plot provides a simplified and indicative view of the model and its bounds. | +| `model_snapshot_id` | [Id](./Id.md) |   | +| `model_snapshot_retention_days` | [long](./long.md) | Advanced configuration option, which affects the automatic removal of old model snapshots for this job. It specifies the maximum period of time (in days) that snapshots are retained. This period is relative to the timestamp of the most recent snapshot for this job. By default, snapshots ten days older than the newest snapshot are deleted. | +| `renormalization_window_days` | [long](./long.md) | Advanced configuration option. The period over which adjustments to the score are applied, as new data is seen. The default value is the longer of 30 days or 100 `bucket_spans`. | +| `results_index_name` | [IndexName](./IndexName.md) | A text string that affects the name of the machine learning results index. The default value is `shared`, which generates an index named `.ml-anomalies-shared`. | +| `results_retention_days` | [long](./long.md) | Advanced configuration option. The period of time (in days) that results are retained. Age is calculated relative to the timestamp of the latest bucket result. If this property has a non-null value, once per day at 00:30 (server time), results that are the specified number of days older than the latest bucket result are deleted from Elasticsearch. The default value is null, which means all results are retained. Annotations generated by the system also count as results for retention purposes; they are deleted after the same number of days as results. Annotations added by users are retained forever. | diff --git a/docs/reference/api/MlJobBlocked.md b/docs/reference/api/MlJobBlocked.md new file mode 100644 index 000000000..02f06d8ca --- /dev/null +++ b/docs/reference/api/MlJobBlocked.md @@ -0,0 +1,6 @@ +## Interface `MlJobBlocked` + +| Name | Type | Description | +| - | - | - | +| `reason` | [MlJobBlockedReason](./MlJobBlockedReason.md) |   | +| `task_id` | [TaskId](./TaskId.md) |   | diff --git a/docs/reference/api/MlJobBlockedReason.md b/docs/reference/api/MlJobBlockedReason.md new file mode 100644 index 000000000..ae74655d4 --- /dev/null +++ b/docs/reference/api/MlJobBlockedReason.md @@ -0,0 +1,4 @@ +## `MlJobBlockedReason` +::: +type MlJobBlockedReason = 'delete' | 'reset' | 'revert'; +::: diff --git a/docs/reference/api/MlJobConfig.md b/docs/reference/api/MlJobConfig.md new file mode 100644 index 000000000..17af774ff --- /dev/null +++ b/docs/reference/api/MlJobConfig.md @@ -0,0 +1,21 @@ +## Interface `MlJobConfig` + +| Name | Type | Description | +| - | - | - | +| `allow_lazy_open` | boolean | Advanced configuration option. Specifies whether this job can open when there is insufficient machine learning node capacity for it to be immediately assigned to a node. | +| `analysis_config` | [MlAnalysisConfig](./MlAnalysisConfig.md) | The analysis configuration, which specifies how to analyze the data. After you create a job, you cannot change the analysis configuration; all the properties are informational. | +| `analysis_limits` | [MlAnalysisLimits](./MlAnalysisLimits.md) | Limits can be applied for the resources required to hold the mathematical models in memory. These limits are approximate and can be set per job. They do not control the memory used by other processes, for example the Elasticsearch Java processes. | +| `background_persist_interval` | [Duration](./Duration.md) | Advanced configuration option. The time between each periodic persistence of the model. The default value is a randomized value between 3 to 4 hours, which avoids all jobs persisting at exactly the same time. The smallest allowed value is 1 hour. | +| `custom_settings` | [MlCustomSettings](./MlCustomSettings.md) | Advanced configuration option. Contains custom metadata about the job. | +| `daily_model_snapshot_retention_after_days` | [long](./long.md) | Advanced configuration option, which affects the automatic removal of old model snapshots for this job. It specifies a period of time (in days) after which only the first snapshot per day is retained. This period is relative to the timestamp of the most recent snapshot for this job. | +| `data_description` | [MlDataDescription](./MlDataDescription.md) | The data description defines the format of the input data when you send data to the job by using the post data API. Note that when configure a datafeed, these properties are automatically set. | +| `datafeed_config` | [MlDatafeedConfig](./MlDatafeedConfig.md) | The datafeed, which retrieves data from Elasticsearch for analysis by the job. You can associate only one datafeed with each anomaly detection job. | +| `description` | string | A description of the job. | +| `groups` | string[] | A list of job groups. A job can belong to no groups or many. | +| `job_id` | [Id](./Id.md) | Identifier for the anomaly detection job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters. | +| `job_type` | string | Reserved for future use, currently set to `anomaly_detector`. | +| `model_plot_config` | [MlModelPlotConfig](./MlModelPlotConfig.md) | This advanced configuration option stores model information along with the results. It provides a more detailed view into anomaly detection. Model plot provides a simplified and indicative view of the model and its bounds. | +| `model_snapshot_retention_days` | [long](./long.md) | Advanced configuration option, which affects the automatic removal of old model snapshots for this job. It specifies the maximum period of time (in days) that snapshots are retained. This period is relative to the timestamp of the most recent snapshot for this job. The default value is `10`, which means snapshots ten days older than the newest snapshot are deleted. | +| `renormalization_window_days` | [long](./long.md) | Advanced configuration option. The period over which adjustments to the score are applied, as new data is seen. The default value is the longer of 30 days or 100 `bucket_spans`. | +| `results_index_name` | [IndexName](./IndexName.md) | A text string that affects the name of the machine learning results index. The default value is `shared`, which generates an index named `.ml-anomalies-shared`. | +| `results_retention_days` | [long](./long.md) | Advanced configuration option. The period of time (in days) that results are retained. Age is calculated relative to the timestamp of the latest bucket result. If this property has a non-null value, once per day at 00:30 (server time), results that are the specified number of days older than the latest bucket result are deleted from Elasticsearch. The default value is null, which means all results are retained. Annotations generated by the system also count as results for retention purposes; they are deleted after the same number of days as results. Annotations added by users are retained forever. | diff --git a/docs/reference/api/MlJobForecastStatistics.md b/docs/reference/api/MlJobForecastStatistics.md new file mode 100644 index 000000000..fff3077ab --- /dev/null +++ b/docs/reference/api/MlJobForecastStatistics.md @@ -0,0 +1,10 @@ +## Interface `MlJobForecastStatistics` + +| Name | Type | Description | +| - | - | - | +| `forecasted_jobs` | [integer](./integer.md) |   | +| `memory_bytes` | [MlJobStatistics](./MlJobStatistics.md) |   | +| `processing_time_ms` | [MlJobStatistics](./MlJobStatistics.md) |   | +| `records` | [MlJobStatistics](./MlJobStatistics.md) |   | +| `status` | Record |   | +| `total` | [long](./long.md) |   | diff --git a/docs/reference/api/MlJobState.md b/docs/reference/api/MlJobState.md new file mode 100644 index 000000000..802e42799 --- /dev/null +++ b/docs/reference/api/MlJobState.md @@ -0,0 +1,4 @@ +## `MlJobState` +::: +type MlJobState = 'closing' | 'closed' | 'opened' | 'failed' | 'opening'; +::: diff --git a/docs/reference/api/MlJobStatistics.md b/docs/reference/api/MlJobStatistics.md new file mode 100644 index 000000000..cf507cd56 --- /dev/null +++ b/docs/reference/api/MlJobStatistics.md @@ -0,0 +1,8 @@ +## Interface `MlJobStatistics` + +| Name | Type | Description | +| - | - | - | +| `avg` | [double](./double.md) |   | +| `max` | [double](./double.md) |   | +| `min` | [double](./double.md) |   | +| `total` | [double](./double.md) |   | diff --git a/docs/reference/api/MlJobStats.md b/docs/reference/api/MlJobStats.md new file mode 100644 index 000000000..340b21c37 --- /dev/null +++ b/docs/reference/api/MlJobStats.md @@ -0,0 +1,14 @@ +## Interface `MlJobStats` + +| Name | Type | Description | +| - | - | - | +| `assignment_explanation` | string | For open anomaly detection jobs only, contains messages relating to the selection of a node to run the job. | +| `data_counts` | [MlDataCounts](./MlDataCounts.md) | An object that describes the quantity of input to the job and any related error counts. The `data_count` values are cumulative for the lifetime of a job. If a model snapshot is reverted or old results are deleted, the job counts are not reset. | +| `deleting` | boolean | Indicates that the process of deleting the job is in progress but not yet completed. It is only reported when `true`. | +| `forecasts_stats` | [MlJobForecastStatistics](./MlJobForecastStatistics.md) | An object that provides statistical information about forecasts belonging to this job. Some statistics are omitted if no forecasts have been made. | +| `job_id` | string | Identifier for the anomaly detection job. | +| `model_size_stats` | [MlModelSizeStats](./MlModelSizeStats.md) | An object that provides information about the size and contents of the model. | +| `node` | [MlDiscoveryNodeCompact](./MlDiscoveryNodeCompact.md) | Contains properties for the node that runs the job. This information is available only for open jobs. | +| `open_time` | [DateTime](./DateTime.md) | For open jobs only, the elapsed time for which the job has been open. | +| `state` | [MlJobState](./MlJobState.md) | The status of the anomaly detection job, which can be one of the following values: `closed`, `closing`, `failed`, `opened`, `opening`. | +| `timing_stats` | [MlJobTimingStats](./MlJobTimingStats.md) | An object that provides statistical information about timing aspect of this job. | diff --git a/docs/reference/api/MlJobTimingStats.md b/docs/reference/api/MlJobTimingStats.md new file mode 100644 index 000000000..e58b1c418 --- /dev/null +++ b/docs/reference/api/MlJobTimingStats.md @@ -0,0 +1,12 @@ +## Interface `MlJobTimingStats` + +| Name | Type | Description | +| - | - | - | +| `average_bucket_processing_time_ms` | [DurationValue](./DurationValue.md)<[UnitFloatMillis](./UnitFloatMillis.md)> |   | +| `bucket_count` | [long](./long.md) |   | +| `exponential_average_bucket_processing_time_ms` | [DurationValue](./DurationValue.md)<[UnitFloatMillis](./UnitFloatMillis.md)> |   | +| `exponential_average_bucket_processing_time_per_hour_ms` | [DurationValue](./DurationValue.md)<[UnitFloatMillis](./UnitFloatMillis.md)> |   | +| `job_id` | [Id](./Id.md) |   | +| `maximum_bucket_processing_time_ms` | [DurationValue](./DurationValue.md)<[UnitFloatMillis](./UnitFloatMillis.md)> |   | +| `minimum_bucket_processing_time_ms` | [DurationValue](./DurationValue.md)<[UnitFloatMillis](./UnitFloatMillis.md)> |   | +| `total_bucket_processing_time_ms` | [DurationValue](./DurationValue.md)<[UnitFloatMillis](./UnitFloatMillis.md)> |   | diff --git a/docs/reference/api/MlLearningToRankConfig.md b/docs/reference/api/MlLearningToRankConfig.md new file mode 100644 index 000000000..5f390a3b6 --- /dev/null +++ b/docs/reference/api/MlLearningToRankConfig.md @@ -0,0 +1,7 @@ +## Interface `MlLearningToRankConfig` + +| Name | Type | Description | +| - | - | - | +| `default_params` | Record |   | +| `feature_extractors` | Record[] |   | +| `num_top_feature_importance_values` | [integer](./integer.md) |   | diff --git a/docs/reference/api/MlMemoryStatus.md b/docs/reference/api/MlMemoryStatus.md new file mode 100644 index 000000000..093328d96 --- /dev/null +++ b/docs/reference/api/MlMemoryStatus.md @@ -0,0 +1,4 @@ +## `MlMemoryStatus` +::: +type MlMemoryStatus = 'ok' | 'soft_limit' | 'hard_limit'; +::: diff --git a/docs/reference/api/MlModelPackageConfig.md b/docs/reference/api/MlModelPackageConfig.md new file mode 100644 index 000000000..5f948fb0e --- /dev/null +++ b/docs/reference/api/MlModelPackageConfig.md @@ -0,0 +1,18 @@ +## Interface `MlModelPackageConfig` + +| Name | Type | Description | +| - | - | - | +| `create_time` | [EpochTime](./EpochTime.md)<[UnitMillis](./UnitMillis.md)> |   | +| `description` | string |   | +| `inference_config` | Record |   | +| `metadata` | [Metadata](./Metadata.md) |   | +| `minimum_version` | string |   | +| `model_repository` | string |   | +| `model_type` | string |   | +| `packaged_model_id` | [Id](./Id.md) |   | +| `platform_architecture` | string |   | +| `prefix_strings` | [MlTrainedModelPrefixStrings](./MlTrainedModelPrefixStrings.md) |   | +| `sha256` | string |   | +| `size` | [ByteSize](./ByteSize.md) |   | +| `tags` | string[] |   | +| `vocabulary_file` | string |   | diff --git a/docs/reference/api/MlModelPlotConfig.md b/docs/reference/api/MlModelPlotConfig.md new file mode 100644 index 000000000..e645bbb1c --- /dev/null +++ b/docs/reference/api/MlModelPlotConfig.md @@ -0,0 +1,7 @@ +## Interface `MlModelPlotConfig` + +| Name | Type | Description | +| - | - | - | +| `annotations_enabled` | boolean | If true, enables calculation and storage of the model change annotations for each entity that is being analyzed. | +| `enabled` | boolean | If true, enables calculation and storage of the model bounds for each entity that is being analyzed. | +| `terms` | [Field](./Field.md) | Limits data collection to this comma separated list of partition or by field values. If terms are not specified or it is an empty string, no filtering is applied. Wildcards are not supported. Only the specified terms can be viewed when using the Single Metric Viewer. | diff --git a/docs/reference/api/MlModelSizeStats.md b/docs/reference/api/MlModelSizeStats.md new file mode 100644 index 000000000..7259fcacc --- /dev/null +++ b/docs/reference/api/MlModelSizeStats.md @@ -0,0 +1,26 @@ +## Interface `MlModelSizeStats` + +| Name | Type | Description | +| - | - | - | +| `assignment_memory_basis` | string |   | +| `bucket_allocation_failures_count` | [long](./long.md) |   | +| `categorization_status` | [MlCategorizationStatus](./MlCategorizationStatus.md) |   | +| `categorized_doc_count` | [integer](./integer.md) |   | +| `dead_category_count` | [integer](./integer.md) |   | +| `failed_category_count` | [integer](./integer.md) |   | +| `frequent_category_count` | [integer](./integer.md) |   | +| `job_id` | [Id](./Id.md) |   | +| `log_time` | [DateTime](./DateTime.md) |   | +| `memory_status` | [MlMemoryStatus](./MlMemoryStatus.md) |   | +| `model_bytes_exceeded` | [ByteSize](./ByteSize.md) |   | +| `model_bytes_memory_limit` | [ByteSize](./ByteSize.md) |   | +| `model_bytes` | [ByteSize](./ByteSize.md) |   | +| `output_memory_allocator_bytes` | [ByteSize](./ByteSize.md) |   | +| `peak_model_bytes` | [ByteSize](./ByteSize.md) |   | +| `rare_category_count` | [integer](./integer.md) |   | +| `result_type` | string |   | +| `timestamp` | [long](./long.md) |   | +| `total_by_field_count` | [long](./long.md) |   | +| `total_category_count` | [integer](./integer.md) |   | +| `total_over_field_count` | [long](./long.md) |   | +| `total_partition_field_count` | [long](./long.md) |   | diff --git a/docs/reference/api/MlModelSnapshot.md b/docs/reference/api/MlModelSnapshot.md new file mode 100644 index 000000000..7c2eda368 --- /dev/null +++ b/docs/reference/api/MlModelSnapshot.md @@ -0,0 +1,14 @@ +## Interface `MlModelSnapshot` + +| Name | Type | Description | +| - | - | - | +| `description` | string | An optional description of the job. | +| `job_id` | [Id](./Id.md) | A numerical character string that uniquely identifies the job that the snapshot was created for. | +| `latest_record_time_stamp` | [integer](./integer.md) | The timestamp of the latest processed record. | +| `latest_result_time_stamp` | [integer](./integer.md) | The timestamp of the latest bucket result. | +| `min_version` | [VersionString](./VersionString.md) | The minimum version required to be able to restore the model snapshot. | +| `model_size_stats` | [MlModelSizeStats](./MlModelSizeStats.md) | Summary information describing the model. | +| `retain` | boolean | If true, this snapshot will not be deleted during automatic cleanup of snapshots older than model_snapshot_retention_days. However, this snapshot will be deleted when the job is deleted. The default value is false. | +| `snapshot_doc_count` | [long](./long.md) | For internal use only. | +| `snapshot_id` | [Id](./Id.md) | A numerical character string that uniquely identifies the model snapshot. | +| `timestamp` | [long](./long.md) | The creation timestamp for the snapshot. | diff --git a/docs/reference/api/MlModelSnapshotUpgrade.md b/docs/reference/api/MlModelSnapshotUpgrade.md new file mode 100644 index 000000000..874858c74 --- /dev/null +++ b/docs/reference/api/MlModelSnapshotUpgrade.md @@ -0,0 +1,9 @@ +## Interface `MlModelSnapshotUpgrade` + +| Name | Type | Description | +| - | - | - | +| `assignment_explanation` | string |   | +| `job_id` | [Id](./Id.md) |   | +| `node` | [MlDiscoveryNode](./MlDiscoveryNode.md) |   | +| `snapshot_id` | [Id](./Id.md) |   | +| `state` | [MlSnapshotUpgradeState](./MlSnapshotUpgradeState.md) |   | diff --git a/docs/reference/api/MlNerInferenceOptions.md b/docs/reference/api/MlNerInferenceOptions.md new file mode 100644 index 000000000..049163f9d --- /dev/null +++ b/docs/reference/api/MlNerInferenceOptions.md @@ -0,0 +1,8 @@ +## Interface `MlNerInferenceOptions` + +| Name | Type | Description | +| - | - | - | +| `classification_labels` | string[] | The token classification labels. Must be IOB formatted tags | +| `results_field` | string | The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. | +| `tokenization` | [MlTokenizationConfigContainer](./MlTokenizationConfigContainer.md) | The tokenization options | +| `vocabulary` | [MlVocabulary](./MlVocabulary.md) |   | diff --git a/docs/reference/api/MlNerInferenceUpdateOptions.md b/docs/reference/api/MlNerInferenceUpdateOptions.md new file mode 100644 index 000000000..f9565f390 --- /dev/null +++ b/docs/reference/api/MlNerInferenceUpdateOptions.md @@ -0,0 +1,6 @@ +## Interface `MlNerInferenceUpdateOptions` + +| Name | Type | Description | +| - | - | - | +| `results_field` | string | The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. | +| `tokenization` | [MlNlpTokenizationUpdateOptions](./MlNlpTokenizationUpdateOptions.md) | The tokenization options to update when inferring | diff --git a/docs/reference/api/MlNlpBertTokenizationConfig.md b/docs/reference/api/MlNlpBertTokenizationConfig.md new file mode 100644 index 000000000..574b9853a --- /dev/null +++ b/docs/reference/api/MlNlpBertTokenizationConfig.md @@ -0,0 +1,4 @@ +## Interface `MlNlpBertTokenizationConfig` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/MlNlpRobertaTokenizationConfig.md b/docs/reference/api/MlNlpRobertaTokenizationConfig.md new file mode 100644 index 000000000..93460432c --- /dev/null +++ b/docs/reference/api/MlNlpRobertaTokenizationConfig.md @@ -0,0 +1,5 @@ +## Interface `MlNlpRobertaTokenizationConfig` + +| Name | Type | Description | +| - | - | - | +| `add_prefix_space` | boolean | Should the tokenizer prefix input with a space character | diff --git a/docs/reference/api/MlNlpTokenizationUpdateOptions.md b/docs/reference/api/MlNlpTokenizationUpdateOptions.md new file mode 100644 index 000000000..e1d180db6 --- /dev/null +++ b/docs/reference/api/MlNlpTokenizationUpdateOptions.md @@ -0,0 +1,6 @@ +## Interface `MlNlpTokenizationUpdateOptions` + +| Name | Type | Description | +| - | - | - | +| `span` | [integer](./integer.md) | Span options to apply | +| `truncate` | [MlTokenizationTruncate](./MlTokenizationTruncate.md) | Truncate options to apply | diff --git a/docs/reference/api/MlOpenJobRequest.md b/docs/reference/api/MlOpenJobRequest.md new file mode 100644 index 000000000..f3c4ffeb5 --- /dev/null +++ b/docs/reference/api/MlOpenJobRequest.md @@ -0,0 +1,8 @@ +## Interface `MlOpenJobRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { job_id?: never; timeout?: never; }) | All values in `body` will be added to the request body. | +| `job_id` | [Id](./Id.md) | Identifier for the anomaly detection job. | +| `querystring` | { [key: string]: any; } & { job_id?: never; timeout?: never; } | All values in `querystring` will be added to the request querystring. | +| `timeout` | [Duration](./Duration.md) | Refer to the description for the `timeout` query parameter. | diff --git a/docs/reference/api/MlOpenJobResponse.md b/docs/reference/api/MlOpenJobResponse.md new file mode 100644 index 000000000..9286869c6 --- /dev/null +++ b/docs/reference/api/MlOpenJobResponse.md @@ -0,0 +1,6 @@ +## Interface `MlOpenJobResponse` + +| Name | Type | Description | +| - | - | - | +| `node` | [NodeId](./NodeId.md) | The ID of the node that the job was started on. In serverless this will be the "serverless". If the job is allowed to open lazily and has not yet been assigned to a node, this value is an empty string. | +| `opened` | boolean |   | diff --git a/docs/reference/api/MlOutlierDetectionParameters.md b/docs/reference/api/MlOutlierDetectionParameters.md new file mode 100644 index 000000000..f9579ba7f --- /dev/null +++ b/docs/reference/api/MlOutlierDetectionParameters.md @@ -0,0 +1,10 @@ +## Interface `MlOutlierDetectionParameters` + +| Name | Type | Description | +| - | - | - | +| `compute_feature_influence` | boolean | Specifies whether the feature influence calculation is enabled. | +| `feature_influence_threshold` | [double](./double.md) | The minimum outlier score that a document needs to have in order to calculate its feature influence score. Value range: 0-1 | +| `method` | string | The method that outlier detection uses. Available methods are `lof`, `ldof`, `distance_kth_nn`, `distance_knn`, and `ensemble`. The default value is ensemble, which means that outlier detection uses an ensemble of different methods and normalises and combines their individual outlier scores to obtain the overall outlier score. | +| `n_neighbors` | [integer](./integer.md) | Defines the value for how many nearest neighbors each method of outlier detection uses to calculate its outlier score. When the value is not set, different values are used for different ensemble members. This default behavior helps improve the diversity in the ensemble; only override it if you are confident that the value you choose is appropriate for the data set. | +| `outlier_fraction` | [double](./double.md) | The proportion of the data set that is assumed to be outlying prior to outlier detection. For example, 0.05 means it is assumed that 5% of values are real outliers and 95% are inliers. | +| `standardization_enabled` | boolean | If `true`, the following operation is performed on the columns before computing outlier scores: (x_i - mean(x_i)) / sd(x_i). | diff --git a/docs/reference/api/MlOverallBucket.md b/docs/reference/api/MlOverallBucket.md new file mode 100644 index 000000000..723d1b3d7 --- /dev/null +++ b/docs/reference/api/MlOverallBucket.md @@ -0,0 +1,11 @@ +## Interface `MlOverallBucket` + +| Name | Type | Description | +| - | - | - | +| `bucket_span` | [DurationValue](./DurationValue.md)<[UnitSeconds](./UnitSeconds.md)> | The length of the bucket in seconds. Matches the job with the longest bucket_span value. | +| `is_interim` | boolean | If true, this is an interim result. In other words, the results are calculated based on partial input data. | +| `jobs` | [MlOverallBucketJob](./MlOverallBucketJob.md)[] | An array of objects that contain the max_anomaly_score per job_id. | +| `overall_score` | [double](./double.md) | The top_n average of the maximum bucket anomaly_score per job. | +| `result_type` | string | Internal. This is always set to overall_bucket. | +| `timestamp_string` | [DateTime](./DateTime.md) | The start time of the bucket for which these results were calculated. | +| `timestamp` | [EpochTime](./EpochTime.md)<[UnitMillis](./UnitMillis.md)> | The start time of the bucket for which these results were calculated. | diff --git a/docs/reference/api/MlOverallBucketJob.md b/docs/reference/api/MlOverallBucketJob.md new file mode 100644 index 000000000..422d0a8b9 --- /dev/null +++ b/docs/reference/api/MlOverallBucketJob.md @@ -0,0 +1,6 @@ +## Interface `MlOverallBucketJob` + +| Name | Type | Description | +| - | - | - | +| `job_id` | [Id](./Id.md) |   | +| `max_anomaly_score` | [double](./double.md) |   | diff --git a/docs/reference/api/MlPage.md b/docs/reference/api/MlPage.md new file mode 100644 index 000000000..c7e32abd0 --- /dev/null +++ b/docs/reference/api/MlPage.md @@ -0,0 +1,6 @@ +## Interface `MlPage` + +| Name | Type | Description | +| - | - | - | +| `from` | [integer](./integer.md) | Skips the specified number of items. | +| `size` | [integer](./integer.md) | Specifies the maximum number of items to obtain. | diff --git a/docs/reference/api/MlPassThroughInferenceOptions.md b/docs/reference/api/MlPassThroughInferenceOptions.md new file mode 100644 index 000000000..36f4aab45 --- /dev/null +++ b/docs/reference/api/MlPassThroughInferenceOptions.md @@ -0,0 +1,7 @@ +## Interface `MlPassThroughInferenceOptions` + +| Name | Type | Description | +| - | - | - | +| `results_field` | string | The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. | +| `tokenization` | [MlTokenizationConfigContainer](./MlTokenizationConfigContainer.md) | The tokenization options | +| `vocabulary` | [MlVocabulary](./MlVocabulary.md) |   | diff --git a/docs/reference/api/MlPassThroughInferenceUpdateOptions.md b/docs/reference/api/MlPassThroughInferenceUpdateOptions.md new file mode 100644 index 000000000..0558f00ea --- /dev/null +++ b/docs/reference/api/MlPassThroughInferenceUpdateOptions.md @@ -0,0 +1,6 @@ +## Interface `MlPassThroughInferenceUpdateOptions` + +| Name | Type | Description | +| - | - | - | +| `results_field` | string | The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. | +| `tokenization` | [MlNlpTokenizationUpdateOptions](./MlNlpTokenizationUpdateOptions.md) | The tokenization options to update when inferring | diff --git a/docs/reference/api/MlPerPartitionCategorization.md b/docs/reference/api/MlPerPartitionCategorization.md new file mode 100644 index 000000000..c2f31b6fb --- /dev/null +++ b/docs/reference/api/MlPerPartitionCategorization.md @@ -0,0 +1,6 @@ +## Interface `MlPerPartitionCategorization` + +| Name | Type | Description | +| - | - | - | +| `enabled` | boolean | To enable this setting, you must also set the `partition_field_name` property to the same value in every detector that uses the keyword `mlcategory`. Otherwise, job creation fails. | +| `stop_on_warn` | boolean | This setting can be set to true only if per-partition categorization is enabled. If true, both categorization and subsequent anomaly detection stops for partitions where the categorization status changes to warn. This setting makes it viable to have a job where it is expected that categorization works well for some partitions but not others; you do not pay the cost of bad categorization forever in the partitions where it works badly. | diff --git a/docs/reference/api/MlPostCalendarEventsRequest.md b/docs/reference/api/MlPostCalendarEventsRequest.md new file mode 100644 index 000000000..a4e1b0881 --- /dev/null +++ b/docs/reference/api/MlPostCalendarEventsRequest.md @@ -0,0 +1,8 @@ +## Interface `MlPostCalendarEventsRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { calendar_id?: never; events?: never; }) | All values in `body` will be added to the request body. | +| `calendar_id` | [Id](./Id.md) | A string that uniquely identifies a calendar. | +| `events` | [MlCalendarEvent](./MlCalendarEvent.md)[] | A list of one of more scheduled events. The event’s start and end times can be specified as integer milliseconds since the epoch or as a string in ISO 8601 format. | +| `querystring` | { [key: string]: any; } & { calendar_id?: never; events?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/MlPostCalendarEventsResponse.md b/docs/reference/api/MlPostCalendarEventsResponse.md new file mode 100644 index 000000000..f0c535e21 --- /dev/null +++ b/docs/reference/api/MlPostCalendarEventsResponse.md @@ -0,0 +1,5 @@ +## Interface `MlPostCalendarEventsResponse` + +| Name | Type | Description | +| - | - | - | +| `events` | [MlCalendarEvent](./MlCalendarEvent.md)[] |   | diff --git a/docs/reference/api/MlPostDataRequest.md b/docs/reference/api/MlPostDataRequest.md new file mode 100644 index 000000000..c14d430ea --- /dev/null +++ b/docs/reference/api/MlPostDataRequest.md @@ -0,0 +1,10 @@ +## Interface `MlPostDataRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { job_id?: never; reset_end?: never; reset_start?: never; data?: never; }) | All values in `body` will be added to the request body. | +| `data` | TData[] |   | +| `job_id` | [Id](./Id.md) | Identifier for the anomaly detection job. The job must have a state of open to receive and process the data. | +| `querystring` | { [key: string]: any; } & { job_id?: never; reset_end?: never; reset_start?: never; data?: never; } | All values in `querystring` will be added to the request querystring. | +| `reset_end` | [DateTime](./DateTime.md) | Specifies the end of the bucket resetting range. | +| `reset_start` | [DateTime](./DateTime.md) | Specifies the start of the bucket resetting range. | diff --git a/docs/reference/api/MlPostDataResponse.md b/docs/reference/api/MlPostDataResponse.md new file mode 100644 index 000000000..652c7364c --- /dev/null +++ b/docs/reference/api/MlPostDataResponse.md @@ -0,0 +1,22 @@ +## Interface `MlPostDataResponse` + +| Name | Type | Description | +| - | - | - | +| `bucket_count` | [long](./long.md) |   | +| `earliest_record_timestamp` | [EpochTime](./EpochTime.md)<[UnitMillis](./UnitMillis.md)> |   | +| `empty_bucket_count` | [long](./long.md) |   | +| `input_bytes` | [long](./long.md) |   | +| `input_field_count` | [long](./long.md) |   | +| `input_record_count` | [long](./long.md) |   | +| `invalid_date_count` | [long](./long.md) |   | +| `job_id` | [Id](./Id.md) |   | +| `last_data_time` | [EpochTime](./EpochTime.md)<[UnitMillis](./UnitMillis.md)> |   | +| `latest_empty_bucket_timestamp` | [EpochTime](./EpochTime.md)<[UnitMillis](./UnitMillis.md)> |   | +| `latest_record_timestamp` | [EpochTime](./EpochTime.md)<[UnitMillis](./UnitMillis.md)> |   | +| `latest_sparse_bucket_timestamp` | [EpochTime](./EpochTime.md)<[UnitMillis](./UnitMillis.md)> |   | +| `log_time` | [EpochTime](./EpochTime.md)<[UnitMillis](./UnitMillis.md)> |   | +| `missing_field_count` | [long](./long.md) |   | +| `out_of_order_timestamp_count` | [long](./long.md) |   | +| `processed_field_count` | [long](./long.md) |   | +| `processed_record_count` | [long](./long.md) |   | +| `sparse_bucket_count` | [long](./long.md) |   | diff --git a/docs/reference/api/MlPredictedValue.md b/docs/reference/api/MlPredictedValue.md new file mode 100644 index 000000000..041fc0ad9 --- /dev/null +++ b/docs/reference/api/MlPredictedValue.md @@ -0,0 +1,4 @@ +## `MlPredictedValue` +::: +type MlPredictedValue = [ScalarValue](./ScalarValue.md) | [ScalarValue](./ScalarValue.md)[]; +::: diff --git a/docs/reference/api/MlPreviewDataFrameAnalyticsDataframePreviewConfig.md b/docs/reference/api/MlPreviewDataFrameAnalyticsDataframePreviewConfig.md new file mode 100644 index 000000000..af04f3c4d --- /dev/null +++ b/docs/reference/api/MlPreviewDataFrameAnalyticsDataframePreviewConfig.md @@ -0,0 +1,9 @@ +## Interface `MlPreviewDataFrameAnalyticsDataframePreviewConfig` + +| Name | Type | Description | +| - | - | - | +| `analysis` | [MlDataframeAnalysisContainer](./MlDataframeAnalysisContainer.md) |   | +| `analyzed_fields` | [MlDataframeAnalysisAnalyzedFields](./MlDataframeAnalysisAnalyzedFields.md) | string[] |   | +| `max_num_threads` | [integer](./integer.md) |   | +| `model_memory_limit` | string |   | +| `source` | [MlDataframeAnalyticsSource](./MlDataframeAnalyticsSource.md) |   | diff --git a/docs/reference/api/MlPreviewDataFrameAnalyticsRequest.md b/docs/reference/api/MlPreviewDataFrameAnalyticsRequest.md new file mode 100644 index 000000000..9f2782880 --- /dev/null +++ b/docs/reference/api/MlPreviewDataFrameAnalyticsRequest.md @@ -0,0 +1,8 @@ +## Interface `MlPreviewDataFrameAnalyticsRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { id?: never; config?: never; }) | All values in `body` will be added to the request body. | +| `config` | [MlPreviewDataFrameAnalyticsDataframePreviewConfig](./MlPreviewDataFrameAnalyticsDataframePreviewConfig.md) | A data frame analytics config as described in create data frame analytics jobs. Note that `id` and `dest` don’t need to be provided in the context of this API. | +| `id` | [Id](./Id.md) | Identifier for the data frame analytics job. | +| `querystring` | { [key: string]: any; } & { id?: never; config?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/MlPreviewDataFrameAnalyticsResponse.md b/docs/reference/api/MlPreviewDataFrameAnalyticsResponse.md new file mode 100644 index 000000000..c6e3b8c3d --- /dev/null +++ b/docs/reference/api/MlPreviewDataFrameAnalyticsResponse.md @@ -0,0 +1,5 @@ +## Interface `MlPreviewDataFrameAnalyticsResponse` + +| Name | Type | Description | +| - | - | - | +| `feature_values` | Record<[Field](./Field.md), string>[] | An array of objects that contain feature name and value pairs. The features have been processed and indicate what will be sent to the model for training. | diff --git a/docs/reference/api/MlPreviewDatafeedRequest.md b/docs/reference/api/MlPreviewDatafeedRequest.md new file mode 100644 index 000000000..3877f87ba --- /dev/null +++ b/docs/reference/api/MlPreviewDatafeedRequest.md @@ -0,0 +1,11 @@ +## Interface `MlPreviewDatafeedRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { datafeed_id?: never; start?: never; end?: never; datafeed_config?: never; job_config?: never; }) | All values in `body` will be added to the request body. | +| `datafeed_config` | [MlDatafeedConfig](./MlDatafeedConfig.md) | The datafeed definition to preview. | +| `datafeed_id` | [Id](./Id.md) | A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters. NOTE: If you use this path parameter, you cannot provide datafeed or anomaly detection job configuration details in the request body. | +| `end` | [DateTime](./DateTime.md) | The end time when the datafeed preview should stop | +| `job_config` | [MlJobConfig](./MlJobConfig.md) | The configuration details for the anomaly detection job that is associated with the datafeed. If the `datafeed_config` object does not include a `job_id` that references an existing anomaly detection job, you must supply this `job_config` object. If you include both a `job_id` and a `job_config`, the latter information is used. You cannot specify a `job_config` object unless you also supply a `datafeed_config` object. | +| `querystring` | { [key: string]: any; } & { datafeed_id?: never; start?: never; end?: never; datafeed_config?: never; job_config?: never; } | All values in `querystring` will be added to the request querystring. | +| `start` | [DateTime](./DateTime.md) | The start time from where the datafeed preview should begin | diff --git a/docs/reference/api/MlPreviewDatafeedResponse.md b/docs/reference/api/MlPreviewDatafeedResponse.md new file mode 100644 index 000000000..70ff5fefa --- /dev/null +++ b/docs/reference/api/MlPreviewDatafeedResponse.md @@ -0,0 +1,4 @@ +## `MlPreviewDatafeedResponse` +::: +type MlPreviewDatafeedResponse = TDocument[]; +::: diff --git a/docs/reference/api/MlPutCalendarJobRequest.md b/docs/reference/api/MlPutCalendarJobRequest.md new file mode 100644 index 000000000..26b99ae65 --- /dev/null +++ b/docs/reference/api/MlPutCalendarJobRequest.md @@ -0,0 +1,8 @@ +## Interface `MlPutCalendarJobRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { calendar_id?: never; job_id?: never; }) | All values in `body` will be added to the request body. | +| `calendar_id` | [Id](./Id.md) | A string that uniquely identifies a calendar. | +| `job_id` | [Ids](./Ids.md) | An identifier for the anomaly detection jobs. It can be a job identifier, a group name, or a comma-separated list of jobs or groups. | +| `querystring` | { [key: string]: any; } & { calendar_id?: never; job_id?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/MlPutCalendarJobResponse.md b/docs/reference/api/MlPutCalendarJobResponse.md new file mode 100644 index 000000000..7d77aca11 --- /dev/null +++ b/docs/reference/api/MlPutCalendarJobResponse.md @@ -0,0 +1,7 @@ +## Interface `MlPutCalendarJobResponse` + +| Name | Type | Description | +| - | - | - | +| `calendar_id` | [Id](./Id.md) | A string that uniquely identifies a calendar. | +| `description` | string | A description of the calendar. | +| `job_ids` | [Ids](./Ids.md) | A list of anomaly detection job identifiers or group names. | diff --git a/docs/reference/api/MlPutCalendarRequest.md b/docs/reference/api/MlPutCalendarRequest.md new file mode 100644 index 000000000..f7dca65c7 --- /dev/null +++ b/docs/reference/api/MlPutCalendarRequest.md @@ -0,0 +1,9 @@ +## Interface `MlPutCalendarRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { calendar_id?: never; job_ids?: never; description?: never; }) | All values in `body` will be added to the request body. | +| `calendar_id` | [Id](./Id.md) | A string that uniquely identifies a calendar. | +| `description` | string | A description of the calendar. | +| `job_ids` | [Id](./Id.md)[] | An array of anomaly detection job identifiers. | +| `querystring` | { [key: string]: any; } & { calendar_id?: never; job_ids?: never; description?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/MlPutCalendarResponse.md b/docs/reference/api/MlPutCalendarResponse.md new file mode 100644 index 000000000..e357a20b6 --- /dev/null +++ b/docs/reference/api/MlPutCalendarResponse.md @@ -0,0 +1,7 @@ +## Interface `MlPutCalendarResponse` + +| Name | Type | Description | +| - | - | - | +| `calendar_id` | [Id](./Id.md) | A string that uniquely identifies a calendar. | +| `description` | string | A description of the calendar. | +| `job_ids` | [Ids](./Ids.md) | A list of anomaly detection job identifiers or group names. | diff --git a/docs/reference/api/MlPutDataFrameAnalyticsRequest.md b/docs/reference/api/MlPutDataFrameAnalyticsRequest.md new file mode 100644 index 000000000..b3520eb95 --- /dev/null +++ b/docs/reference/api/MlPutDataFrameAnalyticsRequest.md @@ -0,0 +1,18 @@ +## Interface `MlPutDataFrameAnalyticsRequest` + +| Name | Type | Description | +| - | - | - | +| `_meta` | [Metadata](./Metadata.md) |   | +| `allow_lazy_start` | boolean | Specifies whether this job can start when there is insufficient machine learning node capacity for it to be immediately assigned to a node. If set to `false` and a machine learning node with capacity to run the job cannot be immediately found, the API returns an error. If set to `true`, the API does not return an error; the job waits in the `starting` state until sufficient machine learning node capacity is available. This behavior is also affected by the cluster-wide `xpack.ml.max_lazy_ml_nodes` setting. | +| `analysis` | [MlDataframeAnalysisContainer](./MlDataframeAnalysisContainer.md) | The analysis configuration, which contains the information necessary to perform one of the following types of analysis: classification, outlier detection, or regression. | +| `analyzed_fields` | [MlDataframeAnalysisAnalyzedFields](./MlDataframeAnalysisAnalyzedFields.md) | string[] | Specifies `includes` and/or `excludes` patterns to select which fields will be included in the analysis. The patterns specified in `excludes` are applied last, therefore `excludes` takes precedence. In other words, if the same field is specified in both `includes` and `excludes`, then the field will not be included in the analysis. If `analyzed_fields` is not set, only the relevant fields will be included. For example, all the numeric fields for outlier detection. The supported fields vary for each type of analysis. Outlier detection requires numeric or `boolean` data to analyze. The algorithms don’t support missing values therefore fields that have data types other than numeric or boolean are ignored. Documents where included fields contain missing values, null values, or an array are also ignored. Therefore the `dest` index may contain documents that don’t have an outlier score. Regression supports fields that are numeric, `boolean`, `text`, `keyword`, and `ip` data types. It is also tolerant of missing values. Fields that are supported are included in the analysis, other fields are ignored. Documents where included fields contain an array with two or more values are also ignored. Documents in the `dest` index that don’t contain a results field are not included in the regression analysis. Classification supports fields that are numeric, `boolean`, `text`, `keyword`, and `ip` data types. It is also tolerant of missing values. Fields that are supported are included in the analysis, other fields are ignored. Documents where included fields contain an array with two or more values are also ignored. Documents in the `dest` index that don’t contain a results field are not included in the classification analysis. Classification analysis can be improved by mapping ordinal variable values to a single number. For example, in case of age ranges, you can model the values as `0-14 = 0`, `15-24 = 1`, `25-34 = 2`, and so on. | +| `body` | string | ({ [key: string]: any; } & { id?: never; allow_lazy_start?: never; analysis?: never; analyzed_fields?: never; description?: never; dest?: never; max_num_threads?: never; _meta?: never; model_memory_limit?: never; source?: never; headers?: never; version?: never; }) | All values in `body` will be added to the request body. | +| `description` | string | A description of the job. | +| `dest` | [MlDataframeAnalyticsDestination](./MlDataframeAnalyticsDestination.md) | The destination configuration. | +| `headers` | [HttpHeaders](./HttpHeaders.md) |   | +| `id` | [Id](./Id.md) | Identifier for the data frame analytics job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters. | +| `max_num_threads` | [integer](./integer.md) | The maximum number of threads to be used by the analysis. Using more threads may decrease the time necessary to complete the analysis at the cost of using more CPU. Note that the process may use additional threads for operational functionality other than the analysis itself. | +| `model_memory_limit` | string | The approximate maximum amount of memory resources that are permitted for analytical processing. If your `elasticsearch.yml` file contains an `xpack.ml.max_model_memory_limit` setting, an error occurs when you try to create data frame analytics jobs that have `model_memory_limit` values greater than that setting. | +| `querystring` | { [key: string]: any; } & { id?: never; allow_lazy_start?: never; analysis?: never; analyzed_fields?: never; description?: never; dest?: never; max_num_threads?: never; _meta?: never; model_memory_limit?: never; source?: never; headers?: never; version?: never; } | All values in `querystring` will be added to the request querystring. | +| `source` | [MlDataframeAnalyticsSource](./MlDataframeAnalyticsSource.md) | The configuration of how to source the analysis data. | +| `version` | [VersionString](./VersionString.md) |   | diff --git a/docs/reference/api/MlPutDataFrameAnalyticsResponse.md b/docs/reference/api/MlPutDataFrameAnalyticsResponse.md new file mode 100644 index 000000000..e395c0dea --- /dev/null +++ b/docs/reference/api/MlPutDataFrameAnalyticsResponse.md @@ -0,0 +1,17 @@ +## Interface `MlPutDataFrameAnalyticsResponse` + +| Name | Type | Description | +| - | - | - | +| `_meta` | [Metadata](./Metadata.md) |   | +| `allow_lazy_start` | boolean |   | +| `analysis` | [MlDataframeAnalysisContainer](./MlDataframeAnalysisContainer.md) |   | +| `analyzed_fields` | [MlDataframeAnalysisAnalyzedFields](./MlDataframeAnalysisAnalyzedFields.md) | string[] |   | +| `authorization` | [MlDataframeAnalyticsAuthorization](./MlDataframeAnalyticsAuthorization.md) |   | +| `create_time` | [EpochTime](./EpochTime.md)<[UnitMillis](./UnitMillis.md)> |   | +| `description` | string |   | +| `dest` | [MlDataframeAnalyticsDestination](./MlDataframeAnalyticsDestination.md) |   | +| `id` | [Id](./Id.md) |   | +| `max_num_threads` | [integer](./integer.md) |   | +| `model_memory_limit` | string |   | +| `source` | [MlDataframeAnalyticsSource](./MlDataframeAnalyticsSource.md) |   | +| `version` | [VersionString](./VersionString.md) |   | diff --git a/docs/reference/api/MlPutDatafeedRequest.md b/docs/reference/api/MlPutDatafeedRequest.md new file mode 100644 index 000000000..3f00514d6 --- /dev/null +++ b/docs/reference/api/MlPutDatafeedRequest.md @@ -0,0 +1,27 @@ +## Interface `MlPutDatafeedRequest` + +| Name | Type | Description | +| - | - | - | +| `aggregations` | Record | If set, the datafeed performs aggregation searches. Support for aggregations is limited and should be used only with low cardinality data. | +| `aggs` | Record | If set, the datafeed performs aggregation searches. Support for aggregations is limited and should be used only with low cardinality data. aggregations | +| `allow_no_indices` | boolean | If true, wildcard indices expressions that resolve into no concrete indices are ignored. This includes the `_all` string or when no indices are specified. | +| `body` | string | ({ [key: string]: any; } & { datafeed_id?: never; allow_no_indices?: never; expand_wildcards?: never; ignore_throttled?: never; ignore_unavailable?: never; aggregations?: never; aggs?: never; chunking_config?: never; delayed_data_check_config?: never; frequency?: never; indices?: never; indexes?: never; indices_options?: never; job_id?: never; max_empty_searches?: never; query?: never; query_delay?: never; runtime_mappings?: never; script_fields?: never; scroll_size?: never; headers?: never; }) | All values in `body` will be added to the request body. | +| `chunking_config` | [MlChunkingConfig](./MlChunkingConfig.md) | Datafeeds might be required to search over long time periods, for several months or years. This search is split into time chunks in order to ensure the load on Elasticsearch is managed. Chunking configuration controls how the size of these time chunks are calculated; it is an advanced configuration option. | +| `datafeed_id` | [Id](./Id.md) | A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters. | +| `delayed_data_check_config` | [MlDelayedDataCheckConfig](./MlDelayedDataCheckConfig.md) | Specifies whether the datafeed checks for missing data and the size of the window. The datafeed can optionally search over indices that have already been read in an effort to determine whether any data has subsequently been added to the index. If missing data is found, it is a good indication that the `query_delay` is set too low and the data is being indexed after the datafeed has passed that moment in time. This check runs only on real-time datafeeds. | +| `expand_wildcards` | [ExpandWildcards](./ExpandWildcards.md) | Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values. | +| `frequency` | [Duration](./Duration.md) | The interval at which scheduled queries are made while the datafeed runs in real time. The default value is either the bucket span for short bucket spans, or, for longer bucket spans, a sensible fraction of the bucket span. When `frequency` is shorter than the bucket span, interim results for the last (partial) bucket are written then eventually overwritten by the full bucket results. If the datafeed uses aggregations, this value must be divisible by the interval of the date histogram aggregation. | +| `headers` | [HttpHeaders](./HttpHeaders.md) |   | +| `ignore_throttled` | boolean | If true, concrete, expanded, or aliased indices are ignored when frozen. | +| `ignore_unavailable` | boolean | If true, unavailable indices (missing or closed) are ignored. | +| `indexes` | [Indices](./Indices.md) | An array of index names. Wildcards are supported. If any of the indices are in remote clusters, the master nodes and the machine learning nodes must have the `remote_cluster_client` role. indices | +| `indices_options` | [IndicesOptions](./IndicesOptions.md) | Specifies index expansion options that are used during search | +| `indices` | [Indices](./Indices.md) | An array of index names. Wildcards are supported. If any of the indices are in remote clusters, the master nodes and the machine learning nodes must have the `remote_cluster_client` role. | +| `job_id` | [Id](./Id.md) | Identifier for the anomaly detection job. | +| `max_empty_searches` | [integer](./integer.md) | If a real-time datafeed has never seen any data (including during any initial training period), it automatically stops and closes the associated job after this many real-time searches return no documents. In other words, it stops after `frequency` times `max_empty_searches` of real-time operation. If not set, a datafeed with no end time that sees no data remains started until it is explicitly stopped. By default, it is not set. | +| `query_delay` | [Duration](./Duration.md) | The number of seconds behind real time that data is queried. For example, if data from 10:04 a.m. might not be searchable in Elasticsearch until 10:06 a.m., set this property to 120 seconds. The default value is randomly selected between `60s` and `120s`. This randomness improves the query performance when there are multiple jobs running on the same node. | +| `query` | [QueryDslQueryContainer](./QueryDslQueryContainer.md) | The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an Elasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this object is passed verbatim to Elasticsearch. | +| `querystring` | { [key: string]: any; } & { datafeed_id?: never; allow_no_indices?: never; expand_wildcards?: never; ignore_throttled?: never; ignore_unavailable?: never; aggregations?: never; aggs?: never; chunking_config?: never; delayed_data_check_config?: never; frequency?: never; indices?: never; indexes?: never; indices_options?: never; job_id?: never; max_empty_searches?: never; query?: never; query_delay?: never; runtime_mappings?: never; script_fields?: never; scroll_size?: never; headers?: never; } | All values in `querystring` will be added to the request querystring. | +| `runtime_mappings` | [MappingRuntimeFields](./MappingRuntimeFields.md) | Specifies runtime fields for the datafeed search. | +| `script_fields` | Record | Specifies scripts that evaluate custom expressions and returns script fields to the datafeed. The detector configuration objects in a job can contain functions that use these script fields. | +| `scroll_size` | [integer](./integer.md) | The size parameter that is used in Elasticsearch searches when the datafeed does not use aggregations. The maximum value is the value of `index.max_result_window`, which is 10,000 by default. | diff --git a/docs/reference/api/MlPutDatafeedResponse.md b/docs/reference/api/MlPutDatafeedResponse.md new file mode 100644 index 000000000..f2dd15e19 --- /dev/null +++ b/docs/reference/api/MlPutDatafeedResponse.md @@ -0,0 +1,19 @@ +## Interface `MlPutDatafeedResponse` + +| Name | Type | Description | +| - | - | - | +| `aggregations` | Record |   | +| `authorization` | [MlDatafeedAuthorization](./MlDatafeedAuthorization.md) |   | +| `chunking_config` | [MlChunkingConfig](./MlChunkingConfig.md) |   | +| `datafeed_id` | [Id](./Id.md) |   | +| `delayed_data_check_config` | [MlDelayedDataCheckConfig](./MlDelayedDataCheckConfig.md) |   | +| `frequency` | [Duration](./Duration.md) |   | +| `indices_options` | [IndicesOptions](./IndicesOptions.md) |   | +| `indices` | string[] |   | +| `job_id` | [Id](./Id.md) |   | +| `max_empty_searches` | [integer](./integer.md) |   | +| `query_delay` | [Duration](./Duration.md) |   | +| `query` | [QueryDslQueryContainer](./QueryDslQueryContainer.md) |   | +| `runtime_mappings` | [MappingRuntimeFields](./MappingRuntimeFields.md) |   | +| `script_fields` | Record |   | +| `scroll_size` | [integer](./integer.md) |   | diff --git a/docs/reference/api/MlPutFilterRequest.md b/docs/reference/api/MlPutFilterRequest.md new file mode 100644 index 000000000..6f151a96e --- /dev/null +++ b/docs/reference/api/MlPutFilterRequest.md @@ -0,0 +1,9 @@ +## Interface `MlPutFilterRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { filter_id?: never; description?: never; items?: never; }) | All values in `body` will be added to the request body. | +| `description` | string | A description of the filter. | +| `filter_id` | [Id](./Id.md) | A string that uniquely identifies a filter. | +| `items` | string[] | The items of the filter. A wildcard `*` can be used at the beginning or the end of an item. Up to 10000 items are allowed in each filter. | +| `querystring` | { [key: string]: any; } & { filter_id?: never; description?: never; items?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/MlPutFilterResponse.md b/docs/reference/api/MlPutFilterResponse.md new file mode 100644 index 000000000..8cd1e9ad1 --- /dev/null +++ b/docs/reference/api/MlPutFilterResponse.md @@ -0,0 +1,7 @@ +## Interface `MlPutFilterResponse` + +| Name | Type | Description | +| - | - | - | +| `description` | string |   | +| `filter_id` | [Id](./Id.md) |   | +| `items` | string[] |   | diff --git a/docs/reference/api/MlPutJobRequest.md b/docs/reference/api/MlPutJobRequest.md new file mode 100644 index 000000000..9ee952c95 --- /dev/null +++ b/docs/reference/api/MlPutJobRequest.md @@ -0,0 +1,26 @@ +## Interface `MlPutJobRequest` + +| Name | Type | Description | +| - | - | - | +| `allow_lazy_open` | boolean | Advanced configuration option. Specifies whether this job can open when there is insufficient machine learning node capacity for it to be immediately assigned to a node. By default, if a machine learning node with capacity to run the job cannot immediately be found, the open anomaly detection jobs API returns an error. However, this is also subject to the cluster-wide `xpack.ml.max_lazy_ml_nodes` setting. If this option is set to true, the open anomaly detection jobs API does not return an error and the job waits in the opening state until sufficient machine learning node capacity is available. | +| `allow_no_indices` | boolean | If `true`, wildcard indices expressions that resolve into no concrete indices are ignored. This includes the `_all` string or when no indices are specified. | +| `analysis_config` | [MlAnalysisConfig](./MlAnalysisConfig.md) | Specifies how to analyze the data. After you create a job, you cannot change the analysis configuration; all the properties are informational. | +| `analysis_limits` | [MlAnalysisLimits](./MlAnalysisLimits.md) | Limits can be applied for the resources required to hold the mathematical models in memory. These limits are approximate and can be set per job. They do not control the memory used by other processes, for example the Elasticsearch Java processes. | +| `background_persist_interval` | [Duration](./Duration.md) | Advanced configuration option. The time between each periodic persistence of the model. The default value is a randomized value between 3 to 4 hours, which avoids all jobs persisting at exactly the same time. The smallest allowed value is 1 hour. For very large models (several GB), persistence could take 10-20 minutes, so do not set the `background_persist_interval` value too low. | +| `body` | string | ({ [key: string]: any; } & { job_id?: never; allow_no_indices?: never; expand_wildcards?: never; ignore_throttled?: never; ignore_unavailable?: never; allow_lazy_open?: never; analysis_config?: never; analysis_limits?: never; background_persist_interval?: never; custom_settings?: never; daily_model_snapshot_retention_after_days?: never; data_description?: never; datafeed_config?: never; description?: never; groups?: never; model_plot_config?: never; model_snapshot_retention_days?: never; renormalization_window_days?: never; results_index_name?: never; results_retention_days?: never; }) | All values in `body` will be added to the request body. | +| `custom_settings` | [MlCustomSettings](./MlCustomSettings.md) | Advanced configuration option. Contains custom meta data about the job. | +| `daily_model_snapshot_retention_after_days` | [long](./long.md) | Advanced configuration option, which affects the automatic removal of old model snapshots for this job. It specifies a period of time (in days) after which only the first snapshot per day is retained. This period is relative to the timestamp of the most recent snapshot for this job. Valid values range from 0 to `model_snapshot_retention_days`. | +| `data_description` | [MlDataDescription](./MlDataDescription.md) | Defines the format of the input data when you send data to the job by using the post data API. Note that when configure a datafeed, these properties are automatically set. When data is received via the post data API, it is not stored in Elasticsearch. Only the results for anomaly detection are retained. | +| `datafeed_config` | [MlDatafeedConfig](./MlDatafeedConfig.md) | Defines a datafeed for the anomaly detection job. If Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead. | +| `description` | string | A description of the job. | +| `expand_wildcards` | [ExpandWildcards](./ExpandWildcards.md) | Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values. Valid values are: * `all`: Match any data stream or index, including hidden ones. * `closed`: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed. * `hidden`: Match hidden data streams and hidden indices. Must be combined with `open`, `closed`, or both. * `none`: Wildcard patterns are not accepted. * `open`: Match open, non-hidden indices. Also matches any non-hidden data stream. | +| `groups` | string[] | A list of job groups. A job can belong to no groups or many. | +| `ignore_throttled` | boolean | If `true`, concrete, expanded or aliased indices are ignored when frozen. | +| `ignore_unavailable` | boolean | If `true`, unavailable indices (missing or closed) are ignored. | +| `job_id` | [Id](./Id.md) | The identifier for the anomaly detection job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters. | +| `model_plot_config` | [MlModelPlotConfig](./MlModelPlotConfig.md) | This advanced configuration option stores model information along with the results. It provides a more detailed view into anomaly detection. If you enable model plot it can add considerable overhead to the performance of the system; it is not feasible for jobs with many entities. Model plot provides a simplified and indicative view of the model and its bounds. It does not display complex features such as multivariate correlations or multimodal data. As such, anomalies may occasionally be reported which cannot be seen in the model plot. Model plot config can be configured when the job is created or updated later. It must be disabled if performance issues are experienced. | +| `model_snapshot_retention_days` | [long](./long.md) | Advanced configuration option, which affects the automatic removal of old model snapshots for this job. It specifies the maximum period of time (in days) that snapshots are retained. This period is relative to the timestamp of the most recent snapshot for this job. By default, snapshots ten days older than the newest snapshot are deleted. | +| `querystring` | { [key: string]: any; } & { job_id?: never; allow_no_indices?: never; expand_wildcards?: never; ignore_throttled?: never; ignore_unavailable?: never; allow_lazy_open?: never; analysis_config?: never; analysis_limits?: never; background_persist_interval?: never; custom_settings?: never; daily_model_snapshot_retention_after_days?: never; data_description?: never; datafeed_config?: never; description?: never; groups?: never; model_plot_config?: never; model_snapshot_retention_days?: never; renormalization_window_days?: never; results_index_name?: never; results_retention_days?: never; } | All values in `querystring` will be added to the request querystring. | +| `renormalization_window_days` | [long](./long.md) | Advanced configuration option. The period over which adjustments to the score are applied, as new data is seen. The default value is the longer of 30 days or 100 bucket spans. | +| `results_index_name` | [IndexName](./IndexName.md) | A text string that affects the name of the machine learning results index. By default, the job generates an index named `.ml-anomalies-shared`. | +| `results_retention_days` | [long](./long.md) | Advanced configuration option. The period of time (in days) that results are retained. Age is calculated relative to the timestamp of the latest bucket result. If this property has a non-null value, once per day at 00:30 (server time), results that are the specified number of days older than the latest bucket result are deleted from Elasticsearch. The default value is null, which means all results are retained. Annotations generated by the system also count as results for retention purposes; they are deleted after the same number of days as results. Annotations added by users are retained forever. | diff --git a/docs/reference/api/MlPutJobResponse.md b/docs/reference/api/MlPutJobResponse.md new file mode 100644 index 000000000..26c9a86cd --- /dev/null +++ b/docs/reference/api/MlPutJobResponse.md @@ -0,0 +1,24 @@ +## Interface `MlPutJobResponse` + +| Name | Type | Description | +| - | - | - | +| `allow_lazy_open` | boolean |   | +| `analysis_config` | [MlAnalysisConfigRead](./MlAnalysisConfigRead.md) |   | +| `analysis_limits` | [MlAnalysisLimits](./MlAnalysisLimits.md) |   | +| `background_persist_interval` | [Duration](./Duration.md) |   | +| `create_time` | [DateTime](./DateTime.md) |   | +| `custom_settings` | [MlCustomSettings](./MlCustomSettings.md) |   | +| `daily_model_snapshot_retention_after_days` | [long](./long.md) |   | +| `data_description` | [MlDataDescription](./MlDataDescription.md) |   | +| `datafeed_config` | [MlDatafeed](./MlDatafeed.md) |   | +| `description` | string |   | +| `groups` | string[] |   | +| `job_id` | [Id](./Id.md) |   | +| `job_type` | string |   | +| `job_version` | string |   | +| `model_plot_config` | [MlModelPlotConfig](./MlModelPlotConfig.md) |   | +| `model_snapshot_id` | [Id](./Id.md) |   | +| `model_snapshot_retention_days` | [long](./long.md) |   | +| `renormalization_window_days` | [long](./long.md) |   | +| `results_index_name` | string |   | +| `results_retention_days` | [long](./long.md) |   | diff --git a/docs/reference/api/MlPutTrainedModelAggregateOutput.md b/docs/reference/api/MlPutTrainedModelAggregateOutput.md new file mode 100644 index 000000000..85c03f627 --- /dev/null +++ b/docs/reference/api/MlPutTrainedModelAggregateOutput.md @@ -0,0 +1,8 @@ +## Interface `MlPutTrainedModelAggregateOutput` + +| Name | Type | Description | +| - | - | - | +| `exponent` | [MlPutTrainedModelWeights](./MlPutTrainedModelWeights.md) |   | +| `logistic_regression` | [MlPutTrainedModelWeights](./MlPutTrainedModelWeights.md) |   | +| `weighted_mode` | [MlPutTrainedModelWeights](./MlPutTrainedModelWeights.md) |   | +| `weighted_sum` | [MlPutTrainedModelWeights](./MlPutTrainedModelWeights.md) |   | diff --git a/docs/reference/api/MlPutTrainedModelAliasRequest.md b/docs/reference/api/MlPutTrainedModelAliasRequest.md new file mode 100644 index 000000000..1d10775d9 --- /dev/null +++ b/docs/reference/api/MlPutTrainedModelAliasRequest.md @@ -0,0 +1,9 @@ +## Interface `MlPutTrainedModelAliasRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { model_alias?: never; model_id?: never; reassign?: never; }) | All values in `body` will be added to the request body. | +| `model_alias` | [Name](./Name.md) | The alias to create or update. This value cannot end in numbers. | +| `model_id` | [Id](./Id.md) | The identifier for the trained model that the alias refers to. | +| `querystring` | { [key: string]: any; } & { model_alias?: never; model_id?: never; reassign?: never; } | All values in `querystring` will be added to the request querystring. | +| `reassign` | boolean | Specifies whether the alias gets reassigned to the specified trained model if it is already assigned to a different model. If the alias is already assigned and this parameter is false, the API returns an error. | diff --git a/docs/reference/api/MlPutTrainedModelAliasResponse.md b/docs/reference/api/MlPutTrainedModelAliasResponse.md new file mode 100644 index 000000000..d33022520 --- /dev/null +++ b/docs/reference/api/MlPutTrainedModelAliasResponse.md @@ -0,0 +1,4 @@ +## `MlPutTrainedModelAliasResponse` +::: +type MlPutTrainedModelAliasResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); +::: diff --git a/docs/reference/api/MlPutTrainedModelDefinition.md b/docs/reference/api/MlPutTrainedModelDefinition.md new file mode 100644 index 000000000..ca55f0152 --- /dev/null +++ b/docs/reference/api/MlPutTrainedModelDefinition.md @@ -0,0 +1,6 @@ +## Interface `MlPutTrainedModelDefinition` + +| Name | Type | Description | +| - | - | - | +| `preprocessors` | [MlPutTrainedModelPreprocessor](./MlPutTrainedModelPreprocessor.md)[] | Collection of preprocessors | +| `trained_model` | [MlPutTrainedModelTrainedModel](./MlPutTrainedModelTrainedModel.md) | The definition of the trained model. | diff --git a/docs/reference/api/MlPutTrainedModelDefinitionPartRequest.md b/docs/reference/api/MlPutTrainedModelDefinitionPartRequest.md new file mode 100644 index 000000000..16f581e01 --- /dev/null +++ b/docs/reference/api/MlPutTrainedModelDefinitionPartRequest.md @@ -0,0 +1,11 @@ +## Interface `MlPutTrainedModelDefinitionPartRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { model_id?: never; part?: never; definition?: never; total_definition_length?: never; total_parts?: never; }) | All values in `body` will be added to the request body. | +| `definition` | string | The definition part for the model. Must be a base64 encoded string. | +| `model_id` | [Id](./Id.md) | The unique identifier of the trained model. | +| `part` | [integer](./integer.md) | The definition part number. When the definition is loaded for inference the definition parts are streamed in the order of their part number. The first part must be `0` and the final part must be `total_parts - 1`. | +| `querystring` | { [key: string]: any; } & { model_id?: never; part?: never; definition?: never; total_definition_length?: never; total_parts?: never; } | All values in `querystring` will be added to the request querystring. | +| `total_definition_length` | [long](./long.md) | The total uncompressed definition length in bytes. Not base64 encoded. | +| `total_parts` | [integer](./integer.md) | The total number of parts that will be uploaded. Must be greater than 0. | diff --git a/docs/reference/api/MlPutTrainedModelDefinitionPartResponse.md b/docs/reference/api/MlPutTrainedModelDefinitionPartResponse.md new file mode 100644 index 000000000..36c2d5a73 --- /dev/null +++ b/docs/reference/api/MlPutTrainedModelDefinitionPartResponse.md @@ -0,0 +1,4 @@ +## `MlPutTrainedModelDefinitionPartResponse` +::: +type MlPutTrainedModelDefinitionPartResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); +::: diff --git a/docs/reference/api/MlPutTrainedModelEnsemble.md b/docs/reference/api/MlPutTrainedModelEnsemble.md new file mode 100644 index 000000000..1f3922b5d --- /dev/null +++ b/docs/reference/api/MlPutTrainedModelEnsemble.md @@ -0,0 +1,9 @@ +## Interface `MlPutTrainedModelEnsemble` + +| Name | Type | Description | +| - | - | - | +| `aggregate_output` | [MlPutTrainedModelAggregateOutput](./MlPutTrainedModelAggregateOutput.md) |   | +| `classification_labels` | string[] |   | +| `feature_names` | string[] |   | +| `target_type` | string |   | +| `trained_models` | [MlPutTrainedModelTrainedModel](./MlPutTrainedModelTrainedModel.md)[] |   | diff --git a/docs/reference/api/MlPutTrainedModelFrequencyEncodingPreprocessor.md b/docs/reference/api/MlPutTrainedModelFrequencyEncodingPreprocessor.md new file mode 100644 index 000000000..2b344bc83 --- /dev/null +++ b/docs/reference/api/MlPutTrainedModelFrequencyEncodingPreprocessor.md @@ -0,0 +1,7 @@ +## Interface `MlPutTrainedModelFrequencyEncodingPreprocessor` + +| Name | Type | Description | +| - | - | - | +| `feature_name` | string |   | +| `field` | string |   | +| `frequency_map` | Record |   | diff --git a/docs/reference/api/MlPutTrainedModelInput.md b/docs/reference/api/MlPutTrainedModelInput.md new file mode 100644 index 000000000..f36c44c8e --- /dev/null +++ b/docs/reference/api/MlPutTrainedModelInput.md @@ -0,0 +1,5 @@ +## Interface `MlPutTrainedModelInput` + +| Name | Type | Description | +| - | - | - | +| `field_names` | [Names](./Names.md) |   | diff --git a/docs/reference/api/MlPutTrainedModelOneHotEncodingPreprocessor.md b/docs/reference/api/MlPutTrainedModelOneHotEncodingPreprocessor.md new file mode 100644 index 000000000..02b7474ea --- /dev/null +++ b/docs/reference/api/MlPutTrainedModelOneHotEncodingPreprocessor.md @@ -0,0 +1,6 @@ +## Interface `MlPutTrainedModelOneHotEncodingPreprocessor` + +| Name | Type | Description | +| - | - | - | +| `field` | string |   | +| `hot_map` | Record |   | diff --git a/docs/reference/api/MlPutTrainedModelPreprocessor.md b/docs/reference/api/MlPutTrainedModelPreprocessor.md new file mode 100644 index 000000000..2cd0a8866 --- /dev/null +++ b/docs/reference/api/MlPutTrainedModelPreprocessor.md @@ -0,0 +1,7 @@ +## Interface `MlPutTrainedModelPreprocessor` + +| Name | Type | Description | +| - | - | - | +| `frequency_encoding` | [MlPutTrainedModelFrequencyEncodingPreprocessor](./MlPutTrainedModelFrequencyEncodingPreprocessor.md) |   | +| `one_hot_encoding` | [MlPutTrainedModelOneHotEncodingPreprocessor](./MlPutTrainedModelOneHotEncodingPreprocessor.md) |   | +| `target_mean_encoding` | [MlPutTrainedModelTargetMeanEncodingPreprocessor](./MlPutTrainedModelTargetMeanEncodingPreprocessor.md) |   | diff --git a/docs/reference/api/MlPutTrainedModelRequest.md b/docs/reference/api/MlPutTrainedModelRequest.md new file mode 100644 index 000000000..76a2e06e7 --- /dev/null +++ b/docs/reference/api/MlPutTrainedModelRequest.md @@ -0,0 +1,20 @@ +## Interface `MlPutTrainedModelRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { model_id?: never; defer_definition_decompression?: never; wait_for_completion?: never; compressed_definition?: never; definition?: never; description?: never; inference_config?: never; input?: never; metadata?: never; model_type?: never; model_size_bytes?: never; platform_architecture?: never; tags?: never; prefix_strings?: never; }) | All values in `body` will be added to the request body. | +| `compressed_definition` | string | The compressed (GZipped and Base64 encoded) inference definition of the model. If compressed_definition is specified, then definition cannot be specified. | +| `defer_definition_decompression` | boolean | If set to `true` and a `compressed_definition` is provided, the request defers definition decompression and skips relevant validations. | +| `definition` | [MlPutTrainedModelDefinition](./MlPutTrainedModelDefinition.md) | The inference definition for the model. If definition is specified, then compressed_definition cannot be specified. | +| `description` | string | A human-readable description of the inference trained model. | +| `inference_config` | [MlInferenceConfigCreateContainer](./MlInferenceConfigCreateContainer.md) | The default configuration for inference. This can be either a regression or classification configuration. It must match the underlying definition.trained_model's target_type. For pre-packaged models such as ELSER the config is not required. | +| `input` | [MlPutTrainedModelInput](./MlPutTrainedModelInput.md) | The input field names for the model definition. | +| `metadata` | any | An object map that contains metadata about the model. | +| `model_id` | [Id](./Id.md) | The unique identifier of the trained model. | +| `model_size_bytes` | [long](./long.md) | The estimated memory usage in bytes to keep the trained model in memory. This property is supported only if defer_definition_decompression is true or the model definition is not supplied. | +| `model_type` | [MlTrainedModelType](./MlTrainedModelType.md) | The model type. | +| `platform_architecture` | string | The platform architecture (if applicable) of the trained mode. If the model only works on one platform, because it is heavily optimized for a particular processor architecture and OS combination, then this field specifies which. The format of the string must match the platform identifiers used by Elasticsearch, so one of, `linux-x86_64`, `linux-aarch64`, `darwin-x86_64`, `darwin-aarch64`, or `windows-x86_64`. For portable models (those that work independent of processor architecture or OS features), leave this field unset. | +| `prefix_strings` | [MlTrainedModelPrefixStrings](./MlTrainedModelPrefixStrings.md) | Optional prefix strings applied at inference | +| `querystring` | { [key: string]: any; } & { model_id?: never; defer_definition_decompression?: never; wait_for_completion?: never; compressed_definition?: never; definition?: never; description?: never; inference_config?: never; input?: never; metadata?: never; model_type?: never; model_size_bytes?: never; platform_architecture?: never; tags?: never; prefix_strings?: never; } | All values in `querystring` will be added to the request querystring. | +| `tags` | string[] | An array of tags to organize the model. | +| `wait_for_completion` | boolean | Whether to wait for all child operations (e.g. model download) to complete. | diff --git a/docs/reference/api/MlPutTrainedModelResponse.md b/docs/reference/api/MlPutTrainedModelResponse.md new file mode 100644 index 000000000..f6f8a71fe --- /dev/null +++ b/docs/reference/api/MlPutTrainedModelResponse.md @@ -0,0 +1,4 @@ +## `MlPutTrainedModelResponse` +::: +type MlPutTrainedModelResponse = [MlTrainedModelConfig](./MlTrainedModelConfig.md); +::: diff --git a/docs/reference/api/MlPutTrainedModelTargetMeanEncodingPreprocessor.md b/docs/reference/api/MlPutTrainedModelTargetMeanEncodingPreprocessor.md new file mode 100644 index 000000000..fe69c51b7 --- /dev/null +++ b/docs/reference/api/MlPutTrainedModelTargetMeanEncodingPreprocessor.md @@ -0,0 +1,8 @@ +## Interface `MlPutTrainedModelTargetMeanEncodingPreprocessor` + +| Name | Type | Description | +| - | - | - | +| `default_value` | [double](./double.md) |   | +| `feature_name` | string |   | +| `field` | string |   | +| `target_map` | Record |   | diff --git a/docs/reference/api/MlPutTrainedModelTrainedModel.md b/docs/reference/api/MlPutTrainedModelTrainedModel.md new file mode 100644 index 000000000..95c4657f8 --- /dev/null +++ b/docs/reference/api/MlPutTrainedModelTrainedModel.md @@ -0,0 +1,7 @@ +## Interface `MlPutTrainedModelTrainedModel` + +| Name | Type | Description | +| - | - | - | +| `ensemble` | [MlPutTrainedModelEnsemble](./MlPutTrainedModelEnsemble.md) | The definition for an ensemble model | +| `tree_node` | [MlPutTrainedModelTrainedModelTreeNode](./MlPutTrainedModelTrainedModelTreeNode.md) | The definition of a node in a tree. There are two major types of nodes: leaf nodes and not-leaf nodes. - Leaf nodes only need node_index and leaf_value defined. - All other nodes need split_feature, left_child, right_child, threshold, decision_type, and default_left defined. | +| `tree` | [MlPutTrainedModelTrainedModelTree](./MlPutTrainedModelTrainedModelTree.md) | The definition for a binary decision tree. | diff --git a/docs/reference/api/MlPutTrainedModelTrainedModelTree.md b/docs/reference/api/MlPutTrainedModelTrainedModelTree.md new file mode 100644 index 000000000..7327989cc --- /dev/null +++ b/docs/reference/api/MlPutTrainedModelTrainedModelTree.md @@ -0,0 +1,8 @@ +## Interface `MlPutTrainedModelTrainedModelTree` + +| Name | Type | Description | +| - | - | - | +| `classification_labels` | string[] |   | +| `feature_names` | string[] |   | +| `target_type` | string |   | +| `tree_structure` | [MlPutTrainedModelTrainedModelTreeNode](./MlPutTrainedModelTrainedModelTreeNode.md)[] |   | diff --git a/docs/reference/api/MlPutTrainedModelTrainedModelTreeNode.md b/docs/reference/api/MlPutTrainedModelTrainedModelTreeNode.md new file mode 100644 index 000000000..507852c9b --- /dev/null +++ b/docs/reference/api/MlPutTrainedModelTrainedModelTreeNode.md @@ -0,0 +1,13 @@ +## Interface `MlPutTrainedModelTrainedModelTreeNode` + +| Name | Type | Description | +| - | - | - | +| `decision_type` | string |   | +| `default_left` | boolean |   | +| `leaf_value` | [double](./double.md) |   | +| `left_child` | [integer](./integer.md) |   | +| `node_index` | [integer](./integer.md) |   | +| `right_child` | [integer](./integer.md) |   | +| `split_feature` | [integer](./integer.md) |   | +| `split_gain` | [integer](./integer.md) |   | +| `threshold` | [double](./double.md) |   | diff --git a/docs/reference/api/MlPutTrainedModelVocabularyRequest.md b/docs/reference/api/MlPutTrainedModelVocabularyRequest.md new file mode 100644 index 000000000..63065f5e0 --- /dev/null +++ b/docs/reference/api/MlPutTrainedModelVocabularyRequest.md @@ -0,0 +1,10 @@ +## Interface `MlPutTrainedModelVocabularyRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { model_id?: never; vocabulary?: never; merges?: never; scores?: never; }) | All values in `body` will be added to the request body. | +| `merges` | string[] | The optional model merges if required by the tokenizer. | +| `model_id` | [Id](./Id.md) | The unique identifier of the trained model. | +| `querystring` | { [key: string]: any; } & { model_id?: never; vocabulary?: never; merges?: never; scores?: never; } | All values in `querystring` will be added to the request querystring. | +| `scores` | [double](./double.md)[] | The optional vocabulary value scores if required by the tokenizer. | +| `vocabulary` | string[] | The model vocabulary, which must not be empty. | diff --git a/docs/reference/api/MlPutTrainedModelVocabularyResponse.md b/docs/reference/api/MlPutTrainedModelVocabularyResponse.md new file mode 100644 index 000000000..d5238d889 --- /dev/null +++ b/docs/reference/api/MlPutTrainedModelVocabularyResponse.md @@ -0,0 +1,4 @@ +## `MlPutTrainedModelVocabularyResponse` +::: +type MlPutTrainedModelVocabularyResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); +::: diff --git a/docs/reference/api/MlPutTrainedModelWeights.md b/docs/reference/api/MlPutTrainedModelWeights.md new file mode 100644 index 000000000..c917f2599 --- /dev/null +++ b/docs/reference/api/MlPutTrainedModelWeights.md @@ -0,0 +1,5 @@ +## Interface `MlPutTrainedModelWeights` + +| Name | Type | Description | +| - | - | - | +| `weights` | [double](./double.md) |   | diff --git a/docs/reference/api/MlQueryFeatureExtractor.md b/docs/reference/api/MlQueryFeatureExtractor.md new file mode 100644 index 000000000..4d12e7e6e --- /dev/null +++ b/docs/reference/api/MlQueryFeatureExtractor.md @@ -0,0 +1,7 @@ +## Interface `MlQueryFeatureExtractor` + +| Name | Type | Description | +| - | - | - | +| `default_score` | [float](./float.md) |   | +| `feature_name` | string |   | +| `query` | [QueryDslQueryContainer](./QueryDslQueryContainer.md) |   | diff --git a/docs/reference/api/MlQuestionAnsweringInferenceOptions.md b/docs/reference/api/MlQuestionAnsweringInferenceOptions.md new file mode 100644 index 000000000..7bfb51d41 --- /dev/null +++ b/docs/reference/api/MlQuestionAnsweringInferenceOptions.md @@ -0,0 +1,8 @@ +## Interface `MlQuestionAnsweringInferenceOptions` + +| Name | Type | Description | +| - | - | - | +| `max_answer_length` | [integer](./integer.md) | The maximum answer length to consider | +| `num_top_classes` | [integer](./integer.md) | Specifies the number of top class predictions to return. Defaults to 0. | +| `results_field` | string | The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. | +| `tokenization` | [MlTokenizationConfigContainer](./MlTokenizationConfigContainer.md) | The tokenization options to update when inferring | diff --git a/docs/reference/api/MlQuestionAnsweringInferenceUpdateOptions.md b/docs/reference/api/MlQuestionAnsweringInferenceUpdateOptions.md new file mode 100644 index 000000000..4bbdd5378 --- /dev/null +++ b/docs/reference/api/MlQuestionAnsweringInferenceUpdateOptions.md @@ -0,0 +1,9 @@ +## Interface `MlQuestionAnsweringInferenceUpdateOptions` + +| Name | Type | Description | +| - | - | - | +| `max_answer_length` | [integer](./integer.md) | The maximum answer length to consider for extraction | +| `num_top_classes` | [integer](./integer.md) | Specifies the number of top class predictions to return. Defaults to 0. | +| `question` | string | The question to answer given the inference context | +| `results_field` | string | The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. | +| `tokenization` | [MlNlpTokenizationUpdateOptions](./MlNlpTokenizationUpdateOptions.md) | The tokenization options to update when inferring | diff --git a/docs/reference/api/MlRegressionInferenceOptions.md b/docs/reference/api/MlRegressionInferenceOptions.md new file mode 100644 index 000000000..a1a3ade30 --- /dev/null +++ b/docs/reference/api/MlRegressionInferenceOptions.md @@ -0,0 +1,6 @@ +## Interface `MlRegressionInferenceOptions` + +| Name | Type | Description | +| - | - | - | +| `num_top_feature_importance_values` | [integer](./integer.md) | Specifies the maximum number of feature importance values per document. | +| `results_field` | [Field](./Field.md) | The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. | diff --git a/docs/reference/api/MlResetJobRequest.md b/docs/reference/api/MlResetJobRequest.md new file mode 100644 index 000000000..f836a900c --- /dev/null +++ b/docs/reference/api/MlResetJobRequest.md @@ -0,0 +1,9 @@ +## Interface `MlResetJobRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { job_id?: never; wait_for_completion?: never; delete_user_annotations?: never; }) | All values in `body` will be added to the request body. | +| `delete_user_annotations` | boolean | Specifies whether annotations that have been added by the user should be deleted along with any auto-generated annotations when the job is reset. | +| `job_id` | [Id](./Id.md) | The ID of the job to reset. | +| `querystring` | { [key: string]: any; } & { job_id?: never; wait_for_completion?: never; delete_user_annotations?: never; } | All values in `querystring` will be added to the request querystring. | +| `wait_for_completion` | boolean | Should this request wait until the operation has completed before returning. | diff --git a/docs/reference/api/MlResetJobResponse.md b/docs/reference/api/MlResetJobResponse.md new file mode 100644 index 000000000..cd889e0f8 --- /dev/null +++ b/docs/reference/api/MlResetJobResponse.md @@ -0,0 +1,4 @@ +## `MlResetJobResponse` +::: +type MlResetJobResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); +::: diff --git a/docs/reference/api/MlRevertModelSnapshotRequest.md b/docs/reference/api/MlRevertModelSnapshotRequest.md new file mode 100644 index 000000000..749f8da74 --- /dev/null +++ b/docs/reference/api/MlRevertModelSnapshotRequest.md @@ -0,0 +1,9 @@ +## Interface `MlRevertModelSnapshotRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { job_id?: never; snapshot_id?: never; delete_intervening_results?: never; }) | All values in `body` will be added to the request body. | +| `delete_intervening_results` | boolean | Refer to the description for the `delete_intervening_results` query parameter. | +| `job_id` | [Id](./Id.md) | Identifier for the anomaly detection job. | +| `querystring` | { [key: string]: any; } & { job_id?: never; snapshot_id?: never; delete_intervening_results?: never; } | All values in `querystring` will be added to the request querystring. | +| `snapshot_id` | [Id](./Id.md) | You can specify `empty` as the < snapshot_id > . Reverting to the empty snapshot means the anomaly detection job starts learning a new model from scratch when it is started. | diff --git a/docs/reference/api/MlRevertModelSnapshotResponse.md b/docs/reference/api/MlRevertModelSnapshotResponse.md new file mode 100644 index 000000000..da3cee0d3 --- /dev/null +++ b/docs/reference/api/MlRevertModelSnapshotResponse.md @@ -0,0 +1,5 @@ +## Interface `MlRevertModelSnapshotResponse` + +| Name | Type | Description | +| - | - | - | +| `model` | [MlModelSnapshot](./MlModelSnapshot.md) |   | diff --git a/docs/reference/api/MlRoutingState.md b/docs/reference/api/MlRoutingState.md new file mode 100644 index 000000000..c7eda096f --- /dev/null +++ b/docs/reference/api/MlRoutingState.md @@ -0,0 +1,4 @@ +## `MlRoutingState` +::: +type MlRoutingState = 'failed' | 'started' | 'starting' | 'stopped' | 'stopping'; +::: diff --git a/docs/reference/api/MlRuleAction.md b/docs/reference/api/MlRuleAction.md new file mode 100644 index 000000000..7c2f4d003 --- /dev/null +++ b/docs/reference/api/MlRuleAction.md @@ -0,0 +1,4 @@ +## `MlRuleAction` +::: +type MlRuleAction = 'skip_result' | 'skip_model_update'; +::: diff --git a/docs/reference/api/MlRuleCondition.md b/docs/reference/api/MlRuleCondition.md new file mode 100644 index 000000000..f7a371bd2 --- /dev/null +++ b/docs/reference/api/MlRuleCondition.md @@ -0,0 +1,7 @@ +## Interface `MlRuleCondition` + +| Name | Type | Description | +| - | - | - | +| `applies_to` | [MlAppliesTo](./MlAppliesTo.md) | Specifies the result property to which the condition applies. If your detector uses `lat_long`, `metric`, `rare`, or `freq_rare` functions, you can only specify conditions that apply to time. | +| `operator` | [MlConditionOperator](./MlConditionOperator.md) | Specifies the condition operator. The available options are greater than, greater than or equals, less than, and less than or equals. | +| `value` | [double](./double.md) | The value that is compared against the `applies_to` field using the operator. | diff --git a/docs/reference/api/MlRunningStateSearchInterval.md b/docs/reference/api/MlRunningStateSearchInterval.md new file mode 100644 index 000000000..4cfa32487 --- /dev/null +++ b/docs/reference/api/MlRunningStateSearchInterval.md @@ -0,0 +1,8 @@ +## Interface `MlRunningStateSearchInterval` + +| Name | Type | Description | +| - | - | - | +| `end_ms` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> | The end time as an epoch in milliseconds. | +| `end` | [Duration](./Duration.md) | The end time. | +| `start_ms` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> | The start time as an epoch in milliseconds. | +| `start` | [Duration](./Duration.md) | The start time. | diff --git a/docs/reference/api/MlSetUpgradeModeRequest.md b/docs/reference/api/MlSetUpgradeModeRequest.md new file mode 100644 index 000000000..289460e21 --- /dev/null +++ b/docs/reference/api/MlSetUpgradeModeRequest.md @@ -0,0 +1,8 @@ +## Interface `MlSetUpgradeModeRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { enabled?: never; timeout?: never; }) | All values in `body` will be added to the request body. | +| `enabled` | boolean | When `true`, it enables `upgrade_mode` which temporarily halts all job and datafeed tasks and prohibits new job and datafeed tasks from starting. | +| `querystring` | { [key: string]: any; } & { enabled?: never; timeout?: never; } | All values in `querystring` will be added to the request querystring. | +| `timeout` | [Duration](./Duration.md) | The time to wait for the request to be completed. | diff --git a/docs/reference/api/MlSetUpgradeModeResponse.md b/docs/reference/api/MlSetUpgradeModeResponse.md new file mode 100644 index 000000000..e18b9cf19 --- /dev/null +++ b/docs/reference/api/MlSetUpgradeModeResponse.md @@ -0,0 +1,4 @@ +## `MlSetUpgradeModeResponse` +::: +type MlSetUpgradeModeResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); +::: diff --git a/docs/reference/api/MlSnapshotUpgradeState.md b/docs/reference/api/MlSnapshotUpgradeState.md new file mode 100644 index 000000000..6ebf38423 --- /dev/null +++ b/docs/reference/api/MlSnapshotUpgradeState.md @@ -0,0 +1,4 @@ +## `MlSnapshotUpgradeState` +::: +type MlSnapshotUpgradeState = 'loading_old_state' | 'saving_new_state' | 'stopped' | 'failed'; +::: diff --git a/docs/reference/api/MlStartDataFrameAnalyticsRequest.md b/docs/reference/api/MlStartDataFrameAnalyticsRequest.md new file mode 100644 index 000000000..861c7b7ef --- /dev/null +++ b/docs/reference/api/MlStartDataFrameAnalyticsRequest.md @@ -0,0 +1,8 @@ +## Interface `MlStartDataFrameAnalyticsRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { id?: never; timeout?: never; }) | All values in `body` will be added to the request body. | +| `id` | [Id](./Id.md) | Identifier for the data frame analytics job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters. | +| `querystring` | { [key: string]: any; } & { id?: never; timeout?: never; } | All values in `querystring` will be added to the request querystring. | +| `timeout` | [Duration](./Duration.md) | Controls the amount of time to wait until the data frame analytics job starts. | diff --git a/docs/reference/api/MlStartDataFrameAnalyticsResponse.md b/docs/reference/api/MlStartDataFrameAnalyticsResponse.md new file mode 100644 index 000000000..e44141ede --- /dev/null +++ b/docs/reference/api/MlStartDataFrameAnalyticsResponse.md @@ -0,0 +1,6 @@ +## Interface `MlStartDataFrameAnalyticsResponse` + +| Name | Type | Description | +| - | - | - | +| `acknowledged` | boolean |   | +| `node` | [NodeId](./NodeId.md) | The ID of the node that the job was started on. If the job is allowed to open lazily and has not yet been assigned to a node, this value is an empty string. The node ID of the node the job has been assigned to, or an empty string if it hasn't been assigned to a node. In serverless if the job has been assigned to run then the node ID will be "serverless". | diff --git a/docs/reference/api/MlStartDatafeedRequest.md b/docs/reference/api/MlStartDatafeedRequest.md new file mode 100644 index 000000000..f03599eab --- /dev/null +++ b/docs/reference/api/MlStartDatafeedRequest.md @@ -0,0 +1,10 @@ +## Interface `MlStartDatafeedRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { datafeed_id?: never; end?: never; start?: never; timeout?: never; }) | All values in `body` will be added to the request body. | +| `datafeed_id` | [Id](./Id.md) | A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters. | +| `end` | [DateTime](./DateTime.md) | Refer to the description for the `end` query parameter. | +| `querystring` | { [key: string]: any; } & { datafeed_id?: never; end?: never; start?: never; timeout?: never; } | All values in `querystring` will be added to the request querystring. | +| `start` | [DateTime](./DateTime.md) | Refer to the description for the `start` query parameter. | +| `timeout` | [Duration](./Duration.md) | Refer to the description for the `timeout` query parameter. | diff --git a/docs/reference/api/MlStartDatafeedResponse.md b/docs/reference/api/MlStartDatafeedResponse.md new file mode 100644 index 000000000..b8009f84b --- /dev/null +++ b/docs/reference/api/MlStartDatafeedResponse.md @@ -0,0 +1,6 @@ +## Interface `MlStartDatafeedResponse` + +| Name | Type | Description | +| - | - | - | +| `node` | [NodeIds](./NodeIds.md) | The ID of the node that the job was started on. In serverless this will be the "serverless". If the job is allowed to open lazily and has not yet been assigned to a node, this value is an empty string. | +| `started` | boolean | For a successful response, this value is always `true`. On failure, an exception is returned instead. | diff --git a/docs/reference/api/MlStartTrainedModelDeploymentRequest.md b/docs/reference/api/MlStartTrainedModelDeploymentRequest.md new file mode 100644 index 000000000..cf0826236 --- /dev/null +++ b/docs/reference/api/MlStartTrainedModelDeploymentRequest.md @@ -0,0 +1,16 @@ +## Interface `MlStartTrainedModelDeploymentRequest` + +| Name | Type | Description | +| - | - | - | +| `adaptive_allocations` | [MlAdaptiveAllocationsSettings](./MlAdaptiveAllocationsSettings.md) | Adaptive allocations configuration. When enabled, the number of allocations is set based on the current load. If adaptive_allocations is enabled, do not set the number of allocations manually. | +| `body` | string | ({ [key: string]: any; } & { model_id?: never; cache_size?: never; deployment_id?: never; number_of_allocations?: never; priority?: never; queue_capacity?: never; threads_per_allocation?: never; timeout?: never; wait_for?: never; adaptive_allocations?: never; }) | All values in `body` will be added to the request body. | +| `cache_size` | [ByteSize](./ByteSize.md) | The inference cache size (in memory outside the JVM heap) per node for the model. The default value is the same size as the `model_size_bytes`. To disable the cache, `0b` can be provided. | +| `deployment_id` | string | A unique identifier for the deployment of the model. | +| `model_id` | [Id](./Id.md) | The unique identifier of the trained model. Currently, only PyTorch models are supported. | +| `number_of_allocations` | [integer](./integer.md) | The number of model allocations on each node where the model is deployed. All allocations on a node share the same copy of the model in memory but use a separate set of threads to evaluate the model. Increasing this value generally increases the throughput. If this setting is greater than the number of hardware threads it will automatically be changed to a value less than the number of hardware threads. If adaptive_allocations is enabled, do not set this value, because it’s automatically set. | +| `priority` | [MlTrainingPriority](./MlTrainingPriority.md) | The deployment priority. | +| `querystring` | { [key: string]: any; } & { model_id?: never; cache_size?: never; deployment_id?: never; number_of_allocations?: never; priority?: never; queue_capacity?: never; threads_per_allocation?: never; timeout?: never; wait_for?: never; adaptive_allocations?: never; } | All values in `querystring` will be added to the request querystring. | +| `queue_capacity` | [integer](./integer.md) | Specifies the number of inference requests that are allowed in the queue. After the number of requests exceeds this value, new requests are rejected with a 429 error. | +| `threads_per_allocation` | [integer](./integer.md) | Sets the number of threads used by each model allocation during inference. This generally increases the inference speed. The inference process is a compute-bound process; any number greater than the number of available hardware threads on the machine does not increase the inference speed. If this setting is greater than the number of hardware threads it will automatically be changed to a value less than the number of hardware threads. | +| `timeout` | [Duration](./Duration.md) | Specifies the amount of time to wait for the model to deploy. | +| `wait_for` | [MlDeploymentAllocationState](./MlDeploymentAllocationState.md) | Specifies the allocation status to wait for before returning. | diff --git a/docs/reference/api/MlStartTrainedModelDeploymentResponse.md b/docs/reference/api/MlStartTrainedModelDeploymentResponse.md new file mode 100644 index 000000000..f0ad276d4 --- /dev/null +++ b/docs/reference/api/MlStartTrainedModelDeploymentResponse.md @@ -0,0 +1,5 @@ +## Interface `MlStartTrainedModelDeploymentResponse` + +| Name | Type | Description | +| - | - | - | +| `assignment` | [MlTrainedModelAssignment](./MlTrainedModelAssignment.md) |   | diff --git a/docs/reference/api/MlStopDataFrameAnalyticsRequest.md b/docs/reference/api/MlStopDataFrameAnalyticsRequest.md new file mode 100644 index 000000000..870212687 --- /dev/null +++ b/docs/reference/api/MlStopDataFrameAnalyticsRequest.md @@ -0,0 +1,10 @@ +## Interface `MlStopDataFrameAnalyticsRequest` + +| Name | Type | Description | +| - | - | - | +| `allow_no_match` | boolean | Specifies what to do when the request: 1. Contains wildcard expressions and there are no data frame analytics jobs that match. 2. Contains the _all string or no identifiers and there are no matches. 3. Contains wildcard expressions and there are only partial matches. The default value is true, which returns an empty data_frame_analytics array when there are no matches and the subset of results when there are partial matches. If this parameter is false, the request returns a 404 status code when there are no matches or only partial matches. | +| `body` | string | ({ [key: string]: any; } & { id?: never; allow_no_match?: never; force?: never; timeout?: never; }) | All values in `body` will be added to the request body. | +| `force` | boolean | If true, the data frame analytics job is stopped forcefully. | +| `id` | [Id](./Id.md) | Identifier for the data frame analytics job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters. | +| `querystring` | { [key: string]: any; } & { id?: never; allow_no_match?: never; force?: never; timeout?: never; } | All values in `querystring` will be added to the request querystring. | +| `timeout` | [Duration](./Duration.md) | Controls the amount of time to wait until the data frame analytics job stops. Defaults to 20 seconds. | diff --git a/docs/reference/api/MlStopDataFrameAnalyticsResponse.md b/docs/reference/api/MlStopDataFrameAnalyticsResponse.md new file mode 100644 index 000000000..d175aecdd --- /dev/null +++ b/docs/reference/api/MlStopDataFrameAnalyticsResponse.md @@ -0,0 +1,5 @@ +## Interface `MlStopDataFrameAnalyticsResponse` + +| Name | Type | Description | +| - | - | - | +| `stopped` | boolean |   | diff --git a/docs/reference/api/MlStopDatafeedRequest.md b/docs/reference/api/MlStopDatafeedRequest.md new file mode 100644 index 000000000..e83d6505f --- /dev/null +++ b/docs/reference/api/MlStopDatafeedRequest.md @@ -0,0 +1,10 @@ +## Interface `MlStopDatafeedRequest` + +| Name | Type | Description | +| - | - | - | +| `allow_no_match` | boolean | Refer to the description for the `allow_no_match` query parameter. | +| `body` | string | ({ [key: string]: any; } & { datafeed_id?: never; allow_no_match?: never; force?: never; timeout?: never; }) | All values in `body` will be added to the request body. | +| `datafeed_id` | [Id](./Id.md) | Identifier for the datafeed. You can stop multiple datafeeds in a single API request by using a comma-separated list of datafeeds or a wildcard expression. You can close all datafeeds by using `_all` or by specifying `*` as the identifier. | +| `force` | boolean | Refer to the description for the `force` query parameter. | +| `querystring` | { [key: string]: any; } & { datafeed_id?: never; allow_no_match?: never; force?: never; timeout?: never; } | All values in `querystring` will be added to the request querystring. | +| `timeout` | [Duration](./Duration.md) | Refer to the description for the `timeout` query parameter. | diff --git a/docs/reference/api/MlStopDatafeedResponse.md b/docs/reference/api/MlStopDatafeedResponse.md new file mode 100644 index 000000000..e643a3310 --- /dev/null +++ b/docs/reference/api/MlStopDatafeedResponse.md @@ -0,0 +1,5 @@ +## Interface `MlStopDatafeedResponse` + +| Name | Type | Description | +| - | - | - | +| `stopped` | boolean |   | diff --git a/docs/reference/api/MlStopTrainedModelDeploymentRequest.md b/docs/reference/api/MlStopTrainedModelDeploymentRequest.md new file mode 100644 index 000000000..cb7a2d1ea --- /dev/null +++ b/docs/reference/api/MlStopTrainedModelDeploymentRequest.md @@ -0,0 +1,9 @@ +## Interface `MlStopTrainedModelDeploymentRequest` + +| Name | Type | Description | +| - | - | - | +| `allow_no_match` | boolean | Specifies what to do when the request: contains wildcard expressions and there are no deployments that match; contains the `_all` string or no identifiers and there are no matches; or contains wildcard expressions and there are only partial matches. By default, it returns an empty array when there are no matches and the subset of results when there are partial matches. If `false`, the request returns a 404 status code when there are no matches or only partial matches. | +| `body` | string | ({ [key: string]: any; } & { model_id?: never; allow_no_match?: never; force?: never; }) | All values in `body` will be added to the request body. | +| `force` | boolean | Forcefully stops the deployment, even if it is used by ingest pipelines. You can't use these pipelines until you restart the model deployment. | +| `model_id` | [Id](./Id.md) | The unique identifier of the trained model. | +| `querystring` | { [key: string]: any; } & { model_id?: never; allow_no_match?: never; force?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/MlStopTrainedModelDeploymentResponse.md b/docs/reference/api/MlStopTrainedModelDeploymentResponse.md new file mode 100644 index 000000000..aba8d8fa1 --- /dev/null +++ b/docs/reference/api/MlStopTrainedModelDeploymentResponse.md @@ -0,0 +1,5 @@ +## Interface `MlStopTrainedModelDeploymentResponse` + +| Name | Type | Description | +| - | - | - | +| `stopped` | boolean |   | diff --git a/docs/reference/api/MlTextClassificationInferenceOptions.md b/docs/reference/api/MlTextClassificationInferenceOptions.md new file mode 100644 index 000000000..a5105cd20 --- /dev/null +++ b/docs/reference/api/MlTextClassificationInferenceOptions.md @@ -0,0 +1,9 @@ +## Interface `MlTextClassificationInferenceOptions` + +| Name | Type | Description | +| - | - | - | +| `classification_labels` | string[] | Classification labels to apply other than the stored labels. Must have the same deminsions as the default configured labels | +| `num_top_classes` | [integer](./integer.md) | Specifies the number of top class predictions to return. Defaults to 0. | +| `results_field` | string | The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. | +| `tokenization` | [MlTokenizationConfigContainer](./MlTokenizationConfigContainer.md) | The tokenization options | +| `vocabulary` | [MlVocabulary](./MlVocabulary.md) |   | diff --git a/docs/reference/api/MlTextClassificationInferenceUpdateOptions.md b/docs/reference/api/MlTextClassificationInferenceUpdateOptions.md new file mode 100644 index 000000000..ed0771aca --- /dev/null +++ b/docs/reference/api/MlTextClassificationInferenceUpdateOptions.md @@ -0,0 +1,8 @@ +## Interface `MlTextClassificationInferenceUpdateOptions` + +| Name | Type | Description | +| - | - | - | +| `classification_labels` | string[] | Classification labels to apply other than the stored labels. Must have the same deminsions as the default configured labels | +| `num_top_classes` | [integer](./integer.md) | Specifies the number of top class predictions to return. Defaults to 0. | +| `results_field` | string | The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. | +| `tokenization` | [MlNlpTokenizationUpdateOptions](./MlNlpTokenizationUpdateOptions.md) | The tokenization options to update when inferring | diff --git a/docs/reference/api/MlTextEmbeddingInferenceOptions.md b/docs/reference/api/MlTextEmbeddingInferenceOptions.md new file mode 100644 index 000000000..e268dc984 --- /dev/null +++ b/docs/reference/api/MlTextEmbeddingInferenceOptions.md @@ -0,0 +1,8 @@ +## Interface `MlTextEmbeddingInferenceOptions` + +| Name | Type | Description | +| - | - | - | +| `embedding_size` | [integer](./integer.md) | The number of dimensions in the embedding output | +| `results_field` | string | The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. | +| `tokenization` | [MlTokenizationConfigContainer](./MlTokenizationConfigContainer.md) | The tokenization options | +| `vocabulary` | [MlVocabulary](./MlVocabulary.md) |   | diff --git a/docs/reference/api/MlTextEmbeddingInferenceUpdateOptions.md b/docs/reference/api/MlTextEmbeddingInferenceUpdateOptions.md new file mode 100644 index 000000000..0968162a5 --- /dev/null +++ b/docs/reference/api/MlTextEmbeddingInferenceUpdateOptions.md @@ -0,0 +1,6 @@ +## Interface `MlTextEmbeddingInferenceUpdateOptions` + +| Name | Type | Description | +| - | - | - | +| `results_field` | string | The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. | +| `tokenization` | [MlNlpTokenizationUpdateOptions](./MlNlpTokenizationUpdateOptions.md) |   | diff --git a/docs/reference/api/MlTextExpansionInferenceOptions.md b/docs/reference/api/MlTextExpansionInferenceOptions.md new file mode 100644 index 000000000..ae78826b6 --- /dev/null +++ b/docs/reference/api/MlTextExpansionInferenceOptions.md @@ -0,0 +1,7 @@ +## Interface `MlTextExpansionInferenceOptions` + +| Name | Type | Description | +| - | - | - | +| `results_field` | string | The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. | +| `tokenization` | [MlTokenizationConfigContainer](./MlTokenizationConfigContainer.md) | The tokenization options | +| `vocabulary` | [MlVocabulary](./MlVocabulary.md) |   | diff --git a/docs/reference/api/MlTextExpansionInferenceUpdateOptions.md b/docs/reference/api/MlTextExpansionInferenceUpdateOptions.md new file mode 100644 index 000000000..7ec50c50f --- /dev/null +++ b/docs/reference/api/MlTextExpansionInferenceUpdateOptions.md @@ -0,0 +1,6 @@ +## Interface `MlTextExpansionInferenceUpdateOptions` + +| Name | Type | Description | +| - | - | - | +| `results_field` | string | The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. | +| `tokenization` | [MlNlpTokenizationUpdateOptions](./MlNlpTokenizationUpdateOptions.md) |   | diff --git a/docs/reference/api/MlTimingStats.md b/docs/reference/api/MlTimingStats.md new file mode 100644 index 000000000..58c4b1d24 --- /dev/null +++ b/docs/reference/api/MlTimingStats.md @@ -0,0 +1,6 @@ +## Interface `MlTimingStats` + +| Name | Type | Description | +| - | - | - | +| `elapsed_time` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> | Runtime of the analysis in milliseconds. | +| `iteration_time` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> | Runtime of the latest iteration of the analysis in milliseconds. | diff --git a/docs/reference/api/MlTokenizationConfigContainer.md b/docs/reference/api/MlTokenizationConfigContainer.md new file mode 100644 index 000000000..ed9fd2f81 --- /dev/null +++ b/docs/reference/api/MlTokenizationConfigContainer.md @@ -0,0 +1,9 @@ +## Interface `MlTokenizationConfigContainer` + +| Name | Type | Description | +| - | - | - | +| `bert_ja` | [MlNlpBertTokenizationConfig](./MlNlpBertTokenizationConfig.md) | Indicates BERT Japanese tokenization and its options | +| `bert` | [MlNlpBertTokenizationConfig](./MlNlpBertTokenizationConfig.md) | Indicates BERT tokenization and its options | +| `mpnet` | [MlNlpBertTokenizationConfig](./MlNlpBertTokenizationConfig.md) | Indicates MPNET tokenization and its options | +| `roberta` | [MlNlpRobertaTokenizationConfig](./MlNlpRobertaTokenizationConfig.md) | Indicates RoBERTa tokenization and its options | +| `xlm_roberta` | [MlXlmRobertaTokenizationConfig](./MlXlmRobertaTokenizationConfig.md) |   | diff --git a/docs/reference/api/MlTokenizationTruncate.md b/docs/reference/api/MlTokenizationTruncate.md new file mode 100644 index 000000000..2ec430835 --- /dev/null +++ b/docs/reference/api/MlTokenizationTruncate.md @@ -0,0 +1,4 @@ +## `MlTokenizationTruncate` +::: +type MlTokenizationTruncate = 'first' | 'second' | 'none'; +::: diff --git a/docs/reference/api/MlTopClassEntry.md b/docs/reference/api/MlTopClassEntry.md new file mode 100644 index 000000000..3a50b68f0 --- /dev/null +++ b/docs/reference/api/MlTopClassEntry.md @@ -0,0 +1,7 @@ +## Interface `MlTopClassEntry` + +| Name | Type | Description | +| - | - | - | +| `class_name` | string |   | +| `class_probability` | [double](./double.md) |   | +| `class_score` | [double](./double.md) |   | diff --git a/docs/reference/api/MlTotalFeatureImportance.md b/docs/reference/api/MlTotalFeatureImportance.md new file mode 100644 index 000000000..fc7b7b187 --- /dev/null +++ b/docs/reference/api/MlTotalFeatureImportance.md @@ -0,0 +1,7 @@ +## Interface `MlTotalFeatureImportance` + +| Name | Type | Description | +| - | - | - | +| `classes` | [MlTotalFeatureImportanceClass](./MlTotalFeatureImportanceClass.md)[] | If the trained model is a classification model, feature importance statistics are gathered per target class value. | +| `feature_name` | [Name](./Name.md) | The feature for which this importance was calculated. | +| `importance` | [MlTotalFeatureImportanceStatistics](./MlTotalFeatureImportanceStatistics.md)[] | A collection of feature importance statistics related to the training data set for this particular feature. | diff --git a/docs/reference/api/MlTotalFeatureImportanceClass.md b/docs/reference/api/MlTotalFeatureImportanceClass.md new file mode 100644 index 000000000..5f01c02ea --- /dev/null +++ b/docs/reference/api/MlTotalFeatureImportanceClass.md @@ -0,0 +1,6 @@ +## Interface `MlTotalFeatureImportanceClass` + +| Name | Type | Description | +| - | - | - | +| `class_name` | [Name](./Name.md) | The target class value. Could be a string, boolean, or number. | +| `importance` | [MlTotalFeatureImportanceStatistics](./MlTotalFeatureImportanceStatistics.md)[] | A collection of feature importance statistics related to the training data set for this particular feature. | diff --git a/docs/reference/api/MlTotalFeatureImportanceStatistics.md b/docs/reference/api/MlTotalFeatureImportanceStatistics.md new file mode 100644 index 000000000..6a63f2977 --- /dev/null +++ b/docs/reference/api/MlTotalFeatureImportanceStatistics.md @@ -0,0 +1,7 @@ +## Interface `MlTotalFeatureImportanceStatistics` + +| Name | Type | Description | +| - | - | - | +| `max` | [integer](./integer.md) | The maximum importance value across all the training data for this feature. | +| `mean_magnitude` | [double](./double.md) | The average magnitude of this feature across all the training data. This value is the average of the absolute values of the importance for this feature. | +| `min` | [integer](./integer.md) | The minimum importance value across all the training data for this feature. | diff --git a/docs/reference/api/MlTrainedModelAssignment.md b/docs/reference/api/MlTrainedModelAssignment.md new file mode 100644 index 000000000..667df9d66 --- /dev/null +++ b/docs/reference/api/MlTrainedModelAssignment.md @@ -0,0 +1,11 @@ +## Interface `MlTrainedModelAssignment` + +| Name | Type | Description | +| - | - | - | +| `adaptive_allocations` | [MlAdaptiveAllocationsSettings](./MlAdaptiveAllocationsSettings.md) | null |   | +| `assignment_state` | [MlDeploymentAssignmentState](./MlDeploymentAssignmentState.md) | The overall assignment state. | +| `max_assigned_allocations` | [integer](./integer.md) |   | +| `reason` | string |   | +| `routing_table` | Record | The allocation state for each node. | +| `start_time` | [DateTime](./DateTime.md) | The timestamp when the deployment started. | +| `task_parameters` | [MlTrainedModelAssignmentTaskParameters](./MlTrainedModelAssignmentTaskParameters.md) |   | diff --git a/docs/reference/api/MlTrainedModelAssignmentRoutingStateAndReason.md b/docs/reference/api/MlTrainedModelAssignmentRoutingStateAndReason.md new file mode 100644 index 000000000..bbbae8b03 --- /dev/null +++ b/docs/reference/api/MlTrainedModelAssignmentRoutingStateAndReason.md @@ -0,0 +1,6 @@ +## Interface `MlTrainedModelAssignmentRoutingStateAndReason` + +| Name | Type | Description | +| - | - | - | +| `reason` | string | The reason for the current state. It is usually populated only when the `routing_state` is `failed`. | +| `routing_state` | [MlRoutingState](./MlRoutingState.md) | The current routing state. | diff --git a/docs/reference/api/MlTrainedModelAssignmentRoutingTable.md b/docs/reference/api/MlTrainedModelAssignmentRoutingTable.md new file mode 100644 index 000000000..bedc0ef7c --- /dev/null +++ b/docs/reference/api/MlTrainedModelAssignmentRoutingTable.md @@ -0,0 +1,8 @@ +## Interface `MlTrainedModelAssignmentRoutingTable` + +| Name | Type | Description | +| - | - | - | +| `current_allocations` | [integer](./integer.md) | Current number of allocations. | +| `reason` | string | The reason for the current state. It is usually populated only when the `routing_state` is `failed`. | +| `routing_state` | [MlRoutingState](./MlRoutingState.md) | The current routing state. | +| `target_allocations` | [integer](./integer.md) | Target number of allocations. | diff --git a/docs/reference/api/MlTrainedModelAssignmentTaskParameters.md b/docs/reference/api/MlTrainedModelAssignmentTaskParameters.md new file mode 100644 index 000000000..c7cd22209 --- /dev/null +++ b/docs/reference/api/MlTrainedModelAssignmentTaskParameters.md @@ -0,0 +1,14 @@ +## Interface `MlTrainedModelAssignmentTaskParameters` + +| Name | Type | Description | +| - | - | - | +| `cache_size` | [ByteSize](./ByteSize.md) | The size of the trained model cache. | +| `deployment_id` | [Id](./Id.md) | The unique identifier for the trained model deployment. | +| `model_bytes` | [ByteSize](./ByteSize.md) | The size of the trained model in bytes. | +| `model_id` | [Id](./Id.md) | The unique identifier for the trained model. | +| `number_of_allocations` | [integer](./integer.md) | The total number of allocations this model is assigned across ML nodes. | +| `per_allocation_memory_bytes` | [ByteSize](./ByteSize.md) |   | +| `per_deployment_memory_bytes` | [ByteSize](./ByteSize.md) |   | +| `priority` | [MlTrainingPriority](./MlTrainingPriority.md) |   | +| `queue_capacity` | [integer](./integer.md) | Number of inference requests are allowed in the queue at a time. | +| `threads_per_allocation` | [integer](./integer.md) | Number of threads per allocation. | diff --git a/docs/reference/api/MlTrainedModelConfig.md b/docs/reference/api/MlTrainedModelConfig.md new file mode 100644 index 000000000..4831da466 --- /dev/null +++ b/docs/reference/api/MlTrainedModelConfig.md @@ -0,0 +1,25 @@ +## Interface `MlTrainedModelConfig` + +| Name | Type | Description | +| - | - | - | +| `compressed_definition` | string |   | +| `create_time` | [DateTime](./DateTime.md) | The time when the trained model was created. | +| `created_by` | string | Information on the creator of the trained model. | +| `default_field_map` | Record | Any field map described in the inference configuration takes precedence. | +| `description` | string | The free-text description of the trained model. | +| `estimated_heap_memory_usage_bytes` | [integer](./integer.md) | The estimated heap usage in bytes to keep the trained model in memory. | +| `estimated_operations` | [integer](./integer.md) | The estimated number of operations to use the trained model. | +| `fully_defined` | boolean | True if the full model definition is present. | +| `inference_config` | [MlInferenceConfigCreateContainer](./MlInferenceConfigCreateContainer.md) | The default configuration for inference. This can be either a regression, classification, or one of the many NLP focused configurations. It must match the underlying definition.trained_model's target_type. For pre-packaged models such as ELSER the config is not required. | +| `input` | [MlTrainedModelConfigInput](./MlTrainedModelConfigInput.md) | The input field names for the model definition. | +| `license_level` | string | The license level of the trained model. | +| `location` | [MlTrainedModelLocation](./MlTrainedModelLocation.md) |   | +| `metadata` | [MlTrainedModelConfigMetadata](./MlTrainedModelConfigMetadata.md) | An object containing metadata about the trained model. For example, models created by data frame analytics contain analysis_config and input objects. | +| `model_id` | [Id](./Id.md) | Identifier for the trained model. | +| `model_package` | [MlModelPackageConfig](./MlModelPackageConfig.md) |   | +| `model_size_bytes` | [ByteSize](./ByteSize.md) |   | +| `model_type` | [MlTrainedModelType](./MlTrainedModelType.md) | The model type | +| `platform_architecture` | string |   | +| `prefix_strings` | [MlTrainedModelPrefixStrings](./MlTrainedModelPrefixStrings.md) |   | +| `tags` | string[] | A comma delimited string of tags. A trained model can have many tags, or none. | +| `version` | [VersionString](./VersionString.md) | The Elasticsearch version number in which the trained model was created. | diff --git a/docs/reference/api/MlTrainedModelConfigInput.md b/docs/reference/api/MlTrainedModelConfigInput.md new file mode 100644 index 000000000..7ebe33aed --- /dev/null +++ b/docs/reference/api/MlTrainedModelConfigInput.md @@ -0,0 +1,5 @@ +## Interface `MlTrainedModelConfigInput` + +| Name | Type | Description | +| - | - | - | +| `field_names` | [Field](./Field.md)[] | An array of input field names for the model. | diff --git a/docs/reference/api/MlTrainedModelConfigMetadata.md b/docs/reference/api/MlTrainedModelConfigMetadata.md new file mode 100644 index 000000000..74513f730 --- /dev/null +++ b/docs/reference/api/MlTrainedModelConfigMetadata.md @@ -0,0 +1,8 @@ +## Interface `MlTrainedModelConfigMetadata` + +| Name | Type | Description | +| - | - | - | +| `feature_importance_baseline` | Record | An object that contains the baseline for feature importance values. For regression analysis, it is a single value. For classification analysis, there is a value for each class. | +| `hyperparameters` | [MlHyperparameter](./MlHyperparameter.md)[] | List of the available hyperparameters optimized during the fine_parameter_tuning phase as well as specified by the user. | +| `model_aliases` | string[] |   | +| `total_feature_importance` | [MlTotalFeatureImportance](./MlTotalFeatureImportance.md)[] | An array of the total feature importance for each feature used from the training data set. This array of objects is returned if data frame analytics trained the model and the request includes total_feature_importance in the include request parameter. | diff --git a/docs/reference/api/MlTrainedModelDeploymentAllocationStatus.md b/docs/reference/api/MlTrainedModelDeploymentAllocationStatus.md new file mode 100644 index 000000000..ca26cbaab --- /dev/null +++ b/docs/reference/api/MlTrainedModelDeploymentAllocationStatus.md @@ -0,0 +1,7 @@ +## Interface `MlTrainedModelDeploymentAllocationStatus` + +| Name | Type | Description | +| - | - | - | +| `allocation_count` | [integer](./integer.md) | The current number of nodes where the model is allocated. | +| `state` | [MlDeploymentAllocationState](./MlDeploymentAllocationState.md) | The detailed allocation state related to the nodes. | +| `target_allocation_count` | [integer](./integer.md) | The desired number of nodes for model allocation. | diff --git a/docs/reference/api/MlTrainedModelDeploymentNodesStats.md b/docs/reference/api/MlTrainedModelDeploymentNodesStats.md new file mode 100644 index 000000000..4a83428e6 --- /dev/null +++ b/docs/reference/api/MlTrainedModelDeploymentNodesStats.md @@ -0,0 +1,22 @@ +## Interface `MlTrainedModelDeploymentNodesStats` + +| Name | Type | Description | +| - | - | - | +| `average_inference_time_ms_excluding_cache_hits` | [DurationValue](./DurationValue.md)<[UnitFloatMillis](./UnitFloatMillis.md)> | The average time for each inference call to complete on this node, excluding cache | +| `average_inference_time_ms_last_minute` | [DurationValue](./DurationValue.md)<[UnitFloatMillis](./UnitFloatMillis.md)> |   | +| `average_inference_time_ms` | [DurationValue](./DurationValue.md)<[UnitFloatMillis](./UnitFloatMillis.md)> | The average time for each inference call to complete on this node. | +| `error_count` | [integer](./integer.md) | The number of errors when evaluating the trained model. | +| `inference_cache_hit_count_last_minute` | [long](./long.md) |   | +| `inference_cache_hit_count` | [long](./long.md) |   | +| `inference_count` | [long](./long.md) | The total number of inference calls made against this node for this model. | +| `last_access` | [EpochTime](./EpochTime.md)<[UnitMillis](./UnitMillis.md)> | The epoch time stamp of the last inference call for the model on this node. | +| `node` | [MlDiscoveryNode](./MlDiscoveryNode.md) | Information pertaining to the node. | +| `number_of_allocations` | [integer](./integer.md) | The number of allocations assigned to this node. | +| `number_of_pending_requests` | [integer](./integer.md) | The number of inference requests queued to be processed. | +| `peak_throughput_per_minute` | [long](./long.md) |   | +| `rejected_execution_count` | [integer](./integer.md) | The number of inference requests that were not processed because the queue was full. | +| `routing_state` | [MlTrainedModelAssignmentRoutingStateAndReason](./MlTrainedModelAssignmentRoutingStateAndReason.md) | The current routing state and reason for the current routing state for this allocation. | +| `start_time` | [EpochTime](./EpochTime.md)<[UnitMillis](./UnitMillis.md)> | The epoch timestamp when the allocation started. | +| `threads_per_allocation` | [integer](./integer.md) | The number of threads used by each allocation during inference. | +| `throughput_last_minute` | [integer](./integer.md) |   | +| `timeout_count` | [integer](./integer.md) | The number of inference requests that timed out before being processed. | diff --git a/docs/reference/api/MlTrainedModelDeploymentStats.md b/docs/reference/api/MlTrainedModelDeploymentStats.md new file mode 100644 index 000000000..6aa16369d --- /dev/null +++ b/docs/reference/api/MlTrainedModelDeploymentStats.md @@ -0,0 +1,22 @@ +## Interface `MlTrainedModelDeploymentStats` + +| Name | Type | Description | +| - | - | - | +| `adaptive_allocations` | [MlAdaptiveAllocationsSettings](./MlAdaptiveAllocationsSettings.md) |   | +| `allocation_status` | [MlTrainedModelDeploymentAllocationStatus](./MlTrainedModelDeploymentAllocationStatus.md) | The detailed allocation status for the deployment. | +| `cache_size` | [ByteSize](./ByteSize.md) |   | +| `deployment_id` | [Id](./Id.md) | The unique identifier for the trained model deployment. | +| `error_count` | [integer](./integer.md) | The sum of `error_count` for all nodes in the deployment. | +| `inference_count` | [integer](./integer.md) | The sum of `inference_count` for all nodes in the deployment. | +| `model_id` | [Id](./Id.md) | The unique identifier for the trained model. | +| `nodes` | [MlTrainedModelDeploymentNodesStats](./MlTrainedModelDeploymentNodesStats.md)[] | The deployment stats for each node that currently has the model allocated. In serverless, stats are reported for a single unnamed virtual node. | +| `number_of_allocations` | [integer](./integer.md) | The number of allocations requested. | +| `peak_throughput_per_minute` | [long](./long.md) |   | +| `priority` | [MlTrainingPriority](./MlTrainingPriority.md) |   | +| `queue_capacity` | [integer](./integer.md) | The number of inference requests that can be queued before new requests are rejected. | +| `reason` | string | The reason for the current deployment state. Usually only populated when the model is not deployed to a node. | +| `rejected_execution_count` | [integer](./integer.md) | The sum of `rejected_execution_count` for all nodes in the deployment. Individual nodes reject an inference request if the inference queue is full. The queue size is controlled by the `queue_capacity` setting in the start trained model deployment API. | +| `start_time` | [EpochTime](./EpochTime.md)<[UnitMillis](./UnitMillis.md)> | The epoch timestamp when the deployment started. | +| `state` | [MlDeploymentAssignmentState](./MlDeploymentAssignmentState.md) | The overall state of the deployment. | +| `threads_per_allocation` | [integer](./integer.md) | The number of threads used be each allocation during inference. | +| `timeout_count` | [integer](./integer.md) | The sum of `timeout_count` for all nodes in the deployment. | diff --git a/docs/reference/api/MlTrainedModelEntities.md b/docs/reference/api/MlTrainedModelEntities.md new file mode 100644 index 000000000..ea4823515 --- /dev/null +++ b/docs/reference/api/MlTrainedModelEntities.md @@ -0,0 +1,9 @@ +## Interface `MlTrainedModelEntities` + +| Name | Type | Description | +| - | - | - | +| `class_name` | string |   | +| `class_probability` | [double](./double.md) |   | +| `end_pos` | [integer](./integer.md) |   | +| `entity` | string |   | +| `start_pos` | [integer](./integer.md) |   | diff --git a/docs/reference/api/MlTrainedModelInferenceClassImportance.md b/docs/reference/api/MlTrainedModelInferenceClassImportance.md new file mode 100644 index 000000000..3a9ac3cd4 --- /dev/null +++ b/docs/reference/api/MlTrainedModelInferenceClassImportance.md @@ -0,0 +1,6 @@ +## Interface `MlTrainedModelInferenceClassImportance` + +| Name | Type | Description | +| - | - | - | +| `class_name` | string |   | +| `importance` | [double](./double.md) |   | diff --git a/docs/reference/api/MlTrainedModelInferenceFeatureImportance.md b/docs/reference/api/MlTrainedModelInferenceFeatureImportance.md new file mode 100644 index 000000000..d3624c59c --- /dev/null +++ b/docs/reference/api/MlTrainedModelInferenceFeatureImportance.md @@ -0,0 +1,7 @@ +## Interface `MlTrainedModelInferenceFeatureImportance` + +| Name | Type | Description | +| - | - | - | +| `classes` | [MlTrainedModelInferenceClassImportance](./MlTrainedModelInferenceClassImportance.md)[] |   | +| `feature_name` | string |   | +| `importance` | [double](./double.md) |   | diff --git a/docs/reference/api/MlTrainedModelInferenceStats.md b/docs/reference/api/MlTrainedModelInferenceStats.md new file mode 100644 index 000000000..dc2cd3a28 --- /dev/null +++ b/docs/reference/api/MlTrainedModelInferenceStats.md @@ -0,0 +1,9 @@ +## Interface `MlTrainedModelInferenceStats` + +| Name | Type | Description | +| - | - | - | +| `cache_miss_count` | [integer](./integer.md) | The number of times the model was loaded for inference and was not retrieved from the cache. If this number is close to the `inference_count`, the cache is not being appropriately used. This can be solved by increasing the cache size or its time-to-live (TTL). Refer to general machine learning settings for the appropriate settings. | +| `failure_count` | [integer](./integer.md) | The number of failures when using the model for inference. | +| `inference_count` | [integer](./integer.md) | The total number of times the model has been called for inference. This is across all inference contexts, including all pipelines. | +| `missing_all_fields_count` | [integer](./integer.md) | The number of inference calls where all the training features for the model were missing. | +| `timestamp` | [EpochTime](./EpochTime.md)<[UnitMillis](./UnitMillis.md)> | The time when the statistics were last updated. | diff --git a/docs/reference/api/MlTrainedModelLocation.md b/docs/reference/api/MlTrainedModelLocation.md new file mode 100644 index 000000000..65554db63 --- /dev/null +++ b/docs/reference/api/MlTrainedModelLocation.md @@ -0,0 +1,5 @@ +## Interface `MlTrainedModelLocation` + +| Name | Type | Description | +| - | - | - | +| `index` | [MlTrainedModelLocationIndex](./MlTrainedModelLocationIndex.md) |   | diff --git a/docs/reference/api/MlTrainedModelLocationIndex.md b/docs/reference/api/MlTrainedModelLocationIndex.md new file mode 100644 index 000000000..37fd91bb4 --- /dev/null +++ b/docs/reference/api/MlTrainedModelLocationIndex.md @@ -0,0 +1,5 @@ +## Interface `MlTrainedModelLocationIndex` + +| Name | Type | Description | +| - | - | - | +| `name` | [IndexName](./IndexName.md) |   | diff --git a/docs/reference/api/MlTrainedModelPrefixStrings.md b/docs/reference/api/MlTrainedModelPrefixStrings.md new file mode 100644 index 000000000..bd7ff76fb --- /dev/null +++ b/docs/reference/api/MlTrainedModelPrefixStrings.md @@ -0,0 +1,6 @@ +## Interface `MlTrainedModelPrefixStrings` + +| Name | Type | Description | +| - | - | - | +| `ingest` | string | String prepended to input at ingest | +| `search` | string | String prepended to input at search | diff --git a/docs/reference/api/MlTrainedModelSizeStats.md b/docs/reference/api/MlTrainedModelSizeStats.md new file mode 100644 index 000000000..316361026 --- /dev/null +++ b/docs/reference/api/MlTrainedModelSizeStats.md @@ -0,0 +1,6 @@ +## Interface `MlTrainedModelSizeStats` + +| Name | Type | Description | +| - | - | - | +| `model_size_bytes` | [ByteSize](./ByteSize.md) | The size of the model in bytes. | +| `required_native_memory_bytes` | [ByteSize](./ByteSize.md) | The amount of memory required to load the model in bytes. | diff --git a/docs/reference/api/MlTrainedModelStats.md b/docs/reference/api/MlTrainedModelStats.md new file mode 100644 index 000000000..00f9f18b8 --- /dev/null +++ b/docs/reference/api/MlTrainedModelStats.md @@ -0,0 +1,10 @@ +## Interface `MlTrainedModelStats` + +| Name | Type | Description | +| - | - | - | +| `deployment_stats` | [MlTrainedModelDeploymentStats](./MlTrainedModelDeploymentStats.md) | A collection of deployment stats, which is present when the models are deployed. | +| `inference_stats` | [MlTrainedModelInferenceStats](./MlTrainedModelInferenceStats.md) | A collection of inference stats fields. | +| `ingest` | Record | A collection of ingest stats for the model across all nodes. The values are summations of the individual node statistics. The format matches the ingest section in the nodes stats API. | +| `model_id` | [Id](./Id.md) | The unique identifier of the trained model. | +| `model_size_stats` | [MlTrainedModelSizeStats](./MlTrainedModelSizeStats.md) | A collection of model size stats. | +| `pipeline_count` | [integer](./integer.md) | The number of ingest pipelines that currently refer to the model. | diff --git a/docs/reference/api/MlTrainedModelType.md b/docs/reference/api/MlTrainedModelType.md new file mode 100644 index 000000000..ab453d832 --- /dev/null +++ b/docs/reference/api/MlTrainedModelType.md @@ -0,0 +1,4 @@ +## `MlTrainedModelType` +::: +type MlTrainedModelType = 'tree_ensemble' | 'lang_ident' | 'pytorch'; +::: diff --git a/docs/reference/api/MlTrainingPriority.md b/docs/reference/api/MlTrainingPriority.md new file mode 100644 index 000000000..1d4c80271 --- /dev/null +++ b/docs/reference/api/MlTrainingPriority.md @@ -0,0 +1,4 @@ +## `MlTrainingPriority` +::: +type MlTrainingPriority = 'normal' | 'low'; +::: diff --git a/docs/reference/api/MlTransformAuthorization.md b/docs/reference/api/MlTransformAuthorization.md new file mode 100644 index 000000000..0eb5bbe02 --- /dev/null +++ b/docs/reference/api/MlTransformAuthorization.md @@ -0,0 +1,7 @@ +## Interface `MlTransformAuthorization` + +| Name | Type | Description | +| - | - | - | +| `api_key` | [MlApiKeyAuthorization](./MlApiKeyAuthorization.md) | If an API key was used for the most recent update to the transform, its name and identifier are listed in the response. | +| `roles` | string[] | If a user ID was used for the most recent update to the transform, its roles at the time of the update are listed in the response. | +| `service_account` | string | If a service account was used for the most recent update to the transform, the account name is listed in the response. | diff --git a/docs/reference/api/MlUpdateDataFrameAnalyticsRequest.md b/docs/reference/api/MlUpdateDataFrameAnalyticsRequest.md new file mode 100644 index 000000000..ed95e6aa1 --- /dev/null +++ b/docs/reference/api/MlUpdateDataFrameAnalyticsRequest.md @@ -0,0 +1,11 @@ +## Interface `MlUpdateDataFrameAnalyticsRequest` + +| Name | Type | Description | +| - | - | - | +| `allow_lazy_start` | boolean | Specifies whether this job can start when there is insufficient machine learning node capacity for it to be immediately assigned to a node. | +| `body` | string | ({ [key: string]: any; } & { id?: never; description?: never; model_memory_limit?: never; max_num_threads?: never; allow_lazy_start?: never; }) | All values in `body` will be added to the request body. | +| `description` | string | A description of the job. | +| `id` | [Id](./Id.md) | Identifier for the data frame analytics job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters. | +| `max_num_threads` | [integer](./integer.md) | The maximum number of threads to be used by the analysis. Using more threads may decrease the time necessary to complete the analysis at the cost of using more CPU. Note that the process may use additional threads for operational functionality other than the analysis itself. | +| `model_memory_limit` | string | The approximate maximum amount of memory resources that are permitted for analytical processing. If your `elasticsearch.yml` file contains an `xpack.ml.max_model_memory_limit` setting, an error occurs when you try to create data frame analytics jobs that have `model_memory_limit` values greater than that setting. | +| `querystring` | { [key: string]: any; } & { id?: never; description?: never; model_memory_limit?: never; max_num_threads?: never; allow_lazy_start?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/MlUpdateDataFrameAnalyticsResponse.md b/docs/reference/api/MlUpdateDataFrameAnalyticsResponse.md new file mode 100644 index 000000000..e869162ce --- /dev/null +++ b/docs/reference/api/MlUpdateDataFrameAnalyticsResponse.md @@ -0,0 +1,16 @@ +## Interface `MlUpdateDataFrameAnalyticsResponse` + +| Name | Type | Description | +| - | - | - | +| `allow_lazy_start` | boolean |   | +| `analysis` | [MlDataframeAnalysisContainer](./MlDataframeAnalysisContainer.md) |   | +| `analyzed_fields` | [MlDataframeAnalysisAnalyzedFields](./MlDataframeAnalysisAnalyzedFields.md) | string[] |   | +| `authorization` | [MlDataframeAnalyticsAuthorization](./MlDataframeAnalyticsAuthorization.md) |   | +| `create_time` | [long](./long.md) |   | +| `description` | string |   | +| `dest` | [MlDataframeAnalyticsDestination](./MlDataframeAnalyticsDestination.md) |   | +| `id` | [Id](./Id.md) |   | +| `max_num_threads` | [integer](./integer.md) |   | +| `model_memory_limit` | string |   | +| `source` | [MlDataframeAnalyticsSource](./MlDataframeAnalyticsSource.md) |   | +| `version` | [VersionString](./VersionString.md) |   | diff --git a/docs/reference/api/MlUpdateDatafeedRequest.md b/docs/reference/api/MlUpdateDatafeedRequest.md new file mode 100644 index 000000000..2942ead4d --- /dev/null +++ b/docs/reference/api/MlUpdateDatafeedRequest.md @@ -0,0 +1,25 @@ +## Interface `MlUpdateDatafeedRequest` + +| Name | Type | Description | +| - | - | - | +| `aggregations` | Record | If set, the datafeed performs aggregation searches. Support for aggregations is limited and should be used only with low cardinality data. | +| `allow_no_indices` | boolean | If `true`, wildcard indices expressions that resolve into no concrete indices are ignored. This includes the `_all` string or when no indices are specified. | +| `body` | string | ({ [key: string]: any; } & { datafeed_id?: never; allow_no_indices?: never; expand_wildcards?: never; ignore_throttled?: never; ignore_unavailable?: never; aggregations?: never; chunking_config?: never; delayed_data_check_config?: never; frequency?: never; indices?: never; indexes?: never; indices_options?: never; job_id?: never; max_empty_searches?: never; query?: never; query_delay?: never; runtime_mappings?: never; script_fields?: never; scroll_size?: never; }) | All values in `body` will be added to the request body. | +| `chunking_config` | [MlChunkingConfig](./MlChunkingConfig.md) | Datafeeds might search over long time periods, for several months or years. This search is split into time chunks in order to ensure the load on Elasticsearch is managed. Chunking configuration controls how the size of these time chunks are calculated; it is an advanced configuration option. | +| `datafeed_id` | [Id](./Id.md) | A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters. | +| `delayed_data_check_config` | [MlDelayedDataCheckConfig](./MlDelayedDataCheckConfig.md) | Specifies whether the datafeed checks for missing data and the size of the window. The datafeed can optionally search over indices that have already been read in an effort to determine whether any data has subsequently been added to the index. If missing data is found, it is a good indication that the `query_delay` is set too low and the data is being indexed after the datafeed has passed that moment in time. This check runs only on real-time datafeeds. | +| `expand_wildcards` | [ExpandWildcards](./ExpandWildcards.md) | Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values. Valid values are: * `all`: Match any data stream or index, including hidden ones. * `closed`: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed. * `hidden`: Match hidden data streams and hidden indices. Must be combined with `open`, `closed`, or both. * `none`: Wildcard patterns are not accepted. * `open`: Match open, non-hidden indices. Also matches any non-hidden data stream. | +| `frequency` | [Duration](./Duration.md) | The interval at which scheduled queries are made while the datafeed runs in real time. The default value is either the bucket span for short bucket spans, or, for longer bucket spans, a sensible fraction of the bucket span. When `frequency` is shorter than the bucket span, interim results for the last (partial) bucket are written then eventually overwritten by the full bucket results. If the datafeed uses aggregations, this value must be divisible by the interval of the date histogram aggregation. | +| `ignore_throttled` | boolean | If `true`, concrete, expanded or aliased indices are ignored when frozen. | +| `ignore_unavailable` | boolean | If `true`, unavailable indices (missing or closed) are ignored. | +| `indexes` | string[] | An array of index names. Wildcards are supported. If any of the indices are in remote clusters, the machine learning nodes must have the `remote_cluster_client` role. indices | +| `indices_options` | [IndicesOptions](./IndicesOptions.md) | Specifies index expansion options that are used during search. | +| `indices` | string[] | An array of index names. Wildcards are supported. If any of the indices are in remote clusters, the machine learning nodes must have the `remote_cluster_client` role. | +| `job_id` | [Id](./Id.md) |   | +| `max_empty_searches` | [integer](./integer.md) | If a real-time datafeed has never seen any data (including during any initial training period), it automatically stops and closes the associated job after this many real-time searches return no documents. In other words, it stops after `frequency` times `max_empty_searches` of real-time operation. If not set, a datafeed with no end time that sees no data remains started until it is explicitly stopped. By default, it is not set. | +| `query_delay` | [Duration](./Duration.md) | The number of seconds behind real time that data is queried. For example, if data from 10:04 a.m. might not be searchable in Elasticsearch until 10:06 a.m., set this property to 120 seconds. The default value is randomly selected between `60s` and `120s`. This randomness improves the query performance when there are multiple jobs running on the same node. | +| `query` | [QueryDslQueryContainer](./QueryDslQueryContainer.md) | The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an Elasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this object is passed verbatim to Elasticsearch. Note that if you change the query, the analyzed data is also changed. Therefore, the time required to learn might be long and the understandability of the results is unpredictable. If you want to make significant changes to the source data, it is recommended that you clone the job and datafeed and make the amendments in the clone. Let both run in parallel and close one when you are satisfied with the results of the job. | +| `querystring` | { [key: string]: any; } & { datafeed_id?: never; allow_no_indices?: never; expand_wildcards?: never; ignore_throttled?: never; ignore_unavailable?: never; aggregations?: never; chunking_config?: never; delayed_data_check_config?: never; frequency?: never; indices?: never; indexes?: never; indices_options?: never; job_id?: never; max_empty_searches?: never; query?: never; query_delay?: never; runtime_mappings?: never; script_fields?: never; scroll_size?: never; } | All values in `querystring` will be added to the request querystring. | +| `runtime_mappings` | [MappingRuntimeFields](./MappingRuntimeFields.md) | Specifies runtime fields for the datafeed search. | +| `script_fields` | Record | Specifies scripts that evaluate custom expressions and returns script fields to the datafeed. The detector configuration objects in a job can contain functions that use these script fields. | +| `scroll_size` | [integer](./integer.md) | The size parameter that is used in Elasticsearch searches when the datafeed does not use aggregations. The maximum value is the value of `index.max_result_window`. | diff --git a/docs/reference/api/MlUpdateDatafeedResponse.md b/docs/reference/api/MlUpdateDatafeedResponse.md new file mode 100644 index 000000000..c6c6aa164 --- /dev/null +++ b/docs/reference/api/MlUpdateDatafeedResponse.md @@ -0,0 +1,19 @@ +## Interface `MlUpdateDatafeedResponse` + +| Name | Type | Description | +| - | - | - | +| `aggregations` | Record |   | +| `authorization` | [MlDatafeedAuthorization](./MlDatafeedAuthorization.md) |   | +| `chunking_config` | [MlChunkingConfig](./MlChunkingConfig.md) |   | +| `datafeed_id` | [Id](./Id.md) |   | +| `delayed_data_check_config` | [MlDelayedDataCheckConfig](./MlDelayedDataCheckConfig.md) |   | +| `frequency` | [Duration](./Duration.md) |   | +| `indices_options` | [IndicesOptions](./IndicesOptions.md) |   | +| `indices` | string[] |   | +| `job_id` | [Id](./Id.md) |   | +| `max_empty_searches` | [integer](./integer.md) |   | +| `query_delay` | [Duration](./Duration.md) |   | +| `query` | [QueryDslQueryContainer](./QueryDslQueryContainer.md) |   | +| `runtime_mappings` | [MappingRuntimeFields](./MappingRuntimeFields.md) |   | +| `script_fields` | Record |   | +| `scroll_size` | [integer](./integer.md) |   | diff --git a/docs/reference/api/MlUpdateFilterRequest.md b/docs/reference/api/MlUpdateFilterRequest.md new file mode 100644 index 000000000..96f221fc2 --- /dev/null +++ b/docs/reference/api/MlUpdateFilterRequest.md @@ -0,0 +1,10 @@ +## Interface `MlUpdateFilterRequest` + +| Name | Type | Description | +| - | - | - | +| `add_items` | string[] | The items to add to the filter. | +| `body` | string | ({ [key: string]: any; } & { filter_id?: never; add_items?: never; description?: never; remove_items?: never; }) | All values in `body` will be added to the request body. | +| `description` | string | A description for the filter. | +| `filter_id` | [Id](./Id.md) | A string that uniquely identifies a filter. | +| `querystring` | { [key: string]: any; } & { filter_id?: never; add_items?: never; description?: never; remove_items?: never; } | All values in `querystring` will be added to the request querystring. | +| `remove_items` | string[] | The items to remove from the filter. | diff --git a/docs/reference/api/MlUpdateFilterResponse.md b/docs/reference/api/MlUpdateFilterResponse.md new file mode 100644 index 000000000..4b739d23d --- /dev/null +++ b/docs/reference/api/MlUpdateFilterResponse.md @@ -0,0 +1,7 @@ +## Interface `MlUpdateFilterResponse` + +| Name | Type | Description | +| - | - | - | +| `description` | string |   | +| `filter_id` | [Id](./Id.md) |   | +| `items` | string[] |   | diff --git a/docs/reference/api/MlUpdateJobRequest.md b/docs/reference/api/MlUpdateJobRequest.md new file mode 100644 index 000000000..9a31c220e --- /dev/null +++ b/docs/reference/api/MlUpdateJobRequest.md @@ -0,0 +1,22 @@ +## Interface `MlUpdateJobRequest` + +| Name | Type | Description | +| - | - | - | +| `allow_lazy_open` | boolean | Advanced configuration option. Specifies whether this job can open when there is insufficient machine learning node capacity for it to be immediately assigned to a node. If `false` and a machine learning node with capacity to run the job cannot immediately be found, the open anomaly detection jobs API returns an error. However, this is also subject to the cluster-wide `xpack.ml.max_lazy_ml_nodes` setting. If this option is set to `true`, the open anomaly detection jobs API does not return an error and the job waits in the opening state until sufficient machine learning node capacity is available. | +| `analysis_limits` | [MlAnalysisMemoryLimit](./MlAnalysisMemoryLimit.md) |   | +| `background_persist_interval` | [Duration](./Duration.md) | Advanced configuration option. The time between each periodic persistence of the model. The default value is a randomized value between 3 to 4 hours, which avoids all jobs persisting at exactly the same time. The smallest allowed value is 1 hour. For very large models (several GB), persistence could take 10-20 minutes, so do not set the value too low. If the job is open when you make the update, you must stop the datafeed, close the job, then reopen the job and restart the datafeed for the changes to take effect. | +| `body` | string | ({ [key: string]: any; } & { job_id?: never; allow_lazy_open?: never; analysis_limits?: never; background_persist_interval?: never; custom_settings?: never; categorization_filters?: never; description?: never; model_plot_config?: never; model_prune_window?: never; daily_model_snapshot_retention_after_days?: never; model_snapshot_retention_days?: never; renormalization_window_days?: never; results_retention_days?: never; groups?: never; detectors?: never; per_partition_categorization?: never; }) | All values in `body` will be added to the request body. | +| `categorization_filters` | string[] |   | +| `custom_settings` | Record | Advanced configuration option. Contains custom meta data about the job. For example, it can contain custom URL information as shown in Adding custom URLs to machine learning results. | +| `daily_model_snapshot_retention_after_days` | [long](./long.md) | Advanced configuration option, which affects the automatic removal of old model snapshots for this job. It specifies a period of time (in days) after which only the first snapshot per day is retained. This period is relative to the timestamp of the most recent snapshot for this job. Valid values range from 0 to `model_snapshot_retention_days`. For jobs created before version 7.8.0, the default value matches `model_snapshot_retention_days`. | +| `description` | string | A description of the job. | +| `detectors` | [MlDetectorUpdate](./MlDetectorUpdate.md)[] | An array of detector update objects. | +| `groups` | string[] | A list of job groups. A job can belong to no groups or many. | +| `job_id` | [Id](./Id.md) | Identifier for the job. | +| `model_plot_config` | [MlModelPlotConfig](./MlModelPlotConfig.md) |   | +| `model_prune_window` | [Duration](./Duration.md) |   | +| `model_snapshot_retention_days` | [long](./long.md) | Advanced configuration option, which affects the automatic removal of old model snapshots for this job. It specifies the maximum period of time (in days) that snapshots are retained. This period is relative to the timestamp of the most recent snapshot for this job. | +| `per_partition_categorization` | [MlPerPartitionCategorization](./MlPerPartitionCategorization.md) | Settings related to how categorization interacts with partition fields. | +| `querystring` | { [key: string]: any; } & { job_id?: never; allow_lazy_open?: never; analysis_limits?: never; background_persist_interval?: never; custom_settings?: never; categorization_filters?: never; description?: never; model_plot_config?: never; model_prune_window?: never; daily_model_snapshot_retention_after_days?: never; model_snapshot_retention_days?: never; renormalization_window_days?: never; results_retention_days?: never; groups?: never; detectors?: never; per_partition_categorization?: never; } | All values in `querystring` will be added to the request querystring. | +| `renormalization_window_days` | [long](./long.md) | Advanced configuration option. The period over which adjustments to the score are applied, as new data is seen. | +| `results_retention_days` | [long](./long.md) | Advanced configuration option. The period of time (in days) that results are retained. Age is calculated relative to the timestamp of the latest bucket result. If this property has a non-null value, once per day at 00:30 (server time), results that are the specified number of days older than the latest bucket result are deleted from Elasticsearch. The default value is null, which means all results are retained. | diff --git a/docs/reference/api/MlUpdateJobResponse.md b/docs/reference/api/MlUpdateJobResponse.md new file mode 100644 index 000000000..43d14f37a --- /dev/null +++ b/docs/reference/api/MlUpdateJobResponse.md @@ -0,0 +1,25 @@ +## Interface `MlUpdateJobResponse` + +| Name | Type | Description | +| - | - | - | +| `allow_lazy_open` | boolean |   | +| `analysis_config` | [MlAnalysisConfigRead](./MlAnalysisConfigRead.md) |   | +| `analysis_limits` | [MlAnalysisLimits](./MlAnalysisLimits.md) |   | +| `background_persist_interval` | [Duration](./Duration.md) |   | +| `create_time` | [EpochTime](./EpochTime.md)<[UnitMillis](./UnitMillis.md)> |   | +| `custom_settings` | Record |   | +| `daily_model_snapshot_retention_after_days` | [long](./long.md) |   | +| `data_description` | [MlDataDescription](./MlDataDescription.md) |   | +| `datafeed_config` | [MlDatafeed](./MlDatafeed.md) |   | +| `description` | string |   | +| `finished_time` | [EpochTime](./EpochTime.md)<[UnitMillis](./UnitMillis.md)> |   | +| `groups` | string[] |   | +| `job_id` | [Id](./Id.md) |   | +| `job_type` | string |   | +| `job_version` | [VersionString](./VersionString.md) |   | +| `model_plot_config` | [MlModelPlotConfig](./MlModelPlotConfig.md) |   | +| `model_snapshot_id` | [Id](./Id.md) |   | +| `model_snapshot_retention_days` | [long](./long.md) |   | +| `renormalization_window_days` | [long](./long.md) |   | +| `results_index_name` | [IndexName](./IndexName.md) |   | +| `results_retention_days` | [long](./long.md) |   | diff --git a/docs/reference/api/MlUpdateModelSnapshotRequest.md b/docs/reference/api/MlUpdateModelSnapshotRequest.md new file mode 100644 index 000000000..8d2dad744 --- /dev/null +++ b/docs/reference/api/MlUpdateModelSnapshotRequest.md @@ -0,0 +1,10 @@ +## Interface `MlUpdateModelSnapshotRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { job_id?: never; snapshot_id?: never; description?: never; retain?: never; }) | All values in `body` will be added to the request body. | +| `description` | string | A description of the model snapshot. | +| `job_id` | [Id](./Id.md) | Identifier for the anomaly detection job. | +| `querystring` | { [key: string]: any; } & { job_id?: never; snapshot_id?: never; description?: never; retain?: never; } | All values in `querystring` will be added to the request querystring. | +| `retain` | boolean | If `true`, this snapshot will not be deleted during automatic cleanup of snapshots older than `model_snapshot_retention_days`. However, this snapshot will be deleted when the job is deleted. | +| `snapshot_id` | [Id](./Id.md) | Identifier for the model snapshot. | diff --git a/docs/reference/api/MlUpdateModelSnapshotResponse.md b/docs/reference/api/MlUpdateModelSnapshotResponse.md new file mode 100644 index 000000000..84054b8d0 --- /dev/null +++ b/docs/reference/api/MlUpdateModelSnapshotResponse.md @@ -0,0 +1,6 @@ +## Interface `MlUpdateModelSnapshotResponse` + +| Name | Type | Description | +| - | - | - | +| `acknowledged` | boolean |   | +| `model` | [MlModelSnapshot](./MlModelSnapshot.md) |   | diff --git a/docs/reference/api/MlUpdateTrainedModelDeploymentRequest.md b/docs/reference/api/MlUpdateTrainedModelDeploymentRequest.md new file mode 100644 index 000000000..cf9e609e5 --- /dev/null +++ b/docs/reference/api/MlUpdateTrainedModelDeploymentRequest.md @@ -0,0 +1,9 @@ +## Interface `MlUpdateTrainedModelDeploymentRequest` + +| Name | Type | Description | +| - | - | - | +| `adaptive_allocations` | [MlAdaptiveAllocationsSettings](./MlAdaptiveAllocationsSettings.md) | Adaptive allocations configuration. When enabled, the number of allocations is set based on the current load. If adaptive_allocations is enabled, do not set the number of allocations manually. | +| `body` | string | ({ [key: string]: any; } & { model_id?: never; number_of_allocations?: never; adaptive_allocations?: never; }) | All values in `body` will be added to the request body. | +| `model_id` | [Id](./Id.md) | The unique identifier of the trained model. Currently, only PyTorch models are supported. | +| `number_of_allocations` | [integer](./integer.md) | The number of model allocations on each node where the model is deployed. All allocations on a node share the same copy of the model in memory but use a separate set of threads to evaluate the model. Increasing this value generally increases the throughput. If this setting is greater than the number of hardware threads it will automatically be changed to a value less than the number of hardware threads. If adaptive_allocations is enabled, do not set this value, because it’s automatically set. | +| `querystring` | { [key: string]: any; } & { model_id?: never; number_of_allocations?: never; adaptive_allocations?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/MlUpdateTrainedModelDeploymentResponse.md b/docs/reference/api/MlUpdateTrainedModelDeploymentResponse.md new file mode 100644 index 000000000..55b7846b9 --- /dev/null +++ b/docs/reference/api/MlUpdateTrainedModelDeploymentResponse.md @@ -0,0 +1,5 @@ +## Interface `MlUpdateTrainedModelDeploymentResponse` + +| Name | Type | Description | +| - | - | - | +| `assignment` | [MlTrainedModelAssignment](./MlTrainedModelAssignment.md) |   | diff --git a/docs/reference/api/MlUpgradeJobSnapshotRequest.md b/docs/reference/api/MlUpgradeJobSnapshotRequest.md new file mode 100644 index 000000000..1691dcb20 --- /dev/null +++ b/docs/reference/api/MlUpgradeJobSnapshotRequest.md @@ -0,0 +1,10 @@ +## Interface `MlUpgradeJobSnapshotRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { job_id?: never; snapshot_id?: never; wait_for_completion?: never; timeout?: never; }) | All values in `body` will be added to the request body. | +| `job_id` | [Id](./Id.md) | Identifier for the anomaly detection job. | +| `querystring` | { [key: string]: any; } & { job_id?: never; snapshot_id?: never; wait_for_completion?: never; timeout?: never; } | All values in `querystring` will be added to the request querystring. | +| `snapshot_id` | [Id](./Id.md) | A numerical character string that uniquely identifies the model snapshot. | +| `timeout` | [Duration](./Duration.md) | Controls the time to wait for the request to complete. | +| `wait_for_completion` | boolean | When true, the API won’t respond until the upgrade is complete. Otherwise, it responds as soon as the upgrade task is assigned to a node. | diff --git a/docs/reference/api/MlUpgradeJobSnapshotResponse.md b/docs/reference/api/MlUpgradeJobSnapshotResponse.md new file mode 100644 index 000000000..d217cb44e --- /dev/null +++ b/docs/reference/api/MlUpgradeJobSnapshotResponse.md @@ -0,0 +1,6 @@ +## Interface `MlUpgradeJobSnapshotResponse` + +| Name | Type | Description | +| - | - | - | +| `completed` | boolean | When true, this means the task is complete. When false, it is still running. | +| `node` | [NodeId](./NodeId.md) | The ID of the node that the upgrade task was started on if it is still running. In serverless this will be the "serverless". | diff --git a/docs/reference/api/MlValidateDetectorRequest.md b/docs/reference/api/MlValidateDetectorRequest.md new file mode 100644 index 000000000..8f72d216d --- /dev/null +++ b/docs/reference/api/MlValidateDetectorRequest.md @@ -0,0 +1,7 @@ +## Interface `MlValidateDetectorRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { detector?: never; }) | All values in `body` will be added to the request body. | +| `detector` | [MlDetector](./MlDetector.md) |   | +| `querystring` | { [key: string]: any; } & { detector?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/MlValidateDetectorResponse.md b/docs/reference/api/MlValidateDetectorResponse.md new file mode 100644 index 000000000..76ea14cfd --- /dev/null +++ b/docs/reference/api/MlValidateDetectorResponse.md @@ -0,0 +1,4 @@ +## `MlValidateDetectorResponse` +::: +type MlValidateDetectorResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); +::: diff --git a/docs/reference/api/MlValidateRequest.md b/docs/reference/api/MlValidateRequest.md new file mode 100644 index 000000000..812619d6d --- /dev/null +++ b/docs/reference/api/MlValidateRequest.md @@ -0,0 +1,15 @@ +## Interface `MlValidateRequest` + +| Name | Type | Description | +| - | - | - | +| `analysis_config` | [MlAnalysisConfig](./MlAnalysisConfig.md) |   | +| `analysis_limits` | [MlAnalysisLimits](./MlAnalysisLimits.md) |   | +| `body` | string | ({ [key: string]: any; } & { job_id?: never; analysis_config?: never; analysis_limits?: never; data_description?: never; description?: never; model_plot?: never; model_snapshot_id?: never; model_snapshot_retention_days?: never; results_index_name?: never; }) | All values in `body` will be added to the request body. | +| `data_description` | [MlDataDescription](./MlDataDescription.md) |   | +| `description` | string |   | +| `job_id` | [Id](./Id.md) |   | +| `model_plot` | [MlModelPlotConfig](./MlModelPlotConfig.md) |   | +| `model_snapshot_id` | [Id](./Id.md) |   | +| `model_snapshot_retention_days` | [long](./long.md) |   | +| `querystring` | { [key: string]: any; } & { job_id?: never; analysis_config?: never; analysis_limits?: never; data_description?: never; description?: never; model_plot?: never; model_snapshot_id?: never; model_snapshot_retention_days?: never; results_index_name?: never; } | All values in `querystring` will be added to the request querystring. | +| `results_index_name` | [IndexName](./IndexName.md) |   | diff --git a/docs/reference/api/MlValidateResponse.md b/docs/reference/api/MlValidateResponse.md new file mode 100644 index 000000000..0f7a19c1f --- /dev/null +++ b/docs/reference/api/MlValidateResponse.md @@ -0,0 +1,4 @@ +## `MlValidateResponse` +::: +type MlValidateResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); +::: diff --git a/docs/reference/api/MlValidationLoss.md b/docs/reference/api/MlValidationLoss.md new file mode 100644 index 000000000..c02362dd9 --- /dev/null +++ b/docs/reference/api/MlValidationLoss.md @@ -0,0 +1,6 @@ +## Interface `MlValidationLoss` + +| Name | Type | Description | +| - | - | - | +| `fold_values` | string[] | Validation loss values for every added decision tree during the forest growing procedure. | +| `loss_type` | string | The type of the loss metric. For example, binomial_logistic. | diff --git a/docs/reference/api/MlVocabulary.md b/docs/reference/api/MlVocabulary.md new file mode 100644 index 000000000..479a92ca0 --- /dev/null +++ b/docs/reference/api/MlVocabulary.md @@ -0,0 +1,5 @@ +## Interface `MlVocabulary` + +| Name | Type | Description | +| - | - | - | +| `index` | [IndexName](./IndexName.md) |   | diff --git a/docs/reference/api/MlXlmRobertaTokenizationConfig.md b/docs/reference/api/MlXlmRobertaTokenizationConfig.md new file mode 100644 index 000000000..f06e6e711 --- /dev/null +++ b/docs/reference/api/MlXlmRobertaTokenizationConfig.md @@ -0,0 +1,4 @@ +## Interface `MlXlmRobertaTokenizationConfig` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/MlZeroShotClassificationInferenceOptions.md b/docs/reference/api/MlZeroShotClassificationInferenceOptions.md new file mode 100644 index 000000000..da2fe8162 --- /dev/null +++ b/docs/reference/api/MlZeroShotClassificationInferenceOptions.md @@ -0,0 +1,10 @@ +## Interface `MlZeroShotClassificationInferenceOptions` + +| Name | Type | Description | +| - | - | - | +| `classification_labels` | string[] | The zero shot classification labels indicating entailment, neutral, and contradiction Must contain exactly and only entailment, neutral, and contradiction | +| `hypothesis_template` | string | Hypothesis template used when tokenizing labels for prediction | +| `labels` | string[] | The labels to predict. | +| `multi_label` | boolean | Indicates if more than one true label exists. | +| `results_field` | string | The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. | +| `tokenization` | [MlTokenizationConfigContainer](./MlTokenizationConfigContainer.md) | The tokenization options to update when inferring | diff --git a/docs/reference/api/MlZeroShotClassificationInferenceUpdateOptions.md b/docs/reference/api/MlZeroShotClassificationInferenceUpdateOptions.md new file mode 100644 index 000000000..b3eb97404 --- /dev/null +++ b/docs/reference/api/MlZeroShotClassificationInferenceUpdateOptions.md @@ -0,0 +1,8 @@ +## Interface `MlZeroShotClassificationInferenceUpdateOptions` + +| Name | Type | Description | +| - | - | - | +| `labels` | string[] | The labels to predict. | +| `multi_label` | boolean | Update the configured multi label option. Indicates if more than one true label exists. Defaults to the configured value. | +| `results_field` | string | The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. | +| `tokenization` | [MlNlpTokenizationUpdateOptions](./MlNlpTokenizationUpdateOptions.md) | The tokenization options to update when inferring | diff --git a/docs/reference/api/Monitoring.md b/docs/reference/api/Monitoring.md new file mode 100644 index 000000000..d277b3c2a --- /dev/null +++ b/docs/reference/api/Monitoring.md @@ -0,0 +1,20 @@ +## `Monitoring` + +### Constructor + +::: +new Monitoring(transport: [Transport](./Transport.md)); +::: + +### Properties + +| Name | Type | Description | +| - | - | - | +| `acceptedParams` | Record |   | +| `transport` | [Transport](./Transport.md) |   | + +### Methods + +| Name | Signature | Description | +| - | - | - | +| `bulk` | `bulk(this: [That](./That.md), params: [MonitoringBulkRequest](./MonitoringBulkRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MonitoringBulkResponse](./MonitoringBulkResponse.md)>;` | Send monitoring data. This API is used by the monitoring features to send monitoring data. || `bulk` | `bulk(this: [That](./That.md), params: [MonitoringBulkRequest](./MonitoringBulkRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MonitoringBulkResponse](./MonitoringBulkResponse.md), unknown>>;` |   || `bulk` | `bulk(this: [That](./That.md), params: [MonitoringBulkRequest](./MonitoringBulkRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MonitoringBulkResponse](./MonitoringBulkResponse.md)>;` |   | \ No newline at end of file diff --git a/docs/reference/api/MonitoringBulkRequest.md b/docs/reference/api/MonitoringBulkRequest.md new file mode 100644 index 000000000..b8c718100 --- /dev/null +++ b/docs/reference/api/MonitoringBulkRequest.md @@ -0,0 +1,11 @@ +## Interface `MonitoringBulkRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { type?: never; system_id?: never; system_api_version?: never; interval?: never; operations?: never; }) | All values in `body` will be added to the request body. | +| `interval` | [Duration](./Duration.md) | Collection interval (e.g., '10s' or '10000ms') of the payload | +| `operations` | ([BulkOperationContainer](./BulkOperationContainer.md) | [BulkUpdateAction](./BulkUpdateAction.md) | TDocument)[] |   | +| `querystring` | { [key: string]: any; } & { type?: never; system_id?: never; system_api_version?: never; interval?: never; operations?: never; } | All values in `querystring` will be added to the request querystring. | +| `system_api_version` | string |   | +| `system_id` | string | Identifier of the monitored system | +| `type` | string | Default document type for items which don't provide one | diff --git a/docs/reference/api/MonitoringBulkResponse.md b/docs/reference/api/MonitoringBulkResponse.md new file mode 100644 index 000000000..6f9a027bd --- /dev/null +++ b/docs/reference/api/MonitoringBulkResponse.md @@ -0,0 +1,8 @@ +## Interface `MonitoringBulkResponse` + +| Name | Type | Description | +| - | - | - | +| `error` | [ErrorCause](./ErrorCause.md) |   | +| `errors` | boolean | True if there is was an error | +| `ignored` | boolean | Was collection disabled? | +| `took` | [long](./long.md) |   | diff --git a/docs/reference/api/MsearchApi_1.md b/docs/reference/api/MsearchApi_1.md new file mode 100644 index 000000000..84fdab035 --- /dev/null +++ b/docs/reference/api/MsearchApi_1.md @@ -0,0 +1,3 @@ +::: +default function MsearchApi>(this: [That](./That.md), params: [MsearchRequest](./MsearchRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MsearchResponse](./MsearchResponse.md)>; +::: diff --git a/docs/reference/api/MsearchApi_2.md b/docs/reference/api/MsearchApi_2.md new file mode 100644 index 000000000..b5042c23e --- /dev/null +++ b/docs/reference/api/MsearchApi_2.md @@ -0,0 +1,3 @@ +::: +default function MsearchApi>(this: [That](./That.md), params: [MsearchRequest](./MsearchRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MsearchResponse](./MsearchResponse.md), unknown>>; +::: diff --git a/docs/reference/api/MsearchApi_3.md b/docs/reference/api/MsearchApi_3.md new file mode 100644 index 000000000..688077abd --- /dev/null +++ b/docs/reference/api/MsearchApi_3.md @@ -0,0 +1,3 @@ +::: +default function MsearchApi>(this: [That](./That.md), params: [MsearchRequest](./MsearchRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MsearchResponse](./MsearchResponse.md)>; +::: diff --git a/docs/reference/api/MsearchHelper.md b/docs/reference/api/MsearchHelper.md new file mode 100644 index 000000000..0ec7fcfec --- /dev/null +++ b/docs/reference/api/MsearchHelper.md @@ -0,0 +1,6 @@ +## Interface `MsearchHelper` + +| Name | Type | Description | +| - | - | - | +| `search` | (header: [MsearchMultisearchHeader](./MsearchMultisearchHeader.md), body: [SearchSearchRequestBody](./SearchSearchRequestBody.md)) => Promise<[MsearchHelperResponse](./MsearchHelperResponse.md)> |   | +| `stop` | (error?: [Error](./Error.md) | null) => void |   | diff --git a/docs/reference/api/MsearchHelperOptions.md b/docs/reference/api/MsearchHelperOptions.md new file mode 100644 index 000000000..8ecaaadb0 --- /dev/null +++ b/docs/reference/api/MsearchHelperOptions.md @@ -0,0 +1,9 @@ +## Interface `MsearchHelperOptions` + +| Name | Type | Description | +| - | - | - | +| `concurrency` | number |   | +| `flushInterval` | number |   | +| `operations` | number |   | +| `retries` | number |   | +| `wait` | number |   | diff --git a/docs/reference/api/MsearchHelperResponse.md b/docs/reference/api/MsearchHelperResponse.md new file mode 100644 index 000000000..2c5263fa3 --- /dev/null +++ b/docs/reference/api/MsearchHelperResponse.md @@ -0,0 +1,8 @@ +## Interface `MsearchHelperResponse` + +| Name | Type | Description | +| - | - | - | +| `body` | [SearchResponse](./SearchResponse.md) |   | +| `documents` | TDocument[] |   | +| `responses` | [MsearchResponse](./MsearchResponse.md) |   | +| `status` | number |   | diff --git a/docs/reference/api/MsearchMultiSearchItem.md b/docs/reference/api/MsearchMultiSearchItem.md new file mode 100644 index 000000000..3f0fe5d2e --- /dev/null +++ b/docs/reference/api/MsearchMultiSearchItem.md @@ -0,0 +1,5 @@ +## Interface `MsearchMultiSearchItem` + +| Name | Type | Description | +| - | - | - | +| `status` | [integer](./integer.md) |   | diff --git a/docs/reference/api/MsearchMultiSearchResult.md b/docs/reference/api/MsearchMultiSearchResult.md new file mode 100644 index 000000000..f7d42fbcf --- /dev/null +++ b/docs/reference/api/MsearchMultiSearchResult.md @@ -0,0 +1,6 @@ +## Interface `MsearchMultiSearchResult` + +| Name | Type | Description | +| - | - | - | +| `responses` | [MsearchResponseItem](./MsearchResponseItem.md)[] |   | +| `took` | [long](./long.md) |   | diff --git a/docs/reference/api/MsearchMultisearchHeader.md b/docs/reference/api/MsearchMultisearchHeader.md new file mode 100644 index 000000000..18891a544 --- /dev/null +++ b/docs/reference/api/MsearchMultisearchHeader.md @@ -0,0 +1,15 @@ +## Interface `MsearchMultisearchHeader` + +| Name | Type | Description | +| - | - | - | +| `allow_no_indices` | boolean |   | +| `allow_partial_search_results` | boolean |   | +| `ccs_minimize_roundtrips` | boolean |   | +| `expand_wildcards` | [ExpandWildcards](./ExpandWildcards.md) |   | +| `ignore_throttled` | boolean |   | +| `ignore_unavailable` | boolean |   | +| `index` | [Indices](./Indices.md) |   | +| `preference` | string |   | +| `request_cache` | boolean |   | +| `routing` | [Routing](./Routing.md) |   | +| `search_type` | [SearchType](./SearchType.md) |   | diff --git a/docs/reference/api/MsearchRequest.md b/docs/reference/api/MsearchRequest.md new file mode 100644 index 000000000..6913c29ff --- /dev/null +++ b/docs/reference/api/MsearchRequest.md @@ -0,0 +1,21 @@ +## Interface `MsearchRequest` + +| Name | Type | Description | +| - | - | - | +| `allow_no_indices` | boolean | If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar. | +| `body` | string | ({ [key: string]: any; } & { index?: never; allow_no_indices?: never; ccs_minimize_roundtrips?: never; expand_wildcards?: never; ignore_throttled?: never; ignore_unavailable?: never; include_named_queries_score?: never; max_concurrent_searches?: never; max_concurrent_shard_requests?: never; pre_filter_shard_size?: never; rest_total_hits_as_int?: never; routing?: never; search_type?: never; typed_keys?: never; searches?: never; }) | All values in `body` will be added to the request body. | +| `ccs_minimize_roundtrips` | boolean | If true, network roundtrips between the coordinating node and remote clusters are minimized for cross-cluster search requests. | +| `expand_wildcards` | [ExpandWildcards](./ExpandWildcards.md) | Type of index that wildcard expressions can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. | +| `ignore_throttled` | boolean | If true, concrete, expanded or aliased indices are ignored when frozen. | +| `ignore_unavailable` | boolean | If true, missing or closed indices are not included in the response. | +| `include_named_queries_score` | boolean | Indicates whether hit.matched_queries should be rendered as a map that includes the name of the matched query associated with its score (true) or as an array containing the name of the matched queries (false) This functionality reruns each named query on every hit in a search response. Typically, this adds a small overhead to a request. However, using computationally expensive named queries on a large number of hits may add significant overhead. | +| `index` | [Indices](./Indices.md) | Comma-separated list of data streams, indices, and index aliases to search. | +| `max_concurrent_searches` | [integer](./integer.md) | Maximum number of concurrent searches the multi search API can execute. Defaults to `max(1, (# of data nodes * min(search thread pool size, 10)))`. | +| `max_concurrent_shard_requests` | [integer](./integer.md) | Maximum number of concurrent shard requests that each sub-search request executes per node. | +| `pre_filter_shard_size` | [long](./long.md) | Defines a threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method i.e., if date filters are mandatory to match but the shard bounds and the query are disjoint. | +| `querystring` | { [key: string]: any; } & { index?: never; allow_no_indices?: never; ccs_minimize_roundtrips?: never; expand_wildcards?: never; ignore_throttled?: never; ignore_unavailable?: never; include_named_queries_score?: never; max_concurrent_searches?: never; max_concurrent_shard_requests?: never; pre_filter_shard_size?: never; rest_total_hits_as_int?: never; routing?: never; search_type?: never; typed_keys?: never; searches?: never; } | All values in `querystring` will be added to the request querystring. | +| `rest_total_hits_as_int` | boolean | If true, hits.total are returned as an integer in the response. Defaults to false, which returns an object. | +| `routing` | [Routing](./Routing.md) | Custom routing value used to route search operations to a specific shard. | +| `search_type` | [SearchType](./SearchType.md) | Indicates whether global term and document frequencies should be used when scoring returned documents. | +| `searches` | [MsearchRequestItem](./MsearchRequestItem.md)[] |   | +| `typed_keys` | boolean | Specifies whether aggregation and suggester names should be prefixed by their respective types in the response. | diff --git a/docs/reference/api/MsearchRequestItem.md b/docs/reference/api/MsearchRequestItem.md new file mode 100644 index 000000000..6109a71c0 --- /dev/null +++ b/docs/reference/api/MsearchRequestItem.md @@ -0,0 +1,4 @@ +## `MsearchRequestItem` +::: +type MsearchRequestItem = [MsearchMultisearchHeader](./MsearchMultisearchHeader.md) | [SearchSearchRequestBody](./SearchSearchRequestBody.md); +::: diff --git a/docs/reference/api/MsearchResponse.md b/docs/reference/api/MsearchResponse.md new file mode 100644 index 000000000..7cf96c530 --- /dev/null +++ b/docs/reference/api/MsearchResponse.md @@ -0,0 +1,4 @@ +## `MsearchResponse` +::: +type MsearchResponse> = [MsearchMultiSearchResult](./MsearchMultiSearchResult.md); +::: diff --git a/docs/reference/api/MsearchResponseItem.md b/docs/reference/api/MsearchResponseItem.md new file mode 100644 index 000000000..b758a53bc --- /dev/null +++ b/docs/reference/api/MsearchResponseItem.md @@ -0,0 +1,4 @@ +## `MsearchResponseItem` +::: +type MsearchResponseItem = [MsearchMultiSearchItem](./MsearchMultiSearchItem.md) | [ErrorResponseBase](./ErrorResponseBase.md); +::: diff --git a/docs/reference/api/MsearchTemplateApi_1.md b/docs/reference/api/MsearchTemplateApi_1.md new file mode 100644 index 000000000..485cbe4a9 --- /dev/null +++ b/docs/reference/api/MsearchTemplateApi_1.md @@ -0,0 +1,3 @@ +::: +default function MsearchTemplateApi>(this: [That](./That.md), params: [MsearchTemplateRequest](./MsearchTemplateRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MsearchTemplateResponse](./MsearchTemplateResponse.md)>; +::: diff --git a/docs/reference/api/MsearchTemplateApi_2.md b/docs/reference/api/MsearchTemplateApi_2.md new file mode 100644 index 000000000..0299f947b --- /dev/null +++ b/docs/reference/api/MsearchTemplateApi_2.md @@ -0,0 +1,3 @@ +::: +default function MsearchTemplateApi>(this: [That](./That.md), params: [MsearchTemplateRequest](./MsearchTemplateRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MsearchTemplateResponse](./MsearchTemplateResponse.md), unknown>>; +::: diff --git a/docs/reference/api/MsearchTemplateApi_3.md b/docs/reference/api/MsearchTemplateApi_3.md new file mode 100644 index 000000000..d2f127a6e --- /dev/null +++ b/docs/reference/api/MsearchTemplateApi_3.md @@ -0,0 +1,3 @@ +::: +default function MsearchTemplateApi>(this: [That](./That.md), params: [MsearchTemplateRequest](./MsearchTemplateRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MsearchTemplateResponse](./MsearchTemplateResponse.md)>; +::: diff --git a/docs/reference/api/MsearchTemplateRequest.md b/docs/reference/api/MsearchTemplateRequest.md new file mode 100644 index 000000000..bd3c257e7 --- /dev/null +++ b/docs/reference/api/MsearchTemplateRequest.md @@ -0,0 +1,13 @@ +## Interface `MsearchTemplateRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { index?: never; ccs_minimize_roundtrips?: never; max_concurrent_searches?: never; search_type?: never; rest_total_hits_as_int?: never; typed_keys?: never; search_templates?: never; }) | All values in `body` will be added to the request body. | +| `ccs_minimize_roundtrips` | boolean | If `true`, network round-trips are minimized for cross-cluster search requests. | +| `index` | [Indices](./Indices.md) | A comma-separated list of data streams, indices, and aliases to search. It supports wildcards ( `*`). To search all data streams and indices, omit this parameter or use `*`. | +| `max_concurrent_searches` | [long](./long.md) | The maximum number of concurrent searches the API can run. | +| `querystring` | { [key: string]: any; } & { index?: never; ccs_minimize_roundtrips?: never; max_concurrent_searches?: never; search_type?: never; rest_total_hits_as_int?: never; typed_keys?: never; search_templates?: never; } | All values in `querystring` will be added to the request querystring. | +| `rest_total_hits_as_int` | boolean | If `true`, the response returns `hits.total` as an integer. If `false`, it returns `hits.total` as an object. | +| `search_templates` | [MsearchTemplateRequestItem](./MsearchTemplateRequestItem.md)[] |   | +| `search_type` | [SearchType](./SearchType.md) | The type of the search operation. | +| `typed_keys` | boolean | If `true`, the response prefixes aggregation and suggester names with their respective types. | diff --git a/docs/reference/api/MsearchTemplateRequestItem.md b/docs/reference/api/MsearchTemplateRequestItem.md new file mode 100644 index 000000000..38843dbea --- /dev/null +++ b/docs/reference/api/MsearchTemplateRequestItem.md @@ -0,0 +1,4 @@ +## `MsearchTemplateRequestItem` +::: +type MsearchTemplateRequestItem = [MsearchMultisearchHeader](./MsearchMultisearchHeader.md) | [MsearchTemplateTemplateConfig](./MsearchTemplateTemplateConfig.md); +::: diff --git a/docs/reference/api/MsearchTemplateResponse.md b/docs/reference/api/MsearchTemplateResponse.md new file mode 100644 index 000000000..af06bc769 --- /dev/null +++ b/docs/reference/api/MsearchTemplateResponse.md @@ -0,0 +1,4 @@ +## `MsearchTemplateResponse` +::: +type MsearchTemplateResponse> = [MsearchMultiSearchResult](./MsearchMultiSearchResult.md); +::: diff --git a/docs/reference/api/MsearchTemplateTemplateConfig.md b/docs/reference/api/MsearchTemplateTemplateConfig.md new file mode 100644 index 000000000..1531e91c8 --- /dev/null +++ b/docs/reference/api/MsearchTemplateTemplateConfig.md @@ -0,0 +1,9 @@ +## Interface `MsearchTemplateTemplateConfig` + +| Name | Type | Description | +| - | - | - | +| `explain` | boolean | If `true`, returns detailed information about score calculation as part of each hit. | +| `id` | [Id](./Id.md) | The ID of the search template to use. If no `source` is specified, this parameter is required. | +| `params` | Record | Key-value pairs used to replace Mustache variables in the template. The key is the variable name. The value is the variable value. | +| `profile` | boolean | If `true`, the query execution is profiled. | +| `source` | [ScriptSource](./ScriptSource.md) | An inline search template. Supports the same parameters as the search API's request body. It also supports Mustache variables. If no `id` is specified, this parameter is required. | diff --git a/docs/reference/api/MtermvectorsApi_1.md b/docs/reference/api/MtermvectorsApi_1.md new file mode 100644 index 000000000..750bc88b8 --- /dev/null +++ b/docs/reference/api/MtermvectorsApi_1.md @@ -0,0 +1,3 @@ +::: +default function MtermvectorsApi(this: [That](./That.md), params?: [MtermvectorsRequest](./MtermvectorsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MtermvectorsResponse](./MtermvectorsResponse.md)>; +::: diff --git a/docs/reference/api/MtermvectorsApi_2.md b/docs/reference/api/MtermvectorsApi_2.md new file mode 100644 index 000000000..06ff7289c --- /dev/null +++ b/docs/reference/api/MtermvectorsApi_2.md @@ -0,0 +1,3 @@ +::: +default function MtermvectorsApi(this: [That](./That.md), params?: [MtermvectorsRequest](./MtermvectorsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MtermvectorsResponse](./MtermvectorsResponse.md), unknown>>; +::: diff --git a/docs/reference/api/MtermvectorsApi_3.md b/docs/reference/api/MtermvectorsApi_3.md new file mode 100644 index 000000000..5ff94be24 --- /dev/null +++ b/docs/reference/api/MtermvectorsApi_3.md @@ -0,0 +1,3 @@ +::: +default function MtermvectorsApi(this: [That](./That.md), params?: [MtermvectorsRequest](./MtermvectorsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MtermvectorsResponse](./MtermvectorsResponse.md)>; +::: diff --git a/docs/reference/api/MtermvectorsOperation.md b/docs/reference/api/MtermvectorsOperation.md new file mode 100644 index 000000000..f6afe144d --- /dev/null +++ b/docs/reference/api/MtermvectorsOperation.md @@ -0,0 +1,17 @@ +## Interface `MtermvectorsOperation` + +| Name | Type | Description | +| - | - | - | +| `_id` | [Id](./Id.md) | The ID of the document. | +| `_index` | [IndexName](./IndexName.md) | The index of the document. | +| `doc` | any | An artificial document (a document not present in the index) for which you want to retrieve term vectors. | +| `field_statistics` | boolean | If `true`, the response includes the document count, sum of document frequencies, and sum of total term frequencies. | +| `fields` | [Fields](./Fields.md) | Comma-separated list or wildcard expressions of fields to include in the statistics. Used as the default list unless a specific field list is provided in the `completion_fields` or `fielddata_fields` parameters. | +| `filter` | [TermvectorsFilter](./TermvectorsFilter.md) | Filter terms based on their tf-idf scores. | +| `offsets` | boolean | If `true`, the response includes term offsets. | +| `payloads` | boolean | If `true`, the response includes term payloads. | +| `positions` | boolean | If `true`, the response includes term positions. | +| `routing` | [Routing](./Routing.md) | Custom value used to route operations to a specific shard. | +| `term_statistics` | boolean | If true, the response includes term frequency and document frequency. | +| `version_type` | [VersionType](./VersionType.md) | Specific version type. | +| `version` | [VersionNumber](./VersionNumber.md) | If `true`, returns the document version as part of a hit. | diff --git a/docs/reference/api/MtermvectorsRequest.md b/docs/reference/api/MtermvectorsRequest.md new file mode 100644 index 000000000..7f78fd0f9 --- /dev/null +++ b/docs/reference/api/MtermvectorsRequest.md @@ -0,0 +1,20 @@ +## Interface `MtermvectorsRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { index?: never; fields?: never; field_statistics?: never; offsets?: never; payloads?: never; positions?: never; preference?: never; realtime?: never; routing?: never; term_statistics?: never; version?: never; version_type?: never; docs?: never; ids?: never; }) | All values in `body` will be added to the request body. | +| `docs` | [MtermvectorsOperation](./MtermvectorsOperation.md)[] | An array of existing or artificial documents. | +| `field_statistics` | boolean | If `true`, the response includes the document count, sum of document frequencies, and sum of total term frequencies. | +| `fields` | [Fields](./Fields.md) | A comma-separated list or wildcard expressions of fields to include in the statistics. It is used as the default list unless a specific field list is provided in the `completion_fields` or `fielddata_fields` parameters. | +| `ids` | [Id](./Id.md)[] | A simplified syntax to specify documents by their ID if they're in the same index. | +| `index` | [IndexName](./IndexName.md) | The name of the index that contains the documents. | +| `offsets` | boolean | If `true`, the response includes term offsets. | +| `payloads` | boolean | If `true`, the response includes term payloads. | +| `positions` | boolean | If `true`, the response includes term positions. | +| `preference` | string | The node or shard the operation should be performed on. It is random by default. | +| `querystring` | { [key: string]: any; } & { index?: never; fields?: never; field_statistics?: never; offsets?: never; payloads?: never; positions?: never; preference?: never; realtime?: never; routing?: never; term_statistics?: never; version?: never; version_type?: never; docs?: never; ids?: never; } | All values in `querystring` will be added to the request querystring. | +| `realtime` | boolean | If true, the request is real-time as opposed to near-real-time. | +| `routing` | [Routing](./Routing.md) | A custom value used to route operations to a specific shard. | +| `term_statistics` | boolean | If true, the response includes term frequency and document frequency. | +| `version_type` | [VersionType](./VersionType.md) | The version type. | +| `version` | [VersionNumber](./VersionNumber.md) | If `true`, returns the document version as part of a hit. | diff --git a/docs/reference/api/MtermvectorsResponse.md b/docs/reference/api/MtermvectorsResponse.md new file mode 100644 index 000000000..6ac6727ce --- /dev/null +++ b/docs/reference/api/MtermvectorsResponse.md @@ -0,0 +1,5 @@ +## Interface `MtermvectorsResponse` + +| Name | Type | Description | +| - | - | - | +| `docs` | [MtermvectorsTermVectorsResult](./MtermvectorsTermVectorsResult.md)[] |   | diff --git a/docs/reference/api/MtermvectorsTermVectorsResult.md b/docs/reference/api/MtermvectorsTermVectorsResult.md new file mode 100644 index 000000000..62442602c --- /dev/null +++ b/docs/reference/api/MtermvectorsTermVectorsResult.md @@ -0,0 +1,11 @@ +## Interface `MtermvectorsTermVectorsResult` + +| Name | Type | Description | +| - | - | - | +| `_id` | [Id](./Id.md) |   | +| `_index` | [IndexName](./IndexName.md) |   | +| `_version` | [VersionNumber](./VersionNumber.md) |   | +| `error` | [ErrorCause](./ErrorCause.md) |   | +| `found` | boolean |   | +| `term_vectors` | Record<[Field](./Field.md), [TermvectorsTermVector](./TermvectorsTermVector.md)> |   | +| `took` | [long](./long.md) |   | diff --git a/docs/reference/api/MultiTermQueryRewrite.md b/docs/reference/api/MultiTermQueryRewrite.md new file mode 100644 index 000000000..55a9ae49b --- /dev/null +++ b/docs/reference/api/MultiTermQueryRewrite.md @@ -0,0 +1,4 @@ +## `MultiTermQueryRewrite` +::: +type MultiTermQueryRewrite = string; +::: diff --git a/docs/reference/api/Name.md b/docs/reference/api/Name.md new file mode 100644 index 000000000..cff4ff4ad --- /dev/null +++ b/docs/reference/api/Name.md @@ -0,0 +1,4 @@ +## `Name` +::: +type Name = string; +::: diff --git a/docs/reference/api/Names.md b/docs/reference/api/Names.md new file mode 100644 index 000000000..5e34e868e --- /dev/null +++ b/docs/reference/api/Names.md @@ -0,0 +1,4 @@ +## `Names` +::: +type Names = [Name](./Name.md) | [Name](./Name.md)[]; +::: diff --git a/docs/reference/api/Namespace.md b/docs/reference/api/Namespace.md new file mode 100644 index 000000000..a03f8fcca --- /dev/null +++ b/docs/reference/api/Namespace.md @@ -0,0 +1,4 @@ +## `Namespace` +::: +type Namespace = string; +::: diff --git a/docs/reference/api/NestedSortValue.md b/docs/reference/api/NestedSortValue.md new file mode 100644 index 000000000..a154b2bb3 --- /dev/null +++ b/docs/reference/api/NestedSortValue.md @@ -0,0 +1,8 @@ +## Interface `NestedSortValue` + +| Name | Type | Description | +| - | - | - | +| `filter` | [QueryDslQueryContainer](./QueryDslQueryContainer.md) |   | +| `max_children` | [integer](./integer.md) |   | +| `nested` | [NestedSortValue](./NestedSortValue.md) |   | +| `path` | [Field](./Field.md) |   | diff --git a/docs/reference/api/NodeAttributes.md b/docs/reference/api/NodeAttributes.md new file mode 100644 index 000000000..10a1f0e4a --- /dev/null +++ b/docs/reference/api/NodeAttributes.md @@ -0,0 +1,9 @@ +## Interface `NodeAttributes` + +| Name | Type | Description | +| - | - | - | +| `attributes` | Record | Lists node attributes. | +| `ephemeral_id` | [Id](./Id.md) | The ephemeral ID of the node. | +| `id` | [NodeId](./NodeId.md) | The unique identifier of the node. | +| `name` | [NodeName](./NodeName.md) | The unique identifier of the node. | +| `transport_address` | [TransportAddress](./TransportAddress.md) | The host and port where transport HTTP connections are accepted. | diff --git a/docs/reference/api/NodeId.md b/docs/reference/api/NodeId.md new file mode 100644 index 000000000..d25127ee4 --- /dev/null +++ b/docs/reference/api/NodeId.md @@ -0,0 +1,4 @@ +## `NodeId` +::: +type NodeId = string; +::: diff --git a/docs/reference/api/NodeIds.md b/docs/reference/api/NodeIds.md new file mode 100644 index 000000000..3035274bf --- /dev/null +++ b/docs/reference/api/NodeIds.md @@ -0,0 +1,4 @@ +## `NodeIds` +::: +type NodeIds = [NodeId](./NodeId.md) | [NodeId](./NodeId.md)[]; +::: diff --git a/docs/reference/api/NodeName.md b/docs/reference/api/NodeName.md new file mode 100644 index 000000000..ebc5ef517 --- /dev/null +++ b/docs/reference/api/NodeName.md @@ -0,0 +1,4 @@ +## `NodeName` +::: +type NodeName = string; +::: diff --git a/docs/reference/api/NodeOptions.md b/docs/reference/api/NodeOptions.md new file mode 100644 index 000000000..bfe94d8ba --- /dev/null +++ b/docs/reference/api/NodeOptions.md @@ -0,0 +1,10 @@ +## Interface `NodeOptions` + +| Name | Type | Description | +| - | - | - | +| `agent` | [HttpAgentOptions](./HttpAgentOptions.md) | [UndiciAgentOptions](./UndiciAgentOptions.md) | agent Custom HTTP agent options | +| `headers` | Record | headers Custom HTTP headers that should be sent with each request | +| `id` | string |   | +| `roles` | { master: boolean; data: boolean; ingest: boolean; ml: boolean; } | roles Common Elasticsearch roles that can be assigned to this node. Can be helpful when writing custom nodeFilter or nodeSelector functions. | +| `ssl` | [TlsConnectionOptions](./TlsConnectionOptions.md) | ssl Overrides default TLS connection settings | +| `url` | URL | url Elasticsearch node's location | diff --git a/docs/reference/api/NodeRole.md b/docs/reference/api/NodeRole.md new file mode 100644 index 000000000..7a864e11c --- /dev/null +++ b/docs/reference/api/NodeRole.md @@ -0,0 +1,4 @@ +## `NodeRole` +::: +type NodeRole = 'master' | 'data' | 'data_cold' | 'data_content' | 'data_frozen' | 'data_hot' | 'data_warm' | 'client' | 'ingest' | 'ml' | 'voting_only' | 'transform' | 'remote_cluster_client' | 'coordinating_only'; +::: diff --git a/docs/reference/api/NodeRoles.md b/docs/reference/api/NodeRoles.md new file mode 100644 index 000000000..a687f5ba9 --- /dev/null +++ b/docs/reference/api/NodeRoles.md @@ -0,0 +1,4 @@ +## `NodeRoles` +::: +type NodeRoles = [NodeRole](./NodeRole.md)[]; +::: diff --git a/docs/reference/api/NodeShard.md b/docs/reference/api/NodeShard.md new file mode 100644 index 000000000..6c79e84f2 --- /dev/null +++ b/docs/reference/api/NodeShard.md @@ -0,0 +1,14 @@ +## Interface `NodeShard` + +| Name | Type | Description | +| - | - | - | +| `allocation_id` | Record |   | +| `index` | [IndexName](./IndexName.md) |   | +| `node` | [NodeName](./NodeName.md) |   | +| `primary` | boolean |   | +| `recovery_source` | Record |   | +| `relocating_node` | [NodeId](./NodeId.md) | null |   | +| `relocation_failure_info` | [RelocationFailureInfo](./RelocationFailureInfo.md) |   | +| `shard` | [integer](./integer.md) |   | +| `state` | [IndicesStatsShardRoutingState](./IndicesStatsShardRoutingState.md) |   | +| `unassigned_info` | [ClusterAllocationExplainUnassignedInformation](./ClusterAllocationExplainUnassignedInformation.md) |   | diff --git a/docs/reference/api/NodeStatistics.md b/docs/reference/api/NodeStatistics.md new file mode 100644 index 000000000..103a69a78 --- /dev/null +++ b/docs/reference/api/NodeStatistics.md @@ -0,0 +1,8 @@ +## Interface `NodeStatistics` + +| Name | Type | Description | +| - | - | - | +| `failed` | [integer](./integer.md) | Number of nodes that rejected the request or failed to respond. If this value is not 0, a reason for the rejection or failure is included in the response. | +| `failures` | [ErrorCause](./ErrorCause.md)[] |   | +| `successful` | [integer](./integer.md) | Number of nodes that responded successfully to the request. | +| `total` | [integer](./integer.md) | Total number of nodes selected by the request. | diff --git a/docs/reference/api/Nodes.md b/docs/reference/api/Nodes.md new file mode 100644 index 000000000..3f9b56e12 --- /dev/null +++ b/docs/reference/api/Nodes.md @@ -0,0 +1,20 @@ +## `Nodes` + +### Constructor + +::: +new Nodes(transport: [Transport](./Transport.md)); +::: + +### Properties + +| Name | Type | Description | +| - | - | - | +| `acceptedParams` | Record |   | +| `transport` | [Transport](./Transport.md) |   | + +### Methods + +| Name | Signature | Description | +| - | - | - | +| `clearRepositoriesMeteringArchive` | `clearRepositoriesMeteringArchive(this: [That](./That.md), params: [NodesClearRepositoriesMeteringArchiveRequest](./NodesClearRepositoriesMeteringArchiveRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[NodesClearRepositoriesMeteringArchiveResponse](./NodesClearRepositoriesMeteringArchiveResponse.md)>;` | Clear the archived repositories metering. Clear the archived repositories metering information in the cluster. || `clearRepositoriesMeteringArchive` | `clearRepositoriesMeteringArchive(this: [That](./That.md), params: [NodesClearRepositoriesMeteringArchiveRequest](./NodesClearRepositoriesMeteringArchiveRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[NodesClearRepositoriesMeteringArchiveResponse](./NodesClearRepositoriesMeteringArchiveResponse.md), unknown>>;` |   || `clearRepositoriesMeteringArchive` | `clearRepositoriesMeteringArchive(this: [That](./That.md), params: [NodesClearRepositoriesMeteringArchiveRequest](./NodesClearRepositoriesMeteringArchiveRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[NodesClearRepositoriesMeteringArchiveResponse](./NodesClearRepositoriesMeteringArchiveResponse.md)>;` |   || `getRepositoriesMeteringInfo` | `getRepositoriesMeteringInfo(this: [That](./That.md), params: [NodesGetRepositoriesMeteringInfoRequest](./NodesGetRepositoriesMeteringInfoRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[NodesGetRepositoriesMeteringInfoResponse](./NodesGetRepositoriesMeteringInfoResponse.md)>;` | Get cluster repositories metering. Get repositories metering information for a cluster. This API exposes monotonically non-decreasing counters and it is expected that clients would durably store the information needed to compute aggregations over a period of time. Additionally, the information exposed by this API is volatile, meaning that it will not be present after node restarts. || `getRepositoriesMeteringInfo` | `getRepositoriesMeteringInfo(this: [That](./That.md), params: [NodesGetRepositoriesMeteringInfoRequest](./NodesGetRepositoriesMeteringInfoRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[NodesGetRepositoriesMeteringInfoResponse](./NodesGetRepositoriesMeteringInfoResponse.md), unknown>>;` |   || `getRepositoriesMeteringInfo` | `getRepositoriesMeteringInfo(this: [That](./That.md), params: [NodesGetRepositoriesMeteringInfoRequest](./NodesGetRepositoriesMeteringInfoRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[NodesGetRepositoriesMeteringInfoResponse](./NodesGetRepositoriesMeteringInfoResponse.md)>;` |   || `hotThreads` | `hotThreads(this: [That](./That.md), params?: [NodesHotThreadsRequest](./NodesHotThreadsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[NodesHotThreadsResponse](./NodesHotThreadsResponse.md)>;` | Get the hot threads for nodes. Get a breakdown of the hot threads on each selected node in the cluster. The output is plain text with a breakdown of the top hot threads for each node. || `hotThreads` | `hotThreads(this: [That](./That.md), params?: [NodesHotThreadsRequest](./NodesHotThreadsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[NodesHotThreadsResponse](./NodesHotThreadsResponse.md), unknown>>;` |   || `hotThreads` | `hotThreads(this: [That](./That.md), params?: [NodesHotThreadsRequest](./NodesHotThreadsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[NodesHotThreadsResponse](./NodesHotThreadsResponse.md)>;` |   || `info` | `info(this: [That](./That.md), params?: [NodesInfoRequest](./NodesInfoRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[NodesInfoResponse](./NodesInfoResponse.md)>;` | Get node information. By default, the API returns all attributes and core settings for cluster nodes. || `info` | `info(this: [That](./That.md), params?: [NodesInfoRequest](./NodesInfoRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[NodesInfoResponse](./NodesInfoResponse.md), unknown>>;` |   || `info` | `info(this: [That](./That.md), params?: [NodesInfoRequest](./NodesInfoRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[NodesInfoResponse](./NodesInfoResponse.md)>;` |   || `reloadSecureSettings` | `reloadSecureSettings(this: [That](./That.md), params?: [NodesReloadSecureSettingsRequest](./NodesReloadSecureSettingsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[NodesReloadSecureSettingsResponse](./NodesReloadSecureSettingsResponse.md)>;` | Reload the keystore on nodes in the cluster. Secure settings are stored in an on-disk keystore. Certain of these settings are reloadable. That is, you can change them on disk and reload them without restarting any nodes in the cluster. When you have updated reloadable secure settings in your keystore, you can use this API to reload those settings on each node. When the Elasticsearch keystore is password protected and not simply obfuscated, you must provide the password for the keystore when you reload the secure settings. Reloading the settings for the whole cluster assumes that the keystores for all nodes are protected with the same password; this method is allowed only when inter-node communications are encrypted. Alternatively, you can reload the secure settings on each node by locally accessing the API and passing the node-specific Elasticsearch keystore password. || `reloadSecureSettings` | `reloadSecureSettings(this: [That](./That.md), params?: [NodesReloadSecureSettingsRequest](./NodesReloadSecureSettingsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[NodesReloadSecureSettingsResponse](./NodesReloadSecureSettingsResponse.md), unknown>>;` |   || `reloadSecureSettings` | `reloadSecureSettings(this: [That](./That.md), params?: [NodesReloadSecureSettingsRequest](./NodesReloadSecureSettingsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[NodesReloadSecureSettingsResponse](./NodesReloadSecureSettingsResponse.md)>;` |   || `stats` | `stats(this: [That](./That.md), params?: [NodesStatsRequest](./NodesStatsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[NodesStatsResponse](./NodesStatsResponse.md)>;` | Get node statistics. Get statistics for nodes in a cluster. By default, all stats are returned. You can limit the returned information by using metrics. || `stats` | `stats(this: [That](./That.md), params?: [NodesStatsRequest](./NodesStatsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[NodesStatsResponse](./NodesStatsResponse.md), unknown>>;` |   || `stats` | `stats(this: [That](./That.md), params?: [NodesStatsRequest](./NodesStatsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[NodesStatsResponse](./NodesStatsResponse.md)>;` |   || `usage` | `usage(this: [That](./That.md), params?: [NodesUsageRequest](./NodesUsageRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[NodesUsageResponse](./NodesUsageResponse.md)>;` | Get feature usage information. || `usage` | `usage(this: [That](./That.md), params?: [NodesUsageRequest](./NodesUsageRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[NodesUsageResponse](./NodesUsageResponse.md), unknown>>;` |   || `usage` | `usage(this: [That](./That.md), params?: [NodesUsageRequest](./NodesUsageRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[NodesUsageResponse](./NodesUsageResponse.md)>;` |   | \ No newline at end of file diff --git a/docs/reference/api/NodesAdaptiveSelection.md b/docs/reference/api/NodesAdaptiveSelection.md new file mode 100644 index 000000000..acede7bf6 --- /dev/null +++ b/docs/reference/api/NodesAdaptiveSelection.md @@ -0,0 +1,11 @@ +## Interface `NodesAdaptiveSelection` + +| Name | Type | Description | +| - | - | - | +| `avg_queue_size` | [long](./long.md) | The exponentially weighted moving average queue size of search requests on the keyed node. | +| `avg_response_time_ns` | [long](./long.md) | The exponentially weighted moving average response time, in nanoseconds, of search requests on the keyed node. | +| `avg_response_time` | [Duration](./Duration.md) | The exponentially weighted moving average response time of search requests on the keyed node. | +| `avg_service_time_ns` | [long](./long.md) | The exponentially weighted moving average service time, in nanoseconds, of search requests on the keyed node. | +| `avg_service_time` | [Duration](./Duration.md) | The exponentially weighted moving average service time of search requests on the keyed node. | +| `outgoing_searches` | [long](./long.md) | The number of outstanding search requests to the keyed node from the node these stats are for. | +| `rank` | string | The rank of this node; used for shard selection when routing search requests. | diff --git a/docs/reference/api/NodesBreaker.md b/docs/reference/api/NodesBreaker.md new file mode 100644 index 000000000..e9e8053c6 --- /dev/null +++ b/docs/reference/api/NodesBreaker.md @@ -0,0 +1,10 @@ +## Interface `NodesBreaker` + +| Name | Type | Description | +| - | - | - | +| `estimated_size_in_bytes` | [long](./long.md) | Estimated memory used, in bytes, for the operation. | +| `estimated_size` | string | Estimated memory used for the operation. | +| `limit_size_in_bytes` | [long](./long.md) | Memory limit, in bytes, for the circuit breaker. | +| `limit_size` | string | Memory limit for the circuit breaker. | +| `overhead` | [float](./float.md) | A constant that all estimates for the circuit breaker are multiplied with to calculate a final estimate. | +| `tripped` | [float](./float.md) | Total number of times the circuit breaker has been triggered and prevented an out of memory error. | diff --git a/docs/reference/api/NodesCgroup.md b/docs/reference/api/NodesCgroup.md new file mode 100644 index 000000000..d1e862dcd --- /dev/null +++ b/docs/reference/api/NodesCgroup.md @@ -0,0 +1,7 @@ +## Interface `NodesCgroup` + +| Name | Type | Description | +| - | - | - | +| `cpu` | [NodesCgroupCpu](./NodesCgroupCpu.md) | Contains statistics about `cpu` control group for the node. | +| `cpuacct` | [NodesCpuAcct](./NodesCpuAcct.md) | Contains statistics about `cpuacct` control group for the node. | +| `memory` | [NodesCgroupMemory](./NodesCgroupMemory.md) | Contains statistics about the memory control group for the node. | diff --git a/docs/reference/api/NodesCgroupCpu.md b/docs/reference/api/NodesCgroupCpu.md new file mode 100644 index 000000000..207ef1d1f --- /dev/null +++ b/docs/reference/api/NodesCgroupCpu.md @@ -0,0 +1,8 @@ +## Interface `NodesCgroupCpu` + +| Name | Type | Description | +| - | - | - | +| `cfs_period_micros` | [integer](./integer.md) | The period of time, in microseconds, for how regularly all tasks in the same cgroup as the Elasticsearch process should have their access to CPU resources reallocated. | +| `cfs_quota_micros` | [integer](./integer.md) | The total amount of time, in microseconds, for which all tasks in the same cgroup as the Elasticsearch process can run during one period `cfs_period_micros`. | +| `control_group` | string | The `cpu` control group to which the Elasticsearch process belongs. | +| `stat` | [NodesCgroupCpuStat](./NodesCgroupCpuStat.md) | Contains CPU statistics for the node. | diff --git a/docs/reference/api/NodesCgroupCpuStat.md b/docs/reference/api/NodesCgroupCpuStat.md new file mode 100644 index 000000000..ecf43b8d4 --- /dev/null +++ b/docs/reference/api/NodesCgroupCpuStat.md @@ -0,0 +1,7 @@ +## Interface `NodesCgroupCpuStat` + +| Name | Type | Description | +| - | - | - | +| `number_of_elapsed_periods` | [long](./long.md) | The number of reporting periods (as specified by `cfs_period_micros`) that have elapsed. | +| `number_of_times_throttled` | [long](./long.md) | The number of times all tasks in the same cgroup as the Elasticsearch process have been throttled. | +| `time_throttled_nanos` | [DurationValue](./DurationValue.md)<[UnitNanos](./UnitNanos.md)> | The total amount of time, in nanoseconds, for which all tasks in the same cgroup as the Elasticsearch process have been throttled. | diff --git a/docs/reference/api/NodesCgroupMemory.md b/docs/reference/api/NodesCgroupMemory.md new file mode 100644 index 000000000..734df45d8 --- /dev/null +++ b/docs/reference/api/NodesCgroupMemory.md @@ -0,0 +1,7 @@ +## Interface `NodesCgroupMemory` + +| Name | Type | Description | +| - | - | - | +| `control_group` | string | The `memory` control group to which the Elasticsearch process belongs. | +| `limit_in_bytes` | string | The maximum amount of user memory (including file cache) allowed for all tasks in the same cgroup as the Elasticsearch process. This value can be too big to store in a `long`, so is returned as a string so that the value returned can exactly match what the underlying operating system interface returns. Any value that is too large to parse into a `long` almost certainly means no limit has been set for the cgroup. | +| `usage_in_bytes` | string | The total current memory usage by processes in the cgroup, in bytes, by all tasks in the same cgroup as the Elasticsearch process. This value is stored as a string for consistency with `limit_in_bytes`. | diff --git a/docs/reference/api/NodesClearRepositoriesMeteringArchiveRequest.md b/docs/reference/api/NodesClearRepositoriesMeteringArchiveRequest.md new file mode 100644 index 000000000..849a4ce3c --- /dev/null +++ b/docs/reference/api/NodesClearRepositoriesMeteringArchiveRequest.md @@ -0,0 +1,8 @@ +## Interface `NodesClearRepositoriesMeteringArchiveRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { node_id?: never; max_archive_version?: never; }) | All values in `body` will be added to the request body. | +| `max_archive_version` | [long](./long.md) | Specifies the maximum `archive_version` to be cleared from the archive. | +| `node_id` | [NodeIds](./NodeIds.md) | Comma-separated list of node IDs or names used to limit returned information. | +| `querystring` | { [key: string]: any; } & { node_id?: never; max_archive_version?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/NodesClearRepositoriesMeteringArchiveResponse.md b/docs/reference/api/NodesClearRepositoriesMeteringArchiveResponse.md new file mode 100644 index 000000000..55c07b010 --- /dev/null +++ b/docs/reference/api/NodesClearRepositoriesMeteringArchiveResponse.md @@ -0,0 +1,4 @@ +## `NodesClearRepositoriesMeteringArchiveResponse` +::: +type NodesClearRepositoriesMeteringArchiveResponse = [NodesClearRepositoriesMeteringArchiveResponseBase](./NodesClearRepositoriesMeteringArchiveResponseBase.md); +::: diff --git a/docs/reference/api/NodesClearRepositoriesMeteringArchiveResponseBase.md b/docs/reference/api/NodesClearRepositoriesMeteringArchiveResponseBase.md new file mode 100644 index 000000000..7a7c81e57 --- /dev/null +++ b/docs/reference/api/NodesClearRepositoriesMeteringArchiveResponseBase.md @@ -0,0 +1,6 @@ +## Interface `NodesClearRepositoriesMeteringArchiveResponseBase` + +| Name | Type | Description | +| - | - | - | +| `cluster_name` | [Name](./Name.md) | Name of the cluster. Based on the `cluster.name` setting. | +| `nodes` | Record | Contains repositories metering information for the nodes selected by the request. | diff --git a/docs/reference/api/NodesClient.md b/docs/reference/api/NodesClient.md new file mode 100644 index 000000000..72934c22f --- /dev/null +++ b/docs/reference/api/NodesClient.md @@ -0,0 +1,15 @@ +## Interface `NodesClient` + +| Name | Type | Description | +| - | - | - | +| `agent` | string | Reported agent for the HTTP client. If unavailable, this property is not included in the response. | +| `closed_time_millis` | [long](./long.md) | Time at which the client closed the connection if the connection is closed. | +| `id` | [long](./long.md) | Unique ID for the HTTP client. | +| `last_request_time_millis` | [long](./long.md) | Time of the most recent request from this client. | +| `last_uri` | string | The URI of the client’s most recent request. | +| `local_address` | string | Local address for the HTTP connection. | +| `opened_time_millis` | [long](./long.md) | Time at which the client opened the connection. | +| `remote_address` | string | Remote address for the HTTP connection. | +| `request_count` | [long](./long.md) | Number of requests from this client. | +| `request_size_bytes` | [long](./long.md) | Cumulative size in bytes of all requests from this client. | +| `x_opaque_id` | string | Value from the client’s `x-opaque-id` HTTP header. If unavailable, this property is not included in the response. | diff --git a/docs/reference/api/NodesClusterAppliedStats.md b/docs/reference/api/NodesClusterAppliedStats.md new file mode 100644 index 000000000..eeef14c99 --- /dev/null +++ b/docs/reference/api/NodesClusterAppliedStats.md @@ -0,0 +1,5 @@ +## Interface `NodesClusterAppliedStats` + +| Name | Type | Description | +| - | - | - | +| `recordings` | [NodesRecording](./NodesRecording.md)[] |   | diff --git a/docs/reference/api/NodesClusterStateQueue.md b/docs/reference/api/NodesClusterStateQueue.md new file mode 100644 index 000000000..fbc106fd5 --- /dev/null +++ b/docs/reference/api/NodesClusterStateQueue.md @@ -0,0 +1,7 @@ +## Interface `NodesClusterStateQueue` + +| Name | Type | Description | +| - | - | - | +| `committed` | [long](./long.md) | Number of committed cluster states in queue. | +| `pending` | [long](./long.md) | Number of pending cluster states in queue. | +| `total` | [long](./long.md) | Total number of cluster states in queue. | diff --git a/docs/reference/api/NodesClusterStateUpdate.md b/docs/reference/api/NodesClusterStateUpdate.md new file mode 100644 index 000000000..955ebe4c5 --- /dev/null +++ b/docs/reference/api/NodesClusterStateUpdate.md @@ -0,0 +1,19 @@ +## Interface `NodesClusterStateUpdate` + +| Name | Type | Description | +| - | - | - | +| `commit_time_millis` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> | The cumulative amount of time, in milliseconds, spent waiting for a successful cluster state update to commit, which measures the time from the start of each publication until a majority of the master-eligible nodes have written the state to disk and confirmed the write to the elected master. | +| `commit_time` | [Duration](./Duration.md) | The cumulative amount of time spent waiting for a successful cluster state update to commit, which measures the time from the start of each publication until a majority of the master-eligible nodes have written the state to disk and confirmed the write to the elected master. | +| `completion_time_millis` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> | The cumulative amount of time, in milliseconds, spent waiting for a successful cluster state update to complete, which measures the time from the start of each publication until all the other nodes have notified the elected master that they have applied the cluster state. | +| `completion_time` | [Duration](./Duration.md) | The cumulative amount of time spent waiting for a successful cluster state update to complete, which measures the time from the start of each publication until all the other nodes have notified the elected master that they have applied the cluster state. | +| `computation_time_millis` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> | The cumulative amount of time, in milliseconds, spent computing no-op cluster state updates since the node started. | +| `computation_time` | [Duration](./Duration.md) | The cumulative amount of time spent computing no-op cluster state updates since the node started. | +| `context_construction_time_millis` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> | The cumulative amount of time, in milliseconds, spent constructing a publication context since the node started for publications that ultimately succeeded. This statistic includes the time spent computing the difference between the current and new cluster state preparing a serialized representation of this difference. | +| `context_construction_time` | [Duration](./Duration.md) | The cumulative amount of time spent constructing a publication context since the node started for publications that ultimately succeeded. This statistic includes the time spent computing the difference between the current and new cluster state preparing a serialized representation of this difference. | +| `count` | [long](./long.md) | The number of cluster state update attempts that did not change the cluster state since the node started. | +| `master_apply_time_millis` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> | The cumulative amount of time, in milliseconds, spent successfully applying cluster state updates on the elected master since the node started. | +| `master_apply_time` | [Duration](./Duration.md) | The cumulative amount of time spent successfully applying cluster state updates on the elected master since the node started. | +| `notification_time_millis` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> | The cumulative amount of time, in milliseconds, spent notifying listeners of a no-op cluster state update since the node started. | +| `notification_time` | [Duration](./Duration.md) | The cumulative amount of time spent notifying listeners of a no-op cluster state update since the node started. | +| `publication_time_millis` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> | The cumulative amount of time, in milliseconds, spent publishing cluster state updates which ultimately succeeded, which includes everything from the start of the publication (just after the computation of the new cluster state) until the publication has finished and the master node is ready to start processing the next state update. This includes the time measured by `context_construction_time`, `commit_time`, `completion_time` and `master_apply_time`. | +| `publication_time` | [Duration](./Duration.md) | The cumulative amount of time spent publishing cluster state updates which ultimately succeeded, which includes everything from the start of the publication (just after the computation of the new cluster state) until the publication has finished and the master node is ready to start processing the next state update. This includes the time measured by `context_construction_time`, `commit_time`, `completion_time` and `master_apply_time`. | diff --git a/docs/reference/api/NodesContext.md b/docs/reference/api/NodesContext.md new file mode 100644 index 000000000..6af796788 --- /dev/null +++ b/docs/reference/api/NodesContext.md @@ -0,0 +1,8 @@ +## Interface `NodesContext` + +| Name | Type | Description | +| - | - | - | +| `cache_evictions` | [long](./long.md) |   | +| `compilation_limit_triggered` | [long](./long.md) |   | +| `compilations` | [long](./long.md) |   | +| `context` | string |   | diff --git a/docs/reference/api/NodesCpu.md b/docs/reference/api/NodesCpu.md new file mode 100644 index 000000000..1f46b4d1a --- /dev/null +++ b/docs/reference/api/NodesCpu.md @@ -0,0 +1,12 @@ +## Interface `NodesCpu` + +| Name | Type | Description | +| - | - | - | +| `load_average` | Record |   | +| `percent` | [integer](./integer.md) |   | +| `sys_in_millis` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> |   | +| `sys` | [Duration](./Duration.md) |   | +| `total_in_millis` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> |   | +| `total` | [Duration](./Duration.md) |   | +| `user_in_millis` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> |   | +| `user` | [Duration](./Duration.md) |   | diff --git a/docs/reference/api/NodesCpuAcct.md b/docs/reference/api/NodesCpuAcct.md new file mode 100644 index 000000000..244908115 --- /dev/null +++ b/docs/reference/api/NodesCpuAcct.md @@ -0,0 +1,6 @@ +## Interface `NodesCpuAcct` + +| Name | Type | Description | +| - | - | - | +| `control_group` | string | The `cpuacct` control group to which the Elasticsearch process belongs. | +| `usage_nanos` | [DurationValue](./DurationValue.md)<[UnitNanos](./UnitNanos.md)> | The total CPU time, in nanoseconds, consumed by all tasks in the same cgroup as the Elasticsearch process. | diff --git a/docs/reference/api/NodesDataPathStats.md b/docs/reference/api/NodesDataPathStats.md new file mode 100644 index 000000000..240cae9e1 --- /dev/null +++ b/docs/reference/api/NodesDataPathStats.md @@ -0,0 +1,20 @@ +## Interface `NodesDataPathStats` + +| Name | Type | Description | +| - | - | - | +| `available_in_bytes` | [long](./long.md) | Total number of bytes available to this Java virtual machine on this file store. | +| `available` | string | Total amount of disk space available to this Java virtual machine on this file store. | +| `disk_queue` | string |   | +| `disk_read_size_in_bytes` | [long](./long.md) |   | +| `disk_read_size` | string |   | +| `disk_reads` | [long](./long.md) |   | +| `disk_write_size_in_bytes` | [long](./long.md) |   | +| `disk_write_size` | string |   | +| `disk_writes` | [long](./long.md) |   | +| `free_in_bytes` | [long](./long.md) | Total number of unallocated bytes in the file store. | +| `free` | string | Total amount of unallocated disk space in the file store. | +| `mount` | string | Mount point of the file store (for example: `/dev/sda2`). | +| `path` | string | Path to the file store. | +| `total_in_bytes` | [long](./long.md) | Total size of the file store in bytes. | +| `total` | string | Total size of the file store. | +| `type` | string | Type of the file store (ex: ext4). | diff --git a/docs/reference/api/NodesDiscovery.md b/docs/reference/api/NodesDiscovery.md new file mode 100644 index 000000000..4fe170b33 --- /dev/null +++ b/docs/reference/api/NodesDiscovery.md @@ -0,0 +1,9 @@ +## Interface `NodesDiscovery` + +| Name | Type | Description | +| - | - | - | +| `cluster_applier_stats` | [NodesClusterAppliedStats](./NodesClusterAppliedStats.md) |   | +| `cluster_state_queue` | [NodesClusterStateQueue](./NodesClusterStateQueue.md) | Contains statistics for the cluster state queue of the node. | +| `cluster_state_update` | Record | Contains low-level statistics about how long various activities took during cluster state updates while the node was the elected master. Omitted if the node is not master-eligible. Every field whose name ends in `_time` within this object is also represented as a raw number of milliseconds in a field whose name ends in `_time_millis`. The human-readable fields with a `_time` suffix are only returned if requested with the `?human=true` query parameter. | +| `published_cluster_states` | [NodesPublishedClusterStates](./NodesPublishedClusterStates.md) | Contains statistics for the published cluster states of the node. | +| `serialized_cluster_states` | [NodesSerializedClusterState](./NodesSerializedClusterState.md) |   | diff --git a/docs/reference/api/NodesExtendedMemoryStats.md b/docs/reference/api/NodesExtendedMemoryStats.md new file mode 100644 index 000000000..961f9c8d1 --- /dev/null +++ b/docs/reference/api/NodesExtendedMemoryStats.md @@ -0,0 +1,6 @@ +## Interface `NodesExtendedMemoryStats` + +| Name | Type | Description | +| - | - | - | +| `free_percent` | [integer](./integer.md) | Percentage of free memory. | +| `used_percent` | [integer](./integer.md) | Percentage of used memory. | diff --git a/docs/reference/api/NodesFileSystem.md b/docs/reference/api/NodesFileSystem.md new file mode 100644 index 000000000..18d164ea6 --- /dev/null +++ b/docs/reference/api/NodesFileSystem.md @@ -0,0 +1,8 @@ +## Interface `NodesFileSystem` + +| Name | Type | Description | +| - | - | - | +| `data` | [NodesDataPathStats](./NodesDataPathStats.md)[] | List of all file stores. | +| `io_stats` | [NodesIoStats](./NodesIoStats.md) | Contains I/O statistics for the node. | +| `timestamp` | [long](./long.md) | Last time the file stores statistics were refreshed. Recorded in milliseconds since the Unix Epoch. | +| `total` | [NodesFileSystemTotal](./NodesFileSystemTotal.md) | Contains statistics for all file stores of the node. | diff --git a/docs/reference/api/NodesFileSystemTotal.md b/docs/reference/api/NodesFileSystemTotal.md new file mode 100644 index 000000000..39cc87029 --- /dev/null +++ b/docs/reference/api/NodesFileSystemTotal.md @@ -0,0 +1,10 @@ +## Interface `NodesFileSystemTotal` + +| Name | Type | Description | +| - | - | - | +| `available_in_bytes` | [long](./long.md) | Total number of bytes available to this Java virtual machine on all file stores. Depending on OS or process level restrictions, this might appear less than `free_in_bytes`. This is the actual amount of free disk space the Elasticsearch node can utilise. | +| `available` | string | Total disk space available to this Java virtual machine on all file stores. Depending on OS or process level restrictions, this might appear less than `free`. This is the actual amount of free disk space the Elasticsearch node can utilise. | +| `free_in_bytes` | [long](./long.md) | Total number of unallocated bytes in all file stores. | +| `free` | string | Total unallocated disk space in all file stores. | +| `total_in_bytes` | [long](./long.md) | Total size of all file stores in bytes. | +| `total` | string | Total size of all file stores. | diff --git a/docs/reference/api/NodesGarbageCollector.md b/docs/reference/api/NodesGarbageCollector.md new file mode 100644 index 000000000..8d5a70c02 --- /dev/null +++ b/docs/reference/api/NodesGarbageCollector.md @@ -0,0 +1,5 @@ +## Interface `NodesGarbageCollector` + +| Name | Type | Description | +| - | - | - | +| `collectors` | Record | Contains statistics about JVM garbage collectors for the node. | diff --git a/docs/reference/api/NodesGarbageCollectorTotal.md b/docs/reference/api/NodesGarbageCollectorTotal.md new file mode 100644 index 000000000..5c9a6343f --- /dev/null +++ b/docs/reference/api/NodesGarbageCollectorTotal.md @@ -0,0 +1,7 @@ +## Interface `NodesGarbageCollectorTotal` + +| Name | Type | Description | +| - | - | - | +| `collection_count` | [long](./long.md) | Total number of JVM garbage collectors that collect objects. | +| `collection_time_in_millis` | [long](./long.md) | Total time, in milliseconds, spent by JVM collecting objects. | +| `collection_time` | string | Total time spent by JVM collecting objects. | diff --git a/docs/reference/api/NodesGetRepositoriesMeteringInfoRequest.md b/docs/reference/api/NodesGetRepositoriesMeteringInfoRequest.md new file mode 100644 index 000000000..e71d50a20 --- /dev/null +++ b/docs/reference/api/NodesGetRepositoriesMeteringInfoRequest.md @@ -0,0 +1,7 @@ +## Interface `NodesGetRepositoriesMeteringInfoRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { node_id?: never; }) | All values in `body` will be added to the request body. | +| `node_id` | [NodeIds](./NodeIds.md) | Comma-separated list of node IDs or names used to limit returned information. | +| `querystring` | { [key: string]: any; } & { node_id?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/NodesGetRepositoriesMeteringInfoResponse.md b/docs/reference/api/NodesGetRepositoriesMeteringInfoResponse.md new file mode 100644 index 000000000..7a4c826dd --- /dev/null +++ b/docs/reference/api/NodesGetRepositoriesMeteringInfoResponse.md @@ -0,0 +1,4 @@ +## `NodesGetRepositoriesMeteringInfoResponse` +::: +type NodesGetRepositoriesMeteringInfoResponse = [NodesGetRepositoriesMeteringInfoResponseBase](./NodesGetRepositoriesMeteringInfoResponseBase.md); +::: diff --git a/docs/reference/api/NodesGetRepositoriesMeteringInfoResponseBase.md b/docs/reference/api/NodesGetRepositoriesMeteringInfoResponseBase.md new file mode 100644 index 000000000..97a2195d6 --- /dev/null +++ b/docs/reference/api/NodesGetRepositoriesMeteringInfoResponseBase.md @@ -0,0 +1,6 @@ +## Interface `NodesGetRepositoriesMeteringInfoResponseBase` + +| Name | Type | Description | +| - | - | - | +| `cluster_name` | [Name](./Name.md) | Name of the cluster. Based on the `cluster.name` setting. | +| `nodes` | Record | Contains repositories metering information for the nodes selected by the request. | diff --git a/docs/reference/api/NodesHotThreadsRequest.md b/docs/reference/api/NodesHotThreadsRequest.md new file mode 100644 index 000000000..776ebdeac --- /dev/null +++ b/docs/reference/api/NodesHotThreadsRequest.md @@ -0,0 +1,14 @@ +## Interface `NodesHotThreadsRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { node_id?: never; ignore_idle_threads?: never; interval?: never; snapshots?: never; threads?: never; timeout?: never; type?: never; sort?: never; }) | All values in `body` will be added to the request body. | +| `ignore_idle_threads` | boolean | If true, known idle threads (e.g. waiting in a socket select, or to get a task from an empty queue) are filtered out. | +| `interval` | [Duration](./Duration.md) | The interval to do the second sampling of threads. | +| `node_id` | [NodeIds](./NodeIds.md) | List of node IDs or names used to limit returned information. | +| `querystring` | { [key: string]: any; } & { node_id?: never; ignore_idle_threads?: never; interval?: never; snapshots?: never; threads?: never; timeout?: never; type?: never; sort?: never; } | All values in `querystring` will be added to the request querystring. | +| `snapshots` | [long](./long.md) | Number of samples of thread stacktrace. | +| `sort` | [ThreadType](./ThreadType.md) | The sort order for 'cpu' type (default: total) | +| `threads` | [long](./long.md) | Specifies the number of hot threads to provide information for. | +| `timeout` | [Duration](./Duration.md) | Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. | +| `type` | [ThreadType](./ThreadType.md) | The type to sample. | diff --git a/docs/reference/api/NodesHotThreadsResponse.md b/docs/reference/api/NodesHotThreadsResponse.md new file mode 100644 index 000000000..74cb30af3 --- /dev/null +++ b/docs/reference/api/NodesHotThreadsResponse.md @@ -0,0 +1,4 @@ +## Interface `NodesHotThreadsResponse` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/NodesHttp.md b/docs/reference/api/NodesHttp.md new file mode 100644 index 000000000..b96796c54 --- /dev/null +++ b/docs/reference/api/NodesHttp.md @@ -0,0 +1,8 @@ +## Interface `NodesHttp` + +| Name | Type | Description | +| - | - | - | +| `clients` | [NodesClient](./NodesClient.md)[] | Information on current and recently-closed HTTP client connections. Clients that have been closed longer than the `http.client_stats.closed_channels.max_age` setting will not be represented here. | +| `current_open` | [integer](./integer.md) | Current number of open HTTP connections for the node. | +| `routes` | Record | Detailed HTTP stats broken down by route | +| `total_opened` | [long](./long.md) | Total number of HTTP connections opened for the node. | diff --git a/docs/reference/api/NodesHttpRoute.md b/docs/reference/api/NodesHttpRoute.md new file mode 100644 index 000000000..8f25d3cb9 --- /dev/null +++ b/docs/reference/api/NodesHttpRoute.md @@ -0,0 +1,6 @@ +## Interface `NodesHttpRoute` + +| Name | Type | Description | +| - | - | - | +| `requests` | [NodesHttpRouteRequests](./NodesHttpRouteRequests.md) |   | +| `responses` | [NodesHttpRouteResponses](./NodesHttpRouteResponses.md) |   | diff --git a/docs/reference/api/NodesHttpRouteRequests.md b/docs/reference/api/NodesHttpRouteRequests.md new file mode 100644 index 000000000..7fc796303 --- /dev/null +++ b/docs/reference/api/NodesHttpRouteRequests.md @@ -0,0 +1,7 @@ +## Interface `NodesHttpRouteRequests` + +| Name | Type | Description | +| - | - | - | +| `count` | [long](./long.md) |   | +| `size_histogram` | [NodesSizeHttpHistogram](./NodesSizeHttpHistogram.md)[] |   | +| `total_size_in_bytes` | [long](./long.md) |   | diff --git a/docs/reference/api/NodesHttpRouteResponses.md b/docs/reference/api/NodesHttpRouteResponses.md new file mode 100644 index 000000000..9bb2b0f79 --- /dev/null +++ b/docs/reference/api/NodesHttpRouteResponses.md @@ -0,0 +1,8 @@ +## Interface `NodesHttpRouteResponses` + +| Name | Type | Description | +| - | - | - | +| `count` | [long](./long.md) |   | +| `handling_time_histogram` | [NodesTimeHttpHistogram](./NodesTimeHttpHistogram.md)[] |   | +| `size_histogram` | [NodesSizeHttpHistogram](./NodesSizeHttpHistogram.md)[] |   | +| `total_size_in_bytes` | [long](./long.md) |   | diff --git a/docs/reference/api/NodesIndexingPressure.md b/docs/reference/api/NodesIndexingPressure.md new file mode 100644 index 000000000..76d057568 --- /dev/null +++ b/docs/reference/api/NodesIndexingPressure.md @@ -0,0 +1,5 @@ +## Interface `NodesIndexingPressure` + +| Name | Type | Description | +| - | - | - | +| `memory` | [NodesIndexingPressureMemory](./NodesIndexingPressureMemory.md) | Contains statistics for memory consumption from indexing load. | diff --git a/docs/reference/api/NodesIndexingPressureMemory.md b/docs/reference/api/NodesIndexingPressureMemory.md new file mode 100644 index 000000000..a49652090 --- /dev/null +++ b/docs/reference/api/NodesIndexingPressureMemory.md @@ -0,0 +1,8 @@ +## Interface `NodesIndexingPressureMemory` + +| Name | Type | Description | +| - | - | - | +| `current` | [NodesPressureMemory](./NodesPressureMemory.md) | Contains statistics for current indexing load. | +| `limit_in_bytes` | [long](./long.md) | Configured memory limit, in bytes, for the indexing requests. Replica requests have an automatic limit that is 1.5x this value. | +| `limit` | [ByteSize](./ByteSize.md) | Configured memory limit for the indexing requests. Replica requests have an automatic limit that is 1.5x this value. | +| `total` | [NodesPressureMemory](./NodesPressureMemory.md) | Contains statistics for the cumulative indexing load since the node started. | diff --git a/docs/reference/api/NodesInfoDeprecationIndexing.md b/docs/reference/api/NodesInfoDeprecationIndexing.md new file mode 100644 index 000000000..ca0c563e5 --- /dev/null +++ b/docs/reference/api/NodesInfoDeprecationIndexing.md @@ -0,0 +1,5 @@ +## Interface `NodesInfoDeprecationIndexing` + +| Name | Type | Description | +| - | - | - | +| `enabled` | boolean | string |   | diff --git a/docs/reference/api/NodesInfoNodeInfo.md b/docs/reference/api/NodesInfoNodeInfo.md new file mode 100644 index 000000000..900dc9829 --- /dev/null +++ b/docs/reference/api/NodesInfoNodeInfo.md @@ -0,0 +1,28 @@ +## Interface `NodesInfoNodeInfo` + +| Name | Type | Description | +| - | - | - | +| `aggregations` | Record |   | +| `attributes` | Record |   | +| `build_flavor` | string |   | +| `build_hash` | string | Short hash of the last git commit in this release. | +| `build_type` | string |   | +| `host` | [Host](./Host.md) | The node’s host name. | +| `http` | [NodesInfoNodeInfoHttp](./NodesInfoNodeInfoHttp.md) |   | +| `ingest` | [NodesInfoNodeInfoIngest](./NodesInfoNodeInfoIngest.md) |   | +| `ip` | [Ip](./Ip.md) | The node’s IP address. | +| `jvm` | [NodesInfoNodeJvmInfo](./NodesInfoNodeJvmInfo.md) |   | +| `modules` | [PluginStats](./PluginStats.md)[] |   | +| `name` | [Name](./Name.md) | The node's name | +| `network` | [NodesInfoNodeInfoNetwork](./NodesInfoNodeInfoNetwork.md) |   | +| `os` | [NodesInfoNodeOperatingSystemInfo](./NodesInfoNodeOperatingSystemInfo.md) |   | +| `plugins` | [PluginStats](./PluginStats.md)[] |   | +| `process` | [NodesInfoNodeProcessInfo](./NodesInfoNodeProcessInfo.md) |   | +| `roles` | [NodeRoles](./NodeRoles.md) |   | +| `settings` | [NodesInfoNodeInfoSettings](./NodesInfoNodeInfoSettings.md) |   | +| `thread_pool` | Record |   | +| `total_indexing_buffer_in_bytes` | [ByteSize](./ByteSize.md) | Same as total_indexing_buffer, but expressed in bytes. | +| `total_indexing_buffer` | [long](./long.md) | Total heap allowed to be used to hold recently indexed documents before they must be written to disk. This size is a shared pool across all shards on this node, and is controlled by Indexing Buffer settings. | +| `transport_address` | [TransportAddress](./TransportAddress.md) | Host and port where transport HTTP connections are accepted. | +| `transport` | [NodesInfoNodeInfoTransport](./NodesInfoNodeInfoTransport.md) |   | +| `version` | [VersionString](./VersionString.md) | Elasticsearch version running on this node. | diff --git a/docs/reference/api/NodesInfoNodeInfoAction.md b/docs/reference/api/NodesInfoNodeInfoAction.md new file mode 100644 index 000000000..6dfcf50c3 --- /dev/null +++ b/docs/reference/api/NodesInfoNodeInfoAction.md @@ -0,0 +1,5 @@ +## Interface `NodesInfoNodeInfoAction` + +| Name | Type | Description | +| - | - | - | +| `destructive_requires_name` | string |   | diff --git a/docs/reference/api/NodesInfoNodeInfoAggregation.md b/docs/reference/api/NodesInfoNodeInfoAggregation.md new file mode 100644 index 000000000..be45ff4c3 --- /dev/null +++ b/docs/reference/api/NodesInfoNodeInfoAggregation.md @@ -0,0 +1,5 @@ +## Interface `NodesInfoNodeInfoAggregation` + +| Name | Type | Description | +| - | - | - | +| `types` | string[] |   | diff --git a/docs/reference/api/NodesInfoNodeInfoBootstrap.md b/docs/reference/api/NodesInfoNodeInfoBootstrap.md new file mode 100644 index 000000000..74373b6bf --- /dev/null +++ b/docs/reference/api/NodesInfoNodeInfoBootstrap.md @@ -0,0 +1,5 @@ +## Interface `NodesInfoNodeInfoBootstrap` + +| Name | Type | Description | +| - | - | - | +| `memory_lock` | string |   | diff --git a/docs/reference/api/NodesInfoNodeInfoClient.md b/docs/reference/api/NodesInfoNodeInfoClient.md new file mode 100644 index 000000000..ee128826d --- /dev/null +++ b/docs/reference/api/NodesInfoNodeInfoClient.md @@ -0,0 +1,5 @@ +## Interface `NodesInfoNodeInfoClient` + +| Name | Type | Description | +| - | - | - | +| `type` | string |   | diff --git a/docs/reference/api/NodesInfoNodeInfoDiscover.md b/docs/reference/api/NodesInfoNodeInfoDiscover.md new file mode 100644 index 000000000..eb25b42aa --- /dev/null +++ b/docs/reference/api/NodesInfoNodeInfoDiscover.md @@ -0,0 +1,4 @@ +## `NodesInfoNodeInfoDiscover` +::: +type NodesInfoNodeInfoDiscover = [NodesInfoNodeInfoDiscoverKeys](./NodesInfoNodeInfoDiscoverKeys.md) & { [property: string]: any;}; +::: diff --git a/docs/reference/api/NodesInfoNodeInfoDiscoverKeys.md b/docs/reference/api/NodesInfoNodeInfoDiscoverKeys.md new file mode 100644 index 000000000..c390506d4 --- /dev/null +++ b/docs/reference/api/NodesInfoNodeInfoDiscoverKeys.md @@ -0,0 +1,7 @@ +## Interface `NodesInfoNodeInfoDiscoverKeys` + +| Name | Type | Description | +| - | - | - | +| `seed_hosts` | string[] |   | +| `seed_providers` | string[] |   | +| `type` | string |   | diff --git a/docs/reference/api/NodesInfoNodeInfoHttp.md b/docs/reference/api/NodesInfoNodeInfoHttp.md new file mode 100644 index 000000000..54f048686 --- /dev/null +++ b/docs/reference/api/NodesInfoNodeInfoHttp.md @@ -0,0 +1,8 @@ +## Interface `NodesInfoNodeInfoHttp` + +| Name | Type | Description | +| - | - | - | +| `bound_address` | string[] |   | +| `max_content_length_in_bytes` | [long](./long.md) |   | +| `max_content_length` | [ByteSize](./ByteSize.md) |   | +| `publish_address` | string |   | diff --git a/docs/reference/api/NodesInfoNodeInfoIngest.md b/docs/reference/api/NodesInfoNodeInfoIngest.md new file mode 100644 index 000000000..6f5c3871d --- /dev/null +++ b/docs/reference/api/NodesInfoNodeInfoIngest.md @@ -0,0 +1,5 @@ +## Interface `NodesInfoNodeInfoIngest` + +| Name | Type | Description | +| - | - | - | +| `processors` | [NodesInfoNodeInfoIngestProcessor](./NodesInfoNodeInfoIngestProcessor.md)[] |   | diff --git a/docs/reference/api/NodesInfoNodeInfoIngestDownloader.md b/docs/reference/api/NodesInfoNodeInfoIngestDownloader.md new file mode 100644 index 000000000..24ae7d605 --- /dev/null +++ b/docs/reference/api/NodesInfoNodeInfoIngestDownloader.md @@ -0,0 +1,5 @@ +## Interface `NodesInfoNodeInfoIngestDownloader` + +| Name | Type | Description | +| - | - | - | +| `enabled` | string |   | diff --git a/docs/reference/api/NodesInfoNodeInfoIngestInfo.md b/docs/reference/api/NodesInfoNodeInfoIngestInfo.md new file mode 100644 index 000000000..d8a649f4b --- /dev/null +++ b/docs/reference/api/NodesInfoNodeInfoIngestInfo.md @@ -0,0 +1,5 @@ +## Interface `NodesInfoNodeInfoIngestInfo` + +| Name | Type | Description | +| - | - | - | +| `downloader` | [NodesInfoNodeInfoIngestDownloader](./NodesInfoNodeInfoIngestDownloader.md) |   | diff --git a/docs/reference/api/NodesInfoNodeInfoIngestProcessor.md b/docs/reference/api/NodesInfoNodeInfoIngestProcessor.md new file mode 100644 index 000000000..ad1e2cc7e --- /dev/null +++ b/docs/reference/api/NodesInfoNodeInfoIngestProcessor.md @@ -0,0 +1,5 @@ +## Interface `NodesInfoNodeInfoIngestProcessor` + +| Name | Type | Description | +| - | - | - | +| `type` | string |   | diff --git a/docs/reference/api/NodesInfoNodeInfoJvmMemory.md b/docs/reference/api/NodesInfoNodeInfoJvmMemory.md new file mode 100644 index 000000000..b2df1cd9f --- /dev/null +++ b/docs/reference/api/NodesInfoNodeInfoJvmMemory.md @@ -0,0 +1,14 @@ +## Interface `NodesInfoNodeInfoJvmMemory` + +| Name | Type | Description | +| - | - | - | +| `direct_max_in_bytes` | [long](./long.md) |   | +| `direct_max` | [ByteSize](./ByteSize.md) |   | +| `heap_init_in_bytes` | [long](./long.md) |   | +| `heap_init` | [ByteSize](./ByteSize.md) |   | +| `heap_max_in_bytes` | [long](./long.md) |   | +| `heap_max` | [ByteSize](./ByteSize.md) |   | +| `non_heap_init_in_bytes` | [long](./long.md) |   | +| `non_heap_init` | [ByteSize](./ByteSize.md) |   | +| `non_heap_max_in_bytes` | [long](./long.md) |   | +| `non_heap_max` | [ByteSize](./ByteSize.md) |   | diff --git a/docs/reference/api/NodesInfoNodeInfoMemory.md b/docs/reference/api/NodesInfoNodeInfoMemory.md new file mode 100644 index 000000000..14d7b8603 --- /dev/null +++ b/docs/reference/api/NodesInfoNodeInfoMemory.md @@ -0,0 +1,6 @@ +## Interface `NodesInfoNodeInfoMemory` + +| Name | Type | Description | +| - | - | - | +| `total_in_bytes` | [long](./long.md) |   | +| `total` | string |   | diff --git a/docs/reference/api/NodesInfoNodeInfoNetwork.md b/docs/reference/api/NodesInfoNodeInfoNetwork.md new file mode 100644 index 000000000..e3710a398 --- /dev/null +++ b/docs/reference/api/NodesInfoNodeInfoNetwork.md @@ -0,0 +1,6 @@ +## Interface `NodesInfoNodeInfoNetwork` + +| Name | Type | Description | +| - | - | - | +| `primary_interface` | [NodesInfoNodeInfoNetworkInterface](./NodesInfoNodeInfoNetworkInterface.md) |   | +| `refresh_interval` | [integer](./integer.md) |   | diff --git a/docs/reference/api/NodesInfoNodeInfoNetworkInterface.md b/docs/reference/api/NodesInfoNodeInfoNetworkInterface.md new file mode 100644 index 000000000..7b3521632 --- /dev/null +++ b/docs/reference/api/NodesInfoNodeInfoNetworkInterface.md @@ -0,0 +1,7 @@ +## Interface `NodesInfoNodeInfoNetworkInterface` + +| Name | Type | Description | +| - | - | - | +| `address` | string |   | +| `mac_address` | string |   | +| `name` | [Name](./Name.md) |   | diff --git a/docs/reference/api/NodesInfoNodeInfoOSCPU.md b/docs/reference/api/NodesInfoNodeInfoOSCPU.md new file mode 100644 index 000000000..f129eddd4 --- /dev/null +++ b/docs/reference/api/NodesInfoNodeInfoOSCPU.md @@ -0,0 +1,12 @@ +## Interface `NodesInfoNodeInfoOSCPU` + +| Name | Type | Description | +| - | - | - | +| `cache_size_in_bytes` | [integer](./integer.md) |   | +| `cache_size` | string |   | +| `cores_per_socket` | [integer](./integer.md) |   | +| `mhz` | [integer](./integer.md) |   | +| `model` | string |   | +| `total_cores` | [integer](./integer.md) |   | +| `total_sockets` | [integer](./integer.md) |   | +| `vendor` | string |   | diff --git a/docs/reference/api/NodesInfoNodeInfoPath.md b/docs/reference/api/NodesInfoNodeInfoPath.md new file mode 100644 index 000000000..697e5cd20 --- /dev/null +++ b/docs/reference/api/NodesInfoNodeInfoPath.md @@ -0,0 +1,8 @@ +## Interface `NodesInfoNodeInfoPath` + +| Name | Type | Description | +| - | - | - | +| `data` | string | string[] |   | +| `home` | string |   | +| `logs` | string |   | +| `repo` | string[] |   | diff --git a/docs/reference/api/NodesInfoNodeInfoRepositories.md b/docs/reference/api/NodesInfoNodeInfoRepositories.md new file mode 100644 index 000000000..7c0714ef1 --- /dev/null +++ b/docs/reference/api/NodesInfoNodeInfoRepositories.md @@ -0,0 +1,5 @@ +## Interface `NodesInfoNodeInfoRepositories` + +| Name | Type | Description | +| - | - | - | +| `url` | [NodesInfoNodeInfoRepositoriesUrl](./NodesInfoNodeInfoRepositoriesUrl.md) |   | diff --git a/docs/reference/api/NodesInfoNodeInfoRepositoriesUrl.md b/docs/reference/api/NodesInfoNodeInfoRepositoriesUrl.md new file mode 100644 index 000000000..ece387e95 --- /dev/null +++ b/docs/reference/api/NodesInfoNodeInfoRepositoriesUrl.md @@ -0,0 +1,5 @@ +## Interface `NodesInfoNodeInfoRepositoriesUrl` + +| Name | Type | Description | +| - | - | - | +| `allowed_urls` | string |   | diff --git a/docs/reference/api/NodesInfoNodeInfoScript.md b/docs/reference/api/NodesInfoNodeInfoScript.md new file mode 100644 index 000000000..70fc99ade --- /dev/null +++ b/docs/reference/api/NodesInfoNodeInfoScript.md @@ -0,0 +1,6 @@ +## Interface `NodesInfoNodeInfoScript` + +| Name | Type | Description | +| - | - | - | +| `allowed_types` | string |   | +| `disable_max_compilations_rate` | string |   | diff --git a/docs/reference/api/NodesInfoNodeInfoSearch.md b/docs/reference/api/NodesInfoNodeInfoSearch.md new file mode 100644 index 000000000..ae2c574c8 --- /dev/null +++ b/docs/reference/api/NodesInfoNodeInfoSearch.md @@ -0,0 +1,5 @@ +## Interface `NodesInfoNodeInfoSearch` + +| Name | Type | Description | +| - | - | - | +| `remote` | [NodesInfoNodeInfoSearchRemote](./NodesInfoNodeInfoSearchRemote.md) |   | diff --git a/docs/reference/api/NodesInfoNodeInfoSearchRemote.md b/docs/reference/api/NodesInfoNodeInfoSearchRemote.md new file mode 100644 index 000000000..977bfb98f --- /dev/null +++ b/docs/reference/api/NodesInfoNodeInfoSearchRemote.md @@ -0,0 +1,5 @@ +## Interface `NodesInfoNodeInfoSearchRemote` + +| Name | Type | Description | +| - | - | - | +| `connect` | string |   | diff --git a/docs/reference/api/NodesInfoNodeInfoSettings.md b/docs/reference/api/NodesInfoNodeInfoSettings.md new file mode 100644 index 000000000..107ac93dd --- /dev/null +++ b/docs/reference/api/NodesInfoNodeInfoSettings.md @@ -0,0 +1,19 @@ +## Interface `NodesInfoNodeInfoSettings` + +| Name | Type | Description | +| - | - | - | +| `action` | [NodesInfoNodeInfoAction](./NodesInfoNodeInfoAction.md) |   | +| `bootstrap` | [NodesInfoNodeInfoBootstrap](./NodesInfoNodeInfoBootstrap.md) |   | +| `client` | [NodesInfoNodeInfoClient](./NodesInfoNodeInfoClient.md) |   | +| `cluster` | [NodesInfoNodeInfoSettingsCluster](./NodesInfoNodeInfoSettingsCluster.md) |   | +| `discovery` | [NodesInfoNodeInfoDiscover](./NodesInfoNodeInfoDiscover.md) |   | +| `http` | [NodesInfoNodeInfoSettingsHttp](./NodesInfoNodeInfoSettingsHttp.md) |   | +| `ingest` | [NodesInfoNodeInfoSettingsIngest](./NodesInfoNodeInfoSettingsIngest.md) |   | +| `network` | [NodesInfoNodeInfoSettingsNetwork](./NodesInfoNodeInfoSettingsNetwork.md) |   | +| `node` | [NodesInfoNodeInfoSettingsNode](./NodesInfoNodeInfoSettingsNode.md) |   | +| `path` | [NodesInfoNodeInfoPath](./NodesInfoNodeInfoPath.md) |   | +| `repositories` | [NodesInfoNodeInfoRepositories](./NodesInfoNodeInfoRepositories.md) |   | +| `script` | [NodesInfoNodeInfoScript](./NodesInfoNodeInfoScript.md) |   | +| `search` | [NodesInfoNodeInfoSearch](./NodesInfoNodeInfoSearch.md) |   | +| `transport` | [NodesInfoNodeInfoSettingsTransport](./NodesInfoNodeInfoSettingsTransport.md) |   | +| `xpack` | [NodesInfoNodeInfoXpack](./NodesInfoNodeInfoXpack.md) |   | diff --git a/docs/reference/api/NodesInfoNodeInfoSettingsCluster.md b/docs/reference/api/NodesInfoNodeInfoSettingsCluster.md new file mode 100644 index 000000000..9ae408f42 --- /dev/null +++ b/docs/reference/api/NodesInfoNodeInfoSettingsCluster.md @@ -0,0 +1,9 @@ +## Interface `NodesInfoNodeInfoSettingsCluster` + +| Name | Type | Description | +| - | - | - | +| `deprecation_indexing` | [NodesInfoDeprecationIndexing](./NodesInfoDeprecationIndexing.md) |   | +| `election` | [NodesInfoNodeInfoSettingsClusterElection](./NodesInfoNodeInfoSettingsClusterElection.md) |   | +| `initial_master_nodes` | string[] |   | +| `name` | [Name](./Name.md) |   | +| `routing` | [IndicesIndexRouting](./IndicesIndexRouting.md) |   | diff --git a/docs/reference/api/NodesInfoNodeInfoSettingsClusterElection.md b/docs/reference/api/NodesInfoNodeInfoSettingsClusterElection.md new file mode 100644 index 000000000..56baa4424 --- /dev/null +++ b/docs/reference/api/NodesInfoNodeInfoSettingsClusterElection.md @@ -0,0 +1,5 @@ +## Interface `NodesInfoNodeInfoSettingsClusterElection` + +| Name | Type | Description | +| - | - | - | +| `strategy` | [Name](./Name.md) |   | diff --git a/docs/reference/api/NodesInfoNodeInfoSettingsHttp.md b/docs/reference/api/NodesInfoNodeInfoSettingsHttp.md new file mode 100644 index 000000000..a7b941d9c --- /dev/null +++ b/docs/reference/api/NodesInfoNodeInfoSettingsHttp.md @@ -0,0 +1,8 @@ +## Interface `NodesInfoNodeInfoSettingsHttp` + +| Name | Type | Description | +| - | - | - | +| `"type.default"` | string |   | +| `compression` | boolean | string |   | +| `port` | [integer](./integer.md) | string |   | +| `type` | [NodesInfoNodeInfoSettingsHttpType](./NodesInfoNodeInfoSettingsHttpType.md) | string |   | diff --git a/docs/reference/api/NodesInfoNodeInfoSettingsHttpType.md b/docs/reference/api/NodesInfoNodeInfoSettingsHttpType.md new file mode 100644 index 000000000..a641bf5b3 --- /dev/null +++ b/docs/reference/api/NodesInfoNodeInfoSettingsHttpType.md @@ -0,0 +1,5 @@ +## Interface `NodesInfoNodeInfoSettingsHttpType` + +| Name | Type | Description | +| - | - | - | +| `default` | string |   | diff --git a/docs/reference/api/NodesInfoNodeInfoSettingsIngest.md b/docs/reference/api/NodesInfoNodeInfoSettingsIngest.md new file mode 100644 index 000000000..8ddec0573 --- /dev/null +++ b/docs/reference/api/NodesInfoNodeInfoSettingsIngest.md @@ -0,0 +1,38 @@ +## Interface `NodesInfoNodeInfoSettingsIngest` + +| Name | Type | Description | +| - | - | - | +| `append` | [NodesInfoNodeInfoIngestInfo](./NodesInfoNodeInfoIngestInfo.md) |   | +| `attachment` | [NodesInfoNodeInfoIngestInfo](./NodesInfoNodeInfoIngestInfo.md) |   | +| `bytes` | [NodesInfoNodeInfoIngestInfo](./NodesInfoNodeInfoIngestInfo.md) |   | +| `circle` | [NodesInfoNodeInfoIngestInfo](./NodesInfoNodeInfoIngestInfo.md) |   | +| `convert` | [NodesInfoNodeInfoIngestInfo](./NodesInfoNodeInfoIngestInfo.md) |   | +| `csv` | [NodesInfoNodeInfoIngestInfo](./NodesInfoNodeInfoIngestInfo.md) |   | +| `date_index_name` | [NodesInfoNodeInfoIngestInfo](./NodesInfoNodeInfoIngestInfo.md) |   | +| `date` | [NodesInfoNodeInfoIngestInfo](./NodesInfoNodeInfoIngestInfo.md) |   | +| `dissect` | [NodesInfoNodeInfoIngestInfo](./NodesInfoNodeInfoIngestInfo.md) |   | +| `dot_expander` | [NodesInfoNodeInfoIngestInfo](./NodesInfoNodeInfoIngestInfo.md) |   | +| `drop` | [NodesInfoNodeInfoIngestInfo](./NodesInfoNodeInfoIngestInfo.md) |   | +| `enrich` | [NodesInfoNodeInfoIngestInfo](./NodesInfoNodeInfoIngestInfo.md) |   | +| `fail` | [NodesInfoNodeInfoIngestInfo](./NodesInfoNodeInfoIngestInfo.md) |   | +| `foreach` | [NodesInfoNodeInfoIngestInfo](./NodesInfoNodeInfoIngestInfo.md) |   | +| `geoip` | [NodesInfoNodeInfoIngestInfo](./NodesInfoNodeInfoIngestInfo.md) |   | +| `grok` | [NodesInfoNodeInfoIngestInfo](./NodesInfoNodeInfoIngestInfo.md) |   | +| `gsub` | [NodesInfoNodeInfoIngestInfo](./NodesInfoNodeInfoIngestInfo.md) |   | +| `inference` | [NodesInfoNodeInfoIngestInfo](./NodesInfoNodeInfoIngestInfo.md) |   | +| `join` | [NodesInfoNodeInfoIngestInfo](./NodesInfoNodeInfoIngestInfo.md) |   | +| `json` | [NodesInfoNodeInfoIngestInfo](./NodesInfoNodeInfoIngestInfo.md) |   | +| `kv` | [NodesInfoNodeInfoIngestInfo](./NodesInfoNodeInfoIngestInfo.md) |   | +| `lowercase` | [NodesInfoNodeInfoIngestInfo](./NodesInfoNodeInfoIngestInfo.md) |   | +| `pipeline` | [NodesInfoNodeInfoIngestInfo](./NodesInfoNodeInfoIngestInfo.md) |   | +| `remove` | [NodesInfoNodeInfoIngestInfo](./NodesInfoNodeInfoIngestInfo.md) |   | +| `rename` | [NodesInfoNodeInfoIngestInfo](./NodesInfoNodeInfoIngestInfo.md) |   | +| `script` | [NodesInfoNodeInfoIngestInfo](./NodesInfoNodeInfoIngestInfo.md) |   | +| `set_security_user` | [NodesInfoNodeInfoIngestInfo](./NodesInfoNodeInfoIngestInfo.md) |   | +| `set` | [NodesInfoNodeInfoIngestInfo](./NodesInfoNodeInfoIngestInfo.md) |   | +| `sort` | [NodesInfoNodeInfoIngestInfo](./NodesInfoNodeInfoIngestInfo.md) |   | +| `split` | [NodesInfoNodeInfoIngestInfo](./NodesInfoNodeInfoIngestInfo.md) |   | +| `trim` | [NodesInfoNodeInfoIngestInfo](./NodesInfoNodeInfoIngestInfo.md) |   | +| `uppercase` | [NodesInfoNodeInfoIngestInfo](./NodesInfoNodeInfoIngestInfo.md) |   | +| `urldecode` | [NodesInfoNodeInfoIngestInfo](./NodesInfoNodeInfoIngestInfo.md) |   | +| `user_agent` | [NodesInfoNodeInfoIngestInfo](./NodesInfoNodeInfoIngestInfo.md) |   | diff --git a/docs/reference/api/NodesInfoNodeInfoSettingsNetwork.md b/docs/reference/api/NodesInfoNodeInfoSettingsNetwork.md new file mode 100644 index 000000000..341b09841 --- /dev/null +++ b/docs/reference/api/NodesInfoNodeInfoSettingsNetwork.md @@ -0,0 +1,5 @@ +## Interface `NodesInfoNodeInfoSettingsNetwork` + +| Name | Type | Description | +| - | - | - | +| `host` | [Host](./Host.md) | [Host](./Host.md)[] |   | diff --git a/docs/reference/api/NodesInfoNodeInfoSettingsNode.md b/docs/reference/api/NodesInfoNodeInfoSettingsNode.md new file mode 100644 index 000000000..c8c89348e --- /dev/null +++ b/docs/reference/api/NodesInfoNodeInfoSettingsNode.md @@ -0,0 +1,7 @@ +## Interface `NodesInfoNodeInfoSettingsNode` + +| Name | Type | Description | +| - | - | - | +| `attr` | Record |   | +| `max_local_storage_nodes` | string |   | +| `name` | [Name](./Name.md) |   | diff --git a/docs/reference/api/NodesInfoNodeInfoSettingsTransport.md b/docs/reference/api/NodesInfoNodeInfoSettingsTransport.md new file mode 100644 index 000000000..3bd3b84e9 --- /dev/null +++ b/docs/reference/api/NodesInfoNodeInfoSettingsTransport.md @@ -0,0 +1,7 @@ +## Interface `NodesInfoNodeInfoSettingsTransport` + +| Name | Type | Description | +| - | - | - | +| `"type.default"` | string |   | +| `features` | [NodesInfoNodeInfoSettingsTransportFeatures](./NodesInfoNodeInfoSettingsTransportFeatures.md) |   | +| `type` | [NodesInfoNodeInfoSettingsTransportType](./NodesInfoNodeInfoSettingsTransportType.md) | string |   | diff --git a/docs/reference/api/NodesInfoNodeInfoSettingsTransportFeatures.md b/docs/reference/api/NodesInfoNodeInfoSettingsTransportFeatures.md new file mode 100644 index 000000000..2ec4c48e7 --- /dev/null +++ b/docs/reference/api/NodesInfoNodeInfoSettingsTransportFeatures.md @@ -0,0 +1,5 @@ +## Interface `NodesInfoNodeInfoSettingsTransportFeatures` + +| Name | Type | Description | +| - | - | - | +| `"x-pack"` | string |   | diff --git a/docs/reference/api/NodesInfoNodeInfoSettingsTransportType.md b/docs/reference/api/NodesInfoNodeInfoSettingsTransportType.md new file mode 100644 index 000000000..c60a52da0 --- /dev/null +++ b/docs/reference/api/NodesInfoNodeInfoSettingsTransportType.md @@ -0,0 +1,5 @@ +## Interface `NodesInfoNodeInfoSettingsTransportType` + +| Name | Type | Description | +| - | - | - | +| `default` | string |   | diff --git a/docs/reference/api/NodesInfoNodeInfoTransport.md b/docs/reference/api/NodesInfoNodeInfoTransport.md new file mode 100644 index 000000000..cca58fc43 --- /dev/null +++ b/docs/reference/api/NodesInfoNodeInfoTransport.md @@ -0,0 +1,7 @@ +## Interface `NodesInfoNodeInfoTransport` + +| Name | Type | Description | +| - | - | - | +| `bound_address` | string[] |   | +| `profiles` | Record |   | +| `publish_address` | string |   | diff --git a/docs/reference/api/NodesInfoNodeInfoXpack.md b/docs/reference/api/NodesInfoNodeInfoXpack.md new file mode 100644 index 000000000..a536ab0d9 --- /dev/null +++ b/docs/reference/api/NodesInfoNodeInfoXpack.md @@ -0,0 +1,8 @@ +## Interface `NodesInfoNodeInfoXpack` + +| Name | Type | Description | +| - | - | - | +| `license` | [NodesInfoNodeInfoXpackLicense](./NodesInfoNodeInfoXpackLicense.md) |   | +| `ml` | [NodesInfoNodeInfoXpackMl](./NodesInfoNodeInfoXpackMl.md) |   | +| `notification` | Record |   | +| `security` | [NodesInfoNodeInfoXpackSecurity](./NodesInfoNodeInfoXpackSecurity.md) |   | diff --git a/docs/reference/api/NodesInfoNodeInfoXpackLicense.md b/docs/reference/api/NodesInfoNodeInfoXpackLicense.md new file mode 100644 index 000000000..88fac4507 --- /dev/null +++ b/docs/reference/api/NodesInfoNodeInfoXpackLicense.md @@ -0,0 +1,5 @@ +## Interface `NodesInfoNodeInfoXpackLicense` + +| Name | Type | Description | +| - | - | - | +| `self_generated` | [NodesInfoNodeInfoXpackLicenseType](./NodesInfoNodeInfoXpackLicenseType.md) |   | diff --git a/docs/reference/api/NodesInfoNodeInfoXpackLicenseType.md b/docs/reference/api/NodesInfoNodeInfoXpackLicenseType.md new file mode 100644 index 000000000..c923c611d --- /dev/null +++ b/docs/reference/api/NodesInfoNodeInfoXpackLicenseType.md @@ -0,0 +1,5 @@ +## Interface `NodesInfoNodeInfoXpackLicenseType` + +| Name | Type | Description | +| - | - | - | +| `type` | string |   | diff --git a/docs/reference/api/NodesInfoNodeInfoXpackMl.md b/docs/reference/api/NodesInfoNodeInfoXpackMl.md new file mode 100644 index 000000000..39b90c5ed --- /dev/null +++ b/docs/reference/api/NodesInfoNodeInfoXpackMl.md @@ -0,0 +1,5 @@ +## Interface `NodesInfoNodeInfoXpackMl` + +| Name | Type | Description | +| - | - | - | +| `use_auto_machine_memory_percent` | boolean |   | diff --git a/docs/reference/api/NodesInfoNodeInfoXpackSecurity.md b/docs/reference/api/NodesInfoNodeInfoXpackSecurity.md new file mode 100644 index 000000000..25c728b20 --- /dev/null +++ b/docs/reference/api/NodesInfoNodeInfoXpackSecurity.md @@ -0,0 +1,8 @@ +## Interface `NodesInfoNodeInfoXpackSecurity` + +| Name | Type | Description | +| - | - | - | +| `authc` | [NodesInfoNodeInfoXpackSecurityAuthc](./NodesInfoNodeInfoXpackSecurityAuthc.md) |   | +| `enabled` | string |   | +| `http` | [NodesInfoNodeInfoXpackSecuritySsl](./NodesInfoNodeInfoXpackSecuritySsl.md) |   | +| `transport` | [NodesInfoNodeInfoXpackSecuritySsl](./NodesInfoNodeInfoXpackSecuritySsl.md) |   | diff --git a/docs/reference/api/NodesInfoNodeInfoXpackSecurityAuthc.md b/docs/reference/api/NodesInfoNodeInfoXpackSecurityAuthc.md new file mode 100644 index 000000000..3e29bccb7 --- /dev/null +++ b/docs/reference/api/NodesInfoNodeInfoXpackSecurityAuthc.md @@ -0,0 +1,6 @@ +## Interface `NodesInfoNodeInfoXpackSecurityAuthc` + +| Name | Type | Description | +| - | - | - | +| `realms` | [NodesInfoNodeInfoXpackSecurityAuthcRealms](./NodesInfoNodeInfoXpackSecurityAuthcRealms.md) |   | +| `token` | [NodesInfoNodeInfoXpackSecurityAuthcToken](./NodesInfoNodeInfoXpackSecurityAuthcToken.md) |   | diff --git a/docs/reference/api/NodesInfoNodeInfoXpackSecurityAuthcRealms.md b/docs/reference/api/NodesInfoNodeInfoXpackSecurityAuthcRealms.md new file mode 100644 index 000000000..dabff5ddd --- /dev/null +++ b/docs/reference/api/NodesInfoNodeInfoXpackSecurityAuthcRealms.md @@ -0,0 +1,7 @@ +## Interface `NodesInfoNodeInfoXpackSecurityAuthcRealms` + +| Name | Type | Description | +| - | - | - | +| `file` | Record |   | +| `native` | Record |   | +| `pki` | Record |   | diff --git a/docs/reference/api/NodesInfoNodeInfoXpackSecurityAuthcRealmsStatus.md b/docs/reference/api/NodesInfoNodeInfoXpackSecurityAuthcRealmsStatus.md new file mode 100644 index 000000000..dc4cb5e25 --- /dev/null +++ b/docs/reference/api/NodesInfoNodeInfoXpackSecurityAuthcRealmsStatus.md @@ -0,0 +1,6 @@ +## Interface `NodesInfoNodeInfoXpackSecurityAuthcRealmsStatus` + +| Name | Type | Description | +| - | - | - | +| `enabled` | string |   | +| `order` | string |   | diff --git a/docs/reference/api/NodesInfoNodeInfoXpackSecurityAuthcToken.md b/docs/reference/api/NodesInfoNodeInfoXpackSecurityAuthcToken.md new file mode 100644 index 000000000..2dc45d5c0 --- /dev/null +++ b/docs/reference/api/NodesInfoNodeInfoXpackSecurityAuthcToken.md @@ -0,0 +1,5 @@ +## Interface `NodesInfoNodeInfoXpackSecurityAuthcToken` + +| Name | Type | Description | +| - | - | - | +| `enabled` | string |   | diff --git a/docs/reference/api/NodesInfoNodeInfoXpackSecuritySsl.md b/docs/reference/api/NodesInfoNodeInfoXpackSecuritySsl.md new file mode 100644 index 000000000..3204c6956 --- /dev/null +++ b/docs/reference/api/NodesInfoNodeInfoXpackSecuritySsl.md @@ -0,0 +1,5 @@ +## Interface `NodesInfoNodeInfoXpackSecuritySsl` + +| Name | Type | Description | +| - | - | - | +| `ssl` | Record |   | diff --git a/docs/reference/api/NodesInfoNodeJvmInfo.md b/docs/reference/api/NodesInfoNodeJvmInfo.md new file mode 100644 index 000000000..258bda44f --- /dev/null +++ b/docs/reference/api/NodesInfoNodeJvmInfo.md @@ -0,0 +1,17 @@ +## Interface `NodesInfoNodeJvmInfo` + +| Name | Type | Description | +| - | - | - | +| `bundled_jdk` | boolean | using_bundled_jdk | +| `gc_collectors` | string[] |   | +| `input_arguments` | string[] |   | +| `mem` | [NodesInfoNodeInfoJvmMemory](./NodesInfoNodeInfoJvmMemory.md) |   | +| `memory_pools` | string[] |   | +| `pid` | [integer](./integer.md) |   | +| `start_time_in_millis` | [EpochTime](./EpochTime.md)<[UnitMillis](./UnitMillis.md)> |   | +| `using_bundled_jdk` | boolean |   | +| `using_compressed_ordinary_object_pointers` | boolean | string |   | +| `version` | [VersionString](./VersionString.md) |   | +| `vm_name` | [Name](./Name.md) |   | +| `vm_vendor` | string |   | +| `vm_version` | [VersionString](./VersionString.md) |   | diff --git a/docs/reference/api/NodesInfoNodeOperatingSystemInfo.md b/docs/reference/api/NodesInfoNodeOperatingSystemInfo.md new file mode 100644 index 000000000..cfaf16c90 --- /dev/null +++ b/docs/reference/api/NodesInfoNodeOperatingSystemInfo.md @@ -0,0 +1,14 @@ +## Interface `NodesInfoNodeOperatingSystemInfo` + +| Name | Type | Description | +| - | - | - | +| `allocated_processors` | [integer](./integer.md) | The number of processors actually used to calculate thread pool size. This number can be set with the node.processors setting of a node and defaults to the number of processors reported by the OS. | +| `arch` | string | Name of the JVM architecture (ex: amd64, x86) | +| `available_processors` | [integer](./integer.md) | Number of processors available to the Java virtual machine | +| `cpu` | [NodesInfoNodeInfoOSCPU](./NodesInfoNodeInfoOSCPU.md) |   | +| `mem` | [NodesInfoNodeInfoMemory](./NodesInfoNodeInfoMemory.md) |   | +| `name` | [Name](./Name.md) | Name of the operating system (ex: Linux, Windows, Mac OS X) | +| `pretty_name` | [Name](./Name.md) |   | +| `refresh_interval_in_millis` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> | Refresh interval for the OS statistics | +| `swap` | [NodesInfoNodeInfoMemory](./NodesInfoNodeInfoMemory.md) |   | +| `version` | [VersionString](./VersionString.md) | Version of the operating system | diff --git a/docs/reference/api/NodesInfoNodeProcessInfo.md b/docs/reference/api/NodesInfoNodeProcessInfo.md new file mode 100644 index 000000000..65dc5fde0 --- /dev/null +++ b/docs/reference/api/NodesInfoNodeProcessInfo.md @@ -0,0 +1,7 @@ +## Interface `NodesInfoNodeProcessInfo` + +| Name | Type | Description | +| - | - | - | +| `id` | [long](./long.md) | Process identifier (PID) | +| `mlockall` | boolean | Indicates if the process address space has been successfully locked in memory | +| `refresh_interval_in_millis` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> | Refresh interval for the process statistics | diff --git a/docs/reference/api/NodesInfoNodeThreadPoolInfo.md b/docs/reference/api/NodesInfoNodeThreadPoolInfo.md new file mode 100644 index 000000000..5afed8519 --- /dev/null +++ b/docs/reference/api/NodesInfoNodeThreadPoolInfo.md @@ -0,0 +1,10 @@ +## Interface `NodesInfoNodeThreadPoolInfo` + +| Name | Type | Description | +| - | - | - | +| `core` | [integer](./integer.md) |   | +| `keep_alive` | [Duration](./Duration.md) |   | +| `max` | [integer](./integer.md) |   | +| `queue_size` | [integer](./integer.md) |   | +| `size` | [integer](./integer.md) |   | +| `type` | string |   | diff --git a/docs/reference/api/NodesInfoRequest.md b/docs/reference/api/NodesInfoRequest.md new file mode 100644 index 000000000..872fc8ac1 --- /dev/null +++ b/docs/reference/api/NodesInfoRequest.md @@ -0,0 +1,10 @@ +## Interface `NodesInfoRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { node_id?: never; metric?: never; flat_settings?: never; timeout?: never; }) | All values in `body` will be added to the request body. | +| `flat_settings` | boolean | If true, returns settings in flat format. | +| `metric` | [Metrics](./Metrics.md) | Limits the information returned to the specific metrics. Supports a comma-separated list, such as http,ingest. | +| `node_id` | [NodeIds](./NodeIds.md) | Comma-separated list of node IDs or names used to limit returned information. | +| `querystring` | { [key: string]: any; } & { node_id?: never; metric?: never; flat_settings?: never; timeout?: never; } | All values in `querystring` will be added to the request querystring. | +| `timeout` | [Duration](./Duration.md) | Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. | diff --git a/docs/reference/api/NodesInfoResponse.md b/docs/reference/api/NodesInfoResponse.md new file mode 100644 index 000000000..b8cd4cb22 --- /dev/null +++ b/docs/reference/api/NodesInfoResponse.md @@ -0,0 +1,4 @@ +## `NodesInfoResponse` +::: +type NodesInfoResponse = [NodesInfoResponseBase](./NodesInfoResponseBase.md); +::: diff --git a/docs/reference/api/NodesInfoResponseBase.md b/docs/reference/api/NodesInfoResponseBase.md new file mode 100644 index 000000000..0b3241f7f --- /dev/null +++ b/docs/reference/api/NodesInfoResponseBase.md @@ -0,0 +1,6 @@ +## Interface `NodesInfoResponseBase` + +| Name | Type | Description | +| - | - | - | +| `cluster_name` | [Name](./Name.md) |   | +| `nodes` | Record |   | diff --git a/docs/reference/api/NodesIngest.md b/docs/reference/api/NodesIngest.md new file mode 100644 index 000000000..f32b4d4d0 --- /dev/null +++ b/docs/reference/api/NodesIngest.md @@ -0,0 +1,6 @@ +## Interface `NodesIngest` + +| Name | Type | Description | +| - | - | - | +| `pipelines` | Record | Contains statistics about ingest pipelines for the node. | +| `total` | [NodesIngestTotal](./NodesIngestTotal.md) | Contains statistics about ingest operations for the node. | diff --git a/docs/reference/api/NodesIngestStats.md b/docs/reference/api/NodesIngestStats.md new file mode 100644 index 000000000..59acd5c1b --- /dev/null +++ b/docs/reference/api/NodesIngestStats.md @@ -0,0 +1,11 @@ +## Interface `NodesIngestStats` + +| Name | Type | Description | +| - | - | - | +| `count` | [long](./long.md) | Total number of documents ingested during the lifetime of this node. | +| `current` | [long](./long.md) | Total number of documents currently being ingested. | +| `failed` | [long](./long.md) | Total number of failed ingest operations during the lifetime of this node. | +| `ingested_as_first_pipeline_in_bytes` | [long](./long.md) | Total number of bytes of all documents ingested by the pipeline. This field is only present on pipelines which are the first to process a document. Thus, it is not present on pipelines which only serve as a final pipeline after a default pipeline, a pipeline run after a reroute processor, or pipelines in pipeline processors. | +| `processors` | Record[] | Total number of ingest processors. | +| `produced_as_first_pipeline_in_bytes` | [long](./long.md) | Total number of bytes of all documents produced by the pipeline. This field is only present on pipelines which are the first to process a document. Thus, it is not present on pipelines which only serve as a final pipeline after a default pipeline, a pipeline run after a reroute processor, or pipelines in pipeline processors. In situations where there are subsequent pipelines, the value represents the size of the document after all pipelines have run. | +| `time_in_millis` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> | Total time, in milliseconds, spent preprocessing ingest documents during the lifetime of this node. | diff --git a/docs/reference/api/NodesIngestTotal.md b/docs/reference/api/NodesIngestTotal.md new file mode 100644 index 000000000..9fad514da --- /dev/null +++ b/docs/reference/api/NodesIngestTotal.md @@ -0,0 +1,8 @@ +## Interface `NodesIngestTotal` + +| Name | Type | Description | +| - | - | - | +| `count` | [long](./long.md) | Total number of documents ingested during the lifetime of this node. | +| `current` | [long](./long.md) | Total number of documents currently being ingested. | +| `failed` | [long](./long.md) | Total number of failed ingest operations during the lifetime of this node. | +| `time_in_millis` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> | Total time, in milliseconds, spent preprocessing ingest documents during the lifetime of this node. | diff --git a/docs/reference/api/NodesIoStatDevice.md b/docs/reference/api/NodesIoStatDevice.md new file mode 100644 index 000000000..dfdbd450e --- /dev/null +++ b/docs/reference/api/NodesIoStatDevice.md @@ -0,0 +1,10 @@ +## Interface `NodesIoStatDevice` + +| Name | Type | Description | +| - | - | - | +| `device_name` | string | The Linux device name. | +| `operations` | [long](./long.md) | The total number of read and write operations for the device completed since starting Elasticsearch. | +| `read_kilobytes` | [long](./long.md) | The total number of kilobytes read for the device since starting Elasticsearch. | +| `read_operations` | [long](./long.md) | The total number of read operations for the device completed since starting Elasticsearch. | +| `write_kilobytes` | [long](./long.md) | The total number of kilobytes written for the device since starting Elasticsearch. | +| `write_operations` | [long](./long.md) | The total number of write operations for the device completed since starting Elasticsearch. | diff --git a/docs/reference/api/NodesIoStats.md b/docs/reference/api/NodesIoStats.md new file mode 100644 index 000000000..669c569c4 --- /dev/null +++ b/docs/reference/api/NodesIoStats.md @@ -0,0 +1,6 @@ +## Interface `NodesIoStats` + +| Name | Type | Description | +| - | - | - | +| `devices` | [NodesIoStatDevice](./NodesIoStatDevice.md)[] | Array of disk metrics for each device that is backing an Elasticsearch data path. These disk metrics are probed periodically and averages between the last probe and the current probe are computed. | +| `total` | [NodesIoStatDevice](./NodesIoStatDevice.md) | The sum of the disk metrics for all devices that back an Elasticsearch data path. | diff --git a/docs/reference/api/NodesJvm.md b/docs/reference/api/NodesJvm.md new file mode 100644 index 000000000..c1cd2579a --- /dev/null +++ b/docs/reference/api/NodesJvm.md @@ -0,0 +1,12 @@ +## Interface `NodesJvm` + +| Name | Type | Description | +| - | - | - | +| `buffer_pools` | Record | Contains statistics about JVM buffer pools for the node. | +| `classes` | [NodesJvmClasses](./NodesJvmClasses.md) | Contains statistics about classes loaded by JVM for the node. | +| `gc` | [NodesGarbageCollector](./NodesGarbageCollector.md) | Contains statistics about JVM garbage collectors for the node. | +| `mem` | [NodesJvmMemoryStats](./NodesJvmMemoryStats.md) | Contains JVM memory usage statistics for the node. | +| `threads` | [NodesJvmThreads](./NodesJvmThreads.md) | Contains statistics about JVM thread usage for the node. | +| `timestamp` | [long](./long.md) | Last time JVM statistics were refreshed. | +| `uptime_in_millis` | [long](./long.md) | JVM uptime in milliseconds. | +| `uptime` | string | Human-readable JVM uptime. Only returned if the `human` query parameter is `true`. | diff --git a/docs/reference/api/NodesJvmClasses.md b/docs/reference/api/NodesJvmClasses.md new file mode 100644 index 000000000..8baa897e6 --- /dev/null +++ b/docs/reference/api/NodesJvmClasses.md @@ -0,0 +1,7 @@ +## Interface `NodesJvmClasses` + +| Name | Type | Description | +| - | - | - | +| `current_loaded_count` | [long](./long.md) | Number of classes currently loaded by JVM. | +| `total_loaded_count` | [long](./long.md) | Total number of classes loaded since the JVM started. | +| `total_unloaded_count` | [long](./long.md) | Total number of classes unloaded since the JVM started. | diff --git a/docs/reference/api/NodesJvmMemoryStats.md b/docs/reference/api/NodesJvmMemoryStats.md new file mode 100644 index 000000000..7a73d0759 --- /dev/null +++ b/docs/reference/api/NodesJvmMemoryStats.md @@ -0,0 +1,11 @@ +## Interface `NodesJvmMemoryStats` + +| Name | Type | Description | +| - | - | - | +| `heap_committed_in_bytes` | [long](./long.md) | Amount of memory, in bytes, available for use by the heap. | +| `heap_max_in_bytes` | [long](./long.md) | Maximum amount of memory, in bytes, available for use by the heap. | +| `heap_used_in_bytes` | [long](./long.md) | Memory, in bytes, currently in use by the heap. | +| `heap_used_percent` | [long](./long.md) | Percentage of memory currently in use by the heap. | +| `non_heap_committed_in_bytes` | [long](./long.md) | Amount of non-heap memory available, in bytes. | +| `non_heap_used_in_bytes` | [long](./long.md) | Non-heap memory used, in bytes. | +| `pools` | Record | Contains statistics about heap memory usage for the node. | diff --git a/docs/reference/api/NodesJvmThreads.md b/docs/reference/api/NodesJvmThreads.md new file mode 100644 index 000000000..432751ba3 --- /dev/null +++ b/docs/reference/api/NodesJvmThreads.md @@ -0,0 +1,6 @@ +## Interface `NodesJvmThreads` + +| Name | Type | Description | +| - | - | - | +| `count` | [long](./long.md) | Number of active threads in use by JVM. | +| `peak_count` | [long](./long.md) | Highest number of threads used by JVM. | diff --git a/docs/reference/api/NodesKeyedProcessor.md b/docs/reference/api/NodesKeyedProcessor.md new file mode 100644 index 000000000..c6bd94492 --- /dev/null +++ b/docs/reference/api/NodesKeyedProcessor.md @@ -0,0 +1,6 @@ +## Interface `NodesKeyedProcessor` + +| Name | Type | Description | +| - | - | - | +| `stats` | [NodesProcessor](./NodesProcessor.md) |   | +| `type` | string |   | diff --git a/docs/reference/api/NodesMemoryStats.md b/docs/reference/api/NodesMemoryStats.md new file mode 100644 index 000000000..c4736d398 --- /dev/null +++ b/docs/reference/api/NodesMemoryStats.md @@ -0,0 +1,14 @@ +## Interface `NodesMemoryStats` + +| Name | Type | Description | +| - | - | - | +| `adjusted_total_in_bytes` | [long](./long.md) | If the amount of physical memory has been overridden using the `es`. `total_memory_bytes` system property then this reports the overridden value in bytes. Otherwise it reports the same value as `total_in_bytes`. | +| `free_in_bytes` | [long](./long.md) | Amount of free physical memory in bytes. | +| `resident_in_bytes` | [long](./long.md) |   | +| `resident` | string |   | +| `share_in_bytes` | [long](./long.md) |   | +| `share` | string |   | +| `total_in_bytes` | [long](./long.md) | Total amount of physical memory in bytes. | +| `total_virtual_in_bytes` | [long](./long.md) |   | +| `total_virtual` | string |   | +| `used_in_bytes` | [long](./long.md) | Amount of used physical memory in bytes. | diff --git a/docs/reference/api/NodesNodeBufferPool.md b/docs/reference/api/NodesNodeBufferPool.md new file mode 100644 index 000000000..9941a07ee --- /dev/null +++ b/docs/reference/api/NodesNodeBufferPool.md @@ -0,0 +1,9 @@ +## Interface `NodesNodeBufferPool` + +| Name | Type | Description | +| - | - | - | +| `count` | [long](./long.md) | Number of buffer pools. | +| `total_capacity_in_bytes` | [long](./long.md) | Total capacity of buffer pools in bytes. | +| `total_capacity` | string | Total capacity of buffer pools. | +| `used_in_bytes` | [long](./long.md) | Size of buffer pools in bytes. | +| `used` | string | Size of buffer pools. | diff --git a/docs/reference/api/NodesNodeReloadResult.md b/docs/reference/api/NodesNodeReloadResult.md new file mode 100644 index 000000000..628cea5e6 --- /dev/null +++ b/docs/reference/api/NodesNodeReloadResult.md @@ -0,0 +1,6 @@ +## Interface `NodesNodeReloadResult` + +| Name | Type | Description | +| - | - | - | +| `name` | [Name](./Name.md) |   | +| `reload_exception` | [ErrorCause](./ErrorCause.md) |   | diff --git a/docs/reference/api/NodesNodesResponseBase.md b/docs/reference/api/NodesNodesResponseBase.md new file mode 100644 index 000000000..b1081f8ec --- /dev/null +++ b/docs/reference/api/NodesNodesResponseBase.md @@ -0,0 +1,5 @@ +## Interface `NodesNodesResponseBase` + +| Name | Type | Description | +| - | - | - | +| `_nodes` | [NodeStatistics](./NodeStatistics.md) | Contains statistics about the number of nodes selected by the request’s node filters. | diff --git a/docs/reference/api/NodesOperatingSystem.md b/docs/reference/api/NodesOperatingSystem.md new file mode 100644 index 000000000..9971b0f14 --- /dev/null +++ b/docs/reference/api/NodesOperatingSystem.md @@ -0,0 +1,9 @@ +## Interface `NodesOperatingSystem` + +| Name | Type | Description | +| - | - | - | +| `cgroup` | [NodesCgroup](./NodesCgroup.md) |   | +| `cpu` | [NodesCpu](./NodesCpu.md) |   | +| `mem` | [NodesExtendedMemoryStats](./NodesExtendedMemoryStats.md) |   | +| `swap` | [NodesMemoryStats](./NodesMemoryStats.md) |   | +| `timestamp` | [long](./long.md) |   | diff --git a/docs/reference/api/NodesPool.md b/docs/reference/api/NodesPool.md new file mode 100644 index 000000000..7e6972594 --- /dev/null +++ b/docs/reference/api/NodesPool.md @@ -0,0 +1,8 @@ +## Interface `NodesPool` + +| Name | Type | Description | +| - | - | - | +| `max_in_bytes` | [long](./long.md) | Maximum amount of memory, in bytes, available for use by the heap. | +| `peak_max_in_bytes` | [long](./long.md) | Largest amount of memory, in bytes, historically used by the heap. | +| `peak_used_in_bytes` | [long](./long.md) | Largest amount of memory, in bytes, historically used by the heap. | +| `used_in_bytes` | [long](./long.md) | Memory, in bytes, used by the heap. | diff --git a/docs/reference/api/NodesPressureMemory.md b/docs/reference/api/NodesPressureMemory.md new file mode 100644 index 000000000..d6b1f8db3 --- /dev/null +++ b/docs/reference/api/NodesPressureMemory.md @@ -0,0 +1,17 @@ +## Interface `NodesPressureMemory` + +| Name | Type | Description | +| - | - | - | +| `all_in_bytes` | [long](./long.md) | Memory consumed, in bytes, by indexing requests in the coordinating, primary, or replica stage. | +| `all` | [ByteSize](./ByteSize.md) | Memory consumed by indexing requests in the coordinating, primary, or replica stage. | +| `combined_coordinating_and_primary_in_bytes` | [long](./long.md) | Memory consumed, in bytes, by indexing requests in the coordinating or primary stage. This value is not the sum of coordinating and primary as a node can reuse the coordinating memory if the primary stage is executed locally. | +| `combined_coordinating_and_primary` | [ByteSize](./ByteSize.md) | Memory consumed by indexing requests in the coordinating or primary stage. This value is not the sum of coordinating and primary as a node can reuse the coordinating memory if the primary stage is executed locally. | +| `coordinating_in_bytes` | [long](./long.md) | Memory consumed, in bytes, by indexing requests in the coordinating stage. | +| `coordinating_rejections` | [long](./long.md) | Number of indexing requests rejected in the coordinating stage. | +| `coordinating` | [ByteSize](./ByteSize.md) | Memory consumed by indexing requests in the coordinating stage. | +| `primary_in_bytes` | [long](./long.md) | Memory consumed, in bytes, by indexing requests in the primary stage. | +| `primary_rejections` | [long](./long.md) | Number of indexing requests rejected in the primary stage. | +| `primary` | [ByteSize](./ByteSize.md) | Memory consumed by indexing requests in the primary stage. | +| `replica_in_bytes` | [long](./long.md) | Memory consumed, in bytes, by indexing requests in the replica stage. | +| `replica_rejections` | [long](./long.md) | Number of indexing requests rejected in the replica stage. | +| `replica` | [ByteSize](./ByteSize.md) | Memory consumed by indexing requests in the replica stage. | diff --git a/docs/reference/api/NodesProcess.md b/docs/reference/api/NodesProcess.md new file mode 100644 index 000000000..bcfc030ec --- /dev/null +++ b/docs/reference/api/NodesProcess.md @@ -0,0 +1,9 @@ +## Interface `NodesProcess` + +| Name | Type | Description | +| - | - | - | +| `cpu` | [NodesCpu](./NodesCpu.md) | Contains CPU statistics for the node. | +| `max_file_descriptors` | [integer](./integer.md) | Maximum number of file descriptors allowed on the system, or `-1` if not supported. | +| `mem` | [NodesMemoryStats](./NodesMemoryStats.md) | Contains virtual memory statistics for the node. | +| `open_file_descriptors` | [integer](./integer.md) | Number of opened file descriptors associated with the current or `-1` if not supported. | +| `timestamp` | [long](./long.md) | Last time the statistics were refreshed. Recorded in milliseconds since the Unix Epoch. | diff --git a/docs/reference/api/NodesProcessor.md b/docs/reference/api/NodesProcessor.md new file mode 100644 index 000000000..830365bae --- /dev/null +++ b/docs/reference/api/NodesProcessor.md @@ -0,0 +1,8 @@ +## Interface `NodesProcessor` + +| Name | Type | Description | +| - | - | - | +| `count` | [long](./long.md) | Number of documents transformed by the processor. | +| `current` | [long](./long.md) | Number of documents currently being transformed by the processor. | +| `failed` | [long](./long.md) | Number of failed operations for the processor. | +| `time_in_millis` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> | Time, in milliseconds, spent by the processor transforming documents. | diff --git a/docs/reference/api/NodesPublishedClusterStates.md b/docs/reference/api/NodesPublishedClusterStates.md new file mode 100644 index 000000000..83daa3043 --- /dev/null +++ b/docs/reference/api/NodesPublishedClusterStates.md @@ -0,0 +1,7 @@ +## Interface `NodesPublishedClusterStates` + +| Name | Type | Description | +| - | - | - | +| `compatible_diffs` | [long](./long.md) | Number of compatible differences between published cluster states. | +| `full_states` | [long](./long.md) | Number of published cluster states. | +| `incompatible_diffs` | [long](./long.md) | Number of incompatible differences between published cluster states. | diff --git a/docs/reference/api/NodesRecording.md b/docs/reference/api/NodesRecording.md new file mode 100644 index 000000000..57af49d3b --- /dev/null +++ b/docs/reference/api/NodesRecording.md @@ -0,0 +1,8 @@ +## Interface `NodesRecording` + +| Name | Type | Description | +| - | - | - | +| `cumulative_execution_count` | [long](./long.md) |   | +| `cumulative_execution_time_millis` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> |   | +| `cumulative_execution_time` | [Duration](./Duration.md) |   | +| `name` | string |   | diff --git a/docs/reference/api/NodesReloadSecureSettingsRequest.md b/docs/reference/api/NodesReloadSecureSettingsRequest.md new file mode 100644 index 000000000..7e56a3968 --- /dev/null +++ b/docs/reference/api/NodesReloadSecureSettingsRequest.md @@ -0,0 +1,9 @@ +## Interface `NodesReloadSecureSettingsRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { node_id?: never; timeout?: never; secure_settings_password?: never; }) | All values in `body` will be added to the request body. | +| `node_id` | [NodeIds](./NodeIds.md) | The names of particular nodes in the cluster to target. | +| `querystring` | { [key: string]: any; } & { node_id?: never; timeout?: never; secure_settings_password?: never; } | All values in `querystring` will be added to the request querystring. | +| `secure_settings_password` | [Password](./Password.md) | The password for the Elasticsearch keystore. | +| `timeout` | [Duration](./Duration.md) | Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. | diff --git a/docs/reference/api/NodesReloadSecureSettingsResponse.md b/docs/reference/api/NodesReloadSecureSettingsResponse.md new file mode 100644 index 000000000..88e0b0c1c --- /dev/null +++ b/docs/reference/api/NodesReloadSecureSettingsResponse.md @@ -0,0 +1,4 @@ +## `NodesReloadSecureSettingsResponse` +::: +type NodesReloadSecureSettingsResponse = [NodesReloadSecureSettingsResponseBase](./NodesReloadSecureSettingsResponseBase.md); +::: diff --git a/docs/reference/api/NodesReloadSecureSettingsResponseBase.md b/docs/reference/api/NodesReloadSecureSettingsResponseBase.md new file mode 100644 index 000000000..c9a4ee051 --- /dev/null +++ b/docs/reference/api/NodesReloadSecureSettingsResponseBase.md @@ -0,0 +1,6 @@ +## Interface `NodesReloadSecureSettingsResponseBase` + +| Name | Type | Description | +| - | - | - | +| `cluster_name` | [Name](./Name.md) |   | +| `nodes` | Record |   | diff --git a/docs/reference/api/NodesRepositoryLocation.md b/docs/reference/api/NodesRepositoryLocation.md new file mode 100644 index 000000000..70d0b8e4f --- /dev/null +++ b/docs/reference/api/NodesRepositoryLocation.md @@ -0,0 +1,7 @@ +## Interface `NodesRepositoryLocation` + +| Name | Type | Description | +| - | - | - | +| `base_path` | string |   | +| `bucket` | string | Bucket name (GCP, S3) | +| `container` | string | Container name (Azure) | diff --git a/docs/reference/api/NodesRepositoryMeteringInformation.md b/docs/reference/api/NodesRepositoryMeteringInformation.md new file mode 100644 index 000000000..543472b1a --- /dev/null +++ b/docs/reference/api/NodesRepositoryMeteringInformation.md @@ -0,0 +1,13 @@ +## Interface `NodesRepositoryMeteringInformation` + +| Name | Type | Description | +| - | - | - | +| `archived` | boolean | A flag that tells whether or not this object has been archived. When a repository is closed or updated the repository metering information is archived and kept for a certain period of time. This allows retrieving the repository metering information of previous repository instantiations. | +| `cluster_version` | [VersionNumber](./VersionNumber.md) | The cluster state version when this object was archived, this field can be used as a logical timestamp to delete all the archived metrics up to an observed version. This field is only present for archived repository metering information objects. The main purpose of this field is to avoid possible race conditions during repository metering information deletions, i.e. deleting archived repositories metering information that we haven’t observed yet. | +| `repository_ephemeral_id` | [Id](./Id.md) | An identifier that changes every time the repository is updated. | +| `repository_location` | [NodesRepositoryLocation](./NodesRepositoryLocation.md) | Represents an unique location within the repository. | +| `repository_name` | [Name](./Name.md) | Repository name. | +| `repository_started_at` | [EpochTime](./EpochTime.md)<[UnitMillis](./UnitMillis.md)> | Time the repository was created or updated. Recorded in milliseconds since the Unix Epoch. | +| `repository_stopped_at` | [EpochTime](./EpochTime.md)<[UnitMillis](./UnitMillis.md)> | Time the repository was deleted or updated. Recorded in milliseconds since the Unix Epoch. | +| `repository_type` | string | Repository type. | +| `request_counts` | [NodesRequestCounts](./NodesRequestCounts.md) | An object with the number of request performed against the repository grouped by request type. | diff --git a/docs/reference/api/NodesRequestCounts.md b/docs/reference/api/NodesRequestCounts.md new file mode 100644 index 000000000..db09bd712 --- /dev/null +++ b/docs/reference/api/NodesRequestCounts.md @@ -0,0 +1,15 @@ +## Interface `NodesRequestCounts` + +| Name | Type | Description | +| - | - | - | +| `GetBlob` | [long](./long.md) | Number of Get Blob requests (Azure) | +| `GetBlobProperties` | [long](./long.md) | Number of Get Blob Properties requests (Azure) | +| `GetObject` | [long](./long.md) | Number of get object requests (GCP, S3) | +| `InsertObject` | [long](./long.md) | Number of insert object requests, including simple, multipart and resumable uploads. Resumable uploads can perform multiple http requests to insert a single object but they are considered as a single request since they are billed as an individual operation. (GCP) | +| `ListBlobs` | [long](./long.md) | Number of List Blobs requests (Azure) | +| `ListObjects` | [long](./long.md) | Number of list objects requests (GCP, S3) | +| `PutBlob` | [long](./long.md) | Number of Put Blob requests (Azure) | +| `PutBlock` | [long](./long.md) | Number of Put Block (Azure) | +| `PutBlockList` | [long](./long.md) | Number of Put Block List requests | +| `PutMultipartObject` | [long](./long.md) | Number of Multipart requests, including CreateMultipartUpload, UploadPart and CompleteMultipartUpload requests (S3) | +| `PutObject` | [long](./long.md) | Number of PutObject requests (S3) | diff --git a/docs/reference/api/NodesScriptCache.md b/docs/reference/api/NodesScriptCache.md new file mode 100644 index 000000000..494c0a7d4 --- /dev/null +++ b/docs/reference/api/NodesScriptCache.md @@ -0,0 +1,8 @@ +## Interface `NodesScriptCache` + +| Name | Type | Description | +| - | - | - | +| `cache_evictions` | [long](./long.md) | Total number of times the script cache has evicted old data. | +| `compilation_limit_triggered` | [long](./long.md) | Total number of times the script compilation circuit breaker has limited inline script compilations. | +| `compilations` | [long](./long.md) | Total number of inline script compilations performed by the node. | +| `context` | string |   | diff --git a/docs/reference/api/NodesScripting.md b/docs/reference/api/NodesScripting.md new file mode 100644 index 000000000..9fafe673f --- /dev/null +++ b/docs/reference/api/NodesScripting.md @@ -0,0 +1,9 @@ +## Interface `NodesScripting` + +| Name | Type | Description | +| - | - | - | +| `cache_evictions` | [long](./long.md) | Total number of times the script cache has evicted old data. | +| `compilation_limit_triggered` | [long](./long.md) | Total number of times the script compilation circuit breaker has limited inline script compilations. | +| `compilations_history` | Record | Contains this recent history of script compilations. | +| `compilations` | [long](./long.md) | Total number of inline script compilations performed by the node. | +| `contexts` | [NodesContext](./NodesContext.md)[] |   | diff --git a/docs/reference/api/NodesSerializedClusterState.md b/docs/reference/api/NodesSerializedClusterState.md new file mode 100644 index 000000000..b13405a57 --- /dev/null +++ b/docs/reference/api/NodesSerializedClusterState.md @@ -0,0 +1,6 @@ +## Interface `NodesSerializedClusterState` + +| Name | Type | Description | +| - | - | - | +| `diffs` | [NodesSerializedClusterStateDetail](./NodesSerializedClusterStateDetail.md) |   | +| `full_states` | [NodesSerializedClusterStateDetail](./NodesSerializedClusterStateDetail.md) | Number of published cluster states. | diff --git a/docs/reference/api/NodesSerializedClusterStateDetail.md b/docs/reference/api/NodesSerializedClusterStateDetail.md new file mode 100644 index 000000000..a99fe47c7 --- /dev/null +++ b/docs/reference/api/NodesSerializedClusterStateDetail.md @@ -0,0 +1,9 @@ +## Interface `NodesSerializedClusterStateDetail` + +| Name | Type | Description | +| - | - | - | +| `compressed_size_in_bytes` | [long](./long.md) |   | +| `compressed_size` | string |   | +| `count` | [long](./long.md) |   | +| `uncompressed_size_in_bytes` | [long](./long.md) |   | +| `uncompressed_size` | string |   | diff --git a/docs/reference/api/NodesSizeHttpHistogram.md b/docs/reference/api/NodesSizeHttpHistogram.md new file mode 100644 index 000000000..753a4655a --- /dev/null +++ b/docs/reference/api/NodesSizeHttpHistogram.md @@ -0,0 +1,7 @@ +## Interface `NodesSizeHttpHistogram` + +| Name | Type | Description | +| - | - | - | +| `count` | [long](./long.md) |   | +| `ge_bytes` | [long](./long.md) |   | +| `lt_bytes` | [long](./long.md) |   | diff --git a/docs/reference/api/NodesStats.md b/docs/reference/api/NodesStats.md new file mode 100644 index 000000000..779677f12 --- /dev/null +++ b/docs/reference/api/NodesStats.md @@ -0,0 +1,26 @@ +## Interface `NodesStats` + +| Name | Type | Description | +| - | - | - | +| `adaptive_selection` | Record | Statistics about adaptive replica selection. | +| `attributes` | Record<[Field](./Field.md), string> | Contains a list of attributes for the node. | +| `breakers` | Record | Statistics about the field data circuit breaker. | +| `discovery` | [NodesDiscovery](./NodesDiscovery.md) | Contains node discovery statistics for the node. | +| `fs` | [NodesFileSystem](./NodesFileSystem.md) | File system information, data path, free disk space, read/write stats. | +| `host` | [Host](./Host.md) | Network host for the node, based on the network host setting. | +| `http` | [NodesHttp](./NodesHttp.md) | HTTP connection information. | +| `indexing_pressure` | [NodesIndexingPressure](./NodesIndexingPressure.md) | Contains indexing pressure statistics for the node. | +| `indices` | [IndicesStatsShardStats](./IndicesStatsShardStats.md) | Indices stats about size, document count, indexing and deletion times, search times, field cache size, merges and flushes. | +| `ingest` | [NodesIngest](./NodesIngest.md) | Statistics about ingest preprocessing. | +| `ip` | [Ip](./Ip.md) | [Ip](./Ip.md)[] | IP address and port for the node. | +| `jvm` | [NodesJvm](./NodesJvm.md) | JVM stats, memory pool information, garbage collection, buffer pools, number of loaded/unloaded classes. | +| `name` | [Name](./Name.md) | Human-readable identifier for the node. Based on the node name setting. | +| `os` | [NodesOperatingSystem](./NodesOperatingSystem.md) | Operating system stats, load average, mem, swap. | +| `process` | [NodesProcess](./NodesProcess.md) | Process statistics, memory consumption, cpu usage, open file descriptors. | +| `roles` | [NodeRoles](./NodeRoles.md) | Roles assigned to the node. | +| `script_cache` | Record |   | +| `script` | [NodesScripting](./NodesScripting.md) | Contains script statistics for the node. | +| `thread_pool` | Record | Statistics about each thread pool, including current size, queue and rejected tasks. | +| `timestamp` | [long](./long.md) |   | +| `transport_address` | [TransportAddress](./TransportAddress.md) | Host and port for the transport layer, used for internal communication between nodes in a cluster. | +| `transport` | [NodesTransport](./NodesTransport.md) | Transport statistics about sent and received bytes in cluster communication. | diff --git a/docs/reference/api/NodesStatsRequest.md b/docs/reference/api/NodesStatsRequest.md new file mode 100644 index 000000000..efaa8f3c3 --- /dev/null +++ b/docs/reference/api/NodesStatsRequest.md @@ -0,0 +1,18 @@ +## Interface `NodesStatsRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { node_id?: never; metric?: never; index_metric?: never; completion_fields?: never; fielddata_fields?: never; fields?: never; groups?: never; include_segment_file_sizes?: never; level?: never; timeout?: never; types?: never; include_unloaded_segments?: never; }) | All values in `body` will be added to the request body. | +| `completion_fields` | [Fields](./Fields.md) | Comma-separated list or wildcard expressions of fields to include in fielddata and suggest statistics. | +| `fielddata_fields` | [Fields](./Fields.md) | Comma-separated list or wildcard expressions of fields to include in fielddata statistics. | +| `fields` | [Fields](./Fields.md) | Comma-separated list or wildcard expressions of fields to include in the statistics. | +| `groups` | boolean | Comma-separated list of search groups to include in the search statistics. | +| `include_segment_file_sizes` | boolean | If true, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested). | +| `include_unloaded_segments` | boolean | If `true`, the response includes information from segments that are not loaded into memory. | +| `index_metric` | [Metrics](./Metrics.md) | Limit the information returned for indices metric to the specific index metrics. It can be used only if indices (or all) metric is specified. | +| `level` | [Level](./Level.md) | Indicates whether statistics are aggregated at the cluster, index, or shard level. | +| `metric` | [Metrics](./Metrics.md) | Limit the information returned to the specified metrics | +| `node_id` | [NodeIds](./NodeIds.md) | Comma-separated list of node IDs or names used to limit returned information. | +| `querystring` | { [key: string]: any; } & { node_id?: never; metric?: never; index_metric?: never; completion_fields?: never; fielddata_fields?: never; fields?: never; groups?: never; include_segment_file_sizes?: never; level?: never; timeout?: never; types?: never; include_unloaded_segments?: never; } | All values in `querystring` will be added to the request querystring. | +| `timeout` | [Duration](./Duration.md) | Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. | +| `types` | string[] | A comma-separated list of document types for the indexing index metric. | diff --git a/docs/reference/api/NodesStatsResponse.md b/docs/reference/api/NodesStatsResponse.md new file mode 100644 index 000000000..f611868b8 --- /dev/null +++ b/docs/reference/api/NodesStatsResponse.md @@ -0,0 +1,4 @@ +## `NodesStatsResponse` +::: +type NodesStatsResponse = [NodesStatsResponseBase](./NodesStatsResponseBase.md); +::: diff --git a/docs/reference/api/NodesStatsResponseBase.md b/docs/reference/api/NodesStatsResponseBase.md new file mode 100644 index 000000000..82f27a6d2 --- /dev/null +++ b/docs/reference/api/NodesStatsResponseBase.md @@ -0,0 +1,6 @@ +## Interface `NodesStatsResponseBase` + +| Name | Type | Description | +| - | - | - | +| `cluster_name` | [Name](./Name.md) |   | +| `nodes` | Record |   | diff --git a/docs/reference/api/NodesThreadCount.md b/docs/reference/api/NodesThreadCount.md new file mode 100644 index 000000000..b9935bd37 --- /dev/null +++ b/docs/reference/api/NodesThreadCount.md @@ -0,0 +1,10 @@ +## Interface `NodesThreadCount` + +| Name | Type | Description | +| - | - | - | +| `active` | [long](./long.md) | Number of active threads in the thread pool. | +| `completed` | [long](./long.md) | Number of tasks completed by the thread pool executor. | +| `largest` | [long](./long.md) | Highest number of active threads in the thread pool. | +| `queue` | [long](./long.md) | Number of tasks in queue for the thread pool. | +| `rejected` | [long](./long.md) | Number of tasks rejected by the thread pool executor. | +| `threads` | [long](./long.md) | Number of threads in the thread pool. | diff --git a/docs/reference/api/NodesTimeHttpHistogram.md b/docs/reference/api/NodesTimeHttpHistogram.md new file mode 100644 index 000000000..1ed2e6a15 --- /dev/null +++ b/docs/reference/api/NodesTimeHttpHistogram.md @@ -0,0 +1,7 @@ +## Interface `NodesTimeHttpHistogram` + +| Name | Type | Description | +| - | - | - | +| `count` | [long](./long.md) |   | +| `ge_millis` | [long](./long.md) |   | +| `lt_millis` | [long](./long.md) |   | diff --git a/docs/reference/api/NodesTransport.md b/docs/reference/api/NodesTransport.md new file mode 100644 index 000000000..63f301435 --- /dev/null +++ b/docs/reference/api/NodesTransport.md @@ -0,0 +1,14 @@ +## Interface `NodesTransport` + +| Name | Type | Description | +| - | - | - | +| `inbound_handling_time_histogram` | [NodesTransportHistogram](./NodesTransportHistogram.md)[] | The distribution of the time spent handling each inbound message on a transport thread, represented as a histogram. | +| `outbound_handling_time_histogram` | [NodesTransportHistogram](./NodesTransportHistogram.md)[] | The distribution of the time spent sending each outbound transport message on a transport thread, represented as a histogram. | +| `rx_count` | [long](./long.md) | Total number of RX (receive) packets received by the node during internal cluster communication. | +| `rx_size_in_bytes` | [long](./long.md) | Size, in bytes, of RX packets received by the node during internal cluster communication. | +| `rx_size` | string | Size of RX packets received by the node during internal cluster communication. | +| `server_open` | [integer](./integer.md) | Current number of inbound TCP connections used for internal communication between nodes. | +| `total_outbound_connections` | [long](./long.md) | The cumulative number of outbound transport connections that this node has opened since it started. Each transport connection may comprise multiple TCP connections but is only counted once in this statistic. Transport connections are typically long-lived so this statistic should remain constant in a stable cluster. | +| `tx_count` | [long](./long.md) | Total number of TX (transmit) packets sent by the node during internal cluster communication. | +| `tx_size_in_bytes` | [long](./long.md) | Size, in bytes, of TX packets sent by the node during internal cluster communication. | +| `tx_size` | string | Size of TX packets sent by the node during internal cluster communication. | diff --git a/docs/reference/api/NodesTransportHistogram.md b/docs/reference/api/NodesTransportHistogram.md new file mode 100644 index 000000000..4a05743c6 --- /dev/null +++ b/docs/reference/api/NodesTransportHistogram.md @@ -0,0 +1,7 @@ +## Interface `NodesTransportHistogram` + +| Name | Type | Description | +| - | - | - | +| `count` | [long](./long.md) | The number of times a transport thread took a period of time within the bounds of this bucket to handle an inbound message. | +| `ge_millis` | [long](./long.md) | The inclusive lower bound of the bucket in milliseconds. May be omitted on the first bucket if this bucket has no lower bound. | +| `lt_millis` | [long](./long.md) | The exclusive upper bound of the bucket in milliseconds. May be omitted on the last bucket if this bucket has no upper bound. | diff --git a/docs/reference/api/NodesUsageNodeUsage.md b/docs/reference/api/NodesUsageNodeUsage.md new file mode 100644 index 000000000..81d93fe03 --- /dev/null +++ b/docs/reference/api/NodesUsageNodeUsage.md @@ -0,0 +1,8 @@ +## Interface `NodesUsageNodeUsage` + +| Name | Type | Description | +| - | - | - | +| `aggregations` | Record |   | +| `rest_actions` | Record |   | +| `since` | [EpochTime](./EpochTime.md)<[UnitMillis](./UnitMillis.md)> |   | +| `timestamp` | [EpochTime](./EpochTime.md)<[UnitMillis](./UnitMillis.md)> |   | diff --git a/docs/reference/api/NodesUsageRequest.md b/docs/reference/api/NodesUsageRequest.md new file mode 100644 index 000000000..6df96d1c7 --- /dev/null +++ b/docs/reference/api/NodesUsageRequest.md @@ -0,0 +1,9 @@ +## Interface `NodesUsageRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { node_id?: never; metric?: never; timeout?: never; }) | All values in `body` will be added to the request body. | +| `metric` | [Metrics](./Metrics.md) | Limits the information returned to the specific metrics. A comma-separated list of the following options: `_all`, `rest_actions`. | +| `node_id` | [NodeIds](./NodeIds.md) | A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes | +| `querystring` | { [key: string]: any; } & { node_id?: never; metric?: never; timeout?: never; } | All values in `querystring` will be added to the request querystring. | +| `timeout` | [Duration](./Duration.md) | Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. | diff --git a/docs/reference/api/NodesUsageResponse.md b/docs/reference/api/NodesUsageResponse.md new file mode 100644 index 000000000..2f1371830 --- /dev/null +++ b/docs/reference/api/NodesUsageResponse.md @@ -0,0 +1,4 @@ +## `NodesUsageResponse` +::: +type NodesUsageResponse = [NodesUsageResponseBase](./NodesUsageResponseBase.md); +::: diff --git a/docs/reference/api/NodesUsageResponseBase.md b/docs/reference/api/NodesUsageResponseBase.md new file mode 100644 index 000000000..ad9cd759b --- /dev/null +++ b/docs/reference/api/NodesUsageResponseBase.md @@ -0,0 +1,6 @@ +## Interface `NodesUsageResponseBase` + +| Name | Type | Description | +| - | - | - | +| `cluster_name` | [Name](./Name.md) |   | +| `nodes` | Record |   | diff --git a/docs/reference/api/Normalization.md b/docs/reference/api/Normalization.md new file mode 100644 index 000000000..65ecd251d --- /dev/null +++ b/docs/reference/api/Normalization.md @@ -0,0 +1,4 @@ +## `Normalization` +::: +type Normalization = 'no' | 'h1' | 'h2' | 'h3' | 'z'; +::: diff --git a/docs/reference/api/OnDropDocument.md b/docs/reference/api/OnDropDocument.md new file mode 100644 index 000000000..2cd03ed0a --- /dev/null +++ b/docs/reference/api/OnDropDocument.md @@ -0,0 +1,9 @@ +## Interface `OnDropDocument` + +| Name | Type | Description | +| - | - | - | +| `document` | TDocument |   | +| `error` | [ErrorCause](./ErrorCause.md) | null |   | +| `operation` | [Action](./Action.md) |   | +| `retried` | boolean |   | +| `status` | number |   | diff --git a/docs/reference/api/OnSuccessDocument.md b/docs/reference/api/OnSuccessDocument.md new file mode 100644 index 000000000..b85d89906 --- /dev/null +++ b/docs/reference/api/OnSuccessDocument.md @@ -0,0 +1,6 @@ +## Interface `OnSuccessDocument` + +| Name | Type | Description | +| - | - | - | +| `document` | TDocument |   | +| `result` | [BulkResponseItem](./BulkResponseItem.md) |   | diff --git a/docs/reference/api/OpType.md b/docs/reference/api/OpType.md new file mode 100644 index 000000000..fd1900147 --- /dev/null +++ b/docs/reference/api/OpType.md @@ -0,0 +1,4 @@ +## `OpType` +::: +type OpType = 'index' | 'create'; +::: diff --git a/docs/reference/api/OpenPointInTimeApi_1.md b/docs/reference/api/OpenPointInTimeApi_1.md new file mode 100644 index 000000000..68671fc46 --- /dev/null +++ b/docs/reference/api/OpenPointInTimeApi_1.md @@ -0,0 +1,3 @@ +::: +default function OpenPointInTimeApi(this: [That](./That.md), params: [OpenPointInTimeRequest](./OpenPointInTimeRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[OpenPointInTimeResponse](./OpenPointInTimeResponse.md)>; +::: diff --git a/docs/reference/api/OpenPointInTimeApi_2.md b/docs/reference/api/OpenPointInTimeApi_2.md new file mode 100644 index 000000000..c9fbe614c --- /dev/null +++ b/docs/reference/api/OpenPointInTimeApi_2.md @@ -0,0 +1,3 @@ +::: +default function OpenPointInTimeApi(this: [That](./That.md), params: [OpenPointInTimeRequest](./OpenPointInTimeRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[OpenPointInTimeResponse](./OpenPointInTimeResponse.md), unknown>>; +::: diff --git a/docs/reference/api/OpenPointInTimeApi_3.md b/docs/reference/api/OpenPointInTimeApi_3.md new file mode 100644 index 000000000..f7d03ef19 --- /dev/null +++ b/docs/reference/api/OpenPointInTimeApi_3.md @@ -0,0 +1,3 @@ +::: +default function OpenPointInTimeApi(this: [That](./That.md), params: [OpenPointInTimeRequest](./OpenPointInTimeRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[OpenPointInTimeResponse](./OpenPointInTimeResponse.md)>; +::: diff --git a/docs/reference/api/OpenPointInTimeRequest.md b/docs/reference/api/OpenPointInTimeRequest.md new file mode 100644 index 000000000..333c6c087 --- /dev/null +++ b/docs/reference/api/OpenPointInTimeRequest.md @@ -0,0 +1,15 @@ +## Interface `OpenPointInTimeRequest` + +| Name | Type | Description | +| - | - | - | +| `allow_partial_search_results` | boolean | Indicates whether the point in time tolerates unavailable shards or shard failures when initially creating the PIT. If `false`, creating a point in time request when a shard is missing or unavailable will throw an exception. If `true`, the point in time will contain all the shards that are available at the time of the request. | +| `body` | string | ({ [key: string]: any; } & { index?: never; keep_alive?: never; ignore_unavailable?: never; preference?: never; routing?: never; expand_wildcards?: never; allow_partial_search_results?: never; max_concurrent_shard_requests?: never; index_filter?: never; }) | All values in `body` will be added to the request body. | +| `expand_wildcards` | [ExpandWildcards](./ExpandWildcards.md) | The type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. It supports comma-separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. | +| `ignore_unavailable` | boolean | If `false`, the request returns an error if it targets a missing or closed index. | +| `index_filter` | [QueryDslQueryContainer](./QueryDslQueryContainer.md) | Filter indices if the provided query rewrites to `match_none` on every shard. | +| `index` | [Indices](./Indices.md) | A comma-separated list of index names to open point in time; use `_all` or empty string to perform the operation on all indices | +| `keep_alive` | [Duration](./Duration.md) | Extend the length of time that the point in time persists. | +| `max_concurrent_shard_requests` | [integer](./integer.md) | Maximum number of concurrent shard requests that each sub-search request executes per node. | +| `preference` | string | The node or shard the operation should be performed on. By default, it is random. | +| `querystring` | { [key: string]: any; } & { index?: never; keep_alive?: never; ignore_unavailable?: never; preference?: never; routing?: never; expand_wildcards?: never; allow_partial_search_results?: never; max_concurrent_shard_requests?: never; index_filter?: never; } | All values in `querystring` will be added to the request querystring. | +| `routing` | [Routing](./Routing.md) | A custom value that is used to route operations to a specific shard. | diff --git a/docs/reference/api/OpenPointInTimeResponse.md b/docs/reference/api/OpenPointInTimeResponse.md new file mode 100644 index 000000000..3576e2ffe --- /dev/null +++ b/docs/reference/api/OpenPointInTimeResponse.md @@ -0,0 +1,6 @@ +## Interface `OpenPointInTimeResponse` + +| Name | Type | Description | +| - | - | - | +| `_shards` | [ShardStatistics](./ShardStatistics.md) | Shards used to create the PIT | +| `id` | [Id](./Id.md) |   | diff --git a/docs/reference/api/Password.md b/docs/reference/api/Password.md new file mode 100644 index 000000000..b3ed97527 --- /dev/null +++ b/docs/reference/api/Password.md @@ -0,0 +1,4 @@ +## `Password` +::: +type Password = string; +::: diff --git a/docs/reference/api/Percentage.md b/docs/reference/api/Percentage.md new file mode 100644 index 000000000..957f5e8bc --- /dev/null +++ b/docs/reference/api/Percentage.md @@ -0,0 +1,4 @@ +## `Percentage` +::: +type Percentage = string | [float](./float.md); +::: diff --git a/docs/reference/api/PingApi_1.md b/docs/reference/api/PingApi_1.md new file mode 100644 index 000000000..a4e9c2285 --- /dev/null +++ b/docs/reference/api/PingApi_1.md @@ -0,0 +1,3 @@ +::: +default function PingApi(this: [That](./That.md), params?: [PingRequest](./PingRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[PingResponse](./PingResponse.md)>; +::: diff --git a/docs/reference/api/PingApi_2.md b/docs/reference/api/PingApi_2.md new file mode 100644 index 000000000..4382d3052 --- /dev/null +++ b/docs/reference/api/PingApi_2.md @@ -0,0 +1,3 @@ +::: +default function PingApi(this: [That](./That.md), params?: [PingRequest](./PingRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[PingResponse](./PingResponse.md), unknown>>; +::: diff --git a/docs/reference/api/PingApi_3.md b/docs/reference/api/PingApi_3.md new file mode 100644 index 000000000..30adbfe44 --- /dev/null +++ b/docs/reference/api/PingApi_3.md @@ -0,0 +1,3 @@ +::: +default function PingApi(this: [That](./That.md), params?: [PingRequest](./PingRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[PingResponse](./PingResponse.md)>; +::: diff --git a/docs/reference/api/PingRequest.md b/docs/reference/api/PingRequest.md new file mode 100644 index 000000000..d16a510e8 --- /dev/null +++ b/docs/reference/api/PingRequest.md @@ -0,0 +1,6 @@ +## Interface `PingRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | { [key: string]: any; } | All values in `body` will be added to the request body. | +| `querystring` | { [key: string]: any; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/PingResponse.md b/docs/reference/api/PingResponse.md new file mode 100644 index 000000000..bb58e4413 --- /dev/null +++ b/docs/reference/api/PingResponse.md @@ -0,0 +1,4 @@ +## `PingResponse` +::: +type PingResponse = boolean; +::: diff --git a/docs/reference/api/PipelineName.md b/docs/reference/api/PipelineName.md new file mode 100644 index 000000000..afe37a1b8 --- /dev/null +++ b/docs/reference/api/PipelineName.md @@ -0,0 +1,4 @@ +## `PipelineName` +::: +type PipelineName = string; +::: diff --git a/docs/reference/api/PluginStats.md b/docs/reference/api/PluginStats.md new file mode 100644 index 000000000..cacf24a24 --- /dev/null +++ b/docs/reference/api/PluginStats.md @@ -0,0 +1,13 @@ +## Interface `PluginStats` + +| Name | Type | Description | +| - | - | - | +| `classname` | string |   | +| `description` | string |   | +| `elasticsearch_version` | [VersionString](./VersionString.md) |   | +| `extended_plugins` | string[] |   | +| `has_native_controller` | boolean |   | +| `java_version` | [VersionString](./VersionString.md) |   | +| `licensed` | boolean |   | +| `name` | [Name](./Name.md) |   | +| `version` | [VersionString](./VersionString.md) |   | diff --git a/docs/reference/api/Profiling.md b/docs/reference/api/Profiling.md new file mode 100644 index 000000000..03ce2a05a --- /dev/null +++ b/docs/reference/api/Profiling.md @@ -0,0 +1,20 @@ +## `Profiling` + +### Constructor + +::: +new Profiling(transport: [Transport](./Transport.md)); +::: + +### Properties + +| Name | Type | Description | +| - | - | - | +| `acceptedParams` | Record |   | +| `transport` | [Transport](./Transport.md) |   | + +### Methods + +| Name | Signature | Description | +| - | - | - | +| `flamegraph` | `flamegraph(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TODO](./TODO.md)>;` | Extracts a UI-optimized structure to render flamegraphs from Universal Profiling. || `flamegraph` | `flamegraph(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TODO](./TODO.md), unknown>>;` |   || `flamegraph` | `flamegraph(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TODO](./TODO.md)>;` |   || `stacktraces` | `stacktraces(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TODO](./TODO.md)>;` | Extracts raw stacktrace information from Universal Profiling. || `stacktraces` | `stacktraces(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TODO](./TODO.md), unknown>>;` |   || `stacktraces` | `stacktraces(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TODO](./TODO.md)>;` |   || `status` | `status(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TODO](./TODO.md)>;` | Returns basic information about the status of Universal Profiling. || `status` | `status(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TODO](./TODO.md), unknown>>;` |   || `status` | `status(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TODO](./TODO.md)>;` |   || `topnFunctions` | `topnFunctions(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TODO](./TODO.md)>;` | Extracts a list of topN functions from Universal Profiling. || `topnFunctions` | `topnFunctions(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TODO](./TODO.md), unknown>>;` |   || `topnFunctions` | `topnFunctions(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TODO](./TODO.md)>;` |   | \ No newline at end of file diff --git a/docs/reference/api/PropertyName.md b/docs/reference/api/PropertyName.md new file mode 100644 index 000000000..c833c35b2 --- /dev/null +++ b/docs/reference/api/PropertyName.md @@ -0,0 +1,4 @@ +## `PropertyName` +::: +type PropertyName = string; +::: diff --git a/docs/reference/api/PutScriptApi_1.md b/docs/reference/api/PutScriptApi_1.md new file mode 100644 index 000000000..386b64dcc --- /dev/null +++ b/docs/reference/api/PutScriptApi_1.md @@ -0,0 +1,3 @@ +::: +default function PutScriptApi(this: [That](./That.md), params: [PutScriptRequest](./PutScriptRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[PutScriptResponse](./PutScriptResponse.md)>; +::: diff --git a/docs/reference/api/PutScriptApi_2.md b/docs/reference/api/PutScriptApi_2.md new file mode 100644 index 000000000..21f681bf4 --- /dev/null +++ b/docs/reference/api/PutScriptApi_2.md @@ -0,0 +1,3 @@ +::: +default function PutScriptApi(this: [That](./That.md), params: [PutScriptRequest](./PutScriptRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[PutScriptResponse](./PutScriptResponse.md), unknown>>; +::: diff --git a/docs/reference/api/PutScriptApi_3.md b/docs/reference/api/PutScriptApi_3.md new file mode 100644 index 000000000..5358c0264 --- /dev/null +++ b/docs/reference/api/PutScriptApi_3.md @@ -0,0 +1,3 @@ +::: +default function PutScriptApi(this: [That](./That.md), params: [PutScriptRequest](./PutScriptRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[PutScriptResponse](./PutScriptResponse.md)>; +::: diff --git a/docs/reference/api/PutScriptRequest.md b/docs/reference/api/PutScriptRequest.md new file mode 100644 index 000000000..16c8bb56b --- /dev/null +++ b/docs/reference/api/PutScriptRequest.md @@ -0,0 +1,11 @@ +## Interface `PutScriptRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { id?: never; context?: never; master_timeout?: never; timeout?: never; script?: never; }) | All values in `body` will be added to the request body. | +| `context` | [Name](./Name.md) | The context in which the script or search template should run. To prevent errors, the API immediately compiles the script or template in this context. | +| `id` | [Id](./Id.md) | The identifier for the stored script or search template. It must be unique within the cluster. | +| `master_timeout` | [Duration](./Duration.md) | The period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. It can also be set to `-1` to indicate that the request should never timeout. | +| `querystring` | { [key: string]: any; } & { id?: never; context?: never; master_timeout?: never; timeout?: never; script?: never; } | All values in `querystring` will be added to the request querystring. | +| `script` | [StoredScript](./StoredScript.md) | The script or search template, its parameters, and its language. | +| `timeout` | [Duration](./Duration.md) | The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. It can also be set to `-1` to indicate that the request should never timeout. | diff --git a/docs/reference/api/PutScriptResponse.md b/docs/reference/api/PutScriptResponse.md new file mode 100644 index 000000000..1d21c2811 --- /dev/null +++ b/docs/reference/api/PutScriptResponse.md @@ -0,0 +1,4 @@ +## `PutScriptResponse` +::: +type PutScriptResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); +::: diff --git a/docs/reference/api/QueryCacheStats.md b/docs/reference/api/QueryCacheStats.md new file mode 100644 index 000000000..ea95df52a --- /dev/null +++ b/docs/reference/api/QueryCacheStats.md @@ -0,0 +1,12 @@ +## Interface `QueryCacheStats` + +| Name | Type | Description | +| - | - | - | +| `cache_count` | [long](./long.md) | Total number of entries added to the query cache across all shards assigned to selected nodes. This number includes current and evicted entries. | +| `cache_size` | [long](./long.md) | Total number of entries currently in the query cache across all shards assigned to selected nodes. | +| `evictions` | [long](./long.md) | Total number of query cache evictions across all shards assigned to selected nodes. | +| `hit_count` | [long](./long.md) | Total count of query cache hits across all shards assigned to selected nodes. | +| `memory_size_in_bytes` | [long](./long.md) | Total amount, in bytes, of memory used for the query cache across all shards assigned to selected nodes. | +| `memory_size` | [ByteSize](./ByteSize.md) | Total amount of memory used for the query cache across all shards assigned to selected nodes. | +| `miss_count` | [long](./long.md) | Total count of query cache misses across all shards assigned to selected nodes. | +| `total_count` | [long](./long.md) | Total count of hits and misses in the query cache across all shards assigned to selected nodes. | diff --git a/docs/reference/api/QueryDslBoolQuery.md b/docs/reference/api/QueryDslBoolQuery.md new file mode 100644 index 000000000..6cc45f6cb --- /dev/null +++ b/docs/reference/api/QueryDslBoolQuery.md @@ -0,0 +1,9 @@ +## Interface `QueryDslBoolQuery` + +| Name | Type | Description | +| - | - | - | +| `filter` | [QueryDslQueryContainer](./QueryDslQueryContainer.md) | [QueryDslQueryContainer](./QueryDslQueryContainer.md)[] | The clause (query) must appear in matching documents. However, unlike `must`, the score of the query will be ignored. | +| `minimum_should_match` | [MinimumShouldMatch](./MinimumShouldMatch.md) | Specifies the number or percentage of `should` clauses returned documents must match. | +| `must_not` | [QueryDslQueryContainer](./QueryDslQueryContainer.md) | [QueryDslQueryContainer](./QueryDslQueryContainer.md)[] | The clause (query) must not appear in the matching documents. Because scoring is ignored, a score of `0` is returned for all documents. | +| `must` | [QueryDslQueryContainer](./QueryDslQueryContainer.md) | [QueryDslQueryContainer](./QueryDslQueryContainer.md)[] | The clause (query) must appear in matching documents and will contribute to the score. | +| `should` | [QueryDslQueryContainer](./QueryDslQueryContainer.md) | [QueryDslQueryContainer](./QueryDslQueryContainer.md)[] | The clause (query) should appear in the matching document. | diff --git a/docs/reference/api/QueryDslBoostingQuery.md b/docs/reference/api/QueryDslBoostingQuery.md new file mode 100644 index 000000000..d96d610e5 --- /dev/null +++ b/docs/reference/api/QueryDslBoostingQuery.md @@ -0,0 +1,7 @@ +## Interface `QueryDslBoostingQuery` + +| Name | Type | Description | +| - | - | - | +| `negative_boost` | [double](./double.md) | Floating point number between 0 and 1.0 used to decrease the relevance scores of documents matching the `negative` query. | +| `negative` | [QueryDslQueryContainer](./QueryDslQueryContainer.md) | Query used to decrease the relevance score of matching documents. | +| `positive` | [QueryDslQueryContainer](./QueryDslQueryContainer.md) | Any returned documents must match this query. | diff --git a/docs/reference/api/QueryDslChildScoreMode.md b/docs/reference/api/QueryDslChildScoreMode.md new file mode 100644 index 000000000..34f5812e6 --- /dev/null +++ b/docs/reference/api/QueryDslChildScoreMode.md @@ -0,0 +1,4 @@ +## `QueryDslChildScoreMode` +::: +type QueryDslChildScoreMode = 'none' | 'avg' | 'sum' | 'max' | 'min'; +::: diff --git a/docs/reference/api/QueryDslCombinedFieldsOperator.md b/docs/reference/api/QueryDslCombinedFieldsOperator.md new file mode 100644 index 000000000..b384e4b21 --- /dev/null +++ b/docs/reference/api/QueryDslCombinedFieldsOperator.md @@ -0,0 +1,4 @@ +## `QueryDslCombinedFieldsOperator` +::: +type QueryDslCombinedFieldsOperator = 'or' | 'and'; +::: diff --git a/docs/reference/api/QueryDslCombinedFieldsQuery.md b/docs/reference/api/QueryDslCombinedFieldsQuery.md new file mode 100644 index 000000000..51f5e88e3 --- /dev/null +++ b/docs/reference/api/QueryDslCombinedFieldsQuery.md @@ -0,0 +1,10 @@ +## Interface `QueryDslCombinedFieldsQuery` + +| Name | Type | Description | +| - | - | - | +| `auto_generate_synonyms_phrase_query` | boolean | If true, match phrase queries are automatically created for multi-term synonyms. | +| `fields` | [Field](./Field.md)[] | List of fields to search. Field wildcard patterns are allowed. Only `text` fields are supported, and they must all have the same search `analyzer`. | +| `minimum_should_match` | [MinimumShouldMatch](./MinimumShouldMatch.md) | Minimum number of clauses that must match for a document to be returned. | +| `operator` | [QueryDslCombinedFieldsOperator](./QueryDslCombinedFieldsOperator.md) | Boolean logic used to interpret text in the query value. | +| `query` | string | Text to search for in the provided `fields`. The `combined_fields` query analyzes the provided text before performing a search. | +| `zero_terms_query` | [QueryDslCombinedFieldsZeroTerms](./QueryDslCombinedFieldsZeroTerms.md) | Indicates whether no documents are returned if the analyzer removes all tokens, such as when using a `stop` filter. | diff --git a/docs/reference/api/QueryDslCombinedFieldsZeroTerms.md b/docs/reference/api/QueryDslCombinedFieldsZeroTerms.md new file mode 100644 index 000000000..6f213af2e --- /dev/null +++ b/docs/reference/api/QueryDslCombinedFieldsZeroTerms.md @@ -0,0 +1,4 @@ +## `QueryDslCombinedFieldsZeroTerms` +::: +type QueryDslCombinedFieldsZeroTerms = 'none' | 'all'; +::: diff --git a/docs/reference/api/QueryDslCommonTermsQuery.md b/docs/reference/api/QueryDslCommonTermsQuery.md new file mode 100644 index 000000000..0bd62e2a9 --- /dev/null +++ b/docs/reference/api/QueryDslCommonTermsQuery.md @@ -0,0 +1,10 @@ +## Interface `QueryDslCommonTermsQuery` + +| Name | Type | Description | +| - | - | - | +| `analyzer` | string |   | +| `cutoff_frequency` | [double](./double.md) |   | +| `high_freq_operator` | [QueryDslOperator](./QueryDslOperator.md) |   | +| `low_freq_operator` | [QueryDslOperator](./QueryDslOperator.md) |   | +| `minimum_should_match` | [MinimumShouldMatch](./MinimumShouldMatch.md) |   | +| `query` | string |   | diff --git a/docs/reference/api/QueryDslConstantScoreQuery.md b/docs/reference/api/QueryDslConstantScoreQuery.md new file mode 100644 index 000000000..5b4903bb2 --- /dev/null +++ b/docs/reference/api/QueryDslConstantScoreQuery.md @@ -0,0 +1,5 @@ +## Interface `QueryDslConstantScoreQuery` + +| Name | Type | Description | +| - | - | - | +| `filter` | [QueryDslQueryContainer](./QueryDslQueryContainer.md) | Filter query you wish to run. Any returned documents must match this query. Filter queries do not calculate relevance scores. To speed up performance, Elasticsearch automatically caches frequently used filter queries. | diff --git a/docs/reference/api/QueryDslDateDecayFunction.md b/docs/reference/api/QueryDslDateDecayFunction.md new file mode 100644 index 000000000..ce47688d6 --- /dev/null +++ b/docs/reference/api/QueryDslDateDecayFunction.md @@ -0,0 +1,4 @@ +## `QueryDslDateDecayFunction` +::: +type QueryDslDateDecayFunction = [QueryDslDateDecayFunctionKeys](./QueryDslDateDecayFunctionKeys.md) & { [property: string]: [QueryDslDecayPlacement](./QueryDslDecayPlacement.md) | [QueryDslMultiValueMode](./QueryDslMultiValueMode.md);}; +::: diff --git a/docs/reference/api/QueryDslDateDecayFunctionKeys.md b/docs/reference/api/QueryDslDateDecayFunctionKeys.md new file mode 100644 index 000000000..dab67c465 --- /dev/null +++ b/docs/reference/api/QueryDslDateDecayFunctionKeys.md @@ -0,0 +1,4 @@ +## Interface `QueryDslDateDecayFunctionKeys` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/QueryDslDateDistanceFeatureQuery.md b/docs/reference/api/QueryDslDateDistanceFeatureQuery.md new file mode 100644 index 000000000..ccef0b59e --- /dev/null +++ b/docs/reference/api/QueryDslDateDistanceFeatureQuery.md @@ -0,0 +1,4 @@ +## Interface `QueryDslDateDistanceFeatureQuery` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/QueryDslDateRangeQuery.md b/docs/reference/api/QueryDslDateRangeQuery.md new file mode 100644 index 000000000..ec38917f8 --- /dev/null +++ b/docs/reference/api/QueryDslDateRangeQuery.md @@ -0,0 +1,6 @@ +## Interface `QueryDslDateRangeQuery` + +| Name | Type | Description | +| - | - | - | +| `format` | [DateFormat](./DateFormat.md) | Date format used to convert `date` values in the query. | +| `time_zone` | [TimeZone](./TimeZone.md) | Coordinated Universal Time (UTC) offset or IANA time zone used to convert `date` values in the query to UTC. | diff --git a/docs/reference/api/QueryDslDecayFunction.md b/docs/reference/api/QueryDslDecayFunction.md new file mode 100644 index 000000000..055d9072b --- /dev/null +++ b/docs/reference/api/QueryDslDecayFunction.md @@ -0,0 +1,4 @@ +## `QueryDslDecayFunction` +::: +type QueryDslDecayFunction = [QueryDslUntypedDecayFunction](./QueryDslUntypedDecayFunction.md) | [QueryDslDateDecayFunction](./QueryDslDateDecayFunction.md) | [QueryDslNumericDecayFunction](./QueryDslNumericDecayFunction.md) | [QueryDslGeoDecayFunction](./QueryDslGeoDecayFunction.md); +::: diff --git a/docs/reference/api/QueryDslDecayFunctionBase.md b/docs/reference/api/QueryDslDecayFunctionBase.md new file mode 100644 index 000000000..ab72e7a4f --- /dev/null +++ b/docs/reference/api/QueryDslDecayFunctionBase.md @@ -0,0 +1,5 @@ +## Interface `QueryDslDecayFunctionBase` + +| Name | Type | Description | +| - | - | - | +| `multi_value_mode` | [QueryDslMultiValueMode](./QueryDslMultiValueMode.md) | Determines how the distance is calculated when a field used for computing the decay contains multiple values. | diff --git a/docs/reference/api/QueryDslDecayPlacement.md b/docs/reference/api/QueryDslDecayPlacement.md new file mode 100644 index 000000000..aba9faefa --- /dev/null +++ b/docs/reference/api/QueryDslDecayPlacement.md @@ -0,0 +1,8 @@ +## Interface `QueryDslDecayPlacement` + +| Name | Type | Description | +| - | - | - | +| `decay` | [double](./double.md) | Defines how documents are scored at the distance given at scale. | +| `offset` | TScale | If defined, the decay function will only compute the decay function for documents with a distance greater than the defined `offset`. | +| `origin` | TOrigin | The point of origin used for calculating distance. Must be given as a number for numeric field, date for date fields and geo point for geo fields. | +| `scale` | TScale | Defines the distance from origin + offset at which the computed score will equal `decay` parameter. | diff --git a/docs/reference/api/QueryDslDisMaxQuery.md b/docs/reference/api/QueryDslDisMaxQuery.md new file mode 100644 index 000000000..f43f07334 --- /dev/null +++ b/docs/reference/api/QueryDslDisMaxQuery.md @@ -0,0 +1,6 @@ +## Interface `QueryDslDisMaxQuery` + +| Name | Type | Description | +| - | - | - | +| `queries` | [QueryDslQueryContainer](./QueryDslQueryContainer.md)[] | One or more query clauses. Returned documents must match one or more of these queries. If a document matches multiple queries, Elasticsearch uses the highest relevance score. | +| `tie_breaker` | [double](./double.md) | Floating point number between 0 and 1.0 used to increase the relevance scores of documents matching multiple query clauses. | diff --git a/docs/reference/api/QueryDslDistanceFeatureQuery.md b/docs/reference/api/QueryDslDistanceFeatureQuery.md new file mode 100644 index 000000000..a96c84028 --- /dev/null +++ b/docs/reference/api/QueryDslDistanceFeatureQuery.md @@ -0,0 +1,4 @@ +## `QueryDslDistanceFeatureQuery` +::: +type QueryDslDistanceFeatureQuery = [QueryDslUntypedDistanceFeatureQuery](./QueryDslUntypedDistanceFeatureQuery.md) | [QueryDslGeoDistanceFeatureQuery](./QueryDslGeoDistanceFeatureQuery.md) | [QueryDslDateDistanceFeatureQuery](./QueryDslDateDistanceFeatureQuery.md); +::: diff --git a/docs/reference/api/QueryDslDistanceFeatureQueryBase.md b/docs/reference/api/QueryDslDistanceFeatureQueryBase.md new file mode 100644 index 000000000..22891edda --- /dev/null +++ b/docs/reference/api/QueryDslDistanceFeatureQueryBase.md @@ -0,0 +1,7 @@ +## Interface `QueryDslDistanceFeatureQueryBase` + +| Name | Type | Description | +| - | - | - | +| `field` | [Field](./Field.md) | Name of the field used to calculate distances. This field must meet the following criteria: be a `date`, `date_nanos` or `geo_point` field; have an `index` mapping parameter value of `true`, which is the default; have an `doc_values` mapping parameter value of `true`, which is the default. | +| `origin` | TOrigin | Date or point of origin used to calculate distances. If the `field` value is a `date` or `date_nanos` field, the `origin` value must be a date. Date Math, such as `now-1h`, is supported. If the field value is a `geo_point` field, the `origin` value must be a geopoint. | +| `pivot` | TDistance | Distance from the `origin` at which relevance scores receive half of the `boost` value. If the `field` value is a `date` or `date_nanos` field, the `pivot` value must be a time unit, such as `1h` or `10d`. If the `field` value is a `geo_point` field, the `pivot` value must be a distance unit, such as `1km` or `12m`. | diff --git a/docs/reference/api/QueryDslExistsQuery.md b/docs/reference/api/QueryDslExistsQuery.md new file mode 100644 index 000000000..b987aa498 --- /dev/null +++ b/docs/reference/api/QueryDslExistsQuery.md @@ -0,0 +1,5 @@ +## Interface `QueryDslExistsQuery` + +| Name | Type | Description | +| - | - | - | +| `field` | [Field](./Field.md) | Name of the field you wish to search. | diff --git a/docs/reference/api/QueryDslFieldAndFormat.md b/docs/reference/api/QueryDslFieldAndFormat.md new file mode 100644 index 000000000..d9d12f67f --- /dev/null +++ b/docs/reference/api/QueryDslFieldAndFormat.md @@ -0,0 +1,7 @@ +## Interface `QueryDslFieldAndFormat` + +| Name | Type | Description | +| - | - | - | +| `field` | [Field](./Field.md) | A wildcard pattern. The request returns values for field names matching this pattern. | +| `format` | string | The format in which the values are returned. | +| `include_unmapped` | boolean |   | diff --git a/docs/reference/api/QueryDslFieldLookup.md b/docs/reference/api/QueryDslFieldLookup.md new file mode 100644 index 000000000..9ffaf6681 --- /dev/null +++ b/docs/reference/api/QueryDslFieldLookup.md @@ -0,0 +1,8 @@ +## Interface `QueryDslFieldLookup` + +| Name | Type | Description | +| - | - | - | +| `id` | [Id](./Id.md) | `id` of the document. | +| `index` | [IndexName](./IndexName.md) | Index from which to retrieve the document. | +| `path` | [Field](./Field.md) | Name of the field. | +| `routing` | [Routing](./Routing.md) | Custom routing value. | diff --git a/docs/reference/api/QueryDslFieldValueFactorModifier.md b/docs/reference/api/QueryDslFieldValueFactorModifier.md new file mode 100644 index 000000000..19064d5cc --- /dev/null +++ b/docs/reference/api/QueryDslFieldValueFactorModifier.md @@ -0,0 +1,4 @@ +## `QueryDslFieldValueFactorModifier` +::: +type QueryDslFieldValueFactorModifier = 'none' | 'log' | 'log1p' | 'log2p' | 'ln' | 'ln1p' | 'ln2p' | 'square' | 'sqrt' | 'reciprocal'; +::: diff --git a/docs/reference/api/QueryDslFieldValueFactorScoreFunction.md b/docs/reference/api/QueryDslFieldValueFactorScoreFunction.md new file mode 100644 index 000000000..e1301fcec --- /dev/null +++ b/docs/reference/api/QueryDslFieldValueFactorScoreFunction.md @@ -0,0 +1,8 @@ +## Interface `QueryDslFieldValueFactorScoreFunction` + +| Name | Type | Description | +| - | - | - | +| `factor` | [double](./double.md) | Optional factor to multiply the field value with. | +| `field` | [Field](./Field.md) | Field to be extracted from the document. | +| `missing` | [double](./double.md) | Value used if the document doesn’t have that field. The modifier and factor are still applied to it as though it were read from the document. | +| `modifier` | [QueryDslFieldValueFactorModifier](./QueryDslFieldValueFactorModifier.md) | Modifier to apply to the field value. | diff --git a/docs/reference/api/QueryDslFunctionBoostMode.md b/docs/reference/api/QueryDslFunctionBoostMode.md new file mode 100644 index 000000000..f7e924786 --- /dev/null +++ b/docs/reference/api/QueryDslFunctionBoostMode.md @@ -0,0 +1,4 @@ +## `QueryDslFunctionBoostMode` +::: +type QueryDslFunctionBoostMode = 'multiply' | 'replace' | 'sum' | 'avg' | 'max' | 'min'; +::: diff --git a/docs/reference/api/QueryDslFunctionScoreContainer.md b/docs/reference/api/QueryDslFunctionScoreContainer.md new file mode 100644 index 000000000..bda3740e2 --- /dev/null +++ b/docs/reference/api/QueryDslFunctionScoreContainer.md @@ -0,0 +1,12 @@ +## Interface `QueryDslFunctionScoreContainer` + +| Name | Type | Description | +| - | - | - | +| `exp` | [QueryDslDecayFunction](./QueryDslDecayFunction.md) | Function that scores a document with a exponential decay, depending on the distance of a numeric field value of the document from an origin. | +| `field_value_factor` | [QueryDslFieldValueFactorScoreFunction](./QueryDslFieldValueFactorScoreFunction.md) | Function allows you to use a field from a document to influence the score. It’s similar to using the script_score function, however, it avoids the overhead of scripting. | +| `filter` | [QueryDslQueryContainer](./QueryDslQueryContainer.md) |   | +| `gauss` | [QueryDslDecayFunction](./QueryDslDecayFunction.md) | Function that scores a document with a normal decay, depending on the distance of a numeric field value of the document from an origin. | +| `linear` | [QueryDslDecayFunction](./QueryDslDecayFunction.md) | Function that scores a document with a linear decay, depending on the distance of a numeric field value of the document from an origin. | +| `random_score` | [QueryDslRandomScoreFunction](./QueryDslRandomScoreFunction.md) | Generates scores that are uniformly distributed from 0 up to but not including 1. In case you want scores to be reproducible, it is possible to provide a `seed` and `field`. | +| `script_score` | [QueryDslScriptScoreFunction](./QueryDslScriptScoreFunction.md) | Enables you to wrap another query and customize the scoring of it optionally with a computation derived from other numeric field values in the doc using a script expression. | +| `weight` | [double](./double.md) |   | diff --git a/docs/reference/api/QueryDslFunctionScoreMode.md b/docs/reference/api/QueryDslFunctionScoreMode.md new file mode 100644 index 000000000..284ace0c5 --- /dev/null +++ b/docs/reference/api/QueryDslFunctionScoreMode.md @@ -0,0 +1,4 @@ +## `QueryDslFunctionScoreMode` +::: +type QueryDslFunctionScoreMode = 'multiply' | 'sum' | 'avg' | 'first' | 'max' | 'min'; +::: diff --git a/docs/reference/api/QueryDslFunctionScoreQuery.md b/docs/reference/api/QueryDslFunctionScoreQuery.md new file mode 100644 index 000000000..89565c9a3 --- /dev/null +++ b/docs/reference/api/QueryDslFunctionScoreQuery.md @@ -0,0 +1,10 @@ +## Interface `QueryDslFunctionScoreQuery` + +| Name | Type | Description | +| - | - | - | +| `boost_mode` | [QueryDslFunctionBoostMode](./QueryDslFunctionBoostMode.md) | Defines how he newly computed score is combined with the score of the query | +| `functions` | [QueryDslFunctionScoreContainer](./QueryDslFunctionScoreContainer.md)[] | One or more functions that compute a new score for each document returned by the query. | +| `max_boost` | [double](./double.md) | Restricts the new score to not exceed the provided limit. | +| `min_score` | [double](./double.md) | Excludes documents that do not meet the provided score threshold. | +| `query` | [QueryDslQueryContainer](./QueryDslQueryContainer.md) | A query that determines the documents for which a new score is computed. | +| `score_mode` | [QueryDslFunctionScoreMode](./QueryDslFunctionScoreMode.md) | Specifies how the computed scores are combined | diff --git a/docs/reference/api/QueryDslFuzzyQuery.md b/docs/reference/api/QueryDslFuzzyQuery.md new file mode 100644 index 000000000..6abc1d473 --- /dev/null +++ b/docs/reference/api/QueryDslFuzzyQuery.md @@ -0,0 +1,10 @@ +## Interface `QueryDslFuzzyQuery` + +| Name | Type | Description | +| - | - | - | +| `fuzziness` | [Fuzziness](./Fuzziness.md) | Maximum edit distance allowed for matching. | +| `max_expansions` | [integer](./integer.md) | Maximum number of variations created. | +| `prefix_length` | [integer](./integer.md) | Number of beginning characters left unchanged when creating expansions. | +| `rewrite` | [MultiTermQueryRewrite](./MultiTermQueryRewrite.md) | Number of beginning characters left unchanged when creating expansions. | +| `transpositions` | boolean | Indicates whether edits include transpositions of two adjacent characters (for example `ab` to `ba`). | +| `value` | string | [double](./double.md) | boolean | Term you wish to find in the provided field. | diff --git a/docs/reference/api/QueryDslGeoBoundingBoxQuery.md b/docs/reference/api/QueryDslGeoBoundingBoxQuery.md new file mode 100644 index 000000000..416a4cebc --- /dev/null +++ b/docs/reference/api/QueryDslGeoBoundingBoxQuery.md @@ -0,0 +1,4 @@ +## `QueryDslGeoBoundingBoxQuery` +::: +type QueryDslGeoBoundingBoxQuery = [QueryDslGeoBoundingBoxQueryKeys](./QueryDslGeoBoundingBoxQueryKeys.md) & { [property: string]: [GeoBounds](./GeoBounds.md) | [QueryDslGeoExecution](./QueryDslGeoExecution.md) | [QueryDslGeoValidationMethod](./QueryDslGeoValidationMethod.md) | boolean | [float](./float.md) | string;}; +::: diff --git a/docs/reference/api/QueryDslGeoBoundingBoxQueryKeys.md b/docs/reference/api/QueryDslGeoBoundingBoxQueryKeys.md new file mode 100644 index 000000000..eb586bc46 --- /dev/null +++ b/docs/reference/api/QueryDslGeoBoundingBoxQueryKeys.md @@ -0,0 +1,7 @@ +## Interface `QueryDslGeoBoundingBoxQueryKeys` + +| Name | Type | Description | +| - | - | - | +| `ignore_unmapped` | boolean | Set to `true` to ignore an unmapped field and not match any documents for this query. Set to `false` to throw an exception if the field is not mapped. | +| `type` | [QueryDslGeoExecution](./QueryDslGeoExecution.md) |   | +| `validation_method` | [QueryDslGeoValidationMethod](./QueryDslGeoValidationMethod.md) | Set to `IGNORE_MALFORMED` to accept geo points with invalid latitude or longitude. Set to `COERCE` to also try to infer correct latitude or longitude. | diff --git a/docs/reference/api/QueryDslGeoDecayFunction.md b/docs/reference/api/QueryDslGeoDecayFunction.md new file mode 100644 index 000000000..cf76454da --- /dev/null +++ b/docs/reference/api/QueryDslGeoDecayFunction.md @@ -0,0 +1,4 @@ +## `QueryDslGeoDecayFunction` +::: +type QueryDslGeoDecayFunction = [QueryDslGeoDecayFunctionKeys](./QueryDslGeoDecayFunctionKeys.md) & { [property: string]: [QueryDslDecayPlacement](./QueryDslDecayPlacement.md) | [QueryDslMultiValueMode](./QueryDslMultiValueMode.md);}; +::: diff --git a/docs/reference/api/QueryDslGeoDecayFunctionKeys.md b/docs/reference/api/QueryDslGeoDecayFunctionKeys.md new file mode 100644 index 000000000..7927a0282 --- /dev/null +++ b/docs/reference/api/QueryDslGeoDecayFunctionKeys.md @@ -0,0 +1,4 @@ +## Interface `QueryDslGeoDecayFunctionKeys` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/QueryDslGeoDistanceFeatureQuery.md b/docs/reference/api/QueryDslGeoDistanceFeatureQuery.md new file mode 100644 index 000000000..ae4810131 --- /dev/null +++ b/docs/reference/api/QueryDslGeoDistanceFeatureQuery.md @@ -0,0 +1,4 @@ +## Interface `QueryDslGeoDistanceFeatureQuery` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/QueryDslGeoDistanceQuery.md b/docs/reference/api/QueryDslGeoDistanceQuery.md new file mode 100644 index 000000000..488d67af7 --- /dev/null +++ b/docs/reference/api/QueryDslGeoDistanceQuery.md @@ -0,0 +1,4 @@ +## `QueryDslGeoDistanceQuery` +::: +type QueryDslGeoDistanceQuery = [QueryDslGeoDistanceQueryKeys](./QueryDslGeoDistanceQueryKeys.md) & { [property: string]: [GeoLocation](./GeoLocation.md) | [Distance](./Distance.md) | [GeoDistanceType](./GeoDistanceType.md) | [QueryDslGeoValidationMethod](./QueryDslGeoValidationMethod.md) | boolean | [float](./float.md) | string;}; +::: diff --git a/docs/reference/api/QueryDslGeoDistanceQueryKeys.md b/docs/reference/api/QueryDslGeoDistanceQueryKeys.md new file mode 100644 index 000000000..6f76eceaf --- /dev/null +++ b/docs/reference/api/QueryDslGeoDistanceQueryKeys.md @@ -0,0 +1,8 @@ +## Interface `QueryDslGeoDistanceQueryKeys` + +| Name | Type | Description | +| - | - | - | +| `distance_type` | [GeoDistanceType](./GeoDistanceType.md) | How to compute the distance. Set to `plane` for a faster calculation that's inaccurate on long distances and close to the poles. | +| `distance` | [Distance](./Distance.md) | The radius of the circle centred on the specified location. Points which fall into this circle are considered to be matches. | +| `ignore_unmapped` | boolean | Set to `true` to ignore an unmapped field and not match any documents for this query. Set to `false` to throw an exception if the field is not mapped. | +| `validation_method` | [QueryDslGeoValidationMethod](./QueryDslGeoValidationMethod.md) | Set to `IGNORE_MALFORMED` to accept geo points with invalid latitude or longitude. Set to `COERCE` to also try to infer correct latitude or longitude. | diff --git a/docs/reference/api/QueryDslGeoExecution.md b/docs/reference/api/QueryDslGeoExecution.md new file mode 100644 index 000000000..9e60f058c --- /dev/null +++ b/docs/reference/api/QueryDslGeoExecution.md @@ -0,0 +1,4 @@ +## `QueryDslGeoExecution` +::: +type QueryDslGeoExecution = 'memory' | 'indexed'; +::: diff --git a/docs/reference/api/QueryDslGeoGridQuery.md b/docs/reference/api/QueryDslGeoGridQuery.md new file mode 100644 index 000000000..d61e43fbf --- /dev/null +++ b/docs/reference/api/QueryDslGeoGridQuery.md @@ -0,0 +1,7 @@ +## Interface `QueryDslGeoGridQuery` + +| Name | Type | Description | +| - | - | - | +| `geogrid` | [GeoTile](./GeoTile.md) |   | +| `geohash` | [GeoHash](./GeoHash.md) |   | +| `geohex` | [GeoHexCell](./GeoHexCell.md) |   | diff --git a/docs/reference/api/QueryDslGeoPolygonPoints.md b/docs/reference/api/QueryDslGeoPolygonPoints.md new file mode 100644 index 000000000..c50fbc27a --- /dev/null +++ b/docs/reference/api/QueryDslGeoPolygonPoints.md @@ -0,0 +1,5 @@ +## Interface `QueryDslGeoPolygonPoints` + +| Name | Type | Description | +| - | - | - | +| `points` | [GeoLocation](./GeoLocation.md)[] |   | diff --git a/docs/reference/api/QueryDslGeoPolygonQuery.md b/docs/reference/api/QueryDslGeoPolygonQuery.md new file mode 100644 index 000000000..a937d81db --- /dev/null +++ b/docs/reference/api/QueryDslGeoPolygonQuery.md @@ -0,0 +1,4 @@ +## `QueryDslGeoPolygonQuery` +::: +type QueryDslGeoPolygonQuery = [QueryDslGeoPolygonQueryKeys](./QueryDslGeoPolygonQueryKeys.md) & { [property: string]: [QueryDslGeoPolygonPoints](./QueryDslGeoPolygonPoints.md) | [QueryDslGeoValidationMethod](./QueryDslGeoValidationMethod.md) | boolean | [float](./float.md) | string;}; +::: diff --git a/docs/reference/api/QueryDslGeoPolygonQueryKeys.md b/docs/reference/api/QueryDslGeoPolygonQueryKeys.md new file mode 100644 index 000000000..3938aa3ee --- /dev/null +++ b/docs/reference/api/QueryDslGeoPolygonQueryKeys.md @@ -0,0 +1,6 @@ +## Interface `QueryDslGeoPolygonQueryKeys` + +| Name | Type | Description | +| - | - | - | +| `ignore_unmapped` | boolean |   | +| `validation_method` | [QueryDslGeoValidationMethod](./QueryDslGeoValidationMethod.md) |   | diff --git a/docs/reference/api/QueryDslGeoShapeFieldQuery.md b/docs/reference/api/QueryDslGeoShapeFieldQuery.md new file mode 100644 index 000000000..c00672cbe --- /dev/null +++ b/docs/reference/api/QueryDslGeoShapeFieldQuery.md @@ -0,0 +1,7 @@ +## Interface `QueryDslGeoShapeFieldQuery` + +| Name | Type | Description | +| - | - | - | +| `indexed_shape` | [QueryDslFieldLookup](./QueryDslFieldLookup.md) | Query using an indexed shape retrieved from the the specified document and path. | +| `relation` | [GeoShapeRelation](./GeoShapeRelation.md) | Spatial relation operator used to search a geo field. | +| `shape` | [GeoShape](./GeoShape.md) |   | diff --git a/docs/reference/api/QueryDslGeoShapeQuery.md b/docs/reference/api/QueryDslGeoShapeQuery.md new file mode 100644 index 000000000..09192b368 --- /dev/null +++ b/docs/reference/api/QueryDslGeoShapeQuery.md @@ -0,0 +1,4 @@ +## `QueryDslGeoShapeQuery` +::: +type QueryDslGeoShapeQuery = [QueryDslGeoShapeQueryKeys](./QueryDslGeoShapeQueryKeys.md) & { [property: string]: [QueryDslGeoShapeFieldQuery](./QueryDslGeoShapeFieldQuery.md) | boolean | [float](./float.md) | string;}; +::: diff --git a/docs/reference/api/QueryDslGeoShapeQueryKeys.md b/docs/reference/api/QueryDslGeoShapeQueryKeys.md new file mode 100644 index 000000000..246c0a952 --- /dev/null +++ b/docs/reference/api/QueryDslGeoShapeQueryKeys.md @@ -0,0 +1,5 @@ +## Interface `QueryDslGeoShapeQueryKeys` + +| Name | Type | Description | +| - | - | - | +| `ignore_unmapped` | boolean | Set to `true` to ignore an unmapped field and not match any documents for this query. Set to `false` to throw an exception if the field is not mapped. | diff --git a/docs/reference/api/QueryDslGeoValidationMethod.md b/docs/reference/api/QueryDslGeoValidationMethod.md new file mode 100644 index 000000000..3eff8fa0e --- /dev/null +++ b/docs/reference/api/QueryDslGeoValidationMethod.md @@ -0,0 +1,4 @@ +## `QueryDslGeoValidationMethod` +::: +type QueryDslGeoValidationMethod = 'coerce' | 'ignore_malformed' | 'strict'; +::: diff --git a/docs/reference/api/QueryDslHasChildQuery.md b/docs/reference/api/QueryDslHasChildQuery.md new file mode 100644 index 000000000..1b58bcd0c --- /dev/null +++ b/docs/reference/api/QueryDslHasChildQuery.md @@ -0,0 +1,11 @@ +## Interface `QueryDslHasChildQuery` + +| Name | Type | Description | +| - | - | - | +| `ignore_unmapped` | boolean | Indicates whether to ignore an unmapped `type` and not return any documents instead of an error. | +| `inner_hits` | [SearchInnerHits](./SearchInnerHits.md) | If defined, each search hit will contain inner hits. | +| `max_children` | [integer](./integer.md) | Maximum number of child documents that match the query allowed for a returned parent document. If the parent document exceeds this limit, it is excluded from the search results. | +| `min_children` | [integer](./integer.md) | Minimum number of child documents that match the query required to match the query for a returned parent document. If the parent document does not meet this limit, it is excluded from the search results. | +| `query` | [QueryDslQueryContainer](./QueryDslQueryContainer.md) | Query you wish to run on child documents of the `type` field. If a child document matches the search, the query returns the parent document. | +| `score_mode` | [QueryDslChildScoreMode](./QueryDslChildScoreMode.md) | Indicates how scores for matching child documents affect the root parent document’s relevance score. | +| `type` | [RelationName](./RelationName.md) | Name of the child relationship mapped for the `join` field. | diff --git a/docs/reference/api/QueryDslHasParentQuery.md b/docs/reference/api/QueryDslHasParentQuery.md new file mode 100644 index 000000000..bf3c90a17 --- /dev/null +++ b/docs/reference/api/QueryDslHasParentQuery.md @@ -0,0 +1,9 @@ +## Interface `QueryDslHasParentQuery` + +| Name | Type | Description | +| - | - | - | +| `ignore_unmapped` | boolean | Indicates whether to ignore an unmapped `parent_type` and not return any documents instead of an error. You can use this parameter to query multiple indices that may not contain the `parent_type`. | +| `inner_hits` | [SearchInnerHits](./SearchInnerHits.md) | If defined, each search hit will contain inner hits. | +| `parent_type` | [RelationName](./RelationName.md) | Name of the parent relationship mapped for the `join` field. | +| `query` | [QueryDslQueryContainer](./QueryDslQueryContainer.md) | Query you wish to run on parent documents of the `parent_type` field. If a parent document matches the search, the query returns its child documents. | +| `score` | boolean | Indicates whether the relevance score of a matching parent document is aggregated into its child documents. | diff --git a/docs/reference/api/QueryDslIdsQuery.md b/docs/reference/api/QueryDslIdsQuery.md new file mode 100644 index 000000000..c8533b947 --- /dev/null +++ b/docs/reference/api/QueryDslIdsQuery.md @@ -0,0 +1,5 @@ +## Interface `QueryDslIdsQuery` + +| Name | Type | Description | +| - | - | - | +| `values` | [Ids](./Ids.md) | An array of document IDs. | diff --git a/docs/reference/api/QueryDslIntervalsAllOf.md b/docs/reference/api/QueryDslIntervalsAllOf.md new file mode 100644 index 000000000..c8bb7cfdf --- /dev/null +++ b/docs/reference/api/QueryDslIntervalsAllOf.md @@ -0,0 +1,8 @@ +## Interface `QueryDslIntervalsAllOf` + +| Name | Type | Description | +| - | - | - | +| `filter` | [QueryDslIntervalsFilter](./QueryDslIntervalsFilter.md) | Rule used to filter returned intervals. | +| `intervals` | [QueryDslIntervalsContainer](./QueryDslIntervalsContainer.md)[] | An array of rules to combine. All rules must produce a match in a document for the overall source to match. | +| `max_gaps` | [integer](./integer.md) | Maximum number of positions between the matching terms. Intervals produced by the rules further apart than this are not considered matches. | +| `ordered` | boolean | If `true`, intervals produced by the rules should appear in the order in which they are specified. | diff --git a/docs/reference/api/QueryDslIntervalsAnyOf.md b/docs/reference/api/QueryDslIntervalsAnyOf.md new file mode 100644 index 000000000..01889ffa3 --- /dev/null +++ b/docs/reference/api/QueryDslIntervalsAnyOf.md @@ -0,0 +1,6 @@ +## Interface `QueryDslIntervalsAnyOf` + +| Name | Type | Description | +| - | - | - | +| `filter` | [QueryDslIntervalsFilter](./QueryDslIntervalsFilter.md) | Rule used to filter returned intervals. | +| `intervals` | [QueryDslIntervalsContainer](./QueryDslIntervalsContainer.md)[] | An array of rules to match. | diff --git a/docs/reference/api/QueryDslIntervalsContainer.md b/docs/reference/api/QueryDslIntervalsContainer.md new file mode 100644 index 000000000..310a445fc --- /dev/null +++ b/docs/reference/api/QueryDslIntervalsContainer.md @@ -0,0 +1,10 @@ +## Interface `QueryDslIntervalsContainer` + +| Name | Type | Description | +| - | - | - | +| `all_of` | [QueryDslIntervalsAllOf](./QueryDslIntervalsAllOf.md) | Returns matches that span a combination of other rules. | +| `any_of` | [QueryDslIntervalsAnyOf](./QueryDslIntervalsAnyOf.md) | Returns intervals produced by any of its sub-rules. | +| `fuzzy` | [QueryDslIntervalsFuzzy](./QueryDslIntervalsFuzzy.md) | Matches analyzed text. | +| `match` | [QueryDslIntervalsMatch](./QueryDslIntervalsMatch.md) | Matches analyzed text. | +| `prefix` | [QueryDslIntervalsPrefix](./QueryDslIntervalsPrefix.md) | Matches terms that start with a specified set of characters. | +| `wildcard` | [QueryDslIntervalsWildcard](./QueryDslIntervalsWildcard.md) | Matches terms using a wildcard pattern. | diff --git a/docs/reference/api/QueryDslIntervalsFilter.md b/docs/reference/api/QueryDslIntervalsFilter.md new file mode 100644 index 000000000..1a0638988 --- /dev/null +++ b/docs/reference/api/QueryDslIntervalsFilter.md @@ -0,0 +1,13 @@ +## Interface `QueryDslIntervalsFilter` + +| Name | Type | Description | +| - | - | - | +| `after` | [QueryDslIntervalsContainer](./QueryDslIntervalsContainer.md) | Query used to return intervals that follow an interval from the `filter` rule. | +| `before` | [QueryDslIntervalsContainer](./QueryDslIntervalsContainer.md) | Query used to return intervals that occur before an interval from the `filter` rule. | +| `contained_by` | [QueryDslIntervalsContainer](./QueryDslIntervalsContainer.md) | Query used to return intervals contained by an interval from the `filter` rule. | +| `containing` | [QueryDslIntervalsContainer](./QueryDslIntervalsContainer.md) | Query used to return intervals that contain an interval from the `filter` rule. | +| `not_contained_by` | [QueryDslIntervalsContainer](./QueryDslIntervalsContainer.md) | Query used to return intervals that are **not** contained by an interval from the `filter` rule. | +| `not_containing` | [QueryDslIntervalsContainer](./QueryDslIntervalsContainer.md) | Query used to return intervals that do **not** contain an interval from the `filter` rule. | +| `not_overlapping` | [QueryDslIntervalsContainer](./QueryDslIntervalsContainer.md) | Query used to return intervals that do **not** overlap with an interval from the `filter` rule. | +| `overlapping` | [QueryDslIntervalsContainer](./QueryDslIntervalsContainer.md) | Query used to return intervals that overlap with an interval from the `filter` rule. | +| `script` | [Script](./Script.md) | [ScriptSource](./ScriptSource.md) | Script used to return matching documents. This script must return a boolean value: `true` or `false`. | diff --git a/docs/reference/api/QueryDslIntervalsFuzzy.md b/docs/reference/api/QueryDslIntervalsFuzzy.md new file mode 100644 index 000000000..79abf2011 --- /dev/null +++ b/docs/reference/api/QueryDslIntervalsFuzzy.md @@ -0,0 +1,10 @@ +## Interface `QueryDslIntervalsFuzzy` + +| Name | Type | Description | +| - | - | - | +| `analyzer` | string | Analyzer used to normalize the term. | +| `fuzziness` | [Fuzziness](./Fuzziness.md) | Maximum edit distance allowed for matching. | +| `prefix_length` | [integer](./integer.md) | Number of beginning characters left unchanged when creating expansions. | +| `term` | string | The term to match. | +| `transpositions` | boolean | Indicates whether edits include transpositions of two adjacent characters (for example, `ab` to `ba`). | +| `use_field` | [Field](./Field.md) | If specified, match intervals from this field rather than the top-level field. The `term` is normalized using the search analyzer from this field, unless `analyzer` is specified separately. | diff --git a/docs/reference/api/QueryDslIntervalsMatch.md b/docs/reference/api/QueryDslIntervalsMatch.md new file mode 100644 index 000000000..321f1de0c --- /dev/null +++ b/docs/reference/api/QueryDslIntervalsMatch.md @@ -0,0 +1,10 @@ +## Interface `QueryDslIntervalsMatch` + +| Name | Type | Description | +| - | - | - | +| `analyzer` | string | Analyzer used to analyze terms in the query. | +| `filter` | [QueryDslIntervalsFilter](./QueryDslIntervalsFilter.md) | An optional interval filter. | +| `max_gaps` | [integer](./integer.md) | Maximum number of positions between the matching terms. Terms further apart than this are not considered matches. | +| `ordered` | boolean | If `true`, matching terms must appear in their specified order. | +| `query` | string | Text you wish to find in the provided field. | +| `use_field` | [Field](./Field.md) | If specified, match intervals from this field rather than the top-level field. The `term` is normalized using the search analyzer from this field, unless `analyzer` is specified separately. | diff --git a/docs/reference/api/QueryDslIntervalsPrefix.md b/docs/reference/api/QueryDslIntervalsPrefix.md new file mode 100644 index 000000000..41f14d3fa --- /dev/null +++ b/docs/reference/api/QueryDslIntervalsPrefix.md @@ -0,0 +1,7 @@ +## Interface `QueryDslIntervalsPrefix` + +| Name | Type | Description | +| - | - | - | +| `analyzer` | string | Analyzer used to analyze the `prefix`. | +| `prefix` | string | Beginning characters of terms you wish to find in the top-level field. | +| `use_field` | [Field](./Field.md) | If specified, match intervals from this field rather than the top-level field. The `prefix` is normalized using the search analyzer from this field, unless `analyzer` is specified separately. | diff --git a/docs/reference/api/QueryDslIntervalsQuery.md b/docs/reference/api/QueryDslIntervalsQuery.md new file mode 100644 index 000000000..bec8891c1 --- /dev/null +++ b/docs/reference/api/QueryDslIntervalsQuery.md @@ -0,0 +1,10 @@ +## Interface `QueryDslIntervalsQuery` + +| Name | Type | Description | +| - | - | - | +| `all_of` | [QueryDslIntervalsAllOf](./QueryDslIntervalsAllOf.md) | Returns matches that span a combination of other rules. | +| `any_of` | [QueryDslIntervalsAnyOf](./QueryDslIntervalsAnyOf.md) | Returns intervals produced by any of its sub-rules. | +| `fuzzy` | [QueryDslIntervalsFuzzy](./QueryDslIntervalsFuzzy.md) | Matches terms that are similar to the provided term, within an edit distance defined by `fuzziness`. | +| `match` | [QueryDslIntervalsMatch](./QueryDslIntervalsMatch.md) | Matches analyzed text. | +| `prefix` | [QueryDslIntervalsPrefix](./QueryDslIntervalsPrefix.md) | Matches terms that start with a specified set of characters. | +| `wildcard` | [QueryDslIntervalsWildcard](./QueryDslIntervalsWildcard.md) | Matches terms using a wildcard pattern. | diff --git a/docs/reference/api/QueryDslIntervalsWildcard.md b/docs/reference/api/QueryDslIntervalsWildcard.md new file mode 100644 index 000000000..910629b23 --- /dev/null +++ b/docs/reference/api/QueryDslIntervalsWildcard.md @@ -0,0 +1,7 @@ +## Interface `QueryDslIntervalsWildcard` + +| Name | Type | Description | +| - | - | - | +| `analyzer` | string | Analyzer used to analyze the `pattern`. Defaults to the top-level field's analyzer. | +| `pattern` | string | Wildcard pattern used to find matching terms. | +| `use_field` | [Field](./Field.md) | If specified, match intervals from this field rather than the top-level field. The `pattern` is normalized using the search analyzer from this field, unless `analyzer` is specified separately. | diff --git a/docs/reference/api/QueryDslLike.md b/docs/reference/api/QueryDslLike.md new file mode 100644 index 000000000..97d607d51 --- /dev/null +++ b/docs/reference/api/QueryDslLike.md @@ -0,0 +1,4 @@ +## `QueryDslLike` +::: +type QueryDslLike = string | [QueryDslLikeDocument](./QueryDslLikeDocument.md); +::: diff --git a/docs/reference/api/QueryDslLikeDocument.md b/docs/reference/api/QueryDslLikeDocument.md new file mode 100644 index 000000000..a57ae730e --- /dev/null +++ b/docs/reference/api/QueryDslLikeDocument.md @@ -0,0 +1,12 @@ +## Interface `QueryDslLikeDocument` + +| Name | Type | Description | +| - | - | - | +| `_id` | [Id](./Id.md) | ID of a document. | +| `_index` | [IndexName](./IndexName.md) | Index of a document. | +| `doc` | any | A document not present in the index. | +| `fields` | [Field](./Field.md)[] |   | +| `per_field_analyzer` | Record<[Field](./Field.md), string> | Overrides the default analyzer. | +| `routing` | [Routing](./Routing.md) |   | +| `version_type` | [VersionType](./VersionType.md) |   | +| `version` | [VersionNumber](./VersionNumber.md) |   | diff --git a/docs/reference/api/QueryDslMatchAllQuery.md b/docs/reference/api/QueryDslMatchAllQuery.md new file mode 100644 index 000000000..1d590e5ee --- /dev/null +++ b/docs/reference/api/QueryDslMatchAllQuery.md @@ -0,0 +1,4 @@ +## Interface `QueryDslMatchAllQuery` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/QueryDslMatchBoolPrefixQuery.md b/docs/reference/api/QueryDslMatchBoolPrefixQuery.md new file mode 100644 index 000000000..336631993 --- /dev/null +++ b/docs/reference/api/QueryDslMatchBoolPrefixQuery.md @@ -0,0 +1,13 @@ +## Interface `QueryDslMatchBoolPrefixQuery` + +| Name | Type | Description | +| - | - | - | +| `analyzer` | string | Analyzer used to convert the text in the query value into tokens. | +| `fuzziness` | [Fuzziness](./Fuzziness.md) | Maximum edit distance allowed for matching. Can be applied to the term subqueries constructed for all terms but the final term. | +| `fuzzy_rewrite` | [MultiTermQueryRewrite](./MultiTermQueryRewrite.md) | Method used to rewrite the query. Can be applied to the term subqueries constructed for all terms but the final term. | +| `fuzzy_transpositions` | boolean | If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`). Can be applied to the term subqueries constructed for all terms but the final term. | +| `max_expansions` | [integer](./integer.md) | Maximum number of terms to which the query will expand. Can be applied to the term subqueries constructed for all terms but the final term. | +| `minimum_should_match` | [MinimumShouldMatch](./MinimumShouldMatch.md) | Minimum number of clauses that must match for a document to be returned. Applied to the constructed bool query. | +| `operator` | [QueryDslOperator](./QueryDslOperator.md) | Boolean logic used to interpret text in the query value. Applied to the constructed bool query. | +| `prefix_length` | [integer](./integer.md) | Number of beginning characters left unchanged for fuzzy matching. Can be applied to the term subqueries constructed for all terms but the final term. | +| `query` | string | Terms you wish to find in the provided field. The last term is used in a prefix query. | diff --git a/docs/reference/api/QueryDslMatchNoneQuery.md b/docs/reference/api/QueryDslMatchNoneQuery.md new file mode 100644 index 000000000..792e1d261 --- /dev/null +++ b/docs/reference/api/QueryDslMatchNoneQuery.md @@ -0,0 +1,4 @@ +## Interface `QueryDslMatchNoneQuery` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/QueryDslMatchPhrasePrefixQuery.md b/docs/reference/api/QueryDslMatchPhrasePrefixQuery.md new file mode 100644 index 000000000..51d57d363 --- /dev/null +++ b/docs/reference/api/QueryDslMatchPhrasePrefixQuery.md @@ -0,0 +1,9 @@ +## Interface `QueryDslMatchPhrasePrefixQuery` + +| Name | Type | Description | +| - | - | - | +| `analyzer` | string | Analyzer used to convert text in the query value into tokens. | +| `max_expansions` | [integer](./integer.md) | Maximum number of terms to which the last provided term of the query value will expand. | +| `query` | string | Text you wish to find in the provided field. | +| `slop` | [integer](./integer.md) | Maximum number of positions allowed between matching tokens. | +| `zero_terms_query` | [QueryDslZeroTermsQuery](./QueryDslZeroTermsQuery.md) | Indicates whether no documents are returned if the analyzer removes all tokens, such as when using a `stop` filter. | diff --git a/docs/reference/api/QueryDslMatchPhraseQuery.md b/docs/reference/api/QueryDslMatchPhraseQuery.md new file mode 100644 index 000000000..1317ee1fb --- /dev/null +++ b/docs/reference/api/QueryDslMatchPhraseQuery.md @@ -0,0 +1,8 @@ +## Interface `QueryDslMatchPhraseQuery` + +| Name | Type | Description | +| - | - | - | +| `analyzer` | string | Analyzer used to convert the text in the query value into tokens. | +| `query` | string | Query terms that are analyzed and turned into a phrase query. | +| `slop` | [integer](./integer.md) | Maximum number of positions allowed between matching tokens. | +| `zero_terms_query` | [QueryDslZeroTermsQuery](./QueryDslZeroTermsQuery.md) | Indicates whether no documents are returned if the `analyzer` removes all tokens, such as when using a `stop` filter. | diff --git a/docs/reference/api/QueryDslMatchQuery.md b/docs/reference/api/QueryDslMatchQuery.md new file mode 100644 index 000000000..afb755b36 --- /dev/null +++ b/docs/reference/api/QueryDslMatchQuery.md @@ -0,0 +1,17 @@ +## Interface `QueryDslMatchQuery` + +| Name | Type | Description | +| - | - | - | +| `analyzer` | string | Analyzer used to convert the text in the query value into tokens. | +| `auto_generate_synonyms_phrase_query` | boolean | If `true`, match phrase queries are automatically created for multi-term synonyms. | +| `cutoff_frequency` | [double](./double.md) |   | +| `fuzziness` | [Fuzziness](./Fuzziness.md) | Maximum edit distance allowed for matching. | +| `fuzzy_rewrite` | [MultiTermQueryRewrite](./MultiTermQueryRewrite.md) | Method used to rewrite the query. | +| `fuzzy_transpositions` | boolean | If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`). | +| `lenient` | boolean | If `true`, format-based errors, such as providing a text query value for a numeric field, are ignored. | +| `max_expansions` | [integer](./integer.md) | Maximum number of terms to which the query will expand. | +| `minimum_should_match` | [MinimumShouldMatch](./MinimumShouldMatch.md) | Minimum number of clauses that must match for a document to be returned. | +| `operator` | [QueryDslOperator](./QueryDslOperator.md) | Boolean logic used to interpret text in the query value. | +| `prefix_length` | [integer](./integer.md) | Number of beginning characters left unchanged for fuzzy matching. | +| `query` | string | [float](./float.md) | boolean | Text, number, boolean value or date you wish to find in the provided field. | +| `zero_terms_query` | [QueryDslZeroTermsQuery](./QueryDslZeroTermsQuery.md) | Indicates whether no documents are returned if the `analyzer` removes all tokens, such as when using a `stop` filter. | diff --git a/docs/reference/api/QueryDslMoreLikeThisQuery.md b/docs/reference/api/QueryDslMoreLikeThisQuery.md new file mode 100644 index 000000000..c83c82ae3 --- /dev/null +++ b/docs/reference/api/QueryDslMoreLikeThisQuery.md @@ -0,0 +1,22 @@ +## Interface `QueryDslMoreLikeThisQuery` + +| Name | Type | Description | +| - | - | - | +| `analyzer` | string | The analyzer that is used to analyze the free form text. Defaults to the analyzer associated with the first field in fields. | +| `boost_terms` | [double](./double.md) | Each term in the formed query could be further boosted by their tf-idf score. This sets the boost factor to use when using this feature. Defaults to deactivated (0). | +| `fail_on_unsupported_field` | boolean | Controls whether the query should fail (throw an exception) if any of the specified fields are not of the supported types ( `text` or `keyword`). | +| `fields` | [Field](./Field.md)[] | A list of fields to fetch and analyze the text from. Defaults to the `index.query.default_field` index setting, which has a default value of `*`. | +| `include` | boolean | Specifies whether the input documents should also be included in the search results returned. | +| `like` | [QueryDslLike](./QueryDslLike.md) | [QueryDslLike](./QueryDslLike.md)[] | Specifies free form text and/or a single or multiple documents for which you want to find similar documents. | +| `max_doc_freq` | [integer](./integer.md) | The maximum document frequency above which the terms are ignored from the input document. | +| `max_query_terms` | [integer](./integer.md) | The maximum number of query terms that can be selected. | +| `max_word_length` | [integer](./integer.md) | The maximum word length above which the terms are ignored. Defaults to unbounded ( `0`). | +| `min_doc_freq` | [integer](./integer.md) | The minimum document frequency below which the terms are ignored from the input document. | +| `min_term_freq` | [integer](./integer.md) | The minimum term frequency below which the terms are ignored from the input document. | +| `min_word_length` | [integer](./integer.md) | The minimum word length below which the terms are ignored. | +| `minimum_should_match` | [MinimumShouldMatch](./MinimumShouldMatch.md) | After the disjunctive query has been formed, this parameter controls the number of terms that must match. | +| `routing` | [Routing](./Routing.md) |   | +| `stop_words` | [AnalysisStopWords](./AnalysisStopWords.md) | An array of stop words. Any word in this set is ignored. | +| `unlike` | [QueryDslLike](./QueryDslLike.md) | [QueryDslLike](./QueryDslLike.md)[] | Used in combination with `like` to exclude documents that match a set of terms. | +| `version_type` | [VersionType](./VersionType.md) |   | +| `version` | [VersionNumber](./VersionNumber.md) |   | diff --git a/docs/reference/api/QueryDslMultiMatchQuery.md b/docs/reference/api/QueryDslMultiMatchQuery.md new file mode 100644 index 000000000..3185538c5 --- /dev/null +++ b/docs/reference/api/QueryDslMultiMatchQuery.md @@ -0,0 +1,21 @@ +## Interface `QueryDslMultiMatchQuery` + +| Name | Type | Description | +| - | - | - | +| `analyzer` | string | Analyzer used to convert the text in the query value into tokens. | +| `auto_generate_synonyms_phrase_query` | boolean | If `true`, match phrase queries are automatically created for multi-term synonyms. | +| `cutoff_frequency` | [double](./double.md) |   | +| `fields` | [Fields](./Fields.md) | The fields to be queried. Defaults to the `index.query.default_field` index settings, which in turn defaults to `*`. | +| `fuzziness` | [Fuzziness](./Fuzziness.md) | Maximum edit distance allowed for matching. | +| `fuzzy_rewrite` | [MultiTermQueryRewrite](./MultiTermQueryRewrite.md) | Method used to rewrite the query. | +| `fuzzy_transpositions` | boolean | If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`). Can be applied to the term subqueries constructed for all terms but the final term. | +| `lenient` | boolean | If `true`, format-based errors, such as providing a text query value for a numeric field, are ignored. | +| `max_expansions` | [integer](./integer.md) | Maximum number of terms to which the query will expand. | +| `minimum_should_match` | [MinimumShouldMatch](./MinimumShouldMatch.md) | Minimum number of clauses that must match for a document to be returned. | +| `operator` | [QueryDslOperator](./QueryDslOperator.md) | Boolean logic used to interpret text in the query value. | +| `prefix_length` | [integer](./integer.md) | Number of beginning characters left unchanged for fuzzy matching. | +| `query` | string | Text, number, boolean value or date you wish to find in the provided field. | +| `slop` | [integer](./integer.md) | Maximum number of positions allowed between matching tokens. | +| `tie_breaker` | [double](./double.md) | Determines how scores for each per-term blended query and scores across groups are combined. | +| `type` | [QueryDslTextQueryType](./QueryDslTextQueryType.md) | How `the` multi_match query is executed internally. | +| `zero_terms_query` | [QueryDslZeroTermsQuery](./QueryDslZeroTermsQuery.md) | Indicates whether no documents are returned if the `analyzer` removes all tokens, such as when using a `stop` filter. | diff --git a/docs/reference/api/QueryDslMultiValueMode.md b/docs/reference/api/QueryDslMultiValueMode.md new file mode 100644 index 000000000..b3ed45836 --- /dev/null +++ b/docs/reference/api/QueryDslMultiValueMode.md @@ -0,0 +1,4 @@ +## `QueryDslMultiValueMode` +::: +type QueryDslMultiValueMode = 'min' | 'max' | 'avg' | 'sum'; +::: diff --git a/docs/reference/api/QueryDslNestedQuery.md b/docs/reference/api/QueryDslNestedQuery.md new file mode 100644 index 000000000..3e872dd3c --- /dev/null +++ b/docs/reference/api/QueryDslNestedQuery.md @@ -0,0 +1,9 @@ +## Interface `QueryDslNestedQuery` + +| Name | Type | Description | +| - | - | - | +| `ignore_unmapped` | boolean | Indicates whether to ignore an unmapped path and not return any documents instead of an error. | +| `inner_hits` | [SearchInnerHits](./SearchInnerHits.md) | If defined, each search hit will contain inner hits. | +| `path` | [Field](./Field.md) | Path to the nested object you wish to search. | +| `query` | [QueryDslQueryContainer](./QueryDslQueryContainer.md) | Query you wish to run on nested objects in the path. | +| `score_mode` | [QueryDslChildScoreMode](./QueryDslChildScoreMode.md) | How scores for matching child objects affect the root parent document’s relevance score. | diff --git a/docs/reference/api/QueryDslNumberRangeQuery.md b/docs/reference/api/QueryDslNumberRangeQuery.md new file mode 100644 index 000000000..09d8f6d0a --- /dev/null +++ b/docs/reference/api/QueryDslNumberRangeQuery.md @@ -0,0 +1,4 @@ +## Interface `QueryDslNumberRangeQuery` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/QueryDslNumericDecayFunction.md b/docs/reference/api/QueryDslNumericDecayFunction.md new file mode 100644 index 000000000..1f38e1fab --- /dev/null +++ b/docs/reference/api/QueryDslNumericDecayFunction.md @@ -0,0 +1,4 @@ +## `QueryDslNumericDecayFunction` +::: +type QueryDslNumericDecayFunction = [QueryDslNumericDecayFunctionKeys](./QueryDslNumericDecayFunctionKeys.md) & { [property: string]: [QueryDslDecayPlacement](./QueryDslDecayPlacement.md) | [QueryDslMultiValueMode](./QueryDslMultiValueMode.md);}; +::: diff --git a/docs/reference/api/QueryDslNumericDecayFunctionKeys.md b/docs/reference/api/QueryDslNumericDecayFunctionKeys.md new file mode 100644 index 000000000..4466b2524 --- /dev/null +++ b/docs/reference/api/QueryDslNumericDecayFunctionKeys.md @@ -0,0 +1,4 @@ +## Interface `QueryDslNumericDecayFunctionKeys` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/QueryDslOperator.md b/docs/reference/api/QueryDslOperator.md new file mode 100644 index 000000000..7fe45b375 --- /dev/null +++ b/docs/reference/api/QueryDslOperator.md @@ -0,0 +1,4 @@ +## `QueryDslOperator` +::: +type QueryDslOperator = 'and' | 'AND' | 'or' | 'OR'; +::: diff --git a/docs/reference/api/QueryDslParentIdQuery.md b/docs/reference/api/QueryDslParentIdQuery.md new file mode 100644 index 000000000..080c0184c --- /dev/null +++ b/docs/reference/api/QueryDslParentIdQuery.md @@ -0,0 +1,7 @@ +## Interface `QueryDslParentIdQuery` + +| Name | Type | Description | +| - | - | - | +| `id` | [Id](./Id.md) | ID of the parent document. | +| `ignore_unmapped` | boolean | Indicates whether to ignore an unmapped `type` and not return any documents instead of an error. | +| `type` | [RelationName](./RelationName.md) | Name of the child relationship mapped for the `join` field. | diff --git a/docs/reference/api/QueryDslPercolateQuery.md b/docs/reference/api/QueryDslPercolateQuery.md new file mode 100644 index 000000000..857f613dd --- /dev/null +++ b/docs/reference/api/QueryDslPercolateQuery.md @@ -0,0 +1,13 @@ +## Interface `QueryDslPercolateQuery` + +| Name | Type | Description | +| - | - | - | +| `document` | any | The source of the document being percolated. | +| `documents` | any[] | An array of sources of the documents being percolated. | +| `field` | [Field](./Field.md) | Field that holds the indexed queries. The field must use the `percolator` mapping type. | +| `id` | [Id](./Id.md) | The ID of a stored document to percolate. | +| `index` | [IndexName](./IndexName.md) | The index of a stored document to percolate. | +| `name` | string | The suffix used for the `_percolator_document_slot` field when multiple `percolate` queries are specified. | +| `preference` | string | Preference used to fetch document to percolate. | +| `routing` | [Routing](./Routing.md) | Routing used to fetch document to percolate. | +| `version` | [VersionNumber](./VersionNumber.md) | The expected version of a stored document to percolate. | diff --git a/docs/reference/api/QueryDslPinnedDoc.md b/docs/reference/api/QueryDslPinnedDoc.md new file mode 100644 index 000000000..28f6013b6 --- /dev/null +++ b/docs/reference/api/QueryDslPinnedDoc.md @@ -0,0 +1,6 @@ +## Interface `QueryDslPinnedDoc` + +| Name | Type | Description | +| - | - | - | +| `_id` | [Id](./Id.md) | The unique document ID. | +| `_index` | [IndexName](./IndexName.md) | The index that contains the document. | diff --git a/docs/reference/api/QueryDslPinnedQuery.md b/docs/reference/api/QueryDslPinnedQuery.md new file mode 100644 index 000000000..5ae74b4db --- /dev/null +++ b/docs/reference/api/QueryDslPinnedQuery.md @@ -0,0 +1,7 @@ +## Interface `QueryDslPinnedQuery` + +| Name | Type | Description | +| - | - | - | +| `docs` | [QueryDslPinnedDoc](./QueryDslPinnedDoc.md)[] | Documents listed in the order they are to appear in results. Required if `ids` is not specified. | +| `ids` | [Id](./Id.md)[] | Document IDs listed in the order they are to appear in results. Required if `docs` is not specified. | +| `organic` | [QueryDslQueryContainer](./QueryDslQueryContainer.md) | Any choice of query used to rank documents which will be ranked below the "pinned" documents. | diff --git a/docs/reference/api/QueryDslPrefixQuery.md b/docs/reference/api/QueryDslPrefixQuery.md new file mode 100644 index 000000000..c2651c5d6 --- /dev/null +++ b/docs/reference/api/QueryDslPrefixQuery.md @@ -0,0 +1,7 @@ +## Interface `QueryDslPrefixQuery` + +| Name | Type | Description | +| - | - | - | +| `case_insensitive` | boolean | Allows ASCII case insensitive matching of the value with the indexed field values when set to `true`. Default is `false` which means the case sensitivity of matching depends on the underlying field’s mapping. | +| `rewrite` | [MultiTermQueryRewrite](./MultiTermQueryRewrite.md) | Method used to rewrite the query. | +| `value` | string | Beginning characters of terms you wish to find in the provided field. | diff --git a/docs/reference/api/QueryDslQueryBase.md b/docs/reference/api/QueryDslQueryBase.md new file mode 100644 index 000000000..449546273 --- /dev/null +++ b/docs/reference/api/QueryDslQueryBase.md @@ -0,0 +1,6 @@ +## Interface `QueryDslQueryBase` + +| Name | Type | Description | +| - | - | - | +| `_name` | string |   | +| `boost` | [float](./float.md) | Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score. | diff --git a/docs/reference/api/QueryDslQueryContainer.md b/docs/reference/api/QueryDslQueryContainer.md new file mode 100644 index 000000000..b2a2c4ef2 --- /dev/null +++ b/docs/reference/api/QueryDslQueryContainer.md @@ -0,0 +1,65 @@ +## Interface `QueryDslQueryContainer` + +| Name | Type | Description | +| - | - | - | +| `bool` | [QueryDslBoolQuery](./QueryDslBoolQuery.md) | matches documents matching boolean combinations of other queries. | +| `boosting` | [QueryDslBoostingQuery](./QueryDslBoostingQuery.md) | Returns documents matching a `positive` query while reducing the relevance score of documents that also match a `negative` query. | +| `combined_fields` | [QueryDslCombinedFieldsQuery](./QueryDslCombinedFieldsQuery.md) | The `combined_fields` query supports searching multiple text fields as if their contents had been indexed into one combined field. | +| `common` | [Partial](./Partial.md)> |   | +| `constant_score` | [QueryDslConstantScoreQuery](./QueryDslConstantScoreQuery.md) | Wraps a filter query and returns every matching document with a relevance score equal to the `boost` parameter value. | +| `dis_max` | [QueryDslDisMaxQuery](./QueryDslDisMaxQuery.md) | Returns documents matching one or more wrapped queries, called query clauses or clauses. If a returned document matches multiple query clauses, the `dis_max` query assigns the document the highest relevance score from any matching clause, plus a tie breaking increment for any additional matching subqueries. | +| `distance_feature` | [QueryDslDistanceFeatureQuery](./QueryDslDistanceFeatureQuery.md) | Boosts the relevance score of documents closer to a provided origin date or point. For example, you can use this query to give more weight to documents closer to a certain date or location. | +| `exists` | [QueryDslExistsQuery](./QueryDslExistsQuery.md) | Returns documents that contain an indexed value for a field. | +| `function_score` | [QueryDslFunctionScoreQuery](./QueryDslFunctionScoreQuery.md) | [QueryDslFunctionScoreContainer](./QueryDslFunctionScoreContainer.md)[] | The `function_score` enables you to modify the score of documents that are retrieved by a query. | +| `fuzzy` | [Partial](./Partial.md)> | Returns documents that contain terms similar to the search term, as measured by a Levenshtein edit distance. | +| `geo_bounding_box` | [QueryDslGeoBoundingBoxQuery](./QueryDslGeoBoundingBoxQuery.md) | Matches geo_point and geo_shape values that intersect a bounding box. | +| `geo_distance` | [QueryDslGeoDistanceQuery](./QueryDslGeoDistanceQuery.md) | Matches `geo_point` and `geo_shape` values within a given distance of a geopoint. | +| `geo_grid` | [Partial](./Partial.md)> | Matches `geo_point` and `geo_shape` values that intersect a grid cell from a GeoGrid aggregation. | +| `geo_polygon` | [QueryDslGeoPolygonQuery](./QueryDslGeoPolygonQuery.md) |   | +| `geo_shape` | [QueryDslGeoShapeQuery](./QueryDslGeoShapeQuery.md) | Filter documents indexed using either the `geo_shape` or the `geo_point` type. | +| `has_child` | [QueryDslHasChildQuery](./QueryDslHasChildQuery.md) | Returns parent documents whose joined child documents match a provided query. | +| `has_parent` | [QueryDslHasParentQuery](./QueryDslHasParentQuery.md) | Returns child documents whose joined parent document matches a provided query. | +| `ids` | [QueryDslIdsQuery](./QueryDslIdsQuery.md) | Returns documents based on their IDs. This query uses document IDs stored in the `_id` field. | +| `intervals` | [Partial](./Partial.md)> | Returns documents based on the order and proximity of matching terms. | +| `knn` | [KnnQuery](./KnnQuery.md) | Finds the k nearest vectors to a query vector, as measured by a similarity metric. knn query finds nearest vectors through approximate search on indexed dense_vectors. | +| `match_all` | [QueryDslMatchAllQuery](./QueryDslMatchAllQuery.md) | Matches all documents, giving them all a `_score` of 1.0. | +| `match_bool_prefix` | [Partial](./Partial.md)> | Analyzes its input and constructs a `bool` query from the terms. Each term except the last is used in a `term` query. The last term is used in a prefix query. | +| `match_none` | [QueryDslMatchNoneQuery](./QueryDslMatchNoneQuery.md) | Matches no documents. | +| `match_phrase_prefix` | [Partial](./Partial.md)> | Returns documents that contain the words of a provided text, in the same order as provided. The last term of the provided text is treated as a prefix, matching any words that begin with that term. | +| `match_phrase` | [Partial](./Partial.md)> | Analyzes the text and creates a phrase query out of the analyzed text. | +| `match` | [Partial](./Partial.md)> | Returns documents that match a provided text, number, date or boolean value. The provided text is analyzed before matching. | +| `more_like_this` | [QueryDslMoreLikeThisQuery](./QueryDslMoreLikeThisQuery.md) | Returns documents that are "like" a given set of documents. | +| `multi_match` | [QueryDslMultiMatchQuery](./QueryDslMultiMatchQuery.md) | Enables you to search for a provided text, number, date or boolean value across multiple fields. The provided text is analyzed before matching. | +| `nested` | [QueryDslNestedQuery](./QueryDslNestedQuery.md) | Wraps another query to search nested fields. If an object matches the search, the nested query returns the root parent document. | +| `parent_id` | [QueryDslParentIdQuery](./QueryDslParentIdQuery.md) | Returns child documents joined to a specific parent document. | +| `percolate` | [QueryDslPercolateQuery](./QueryDslPercolateQuery.md) | Matches queries stored in an index. | +| `pinned` | [QueryDslPinnedQuery](./QueryDslPinnedQuery.md) | Promotes selected documents to rank higher than those matching a given query. | +| `prefix` | [Partial](./Partial.md)> | Returns documents that contain a specific prefix in a provided field. | +| `query_string` | [QueryDslQueryStringQuery](./QueryDslQueryStringQuery.md) | Returns documents based on a provided query string, using a parser with a strict syntax. | +| `range` | [Partial](./Partial.md)> | Returns documents that contain terms within a provided range. | +| `rank_feature` | [QueryDslRankFeatureQuery](./QueryDslRankFeatureQuery.md) | Boosts the relevance score of documents based on the numeric value of a `rank_feature` or `rank_features` field. | +| `regexp` | [Partial](./Partial.md)> | Returns documents that contain terms matching a regular expression. | +| `rule` | [QueryDslRuleQuery](./QueryDslRuleQuery.md) |   | +| `script_score` | [QueryDslScriptScoreQuery](./QueryDslScriptScoreQuery.md) | Uses a script to provide a custom score for returned documents. | +| `script` | [QueryDslScriptQuery](./QueryDslScriptQuery.md) | Filters documents based on a provided script. The script query is typically used in a filter context. | +| `semantic` | [QueryDslSemanticQuery](./QueryDslSemanticQuery.md) | A semantic query to semantic_text field types | +| `shape` | [QueryDslShapeQuery](./QueryDslShapeQuery.md) | Queries documents that contain fields indexed using the `shape` type. | +| `simple_query_string` | [QueryDslSimpleQueryStringQuery](./QueryDslSimpleQueryStringQuery.md) | Returns documents based on a provided query string, using a parser with a limited but fault-tolerant syntax. | +| `span_containing` | [QueryDslSpanContainingQuery](./QueryDslSpanContainingQuery.md) | Returns matches which enclose another span query. | +| `span_field_masking` | [QueryDslSpanFieldMaskingQuery](./QueryDslSpanFieldMaskingQuery.md) | Wrapper to allow span queries to participate in composite single-field span queries by _lying_ about their search field. | +| `span_first` | [QueryDslSpanFirstQuery](./QueryDslSpanFirstQuery.md) | Matches spans near the beginning of a field. | +| `span_multi` | [QueryDslSpanMultiTermQuery](./QueryDslSpanMultiTermQuery.md) | Allows you to wrap a multi term query (one of `wildcard`, `fuzzy`, `prefix`, `range`, or `regexp` query) as a `span` query, so it can be nested. | +| `span_near` | [QueryDslSpanNearQuery](./QueryDslSpanNearQuery.md) | Matches spans which are near one another. You can specify `slop`, the maximum number of intervening unmatched positions, as well as whether matches are required to be in-order. | +| `span_not` | [QueryDslSpanNotQuery](./QueryDslSpanNotQuery.md) | Removes matches which overlap with another span query or which are within x tokens before (controlled by the parameter `pre`) or y tokens after (controlled by the parameter `post`) another span query. | +| `span_or` | [QueryDslSpanOrQuery](./QueryDslSpanOrQuery.md) | Matches the union of its span clauses. | +| `span_term` | [Partial](./Partial.md)> | Matches spans containing a term. | +| `span_within` | [QueryDslSpanWithinQuery](./QueryDslSpanWithinQuery.md) | Returns matches which are enclosed inside another span query. | +| `sparse_vector` | [QueryDslSparseVectorQuery](./QueryDslSparseVectorQuery.md) | Using input query vectors or a natural language processing model to convert a query into a list of token-weight pairs, queries against a sparse vector field. | +| `term` | [Partial](./Partial.md)> | Returns documents that contain an exact term in a provided field. To return a document, the query term must exactly match the queried field's value, including whitespace and capitalization. | +| `terms_set` | [Partial](./Partial.md)> | Returns documents that contain a minimum number of exact terms in a provided field. To return a document, a required number of terms must exactly match the field values, including whitespace and capitalization. | +| `terms` | [QueryDslTermsQuery](./QueryDslTermsQuery.md) | Returns documents that contain one or more exact terms in a provided field. To return a document, one or more terms must exactly match a field value, including whitespace and capitalization. | +| `text_expansion` | [Partial](./Partial.md)> | Uses a natural language processing model to convert the query text into a list of token-weight pairs which are then used in a query against a sparse vector or rank features field. | +| `type` | [QueryDslTypeQuery](./QueryDslTypeQuery.md) |   | +| `weighted_tokens` | [Partial](./Partial.md)> | Supports returning text_expansion query results by sending in precomputed tokens with the query. | +| `wildcard` | [Partial](./Partial.md)> | Returns documents that contain terms matching a wildcard pattern. | +| `wrapper` | [QueryDslWrapperQuery](./QueryDslWrapperQuery.md) | A query that accepts any other query as base64 encoded string. | diff --git a/docs/reference/api/QueryDslQueryStringQuery.md b/docs/reference/api/QueryDslQueryStringQuery.md new file mode 100644 index 000000000..32919044f --- /dev/null +++ b/docs/reference/api/QueryDslQueryStringQuery.md @@ -0,0 +1,29 @@ +## Interface `QueryDslQueryStringQuery` + +| Name | Type | Description | +| - | - | - | +| `allow_leading_wildcard` | boolean | If `true`, the wildcard characters `*` and `?` are allowed as the first character of the query string. | +| `analyze_wildcard` | boolean | If `true`, the query attempts to analyze wildcard terms in the query string. | +| `analyzer` | string | Analyzer used to convert text in the query string into tokens. | +| `auto_generate_synonyms_phrase_query` | boolean | If `true`, match phrase queries are automatically created for multi-term synonyms. | +| `default_field` | [Field](./Field.md) | Default field to search if no field is provided in the query string. Supports wildcards ( `*`). Defaults to the `index.query.default_field` index setting, which has a default value of `*`. | +| `default_operator` | [QueryDslOperator](./QueryDslOperator.md) | Default boolean logic used to interpret text in the query string if no operators are specified. | +| `enable_position_increments` | boolean | If `true`, enable position increments in queries constructed from a `query_string` search. | +| `escape` | boolean |   | +| `fields` | [Field](./Field.md)[] | Array of fields to search. Supports wildcards ( `*`). | +| `fuzziness` | [Fuzziness](./Fuzziness.md) | Maximum edit distance allowed for fuzzy matching. | +| `fuzzy_max_expansions` | [integer](./integer.md) | Maximum number of terms to which the query expands for fuzzy matching. | +| `fuzzy_prefix_length` | [integer](./integer.md) | Number of beginning characters left unchanged for fuzzy matching. | +| `fuzzy_rewrite` | [MultiTermQueryRewrite](./MultiTermQueryRewrite.md) | Method used to rewrite the query. | +| `fuzzy_transpositions` | boolean | If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`). | +| `lenient` | boolean | If `true`, format-based errors, such as providing a text value for a numeric field, are ignored. | +| `max_determinized_states` | [integer](./integer.md) | Maximum number of automaton states required for the query. | +| `minimum_should_match` | [MinimumShouldMatch](./MinimumShouldMatch.md) | Minimum number of clauses that must match for a document to be returned. | +| `phrase_slop` | [double](./double.md) | Maximum number of positions allowed between matching tokens for phrases. | +| `query` | string | Query string you wish to parse and use for search. | +| `quote_analyzer` | string | Analyzer used to convert quoted text in the query string into tokens. For quoted text, this parameter overrides the analyzer specified in the `analyzer` parameter. | +| `quote_field_suffix` | string | Suffix appended to quoted text in the query string. You can use this suffix to use a different analysis method for exact matches. | +| `rewrite` | [MultiTermQueryRewrite](./MultiTermQueryRewrite.md) | Method used to rewrite the query. | +| `tie_breaker` | [double](./double.md) | How to combine the queries generated from the individual search terms in the resulting `dis_max` query. | +| `time_zone` | [TimeZone](./TimeZone.md) | Coordinated Universal Time (UTC) offset or IANA time zone used to convert date values in the query string to UTC. | +| `type` | [QueryDslTextQueryType](./QueryDslTextQueryType.md) | Determines how the query matches and scores documents. | diff --git a/docs/reference/api/QueryDslRandomScoreFunction.md b/docs/reference/api/QueryDslRandomScoreFunction.md new file mode 100644 index 000000000..6436ebdcb --- /dev/null +++ b/docs/reference/api/QueryDslRandomScoreFunction.md @@ -0,0 +1,6 @@ +## Interface `QueryDslRandomScoreFunction` + +| Name | Type | Description | +| - | - | - | +| `field` | [Field](./Field.md) |   | +| `seed` | [long](./long.md) | string |   | diff --git a/docs/reference/api/QueryDslRangeQuery.md b/docs/reference/api/QueryDslRangeQuery.md new file mode 100644 index 000000000..faec7bb1f --- /dev/null +++ b/docs/reference/api/QueryDslRangeQuery.md @@ -0,0 +1,4 @@ +## `QueryDslRangeQuery` +::: +type QueryDslRangeQuery = [QueryDslUntypedRangeQuery](./QueryDslUntypedRangeQuery.md) | [QueryDslDateRangeQuery](./QueryDslDateRangeQuery.md) | [QueryDslNumberRangeQuery](./QueryDslNumberRangeQuery.md) | [QueryDslTermRangeQuery](./QueryDslTermRangeQuery.md); +::: diff --git a/docs/reference/api/QueryDslRangeQueryBase.md b/docs/reference/api/QueryDslRangeQueryBase.md new file mode 100644 index 000000000..f5cc57a63 --- /dev/null +++ b/docs/reference/api/QueryDslRangeQueryBase.md @@ -0,0 +1,11 @@ +## Interface `QueryDslRangeQueryBase` + +| Name | Type | Description | +| - | - | - | +| `from` | T | null |   | +| `gt` | T | Greater than. | +| `gte` | T | Greater than or equal to. | +| `lt` | T | Less than. | +| `lte` | T | Less than or equal to. | +| `relation` | [QueryDslRangeRelation](./QueryDslRangeRelation.md) | Indicates how the range query matches values for `range` fields. | +| `to` | T | null |   | diff --git a/docs/reference/api/QueryDslRangeRelation.md b/docs/reference/api/QueryDslRangeRelation.md new file mode 100644 index 000000000..c1516f2ae --- /dev/null +++ b/docs/reference/api/QueryDslRangeRelation.md @@ -0,0 +1,4 @@ +## `QueryDslRangeRelation` +::: +type QueryDslRangeRelation = 'within' | 'contains' | 'intersects'; +::: diff --git a/docs/reference/api/QueryDslRankFeatureFunction.md b/docs/reference/api/QueryDslRankFeatureFunction.md new file mode 100644 index 000000000..cae22c921 --- /dev/null +++ b/docs/reference/api/QueryDslRankFeatureFunction.md @@ -0,0 +1,4 @@ +## Interface `QueryDslRankFeatureFunction` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/QueryDslRankFeatureFunctionLinear.md b/docs/reference/api/QueryDslRankFeatureFunctionLinear.md new file mode 100644 index 000000000..50adb8683 --- /dev/null +++ b/docs/reference/api/QueryDslRankFeatureFunctionLinear.md @@ -0,0 +1,4 @@ +## Interface `QueryDslRankFeatureFunctionLinear` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/QueryDslRankFeatureFunctionLogarithm.md b/docs/reference/api/QueryDslRankFeatureFunctionLogarithm.md new file mode 100644 index 000000000..7eb4cfddc --- /dev/null +++ b/docs/reference/api/QueryDslRankFeatureFunctionLogarithm.md @@ -0,0 +1,5 @@ +## Interface `QueryDslRankFeatureFunctionLogarithm` + +| Name | Type | Description | +| - | - | - | +| `scaling_factor` | [float](./float.md) | Configurable scaling factor. | diff --git a/docs/reference/api/QueryDslRankFeatureFunctionSaturation.md b/docs/reference/api/QueryDslRankFeatureFunctionSaturation.md new file mode 100644 index 000000000..68956af82 --- /dev/null +++ b/docs/reference/api/QueryDslRankFeatureFunctionSaturation.md @@ -0,0 +1,5 @@ +## Interface `QueryDslRankFeatureFunctionSaturation` + +| Name | Type | Description | +| - | - | - | +| `pivot` | [float](./float.md) | Configurable pivot value so that the result will be less than 0.5. | diff --git a/docs/reference/api/QueryDslRankFeatureFunctionSigmoid.md b/docs/reference/api/QueryDslRankFeatureFunctionSigmoid.md new file mode 100644 index 000000000..967bcc2db --- /dev/null +++ b/docs/reference/api/QueryDslRankFeatureFunctionSigmoid.md @@ -0,0 +1,6 @@ +## Interface `QueryDslRankFeatureFunctionSigmoid` + +| Name | Type | Description | +| - | - | - | +| `exponent` | [float](./float.md) | Configurable Exponent. | +| `pivot` | [float](./float.md) | Configurable pivot value so that the result will be less than 0.5. | diff --git a/docs/reference/api/QueryDslRankFeatureQuery.md b/docs/reference/api/QueryDslRankFeatureQuery.md new file mode 100644 index 000000000..22158eae2 --- /dev/null +++ b/docs/reference/api/QueryDslRankFeatureQuery.md @@ -0,0 +1,9 @@ +## Interface `QueryDslRankFeatureQuery` + +| Name | Type | Description | +| - | - | - | +| `field` | [Field](./Field.md) | `rank_feature` or `rank_features` field used to boost relevance scores. | +| `linear` | [QueryDslRankFeatureFunctionLinear](./QueryDslRankFeatureFunctionLinear.md) | Linear function used to boost relevance scores based on the value of the rank feature `field`. | +| `log` | [QueryDslRankFeatureFunctionLogarithm](./QueryDslRankFeatureFunctionLogarithm.md) | Logarithmic function used to boost relevance scores based on the value of the rank feature `field`. | +| `saturation` | [QueryDslRankFeatureFunctionSaturation](./QueryDslRankFeatureFunctionSaturation.md) | Saturation function used to boost relevance scores based on the value of the rank feature `field`. | +| `sigmoid` | [QueryDslRankFeatureFunctionSigmoid](./QueryDslRankFeatureFunctionSigmoid.md) | Sigmoid function used to boost relevance scores based on the value of the rank feature `field`. | diff --git a/docs/reference/api/QueryDslRegexpQuery.md b/docs/reference/api/QueryDslRegexpQuery.md new file mode 100644 index 000000000..e6963fe35 --- /dev/null +++ b/docs/reference/api/QueryDslRegexpQuery.md @@ -0,0 +1,9 @@ +## Interface `QueryDslRegexpQuery` + +| Name | Type | Description | +| - | - | - | +| `case_insensitive` | boolean | Allows case insensitive matching of the regular expression value with the indexed field values when set to `true`. When `false`, case sensitivity of matching depends on the underlying field’s mapping. | +| `flags` | string | Enables optional operators for the regular expression. | +| `max_determinized_states` | [integer](./integer.md) | Maximum number of automaton states required for the query. | +| `rewrite` | [MultiTermQueryRewrite](./MultiTermQueryRewrite.md) | Method used to rewrite the query. | +| `value` | string | Regular expression for terms you wish to find in the provided field. | diff --git a/docs/reference/api/QueryDslRuleQuery.md b/docs/reference/api/QueryDslRuleQuery.md new file mode 100644 index 000000000..1a3047f7a --- /dev/null +++ b/docs/reference/api/QueryDslRuleQuery.md @@ -0,0 +1,7 @@ +## Interface `QueryDslRuleQuery` + +| Name | Type | Description | +| - | - | - | +| `match_criteria` | any |   | +| `organic` | [QueryDslQueryContainer](./QueryDslQueryContainer.md) |   | +| `ruleset_ids` | [Id](./Id.md)[] |   | diff --git a/docs/reference/api/QueryDslScriptQuery.md b/docs/reference/api/QueryDslScriptQuery.md new file mode 100644 index 000000000..24f51e548 --- /dev/null +++ b/docs/reference/api/QueryDslScriptQuery.md @@ -0,0 +1,5 @@ +## Interface `QueryDslScriptQuery` + +| Name | Type | Description | +| - | - | - | +| `script` | [Script](./Script.md) | [ScriptSource](./ScriptSource.md) | Contains a script to run as a query. This script must return a boolean value, `true` or `false`. | diff --git a/docs/reference/api/QueryDslScriptScoreFunction.md b/docs/reference/api/QueryDslScriptScoreFunction.md new file mode 100644 index 000000000..85bd62027 --- /dev/null +++ b/docs/reference/api/QueryDslScriptScoreFunction.md @@ -0,0 +1,5 @@ +## Interface `QueryDslScriptScoreFunction` + +| Name | Type | Description | +| - | - | - | +| `script` | [Script](./Script.md) | [ScriptSource](./ScriptSource.md) | A script that computes a score. | diff --git a/docs/reference/api/QueryDslScriptScoreQuery.md b/docs/reference/api/QueryDslScriptScoreQuery.md new file mode 100644 index 000000000..ca4b57663 --- /dev/null +++ b/docs/reference/api/QueryDslScriptScoreQuery.md @@ -0,0 +1,7 @@ +## Interface `QueryDslScriptScoreQuery` + +| Name | Type | Description | +| - | - | - | +| `min_score` | [float](./float.md) | Documents with a score lower than this floating point number are excluded from the search results. | +| `query` | [QueryDslQueryContainer](./QueryDslQueryContainer.md) | Query used to return documents. | +| `script` | [Script](./Script.md) | [ScriptSource](./ScriptSource.md) | Script used to compute the score of documents returned by the query. Important: final relevance scores from the `script_score` query cannot be negative. | diff --git a/docs/reference/api/QueryDslSemanticQuery.md b/docs/reference/api/QueryDslSemanticQuery.md new file mode 100644 index 000000000..1bbac26a5 --- /dev/null +++ b/docs/reference/api/QueryDslSemanticQuery.md @@ -0,0 +1,6 @@ +## Interface `QueryDslSemanticQuery` + +| Name | Type | Description | +| - | - | - | +| `field` | string | The field to query, which must be a semantic_text field type | +| `query` | string | The query text | diff --git a/docs/reference/api/QueryDslShapeFieldQuery.md b/docs/reference/api/QueryDslShapeFieldQuery.md new file mode 100644 index 000000000..97da4a4e5 --- /dev/null +++ b/docs/reference/api/QueryDslShapeFieldQuery.md @@ -0,0 +1,7 @@ +## Interface `QueryDslShapeFieldQuery` + +| Name | Type | Description | +| - | - | - | +| `indexed_shape` | [QueryDslFieldLookup](./QueryDslFieldLookup.md) | Queries using a pre-indexed shape. | +| `relation` | [GeoShapeRelation](./GeoShapeRelation.md) | Spatial relation between the query shape and the document shape. | +| `shape` | [GeoShape](./GeoShape.md) | Queries using an inline shape definition in GeoJSON or Well Known Text (WKT) format. | diff --git a/docs/reference/api/QueryDslShapeQuery.md b/docs/reference/api/QueryDslShapeQuery.md new file mode 100644 index 000000000..d36800eab --- /dev/null +++ b/docs/reference/api/QueryDslShapeQuery.md @@ -0,0 +1,4 @@ +## `QueryDslShapeQuery` +::: +type QueryDslShapeQuery = [QueryDslShapeQueryKeys](./QueryDslShapeQueryKeys.md) & { [property: string]: [QueryDslShapeFieldQuery](./QueryDslShapeFieldQuery.md) | boolean | [float](./float.md) | string;}; +::: diff --git a/docs/reference/api/QueryDslShapeQueryKeys.md b/docs/reference/api/QueryDslShapeQueryKeys.md new file mode 100644 index 000000000..66e853fed --- /dev/null +++ b/docs/reference/api/QueryDslShapeQueryKeys.md @@ -0,0 +1,5 @@ +## Interface `QueryDslShapeQueryKeys` + +| Name | Type | Description | +| - | - | - | +| `ignore_unmapped` | boolean | When set to `true` the query ignores an unmapped field and will not match any documents. | diff --git a/docs/reference/api/QueryDslSimpleQueryStringFlag.md b/docs/reference/api/QueryDslSimpleQueryStringFlag.md new file mode 100644 index 000000000..a02b5a918 --- /dev/null +++ b/docs/reference/api/QueryDslSimpleQueryStringFlag.md @@ -0,0 +1,4 @@ +## `QueryDslSimpleQueryStringFlag` +::: +type QueryDslSimpleQueryStringFlag = 'NONE' | 'AND' | 'NOT' | 'OR' | 'PREFIX' | 'PHRASE' | 'PRECEDENCE' | 'ESCAPE' | 'WHITESPACE' | 'FUZZY' | 'NEAR' | 'SLOP' | 'ALL'; +::: diff --git a/docs/reference/api/QueryDslSimpleQueryStringFlags.md b/docs/reference/api/QueryDslSimpleQueryStringFlags.md new file mode 100644 index 000000000..c4fdafbe2 --- /dev/null +++ b/docs/reference/api/QueryDslSimpleQueryStringFlags.md @@ -0,0 +1,4 @@ +## `QueryDslSimpleQueryStringFlags` +::: +type QueryDslSimpleQueryStringFlags = [SpecUtilsPipeSeparatedFlags](./SpecUtilsPipeSeparatedFlags.md)<[QueryDslSimpleQueryStringFlag](./QueryDslSimpleQueryStringFlag.md)>; +::: diff --git a/docs/reference/api/QueryDslSimpleQueryStringQuery.md b/docs/reference/api/QueryDslSimpleQueryStringQuery.md new file mode 100644 index 000000000..afd1b68c3 --- /dev/null +++ b/docs/reference/api/QueryDslSimpleQueryStringQuery.md @@ -0,0 +1,17 @@ +## Interface `QueryDslSimpleQueryStringQuery` + +| Name | Type | Description | +| - | - | - | +| `analyze_wildcard` | boolean | If `true`, the query attempts to analyze wildcard terms in the query string. | +| `analyzer` | string | Analyzer used to convert text in the query string into tokens. | +| `auto_generate_synonyms_phrase_query` | boolean | If `true`, the parser creates a match_phrase query for each multi-position token. | +| `default_operator` | [QueryDslOperator](./QueryDslOperator.md) | Default boolean logic used to interpret text in the query string if no operators are specified. | +| `fields` | [Field](./Field.md)[] | Array of fields you wish to search. Accepts wildcard expressions. You also can boost relevance scores for matches to particular fields using a caret ( `^`) notation. Defaults to the `index.query.default_field index` setting, which has a default value of `*`. | +| `flags` | [QueryDslSimpleQueryStringFlags](./QueryDslSimpleQueryStringFlags.md) | List of enabled operators for the simple query string syntax. | +| `fuzzy_max_expansions` | [integer](./integer.md) | Maximum number of terms to which the query expands for fuzzy matching. | +| `fuzzy_prefix_length` | [integer](./integer.md) | Number of beginning characters left unchanged for fuzzy matching. | +| `fuzzy_transpositions` | boolean | If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`). | +| `lenient` | boolean | If `true`, format-based errors, such as providing a text value for a numeric field, are ignored. | +| `minimum_should_match` | [MinimumShouldMatch](./MinimumShouldMatch.md) | Minimum number of clauses that must match for a document to be returned. | +| `query` | string | Query string in the simple query string syntax you wish to parse and use for search. | +| `quote_field_suffix` | string | Suffix appended to quoted text in the query string. | diff --git a/docs/reference/api/QueryDslSpanContainingQuery.md b/docs/reference/api/QueryDslSpanContainingQuery.md new file mode 100644 index 000000000..0866d66fd --- /dev/null +++ b/docs/reference/api/QueryDslSpanContainingQuery.md @@ -0,0 +1,6 @@ +## Interface `QueryDslSpanContainingQuery` + +| Name | Type | Description | +| - | - | - | +| `big` | [QueryDslSpanQuery](./QueryDslSpanQuery.md) | Can be any span query. Matching spans from `big` that contain matches from `little` are returned. | +| `little` | [QueryDslSpanQuery](./QueryDslSpanQuery.md) | Can be any span query. Matching spans from `big` that contain matches from `little` are returned. | diff --git a/docs/reference/api/QueryDslSpanFieldMaskingQuery.md b/docs/reference/api/QueryDslSpanFieldMaskingQuery.md new file mode 100644 index 000000000..2f90db3d1 --- /dev/null +++ b/docs/reference/api/QueryDslSpanFieldMaskingQuery.md @@ -0,0 +1,6 @@ +## Interface `QueryDslSpanFieldMaskingQuery` + +| Name | Type | Description | +| - | - | - | +| `field` | [Field](./Field.md) |   | +| `query` | [QueryDslSpanQuery](./QueryDslSpanQuery.md) |   | diff --git a/docs/reference/api/QueryDslSpanFirstQuery.md b/docs/reference/api/QueryDslSpanFirstQuery.md new file mode 100644 index 000000000..2b033b3f3 --- /dev/null +++ b/docs/reference/api/QueryDslSpanFirstQuery.md @@ -0,0 +1,6 @@ +## Interface `QueryDslSpanFirstQuery` + +| Name | Type | Description | +| - | - | - | +| `end` | [integer](./integer.md) | Controls the maximum end position permitted in a match. | +| `match` | [QueryDslSpanQuery](./QueryDslSpanQuery.md) | Can be any other span type query. | diff --git a/docs/reference/api/QueryDslSpanGapQuery.md b/docs/reference/api/QueryDslSpanGapQuery.md new file mode 100644 index 000000000..5997d9502 --- /dev/null +++ b/docs/reference/api/QueryDslSpanGapQuery.md @@ -0,0 +1,4 @@ +## `QueryDslSpanGapQuery` +::: +type QueryDslSpanGapQuery = [Partial](./Partial.md)>; +::: diff --git a/docs/reference/api/QueryDslSpanMultiTermQuery.md b/docs/reference/api/QueryDslSpanMultiTermQuery.md new file mode 100644 index 000000000..889e4bb01 --- /dev/null +++ b/docs/reference/api/QueryDslSpanMultiTermQuery.md @@ -0,0 +1,5 @@ +## Interface `QueryDslSpanMultiTermQuery` + +| Name | Type | Description | +| - | - | - | +| `match` | [QueryDslQueryContainer](./QueryDslQueryContainer.md) | Should be a multi term query (one of `wildcard`, `fuzzy`, `prefix`, `range`, or `regexp` query). | diff --git a/docs/reference/api/QueryDslSpanNearQuery.md b/docs/reference/api/QueryDslSpanNearQuery.md new file mode 100644 index 000000000..5d8b9a0be --- /dev/null +++ b/docs/reference/api/QueryDslSpanNearQuery.md @@ -0,0 +1,7 @@ +## Interface `QueryDslSpanNearQuery` + +| Name | Type | Description | +| - | - | - | +| `clauses` | [QueryDslSpanQuery](./QueryDslSpanQuery.md)[] | Array of one or more other span type queries. | +| `in_order` | boolean | Controls whether matches are required to be in-order. | +| `slop` | [integer](./integer.md) | Controls the maximum number of intervening unmatched positions permitted. | diff --git a/docs/reference/api/QueryDslSpanNotQuery.md b/docs/reference/api/QueryDslSpanNotQuery.md new file mode 100644 index 000000000..b3f2d82d8 --- /dev/null +++ b/docs/reference/api/QueryDslSpanNotQuery.md @@ -0,0 +1,9 @@ +## Interface `QueryDslSpanNotQuery` + +| Name | Type | Description | +| - | - | - | +| `dist` | [integer](./integer.md) | The number of tokens from within the include span that can’t have overlap with the exclude span. Equivalent to setting both `pre` and `post`. | +| `exclude` | [QueryDslSpanQuery](./QueryDslSpanQuery.md) | Span query whose matches must not overlap those returned. | +| `include` | [QueryDslSpanQuery](./QueryDslSpanQuery.md) | Span query whose matches are filtered. | +| `post` | [integer](./integer.md) | The number of tokens after the include span that can’t have overlap with the exclude span. | +| `pre` | [integer](./integer.md) | The number of tokens before the include span that can’t have overlap with the exclude span. | diff --git a/docs/reference/api/QueryDslSpanOrQuery.md b/docs/reference/api/QueryDslSpanOrQuery.md new file mode 100644 index 000000000..f7858f82e --- /dev/null +++ b/docs/reference/api/QueryDslSpanOrQuery.md @@ -0,0 +1,5 @@ +## Interface `QueryDslSpanOrQuery` + +| Name | Type | Description | +| - | - | - | +| `clauses` | [QueryDslSpanQuery](./QueryDslSpanQuery.md)[] | Array of one or more other span type queries. | diff --git a/docs/reference/api/QueryDslSpanQuery.md b/docs/reference/api/QueryDslSpanQuery.md new file mode 100644 index 000000000..da4e56786 --- /dev/null +++ b/docs/reference/api/QueryDslSpanQuery.md @@ -0,0 +1,14 @@ +## Interface `QueryDslSpanQuery` + +| Name | Type | Description | +| - | - | - | +| `span_containing` | [QueryDslSpanContainingQuery](./QueryDslSpanContainingQuery.md) | Accepts a list of span queries, but only returns those spans which also match a second span query. | +| `span_field_masking` | [QueryDslSpanFieldMaskingQuery](./QueryDslSpanFieldMaskingQuery.md) | Allows queries like `span_near` or `span_or` across different fields. | +| `span_first` | [QueryDslSpanFirstQuery](./QueryDslSpanFirstQuery.md) | Accepts another span query whose matches must appear within the first N positions of the field. | +| `span_gap` | [QueryDslSpanGapQuery](./QueryDslSpanGapQuery.md) |   | +| `span_multi` | [QueryDslSpanMultiTermQuery](./QueryDslSpanMultiTermQuery.md) | Wraps a `term`, `range`, `prefix`, `wildcard`, `regexp`, or `fuzzy` query. | +| `span_near` | [QueryDslSpanNearQuery](./QueryDslSpanNearQuery.md) | Accepts multiple span queries whose matches must be within the specified distance of each other, and possibly in the same order. | +| `span_not` | [QueryDslSpanNotQuery](./QueryDslSpanNotQuery.md) | Wraps another span query, and excludes any documents which match that query. | +| `span_or` | [QueryDslSpanOrQuery](./QueryDslSpanOrQuery.md) | Combines multiple span queriesandreturns documents which match any of the specified queries. | +| `span_term` | [Partial](./Partial.md)> | The equivalent of the `term` query but for use with other span queries. | +| `span_within` | [QueryDslSpanWithinQuery](./QueryDslSpanWithinQuery.md) | The result from a single span query is returned as long is its span falls within the spans returned by a list of other span queries. | diff --git a/docs/reference/api/QueryDslSpanTermQuery.md b/docs/reference/api/QueryDslSpanTermQuery.md new file mode 100644 index 000000000..663778588 --- /dev/null +++ b/docs/reference/api/QueryDslSpanTermQuery.md @@ -0,0 +1,6 @@ +## Interface `QueryDslSpanTermQuery` + +| Name | Type | Description | +| - | - | - | +| `term` | [FieldValue](./FieldValue.md) | value | +| `value` | [FieldValue](./FieldValue.md) |   | diff --git a/docs/reference/api/QueryDslSpanWithinQuery.md b/docs/reference/api/QueryDslSpanWithinQuery.md new file mode 100644 index 000000000..828b6b13a --- /dev/null +++ b/docs/reference/api/QueryDslSpanWithinQuery.md @@ -0,0 +1,6 @@ +## Interface `QueryDslSpanWithinQuery` + +| Name | Type | Description | +| - | - | - | +| `big` | [QueryDslSpanQuery](./QueryDslSpanQuery.md) | Can be any span query. Matching spans from `little` that are enclosed within `big` are returned. | +| `little` | [QueryDslSpanQuery](./QueryDslSpanQuery.md) | Can be any span query. Matching spans from `little` that are enclosed within `big` are returned. | diff --git a/docs/reference/api/QueryDslSparseVectorQuery.md b/docs/reference/api/QueryDslSparseVectorQuery.md new file mode 100644 index 000000000..ea79c9641 --- /dev/null +++ b/docs/reference/api/QueryDslSparseVectorQuery.md @@ -0,0 +1,10 @@ +## Interface `QueryDslSparseVectorQuery` + +| Name | Type | Description | +| - | - | - | +| `field` | [Field](./Field.md) | The name of the field that contains the token-weight pairs to be searched against. This field must be a mapped sparse_vector field. | +| `inference_id` | [Id](./Id.md) | The inference ID to use to convert the query text into token-weight pairs. It must be the same inference ID that was used to create the tokens from the input text. Only one of inference_id and query_vector is allowed. If inference_id is specified, query must also be specified. Only one of inference_id or query_vector may be supplied in a request. | +| `prune` | boolean | Whether to perform pruning, omitting the non-significant tokens from the query to improve query performance. If prune is true but the pruning_config is not specified, pruning will occur but default values will be used. Default: false | +| `pruning_config` | [QueryDslTokenPruningConfig](./QueryDslTokenPruningConfig.md) | Optional pruning configuration. If enabled, this will omit non-significant tokens from the query in order to improve query performance. This is only used if prune is set to true. If prune is set to true but pruning_config is not specified, default values will be used. | +| `query_vector` | Record | Dictionary of precomputed sparse vectors and their associated weights. Only one of inference_id or query_vector may be supplied in a request. | +| `query` | string | The query text you want to use for search. If inference_id is specified, query must also be specified. | diff --git a/docs/reference/api/QueryDslTermQuery.md b/docs/reference/api/QueryDslTermQuery.md new file mode 100644 index 000000000..3572e3cc6 --- /dev/null +++ b/docs/reference/api/QueryDslTermQuery.md @@ -0,0 +1,6 @@ +## Interface `QueryDslTermQuery` + +| Name | Type | Description | +| - | - | - | +| `case_insensitive` | boolean | Allows ASCII case insensitive matching of the value with the indexed field values when set to `true`. When `false`, the case sensitivity of matching depends on the underlying field’s mapping. | +| `value` | [FieldValue](./FieldValue.md) | Term you wish to find in the provided field. | diff --git a/docs/reference/api/QueryDslTermRangeQuery.md b/docs/reference/api/QueryDslTermRangeQuery.md new file mode 100644 index 000000000..3d95f7492 --- /dev/null +++ b/docs/reference/api/QueryDslTermRangeQuery.md @@ -0,0 +1,4 @@ +## Interface `QueryDslTermRangeQuery` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/QueryDslTermsLookup.md b/docs/reference/api/QueryDslTermsLookup.md new file mode 100644 index 000000000..ca6f7a20f --- /dev/null +++ b/docs/reference/api/QueryDslTermsLookup.md @@ -0,0 +1,8 @@ +## Interface `QueryDslTermsLookup` + +| Name | Type | Description | +| - | - | - | +| `id` | [Id](./Id.md) |   | +| `index` | [IndexName](./IndexName.md) |   | +| `path` | [Field](./Field.md) |   | +| `routing` | [Routing](./Routing.md) |   | diff --git a/docs/reference/api/QueryDslTermsQuery.md b/docs/reference/api/QueryDslTermsQuery.md new file mode 100644 index 000000000..900484a20 --- /dev/null +++ b/docs/reference/api/QueryDslTermsQuery.md @@ -0,0 +1,4 @@ +## `QueryDslTermsQuery` +::: +type QueryDslTermsQuery = [QueryDslTermsQueryKeys](./QueryDslTermsQueryKeys.md) & { [property: string]: [QueryDslTermsQueryField](./QueryDslTermsQueryField.md) | [float](./float.md) | string;}; +::: diff --git a/docs/reference/api/QueryDslTermsQueryField.md b/docs/reference/api/QueryDslTermsQueryField.md new file mode 100644 index 000000000..be9ef9787 --- /dev/null +++ b/docs/reference/api/QueryDslTermsQueryField.md @@ -0,0 +1,4 @@ +## `QueryDslTermsQueryField` +::: +type QueryDslTermsQueryField = [FieldValue](./FieldValue.md)[] | [QueryDslTermsLookup](./QueryDslTermsLookup.md); +::: diff --git a/docs/reference/api/QueryDslTermsQueryKeys.md b/docs/reference/api/QueryDslTermsQueryKeys.md new file mode 100644 index 000000000..1793d92c8 --- /dev/null +++ b/docs/reference/api/QueryDslTermsQueryKeys.md @@ -0,0 +1,4 @@ +## Interface `QueryDslTermsQueryKeys` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/QueryDslTermsSetQuery.md b/docs/reference/api/QueryDslTermsSetQuery.md new file mode 100644 index 000000000..7e0def4d1 --- /dev/null +++ b/docs/reference/api/QueryDslTermsSetQuery.md @@ -0,0 +1,8 @@ +## Interface `QueryDslTermsSetQuery` + +| Name | Type | Description | +| - | - | - | +| `minimum_should_match_field` | [Field](./Field.md) | Numeric field containing the number of matching terms required to return a document. | +| `minimum_should_match_script` | [Script](./Script.md) | [ScriptSource](./ScriptSource.md) | Custom script containing the number of matching terms required to return a document. | +| `minimum_should_match` | [MinimumShouldMatch](./MinimumShouldMatch.md) | Specification describing number of matching terms required to return a document. | +| `terms` | [FieldValue](./FieldValue.md)[] | Array of terms you wish to find in the provided field. | diff --git a/docs/reference/api/QueryDslTextExpansionQuery.md b/docs/reference/api/QueryDslTextExpansionQuery.md new file mode 100644 index 000000000..7c9cdbfbf --- /dev/null +++ b/docs/reference/api/QueryDslTextExpansionQuery.md @@ -0,0 +1,7 @@ +## Interface `QueryDslTextExpansionQuery` + +| Name | Type | Description | +| - | - | - | +| `model_id` | string | The text expansion NLP model to use | +| `model_text` | string | The query text | +| `pruning_config` | [QueryDslTokenPruningConfig](./QueryDslTokenPruningConfig.md) | Token pruning configurations | diff --git a/docs/reference/api/QueryDslTextQueryType.md b/docs/reference/api/QueryDslTextQueryType.md new file mode 100644 index 000000000..3e56cf94d --- /dev/null +++ b/docs/reference/api/QueryDslTextQueryType.md @@ -0,0 +1,4 @@ +## `QueryDslTextQueryType` +::: +type QueryDslTextQueryType = 'best_fields' | 'most_fields' | 'cross_fields' | 'phrase' | 'phrase_prefix' | 'bool_prefix'; +::: diff --git a/docs/reference/api/QueryDslTokenPruningConfig.md b/docs/reference/api/QueryDslTokenPruningConfig.md new file mode 100644 index 000000000..868610c02 --- /dev/null +++ b/docs/reference/api/QueryDslTokenPruningConfig.md @@ -0,0 +1,7 @@ +## Interface `QueryDslTokenPruningConfig` + +| Name | Type | Description | +| - | - | - | +| `only_score_pruned_tokens` | boolean | Whether to only score pruned tokens, vs only scoring kept tokens. | +| `tokens_freq_ratio_threshold` | [integer](./integer.md) | Tokens whose frequency is more than this threshold times the average frequency of all tokens in the specified field are considered outliers and pruned. | +| `tokens_weight_threshold` | [float](./float.md) | Tokens whose weight is less than this threshold are considered nonsignificant and pruned. | diff --git a/docs/reference/api/QueryDslTypeQuery.md b/docs/reference/api/QueryDslTypeQuery.md new file mode 100644 index 000000000..bed46e6d6 --- /dev/null +++ b/docs/reference/api/QueryDslTypeQuery.md @@ -0,0 +1,5 @@ +## Interface `QueryDslTypeQuery` + +| Name | Type | Description | +| - | - | - | +| `value` | string |   | diff --git a/docs/reference/api/QueryDslUntypedDecayFunction.md b/docs/reference/api/QueryDslUntypedDecayFunction.md new file mode 100644 index 000000000..8281b32d5 --- /dev/null +++ b/docs/reference/api/QueryDslUntypedDecayFunction.md @@ -0,0 +1,4 @@ +## `QueryDslUntypedDecayFunction` +::: +type QueryDslUntypedDecayFunction = [QueryDslUntypedDecayFunctionKeys](./QueryDslUntypedDecayFunctionKeys.md) & { [property: string]: [QueryDslDecayPlacement](./QueryDslDecayPlacement.md) | [QueryDslMultiValueMode](./QueryDslMultiValueMode.md);}; +::: diff --git a/docs/reference/api/QueryDslUntypedDecayFunctionKeys.md b/docs/reference/api/QueryDslUntypedDecayFunctionKeys.md new file mode 100644 index 000000000..c2b7e689b --- /dev/null +++ b/docs/reference/api/QueryDslUntypedDecayFunctionKeys.md @@ -0,0 +1,4 @@ +## Interface `QueryDslUntypedDecayFunctionKeys` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/QueryDslUntypedDistanceFeatureQuery.md b/docs/reference/api/QueryDslUntypedDistanceFeatureQuery.md new file mode 100644 index 000000000..7ffed5a03 --- /dev/null +++ b/docs/reference/api/QueryDslUntypedDistanceFeatureQuery.md @@ -0,0 +1,4 @@ +## Interface `QueryDslUntypedDistanceFeatureQuery` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/QueryDslUntypedRangeQuery.md b/docs/reference/api/QueryDslUntypedRangeQuery.md new file mode 100644 index 000000000..112bd0f67 --- /dev/null +++ b/docs/reference/api/QueryDslUntypedRangeQuery.md @@ -0,0 +1,6 @@ +## Interface `QueryDslUntypedRangeQuery` + +| Name | Type | Description | +| - | - | - | +| `format` | [DateFormat](./DateFormat.md) | Date format used to convert `date` values in the query. | +| `time_zone` | [TimeZone](./TimeZone.md) | Coordinated Universal Time (UTC) offset or IANA time zone used to convert `date` values in the query to UTC. | diff --git a/docs/reference/api/QueryDslWeightedTokensQuery.md b/docs/reference/api/QueryDslWeightedTokensQuery.md new file mode 100644 index 000000000..034810c4c --- /dev/null +++ b/docs/reference/api/QueryDslWeightedTokensQuery.md @@ -0,0 +1,6 @@ +## Interface `QueryDslWeightedTokensQuery` + +| Name | Type | Description | +| - | - | - | +| `pruning_config` | [QueryDslTokenPruningConfig](./QueryDslTokenPruningConfig.md) | Token pruning configurations | +| `tokens` | Record | The tokens representing this query | diff --git a/docs/reference/api/QueryDslWildcardQuery.md b/docs/reference/api/QueryDslWildcardQuery.md new file mode 100644 index 000000000..9dba21fae --- /dev/null +++ b/docs/reference/api/QueryDslWildcardQuery.md @@ -0,0 +1,8 @@ +## Interface `QueryDslWildcardQuery` + +| Name | Type | Description | +| - | - | - | +| `case_insensitive` | boolean | Allows case insensitive matching of the pattern with the indexed field values when set to true. Default is false which means the case sensitivity of matching depends on the underlying field’s mapping. | +| `rewrite` | [MultiTermQueryRewrite](./MultiTermQueryRewrite.md) | Method used to rewrite the query. | +| `value` | string | Wildcard pattern for terms you wish to find in the provided field. Required, when wildcard is not set. | +| `wildcard` | string | Wildcard pattern for terms you wish to find in the provided field. Required, when value is not set. | diff --git a/docs/reference/api/QueryDslWrapperQuery.md b/docs/reference/api/QueryDslWrapperQuery.md new file mode 100644 index 000000000..7ba77c89d --- /dev/null +++ b/docs/reference/api/QueryDslWrapperQuery.md @@ -0,0 +1,5 @@ +## Interface `QueryDslWrapperQuery` + +| Name | Type | Description | +| - | - | - | +| `query` | string | A base64 encoded query. The binary data format can be any of JSON, YAML, CBOR or SMILE encodings | diff --git a/docs/reference/api/QueryDslZeroTermsQuery.md b/docs/reference/api/QueryDslZeroTermsQuery.md new file mode 100644 index 000000000..44f3563c2 --- /dev/null +++ b/docs/reference/api/QueryDslZeroTermsQuery.md @@ -0,0 +1,4 @@ +## `QueryDslZeroTermsQuery` +::: +type QueryDslZeroTermsQuery = 'all' | 'none'; +::: diff --git a/docs/reference/api/QueryRules.md b/docs/reference/api/QueryRules.md new file mode 100644 index 000000000..29466905a --- /dev/null +++ b/docs/reference/api/QueryRules.md @@ -0,0 +1,20 @@ +## `QueryRules` + +### Constructor + +::: +new QueryRules(transport: [Transport](./Transport.md)); +::: + +### Properties + +| Name | Type | Description | +| - | - | - | +| `acceptedParams` | Record |   | +| `transport` | [Transport](./Transport.md) |   | + +### Methods + +| Name | Signature | Description | +| - | - | - | +| `deleteRule` | `deleteRule(this: [That](./That.md), params: [QueryRulesDeleteRuleRequest](./QueryRulesDeleteRuleRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[QueryRulesDeleteRuleResponse](./QueryRulesDeleteRuleResponse.md)>;` | Delete a query rule. Delete a query rule within a query ruleset. This is a destructive action that is only recoverable by re-adding the same rule with the create or update query rule API. || `deleteRule` | `deleteRule(this: [That](./That.md), params: [QueryRulesDeleteRuleRequest](./QueryRulesDeleteRuleRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[QueryRulesDeleteRuleResponse](./QueryRulesDeleteRuleResponse.md), unknown>>;` |   || `deleteRule` | `deleteRule(this: [That](./That.md), params: [QueryRulesDeleteRuleRequest](./QueryRulesDeleteRuleRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[QueryRulesDeleteRuleResponse](./QueryRulesDeleteRuleResponse.md)>;` |   || `deleteRuleset` | `deleteRuleset(this: [That](./That.md), params: [QueryRulesDeleteRulesetRequest](./QueryRulesDeleteRulesetRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[QueryRulesDeleteRulesetResponse](./QueryRulesDeleteRulesetResponse.md)>;` | Delete a query ruleset. Remove a query ruleset and its associated data. This is a destructive action that is not recoverable. || `deleteRuleset` | `deleteRuleset(this: [That](./That.md), params: [QueryRulesDeleteRulesetRequest](./QueryRulesDeleteRulesetRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[QueryRulesDeleteRulesetResponse](./QueryRulesDeleteRulesetResponse.md), unknown>>;` |   || `deleteRuleset` | `deleteRuleset(this: [That](./That.md), params: [QueryRulesDeleteRulesetRequest](./QueryRulesDeleteRulesetRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[QueryRulesDeleteRulesetResponse](./QueryRulesDeleteRulesetResponse.md)>;` |   || `getRule` | `getRule(this: [That](./That.md), params: [QueryRulesGetRuleRequest](./QueryRulesGetRuleRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[QueryRulesGetRuleResponse](./QueryRulesGetRuleResponse.md)>;` | Get a query rule. Get details about a query rule within a query ruleset. || `getRule` | `getRule(this: [That](./That.md), params: [QueryRulesGetRuleRequest](./QueryRulesGetRuleRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[QueryRulesGetRuleResponse](./QueryRulesGetRuleResponse.md), unknown>>;` |   || `getRule` | `getRule(this: [That](./That.md), params: [QueryRulesGetRuleRequest](./QueryRulesGetRuleRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[QueryRulesGetRuleResponse](./QueryRulesGetRuleResponse.md)>;` |   || `getRuleset` | `getRuleset(this: [That](./That.md), params: [QueryRulesGetRulesetRequest](./QueryRulesGetRulesetRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[QueryRulesGetRulesetResponse](./QueryRulesGetRulesetResponse.md)>;` | Get a query ruleset. Get details about a query ruleset. || `getRuleset` | `getRuleset(this: [That](./That.md), params: [QueryRulesGetRulesetRequest](./QueryRulesGetRulesetRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[QueryRulesGetRulesetResponse](./QueryRulesGetRulesetResponse.md), unknown>>;` |   || `getRuleset` | `getRuleset(this: [That](./That.md), params: [QueryRulesGetRulesetRequest](./QueryRulesGetRulesetRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[QueryRulesGetRulesetResponse](./QueryRulesGetRulesetResponse.md)>;` |   || `listRulesets` | `listRulesets(this: [That](./That.md), params?: [QueryRulesListRulesetsRequest](./QueryRulesListRulesetsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[QueryRulesListRulesetsResponse](./QueryRulesListRulesetsResponse.md)>;` | Get all query rulesets. Get summarized information about the query rulesets. || `listRulesets` | `listRulesets(this: [That](./That.md), params?: [QueryRulesListRulesetsRequest](./QueryRulesListRulesetsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[QueryRulesListRulesetsResponse](./QueryRulesListRulesetsResponse.md), unknown>>;` |   || `listRulesets` | `listRulesets(this: [That](./That.md), params?: [QueryRulesListRulesetsRequest](./QueryRulesListRulesetsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[QueryRulesListRulesetsResponse](./QueryRulesListRulesetsResponse.md)>;` |   || `putRule` | `putRule(this: [That](./That.md), params: [QueryRulesPutRuleRequest](./QueryRulesPutRuleRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[QueryRulesPutRuleResponse](./QueryRulesPutRuleResponse.md)>;` | Create or update a query rule. Create or update a query rule within a query ruleset. IMPORTANT: Due to limitations within pinned queries, you can only pin documents using ids or docs, but cannot use both in single rule. It is advised to use one or the other in query rulesets, to avoid errors. Additionally, pinned queries have a maximum limit of 100 pinned hits. If multiple matching rules pin more than 100 documents, only the first 100 documents are pinned in the order they are specified in the ruleset. || `putRule` | `putRule(this: [That](./That.md), params: [QueryRulesPutRuleRequest](./QueryRulesPutRuleRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[QueryRulesPutRuleResponse](./QueryRulesPutRuleResponse.md), unknown>>;` |   || `putRule` | `putRule(this: [That](./That.md), params: [QueryRulesPutRuleRequest](./QueryRulesPutRuleRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[QueryRulesPutRuleResponse](./QueryRulesPutRuleResponse.md)>;` |   || `putRuleset` | `putRuleset(this: [That](./That.md), params: [QueryRulesPutRulesetRequest](./QueryRulesPutRulesetRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[QueryRulesPutRulesetResponse](./QueryRulesPutRulesetResponse.md)>;` | Create or update a query ruleset. There is a limit of 100 rules per ruleset. This limit can be increased by using the `xpack.applications.rules.max_rules_per_ruleset` cluster setting. IMPORTANT: Due to limitations within pinned queries, you can only select documents using `ids` or `docs`, but cannot use both in single rule. It is advised to use one or the other in query rulesets, to avoid errors. Additionally, pinned queries have a maximum limit of 100 pinned hits. If multiple matching rules pin more than 100 documents, only the first 100 documents are pinned in the order they are specified in the ruleset. || `putRuleset` | `putRuleset(this: [That](./That.md), params: [QueryRulesPutRulesetRequest](./QueryRulesPutRulesetRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[QueryRulesPutRulesetResponse](./QueryRulesPutRulesetResponse.md), unknown>>;` |   || `putRuleset` | `putRuleset(this: [That](./That.md), params: [QueryRulesPutRulesetRequest](./QueryRulesPutRulesetRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[QueryRulesPutRulesetResponse](./QueryRulesPutRulesetResponse.md)>;` |   || `test` | `test(this: [That](./That.md), params: [QueryRulesTestRequest](./QueryRulesTestRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[QueryRulesTestResponse](./QueryRulesTestResponse.md)>;` | Test a query ruleset. Evaluate match criteria against a query ruleset to identify the rules that would match that criteria. || `test` | `test(this: [That](./That.md), params: [QueryRulesTestRequest](./QueryRulesTestRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[QueryRulesTestResponse](./QueryRulesTestResponse.md), unknown>>;` |   || `test` | `test(this: [That](./That.md), params: [QueryRulesTestRequest](./QueryRulesTestRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[QueryRulesTestResponse](./QueryRulesTestResponse.md)>;` |   | \ No newline at end of file diff --git a/docs/reference/api/QueryRulesDeleteRuleRequest.md b/docs/reference/api/QueryRulesDeleteRuleRequest.md new file mode 100644 index 000000000..de1ae8475 --- /dev/null +++ b/docs/reference/api/QueryRulesDeleteRuleRequest.md @@ -0,0 +1,8 @@ +## Interface `QueryRulesDeleteRuleRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { ruleset_id?: never; rule_id?: never; }) | All values in `body` will be added to the request body. | +| `querystring` | { [key: string]: any; } & { ruleset_id?: never; rule_id?: never; } | All values in `querystring` will be added to the request querystring. | +| `rule_id` | [Id](./Id.md) | The unique identifier of the query rule within the specified ruleset to delete | +| `ruleset_id` | [Id](./Id.md) | The unique identifier of the query ruleset containing the rule to delete | diff --git a/docs/reference/api/QueryRulesDeleteRuleResponse.md b/docs/reference/api/QueryRulesDeleteRuleResponse.md new file mode 100644 index 000000000..9e7edfeda --- /dev/null +++ b/docs/reference/api/QueryRulesDeleteRuleResponse.md @@ -0,0 +1,4 @@ +## `QueryRulesDeleteRuleResponse` +::: +type QueryRulesDeleteRuleResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); +::: diff --git a/docs/reference/api/QueryRulesDeleteRulesetRequest.md b/docs/reference/api/QueryRulesDeleteRulesetRequest.md new file mode 100644 index 000000000..ab5e7278f --- /dev/null +++ b/docs/reference/api/QueryRulesDeleteRulesetRequest.md @@ -0,0 +1,7 @@ +## Interface `QueryRulesDeleteRulesetRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { ruleset_id?: never; }) | All values in `body` will be added to the request body. | +| `querystring` | { [key: string]: any; } & { ruleset_id?: never; } | All values in `querystring` will be added to the request querystring. | +| `ruleset_id` | [Id](./Id.md) | The unique identifier of the query ruleset to delete | diff --git a/docs/reference/api/QueryRulesDeleteRulesetResponse.md b/docs/reference/api/QueryRulesDeleteRulesetResponse.md new file mode 100644 index 000000000..2ee181dec --- /dev/null +++ b/docs/reference/api/QueryRulesDeleteRulesetResponse.md @@ -0,0 +1,4 @@ +## `QueryRulesDeleteRulesetResponse` +::: +type QueryRulesDeleteRulesetResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); +::: diff --git a/docs/reference/api/QueryRulesGetRuleRequest.md b/docs/reference/api/QueryRulesGetRuleRequest.md new file mode 100644 index 000000000..d4110a213 --- /dev/null +++ b/docs/reference/api/QueryRulesGetRuleRequest.md @@ -0,0 +1,8 @@ +## Interface `QueryRulesGetRuleRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { ruleset_id?: never; rule_id?: never; }) | All values in `body` will be added to the request body. | +| `querystring` | { [key: string]: any; } & { ruleset_id?: never; rule_id?: never; } | All values in `querystring` will be added to the request querystring. | +| `rule_id` | [Id](./Id.md) | The unique identifier of the query rule within the specified ruleset to retrieve | +| `ruleset_id` | [Id](./Id.md) | The unique identifier of the query ruleset containing the rule to retrieve | diff --git a/docs/reference/api/QueryRulesGetRuleResponse.md b/docs/reference/api/QueryRulesGetRuleResponse.md new file mode 100644 index 000000000..7c4f8a5c7 --- /dev/null +++ b/docs/reference/api/QueryRulesGetRuleResponse.md @@ -0,0 +1,4 @@ +## `QueryRulesGetRuleResponse` +::: +type QueryRulesGetRuleResponse = [QueryRulesQueryRule](./QueryRulesQueryRule.md); +::: diff --git a/docs/reference/api/QueryRulesGetRulesetRequest.md b/docs/reference/api/QueryRulesGetRulesetRequest.md new file mode 100644 index 000000000..a21e406d4 --- /dev/null +++ b/docs/reference/api/QueryRulesGetRulesetRequest.md @@ -0,0 +1,7 @@ +## Interface `QueryRulesGetRulesetRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { ruleset_id?: never; }) | All values in `body` will be added to the request body. | +| `querystring` | { [key: string]: any; } & { ruleset_id?: never; } | All values in `querystring` will be added to the request querystring. | +| `ruleset_id` | [Id](./Id.md) | The unique identifier of the query ruleset | diff --git a/docs/reference/api/QueryRulesGetRulesetResponse.md b/docs/reference/api/QueryRulesGetRulesetResponse.md new file mode 100644 index 000000000..c53dc7aca --- /dev/null +++ b/docs/reference/api/QueryRulesGetRulesetResponse.md @@ -0,0 +1,4 @@ +## `QueryRulesGetRulesetResponse` +::: +type QueryRulesGetRulesetResponse = [QueryRulesQueryRuleset](./QueryRulesQueryRuleset.md); +::: diff --git a/docs/reference/api/QueryRulesListRulesetsQueryRulesetListItem.md b/docs/reference/api/QueryRulesListRulesetsQueryRulesetListItem.md new file mode 100644 index 000000000..20803114b --- /dev/null +++ b/docs/reference/api/QueryRulesListRulesetsQueryRulesetListItem.md @@ -0,0 +1,8 @@ +## Interface `QueryRulesListRulesetsQueryRulesetListItem` + +| Name | Type | Description | +| - | - | - | +| `rule_criteria_types_counts` | Record | A map of criteria type (for example, `exact`) to the number of rules of that type. NOTE: The counts in `rule_criteria_types_counts` may be larger than the value of `rule_total_count` because a rule may have multiple criteria. | +| `rule_total_count` | [integer](./integer.md) | The number of rules associated with the ruleset. | +| `rule_type_counts` | Record | A map of rule type (for example, `pinned`) to the number of rules of that type. | +| `ruleset_id` | [Id](./Id.md) | A unique identifier for the ruleset. | diff --git a/docs/reference/api/QueryRulesListRulesetsRequest.md b/docs/reference/api/QueryRulesListRulesetsRequest.md new file mode 100644 index 000000000..f6feffe19 --- /dev/null +++ b/docs/reference/api/QueryRulesListRulesetsRequest.md @@ -0,0 +1,8 @@ +## Interface `QueryRulesListRulesetsRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { from?: never; size?: never; }) | All values in `body` will be added to the request body. | +| `from` | [integer](./integer.md) | The offset from the first result to fetch. | +| `querystring` | { [key: string]: any; } & { from?: never; size?: never; } | All values in `querystring` will be added to the request querystring. | +| `size` | [integer](./integer.md) | The maximum number of results to retrieve. | diff --git a/docs/reference/api/QueryRulesListRulesetsResponse.md b/docs/reference/api/QueryRulesListRulesetsResponse.md new file mode 100644 index 000000000..852b4c4c0 --- /dev/null +++ b/docs/reference/api/QueryRulesListRulesetsResponse.md @@ -0,0 +1,6 @@ +## Interface `QueryRulesListRulesetsResponse` + +| Name | Type | Description | +| - | - | - | +| `count` | [long](./long.md) |   | +| `results` | [QueryRulesListRulesetsQueryRulesetListItem](./QueryRulesListRulesetsQueryRulesetListItem.md)[] |   | diff --git a/docs/reference/api/QueryRulesPutRuleRequest.md b/docs/reference/api/QueryRulesPutRuleRequest.md new file mode 100644 index 000000000..bfcf965c7 --- /dev/null +++ b/docs/reference/api/QueryRulesPutRuleRequest.md @@ -0,0 +1,12 @@ +## Interface `QueryRulesPutRuleRequest` + +| Name | Type | Description | +| - | - | - | +| `actions` | [QueryRulesQueryRuleActions](./QueryRulesQueryRuleActions.md) | The actions to take when the rule is matched. The format of this action depends on the rule type. | +| `body` | string | ({ [key: string]: any; } & { ruleset_id?: never; rule_id?: never; type?: never; criteria?: never; actions?: never; priority?: never; }) | All values in `body` will be added to the request body. | +| `criteria` | [QueryRulesQueryRuleCriteria](./QueryRulesQueryRuleCriteria.md) | [QueryRulesQueryRuleCriteria](./QueryRulesQueryRuleCriteria.md)[] | The criteria that must be met for the rule to be applied. If multiple criteria are specified for a rule, all criteria must be met for the rule to be applied. | +| `priority` | [integer](./integer.md) |   | +| `querystring` | { [key: string]: any; } & { ruleset_id?: never; rule_id?: never; type?: never; criteria?: never; actions?: never; priority?: never; } | All values in `querystring` will be added to the request querystring. | +| `rule_id` | [Id](./Id.md) | The unique identifier of the query rule within the specified ruleset to be created or updated. | +| `ruleset_id` | [Id](./Id.md) | The unique identifier of the query ruleset containing the rule to be created or updated. | +| `type` | [QueryRulesQueryRuleType](./QueryRulesQueryRuleType.md) | The type of rule. | diff --git a/docs/reference/api/QueryRulesPutRuleResponse.md b/docs/reference/api/QueryRulesPutRuleResponse.md new file mode 100644 index 000000000..6b5b75e8e --- /dev/null +++ b/docs/reference/api/QueryRulesPutRuleResponse.md @@ -0,0 +1,5 @@ +## Interface `QueryRulesPutRuleResponse` + +| Name | Type | Description | +| - | - | - | +| `result` | [Result](./Result.md) |   | diff --git a/docs/reference/api/QueryRulesPutRulesetRequest.md b/docs/reference/api/QueryRulesPutRulesetRequest.md new file mode 100644 index 000000000..02abe3209 --- /dev/null +++ b/docs/reference/api/QueryRulesPutRulesetRequest.md @@ -0,0 +1,8 @@ +## Interface `QueryRulesPutRulesetRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { ruleset_id?: never; rules?: never; }) | All values in `body` will be added to the request body. | +| `querystring` | { [key: string]: any; } & { ruleset_id?: never; rules?: never; } | All values in `querystring` will be added to the request querystring. | +| `rules` | [QueryRulesQueryRule](./QueryRulesQueryRule.md) | [QueryRulesQueryRule](./QueryRulesQueryRule.md)[] |   | +| `ruleset_id` | [Id](./Id.md) | The unique identifier of the query ruleset to be created or updated. | diff --git a/docs/reference/api/QueryRulesPutRulesetResponse.md b/docs/reference/api/QueryRulesPutRulesetResponse.md new file mode 100644 index 000000000..61a94065f --- /dev/null +++ b/docs/reference/api/QueryRulesPutRulesetResponse.md @@ -0,0 +1,5 @@ +## Interface `QueryRulesPutRulesetResponse` + +| Name | Type | Description | +| - | - | - | +| `result` | [Result](./Result.md) |   | diff --git a/docs/reference/api/QueryRulesQueryRule.md b/docs/reference/api/QueryRulesQueryRule.md new file mode 100644 index 000000000..97b50863e --- /dev/null +++ b/docs/reference/api/QueryRulesQueryRule.md @@ -0,0 +1,9 @@ +## Interface `QueryRulesQueryRule` + +| Name | Type | Description | +| - | - | - | +| `actions` | [QueryRulesQueryRuleActions](./QueryRulesQueryRuleActions.md) | The actions to take when the rule is matched. The format of this action depends on the rule type. | +| `criteria` | [QueryRulesQueryRuleCriteria](./QueryRulesQueryRuleCriteria.md) | [QueryRulesQueryRuleCriteria](./QueryRulesQueryRuleCriteria.md)[] | The criteria that must be met for the rule to be applied. If multiple criteria are specified for a rule, all criteria must be met for the rule to be applied. | +| `priority` | [integer](./integer.md) |   | +| `rule_id` | [Id](./Id.md) | A unique identifier for the rule. | +| `type` | [QueryRulesQueryRuleType](./QueryRulesQueryRuleType.md) | The type of rule. `pinned` will identify and pin specific documents to the top of search results. `exclude` will exclude specific documents from search results. | diff --git a/docs/reference/api/QueryRulesQueryRuleActions.md b/docs/reference/api/QueryRulesQueryRuleActions.md new file mode 100644 index 000000000..02573457e --- /dev/null +++ b/docs/reference/api/QueryRulesQueryRuleActions.md @@ -0,0 +1,6 @@ +## Interface `QueryRulesQueryRuleActions` + +| Name | Type | Description | +| - | - | - | +| `docs` | [QueryDslPinnedDoc](./QueryDslPinnedDoc.md)[] | The documents to apply the rule to. Only one of `ids` or `docs` may be specified and at least one must be specified. There is a maximum value of 100 documents in a rule. You can specify the following attributes for each document: * `_index`: The index of the document to pin. * `_id`: The unique document ID. | +| `ids` | [Id](./Id.md)[] | The unique document IDs of the documents to apply the rule to. Only one of `ids` or `docs` may be specified and at least one must be specified. | diff --git a/docs/reference/api/QueryRulesQueryRuleCriteria.md b/docs/reference/api/QueryRulesQueryRuleCriteria.md new file mode 100644 index 000000000..22b3ee383 --- /dev/null +++ b/docs/reference/api/QueryRulesQueryRuleCriteria.md @@ -0,0 +1,7 @@ +## Interface `QueryRulesQueryRuleCriteria` + +| Name | Type | Description | +| - | - | - | +| `metadata` | string | The metadata field to match against. This metadata will be used to match against `match_criteria` sent in the rule. It is required for all criteria types except `always`. | +| `type` | [QueryRulesQueryRuleCriteriaType](./QueryRulesQueryRuleCriteriaType.md) | The type of criteria. The following criteria types are supported: * `always`: Matches all queries, regardless of input. * `contains`: Matches that contain this value anywhere in the field meet the criteria defined by the rule. Only applicable for string values. * `exact`: Only exact matches meet the criteria defined by the rule. Applicable for string or numerical values. * `fuzzy`: Exact matches or matches within the allowed Levenshtein Edit Distance meet the criteria defined by the rule. Only applicable for string values. * `gt`: Matches with a value greater than this value meet the criteria defined by the rule. Only applicable for numerical values. * `gte`: Matches with a value greater than or equal to this value meet the criteria defined by the rule. Only applicable for numerical values. * `lt`: Matches with a value less than this value meet the criteria defined by the rule. Only applicable for numerical values. * `lte`: Matches with a value less than or equal to this value meet the criteria defined by the rule. Only applicable for numerical values. * `prefix`: Matches that start with this value meet the criteria defined by the rule. Only applicable for string values. * `suffix`: Matches that end with this value meet the criteria defined by the rule. Only applicable for string values. | +| `values` | any[] | The values to match against the `metadata` field. Only one value must match for the criteria to be met. It is required for all criteria types except `always`. | diff --git a/docs/reference/api/QueryRulesQueryRuleCriteriaType.md b/docs/reference/api/QueryRulesQueryRuleCriteriaType.md new file mode 100644 index 000000000..f8a4a35d7 --- /dev/null +++ b/docs/reference/api/QueryRulesQueryRuleCriteriaType.md @@ -0,0 +1,4 @@ +## `QueryRulesQueryRuleCriteriaType` +::: +type QueryRulesQueryRuleCriteriaType = 'global' | 'exact' | 'exact_fuzzy' | 'fuzzy' | 'prefix' | 'suffix' | 'contains' | 'lt' | 'lte' | 'gt' | 'gte' | 'always'; +::: diff --git a/docs/reference/api/QueryRulesQueryRuleType.md b/docs/reference/api/QueryRulesQueryRuleType.md new file mode 100644 index 000000000..f5e9ef511 --- /dev/null +++ b/docs/reference/api/QueryRulesQueryRuleType.md @@ -0,0 +1,4 @@ +## `QueryRulesQueryRuleType` +::: +type QueryRulesQueryRuleType = 'pinned' | 'exclude'; +::: diff --git a/docs/reference/api/QueryRulesQueryRuleset.md b/docs/reference/api/QueryRulesQueryRuleset.md new file mode 100644 index 000000000..60499a011 --- /dev/null +++ b/docs/reference/api/QueryRulesQueryRuleset.md @@ -0,0 +1,6 @@ +## Interface `QueryRulesQueryRuleset` + +| Name | Type | Description | +| - | - | - | +| `rules` | [QueryRulesQueryRule](./QueryRulesQueryRule.md)[] | Rules associated with the query ruleset. | +| `ruleset_id` | [Id](./Id.md) | A unique identifier for the ruleset. | diff --git a/docs/reference/api/QueryRulesTestQueryRulesetMatchedRule.md b/docs/reference/api/QueryRulesTestQueryRulesetMatchedRule.md new file mode 100644 index 000000000..f17c56b70 --- /dev/null +++ b/docs/reference/api/QueryRulesTestQueryRulesetMatchedRule.md @@ -0,0 +1,6 @@ +## Interface `QueryRulesTestQueryRulesetMatchedRule` + +| Name | Type | Description | +| - | - | - | +| `rule_id` | [Id](./Id.md) | Rule unique identifier within that ruleset | +| `ruleset_id` | [Id](./Id.md) | Ruleset unique identifier | diff --git a/docs/reference/api/QueryRulesTestRequest.md b/docs/reference/api/QueryRulesTestRequest.md new file mode 100644 index 000000000..20e04aef2 --- /dev/null +++ b/docs/reference/api/QueryRulesTestRequest.md @@ -0,0 +1,8 @@ +## Interface `QueryRulesTestRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { ruleset_id?: never; match_criteria?: never; }) | All values in `body` will be added to the request body. | +| `match_criteria` | Record | The match criteria to apply to rules in the given query ruleset. Match criteria should match the keys defined in the `criteria.metadata` field of the rule. | +| `querystring` | { [key: string]: any; } & { ruleset_id?: never; match_criteria?: never; } | All values in `querystring` will be added to the request querystring. | +| `ruleset_id` | [Id](./Id.md) | The unique identifier of the query ruleset to be created or updated | diff --git a/docs/reference/api/QueryRulesTestResponse.md b/docs/reference/api/QueryRulesTestResponse.md new file mode 100644 index 000000000..13b0d6130 --- /dev/null +++ b/docs/reference/api/QueryRulesTestResponse.md @@ -0,0 +1,6 @@ +## Interface `QueryRulesTestResponse` + +| Name | Type | Description | +| - | - | - | +| `matched_rules` | [QueryRulesTestQueryRulesetMatchedRule](./QueryRulesTestQueryRulesetMatchedRule.md)[] |   | +| `total_matched_rules` | [integer](./integer.md) |   | diff --git a/docs/reference/api/QueryVector.md b/docs/reference/api/QueryVector.md new file mode 100644 index 000000000..a59df2954 --- /dev/null +++ b/docs/reference/api/QueryVector.md @@ -0,0 +1,4 @@ +## `QueryVector` +::: +type QueryVector = [float](./float.md)[]; +::: diff --git a/docs/reference/api/QueryVectorBuilder.md b/docs/reference/api/QueryVectorBuilder.md new file mode 100644 index 000000000..02bf8ab0e --- /dev/null +++ b/docs/reference/api/QueryVectorBuilder.md @@ -0,0 +1,5 @@ +## Interface `QueryVectorBuilder` + +| Name | Type | Description | +| - | - | - | +| `text_embedding` | [TextEmbedding](./TextEmbedding.md) |   | diff --git a/docs/reference/api/RRFRetriever.md b/docs/reference/api/RRFRetriever.md new file mode 100644 index 000000000..9dba43d00 --- /dev/null +++ b/docs/reference/api/RRFRetriever.md @@ -0,0 +1,7 @@ +## Interface `RRFRetriever` + +| Name | Type | Description | +| - | - | - | +| `rank_constant` | [integer](./integer.md) | This value determines how much influence documents in individual result sets per query have over the final ranked result set. | +| `rank_window_size` | [integer](./integer.md) | This value determines the size of the individual result sets per query. | +| `retrievers` | [RetrieverContainer](./RetrieverContainer.md)[] | A list of child retrievers to specify which sets of returned top documents will have the RRF formula applied to them. | diff --git a/docs/reference/api/RankBase.md b/docs/reference/api/RankBase.md new file mode 100644 index 000000000..52f8aa591 --- /dev/null +++ b/docs/reference/api/RankBase.md @@ -0,0 +1,4 @@ +## Interface `RankBase` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/RankContainer.md b/docs/reference/api/RankContainer.md new file mode 100644 index 000000000..3983ee23a --- /dev/null +++ b/docs/reference/api/RankContainer.md @@ -0,0 +1,5 @@ +## Interface `RankContainer` + +| Name | Type | Description | +| - | - | - | +| `rrf` | [RrfRank](./RrfRank.md) | The reciprocal rank fusion parameters | diff --git a/docs/reference/api/RankEvalApi_1.md b/docs/reference/api/RankEvalApi_1.md new file mode 100644 index 000000000..b908aa0eb --- /dev/null +++ b/docs/reference/api/RankEvalApi_1.md @@ -0,0 +1,3 @@ +::: +default function RankEvalApi(this: [That](./That.md), params: [RankEvalRequest](./RankEvalRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[RankEvalResponse](./RankEvalResponse.md)>; +::: diff --git a/docs/reference/api/RankEvalApi_2.md b/docs/reference/api/RankEvalApi_2.md new file mode 100644 index 000000000..198cf8205 --- /dev/null +++ b/docs/reference/api/RankEvalApi_2.md @@ -0,0 +1,3 @@ +::: +default function RankEvalApi(this: [That](./That.md), params: [RankEvalRequest](./RankEvalRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[RankEvalResponse](./RankEvalResponse.md), unknown>>; +::: diff --git a/docs/reference/api/RankEvalApi_3.md b/docs/reference/api/RankEvalApi_3.md new file mode 100644 index 000000000..6024561f6 --- /dev/null +++ b/docs/reference/api/RankEvalApi_3.md @@ -0,0 +1,3 @@ +::: +default function RankEvalApi(this: [That](./That.md), params: [RankEvalRequest](./RankEvalRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[RankEvalResponse](./RankEvalResponse.md)>; +::: diff --git a/docs/reference/api/RankEvalDocumentRating.md b/docs/reference/api/RankEvalDocumentRating.md new file mode 100644 index 000000000..521cb9fe8 --- /dev/null +++ b/docs/reference/api/RankEvalDocumentRating.md @@ -0,0 +1,7 @@ +## Interface `RankEvalDocumentRating` + +| Name | Type | Description | +| - | - | - | +| `_id` | [Id](./Id.md) | The document ID. | +| `_index` | [IndexName](./IndexName.md) | The document’s index. For data streams, this should be the document’s backing index. | +| `rating` | [integer](./integer.md) | The document’s relevance with regard to this search request. | diff --git a/docs/reference/api/RankEvalRankEvalHit.md b/docs/reference/api/RankEvalRankEvalHit.md new file mode 100644 index 000000000..ed22c3686 --- /dev/null +++ b/docs/reference/api/RankEvalRankEvalHit.md @@ -0,0 +1,7 @@ +## Interface `RankEvalRankEvalHit` + +| Name | Type | Description | +| - | - | - | +| `_id` | [Id](./Id.md) |   | +| `_index` | [IndexName](./IndexName.md) |   | +| `_score` | [double](./double.md) |   | diff --git a/docs/reference/api/RankEvalRankEvalHitItem.md b/docs/reference/api/RankEvalRankEvalHitItem.md new file mode 100644 index 000000000..63ce999c2 --- /dev/null +++ b/docs/reference/api/RankEvalRankEvalHitItem.md @@ -0,0 +1,6 @@ +## Interface `RankEvalRankEvalHitItem` + +| Name | Type | Description | +| - | - | - | +| `hit` | [RankEvalRankEvalHit](./RankEvalRankEvalHit.md) |   | +| `rating` | [double](./double.md) | null |   | diff --git a/docs/reference/api/RankEvalRankEvalMetric.md b/docs/reference/api/RankEvalRankEvalMetric.md new file mode 100644 index 000000000..55b210f26 --- /dev/null +++ b/docs/reference/api/RankEvalRankEvalMetric.md @@ -0,0 +1,9 @@ +## Interface `RankEvalRankEvalMetric` + +| Name | Type | Description | +| - | - | - | +| `dcg` | [RankEvalRankEvalMetricDiscountedCumulativeGain](./RankEvalRankEvalMetricDiscountedCumulativeGain.md) |   | +| `expected_reciprocal_rank` | [RankEvalRankEvalMetricExpectedReciprocalRank](./RankEvalRankEvalMetricExpectedReciprocalRank.md) |   | +| `mean_reciprocal_rank` | [RankEvalRankEvalMetricMeanReciprocalRank](./RankEvalRankEvalMetricMeanReciprocalRank.md) |   | +| `precision` | [RankEvalRankEvalMetricPrecision](./RankEvalRankEvalMetricPrecision.md) |   | +| `recall` | [RankEvalRankEvalMetricRecall](./RankEvalRankEvalMetricRecall.md) |   | diff --git a/docs/reference/api/RankEvalRankEvalMetricBase.md b/docs/reference/api/RankEvalRankEvalMetricBase.md new file mode 100644 index 000000000..bea2d7146 --- /dev/null +++ b/docs/reference/api/RankEvalRankEvalMetricBase.md @@ -0,0 +1,5 @@ +## Interface `RankEvalRankEvalMetricBase` + +| Name | Type | Description | +| - | - | - | +| `k` | [integer](./integer.md) | Sets the maximum number of documents retrieved per query. This value will act in place of the usual size parameter in the query. | diff --git a/docs/reference/api/RankEvalRankEvalMetricDetail.md b/docs/reference/api/RankEvalRankEvalMetricDetail.md new file mode 100644 index 000000000..e58e36ea9 --- /dev/null +++ b/docs/reference/api/RankEvalRankEvalMetricDetail.md @@ -0,0 +1,8 @@ +## Interface `RankEvalRankEvalMetricDetail` + +| Name | Type | Description | +| - | - | - | +| `hits` | [RankEvalRankEvalHitItem](./RankEvalRankEvalHitItem.md)[] | The hits section shows a grouping of the search results with their supplied ratings | +| `metric_details` | Record> | The metric_details give additional information about the calculated quality metric (e.g. how many of the retrieved documents were relevant). The content varies for each metric but allows for better interpretation of the results | +| `metric_score` | [double](./double.md) | The metric_score in the details section shows the contribution of this query to the global quality metric score | +| `unrated_docs` | [RankEvalUnratedDocument](./RankEvalUnratedDocument.md)[] | The unrated_docs section contains an _index and _id entry for each document in the search result for this query that didn’t have a ratings value. This can be used to ask the user to supply ratings for these documents | diff --git a/docs/reference/api/RankEvalRankEvalMetricDiscountedCumulativeGain.md b/docs/reference/api/RankEvalRankEvalMetricDiscountedCumulativeGain.md new file mode 100644 index 000000000..74a0d5f4e --- /dev/null +++ b/docs/reference/api/RankEvalRankEvalMetricDiscountedCumulativeGain.md @@ -0,0 +1,5 @@ +## Interface `RankEvalRankEvalMetricDiscountedCumulativeGain` + +| Name | Type | Description | +| - | - | - | +| `normalize` | boolean | If set to true, this metric will calculate the Normalized DCG. | diff --git a/docs/reference/api/RankEvalRankEvalMetricExpectedReciprocalRank.md b/docs/reference/api/RankEvalRankEvalMetricExpectedReciprocalRank.md new file mode 100644 index 000000000..8f5ada34b --- /dev/null +++ b/docs/reference/api/RankEvalRankEvalMetricExpectedReciprocalRank.md @@ -0,0 +1,5 @@ +## Interface `RankEvalRankEvalMetricExpectedReciprocalRank` + +| Name | Type | Description | +| - | - | - | +| `maximum_relevance` | [integer](./integer.md) | The highest relevance grade used in the user-supplied relevance judgments. | diff --git a/docs/reference/api/RankEvalRankEvalMetricMeanReciprocalRank.md b/docs/reference/api/RankEvalRankEvalMetricMeanReciprocalRank.md new file mode 100644 index 000000000..f5cd9fa80 --- /dev/null +++ b/docs/reference/api/RankEvalRankEvalMetricMeanReciprocalRank.md @@ -0,0 +1,4 @@ +## Interface `RankEvalRankEvalMetricMeanReciprocalRank` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/RankEvalRankEvalMetricPrecision.md b/docs/reference/api/RankEvalRankEvalMetricPrecision.md new file mode 100644 index 000000000..8bdb55168 --- /dev/null +++ b/docs/reference/api/RankEvalRankEvalMetricPrecision.md @@ -0,0 +1,5 @@ +## Interface `RankEvalRankEvalMetricPrecision` + +| Name | Type | Description | +| - | - | - | +| `ignore_unlabeled` | boolean | Controls how unlabeled documents in the search results are counted. If set to true, unlabeled documents are ignored and neither count as relevant or irrelevant. Set to false (the default), they are treated as irrelevant. | diff --git a/docs/reference/api/RankEvalRankEvalMetricRatingTreshold.md b/docs/reference/api/RankEvalRankEvalMetricRatingTreshold.md new file mode 100644 index 000000000..babeb5df7 --- /dev/null +++ b/docs/reference/api/RankEvalRankEvalMetricRatingTreshold.md @@ -0,0 +1,5 @@ +## Interface `RankEvalRankEvalMetricRatingTreshold` + +| Name | Type | Description | +| - | - | - | +| `relevant_rating_threshold` | [integer](./integer.md) | Sets the rating threshold above which documents are considered to be "relevant". | diff --git a/docs/reference/api/RankEvalRankEvalMetricRecall.md b/docs/reference/api/RankEvalRankEvalMetricRecall.md new file mode 100644 index 000000000..1603da323 --- /dev/null +++ b/docs/reference/api/RankEvalRankEvalMetricRecall.md @@ -0,0 +1,4 @@ +## Interface `RankEvalRankEvalMetricRecall` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/RankEvalRankEvalQuery.md b/docs/reference/api/RankEvalRankEvalQuery.md new file mode 100644 index 000000000..44d09a250 --- /dev/null +++ b/docs/reference/api/RankEvalRankEvalQuery.md @@ -0,0 +1,6 @@ +## Interface `RankEvalRankEvalQuery` + +| Name | Type | Description | +| - | - | - | +| `query` | [QueryDslQueryContainer](./QueryDslQueryContainer.md) |   | +| `size` | [integer](./integer.md) |   | diff --git a/docs/reference/api/RankEvalRankEvalRequestItem.md b/docs/reference/api/RankEvalRankEvalRequestItem.md new file mode 100644 index 000000000..a33a3e72e --- /dev/null +++ b/docs/reference/api/RankEvalRankEvalRequestItem.md @@ -0,0 +1,9 @@ +## Interface `RankEvalRankEvalRequestItem` + +| Name | Type | Description | +| - | - | - | +| `id` | [Id](./Id.md) | The search request’s ID, used to group result details later. | +| `params` | Record | The search template parameters. | +| `ratings` | [RankEvalDocumentRating](./RankEvalDocumentRating.md)[] | List of document ratings | +| `request` | [RankEvalRankEvalQuery](./RankEvalRankEvalQuery.md) | [QueryDslQueryContainer](./QueryDslQueryContainer.md) | The query being evaluated. | +| `template_id` | [Id](./Id.md) | The search template Id | diff --git a/docs/reference/api/RankEvalRequest.md b/docs/reference/api/RankEvalRequest.md new file mode 100644 index 000000000..e96e3de47 --- /dev/null +++ b/docs/reference/api/RankEvalRequest.md @@ -0,0 +1,13 @@ +## Interface `RankEvalRequest` + +| Name | Type | Description | +| - | - | - | +| `allow_no_indices` | boolean | If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. | +| `body` | string | ({ [key: string]: any; } & { index?: never; allow_no_indices?: never; expand_wildcards?: never; ignore_unavailable?: never; search_type?: never; requests?: never; metric?: never; }) | All values in `body` will be added to the request body. | +| `expand_wildcards` | [ExpandWildcards](./ExpandWildcards.md) | Whether to expand wildcard expression to concrete indices that are open, closed or both. | +| `ignore_unavailable` | boolean | If `true`, missing or closed indices are not included in the response. | +| `index` | [Indices](./Indices.md) | A comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard ( `*`) expressions are supported. To target all data streams and indices in a cluster, omit this parameter or use `_all` or `*`. | +| `metric` | [RankEvalRankEvalMetric](./RankEvalRankEvalMetric.md) | Definition of the evaluation metric to calculate. | +| `querystring` | { [key: string]: any; } & { index?: never; allow_no_indices?: never; expand_wildcards?: never; ignore_unavailable?: never; search_type?: never; requests?: never; metric?: never; } | All values in `querystring` will be added to the request querystring. | +| `requests` | [RankEvalRankEvalRequestItem](./RankEvalRankEvalRequestItem.md)[] | A set of typical search requests, together with their provided ratings. | +| `search_type` | string | Search operation type | diff --git a/docs/reference/api/RankEvalResponse.md b/docs/reference/api/RankEvalResponse.md new file mode 100644 index 000000000..39c17a14b --- /dev/null +++ b/docs/reference/api/RankEvalResponse.md @@ -0,0 +1,7 @@ +## Interface `RankEvalResponse` + +| Name | Type | Description | +| - | - | - | +| `details` | Record<[Id](./Id.md), [RankEvalRankEvalMetricDetail](./RankEvalRankEvalMetricDetail.md)> | The details section contains one entry for every query in the original requests section, keyed by the search request id | +| `failures` | Record |   | +| `metric_score` | [double](./double.md) | The overall evaluation quality calculated by the defined metric | diff --git a/docs/reference/api/RankEvalUnratedDocument.md b/docs/reference/api/RankEvalUnratedDocument.md new file mode 100644 index 000000000..ce1136d7c --- /dev/null +++ b/docs/reference/api/RankEvalUnratedDocument.md @@ -0,0 +1,6 @@ +## Interface `RankEvalUnratedDocument` + +| Name | Type | Description | +| - | - | - | +| `_id` | [Id](./Id.md) |   | +| `_index` | [IndexName](./IndexName.md) |   | diff --git a/docs/reference/api/RecoveryStats.md b/docs/reference/api/RecoveryStats.md new file mode 100644 index 000000000..4ab8617b1 --- /dev/null +++ b/docs/reference/api/RecoveryStats.md @@ -0,0 +1,8 @@ +## Interface `RecoveryStats` + +| Name | Type | Description | +| - | - | - | +| `current_as_source` | [long](./long.md) |   | +| `current_as_target` | [long](./long.md) |   | +| `throttle_time_in_millis` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> |   | +| `throttle_time` | [Duration](./Duration.md) |   | diff --git a/docs/reference/api/Refresh.md b/docs/reference/api/Refresh.md new file mode 100644 index 000000000..911d454e6 --- /dev/null +++ b/docs/reference/api/Refresh.md @@ -0,0 +1,4 @@ +## `Refresh` +::: +type Refresh = boolean | 'true' | 'false' | 'wait_for'; +::: diff --git a/docs/reference/api/RefreshStats.md b/docs/reference/api/RefreshStats.md new file mode 100644 index 000000000..c74cdea29 --- /dev/null +++ b/docs/reference/api/RefreshStats.md @@ -0,0 +1,10 @@ +## Interface `RefreshStats` + +| Name | Type | Description | +| - | - | - | +| `external_total_time_in_millis` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> |   | +| `external_total` | [long](./long.md) |   | +| `listeners` | [long](./long.md) |   | +| `total_time_in_millis` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> |   | +| `total_time` | [Duration](./Duration.md) |   | +| `total` | [long](./long.md) |   | diff --git a/docs/reference/api/ReindexApi_1.md b/docs/reference/api/ReindexApi_1.md new file mode 100644 index 000000000..34d978b2b --- /dev/null +++ b/docs/reference/api/ReindexApi_1.md @@ -0,0 +1,3 @@ +::: +default function ReindexApi(this: [That](./That.md), params: [ReindexRequest](./ReindexRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ReindexResponse](./ReindexResponse.md)>; +::: diff --git a/docs/reference/api/ReindexApi_2.md b/docs/reference/api/ReindexApi_2.md new file mode 100644 index 000000000..38757fd58 --- /dev/null +++ b/docs/reference/api/ReindexApi_2.md @@ -0,0 +1,3 @@ +::: +default function ReindexApi(this: [That](./That.md), params: [ReindexRequest](./ReindexRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ReindexResponse](./ReindexResponse.md), unknown>>; +::: diff --git a/docs/reference/api/ReindexApi_3.md b/docs/reference/api/ReindexApi_3.md new file mode 100644 index 000000000..df977454e --- /dev/null +++ b/docs/reference/api/ReindexApi_3.md @@ -0,0 +1,3 @@ +::: +default function ReindexApi(this: [That](./That.md), params: [ReindexRequest](./ReindexRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ReindexResponse](./ReindexResponse.md)>; +::: diff --git a/docs/reference/api/ReindexDestination.md b/docs/reference/api/ReindexDestination.md new file mode 100644 index 000000000..3b27d06a8 --- /dev/null +++ b/docs/reference/api/ReindexDestination.md @@ -0,0 +1,9 @@ +## Interface `ReindexDestination` + +| Name | Type | Description | +| - | - | - | +| `index` | [IndexName](./IndexName.md) | The name of the data stream, index, or index alias you are copying to. | +| `op_type` | [OpType](./OpType.md) | If it is `create`, the operation will only index documents that do not already exist (also known as "put if absent"). IMPORTANT: To reindex to a data stream destination, this argument must be `create`. | +| `pipeline` | string | The name of the pipeline to use. | +| `routing` | [Routing](./Routing.md) | By default, a document's routing is preserved unless it's changed by the script. If it is `keep`, the routing on the bulk request sent for each match is set to the routing on the match. If it is `discard`, the routing on the bulk request sent for each match is set to `null`. If it is `=value`, the routing on the bulk request sent for each match is set to all value specified after the equals sign ( `=`). | +| `version_type` | [VersionType](./VersionType.md) | The versioning to use for the indexing operation. | diff --git a/docs/reference/api/ReindexRemoteSource.md b/docs/reference/api/ReindexRemoteSource.md new file mode 100644 index 000000000..76938fc8b --- /dev/null +++ b/docs/reference/api/ReindexRemoteSource.md @@ -0,0 +1,10 @@ +## Interface `ReindexRemoteSource` + +| Name | Type | Description | +| - | - | - | +| `connect_timeout` | [Duration](./Duration.md) | The remote connection timeout. | +| `headers` | Record | An object containing the headers of the request. | +| `host` | [Host](./Host.md) | The URL for the remote instance of Elasticsearch that you want to index from. This information is required when you're indexing from remote. | +| `password` | [Password](./Password.md) | The password to use for authentication with the remote host. | +| `socket_timeout` | [Duration](./Duration.md) | The remote socket read timeout. | +| `username` | [Username](./Username.md) | The username to use for authentication with the remote host. | diff --git a/docs/reference/api/ReindexRequest.md b/docs/reference/api/ReindexRequest.md new file mode 100644 index 000000000..72e8bdb23 --- /dev/null +++ b/docs/reference/api/ReindexRequest.md @@ -0,0 +1,20 @@ +## Interface `ReindexRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { refresh?: never; requests_per_second?: never; scroll?: never; slices?: never; timeout?: never; wait_for_active_shards?: never; wait_for_completion?: never; require_alias?: never; conflicts?: never; dest?: never; max_docs?: never; script?: never; size?: never; source?: never; }) | All values in `body` will be added to the request body. | +| `conflicts` | [Conflicts](./Conflicts.md) | Indicates whether to continue reindexing even when there are conflicts. | +| `dest` | [ReindexDestination](./ReindexDestination.md) | The destination you are copying to. | +| `max_docs` | [long](./long.md) | The maximum number of documents to reindex. By default, all documents are reindexed. If it is a value less then or equal to `scroll_size`, a scroll will not be used to retrieve the results for the operation. If `conflicts` is set to `proceed`, the reindex operation could attempt to reindex more documents from the source than `max_docs` until it has successfully indexed `max_docs` documents into the target or it has gone through every document in the source query. | +| `querystring` | { [key: string]: any; } & { refresh?: never; requests_per_second?: never; scroll?: never; slices?: never; timeout?: never; wait_for_active_shards?: never; wait_for_completion?: never; require_alias?: never; conflicts?: never; dest?: never; max_docs?: never; script?: never; size?: never; source?: never; } | All values in `querystring` will be added to the request querystring. | +| `refresh` | boolean | If `true`, the request refreshes affected shards to make this operation visible to search. | +| `requests_per_second` | [float](./float.md) | The throttle for this request in sub-requests per second. By default, there is no throttle. | +| `require_alias` | boolean | If `true`, the destination must be an index alias. | +| `script` | [Script](./Script.md) | [ScriptSource](./ScriptSource.md) | The script to run to update the document source or metadata when reindexing. | +| `scroll` | [Duration](./Duration.md) | The period of time that a consistent view of the index should be maintained for scrolled search. | +| `size` | [long](./long.md) |   | +| `slices` | [Slices](./Slices.md) | The number of slices this task should be divided into. It defaults to one slice, which means the task isn't sliced into subtasks. Reindex supports sliced scroll to parallelize the reindexing process. This parallelization can improve efficiency and provide a convenient way to break the request down into smaller parts. NOTE: Reindexing from remote clusters does not support manual or automatic slicing. If set to `auto`, Elasticsearch chooses the number of slices to use. This setting will use one slice per shard, up to a certain limit. If there are multiple sources, it will choose the number of slices based on the index or backing index with the smallest number of shards. | +| `source` | [ReindexSource](./ReindexSource.md) | The source you are copying from. | +| `timeout` | [Duration](./Duration.md) | The period each indexing waits for automatic index creation, dynamic mapping updates, and waiting for active shards. By default, Elasticsearch waits for at least one minute before failing. The actual wait time could be longer, particularly when multiple waits occur. | +| `wait_for_active_shards` | [WaitForActiveShards](./WaitForActiveShards.md) | The number of shard copies that must be active before proceeding with the operation. Set it to `all` or any positive integer up to the total number of shards in the index ( `number_of_replicas+1`). The default value is one, which means it waits for each primary shard to be active. | +| `wait_for_completion` | boolean | If `true`, the request blocks until the operation is complete. | diff --git a/docs/reference/api/ReindexResponse.md b/docs/reference/api/ReindexResponse.md new file mode 100644 index 000000000..9da2f6846 --- /dev/null +++ b/docs/reference/api/ReindexResponse.md @@ -0,0 +1,20 @@ +## Interface `ReindexResponse` + +| Name | Type | Description | +| - | - | - | +| `batches` | [long](./long.md) | The number of scroll responses that were pulled back by the reindex. | +| `created` | [long](./long.md) | The number of documents that were successfully created. | +| `deleted` | [long](./long.md) | The number of documents that were successfully deleted. | +| `failures` | [BulkIndexByScrollFailure](./BulkIndexByScrollFailure.md)[] | If there were any unrecoverable errors during the process, it is an array of those failures. If this array is not empty, the request ended because of those failures. Reindex is implemented using batches and any failure causes the entire process to end but all failures in the current batch are collected into the array. You can use the `conflicts` option to prevent the reindex from ending on version conflicts. | +| `noops` | [long](./long.md) | The number of documents that were ignored because the script used for the reindex returned a `noop` value for `ctx.op`. | +| `requests_per_second` | [float](./float.md) | The number of requests per second effectively run during the reindex. | +| `retries` | [Retries](./Retries.md) | The number of retries attempted by reindex. | +| `slice_id` | [integer](./integer.md) |   | +| `task` | [TaskId](./TaskId.md) |   | +| `throttled_millis` | [EpochTime](./EpochTime.md)<[UnitMillis](./UnitMillis.md)> | The number of milliseconds the request slept to conform to `requests_per_second`. | +| `throttled_until_millis` | [EpochTime](./EpochTime.md)<[UnitMillis](./UnitMillis.md)> | This field should always be equal to zero in a reindex response. It has meaning only when using the task API, where it indicates the next time (in milliseconds since epoch) that a throttled request will be run again in order to conform to `requests_per_second`. | +| `timed_out` | boolean | If any of the requests that ran during the reindex timed out, it is `true`. | +| `took` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> | The total milliseconds the entire operation took. | +| `total` | [long](./long.md) | The number of documents that were successfully processed. | +| `updated` | [long](./long.md) | The number of documents that were successfully updated. That is to say, a document with the same ID already existed before the reindex updated it. | +| `version_conflicts` | [long](./long.md) | The number of version conflicts that occurred. | diff --git a/docs/reference/api/ReindexRethrottleApi_1.md b/docs/reference/api/ReindexRethrottleApi_1.md new file mode 100644 index 000000000..b9a0750a1 --- /dev/null +++ b/docs/reference/api/ReindexRethrottleApi_1.md @@ -0,0 +1,3 @@ +::: +default function ReindexRethrottleApi(this: [That](./That.md), params: [ReindexRethrottleRequest](./ReindexRethrottleRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ReindexRethrottleResponse](./ReindexRethrottleResponse.md)>; +::: diff --git a/docs/reference/api/ReindexRethrottleApi_2.md b/docs/reference/api/ReindexRethrottleApi_2.md new file mode 100644 index 000000000..8a7f25581 --- /dev/null +++ b/docs/reference/api/ReindexRethrottleApi_2.md @@ -0,0 +1,3 @@ +::: +default function ReindexRethrottleApi(this: [That](./That.md), params: [ReindexRethrottleRequest](./ReindexRethrottleRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ReindexRethrottleResponse](./ReindexRethrottleResponse.md), unknown>>; +::: diff --git a/docs/reference/api/ReindexRethrottleApi_3.md b/docs/reference/api/ReindexRethrottleApi_3.md new file mode 100644 index 000000000..f8bfaf775 --- /dev/null +++ b/docs/reference/api/ReindexRethrottleApi_3.md @@ -0,0 +1,3 @@ +::: +default function ReindexRethrottleApi(this: [That](./That.md), params: [ReindexRethrottleRequest](./ReindexRethrottleRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ReindexRethrottleResponse](./ReindexRethrottleResponse.md)>; +::: diff --git a/docs/reference/api/ReindexRethrottleReindexNode.md b/docs/reference/api/ReindexRethrottleReindexNode.md new file mode 100644 index 000000000..6d50d426c --- /dev/null +++ b/docs/reference/api/ReindexRethrottleReindexNode.md @@ -0,0 +1,5 @@ +## Interface `ReindexRethrottleReindexNode` + +| Name | Type | Description | +| - | - | - | +| `tasks` | Record<[TaskId](./TaskId.md), [ReindexRethrottleReindexTask](./ReindexRethrottleReindexTask.md)> |   | diff --git a/docs/reference/api/ReindexRethrottleReindexStatus.md b/docs/reference/api/ReindexRethrottleReindexStatus.md new file mode 100644 index 000000000..9b833afd4 --- /dev/null +++ b/docs/reference/api/ReindexRethrottleReindexStatus.md @@ -0,0 +1,17 @@ +## Interface `ReindexRethrottleReindexStatus` + +| Name | Type | Description | +| - | - | - | +| `batches` | [long](./long.md) | The number of scroll responses pulled back by the reindex. | +| `created` | [long](./long.md) | The number of documents that were successfully created. | +| `deleted` | [long](./long.md) | The number of documents that were successfully deleted. | +| `noops` | [long](./long.md) | The number of documents that were ignored because the script used for the reindex returned a `noop` value for `ctx.op`. | +| `requests_per_second` | [float](./float.md) | The number of requests per second effectively executed during the reindex. | +| `retries` | [Retries](./Retries.md) | The number of retries attempted by reindex. `bulk` is the number of bulk actions retried and `search` is the number of search actions retried. | +| `throttled_millis` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> | Number of milliseconds the request slept to conform to `requests_per_second`. | +| `throttled_until_millis` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> | This field should always be equal to zero in a `_reindex` response. It only has meaning when using the Task API, where it indicates the next time (in milliseconds since epoch) a throttled request will be executed again in order to conform to `requests_per_second`. | +| `throttled_until` | [Duration](./Duration.md) |   | +| `throttled` | [Duration](./Duration.md) |   | +| `total` | [long](./long.md) | The number of documents that were successfully processed. | +| `updated` | [long](./long.md) | The number of documents that were successfully updated, for example, a document with same ID already existed prior to reindex updating it. | +| `version_conflicts` | [long](./long.md) | The number of version conflicts that reindex hits. | diff --git a/docs/reference/api/ReindexRethrottleReindexTask.md b/docs/reference/api/ReindexRethrottleReindexTask.md new file mode 100644 index 000000000..53c6aa273 --- /dev/null +++ b/docs/reference/api/ReindexRethrottleReindexTask.md @@ -0,0 +1,14 @@ +## Interface `ReindexRethrottleReindexTask` + +| Name | Type | Description | +| - | - | - | +| `action` | string |   | +| `cancellable` | boolean |   | +| `description` | string |   | +| `headers` | [HttpHeaders](./HttpHeaders.md) |   | +| `id` | [long](./long.md) |   | +| `node` | [Name](./Name.md) |   | +| `running_time_in_nanos` | [DurationValue](./DurationValue.md)<[UnitNanos](./UnitNanos.md)> |   | +| `start_time_in_millis` | [EpochTime](./EpochTime.md)<[UnitMillis](./UnitMillis.md)> |   | +| `status` | [ReindexRethrottleReindexStatus](./ReindexRethrottleReindexStatus.md) |   | +| `type` | string |   | diff --git a/docs/reference/api/ReindexRethrottleRequest.md b/docs/reference/api/ReindexRethrottleRequest.md new file mode 100644 index 000000000..177d976ac --- /dev/null +++ b/docs/reference/api/ReindexRethrottleRequest.md @@ -0,0 +1,8 @@ +## Interface `ReindexRethrottleRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { task_id?: never; requests_per_second?: never; }) | All values in `body` will be added to the request body. | +| `querystring` | { [key: string]: any; } & { task_id?: never; requests_per_second?: never; } | All values in `querystring` will be added to the request querystring. | +| `requests_per_second` | [float](./float.md) | The throttle for this request in sub-requests per second. It can be either `-1` to turn off throttling or any decimal number like `1.7` or `12` to throttle to that level. | +| `task_id` | [Id](./Id.md) | The task identifier, which can be found by using the tasks API. | diff --git a/docs/reference/api/ReindexRethrottleResponse.md b/docs/reference/api/ReindexRethrottleResponse.md new file mode 100644 index 000000000..6df0ab4c5 --- /dev/null +++ b/docs/reference/api/ReindexRethrottleResponse.md @@ -0,0 +1,5 @@ +## Interface `ReindexRethrottleResponse` + +| Name | Type | Description | +| - | - | - | +| `nodes` | Record |   | diff --git a/docs/reference/api/ReindexSource.md b/docs/reference/api/ReindexSource.md new file mode 100644 index 000000000..6ae864190 --- /dev/null +++ b/docs/reference/api/ReindexSource.md @@ -0,0 +1,12 @@ +## Interface `ReindexSource` + +| Name | Type | Description | +| - | - | - | +| `_source` | [Fields](./Fields.md) | If `true`, reindex all source fields. Set it to a list to reindex select fields. | +| `index` | [Indices](./Indices.md) | The name of the data stream, index, or alias you are copying from. It accepts a comma-separated list to reindex from multiple sources. | +| `query` | [QueryDslQueryContainer](./QueryDslQueryContainer.md) | The documents to reindex, which is defined with Query DSL. | +| `remote` | [ReindexRemoteSource](./ReindexRemoteSource.md) | A remote instance of Elasticsearch that you want to index from. | +| `runtime_mappings` | [MappingRuntimeFields](./MappingRuntimeFields.md) |   | +| `size` | [integer](./integer.md) | The number of documents to index per batch. Use it when you are indexing from remote to ensure that the batches fit within the on-heap buffer, which defaults to a maximum size of 100 MB. | +| `slice` | [SlicedScroll](./SlicedScroll.md) | Slice the reindex request manually using the provided slice ID and total number of slices. | +| `sort` | [Sort](./Sort.md) | A comma-separated list of `:` pairs to sort by before indexing. Use it in conjunction with `max_docs` to control what documents are reindexed. WARNING: Sort in reindex is deprecated. Sorting in reindex was never guaranteed to index documents in order and prevents further development of reindex such as resilience and performance improvements. If used in combination with `max_docs`, consider using a query filter instead. | diff --git a/docs/reference/api/RelationName.md b/docs/reference/api/RelationName.md new file mode 100644 index 000000000..c04c77153 --- /dev/null +++ b/docs/reference/api/RelationName.md @@ -0,0 +1,4 @@ +## `RelationName` +::: +type RelationName = string; +::: diff --git a/docs/reference/api/RelocationFailureInfo.md b/docs/reference/api/RelocationFailureInfo.md new file mode 100644 index 000000000..150e29133 --- /dev/null +++ b/docs/reference/api/RelocationFailureInfo.md @@ -0,0 +1,5 @@ +## Interface `RelocationFailureInfo` + +| Name | Type | Description | +| - | - | - | +| `failed_attempts` | [integer](./integer.md) |   | diff --git a/docs/reference/api/RenderSearchTemplateApi_1.md b/docs/reference/api/RenderSearchTemplateApi_1.md new file mode 100644 index 000000000..46620b99e --- /dev/null +++ b/docs/reference/api/RenderSearchTemplateApi_1.md @@ -0,0 +1,3 @@ +::: +default function RenderSearchTemplateApi(this: [That](./That.md), params?: [RenderSearchTemplateRequest](./RenderSearchTemplateRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[RenderSearchTemplateResponse](./RenderSearchTemplateResponse.md)>; +::: diff --git a/docs/reference/api/RenderSearchTemplateApi_2.md b/docs/reference/api/RenderSearchTemplateApi_2.md new file mode 100644 index 000000000..80dfa495b --- /dev/null +++ b/docs/reference/api/RenderSearchTemplateApi_2.md @@ -0,0 +1,3 @@ +::: +default function RenderSearchTemplateApi(this: [That](./That.md), params?: [RenderSearchTemplateRequest](./RenderSearchTemplateRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[RenderSearchTemplateResponse](./RenderSearchTemplateResponse.md), unknown>>; +::: diff --git a/docs/reference/api/RenderSearchTemplateApi_3.md b/docs/reference/api/RenderSearchTemplateApi_3.md new file mode 100644 index 000000000..37c59138f --- /dev/null +++ b/docs/reference/api/RenderSearchTemplateApi_3.md @@ -0,0 +1,3 @@ +::: +default function RenderSearchTemplateApi(this: [That](./That.md), params?: [RenderSearchTemplateRequest](./RenderSearchTemplateRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[RenderSearchTemplateResponse](./RenderSearchTemplateResponse.md)>; +::: diff --git a/docs/reference/api/RenderSearchTemplateRequest.md b/docs/reference/api/RenderSearchTemplateRequest.md new file mode 100644 index 000000000..89bed0044 --- /dev/null +++ b/docs/reference/api/RenderSearchTemplateRequest.md @@ -0,0 +1,10 @@ +## Interface `RenderSearchTemplateRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { id?: never; file?: never; params?: never; source?: never; }) | All values in `body` will be added to the request body. | +| `file` | string |   | +| `id` | [Id](./Id.md) | The ID of the search template to render. If no `source` is specified, this or the `id` request body parameter is required. | +| `params` | Record | Key-value pairs used to replace Mustache variables in the template. The key is the variable name. The value is the variable value. | +| `querystring` | { [key: string]: any; } & { id?: never; file?: never; params?: never; source?: never; } | All values in `querystring` will be added to the request querystring. | +| `source` | [ScriptSource](./ScriptSource.md) | An inline search template. It supports the same parameters as the search API's request body. These parameters also support Mustache variables. If no `id` or `` is specified, this parameter is required. | diff --git a/docs/reference/api/RenderSearchTemplateResponse.md b/docs/reference/api/RenderSearchTemplateResponse.md new file mode 100644 index 000000000..219884ab8 --- /dev/null +++ b/docs/reference/api/RenderSearchTemplateResponse.md @@ -0,0 +1,5 @@ +## Interface `RenderSearchTemplateResponse` + +| Name | Type | Description | +| - | - | - | +| `template_output` | Record |   | diff --git a/docs/reference/api/RequestBase.md b/docs/reference/api/RequestBase.md new file mode 100644 index 000000000..6c0299267 --- /dev/null +++ b/docs/reference/api/RequestBase.md @@ -0,0 +1,4 @@ +## Interface `RequestBase` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/RequestCacheStats.md b/docs/reference/api/RequestCacheStats.md new file mode 100644 index 000000000..6753290e1 --- /dev/null +++ b/docs/reference/api/RequestCacheStats.md @@ -0,0 +1,9 @@ +## Interface `RequestCacheStats` + +| Name | Type | Description | +| - | - | - | +| `evictions` | [long](./long.md) |   | +| `hit_count` | [long](./long.md) |   | +| `memory_size_in_bytes` | [long](./long.md) |   | +| `memory_size` | string |   | +| `miss_count` | [long](./long.md) |   | diff --git a/docs/reference/api/RescoreVector.md b/docs/reference/api/RescoreVector.md new file mode 100644 index 000000000..be1672257 --- /dev/null +++ b/docs/reference/api/RescoreVector.md @@ -0,0 +1,5 @@ +## Interface `RescoreVector` + +| Name | Type | Description | +| - | - | - | +| `oversample` | [float](./float.md) | Applies the specified oversample factor to k on the approximate kNN search | diff --git a/docs/reference/api/Result.md b/docs/reference/api/Result.md new file mode 100644 index 000000000..7ff4fadb5 --- /dev/null +++ b/docs/reference/api/Result.md @@ -0,0 +1,4 @@ +## `Result` +::: +type Result = 'created' | 'updated' | 'deleted' | 'not_found' | 'noop'; +::: diff --git a/docs/reference/api/Retries.md b/docs/reference/api/Retries.md new file mode 100644 index 000000000..8f1ee791b --- /dev/null +++ b/docs/reference/api/Retries.md @@ -0,0 +1,6 @@ +## Interface `Retries` + +| Name | Type | Description | +| - | - | - | +| `bulk` | [long](./long.md) | The number of bulk actions retried. | +| `search` | [long](./long.md) | The number of search actions retried. | diff --git a/docs/reference/api/RetrieverBase.md b/docs/reference/api/RetrieverBase.md new file mode 100644 index 000000000..4df96dfd6 --- /dev/null +++ b/docs/reference/api/RetrieverBase.md @@ -0,0 +1,6 @@ +## Interface `RetrieverBase` + +| Name | Type | Description | +| - | - | - | +| `filter` | [QueryDslQueryContainer](./QueryDslQueryContainer.md) | [QueryDslQueryContainer](./QueryDslQueryContainer.md)[] | Query to filter the documents that can match. | +| `min_score` | [float](./float.md) | Minimum _score for matching documents. Documents with a lower _score are not included in the top documents. | diff --git a/docs/reference/api/RetrieverContainer.md b/docs/reference/api/RetrieverContainer.md new file mode 100644 index 000000000..a28685cb4 --- /dev/null +++ b/docs/reference/api/RetrieverContainer.md @@ -0,0 +1,9 @@ +## Interface `RetrieverContainer` + +| Name | Type | Description | +| - | - | - | +| `knn` | [KnnRetriever](./KnnRetriever.md) | A retriever that replaces the functionality of a knn search. | +| `rrf` | [RRFRetriever](./RRFRetriever.md) | A retriever that produces top documents from reciprocal rank fusion (RRF). | +| `rule` | [RuleRetriever](./RuleRetriever.md) | A retriever that replaces the functionality of a rule query. | +| `standard` | [StandardRetriever](./StandardRetriever.md) | A retriever that replaces the functionality of a traditional query. | +| `text_similarity_reranker` | [TextSimilarityReranker](./TextSimilarityReranker.md) | A retriever that reranks the top documents based on a reranking model using the InferenceAPI | diff --git a/docs/reference/api/Rollup.md b/docs/reference/api/Rollup.md new file mode 100644 index 000000000..8768f048e --- /dev/null +++ b/docs/reference/api/Rollup.md @@ -0,0 +1,20 @@ +## `Rollup` + +### Constructor + +::: +new Rollup(transport: [Transport](./Transport.md)); +::: + +### Properties + +| Name | Type | Description | +| - | - | - | +| `acceptedParams` | Record |   | +| `transport` | [Transport](./Transport.md) |   | + +### Methods + +| Name | Signature | Description | +| - | - | - | +| `deleteJob` | `deleteJob(this: [That](./That.md), params: [RollupDeleteJobRequest](./RollupDeleteJobRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[RollupDeleteJobResponse](./RollupDeleteJobResponse.md)>;` | Delete a rollup job. A job must be stopped before it can be deleted. If you attempt to delete a started job, an error occurs. Similarly, if you attempt to delete a nonexistent job, an exception occurs. IMPORTANT: When you delete a job, you remove only the process that is actively monitoring and rolling up data. The API does not delete any previously rolled up data. This is by design; a user may wish to roll up a static data set. Because the data set is static, after it has been fully rolled up there is no need to keep the indexing rollup job around (as there will be no new data). Thus the job can be deleted, leaving behind the rolled up data for analysis. If you wish to also remove the rollup data and the rollup index contains the data for only a single job, you can delete the whole rollup index. If the rollup index stores data from several jobs, you must issue a delete-by-query that targets the rollup job's identifier in the rollup index. For example: ``` POST my_rollup_index/_delete_by_query { "query": { "term": { "_rollup.id": "the_rollup_job_id" } } } ``` || `deleteJob` | `deleteJob(this: [That](./That.md), params: [RollupDeleteJobRequest](./RollupDeleteJobRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[RollupDeleteJobResponse](./RollupDeleteJobResponse.md), unknown>>;` |   || `deleteJob` | `deleteJob(this: [That](./That.md), params: [RollupDeleteJobRequest](./RollupDeleteJobRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[RollupDeleteJobResponse](./RollupDeleteJobResponse.md)>;` |   || `getJobs` | `getJobs(this: [That](./That.md), params?: [RollupGetJobsRequest](./RollupGetJobsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[RollupGetJobsResponse](./RollupGetJobsResponse.md)>;` | Get rollup job information. Get the configuration, stats, and status of rollup jobs. NOTE: This API returns only active (both `STARTED` and `STOPPED`) jobs. If a job was created, ran for a while, then was deleted, the API does not return any details about it. For details about a historical rollup job, the rollup capabilities API may be more useful. || `getJobs` | `getJobs(this: [That](./That.md), params?: [RollupGetJobsRequest](./RollupGetJobsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[RollupGetJobsResponse](./RollupGetJobsResponse.md), unknown>>;` |   || `getJobs` | `getJobs(this: [That](./That.md), params?: [RollupGetJobsRequest](./RollupGetJobsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[RollupGetJobsResponse](./RollupGetJobsResponse.md)>;` |   || `getRollupCaps` | `getRollupCaps(this: [That](./That.md), params?: [RollupGetRollupCapsRequest](./RollupGetRollupCapsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[RollupGetRollupCapsResponse](./RollupGetRollupCapsResponse.md)>;` | Get the rollup job capabilities. Get the capabilities of any rollup jobs that have been configured for a specific index or index pattern. This API is useful because a rollup job is often configured to rollup only a subset of fields from the source index. Furthermore, only certain aggregations can be configured for various fields, leading to a limited subset of functionality depending on that configuration. This API enables you to inspect an index and determine: 1. Does this index have associated rollup data somewhere in the cluster? 2. If yes to the first question, what fields were rolled up, what aggregations can be performed, and where does the data live? || `getRollupCaps` | `getRollupCaps(this: [That](./That.md), params?: [RollupGetRollupCapsRequest](./RollupGetRollupCapsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[RollupGetRollupCapsResponse](./RollupGetRollupCapsResponse.md), unknown>>;` |   || `getRollupCaps` | `getRollupCaps(this: [That](./That.md), params?: [RollupGetRollupCapsRequest](./RollupGetRollupCapsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[RollupGetRollupCapsResponse](./RollupGetRollupCapsResponse.md)>;` |   || `getRollupIndexCaps` | `getRollupIndexCaps(this: [That](./That.md), params: [RollupGetRollupIndexCapsRequest](./RollupGetRollupIndexCapsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[RollupGetRollupIndexCapsResponse](./RollupGetRollupIndexCapsResponse.md)>;` | Get the rollup index capabilities. Get the rollup capabilities of all jobs inside of a rollup index. A single rollup index may store the data for multiple rollup jobs and may have a variety of capabilities depending on those jobs. This API enables you to determine: * What jobs are stored in an index (or indices specified via a pattern)? * What target indices were rolled up, what fields were used in those rollups, and what aggregations can be performed on each job? || `getRollupIndexCaps` | `getRollupIndexCaps(this: [That](./That.md), params: [RollupGetRollupIndexCapsRequest](./RollupGetRollupIndexCapsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[RollupGetRollupIndexCapsResponse](./RollupGetRollupIndexCapsResponse.md), unknown>>;` |   || `getRollupIndexCaps` | `getRollupIndexCaps(this: [That](./That.md), params: [RollupGetRollupIndexCapsRequest](./RollupGetRollupIndexCapsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[RollupGetRollupIndexCapsResponse](./RollupGetRollupIndexCapsResponse.md)>;` |   || `putJob` | `putJob(this: [That](./That.md), params: [RollupPutJobRequest](./RollupPutJobRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[RollupPutJobResponse](./RollupPutJobResponse.md)>;` | Create a rollup job. WARNING: From 8.15.0, calling this API in a cluster with no rollup usage will fail with a message about the deprecation and planned removal of rollup features. A cluster needs to contain either a rollup job or a rollup index in order for this API to be allowed to run. The rollup job configuration contains all the details about how the job should run, when it indexes documents, and what future queries will be able to run against the rollup index. There are three main sections to the job configuration: the logistical details about the job (for example, the cron schedule), the fields that are used for grouping, and what metrics to collect for each group. Jobs are created in a `STOPPED` state. You can start them with the start rollup jobs API. || `putJob` | `putJob(this: [That](./That.md), params: [RollupPutJobRequest](./RollupPutJobRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[RollupPutJobResponse](./RollupPutJobResponse.md), unknown>>;` |   || `putJob` | `putJob(this: [That](./That.md), params: [RollupPutJobRequest](./RollupPutJobRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[RollupPutJobResponse](./RollupPutJobResponse.md)>;` |   || `rollupSearch` | `rollupSearch>(this: [That](./That.md), params: [RollupRollupSearchRequest](./RollupRollupSearchRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[RollupRollupSearchResponse](./RollupRollupSearchResponse.md)>;` | Search rolled-up data. The rollup search endpoint is needed because, internally, rolled-up documents utilize a different document structure than the original data. It rewrites standard Query DSL into a format that matches the rollup documents then takes the response and rewrites it back to what a client would expect given the original query. The request body supports a subset of features from the regular search API. The following functionality is not available: `size`: Because rollups work on pre-aggregated data, no search hits can be returned and so size must be set to zero or omitted entirely. `highlighter`, `suggestors`, `post_filter`, `profile`, `explain`: These are similarly disallowed. **Searching both historical rollup and non-rollup data** The rollup search API has the capability to search across both "live" non-rollup data and the aggregated rollup data. This is done by simply adding the live indices to the URI. For example: ``` GET sensor-1,sensor_rollup/_rollup_search { "size": 0, "aggregations": { "max_temperature": { "max": { "field": "temperature" } } } } ``` The rollup search endpoint does two things when the search runs: * The original request is sent to the non-rollup index unaltered. * A rewritten version of the original request is sent to the rollup index. When the two responses are received, the endpoint rewrites the rollup response and merges the two together. During the merging process, if there is any overlap in buckets between the two responses, the buckets from the non-rollup index are used. || `rollupSearch` | `rollupSearch>(this: [That](./That.md), params: [RollupRollupSearchRequest](./RollupRollupSearchRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[RollupRollupSearchResponse](./RollupRollupSearchResponse.md), unknown>>;` |   || `rollupSearch` | `rollupSearch>(this: [That](./That.md), params: [RollupRollupSearchRequest](./RollupRollupSearchRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[RollupRollupSearchResponse](./RollupRollupSearchResponse.md)>;` |   || `startJob` | `startJob(this: [That](./That.md), params: [RollupStartJobRequest](./RollupStartJobRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[RollupStartJobResponse](./RollupStartJobResponse.md)>;` | Start rollup jobs. If you try to start a job that does not exist, an exception occurs. If you try to start a job that is already started, nothing happens. || `startJob` | `startJob(this: [That](./That.md), params: [RollupStartJobRequest](./RollupStartJobRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[RollupStartJobResponse](./RollupStartJobResponse.md), unknown>>;` |   || `startJob` | `startJob(this: [That](./That.md), params: [RollupStartJobRequest](./RollupStartJobRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[RollupStartJobResponse](./RollupStartJobResponse.md)>;` |   || `stopJob` | `stopJob(this: [That](./That.md), params: [RollupStopJobRequest](./RollupStopJobRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[RollupStopJobResponse](./RollupStopJobResponse.md)>;` | Stop rollup jobs. If you try to stop a job that does not exist, an exception occurs. If you try to stop a job that is already stopped, nothing happens. Since only a stopped job can be deleted, it can be useful to block the API until the indexer has fully stopped. This is accomplished with the `wait_for_completion` query parameter, and optionally a timeout. For example: ``` POST _rollup/job/sensor/_stop?wait_for_completion=true&timeout=10s ``` The parameter blocks the API call from returning until either the job has moved to STOPPED or the specified time has elapsed. If the specified time elapses without the job moving to STOPPED, a timeout exception occurs. || `stopJob` | `stopJob(this: [That](./That.md), params: [RollupStopJobRequest](./RollupStopJobRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[RollupStopJobResponse](./RollupStopJobResponse.md), unknown>>;` |   || `stopJob` | `stopJob(this: [That](./That.md), params: [RollupStopJobRequest](./RollupStopJobRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[RollupStopJobResponse](./RollupStopJobResponse.md)>;` |   | \ No newline at end of file diff --git a/docs/reference/api/RollupDateHistogramGrouping.md b/docs/reference/api/RollupDateHistogramGrouping.md new file mode 100644 index 000000000..e33b9afd4 --- /dev/null +++ b/docs/reference/api/RollupDateHistogramGrouping.md @@ -0,0 +1,11 @@ +## Interface `RollupDateHistogramGrouping` + +| Name | Type | Description | +| - | - | - | +| `calendar_interval` | [Duration](./Duration.md) | The interval of time buckets to be generated when rolling up. | +| `delay` | [Duration](./Duration.md) | How long to wait before rolling up new documents. By default, the indexer attempts to roll up all data that is available. However, it is not uncommon for data to arrive out of order. The indexer is unable to deal with data that arrives after a time-span has been rolled up. You need to specify a delay that matches the longest period of time you expect out-of-order data to arrive. | +| `field` | [Field](./Field.md) | The date field that is to be rolled up. | +| `fixed_interval` | [Duration](./Duration.md) | The interval of time buckets to be generated when rolling up. | +| `format` | string |   | +| `interval` | [Duration](./Duration.md) |   | +| `time_zone` | [TimeZone](./TimeZone.md) | Defines what `time_zone` the rollup documents are stored as. Unlike raw data, which can shift timezones on the fly, rolled documents have to be stored with a specific timezone. By default, rollup documents are stored in `UTC`. | diff --git a/docs/reference/api/RollupDeleteJobRequest.md b/docs/reference/api/RollupDeleteJobRequest.md new file mode 100644 index 000000000..1e08bfe76 --- /dev/null +++ b/docs/reference/api/RollupDeleteJobRequest.md @@ -0,0 +1,7 @@ +## Interface `RollupDeleteJobRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { id?: never; }) | All values in `body` will be added to the request body. | +| `id` | [Id](./Id.md) | Identifier for the job. | +| `querystring` | { [key: string]: any; } & { id?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/RollupDeleteJobResponse.md b/docs/reference/api/RollupDeleteJobResponse.md new file mode 100644 index 000000000..153348452 --- /dev/null +++ b/docs/reference/api/RollupDeleteJobResponse.md @@ -0,0 +1,6 @@ +## Interface `RollupDeleteJobResponse` + +| Name | Type | Description | +| - | - | - | +| `acknowledged` | boolean |   | +| `task_failures` | [TaskFailure](./TaskFailure.md)[] |   | diff --git a/docs/reference/api/RollupFieldMetric.md b/docs/reference/api/RollupFieldMetric.md new file mode 100644 index 000000000..e188abe59 --- /dev/null +++ b/docs/reference/api/RollupFieldMetric.md @@ -0,0 +1,6 @@ +## Interface `RollupFieldMetric` + +| Name | Type | Description | +| - | - | - | +| `field` | [Field](./Field.md) | The field to collect metrics for. This must be a numeric of some kind. | +| `metrics` | [RollupMetric](./RollupMetric.md)[] | An array of metrics to collect for the field. At least one metric must be configured. | diff --git a/docs/reference/api/RollupGetJobsIndexingJobState.md b/docs/reference/api/RollupGetJobsIndexingJobState.md new file mode 100644 index 000000000..d47ede937 --- /dev/null +++ b/docs/reference/api/RollupGetJobsIndexingJobState.md @@ -0,0 +1,4 @@ +## `RollupGetJobsIndexingJobState` +::: +type RollupGetJobsIndexingJobState = 'started' | 'indexing' | 'stopping' | 'stopped' | 'aborting'; +::: diff --git a/docs/reference/api/RollupGetJobsRequest.md b/docs/reference/api/RollupGetJobsRequest.md new file mode 100644 index 000000000..e2139f7c4 --- /dev/null +++ b/docs/reference/api/RollupGetJobsRequest.md @@ -0,0 +1,7 @@ +## Interface `RollupGetJobsRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { id?: never; }) | All values in `body` will be added to the request body. | +| `id` | [Id](./Id.md) | Identifier for the rollup job. If it is `_all` or omitted, the API returns all rollup jobs. | +| `querystring` | { [key: string]: any; } & { id?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/RollupGetJobsResponse.md b/docs/reference/api/RollupGetJobsResponse.md new file mode 100644 index 000000000..59cba3cb2 --- /dev/null +++ b/docs/reference/api/RollupGetJobsResponse.md @@ -0,0 +1,5 @@ +## Interface `RollupGetJobsResponse` + +| Name | Type | Description | +| - | - | - | +| `jobs` | [RollupGetJobsRollupJob](./RollupGetJobsRollupJob.md)[] |   | diff --git a/docs/reference/api/RollupGetJobsRollupJob.md b/docs/reference/api/RollupGetJobsRollupJob.md new file mode 100644 index 000000000..8a1d0ba1d --- /dev/null +++ b/docs/reference/api/RollupGetJobsRollupJob.md @@ -0,0 +1,7 @@ +## Interface `RollupGetJobsRollupJob` + +| Name | Type | Description | +| - | - | - | +| `config` | [RollupGetJobsRollupJobConfiguration](./RollupGetJobsRollupJobConfiguration.md) | The rollup job configuration. | +| `stats` | [RollupGetJobsRollupJobStats](./RollupGetJobsRollupJobStats.md) | Transient statistics about the rollup job, such as how many documents have been processed and how many rollup summary docs have been indexed. These stats are not persisted. If a node is restarted, these stats are reset. | +| `status` | [RollupGetJobsRollupJobStatus](./RollupGetJobsRollupJobStatus.md) | The current status of the indexer for the rollup job. | diff --git a/docs/reference/api/RollupGetJobsRollupJobConfiguration.md b/docs/reference/api/RollupGetJobsRollupJobConfiguration.md new file mode 100644 index 000000000..972e99767 --- /dev/null +++ b/docs/reference/api/RollupGetJobsRollupJobConfiguration.md @@ -0,0 +1,12 @@ +## Interface `RollupGetJobsRollupJobConfiguration` + +| Name | Type | Description | +| - | - | - | +| `cron` | string |   | +| `groups` | [RollupGroupings](./RollupGroupings.md) |   | +| `id` | [Id](./Id.md) |   | +| `index_pattern` | string |   | +| `metrics` | [RollupFieldMetric](./RollupFieldMetric.md)[] |   | +| `page_size` | [long](./long.md) |   | +| `rollup_index` | [IndexName](./IndexName.md) |   | +| `timeout` | [Duration](./Duration.md) |   | diff --git a/docs/reference/api/RollupGetJobsRollupJobStats.md b/docs/reference/api/RollupGetJobsRollupJobStats.md new file mode 100644 index 000000000..76248fa62 --- /dev/null +++ b/docs/reference/api/RollupGetJobsRollupJobStats.md @@ -0,0 +1,16 @@ +## Interface `RollupGetJobsRollupJobStats` + +| Name | Type | Description | +| - | - | - | +| `documents_processed` | [long](./long.md) |   | +| `index_failures` | [long](./long.md) |   | +| `index_time_in_ms` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> |   | +| `index_total` | [long](./long.md) |   | +| `pages_processed` | [long](./long.md) |   | +| `processing_time_in_ms` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> |   | +| `processing_total` | [long](./long.md) |   | +| `rollups_indexed` | [long](./long.md) |   | +| `search_failures` | [long](./long.md) |   | +| `search_time_in_ms` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> |   | +| `search_total` | [long](./long.md) |   | +| `trigger_count` | [long](./long.md) |   | diff --git a/docs/reference/api/RollupGetJobsRollupJobStatus.md b/docs/reference/api/RollupGetJobsRollupJobStatus.md new file mode 100644 index 000000000..72020dacd --- /dev/null +++ b/docs/reference/api/RollupGetJobsRollupJobStatus.md @@ -0,0 +1,7 @@ +## Interface `RollupGetJobsRollupJobStatus` + +| Name | Type | Description | +| - | - | - | +| `current_position` | Record |   | +| `job_state` | [RollupGetJobsIndexingJobState](./RollupGetJobsIndexingJobState.md) |   | +| `upgraded_doc_id` | boolean |   | diff --git a/docs/reference/api/RollupGetRollupCapsRequest.md b/docs/reference/api/RollupGetRollupCapsRequest.md new file mode 100644 index 000000000..5046d3fc5 --- /dev/null +++ b/docs/reference/api/RollupGetRollupCapsRequest.md @@ -0,0 +1,7 @@ +## Interface `RollupGetRollupCapsRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { id?: never; }) | All values in `body` will be added to the request body. | +| `id` | [Id](./Id.md) | Index, indices or index-pattern to return rollup capabilities for. `_all` may be used to fetch rollup capabilities from all jobs. | +| `querystring` | { [key: string]: any; } & { id?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/RollupGetRollupCapsResponse.md b/docs/reference/api/RollupGetRollupCapsResponse.md new file mode 100644 index 000000000..98f5e5004 --- /dev/null +++ b/docs/reference/api/RollupGetRollupCapsResponse.md @@ -0,0 +1,4 @@ +## `RollupGetRollupCapsResponse` +::: +type RollupGetRollupCapsResponse = Record<[IndexName](./IndexName.md), [RollupGetRollupCapsRollupCapabilities](./RollupGetRollupCapsRollupCapabilities.md)>; +::: diff --git a/docs/reference/api/RollupGetRollupCapsRollupCapabilities.md b/docs/reference/api/RollupGetRollupCapsRollupCapabilities.md new file mode 100644 index 000000000..029a771bd --- /dev/null +++ b/docs/reference/api/RollupGetRollupCapsRollupCapabilities.md @@ -0,0 +1,5 @@ +## Interface `RollupGetRollupCapsRollupCapabilities` + +| Name | Type | Description | +| - | - | - | +| `rollup_jobs` | [RollupGetRollupCapsRollupCapabilitySummary](./RollupGetRollupCapsRollupCapabilitySummary.md)[] | There can be multiple, independent jobs configured for a single index or index pattern. Each of these jobs may have different configurations, so the API returns a list of all the various configurations available. | diff --git a/docs/reference/api/RollupGetRollupCapsRollupCapabilitySummary.md b/docs/reference/api/RollupGetRollupCapsRollupCapabilitySummary.md new file mode 100644 index 000000000..17299005e --- /dev/null +++ b/docs/reference/api/RollupGetRollupCapsRollupCapabilitySummary.md @@ -0,0 +1,8 @@ +## Interface `RollupGetRollupCapsRollupCapabilitySummary` + +| Name | Type | Description | +| - | - | - | +| `fields` | Record<[Field](./Field.md), [RollupGetRollupCapsRollupFieldSummary](./RollupGetRollupCapsRollupFieldSummary.md)[]> |   | +| `index_pattern` | string |   | +| `job_id` | string |   | +| `rollup_index` | string |   | diff --git a/docs/reference/api/RollupGetRollupCapsRollupFieldSummary.md b/docs/reference/api/RollupGetRollupCapsRollupFieldSummary.md new file mode 100644 index 000000000..30eae0886 --- /dev/null +++ b/docs/reference/api/RollupGetRollupCapsRollupFieldSummary.md @@ -0,0 +1,7 @@ +## Interface `RollupGetRollupCapsRollupFieldSummary` + +| Name | Type | Description | +| - | - | - | +| `agg` | string |   | +| `calendar_interval` | [Duration](./Duration.md) |   | +| `time_zone` | [TimeZone](./TimeZone.md) |   | diff --git a/docs/reference/api/RollupGetRollupIndexCapsIndexCapabilities.md b/docs/reference/api/RollupGetRollupIndexCapsIndexCapabilities.md new file mode 100644 index 000000000..ce1428cbe --- /dev/null +++ b/docs/reference/api/RollupGetRollupIndexCapsIndexCapabilities.md @@ -0,0 +1,5 @@ +## Interface `RollupGetRollupIndexCapsIndexCapabilities` + +| Name | Type | Description | +| - | - | - | +| `rollup_jobs` | [RollupGetRollupIndexCapsRollupJobSummary](./RollupGetRollupIndexCapsRollupJobSummary.md)[] |   | diff --git a/docs/reference/api/RollupGetRollupIndexCapsRequest.md b/docs/reference/api/RollupGetRollupIndexCapsRequest.md new file mode 100644 index 000000000..6115c4643 --- /dev/null +++ b/docs/reference/api/RollupGetRollupIndexCapsRequest.md @@ -0,0 +1,7 @@ +## Interface `RollupGetRollupIndexCapsRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { index?: never; }) | All values in `body` will be added to the request body. | +| `index` | [Ids](./Ids.md) | Data stream or index to check for rollup capabilities. Wildcard ( `*`) expressions are supported. | +| `querystring` | { [key: string]: any; } & { index?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/RollupGetRollupIndexCapsResponse.md b/docs/reference/api/RollupGetRollupIndexCapsResponse.md new file mode 100644 index 000000000..19c5dcde0 --- /dev/null +++ b/docs/reference/api/RollupGetRollupIndexCapsResponse.md @@ -0,0 +1,4 @@ +## `RollupGetRollupIndexCapsResponse` +::: +type RollupGetRollupIndexCapsResponse = Record<[IndexName](./IndexName.md), [RollupGetRollupIndexCapsIndexCapabilities](./RollupGetRollupIndexCapsIndexCapabilities.md)>; +::: diff --git a/docs/reference/api/RollupGetRollupIndexCapsRollupJobSummary.md b/docs/reference/api/RollupGetRollupIndexCapsRollupJobSummary.md new file mode 100644 index 000000000..c099af645 --- /dev/null +++ b/docs/reference/api/RollupGetRollupIndexCapsRollupJobSummary.md @@ -0,0 +1,8 @@ +## Interface `RollupGetRollupIndexCapsRollupJobSummary` + +| Name | Type | Description | +| - | - | - | +| `fields` | Record<[Field](./Field.md), [RollupGetRollupIndexCapsRollupJobSummaryField](./RollupGetRollupIndexCapsRollupJobSummaryField.md)[]> |   | +| `index_pattern` | string |   | +| `job_id` | [Id](./Id.md) |   | +| `rollup_index` | [IndexName](./IndexName.md) |   | diff --git a/docs/reference/api/RollupGetRollupIndexCapsRollupJobSummaryField.md b/docs/reference/api/RollupGetRollupIndexCapsRollupJobSummaryField.md new file mode 100644 index 000000000..c8d29618d --- /dev/null +++ b/docs/reference/api/RollupGetRollupIndexCapsRollupJobSummaryField.md @@ -0,0 +1,7 @@ +## Interface `RollupGetRollupIndexCapsRollupJobSummaryField` + +| Name | Type | Description | +| - | - | - | +| `agg` | string |   | +| `calendar_interval` | [Duration](./Duration.md) |   | +| `time_zone` | [TimeZone](./TimeZone.md) |   | diff --git a/docs/reference/api/RollupGroupings.md b/docs/reference/api/RollupGroupings.md new file mode 100644 index 000000000..bd8fa2431 --- /dev/null +++ b/docs/reference/api/RollupGroupings.md @@ -0,0 +1,7 @@ +## Interface `RollupGroupings` + +| Name | Type | Description | +| - | - | - | +| `date_histogram` | [RollupDateHistogramGrouping](./RollupDateHistogramGrouping.md) | A date histogram group aggregates a date field into time-based buckets. This group is mandatory; you currently cannot roll up documents without a timestamp and a `date_histogram` group. | +| `histogram` | [RollupHistogramGrouping](./RollupHistogramGrouping.md) | The histogram group aggregates one or more numeric fields into numeric histogram intervals. | +| `terms` | [RollupTermsGrouping](./RollupTermsGrouping.md) | The terms group can be used on keyword or numeric fields to allow bucketing via the terms aggregation at a later point. The indexer enumerates and stores all values of a field for each time-period. This can be potentially costly for high-cardinality groups such as IP addresses, especially if the time-bucket is particularly sparse. | diff --git a/docs/reference/api/RollupHistogramGrouping.md b/docs/reference/api/RollupHistogramGrouping.md new file mode 100644 index 000000000..415414099 --- /dev/null +++ b/docs/reference/api/RollupHistogramGrouping.md @@ -0,0 +1,6 @@ +## Interface `RollupHistogramGrouping` + +| Name | Type | Description | +| - | - | - | +| `fields` | [Fields](./Fields.md) | The set of fields that you wish to build histograms for. All fields specified must be some kind of numeric. Order does not matter. | +| `interval` | [long](./long.md) | The interval of histogram buckets to be generated when rolling up. For example, a value of `5` creates buckets that are five units wide ( `0-5`, `5-10`, etc). Note that only one interval can be specified in the histogram group, meaning that all fields being grouped via the histogram must share the same interval. | diff --git a/docs/reference/api/RollupMetric.md b/docs/reference/api/RollupMetric.md new file mode 100644 index 000000000..7d781a37a --- /dev/null +++ b/docs/reference/api/RollupMetric.md @@ -0,0 +1,4 @@ +## `RollupMetric` +::: +type RollupMetric = 'min' | 'max' | 'sum' | 'avg' | 'value_count'; +::: diff --git a/docs/reference/api/RollupPutJobRequest.md b/docs/reference/api/RollupPutJobRequest.md new file mode 100644 index 000000000..d2c53155e --- /dev/null +++ b/docs/reference/api/RollupPutJobRequest.md @@ -0,0 +1,15 @@ +## Interface `RollupPutJobRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { id?: never; cron?: never; groups?: never; index_pattern?: never; metrics?: never; page_size?: never; rollup_index?: never; timeout?: never; headers?: never; }) | All values in `body` will be added to the request body. | +| `cron` | string | A cron string which defines the intervals when the rollup job should be executed. When the interval triggers, the indexer attempts to rollup the data in the index pattern. The cron pattern is unrelated to the time interval of the data being rolled up. For example, you may wish to create hourly rollups of your document but to only run the indexer on a daily basis at midnight, as defined by the cron. The cron pattern is defined just like a Watcher cron schedule. | +| `groups` | [RollupGroupings](./RollupGroupings.md) | Defines the grouping fields and aggregations that are defined for this rollup job. These fields will then be available later for aggregating into buckets. These aggs and fields can be used in any combination. Think of the groups configuration as defining a set of tools that can later be used in aggregations to partition the data. Unlike raw data, we have to think ahead to which fields and aggregations might be used. Rollups provide enough flexibility that you simply need to determine which fields are needed, not in what order they are needed. | +| `headers` | [HttpHeaders](./HttpHeaders.md) |   | +| `id` | [Id](./Id.md) | Identifier for the rollup job. This can be any alphanumeric string and uniquely identifies the data that is associated with the rollup job. The ID is persistent; it is stored with the rolled up data. If you create a job, let it run for a while, then delete the job, the data that the job rolled up is still be associated with this job ID. You cannot create a new job with the same ID since that could lead to problems with mismatched job configurations. | +| `index_pattern` | string | The index or index pattern to roll up. Supports wildcard-style patterns ( `logstash-*`). The job attempts to rollup the entire index or index-pattern. | +| `metrics` | [RollupFieldMetric](./RollupFieldMetric.md)[] | Defines the metrics to collect for each grouping tuple. By default, only the doc_counts are collected for each group. To make rollup useful, you will often add metrics like averages, mins, maxes, etc. Metrics are defined on a per-field basis and for each field you configure which metric should be collected. | +| `page_size` | [integer](./integer.md) | The number of bucket results that are processed on each iteration of the rollup indexer. A larger value tends to execute faster, but requires more memory during processing. This value has no effect on how the data is rolled up; it is merely used for tweaking the speed or memory cost of the indexer. | +| `querystring` | { [key: string]: any; } & { id?: never; cron?: never; groups?: never; index_pattern?: never; metrics?: never; page_size?: never; rollup_index?: never; timeout?: never; headers?: never; } | All values in `querystring` will be added to the request querystring. | +| `rollup_index` | [IndexName](./IndexName.md) | The index that contains the rollup results. The index can be shared with other rollup jobs. The data is stored so that it doesn’t interfere with unrelated jobs. | +| `timeout` | [Duration](./Duration.md) | Time to wait for the request to complete. | diff --git a/docs/reference/api/RollupPutJobResponse.md b/docs/reference/api/RollupPutJobResponse.md new file mode 100644 index 000000000..62ebad45e --- /dev/null +++ b/docs/reference/api/RollupPutJobResponse.md @@ -0,0 +1,4 @@ +## `RollupPutJobResponse` +::: +type RollupPutJobResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); +::: diff --git a/docs/reference/api/RollupRollupSearchRequest.md b/docs/reference/api/RollupRollupSearchRequest.md new file mode 100644 index 000000000..b3b22a146 --- /dev/null +++ b/docs/reference/api/RollupRollupSearchRequest.md @@ -0,0 +1,13 @@ +## Interface `RollupRollupSearchRequest` + +| Name | Type | Description | +| - | - | - | +| `aggregations` | Record | Specifies aggregations. | +| `aggs` | Record | Specifies aggregations. aggregations | +| `body` | string | ({ [key: string]: any; } & { index?: never; rest_total_hits_as_int?: never; typed_keys?: never; aggregations?: never; aggs?: never; query?: never; size?: never; }) | All values in `body` will be added to the request body. | +| `index` | [Indices](./Indices.md) | A comma-separated list of data streams and indices used to limit the request. This parameter has the following rules: * At least one data stream, index, or wildcard expression must be specified. This target can include a rollup or non-rollup index. For data streams, the stream's backing indices can only serve as non-rollup indices. Omitting the parameter or using `_all` are not permitted. * Multiple non-rollup indices may be specified. * Only one rollup index may be specified. If more than one are supplied, an exception occurs. * Wildcard expressions ( `*`) may be used. If they match more than one rollup index, an exception occurs. However, you can use an expression to match multiple non-rollup indices or data streams. | +| `query` | [QueryDslQueryContainer](./QueryDslQueryContainer.md) | Specifies a DSL query that is subject to some limitations. | +| `querystring` | { [key: string]: any; } & { index?: never; rest_total_hits_as_int?: never; typed_keys?: never; aggregations?: never; aggs?: never; query?: never; size?: never; } | All values in `querystring` will be added to the request querystring. | +| `rest_total_hits_as_int` | boolean | Indicates whether hits.total should be rendered as an integer or an object in the rest search response | +| `size` | [integer](./integer.md) | Must be zero if set, as rollups work on pre-aggregated data. | +| `typed_keys` | boolean | Specify whether aggregation and suggester names should be prefixed by their respective types in the response | diff --git a/docs/reference/api/RollupRollupSearchResponse.md b/docs/reference/api/RollupRollupSearchResponse.md new file mode 100644 index 000000000..8869fde81 --- /dev/null +++ b/docs/reference/api/RollupRollupSearchResponse.md @@ -0,0 +1,10 @@ +## Interface `RollupRollupSearchResponse` + +| Name | Type | Description | +| - | - | - | +| `_shards` | [ShardStatistics](./ShardStatistics.md) |   | +| `aggregations` | TAggregations |   | +| `hits` | [SearchHitsMetadata](./SearchHitsMetadata.md) |   | +| `terminated_early` | boolean |   | +| `timed_out` | boolean |   | +| `took` | [long](./long.md) |   | diff --git a/docs/reference/api/RollupStartJobRequest.md b/docs/reference/api/RollupStartJobRequest.md new file mode 100644 index 000000000..c06fe5fd4 --- /dev/null +++ b/docs/reference/api/RollupStartJobRequest.md @@ -0,0 +1,7 @@ +## Interface `RollupStartJobRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { id?: never; }) | All values in `body` will be added to the request body. | +| `id` | [Id](./Id.md) | Identifier for the rollup job. | +| `querystring` | { [key: string]: any; } & { id?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/RollupStartJobResponse.md b/docs/reference/api/RollupStartJobResponse.md new file mode 100644 index 000000000..09e61ed4c --- /dev/null +++ b/docs/reference/api/RollupStartJobResponse.md @@ -0,0 +1,5 @@ +## Interface `RollupStartJobResponse` + +| Name | Type | Description | +| - | - | - | +| `started` | boolean |   | diff --git a/docs/reference/api/RollupStopJobRequest.md b/docs/reference/api/RollupStopJobRequest.md new file mode 100644 index 000000000..63dc522e8 --- /dev/null +++ b/docs/reference/api/RollupStopJobRequest.md @@ -0,0 +1,9 @@ +## Interface `RollupStopJobRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { id?: never; timeout?: never; wait_for_completion?: never; }) | All values in `body` will be added to the request body. | +| `id` | [Id](./Id.md) | Identifier for the rollup job. | +| `querystring` | { [key: string]: any; } & { id?: never; timeout?: never; wait_for_completion?: never; } | All values in `querystring` will be added to the request querystring. | +| `timeout` | [Duration](./Duration.md) | If `wait_for_completion` is `true`, the API blocks for (at maximum) the specified duration while waiting for the job to stop. If more than `timeout` time has passed, the API throws a timeout exception. NOTE: Even if a timeout occurs, the stop request is still processing and eventually moves the job to STOPPED. The timeout simply means the API call itself timed out while waiting for the status change. | +| `wait_for_completion` | boolean | If set to `true`, causes the API to block until the indexer state completely stops. If set to `false`, the API returns immediately and the indexer is stopped asynchronously in the background. | diff --git a/docs/reference/api/RollupStopJobResponse.md b/docs/reference/api/RollupStopJobResponse.md new file mode 100644 index 000000000..41be43cb2 --- /dev/null +++ b/docs/reference/api/RollupStopJobResponse.md @@ -0,0 +1,5 @@ +## Interface `RollupStopJobResponse` + +| Name | Type | Description | +| - | - | - | +| `stopped` | boolean |   | diff --git a/docs/reference/api/RollupTermsGrouping.md b/docs/reference/api/RollupTermsGrouping.md new file mode 100644 index 000000000..fff4c05c4 --- /dev/null +++ b/docs/reference/api/RollupTermsGrouping.md @@ -0,0 +1,5 @@ +## Interface `RollupTermsGrouping` + +| Name | Type | Description | +| - | - | - | +| `fields` | [Fields](./Fields.md) | The set of fields that you wish to collect terms for. This array can contain fields that are both keyword and numerics. Order does not matter. | diff --git a/docs/reference/api/Routing.md b/docs/reference/api/Routing.md new file mode 100644 index 000000000..2763e2e25 --- /dev/null +++ b/docs/reference/api/Routing.md @@ -0,0 +1,4 @@ +## `Routing` +::: +type Routing = string; +::: diff --git a/docs/reference/api/RrfRank.md b/docs/reference/api/RrfRank.md new file mode 100644 index 000000000..c6bf05664 --- /dev/null +++ b/docs/reference/api/RrfRank.md @@ -0,0 +1,6 @@ +## Interface `RrfRank` + +| Name | Type | Description | +| - | - | - | +| `rank_constant` | [long](./long.md) | How much influence documents in individual result sets per query have over the final ranked result set | +| `rank_window_size` | [long](./long.md) | Size of the individual result sets per query | diff --git a/docs/reference/api/RuleRetriever.md b/docs/reference/api/RuleRetriever.md new file mode 100644 index 000000000..631fe809a --- /dev/null +++ b/docs/reference/api/RuleRetriever.md @@ -0,0 +1,8 @@ +## Interface `RuleRetriever` + +| Name | Type | Description | +| - | - | - | +| `match_criteria` | any | The match criteria that will determine if a rule in the provided rulesets should be applied. | +| `rank_window_size` | [integer](./integer.md) | This value determines the size of the individual result set. | +| `retriever` | [RetrieverContainer](./RetrieverContainer.md) | The retriever whose results rules should be applied to. | +| `ruleset_ids` | [Id](./Id.md)[] | The ruleset IDs containing the rules this retriever is evaluating against. | diff --git a/docs/reference/api/ScalarValue.md b/docs/reference/api/ScalarValue.md new file mode 100644 index 000000000..0cc4ae095 --- /dev/null +++ b/docs/reference/api/ScalarValue.md @@ -0,0 +1,4 @@ +## `ScalarValue` +::: +type ScalarValue = [long](./long.md) | [double](./double.md) | string | boolean | null; +::: diff --git a/docs/reference/api/ScoreSort.md b/docs/reference/api/ScoreSort.md new file mode 100644 index 000000000..0d08e54c1 --- /dev/null +++ b/docs/reference/api/ScoreSort.md @@ -0,0 +1,5 @@ +## Interface `ScoreSort` + +| Name | Type | Description | +| - | - | - | +| `order` | [SortOrder](./SortOrder.md) |   | diff --git a/docs/reference/api/Script.md b/docs/reference/api/Script.md new file mode 100644 index 000000000..af74d9ecd --- /dev/null +++ b/docs/reference/api/Script.md @@ -0,0 +1,9 @@ +## Interface `Script` + +| Name | Type | Description | +| - | - | - | +| `id` | [Id](./Id.md) | The `id` for a stored script. | +| `lang` | [ScriptLanguage](./ScriptLanguage.md) | Specifies the language the script is written in. | +| `options` | Record |   | +| `params` | Record | Specifies any named parameters that are passed into the script as variables. Use parameters instead of hard-coded values to decrease compile time. | +| `source` | [ScriptSource](./ScriptSource.md) | The script source. | diff --git a/docs/reference/api/ScriptField.md b/docs/reference/api/ScriptField.md new file mode 100644 index 000000000..ce56a4b72 --- /dev/null +++ b/docs/reference/api/ScriptField.md @@ -0,0 +1,6 @@ +## Interface `ScriptField` + +| Name | Type | Description | +| - | - | - | +| `ignore_failure` | boolean |   | +| `script` | [Script](./Script.md) | [ScriptSource](./ScriptSource.md) |   | diff --git a/docs/reference/api/ScriptLanguage.md b/docs/reference/api/ScriptLanguage.md new file mode 100644 index 000000000..444bef409 --- /dev/null +++ b/docs/reference/api/ScriptLanguage.md @@ -0,0 +1,4 @@ +## `ScriptLanguage` +::: +type ScriptLanguage = 'painless' | 'expression' | 'mustache' | 'java' | string; +::: diff --git a/docs/reference/api/ScriptSort.md b/docs/reference/api/ScriptSort.md new file mode 100644 index 000000000..3317ab5e9 --- /dev/null +++ b/docs/reference/api/ScriptSort.md @@ -0,0 +1,9 @@ +## Interface `ScriptSort` + +| Name | Type | Description | +| - | - | - | +| `mode` | [SortMode](./SortMode.md) |   | +| `nested` | [NestedSortValue](./NestedSortValue.md) |   | +| `order` | [SortOrder](./SortOrder.md) |   | +| `script` | [Script](./Script.md) | [ScriptSource](./ScriptSource.md) |   | +| `type` | [ScriptSortType](./ScriptSortType.md) |   | diff --git a/docs/reference/api/ScriptSortType.md b/docs/reference/api/ScriptSortType.md new file mode 100644 index 000000000..fcdf9652f --- /dev/null +++ b/docs/reference/api/ScriptSortType.md @@ -0,0 +1,4 @@ +## `ScriptSortType` +::: +type ScriptSortType = 'string' | 'number' | 'version'; +::: diff --git a/docs/reference/api/ScriptSource.md b/docs/reference/api/ScriptSource.md new file mode 100644 index 000000000..248d12381 --- /dev/null +++ b/docs/reference/api/ScriptSource.md @@ -0,0 +1,4 @@ +## `ScriptSource` +::: +type ScriptSource = string | [SearchSearchRequestBody](./SearchSearchRequestBody.md); +::: diff --git a/docs/reference/api/ScriptTransform.md b/docs/reference/api/ScriptTransform.md new file mode 100644 index 000000000..a294948ea --- /dev/null +++ b/docs/reference/api/ScriptTransform.md @@ -0,0 +1,8 @@ +## Interface `ScriptTransform` + +| Name | Type | Description | +| - | - | - | +| `id` | string |   | +| `lang` | string |   | +| `params` | Record |   | +| `source` | [ScriptSource](./ScriptSource.md) |   | diff --git a/docs/reference/api/ScriptsPainlessExecuteApi_1.md b/docs/reference/api/ScriptsPainlessExecuteApi_1.md new file mode 100644 index 000000000..f69d9565f --- /dev/null +++ b/docs/reference/api/ScriptsPainlessExecuteApi_1.md @@ -0,0 +1,3 @@ +::: +default function ScriptsPainlessExecuteApi(this: [That](./That.md), params?: [ScriptsPainlessExecuteRequest](./ScriptsPainlessExecuteRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ScriptsPainlessExecuteResponse](./ScriptsPainlessExecuteResponse.md)>; +::: diff --git a/docs/reference/api/ScriptsPainlessExecuteApi_2.md b/docs/reference/api/ScriptsPainlessExecuteApi_2.md new file mode 100644 index 000000000..fd1728ee1 --- /dev/null +++ b/docs/reference/api/ScriptsPainlessExecuteApi_2.md @@ -0,0 +1,3 @@ +::: +default function ScriptsPainlessExecuteApi(this: [That](./That.md), params?: [ScriptsPainlessExecuteRequest](./ScriptsPainlessExecuteRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ScriptsPainlessExecuteResponse](./ScriptsPainlessExecuteResponse.md), unknown>>; +::: diff --git a/docs/reference/api/ScriptsPainlessExecuteApi_3.md b/docs/reference/api/ScriptsPainlessExecuteApi_3.md new file mode 100644 index 000000000..9761c3e8f --- /dev/null +++ b/docs/reference/api/ScriptsPainlessExecuteApi_3.md @@ -0,0 +1,3 @@ +::: +default function ScriptsPainlessExecuteApi(this: [That](./That.md), params?: [ScriptsPainlessExecuteRequest](./ScriptsPainlessExecuteRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ScriptsPainlessExecuteResponse](./ScriptsPainlessExecuteResponse.md)>; +::: diff --git a/docs/reference/api/ScriptsPainlessExecutePainlessContext.md b/docs/reference/api/ScriptsPainlessExecutePainlessContext.md new file mode 100644 index 000000000..63b75fc17 --- /dev/null +++ b/docs/reference/api/ScriptsPainlessExecutePainlessContext.md @@ -0,0 +1,4 @@ +## `ScriptsPainlessExecutePainlessContext` +::: +type ScriptsPainlessExecutePainlessContext = 'painless_test' | 'filter' | 'score' | 'boolean_field' | 'date_field' | 'double_field' | 'geo_point_field' | 'ip_field' | 'keyword_field' | 'long_field' | 'composite_field'; +::: diff --git a/docs/reference/api/ScriptsPainlessExecutePainlessContextSetup.md b/docs/reference/api/ScriptsPainlessExecutePainlessContextSetup.md new file mode 100644 index 000000000..76da5a50d --- /dev/null +++ b/docs/reference/api/ScriptsPainlessExecutePainlessContextSetup.md @@ -0,0 +1,7 @@ +## Interface `ScriptsPainlessExecutePainlessContextSetup` + +| Name | Type | Description | +| - | - | - | +| `document` | any | Document that's temporarily indexed in-memory and accessible from the script. | +| `index` | [IndexName](./IndexName.md) | Index containing a mapping that's compatible with the indexed document. You may specify a remote index by prefixing the index with the remote cluster alias. For example, `remote1:my_index` indicates that you want to run the painless script against the "my_index" index on the "remote1" cluster. This request will be forwarded to the "remote1" cluster if you have configured a connection to that remote cluster. NOTE: Wildcards are not accepted in the index expression for this endpoint. The expression `*:myindex` will return the error "No such remote cluster" and the expression `logs*` or `remote1:logs*` will return the error "index not found". | +| `query` | [QueryDslQueryContainer](./QueryDslQueryContainer.md) | Use this parameter to specify a query for computing a score. | diff --git a/docs/reference/api/ScriptsPainlessExecuteRequest.md b/docs/reference/api/ScriptsPainlessExecuteRequest.md new file mode 100644 index 000000000..44b6e96f7 --- /dev/null +++ b/docs/reference/api/ScriptsPainlessExecuteRequest.md @@ -0,0 +1,9 @@ +## Interface `ScriptsPainlessExecuteRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { context?: never; context_setup?: never; script?: never; }) | All values in `body` will be added to the request body. | +| `context_setup` | [ScriptsPainlessExecutePainlessContextSetup](./ScriptsPainlessExecutePainlessContextSetup.md) | Additional parameters for the `context`. NOTE: This parameter is required for all contexts except `painless_test`, which is the default if no value is provided for `context`. | +| `context` | [ScriptsPainlessExecutePainlessContext](./ScriptsPainlessExecutePainlessContext.md) | The context that the script should run in. NOTE: Result ordering in the field contexts is not guaranteed. | +| `querystring` | { [key: string]: any; } & { context?: never; context_setup?: never; script?: never; } | All values in `querystring` will be added to the request querystring. | +| `script` | [Script](./Script.md) | [ScriptSource](./ScriptSource.md) | The Painless script to run. | diff --git a/docs/reference/api/ScriptsPainlessExecuteResponse.md b/docs/reference/api/ScriptsPainlessExecuteResponse.md new file mode 100644 index 000000000..e5f313c12 --- /dev/null +++ b/docs/reference/api/ScriptsPainlessExecuteResponse.md @@ -0,0 +1,5 @@ +## Interface `ScriptsPainlessExecuteResponse` + +| Name | Type | Description | +| - | - | - | +| `result` | TResult |   | diff --git a/docs/reference/api/ScrollApi_1.md b/docs/reference/api/ScrollApi_1.md new file mode 100644 index 000000000..c7764e66e --- /dev/null +++ b/docs/reference/api/ScrollApi_1.md @@ -0,0 +1,3 @@ +::: +default function ScrollApi>(this: [That](./That.md), params: [ScrollRequest](./ScrollRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ScrollResponse](./ScrollResponse.md)>; +::: diff --git a/docs/reference/api/ScrollApi_2.md b/docs/reference/api/ScrollApi_2.md new file mode 100644 index 000000000..b9281ca42 --- /dev/null +++ b/docs/reference/api/ScrollApi_2.md @@ -0,0 +1,3 @@ +::: +default function ScrollApi>(this: [That](./That.md), params: [ScrollRequest](./ScrollRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ScrollResponse](./ScrollResponse.md), unknown>>; +::: diff --git a/docs/reference/api/ScrollApi_3.md b/docs/reference/api/ScrollApi_3.md new file mode 100644 index 000000000..93fca7cb0 --- /dev/null +++ b/docs/reference/api/ScrollApi_3.md @@ -0,0 +1,3 @@ +::: +default function ScrollApi>(this: [That](./That.md), params: [ScrollRequest](./ScrollRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ScrollResponse](./ScrollResponse.md)>; +::: diff --git a/docs/reference/api/ScrollId.md b/docs/reference/api/ScrollId.md new file mode 100644 index 000000000..4914d7480 --- /dev/null +++ b/docs/reference/api/ScrollId.md @@ -0,0 +1,4 @@ +## `ScrollId` +::: +type ScrollId = string; +::: diff --git a/docs/reference/api/ScrollIds.md b/docs/reference/api/ScrollIds.md new file mode 100644 index 000000000..cf0b2417e --- /dev/null +++ b/docs/reference/api/ScrollIds.md @@ -0,0 +1,4 @@ +## `ScrollIds` +::: +type ScrollIds = [ScrollId](./ScrollId.md) | [ScrollId](./ScrollId.md)[]; +::: diff --git a/docs/reference/api/ScrollRequest.md b/docs/reference/api/ScrollRequest.md new file mode 100644 index 000000000..833f2fbcf --- /dev/null +++ b/docs/reference/api/ScrollRequest.md @@ -0,0 +1,9 @@ +## Interface `ScrollRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { scroll_id?: never; rest_total_hits_as_int?: never; scroll?: never; }) | All values in `body` will be added to the request body. | +| `querystring` | { [key: string]: any; } & { scroll_id?: never; rest_total_hits_as_int?: never; scroll?: never; } | All values in `querystring` will be added to the request querystring. | +| `rest_total_hits_as_int` | boolean | If true, the API response’s hit.total property is returned as an integer. If false, the API response’s hit.total property is returned as an object. | +| `scroll_id` | [ScrollId](./ScrollId.md) | The scroll ID | +| `scroll` | [Duration](./Duration.md) | The period to retain the search context for scrolling. | diff --git a/docs/reference/api/ScrollResponse.md b/docs/reference/api/ScrollResponse.md new file mode 100644 index 000000000..57051cc68 --- /dev/null +++ b/docs/reference/api/ScrollResponse.md @@ -0,0 +1,4 @@ +## `ScrollResponse` +::: +type ScrollResponse> = [SearchResponseBody](./SearchResponseBody.md); +::: diff --git a/docs/reference/api/ScrollSearchOptions.md b/docs/reference/api/ScrollSearchOptions.md new file mode 100644 index 000000000..0753471b2 --- /dev/null +++ b/docs/reference/api/ScrollSearchOptions.md @@ -0,0 +1,5 @@ +## Interface `ScrollSearchOptions` + +| Name | Type | Description | +| - | - | - | +| `wait` | number |   | diff --git a/docs/reference/api/ScrollSearchResponse.md b/docs/reference/api/ScrollSearchResponse.md new file mode 100644 index 000000000..2832b460f --- /dev/null +++ b/docs/reference/api/ScrollSearchResponse.md @@ -0,0 +1,6 @@ +## Interface `ScrollSearchResponse` + +| Name | Type | Description | +| - | - | - | +| `clear` | () => Promise |   | +| `documents` | TDocument[] |   | diff --git a/docs/reference/api/SearchAggregationBreakdown.md b/docs/reference/api/SearchAggregationBreakdown.md new file mode 100644 index 000000000..8cc5e9f79 --- /dev/null +++ b/docs/reference/api/SearchAggregationBreakdown.md @@ -0,0 +1,16 @@ +## Interface `SearchAggregationBreakdown` + +| Name | Type | Description | +| - | - | - | +| `build_aggregation_count` | [long](./long.md) |   | +| `build_aggregation` | [long](./long.md) |   | +| `build_leaf_collector_count` | [long](./long.md) |   | +| `build_leaf_collector` | [long](./long.md) |   | +| `collect_count` | [long](./long.md) |   | +| `collect` | [long](./long.md) |   | +| `initialize_count` | [long](./long.md) |   | +| `initialize` | [long](./long.md) |   | +| `post_collection_count` | [long](./long.md) |   | +| `post_collection` | [long](./long.md) |   | +| `reduce_count` | [long](./long.md) |   | +| `reduce` | [long](./long.md) |   | diff --git a/docs/reference/api/SearchAggregationProfile.md b/docs/reference/api/SearchAggregationProfile.md new file mode 100644 index 000000000..b42ff5c1c --- /dev/null +++ b/docs/reference/api/SearchAggregationProfile.md @@ -0,0 +1,10 @@ +## Interface `SearchAggregationProfile` + +| Name | Type | Description | +| - | - | - | +| `breakdown` | [SearchAggregationBreakdown](./SearchAggregationBreakdown.md) |   | +| `children` | [SearchAggregationProfile](./SearchAggregationProfile.md)[] |   | +| `debug` | [SearchAggregationProfileDebug](./SearchAggregationProfileDebug.md) |   | +| `description` | string |   | +| `time_in_nanos` | [DurationValue](./DurationValue.md)<[UnitNanos](./UnitNanos.md)> |   | +| `type` | string |   | diff --git a/docs/reference/api/SearchAggregationProfileDebug.md b/docs/reference/api/SearchAggregationProfileDebug.md new file mode 100644 index 000000000..62e04df10 --- /dev/null +++ b/docs/reference/api/SearchAggregationProfileDebug.md @@ -0,0 +1,36 @@ +## Interface `SearchAggregationProfileDebug` + +| Name | Type | Description | +| - | - | - | +| `brute_force_used` | [integer](./integer.md) |   | +| `built_buckets` | [integer](./integer.md) |   | +| `chars_fetched` | [integer](./integer.md) |   | +| `collect_analyzed_count` | [integer](./integer.md) |   | +| `collect_analyzed_ns` | [integer](./integer.md) |   | +| `collection_strategy` | string |   | +| `deferred_aggregators` | string[] |   | +| `delegate_debug` | [SearchAggregationProfileDebug](./SearchAggregationProfileDebug.md) |   | +| `delegate` | string |   | +| `dynamic_pruning_attempted` | [integer](./integer.md) |   | +| `dynamic_pruning_used` | [integer](./integer.md) |   | +| `empty_collectors_used` | [integer](./integer.md) |   | +| `extract_count` | [integer](./integer.md) |   | +| `extract_ns` | [integer](./integer.md) |   | +| `filters` | [SearchAggregationProfileDelegateDebugFilter](./SearchAggregationProfileDelegateDebugFilter.md)[] |   | +| `has_filter` | boolean |   | +| `map_reducer` | string |   | +| `numeric_collectors_used` | [integer](./integer.md) |   | +| `ordinals_collectors_overhead_too_high` | [integer](./integer.md) |   | +| `ordinals_collectors_used` | [integer](./integer.md) |   | +| `result_strategy` | string |   | +| `segments_collected` | [integer](./integer.md) |   | +| `segments_counted` | [integer](./integer.md) |   | +| `segments_with_deleted_docs` | [integer](./integer.md) |   | +| `segments_with_doc_count_field` | [integer](./integer.md) |   | +| `segments_with_multi_valued_ords` | [integer](./integer.md) |   | +| `segments_with_single_valued_ords` | [integer](./integer.md) |   | +| `skipped_due_to_no_data` | [integer](./integer.md) |   | +| `string_hashing_collectors_used` | [integer](./integer.md) |   | +| `surviving_buckets` | [integer](./integer.md) |   | +| `total_buckets` | [integer](./integer.md) |   | +| `values_fetched` | [integer](./integer.md) |   | diff --git a/docs/reference/api/SearchAggregationProfileDelegateDebugFilter.md b/docs/reference/api/SearchAggregationProfileDelegateDebugFilter.md new file mode 100644 index 000000000..8dcded6c2 --- /dev/null +++ b/docs/reference/api/SearchAggregationProfileDelegateDebugFilter.md @@ -0,0 +1,8 @@ +## Interface `SearchAggregationProfileDelegateDebugFilter` + +| Name | Type | Description | +| - | - | - | +| `query` | string |   | +| `results_from_metadata` | [integer](./integer.md) |   | +| `segments_counted_in_constant_time` | [integer](./integer.md) |   | +| `specialized_for` | string |   | diff --git a/docs/reference/api/SearchApi_1.md b/docs/reference/api/SearchApi_1.md new file mode 100644 index 000000000..6563fc763 --- /dev/null +++ b/docs/reference/api/SearchApi_1.md @@ -0,0 +1,3 @@ +::: +default function SearchApi>(this: [That](./That.md), params?: [SearchRequest](./SearchRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SearchResponse](./SearchResponse.md)>; +::: diff --git a/docs/reference/api/SearchApi_2.md b/docs/reference/api/SearchApi_2.md new file mode 100644 index 000000000..0f0d5aab2 --- /dev/null +++ b/docs/reference/api/SearchApi_2.md @@ -0,0 +1,3 @@ +::: +default function SearchApi>(this: [That](./That.md), params?: [SearchRequest](./SearchRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SearchResponse](./SearchResponse.md), unknown>>; +::: diff --git a/docs/reference/api/SearchApi_3.md b/docs/reference/api/SearchApi_3.md new file mode 100644 index 000000000..58eb62d0e --- /dev/null +++ b/docs/reference/api/SearchApi_3.md @@ -0,0 +1,3 @@ +::: +default function SearchApi>(this: [That](./That.md), params?: [SearchRequest](./SearchRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SearchResponse](./SearchResponse.md)>; +::: diff --git a/docs/reference/api/SearchApplication.md b/docs/reference/api/SearchApplication.md new file mode 100644 index 000000000..6ba363b3b --- /dev/null +++ b/docs/reference/api/SearchApplication.md @@ -0,0 +1,20 @@ +## `SearchApplication` + +### Constructor + +::: +new SearchApplication(transport: [Transport](./Transport.md)); +::: + +### Properties + +| Name | Type | Description | +| - | - | - | +| `acceptedParams` | Record |   | +| `transport` | [Transport](./Transport.md) |   | + +### Methods + +| Name | Signature | Description | +| - | - | - | +| `delete` | `delete(this: [That](./That.md), params: [SearchApplicationDeleteRequest](./SearchApplicationDeleteRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SearchApplicationDeleteResponse](./SearchApplicationDeleteResponse.md)>;` | Delete a search application. Remove a search application and its associated alias. Indices attached to the search application are not removed. || `delete` | `delete(this: [That](./That.md), params: [SearchApplicationDeleteRequest](./SearchApplicationDeleteRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SearchApplicationDeleteResponse](./SearchApplicationDeleteResponse.md), unknown>>;` |   || `delete` | `delete(this: [That](./That.md), params: [SearchApplicationDeleteRequest](./SearchApplicationDeleteRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SearchApplicationDeleteResponse](./SearchApplicationDeleteResponse.md)>;` |   || `deleteBehavioralAnalytics` | `deleteBehavioralAnalytics(this: [That](./That.md), params: [SearchApplicationDeleteBehavioralAnalyticsRequest](./SearchApplicationDeleteBehavioralAnalyticsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SearchApplicationDeleteBehavioralAnalyticsResponse](./SearchApplicationDeleteBehavioralAnalyticsResponse.md)>;` | Delete a behavioral analytics collection. The associated data stream is also deleted. || `deleteBehavioralAnalytics` | `deleteBehavioralAnalytics(this: [That](./That.md), params: [SearchApplicationDeleteBehavioralAnalyticsRequest](./SearchApplicationDeleteBehavioralAnalyticsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SearchApplicationDeleteBehavioralAnalyticsResponse](./SearchApplicationDeleteBehavioralAnalyticsResponse.md), unknown>>;` |   || `deleteBehavioralAnalytics` | `deleteBehavioralAnalytics(this: [That](./That.md), params: [SearchApplicationDeleteBehavioralAnalyticsRequest](./SearchApplicationDeleteBehavioralAnalyticsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SearchApplicationDeleteBehavioralAnalyticsResponse](./SearchApplicationDeleteBehavioralAnalyticsResponse.md)>;` |   || `get` | `get(this: [That](./That.md), params: [SearchApplicationGetRequest](./SearchApplicationGetRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SearchApplicationGetResponse](./SearchApplicationGetResponse.md)>;` | Get search application details. || `get` | `get(this: [That](./That.md), params: [SearchApplicationGetRequest](./SearchApplicationGetRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SearchApplicationGetResponse](./SearchApplicationGetResponse.md), unknown>>;` |   || `get` | `get(this: [That](./That.md), params: [SearchApplicationGetRequest](./SearchApplicationGetRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SearchApplicationGetResponse](./SearchApplicationGetResponse.md)>;` |   || `getBehavioralAnalytics` | `getBehavioralAnalytics(this: [That](./That.md), params?: [SearchApplicationGetBehavioralAnalyticsRequest](./SearchApplicationGetBehavioralAnalyticsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SearchApplicationGetBehavioralAnalyticsResponse](./SearchApplicationGetBehavioralAnalyticsResponse.md)>;` | Get behavioral analytics collections. || `getBehavioralAnalytics` | `getBehavioralAnalytics(this: [That](./That.md), params?: [SearchApplicationGetBehavioralAnalyticsRequest](./SearchApplicationGetBehavioralAnalyticsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SearchApplicationGetBehavioralAnalyticsResponse](./SearchApplicationGetBehavioralAnalyticsResponse.md), unknown>>;` |   || `getBehavioralAnalytics` | `getBehavioralAnalytics(this: [That](./That.md), params?: [SearchApplicationGetBehavioralAnalyticsRequest](./SearchApplicationGetBehavioralAnalyticsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SearchApplicationGetBehavioralAnalyticsResponse](./SearchApplicationGetBehavioralAnalyticsResponse.md)>;` |   || `list` | `list(this: [That](./That.md), params?: [SearchApplicationListRequest](./SearchApplicationListRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SearchApplicationListResponse](./SearchApplicationListResponse.md)>;` | Get search applications. Get information about search applications. || `list` | `list(this: [That](./That.md), params?: [SearchApplicationListRequest](./SearchApplicationListRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SearchApplicationListResponse](./SearchApplicationListResponse.md), unknown>>;` |   || `list` | `list(this: [That](./That.md), params?: [SearchApplicationListRequest](./SearchApplicationListRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SearchApplicationListResponse](./SearchApplicationListResponse.md)>;` |   || `postBehavioralAnalyticsEvent` | `postBehavioralAnalyticsEvent(this: [That](./That.md), params: [SearchApplicationPostBehavioralAnalyticsEventRequest](./SearchApplicationPostBehavioralAnalyticsEventRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SearchApplicationPostBehavioralAnalyticsEventResponse](./SearchApplicationPostBehavioralAnalyticsEventResponse.md)>;` | Create a behavioral analytics collection event. || `postBehavioralAnalyticsEvent` | `postBehavioralAnalyticsEvent(this: [That](./That.md), params: [SearchApplicationPostBehavioralAnalyticsEventRequest](./SearchApplicationPostBehavioralAnalyticsEventRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SearchApplicationPostBehavioralAnalyticsEventResponse](./SearchApplicationPostBehavioralAnalyticsEventResponse.md), unknown>>;` |   || `postBehavioralAnalyticsEvent` | `postBehavioralAnalyticsEvent(this: [That](./That.md), params: [SearchApplicationPostBehavioralAnalyticsEventRequest](./SearchApplicationPostBehavioralAnalyticsEventRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SearchApplicationPostBehavioralAnalyticsEventResponse](./SearchApplicationPostBehavioralAnalyticsEventResponse.md)>;` |   || `put` | `put(this: [That](./That.md), params: [SearchApplicationPutRequest](./SearchApplicationPutRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SearchApplicationPutResponse](./SearchApplicationPutResponse.md)>;` | Create or update a search application. || `put` | `put(this: [That](./That.md), params: [SearchApplicationPutRequest](./SearchApplicationPutRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SearchApplicationPutResponse](./SearchApplicationPutResponse.md), unknown>>;` |   || `put` | `put(this: [That](./That.md), params: [SearchApplicationPutRequest](./SearchApplicationPutRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SearchApplicationPutResponse](./SearchApplicationPutResponse.md)>;` |   || `putBehavioralAnalytics` | `putBehavioralAnalytics(this: [That](./That.md), params: [SearchApplicationPutBehavioralAnalyticsRequest](./SearchApplicationPutBehavioralAnalyticsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SearchApplicationPutBehavioralAnalyticsResponse](./SearchApplicationPutBehavioralAnalyticsResponse.md)>;` | Create a behavioral analytics collection. || `putBehavioralAnalytics` | `putBehavioralAnalytics(this: [That](./That.md), params: [SearchApplicationPutBehavioralAnalyticsRequest](./SearchApplicationPutBehavioralAnalyticsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SearchApplicationPutBehavioralAnalyticsResponse](./SearchApplicationPutBehavioralAnalyticsResponse.md), unknown>>;` |   || `putBehavioralAnalytics` | `putBehavioralAnalytics(this: [That](./That.md), params: [SearchApplicationPutBehavioralAnalyticsRequest](./SearchApplicationPutBehavioralAnalyticsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SearchApplicationPutBehavioralAnalyticsResponse](./SearchApplicationPutBehavioralAnalyticsResponse.md)>;` |   || `renderQuery` | `renderQuery(this: [That](./That.md), params: [SearchApplicationRenderQueryRequest](./SearchApplicationRenderQueryRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SearchApplicationRenderQueryResponse](./SearchApplicationRenderQueryResponse.md)>;` | Render a search application query. Generate an Elasticsearch query using the specified query parameters and the search template associated with the search application or a default template if none is specified. If a parameter used in the search template is not specified in `params`, the parameter's default value will be used. The API returns the specific Elasticsearch query that would be generated and run by calling the search application search API. You must have `read` privileges on the backing alias of the search application. || `renderQuery` | `renderQuery(this: [That](./That.md), params: [SearchApplicationRenderQueryRequest](./SearchApplicationRenderQueryRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SearchApplicationRenderQueryResponse](./SearchApplicationRenderQueryResponse.md), unknown>>;` |   || `renderQuery` | `renderQuery(this: [That](./That.md), params: [SearchApplicationRenderQueryRequest](./SearchApplicationRenderQueryRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SearchApplicationRenderQueryResponse](./SearchApplicationRenderQueryResponse.md)>;` |   || `search` | `search>(this: [That](./That.md), params: [SearchApplicationSearchRequest](./SearchApplicationSearchRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SearchApplicationSearchResponse](./SearchApplicationSearchResponse.md)>;` | Run a search application search. Generate and run an Elasticsearch query that uses the specified query parameteter and the search template associated with the search application or default template. Unspecified template parameters are assigned their default values if applicable. || `search` | `search>(this: [That](./That.md), params: [SearchApplicationSearchRequest](./SearchApplicationSearchRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SearchApplicationSearchResponse](./SearchApplicationSearchResponse.md), unknown>>;` |   || `search` | `search>(this: [That](./That.md), params: [SearchApplicationSearchRequest](./SearchApplicationSearchRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SearchApplicationSearchResponse](./SearchApplicationSearchResponse.md)>;` |   | \ No newline at end of file diff --git a/docs/reference/api/SearchApplicationAnalyticsCollection.md b/docs/reference/api/SearchApplicationAnalyticsCollection.md new file mode 100644 index 000000000..a179b414b --- /dev/null +++ b/docs/reference/api/SearchApplicationAnalyticsCollection.md @@ -0,0 +1,5 @@ +## Interface `SearchApplicationAnalyticsCollection` + +| Name | Type | Description | +| - | - | - | +| `event_data_stream` | [SearchApplicationEventDataStream](./SearchApplicationEventDataStream.md) | Data stream for the collection. | diff --git a/docs/reference/api/SearchApplicationDeleteBehavioralAnalyticsRequest.md b/docs/reference/api/SearchApplicationDeleteBehavioralAnalyticsRequest.md new file mode 100644 index 000000000..db49dccb3 --- /dev/null +++ b/docs/reference/api/SearchApplicationDeleteBehavioralAnalyticsRequest.md @@ -0,0 +1,7 @@ +## Interface `SearchApplicationDeleteBehavioralAnalyticsRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { name?: never; }) | All values in `body` will be added to the request body. | +| `name` | [Name](./Name.md) | The name of the analytics collection to be deleted | +| `querystring` | { [key: string]: any; } & { name?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/SearchApplicationDeleteBehavioralAnalyticsResponse.md b/docs/reference/api/SearchApplicationDeleteBehavioralAnalyticsResponse.md new file mode 100644 index 000000000..073641fb6 --- /dev/null +++ b/docs/reference/api/SearchApplicationDeleteBehavioralAnalyticsResponse.md @@ -0,0 +1,4 @@ +## `SearchApplicationDeleteBehavioralAnalyticsResponse` +::: +type SearchApplicationDeleteBehavioralAnalyticsResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); +::: diff --git a/docs/reference/api/SearchApplicationDeleteRequest.md b/docs/reference/api/SearchApplicationDeleteRequest.md new file mode 100644 index 000000000..3901a49d5 --- /dev/null +++ b/docs/reference/api/SearchApplicationDeleteRequest.md @@ -0,0 +1,7 @@ +## Interface `SearchApplicationDeleteRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { name?: never; }) | All values in `body` will be added to the request body. | +| `name` | [Name](./Name.md) | The name of the search application to delete. | +| `querystring` | { [key: string]: any; } & { name?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/SearchApplicationDeleteResponse.md b/docs/reference/api/SearchApplicationDeleteResponse.md new file mode 100644 index 000000000..406e3255e --- /dev/null +++ b/docs/reference/api/SearchApplicationDeleteResponse.md @@ -0,0 +1,4 @@ +## `SearchApplicationDeleteResponse` +::: +type SearchApplicationDeleteResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); +::: diff --git a/docs/reference/api/SearchApplicationEventDataStream.md b/docs/reference/api/SearchApplicationEventDataStream.md new file mode 100644 index 000000000..e7a0d32a8 --- /dev/null +++ b/docs/reference/api/SearchApplicationEventDataStream.md @@ -0,0 +1,5 @@ +## Interface `SearchApplicationEventDataStream` + +| Name | Type | Description | +| - | - | - | +| `name` | [IndexName](./IndexName.md) |   | diff --git a/docs/reference/api/SearchApplicationEventType.md b/docs/reference/api/SearchApplicationEventType.md new file mode 100644 index 000000000..fca21ffcf --- /dev/null +++ b/docs/reference/api/SearchApplicationEventType.md @@ -0,0 +1,4 @@ +## `SearchApplicationEventType` +::: +type SearchApplicationEventType = 'page_view' | 'search' | 'search_click'; +::: diff --git a/docs/reference/api/SearchApplicationGetBehavioralAnalyticsRequest.md b/docs/reference/api/SearchApplicationGetBehavioralAnalyticsRequest.md new file mode 100644 index 000000000..69db447ac --- /dev/null +++ b/docs/reference/api/SearchApplicationGetBehavioralAnalyticsRequest.md @@ -0,0 +1,7 @@ +## Interface `SearchApplicationGetBehavioralAnalyticsRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { name?: never; }) | All values in `body` will be added to the request body. | +| `name` | [Name](./Name.md)[] | A list of analytics collections to limit the returned information | +| `querystring` | { [key: string]: any; } & { name?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/SearchApplicationGetBehavioralAnalyticsResponse.md b/docs/reference/api/SearchApplicationGetBehavioralAnalyticsResponse.md new file mode 100644 index 000000000..63bbc41f6 --- /dev/null +++ b/docs/reference/api/SearchApplicationGetBehavioralAnalyticsResponse.md @@ -0,0 +1,4 @@ +## `SearchApplicationGetBehavioralAnalyticsResponse` +::: +type SearchApplicationGetBehavioralAnalyticsResponse = Record<[Name](./Name.md), [SearchApplicationAnalyticsCollection](./SearchApplicationAnalyticsCollection.md)>; +::: diff --git a/docs/reference/api/SearchApplicationGetRequest.md b/docs/reference/api/SearchApplicationGetRequest.md new file mode 100644 index 000000000..2face3a9a --- /dev/null +++ b/docs/reference/api/SearchApplicationGetRequest.md @@ -0,0 +1,7 @@ +## Interface `SearchApplicationGetRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { name?: never; }) | All values in `body` will be added to the request body. | +| `name` | [Name](./Name.md) | The name of the search application | +| `querystring` | { [key: string]: any; } & { name?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/SearchApplicationGetResponse.md b/docs/reference/api/SearchApplicationGetResponse.md new file mode 100644 index 000000000..a027c34fa --- /dev/null +++ b/docs/reference/api/SearchApplicationGetResponse.md @@ -0,0 +1,4 @@ +## `SearchApplicationGetResponse` +::: +type SearchApplicationGetResponse = [SearchApplicationSearchApplication](./SearchApplicationSearchApplication.md); +::: diff --git a/docs/reference/api/SearchApplicationListRequest.md b/docs/reference/api/SearchApplicationListRequest.md new file mode 100644 index 000000000..962b25712 --- /dev/null +++ b/docs/reference/api/SearchApplicationListRequest.md @@ -0,0 +1,9 @@ +## Interface `SearchApplicationListRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { q?: never; from?: never; size?: never; }) | All values in `body` will be added to the request body. | +| `from` | [integer](./integer.md) | Starting offset. | +| `q` | string | Query in the Lucene query string syntax. | +| `querystring` | { [key: string]: any; } & { q?: never; from?: never; size?: never; } | All values in `querystring` will be added to the request querystring. | +| `size` | [integer](./integer.md) | Specifies a max number of results to get. | diff --git a/docs/reference/api/SearchApplicationListResponse.md b/docs/reference/api/SearchApplicationListResponse.md new file mode 100644 index 000000000..c91707383 --- /dev/null +++ b/docs/reference/api/SearchApplicationListResponse.md @@ -0,0 +1,6 @@ +## Interface `SearchApplicationListResponse` + +| Name | Type | Description | +| - | - | - | +| `count` | [long](./long.md) |   | +| `results` | [SearchApplicationSearchApplication](./SearchApplicationSearchApplication.md)[] |   | diff --git a/docs/reference/api/SearchApplicationPostBehavioralAnalyticsEventRequest.md b/docs/reference/api/SearchApplicationPostBehavioralAnalyticsEventRequest.md new file mode 100644 index 000000000..ee3ab5012 --- /dev/null +++ b/docs/reference/api/SearchApplicationPostBehavioralAnalyticsEventRequest.md @@ -0,0 +1,10 @@ +## Interface `SearchApplicationPostBehavioralAnalyticsEventRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { collection_name?: never; event_type?: never; debug?: never; payload?: never; }) | All values in `body` will be added to the request body. | +| `collection_name` | [Name](./Name.md) | The name of the behavioral analytics collection. | +| `debug` | boolean | Whether the response type has to include more details | +| `event_type` | [SearchApplicationEventType](./SearchApplicationEventType.md) | The analytics event type. | +| `payload` | any |   | +| `querystring` | { [key: string]: any; } & { collection_name?: never; event_type?: never; debug?: never; payload?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/SearchApplicationPostBehavioralAnalyticsEventResponse.md b/docs/reference/api/SearchApplicationPostBehavioralAnalyticsEventResponse.md new file mode 100644 index 000000000..f37618b66 --- /dev/null +++ b/docs/reference/api/SearchApplicationPostBehavioralAnalyticsEventResponse.md @@ -0,0 +1,6 @@ +## Interface `SearchApplicationPostBehavioralAnalyticsEventResponse` + +| Name | Type | Description | +| - | - | - | +| `accepted` | boolean |   | +| `event` | any |   | diff --git a/docs/reference/api/SearchApplicationPutBehavioralAnalyticsAnalyticsAcknowledgeResponseBase.md b/docs/reference/api/SearchApplicationPutBehavioralAnalyticsAnalyticsAcknowledgeResponseBase.md new file mode 100644 index 000000000..e47aa1db3 --- /dev/null +++ b/docs/reference/api/SearchApplicationPutBehavioralAnalyticsAnalyticsAcknowledgeResponseBase.md @@ -0,0 +1,5 @@ +## Interface `SearchApplicationPutBehavioralAnalyticsAnalyticsAcknowledgeResponseBase` + +| Name | Type | Description | +| - | - | - | +| `name` | [Name](./Name.md) | The name of the analytics collection created or updated | diff --git a/docs/reference/api/SearchApplicationPutBehavioralAnalyticsRequest.md b/docs/reference/api/SearchApplicationPutBehavioralAnalyticsRequest.md new file mode 100644 index 000000000..7da1c0d07 --- /dev/null +++ b/docs/reference/api/SearchApplicationPutBehavioralAnalyticsRequest.md @@ -0,0 +1,7 @@ +## Interface `SearchApplicationPutBehavioralAnalyticsRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { name?: never; }) | All values in `body` will be added to the request body. | +| `name` | [Name](./Name.md) | The name of the analytics collection to be created or updated. | +| `querystring` | { [key: string]: any; } & { name?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/SearchApplicationPutBehavioralAnalyticsResponse.md b/docs/reference/api/SearchApplicationPutBehavioralAnalyticsResponse.md new file mode 100644 index 000000000..2de20d5f4 --- /dev/null +++ b/docs/reference/api/SearchApplicationPutBehavioralAnalyticsResponse.md @@ -0,0 +1,4 @@ +## `SearchApplicationPutBehavioralAnalyticsResponse` +::: +type SearchApplicationPutBehavioralAnalyticsResponse = [SearchApplicationPutBehavioralAnalyticsAnalyticsAcknowledgeResponseBase](./SearchApplicationPutBehavioralAnalyticsAnalyticsAcknowledgeResponseBase.md); +::: diff --git a/docs/reference/api/SearchApplicationPutRequest.md b/docs/reference/api/SearchApplicationPutRequest.md new file mode 100644 index 000000000..a0c6dc280 --- /dev/null +++ b/docs/reference/api/SearchApplicationPutRequest.md @@ -0,0 +1,9 @@ +## Interface `SearchApplicationPutRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { name?: never; create?: never; search_application?: never; }) | All values in `body` will be added to the request body. | +| `create` | boolean | If `true`, this request cannot replace or update existing Search Applications. | +| `name` | [Name](./Name.md) | The name of the search application to be created or updated. | +| `querystring` | { [key: string]: any; } & { name?: never; create?: never; search_application?: never; } | All values in `querystring` will be added to the request querystring. | +| `search_application` | [SearchApplicationSearchApplicationParameters](./SearchApplicationSearchApplicationParameters.md) |   | diff --git a/docs/reference/api/SearchApplicationPutResponse.md b/docs/reference/api/SearchApplicationPutResponse.md new file mode 100644 index 000000000..11346b5e2 --- /dev/null +++ b/docs/reference/api/SearchApplicationPutResponse.md @@ -0,0 +1,5 @@ +## Interface `SearchApplicationPutResponse` + +| Name | Type | Description | +| - | - | - | +| `result` | [Result](./Result.md) |   | diff --git a/docs/reference/api/SearchApplicationRenderQueryRequest.md b/docs/reference/api/SearchApplicationRenderQueryRequest.md new file mode 100644 index 000000000..1490bdb9a --- /dev/null +++ b/docs/reference/api/SearchApplicationRenderQueryRequest.md @@ -0,0 +1,8 @@ +## Interface `SearchApplicationRenderQueryRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { name?: never; params?: never; }) | All values in `body` will be added to the request body. | +| `name` | [Name](./Name.md) | The name of the search application to render teh query for. | +| `params` | Record |   | +| `querystring` | { [key: string]: any; } & { name?: never; params?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/SearchApplicationRenderQueryResponse.md b/docs/reference/api/SearchApplicationRenderQueryResponse.md new file mode 100644 index 000000000..6c0eb2db9 --- /dev/null +++ b/docs/reference/api/SearchApplicationRenderQueryResponse.md @@ -0,0 +1,4 @@ +## Interface `SearchApplicationRenderQueryResponse` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/SearchApplicationSearchApplication.md b/docs/reference/api/SearchApplicationSearchApplication.md new file mode 100644 index 000000000..4beed6edf --- /dev/null +++ b/docs/reference/api/SearchApplicationSearchApplication.md @@ -0,0 +1,6 @@ +## Interface `SearchApplicationSearchApplication` + +| Name | Type | Description | +| - | - | - | +| `name` | [Name](./Name.md) | Search Application name | +| `updated_at_millis` | [EpochTime](./EpochTime.md)<[UnitMillis](./UnitMillis.md)> | Last time the Search Application was updated. | diff --git a/docs/reference/api/SearchApplicationSearchApplicationParameters.md b/docs/reference/api/SearchApplicationSearchApplicationParameters.md new file mode 100644 index 000000000..ae7f4af3c --- /dev/null +++ b/docs/reference/api/SearchApplicationSearchApplicationParameters.md @@ -0,0 +1,7 @@ +## Interface `SearchApplicationSearchApplicationParameters` + +| Name | Type | Description | +| - | - | - | +| `analytics_collection_name` | [Name](./Name.md) | Analytics collection associated to the Search Application. | +| `indices` | [IndexName](./IndexName.md)[] | Indices that are part of the Search Application. | +| `template` | [SearchApplicationSearchApplicationTemplate](./SearchApplicationSearchApplicationTemplate.md) | Search template to use on search operations. | diff --git a/docs/reference/api/SearchApplicationSearchApplicationTemplate.md b/docs/reference/api/SearchApplicationSearchApplicationTemplate.md new file mode 100644 index 000000000..077912f94 --- /dev/null +++ b/docs/reference/api/SearchApplicationSearchApplicationTemplate.md @@ -0,0 +1,5 @@ +## Interface `SearchApplicationSearchApplicationTemplate` + +| Name | Type | Description | +| - | - | - | +| `script` | [Script](./Script.md) | [ScriptSource](./ScriptSource.md) | The associated mustache template. | diff --git a/docs/reference/api/SearchApplicationSearchRequest.md b/docs/reference/api/SearchApplicationSearchRequest.md new file mode 100644 index 000000000..b52c4a506 --- /dev/null +++ b/docs/reference/api/SearchApplicationSearchRequest.md @@ -0,0 +1,9 @@ +## Interface `SearchApplicationSearchRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { name?: never; typed_keys?: never; params?: never; }) | All values in `body` will be added to the request body. | +| `name` | [Name](./Name.md) | The name of the search application to be searched. | +| `params` | Record | Query parameters specific to this request, which will override any defaults specified in the template. | +| `querystring` | { [key: string]: any; } & { name?: never; typed_keys?: never; params?: never; } | All values in `querystring` will be added to the request querystring. | +| `typed_keys` | boolean | Determines whether aggregation names are prefixed by their respective types in the response. | diff --git a/docs/reference/api/SearchApplicationSearchResponse.md b/docs/reference/api/SearchApplicationSearchResponse.md new file mode 100644 index 000000000..a0955c111 --- /dev/null +++ b/docs/reference/api/SearchApplicationSearchResponse.md @@ -0,0 +1,4 @@ +## `SearchApplicationSearchResponse` +::: +type SearchApplicationSearchResponse> = [SearchResponseBody](./SearchResponseBody.md); +::: diff --git a/docs/reference/api/SearchBoundaryScanner.md b/docs/reference/api/SearchBoundaryScanner.md new file mode 100644 index 000000000..d3961052b --- /dev/null +++ b/docs/reference/api/SearchBoundaryScanner.md @@ -0,0 +1,4 @@ +## `SearchBoundaryScanner` +::: +type SearchBoundaryScanner = 'chars' | 'sentence' | 'word'; +::: diff --git a/docs/reference/api/SearchCollector.md b/docs/reference/api/SearchCollector.md new file mode 100644 index 000000000..5907ac8c8 --- /dev/null +++ b/docs/reference/api/SearchCollector.md @@ -0,0 +1,8 @@ +## Interface `SearchCollector` + +| Name | Type | Description | +| - | - | - | +| `children` | [SearchCollector](./SearchCollector.md)[] |   | +| `name` | string |   | +| `reason` | string |   | +| `time_in_nanos` | [DurationValue](./DurationValue.md)<[UnitNanos](./UnitNanos.md)> |   | diff --git a/docs/reference/api/SearchCompletionContext.md b/docs/reference/api/SearchCompletionContext.md new file mode 100644 index 000000000..b2a867d04 --- /dev/null +++ b/docs/reference/api/SearchCompletionContext.md @@ -0,0 +1,9 @@ +## Interface `SearchCompletionContext` + +| Name | Type | Description | +| - | - | - | +| `boost` | [double](./double.md) | The factor by which the score of the suggestion should be boosted. The score is computed by multiplying the boost with the suggestion weight. | +| `context` | [SearchContext](./SearchContext.md) | The value of the category to filter/boost on. | +| `neighbours` | [GeoHashPrecision](./GeoHashPrecision.md)[] | An array of precision values at which neighboring geohashes should be taken into account. Precision value can be a distance value ( `5m`, `10km`, etc.) or a raw geohash precision ( `1`.. `12`). Defaults to generating neighbors for index time precision level. | +| `precision` | [GeoHashPrecision](./GeoHashPrecision.md) | The precision of the geohash to encode the query geo point. Can be specified as a distance value ( `5m`, `10km`, etc.), or as a raw geohash precision ( `1`.. `12`). Defaults to index time precision level. | +| `prefix` | boolean | Whether the category value should be treated as a prefix or not. | diff --git a/docs/reference/api/SearchCompletionSuggest.md b/docs/reference/api/SearchCompletionSuggest.md new file mode 100644 index 000000000..d1ed40e8d --- /dev/null +++ b/docs/reference/api/SearchCompletionSuggest.md @@ -0,0 +1,5 @@ +## Interface `SearchCompletionSuggest` + +| Name | Type | Description | +| - | - | - | +| `options` | [SearchCompletionSuggestOption](./SearchCompletionSuggestOption.md) | [SearchCompletionSuggestOption](./SearchCompletionSuggestOption.md)[] |   | diff --git a/docs/reference/api/SearchCompletionSuggestOption.md b/docs/reference/api/SearchCompletionSuggestOption.md new file mode 100644 index 000000000..4e67fc129 --- /dev/null +++ b/docs/reference/api/SearchCompletionSuggestOption.md @@ -0,0 +1,14 @@ +## Interface `SearchCompletionSuggestOption` + +| Name | Type | Description | +| - | - | - | +| `_id` | string |   | +| `_index` | [IndexName](./IndexName.md) |   | +| `_routing` | [Routing](./Routing.md) |   | +| `_score` | [double](./double.md) |   | +| `_source` | TDocument |   | +| `collate_match` | boolean |   | +| `contexts` | Record |   | +| `fields` | Record |   | +| `score` | [double](./double.md) |   | +| `text` | string |   | diff --git a/docs/reference/api/SearchCompletionSuggester.md b/docs/reference/api/SearchCompletionSuggester.md new file mode 100644 index 000000000..8c20b7050 --- /dev/null +++ b/docs/reference/api/SearchCompletionSuggester.md @@ -0,0 +1,8 @@ +## Interface `SearchCompletionSuggester` + +| Name | Type | Description | +| - | - | - | +| `contexts` | Record<[Field](./Field.md), [SearchCompletionContext](./SearchCompletionContext.md) | [SearchContext](./SearchContext.md) | ([SearchCompletionContext](./SearchCompletionContext.md) | [SearchContext](./SearchContext.md))[]> | A value, geo point object, or a geo hash string to filter or boost the suggestion on. | +| `fuzzy` | [SearchSuggestFuzziness](./SearchSuggestFuzziness.md) | Enables fuzziness, meaning you can have a typo in your search and still get results back. | +| `regex` | [SearchRegexOptions](./SearchRegexOptions.md) | A regex query that expresses a prefix as a regular expression. | +| `skip_duplicates` | boolean | Whether duplicate suggestions should be filtered out. | diff --git a/docs/reference/api/SearchContext.md b/docs/reference/api/SearchContext.md new file mode 100644 index 000000000..80a2a9c08 --- /dev/null +++ b/docs/reference/api/SearchContext.md @@ -0,0 +1,4 @@ +## `SearchContext` +::: +type SearchContext = string | [GeoLocation](./GeoLocation.md); +::: diff --git a/docs/reference/api/SearchDfsKnnProfile.md b/docs/reference/api/SearchDfsKnnProfile.md new file mode 100644 index 000000000..ef0d9ff73 --- /dev/null +++ b/docs/reference/api/SearchDfsKnnProfile.md @@ -0,0 +1,8 @@ +## Interface `SearchDfsKnnProfile` + +| Name | Type | Description | +| - | - | - | +| `collector` | [SearchKnnCollectorResult](./SearchKnnCollectorResult.md)[] |   | +| `query` | [SearchKnnQueryProfileResult](./SearchKnnQueryProfileResult.md)[] |   | +| `rewrite_time` | [long](./long.md) |   | +| `vector_operations_count` | [long](./long.md) |   | diff --git a/docs/reference/api/SearchDfsProfile.md b/docs/reference/api/SearchDfsProfile.md new file mode 100644 index 000000000..8a5f1f028 --- /dev/null +++ b/docs/reference/api/SearchDfsProfile.md @@ -0,0 +1,6 @@ +## Interface `SearchDfsProfile` + +| Name | Type | Description | +| - | - | - | +| `knn` | [SearchDfsKnnProfile](./SearchDfsKnnProfile.md)[] |   | +| `statistics` | [SearchDfsStatisticsProfile](./SearchDfsStatisticsProfile.md) |   | diff --git a/docs/reference/api/SearchDfsStatisticsBreakdown.md b/docs/reference/api/SearchDfsStatisticsBreakdown.md new file mode 100644 index 000000000..9b760cb34 --- /dev/null +++ b/docs/reference/api/SearchDfsStatisticsBreakdown.md @@ -0,0 +1,12 @@ +## Interface `SearchDfsStatisticsBreakdown` + +| Name | Type | Description | +| - | - | - | +| `collection_statistics_count` | [long](./long.md) |   | +| `collection_statistics` | [long](./long.md) |   | +| `create_weight_count` | [long](./long.md) |   | +| `create_weight` | [long](./long.md) |   | +| `rewrite_count` | [long](./long.md) |   | +| `rewrite` | [long](./long.md) |   | +| `term_statistics_count` | [long](./long.md) |   | +| `term_statistics` | [long](./long.md) |   | diff --git a/docs/reference/api/SearchDfsStatisticsProfile.md b/docs/reference/api/SearchDfsStatisticsProfile.md new file mode 100644 index 000000000..d0d6eaa5a --- /dev/null +++ b/docs/reference/api/SearchDfsStatisticsProfile.md @@ -0,0 +1,11 @@ +## Interface `SearchDfsStatisticsProfile` + +| Name | Type | Description | +| - | - | - | +| `breakdown` | [SearchDfsStatisticsBreakdown](./SearchDfsStatisticsBreakdown.md) |   | +| `children` | [SearchDfsStatisticsProfile](./SearchDfsStatisticsProfile.md)[] |   | +| `debug` | Record |   | +| `description` | string |   | +| `time_in_nanos` | [DurationValue](./DurationValue.md)<[UnitNanos](./UnitNanos.md)> |   | +| `time` | [Duration](./Duration.md) |   | +| `type` | string |   | diff --git a/docs/reference/api/SearchDirectGenerator.md b/docs/reference/api/SearchDirectGenerator.md new file mode 100644 index 000000000..f61b37018 --- /dev/null +++ b/docs/reference/api/SearchDirectGenerator.md @@ -0,0 +1,15 @@ +## Interface `SearchDirectGenerator` + +| Name | Type | Description | +| - | - | - | +| `field` | [Field](./Field.md) | The field to fetch the candidate suggestions from. Needs to be set globally or per suggestion. | +| `max_edits` | [integer](./integer.md) | The maximum edit distance candidate suggestions can have in order to be considered as a suggestion. Can only be `1` or `2`. | +| `max_inspections` | [float](./float.md) | A factor that is used to multiply with the shard_size in order to inspect more candidate spelling corrections on the shard level. Can improve accuracy at the cost of performance. | +| `max_term_freq` | [float](./float.md) | The maximum threshold in number of documents in which a suggest text token can exist in order to be included. This can be used to exclude high frequency terms—which are usually spelled correctly—from being spellchecked. Can be a relative percentage number (for example `0.4`) or an absolute number to represent document frequencies. If a value higher than 1 is specified, then fractional can not be specified. | +| `min_doc_freq` | [float](./float.md) | The minimal threshold in number of documents a suggestion should appear in. This can improve quality by only suggesting high frequency terms. Can be specified as an absolute number or as a relative percentage of number of documents. If a value higher than 1 is specified, the number cannot be fractional. | +| `min_word_length` | [integer](./integer.md) | The minimum length a suggest text term must have in order to be included. | +| `post_filter` | string | A filter (analyzer) that is applied to each of the generated tokens before they are passed to the actual phrase scorer. | +| `pre_filter` | string | A filter (analyzer) that is applied to each of the tokens passed to this candidate generator. This filter is applied to the original token before candidates are generated. | +| `prefix_length` | [integer](./integer.md) | The number of minimal prefix characters that must match in order be a candidate suggestions. Increasing this number improves spellcheck performance. | +| `size` | [integer](./integer.md) | The maximum corrections to be returned per suggest text token. | +| `suggest_mode` | [SuggestMode](./SuggestMode.md) | Controls what suggestions are included on the suggestions generated on each shard. | diff --git a/docs/reference/api/SearchFetchProfile.md b/docs/reference/api/SearchFetchProfile.md new file mode 100644 index 000000000..566bd5fdc --- /dev/null +++ b/docs/reference/api/SearchFetchProfile.md @@ -0,0 +1,10 @@ +## Interface `SearchFetchProfile` + +| Name | Type | Description | +| - | - | - | +| `breakdown` | [SearchFetchProfileBreakdown](./SearchFetchProfileBreakdown.md) |   | +| `children` | [SearchFetchProfile](./SearchFetchProfile.md)[] |   | +| `debug` | [SearchFetchProfileDebug](./SearchFetchProfileDebug.md) |   | +| `description` | string |   | +| `time_in_nanos` | [DurationValue](./DurationValue.md)<[UnitNanos](./UnitNanos.md)> |   | +| `type` | string |   | diff --git a/docs/reference/api/SearchFetchProfileBreakdown.md b/docs/reference/api/SearchFetchProfileBreakdown.md new file mode 100644 index 000000000..b906db047 --- /dev/null +++ b/docs/reference/api/SearchFetchProfileBreakdown.md @@ -0,0 +1,12 @@ +## Interface `SearchFetchProfileBreakdown` + +| Name | Type | Description | +| - | - | - | +| `load_source_count` | [integer](./integer.md) |   | +| `load_source` | [integer](./integer.md) |   | +| `load_stored_fields_count` | [integer](./integer.md) |   | +| `load_stored_fields` | [integer](./integer.md) |   | +| `next_reader_count` | [integer](./integer.md) |   | +| `next_reader` | [integer](./integer.md) |   | +| `process_count` | [integer](./integer.md) |   | +| `process` | [integer](./integer.md) |   | diff --git a/docs/reference/api/SearchFetchProfileDebug.md b/docs/reference/api/SearchFetchProfileDebug.md new file mode 100644 index 000000000..03f64e033 --- /dev/null +++ b/docs/reference/api/SearchFetchProfileDebug.md @@ -0,0 +1,6 @@ +## Interface `SearchFetchProfileDebug` + +| Name | Type | Description | +| - | - | - | +| `fast_path` | [integer](./integer.md) |   | +| `stored_fields` | string[] |   | diff --git a/docs/reference/api/SearchFieldCollapse.md b/docs/reference/api/SearchFieldCollapse.md new file mode 100644 index 000000000..d9ee95c16 --- /dev/null +++ b/docs/reference/api/SearchFieldCollapse.md @@ -0,0 +1,8 @@ +## Interface `SearchFieldCollapse` + +| Name | Type | Description | +| - | - | - | +| `collapse` | [SearchFieldCollapse](./SearchFieldCollapse.md) |   | +| `field` | [Field](./Field.md) | The field to collapse the result set on | +| `inner_hits` | [SearchInnerHits](./SearchInnerHits.md) | [SearchInnerHits](./SearchInnerHits.md)[] | The number of inner hits and their sort order | +| `max_concurrent_group_searches` | [integer](./integer.md) | The number of concurrent requests allowed to retrieve the inner_hits per group | diff --git a/docs/reference/api/SearchFieldSuggester.md b/docs/reference/api/SearchFieldSuggester.md new file mode 100644 index 000000000..fe72caf11 --- /dev/null +++ b/docs/reference/api/SearchFieldSuggester.md @@ -0,0 +1,10 @@ +## Interface `SearchFieldSuggester` + +| Name | Type | Description | +| - | - | - | +| `completion` | [SearchCompletionSuggester](./SearchCompletionSuggester.md) | Provides auto-complete/search-as-you-type functionality. | +| `phrase` | [SearchPhraseSuggester](./SearchPhraseSuggester.md) | Provides access to word alternatives on a per token basis within a certain string distance. | +| `prefix` | string | Prefix used to search for suggestions. | +| `regex` | string | A prefix expressed as a regular expression. | +| `term` | [SearchTermSuggester](./SearchTermSuggester.md) | Suggests terms based on edit distance. | +| `text` | string | The text to use as input for the suggester. Needs to be set globally or per suggestion. | diff --git a/docs/reference/api/SearchHighlight.md b/docs/reference/api/SearchHighlight.md new file mode 100644 index 000000000..2f99ee597 --- /dev/null +++ b/docs/reference/api/SearchHighlight.md @@ -0,0 +1,6 @@ +## Interface `SearchHighlight` + +| Name | Type | Description | +| - | - | - | +| `encoder` | [SearchHighlighterEncoder](./SearchHighlighterEncoder.md) |   | +| `fields` | Record<[Field](./Field.md), [SearchHighlightField](./SearchHighlightField.md)> |   | diff --git a/docs/reference/api/SearchHighlightBase.md b/docs/reference/api/SearchHighlightBase.md new file mode 100644 index 000000000..3e22909f8 --- /dev/null +++ b/docs/reference/api/SearchHighlightBase.md @@ -0,0 +1,25 @@ +## Interface `SearchHighlightBase` + +| Name | Type | Description | +| - | - | - | +| `boundary_chars` | string | A string that contains each boundary character. | +| `boundary_max_scan` | [integer](./integer.md) | How far to scan for boundary characters. | +| `boundary_scanner_locale` | string | Controls which locale is used to search for sentence and word boundaries. This parameter takes a form of a language tag, for example: `"en-US"`, `"fr-FR"`, `"ja-JP"`. | +| `boundary_scanner` | [SearchBoundaryScanner](./SearchBoundaryScanner.md) | Specifies how to break the highlighted fragments: chars, sentence, or word. Only valid for the unified and fvh highlighters. Defaults to `sentence` for the `unified` highlighter. Defaults to `chars` for the `fvh` highlighter. | +| `force_source` | boolean |   | +| `fragment_size` | [integer](./integer.md) | The size of the highlighted fragment in characters. | +| `fragmenter` | [SearchHighlighterFragmenter](./SearchHighlighterFragmenter.md) | Specifies how text should be broken up in highlight snippets: `simple` or `span`. Only valid for the `plain` highlighter. | +| `highlight_filter` | boolean |   | +| `highlight_query` | [QueryDslQueryContainer](./QueryDslQueryContainer.md) | Highlight matches for a query other than the search query. This is especially useful if you use a rescore query because those are not taken into account by highlighting by default. | +| `max_analyzed_offset` | [integer](./integer.md) | If set to a non-negative value, highlighting stops at this defined maximum limit. The rest of the text is not processed, thus not highlighted and no error is returned The `max_analyzed_offset` query setting does not override the `index.highlight.max_analyzed_offset` setting, which prevails when it’s set to lower value than the query setting. | +| `max_fragment_length` | [integer](./integer.md) |   | +| `no_match_size` | [integer](./integer.md) | The amount of text you want to return from the beginning of the field if there are no matching fragments to highlight. | +| `number_of_fragments` | [integer](./integer.md) | The maximum number of fragments to return. If the number of fragments is set to `0`, no fragments are returned. Instead, the entire field contents are highlighted and returned. This can be handy when you need to highlight short texts such as a title or address, but fragmentation is not required. If `number_of_fragments` is `0`, `fragment_size` is ignored. | +| `options` | Record |   | +| `order` | [SearchHighlighterOrder](./SearchHighlighterOrder.md) | Sorts highlighted fragments by score when set to `score`. By default, fragments will be output in the order they appear in the field (order: `none`). Setting this option to `score` will output the most relevant fragments first. Each highlighter applies its own logic to compute relevancy scores. | +| `phrase_limit` | [integer](./integer.md) | Controls the number of matching phrases in a document that are considered. Prevents the `fvh` highlighter from analyzing too many phrases and consuming too much memory. When using `matched_fields`, `phrase_limit` phrases per matched field are considered. Raising the limit increases query time and consumes more memory. Only supported by the `fvh` highlighter. | +| `post_tags` | string[] | Use in conjunction with `pre_tags` to define the HTML tags to use for the highlighted text. By default, highlighted text is wrapped in `` and `` tags. | +| `pre_tags` | string[] | Use in conjunction with `post_tags` to define the HTML tags to use for the highlighted text. By default, highlighted text is wrapped in `` and `` tags. | +| `require_field_match` | boolean | By default, only fields that contains a query match are highlighted. Set to `false` to highlight all fields. | +| `tags_schema` | [SearchHighlighterTagsSchema](./SearchHighlighterTagsSchema.md) | Set to `styled` to use the built-in tag schema. | +| `type` | [SearchHighlighterType](./SearchHighlighterType.md) |   | diff --git a/docs/reference/api/SearchHighlightField.md b/docs/reference/api/SearchHighlightField.md new file mode 100644 index 000000000..2025f169a --- /dev/null +++ b/docs/reference/api/SearchHighlightField.md @@ -0,0 +1,6 @@ +## Interface `SearchHighlightField` + +| Name | Type | Description | +| - | - | - | +| `fragment_offset` | [integer](./integer.md) |   | +| `matched_fields` | [Fields](./Fields.md) |   | diff --git a/docs/reference/api/SearchHighlighterEncoder.md b/docs/reference/api/SearchHighlighterEncoder.md new file mode 100644 index 000000000..2a557f9d8 --- /dev/null +++ b/docs/reference/api/SearchHighlighterEncoder.md @@ -0,0 +1,4 @@ +## `SearchHighlighterEncoder` +::: +type SearchHighlighterEncoder = 'default' | 'html'; +::: diff --git a/docs/reference/api/SearchHighlighterFragmenter.md b/docs/reference/api/SearchHighlighterFragmenter.md new file mode 100644 index 000000000..e057a8b05 --- /dev/null +++ b/docs/reference/api/SearchHighlighterFragmenter.md @@ -0,0 +1,4 @@ +## `SearchHighlighterFragmenter` +::: +type SearchHighlighterFragmenter = 'simple' | 'span'; +::: diff --git a/docs/reference/api/SearchHighlighterOrder.md b/docs/reference/api/SearchHighlighterOrder.md new file mode 100644 index 000000000..18d3763be --- /dev/null +++ b/docs/reference/api/SearchHighlighterOrder.md @@ -0,0 +1,4 @@ +## `SearchHighlighterOrder` +::: +type SearchHighlighterOrder = 'score'; +::: diff --git a/docs/reference/api/SearchHighlighterTagsSchema.md b/docs/reference/api/SearchHighlighterTagsSchema.md new file mode 100644 index 000000000..e7fae6291 --- /dev/null +++ b/docs/reference/api/SearchHighlighterTagsSchema.md @@ -0,0 +1,4 @@ +## `SearchHighlighterTagsSchema` +::: +type SearchHighlighterTagsSchema = 'styled'; +::: diff --git a/docs/reference/api/SearchHighlighterType.md b/docs/reference/api/SearchHighlighterType.md new file mode 100644 index 000000000..0b6885cfd --- /dev/null +++ b/docs/reference/api/SearchHighlighterType.md @@ -0,0 +1,4 @@ +## `SearchHighlighterType` +::: +type SearchHighlighterType = 'plain' | 'fvh' | 'unified' | string; +::: diff --git a/docs/reference/api/SearchHit.md b/docs/reference/api/SearchHit.md new file mode 100644 index 000000000..9b5c00601 --- /dev/null +++ b/docs/reference/api/SearchHit.md @@ -0,0 +1,24 @@ +## Interface `SearchHit` + +| Name | Type | Description | +| - | - | - | +| `_explanation` | [ExplainExplanation](./ExplainExplanation.md) |   | +| `_id` | [Id](./Id.md) |   | +| `_ignored` | string[] |   | +| `_index` | [IndexName](./IndexName.md) |   | +| `_nested` | [SearchNestedIdentity](./SearchNestedIdentity.md) |   | +| `_node` | string |   | +| `_primary_term` | [long](./long.md) |   | +| `_rank` | [integer](./integer.md) |   | +| `_routing` | string |   | +| `_score` | [double](./double.md) | null |   | +| `_seq_no` | [SequenceNumber](./SequenceNumber.md) |   | +| `_shard` | string |   | +| `_source` | TDocument |   | +| `_version` | [VersionNumber](./VersionNumber.md) |   | +| `fields` | Record |   | +| `highlight` | Record |   | +| `ignored_field_values` | Record |   | +| `inner_hits` | Record |   | +| `matched_queries` | string[] | Record |   | +| `sort` | [SortResults](./SortResults.md) |   | diff --git a/docs/reference/api/SearchHitsMetadata.md b/docs/reference/api/SearchHitsMetadata.md new file mode 100644 index 000000000..a2cdbd975 --- /dev/null +++ b/docs/reference/api/SearchHitsMetadata.md @@ -0,0 +1,7 @@ +## Interface `SearchHitsMetadata` + +| Name | Type | Description | +| - | - | - | +| `hits` | [SearchHit](./SearchHit.md)[] |   | +| `max_score` | [double](./double.md) | null |   | +| `total` | [SearchTotalHits](./SearchTotalHits.md) | [long](./long.md) | Total hit count information, present only if `track_total_hits` wasn't `false` in the search request. | diff --git a/docs/reference/api/SearchInnerHits.md b/docs/reference/api/SearchInnerHits.md new file mode 100644 index 000000000..eb3f206a0 --- /dev/null +++ b/docs/reference/api/SearchInnerHits.md @@ -0,0 +1,20 @@ +## Interface `SearchInnerHits` + +| Name | Type | Description | +| - | - | - | +| `_source` | [SearchSourceConfig](./SearchSourceConfig.md) |   | +| `collapse` | [SearchFieldCollapse](./SearchFieldCollapse.md) |   | +| `docvalue_fields` | ([QueryDslFieldAndFormat](./QueryDslFieldAndFormat.md) | [Field](./Field.md))[] |   | +| `explain` | boolean |   | +| `fields` | [Field](./Field.md)[] |   | +| `from` | [integer](./integer.md) | Inner hit starting document offset. | +| `highlight` | [SearchHighlight](./SearchHighlight.md) |   | +| `ignore_unmapped` | boolean |   | +| `name` | [Name](./Name.md) | The name for the particular inner hit definition in the response. Useful when a search request contains multiple inner hits. | +| `script_fields` | Record<[Field](./Field.md), [ScriptField](./ScriptField.md)> |   | +| `seq_no_primary_term` | boolean |   | +| `size` | [integer](./integer.md) | The maximum number of hits to return per `inner_hits`. | +| `sort` | [Sort](./Sort.md) | How the inner hits should be sorted per `inner_hits`. By default, inner hits are sorted by score. | +| `stored_fields` | [Fields](./Fields.md) |   | +| `track_scores` | boolean |   | +| `version` | boolean |   | diff --git a/docs/reference/api/SearchInnerHitsResult.md b/docs/reference/api/SearchInnerHitsResult.md new file mode 100644 index 000000000..99a421f91 --- /dev/null +++ b/docs/reference/api/SearchInnerHitsResult.md @@ -0,0 +1,5 @@ +## Interface `SearchInnerHitsResult` + +| Name | Type | Description | +| - | - | - | +| `hits` | [SearchHitsMetadata](./SearchHitsMetadata.md) |   | diff --git a/docs/reference/api/SearchKnnCollectorResult.md b/docs/reference/api/SearchKnnCollectorResult.md new file mode 100644 index 000000000..0f994f64b --- /dev/null +++ b/docs/reference/api/SearchKnnCollectorResult.md @@ -0,0 +1,9 @@ +## Interface `SearchKnnCollectorResult` + +| Name | Type | Description | +| - | - | - | +| `children` | [SearchKnnCollectorResult](./SearchKnnCollectorResult.md)[] |   | +| `name` | string |   | +| `reason` | string |   | +| `time_in_nanos` | [DurationValue](./DurationValue.md)<[UnitNanos](./UnitNanos.md)> |   | +| `time` | [Duration](./Duration.md) |   | diff --git a/docs/reference/api/SearchKnnQueryProfileBreakdown.md b/docs/reference/api/SearchKnnQueryProfileBreakdown.md new file mode 100644 index 000000000..b744c4d5b --- /dev/null +++ b/docs/reference/api/SearchKnnQueryProfileBreakdown.md @@ -0,0 +1,24 @@ +## Interface `SearchKnnQueryProfileBreakdown` + +| Name | Type | Description | +| - | - | - | +| `advance_count` | [long](./long.md) |   | +| `advance` | [long](./long.md) |   | +| `build_scorer_count` | [long](./long.md) |   | +| `build_scorer` | [long](./long.md) |   | +| `compute_max_score_count` | [long](./long.md) |   | +| `compute_max_score` | [long](./long.md) |   | +| `count_weight_count` | [long](./long.md) |   | +| `count_weight` | [long](./long.md) |   | +| `create_weight_count` | [long](./long.md) |   | +| `create_weight` | [long](./long.md) |   | +| `match_count` | [long](./long.md) |   | +| `match` | [long](./long.md) |   | +| `next_doc_count` | [long](./long.md) |   | +| `next_doc` | [long](./long.md) |   | +| `score_count` | [long](./long.md) |   | +| `score` | [long](./long.md) |   | +| `set_min_competitive_score_count` | [long](./long.md) |   | +| `set_min_competitive_score` | [long](./long.md) |   | +| `shallow_advance_count` | [long](./long.md) |   | +| `shallow_advance` | [long](./long.md) |   | diff --git a/docs/reference/api/SearchKnnQueryProfileResult.md b/docs/reference/api/SearchKnnQueryProfileResult.md new file mode 100644 index 000000000..365e62fcd --- /dev/null +++ b/docs/reference/api/SearchKnnQueryProfileResult.md @@ -0,0 +1,11 @@ +## Interface `SearchKnnQueryProfileResult` + +| Name | Type | Description | +| - | - | - | +| `breakdown` | [SearchKnnQueryProfileBreakdown](./SearchKnnQueryProfileBreakdown.md) |   | +| `children` | [SearchKnnQueryProfileResult](./SearchKnnQueryProfileResult.md)[] |   | +| `debug` | Record |   | +| `description` | string |   | +| `time_in_nanos` | [DurationValue](./DurationValue.md)<[UnitNanos](./UnitNanos.md)> |   | +| `time` | [Duration](./Duration.md) |   | +| `type` | string |   | diff --git a/docs/reference/api/SearchLaplaceSmoothingModel.md b/docs/reference/api/SearchLaplaceSmoothingModel.md new file mode 100644 index 000000000..176435fec --- /dev/null +++ b/docs/reference/api/SearchLaplaceSmoothingModel.md @@ -0,0 +1,5 @@ +## Interface `SearchLaplaceSmoothingModel` + +| Name | Type | Description | +| - | - | - | +| `alpha` | [double](./double.md) | A constant that is added to all counts to balance weights. | diff --git a/docs/reference/api/SearchLearningToRank.md b/docs/reference/api/SearchLearningToRank.md new file mode 100644 index 000000000..a5a486f5e --- /dev/null +++ b/docs/reference/api/SearchLearningToRank.md @@ -0,0 +1,6 @@ +## Interface `SearchLearningToRank` + +| Name | Type | Description | +| - | - | - | +| `model_id` | string | The unique identifier of the trained model uploaded to Elasticsearch | +| `params` | Record | Named parameters to be passed to the query templates used for feature | diff --git a/docs/reference/api/SearchLinearInterpolationSmoothingModel.md b/docs/reference/api/SearchLinearInterpolationSmoothingModel.md new file mode 100644 index 000000000..1674b3f60 --- /dev/null +++ b/docs/reference/api/SearchLinearInterpolationSmoothingModel.md @@ -0,0 +1,7 @@ +## Interface `SearchLinearInterpolationSmoothingModel` + +| Name | Type | Description | +| - | - | - | +| `bigram_lambda` | [double](./double.md) |   | +| `trigram_lambda` | [double](./double.md) |   | +| `unigram_lambda` | [double](./double.md) |   | diff --git a/docs/reference/api/SearchMvtApi_1.md b/docs/reference/api/SearchMvtApi_1.md new file mode 100644 index 000000000..d2ea4aa85 --- /dev/null +++ b/docs/reference/api/SearchMvtApi_1.md @@ -0,0 +1,3 @@ +::: +default function SearchMvtApi(this: [That](./That.md), params: [SearchMvtRequest](./SearchMvtRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SearchMvtResponse](./SearchMvtResponse.md)>; +::: diff --git a/docs/reference/api/SearchMvtApi_2.md b/docs/reference/api/SearchMvtApi_2.md new file mode 100644 index 000000000..b43b09176 --- /dev/null +++ b/docs/reference/api/SearchMvtApi_2.md @@ -0,0 +1,3 @@ +::: +default function SearchMvtApi(this: [That](./That.md), params: [SearchMvtRequest](./SearchMvtRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SearchMvtResponse](./SearchMvtResponse.md), unknown>>; +::: diff --git a/docs/reference/api/SearchMvtApi_3.md b/docs/reference/api/SearchMvtApi_3.md new file mode 100644 index 000000000..5b2a13449 --- /dev/null +++ b/docs/reference/api/SearchMvtApi_3.md @@ -0,0 +1,3 @@ +::: +default function SearchMvtApi(this: [That](./That.md), params: [SearchMvtRequest](./SearchMvtRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SearchMvtResponse](./SearchMvtResponse.md)>; +::: diff --git a/docs/reference/api/SearchMvtCoordinate.md b/docs/reference/api/SearchMvtCoordinate.md new file mode 100644 index 000000000..04e667dd9 --- /dev/null +++ b/docs/reference/api/SearchMvtCoordinate.md @@ -0,0 +1,4 @@ +## `SearchMvtCoordinate` +::: +type SearchMvtCoordinate = [integer](./integer.md); +::: diff --git a/docs/reference/api/SearchMvtGridAggregationType.md b/docs/reference/api/SearchMvtGridAggregationType.md new file mode 100644 index 000000000..590210f37 --- /dev/null +++ b/docs/reference/api/SearchMvtGridAggregationType.md @@ -0,0 +1,4 @@ +## `SearchMvtGridAggregationType` +::: +type SearchMvtGridAggregationType = 'geotile' | 'geohex'; +::: diff --git a/docs/reference/api/SearchMvtGridType.md b/docs/reference/api/SearchMvtGridType.md new file mode 100644 index 000000000..2617eb738 --- /dev/null +++ b/docs/reference/api/SearchMvtGridType.md @@ -0,0 +1,4 @@ +## `SearchMvtGridType` +::: +type SearchMvtGridType = 'grid' | 'point' | 'centroid'; +::: diff --git a/docs/reference/api/SearchMvtRequest.md b/docs/reference/api/SearchMvtRequest.md new file mode 100644 index 000000000..1654c4b3c --- /dev/null +++ b/docs/reference/api/SearchMvtRequest.md @@ -0,0 +1,25 @@ +## Interface `SearchMvtRequest` + +| Name | Type | Description | +| - | - | - | +| `aggs` | Record | Sub-aggregations for the geotile_grid. It supports the following aggregation types: - `avg` - `boxplot` - `cardinality` - `extended stats` - `max` - `median absolute deviation` - `min` - `percentile` - `percentile-rank` - `stats` - `sum` - `value count`The aggregation names can't start with `_mvt_`. The `_mvt_` prefix is reserved for internal aggregations. | +| `body` | string | ({ [key: string]: any; } & { index?: never; field?: never; zoom?: never; x?: never; y?: never; aggs?: never; buffer?: never; exact_bounds?: never; extent?: never; fields?: never; grid_agg?: never; grid_precision?: never; grid_type?: never; query?: never; runtime_mappings?: never; size?: never; sort?: never; track_total_hits?: never; with_labels?: never; }) | All values in `body` will be added to the request body. | +| `buffer` | [integer](./integer.md) | The size, in pixels, of a clipping buffer outside the tile. This allows renderers to avoid outline artifacts from geometries that extend past the extent of the tile. | +| `exact_bounds` | boolean | If `false`, the meta layer's feature is the bounding box of the tile. If `true`, the meta layer's feature is a bounding box resulting from a `geo_bounds` aggregation. The aggregation runs on values that intersect the `//` tile with `wrap_longitude` set to `false`. The resulting bounding box may be larger than the vector tile. | +| `extent` | [integer](./integer.md) | The size, in pixels, of a side of the tile. Vector tiles are square with equal sides. | +| `field` | [Field](./Field.md) | Field containing geospatial data to return | +| `fields` | [Fields](./Fields.md) | The fields to return in the `hits` layer. It supports wildcards ( `*`). This parameter does not support fields with array values. Fields with array values may return inconsistent results. | +| `grid_agg` | [SearchMvtGridAggregationType](./SearchMvtGridAggregationType.md) | The aggregation used to create a grid for the `field`. | +| `grid_precision` | [integer](./integer.md) | Additional zoom levels available through the aggs layer. For example, if `` is `7` and `grid_precision` is `8`, you can zoom in up to level 15. Accepts 0-8. If 0, results don't include the aggs layer. | +| `grid_type` | [SearchMvtGridType](./SearchMvtGridType.md) | Determines the geometry type for features in the aggs layer. In the aggs layer, each feature represents a `geotile_grid` cell. If `grid, each feature is a polygon of the cells bounding box. If `point ` , each feature is a Point that is the centroid of the cell. | +| `index` | [Indices](./Indices.md) | Comma-separated list of data streams, indices, or aliases to search | +| `query` | [QueryDslQueryContainer](./QueryDslQueryContainer.md) | The query DSL used to filter documents for the search. | +| `querystring` | { [key: string]: any; } & { index?: never; field?: never; zoom?: never; x?: never; y?: never; aggs?: never; buffer?: never; exact_bounds?: never; extent?: never; fields?: never; grid_agg?: never; grid_precision?: never; grid_type?: never; query?: never; runtime_mappings?: never; size?: never; sort?: never; track_total_hits?: never; with_labels?: never; } | All values in `querystring` will be added to the request querystring. | +| `runtime_mappings` | [MappingRuntimeFields](./MappingRuntimeFields.md) | Defines one or more runtime fields in the search request. These fields take precedence over mapped fields with the same name. | +| `size` | [integer](./integer.md) | The maximum number of features to return in the hits layer. Accepts 0-10000. If 0, results don't include the hits layer. | +| `sort` | [Sort](./Sort.md) | Sort the features in the hits layer. By default, the API calculates a bounding box for each feature. It sorts features based on this box's diagonal length, from longest to shortest. | +| `track_total_hits` | [SearchTrackHits](./SearchTrackHits.md) | The number of hits matching the query to count accurately. If `true`, the exact number of hits is returned at the cost of some performance. If `false`, the response does not include the total number of hits matching the query. | +| `with_labels` | boolean | If `true`, the hits and aggs layers will contain additional point features representing suggested label positions for the original features. * `Point` and `MultiPoint` features will have one of the points selected. * `Polygon` and `MultiPolygon` features will have a single point generated, either the centroid, if it is within the polygon, or another point within the polygon selected from the sorted triangle-tree. * `LineString` features will likewise provide a roughly central point selected from the triangle-tree. * The aggregation results will provide one central point for each aggregation bucket. All attributes from the original features will also be copied to the new label features. In addition, the new features will be distinguishable using the tag `_mvt_label_position`. | +| `x` | [SearchMvtCoordinate](./SearchMvtCoordinate.md) | X coordinate for the vector tile to search | +| `y` | [SearchMvtCoordinate](./SearchMvtCoordinate.md) | Y coordinate for the vector tile to search | +| `zoom` | [SearchMvtZoomLevel](./SearchMvtZoomLevel.md) | Zoom level for the vector tile to search | diff --git a/docs/reference/api/SearchMvtResponse.md b/docs/reference/api/SearchMvtResponse.md new file mode 100644 index 000000000..c3006f472 --- /dev/null +++ b/docs/reference/api/SearchMvtResponse.md @@ -0,0 +1,4 @@ +## `SearchMvtResponse` +::: +type SearchMvtResponse = [MapboxVectorTiles](./MapboxVectorTiles.md); +::: diff --git a/docs/reference/api/SearchMvtZoomLevel.md b/docs/reference/api/SearchMvtZoomLevel.md new file mode 100644 index 000000000..5abdd344e --- /dev/null +++ b/docs/reference/api/SearchMvtZoomLevel.md @@ -0,0 +1,4 @@ +## `SearchMvtZoomLevel` +::: +type SearchMvtZoomLevel = [integer](./integer.md); +::: diff --git a/docs/reference/api/SearchNestedIdentity.md b/docs/reference/api/SearchNestedIdentity.md new file mode 100644 index 000000000..9c9eb82b7 --- /dev/null +++ b/docs/reference/api/SearchNestedIdentity.md @@ -0,0 +1,7 @@ +## Interface `SearchNestedIdentity` + +| Name | Type | Description | +| - | - | - | +| `_nested` | [SearchNestedIdentity](./SearchNestedIdentity.md) |   | +| `field` | [Field](./Field.md) |   | +| `offset` | [integer](./integer.md) |   | diff --git a/docs/reference/api/SearchPhraseSuggest.md b/docs/reference/api/SearchPhraseSuggest.md new file mode 100644 index 000000000..faba96edb --- /dev/null +++ b/docs/reference/api/SearchPhraseSuggest.md @@ -0,0 +1,5 @@ +## Interface `SearchPhraseSuggest` + +| Name | Type | Description | +| - | - | - | +| `options` | [SearchPhraseSuggestOption](./SearchPhraseSuggestOption.md) | [SearchPhraseSuggestOption](./SearchPhraseSuggestOption.md)[] |   | diff --git a/docs/reference/api/SearchPhraseSuggestCollate.md b/docs/reference/api/SearchPhraseSuggestCollate.md new file mode 100644 index 000000000..a04f5ca53 --- /dev/null +++ b/docs/reference/api/SearchPhraseSuggestCollate.md @@ -0,0 +1,7 @@ +## Interface `SearchPhraseSuggestCollate` + +| Name | Type | Description | +| - | - | - | +| `params` | Record | Parameters to use if the query is templated. | +| `prune` | boolean | Returns all suggestions with an extra `collate_match` option indicating whether the generated phrase matched any document. | +| `query` | [SearchPhraseSuggestCollateQuery](./SearchPhraseSuggestCollateQuery.md) | A collate query that is run once for every suggestion. | diff --git a/docs/reference/api/SearchPhraseSuggestCollateQuery.md b/docs/reference/api/SearchPhraseSuggestCollateQuery.md new file mode 100644 index 000000000..20ef58bb6 --- /dev/null +++ b/docs/reference/api/SearchPhraseSuggestCollateQuery.md @@ -0,0 +1,6 @@ +## Interface `SearchPhraseSuggestCollateQuery` + +| Name | Type | Description | +| - | - | - | +| `id` | [Id](./Id.md) | The search template ID. | +| `source` | [ScriptSource](./ScriptSource.md) | The query source. | diff --git a/docs/reference/api/SearchPhraseSuggestHighlight.md b/docs/reference/api/SearchPhraseSuggestHighlight.md new file mode 100644 index 000000000..0cf6b0ce0 --- /dev/null +++ b/docs/reference/api/SearchPhraseSuggestHighlight.md @@ -0,0 +1,6 @@ +## Interface `SearchPhraseSuggestHighlight` + +| Name | Type | Description | +| - | - | - | +| `post_tag` | string | Use in conjunction with `pre_tag` to define the HTML tags to use for the highlighted text. | +| `pre_tag` | string | Use in conjunction with `post_tag` to define the HTML tags to use for the highlighted text. | diff --git a/docs/reference/api/SearchPhraseSuggestOption.md b/docs/reference/api/SearchPhraseSuggestOption.md new file mode 100644 index 000000000..e97e2e93d --- /dev/null +++ b/docs/reference/api/SearchPhraseSuggestOption.md @@ -0,0 +1,8 @@ +## Interface `SearchPhraseSuggestOption` + +| Name | Type | Description | +| - | - | - | +| `collate_match` | boolean |   | +| `highlighted` | string |   | +| `score` | [double](./double.md) |   | +| `text` | string |   | diff --git a/docs/reference/api/SearchPhraseSuggester.md b/docs/reference/api/SearchPhraseSuggester.md new file mode 100644 index 000000000..1b1e8acd8 --- /dev/null +++ b/docs/reference/api/SearchPhraseSuggester.md @@ -0,0 +1,17 @@ +## Interface `SearchPhraseSuggester` + +| Name | Type | Description | +| - | - | - | +| `collate` | [SearchPhraseSuggestCollate](./SearchPhraseSuggestCollate.md) | Checks each suggestion against the specified query to prune suggestions for which no matching docs exist in the index. | +| `confidence` | [double](./double.md) | Defines a factor applied to the input phrases score, which is used as a threshold for other suggest candidates. Only candidates that score higher than the threshold will be included in the result. | +| `direct_generator` | [SearchDirectGenerator](./SearchDirectGenerator.md)[] | A list of candidate generators that produce a list of possible terms per term in the given text. | +| `force_unigrams` | boolean |   | +| `gram_size` | [integer](./integer.md) | Sets max size of the n-grams (shingles) in the field. If the field doesn’t contain n-grams (shingles), this should be omitted or set to `1`. If the field uses a shingle filter, the `gram_size` is set to the `max_shingle_size` if not explicitly set. | +| `highlight` | [SearchPhraseSuggestHighlight](./SearchPhraseSuggestHighlight.md) | Sets up suggestion highlighting. If not provided, no highlighted field is returned. | +| `max_errors` | [double](./double.md) | The maximum percentage of the terms considered to be misspellings in order to form a correction. This method accepts a float value in the range `[0..1)` as a fraction of the actual query terms or a number `>=1` as an absolute number of query terms. | +| `real_word_error_likelihood` | [double](./double.md) | The likelihood of a term being misspelled even if the term exists in the dictionary. | +| `separator` | string | The separator that is used to separate terms in the bigram field. If not set, the whitespace character is used as a separator. | +| `shard_size` | [integer](./integer.md) | Sets the maximum number of suggested terms to be retrieved from each individual shard. | +| `smoothing` | [SearchSmoothingModelContainer](./SearchSmoothingModelContainer.md) | The smoothing model used to balance weight between infrequent grams (grams (shingles) are not existing in the index) and frequent grams (appear at least once in the index). The default model is Stupid Backoff. | +| `text` | string | The text/query to provide suggestions for. | +| `token_limit` | [integer](./integer.md) |   | diff --git a/docs/reference/api/SearchPointInTimeReference.md b/docs/reference/api/SearchPointInTimeReference.md new file mode 100644 index 000000000..58a09aa8a --- /dev/null +++ b/docs/reference/api/SearchPointInTimeReference.md @@ -0,0 +1,6 @@ +## Interface `SearchPointInTimeReference` + +| Name | Type | Description | +| - | - | - | +| `id` | [Id](./Id.md) |   | +| `keep_alive` | [Duration](./Duration.md) |   | diff --git a/docs/reference/api/SearchProfile.md b/docs/reference/api/SearchProfile.md new file mode 100644 index 000000000..57b0ead08 --- /dev/null +++ b/docs/reference/api/SearchProfile.md @@ -0,0 +1,5 @@ +## Interface `SearchProfile` + +| Name | Type | Description | +| - | - | - | +| `shards` | [SearchShardProfile](./SearchShardProfile.md)[] |   | diff --git a/docs/reference/api/SearchQueryBreakdown.md b/docs/reference/api/SearchQueryBreakdown.md new file mode 100644 index 000000000..21f6ca939 --- /dev/null +++ b/docs/reference/api/SearchQueryBreakdown.md @@ -0,0 +1,24 @@ +## Interface `SearchQueryBreakdown` + +| Name | Type | Description | +| - | - | - | +| `advance_count` | [long](./long.md) |   | +| `advance` | [long](./long.md) |   | +| `build_scorer_count` | [long](./long.md) |   | +| `build_scorer` | [long](./long.md) |   | +| `compute_max_score_count` | [long](./long.md) |   | +| `compute_max_score` | [long](./long.md) |   | +| `count_weight_count` | [long](./long.md) |   | +| `count_weight` | [long](./long.md) |   | +| `create_weight_count` | [long](./long.md) |   | +| `create_weight` | [long](./long.md) |   | +| `match_count` | [long](./long.md) |   | +| `match` | [long](./long.md) |   | +| `next_doc_count` | [long](./long.md) |   | +| `next_doc` | [long](./long.md) |   | +| `score_count` | [long](./long.md) |   | +| `score` | [long](./long.md) |   | +| `set_min_competitive_score_count` | [long](./long.md) |   | +| `set_min_competitive_score` | [long](./long.md) |   | +| `shallow_advance_count` | [long](./long.md) |   | +| `shallow_advance` | [long](./long.md) |   | diff --git a/docs/reference/api/SearchQueryProfile.md b/docs/reference/api/SearchQueryProfile.md new file mode 100644 index 000000000..aef98ab21 --- /dev/null +++ b/docs/reference/api/SearchQueryProfile.md @@ -0,0 +1,9 @@ +## Interface `SearchQueryProfile` + +| Name | Type | Description | +| - | - | - | +| `breakdown` | [SearchQueryBreakdown](./SearchQueryBreakdown.md) |   | +| `children` | [SearchQueryProfile](./SearchQueryProfile.md)[] |   | +| `description` | string |   | +| `time_in_nanos` | [DurationValue](./DurationValue.md)<[UnitNanos](./UnitNanos.md)> |   | +| `type` | string |   | diff --git a/docs/reference/api/SearchRegexOptions.md b/docs/reference/api/SearchRegexOptions.md new file mode 100644 index 000000000..64b2679fe --- /dev/null +++ b/docs/reference/api/SearchRegexOptions.md @@ -0,0 +1,6 @@ +## Interface `SearchRegexOptions` + +| Name | Type | Description | +| - | - | - | +| `flags` | [integer](./integer.md) | string | Optional operators for the regular expression. | +| `max_determinized_states` | [integer](./integer.md) | Maximum number of automaton states required for the query. | diff --git a/docs/reference/api/SearchRequest.md b/docs/reference/api/SearchRequest.md new file mode 100644 index 000000000..a1bff6a29 --- /dev/null +++ b/docs/reference/api/SearchRequest.md @@ -0,0 +1,72 @@ +## Interface `SearchRequest` + +| Name | Type | Description | +| - | - | - | +| `_source_excludes` | [Fields](./Fields.md) | A comma-separated list of source fields to exclude from the response. You can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter. If the `_source` parameter is `false`, this parameter is ignored. | +| `_source_includes` | [Fields](./Fields.md) | A comma-separated list of source fields to include in the response. If this parameter is specified, only these source fields are returned. You can exclude fields from this subset using the `_source_excludes` query parameter. If the `_source` parameter is `false`, this parameter is ignored. | +| `_source` | [SearchSourceConfig](./SearchSourceConfig.md) | The source fields that are returned for matching documents. These fields are returned in the `hits._source` property of the search response. If the `stored_fields` property is specified, the `_source` property defaults to `false`. Otherwise, it defaults to `true`. | +| `aggregations` | Record | Defines the aggregations that are run as part of the search request. | +| `aggs` | Record | Defines the aggregations that are run as part of the search request. aggregations | +| `allow_no_indices` | boolean | If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. | +| `allow_partial_search_results` | boolean | If `true` and there are shard request timeouts or shard failures, the request returns partial results. If `false`, it returns an error with no partial results. To override the default behavior, you can set the `search.default_allow_partial_results` cluster setting to `false`. | +| `analyze_wildcard` | boolean | If `true`, wildcard and prefix queries are analyzed. This parameter can be used only when the `q` query string parameter is specified. | +| `analyzer` | string | The analyzer to use for the query string. This parameter can be used only when the `q` query string parameter is specified. | +| `batched_reduce_size` | [long](./long.md) | The number of shard results that should be reduced at once on the coordinating node. If the potential number of shards in the request can be large, this value should be used as a protection mechanism to reduce the memory overhead per search request. | +| `body` | string | ({ [key: string]: any; } & { index?: never; allow_no_indices?: never; allow_partial_search_results?: never; analyzer?: never; analyze_wildcard?: never; batched_reduce_size?: never; ccs_minimize_roundtrips?: never; default_operator?: never; df?: never; expand_wildcards?: never; ignore_throttled?: never; ignore_unavailable?: never; include_named_queries_score?: never; lenient?: never; max_concurrent_shard_requests?: never; preference?: never; pre_filter_shard_size?: never; request_cache?: never; routing?: never; scroll?: never; search_type?: never; suggest_field?: never; suggest_mode?: never; suggest_size?: never; suggest_text?: never; typed_keys?: never; rest_total_hits_as_int?: never; _source_excludes?: never; _source_includes?: never; q?: never; force_synthetic_source?: never; aggregations?: never; aggs?: never; collapse?: never; explain?: never; ext?: never; from?: never; highlight?: never; track_total_hits?: never; indices_boost?: never; docvalue_fields?: never; knn?: never; rank?: never; min_score?: never; post_filter?: never; profile?: never; query?: never; rescore?: never; retriever?: never; script_fields?: never; search_after?: never; size?: never; slice?: never; sort?: never; _source?: never; fields?: never; suggest?: never; terminate_after?: never; timeout?: never; track_scores?: never; version?: never; seq_no_primary_term?: never; stored_fields?: never; pit?: never; runtime_mappings?: never; stats?: never; }) | All values in `body` will be added to the request body. | +| `ccs_minimize_roundtrips` | boolean | If `true`, network round-trips between the coordinating node and the remote clusters are minimized when running cross-cluster search (CCS) requests. | +| `collapse` | [SearchFieldCollapse](./SearchFieldCollapse.md) | Collapses search results the values of the specified field. | +| `default_operator` | [QueryDslOperator](./QueryDslOperator.md) | The default operator for the query string query: `AND` or `OR`. This parameter can be used only when the `q` query string parameter is specified. | +| `df` | string | The field to use as a default when no field prefix is given in the query string. This parameter can be used only when the `q` query string parameter is specified. | +| `docvalue_fields` | ([QueryDslFieldAndFormat](./QueryDslFieldAndFormat.md) | [Field](./Field.md))[] | An array of wildcard ( `*`) field patterns. The request returns doc values for field names matching these patterns in the `hits.fields` property of the response. | +| `expand_wildcards` | [ExpandWildcards](./ExpandWildcards.md) | The type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. It supports comma-separated values such as `open,hidden`. | +| `explain` | boolean | If `true`, the request returns detailed information about score computation as part of a hit. | +| `ext` | Record | Configuration of search extensions defined by Elasticsearch plugins. | +| `fields` | ([QueryDslFieldAndFormat](./QueryDslFieldAndFormat.md) | [Field](./Field.md))[] | An array of wildcard ( `*`) field patterns. The request returns values for field names matching these patterns in the `hits.fields` property of the response. | +| `force_synthetic_source` | boolean | Should this request force synthetic _source? Use this to test if the mapping supports synthetic _source and to get a sense of the worst case performance. Fetches with this enabled will be slower the enabling synthetic source natively in the index. | +| `from` | [integer](./integer.md) | The starting document offset, which must be non-negative. By default, you cannot page through more than 10,000 hits using the `from` and `size` parameters. To page through more hits, use the `search_after` parameter. | +| `highlight` | [SearchHighlight](./SearchHighlight.md) | Specifies the highlighter to use for retrieving highlighted snippets from one or more fields in your search results. | +| `ignore_throttled` | boolean | If `true`, concrete, expanded or aliased indices will be ignored when frozen. | +| `ignore_unavailable` | boolean | If `false`, the request returns an error if it targets a missing or closed index. | +| `include_named_queries_score` | boolean | If `true`, the response includes the score contribution from any named queries. This functionality reruns each named query on every hit in a search response. Typically, this adds a small overhead to a request. However, using computationally expensive named queries on a large number of hits may add significant overhead. | +| `index` | [Indices](./Indices.md) | A comma-separated list of data streams, indices, and aliases to search. It supports wildcards ( `*`). To search all data streams and indices, omit this parameter or use `*` or `_all`. | +| `indices_boost` | [Partial](./Partial.md)>[] | Boost the `_score` of documents from specified indices. The boost value is the factor by which scores are multiplied. A boost value greater than `1.0` increases the score. A boost value between `0` and `1.0` decreases the score. | +| `knn` | [KnnSearch](./KnnSearch.md) | [KnnSearch](./KnnSearch.md)[] | The approximate kNN search to run. | +| `lenient` | boolean | If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. This parameter can be used only when the `q` query string parameter is specified. | +| `max_concurrent_shard_requests` | [integer](./integer.md) | The number of concurrent shard requests per node that the search runs concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests. | +| `min_score` | [double](./double.md) | The minimum `_score` for matching documents. Documents with a lower `_score` are not included in search results and results collected by aggregations. | +| `pit` | [SearchPointInTimeReference](./SearchPointInTimeReference.md) | Limit the search to a point in time (PIT). If you provide a PIT, you cannot specify an `` in the request path. | +| `post_filter` | [QueryDslQueryContainer](./QueryDslQueryContainer.md) | Use the `post_filter` parameter to filter search results. The search hits are filtered after the aggregations are calculated. A post filter has no impact on the aggregation results. | +| `pre_filter_shard_size` | [long](./long.md) | A threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method (if date filters are mandatory to match but the shard bounds and the query are disjoint). When unspecified, the pre-filter phase is executed if any of these conditions is met: * The request targets more than 128 shards. * The request targets one or more read-only index. * The primary sort of the query targets an indexed field. | +| `preference` | string | The nodes and shards used for the search. By default, Elasticsearch selects from eligible nodes and shards using adaptive replica selection, accounting for allocation awareness. Valid values are: * `_only_local` to run the search only on shards on the local node. * `_local` to, if possible, run the search on shards on the local node, or if not, select shards using the default method. * `_only_nodes:,` to run the search on only the specified nodes IDs. If suitable shards exist on more than one selected node, use shards on those nodes using the default method. If none of the specified nodes are available, select shards from any available node using the default method. * `_prefer_nodes:,` to if possible, run the search on the specified nodes IDs. If not, select shards using the default method. * `_shards:,` to run the search only on the specified shards. You can combine this value with other `preference` values. However, the `_shards` value must come first. For example: `_shards:2,3|_local`. * `` (any string that does not start with `_`) to route searches with the same `` to the same shards in the same order. | +| `profile` | boolean | Set to `true` to return detailed timing information about the execution of individual components in a search request. NOTE: This is a debugging tool and adds significant overhead to search execution. | +| `q` | string | A query in the Lucene query string syntax. Query parameter searches do not support the full Elasticsearch Query DSL but are handy for testing. IMPORTANT: This parameter overrides the query parameter in the request body. If both parameters are specified, documents matching the query request body parameter are not returned. | +| `query` | [QueryDslQueryContainer](./QueryDslQueryContainer.md) | The search definition using the Query DSL. | +| `querystring` | { [key: string]: any; } & { index?: never; allow_no_indices?: never; allow_partial_search_results?: never; analyzer?: never; analyze_wildcard?: never; batched_reduce_size?: never; ccs_minimize_roundtrips?: never; default_operator?: never; df?: never; expand_wildcards?: never; ignore_throttled?: never; ignore_unavailable?: never; include_named_queries_score?: never; lenient?: never; max_concurrent_shard_requests?: never; preference?: never; pre_filter_shard_size?: never; request_cache?: never; routing?: never; scroll?: never; search_type?: never; suggest_field?: never; suggest_mode?: never; suggest_size?: never; suggest_text?: never; typed_keys?: never; rest_total_hits_as_int?: never; _source_excludes?: never; _source_includes?: never; q?: never; force_synthetic_source?: never; aggregations?: never; aggs?: never; collapse?: never; explain?: never; ext?: never; from?: never; highlight?: never; track_total_hits?: never; indices_boost?: never; docvalue_fields?: never; knn?: never; rank?: never; min_score?: never; post_filter?: never; profile?: never; query?: never; rescore?: never; retriever?: never; script_fields?: never; search_after?: never; size?: never; slice?: never; sort?: never; _source?: never; fields?: never; suggest?: never; terminate_after?: never; timeout?: never; track_scores?: never; version?: never; seq_no_primary_term?: never; stored_fields?: never; pit?: never; runtime_mappings?: never; stats?: never; } | All values in `querystring` will be added to the request querystring. | +| `rank` | [RankContainer](./RankContainer.md) | The Reciprocal Rank Fusion (RRF) to use. | +| `request_cache` | boolean | If `true`, the caching of search results is enabled for requests where `size` is `0`. It defaults to index level settings. | +| `rescore` | [SearchRescore](./SearchRescore.md) | [SearchRescore](./SearchRescore.md)[] | Can be used to improve precision by reordering just the top (for example 100 - 500) documents returned by the `query` and `post_filter` phases. | +| `rest_total_hits_as_int` | boolean | Indicates whether `hits.total` should be rendered as an integer or an object in the rest search response. | +| `retriever` | [RetrieverContainer](./RetrieverContainer.md) | A retriever is a specification to describe top documents returned from a search. A retriever replaces other elements of the search API that also return top documents such as `query` and `knn`. | +| `routing` | [Routing](./Routing.md) | A custom value that is used to route operations to a specific shard. | +| `runtime_mappings` | [MappingRuntimeFields](./MappingRuntimeFields.md) | One or more runtime fields in the search request. These fields take precedence over mapped fields with the same name. | +| `script_fields` | Record | Retrieve a script evaluation (based on different fields) for each hit. | +| `scroll` | [Duration](./Duration.md) | The period to retain the search context for scrolling. By default, this value cannot exceed `1d` (24 hours). You can change this limit by using the `search.max_keep_alive` cluster-level setting. | +| `search_after` | [SortResults](./SortResults.md) | Used to retrieve the next page of hits using a set of sort values from the previous page. | +| `search_type` | [SearchType](./SearchType.md) | Indicates how distributed term frequencies are calculated for relevance scoring. | +| `seq_no_primary_term` | boolean | If `true`, the request returns sequence number and primary term of the last modification of each hit. | +| `size` | [integer](./integer.md) | The number of hits to return, which must not be negative. By default, you cannot page through more than 10,000 hits using the `from` and `size` parameters. To page through more hits, use the `search_after` property. | +| `slice` | [SlicedScroll](./SlicedScroll.md) | Split a scrolled search into multiple slices that can be consumed independently. | +| `sort` | [Sort](./Sort.md) | A comma-separated list of : pairs. | +| `stats` | string[] | The stats groups to associate with the search. Each group maintains a statistics aggregation for its associated searches. You can retrieve these stats using the indices stats API. | +| `stored_fields` | [Fields](./Fields.md) | A comma-separated list of stored fields to return as part of a hit. If no fields are specified, no stored fields are included in the response. If this field is specified, the `_source` property defaults to `false`. You can pass `_source: true` to return both source fields and stored fields in the search response. | +| `suggest_field` | [Field](./Field.md) | The field to use for suggestions. | +| `suggest_mode` | [SuggestMode](./SuggestMode.md) | The suggest mode. This parameter can be used only when the `suggest_field` and `suggest_text` query string parameters are specified. | +| `suggest_size` | [long](./long.md) | The number of suggestions to return. This parameter can be used only when the `suggest_field` and `suggest_text` query string parameters are specified. | +| `suggest_text` | string | The source text for which the suggestions should be returned. This parameter can be used only when the `suggest_field` and `suggest_text` query string parameters are specified. | +| `suggest` | [SearchSuggester](./SearchSuggester.md) | Defines a suggester that provides similar looking terms based on a provided text. | +| `terminate_after` | [long](./long.md) | The maximum number of documents to collect for each shard. If a query reaches this limit, Elasticsearch terminates the query early. Elasticsearch collects documents before sorting. IMPORTANT: Use with caution. Elasticsearch applies this property to each shard handling the request. When possible, let Elasticsearch perform early termination automatically. Avoid specifying this property for requests that target data streams with backing indices across multiple data tiers. If set to `0` (default), the query does not terminate early. | +| `timeout` | string | The period of time to wait for a response from each shard. If no response is received before the timeout expires, the request fails and returns an error. Defaults to no timeout. | +| `track_scores` | boolean | If `true`, calculate and return document scores, even if the scores are not used for sorting. | +| `track_total_hits` | [SearchTrackHits](./SearchTrackHits.md) | Number of hits matching the query to count accurately. If `true`, the exact number of hits is returned at the cost of some performance. If `false`, the response does not include the total number of hits matching the query. | +| `typed_keys` | boolean | If `true`, aggregation and suggester names are be prefixed by their respective types in the response. | +| `version` | boolean | If `true`, the request returns the document version as part of a hit. | diff --git a/docs/reference/api/SearchRescore.md b/docs/reference/api/SearchRescore.md new file mode 100644 index 000000000..79958f7d4 --- /dev/null +++ b/docs/reference/api/SearchRescore.md @@ -0,0 +1,7 @@ +## Interface `SearchRescore` + +| Name | Type | Description | +| - | - | - | +| `learning_to_rank` | [SearchLearningToRank](./SearchLearningToRank.md) |   | +| `query` | [SearchRescoreQuery](./SearchRescoreQuery.md) |   | +| `window_size` | [integer](./integer.md) |   | diff --git a/docs/reference/api/SearchRescoreQuery.md b/docs/reference/api/SearchRescoreQuery.md new file mode 100644 index 000000000..21a432c85 --- /dev/null +++ b/docs/reference/api/SearchRescoreQuery.md @@ -0,0 +1,8 @@ +## Interface `SearchRescoreQuery` + +| Name | Type | Description | +| - | - | - | +| `query_weight` | [double](./double.md) | Relative importance of the original query versus the rescore query. | +| `rescore_query_weight` | [double](./double.md) | Relative importance of the rescore query versus the original query. | +| `rescore_query` | [QueryDslQueryContainer](./QueryDslQueryContainer.md) | The query to use for rescoring. This query is only run on the Top-K results returned by the `query` and `post_filter` phases. | +| `score_mode` | [SearchScoreMode](./SearchScoreMode.md) | Determines how scores are combined. | diff --git a/docs/reference/api/SearchResponse.md b/docs/reference/api/SearchResponse.md new file mode 100644 index 000000000..b74eb9d23 --- /dev/null +++ b/docs/reference/api/SearchResponse.md @@ -0,0 +1,4 @@ +## `SearchResponse` +::: +type SearchResponse> = [SearchResponseBody](./SearchResponseBody.md); +::: diff --git a/docs/reference/api/SearchResponseBody.md b/docs/reference/api/SearchResponseBody.md new file mode 100644 index 000000000..761008a78 --- /dev/null +++ b/docs/reference/api/SearchResponseBody.md @@ -0,0 +1,18 @@ +## Interface `SearchResponseBody` + +| Name | Type | Description | +| - | - | - | +| `_clusters` | [ClusterStatistics](./ClusterStatistics.md) |   | +| `_scroll_id` | [ScrollId](./ScrollId.md) | The identifier for the search and its search context. You can use this scroll ID with the scroll API to retrieve the next batch of search results for the request. This property is returned only if the `scroll` query parameter is specified in the request. | +| `_shards` | [ShardStatistics](./ShardStatistics.md) | A count of shards used for the request. | +| `aggregations` | TAggregations |   | +| `fields` | Record |   | +| `hits` | [SearchHitsMetadata](./SearchHitsMetadata.md) | The returned documents and metadata. | +| `max_score` | [double](./double.md) |   | +| `num_reduce_phases` | [long](./long.md) |   | +| `pit_id` | [Id](./Id.md) |   | +| `profile` | [SearchProfile](./SearchProfile.md) |   | +| `suggest` | Record<[SuggestionName](./SuggestionName.md), [SearchSuggest](./SearchSuggest.md)[]> |   | +| `terminated_early` | boolean |   | +| `timed_out` | boolean | If `true`, the request timed out before completion; returned results may be partial or empty. | +| `took` | [long](./long.md) | The number of milliseconds it took Elasticsearch to run the request. This value is calculated by measuring the time elapsed between receipt of a request on the coordinating node and the time at which the coordinating node is ready to send the response. It includes: * Communication time between the coordinating node and data nodes * Time the request spends in the search thread pool, queued for execution * Actual run time It does not include: * Time needed to send the request to Elasticsearch * Time needed to serialize the JSON response * Time needed to send the response to a client | diff --git a/docs/reference/api/SearchScoreMode.md b/docs/reference/api/SearchScoreMode.md new file mode 100644 index 000000000..5c55101ca --- /dev/null +++ b/docs/reference/api/SearchScoreMode.md @@ -0,0 +1,4 @@ +## `SearchScoreMode` +::: +type SearchScoreMode = 'avg' | 'max' | 'min' | 'multiply' | 'total'; +::: diff --git a/docs/reference/api/SearchSearchProfile.md b/docs/reference/api/SearchSearchProfile.md new file mode 100644 index 000000000..67f3e717d --- /dev/null +++ b/docs/reference/api/SearchSearchProfile.md @@ -0,0 +1,7 @@ +## Interface `SearchSearchProfile` + +| Name | Type | Description | +| - | - | - | +| `collector` | [SearchCollector](./SearchCollector.md)[] |   | +| `query` | [SearchQueryProfile](./SearchQueryProfile.md)[] |   | +| `rewrite_time` | [long](./long.md) |   | diff --git a/docs/reference/api/SearchSearchRequestBody.md b/docs/reference/api/SearchSearchRequestBody.md new file mode 100644 index 000000000..2c9256658 --- /dev/null +++ b/docs/reference/api/SearchSearchRequestBody.md @@ -0,0 +1,39 @@ +## Interface `SearchSearchRequestBody` + +| Name | Type | Description | +| - | - | - | +| `_source` | [SearchSourceConfig](./SearchSourceConfig.md) | The source fields that are returned for matching documents. These fields are returned in the `hits._source` property of the search response. If the `stored_fields` property is specified, the `_source` property defaults to `false`. Otherwise, it defaults to `true`. | +| `aggregations` | Record | Defines the aggregations that are run as part of the search request. | +| `aggs` | Record | Defines the aggregations that are run as part of the search request. aggregations | +| `collapse` | [SearchFieldCollapse](./SearchFieldCollapse.md) | Collapses search results the values of the specified field. | +| `docvalue_fields` | ([QueryDslFieldAndFormat](./QueryDslFieldAndFormat.md) | [Field](./Field.md))[] | An array of wildcard ( `*`) field patterns. The request returns doc values for field names matching these patterns in the `hits.fields` property of the response. | +| `explain` | boolean | If `true`, the request returns detailed information about score computation as part of a hit. | +| `ext` | Record | Configuration of search extensions defined by Elasticsearch plugins. | +| `fields` | ([QueryDslFieldAndFormat](./QueryDslFieldAndFormat.md) | [Field](./Field.md))[] | An array of wildcard ( `*`) field patterns. The request returns values for field names matching these patterns in the `hits.fields` property of the response. | +| `from` | [integer](./integer.md) | The starting document offset, which must be non-negative. By default, you cannot page through more than 10,000 hits using the `from` and `size` parameters. To page through more hits, use the `search_after` parameter. | +| `highlight` | [SearchHighlight](./SearchHighlight.md) | Specifies the highlighter to use for retrieving highlighted snippets from one or more fields in your search results. | +| `indices_boost` | [Partial](./Partial.md)>[] | Boost the `_score` of documents from specified indices. The boost value is the factor by which scores are multiplied. A boost value greater than `1.0` increases the score. A boost value between `0` and `1.0` decreases the score. | +| `knn` | [KnnSearch](./KnnSearch.md) | [KnnSearch](./KnnSearch.md)[] | The approximate kNN search to run. | +| `min_score` | [double](./double.md) | The minimum `_score` for matching documents. Documents with a lower `_score` are not included in search results or results collected by aggregations. | +| `pit` | [SearchPointInTimeReference](./SearchPointInTimeReference.md) | Limit the search to a point in time (PIT). If you provide a PIT, you cannot specify an `` in the request path. | +| `post_filter` | [QueryDslQueryContainer](./QueryDslQueryContainer.md) | Use the `post_filter` parameter to filter search results. The search hits are filtered after the aggregations are calculated. A post filter has no impact on the aggregation results. | +| `profile` | boolean | Set to `true` to return detailed timing information about the execution of individual components in a search request. NOTE: This is a debugging tool and adds significant overhead to search execution. | +| `query` | [QueryDslQueryContainer](./QueryDslQueryContainer.md) | The search definition using the Query DSL. | +| `rank` | [RankContainer](./RankContainer.md) | The Reciprocal Rank Fusion (RRF) to use. | +| `rescore` | [SearchRescore](./SearchRescore.md) | [SearchRescore](./SearchRescore.md)[] | Can be used to improve precision by reordering just the top (for example 100 - 500) documents returned by the `query` and `post_filter` phases. | +| `retriever` | [RetrieverContainer](./RetrieverContainer.md) | A retriever is a specification to describe top documents returned from a search. A retriever replaces other elements of the search API that also return top documents such as `query` and `knn`. | +| `runtime_mappings` | [MappingRuntimeFields](./MappingRuntimeFields.md) | One or more runtime fields in the search request. These fields take precedence over mapped fields with the same name. | +| `script_fields` | Record | Retrieve a script evaluation (based on different fields) for each hit. | +| `search_after` | [SortResults](./SortResults.md) | Used to retrieve the next page of hits using a set of sort values from the previous page. | +| `seq_no_primary_term` | boolean | If `true`, the request returns sequence number and primary term of the last modification of each hit. | +| `size` | [integer](./integer.md) | The number of hits to return, which must not be negative. By default, you cannot page through more than 10,000 hits using the `from` and `size` parameters. To page through more hits, use the `search_after` property. | +| `slice` | [SlicedScroll](./SlicedScroll.md) | Split a scrolled search into multiple slices that can be consumed independently. | +| `sort` | [Sort](./Sort.md) | A comma-separated list of : pairs. | +| `stats` | string[] | The stats groups to associate with the search. Each group maintains a statistics aggregation for its associated searches. You can retrieve these stats using the indices stats API. | +| `stored_fields` | [Fields](./Fields.md) | A comma-separated list of stored fields to return as part of a hit. If no fields are specified, no stored fields are included in the response. If this field is specified, the `_source` property defaults to `false`. You can pass `_source: true` to return both source fields and stored fields in the search response. | +| `suggest` | [SearchSuggester](./SearchSuggester.md) | Defines a suggester that provides similar looking terms based on a provided text. | +| `terminate_after` | [long](./long.md) | The maximum number of documents to collect for each shard. If a query reaches this limit, Elasticsearch terminates the query early. Elasticsearch collects documents before sorting. IMPORTANT: Use with caution. Elasticsearch applies this property to each shard handling the request. When possible, let Elasticsearch perform early termination automatically. Avoid specifying this property for requests that target data streams with backing indices across multiple data tiers. If set to `0` (default), the query does not terminate early. | +| `timeout` | string | The period of time to wait for a response from each shard. If no response is received before the timeout expires, the request fails and returns an error. Defaults to no timeout. | +| `track_scores` | boolean | If `true`, calculate and return document scores, even if the scores are not used for sorting. | +| `track_total_hits` | [SearchTrackHits](./SearchTrackHits.md) | Number of hits matching the query to count accurately. If `true`, the exact number of hits is returned at the cost of some performance. If `false`, the response does not include the total number of hits matching the query. | +| `version` | boolean | If `true`, the request returns the document version as part of a hit. | diff --git a/docs/reference/api/SearchShardProfile.md b/docs/reference/api/SearchShardProfile.md new file mode 100644 index 000000000..a62b2de9b --- /dev/null +++ b/docs/reference/api/SearchShardProfile.md @@ -0,0 +1,13 @@ +## Interface `SearchShardProfile` + +| Name | Type | Description | +| - | - | - | +| `aggregations` | [SearchAggregationProfile](./SearchAggregationProfile.md)[] |   | +| `cluster` | string |   | +| `dfs` | [SearchDfsProfile](./SearchDfsProfile.md) |   | +| `fetch` | [SearchFetchProfile](./SearchFetchProfile.md) |   | +| `id` | string |   | +| `index` | [IndexName](./IndexName.md) |   | +| `node_id` | [NodeId](./NodeId.md) |   | +| `searches` | [SearchSearchProfile](./SearchSearchProfile.md)[] |   | +| `shard_id` | [long](./long.md) |   | diff --git a/docs/reference/api/SearchShardsApi_1.md b/docs/reference/api/SearchShardsApi_1.md new file mode 100644 index 000000000..c1e98d543 --- /dev/null +++ b/docs/reference/api/SearchShardsApi_1.md @@ -0,0 +1,3 @@ +::: +default function SearchShardsApi(this: [That](./That.md), params?: [SearchShardsRequest](./SearchShardsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SearchShardsResponse](./SearchShardsResponse.md)>; +::: diff --git a/docs/reference/api/SearchShardsApi_2.md b/docs/reference/api/SearchShardsApi_2.md new file mode 100644 index 000000000..5aeb01bc1 --- /dev/null +++ b/docs/reference/api/SearchShardsApi_2.md @@ -0,0 +1,3 @@ +::: +default function SearchShardsApi(this: [That](./That.md), params?: [SearchShardsRequest](./SearchShardsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SearchShardsResponse](./SearchShardsResponse.md), unknown>>; +::: diff --git a/docs/reference/api/SearchShardsApi_3.md b/docs/reference/api/SearchShardsApi_3.md new file mode 100644 index 000000000..484493ae5 --- /dev/null +++ b/docs/reference/api/SearchShardsApi_3.md @@ -0,0 +1,3 @@ +::: +default function SearchShardsApi(this: [That](./That.md), params?: [SearchShardsRequest](./SearchShardsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SearchShardsResponse](./SearchShardsResponse.md)>; +::: diff --git a/docs/reference/api/SearchShardsRequest.md b/docs/reference/api/SearchShardsRequest.md new file mode 100644 index 000000000..36d92ba4f --- /dev/null +++ b/docs/reference/api/SearchShardsRequest.md @@ -0,0 +1,14 @@ +## Interface `SearchShardsRequest` + +| Name | Type | Description | +| - | - | - | +| `allow_no_indices` | boolean | If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. | +| `body` | string | ({ [key: string]: any; } & { index?: never; allow_no_indices?: never; expand_wildcards?: never; ignore_unavailable?: never; local?: never; master_timeout?: never; preference?: never; routing?: never; }) | All values in `body` will be added to the request body. | +| `expand_wildcards` | [ExpandWildcards](./ExpandWildcards.md) | Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. | +| `ignore_unavailable` | boolean | If `false`, the request returns an error if it targets a missing or closed index. | +| `index` | [Indices](./Indices.md) | A comma-separated list of data streams, indices, and aliases to search. It supports wildcards ( `*`). To search all data streams and indices, omit this parameter or use `*` or `_all`. | +| `local` | boolean | If `true`, the request retrieves information from the local node only. | +| `master_timeout` | [Duration](./Duration.md) | The period to wait for a connection to the master node. If the master node is not available before the timeout expires, the request fails and returns an error. IT can also be set to `-1` to indicate that the request should never timeout. | +| `preference` | string | The node or shard the operation should be performed on. It is random by default. | +| `querystring` | { [key: string]: any; } & { index?: never; allow_no_indices?: never; expand_wildcards?: never; ignore_unavailable?: never; local?: never; master_timeout?: never; preference?: never; routing?: never; } | All values in `querystring` will be added to the request querystring. | +| `routing` | [Routing](./Routing.md) | A custom value used to route operations to a specific shard. | diff --git a/docs/reference/api/SearchShardsResponse.md b/docs/reference/api/SearchShardsResponse.md new file mode 100644 index 000000000..2b04b7783 --- /dev/null +++ b/docs/reference/api/SearchShardsResponse.md @@ -0,0 +1,7 @@ +## Interface `SearchShardsResponse` + +| Name | Type | Description | +| - | - | - | +| `indices` | Record<[IndexName](./IndexName.md), [SearchShardsShardStoreIndex](./SearchShardsShardStoreIndex.md)> |   | +| `nodes` | Record<[NodeId](./NodeId.md), [SearchShardsSearchShardsNodeAttributes](./SearchShardsSearchShardsNodeAttributes.md)> |   | +| `shards` | [NodeShard](./NodeShard.md)[][] |   | diff --git a/docs/reference/api/SearchShardsSearchShardsNodeAttributes.md b/docs/reference/api/SearchShardsSearchShardsNodeAttributes.md new file mode 100644 index 000000000..1ebb96085 --- /dev/null +++ b/docs/reference/api/SearchShardsSearchShardsNodeAttributes.md @@ -0,0 +1,13 @@ +## Interface `SearchShardsSearchShardsNodeAttributes` + +| Name | Type | Description | +| - | - | - | +| `attributes` | Record | Lists node attributes. | +| `ephemeral_id` | [Id](./Id.md) | The ephemeral ID of the node. | +| `external_id` | string |   | +| `max_index_version` | [integer](./integer.md) |   | +| `min_index_version` | [integer](./integer.md) |   | +| `name` | [NodeName](./NodeName.md) | The human-readable identifier of the node. | +| `roles` | [NodeRoles](./NodeRoles.md) |   | +| `transport_address` | [TransportAddress](./TransportAddress.md) | The host and port where transport HTTP connections are accepted. | +| `version` | [VersionString](./VersionString.md) |   | diff --git a/docs/reference/api/SearchShardsShardStoreIndex.md b/docs/reference/api/SearchShardsShardStoreIndex.md new file mode 100644 index 000000000..5f2b20c7f --- /dev/null +++ b/docs/reference/api/SearchShardsShardStoreIndex.md @@ -0,0 +1,6 @@ +## Interface `SearchShardsShardStoreIndex` + +| Name | Type | Description | +| - | - | - | +| `aliases` | [Name](./Name.md)[] |   | +| `filter` | [QueryDslQueryContainer](./QueryDslQueryContainer.md) |   | diff --git a/docs/reference/api/SearchSmoothingModelContainer.md b/docs/reference/api/SearchSmoothingModelContainer.md new file mode 100644 index 000000000..f9ef44bdc --- /dev/null +++ b/docs/reference/api/SearchSmoothingModelContainer.md @@ -0,0 +1,7 @@ +## Interface `SearchSmoothingModelContainer` + +| Name | Type | Description | +| - | - | - | +| `laplace` | [SearchLaplaceSmoothingModel](./SearchLaplaceSmoothingModel.md) | A smoothing model that uses an additive smoothing where a constant (typically `1.0` or smaller) is added to all counts to balance weights. | +| `linear_interpolation` | [SearchLinearInterpolationSmoothingModel](./SearchLinearInterpolationSmoothingModel.md) | A smoothing model that takes the weighted mean of the unigrams, bigrams, and trigrams based on user supplied weights (lambdas). | +| `stupid_backoff` | [SearchStupidBackoffSmoothingModel](./SearchStupidBackoffSmoothingModel.md) | A simple backoff model that backs off to lower order n-gram models if the higher order count is `0` and discounts the lower order n-gram model by a constant factor. | diff --git a/docs/reference/api/SearchSourceConfig.md b/docs/reference/api/SearchSourceConfig.md new file mode 100644 index 000000000..dc0d543bf --- /dev/null +++ b/docs/reference/api/SearchSourceConfig.md @@ -0,0 +1,4 @@ +## `SearchSourceConfig` +::: +type SearchSourceConfig = boolean | [SearchSourceFilter](./SearchSourceFilter.md) | [Fields](./Fields.md); +::: diff --git a/docs/reference/api/SearchSourceConfigParam.md b/docs/reference/api/SearchSourceConfigParam.md new file mode 100644 index 000000000..f467be8be --- /dev/null +++ b/docs/reference/api/SearchSourceConfigParam.md @@ -0,0 +1,4 @@ +## `SearchSourceConfigParam` +::: +type SearchSourceConfigParam = boolean | [Fields](./Fields.md); +::: diff --git a/docs/reference/api/SearchSourceFilter.md b/docs/reference/api/SearchSourceFilter.md new file mode 100644 index 000000000..1f879977f --- /dev/null +++ b/docs/reference/api/SearchSourceFilter.md @@ -0,0 +1,8 @@ +## Interface `SearchSourceFilter` + +| Name | Type | Description | +| - | - | - | +| `exclude` | [Fields](./Fields.md) | excludes | +| `excludes` | [Fields](./Fields.md) |   | +| `include` | [Fields](./Fields.md) | includes | +| `includes` | [Fields](./Fields.md) |   | diff --git a/docs/reference/api/SearchStats.md b/docs/reference/api/SearchStats.md new file mode 100644 index 000000000..b59063170 --- /dev/null +++ b/docs/reference/api/SearchStats.md @@ -0,0 +1,22 @@ +## Interface `SearchStats` + +| Name | Type | Description | +| - | - | - | +| `fetch_current` | [long](./long.md) |   | +| `fetch_time_in_millis` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> |   | +| `fetch_time` | [Duration](./Duration.md) |   | +| `fetch_total` | [long](./long.md) |   | +| `groups` | Record |   | +| `open_contexts` | [long](./long.md) |   | +| `query_current` | [long](./long.md) |   | +| `query_time_in_millis` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> |   | +| `query_time` | [Duration](./Duration.md) |   | +| `query_total` | [long](./long.md) |   | +| `scroll_current` | [long](./long.md) |   | +| `scroll_time_in_millis` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> |   | +| `scroll_time` | [Duration](./Duration.md) |   | +| `scroll_total` | [long](./long.md) |   | +| `suggest_current` | [long](./long.md) |   | +| `suggest_time_in_millis` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> |   | +| `suggest_time` | [Duration](./Duration.md) |   | +| `suggest_total` | [long](./long.md) |   | diff --git a/docs/reference/api/SearchStringDistance.md b/docs/reference/api/SearchStringDistance.md new file mode 100644 index 000000000..1beddce54 --- /dev/null +++ b/docs/reference/api/SearchStringDistance.md @@ -0,0 +1,4 @@ +## `SearchStringDistance` +::: +type SearchStringDistance = 'internal' | 'damerau_levenshtein' | 'levenshtein' | 'jaro_winkler' | 'ngram'; +::: diff --git a/docs/reference/api/SearchStupidBackoffSmoothingModel.md b/docs/reference/api/SearchStupidBackoffSmoothingModel.md new file mode 100644 index 000000000..30d5e716b --- /dev/null +++ b/docs/reference/api/SearchStupidBackoffSmoothingModel.md @@ -0,0 +1,5 @@ +## Interface `SearchStupidBackoffSmoothingModel` + +| Name | Type | Description | +| - | - | - | +| `discount` | [double](./double.md) | A constant factor that the lower order n-gram model is discounted by. | diff --git a/docs/reference/api/SearchSuggest.md b/docs/reference/api/SearchSuggest.md new file mode 100644 index 000000000..05996648d --- /dev/null +++ b/docs/reference/api/SearchSuggest.md @@ -0,0 +1,4 @@ +## `SearchSuggest` +::: +type SearchSuggest = [SearchCompletionSuggest](./SearchCompletionSuggest.md) | [SearchPhraseSuggest](./SearchPhraseSuggest.md) | [SearchTermSuggest](./SearchTermSuggest.md); +::: diff --git a/docs/reference/api/SearchSuggestBase.md b/docs/reference/api/SearchSuggestBase.md new file mode 100644 index 000000000..17eb5e85a --- /dev/null +++ b/docs/reference/api/SearchSuggestBase.md @@ -0,0 +1,7 @@ +## Interface `SearchSuggestBase` + +| Name | Type | Description | +| - | - | - | +| `length` | [integer](./integer.md) |   | +| `offset` | [integer](./integer.md) |   | +| `text` | string |   | diff --git a/docs/reference/api/SearchSuggestFuzziness.md b/docs/reference/api/SearchSuggestFuzziness.md new file mode 100644 index 000000000..b236395f9 --- /dev/null +++ b/docs/reference/api/SearchSuggestFuzziness.md @@ -0,0 +1,9 @@ +## Interface `SearchSuggestFuzziness` + +| Name | Type | Description | +| - | - | - | +| `fuzziness` | [Fuzziness](./Fuzziness.md) | The fuzziness factor. | +| `min_length` | [integer](./integer.md) | Minimum length of the input before fuzzy suggestions are returned. | +| `prefix_length` | [integer](./integer.md) | Minimum length of the input, which is not checked for fuzzy alternatives. | +| `transpositions` | boolean | If set to `true`, transpositions are counted as one change instead of two. | +| `unicode_aware` | boolean | If `true`, all measurements (like fuzzy edit distance, transpositions, and lengths) are measured in Unicode code points instead of in bytes. This is slightly slower than raw bytes. | diff --git a/docs/reference/api/SearchSuggestSort.md b/docs/reference/api/SearchSuggestSort.md new file mode 100644 index 000000000..c9ab10b6d --- /dev/null +++ b/docs/reference/api/SearchSuggestSort.md @@ -0,0 +1,4 @@ +## `SearchSuggestSort` +::: +type SearchSuggestSort = 'score' | 'frequency'; +::: diff --git a/docs/reference/api/SearchSuggester.md b/docs/reference/api/SearchSuggester.md new file mode 100644 index 000000000..1e781f106 --- /dev/null +++ b/docs/reference/api/SearchSuggester.md @@ -0,0 +1,4 @@ +## `SearchSuggester` +::: +type SearchSuggester = [SearchSuggesterKeys](./SearchSuggesterKeys.md) & { [property: string]: [SearchFieldSuggester](./SearchFieldSuggester.md) | string;}; +::: diff --git a/docs/reference/api/SearchSuggesterBase.md b/docs/reference/api/SearchSuggesterBase.md new file mode 100644 index 000000000..869fb6685 --- /dev/null +++ b/docs/reference/api/SearchSuggesterBase.md @@ -0,0 +1,7 @@ +## Interface `SearchSuggesterBase` + +| Name | Type | Description | +| - | - | - | +| `analyzer` | string | The analyzer to analyze the suggest text with. Defaults to the search analyzer of the suggest field. | +| `field` | [Field](./Field.md) | The field to fetch the candidate suggestions from. Needs to be set globally or per suggestion. | +| `size` | [integer](./integer.md) | The maximum corrections to be returned per suggest text token. | diff --git a/docs/reference/api/SearchSuggesterKeys.md b/docs/reference/api/SearchSuggesterKeys.md new file mode 100644 index 000000000..835b84434 --- /dev/null +++ b/docs/reference/api/SearchSuggesterKeys.md @@ -0,0 +1,5 @@ +## Interface `SearchSuggesterKeys` + +| Name | Type | Description | +| - | - | - | +| `text` | string | Global suggest text, to avoid repetition when the same text is used in several suggesters | diff --git a/docs/reference/api/SearchTemplateApi_1.md b/docs/reference/api/SearchTemplateApi_1.md new file mode 100644 index 000000000..2fb4d1e0c --- /dev/null +++ b/docs/reference/api/SearchTemplateApi_1.md @@ -0,0 +1,3 @@ +::: +default function SearchTemplateApi(this: [That](./That.md), params?: [SearchTemplateRequest](./SearchTemplateRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SearchTemplateResponse](./SearchTemplateResponse.md)>; +::: diff --git a/docs/reference/api/SearchTemplateApi_2.md b/docs/reference/api/SearchTemplateApi_2.md new file mode 100644 index 000000000..636a9d0f6 --- /dev/null +++ b/docs/reference/api/SearchTemplateApi_2.md @@ -0,0 +1,3 @@ +::: +default function SearchTemplateApi(this: [That](./That.md), params?: [SearchTemplateRequest](./SearchTemplateRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SearchTemplateResponse](./SearchTemplateResponse.md), unknown>>; +::: diff --git a/docs/reference/api/SearchTemplateApi_3.md b/docs/reference/api/SearchTemplateApi_3.md new file mode 100644 index 000000000..adf7b6c14 --- /dev/null +++ b/docs/reference/api/SearchTemplateApi_3.md @@ -0,0 +1,3 @@ +::: +default function SearchTemplateApi(this: [That](./That.md), params?: [SearchTemplateRequest](./SearchTemplateRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SearchTemplateResponse](./SearchTemplateResponse.md)>; +::: diff --git a/docs/reference/api/SearchTemplateRequest.md b/docs/reference/api/SearchTemplateRequest.md new file mode 100644 index 000000000..370e419c1 --- /dev/null +++ b/docs/reference/api/SearchTemplateRequest.md @@ -0,0 +1,23 @@ +## Interface `SearchTemplateRequest` + +| Name | Type | Description | +| - | - | - | +| `allow_no_indices` | boolean | If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. | +| `body` | string | ({ [key: string]: any; } & { index?: never; allow_no_indices?: never; ccs_minimize_roundtrips?: never; expand_wildcards?: never; ignore_throttled?: never; ignore_unavailable?: never; preference?: never; routing?: never; scroll?: never; search_type?: never; rest_total_hits_as_int?: never; typed_keys?: never; explain?: never; id?: never; params?: never; profile?: never; source?: never; }) | All values in `body` will be added to the request body. | +| `ccs_minimize_roundtrips` | boolean | If `true`, network round-trips are minimized for cross-cluster search requests. | +| `expand_wildcards` | [ExpandWildcards](./ExpandWildcards.md) | The type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. | +| `explain` | boolean | If `true`, returns detailed information about score calculation as part of each hit. If you specify both this and the `explain` query parameter, the API uses only the query parameter. | +| `id` | [Id](./Id.md) | The ID of the search template to use. If no `source` is specified, this parameter is required. | +| `ignore_throttled` | boolean | If `true`, specified concrete, expanded, or aliased indices are not included in the response when throttled. | +| `ignore_unavailable` | boolean | If `false`, the request returns an error if it targets a missing or closed index. | +| `index` | [Indices](./Indices.md) | A comma-separated list of data streams, indices, and aliases to search. It supports wildcards ( `*`). | +| `params` | Record | Key-value pairs used to replace Mustache variables in the template. The key is the variable name. The value is the variable value. | +| `preference` | string | The node or shard the operation should be performed on. It is random by default. | +| `profile` | boolean | If `true`, the query execution is profiled. | +| `querystring` | { [key: string]: any; } & { index?: never; allow_no_indices?: never; ccs_minimize_roundtrips?: never; expand_wildcards?: never; ignore_throttled?: never; ignore_unavailable?: never; preference?: never; routing?: never; scroll?: never; search_type?: never; rest_total_hits_as_int?: never; typed_keys?: never; explain?: never; id?: never; params?: never; profile?: never; source?: never; } | All values in `querystring` will be added to the request querystring. | +| `rest_total_hits_as_int` | boolean | If `true`, `hits.total` is rendered as an integer in the response. If `false`, it is rendered as an object. | +| `routing` | [Routing](./Routing.md) | A custom value used to route operations to a specific shard. | +| `scroll` | [Duration](./Duration.md) | Specifies how long a consistent view of the index should be maintained for scrolled search. | +| `search_type` | [SearchType](./SearchType.md) | The type of the search operation. | +| `source` | [ScriptSource](./ScriptSource.md) | An inline search template. Supports the same parameters as the search API's request body. It also supports Mustache variables. If no `id` is specified, this parameter is required. | +| `typed_keys` | boolean | If `true`, the response prefixes aggregation and suggester names with their respective types. | diff --git a/docs/reference/api/SearchTemplateResponse.md b/docs/reference/api/SearchTemplateResponse.md new file mode 100644 index 000000000..c6bd4a9ef --- /dev/null +++ b/docs/reference/api/SearchTemplateResponse.md @@ -0,0 +1,18 @@ +## Interface `SearchTemplateResponse` + +| Name | Type | Description | +| - | - | - | +| `_clusters` | [ClusterStatistics](./ClusterStatistics.md) |   | +| `_scroll_id` | [ScrollId](./ScrollId.md) |   | +| `_shards` | [ShardStatistics](./ShardStatistics.md) |   | +| `aggregations` | Record<[AggregateName](./AggregateName.md), [AggregationsAggregate](./AggregationsAggregate.md)> |   | +| `fields` | Record |   | +| `hits` | [SearchHitsMetadata](./SearchHitsMetadata.md) |   | +| `max_score` | [double](./double.md) |   | +| `num_reduce_phases` | [long](./long.md) |   | +| `pit_id` | [Id](./Id.md) |   | +| `profile` | [SearchProfile](./SearchProfile.md) |   | +| `suggest` | Record<[SuggestionName](./SuggestionName.md), [SearchSuggest](./SearchSuggest.md)[]> |   | +| `terminated_early` | boolean |   | +| `timed_out` | boolean |   | +| `took` | [long](./long.md) |   | diff --git a/docs/reference/api/SearchTermSuggest.md b/docs/reference/api/SearchTermSuggest.md new file mode 100644 index 000000000..d7b6233af --- /dev/null +++ b/docs/reference/api/SearchTermSuggest.md @@ -0,0 +1,5 @@ +## Interface `SearchTermSuggest` + +| Name | Type | Description | +| - | - | - | +| `options` | [SearchTermSuggestOption](./SearchTermSuggestOption.md) | [SearchTermSuggestOption](./SearchTermSuggestOption.md)[] |   | diff --git a/docs/reference/api/SearchTermSuggestOption.md b/docs/reference/api/SearchTermSuggestOption.md new file mode 100644 index 000000000..83ff1deb1 --- /dev/null +++ b/docs/reference/api/SearchTermSuggestOption.md @@ -0,0 +1,9 @@ +## Interface `SearchTermSuggestOption` + +| Name | Type | Description | +| - | - | - | +| `collate_match` | boolean |   | +| `freq` | [long](./long.md) |   | +| `highlighted` | string |   | +| `score` | [double](./double.md) |   | +| `text` | string |   | diff --git a/docs/reference/api/SearchTermSuggester.md b/docs/reference/api/SearchTermSuggester.md new file mode 100644 index 000000000..5122ce7bd --- /dev/null +++ b/docs/reference/api/SearchTermSuggester.md @@ -0,0 +1,16 @@ +## Interface `SearchTermSuggester` + +| Name | Type | Description | +| - | - | - | +| `lowercase_terms` | boolean |   | +| `max_edits` | [integer](./integer.md) | The maximum edit distance candidate suggestions can have in order to be considered as a suggestion. Can only be `1` or `2`. | +| `max_inspections` | [integer](./integer.md) | A factor that is used to multiply with the shard_size in order to inspect more candidate spelling corrections on the shard level. Can improve accuracy at the cost of performance. | +| `max_term_freq` | [float](./float.md) | The maximum threshold in number of documents in which a suggest text token can exist in order to be included. Can be a relative percentage number (for example `0.4`) or an absolute number to represent document frequencies. If a value higher than 1 is specified, then fractional can not be specified. | +| `min_doc_freq` | [float](./float.md) | The minimal threshold in number of documents a suggestion should appear in. This can improve quality by only suggesting high frequency terms. Can be specified as an absolute number or as a relative percentage of number of documents. If a value higher than 1 is specified, then the number cannot be fractional. | +| `min_word_length` | [integer](./integer.md) | The minimum length a suggest text term must have in order to be included. | +| `prefix_length` | [integer](./integer.md) | The number of minimal prefix characters that must match in order be a candidate for suggestions. Increasing this number improves spellcheck performance. | +| `shard_size` | [integer](./integer.md) | Sets the maximum number of suggestions to be retrieved from each individual shard. | +| `sort` | [SearchSuggestSort](./SearchSuggestSort.md) | Defines how suggestions should be sorted per suggest text term. | +| `string_distance` | [SearchStringDistance](./SearchStringDistance.md) | The string distance implementation to use for comparing how similar suggested terms are. | +| `suggest_mode` | [SuggestMode](./SuggestMode.md) | Controls what suggestions are included or controls for what suggest text terms, suggestions should be suggested. | +| `text` | string | The suggest text. Needs to be set globally or per suggestion. | diff --git a/docs/reference/api/SearchTotalHits.md b/docs/reference/api/SearchTotalHits.md new file mode 100644 index 000000000..70c43f81c --- /dev/null +++ b/docs/reference/api/SearchTotalHits.md @@ -0,0 +1,6 @@ +## Interface `SearchTotalHits` + +| Name | Type | Description | +| - | - | - | +| `relation` | [SearchTotalHitsRelation](./SearchTotalHitsRelation.md) |   | +| `value` | [long](./long.md) |   | diff --git a/docs/reference/api/SearchTotalHitsRelation.md b/docs/reference/api/SearchTotalHitsRelation.md new file mode 100644 index 000000000..54969b514 --- /dev/null +++ b/docs/reference/api/SearchTotalHitsRelation.md @@ -0,0 +1,4 @@ +## `SearchTotalHitsRelation` +::: +type SearchTotalHitsRelation = 'eq' | 'gte'; +::: diff --git a/docs/reference/api/SearchTrackHits.md b/docs/reference/api/SearchTrackHits.md new file mode 100644 index 000000000..f29f19c3a --- /dev/null +++ b/docs/reference/api/SearchTrackHits.md @@ -0,0 +1,4 @@ +## `SearchTrackHits` +::: +type SearchTrackHits = boolean | [integer](./integer.md); +::: diff --git a/docs/reference/api/SearchTransform.md b/docs/reference/api/SearchTransform.md new file mode 100644 index 000000000..0bab2bc10 --- /dev/null +++ b/docs/reference/api/SearchTransform.md @@ -0,0 +1,6 @@ +## Interface `SearchTransform` + +| Name | Type | Description | +| - | - | - | +| `request` | [WatcherSearchInputRequestDefinition](./WatcherSearchInputRequestDefinition.md) |   | +| `timeout` | [Duration](./Duration.md) |   | diff --git a/docs/reference/api/SearchType.md b/docs/reference/api/SearchType.md new file mode 100644 index 000000000..665b1accb --- /dev/null +++ b/docs/reference/api/SearchType.md @@ -0,0 +1,4 @@ +## `SearchType` +::: +type SearchType = 'query_then_fetch' | 'dfs_query_then_fetch'; +::: diff --git a/docs/reference/api/SearchableSnapshots.md b/docs/reference/api/SearchableSnapshots.md new file mode 100644 index 000000000..ced4ac437 --- /dev/null +++ b/docs/reference/api/SearchableSnapshots.md @@ -0,0 +1,20 @@ +## `SearchableSnapshots` + +### Constructor + +::: +new SearchableSnapshots(transport: [Transport](./Transport.md)); +::: + +### Properties + +| Name | Type | Description | +| - | - | - | +| `acceptedParams` | Record |   | +| `transport` | [Transport](./Transport.md) |   | + +### Methods + +| Name | Signature | Description | +| - | - | - | +| `cacheStats` | `cacheStats(this: [That](./That.md), params?: [SearchableSnapshotsCacheStatsRequest](./SearchableSnapshotsCacheStatsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SearchableSnapshotsCacheStatsResponse](./SearchableSnapshotsCacheStatsResponse.md)>;` | Get cache statistics. Get statistics about the shared cache for partially mounted indices. || `cacheStats` | `cacheStats(this: [That](./That.md), params?: [SearchableSnapshotsCacheStatsRequest](./SearchableSnapshotsCacheStatsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SearchableSnapshotsCacheStatsResponse](./SearchableSnapshotsCacheStatsResponse.md), unknown>>;` |   || `cacheStats` | `cacheStats(this: [That](./That.md), params?: [SearchableSnapshotsCacheStatsRequest](./SearchableSnapshotsCacheStatsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SearchableSnapshotsCacheStatsResponse](./SearchableSnapshotsCacheStatsResponse.md)>;` |   || `clearCache` | `clearCache(this: [That](./That.md), params?: [SearchableSnapshotsClearCacheRequest](./SearchableSnapshotsClearCacheRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SearchableSnapshotsClearCacheResponse](./SearchableSnapshotsClearCacheResponse.md)>;` | Clear the cache. Clear indices and data streams from the shared cache for partially mounted indices. || `clearCache` | `clearCache(this: [That](./That.md), params?: [SearchableSnapshotsClearCacheRequest](./SearchableSnapshotsClearCacheRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SearchableSnapshotsClearCacheResponse](./SearchableSnapshotsClearCacheResponse.md), unknown>>;` |   || `clearCache` | `clearCache(this: [That](./That.md), params?: [SearchableSnapshotsClearCacheRequest](./SearchableSnapshotsClearCacheRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SearchableSnapshotsClearCacheResponse](./SearchableSnapshotsClearCacheResponse.md)>;` |   || `mount` | `mount(this: [That](./That.md), params: [SearchableSnapshotsMountRequest](./SearchableSnapshotsMountRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SearchableSnapshotsMountResponse](./SearchableSnapshotsMountResponse.md)>;` | Mount a snapshot. Mount a snapshot as a searchable snapshot index. Do not use this API for snapshots managed by index lifecycle management (ILM). Manually mounting ILM-managed snapshots can interfere with ILM processes. || `mount` | `mount(this: [That](./That.md), params: [SearchableSnapshotsMountRequest](./SearchableSnapshotsMountRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SearchableSnapshotsMountResponse](./SearchableSnapshotsMountResponse.md), unknown>>;` |   || `mount` | `mount(this: [That](./That.md), params: [SearchableSnapshotsMountRequest](./SearchableSnapshotsMountRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SearchableSnapshotsMountResponse](./SearchableSnapshotsMountResponse.md)>;` |   || `stats` | `stats(this: [That](./That.md), params?: [SearchableSnapshotsStatsRequest](./SearchableSnapshotsStatsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SearchableSnapshotsStatsResponse](./SearchableSnapshotsStatsResponse.md)>;` | Get searchable snapshot statistics. || `stats` | `stats(this: [That](./That.md), params?: [SearchableSnapshotsStatsRequest](./SearchableSnapshotsStatsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SearchableSnapshotsStatsResponse](./SearchableSnapshotsStatsResponse.md), unknown>>;` |   || `stats` | `stats(this: [That](./That.md), params?: [SearchableSnapshotsStatsRequest](./SearchableSnapshotsStatsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SearchableSnapshotsStatsResponse](./SearchableSnapshotsStatsResponse.md)>;` |   | \ No newline at end of file diff --git a/docs/reference/api/SearchableSnapshotsCacheStatsNode.md b/docs/reference/api/SearchableSnapshotsCacheStatsNode.md new file mode 100644 index 000000000..9ec9b867a --- /dev/null +++ b/docs/reference/api/SearchableSnapshotsCacheStatsNode.md @@ -0,0 +1,5 @@ +## Interface `SearchableSnapshotsCacheStatsNode` + +| Name | Type | Description | +| - | - | - | +| `shared_cache` | [SearchableSnapshotsCacheStatsShared](./SearchableSnapshotsCacheStatsShared.md) |   | diff --git a/docs/reference/api/SearchableSnapshotsCacheStatsRequest.md b/docs/reference/api/SearchableSnapshotsCacheStatsRequest.md new file mode 100644 index 000000000..7247e8803 --- /dev/null +++ b/docs/reference/api/SearchableSnapshotsCacheStatsRequest.md @@ -0,0 +1,8 @@ +## Interface `SearchableSnapshotsCacheStatsRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { node_id?: never; master_timeout?: never; }) | All values in `body` will be added to the request body. | +| `master_timeout` | [Duration](./Duration.md) |   | +| `node_id` | [NodeIds](./NodeIds.md) | The names of the nodes in the cluster to target. | +| `querystring` | { [key: string]: any; } & { node_id?: never; master_timeout?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/SearchableSnapshotsCacheStatsResponse.md b/docs/reference/api/SearchableSnapshotsCacheStatsResponse.md new file mode 100644 index 000000000..c04eccaeb --- /dev/null +++ b/docs/reference/api/SearchableSnapshotsCacheStatsResponse.md @@ -0,0 +1,5 @@ +## Interface `SearchableSnapshotsCacheStatsResponse` + +| Name | Type | Description | +| - | - | - | +| `nodes` | Record |   | diff --git a/docs/reference/api/SearchableSnapshotsCacheStatsShared.md b/docs/reference/api/SearchableSnapshotsCacheStatsShared.md new file mode 100644 index 000000000..01f749fc5 --- /dev/null +++ b/docs/reference/api/SearchableSnapshotsCacheStatsShared.md @@ -0,0 +1,12 @@ +## Interface `SearchableSnapshotsCacheStatsShared` + +| Name | Type | Description | +| - | - | - | +| `bytes_read_in_bytes` | [ByteSize](./ByteSize.md) |   | +| `bytes_written_in_bytes` | [ByteSize](./ByteSize.md) |   | +| `evictions` | [long](./long.md) |   | +| `num_regions` | [integer](./integer.md) |   | +| `reads` | [long](./long.md) |   | +| `region_size_in_bytes` | [ByteSize](./ByteSize.md) |   | +| `size_in_bytes` | [ByteSize](./ByteSize.md) |   | +| `writes` | [long](./long.md) |   | diff --git a/docs/reference/api/SearchableSnapshotsClearCacheRequest.md b/docs/reference/api/SearchableSnapshotsClearCacheRequest.md new file mode 100644 index 000000000..7092fd609 --- /dev/null +++ b/docs/reference/api/SearchableSnapshotsClearCacheRequest.md @@ -0,0 +1,10 @@ +## Interface `SearchableSnapshotsClearCacheRequest` + +| Name | Type | Description | +| - | - | - | +| `allow_no_indices` | boolean | Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) | +| `body` | string | ({ [key: string]: any; } & { index?: never; expand_wildcards?: never; allow_no_indices?: never; ignore_unavailable?: never; }) | All values in `body` will be added to the request body. | +| `expand_wildcards` | [ExpandWildcards](./ExpandWildcards.md) | Whether to expand wildcard expression to concrete indices that are open, closed or both. | +| `ignore_unavailable` | boolean | Whether specified concrete indices should be ignored when unavailable (missing or closed) | +| `index` | [Indices](./Indices.md) | A comma-separated list of data streams, indices, and aliases to clear from the cache. It supports wildcards ( `*`). | +| `querystring` | { [key: string]: any; } & { index?: never; expand_wildcards?: never; allow_no_indices?: never; ignore_unavailable?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/SearchableSnapshotsClearCacheResponse.md b/docs/reference/api/SearchableSnapshotsClearCacheResponse.md new file mode 100644 index 000000000..e3c11f2e5 --- /dev/null +++ b/docs/reference/api/SearchableSnapshotsClearCacheResponse.md @@ -0,0 +1,4 @@ +## `SearchableSnapshotsClearCacheResponse` +::: +type SearchableSnapshotsClearCacheResponse = any; +::: diff --git a/docs/reference/api/SearchableSnapshotsMountMountedSnapshot.md b/docs/reference/api/SearchableSnapshotsMountMountedSnapshot.md new file mode 100644 index 000000000..8d474e222 --- /dev/null +++ b/docs/reference/api/SearchableSnapshotsMountMountedSnapshot.md @@ -0,0 +1,7 @@ +## Interface `SearchableSnapshotsMountMountedSnapshot` + +| Name | Type | Description | +| - | - | - | +| `indices` | [Indices](./Indices.md) |   | +| `shards` | [ShardStatistics](./ShardStatistics.md) |   | +| `snapshot` | [Name](./Name.md) |   | diff --git a/docs/reference/api/SearchableSnapshotsMountRequest.md b/docs/reference/api/SearchableSnapshotsMountRequest.md new file mode 100644 index 000000000..dcf8f2dac --- /dev/null +++ b/docs/reference/api/SearchableSnapshotsMountRequest.md @@ -0,0 +1,15 @@ +## Interface `SearchableSnapshotsMountRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { repository?: never; snapshot?: never; master_timeout?: never; wait_for_completion?: never; storage?: never; index?: never; renamed_index?: never; index_settings?: never; ignore_index_settings?: never; }) | All values in `body` will be added to the request body. | +| `ignore_index_settings` | string[] | The names of settings that should be removed from the index when it is mounted. | +| `index_settings` | Record | The settings that should be added to the index when it is mounted. | +| `index` | [IndexName](./IndexName.md) | The name of the index contained in the snapshot whose data is to be mounted. If no `renamed_index` is specified, this name will also be used to create the new index. | +| `master_timeout` | [Duration](./Duration.md) | The period to wait for the master node. If the master node is not available before the timeout expires, the request fails and returns an error. To indicate that the request should never timeout, set it to `-1`. | +| `querystring` | { [key: string]: any; } & { repository?: never; snapshot?: never; master_timeout?: never; wait_for_completion?: never; storage?: never; index?: never; renamed_index?: never; index_settings?: never; ignore_index_settings?: never; } | All values in `querystring` will be added to the request querystring. | +| `renamed_index` | [IndexName](./IndexName.md) | The name of the index that will be created. | +| `repository` | [Name](./Name.md) | The name of the repository containing the snapshot of the index to mount. | +| `snapshot` | [Name](./Name.md) | The name of the snapshot of the index to mount. | +| `storage` | string | The mount option for the searchable snapshot index. | +| `wait_for_completion` | boolean | If true, the request blocks until the operation is complete. | diff --git a/docs/reference/api/SearchableSnapshotsMountResponse.md b/docs/reference/api/SearchableSnapshotsMountResponse.md new file mode 100644 index 000000000..302da7ca4 --- /dev/null +++ b/docs/reference/api/SearchableSnapshotsMountResponse.md @@ -0,0 +1,5 @@ +## Interface `SearchableSnapshotsMountResponse` + +| Name | Type | Description | +| - | - | - | +| `snapshot` | [SearchableSnapshotsMountMountedSnapshot](./SearchableSnapshotsMountMountedSnapshot.md) |   | diff --git a/docs/reference/api/SearchableSnapshotsStatsLevel.md b/docs/reference/api/SearchableSnapshotsStatsLevel.md new file mode 100644 index 000000000..2e8c2e1e6 --- /dev/null +++ b/docs/reference/api/SearchableSnapshotsStatsLevel.md @@ -0,0 +1,4 @@ +## `SearchableSnapshotsStatsLevel` +::: +type SearchableSnapshotsStatsLevel = 'cluster' | 'indices' | 'shards'; +::: diff --git a/docs/reference/api/SearchableSnapshotsStatsRequest.md b/docs/reference/api/SearchableSnapshotsStatsRequest.md new file mode 100644 index 000000000..ad5eede82 --- /dev/null +++ b/docs/reference/api/SearchableSnapshotsStatsRequest.md @@ -0,0 +1,8 @@ +## Interface `SearchableSnapshotsStatsRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { index?: never; level?: never; }) | All values in `body` will be added to the request body. | +| `index` | [Indices](./Indices.md) | A comma-separated list of data streams and indices to retrieve statistics for. | +| `level` | [SearchableSnapshotsStatsLevel](./SearchableSnapshotsStatsLevel.md) | Return stats aggregated at cluster, index or shard level | +| `querystring` | { [key: string]: any; } & { index?: never; level?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/SearchableSnapshotsStatsResponse.md b/docs/reference/api/SearchableSnapshotsStatsResponse.md new file mode 100644 index 000000000..73c033bc0 --- /dev/null +++ b/docs/reference/api/SearchableSnapshotsStatsResponse.md @@ -0,0 +1,6 @@ +## Interface `SearchableSnapshotsStatsResponse` + +| Name | Type | Description | +| - | - | - | +| `stats` | any |   | +| `total` | any |   | diff --git a/docs/reference/api/Security.md b/docs/reference/api/Security.md new file mode 100644 index 000000000..eb194694d --- /dev/null +++ b/docs/reference/api/Security.md @@ -0,0 +1,20 @@ +## `Security` + +### Constructor + +::: +new Security(transport: [Transport](./Transport.md)); +::: + +### Properties + +| Name | Type | Description | +| - | - | - | +| `acceptedParams` | Record |   | +| `transport` | [Transport](./Transport.md) |   | + +### Methods + +| Name | Signature | Description | +| - | - | - | +| `activateUserProfile` | `activateUserProfile(this: [That](./That.md), params: [SecurityActivateUserProfileRequest](./SecurityActivateUserProfileRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityActivateUserProfileResponse](./SecurityActivateUserProfileResponse.md)>;` | Activate a user profile. Create or update a user profile on behalf of another user. NOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions. Individual users and external applications should not call this API directly. The calling application must have either an `access_token` or a combination of `username` and `password` for the user that the profile document is intended for. Elastic reserves the right to change or remove this feature in future releases without prior notice. This API creates or updates a profile document for end users with information that is extracted from the user's authentication object including `username`, `full_name,` `roles`, and the authentication realm. For example, in the JWT `access_token` case, the profile user's `username` is extracted from the JWT token claim pointed to by the `claims.principal` setting of the JWT realm that authenticated the token. When updating a profile document, the API enables the document if it was disabled. Any updates do not change existing content for either the `labels` or `data` fields. || `activateUserProfile` | `activateUserProfile(this: [That](./That.md), params: [SecurityActivateUserProfileRequest](./SecurityActivateUserProfileRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityActivateUserProfileResponse](./SecurityActivateUserProfileResponse.md), unknown>>;` |   || `activateUserProfile` | `activateUserProfile(this: [That](./That.md), params: [SecurityActivateUserProfileRequest](./SecurityActivateUserProfileRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityActivateUserProfileResponse](./SecurityActivateUserProfileResponse.md)>;` |   || `authenticate` | `authenticate(this: [That](./That.md), params?: [SecurityAuthenticateRequest](./SecurityAuthenticateRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityAuthenticateResponse](./SecurityAuthenticateResponse.md)>;` | Authenticate a user. Authenticates a user and returns information about the authenticated user. Include the user information in a [basic auth header](https://en.wikipedia.org/wiki/Basic_access_authentication). A successful call returns a JSON structure that shows user information such as their username, the roles that are assigned to the user, any assigned metadata, and information about the realms that authenticated and authorized the user. If the user cannot be authenticated, this API returns a 401 status code. || `authenticate` | `authenticate(this: [That](./That.md), params?: [SecurityAuthenticateRequest](./SecurityAuthenticateRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityAuthenticateResponse](./SecurityAuthenticateResponse.md), unknown>>;` |   || `authenticate` | `authenticate(this: [That](./That.md), params?: [SecurityAuthenticateRequest](./SecurityAuthenticateRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityAuthenticateResponse](./SecurityAuthenticateResponse.md)>;` |   || `bulkDeleteRole` | `bulkDeleteRole(this: [That](./That.md), params: [SecurityBulkDeleteRoleRequest](./SecurityBulkDeleteRoleRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityBulkDeleteRoleResponse](./SecurityBulkDeleteRoleResponse.md)>;` | Bulk delete roles. The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. The bulk delete roles API cannot delete roles that are defined in roles files. || `bulkDeleteRole` | `bulkDeleteRole(this: [That](./That.md), params: [SecurityBulkDeleteRoleRequest](./SecurityBulkDeleteRoleRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityBulkDeleteRoleResponse](./SecurityBulkDeleteRoleResponse.md), unknown>>;` |   || `bulkDeleteRole` | `bulkDeleteRole(this: [That](./That.md), params: [SecurityBulkDeleteRoleRequest](./SecurityBulkDeleteRoleRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityBulkDeleteRoleResponse](./SecurityBulkDeleteRoleResponse.md)>;` |   || `bulkPutRole` | `bulkPutRole(this: [That](./That.md), params: [SecurityBulkPutRoleRequest](./SecurityBulkPutRoleRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityBulkPutRoleResponse](./SecurityBulkPutRoleResponse.md)>;` | Bulk create or update roles. The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. The bulk create or update roles API cannot update roles that are defined in roles files. || `bulkPutRole` | `bulkPutRole(this: [That](./That.md), params: [SecurityBulkPutRoleRequest](./SecurityBulkPutRoleRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityBulkPutRoleResponse](./SecurityBulkPutRoleResponse.md), unknown>>;` |   || `bulkPutRole` | `bulkPutRole(this: [That](./That.md), params: [SecurityBulkPutRoleRequest](./SecurityBulkPutRoleRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityBulkPutRoleResponse](./SecurityBulkPutRoleResponse.md)>;` |   || `bulkUpdateApiKeys` | `bulkUpdateApiKeys(this: [That](./That.md), params: [SecurityBulkUpdateApiKeysRequest](./SecurityBulkUpdateApiKeysRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityBulkUpdateApiKeysResponse](./SecurityBulkUpdateApiKeysResponse.md)>;` | Bulk update API keys. Update the attributes for multiple API keys. IMPORTANT: It is not possible to use an API key as the authentication credential for this API. To update API keys, the owner user's credentials are required. This API is similar to the update API key API but enables you to apply the same update to multiple API keys in one API call. This operation can greatly improve performance over making individual updates. It is not possible to update expired or invalidated API keys. This API supports updates to API key access scope, metadata and expiration. The access scope of each API key is derived from the `role_descriptors` you specify in the request and a snapshot of the owner user's permissions at the time of the request. The snapshot of the owner's permissions is updated automatically on every call. IMPORTANT: If you don't specify `role_descriptors` in the request, a call to this API might still change an API key's access scope. This change can occur if the owner user's permissions have changed since the API key was created or last modified. A successful request returns a JSON structure that contains the IDs of all updated API keys, the IDs of API keys that already had the requested changes and did not require an update, and error details for any failed update. || `bulkUpdateApiKeys` | `bulkUpdateApiKeys(this: [That](./That.md), params: [SecurityBulkUpdateApiKeysRequest](./SecurityBulkUpdateApiKeysRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityBulkUpdateApiKeysResponse](./SecurityBulkUpdateApiKeysResponse.md), unknown>>;` |   || `bulkUpdateApiKeys` | `bulkUpdateApiKeys(this: [That](./That.md), params: [SecurityBulkUpdateApiKeysRequest](./SecurityBulkUpdateApiKeysRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityBulkUpdateApiKeysResponse](./SecurityBulkUpdateApiKeysResponse.md)>;` |   || `changePassword` | `changePassword(this: [That](./That.md), params?: [SecurityChangePasswordRequest](./SecurityChangePasswordRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityChangePasswordResponse](./SecurityChangePasswordResponse.md)>;` | Change passwords. Change the passwords of users in the native realm and built-in users. || `changePassword` | `changePassword(this: [That](./That.md), params?: [SecurityChangePasswordRequest](./SecurityChangePasswordRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityChangePasswordResponse](./SecurityChangePasswordResponse.md), unknown>>;` |   || `changePassword` | `changePassword(this: [That](./That.md), params?: [SecurityChangePasswordRequest](./SecurityChangePasswordRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityChangePasswordResponse](./SecurityChangePasswordResponse.md)>;` |   || `clearApiKeyCache` | `clearApiKeyCache(this: [That](./That.md), params: [SecurityClearApiKeyCacheRequest](./SecurityClearApiKeyCacheRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityClearApiKeyCacheResponse](./SecurityClearApiKeyCacheResponse.md)>;` | Clear the API key cache. Evict a subset of all entries from the API key cache. The cache is also automatically cleared on state changes of the security index. || `clearApiKeyCache` | `clearApiKeyCache(this: [That](./That.md), params: [SecurityClearApiKeyCacheRequest](./SecurityClearApiKeyCacheRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityClearApiKeyCacheResponse](./SecurityClearApiKeyCacheResponse.md), unknown>>;` |   || `clearApiKeyCache` | `clearApiKeyCache(this: [That](./That.md), params: [SecurityClearApiKeyCacheRequest](./SecurityClearApiKeyCacheRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityClearApiKeyCacheResponse](./SecurityClearApiKeyCacheResponse.md)>;` |   || `clearCachedPrivileges` | `clearCachedPrivileges(this: [That](./That.md), params: [SecurityClearCachedPrivilegesRequest](./SecurityClearCachedPrivilegesRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityClearCachedPrivilegesResponse](./SecurityClearCachedPrivilegesResponse.md)>;` | Clear the privileges cache. Evict privileges from the native application privilege cache. The cache is also automatically cleared for applications that have their privileges updated. || `clearCachedPrivileges` | `clearCachedPrivileges(this: [That](./That.md), params: [SecurityClearCachedPrivilegesRequest](./SecurityClearCachedPrivilegesRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityClearCachedPrivilegesResponse](./SecurityClearCachedPrivilegesResponse.md), unknown>>;` |   || `clearCachedPrivileges` | `clearCachedPrivileges(this: [That](./That.md), params: [SecurityClearCachedPrivilegesRequest](./SecurityClearCachedPrivilegesRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityClearCachedPrivilegesResponse](./SecurityClearCachedPrivilegesResponse.md)>;` |   || `clearCachedRealms` | `clearCachedRealms(this: [That](./That.md), params: [SecurityClearCachedRealmsRequest](./SecurityClearCachedRealmsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityClearCachedRealmsResponse](./SecurityClearCachedRealmsResponse.md)>;` | Clear the user cache. Evict users from the user cache. You can completely clear the cache or evict specific users. User credentials are cached in memory on each node to avoid connecting to a remote authentication service or hitting the disk for every incoming request. There are realm settings that you can use to configure the user cache. For more information, refer to the documentation about controlling the user cache. || `clearCachedRealms` | `clearCachedRealms(this: [That](./That.md), params: [SecurityClearCachedRealmsRequest](./SecurityClearCachedRealmsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityClearCachedRealmsResponse](./SecurityClearCachedRealmsResponse.md), unknown>>;` |   || `clearCachedRealms` | `clearCachedRealms(this: [That](./That.md), params: [SecurityClearCachedRealmsRequest](./SecurityClearCachedRealmsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityClearCachedRealmsResponse](./SecurityClearCachedRealmsResponse.md)>;` |   || `clearCachedRoles` | `clearCachedRoles(this: [That](./That.md), params: [SecurityClearCachedRolesRequest](./SecurityClearCachedRolesRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityClearCachedRolesResponse](./SecurityClearCachedRolesResponse.md)>;` | Clear the roles cache. Evict roles from the native role cache. || `clearCachedRoles` | `clearCachedRoles(this: [That](./That.md), params: [SecurityClearCachedRolesRequest](./SecurityClearCachedRolesRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityClearCachedRolesResponse](./SecurityClearCachedRolesResponse.md), unknown>>;` |   || `clearCachedRoles` | `clearCachedRoles(this: [That](./That.md), params: [SecurityClearCachedRolesRequest](./SecurityClearCachedRolesRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityClearCachedRolesResponse](./SecurityClearCachedRolesResponse.md)>;` |   || `clearCachedServiceTokens` | `clearCachedServiceTokens(this: [That](./That.md), params: [SecurityClearCachedServiceTokensRequest](./SecurityClearCachedServiceTokensRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityClearCachedServiceTokensResponse](./SecurityClearCachedServiceTokensResponse.md)>;` | Clear service account token caches. Evict a subset of all entries from the service account token caches. Two separate caches exist for service account tokens: one cache for tokens backed by the `service_tokens` file, and another for tokens backed by the `.security` index. This API clears matching entries from both caches. The cache for service account tokens backed by the `.security` index is cleared automatically on state changes of the security index. The cache for tokens backed by the `service_tokens` file is cleared automatically on file changes. || `clearCachedServiceTokens` | `clearCachedServiceTokens(this: [That](./That.md), params: [SecurityClearCachedServiceTokensRequest](./SecurityClearCachedServiceTokensRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityClearCachedServiceTokensResponse](./SecurityClearCachedServiceTokensResponse.md), unknown>>;` |   || `clearCachedServiceTokens` | `clearCachedServiceTokens(this: [That](./That.md), params: [SecurityClearCachedServiceTokensRequest](./SecurityClearCachedServiceTokensRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityClearCachedServiceTokensResponse](./SecurityClearCachedServiceTokensResponse.md)>;` |   || `createApiKey` | `createApiKey(this: [That](./That.md), params?: [SecurityCreateApiKeyRequest](./SecurityCreateApiKeyRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityCreateApiKeyResponse](./SecurityCreateApiKeyResponse.md)>;` | Create an API key. Create an API key for access without requiring basic authentication. IMPORTANT: If the credential that is used to authenticate this request is an API key, the derived API key cannot have any privileges. If you specify privileges, the API returns an error. A successful request returns a JSON structure that contains the API key, its unique id, and its name. If applicable, it also returns expiration information for the API key in milliseconds. NOTE: By default, API keys never expire. You can specify expiration information when you create the API keys. The API keys are created by the Elasticsearch API key service, which is automatically enabled. To configure or turn off the API key service, refer to API key service setting documentation. || `createApiKey` | `createApiKey(this: [That](./That.md), params?: [SecurityCreateApiKeyRequest](./SecurityCreateApiKeyRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityCreateApiKeyResponse](./SecurityCreateApiKeyResponse.md), unknown>>;` |   || `createApiKey` | `createApiKey(this: [That](./That.md), params?: [SecurityCreateApiKeyRequest](./SecurityCreateApiKeyRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityCreateApiKeyResponse](./SecurityCreateApiKeyResponse.md)>;` |   || `createCrossClusterApiKey` | `createCrossClusterApiKey(this: [That](./That.md), params: [SecurityCreateCrossClusterApiKeyRequest](./SecurityCreateCrossClusterApiKeyRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityCreateCrossClusterApiKeyResponse](./SecurityCreateCrossClusterApiKeyResponse.md)>;` | Create a cross-cluster API key. Create an API key of the `cross_cluster` type for the API key based remote cluster access. A `cross_cluster` API key cannot be used to authenticate through the REST interface. IMPORTANT: To authenticate this request you must use a credential that is not an API key. Even if you use an API key that has the required privilege, the API returns an error. Cross-cluster API keys are created by the Elasticsearch API key service, which is automatically enabled. NOTE: Unlike REST API keys, a cross-cluster API key does not capture permissions of the authenticated user. The API key’s effective permission is exactly as specified with the `access` property. A successful request returns a JSON structure that contains the API key, its unique ID, and its name. If applicable, it also returns expiration information for the API key in milliseconds. By default, API keys never expire. You can specify expiration information when you create the API keys. Cross-cluster API keys can only be updated with the update cross-cluster API key API. Attempting to update them with the update REST API key API or the bulk update REST API keys API will result in an error. || `createCrossClusterApiKey` | `createCrossClusterApiKey(this: [That](./That.md), params: [SecurityCreateCrossClusterApiKeyRequest](./SecurityCreateCrossClusterApiKeyRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityCreateCrossClusterApiKeyResponse](./SecurityCreateCrossClusterApiKeyResponse.md), unknown>>;` |   || `createCrossClusterApiKey` | `createCrossClusterApiKey(this: [That](./That.md), params: [SecurityCreateCrossClusterApiKeyRequest](./SecurityCreateCrossClusterApiKeyRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityCreateCrossClusterApiKeyResponse](./SecurityCreateCrossClusterApiKeyResponse.md)>;` |   || `createServiceToken` | `createServiceToken(this: [That](./That.md), params: [SecurityCreateServiceTokenRequest](./SecurityCreateServiceTokenRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityCreateServiceTokenResponse](./SecurityCreateServiceTokenResponse.md)>;` | Create a service account token. Create a service accounts token for access without requiring basic authentication. NOTE: Service account tokens never expire. You must actively delete them if they are no longer needed. || `createServiceToken` | `createServiceToken(this: [That](./That.md), params: [SecurityCreateServiceTokenRequest](./SecurityCreateServiceTokenRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityCreateServiceTokenResponse](./SecurityCreateServiceTokenResponse.md), unknown>>;` |   || `createServiceToken` | `createServiceToken(this: [That](./That.md), params: [SecurityCreateServiceTokenRequest](./SecurityCreateServiceTokenRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityCreateServiceTokenResponse](./SecurityCreateServiceTokenResponse.md)>;` |   || `delegatePki` | `delegatePki(this: [That](./That.md), params: [SecurityDelegatePkiRequest](./SecurityDelegatePkiRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityDelegatePkiResponse](./SecurityDelegatePkiResponse.md)>;` | Delegate PKI authentication. This API implements the exchange of an X509Certificate chain for an Elasticsearch access token. The certificate chain is validated, according to RFC 5280, by sequentially considering the trust configuration of every installed PKI realm that has `delegation.enabled` set to `true`. A successfully trusted client certificate is also subject to the validation of the subject distinguished name according to thw `username_pattern` of the respective realm. This API is called by smart and trusted proxies, such as Kibana, which terminate the user's TLS session but still want to authenticate the user by using a PKI realm—-as if the user connected directly to Elasticsearch. IMPORTANT: The association between the subject public key in the target certificate and the corresponding private key is not validated. This is part of the TLS authentication process and it is delegated to the proxy that calls this API. The proxy is trusted to have performed the TLS authentication and this API translates that authentication into an Elasticsearch access token. || `delegatePki` | `delegatePki(this: [That](./That.md), params: [SecurityDelegatePkiRequest](./SecurityDelegatePkiRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityDelegatePkiResponse](./SecurityDelegatePkiResponse.md), unknown>>;` |   || `delegatePki` | `delegatePki(this: [That](./That.md), params: [SecurityDelegatePkiRequest](./SecurityDelegatePkiRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityDelegatePkiResponse](./SecurityDelegatePkiResponse.md)>;` |   || `deletePrivileges` | `deletePrivileges(this: [That](./That.md), params: [SecurityDeletePrivilegesRequest](./SecurityDeletePrivilegesRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityDeletePrivilegesResponse](./SecurityDeletePrivilegesResponse.md)>;` | Delete application privileges. To use this API, you must have one of the following privileges: * The `manage_security` cluster privilege (or a greater privilege such as `all`). * The "Manage Application Privileges" global privilege for the application being referenced in the request. || `deletePrivileges` | `deletePrivileges(this: [That](./That.md), params: [SecurityDeletePrivilegesRequest](./SecurityDeletePrivilegesRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityDeletePrivilegesResponse](./SecurityDeletePrivilegesResponse.md), unknown>>;` |   || `deletePrivileges` | `deletePrivileges(this: [That](./That.md), params: [SecurityDeletePrivilegesRequest](./SecurityDeletePrivilegesRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityDeletePrivilegesResponse](./SecurityDeletePrivilegesResponse.md)>;` |   || `deleteRole` | `deleteRole(this: [That](./That.md), params: [SecurityDeleteRoleRequest](./SecurityDeleteRoleRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityDeleteRoleResponse](./SecurityDeleteRoleResponse.md)>;` | Delete roles. Delete roles in the native realm. The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. The delete roles API cannot remove roles that are defined in roles files. || `deleteRole` | `deleteRole(this: [That](./That.md), params: [SecurityDeleteRoleRequest](./SecurityDeleteRoleRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityDeleteRoleResponse](./SecurityDeleteRoleResponse.md), unknown>>;` |   || `deleteRole` | `deleteRole(this: [That](./That.md), params: [SecurityDeleteRoleRequest](./SecurityDeleteRoleRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityDeleteRoleResponse](./SecurityDeleteRoleResponse.md)>;` |   || `deleteRoleMapping` | `deleteRoleMapping(this: [That](./That.md), params: [SecurityDeleteRoleMappingRequest](./SecurityDeleteRoleMappingRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityDeleteRoleMappingResponse](./SecurityDeleteRoleMappingResponse.md)>;` | Delete role mappings. Role mappings define which roles are assigned to each user. The role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files. The delete role mappings API cannot remove role mappings that are defined in role mapping files. || `deleteRoleMapping` | `deleteRoleMapping(this: [That](./That.md), params: [SecurityDeleteRoleMappingRequest](./SecurityDeleteRoleMappingRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityDeleteRoleMappingResponse](./SecurityDeleteRoleMappingResponse.md), unknown>>;` |   || `deleteRoleMapping` | `deleteRoleMapping(this: [That](./That.md), params: [SecurityDeleteRoleMappingRequest](./SecurityDeleteRoleMappingRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityDeleteRoleMappingResponse](./SecurityDeleteRoleMappingResponse.md)>;` |   || `deleteServiceToken` | `deleteServiceToken(this: [That](./That.md), params: [SecurityDeleteServiceTokenRequest](./SecurityDeleteServiceTokenRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityDeleteServiceTokenResponse](./SecurityDeleteServiceTokenResponse.md)>;` | Delete service account tokens. Delete service account tokens for a service in a specified namespace. || `deleteServiceToken` | `deleteServiceToken(this: [That](./That.md), params: [SecurityDeleteServiceTokenRequest](./SecurityDeleteServiceTokenRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityDeleteServiceTokenResponse](./SecurityDeleteServiceTokenResponse.md), unknown>>;` |   || `deleteServiceToken` | `deleteServiceToken(this: [That](./That.md), params: [SecurityDeleteServiceTokenRequest](./SecurityDeleteServiceTokenRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityDeleteServiceTokenResponse](./SecurityDeleteServiceTokenResponse.md)>;` |   || `deleteUser` | `deleteUser(this: [That](./That.md), params: [SecurityDeleteUserRequest](./SecurityDeleteUserRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityDeleteUserResponse](./SecurityDeleteUserResponse.md)>;` | Delete users. Delete users from the native realm. || `deleteUser` | `deleteUser(this: [That](./That.md), params: [SecurityDeleteUserRequest](./SecurityDeleteUserRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityDeleteUserResponse](./SecurityDeleteUserResponse.md), unknown>>;` |   || `deleteUser` | `deleteUser(this: [That](./That.md), params: [SecurityDeleteUserRequest](./SecurityDeleteUserRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityDeleteUserResponse](./SecurityDeleteUserResponse.md)>;` |   || `disableUser` | `disableUser(this: [That](./That.md), params: [SecurityDisableUserRequest](./SecurityDisableUserRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityDisableUserResponse](./SecurityDisableUserResponse.md)>;` | Disable users. Disable users in the native realm. By default, when you create users, they are enabled. You can use this API to revoke a user's access to Elasticsearch. || `disableUser` | `disableUser(this: [That](./That.md), params: [SecurityDisableUserRequest](./SecurityDisableUserRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityDisableUserResponse](./SecurityDisableUserResponse.md), unknown>>;` |   || `disableUser` | `disableUser(this: [That](./That.md), params: [SecurityDisableUserRequest](./SecurityDisableUserRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityDisableUserResponse](./SecurityDisableUserResponse.md)>;` |   || `disableUserProfile` | `disableUserProfile(this: [That](./That.md), params: [SecurityDisableUserProfileRequest](./SecurityDisableUserProfileRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityDisableUserProfileResponse](./SecurityDisableUserProfileResponse.md)>;` | Disable a user profile. Disable user profiles so that they are not visible in user profile searches. NOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions. Individual users and external applications should not call this API directly. Elastic reserves the right to change or remove this feature in future releases without prior notice. When you activate a user profile, its automatically enabled and visible in user profile searches. You can use the disable user profile API to disable a user profile so it’s not visible in these searches. To re-enable a disabled user profile, use the enable user profile API . || `disableUserProfile` | `disableUserProfile(this: [That](./That.md), params: [SecurityDisableUserProfileRequest](./SecurityDisableUserProfileRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityDisableUserProfileResponse](./SecurityDisableUserProfileResponse.md), unknown>>;` |   || `disableUserProfile` | `disableUserProfile(this: [That](./That.md), params: [SecurityDisableUserProfileRequest](./SecurityDisableUserProfileRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityDisableUserProfileResponse](./SecurityDisableUserProfileResponse.md)>;` |   || `enableUser` | `enableUser(this: [That](./That.md), params: [SecurityEnableUserRequest](./SecurityEnableUserRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityEnableUserResponse](./SecurityEnableUserResponse.md)>;` | Enable users. Enable users in the native realm. By default, when you create users, they are enabled. || `enableUser` | `enableUser(this: [That](./That.md), params: [SecurityEnableUserRequest](./SecurityEnableUserRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityEnableUserResponse](./SecurityEnableUserResponse.md), unknown>>;` |   || `enableUser` | `enableUser(this: [That](./That.md), params: [SecurityEnableUserRequest](./SecurityEnableUserRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityEnableUserResponse](./SecurityEnableUserResponse.md)>;` |   || `enableUserProfile` | `enableUserProfile(this: [That](./That.md), params: [SecurityEnableUserProfileRequest](./SecurityEnableUserProfileRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityEnableUserProfileResponse](./SecurityEnableUserProfileResponse.md)>;` | Enable a user profile. Enable user profiles to make them visible in user profile searches. NOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions. Individual users and external applications should not call this API directly. Elastic reserves the right to change or remove this feature in future releases without prior notice. When you activate a user profile, it's automatically enabled and visible in user profile searches. If you later disable the user profile, you can use the enable user profile API to make the profile visible in these searches again. || `enableUserProfile` | `enableUserProfile(this: [That](./That.md), params: [SecurityEnableUserProfileRequest](./SecurityEnableUserProfileRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityEnableUserProfileResponse](./SecurityEnableUserProfileResponse.md), unknown>>;` |   || `enableUserProfile` | `enableUserProfile(this: [That](./That.md), params: [SecurityEnableUserProfileRequest](./SecurityEnableUserProfileRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityEnableUserProfileResponse](./SecurityEnableUserProfileResponse.md)>;` |   || `enrollKibana` | `enrollKibana(this: [That](./That.md), params?: [SecurityEnrollKibanaRequest](./SecurityEnrollKibanaRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityEnrollKibanaResponse](./SecurityEnrollKibanaResponse.md)>;` | Enroll Kibana. Enable a Kibana instance to configure itself for communication with a secured Elasticsearch cluster. NOTE: This API is currently intended for internal use only by Kibana. Kibana uses this API internally to configure itself for communications with an Elasticsearch cluster that already has security features enabled. || `enrollKibana` | `enrollKibana(this: [That](./That.md), params?: [SecurityEnrollKibanaRequest](./SecurityEnrollKibanaRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityEnrollKibanaResponse](./SecurityEnrollKibanaResponse.md), unknown>>;` |   || `enrollKibana` | `enrollKibana(this: [That](./That.md), params?: [SecurityEnrollKibanaRequest](./SecurityEnrollKibanaRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityEnrollKibanaResponse](./SecurityEnrollKibanaResponse.md)>;` |   || `enrollNode` | `enrollNode(this: [That](./That.md), params?: [SecurityEnrollNodeRequest](./SecurityEnrollNodeRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityEnrollNodeResponse](./SecurityEnrollNodeResponse.md)>;` | Enroll a node. Enroll a new node to allow it to join an existing cluster with security features enabled. The response contains all the necessary information for the joining node to bootstrap discovery and security related settings so that it can successfully join the cluster. The response contains key and certificate material that allows the caller to generate valid signed certificates for the HTTP layer of all nodes in the cluster. || `enrollNode` | `enrollNode(this: [That](./That.md), params?: [SecurityEnrollNodeRequest](./SecurityEnrollNodeRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityEnrollNodeResponse](./SecurityEnrollNodeResponse.md), unknown>>;` |   || `enrollNode` | `enrollNode(this: [That](./That.md), params?: [SecurityEnrollNodeRequest](./SecurityEnrollNodeRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityEnrollNodeResponse](./SecurityEnrollNodeResponse.md)>;` |   || `getApiKey` | `getApiKey(this: [That](./That.md), params?: [SecurityGetApiKeyRequest](./SecurityGetApiKeyRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityGetApiKeyResponse](./SecurityGetApiKeyResponse.md)>;` | Get API key information. Retrieves information for one or more API keys. NOTE: If you have only the `manage_own_api_key` privilege, this API returns only the API keys that you own. If you have `read_security`, `manage_api_key` or greater privileges (including `manage_security`), this API returns all API keys regardless of ownership. || `getApiKey` | `getApiKey(this: [That](./That.md), params?: [SecurityGetApiKeyRequest](./SecurityGetApiKeyRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityGetApiKeyResponse](./SecurityGetApiKeyResponse.md), unknown>>;` |   || `getApiKey` | `getApiKey(this: [That](./That.md), params?: [SecurityGetApiKeyRequest](./SecurityGetApiKeyRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityGetApiKeyResponse](./SecurityGetApiKeyResponse.md)>;` |   || `getBuiltinPrivileges` | `getBuiltinPrivileges(this: [That](./That.md), params?: [SecurityGetBuiltinPrivilegesRequest](./SecurityGetBuiltinPrivilegesRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityGetBuiltinPrivilegesResponse](./SecurityGetBuiltinPrivilegesResponse.md)>;` | Get builtin privileges. Get the list of cluster privileges and index privileges that are available in this version of Elasticsearch. || `getBuiltinPrivileges` | `getBuiltinPrivileges(this: [That](./That.md), params?: [SecurityGetBuiltinPrivilegesRequest](./SecurityGetBuiltinPrivilegesRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityGetBuiltinPrivilegesResponse](./SecurityGetBuiltinPrivilegesResponse.md), unknown>>;` |   || `getBuiltinPrivileges` | `getBuiltinPrivileges(this: [That](./That.md), params?: [SecurityGetBuiltinPrivilegesRequest](./SecurityGetBuiltinPrivilegesRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityGetBuiltinPrivilegesResponse](./SecurityGetBuiltinPrivilegesResponse.md)>;` |   || `getPrivileges` | `getPrivileges(this: [That](./That.md), params?: [SecurityGetPrivilegesRequest](./SecurityGetPrivilegesRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityGetPrivilegesResponse](./SecurityGetPrivilegesResponse.md)>;` | Get application privileges. To use this API, you must have one of the following privileges: * The `read_security` cluster privilege (or a greater privilege such as `manage_security` or `all`). * The "Manage Application Privileges" global privilege for the application being referenced in the request. || `getPrivileges` | `getPrivileges(this: [That](./That.md), params?: [SecurityGetPrivilegesRequest](./SecurityGetPrivilegesRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityGetPrivilegesResponse](./SecurityGetPrivilegesResponse.md), unknown>>;` |   || `getPrivileges` | `getPrivileges(this: [That](./That.md), params?: [SecurityGetPrivilegesRequest](./SecurityGetPrivilegesRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityGetPrivilegesResponse](./SecurityGetPrivilegesResponse.md)>;` |   || `getRole` | `getRole(this: [That](./That.md), params?: [SecurityGetRoleRequest](./SecurityGetRoleRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityGetRoleResponse](./SecurityGetRoleResponse.md)>;` | Get roles. Get roles in the native realm. The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. The get roles API cannot retrieve roles that are defined in roles files. || `getRole` | `getRole(this: [That](./That.md), params?: [SecurityGetRoleRequest](./SecurityGetRoleRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityGetRoleResponse](./SecurityGetRoleResponse.md), unknown>>;` |   || `getRole` | `getRole(this: [That](./That.md), params?: [SecurityGetRoleRequest](./SecurityGetRoleRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityGetRoleResponse](./SecurityGetRoleResponse.md)>;` |   || `getRoleMapping` | `getRoleMapping(this: [That](./That.md), params?: [SecurityGetRoleMappingRequest](./SecurityGetRoleMappingRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityGetRoleMappingResponse](./SecurityGetRoleMappingResponse.md)>;` | Get role mappings. Role mappings define which roles are assigned to each user. The role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files. The get role mappings API cannot retrieve role mappings that are defined in role mapping files. || `getRoleMapping` | `getRoleMapping(this: [That](./That.md), params?: [SecurityGetRoleMappingRequest](./SecurityGetRoleMappingRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityGetRoleMappingResponse](./SecurityGetRoleMappingResponse.md), unknown>>;` |   || `getRoleMapping` | `getRoleMapping(this: [That](./That.md), params?: [SecurityGetRoleMappingRequest](./SecurityGetRoleMappingRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityGetRoleMappingResponse](./SecurityGetRoleMappingResponse.md)>;` |   || `getServiceAccounts` | `getServiceAccounts(this: [That](./That.md), params?: [SecurityGetServiceAccountsRequest](./SecurityGetServiceAccountsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityGetServiceAccountsResponse](./SecurityGetServiceAccountsResponse.md)>;` | Get service accounts. Get a list of service accounts that match the provided path parameters. NOTE: Currently, only the `elastic/fleet-server` service account is available. || `getServiceAccounts` | `getServiceAccounts(this: [That](./That.md), params?: [SecurityGetServiceAccountsRequest](./SecurityGetServiceAccountsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityGetServiceAccountsResponse](./SecurityGetServiceAccountsResponse.md), unknown>>;` |   || `getServiceAccounts` | `getServiceAccounts(this: [That](./That.md), params?: [SecurityGetServiceAccountsRequest](./SecurityGetServiceAccountsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityGetServiceAccountsResponse](./SecurityGetServiceAccountsResponse.md)>;` |   || `getServiceCredentials` | `getServiceCredentials(this: [That](./That.md), params: [SecurityGetServiceCredentialsRequest](./SecurityGetServiceCredentialsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityGetServiceCredentialsResponse](./SecurityGetServiceCredentialsResponse.md)>;` | Get service account credentials. To use this API, you must have at least the `read_security` cluster privilege (or a greater privilege such as `manage_service_account` or `manage_security`). The response includes service account tokens that were created with the create service account tokens API as well as file-backed tokens from all nodes of the cluster. NOTE: For tokens backed by the `service_tokens` file, the API collects them from all nodes of the cluster. Tokens with the same name from different nodes are assumed to be the same token and are only counted once towards the total number of service tokens. || `getServiceCredentials` | `getServiceCredentials(this: [That](./That.md), params: [SecurityGetServiceCredentialsRequest](./SecurityGetServiceCredentialsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityGetServiceCredentialsResponse](./SecurityGetServiceCredentialsResponse.md), unknown>>;` |   || `getServiceCredentials` | `getServiceCredentials(this: [That](./That.md), params: [SecurityGetServiceCredentialsRequest](./SecurityGetServiceCredentialsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityGetServiceCredentialsResponse](./SecurityGetServiceCredentialsResponse.md)>;` |   || `getSettings` | `getSettings(this: [That](./That.md), params?: [SecurityGetSettingsRequest](./SecurityGetSettingsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityGetSettingsResponse](./SecurityGetSettingsResponse.md)>;` | Get security index settings. Get the user-configurable settings for the security internal index ( `.security` and associated indices). Only a subset of the index settings — those that are user-configurable—will be shown. This includes: * `index.auto_expand_replicas` * `index.number_of_replicas` || `getSettings` | `getSettings(this: [That](./That.md), params?: [SecurityGetSettingsRequest](./SecurityGetSettingsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityGetSettingsResponse](./SecurityGetSettingsResponse.md), unknown>>;` |   || `getSettings` | `getSettings(this: [That](./That.md), params?: [SecurityGetSettingsRequest](./SecurityGetSettingsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityGetSettingsResponse](./SecurityGetSettingsResponse.md)>;` |   || `getToken` | `getToken(this: [That](./That.md), params?: [SecurityGetTokenRequest](./SecurityGetTokenRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityGetTokenResponse](./SecurityGetTokenResponse.md)>;` | Get a token. Create a bearer token for access without requiring basic authentication. The tokens are created by the Elasticsearch Token Service, which is automatically enabled when you configure TLS on the HTTP interface. Alternatively, you can explicitly enable the `xpack.security.authc.token.enabled` setting. When you are running in production mode, a bootstrap check prevents you from enabling the token service unless you also enable TLS on the HTTP interface. The get token API takes the same parameters as a typical OAuth 2.0 token API except for the use of a JSON request body. A successful get token API call returns a JSON structure that contains the access token, the amount of time (seconds) that the token expires in, the type, and the scope if available. The tokens returned by the get token API have a finite period of time for which they are valid and after that time period, they can no longer be used. That time period is defined by the `xpack.security.authc.token.timeout` setting. If you want to invalidate a token immediately, you can do so by using the invalidate token API. || `getToken` | `getToken(this: [That](./That.md), params?: [SecurityGetTokenRequest](./SecurityGetTokenRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityGetTokenResponse](./SecurityGetTokenResponse.md), unknown>>;` |   || `getToken` | `getToken(this: [That](./That.md), params?: [SecurityGetTokenRequest](./SecurityGetTokenRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityGetTokenResponse](./SecurityGetTokenResponse.md)>;` |   || `getUser` | `getUser(this: [That](./That.md), params?: [SecurityGetUserRequest](./SecurityGetUserRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityGetUserResponse](./SecurityGetUserResponse.md)>;` | Get users. Get information about users in the native realm and built-in users. || `getUser` | `getUser(this: [That](./That.md), params?: [SecurityGetUserRequest](./SecurityGetUserRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityGetUserResponse](./SecurityGetUserResponse.md), unknown>>;` |   || `getUser` | `getUser(this: [That](./That.md), params?: [SecurityGetUserRequest](./SecurityGetUserRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityGetUserResponse](./SecurityGetUserResponse.md)>;` |   || `getUserPrivileges` | `getUserPrivileges(this: [That](./That.md), params?: [SecurityGetUserPrivilegesRequest](./SecurityGetUserPrivilegesRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityGetUserPrivilegesResponse](./SecurityGetUserPrivilegesResponse.md)>;` | Get user privileges. Get the security privileges for the logged in user. All users can use this API, but only to determine their own privileges. To check the privileges of other users, you must use the run as feature. To check whether a user has a specific list of privileges, use the has privileges API. || `getUserPrivileges` | `getUserPrivileges(this: [That](./That.md), params?: [SecurityGetUserPrivilegesRequest](./SecurityGetUserPrivilegesRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityGetUserPrivilegesResponse](./SecurityGetUserPrivilegesResponse.md), unknown>>;` |   || `getUserPrivileges` | `getUserPrivileges(this: [That](./That.md), params?: [SecurityGetUserPrivilegesRequest](./SecurityGetUserPrivilegesRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityGetUserPrivilegesResponse](./SecurityGetUserPrivilegesResponse.md)>;` |   || `getUserProfile` | `getUserProfile(this: [That](./That.md), params: [SecurityGetUserProfileRequest](./SecurityGetUserProfileRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityGetUserProfileResponse](./SecurityGetUserProfileResponse.md)>;` | Get a user profile. Get a user's profile using the unique profile ID. NOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions. Individual users and external applications should not call this API directly. Elastic reserves the right to change or remove this feature in future releases without prior notice. || `getUserProfile` | `getUserProfile(this: [That](./That.md), params: [SecurityGetUserProfileRequest](./SecurityGetUserProfileRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityGetUserProfileResponse](./SecurityGetUserProfileResponse.md), unknown>>;` |   || `getUserProfile` | `getUserProfile(this: [That](./That.md), params: [SecurityGetUserProfileRequest](./SecurityGetUserProfileRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityGetUserProfileResponse](./SecurityGetUserProfileResponse.md)>;` |   || `grantApiKey` | `grantApiKey(this: [That](./That.md), params: [SecurityGrantApiKeyRequest](./SecurityGrantApiKeyRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityGrantApiKeyResponse](./SecurityGrantApiKeyResponse.md)>;` | Grant an API key. Create an API key on behalf of another user. This API is similar to the create API keys API, however it creates the API key for a user that is different than the user that runs the API. The caller must have authentication credentials for the user on whose behalf the API key will be created. It is not possible to use this API to create an API key without that user's credentials. The supported user authentication credential types are: * username and password * Elasticsearch access tokens * JWTs The user, for whom the authentication credentials is provided, can optionally "run as" (impersonate) another user. In this case, the API key will be created on behalf of the impersonated user. This API is intended be used by applications that need to create and manage API keys for end users, but cannot guarantee that those users have permission to create API keys on their own behalf. The API keys are created by the Elasticsearch API key service, which is automatically enabled. A successful grant API key API call returns a JSON structure that contains the API key, its unique id, and its name. If applicable, it also returns expiration information for the API key in milliseconds. By default, API keys never expire. You can specify expiration information when you create the API keys. || `grantApiKey` | `grantApiKey(this: [That](./That.md), params: [SecurityGrantApiKeyRequest](./SecurityGrantApiKeyRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityGrantApiKeyResponse](./SecurityGrantApiKeyResponse.md), unknown>>;` |   || `grantApiKey` | `grantApiKey(this: [That](./That.md), params: [SecurityGrantApiKeyRequest](./SecurityGrantApiKeyRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityGrantApiKeyResponse](./SecurityGrantApiKeyResponse.md)>;` |   || `hasPrivileges` | `hasPrivileges(this: [That](./That.md), params?: [SecurityHasPrivilegesRequest](./SecurityHasPrivilegesRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityHasPrivilegesResponse](./SecurityHasPrivilegesResponse.md)>;` | Check user privileges. Determine whether the specified user has a specified list of privileges. All users can use this API, but only to determine their own privileges. To check the privileges of other users, you must use the run as feature. || `hasPrivileges` | `hasPrivileges(this: [That](./That.md), params?: [SecurityHasPrivilegesRequest](./SecurityHasPrivilegesRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityHasPrivilegesResponse](./SecurityHasPrivilegesResponse.md), unknown>>;` |   || `hasPrivileges` | `hasPrivileges(this: [That](./That.md), params?: [SecurityHasPrivilegesRequest](./SecurityHasPrivilegesRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityHasPrivilegesResponse](./SecurityHasPrivilegesResponse.md)>;` |   || `hasPrivilegesUserProfile` | `hasPrivilegesUserProfile(this: [That](./That.md), params: [SecurityHasPrivilegesUserProfileRequest](./SecurityHasPrivilegesUserProfileRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityHasPrivilegesUserProfileResponse](./SecurityHasPrivilegesUserProfileResponse.md)>;` | Check user profile privileges. Determine whether the users associated with the specified user profile IDs have all the requested privileges. NOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions. Individual users and external applications should not call this API directly. Elastic reserves the right to change or remove this feature in future releases without prior notice. || `hasPrivilegesUserProfile` | `hasPrivilegesUserProfile(this: [That](./That.md), params: [SecurityHasPrivilegesUserProfileRequest](./SecurityHasPrivilegesUserProfileRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityHasPrivilegesUserProfileResponse](./SecurityHasPrivilegesUserProfileResponse.md), unknown>>;` |   || `hasPrivilegesUserProfile` | `hasPrivilegesUserProfile(this: [That](./That.md), params: [SecurityHasPrivilegesUserProfileRequest](./SecurityHasPrivilegesUserProfileRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityHasPrivilegesUserProfileResponse](./SecurityHasPrivilegesUserProfileResponse.md)>;` |   || `invalidateApiKey` | `invalidateApiKey(this: [That](./That.md), params?: [SecurityInvalidateApiKeyRequest](./SecurityInvalidateApiKeyRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityInvalidateApiKeyResponse](./SecurityInvalidateApiKeyResponse.md)>;` | Invalidate API keys. This API invalidates API keys created by the create API key or grant API key APIs. Invalidated API keys fail authentication, but they can still be viewed using the get API key information and query API key information APIs, for at least the configured retention period, until they are automatically deleted. To use this API, you must have at least the `manage_security`, `manage_api_key`, or `manage_own_api_key` cluster privileges. The `manage_security` privilege allows deleting any API key, including both REST and cross cluster API keys. The `manage_api_key` privilege allows deleting any REST API key, but not cross cluster API keys. The `manage_own_api_key` only allows deleting REST API keys that are owned by the user. In addition, with the `manage_own_api_key` privilege, an invalidation request must be issued in one of the three formats: - Set the parameter `owner=true`. - Or, set both `username` and `realm_name` to match the user's identity. - Or, if the request is issued by an API key, that is to say an API key invalidates itself, specify its ID in the `ids` field. || `invalidateApiKey` | `invalidateApiKey(this: [That](./That.md), params?: [SecurityInvalidateApiKeyRequest](./SecurityInvalidateApiKeyRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityInvalidateApiKeyResponse](./SecurityInvalidateApiKeyResponse.md), unknown>>;` |   || `invalidateApiKey` | `invalidateApiKey(this: [That](./That.md), params?: [SecurityInvalidateApiKeyRequest](./SecurityInvalidateApiKeyRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityInvalidateApiKeyResponse](./SecurityInvalidateApiKeyResponse.md)>;` |   || `invalidateToken` | `invalidateToken(this: [That](./That.md), params?: [SecurityInvalidateTokenRequest](./SecurityInvalidateTokenRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityInvalidateTokenResponse](./SecurityInvalidateTokenResponse.md)>;` | Invalidate a token. The access tokens returned by the get token API have a finite period of time for which they are valid. After that time period, they can no longer be used. The time period is defined by the `xpack.security.authc.token.timeout` setting. The refresh tokens returned by the get token API are only valid for 24 hours. They can also be used exactly once. If you want to invalidate one or more access or refresh tokens immediately, use this invalidate token API. NOTE: While all parameters are optional, at least one of them is required. More specifically, either one of `token` or `refresh_token` parameters is required. If none of these two are specified, then `realm_name` and/or `username` need to be specified. || `invalidateToken` | `invalidateToken(this: [That](./That.md), params?: [SecurityInvalidateTokenRequest](./SecurityInvalidateTokenRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityInvalidateTokenResponse](./SecurityInvalidateTokenResponse.md), unknown>>;` |   || `invalidateToken` | `invalidateToken(this: [That](./That.md), params?: [SecurityInvalidateTokenRequest](./SecurityInvalidateTokenRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityInvalidateTokenResponse](./SecurityInvalidateTokenResponse.md)>;` |   || `oidcAuthenticate` | `oidcAuthenticate(this: [That](./That.md), params: [SecurityOidcAuthenticateRequest](./SecurityOidcAuthenticateRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityOidcAuthenticateResponse](./SecurityOidcAuthenticateResponse.md)>;` | Authenticate OpenID Connect. Exchange an OpenID Connect authentication response message for an Elasticsearch internal access token and refresh token that can be subsequently used for authentication. Elasticsearch exposes all the necessary OpenID Connect related functionality with the OpenID Connect APIs. These APIs are used internally by Kibana in order to provide OpenID Connect based authentication, but can also be used by other, custom web applications or other clients. || `oidcAuthenticate` | `oidcAuthenticate(this: [That](./That.md), params: [SecurityOidcAuthenticateRequest](./SecurityOidcAuthenticateRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityOidcAuthenticateResponse](./SecurityOidcAuthenticateResponse.md), unknown>>;` |   || `oidcAuthenticate` | `oidcAuthenticate(this: [That](./That.md), params: [SecurityOidcAuthenticateRequest](./SecurityOidcAuthenticateRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityOidcAuthenticateResponse](./SecurityOidcAuthenticateResponse.md)>;` |   || `oidcLogout` | `oidcLogout(this: [That](./That.md), params: [SecurityOidcLogoutRequest](./SecurityOidcLogoutRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityOidcLogoutResponse](./SecurityOidcLogoutResponse.md)>;` | Logout of OpenID Connect. Invalidate an access token and a refresh token that were generated as a response to the `/_security/oidc/authenticate` API. If the OpenID Connect authentication realm in Elasticsearch is accordingly configured, the response to this call will contain a URI pointing to the end session endpoint of the OpenID Connect Provider in order to perform single logout. Elasticsearch exposes all the necessary OpenID Connect related functionality with the OpenID Connect APIs. These APIs are used internally by Kibana in order to provide OpenID Connect based authentication, but can also be used by other, custom web applications or other clients. || `oidcLogout` | `oidcLogout(this: [That](./That.md), params: [SecurityOidcLogoutRequest](./SecurityOidcLogoutRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityOidcLogoutResponse](./SecurityOidcLogoutResponse.md), unknown>>;` |   || `oidcLogout` | `oidcLogout(this: [That](./That.md), params: [SecurityOidcLogoutRequest](./SecurityOidcLogoutRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityOidcLogoutResponse](./SecurityOidcLogoutResponse.md)>;` |   || `oidcPrepareAuthentication` | `oidcPrepareAuthentication(this: [That](./That.md), params?: [SecurityOidcPrepareAuthenticationRequest](./SecurityOidcPrepareAuthenticationRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityOidcPrepareAuthenticationResponse](./SecurityOidcPrepareAuthenticationResponse.md)>;` | Prepare OpenID connect authentication. Create an oAuth 2.0 authentication request as a URL string based on the configuration of the OpenID Connect authentication realm in Elasticsearch. The response of this API is a URL pointing to the Authorization Endpoint of the configured OpenID Connect Provider, which can be used to redirect the browser of the user in order to continue the authentication process. Elasticsearch exposes all the necessary OpenID Connect related functionality with the OpenID Connect APIs. These APIs are used internally by Kibana in order to provide OpenID Connect based authentication, but can also be used by other, custom web applications or other clients. || `oidcPrepareAuthentication` | `oidcPrepareAuthentication(this: [That](./That.md), params?: [SecurityOidcPrepareAuthenticationRequest](./SecurityOidcPrepareAuthenticationRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityOidcPrepareAuthenticationResponse](./SecurityOidcPrepareAuthenticationResponse.md), unknown>>;` |   || `oidcPrepareAuthentication` | `oidcPrepareAuthentication(this: [That](./That.md), params?: [SecurityOidcPrepareAuthenticationRequest](./SecurityOidcPrepareAuthenticationRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityOidcPrepareAuthenticationResponse](./SecurityOidcPrepareAuthenticationResponse.md)>;` |   || `putPrivileges` | `putPrivileges(this: [That](./That.md), params: [SecurityPutPrivilegesRequest](./SecurityPutPrivilegesRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityPutPrivilegesResponse](./SecurityPutPrivilegesResponse.md)>;` | Create or update application privileges. To use this API, you must have one of the following privileges: * The `manage_security` cluster privilege (or a greater privilege such as `all`). * The "Manage Application Privileges" global privilege for the application being referenced in the request. Application names are formed from a prefix, with an optional suffix that conform to the following rules: * The prefix must begin with a lowercase ASCII letter. * The prefix must contain only ASCII letters or digits. * The prefix must be at least 3 characters long. * If the suffix exists, it must begin with either a dash `-` or `_`. * The suffix cannot contain any of the following characters: `\`, `/`, `*`, `?`, `"`, `<`, `>`, `|`, `,`, `*`. * No part of the name can contain whitespace. Privilege names must begin with a lowercase ASCII letter and must contain only ASCII letters and digits along with the characters `_`, `-`, and `.`. Action names can contain any number of printable ASCII characters and must contain at least one of the following characters: `/`, `*`, `:`. || `putPrivileges` | `putPrivileges(this: [That](./That.md), params: [SecurityPutPrivilegesRequest](./SecurityPutPrivilegesRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityPutPrivilegesResponse](./SecurityPutPrivilegesResponse.md), unknown>>;` |   || `putPrivileges` | `putPrivileges(this: [That](./That.md), params: [SecurityPutPrivilegesRequest](./SecurityPutPrivilegesRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityPutPrivilegesResponse](./SecurityPutPrivilegesResponse.md)>;` |   || `putRole` | `putRole(this: [That](./That.md), params: [SecurityPutRoleRequest](./SecurityPutRoleRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityPutRoleResponse](./SecurityPutRoleResponse.md)>;` | Create or update roles. The role management APIs are generally the preferred way to manage roles in the native realm, rather than using file-based role management. The create or update roles API cannot update roles that are defined in roles files. File-based role management is not available in Elastic Serverless. || `putRole` | `putRole(this: [That](./That.md), params: [SecurityPutRoleRequest](./SecurityPutRoleRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityPutRoleResponse](./SecurityPutRoleResponse.md), unknown>>;` |   || `putRole` | `putRole(this: [That](./That.md), params: [SecurityPutRoleRequest](./SecurityPutRoleRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityPutRoleResponse](./SecurityPutRoleResponse.md)>;` |   || `putRoleMapping` | `putRoleMapping(this: [That](./That.md), params: [SecurityPutRoleMappingRequest](./SecurityPutRoleMappingRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityPutRoleMappingResponse](./SecurityPutRoleMappingResponse.md)>;` | Create or update role mappings. Role mappings define which roles are assigned to each user. Each mapping has rules that identify users and a list of roles that are granted to those users. The role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files. The create or update role mappings API cannot update role mappings that are defined in role mapping files. NOTE: This API does not create roles. Rather, it maps users to existing roles. Roles can be created by using the create or update roles API or roles files. **Role templates** The most common use for role mappings is to create a mapping from a known value on the user to a fixed role name. For example, all users in the `cn=admin,dc=example,dc=com` LDAP group should be given the superuser role in Elasticsearch. The `roles` field is used for this purpose. For more complex needs, it is possible to use Mustache templates to dynamically determine the names of the roles that should be granted to the user. The `role_templates` field is used for this purpose. NOTE: To use role templates successfully, the relevant scripting feature must be enabled. Otherwise, all attempts to create a role mapping with role templates fail. All of the user fields that are available in the role mapping rules are also available in the role templates. Thus it is possible to assign a user to a role that reflects their username, their groups, or the name of the realm to which they authenticated. By default a template is evaluated to produce a single string that is the name of the role which should be assigned to the user. If the format of the template is set to "json" then the template is expected to produce a JSON string or an array of JSON strings for the role names. || `putRoleMapping` | `putRoleMapping(this: [That](./That.md), params: [SecurityPutRoleMappingRequest](./SecurityPutRoleMappingRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityPutRoleMappingResponse](./SecurityPutRoleMappingResponse.md), unknown>>;` |   || `putRoleMapping` | `putRoleMapping(this: [That](./That.md), params: [SecurityPutRoleMappingRequest](./SecurityPutRoleMappingRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityPutRoleMappingResponse](./SecurityPutRoleMappingResponse.md)>;` |   || `putUser` | `putUser(this: [That](./That.md), params: [SecurityPutUserRequest](./SecurityPutUserRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityPutUserResponse](./SecurityPutUserResponse.md)>;` | Create or update users. Add and update users in the native realm. A password is required for adding a new user but is optional when updating an existing user. To change a user's password without updating any other fields, use the change password API. || `putUser` | `putUser(this: [That](./That.md), params: [SecurityPutUserRequest](./SecurityPutUserRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityPutUserResponse](./SecurityPutUserResponse.md), unknown>>;` |   || `putUser` | `putUser(this: [That](./That.md), params: [SecurityPutUserRequest](./SecurityPutUserRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityPutUserResponse](./SecurityPutUserResponse.md)>;` |   || `queryApiKeys` | `queryApiKeys(this: [That](./That.md), params?: [SecurityQueryApiKeysRequest](./SecurityQueryApiKeysRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityQueryApiKeysResponse](./SecurityQueryApiKeysResponse.md)>;` | Find API keys with a query. Get a paginated list of API keys and their information. You can optionally filter the results with a query. To use this API, you must have at least the `manage_own_api_key` or the `read_security` cluster privileges. If you have only the `manage_own_api_key` privilege, this API returns only the API keys that you own. If you have the `read_security`, `manage_api_key`, or greater privileges (including `manage_security`), this API returns all API keys regardless of ownership. || `queryApiKeys` | `queryApiKeys(this: [That](./That.md), params?: [SecurityQueryApiKeysRequest](./SecurityQueryApiKeysRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityQueryApiKeysResponse](./SecurityQueryApiKeysResponse.md), unknown>>;` |   || `queryApiKeys` | `queryApiKeys(this: [That](./That.md), params?: [SecurityQueryApiKeysRequest](./SecurityQueryApiKeysRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityQueryApiKeysResponse](./SecurityQueryApiKeysResponse.md)>;` |   || `queryRole` | `queryRole(this: [That](./That.md), params?: [SecurityQueryRoleRequest](./SecurityQueryRoleRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityQueryRoleResponse](./SecurityQueryRoleResponse.md)>;` | Find roles with a query. Get roles in a paginated manner. The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. The query roles API does not retrieve roles that are defined in roles files, nor built-in ones. You can optionally filter the results with a query. Also, the results can be paginated and sorted. || `queryRole` | `queryRole(this: [That](./That.md), params?: [SecurityQueryRoleRequest](./SecurityQueryRoleRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityQueryRoleResponse](./SecurityQueryRoleResponse.md), unknown>>;` |   || `queryRole` | `queryRole(this: [That](./That.md), params?: [SecurityQueryRoleRequest](./SecurityQueryRoleRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityQueryRoleResponse](./SecurityQueryRoleResponse.md)>;` |   || `queryUser` | `queryUser(this: [That](./That.md), params?: [SecurityQueryUserRequest](./SecurityQueryUserRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityQueryUserResponse](./SecurityQueryUserResponse.md)>;` | Find users with a query. Get information for users in a paginated manner. You can optionally filter the results with a query. NOTE: As opposed to the get user API, built-in users are excluded from the result. This API is only for native users. || `queryUser` | `queryUser(this: [That](./That.md), params?: [SecurityQueryUserRequest](./SecurityQueryUserRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityQueryUserResponse](./SecurityQueryUserResponse.md), unknown>>;` |   || `queryUser` | `queryUser(this: [That](./That.md), params?: [SecurityQueryUserRequest](./SecurityQueryUserRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityQueryUserResponse](./SecurityQueryUserResponse.md)>;` |   || `samlAuthenticate` | `samlAuthenticate(this: [That](./That.md), params: [SecuritySamlAuthenticateRequest](./SecuritySamlAuthenticateRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecuritySamlAuthenticateResponse](./SecuritySamlAuthenticateResponse.md)>;` | Authenticate SAML. Submit a SAML response message to Elasticsearch for consumption. NOTE: This API is intended for use by custom web applications other than Kibana. If you are using Kibana, refer to the documentation for configuring SAML single-sign-on on the Elastic Stack. The SAML message that is submitted can be: * A response to a SAML authentication request that was previously created using the SAML prepare authentication API. * An unsolicited SAML message in the case of an IdP-initiated single sign-on (SSO) flow. In either case, the SAML message needs to be a base64 encoded XML document with a root element of ``. After successful validation, Elasticsearch responds with an Elasticsearch internal access token and refresh token that can be subsequently used for authentication. This API endpoint essentially exchanges SAML responses that indicate successful authentication in the IdP for Elasticsearch access and refresh tokens, which can be used for authentication against Elasticsearch. || `samlAuthenticate` | `samlAuthenticate(this: [That](./That.md), params: [SecuritySamlAuthenticateRequest](./SecuritySamlAuthenticateRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecuritySamlAuthenticateResponse](./SecuritySamlAuthenticateResponse.md), unknown>>;` |   || `samlAuthenticate` | `samlAuthenticate(this: [That](./That.md), params: [SecuritySamlAuthenticateRequest](./SecuritySamlAuthenticateRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecuritySamlAuthenticateResponse](./SecuritySamlAuthenticateResponse.md)>;` |   || `samlCompleteLogout` | `samlCompleteLogout(this: [That](./That.md), params: [SecuritySamlCompleteLogoutRequest](./SecuritySamlCompleteLogoutRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecuritySamlCompleteLogoutResponse](./SecuritySamlCompleteLogoutResponse.md)>;` | Logout of SAML completely. Verifies the logout response sent from the SAML IdP. NOTE: This API is intended for use by custom web applications other than Kibana. If you are using Kibana, refer to the documentation for configuring SAML single-sign-on on the Elastic Stack. The SAML IdP may send a logout response back to the SP after handling the SP-initiated SAML Single Logout. This API verifies the response by ensuring the content is relevant and validating its signature. An empty response is returned if the verification process is successful. The response can be sent by the IdP with either the HTTP-Redirect or the HTTP-Post binding. The caller of this API must prepare the request accordingly so that this API can handle either of them. || `samlCompleteLogout` | `samlCompleteLogout(this: [That](./That.md), params: [SecuritySamlCompleteLogoutRequest](./SecuritySamlCompleteLogoutRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecuritySamlCompleteLogoutResponse](./SecuritySamlCompleteLogoutResponse.md), unknown>>;` |   || `samlCompleteLogout` | `samlCompleteLogout(this: [That](./That.md), params: [SecuritySamlCompleteLogoutRequest](./SecuritySamlCompleteLogoutRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecuritySamlCompleteLogoutResponse](./SecuritySamlCompleteLogoutResponse.md)>;` |   || `samlInvalidate` | `samlInvalidate(this: [That](./That.md), params: [SecuritySamlInvalidateRequest](./SecuritySamlInvalidateRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecuritySamlInvalidateResponse](./SecuritySamlInvalidateResponse.md)>;` | Invalidate SAML. Submit a SAML LogoutRequest message to Elasticsearch for consumption. NOTE: This API is intended for use by custom web applications other than Kibana. If you are using Kibana, refer to the documentation for configuring SAML single-sign-on on the Elastic Stack. The logout request comes from the SAML IdP during an IdP initiated Single Logout. The custom web application can use this API to have Elasticsearch process the `LogoutRequest`. After successful validation of the request, Elasticsearch invalidates the access token and refresh token that corresponds to that specific SAML principal and provides a URL that contains a SAML LogoutResponse message. Thus the user can be redirected back to their IdP. || `samlInvalidate` | `samlInvalidate(this: [That](./That.md), params: [SecuritySamlInvalidateRequest](./SecuritySamlInvalidateRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecuritySamlInvalidateResponse](./SecuritySamlInvalidateResponse.md), unknown>>;` |   || `samlInvalidate` | `samlInvalidate(this: [That](./That.md), params: [SecuritySamlInvalidateRequest](./SecuritySamlInvalidateRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecuritySamlInvalidateResponse](./SecuritySamlInvalidateResponse.md)>;` |   || `samlLogout` | `samlLogout(this: [That](./That.md), params: [SecuritySamlLogoutRequest](./SecuritySamlLogoutRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecuritySamlLogoutResponse](./SecuritySamlLogoutResponse.md)>;` | Logout of SAML. Submits a request to invalidate an access token and refresh token. NOTE: This API is intended for use by custom web applications other than Kibana. If you are using Kibana, refer to the documentation for configuring SAML single-sign-on on the Elastic Stack. This API invalidates the tokens that were generated for a user by the SAML authenticate API. If the SAML realm in Elasticsearch is configured accordingly and the SAML IdP supports this, the Elasticsearch response contains a URL to redirect the user to the IdP that contains a SAML logout request (starting an SP-initiated SAML Single Logout). || `samlLogout` | `samlLogout(this: [That](./That.md), params: [SecuritySamlLogoutRequest](./SecuritySamlLogoutRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecuritySamlLogoutResponse](./SecuritySamlLogoutResponse.md), unknown>>;` |   || `samlLogout` | `samlLogout(this: [That](./That.md), params: [SecuritySamlLogoutRequest](./SecuritySamlLogoutRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecuritySamlLogoutResponse](./SecuritySamlLogoutResponse.md)>;` |   || `samlPrepareAuthentication` | `samlPrepareAuthentication(this: [That](./That.md), params?: [SecuritySamlPrepareAuthenticationRequest](./SecuritySamlPrepareAuthenticationRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecuritySamlPrepareAuthenticationResponse](./SecuritySamlPrepareAuthenticationResponse.md)>;` | Prepare SAML authentication. Create a SAML authentication request ( ``) as a URL string based on the configuration of the respective SAML realm in Elasticsearch. NOTE: This API is intended for use by custom web applications other than Kibana. If you are using Kibana, refer to the documentation for configuring SAML single-sign-on on the Elastic Stack. This API returns a URL pointing to the SAML Identity Provider. You can use the URL to redirect the browser of the user in order to continue the authentication process. The URL includes a single parameter named `SAMLRequest`, which contains a SAML Authentication request that is deflated and Base64 encoded. If the configuration dictates that SAML authentication requests should be signed, the URL has two extra parameters named `SigAlg` and `Signature`. These parameters contain the algorithm used for the signature and the signature value itself. It also returns a random string that uniquely identifies this SAML Authentication request. The caller of this API needs to store this identifier as it needs to be used in a following step of the authentication process. || `samlPrepareAuthentication` | `samlPrepareAuthentication(this: [That](./That.md), params?: [SecuritySamlPrepareAuthenticationRequest](./SecuritySamlPrepareAuthenticationRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecuritySamlPrepareAuthenticationResponse](./SecuritySamlPrepareAuthenticationResponse.md), unknown>>;` |   || `samlPrepareAuthentication` | `samlPrepareAuthentication(this: [That](./That.md), params?: [SecuritySamlPrepareAuthenticationRequest](./SecuritySamlPrepareAuthenticationRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecuritySamlPrepareAuthenticationResponse](./SecuritySamlPrepareAuthenticationResponse.md)>;` |   || `samlServiceProviderMetadata` | `samlServiceProviderMetadata(this: [That](./That.md), params: [SecuritySamlServiceProviderMetadataRequest](./SecuritySamlServiceProviderMetadataRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecuritySamlServiceProviderMetadataResponse](./SecuritySamlServiceProviderMetadataResponse.md)>;` | Create SAML service provider metadata. Generate SAML metadata for a SAML 2.0 Service Provider. The SAML 2.0 specification provides a mechanism for Service Providers to describe their capabilities and configuration using a metadata file. This API generates Service Provider metadata based on the configuration of a SAML realm in Elasticsearch. || `samlServiceProviderMetadata` | `samlServiceProviderMetadata(this: [That](./That.md), params: [SecuritySamlServiceProviderMetadataRequest](./SecuritySamlServiceProviderMetadataRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecuritySamlServiceProviderMetadataResponse](./SecuritySamlServiceProviderMetadataResponse.md), unknown>>;` |   || `samlServiceProviderMetadata` | `samlServiceProviderMetadata(this: [That](./That.md), params: [SecuritySamlServiceProviderMetadataRequest](./SecuritySamlServiceProviderMetadataRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecuritySamlServiceProviderMetadataResponse](./SecuritySamlServiceProviderMetadataResponse.md)>;` |   || `suggestUserProfiles` | `suggestUserProfiles(this: [That](./That.md), params?: [SecuritySuggestUserProfilesRequest](./SecuritySuggestUserProfilesRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecuritySuggestUserProfilesResponse](./SecuritySuggestUserProfilesResponse.md)>;` | Suggest a user profile. Get suggestions for user profiles that match specified search criteria. NOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions. Individual users and external applications should not call this API directly. Elastic reserves the right to change or remove this feature in future releases without prior notice. || `suggestUserProfiles` | `suggestUserProfiles(this: [That](./That.md), params?: [SecuritySuggestUserProfilesRequest](./SecuritySuggestUserProfilesRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecuritySuggestUserProfilesResponse](./SecuritySuggestUserProfilesResponse.md), unknown>>;` |   || `suggestUserProfiles` | `suggestUserProfiles(this: [That](./That.md), params?: [SecuritySuggestUserProfilesRequest](./SecuritySuggestUserProfilesRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecuritySuggestUserProfilesResponse](./SecuritySuggestUserProfilesResponse.md)>;` |   || `updateApiKey` | `updateApiKey(this: [That](./That.md), params: [SecurityUpdateApiKeyRequest](./SecurityUpdateApiKeyRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityUpdateApiKeyResponse](./SecurityUpdateApiKeyResponse.md)>;` | Update an API key. Update attributes of an existing API key. This API supports updates to an API key's access scope, expiration, and metadata. To use this API, you must have at least the `manage_own_api_key` cluster privilege. Users can only update API keys that they created or that were granted to them. To update another user’s API key, use the `run_as` feature to submit a request on behalf of another user. IMPORTANT: It's not possible to use an API key as the authentication credential for this API. The owner user’s credentials are required. Use this API to update API keys created by the create API key or grant API Key APIs. If you need to apply the same update to many API keys, you can use the bulk update API keys API to reduce overhead. It's not possible to update expired API keys or API keys that have been invalidated by the invalidate API key API. The access scope of an API key is derived from the `role_descriptors` you specify in the request and a snapshot of the owner user's permissions at the time of the request. The snapshot of the owner's permissions is updated automatically on every call. IMPORTANT: If you don't specify `role_descriptors` in the request, a call to this API might still change the API key's access scope. This change can occur if the owner user's permissions have changed since the API key was created or last modified. || `updateApiKey` | `updateApiKey(this: [That](./That.md), params: [SecurityUpdateApiKeyRequest](./SecurityUpdateApiKeyRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityUpdateApiKeyResponse](./SecurityUpdateApiKeyResponse.md), unknown>>;` |   || `updateApiKey` | `updateApiKey(this: [That](./That.md), params: [SecurityUpdateApiKeyRequest](./SecurityUpdateApiKeyRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityUpdateApiKeyResponse](./SecurityUpdateApiKeyResponse.md)>;` |   || `updateCrossClusterApiKey` | `updateCrossClusterApiKey(this: [That](./That.md), params: [SecurityUpdateCrossClusterApiKeyRequest](./SecurityUpdateCrossClusterApiKeyRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityUpdateCrossClusterApiKeyResponse](./SecurityUpdateCrossClusterApiKeyResponse.md)>;` | Update a cross-cluster API key. Update the attributes of an existing cross-cluster API key, which is used for API key based remote cluster access. To use this API, you must have at least the `manage_security` cluster privilege. Users can only update API keys that they created. To update another user's API key, use the `run_as` feature to submit a request on behalf of another user. IMPORTANT: It's not possible to use an API key as the authentication credential for this API. To update an API key, the owner user's credentials are required. It's not possible to update expired API keys, or API keys that have been invalidated by the invalidate API key API. This API supports updates to an API key's access scope, metadata, and expiration. The owner user's information, such as the `username` and `realm`, is also updated automatically on every call. NOTE: This API cannot update REST API keys, which should be updated by either the update API key or bulk update API keys API. || `updateCrossClusterApiKey` | `updateCrossClusterApiKey(this: [That](./That.md), params: [SecurityUpdateCrossClusterApiKeyRequest](./SecurityUpdateCrossClusterApiKeyRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityUpdateCrossClusterApiKeyResponse](./SecurityUpdateCrossClusterApiKeyResponse.md), unknown>>;` |   || `updateCrossClusterApiKey` | `updateCrossClusterApiKey(this: [That](./That.md), params: [SecurityUpdateCrossClusterApiKeyRequest](./SecurityUpdateCrossClusterApiKeyRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityUpdateCrossClusterApiKeyResponse](./SecurityUpdateCrossClusterApiKeyResponse.md)>;` |   || `updateSettings` | `updateSettings(this: [That](./That.md), params?: [SecurityUpdateSettingsRequest](./SecurityUpdateSettingsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityUpdateSettingsResponse](./SecurityUpdateSettingsResponse.md)>;` | Update security index settings. Update the user-configurable settings for the security internal index ( `.security` and associated indices). Only a subset of settings are allowed to be modified. This includes `index.auto_expand_replicas` and `index.number_of_replicas`. NOTE: If `index.auto_expand_replicas` is set, `index.number_of_replicas` will be ignored during updates. If a specific index is not in use on the system and settings are provided for it, the request will be rejected. This API does not yet support configuring the settings for indices before they are in use. || `updateSettings` | `updateSettings(this: [That](./That.md), params?: [SecurityUpdateSettingsRequest](./SecurityUpdateSettingsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityUpdateSettingsResponse](./SecurityUpdateSettingsResponse.md), unknown>>;` |   || `updateSettings` | `updateSettings(this: [That](./That.md), params?: [SecurityUpdateSettingsRequest](./SecurityUpdateSettingsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityUpdateSettingsResponse](./SecurityUpdateSettingsResponse.md)>;` |   || `updateUserProfileData` | `updateUserProfileData(this: [That](./That.md), params: [SecurityUpdateUserProfileDataRequest](./SecurityUpdateUserProfileDataRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityUpdateUserProfileDataResponse](./SecurityUpdateUserProfileDataResponse.md)>;` | Update user profile data. Update specific data for the user profile that is associated with a unique ID. NOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions. Individual users and external applications should not call this API directly. Elastic reserves the right to change or remove this feature in future releases without prior notice. To use this API, you must have one of the following privileges: * The `manage_user_profile` cluster privilege. * The `update_profile_data` global privilege for the namespaces that are referenced in the request. This API updates the `labels` and `data` fields of an existing user profile document with JSON objects. New keys and their values are added to the profile document and conflicting keys are replaced by data that's included in the request. For both labels and data, content is namespaced by the top-level fields. The `update_profile_data` global privilege grants privileges for updating only the allowed namespaces. || `updateUserProfileData` | `updateUserProfileData(this: [That](./That.md), params: [SecurityUpdateUserProfileDataRequest](./SecurityUpdateUserProfileDataRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityUpdateUserProfileDataResponse](./SecurityUpdateUserProfileDataResponse.md), unknown>>;` |   || `updateUserProfileData` | `updateUserProfileData(this: [That](./That.md), params: [SecurityUpdateUserProfileDataRequest](./SecurityUpdateUserProfileDataRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityUpdateUserProfileDataResponse](./SecurityUpdateUserProfileDataResponse.md)>;` |   | \ No newline at end of file diff --git a/docs/reference/api/SecurityAccess.md b/docs/reference/api/SecurityAccess.md new file mode 100644 index 000000000..5196ea6f8 --- /dev/null +++ b/docs/reference/api/SecurityAccess.md @@ -0,0 +1,6 @@ +## Interface `SecurityAccess` + +| Name | Type | Description | +| - | - | - | +| `replication` | [SecurityReplicationAccess](./SecurityReplicationAccess.md)[] | A list of indices permission entries for cross-cluster replication. | +| `search` | [SecuritySearchAccess](./SecuritySearchAccess.md)[] | A list of indices permission entries for cross-cluster search. | diff --git a/docs/reference/api/SecurityActivateUserProfileRequest.md b/docs/reference/api/SecurityActivateUserProfileRequest.md new file mode 100644 index 000000000..d0c8f40ca --- /dev/null +++ b/docs/reference/api/SecurityActivateUserProfileRequest.md @@ -0,0 +1,10 @@ +## Interface `SecurityActivateUserProfileRequest` + +| Name | Type | Description | +| - | - | - | +| `access_token` | string | The user's Elasticsearch access token or JWT. Both `access` and `id` JWT token types are supported and they depend on the underlying JWT realm configuration. If you specify the `access_token` grant type, this parameter is required. It is not valid with other grant types. | +| `body` | string | ({ [key: string]: any; } & { access_token?: never; grant_type?: never; password?: never; username?: never; }) | All values in `body` will be added to the request body. | +| `grant_type` | [SecurityGrantType](./SecurityGrantType.md) | The type of grant. | +| `password` | string | The user's password. If you specify the `password` grant type, this parameter is required. It is not valid with other grant types. | +| `querystring` | { [key: string]: any; } & { access_token?: never; grant_type?: never; password?: never; username?: never; } | All values in `querystring` will be added to the request querystring. | +| `username` | string | The username that identifies the user. If you specify the `password` grant type, this parameter is required. It is not valid with other grant types. | diff --git a/docs/reference/api/SecurityActivateUserProfileResponse.md b/docs/reference/api/SecurityActivateUserProfileResponse.md new file mode 100644 index 000000000..cf2554fd2 --- /dev/null +++ b/docs/reference/api/SecurityActivateUserProfileResponse.md @@ -0,0 +1,4 @@ +## `SecurityActivateUserProfileResponse` +::: +type SecurityActivateUserProfileResponse = [SecurityUserProfileWithMetadata](./SecurityUserProfileWithMetadata.md); +::: diff --git a/docs/reference/api/SecurityApiKey.md b/docs/reference/api/SecurityApiKey.md new file mode 100644 index 000000000..e01c4ab12 --- /dev/null +++ b/docs/reference/api/SecurityApiKey.md @@ -0,0 +1,20 @@ +## Interface `SecurityApiKey` + +| Name | Type | Description | +| - | - | - | +| `_sort` | [SortResults](./SortResults.md) | Sorting values when using the `sort` parameter with the `security.query_api_keys` API. | +| `access` | [SecurityAccess](./SecurityAccess.md) | The access granted to cross-cluster API keys. The access is composed of permissions for cross cluster search and cross cluster replication. At least one of them must be specified. When specified, the new access assignment fully replaces the previously assigned access. | +| `creation` | [EpochTime](./EpochTime.md)<[UnitMillis](./UnitMillis.md)> | Creation time for the API key in milliseconds. | +| `expiration` | [EpochTime](./EpochTime.md)<[UnitMillis](./UnitMillis.md)> | Expiration time for the API key in milliseconds. | +| `id` | [Id](./Id.md) | Id for the API key | +| `invalidated` | boolean | Invalidation status for the API key. If the key has been invalidated, it has a value of `true`. Otherwise, it is `false`. | +| `invalidation` | [EpochTime](./EpochTime.md)<[UnitMillis](./UnitMillis.md)> | If the key has been invalidated, invalidation time in milliseconds. | +| `limited_by` | Record[] | The owner user’s permissions associated with the API key. It is a point-in-time snapshot captured at creation and subsequent updates. An API key’s effective permissions are an intersection of its assigned privileges and the owner user’s permissions. | +| `metadata` | [Metadata](./Metadata.md) | Metadata of the API key | +| `name` | [Name](./Name.md) | Name of the API key. | +| `profile_uid` | string | The profile uid for the API key owner principal, if requested and if it exists | +| `realm_type` | string | Realm type of the principal for which this API key was created | +| `realm` | string | Realm name of the principal for which this API key was created. | +| `role_descriptors` | Record | The role descriptors assigned to this API key when it was created or last updated. An empty role descriptor means the API key inherits the owner user’s permissions. | +| `type` | [SecurityApiKeyType](./SecurityApiKeyType.md) | The type of the API key (e.g. `rest` or `cross_cluster`). | +| `username` | [Username](./Username.md) | Principal for which this API key was created | diff --git a/docs/reference/api/SecurityApiKeyType.md b/docs/reference/api/SecurityApiKeyType.md new file mode 100644 index 000000000..6298fec69 --- /dev/null +++ b/docs/reference/api/SecurityApiKeyType.md @@ -0,0 +1,4 @@ +## `SecurityApiKeyType` +::: +type SecurityApiKeyType = 'rest' | 'cross_cluster'; +::: diff --git a/docs/reference/api/SecurityApplicationGlobalUserPrivileges.md b/docs/reference/api/SecurityApplicationGlobalUserPrivileges.md new file mode 100644 index 000000000..52106df49 --- /dev/null +++ b/docs/reference/api/SecurityApplicationGlobalUserPrivileges.md @@ -0,0 +1,5 @@ +## Interface `SecurityApplicationGlobalUserPrivileges` + +| Name | Type | Description | +| - | - | - | +| `manage` | [SecurityManageUserPrivileges](./SecurityManageUserPrivileges.md) |   | diff --git a/docs/reference/api/SecurityApplicationPrivileges.md b/docs/reference/api/SecurityApplicationPrivileges.md new file mode 100644 index 000000000..48c651b97 --- /dev/null +++ b/docs/reference/api/SecurityApplicationPrivileges.md @@ -0,0 +1,7 @@ +## Interface `SecurityApplicationPrivileges` + +| Name | Type | Description | +| - | - | - | +| `application` | string | The name of the application to which this entry applies. | +| `privileges` | string[] | A list of strings, where each element is the name of an application privilege or action. | +| `resources` | string[] | A list resources to which the privileges are applied. | diff --git a/docs/reference/api/SecurityAuthenticateAuthenticateApiKey.md b/docs/reference/api/SecurityAuthenticateAuthenticateApiKey.md new file mode 100644 index 000000000..5703126e4 --- /dev/null +++ b/docs/reference/api/SecurityAuthenticateAuthenticateApiKey.md @@ -0,0 +1,6 @@ +## Interface `SecurityAuthenticateAuthenticateApiKey` + +| Name | Type | Description | +| - | - | - | +| `id` | [Id](./Id.md) |   | +| `name` | [Name](./Name.md) |   | diff --git a/docs/reference/api/SecurityAuthenticateRequest.md b/docs/reference/api/SecurityAuthenticateRequest.md new file mode 100644 index 000000000..8b6765628 --- /dev/null +++ b/docs/reference/api/SecurityAuthenticateRequest.md @@ -0,0 +1,6 @@ +## Interface `SecurityAuthenticateRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | { [key: string]: any; } | All values in `body` will be added to the request body. | +| `querystring` | { [key: string]: any; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/SecurityAuthenticateResponse.md b/docs/reference/api/SecurityAuthenticateResponse.md new file mode 100644 index 000000000..bc013f576 --- /dev/null +++ b/docs/reference/api/SecurityAuthenticateResponse.md @@ -0,0 +1,15 @@ +## Interface `SecurityAuthenticateResponse` + +| Name | Type | Description | +| - | - | - | +| `api_key` | [SecurityAuthenticateAuthenticateApiKey](./SecurityAuthenticateAuthenticateApiKey.md) |   | +| `authentication_realm` | [SecurityRealmInfo](./SecurityRealmInfo.md) |   | +| `authentication_type` | string |   | +| `email` | string | null |   | +| `enabled` | boolean |   | +| `full_name` | [Name](./Name.md) | null |   | +| `lookup_realm` | [SecurityRealmInfo](./SecurityRealmInfo.md) |   | +| `metadata` | [Metadata](./Metadata.md) |   | +| `roles` | string[] |   | +| `token` | [SecurityAuthenticateToken](./SecurityAuthenticateToken.md) |   | +| `username` | [Username](./Username.md) |   | diff --git a/docs/reference/api/SecurityAuthenticateToken.md b/docs/reference/api/SecurityAuthenticateToken.md new file mode 100644 index 000000000..ffbe9bedb --- /dev/null +++ b/docs/reference/api/SecurityAuthenticateToken.md @@ -0,0 +1,6 @@ +## Interface `SecurityAuthenticateToken` + +| Name | Type | Description | +| - | - | - | +| `name` | [Name](./Name.md) |   | +| `type` | string |   | diff --git a/docs/reference/api/SecurityBulkDeleteRoleRequest.md b/docs/reference/api/SecurityBulkDeleteRoleRequest.md new file mode 100644 index 000000000..c8b6cb288 --- /dev/null +++ b/docs/reference/api/SecurityBulkDeleteRoleRequest.md @@ -0,0 +1,8 @@ +## Interface `SecurityBulkDeleteRoleRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { refresh?: never; names?: never; }) | All values in `body` will be added to the request body. | +| `names` | string[] | An array of role names to delete | +| `querystring` | { [key: string]: any; } & { refresh?: never; names?: never; } | All values in `querystring` will be added to the request querystring. | +| `refresh` | [Refresh](./Refresh.md) | If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. | diff --git a/docs/reference/api/SecurityBulkDeleteRoleResponse.md b/docs/reference/api/SecurityBulkDeleteRoleResponse.md new file mode 100644 index 000000000..f8e5b1ff0 --- /dev/null +++ b/docs/reference/api/SecurityBulkDeleteRoleResponse.md @@ -0,0 +1,7 @@ +## Interface `SecurityBulkDeleteRoleResponse` + +| Name | Type | Description | +| - | - | - | +| `deleted` | string[] | Array of deleted roles | +| `errors` | [SecurityBulkError](./SecurityBulkError.md) | Present if any deletes resulted in errors | +| `not_found` | string[] | Array of roles that could not be found | diff --git a/docs/reference/api/SecurityBulkError.md b/docs/reference/api/SecurityBulkError.md new file mode 100644 index 000000000..73208fcdf --- /dev/null +++ b/docs/reference/api/SecurityBulkError.md @@ -0,0 +1,6 @@ +## Interface `SecurityBulkError` + +| Name | Type | Description | +| - | - | - | +| `count` | [integer](./integer.md) | The number of errors | +| `details` | Record | Details about the errors, keyed by role name | diff --git a/docs/reference/api/SecurityBulkPutRoleRequest.md b/docs/reference/api/SecurityBulkPutRoleRequest.md new file mode 100644 index 000000000..e131903a7 --- /dev/null +++ b/docs/reference/api/SecurityBulkPutRoleRequest.md @@ -0,0 +1,8 @@ +## Interface `SecurityBulkPutRoleRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { refresh?: never; roles?: never; }) | All values in `body` will be added to the request body. | +| `querystring` | { [key: string]: any; } & { refresh?: never; roles?: never; } | All values in `querystring` will be added to the request querystring. | +| `refresh` | [Refresh](./Refresh.md) | If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. | +| `roles` | Record | A dictionary of role name to RoleDescriptor objects to add or update | diff --git a/docs/reference/api/SecurityBulkPutRoleResponse.md b/docs/reference/api/SecurityBulkPutRoleResponse.md new file mode 100644 index 000000000..229ab7afe --- /dev/null +++ b/docs/reference/api/SecurityBulkPutRoleResponse.md @@ -0,0 +1,8 @@ +## Interface `SecurityBulkPutRoleResponse` + +| Name | Type | Description | +| - | - | - | +| `created` | string[] | Array of created roles | +| `errors` | [SecurityBulkError](./SecurityBulkError.md) | Present if any updates resulted in errors | +| `noop` | string[] | Array of role names without any changes | +| `updated` | string[] | Array of updated roles | diff --git a/docs/reference/api/SecurityBulkUpdateApiKeysRequest.md b/docs/reference/api/SecurityBulkUpdateApiKeysRequest.md new file mode 100644 index 000000000..37c12a7b7 --- /dev/null +++ b/docs/reference/api/SecurityBulkUpdateApiKeysRequest.md @@ -0,0 +1,10 @@ +## Interface `SecurityBulkUpdateApiKeysRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { expiration?: never; ids?: never; metadata?: never; role_descriptors?: never; }) | All values in `body` will be added to the request body. | +| `expiration` | [Duration](./Duration.md) | Expiration time for the API keys. By default, API keys never expire. This property can be omitted to leave the value unchanged. | +| `ids` | string | string[] | The API key identifiers. | +| `metadata` | [Metadata](./Metadata.md) | Arbitrary nested metadata to associate with the API keys. Within the `metadata` object, top-level keys beginning with an underscore ( `_`) are reserved for system usage. Any information specified with this parameter fully replaces metadata previously associated with the API key. | +| `querystring` | { [key: string]: any; } & { expiration?: never; ids?: never; metadata?: never; role_descriptors?: never; } | All values in `querystring` will be added to the request querystring. | +| `role_descriptors` | Record | The role descriptors to assign to the API keys. An API key's effective permissions are an intersection of its assigned privileges and the point-in-time snapshot of permissions of the owner user. You can assign new privileges by specifying them in this parameter. To remove assigned privileges, supply the `role_descriptors` parameter as an empty object `{}`. If an API key has no assigned privileges, it inherits the owner user's full permissions. The snapshot of the owner's permissions is always updated, whether you supply the `role_descriptors` parameter. The structure of a role descriptor is the same as the request for the create API keys API. | diff --git a/docs/reference/api/SecurityBulkUpdateApiKeysResponse.md b/docs/reference/api/SecurityBulkUpdateApiKeysResponse.md new file mode 100644 index 000000000..a42496199 --- /dev/null +++ b/docs/reference/api/SecurityBulkUpdateApiKeysResponse.md @@ -0,0 +1,7 @@ +## Interface `SecurityBulkUpdateApiKeysResponse` + +| Name | Type | Description | +| - | - | - | +| `errors` | [SecurityBulkError](./SecurityBulkError.md) |   | +| `noops` | string[] |   | +| `updated` | string[] |   | diff --git a/docs/reference/api/SecurityChangePasswordRequest.md b/docs/reference/api/SecurityChangePasswordRequest.md new file mode 100644 index 000000000..ab1d8b22b --- /dev/null +++ b/docs/reference/api/SecurityChangePasswordRequest.md @@ -0,0 +1,10 @@ +## Interface `SecurityChangePasswordRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { username?: never; refresh?: never; password?: never; password_hash?: never; }) | All values in `body` will be added to the request body. | +| `password_hash` | string | A hash of the new password value. This must be produced using the same hashing algorithm as has been configured for password storage. For more details, see the explanation of the `xpack.security.authc.password_hashing.algorithm` setting. | +| `password` | [Password](./Password.md) | The new password value. Passwords must be at least 6 characters long. | +| `querystring` | { [key: string]: any; } & { username?: never; refresh?: never; password?: never; password_hash?: never; } | All values in `querystring` will be added to the request querystring. | +| `refresh` | [Refresh](./Refresh.md) | If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. | +| `username` | [Username](./Username.md) | The user whose password you want to change. If you do not specify this parameter, the password is changed for the current user. | diff --git a/docs/reference/api/SecurityChangePasswordResponse.md b/docs/reference/api/SecurityChangePasswordResponse.md new file mode 100644 index 000000000..efa8fd32e --- /dev/null +++ b/docs/reference/api/SecurityChangePasswordResponse.md @@ -0,0 +1,4 @@ +## Interface `SecurityChangePasswordResponse` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/SecurityClearApiKeyCacheRequest.md b/docs/reference/api/SecurityClearApiKeyCacheRequest.md new file mode 100644 index 000000000..236b50450 --- /dev/null +++ b/docs/reference/api/SecurityClearApiKeyCacheRequest.md @@ -0,0 +1,7 @@ +## Interface `SecurityClearApiKeyCacheRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { ids?: never; }) | All values in `body` will be added to the request body. | +| `ids` | [Ids](./Ids.md) | Comma-separated list of API key IDs to evict from the API key cache. To evict all API keys, use `*`. Does not support other wildcard patterns. | +| `querystring` | { [key: string]: any; } & { ids?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/SecurityClearApiKeyCacheResponse.md b/docs/reference/api/SecurityClearApiKeyCacheResponse.md new file mode 100644 index 000000000..99095dbb0 --- /dev/null +++ b/docs/reference/api/SecurityClearApiKeyCacheResponse.md @@ -0,0 +1,7 @@ +## Interface `SecurityClearApiKeyCacheResponse` + +| Name | Type | Description | +| - | - | - | +| `_nodes` | [NodeStatistics](./NodeStatistics.md) |   | +| `cluster_name` | [Name](./Name.md) |   | +| `nodes` | Record |   | diff --git a/docs/reference/api/SecurityClearCachedPrivilegesRequest.md b/docs/reference/api/SecurityClearCachedPrivilegesRequest.md new file mode 100644 index 000000000..0e5e72f77 --- /dev/null +++ b/docs/reference/api/SecurityClearCachedPrivilegesRequest.md @@ -0,0 +1,7 @@ +## Interface `SecurityClearCachedPrivilegesRequest` + +| Name | Type | Description | +| - | - | - | +| `application` | [Name](./Name.md) | A comma-separated list of applications. To clear all applications, use an asterism ( `*`). It does not support other wildcard patterns. | +| `body` | string | ({ [key: string]: any; } & { application?: never; }) | All values in `body` will be added to the request body. | +| `querystring` | { [key: string]: any; } & { application?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/SecurityClearCachedPrivilegesResponse.md b/docs/reference/api/SecurityClearCachedPrivilegesResponse.md new file mode 100644 index 000000000..472761116 --- /dev/null +++ b/docs/reference/api/SecurityClearCachedPrivilegesResponse.md @@ -0,0 +1,7 @@ +## Interface `SecurityClearCachedPrivilegesResponse` + +| Name | Type | Description | +| - | - | - | +| `_nodes` | [NodeStatistics](./NodeStatistics.md) |   | +| `cluster_name` | [Name](./Name.md) |   | +| `nodes` | Record |   | diff --git a/docs/reference/api/SecurityClearCachedRealmsRequest.md b/docs/reference/api/SecurityClearCachedRealmsRequest.md new file mode 100644 index 000000000..bdcc14a31 --- /dev/null +++ b/docs/reference/api/SecurityClearCachedRealmsRequest.md @@ -0,0 +1,8 @@ +## Interface `SecurityClearCachedRealmsRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { realms?: never; usernames?: never; }) | All values in `body` will be added to the request body. | +| `querystring` | { [key: string]: any; } & { realms?: never; usernames?: never; } | All values in `querystring` will be added to the request querystring. | +| `realms` | [Names](./Names.md) | A comma-separated list of realms. To clear all realms, use an asterisk ( `*`). It does not support other wildcard patterns. | +| `usernames` | string[] | A comma-separated list of the users to clear from the cache. If you do not specify this parameter, the API evicts all users from the user cache. | diff --git a/docs/reference/api/SecurityClearCachedRealmsResponse.md b/docs/reference/api/SecurityClearCachedRealmsResponse.md new file mode 100644 index 000000000..64b3e094d --- /dev/null +++ b/docs/reference/api/SecurityClearCachedRealmsResponse.md @@ -0,0 +1,7 @@ +## Interface `SecurityClearCachedRealmsResponse` + +| Name | Type | Description | +| - | - | - | +| `_nodes` | [NodeStatistics](./NodeStatistics.md) |   | +| `cluster_name` | [Name](./Name.md) |   | +| `nodes` | Record |   | diff --git a/docs/reference/api/SecurityClearCachedRolesRequest.md b/docs/reference/api/SecurityClearCachedRolesRequest.md new file mode 100644 index 000000000..72274375f --- /dev/null +++ b/docs/reference/api/SecurityClearCachedRolesRequest.md @@ -0,0 +1,7 @@ +## Interface `SecurityClearCachedRolesRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { name?: never; }) | All values in `body` will be added to the request body. | +| `name` | [Names](./Names.md) | A comma-separated list of roles to evict from the role cache. To evict all roles, use an asterisk ( `*`). It does not support other wildcard patterns. | +| `querystring` | { [key: string]: any; } & { name?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/SecurityClearCachedRolesResponse.md b/docs/reference/api/SecurityClearCachedRolesResponse.md new file mode 100644 index 000000000..06b060158 --- /dev/null +++ b/docs/reference/api/SecurityClearCachedRolesResponse.md @@ -0,0 +1,7 @@ +## Interface `SecurityClearCachedRolesResponse` + +| Name | Type | Description | +| - | - | - | +| `_nodes` | [NodeStatistics](./NodeStatistics.md) |   | +| `cluster_name` | [Name](./Name.md) |   | +| `nodes` | Record |   | diff --git a/docs/reference/api/SecurityClearCachedServiceTokensRequest.md b/docs/reference/api/SecurityClearCachedServiceTokensRequest.md new file mode 100644 index 000000000..39f83b678 --- /dev/null +++ b/docs/reference/api/SecurityClearCachedServiceTokensRequest.md @@ -0,0 +1,9 @@ +## Interface `SecurityClearCachedServiceTokensRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { namespace?: never; service?: never; name?: never; }) | All values in `body` will be added to the request body. | +| `name` | [Names](./Names.md) | A comma-separated list of token names to evict from the service account token caches. Use a wildcard ( `*`) to evict all tokens that belong to a service account. It does not support other wildcard patterns. | +| `namespace` | [Namespace](./Namespace.md) | The namespace, which is a top-level grouping of service accounts. | +| `querystring` | { [key: string]: any; } & { namespace?: never; service?: never; name?: never; } | All values in `querystring` will be added to the request querystring. | +| `service` | [Service](./Service.md) | The name of the service, which must be unique within its namespace. | diff --git a/docs/reference/api/SecurityClearCachedServiceTokensResponse.md b/docs/reference/api/SecurityClearCachedServiceTokensResponse.md new file mode 100644 index 000000000..1abb07ce0 --- /dev/null +++ b/docs/reference/api/SecurityClearCachedServiceTokensResponse.md @@ -0,0 +1,7 @@ +## Interface `SecurityClearCachedServiceTokensResponse` + +| Name | Type | Description | +| - | - | - | +| `_nodes` | [NodeStatistics](./NodeStatistics.md) |   | +| `cluster_name` | [Name](./Name.md) |   | +| `nodes` | Record |   | diff --git a/docs/reference/api/SecurityClusterNode.md b/docs/reference/api/SecurityClusterNode.md new file mode 100644 index 000000000..20882bf9d --- /dev/null +++ b/docs/reference/api/SecurityClusterNode.md @@ -0,0 +1,5 @@ +## Interface `SecurityClusterNode` + +| Name | Type | Description | +| - | - | - | +| `name` | [Name](./Name.md) |   | diff --git a/docs/reference/api/SecurityClusterPrivilege.md b/docs/reference/api/SecurityClusterPrivilege.md new file mode 100644 index 000000000..6a937aeda --- /dev/null +++ b/docs/reference/api/SecurityClusterPrivilege.md @@ -0,0 +1,4 @@ +## `SecurityClusterPrivilege` +::: +type SecurityClusterPrivilege = 'all' | 'cancel_task' | 'create_snapshot' | 'cross_cluster_replication' | 'cross_cluster_search' | 'delegate_pki' | 'grant_api_key' | 'manage' | 'manage_api_key' | 'manage_autoscaling' | 'manage_behavioral_analytics' | 'manage_ccr' | 'manage_data_frame_transforms' | 'manage_data_stream_global_retention' | 'manage_enrich' | 'manage_esql' | 'manage_ilm' | 'manage_index_templates' | 'manage_inference' | 'manage_ingest_pipelines' | 'manage_logstash_pipelines' | 'manage_ml' | 'manage_oidc' | 'manage_own_api_key' | 'manage_pipeline' | 'manage_rollup' | 'manage_saml' | 'manage_search_application' | 'manage_search_query_rules' | 'manage_search_synonyms' | 'manage_security' | 'manage_service_account' | 'manage_slm' | 'manage_token' | 'manage_transform' | 'manage_user_profile' | 'manage_watcher' | 'monitor' | 'monitor_data_frame_transforms' | 'monitor_data_stream_global_retention' | 'monitor_enrich' | 'monitor_esql' | 'monitor_inference' | 'monitor_ml' | 'monitor_rollup' | 'monitor_snapshot' | 'monitor_stats' | 'monitor_text_structure' | 'monitor_transform' | 'monitor_watcher' | 'none' | 'post_behavioral_analytics_event' | 'read_ccr' | 'read_fleet_secrets' | 'read_ilm' | 'read_pipeline' | 'read_security' | 'read_slm' | 'transport_client' | 'write_connector_secrets' | 'write_fleet_secrets' | string; +::: diff --git a/docs/reference/api/SecurityCreateApiKeyRequest.md b/docs/reference/api/SecurityCreateApiKeyRequest.md new file mode 100644 index 000000000..47c2a4585 --- /dev/null +++ b/docs/reference/api/SecurityCreateApiKeyRequest.md @@ -0,0 +1,11 @@ +## Interface `SecurityCreateApiKeyRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { refresh?: never; expiration?: never; name?: never; role_descriptors?: never; metadata?: never; }) | All values in `body` will be added to the request body. | +| `expiration` | [Duration](./Duration.md) | The expiration time for the API key. By default, API keys never expire. | +| `metadata` | [Metadata](./Metadata.md) | Arbitrary metadata that you want to associate with the API key. It supports nested data structure. Within the metadata object, keys beginning with `_` are reserved for system usage. | +| `name` | [Name](./Name.md) | A name for the API key. | +| `querystring` | { [key: string]: any; } & { refresh?: never; expiration?: never; name?: never; role_descriptors?: never; metadata?: never; } | All values in `querystring` will be added to the request querystring. | +| `refresh` | [Refresh](./Refresh.md) | If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. | +| `role_descriptors` | Record | An array of role descriptors for this API key. When it is not specified or it is an empty array, the API key will have a point in time snapshot of permissions of the authenticated user. If you supply role descriptors, the resultant permissions are an intersection of API keys permissions and the authenticated user's permissions thereby limiting the access scope for API keys. The structure of role descriptor is the same as the request for the create role API. For more details, refer to the create or update roles API. NOTE: Due to the way in which this permission intersection is calculated, it is not possible to create an API key that is a child of another API key, unless the derived key is created without any privileges. In this case, you must explicitly specify a role descriptor with no privileges. The derived API key can be used for authentication; it will not have authority to call Elasticsearch APIs. | diff --git a/docs/reference/api/SecurityCreateApiKeyResponse.md b/docs/reference/api/SecurityCreateApiKeyResponse.md new file mode 100644 index 000000000..c24a640ea --- /dev/null +++ b/docs/reference/api/SecurityCreateApiKeyResponse.md @@ -0,0 +1,9 @@ +## Interface `SecurityCreateApiKeyResponse` + +| Name | Type | Description | +| - | - | - | +| `api_key` | string | Generated API key. | +| `encoded` | string | API key credentials which is the base64-encoding of the UTF-8 representation of `id` and `api_key` joined by a colon ( `:`). | +| `expiration` | [long](./long.md) | Expiration in milliseconds for the API key. | +| `id` | [Id](./Id.md) | Unique ID for this API key. | +| `name` | [Name](./Name.md) | Specifies the name for this API key. | diff --git a/docs/reference/api/SecurityCreateCrossClusterApiKeyRequest.md b/docs/reference/api/SecurityCreateCrossClusterApiKeyRequest.md new file mode 100644 index 000000000..8bdb0ced0 --- /dev/null +++ b/docs/reference/api/SecurityCreateCrossClusterApiKeyRequest.md @@ -0,0 +1,10 @@ +## Interface `SecurityCreateCrossClusterApiKeyRequest` + +| Name | Type | Description | +| - | - | - | +| `access` | [SecurityAccess](./SecurityAccess.md) | The access to be granted to this API key. The access is composed of permissions for cross-cluster search and cross-cluster replication. At least one of them must be specified. NOTE: No explicit privileges should be specified for either search or replication access. The creation process automatically converts the access specification to a role descriptor which has relevant privileges assigned accordingly. | +| `body` | string | ({ [key: string]: any; } & { access?: never; expiration?: never; metadata?: never; name?: never; }) | All values in `body` will be added to the request body. | +| `expiration` | [Duration](./Duration.md) | Expiration time for the API key. By default, API keys never expire. | +| `metadata` | [Metadata](./Metadata.md) | Arbitrary metadata that you want to associate with the API key. It supports nested data structure. Within the metadata object, keys beginning with `_` are reserved for system usage. | +| `name` | [Name](./Name.md) | Specifies the name for this API key. | +| `querystring` | { [key: string]: any; } & { access?: never; expiration?: never; metadata?: never; name?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/SecurityCreateCrossClusterApiKeyResponse.md b/docs/reference/api/SecurityCreateCrossClusterApiKeyResponse.md new file mode 100644 index 000000000..ec2450fe2 --- /dev/null +++ b/docs/reference/api/SecurityCreateCrossClusterApiKeyResponse.md @@ -0,0 +1,9 @@ +## Interface `SecurityCreateCrossClusterApiKeyResponse` + +| Name | Type | Description | +| - | - | - | +| `api_key` | string | Generated API key. | +| `encoded` | string | API key credentials which is the base64-encoding of the UTF-8 representation of `id` and `api_key` joined by a colon ( `:`). | +| `expiration` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> | Expiration in milliseconds for the API key. | +| `id` | [Id](./Id.md) | Unique ID for this API key. | +| `name` | [Name](./Name.md) | Specifies the name for this API key. | diff --git a/docs/reference/api/SecurityCreateServiceTokenRequest.md b/docs/reference/api/SecurityCreateServiceTokenRequest.md new file mode 100644 index 000000000..72a708b99 --- /dev/null +++ b/docs/reference/api/SecurityCreateServiceTokenRequest.md @@ -0,0 +1,10 @@ +## Interface `SecurityCreateServiceTokenRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { namespace?: never; service?: never; name?: never; refresh?: never; }) | All values in `body` will be added to the request body. | +| `name` | [Name](./Name.md) | The name for the service account token. If omitted, a random name will be generated. Token names must be at least one and no more than 256 characters. They can contain alphanumeric characters (a-z, A-Z, 0-9), dashes ( `-`), and underscores ( `_`), but cannot begin with an underscore. NOTE: Token names must be unique in the context of the associated service account. They must also be globally unique with their fully qualified names, which are comprised of the service account principal and token name, such as `//`. | +| `namespace` | [Namespace](./Namespace.md) | The name of the namespace, which is a top-level grouping of service accounts. | +| `querystring` | { [key: string]: any; } & { namespace?: never; service?: never; name?: never; refresh?: never; } | All values in `querystring` will be added to the request querystring. | +| `refresh` | [Refresh](./Refresh.md) | If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` (the default) then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. | +| `service` | [Service](./Service.md) | The name of the service. | diff --git a/docs/reference/api/SecurityCreateServiceTokenResponse.md b/docs/reference/api/SecurityCreateServiceTokenResponse.md new file mode 100644 index 000000000..1a5b0e477 --- /dev/null +++ b/docs/reference/api/SecurityCreateServiceTokenResponse.md @@ -0,0 +1,6 @@ +## Interface `SecurityCreateServiceTokenResponse` + +| Name | Type | Description | +| - | - | - | +| `created` | boolean |   | +| `token` | [SecurityCreateServiceTokenToken](./SecurityCreateServiceTokenToken.md) |   | diff --git a/docs/reference/api/SecurityCreateServiceTokenToken.md b/docs/reference/api/SecurityCreateServiceTokenToken.md new file mode 100644 index 000000000..fd5ea71b7 --- /dev/null +++ b/docs/reference/api/SecurityCreateServiceTokenToken.md @@ -0,0 +1,6 @@ +## Interface `SecurityCreateServiceTokenToken` + +| Name | Type | Description | +| - | - | - | +| `name` | [Name](./Name.md) |   | +| `value` | string |   | diff --git a/docs/reference/api/SecurityCreatedStatus.md b/docs/reference/api/SecurityCreatedStatus.md new file mode 100644 index 000000000..63e128c95 --- /dev/null +++ b/docs/reference/api/SecurityCreatedStatus.md @@ -0,0 +1,5 @@ +## Interface `SecurityCreatedStatus` + +| Name | Type | Description | +| - | - | - | +| `created` | boolean |   | diff --git a/docs/reference/api/SecurityDelegatePkiAuthentication.md b/docs/reference/api/SecurityDelegatePkiAuthentication.md new file mode 100644 index 000000000..8ab735e7c --- /dev/null +++ b/docs/reference/api/SecurityDelegatePkiAuthentication.md @@ -0,0 +1,15 @@ +## Interface `SecurityDelegatePkiAuthentication` + +| Name | Type | Description | +| - | - | - | +| `api_key` | Record |   | +| `authentication_realm` | [SecurityDelegatePkiAuthenticationRealm](./SecurityDelegatePkiAuthenticationRealm.md) |   | +| `authentication_type` | string |   | +| `email` | string | null |   | +| `enabled` | boolean |   | +| `full_name` | string | null |   | +| `lookup_realm` | [SecurityDelegatePkiAuthenticationRealm](./SecurityDelegatePkiAuthenticationRealm.md) |   | +| `metadata` | [Metadata](./Metadata.md) |   | +| `roles` | string[] |   | +| `token` | Record |   | +| `username` | string |   | diff --git a/docs/reference/api/SecurityDelegatePkiAuthenticationRealm.md b/docs/reference/api/SecurityDelegatePkiAuthenticationRealm.md new file mode 100644 index 000000000..25a2dfa7e --- /dev/null +++ b/docs/reference/api/SecurityDelegatePkiAuthenticationRealm.md @@ -0,0 +1,7 @@ +## Interface `SecurityDelegatePkiAuthenticationRealm` + +| Name | Type | Description | +| - | - | - | +| `domain` | string |   | +| `name` | string |   | +| `type` | string |   | diff --git a/docs/reference/api/SecurityDelegatePkiRequest.md b/docs/reference/api/SecurityDelegatePkiRequest.md new file mode 100644 index 000000000..2a5c88e1c --- /dev/null +++ b/docs/reference/api/SecurityDelegatePkiRequest.md @@ -0,0 +1,7 @@ +## Interface `SecurityDelegatePkiRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { x509_certificate_chain?: never; }) | All values in `body` will be added to the request body. | +| `querystring` | { [key: string]: any; } & { x509_certificate_chain?: never; } | All values in `querystring` will be added to the request querystring. | +| `x509_certificate_chain` | string[] | The X509Certificate chain, which is represented as an ordered string array. Each string in the array is a base64-encoded (Section 4 of RFC4648 - not base64url-encoded) of the certificate's DER encoding. The first element is the target certificate that contains the subject distinguished name that is requesting access. This may be followed by additional certificates; each subsequent certificate is used to certify the previous one. | diff --git a/docs/reference/api/SecurityDelegatePkiResponse.md b/docs/reference/api/SecurityDelegatePkiResponse.md new file mode 100644 index 000000000..2bda5484c --- /dev/null +++ b/docs/reference/api/SecurityDelegatePkiResponse.md @@ -0,0 +1,8 @@ +## Interface `SecurityDelegatePkiResponse` + +| Name | Type | Description | +| - | - | - | +| `access_token` | string | An access token associated with the subject distinguished name of the client's certificate. | +| `authentication` | [SecurityDelegatePkiAuthentication](./SecurityDelegatePkiAuthentication.md) |   | +| `expires_in` | [long](./long.md) | The amount of time (in seconds) before the token expires. | +| `type` | string | The type of token. | diff --git a/docs/reference/api/SecurityDeletePrivilegesFoundStatus.md b/docs/reference/api/SecurityDeletePrivilegesFoundStatus.md new file mode 100644 index 000000000..63942c07e --- /dev/null +++ b/docs/reference/api/SecurityDeletePrivilegesFoundStatus.md @@ -0,0 +1,5 @@ +## Interface `SecurityDeletePrivilegesFoundStatus` + +| Name | Type | Description | +| - | - | - | +| `found` | boolean |   | diff --git a/docs/reference/api/SecurityDeletePrivilegesRequest.md b/docs/reference/api/SecurityDeletePrivilegesRequest.md new file mode 100644 index 000000000..16997f665 --- /dev/null +++ b/docs/reference/api/SecurityDeletePrivilegesRequest.md @@ -0,0 +1,9 @@ +## Interface `SecurityDeletePrivilegesRequest` + +| Name | Type | Description | +| - | - | - | +| `application` | [Name](./Name.md) | The name of the application. Application privileges are always associated with exactly one application. | +| `body` | string | ({ [key: string]: any; } & { application?: never; name?: never; refresh?: never; }) | All values in `body` will be added to the request body. | +| `name` | [Names](./Names.md) | The name of the privilege. | +| `querystring` | { [key: string]: any; } & { application?: never; name?: never; refresh?: never; } | All values in `querystring` will be added to the request querystring. | +| `refresh` | [Refresh](./Refresh.md) | If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. | diff --git a/docs/reference/api/SecurityDeletePrivilegesResponse.md b/docs/reference/api/SecurityDeletePrivilegesResponse.md new file mode 100644 index 000000000..dff9ed9ad --- /dev/null +++ b/docs/reference/api/SecurityDeletePrivilegesResponse.md @@ -0,0 +1,4 @@ +## `SecurityDeletePrivilegesResponse` +::: +type SecurityDeletePrivilegesResponse = Record>; +::: diff --git a/docs/reference/api/SecurityDeleteRoleMappingRequest.md b/docs/reference/api/SecurityDeleteRoleMappingRequest.md new file mode 100644 index 000000000..d959220e6 --- /dev/null +++ b/docs/reference/api/SecurityDeleteRoleMappingRequest.md @@ -0,0 +1,8 @@ +## Interface `SecurityDeleteRoleMappingRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { name?: never; refresh?: never; }) | All values in `body` will be added to the request body. | +| `name` | [Name](./Name.md) | The distinct name that identifies the role mapping. The name is used solely as an identifier to facilitate interaction via the API; it does not affect the behavior of the mapping in any way. | +| `querystring` | { [key: string]: any; } & { name?: never; refresh?: never; } | All values in `querystring` will be added to the request querystring. | +| `refresh` | [Refresh](./Refresh.md) | If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. | diff --git a/docs/reference/api/SecurityDeleteRoleMappingResponse.md b/docs/reference/api/SecurityDeleteRoleMappingResponse.md new file mode 100644 index 000000000..abda2b2da --- /dev/null +++ b/docs/reference/api/SecurityDeleteRoleMappingResponse.md @@ -0,0 +1,5 @@ +## Interface `SecurityDeleteRoleMappingResponse` + +| Name | Type | Description | +| - | - | - | +| `found` | boolean | If the mapping is successfully deleted, `found` is `true`. Otherwise, `found` is `false`. | diff --git a/docs/reference/api/SecurityDeleteRoleRequest.md b/docs/reference/api/SecurityDeleteRoleRequest.md new file mode 100644 index 000000000..71ebfe14b --- /dev/null +++ b/docs/reference/api/SecurityDeleteRoleRequest.md @@ -0,0 +1,8 @@ +## Interface `SecurityDeleteRoleRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { name?: never; refresh?: never; }) | All values in `body` will be added to the request body. | +| `name` | [Name](./Name.md) | The name of the role. | +| `querystring` | { [key: string]: any; } & { name?: never; refresh?: never; } | All values in `querystring` will be added to the request querystring. | +| `refresh` | [Refresh](./Refresh.md) | If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. | diff --git a/docs/reference/api/SecurityDeleteRoleResponse.md b/docs/reference/api/SecurityDeleteRoleResponse.md new file mode 100644 index 000000000..7d7908fd1 --- /dev/null +++ b/docs/reference/api/SecurityDeleteRoleResponse.md @@ -0,0 +1,5 @@ +## Interface `SecurityDeleteRoleResponse` + +| Name | Type | Description | +| - | - | - | +| `found` | boolean | If the role is successfully deleted, `found` is `true`. Otherwise, `found` is `false`. | diff --git a/docs/reference/api/SecurityDeleteServiceTokenRequest.md b/docs/reference/api/SecurityDeleteServiceTokenRequest.md new file mode 100644 index 000000000..ac776cf4f --- /dev/null +++ b/docs/reference/api/SecurityDeleteServiceTokenRequest.md @@ -0,0 +1,10 @@ +## Interface `SecurityDeleteServiceTokenRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { namespace?: never; service?: never; name?: never; refresh?: never; }) | All values in `body` will be added to the request body. | +| `name` | [Name](./Name.md) | The name of the service account token. | +| `namespace` | [Namespace](./Namespace.md) | The namespace, which is a top-level grouping of service accounts. | +| `querystring` | { [key: string]: any; } & { namespace?: never; service?: never; name?: never; refresh?: never; } | All values in `querystring` will be added to the request querystring. | +| `refresh` | [Refresh](./Refresh.md) | If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` (the default) then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. | +| `service` | [Service](./Service.md) | The service name. | diff --git a/docs/reference/api/SecurityDeleteServiceTokenResponse.md b/docs/reference/api/SecurityDeleteServiceTokenResponse.md new file mode 100644 index 000000000..dd3845caf --- /dev/null +++ b/docs/reference/api/SecurityDeleteServiceTokenResponse.md @@ -0,0 +1,5 @@ +## Interface `SecurityDeleteServiceTokenResponse` + +| Name | Type | Description | +| - | - | - | +| `found` | boolean | If the service account token is successfully deleted, the request returns `{"found": true}`. Otherwise, the response will have status code 404 and `found` is set to `false`. | diff --git a/docs/reference/api/SecurityDeleteUserRequest.md b/docs/reference/api/SecurityDeleteUserRequest.md new file mode 100644 index 000000000..092be02ec --- /dev/null +++ b/docs/reference/api/SecurityDeleteUserRequest.md @@ -0,0 +1,8 @@ +## Interface `SecurityDeleteUserRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { username?: never; refresh?: never; }) | All values in `body` will be added to the request body. | +| `querystring` | { [key: string]: any; } & { username?: never; refresh?: never; } | All values in `querystring` will be added to the request querystring. | +| `refresh` | [Refresh](./Refresh.md) | If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. | +| `username` | [Username](./Username.md) | An identifier for the user. | diff --git a/docs/reference/api/SecurityDeleteUserResponse.md b/docs/reference/api/SecurityDeleteUserResponse.md new file mode 100644 index 000000000..bf62d879e --- /dev/null +++ b/docs/reference/api/SecurityDeleteUserResponse.md @@ -0,0 +1,5 @@ +## Interface `SecurityDeleteUserResponse` + +| Name | Type | Description | +| - | - | - | +| `found` | boolean | If the user is successfully deleted, the request returns `{"found": true}`. Otherwise, `found` is set to `false`. | diff --git a/docs/reference/api/SecurityDisableUserProfileRequest.md b/docs/reference/api/SecurityDisableUserProfileRequest.md new file mode 100644 index 000000000..87140a2e1 --- /dev/null +++ b/docs/reference/api/SecurityDisableUserProfileRequest.md @@ -0,0 +1,8 @@ +## Interface `SecurityDisableUserProfileRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { uid?: never; refresh?: never; }) | All values in `body` will be added to the request body. | +| `querystring` | { [key: string]: any; } & { uid?: never; refresh?: never; } | All values in `querystring` will be added to the request querystring. | +| `refresh` | [Refresh](./Refresh.md) | If 'true', Elasticsearch refreshes the affected shards to make this operation visible to search. If 'wait_for', it waits for a refresh to make this operation visible to search. If 'false', it does nothing with refreshes. | +| `uid` | [SecurityUserProfileId](./SecurityUserProfileId.md) | Unique identifier for the user profile. | diff --git a/docs/reference/api/SecurityDisableUserProfileResponse.md b/docs/reference/api/SecurityDisableUserProfileResponse.md new file mode 100644 index 000000000..01be19a63 --- /dev/null +++ b/docs/reference/api/SecurityDisableUserProfileResponse.md @@ -0,0 +1,4 @@ +## `SecurityDisableUserProfileResponse` +::: +type SecurityDisableUserProfileResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); +::: diff --git a/docs/reference/api/SecurityDisableUserRequest.md b/docs/reference/api/SecurityDisableUserRequest.md new file mode 100644 index 000000000..92025ec8a --- /dev/null +++ b/docs/reference/api/SecurityDisableUserRequest.md @@ -0,0 +1,8 @@ +## Interface `SecurityDisableUserRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { username?: never; refresh?: never; }) | All values in `body` will be added to the request body. | +| `querystring` | { [key: string]: any; } & { username?: never; refresh?: never; } | All values in `querystring` will be added to the request querystring. | +| `refresh` | [Refresh](./Refresh.md) | If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. | +| `username` | [Username](./Username.md) | An identifier for the user. | diff --git a/docs/reference/api/SecurityDisableUserResponse.md b/docs/reference/api/SecurityDisableUserResponse.md new file mode 100644 index 000000000..d70e5a227 --- /dev/null +++ b/docs/reference/api/SecurityDisableUserResponse.md @@ -0,0 +1,4 @@ +## Interface `SecurityDisableUserResponse` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/SecurityEnableUserProfileRequest.md b/docs/reference/api/SecurityEnableUserProfileRequest.md new file mode 100644 index 000000000..207482225 --- /dev/null +++ b/docs/reference/api/SecurityEnableUserProfileRequest.md @@ -0,0 +1,8 @@ +## Interface `SecurityEnableUserProfileRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { uid?: never; refresh?: never; }) | All values in `body` will be added to the request body. | +| `querystring` | { [key: string]: any; } & { uid?: never; refresh?: never; } | All values in `querystring` will be added to the request querystring. | +| `refresh` | [Refresh](./Refresh.md) | If 'true', Elasticsearch refreshes the affected shards to make this operation visible to search. If 'wait_for', it waits for a refresh to make this operation visible to search. If 'false', nothing is done with refreshes. | +| `uid` | [SecurityUserProfileId](./SecurityUserProfileId.md) | A unique identifier for the user profile. | diff --git a/docs/reference/api/SecurityEnableUserProfileResponse.md b/docs/reference/api/SecurityEnableUserProfileResponse.md new file mode 100644 index 000000000..9b8f9482b --- /dev/null +++ b/docs/reference/api/SecurityEnableUserProfileResponse.md @@ -0,0 +1,4 @@ +## `SecurityEnableUserProfileResponse` +::: +type SecurityEnableUserProfileResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); +::: diff --git a/docs/reference/api/SecurityEnableUserRequest.md b/docs/reference/api/SecurityEnableUserRequest.md new file mode 100644 index 000000000..5f62dead9 --- /dev/null +++ b/docs/reference/api/SecurityEnableUserRequest.md @@ -0,0 +1,8 @@ +## Interface `SecurityEnableUserRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { username?: never; refresh?: never; }) | All values in `body` will be added to the request body. | +| `querystring` | { [key: string]: any; } & { username?: never; refresh?: never; } | All values in `querystring` will be added to the request querystring. | +| `refresh` | [Refresh](./Refresh.md) | If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. | +| `username` | [Username](./Username.md) | An identifier for the user. | diff --git a/docs/reference/api/SecurityEnableUserResponse.md b/docs/reference/api/SecurityEnableUserResponse.md new file mode 100644 index 000000000..1756bdc38 --- /dev/null +++ b/docs/reference/api/SecurityEnableUserResponse.md @@ -0,0 +1,4 @@ +## Interface `SecurityEnableUserResponse` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/SecurityEnrollKibanaRequest.md b/docs/reference/api/SecurityEnrollKibanaRequest.md new file mode 100644 index 000000000..183ebd629 --- /dev/null +++ b/docs/reference/api/SecurityEnrollKibanaRequest.md @@ -0,0 +1,6 @@ +## Interface `SecurityEnrollKibanaRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | { [key: string]: any; } | All values in `body` will be added to the request body. | +| `querystring` | { [key: string]: any; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/SecurityEnrollKibanaResponse.md b/docs/reference/api/SecurityEnrollKibanaResponse.md new file mode 100644 index 000000000..6719c5341 --- /dev/null +++ b/docs/reference/api/SecurityEnrollKibanaResponse.md @@ -0,0 +1,6 @@ +## Interface `SecurityEnrollKibanaResponse` + +| Name | Type | Description | +| - | - | - | +| `http_ca` | string | The CA certificate used to sign the node certificates that Elasticsearch uses for TLS on the HTTP layer. The certificate is returned as a Base64 encoded string of the ASN.1 DER encoding of the certificate. | +| `token` | [SecurityEnrollKibanaToken](./SecurityEnrollKibanaToken.md) |   | diff --git a/docs/reference/api/SecurityEnrollKibanaToken.md b/docs/reference/api/SecurityEnrollKibanaToken.md new file mode 100644 index 000000000..25882bac2 --- /dev/null +++ b/docs/reference/api/SecurityEnrollKibanaToken.md @@ -0,0 +1,6 @@ +## Interface `SecurityEnrollKibanaToken` + +| Name | Type | Description | +| - | - | - | +| `name` | string | The name of the bearer token for the `elastic/kibana` service account. | +| `value` | string | The value of the bearer token for the `elastic/kibana` service account. Use this value to authenticate the service account with Elasticsearch. | diff --git a/docs/reference/api/SecurityEnrollNodeRequest.md b/docs/reference/api/SecurityEnrollNodeRequest.md new file mode 100644 index 000000000..2ad881402 --- /dev/null +++ b/docs/reference/api/SecurityEnrollNodeRequest.md @@ -0,0 +1,6 @@ +## Interface `SecurityEnrollNodeRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | { [key: string]: any; } | All values in `body` will be added to the request body. | +| `querystring` | { [key: string]: any; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/SecurityEnrollNodeResponse.md b/docs/reference/api/SecurityEnrollNodeResponse.md new file mode 100644 index 000000000..6f3e38f17 --- /dev/null +++ b/docs/reference/api/SecurityEnrollNodeResponse.md @@ -0,0 +1,10 @@ +## Interface `SecurityEnrollNodeResponse` + +| Name | Type | Description | +| - | - | - | +| `http_ca_cert` | string | The CA certificate that can be used by the new node in order to sign its certificate for the HTTP layer, as a Base64 encoded string of the ASN.1 DER encoding of the certificate. | +| `http_ca_key` | string | The CA private key that can be used by the new node in order to sign its certificate for the HTTP layer, as a Base64 encoded string of the ASN.1 DER encoding of the key. | +| `nodes_addresses` | string[] | A list of transport addresses in the form of `host:port` for the nodes that are already members of the cluster. | +| `transport_ca_cert` | string | The CA certificate that is used to sign the TLS certificate for the transport layer, as a Base64 encoded string of the ASN.1 DER encoding of the certificate. | +| `transport_cert` | string | The certificate that the node can use for TLS for its transport layer, as a Base64 encoded string of the ASN.1 DER encoding of the certificate. | +| `transport_key` | string | The private key that the node can use for TLS for its transport layer, as a Base64 encoded string of the ASN.1 DER encoding of the key. | diff --git a/docs/reference/api/SecurityFieldSecurity.md b/docs/reference/api/SecurityFieldSecurity.md new file mode 100644 index 000000000..6cdf2d0cd --- /dev/null +++ b/docs/reference/api/SecurityFieldSecurity.md @@ -0,0 +1,6 @@ +## Interface `SecurityFieldSecurity` + +| Name | Type | Description | +| - | - | - | +| `except` | [Fields](./Fields.md) |   | +| `grant` | [Fields](./Fields.md) |   | diff --git a/docs/reference/api/SecurityGetApiKeyRequest.md b/docs/reference/api/SecurityGetApiKeyRequest.md new file mode 100644 index 000000000..fa424f512 --- /dev/null +++ b/docs/reference/api/SecurityGetApiKeyRequest.md @@ -0,0 +1,14 @@ +## Interface `SecurityGetApiKeyRequest` + +| Name | Type | Description | +| - | - | - | +| `active_only` | boolean | A boolean flag that can be used to query API keys that are currently active. An API key is considered active if it is neither invalidated, nor expired at query time. You can specify this together with other parameters such as `owner` or `name`. If `active_only` is false, the response will include both active and inactive (expired or invalidated) keys. | +| `body` | string | ({ [key: string]: any; } & { id?: never; name?: never; owner?: never; realm_name?: never; username?: never; with_limited_by?: never; active_only?: never; with_profile_uid?: never; }) | All values in `body` will be added to the request body. | +| `id` | [Id](./Id.md) | An API key id. This parameter cannot be used with any of `name`, `realm_name` or `username`. | +| `name` | [Name](./Name.md) | An API key name. This parameter cannot be used with any of `id`, `realm_name` or `username`. It supports prefix search with wildcard. | +| `owner` | boolean | A boolean flag that can be used to query API keys owned by the currently authenticated user. The `realm_name` or `username` parameters cannot be specified when this parameter is set to `true` as they are assumed to be the currently authenticated ones. | +| `querystring` | { [key: string]: any; } & { id?: never; name?: never; owner?: never; realm_name?: never; username?: never; with_limited_by?: never; active_only?: never; with_profile_uid?: never; } | All values in `querystring` will be added to the request querystring. | +| `realm_name` | [Name](./Name.md) | The name of an authentication realm. This parameter cannot be used with either `id` or `name` or when `owner` flag is set to `true`. | +| `username` | [Username](./Username.md) | The username of a user. This parameter cannot be used with either `id` or `name` or when `owner` flag is set to `true`. | +| `with_limited_by` | boolean | Return the snapshot of the owner user's role descriptors associated with the API key. An API key's actual permission is the intersection of its assigned role descriptors and the owner user's role descriptors. | +| `with_profile_uid` | boolean | Determines whether to also retrieve the profile uid, for the API key owner principal, if it exists. | diff --git a/docs/reference/api/SecurityGetApiKeyResponse.md b/docs/reference/api/SecurityGetApiKeyResponse.md new file mode 100644 index 000000000..1d54a47a5 --- /dev/null +++ b/docs/reference/api/SecurityGetApiKeyResponse.md @@ -0,0 +1,5 @@ +## Interface `SecurityGetApiKeyResponse` + +| Name | Type | Description | +| - | - | - | +| `api_keys` | [SecurityApiKey](./SecurityApiKey.md)[] |   | diff --git a/docs/reference/api/SecurityGetBuiltinPrivilegesRequest.md b/docs/reference/api/SecurityGetBuiltinPrivilegesRequest.md new file mode 100644 index 000000000..450bb4fcc --- /dev/null +++ b/docs/reference/api/SecurityGetBuiltinPrivilegesRequest.md @@ -0,0 +1,6 @@ +## Interface `SecurityGetBuiltinPrivilegesRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | { [key: string]: any; } | All values in `body` will be added to the request body. | +| `querystring` | { [key: string]: any; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/SecurityGetBuiltinPrivilegesResponse.md b/docs/reference/api/SecurityGetBuiltinPrivilegesResponse.md new file mode 100644 index 000000000..3eab4f3a0 --- /dev/null +++ b/docs/reference/api/SecurityGetBuiltinPrivilegesResponse.md @@ -0,0 +1,7 @@ +## Interface `SecurityGetBuiltinPrivilegesResponse` + +| Name | Type | Description | +| - | - | - | +| `cluster` | [SecurityClusterPrivilege](./SecurityClusterPrivilege.md)[] | The list of cluster privileges that are understood by this version of Elasticsearch. | +| `index` | [IndexName](./IndexName.md)[] | The list of index privileges that are understood by this version of Elasticsearch. | +| `remote_cluster` | [SecurityRemoteClusterPrivilege](./SecurityRemoteClusterPrivilege.md)[] | The list of remote_cluster privileges that are understood by this version of Elasticsearch. | diff --git a/docs/reference/api/SecurityGetPrivilegesRequest.md b/docs/reference/api/SecurityGetPrivilegesRequest.md new file mode 100644 index 000000000..72f490174 --- /dev/null +++ b/docs/reference/api/SecurityGetPrivilegesRequest.md @@ -0,0 +1,8 @@ +## Interface `SecurityGetPrivilegesRequest` + +| Name | Type | Description | +| - | - | - | +| `application` | [Name](./Name.md) | The name of the application. Application privileges are always associated with exactly one application. If you do not specify this parameter, the API returns information about all privileges for all applications. | +| `body` | string | ({ [key: string]: any; } & { application?: never; name?: never; }) | All values in `body` will be added to the request body. | +| `name` | [Names](./Names.md) | The name of the privilege. If you do not specify this parameter, the API returns information about all privileges for the requested application. | +| `querystring` | { [key: string]: any; } & { application?: never; name?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/SecurityGetPrivilegesResponse.md b/docs/reference/api/SecurityGetPrivilegesResponse.md new file mode 100644 index 000000000..e5c3525da --- /dev/null +++ b/docs/reference/api/SecurityGetPrivilegesResponse.md @@ -0,0 +1,4 @@ +## `SecurityGetPrivilegesResponse` +::: +type SecurityGetPrivilegesResponse = Record>; +::: diff --git a/docs/reference/api/SecurityGetRoleMappingRequest.md b/docs/reference/api/SecurityGetRoleMappingRequest.md new file mode 100644 index 000000000..7c6c8eac9 --- /dev/null +++ b/docs/reference/api/SecurityGetRoleMappingRequest.md @@ -0,0 +1,7 @@ +## Interface `SecurityGetRoleMappingRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { name?: never; }) | All values in `body` will be added to the request body. | +| `name` | [Names](./Names.md) | The distinct name that identifies the role mapping. The name is used solely as an identifier to facilitate interaction via the API; it does not affect the behavior of the mapping in any way. You can specify multiple mapping names as a comma-separated list. If you do not specify this parameter, the API returns information about all role mappings. | +| `querystring` | { [key: string]: any; } & { name?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/SecurityGetRoleMappingResponse.md b/docs/reference/api/SecurityGetRoleMappingResponse.md new file mode 100644 index 000000000..ba0e06812 --- /dev/null +++ b/docs/reference/api/SecurityGetRoleMappingResponse.md @@ -0,0 +1,4 @@ +## `SecurityGetRoleMappingResponse` +::: +type SecurityGetRoleMappingResponse = Record; +::: diff --git a/docs/reference/api/SecurityGetRoleRequest.md b/docs/reference/api/SecurityGetRoleRequest.md new file mode 100644 index 000000000..feeef77d9 --- /dev/null +++ b/docs/reference/api/SecurityGetRoleRequest.md @@ -0,0 +1,7 @@ +## Interface `SecurityGetRoleRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { name?: never; }) | All values in `body` will be added to the request body. | +| `name` | [Names](./Names.md) | The name of the role. You can specify multiple roles as a comma-separated list. If you do not specify this parameter, the API returns information about all roles. | +| `querystring` | { [key: string]: any; } & { name?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/SecurityGetRoleResponse.md b/docs/reference/api/SecurityGetRoleResponse.md new file mode 100644 index 000000000..ec3f4bf64 --- /dev/null +++ b/docs/reference/api/SecurityGetRoleResponse.md @@ -0,0 +1,4 @@ +## `SecurityGetRoleResponse` +::: +type SecurityGetRoleResponse = Record; +::: diff --git a/docs/reference/api/SecurityGetRoleRole.md b/docs/reference/api/SecurityGetRoleRole.md new file mode 100644 index 000000000..27c3132a6 --- /dev/null +++ b/docs/reference/api/SecurityGetRoleRole.md @@ -0,0 +1,15 @@ +## Interface `SecurityGetRoleRole` + +| Name | Type | Description | +| - | - | - | +| `applications` | [SecurityApplicationPrivileges](./SecurityApplicationPrivileges.md)[] |   | +| `cluster` | [SecurityClusterPrivilege](./SecurityClusterPrivilege.md)[] |   | +| `description` | string |   | +| `global` | Record>> |   | +| `indices` | [SecurityIndicesPrivileges](./SecurityIndicesPrivileges.md)[] |   | +| `metadata` | [Metadata](./Metadata.md) |   | +| `remote_cluster` | [SecurityRemoteClusterPrivileges](./SecurityRemoteClusterPrivileges.md)[] |   | +| `remote_indices` | [SecurityRemoteIndicesPrivileges](./SecurityRemoteIndicesPrivileges.md)[] |   | +| `role_templates` | [SecurityRoleTemplate](./SecurityRoleTemplate.md)[] |   | +| `run_as` | string[] |   | +| `transient_metadata` | Record |   | diff --git a/docs/reference/api/SecurityGetServiceAccountsRequest.md b/docs/reference/api/SecurityGetServiceAccountsRequest.md new file mode 100644 index 000000000..a59284442 --- /dev/null +++ b/docs/reference/api/SecurityGetServiceAccountsRequest.md @@ -0,0 +1,8 @@ +## Interface `SecurityGetServiceAccountsRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { namespace?: never; service?: never; }) | All values in `body` will be added to the request body. | +| `namespace` | [Namespace](./Namespace.md) | The name of the namespace. Omit this parameter to retrieve information about all service accounts. If you omit this parameter, you must also omit the `service` parameter. | +| `querystring` | { [key: string]: any; } & { namespace?: never; service?: never; } | All values in `querystring` will be added to the request querystring. | +| `service` | [Service](./Service.md) | The service name. Omit this parameter to retrieve information about all service accounts that belong to the specified `namespace`. | diff --git a/docs/reference/api/SecurityGetServiceAccountsResponse.md b/docs/reference/api/SecurityGetServiceAccountsResponse.md new file mode 100644 index 000000000..ac878b1b5 --- /dev/null +++ b/docs/reference/api/SecurityGetServiceAccountsResponse.md @@ -0,0 +1,4 @@ +## `SecurityGetServiceAccountsResponse` +::: +type SecurityGetServiceAccountsResponse = Record; +::: diff --git a/docs/reference/api/SecurityGetServiceAccountsRoleDescriptorWrapper.md b/docs/reference/api/SecurityGetServiceAccountsRoleDescriptorWrapper.md new file mode 100644 index 000000000..625a013bc --- /dev/null +++ b/docs/reference/api/SecurityGetServiceAccountsRoleDescriptorWrapper.md @@ -0,0 +1,5 @@ +## Interface `SecurityGetServiceAccountsRoleDescriptorWrapper` + +| Name | Type | Description | +| - | - | - | +| `role_descriptor` | [SecurityRoleDescriptorRead](./SecurityRoleDescriptorRead.md) |   | diff --git a/docs/reference/api/SecurityGetServiceCredentialsNodesCredentials.md b/docs/reference/api/SecurityGetServiceCredentialsNodesCredentials.md new file mode 100644 index 000000000..1ef48e23a --- /dev/null +++ b/docs/reference/api/SecurityGetServiceCredentialsNodesCredentials.md @@ -0,0 +1,6 @@ +## Interface `SecurityGetServiceCredentialsNodesCredentials` + +| Name | Type | Description | +| - | - | - | +| `_nodes` | [NodeStatistics](./NodeStatistics.md) | General status showing how nodes respond to the above collection request | +| `file_tokens` | Record | File-backed tokens collected from all nodes | diff --git a/docs/reference/api/SecurityGetServiceCredentialsNodesCredentialsFileToken.md b/docs/reference/api/SecurityGetServiceCredentialsNodesCredentialsFileToken.md new file mode 100644 index 000000000..1520e6ae8 --- /dev/null +++ b/docs/reference/api/SecurityGetServiceCredentialsNodesCredentialsFileToken.md @@ -0,0 +1,5 @@ +## Interface `SecurityGetServiceCredentialsNodesCredentialsFileToken` + +| Name | Type | Description | +| - | - | - | +| `nodes` | string[] |   | diff --git a/docs/reference/api/SecurityGetServiceCredentialsRequest.md b/docs/reference/api/SecurityGetServiceCredentialsRequest.md new file mode 100644 index 000000000..b2175a8fc --- /dev/null +++ b/docs/reference/api/SecurityGetServiceCredentialsRequest.md @@ -0,0 +1,8 @@ +## Interface `SecurityGetServiceCredentialsRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { namespace?: never; service?: never; }) | All values in `body` will be added to the request body. | +| `namespace` | [Namespace](./Namespace.md) | The name of the namespace. | +| `querystring` | { [key: string]: any; } & { namespace?: never; service?: never; } | All values in `querystring` will be added to the request querystring. | +| `service` | [Name](./Name.md) | The service name. | diff --git a/docs/reference/api/SecurityGetServiceCredentialsResponse.md b/docs/reference/api/SecurityGetServiceCredentialsResponse.md new file mode 100644 index 000000000..492a5ddf3 --- /dev/null +++ b/docs/reference/api/SecurityGetServiceCredentialsResponse.md @@ -0,0 +1,8 @@ +## Interface `SecurityGetServiceCredentialsResponse` + +| Name | Type | Description | +| - | - | - | +| `count` | [integer](./integer.md) |   | +| `nodes_credentials` | [SecurityGetServiceCredentialsNodesCredentials](./SecurityGetServiceCredentialsNodesCredentials.md) | Service account credentials collected from all nodes of the cluster. | +| `service_account` | string |   | +| `tokens` | Record |   | diff --git a/docs/reference/api/SecurityGetSettingsRequest.md b/docs/reference/api/SecurityGetSettingsRequest.md new file mode 100644 index 000000000..5cd67a893 --- /dev/null +++ b/docs/reference/api/SecurityGetSettingsRequest.md @@ -0,0 +1,7 @@ +## Interface `SecurityGetSettingsRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { master_timeout?: never; }) | All values in `body` will be added to the request body. | +| `master_timeout` | [Duration](./Duration.md) | Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. | +| `querystring` | { [key: string]: any; } & { master_timeout?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/SecurityGetSettingsResponse.md b/docs/reference/api/SecurityGetSettingsResponse.md new file mode 100644 index 000000000..c9f2a7c93 --- /dev/null +++ b/docs/reference/api/SecurityGetSettingsResponse.md @@ -0,0 +1,7 @@ +## Interface `SecurityGetSettingsResponse` + +| Name | Type | Description | +| - | - | - | +| `"security-profile"` | [SecuritySecuritySettings](./SecuritySecuritySettings.md) | Settings for the index used to store profile information. | +| `"security-tokens"` | [SecuritySecuritySettings](./SecuritySecuritySettings.md) | Settings for the index used to store tokens. | +| `security` | [SecuritySecuritySettings](./SecuritySecuritySettings.md) | Settings for the index used for most security configuration, including native realm users and roles configured with the API. | diff --git a/docs/reference/api/SecurityGetTokenAccessTokenGrantType.md b/docs/reference/api/SecurityGetTokenAccessTokenGrantType.md new file mode 100644 index 000000000..cd9f7cf55 --- /dev/null +++ b/docs/reference/api/SecurityGetTokenAccessTokenGrantType.md @@ -0,0 +1,4 @@ +## `SecurityGetTokenAccessTokenGrantType` +::: +type SecurityGetTokenAccessTokenGrantType = 'password' | 'client_credentials' | '_kerberos' | 'refresh_token'; +::: diff --git a/docs/reference/api/SecurityGetTokenAuthenticatedUser.md b/docs/reference/api/SecurityGetTokenAuthenticatedUser.md new file mode 100644 index 000000000..2045fb9c8 --- /dev/null +++ b/docs/reference/api/SecurityGetTokenAuthenticatedUser.md @@ -0,0 +1,8 @@ +## Interface `SecurityGetTokenAuthenticatedUser` + +| Name | Type | Description | +| - | - | - | +| `authentication_provider` | [SecurityGetTokenAuthenticationProvider](./SecurityGetTokenAuthenticationProvider.md) |   | +| `authentication_realm` | [SecurityGetTokenUserRealm](./SecurityGetTokenUserRealm.md) |   | +| `authentication_type` | string |   | +| `lookup_realm` | [SecurityGetTokenUserRealm](./SecurityGetTokenUserRealm.md) |   | diff --git a/docs/reference/api/SecurityGetTokenAuthenticationProvider.md b/docs/reference/api/SecurityGetTokenAuthenticationProvider.md new file mode 100644 index 000000000..55a3d4395 --- /dev/null +++ b/docs/reference/api/SecurityGetTokenAuthenticationProvider.md @@ -0,0 +1,6 @@ +## Interface `SecurityGetTokenAuthenticationProvider` + +| Name | Type | Description | +| - | - | - | +| `name` | [Name](./Name.md) |   | +| `type` | string |   | diff --git a/docs/reference/api/SecurityGetTokenRequest.md b/docs/reference/api/SecurityGetTokenRequest.md new file mode 100644 index 000000000..c599487b7 --- /dev/null +++ b/docs/reference/api/SecurityGetTokenRequest.md @@ -0,0 +1,12 @@ +## Interface `SecurityGetTokenRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { grant_type?: never; scope?: never; password?: never; kerberos_ticket?: never; refresh_token?: never; username?: never; }) | All values in `body` will be added to the request body. | +| `grant_type` | [SecurityGetTokenAccessTokenGrantType](./SecurityGetTokenAccessTokenGrantType.md) | The type of grant. Supported grant types are: `password`, `_kerberos`, `client_credentials`, and `refresh_token`. | +| `kerberos_ticket` | string | The base64 encoded kerberos ticket. If you specify the `_kerberos` grant type, this parameter is required. This parameter is not valid with any other supported grant type. | +| `password` | [Password](./Password.md) | The user's password. If you specify the `password` grant type, this parameter is required. This parameter is not valid with any other supported grant type. | +| `querystring` | { [key: string]: any; } & { grant_type?: never; scope?: never; password?: never; kerberos_ticket?: never; refresh_token?: never; username?: never; } | All values in `querystring` will be added to the request querystring. | +| `refresh_token` | string | The string that was returned when you created the token, which enables you to extend its life. If you specify the `refresh_token` grant type, this parameter is required. This parameter is not valid with any other supported grant type. | +| `scope` | string | The scope of the token. Currently tokens are only issued for a scope of FULL regardless of the value sent with the request. | +| `username` | [Username](./Username.md) | The username that identifies the user. If you specify the `password` grant type, this parameter is required. This parameter is not valid with any other supported grant type. | diff --git a/docs/reference/api/SecurityGetTokenResponse.md b/docs/reference/api/SecurityGetTokenResponse.md new file mode 100644 index 000000000..59578de56 --- /dev/null +++ b/docs/reference/api/SecurityGetTokenResponse.md @@ -0,0 +1,11 @@ +## Interface `SecurityGetTokenResponse` + +| Name | Type | Description | +| - | - | - | +| `access_token` | string |   | +| `authentication` | [SecurityGetTokenAuthenticatedUser](./SecurityGetTokenAuthenticatedUser.md) |   | +| `expires_in` | [long](./long.md) |   | +| `kerberos_authentication_response_token` | string |   | +| `refresh_token` | string |   | +| `scope` | string |   | +| `type` | string |   | diff --git a/docs/reference/api/SecurityGetTokenUserRealm.md b/docs/reference/api/SecurityGetTokenUserRealm.md new file mode 100644 index 000000000..04f311387 --- /dev/null +++ b/docs/reference/api/SecurityGetTokenUserRealm.md @@ -0,0 +1,6 @@ +## Interface `SecurityGetTokenUserRealm` + +| Name | Type | Description | +| - | - | - | +| `name` | [Name](./Name.md) |   | +| `type` | string |   | diff --git a/docs/reference/api/SecurityGetUserPrivilegesRequest.md b/docs/reference/api/SecurityGetUserPrivilegesRequest.md new file mode 100644 index 000000000..b73ec0987 --- /dev/null +++ b/docs/reference/api/SecurityGetUserPrivilegesRequest.md @@ -0,0 +1,9 @@ +## Interface `SecurityGetUserPrivilegesRequest` + +| Name | Type | Description | +| - | - | - | +| `application` | [Name](./Name.md) | The name of the application. Application privileges are always associated with exactly one application. If you do not specify this parameter, the API returns information about all privileges for all applications. | +| `body` | string | ({ [key: string]: any; } & { application?: never; priviledge?: never; username?: never; }) | All values in `body` will be added to the request body. | +| `priviledge` | [Name](./Name.md) | The name of the privilege. If you do not specify this parameter, the API returns information about all privileges for the requested application. | +| `querystring` | { [key: string]: any; } & { application?: never; priviledge?: never; username?: never; } | All values in `querystring` will be added to the request querystring. | +| `username` | [Name](./Name.md) | null |   | diff --git a/docs/reference/api/SecurityGetUserPrivilegesResponse.md b/docs/reference/api/SecurityGetUserPrivilegesResponse.md new file mode 100644 index 000000000..7db1a9d63 --- /dev/null +++ b/docs/reference/api/SecurityGetUserPrivilegesResponse.md @@ -0,0 +1,11 @@ +## Interface `SecurityGetUserPrivilegesResponse` + +| Name | Type | Description | +| - | - | - | +| `applications` | [SecurityApplicationPrivileges](./SecurityApplicationPrivileges.md)[] |   | +| `cluster` | string[] |   | +| `global` | [SecurityGlobalPrivilege](./SecurityGlobalPrivilege.md)[] |   | +| `indices` | [SecurityUserIndicesPrivileges](./SecurityUserIndicesPrivileges.md)[] |   | +| `remote_cluster` | [SecurityRemoteClusterPrivileges](./SecurityRemoteClusterPrivileges.md)[] |   | +| `remote_indices` | [SecurityRemoteUserIndicesPrivileges](./SecurityRemoteUserIndicesPrivileges.md)[] |   | +| `run_as` | string[] |   | diff --git a/docs/reference/api/SecurityGetUserProfileGetUserProfileErrors.md b/docs/reference/api/SecurityGetUserProfileGetUserProfileErrors.md new file mode 100644 index 000000000..3b1e370bc --- /dev/null +++ b/docs/reference/api/SecurityGetUserProfileGetUserProfileErrors.md @@ -0,0 +1,6 @@ +## Interface `SecurityGetUserProfileGetUserProfileErrors` + +| Name | Type | Description | +| - | - | - | +| `count` | [long](./long.md) |   | +| `details` | Record<[SecurityUserProfileId](./SecurityUserProfileId.md), [ErrorCause](./ErrorCause.md)> |   | diff --git a/docs/reference/api/SecurityGetUserProfileRequest.md b/docs/reference/api/SecurityGetUserProfileRequest.md new file mode 100644 index 000000000..d84ea23b4 --- /dev/null +++ b/docs/reference/api/SecurityGetUserProfileRequest.md @@ -0,0 +1,8 @@ +## Interface `SecurityGetUserProfileRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { uid?: never; data?: never; }) | All values in `body` will be added to the request body. | +| `data` | string | string[] | A comma-separated list of filters for the `data` field of the profile document. To return all content use `data=*`. To return a subset of content use `data=` to retrieve content nested under the specified ``. By default returns no `data` content. | +| `querystring` | { [key: string]: any; } & { uid?: never; data?: never; } | All values in `querystring` will be added to the request querystring. | +| `uid` | [SecurityUserProfileId](./SecurityUserProfileId.md) | [SecurityUserProfileId](./SecurityUserProfileId.md)[] | A unique identifier for the user profile. | diff --git a/docs/reference/api/SecurityGetUserProfileResponse.md b/docs/reference/api/SecurityGetUserProfileResponse.md new file mode 100644 index 000000000..76afd530f --- /dev/null +++ b/docs/reference/api/SecurityGetUserProfileResponse.md @@ -0,0 +1,6 @@ +## Interface `SecurityGetUserProfileResponse` + +| Name | Type | Description | +| - | - | - | +| `errors` | [SecurityGetUserProfileGetUserProfileErrors](./SecurityGetUserProfileGetUserProfileErrors.md) |   | +| `profiles` | [SecurityUserProfileWithMetadata](./SecurityUserProfileWithMetadata.md)[] | A successful call returns the JSON representation of the user profile and its internal versioning numbers. The API returns an empty object if no profile document is found for the provided `uid`. The content of the data field is not returned by default to avoid deserializing a potential large payload. | diff --git a/docs/reference/api/SecurityGetUserRequest.md b/docs/reference/api/SecurityGetUserRequest.md new file mode 100644 index 000000000..6e089fdd7 --- /dev/null +++ b/docs/reference/api/SecurityGetUserRequest.md @@ -0,0 +1,8 @@ +## Interface `SecurityGetUserRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { username?: never; with_profile_uid?: never; }) | All values in `body` will be added to the request body. | +| `querystring` | { [key: string]: any; } & { username?: never; with_profile_uid?: never; } | All values in `querystring` will be added to the request querystring. | +| `username` | [Username](./Username.md) | [Username](./Username.md)[] | An identifier for the user. You can specify multiple usernames as a comma-separated list. If you omit this parameter, the API retrieves information about all users. | +| `with_profile_uid` | boolean | Determines whether to retrieve the user profile UID, if it exists, for the users. | diff --git a/docs/reference/api/SecurityGetUserResponse.md b/docs/reference/api/SecurityGetUserResponse.md new file mode 100644 index 000000000..f5abca3e0 --- /dev/null +++ b/docs/reference/api/SecurityGetUserResponse.md @@ -0,0 +1,4 @@ +## `SecurityGetUserResponse` +::: +type SecurityGetUserResponse = Record; +::: diff --git a/docs/reference/api/SecurityGlobalPrivilege.md b/docs/reference/api/SecurityGlobalPrivilege.md new file mode 100644 index 000000000..59ea2338e --- /dev/null +++ b/docs/reference/api/SecurityGlobalPrivilege.md @@ -0,0 +1,5 @@ +## Interface `SecurityGlobalPrivilege` + +| Name | Type | Description | +| - | - | - | +| `application` | [SecurityApplicationGlobalUserPrivileges](./SecurityApplicationGlobalUserPrivileges.md) |   | diff --git a/docs/reference/api/SecurityGrantApiKeyApiKeyGrantType.md b/docs/reference/api/SecurityGrantApiKeyApiKeyGrantType.md new file mode 100644 index 000000000..e14a61a86 --- /dev/null +++ b/docs/reference/api/SecurityGrantApiKeyApiKeyGrantType.md @@ -0,0 +1,4 @@ +## `SecurityGrantApiKeyApiKeyGrantType` +::: +type SecurityGrantApiKeyApiKeyGrantType = 'access_token' | 'password'; +::: diff --git a/docs/reference/api/SecurityGrantApiKeyGrantApiKey.md b/docs/reference/api/SecurityGrantApiKeyGrantApiKey.md new file mode 100644 index 000000000..2480c9ab0 --- /dev/null +++ b/docs/reference/api/SecurityGrantApiKeyGrantApiKey.md @@ -0,0 +1,8 @@ +## Interface `SecurityGrantApiKeyGrantApiKey` + +| Name | Type | Description | +| - | - | - | +| `expiration` | [DurationLarge](./DurationLarge.md) | Expiration time for the API key. By default, API keys never expire. | +| `metadata` | [Metadata](./Metadata.md) | Arbitrary metadata that you want to associate with the API key. It supports nested data structure. Within the `metadata` object, keys beginning with `_` are reserved for system usage. | +| `name` | [Name](./Name.md) |   | +| `role_descriptors` | Record | Record[] | The role descriptors for this API key. When it is not specified or is an empty array, the API key has a point in time snapshot of permissions of the specified user or access token. If you supply role descriptors, the resultant permissions are an intersection of API keys permissions and the permissions of the user or access token. | diff --git a/docs/reference/api/SecurityGrantApiKeyRequest.md b/docs/reference/api/SecurityGrantApiKeyRequest.md new file mode 100644 index 000000000..41d8f01fc --- /dev/null +++ b/docs/reference/api/SecurityGrantApiKeyRequest.md @@ -0,0 +1,12 @@ +## Interface `SecurityGrantApiKeyRequest` + +| Name | Type | Description | +| - | - | - | +| `access_token` | string | The user's access token. If you specify the `access_token` grant type, this parameter is required. It is not valid with other grant types. | +| `api_key` | [SecurityGrantApiKeyGrantApiKey](./SecurityGrantApiKeyGrantApiKey.md) | The API key. | +| `body` | string | ({ [key: string]: any; } & { api_key?: never; grant_type?: never; access_token?: never; username?: never; password?: never; run_as?: never; }) | All values in `body` will be added to the request body. | +| `grant_type` | [SecurityGrantApiKeyApiKeyGrantType](./SecurityGrantApiKeyApiKeyGrantType.md) | The type of grant. Supported grant types are: `access_token`, `password`. | +| `password` | [Password](./Password.md) | The user's password. If you specify the `password` grant type, this parameter is required. It is not valid with other grant types. | +| `querystring` | { [key: string]: any; } & { api_key?: never; grant_type?: never; access_token?: never; username?: never; password?: never; run_as?: never; } | All values in `querystring` will be added to the request querystring. | +| `run_as` | [Username](./Username.md) | The name of the user to be impersonated. | +| `username` | [Username](./Username.md) | The user name that identifies the user. If you specify the `password` grant type, this parameter is required. It is not valid with other grant types. | diff --git a/docs/reference/api/SecurityGrantApiKeyResponse.md b/docs/reference/api/SecurityGrantApiKeyResponse.md new file mode 100644 index 000000000..9286dd4f4 --- /dev/null +++ b/docs/reference/api/SecurityGrantApiKeyResponse.md @@ -0,0 +1,9 @@ +## Interface `SecurityGrantApiKeyResponse` + +| Name | Type | Description | +| - | - | - | +| `api_key` | string |   | +| `encoded` | string |   | +| `expiration` | [EpochTime](./EpochTime.md)<[UnitMillis](./UnitMillis.md)> |   | +| `id` | [Id](./Id.md) |   | +| `name` | [Name](./Name.md) |   | diff --git a/docs/reference/api/SecurityGrantType.md b/docs/reference/api/SecurityGrantType.md new file mode 100644 index 000000000..c296010a7 --- /dev/null +++ b/docs/reference/api/SecurityGrantType.md @@ -0,0 +1,4 @@ +## `SecurityGrantType` +::: +type SecurityGrantType = 'password' | 'access_token'; +::: diff --git a/docs/reference/api/SecurityHasPrivilegesApplicationPrivilegesCheck.md b/docs/reference/api/SecurityHasPrivilegesApplicationPrivilegesCheck.md new file mode 100644 index 000000000..c9ad1aafb --- /dev/null +++ b/docs/reference/api/SecurityHasPrivilegesApplicationPrivilegesCheck.md @@ -0,0 +1,7 @@ +## Interface `SecurityHasPrivilegesApplicationPrivilegesCheck` + +| Name | Type | Description | +| - | - | - | +| `application` | string | The name of the application. | +| `privileges` | string[] | A list of the privileges that you want to check for the specified resources. It may be either application privilege names or the names of actions that are granted by those privileges | +| `resources` | string[] | A list of resource names against which the privileges should be checked. | diff --git a/docs/reference/api/SecurityHasPrivilegesApplicationsPrivileges.md b/docs/reference/api/SecurityHasPrivilegesApplicationsPrivileges.md new file mode 100644 index 000000000..2f62c478b --- /dev/null +++ b/docs/reference/api/SecurityHasPrivilegesApplicationsPrivileges.md @@ -0,0 +1,4 @@ +## `SecurityHasPrivilegesApplicationsPrivileges` +::: +type SecurityHasPrivilegesApplicationsPrivileges = Record<[Name](./Name.md), [SecurityHasPrivilegesResourcePrivileges](./SecurityHasPrivilegesResourcePrivileges.md)>; +::: diff --git a/docs/reference/api/SecurityHasPrivilegesIndexPrivilegesCheck.md b/docs/reference/api/SecurityHasPrivilegesIndexPrivilegesCheck.md new file mode 100644 index 000000000..74b1c3f33 --- /dev/null +++ b/docs/reference/api/SecurityHasPrivilegesIndexPrivilegesCheck.md @@ -0,0 +1,7 @@ +## Interface `SecurityHasPrivilegesIndexPrivilegesCheck` + +| Name | Type | Description | +| - | - | - | +| `allow_restricted_indices` | boolean | This needs to be set to `true` (default is `false`) if using wildcards or regexps for patterns that cover restricted indices. Implicitly, restricted indices do not match index patterns because restricted indices usually have limited privileges and including them in pattern tests would render most such tests false. If restricted indices are explicitly included in the names list, privileges will be checked against them regardless of the value of `allow_restricted_indices`. | +| `names` | [Indices](./Indices.md) | A list of indices. | +| `privileges` | [SecurityIndexPrivilege](./SecurityIndexPrivilege.md)[] | A list of the privileges that you want to check for the specified indices. | diff --git a/docs/reference/api/SecurityHasPrivilegesPrivileges.md b/docs/reference/api/SecurityHasPrivilegesPrivileges.md new file mode 100644 index 000000000..c1d75cbec --- /dev/null +++ b/docs/reference/api/SecurityHasPrivilegesPrivileges.md @@ -0,0 +1,4 @@ +## `SecurityHasPrivilegesPrivileges` +::: +type SecurityHasPrivilegesPrivileges = Record; +::: diff --git a/docs/reference/api/SecurityHasPrivilegesRequest.md b/docs/reference/api/SecurityHasPrivilegesRequest.md new file mode 100644 index 000000000..0a5fe9290 --- /dev/null +++ b/docs/reference/api/SecurityHasPrivilegesRequest.md @@ -0,0 +1,10 @@ +## Interface `SecurityHasPrivilegesRequest` + +| Name | Type | Description | +| - | - | - | +| `application` | [SecurityHasPrivilegesApplicationPrivilegesCheck](./SecurityHasPrivilegesApplicationPrivilegesCheck.md)[] |   | +| `body` | string | ({ [key: string]: any; } & { user?: never; application?: never; cluster?: never; index?: never; }) | All values in `body` will be added to the request body. | +| `cluster` | [SecurityClusterPrivilege](./SecurityClusterPrivilege.md)[] | A list of the cluster privileges that you want to check. | +| `index` | [SecurityHasPrivilegesIndexPrivilegesCheck](./SecurityHasPrivilegesIndexPrivilegesCheck.md)[] |   | +| `querystring` | { [key: string]: any; } & { user?: never; application?: never; cluster?: never; index?: never; } | All values in `querystring` will be added to the request querystring. | +| `user` | [Name](./Name.md) | Username | diff --git a/docs/reference/api/SecurityHasPrivilegesResourcePrivileges.md b/docs/reference/api/SecurityHasPrivilegesResourcePrivileges.md new file mode 100644 index 000000000..dbc712cd1 --- /dev/null +++ b/docs/reference/api/SecurityHasPrivilegesResourcePrivileges.md @@ -0,0 +1,4 @@ +## `SecurityHasPrivilegesResourcePrivileges` +::: +type SecurityHasPrivilegesResourcePrivileges = Record<[Name](./Name.md), [SecurityHasPrivilegesPrivileges](./SecurityHasPrivilegesPrivileges.md)>; +::: diff --git a/docs/reference/api/SecurityHasPrivilegesResponse.md b/docs/reference/api/SecurityHasPrivilegesResponse.md new file mode 100644 index 000000000..f2453bcbb --- /dev/null +++ b/docs/reference/api/SecurityHasPrivilegesResponse.md @@ -0,0 +1,9 @@ +## Interface `SecurityHasPrivilegesResponse` + +| Name | Type | Description | +| - | - | - | +| `application` | [SecurityHasPrivilegesApplicationsPrivileges](./SecurityHasPrivilegesApplicationsPrivileges.md) |   | +| `cluster` | Record |   | +| `has_all_requested` | boolean |   | +| `index` | Record<[IndexName](./IndexName.md), [SecurityHasPrivilegesPrivileges](./SecurityHasPrivilegesPrivileges.md)> |   | +| `username` | [Username](./Username.md) |   | diff --git a/docs/reference/api/SecurityHasPrivilegesUserProfileHasPrivilegesUserProfileErrors.md b/docs/reference/api/SecurityHasPrivilegesUserProfileHasPrivilegesUserProfileErrors.md new file mode 100644 index 000000000..d7ebb2800 --- /dev/null +++ b/docs/reference/api/SecurityHasPrivilegesUserProfileHasPrivilegesUserProfileErrors.md @@ -0,0 +1,6 @@ +## Interface `SecurityHasPrivilegesUserProfileHasPrivilegesUserProfileErrors` + +| Name | Type | Description | +| - | - | - | +| `count` | [long](./long.md) |   | +| `details` | Record<[SecurityUserProfileId](./SecurityUserProfileId.md), [ErrorCause](./ErrorCause.md)> |   | diff --git a/docs/reference/api/SecurityHasPrivilegesUserProfilePrivilegesCheck.md b/docs/reference/api/SecurityHasPrivilegesUserProfilePrivilegesCheck.md new file mode 100644 index 000000000..880b52b5a --- /dev/null +++ b/docs/reference/api/SecurityHasPrivilegesUserProfilePrivilegesCheck.md @@ -0,0 +1,7 @@ +## Interface `SecurityHasPrivilegesUserProfilePrivilegesCheck` + +| Name | Type | Description | +| - | - | - | +| `application` | [SecurityHasPrivilegesApplicationPrivilegesCheck](./SecurityHasPrivilegesApplicationPrivilegesCheck.md)[] |   | +| `cluster` | [SecurityClusterPrivilege](./SecurityClusterPrivilege.md)[] | A list of the cluster privileges that you want to check. | +| `index` | [SecurityHasPrivilegesIndexPrivilegesCheck](./SecurityHasPrivilegesIndexPrivilegesCheck.md)[] |   | diff --git a/docs/reference/api/SecurityHasPrivilegesUserProfileRequest.md b/docs/reference/api/SecurityHasPrivilegesUserProfileRequest.md new file mode 100644 index 000000000..988266472 --- /dev/null +++ b/docs/reference/api/SecurityHasPrivilegesUserProfileRequest.md @@ -0,0 +1,8 @@ +## Interface `SecurityHasPrivilegesUserProfileRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { uids?: never; privileges?: never; }) | All values in `body` will be added to the request body. | +| `privileges` | [SecurityHasPrivilegesUserProfilePrivilegesCheck](./SecurityHasPrivilegesUserProfilePrivilegesCheck.md) | An object containing all the privileges to be checked. | +| `querystring` | { [key: string]: any; } & { uids?: never; privileges?: never; } | All values in `querystring` will be added to the request querystring. | +| `uids` | [SecurityUserProfileId](./SecurityUserProfileId.md)[] | A list of profile IDs. The privileges are checked for associated users of the profiles. | diff --git a/docs/reference/api/SecurityHasPrivilegesUserProfileResponse.md b/docs/reference/api/SecurityHasPrivilegesUserProfileResponse.md new file mode 100644 index 000000000..ae2b34ddf --- /dev/null +++ b/docs/reference/api/SecurityHasPrivilegesUserProfileResponse.md @@ -0,0 +1,6 @@ +## Interface `SecurityHasPrivilegesUserProfileResponse` + +| Name | Type | Description | +| - | - | - | +| `errors` | [SecurityHasPrivilegesUserProfileHasPrivilegesUserProfileErrors](./SecurityHasPrivilegesUserProfileHasPrivilegesUserProfileErrors.md) | The subset of the requested profile IDs for which an error was encountered. It does not include the missing profile IDs or the profile IDs of the users that do not have all the requested privileges. This field is absent if empty. | +| `has_privilege_uids` | [SecurityUserProfileId](./SecurityUserProfileId.md)[] | The subset of the requested profile IDs of the users that have all the requested privileges. | diff --git a/docs/reference/api/SecurityIndexPrivilege.md b/docs/reference/api/SecurityIndexPrivilege.md new file mode 100644 index 000000000..2cd496d31 --- /dev/null +++ b/docs/reference/api/SecurityIndexPrivilege.md @@ -0,0 +1,4 @@ +## `SecurityIndexPrivilege` +::: +type SecurityIndexPrivilege = 'all' | 'auto_configure' | 'create' | 'create_doc' | 'create_index' | 'cross_cluster_replication' | 'cross_cluster_replication_internal' | 'delete' | 'delete_index' | 'index' | 'maintenance' | 'manage' | 'manage_data_stream_lifecycle' | 'manage_follow_index' | 'manage_ilm' | 'manage_leader_index' | 'monitor' | 'none' | 'read' | 'read_cross_cluster' | 'view_index_metadata' | 'write' | string; +::: diff --git a/docs/reference/api/SecurityIndicesPrivileges.md b/docs/reference/api/SecurityIndicesPrivileges.md new file mode 100644 index 000000000..4e444b762 --- /dev/null +++ b/docs/reference/api/SecurityIndicesPrivileges.md @@ -0,0 +1,9 @@ +## Interface `SecurityIndicesPrivileges` + +| Name | Type | Description | +| - | - | - | +| `allow_restricted_indices` | boolean | Set to `true` if using wildcard or regular expressions for patterns that cover restricted indices. Implicitly, restricted indices have limited privileges that can cause pattern tests to fail. If restricted indices are explicitly included in the `names` list, Elasticsearch checks privileges against these indices regardless of the value set for `allow_restricted_indices`. | +| `field_security` | [SecurityFieldSecurity](./SecurityFieldSecurity.md) | The document fields that the owners of the role have read access to. | +| `names` | [IndexName](./IndexName.md) | [IndexName](./IndexName.md)[] | A list of indices (or index name patterns) to which the permissions in this entry apply. | +| `privileges` | [SecurityIndexPrivilege](./SecurityIndexPrivilege.md)[] | The index level privileges that owners of the role have on the specified indices. | +| `query` | [SecurityIndicesPrivilegesQuery](./SecurityIndicesPrivilegesQuery.md) | A search query that defines the documents the owners of the role have access to. A document within the specified indices must match this query for it to be accessible by the owners of the role. | diff --git a/docs/reference/api/SecurityIndicesPrivilegesQuery.md b/docs/reference/api/SecurityIndicesPrivilegesQuery.md new file mode 100644 index 000000000..9577553c1 --- /dev/null +++ b/docs/reference/api/SecurityIndicesPrivilegesQuery.md @@ -0,0 +1,4 @@ +## `SecurityIndicesPrivilegesQuery` +::: +type SecurityIndicesPrivilegesQuery = string | [QueryDslQueryContainer](./QueryDslQueryContainer.md) | [SecurityRoleTemplateQuery](./SecurityRoleTemplateQuery.md); +::: diff --git a/docs/reference/api/SecurityInvalidateApiKeyRequest.md b/docs/reference/api/SecurityInvalidateApiKeyRequest.md new file mode 100644 index 000000000..b84126068 --- /dev/null +++ b/docs/reference/api/SecurityInvalidateApiKeyRequest.md @@ -0,0 +1,12 @@ +## Interface `SecurityInvalidateApiKeyRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { id?: never; ids?: never; name?: never; owner?: never; realm_name?: never; username?: never; }) | All values in `body` will be added to the request body. | +| `id` | [Id](./Id.md) |   | +| `ids` | [Id](./Id.md)[] | A list of API key ids. This parameter cannot be used with any of `name`, `realm_name`, or `username`. | +| `name` | [Name](./Name.md) | An API key name. This parameter cannot be used with any of `ids`, `realm_name` or `username`. | +| `owner` | boolean | Query API keys owned by the currently authenticated user. The `realm_name` or `username` parameters cannot be specified when this parameter is set to `true` as they are assumed to be the currently authenticated ones. NOTE: At least one of `ids`, `name`, `username`, and `realm_name` must be specified if `owner` is `false`. | +| `querystring` | { [key: string]: any; } & { id?: never; ids?: never; name?: never; owner?: never; realm_name?: never; username?: never; } | All values in `querystring` will be added to the request querystring. | +| `realm_name` | string | The name of an authentication realm. This parameter cannot be used with either `ids` or `name`, or when `owner` flag is set to `true`. | +| `username` | [Username](./Username.md) | The username of a user. This parameter cannot be used with either `ids` or `name` or when `owner` flag is set to `true`. | diff --git a/docs/reference/api/SecurityInvalidateApiKeyResponse.md b/docs/reference/api/SecurityInvalidateApiKeyResponse.md new file mode 100644 index 000000000..faef0c533 --- /dev/null +++ b/docs/reference/api/SecurityInvalidateApiKeyResponse.md @@ -0,0 +1,8 @@ +## Interface `SecurityInvalidateApiKeyResponse` + +| Name | Type | Description | +| - | - | - | +| `error_count` | [integer](./integer.md) | The number of errors that were encountered when invalidating the API keys. | +| `error_details` | [ErrorCause](./ErrorCause.md)[] | Details about the errors. This field is not present in the response when `error_count` is `0`. | +| `invalidated_api_keys` | string[] | The IDs of the API keys that were invalidated as part of this request. | +| `previously_invalidated_api_keys` | string[] | The IDs of the API keys that were already invalidated. | diff --git a/docs/reference/api/SecurityInvalidateTokenRequest.md b/docs/reference/api/SecurityInvalidateTokenRequest.md new file mode 100644 index 000000000..78a58a9b3 --- /dev/null +++ b/docs/reference/api/SecurityInvalidateTokenRequest.md @@ -0,0 +1,10 @@ +## Interface `SecurityInvalidateTokenRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { token?: never; refresh_token?: never; realm_name?: never; username?: never; }) | All values in `body` will be added to the request body. | +| `querystring` | { [key: string]: any; } & { token?: never; refresh_token?: never; realm_name?: never; username?: never; } | All values in `querystring` will be added to the request querystring. | +| `realm_name` | [Name](./Name.md) | The name of an authentication realm. This parameter cannot be used with either `refresh_token` or `token`. | +| `refresh_token` | string | A refresh token. This parameter cannot be used if any of `refresh_token`, `realm_name`, or `username` are used. | +| `token` | string | An access token. This parameter cannot be used if any of `refresh_token`, `realm_name`, or `username` are used. | +| `username` | [Username](./Username.md) | The username of a user. This parameter cannot be used with either `refresh_token` or `token`. | diff --git a/docs/reference/api/SecurityInvalidateTokenResponse.md b/docs/reference/api/SecurityInvalidateTokenResponse.md new file mode 100644 index 000000000..bf4b639b2 --- /dev/null +++ b/docs/reference/api/SecurityInvalidateTokenResponse.md @@ -0,0 +1,8 @@ +## Interface `SecurityInvalidateTokenResponse` + +| Name | Type | Description | +| - | - | - | +| `error_count` | [long](./long.md) | The number of errors that were encountered when invalidating the tokens. | +| `error_details` | [ErrorCause](./ErrorCause.md)[] | Details about the errors. This field is not present in the response when `error_count` is `0`. | +| `invalidated_tokens` | [long](./long.md) | The number of the tokens that were invalidated as part of this request. | +| `previously_invalidated_tokens` | [long](./long.md) | The number of tokens that were already invalidated. | diff --git a/docs/reference/api/SecurityManageUserPrivileges.md b/docs/reference/api/SecurityManageUserPrivileges.md new file mode 100644 index 000000000..f1cc24f21 --- /dev/null +++ b/docs/reference/api/SecurityManageUserPrivileges.md @@ -0,0 +1,5 @@ +## Interface `SecurityManageUserPrivileges` + +| Name | Type | Description | +| - | - | - | +| `applications` | string[] |   | diff --git a/docs/reference/api/SecurityOidcAuthenticateRequest.md b/docs/reference/api/SecurityOidcAuthenticateRequest.md new file mode 100644 index 000000000..80862babb --- /dev/null +++ b/docs/reference/api/SecurityOidcAuthenticateRequest.md @@ -0,0 +1,10 @@ +## Interface `SecurityOidcAuthenticateRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { nonce?: never; realm?: never; redirect_uri?: never; state?: never; }) | All values in `body` will be added to the request body. | +| `nonce` | string | Associate a client session with an ID token and mitigate replay attacks. This value needs to be the same as the one that was provided to the `/_security/oidc/prepare` API or the one that was generated by Elasticsearch and included in the response to that call. | +| `querystring` | { [key: string]: any; } & { nonce?: never; realm?: never; redirect_uri?: never; state?: never; } | All values in `querystring` will be added to the request querystring. | +| `realm` | string | The name of the OpenID Connect realm. This property is useful in cases where multiple realms are defined. | +| `redirect_uri` | string | The URL to which the OpenID Connect Provider redirected the User Agent in response to an authentication request after a successful authentication. This URL must be provided as-is (URL encoded), taken from the body of the response or as the value of a location header in the response from the OpenID Connect Provider. | +| `state` | string | Maintain state between the authentication request and the response. This value needs to be the same as the one that was provided to the `/_security/oidc/prepare` API or the one that was generated by Elasticsearch and included in the response to that call. | diff --git a/docs/reference/api/SecurityOidcAuthenticateResponse.md b/docs/reference/api/SecurityOidcAuthenticateResponse.md new file mode 100644 index 000000000..665a9b7b8 --- /dev/null +++ b/docs/reference/api/SecurityOidcAuthenticateResponse.md @@ -0,0 +1,8 @@ +## Interface `SecurityOidcAuthenticateResponse` + +| Name | Type | Description | +| - | - | - | +| `access_token` | string | The Elasticsearch access token. | +| `expires_in` | [integer](./integer.md) | The duration (in seconds) of the tokens. | +| `refresh_token` | string | The Elasticsearch refresh token. | +| `type` | string | The type of token. | diff --git a/docs/reference/api/SecurityOidcLogoutRequest.md b/docs/reference/api/SecurityOidcLogoutRequest.md new file mode 100644 index 000000000..d4b2f6e79 --- /dev/null +++ b/docs/reference/api/SecurityOidcLogoutRequest.md @@ -0,0 +1,8 @@ +## Interface `SecurityOidcLogoutRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { token?: never; refresh_token?: never; }) | All values in `body` will be added to the request body. | +| `querystring` | { [key: string]: any; } & { token?: never; refresh_token?: never; } | All values in `querystring` will be added to the request querystring. | +| `refresh_token` | string | The refresh token to be invalidated. | +| `token` | string | The access token to be invalidated. | diff --git a/docs/reference/api/SecurityOidcLogoutResponse.md b/docs/reference/api/SecurityOidcLogoutResponse.md new file mode 100644 index 000000000..dfaa88426 --- /dev/null +++ b/docs/reference/api/SecurityOidcLogoutResponse.md @@ -0,0 +1,5 @@ +## Interface `SecurityOidcLogoutResponse` + +| Name | Type | Description | +| - | - | - | +| `redirect` | string | A URI that points to the end session endpoint of the OpenID Connect Provider with all the parameters of the logout request as HTTP GET parameters. | diff --git a/docs/reference/api/SecurityOidcPrepareAuthenticationRequest.md b/docs/reference/api/SecurityOidcPrepareAuthenticationRequest.md new file mode 100644 index 000000000..6c3761474 --- /dev/null +++ b/docs/reference/api/SecurityOidcPrepareAuthenticationRequest.md @@ -0,0 +1,11 @@ +## Interface `SecurityOidcPrepareAuthenticationRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { iss?: never; login_hint?: never; nonce?: never; realm?: never; state?: never; }) | All values in `body` will be added to the request body. | +| `iss` | string | In the case of a third party initiated single sign on, this is the issuer identifier for the OP that the RP is to send the authentication request to. It cannot be specified when *realm* is specified. One of *realm* or *iss* is required. | +| `login_hint` | string | In the case of a third party initiated single sign on, it is a string value that is included in the authentication request as the *login_hint* parameter. This parameter is not valid when *realm* is specified. | +| `nonce` | string | The value used to associate a client session with an ID token and to mitigate replay attacks. If the caller of the API does not provide a value, Elasticsearch will generate one with sufficient entropy and return it in the response. | +| `querystring` | { [key: string]: any; } & { iss?: never; login_hint?: never; nonce?: never; realm?: never; state?: never; } | All values in `querystring` will be added to the request querystring. | +| `realm` | string | The name of the OpenID Connect realm in Elasticsearch the configuration of which should be used in order to generate the authentication request. It cannot be specified when *iss* is specified. One of *realm* or *iss* is required. | +| `state` | string | The value used to maintain state between the authentication request and the response, typically used as a Cross-Site Request Forgery mitigation. If the caller of the API does not provide a value, Elasticsearch will generate one with sufficient entropy and return it in the response. | diff --git a/docs/reference/api/SecurityOidcPrepareAuthenticationResponse.md b/docs/reference/api/SecurityOidcPrepareAuthenticationResponse.md new file mode 100644 index 000000000..44ad7ae20 --- /dev/null +++ b/docs/reference/api/SecurityOidcPrepareAuthenticationResponse.md @@ -0,0 +1,8 @@ +## Interface `SecurityOidcPrepareAuthenticationResponse` + +| Name | Type | Description | +| - | - | - | +| `nonce` | string |   | +| `realm` | string |   | +| `redirect` | string | A URI that points to the authorization endpoint of the OpenID Connect Provider with all the parameters of the authentication request as HTTP GET parameters. | +| `state` | string |   | diff --git a/docs/reference/api/SecurityPutPrivilegesActions.md b/docs/reference/api/SecurityPutPrivilegesActions.md new file mode 100644 index 000000000..661d630f7 --- /dev/null +++ b/docs/reference/api/SecurityPutPrivilegesActions.md @@ -0,0 +1,8 @@ +## Interface `SecurityPutPrivilegesActions` + +| Name | Type | Description | +| - | - | - | +| `actions` | string[] |   | +| `application` | string |   | +| `metadata` | [Metadata](./Metadata.md) |   | +| `name` | [Name](./Name.md) |   | diff --git a/docs/reference/api/SecurityPutPrivilegesRequest.md b/docs/reference/api/SecurityPutPrivilegesRequest.md new file mode 100644 index 000000000..7416c99da --- /dev/null +++ b/docs/reference/api/SecurityPutPrivilegesRequest.md @@ -0,0 +1,8 @@ +## Interface `SecurityPutPrivilegesRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { refresh?: never; privileges?: never; }) | All values in `body` will be added to the request body. | +| `privileges` | Record> |   | +| `querystring` | { [key: string]: any; } & { refresh?: never; privileges?: never; } | All values in `querystring` will be added to the request querystring. | +| `refresh` | [Refresh](./Refresh.md) | If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. | diff --git a/docs/reference/api/SecurityPutPrivilegesResponse.md b/docs/reference/api/SecurityPutPrivilegesResponse.md new file mode 100644 index 000000000..0d085616d --- /dev/null +++ b/docs/reference/api/SecurityPutPrivilegesResponse.md @@ -0,0 +1,4 @@ +## `SecurityPutPrivilegesResponse` +::: +type SecurityPutPrivilegesResponse = Record>; +::: diff --git a/docs/reference/api/SecurityPutRoleMappingRequest.md b/docs/reference/api/SecurityPutRoleMappingRequest.md new file mode 100644 index 000000000..cb8e4c44b --- /dev/null +++ b/docs/reference/api/SecurityPutRoleMappingRequest.md @@ -0,0 +1,14 @@ +## Interface `SecurityPutRoleMappingRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { name?: never; refresh?: never; enabled?: never; metadata?: never; roles?: never; role_templates?: never; rules?: never; run_as?: never; }) | All values in `body` will be added to the request body. | +| `enabled` | boolean | Mappings that have `enabled` set to `false` are ignored when role mapping is performed. | +| `metadata` | [Metadata](./Metadata.md) | Additional metadata that helps define which roles are assigned to each user. Within the metadata object, keys beginning with `_` are reserved for system usage. | +| `name` | [Name](./Name.md) | The distinct name that identifies the role mapping. The name is used solely as an identifier to facilitate interaction via the API; it does not affect the behavior of the mapping in any way. | +| `querystring` | { [key: string]: any; } & { name?: never; refresh?: never; enabled?: never; metadata?: never; roles?: never; role_templates?: never; rules?: never; run_as?: never; } | All values in `querystring` will be added to the request querystring. | +| `refresh` | [Refresh](./Refresh.md) | If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. | +| `role_templates` | [SecurityRoleTemplate](./SecurityRoleTemplate.md)[] | A list of Mustache templates that will be evaluated to determine the roles names that should granted to the users that match the role mapping rules. Exactly one of `roles` or `role_templates` must be specified. | +| `roles` | string[] | A list of role names that are granted to the users that match the role mapping rules. Exactly one of `roles` or `role_templates` must be specified. | +| `rules` | [SecurityRoleMappingRule](./SecurityRoleMappingRule.md) | The rules that determine which users should be matched by the mapping. A rule is a logical condition that is expressed by using a JSON DSL. | +| `run_as` | string[] |   | diff --git a/docs/reference/api/SecurityPutRoleMappingResponse.md b/docs/reference/api/SecurityPutRoleMappingResponse.md new file mode 100644 index 000000000..be791f7d5 --- /dev/null +++ b/docs/reference/api/SecurityPutRoleMappingResponse.md @@ -0,0 +1,6 @@ +## Interface `SecurityPutRoleMappingResponse` + +| Name | Type | Description | +| - | - | - | +| `created` | boolean |   | +| `role_mapping` | [SecurityCreatedStatus](./SecurityCreatedStatus.md) |   | diff --git a/docs/reference/api/SecurityPutRoleRequest.md b/docs/reference/api/SecurityPutRoleRequest.md new file mode 100644 index 000000000..4865744ab --- /dev/null +++ b/docs/reference/api/SecurityPutRoleRequest.md @@ -0,0 +1,18 @@ +## Interface `SecurityPutRoleRequest` + +| Name | Type | Description | +| - | - | - | +| `applications` | [SecurityApplicationPrivileges](./SecurityApplicationPrivileges.md)[] | A list of application privilege entries. | +| `body` | string | ({ [key: string]: any; } & { name?: never; refresh?: never; applications?: never; cluster?: never; global?: never; indices?: never; remote_indices?: never; remote_cluster?: never; metadata?: never; run_as?: never; description?: never; transient_metadata?: never; }) | All values in `body` will be added to the request body. | +| `cluster` | [SecurityClusterPrivilege](./SecurityClusterPrivilege.md)[] | A list of cluster privileges. These privileges define the cluster-level actions for users with this role. | +| `description` | string | Optional description of the role descriptor | +| `global` | Record | An object defining global privileges. A global privilege is a form of cluster privilege that is request-aware. Support for global privileges is currently limited to the management of application privileges. | +| `indices` | [SecurityIndicesPrivileges](./SecurityIndicesPrivileges.md)[] | A list of indices permissions entries. | +| `metadata` | [Metadata](./Metadata.md) | Optional metadata. Within the metadata object, keys that begin with an underscore ( `_`) are reserved for system use. | +| `name` | [Name](./Name.md) | The name of the role that is being created or updated. On Elasticsearch Serverless, the role name must begin with a letter or digit and can only contain letters, digits and the characters '_', '-', and '.'. Each role must have a unique name, as this will serve as the identifier for that role. | +| `querystring` | { [key: string]: any; } & { name?: never; refresh?: never; applications?: never; cluster?: never; global?: never; indices?: never; remote_indices?: never; remote_cluster?: never; metadata?: never; run_as?: never; description?: never; transient_metadata?: never; } | All values in `querystring` will be added to the request querystring. | +| `refresh` | [Refresh](./Refresh.md) | If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. | +| `remote_cluster` | [SecurityRemoteClusterPrivileges](./SecurityRemoteClusterPrivileges.md)[] | A list of remote cluster permissions entries. | +| `remote_indices` | [SecurityRemoteIndicesPrivileges](./SecurityRemoteIndicesPrivileges.md)[] | A list of remote indices permissions entries. NOTE: Remote indices are effective for remote clusters configured with the API key based model. They have no effect for remote clusters configured with the certificate based model. | +| `run_as` | string[] | A list of users that the owners of this role can impersonate. *Note*: in Serverless, the run-as feature is disabled. For API compatibility, you can still specify an empty `run_as` field, but a non-empty list will be rejected. | +| `transient_metadata` | Record | Indicates roles that might be incompatible with the current cluster license, specifically roles with document and field level security. When the cluster license doesn’t allow certain features for a given role, this parameter is updated dynamically to list the incompatible features. If `enabled` is `false`, the role is ignored, but is still listed in the response from the authenticate API. | diff --git a/docs/reference/api/SecurityPutRoleResponse.md b/docs/reference/api/SecurityPutRoleResponse.md new file mode 100644 index 000000000..36af9d8dd --- /dev/null +++ b/docs/reference/api/SecurityPutRoleResponse.md @@ -0,0 +1,5 @@ +## Interface `SecurityPutRoleResponse` + +| Name | Type | Description | +| - | - | - | +| `role` | [SecurityCreatedStatus](./SecurityCreatedStatus.md) | When an existing role is updated, `created` is set to `false`. | diff --git a/docs/reference/api/SecurityPutUserRequest.md b/docs/reference/api/SecurityPutUserRequest.md new file mode 100644 index 000000000..4ad54a910 --- /dev/null +++ b/docs/reference/api/SecurityPutUserRequest.md @@ -0,0 +1,15 @@ +## Interface `SecurityPutUserRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { username?: never; refresh?: never; email?: never; full_name?: never; metadata?: never; password?: never; password_hash?: never; roles?: never; enabled?: never; }) | All values in `body` will be added to the request body. | +| `email` | string | null | The email of the user. | +| `enabled` | boolean | Specifies whether the user is enabled. | +| `full_name` | string | null | The full name of the user. | +| `metadata` | [Metadata](./Metadata.md) | Arbitrary metadata that you want to associate with the user. | +| `password_hash` | string | A hash of the user's password. This must be produced using the same hashing algorithm as has been configured for password storage. For more details, see the explanation of the `xpack.security.authc.password_hashing.algorithm` setting in the user cache and password hash algorithm documentation. Using this parameter allows the client to pre-hash the password for performance and/or confidentiality reasons. The `password` parameter and the `password_hash` parameter cannot be used in the same request. | +| `password` | [Password](./Password.md) | The user's password. Passwords must be at least 6 characters long. When adding a user, one of `password` or `password_hash` is required. When updating an existing user, the password is optional, so that other fields on the user (such as their roles) may be updated without modifying the user's password | +| `querystring` | { [key: string]: any; } & { username?: never; refresh?: never; email?: never; full_name?: never; metadata?: never; password?: never; password_hash?: never; roles?: never; enabled?: never; } | All values in `querystring` will be added to the request querystring. | +| `refresh` | [Refresh](./Refresh.md) | Valid values are `true`, `false`, and `wait_for`. These values have the same meaning as in the index API, but the default value for this API is true. | +| `roles` | string[] | A set of roles the user has. The roles determine the user's access permissions. To create a user without any roles, specify an empty list ( `[]`). | +| `username` | [Username](./Username.md) | An identifier for the user. NOTE: Usernames must be at least 1 and no more than 507 characters. They can contain alphanumeric characters (a-z, A-Z, 0-9), spaces, punctuation, and printable symbols in the Basic Latin (ASCII) block. Leading or trailing whitespace is not allowed. | diff --git a/docs/reference/api/SecurityPutUserResponse.md b/docs/reference/api/SecurityPutUserResponse.md new file mode 100644 index 000000000..b54d69c8b --- /dev/null +++ b/docs/reference/api/SecurityPutUserResponse.md @@ -0,0 +1,5 @@ +## Interface `SecurityPutUserResponse` + +| Name | Type | Description | +| - | - | - | +| `created` | boolean | A successful call returns a JSON structure that shows whether the user has been created or updated. When an existing user is updated, `created` is set to `false`. | diff --git a/docs/reference/api/SecurityQueryApiKeysApiKeyAggregate.md b/docs/reference/api/SecurityQueryApiKeysApiKeyAggregate.md new file mode 100644 index 000000000..8bcafadb6 --- /dev/null +++ b/docs/reference/api/SecurityQueryApiKeysApiKeyAggregate.md @@ -0,0 +1,4 @@ +## `SecurityQueryApiKeysApiKeyAggregate` +::: +type SecurityQueryApiKeysApiKeyAggregate = [AggregationsCardinalityAggregate](./AggregationsCardinalityAggregate.md) | [AggregationsValueCountAggregate](./AggregationsValueCountAggregate.md) | [AggregationsStringTermsAggregate](./AggregationsStringTermsAggregate.md) | [AggregationsLongTermsAggregate](./AggregationsLongTermsAggregate.md) | [AggregationsDoubleTermsAggregate](./AggregationsDoubleTermsAggregate.md) | [AggregationsUnmappedTermsAggregate](./AggregationsUnmappedTermsAggregate.md) | [AggregationsMultiTermsAggregate](./AggregationsMultiTermsAggregate.md) | [AggregationsMissingAggregate](./AggregationsMissingAggregate.md) | [AggregationsFilterAggregate](./AggregationsFilterAggregate.md) | [AggregationsFiltersAggregate](./AggregationsFiltersAggregate.md) | [AggregationsRangeAggregate](./AggregationsRangeAggregate.md) | [AggregationsDateRangeAggregate](./AggregationsDateRangeAggregate.md) | [AggregationsCompositeAggregate](./AggregationsCompositeAggregate.md); +::: diff --git a/docs/reference/api/SecurityQueryApiKeysApiKeyAggregationContainer.md b/docs/reference/api/SecurityQueryApiKeysApiKeyAggregationContainer.md new file mode 100644 index 000000000..5a6d5bcc5 --- /dev/null +++ b/docs/reference/api/SecurityQueryApiKeysApiKeyAggregationContainer.md @@ -0,0 +1,16 @@ +## Interface `SecurityQueryApiKeysApiKeyAggregationContainer` + +| Name | Type | Description | +| - | - | - | +| `aggregations` | Record | Sub-aggregations for this aggregation. Only applies to bucket aggregations. | +| `aggs` | Record | Sub-aggregations for this aggregation. Only applies to bucket aggregations. aggregations | +| `cardinality` | [AggregationsCardinalityAggregation](./AggregationsCardinalityAggregation.md) | A single-value metrics aggregation that calculates an approximate count of distinct values. | +| `composite` | [AggregationsCompositeAggregation](./AggregationsCompositeAggregation.md) | A multi-bucket aggregation that creates composite buckets from different sources. Unlike the other multi-bucket aggregations, you can use the `composite` aggregation to paginate *all* buckets from a multi-level aggregation efficiently. | +| `date_range` | [AggregationsDateRangeAggregation](./AggregationsDateRangeAggregation.md) | A multi-bucket value source based aggregation that enables the user to define a set of date ranges - each representing a bucket. | +| `filter` | [SecurityQueryApiKeysApiKeyQueryContainer](./SecurityQueryApiKeysApiKeyQueryContainer.md) | A single bucket aggregation that narrows the set of documents to those that match a query. | +| `filters` | [SecurityQueryApiKeysApiKeyFiltersAggregation](./SecurityQueryApiKeysApiKeyFiltersAggregation.md) | A multi-bucket aggregation where each bucket contains the documents that match a query. | +| `meta` | [Metadata](./Metadata.md) |   | +| `missing` | [AggregationsMissingAggregation](./AggregationsMissingAggregation.md) |   | +| `range` | [AggregationsRangeAggregation](./AggregationsRangeAggregation.md) | A multi-bucket value source based aggregation that enables the user to define a set of ranges - each representing a bucket. | +| `terms` | [AggregationsTermsAggregation](./AggregationsTermsAggregation.md) | A multi-bucket value source based aggregation where buckets are dynamically built - one per unique value. | +| `value_count` | [AggregationsValueCountAggregation](./AggregationsValueCountAggregation.md) | A single-value metrics aggregation that counts the number of values that are extracted from the aggregated documents. | diff --git a/docs/reference/api/SecurityQueryApiKeysApiKeyFiltersAggregation.md b/docs/reference/api/SecurityQueryApiKeysApiKeyFiltersAggregation.md new file mode 100644 index 000000000..0f7ef2ce1 --- /dev/null +++ b/docs/reference/api/SecurityQueryApiKeysApiKeyFiltersAggregation.md @@ -0,0 +1,8 @@ +## Interface `SecurityQueryApiKeysApiKeyFiltersAggregation` + +| Name | Type | Description | +| - | - | - | +| `filters` | [AggregationsBuckets](./AggregationsBuckets.md)<[SecurityQueryApiKeysApiKeyQueryContainer](./SecurityQueryApiKeysApiKeyQueryContainer.md)> | Collection of queries from which to build buckets. | +| `keyed` | boolean | By default, the named filters aggregation returns the buckets as an object. Set to `false` to return the buckets as an array of objects. | +| `other_bucket_key` | string | The key with which the other bucket is returned. | +| `other_bucket` | boolean | Set to `true` to add a bucket to the response which will contain all documents that do not match any of the given filters. | diff --git a/docs/reference/api/SecurityQueryApiKeysApiKeyQueryContainer.md b/docs/reference/api/SecurityQueryApiKeysApiKeyQueryContainer.md new file mode 100644 index 000000000..d01e6d42c --- /dev/null +++ b/docs/reference/api/SecurityQueryApiKeysApiKeyQueryContainer.md @@ -0,0 +1,15 @@ +## Interface `SecurityQueryApiKeysApiKeyQueryContainer` + +| Name | Type | Description | +| - | - | - | +| `bool` | [QueryDslBoolQuery](./QueryDslBoolQuery.md) | Matches documents matching boolean combinations of other queries. | +| `exists` | [QueryDslExistsQuery](./QueryDslExistsQuery.md) | Returns documents that contain an indexed value for a field. | +| `ids` | [QueryDslIdsQuery](./QueryDslIdsQuery.md) | Returns documents based on their IDs. This query uses document IDs stored in the `_id` field. | +| `match_all` | [QueryDslMatchAllQuery](./QueryDslMatchAllQuery.md) | Matches all documents, giving them all a `_score` of 1.0. | +| `match` | [Partial](./Partial.md)> | Returns documents that match a provided text, number, date or boolean value. The provided text is analyzed before matching. | +| `prefix` | [Partial](./Partial.md)> | Returns documents that contain a specific prefix in a provided field. | +| `range` | [Partial](./Partial.md)> | Returns documents that contain terms within a provided range. | +| `simple_query_string` | [QueryDslSimpleQueryStringQuery](./QueryDslSimpleQueryStringQuery.md) | Returns documents based on a provided query string, using a parser with a limited but fault-tolerant syntax. | +| `term` | [Partial](./Partial.md)> | Returns documents that contain an exact term in a provided field. To return a document, the query term must exactly match the queried field's value, including whitespace and capitalization. | +| `terms` | [QueryDslTermsQuery](./QueryDslTermsQuery.md) | Returns documents that contain one or more exact terms in a provided field. To return a document, one or more terms must exactly match a field value, including whitespace and capitalization. | +| `wildcard` | [Partial](./Partial.md)> | Returns documents that contain terms matching a wildcard pattern. | diff --git a/docs/reference/api/SecurityQueryApiKeysRequest.md b/docs/reference/api/SecurityQueryApiKeysRequest.md new file mode 100644 index 000000000..1fba7cddb --- /dev/null +++ b/docs/reference/api/SecurityQueryApiKeysRequest.md @@ -0,0 +1,16 @@ +## Interface `SecurityQueryApiKeysRequest` + +| Name | Type | Description | +| - | - | - | +| `aggregations` | Record | Any aggregations to run over the corpus of returned API keys. Aggregations and queries work together. Aggregations are computed only on the API keys that match the query. This supports only a subset of aggregation types, namely: `terms`, `range`, `date_range`, `missing`, `cardinality`, `value_count`, `composite`, `filter`, and `filters`. Additionally, aggregations only run over the same subset of fields that query works with. | +| `aggs` | Record | Any aggregations to run over the corpus of returned API keys. Aggregations and queries work together. Aggregations are computed only on the API keys that match the query. This supports only a subset of aggregation types, namely: `terms`, `range`, `date_range`, `missing`, `cardinality`, `value_count`, `composite`, `filter`, and `filters`. Additionally, aggregations only run over the same subset of fields that query works with. aggregations | +| `body` | string | ({ [key: string]: any; } & { with_limited_by?: never; with_profile_uid?: never; typed_keys?: never; aggregations?: never; aggs?: never; query?: never; from?: never; sort?: never; size?: never; search_after?: never; }) | All values in `body` will be added to the request body. | +| `from` | [integer](./integer.md) | The starting document offset. It must not be negative. By default, you cannot page through more than 10,000 hits using the `from` and `size` parameters. To page through more hits, use the `search_after` parameter. | +| `query` | [SecurityQueryApiKeysApiKeyQueryContainer](./SecurityQueryApiKeysApiKeyQueryContainer.md) | A query to filter which API keys to return. If the query parameter is missing, it is equivalent to a `match_all` query. The query supports a subset of query types, including `match_all`, `bool`, `term`, `terms`, `match`, `ids`, `prefix`, `wildcard`, `exists`, `range`, and `simple_query_string`. You can query the following public information associated with an API key: `id`, `type`, `name`, `creation`, `expiration`, `invalidated`, `invalidation`, `username`, `realm`, and `metadata`. NOTE: The queryable string values associated with API keys are internally mapped as keywords. Consequently, if no `analyzer` parameter is specified for a `match` query, then the provided match query string is interpreted as a single keyword value. Such a match query is hence equivalent to a `term` query. | +| `querystring` | { [key: string]: any; } & { with_limited_by?: never; with_profile_uid?: never; typed_keys?: never; aggregations?: never; aggs?: never; query?: never; from?: never; sort?: never; size?: never; search_after?: never; } | All values in `querystring` will be added to the request querystring. | +| `search_after` | [SortResults](./SortResults.md) | The search after definition. | +| `size` | [integer](./integer.md) | The number of hits to return. It must not be negative. The `size` parameter can be set to `0`, in which case no API key matches are returned, only the aggregation results. By default, you cannot page through more than 10,000 hits using the `from` and `size` parameters. To page through more hits, use the `search_after` parameter. | +| `sort` | [Sort](./Sort.md) | The sort definition. Other than `id`, all public fields of an API key are eligible for sorting. In addition, sort can also be applied to the `_doc` field to sort by index order. | +| `typed_keys` | boolean | Determines whether aggregation names are prefixed by their respective types in the response. | +| `with_limited_by` | boolean | Return the snapshot of the owner user's role descriptors associated with the API key. An API key's actual permission is the intersection of its assigned role descriptors and the owner user's role descriptors (effectively limited by it). An API key cannot retrieve any API key’s limited-by role descriptors (including itself) unless it has `manage_api_key` or higher privileges. | +| `with_profile_uid` | boolean | Determines whether to also retrieve the profile UID for the API key owner principal. If it exists, the profile UID is returned under the `profile_uid` response field for each API key. | diff --git a/docs/reference/api/SecurityQueryApiKeysResponse.md b/docs/reference/api/SecurityQueryApiKeysResponse.md new file mode 100644 index 000000000..b098e83f1 --- /dev/null +++ b/docs/reference/api/SecurityQueryApiKeysResponse.md @@ -0,0 +1,8 @@ +## Interface `SecurityQueryApiKeysResponse` + +| Name | Type | Description | +| - | - | - | +| `aggregations` | Record<[AggregateName](./AggregateName.md), [SecurityQueryApiKeysApiKeyAggregate](./SecurityQueryApiKeysApiKeyAggregate.md)> | The aggregations result, if requested. | +| `api_keys` | [SecurityApiKey](./SecurityApiKey.md)[] | A list of API key information. | +| `count` | [integer](./integer.md) | The number of API keys returned in the response. | +| `total` | [integer](./integer.md) | The total number of API keys found. | diff --git a/docs/reference/api/SecurityQueryRoleQueryRole.md b/docs/reference/api/SecurityQueryRoleQueryRole.md new file mode 100644 index 000000000..01eb5847c --- /dev/null +++ b/docs/reference/api/SecurityQueryRoleQueryRole.md @@ -0,0 +1,6 @@ +## Interface `SecurityQueryRoleQueryRole` + +| Name | Type | Description | +| - | - | - | +| `_sort` | [SortResults](./SortResults.md) |   | +| `name` | string | Name of the role. | diff --git a/docs/reference/api/SecurityQueryRoleRequest.md b/docs/reference/api/SecurityQueryRoleRequest.md new file mode 100644 index 000000000..402bafc86 --- /dev/null +++ b/docs/reference/api/SecurityQueryRoleRequest.md @@ -0,0 +1,11 @@ +## Interface `SecurityQueryRoleRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { query?: never; from?: never; sort?: never; size?: never; search_after?: never; }) | All values in `body` will be added to the request body. | +| `from` | [integer](./integer.md) | The starting document offset. It must not be negative. By default, you cannot page through more than 10,000 hits using the `from` and `size` parameters. To page through more hits, use the `search_after` parameter. | +| `query` | [SecurityQueryRoleRoleQueryContainer](./SecurityQueryRoleRoleQueryContainer.md) | A query to filter which roles to return. If the query parameter is missing, it is equivalent to a `match_all` query. The query supports a subset of query types, including `match_all`, `bool`, `term`, `terms`, `match`, `ids`, `prefix`, `wildcard`, `exists`, `range`, and `simple_query_string`. You can query the following information associated with roles: `name`, `description`, `metadata`, `applications.application`, `applications.privileges`, and `applications.resources`. | +| `querystring` | { [key: string]: any; } & { query?: never; from?: never; sort?: never; size?: never; search_after?: never; } | All values in `querystring` will be added to the request querystring. | +| `search_after` | [SortResults](./SortResults.md) | The search after definition. | +| `size` | [integer](./integer.md) | The number of hits to return. It must not be negative. By default, you cannot page through more than 10,000 hits using the `from` and `size` parameters. To page through more hits, use the `search_after` parameter. | +| `sort` | [Sort](./Sort.md) | The sort definition. You can sort on `username`, `roles`, or `enabled`. In addition, sort can also be applied to the `_doc` field to sort by index order. | diff --git a/docs/reference/api/SecurityQueryRoleResponse.md b/docs/reference/api/SecurityQueryRoleResponse.md new file mode 100644 index 000000000..00086b872 --- /dev/null +++ b/docs/reference/api/SecurityQueryRoleResponse.md @@ -0,0 +1,7 @@ +## Interface `SecurityQueryRoleResponse` + +| Name | Type | Description | +| - | - | - | +| `count` | [integer](./integer.md) | The number of roles returned in the response. | +| `roles` | [SecurityQueryRoleQueryRole](./SecurityQueryRoleQueryRole.md)[] | A list of roles that match the query. The returned role format is an extension of the role definition format. It adds the `transient_metadata.enabled` and the `_sort` fields. `transient_metadata.enabled` is set to `false` in case the role is automatically disabled, for example when the role grants privileges that are not allowed by the installed license. `_sort` is present when the search query sorts on some field. It contains the array of values that have been used for sorting. | +| `total` | [integer](./integer.md) | The total number of roles found. | diff --git a/docs/reference/api/SecurityQueryRoleRoleQueryContainer.md b/docs/reference/api/SecurityQueryRoleRoleQueryContainer.md new file mode 100644 index 000000000..c104b89d1 --- /dev/null +++ b/docs/reference/api/SecurityQueryRoleRoleQueryContainer.md @@ -0,0 +1,15 @@ +## Interface `SecurityQueryRoleRoleQueryContainer` + +| Name | Type | Description | +| - | - | - | +| `bool` | [QueryDslBoolQuery](./QueryDslBoolQuery.md) | matches roles matching boolean combinations of other queries. | +| `exists` | [QueryDslExistsQuery](./QueryDslExistsQuery.md) | Returns roles that contain an indexed value for a field. | +| `ids` | [QueryDslIdsQuery](./QueryDslIdsQuery.md) | Returns roles based on their IDs. This query uses role document IDs stored in the `_id` field. | +| `match_all` | [QueryDslMatchAllQuery](./QueryDslMatchAllQuery.md) | Matches all roles, giving them all a `_score` of 1.0. | +| `match` | [Partial](./Partial.md)> | Returns roles that match a provided text, number, date or boolean value. The provided text is analyzed before matching. | +| `prefix` | [Partial](./Partial.md)> | Returns roles that contain a specific prefix in a provided field. | +| `range` | [Partial](./Partial.md)> | Returns roles that contain terms within a provided range. | +| `simple_query_string` | [QueryDslSimpleQueryStringQuery](./QueryDslSimpleQueryStringQuery.md) | Returns roles based on a provided query string, using a parser with a limited but fault-tolerant syntax. | +| `term` | [Partial](./Partial.md)> | Returns roles that contain an exact term in a provided field. To return a document, the query term must exactly match the queried field's value, including whitespace and capitalization. | +| `terms` | [QueryDslTermsQuery](./QueryDslTermsQuery.md) | Returns roles that contain one or more exact terms in a provided field. To return a document, one or more terms must exactly match a field value, including whitespace and capitalization. | +| `wildcard` | [Partial](./Partial.md)> | Returns roles that contain terms matching a wildcard pattern. | diff --git a/docs/reference/api/SecurityQueryUserQueryUser.md b/docs/reference/api/SecurityQueryUserQueryUser.md new file mode 100644 index 000000000..96756fdc1 --- /dev/null +++ b/docs/reference/api/SecurityQueryUserQueryUser.md @@ -0,0 +1,5 @@ +## Interface `SecurityQueryUserQueryUser` + +| Name | Type | Description | +| - | - | - | +| `_sort` | [SortResults](./SortResults.md) |   | diff --git a/docs/reference/api/SecurityQueryUserRequest.md b/docs/reference/api/SecurityQueryUserRequest.md new file mode 100644 index 000000000..fae4e22d9 --- /dev/null +++ b/docs/reference/api/SecurityQueryUserRequest.md @@ -0,0 +1,12 @@ +## Interface `SecurityQueryUserRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { with_profile_uid?: never; query?: never; from?: never; sort?: never; size?: never; search_after?: never; }) | All values in `body` will be added to the request body. | +| `from` | [integer](./integer.md) | The starting document offset. It must not be negative. By default, you cannot page through more than 10,000 hits using the `from` and `size` parameters. To page through more hits, use the `search_after` parameter. | +| `query` | [SecurityQueryUserUserQueryContainer](./SecurityQueryUserUserQueryContainer.md) | A query to filter which users to return. If the query parameter is missing, it is equivalent to a `match_all` query. The query supports a subset of query types, including `match_all`, `bool`, `term`, `terms`, `match`, `ids`, `prefix`, `wildcard`, `exists`, `range`, and `simple_query_string`. You can query the following information associated with user: `username`, `roles`, `enabled`, `full_name`, and `email`. | +| `querystring` | { [key: string]: any; } & { with_profile_uid?: never; query?: never; from?: never; sort?: never; size?: never; search_after?: never; } | All values in `querystring` will be added to the request querystring. | +| `search_after` | [SortResults](./SortResults.md) | The search after definition | +| `size` | [integer](./integer.md) | The number of hits to return. It must not be negative. By default, you cannot page through more than 10,000 hits using the `from` and `size` parameters. To page through more hits, use the `search_after` parameter. | +| `sort` | [Sort](./Sort.md) | The sort definition. Fields eligible for sorting are: `username`, `roles`, `enabled`. In addition, sort can also be applied to the `_doc` field to sort by index order. | +| `with_profile_uid` | boolean | Determines whether to retrieve the user profile UID, if it exists, for the users. | diff --git a/docs/reference/api/SecurityQueryUserResponse.md b/docs/reference/api/SecurityQueryUserResponse.md new file mode 100644 index 000000000..5a723c7ea --- /dev/null +++ b/docs/reference/api/SecurityQueryUserResponse.md @@ -0,0 +1,7 @@ +## Interface `SecurityQueryUserResponse` + +| Name | Type | Description | +| - | - | - | +| `count` | [integer](./integer.md) | The number of users returned in the response. | +| `total` | [integer](./integer.md) | The total number of users found. | +| `users` | [SecurityQueryUserQueryUser](./SecurityQueryUserQueryUser.md)[] | A list of users that match the query. | diff --git a/docs/reference/api/SecurityQueryUserUserQueryContainer.md b/docs/reference/api/SecurityQueryUserUserQueryContainer.md new file mode 100644 index 000000000..5fd819980 --- /dev/null +++ b/docs/reference/api/SecurityQueryUserUserQueryContainer.md @@ -0,0 +1,15 @@ +## Interface `SecurityQueryUserUserQueryContainer` + +| Name | Type | Description | +| - | - | - | +| `bool` | [QueryDslBoolQuery](./QueryDslBoolQuery.md) | matches users matching boolean combinations of other queries. | +| `exists` | [QueryDslExistsQuery](./QueryDslExistsQuery.md) | Returns users that contain an indexed value for a field. | +| `ids` | [QueryDslIdsQuery](./QueryDslIdsQuery.md) | Returns users based on their IDs. This query uses the user document IDs stored in the `_id` field. | +| `match_all` | [QueryDslMatchAllQuery](./QueryDslMatchAllQuery.md) | Matches all users, giving them all a `_score` of 1.0. | +| `match` | [Partial](./Partial.md)> | Returns users that match a provided text, number, date or boolean value. The provided text is analyzed before matching. | +| `prefix` | [Partial](./Partial.md)> | Returns users that contain a specific prefix in a provided field. | +| `range` | [Partial](./Partial.md)> | Returns users that contain terms within a provided range. | +| `simple_query_string` | [QueryDslSimpleQueryStringQuery](./QueryDslSimpleQueryStringQuery.md) | Returns users based on a provided query string, using a parser with a limited but fault-tolerant syntax. | +| `term` | [Partial](./Partial.md)> | Returns users that contain an exact term in a provided field. To return a document, the query term must exactly match the queried field's value, including whitespace and capitalization. | +| `terms` | [QueryDslTermsQuery](./QueryDslTermsQuery.md) | Returns users that contain one or more exact terms in a provided field. To return a document, one or more terms must exactly match a field value, including whitespace and capitalization. | +| `wildcard` | [Partial](./Partial.md)> | Returns users that contain terms matching a wildcard pattern. | diff --git a/docs/reference/api/SecurityRealmInfo.md b/docs/reference/api/SecurityRealmInfo.md new file mode 100644 index 000000000..e31de973a --- /dev/null +++ b/docs/reference/api/SecurityRealmInfo.md @@ -0,0 +1,6 @@ +## Interface `SecurityRealmInfo` + +| Name | Type | Description | +| - | - | - | +| `name` | [Name](./Name.md) |   | +| `type` | string |   | diff --git a/docs/reference/api/SecurityRemoteClusterPrivilege.md b/docs/reference/api/SecurityRemoteClusterPrivilege.md new file mode 100644 index 000000000..6eb745911 --- /dev/null +++ b/docs/reference/api/SecurityRemoteClusterPrivilege.md @@ -0,0 +1,4 @@ +## `SecurityRemoteClusterPrivilege` +::: +type SecurityRemoteClusterPrivilege = 'monitor_enrich' | 'monitor_stats'; +::: diff --git a/docs/reference/api/SecurityRemoteClusterPrivileges.md b/docs/reference/api/SecurityRemoteClusterPrivileges.md new file mode 100644 index 000000000..3ac9ac72a --- /dev/null +++ b/docs/reference/api/SecurityRemoteClusterPrivileges.md @@ -0,0 +1,6 @@ +## Interface `SecurityRemoteClusterPrivileges` + +| Name | Type | Description | +| - | - | - | +| `clusters` | [Names](./Names.md) | A list of cluster aliases to which the permissions in this entry apply. | +| `privileges` | [SecurityRemoteClusterPrivilege](./SecurityRemoteClusterPrivilege.md)[] | The cluster level privileges that owners of the role have on the remote cluster. | diff --git a/docs/reference/api/SecurityRemoteIndicesPrivileges.md b/docs/reference/api/SecurityRemoteIndicesPrivileges.md new file mode 100644 index 000000000..e3e71a257 --- /dev/null +++ b/docs/reference/api/SecurityRemoteIndicesPrivileges.md @@ -0,0 +1,10 @@ +## Interface `SecurityRemoteIndicesPrivileges` + +| Name | Type | Description | +| - | - | - | +| `allow_restricted_indices` | boolean | Set to `true` if using wildcard or regular expressions for patterns that cover restricted indices. Implicitly, restricted indices have limited privileges that can cause pattern tests to fail. If restricted indices are explicitly included in the `names` list, Elasticsearch checks privileges against these indices regardless of the value set for `allow_restricted_indices`. | +| `clusters` | [Names](./Names.md) | A list of cluster aliases to which the permissions in this entry apply. | +| `field_security` | [SecurityFieldSecurity](./SecurityFieldSecurity.md) | The document fields that the owners of the role have read access to. | +| `names` | [IndexName](./IndexName.md) | [IndexName](./IndexName.md)[] | A list of indices (or index name patterns) to which the permissions in this entry apply. | +| `privileges` | [SecurityIndexPrivilege](./SecurityIndexPrivilege.md)[] | The index level privileges that owners of the role have on the specified indices. | +| `query` | [SecurityIndicesPrivilegesQuery](./SecurityIndicesPrivilegesQuery.md) | A search query that defines the documents the owners of the role have access to. A document within the specified indices must match this query for it to be accessible by the owners of the role. | diff --git a/docs/reference/api/SecurityRemoteUserIndicesPrivileges.md b/docs/reference/api/SecurityRemoteUserIndicesPrivileges.md new file mode 100644 index 000000000..cc65b7488 --- /dev/null +++ b/docs/reference/api/SecurityRemoteUserIndicesPrivileges.md @@ -0,0 +1,10 @@ +## Interface `SecurityRemoteUserIndicesPrivileges` + +| Name | Type | Description | +| - | - | - | +| `allow_restricted_indices` | boolean | Set to `true` if using wildcard or regular expressions for patterns that cover restricted indices. Implicitly, restricted indices have limited privileges that can cause pattern tests to fail. If restricted indices are explicitly included in the `names` list, Elasticsearch checks privileges against these indices regardless of the value set for `allow_restricted_indices`. | +| `clusters` | string[] |   | +| `field_security` | [SecurityFieldSecurity](./SecurityFieldSecurity.md)[] | The document fields that the owners of the role have read access to. | +| `names` | [IndexName](./IndexName.md) | [IndexName](./IndexName.md)[] | A list of indices (or index name patterns) to which the permissions in this entry apply. | +| `privileges` | [SecurityIndexPrivilege](./SecurityIndexPrivilege.md)[] | The index level privileges that owners of the role have on the specified indices. | +| `query` | [SecurityIndicesPrivilegesQuery](./SecurityIndicesPrivilegesQuery.md)[] | Search queries that define the documents the user has access to. A document within the specified indices must match these queries for it to be accessible by the owners of the role. | diff --git a/docs/reference/api/SecurityReplicationAccess.md b/docs/reference/api/SecurityReplicationAccess.md new file mode 100644 index 000000000..05143c2b1 --- /dev/null +++ b/docs/reference/api/SecurityReplicationAccess.md @@ -0,0 +1,6 @@ +## Interface `SecurityReplicationAccess` + +| Name | Type | Description | +| - | - | - | +| `allow_restricted_indices` | boolean | This needs to be set to true if the patterns in the names field should cover system indices. | +| `names` | [IndexName](./IndexName.md) | [IndexName](./IndexName.md)[] | A list of indices (or index name patterns) to which the permissions in this entry apply. | diff --git a/docs/reference/api/SecurityRestriction.md b/docs/reference/api/SecurityRestriction.md new file mode 100644 index 000000000..9acf5340c --- /dev/null +++ b/docs/reference/api/SecurityRestriction.md @@ -0,0 +1,5 @@ +## Interface `SecurityRestriction` + +| Name | Type | Description | +| - | - | - | +| `workflows` | [SecurityRestrictionWorkflow](./SecurityRestrictionWorkflow.md)[] | A list of workflows to which the API key is restricted. NOTE: In order to use a role restriction, an API key must be created with a single role descriptor. | diff --git a/docs/reference/api/SecurityRestrictionWorkflow.md b/docs/reference/api/SecurityRestrictionWorkflow.md new file mode 100644 index 000000000..9ff9ccf15 --- /dev/null +++ b/docs/reference/api/SecurityRestrictionWorkflow.md @@ -0,0 +1,4 @@ +## `SecurityRestrictionWorkflow` +::: +type SecurityRestrictionWorkflow = 'search_application_query' | string; +::: diff --git a/docs/reference/api/SecurityRoleDescriptor.md b/docs/reference/api/SecurityRoleDescriptor.md new file mode 100644 index 000000000..b4cc379f5 --- /dev/null +++ b/docs/reference/api/SecurityRoleDescriptor.md @@ -0,0 +1,16 @@ +## Interface `SecurityRoleDescriptor` + +| Name | Type | Description | +| - | - | - | +| `applications` | [SecurityApplicationPrivileges](./SecurityApplicationPrivileges.md)[] | A list of application privilege entries | +| `cluster` | [SecurityClusterPrivilege](./SecurityClusterPrivilege.md)[] | A list of cluster privileges. These privileges define the cluster level actions that API keys are able to execute. | +| `description` | string | Optional description of the role descriptor | +| `global` | [SecurityGlobalPrivilege](./SecurityGlobalPrivilege.md)[] | [SecurityGlobalPrivilege](./SecurityGlobalPrivilege.md) | An object defining global privileges. A global privilege is a form of cluster privilege that is request-aware. Support for global privileges is currently limited to the management of application privileges. | +| `index` | [SecurityIndicesPrivileges](./SecurityIndicesPrivileges.md)[] | A list of indices permissions entries. indices | +| `indices` | [SecurityIndicesPrivileges](./SecurityIndicesPrivileges.md)[] | A list of indices permissions entries. | +| `metadata` | [Metadata](./Metadata.md) | Optional meta-data. Within the metadata object, keys that begin with `_` are reserved for system usage. | +| `remote_cluster` | [SecurityRemoteClusterPrivileges](./SecurityRemoteClusterPrivileges.md)[] | A list of cluster permissions for remote clusters. NOTE: This is limited a subset of the cluster permissions. | +| `remote_indices` | [SecurityRemoteIndicesPrivileges](./SecurityRemoteIndicesPrivileges.md)[] | A list of indices permissions for remote clusters. | +| `restriction` | [SecurityRestriction](./SecurityRestriction.md) | Restriction for when the role descriptor is allowed to be effective. | +| `run_as` | string[] | A list of users that the API keys can impersonate. NOTE: In Elastic Cloud Serverless, the run-as feature is disabled. For API compatibility, you can still specify an empty `run_as` field, but a non-empty list will be rejected. | +| `transient_metadata` | Record |   | diff --git a/docs/reference/api/SecurityRoleDescriptorRead.md b/docs/reference/api/SecurityRoleDescriptorRead.md new file mode 100644 index 000000000..8638aaa61 --- /dev/null +++ b/docs/reference/api/SecurityRoleDescriptorRead.md @@ -0,0 +1,16 @@ +## Interface `SecurityRoleDescriptorRead` + +| Name | Type | Description | +| - | - | - | +| `applications` | [SecurityApplicationPrivileges](./SecurityApplicationPrivileges.md)[] | A list of application privilege entries | +| `cluster` | [SecurityClusterPrivilege](./SecurityClusterPrivilege.md)[] | A list of cluster privileges. These privileges define the cluster level actions that API keys are able to execute. | +| `description` | string | An optional description of the role descriptor. | +| `global` | [SecurityGlobalPrivilege](./SecurityGlobalPrivilege.md)[] | [SecurityGlobalPrivilege](./SecurityGlobalPrivilege.md) | An object defining global privileges. A global privilege is a form of cluster privilege that is request-aware. Support for global privileges is currently limited to the management of application privileges. | +| `index` | [SecurityIndicesPrivileges](./SecurityIndicesPrivileges.md)[] | A list of indices permissions entries. indices | +| `indices` | [SecurityIndicesPrivileges](./SecurityIndicesPrivileges.md)[] | A list of indices permissions entries. | +| `metadata` | [Metadata](./Metadata.md) | Optional meta-data. Within the metadata object, keys that begin with `_` are reserved for system usage. | +| `remote_cluster` | [SecurityRemoteClusterPrivileges](./SecurityRemoteClusterPrivileges.md)[] | A list of cluster permissions for remote clusters. NOTE: This is limited a subset of the cluster permissions. | +| `remote_indices` | [SecurityRemoteIndicesPrivileges](./SecurityRemoteIndicesPrivileges.md)[] | A list of indices permissions for remote clusters. | +| `restriction` | [SecurityRestriction](./SecurityRestriction.md) | A restriction for when the role descriptor is allowed to be effective. | +| `run_as` | string[] | A list of users that the API keys can impersonate. | +| `transient_metadata` | Record |   | diff --git a/docs/reference/api/SecurityRoleMapping.md b/docs/reference/api/SecurityRoleMapping.md new file mode 100644 index 000000000..3f3f39c1c --- /dev/null +++ b/docs/reference/api/SecurityRoleMapping.md @@ -0,0 +1,9 @@ +## Interface `SecurityRoleMapping` + +| Name | Type | Description | +| - | - | - | +| `enabled` | boolean |   | +| `metadata` | [Metadata](./Metadata.md) |   | +| `role_templates` | [SecurityRoleTemplate](./SecurityRoleTemplate.md)[] |   | +| `roles` | string[] |   | +| `rules` | [SecurityRoleMappingRule](./SecurityRoleMappingRule.md) |   | diff --git a/docs/reference/api/SecurityRoleMappingRule.md b/docs/reference/api/SecurityRoleMappingRule.md new file mode 100644 index 000000000..8704bf160 --- /dev/null +++ b/docs/reference/api/SecurityRoleMappingRule.md @@ -0,0 +1,8 @@ +## Interface `SecurityRoleMappingRule` + +| Name | Type | Description | +| - | - | - | +| `all` | [SecurityRoleMappingRule](./SecurityRoleMappingRule.md)[] |   | +| `any` | [SecurityRoleMappingRule](./SecurityRoleMappingRule.md)[] |   | +| `except` | [SecurityRoleMappingRule](./SecurityRoleMappingRule.md) |   | +| `field` | [Partial](./Partial.md)> |   | diff --git a/docs/reference/api/SecurityRoleTemplate.md b/docs/reference/api/SecurityRoleTemplate.md new file mode 100644 index 000000000..81e4bcab5 --- /dev/null +++ b/docs/reference/api/SecurityRoleTemplate.md @@ -0,0 +1,6 @@ +## Interface `SecurityRoleTemplate` + +| Name | Type | Description | +| - | - | - | +| `format` | [SecurityTemplateFormat](./SecurityTemplateFormat.md) |   | +| `template` | [Script](./Script.md) | [ScriptSource](./ScriptSource.md) |   | diff --git a/docs/reference/api/SecurityRoleTemplateInlineQuery.md b/docs/reference/api/SecurityRoleTemplateInlineQuery.md new file mode 100644 index 000000000..40dc9e707 --- /dev/null +++ b/docs/reference/api/SecurityRoleTemplateInlineQuery.md @@ -0,0 +1,4 @@ +## `SecurityRoleTemplateInlineQuery` +::: +type SecurityRoleTemplateInlineQuery = string | [QueryDslQueryContainer](./QueryDslQueryContainer.md); +::: diff --git a/docs/reference/api/SecurityRoleTemplateQuery.md b/docs/reference/api/SecurityRoleTemplateQuery.md new file mode 100644 index 000000000..61a2988a0 --- /dev/null +++ b/docs/reference/api/SecurityRoleTemplateQuery.md @@ -0,0 +1,5 @@ +## Interface `SecurityRoleTemplateQuery` + +| Name | Type | Description | +| - | - | - | +| `template` | [SecurityRoleTemplateScript](./SecurityRoleTemplateScript.md) | [SecurityRoleTemplateInlineQuery](./SecurityRoleTemplateInlineQuery.md) | When you create a role, you can specify a query that defines the document level security permissions. You can optionally use Mustache templates in the role query to insert the username of the current authenticated user into the role. Like other places in Elasticsearch that support templating or scripting, you can specify inline, stored, or file-based templates and define custom parameters. You access the details for the current authenticated user through the _user parameter. | diff --git a/docs/reference/api/SecurityRoleTemplateScript.md b/docs/reference/api/SecurityRoleTemplateScript.md new file mode 100644 index 000000000..1b0c6511b --- /dev/null +++ b/docs/reference/api/SecurityRoleTemplateScript.md @@ -0,0 +1,9 @@ +## Interface `SecurityRoleTemplateScript` + +| Name | Type | Description | +| - | - | - | +| `id` | [Id](./Id.md) | The `id` for a stored script. | +| `lang` | [ScriptLanguage](./ScriptLanguage.md) | Specifies the language the script is written in. | +| `options` | Record |   | +| `params` | Record | Specifies any named parameters that are passed into the script as variables. Use parameters instead of hard-coded values to decrease compile time. | +| `source` | [SecurityRoleTemplateInlineQuery](./SecurityRoleTemplateInlineQuery.md) |   | diff --git a/docs/reference/api/SecuritySamlAuthenticateRequest.md b/docs/reference/api/SecuritySamlAuthenticateRequest.md new file mode 100644 index 000000000..eb2a307b0 --- /dev/null +++ b/docs/reference/api/SecuritySamlAuthenticateRequest.md @@ -0,0 +1,9 @@ +## Interface `SecuritySamlAuthenticateRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { content?: never; ids?: never; realm?: never; }) | All values in `body` will be added to the request body. | +| `content` | string | The SAML response as it was sent by the user's browser, usually a Base64 encoded XML document. | +| `ids` | [Ids](./Ids.md) | A JSON array with all the valid SAML Request Ids that the caller of the API has for the current user. | +| `querystring` | { [key: string]: any; } & { content?: never; ids?: never; realm?: never; } | All values in `querystring` will be added to the request querystring. | +| `realm` | string | The name of the realm that should authenticate the SAML response. Useful in cases where many SAML realms are defined. | diff --git a/docs/reference/api/SecuritySamlAuthenticateResponse.md b/docs/reference/api/SecuritySamlAuthenticateResponse.md new file mode 100644 index 000000000..ad2146589 --- /dev/null +++ b/docs/reference/api/SecuritySamlAuthenticateResponse.md @@ -0,0 +1,9 @@ +## Interface `SecuritySamlAuthenticateResponse` + +| Name | Type | Description | +| - | - | - | +| `access_token` | string | The access token that was generated by Elasticsearch. | +| `expires_in` | [integer](./integer.md) | The amount of time (in seconds) left until the token expires. | +| `realm` | string | The name of the realm where the user was authenticated. | +| `refresh_token` | string | The refresh token that was generated by Elasticsearch. | +| `username` | string | The authenticated user's name. | diff --git a/docs/reference/api/SecuritySamlCompleteLogoutRequest.md b/docs/reference/api/SecuritySamlCompleteLogoutRequest.md new file mode 100644 index 000000000..3a1d3aa2c --- /dev/null +++ b/docs/reference/api/SecuritySamlCompleteLogoutRequest.md @@ -0,0 +1,10 @@ +## Interface `SecuritySamlCompleteLogoutRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { realm?: never; ids?: never; query_string?: never; content?: never; }) | All values in `body` will be added to the request body. | +| `content` | string | If the SAML IdP sends the logout response with the HTTP-Post binding, this field must be set to the value of the SAMLResponse form parameter from the logout response. | +| `ids` | [Ids](./Ids.md) | A JSON array with all the valid SAML Request Ids that the caller of the API has for the current user. | +| `query_string` | string | If the SAML IdP sends the logout response with the HTTP-Redirect binding, this field must be set to the query string of the redirect URI. | +| `querystring` | { [key: string]: any; } & { realm?: never; ids?: never; query_string?: never; content?: never; } | All values in `querystring` will be added to the request querystring. | +| `realm` | string | The name of the SAML realm in Elasticsearch for which the configuration is used to verify the logout response. | diff --git a/docs/reference/api/SecuritySamlCompleteLogoutResponse.md b/docs/reference/api/SecuritySamlCompleteLogoutResponse.md new file mode 100644 index 000000000..e6a9c254e --- /dev/null +++ b/docs/reference/api/SecuritySamlCompleteLogoutResponse.md @@ -0,0 +1,4 @@ +## `SecuritySamlCompleteLogoutResponse` +::: +type SecuritySamlCompleteLogoutResponse = boolean; +::: diff --git a/docs/reference/api/SecuritySamlInvalidateRequest.md b/docs/reference/api/SecuritySamlInvalidateRequest.md new file mode 100644 index 000000000..1bd43fbc1 --- /dev/null +++ b/docs/reference/api/SecuritySamlInvalidateRequest.md @@ -0,0 +1,9 @@ +## Interface `SecuritySamlInvalidateRequest` + +| Name | Type | Description | +| - | - | - | +| `acs` | string | The Assertion Consumer Service URL that matches the one of the SAML realm in Elasticsearch that should be used. You must specify either this parameter or the `realm` parameter. | +| `body` | string | ({ [key: string]: any; } & { acs?: never; query_string?: never; realm?: never; }) | All values in `body` will be added to the request body. | +| `query_string` | string | The query part of the URL that the user was redirected to by the SAML IdP to initiate the Single Logout. This query should include a single parameter named `SAMLRequest` that contains a SAML logout request that is deflated and Base64 encoded. If the SAML IdP has signed the logout request, the URL should include two extra parameters named `SigAlg` and `Signature` that contain the algorithm used for the signature and the signature value itself. In order for Elasticsearch to be able to verify the IdP's signature, the value of the `query_string` field must be an exact match to the string provided by the browser. The client application must not attempt to parse or process the string in any way. | +| `querystring` | { [key: string]: any; } & { acs?: never; query_string?: never; realm?: never; } | All values in `querystring` will be added to the request querystring. | +| `realm` | string | The name of the SAML realm in Elasticsearch the configuration. You must specify either this parameter or the `acs` parameter. | diff --git a/docs/reference/api/SecuritySamlInvalidateResponse.md b/docs/reference/api/SecuritySamlInvalidateResponse.md new file mode 100644 index 000000000..b2ad3e429 --- /dev/null +++ b/docs/reference/api/SecuritySamlInvalidateResponse.md @@ -0,0 +1,7 @@ +## Interface `SecuritySamlInvalidateResponse` + +| Name | Type | Description | +| - | - | - | +| `invalidated` | [integer](./integer.md) | The number of tokens that were invalidated as part of this logout. | +| `realm` | string | The realm name of the SAML realm in Elasticsearch that authenticated the user. | +| `redirect` | string | A SAML logout response as a parameter so that the user can be redirected back to the SAML IdP. | diff --git a/docs/reference/api/SecuritySamlLogoutRequest.md b/docs/reference/api/SecuritySamlLogoutRequest.md new file mode 100644 index 000000000..a75792bb4 --- /dev/null +++ b/docs/reference/api/SecuritySamlLogoutRequest.md @@ -0,0 +1,8 @@ +## Interface `SecuritySamlLogoutRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { token?: never; refresh_token?: never; }) | All values in `body` will be added to the request body. | +| `querystring` | { [key: string]: any; } & { token?: never; refresh_token?: never; } | All values in `querystring` will be added to the request querystring. | +| `refresh_token` | string | The refresh token that was returned as a response to calling the SAML authenticate API. Alternatively, the most recent refresh token that was received after refreshing the original access token. | +| `token` | string | The access token that was returned as a response to calling the SAML authenticate API. Alternatively, the most recent token that was received after refreshing the original one by using a `refresh_token`. | diff --git a/docs/reference/api/SecuritySamlLogoutResponse.md b/docs/reference/api/SecuritySamlLogoutResponse.md new file mode 100644 index 000000000..4e7609a99 --- /dev/null +++ b/docs/reference/api/SecuritySamlLogoutResponse.md @@ -0,0 +1,5 @@ +## Interface `SecuritySamlLogoutResponse` + +| Name | Type | Description | +| - | - | - | +| `redirect` | string | A URL that contains a SAML logout request as a parameter. You can use this URL to be redirected back to the SAML IdP and to initiate Single Logout. | diff --git a/docs/reference/api/SecuritySamlPrepareAuthenticationRequest.md b/docs/reference/api/SecuritySamlPrepareAuthenticationRequest.md new file mode 100644 index 000000000..408fc1b70 --- /dev/null +++ b/docs/reference/api/SecuritySamlPrepareAuthenticationRequest.md @@ -0,0 +1,9 @@ +## Interface `SecuritySamlPrepareAuthenticationRequest` + +| Name | Type | Description | +| - | - | - | +| `acs` | string | The Assertion Consumer Service URL that matches the one of the SAML realms in Elasticsearch. The realm is used to generate the authentication request. You must specify either this parameter or the `realm` parameter. | +| `body` | string | ({ [key: string]: any; } & { acs?: never; realm?: never; relay_state?: never; }) | All values in `body` will be added to the request body. | +| `querystring` | { [key: string]: any; } & { acs?: never; realm?: never; relay_state?: never; } | All values in `querystring` will be added to the request querystring. | +| `realm` | string | The name of the SAML realm in Elasticsearch for which the configuration is used to generate the authentication request. You must specify either this parameter or the `acs` parameter. | +| `relay_state` | string | A string that will be included in the redirect URL that this API returns as the `RelayState` query parameter. If the Authentication Request is signed, this value is used as part of the signature computation. | diff --git a/docs/reference/api/SecuritySamlPrepareAuthenticationResponse.md b/docs/reference/api/SecuritySamlPrepareAuthenticationResponse.md new file mode 100644 index 000000000..3480bbd62 --- /dev/null +++ b/docs/reference/api/SecuritySamlPrepareAuthenticationResponse.md @@ -0,0 +1,7 @@ +## Interface `SecuritySamlPrepareAuthenticationResponse` + +| Name | Type | Description | +| - | - | - | +| `id` | [Id](./Id.md) | A unique identifier for the SAML Request to be stored by the caller of the API. | +| `realm` | string | The name of the Elasticsearch realm that was used to construct the authentication request. | +| `redirect` | string | The URL to redirect the user to. | diff --git a/docs/reference/api/SecuritySamlServiceProviderMetadataRequest.md b/docs/reference/api/SecuritySamlServiceProviderMetadataRequest.md new file mode 100644 index 000000000..f7e3494e9 --- /dev/null +++ b/docs/reference/api/SecuritySamlServiceProviderMetadataRequest.md @@ -0,0 +1,7 @@ +## Interface `SecuritySamlServiceProviderMetadataRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { realm_name?: never; }) | All values in `body` will be added to the request body. | +| `querystring` | { [key: string]: any; } & { realm_name?: never; } | All values in `querystring` will be added to the request querystring. | +| `realm_name` | [Name](./Name.md) | The name of the SAML realm in Elasticsearch. | diff --git a/docs/reference/api/SecuritySamlServiceProviderMetadataResponse.md b/docs/reference/api/SecuritySamlServiceProviderMetadataResponse.md new file mode 100644 index 000000000..5a118ad64 --- /dev/null +++ b/docs/reference/api/SecuritySamlServiceProviderMetadataResponse.md @@ -0,0 +1,5 @@ +## Interface `SecuritySamlServiceProviderMetadataResponse` + +| Name | Type | Description | +| - | - | - | +| `metadata` | string | An XML string that contains a SAML Service Provider's metadata for the realm. | diff --git a/docs/reference/api/SecuritySearchAccess.md b/docs/reference/api/SecuritySearchAccess.md new file mode 100644 index 000000000..9307625eb --- /dev/null +++ b/docs/reference/api/SecuritySearchAccess.md @@ -0,0 +1,8 @@ +## Interface `SecuritySearchAccess` + +| Name | Type | Description | +| - | - | - | +| `allow_restricted_indices` | boolean | Set to `true` if using wildcard or regular expressions for patterns that cover restricted indices. Implicitly, restricted indices have limited privileges that can cause pattern tests to fail. If restricted indices are explicitly included in the `names` list, Elasticsearch checks privileges against these indices regardless of the value set for `allow_restricted_indices`. | +| `field_security` | [SecurityFieldSecurity](./SecurityFieldSecurity.md) | The document fields that the owners of the role have read access to. | +| `names` | [IndexName](./IndexName.md) | [IndexName](./IndexName.md)[] | A list of indices (or index name patterns) to which the permissions in this entry apply. | +| `query` | [SecurityIndicesPrivilegesQuery](./SecurityIndicesPrivilegesQuery.md) | A search query that defines the documents the owners of the role have access to. A document within the specified indices must match this query for it to be accessible by the owners of the role. | diff --git a/docs/reference/api/SecuritySecuritySettings.md b/docs/reference/api/SecuritySecuritySettings.md new file mode 100644 index 000000000..5e7b32a93 --- /dev/null +++ b/docs/reference/api/SecuritySecuritySettings.md @@ -0,0 +1,5 @@ +## Interface `SecuritySecuritySettings` + +| Name | Type | Description | +| - | - | - | +| `index` | [IndicesIndexSettings](./IndicesIndexSettings.md) |   | diff --git a/docs/reference/api/SecuritySuggestUserProfilesHint.md b/docs/reference/api/SecuritySuggestUserProfilesHint.md new file mode 100644 index 000000000..b956b4b23 --- /dev/null +++ b/docs/reference/api/SecuritySuggestUserProfilesHint.md @@ -0,0 +1,6 @@ +## Interface `SecuritySuggestUserProfilesHint` + +| Name | Type | Description | +| - | - | - | +| `labels` | Record | A single key-value pair to match against the labels section of a profile. A profile is considered matching if it matches at least one of the strings. | +| `uids` | [SecurityUserProfileId](./SecurityUserProfileId.md)[] | A list of profile UIDs to match against. | diff --git a/docs/reference/api/SecuritySuggestUserProfilesRequest.md b/docs/reference/api/SecuritySuggestUserProfilesRequest.md new file mode 100644 index 000000000..05c8b96ed --- /dev/null +++ b/docs/reference/api/SecuritySuggestUserProfilesRequest.md @@ -0,0 +1,10 @@ +## Interface `SecuritySuggestUserProfilesRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { name?: never; size?: never; data?: never; hint?: never; }) | All values in `body` will be added to the request body. | +| `data` | string | string[] | A comma-separated list of filters for the `data` field of the profile document. To return all content use `data=*`. To return a subset of content, use `data=` to retrieve content nested under the specified ``. By default, the API returns no `data` content. It is an error to specify `data` as both the query parameter and the request body field. | +| `hint` | [SecuritySuggestUserProfilesHint](./SecuritySuggestUserProfilesHint.md) | Extra search criteria to improve relevance of the suggestion result. Profiles matching the spcified hint are ranked higher in the response. Profiles not matching the hint aren't excluded from the response as long as the profile matches the `name` field query. | +| `name` | string | A query string used to match name-related fields in user profile documents. Name-related fields are the user's `username`, `full_name`, and `email`. | +| `querystring` | { [key: string]: any; } & { name?: never; size?: never; data?: never; hint?: never; } | All values in `querystring` will be added to the request querystring. | +| `size` | [long](./long.md) | The number of profiles to return. | diff --git a/docs/reference/api/SecuritySuggestUserProfilesResponse.md b/docs/reference/api/SecuritySuggestUserProfilesResponse.md new file mode 100644 index 000000000..dd31bef8a --- /dev/null +++ b/docs/reference/api/SecuritySuggestUserProfilesResponse.md @@ -0,0 +1,7 @@ +## Interface `SecuritySuggestUserProfilesResponse` + +| Name | Type | Description | +| - | - | - | +| `profiles` | [SecurityUserProfile](./SecurityUserProfile.md)[] | A list of profile documents, ordered by relevance, that match the search criteria. | +| `took` | [long](./long.md) | The number of milliseconds it took Elasticsearch to run the request. | +| `total` | [SecuritySuggestUserProfilesTotalUserProfiles](./SecuritySuggestUserProfilesTotalUserProfiles.md) | Metadata about the number of matching profiles. | diff --git a/docs/reference/api/SecuritySuggestUserProfilesTotalUserProfiles.md b/docs/reference/api/SecuritySuggestUserProfilesTotalUserProfiles.md new file mode 100644 index 000000000..a90642d88 --- /dev/null +++ b/docs/reference/api/SecuritySuggestUserProfilesTotalUserProfiles.md @@ -0,0 +1,6 @@ +## Interface `SecuritySuggestUserProfilesTotalUserProfiles` + +| Name | Type | Description | +| - | - | - | +| `relation` | [RelationName](./RelationName.md) |   | +| `value` | [long](./long.md) |   | diff --git a/docs/reference/api/SecurityTemplateFormat.md b/docs/reference/api/SecurityTemplateFormat.md new file mode 100644 index 000000000..af572c41b --- /dev/null +++ b/docs/reference/api/SecurityTemplateFormat.md @@ -0,0 +1,4 @@ +## `SecurityTemplateFormat` +::: +type SecurityTemplateFormat = 'string' | 'json'; +::: diff --git a/docs/reference/api/SecurityUpdateApiKeyRequest.md b/docs/reference/api/SecurityUpdateApiKeyRequest.md new file mode 100644 index 000000000..e8daa0dd5 --- /dev/null +++ b/docs/reference/api/SecurityUpdateApiKeyRequest.md @@ -0,0 +1,10 @@ +## Interface `SecurityUpdateApiKeyRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { id?: never; role_descriptors?: never; metadata?: never; expiration?: never; }) | All values in `body` will be added to the request body. | +| `expiration` | [Duration](./Duration.md) | The expiration time for the API key. By default, API keys never expire. This property can be omitted to leave the expiration unchanged. | +| `id` | [Id](./Id.md) | The ID of the API key to update. | +| `metadata` | [Metadata](./Metadata.md) | Arbitrary metadata that you want to associate with the API key. It supports a nested data structure. Within the metadata object, keys beginning with `_` are reserved for system usage. When specified, this value fully replaces the metadata previously associated with the API key. | +| `querystring` | { [key: string]: any; } & { id?: never; role_descriptors?: never; metadata?: never; expiration?: never; } | All values in `querystring` will be added to the request querystring. | +| `role_descriptors` | Record | The role descriptors to assign to this API key. The API key's effective permissions are an intersection of its assigned privileges and the point in time snapshot of permissions of the owner user. You can assign new privileges by specifying them in this parameter. To remove assigned privileges, you can supply an empty `role_descriptors` parameter, that is to say, an empty object `{}`. If an API key has no assigned privileges, it inherits the owner user's full permissions. The snapshot of the owner's permissions is always updated, whether you supply the `role_descriptors` parameter or not. The structure of a role descriptor is the same as the request for the create API keys API. | diff --git a/docs/reference/api/SecurityUpdateApiKeyResponse.md b/docs/reference/api/SecurityUpdateApiKeyResponse.md new file mode 100644 index 000000000..0ebf5d3a1 --- /dev/null +++ b/docs/reference/api/SecurityUpdateApiKeyResponse.md @@ -0,0 +1,5 @@ +## Interface `SecurityUpdateApiKeyResponse` + +| Name | Type | Description | +| - | - | - | +| `updated` | boolean | If `true`, the API key was updated. If `false`, the API key didn't change because no change was detected. | diff --git a/docs/reference/api/SecurityUpdateCrossClusterApiKeyRequest.md b/docs/reference/api/SecurityUpdateCrossClusterApiKeyRequest.md new file mode 100644 index 000000000..1ff73dff2 --- /dev/null +++ b/docs/reference/api/SecurityUpdateCrossClusterApiKeyRequest.md @@ -0,0 +1,10 @@ +## Interface `SecurityUpdateCrossClusterApiKeyRequest` + +| Name | Type | Description | +| - | - | - | +| `access` | [SecurityAccess](./SecurityAccess.md) | The access to be granted to this API key. The access is composed of permissions for cross cluster search and cross cluster replication. At least one of them must be specified. When specified, the new access assignment fully replaces the previously assigned access. | +| `body` | string | ({ [key: string]: any; } & { id?: never; access?: never; expiration?: never; metadata?: never; }) | All values in `body` will be added to the request body. | +| `expiration` | [Duration](./Duration.md) | The expiration time for the API key. By default, API keys never expire. This property can be omitted to leave the value unchanged. | +| `id` | [Id](./Id.md) | The ID of the cross-cluster API key to update. | +| `metadata` | [Metadata](./Metadata.md) | Arbitrary metadata that you want to associate with the API key. It supports nested data structure. Within the metadata object, keys beginning with `_` are reserved for system usage. When specified, this information fully replaces metadata previously associated with the API key. | +| `querystring` | { [key: string]: any; } & { id?: never; access?: never; expiration?: never; metadata?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/SecurityUpdateCrossClusterApiKeyResponse.md b/docs/reference/api/SecurityUpdateCrossClusterApiKeyResponse.md new file mode 100644 index 000000000..4c8fd2996 --- /dev/null +++ b/docs/reference/api/SecurityUpdateCrossClusterApiKeyResponse.md @@ -0,0 +1,5 @@ +## Interface `SecurityUpdateCrossClusterApiKeyResponse` + +| Name | Type | Description | +| - | - | - | +| `updated` | boolean | If `true`, the API key was updated. If `false`, the API key didn’t change because no change was detected. | diff --git a/docs/reference/api/SecurityUpdateSettingsRequest.md b/docs/reference/api/SecurityUpdateSettingsRequest.md new file mode 100644 index 000000000..6d05a0b90 --- /dev/null +++ b/docs/reference/api/SecurityUpdateSettingsRequest.md @@ -0,0 +1,11 @@ +## Interface `SecurityUpdateSettingsRequest` + +| Name | Type | Description | +| - | - | - | +| `"security-profile"` | [SecuritySecuritySettings](./SecuritySecuritySettings.md) | Settings for the index used to store profile information. | +| `"security-tokens"` | [SecuritySecuritySettings](./SecuritySecuritySettings.md) | Settings for the index used to store tokens. | +| `body` | string | ({ [key: string]: any; } & { master_timeout?: never; timeout?: never; security?: never; 'security-profile'?: never; 'security-tokens'?: never; }) | All values in `body` will be added to the request body. | +| `master_timeout` | [Duration](./Duration.md) | The period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. | +| `querystring` | { [key: string]: any; } & { master_timeout?: never; timeout?: never; security?: never; 'security-profile'?: never; 'security-tokens'?: never; } | All values in `querystring` will be added to the request querystring. | +| `security` | [SecuritySecuritySettings](./SecuritySecuritySettings.md) | Settings for the index used for most security configuration, including native realm users and roles configured with the API. | +| `timeout` | [Duration](./Duration.md) | The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. | diff --git a/docs/reference/api/SecurityUpdateSettingsResponse.md b/docs/reference/api/SecurityUpdateSettingsResponse.md new file mode 100644 index 000000000..2d28ad016 --- /dev/null +++ b/docs/reference/api/SecurityUpdateSettingsResponse.md @@ -0,0 +1,5 @@ +## Interface `SecurityUpdateSettingsResponse` + +| Name | Type | Description | +| - | - | - | +| `acknowledged` | boolean |   | diff --git a/docs/reference/api/SecurityUpdateUserProfileDataRequest.md b/docs/reference/api/SecurityUpdateUserProfileDataRequest.md new file mode 100644 index 000000000..806aa5fba --- /dev/null +++ b/docs/reference/api/SecurityUpdateUserProfileDataRequest.md @@ -0,0 +1,12 @@ +## Interface `SecurityUpdateUserProfileDataRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { uid?: never; if_seq_no?: never; if_primary_term?: never; refresh?: never; labels?: never; data?: never; }) | All values in `body` will be added to the request body. | +| `data` | Record | Non-searchable data that you want to associate with the user profile. This field supports a nested data structure. Within the `data` object, top-level keys cannot begin with an underscore ( `_`) or contain a period ( `.`). The data object is not searchable, but can be retrieved with the get user profile API. | +| `if_primary_term` | [long](./long.md) | Only perform the operation if the document has this primary term. | +| `if_seq_no` | [SequenceNumber](./SequenceNumber.md) | Only perform the operation if the document has this sequence number. | +| `labels` | Record | Searchable data that you want to associate with the user profile. This field supports a nested data structure. Within the labels object, top-level keys cannot begin with an underscore ( `_`) or contain a period ( `.`). | +| `querystring` | { [key: string]: any; } & { uid?: never; if_seq_no?: never; if_primary_term?: never; refresh?: never; labels?: never; data?: never; } | All values in `querystring` will be added to the request querystring. | +| `refresh` | [Refresh](./Refresh.md) | If 'true', Elasticsearch refreshes the affected shards to make this operation visible to search. If 'wait_for', it waits for a refresh to make this operation visible to search. If 'false', nothing is done with refreshes. | +| `uid` | [SecurityUserProfileId](./SecurityUserProfileId.md) | A unique identifier for the user profile. | diff --git a/docs/reference/api/SecurityUpdateUserProfileDataResponse.md b/docs/reference/api/SecurityUpdateUserProfileDataResponse.md new file mode 100644 index 000000000..d07ef5ddf --- /dev/null +++ b/docs/reference/api/SecurityUpdateUserProfileDataResponse.md @@ -0,0 +1,4 @@ +## `SecurityUpdateUserProfileDataResponse` +::: +type SecurityUpdateUserProfileDataResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); +::: diff --git a/docs/reference/api/SecurityUser.md b/docs/reference/api/SecurityUser.md new file mode 100644 index 000000000..e6ab13a2a --- /dev/null +++ b/docs/reference/api/SecurityUser.md @@ -0,0 +1,11 @@ +## Interface `SecurityUser` + +| Name | Type | Description | +| - | - | - | +| `email` | string | null |   | +| `enabled` | boolean |   | +| `full_name` | [Name](./Name.md) | null |   | +| `metadata` | [Metadata](./Metadata.md) |   | +| `profile_uid` | [SecurityUserProfileId](./SecurityUserProfileId.md) |   | +| `roles` | string[] |   | +| `username` | [Username](./Username.md) |   | diff --git a/docs/reference/api/SecurityUserIndicesPrivileges.md b/docs/reference/api/SecurityUserIndicesPrivileges.md new file mode 100644 index 000000000..a79d22421 --- /dev/null +++ b/docs/reference/api/SecurityUserIndicesPrivileges.md @@ -0,0 +1,9 @@ +## Interface `SecurityUserIndicesPrivileges` + +| Name | Type | Description | +| - | - | - | +| `allow_restricted_indices` | boolean | Set to `true` if using wildcard or regular expressions for patterns that cover restricted indices. Implicitly, restricted indices have limited privileges that can cause pattern tests to fail. If restricted indices are explicitly included in the `names` list, Elasticsearch checks privileges against these indices regardless of the value set for `allow_restricted_indices`. | +| `field_security` | [SecurityFieldSecurity](./SecurityFieldSecurity.md)[] | The document fields that the owners of the role have read access to. | +| `names` | [IndexName](./IndexName.md) | [IndexName](./IndexName.md)[] | A list of indices (or index name patterns) to which the permissions in this entry apply. | +| `privileges` | [SecurityIndexPrivilege](./SecurityIndexPrivilege.md)[] | The index level privileges that owners of the role have on the specified indices. | +| `query` | [SecurityIndicesPrivilegesQuery](./SecurityIndicesPrivilegesQuery.md)[] | Search queries that define the documents the user has access to. A document within the specified indices must match these queries for it to be accessible by the owners of the role. | diff --git a/docs/reference/api/SecurityUserProfile.md b/docs/reference/api/SecurityUserProfile.md new file mode 100644 index 000000000..9e2856da1 --- /dev/null +++ b/docs/reference/api/SecurityUserProfile.md @@ -0,0 +1,9 @@ +## Interface `SecurityUserProfile` + +| Name | Type | Description | +| - | - | - | +| `data` | Record |   | +| `enabled` | boolean |   | +| `labels` | Record |   | +| `uid` | [SecurityUserProfileId](./SecurityUserProfileId.md) |   | +| `user` | [SecurityUserProfileUser](./SecurityUserProfileUser.md) |   | diff --git a/docs/reference/api/SecurityUserProfileHitMetadata.md b/docs/reference/api/SecurityUserProfileHitMetadata.md new file mode 100644 index 000000000..07fc2fccf --- /dev/null +++ b/docs/reference/api/SecurityUserProfileHitMetadata.md @@ -0,0 +1,6 @@ +## Interface `SecurityUserProfileHitMetadata` + +| Name | Type | Description | +| - | - | - | +| `_primary_term` | [long](./long.md) |   | +| `_seq_no` | [SequenceNumber](./SequenceNumber.md) |   | diff --git a/docs/reference/api/SecurityUserProfileId.md b/docs/reference/api/SecurityUserProfileId.md new file mode 100644 index 000000000..19ae129b1 --- /dev/null +++ b/docs/reference/api/SecurityUserProfileId.md @@ -0,0 +1,4 @@ +## `SecurityUserProfileId` +::: +type SecurityUserProfileId = string; +::: diff --git a/docs/reference/api/SecurityUserProfileUser.md b/docs/reference/api/SecurityUserProfileUser.md new file mode 100644 index 000000000..e9bcb4218 --- /dev/null +++ b/docs/reference/api/SecurityUserProfileUser.md @@ -0,0 +1,10 @@ +## Interface `SecurityUserProfileUser` + +| Name | Type | Description | +| - | - | - | +| `email` | string | null |   | +| `full_name` | [Name](./Name.md) | null |   | +| `realm_domain` | [Name](./Name.md) |   | +| `realm_name` | [Name](./Name.md) |   | +| `roles` | string[] |   | +| `username` | [Username](./Username.md) |   | diff --git a/docs/reference/api/SecurityUserProfileWithMetadata.md b/docs/reference/api/SecurityUserProfileWithMetadata.md new file mode 100644 index 000000000..ec9e3dde3 --- /dev/null +++ b/docs/reference/api/SecurityUserProfileWithMetadata.md @@ -0,0 +1,6 @@ +## Interface `SecurityUserProfileWithMetadata` + +| Name | Type | Description | +| - | - | - | +| `_doc` | [SecurityUserProfileHitMetadata](./SecurityUserProfileHitMetadata.md) |   | +| `last_synchronized` | [long](./long.md) |   | diff --git a/docs/reference/api/SegmentsStats.md b/docs/reference/api/SegmentsStats.md new file mode 100644 index 000000000..b226ef2b8 --- /dev/null +++ b/docs/reference/api/SegmentsStats.md @@ -0,0 +1,28 @@ +## Interface `SegmentsStats` + +| Name | Type | Description | +| - | - | - | +| `count` | [integer](./integer.md) | Total number of segments across all shards assigned to selected nodes. | +| `doc_values_memory_in_bytes` | [long](./long.md) | Total amount, in bytes, of memory used for doc values across all shards assigned to selected nodes. | +| `doc_values_memory` | [ByteSize](./ByteSize.md) | Total amount of memory used for doc values across all shards assigned to selected nodes. | +| `file_sizes` | Record | This object is not populated by the cluster stats API. To get information on segment files, use the node stats API. | +| `fixed_bit_set_memory_in_bytes` | [long](./long.md) | Total amount of memory, in bytes, used by fixed bit sets across all shards assigned to selected nodes. | +| `fixed_bit_set` | [ByteSize](./ByteSize.md) | Total amount of memory used by fixed bit sets across all shards assigned to selected nodes. Fixed bit sets are used for nested object field types and type filters for join fields. | +| `index_writer_max_memory_in_bytes` | [long](./long.md) |   | +| `index_writer_memory_in_bytes` | [long](./long.md) | Total amount, in bytes, of memory used by all index writers across all shards assigned to selected nodes. | +| `index_writer_memory` | [ByteSize](./ByteSize.md) | Total amount of memory used by all index writers across all shards assigned to selected nodes. | +| `max_unsafe_auto_id_timestamp` | [long](./long.md) | Unix timestamp, in milliseconds, of the most recently retried indexing request. | +| `memory_in_bytes` | [long](./long.md) | Total amount, in bytes, of memory used for segments across all shards assigned to selected nodes. | +| `memory` | [ByteSize](./ByteSize.md) | Total amount of memory used for segments across all shards assigned to selected nodes. | +| `norms_memory_in_bytes` | [long](./long.md) | Total amount, in bytes, of memory used for normalization factors across all shards assigned to selected nodes. | +| `norms_memory` | [ByteSize](./ByteSize.md) | Total amount of memory used for normalization factors across all shards assigned to selected nodes. | +| `points_memory_in_bytes` | [long](./long.md) | Total amount, in bytes, of memory used for points across all shards assigned to selected nodes. | +| `points_memory` | [ByteSize](./ByteSize.md) | Total amount of memory used for points across all shards assigned to selected nodes. | +| `stored_fields_memory_in_bytes` | [long](./long.md) | Total amount, in bytes, of memory used for stored fields across all shards assigned to selected nodes. | +| `stored_memory` | [ByteSize](./ByteSize.md) |   | +| `term_vectors_memory_in_bytes` | [long](./long.md) | Total amount, in bytes, of memory used for term vectors across all shards assigned to selected nodes. | +| `term_vectory_memory` | [ByteSize](./ByteSize.md) | Total amount of memory used for term vectors across all shards assigned to selected nodes. | +| `terms_memory_in_bytes` | [long](./long.md) | Total amount, in bytes, of memory used for terms across all shards assigned to selected nodes. | +| `terms_memory` | [ByteSize](./ByteSize.md) | Total amount of memory used for terms across all shards assigned to selected nodes. | +| `version_map_memory_in_bytes` | [long](./long.md) | Total amount, in bytes, of memory used by all version maps across all shards assigned to selected nodes. | +| `version_map_memory` | [ByteSize](./ByteSize.md) | Total amount of memory used by all version maps across all shards assigned to selected nodes. | diff --git a/docs/reference/api/SequenceNumber.md b/docs/reference/api/SequenceNumber.md new file mode 100644 index 000000000..545f2587b --- /dev/null +++ b/docs/reference/api/SequenceNumber.md @@ -0,0 +1,4 @@ +## `SequenceNumber` +::: +type SequenceNumber = [long](./long.md); +::: diff --git a/docs/reference/api/Service.md b/docs/reference/api/Service.md new file mode 100644 index 000000000..ed15e9572 --- /dev/null +++ b/docs/reference/api/Service.md @@ -0,0 +1,4 @@ +## `Service` +::: +type Service = string; +::: diff --git a/docs/reference/api/ShardFailure.md b/docs/reference/api/ShardFailure.md new file mode 100644 index 000000000..100c03c5b --- /dev/null +++ b/docs/reference/api/ShardFailure.md @@ -0,0 +1,9 @@ +## Interface `ShardFailure` + +| Name | Type | Description | +| - | - | - | +| `index` | [IndexName](./IndexName.md) |   | +| `node` | string |   | +| `reason` | [ErrorCause](./ErrorCause.md) |   | +| `shard` | [integer](./integer.md) |   | +| `status` | string |   | diff --git a/docs/reference/api/ShardStatistics.md b/docs/reference/api/ShardStatistics.md new file mode 100644 index 000000000..af7446607 --- /dev/null +++ b/docs/reference/api/ShardStatistics.md @@ -0,0 +1,9 @@ +## Interface `ShardStatistics` + +| Name | Type | Description | +| - | - | - | +| `failed` | [uint](./uint.md) | The number of shards the operation or search attempted to run on but failed. | +| `failures` | [ShardFailure](./ShardFailure.md)[] |   | +| `skipped` | [uint](./uint.md) |   | +| `successful` | [uint](./uint.md) | The number of shards the operation or search succeeded on. | +| `total` | [uint](./uint.md) | The number of shards the operation or search will run on overall. | diff --git a/docs/reference/api/ShardsOperationResponseBase.md b/docs/reference/api/ShardsOperationResponseBase.md new file mode 100644 index 000000000..6ea3648f0 --- /dev/null +++ b/docs/reference/api/ShardsOperationResponseBase.md @@ -0,0 +1,5 @@ +## Interface `ShardsOperationResponseBase` + +| Name | Type | Description | +| - | - | - | +| `_shards` | [ShardStatistics](./ShardStatistics.md) |   | diff --git a/docs/reference/api/Shutdown.md b/docs/reference/api/Shutdown.md new file mode 100644 index 000000000..eab4064c7 --- /dev/null +++ b/docs/reference/api/Shutdown.md @@ -0,0 +1,20 @@ +## `Shutdown` + +### Constructor + +::: +new Shutdown(transport: [Transport](./Transport.md)); +::: + +### Properties + +| Name | Type | Description | +| - | - | - | +| `acceptedParams` | Record |   | +| `transport` | [Transport](./Transport.md) |   | + +### Methods + +| Name | Signature | Description | +| - | - | - | +| `deleteNode` | `deleteNode(this: [That](./That.md), params: [ShutdownDeleteNodeRequest](./ShutdownDeleteNodeRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ShutdownDeleteNodeResponse](./ShutdownDeleteNodeResponse.md)>;` | Cancel node shutdown preparations. Remove a node from the shutdown list so it can resume normal operations. You must explicitly clear the shutdown request when a node rejoins the cluster or when a node has permanently left the cluster. Shutdown requests are never removed automatically by Elasticsearch. NOTE: This feature is designed for indirect use by Elastic Cloud, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported. If the operator privileges feature is enabled, you must be an operator to use this API. || `deleteNode` | `deleteNode(this: [That](./That.md), params: [ShutdownDeleteNodeRequest](./ShutdownDeleteNodeRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ShutdownDeleteNodeResponse](./ShutdownDeleteNodeResponse.md), unknown>>;` |   || `deleteNode` | `deleteNode(this: [That](./That.md), params: [ShutdownDeleteNodeRequest](./ShutdownDeleteNodeRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ShutdownDeleteNodeResponse](./ShutdownDeleteNodeResponse.md)>;` |   || `getNode` | `getNode(this: [That](./That.md), params?: [ShutdownGetNodeRequest](./ShutdownGetNodeRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ShutdownGetNodeResponse](./ShutdownGetNodeResponse.md)>;` | Get the shutdown status. Get information about nodes that are ready to be shut down, have shut down preparations still in progress, or have stalled. The API returns status information for each part of the shut down process. NOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported. If the operator privileges feature is enabled, you must be an operator to use this API. || `getNode` | `getNode(this: [That](./That.md), params?: [ShutdownGetNodeRequest](./ShutdownGetNodeRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ShutdownGetNodeResponse](./ShutdownGetNodeResponse.md), unknown>>;` |   || `getNode` | `getNode(this: [That](./That.md), params?: [ShutdownGetNodeRequest](./ShutdownGetNodeRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ShutdownGetNodeResponse](./ShutdownGetNodeResponse.md)>;` |   || `putNode` | `putNode(this: [That](./That.md), params: [ShutdownPutNodeRequest](./ShutdownPutNodeRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ShutdownPutNodeResponse](./ShutdownPutNodeResponse.md)>;` | Prepare a node to be shut down. NOTE: This feature is designed for indirect use by Elastic Cloud, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported. If you specify a node that is offline, it will be prepared for shut down when it rejoins the cluster. If the operator privileges feature is enabled, you must be an operator to use this API. The API migrates ongoing tasks and index shards to other nodes as needed to prepare a node to be restarted or shut down and removed from the cluster. This ensures that Elasticsearch can be stopped safely with minimal disruption to the cluster. You must specify the type of shutdown: `restart`, `remove`, or `replace`. If a node is already being prepared for shutdown, you can use this API to change the shutdown type. IMPORTANT: This API does NOT terminate the Elasticsearch process. Monitor the node shutdown status to determine when it is safe to stop Elasticsearch. || `putNode` | `putNode(this: [That](./That.md), params: [ShutdownPutNodeRequest](./ShutdownPutNodeRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ShutdownPutNodeResponse](./ShutdownPutNodeResponse.md), unknown>>;` |   || `putNode` | `putNode(this: [That](./That.md), params: [ShutdownPutNodeRequest](./ShutdownPutNodeRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ShutdownPutNodeResponse](./ShutdownPutNodeResponse.md)>;` |   | \ No newline at end of file diff --git a/docs/reference/api/ShutdownDeleteNodeRequest.md b/docs/reference/api/ShutdownDeleteNodeRequest.md new file mode 100644 index 000000000..036c6dec5 --- /dev/null +++ b/docs/reference/api/ShutdownDeleteNodeRequest.md @@ -0,0 +1,9 @@ +## Interface `ShutdownDeleteNodeRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { node_id?: never; master_timeout?: never; timeout?: never; }) | All values in `body` will be added to the request body. | +| `master_timeout` | [TimeUnit](./TimeUnit.md) | Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. | +| `node_id` | [NodeId](./NodeId.md) | The node id of node to be removed from the shutdown state | +| `querystring` | { [key: string]: any; } & { node_id?: never; master_timeout?: never; timeout?: never; } | All values in `querystring` will be added to the request querystring. | +| `timeout` | [TimeUnit](./TimeUnit.md) | Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. | diff --git a/docs/reference/api/ShutdownDeleteNodeResponse.md b/docs/reference/api/ShutdownDeleteNodeResponse.md new file mode 100644 index 000000000..816d2d346 --- /dev/null +++ b/docs/reference/api/ShutdownDeleteNodeResponse.md @@ -0,0 +1,4 @@ +## `ShutdownDeleteNodeResponse` +::: +type ShutdownDeleteNodeResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); +::: diff --git a/docs/reference/api/ShutdownGetNodeNodeShutdownStatus.md b/docs/reference/api/ShutdownGetNodeNodeShutdownStatus.md new file mode 100644 index 000000000..ea20da843 --- /dev/null +++ b/docs/reference/api/ShutdownGetNodeNodeShutdownStatus.md @@ -0,0 +1,12 @@ +## Interface `ShutdownGetNodeNodeShutdownStatus` + +| Name | Type | Description | +| - | - | - | +| `node_id` | [NodeId](./NodeId.md) |   | +| `persistent_tasks` | [ShutdownGetNodePersistentTaskStatus](./ShutdownGetNodePersistentTaskStatus.md) |   | +| `plugins` | [ShutdownGetNodePluginsStatus](./ShutdownGetNodePluginsStatus.md) |   | +| `reason` | string |   | +| `shard_migration` | [ShutdownGetNodeShardMigrationStatus](./ShutdownGetNodeShardMigrationStatus.md) |   | +| `shutdown_startedmillis` | [EpochTime](./EpochTime.md)<[UnitMillis](./UnitMillis.md)> |   | +| `status` | [ShutdownGetNodeShutdownStatus](./ShutdownGetNodeShutdownStatus.md) |   | +| `type` | [ShutdownGetNodeShutdownType](./ShutdownGetNodeShutdownType.md) |   | diff --git a/docs/reference/api/ShutdownGetNodePersistentTaskStatus.md b/docs/reference/api/ShutdownGetNodePersistentTaskStatus.md new file mode 100644 index 000000000..3ca047819 --- /dev/null +++ b/docs/reference/api/ShutdownGetNodePersistentTaskStatus.md @@ -0,0 +1,5 @@ +## Interface `ShutdownGetNodePersistentTaskStatus` + +| Name | Type | Description | +| - | - | - | +| `status` | [ShutdownGetNodeShutdownStatus](./ShutdownGetNodeShutdownStatus.md) |   | diff --git a/docs/reference/api/ShutdownGetNodePluginsStatus.md b/docs/reference/api/ShutdownGetNodePluginsStatus.md new file mode 100644 index 000000000..bbbdfb2c4 --- /dev/null +++ b/docs/reference/api/ShutdownGetNodePluginsStatus.md @@ -0,0 +1,5 @@ +## Interface `ShutdownGetNodePluginsStatus` + +| Name | Type | Description | +| - | - | - | +| `status` | [ShutdownGetNodeShutdownStatus](./ShutdownGetNodeShutdownStatus.md) |   | diff --git a/docs/reference/api/ShutdownGetNodeRequest.md b/docs/reference/api/ShutdownGetNodeRequest.md new file mode 100644 index 000000000..c7ed89c9c --- /dev/null +++ b/docs/reference/api/ShutdownGetNodeRequest.md @@ -0,0 +1,8 @@ +## Interface `ShutdownGetNodeRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { node_id?: never; master_timeout?: never; }) | All values in `body` will be added to the request body. | +| `master_timeout` | [TimeUnit](./TimeUnit.md) | Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. | +| `node_id` | [NodeIds](./NodeIds.md) | Which node for which to retrieve the shutdown status | +| `querystring` | { [key: string]: any; } & { node_id?: never; master_timeout?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/ShutdownGetNodeResponse.md b/docs/reference/api/ShutdownGetNodeResponse.md new file mode 100644 index 000000000..fe8690467 --- /dev/null +++ b/docs/reference/api/ShutdownGetNodeResponse.md @@ -0,0 +1,5 @@ +## Interface `ShutdownGetNodeResponse` + +| Name | Type | Description | +| - | - | - | +| `nodes` | [ShutdownGetNodeNodeShutdownStatus](./ShutdownGetNodeNodeShutdownStatus.md)[] |   | diff --git a/docs/reference/api/ShutdownGetNodeShardMigrationStatus.md b/docs/reference/api/ShutdownGetNodeShardMigrationStatus.md new file mode 100644 index 000000000..855f16306 --- /dev/null +++ b/docs/reference/api/ShutdownGetNodeShardMigrationStatus.md @@ -0,0 +1,5 @@ +## Interface `ShutdownGetNodeShardMigrationStatus` + +| Name | Type | Description | +| - | - | - | +| `status` | [ShutdownGetNodeShutdownStatus](./ShutdownGetNodeShutdownStatus.md) |   | diff --git a/docs/reference/api/ShutdownGetNodeShutdownStatus.md b/docs/reference/api/ShutdownGetNodeShutdownStatus.md new file mode 100644 index 000000000..429b7f494 --- /dev/null +++ b/docs/reference/api/ShutdownGetNodeShutdownStatus.md @@ -0,0 +1,4 @@ +## `ShutdownGetNodeShutdownStatus` +::: +type ShutdownGetNodeShutdownStatus = 'not_started' | 'in_progress' | 'stalled' | 'complete'; +::: diff --git a/docs/reference/api/ShutdownGetNodeShutdownType.md b/docs/reference/api/ShutdownGetNodeShutdownType.md new file mode 100644 index 000000000..b85ed6315 --- /dev/null +++ b/docs/reference/api/ShutdownGetNodeShutdownType.md @@ -0,0 +1,4 @@ +## `ShutdownGetNodeShutdownType` +::: +type ShutdownGetNodeShutdownType = 'remove' | 'restart'; +::: diff --git a/docs/reference/api/ShutdownPutNodeRequest.md b/docs/reference/api/ShutdownPutNodeRequest.md new file mode 100644 index 000000000..8a94f76c5 --- /dev/null +++ b/docs/reference/api/ShutdownPutNodeRequest.md @@ -0,0 +1,13 @@ +## Interface `ShutdownPutNodeRequest` + +| Name | Type | Description | +| - | - | - | +| `allocation_delay` | string | Only valid if type is restart. Controls how long Elasticsearch will wait for the node to restart and join the cluster before reassigning its shards to other nodes. This works the same as delaying allocation with the index.unassigned.node_left.delayed_timeout setting. If you specify both a restart allocation delay and an index-level allocation delay, the longer of the two is used. | +| `body` | string | ({ [key: string]: any; } & { node_id?: never; master_timeout?: never; timeout?: never; type?: never; reason?: never; allocation_delay?: never; target_node_name?: never; }) | All values in `body` will be added to the request body. | +| `master_timeout` | [TimeUnit](./TimeUnit.md) | The period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. | +| `node_id` | [NodeId](./NodeId.md) | The node identifier. This parameter is not validated against the cluster's active nodes. This enables you to register a node for shut down while it is offline. No error is thrown if you specify an invalid node ID. | +| `querystring` | { [key: string]: any; } & { node_id?: never; master_timeout?: never; timeout?: never; type?: never; reason?: never; allocation_delay?: never; target_node_name?: never; } | All values in `querystring` will be added to the request querystring. | +| `reason` | string | A human-readable reason that the node is being shut down. This field provides information for other cluster operators; it does not affect the shut down process. | +| `target_node_name` | string | Only valid if type is replace. Specifies the name of the node that is replacing the node being shut down. Shards from the shut down node are only allowed to be allocated to the target node, and no other data will be allocated to the target node. During relocation of data certain allocation rules are ignored, such as disk watermarks or user attribute filtering rules. | +| `timeout` | [TimeUnit](./TimeUnit.md) | The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. | +| `type` | [ShutdownType](./ShutdownType.md) | Valid values are restart, remove, or replace. Use restart when you need to temporarily shut down a node to perform an upgrade, make configuration changes, or perform other maintenance. Because the node is expected to rejoin the cluster, data is not migrated off of the node. Use remove when you need to permanently remove a node from the cluster. The node is not marked ready for shutdown until data is migrated off of the node Use replace to do a 1:1 replacement of a node with another node. Certain allocation decisions will be ignored (such as disk watermarks) in the interest of true replacement of the source node with the target node. During a replace-type shutdown, rollover and index creation may result in unassigned shards, and shrink may fail until the replacement is complete. | diff --git a/docs/reference/api/ShutdownPutNodeResponse.md b/docs/reference/api/ShutdownPutNodeResponse.md new file mode 100644 index 000000000..f4ddaddda --- /dev/null +++ b/docs/reference/api/ShutdownPutNodeResponse.md @@ -0,0 +1,4 @@ +## `ShutdownPutNodeResponse` +::: +type ShutdownPutNodeResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); +::: diff --git a/docs/reference/api/ShutdownType.md b/docs/reference/api/ShutdownType.md new file mode 100644 index 000000000..e7030bc2f --- /dev/null +++ b/docs/reference/api/ShutdownType.md @@ -0,0 +1,4 @@ +## `ShutdownType` +::: +type ShutdownType = 'restart' | 'remove' | 'replace'; +::: diff --git a/docs/reference/api/Simulate.md b/docs/reference/api/Simulate.md new file mode 100644 index 000000000..f01131ecd --- /dev/null +++ b/docs/reference/api/Simulate.md @@ -0,0 +1,20 @@ +## `Simulate` + +### Constructor + +::: +new Simulate(transport: [Transport](./Transport.md)); +::: + +### Properties + +| Name | Type | Description | +| - | - | - | +| `acceptedParams` | Record |   | +| `transport` | [Transport](./Transport.md) |   | + +### Methods + +| Name | Signature | Description | +| - | - | - | +| `ingest` | `ingest(this: [That](./That.md), params: [SimulateIngestRequest](./SimulateIngestRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SimulateIngestResponse](./SimulateIngestResponse.md)>;` | Simulate data ingestion. Run ingest pipelines against a set of provided documents, optionally with substitute pipeline definitions, to simulate ingesting data into an index. This API is meant to be used for troubleshooting or pipeline development, as it does not actually index any data into Elasticsearch. The API runs the default and final pipeline for that index against a set of documents provided in the body of the request. If a pipeline contains a reroute processor, it follows that reroute processor to the new index, running that index's pipelines as well the same way that a non-simulated ingest would. No data is indexed into Elasticsearch. Instead, the transformed document is returned, along with the list of pipelines that have been run and the name of the index where the document would have been indexed if this were not a simulation. The transformed document is validated against the mappings that would apply to this index, and any validation error is reported in the result. This API differs from the simulate pipeline API in that you specify a single pipeline for that API, and it runs only that one pipeline. The simulate pipeline API is more useful for developing a single pipeline, while the simulate ingest API is more useful for troubleshooting the interaction of the various pipelines that get applied when ingesting into an index. By default, the pipeline definitions that are currently in the system are used. However, you can supply substitute pipeline definitions in the body of the request. These will be used in place of the pipeline definitions that are already in the system. This can be used to replace existing pipeline definitions or to create new ones. The pipeline substitutions are used only within this request. || `ingest` | `ingest(this: [That](./That.md), params: [SimulateIngestRequest](./SimulateIngestRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SimulateIngestResponse](./SimulateIngestResponse.md), unknown>>;` |   || `ingest` | `ingest(this: [That](./That.md), params: [SimulateIngestRequest](./SimulateIngestRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SimulateIngestResponse](./SimulateIngestResponse.md)>;` |   | \ No newline at end of file diff --git a/docs/reference/api/SimulateIngestIngestDocumentSimulation.md b/docs/reference/api/SimulateIngestIngestDocumentSimulation.md new file mode 100644 index 000000000..aeda5fa67 --- /dev/null +++ b/docs/reference/api/SimulateIngestIngestDocumentSimulation.md @@ -0,0 +1,4 @@ +## `SimulateIngestIngestDocumentSimulation` +::: +type SimulateIngestIngestDocumentSimulation = [SimulateIngestIngestDocumentSimulationKeys](./SimulateIngestIngestDocumentSimulationKeys.md) & { [property: string]: string | [Id](./Id.md) | [IndexName](./IndexName.md) | Record | [SpecUtilsStringified](./SpecUtilsStringified.md)<[VersionNumber](./VersionNumber.md)> | string[] | Record[] | [ErrorCause](./ErrorCause.md);}; +::: diff --git a/docs/reference/api/SimulateIngestIngestDocumentSimulationKeys.md b/docs/reference/api/SimulateIngestIngestDocumentSimulationKeys.md new file mode 100644 index 000000000..6e81dab25 --- /dev/null +++ b/docs/reference/api/SimulateIngestIngestDocumentSimulationKeys.md @@ -0,0 +1,11 @@ +## Interface `SimulateIngestIngestDocumentSimulationKeys` + +| Name | Type | Description | +| - | - | - | +| `_id` | [Id](./Id.md) | Identifier for the document. | +| `_index` | [IndexName](./IndexName.md) | Name of the index that the document would be indexed into if this were not a simulation. | +| `_source` | Record | JSON body for the document. | +| `_version` | [SpecUtilsStringified](./SpecUtilsStringified.md)<[VersionNumber](./VersionNumber.md)> |   | +| `error` | [ErrorCause](./ErrorCause.md) | Any error resulting from simulatng ingest on this doc. This can be an error generated by executing a processor, or a mapping validation error when simulating indexing the resulting doc. | +| `executed_pipelines` | string[] | A list of the names of the pipelines executed on this document. | +| `ignored_fields` | Record[] | A list of the fields that would be ignored at the indexing step. For example, a field whose value is larger than the allowed limit would make it through all of the pipelines, but would not be indexed into Elasticsearch. | diff --git a/docs/reference/api/SimulateIngestRequest.md b/docs/reference/api/SimulateIngestRequest.md new file mode 100644 index 000000000..7094dcb60 --- /dev/null +++ b/docs/reference/api/SimulateIngestRequest.md @@ -0,0 +1,13 @@ +## Interface `SimulateIngestRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { index?: never; pipeline?: never; docs?: never; component_template_substitutions?: never; index_template_substitutions?: never; mapping_addition?: never; pipeline_substitutions?: never; }) | All values in `body` will be added to the request body. | +| `component_template_substitutions` | Record | A map of component template names to substitute component template definition objects. | +| `docs` | [IngestDocument](./IngestDocument.md)[] | Sample documents to test in the pipeline. | +| `index_template_substitutions` | Record | A map of index template names to substitute index template definition objects. | +| `index` | [IndexName](./IndexName.md) | The index to simulate ingesting into. This value can be overridden by specifying an index on each document. If you specify this parameter in the request path, it is used for any documents that do not explicitly specify an index argument. | +| `mapping_addition` | [MappingTypeMapping](./MappingTypeMapping.md) |   | +| `pipeline_substitutions` | Record | Pipelines to test. If you don’t specify the `pipeline` request path parameter, this parameter is required. If you specify both this and the request path parameter, the API only uses the request path parameter. | +| `pipeline` | [PipelineName](./PipelineName.md) | The pipeline to use as the default pipeline. This value can be used to override the default pipeline of the index. | +| `querystring` | { [key: string]: any; } & { index?: never; pipeline?: never; docs?: never; component_template_substitutions?: never; index_template_substitutions?: never; mapping_addition?: never; pipeline_substitutions?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/SimulateIngestResponse.md b/docs/reference/api/SimulateIngestResponse.md new file mode 100644 index 000000000..f781cf0d4 --- /dev/null +++ b/docs/reference/api/SimulateIngestResponse.md @@ -0,0 +1,5 @@ +## Interface `SimulateIngestResponse` + +| Name | Type | Description | +| - | - | - | +| `docs` | [SimulateIngestSimulateIngestDocumentResult](./SimulateIngestSimulateIngestDocumentResult.md)[] |   | diff --git a/docs/reference/api/SimulateIngestSimulateIngestDocumentResult.md b/docs/reference/api/SimulateIngestSimulateIngestDocumentResult.md new file mode 100644 index 000000000..240d568ea --- /dev/null +++ b/docs/reference/api/SimulateIngestSimulateIngestDocumentResult.md @@ -0,0 +1,5 @@ +## Interface `SimulateIngestSimulateIngestDocumentResult` + +| Name | Type | Description | +| - | - | - | +| `doc` | [SimulateIngestIngestDocumentSimulation](./SimulateIngestIngestDocumentSimulation.md) |   | diff --git a/docs/reference/api/SlicedScroll.md b/docs/reference/api/SlicedScroll.md new file mode 100644 index 000000000..8a708f27a --- /dev/null +++ b/docs/reference/api/SlicedScroll.md @@ -0,0 +1,7 @@ +## Interface `SlicedScroll` + +| Name | Type | Description | +| - | - | - | +| `field` | [Field](./Field.md) |   | +| `id` | [Id](./Id.md) |   | +| `max` | [integer](./integer.md) |   | diff --git a/docs/reference/api/Slices.md b/docs/reference/api/Slices.md new file mode 100644 index 000000000..53b8bac43 --- /dev/null +++ b/docs/reference/api/Slices.md @@ -0,0 +1,4 @@ +## `Slices` +::: +type Slices = [integer](./integer.md) | [SlicesCalculation](./SlicesCalculation.md); +::: diff --git a/docs/reference/api/SlicesCalculation.md b/docs/reference/api/SlicesCalculation.md new file mode 100644 index 000000000..61b17837c --- /dev/null +++ b/docs/reference/api/SlicesCalculation.md @@ -0,0 +1,4 @@ +## `SlicesCalculation` +::: +type SlicesCalculation = 'auto'; +::: diff --git a/docs/reference/api/Slm.md b/docs/reference/api/Slm.md new file mode 100644 index 000000000..42a6c32fe --- /dev/null +++ b/docs/reference/api/Slm.md @@ -0,0 +1,20 @@ +## `Slm` + +### Constructor + +::: +new Slm(transport: [Transport](./Transport.md)); +::: + +### Properties + +| Name | Type | Description | +| - | - | - | +| `acceptedParams` | Record |   | +| `transport` | [Transport](./Transport.md) |   | + +### Methods + +| Name | Signature | Description | +| - | - | - | +| `deleteLifecycle` | `deleteLifecycle(this: [That](./That.md), params: [SlmDeleteLifecycleRequest](./SlmDeleteLifecycleRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SlmDeleteLifecycleResponse](./SlmDeleteLifecycleResponse.md)>;` | Delete a policy. Delete a snapshot lifecycle policy definition. This operation prevents any future snapshots from being taken but does not cancel in-progress snapshots or remove previously-taken snapshots. || `deleteLifecycle` | `deleteLifecycle(this: [That](./That.md), params: [SlmDeleteLifecycleRequest](./SlmDeleteLifecycleRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SlmDeleteLifecycleResponse](./SlmDeleteLifecycleResponse.md), unknown>>;` |   || `deleteLifecycle` | `deleteLifecycle(this: [That](./That.md), params: [SlmDeleteLifecycleRequest](./SlmDeleteLifecycleRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SlmDeleteLifecycleResponse](./SlmDeleteLifecycleResponse.md)>;` |   || `executeLifecycle` | `executeLifecycle(this: [That](./That.md), params: [SlmExecuteLifecycleRequest](./SlmExecuteLifecycleRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SlmExecuteLifecycleResponse](./SlmExecuteLifecycleResponse.md)>;` | Run a policy. Immediately create a snapshot according to the snapshot lifecycle policy without waiting for the scheduled time. The snapshot policy is normally applied according to its schedule, but you might want to manually run a policy before performing an upgrade or other maintenance. || `executeLifecycle` | `executeLifecycle(this: [That](./That.md), params: [SlmExecuteLifecycleRequest](./SlmExecuteLifecycleRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SlmExecuteLifecycleResponse](./SlmExecuteLifecycleResponse.md), unknown>>;` |   || `executeLifecycle` | `executeLifecycle(this: [That](./That.md), params: [SlmExecuteLifecycleRequest](./SlmExecuteLifecycleRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SlmExecuteLifecycleResponse](./SlmExecuteLifecycleResponse.md)>;` |   || `executeRetention` | `executeRetention(this: [That](./That.md), params?: [SlmExecuteRetentionRequest](./SlmExecuteRetentionRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SlmExecuteRetentionResponse](./SlmExecuteRetentionResponse.md)>;` | Run a retention policy. Manually apply the retention policy to force immediate removal of snapshots that are expired according to the snapshot lifecycle policy retention rules. The retention policy is normally applied according to its schedule. || `executeRetention` | `executeRetention(this: [That](./That.md), params?: [SlmExecuteRetentionRequest](./SlmExecuteRetentionRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SlmExecuteRetentionResponse](./SlmExecuteRetentionResponse.md), unknown>>;` |   || `executeRetention` | `executeRetention(this: [That](./That.md), params?: [SlmExecuteRetentionRequest](./SlmExecuteRetentionRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SlmExecuteRetentionResponse](./SlmExecuteRetentionResponse.md)>;` |   || `getLifecycle` | `getLifecycle(this: [That](./That.md), params?: [SlmGetLifecycleRequest](./SlmGetLifecycleRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SlmGetLifecycleResponse](./SlmGetLifecycleResponse.md)>;` | Get policy information. Get snapshot lifecycle policy definitions and information about the latest snapshot attempts. || `getLifecycle` | `getLifecycle(this: [That](./That.md), params?: [SlmGetLifecycleRequest](./SlmGetLifecycleRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SlmGetLifecycleResponse](./SlmGetLifecycleResponse.md), unknown>>;` |   || `getLifecycle` | `getLifecycle(this: [That](./That.md), params?: [SlmGetLifecycleRequest](./SlmGetLifecycleRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SlmGetLifecycleResponse](./SlmGetLifecycleResponse.md)>;` |   || `getStats` | `getStats(this: [That](./That.md), params?: [SlmGetStatsRequest](./SlmGetStatsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SlmGetStatsResponse](./SlmGetStatsResponse.md)>;` | Get snapshot lifecycle management statistics. Get global and policy-level statistics about actions taken by snapshot lifecycle management. || `getStats` | `getStats(this: [That](./That.md), params?: [SlmGetStatsRequest](./SlmGetStatsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SlmGetStatsResponse](./SlmGetStatsResponse.md), unknown>>;` |   || `getStats` | `getStats(this: [That](./That.md), params?: [SlmGetStatsRequest](./SlmGetStatsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SlmGetStatsResponse](./SlmGetStatsResponse.md)>;` |   || `getStatus` | `getStatus(this: [That](./That.md), params?: [SlmGetStatusRequest](./SlmGetStatusRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SlmGetStatusResponse](./SlmGetStatusResponse.md)>;` | Get the snapshot lifecycle management status. || `getStatus` | `getStatus(this: [That](./That.md), params?: [SlmGetStatusRequest](./SlmGetStatusRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SlmGetStatusResponse](./SlmGetStatusResponse.md), unknown>>;` |   || `getStatus` | `getStatus(this: [That](./That.md), params?: [SlmGetStatusRequest](./SlmGetStatusRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SlmGetStatusResponse](./SlmGetStatusResponse.md)>;` |   || `putLifecycle` | `putLifecycle(this: [That](./That.md), params: [SlmPutLifecycleRequest](./SlmPutLifecycleRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SlmPutLifecycleResponse](./SlmPutLifecycleResponse.md)>;` | Create or update a policy. Create or update a snapshot lifecycle policy. If the policy already exists, this request increments the policy version. Only the latest version of a policy is stored. || `putLifecycle` | `putLifecycle(this: [That](./That.md), params: [SlmPutLifecycleRequest](./SlmPutLifecycleRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SlmPutLifecycleResponse](./SlmPutLifecycleResponse.md), unknown>>;` |   || `putLifecycle` | `putLifecycle(this: [That](./That.md), params: [SlmPutLifecycleRequest](./SlmPutLifecycleRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SlmPutLifecycleResponse](./SlmPutLifecycleResponse.md)>;` |   || `start` | `start(this: [That](./That.md), params?: [SlmStartRequest](./SlmStartRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SlmStartResponse](./SlmStartResponse.md)>;` | Start snapshot lifecycle management. Snapshot lifecycle management (SLM) starts automatically when a cluster is formed. Manually starting SLM is necessary only if it has been stopped using the stop SLM API. || `start` | `start(this: [That](./That.md), params?: [SlmStartRequest](./SlmStartRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SlmStartResponse](./SlmStartResponse.md), unknown>>;` |   || `start` | `start(this: [That](./That.md), params?: [SlmStartRequest](./SlmStartRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SlmStartResponse](./SlmStartResponse.md)>;` |   || `stop` | `stop(this: [That](./That.md), params?: [SlmStopRequest](./SlmStopRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SlmStopResponse](./SlmStopResponse.md)>;` | Stop snapshot lifecycle management. Stop all snapshot lifecycle management (SLM) operations and the SLM plugin. This API is useful when you are performing maintenance on a cluster and need to prevent SLM from performing any actions on your data streams or indices. Stopping SLM does not stop any snapshots that are in progress. You can manually trigger snapshots with the run snapshot lifecycle policy API even if SLM is stopped. The API returns a response as soon as the request is acknowledged, but the plugin might continue to run until in-progress operations complete and it can be safely stopped. Use the get snapshot lifecycle management status API to see if SLM is running. || `stop` | `stop(this: [That](./That.md), params?: [SlmStopRequest](./SlmStopRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SlmStopResponse](./SlmStopResponse.md), unknown>>;` |   || `stop` | `stop(this: [That](./That.md), params?: [SlmStopRequest](./SlmStopRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SlmStopResponse](./SlmStopResponse.md)>;` |   | \ No newline at end of file diff --git a/docs/reference/api/SlmConfiguration.md b/docs/reference/api/SlmConfiguration.md new file mode 100644 index 000000000..1d49ac894 --- /dev/null +++ b/docs/reference/api/SlmConfiguration.md @@ -0,0 +1,10 @@ +## Interface `SlmConfiguration` + +| Name | Type | Description | +| - | - | - | +| `feature_states` | string[] | A list of feature states to be included in this snapshot. A list of features available for inclusion in the snapshot and their descriptions be can be retrieved using the get features API. Each feature state includes one or more system indices containing data necessary for the function of that feature. Providing an empty array will include no feature states in the snapshot, regardless of the value of include_global_state. By default, all available feature states will be included in the snapshot if include_global_state is true, or no feature states if include_global_state is false. | +| `ignore_unavailable` | boolean | If false, the snapshot fails if any data stream or index in indices is missing or closed. If true, the snapshot ignores missing or closed data streams and indices. | +| `include_global_state` | boolean | If true, the current global state is included in the snapshot. | +| `indices` | [Indices](./Indices.md) | A comma-separated list of data streams and indices to include in the snapshot. Multi-index syntax is supported. By default, a snapshot includes all data streams and indices in the cluster. If this argument is provided, the snapshot only includes the specified data streams and clusters. | +| `metadata` | [Metadata](./Metadata.md) | Attaches arbitrary metadata to the snapshot, such as a record of who took the snapshot, why it was taken, or any other useful data. Metadata must be less than 1024 bytes. | +| `partial` | boolean | If false, the entire snapshot will fail if one or more indices included in the snapshot do not have all primary shards available. | diff --git a/docs/reference/api/SlmDeleteLifecycleRequest.md b/docs/reference/api/SlmDeleteLifecycleRequest.md new file mode 100644 index 000000000..ddd8d9ee2 --- /dev/null +++ b/docs/reference/api/SlmDeleteLifecycleRequest.md @@ -0,0 +1,9 @@ +## Interface `SlmDeleteLifecycleRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { policy_id?: never; master_timeout?: never; timeout?: never; }) | All values in `body` will be added to the request body. | +| `master_timeout` | [Duration](./Duration.md) | The period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. | +| `policy_id` | [Name](./Name.md) | The id of the snapshot lifecycle policy to remove | +| `querystring` | { [key: string]: any; } & { policy_id?: never; master_timeout?: never; timeout?: never; } | All values in `querystring` will be added to the request querystring. | +| `timeout` | [Duration](./Duration.md) | The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. | diff --git a/docs/reference/api/SlmDeleteLifecycleResponse.md b/docs/reference/api/SlmDeleteLifecycleResponse.md new file mode 100644 index 000000000..9297b1bfb --- /dev/null +++ b/docs/reference/api/SlmDeleteLifecycleResponse.md @@ -0,0 +1,4 @@ +## `SlmDeleteLifecycleResponse` +::: +type SlmDeleteLifecycleResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); +::: diff --git a/docs/reference/api/SlmExecuteLifecycleRequest.md b/docs/reference/api/SlmExecuteLifecycleRequest.md new file mode 100644 index 000000000..848285c20 --- /dev/null +++ b/docs/reference/api/SlmExecuteLifecycleRequest.md @@ -0,0 +1,9 @@ +## Interface `SlmExecuteLifecycleRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { policy_id?: never; master_timeout?: never; timeout?: never; }) | All values in `body` will be added to the request body. | +| `master_timeout` | [Duration](./Duration.md) | The period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. | +| `policy_id` | [Name](./Name.md) | The id of the snapshot lifecycle policy to be executed | +| `querystring` | { [key: string]: any; } & { policy_id?: never; master_timeout?: never; timeout?: never; } | All values in `querystring` will be added to the request querystring. | +| `timeout` | [Duration](./Duration.md) | The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. | diff --git a/docs/reference/api/SlmExecuteLifecycleResponse.md b/docs/reference/api/SlmExecuteLifecycleResponse.md new file mode 100644 index 000000000..6bee818a5 --- /dev/null +++ b/docs/reference/api/SlmExecuteLifecycleResponse.md @@ -0,0 +1,5 @@ +## Interface `SlmExecuteLifecycleResponse` + +| Name | Type | Description | +| - | - | - | +| `snapshot_name` | [Name](./Name.md) |   | diff --git a/docs/reference/api/SlmExecuteRetentionRequest.md b/docs/reference/api/SlmExecuteRetentionRequest.md new file mode 100644 index 000000000..dc248f2e7 --- /dev/null +++ b/docs/reference/api/SlmExecuteRetentionRequest.md @@ -0,0 +1,8 @@ +## Interface `SlmExecuteRetentionRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { master_timeout?: never; timeout?: never; }) | All values in `body` will be added to the request body. | +| `master_timeout` | [Duration](./Duration.md) | The period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. | +| `querystring` | { [key: string]: any; } & { master_timeout?: never; timeout?: never; } | All values in `querystring` will be added to the request querystring. | +| `timeout` | [Duration](./Duration.md) | The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. | diff --git a/docs/reference/api/SlmExecuteRetentionResponse.md b/docs/reference/api/SlmExecuteRetentionResponse.md new file mode 100644 index 000000000..a27ddd358 --- /dev/null +++ b/docs/reference/api/SlmExecuteRetentionResponse.md @@ -0,0 +1,4 @@ +## `SlmExecuteRetentionResponse` +::: +type SlmExecuteRetentionResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); +::: diff --git a/docs/reference/api/SlmGetLifecycleRequest.md b/docs/reference/api/SlmGetLifecycleRequest.md new file mode 100644 index 000000000..7daf8b0ac --- /dev/null +++ b/docs/reference/api/SlmGetLifecycleRequest.md @@ -0,0 +1,9 @@ +## Interface `SlmGetLifecycleRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { policy_id?: never; master_timeout?: never; timeout?: never; }) | All values in `body` will be added to the request body. | +| `master_timeout` | [Duration](./Duration.md) | The period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. | +| `policy_id` | [Names](./Names.md) | Comma-separated list of snapshot lifecycle policies to retrieve | +| `querystring` | { [key: string]: any; } & { policy_id?: never; master_timeout?: never; timeout?: never; } | All values in `querystring` will be added to the request querystring. | +| `timeout` | [Duration](./Duration.md) | The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. | diff --git a/docs/reference/api/SlmGetLifecycleResponse.md b/docs/reference/api/SlmGetLifecycleResponse.md new file mode 100644 index 000000000..24f61b6e5 --- /dev/null +++ b/docs/reference/api/SlmGetLifecycleResponse.md @@ -0,0 +1,4 @@ +## `SlmGetLifecycleResponse` +::: +type SlmGetLifecycleResponse = Record<[Id](./Id.md), [SlmSnapshotLifecycle](./SlmSnapshotLifecycle.md)>; +::: diff --git a/docs/reference/api/SlmGetStatsRequest.md b/docs/reference/api/SlmGetStatsRequest.md new file mode 100644 index 000000000..be0cc892f --- /dev/null +++ b/docs/reference/api/SlmGetStatsRequest.md @@ -0,0 +1,8 @@ +## Interface `SlmGetStatsRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { master_timeout?: never; timeout?: never; }) | All values in `body` will be added to the request body. | +| `master_timeout` | [Duration](./Duration.md) | Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. | +| `querystring` | { [key: string]: any; } & { master_timeout?: never; timeout?: never; } | All values in `querystring` will be added to the request querystring. | +| `timeout` | [Duration](./Duration.md) | Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. | diff --git a/docs/reference/api/SlmGetStatsResponse.md b/docs/reference/api/SlmGetStatsResponse.md new file mode 100644 index 000000000..77e475e4e --- /dev/null +++ b/docs/reference/api/SlmGetStatsResponse.md @@ -0,0 +1,14 @@ +## Interface `SlmGetStatsResponse` + +| Name | Type | Description | +| - | - | - | +| `policy_stats` | string[] |   | +| `retention_deletion_time_millis` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> |   | +| `retention_deletion_time` | [Duration](./Duration.md) |   | +| `retention_failed` | [long](./long.md) |   | +| `retention_runs` | [long](./long.md) |   | +| `retention_timed_out` | [long](./long.md) |   | +| `total_snapshot_deletion_failures` | [long](./long.md) |   | +| `total_snapshots_deleted` | [long](./long.md) |   | +| `total_snapshots_failed` | [long](./long.md) |   | +| `total_snapshots_taken` | [long](./long.md) |   | diff --git a/docs/reference/api/SlmGetStatusRequest.md b/docs/reference/api/SlmGetStatusRequest.md new file mode 100644 index 000000000..e1e702b33 --- /dev/null +++ b/docs/reference/api/SlmGetStatusRequest.md @@ -0,0 +1,8 @@ +## Interface `SlmGetStatusRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { master_timeout?: never; timeout?: never; }) | All values in `body` will be added to the request body. | +| `master_timeout` | [Duration](./Duration.md) | The period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. To indicate that the request should never timeout, set it to `-1`. | +| `querystring` | { [key: string]: any; } & { master_timeout?: never; timeout?: never; } | All values in `querystring` will be added to the request querystring. | +| `timeout` | [Duration](./Duration.md) | The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. To indicate that the request should never timeout, set it to `-1`. | diff --git a/docs/reference/api/SlmGetStatusResponse.md b/docs/reference/api/SlmGetStatusResponse.md new file mode 100644 index 000000000..c9d2c58b1 --- /dev/null +++ b/docs/reference/api/SlmGetStatusResponse.md @@ -0,0 +1,5 @@ +## Interface `SlmGetStatusResponse` + +| Name | Type | Description | +| - | - | - | +| `operation_mode` | [LifecycleOperationMode](./LifecycleOperationMode.md) |   | diff --git a/docs/reference/api/SlmInProgress.md b/docs/reference/api/SlmInProgress.md new file mode 100644 index 000000000..4218d6e75 --- /dev/null +++ b/docs/reference/api/SlmInProgress.md @@ -0,0 +1,8 @@ +## Interface `SlmInProgress` + +| Name | Type | Description | +| - | - | - | +| `name` | [Name](./Name.md) |   | +| `start_time_millis` | [EpochTime](./EpochTime.md)<[UnitMillis](./UnitMillis.md)> |   | +| `state` | string |   | +| `uuid` | [Uuid](./Uuid.md) |   | diff --git a/docs/reference/api/SlmInvocation.md b/docs/reference/api/SlmInvocation.md new file mode 100644 index 000000000..24d1df714 --- /dev/null +++ b/docs/reference/api/SlmInvocation.md @@ -0,0 +1,6 @@ +## Interface `SlmInvocation` + +| Name | Type | Description | +| - | - | - | +| `snapshot_name` | [Name](./Name.md) |   | +| `time` | [DateTime](./DateTime.md) |   | diff --git a/docs/reference/api/SlmPolicy.md b/docs/reference/api/SlmPolicy.md new file mode 100644 index 000000000..b65feb0a6 --- /dev/null +++ b/docs/reference/api/SlmPolicy.md @@ -0,0 +1,9 @@ +## Interface `SlmPolicy` + +| Name | Type | Description | +| - | - | - | +| `config` | [SlmConfiguration](./SlmConfiguration.md) |   | +| `name` | [Name](./Name.md) |   | +| `repository` | string |   | +| `retention` | [SlmRetention](./SlmRetention.md) |   | +| `schedule` | [WatcherCronExpression](./WatcherCronExpression.md) |   | diff --git a/docs/reference/api/SlmPutLifecycleRequest.md b/docs/reference/api/SlmPutLifecycleRequest.md new file mode 100644 index 000000000..856402f4e --- /dev/null +++ b/docs/reference/api/SlmPutLifecycleRequest.md @@ -0,0 +1,14 @@ +## Interface `SlmPutLifecycleRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { policy_id?: never; master_timeout?: never; timeout?: never; config?: never; name?: never; repository?: never; retention?: never; schedule?: never; }) | All values in `body` will be added to the request body. | +| `config` | [SlmConfiguration](./SlmConfiguration.md) | Configuration for each snapshot created by the policy. | +| `master_timeout` | [Duration](./Duration.md) | The period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. To indicate that the request should never timeout, set it to `-1`. | +| `name` | [Name](./Name.md) | Name automatically assigned to each snapshot created by the policy. Date math is supported. To prevent conflicting snapshot names, a UUID is automatically appended to each snapshot name. | +| `policy_id` | [Name](./Name.md) | The identifier for the snapshot lifecycle policy you want to create or update. | +| `querystring` | { [key: string]: any; } & { policy_id?: never; master_timeout?: never; timeout?: never; config?: never; name?: never; repository?: never; retention?: never; schedule?: never; } | All values in `querystring` will be added to the request querystring. | +| `repository` | string | Repository used to store snapshots created by this policy. This repository must exist prior to the policy’s creation. You can create a repository using the snapshot repository API. | +| `retention` | [SlmRetention](./SlmRetention.md) | Retention rules used to retain and delete snapshots created by the policy. | +| `schedule` | [WatcherCronExpression](./WatcherCronExpression.md) | Periodic or absolute schedule at which the policy creates snapshots. SLM applies schedule changes immediately. | +| `timeout` | [Duration](./Duration.md) | The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. To indicate that the request should never timeout, set it to `-1`. | diff --git a/docs/reference/api/SlmPutLifecycleResponse.md b/docs/reference/api/SlmPutLifecycleResponse.md new file mode 100644 index 000000000..fd840bb86 --- /dev/null +++ b/docs/reference/api/SlmPutLifecycleResponse.md @@ -0,0 +1,4 @@ +## `SlmPutLifecycleResponse` +::: +type SlmPutLifecycleResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); +::: diff --git a/docs/reference/api/SlmRetention.md b/docs/reference/api/SlmRetention.md new file mode 100644 index 000000000..193c426a1 --- /dev/null +++ b/docs/reference/api/SlmRetention.md @@ -0,0 +1,7 @@ +## Interface `SlmRetention` + +| Name | Type | Description | +| - | - | - | +| `expire_after` | [Duration](./Duration.md) | Time period after which a snapshot is considered expired and eligible for deletion. SLM deletes expired snapshots based on the slm.retention_schedule. | +| `max_count` | [integer](./integer.md) | Maximum number of snapshots to retain, even if the snapshots have not yet expired. If the number of snapshots in the repository exceeds this limit, the policy retains the most recent snapshots and deletes older snapshots. | +| `min_count` | [integer](./integer.md) | Minimum number of snapshots to retain, even if the snapshots have expired. | diff --git a/docs/reference/api/SlmSnapshotLifecycle.md b/docs/reference/api/SlmSnapshotLifecycle.md new file mode 100644 index 000000000..7c20a4be4 --- /dev/null +++ b/docs/reference/api/SlmSnapshotLifecycle.md @@ -0,0 +1,14 @@ +## Interface `SlmSnapshotLifecycle` + +| Name | Type | Description | +| - | - | - | +| `in_progress` | [SlmInProgress](./SlmInProgress.md) |   | +| `last_failure` | [SlmInvocation](./SlmInvocation.md) |   | +| `last_success` | [SlmInvocation](./SlmInvocation.md) |   | +| `modified_date_millis` | [EpochTime](./EpochTime.md)<[UnitMillis](./UnitMillis.md)> |   | +| `modified_date` | [DateTime](./DateTime.md) | The last time the policy was modified. | +| `next_execution_millis` | [EpochTime](./EpochTime.md)<[UnitMillis](./UnitMillis.md)> |   | +| `next_execution` | [DateTime](./DateTime.md) | The next time the policy will run. | +| `policy` | [SlmPolicy](./SlmPolicy.md) |   | +| `stats` | [SlmStatistics](./SlmStatistics.md) |   | +| `version` | [VersionNumber](./VersionNumber.md) | The version of the snapshot policy. Only the latest version is stored and incremented when the policy is updated. | diff --git a/docs/reference/api/SlmStartRequest.md b/docs/reference/api/SlmStartRequest.md new file mode 100644 index 000000000..fe03e47c0 --- /dev/null +++ b/docs/reference/api/SlmStartRequest.md @@ -0,0 +1,8 @@ +## Interface `SlmStartRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { master_timeout?: never; timeout?: never; }) | All values in `body` will be added to the request body. | +| `master_timeout` | [Duration](./Duration.md) | The period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. To indicate that the request should never timeout, set it to `-1`. | +| `querystring` | { [key: string]: any; } & { master_timeout?: never; timeout?: never; } | All values in `querystring` will be added to the request querystring. | +| `timeout` | [Duration](./Duration.md) | The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. To indicate that the request should never timeout, set it to `-1`. | diff --git a/docs/reference/api/SlmStartResponse.md b/docs/reference/api/SlmStartResponse.md new file mode 100644 index 000000000..6c40e7d3c --- /dev/null +++ b/docs/reference/api/SlmStartResponse.md @@ -0,0 +1,4 @@ +## `SlmStartResponse` +::: +type SlmStartResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); +::: diff --git a/docs/reference/api/SlmStatistics.md b/docs/reference/api/SlmStatistics.md new file mode 100644 index 000000000..7c02ca5d9 --- /dev/null +++ b/docs/reference/api/SlmStatistics.md @@ -0,0 +1,18 @@ +## Interface `SlmStatistics` + +| Name | Type | Description | +| - | - | - | +| `policy` | [Id](./Id.md) |   | +| `retention_deletion_time_millis` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> |   | +| `retention_deletion_time` | [Duration](./Duration.md) |   | +| `retention_failed` | [long](./long.md) |   | +| `retention_runs` | [long](./long.md) |   | +| `retention_timed_out` | [long](./long.md) |   | +| `snapshot_deletion_failures` | [long](./long.md) | total_snapshot_deletion_failures | +| `snapshots_deleted` | [long](./long.md) | total_snapshots_deleted | +| `snapshots_failed` | [long](./long.md) | total_snapshots_failed | +| `snapshots_taken` | [long](./long.md) | total_snapshots_taken | +| `total_snapshot_deletion_failures` | [long](./long.md) |   | +| `total_snapshots_deleted` | [long](./long.md) |   | +| `total_snapshots_failed` | [long](./long.md) |   | +| `total_snapshots_taken` | [long](./long.md) |   | diff --git a/docs/reference/api/SlmStopRequest.md b/docs/reference/api/SlmStopRequest.md new file mode 100644 index 000000000..2d111c5d3 --- /dev/null +++ b/docs/reference/api/SlmStopRequest.md @@ -0,0 +1,8 @@ +## Interface `SlmStopRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { master_timeout?: never; timeout?: never; }) | All values in `body` will be added to the request body. | +| `master_timeout` | [Duration](./Duration.md) | The period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. To indicate that the request should never timeout, set it to `-1`. | +| `querystring` | { [key: string]: any; } & { master_timeout?: never; timeout?: never; } | All values in `querystring` will be added to the request querystring. | +| `timeout` | [Duration](./Duration.md) | The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. To indicate that the request should never timeout, set it to `-1`. | diff --git a/docs/reference/api/SlmStopResponse.md b/docs/reference/api/SlmStopResponse.md new file mode 100644 index 000000000..86dda46b5 --- /dev/null +++ b/docs/reference/api/SlmStopResponse.md @@ -0,0 +1,4 @@ +## `SlmStopResponse` +::: +type SlmStopResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); +::: diff --git a/docs/reference/api/Snapshot.md b/docs/reference/api/Snapshot.md new file mode 100644 index 000000000..b2b9ce74e --- /dev/null +++ b/docs/reference/api/Snapshot.md @@ -0,0 +1,20 @@ +## `Snapshot` + +### Constructor + +::: +new Snapshot(transport: [Transport](./Transport.md)); +::: + +### Properties + +| Name | Type | Description | +| - | - | - | +| `acceptedParams` | Record |   | +| `transport` | [Transport](./Transport.md) |   | + +### Methods + +| Name | Signature | Description | +| - | - | - | +| `cleanupRepository` | `cleanupRepository(this: [That](./That.md), params: [SnapshotCleanupRepositoryRequest](./SnapshotCleanupRepositoryRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SnapshotCleanupRepositoryResponse](./SnapshotCleanupRepositoryResponse.md)>;` | Clean up the snapshot repository. Trigger the review of the contents of a snapshot repository and delete any stale data not referenced by existing snapshots. || `cleanupRepository` | `cleanupRepository(this: [That](./That.md), params: [SnapshotCleanupRepositoryRequest](./SnapshotCleanupRepositoryRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SnapshotCleanupRepositoryResponse](./SnapshotCleanupRepositoryResponse.md), unknown>>;` |   || `cleanupRepository` | `cleanupRepository(this: [That](./That.md), params: [SnapshotCleanupRepositoryRequest](./SnapshotCleanupRepositoryRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SnapshotCleanupRepositoryResponse](./SnapshotCleanupRepositoryResponse.md)>;` |   || `clone` | `clone(this: [That](./That.md), params: [SnapshotCloneRequest](./SnapshotCloneRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SnapshotCloneResponse](./SnapshotCloneResponse.md)>;` | Clone a snapshot. Clone part of all of a snapshot into another snapshot in the same repository. || `clone` | `clone(this: [That](./That.md), params: [SnapshotCloneRequest](./SnapshotCloneRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SnapshotCloneResponse](./SnapshotCloneResponse.md), unknown>>;` |   || `clone` | `clone(this: [That](./That.md), params: [SnapshotCloneRequest](./SnapshotCloneRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SnapshotCloneResponse](./SnapshotCloneResponse.md)>;` |   || `create` | `create(this: [That](./That.md), params: [SnapshotCreateRequest](./SnapshotCreateRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SnapshotCreateResponse](./SnapshotCreateResponse.md)>;` | Create a snapshot. Take a snapshot of a cluster or of data streams and indices. || `create` | `create(this: [That](./That.md), params: [SnapshotCreateRequest](./SnapshotCreateRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SnapshotCreateResponse](./SnapshotCreateResponse.md), unknown>>;` |   || `create` | `create(this: [That](./That.md), params: [SnapshotCreateRequest](./SnapshotCreateRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SnapshotCreateResponse](./SnapshotCreateResponse.md)>;` |   || `createRepository` | `createRepository(this: [That](./That.md), params: [SnapshotCreateRepositoryRequest](./SnapshotCreateRepositoryRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SnapshotCreateRepositoryResponse](./SnapshotCreateRepositoryResponse.md)>;` | Create or update a snapshot repository. IMPORTANT: If you are migrating searchable snapshots, the repository name must be identical in the source and destination clusters. To register a snapshot repository, the cluster's global metadata must be writeable. Ensure there are no cluster blocks (for example, `cluster.blocks.read_only` and `clsuter.blocks.read_only_allow_delete` settings) that prevent write access. Several options for this API can be specified using a query parameter or a request body parameter. If both parameters are specified, only the query parameter is used. || `createRepository` | `createRepository(this: [That](./That.md), params: [SnapshotCreateRepositoryRequest](./SnapshotCreateRepositoryRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SnapshotCreateRepositoryResponse](./SnapshotCreateRepositoryResponse.md), unknown>>;` |   || `createRepository` | `createRepository(this: [That](./That.md), params: [SnapshotCreateRepositoryRequest](./SnapshotCreateRepositoryRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SnapshotCreateRepositoryResponse](./SnapshotCreateRepositoryResponse.md)>;` |   || `delete` | `delete(this: [That](./That.md), params: [SnapshotDeleteRequest](./SnapshotDeleteRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SnapshotDeleteResponse](./SnapshotDeleteResponse.md)>;` | Delete snapshots. || `delete` | `delete(this: [That](./That.md), params: [SnapshotDeleteRequest](./SnapshotDeleteRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SnapshotDeleteResponse](./SnapshotDeleteResponse.md), unknown>>;` |   || `delete` | `delete(this: [That](./That.md), params: [SnapshotDeleteRequest](./SnapshotDeleteRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SnapshotDeleteResponse](./SnapshotDeleteResponse.md)>;` |   || `deleteRepository` | `deleteRepository(this: [That](./That.md), params: [SnapshotDeleteRepositoryRequest](./SnapshotDeleteRepositoryRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SnapshotDeleteRepositoryResponse](./SnapshotDeleteRepositoryResponse.md)>;` | Delete snapshot repositories. When a repository is unregistered, Elasticsearch removes only the reference to the location where the repository is storing the snapshots. The snapshots themselves are left untouched and in place. || `deleteRepository` | `deleteRepository(this: [That](./That.md), params: [SnapshotDeleteRepositoryRequest](./SnapshotDeleteRepositoryRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SnapshotDeleteRepositoryResponse](./SnapshotDeleteRepositoryResponse.md), unknown>>;` |   || `deleteRepository` | `deleteRepository(this: [That](./That.md), params: [SnapshotDeleteRepositoryRequest](./SnapshotDeleteRepositoryRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SnapshotDeleteRepositoryResponse](./SnapshotDeleteRepositoryResponse.md)>;` |   || `get` | `get(this: [That](./That.md), params: [SnapshotGetRequest](./SnapshotGetRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SnapshotGetResponse](./SnapshotGetResponse.md)>;` | Get snapshot information. NOTE: The `after` parameter and `next` field enable you to iterate through snapshots with some consistency guarantees regarding concurrent creation or deletion of snapshots. It is guaranteed that any snapshot that exists at the beginning of the iteration and is not concurrently deleted will be seen during the iteration. Snapshots concurrently created may be seen during an iteration. || `get` | `get(this: [That](./That.md), params: [SnapshotGetRequest](./SnapshotGetRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SnapshotGetResponse](./SnapshotGetResponse.md), unknown>>;` |   || `get` | `get(this: [That](./That.md), params: [SnapshotGetRequest](./SnapshotGetRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SnapshotGetResponse](./SnapshotGetResponse.md)>;` |   || `getRepository` | `getRepository(this: [That](./That.md), params?: [SnapshotGetRepositoryRequest](./SnapshotGetRepositoryRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SnapshotGetRepositoryResponse](./SnapshotGetRepositoryResponse.md)>;` | Get snapshot repository information. || `getRepository` | `getRepository(this: [That](./That.md), params?: [SnapshotGetRepositoryRequest](./SnapshotGetRepositoryRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SnapshotGetRepositoryResponse](./SnapshotGetRepositoryResponse.md), unknown>>;` |   || `getRepository` | `getRepository(this: [That](./That.md), params?: [SnapshotGetRepositoryRequest](./SnapshotGetRepositoryRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SnapshotGetRepositoryResponse](./SnapshotGetRepositoryResponse.md)>;` |   || `repositoryAnalyze` | `repositoryAnalyze(this: [That](./That.md), params: [SnapshotRepositoryAnalyzeRequest](./SnapshotRepositoryAnalyzeRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SnapshotRepositoryAnalyzeResponse](./SnapshotRepositoryAnalyzeResponse.md)>;` | Analyze a snapshot repository. Analyze the performance characteristics and any incorrect behaviour found in a repository. The response exposes implementation details of the analysis which may change from version to version. The response body format is therefore not considered stable and may be different in newer versions. There are a large number of third-party storage systems available, not all of which are suitable for use as a snapshot repository by Elasticsearch. Some storage systems behave incorrectly, or perform poorly, especially when accessed concurrently by multiple clients as the nodes of an Elasticsearch cluster do. This API performs a collection of read and write operations on your repository which are designed to detect incorrect behaviour and to measure the performance characteristics of your storage system. The default values for the parameters are deliberately low to reduce the impact of running an analysis inadvertently and to provide a sensible starting point for your investigations. Run your first analysis with the default parameter values to check for simple problems. If successful, run a sequence of increasingly large analyses until you encounter a failure or you reach a `blob_count` of at least `2000`, a `max_blob_size` of at least `2gb`, a `max_total_data_size` of at least `1tb`, and a `register_operation_count` of at least `100`. Always specify a generous timeout, possibly `1h` or longer, to allow time for each analysis to run to completion. Perform the analyses using a multi-node cluster of a similar size to your production cluster so that it can detect any problems that only arise when the repository is accessed by many nodes at once. If the analysis fails, Elasticsearch detected that your repository behaved unexpectedly. This usually means you are using a third-party storage system with an incorrect or incompatible implementation of the API it claims to support. If so, this storage system is not suitable for use as a snapshot repository. You will need to work with the supplier of your storage system to address the incompatibilities that Elasticsearch detects. If the analysis is successful, the API returns details of the testing process, optionally including how long each operation took. You can use this information to determine the performance of your storage system. If any operation fails or returns an incorrect result, the API returns an error. If the API returns an error, it may not have removed all the data it wrote to the repository. The error will indicate the location of any leftover data and this path is also recorded in the Elasticsearch logs. You should verify that this location has been cleaned up correctly. If there is still leftover data at the specified location, you should manually remove it. If the connection from your client to Elasticsearch is closed while the client is waiting for the result of the analysis, the test is cancelled. Some clients are configured to close their connection if no response is received within a certain timeout. An analysis takes a long time to complete so you might need to relax any such client-side timeouts. On cancellation the analysis attempts to clean up the data it was writing, but it may not be able to remove it all. The path to the leftover data is recorded in the Elasticsearch logs. You should verify that this location has been cleaned up correctly. If there is still leftover data at the specified location, you should manually remove it. If the analysis is successful then it detected no incorrect behaviour, but this does not mean that correct behaviour is guaranteed. The analysis attempts to detect common bugs but it does not offer 100% coverage. Additionally, it does not test the following: * Your repository must perform durable writes. Once a blob has been written it must remain in place until it is deleted, even after a power loss or similar disaster. * Your repository must not suffer from silent data corruption. Once a blob has been written, its contents must remain unchanged until it is deliberately modified or deleted. * Your repository must behave correctly even if connectivity from the cluster is disrupted. Reads and writes may fail in this case, but they must not return incorrect results. IMPORTANT: An analysis writes a substantial amount of data to your repository and then reads it back again. This consumes bandwidth on the network between the cluster and the repository, and storage space and I/O bandwidth on the repository itself. You must ensure this load does not affect other users of these systems. Analyses respect the repository settings `max_snapshot_bytes_per_sec` and `max_restore_bytes_per_sec` if available and the cluster setting `indices.recovery.max_bytes_per_sec` which you can use to limit the bandwidth they consume. NOTE: This API is intended for exploratory use by humans. You should expect the request parameters and the response format to vary in future versions. NOTE: Different versions of Elasticsearch may perform different checks for repository compatibility, with newer versions typically being stricter than older ones. A storage system that passes repository analysis with one version of Elasticsearch may fail with a different version. This indicates it behaves incorrectly in ways that the former version did not detect. You must work with the supplier of your storage system to address the incompatibilities detected by the repository analysis API in any version of Elasticsearch. NOTE: This API may not work correctly in a mixed-version cluster. *Implementation details* NOTE: This section of documentation describes how the repository analysis API works in this version of Elasticsearch, but you should expect the implementation to vary between versions. The request parameters and response format depend on details of the implementation so may also be different in newer versions. The analysis comprises a number of blob-level tasks, as set by the `blob_count` parameter and a number of compare-and-exchange operations on linearizable registers, as set by the `register_operation_count` parameter. These tasks are distributed over the data and master-eligible nodes in the cluster for execution. For most blob-level tasks, the executing node first writes a blob to the repository and then instructs some of the other nodes in the cluster to attempt to read the data it just wrote. The size of the blob is chosen randomly, according to the `max_blob_size` and `max_total_data_size` parameters. If any of these reads fails then the repository does not implement the necessary read-after-write semantics that Elasticsearch requires. For some blob-level tasks, the executing node will instruct some of its peers to attempt to read the data before the writing process completes. These reads are permitted to fail, but must not return partial data. If any read returns partial data then the repository does not implement the necessary atomicity semantics that Elasticsearch requires. For some blob-level tasks, the executing node will overwrite the blob while its peers are reading it. In this case the data read may come from either the original or the overwritten blob, but the read operation must not return partial data or a mix of data from the two blobs. If any of these reads returns partial data or a mix of the two blobs then the repository does not implement the necessary atomicity semantics that Elasticsearch requires for overwrites. The executing node will use a variety of different methods to write the blob. For instance, where applicable, it will use both single-part and multi-part uploads. Similarly, the reading nodes will use a variety of different methods to read the data back again. For instance they may read the entire blob from start to end or may read only a subset of the data. For some blob-level tasks, the executing node will cancel the write before it is complete. In this case, it still instructs some of the other nodes in the cluster to attempt to read the blob but all of these reads must fail to find the blob. Linearizable registers are special blobs that Elasticsearch manipulates using an atomic compare-and-exchange operation. This operation ensures correct and strongly-consistent behavior even when the blob is accessed by multiple nodes at the same time. The detailed implementation of the compare-and-exchange operation on linearizable registers varies by repository type. Repository analysis verifies that that uncontended compare-and-exchange operations on a linearizable register blob always succeed. Repository analysis also verifies that contended operations either succeed or report the contention but do not return incorrect results. If an operation fails due to contention, Elasticsearch retries the operation until it succeeds. Most of the compare-and-exchange operations performed by repository analysis atomically increment a counter which is represented as an 8-byte blob. Some operations also verify the behavior on small blobs with sizes other than 8 bytes. || `repositoryAnalyze` | `repositoryAnalyze(this: [That](./That.md), params: [SnapshotRepositoryAnalyzeRequest](./SnapshotRepositoryAnalyzeRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SnapshotRepositoryAnalyzeResponse](./SnapshotRepositoryAnalyzeResponse.md), unknown>>;` |   || `repositoryAnalyze` | `repositoryAnalyze(this: [That](./That.md), params: [SnapshotRepositoryAnalyzeRequest](./SnapshotRepositoryAnalyzeRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SnapshotRepositoryAnalyzeResponse](./SnapshotRepositoryAnalyzeResponse.md)>;` |   || `repositoryVerifyIntegrity` | `repositoryVerifyIntegrity(this: [That](./That.md), params: [SnapshotRepositoryVerifyIntegrityRequest](./SnapshotRepositoryVerifyIntegrityRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SnapshotRepositoryVerifyIntegrityResponse](./SnapshotRepositoryVerifyIntegrityResponse.md)>;` | Verify the repository integrity. Verify the integrity of the contents of a snapshot repository. This API enables you to perform a comprehensive check of the contents of a repository, looking for any anomalies in its data or metadata which might prevent you from restoring snapshots from the repository or which might cause future snapshot create or delete operations to fail. If you suspect the integrity of the contents of one of your snapshot repositories, cease all write activity to this repository immediately, set its `read_only` option to `true`, and use this API to verify its integrity. Until you do so: * It may not be possible to restore some snapshots from this repository. * Searchable snapshots may report errors when searched or may have unassigned shards. * Taking snapshots into this repository may fail or may appear to succeed but have created a snapshot which cannot be restored. * Deleting snapshots from this repository may fail or may appear to succeed but leave the underlying data on disk. * Continuing to write to the repository while it is in an invalid state may causing additional damage to its contents. If the API finds any problems with the integrity of the contents of your repository, Elasticsearch will not be able to repair the damage. The only way to bring the repository back into a fully working state after its contents have been damaged is by restoring its contents from a repository backup which was taken before the damage occurred. You must also identify what caused the damage and take action to prevent it from happening again. If you cannot restore a repository backup, register a new repository and use this for all future snapshot operations. In some cases it may be possible to recover some of the contents of a damaged repository, either by restoring as many of its snapshots as needed and taking new snapshots of the restored data, or by using the reindex API to copy data from any searchable snapshots mounted from the damaged repository. Avoid all operations which write to the repository while the verify repository integrity API is running. If something changes the repository contents while an integrity verification is running then Elasticsearch may incorrectly report having detected some anomalies in its contents due to the concurrent writes. It may also incorrectly fail to report some anomalies that the concurrent writes prevented it from detecting. NOTE: This API is intended for exploratory use by humans. You should expect the request parameters and the response format to vary in future versions. NOTE: This API may not work correctly in a mixed-version cluster. The default values for the parameters of this API are designed to limit the impact of the integrity verification on other activities in your cluster. For instance, by default it will only use at most half of the `snapshot_meta` threads to verify the integrity of each snapshot, allowing other snapshot operations to use the other half of this thread pool. If you modify these parameters to speed up the verification process, you risk disrupting other snapshot-related operations in your cluster. For large repositories, consider setting up a separate single-node Elasticsearch cluster just for running the integrity verification API. The response exposes implementation details of the analysis which may change from version to version. The response body format is therefore not considered stable and may be different in newer versions. || `repositoryVerifyIntegrity` | `repositoryVerifyIntegrity(this: [That](./That.md), params: [SnapshotRepositoryVerifyIntegrityRequest](./SnapshotRepositoryVerifyIntegrityRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SnapshotRepositoryVerifyIntegrityResponse](./SnapshotRepositoryVerifyIntegrityResponse.md), unknown>>;` |   || `repositoryVerifyIntegrity` | `repositoryVerifyIntegrity(this: [That](./That.md), params: [SnapshotRepositoryVerifyIntegrityRequest](./SnapshotRepositoryVerifyIntegrityRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SnapshotRepositoryVerifyIntegrityResponse](./SnapshotRepositoryVerifyIntegrityResponse.md)>;` |   || `restore` | `restore(this: [That](./That.md), params: [SnapshotRestoreRequest](./SnapshotRestoreRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SnapshotRestoreResponse](./SnapshotRestoreResponse.md)>;` | Restore a snapshot. Restore a snapshot of a cluster or data streams and indices. You can restore a snapshot only to a running cluster with an elected master node. The snapshot repository must be registered and available to the cluster. The snapshot and cluster versions must be compatible. To restore a snapshot, the cluster's global metadata must be writable. Ensure there are't any cluster blocks that prevent writes. The restore operation ignores index blocks. Before you restore a data stream, ensure the cluster contains a matching index template with data streams enabled. To check, use the index management feature in Kibana or the get index template API: ``` GET _index_template/*?filter_path=index_templates.name,index_templates.index_template.index_patterns,index_templates.index_template.data_stream ``` If no such template exists, you can create one or restore a cluster state that contains one. Without a matching index template, a data stream can't roll over or create backing indices. If your snapshot contains data from App Search or Workplace Search, you must restore the Enterprise Search encryption key before you restore the snapshot. || `restore` | `restore(this: [That](./That.md), params: [SnapshotRestoreRequest](./SnapshotRestoreRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SnapshotRestoreResponse](./SnapshotRestoreResponse.md), unknown>>;` |   || `restore` | `restore(this: [That](./That.md), params: [SnapshotRestoreRequest](./SnapshotRestoreRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SnapshotRestoreResponse](./SnapshotRestoreResponse.md)>;` |   || `status` | `status(this: [That](./That.md), params?: [SnapshotStatusRequest](./SnapshotStatusRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SnapshotStatusResponse](./SnapshotStatusResponse.md)>;` | Get the snapshot status. Get a detailed description of the current state for each shard participating in the snapshot. Note that this API should be used only to obtain detailed shard-level information for ongoing snapshots. If this detail is not needed or you want to obtain information about one or more existing snapshots, use the get snapshot API. If you omit the `` request path parameter, the request retrieves information only for currently running snapshots. This usage is preferred. If needed, you can specify `` and `` to retrieve information for specific snapshots, even if they're not currently running. WARNING: Using the API to return the status of any snapshots other than currently running snapshots can be expensive. The API requires a read from the repository for each shard in each snapshot. For example, if you have 100 snapshots with 1,000 shards each, an API request that includes all snapshots will require 100,000 reads (100 snapshots x 1,000 shards). Depending on the latency of your storage, such requests can take an extremely long time to return results. These requests can also tax machine resources and, when using cloud storage, incur high processing costs. || `status` | `status(this: [That](./That.md), params?: [SnapshotStatusRequest](./SnapshotStatusRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SnapshotStatusResponse](./SnapshotStatusResponse.md), unknown>>;` |   || `status` | `status(this: [That](./That.md), params?: [SnapshotStatusRequest](./SnapshotStatusRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SnapshotStatusResponse](./SnapshotStatusResponse.md)>;` |   || `verifyRepository` | `verifyRepository(this: [That](./That.md), params: [SnapshotVerifyRepositoryRequest](./SnapshotVerifyRepositoryRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SnapshotVerifyRepositoryResponse](./SnapshotVerifyRepositoryResponse.md)>;` | Verify a snapshot repository. Check for common misconfigurations in a snapshot repository. || `verifyRepository` | `verifyRepository(this: [That](./That.md), params: [SnapshotVerifyRepositoryRequest](./SnapshotVerifyRepositoryRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SnapshotVerifyRepositoryResponse](./SnapshotVerifyRepositoryResponse.md), unknown>>;` |   || `verifyRepository` | `verifyRepository(this: [That](./That.md), params: [SnapshotVerifyRepositoryRequest](./SnapshotVerifyRepositoryRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SnapshotVerifyRepositoryResponse](./SnapshotVerifyRepositoryResponse.md)>;` |   | \ No newline at end of file diff --git a/docs/reference/api/SnapshotAzureRepository.md b/docs/reference/api/SnapshotAzureRepository.md new file mode 100644 index 000000000..68639b0d4 --- /dev/null +++ b/docs/reference/api/SnapshotAzureRepository.md @@ -0,0 +1,6 @@ +## Interface `SnapshotAzureRepository` + +| Name | Type | Description | +| - | - | - | +| `settings` | [SnapshotAzureRepositorySettings](./SnapshotAzureRepositorySettings.md) | The repository settings. | +| `type` | 'azure' | The Azure repository type. | diff --git a/docs/reference/api/SnapshotAzureRepositorySettings.md b/docs/reference/api/SnapshotAzureRepositorySettings.md new file mode 100644 index 000000000..f6c72177b --- /dev/null +++ b/docs/reference/api/SnapshotAzureRepositorySettings.md @@ -0,0 +1,11 @@ +## Interface `SnapshotAzureRepositorySettings` + +| Name | Type | Description | +| - | - | - | +| `base_path` | string | The path to the repository data within the container. It defaults to the root directory. NOTE: Don't set `base_path` when configuring a snapshot repository for Elastic Cloud Enterprise. Elastic Cloud Enterprise automatically generates the `base_path` for each deployment so that multiple deployments can share the same bucket. | +| `client` | string | The name of the Azure repository client to use. | +| `container` | string | The Azure container. | +| `delete_objects_max_size` | [integer](./integer.md) | The maxmimum batch size, between 1 and 256, used for `BlobBatch` requests. Defaults to 256 which is the maximum number supported by the Azure blob batch API. | +| `location_mode` | string | Either `primary_only` or `secondary_only`. Note that if you set it to `secondary_only`, it will force `readonly` to `true`. | +| `max_concurrent_batch_deletes` | [integer](./integer.md) | The maximum number of concurrent batch delete requests that will be submitted for any individual bulk delete with `BlobBatch`. Note that the effective number of concurrent deletes is further limited by the Azure client connection and event loop thread limits. Defaults to 10, minimum is 1, maximum is 100. | +| `readonly` | boolean | If `true`, the repository is read-only. The cluster can retrieve and restore snapshots from the repository but not write to the repository or create snapshots in it. Only a cluster with write access can create snapshots in the repository. All other clusters connected to the repository should have the `readonly` parameter set to `true`. If `false`, the cluster can write to the repository and create snapshots in it. IMPORTANT: If you register the same snapshot repository with multiple clusters, only one cluster should have write access to the repository. Having multiple clusters write to the repository at the same time risks corrupting the contents of the repository. | diff --git a/docs/reference/api/SnapshotCleanupRepositoryCleanupRepositoryResults.md b/docs/reference/api/SnapshotCleanupRepositoryCleanupRepositoryResults.md new file mode 100644 index 000000000..0a709403b --- /dev/null +++ b/docs/reference/api/SnapshotCleanupRepositoryCleanupRepositoryResults.md @@ -0,0 +1,6 @@ +## Interface `SnapshotCleanupRepositoryCleanupRepositoryResults` + +| Name | Type | Description | +| - | - | - | +| `deleted_blobs` | [long](./long.md) | The number of binary large objects (blobs) removed from the snapshot repository during cleanup operations. A non-zero value indicates that unreferenced blobs were found and subsequently cleaned up. | +| `deleted_bytes` | [long](./long.md) | The number of bytes freed by cleanup operations. | diff --git a/docs/reference/api/SnapshotCleanupRepositoryRequest.md b/docs/reference/api/SnapshotCleanupRepositoryRequest.md new file mode 100644 index 000000000..207df338a --- /dev/null +++ b/docs/reference/api/SnapshotCleanupRepositoryRequest.md @@ -0,0 +1,9 @@ +## Interface `SnapshotCleanupRepositoryRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { name?: never; master_timeout?: never; timeout?: never; }) | All values in `body` will be added to the request body. | +| `master_timeout` | [Duration](./Duration.md) | The period to wait for a connection to the master node. If the master node is not available before the timeout expires, the request fails and returns an error. To indicate that the request should never timeout, set it to `-1` | +| `name` | [Name](./Name.md) | The name of the snapshot repository to clean up. | +| `querystring` | { [key: string]: any; } & { name?: never; master_timeout?: never; timeout?: never; } | All values in `querystring` will be added to the request querystring. | +| `timeout` | [Duration](./Duration.md) | The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata. If no response is received before the timeout expires, the cluster metadata update still applies but the response will indicate that it was not completely acknowledged. To indicate that the request should never timeout, set it to `-1`. | diff --git a/docs/reference/api/SnapshotCleanupRepositoryResponse.md b/docs/reference/api/SnapshotCleanupRepositoryResponse.md new file mode 100644 index 000000000..e323023f6 --- /dev/null +++ b/docs/reference/api/SnapshotCleanupRepositoryResponse.md @@ -0,0 +1,5 @@ +## Interface `SnapshotCleanupRepositoryResponse` + +| Name | Type | Description | +| - | - | - | +| `results` | [SnapshotCleanupRepositoryCleanupRepositoryResults](./SnapshotCleanupRepositoryCleanupRepositoryResults.md) | Statistics for cleanup operations. | diff --git a/docs/reference/api/SnapshotCloneRequest.md b/docs/reference/api/SnapshotCloneRequest.md new file mode 100644 index 000000000..6122c07df --- /dev/null +++ b/docs/reference/api/SnapshotCloneRequest.md @@ -0,0 +1,11 @@ +## Interface `SnapshotCloneRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { repository?: never; snapshot?: never; target_snapshot?: never; master_timeout?: never; indices?: never; }) | All values in `body` will be added to the request body. | +| `indices` | string | A comma-separated list of indices to include in the snapshot. Multi-target syntax is supported. | +| `master_timeout` | [Duration](./Duration.md) | The period to wait for the master node. If the master node is not available before the timeout expires, the request fails and returns an error. To indicate that the request should never timeout, set it to `-1`. | +| `querystring` | { [key: string]: any; } & { repository?: never; snapshot?: never; target_snapshot?: never; master_timeout?: never; indices?: never; } | All values in `querystring` will be added to the request querystring. | +| `repository` | [Name](./Name.md) | The name of the snapshot repository that both source and target snapshot belong to. | +| `snapshot` | [Name](./Name.md) | The source snapshot name. | +| `target_snapshot` | [Name](./Name.md) | The target snapshot name. | diff --git a/docs/reference/api/SnapshotCloneResponse.md b/docs/reference/api/SnapshotCloneResponse.md new file mode 100644 index 000000000..d2719bd06 --- /dev/null +++ b/docs/reference/api/SnapshotCloneResponse.md @@ -0,0 +1,4 @@ +## `SnapshotCloneResponse` +::: +type SnapshotCloneResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); +::: diff --git a/docs/reference/api/SnapshotCreateRepositoryRequest.md b/docs/reference/api/SnapshotCreateRepositoryRequest.md new file mode 100644 index 000000000..2f7463a25 --- /dev/null +++ b/docs/reference/api/SnapshotCreateRepositoryRequest.md @@ -0,0 +1,11 @@ +## Interface `SnapshotCreateRepositoryRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { name?: never; master_timeout?: never; timeout?: never; verify?: never; repository?: never; }) | All values in `body` will be added to the request body. | +| `master_timeout` | [Duration](./Duration.md) | The period to wait for the master node. If the master node is not available before the timeout expires, the request fails and returns an error. To indicate that the request should never timeout, set it to `-1`. | +| `name` | [Name](./Name.md) | The name of the snapshot repository to register or update. | +| `querystring` | { [key: string]: any; } & { name?: never; master_timeout?: never; timeout?: never; verify?: never; repository?: never; } | All values in `querystring` will be added to the request querystring. | +| `repository` | [SnapshotRepository](./SnapshotRepository.md) |   | +| `timeout` | [Duration](./Duration.md) | The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata. If no response is received before the timeout expires, the cluster metadata update still applies but the response will indicate that it was not completely acknowledged. To indicate that the request should never timeout, set it to `-1`. | +| `verify` | boolean | If `true`, the request verifies the repository is functional on all master and data nodes in the cluster. If `false`, this verification is skipped. You can also perform this verification with the verify snapshot repository API. | diff --git a/docs/reference/api/SnapshotCreateRepositoryResponse.md b/docs/reference/api/SnapshotCreateRepositoryResponse.md new file mode 100644 index 000000000..a1602984b --- /dev/null +++ b/docs/reference/api/SnapshotCreateRepositoryResponse.md @@ -0,0 +1,4 @@ +## `SnapshotCreateRepositoryResponse` +::: +type SnapshotCreateRepositoryResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); +::: diff --git a/docs/reference/api/SnapshotCreateRequest.md b/docs/reference/api/SnapshotCreateRequest.md new file mode 100644 index 000000000..aa1904328 --- /dev/null +++ b/docs/reference/api/SnapshotCreateRequest.md @@ -0,0 +1,17 @@ +## Interface `SnapshotCreateRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { repository?: never; snapshot?: never; master_timeout?: never; wait_for_completion?: never; expand_wildcards?: never; feature_states?: never; ignore_unavailable?: never; include_global_state?: never; indices?: never; metadata?: never; partial?: never; }) | All values in `body` will be added to the request body. | +| `expand_wildcards` | [ExpandWildcards](./ExpandWildcards.md) | Determines how wildcard patterns in the `indices` parameter match data streams and indices. It supports comma-separated values such as `open,hidden`. | +| `feature_states` | string[] | The feature states to include in the snapshot. Each feature state includes one or more system indices containing related data. You can view a list of eligible features using the get features API. If `include_global_state` is `true`, all current feature states are included by default. If `include_global_state` is `false`, no feature states are included by default. Note that specifying an empty array will result in the default behavior. To exclude all feature states, regardless of the `include_global_state` value, specify an array with only the value `none` ( `["none"]`). | +| `ignore_unavailable` | boolean | If `true`, the request ignores data streams and indices in `indices` that are missing or closed. If `false`, the request returns an error for any data stream or index that is missing or closed. | +| `include_global_state` | boolean | If `true`, the current cluster state is included in the snapshot. The cluster state includes persistent cluster settings, composable index templates, legacy index templates, ingest pipelines, and ILM policies. It also includes data stored in system indices, such as Watches and task records (configurable via `feature_states`). | +| `indices` | [Indices](./Indices.md) | A comma-separated list of data streams and indices to include in the snapshot. It supports a multi-target syntax. The default is an empty array ( `[]`), which includes all regular data streams and regular indices. To exclude all data streams and indices, use `-*`. You can't use this parameter to include or exclude system indices or system data streams from a snapshot. Use `feature_states` instead. | +| `master_timeout` | [Duration](./Duration.md) | The period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. | +| `metadata` | [Metadata](./Metadata.md) | Arbitrary metadata to the snapshot, such as a record of who took the snapshot, why it was taken, or any other useful data. It can have any contents but it must be less than 1024 bytes. This information is not automatically generated by Elasticsearch. | +| `partial` | boolean | If `true`, it enables you to restore a partial snapshot of indices with unavailable shards. Only shards that were successfully included in the snapshot will be restored. All missing shards will be recreated as empty. If `false`, the entire restore operation will fail if one or more indices included in the snapshot do not have all primary shards available. | +| `querystring` | { [key: string]: any; } & { repository?: never; snapshot?: never; master_timeout?: never; wait_for_completion?: never; expand_wildcards?: never; feature_states?: never; ignore_unavailable?: never; include_global_state?: never; indices?: never; metadata?: never; partial?: never; } | All values in `querystring` will be added to the request querystring. | +| `repository` | [Name](./Name.md) | The name of the repository for the snapshot. | +| `snapshot` | [Name](./Name.md) | The name of the snapshot. It supportes date math. It must be unique in the repository. | +| `wait_for_completion` | boolean | If `true`, the request returns a response when the snapshot is complete. If `false`, the request returns a response when the snapshot initializes. | diff --git a/docs/reference/api/SnapshotCreateResponse.md b/docs/reference/api/SnapshotCreateResponse.md new file mode 100644 index 000000000..667f32559 --- /dev/null +++ b/docs/reference/api/SnapshotCreateResponse.md @@ -0,0 +1,6 @@ +## Interface `SnapshotCreateResponse` + +| Name | Type | Description | +| - | - | - | +| `accepted` | boolean | Equals `true` if the snapshot was accepted. Present when the request had `wait_for_completion` set to `false` | +| `snapshot` | [SnapshotSnapshotInfo](./SnapshotSnapshotInfo.md) | Snapshot information. Present when the request had `wait_for_completion` set to `true` | diff --git a/docs/reference/api/SnapshotDeleteRepositoryRequest.md b/docs/reference/api/SnapshotDeleteRepositoryRequest.md new file mode 100644 index 000000000..91b6c03ce --- /dev/null +++ b/docs/reference/api/SnapshotDeleteRepositoryRequest.md @@ -0,0 +1,9 @@ +## Interface `SnapshotDeleteRepositoryRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { name?: never; master_timeout?: never; timeout?: never; }) | All values in `body` will be added to the request body. | +| `master_timeout` | [Duration](./Duration.md) | The period to wait for the master node. If the master node is not available before the timeout expires, the request fails and returns an error. To indicate that the request should never timeout, set it to `-1`. | +| `name` | [Names](./Names.md) | The ame of the snapshot repositories to unregister. Wildcard ( `*`) patterns are supported. | +| `querystring` | { [key: string]: any; } & { name?: never; master_timeout?: never; timeout?: never; } | All values in `querystring` will be added to the request querystring. | +| `timeout` | [Duration](./Duration.md) | The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata. If no response is received before the timeout expires, the cluster metadata update still applies but the response will indicate that it was not completely acknowledged. To indicate that the request should never timeout, set it to `-1`. | diff --git a/docs/reference/api/SnapshotDeleteRepositoryResponse.md b/docs/reference/api/SnapshotDeleteRepositoryResponse.md new file mode 100644 index 000000000..bdf8b400b --- /dev/null +++ b/docs/reference/api/SnapshotDeleteRepositoryResponse.md @@ -0,0 +1,4 @@ +## `SnapshotDeleteRepositoryResponse` +::: +type SnapshotDeleteRepositoryResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); +::: diff --git a/docs/reference/api/SnapshotDeleteRequest.md b/docs/reference/api/SnapshotDeleteRequest.md new file mode 100644 index 000000000..39c63ff8b --- /dev/null +++ b/docs/reference/api/SnapshotDeleteRequest.md @@ -0,0 +1,9 @@ +## Interface `SnapshotDeleteRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { repository?: never; snapshot?: never; master_timeout?: never; }) | All values in `body` will be added to the request body. | +| `master_timeout` | [Duration](./Duration.md) | The period to wait for the master node. If the master node is not available before the timeout expires, the request fails and returns an error. To indicate that the request should never timeout, set it to `-1`. | +| `querystring` | { [key: string]: any; } & { repository?: never; snapshot?: never; master_timeout?: never; } | All values in `querystring` will be added to the request querystring. | +| `repository` | [Name](./Name.md) | The name of the repository to delete a snapshot from. | +| `snapshot` | [Name](./Name.md) | A comma-separated list of snapshot names to delete. It also accepts wildcards ( `*`). | diff --git a/docs/reference/api/SnapshotDeleteResponse.md b/docs/reference/api/SnapshotDeleteResponse.md new file mode 100644 index 000000000..7411ce088 --- /dev/null +++ b/docs/reference/api/SnapshotDeleteResponse.md @@ -0,0 +1,4 @@ +## `SnapshotDeleteResponse` +::: +type SnapshotDeleteResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); +::: diff --git a/docs/reference/api/SnapshotFileCountSnapshotStats.md b/docs/reference/api/SnapshotFileCountSnapshotStats.md new file mode 100644 index 000000000..6a23f5b6d --- /dev/null +++ b/docs/reference/api/SnapshotFileCountSnapshotStats.md @@ -0,0 +1,6 @@ +## Interface `SnapshotFileCountSnapshotStats` + +| Name | Type | Description | +| - | - | - | +| `file_count` | [integer](./integer.md) |   | +| `size_in_bytes` | [long](./long.md) |   | diff --git a/docs/reference/api/SnapshotGcsRepository.md b/docs/reference/api/SnapshotGcsRepository.md new file mode 100644 index 000000000..4bebd299f --- /dev/null +++ b/docs/reference/api/SnapshotGcsRepository.md @@ -0,0 +1,6 @@ +## Interface `SnapshotGcsRepository` + +| Name | Type | Description | +| - | - | - | +| `settings` | [SnapshotGcsRepositorySettings](./SnapshotGcsRepositorySettings.md) | The repository settings. | +| `type` | 'gcs' | The Google Cloud Storage repository type. | diff --git a/docs/reference/api/SnapshotGcsRepositorySettings.md b/docs/reference/api/SnapshotGcsRepositorySettings.md new file mode 100644 index 000000000..d2d341022 --- /dev/null +++ b/docs/reference/api/SnapshotGcsRepositorySettings.md @@ -0,0 +1,9 @@ +## Interface `SnapshotGcsRepositorySettings` + +| Name | Type | Description | +| - | - | - | +| `application_name` | string | The name used by the client when it uses the Google Cloud Storage service. | +| `base_path` | string | The path to the repository data within the bucket. It defaults to the root of the bucket. NOTE: Don't set `base_path` when configuring a snapshot repository for Elastic Cloud Enterprise. Elastic Cloud Enterprise automatically generates the `base_path` for each deployment so that multiple deployments can share the same bucket. | +| `bucket` | string | The name of the bucket to be used for snapshots. | +| `client` | string | The name of the client to use to connect to Google Cloud Storage. | +| `readonly` | boolean | If `true`, the repository is read-only. The cluster can retrieve and restore snapshots from the repository but not write to the repository or create snapshots in it. Only a cluster with write access can create snapshots in the repository. All other clusters connected to the repository should have the `readonly` parameter set to `true`. If `false`, the cluster can write to the repository and create snapshots in it. IMPORTANT: If you register the same snapshot repository with multiple clusters, only one cluster should have write access to the repository. Having multiple clusters write to the repository at the same time risks corrupting the contents of the repository. | diff --git a/docs/reference/api/SnapshotGetRepositoryRequest.md b/docs/reference/api/SnapshotGetRepositoryRequest.md new file mode 100644 index 000000000..add7bef2a --- /dev/null +++ b/docs/reference/api/SnapshotGetRepositoryRequest.md @@ -0,0 +1,9 @@ +## Interface `SnapshotGetRepositoryRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { name?: never; local?: never; master_timeout?: never; }) | All values in `body` will be added to the request body. | +| `local` | boolean | If `true`, the request gets information from the local node only. If `false`, the request gets information from the master node. | +| `master_timeout` | [Duration](./Duration.md) | The period to wait for the master node. If the master node is not available before the timeout expires, the request fails and returns an error. To indicate that the request should never timeout, set it to `-1`. | +| `name` | [Names](./Names.md) | A comma-separated list of snapshot repository names used to limit the request. Wildcard ( `*`) expressions are supported including combining wildcards with exclude patterns starting with `-`. To get information about all snapshot repositories registered in the cluster, omit this parameter or use `*` or `_all`. | +| `querystring` | { [key: string]: any; } & { name?: never; local?: never; master_timeout?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/SnapshotGetRepositoryResponse.md b/docs/reference/api/SnapshotGetRepositoryResponse.md new file mode 100644 index 000000000..acb3111bd --- /dev/null +++ b/docs/reference/api/SnapshotGetRepositoryResponse.md @@ -0,0 +1,4 @@ +## `SnapshotGetRepositoryResponse` +::: +type SnapshotGetRepositoryResponse = Record; +::: diff --git a/docs/reference/api/SnapshotGetRequest.md b/docs/reference/api/SnapshotGetRequest.md new file mode 100644 index 000000000..68e4e1f20 --- /dev/null +++ b/docs/reference/api/SnapshotGetRequest.md @@ -0,0 +1,21 @@ +## Interface `SnapshotGetRequest` + +| Name | Type | Description | +| - | - | - | +| `after` | string | An offset identifier to start pagination from as returned by the next field in the response body. | +| `body` | string | ({ [key: string]: any; } & { repository?: never; snapshot?: never; after?: never; from_sort_value?: never; ignore_unavailable?: never; index_details?: never; index_names?: never; include_repository?: never; master_timeout?: never; order?: never; offset?: never; size?: never; slm_policy_filter?: never; sort?: never; verbose?: never; }) | All values in `body` will be added to the request body. | +| `from_sort_value` | string | The value of the current sort column at which to start retrieval. It can be a string `snapshot-` or a repository name when sorting by snapshot or repository name. It can be a millisecond time value or a number when sorting by `index-` or shard count. | +| `ignore_unavailable` | boolean | If `false`, the request returns an error for any snapshots that are unavailable. | +| `include_repository` | boolean | If `true`, the response includes the repository name in each snapshot. | +| `index_details` | boolean | If `true`, the response includes additional information about each index in the snapshot comprising the number of shards in the index, the total size of the index in bytes, and the maximum number of segments per shard in the index. The default is `false`, meaning that this information is omitted. | +| `index_names` | boolean | If `true`, the response includes the name of each index in each snapshot. | +| `master_timeout` | [Duration](./Duration.md) | The period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. | +| `offset` | [integer](./integer.md) | Numeric offset to start pagination from based on the snapshots matching this request. Using a non-zero value for this parameter is mutually exclusive with using the after parameter. Defaults to 0. | +| `order` | [SortOrder](./SortOrder.md) | The sort order. Valid values are `asc` for ascending and `desc` for descending order. The default behavior is ascending order. | +| `querystring` | { [key: string]: any; } & { repository?: never; snapshot?: never; after?: never; from_sort_value?: never; ignore_unavailable?: never; index_details?: never; index_names?: never; include_repository?: never; master_timeout?: never; order?: never; offset?: never; size?: never; slm_policy_filter?: never; sort?: never; verbose?: never; } | All values in `querystring` will be added to the request querystring. | +| `repository` | [Name](./Name.md) | A comma-separated list of snapshot repository names used to limit the request. Wildcard ( `*`) expressions are supported. | +| `size` | [integer](./integer.md) | The maximum number of snapshots to return. The default is 0, which means to return all that match the request without limit. | +| `slm_policy_filter` | [Name](./Name.md) | Filter snapshots by a comma-separated list of snapshot lifecycle management (SLM) policy names that snapshots belong to. You can use wildcards ( `*`) and combinations of wildcards followed by exclude patterns starting with `-`. For example, the pattern `*,-policy-a-\*` will return all snapshots except for those that were created by an SLM policy with a name starting with `policy-a-`. Note that the wildcard pattern `*` matches all snapshots created by an SLM policy but not those snapshots that were not created by an SLM policy. To include snapshots that were not created by an SLM policy, you can use the special pattern `_none` that will match all snapshots without an SLM policy. | +| `snapshot` | [Names](./Names.md) | A comma-separated list of snapshot names to retrieve Wildcards ( `*`) are supported. * To get information about all snapshots in a registered repository, use a wildcard ( `*`) or `_all`. * To get information about any snapshots that are currently running, use `_current`. | +| `sort` | [SnapshotSnapshotSort](./SnapshotSnapshotSort.md) | The sort order for the result. The default behavior is sorting by snapshot start time stamp. | +| `verbose` | boolean | If `true`, returns additional information about each snapshot such as the version of Elasticsearch which took the snapshot, the start and end times of the snapshot, and the number of shards snapshotted. NOTE: The parameters `size`, `order`, `after`, `from_sort_value`, `offset`, `slm_policy_filter`, and `sort` are not supported when you set `verbose=false` and the sort order for requests with `verbose=false` is undefined. | diff --git a/docs/reference/api/SnapshotGetResponse.md b/docs/reference/api/SnapshotGetResponse.md new file mode 100644 index 000000000..32cfb9197 --- /dev/null +++ b/docs/reference/api/SnapshotGetResponse.md @@ -0,0 +1,9 @@ +## Interface `SnapshotGetResponse` + +| Name | Type | Description | +| - | - | - | +| `next` | string | If the request contained a size limit and there might be more results, a `next` field will be added to the response. It can be used as the `after` query parameter to fetch additional results. | +| `remaining` | [integer](./integer.md) | The number of remaining snapshots that were not returned due to size limits and that can be fetched by additional requests using the `next` field value. | +| `responses` | [SnapshotGetSnapshotResponseItem](./SnapshotGetSnapshotResponseItem.md)[] |   | +| `snapshots` | [SnapshotSnapshotInfo](./SnapshotSnapshotInfo.md)[] |   | +| `total` | [integer](./integer.md) | The total number of snapshots that match the request when ignoring the size limit or `after` query parameter. | diff --git a/docs/reference/api/SnapshotGetSnapshotResponseItem.md b/docs/reference/api/SnapshotGetSnapshotResponseItem.md new file mode 100644 index 000000000..cc1cb8e7e --- /dev/null +++ b/docs/reference/api/SnapshotGetSnapshotResponseItem.md @@ -0,0 +1,7 @@ +## Interface `SnapshotGetSnapshotResponseItem` + +| Name | Type | Description | +| - | - | - | +| `error` | [ErrorCause](./ErrorCause.md) |   | +| `repository` | [Name](./Name.md) |   | +| `snapshots` | [SnapshotSnapshotInfo](./SnapshotSnapshotInfo.md)[] |   | diff --git a/docs/reference/api/SnapshotIndexDetails.md b/docs/reference/api/SnapshotIndexDetails.md new file mode 100644 index 000000000..e25548ae2 --- /dev/null +++ b/docs/reference/api/SnapshotIndexDetails.md @@ -0,0 +1,8 @@ +## Interface `SnapshotIndexDetails` + +| Name | Type | Description | +| - | - | - | +| `max_segments_per_shard` | [long](./long.md) |   | +| `shard_count` | [integer](./integer.md) |   | +| `size_in_bytes` | [long](./long.md) |   | +| `size` | [ByteSize](./ByteSize.md) |   | diff --git a/docs/reference/api/SnapshotInfoFeatureState.md b/docs/reference/api/SnapshotInfoFeatureState.md new file mode 100644 index 000000000..643ad4819 --- /dev/null +++ b/docs/reference/api/SnapshotInfoFeatureState.md @@ -0,0 +1,6 @@ +## Interface `SnapshotInfoFeatureState` + +| Name | Type | Description | +| - | - | - | +| `feature_name` | string |   | +| `indices` | [Indices](./Indices.md) |   | diff --git a/docs/reference/api/SnapshotReadOnlyUrlRepository.md b/docs/reference/api/SnapshotReadOnlyUrlRepository.md new file mode 100644 index 000000000..936865ffd --- /dev/null +++ b/docs/reference/api/SnapshotReadOnlyUrlRepository.md @@ -0,0 +1,6 @@ +## Interface `SnapshotReadOnlyUrlRepository` + +| Name | Type | Description | +| - | - | - | +| `settings` | [SnapshotReadOnlyUrlRepositorySettings](./SnapshotReadOnlyUrlRepositorySettings.md) | The repository settings. | +| `type` | 'url' | The read-only URL repository type. | diff --git a/docs/reference/api/SnapshotReadOnlyUrlRepositorySettings.md b/docs/reference/api/SnapshotReadOnlyUrlRepositorySettings.md new file mode 100644 index 000000000..52c46141c --- /dev/null +++ b/docs/reference/api/SnapshotReadOnlyUrlRepositorySettings.md @@ -0,0 +1,8 @@ +## Interface `SnapshotReadOnlyUrlRepositorySettings` + +| Name | Type | Description | +| - | - | - | +| `http_max_retries` | [integer](./integer.md) | The maximum number of retries for HTTP and HTTPS URLs. | +| `http_socket_timeout` | [Duration](./Duration.md) | The maximum wait time for data transfers over a connection. | +| `max_number_of_snapshots` | [integer](./integer.md) | The maximum number of snapshots the repository can contain. The default is `Integer.MAX_VALUE`, which is 2^31-1 or `2147483647`. | +| `url` | string | The URL location of the root of the shared filesystem repository. The following protocols are supported: * `file` * `ftp` * `http` * `https` * `jar`URLs using the HTTP, HTTPS, or FTP protocols must be explicitly allowed with the `repositories.url.allowed_urls` cluster setting. This setting supports wildcards in the place of a host, path, query, or fragment in the URL. URLs using the file protocol must point to the location of a shared filesystem accessible to all master and data nodes in the cluster. This location must be registered in the `path.repo` setting. You don't need to register URLs using the FTP, HTTP, HTTPS, or JAR protocols in the `path.repo` setting. | diff --git a/docs/reference/api/SnapshotRepository.md b/docs/reference/api/SnapshotRepository.md new file mode 100644 index 000000000..a374505ea --- /dev/null +++ b/docs/reference/api/SnapshotRepository.md @@ -0,0 +1,4 @@ +## `SnapshotRepository` +::: +type SnapshotRepository = [SnapshotAzureRepository](./SnapshotAzureRepository.md) | [SnapshotGcsRepository](./SnapshotGcsRepository.md) | [SnapshotS3Repository](./SnapshotS3Repository.md) | [SnapshotSharedFileSystemRepository](./SnapshotSharedFileSystemRepository.md) | [SnapshotReadOnlyUrlRepository](./SnapshotReadOnlyUrlRepository.md) | [SnapshotSourceOnlyRepository](./SnapshotSourceOnlyRepository.md); +::: diff --git a/docs/reference/api/SnapshotRepositoryAnalyzeBlobDetails.md b/docs/reference/api/SnapshotRepositoryAnalyzeBlobDetails.md new file mode 100644 index 000000000..e940d77d3 --- /dev/null +++ b/docs/reference/api/SnapshotRepositoryAnalyzeBlobDetails.md @@ -0,0 +1,12 @@ +## Interface `SnapshotRepositoryAnalyzeBlobDetails` + +| Name | Type | Description | +| - | - | - | +| `name` | string | The name of the blob. | +| `overwritten` | boolean | Indicates whether the blob was overwritten while the read operations were ongoing. /** | +| `read_early` | boolean |   | +| `read_end` | [long](./long.md) | The position, in bytes, at which read operations completed. | +| `read_start` | [long](./long.md) | The position, in bytes, at which read operations started. | +| `reads` | [SnapshotRepositoryAnalyzeReadBlobDetails](./SnapshotRepositoryAnalyzeReadBlobDetails.md) | A description of every read operation performed on the blob. | +| `size_bytes` | [long](./long.md) | The size of the blob in bytes. | +| `size` | [ByteSize](./ByteSize.md) | The size of the blob. | diff --git a/docs/reference/api/SnapshotRepositoryAnalyzeDetailsInfo.md b/docs/reference/api/SnapshotRepositoryAnalyzeDetailsInfo.md new file mode 100644 index 000000000..d7d573937 --- /dev/null +++ b/docs/reference/api/SnapshotRepositoryAnalyzeDetailsInfo.md @@ -0,0 +1,12 @@ +## Interface `SnapshotRepositoryAnalyzeDetailsInfo` + +| Name | Type | Description | +| - | - | - | +| `blob` | [SnapshotRepositoryAnalyzeBlobDetails](./SnapshotRepositoryAnalyzeBlobDetails.md) | A description of the blob that was written and read. | +| `overwrite_elapsed_nanos` | [DurationValue](./DurationValue.md)<[UnitNanos](./UnitNanos.md)> | The elapsed time spent overwriting the blob, in nanoseconds. If the blob was not overwritten, this information is omitted. | +| `overwrite_elapsed` | [Duration](./Duration.md) | The elapsed time spent overwriting the blob. If the blob was not overwritten, this information is omitted. | +| `write_elapsed_nanos` | [DurationValue](./DurationValue.md)<[UnitNanos](./UnitNanos.md)> | The elapsed time spent writing the blob, in nanoseconds. | +| `write_elapsed` | [Duration](./Duration.md) | The elapsed time spent writing the blob. | +| `write_throttled_nanos` | [DurationValue](./DurationValue.md)<[UnitNanos](./UnitNanos.md)> | The length of time spent waiting for the `max_snapshot_bytes_per_sec` (or `indices.recovery.max_bytes_per_sec` if the recovery settings for managed services are set) throttle while writing the blob, in nanoseconds. | +| `write_throttled` | [Duration](./Duration.md) | The length of time spent waiting for the `max_snapshot_bytes_per_sec` (or `indices.recovery.max_bytes_per_sec` if the recovery settings for managed services are set) throttle while writing the blob. | +| `writer_node` | [SnapshotRepositoryAnalyzeSnapshotNodeInfo](./SnapshotRepositoryAnalyzeSnapshotNodeInfo.md) | The node which wrote the blob and coordinated the read operations. | diff --git a/docs/reference/api/SnapshotRepositoryAnalyzeReadBlobDetails.md b/docs/reference/api/SnapshotRepositoryAnalyzeReadBlobDetails.md new file mode 100644 index 000000000..965dfa838 --- /dev/null +++ b/docs/reference/api/SnapshotRepositoryAnalyzeReadBlobDetails.md @@ -0,0 +1,13 @@ +## Interface `SnapshotRepositoryAnalyzeReadBlobDetails` + +| Name | Type | Description | +| - | - | - | +| `before_write_complete` | boolean | Indicates whether the read operation may have started before the write operation was complete. | +| `elapsed_nanos` | [DurationValue](./DurationValue.md)<[UnitNanos](./UnitNanos.md)> | The length of time spent reading the blob, in nanoseconds. If the blob was not found, this detail is omitted. | +| `elapsed` | [Duration](./Duration.md) | The length of time spent reading the blob. If the blob was not found, this detail is omitted. | +| `first_byte_time_nanos` | [DurationValue](./DurationValue.md)<[UnitNanos](./UnitNanos.md)> | The length of time waiting for the first byte of the read operation to be received, in nanoseconds. If the blob was not found, this detail is omitted. | +| `first_byte_time` | [Duration](./Duration.md) | The length of time waiting for the first byte of the read operation to be received. If the blob was not found, this detail is omitted. | +| `found` | boolean | Indicates whether the blob was found by the read operation. If the read was started before the write completed or the write was ended before completion, it might be false. | +| `node` | [SnapshotRepositoryAnalyzeSnapshotNodeInfo](./SnapshotRepositoryAnalyzeSnapshotNodeInfo.md) | The node that performed the read operation. | +| `throttled_nanos` | [DurationValue](./DurationValue.md)<[UnitNanos](./UnitNanos.md)> | The length of time spent waiting due to the `max_restore_bytes_per_sec` or `indices.recovery.max_bytes_per_sec` throttles during the read of the blob, in nanoseconds. If the blob was not found, this detail is omitted. | +| `throttled` | [Duration](./Duration.md) | The length of time spent waiting due to the `max_restore_bytes_per_sec` or `indices.recovery.max_bytes_per_sec` throttles during the read of the blob. If the blob was not found, this detail is omitted. | diff --git a/docs/reference/api/SnapshotRepositoryAnalyzeReadSummaryInfo.md b/docs/reference/api/SnapshotRepositoryAnalyzeReadSummaryInfo.md new file mode 100644 index 000000000..1fd4b66d1 --- /dev/null +++ b/docs/reference/api/SnapshotRepositoryAnalyzeReadSummaryInfo.md @@ -0,0 +1,15 @@ +## Interface `SnapshotRepositoryAnalyzeReadSummaryInfo` + +| Name | Type | Description | +| - | - | - | +| `count` | [integer](./integer.md) | The number of read operations performed in the test. | +| `max_wait_nanos` | [DurationValue](./DurationValue.md)<[UnitNanos](./UnitNanos.md)> | The maximum time spent waiting for the first byte of any read request to be received, in nanoseconds. | +| `max_wait` | [Duration](./Duration.md) | The maximum time spent waiting for the first byte of any read request to be received. | +| `total_elapsed_nanos` | [DurationValue](./DurationValue.md)<[UnitNanos](./UnitNanos.md)> | The total elapsed time spent on reading blobs in the test, in nanoseconds. | +| `total_elapsed` | [Duration](./Duration.md) | The total elapsed time spent on reading blobs in the test. | +| `total_size_bytes` | [long](./long.md) | The total size of all the blobs or partial blobs read in the test, in bytes. | +| `total_size` | [ByteSize](./ByteSize.md) | The total size of all the blobs or partial blobs read in the test. | +| `total_throttled_nanos` | [DurationValue](./DurationValue.md)<[UnitNanos](./UnitNanos.md)> | The total time spent waiting due to the `max_restore_bytes_per_sec` or `indices.recovery.max_bytes_per_sec` throttles, in nanoseconds. | +| `total_throttled` | [Duration](./Duration.md) | The total time spent waiting due to the `max_restore_bytes_per_sec` or `indices.recovery.max_bytes_per_sec` throttles. | +| `total_wait_nanos` | [DurationValue](./DurationValue.md)<[UnitNanos](./UnitNanos.md)> | The total time spent waiting for the first byte of each read request to be received, in nanoseconds. | +| `total_wait` | [Duration](./Duration.md) | The total time spent waiting for the first byte of each read request to be received. | diff --git a/docs/reference/api/SnapshotRepositoryAnalyzeRequest.md b/docs/reference/api/SnapshotRepositoryAnalyzeRequest.md new file mode 100644 index 000000000..cbadfb1f3 --- /dev/null +++ b/docs/reference/api/SnapshotRepositoryAnalyzeRequest.md @@ -0,0 +1,19 @@ +## Interface `SnapshotRepositoryAnalyzeRequest` + +| Name | Type | Description | +| - | - | - | +| `blob_count` | [integer](./integer.md) | The total number of blobs to write to the repository during the test. For realistic experiments, you should set it to at least `2000`. | +| `body` | string | ({ [key: string]: any; } & { name?: never; blob_count?: never; concurrency?: never; detailed?: never; early_read_node_count?: never; max_blob_size?: never; max_total_data_size?: never; rare_action_probability?: never; rarely_abort_writes?: never; read_node_count?: never; register_operation_count?: never; seed?: never; timeout?: never; }) | All values in `body` will be added to the request body. | +| `concurrency` | [integer](./integer.md) | The number of operations to run concurrently during the test. | +| `detailed` | boolean | Indicates whether to return detailed results, including timing information for every operation performed during the analysis. If false, it returns only a summary of the analysis. | +| `early_read_node_count` | [integer](./integer.md) | The number of nodes on which to perform an early read operation while writing each blob. Early read operations are only rarely performed. | +| `max_blob_size` | [ByteSize](./ByteSize.md) | The maximum size of a blob to be written during the test. For realistic experiments, you should set it to at least `2gb`. | +| `max_total_data_size` | [ByteSize](./ByteSize.md) | An upper limit on the total size of all the blobs written during the test. For realistic experiments, you should set it to at least `1tb`. | +| `name` | [Name](./Name.md) | The name of the repository. | +| `querystring` | { [key: string]: any; } & { name?: never; blob_count?: never; concurrency?: never; detailed?: never; early_read_node_count?: never; max_blob_size?: never; max_total_data_size?: never; rare_action_probability?: never; rarely_abort_writes?: never; read_node_count?: never; register_operation_count?: never; seed?: never; timeout?: never; } | All values in `querystring` will be added to the request querystring. | +| `rare_action_probability` | [double](./double.md) | The probability of performing a rare action such as an early read, an overwrite, or an aborted write on each blob. | +| `rarely_abort_writes` | boolean | Indicates whether to rarely cancel writes before they complete. | +| `read_node_count` | [integer](./integer.md) | The number of nodes on which to read a blob after writing. | +| `register_operation_count` | [integer](./integer.md) | The minimum number of linearizable register operations to perform in total. For realistic experiments, you should set it to at least `100`. | +| `seed` | [integer](./integer.md) | The seed for the pseudo-random number generator used to generate the list of operations performed during the test. To repeat the same set of operations in multiple experiments, use the same seed in each experiment. Note that the operations are performed concurrently so might not always happen in the same order on each run. | +| `timeout` | [Duration](./Duration.md) | The period of time to wait for the test to complete. If no response is received before the timeout expires, the test is cancelled and returns an error. | diff --git a/docs/reference/api/SnapshotRepositoryAnalyzeResponse.md b/docs/reference/api/SnapshotRepositoryAnalyzeResponse.md new file mode 100644 index 000000000..057774315 --- /dev/null +++ b/docs/reference/api/SnapshotRepositoryAnalyzeResponse.md @@ -0,0 +1,24 @@ +## Interface `SnapshotRepositoryAnalyzeResponse` + +| Name | Type | Description | +| - | - | - | +| `blob_count` | [integer](./integer.md) | The number of blobs written to the repository during the test. | +| `blob_path` | string | The path in the repository under which all the blobs were written during the test. | +| `concurrency` | [integer](./integer.md) | The number of write operations performed concurrently during the test. | +| `coordinating_node` | [SnapshotRepositoryAnalyzeSnapshotNodeInfo](./SnapshotRepositoryAnalyzeSnapshotNodeInfo.md) | The node that coordinated the analysis and performed the final cleanup. | +| `delete_elapsed_nanos` | [DurationValue](./DurationValue.md)<[UnitNanos](./UnitNanos.md)> | The time it took to delete all the blobs in the container, in nanoseconds. | +| `delete_elapsed` | [Duration](./Duration.md) | The time it took to delete all the blobs in the container. | +| `details` | [SnapshotRepositoryAnalyzeDetailsInfo](./SnapshotRepositoryAnalyzeDetailsInfo.md) | A description of every read and write operation performed during the test. | +| `early_read_node_count` | [integer](./integer.md) | The limit on the number of nodes on which early read operations were performed after writing each blob. | +| `issues_detected` | string[] | A list of correctness issues detected, which is empty if the API succeeded. It is included to emphasize that a successful response does not guarantee correct behaviour in future. | +| `listing_elapsed_nanos` | [DurationValue](./DurationValue.md)<[UnitNanos](./UnitNanos.md)> | The time it took to retrieve a list of all the blobs in the container, in nanoseconds. | +| `listing_elapsed` | [Duration](./Duration.md) | The time it took to retrieve a list of all the blobs in the container. | +| `max_blob_size_bytes` | [long](./long.md) | The limit, in bytes, on the size of a blob written during the test. | +| `max_blob_size` | [ByteSize](./ByteSize.md) | The limit on the size of a blob written during the test. | +| `max_total_data_size_bytes` | [long](./long.md) | The limit, in bytes, on the total size of all blob written during the test. | +| `max_total_data_size` | [ByteSize](./ByteSize.md) | The limit on the total size of all blob written during the test. | +| `rare_action_probability` | [double](./double.md) | The probability of performing rare actions during the test. | +| `read_node_count` | [integer](./integer.md) | The limit on the number of nodes on which read operations were performed after writing each blob. | +| `repository` | string | The name of the repository that was the subject of the analysis. | +| `seed` | [long](./long.md) | The seed for the pseudo-random number generator used to generate the operations used during the test. | +| `summary` | [SnapshotRepositoryAnalyzeSummaryInfo](./SnapshotRepositoryAnalyzeSummaryInfo.md) | A collection of statistics that summarize the results of the test. | diff --git a/docs/reference/api/SnapshotRepositoryAnalyzeSnapshotNodeInfo.md b/docs/reference/api/SnapshotRepositoryAnalyzeSnapshotNodeInfo.md new file mode 100644 index 000000000..c89e7914f --- /dev/null +++ b/docs/reference/api/SnapshotRepositoryAnalyzeSnapshotNodeInfo.md @@ -0,0 +1,6 @@ +## Interface `SnapshotRepositoryAnalyzeSnapshotNodeInfo` + +| Name | Type | Description | +| - | - | - | +| `id` | [Id](./Id.md) |   | +| `name` | [Name](./Name.md) |   | diff --git a/docs/reference/api/SnapshotRepositoryAnalyzeSummaryInfo.md b/docs/reference/api/SnapshotRepositoryAnalyzeSummaryInfo.md new file mode 100644 index 000000000..7363225fa --- /dev/null +++ b/docs/reference/api/SnapshotRepositoryAnalyzeSummaryInfo.md @@ -0,0 +1,6 @@ +## Interface `SnapshotRepositoryAnalyzeSummaryInfo` + +| Name | Type | Description | +| - | - | - | +| `read` | [SnapshotRepositoryAnalyzeReadSummaryInfo](./SnapshotRepositoryAnalyzeReadSummaryInfo.md) | A collection of statistics that summarise the results of the read operations in the test. | +| `write` | [SnapshotRepositoryAnalyzeWriteSummaryInfo](./SnapshotRepositoryAnalyzeWriteSummaryInfo.md) | A collection of statistics that summarise the results of the write operations in the test. | diff --git a/docs/reference/api/SnapshotRepositoryAnalyzeWriteSummaryInfo.md b/docs/reference/api/SnapshotRepositoryAnalyzeWriteSummaryInfo.md new file mode 100644 index 000000000..2058c6668 --- /dev/null +++ b/docs/reference/api/SnapshotRepositoryAnalyzeWriteSummaryInfo.md @@ -0,0 +1,11 @@ +## Interface `SnapshotRepositoryAnalyzeWriteSummaryInfo` + +| Name | Type | Description | +| - | - | - | +| `count` | [integer](./integer.md) | The number of write operations performed in the test. | +| `total_elapsed_nanos` | [DurationValue](./DurationValue.md)<[UnitNanos](./UnitNanos.md)> | The total elapsed time spent on writing blobs in the test, in nanoseconds. | +| `total_elapsed` | [Duration](./Duration.md) | The total elapsed time spent on writing blobs in the test. | +| `total_size_bytes` | [long](./long.md) | The total size of all the blobs written in the test, in bytes. | +| `total_size` | [ByteSize](./ByteSize.md) | The total size of all the blobs written in the test. | +| `total_throttled_nanos` | [long](./long.md) | The total time spent waiting due to the `max_snapshot_bytes_per_sec` throttle, in nanoseconds. | +| `total_throttled` | [Duration](./Duration.md) | The total time spent waiting due to the `max_snapshot_bytes_per_sec` throttle. | diff --git a/docs/reference/api/SnapshotRepositoryBase.md b/docs/reference/api/SnapshotRepositoryBase.md new file mode 100644 index 000000000..b8333cfd0 --- /dev/null +++ b/docs/reference/api/SnapshotRepositoryBase.md @@ -0,0 +1,5 @@ +## Interface `SnapshotRepositoryBase` + +| Name | Type | Description | +| - | - | - | +| `uuid` | [Uuid](./Uuid.md) |   | diff --git a/docs/reference/api/SnapshotRepositorySettingsBase.md b/docs/reference/api/SnapshotRepositorySettingsBase.md new file mode 100644 index 000000000..0c8e5920d --- /dev/null +++ b/docs/reference/api/SnapshotRepositorySettingsBase.md @@ -0,0 +1,8 @@ +## Interface `SnapshotRepositorySettingsBase` + +| Name | Type | Description | +| - | - | - | +| `chunk_size` | [ByteSize](./ByteSize.md) | Big files can be broken down into multiple smaller blobs in the blob store during snapshotting. It is not recommended to change this value from its default unless there is an explicit reason for limiting the size of blobs in the repository. Setting a value lower than the default can result in an increased number of API calls to the blob store during snapshot create and restore operations compared to using the default value and thus make both operations slower and more costly. Specify the chunk size as a byte unit, for example: `10MB`, `5KB`, 500B. The default varies by repository type. | +| `compress` | boolean | When set to `true`, metadata files are stored in compressed format. This setting doesn't affect index files that are already compressed by default. | +| `max_restore_bytes_per_sec` | [ByteSize](./ByteSize.md) | The maximum snapshot restore rate per node. It defaults to unlimited. Note that restores are also throttled through recovery settings. | +| `max_snapshot_bytes_per_sec` | [ByteSize](./ByteSize.md) | The maximum snapshot creation rate per node. It defaults to 40mb per second. Note that if the recovery settings for managed services are set, then it defaults to unlimited, and the rate is additionally throttled through recovery settings. | diff --git a/docs/reference/api/SnapshotRepositoryVerifyIntegrityRequest.md b/docs/reference/api/SnapshotRepositoryVerifyIntegrityRequest.md new file mode 100644 index 000000000..7699177b3 --- /dev/null +++ b/docs/reference/api/SnapshotRepositoryVerifyIntegrityRequest.md @@ -0,0 +1,15 @@ +## Interface `SnapshotRepositoryVerifyIntegrityRequest` + +| Name | Type | Description | +| - | - | - | +| `blob_thread_pool_concurrency` | [integer](./integer.md) | If `verify_blob_contents` is `true`, this parameter specifies how many blobs to verify at once. | +| `body` | string | ({ [key: string]: any; } & { name?: never; blob_thread_pool_concurrency?: never; index_snapshot_verification_concurrency?: never; index_verification_concurrency?: never; max_bytes_per_sec?: never; max_failed_shard_snapshots?: never; meta_thread_pool_concurrency?: never; snapshot_verification_concurrency?: never; verify_blob_contents?: never; }) | All values in `body` will be added to the request body. | +| `index_snapshot_verification_concurrency` | [integer](./integer.md) | The maximum number of index snapshots to verify concurrently within each index verification. | +| `index_verification_concurrency` | [integer](./integer.md) | The number of indices to verify concurrently. The default behavior is to use the entire `snapshot_meta` thread pool. | +| `max_bytes_per_sec` | string | If `verify_blob_contents` is `true`, this parameter specifies the maximum amount of data that Elasticsearch will read from the repository every second. | +| `max_failed_shard_snapshots` | [integer](./integer.md) | The number of shard snapshot failures to track during integrity verification, in order to avoid excessive resource usage. If your repository contains more than this number of shard snapshot failures, the verification will fail. | +| `meta_thread_pool_concurrency` | [integer](./integer.md) | The maximum number of snapshot metadata operations to run concurrently. The default behavior is to use at most half of the `snapshot_meta` thread pool at once. | +| `name` | [Names](./Names.md) | The name of the snapshot repository. | +| `querystring` | { [key: string]: any; } & { name?: never; blob_thread_pool_concurrency?: never; index_snapshot_verification_concurrency?: never; index_verification_concurrency?: never; max_bytes_per_sec?: never; max_failed_shard_snapshots?: never; meta_thread_pool_concurrency?: never; snapshot_verification_concurrency?: never; verify_blob_contents?: never; } | All values in `querystring` will be added to the request querystring. | +| `snapshot_verification_concurrency` | [integer](./integer.md) | The number of snapshots to verify concurrently. The default behavior is to use at most half of the `snapshot_meta` thread pool at once. | +| `verify_blob_contents` | boolean | Indicates whether to verify the checksum of every data blob in the repository. If this feature is enabled, Elasticsearch will read the entire repository contents, which may be extremely slow and expensive. | diff --git a/docs/reference/api/SnapshotRepositoryVerifyIntegrityResponse.md b/docs/reference/api/SnapshotRepositoryVerifyIntegrityResponse.md new file mode 100644 index 000000000..537332527 --- /dev/null +++ b/docs/reference/api/SnapshotRepositoryVerifyIntegrityResponse.md @@ -0,0 +1,4 @@ +## `SnapshotRepositoryVerifyIntegrityResponse` +::: +type SnapshotRepositoryVerifyIntegrityResponse = any; +::: diff --git a/docs/reference/api/SnapshotRestoreRequest.md b/docs/reference/api/SnapshotRestoreRequest.md new file mode 100644 index 000000000..3dda082aa --- /dev/null +++ b/docs/reference/api/SnapshotRestoreRequest.md @@ -0,0 +1,20 @@ +## Interface `SnapshotRestoreRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { repository?: never; snapshot?: never; master_timeout?: never; wait_for_completion?: never; feature_states?: never; ignore_index_settings?: never; ignore_unavailable?: never; include_aliases?: never; include_global_state?: never; index_settings?: never; indices?: never; partial?: never; rename_pattern?: never; rename_replacement?: never; }) | All values in `body` will be added to the request body. | +| `feature_states` | string[] | The feature states to restore. If `include_global_state` is `true`, the request restores all feature states in the snapshot by default. If `include_global_state` is `false`, the request restores no feature states by default. Note that specifying an empty array will result in the default behavior. To restore no feature states, regardless of the `include_global_state` value, specify an array containing only the value `none` ( `["none"]`). | +| `ignore_index_settings` | string[] | The index settings to not restore from the snapshot. You can't use this option to ignore `index.number_of_shards`. For data streams, this option applies only to restored backing indices. New backing indices are configured using the data stream's matching index template. | +| `ignore_unavailable` | boolean | If `true`, the request ignores any index or data stream in indices that's missing from the snapshot. If `false`, the request returns an error for any missing index or data stream. | +| `include_aliases` | boolean | If `true`, the request restores aliases for any restored data streams and indices. If `false`, the request doesn’t restore aliases. | +| `include_global_state` | boolean | If `true`, restore the cluster state. The cluster state includes: * Persistent cluster settings * Index templates * Legacy index templates * Ingest pipelines * Index lifecycle management (ILM) policies * Stored scripts * For snapshots taken after 7.12.0, feature states If `include_global_state` is `true`, the restore operation merges the legacy index templates in your cluster with the templates contained in the snapshot, replacing any existing ones whose name matches one in the snapshot. It completely removes all persistent settings, non-legacy index templates, ingest pipelines, and ILM lifecycle policies that exist in your cluster and replaces them with the corresponding items from the snapshot. Use the `feature_states` parameter to configure how feature states are restored. If `include_global_state` is `true` and a snapshot was created without a global state then the restore request will fail. | +| `index_settings` | [IndicesIndexSettings](./IndicesIndexSettings.md) | Index settings to add or change in restored indices, including backing indices. You can't use this option to change `index.number_of_shards`. For data streams, this option applies only to restored backing indices. New backing indices are configured using the data stream's matching index template. | +| `indices` | [Indices](./Indices.md) | A comma-separated list of indices and data streams to restore. It supports a multi-target syntax. The default behavior is all regular indices and regular data streams in the snapshot. You can't use this parameter to restore system indices or system data streams. Use `feature_states` instead. | +| `master_timeout` | [Duration](./Duration.md) | The period to wait for the master node. If the master node is not available before the timeout expires, the request fails and returns an error. To indicate that the request should never timeout, set it to `-1`. | +| `partial` | boolean | If `false`, the entire restore operation will fail if one or more indices included in the snapshot do not have all primary shards available. If true, it allows restoring a partial snapshot of indices with unavailable shards. Only shards that were successfully included in the snapshot will be restored. All missing shards will be recreated as empty. | +| `querystring` | { [key: string]: any; } & { repository?: never; snapshot?: never; master_timeout?: never; wait_for_completion?: never; feature_states?: never; ignore_index_settings?: never; ignore_unavailable?: never; include_aliases?: never; include_global_state?: never; index_settings?: never; indices?: never; partial?: never; rename_pattern?: never; rename_replacement?: never; } | All values in `querystring` will be added to the request querystring. | +| `rename_pattern` | string | A rename pattern to apply to restored data streams and indices. Data streams and indices matching the rename pattern will be renamed according to `rename_replacement`. The rename pattern is applied as defined by the regular expression that supports referencing the original text, according to the `appendReplacement` logic. | +| `rename_replacement` | string | The rename replacement string that is used with the `rename_pattern`. | +| `repository` | [Name](./Name.md) | The name of the repository to restore a snapshot from. | +| `snapshot` | [Name](./Name.md) | The name of the snapshot to restore. | +| `wait_for_completion` | boolean | If `true`, the request returns a response when the restore operation completes. The operation is complete when it finishes all attempts to recover primary shards for restored indices. This applies even if one or more of the recovery attempts fail. If `false`, the request returns a response when the restore operation initializes. | diff --git a/docs/reference/api/SnapshotRestoreResponse.md b/docs/reference/api/SnapshotRestoreResponse.md new file mode 100644 index 000000000..4f17d7cf3 --- /dev/null +++ b/docs/reference/api/SnapshotRestoreResponse.md @@ -0,0 +1,6 @@ +## Interface `SnapshotRestoreResponse` + +| Name | Type | Description | +| - | - | - | +| `accepted` | boolean |   | +| `snapshot` | [SnapshotRestoreSnapshotRestore](./SnapshotRestoreSnapshotRestore.md) |   | diff --git a/docs/reference/api/SnapshotRestoreSnapshotRestore.md b/docs/reference/api/SnapshotRestoreSnapshotRestore.md new file mode 100644 index 000000000..fc7e95539 --- /dev/null +++ b/docs/reference/api/SnapshotRestoreSnapshotRestore.md @@ -0,0 +1,7 @@ +## Interface `SnapshotRestoreSnapshotRestore` + +| Name | Type | Description | +| - | - | - | +| `indices` | [IndexName](./IndexName.md)[] |   | +| `shards` | [ShardStatistics](./ShardStatistics.md) |   | +| `snapshot` | string |   | diff --git a/docs/reference/api/SnapshotS3Repository.md b/docs/reference/api/SnapshotS3Repository.md new file mode 100644 index 000000000..f3e408b0b --- /dev/null +++ b/docs/reference/api/SnapshotS3Repository.md @@ -0,0 +1,6 @@ +## Interface `SnapshotS3Repository` + +| Name | Type | Description | +| - | - | - | +| `settings` | [SnapshotS3RepositorySettings](./SnapshotS3RepositorySettings.md) | The repository settings. NOTE: In addition to the specified settings, you can also use all non-secure client settings in the repository settings. In this case, the client settings found in the repository settings will be merged with those of the named client used by the repository. Conflicts between client and repository settings are resolved by the repository settings taking precedence over client settings. | +| `type` | 's3' | The S3 repository type. | diff --git a/docs/reference/api/SnapshotS3RepositorySettings.md b/docs/reference/api/SnapshotS3RepositorySettings.md new file mode 100644 index 000000000..1380494d9 --- /dev/null +++ b/docs/reference/api/SnapshotS3RepositorySettings.md @@ -0,0 +1,19 @@ +## Interface `SnapshotS3RepositorySettings` + +| Name | Type | Description | +| - | - | - | +| `"throttled_delete_retry.delay_increment"` | [Duration](./Duration.md) | The delay before the first retry and the amount the delay is incremented by on each subsequent retry. The default is 50ms and the minimum is 0ms. | +| `"throttled_delete_retry.maximum_delay"` | [Duration](./Duration.md) | The upper bound on how long the delays between retries will grow to. The default is 5s and the minimum is 0ms. | +| `"throttled_delete_retry.maximum_number_of_retries"` | [integer](./integer.md) | The number times to retry a throttled snapshot deletion. The default is 10 and the minimum value is 0 which will disable retries altogether. Note that if retries are enabled in the Azure client, each of these retries comprises that many client-level retries. | +| `base_path` | string | The path to the repository data within its bucket. It defaults to an empty string, meaning that the repository is at the root of the bucket. The value of this setting should not start or end with a forward slash ( `/`). NOTE: Don't set base_path when configuring a snapshot repository for Elastic Cloud Enterprise. Elastic Cloud Enterprise automatically generates the `base_path` for each deployment so that multiple deployments may share the same bucket. | +| `bucket` | string | The name of the S3 bucket to use for snapshots. The bucket name must adhere to Amazon's S3 bucket naming rules. | +| `buffer_size` | [ByteSize](./ByteSize.md) | The minimum threshold below which the chunk is uploaded using a single request. Beyond this threshold, the S3 repository will use the AWS Multipart Upload API to split the chunk into several parts, each of `buffer_size` length, and to upload each part in its own request. Note that setting a buffer size lower than 5mb is not allowed since it will prevent the use of the Multipart API and may result in upload errors. It is also not possible to set a buffer size greater than 5gb as it is the maximum upload size allowed by S3. Defaults to `100mb` or 5% of JVM heap, whichever is smaller. | +| `canned_acl` | string | The S3 repository supports all S3 canned ACLs: `private`, `public-read`, `public-read-write`, `authenticated-read`, `log-delivery-write`, `bucket-owner-read`, `bucket-owner-full-control`. You could specify a canned ACL using the `canned_acl` setting. When the S3 repository creates buckets and objects, it adds the canned ACL into the buckets and objects. | +| `client` | string | The name of the S3 client to use to connect to S3. | +| `delete_objects_max_size` | [integer](./integer.md) | The maxmimum batch size, between 1 and 1000, used for `DeleteObjects` requests. Defaults to 1000 which is the maximum number supported by the AWS DeleteObjects API. | +| `get_register_retry_delay` | [Duration](./Duration.md) | The time to wait before trying again if an attempt to read a linearizable register fails. | +| `max_multipart_parts` | [integer](./integer.md) | The maximum number of parts that Elasticsearch will write during a multipart upload of a single object. Files which are larger than `buffer_size × max_multipart_parts` will be chunked into several smaller objects. Elasticsearch may also split a file across multiple objects to satisfy other constraints such as the `chunk_size` limit. Defaults to `10000` which is the maximum number of parts in a multipart upload in AWS S3. | +| `max_multipart_upload_cleanup_size` | [integer](./integer.md) | The maximum number of possibly-dangling multipart uploads to clean up in each batch of snapshot deletions. Defaults to 1000 which is the maximum number supported by the AWS ListMultipartUploads API. If set to `0`, Elasticsearch will not attempt to clean up dangling multipart uploads. | +| `readonly` | boolean | If true, the repository is read-only. The cluster can retrieve and restore snapshots from the repository but not write to the repository or create snapshots in it. Only a cluster with write access can create snapshots in the repository. All other clusters connected to the repository should have the `readonly` parameter set to `true`. If `false`, the cluster can write to the repository and create snapshots in it. IMPORTANT: If you register the same snapshot repository with multiple clusters, only one cluster should have write access to the repository. Having multiple clusters write to the repository at the same time risks corrupting the contents of the repository. | +| `server_side_encryption` | boolean | When set to `true`, files are encrypted on server side using an AES256 algorithm. | +| `storage_class` | string | The S3 storage class for objects written to the repository. Values may be `standard`, `reduced_redundancy`, `standard_ia`, `onezone_ia`, and `intelligent_tiering`. | diff --git a/docs/reference/api/SnapshotShardsStats.md b/docs/reference/api/SnapshotShardsStats.md new file mode 100644 index 000000000..b584cbaf5 --- /dev/null +++ b/docs/reference/api/SnapshotShardsStats.md @@ -0,0 +1,10 @@ +## Interface `SnapshotShardsStats` + +| Name | Type | Description | +| - | - | - | +| `done` | [long](./long.md) | The number of shards that initialized, started, and finalized successfully. | +| `failed` | [long](./long.md) | The number of shards that failed to be included in the snapshot. | +| `finalizing` | [long](./long.md) | The number of shards that are finalizing but are not done. | +| `initializing` | [long](./long.md) | The number of shards that are still initializing. | +| `started` | [long](./long.md) | The number of shards that have started but are not finalized. | +| `total` | [long](./long.md) | The total number of shards included in the snapshot. | diff --git a/docs/reference/api/SnapshotShardsStatsStage.md b/docs/reference/api/SnapshotShardsStatsStage.md new file mode 100644 index 000000000..6b55288a0 --- /dev/null +++ b/docs/reference/api/SnapshotShardsStatsStage.md @@ -0,0 +1,4 @@ +## `SnapshotShardsStatsStage` +::: +type SnapshotShardsStatsStage = 'DONE' | 'FAILURE' | 'FINALIZE' | 'INIT' | 'STARTED'; +::: diff --git a/docs/reference/api/SnapshotShardsStatsSummary.md b/docs/reference/api/SnapshotShardsStatsSummary.md new file mode 100644 index 000000000..c9273ebd7 --- /dev/null +++ b/docs/reference/api/SnapshotShardsStatsSummary.md @@ -0,0 +1,9 @@ +## Interface `SnapshotShardsStatsSummary` + +| Name | Type | Description | +| - | - | - | +| `incremental` | [SnapshotShardsStatsSummaryItem](./SnapshotShardsStatsSummaryItem.md) |   | +| `start_time_in_millis` | [EpochTime](./EpochTime.md)<[UnitMillis](./UnitMillis.md)> |   | +| `time_in_millis` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> |   | +| `time` | [Duration](./Duration.md) |   | +| `total` | [SnapshotShardsStatsSummaryItem](./SnapshotShardsStatsSummaryItem.md) |   | diff --git a/docs/reference/api/SnapshotShardsStatsSummaryItem.md b/docs/reference/api/SnapshotShardsStatsSummaryItem.md new file mode 100644 index 000000000..71d2aec76 --- /dev/null +++ b/docs/reference/api/SnapshotShardsStatsSummaryItem.md @@ -0,0 +1,6 @@ +## Interface `SnapshotShardsStatsSummaryItem` + +| Name | Type | Description | +| - | - | - | +| `file_count` | [long](./long.md) |   | +| `size_in_bytes` | [long](./long.md) |   | diff --git a/docs/reference/api/SnapshotSharedFileSystemRepository.md b/docs/reference/api/SnapshotSharedFileSystemRepository.md new file mode 100644 index 000000000..0c3a03da1 --- /dev/null +++ b/docs/reference/api/SnapshotSharedFileSystemRepository.md @@ -0,0 +1,6 @@ +## Interface `SnapshotSharedFileSystemRepository` + +| Name | Type | Description | +| - | - | - | +| `settings` | [SnapshotSharedFileSystemRepositorySettings](./SnapshotSharedFileSystemRepositorySettings.md) | The repository settings. | +| `type` | 'fs' | The shared file system repository type. | diff --git a/docs/reference/api/SnapshotSharedFileSystemRepositorySettings.md b/docs/reference/api/SnapshotSharedFileSystemRepositorySettings.md new file mode 100644 index 000000000..321a1e3dd --- /dev/null +++ b/docs/reference/api/SnapshotSharedFileSystemRepositorySettings.md @@ -0,0 +1,7 @@ +## Interface `SnapshotSharedFileSystemRepositorySettings` + +| Name | Type | Description | +| - | - | - | +| `location` | string | The location of the shared filesystem used to store and retrieve snapshots. This location must be registered in the `path.repo` setting on all master and data nodes in the cluster. Unlike `path.repo`, this setting supports only a single file path. | +| `max_number_of_snapshots` | [integer](./integer.md) | The maximum number of snapshots the repository can contain. The default is `Integer.MAX_VALUE`, which is 2^31-1 or `2147483647`. | +| `readonly` | boolean | If `true`, the repository is read-only. The cluster can retrieve and restore snapshots from the repository but not write to the repository or create snapshots in it. Only a cluster with write access can create snapshots in the repository. All other clusters connected to the repository should have the `readonly` parameter set to `true`. If `false`, the cluster can write to the repository and create snapshots in it. IMPORTANT: If you register the same snapshot repository with multiple clusters, only one cluster should have write access to the repository. Having multiple clusters write to the repository at the same time risks corrupting the contents of the repository. | diff --git a/docs/reference/api/SnapshotSnapshotIndexStats.md b/docs/reference/api/SnapshotSnapshotIndexStats.md new file mode 100644 index 000000000..1f27d434a --- /dev/null +++ b/docs/reference/api/SnapshotSnapshotIndexStats.md @@ -0,0 +1,7 @@ +## Interface `SnapshotSnapshotIndexStats` + +| Name | Type | Description | +| - | - | - | +| `shards_stats` | [SnapshotShardsStats](./SnapshotShardsStats.md) |   | +| `shards` | Record |   | +| `stats` | [SnapshotSnapshotStats](./SnapshotSnapshotStats.md) |   | diff --git a/docs/reference/api/SnapshotSnapshotInfo.md b/docs/reference/api/SnapshotSnapshotInfo.md new file mode 100644 index 000000000..b4776b98e --- /dev/null +++ b/docs/reference/api/SnapshotSnapshotInfo.md @@ -0,0 +1,25 @@ +## Interface `SnapshotSnapshotInfo` + +| Name | Type | Description | +| - | - | - | +| `data_streams` | string[] |   | +| `duration_in_millis` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> |   | +| `duration` | [Duration](./Duration.md) |   | +| `end_time_in_millis` | [EpochTime](./EpochTime.md)<[UnitMillis](./UnitMillis.md)> |   | +| `end_time` | [DateTime](./DateTime.md) |   | +| `failures` | [SnapshotSnapshotShardFailure](./SnapshotSnapshotShardFailure.md)[] |   | +| `feature_states` | [SnapshotInfoFeatureState](./SnapshotInfoFeatureState.md)[] |   | +| `include_global_state` | boolean |   | +| `index_details` | Record<[IndexName](./IndexName.md), [SnapshotIndexDetails](./SnapshotIndexDetails.md)> |   | +| `indices` | [IndexName](./IndexName.md)[] |   | +| `metadata` | [Metadata](./Metadata.md) |   | +| `reason` | string |   | +| `repository` | [Name](./Name.md) |   | +| `shards` | [ShardStatistics](./ShardStatistics.md) |   | +| `snapshot` | [Name](./Name.md) |   | +| `start_time_in_millis` | [EpochTime](./EpochTime.md)<[UnitMillis](./UnitMillis.md)> |   | +| `start_time` | [DateTime](./DateTime.md) |   | +| `state` | string |   | +| `uuid` | [Uuid](./Uuid.md) |   | +| `version_id` | [VersionNumber](./VersionNumber.md) |   | +| `version` | [VersionString](./VersionString.md) |   | diff --git a/docs/reference/api/SnapshotSnapshotShardFailure.md b/docs/reference/api/SnapshotSnapshotShardFailure.md new file mode 100644 index 000000000..d0ffbb8be --- /dev/null +++ b/docs/reference/api/SnapshotSnapshotShardFailure.md @@ -0,0 +1,10 @@ +## Interface `SnapshotSnapshotShardFailure` + +| Name | Type | Description | +| - | - | - | +| `index_uuid` | [Id](./Id.md) |   | +| `index` | [IndexName](./IndexName.md) |   | +| `node_id` | [Id](./Id.md) |   | +| `reason` | string |   | +| `shard_id` | [Id](./Id.md) |   | +| `status` | string |   | diff --git a/docs/reference/api/SnapshotSnapshotShardsStatus.md b/docs/reference/api/SnapshotSnapshotShardsStatus.md new file mode 100644 index 000000000..27ac1ca47 --- /dev/null +++ b/docs/reference/api/SnapshotSnapshotShardsStatus.md @@ -0,0 +1,6 @@ +## Interface `SnapshotSnapshotShardsStatus` + +| Name | Type | Description | +| - | - | - | +| `stage` | [SnapshotShardsStatsStage](./SnapshotShardsStatsStage.md) |   | +| `stats` | [SnapshotShardsStatsSummary](./SnapshotShardsStatsSummary.md) |   | diff --git a/docs/reference/api/SnapshotSnapshotSort.md b/docs/reference/api/SnapshotSnapshotSort.md new file mode 100644 index 000000000..4f8704b36 --- /dev/null +++ b/docs/reference/api/SnapshotSnapshotSort.md @@ -0,0 +1,4 @@ +## `SnapshotSnapshotSort` +::: +type SnapshotSnapshotSort = 'start_time' | 'duration' | 'name' | 'index_count' | 'repository' | 'shard_count' | 'failed_shard_count'; +::: diff --git a/docs/reference/api/SnapshotSnapshotStats.md b/docs/reference/api/SnapshotSnapshotStats.md new file mode 100644 index 000000000..91f874c1d --- /dev/null +++ b/docs/reference/api/SnapshotSnapshotStats.md @@ -0,0 +1,9 @@ +## Interface `SnapshotSnapshotStats` + +| Name | Type | Description | +| - | - | - | +| `incremental` | [SnapshotFileCountSnapshotStats](./SnapshotFileCountSnapshotStats.md) | The number and size of files that still need to be copied as part of the incremental snapshot. For completed snapshots, this property indicates the number and size of files that were not already in the repository and were copied as part of the incremental snapshot. | +| `start_time_in_millis` | [EpochTime](./EpochTime.md)<[UnitMillis](./UnitMillis.md)> | The time, in milliseconds, when the snapshot creation process started. | +| `time_in_millis` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> | The total time, in milliseconds, that it took for the snapshot process to complete. | +| `time` | [Duration](./Duration.md) |   | +| `total` | [SnapshotFileCountSnapshotStats](./SnapshotFileCountSnapshotStats.md) | The total number and size of files that are referenced by the snapshot. | diff --git a/docs/reference/api/SnapshotSourceOnlyRepository.md b/docs/reference/api/SnapshotSourceOnlyRepository.md new file mode 100644 index 000000000..ec78b2ce7 --- /dev/null +++ b/docs/reference/api/SnapshotSourceOnlyRepository.md @@ -0,0 +1,6 @@ +## Interface `SnapshotSourceOnlyRepository` + +| Name | Type | Description | +| - | - | - | +| `settings` | [SnapshotSourceOnlyRepositorySettings](./SnapshotSourceOnlyRepositorySettings.md) | The repository settings. | +| `type` | 'source' | The source-only repository type. | diff --git a/docs/reference/api/SnapshotSourceOnlyRepositorySettings.md b/docs/reference/api/SnapshotSourceOnlyRepositorySettings.md new file mode 100644 index 000000000..06fbbfaa7 --- /dev/null +++ b/docs/reference/api/SnapshotSourceOnlyRepositorySettings.md @@ -0,0 +1,8 @@ +## Interface `SnapshotSourceOnlyRepositorySettings` + +| Name | Type | Description | +| - | - | - | +| `delegate_type` | string | The delegated repository type. For valid values, refer to the `type` parameter. Source repositories can use `settings` properties for its delegated repository type. | +| `max_number_of_snapshots` | [integer](./integer.md) | The maximum number of snapshots the repository can contain. The default is `Integer.MAX_VALUE`, which is 2^31-1 or `2147483647`. | +| `read_only` | boolean | If `true`, the repository is read-only. The cluster can retrieve and restore snapshots from the repository but not write to the repository or create snapshots in it. Only a cluster with write access can create snapshots in the repository. All other clusters connected to the repository should have the `readonly` parameter set to `true`. If `false`, the cluster can write to the repository and create snapshots in it. IMPORTANT: If you register the same snapshot repository with multiple clusters, only one cluster should have write access to the repository. Having multiple clusters write to the repository at the same time risks corrupting the contents of the repository. | +| `readonly` | boolean | If `true`, the repository is read-only. The cluster can retrieve and restore snapshots from the repository but not write to the repository or create snapshots in it. Only a cluster with write access can create snapshots in the repository. All other clusters connected to the repository should have the `readonly` parameter set to `true`. If `false`, the cluster can write to the repository and create snapshots in it. IMPORTANT: If you register the same snapshot repository with multiple clusters, only one cluster should have write access to the repository. Having multiple clusters write to the repository at the same time risks corrupting the contents of the repository. read_only | diff --git a/docs/reference/api/SnapshotStatus.md b/docs/reference/api/SnapshotStatus.md new file mode 100644 index 000000000..11cbcc9b0 --- /dev/null +++ b/docs/reference/api/SnapshotStatus.md @@ -0,0 +1,12 @@ +## Interface `SnapshotStatus` + +| Name | Type | Description | +| - | - | - | +| `include_global_state` | boolean | Indicates whether the current cluster state is included in the snapshot. | +| `indices` | Record |   | +| `repository` | string | The name of the repository that includes the snapshot. | +| `shards_stats` | [SnapshotShardsStats](./SnapshotShardsStats.md) | Statistics for the shards in the snapshot. | +| `snapshot` | string | The name of the snapshot. | +| `state` | string | The current snapshot state: * `FAILED`: The snapshot finished with an error and failed to store any data. * `STARTED`: The snapshot is currently running. * `SUCCESS`: The snapshot completed. | +| `stats` | [SnapshotSnapshotStats](./SnapshotSnapshotStats.md) | Details about the number ( `file_count`) and size ( `size_in_bytes`) of files included in the snapshot. | +| `uuid` | [Uuid](./Uuid.md) | The universally unique identifier (UUID) for the snapshot. | diff --git a/docs/reference/api/SnapshotStatusRequest.md b/docs/reference/api/SnapshotStatusRequest.md new file mode 100644 index 000000000..f00e6a9db --- /dev/null +++ b/docs/reference/api/SnapshotStatusRequest.md @@ -0,0 +1,10 @@ +## Interface `SnapshotStatusRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { repository?: never; snapshot?: never; ignore_unavailable?: never; master_timeout?: never; }) | All values in `body` will be added to the request body. | +| `ignore_unavailable` | boolean | If `false`, the request returns an error for any snapshots that are unavailable. If `true`, the request ignores snapshots that are unavailable, such as those that are corrupted or temporarily cannot be returned. | +| `master_timeout` | [Duration](./Duration.md) | The period to wait for the master node. If the master node is not available before the timeout expires, the request fails and returns an error. To indicate that the request should never timeout, set it to `-1`. | +| `querystring` | { [key: string]: any; } & { repository?: never; snapshot?: never; ignore_unavailable?: never; master_timeout?: never; } | All values in `querystring` will be added to the request querystring. | +| `repository` | [Name](./Name.md) | The snapshot repository name used to limit the request. It supports wildcards ( `*`) if `` isn't specified. | +| `snapshot` | [Names](./Names.md) | A comma-separated list of snapshots to retrieve status for. The default is currently running snapshots. Wildcards ( `*`) are not supported. | diff --git a/docs/reference/api/SnapshotStatusResponse.md b/docs/reference/api/SnapshotStatusResponse.md new file mode 100644 index 000000000..9de3a780b --- /dev/null +++ b/docs/reference/api/SnapshotStatusResponse.md @@ -0,0 +1,5 @@ +## Interface `SnapshotStatusResponse` + +| Name | Type | Description | +| - | - | - | +| `snapshots` | [SnapshotStatus](./SnapshotStatus.md)[] |   | diff --git a/docs/reference/api/SnapshotVerifyRepositoryCompactNodeInfo.md b/docs/reference/api/SnapshotVerifyRepositoryCompactNodeInfo.md new file mode 100644 index 000000000..3c6cf73ce --- /dev/null +++ b/docs/reference/api/SnapshotVerifyRepositoryCompactNodeInfo.md @@ -0,0 +1,5 @@ +## Interface `SnapshotVerifyRepositoryCompactNodeInfo` + +| Name | Type | Description | +| - | - | - | +| `name` | [Name](./Name.md) | A human-readable name for the node. You can set this name using the `node.name` property in `elasticsearch.yml`. The default value is the machine's hostname. | diff --git a/docs/reference/api/SnapshotVerifyRepositoryRequest.md b/docs/reference/api/SnapshotVerifyRepositoryRequest.md new file mode 100644 index 000000000..bad81c770 --- /dev/null +++ b/docs/reference/api/SnapshotVerifyRepositoryRequest.md @@ -0,0 +1,9 @@ +## Interface `SnapshotVerifyRepositoryRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { name?: never; master_timeout?: never; timeout?: never; }) | All values in `body` will be added to the request body. | +| `master_timeout` | [Duration](./Duration.md) | The period to wait for the master node. If the master node is not available before the timeout expires, the request fails and returns an error. To indicate that the request should never timeout, set it to `-1`. | +| `name` | [Name](./Name.md) | The name of the snapshot repository to verify. | +| `querystring` | { [key: string]: any; } & { name?: never; master_timeout?: never; timeout?: never; } | All values in `querystring` will be added to the request querystring. | +| `timeout` | [Duration](./Duration.md) | The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata. If no response is received before the timeout expires, the cluster metadata update still applies but the response will indicate that it was not completely acknowledged. To indicate that the request should never timeout, set it to `-1`. | diff --git a/docs/reference/api/SnapshotVerifyRepositoryResponse.md b/docs/reference/api/SnapshotVerifyRepositoryResponse.md new file mode 100644 index 000000000..36709b382 --- /dev/null +++ b/docs/reference/api/SnapshotVerifyRepositoryResponse.md @@ -0,0 +1,5 @@ +## Interface `SnapshotVerifyRepositoryResponse` + +| Name | Type | Description | +| - | - | - | +| `nodes` | Record | Information about the nodes connected to the snapshot repository. The key is the ID of the node. | diff --git a/docs/reference/api/SniffingTransport.md b/docs/reference/api/SniffingTransport.md new file mode 100644 index 000000000..5b9d59fd3 --- /dev/null +++ b/docs/reference/api/SniffingTransport.md @@ -0,0 +1,10 @@ +## `SniffingTransport` + +### Constructor + + +### Methods + +| Name | Signature | Description | +| - | - | - | +| `sniff` | `sniff(opts: [SniffOptions](./SniffOptions.md)): void;` |   | \ No newline at end of file diff --git a/docs/reference/api/Sort.md b/docs/reference/api/Sort.md new file mode 100644 index 000000000..6f83b9b93 --- /dev/null +++ b/docs/reference/api/Sort.md @@ -0,0 +1,4 @@ +## `Sort` +::: +type Sort = [SortCombinations](./SortCombinations.md) | [SortCombinations](./SortCombinations.md)[]; +::: diff --git a/docs/reference/api/SortCombinations.md b/docs/reference/api/SortCombinations.md new file mode 100644 index 000000000..262319cb8 --- /dev/null +++ b/docs/reference/api/SortCombinations.md @@ -0,0 +1,4 @@ +## `SortCombinations` +::: +type SortCombinations = [Field](./Field.md) | [SortOptions](./SortOptions.md); +::: diff --git a/docs/reference/api/SortMode.md b/docs/reference/api/SortMode.md new file mode 100644 index 000000000..f7d8b1c4c --- /dev/null +++ b/docs/reference/api/SortMode.md @@ -0,0 +1,4 @@ +## `SortMode` +::: +type SortMode = 'min' | 'max' | 'sum' | 'avg' | 'median'; +::: diff --git a/docs/reference/api/SortOptions.md b/docs/reference/api/SortOptions.md new file mode 100644 index 000000000..42c9f76fe --- /dev/null +++ b/docs/reference/api/SortOptions.md @@ -0,0 +1,4 @@ +## `SortOptions` +::: +type SortOptions = [SortOptionsKeys](./SortOptionsKeys.md) & { [property: string]: [FieldSort](./FieldSort.md) | [SortOrder](./SortOrder.md) | [ScoreSort](./ScoreSort.md) | [GeoDistanceSort](./GeoDistanceSort.md) | [ScriptSort](./ScriptSort.md);}; +::: diff --git a/docs/reference/api/SortOptionsKeys.md b/docs/reference/api/SortOptionsKeys.md new file mode 100644 index 000000000..44355d4e7 --- /dev/null +++ b/docs/reference/api/SortOptionsKeys.md @@ -0,0 +1,8 @@ +## Interface `SortOptionsKeys` + +| Name | Type | Description | +| - | - | - | +| `_doc` | [ScoreSort](./ScoreSort.md) |   | +| `_geo_distance` | [GeoDistanceSort](./GeoDistanceSort.md) |   | +| `_score` | [ScoreSort](./ScoreSort.md) |   | +| `_script` | [ScriptSort](./ScriptSort.md) |   | diff --git a/docs/reference/api/SortOrder.md b/docs/reference/api/SortOrder.md new file mode 100644 index 000000000..0ecea72b5 --- /dev/null +++ b/docs/reference/api/SortOrder.md @@ -0,0 +1,4 @@ +## `SortOrder` +::: +type SortOrder = 'asc' | 'desc'; +::: diff --git a/docs/reference/api/SortResults.md b/docs/reference/api/SortResults.md new file mode 100644 index 000000000..67ecd1715 --- /dev/null +++ b/docs/reference/api/SortResults.md @@ -0,0 +1,4 @@ +## `SortResults` +::: +type SortResults = [FieldValue](./FieldValue.md)[]; +::: diff --git a/docs/reference/api/SpecUtilsAdditionalProperties.md b/docs/reference/api/SpecUtilsAdditionalProperties.md new file mode 100644 index 000000000..8ce8c023e --- /dev/null +++ b/docs/reference/api/SpecUtilsAdditionalProperties.md @@ -0,0 +1,4 @@ +## Interface `SpecUtilsAdditionalProperties` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/SpecUtilsAdditionalProperty.md b/docs/reference/api/SpecUtilsAdditionalProperty.md new file mode 100644 index 000000000..127f0de0a --- /dev/null +++ b/docs/reference/api/SpecUtilsAdditionalProperty.md @@ -0,0 +1,4 @@ +## Interface `SpecUtilsAdditionalProperty` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/SpecUtilsBaseNode.md b/docs/reference/api/SpecUtilsBaseNode.md new file mode 100644 index 000000000..875e950a0 --- /dev/null +++ b/docs/reference/api/SpecUtilsBaseNode.md @@ -0,0 +1,10 @@ +## Interface `SpecUtilsBaseNode` + +| Name | Type | Description | +| - | - | - | +| `attributes` | Record |   | +| `host` | [Host](./Host.md) |   | +| `ip` | [Ip](./Ip.md) |   | +| `name` | [Name](./Name.md) |   | +| `roles` | [NodeRoles](./NodeRoles.md) |   | +| `transport_address` | [TransportAddress](./TransportAddress.md) |   | diff --git a/docs/reference/api/SpecUtilsCommonCatQueryParameters.md b/docs/reference/api/SpecUtilsCommonCatQueryParameters.md new file mode 100644 index 000000000..a1ff52d4b --- /dev/null +++ b/docs/reference/api/SpecUtilsCommonCatQueryParameters.md @@ -0,0 +1,7 @@ +## Interface `SpecUtilsCommonCatQueryParameters` + +| Name | Type | Description | +| - | - | - | +| `format` | string | Specifies the format to return the columnar data in, can be set to `text`, `json`, `cbor`, `yaml`, or `smile`. | +| `help` | boolean | When set to `true` will output available columns. This option can't be combined with any other query string option. | +| `v` | boolean | When set to `true` will enable verbose output. | diff --git a/docs/reference/api/SpecUtilsCommonQueryParameters.md b/docs/reference/api/SpecUtilsCommonQueryParameters.md new file mode 100644 index 000000000..4675fca86 --- /dev/null +++ b/docs/reference/api/SpecUtilsCommonQueryParameters.md @@ -0,0 +1,8 @@ +## Interface `SpecUtilsCommonQueryParameters` + +| Name | Type | Description | +| - | - | - | +| `error_trace` | boolean | When set to `true` Elasticsearch will include the full stack trace of errors when they occur. | +| `filter_path` | string | string[] | Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. | +| `human` | boolean | When set to `true` will return statistics in a format suitable for humans. For example `"exists_time": "1h"` for humans and `"eixsts_time_in_millis": 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines. | +| `pretty` | boolean | If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. | diff --git a/docs/reference/api/SpecUtilsNullValue.md b/docs/reference/api/SpecUtilsNullValue.md new file mode 100644 index 000000000..29ac73708 --- /dev/null +++ b/docs/reference/api/SpecUtilsNullValue.md @@ -0,0 +1,4 @@ +## `SpecUtilsNullValue` +::: +type SpecUtilsNullValue = null; +::: diff --git a/docs/reference/api/SpecUtilsOverloadOf.md b/docs/reference/api/SpecUtilsOverloadOf.md new file mode 100644 index 000000000..6898cfb25 --- /dev/null +++ b/docs/reference/api/SpecUtilsOverloadOf.md @@ -0,0 +1,4 @@ +## Interface `SpecUtilsOverloadOf` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/SpecUtilsPipeSeparatedFlags.md b/docs/reference/api/SpecUtilsPipeSeparatedFlags.md new file mode 100644 index 000000000..0874e8188 --- /dev/null +++ b/docs/reference/api/SpecUtilsPipeSeparatedFlags.md @@ -0,0 +1,4 @@ +## `SpecUtilsPipeSeparatedFlags` +::: +type SpecUtilsPipeSeparatedFlags = T | string; +::: diff --git a/docs/reference/api/SpecUtilsStringified.md b/docs/reference/api/SpecUtilsStringified.md new file mode 100644 index 000000000..694904112 --- /dev/null +++ b/docs/reference/api/SpecUtilsStringified.md @@ -0,0 +1,4 @@ +## `SpecUtilsStringified` +::: +type SpecUtilsStringified = T | string; +::: diff --git a/docs/reference/api/SpecUtilsWithNullValue.md b/docs/reference/api/SpecUtilsWithNullValue.md new file mode 100644 index 000000000..9a2267e14 --- /dev/null +++ b/docs/reference/api/SpecUtilsWithNullValue.md @@ -0,0 +1,4 @@ +## `SpecUtilsWithNullValue` +::: +type SpecUtilsWithNullValue = T | [SpecUtilsNullValue](./SpecUtilsNullValue.md); +::: diff --git a/docs/reference/api/Sql.md b/docs/reference/api/Sql.md new file mode 100644 index 000000000..b296ecc19 --- /dev/null +++ b/docs/reference/api/Sql.md @@ -0,0 +1,20 @@ +## `Sql` + +### Constructor + +::: +new Sql(transport: [Transport](./Transport.md)); +::: + +### Properties + +| Name | Type | Description | +| - | - | - | +| `acceptedParams` | Record |   | +| `transport` | [Transport](./Transport.md) |   | + +### Methods + +| Name | Signature | Description | +| - | - | - | +| `clearCursor` | `clearCursor(this: [That](./That.md), params: [SqlClearCursorRequest](./SqlClearCursorRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SqlClearCursorResponse](./SqlClearCursorResponse.md)>;` | Clear an SQL search cursor. || `clearCursor` | `clearCursor(this: [That](./That.md), params: [SqlClearCursorRequest](./SqlClearCursorRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SqlClearCursorResponse](./SqlClearCursorResponse.md), unknown>>;` |   || `clearCursor` | `clearCursor(this: [That](./That.md), params: [SqlClearCursorRequest](./SqlClearCursorRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SqlClearCursorResponse](./SqlClearCursorResponse.md)>;` |   || `deleteAsync` | `deleteAsync(this: [That](./That.md), params: [SqlDeleteAsyncRequest](./SqlDeleteAsyncRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SqlDeleteAsyncResponse](./SqlDeleteAsyncResponse.md)>;` | Delete an async SQL search. Delete an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it. If the Elasticsearch security features are enabled, only the following users can use this API to delete a search: * Users with the `cancel_task` cluster privilege. * The user who first submitted the search. || `deleteAsync` | `deleteAsync(this: [That](./That.md), params: [SqlDeleteAsyncRequest](./SqlDeleteAsyncRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SqlDeleteAsyncResponse](./SqlDeleteAsyncResponse.md), unknown>>;` |   || `deleteAsync` | `deleteAsync(this: [That](./That.md), params: [SqlDeleteAsyncRequest](./SqlDeleteAsyncRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SqlDeleteAsyncResponse](./SqlDeleteAsyncResponse.md)>;` |   || `getAsync` | `getAsync(this: [That](./That.md), params: [SqlGetAsyncRequest](./SqlGetAsyncRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SqlGetAsyncResponse](./SqlGetAsyncResponse.md)>;` | Get async SQL search results. Get the current status and available results for an async SQL search or stored synchronous SQL search. If the Elasticsearch security features are enabled, only the user who first submitted the SQL search can retrieve the search using this API. || `getAsync` | `getAsync(this: [That](./That.md), params: [SqlGetAsyncRequest](./SqlGetAsyncRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SqlGetAsyncResponse](./SqlGetAsyncResponse.md), unknown>>;` |   || `getAsync` | `getAsync(this: [That](./That.md), params: [SqlGetAsyncRequest](./SqlGetAsyncRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SqlGetAsyncResponse](./SqlGetAsyncResponse.md)>;` |   || `getAsyncStatus` | `getAsyncStatus(this: [That](./That.md), params: [SqlGetAsyncStatusRequest](./SqlGetAsyncStatusRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SqlGetAsyncStatusResponse](./SqlGetAsyncStatusResponse.md)>;` | Get the async SQL search status. Get the current status of an async SQL search or a stored synchronous SQL search. || `getAsyncStatus` | `getAsyncStatus(this: [That](./That.md), params: [SqlGetAsyncStatusRequest](./SqlGetAsyncStatusRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SqlGetAsyncStatusResponse](./SqlGetAsyncStatusResponse.md), unknown>>;` |   || `getAsyncStatus` | `getAsyncStatus(this: [That](./That.md), params: [SqlGetAsyncStatusRequest](./SqlGetAsyncStatusRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SqlGetAsyncStatusResponse](./SqlGetAsyncStatusResponse.md)>;` |   || `query` | `query(this: [That](./That.md), params?: [SqlQueryRequest](./SqlQueryRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SqlQueryResponse](./SqlQueryResponse.md)>;` | Get SQL search results. Run an SQL request. || `query` | `query(this: [That](./That.md), params?: [SqlQueryRequest](./SqlQueryRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SqlQueryResponse](./SqlQueryResponse.md), unknown>>;` |   || `query` | `query(this: [That](./That.md), params?: [SqlQueryRequest](./SqlQueryRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SqlQueryResponse](./SqlQueryResponse.md)>;` |   || `translate` | `translate(this: [That](./That.md), params: [SqlTranslateRequest](./SqlTranslateRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SqlTranslateResponse](./SqlTranslateResponse.md)>;` | Translate SQL into Elasticsearch queries. Translate an SQL search into a search API request containing Query DSL. It accepts the same request body parameters as the SQL search API, excluding `cursor`. || `translate` | `translate(this: [That](./That.md), params: [SqlTranslateRequest](./SqlTranslateRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SqlTranslateResponse](./SqlTranslateResponse.md), unknown>>;` |   || `translate` | `translate(this: [That](./That.md), params: [SqlTranslateRequest](./SqlTranslateRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SqlTranslateResponse](./SqlTranslateResponse.md)>;` |   | \ No newline at end of file diff --git a/docs/reference/api/SqlClearCursorRequest.md b/docs/reference/api/SqlClearCursorRequest.md new file mode 100644 index 000000000..71cc79ac6 --- /dev/null +++ b/docs/reference/api/SqlClearCursorRequest.md @@ -0,0 +1,7 @@ +## Interface `SqlClearCursorRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { cursor?: never; }) | All values in `body` will be added to the request body. | +| `cursor` | string | Cursor to clear. | +| `querystring` | { [key: string]: any; } & { cursor?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/SqlClearCursorResponse.md b/docs/reference/api/SqlClearCursorResponse.md new file mode 100644 index 000000000..4d8e9d682 --- /dev/null +++ b/docs/reference/api/SqlClearCursorResponse.md @@ -0,0 +1,5 @@ +## Interface `SqlClearCursorResponse` + +| Name | Type | Description | +| - | - | - | +| `succeeded` | boolean |   | diff --git a/docs/reference/api/SqlColumn.md b/docs/reference/api/SqlColumn.md new file mode 100644 index 000000000..cb85b6ba5 --- /dev/null +++ b/docs/reference/api/SqlColumn.md @@ -0,0 +1,6 @@ +## Interface `SqlColumn` + +| Name | Type | Description | +| - | - | - | +| `name` | [Name](./Name.md) |   | +| `type` | string |   | diff --git a/docs/reference/api/SqlDeleteAsyncRequest.md b/docs/reference/api/SqlDeleteAsyncRequest.md new file mode 100644 index 000000000..70361ce89 --- /dev/null +++ b/docs/reference/api/SqlDeleteAsyncRequest.md @@ -0,0 +1,7 @@ +## Interface `SqlDeleteAsyncRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { id?: never; }) | All values in `body` will be added to the request body. | +| `id` | [Id](./Id.md) | The identifier for the search. | +| `querystring` | { [key: string]: any; } & { id?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/SqlDeleteAsyncResponse.md b/docs/reference/api/SqlDeleteAsyncResponse.md new file mode 100644 index 000000000..c584c510f --- /dev/null +++ b/docs/reference/api/SqlDeleteAsyncResponse.md @@ -0,0 +1,4 @@ +## `SqlDeleteAsyncResponse` +::: +type SqlDeleteAsyncResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); +::: diff --git a/docs/reference/api/SqlGetAsyncRequest.md b/docs/reference/api/SqlGetAsyncRequest.md new file mode 100644 index 000000000..ba2920a7a --- /dev/null +++ b/docs/reference/api/SqlGetAsyncRequest.md @@ -0,0 +1,11 @@ +## Interface `SqlGetAsyncRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { id?: never; delimiter?: never; format?: never; keep_alive?: never; wait_for_completion_timeout?: never; }) | All values in `body` will be added to the request body. | +| `delimiter` | string | The separator for CSV results. The API supports this parameter only for CSV responses. | +| `format` | string | The format for the response. You must specify a format using this parameter or the `Accept` HTTP header. If you specify both, the API uses this parameter. | +| `id` | [Id](./Id.md) | The identifier for the search. | +| `keep_alive` | [Duration](./Duration.md) | The retention period for the search and its results. It defaults to the `keep_alive` period for the original SQL search. | +| `querystring` | { [key: string]: any; } & { id?: never; delimiter?: never; format?: never; keep_alive?: never; wait_for_completion_timeout?: never; } | All values in `querystring` will be added to the request querystring. | +| `wait_for_completion_timeout` | [Duration](./Duration.md) | The period to wait for complete results. It defaults to no timeout, meaning the request waits for complete search results. | diff --git a/docs/reference/api/SqlGetAsyncResponse.md b/docs/reference/api/SqlGetAsyncResponse.md new file mode 100644 index 000000000..3bb3d9dd8 --- /dev/null +++ b/docs/reference/api/SqlGetAsyncResponse.md @@ -0,0 +1,10 @@ +## Interface `SqlGetAsyncResponse` + +| Name | Type | Description | +| - | - | - | +| `columns` | [SqlColumn](./SqlColumn.md)[] | Column headings for the search results. Each object is a column. | +| `cursor` | string | The cursor for the next set of paginated results. For CSV, TSV, and TXT responses, this value is returned in the `Cursor` HTTP header. | +| `id` | [Id](./Id.md) | Identifier for the search. This value is returned only for async and saved synchronous searches. For CSV, TSV, and TXT responses, this value is returned in the `Async-ID` HTTP header. | +| `is_partial` | boolean | If `true`, the response does not contain complete search results. If `is_partial` is `true` and `is_running` is `true`, the search is still running. If `is_partial` is `true` but `is_running` is `false`, the results are partial due to a failure or timeout. This value is returned only for async and saved synchronous searches. For CSV, TSV, and TXT responses, this value is returned in the `Async-partial` HTTP header. | +| `is_running` | boolean | If `true`, the search is still running. If `false`, the search has finished. This value is returned only for async and saved synchronous searches. For CSV, TSV, and TXT responses, this value is returned in the `Async-partial` HTTP header. | +| `rows` | [SqlRow](./SqlRow.md)[] | The values for the search results. | diff --git a/docs/reference/api/SqlGetAsyncStatusRequest.md b/docs/reference/api/SqlGetAsyncStatusRequest.md new file mode 100644 index 000000000..4b88b1455 --- /dev/null +++ b/docs/reference/api/SqlGetAsyncStatusRequest.md @@ -0,0 +1,7 @@ +## Interface `SqlGetAsyncStatusRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { id?: never; }) | All values in `body` will be added to the request body. | +| `id` | [Id](./Id.md) | The identifier for the search. | +| `querystring` | { [key: string]: any; } & { id?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/SqlGetAsyncStatusResponse.md b/docs/reference/api/SqlGetAsyncStatusResponse.md new file mode 100644 index 000000000..8e9874a9d --- /dev/null +++ b/docs/reference/api/SqlGetAsyncStatusResponse.md @@ -0,0 +1,10 @@ +## Interface `SqlGetAsyncStatusResponse` + +| Name | Type | Description | +| - | - | - | +| `completion_status` | [uint](./uint.md) | The HTTP status code for the search. The API returns this property only for completed searches. | +| `expiration_time_in_millis` | [EpochTime](./EpochTime.md)<[UnitMillis](./UnitMillis.md)> | The timestamp, in milliseconds since the Unix epoch, when Elasticsearch will delete the search and its results, even if the search is still running. | +| `id` | string | The identifier for the search. | +| `is_partial` | boolean | If `true`, the response does not contain complete search results. If `is_partial` is `true` and `is_running` is `true`, the search is still running. If `is_partial` is `true` but `is_running` is `false`, the results are partial due to a failure or timeout. | +| `is_running` | boolean | If `true`, the search is still running. If `false`, the search has finished. | +| `start_time_in_millis` | [EpochTime](./EpochTime.md)<[UnitMillis](./UnitMillis.md)> | The timestamp, in milliseconds since the Unix epoch, when the search started. The API returns this property only for running searches. | diff --git a/docs/reference/api/SqlQueryRequest.md b/docs/reference/api/SqlQueryRequest.md new file mode 100644 index 000000000..b2a1e0c1d --- /dev/null +++ b/docs/reference/api/SqlQueryRequest.md @@ -0,0 +1,24 @@ +## Interface `SqlQueryRequest` + +| Name | Type | Description | +| - | - | - | +| `allow_partial_search_results` | boolean | If `true`, the response has partial results when there are shard request timeouts or shard failures. If `false`, the API returns an error with no partial results. | +| `body` | string | ({ [key: string]: any; } & { format?: never; allow_partial_search_results?: never; catalog?: never; columnar?: never; cursor?: never; fetch_size?: never; field_multi_value_leniency?: never; filter?: never; index_using_frozen?: never; keep_alive?: never; keep_on_completion?: never; page_timeout?: never; params?: never; query?: never; request_timeout?: never; runtime_mappings?: never; time_zone?: never; wait_for_completion_timeout?: never; }) | All values in `body` will be added to the request body. | +| `catalog` | string | The default catalog (cluster) for queries. If unspecified, the queries execute on the data in the local cluster only. | +| `columnar` | boolean | If `true`, the results are in a columnar fashion: one row represents all the values of a certain column from the current page of results. The API supports this parameter only for CBOR, JSON, SMILE, and YAML responses. | +| `cursor` | string | The cursor used to retrieve a set of paginated results. If you specify a cursor, the API only uses the `columnar` and `time_zone` request body parameters. It ignores other request body parameters. | +| `fetch_size` | [integer](./integer.md) | The maximum number of rows (or entries) to return in one response. | +| `field_multi_value_leniency` | boolean | If `false`, the API returns an exception when encountering multiple values for a field. If `true`, the API is lenient and returns the first value from the array with no guarantee of consistent results. | +| `filter` | [QueryDslQueryContainer](./QueryDslQueryContainer.md) | The Elasticsearch query DSL for additional filtering. | +| `format` | [SqlQuerySqlFormat](./SqlQuerySqlFormat.md) | The format for the response. You can also specify a format using the `Accept` HTTP header. If you specify both this parameter and the `Accept` HTTP header, this parameter takes precedence. | +| `index_using_frozen` | boolean | If `true`, the search can run on frozen indices. | +| `keep_alive` | [Duration](./Duration.md) | The retention period for an async or saved synchronous search. | +| `keep_on_completion` | boolean | If `true`, Elasticsearch stores synchronous searches if you also specify the `wait_for_completion_timeout` parameter. If `false`, Elasticsearch only stores async searches that don't finish before the `wait_for_completion_timeout`. | +| `page_timeout` | [Duration](./Duration.md) | The minimum retention period for the scroll cursor. After this time period, a pagination request might fail because the scroll cursor is no longer available. Subsequent scroll requests prolong the lifetime of the scroll cursor by the duration of `page_timeout` in the scroll request. | +| `params` | Record | The values for parameters in the query. | +| `query` | string | The SQL query to run. | +| `querystring` | { [key: string]: any; } & { format?: never; allow_partial_search_results?: never; catalog?: never; columnar?: never; cursor?: never; fetch_size?: never; field_multi_value_leniency?: never; filter?: never; index_using_frozen?: never; keep_alive?: never; keep_on_completion?: never; page_timeout?: never; params?: never; query?: never; request_timeout?: never; runtime_mappings?: never; time_zone?: never; wait_for_completion_timeout?: never; } | All values in `querystring` will be added to the request querystring. | +| `request_timeout` | [Duration](./Duration.md) | The timeout before the request fails. | +| `runtime_mappings` | [MappingRuntimeFields](./MappingRuntimeFields.md) | One or more runtime fields for the search request. These fields take precedence over mapped fields with the same name. | +| `time_zone` | [TimeZone](./TimeZone.md) | The ISO-8601 time zone ID for the search. | +| `wait_for_completion_timeout` | [Duration](./Duration.md) | The period to wait for complete results. It defaults to no timeout, meaning the request waits for complete search results. If the search doesn't finish within this period, the search becomes async. To save a synchronous search, you must specify this parameter and the `keep_on_completion` parameter. | diff --git a/docs/reference/api/SqlQueryResponse.md b/docs/reference/api/SqlQueryResponse.md new file mode 100644 index 000000000..50c010248 --- /dev/null +++ b/docs/reference/api/SqlQueryResponse.md @@ -0,0 +1,10 @@ +## Interface `SqlQueryResponse` + +| Name | Type | Description | +| - | - | - | +| `columns` | [SqlColumn](./SqlColumn.md)[] | Column headings for the search results. Each object is a column. | +| `cursor` | string | The cursor for the next set of paginated results. For CSV, TSV, and TXT responses, this value is returned in the `Cursor` HTTP header. | +| `id` | [Id](./Id.md) | The identifier for the search. This value is returned only for async and saved synchronous searches. For CSV, TSV, and TXT responses, this value is returned in the `Async-ID` HTTP header. | +| `is_partial` | boolean | If `true`, the response does not contain complete search results. If `is_partial` is `true` and `is_running` is `true`, the search is still running. If `is_partial` is `true` but `is_running` is `false`, the results are partial due to a failure or timeout. This value is returned only for async and saved synchronous searches. For CSV, TSV, and TXT responses, this value is returned in the `Async-partial` HTTP header. | +| `is_running` | boolean | If `true`, the search is still running. If `false`, the search has finished. This value is returned only for async and saved synchronous searches. For CSV, TSV, and TXT responses, this value is returned in the `Async-partial` HTTP header. | +| `rows` | [SqlRow](./SqlRow.md)[] | The values for the search results. | diff --git a/docs/reference/api/SqlQuerySqlFormat.md b/docs/reference/api/SqlQuerySqlFormat.md new file mode 100644 index 000000000..27669de73 --- /dev/null +++ b/docs/reference/api/SqlQuerySqlFormat.md @@ -0,0 +1,4 @@ +## `SqlQuerySqlFormat` +::: +type SqlQuerySqlFormat = 'csv' | 'json' | 'tsv' | 'txt' | 'yaml' | 'cbor' | 'smile'; +::: diff --git a/docs/reference/api/SqlRow.md b/docs/reference/api/SqlRow.md new file mode 100644 index 000000000..78bab4eec --- /dev/null +++ b/docs/reference/api/SqlRow.md @@ -0,0 +1,4 @@ +## `SqlRow` +::: +type SqlRow = any[]; +::: diff --git a/docs/reference/api/SqlTranslateRequest.md b/docs/reference/api/SqlTranslateRequest.md new file mode 100644 index 000000000..d8f98548a --- /dev/null +++ b/docs/reference/api/SqlTranslateRequest.md @@ -0,0 +1,10 @@ +## Interface `SqlTranslateRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { fetch_size?: never; filter?: never; query?: never; time_zone?: never; }) | All values in `body` will be added to the request body. | +| `fetch_size` | [integer](./integer.md) | The maximum number of rows (or entries) to return in one response. | +| `filter` | [QueryDslQueryContainer](./QueryDslQueryContainer.md) | The Elasticsearch query DSL for additional filtering. | +| `query` | string | The SQL query to run. | +| `querystring` | { [key: string]: any; } & { fetch_size?: never; filter?: never; query?: never; time_zone?: never; } | All values in `querystring` will be added to the request querystring. | +| `time_zone` | [TimeZone](./TimeZone.md) | The ISO-8601 time zone ID for the search. | diff --git a/docs/reference/api/SqlTranslateResponse.md b/docs/reference/api/SqlTranslateResponse.md new file mode 100644 index 000000000..5c6dbbbeb --- /dev/null +++ b/docs/reference/api/SqlTranslateResponse.md @@ -0,0 +1,10 @@ +## Interface `SqlTranslateResponse` + +| Name | Type | Description | +| - | - | - | +| `_source` | [SearchSourceConfig](./SearchSourceConfig.md) |   | +| `aggregations` | Record |   | +| `fields` | ([QueryDslFieldAndFormat](./QueryDslFieldAndFormat.md) | [Field](./Field.md))[] |   | +| `query` | [QueryDslQueryContainer](./QueryDslQueryContainer.md) |   | +| `size` | [long](./long.md) |   | +| `sort` | [Sort](./Sort.md) |   | diff --git a/docs/reference/api/Ssl.md b/docs/reference/api/Ssl.md new file mode 100644 index 000000000..3d6f08430 --- /dev/null +++ b/docs/reference/api/Ssl.md @@ -0,0 +1,20 @@ +## `Ssl` + +### Constructor + +::: +new Ssl(transport: [Transport](./Transport.md)); +::: + +### Properties + +| Name | Type | Description | +| - | - | - | +| `acceptedParams` | Record |   | +| `transport` | [Transport](./Transport.md) |   | + +### Methods + +| Name | Signature | Description | +| - | - | - | +| `certificates` | `certificates(this: [That](./That.md), params?: [SslCertificatesRequest](./SslCertificatesRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SslCertificatesResponse](./SslCertificatesResponse.md)>;` | Get SSL certificates. Get information about the X.509 certificates that are used to encrypt communications in the cluster. The API returns a list that includes certificates from all TLS contexts including: - Settings for transport and HTTP interfaces - TLS settings that are used within authentication realms - TLS settings for remote monitoring exporters The list includes certificates that are used for configuring trust, such as those configured in the `xpack.security.transport.ssl.truststore` and `xpack.security.transport.ssl.certificate_authorities` settings. It also includes certificates that are used for configuring server identity, such as `xpack.security.http.ssl.keystore` and `xpack.security.http.ssl.certificate settings`. The list does not include certificates that are sourced from the default SSL context of the Java Runtime Environment (JRE), even if those certificates are in use within Elasticsearch. NOTE: When a PKCS#11 token is configured as the truststore of the JRE, the API returns all the certificates that are included in the PKCS#11 token irrespective of whether these are used in the Elasticsearch TLS configuration. If Elasticsearch is configured to use a keystore or truststore, the API output includes all certificates in that store, even though some of the certificates might not be in active use within the cluster. || `certificates` | `certificates(this: [That](./That.md), params?: [SslCertificatesRequest](./SslCertificatesRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SslCertificatesResponse](./SslCertificatesResponse.md), unknown>>;` |   || `certificates` | `certificates(this: [That](./That.md), params?: [SslCertificatesRequest](./SslCertificatesRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SslCertificatesResponse](./SslCertificatesResponse.md)>;` |   | \ No newline at end of file diff --git a/docs/reference/api/SslCertificatesCertificateInformation.md b/docs/reference/api/SslCertificatesCertificateInformation.md new file mode 100644 index 000000000..950ca767a --- /dev/null +++ b/docs/reference/api/SslCertificatesCertificateInformation.md @@ -0,0 +1,12 @@ +## Interface `SslCertificatesCertificateInformation` + +| Name | Type | Description | +| - | - | - | +| `alias` | string | null | If the path refers to a container file (a jks keystore, or a PKCS#12 file), it is the alias of the certificate. Otherwise, it is null. | +| `expiry` | [DateTime](./DateTime.md) | The ISO formatted date of the certificate's expiry (not-after) date. | +| `format` | string | The format of the file. Valid values include `jks`, `PKCS12`, and `PEM`. | +| `has_private_key` | boolean | Indicates whether Elasticsearch has access to the private key for this certificate. | +| `issuer` | string | The Distinguished Name of the certificate's issuer. | +| `path` | string | The path to the certificate, as configured in the `elasticsearch.yml` file. | +| `serial_number` | string | The hexadecimal representation of the certificate's serial number. | +| `subject_dn` | string | The Distinguished Name of the certificate's subject. | diff --git a/docs/reference/api/SslCertificatesRequest.md b/docs/reference/api/SslCertificatesRequest.md new file mode 100644 index 000000000..f889c284c --- /dev/null +++ b/docs/reference/api/SslCertificatesRequest.md @@ -0,0 +1,6 @@ +## Interface `SslCertificatesRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | { [key: string]: any; } | All values in `body` will be added to the request body. | +| `querystring` | { [key: string]: any; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/SslCertificatesResponse.md b/docs/reference/api/SslCertificatesResponse.md new file mode 100644 index 000000000..5be715487 --- /dev/null +++ b/docs/reference/api/SslCertificatesResponse.md @@ -0,0 +1,4 @@ +## `SslCertificatesResponse` +::: +type SslCertificatesResponse = [SslCertificatesCertificateInformation](./SslCertificatesCertificateInformation.md)[]; +::: diff --git a/docs/reference/api/StandardRetriever.md b/docs/reference/api/StandardRetriever.md new file mode 100644 index 000000000..9103d2306 --- /dev/null +++ b/docs/reference/api/StandardRetriever.md @@ -0,0 +1,9 @@ +## Interface `StandardRetriever` + +| Name | Type | Description | +| - | - | - | +| `collapse` | [SearchFieldCollapse](./SearchFieldCollapse.md) | Collapses the top documents by a specified key into a single top document per key. | +| `query` | [QueryDslQueryContainer](./QueryDslQueryContainer.md) | Defines a query to retrieve a set of top documents. | +| `search_after` | [SortResults](./SortResults.md) | Defines a search after object parameter used for pagination. | +| `sort` | [Sort](./Sort.md) | A sort object that that specifies the order of matching documents. | +| `terminate_after` | [integer](./integer.md) | Maximum number of documents to collect for each shard. | diff --git a/docs/reference/api/StoreStats.md b/docs/reference/api/StoreStats.md new file mode 100644 index 000000000..e1b7d6d80 --- /dev/null +++ b/docs/reference/api/StoreStats.md @@ -0,0 +1,10 @@ +## Interface `StoreStats` + +| Name | Type | Description | +| - | - | - | +| `reserved_in_bytes` | [long](./long.md) | A prediction, in bytes, of how much larger the shard stores will eventually grow due to ongoing peer recoveries, restoring snapshots, and similar activities. | +| `reserved` | [ByteSize](./ByteSize.md) | A prediction of how much larger the shard stores will eventually grow due to ongoing peer recoveries, restoring snapshots, and similar activities. | +| `size_in_bytes` | [long](./long.md) | Total size, in bytes, of all shards assigned to selected nodes. | +| `size` | [ByteSize](./ByteSize.md) | Total size of all shards assigned to selected nodes. | +| `total_data_set_size_in_bytes` | [long](./long.md) | Total data set size, in bytes, of all shards assigned to selected nodes. This includes the size of shards not stored fully on the nodes, such as the cache for partially mounted indices. | +| `total_data_set_size` | [ByteSize](./ByteSize.md) | Total data set size of all shards assigned to selected nodes. This includes the size of shards not stored fully on the nodes, such as the cache for partially mounted indices. | diff --git a/docs/reference/api/StoredScript.md b/docs/reference/api/StoredScript.md new file mode 100644 index 000000000..d8e747eea --- /dev/null +++ b/docs/reference/api/StoredScript.md @@ -0,0 +1,7 @@ +## Interface `StoredScript` + +| Name | Type | Description | +| - | - | - | +| `lang` | [ScriptLanguage](./ScriptLanguage.md) | The language the script is written in. For search templates, use `mustache`. | +| `options` | Record |   | +| `source` | [ScriptSource](./ScriptSource.md) | The script source. For search templates, an object containing the search template. | diff --git a/docs/reference/api/StreamResult.md b/docs/reference/api/StreamResult.md new file mode 100644 index 000000000..bd6ac9fc5 --- /dev/null +++ b/docs/reference/api/StreamResult.md @@ -0,0 +1,4 @@ +## `StreamResult` +::: +type StreamResult = [ArrayBuffer](./ArrayBuffer.md); +::: diff --git a/docs/reference/api/SuggestMode.md b/docs/reference/api/SuggestMode.md new file mode 100644 index 000000000..25ef9577c --- /dev/null +++ b/docs/reference/api/SuggestMode.md @@ -0,0 +1,4 @@ +## `SuggestMode` +::: +type SuggestMode = 'missing' | 'popular' | 'always'; +::: diff --git a/docs/reference/api/SuggestionName.md b/docs/reference/api/SuggestionName.md new file mode 100644 index 000000000..ffeacdd31 --- /dev/null +++ b/docs/reference/api/SuggestionName.md @@ -0,0 +1,4 @@ +## `SuggestionName` +::: +type SuggestionName = string; +::: diff --git a/docs/reference/api/Synonyms.md b/docs/reference/api/Synonyms.md new file mode 100644 index 000000000..90a98aeff --- /dev/null +++ b/docs/reference/api/Synonyms.md @@ -0,0 +1,20 @@ +## `Synonyms` + +### Constructor + +::: +new Synonyms(transport: [Transport](./Transport.md)); +::: + +### Properties + +| Name | Type | Description | +| - | - | - | +| `acceptedParams` | Record |   | +| `transport` | [Transport](./Transport.md) |   | + +### Methods + +| Name | Signature | Description | +| - | - | - | +| `deleteSynonym` | `deleteSynonym(this: [That](./That.md), params: [SynonymsDeleteSynonymRequest](./SynonymsDeleteSynonymRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SynonymsDeleteSynonymResponse](./SynonymsDeleteSynonymResponse.md)>;` | Delete a synonym set. You can only delete a synonyms set that is not in use by any index analyzer. Synonyms sets can be used in synonym graph token filters and synonym token filters. These synonym filters can be used as part of search analyzers. Analyzers need to be loaded when an index is restored (such as when a node starts, or the index becomes open). Even if the analyzer is not used on any field mapping, it still needs to be loaded on the index recovery phase. If any analyzers cannot be loaded, the index becomes unavailable and the cluster status becomes red or yellow as index shards are not available. To prevent that, synonyms sets that are used in analyzers can't be deleted. A delete request in this case will return a 400 response code. To remove a synonyms set, you must first remove all indices that contain analyzers using it. You can migrate an index by creating a new index that does not contain the token filter with the synonyms set, and use the reindex API in order to copy over the index data. Once finished, you can delete the index. When the synonyms set is not used in analyzers, you will be able to delete it. || `deleteSynonym` | `deleteSynonym(this: [That](./That.md), params: [SynonymsDeleteSynonymRequest](./SynonymsDeleteSynonymRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SynonymsDeleteSynonymResponse](./SynonymsDeleteSynonymResponse.md), unknown>>;` |   || `deleteSynonym` | `deleteSynonym(this: [That](./That.md), params: [SynonymsDeleteSynonymRequest](./SynonymsDeleteSynonymRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SynonymsDeleteSynonymResponse](./SynonymsDeleteSynonymResponse.md)>;` |   || `deleteSynonymRule` | `deleteSynonymRule(this: [That](./That.md), params: [SynonymsDeleteSynonymRuleRequest](./SynonymsDeleteSynonymRuleRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SynonymsDeleteSynonymRuleResponse](./SynonymsDeleteSynonymRuleResponse.md)>;` | Delete a synonym rule. Delete a synonym rule from a synonym set. || `deleteSynonymRule` | `deleteSynonymRule(this: [That](./That.md), params: [SynonymsDeleteSynonymRuleRequest](./SynonymsDeleteSynonymRuleRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SynonymsDeleteSynonymRuleResponse](./SynonymsDeleteSynonymRuleResponse.md), unknown>>;` |   || `deleteSynonymRule` | `deleteSynonymRule(this: [That](./That.md), params: [SynonymsDeleteSynonymRuleRequest](./SynonymsDeleteSynonymRuleRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SynonymsDeleteSynonymRuleResponse](./SynonymsDeleteSynonymRuleResponse.md)>;` |   || `getSynonym` | `getSynonym(this: [That](./That.md), params: [SynonymsGetSynonymRequest](./SynonymsGetSynonymRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SynonymsGetSynonymResponse](./SynonymsGetSynonymResponse.md)>;` | Get a synonym set. || `getSynonym` | `getSynonym(this: [That](./That.md), params: [SynonymsGetSynonymRequest](./SynonymsGetSynonymRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SynonymsGetSynonymResponse](./SynonymsGetSynonymResponse.md), unknown>>;` |   || `getSynonym` | `getSynonym(this: [That](./That.md), params: [SynonymsGetSynonymRequest](./SynonymsGetSynonymRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SynonymsGetSynonymResponse](./SynonymsGetSynonymResponse.md)>;` |   || `getSynonymRule` | `getSynonymRule(this: [That](./That.md), params: [SynonymsGetSynonymRuleRequest](./SynonymsGetSynonymRuleRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SynonymsGetSynonymRuleResponse](./SynonymsGetSynonymRuleResponse.md)>;` | Get a synonym rule. Get a synonym rule from a synonym set. || `getSynonymRule` | `getSynonymRule(this: [That](./That.md), params: [SynonymsGetSynonymRuleRequest](./SynonymsGetSynonymRuleRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SynonymsGetSynonymRuleResponse](./SynonymsGetSynonymRuleResponse.md), unknown>>;` |   || `getSynonymRule` | `getSynonymRule(this: [That](./That.md), params: [SynonymsGetSynonymRuleRequest](./SynonymsGetSynonymRuleRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SynonymsGetSynonymRuleResponse](./SynonymsGetSynonymRuleResponse.md)>;` |   || `getSynonymsSets` | `getSynonymsSets(this: [That](./That.md), params?: [SynonymsGetSynonymsSetsRequest](./SynonymsGetSynonymsSetsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SynonymsGetSynonymsSetsResponse](./SynonymsGetSynonymsSetsResponse.md)>;` | Get all synonym sets. Get a summary of all defined synonym sets. || `getSynonymsSets` | `getSynonymsSets(this: [That](./That.md), params?: [SynonymsGetSynonymsSetsRequest](./SynonymsGetSynonymsSetsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SynonymsGetSynonymsSetsResponse](./SynonymsGetSynonymsSetsResponse.md), unknown>>;` |   || `getSynonymsSets` | `getSynonymsSets(this: [That](./That.md), params?: [SynonymsGetSynonymsSetsRequest](./SynonymsGetSynonymsSetsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SynonymsGetSynonymsSetsResponse](./SynonymsGetSynonymsSetsResponse.md)>;` |   || `putSynonym` | `putSynonym(this: [That](./That.md), params: [SynonymsPutSynonymRequest](./SynonymsPutSynonymRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SynonymsPutSynonymResponse](./SynonymsPutSynonymResponse.md)>;` | Create or update a synonym set. Synonyms sets are limited to a maximum of 10,000 synonym rules per set. If you need to manage more synonym rules, you can create multiple synonym sets. When an existing synonyms set is updated, the search analyzers that use the synonyms set are reloaded automatically for all indices. This is equivalent to invoking the reload search analyzers API for all indices that use the synonyms set. || `putSynonym` | `putSynonym(this: [That](./That.md), params: [SynonymsPutSynonymRequest](./SynonymsPutSynonymRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SynonymsPutSynonymResponse](./SynonymsPutSynonymResponse.md), unknown>>;` |   || `putSynonym` | `putSynonym(this: [That](./That.md), params: [SynonymsPutSynonymRequest](./SynonymsPutSynonymRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SynonymsPutSynonymResponse](./SynonymsPutSynonymResponse.md)>;` |   || `putSynonymRule` | `putSynonymRule(this: [That](./That.md), params: [SynonymsPutSynonymRuleRequest](./SynonymsPutSynonymRuleRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SynonymsPutSynonymRuleResponse](./SynonymsPutSynonymRuleResponse.md)>;` | Create or update a synonym rule. Create or update a synonym rule in a synonym set. If any of the synonym rules included is invalid, the API returns an error. When you update a synonym rule, all analyzers using the synonyms set will be reloaded automatically to reflect the new rule. || `putSynonymRule` | `putSynonymRule(this: [That](./That.md), params: [SynonymsPutSynonymRuleRequest](./SynonymsPutSynonymRuleRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SynonymsPutSynonymRuleResponse](./SynonymsPutSynonymRuleResponse.md), unknown>>;` |   || `putSynonymRule` | `putSynonymRule(this: [That](./That.md), params: [SynonymsPutSynonymRuleRequest](./SynonymsPutSynonymRuleRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SynonymsPutSynonymRuleResponse](./SynonymsPutSynonymRuleResponse.md)>;` |   | \ No newline at end of file diff --git a/docs/reference/api/SynonymsDeleteSynonymRequest.md b/docs/reference/api/SynonymsDeleteSynonymRequest.md new file mode 100644 index 000000000..c75da8338 --- /dev/null +++ b/docs/reference/api/SynonymsDeleteSynonymRequest.md @@ -0,0 +1,7 @@ +## Interface `SynonymsDeleteSynonymRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { id?: never; }) | All values in `body` will be added to the request body. | +| `id` | [Id](./Id.md) | The synonyms set identifier to delete. | +| `querystring` | { [key: string]: any; } & { id?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/SynonymsDeleteSynonymResponse.md b/docs/reference/api/SynonymsDeleteSynonymResponse.md new file mode 100644 index 000000000..ca51be4cd --- /dev/null +++ b/docs/reference/api/SynonymsDeleteSynonymResponse.md @@ -0,0 +1,4 @@ +## `SynonymsDeleteSynonymResponse` +::: +type SynonymsDeleteSynonymResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); +::: diff --git a/docs/reference/api/SynonymsDeleteSynonymRuleRequest.md b/docs/reference/api/SynonymsDeleteSynonymRuleRequest.md new file mode 100644 index 000000000..7f96044c6 --- /dev/null +++ b/docs/reference/api/SynonymsDeleteSynonymRuleRequest.md @@ -0,0 +1,9 @@ +## Interface `SynonymsDeleteSynonymRuleRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { set_id?: never; rule_id?: never; refresh?: never; }) | All values in `body` will be added to the request body. | +| `querystring` | { [key: string]: any; } & { set_id?: never; rule_id?: never; refresh?: never; } | All values in `querystring` will be added to the request querystring. | +| `refresh` | boolean | If `true`, the request will refresh the analyzers with the deleted synonym rule and wait for the new synonyms to be available before returning. If `false`, analyzers will not be reloaded with the deleted synonym rule | +| `rule_id` | [Id](./Id.md) | The ID of the synonym rule to delete. | +| `set_id` | [Id](./Id.md) | The ID of the synonym set to update. | diff --git a/docs/reference/api/SynonymsDeleteSynonymRuleResponse.md b/docs/reference/api/SynonymsDeleteSynonymRuleResponse.md new file mode 100644 index 000000000..581791697 --- /dev/null +++ b/docs/reference/api/SynonymsDeleteSynonymRuleResponse.md @@ -0,0 +1,4 @@ +## `SynonymsDeleteSynonymRuleResponse` +::: +type SynonymsDeleteSynonymRuleResponse = [SynonymsSynonymsUpdateResult](./SynonymsSynonymsUpdateResult.md); +::: diff --git a/docs/reference/api/SynonymsGetSynonymRequest.md b/docs/reference/api/SynonymsGetSynonymRequest.md new file mode 100644 index 000000000..0fc29f1e1 --- /dev/null +++ b/docs/reference/api/SynonymsGetSynonymRequest.md @@ -0,0 +1,9 @@ +## Interface `SynonymsGetSynonymRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { id?: never; from?: never; size?: never; }) | All values in `body` will be added to the request body. | +| `from` | [integer](./integer.md) | The starting offset for query rules to retrieve. | +| `id` | [Id](./Id.md) | The synonyms set identifier to retrieve. | +| `querystring` | { [key: string]: any; } & { id?: never; from?: never; size?: never; } | All values in `querystring` will be added to the request querystring. | +| `size` | [integer](./integer.md) | The max number of query rules to retrieve. | diff --git a/docs/reference/api/SynonymsGetSynonymResponse.md b/docs/reference/api/SynonymsGetSynonymResponse.md new file mode 100644 index 000000000..8f3601bf7 --- /dev/null +++ b/docs/reference/api/SynonymsGetSynonymResponse.md @@ -0,0 +1,6 @@ +## Interface `SynonymsGetSynonymResponse` + +| Name | Type | Description | +| - | - | - | +| `count` | [integer](./integer.md) | The total number of synonyms rules that the synonyms set contains. | +| `synonyms_set` | [SynonymsSynonymRuleRead](./SynonymsSynonymRuleRead.md)[] | Synonym rule details. | diff --git a/docs/reference/api/SynonymsGetSynonymRuleRequest.md b/docs/reference/api/SynonymsGetSynonymRuleRequest.md new file mode 100644 index 000000000..955e2db53 --- /dev/null +++ b/docs/reference/api/SynonymsGetSynonymRuleRequest.md @@ -0,0 +1,8 @@ +## Interface `SynonymsGetSynonymRuleRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { set_id?: never; rule_id?: never; }) | All values in `body` will be added to the request body. | +| `querystring` | { [key: string]: any; } & { set_id?: never; rule_id?: never; } | All values in `querystring` will be added to the request querystring. | +| `rule_id` | [Id](./Id.md) | The ID of the synonym rule to retrieve. | +| `set_id` | [Id](./Id.md) | The ID of the synonym set to retrieve the synonym rule from. | diff --git a/docs/reference/api/SynonymsGetSynonymRuleResponse.md b/docs/reference/api/SynonymsGetSynonymRuleResponse.md new file mode 100644 index 000000000..fe5e71b99 --- /dev/null +++ b/docs/reference/api/SynonymsGetSynonymRuleResponse.md @@ -0,0 +1,4 @@ +## `SynonymsGetSynonymRuleResponse` +::: +type SynonymsGetSynonymRuleResponse = [SynonymsSynonymRuleRead](./SynonymsSynonymRuleRead.md); +::: diff --git a/docs/reference/api/SynonymsGetSynonymsSetsRequest.md b/docs/reference/api/SynonymsGetSynonymsSetsRequest.md new file mode 100644 index 000000000..75a9f185a --- /dev/null +++ b/docs/reference/api/SynonymsGetSynonymsSetsRequest.md @@ -0,0 +1,8 @@ +## Interface `SynonymsGetSynonymsSetsRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { from?: never; size?: never; }) | All values in `body` will be added to the request body. | +| `from` | [integer](./integer.md) | The starting offset for synonyms sets to retrieve. | +| `querystring` | { [key: string]: any; } & { from?: never; size?: never; } | All values in `querystring` will be added to the request querystring. | +| `size` | [integer](./integer.md) | The maximum number of synonyms sets to retrieve. | diff --git a/docs/reference/api/SynonymsGetSynonymsSetsResponse.md b/docs/reference/api/SynonymsGetSynonymsSetsResponse.md new file mode 100644 index 000000000..a9497efe4 --- /dev/null +++ b/docs/reference/api/SynonymsGetSynonymsSetsResponse.md @@ -0,0 +1,6 @@ +## Interface `SynonymsGetSynonymsSetsResponse` + +| Name | Type | Description | +| - | - | - | +| `count` | [integer](./integer.md) | The total number of synonyms sets defined. | +| `results` | [SynonymsGetSynonymsSetsSynonymsSetItem](./SynonymsGetSynonymsSetsSynonymsSetItem.md)[] | The identifier and total number of defined synonym rules for each synonyms set. | diff --git a/docs/reference/api/SynonymsGetSynonymsSetsSynonymsSetItem.md b/docs/reference/api/SynonymsGetSynonymsSetsSynonymsSetItem.md new file mode 100644 index 000000000..c9895e79a --- /dev/null +++ b/docs/reference/api/SynonymsGetSynonymsSetsSynonymsSetItem.md @@ -0,0 +1,6 @@ +## Interface `SynonymsGetSynonymsSetsSynonymsSetItem` + +| Name | Type | Description | +| - | - | - | +| `count` | [integer](./integer.md) | Number of synonym rules that the synonym set contains | +| `synonyms_set` | [Id](./Id.md) | Synonyms set identifier | diff --git a/docs/reference/api/SynonymsPutSynonymRequest.md b/docs/reference/api/SynonymsPutSynonymRequest.md new file mode 100644 index 000000000..bf56275db --- /dev/null +++ b/docs/reference/api/SynonymsPutSynonymRequest.md @@ -0,0 +1,9 @@ +## Interface `SynonymsPutSynonymRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { id?: never; refresh?: never; synonyms_set?: never; }) | All values in `body` will be added to the request body. | +| `id` | [Id](./Id.md) | The ID of the synonyms set to be created or updated. | +| `querystring` | { [key: string]: any; } & { id?: never; refresh?: never; synonyms_set?: never; } | All values in `querystring` will be added to the request querystring. | +| `refresh` | boolean | If `true`, the request will refresh the analyzers with the new synonyms set and wait for the new synonyms to be available before returning. If `false`, analyzers will not be reloaded with the new synonym set | +| `synonyms_set` | [SynonymsSynonymRule](./SynonymsSynonymRule.md) | [SynonymsSynonymRule](./SynonymsSynonymRule.md)[] | The synonym rules definitions for the synonyms set. | diff --git a/docs/reference/api/SynonymsPutSynonymResponse.md b/docs/reference/api/SynonymsPutSynonymResponse.md new file mode 100644 index 000000000..69e1ece6e --- /dev/null +++ b/docs/reference/api/SynonymsPutSynonymResponse.md @@ -0,0 +1,6 @@ +## Interface `SynonymsPutSynonymResponse` + +| Name | Type | Description | +| - | - | - | +| `reload_analyzers_details` | [IndicesReloadSearchAnalyzersReloadResult](./IndicesReloadSearchAnalyzersReloadResult.md) | Updating a synonyms set can reload the associated analyzers in case refresh is set to true. This information is the analyzers reloading result. | +| `result` | [Result](./Result.md) | The update operation result. | diff --git a/docs/reference/api/SynonymsPutSynonymRuleRequest.md b/docs/reference/api/SynonymsPutSynonymRuleRequest.md new file mode 100644 index 000000000..adc195f1e --- /dev/null +++ b/docs/reference/api/SynonymsPutSynonymRuleRequest.md @@ -0,0 +1,10 @@ +## Interface `SynonymsPutSynonymRuleRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { set_id?: never; rule_id?: never; refresh?: never; synonyms?: never; }) | All values in `body` will be added to the request body. | +| `querystring` | { [key: string]: any; } & { set_id?: never; rule_id?: never; refresh?: never; synonyms?: never; } | All values in `querystring` will be added to the request querystring. | +| `refresh` | boolean | If `true`, the request will refresh the analyzers with the new synonym rule and wait for the new synonyms to be available before returning. If `false`, analyzers will not be reloaded with the new synonym rule | +| `rule_id` | [Id](./Id.md) | The ID of the synonym rule to be updated or created. | +| `set_id` | [Id](./Id.md) | The ID of the synonym set. | +| `synonyms` | [SynonymsSynonymString](./SynonymsSynonymString.md) | The synonym rule information definition, which must be in Solr format. | diff --git a/docs/reference/api/SynonymsPutSynonymRuleResponse.md b/docs/reference/api/SynonymsPutSynonymRuleResponse.md new file mode 100644 index 000000000..1517a682a --- /dev/null +++ b/docs/reference/api/SynonymsPutSynonymRuleResponse.md @@ -0,0 +1,4 @@ +## `SynonymsPutSynonymRuleResponse` +::: +type SynonymsPutSynonymRuleResponse = [SynonymsSynonymsUpdateResult](./SynonymsSynonymsUpdateResult.md); +::: diff --git a/docs/reference/api/SynonymsSynonymRule.md b/docs/reference/api/SynonymsSynonymRule.md new file mode 100644 index 000000000..8ae02bc9c --- /dev/null +++ b/docs/reference/api/SynonymsSynonymRule.md @@ -0,0 +1,6 @@ +## Interface `SynonymsSynonymRule` + +| Name | Type | Description | +| - | - | - | +| `id` | [Id](./Id.md) | The identifier for the synonym rule. If you do not specify a synonym rule ID when you create a rule, an identifier is created automatically by Elasticsearch. | +| `synonyms` | [SynonymsSynonymString](./SynonymsSynonymString.md) | The synonyms that conform the synonym rule in Solr format. | diff --git a/docs/reference/api/SynonymsSynonymRuleRead.md b/docs/reference/api/SynonymsSynonymRuleRead.md new file mode 100644 index 000000000..b54232cbd --- /dev/null +++ b/docs/reference/api/SynonymsSynonymRuleRead.md @@ -0,0 +1,6 @@ +## Interface `SynonymsSynonymRuleRead` + +| Name | Type | Description | +| - | - | - | +| `id` | [Id](./Id.md) | Synonym Rule identifier | +| `synonyms` | [SynonymsSynonymString](./SynonymsSynonymString.md) | Synonyms, in Solr format, that conform the synonym rule. | diff --git a/docs/reference/api/SynonymsSynonymString.md b/docs/reference/api/SynonymsSynonymString.md new file mode 100644 index 000000000..d38fd266a --- /dev/null +++ b/docs/reference/api/SynonymsSynonymString.md @@ -0,0 +1,4 @@ +## `SynonymsSynonymString` +::: +type SynonymsSynonymString = string; +::: diff --git a/docs/reference/api/SynonymsSynonymsUpdateResult.md b/docs/reference/api/SynonymsSynonymsUpdateResult.md new file mode 100644 index 000000000..59a0c870a --- /dev/null +++ b/docs/reference/api/SynonymsSynonymsUpdateResult.md @@ -0,0 +1,6 @@ +## Interface `SynonymsSynonymsUpdateResult` + +| Name | Type | Description | +| - | - | - | +| `reload_analyzers_details` | [IndicesReloadSearchAnalyzersReloadResult](./IndicesReloadSearchAnalyzersReloadResult.md) | Updating synonyms in a synonym set can reload the associated analyzers in case refresh is set to true. This information is the analyzers reloading result. | +| `result` | [Result](./Result.md) | The update operation result. | diff --git a/docs/reference/api/TODO.md b/docs/reference/api/TODO.md new file mode 100644 index 000000000..7d603058a --- /dev/null +++ b/docs/reference/api/TODO.md @@ -0,0 +1,4 @@ +## `TODO` +::: +type TODO = Record; +::: diff --git a/docs/reference/api/TaskFailure.md b/docs/reference/api/TaskFailure.md new file mode 100644 index 000000000..aa3fa0519 --- /dev/null +++ b/docs/reference/api/TaskFailure.md @@ -0,0 +1,8 @@ +## Interface `TaskFailure` + +| Name | Type | Description | +| - | - | - | +| `node_id` | [NodeId](./NodeId.md) |   | +| `reason` | [ErrorCause](./ErrorCause.md) |   | +| `status` | string |   | +| `task_id` | [long](./long.md) |   | diff --git a/docs/reference/api/TaskId.md b/docs/reference/api/TaskId.md new file mode 100644 index 000000000..416d92583 --- /dev/null +++ b/docs/reference/api/TaskId.md @@ -0,0 +1,4 @@ +## `TaskId` +::: +type TaskId = string | [integer](./integer.md); +::: diff --git a/docs/reference/api/Tasks.md b/docs/reference/api/Tasks.md new file mode 100644 index 000000000..99a7a6fa9 --- /dev/null +++ b/docs/reference/api/Tasks.md @@ -0,0 +1,20 @@ +## `Tasks` + +### Constructor + +::: +new Tasks(transport: [Transport](./Transport.md)); +::: + +### Properties + +| Name | Type | Description | +| - | - | - | +| `acceptedParams` | Record |   | +| `transport` | [Transport](./Transport.md) |   | + +### Methods + +| Name | Signature | Description | +| - | - | - | +| `cancel` | `cancel(this: [That](./That.md), params?: [TasksCancelRequest](./TasksCancelRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TasksCancelResponse](./TasksCancelResponse.md)>;` | Cancel a task. WARNING: The task management API is new and should still be considered a beta feature. The API may change in ways that are not backwards compatible. A task may continue to run for some time after it has been cancelled because it may not be able to safely stop its current activity straight away. It is also possible that Elasticsearch must complete its work on other tasks before it can process the cancellation. The get task information API will continue to list these cancelled tasks until they complete. The cancelled flag in the response indicates that the cancellation command has been processed and the task will stop as soon as possible. To troubleshoot why a cancelled task does not complete promptly, use the get task information API with the `?detailed` parameter to identify the other tasks the system is running. You can also use the node hot threads API to obtain detailed information about the work the system is doing instead of completing the cancelled task. || `cancel` | `cancel(this: [That](./That.md), params?: [TasksCancelRequest](./TasksCancelRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TasksCancelResponse](./TasksCancelResponse.md), unknown>>;` |   || `cancel` | `cancel(this: [That](./That.md), params?: [TasksCancelRequest](./TasksCancelRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TasksCancelResponse](./TasksCancelResponse.md)>;` |   || `get` | `get(this: [That](./That.md), params: [TasksGetRequest](./TasksGetRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TasksGetResponse](./TasksGetResponse.md)>;` | Get task information. Get information about a task currently running in the cluster. WARNING: The task management API is new and should still be considered a beta feature. The API may change in ways that are not backwards compatible. If the task identifier is not found, a 404 response code indicates that there are no resources that match the request. || `get` | `get(this: [That](./That.md), params: [TasksGetRequest](./TasksGetRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TasksGetResponse](./TasksGetResponse.md), unknown>>;` |   || `get` | `get(this: [That](./That.md), params: [TasksGetRequest](./TasksGetRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TasksGetResponse](./TasksGetResponse.md)>;` |   || `list` | `list(this: [That](./That.md), params?: [TasksListRequest](./TasksListRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TasksListResponse](./TasksListResponse.md)>;` | Get all tasks. Get information about the tasks currently running on one or more nodes in the cluster. WARNING: The task management API is new and should still be considered a beta feature. The API may change in ways that are not backwards compatible. **Identifying running tasks** The `X-Opaque-Id header`, when provided on the HTTP request header, is going to be returned as a header in the response as well as in the headers field for in the task information. This enables you to track certain calls or associate certain tasks with the client that started them. For example: ``` curl -i -H "X-Opaque-Id: 123456" "http://localhost:9200/_tasks?group_by=parents" ``` The API returns the following result: ``` HTTP/1.1 200 OK X-Opaque-Id: 123456 content-type: application/json; charset=UTF-8 content-length: 831 { "tasks" : { "u5lcZHqcQhu-rUoFaqDphA:45" : { "node" : "u5lcZHqcQhu-rUoFaqDphA", "id" : 45, "type" : "transport", "action" : "cluster:monitor/tasks/lists", "start_time_in_millis" : 1513823752749, "running_time_in_nanos" : 293139, "cancellable" : false, "headers" : { "X-Opaque-Id" : "123456" } , "children" : [ { "node" : "u5lcZHqcQhu-rUoFaqDphA", "id" : 46, "type" : "direct", "action" : "cluster:monitor/tasks/lists[n]", "start_time_in_millis" : 1513823752750, "running_time_in_nanos" : 92133, "cancellable" : false, "parent_task_id" : "u5lcZHqcQhu-rUoFaqDphA:45", "headers" : { "X-Opaque-Id" : "123456" } } ] } } } ``` In this example, `X-Opaque-Id: 123456` is the ID as a part of the response header. The `X-Opaque-Id` in the task `headers` is the ID for the task that was initiated by the REST request. The `X-Opaque-Id` in the children `headers` is the child task of the task that was initiated by the REST request. || `list` | `list(this: [That](./That.md), params?: [TasksListRequest](./TasksListRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TasksListResponse](./TasksListResponse.md), unknown>>;` |   || `list` | `list(this: [That](./That.md), params?: [TasksListRequest](./TasksListRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TasksListResponse](./TasksListResponse.md)>;` |   | \ No newline at end of file diff --git a/docs/reference/api/TasksCancelRequest.md b/docs/reference/api/TasksCancelRequest.md new file mode 100644 index 000000000..8c700b5ae --- /dev/null +++ b/docs/reference/api/TasksCancelRequest.md @@ -0,0 +1,11 @@ +## Interface `TasksCancelRequest` + +| Name | Type | Description | +| - | - | - | +| `actions` | string | string[] | A comma-separated list or wildcard expression of actions that is used to limit the request. | +| `body` | string | ({ [key: string]: any; } & { task_id?: never; actions?: never; nodes?: never; parent_task_id?: never; wait_for_completion?: never; }) | All values in `body` will be added to the request body. | +| `nodes` | string[] | A comma-separated list of node IDs or names that is used to limit the request. | +| `parent_task_id` | string | A parent task ID that is used to limit the tasks. | +| `querystring` | { [key: string]: any; } & { task_id?: never; actions?: never; nodes?: never; parent_task_id?: never; wait_for_completion?: never; } | All values in `querystring` will be added to the request querystring. | +| `task_id` | [TaskId](./TaskId.md) | The task identifier. | +| `wait_for_completion` | boolean | If true, the request blocks until all found tasks are complete. | diff --git a/docs/reference/api/TasksCancelResponse.md b/docs/reference/api/TasksCancelResponse.md new file mode 100644 index 000000000..c21638612 --- /dev/null +++ b/docs/reference/api/TasksCancelResponse.md @@ -0,0 +1,4 @@ +## `TasksCancelResponse` +::: +type TasksCancelResponse = [TasksTaskListResponseBase](./TasksTaskListResponseBase.md); +::: diff --git a/docs/reference/api/TasksGetRequest.md b/docs/reference/api/TasksGetRequest.md new file mode 100644 index 000000000..97f0b580d --- /dev/null +++ b/docs/reference/api/TasksGetRequest.md @@ -0,0 +1,9 @@ +## Interface `TasksGetRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { task_id?: never; timeout?: never; wait_for_completion?: never; }) | All values in `body` will be added to the request body. | +| `querystring` | { [key: string]: any; } & { task_id?: never; timeout?: never; wait_for_completion?: never; } | All values in `querystring` will be added to the request querystring. | +| `task_id` | [Id](./Id.md) | The task identifier. | +| `timeout` | [Duration](./Duration.md) | The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. | +| `wait_for_completion` | boolean | If `true`, the request blocks until the task has completed. | diff --git a/docs/reference/api/TasksGetResponse.md b/docs/reference/api/TasksGetResponse.md new file mode 100644 index 000000000..fba480497 --- /dev/null +++ b/docs/reference/api/TasksGetResponse.md @@ -0,0 +1,8 @@ +## Interface `TasksGetResponse` + +| Name | Type | Description | +| - | - | - | +| `completed` | boolean |   | +| `error` | [ErrorCause](./ErrorCause.md) |   | +| `response` | any |   | +| `task` | [TasksTaskInfo](./TasksTaskInfo.md) |   | diff --git a/docs/reference/api/TasksGroupBy.md b/docs/reference/api/TasksGroupBy.md new file mode 100644 index 000000000..9d7a10a0b --- /dev/null +++ b/docs/reference/api/TasksGroupBy.md @@ -0,0 +1,4 @@ +## `TasksGroupBy` +::: +type TasksGroupBy = 'nodes' | 'parents' | 'none'; +::: diff --git a/docs/reference/api/TasksListRequest.md b/docs/reference/api/TasksListRequest.md new file mode 100644 index 000000000..60cfddfe7 --- /dev/null +++ b/docs/reference/api/TasksListRequest.md @@ -0,0 +1,13 @@ +## Interface `TasksListRequest` + +| Name | Type | Description | +| - | - | - | +| `actions` | string | string[] | A comma-separated list or wildcard expression of actions used to limit the request. For example, you can use `cluser:*` to retrieve all cluster-related tasks. | +| `body` | string | ({ [key: string]: any; } & { actions?: never; detailed?: never; group_by?: never; nodes?: never; parent_task_id?: never; timeout?: never; wait_for_completion?: never; }) | All values in `body` will be added to the request body. | +| `detailed` | boolean | If `true`, the response includes detailed information about the running tasks. This information is useful to distinguish tasks from each other but is more costly to run. | +| `group_by` | [TasksGroupBy](./TasksGroupBy.md) | A key that is used to group tasks in the response. The task lists can be grouped either by nodes or by parent tasks. | +| `nodes` | [NodeIds](./NodeIds.md) | A comma-separated list of node IDs or names that is used to limit the returned information. | +| `parent_task_id` | [Id](./Id.md) | A parent task identifier that is used to limit returned information. To return all tasks, omit this parameter or use a value of `-1`. If the parent task is not found, the API does not return a 404 response code. | +| `querystring` | { [key: string]: any; } & { actions?: never; detailed?: never; group_by?: never; nodes?: never; parent_task_id?: never; timeout?: never; wait_for_completion?: never; } | All values in `querystring` will be added to the request querystring. | +| `timeout` | [Duration](./Duration.md) | The period to wait for each node to respond. If a node does not respond before its timeout expires, the response does not include its information. However, timed out nodes are included in the `node_failures` property. | +| `wait_for_completion` | boolean | If `true`, the request blocks until the operation is complete. | diff --git a/docs/reference/api/TasksListResponse.md b/docs/reference/api/TasksListResponse.md new file mode 100644 index 000000000..23977bad1 --- /dev/null +++ b/docs/reference/api/TasksListResponse.md @@ -0,0 +1,4 @@ +## `TasksListResponse` +::: +type TasksListResponse = [TasksTaskListResponseBase](./TasksTaskListResponseBase.md); +::: diff --git a/docs/reference/api/TasksNodeTasks.md b/docs/reference/api/TasksNodeTasks.md new file mode 100644 index 000000000..22c164d2d --- /dev/null +++ b/docs/reference/api/TasksNodeTasks.md @@ -0,0 +1,11 @@ +## Interface `TasksNodeTasks` + +| Name | Type | Description | +| - | - | - | +| `attributes` | Record |   | +| `host` | [Host](./Host.md) |   | +| `ip` | [Ip](./Ip.md) |   | +| `name` | [NodeId](./NodeId.md) |   | +| `roles` | string[] |   | +| `tasks` | Record<[TaskId](./TaskId.md), [TasksTaskInfo](./TasksTaskInfo.md)> |   | +| `transport_address` | [TransportAddress](./TransportAddress.md) |   | diff --git a/docs/reference/api/TasksParentTaskInfo.md b/docs/reference/api/TasksParentTaskInfo.md new file mode 100644 index 000000000..d87a4a6d3 --- /dev/null +++ b/docs/reference/api/TasksParentTaskInfo.md @@ -0,0 +1,5 @@ +## Interface `TasksParentTaskInfo` + +| Name | Type | Description | +| - | - | - | +| `children` | [TasksTaskInfo](./TasksTaskInfo.md)[] |   | diff --git a/docs/reference/api/TasksTaskInfo.md b/docs/reference/api/TasksTaskInfo.md new file mode 100644 index 000000000..f98bf7cd9 --- /dev/null +++ b/docs/reference/api/TasksTaskInfo.md @@ -0,0 +1,17 @@ +## Interface `TasksTaskInfo` + +| Name | Type | Description | +| - | - | - | +| `action` | string |   | +| `cancellable` | boolean |   | +| `cancelled` | boolean |   | +| `description` | string | Human readable text that identifies the particular request that the task is performing. For example, it might identify the search request being performed by a search task. Other kinds of tasks have different descriptions, like `_reindex` which has the source and the destination, or `_bulk` which just has the number of requests and the destination indices. Many requests will have only an empty description because more detailed information about the request is not easily available or particularly helpful in identifying the request. | +| `headers` | Record |   | +| `id` | [long](./long.md) |   | +| `node` | [NodeId](./NodeId.md) |   | +| `parent_task_id` | [TaskId](./TaskId.md) |   | +| `running_time_in_nanos` | [DurationValue](./DurationValue.md)<[UnitNanos](./UnitNanos.md)> |   | +| `running_time` | [Duration](./Duration.md) |   | +| `start_time_in_millis` | [EpochTime](./EpochTime.md)<[UnitMillis](./UnitMillis.md)> |   | +| `status` | any | The internal status of the task, which varies from task to task. The format also varies. While the goal is to keep the status for a particular task consistent from version to version, this is not always possible because sometimes the implementation changes. Fields might be removed from the status for a particular request so any parsing you do of the status might break in minor releases. | +| `type` | string |   | diff --git a/docs/reference/api/TasksTaskInfos.md b/docs/reference/api/TasksTaskInfos.md new file mode 100644 index 000000000..1f7d7fbde --- /dev/null +++ b/docs/reference/api/TasksTaskInfos.md @@ -0,0 +1,4 @@ +## `TasksTaskInfos` +::: +type TasksTaskInfos = [TasksTaskInfo](./TasksTaskInfo.md)[] | Record; +::: diff --git a/docs/reference/api/TasksTaskListResponseBase.md b/docs/reference/api/TasksTaskListResponseBase.md new file mode 100644 index 000000000..fb687309b --- /dev/null +++ b/docs/reference/api/TasksTaskListResponseBase.md @@ -0,0 +1,8 @@ +## Interface `TasksTaskListResponseBase` + +| Name | Type | Description | +| - | - | - | +| `node_failures` | [ErrorCause](./ErrorCause.md)[] |   | +| `nodes` | Record | Task information grouped by node, if `group_by` was set to `node` (the default). | +| `task_failures` | [TaskFailure](./TaskFailure.md)[] |   | +| `tasks` | [TasksTaskInfos](./TasksTaskInfos.md) | Either a flat list of tasks if `group_by` was set to `none`, or grouped by parents if `group_by` was set to `parents`. | diff --git a/docs/reference/api/TermsEnumApi_1.md b/docs/reference/api/TermsEnumApi_1.md new file mode 100644 index 000000000..81ba616b0 --- /dev/null +++ b/docs/reference/api/TermsEnumApi_1.md @@ -0,0 +1,3 @@ +::: +default function TermsEnumApi(this: [That](./That.md), params: [TermsEnumRequest](./TermsEnumRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TermsEnumResponse](./TermsEnumResponse.md)>; +::: diff --git a/docs/reference/api/TermsEnumApi_2.md b/docs/reference/api/TermsEnumApi_2.md new file mode 100644 index 000000000..734dfb127 --- /dev/null +++ b/docs/reference/api/TermsEnumApi_2.md @@ -0,0 +1,3 @@ +::: +default function TermsEnumApi(this: [That](./That.md), params: [TermsEnumRequest](./TermsEnumRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TermsEnumResponse](./TermsEnumResponse.md), unknown>>; +::: diff --git a/docs/reference/api/TermsEnumApi_3.md b/docs/reference/api/TermsEnumApi_3.md new file mode 100644 index 000000000..a1b365cf0 --- /dev/null +++ b/docs/reference/api/TermsEnumApi_3.md @@ -0,0 +1,3 @@ +::: +default function TermsEnumApi(this: [That](./That.md), params: [TermsEnumRequest](./TermsEnumRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TermsEnumResponse](./TermsEnumResponse.md)>; +::: diff --git a/docs/reference/api/TermsEnumRequest.md b/docs/reference/api/TermsEnumRequest.md new file mode 100644 index 000000000..b426e1c66 --- /dev/null +++ b/docs/reference/api/TermsEnumRequest.md @@ -0,0 +1,14 @@ +## Interface `TermsEnumRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { index?: never; field?: never; size?: never; timeout?: never; case_insensitive?: never; index_filter?: never; string?: never; search_after?: never; }) | All values in `body` will be added to the request body. | +| `case_insensitive` | boolean | When `true`, the provided search string is matched against index terms without case sensitivity. | +| `field` | [Field](./Field.md) | The string to match at the start of indexed terms. If not provided, all terms in the field are considered. | +| `index_filter` | [QueryDslQueryContainer](./QueryDslQueryContainer.md) | Filter an index shard if the provided query rewrites to `match_none`. | +| `index` | [IndexName](./IndexName.md) | A comma-separated list of data streams, indices, and index aliases to search. Wildcard ( `*`) expressions are supported. To search all data streams or indices, omit this parameter or use `*` or `_all`. | +| `querystring` | { [key: string]: any; } & { index?: never; field?: never; size?: never; timeout?: never; case_insensitive?: never; index_filter?: never; string?: never; search_after?: never; } | All values in `querystring` will be added to the request querystring. | +| `search_after` | string | The string after which terms in the index should be returned. It allows for a form of pagination if the last result from one request is passed as the `search_after` parameter for a subsequent request. | +| `size` | [integer](./integer.md) | The number of matching terms to return. | +| `string` | string | The string to match at the start of indexed terms. If it is not provided, all terms in the field are considered. > info > The prefix string cannot be larger than the largest possible keyword value, which is Lucene's term byte-length limit of 32766. | +| `timeout` | [Duration](./Duration.md) | The maximum length of time to spend collecting results. If the timeout is exceeded the `complete` flag set to `false` in the response and the results may be partial or empty. | diff --git a/docs/reference/api/TermsEnumResponse.md b/docs/reference/api/TermsEnumResponse.md new file mode 100644 index 000000000..8268f8efc --- /dev/null +++ b/docs/reference/api/TermsEnumResponse.md @@ -0,0 +1,7 @@ +## Interface `TermsEnumResponse` + +| Name | Type | Description | +| - | - | - | +| `_shards` | [ShardStatistics](./ShardStatistics.md) |   | +| `complete` | boolean | If `false`, the returned terms set may be incomplete and should be treated as approximate. This can occur due to a few reasons, such as a request timeout or a node error. | +| `terms` | string[] |   | diff --git a/docs/reference/api/TermvectorsApi_1.md b/docs/reference/api/TermvectorsApi_1.md new file mode 100644 index 000000000..1faf2c3c9 --- /dev/null +++ b/docs/reference/api/TermvectorsApi_1.md @@ -0,0 +1,3 @@ +::: +default function TermvectorsApi(this: [That](./That.md), params: [TermvectorsRequest](./TermvectorsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TermvectorsResponse](./TermvectorsResponse.md)>; +::: diff --git a/docs/reference/api/TermvectorsApi_2.md b/docs/reference/api/TermvectorsApi_2.md new file mode 100644 index 000000000..235b242f6 --- /dev/null +++ b/docs/reference/api/TermvectorsApi_2.md @@ -0,0 +1,3 @@ +::: +default function TermvectorsApi(this: [That](./That.md), params: [TermvectorsRequest](./TermvectorsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TermvectorsResponse](./TermvectorsResponse.md), unknown>>; +::: diff --git a/docs/reference/api/TermvectorsApi_3.md b/docs/reference/api/TermvectorsApi_3.md new file mode 100644 index 000000000..0edb0c0b4 --- /dev/null +++ b/docs/reference/api/TermvectorsApi_3.md @@ -0,0 +1,3 @@ +::: +default function TermvectorsApi(this: [That](./That.md), params: [TermvectorsRequest](./TermvectorsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TermvectorsResponse](./TermvectorsResponse.md)>; +::: diff --git a/docs/reference/api/TermvectorsFieldStatistics.md b/docs/reference/api/TermvectorsFieldStatistics.md new file mode 100644 index 000000000..277f87177 --- /dev/null +++ b/docs/reference/api/TermvectorsFieldStatistics.md @@ -0,0 +1,7 @@ +## Interface `TermvectorsFieldStatistics` + +| Name | Type | Description | +| - | - | - | +| `doc_count` | [integer](./integer.md) |   | +| `sum_doc_freq` | [long](./long.md) |   | +| `sum_ttf` | [long](./long.md) |   | diff --git a/docs/reference/api/TermvectorsFilter.md b/docs/reference/api/TermvectorsFilter.md new file mode 100644 index 000000000..1d5955220 --- /dev/null +++ b/docs/reference/api/TermvectorsFilter.md @@ -0,0 +1,11 @@ +## Interface `TermvectorsFilter` + +| Name | Type | Description | +| - | - | - | +| `max_doc_freq` | [integer](./integer.md) | Ignore words which occur in more than this many docs. Defaults to unbounded. | +| `max_num_terms` | [integer](./integer.md) | The maximum number of terms that must be returned per field. | +| `max_term_freq` | [integer](./integer.md) | Ignore words with more than this frequency in the source doc. It defaults to unbounded. | +| `max_word_length` | [integer](./integer.md) | The maximum word length above which words will be ignored. Defaults to unbounded. | +| `min_doc_freq` | [integer](./integer.md) | Ignore terms which do not occur in at least this many docs. | +| `min_term_freq` | [integer](./integer.md) | Ignore words with less than this frequency in the source doc. | +| `min_word_length` | [integer](./integer.md) | The minimum word length below which words will be ignored. | diff --git a/docs/reference/api/TermvectorsRequest.md b/docs/reference/api/TermvectorsRequest.md new file mode 100644 index 000000000..78df6907c --- /dev/null +++ b/docs/reference/api/TermvectorsRequest.md @@ -0,0 +1,22 @@ +## Interface `TermvectorsRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { index?: never; id?: never; preference?: never; realtime?: never; doc?: never; filter?: never; per_field_analyzer?: never; fields?: never; field_statistics?: never; offsets?: never; payloads?: never; positions?: never; term_statistics?: never; routing?: never; version?: never; version_type?: never; }) | All values in `body` will be added to the request body. | +| `doc` | TDocument | An artificial document (a document not present in the index) for which you want to retrieve term vectors. | +| `field_statistics` | boolean | If `true`, the response includes: * The document count (how many documents contain this field). * The sum of document frequencies (the sum of document frequencies for all terms in this field). * The sum of total term frequencies (the sum of total term frequencies of each term in this field). | +| `fields` | [Fields](./Fields.md) | A list of fields to include in the statistics. It is used as the default list unless a specific field list is provided in the `completion_fields` or `fielddata_fields` parameters. | +| `filter` | [TermvectorsFilter](./TermvectorsFilter.md) | Filter terms based on their tf-idf scores. This could be useful in order find out a good characteristic vector of a document. This feature works in a similar manner to the second phase of the More Like This Query. | +| `id` | [Id](./Id.md) | A unique identifier for the document. | +| `index` | [IndexName](./IndexName.md) | The name of the index that contains the document. | +| `offsets` | boolean | If `true`, the response includes term offsets. | +| `payloads` | boolean | If `true`, the response includes term payloads. | +| `per_field_analyzer` | Record<[Field](./Field.md), string> | Override the default per-field analyzer. This is useful in order to generate term vectors in any fashion, especially when using artificial documents. When providing an analyzer for a field that already stores term vectors, the term vectors will be regenerated. | +| `positions` | boolean | If `true`, the response includes term positions. | +| `preference` | string | The node or shard the operation should be performed on. It is random by default. | +| `querystring` | { [key: string]: any; } & { index?: never; id?: never; preference?: never; realtime?: never; doc?: never; filter?: never; per_field_analyzer?: never; fields?: never; field_statistics?: never; offsets?: never; payloads?: never; positions?: never; term_statistics?: never; routing?: never; version?: never; version_type?: never; } | All values in `querystring` will be added to the request querystring. | +| `realtime` | boolean | If true, the request is real-time as opposed to near-real-time. | +| `routing` | [Routing](./Routing.md) | A custom value that is used to route operations to a specific shard. | +| `term_statistics` | boolean | If `true`, the response includes: * The total term frequency (how often a term occurs in all documents). * The document frequency (the number of documents containing the current term). By default these values are not returned since term statistics can have a serious performance impact. | +| `version_type` | [VersionType](./VersionType.md) | The version type. | +| `version` | [VersionNumber](./VersionNumber.md) | If `true`, returns the document version as part of a hit. | diff --git a/docs/reference/api/TermvectorsResponse.md b/docs/reference/api/TermvectorsResponse.md new file mode 100644 index 000000000..0058311b2 --- /dev/null +++ b/docs/reference/api/TermvectorsResponse.md @@ -0,0 +1,10 @@ +## Interface `TermvectorsResponse` + +| Name | Type | Description | +| - | - | - | +| `_id` | [Id](./Id.md) |   | +| `_index` | [IndexName](./IndexName.md) |   | +| `_version` | [VersionNumber](./VersionNumber.md) |   | +| `found` | boolean |   | +| `term_vectors` | Record<[Field](./Field.md), [TermvectorsTermVector](./TermvectorsTermVector.md)> |   | +| `took` | [long](./long.md) |   | diff --git a/docs/reference/api/TermvectorsTerm.md b/docs/reference/api/TermvectorsTerm.md new file mode 100644 index 000000000..786412b46 --- /dev/null +++ b/docs/reference/api/TermvectorsTerm.md @@ -0,0 +1,9 @@ +## Interface `TermvectorsTerm` + +| Name | Type | Description | +| - | - | - | +| `doc_freq` | [integer](./integer.md) |   | +| `score` | [double](./double.md) |   | +| `term_freq` | [integer](./integer.md) |   | +| `tokens` | [TermvectorsToken](./TermvectorsToken.md)[] |   | +| `ttf` | [integer](./integer.md) |   | diff --git a/docs/reference/api/TermvectorsTermVector.md b/docs/reference/api/TermvectorsTermVector.md new file mode 100644 index 000000000..6e11008fa --- /dev/null +++ b/docs/reference/api/TermvectorsTermVector.md @@ -0,0 +1,6 @@ +## Interface `TermvectorsTermVector` + +| Name | Type | Description | +| - | - | - | +| `field_statistics` | [TermvectorsFieldStatistics](./TermvectorsFieldStatistics.md) |   | +| `terms` | Record |   | diff --git a/docs/reference/api/TermvectorsToken.md b/docs/reference/api/TermvectorsToken.md new file mode 100644 index 000000000..bb14d7b9e --- /dev/null +++ b/docs/reference/api/TermvectorsToken.md @@ -0,0 +1,8 @@ +## Interface `TermvectorsToken` + +| Name | Type | Description | +| - | - | - | +| `end_offset` | [integer](./integer.md) |   | +| `payload` | string |   | +| `position` | [integer](./integer.md) |   | +| `start_offset` | [integer](./integer.md) |   | diff --git a/docs/reference/api/TextEmbedding.md b/docs/reference/api/TextEmbedding.md new file mode 100644 index 000000000..aa5cd1d9f --- /dev/null +++ b/docs/reference/api/TextEmbedding.md @@ -0,0 +1,6 @@ +## Interface `TextEmbedding` + +| Name | Type | Description | +| - | - | - | +| `model_id` | string |   | +| `model_text` | string |   | diff --git a/docs/reference/api/TextSimilarityReranker.md b/docs/reference/api/TextSimilarityReranker.md new file mode 100644 index 000000000..ac49770de --- /dev/null +++ b/docs/reference/api/TextSimilarityReranker.md @@ -0,0 +1,9 @@ +## Interface `TextSimilarityReranker` + +| Name | Type | Description | +| - | - | - | +| `field` | string | The document field to be used for text similarity comparisons. This field should contain the text that will be evaluated against the inference_text | +| `inference_id` | string | Unique identifier of the inference endpoint created using the inference API. | +| `inference_text` | string | The text snippet used as the basis for similarity comparison | +| `rank_window_size` | [integer](./integer.md) | This value determines how many documents we will consider from the nested retriever. | +| `retriever` | [RetrieverContainer](./RetrieverContainer.md) | The nested retriever which will produce the first-level results, that will later be used for reranking. | diff --git a/docs/reference/api/TextStructure.md b/docs/reference/api/TextStructure.md new file mode 100644 index 000000000..2867d8f81 --- /dev/null +++ b/docs/reference/api/TextStructure.md @@ -0,0 +1,20 @@ +## `TextStructure` + +### Constructor + +::: +new TextStructure(transport: [Transport](./Transport.md)); +::: + +### Properties + +| Name | Type | Description | +| - | - | - | +| `acceptedParams` | Record |   | +| `transport` | [Transport](./Transport.md) |   | + +### Methods + +| Name | Signature | Description | +| - | - | - | +| `findFieldStructure` | `findFieldStructure(this: [That](./That.md), params: [TextStructureFindFieldStructureRequest](./TextStructureFindFieldStructureRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TextStructureFindFieldStructureResponse](./TextStructureFindFieldStructureResponse.md)>;` | Find the structure of a text field. Find the structure of a text field in an Elasticsearch index. This API provides a starting point for extracting further information from log messages already ingested into Elasticsearch. For example, if you have ingested data into a very simple index that has just `@timestamp` and message fields, you can use this API to see what common structure exists in the message field. The response from the API contains: * Sample messages. * Statistics that reveal the most common values for all fields detected within the text and basic numeric statistics for numeric fields. * Information about the structure of the text, which is useful when you write ingest configurations to index it or similarly formatted text. * Appropriate mappings for an Elasticsearch index, which you could use to ingest the text. All this information can be calculated by the structure finder with no guidance. However, you can optionally override some of the decisions about the text structure by specifying one or more query parameters. If the structure finder produces unexpected results, specify the `explain` query parameter and an explanation will appear in the response. It helps determine why the returned structure was chosen. || `findFieldStructure` | `findFieldStructure(this: [That](./That.md), params: [TextStructureFindFieldStructureRequest](./TextStructureFindFieldStructureRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TextStructureFindFieldStructureResponse](./TextStructureFindFieldStructureResponse.md), unknown>>;` |   || `findFieldStructure` | `findFieldStructure(this: [That](./That.md), params: [TextStructureFindFieldStructureRequest](./TextStructureFindFieldStructureRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TextStructureFindFieldStructureResponse](./TextStructureFindFieldStructureResponse.md)>;` |   || `findMessageStructure` | `findMessageStructure(this: [That](./That.md), params: [TextStructureFindMessageStructureRequest](./TextStructureFindMessageStructureRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TextStructureFindMessageStructureResponse](./TextStructureFindMessageStructureResponse.md)>;` | Find the structure of text messages. Find the structure of a list of text messages. The messages must contain data that is suitable to be ingested into Elasticsearch. This API provides a starting point for ingesting data into Elasticsearch in a format that is suitable for subsequent use with other Elastic Stack functionality. Use this API rather than the find text structure API if your input text has already been split up into separate messages by some other process. The response from the API contains: * Sample messages. * Statistics that reveal the most common values for all fields detected within the text and basic numeric statistics for numeric fields. * Information about the structure of the text, which is useful when you write ingest configurations to index it or similarly formatted text. Appropriate mappings for an Elasticsearch index, which you could use to ingest the text. All this information can be calculated by the structure finder with no guidance. However, you can optionally override some of the decisions about the text structure by specifying one or more query parameters. If the structure finder produces unexpected results, specify the `explain` query parameter and an explanation will appear in the response. It helps determine why the returned structure was chosen. || `findMessageStructure` | `findMessageStructure(this: [That](./That.md), params: [TextStructureFindMessageStructureRequest](./TextStructureFindMessageStructureRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TextStructureFindMessageStructureResponse](./TextStructureFindMessageStructureResponse.md), unknown>>;` |   || `findMessageStructure` | `findMessageStructure(this: [That](./That.md), params: [TextStructureFindMessageStructureRequest](./TextStructureFindMessageStructureRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TextStructureFindMessageStructureResponse](./TextStructureFindMessageStructureResponse.md)>;` |   || `findStructure` | `findStructure(this: [That](./That.md), params: [TextStructureFindStructureRequest](./TextStructureFindStructureRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TextStructureFindStructureResponse](./TextStructureFindStructureResponse.md)>;` | Find the structure of a text file. The text file must contain data that is suitable to be ingested into Elasticsearch. This API provides a starting point for ingesting data into Elasticsearch in a format that is suitable for subsequent use with other Elastic Stack functionality. Unlike other Elasticsearch endpoints, the data that is posted to this endpoint does not need to be UTF-8 encoded and in JSON format. It must, however, be text; binary text formats are not currently supported. The size is limited to the Elasticsearch HTTP receive buffer size, which defaults to 100 Mb. The response from the API contains: * A couple of messages from the beginning of the text. * Statistics that reveal the most common values for all fields detected within the text and basic numeric statistics for numeric fields. * Information about the structure of the text, which is useful when you write ingest configurations to index it or similarly formatted text. * Appropriate mappings for an Elasticsearch index, which you could use to ingest the text. All this information can be calculated by the structure finder with no guidance. However, you can optionally override some of the decisions about the text structure by specifying one or more query parameters. || `findStructure` | `findStructure(this: [That](./That.md), params: [TextStructureFindStructureRequest](./TextStructureFindStructureRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TextStructureFindStructureResponse](./TextStructureFindStructureResponse.md), unknown>>;` |   || `findStructure` | `findStructure(this: [That](./That.md), params: [TextStructureFindStructureRequest](./TextStructureFindStructureRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TextStructureFindStructureResponse](./TextStructureFindStructureResponse.md)>;` |   || `testGrokPattern` | `testGrokPattern(this: [That](./That.md), params: [TextStructureTestGrokPatternRequest](./TextStructureTestGrokPatternRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TextStructureTestGrokPatternResponse](./TextStructureTestGrokPatternResponse.md)>;` | Test a Grok pattern. Test a Grok pattern on one or more lines of text. The API indicates whether the lines match the pattern together with the offsets and lengths of the matched substrings. || `testGrokPattern` | `testGrokPattern(this: [That](./That.md), params: [TextStructureTestGrokPatternRequest](./TextStructureTestGrokPatternRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TextStructureTestGrokPatternResponse](./TextStructureTestGrokPatternResponse.md), unknown>>;` |   || `testGrokPattern` | `testGrokPattern(this: [That](./That.md), params: [TextStructureTestGrokPatternRequest](./TextStructureTestGrokPatternRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TextStructureTestGrokPatternResponse](./TextStructureTestGrokPatternResponse.md)>;` |   | \ No newline at end of file diff --git a/docs/reference/api/TextStructureEcsCompatibilityType.md b/docs/reference/api/TextStructureEcsCompatibilityType.md new file mode 100644 index 000000000..2e32db195 --- /dev/null +++ b/docs/reference/api/TextStructureEcsCompatibilityType.md @@ -0,0 +1,4 @@ +## `TextStructureEcsCompatibilityType` +::: +type TextStructureEcsCompatibilityType = 'disabled' | 'v1'; +::: diff --git a/docs/reference/api/TextStructureFieldStat.md b/docs/reference/api/TextStructureFieldStat.md new file mode 100644 index 000000000..e92f131c8 --- /dev/null +++ b/docs/reference/api/TextStructureFieldStat.md @@ -0,0 +1,13 @@ +## Interface `TextStructureFieldStat` + +| Name | Type | Description | +| - | - | - | +| `cardinality` | [integer](./integer.md) |   | +| `count` | [integer](./integer.md) |   | +| `earliest` | string |   | +| `latest` | string |   | +| `max_value` | [integer](./integer.md) |   | +| `mean_value` | [integer](./integer.md) |   | +| `median_value` | [integer](./integer.md) |   | +| `min_value` | [integer](./integer.md) |   | +| `top_hits` | [TextStructureTopHit](./TextStructureTopHit.md)[] |   | diff --git a/docs/reference/api/TextStructureFindFieldStructureRequest.md b/docs/reference/api/TextStructureFindFieldStructureRequest.md new file mode 100644 index 000000000..f9cb10203 --- /dev/null +++ b/docs/reference/api/TextStructureFindFieldStructureRequest.md @@ -0,0 +1,20 @@ +## Interface `TextStructureFindFieldStructureRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { column_names?: never; delimiter?: never; documents_to_sample?: never; ecs_compatibility?: never; explain?: never; field?: never; format?: never; grok_pattern?: never; index?: never; quote?: never; should_trim_fields?: never; timeout?: never; timestamp_field?: never; timestamp_format?: never; }) | All values in `body` will be added to the request body. | +| `column_names` | string | If `format` is set to `delimited`, you can specify the column names in a comma-separated list. If this parameter is not specified, the structure finder uses the column names from the header row of the text. If the text does not have a header row, columns are named "column1", "column2", "column3", for example. | +| `delimiter` | string | If you have set `format` to `delimited`, you can specify the character used to delimit the values in each row. Only a single character is supported; the delimiter cannot have multiple characters. By default, the API considers the following possibilities: comma, tab, semi-colon, and pipe ( `|`). In this default scenario, all rows must have the same number of fields for the delimited format to be detected. If you specify a delimiter, up to 10% of the rows can have a different number of columns than the first row. | +| `documents_to_sample` | [uint](./uint.md) | The number of documents to include in the structural analysis. The minimum value is 2. | +| `ecs_compatibility` | [TextStructureEcsCompatibilityType](./TextStructureEcsCompatibilityType.md) | The mode of compatibility with ECS compliant Grok patterns. Use this parameter to specify whether to use ECS Grok patterns instead of legacy ones when the structure finder creates a Grok pattern. This setting primarily has an impact when a whole message Grok pattern such as `%{CATALINALOG}` matches the input. If the structure finder identifies a common structure but has no idea of the meaning then generic field names such as `path`, `ipaddress`, `field1`, and `field2` are used in the `grok_pattern` output. The intention in that situation is that a user who knows the meanings will rename the fields before using them. | +| `explain` | boolean | If `true`, the response includes a field named `explanation`, which is an array of strings that indicate how the structure finder produced its result. | +| `field` | [Field](./Field.md) | The field that should be analyzed. | +| `format` | [TextStructureFormatType](./TextStructureFormatType.md) | The high level structure of the text. By default, the API chooses the format. In this default scenario, all rows must have the same number of fields for a delimited format to be detected. If the format is set to delimited and the delimiter is not set, however, the API tolerates up to 5% of rows that have a different number of columns than the first row. | +| `grok_pattern` | [GrokPattern](./GrokPattern.md) | If the format is `semi_structured_text`, you can specify a Grok pattern that is used to extract fields from every message in the text. The name of the timestamp field in the Grok pattern must match what is specified in the `timestamp_field` parameter. If that parameter is not specified, the name of the timestamp field in the Grok pattern must match "timestamp". If `grok_pattern` is not specified, the structure finder creates a Grok pattern. | +| `index` | [IndexName](./IndexName.md) | The name of the index that contains the analyzed field. | +| `querystring` | { [key: string]: any; } & { column_names?: never; delimiter?: never; documents_to_sample?: never; ecs_compatibility?: never; explain?: never; field?: never; format?: never; grok_pattern?: never; index?: never; quote?: never; should_trim_fields?: never; timeout?: never; timestamp_field?: never; timestamp_format?: never; } | All values in `querystring` will be added to the request querystring. | +| `quote` | string | If the format is `delimited`, you can specify the character used to quote the values in each row if they contain newlines or the delimiter character. Only a single character is supported. If this parameter is not specified, the default value is a double quote ( `"`). If your delimited text format does not use quoting, a workaround is to set this argument to a character that does not appear anywhere in the sample. | +| `should_trim_fields` | boolean | If the format is `delimited`, you can specify whether values between delimiters should have whitespace trimmed from them. If this parameter is not specified and the delimiter is pipe ( `|`), the default value is true. Otherwise, the default value is `false`. | +| `timeout` | [Duration](./Duration.md) | The maximum amount of time that the structure analysis can take. If the analysis is still running when the timeout expires, it will be stopped. | +| `timestamp_field` | [Field](./Field.md) | The name of the field that contains the primary timestamp of each record in the text. In particular, if the text was ingested into an index, this is the field that would be used to populate the `@timestamp` field. If the format is `semi_structured_text`, this field must match the name of the appropriate extraction in the `grok_pattern`. Therefore, for semi-structured text, it is best not to specify this parameter unless `grok_pattern` is also specified. For structured text, if you specify this parameter, the field must exist within the text. If this parameter is not specified, the structure finder makes a decision about which field (if any) is the primary timestamp field. For structured text, it is not compulsory to have a timestamp in the text. | +| `timestamp_format` | string | The Java time format of the timestamp field in the text. Only a subset of Java time format letter groups are supported: * `a` * `d` * `dd` * `EEE` * `EEEE` * `H` * `HH` * `h` * `M` * `MM` * `MMM` * `MMMM` * `mm` * `ss` * `XX` * `XXX` * `yy` * `yyyy` * `zzz`Additionally `S` letter groups (fractional seconds) of length one to nine are supported providing they occur after `ss` and are separated from the `ss` by a period ( `.`), comma ( `,`), or colon ( `:`). Spacing and punctuation is also permitted with the exception a question mark ( `?`), newline, and carriage return, together with literal text enclosed in single quotes. For example, `MM/dd HH.mm.ss,SSSSSS 'in' yyyy` is a valid override format. One valuable use case for this parameter is when the format is semi-structured text, there are multiple timestamp formats in the text, and you know which format corresponds to the primary timestamp, but you do not want to specify the full `grok_pattern`. Another is when the timestamp format is one that the structure finder does not consider by default. If this parameter is not specified, the structure finder chooses the best format from a built-in set. If the special value `null` is specified, the structure finder will not look for a primary timestamp in the text. When the format is semi-structured text, this will result in the structure finder treating the text as single-line messages. | diff --git a/docs/reference/api/TextStructureFindFieldStructureResponse.md b/docs/reference/api/TextStructureFindFieldStructureResponse.md new file mode 100644 index 000000000..4a8b5cecb --- /dev/null +++ b/docs/reference/api/TextStructureFindFieldStructureResponse.md @@ -0,0 +1,19 @@ +## Interface `TextStructureFindFieldStructureResponse` + +| Name | Type | Description | +| - | - | - | +| `charset` | string |   | +| `ecs_compatibility` | [TextStructureEcsCompatibilityType](./TextStructureEcsCompatibilityType.md) |   | +| `field_stats` | Record<[Field](./Field.md), [TextStructureFieldStat](./TextStructureFieldStat.md)> |   | +| `format` | [TextStructureFormatType](./TextStructureFormatType.md) |   | +| `grok_pattern` | [GrokPattern](./GrokPattern.md) |   | +| `ingest_pipeline` | [IngestPipelineConfig](./IngestPipelineConfig.md) |   | +| `java_timestamp_formats` | string[] |   | +| `joda_timestamp_formats` | string[] |   | +| `mappings` | [MappingTypeMapping](./MappingTypeMapping.md) |   | +| `multiline_start_pattern` | string |   | +| `need_client_timezone` | boolean |   | +| `num_lines_analyzed` | [integer](./integer.md) |   | +| `num_messages_analyzed` | [integer](./integer.md) |   | +| `sample_start` | string |   | +| `timestamp_field` | [Field](./Field.md) |   | diff --git a/docs/reference/api/TextStructureFindMessageStructureRequest.md b/docs/reference/api/TextStructureFindMessageStructureRequest.md new file mode 100644 index 000000000..9a0ff5109 --- /dev/null +++ b/docs/reference/api/TextStructureFindMessageStructureRequest.md @@ -0,0 +1,18 @@ +## Interface `TextStructureFindMessageStructureRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { column_names?: never; delimiter?: never; ecs_compatibility?: never; explain?: never; format?: never; grok_pattern?: never; quote?: never; should_trim_fields?: never; timeout?: never; timestamp_field?: never; timestamp_format?: never; messages?: never; }) | All values in `body` will be added to the request body. | +| `column_names` | string | If the format is `delimited`, you can specify the column names in a comma-separated list. If this parameter is not specified, the structure finder uses the column names from the header row of the text. If the text does not have a header role, columns are named "column1", "column2", "column3", for example. | +| `delimiter` | string | If you the format is `delimited`, you can specify the character used to delimit the values in each row. Only a single character is supported; the delimiter cannot have multiple characters. By default, the API considers the following possibilities: comma, tab, semi-colon, and pipe ( `|`). In this default scenario, all rows must have the same number of fields for the delimited format to be detected. If you specify a delimiter, up to 10% of the rows can have a different number of columns than the first row. | +| `ecs_compatibility` | [TextStructureEcsCompatibilityType](./TextStructureEcsCompatibilityType.md) | The mode of compatibility with ECS compliant Grok patterns. Use this parameter to specify whether to use ECS Grok patterns instead of legacy ones when the structure finder creates a Grok pattern. This setting primarily has an impact when a whole message Grok pattern such as `%{CATALINALOG}` matches the input. If the structure finder identifies a common structure but has no idea of meaning then generic field names such as `path`, `ipaddress`, `field1`, and `field2` are used in the `grok_pattern` output, with the intention that a user who knows the meanings rename these fields before using it. | +| `explain` | boolean | If this parameter is set to true, the response includes a field named `explanation`, which is an array of strings that indicate how the structure finder produced its result. | +| `format` | [TextStructureFormatType](./TextStructureFormatType.md) | The high level structure of the text. By default, the API chooses the format. In this default scenario, all rows must have the same number of fields for a delimited format to be detected. If the format is `delimited` and the delimiter is not set, however, the API tolerates up to 5% of rows that have a different number of columns than the first row. | +| `grok_pattern` | [GrokPattern](./GrokPattern.md) | If the format is `semi_structured_text`, you can specify a Grok pattern that is used to extract fields from every message in the text. The name of the timestamp field in the Grok pattern must match what is specified in the `timestamp_field` parameter. If that parameter is not specified, the name of the timestamp field in the Grok pattern must match "timestamp". If `grok_pattern` is not specified, the structure finder creates a Grok pattern. | +| `messages` | string[] | The list of messages you want to analyze. | +| `querystring` | { [key: string]: any; } & { column_names?: never; delimiter?: never; ecs_compatibility?: never; explain?: never; format?: never; grok_pattern?: never; quote?: never; should_trim_fields?: never; timeout?: never; timestamp_field?: never; timestamp_format?: never; messages?: never; } | All values in `querystring` will be added to the request querystring. | +| `quote` | string | If the format is `delimited`, you can specify the character used to quote the values in each row if they contain newlines or the delimiter character. Only a single character is supported. If this parameter is not specified, the default value is a double quote ( `"`). If your delimited text format does not use quoting, a workaround is to set this argument to a character that does not appear anywhere in the sample. | +| `should_trim_fields` | boolean | If the format is `delimited`, you can specify whether values between delimiters should have whitespace trimmed from them. If this parameter is not specified and the delimiter is pipe ( `|`), the default value is true. Otherwise, the default value is `false`. | +| `timeout` | [Duration](./Duration.md) | The maximum amount of time that the structure analysis can take. If the analysis is still running when the timeout expires, it will be stopped. | +| `timestamp_field` | [Field](./Field.md) | The name of the field that contains the primary timestamp of each record in the text. In particular, if the text was ingested into an index, this is the field that would be used to populate the `@timestamp` field. If the format is `semi_structured_text`, this field must match the name of the appropriate extraction in the `grok_pattern`. Therefore, for semi-structured text, it is best not to specify this parameter unless `grok_pattern` is also specified. For structured text, if you specify this parameter, the field must exist within the text. If this parameter is not specified, the structure finder makes a decision about which field (if any) is the primary timestamp field. For structured text, it is not compulsory to have a timestamp in the text. | +| `timestamp_format` | string | The Java time format of the timestamp field in the text. Only a subset of Java time format letter groups are supported: * `a` * `d` * `dd` * `EEE` * `EEEE` * `H` * `HH` * `h` * `M` * `MM` * `MMM` * `MMMM` * `mm` * `ss` * `XX` * `XXX` * `yy` * `yyyy` * `zzz`Additionally `S` letter groups (fractional seconds) of length one to nine are supported providing they occur after `ss` and are separated from the `ss` by a period ( `.`), comma ( `,`), or colon ( `:`). Spacing and punctuation is also permitted with the exception a question mark ( `?`), newline, and carriage return, together with literal text enclosed in single quotes. For example, `MM/dd HH.mm.ss,SSSSSS 'in' yyyy` is a valid override format. One valuable use case for this parameter is when the format is semi-structured text, there are multiple timestamp formats in the text, and you know which format corresponds to the primary timestamp, but you do not want to specify the full `grok_pattern`. Another is when the timestamp format is one that the structure finder does not consider by default. If this parameter is not specified, the structure finder chooses the best format from a built-in set. If the special value `null` is specified, the structure finder will not look for a primary timestamp in the text. When the format is semi-structured text, this will result in the structure finder treating the text as single-line messages. | diff --git a/docs/reference/api/TextStructureFindMessageStructureResponse.md b/docs/reference/api/TextStructureFindMessageStructureResponse.md new file mode 100644 index 000000000..964dc3f6f --- /dev/null +++ b/docs/reference/api/TextStructureFindMessageStructureResponse.md @@ -0,0 +1,19 @@ +## Interface `TextStructureFindMessageStructureResponse` + +| Name | Type | Description | +| - | - | - | +| `charset` | string |   | +| `ecs_compatibility` | [TextStructureEcsCompatibilityType](./TextStructureEcsCompatibilityType.md) |   | +| `field_stats` | Record<[Field](./Field.md), [TextStructureFieldStat](./TextStructureFieldStat.md)> |   | +| `format` | [TextStructureFormatType](./TextStructureFormatType.md) |   | +| `grok_pattern` | [GrokPattern](./GrokPattern.md) |   | +| `ingest_pipeline` | [IngestPipelineConfig](./IngestPipelineConfig.md) |   | +| `java_timestamp_formats` | string[] |   | +| `joda_timestamp_formats` | string[] |   | +| `mappings` | [MappingTypeMapping](./MappingTypeMapping.md) |   | +| `multiline_start_pattern` | string |   | +| `need_client_timezone` | boolean |   | +| `num_lines_analyzed` | [integer](./integer.md) |   | +| `num_messages_analyzed` | [integer](./integer.md) |   | +| `sample_start` | string |   | +| `timestamp_field` | [Field](./Field.md) |   | diff --git a/docs/reference/api/TextStructureFindStructureRequest.md b/docs/reference/api/TextStructureFindStructureRequest.md new file mode 100644 index 000000000..5bf541fbd --- /dev/null +++ b/docs/reference/api/TextStructureFindStructureRequest.md @@ -0,0 +1,22 @@ +## Interface `TextStructureFindStructureRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { charset?: never; column_names?: never; delimiter?: never; ecs_compatibility?: never; explain?: never; format?: never; grok_pattern?: never; has_header_row?: never; line_merge_size_limit?: never; lines_to_sample?: never; quote?: never; should_trim_fields?: never; timeout?: never; timestamp_field?: never; timestamp_format?: never; text_files?: never; }) | All values in `body` will be added to the request body. | +| `charset` | string | The text's character set. It must be a character set that is supported by the JVM that Elasticsearch uses. For example, `UTF-8`, `UTF-16LE`, `windows-1252`, or `EUC-JP`. If this parameter is not specified, the structure finder chooses an appropriate character set. | +| `column_names` | string | If you have set format to `delimited`, you can specify the column names in a comma-separated list. If this parameter is not specified, the structure finder uses the column names from the header row of the text. If the text does not have a header role, columns are named "column1", "column2", "column3", for example. | +| `delimiter` | string | If you have set `format` to `delimited`, you can specify the character used to delimit the values in each row. Only a single character is supported; the delimiter cannot have multiple characters. By default, the API considers the following possibilities: comma, tab, semi-colon, and pipe ( `|`). In this default scenario, all rows must have the same number of fields for the delimited format to be detected. If you specify a delimiter, up to 10% of the rows can have a different number of columns than the first row. | +| `ecs_compatibility` | string | The mode of compatibility with ECS compliant Grok patterns. Use this parameter to specify whether to use ECS Grok patterns instead of legacy ones when the structure finder creates a Grok pattern. Valid values are `disabled` and `v1`. This setting primarily has an impact when a whole message Grok pattern such as `%{CATALINALOG}` matches the input. If the structure finder identifies a common structure but has no idea of meaning then generic field names such as `path`, `ipaddress`, `field1`, and `field2` are used in the `grok_pattern` output, with the intention that a user who knows the meanings rename these fields before using it. | +| `explain` | boolean | If this parameter is set to `true`, the response includes a field named explanation, which is an array of strings that indicate how the structure finder produced its result. If the structure finder produces unexpected results for some text, use this query parameter to help you determine why the returned structure was chosen. | +| `format` | string | The high level structure of the text. Valid values are `ndjson`, `xml`, `delimited`, and `semi_structured_text`. By default, the API chooses the format. In this default scenario, all rows must have the same number of fields for a delimited format to be detected. If the format is set to `delimited` and the delimiter is not set, however, the API tolerates up to 5% of rows that have a different number of columns than the first row. | +| `grok_pattern` | [GrokPattern](./GrokPattern.md) | If you have set `format` to `semi_structured_text`, you can specify a Grok pattern that is used to extract fields from every message in the text. The name of the timestamp field in the Grok pattern must match what is specified in the `timestamp_field` parameter. If that parameter is not specified, the name of the timestamp field in the Grok pattern must match "timestamp". If `grok_pattern` is not specified, the structure finder creates a Grok pattern. | +| `has_header_row` | boolean | If you have set `format` to `delimited`, you can use this parameter to indicate whether the column names are in the first row of the text. If this parameter is not specified, the structure finder guesses based on the similarity of the first row of the text to other rows. | +| `line_merge_size_limit` | [uint](./uint.md) | The maximum number of characters in a message when lines are merged to form messages while analyzing semi-structured text. If you have extremely long messages you may need to increase this, but be aware that this may lead to very long processing times if the way to group lines into messages is misdetected. | +| `lines_to_sample` | [uint](./uint.md) | The number of lines to include in the structural analysis, starting from the beginning of the text. The minimum is 2. If the value of this parameter is greater than the number of lines in the text, the analysis proceeds (as long as there are at least two lines in the text) for all of the lines. NOTE: The number of lines and the variation of the lines affects the speed of the analysis. For example, if you upload text where the first 1000 lines are all variations on the same message, the analysis will find more commonality than would be seen with a bigger sample. If possible, however, it is more efficient to upload sample text with more variety in the first 1000 lines than to request analysis of 100000 lines to achieve some variety. | +| `querystring` | { [key: string]: any; } & { charset?: never; column_names?: never; delimiter?: never; ecs_compatibility?: never; explain?: never; format?: never; grok_pattern?: never; has_header_row?: never; line_merge_size_limit?: never; lines_to_sample?: never; quote?: never; should_trim_fields?: never; timeout?: never; timestamp_field?: never; timestamp_format?: never; text_files?: never; } | All values in `querystring` will be added to the request querystring. | +| `quote` | string | If you have set `format` to `delimited`, you can specify the character used to quote the values in each row if they contain newlines or the delimiter character. Only a single character is supported. If this parameter is not specified, the default value is a double quote ( `"`). If your delimited text format does not use quoting, a workaround is to set this argument to a character that does not appear anywhere in the sample. | +| `should_trim_fields` | boolean | If you have set `format` to `delimited`, you can specify whether values between delimiters should have whitespace trimmed from them. If this parameter is not specified and the delimiter is pipe ( `|`), the default value is `true`. Otherwise, the default value is `false`. | +| `text_files` | TJsonDocument[] |   | +| `timeout` | [Duration](./Duration.md) | The maximum amount of time that the structure analysis can take. If the analysis is still running when the timeout expires then it will be stopped. | +| `timestamp_field` | [Field](./Field.md) | The name of the field that contains the primary timestamp of each record in the text. In particular, if the text were ingested into an index, this is the field that would be used to populate the `@timestamp` field. If the `format` is `semi_structured_text`, this field must match the name of the appropriate extraction in the `grok_pattern`. Therefore, for semi-structured text, it is best not to specify this parameter unless `grok_pattern` is also specified. For structured text, if you specify this parameter, the field must exist within the text. If this parameter is not specified, the structure finder makes a decision about which field (if any) is the primary timestamp field. For structured text, it is not compulsory to have a timestamp in the text. | +| `timestamp_format` | string | The Java time format of the timestamp field in the text. Only a subset of Java time format letter groups are supported: * `a` * `d` * `dd` * `EEE` * `EEEE` * `H` * `HH` * `h` * `M` * `MM` * `MMM` * `MMMM` * `mm` * `ss` * `XX` * `XXX` * `yy` * `yyyy` * `zzz`Additionally `S` letter groups (fractional seconds) of length one to nine are supported providing they occur after `ss` and separated from the `ss` by a `.`, `,` or `:`. Spacing and punctuation is also permitted with the exception of `?`, newline and carriage return, together with literal text enclosed in single quotes. For example, `MM/dd HH.mm.ss,SSSSSS 'in' yyyy` is a valid override format. One valuable use case for this parameter is when the format is semi-structured text, there are multiple timestamp formats in the text, and you know which format corresponds to the primary timestamp, but you do not want to specify the full `grok_pattern`. Another is when the timestamp format is one that the structure finder does not consider by default. If this parameter is not specified, the structure finder chooses the best format from a built-in set. If the special value `null` is specified the structure finder will not look for a primary timestamp in the text. When the format is semi-structured text this will result in the structure finder treating the text as single-line messages. | diff --git a/docs/reference/api/TextStructureFindStructureResponse.md b/docs/reference/api/TextStructureFindStructureResponse.md new file mode 100644 index 000000000..bcf09c0dc --- /dev/null +++ b/docs/reference/api/TextStructureFindStructureResponse.md @@ -0,0 +1,26 @@ +## Interface `TextStructureFindStructureResponse` + +| Name | Type | Description | +| - | - | - | +| `charset` | string | The character encoding used to parse the text. | +| `column_names` | string[] | If `format` is `delimited`, the `column_names` field lists the column names in the order they appear in the sample. | +| `delimiter` | string |   | +| `exclude_lines_pattern` | string |   | +| `explanation` | string[] |   | +| `field_stats` | Record<[Field](./Field.md), [TextStructureFieldStat](./TextStructureFieldStat.md)> | The most common values of each field, plus basic numeric statistics for the numeric `page_count` field. This information may provide clues that the data needs to be cleaned or transformed prior to use by other Elastic Stack functionality. | +| `format` | string | Valid values include `ndjson`, `xml`, `delimited`, and `semi_structured_text`. | +| `grok_pattern` | [GrokPattern](./GrokPattern.md) |   | +| `has_byte_order_marker` | boolean | For UTF character encodings, it indicates whether the text begins with a byte order marker. | +| `has_header_row` | boolean |   | +| `ingest_pipeline` | [IngestPipelineConfig](./IngestPipelineConfig.md) |   | +| `java_timestamp_formats` | string[] | The Java time formats recognized in the time fields. Elasticsearch mappings and ingest pipelines use this format. | +| `joda_timestamp_formats` | string[] | Information that is used to tell Logstash how to parse timestamps. | +| `mappings` | [MappingTypeMapping](./MappingTypeMapping.md) | Some suitable mappings for an index into which the data could be ingested. | +| `multiline_start_pattern` | string |   | +| `need_client_timezone` | boolean | If a timestamp format is detected that does not include a timezone, `need_client_timezone` is `true`. The server that parses the text must therefore be told the correct timezone by the client. | +| `num_lines_analyzed` | [integer](./integer.md) | The number of lines of the text that were analyzed. | +| `num_messages_analyzed` | [integer](./integer.md) | The number of distinct messages the lines contained. For NDJSON, this value is the same as `num_lines_analyzed`. For other text formats, messages can span several lines. | +| `quote` | string |   | +| `sample_start` | string | The first two messages in the text verbatim. This may help diagnose parse errors or accidental uploads of the wrong text. | +| `should_trim_fields` | boolean |   | +| `timestamp_field` | [Field](./Field.md) | The field considered most likely to be the primary timestamp of each document. | diff --git a/docs/reference/api/TextStructureFormatType.md b/docs/reference/api/TextStructureFormatType.md new file mode 100644 index 000000000..9dd75460b --- /dev/null +++ b/docs/reference/api/TextStructureFormatType.md @@ -0,0 +1,4 @@ +## `TextStructureFormatType` +::: +type TextStructureFormatType = 'delimited' | 'ndjson' | 'semi_structured_text' | 'xml'; +::: diff --git a/docs/reference/api/TextStructureTestGrokPatternMatchedField.md b/docs/reference/api/TextStructureTestGrokPatternMatchedField.md new file mode 100644 index 000000000..a036b66f4 --- /dev/null +++ b/docs/reference/api/TextStructureTestGrokPatternMatchedField.md @@ -0,0 +1,7 @@ +## Interface `TextStructureTestGrokPatternMatchedField` + +| Name | Type | Description | +| - | - | - | +| `length` | [integer](./integer.md) |   | +| `match` | string |   | +| `offset` | [integer](./integer.md) |   | diff --git a/docs/reference/api/TextStructureTestGrokPatternMatchedText.md b/docs/reference/api/TextStructureTestGrokPatternMatchedText.md new file mode 100644 index 000000000..ccf17b185 --- /dev/null +++ b/docs/reference/api/TextStructureTestGrokPatternMatchedText.md @@ -0,0 +1,6 @@ +## Interface `TextStructureTestGrokPatternMatchedText` + +| Name | Type | Description | +| - | - | - | +| `fields` | Record |   | +| `matched` | boolean |   | diff --git a/docs/reference/api/TextStructureTestGrokPatternRequest.md b/docs/reference/api/TextStructureTestGrokPatternRequest.md new file mode 100644 index 000000000..451d65901 --- /dev/null +++ b/docs/reference/api/TextStructureTestGrokPatternRequest.md @@ -0,0 +1,9 @@ +## Interface `TextStructureTestGrokPatternRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { ecs_compatibility?: never; grok_pattern?: never; text?: never; }) | All values in `body` will be added to the request body. | +| `ecs_compatibility` | string | The mode of compatibility with ECS compliant Grok patterns. Use this parameter to specify whether to use ECS Grok patterns instead of legacy ones when the structure finder creates a Grok pattern. Valid values are `disabled` and `v1`. | +| `grok_pattern` | [GrokPattern](./GrokPattern.md) | The Grok pattern to run on the text. | +| `querystring` | { [key: string]: any; } & { ecs_compatibility?: never; grok_pattern?: never; text?: never; } | All values in `querystring` will be added to the request querystring. | +| `text` | string[] | The lines of text to run the Grok pattern on. | diff --git a/docs/reference/api/TextStructureTestGrokPatternResponse.md b/docs/reference/api/TextStructureTestGrokPatternResponse.md new file mode 100644 index 000000000..dbd1ae4cc --- /dev/null +++ b/docs/reference/api/TextStructureTestGrokPatternResponse.md @@ -0,0 +1,5 @@ +## Interface `TextStructureTestGrokPatternResponse` + +| Name | Type | Description | +| - | - | - | +| `matches` | [TextStructureTestGrokPatternMatchedText](./TextStructureTestGrokPatternMatchedText.md)[] |   | diff --git a/docs/reference/api/TextStructureTopHit.md b/docs/reference/api/TextStructureTopHit.md new file mode 100644 index 000000000..68fa5b2dc --- /dev/null +++ b/docs/reference/api/TextStructureTopHit.md @@ -0,0 +1,6 @@ +## Interface `TextStructureTopHit` + +| Name | Type | Description | +| - | - | - | +| `count` | [long](./long.md) |   | +| `value` | any |   | diff --git a/docs/reference/api/That.md b/docs/reference/api/That.md new file mode 100644 index 000000000..49e001014 --- /dev/null +++ b/docs/reference/api/That.md @@ -0,0 +1,6 @@ +## Interface `That` + +| Name | Type | Description | +| - | - | - | +| `acceptedParams` | Record |   | +| `transport` | [Transport](./Transport.md) |   | diff --git a/docs/reference/api/That_10.md b/docs/reference/api/That_10.md new file mode 100644 index 000000000..5d1947908 --- /dev/null +++ b/docs/reference/api/That_10.md @@ -0,0 +1,6 @@ +## Interface `That_10` + +| Name | Type | Description | +| - | - | - | +| `acceptedParams` | Record |   | +| `transport` | [Transport](./Transport.md) |   | diff --git a/docs/reference/api/That_11.md b/docs/reference/api/That_11.md new file mode 100644 index 000000000..0df4b0346 --- /dev/null +++ b/docs/reference/api/That_11.md @@ -0,0 +1,5 @@ +## Interface `That_11` + +| Name | Type | Description | +| - | - | - | +| `transport` | [Transport](./Transport.md) |   | diff --git a/docs/reference/api/That_12.md b/docs/reference/api/That_12.md new file mode 100644 index 000000000..f76370fd8 --- /dev/null +++ b/docs/reference/api/That_12.md @@ -0,0 +1,5 @@ +## Interface `That_12` + +| Name | Type | Description | +| - | - | - | +| `transport` | [Transport](./Transport.md) |   | diff --git a/docs/reference/api/That_13.md b/docs/reference/api/That_13.md new file mode 100644 index 000000000..f19549708 --- /dev/null +++ b/docs/reference/api/That_13.md @@ -0,0 +1,6 @@ +## Interface `That_13` + +| Name | Type | Description | +| - | - | - | +| `acceptedParams` | Record |   | +| `transport` | [Transport](./Transport.md) |   | diff --git a/docs/reference/api/That_14.md b/docs/reference/api/That_14.md new file mode 100644 index 000000000..bc2b95421 --- /dev/null +++ b/docs/reference/api/That_14.md @@ -0,0 +1,5 @@ +## Interface `That_14` + +| Name | Type | Description | +| - | - | - | +| `transport` | [Transport](./Transport.md) |   | diff --git a/docs/reference/api/That_15.md b/docs/reference/api/That_15.md new file mode 100644 index 000000000..db5c10268 --- /dev/null +++ b/docs/reference/api/That_15.md @@ -0,0 +1,5 @@ +## Interface `That_15` + +| Name | Type | Description | +| - | - | - | +| `transport` | [Transport](./Transport.md) |   | diff --git a/docs/reference/api/That_16.md b/docs/reference/api/That_16.md new file mode 100644 index 000000000..8c98b9f0c --- /dev/null +++ b/docs/reference/api/That_16.md @@ -0,0 +1,5 @@ +## Interface `That_16` + +| Name | Type | Description | +| - | - | - | +| `transport` | [Transport](./Transport.md) |   | diff --git a/docs/reference/api/That_17.md b/docs/reference/api/That_17.md new file mode 100644 index 000000000..f85eabbdf --- /dev/null +++ b/docs/reference/api/That_17.md @@ -0,0 +1,5 @@ +## Interface `That_17` + +| Name | Type | Description | +| - | - | - | +| `transport` | [Transport](./Transport.md) |   | diff --git a/docs/reference/api/That_18.md b/docs/reference/api/That_18.md new file mode 100644 index 000000000..50e482bc8 --- /dev/null +++ b/docs/reference/api/That_18.md @@ -0,0 +1,6 @@ +## Interface `That_18` + +| Name | Type | Description | +| - | - | - | +| `acceptedParams` | Record |   | +| `transport` | [Transport](./Transport.md) |   | diff --git a/docs/reference/api/That_19.md b/docs/reference/api/That_19.md new file mode 100644 index 000000000..de51d501b --- /dev/null +++ b/docs/reference/api/That_19.md @@ -0,0 +1,6 @@ +## Interface `That_19` + +| Name | Type | Description | +| - | - | - | +| `acceptedParams` | Record |   | +| `transport` | [Transport](./Transport.md) |   | diff --git a/docs/reference/api/That_20.md b/docs/reference/api/That_20.md new file mode 100644 index 000000000..e99ae758e --- /dev/null +++ b/docs/reference/api/That_20.md @@ -0,0 +1,6 @@ +## Interface `That_20` + +| Name | Type | Description | +| - | - | - | +| `acceptedParams` | Record |   | +| `transport` | [Transport](./Transport.md) |   | diff --git a/docs/reference/api/That_21.md b/docs/reference/api/That_21.md new file mode 100644 index 000000000..2067b14f8 --- /dev/null +++ b/docs/reference/api/That_21.md @@ -0,0 +1,5 @@ +## Interface `That_21` + +| Name | Type | Description | +| - | - | - | +| `transport` | [Transport](./Transport.md) |   | diff --git a/docs/reference/api/That_22.md b/docs/reference/api/That_22.md new file mode 100644 index 000000000..a61b0847f --- /dev/null +++ b/docs/reference/api/That_22.md @@ -0,0 +1,5 @@ +## Interface `That_22` + +| Name | Type | Description | +| - | - | - | +| `transport` | [Transport](./Transport.md) |   | diff --git a/docs/reference/api/That_23.md b/docs/reference/api/That_23.md new file mode 100644 index 000000000..0bcbd01dd --- /dev/null +++ b/docs/reference/api/That_23.md @@ -0,0 +1,5 @@ +## Interface `That_23` + +| Name | Type | Description | +| - | - | - | +| `transport` | [Transport](./Transport.md) |   | diff --git a/docs/reference/api/That_24.md b/docs/reference/api/That_24.md new file mode 100644 index 000000000..e0011f687 --- /dev/null +++ b/docs/reference/api/That_24.md @@ -0,0 +1,6 @@ +## Interface `That_24` + +| Name | Type | Description | +| - | - | - | +| `acceptedParams` | Record |   | +| `transport` | [Transport](./Transport.md) |   | diff --git a/docs/reference/api/That_25.md b/docs/reference/api/That_25.md new file mode 100644 index 000000000..008939434 --- /dev/null +++ b/docs/reference/api/That_25.md @@ -0,0 +1,5 @@ +## Interface `That_25` + +| Name | Type | Description | +| - | - | - | +| `transport` | [Transport](./Transport.md) |   | diff --git a/docs/reference/api/That_26.md b/docs/reference/api/That_26.md new file mode 100644 index 000000000..6b70eaa2b --- /dev/null +++ b/docs/reference/api/That_26.md @@ -0,0 +1,6 @@ +## Interface `That_26` + +| Name | Type | Description | +| - | - | - | +| `acceptedParams` | Record |   | +| `transport` | [Transport](./Transport.md) |   | diff --git a/docs/reference/api/That_27.md b/docs/reference/api/That_27.md new file mode 100644 index 000000000..6ec75f008 --- /dev/null +++ b/docs/reference/api/That_27.md @@ -0,0 +1,5 @@ +## Interface `That_27` + +| Name | Type | Description | +| - | - | - | +| `transport` | [Transport](./Transport.md) |   | diff --git a/docs/reference/api/That_28.md b/docs/reference/api/That_28.md new file mode 100644 index 000000000..e8000fd90 --- /dev/null +++ b/docs/reference/api/That_28.md @@ -0,0 +1,5 @@ +## Interface `That_28` + +| Name | Type | Description | +| - | - | - | +| `transport` | [Transport](./Transport.md) |   | diff --git a/docs/reference/api/That_29.md b/docs/reference/api/That_29.md new file mode 100644 index 000000000..9ce75a10d --- /dev/null +++ b/docs/reference/api/That_29.md @@ -0,0 +1,5 @@ +## Interface `That_29` + +| Name | Type | Description | +| - | - | - | +| `transport` | [Transport](./Transport.md) |   | diff --git a/docs/reference/api/That_3.md b/docs/reference/api/That_3.md new file mode 100644 index 000000000..e178eaa9c --- /dev/null +++ b/docs/reference/api/That_3.md @@ -0,0 +1,5 @@ +## Interface `That_3` + +| Name | Type | Description | +| - | - | - | +| `transport` | [Transport](./Transport.md) |   | diff --git a/docs/reference/api/That_30.md b/docs/reference/api/That_30.md new file mode 100644 index 000000000..9515bc3fb --- /dev/null +++ b/docs/reference/api/That_30.md @@ -0,0 +1,5 @@ +## Interface `That_30` + +| Name | Type | Description | +| - | - | - | +| `transport` | [Transport](./Transport.md) |   | diff --git a/docs/reference/api/That_31.md b/docs/reference/api/That_31.md new file mode 100644 index 000000000..fd2a733a0 --- /dev/null +++ b/docs/reference/api/That_31.md @@ -0,0 +1,5 @@ +## Interface `That_31` + +| Name | Type | Description | +| - | - | - | +| `transport` | [Transport](./Transport.md) |   | diff --git a/docs/reference/api/That_32.md b/docs/reference/api/That_32.md new file mode 100644 index 000000000..94abe50f2 --- /dev/null +++ b/docs/reference/api/That_32.md @@ -0,0 +1,6 @@ +## Interface `That_32` + +| Name | Type | Description | +| - | - | - | +| `acceptedParams` | Record |   | +| `transport` | [Transport](./Transport.md) |   | diff --git a/docs/reference/api/That_33.md b/docs/reference/api/That_33.md new file mode 100644 index 000000000..f6fbb8ff1 --- /dev/null +++ b/docs/reference/api/That_33.md @@ -0,0 +1,5 @@ +## Interface `That_33` + +| Name | Type | Description | +| - | - | - | +| `transport` | [Transport](./Transport.md) |   | diff --git a/docs/reference/api/That_34.md b/docs/reference/api/That_34.md new file mode 100644 index 000000000..89f9c11e6 --- /dev/null +++ b/docs/reference/api/That_34.md @@ -0,0 +1,6 @@ +## Interface `That_34` + +| Name | Type | Description | +| - | - | - | +| `acceptedParams` | Record |   | +| `transport` | [Transport](./Transport.md) |   | diff --git a/docs/reference/api/That_35.md b/docs/reference/api/That_35.md new file mode 100644 index 000000000..af87a1e05 --- /dev/null +++ b/docs/reference/api/That_35.md @@ -0,0 +1,5 @@ +## Interface `That_35` + +| Name | Type | Description | +| - | - | - | +| `transport` | [Transport](./Transport.md) |   | diff --git a/docs/reference/api/That_36.md b/docs/reference/api/That_36.md new file mode 100644 index 000000000..f75d120c2 --- /dev/null +++ b/docs/reference/api/That_36.md @@ -0,0 +1,6 @@ +## Interface `That_36` + +| Name | Type | Description | +| - | - | - | +| `acceptedParams` | Record |   | +| `transport` | [Transport](./Transport.md) |   | diff --git a/docs/reference/api/That_37.md b/docs/reference/api/That_37.md new file mode 100644 index 000000000..2f4a5eeb3 --- /dev/null +++ b/docs/reference/api/That_37.md @@ -0,0 +1,6 @@ +## Interface `That_37` + +| Name | Type | Description | +| - | - | - | +| `acceptedParams` | Record |   | +| `transport` | [Transport](./Transport.md) |   | diff --git a/docs/reference/api/That_38.md b/docs/reference/api/That_38.md new file mode 100644 index 000000000..0eebddb4b --- /dev/null +++ b/docs/reference/api/That_38.md @@ -0,0 +1,5 @@ +## Interface `That_38` + +| Name | Type | Description | +| - | - | - | +| `transport` | [Transport](./Transport.md) |   | diff --git a/docs/reference/api/That_39.md b/docs/reference/api/That_39.md new file mode 100644 index 000000000..922ed7098 --- /dev/null +++ b/docs/reference/api/That_39.md @@ -0,0 +1,6 @@ +## Interface `That_39` + +| Name | Type | Description | +| - | - | - | +| `acceptedParams` | Record |   | +| `transport` | [Transport](./Transport.md) |   | diff --git a/docs/reference/api/That_4.md b/docs/reference/api/That_4.md new file mode 100644 index 000000000..304fd9984 --- /dev/null +++ b/docs/reference/api/That_4.md @@ -0,0 +1,5 @@ +## Interface `That_4` + +| Name | Type | Description | +| - | - | - | +| `transport` | [Transport](./Transport.md) |   | diff --git a/docs/reference/api/That_40.md b/docs/reference/api/That_40.md new file mode 100644 index 000000000..e3de796a1 --- /dev/null +++ b/docs/reference/api/That_40.md @@ -0,0 +1,5 @@ +## Interface `That_40` + +| Name | Type | Description | +| - | - | - | +| `transport` | [Transport](./Transport.md) |   | diff --git a/docs/reference/api/That_41.md b/docs/reference/api/That_41.md new file mode 100644 index 000000000..c3c5a2252 --- /dev/null +++ b/docs/reference/api/That_41.md @@ -0,0 +1,6 @@ +## Interface `That_41` + +| Name | Type | Description | +| - | - | - | +| `acceptedParams` | Record |   | +| `transport` | [Transport](./Transport.md) |   | diff --git a/docs/reference/api/That_42.md b/docs/reference/api/That_42.md new file mode 100644 index 000000000..104381863 --- /dev/null +++ b/docs/reference/api/That_42.md @@ -0,0 +1,6 @@ +## Interface `That_42` + +| Name | Type | Description | +| - | - | - | +| `acceptedParams` | Record |   | +| `transport` | [Transport](./Transport.md) |   | diff --git a/docs/reference/api/That_43.md b/docs/reference/api/That_43.md new file mode 100644 index 000000000..fb74b2cbd --- /dev/null +++ b/docs/reference/api/That_43.md @@ -0,0 +1,5 @@ +## Interface `That_43` + +| Name | Type | Description | +| - | - | - | +| `transport` | [Transport](./Transport.md) |   | diff --git a/docs/reference/api/That_44.md b/docs/reference/api/That_44.md new file mode 100644 index 000000000..5f0a7992b --- /dev/null +++ b/docs/reference/api/That_44.md @@ -0,0 +1,6 @@ +## Interface `That_44` + +| Name | Type | Description | +| - | - | - | +| `acceptedParams` | Record |   | +| `transport` | [Transport](./Transport.md) |   | diff --git a/docs/reference/api/That_45.md b/docs/reference/api/That_45.md new file mode 100644 index 000000000..61e0805bf --- /dev/null +++ b/docs/reference/api/That_45.md @@ -0,0 +1,6 @@ +## Interface `That_45` + +| Name | Type | Description | +| - | - | - | +| `acceptedParams` | Record |   | +| `transport` | [Transport](./Transport.md) |   | diff --git a/docs/reference/api/That_46.md b/docs/reference/api/That_46.md new file mode 100644 index 000000000..f4ead338b --- /dev/null +++ b/docs/reference/api/That_46.md @@ -0,0 +1,6 @@ +## Interface `That_46` + +| Name | Type | Description | +| - | - | - | +| `acceptedParams` | Record |   | +| `transport` | [Transport](./Transport.md) |   | diff --git a/docs/reference/api/That_47.md b/docs/reference/api/That_47.md new file mode 100644 index 000000000..c12963b77 --- /dev/null +++ b/docs/reference/api/That_47.md @@ -0,0 +1,5 @@ +## Interface `That_47` + +| Name | Type | Description | +| - | - | - | +| `transport` | [Transport](./Transport.md) |   | diff --git a/docs/reference/api/That_48.md b/docs/reference/api/That_48.md new file mode 100644 index 000000000..f1ee8c466 --- /dev/null +++ b/docs/reference/api/That_48.md @@ -0,0 +1,5 @@ +## Interface `That_48` + +| Name | Type | Description | +| - | - | - | +| `transport` | [Transport](./Transport.md) |   | diff --git a/docs/reference/api/That_49.md b/docs/reference/api/That_49.md new file mode 100644 index 000000000..b4c2023d7 --- /dev/null +++ b/docs/reference/api/That_49.md @@ -0,0 +1,5 @@ +## Interface `That_49` + +| Name | Type | Description | +| - | - | - | +| `transport` | [Transport](./Transport.md) |   | diff --git a/docs/reference/api/That_5.md b/docs/reference/api/That_5.md new file mode 100644 index 000000000..206ee0ff2 --- /dev/null +++ b/docs/reference/api/That_5.md @@ -0,0 +1,6 @@ +## Interface `That_5` + +| Name | Type | Description | +| - | - | - | +| `acceptedParams` | Record |   | +| `transport` | [Transport](./Transport.md) |   | diff --git a/docs/reference/api/That_50.md b/docs/reference/api/That_50.md new file mode 100644 index 000000000..0c566f5c3 --- /dev/null +++ b/docs/reference/api/That_50.md @@ -0,0 +1,6 @@ +## Interface `That_50` + +| Name | Type | Description | +| - | - | - | +| `acceptedParams` | Record |   | +| `transport` | [Transport](./Transport.md) |   | diff --git a/docs/reference/api/That_51.md b/docs/reference/api/That_51.md new file mode 100644 index 000000000..bf8893151 --- /dev/null +++ b/docs/reference/api/That_51.md @@ -0,0 +1,5 @@ +## Interface `That_51` + +| Name | Type | Description | +| - | - | - | +| `transport` | [Transport](./Transport.md) |   | diff --git a/docs/reference/api/That_52.md b/docs/reference/api/That_52.md new file mode 100644 index 000000000..64a5a5d8b --- /dev/null +++ b/docs/reference/api/That_52.md @@ -0,0 +1,5 @@ +## Interface `That_52` + +| Name | Type | Description | +| - | - | - | +| `transport` | [Transport](./Transport.md) |   | diff --git a/docs/reference/api/That_53.md b/docs/reference/api/That_53.md new file mode 100644 index 000000000..5132f009f --- /dev/null +++ b/docs/reference/api/That_53.md @@ -0,0 +1,6 @@ +## Interface `That_53` + +| Name | Type | Description | +| - | - | - | +| `acceptedParams` | Record |   | +| `transport` | [Transport](./Transport.md) |   | diff --git a/docs/reference/api/That_54.md b/docs/reference/api/That_54.md new file mode 100644 index 000000000..7d623eda4 --- /dev/null +++ b/docs/reference/api/That_54.md @@ -0,0 +1,5 @@ +## Interface `That_54` + +| Name | Type | Description | +| - | - | - | +| `transport` | [Transport](./Transport.md) |   | diff --git a/docs/reference/api/That_55.md b/docs/reference/api/That_55.md new file mode 100644 index 000000000..c8f795f6c --- /dev/null +++ b/docs/reference/api/That_55.md @@ -0,0 +1,6 @@ +## Interface `That_55` + +| Name | Type | Description | +| - | - | - | +| `acceptedParams` | Record |   | +| `transport` | [Transport](./Transport.md) |   | diff --git a/docs/reference/api/That_56.md b/docs/reference/api/That_56.md new file mode 100644 index 000000000..21858ba8e --- /dev/null +++ b/docs/reference/api/That_56.md @@ -0,0 +1,5 @@ +## Interface `That_56` + +| Name | Type | Description | +| - | - | - | +| `transport` | [Transport](./Transport.md) |   | diff --git a/docs/reference/api/That_57.md b/docs/reference/api/That_57.md new file mode 100644 index 000000000..bebed2888 --- /dev/null +++ b/docs/reference/api/That_57.md @@ -0,0 +1,5 @@ +## Interface `That_57` + +| Name | Type | Description | +| - | - | - | +| `transport` | [Transport](./Transport.md) |   | diff --git a/docs/reference/api/That_58.md b/docs/reference/api/That_58.md new file mode 100644 index 000000000..95a62bb9e --- /dev/null +++ b/docs/reference/api/That_58.md @@ -0,0 +1,5 @@ +## Interface `That_58` + +| Name | Type | Description | +| - | - | - | +| `transport` | [Transport](./Transport.md) |   | diff --git a/docs/reference/api/That_59.md b/docs/reference/api/That_59.md new file mode 100644 index 000000000..b4c095682 --- /dev/null +++ b/docs/reference/api/That_59.md @@ -0,0 +1,5 @@ +## Interface `That_59` + +| Name | Type | Description | +| - | - | - | +| `transport` | [Transport](./Transport.md) |   | diff --git a/docs/reference/api/That_6.md b/docs/reference/api/That_6.md new file mode 100644 index 000000000..c38ec9287 --- /dev/null +++ b/docs/reference/api/That_6.md @@ -0,0 +1,6 @@ +## Interface `That_6` + +| Name | Type | Description | +| - | - | - | +| `acceptedParams` | Record |   | +| `transport` | [Transport](./Transport.md) |   | diff --git a/docs/reference/api/That_60.md b/docs/reference/api/That_60.md new file mode 100644 index 000000000..ebca87543 --- /dev/null +++ b/docs/reference/api/That_60.md @@ -0,0 +1,6 @@ +## Interface `That_60` + +| Name | Type | Description | +| - | - | - | +| `acceptedParams` | Record |   | +| `transport` | [Transport](./Transport.md) |   | diff --git a/docs/reference/api/That_61.md b/docs/reference/api/That_61.md new file mode 100644 index 000000000..96fac04a1 --- /dev/null +++ b/docs/reference/api/That_61.md @@ -0,0 +1,5 @@ +## Interface `That_61` + +| Name | Type | Description | +| - | - | - | +| `transport` | [Transport](./Transport.md) |   | diff --git a/docs/reference/api/That_62.md b/docs/reference/api/That_62.md new file mode 100644 index 000000000..0fe2c04aa --- /dev/null +++ b/docs/reference/api/That_62.md @@ -0,0 +1,5 @@ +## Interface `That_62` + +| Name | Type | Description | +| - | - | - | +| `transport` | [Transport](./Transport.md) |   | diff --git a/docs/reference/api/That_63.md b/docs/reference/api/That_63.md new file mode 100644 index 000000000..313dfeea0 --- /dev/null +++ b/docs/reference/api/That_63.md @@ -0,0 +1,5 @@ +## Interface `That_63` + +| Name | Type | Description | +| - | - | - | +| `transport` | [Transport](./Transport.md) |   | diff --git a/docs/reference/api/That_64.md b/docs/reference/api/That_64.md new file mode 100644 index 000000000..5612a4f4e --- /dev/null +++ b/docs/reference/api/That_64.md @@ -0,0 +1,6 @@ +## Interface `That_64` + +| Name | Type | Description | +| - | - | - | +| `acceptedParams` | Record |   | +| `transport` | [Transport](./Transport.md) |   | diff --git a/docs/reference/api/That_65.md b/docs/reference/api/That_65.md new file mode 100644 index 000000000..fef02bcba --- /dev/null +++ b/docs/reference/api/That_65.md @@ -0,0 +1,5 @@ +## Interface `That_65` + +| Name | Type | Description | +| - | - | - | +| `transport` | [Transport](./Transport.md) |   | diff --git a/docs/reference/api/That_66.md b/docs/reference/api/That_66.md new file mode 100644 index 000000000..3dd775d45 --- /dev/null +++ b/docs/reference/api/That_66.md @@ -0,0 +1,5 @@ +## Interface `That_66` + +| Name | Type | Description | +| - | - | - | +| `transport` | [Transport](./Transport.md) |   | diff --git a/docs/reference/api/That_67.md b/docs/reference/api/That_67.md new file mode 100644 index 000000000..f789219e7 --- /dev/null +++ b/docs/reference/api/That_67.md @@ -0,0 +1,5 @@ +## Interface `That_67` + +| Name | Type | Description | +| - | - | - | +| `transport` | [Transport](./Transport.md) |   | diff --git a/docs/reference/api/That_68.md b/docs/reference/api/That_68.md new file mode 100644 index 000000000..1a07132a8 --- /dev/null +++ b/docs/reference/api/That_68.md @@ -0,0 +1,6 @@ +## Interface `That_68` + +| Name | Type | Description | +| - | - | - | +| `acceptedParams` | Record |   | +| `transport` | [Transport](./Transport.md) |   | diff --git a/docs/reference/api/That_69.md b/docs/reference/api/That_69.md new file mode 100644 index 000000000..0ea2a338e --- /dev/null +++ b/docs/reference/api/That_69.md @@ -0,0 +1,6 @@ +## Interface `That_69` + +| Name | Type | Description | +| - | - | - | +| `acceptedParams` | Record |   | +| `transport` | [Transport](./Transport.md) |   | diff --git a/docs/reference/api/That_7.md b/docs/reference/api/That_7.md new file mode 100644 index 000000000..5ecb09d34 --- /dev/null +++ b/docs/reference/api/That_7.md @@ -0,0 +1,5 @@ +## Interface `That_7` + +| Name | Type | Description | +| - | - | - | +| `transport` | [Transport](./Transport.md) |   | diff --git a/docs/reference/api/That_70.md b/docs/reference/api/That_70.md new file mode 100644 index 000000000..13433ad6e --- /dev/null +++ b/docs/reference/api/That_70.md @@ -0,0 +1,6 @@ +## Interface `That_70` + +| Name | Type | Description | +| - | - | - | +| `acceptedParams` | Record |   | +| `transport` | [Transport](./Transport.md) |   | diff --git a/docs/reference/api/That_71.md b/docs/reference/api/That_71.md new file mode 100644 index 000000000..0e3be3f6b --- /dev/null +++ b/docs/reference/api/That_71.md @@ -0,0 +1,6 @@ +## Interface `That_71` + +| Name | Type | Description | +| - | - | - | +| `acceptedParams` | Record |   | +| `transport` | [Transport](./Transport.md) |   | diff --git a/docs/reference/api/That_72.md b/docs/reference/api/That_72.md new file mode 100644 index 000000000..fd5bda427 --- /dev/null +++ b/docs/reference/api/That_72.md @@ -0,0 +1,6 @@ +## Interface `That_72` + +| Name | Type | Description | +| - | - | - | +| `acceptedParams` | Record |   | +| `transport` | [Transport](./Transport.md) |   | diff --git a/docs/reference/api/That_73.md b/docs/reference/api/That_73.md new file mode 100644 index 000000000..e48b5e987 --- /dev/null +++ b/docs/reference/api/That_73.md @@ -0,0 +1,6 @@ +## Interface `That_73` + +| Name | Type | Description | +| - | - | - | +| `acceptedParams` | Record |   | +| `transport` | [Transport](./Transport.md) |   | diff --git a/docs/reference/api/That_74.md b/docs/reference/api/That_74.md new file mode 100644 index 000000000..e817d8838 --- /dev/null +++ b/docs/reference/api/That_74.md @@ -0,0 +1,6 @@ +## Interface `That_74` + +| Name | Type | Description | +| - | - | - | +| `acceptedParams` | Record |   | +| `transport` | [Transport](./Transport.md) |   | diff --git a/docs/reference/api/That_75.md b/docs/reference/api/That_75.md new file mode 100644 index 000000000..d54085ca6 --- /dev/null +++ b/docs/reference/api/That_75.md @@ -0,0 +1,6 @@ +## Interface `That_75` + +| Name | Type | Description | +| - | - | - | +| `acceptedParams` | Record |   | +| `transport` | [Transport](./Transport.md) |   | diff --git a/docs/reference/api/That_76.md b/docs/reference/api/That_76.md new file mode 100644 index 000000000..0356c9875 --- /dev/null +++ b/docs/reference/api/That_76.md @@ -0,0 +1,6 @@ +## Interface `That_76` + +| Name | Type | Description | +| - | - | - | +| `acceptedParams` | Record |   | +| `transport` | [Transport](./Transport.md) |   | diff --git a/docs/reference/api/That_77.md b/docs/reference/api/That_77.md new file mode 100644 index 000000000..f79ec8ff7 --- /dev/null +++ b/docs/reference/api/That_77.md @@ -0,0 +1,6 @@ +## Interface `That_77` + +| Name | Type | Description | +| - | - | - | +| `acceptedParams` | Record |   | +| `transport` | [Transport](./Transport.md) |   | diff --git a/docs/reference/api/That_78.md b/docs/reference/api/That_78.md new file mode 100644 index 000000000..0ea4b0af6 --- /dev/null +++ b/docs/reference/api/That_78.md @@ -0,0 +1,5 @@ +## Interface `That_78` + +| Name | Type | Description | +| - | - | - | +| `transport` | [Transport](./Transport.md) |   | diff --git a/docs/reference/api/That_79.md b/docs/reference/api/That_79.md new file mode 100644 index 000000000..5acfb5f1d --- /dev/null +++ b/docs/reference/api/That_79.md @@ -0,0 +1,5 @@ +## Interface `That_79` + +| Name | Type | Description | +| - | - | - | +| `transport` | [Transport](./Transport.md) |   | diff --git a/docs/reference/api/That_8.md b/docs/reference/api/That_8.md new file mode 100644 index 000000000..58ad67cc6 --- /dev/null +++ b/docs/reference/api/That_8.md @@ -0,0 +1,5 @@ +## Interface `That_8` + +| Name | Type | Description | +| - | - | - | +| `transport` | [Transport](./Transport.md) |   | diff --git a/docs/reference/api/That_80.md b/docs/reference/api/That_80.md new file mode 100644 index 000000000..3b2c2f958 --- /dev/null +++ b/docs/reference/api/That_80.md @@ -0,0 +1,6 @@ +## Interface `That_80` + +| Name | Type | Description | +| - | - | - | +| `acceptedParams` | Record |   | +| `transport` | [Transport](./Transport.md) |   | diff --git a/docs/reference/api/That_81.md b/docs/reference/api/That_81.md new file mode 100644 index 000000000..3e0d0e3ee --- /dev/null +++ b/docs/reference/api/That_81.md @@ -0,0 +1,6 @@ +## Interface `That_81` + +| Name | Type | Description | +| - | - | - | +| `acceptedParams` | Record |   | +| `transport` | [Transport](./Transport.md) |   | diff --git a/docs/reference/api/That_82.md b/docs/reference/api/That_82.md new file mode 100644 index 000000000..d62b2a10a --- /dev/null +++ b/docs/reference/api/That_82.md @@ -0,0 +1,5 @@ +## Interface `That_82` + +| Name | Type | Description | +| - | - | - | +| `transport` | [Transport](./Transport.md) |   | diff --git a/docs/reference/api/That_83.md b/docs/reference/api/That_83.md new file mode 100644 index 000000000..20aebee5a --- /dev/null +++ b/docs/reference/api/That_83.md @@ -0,0 +1,5 @@ +## Interface `That_83` + +| Name | Type | Description | +| - | - | - | +| `transport` | [Transport](./Transport.md) |   | diff --git a/docs/reference/api/That_84.md b/docs/reference/api/That_84.md new file mode 100644 index 000000000..8c1f7558a --- /dev/null +++ b/docs/reference/api/That_84.md @@ -0,0 +1,5 @@ +## Interface `That_84` + +| Name | Type | Description | +| - | - | - | +| `transport` | [Transport](./Transport.md) |   | diff --git a/docs/reference/api/That_85.md b/docs/reference/api/That_85.md new file mode 100644 index 000000000..bdb90b6a5 --- /dev/null +++ b/docs/reference/api/That_85.md @@ -0,0 +1,6 @@ +## Interface `That_85` + +| Name | Type | Description | +| - | - | - | +| `acceptedParams` | Record |   | +| `transport` | [Transport](./Transport.md) |   | diff --git a/docs/reference/api/That_86.md b/docs/reference/api/That_86.md new file mode 100644 index 000000000..d5d5b4231 --- /dev/null +++ b/docs/reference/api/That_86.md @@ -0,0 +1,6 @@ +## Interface `That_86` + +| Name | Type | Description | +| - | - | - | +| `acceptedParams` | Record |   | +| `transport` | [Transport](./Transport.md) |   | diff --git a/docs/reference/api/That_9.md b/docs/reference/api/That_9.md new file mode 100644 index 000000000..606f71cc6 --- /dev/null +++ b/docs/reference/api/That_9.md @@ -0,0 +1,6 @@ +## Interface `That_9` + +| Name | Type | Description | +| - | - | - | +| `acceptedParams` | Record |   | +| `transport` | [Transport](./Transport.md) |   | diff --git a/docs/reference/api/ThreadType.md b/docs/reference/api/ThreadType.md new file mode 100644 index 000000000..f95e00363 --- /dev/null +++ b/docs/reference/api/ThreadType.md @@ -0,0 +1,4 @@ +## `ThreadType` +::: +type ThreadType = 'cpu' | 'wait' | 'block' | 'gpu' | 'mem'; +::: diff --git a/docs/reference/api/TimeOfDay.md b/docs/reference/api/TimeOfDay.md new file mode 100644 index 000000000..62c19119e --- /dev/null +++ b/docs/reference/api/TimeOfDay.md @@ -0,0 +1,4 @@ +## `TimeOfDay` +::: +type TimeOfDay = string; +::: diff --git a/docs/reference/api/TimeUnit.md b/docs/reference/api/TimeUnit.md new file mode 100644 index 000000000..7efa0afd3 --- /dev/null +++ b/docs/reference/api/TimeUnit.md @@ -0,0 +1,4 @@ +## `TimeUnit` +::: +type TimeUnit = 'nanos' | 'micros' | 'ms' | 's' | 'm' | 'h' | 'd'; +::: diff --git a/docs/reference/api/TimeZone.md b/docs/reference/api/TimeZone.md new file mode 100644 index 000000000..bbcb14373 --- /dev/null +++ b/docs/reference/api/TimeZone.md @@ -0,0 +1,4 @@ +## `TimeZone` +::: +type TimeZone = string; +::: diff --git a/docs/reference/api/TopLeftBottomRightGeoBounds.md b/docs/reference/api/TopLeftBottomRightGeoBounds.md new file mode 100644 index 000000000..f5518950b --- /dev/null +++ b/docs/reference/api/TopLeftBottomRightGeoBounds.md @@ -0,0 +1,6 @@ +## Interface `TopLeftBottomRightGeoBounds` + +| Name | Type | Description | +| - | - | - | +| `bottom_right` | [GeoLocation](./GeoLocation.md) |   | +| `top_left` | [GeoLocation](./GeoLocation.md) |   | diff --git a/docs/reference/api/TopRightBottomLeftGeoBounds.md b/docs/reference/api/TopRightBottomLeftGeoBounds.md new file mode 100644 index 000000000..aa04c1ebf --- /dev/null +++ b/docs/reference/api/TopRightBottomLeftGeoBounds.md @@ -0,0 +1,6 @@ +## Interface `TopRightBottomLeftGeoBounds` + +| Name | Type | Description | +| - | - | - | +| `bottom_left` | [GeoLocation](./GeoLocation.md) |   | +| `top_right` | [GeoLocation](./GeoLocation.md) |   | diff --git a/docs/reference/api/Transform.md b/docs/reference/api/Transform.md new file mode 100644 index 000000000..31e17916a --- /dev/null +++ b/docs/reference/api/Transform.md @@ -0,0 +1,20 @@ +## `Transform` + +### Constructor + +::: +new Transform(transport: [Transport](./Transport.md)); +::: + +### Properties + +| Name | Type | Description | +| - | - | - | +| `acceptedParams` | Record |   | +| `transport` | [Transport](./Transport.md) |   | + +### Methods + +| Name | Signature | Description | +| - | - | - | +| `deleteTransform` | `deleteTransform(this: [That](./That.md), params: [TransformDeleteTransformRequest](./TransformDeleteTransformRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TransformDeleteTransformResponse](./TransformDeleteTransformResponse.md)>;` | Delete a transform. || `deleteTransform` | `deleteTransform(this: [That](./That.md), params: [TransformDeleteTransformRequest](./TransformDeleteTransformRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TransformDeleteTransformResponse](./TransformDeleteTransformResponse.md), unknown>>;` |   || `deleteTransform` | `deleteTransform(this: [That](./That.md), params: [TransformDeleteTransformRequest](./TransformDeleteTransformRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TransformDeleteTransformResponse](./TransformDeleteTransformResponse.md)>;` |   || `getNodeStats` | `getNodeStats(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TODO](./TODO.md)>;` | Retrieves transform usage information for transform nodes. || `getNodeStats` | `getNodeStats(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TODO](./TODO.md), unknown>>;` |   || `getNodeStats` | `getNodeStats(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TODO](./TODO.md)>;` |   || `getTransform` | `getTransform(this: [That](./That.md), params?: [TransformGetTransformRequest](./TransformGetTransformRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TransformGetTransformResponse](./TransformGetTransformResponse.md)>;` | Get transforms. Get configuration information for transforms. || `getTransform` | `getTransform(this: [That](./That.md), params?: [TransformGetTransformRequest](./TransformGetTransformRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TransformGetTransformResponse](./TransformGetTransformResponse.md), unknown>>;` |   || `getTransform` | `getTransform(this: [That](./That.md), params?: [TransformGetTransformRequest](./TransformGetTransformRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TransformGetTransformResponse](./TransformGetTransformResponse.md)>;` |   || `getTransformStats` | `getTransformStats(this: [That](./That.md), params: [TransformGetTransformStatsRequest](./TransformGetTransformStatsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TransformGetTransformStatsResponse](./TransformGetTransformStatsResponse.md)>;` | Get transform stats. Get usage information for transforms. || `getTransformStats` | `getTransformStats(this: [That](./That.md), params: [TransformGetTransformStatsRequest](./TransformGetTransformStatsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TransformGetTransformStatsResponse](./TransformGetTransformStatsResponse.md), unknown>>;` |   || `getTransformStats` | `getTransformStats(this: [That](./That.md), params: [TransformGetTransformStatsRequest](./TransformGetTransformStatsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TransformGetTransformStatsResponse](./TransformGetTransformStatsResponse.md)>;` |   || `previewTransform` | `previewTransform(this: [That](./That.md), params?: [TransformPreviewTransformRequest](./TransformPreviewTransformRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TransformPreviewTransformResponse](./TransformPreviewTransformResponse.md)>;` | Preview a transform. Generates a preview of the results that you will get when you create a transform with the same configuration. It returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also generates a list of mappings and settings for the destination index. These values are determined based on the field types of the source index and the transform aggregations. || `previewTransform` | `previewTransform(this: [That](./That.md), params?: [TransformPreviewTransformRequest](./TransformPreviewTransformRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TransformPreviewTransformResponse](./TransformPreviewTransformResponse.md), unknown>>;` |   || `previewTransform` | `previewTransform(this: [That](./That.md), params?: [TransformPreviewTransformRequest](./TransformPreviewTransformRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TransformPreviewTransformResponse](./TransformPreviewTransformResponse.md)>;` |   || `putTransform` | `putTransform(this: [That](./That.md), params: [TransformPutTransformRequest](./TransformPutTransformRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TransformPutTransformResponse](./TransformPutTransformResponse.md)>;` | Create a transform. Creates a transform. A transform copies data from source indices, transforms it, and persists it into an entity-centric destination index. You can also think of the destination index as a two-dimensional tabular data structure (known as a data frame). The ID for each document in the data frame is generated from a hash of the entity, so there is a unique row per entity. You must choose either the latest or pivot method for your transform; you cannot use both in a single transform. If you choose to use the pivot method for your transform, the entities are defined by the set of `group_by` fields in the pivot object. If you choose to use the latest method, the entities are defined by the `unique_key` field values in the latest object. You must have `create_index`, `index`, and `read` privileges on the destination index and `read` and `view_index_metadata` privileges on the source indices. When Elasticsearch security features are enabled, the transform remembers which roles the user that created it had at the time of creation and uses those same roles. If those roles do not have the required privileges on the source and destination indices, the transform fails when it attempts unauthorized operations. NOTE: You must use Kibana or this API to create a transform. Do not add a transform directly into any `.transform-internal*` indices using the Elasticsearch index API. If Elasticsearch security features are enabled, do not give users any privileges on `.transform-internal*` indices. If you used transforms prior to 7.5, also do not give users any privileges on `.data-frame-internal*` indices. || `putTransform` | `putTransform(this: [That](./That.md), params: [TransformPutTransformRequest](./TransformPutTransformRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TransformPutTransformResponse](./TransformPutTransformResponse.md), unknown>>;` |   || `putTransform` | `putTransform(this: [That](./That.md), params: [TransformPutTransformRequest](./TransformPutTransformRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TransformPutTransformResponse](./TransformPutTransformResponse.md)>;` |   || `resetTransform` | `resetTransform(this: [That](./That.md), params: [TransformResetTransformRequest](./TransformResetTransformRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TransformResetTransformResponse](./TransformResetTransformResponse.md)>;` | Reset a transform. Before you can reset it, you must stop it; alternatively, use the `force` query parameter. If the destination index was created by the transform, it is deleted. || `resetTransform` | `resetTransform(this: [That](./That.md), params: [TransformResetTransformRequest](./TransformResetTransformRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TransformResetTransformResponse](./TransformResetTransformResponse.md), unknown>>;` |   || `resetTransform` | `resetTransform(this: [That](./That.md), params: [TransformResetTransformRequest](./TransformResetTransformRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TransformResetTransformResponse](./TransformResetTransformResponse.md)>;` |   || `scheduleNowTransform` | `scheduleNowTransform(this: [That](./That.md), params: [TransformScheduleNowTransformRequest](./TransformScheduleNowTransformRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TransformScheduleNowTransformResponse](./TransformScheduleNowTransformResponse.md)>;` | Schedule a transform to start now. Instantly run a transform to process data. If you run this API, the transform will process the new data instantly, without waiting for the configured frequency interval. After the API is called, the transform will be processed again at `now + frequency` unless the API is called again in the meantime. || `scheduleNowTransform` | `scheduleNowTransform(this: [That](./That.md), params: [TransformScheduleNowTransformRequest](./TransformScheduleNowTransformRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TransformScheduleNowTransformResponse](./TransformScheduleNowTransformResponse.md), unknown>>;` |   || `scheduleNowTransform` | `scheduleNowTransform(this: [That](./That.md), params: [TransformScheduleNowTransformRequest](./TransformScheduleNowTransformRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TransformScheduleNowTransformResponse](./TransformScheduleNowTransformResponse.md)>;` |   || `startTransform` | `startTransform(this: [That](./That.md), params: [TransformStartTransformRequest](./TransformStartTransformRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TransformStartTransformResponse](./TransformStartTransformResponse.md)>;` | Start a transform. When you start a transform, it creates the destination index if it does not already exist. The `number_of_shards` is set to `1` and the `auto_expand_replicas` is set to `0-1`. If it is a pivot transform, it deduces the mapping definitions for the destination index from the source indices and the transform aggregations. If fields in the destination index are derived from scripts (as in the case of `scripted_metric` or `bucket_script` aggregations), the transform uses dynamic mappings unless an index template exists. If it is a latest transform, it does not deduce mapping definitions; it uses dynamic mappings. To use explicit mappings, create the destination index before you start the transform. Alternatively, you can create an index template, though it does not affect the deduced mappings in a pivot transform. When the transform starts, a series of validations occur to ensure its success. If you deferred validation when you created the transform, they occur when you start the transform—with the exception of privilege checks. When Elasticsearch security features are enabled, the transform remembers which roles the user that created it had at the time of creation and uses those same roles. If those roles do not have the required privileges on the source and destination indices, the transform fails when it attempts unauthorized operations. || `startTransform` | `startTransform(this: [That](./That.md), params: [TransformStartTransformRequest](./TransformStartTransformRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TransformStartTransformResponse](./TransformStartTransformResponse.md), unknown>>;` |   || `startTransform` | `startTransform(this: [That](./That.md), params: [TransformStartTransformRequest](./TransformStartTransformRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TransformStartTransformResponse](./TransformStartTransformResponse.md)>;` |   || `stopTransform` | `stopTransform(this: [That](./That.md), params: [TransformStopTransformRequest](./TransformStopTransformRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TransformStopTransformResponse](./TransformStopTransformResponse.md)>;` | Stop transforms. Stops one or more transforms. || `stopTransform` | `stopTransform(this: [That](./That.md), params: [TransformStopTransformRequest](./TransformStopTransformRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TransformStopTransformResponse](./TransformStopTransformResponse.md), unknown>>;` |   || `stopTransform` | `stopTransform(this: [That](./That.md), params: [TransformStopTransformRequest](./TransformStopTransformRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TransformStopTransformResponse](./TransformStopTransformResponse.md)>;` |   || `updateTransform` | `updateTransform(this: [That](./That.md), params: [TransformUpdateTransformRequest](./TransformUpdateTransformRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TransformUpdateTransformResponse](./TransformUpdateTransformResponse.md)>;` | Update a transform. Updates certain properties of a transform. All updated properties except `description` do not take effect until after the transform starts the next checkpoint, thus there is data consistency in each checkpoint. To use this API, you must have `read` and `view_index_metadata` privileges for the source indices. You must also have `index` and `read` privileges for the destination index. When Elasticsearch security features are enabled, the transform remembers which roles the user who updated it had at the time of update and runs with those privileges. || `updateTransform` | `updateTransform(this: [That](./That.md), params: [TransformUpdateTransformRequest](./TransformUpdateTransformRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TransformUpdateTransformResponse](./TransformUpdateTransformResponse.md), unknown>>;` |   || `updateTransform` | `updateTransform(this: [That](./That.md), params: [TransformUpdateTransformRequest](./TransformUpdateTransformRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TransformUpdateTransformResponse](./TransformUpdateTransformResponse.md)>;` |   || `upgradeTransforms` | `upgradeTransforms(this: [That](./That.md), params?: [TransformUpgradeTransformsRequest](./TransformUpgradeTransformsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TransformUpgradeTransformsResponse](./TransformUpgradeTransformsResponse.md)>;` | Upgrade all transforms. Transforms are compatible across minor versions and between supported major versions. However, over time, the format of transform configuration information may change. This API identifies transforms that have a legacy configuration format and upgrades them to the latest version. It also cleans up the internal data structures that store the transform state and checkpoints. The upgrade does not affect the source and destination indices. The upgrade also does not affect the roles that transforms use when Elasticsearch security features are enabled; the role used to read source data and write to the destination index remains unchanged. If a transform upgrade step fails, the upgrade stops and an error is returned about the underlying issue. Resolve the issue then re-run the process again. A summary is returned when the upgrade is finished. To ensure continuous transforms remain running during a major version upgrade of the cluster – for example, from 7.16 to 8.0 – it is recommended to upgrade transforms before upgrading the cluster. You may want to perform a recent cluster backup prior to the upgrade. || `upgradeTransforms` | `upgradeTransforms(this: [That](./That.md), params?: [TransformUpgradeTransformsRequest](./TransformUpgradeTransformsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TransformUpgradeTransformsResponse](./TransformUpgradeTransformsResponse.md), unknown>>;` |   || `upgradeTransforms` | `upgradeTransforms(this: [That](./That.md), params?: [TransformUpgradeTransformsRequest](./TransformUpgradeTransformsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TransformUpgradeTransformsResponse](./TransformUpgradeTransformsResponse.md)>;` |   | \ No newline at end of file diff --git a/docs/reference/api/TransformContainer.md b/docs/reference/api/TransformContainer.md new file mode 100644 index 000000000..f8970fcaf --- /dev/null +++ b/docs/reference/api/TransformContainer.md @@ -0,0 +1,7 @@ +## Interface `TransformContainer` + +| Name | Type | Description | +| - | - | - | +| `chain` | [TransformContainer](./TransformContainer.md)[] |   | +| `script` | [ScriptTransform](./ScriptTransform.md) |   | +| `search` | [SearchTransform](./SearchTransform.md) |   | diff --git a/docs/reference/api/TransformDeleteTransformRequest.md b/docs/reference/api/TransformDeleteTransformRequest.md new file mode 100644 index 000000000..4120cbd79 --- /dev/null +++ b/docs/reference/api/TransformDeleteTransformRequest.md @@ -0,0 +1,10 @@ +## Interface `TransformDeleteTransformRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { transform_id?: never; force?: never; delete_dest_index?: never; timeout?: never; }) | All values in `body` will be added to the request body. | +| `delete_dest_index` | boolean | If this value is true, the destination index is deleted together with the transform. If false, the destination index will not be deleted | +| `force` | boolean | If this value is false, the transform must be stopped before it can be deleted. If true, the transform is deleted regardless of its current state. | +| `querystring` | { [key: string]: any; } & { transform_id?: never; force?: never; delete_dest_index?: never; timeout?: never; } | All values in `querystring` will be added to the request querystring. | +| `timeout` | [Duration](./Duration.md) | Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. | +| `transform_id` | [Id](./Id.md) | Identifier for the transform. | diff --git a/docs/reference/api/TransformDeleteTransformResponse.md b/docs/reference/api/TransformDeleteTransformResponse.md new file mode 100644 index 000000000..a5ade904a --- /dev/null +++ b/docs/reference/api/TransformDeleteTransformResponse.md @@ -0,0 +1,4 @@ +## `TransformDeleteTransformResponse` +::: +type TransformDeleteTransformResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); +::: diff --git a/docs/reference/api/TransformDestination.md b/docs/reference/api/TransformDestination.md new file mode 100644 index 000000000..6532bf50d --- /dev/null +++ b/docs/reference/api/TransformDestination.md @@ -0,0 +1,6 @@ +## Interface `TransformDestination` + +| Name | Type | Description | +| - | - | - | +| `index` | [IndexName](./IndexName.md) | The destination index for the transform. The mappings of the destination index are deduced based on the source fields when possible. If alternate mappings are required, use the create index API prior to starting the transform. | +| `pipeline` | string | The unique identifier for an ingest pipeline. | diff --git a/docs/reference/api/TransformGetTransformRequest.md b/docs/reference/api/TransformGetTransformRequest.md new file mode 100644 index 000000000..2425da1c8 --- /dev/null +++ b/docs/reference/api/TransformGetTransformRequest.md @@ -0,0 +1,11 @@ +## Interface `TransformGetTransformRequest` + +| Name | Type | Description | +| - | - | - | +| `allow_no_match` | boolean | Specifies what to do when the request: 1. Contains wildcard expressions and there are no transforms that match. 2. Contains the _all string or no identifiers and there are no matches. 3. Contains wildcard expressions and there are only partial matches. If this parameter is false, the request returns a 404 status code when there are no matches or only partial matches. | +| `body` | string | ({ [key: string]: any; } & { transform_id?: never; allow_no_match?: never; from?: never; size?: never; exclude_generated?: never; }) | All values in `body` will be added to the request body. | +| `exclude_generated` | boolean | Excludes fields that were automatically added when creating the transform. This allows the configuration to be in an acceptable format to be retrieved and then added to another cluster. | +| `from` | [integer](./integer.md) | Skips the specified number of transforms. | +| `querystring` | { [key: string]: any; } & { transform_id?: never; allow_no_match?: never; from?: never; size?: never; exclude_generated?: never; } | All values in `querystring` will be added to the request querystring. | +| `size` | [integer](./integer.md) | Specifies the maximum number of transforms to obtain. | +| `transform_id` | [Names](./Names.md) | Identifier for the transform. It can be a transform identifier or a wildcard expression. You can get information for all transforms by using `_all`, by specifying `*` as the ``, or by omitting the ``. | diff --git a/docs/reference/api/TransformGetTransformResponse.md b/docs/reference/api/TransformGetTransformResponse.md new file mode 100644 index 000000000..37cb73852 --- /dev/null +++ b/docs/reference/api/TransformGetTransformResponse.md @@ -0,0 +1,6 @@ +## Interface `TransformGetTransformResponse` + +| Name | Type | Description | +| - | - | - | +| `count` | [long](./long.md) |   | +| `transforms` | [TransformGetTransformTransformSummary](./TransformGetTransformTransformSummary.md)[] |   | diff --git a/docs/reference/api/TransformGetTransformStatsCheckpointStats.md b/docs/reference/api/TransformGetTransformStatsCheckpointStats.md new file mode 100644 index 000000000..3c1ba38b6 --- /dev/null +++ b/docs/reference/api/TransformGetTransformStatsCheckpointStats.md @@ -0,0 +1,10 @@ +## Interface `TransformGetTransformStatsCheckpointStats` + +| Name | Type | Description | +| - | - | - | +| `checkpoint_progress` | [TransformGetTransformStatsTransformProgress](./TransformGetTransformStatsTransformProgress.md) |   | +| `checkpoint` | [long](./long.md) |   | +| `time_upper_bound_millis` | [EpochTime](./EpochTime.md)<[UnitMillis](./UnitMillis.md)> |   | +| `time_upper_bound` | [DateTime](./DateTime.md) |   | +| `timestamp_millis` | [EpochTime](./EpochTime.md)<[UnitMillis](./UnitMillis.md)> |   | +| `timestamp` | [DateTime](./DateTime.md) |   | diff --git a/docs/reference/api/TransformGetTransformStatsCheckpointing.md b/docs/reference/api/TransformGetTransformStatsCheckpointing.md new file mode 100644 index 000000000..4edacd5ca --- /dev/null +++ b/docs/reference/api/TransformGetTransformStatsCheckpointing.md @@ -0,0 +1,11 @@ +## Interface `TransformGetTransformStatsCheckpointing` + +| Name | Type | Description | +| - | - | - | +| `changes_last_detected_at_string` | [DateTime](./DateTime.md) |   | +| `changes_last_detected_at` | [long](./long.md) |   | +| `last_search_time_string` | [DateTime](./DateTime.md) |   | +| `last_search_time` | [long](./long.md) |   | +| `last` | [TransformGetTransformStatsCheckpointStats](./TransformGetTransformStatsCheckpointStats.md) |   | +| `next` | [TransformGetTransformStatsCheckpointStats](./TransformGetTransformStatsCheckpointStats.md) |   | +| `operations_behind` | [long](./long.md) |   | diff --git a/docs/reference/api/TransformGetTransformStatsRequest.md b/docs/reference/api/TransformGetTransformStatsRequest.md new file mode 100644 index 000000000..88f0d5734 --- /dev/null +++ b/docs/reference/api/TransformGetTransformStatsRequest.md @@ -0,0 +1,11 @@ +## Interface `TransformGetTransformStatsRequest` + +| Name | Type | Description | +| - | - | - | +| `allow_no_match` | boolean | Specifies what to do when the request: 1. Contains wildcard expressions and there are no transforms that match. 2. Contains the _all string or no identifiers and there are no matches. 3. Contains wildcard expressions and there are only partial matches. If this parameter is false, the request returns a 404 status code when there are no matches or only partial matches. | +| `body` | string | ({ [key: string]: any; } & { transform_id?: never; allow_no_match?: never; from?: never; size?: never; timeout?: never; }) | All values in `body` will be added to the request body. | +| `from` | [long](./long.md) | Skips the specified number of transforms. | +| `querystring` | { [key: string]: any; } & { transform_id?: never; allow_no_match?: never; from?: never; size?: never; timeout?: never; } | All values in `querystring` will be added to the request querystring. | +| `size` | [long](./long.md) | Specifies the maximum number of transforms to obtain. | +| `timeout` | [Duration](./Duration.md) | Controls the time to wait for the stats | +| `transform_id` | [Names](./Names.md) | Identifier for the transform. It can be a transform identifier or a wildcard expression. You can get information for all transforms by using `_all`, by specifying `*` as the ``, or by omitting the ``. | diff --git a/docs/reference/api/TransformGetTransformStatsResponse.md b/docs/reference/api/TransformGetTransformStatsResponse.md new file mode 100644 index 000000000..f7e318ad7 --- /dev/null +++ b/docs/reference/api/TransformGetTransformStatsResponse.md @@ -0,0 +1,6 @@ +## Interface `TransformGetTransformStatsResponse` + +| Name | Type | Description | +| - | - | - | +| `count` | [long](./long.md) |   | +| `transforms` | [TransformGetTransformStatsTransformStats](./TransformGetTransformStatsTransformStats.md)[] |   | diff --git a/docs/reference/api/TransformGetTransformStatsTransformHealthIssue.md b/docs/reference/api/TransformGetTransformStatsTransformHealthIssue.md new file mode 100644 index 000000000..6aa20b441 --- /dev/null +++ b/docs/reference/api/TransformGetTransformStatsTransformHealthIssue.md @@ -0,0 +1,10 @@ +## Interface `TransformGetTransformStatsTransformHealthIssue` + +| Name | Type | Description | +| - | - | - | +| `count` | [integer](./integer.md) | Number of times this issue has occurred since it started | +| `details` | string | Details about the issue | +| `first_occurence_string` | [DateTime](./DateTime.md) |   | +| `first_occurrence` | [EpochTime](./EpochTime.md)<[UnitMillis](./UnitMillis.md)> | The timestamp this issue occurred for for the first time | +| `issue` | string | A description of the issue | +| `type` | string | The type of the issue | diff --git a/docs/reference/api/TransformGetTransformStatsTransformIndexerStats.md b/docs/reference/api/TransformGetTransformStatsTransformIndexerStats.md new file mode 100644 index 000000000..5dbe037ce --- /dev/null +++ b/docs/reference/api/TransformGetTransformStatsTransformIndexerStats.md @@ -0,0 +1,21 @@ +## Interface `TransformGetTransformStatsTransformIndexerStats` + +| Name | Type | Description | +| - | - | - | +| `delete_time_in_ms` | [EpochTime](./EpochTime.md)<[UnitMillis](./UnitMillis.md)> |   | +| `documents_deleted` | [long](./long.md) |   | +| `documents_indexed` | [long](./long.md) |   | +| `documents_processed` | [long](./long.md) |   | +| `exponential_avg_checkpoint_duration_ms` | [DurationValue](./DurationValue.md)<[UnitFloatMillis](./UnitFloatMillis.md)> |   | +| `exponential_avg_documents_indexed` | [double](./double.md) |   | +| `exponential_avg_documents_processed` | [double](./double.md) |   | +| `index_failures` | [long](./long.md) |   | +| `index_time_in_ms` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> |   | +| `index_total` | [long](./long.md) |   | +| `pages_processed` | [long](./long.md) |   | +| `processing_time_in_ms` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> |   | +| `processing_total` | [long](./long.md) |   | +| `search_failures` | [long](./long.md) |   | +| `search_time_in_ms` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> |   | +| `search_total` | [long](./long.md) |   | +| `trigger_count` | [long](./long.md) |   | diff --git a/docs/reference/api/TransformGetTransformStatsTransformProgress.md b/docs/reference/api/TransformGetTransformStatsTransformProgress.md new file mode 100644 index 000000000..a2dbb635a --- /dev/null +++ b/docs/reference/api/TransformGetTransformStatsTransformProgress.md @@ -0,0 +1,9 @@ +## Interface `TransformGetTransformStatsTransformProgress` + +| Name | Type | Description | +| - | - | - | +| `docs_indexed` | [long](./long.md) |   | +| `docs_processed` | [long](./long.md) |   | +| `docs_remaining` | [long](./long.md) |   | +| `percent_complete` | [double](./double.md) |   | +| `total_docs` | [long](./long.md) |   | diff --git a/docs/reference/api/TransformGetTransformStatsTransformStats.md b/docs/reference/api/TransformGetTransformStatsTransformStats.md new file mode 100644 index 000000000..6ce74560d --- /dev/null +++ b/docs/reference/api/TransformGetTransformStatsTransformStats.md @@ -0,0 +1,11 @@ +## Interface `TransformGetTransformStatsTransformStats` + +| Name | Type | Description | +| - | - | - | +| `checkpointing` | [TransformGetTransformStatsCheckpointing](./TransformGetTransformStatsCheckpointing.md) |   | +| `health` | [TransformGetTransformStatsTransformStatsHealth](./TransformGetTransformStatsTransformStatsHealth.md) |   | +| `id` | [Id](./Id.md) |   | +| `node` | [NodeAttributes](./NodeAttributes.md) |   | +| `reason` | string |   | +| `state` | string |   | +| `stats` | [TransformGetTransformStatsTransformIndexerStats](./TransformGetTransformStatsTransformIndexerStats.md) |   | diff --git a/docs/reference/api/TransformGetTransformStatsTransformStatsHealth.md b/docs/reference/api/TransformGetTransformStatsTransformStatsHealth.md new file mode 100644 index 000000000..c2611ac7b --- /dev/null +++ b/docs/reference/api/TransformGetTransformStatsTransformStatsHealth.md @@ -0,0 +1,6 @@ +## Interface `TransformGetTransformStatsTransformStatsHealth` + +| Name | Type | Description | +| - | - | - | +| `issues` | [TransformGetTransformStatsTransformHealthIssue](./TransformGetTransformStatsTransformHealthIssue.md)[] | If a non-healthy status is returned, contains a list of issues of the transform. | +| `status` | [HealthStatus](./HealthStatus.md) |   | diff --git a/docs/reference/api/TransformGetTransformTransformSummary.md b/docs/reference/api/TransformGetTransformTransformSummary.md new file mode 100644 index 000000000..c332aedb3 --- /dev/null +++ b/docs/reference/api/TransformGetTransformTransformSummary.md @@ -0,0 +1,19 @@ +## Interface `TransformGetTransformTransformSummary` + +| Name | Type | Description | +| - | - | - | +| `_meta` | [Metadata](./Metadata.md) |   | +| `authorization` | [MlTransformAuthorization](./MlTransformAuthorization.md) | The security privileges that the transform uses to run its queries. If Elastic Stack security features were disabled at the time of the most recent update to the transform, this property is omitted. | +| `create_time_string` | [DateTime](./DateTime.md) |   | +| `create_time` | [EpochTime](./EpochTime.md)<[UnitMillis](./UnitMillis.md)> | The time the transform was created. | +| `description` | string | Free text description of the transform. | +| `dest` | [ReindexDestination](./ReindexDestination.md) | The destination for the transform. | +| `frequency` | [Duration](./Duration.md) |   | +| `id` | [Id](./Id.md) |   | +| `latest` | [TransformLatest](./TransformLatest.md) |   | +| `pivot` | [TransformPivot](./TransformPivot.md) | The pivot method transforms the data by aggregating and grouping it. | +| `retention_policy` | [TransformRetentionPolicyContainer](./TransformRetentionPolicyContainer.md) |   | +| `settings` | [TransformSettings](./TransformSettings.md) | Defines optional transform settings. | +| `source` | [TransformSource](./TransformSource.md) | The source of the data for the transform. | +| `sync` | [TransformSyncContainer](./TransformSyncContainer.md) | Defines the properties transforms require to run continuously. | +| `version` | [VersionString](./VersionString.md) | The version of Elasticsearch that existed on the node when the transform was created. | diff --git a/docs/reference/api/TransformLatest.md b/docs/reference/api/TransformLatest.md new file mode 100644 index 000000000..5ec8b3161 --- /dev/null +++ b/docs/reference/api/TransformLatest.md @@ -0,0 +1,6 @@ +## Interface `TransformLatest` + +| Name | Type | Description | +| - | - | - | +| `sort` | [Field](./Field.md) | Specifies the date field that is used to identify the latest documents. | +| `unique_key` | [Field](./Field.md)[] | Specifies an array of one or more fields that are used to group the data. | diff --git a/docs/reference/api/TransformPivot.md b/docs/reference/api/TransformPivot.md new file mode 100644 index 000000000..33dab0556 --- /dev/null +++ b/docs/reference/api/TransformPivot.md @@ -0,0 +1,7 @@ +## Interface `TransformPivot` + +| Name | Type | Description | +| - | - | - | +| `aggregations` | Record | Defines how to aggregate the grouped data. The following aggregations are currently supported: average, bucket script, bucket selector, cardinality, filter, geo bounds, geo centroid, geo line, max, median absolute deviation, min, missing, percentiles, rare terms, scripted metric, stats, sum, terms, top metrics, value count, weighted average. | +| `aggs` | Record | Defines how to aggregate the grouped data. The following aggregations are currently supported: average, bucket script, bucket selector, cardinality, filter, geo bounds, geo centroid, geo line, max, median absolute deviation, min, missing, percentiles, rare terms, scripted metric, stats, sum, terms, top metrics, value count, weighted average. aggregations | +| `group_by` | Record | Defines how to group the data. More than one grouping can be defined per pivot. The following groupings are currently supported: date histogram, geotile grid, histogram, terms. | diff --git a/docs/reference/api/TransformPivotGroupByContainer.md b/docs/reference/api/TransformPivotGroupByContainer.md new file mode 100644 index 000000000..c024ef7f9 --- /dev/null +++ b/docs/reference/api/TransformPivotGroupByContainer.md @@ -0,0 +1,8 @@ +## Interface `TransformPivotGroupByContainer` + +| Name | Type | Description | +| - | - | - | +| `date_histogram` | [AggregationsDateHistogramAggregation](./AggregationsDateHistogramAggregation.md) |   | +| `geotile_grid` | [AggregationsGeoTileGridAggregation](./AggregationsGeoTileGridAggregation.md) |   | +| `histogram` | [AggregationsHistogramAggregation](./AggregationsHistogramAggregation.md) |   | +| `terms` | [AggregationsTermsAggregation](./AggregationsTermsAggregation.md) |   | diff --git a/docs/reference/api/TransformPreviewTransformRequest.md b/docs/reference/api/TransformPreviewTransformRequest.md new file mode 100644 index 000000000..f58b631ab --- /dev/null +++ b/docs/reference/api/TransformPreviewTransformRequest.md @@ -0,0 +1,17 @@ +## Interface `TransformPreviewTransformRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { transform_id?: never; timeout?: never; dest?: never; description?: never; frequency?: never; pivot?: never; source?: never; settings?: never; sync?: never; retention_policy?: never; latest?: never; }) | All values in `body` will be added to the request body. | +| `description` | string | Free text description of the transform. | +| `dest` | [TransformDestination](./TransformDestination.md) | The destination for the transform. | +| `frequency` | [Duration](./Duration.md) | The interval between checks for changes in the source indices when the transform is running continuously. Also determines the retry interval in the event of transient failures while the transform is searching or indexing. The minimum value is 1s and the maximum is 1h. | +| `latest` | [TransformLatest](./TransformLatest.md) | The latest method transforms the data by finding the latest document for each unique key. | +| `pivot` | [TransformPivot](./TransformPivot.md) | The pivot method transforms the data by aggregating and grouping it. These objects define the group by fields and the aggregation to reduce the data. | +| `querystring` | { [key: string]: any; } & { transform_id?: never; timeout?: never; dest?: never; description?: never; frequency?: never; pivot?: never; source?: never; settings?: never; sync?: never; retention_policy?: never; latest?: never; } | All values in `querystring` will be added to the request querystring. | +| `retention_policy` | [TransformRetentionPolicyContainer](./TransformRetentionPolicyContainer.md) | Defines a retention policy for the transform. Data that meets the defined criteria is deleted from the destination index. | +| `settings` | [TransformSettings](./TransformSettings.md) | Defines optional transform settings. | +| `source` | [TransformSource](./TransformSource.md) | The source of the data for the transform. | +| `sync` | [TransformSyncContainer](./TransformSyncContainer.md) | Defines the properties transforms require to run continuously. | +| `timeout` | [Duration](./Duration.md) | Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. | +| `transform_id` | [Id](./Id.md) | Identifier for the transform to preview. If you specify this path parameter, you cannot provide transform configuration details in the request body. | diff --git a/docs/reference/api/TransformPreviewTransformResponse.md b/docs/reference/api/TransformPreviewTransformResponse.md new file mode 100644 index 000000000..1cb248717 --- /dev/null +++ b/docs/reference/api/TransformPreviewTransformResponse.md @@ -0,0 +1,6 @@ +## Interface `TransformPreviewTransformResponse` + +| Name | Type | Description | +| - | - | - | +| `generated_dest_index` | [IndicesIndexState](./IndicesIndexState.md) |   | +| `preview` | TTransform[] |   | diff --git a/docs/reference/api/TransformPutTransformRequest.md b/docs/reference/api/TransformPutTransformRequest.md new file mode 100644 index 000000000..84900d08a --- /dev/null +++ b/docs/reference/api/TransformPutTransformRequest.md @@ -0,0 +1,19 @@ +## Interface `TransformPutTransformRequest` + +| Name | Type | Description | +| - | - | - | +| `_meta` | [Metadata](./Metadata.md) | Defines optional transform metadata. | +| `body` | string | ({ [key: string]: any; } & { transform_id?: never; defer_validation?: never; timeout?: never; dest?: never; description?: never; frequency?: never; latest?: never; _meta?: never; pivot?: never; retention_policy?: never; settings?: never; source?: never; sync?: never; }) | All values in `body` will be added to the request body. | +| `defer_validation` | boolean | When the transform is created, a series of validations occur to ensure its success. For example, there is a check for the existence of the source indices and a check that the destination index is not part of the source index pattern. You can use this parameter to skip the checks, for example when the source index does not exist until after the transform is created. The validations are always run when you start the transform, however, with the exception of privilege checks. | +| `description` | string | Free text description of the transform. | +| `dest` | [TransformDestination](./TransformDestination.md) | The destination for the transform. | +| `frequency` | [Duration](./Duration.md) | The interval between checks for changes in the source indices when the transform is running continuously. Also determines the retry interval in the event of transient failures while the transform is searching or indexing. The minimum value is `1s` and the maximum is `1h`. | +| `latest` | [TransformLatest](./TransformLatest.md) | The latest method transforms the data by finding the latest document for each unique key. | +| `pivot` | [TransformPivot](./TransformPivot.md) | The pivot method transforms the data by aggregating and grouping it. These objects define the group by fields and the aggregation to reduce the data. | +| `querystring` | { [key: string]: any; } & { transform_id?: never; defer_validation?: never; timeout?: never; dest?: never; description?: never; frequency?: never; latest?: never; _meta?: never; pivot?: never; retention_policy?: never; settings?: never; source?: never; sync?: never; } | All values in `querystring` will be added to the request querystring. | +| `retention_policy` | [TransformRetentionPolicyContainer](./TransformRetentionPolicyContainer.md) | Defines a retention policy for the transform. Data that meets the defined criteria is deleted from the destination index. | +| `settings` | [TransformSettings](./TransformSettings.md) | Defines optional transform settings. | +| `source` | [TransformSource](./TransformSource.md) | The source of the data for the transform. | +| `sync` | [TransformSyncContainer](./TransformSyncContainer.md) | Defines the properties transforms require to run continuously. | +| `timeout` | [Duration](./Duration.md) | Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. | +| `transform_id` | [Id](./Id.md) | Identifier for the transform. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It has a 64 character limit and must start and end with alphanumeric characters. | diff --git a/docs/reference/api/TransformPutTransformResponse.md b/docs/reference/api/TransformPutTransformResponse.md new file mode 100644 index 000000000..ec5ebfa9b --- /dev/null +++ b/docs/reference/api/TransformPutTransformResponse.md @@ -0,0 +1,4 @@ +## `TransformPutTransformResponse` +::: +type TransformPutTransformResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); +::: diff --git a/docs/reference/api/TransformResetTransformRequest.md b/docs/reference/api/TransformResetTransformRequest.md new file mode 100644 index 000000000..3d7e39dd2 --- /dev/null +++ b/docs/reference/api/TransformResetTransformRequest.md @@ -0,0 +1,9 @@ +## Interface `TransformResetTransformRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { transform_id?: never; force?: never; timeout?: never; }) | All values in `body` will be added to the request body. | +| `force` | boolean | If this value is `true`, the transform is reset regardless of its current state. If it's `false`, the transform must be stopped before it can be reset. | +| `querystring` | { [key: string]: any; } & { transform_id?: never; force?: never; timeout?: never; } | All values in `querystring` will be added to the request querystring. | +| `timeout` | [Duration](./Duration.md) | Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. | +| `transform_id` | [Id](./Id.md) | Identifier for the transform. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It has a 64 character limit and must start and end with alphanumeric characters. | diff --git a/docs/reference/api/TransformResetTransformResponse.md b/docs/reference/api/TransformResetTransformResponse.md new file mode 100644 index 000000000..6a5ad3999 --- /dev/null +++ b/docs/reference/api/TransformResetTransformResponse.md @@ -0,0 +1,4 @@ +## `TransformResetTransformResponse` +::: +type TransformResetTransformResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); +::: diff --git a/docs/reference/api/TransformRetentionPolicy.md b/docs/reference/api/TransformRetentionPolicy.md new file mode 100644 index 000000000..f139af179 --- /dev/null +++ b/docs/reference/api/TransformRetentionPolicy.md @@ -0,0 +1,6 @@ +## Interface `TransformRetentionPolicy` + +| Name | Type | Description | +| - | - | - | +| `field` | [Field](./Field.md) | The date field that is used to calculate the age of the document. | +| `max_age` | [Duration](./Duration.md) | Specifies the maximum age of a document in the destination index. Documents that are older than the configured value are removed from the destination index. | diff --git a/docs/reference/api/TransformRetentionPolicyContainer.md b/docs/reference/api/TransformRetentionPolicyContainer.md new file mode 100644 index 000000000..38862720a --- /dev/null +++ b/docs/reference/api/TransformRetentionPolicyContainer.md @@ -0,0 +1,5 @@ +## Interface `TransformRetentionPolicyContainer` + +| Name | Type | Description | +| - | - | - | +| `time` | [TransformRetentionPolicy](./TransformRetentionPolicy.md) | Specifies that the transform uses a time field to set the retention policy. | diff --git a/docs/reference/api/TransformScheduleNowTransformRequest.md b/docs/reference/api/TransformScheduleNowTransformRequest.md new file mode 100644 index 000000000..d487f1ea2 --- /dev/null +++ b/docs/reference/api/TransformScheduleNowTransformRequest.md @@ -0,0 +1,8 @@ +## Interface `TransformScheduleNowTransformRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { transform_id?: never; timeout?: never; }) | All values in `body` will be added to the request body. | +| `querystring` | { [key: string]: any; } & { transform_id?: never; timeout?: never; } | All values in `querystring` will be added to the request querystring. | +| `timeout` | [Duration](./Duration.md) | Controls the time to wait for the scheduling to take place | +| `transform_id` | [Id](./Id.md) | Identifier for the transform. | diff --git a/docs/reference/api/TransformScheduleNowTransformResponse.md b/docs/reference/api/TransformScheduleNowTransformResponse.md new file mode 100644 index 000000000..5b725397b --- /dev/null +++ b/docs/reference/api/TransformScheduleNowTransformResponse.md @@ -0,0 +1,4 @@ +## `TransformScheduleNowTransformResponse` +::: +type TransformScheduleNowTransformResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); +::: diff --git a/docs/reference/api/TransformSettings.md b/docs/reference/api/TransformSettings.md new file mode 100644 index 000000000..6d0afcfb6 --- /dev/null +++ b/docs/reference/api/TransformSettings.md @@ -0,0 +1,10 @@ +## Interface `TransformSettings` + +| Name | Type | Description | +| - | - | - | +| `align_checkpoints` | boolean | Specifies whether the transform checkpoint ranges should be optimized for performance. Such optimization can align checkpoint ranges with the date histogram interval when date histogram is specified as a group source in the transform config. As a result, less document updates in the destination index will be performed thus improving overall performance. | +| `dates_as_epoch_millis` | boolean | Defines if dates in the ouput should be written as ISO formatted string or as millis since epoch. epoch_millis was the default for transforms created before version 7.11. For compatible output set this value to `true`. | +| `deduce_mappings` | boolean | Specifies whether the transform should deduce the destination index mappings from the transform configuration. | +| `docs_per_second` | [float](./float.md) | Specifies a limit on the number of input documents per second. This setting throttles the transform by adding a wait time between search requests. The default value is null, which disables throttling. | +| `max_page_search_size` | [integer](./integer.md) | Defines the initial page size to use for the composite aggregation for each checkpoint. If circuit breaker exceptions occur, the page size is dynamically adjusted to a lower value. The minimum value is `10` and the maximum is `65,536`. | +| `unattended` | boolean | If `true`, the transform runs in unattended mode. In unattended mode, the transform retries indefinitely in case of an error which means the transform never fails. Setting the number of retries other than infinite fails in validation. | diff --git a/docs/reference/api/TransformSource.md b/docs/reference/api/TransformSource.md new file mode 100644 index 000000000..0a8d5a345 --- /dev/null +++ b/docs/reference/api/TransformSource.md @@ -0,0 +1,7 @@ +## Interface `TransformSource` + +| Name | Type | Description | +| - | - | - | +| `index` | [Indices](./Indices.md) | The source indices for the transform. It can be a single index, an index pattern (for example, `"my-index-*""`), an array of indices (for example, `["my-index-000001", "my-index-000002"]`), or an array of index patterns (for example, `["my-index-*", "my-other-index-*"]`. For remote indices use the syntax `"remote_name:index_name"`. If any indices are in remote clusters then the master node and at least one transform node must have the `remote_cluster_client` node role. | +| `query` | [QueryDslQueryContainer](./QueryDslQueryContainer.md) | A query clause that retrieves a subset of data from the source index. | +| `runtime_mappings` | [MappingRuntimeFields](./MappingRuntimeFields.md) | Definitions of search-time runtime fields that can be used by the transform. For search runtime fields all data nodes, including remote nodes, must be 7.12 or later. | diff --git a/docs/reference/api/TransformStartTransformRequest.md b/docs/reference/api/TransformStartTransformRequest.md new file mode 100644 index 000000000..6d7e77739 --- /dev/null +++ b/docs/reference/api/TransformStartTransformRequest.md @@ -0,0 +1,9 @@ +## Interface `TransformStartTransformRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { transform_id?: never; timeout?: never; from?: never; }) | All values in `body` will be added to the request body. | +| `from` | string | Restricts the set of transformed entities to those changed after this time. Relative times like now-30d are supported. Only applicable for continuous transforms. | +| `querystring` | { [key: string]: any; } & { transform_id?: never; timeout?: never; from?: never; } | All values in `querystring` will be added to the request querystring. | +| `timeout` | [Duration](./Duration.md) | Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. | +| `transform_id` | [Id](./Id.md) | Identifier for the transform. | diff --git a/docs/reference/api/TransformStartTransformResponse.md b/docs/reference/api/TransformStartTransformResponse.md new file mode 100644 index 000000000..fe4d88296 --- /dev/null +++ b/docs/reference/api/TransformStartTransformResponse.md @@ -0,0 +1,4 @@ +## `TransformStartTransformResponse` +::: +type TransformStartTransformResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); +::: diff --git a/docs/reference/api/TransformStopTransformRequest.md b/docs/reference/api/TransformStopTransformRequest.md new file mode 100644 index 000000000..cae445718 --- /dev/null +++ b/docs/reference/api/TransformStopTransformRequest.md @@ -0,0 +1,12 @@ +## Interface `TransformStopTransformRequest` + +| Name | Type | Description | +| - | - | - | +| `allow_no_match` | boolean | Specifies what to do when the request: contains wildcard expressions and there are no transforms that match; contains the `_all` string or no identifiers and there are no matches; contains wildcard expressions and there are only partial matches. If it is true, the API returns a successful acknowledgement message when there are no matches. When there are only partial matches, the API stops the appropriate transforms. If it is false, the request returns a 404 status code when there are no matches or only partial matches. | +| `body` | string | ({ [key: string]: any; } & { transform_id?: never; allow_no_match?: never; force?: never; timeout?: never; wait_for_checkpoint?: never; wait_for_completion?: never; }) | All values in `body` will be added to the request body. | +| `force` | boolean | If it is true, the API forcefully stops the transforms. | +| `querystring` | { [key: string]: any; } & { transform_id?: never; allow_no_match?: never; force?: never; timeout?: never; wait_for_checkpoint?: never; wait_for_completion?: never; } | All values in `querystring` will be added to the request querystring. | +| `timeout` | [Duration](./Duration.md) | Period to wait for a response when `wait_for_completion` is `true`. If no response is received before the timeout expires, the request returns a timeout exception. However, the request continues processing and eventually moves the transform to a STOPPED state. | +| `transform_id` | [Name](./Name.md) | Identifier for the transform. To stop multiple transforms, use a comma-separated list or a wildcard expression. To stop all transforms, use `_all` or `*` as the identifier. | +| `wait_for_checkpoint` | boolean | If it is true, the transform does not completely stop until the current checkpoint is completed. If it is false, the transform stops as soon as possible. | +| `wait_for_completion` | boolean | If it is true, the API blocks until the indexer state completely stops. If it is false, the API returns immediately and the indexer is stopped asynchronously in the background. | diff --git a/docs/reference/api/TransformStopTransformResponse.md b/docs/reference/api/TransformStopTransformResponse.md new file mode 100644 index 000000000..45134e905 --- /dev/null +++ b/docs/reference/api/TransformStopTransformResponse.md @@ -0,0 +1,4 @@ +## `TransformStopTransformResponse` +::: +type TransformStopTransformResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); +::: diff --git a/docs/reference/api/TransformSyncContainer.md b/docs/reference/api/TransformSyncContainer.md new file mode 100644 index 000000000..a9331c94d --- /dev/null +++ b/docs/reference/api/TransformSyncContainer.md @@ -0,0 +1,5 @@ +## Interface `TransformSyncContainer` + +| Name | Type | Description | +| - | - | - | +| `time` | [TransformTimeSync](./TransformTimeSync.md) | Specifies that the transform uses a time field to synchronize the source and destination indices. | diff --git a/docs/reference/api/TransformTimeSync.md b/docs/reference/api/TransformTimeSync.md new file mode 100644 index 000000000..14dbaf55a --- /dev/null +++ b/docs/reference/api/TransformTimeSync.md @@ -0,0 +1,6 @@ +## Interface `TransformTimeSync` + +| Name | Type | Description | +| - | - | - | +| `delay` | [Duration](./Duration.md) | The time delay between the current time and the latest input data time. | +| `field` | [Field](./Field.md) | The date field that is used to identify new documents in the source. In general, it’s a good idea to use a field that contains the ingest timestamp. If you use a different field, you might need to set the delay such that it accounts for data transmission delays. | diff --git a/docs/reference/api/TransformUpdateTransformRequest.md b/docs/reference/api/TransformUpdateTransformRequest.md new file mode 100644 index 000000000..6e4ab3b3e --- /dev/null +++ b/docs/reference/api/TransformUpdateTransformRequest.md @@ -0,0 +1,17 @@ +## Interface `TransformUpdateTransformRequest` + +| Name | Type | Description | +| - | - | - | +| `_meta` | [Metadata](./Metadata.md) | Defines optional transform metadata. | +| `body` | string | ({ [key: string]: any; } & { transform_id?: never; defer_validation?: never; timeout?: never; dest?: never; description?: never; frequency?: never; _meta?: never; source?: never; settings?: never; sync?: never; retention_policy?: never; }) | All values in `body` will be added to the request body. | +| `defer_validation` | boolean | When true, deferrable validations are not run. This behavior may be desired if the source index does not exist until after the transform is created. | +| `description` | string | Free text description of the transform. | +| `dest` | [TransformDestination](./TransformDestination.md) | The destination for the transform. | +| `frequency` | [Duration](./Duration.md) | The interval between checks for changes in the source indices when the transform is running continuously. Also determines the retry interval in the event of transient failures while the transform is searching or indexing. The minimum value is 1s and the maximum is 1h. | +| `querystring` | { [key: string]: any; } & { transform_id?: never; defer_validation?: never; timeout?: never; dest?: never; description?: never; frequency?: never; _meta?: never; source?: never; settings?: never; sync?: never; retention_policy?: never; } | All values in `querystring` will be added to the request querystring. | +| `retention_policy` | [TransformRetentionPolicyContainer](./TransformRetentionPolicyContainer.md) | null | Defines a retention policy for the transform. Data that meets the defined criteria is deleted from the destination index. | +| `settings` | [TransformSettings](./TransformSettings.md) | Defines optional transform settings. | +| `source` | [TransformSource](./TransformSource.md) | The source of the data for the transform. | +| `sync` | [TransformSyncContainer](./TransformSyncContainer.md) | Defines the properties transforms require to run continuously. | +| `timeout` | [Duration](./Duration.md) | Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. | +| `transform_id` | [Id](./Id.md) | Identifier for the transform. | diff --git a/docs/reference/api/TransformUpdateTransformResponse.md b/docs/reference/api/TransformUpdateTransformResponse.md new file mode 100644 index 000000000..4bd7a3546 --- /dev/null +++ b/docs/reference/api/TransformUpdateTransformResponse.md @@ -0,0 +1,18 @@ +## Interface `TransformUpdateTransformResponse` + +| Name | Type | Description | +| - | - | - | +| `_meta` | [Metadata](./Metadata.md) |   | +| `authorization` | [MlTransformAuthorization](./MlTransformAuthorization.md) |   | +| `create_time` | [long](./long.md) |   | +| `description` | string |   | +| `dest` | [ReindexDestination](./ReindexDestination.md) |   | +| `frequency` | [Duration](./Duration.md) |   | +| `id` | [Id](./Id.md) |   | +| `latest` | [TransformLatest](./TransformLatest.md) |   | +| `pivot` | [TransformPivot](./TransformPivot.md) |   | +| `retention_policy` | [TransformRetentionPolicyContainer](./TransformRetentionPolicyContainer.md) |   | +| `settings` | [TransformSettings](./TransformSettings.md) |   | +| `source` | [ReindexSource](./ReindexSource.md) |   | +| `sync` | [TransformSyncContainer](./TransformSyncContainer.md) |   | +| `version` | [VersionString](./VersionString.md) |   | diff --git a/docs/reference/api/TransformUpgradeTransformsRequest.md b/docs/reference/api/TransformUpgradeTransformsRequest.md new file mode 100644 index 000000000..33c0bc6c2 --- /dev/null +++ b/docs/reference/api/TransformUpgradeTransformsRequest.md @@ -0,0 +1,8 @@ +## Interface `TransformUpgradeTransformsRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { dry_run?: never; timeout?: never; }) | All values in `body` will be added to the request body. | +| `dry_run` | boolean | When true, the request checks for updates but does not run them. | +| `querystring` | { [key: string]: any; } & { dry_run?: never; timeout?: never; } | All values in `querystring` will be added to the request querystring. | +| `timeout` | [Duration](./Duration.md) | Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. | diff --git a/docs/reference/api/TransformUpgradeTransformsResponse.md b/docs/reference/api/TransformUpgradeTransformsResponse.md new file mode 100644 index 000000000..5645a93f5 --- /dev/null +++ b/docs/reference/api/TransformUpgradeTransformsResponse.md @@ -0,0 +1,7 @@ +## Interface `TransformUpgradeTransformsResponse` + +| Name | Type | Description | +| - | - | - | +| `needs_update` | [integer](./integer.md) | The number of transforms that need to be upgraded. | +| `no_action` | [integer](./integer.md) | The number of transforms that don’t require upgrading. | +| `updated` | [integer](./integer.md) | The number of transforms that have been upgraded. | diff --git a/docs/reference/api/TranslogStats.md b/docs/reference/api/TranslogStats.md new file mode 100644 index 000000000..51e9d51fd --- /dev/null +++ b/docs/reference/api/TranslogStats.md @@ -0,0 +1,11 @@ +## Interface `TranslogStats` + +| Name | Type | Description | +| - | - | - | +| `earliest_last_modified_age` | [long](./long.md) |   | +| `operations` | [long](./long.md) |   | +| `size_in_bytes` | [long](./long.md) |   | +| `size` | string |   | +| `uncommitted_operations` | [integer](./integer.md) |   | +| `uncommitted_size_in_bytes` | [long](./long.md) |   | +| `uncommitted_size` | string |   | diff --git a/docs/reference/api/TransportAddress.md b/docs/reference/api/TransportAddress.md new file mode 100644 index 000000000..f1fed2cbe --- /dev/null +++ b/docs/reference/api/TransportAddress.md @@ -0,0 +1,4 @@ +## `TransportAddress` +::: +type TransportAddress = string; +::: diff --git a/docs/reference/api/UnitFloatMillis.md b/docs/reference/api/UnitFloatMillis.md new file mode 100644 index 000000000..6d201c052 --- /dev/null +++ b/docs/reference/api/UnitFloatMillis.md @@ -0,0 +1,4 @@ +## `UnitFloatMillis` +::: +type UnitFloatMillis = [double](./double.md); +::: diff --git a/docs/reference/api/UnitMillis.md b/docs/reference/api/UnitMillis.md new file mode 100644 index 000000000..0c39defbb --- /dev/null +++ b/docs/reference/api/UnitMillis.md @@ -0,0 +1,4 @@ +## `UnitMillis` +::: +type UnitMillis = [long](./long.md); +::: diff --git a/docs/reference/api/UnitNanos.md b/docs/reference/api/UnitNanos.md new file mode 100644 index 000000000..e04193059 --- /dev/null +++ b/docs/reference/api/UnitNanos.md @@ -0,0 +1,4 @@ +## `UnitNanos` +::: +type UnitNanos = [long](./long.md); +::: diff --git a/docs/reference/api/UnitSeconds.md b/docs/reference/api/UnitSeconds.md new file mode 100644 index 000000000..5ddddf824 --- /dev/null +++ b/docs/reference/api/UnitSeconds.md @@ -0,0 +1,4 @@ +## `UnitSeconds` +::: +type UnitSeconds = [long](./long.md); +::: diff --git a/docs/reference/api/UpdateAction.md b/docs/reference/api/UpdateAction.md new file mode 100644 index 000000000..4f2d98631 --- /dev/null +++ b/docs/reference/api/UpdateAction.md @@ -0,0 +1,4 @@ +## `UpdateAction` +::: +type UpdateAction = [[UpdateActionOperation](./UpdateActionOperation.md), [BulkUpdateAction](./BulkUpdateAction.md)]; +::: diff --git a/docs/reference/api/UpdateActionOperation.md b/docs/reference/api/UpdateActionOperation.md new file mode 100644 index 000000000..f259b547f --- /dev/null +++ b/docs/reference/api/UpdateActionOperation.md @@ -0,0 +1,5 @@ +## Interface `UpdateActionOperation` + +| Name | Type | Description | +| - | - | - | +| `update` | [BulkUpdateOperation](./BulkUpdateOperation.md) |   | diff --git a/docs/reference/api/UpdateApi_1.md b/docs/reference/api/UpdateApi_1.md new file mode 100644 index 000000000..f85328aff --- /dev/null +++ b/docs/reference/api/UpdateApi_1.md @@ -0,0 +1,3 @@ +::: +default function UpdateApi(this: [That](./That.md), params: [UpdateRequest](./UpdateRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[UpdateResponse](./UpdateResponse.md)>; +::: diff --git a/docs/reference/api/UpdateApi_2.md b/docs/reference/api/UpdateApi_2.md new file mode 100644 index 000000000..4070bc67c --- /dev/null +++ b/docs/reference/api/UpdateApi_2.md @@ -0,0 +1,3 @@ +::: +default function UpdateApi(this: [That](./That.md), params: [UpdateRequest](./UpdateRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[UpdateResponse](./UpdateResponse.md), unknown>>; +::: diff --git a/docs/reference/api/UpdateApi_3.md b/docs/reference/api/UpdateApi_3.md new file mode 100644 index 000000000..c953d5e05 --- /dev/null +++ b/docs/reference/api/UpdateApi_3.md @@ -0,0 +1,3 @@ +::: +default function UpdateApi(this: [That](./That.md), params: [UpdateRequest](./UpdateRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[UpdateResponse](./UpdateResponse.md)>; +::: diff --git a/docs/reference/api/UpdateByQueryApi_1.md b/docs/reference/api/UpdateByQueryApi_1.md new file mode 100644 index 000000000..c48fac709 --- /dev/null +++ b/docs/reference/api/UpdateByQueryApi_1.md @@ -0,0 +1,3 @@ +::: +default function UpdateByQueryApi(this: [That](./That.md), params: [UpdateByQueryRequest](./UpdateByQueryRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[UpdateByQueryResponse](./UpdateByQueryResponse.md)>; +::: diff --git a/docs/reference/api/UpdateByQueryApi_2.md b/docs/reference/api/UpdateByQueryApi_2.md new file mode 100644 index 000000000..39668353e --- /dev/null +++ b/docs/reference/api/UpdateByQueryApi_2.md @@ -0,0 +1,3 @@ +::: +default function UpdateByQueryApi(this: [That](./That.md), params: [UpdateByQueryRequest](./UpdateByQueryRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[UpdateByQueryResponse](./UpdateByQueryResponse.md), unknown>>; +::: diff --git a/docs/reference/api/UpdateByQueryApi_3.md b/docs/reference/api/UpdateByQueryApi_3.md new file mode 100644 index 000000000..b88bdfccb --- /dev/null +++ b/docs/reference/api/UpdateByQueryApi_3.md @@ -0,0 +1,3 @@ +::: +default function UpdateByQueryApi(this: [That](./That.md), params: [UpdateByQueryRequest](./UpdateByQueryRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[UpdateByQueryResponse](./UpdateByQueryResponse.md)>; +::: diff --git a/docs/reference/api/UpdateByQueryRequest.md b/docs/reference/api/UpdateByQueryRequest.md new file mode 100644 index 000000000..7858a41db --- /dev/null +++ b/docs/reference/api/UpdateByQueryRequest.md @@ -0,0 +1,41 @@ +## Interface `UpdateByQueryRequest` + +| Name | Type | Description | +| - | - | - | +| `allow_no_indices` | boolean | If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. | +| `analyze_wildcard` | boolean | If `true`, wildcard and prefix queries are analyzed. This parameter can be used only when the `q` query string parameter is specified. | +| `analyzer` | string | The analyzer to use for the query string. This parameter can be used only when the `q` query string parameter is specified. | +| `body` | string | ({ [key: string]: any; } & { index?: never; allow_no_indices?: never; analyzer?: never; analyze_wildcard?: never; default_operator?: never; df?: never; expand_wildcards?: never; from?: never; ignore_unavailable?: never; lenient?: never; pipeline?: never; preference?: never; q?: never; refresh?: never; request_cache?: never; requests_per_second?: never; routing?: never; scroll?: never; scroll_size?: never; search_timeout?: never; search_type?: never; slices?: never; sort?: never; stats?: never; terminate_after?: never; timeout?: never; version?: never; version_type?: never; wait_for_active_shards?: never; wait_for_completion?: never; max_docs?: never; query?: never; script?: never; slice?: never; conflicts?: never; }) | All values in `body` will be added to the request body. | +| `conflicts` | [Conflicts](./Conflicts.md) | The preferred behavior when update by query hits version conflicts: `abort` or `proceed`. | +| `default_operator` | [QueryDslOperator](./QueryDslOperator.md) | The default operator for query string query: `AND` or `OR`. This parameter can be used only when the `q` query string parameter is specified. | +| `df` | string | The field to use as default where no field prefix is given in the query string. This parameter can be used only when the `q` query string parameter is specified. | +| `expand_wildcards` | [ExpandWildcards](./ExpandWildcards.md) | The type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. It supports comma-separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. | +| `from` | [long](./long.md) | Skips the specified number of documents. | +| `ignore_unavailable` | boolean | If `false`, the request returns an error if it targets a missing or closed index. | +| `index` | [Indices](./Indices.md) | A comma-separated list of data streams, indices, and aliases to search. It supports wildcards ( `*`). To search all data streams or indices, omit this parameter or use `*` or `_all`. | +| `lenient` | boolean | If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. This parameter can be used only when the `q` query string parameter is specified. | +| `max_docs` | [long](./long.md) | The maximum number of documents to update. | +| `pipeline` | string | The ID of the pipeline to use to preprocess incoming documents. If the index has a default ingest pipeline specified, then setting the value to `_none` disables the default ingest pipeline for this request. If a final pipeline is configured it will always run, regardless of the value of this parameter. | +| `preference` | string | The node or shard the operation should be performed on. It is random by default. | +| `q` | string | A query in the Lucene query string syntax. | +| `query` | [QueryDslQueryContainer](./QueryDslQueryContainer.md) | The documents to update using the Query DSL. | +| `querystring` | { [key: string]: any; } & { index?: never; allow_no_indices?: never; analyzer?: never; analyze_wildcard?: never; default_operator?: never; df?: never; expand_wildcards?: never; from?: never; ignore_unavailable?: never; lenient?: never; pipeline?: never; preference?: never; q?: never; refresh?: never; request_cache?: never; requests_per_second?: never; routing?: never; scroll?: never; scroll_size?: never; search_timeout?: never; search_type?: never; slices?: never; sort?: never; stats?: never; terminate_after?: never; timeout?: never; version?: never; version_type?: never; wait_for_active_shards?: never; wait_for_completion?: never; max_docs?: never; query?: never; script?: never; slice?: never; conflicts?: never; } | All values in `querystring` will be added to the request querystring. | +| `refresh` | boolean | If `true`, Elasticsearch refreshes affected shards to make the operation visible to search after the request completes. This is different than the update API's `refresh` parameter, which causes just the shard that received the request to be refreshed. | +| `request_cache` | boolean | If `true`, the request cache is used for this request. It defaults to the index-level setting. | +| `requests_per_second` | [float](./float.md) | The throttle for this request in sub-requests per second. | +| `routing` | [Routing](./Routing.md) | A custom value used to route operations to a specific shard. | +| `script` | [Script](./Script.md) | [ScriptSource](./ScriptSource.md) | The script to run to update the document source or metadata when updating. | +| `scroll_size` | [long](./long.md) | The size of the scroll request that powers the operation. | +| `scroll` | [Duration](./Duration.md) | The period to retain the search context for scrolling. | +| `search_timeout` | [Duration](./Duration.md) | An explicit timeout for each search request. By default, there is no timeout. | +| `search_type` | [SearchType](./SearchType.md) | The type of the search operation. Available options include `query_then_fetch` and `dfs_query_then_fetch`. | +| `slice` | [SlicedScroll](./SlicedScroll.md) | Slice the request manually using the provided slice ID and total number of slices. | +| `slices` | [Slices](./Slices.md) | The number of slices this task should be divided into. | +| `sort` | string[] | A comma-separated list of : pairs. | +| `stats` | string[] | The specific `tag` of the request for logging and statistical purposes. | +| `terminate_after` | [long](./long.md) | The maximum number of documents to collect for each shard. If a query reaches this limit, Elasticsearch terminates the query early. Elasticsearch collects documents before sorting. IMPORTANT: Use with caution. Elasticsearch applies this parameter to each shard handling the request. When possible, let Elasticsearch perform early termination automatically. Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers. | +| `timeout` | [Duration](./Duration.md) | The period each update request waits for the following operations: dynamic mapping updates, waiting for active shards. By default, it is one minute. This guarantees Elasticsearch waits for at least the timeout before failing. The actual wait time could be longer, particularly when multiple waits occur. | +| `version_type` | boolean | Should the document increment the version number (internal) on hit or not (reindex) | +| `version` | boolean | If `true`, returns the document version as part of a hit. | +| `wait_for_active_shards` | [WaitForActiveShards](./WaitForActiveShards.md) | The number of shard copies that must be active before proceeding with the operation. Set to `all` or any positive integer up to the total number of shards in the index ( `number_of_replicas+1`). The `timeout` parameter controls how long each write request waits for unavailable shards to become available. Both work exactly the way they work in the bulk API. | +| `wait_for_completion` | boolean | If `true`, the request blocks until the operation is complete. If `false`, Elasticsearch performs some preflight checks, launches the request, and returns a task ID that you can use to cancel or get the status of the task. Elasticsearch creates a record of this task as a document at `.tasks/task/${taskId}`. | diff --git a/docs/reference/api/UpdateByQueryResponse.md b/docs/reference/api/UpdateByQueryResponse.md new file mode 100644 index 000000000..9b3292ee9 --- /dev/null +++ b/docs/reference/api/UpdateByQueryResponse.md @@ -0,0 +1,20 @@ +## Interface `UpdateByQueryResponse` + +| Name | Type | Description | +| - | - | - | +| `batches` | [long](./long.md) | The number of scroll responses pulled back by the update by query. | +| `deleted` | [long](./long.md) | The number of documents that were successfully deleted. | +| `failures` | [BulkIndexByScrollFailure](./BulkIndexByScrollFailure.md)[] | Array of failures if there were any unrecoverable errors during the process. If this is non-empty then the request ended because of those failures. Update by query is implemented using batches. Any failure causes the entire process to end, but all failures in the current batch are collected into the array. You can use the `conflicts` option to prevent reindex from ending when version conflicts occur. | +| `noops` | [long](./long.md) | The number of documents that were ignored because the script used for the update by query returned a noop value for `ctx.op`. | +| `requests_per_second` | [float](./float.md) | The number of requests per second effectively run during the update by query. | +| `retries` | [Retries](./Retries.md) | The number of retries attempted by update by query. `bulk` is the number of bulk actions retried. `search` is the number of search actions retried. | +| `task` | [TaskId](./TaskId.md) |   | +| `throttled_millis` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> | The number of milliseconds the request slept to conform to `requests_per_second`. | +| `throttled_until_millis` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> | This field should always be equal to zero in an _update_by_query response. It only has meaning when using the task API, where it indicates the next time (in milliseconds since epoch) a throttled request will be run again in order to conform to `requests_per_second`. | +| `throttled_until` | [Duration](./Duration.md) |   | +| `throttled` | [Duration](./Duration.md) |   | +| `timed_out` | boolean | If true, some requests timed out during the update by query. | +| `took` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> | The number of milliseconds from start to end of the whole operation. | +| `total` | [long](./long.md) | The number of documents that were successfully processed. | +| `updated` | [long](./long.md) | The number of documents that were successfully updated. | +| `version_conflicts` | [long](./long.md) | The number of version conflicts that the update by query hit. | diff --git a/docs/reference/api/UpdateByQueryRethrottleApi_1.md b/docs/reference/api/UpdateByQueryRethrottleApi_1.md new file mode 100644 index 000000000..c4912c7f6 --- /dev/null +++ b/docs/reference/api/UpdateByQueryRethrottleApi_1.md @@ -0,0 +1,3 @@ +::: +default function UpdateByQueryRethrottleApi(this: [That](./That.md), params: [UpdateByQueryRethrottleRequest](./UpdateByQueryRethrottleRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[UpdateByQueryRethrottleResponse](./UpdateByQueryRethrottleResponse.md)>; +::: diff --git a/docs/reference/api/UpdateByQueryRethrottleApi_2.md b/docs/reference/api/UpdateByQueryRethrottleApi_2.md new file mode 100644 index 000000000..f728c8179 --- /dev/null +++ b/docs/reference/api/UpdateByQueryRethrottleApi_2.md @@ -0,0 +1,3 @@ +::: +default function UpdateByQueryRethrottleApi(this: [That](./That.md), params: [UpdateByQueryRethrottleRequest](./UpdateByQueryRethrottleRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[UpdateByQueryRethrottleResponse](./UpdateByQueryRethrottleResponse.md), unknown>>; +::: diff --git a/docs/reference/api/UpdateByQueryRethrottleApi_3.md b/docs/reference/api/UpdateByQueryRethrottleApi_3.md new file mode 100644 index 000000000..5ff1b9c49 --- /dev/null +++ b/docs/reference/api/UpdateByQueryRethrottleApi_3.md @@ -0,0 +1,3 @@ +::: +default function UpdateByQueryRethrottleApi(this: [That](./That.md), params: [UpdateByQueryRethrottleRequest](./UpdateByQueryRethrottleRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[UpdateByQueryRethrottleResponse](./UpdateByQueryRethrottleResponse.md)>; +::: diff --git a/docs/reference/api/UpdateByQueryRethrottleRequest.md b/docs/reference/api/UpdateByQueryRethrottleRequest.md new file mode 100644 index 000000000..7b5671bc8 --- /dev/null +++ b/docs/reference/api/UpdateByQueryRethrottleRequest.md @@ -0,0 +1,8 @@ +## Interface `UpdateByQueryRethrottleRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { task_id?: never; requests_per_second?: never; }) | All values in `body` will be added to the request body. | +| `querystring` | { [key: string]: any; } & { task_id?: never; requests_per_second?: never; } | All values in `querystring` will be added to the request querystring. | +| `requests_per_second` | [float](./float.md) | The throttle for this request in sub-requests per second. To turn off throttling, set it to `-1`. | +| `task_id` | [Id](./Id.md) | The ID for the task. | diff --git a/docs/reference/api/UpdateByQueryRethrottleResponse.md b/docs/reference/api/UpdateByQueryRethrottleResponse.md new file mode 100644 index 000000000..9412df9a2 --- /dev/null +++ b/docs/reference/api/UpdateByQueryRethrottleResponse.md @@ -0,0 +1,5 @@ +## Interface `UpdateByQueryRethrottleResponse` + +| Name | Type | Description | +| - | - | - | +| `nodes` | Record |   | diff --git a/docs/reference/api/UpdateByQueryRethrottleUpdateByQueryRethrottleNode.md b/docs/reference/api/UpdateByQueryRethrottleUpdateByQueryRethrottleNode.md new file mode 100644 index 000000000..3b054f0d6 --- /dev/null +++ b/docs/reference/api/UpdateByQueryRethrottleUpdateByQueryRethrottleNode.md @@ -0,0 +1,5 @@ +## Interface `UpdateByQueryRethrottleUpdateByQueryRethrottleNode` + +| Name | Type | Description | +| - | - | - | +| `tasks` | Record<[TaskId](./TaskId.md), [TasksTaskInfo](./TasksTaskInfo.md)> |   | diff --git a/docs/reference/api/UpdateRequest.md b/docs/reference/api/UpdateRequest.md new file mode 100644 index 000000000..2ddcb4440 --- /dev/null +++ b/docs/reference/api/UpdateRequest.md @@ -0,0 +1,27 @@ +## Interface `UpdateRequest` + +| Name | Type | Description | +| - | - | - | +| `_source_excludes` | [Fields](./Fields.md) | The source fields you want to exclude. | +| `_source_includes` | [Fields](./Fields.md) | The source fields you want to retrieve. | +| `_source` | [SearchSourceConfig](./SearchSourceConfig.md) | If `false`, turn off source retrieval. You can also specify a comma-separated list of the fields you want to retrieve. | +| `body` | string | ({ [key: string]: any; } & { id?: never; index?: never; if_primary_term?: never; if_seq_no?: never; include_source_on_error?: never; lang?: never; refresh?: never; require_alias?: never; retry_on_conflict?: never; routing?: never; timeout?: never; wait_for_active_shards?: never; _source_excludes?: never; _source_includes?: never; detect_noop?: never; doc?: never; doc_as_upsert?: never; script?: never; scripted_upsert?: never; _source?: never; upsert?: never; }) | All values in `body` will be added to the request body. | +| `detect_noop` | boolean | If `true`, the `result` in the response is set to `noop` (no operation) when there are no changes to the document. | +| `doc_as_upsert` | boolean | If `true`, use the contents of 'doc' as the value of 'upsert'. NOTE: Using ingest pipelines with `doc_as_upsert` is not supported. | +| `doc` | TPartialDocument | A partial update to an existing document. If both `doc` and `script` are specified, `doc` is ignored. | +| `id` | [Id](./Id.md) | A unique identifier for the document to be updated. | +| `if_primary_term` | [long](./long.md) | Only perform the operation if the document has this primary term. | +| `if_seq_no` | [SequenceNumber](./SequenceNumber.md) | Only perform the operation if the document has this sequence number. | +| `include_source_on_error` | boolean | True or false if to include the document source in the error message in case of parsing errors. | +| `index` | [IndexName](./IndexName.md) | The name of the target index. By default, the index is created automatically if it doesn't exist. | +| `lang` | string | The script language. | +| `querystring` | { [key: string]: any; } & { id?: never; index?: never; if_primary_term?: never; if_seq_no?: never; include_source_on_error?: never; lang?: never; refresh?: never; require_alias?: never; retry_on_conflict?: never; routing?: never; timeout?: never; wait_for_active_shards?: never; _source_excludes?: never; _source_includes?: never; detect_noop?: never; doc?: never; doc_as_upsert?: never; script?: never; scripted_upsert?: never; _source?: never; upsert?: never; } | All values in `querystring` will be added to the request querystring. | +| `refresh` | [Refresh](./Refresh.md) | If 'true', Elasticsearch refreshes the affected shards to make this operation visible to search. If 'wait_for', it waits for a refresh to make this operation visible to search. If 'false', it does nothing with refreshes. | +| `require_alias` | boolean | If `true`, the destination must be an index alias. | +| `retry_on_conflict` | [integer](./integer.md) | The number of times the operation should be retried when a conflict occurs. | +| `routing` | [Routing](./Routing.md) | A custom value used to route operations to a specific shard. | +| `script` | [Script](./Script.md) | [ScriptSource](./ScriptSource.md) | The script to run to update the document. | +| `scripted_upsert` | boolean | If `true`, run the script whether or not the document exists. | +| `timeout` | [Duration](./Duration.md) | The period to wait for the following operations: dynamic mapping updates and waiting for active shards. Elasticsearch waits for at least the timeout period before failing. The actual wait time could be longer, particularly when multiple waits occur. | +| `upsert` | TDocument | If the document does not already exist, the contents of 'upsert' are inserted as a new document. If the document exists, the 'script' is run. | +| `wait_for_active_shards` | [WaitForActiveShards](./WaitForActiveShards.md) | The number of copies of each shard that must be active before proceeding with the operation. Set to 'all' or any positive integer up to the total number of shards in the index ( `number_of_replicas`+1). The default value of `1` means it waits for each primary shard to be active. | diff --git a/docs/reference/api/UpdateResponse.md b/docs/reference/api/UpdateResponse.md new file mode 100644 index 000000000..27cbdc1f3 --- /dev/null +++ b/docs/reference/api/UpdateResponse.md @@ -0,0 +1,4 @@ +## `UpdateResponse` +::: +type UpdateResponse = [UpdateUpdateWriteResponseBase](./UpdateUpdateWriteResponseBase.md); +::: diff --git a/docs/reference/api/UpdateUpdateWriteResponseBase.md b/docs/reference/api/UpdateUpdateWriteResponseBase.md new file mode 100644 index 000000000..1a1145a40 --- /dev/null +++ b/docs/reference/api/UpdateUpdateWriteResponseBase.md @@ -0,0 +1,5 @@ +## Interface `UpdateUpdateWriteResponseBase` + +| Name | Type | Description | +| - | - | - | +| `get` | [InlineGet](./InlineGet.md) |   | diff --git a/docs/reference/api/Username.md b/docs/reference/api/Username.md new file mode 100644 index 000000000..ca607e195 --- /dev/null +++ b/docs/reference/api/Username.md @@ -0,0 +1,4 @@ +## `Username` +::: +type Username = string; +::: diff --git a/docs/reference/api/Uuid.md b/docs/reference/api/Uuid.md new file mode 100644 index 000000000..527e5f8d7 --- /dev/null +++ b/docs/reference/api/Uuid.md @@ -0,0 +1,4 @@ +## `Uuid` +::: +type Uuid = string; +::: diff --git a/docs/reference/api/VersionNumber.md b/docs/reference/api/VersionNumber.md new file mode 100644 index 000000000..d097abce9 --- /dev/null +++ b/docs/reference/api/VersionNumber.md @@ -0,0 +1,4 @@ +## `VersionNumber` +::: +type VersionNumber = [long](./long.md); +::: diff --git a/docs/reference/api/VersionString.md b/docs/reference/api/VersionString.md new file mode 100644 index 000000000..e3b249178 --- /dev/null +++ b/docs/reference/api/VersionString.md @@ -0,0 +1,4 @@ +## `VersionString` +::: +type VersionString = string; +::: diff --git a/docs/reference/api/VersionType.md b/docs/reference/api/VersionType.md new file mode 100644 index 000000000..b0ff5079d --- /dev/null +++ b/docs/reference/api/VersionType.md @@ -0,0 +1,4 @@ +## `VersionType` +::: +type VersionType = 'internal' | 'external' | 'external_gte' | 'force'; +::: diff --git a/docs/reference/api/WaitForActiveShardOptions.md b/docs/reference/api/WaitForActiveShardOptions.md new file mode 100644 index 000000000..48171d46c --- /dev/null +++ b/docs/reference/api/WaitForActiveShardOptions.md @@ -0,0 +1,4 @@ +## `WaitForActiveShardOptions` +::: +type WaitForActiveShardOptions = 'all' | 'index-setting'; +::: diff --git a/docs/reference/api/WaitForActiveShards.md b/docs/reference/api/WaitForActiveShards.md new file mode 100644 index 000000000..595d4386d --- /dev/null +++ b/docs/reference/api/WaitForActiveShards.md @@ -0,0 +1,4 @@ +## `WaitForActiveShards` +::: +type WaitForActiveShards = [integer](./integer.md) | [WaitForActiveShardOptions](./WaitForActiveShardOptions.md); +::: diff --git a/docs/reference/api/WaitForEvents.md b/docs/reference/api/WaitForEvents.md new file mode 100644 index 000000000..2fb753c33 --- /dev/null +++ b/docs/reference/api/WaitForEvents.md @@ -0,0 +1,4 @@ +## `WaitForEvents` +::: +type WaitForEvents = 'immediate' | 'urgent' | 'high' | 'normal' | 'low' | 'languid'; +::: diff --git a/docs/reference/api/WarmerStats.md b/docs/reference/api/WarmerStats.md new file mode 100644 index 000000000..9111f80ac --- /dev/null +++ b/docs/reference/api/WarmerStats.md @@ -0,0 +1,8 @@ +## Interface `WarmerStats` + +| Name | Type | Description | +| - | - | - | +| `current` | [long](./long.md) |   | +| `total_time_in_millis` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> |   | +| `total_time` | [Duration](./Duration.md) |   | +| `total` | [long](./long.md) |   | diff --git a/docs/reference/api/Watcher.md b/docs/reference/api/Watcher.md new file mode 100644 index 000000000..3b048d1d4 --- /dev/null +++ b/docs/reference/api/Watcher.md @@ -0,0 +1,20 @@ +## `Watcher` + +### Constructor + +::: +new Watcher(transport: [Transport](./Transport.md)); +::: + +### Properties + +| Name | Type | Description | +| - | - | - | +| `acceptedParams` | Record |   | +| `transport` | [Transport](./Transport.md) |   | + +### Methods + +| Name | Signature | Description | +| - | - | - | +| `ackWatch` | `ackWatch(this: [That](./That.md), params: [WatcherAckWatchRequest](./WatcherAckWatchRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[WatcherAckWatchResponse](./WatcherAckWatchResponse.md)>;` | Acknowledge a watch. Acknowledging a watch enables you to manually throttle the execution of the watch's actions. The acknowledgement state of an action is stored in the `status.actions..ack.state` structure. IMPORTANT: If the specified watch is currently being executed, this API will return an error The reason for this behavior is to prevent overwriting the watch status from a watch execution. Acknowledging an action throttles further executions of that action until its `ack.state` is reset to `awaits_successful_execution`. This happens when the condition of the watch is not met (the condition evaluates to false). || `ackWatch` | `ackWatch(this: [That](./That.md), params: [WatcherAckWatchRequest](./WatcherAckWatchRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[WatcherAckWatchResponse](./WatcherAckWatchResponse.md), unknown>>;` |   || `ackWatch` | `ackWatch(this: [That](./That.md), params: [WatcherAckWatchRequest](./WatcherAckWatchRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[WatcherAckWatchResponse](./WatcherAckWatchResponse.md)>;` |   || `activateWatch` | `activateWatch(this: [That](./That.md), params: [WatcherActivateWatchRequest](./WatcherActivateWatchRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[WatcherActivateWatchResponse](./WatcherActivateWatchResponse.md)>;` | Activate a watch. A watch can be either active or inactive. || `activateWatch` | `activateWatch(this: [That](./That.md), params: [WatcherActivateWatchRequest](./WatcherActivateWatchRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[WatcherActivateWatchResponse](./WatcherActivateWatchResponse.md), unknown>>;` |   || `activateWatch` | `activateWatch(this: [That](./That.md), params: [WatcherActivateWatchRequest](./WatcherActivateWatchRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[WatcherActivateWatchResponse](./WatcherActivateWatchResponse.md)>;` |   || `deactivateWatch` | `deactivateWatch(this: [That](./That.md), params: [WatcherDeactivateWatchRequest](./WatcherDeactivateWatchRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[WatcherDeactivateWatchResponse](./WatcherDeactivateWatchResponse.md)>;` | Deactivate a watch. A watch can be either active or inactive. || `deactivateWatch` | `deactivateWatch(this: [That](./That.md), params: [WatcherDeactivateWatchRequest](./WatcherDeactivateWatchRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[WatcherDeactivateWatchResponse](./WatcherDeactivateWatchResponse.md), unknown>>;` |   || `deactivateWatch` | `deactivateWatch(this: [That](./That.md), params: [WatcherDeactivateWatchRequest](./WatcherDeactivateWatchRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[WatcherDeactivateWatchResponse](./WatcherDeactivateWatchResponse.md)>;` |   || `deleteWatch` | `deleteWatch(this: [That](./That.md), params: [WatcherDeleteWatchRequest](./WatcherDeleteWatchRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[WatcherDeleteWatchResponse](./WatcherDeleteWatchResponse.md)>;` | Delete a watch. When the watch is removed, the document representing the watch in the `.watches` index is gone and it will never be run again. Deleting a watch does not delete any watch execution records related to this watch from the watch history. IMPORTANT: Deleting a watch must be done by using only this API. Do not delete the watch directly from the `.watches` index using the Elasticsearch delete document API When Elasticsearch security features are enabled, make sure no write privileges are granted to anyone for the `.watches` index. || `deleteWatch` | `deleteWatch(this: [That](./That.md), params: [WatcherDeleteWatchRequest](./WatcherDeleteWatchRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[WatcherDeleteWatchResponse](./WatcherDeleteWatchResponse.md), unknown>>;` |   || `deleteWatch` | `deleteWatch(this: [That](./That.md), params: [WatcherDeleteWatchRequest](./WatcherDeleteWatchRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[WatcherDeleteWatchResponse](./WatcherDeleteWatchResponse.md)>;` |   || `executeWatch` | `executeWatch(this: [That](./That.md), params?: [WatcherExecuteWatchRequest](./WatcherExecuteWatchRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[WatcherExecuteWatchResponse](./WatcherExecuteWatchResponse.md)>;` | Run a watch. This API can be used to force execution of the watch outside of its triggering logic or to simulate the watch execution for debugging purposes. For testing and debugging purposes, you also have fine-grained control on how the watch runs. You can run the watch without running all of its actions or alternatively by simulating them. You can also force execution by ignoring the watch condition and control whether a watch record would be written to the watch history after it runs. You can use the run watch API to run watches that are not yet registered by specifying the watch definition inline. This serves as great tool for testing and debugging your watches prior to adding them to Watcher. When Elasticsearch security features are enabled on your cluster, watches are run with the privileges of the user that stored the watches. If your user is allowed to read index `a`, but not index `b`, then the exact same set of rules will apply during execution of a watch. When using the run watch API, the authorization data of the user that called the API will be used as a base, instead of the information who stored the watch. || `executeWatch` | `executeWatch(this: [That](./That.md), params?: [WatcherExecuteWatchRequest](./WatcherExecuteWatchRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[WatcherExecuteWatchResponse](./WatcherExecuteWatchResponse.md), unknown>>;` |   || `executeWatch` | `executeWatch(this: [That](./That.md), params?: [WatcherExecuteWatchRequest](./WatcherExecuteWatchRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[WatcherExecuteWatchResponse](./WatcherExecuteWatchResponse.md)>;` |   || `getSettings` | `getSettings(this: [That](./That.md), params?: [WatcherGetSettingsRequest](./WatcherGetSettingsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[WatcherGetSettingsResponse](./WatcherGetSettingsResponse.md)>;` | Get Watcher index settings. Get settings for the Watcher internal index ( `.watches`). Only a subset of settings are shown, for example `index.auto_expand_replicas` and `index.number_of_replicas`. || `getSettings` | `getSettings(this: [That](./That.md), params?: [WatcherGetSettingsRequest](./WatcherGetSettingsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[WatcherGetSettingsResponse](./WatcherGetSettingsResponse.md), unknown>>;` |   || `getSettings` | `getSettings(this: [That](./That.md), params?: [WatcherGetSettingsRequest](./WatcherGetSettingsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[WatcherGetSettingsResponse](./WatcherGetSettingsResponse.md)>;` |   || `getWatch` | `getWatch(this: [That](./That.md), params: [WatcherGetWatchRequest](./WatcherGetWatchRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[WatcherGetWatchResponse](./WatcherGetWatchResponse.md)>;` | Get a watch. || `getWatch` | `getWatch(this: [That](./That.md), params: [WatcherGetWatchRequest](./WatcherGetWatchRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[WatcherGetWatchResponse](./WatcherGetWatchResponse.md), unknown>>;` |   || `getWatch` | `getWatch(this: [That](./That.md), params: [WatcherGetWatchRequest](./WatcherGetWatchRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[WatcherGetWatchResponse](./WatcherGetWatchResponse.md)>;` |   || `putWatch` | `putWatch(this: [That](./That.md), params: [WatcherPutWatchRequest](./WatcherPutWatchRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[WatcherPutWatchResponse](./WatcherPutWatchResponse.md)>;` | Create or update a watch. When a watch is registered, a new document that represents the watch is added to the `.watches` index and its trigger is immediately registered with the relevant trigger engine. Typically for the `schedule` trigger, the scheduler is the trigger engine. IMPORTANT: You must use Kibana or this API to create a watch. Do not add a watch directly to the `.watches` index by using the Elasticsearch index API. If Elasticsearch security features are enabled, do not give users write privileges on the `.watches` index. When you add a watch you can also define its initial active state by setting the *active* parameter. When Elasticsearch security features are enabled, your watch can index or search only on indices for which the user that stored the watch has privileges. If the user is able to read index `a`, but not index `b`, the same will apply when the watch runs. || `putWatch` | `putWatch(this: [That](./That.md), params: [WatcherPutWatchRequest](./WatcherPutWatchRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[WatcherPutWatchResponse](./WatcherPutWatchResponse.md), unknown>>;` |   || `putWatch` | `putWatch(this: [That](./That.md), params: [WatcherPutWatchRequest](./WatcherPutWatchRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[WatcherPutWatchResponse](./WatcherPutWatchResponse.md)>;` |   || `queryWatches` | `queryWatches(this: [That](./That.md), params?: [WatcherQueryWatchesRequest](./WatcherQueryWatchesRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[WatcherQueryWatchesResponse](./WatcherQueryWatchesResponse.md)>;` | Query watches. Get all registered watches in a paginated manner and optionally filter watches by a query. Note that only the `_id` and `metadata.*` fields are queryable or sortable. || `queryWatches` | `queryWatches(this: [That](./That.md), params?: [WatcherQueryWatchesRequest](./WatcherQueryWatchesRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[WatcherQueryWatchesResponse](./WatcherQueryWatchesResponse.md), unknown>>;` |   || `queryWatches` | `queryWatches(this: [That](./That.md), params?: [WatcherQueryWatchesRequest](./WatcherQueryWatchesRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[WatcherQueryWatchesResponse](./WatcherQueryWatchesResponse.md)>;` |   || `start` | `start(this: [That](./That.md), params?: [WatcherStartRequest](./WatcherStartRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[WatcherStartResponse](./WatcherStartResponse.md)>;` | Start the watch service. Start the Watcher service if it is not already running. || `start` | `start(this: [That](./That.md), params?: [WatcherStartRequest](./WatcherStartRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[WatcherStartResponse](./WatcherStartResponse.md), unknown>>;` |   || `start` | `start(this: [That](./That.md), params?: [WatcherStartRequest](./WatcherStartRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[WatcherStartResponse](./WatcherStartResponse.md)>;` |   || `stats` | `stats(this: [That](./That.md), params?: [WatcherStatsRequest](./WatcherStatsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[WatcherStatsResponse](./WatcherStatsResponse.md)>;` | Get Watcher statistics. This API always returns basic metrics. You retrieve more metrics by using the metric parameter. || `stats` | `stats(this: [That](./That.md), params?: [WatcherStatsRequest](./WatcherStatsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[WatcherStatsResponse](./WatcherStatsResponse.md), unknown>>;` |   || `stats` | `stats(this: [That](./That.md), params?: [WatcherStatsRequest](./WatcherStatsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[WatcherStatsResponse](./WatcherStatsResponse.md)>;` |   || `stop` | `stop(this: [That](./That.md), params?: [WatcherStopRequest](./WatcherStopRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[WatcherStopResponse](./WatcherStopResponse.md)>;` | Stop the watch service. Stop the Watcher service if it is running. || `stop` | `stop(this: [That](./That.md), params?: [WatcherStopRequest](./WatcherStopRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[WatcherStopResponse](./WatcherStopResponse.md), unknown>>;` |   || `stop` | `stop(this: [That](./That.md), params?: [WatcherStopRequest](./WatcherStopRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[WatcherStopResponse](./WatcherStopResponse.md)>;` |   || `updateSettings` | `updateSettings(this: [That](./That.md), params?: [WatcherUpdateSettingsRequest](./WatcherUpdateSettingsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[WatcherUpdateSettingsResponse](./WatcherUpdateSettingsResponse.md)>;` | Update Watcher index settings. Update settings for the Watcher internal index ( `.watches`). Only a subset of settings can be modified. This includes `index.auto_expand_replicas`, `index.number_of_replicas`, `index.routing.allocation.exclude.*`, `index.routing.allocation.include.*` and `index.routing.allocation.require.*`. Modification of `index.routing.allocation.include._tier_preference` is an exception and is not allowed as the Watcher shards must always be in the `data_content` tier. || `updateSettings` | `updateSettings(this: [That](./That.md), params?: [WatcherUpdateSettingsRequest](./WatcherUpdateSettingsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[WatcherUpdateSettingsResponse](./WatcherUpdateSettingsResponse.md), unknown>>;` |   || `updateSettings` | `updateSettings(this: [That](./That.md), params?: [WatcherUpdateSettingsRequest](./WatcherUpdateSettingsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[WatcherUpdateSettingsResponse](./WatcherUpdateSettingsResponse.md)>;` |   | \ No newline at end of file diff --git a/docs/reference/api/WatcherAckWatchRequest.md b/docs/reference/api/WatcherAckWatchRequest.md new file mode 100644 index 000000000..7982abcea --- /dev/null +++ b/docs/reference/api/WatcherAckWatchRequest.md @@ -0,0 +1,8 @@ +## Interface `WatcherAckWatchRequest` + +| Name | Type | Description | +| - | - | - | +| `action_id` | [Names](./Names.md) | A comma-separated list of the action identifiers to acknowledge. If you omit this parameter, all of the actions of the watch are acknowledged. | +| `body` | string | ({ [key: string]: any; } & { watch_id?: never; action_id?: never; }) | All values in `body` will be added to the request body. | +| `querystring` | { [key: string]: any; } & { watch_id?: never; action_id?: never; } | All values in `querystring` will be added to the request querystring. | +| `watch_id` | [Name](./Name.md) | The watch identifier. | diff --git a/docs/reference/api/WatcherAckWatchResponse.md b/docs/reference/api/WatcherAckWatchResponse.md new file mode 100644 index 000000000..0b191d149 --- /dev/null +++ b/docs/reference/api/WatcherAckWatchResponse.md @@ -0,0 +1,5 @@ +## Interface `WatcherAckWatchResponse` + +| Name | Type | Description | +| - | - | - | +| `status` | [WatcherWatchStatus](./WatcherWatchStatus.md) |   | diff --git a/docs/reference/api/WatcherAcknowledgeState.md b/docs/reference/api/WatcherAcknowledgeState.md new file mode 100644 index 000000000..59e289152 --- /dev/null +++ b/docs/reference/api/WatcherAcknowledgeState.md @@ -0,0 +1,6 @@ +## Interface `WatcherAcknowledgeState` + +| Name | Type | Description | +| - | - | - | +| `state` | [WatcherAcknowledgementOptions](./WatcherAcknowledgementOptions.md) |   | +| `timestamp` | [DateTime](./DateTime.md) |   | diff --git a/docs/reference/api/WatcherAcknowledgementOptions.md b/docs/reference/api/WatcherAcknowledgementOptions.md new file mode 100644 index 000000000..544627af8 --- /dev/null +++ b/docs/reference/api/WatcherAcknowledgementOptions.md @@ -0,0 +1,4 @@ +## `WatcherAcknowledgementOptions` +::: +type WatcherAcknowledgementOptions = 'awaits_successful_execution' | 'ackable' | 'acked'; +::: diff --git a/docs/reference/api/WatcherAction.md b/docs/reference/api/WatcherAction.md new file mode 100644 index 000000000..46dce2148 --- /dev/null +++ b/docs/reference/api/WatcherAction.md @@ -0,0 +1,18 @@ +## Interface `WatcherAction` + +| Name | Type | Description | +| - | - | - | +| `action_type` | [WatcherActionType](./WatcherActionType.md) |   | +| `condition` | [WatcherConditionContainer](./WatcherConditionContainer.md) |   | +| `email` | [WatcherEmailAction](./WatcherEmailAction.md) |   | +| `foreach` | string |   | +| `index` | [WatcherIndexAction](./WatcherIndexAction.md) |   | +| `logging` | [WatcherLoggingAction](./WatcherLoggingAction.md) |   | +| `max_iterations` | [integer](./integer.md) |   | +| `name` | [Name](./Name.md) |   | +| `pagerduty` | [WatcherPagerDutyAction](./WatcherPagerDutyAction.md) |   | +| `slack` | [WatcherSlackAction](./WatcherSlackAction.md) |   | +| `throttle_period_in_millis` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> |   | +| `throttle_period` | [Duration](./Duration.md) |   | +| `transform` | [TransformContainer](./TransformContainer.md) |   | +| `webhook` | [WatcherWebhookAction](./WatcherWebhookAction.md) |   | diff --git a/docs/reference/api/WatcherActionExecutionMode.md b/docs/reference/api/WatcherActionExecutionMode.md new file mode 100644 index 000000000..6a6d9422e --- /dev/null +++ b/docs/reference/api/WatcherActionExecutionMode.md @@ -0,0 +1,4 @@ +## `WatcherActionExecutionMode` +::: +type WatcherActionExecutionMode = 'simulate' | 'force_simulate' | 'execute' | 'force_execute' | 'skip'; +::: diff --git a/docs/reference/api/WatcherActionStatus.md b/docs/reference/api/WatcherActionStatus.md new file mode 100644 index 000000000..b02ac21e9 --- /dev/null +++ b/docs/reference/api/WatcherActionStatus.md @@ -0,0 +1,8 @@ +## Interface `WatcherActionStatus` + +| Name | Type | Description | +| - | - | - | +| `ack` | [WatcherAcknowledgeState](./WatcherAcknowledgeState.md) |   | +| `last_execution` | [WatcherExecutionState](./WatcherExecutionState.md) |   | +| `last_successful_execution` | [WatcherExecutionState](./WatcherExecutionState.md) |   | +| `last_throttle` | [WatcherThrottleState](./WatcherThrottleState.md) |   | diff --git a/docs/reference/api/WatcherActionStatusOptions.md b/docs/reference/api/WatcherActionStatusOptions.md new file mode 100644 index 000000000..af5fbc36b --- /dev/null +++ b/docs/reference/api/WatcherActionStatusOptions.md @@ -0,0 +1,4 @@ +## `WatcherActionStatusOptions` +::: +type WatcherActionStatusOptions = 'success' | 'failure' | 'simulated' | 'throttled'; +::: diff --git a/docs/reference/api/WatcherActionType.md b/docs/reference/api/WatcherActionType.md new file mode 100644 index 000000000..63c07c82e --- /dev/null +++ b/docs/reference/api/WatcherActionType.md @@ -0,0 +1,4 @@ +## `WatcherActionType` +::: +type WatcherActionType = 'email' | 'webhook' | 'index' | 'logging' | 'slack' | 'pagerduty'; +::: diff --git a/docs/reference/api/WatcherActions.md b/docs/reference/api/WatcherActions.md new file mode 100644 index 000000000..ce9c11f03 --- /dev/null +++ b/docs/reference/api/WatcherActions.md @@ -0,0 +1,4 @@ +## `WatcherActions` +::: +type WatcherActions = Record<[IndexName](./IndexName.md), [WatcherActionStatus](./WatcherActionStatus.md)>; +::: diff --git a/docs/reference/api/WatcherActivateWatchRequest.md b/docs/reference/api/WatcherActivateWatchRequest.md new file mode 100644 index 000000000..09bf48492 --- /dev/null +++ b/docs/reference/api/WatcherActivateWatchRequest.md @@ -0,0 +1,7 @@ +## Interface `WatcherActivateWatchRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { watch_id?: never; }) | All values in `body` will be added to the request body. | +| `querystring` | { [key: string]: any; } & { watch_id?: never; } | All values in `querystring` will be added to the request querystring. | +| `watch_id` | [Name](./Name.md) | The watch identifier. | diff --git a/docs/reference/api/WatcherActivateWatchResponse.md b/docs/reference/api/WatcherActivateWatchResponse.md new file mode 100644 index 000000000..d8e4cebf7 --- /dev/null +++ b/docs/reference/api/WatcherActivateWatchResponse.md @@ -0,0 +1,5 @@ +## Interface `WatcherActivateWatchResponse` + +| Name | Type | Description | +| - | - | - | +| `status` | [WatcherActivationStatus](./WatcherActivationStatus.md) |   | diff --git a/docs/reference/api/WatcherActivationState.md b/docs/reference/api/WatcherActivationState.md new file mode 100644 index 000000000..10d106986 --- /dev/null +++ b/docs/reference/api/WatcherActivationState.md @@ -0,0 +1,6 @@ +## Interface `WatcherActivationState` + +| Name | Type | Description | +| - | - | - | +| `active` | boolean |   | +| `timestamp` | [DateTime](./DateTime.md) |   | diff --git a/docs/reference/api/WatcherActivationStatus.md b/docs/reference/api/WatcherActivationStatus.md new file mode 100644 index 000000000..661bcbaf9 --- /dev/null +++ b/docs/reference/api/WatcherActivationStatus.md @@ -0,0 +1,7 @@ +## Interface `WatcherActivationStatus` + +| Name | Type | Description | +| - | - | - | +| `actions` | [WatcherActions](./WatcherActions.md) |   | +| `state` | [WatcherActivationState](./WatcherActivationState.md) |   | +| `version` | [VersionNumber](./VersionNumber.md) |   | diff --git a/docs/reference/api/WatcherAlwaysCondition.md b/docs/reference/api/WatcherAlwaysCondition.md new file mode 100644 index 000000000..f7400bad1 --- /dev/null +++ b/docs/reference/api/WatcherAlwaysCondition.md @@ -0,0 +1,4 @@ +## Interface `WatcherAlwaysCondition` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/WatcherArrayCompareCondition.md b/docs/reference/api/WatcherArrayCompareCondition.md new file mode 100644 index 000000000..ed3c903e0 --- /dev/null +++ b/docs/reference/api/WatcherArrayCompareCondition.md @@ -0,0 +1,4 @@ +## `WatcherArrayCompareCondition` +::: +type WatcherArrayCompareCondition = [WatcherArrayCompareConditionKeys](./WatcherArrayCompareConditionKeys.md) & { [property: string]: [WatcherArrayCompareOpParams](./WatcherArrayCompareOpParams.md) | string;}; +::: diff --git a/docs/reference/api/WatcherArrayCompareConditionKeys.md b/docs/reference/api/WatcherArrayCompareConditionKeys.md new file mode 100644 index 000000000..d7a832429 --- /dev/null +++ b/docs/reference/api/WatcherArrayCompareConditionKeys.md @@ -0,0 +1,5 @@ +## Interface `WatcherArrayCompareConditionKeys` + +| Name | Type | Description | +| - | - | - | +| `path` | string |   | diff --git a/docs/reference/api/WatcherArrayCompareOpParams.md b/docs/reference/api/WatcherArrayCompareOpParams.md new file mode 100644 index 000000000..58196e345 --- /dev/null +++ b/docs/reference/api/WatcherArrayCompareOpParams.md @@ -0,0 +1,6 @@ +## Interface `WatcherArrayCompareOpParams` + +| Name | Type | Description | +| - | - | - | +| `quantifier` | [WatcherQuantifier](./WatcherQuantifier.md) |   | +| `value` | [FieldValue](./FieldValue.md) |   | diff --git a/docs/reference/api/WatcherChainInput.md b/docs/reference/api/WatcherChainInput.md new file mode 100644 index 000000000..866f8e4d2 --- /dev/null +++ b/docs/reference/api/WatcherChainInput.md @@ -0,0 +1,5 @@ +## Interface `WatcherChainInput` + +| Name | Type | Description | +| - | - | - | +| `inputs` | [Partial](./Partial.md)>[] |   | diff --git a/docs/reference/api/WatcherConditionContainer.md b/docs/reference/api/WatcherConditionContainer.md new file mode 100644 index 000000000..7b2e5a7c8 --- /dev/null +++ b/docs/reference/api/WatcherConditionContainer.md @@ -0,0 +1,9 @@ +## Interface `WatcherConditionContainer` + +| Name | Type | Description | +| - | - | - | +| `always` | [WatcherAlwaysCondition](./WatcherAlwaysCondition.md) |   | +| `array_compare` | [Partial](./Partial.md)> |   | +| `compare` | [Partial](./Partial.md)>>> |   | +| `never` | [WatcherNeverCondition](./WatcherNeverCondition.md) |   | +| `script` | [WatcherScriptCondition](./WatcherScriptCondition.md) |   | diff --git a/docs/reference/api/WatcherConditionOp.md b/docs/reference/api/WatcherConditionOp.md new file mode 100644 index 000000000..f2a1fe72b --- /dev/null +++ b/docs/reference/api/WatcherConditionOp.md @@ -0,0 +1,4 @@ +## `WatcherConditionOp` +::: +type WatcherConditionOp = 'not_eq' | 'eq' | 'lt' | 'gt' | 'lte' | 'gte'; +::: diff --git a/docs/reference/api/WatcherConditionType.md b/docs/reference/api/WatcherConditionType.md new file mode 100644 index 000000000..8c1af4841 --- /dev/null +++ b/docs/reference/api/WatcherConditionType.md @@ -0,0 +1,4 @@ +## `WatcherConditionType` +::: +type WatcherConditionType = 'always' | 'never' | 'script' | 'compare' | 'array_compare'; +::: diff --git a/docs/reference/api/WatcherConnectionScheme.md b/docs/reference/api/WatcherConnectionScheme.md new file mode 100644 index 000000000..97381c663 --- /dev/null +++ b/docs/reference/api/WatcherConnectionScheme.md @@ -0,0 +1,4 @@ +## `WatcherConnectionScheme` +::: +type WatcherConnectionScheme = 'http' | 'https'; +::: diff --git a/docs/reference/api/WatcherCronExpression.md b/docs/reference/api/WatcherCronExpression.md new file mode 100644 index 000000000..b0c27e2ab --- /dev/null +++ b/docs/reference/api/WatcherCronExpression.md @@ -0,0 +1,4 @@ +## `WatcherCronExpression` +::: +type WatcherCronExpression = string; +::: diff --git a/docs/reference/api/WatcherDailySchedule.md b/docs/reference/api/WatcherDailySchedule.md new file mode 100644 index 000000000..83916f455 --- /dev/null +++ b/docs/reference/api/WatcherDailySchedule.md @@ -0,0 +1,5 @@ +## Interface `WatcherDailySchedule` + +| Name | Type | Description | +| - | - | - | +| `at` | [WatcherScheduleTimeOfDay](./WatcherScheduleTimeOfDay.md)[] |   | diff --git a/docs/reference/api/WatcherDataAttachmentFormat.md b/docs/reference/api/WatcherDataAttachmentFormat.md new file mode 100644 index 000000000..6ce7344bb --- /dev/null +++ b/docs/reference/api/WatcherDataAttachmentFormat.md @@ -0,0 +1,4 @@ +## `WatcherDataAttachmentFormat` +::: +type WatcherDataAttachmentFormat = 'json' | 'yaml'; +::: diff --git a/docs/reference/api/WatcherDataEmailAttachment.md b/docs/reference/api/WatcherDataEmailAttachment.md new file mode 100644 index 000000000..7bb82ae7b --- /dev/null +++ b/docs/reference/api/WatcherDataEmailAttachment.md @@ -0,0 +1,5 @@ +## Interface `WatcherDataEmailAttachment` + +| Name | Type | Description | +| - | - | - | +| `format` | [WatcherDataAttachmentFormat](./WatcherDataAttachmentFormat.md) |   | diff --git a/docs/reference/api/WatcherDay.md b/docs/reference/api/WatcherDay.md new file mode 100644 index 000000000..58f73a288 --- /dev/null +++ b/docs/reference/api/WatcherDay.md @@ -0,0 +1,4 @@ +## `WatcherDay` +::: +type WatcherDay = 'sunday' | 'monday' | 'tuesday' | 'wednesday' | 'thursday' | 'friday' | 'saturday'; +::: diff --git a/docs/reference/api/WatcherDeactivateWatchRequest.md b/docs/reference/api/WatcherDeactivateWatchRequest.md new file mode 100644 index 000000000..c18d63aba --- /dev/null +++ b/docs/reference/api/WatcherDeactivateWatchRequest.md @@ -0,0 +1,7 @@ +## Interface `WatcherDeactivateWatchRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { watch_id?: never; }) | All values in `body` will be added to the request body. | +| `querystring` | { [key: string]: any; } & { watch_id?: never; } | All values in `querystring` will be added to the request querystring. | +| `watch_id` | [Name](./Name.md) | The watch identifier. | diff --git a/docs/reference/api/WatcherDeactivateWatchResponse.md b/docs/reference/api/WatcherDeactivateWatchResponse.md new file mode 100644 index 000000000..3ea7cda92 --- /dev/null +++ b/docs/reference/api/WatcherDeactivateWatchResponse.md @@ -0,0 +1,5 @@ +## Interface `WatcherDeactivateWatchResponse` + +| Name | Type | Description | +| - | - | - | +| `status` | [WatcherActivationStatus](./WatcherActivationStatus.md) |   | diff --git a/docs/reference/api/WatcherDeleteWatchRequest.md b/docs/reference/api/WatcherDeleteWatchRequest.md new file mode 100644 index 000000000..14dd55c5d --- /dev/null +++ b/docs/reference/api/WatcherDeleteWatchRequest.md @@ -0,0 +1,7 @@ +## Interface `WatcherDeleteWatchRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { id?: never; }) | All values in `body` will be added to the request body. | +| `id` | [Name](./Name.md) | The watch identifier. | +| `querystring` | { [key: string]: any; } & { id?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/WatcherDeleteWatchResponse.md b/docs/reference/api/WatcherDeleteWatchResponse.md new file mode 100644 index 000000000..9b3921fb1 --- /dev/null +++ b/docs/reference/api/WatcherDeleteWatchResponse.md @@ -0,0 +1,7 @@ +## Interface `WatcherDeleteWatchResponse` + +| Name | Type | Description | +| - | - | - | +| `_id` | [Id](./Id.md) |   | +| `_version` | [VersionNumber](./VersionNumber.md) |   | +| `found` | boolean |   | diff --git a/docs/reference/api/WatcherEmail.md b/docs/reference/api/WatcherEmail.md new file mode 100644 index 000000000..d84643c5f --- /dev/null +++ b/docs/reference/api/WatcherEmail.md @@ -0,0 +1,15 @@ +## Interface `WatcherEmail` + +| Name | Type | Description | +| - | - | - | +| `attachments` | Record |   | +| `bcc` | string | string[] |   | +| `body` | [WatcherEmailBody](./WatcherEmailBody.md) |   | +| `cc` | string | string[] |   | +| `from` | string |   | +| `id` | [Id](./Id.md) |   | +| `priority` | [WatcherEmailPriority](./WatcherEmailPriority.md) |   | +| `reply_to` | string | string[] |   | +| `sent_date` | [DateTime](./DateTime.md) |   | +| `subject` | string |   | +| `to` | string | string[] |   | diff --git a/docs/reference/api/WatcherEmailAction.md b/docs/reference/api/WatcherEmailAction.md new file mode 100644 index 000000000..cdefcbf01 --- /dev/null +++ b/docs/reference/api/WatcherEmailAction.md @@ -0,0 +1,4 @@ +## Interface `WatcherEmailAction` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/WatcherEmailAttachmentContainer.md b/docs/reference/api/WatcherEmailAttachmentContainer.md new file mode 100644 index 000000000..81dd75b5d --- /dev/null +++ b/docs/reference/api/WatcherEmailAttachmentContainer.md @@ -0,0 +1,7 @@ +## Interface `WatcherEmailAttachmentContainer` + +| Name | Type | Description | +| - | - | - | +| `data` | [WatcherDataEmailAttachment](./WatcherDataEmailAttachment.md) |   | +| `http` | [WatcherHttpEmailAttachment](./WatcherHttpEmailAttachment.md) |   | +| `reporting` | [WatcherReportingEmailAttachment](./WatcherReportingEmailAttachment.md) |   | diff --git a/docs/reference/api/WatcherEmailBody.md b/docs/reference/api/WatcherEmailBody.md new file mode 100644 index 000000000..b8ba7cdc8 --- /dev/null +++ b/docs/reference/api/WatcherEmailBody.md @@ -0,0 +1,6 @@ +## Interface `WatcherEmailBody` + +| Name | Type | Description | +| - | - | - | +| `html` | string |   | +| `text` | string |   | diff --git a/docs/reference/api/WatcherEmailPriority.md b/docs/reference/api/WatcherEmailPriority.md new file mode 100644 index 000000000..4414c2f58 --- /dev/null +++ b/docs/reference/api/WatcherEmailPriority.md @@ -0,0 +1,4 @@ +## `WatcherEmailPriority` +::: +type WatcherEmailPriority = 'lowest' | 'low' | 'normal' | 'high' | 'highest'; +::: diff --git a/docs/reference/api/WatcherEmailResult.md b/docs/reference/api/WatcherEmailResult.md new file mode 100644 index 000000000..30d620807 --- /dev/null +++ b/docs/reference/api/WatcherEmailResult.md @@ -0,0 +1,7 @@ +## Interface `WatcherEmailResult` + +| Name | Type | Description | +| - | - | - | +| `account` | string |   | +| `message` | [WatcherEmail](./WatcherEmail.md) |   | +| `reason` | string |   | diff --git a/docs/reference/api/WatcherExecuteWatchRequest.md b/docs/reference/api/WatcherExecuteWatchRequest.md new file mode 100644 index 000000000..760e1da3c --- /dev/null +++ b/docs/reference/api/WatcherExecuteWatchRequest.md @@ -0,0 +1,15 @@ +## Interface `WatcherExecuteWatchRequest` + +| Name | Type | Description | +| - | - | - | +| `action_modes` | Record | Determines how to handle the watch actions as part of the watch execution. | +| `alternative_input` | Record | When present, the watch uses this object as a payload instead of executing its own input. | +| `body` | string | ({ [key: string]: any; } & { id?: never; debug?: never; action_modes?: never; alternative_input?: never; ignore_condition?: never; record_execution?: never; simulated_actions?: never; trigger_data?: never; watch?: never; }) | All values in `body` will be added to the request body. | +| `debug` | boolean | Defines whether the watch runs in debug mode. | +| `id` | [Id](./Id.md) | The watch identifier. | +| `ignore_condition` | boolean | When set to `true`, the watch execution uses the always condition. This can also be specified as an HTTP parameter. | +| `querystring` | { [key: string]: any; } & { id?: never; debug?: never; action_modes?: never; alternative_input?: never; ignore_condition?: never; record_execution?: never; simulated_actions?: never; trigger_data?: never; watch?: never; } | All values in `querystring` will be added to the request querystring. | +| `record_execution` | boolean | When set to `true`, the watch record representing the watch execution result is persisted to the `.watcher-history` index for the current time. In addition, the status of the watch is updated, possibly throttling subsequent runs. This can also be specified as an HTTP parameter. | +| `simulated_actions` | [WatcherSimulatedActions](./WatcherSimulatedActions.md) |   | +| `trigger_data` | [WatcherScheduleTriggerEvent](./WatcherScheduleTriggerEvent.md) | This structure is parsed as the data of the trigger event that will be used during the watch execution. | +| `watch` | [WatcherWatch](./WatcherWatch.md) | When present, this watch is used instead of the one specified in the request. This watch is not persisted to the index and `record_execution` cannot be set. | diff --git a/docs/reference/api/WatcherExecuteWatchResponse.md b/docs/reference/api/WatcherExecuteWatchResponse.md new file mode 100644 index 000000000..5ccdf9432 --- /dev/null +++ b/docs/reference/api/WatcherExecuteWatchResponse.md @@ -0,0 +1,6 @@ +## Interface `WatcherExecuteWatchResponse` + +| Name | Type | Description | +| - | - | - | +| `_id` | [Id](./Id.md) | The watch record identifier as it would be stored in the `.watcher-history` index. | +| `watch_record` | [WatcherExecuteWatchWatchRecord](./WatcherExecuteWatchWatchRecord.md) | The watch record document as it would be stored in the `.watcher-history` index. | diff --git a/docs/reference/api/WatcherExecuteWatchWatchRecord.md b/docs/reference/api/WatcherExecuteWatchWatchRecord.md new file mode 100644 index 000000000..05908f07f --- /dev/null +++ b/docs/reference/api/WatcherExecuteWatchWatchRecord.md @@ -0,0 +1,15 @@ +## Interface `WatcherExecuteWatchWatchRecord` + +| Name | Type | Description | +| - | - | - | +| `condition` | [WatcherConditionContainer](./WatcherConditionContainer.md) |   | +| `input` | [WatcherInputContainer](./WatcherInputContainer.md) |   | +| `messages` | string[] |   | +| `metadata` | [Metadata](./Metadata.md) |   | +| `node` | string |   | +| `result` | [WatcherExecutionResult](./WatcherExecutionResult.md) |   | +| `state` | [WatcherExecutionStatus](./WatcherExecutionStatus.md) |   | +| `status` | [WatcherWatchStatus](./WatcherWatchStatus.md) |   | +| `trigger_event` | [WatcherTriggerEventResult](./WatcherTriggerEventResult.md) |   | +| `user` | [Username](./Username.md) |   | +| `watch_id` | [Id](./Id.md) |   | diff --git a/docs/reference/api/WatcherExecutionPhase.md b/docs/reference/api/WatcherExecutionPhase.md new file mode 100644 index 000000000..e0c4c2ae8 --- /dev/null +++ b/docs/reference/api/WatcherExecutionPhase.md @@ -0,0 +1,4 @@ +## `WatcherExecutionPhase` +::: +type WatcherExecutionPhase = 'awaits_execution' | 'started' | 'input' | 'condition' | 'actions' | 'watch_transform' | 'aborted' | 'finished'; +::: diff --git a/docs/reference/api/WatcherExecutionResult.md b/docs/reference/api/WatcherExecutionResult.md new file mode 100644 index 000000000..595d381a2 --- /dev/null +++ b/docs/reference/api/WatcherExecutionResult.md @@ -0,0 +1,9 @@ +## Interface `WatcherExecutionResult` + +| Name | Type | Description | +| - | - | - | +| `actions` | [WatcherExecutionResultAction](./WatcherExecutionResultAction.md)[] |   | +| `condition` | [WatcherExecutionResultCondition](./WatcherExecutionResultCondition.md) |   | +| `execution_duration` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> |   | +| `execution_time` | [DateTime](./DateTime.md) |   | +| `input` | [WatcherExecutionResultInput](./WatcherExecutionResultInput.md) |   | diff --git a/docs/reference/api/WatcherExecutionResultAction.md b/docs/reference/api/WatcherExecutionResultAction.md new file mode 100644 index 000000000..d331c5610 --- /dev/null +++ b/docs/reference/api/WatcherExecutionResultAction.md @@ -0,0 +1,15 @@ +## Interface `WatcherExecutionResultAction` + +| Name | Type | Description | +| - | - | - | +| `email` | [WatcherEmailResult](./WatcherEmailResult.md) |   | +| `error` | [ErrorCause](./ErrorCause.md) |   | +| `id` | [Id](./Id.md) |   | +| `index` | [WatcherIndexResult](./WatcherIndexResult.md) |   | +| `logging` | [WatcherLoggingResult](./WatcherLoggingResult.md) |   | +| `pagerduty` | [WatcherPagerDutyResult](./WatcherPagerDutyResult.md) |   | +| `reason` | string |   | +| `slack` | [WatcherSlackResult](./WatcherSlackResult.md) |   | +| `status` | [WatcherActionStatusOptions](./WatcherActionStatusOptions.md) |   | +| `type` | [WatcherActionType](./WatcherActionType.md) |   | +| `webhook` | [WatcherWebhookResult](./WatcherWebhookResult.md) |   | diff --git a/docs/reference/api/WatcherExecutionResultCondition.md b/docs/reference/api/WatcherExecutionResultCondition.md new file mode 100644 index 000000000..88762d02d --- /dev/null +++ b/docs/reference/api/WatcherExecutionResultCondition.md @@ -0,0 +1,7 @@ +## Interface `WatcherExecutionResultCondition` + +| Name | Type | Description | +| - | - | - | +| `met` | boolean |   | +| `status` | [WatcherActionStatusOptions](./WatcherActionStatusOptions.md) |   | +| `type` | [WatcherConditionType](./WatcherConditionType.md) |   | diff --git a/docs/reference/api/WatcherExecutionResultInput.md b/docs/reference/api/WatcherExecutionResultInput.md new file mode 100644 index 000000000..b93fb8a2e --- /dev/null +++ b/docs/reference/api/WatcherExecutionResultInput.md @@ -0,0 +1,7 @@ +## Interface `WatcherExecutionResultInput` + +| Name | Type | Description | +| - | - | - | +| `payload` | Record |   | +| `status` | [WatcherActionStatusOptions](./WatcherActionStatusOptions.md) |   | +| `type` | [WatcherInputType](./WatcherInputType.md) |   | diff --git a/docs/reference/api/WatcherExecutionState.md b/docs/reference/api/WatcherExecutionState.md new file mode 100644 index 000000000..c12b19cd7 --- /dev/null +++ b/docs/reference/api/WatcherExecutionState.md @@ -0,0 +1,7 @@ +## Interface `WatcherExecutionState` + +| Name | Type | Description | +| - | - | - | +| `reason` | string |   | +| `successful` | boolean |   | +| `timestamp` | [DateTime](./DateTime.md) |   | diff --git a/docs/reference/api/WatcherExecutionStatus.md b/docs/reference/api/WatcherExecutionStatus.md new file mode 100644 index 000000000..dadac069a --- /dev/null +++ b/docs/reference/api/WatcherExecutionStatus.md @@ -0,0 +1,4 @@ +## `WatcherExecutionStatus` +::: +type WatcherExecutionStatus = 'awaits_execution' | 'checking' | 'execution_not_needed' | 'throttled' | 'executed' | 'failed' | 'deleted_while_queued' | 'not_executed_already_queued'; +::: diff --git a/docs/reference/api/WatcherExecutionThreadPool.md b/docs/reference/api/WatcherExecutionThreadPool.md new file mode 100644 index 000000000..738de21d3 --- /dev/null +++ b/docs/reference/api/WatcherExecutionThreadPool.md @@ -0,0 +1,6 @@ +## Interface `WatcherExecutionThreadPool` + +| Name | Type | Description | +| - | - | - | +| `max_size` | [long](./long.md) | The largest size of the execution thread pool, which indicates the largest number of concurrent running watches. | +| `queue_size` | [long](./long.md) | The number of watches that were triggered and are currently queued. | diff --git a/docs/reference/api/WatcherGetSettingsRequest.md b/docs/reference/api/WatcherGetSettingsRequest.md new file mode 100644 index 000000000..84cccfb56 --- /dev/null +++ b/docs/reference/api/WatcherGetSettingsRequest.md @@ -0,0 +1,7 @@ +## Interface `WatcherGetSettingsRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { master_timeout?: never; }) | All values in `body` will be added to the request body. | +| `master_timeout` | [Duration](./Duration.md) | The period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. | +| `querystring` | { [key: string]: any; } & { master_timeout?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/WatcherGetSettingsResponse.md b/docs/reference/api/WatcherGetSettingsResponse.md new file mode 100644 index 000000000..e37849e87 --- /dev/null +++ b/docs/reference/api/WatcherGetSettingsResponse.md @@ -0,0 +1,5 @@ +## Interface `WatcherGetSettingsResponse` + +| Name | Type | Description | +| - | - | - | +| `index` | [IndicesIndexSettings](./IndicesIndexSettings.md) |   | diff --git a/docs/reference/api/WatcherGetWatchRequest.md b/docs/reference/api/WatcherGetWatchRequest.md new file mode 100644 index 000000000..fe938c739 --- /dev/null +++ b/docs/reference/api/WatcherGetWatchRequest.md @@ -0,0 +1,7 @@ +## Interface `WatcherGetWatchRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { id?: never; }) | All values in `body` will be added to the request body. | +| `id` | [Name](./Name.md) | The watch identifier. | +| `querystring` | { [key: string]: any; } & { id?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/WatcherGetWatchResponse.md b/docs/reference/api/WatcherGetWatchResponse.md new file mode 100644 index 000000000..72aa9f864 --- /dev/null +++ b/docs/reference/api/WatcherGetWatchResponse.md @@ -0,0 +1,11 @@ +## Interface `WatcherGetWatchResponse` + +| Name | Type | Description | +| - | - | - | +| `_id` | [Id](./Id.md) |   | +| `_primary_term` | [integer](./integer.md) |   | +| `_seq_no` | [SequenceNumber](./SequenceNumber.md) |   | +| `_version` | [VersionNumber](./VersionNumber.md) |   | +| `found` | boolean |   | +| `status` | [WatcherWatchStatus](./WatcherWatchStatus.md) |   | +| `watch` | [WatcherWatch](./WatcherWatch.md) |   | diff --git a/docs/reference/api/WatcherHourAndMinute.md b/docs/reference/api/WatcherHourAndMinute.md new file mode 100644 index 000000000..6028e0f9b --- /dev/null +++ b/docs/reference/api/WatcherHourAndMinute.md @@ -0,0 +1,6 @@ +## Interface `WatcherHourAndMinute` + +| Name | Type | Description | +| - | - | - | +| `hour` | [integer](./integer.md)[] |   | +| `minute` | [integer](./integer.md)[] |   | diff --git a/docs/reference/api/WatcherHourlySchedule.md b/docs/reference/api/WatcherHourlySchedule.md new file mode 100644 index 000000000..37002356e --- /dev/null +++ b/docs/reference/api/WatcherHourlySchedule.md @@ -0,0 +1,5 @@ +## Interface `WatcherHourlySchedule` + +| Name | Type | Description | +| - | - | - | +| `minute` | [integer](./integer.md)[] |   | diff --git a/docs/reference/api/WatcherHttpEmailAttachment.md b/docs/reference/api/WatcherHttpEmailAttachment.md new file mode 100644 index 000000000..1c7bad572 --- /dev/null +++ b/docs/reference/api/WatcherHttpEmailAttachment.md @@ -0,0 +1,7 @@ +## Interface `WatcherHttpEmailAttachment` + +| Name | Type | Description | +| - | - | - | +| `content_type` | string |   | +| `inline` | boolean |   | +| `request` | [WatcherHttpInputRequestDefinition](./WatcherHttpInputRequestDefinition.md) |   | diff --git a/docs/reference/api/WatcherHttpInput.md b/docs/reference/api/WatcherHttpInput.md new file mode 100644 index 000000000..0806fe124 --- /dev/null +++ b/docs/reference/api/WatcherHttpInput.md @@ -0,0 +1,7 @@ +## Interface `WatcherHttpInput` + +| Name | Type | Description | +| - | - | - | +| `extract` | string[] |   | +| `request` | [WatcherHttpInputRequestDefinition](./WatcherHttpInputRequestDefinition.md) |   | +| `response_content_type` | [WatcherResponseContentType](./WatcherResponseContentType.md) |   | diff --git a/docs/reference/api/WatcherHttpInputAuthentication.md b/docs/reference/api/WatcherHttpInputAuthentication.md new file mode 100644 index 000000000..3e0727ee5 --- /dev/null +++ b/docs/reference/api/WatcherHttpInputAuthentication.md @@ -0,0 +1,5 @@ +## Interface `WatcherHttpInputAuthentication` + +| Name | Type | Description | +| - | - | - | +| `basic` | [WatcherHttpInputBasicAuthentication](./WatcherHttpInputBasicAuthentication.md) |   | diff --git a/docs/reference/api/WatcherHttpInputBasicAuthentication.md b/docs/reference/api/WatcherHttpInputBasicAuthentication.md new file mode 100644 index 000000000..2b15ebaa5 --- /dev/null +++ b/docs/reference/api/WatcherHttpInputBasicAuthentication.md @@ -0,0 +1,6 @@ +## Interface `WatcherHttpInputBasicAuthentication` + +| Name | Type | Description | +| - | - | - | +| `password` | [Password](./Password.md) |   | +| `username` | [Username](./Username.md) |   | diff --git a/docs/reference/api/WatcherHttpInputMethod.md b/docs/reference/api/WatcherHttpInputMethod.md new file mode 100644 index 000000000..9a7acc1c7 --- /dev/null +++ b/docs/reference/api/WatcherHttpInputMethod.md @@ -0,0 +1,4 @@ +## `WatcherHttpInputMethod` +::: +type WatcherHttpInputMethod = 'head' | 'get' | 'post' | 'put' | 'delete'; +::: diff --git a/docs/reference/api/WatcherHttpInputProxy.md b/docs/reference/api/WatcherHttpInputProxy.md new file mode 100644 index 000000000..9b446d386 --- /dev/null +++ b/docs/reference/api/WatcherHttpInputProxy.md @@ -0,0 +1,6 @@ +## Interface `WatcherHttpInputProxy` + +| Name | Type | Description | +| - | - | - | +| `host` | [Host](./Host.md) |   | +| `port` | [uint](./uint.md) |   | diff --git a/docs/reference/api/WatcherHttpInputRequestDefinition.md b/docs/reference/api/WatcherHttpInputRequestDefinition.md new file mode 100644 index 000000000..125b249dc --- /dev/null +++ b/docs/reference/api/WatcherHttpInputRequestDefinition.md @@ -0,0 +1,17 @@ +## Interface `WatcherHttpInputRequestDefinition` + +| Name | Type | Description | +| - | - | - | +| `auth` | [WatcherHttpInputAuthentication](./WatcherHttpInputAuthentication.md) |   | +| `body` | string |   | +| `connection_timeout` | [Duration](./Duration.md) |   | +| `headers` | Record |   | +| `host` | [Host](./Host.md) |   | +| `method` | [WatcherHttpInputMethod](./WatcherHttpInputMethod.md) |   | +| `params` | Record |   | +| `path` | string |   | +| `port` | [uint](./uint.md) |   | +| `proxy` | [WatcherHttpInputProxy](./WatcherHttpInputProxy.md) |   | +| `read_timeout` | [Duration](./Duration.md) |   | +| `scheme` | [WatcherConnectionScheme](./WatcherConnectionScheme.md) |   | +| `url` | string |   | diff --git a/docs/reference/api/WatcherHttpInputRequestResult.md b/docs/reference/api/WatcherHttpInputRequestResult.md new file mode 100644 index 000000000..39e08def2 --- /dev/null +++ b/docs/reference/api/WatcherHttpInputRequestResult.md @@ -0,0 +1,4 @@ +## Interface `WatcherHttpInputRequestResult` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/WatcherHttpInputResponseResult.md b/docs/reference/api/WatcherHttpInputResponseResult.md new file mode 100644 index 000000000..9d53171bc --- /dev/null +++ b/docs/reference/api/WatcherHttpInputResponseResult.md @@ -0,0 +1,7 @@ +## Interface `WatcherHttpInputResponseResult` + +| Name | Type | Description | +| - | - | - | +| `body` | string |   | +| `headers` | [HttpHeaders](./HttpHeaders.md) |   | +| `status` | [integer](./integer.md) |   | diff --git a/docs/reference/api/WatcherIndexAction.md b/docs/reference/api/WatcherIndexAction.md new file mode 100644 index 000000000..39d19cba1 --- /dev/null +++ b/docs/reference/api/WatcherIndexAction.md @@ -0,0 +1,10 @@ +## Interface `WatcherIndexAction` + +| Name | Type | Description | +| - | - | - | +| `doc_id` | [Id](./Id.md) |   | +| `execution_time_field` | [Field](./Field.md) |   | +| `index` | [IndexName](./IndexName.md) |   | +| `op_type` | [OpType](./OpType.md) |   | +| `refresh` | [Refresh](./Refresh.md) |   | +| `timeout` | [Duration](./Duration.md) |   | diff --git a/docs/reference/api/WatcherIndexResult.md b/docs/reference/api/WatcherIndexResult.md new file mode 100644 index 000000000..40138e0b6 --- /dev/null +++ b/docs/reference/api/WatcherIndexResult.md @@ -0,0 +1,5 @@ +## Interface `WatcherIndexResult` + +| Name | Type | Description | +| - | - | - | +| `response` | [WatcherIndexResultSummary](./WatcherIndexResultSummary.md) |   | diff --git a/docs/reference/api/WatcherIndexResultSummary.md b/docs/reference/api/WatcherIndexResultSummary.md new file mode 100644 index 000000000..e1e903c3e --- /dev/null +++ b/docs/reference/api/WatcherIndexResultSummary.md @@ -0,0 +1,9 @@ +## Interface `WatcherIndexResultSummary` + +| Name | Type | Description | +| - | - | - | +| `created` | boolean |   | +| `id` | [Id](./Id.md) |   | +| `index` | [IndexName](./IndexName.md) |   | +| `result` | [Result](./Result.md) |   | +| `version` | [VersionNumber](./VersionNumber.md) |   | diff --git a/docs/reference/api/WatcherInputContainer.md b/docs/reference/api/WatcherInputContainer.md new file mode 100644 index 000000000..c6ac3cfde --- /dev/null +++ b/docs/reference/api/WatcherInputContainer.md @@ -0,0 +1,8 @@ +## Interface `WatcherInputContainer` + +| Name | Type | Description | +| - | - | - | +| `chain` | [WatcherChainInput](./WatcherChainInput.md) |   | +| `http` | [WatcherHttpInput](./WatcherHttpInput.md) |   | +| `search` | [WatcherSearchInput](./WatcherSearchInput.md) |   | +| `simple` | Record |   | diff --git a/docs/reference/api/WatcherInputType.md b/docs/reference/api/WatcherInputType.md new file mode 100644 index 000000000..3214ab0cf --- /dev/null +++ b/docs/reference/api/WatcherInputType.md @@ -0,0 +1,4 @@ +## `WatcherInputType` +::: +type WatcherInputType = 'http' | 'search' | 'simple'; +::: diff --git a/docs/reference/api/WatcherLoggingAction.md b/docs/reference/api/WatcherLoggingAction.md new file mode 100644 index 000000000..033b1ce70 --- /dev/null +++ b/docs/reference/api/WatcherLoggingAction.md @@ -0,0 +1,7 @@ +## Interface `WatcherLoggingAction` + +| Name | Type | Description | +| - | - | - | +| `category` | string |   | +| `level` | string |   | +| `text` | string |   | diff --git a/docs/reference/api/WatcherLoggingResult.md b/docs/reference/api/WatcherLoggingResult.md new file mode 100644 index 000000000..7055f03cc --- /dev/null +++ b/docs/reference/api/WatcherLoggingResult.md @@ -0,0 +1,5 @@ +## Interface `WatcherLoggingResult` + +| Name | Type | Description | +| - | - | - | +| `logged_text` | string |   | diff --git a/docs/reference/api/WatcherMonth.md b/docs/reference/api/WatcherMonth.md new file mode 100644 index 000000000..5dadbeeb0 --- /dev/null +++ b/docs/reference/api/WatcherMonth.md @@ -0,0 +1,4 @@ +## `WatcherMonth` +::: +type WatcherMonth = 'january' | 'february' | 'march' | 'april' | 'may' | 'june' | 'july' | 'august' | 'september' | 'october' | 'november' | 'december'; +::: diff --git a/docs/reference/api/WatcherNeverCondition.md b/docs/reference/api/WatcherNeverCondition.md new file mode 100644 index 000000000..1a76cb090 --- /dev/null +++ b/docs/reference/api/WatcherNeverCondition.md @@ -0,0 +1,4 @@ +## Interface `WatcherNeverCondition` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/WatcherPagerDutyAction.md b/docs/reference/api/WatcherPagerDutyAction.md new file mode 100644 index 000000000..12de4e621 --- /dev/null +++ b/docs/reference/api/WatcherPagerDutyAction.md @@ -0,0 +1,4 @@ +## Interface `WatcherPagerDutyAction` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/WatcherPagerDutyContext.md b/docs/reference/api/WatcherPagerDutyContext.md new file mode 100644 index 000000000..6e007fca3 --- /dev/null +++ b/docs/reference/api/WatcherPagerDutyContext.md @@ -0,0 +1,7 @@ +## Interface `WatcherPagerDutyContext` + +| Name | Type | Description | +| - | - | - | +| `href` | string |   | +| `src` | string |   | +| `type` | [WatcherPagerDutyContextType](./WatcherPagerDutyContextType.md) |   | diff --git a/docs/reference/api/WatcherPagerDutyContextType.md b/docs/reference/api/WatcherPagerDutyContextType.md new file mode 100644 index 000000000..abc800255 --- /dev/null +++ b/docs/reference/api/WatcherPagerDutyContextType.md @@ -0,0 +1,4 @@ +## `WatcherPagerDutyContextType` +::: +type WatcherPagerDutyContextType = 'link' | 'image'; +::: diff --git a/docs/reference/api/WatcherPagerDutyEvent.md b/docs/reference/api/WatcherPagerDutyEvent.md new file mode 100644 index 000000000..837822c3e --- /dev/null +++ b/docs/reference/api/WatcherPagerDutyEvent.md @@ -0,0 +1,14 @@ +## Interface `WatcherPagerDutyEvent` + +| Name | Type | Description | +| - | - | - | +| `account` | string |   | +| `attach_payload` | boolean |   | +| `client_url` | string |   | +| `client` | string |   | +| `context` | [WatcherPagerDutyContext](./WatcherPagerDutyContext.md)[] | contexts | +| `contexts` | [WatcherPagerDutyContext](./WatcherPagerDutyContext.md)[] |   | +| `description` | string |   | +| `event_type` | [WatcherPagerDutyEventType](./WatcherPagerDutyEventType.md) |   | +| `incident_key` | string |   | +| `proxy` | [WatcherPagerDutyEventProxy](./WatcherPagerDutyEventProxy.md) |   | diff --git a/docs/reference/api/WatcherPagerDutyEventProxy.md b/docs/reference/api/WatcherPagerDutyEventProxy.md new file mode 100644 index 000000000..fb8354a96 --- /dev/null +++ b/docs/reference/api/WatcherPagerDutyEventProxy.md @@ -0,0 +1,6 @@ +## Interface `WatcherPagerDutyEventProxy` + +| Name | Type | Description | +| - | - | - | +| `host` | [Host](./Host.md) |   | +| `port` | [integer](./integer.md) |   | diff --git a/docs/reference/api/WatcherPagerDutyEventType.md b/docs/reference/api/WatcherPagerDutyEventType.md new file mode 100644 index 000000000..329cda1cd --- /dev/null +++ b/docs/reference/api/WatcherPagerDutyEventType.md @@ -0,0 +1,4 @@ +## `WatcherPagerDutyEventType` +::: +type WatcherPagerDutyEventType = 'trigger' | 'resolve' | 'acknowledge'; +::: diff --git a/docs/reference/api/WatcherPagerDutyResult.md b/docs/reference/api/WatcherPagerDutyResult.md new file mode 100644 index 000000000..8f9f9b3ab --- /dev/null +++ b/docs/reference/api/WatcherPagerDutyResult.md @@ -0,0 +1,8 @@ +## Interface `WatcherPagerDutyResult` + +| Name | Type | Description | +| - | - | - | +| `event` | [WatcherPagerDutyEvent](./WatcherPagerDutyEvent.md) |   | +| `reason` | string |   | +| `request` | [WatcherHttpInputRequestResult](./WatcherHttpInputRequestResult.md) |   | +| `response` | [WatcherHttpInputResponseResult](./WatcherHttpInputResponseResult.md) |   | diff --git a/docs/reference/api/WatcherPutWatchRequest.md b/docs/reference/api/WatcherPutWatchRequest.md new file mode 100644 index 000000000..40769735b --- /dev/null +++ b/docs/reference/api/WatcherPutWatchRequest.md @@ -0,0 +1,19 @@ +## Interface `WatcherPutWatchRequest` + +| Name | Type | Description | +| - | - | - | +| `actions` | Record | The list of actions that will be run if the condition matches. | +| `active` | boolean | The initial state of the watch. The default value is `true`, which means the watch is active by default. | +| `body` | string | ({ [key: string]: any; } & { id?: never; active?: never; if_primary_term?: never; if_seq_no?: never; version?: never; actions?: never; condition?: never; input?: never; metadata?: never; throttle_period?: never; throttle_period_in_millis?: never; transform?: never; trigger?: never; }) | All values in `body` will be added to the request body. | +| `condition` | [WatcherConditionContainer](./WatcherConditionContainer.md) | The condition that defines if the actions should be run. | +| `id` | [Id](./Id.md) | The identifier for the watch. | +| `if_primary_term` | [long](./long.md) | only update the watch if the last operation that has changed the watch has the specified primary term | +| `if_seq_no` | [SequenceNumber](./SequenceNumber.md) | only update the watch if the last operation that has changed the watch has the specified sequence number | +| `input` | [WatcherInputContainer](./WatcherInputContainer.md) | The input that defines the input that loads the data for the watch. | +| `metadata` | [Metadata](./Metadata.md) | Metadata JSON that will be copied into the history entries. | +| `querystring` | { [key: string]: any; } & { id?: never; active?: never; if_primary_term?: never; if_seq_no?: never; version?: never; actions?: never; condition?: never; input?: never; metadata?: never; throttle_period?: never; throttle_period_in_millis?: never; transform?: never; trigger?: never; } | All values in `querystring` will be added to the request querystring. | +| `throttle_period_in_millis` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> | Minimum time in milliseconds between actions being run. Defaults to 5000. If both this value and the throttle_period parameter are specified, Watcher uses the last parameter included in the request. | +| `throttle_period` | [Duration](./Duration.md) | The minimum time between actions being run. The default is 5 seconds. This default can be changed in the config file with the setting `xpack.watcher.throttle.period.default_period`. If both this value and the `throttle_period_in_millis` parameter are specified, Watcher uses the last parameter included in the request. | +| `transform` | [TransformContainer](./TransformContainer.md) | The transform that processes the watch payload to prepare it for the watch actions. | +| `trigger` | [WatcherTriggerContainer](./WatcherTriggerContainer.md) | The trigger that defines when the watch should run. | +| `version` | [VersionNumber](./VersionNumber.md) | Explicit version number for concurrency control | diff --git a/docs/reference/api/WatcherPutWatchResponse.md b/docs/reference/api/WatcherPutWatchResponse.md new file mode 100644 index 000000000..9c10a8596 --- /dev/null +++ b/docs/reference/api/WatcherPutWatchResponse.md @@ -0,0 +1,9 @@ +## Interface `WatcherPutWatchResponse` + +| Name | Type | Description | +| - | - | - | +| `_id` | [Id](./Id.md) |   | +| `_primary_term` | [long](./long.md) |   | +| `_seq_no` | [SequenceNumber](./SequenceNumber.md) |   | +| `_version` | [VersionNumber](./VersionNumber.md) |   | +| `created` | boolean |   | diff --git a/docs/reference/api/WatcherQuantifier.md b/docs/reference/api/WatcherQuantifier.md new file mode 100644 index 000000000..63e7f6790 --- /dev/null +++ b/docs/reference/api/WatcherQuantifier.md @@ -0,0 +1,4 @@ +## `WatcherQuantifier` +::: +type WatcherQuantifier = 'some' | 'all'; +::: diff --git a/docs/reference/api/WatcherQueryWatch.md b/docs/reference/api/WatcherQueryWatch.md new file mode 100644 index 000000000..3d44f9c6d --- /dev/null +++ b/docs/reference/api/WatcherQueryWatch.md @@ -0,0 +1,9 @@ +## Interface `WatcherQueryWatch` + +| Name | Type | Description | +| - | - | - | +| `_id` | [Id](./Id.md) |   | +| `_primary_term` | [integer](./integer.md) |   | +| `_seq_no` | [SequenceNumber](./SequenceNumber.md) |   | +| `status` | [WatcherWatchStatus](./WatcherWatchStatus.md) |   | +| `watch` | [WatcherWatch](./WatcherWatch.md) |   | diff --git a/docs/reference/api/WatcherQueryWatchesRequest.md b/docs/reference/api/WatcherQueryWatchesRequest.md new file mode 100644 index 000000000..06bc2cca1 --- /dev/null +++ b/docs/reference/api/WatcherQueryWatchesRequest.md @@ -0,0 +1,11 @@ +## Interface `WatcherQueryWatchesRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { from?: never; size?: never; query?: never; sort?: never; search_after?: never; }) | All values in `body` will be added to the request body. | +| `from` | [integer](./integer.md) | The offset from the first result to fetch. It must be non-negative. | +| `query` | [QueryDslQueryContainer](./QueryDslQueryContainer.md) | A query that filters the watches to be returned. | +| `querystring` | { [key: string]: any; } & { from?: never; size?: never; query?: never; sort?: never; search_after?: never; } | All values in `querystring` will be added to the request querystring. | +| `search_after` | [SortResults](./SortResults.md) | Retrieve the next page of hits using a set of sort values from the previous page. | +| `size` | [integer](./integer.md) | The number of hits to return. It must be non-negative. | +| `sort` | [Sort](./Sort.md) | One or more fields used to sort the search results. | diff --git a/docs/reference/api/WatcherQueryWatchesResponse.md b/docs/reference/api/WatcherQueryWatchesResponse.md new file mode 100644 index 000000000..86b535874 --- /dev/null +++ b/docs/reference/api/WatcherQueryWatchesResponse.md @@ -0,0 +1,6 @@ +## Interface `WatcherQueryWatchesResponse` + +| Name | Type | Description | +| - | - | - | +| `count` | [integer](./integer.md) | The total number of watches found. | +| `watches` | [WatcherQueryWatch](./WatcherQueryWatch.md)[] | A list of watches based on the `from`, `size`, or `search_after` request body parameters. | diff --git a/docs/reference/api/WatcherReportingEmailAttachment.md b/docs/reference/api/WatcherReportingEmailAttachment.md new file mode 100644 index 000000000..a4b1a5c49 --- /dev/null +++ b/docs/reference/api/WatcherReportingEmailAttachment.md @@ -0,0 +1,9 @@ +## Interface `WatcherReportingEmailAttachment` + +| Name | Type | Description | +| - | - | - | +| `inline` | boolean |   | +| `interval` | [Duration](./Duration.md) |   | +| `request` | [WatcherHttpInputRequestDefinition](./WatcherHttpInputRequestDefinition.md) |   | +| `retries` | [integer](./integer.md) |   | +| `url` | string |   | diff --git a/docs/reference/api/WatcherResponseContentType.md b/docs/reference/api/WatcherResponseContentType.md new file mode 100644 index 000000000..af43c1832 --- /dev/null +++ b/docs/reference/api/WatcherResponseContentType.md @@ -0,0 +1,4 @@ +## `WatcherResponseContentType` +::: +type WatcherResponseContentType = 'json' | 'yaml' | 'text'; +::: diff --git a/docs/reference/api/WatcherScheduleContainer.md b/docs/reference/api/WatcherScheduleContainer.md new file mode 100644 index 000000000..f5599416c --- /dev/null +++ b/docs/reference/api/WatcherScheduleContainer.md @@ -0,0 +1,12 @@ +## Interface `WatcherScheduleContainer` + +| Name | Type | Description | +| - | - | - | +| `cron` | [WatcherCronExpression](./WatcherCronExpression.md) |   | +| `daily` | [WatcherDailySchedule](./WatcherDailySchedule.md) |   | +| `hourly` | [WatcherHourlySchedule](./WatcherHourlySchedule.md) |   | +| `interval` | [Duration](./Duration.md) |   | +| `monthly` | [WatcherTimeOfMonth](./WatcherTimeOfMonth.md) | [WatcherTimeOfMonth](./WatcherTimeOfMonth.md)[] |   | +| `timezone` | string |   | +| `weekly` | [WatcherTimeOfWeek](./WatcherTimeOfWeek.md) | [WatcherTimeOfWeek](./WatcherTimeOfWeek.md)[] |   | +| `yearly` | [WatcherTimeOfYear](./WatcherTimeOfYear.md) | [WatcherTimeOfYear](./WatcherTimeOfYear.md)[] |   | diff --git a/docs/reference/api/WatcherScheduleTimeOfDay.md b/docs/reference/api/WatcherScheduleTimeOfDay.md new file mode 100644 index 000000000..4dd591c38 --- /dev/null +++ b/docs/reference/api/WatcherScheduleTimeOfDay.md @@ -0,0 +1,4 @@ +## `WatcherScheduleTimeOfDay` +::: +type WatcherScheduleTimeOfDay = string | [WatcherHourAndMinute](./WatcherHourAndMinute.md); +::: diff --git a/docs/reference/api/WatcherScheduleTriggerEvent.md b/docs/reference/api/WatcherScheduleTriggerEvent.md new file mode 100644 index 000000000..69dca292a --- /dev/null +++ b/docs/reference/api/WatcherScheduleTriggerEvent.md @@ -0,0 +1,6 @@ +## Interface `WatcherScheduleTriggerEvent` + +| Name | Type | Description | +| - | - | - | +| `scheduled_time` | [DateTime](./DateTime.md) |   | +| `triggered_time` | [DateTime](./DateTime.md) |   | diff --git a/docs/reference/api/WatcherScriptCondition.md b/docs/reference/api/WatcherScriptCondition.md new file mode 100644 index 000000000..9049db04a --- /dev/null +++ b/docs/reference/api/WatcherScriptCondition.md @@ -0,0 +1,8 @@ +## Interface `WatcherScriptCondition` + +| Name | Type | Description | +| - | - | - | +| `id` | string |   | +| `lang` | [ScriptLanguage](./ScriptLanguage.md) |   | +| `params` | Record |   | +| `source` | [ScriptSource](./ScriptSource.md) |   | diff --git a/docs/reference/api/WatcherSearchInput.md b/docs/reference/api/WatcherSearchInput.md new file mode 100644 index 000000000..88f6ca37d --- /dev/null +++ b/docs/reference/api/WatcherSearchInput.md @@ -0,0 +1,7 @@ +## Interface `WatcherSearchInput` + +| Name | Type | Description | +| - | - | - | +| `extract` | string[] |   | +| `request` | [WatcherSearchInputRequestDefinition](./WatcherSearchInputRequestDefinition.md) |   | +| `timeout` | [Duration](./Duration.md) |   | diff --git a/docs/reference/api/WatcherSearchInputRequestBody.md b/docs/reference/api/WatcherSearchInputRequestBody.md new file mode 100644 index 000000000..c1b191959 --- /dev/null +++ b/docs/reference/api/WatcherSearchInputRequestBody.md @@ -0,0 +1,5 @@ +## Interface `WatcherSearchInputRequestBody` + +| Name | Type | Description | +| - | - | - | +| `query` | [QueryDslQueryContainer](./QueryDslQueryContainer.md) |   | diff --git a/docs/reference/api/WatcherSearchInputRequestDefinition.md b/docs/reference/api/WatcherSearchInputRequestDefinition.md new file mode 100644 index 000000000..f08d37da9 --- /dev/null +++ b/docs/reference/api/WatcherSearchInputRequestDefinition.md @@ -0,0 +1,10 @@ +## Interface `WatcherSearchInputRequestDefinition` + +| Name | Type | Description | +| - | - | - | +| `body` | [WatcherSearchInputRequestBody](./WatcherSearchInputRequestBody.md) |   | +| `indices_options` | [IndicesOptions](./IndicesOptions.md) |   | +| `indices` | [IndexName](./IndexName.md)[] |   | +| `rest_total_hits_as_int` | boolean |   | +| `search_type` | [SearchType](./SearchType.md) |   | +| `template` | [WatcherSearchTemplateRequestBody](./WatcherSearchTemplateRequestBody.md) |   | diff --git a/docs/reference/api/WatcherSearchTemplateRequestBody.md b/docs/reference/api/WatcherSearchTemplateRequestBody.md new file mode 100644 index 000000000..f31ec4834 --- /dev/null +++ b/docs/reference/api/WatcherSearchTemplateRequestBody.md @@ -0,0 +1,9 @@ +## Interface `WatcherSearchTemplateRequestBody` + +| Name | Type | Description | +| - | - | - | +| `explain` | boolean |   | +| `id` | [Id](./Id.md) | ID of the search template to use. If no source is specified, this parameter is required. | +| `params` | Record |   | +| `profile` | boolean |   | +| `source` | string | An inline search template. Supports the same parameters as the search API's request body. Also supports Mustache variables. If no id is specified, this parameter is required. | diff --git a/docs/reference/api/WatcherSimulatedActions.md b/docs/reference/api/WatcherSimulatedActions.md new file mode 100644 index 000000000..342a656c9 --- /dev/null +++ b/docs/reference/api/WatcherSimulatedActions.md @@ -0,0 +1,7 @@ +## Interface `WatcherSimulatedActions` + +| Name | Type | Description | +| - | - | - | +| `actions` | string[] |   | +| `all` | [WatcherSimulatedActions](./WatcherSimulatedActions.md) |   | +| `use_all` | boolean |   | diff --git a/docs/reference/api/WatcherSlackAction.md b/docs/reference/api/WatcherSlackAction.md new file mode 100644 index 000000000..8a183db77 --- /dev/null +++ b/docs/reference/api/WatcherSlackAction.md @@ -0,0 +1,6 @@ +## Interface `WatcherSlackAction` + +| Name | Type | Description | +| - | - | - | +| `account` | string |   | +| `message` | [WatcherSlackMessage](./WatcherSlackMessage.md) |   | diff --git a/docs/reference/api/WatcherSlackAttachment.md b/docs/reference/api/WatcherSlackAttachment.md new file mode 100644 index 000000000..f0129eeb4 --- /dev/null +++ b/docs/reference/api/WatcherSlackAttachment.md @@ -0,0 +1,19 @@ +## Interface `WatcherSlackAttachment` + +| Name | Type | Description | +| - | - | - | +| `author_icon` | string |   | +| `author_link` | string |   | +| `author_name` | string |   | +| `color` | string |   | +| `fallback` | string |   | +| `fields` | [WatcherSlackAttachmentField](./WatcherSlackAttachmentField.md)[] |   | +| `footer_icon` | string |   | +| `footer` | string |   | +| `image_url` | string |   | +| `pretext` | string |   | +| `text` | string |   | +| `thumb_url` | string |   | +| `title_link` | string |   | +| `title` | string |   | +| `ts` | [EpochTime](./EpochTime.md)<[UnitSeconds](./UnitSeconds.md)> |   | diff --git a/docs/reference/api/WatcherSlackAttachmentField.md b/docs/reference/api/WatcherSlackAttachmentField.md new file mode 100644 index 000000000..99d527362 --- /dev/null +++ b/docs/reference/api/WatcherSlackAttachmentField.md @@ -0,0 +1,7 @@ +## Interface `WatcherSlackAttachmentField` + +| Name | Type | Description | +| - | - | - | +| `short` | boolean |   | +| `title` | string |   | +| `value` | string |   | diff --git a/docs/reference/api/WatcherSlackDynamicAttachment.md b/docs/reference/api/WatcherSlackDynamicAttachment.md new file mode 100644 index 000000000..2a33c908e --- /dev/null +++ b/docs/reference/api/WatcherSlackDynamicAttachment.md @@ -0,0 +1,6 @@ +## Interface `WatcherSlackDynamicAttachment` + +| Name | Type | Description | +| - | - | - | +| `attachment_template` | [WatcherSlackAttachment](./WatcherSlackAttachment.md) |   | +| `list_path` | string |   | diff --git a/docs/reference/api/WatcherSlackMessage.md b/docs/reference/api/WatcherSlackMessage.md new file mode 100644 index 000000000..caf8b99d9 --- /dev/null +++ b/docs/reference/api/WatcherSlackMessage.md @@ -0,0 +1,10 @@ +## Interface `WatcherSlackMessage` + +| Name | Type | Description | +| - | - | - | +| `attachments` | [WatcherSlackAttachment](./WatcherSlackAttachment.md)[] |   | +| `dynamic_attachments` | [WatcherSlackDynamicAttachment](./WatcherSlackDynamicAttachment.md) |   | +| `from` | string |   | +| `icon` | string |   | +| `text` | string |   | +| `to` | string[] |   | diff --git a/docs/reference/api/WatcherSlackResult.md b/docs/reference/api/WatcherSlackResult.md new file mode 100644 index 000000000..7ae8b1554 --- /dev/null +++ b/docs/reference/api/WatcherSlackResult.md @@ -0,0 +1,6 @@ +## Interface `WatcherSlackResult` + +| Name | Type | Description | +| - | - | - | +| `account` | string |   | +| `message` | [WatcherSlackMessage](./WatcherSlackMessage.md) |   | diff --git a/docs/reference/api/WatcherStartRequest.md b/docs/reference/api/WatcherStartRequest.md new file mode 100644 index 000000000..32d5a9d3e --- /dev/null +++ b/docs/reference/api/WatcherStartRequest.md @@ -0,0 +1,7 @@ +## Interface `WatcherStartRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { master_timeout?: never; }) | All values in `body` will be added to the request body. | +| `master_timeout` | [Duration](./Duration.md) | Period to wait for a connection to the master node. | +| `querystring` | { [key: string]: any; } & { master_timeout?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/WatcherStartResponse.md b/docs/reference/api/WatcherStartResponse.md new file mode 100644 index 000000000..f27ca8f2b --- /dev/null +++ b/docs/reference/api/WatcherStartResponse.md @@ -0,0 +1,4 @@ +## `WatcherStartResponse` +::: +type WatcherStartResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); +::: diff --git a/docs/reference/api/WatcherStatsRequest.md b/docs/reference/api/WatcherStatsRequest.md new file mode 100644 index 000000000..374c53b07 --- /dev/null +++ b/docs/reference/api/WatcherStatsRequest.md @@ -0,0 +1,8 @@ +## Interface `WatcherStatsRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { metric?: never; emit_stacktraces?: never; }) | All values in `body` will be added to the request body. | +| `emit_stacktraces` | boolean | Defines whether stack traces are generated for each watch that is running. | +| `metric` | [WatcherStatsWatcherMetric](./WatcherStatsWatcherMetric.md) | [WatcherStatsWatcherMetric](./WatcherStatsWatcherMetric.md)[] | Defines which additional metrics are included in the response. | +| `querystring` | { [key: string]: any; } & { metric?: never; emit_stacktraces?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/WatcherStatsResponse.md b/docs/reference/api/WatcherStatsResponse.md new file mode 100644 index 000000000..383e5308b --- /dev/null +++ b/docs/reference/api/WatcherStatsResponse.md @@ -0,0 +1,8 @@ +## Interface `WatcherStatsResponse` + +| Name | Type | Description | +| - | - | - | +| `_nodes` | [NodeStatistics](./NodeStatistics.md) |   | +| `cluster_name` | [Name](./Name.md) |   | +| `manually_stopped` | boolean |   | +| `stats` | [WatcherStatsWatcherNodeStats](./WatcherStatsWatcherNodeStats.md)[] |   | diff --git a/docs/reference/api/WatcherStatsWatchRecordQueuedStats.md b/docs/reference/api/WatcherStatsWatchRecordQueuedStats.md new file mode 100644 index 000000000..e0f3c2e62 --- /dev/null +++ b/docs/reference/api/WatcherStatsWatchRecordQueuedStats.md @@ -0,0 +1,5 @@ +## Interface `WatcherStatsWatchRecordQueuedStats` + +| Name | Type | Description | +| - | - | - | +| `execution_time` | [DateTime](./DateTime.md) | The time the watch was run. This is just before the input is being run. | diff --git a/docs/reference/api/WatcherStatsWatchRecordStats.md b/docs/reference/api/WatcherStatsWatchRecordStats.md new file mode 100644 index 000000000..736c946a0 --- /dev/null +++ b/docs/reference/api/WatcherStatsWatchRecordStats.md @@ -0,0 +1,9 @@ +## Interface `WatcherStatsWatchRecordStats` + +| Name | Type | Description | +| - | - | - | +| `executed_actions` | string[] |   | +| `execution_phase` | [WatcherExecutionPhase](./WatcherExecutionPhase.md) | The current watch execution phase. | +| `triggered_time` | [DateTime](./DateTime.md) | The time the watch was triggered by the trigger engine. | +| `watch_id` | [Id](./Id.md) |   | +| `watch_record_id` | [Id](./Id.md) | The watch record identifier. | diff --git a/docs/reference/api/WatcherStatsWatcherMetric.md b/docs/reference/api/WatcherStatsWatcherMetric.md new file mode 100644 index 000000000..c469ea804 --- /dev/null +++ b/docs/reference/api/WatcherStatsWatcherMetric.md @@ -0,0 +1,4 @@ +## `WatcherStatsWatcherMetric` +::: +type WatcherStatsWatcherMetric = '_all' | 'all' | 'queued_watches' | 'current_watches' | 'pending_watches'; +::: diff --git a/docs/reference/api/WatcherStatsWatcherNodeStats.md b/docs/reference/api/WatcherStatsWatcherNodeStats.md new file mode 100644 index 000000000..43805fcdb --- /dev/null +++ b/docs/reference/api/WatcherStatsWatcherNodeStats.md @@ -0,0 +1,10 @@ +## Interface `WatcherStatsWatcherNodeStats` + +| Name | Type | Description | +| - | - | - | +| `current_watches` | [WatcherStatsWatchRecordStats](./WatcherStatsWatchRecordStats.md)[] | The current executing watches metric gives insight into the watches that are currently being executed by Watcher. Additional information is shared per watch that is currently executing. This information includes the `watch_id`, the time its execution started and its current execution phase. To include this metric, the `metric` option should be set to `current_watches` or `_all`. In addition you can also specify the `emit_stacktraces=true` parameter, which adds stack traces for each watch that is being run. These stack traces can give you more insight into an execution of a watch. | +| `execution_thread_pool` | [WatcherExecutionThreadPool](./WatcherExecutionThreadPool.md) |   | +| `node_id` | [Id](./Id.md) |   | +| `queued_watches` | [WatcherStatsWatchRecordQueuedStats](./WatcherStatsWatchRecordQueuedStats.md)[] | Watcher moderates the execution of watches such that their execution won't put too much pressure on the node and its resources. If too many watches trigger concurrently and there isn't enough capacity to run them all, some of the watches are queued, waiting for the current running watches to finish.s The queued watches metric gives insight on these queued watches. To include this metric, the `metric` option should include `queued_watches` or `_all`. | +| `watch_count` | [long](./long.md) | The number of watches currently registered. | +| `watcher_state` | [WatcherStatsWatcherState](./WatcherStatsWatcherState.md) | The current state of Watcher. | diff --git a/docs/reference/api/WatcherStatsWatcherState.md b/docs/reference/api/WatcherStatsWatcherState.md new file mode 100644 index 000000000..8ecb7b1d2 --- /dev/null +++ b/docs/reference/api/WatcherStatsWatcherState.md @@ -0,0 +1,4 @@ +## `WatcherStatsWatcherState` +::: +type WatcherStatsWatcherState = 'stopped' | 'starting' | 'started' | 'stopping'; +::: diff --git a/docs/reference/api/WatcherStopRequest.md b/docs/reference/api/WatcherStopRequest.md new file mode 100644 index 000000000..1c66b11fd --- /dev/null +++ b/docs/reference/api/WatcherStopRequest.md @@ -0,0 +1,7 @@ +## Interface `WatcherStopRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { master_timeout?: never; }) | All values in `body` will be added to the request body. | +| `master_timeout` | [Duration](./Duration.md) | The period to wait for the master node. If the master node is not available before the timeout expires, the request fails and returns an error. To indicate that the request should never timeout, set it to `-1`. | +| `querystring` | { [key: string]: any; } & { master_timeout?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/WatcherStopResponse.md b/docs/reference/api/WatcherStopResponse.md new file mode 100644 index 000000000..b6db405e9 --- /dev/null +++ b/docs/reference/api/WatcherStopResponse.md @@ -0,0 +1,4 @@ +## `WatcherStopResponse` +::: +type WatcherStopResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); +::: diff --git a/docs/reference/api/WatcherThrottleState.md b/docs/reference/api/WatcherThrottleState.md new file mode 100644 index 000000000..1c4d28f41 --- /dev/null +++ b/docs/reference/api/WatcherThrottleState.md @@ -0,0 +1,6 @@ +## Interface `WatcherThrottleState` + +| Name | Type | Description | +| - | - | - | +| `reason` | string |   | +| `timestamp` | [DateTime](./DateTime.md) |   | diff --git a/docs/reference/api/WatcherTimeOfMonth.md b/docs/reference/api/WatcherTimeOfMonth.md new file mode 100644 index 000000000..604e104c4 --- /dev/null +++ b/docs/reference/api/WatcherTimeOfMonth.md @@ -0,0 +1,6 @@ +## Interface `WatcherTimeOfMonth` + +| Name | Type | Description | +| - | - | - | +| `at` | string[] |   | +| `on` | [integer](./integer.md)[] |   | diff --git a/docs/reference/api/WatcherTimeOfWeek.md b/docs/reference/api/WatcherTimeOfWeek.md new file mode 100644 index 000000000..4b07dd068 --- /dev/null +++ b/docs/reference/api/WatcherTimeOfWeek.md @@ -0,0 +1,6 @@ +## Interface `WatcherTimeOfWeek` + +| Name | Type | Description | +| - | - | - | +| `at` | string[] |   | +| `on` | [WatcherDay](./WatcherDay.md)[] |   | diff --git a/docs/reference/api/WatcherTimeOfYear.md b/docs/reference/api/WatcherTimeOfYear.md new file mode 100644 index 000000000..da23c0003 --- /dev/null +++ b/docs/reference/api/WatcherTimeOfYear.md @@ -0,0 +1,7 @@ +## Interface `WatcherTimeOfYear` + +| Name | Type | Description | +| - | - | - | +| `at` | string[] |   | +| `int` | [WatcherMonth](./WatcherMonth.md)[] |   | +| `on` | [integer](./integer.md)[] |   | diff --git a/docs/reference/api/WatcherTriggerContainer.md b/docs/reference/api/WatcherTriggerContainer.md new file mode 100644 index 000000000..c254f51b2 --- /dev/null +++ b/docs/reference/api/WatcherTriggerContainer.md @@ -0,0 +1,5 @@ +## Interface `WatcherTriggerContainer` + +| Name | Type | Description | +| - | - | - | +| `schedule` | [WatcherScheduleContainer](./WatcherScheduleContainer.md) |   | diff --git a/docs/reference/api/WatcherTriggerEventContainer.md b/docs/reference/api/WatcherTriggerEventContainer.md new file mode 100644 index 000000000..fd75f8ad7 --- /dev/null +++ b/docs/reference/api/WatcherTriggerEventContainer.md @@ -0,0 +1,5 @@ +## Interface `WatcherTriggerEventContainer` + +| Name | Type | Description | +| - | - | - | +| `schedule` | [WatcherScheduleTriggerEvent](./WatcherScheduleTriggerEvent.md) |   | diff --git a/docs/reference/api/WatcherTriggerEventResult.md b/docs/reference/api/WatcherTriggerEventResult.md new file mode 100644 index 000000000..aaadeee51 --- /dev/null +++ b/docs/reference/api/WatcherTriggerEventResult.md @@ -0,0 +1,7 @@ +## Interface `WatcherTriggerEventResult` + +| Name | Type | Description | +| - | - | - | +| `manual` | [WatcherTriggerEventContainer](./WatcherTriggerEventContainer.md) |   | +| `triggered_time` | [DateTime](./DateTime.md) |   | +| `type` | string |   | diff --git a/docs/reference/api/WatcherUpdateSettingsRequest.md b/docs/reference/api/WatcherUpdateSettingsRequest.md new file mode 100644 index 000000000..1667afd12 --- /dev/null +++ b/docs/reference/api/WatcherUpdateSettingsRequest.md @@ -0,0 +1,10 @@ +## Interface `WatcherUpdateSettingsRequest` + +| Name | Type | Description | +| - | - | - | +| `"index.auto_expand_replicas"` | string |   | +| `"index.number_of_replicas"` | [integer](./integer.md) |   | +| `body` | string | ({ [key: string]: any; } & { master_timeout?: never; timeout?: never; 'index.auto_expand_replicas'?: never; 'index.number_of_replicas'?: never; }) | All values in `body` will be added to the request body. | +| `master_timeout` | [Duration](./Duration.md) | The period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. | +| `querystring` | { [key: string]: any; } & { master_timeout?: never; timeout?: never; 'index.auto_expand_replicas'?: never; 'index.number_of_replicas'?: never; } | All values in `querystring` will be added to the request querystring. | +| `timeout` | [Duration](./Duration.md) | The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. | diff --git a/docs/reference/api/WatcherUpdateSettingsResponse.md b/docs/reference/api/WatcherUpdateSettingsResponse.md new file mode 100644 index 000000000..59fc1ea4d --- /dev/null +++ b/docs/reference/api/WatcherUpdateSettingsResponse.md @@ -0,0 +1,5 @@ +## Interface `WatcherUpdateSettingsResponse` + +| Name | Type | Description | +| - | - | - | +| `acknowledged` | boolean |   | diff --git a/docs/reference/api/WatcherWatch.md b/docs/reference/api/WatcherWatch.md new file mode 100644 index 000000000..a98c4b0c3 --- /dev/null +++ b/docs/reference/api/WatcherWatch.md @@ -0,0 +1,13 @@ +## Interface `WatcherWatch` + +| Name | Type | Description | +| - | - | - | +| `actions` | Record<[IndexName](./IndexName.md), [WatcherAction](./WatcherAction.md)> |   | +| `condition` | [WatcherConditionContainer](./WatcherConditionContainer.md) |   | +| `input` | [WatcherInputContainer](./WatcherInputContainer.md) |   | +| `metadata` | [Metadata](./Metadata.md) |   | +| `status` | [WatcherWatchStatus](./WatcherWatchStatus.md) |   | +| `throttle_period_in_millis` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> |   | +| `throttle_period` | [Duration](./Duration.md) |   | +| `transform` | [TransformContainer](./TransformContainer.md) |   | +| `trigger` | [WatcherTriggerContainer](./WatcherTriggerContainer.md) |   | diff --git a/docs/reference/api/WatcherWatchStatus.md b/docs/reference/api/WatcherWatchStatus.md new file mode 100644 index 000000000..78555c125 --- /dev/null +++ b/docs/reference/api/WatcherWatchStatus.md @@ -0,0 +1,10 @@ +## Interface `WatcherWatchStatus` + +| Name | Type | Description | +| - | - | - | +| `actions` | [WatcherActions](./WatcherActions.md) |   | +| `execution_state` | string |   | +| `last_checked` | [DateTime](./DateTime.md) |   | +| `last_met_condition` | [DateTime](./DateTime.md) |   | +| `state` | [WatcherActivationState](./WatcherActivationState.md) |   | +| `version` | [VersionNumber](./VersionNumber.md) |   | diff --git a/docs/reference/api/WatcherWebhookAction.md b/docs/reference/api/WatcherWebhookAction.md new file mode 100644 index 000000000..ab8be7be7 --- /dev/null +++ b/docs/reference/api/WatcherWebhookAction.md @@ -0,0 +1,4 @@ +## Interface `WatcherWebhookAction` + +| Name | Type | Description | +| - | - | - | diff --git a/docs/reference/api/WatcherWebhookResult.md b/docs/reference/api/WatcherWebhookResult.md new file mode 100644 index 000000000..d29c319e5 --- /dev/null +++ b/docs/reference/api/WatcherWebhookResult.md @@ -0,0 +1,6 @@ +## Interface `WatcherWebhookResult` + +| Name | Type | Description | +| - | - | - | +| `request` | [WatcherHttpInputRequestResult](./WatcherHttpInputRequestResult.md) |   | +| `response` | [WatcherHttpInputResponseResult](./WatcherHttpInputResponseResult.md) |   | diff --git a/docs/reference/api/WktGeoBounds.md b/docs/reference/api/WktGeoBounds.md new file mode 100644 index 000000000..61295cdd5 --- /dev/null +++ b/docs/reference/api/WktGeoBounds.md @@ -0,0 +1,5 @@ +## Interface `WktGeoBounds` + +| Name | Type | Description | +| - | - | - | +| `wkt` | string |   | diff --git a/docs/reference/api/WriteResponseBase.md b/docs/reference/api/WriteResponseBase.md new file mode 100644 index 000000000..9c96ace71 --- /dev/null +++ b/docs/reference/api/WriteResponseBase.md @@ -0,0 +1,12 @@ +## Interface `WriteResponseBase` + +| Name | Type | Description | +| - | - | - | +| `_id` | [Id](./Id.md) | The unique identifier for the added document. | +| `_index` | [IndexName](./IndexName.md) | The name of the index the document was added to. | +| `_primary_term` | [long](./long.md) | The primary term assigned to the document for the indexing operation. | +| `_seq_no` | [SequenceNumber](./SequenceNumber.md) | The sequence number assigned to the document for the indexing operation. Sequence numbers are used to ensure an older version of a document doesn't overwrite a newer version. | +| `_shards` | [ShardStatistics](./ShardStatistics.md) | Information about the replication process of the operation. | +| `_version` | [VersionNumber](./VersionNumber.md) | The document version, which is incremented each time the document is updated. | +| `forced_refresh` | boolean |   | +| `result` | [Result](./Result.md) | The result of the indexing operation: `created` or `updated`. | diff --git a/docs/reference/api/Xpack.md b/docs/reference/api/Xpack.md new file mode 100644 index 000000000..37e3e3b56 --- /dev/null +++ b/docs/reference/api/Xpack.md @@ -0,0 +1,20 @@ +## `Xpack` + +### Constructor + +::: +new Xpack(transport: [Transport](./Transport.md)); +::: + +### Properties + +| Name | Type | Description | +| - | - | - | +| `acceptedParams` | Record |   | +| `transport` | [Transport](./Transport.md) |   | + +### Methods + +| Name | Signature | Description | +| - | - | - | +| `info` | `info(this: [That](./That.md), params?: [XpackInfoRequest](./XpackInfoRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[XpackInfoResponse](./XpackInfoResponse.md)>;` | Get information. The information provided by the API includes: * Build information including the build number and timestamp. * License information about the currently installed license. * Feature information for the features that are currently enabled and available under the current license. || `info` | `info(this: [That](./That.md), params?: [XpackInfoRequest](./XpackInfoRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[XpackInfoResponse](./XpackInfoResponse.md), unknown>>;` |   || `info` | `info(this: [That](./That.md), params?: [XpackInfoRequest](./XpackInfoRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[XpackInfoResponse](./XpackInfoResponse.md)>;` |   || `usage` | `usage(this: [That](./That.md), params?: [XpackUsageRequest](./XpackUsageRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[XpackUsageResponse](./XpackUsageResponse.md)>;` | Get usage information. Get information about the features that are currently enabled and available under the current license. The API also provides some usage statistics. || `usage` | `usage(this: [That](./That.md), params?: [XpackUsageRequest](./XpackUsageRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[XpackUsageResponse](./XpackUsageResponse.md), unknown>>;` |   || `usage` | `usage(this: [That](./That.md), params?: [XpackUsageRequest](./XpackUsageRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[XpackUsageResponse](./XpackUsageResponse.md)>;` |   | \ No newline at end of file diff --git a/docs/reference/api/XpackInfoBuildInformation.md b/docs/reference/api/XpackInfoBuildInformation.md new file mode 100644 index 000000000..bbf6486d1 --- /dev/null +++ b/docs/reference/api/XpackInfoBuildInformation.md @@ -0,0 +1,6 @@ +## Interface `XpackInfoBuildInformation` + +| Name | Type | Description | +| - | - | - | +| `date` | [DateTime](./DateTime.md) |   | +| `hash` | string |   | diff --git a/docs/reference/api/XpackInfoFeature.md b/docs/reference/api/XpackInfoFeature.md new file mode 100644 index 000000000..739bdd318 --- /dev/null +++ b/docs/reference/api/XpackInfoFeature.md @@ -0,0 +1,8 @@ +## Interface `XpackInfoFeature` + +| Name | Type | Description | +| - | - | - | +| `available` | boolean |   | +| `description` | string |   | +| `enabled` | boolean |   | +| `native_code_info` | [XpackInfoNativeCodeInformation](./XpackInfoNativeCodeInformation.md) |   | diff --git a/docs/reference/api/XpackInfoFeatures.md b/docs/reference/api/XpackInfoFeatures.md new file mode 100644 index 000000000..d0871c0f4 --- /dev/null +++ b/docs/reference/api/XpackInfoFeatures.md @@ -0,0 +1,31 @@ +## Interface `XpackInfoFeatures` + +| Name | Type | Description | +| - | - | - | +| `aggregate_metric` | [XpackInfoFeature](./XpackInfoFeature.md) |   | +| `analytics` | [XpackInfoFeature](./XpackInfoFeature.md) |   | +| `archive` | [XpackInfoFeature](./XpackInfoFeature.md) |   | +| `ccr` | [XpackInfoFeature](./XpackInfoFeature.md) |   | +| `data_streams` | [XpackInfoFeature](./XpackInfoFeature.md) |   | +| `data_tiers` | [XpackInfoFeature](./XpackInfoFeature.md) |   | +| `enrich` | [XpackInfoFeature](./XpackInfoFeature.md) |   | +| `enterprise_search` | [XpackInfoFeature](./XpackInfoFeature.md) |   | +| `eql` | [XpackInfoFeature](./XpackInfoFeature.md) |   | +| `esql` | [XpackInfoFeature](./XpackInfoFeature.md) |   | +| `graph` | [XpackInfoFeature](./XpackInfoFeature.md) |   | +| `ilm` | [XpackInfoFeature](./XpackInfoFeature.md) |   | +| `logsdb` | [XpackInfoFeature](./XpackInfoFeature.md) |   | +| `logstash` | [XpackInfoFeature](./XpackInfoFeature.md) |   | +| `ml` | [XpackInfoFeature](./XpackInfoFeature.md) |   | +| `monitoring` | [XpackInfoFeature](./XpackInfoFeature.md) |   | +| `rollup` | [XpackInfoFeature](./XpackInfoFeature.md) |   | +| `runtime_fields` | [XpackInfoFeature](./XpackInfoFeature.md) |   | +| `searchable_snapshots` | [XpackInfoFeature](./XpackInfoFeature.md) |   | +| `security` | [XpackInfoFeature](./XpackInfoFeature.md) |   | +| `slm` | [XpackInfoFeature](./XpackInfoFeature.md) |   | +| `spatial` | [XpackInfoFeature](./XpackInfoFeature.md) |   | +| `sql` | [XpackInfoFeature](./XpackInfoFeature.md) |   | +| `transform` | [XpackInfoFeature](./XpackInfoFeature.md) |   | +| `universal_profiling` | [XpackInfoFeature](./XpackInfoFeature.md) |   | +| `voting_only` | [XpackInfoFeature](./XpackInfoFeature.md) |   | +| `watcher` | [XpackInfoFeature](./XpackInfoFeature.md) |   | diff --git a/docs/reference/api/XpackInfoMinimalLicenseInformation.md b/docs/reference/api/XpackInfoMinimalLicenseInformation.md new file mode 100644 index 000000000..221f167bd --- /dev/null +++ b/docs/reference/api/XpackInfoMinimalLicenseInformation.md @@ -0,0 +1,9 @@ +## Interface `XpackInfoMinimalLicenseInformation` + +| Name | Type | Description | +| - | - | - | +| `expiry_date_in_millis` | [EpochTime](./EpochTime.md)<[UnitMillis](./UnitMillis.md)> |   | +| `mode` | [LicenseLicenseType](./LicenseLicenseType.md) |   | +| `status` | [LicenseLicenseStatus](./LicenseLicenseStatus.md) |   | +| `type` | [LicenseLicenseType](./LicenseLicenseType.md) |   | +| `uid` | string |   | diff --git a/docs/reference/api/XpackInfoNativeCodeInformation.md b/docs/reference/api/XpackInfoNativeCodeInformation.md new file mode 100644 index 000000000..8b187172a --- /dev/null +++ b/docs/reference/api/XpackInfoNativeCodeInformation.md @@ -0,0 +1,6 @@ +## Interface `XpackInfoNativeCodeInformation` + +| Name | Type | Description | +| - | - | - | +| `build_hash` | string |   | +| `version` | [VersionString](./VersionString.md) |   | diff --git a/docs/reference/api/XpackInfoRequest.md b/docs/reference/api/XpackInfoRequest.md new file mode 100644 index 000000000..ff1b7d277 --- /dev/null +++ b/docs/reference/api/XpackInfoRequest.md @@ -0,0 +1,9 @@ +## Interface `XpackInfoRequest` + +| Name | Type | Description | +| - | - | - | +| `accept_enterprise` | boolean | If this param is used it must be set to true | +| `body` | string | ({ [key: string]: any; } & { categories?: never; accept_enterprise?: never; human?: never; }) | All values in `body` will be added to the request body. | +| `categories` | [XpackInfoXPackCategory](./XpackInfoXPackCategory.md)[] | A comma-separated list of the information categories to include in the response. For example, `build,license,features`. | +| `human` | boolean | Defines whether additional human-readable information is included in the response. In particular, it adds descriptions and a tag line. | +| `querystring` | { [key: string]: any; } & { categories?: never; accept_enterprise?: never; human?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/XpackInfoResponse.md b/docs/reference/api/XpackInfoResponse.md new file mode 100644 index 000000000..cb6ccc5d1 --- /dev/null +++ b/docs/reference/api/XpackInfoResponse.md @@ -0,0 +1,8 @@ +## Interface `XpackInfoResponse` + +| Name | Type | Description | +| - | - | - | +| `build` | [XpackInfoBuildInformation](./XpackInfoBuildInformation.md) |   | +| `features` | [XpackInfoFeatures](./XpackInfoFeatures.md) |   | +| `license` | [XpackInfoMinimalLicenseInformation](./XpackInfoMinimalLicenseInformation.md) |   | +| `tagline` | string |   | diff --git a/docs/reference/api/XpackInfoXPackCategory.md b/docs/reference/api/XpackInfoXPackCategory.md new file mode 100644 index 000000000..5989e89e9 --- /dev/null +++ b/docs/reference/api/XpackInfoXPackCategory.md @@ -0,0 +1,4 @@ +## `XpackInfoXPackCategory` +::: +type XpackInfoXPackCategory = 'build' | 'features' | 'license'; +::: diff --git a/docs/reference/api/XpackUsageAnalytics.md b/docs/reference/api/XpackUsageAnalytics.md new file mode 100644 index 000000000..a8d1aa59c --- /dev/null +++ b/docs/reference/api/XpackUsageAnalytics.md @@ -0,0 +1,5 @@ +## Interface `XpackUsageAnalytics` + +| Name | Type | Description | +| - | - | - | +| `stats` | [XpackUsageAnalyticsStatistics](./XpackUsageAnalyticsStatistics.md) |   | diff --git a/docs/reference/api/XpackUsageAnalyticsStatistics.md b/docs/reference/api/XpackUsageAnalyticsStatistics.md new file mode 100644 index 000000000..af3c7d8da --- /dev/null +++ b/docs/reference/api/XpackUsageAnalyticsStatistics.md @@ -0,0 +1,13 @@ +## Interface `XpackUsageAnalyticsStatistics` + +| Name | Type | Description | +| - | - | - | +| `boxplot_usage` | [long](./long.md) |   | +| `cumulative_cardinality_usage` | [long](./long.md) |   | +| `moving_percentiles_usage` | [long](./long.md) |   | +| `multi_terms_usage` | [long](./long.md) |   | +| `normalize_usage` | [long](./long.md) |   | +| `rate_usage` | [long](./long.md) |   | +| `string_stats_usage` | [long](./long.md) |   | +| `t_test_usage` | [long](./long.md) |   | +| `top_metrics_usage` | [long](./long.md) |   | diff --git a/docs/reference/api/XpackUsageArchive.md b/docs/reference/api/XpackUsageArchive.md new file mode 100644 index 000000000..2ce2b4829 --- /dev/null +++ b/docs/reference/api/XpackUsageArchive.md @@ -0,0 +1,5 @@ +## Interface `XpackUsageArchive` + +| Name | Type | Description | +| - | - | - | +| `indices_count` | [long](./long.md) |   | diff --git a/docs/reference/api/XpackUsageAudit.md b/docs/reference/api/XpackUsageAudit.md new file mode 100644 index 000000000..9d9ceaed8 --- /dev/null +++ b/docs/reference/api/XpackUsageAudit.md @@ -0,0 +1,5 @@ +## Interface `XpackUsageAudit` + +| Name | Type | Description | +| - | - | - | +| `outputs` | string[] |   | diff --git a/docs/reference/api/XpackUsageBase.md b/docs/reference/api/XpackUsageBase.md new file mode 100644 index 000000000..3ec4b2607 --- /dev/null +++ b/docs/reference/api/XpackUsageBase.md @@ -0,0 +1,6 @@ +## Interface `XpackUsageBase` + +| Name | Type | Description | +| - | - | - | +| `available` | boolean |   | +| `enabled` | boolean |   | diff --git a/docs/reference/api/XpackUsageCcr.md b/docs/reference/api/XpackUsageCcr.md new file mode 100644 index 000000000..ef4bec7f2 --- /dev/null +++ b/docs/reference/api/XpackUsageCcr.md @@ -0,0 +1,6 @@ +## Interface `XpackUsageCcr` + +| Name | Type | Description | +| - | - | - | +| `auto_follow_patterns_count` | [integer](./integer.md) |   | +| `follower_indices_count` | [integer](./integer.md) |   | diff --git a/docs/reference/api/XpackUsageCounter.md b/docs/reference/api/XpackUsageCounter.md new file mode 100644 index 000000000..f31ac5f57 --- /dev/null +++ b/docs/reference/api/XpackUsageCounter.md @@ -0,0 +1,6 @@ +## Interface `XpackUsageCounter` + +| Name | Type | Description | +| - | - | - | +| `active` | [long](./long.md) |   | +| `total` | [long](./long.md) |   | diff --git a/docs/reference/api/XpackUsageDataStreams.md b/docs/reference/api/XpackUsageDataStreams.md new file mode 100644 index 000000000..e1137b226 --- /dev/null +++ b/docs/reference/api/XpackUsageDataStreams.md @@ -0,0 +1,6 @@ +## Interface `XpackUsageDataStreams` + +| Name | Type | Description | +| - | - | - | +| `data_streams` | [long](./long.md) |   | +| `indices_count` | [long](./long.md) |   | diff --git a/docs/reference/api/XpackUsageDataTierPhaseStatistics.md b/docs/reference/api/XpackUsageDataTierPhaseStatistics.md new file mode 100644 index 000000000..be3f5af3c --- /dev/null +++ b/docs/reference/api/XpackUsageDataTierPhaseStatistics.md @@ -0,0 +1,14 @@ +## Interface `XpackUsageDataTierPhaseStatistics` + +| Name | Type | Description | +| - | - | - | +| `doc_count` | [long](./long.md) |   | +| `index_count` | [long](./long.md) |   | +| `node_count` | [long](./long.md) |   | +| `primary_shard_count` | [long](./long.md) |   | +| `primary_shard_size_avg_bytes` | [long](./long.md) |   | +| `primary_shard_size_mad_bytes` | [long](./long.md) |   | +| `primary_shard_size_median_bytes` | [long](./long.md) |   | +| `primary_size_bytes` | [long](./long.md) |   | +| `total_shard_count` | [long](./long.md) |   | +| `total_size_bytes` | [long](./long.md) |   | diff --git a/docs/reference/api/XpackUsageDataTiers.md b/docs/reference/api/XpackUsageDataTiers.md new file mode 100644 index 000000000..fd286e2f2 --- /dev/null +++ b/docs/reference/api/XpackUsageDataTiers.md @@ -0,0 +1,9 @@ +## Interface `XpackUsageDataTiers` + +| Name | Type | Description | +| - | - | - | +| `data_cold` | [XpackUsageDataTierPhaseStatistics](./XpackUsageDataTierPhaseStatistics.md) |   | +| `data_content` | [XpackUsageDataTierPhaseStatistics](./XpackUsageDataTierPhaseStatistics.md) |   | +| `data_frozen` | [XpackUsageDataTierPhaseStatistics](./XpackUsageDataTierPhaseStatistics.md) |   | +| `data_hot` | [XpackUsageDataTierPhaseStatistics](./XpackUsageDataTierPhaseStatistics.md) |   | +| `data_warm` | [XpackUsageDataTierPhaseStatistics](./XpackUsageDataTierPhaseStatistics.md) |   | diff --git a/docs/reference/api/XpackUsageDatafeed.md b/docs/reference/api/XpackUsageDatafeed.md new file mode 100644 index 000000000..9ab52d948 --- /dev/null +++ b/docs/reference/api/XpackUsageDatafeed.md @@ -0,0 +1,5 @@ +## Interface `XpackUsageDatafeed` + +| Name | Type | Description | +| - | - | - | +| `count` | [long](./long.md) |   | diff --git a/docs/reference/api/XpackUsageEql.md b/docs/reference/api/XpackUsageEql.md new file mode 100644 index 000000000..bf676576f --- /dev/null +++ b/docs/reference/api/XpackUsageEql.md @@ -0,0 +1,6 @@ +## Interface `XpackUsageEql` + +| Name | Type | Description | +| - | - | - | +| `features` | [XpackUsageEqlFeatures](./XpackUsageEqlFeatures.md) |   | +| `queries` | Record |   | diff --git a/docs/reference/api/XpackUsageEqlFeatures.md b/docs/reference/api/XpackUsageEqlFeatures.md new file mode 100644 index 000000000..a8f57cfdc --- /dev/null +++ b/docs/reference/api/XpackUsageEqlFeatures.md @@ -0,0 +1,11 @@ +## Interface `XpackUsageEqlFeatures` + +| Name | Type | Description | +| - | - | - | +| `event` | [uint](./uint.md) |   | +| `join` | [uint](./uint.md) |   | +| `joins` | [XpackUsageEqlFeaturesJoin](./XpackUsageEqlFeaturesJoin.md) |   | +| `keys` | [XpackUsageEqlFeaturesKeys](./XpackUsageEqlFeaturesKeys.md) |   | +| `pipes` | [XpackUsageEqlFeaturesPipes](./XpackUsageEqlFeaturesPipes.md) |   | +| `sequence` | [uint](./uint.md) |   | +| `sequences` | [XpackUsageEqlFeaturesSequences](./XpackUsageEqlFeaturesSequences.md) |   | diff --git a/docs/reference/api/XpackUsageEqlFeaturesJoin.md b/docs/reference/api/XpackUsageEqlFeaturesJoin.md new file mode 100644 index 000000000..aaed538cb --- /dev/null +++ b/docs/reference/api/XpackUsageEqlFeaturesJoin.md @@ -0,0 +1,9 @@ +## Interface `XpackUsageEqlFeaturesJoin` + +| Name | Type | Description | +| - | - | - | +| `join_queries_five_or_more` | [uint](./uint.md) |   | +| `join_queries_four` | [uint](./uint.md) |   | +| `join_queries_three` | [uint](./uint.md) |   | +| `join_queries_two` | [uint](./uint.md) |   | +| `join_until` | [uint](./uint.md) |   | diff --git a/docs/reference/api/XpackUsageEqlFeaturesKeys.md b/docs/reference/api/XpackUsageEqlFeaturesKeys.md new file mode 100644 index 000000000..f1e523461 --- /dev/null +++ b/docs/reference/api/XpackUsageEqlFeaturesKeys.md @@ -0,0 +1,9 @@ +## Interface `XpackUsageEqlFeaturesKeys` + +| Name | Type | Description | +| - | - | - | +| `join_keys_five_or_more` | [uint](./uint.md) |   | +| `join_keys_four` | [uint](./uint.md) |   | +| `join_keys_one` | [uint](./uint.md) |   | +| `join_keys_three` | [uint](./uint.md) |   | +| `join_keys_two` | [uint](./uint.md) |   | diff --git a/docs/reference/api/XpackUsageEqlFeaturesPipes.md b/docs/reference/api/XpackUsageEqlFeaturesPipes.md new file mode 100644 index 000000000..3a3f8bad5 --- /dev/null +++ b/docs/reference/api/XpackUsageEqlFeaturesPipes.md @@ -0,0 +1,6 @@ +## Interface `XpackUsageEqlFeaturesPipes` + +| Name | Type | Description | +| - | - | - | +| `pipe_head` | [uint](./uint.md) |   | +| `pipe_tail` | [uint](./uint.md) |   | diff --git a/docs/reference/api/XpackUsageEqlFeaturesSequences.md b/docs/reference/api/XpackUsageEqlFeaturesSequences.md new file mode 100644 index 000000000..a620710bd --- /dev/null +++ b/docs/reference/api/XpackUsageEqlFeaturesSequences.md @@ -0,0 +1,10 @@ +## Interface `XpackUsageEqlFeaturesSequences` + +| Name | Type | Description | +| - | - | - | +| `sequence_maxspan` | [uint](./uint.md) |   | +| `sequence_queries_five_or_more` | [uint](./uint.md) |   | +| `sequence_queries_four` | [uint](./uint.md) |   | +| `sequence_queries_three` | [uint](./uint.md) |   | +| `sequence_queries_two` | [uint](./uint.md) |   | +| `sequence_until` | [uint](./uint.md) |   | diff --git a/docs/reference/api/XpackUsageFeatureToggle.md b/docs/reference/api/XpackUsageFeatureToggle.md new file mode 100644 index 000000000..f005b84d3 --- /dev/null +++ b/docs/reference/api/XpackUsageFeatureToggle.md @@ -0,0 +1,5 @@ +## Interface `XpackUsageFeatureToggle` + +| Name | Type | Description | +| - | - | - | +| `enabled` | boolean |   | diff --git a/docs/reference/api/XpackUsageFlattened.md b/docs/reference/api/XpackUsageFlattened.md new file mode 100644 index 000000000..65cabca7d --- /dev/null +++ b/docs/reference/api/XpackUsageFlattened.md @@ -0,0 +1,5 @@ +## Interface `XpackUsageFlattened` + +| Name | Type | Description | +| - | - | - | +| `field_count` | [integer](./integer.md) |   | diff --git a/docs/reference/api/XpackUsageHealthStatistics.md b/docs/reference/api/XpackUsageHealthStatistics.md new file mode 100644 index 000000000..d442df5d6 --- /dev/null +++ b/docs/reference/api/XpackUsageHealthStatistics.md @@ -0,0 +1,5 @@ +## Interface `XpackUsageHealthStatistics` + +| Name | Type | Description | +| - | - | - | +| `invocations` | [XpackUsageInvocations](./XpackUsageInvocations.md) |   | diff --git a/docs/reference/api/XpackUsageIlm.md b/docs/reference/api/XpackUsageIlm.md new file mode 100644 index 000000000..b5cd7fc01 --- /dev/null +++ b/docs/reference/api/XpackUsageIlm.md @@ -0,0 +1,6 @@ +## Interface `XpackUsageIlm` + +| Name | Type | Description | +| - | - | - | +| `policy_count` | [integer](./integer.md) |   | +| `policy_stats` | [XpackUsageIlmPolicyStatistics](./XpackUsageIlmPolicyStatistics.md)[] |   | diff --git a/docs/reference/api/XpackUsageIlmPolicyStatistics.md b/docs/reference/api/XpackUsageIlmPolicyStatistics.md new file mode 100644 index 000000000..f5242b7e1 --- /dev/null +++ b/docs/reference/api/XpackUsageIlmPolicyStatistics.md @@ -0,0 +1,6 @@ +## Interface `XpackUsageIlmPolicyStatistics` + +| Name | Type | Description | +| - | - | - | +| `indices_managed` | [integer](./integer.md) |   | +| `phases` | [XpackUsagePhases](./XpackUsagePhases.md) |   | diff --git a/docs/reference/api/XpackUsageInvocations.md b/docs/reference/api/XpackUsageInvocations.md new file mode 100644 index 000000000..258bbe0d6 --- /dev/null +++ b/docs/reference/api/XpackUsageInvocations.md @@ -0,0 +1,5 @@ +## Interface `XpackUsageInvocations` + +| Name | Type | Description | +| - | - | - | +| `total` | [long](./long.md) |   | diff --git a/docs/reference/api/XpackUsageIpFilter.md b/docs/reference/api/XpackUsageIpFilter.md new file mode 100644 index 000000000..2806edf23 --- /dev/null +++ b/docs/reference/api/XpackUsageIpFilter.md @@ -0,0 +1,6 @@ +## Interface `XpackUsageIpFilter` + +| Name | Type | Description | +| - | - | - | +| `http` | boolean |   | +| `transport` | boolean |   | diff --git a/docs/reference/api/XpackUsageJobUsage.md b/docs/reference/api/XpackUsageJobUsage.md new file mode 100644 index 000000000..0a7a922e0 --- /dev/null +++ b/docs/reference/api/XpackUsageJobUsage.md @@ -0,0 +1,9 @@ +## Interface `XpackUsageJobUsage` + +| Name | Type | Description | +| - | - | - | +| `count` | [integer](./integer.md) |   | +| `created_by` | Record |   | +| `detectors` | [MlJobStatistics](./MlJobStatistics.md) |   | +| `forecasts` | [XpackUsageMlJobForecasts](./XpackUsageMlJobForecasts.md) |   | +| `model_size` | [MlJobStatistics](./MlJobStatistics.md) |   | diff --git a/docs/reference/api/XpackUsageMachineLearning.md b/docs/reference/api/XpackUsageMachineLearning.md new file mode 100644 index 000000000..8723a97d5 --- /dev/null +++ b/docs/reference/api/XpackUsageMachineLearning.md @@ -0,0 +1,9 @@ +## Interface `XpackUsageMachineLearning` + +| Name | Type | Description | +| - | - | - | +| `data_frame_analytics_jobs` | [XpackUsageMlDataFrameAnalyticsJobs](./XpackUsageMlDataFrameAnalyticsJobs.md) |   | +| `datafeeds` | Record |   | +| `inference` | [XpackUsageMlInference](./XpackUsageMlInference.md) |   | +| `jobs` | Record | Job usage statistics. The `_all` entry is always present and gathers statistics for all jobs. | +| `node_count` | [integer](./integer.md) |   | diff --git a/docs/reference/api/XpackUsageMlCounter.md b/docs/reference/api/XpackUsageMlCounter.md new file mode 100644 index 000000000..2a1963d07 --- /dev/null +++ b/docs/reference/api/XpackUsageMlCounter.md @@ -0,0 +1,5 @@ +## Interface `XpackUsageMlCounter` + +| Name | Type | Description | +| - | - | - | +| `count` | [long](./long.md) |   | diff --git a/docs/reference/api/XpackUsageMlDataFrameAnalyticsJobs.md b/docs/reference/api/XpackUsageMlDataFrameAnalyticsJobs.md new file mode 100644 index 000000000..1a9597e10 --- /dev/null +++ b/docs/reference/api/XpackUsageMlDataFrameAnalyticsJobs.md @@ -0,0 +1,8 @@ +## Interface `XpackUsageMlDataFrameAnalyticsJobs` + +| Name | Type | Description | +| - | - | - | +| `_all` | [XpackUsageMlDataFrameAnalyticsJobsCount](./XpackUsageMlDataFrameAnalyticsJobsCount.md) |   | +| `analysis_counts` | [XpackUsageMlDataFrameAnalyticsJobsAnalysis](./XpackUsageMlDataFrameAnalyticsJobsAnalysis.md) |   | +| `memory_usage` | [XpackUsageMlDataFrameAnalyticsJobsMemory](./XpackUsageMlDataFrameAnalyticsJobsMemory.md) |   | +| `stopped` | [XpackUsageMlDataFrameAnalyticsJobsCount](./XpackUsageMlDataFrameAnalyticsJobsCount.md) |   | diff --git a/docs/reference/api/XpackUsageMlDataFrameAnalyticsJobsAnalysis.md b/docs/reference/api/XpackUsageMlDataFrameAnalyticsJobsAnalysis.md new file mode 100644 index 000000000..90c209528 --- /dev/null +++ b/docs/reference/api/XpackUsageMlDataFrameAnalyticsJobsAnalysis.md @@ -0,0 +1,7 @@ +## Interface `XpackUsageMlDataFrameAnalyticsJobsAnalysis` + +| Name | Type | Description | +| - | - | - | +| `classification` | [integer](./integer.md) |   | +| `outlier_detection` | [integer](./integer.md) |   | +| `regression` | [integer](./integer.md) |   | diff --git a/docs/reference/api/XpackUsageMlDataFrameAnalyticsJobsCount.md b/docs/reference/api/XpackUsageMlDataFrameAnalyticsJobsCount.md new file mode 100644 index 000000000..2e9952165 --- /dev/null +++ b/docs/reference/api/XpackUsageMlDataFrameAnalyticsJobsCount.md @@ -0,0 +1,5 @@ +## Interface `XpackUsageMlDataFrameAnalyticsJobsCount` + +| Name | Type | Description | +| - | - | - | +| `count` | [long](./long.md) |   | diff --git a/docs/reference/api/XpackUsageMlDataFrameAnalyticsJobsMemory.md b/docs/reference/api/XpackUsageMlDataFrameAnalyticsJobsMemory.md new file mode 100644 index 000000000..2c97e8bf7 --- /dev/null +++ b/docs/reference/api/XpackUsageMlDataFrameAnalyticsJobsMemory.md @@ -0,0 +1,5 @@ +## Interface `XpackUsageMlDataFrameAnalyticsJobsMemory` + +| Name | Type | Description | +| - | - | - | +| `peak_usage_bytes` | [MlJobStatistics](./MlJobStatistics.md) |   | diff --git a/docs/reference/api/XpackUsageMlInference.md b/docs/reference/api/XpackUsageMlInference.md new file mode 100644 index 000000000..6995e3a81 --- /dev/null +++ b/docs/reference/api/XpackUsageMlInference.md @@ -0,0 +1,7 @@ +## Interface `XpackUsageMlInference` + +| Name | Type | Description | +| - | - | - | +| `deployments` | [XpackUsageMlInferenceDeployments](./XpackUsageMlInferenceDeployments.md) |   | +| `ingest_processors` | Record |   | +| `trained_models` | [XpackUsageMlInferenceTrainedModels](./XpackUsageMlInferenceTrainedModels.md) |   | diff --git a/docs/reference/api/XpackUsageMlInferenceDeployments.md b/docs/reference/api/XpackUsageMlInferenceDeployments.md new file mode 100644 index 000000000..71fc0e8f3 --- /dev/null +++ b/docs/reference/api/XpackUsageMlInferenceDeployments.md @@ -0,0 +1,8 @@ +## Interface `XpackUsageMlInferenceDeployments` + +| Name | Type | Description | +| - | - | - | +| `count` | [integer](./integer.md) |   | +| `inference_counts` | [MlJobStatistics](./MlJobStatistics.md) |   | +| `model_sizes_bytes` | [MlJobStatistics](./MlJobStatistics.md) |   | +| `time_ms` | [XpackUsageMlInferenceDeploymentsTimeMs](./XpackUsageMlInferenceDeploymentsTimeMs.md) |   | diff --git a/docs/reference/api/XpackUsageMlInferenceDeploymentsTimeMs.md b/docs/reference/api/XpackUsageMlInferenceDeploymentsTimeMs.md new file mode 100644 index 000000000..2962442c9 --- /dev/null +++ b/docs/reference/api/XpackUsageMlInferenceDeploymentsTimeMs.md @@ -0,0 +1,5 @@ +## Interface `XpackUsageMlInferenceDeploymentsTimeMs` + +| Name | Type | Description | +| - | - | - | +| `avg` | [double](./double.md) |   | diff --git a/docs/reference/api/XpackUsageMlInferenceIngestProcessor.md b/docs/reference/api/XpackUsageMlInferenceIngestProcessor.md new file mode 100644 index 000000000..1d0faf3a5 --- /dev/null +++ b/docs/reference/api/XpackUsageMlInferenceIngestProcessor.md @@ -0,0 +1,8 @@ +## Interface `XpackUsageMlInferenceIngestProcessor` + +| Name | Type | Description | +| - | - | - | +| `num_docs_processed` | [XpackUsageMlInferenceIngestProcessorCount](./XpackUsageMlInferenceIngestProcessorCount.md) |   | +| `num_failures` | [XpackUsageMlInferenceIngestProcessorCount](./XpackUsageMlInferenceIngestProcessorCount.md) |   | +| `pipelines` | [XpackUsageMlCounter](./XpackUsageMlCounter.md) |   | +| `time_ms` | [XpackUsageMlInferenceIngestProcessorCount](./XpackUsageMlInferenceIngestProcessorCount.md) |   | diff --git a/docs/reference/api/XpackUsageMlInferenceIngestProcessorCount.md b/docs/reference/api/XpackUsageMlInferenceIngestProcessorCount.md new file mode 100644 index 000000000..9b8801d03 --- /dev/null +++ b/docs/reference/api/XpackUsageMlInferenceIngestProcessorCount.md @@ -0,0 +1,7 @@ +## Interface `XpackUsageMlInferenceIngestProcessorCount` + +| Name | Type | Description | +| - | - | - | +| `max` | [long](./long.md) |   | +| `min` | [long](./long.md) |   | +| `sum` | [long](./long.md) |   | diff --git a/docs/reference/api/XpackUsageMlInferenceTrainedModels.md b/docs/reference/api/XpackUsageMlInferenceTrainedModels.md new file mode 100644 index 000000000..af7c74fbc --- /dev/null +++ b/docs/reference/api/XpackUsageMlInferenceTrainedModels.md @@ -0,0 +1,9 @@ +## Interface `XpackUsageMlInferenceTrainedModels` + +| Name | Type | Description | +| - | - | - | +| `_all` | [XpackUsageMlCounter](./XpackUsageMlCounter.md) |   | +| `count` | [XpackUsageMlInferenceTrainedModelsCount](./XpackUsageMlInferenceTrainedModelsCount.md) |   | +| `estimated_heap_memory_usage_bytes` | [MlJobStatistics](./MlJobStatistics.md) |   | +| `estimated_operations` | [MlJobStatistics](./MlJobStatistics.md) |   | +| `model_size_bytes` | [MlJobStatistics](./MlJobStatistics.md) |   | diff --git a/docs/reference/api/XpackUsageMlInferenceTrainedModelsCount.md b/docs/reference/api/XpackUsageMlInferenceTrainedModelsCount.md new file mode 100644 index 000000000..2bed7a914 --- /dev/null +++ b/docs/reference/api/XpackUsageMlInferenceTrainedModelsCount.md @@ -0,0 +1,12 @@ +## Interface `XpackUsageMlInferenceTrainedModelsCount` + +| Name | Type | Description | +| - | - | - | +| `classification` | [long](./long.md) |   | +| `ner` | [long](./long.md) |   | +| `other` | [long](./long.md) |   | +| `pass_through` | [long](./long.md) |   | +| `prepackaged` | [long](./long.md) |   | +| `regression` | [long](./long.md) |   | +| `text_embedding` | [long](./long.md) |   | +| `total` | [long](./long.md) |   | diff --git a/docs/reference/api/XpackUsageMlJobForecasts.md b/docs/reference/api/XpackUsageMlJobForecasts.md new file mode 100644 index 000000000..a3736fa28 --- /dev/null +++ b/docs/reference/api/XpackUsageMlJobForecasts.md @@ -0,0 +1,6 @@ +## Interface `XpackUsageMlJobForecasts` + +| Name | Type | Description | +| - | - | - | +| `forecasted_jobs` | [long](./long.md) |   | +| `total` | [long](./long.md) |   | diff --git a/docs/reference/api/XpackUsageMonitoring.md b/docs/reference/api/XpackUsageMonitoring.md new file mode 100644 index 000000000..1a3e8e93e --- /dev/null +++ b/docs/reference/api/XpackUsageMonitoring.md @@ -0,0 +1,6 @@ +## Interface `XpackUsageMonitoring` + +| Name | Type | Description | +| - | - | - | +| `collection_enabled` | boolean |   | +| `enabled_exporters` | Record |   | diff --git a/docs/reference/api/XpackUsagePhase.md b/docs/reference/api/XpackUsagePhase.md new file mode 100644 index 000000000..f5b04698d --- /dev/null +++ b/docs/reference/api/XpackUsagePhase.md @@ -0,0 +1,6 @@ +## Interface `XpackUsagePhase` + +| Name | Type | Description | +| - | - | - | +| `actions` | string[] |   | +| `min_age` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> |   | diff --git a/docs/reference/api/XpackUsagePhases.md b/docs/reference/api/XpackUsagePhases.md new file mode 100644 index 000000000..29f6dd668 --- /dev/null +++ b/docs/reference/api/XpackUsagePhases.md @@ -0,0 +1,9 @@ +## Interface `XpackUsagePhases` + +| Name | Type | Description | +| - | - | - | +| `cold` | [XpackUsagePhase](./XpackUsagePhase.md) |   | +| `delete` | [XpackUsagePhase](./XpackUsagePhase.md) |   | +| `frozen` | [XpackUsagePhase](./XpackUsagePhase.md) |   | +| `hot` | [XpackUsagePhase](./XpackUsagePhase.md) |   | +| `warm` | [XpackUsagePhase](./XpackUsagePhase.md) |   | diff --git a/docs/reference/api/XpackUsageQuery.md b/docs/reference/api/XpackUsageQuery.md new file mode 100644 index 000000000..45b9e298c --- /dev/null +++ b/docs/reference/api/XpackUsageQuery.md @@ -0,0 +1,8 @@ +## Interface `XpackUsageQuery` + +| Name | Type | Description | +| - | - | - | +| `count` | [integer](./integer.md) |   | +| `failed` | [integer](./integer.md) |   | +| `paging` | [integer](./integer.md) |   | +| `total` | [integer](./integer.md) |   | diff --git a/docs/reference/api/XpackUsageRealm.md b/docs/reference/api/XpackUsageRealm.md new file mode 100644 index 000000000..7c665c820 --- /dev/null +++ b/docs/reference/api/XpackUsageRealm.md @@ -0,0 +1,12 @@ +## Interface `XpackUsageRealm` + +| Name | Type | Description | +| - | - | - | +| `cache` | [XpackUsageRealmCache](./XpackUsageRealmCache.md)[] |   | +| `has_authorization_realms` | boolean[] |   | +| `has_default_username_pattern` | boolean[] |   | +| `has_truststore` | boolean[] |   | +| `is_authentication_delegated` | boolean[] |   | +| `name` | string[] |   | +| `order` | [long](./long.md)[] |   | +| `size` | [long](./long.md)[] |   | diff --git a/docs/reference/api/XpackUsageRealmCache.md b/docs/reference/api/XpackUsageRealmCache.md new file mode 100644 index 000000000..09e6a9e71 --- /dev/null +++ b/docs/reference/api/XpackUsageRealmCache.md @@ -0,0 +1,5 @@ +## Interface `XpackUsageRealmCache` + +| Name | Type | Description | +| - | - | - | +| `size` | [long](./long.md) |   | diff --git a/docs/reference/api/XpackUsageRequest.md b/docs/reference/api/XpackUsageRequest.md new file mode 100644 index 000000000..277947ac4 --- /dev/null +++ b/docs/reference/api/XpackUsageRequest.md @@ -0,0 +1,7 @@ +## Interface `XpackUsageRequest` + +| Name | Type | Description | +| - | - | - | +| `body` | string | ({ [key: string]: any; } & { master_timeout?: never; }) | All values in `body` will be added to the request body. | +| `master_timeout` | [Duration](./Duration.md) | The period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. To indicate that the request should never timeout, set it to `-1`. | +| `querystring` | { [key: string]: any; } & { master_timeout?: never; } | All values in `querystring` will be added to the request querystring. | diff --git a/docs/reference/api/XpackUsageResponse.md b/docs/reference/api/XpackUsageResponse.md new file mode 100644 index 000000000..4d43f1ee7 --- /dev/null +++ b/docs/reference/api/XpackUsageResponse.md @@ -0,0 +1,32 @@ +## Interface `XpackUsageResponse` + +| Name | Type | Description | +| - | - | - | +| `aggregate_metric` | [XpackUsageBase](./XpackUsageBase.md) |   | +| `analytics` | [XpackUsageAnalytics](./XpackUsageAnalytics.md) |   | +| `archive` | [XpackUsageArchive](./XpackUsageArchive.md) |   | +| `ccr` | [XpackUsageCcr](./XpackUsageCcr.md) |   | +| `data_frame` | [XpackUsageBase](./XpackUsageBase.md) |   | +| `data_science` | [XpackUsageBase](./XpackUsageBase.md) |   | +| `data_streams` | [XpackUsageDataStreams](./XpackUsageDataStreams.md) |   | +| `data_tiers` | [XpackUsageDataTiers](./XpackUsageDataTiers.md) |   | +| `enrich` | [XpackUsageBase](./XpackUsageBase.md) |   | +| `eql` | [XpackUsageEql](./XpackUsageEql.md) |   | +| `flattened` | [XpackUsageFlattened](./XpackUsageFlattened.md) |   | +| `graph` | [XpackUsageBase](./XpackUsageBase.md) |   | +| `health_api` | [XpackUsageHealthStatistics](./XpackUsageHealthStatistics.md) |   | +| `ilm` | [XpackUsageIlm](./XpackUsageIlm.md) |   | +| `logstash` | [XpackUsageBase](./XpackUsageBase.md) |   | +| `ml` | [XpackUsageMachineLearning](./XpackUsageMachineLearning.md) |   | +| `monitoring` | [XpackUsageMonitoring](./XpackUsageMonitoring.md) |   | +| `rollup` | [XpackUsageBase](./XpackUsageBase.md) |   | +| `runtime_fields` | [XpackUsageRuntimeFieldTypes](./XpackUsageRuntimeFieldTypes.md) |   | +| `searchable_snapshots` | [XpackUsageSearchableSnapshots](./XpackUsageSearchableSnapshots.md) |   | +| `security` | [XpackUsageSecurity](./XpackUsageSecurity.md) |   | +| `slm` | [XpackUsageSlm](./XpackUsageSlm.md) |   | +| `spatial` | [XpackUsageBase](./XpackUsageBase.md) |   | +| `sql` | [XpackUsageSql](./XpackUsageSql.md) |   | +| `transform` | [XpackUsageBase](./XpackUsageBase.md) |   | +| `vectors` | [XpackUsageVector](./XpackUsageVector.md) |   | +| `voting_only` | [XpackUsageBase](./XpackUsageBase.md) |   | +| `watcher` | [XpackUsageWatcher](./XpackUsageWatcher.md) |   | diff --git a/docs/reference/api/XpackUsageRoleMapping.md b/docs/reference/api/XpackUsageRoleMapping.md new file mode 100644 index 000000000..e56f6be9f --- /dev/null +++ b/docs/reference/api/XpackUsageRoleMapping.md @@ -0,0 +1,6 @@ +## Interface `XpackUsageRoleMapping` + +| Name | Type | Description | +| - | - | - | +| `enabled` | [integer](./integer.md) |   | +| `size` | [integer](./integer.md) |   | diff --git a/docs/reference/api/XpackUsageRuntimeFieldTypes.md b/docs/reference/api/XpackUsageRuntimeFieldTypes.md new file mode 100644 index 000000000..a9a1cf5d5 --- /dev/null +++ b/docs/reference/api/XpackUsageRuntimeFieldTypes.md @@ -0,0 +1,5 @@ +## Interface `XpackUsageRuntimeFieldTypes` + +| Name | Type | Description | +| - | - | - | +| `field_types` | [XpackUsageRuntimeFieldsType](./XpackUsageRuntimeFieldsType.md)[] |   | diff --git a/docs/reference/api/XpackUsageRuntimeFieldsType.md b/docs/reference/api/XpackUsageRuntimeFieldsType.md new file mode 100644 index 000000000..013ad36a9 --- /dev/null +++ b/docs/reference/api/XpackUsageRuntimeFieldsType.md @@ -0,0 +1,18 @@ +## Interface `XpackUsageRuntimeFieldsType` + +| Name | Type | Description | +| - | - | - | +| `chars_max` | [long](./long.md) |   | +| `chars_total` | [long](./long.md) |   | +| `count` | [long](./long.md) |   | +| `doc_max` | [long](./long.md) |   | +| `doc_total` | [long](./long.md) |   | +| `index_count` | [long](./long.md) |   | +| `lang` | string[] |   | +| `lines_max` | [long](./long.md) |   | +| `lines_total` | [long](./long.md) |   | +| `name` | [Field](./Field.md) |   | +| `scriptless_count` | [long](./long.md) |   | +| `shadowed_count` | [long](./long.md) |   | +| `source_max` | [long](./long.md) |   | +| `source_total` | [long](./long.md) |   | diff --git a/docs/reference/api/XpackUsageSearchableSnapshots.md b/docs/reference/api/XpackUsageSearchableSnapshots.md new file mode 100644 index 000000000..16bdf0c14 --- /dev/null +++ b/docs/reference/api/XpackUsageSearchableSnapshots.md @@ -0,0 +1,7 @@ +## Interface `XpackUsageSearchableSnapshots` + +| Name | Type | Description | +| - | - | - | +| `full_copy_indices_count` | [integer](./integer.md) |   | +| `indices_count` | [integer](./integer.md) |   | +| `shared_cache_indices_count` | [integer](./integer.md) |   | diff --git a/docs/reference/api/XpackUsageSecurity.md b/docs/reference/api/XpackUsageSecurity.md new file mode 100644 index 000000000..0f6cd9774 --- /dev/null +++ b/docs/reference/api/XpackUsageSecurity.md @@ -0,0 +1,16 @@ +## Interface `XpackUsageSecurity` + +| Name | Type | Description | +| - | - | - | +| `anonymous` | [XpackUsageFeatureToggle](./XpackUsageFeatureToggle.md) |   | +| `api_key_service` | [XpackUsageFeatureToggle](./XpackUsageFeatureToggle.md) |   | +| `audit` | [XpackUsageAudit](./XpackUsageAudit.md) |   | +| `fips_140` | [XpackUsageFeatureToggle](./XpackUsageFeatureToggle.md) |   | +| `ipfilter` | [XpackUsageIpFilter](./XpackUsageIpFilter.md) |   | +| `operator_privileges` | [XpackUsageBase](./XpackUsageBase.md) |   | +| `realms` | Record |   | +| `role_mapping` | Record |   | +| `roles` | [XpackUsageSecurityRoles](./XpackUsageSecurityRoles.md) |   | +| `ssl` | [XpackUsageSsl](./XpackUsageSsl.md) |   | +| `system_key` | [XpackUsageFeatureToggle](./XpackUsageFeatureToggle.md) |   | +| `token_service` | [XpackUsageFeatureToggle](./XpackUsageFeatureToggle.md) |   | diff --git a/docs/reference/api/XpackUsageSecurityRoles.md b/docs/reference/api/XpackUsageSecurityRoles.md new file mode 100644 index 000000000..00203010c --- /dev/null +++ b/docs/reference/api/XpackUsageSecurityRoles.md @@ -0,0 +1,7 @@ +## Interface `XpackUsageSecurityRoles` + +| Name | Type | Description | +| - | - | - | +| `dls` | [XpackUsageSecurityRolesDls](./XpackUsageSecurityRolesDls.md) |   | +| `file` | [XpackUsageSecurityRolesFile](./XpackUsageSecurityRolesFile.md) |   | +| `native` | [XpackUsageSecurityRolesNative](./XpackUsageSecurityRolesNative.md) |   | diff --git a/docs/reference/api/XpackUsageSecurityRolesDls.md b/docs/reference/api/XpackUsageSecurityRolesDls.md new file mode 100644 index 000000000..0981d2eba --- /dev/null +++ b/docs/reference/api/XpackUsageSecurityRolesDls.md @@ -0,0 +1,5 @@ +## Interface `XpackUsageSecurityRolesDls` + +| Name | Type | Description | +| - | - | - | +| `bit_set_cache` | [XpackUsageSecurityRolesDlsBitSetCache](./XpackUsageSecurityRolesDlsBitSetCache.md) |   | diff --git a/docs/reference/api/XpackUsageSecurityRolesDlsBitSetCache.md b/docs/reference/api/XpackUsageSecurityRolesDlsBitSetCache.md new file mode 100644 index 000000000..c78d236bf --- /dev/null +++ b/docs/reference/api/XpackUsageSecurityRolesDlsBitSetCache.md @@ -0,0 +1,7 @@ +## Interface `XpackUsageSecurityRolesDlsBitSetCache` + +| Name | Type | Description | +| - | - | - | +| `count` | [integer](./integer.md) |   | +| `memory_in_bytes` | [ulong](./ulong.md) |   | +| `memory` | [ByteSize](./ByteSize.md) |   | diff --git a/docs/reference/api/XpackUsageSecurityRolesFile.md b/docs/reference/api/XpackUsageSecurityRolesFile.md new file mode 100644 index 000000000..6948b259b --- /dev/null +++ b/docs/reference/api/XpackUsageSecurityRolesFile.md @@ -0,0 +1,7 @@ +## Interface `XpackUsageSecurityRolesFile` + +| Name | Type | Description | +| - | - | - | +| `dls` | boolean |   | +| `fls` | boolean |   | +| `size` | [long](./long.md) |   | diff --git a/docs/reference/api/XpackUsageSecurityRolesNative.md b/docs/reference/api/XpackUsageSecurityRolesNative.md new file mode 100644 index 000000000..2a5e8fe75 --- /dev/null +++ b/docs/reference/api/XpackUsageSecurityRolesNative.md @@ -0,0 +1,7 @@ +## Interface `XpackUsageSecurityRolesNative` + +| Name | Type | Description | +| - | - | - | +| `dls` | boolean |   | +| `fls` | boolean |   | +| `size` | [long](./long.md) |   | diff --git a/docs/reference/api/XpackUsageSlm.md b/docs/reference/api/XpackUsageSlm.md new file mode 100644 index 000000000..fb94e4490 --- /dev/null +++ b/docs/reference/api/XpackUsageSlm.md @@ -0,0 +1,6 @@ +## Interface `XpackUsageSlm` + +| Name | Type | Description | +| - | - | - | +| `policy_count` | [integer](./integer.md) |   | +| `policy_stats` | [SlmStatistics](./SlmStatistics.md) |   | diff --git a/docs/reference/api/XpackUsageSql.md b/docs/reference/api/XpackUsageSql.md new file mode 100644 index 000000000..a82039d4f --- /dev/null +++ b/docs/reference/api/XpackUsageSql.md @@ -0,0 +1,6 @@ +## Interface `XpackUsageSql` + +| Name | Type | Description | +| - | - | - | +| `features` | Record |   | +| `queries` | Record |   | diff --git a/docs/reference/api/XpackUsageSsl.md b/docs/reference/api/XpackUsageSsl.md new file mode 100644 index 000000000..82a95065e --- /dev/null +++ b/docs/reference/api/XpackUsageSsl.md @@ -0,0 +1,6 @@ +## Interface `XpackUsageSsl` + +| Name | Type | Description | +| - | - | - | +| `http` | [XpackUsageFeatureToggle](./XpackUsageFeatureToggle.md) |   | +| `transport` | [XpackUsageFeatureToggle](./XpackUsageFeatureToggle.md) |   | diff --git a/docs/reference/api/XpackUsageVector.md b/docs/reference/api/XpackUsageVector.md new file mode 100644 index 000000000..cf0a36ed8 --- /dev/null +++ b/docs/reference/api/XpackUsageVector.md @@ -0,0 +1,7 @@ +## Interface `XpackUsageVector` + +| Name | Type | Description | +| - | - | - | +| `dense_vector_dims_avg_count` | [integer](./integer.md) |   | +| `dense_vector_fields_count` | [integer](./integer.md) |   | +| `sparse_vector_fields_count` | [integer](./integer.md) |   | diff --git a/docs/reference/api/XpackUsageWatcher.md b/docs/reference/api/XpackUsageWatcher.md new file mode 100644 index 000000000..dd7872cb5 --- /dev/null +++ b/docs/reference/api/XpackUsageWatcher.md @@ -0,0 +1,7 @@ +## Interface `XpackUsageWatcher` + +| Name | Type | Description | +| - | - | - | +| `count` | [XpackUsageCounter](./XpackUsageCounter.md) |   | +| `execution` | [XpackUsageWatcherActions](./XpackUsageWatcherActions.md) |   | +| `watch` | [XpackUsageWatcherWatch](./XpackUsageWatcherWatch.md) |   | diff --git a/docs/reference/api/XpackUsageWatcherActionTotals.md b/docs/reference/api/XpackUsageWatcherActionTotals.md new file mode 100644 index 000000000..9017bdd21 --- /dev/null +++ b/docs/reference/api/XpackUsageWatcherActionTotals.md @@ -0,0 +1,6 @@ +## Interface `XpackUsageWatcherActionTotals` + +| Name | Type | Description | +| - | - | - | +| `total_time_in_ms` | [DurationValue](./DurationValue.md)<[UnitMillis](./UnitMillis.md)> |   | +| `total` | [Duration](./Duration.md) |   | diff --git a/docs/reference/api/XpackUsageWatcherActions.md b/docs/reference/api/XpackUsageWatcherActions.md new file mode 100644 index 000000000..3a2d4e02e --- /dev/null +++ b/docs/reference/api/XpackUsageWatcherActions.md @@ -0,0 +1,5 @@ +## Interface `XpackUsageWatcherActions` + +| Name | Type | Description | +| - | - | - | +| `actions` | Record<[Name](./Name.md), [XpackUsageWatcherActionTotals](./XpackUsageWatcherActionTotals.md)> |   | diff --git a/docs/reference/api/XpackUsageWatcherWatch.md b/docs/reference/api/XpackUsageWatcherWatch.md new file mode 100644 index 000000000..aadb45a9a --- /dev/null +++ b/docs/reference/api/XpackUsageWatcherWatch.md @@ -0,0 +1,8 @@ +## Interface `XpackUsageWatcherWatch` + +| Name | Type | Description | +| - | - | - | +| `action` | Record<[Name](./Name.md), [XpackUsageCounter](./XpackUsageCounter.md)> |   | +| `condition` | Record<[Name](./Name.md), [XpackUsageCounter](./XpackUsageCounter.md)> |   | +| `input` | Record<[Name](./Name.md), [XpackUsageCounter](./XpackUsageCounter.md)> |   | +| `trigger` | [XpackUsageWatcherWatchTrigger](./XpackUsageWatcherWatchTrigger.md) |   | diff --git a/docs/reference/api/XpackUsageWatcherWatchTrigger.md b/docs/reference/api/XpackUsageWatcherWatchTrigger.md new file mode 100644 index 000000000..c4572bfdf --- /dev/null +++ b/docs/reference/api/XpackUsageWatcherWatchTrigger.md @@ -0,0 +1,6 @@ +## Interface `XpackUsageWatcherWatchTrigger` + +| Name | Type | Description | +| - | - | - | +| `_all` | [XpackUsageCounter](./XpackUsageCounter.md) |   | +| `schedule` | [XpackUsageWatcherWatchTriggerSchedule](./XpackUsageWatcherWatchTriggerSchedule.md) |   | diff --git a/docs/reference/api/XpackUsageWatcherWatchTriggerSchedule.md b/docs/reference/api/XpackUsageWatcherWatchTriggerSchedule.md new file mode 100644 index 000000000..1eb3a9e49 --- /dev/null +++ b/docs/reference/api/XpackUsageWatcherWatchTriggerSchedule.md @@ -0,0 +1,6 @@ +## Interface `XpackUsageWatcherWatchTriggerSchedule` + +| Name | Type | Description | +| - | - | - | +| `_all` | [XpackUsageCounter](./XpackUsageCounter.md) |   | +| `cron` | [XpackUsageCounter](./XpackUsageCounter.md) |   | diff --git a/docs/reference/api/byte.md b/docs/reference/api/byte.md new file mode 100644 index 000000000..98a472e84 --- /dev/null +++ b/docs/reference/api/byte.md @@ -0,0 +1,4 @@ +## `byte` +::: +type byte = number; +::: diff --git a/docs/reference/api/double.md b/docs/reference/api/double.md new file mode 100644 index 000000000..385ded8a8 --- /dev/null +++ b/docs/reference/api/double.md @@ -0,0 +1,4 @@ +## `double` +::: +type double = number; +::: diff --git a/docs/reference/api/float.md b/docs/reference/api/float.md new file mode 100644 index 000000000..668ba113b --- /dev/null +++ b/docs/reference/api/float.md @@ -0,0 +1,4 @@ +## `float` +::: +type float = number; +::: diff --git a/docs/reference/api/integer.md b/docs/reference/api/integer.md new file mode 100644 index 000000000..62d06e790 --- /dev/null +++ b/docs/reference/api/integer.md @@ -0,0 +1,4 @@ +## `integer` +::: +type integer = number; +::: diff --git a/docs/reference/api/long.md b/docs/reference/api/long.md new file mode 100644 index 000000000..db4818f0e --- /dev/null +++ b/docs/reference/api/long.md @@ -0,0 +1,4 @@ +## `long` +::: +type long = number; +::: diff --git a/docs/reference/api/short.md b/docs/reference/api/short.md new file mode 100644 index 000000000..c6f58e5ba --- /dev/null +++ b/docs/reference/api/short.md @@ -0,0 +1,4 @@ +## `short` +::: +type short = number; +::: diff --git a/docs/reference/api/uint.md b/docs/reference/api/uint.md new file mode 100644 index 000000000..228798433 --- /dev/null +++ b/docs/reference/api/uint.md @@ -0,0 +1,4 @@ +## `uint` +::: +type uint = number; +::: diff --git a/docs/reference/api/ulong.md b/docs/reference/api/ulong.md new file mode 100644 index 000000000..ad621a8ac --- /dev/null +++ b/docs/reference/api/ulong.md @@ -0,0 +1,4 @@ +## `ulong` +::: +type ulong = number; +::: diff --git a/package.json b/package.json index 264f2cecb..a206d0c9f 100644 --- a/package.json +++ b/package.json @@ -27,7 +27,8 @@ "prebuild": "npm run clean-build && npm run lint", "build": "tsc && rm lib/package.json && mv lib/src/* lib/ && rm -rf lib/src", "clean-build": "rimraf ./lib && mkdir lib", - "prepublishOnly": "npm run build" + "prepublishOnly": "npm run build", + "docs": "npm run build && api-extractor run --local && node scripts/docgen.mjs" }, "keywords": [ "elasticsearch", @@ -59,6 +60,7 @@ }, "devDependencies": { "@elastic/request-converter": "9.0.1", + "@microsoft/api-extractor": "^7.52.8", "@sinonjs/fake-timers": "14.0.0", "@types/debug": "4.1.12", "@types/ms": "2.1.0", diff --git a/scripts/docgen.mjs b/scripts/docgen.mjs new file mode 100644 index 000000000..2f2ff1b94 --- /dev/null +++ b/scripts/docgen.mjs @@ -0,0 +1,343 @@ +/* +* Copyright Elasticsearch B.V. and contributors +* SPDX-License-Identifier: Apache-2.0 +*/ + +import path from 'node:path' +import fs from 'node:fs/promises' +import * as Extractor from '@microsoft/api-extractor-model' + +const header = ` +` + +const linkedRefs = new Set() +const documented = new Set() + +function nodesToText(nodes) { + let text = '' + for (const node of nodes) { + if (node.kind === 'Paragraph') { + for (const pNode of node.nodes) { + if (pNode.text) { + text += pNode.text + ' ' + } else if (pNode.kind === 'CodeSpan') { + text += '`' + pNode.code + '`' + } + } + } + } + text = text.replace(/\s+/g, ' ') + return text +} + +const skippableReferences = [ + 'Record', + 'URL', + 'Array', + 'Promise', + 'inspect.custom', + 'http.IncomingHttpHeaders', +] + +function generatePropertyType(tokens) { + let code = '' + tokens.forEach(token => { + if (token.kind === 'Reference' && !skippableReferences.includes(token.text)) { + let { text } = token + if (text.startsWith('T.')) { + text = text.split('.')[1] + } + linkedRefs.add(text) + code += `[${text}](./${text}.md)` + } else { + code += token.text.replace(/\n/g, '') + } + }) + return code.replace(/^export (declare )?/, '').replace(/\s+/g, ' ').trim() +} + +function generateDescription(comment) { + let code = '' + + if (comment == null) return code + + const { summarySection, customBlocks } = comment + + if (summarySection != null || customBlocks != null) { + if (summarySection != null) { + const summary = nodesToText(summarySection.nodes) + code += `${summary}\n\n` + } + + if (customBlocks != null) { + let defaultValue = '' + for (const block of customBlocks) { + if (block.blockTag.tagNameWithUpperCase === '@DEFAULTVALUE') { + defaultValue = nodesToText(block.content.nodes) + } + } + if (defaultValue.length > 0) { + code += `Default value: ${defaultValue}` + } + } + } + + return code.trim() +} + +function generateApiFunction(spec) { + // let code = '```typescript\n' + let code = ':::\n' + code += generatePropertyType(spec.excerptTokens) + code += '\n' + code += ':::\n' + return code +} + +function generateInterface(spec) { + let code = `## Interface \`${spec.displayName}\`\n\n` + code += '| Name | Type | Description |\n' + code += '| - | - | - |\n' + + for (const member of spec.members) { + if (member.propertyTypeExcerpt == null) continue + code += `| \`${member.displayName}\`` + code += ` | ${generatePropertyType(member.propertyTypeExcerpt.spannedTokens)}` + const description = generateDescription(member.tsdocComment, false) + code += ` | ${description.length > 0 ? description : ' '}` + code += ' |\n' + } + + return code +} + +function generateClass(spec) { + let code = `## \`${spec.displayName}\`\n` + + code += '\n### Constructor\n\n' + const cons = spec.members.filter(m => m.kind === 'Constructor') + for (const con of cons) { + // code += '```typescript\n' + code += ':::\n' + code += generatePropertyType(con.excerptTokens).replace(/^constructor/, `new ${spec.displayName}`) + code += '\n' + code += ':::\n' + } + + // generate properties + const props = spec.members.filter(m => m.kind === 'Property') + if (props.length > 0) { + code += '\n### Properties\n\n' + code += '| Name | Type | Description |\n' + code += '| - | - | - |\n' + + for (const prop of props) { + if (prop.propertyTypeExcerpt == null) continue + if (prop.displayName.startsWith('[k')) continue + + code += `| \`${prop.displayName}\`` + code += ` | ${generatePropertyType(prop.propertyTypeExcerpt.spannedTokens)}` + const description = generateDescription(prop.tsdocComment, false) + code += ` | ${description.length > 0 ? description : ' '}` + code += ' |\n' + } + } + + // generate methods + const methods = spec.members.filter(m => m.kind === 'Method') + if (methods.length > 0) { + code += '\n### Methods\n\n' + code += '| Name | Signature | Description |\n' + code += '| - | - | - |\n' + + for (const method of methods) { + code += `| \`${method.displayName}\`` + code += ` | \`${generatePropertyType(method.excerptTokens)}\`` + const description = generateDescription(method.tsdocComment, false) + code += ` | ${description.length > 0 ? description : ' '}` + code += ' |' + } + } + + return code +} + +function generateAlias(spec) { + let code = `## \`${spec.displayName}\`\n` + // code += '```typescript\n' + code += ':::\n' + code += `${generatePropertyType(spec.excerpt.tokens)}\n` + code += ':::\n' + return code +} + +/** + * Generates documentation for ClientOptions interface + * @param spec {Extractor.ApiItem} + * @returns {string} markdown content + */ +// function generateClientOptions (spec) { +// let code = `[reference-client-options-interface]\n\n== ClientOptions\n\n${header}\n\n` +// code += `[[${spec.displayName}]]\n` +// code += `=== ${spec.displayName}\n\n` +// code += generateInterface(spec) +// return code +// } + +// const standardTypes = { +// 'TlsConnectionOptions': 'https://nodejs.org/api/tls.html#tlsconnectoptions-callback[Node.js TLS connection options]', +// } + +/** + * @param spec {Extractor.ApiItem} + * @param model {Extractor.ApiModel} + * @returns string + */ +// function generateClientOptionsReference (spec, model) { +// let code = `${header}\n\n` +// for (const member of spec.members) { +// for (const token of member.excerptTokens) { +// if (token.kind === 'Reference' && !documented.has(token.text)) { +// documented.add(token.text) +// code += `[discrete]\n` +// code += `[[${token.text}]]\n` +// code += `=== ${token.text}\n\n` +// +// const item = model.packages[0].entryPoints[0].members.find(member => member.displayName === token.text) +// if (item != null) { +// code += generateDescription(item.tsdocComment, false) +// switch (item.kind) { +// case 'Interface': +// code += generateInterface(item) +// break; +// case 'TypeAlias': +// code += generateAlias(item) +// break +// case 'Class': +// console.log('Class', token.text) +// code += generateClass(item) +// break +// default: +// code += 'Undocumented type\n' +// break +// } +// } else if (standardTypes[token.text] != null) { +// code += `${standardTypes[token.text]}\n` +// } else { +// code += 'Unknown\n' +// } +// code += '\n' +// } +// } +// } +// return code +// } + +/** + * Generates documentation for the Client class + * @param spec {Extractor.ApiItem} + * @returns {string} Asciidoc markup + */ +// function generateClientDocs (spec) { +// let code = `[reference-client-class]\n\n== Client\n\n${header}\n\n` +// +// // generate constructor and client options +// code += '[discrete]\n' +// code += '=== Constructor\n\n' +// code += '[source,ts,subs=+macros]\n' +// code += '----\n' +// code += 'new Client(options: <>): Client\n' +// code += '----\n\n' +// +// // generate methods +// code += '[discrete]\n' +// code += '=== Methods\n\n' +// for (const method of spec.members.filter(m => m.kind === 'Method')) { +// code += `[[Client.${method.displayName}]]\n` +// code += '[discrete]\n' +// code += `==== Client.${method.displayName}\n\n` +// code += 'TODO\n\n' +// } +// +// // generate properties +// code += '[discrete]\n' +// code += '=== Properties\n\n' +// for (const prop of spec.members.filter(m => m.kind === 'Property')) { +// code += `[[Client.${prop.displayName}]]\n` +// code += '[discrete]\n' +// code += `==== Client.${prop.displayName}\n\n` +// code += 'TODO\n\n' +// } +// +// return code +// } + +async function write(name, code) { + const filePath = path.join(import.meta.dirname, '..', 'docs', 'reference', 'api', `${name}.md`) + await fs.writeFile(filePath, code, 'utf8') +} + +async function start() { + const model = new Extractor.ApiModel() + const pkg = model.loadPackage(path.join(import.meta.dirname, '..', 'api-extractor', 'elasticsearch.api.json')) + const entry = pkg.entryPoints[0] + + for (const member of entry.members) { + if (member.displayName.endsWith('_2')) continue + switch (member.kind) { + case 'Class': + await write(member.displayName, generateClass(member)) + break + case 'Interface': + await write(member.displayName, generateInterface(member)) + break + case 'TypeAlias': + await write(member.displayName, generateAlias(member)) + break + case 'Function': + if (member.fileUrlPath.startsWith('lib/api/api')) { + // if (member.displayName === 'CountApi') console.log(member) + // TODO: drop this: That stuff + // TODO: sub name with `client.foo.bar` + await write(`${member.displayName}_${member.overloadIndex ?? ''}`, generateApiFunction(member)) + // TODO: generate rollup page for each override + } + // console.log(member) + // process.exit(0) + break + case 'Namespace': + case 'Variable': + break + default: + console.log('unsupported type', member.kind, member.displayName) + break + } + // TODO: generate rollup page that includes a whole API namespace's functions, requests, responses + } +} + +start() + .then(() => process.exit(0)) + .catch(err => { + console.error(err) + process.exit(1) + }) From bc7a3776e478b4175dcf70b7c464baeff2af824b Mon Sep 17 00:00:00 2001 From: Josh Mock Date: Tue, 27 May 2025 15:34:59 -0500 Subject: [PATCH 2/7] Add missing anchor --- docs/reference/api-reference.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/reference/api-reference.md b/docs/reference/api-reference.md index e07557048..570037df2 100644 --- a/docs/reference/api-reference.md +++ b/docs/reference/api-reference.md @@ -3,4 +3,6 @@ mapped_pages: - https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/api-reference.html --- +# API Documentation [_index] + See API documentation [here](./api/Client.md) From 20dbabf636cc98a986e1d3783e75e1cf69cc133f Mon Sep 17 00:00:00 2001 From: Josh Mock Date: Tue, 27 May 2025 15:39:58 -0500 Subject: [PATCH 3/7] stabbing in the dark --- docs/reference/api-reference.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/reference/api-reference.md b/docs/reference/api-reference.md index 570037df2..3e8c8e71b 100644 --- a/docs/reference/api-reference.md +++ b/docs/reference/api-reference.md @@ -3,6 +3,6 @@ mapped_pages: - https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/api-reference.html --- -# API Documentation [_index] +## API Documentation [_index] See API documentation [here](./api/Client.md) From e996782c53836dd7c24514d3b8b7971179130a00 Mon Sep 17 00:00:00 2001 From: Josh Mock Date: Tue, 27 May 2025 15:45:02 -0500 Subject: [PATCH 4/7] Add API reference files to TOC --- docs/reference/toc.yml | 3743 +++++++++++++++++++++++++++++++++++++++- 1 file changed, 3742 insertions(+), 1 deletion(-) diff --git a/docs/reference/toc.yml b/docs/reference/toc.yml index 9fbda6f58..09c520bb2 100644 --- a/docs/reference/toc.yml +++ b/docs/reference/toc.yml @@ -15,6 +15,3746 @@ toc: - file: transport.md - file: typescript.md - file: api-reference.md + children: + - file: api/AcknowledgedResponseBase.md + - file: api/Action.md + - file: api/AggregateName.md + - file: api/AggregationsAdjacencyMatrixAggregate.md + - file: api/AggregationsAdjacencyMatrixAggregation.md + - file: api/AggregationsAdjacencyMatrixBucketKeys.md + - file: api/AggregationsAdjacencyMatrixBucket.md + - file: api/AggregationsAggregateBase.md + - file: api/AggregationsAggregate.md + - file: api/AggregationsAggregateOrder.md + - file: api/AggregationsAggregationContainer.md + - file: api/AggregationsAggregation.md + - file: api/AggregationsAggregationRange.md + - file: api/AggregationsArrayPercentilesItem.md + - file: api/AggregationsAutoDateHistogramAggregate.md + - file: api/AggregationsAutoDateHistogramAggregation.md + - file: api/AggregationsAverageAggregation.md + - file: api/AggregationsAverageBucketAggregation.md + - file: api/AggregationsAvgAggregate.md + - file: api/AggregationsBoxPlotAggregate.md + - file: api/AggregationsBoxplotAggregation.md + - file: api/AggregationsBucketAggregationBase.md + - file: api/AggregationsBucketCorrelationAggregation.md + - file: api/AggregationsBucketCorrelationFunctionCountCorrelationIndicator.md + - file: api/AggregationsBucketCorrelationFunctionCountCorrelation.md + - file: api/AggregationsBucketCorrelationFunction.md + - file: api/AggregationsBucketKsAggregation.md + - file: api/AggregationsBucketMetricValueAggregate.md + - file: api/AggregationsBucketPathAggregation.md + - file: api/AggregationsBucketScriptAggregation.md + - file: api/AggregationsBucketSelectorAggregation.md + - file: api/AggregationsBuckets.md + - file: api/AggregationsBucketSortAggregation.md + - file: api/AggregationsBucketsPath.md + - file: api/AggregationsCalendarInterval.md + - file: api/AggregationsCardinalityAggregate.md + - file: api/AggregationsCardinalityAggregation.md + - file: api/AggregationsCardinalityExecutionMode.md + - file: api/AggregationsCategorizeTextAggregation.md + - file: api/AggregationsCategorizeTextAnalyzer.md + - file: api/AggregationsChildrenAggregateKeys.md + - file: api/AggregationsChildrenAggregate.md + - file: api/AggregationsChildrenAggregation.md + - file: api/AggregationsChiSquareHeuristic.md + - file: api/AggregationsCompositeAggregateKey.md + - file: api/AggregationsCompositeAggregate.md + - file: api/AggregationsCompositeAggregationBase.md + - file: api/AggregationsCompositeAggregation.md + - file: api/AggregationsCompositeAggregationSource.md + - file: api/AggregationsCompositeBucketKeys.md + - file: api/AggregationsCompositeBucket.md + - file: api/AggregationsCompositeDateHistogramAggregation.md + - file: api/AggregationsCompositeGeoTileGridAggregation.md + - file: api/AggregationsCompositeHistogramAggregation.md + - file: api/AggregationsCompositeTermsAggregation.md + - file: api/AggregationsCumulativeCardinalityAggregate.md + - file: api/AggregationsCumulativeCardinalityAggregation.md + - file: api/AggregationsCumulativeSumAggregation.md + - file: api/AggregationsCustomCategorizeTextAnalyzer.md + - file: api/AggregationsDateHistogramAggregate.md + - file: api/AggregationsDateHistogramAggregation.md + - file: api/AggregationsDateHistogramBucketKeys.md + - file: api/AggregationsDateHistogramBucket.md + - file: api/AggregationsDateRangeAggregate.md + - file: api/AggregationsDateRangeAggregation.md + - file: api/AggregationsDateRangeExpression.md + - file: api/AggregationsDerivativeAggregate.md + - file: api/AggregationsDerivativeAggregation.md + - file: api/AggregationsDiversifiedSamplerAggregation.md + - file: api/AggregationsDoubleTermsAggregate.md + - file: api/AggregationsDoubleTermsBucketKeys.md + - file: api/AggregationsDoubleTermsBucket.md + - file: api/AggregationsEwmaModelSettings.md + - file: api/AggregationsEwmaMovingAverageAggregation.md + - file: api/AggregationsExtendedBounds.md + - file: api/AggregationsExtendedStatsAggregate.md + - file: api/AggregationsExtendedStatsAggregation.md + - file: api/AggregationsExtendedStatsBucketAggregate.md + - file: api/AggregationsExtendedStatsBucketAggregation.md + - file: api/AggregationsFieldDateMath.md + - file: api/AggregationsFilterAggregateKeys.md + - file: api/AggregationsFilterAggregate.md + - file: api/AggregationsFiltersAggregate.md + - file: api/AggregationsFiltersAggregation.md + - file: api/AggregationsFiltersBucketKeys.md + - file: api/AggregationsFiltersBucket.md + - file: api/AggregationsFormatMetricAggregationBase.md + - file: api/AggregationsFormattableMetricAggregation.md + - file: api/AggregationsFrequentItemSetsAggregate.md + - file: api/AggregationsFrequentItemSetsAggregation.md + - file: api/AggregationsFrequentItemSetsBucketKeys.md + - file: api/AggregationsFrequentItemSetsBucket.md + - file: api/AggregationsFrequentItemSetsField.md + - file: api/AggregationsGapPolicy.md + - file: api/AggregationsGeoBoundsAggregate.md + - file: api/AggregationsGeoBoundsAggregation.md + - file: api/AggregationsGeoCentroidAggregate.md + - file: api/AggregationsGeoCentroidAggregation.md + - file: api/AggregationsGeoDistanceAggregate.md + - file: api/AggregationsGeoDistanceAggregation.md + - file: api/AggregationsGeoHashGridAggregate.md + - file: api/AggregationsGeoHashGridAggregation.md + - file: api/AggregationsGeoHashGridBucketKeys.md + - file: api/AggregationsGeoHashGridBucket.md + - file: api/AggregationsGeoHexGridAggregate.md + - file: api/AggregationsGeohexGridAggregation.md + - file: api/AggregationsGeoHexGridBucketKeys.md + - file: api/AggregationsGeoHexGridBucket.md + - file: api/AggregationsGeoLineAggregate.md + - file: api/AggregationsGeoLineAggregation.md + - file: api/AggregationsGeoLinePoint.md + - file: api/AggregationsGeoLineSort.md + - file: api/AggregationsGeoTileGridAggregate.md + - file: api/AggregationsGeoTileGridAggregation.md + - file: api/AggregationsGeoTileGridBucketKeys.md + - file: api/AggregationsGeoTileGridBucket.md + - file: api/AggregationsGlobalAggregateKeys.md + - file: api/AggregationsGlobalAggregate.md + - file: api/AggregationsGlobalAggregation.md + - file: api/AggregationsGoogleNormalizedDistanceHeuristic.md + - file: api/AggregationsHdrMethod.md + - file: api/AggregationsHdrPercentileRanksAggregate.md + - file: api/AggregationsHdrPercentilesAggregate.md + - file: api/AggregationsHistogramAggregate.md + - file: api/AggregationsHistogramAggregation.md + - file: api/AggregationsHistogramBucketKeys.md + - file: api/AggregationsHistogramBucket.md + - file: api/AggregationsHoltLinearModelSettings.md + - file: api/AggregationsHoltMovingAverageAggregation.md + - file: api/AggregationsHoltWintersModelSettings.md + - file: api/AggregationsHoltWintersMovingAverageAggregation.md + - file: api/AggregationsHoltWintersType.md + - file: api/AggregationsInferenceAggregateKeys.md + - file: api/AggregationsInferenceAggregate.md + - file: api/AggregationsInferenceAggregation.md + - file: api/AggregationsInferenceClassImportance.md + - file: api/AggregationsInferenceConfigContainer.md + - file: api/AggregationsInferenceFeatureImportance.md + - file: api/AggregationsInferenceTopClassEntry.md + - file: api/AggregationsIpPrefixAggregate.md + - file: api/AggregationsIpPrefixAggregation.md + - file: api/AggregationsIpPrefixBucketKeys.md + - file: api/AggregationsIpPrefixBucket.md + - file: api/AggregationsIpRangeAggregate.md + - file: api/AggregationsIpRangeAggregation.md + - file: api/AggregationsIpRangeAggregationRange.md + - file: api/AggregationsIpRangeBucketKeys.md + - file: api/AggregationsIpRangeBucket.md + - file: api/AggregationsKeyedPercentiles.md + - file: api/AggregationsLinearMovingAverageAggregation.md + - file: api/AggregationsLongRareTermsAggregate.md + - file: api/AggregationsLongRareTermsBucketKeys.md + - file: api/AggregationsLongRareTermsBucket.md + - file: api/AggregationsLongTermsAggregate.md + - file: api/AggregationsLongTermsBucketKeys.md + - file: api/AggregationsLongTermsBucket.md + - file: api/AggregationsMatrixAggregation.md + - file: api/AggregationsMatrixStatsAggregate.md + - file: api/AggregationsMatrixStatsAggregation.md + - file: api/AggregationsMatrixStatsFields.md + - file: api/AggregationsMaxAggregate.md + - file: api/AggregationsMaxAggregation.md + - file: api/AggregationsMaxBucketAggregation.md + - file: api/AggregationsMedianAbsoluteDeviationAggregate.md + - file: api/AggregationsMedianAbsoluteDeviationAggregation.md + - file: api/AggregationsMetricAggregationBase.md + - file: api/AggregationsMinAggregate.md + - file: api/AggregationsMinAggregation.md + - file: api/AggregationsMinBucketAggregation.md + - file: api/AggregationsMinimumInterval.md + - file: api/AggregationsMissingAggregateKeys.md + - file: api/AggregationsMissingAggregate.md + - file: api/AggregationsMissingAggregation.md + - file: api/AggregationsMissing.md + - file: api/AggregationsMissingOrder.md + - file: api/AggregationsMovingAverageAggregationBase.md + - file: api/AggregationsMovingAverageAggregation.md + - file: api/AggregationsMovingFunctionAggregation.md + - file: api/AggregationsMovingPercentilesAggregation.md + - file: api/AggregationsMultiBucketAggregateBase.md + - file: api/AggregationsMultiBucketBase.md + - file: api/AggregationsMultiTermLookup.md + - file: api/AggregationsMultiTermsAggregate.md + - file: api/AggregationsMultiTermsAggregation.md + - file: api/AggregationsMultiTermsBucketKeys.md + - file: api/AggregationsMultiTermsBucket.md + - file: api/AggregationsMutualInformationHeuristic.md + - file: api/AggregationsNestedAggregateKeys.md + - file: api/AggregationsNestedAggregate.md + - file: api/AggregationsNestedAggregation.md + - file: api/AggregationsNormalizeAggregation.md + - file: api/AggregationsNormalizeMethod.md + - file: api/AggregationsParentAggregateKeys.md + - file: api/AggregationsParentAggregate.md + - file: api/AggregationsParentAggregation.md + - file: api/AggregationsPercentageScoreHeuristic.md + - file: api/AggregationsPercentileRanksAggregation.md + - file: api/AggregationsPercentilesAggregateBase.md + - file: api/AggregationsPercentilesAggregation.md + - file: api/AggregationsPercentilesBucketAggregate.md + - file: api/AggregationsPercentilesBucketAggregation.md + - file: api/AggregationsPercentiles.md + - file: api/AggregationsPipelineAggregationBase.md + - file: api/AggregationsRandomSamplerAggregation.md + - file: api/AggregationsRangeAggregate.md + - file: api/AggregationsRangeAggregation.md + - file: api/AggregationsRangeBucketKeys.md + - file: api/AggregationsRangeBucket.md + - file: api/AggregationsRareTermsAggregation.md + - file: api/AggregationsRateAggregate.md + - file: api/AggregationsRateAggregation.md + - file: api/AggregationsRateMode.md + - file: api/AggregationsReverseNestedAggregateKeys.md + - file: api/AggregationsReverseNestedAggregate.md + - file: api/AggregationsReverseNestedAggregation.md + - file: api/AggregationsSamplerAggregateKeys.md + - file: api/AggregationsSamplerAggregate.md + - file: api/AggregationsSamplerAggregationExecutionHint.md + - file: api/AggregationsSamplerAggregation.md + - file: api/AggregationsScriptedHeuristic.md + - file: api/AggregationsScriptedMetricAggregate.md + - file: api/AggregationsScriptedMetricAggregation.md + - file: api/AggregationsSerialDifferencingAggregation.md + - file: api/AggregationsSignificantLongTermsAggregate.md + - file: api/AggregationsSignificantLongTermsBucketKeys.md + - file: api/AggregationsSignificantLongTermsBucket.md + - file: api/AggregationsSignificantStringTermsAggregate.md + - file: api/AggregationsSignificantStringTermsBucketKeys.md + - file: api/AggregationsSignificantStringTermsBucket.md + - file: api/AggregationsSignificantTermsAggregateBase.md + - file: api/AggregationsSignificantTermsAggregation.md + - file: api/AggregationsSignificantTermsBucketBase.md + - file: api/AggregationsSignificantTextAggregation.md + - file: api/AggregationsSimpleMovingAverageAggregation.md + - file: api/AggregationsSimpleValueAggregate.md + - file: api/AggregationsSingleBucketAggregateBase.md + - file: api/AggregationsSingleMetricAggregateBase.md + - file: api/AggregationsStandardDeviationBoundsAsString.md + - file: api/AggregationsStandardDeviationBounds.md + - file: api/AggregationsStatsAggregate.md + - file: api/AggregationsStatsAggregation.md + - file: api/AggregationsStatsBucketAggregate.md + - file: api/AggregationsStatsBucketAggregation.md + - file: api/AggregationsStringRareTermsAggregate.md + - file: api/AggregationsStringRareTermsBucketKeys.md + - file: api/AggregationsStringRareTermsBucket.md + - file: api/AggregationsStringStatsAggregate.md + - file: api/AggregationsStringStatsAggregation.md + - file: api/AggregationsStringTermsAggregate.md + - file: api/AggregationsStringTermsBucketKeys.md + - file: api/AggregationsStringTermsBucket.md + - file: api/AggregationsSumAggregate.md + - file: api/AggregationsSumAggregation.md + - file: api/AggregationsSumBucketAggregation.md + - file: api/AggregationsTDigest.md + - file: api/AggregationsTDigestPercentileRanksAggregate.md + - file: api/AggregationsTDigestPercentilesAggregate.md + - file: api/AggregationsTermsAggregateBase.md + - file: api/AggregationsTermsAggregationCollectMode.md + - file: api/AggregationsTermsAggregationExecutionHint.md + - file: api/AggregationsTermsAggregation.md + - file: api/AggregationsTermsBucketBase.md + - file: api/AggregationsTermsExclude.md + - file: api/AggregationsTermsInclude.md + - file: api/AggregationsTermsPartition.md + - file: api/AggregationsTestPopulation.md + - file: api/AggregationsTimeSeriesAggregate.md + - file: api/AggregationsTimeSeriesAggregation.md + - file: api/AggregationsTimeSeriesBucketKeys.md + - file: api/AggregationsTimeSeriesBucket.md + - file: api/AggregationsTopHitsAggregate.md + - file: api/AggregationsTopHitsAggregation.md + - file: api/AggregationsTopMetricsAggregate.md + - file: api/AggregationsTopMetricsAggregation.md + - file: api/AggregationsTopMetrics.md + - file: api/AggregationsTopMetricsValue.md + - file: api/AggregationsTTestAggregate.md + - file: api/AggregationsTTestAggregation.md + - file: api/AggregationsTTestType.md + - file: api/AggregationsUnmappedRareTermsAggregate.md + - file: api/AggregationsUnmappedSamplerAggregateKeys.md + - file: api/AggregationsUnmappedSamplerAggregate.md + - file: api/AggregationsUnmappedSignificantTermsAggregate.md + - file: api/AggregationsUnmappedTermsAggregate.md + - file: api/AggregationsValueCountAggregate.md + - file: api/AggregationsValueCountAggregation.md + - file: api/AggregationsValueType.md + - file: api/AggregationsVariableWidthHistogramAggregate.md + - file: api/AggregationsVariableWidthHistogramAggregation.md + - file: api/AggregationsVariableWidthHistogramBucketKeys.md + - file: api/AggregationsVariableWidthHistogramBucket.md + - file: api/AggregationsWeightedAverageAggregation.md + - file: api/AggregationsWeightedAverageValue.md + - file: api/AggregationsWeightedAvgAggregate.md + - file: api/AnalysisAnalyzer.md + - file: api/AnalysisApostropheTokenFilter.md + - file: api/AnalysisArabicAnalyzer.md + - file: api/AnalysisArabicNormalizationTokenFilter.md + - file: api/AnalysisArmenianAnalyzer.md + - file: api/AnalysisAsciiFoldingTokenFilter.md + - file: api/AnalysisBasqueAnalyzer.md + - file: api/AnalysisBengaliAnalyzer.md + - file: api/AnalysisBrazilianAnalyzer.md + - file: api/AnalysisBulgarianAnalyzer.md + - file: api/AnalysisCatalanAnalyzer.md + - file: api/AnalysisCharFilterBase.md + - file: api/AnalysisCharFilterDefinition.md + - file: api/AnalysisCharFilter.md + - file: api/AnalysisCharGroupTokenizer.md + - file: api/AnalysisChineseAnalyzer.md + - file: api/AnalysisCjkAnalyzer.md + - file: api/AnalysisCjkBigramIgnoredScript.md + - file: api/AnalysisCjkBigramTokenFilter.md + - file: api/AnalysisCjkWidthTokenFilter.md + - file: api/AnalysisClassicTokenFilter.md + - file: api/AnalysisClassicTokenizer.md + - file: api/AnalysisCommonGramsTokenFilter.md + - file: api/AnalysisCompoundWordTokenFilterBase.md + - file: api/AnalysisConditionTokenFilter.md + - file: api/AnalysisCustomAnalyzer.md + - file: api/AnalysisCustomNormalizer.md + - file: api/AnalysisCzechAnalyzer.md + - file: api/AnalysisDanishAnalyzer.md + - file: api/AnalysisDecimalDigitTokenFilter.md + - file: api/AnalysisDelimitedPayloadEncoding.md + - file: api/AnalysisDelimitedPayloadTokenFilter.md + - file: api/AnalysisDictionaryDecompounderTokenFilter.md + - file: api/AnalysisDutchAnalyzer.md + - file: api/AnalysisEdgeNGramSide.md + - file: api/AnalysisEdgeNGramTokenFilter.md + - file: api/AnalysisEdgeNGramTokenizer.md + - file: api/AnalysisElisionTokenFilter.md + - file: api/AnalysisEnglishAnalyzer.md + - file: api/AnalysisEstonianAnalyzer.md + - file: api/AnalysisFingerprintAnalyzer.md + - file: api/AnalysisFingerprintTokenFilter.md + - file: api/AnalysisFinnishAnalyzer.md + - file: api/AnalysisFlattenGraphTokenFilter.md + - file: api/AnalysisFrenchAnalyzer.md + - file: api/AnalysisGalicianAnalyzer.md + - file: api/AnalysisGermanAnalyzer.md + - file: api/AnalysisGermanNormalizationTokenFilter.md + - file: api/AnalysisGreekAnalyzer.md + - file: api/AnalysisHindiAnalyzer.md + - file: api/AnalysisHindiNormalizationTokenFilter.md + - file: api/AnalysisHtmlStripCharFilter.md + - file: api/AnalysisHungarianAnalyzer.md + - file: api/AnalysisHunspellTokenFilter.md + - file: api/AnalysisHyphenationDecompounderTokenFilter.md + - file: api/AnalysisIcuAnalyzer.md + - file: api/AnalysisIcuCollationAlternate.md + - file: api/AnalysisIcuCollationCaseFirst.md + - file: api/AnalysisIcuCollationDecomposition.md + - file: api/AnalysisIcuCollationStrength.md + - file: api/AnalysisIcuCollationTokenFilter.md + - file: api/AnalysisIcuFoldingTokenFilter.md + - file: api/AnalysisIcuNormalizationCharFilter.md + - file: api/AnalysisIcuNormalizationMode.md + - file: api/AnalysisIcuNormalizationTokenFilter.md + - file: api/AnalysisIcuNormalizationType.md + - file: api/AnalysisIcuTokenizer.md + - file: api/AnalysisIcuTransformDirection.md + - file: api/AnalysisIcuTransformTokenFilter.md + - file: api/AnalysisIndicNormalizationTokenFilter.md + - file: api/AnalysisIndonesianAnalyzer.md + - file: api/AnalysisIrishAnalyzer.md + - file: api/AnalysisItalianAnalyzer.md + - file: api/AnalysisJaStopTokenFilter.md + - file: api/AnalysisKeepTypesMode.md + - file: api/AnalysisKeepTypesTokenFilter.md + - file: api/AnalysisKeepWordsTokenFilter.md + - file: api/AnalysisKeywordAnalyzer.md + - file: api/AnalysisKeywordMarkerTokenFilter.md + - file: api/AnalysisKeywordRepeatTokenFilter.md + - file: api/AnalysisKeywordTokenizer.md + - file: api/AnalysisKStemTokenFilter.md + - file: api/AnalysisKuromojiAnalyzer.md + - file: api/AnalysisKuromojiIterationMarkCharFilter.md + - file: api/AnalysisKuromojiPartOfSpeechTokenFilter.md + - file: api/AnalysisKuromojiReadingFormTokenFilter.md + - file: api/AnalysisKuromojiStemmerTokenFilter.md + - file: api/AnalysisKuromojiTokenizationMode.md + - file: api/AnalysisKuromojiTokenizer.md + - file: api/AnalysisLatvianAnalyzer.md + - file: api/AnalysisLengthTokenFilter.md + - file: api/AnalysisLetterTokenizer.md + - file: api/AnalysisLimitTokenCountTokenFilter.md + - file: api/AnalysisLithuanianAnalyzer.md + - file: api/AnalysisLowercaseNormalizer.md + - file: api/AnalysisLowercaseTokenFilterLanguages.md + - file: api/AnalysisLowercaseTokenFilter.md + - file: api/AnalysisLowercaseTokenizer.md + - file: api/AnalysisMappingCharFilter.md + - file: api/AnalysisMinHashTokenFilter.md + - file: api/AnalysisMultiplexerTokenFilter.md + - file: api/AnalysisNGramTokenFilter.md + - file: api/AnalysisNGramTokenizer.md + - file: api/AnalysisNoriAnalyzer.md + - file: api/AnalysisNoriDecompoundMode.md + - file: api/AnalysisNoriPartOfSpeechTokenFilter.md + - file: api/AnalysisNoriTokenizer.md + - file: api/AnalysisNormalizer.md + - file: api/AnalysisNorwegianAnalyzer.md + - file: api/AnalysisPathHierarchyTokenizer.md + - file: api/AnalysisPatternAnalyzer.md + - file: api/AnalysisPatternCaptureTokenFilter.md + - file: api/AnalysisPatternReplaceCharFilter.md + - file: api/AnalysisPatternReplaceTokenFilter.md + - file: api/AnalysisPatternTokenizer.md + - file: api/AnalysisPersianAnalyzer.md + - file: api/AnalysisPersianNormalizationTokenFilter.md + - file: api/AnalysisPhoneticEncoder.md + - file: api/AnalysisPhoneticLanguage.md + - file: api/AnalysisPhoneticNameType.md + - file: api/AnalysisPhoneticRuleType.md + - file: api/AnalysisPhoneticTokenFilter.md + - file: api/AnalysisPorterStemTokenFilter.md + - file: api/AnalysisPortugueseAnalyzer.md + - file: api/AnalysisPredicateTokenFilter.md + - file: api/AnalysisRemoveDuplicatesTokenFilter.md + - file: api/AnalysisReverseTokenFilter.md + - file: api/AnalysisRomanianAnalyzer.md + - file: api/AnalysisRussianAnalyzer.md + - file: api/AnalysisScandinavianFoldingTokenFilter.md + - file: api/AnalysisScandinavianNormalizationTokenFilter.md + - file: api/AnalysisSerbianAnalyzer.md + - file: api/AnalysisSerbianNormalizationTokenFilter.md + - file: api/AnalysisShingleTokenFilter.md + - file: api/AnalysisSimpleAnalyzer.md + - file: api/AnalysisSimplePatternSplitTokenizer.md + - file: api/AnalysisSimplePatternTokenizer.md + - file: api/AnalysisSnowballAnalyzer.md + - file: api/AnalysisSnowballLanguage.md + - file: api/AnalysisSnowballTokenFilter.md + - file: api/AnalysisSoraniAnalyzer.md + - file: api/AnalysisSoraniNormalizationTokenFilter.md + - file: api/AnalysisSpanishAnalyzer.md + - file: api/AnalysisStandardAnalyzer.md + - file: api/AnalysisStandardTokenizer.md + - file: api/AnalysisStemmerOverrideTokenFilter.md + - file: api/AnalysisStemmerTokenFilter.md + - file: api/AnalysisStopAnalyzer.md + - file: api/AnalysisStopTokenFilter.md + - file: api/AnalysisStopWordLanguage.md + - file: api/AnalysisStopWords.md + - file: api/AnalysisSwedishAnalyzer.md + - file: api/AnalysisSynonymFormat.md + - file: api/AnalysisSynonymGraphTokenFilter.md + - file: api/AnalysisSynonymTokenFilterBase.md + - file: api/AnalysisSynonymTokenFilter.md + - file: api/AnalysisThaiAnalyzer.md + - file: api/AnalysisThaiTokenizer.md + - file: api/AnalysisTokenChar.md + - file: api/AnalysisTokenFilterBase.md + - file: api/AnalysisTokenFilterDefinition.md + - file: api/AnalysisTokenFilter.md + - file: api/AnalysisTokenizerBase.md + - file: api/AnalysisTokenizerDefinition.md + - file: api/AnalysisTokenizer.md + - file: api/AnalysisTrimTokenFilter.md + - file: api/AnalysisTruncateTokenFilter.md + - file: api/AnalysisTurkishAnalyzer.md + - file: api/AnalysisUaxEmailUrlTokenizer.md + - file: api/AnalysisUniqueTokenFilter.md + - file: api/AnalysisUppercaseTokenFilter.md + - file: api/AnalysisWhitespaceAnalyzer.md + - file: api/AnalysisWhitespaceTokenizer.md + - file: api/AnalysisWordDelimiterGraphTokenFilter.md + - file: api/AnalysisWordDelimiterTokenFilterBase.md + - file: api/AnalysisWordDelimiterTokenFilter.md + - file: api/API.md + - file: api/AsyncSearchAsyncSearchDocumentResponseBase.md + - file: api/AsyncSearchAsyncSearch.md + - file: api/AsyncSearchAsyncSearchResponseBase.md + - file: api/AsyncSearchDeleteRequest.md + - file: api/AsyncSearchDeleteResponse.md + - file: api/AsyncSearchGetRequest.md + - file: api/AsyncSearchGetResponse.md + - file: api/AsyncSearch.md + - file: api/AsyncSearchStatusRequest.md + - file: api/AsyncSearchStatusResponse.md + - file: api/AsyncSearchStatusStatusResponseBase.md + - file: api/AsyncSearchSubmitRequest.md + - file: api/AsyncSearchSubmitResponse.md + - file: api/AutoscalingAutoscalingPolicy.md + - file: api/AutoscalingDeleteAutoscalingPolicyRequest.md + - file: api/AutoscalingDeleteAutoscalingPolicyResponse.md + - file: api/AutoscalingGetAutoscalingCapacityAutoscalingCapacity.md + - file: api/AutoscalingGetAutoscalingCapacityAutoscalingDecider.md + - file: api/AutoscalingGetAutoscalingCapacityAutoscalingDeciders.md + - file: api/AutoscalingGetAutoscalingCapacityAutoscalingNode.md + - file: api/AutoscalingGetAutoscalingCapacityAutoscalingResources.md + - file: api/AutoscalingGetAutoscalingCapacityRequest.md + - file: api/AutoscalingGetAutoscalingCapacityResponse.md + - file: api/AutoscalingGetAutoscalingPolicyRequest.md + - file: api/AutoscalingGetAutoscalingPolicyResponse.md + - file: api/Autoscaling.md + - file: api/AutoscalingPutAutoscalingPolicyRequest.md + - file: api/AutoscalingPutAutoscalingPolicyResponse.md + - file: api/BulkApi_1.md + - file: api/BulkApi_2.md + - file: api/BulkApi_3.md + - file: api/BulkCreateOperation.md + - file: api/BulkDeleteOperation.md + - file: api/BulkFailureStoreStatus.md + - file: api/BulkHelper.md + - file: api/BulkHelperOptions.md + - file: api/BulkIndexByScrollFailure.md + - file: api/BulkIndexOperation.md + - file: api/BulkOperationBase.md + - file: api/BulkOperationContainer.md + - file: api/BulkOperationType.md + - file: api/BulkRequest.md + - file: api/BulkResponseItem.md + - file: api/BulkResponse.md + - file: api/BulkStats.md + - file: api/BulkUpdateAction.md + - file: api/BulkUpdateOperation.md + - file: api/BulkWriteOperation.md + - file: api/byte.md + - file: api/ByteSize.md + - file: api/Bytes.md + - file: api/CapabilitiesApi_1.md + - file: api/CapabilitiesApi_2.md + - file: api/CapabilitiesApi_3.md + - file: api/CatAliasesAliasesRecord.md + - file: api/CatAliasesRequest.md + - file: api/CatAliasesResponse.md + - file: api/CatAllocationAllocationRecord.md + - file: api/CatAllocationRequest.md + - file: api/CatAllocationResponse.md + - file: api/CatCatAnomalyDetectorColumn.md + - file: api/CatCatAnonalyDetectorColumns.md + - file: api/CatCatDatafeedColumn.md + - file: api/CatCatDatafeedColumns.md + - file: api/CatCatDfaColumn.md + - file: api/CatCatDfaColumns.md + - file: api/CatCatNodeColumn.md + - file: api/CatCatNodeColumns.md + - file: api/CatCatRequestBase.md + - file: api/CatCatTrainedModelsColumn.md + - file: api/CatCatTrainedModelsColumns.md + - file: api/CatCatTransformColumn.md + - file: api/CatCatTransformColumns.md + - file: api/CatComponentTemplatesComponentTemplate.md + - file: api/CatComponentTemplatesRequest.md + - file: api/CatComponentTemplatesResponse.md + - file: api/CatCountCountRecord.md + - file: api/CatCountRequest.md + - file: api/CatCountResponse.md + - file: api/CategoryId.md + - file: api/CatFielddataFielddataRecord.md + - file: api/CatFielddataRequest.md + - file: api/CatFielddataResponse.md + - file: api/CatHealthHealthRecord.md + - file: api/CatHealthRequest.md + - file: api/CatHealthResponse.md + - file: api/CatHelpRequest.md + - file: api/CatHelpResponse.md + - file: api/CatIndicesIndicesRecord.md + - file: api/CatIndicesRequest.md + - file: api/CatIndicesResponse.md + - file: api/CatMasterMasterRecord.md + - file: api/CatMasterRequest.md + - file: api/CatMasterResponse.md + - file: api/Cat.md + - file: api/CatMlDatafeedsDatafeedsRecord.md + - file: api/CatMlDatafeedsRequest.md + - file: api/CatMlDatafeedsResponse.md + - file: api/CatMlDataFrameAnalyticsDataFrameAnalyticsRecord.md + - file: api/CatMlDataFrameAnalyticsRequest.md + - file: api/CatMlDataFrameAnalyticsResponse.md + - file: api/CatMlJobsJobsRecord.md + - file: api/CatMlJobsRequest.md + - file: api/CatMlJobsResponse.md + - file: api/CatMlTrainedModelsRequest.md + - file: api/CatMlTrainedModelsResponse.md + - file: api/CatMlTrainedModelsTrainedModelsRecord.md + - file: api/CatNodeattrsNodeAttributesRecord.md + - file: api/CatNodeattrsRequest.md + - file: api/CatNodeattrsResponse.md + - file: api/CatNodesNodesRecord.md + - file: api/CatNodesRequest.md + - file: api/CatNodesResponse.md + - file: api/CatPendingTasksPendingTasksRecord.md + - file: api/CatPendingTasksRequest.md + - file: api/CatPendingTasksResponse.md + - file: api/CatPluginsPluginsRecord.md + - file: api/CatPluginsRequest.md + - file: api/CatPluginsResponse.md + - file: api/CatRecoveryRecoveryRecord.md + - file: api/CatRecoveryRequest.md + - file: api/CatRecoveryResponse.md + - file: api/CatRepositoriesRepositoriesRecord.md + - file: api/CatRepositoriesRequest.md + - file: api/CatRepositoriesResponse.md + - file: api/CatSegmentsRequest.md + - file: api/CatSegmentsResponse.md + - file: api/CatSegmentsSegmentsRecord.md + - file: api/CatShardsRequest.md + - file: api/CatShardsResponse.md + - file: api/CatShardsShardsRecord.md + - file: api/CatSnapshotsRequest.md + - file: api/CatSnapshotsResponse.md + - file: api/CatSnapshotsSnapshotsRecord.md + - file: api/CatTasksRequest.md + - file: api/CatTasksResponse.md + - file: api/CatTasksTasksRecord.md + - file: api/CatTemplatesRequest.md + - file: api/CatTemplatesResponse.md + - file: api/CatTemplatesTemplatesRecord.md + - file: api/CatThreadPoolRequest.md + - file: api/CatThreadPoolResponse.md + - file: api/CatThreadPoolThreadPoolRecord.md + - file: api/CatTransformsRequest.md + - file: api/CatTransformsResponse.md + - file: api/CatTransformsTransformsRecord.md + - file: api/CcrDeleteAutoFollowPatternRequest.md + - file: api/CcrDeleteAutoFollowPatternResponse.md + - file: api/CcrFollowIndexStats.md + - file: api/CcrFollowInfoFollowerIndex.md + - file: api/CcrFollowInfoFollowerIndexParameters.md + - file: api/CcrFollowInfoFollowerIndexStatus.md + - file: api/CcrFollowInfoRequest.md + - file: api/CcrFollowInfoResponse.md + - file: api/CcrFollowRequest.md + - file: api/CcrFollowResponse.md + - file: api/CcrFollowStatsRequest.md + - file: api/CcrFollowStatsResponse.md + - file: api/CcrForgetFollowerRequest.md + - file: api/CcrForgetFollowerResponse.md + - file: api/CcrGetAutoFollowPatternAutoFollowPattern.md + - file: api/CcrGetAutoFollowPatternAutoFollowPatternSummary.md + - file: api/CcrGetAutoFollowPatternRequest.md + - file: api/CcrGetAutoFollowPatternResponse.md + - file: api/Ccr.md + - file: api/CcrPauseAutoFollowPatternRequest.md + - file: api/CcrPauseAutoFollowPatternResponse.md + - file: api/CcrPauseFollowRequest.md + - file: api/CcrPauseFollowResponse.md + - file: api/CcrPutAutoFollowPatternRequest.md + - file: api/CcrPutAutoFollowPatternResponse.md + - file: api/CcrReadException.md + - file: api/CcrResumeAutoFollowPatternRequest.md + - file: api/CcrResumeAutoFollowPatternResponse.md + - file: api/CcrResumeFollowRequest.md + - file: api/CcrResumeFollowResponse.md + - file: api/CcrShardStats.md + - file: api/CcrStatsAutoFollowedCluster.md + - file: api/CcrStatsAutoFollowStats.md + - file: api/CcrStatsFollowStats.md + - file: api/CcrStatsRequest.md + - file: api/CcrStatsResponse.md + - file: api/CcrUnfollowRequest.md + - file: api/CcrUnfollowResponse.md + - file: api/ClearScrollApi_1.md + - file: api/ClearScrollApi_2.md + - file: api/ClearScrollApi_3.md + - file: api/ClearScrollRequest.md + - file: api/ClearScrollResponse.md + - file: api/Client.md + - file: api/ClientOptions.md + - file: api/ClosePointInTimeApi_1.md + - file: api/ClosePointInTimeApi_2.md + - file: api/ClosePointInTimeApi_3.md + - file: api/ClosePointInTimeRequest.md + - file: api/ClosePointInTimeResponse.md + - file: api/ClusterAlias.md + - file: api/ClusterAllocationExplainAllocationDecision.md + - file: api/ClusterAllocationExplainAllocationExplainDecision.md + - file: api/ClusterAllocationExplainAllocationStore.md + - file: api/ClusterAllocationExplainClusterInfo.md + - file: api/ClusterAllocationExplainCurrentNode.md + - file: api/ClusterAllocationExplainDecision.md + - file: api/ClusterAllocationExplainDiskUsage.md + - file: api/ClusterAllocationExplainNodeAllocationExplanation.md + - file: api/ClusterAllocationExplainNodeDiskUsage.md + - file: api/ClusterAllocationExplainRequest.md + - file: api/ClusterAllocationExplainReservedSize.md + - file: api/ClusterAllocationExplainResponse.md + - file: api/ClusterAllocationExplainUnassignedInformation.md + - file: api/ClusterAllocationExplainUnassignedInformationReason.md + - file: api/ClusterComponentTemplate.md + - file: api/ClusterComponentTemplateNode.md + - file: api/ClusterComponentTemplateSummary.md + - file: api/ClusterDeleteComponentTemplateRequest.md + - file: api/ClusterDeleteComponentTemplateResponse.md + - file: api/ClusterDeleteVotingConfigExclusionsRequest.md + - file: api/ClusterDeleteVotingConfigExclusionsResponse.md + - file: api/ClusterDetails.md + - file: api/ClusterExistsComponentTemplateRequest.md + - file: api/ClusterExistsComponentTemplateResponse.md + - file: api/ClusterGetComponentTemplateRequest.md + - file: api/ClusterGetComponentTemplateResponse.md + - file: api/ClusterGetSettingsRequest.md + - file: api/ClusterGetSettingsResponse.md + - file: api/ClusterHealthHealthResponseBody.md + - file: api/ClusterHealthIndexHealthStats.md + - file: api/ClusterHealthRequest.md + - file: api/ClusterHealthResponse.md + - file: api/ClusterHealthShardHealthStats.md + - file: api/ClusterHealthWaitForNodes.md + - file: api/ClusterInfoRequest.md + - file: api/ClusterInfoResponse.md + - file: api/ClusterInfoTarget.md + - file: api/ClusterInfoTargets.md + - file: api/Cluster.md + - file: api/ClusterPendingTasksPendingTask.md + - file: api/ClusterPendingTasksRequest.md + - file: api/ClusterPendingTasksResponse.md + - file: api/ClusterPostVotingConfigExclusionsRequest.md + - file: api/ClusterPostVotingConfigExclusionsResponse.md + - file: api/ClusterPutComponentTemplateRequest.md + - file: api/ClusterPutComponentTemplateResponse.md + - file: api/ClusterPutSettingsRequest.md + - file: api/ClusterPutSettingsResponse.md + - file: api/ClusterRemoteInfoClusterRemoteInfo.md + - file: api/ClusterRemoteInfoClusterRemoteProxyInfo.md + - file: api/ClusterRemoteInfoClusterRemoteSniffInfo.md + - file: api/ClusterRemoteInfoRequest.md + - file: api/ClusterRemoteInfoResponse.md + - file: api/ClusterRerouteCommandAllocatePrimaryAction.md + - file: api/ClusterRerouteCommandAllocateReplicaAction.md + - file: api/ClusterRerouteCommandCancelAction.md + - file: api/ClusterRerouteCommand.md + - file: api/ClusterRerouteCommandMoveAction.md + - file: api/ClusterRerouteRequest.md + - file: api/ClusterRerouteRerouteDecision.md + - file: api/ClusterRerouteRerouteExplanation.md + - file: api/ClusterRerouteRerouteParameters.md + - file: api/ClusterRerouteResponse.md + - file: api/ClusterSearchStatus.md + - file: api/ClusterStateRequest.md + - file: api/ClusterStateResponse.md + - file: api/ClusterStatistics.md + - file: api/ClusterStatsCCSStats.md + - file: api/ClusterStatsCCSUsageClusterStats.md + - file: api/ClusterStatsCCSUsageStats.md + - file: api/ClusterStatsCCSUsageTimeValue.md + - file: api/ClusterStatsCharFilterTypes.md + - file: api/ClusterStatsClusterFileSystem.md + - file: api/ClusterStatsClusterIndices.md + - file: api/ClusterStatsClusterIndicesShardsIndex.md + - file: api/ClusterStatsClusterIndicesShards.md + - file: api/ClusterStatsClusterIngest.md + - file: api/ClusterStatsClusterJvm.md + - file: api/ClusterStatsClusterJvmMemory.md + - file: api/ClusterStatsClusterJvmVersion.md + - file: api/ClusterStatsClusterNetworkTypes.md + - file: api/ClusterStatsClusterNodeCount.md + - file: api/ClusterStatsClusterNodes.md + - file: api/ClusterStatsClusterOperatingSystemArchitecture.md + - file: api/ClusterStatsClusterOperatingSystem.md + - file: api/ClusterStatsClusterOperatingSystemName.md + - file: api/ClusterStatsClusterOperatingSystemPrettyName.md + - file: api/ClusterStatsClusterProcessCpu.md + - file: api/ClusterStatsClusterProcess.md + - file: api/ClusterStatsClusterProcessOpenFileDescriptors.md + - file: api/ClusterStatsClusterProcessor.md + - file: api/ClusterStatsClusterShardMetrics.md + - file: api/ClusterStatsFieldTypesMappings.md + - file: api/ClusterStatsFieldTypes.md + - file: api/ClusterStatsIndexingPressure.md + - file: api/ClusterStatsIndexingPressureMemory.md + - file: api/ClusterStatsIndexingPressureMemorySummary.md + - file: api/ClusterStatsIndicesVersions.md + - file: api/ClusterStatsNodePackagingType.md + - file: api/ClusterStatsOperatingSystemMemoryInfo.md + - file: api/ClusterStatsRemoteClusterInfo.md + - file: api/ClusterStatsRequest.md + - file: api/ClusterStatsResponse.md + - file: api/ClusterStatsRuntimeFieldTypes.md + - file: api/ClusterStatsStatsResponseBase.md + - file: api/CompletionStats.md + - file: api/Conflicts.md + - file: api/ConnectorCheckInRequest.md + - file: api/ConnectorCheckInResponse.md + - file: api/ConnectorConnectorConfigProperties.md + - file: api/ConnectorConnectorConfiguration.md + - file: api/ConnectorConnectorCustomScheduling.md + - file: api/ConnectorConnectorFeatures.md + - file: api/ConnectorConnectorFieldType.md + - file: api/ConnectorConnector.md + - file: api/ConnectorConnectorScheduling.md + - file: api/ConnectorConnectorStatus.md + - file: api/ConnectorConnectorSyncJob.md + - file: api/ConnectorCustomSchedulingConfigurationOverrides.md + - file: api/ConnectorCustomScheduling.md + - file: api/ConnectorDeleteRequest.md + - file: api/ConnectorDeleteResponse.md + - file: api/ConnectorDependency.md + - file: api/ConnectorDisplayType.md + - file: api/ConnectorFeatureEnabled.md + - file: api/ConnectorFilteringAdvancedSnippet.md + - file: api/ConnectorFilteringConfig.md + - file: api/ConnectorFilteringPolicy.md + - file: api/ConnectorFilteringRule.md + - file: api/ConnectorFilteringRuleRule.md + - file: api/ConnectorFilteringRules.md + - file: api/ConnectorFilteringRulesValidation.md + - file: api/ConnectorFilteringValidation.md + - file: api/ConnectorFilteringValidationState.md + - file: api/ConnectorGetRequest.md + - file: api/ConnectorGetResponse.md + - file: api/ConnectorGreaterThanValidation.md + - file: api/ConnectorIncludedInValidation.md + - file: api/ConnectorIngestPipelineParams.md + - file: api/ConnectorLastSyncRequest.md + - file: api/ConnectorLastSyncResponse.md + - file: api/ConnectorLessThanValidation.md + - file: api/ConnectorListRequest.md + - file: api/ConnectorListResponse.md + - file: api/ConnectorListTypeValidation.md + - file: api/Connector.md + - file: api/ConnectorPostRequest.md + - file: api/ConnectorPostResponse.md + - file: api/ConnectorPutRequest.md + - file: api/ConnectorPutResponse.md + - file: api/ConnectorRegexValidation.md + - file: api/ConnectorSchedulingConfiguration.md + - file: api/ConnectorSelectOption.md + - file: api/ConnectorSyncJobCancelRequest.md + - file: api/ConnectorSyncJobCancelResponse.md + - file: api/ConnectorSyncJobCheckInRequest.md + - file: api/ConnectorSyncJobCheckInResponse.md + - file: api/ConnectorSyncJobClaimRequest.md + - file: api/ConnectorSyncJobClaimResponse.md + - file: api/ConnectorSyncJobConnectorReference.md + - file: api/ConnectorSyncJobDeleteRequest.md + - file: api/ConnectorSyncJobDeleteResponse.md + - file: api/ConnectorSyncJobErrorRequest.md + - file: api/ConnectorSyncJobErrorResponse.md + - file: api/ConnectorSyncJobGetRequest.md + - file: api/ConnectorSyncJobGetResponse.md + - file: api/ConnectorSyncJobListRequest.md + - file: api/ConnectorSyncJobListResponse.md + - file: api/ConnectorSyncJobPostRequest.md + - file: api/ConnectorSyncJobPostResponse.md + - file: api/ConnectorSyncJobTriggerMethod.md + - file: api/ConnectorSyncJobType.md + - file: api/ConnectorSyncJobUpdateStatsRequest.md + - file: api/ConnectorSyncJobUpdateStatsResponse.md + - file: api/ConnectorSyncRulesFeature.md + - file: api/ConnectorSyncStatus.md + - file: api/ConnectorUpdateActiveFilteringRequest.md + - file: api/ConnectorUpdateActiveFilteringResponse.md + - file: api/ConnectorUpdateApiKeyIdRequest.md + - file: api/ConnectorUpdateApiKeyIdResponse.md + - file: api/ConnectorUpdateConfigurationRequest.md + - file: api/ConnectorUpdateConfigurationResponse.md + - file: api/ConnectorUpdateErrorRequest.md + - file: api/ConnectorUpdateErrorResponse.md + - file: api/ConnectorUpdateFeaturesRequest.md + - file: api/ConnectorUpdateFeaturesResponse.md + - file: api/ConnectorUpdateFilteringRequest.md + - file: api/ConnectorUpdateFilteringResponse.md + - file: api/ConnectorUpdateFilteringValidationRequest.md + - file: api/ConnectorUpdateFilteringValidationResponse.md + - file: api/ConnectorUpdateIndexNameRequest.md + - file: api/ConnectorUpdateIndexNameResponse.md + - file: api/ConnectorUpdateNameRequest.md + - file: api/ConnectorUpdateNameResponse.md + - file: api/ConnectorUpdateNativeRequest.md + - file: api/ConnectorUpdateNativeResponse.md + - file: api/ConnectorUpdatePipelineRequest.md + - file: api/ConnectorUpdatePipelineResponse.md + - file: api/ConnectorUpdateSchedulingRequest.md + - file: api/ConnectorUpdateSchedulingResponse.md + - file: api/ConnectorUpdateServiceTypeRequest.md + - file: api/ConnectorUpdateServiceTypeResponse.md + - file: api/ConnectorUpdateStatusRequest.md + - file: api/ConnectorUpdateStatusResponse.md + - file: api/ConnectorValidation.md + - file: api/CoordsGeoBounds.md + - file: api/CountApi_1.md + - file: api/CountApi_2.md + - file: api/CountApi_3.md + - file: api/CountRequest.md + - file: api/CountResponse.md + - file: api/CreateAction.md + - file: api/CreateActionOperation.md + - file: api/CreateApi_1.md + - file: api/CreateApi_2.md + - file: api/CreateApi_3.md + - file: api/CreateRequest.md + - file: api/CreateResponse.md + - file: api/DanglingIndicesDeleteDanglingIndexRequest.md + - file: api/DanglingIndicesDeleteDanglingIndexResponse.md + - file: api/DanglingIndicesImportDanglingIndexRequest.md + - file: api/DanglingIndicesImportDanglingIndexResponse.md + - file: api/DanglingIndicesListDanglingIndicesDanglingIndex.md + - file: api/DanglingIndicesListDanglingIndicesRequest.md + - file: api/DanglingIndicesListDanglingIndicesResponse.md + - file: api/DanglingIndices.md + - file: api/DataStreamName.md + - file: api/DataStreamNames.md + - file: api/DateFormat.md + - file: api/DateMath.md + - file: api/DateTime.md + - file: api/DeleteAction.md + - file: api/DeleteApi_1.md + - file: api/DeleteApi_2.md + - file: api/DeleteApi_3.md + - file: api/DeleteByQueryApi_1.md + - file: api/DeleteByQueryApi_2.md + - file: api/DeleteByQueryApi_3.md + - file: api/DeleteByQueryRequest.md + - file: api/DeleteByQueryResponse.md + - file: api/DeleteByQueryRethrottleApi_1.md + - file: api/DeleteByQueryRethrottleApi_2.md + - file: api/DeleteByQueryRethrottleApi_3.md + - file: api/DeleteByQueryRethrottleRequest.md + - file: api/DeleteByQueryRethrottleResponse.md + - file: api/DeleteRequest.md + - file: api/DeleteResponse.md + - file: api/DeleteScriptApi_1.md + - file: api/DeleteScriptApi_2.md + - file: api/DeleteScriptApi_3.md + - file: api/DeleteScriptRequest.md + - file: api/DeleteScriptResponse.md + - file: api/DFIIndependenceMeasure.md + - file: api/DFRAfterEffect.md + - file: api/DFRBasicModel.md + - file: api/Distance.md + - file: api/DistanceUnit.md + - file: api/DocStats.md + - file: api/double.md + - file: api/DurationLarge.md + - file: api/Duration.md + - file: api/DurationValue.md + - file: api/ElasticsearchVersionInfo.md + - file: api/ElasticsearchVersionMinInfo.md + - file: api/EmptyObject.md + - file: api/EnrichDeletePolicyRequest.md + - file: api/EnrichDeletePolicyResponse.md + - file: api/EnrichExecutePolicyEnrichPolicyPhase.md + - file: api/EnrichExecutePolicyExecuteEnrichPolicyStatus.md + - file: api/EnrichExecutePolicyRequest.md + - file: api/EnrichExecutePolicyResponse.md + - file: api/EnrichGetPolicyRequest.md + - file: api/EnrichGetPolicyResponse.md + - file: api/Enrich.md + - file: api/EnrichPolicy.md + - file: api/EnrichPolicyType.md + - file: api/EnrichPutPolicyRequest.md + - file: api/EnrichPutPolicyResponse.md + - file: api/EnrichStatsCacheStats.md + - file: api/EnrichStatsCoordinatorStats.md + - file: api/EnrichStatsExecutingPolicy.md + - file: api/EnrichStatsRequest.md + - file: api/EnrichStatsResponse.md + - file: api/EnrichSummary.md + - file: api/EpochTime.md + - file: api/EqlDeleteRequest.md + - file: api/EqlDeleteResponse.md + - file: api/EqlEqlHits.md + - file: api/EqlEqlSearchResponseBase.md + - file: api/EqlGetRequest.md + - file: api/EqlGetResponse.md + - file: api/EqlGetStatusRequest.md + - file: api/EqlGetStatusResponse.md + - file: api/EqlHitsEvent.md + - file: api/EqlHitsSequence.md + - file: api/Eql.md + - file: api/EqlSearchRequest.md + - file: api/EqlSearchResponse.md + - file: api/EqlSearchResultPosition.md + - file: api/ErrorCauseKeys.md + - file: api/ErrorCause.md + - file: api/ErrorResponseBase.md + - file: api/EsqlAsyncEsqlResult.md + - file: api/EsqlAsyncQueryDeleteRequest.md + - file: api/EsqlAsyncQueryDeleteResponse.md + - file: api/EsqlAsyncQueryGetRequest.md + - file: api/EsqlAsyncQueryGetResponse.md + - file: api/EsqlAsyncQueryRequest.md + - file: api/EsqlAsyncQueryResponse.md + - file: api/EsqlAsyncQueryStopRequest.md + - file: api/EsqlAsyncQueryStopResponse.md + - file: api/EsqlColumn.md + - file: api/EsqlEsqlClusterDetails.md + - file: api/EsqlEsqlClusterInfo.md + - file: api/EsqlEsqlClusterStatus.md + - file: api/EsqlEsqlColumnInfo.md + - file: api/EsqlEsqlFormat.md + - file: api/EsqlEsqlResult.md + - file: api/EsqlEsqlShardFailure.md + - file: api/EsqlEsqlShardInfo.md + - file: api/EsqlGetQueryRequest.md + - file: api/EsqlGetQueryResponse.md + - file: api/EsqlHelper.md + - file: api/EsqlListQueriesBody.md + - file: api/EsqlListQueriesRequest.md + - file: api/EsqlListQueriesResponse.md + - file: api/Esql.md + - file: api/EsqlQueryRequest.md + - file: api/EsqlQueryResponse.md + - file: api/EsqlTableValuesContainer.md + - file: api/EsqlTableValuesIntegerValue.md + - file: api/EsqlTableValuesKeywordValue.md + - file: api/EsqlTableValuesLongDouble.md + - file: api/EsqlTableValuesLongValue.md + - file: api/EsqlToRecords.md + - file: api/ExistsApi_1.md + - file: api/ExistsApi_2.md + - file: api/ExistsApi_3.md + - file: api/ExistsRequest.md + - file: api/ExistsResponse.md + - file: api/ExistsSourceApi_1.md + - file: api/ExistsSourceApi_2.md + - file: api/ExistsSourceApi_3.md + - file: api/ExistsSourceRequest.md + - file: api/ExistsSourceResponse.md + - file: api/ExpandWildcard.md + - file: api/ExpandWildcards.md + - file: api/ExplainApi_1.md + - file: api/ExplainApi_2.md + - file: api/ExplainApi_3.md + - file: api/ExplainExplanationDetail.md + - file: api/ExplainExplanation.md + - file: api/ExplainRequest.md + - file: api/ExplainResponse.md + - file: api/FeaturesFeature.md + - file: api/FeaturesGetFeaturesRequest.md + - file: api/FeaturesGetFeaturesResponse.md + - file: api/Features.md + - file: api/FeaturesResetFeaturesRequest.md + - file: api/FeaturesResetFeaturesResponse.md + - file: api/FieldCapsApi_1.md + - file: api/FieldCapsApi_2.md + - file: api/FieldCapsApi_3.md + - file: api/FieldCapsFieldCapability.md + - file: api/FieldCapsRequest.md + - file: api/FieldCapsResponse.md + - file: api/FielddataStats.md + - file: api/Field.md + - file: api/FieldMemoryUsage.md + - file: api/FieldSizeUsage.md + - file: api/Fields.md + - file: api/FieldSort.md + - file: api/FieldSortNumericType.md + - file: api/FieldValue.md + - file: api/FleetCheckpoint.md + - file: api/FleetGlobalCheckpointsRequest.md + - file: api/FleetGlobalCheckpointsResponse.md + - file: api/Fleet.md + - file: api/FleetMsearchRequest.md + - file: api/FleetMsearchResponse.md + - file: api/FleetSearchRequest.md + - file: api/FleetSearchResponse.md + - file: api/float.md + - file: api/FlushStats.md + - file: api/Fuzziness.md + - file: api/GeoBounds.md + - file: api/GeoDistanceSortKeys.md + - file: api/GeoDistanceSort.md + - file: api/GeoDistanceType.md + - file: api/GeoHashLocation.md + - file: api/GeoHash.md + - file: api/GeoHashPrecision.md + - file: api/GeoHexCell.md + - file: api/GeoLine.md + - file: api/GeoLocation.md + - file: api/GeoShape.md + - file: api/GeoShapeRelation.md + - file: api/GeoTile.md + - file: api/GeoTilePrecision.md + - file: api/GetApi_1.md + - file: api/GetApi_2.md + - file: api/GetApi_3.md + - file: api/GetGetResult.md + - file: api/GetRequest.md + - file: api/GetResponse.md + - file: api/GetScriptApi_1.md + - file: api/GetScriptApi_2.md + - file: api/GetScriptApi_3.md + - file: api/GetScriptContextApi_1.md + - file: api/GetScriptContextApi_2.md + - file: api/GetScriptContextApi_3.md + - file: api/GetScriptContextContext.md + - file: api/GetScriptContextContextMethod.md + - file: api/GetScriptContextContextMethodParam.md + - file: api/GetScriptContextRequest.md + - file: api/GetScriptContextResponse.md + - file: api/GetScriptLanguagesApi_1.md + - file: api/GetScriptLanguagesApi_2.md + - file: api/GetScriptLanguagesApi_3.md + - file: api/GetScriptLanguagesLanguageContext.md + - file: api/GetScriptLanguagesRequest.md + - file: api/GetScriptLanguagesResponse.md + - file: api/GetScriptRequest.md + - file: api/GetScriptResponse.md + - file: api/GetSourceApi_1.md + - file: api/GetSourceApi_2.md + - file: api/GetSourceApi_3.md + - file: api/GetSourceRequest.md + - file: api/GetSourceResponse.md + - file: api/GetStats.md + - file: api/GraphConnection.md + - file: api/GraphExploreControls.md + - file: api/GraphExploreRequest.md + - file: api/GraphExploreResponse.md + - file: api/GraphHop.md + - file: api/Graph.md + - file: api/GraphSampleDiversity.md + - file: api/GraphVertexDefinition.md + - file: api/GraphVertexInclude.md + - file: api/GraphVertex.md + - file: api/GrokPattern.md + - file: api/HealthReportApi_1.md + - file: api/HealthReportApi_2.md + - file: api/HealthReportApi_3.md + - file: api/HealthReportBaseIndicator.md + - file: api/HealthReportDataStreamLifecycleDetails.md + - file: api/HealthReportDataStreamLifecycleIndicator.md + - file: api/HealthReportDiagnosisAffectedResources.md + - file: api/HealthReportDiagnosis.md + - file: api/HealthReportDiskIndicatorDetails.md + - file: api/HealthReportDiskIndicator.md + - file: api/HealthReportFileSettingsIndicatorDetails.md + - file: api/HealthReportFileSettingsIndicator.md + - file: api/HealthReportIlmIndicatorDetails.md + - file: api/HealthReportIlmIndicator.md + - file: api/HealthReportImpactArea.md + - file: api/HealthReportImpact.md + - file: api/HealthReportIndicatorHealthStatus.md + - file: api/HealthReportIndicatorNode.md + - file: api/HealthReportIndicators.md + - file: api/HealthReportMasterIsStableIndicatorClusterFormationNode.md + - file: api/HealthReportMasterIsStableIndicatorDetails.md + - file: api/HealthReportMasterIsStableIndicatorExceptionFetchingHistory.md + - file: api/HealthReportMasterIsStableIndicator.md + - file: api/HealthReportRepositoryIntegrityIndicatorDetails.md + - file: api/HealthReportRepositoryIntegrityIndicator.md + - file: api/HealthReportRequest.md + - file: api/HealthReportResponse.md + - file: api/HealthReportShardsAvailabilityIndicatorDetails.md + - file: api/HealthReportShardsAvailabilityIndicator.md + - file: api/HealthReportShardsCapacityIndicatorDetails.md + - file: api/HealthReportShardsCapacityIndicator.md + - file: api/HealthReportShardsCapacityIndicatorTierDetail.md + - file: api/HealthReportSlmIndicatorDetails.md + - file: api/HealthReportSlmIndicator.md + - file: api/HealthReportSlmIndicatorUnhealthyPolicies.md + - file: api/HealthReportStagnatingBackingIndices.md + - file: api/HealthStatus.md + - file: api/Helpers.md + - file: api/HelpersOptions.md + - file: api/Host.md + - file: api/HttpHeaders.md + - file: api/IBDistribution.md + - file: api/IBLambda.md + - file: api/Id.md + - file: api/Ids.md + - file: api/IlmActions.md + - file: api/IlmAllocateAction.md + - file: api/IlmDeleteAction.md + - file: api/IlmDeleteLifecycleRequest.md + - file: api/IlmDeleteLifecycleResponse.md + - file: api/IlmDownsampleAction.md + - file: api/IlmExplainLifecycleLifecycleExplainManaged.md + - file: api/IlmExplainLifecycleLifecycleExplain.md + - file: api/IlmExplainLifecycleLifecycleExplainPhaseExecution.md + - file: api/IlmExplainLifecycleLifecycleExplainUnmanaged.md + - file: api/IlmExplainLifecycleRequest.md + - file: api/IlmExplainLifecycleResponse.md + - file: api/IlmForceMergeAction.md + - file: api/IlmGetLifecycleLifecycle.md + - file: api/IlmGetLifecycleRequest.md + - file: api/IlmGetLifecycleResponse.md + - file: api/IlmGetStatusRequest.md + - file: api/IlmGetStatusResponse.md + - file: api/Ilm.md + - file: api/IlmMigrateAction.md + - file: api/IlmMigrateToDataTiersRequest.md + - file: api/IlmMigrateToDataTiersResponse.md + - file: api/IlmMoveToStepRequest.md + - file: api/IlmMoveToStepResponse.md + - file: api/IlmMoveToStepStepKey.md + - file: api/IlmPhase.md + - file: api/IlmPhases.md + - file: api/IlmPolicy.md + - file: api/IlmPutLifecycleRequest.md + - file: api/IlmPutLifecycleResponse.md + - file: api/IlmRemovePolicyRequest.md + - file: api/IlmRemovePolicyResponse.md + - file: api/IlmRetryRequest.md + - file: api/IlmRetryResponse.md + - file: api/IlmRolloverAction.md + - file: api/IlmSearchableSnapshotAction.md + - file: api/IlmSetPriorityAction.md + - file: api/IlmShrinkAction.md + - file: api/IlmStartRequest.md + - file: api/IlmStartResponse.md + - file: api/IlmStopRequest.md + - file: api/IlmStopResponse.md + - file: api/IlmWaitForSnapshotAction.md + - file: api/IndexAction.md + - file: api/IndexActionOperation.md + - file: api/IndexAlias.md + - file: api/IndexApi_1.md + - file: api/IndexApi_2.md + - file: api/IndexApi_3.md + - file: api/IndexingStats.md + - file: api/IndexName.md + - file: api/IndexPattern.md + - file: api/IndexPatterns.md + - file: api/IndexRequest.md + - file: api/IndexResponse.md + - file: api/IndicesAddBlockIndicesBlockOptions.md + - file: api/IndicesAddBlockIndicesBlockStatus.md + - file: api/IndicesAddBlockRequest.md + - file: api/IndicesAddBlockResponse.md + - file: api/IndicesAliasDefinition.md + - file: api/IndicesAlias.md + - file: api/IndicesAnalyzeAnalyzeDetail.md + - file: api/IndicesAnalyzeAnalyzerDetail.md + - file: api/IndicesAnalyzeAnalyzeToken.md + - file: api/IndicesAnalyzeCharFilterDetail.md + - file: api/IndicesAnalyzeExplainAnalyzeTokenKeys.md + - file: api/IndicesAnalyzeExplainAnalyzeToken.md + - file: api/IndicesAnalyzeRequest.md + - file: api/IndicesAnalyzeResponse.md + - file: api/IndicesAnalyzeTextToAnalyze.md + - file: api/IndicesAnalyzeTokenDetail.md + - file: api/IndicesCacheQueries.md + - file: api/IndicesCancelMigrateReindexRequest.md + - file: api/IndicesCancelMigrateReindexResponse.md + - file: api/IndicesClearCacheRequest.md + - file: api/IndicesClearCacheResponse.md + - file: api/IndicesCloneRequest.md + - file: api/IndicesCloneResponse.md + - file: api/IndicesCloseCloseIndexResult.md + - file: api/IndicesCloseCloseShardResult.md + - file: api/IndicesCloseRequest.md + - file: api/IndicesCloseResponse.md + - file: api/IndicesCreateDataStreamRequest.md + - file: api/IndicesCreateDataStreamResponse.md + - file: api/IndicesCreateFromCreateFrom.md + - file: api/IndicesCreateFromRequest.md + - file: api/IndicesCreateFromResponse.md + - file: api/IndicesCreateRequest.md + - file: api/IndicesCreateResponse.md + - file: api/IndicesDataStreamIndex.md + - file: api/IndicesDataStreamLifecycleDownsampling.md + - file: api/IndicesDataStreamLifecycle.md + - file: api/IndicesDataStreamLifecycleRolloverConditions.md + - file: api/IndicesDataStreamLifecycleWithRollover.md + - file: api/IndicesDataStream.md + - file: api/IndicesDataStreamsStatsDataStreamsStatsItem.md + - file: api/IndicesDataStreamsStatsRequest.md + - file: api/IndicesDataStreamsStatsResponse.md + - file: api/IndicesDataStreamTimestampField.md + - file: api/IndicesDataStreamVisibility.md + - file: api/IndicesDeleteAliasRequest.md + - file: api/IndicesDeleteAliasResponse.md + - file: api/IndicesDeleteDataLifecycleRequest.md + - file: api/IndicesDeleteDataLifecycleResponse.md + - file: api/IndicesDeleteDataStreamRequest.md + - file: api/IndicesDeleteDataStreamResponse.md + - file: api/IndicesDeleteIndexTemplateRequest.md + - file: api/IndicesDeleteIndexTemplateResponse.md + - file: api/IndicesDeleteRequest.md + - file: api/IndicesDeleteResponse.md + - file: api/IndicesDeleteTemplateRequest.md + - file: api/IndicesDeleteTemplateResponse.md + - file: api/IndicesDiskUsageRequest.md + - file: api/IndicesDiskUsageResponse.md + - file: api/IndicesDownsampleConfig.md + - file: api/IndicesDownsampleRequest.md + - file: api/IndicesDownsampleResponse.md + - file: api/IndicesDownsamplingRound.md + - file: api/IndicesExistsAliasRequest.md + - file: api/IndicesExistsAliasResponse.md + - file: api/IndicesExistsIndexTemplateRequest.md + - file: api/IndicesExistsIndexTemplateResponse.md + - file: api/IndicesExistsRequest.md + - file: api/IndicesExistsResponse.md + - file: api/IndicesExistsTemplateRequest.md + - file: api/IndicesExistsTemplateResponse.md + - file: api/IndicesExplainDataLifecycleDataStreamLifecycleExplain.md + - file: api/IndicesExplainDataLifecycleRequest.md + - file: api/IndicesExplainDataLifecycleResponse.md + - file: api/IndicesFailureStore.md + - file: api/IndicesFielddataFrequencyFilter.md + - file: api/IndicesFieldUsageStatsFieldSummary.md + - file: api/IndicesFieldUsageStatsFieldsUsageBodyKeys.md + - file: api/IndicesFieldUsageStatsFieldsUsageBody.md + - file: api/IndicesFieldUsageStatsInvertedIndex.md + - file: api/IndicesFieldUsageStatsRequest.md + - file: api/IndicesFieldUsageStatsResponse.md + - file: api/IndicesFieldUsageStatsShardsStats.md + - file: api/IndicesFieldUsageStatsUsageStatsIndex.md + - file: api/IndicesFieldUsageStatsUsageStatsShards.md + - file: api/IndicesFlushRequest.md + - file: api/IndicesFlushResponse.md + - file: api/IndicesForcemergeForceMergeResponseBody.md + - file: api/IndicesForcemergeRequest.md + - file: api/IndicesForcemergeResponse.md + - file: api/IndicesGetAliasIndexAliases.md + - file: api/IndicesGetAliasRequest.md + - file: api/IndicesGetAliasResponse.md + - file: api/IndicesGetDataLifecycleDataStreamWithLifecycle.md + - file: api/IndicesGetDataLifecycleRequest.md + - file: api/IndicesGetDataLifecycleResponse.md + - file: api/IndicesGetDataLifecycleStatsDataStreamStats.md + - file: api/IndicesGetDataLifecycleStatsRequest.md + - file: api/IndicesGetDataLifecycleStatsResponse.md + - file: api/IndicesGetDataStreamRequest.md + - file: api/IndicesGetDataStreamResponse.md + - file: api/IndicesGetFeature.md + - file: api/IndicesGetFeatures.md + - file: api/IndicesGetFieldMappingRequest.md + - file: api/IndicesGetFieldMappingResponse.md + - file: api/IndicesGetFieldMappingTypeFieldMappings.md + - file: api/IndicesGetIndexTemplateIndexTemplateItem.md + - file: api/IndicesGetIndexTemplateRequest.md + - file: api/IndicesGetIndexTemplateResponse.md + - file: api/IndicesGetMappingIndexMappingRecord.md + - file: api/IndicesGetMappingRequest.md + - file: api/IndicesGetMappingResponse.md + - file: api/IndicesGetMigrateReindexStatusRequest.md + - file: api/IndicesGetMigrateReindexStatusResponse.md + - file: api/IndicesGetMigrateReindexStatusStatusError.md + - file: api/IndicesGetMigrateReindexStatusStatusInProgress.md + - file: api/IndicesGetRequest.md + - file: api/IndicesGetResponse.md + - file: api/IndicesGetSettingsRequest.md + - file: api/IndicesGetSettingsResponse.md + - file: api/IndicesGetTemplateRequest.md + - file: api/IndicesGetTemplateResponse.md + - file: api/IndicesIndexCheckOnStartup.md + - file: api/IndicesIndexingPressure.md + - file: api/IndicesIndexingPressureMemory.md + - file: api/IndicesIndexingSlowlogSettings.md + - file: api/IndicesIndexingSlowlogTresholds.md + - file: api/IndicesIndexMode.md + - file: api/IndicesIndexRoutingAllocationDisk.md + - file: api/IndicesIndexRoutingAllocationInclude.md + - file: api/IndicesIndexRoutingAllocationInitialRecovery.md + - file: api/IndicesIndexRoutingAllocation.md + - file: api/IndicesIndexRoutingAllocationOptions.md + - file: api/IndicesIndexRouting.md + - file: api/IndicesIndexRoutingRebalance.md + - file: api/IndicesIndexRoutingRebalanceOptions.md + - file: api/IndicesIndexSegmentSort.md + - file: api/IndicesIndexSettingBlocks.md + - file: api/IndicesIndexSettingsAnalysis.md + - file: api/IndicesIndexSettingsKeys.md + - file: api/IndicesIndexSettingsLifecycle.md + - file: api/IndicesIndexSettingsLifecycleStep.md + - file: api/IndicesIndexSettings.md + - file: api/IndicesIndexSettingsTimeSeries.md + - file: api/IndicesIndexState.md + - file: api/IndicesIndexTemplateDataStreamConfiguration.md + - file: api/IndicesIndexTemplate.md + - file: api/IndicesIndexTemplateSummary.md + - file: api/IndicesIndexVersioning.md + - file: api/IndicesManagedBy.md + - file: api/IndicesMappingLimitSettingsDepth.md + - file: api/IndicesMappingLimitSettingsDimensionFields.md + - file: api/IndicesMappingLimitSettingsFieldNameLength.md + - file: api/IndicesMappingLimitSettings.md + - file: api/IndicesMappingLimitSettingsNestedFields.md + - file: api/IndicesMappingLimitSettingsNestedObjects.md + - file: api/IndicesMappingLimitSettingsSourceFields.md + - file: api/IndicesMappingLimitSettingsTotalFields.md + - file: api/Indices.md + - file: api/IndicesMerge.md + - file: api/IndicesMergeScheduler.md + - file: api/IndicesMigrateReindexMigrateReindex.md + - file: api/IndicesMigrateReindexModeEnum.md + - file: api/IndicesMigrateReindexRequest.md + - file: api/IndicesMigrateReindexResponse.md + - file: api/IndicesMigrateReindexSourceIndex.md + - file: api/IndicesMigrateToDataStreamRequest.md + - file: api/IndicesMigrateToDataStreamResponse.md + - file: api/IndicesModifyDataStreamAction.md + - file: api/IndicesModifyDataStreamIndexAndDataStreamAction.md + - file: api/IndicesModifyDataStreamRequest.md + - file: api/IndicesModifyDataStreamResponse.md + - file: api/IndicesNumericFielddataFormat.md + - file: api/IndicesNumericFielddata.md + - file: api/IndicesOpenRequest.md + - file: api/IndicesOpenResponse.md + - file: api/IndicesOptions.md + - file: api/IndicesPromoteDataStreamRequest.md + - file: api/IndicesPromoteDataStreamResponse.md + - file: api/IndicesPutAliasRequest.md + - file: api/IndicesPutAliasResponse.md + - file: api/IndicesPutDataLifecycleRequest.md + - file: api/IndicesPutDataLifecycleResponse.md + - file: api/IndicesPutIndexTemplateIndexTemplateMapping.md + - file: api/IndicesPutIndexTemplateRequest.md + - file: api/IndicesPutIndexTemplateResponse.md + - file: api/IndicesPutMappingRequest.md + - file: api/IndicesPutMappingResponse.md + - file: api/IndicesPutSettingsRequest.md + - file: api/IndicesPutSettingsResponse.md + - file: api/IndicesPutTemplateRequest.md + - file: api/IndicesPutTemplateResponse.md + - file: api/IndicesQueries.md + - file: api/IndicesRecoveryFileDetails.md + - file: api/IndicesRecoveryRecoveryBytes.md + - file: api/IndicesRecoveryRecoveryFiles.md + - file: api/IndicesRecoveryRecoveryIndexStatus.md + - file: api/IndicesRecoveryRecoveryOrigin.md + - file: api/IndicesRecoveryRecoveryStartStatus.md + - file: api/IndicesRecoveryRecoveryStatus.md + - file: api/IndicesRecoveryRequest.md + - file: api/IndicesRecoveryResponse.md + - file: api/IndicesRecoveryShardRecovery.md + - file: api/IndicesRecoveryTranslogStatus.md + - file: api/IndicesRecoveryVerifyIndex.md + - file: api/IndicesRefreshRequest.md + - file: api/IndicesRefreshResponse.md + - file: api/IndicesReloadSearchAnalyzersReloadDetails.md + - file: api/IndicesReloadSearchAnalyzersReloadResult.md + - file: api/IndicesReloadSearchAnalyzersRequest.md + - file: api/IndicesReloadSearchAnalyzersResponse.md + - file: api/IndicesResolveClusterRequest.md + - file: api/IndicesResolveClusterResolveClusterInfo.md + - file: api/IndicesResolveClusterResponse.md + - file: api/IndicesResolveIndexRequest.md + - file: api/IndicesResolveIndexResolveIndexAliasItem.md + - file: api/IndicesResolveIndexResolveIndexDataStreamsItem.md + - file: api/IndicesResolveIndexResolveIndexItem.md + - file: api/IndicesResolveIndexResponse.md + - file: api/IndicesResponseBase.md + - file: api/IndicesRetentionLease.md + - file: api/IndicesRolloverRequest.md + - file: api/IndicesRolloverResponse.md + - file: api/IndicesRolloverRolloverConditions.md + - file: api/IndicesSearchIdle.md + - file: api/IndicesSegmentsIndexSegment.md + - file: api/IndicesSegmentSortMissing.md + - file: api/IndicesSegmentSortMode.md + - file: api/IndicesSegmentSortOrder.md + - file: api/IndicesSegmentsRequest.md + - file: api/IndicesSegmentsResponse.md + - file: api/IndicesSegmentsSegment.md + - file: api/IndicesSegmentsShardSegmentRouting.md + - file: api/IndicesSegmentsShardsSegment.md + - file: api/IndicesSettingsAnalyze.md + - file: api/IndicesSettingsHighlight.md + - file: api/IndicesSettingsQueryString.md + - file: api/IndicesSettingsSearch.md + - file: api/IndicesSettingsSimilarityBm25.md + - file: api/IndicesSettingsSimilarityBoolean.md + - file: api/IndicesSettingsSimilarityDfi.md + - file: api/IndicesSettingsSimilarityDfr.md + - file: api/IndicesSettingsSimilarityIb.md + - file: api/IndicesSettingsSimilarityLmd.md + - file: api/IndicesSettingsSimilarityLmj.md + - file: api/IndicesSettingsSimilarity.md + - file: api/IndicesSettingsSimilarityScripted.md + - file: api/IndicesShardStoresIndicesShardStores.md + - file: api/IndicesShardStoresRequest.md + - file: api/IndicesShardStoresResponse.md + - file: api/IndicesShardStoresShardStoreAllocation.md + - file: api/IndicesShardStoresShardStoreException.md + - file: api/IndicesShardStoresShardStoreKeys.md + - file: api/IndicesShardStoresShardStore.md + - file: api/IndicesShardStoresShardStoreNode.md + - file: api/IndicesShardStoresShardStoreStatus.md + - file: api/IndicesShardStoresShardStoreWrapper.md + - file: api/IndicesShrinkRequest.md + - file: api/IndicesShrinkResponse.md + - file: api/IndicesSimulateIndexTemplateRequest.md + - file: api/IndicesSimulateIndexTemplateResponse.md + - file: api/IndicesSimulateTemplateOverlapping.md + - file: api/IndicesSimulateTemplateRequest.md + - file: api/IndicesSimulateTemplateResponse.md + - file: api/IndicesSimulateTemplateTemplate.md + - file: api/IndicesSlowlogSettings.md + - file: api/IndicesSlowlogTresholdLevels.md + - file: api/IndicesSlowlogTresholds.md + - file: api/IndicesSoftDeletes.md + - file: api/IndicesSourceMode.md + - file: api/IndicesSplitRequest.md + - file: api/IndicesSplitResponse.md + - file: api/IndicesStatsIndexMetadataState.md + - file: api/IndicesStatsIndexStats.md + - file: api/IndicesStatsIndicesStats.md + - file: api/IndicesStatsMappingStats.md + - file: api/IndicesStatsRequest.md + - file: api/IndicesStatsResponse.md + - file: api/IndicesStatsShardCommit.md + - file: api/IndicesStatsShardFileSizeInfo.md + - file: api/IndicesStatsShardLease.md + - file: api/IndicesStatsShardPath.md + - file: api/IndicesStatsShardQueryCache.md + - file: api/IndicesStatsShardRetentionLeases.md + - file: api/IndicesStatsShardRouting.md + - file: api/IndicesStatsShardRoutingState.md + - file: api/IndicesStatsShardSequenceNumber.md + - file: api/IndicesStatsShardStats.md + - file: api/IndicesStatsShardsTotalStats.md + - file: api/IndicesStorage.md + - file: api/IndicesStorageType.md + - file: api/IndicesTemplateMapping.md + - file: api/IndicesTranslogDurability.md + - file: api/IndicesTranslog.md + - file: api/IndicesTranslogRetention.md + - file: api/IndicesUpdateAliasesAction.md + - file: api/IndicesUpdateAliasesAddAction.md + - file: api/IndicesUpdateAliasesRemoveAction.md + - file: api/IndicesUpdateAliasesRemoveIndexAction.md + - file: api/IndicesUpdateAliasesRequest.md + - file: api/IndicesUpdateAliasesResponse.md + - file: api/IndicesValidateQueryIndicesValidationExplanation.md + - file: api/IndicesValidateQueryRequest.md + - file: api/IndicesValidateQueryResponse.md + - file: api/InferenceAdaptiveAllocations.md + - file: api/InferenceAlibabaCloudServiceSettings.md + - file: api/InferenceAlibabaCloudServiceType.md + - file: api/InferenceAlibabaCloudTaskSettings.md + - file: api/InferenceAlibabaCloudTaskType.md + - file: api/InferenceAmazonBedrockServiceSettings.md + - file: api/InferenceAmazonBedrockServiceType.md + - file: api/InferenceAmazonBedrockTaskSettings.md + - file: api/InferenceAmazonBedrockTaskType.md + - file: api/InferenceAnthropicServiceSettings.md + - file: api/InferenceAnthropicServiceType.md + - file: api/InferenceAnthropicTaskSettings.md + - file: api/InferenceAnthropicTaskType.md + - file: api/InferenceAzureAiStudioServiceSettings.md + - file: api/InferenceAzureAiStudioServiceType.md + - file: api/InferenceAzureAiStudioTaskSettings.md + - file: api/InferenceAzureAiStudioTaskType.md + - file: api/InferenceAzureOpenAIServiceSettings.md + - file: api/InferenceAzureOpenAIServiceType.md + - file: api/InferenceAzureOpenAITaskSettings.md + - file: api/InferenceAzureOpenAITaskType.md + - file: api/InferenceChatCompletionUnifiedRequest.md + - file: api/InferenceChatCompletionUnifiedResponse.md + - file: api/InferenceCohereEmbeddingType.md + - file: api/InferenceCohereInputType.md + - file: api/InferenceCohereServiceSettings.md + - file: api/InferenceCohereServiceType.md + - file: api/InferenceCohereSimilarityType.md + - file: api/InferenceCohereTaskSettings.md + - file: api/InferenceCohereTaskType.md + - file: api/InferenceCohereTruncateType.md + - file: api/InferenceCompletionInferenceResult.md + - file: api/InferenceCompletionRequest.md + - file: api/InferenceCompletionResponse.md + - file: api/InferenceCompletionResult.md + - file: api/InferenceCompletionToolChoiceFunction.md + - file: api/InferenceCompletionToolChoice.md + - file: api/InferenceCompletionToolFunction.md + - file: api/InferenceCompletionTool.md + - file: api/InferenceCompletionToolType.md + - file: api/InferenceContentObject.md + - file: api/InferenceDeleteInferenceEndpointResult.md + - file: api/InferenceDeleteRequest.md + - file: api/InferenceDeleteResponse.md + - file: api/InferenceDenseByteVector.md + - file: api/InferenceDenseVector.md + - file: api/InferenceElasticsearchServiceSettings.md + - file: api/InferenceElasticsearchServiceType.md + - file: api/InferenceElasticsearchTaskSettings.md + - file: api/InferenceElasticsearchTaskType.md + - file: api/InferenceElserServiceSettings.md + - file: api/InferenceElserServiceType.md + - file: api/InferenceElserTaskType.md + - file: api/InferenceGetRequest.md + - file: api/InferenceGetResponse.md + - file: api/InferenceGoogleAiServiceType.md + - file: api/InferenceGoogleAiStudioServiceSettings.md + - file: api/InferenceGoogleAiStudioTaskType.md + - file: api/InferenceGoogleVertexAIServiceSettings.md + - file: api/InferenceGoogleVertexAIServiceType.md + - file: api/InferenceGoogleVertexAITaskSettings.md + - file: api/InferenceGoogleVertexAITaskType.md + - file: api/InferenceHuggingFaceServiceSettings.md + - file: api/InferenceHuggingFaceServiceType.md + - file: api/InferenceHuggingFaceTaskType.md + - file: api/InferenceInferenceChunkingSettings.md + - file: api/InferenceInferenceEndpointInfo.md + - file: api/InferenceInferenceEndpoint.md + - file: api/InferenceInferenceRequest.md + - file: api/InferenceInferenceResponse.md + - file: api/InferenceInferenceResult.md + - file: api/InferenceJinaAIServiceSettings.md + - file: api/InferenceJinaAIServiceType.md + - file: api/InferenceJinaAISimilarityType.md + - file: api/InferenceJinaAITaskSettings.md + - file: api/InferenceJinaAITaskType.md + - file: api/InferenceJinaAITextEmbeddingTask.md + - file: api/Inference.md + - file: api/InferenceMessageContent.md + - file: api/InferenceMessage.md + - file: api/InferenceMistralServiceSettings.md + - file: api/InferenceMistralServiceType.md + - file: api/InferenceMistralTaskType.md + - file: api/InferenceOpenAIServiceSettings.md + - file: api/InferenceOpenAIServiceType.md + - file: api/InferenceOpenAITaskSettings.md + - file: api/InferenceOpenAITaskType.md + - file: api/InferencePutAlibabacloudRequest.md + - file: api/InferencePutAlibabacloudResponse.md + - file: api/InferencePutAmazonbedrockRequest.md + - file: api/InferencePutAmazonbedrockResponse.md + - file: api/InferencePutAnthropicRequest.md + - file: api/InferencePutAnthropicResponse.md + - file: api/InferencePutAzureaistudioRequest.md + - file: api/InferencePutAzureaistudioResponse.md + - file: api/InferencePutAzureopenaiRequest.md + - file: api/InferencePutAzureopenaiResponse.md + - file: api/InferencePutCohereRequest.md + - file: api/InferencePutCohereResponse.md + - file: api/InferencePutElasticsearchRequest.md + - file: api/InferencePutElasticsearchResponse.md + - file: api/InferencePutElserRequest.md + - file: api/InferencePutElserResponse.md + - file: api/InferencePutGoogleaistudioRequest.md + - file: api/InferencePutGoogleaistudioResponse.md + - file: api/InferencePutGooglevertexaiRequest.md + - file: api/InferencePutGooglevertexaiResponse.md + - file: api/InferencePutHuggingFaceRequest.md + - file: api/InferencePutHuggingFaceResponse.md + - file: api/InferencePutJinaaiRequest.md + - file: api/InferencePutJinaaiResponse.md + - file: api/InferencePutMistralRequest.md + - file: api/InferencePutMistralResponse.md + - file: api/InferencePutOpenaiRequest.md + - file: api/InferencePutOpenaiResponse.md + - file: api/InferencePutRequest.md + - file: api/InferencePutResponse.md + - file: api/InferencePutVoyageaiRequest.md + - file: api/InferencePutVoyageaiResponse.md + - file: api/InferencePutWatsonxRequest.md + - file: api/InferencePutWatsonxResponse.md + - file: api/InferenceRankedDocument.md + - file: api/InferenceRateLimitSetting.md + - file: api/InferenceRequestChatCompletion.md + - file: api/InferenceRerankedInferenceResult.md + - file: api/InferenceRerankRequest.md + - file: api/InferenceRerankResponse.md + - file: api/InferenceServiceSettings.md + - file: api/InferenceSparseEmbeddingInferenceResult.md + - file: api/InferenceSparseEmbeddingRequest.md + - file: api/InferenceSparseEmbeddingResponse.md + - file: api/InferenceSparseEmbeddingResult.md + - file: api/InferenceSparseVector.md + - file: api/InferenceStreamCompletionRequest.md + - file: api/InferenceStreamCompletionResponse.md + - file: api/InferenceTaskSettings.md + - file: api/InferenceTaskType.md + - file: api/InferenceTextEmbeddingByteResult.md + - file: api/InferenceTextEmbeddingInferenceResult.md + - file: api/InferenceTextEmbeddingRequest.md + - file: api/InferenceTextEmbeddingResponse.md + - file: api/InferenceTextEmbeddingResult.md + - file: api/InferenceToolCallFunction.md + - file: api/InferenceToolCall.md + - file: api/InferenceUpdateRequest.md + - file: api/InferenceUpdateResponse.md + - file: api/InferenceVoyageAIServiceSettings.md + - file: api/InferenceVoyageAIServiceType.md + - file: api/InferenceVoyageAITaskSettings.md + - file: api/InferenceVoyageAITaskType.md + - file: api/InferenceWatsonxServiceSettings.md + - file: api/InferenceWatsonxServiceType.md + - file: api/InferenceWatsonxTaskType.md + - file: api/InfoApi_1.md + - file: api/InfoApi_2.md + - file: api/InfoApi_3.md + - file: api/InfoRequest.md + - file: api/InfoResponse.md + - file: api/IngestAppendProcessor.md + - file: api/IngestAttachmentProcessor.md + - file: api/IngestBytesProcessor.md + - file: api/IngestCircleProcessor.md + - file: api/IngestCommunityIDProcessor.md + - file: api/IngestConvertProcessor.md + - file: api/IngestConvertType.md + - file: api/IngestCsvProcessor.md + - file: api/IngestDatabaseConfigurationFull.md + - file: api/IngestDatabaseConfiguration.md + - file: api/IngestDateIndexNameProcessor.md + - file: api/IngestDateProcessor.md + - file: api/IngestDeleteGeoipDatabaseRequest.md + - file: api/IngestDeleteGeoipDatabaseResponse.md + - file: api/IngestDeleteIpLocationDatabaseRequest.md + - file: api/IngestDeleteIpLocationDatabaseResponse.md + - file: api/IngestDeletePipelineRequest.md + - file: api/IngestDeletePipelineResponse.md + - file: api/IngestDissectProcessor.md + - file: api/IngestDocument.md + - file: api/IngestDocumentSimulationKeys.md + - file: api/IngestDocumentSimulation.md + - file: api/IngestDotExpanderProcessor.md + - file: api/IngestDropProcessor.md + - file: api/IngestEnrichProcessor.md + - file: api/IngestFailProcessor.md + - file: api/IngestFingerprintDigest.md + - file: api/IngestFingerprintProcessor.md + - file: api/IngestForeachProcessor.md + - file: api/IngestGeoGridProcessor.md + - file: api/IngestGeoGridTargetFormat.md + - file: api/IngestGeoGridTileType.md + - file: api/IngestGeoIpProcessor.md + - file: api/IngestGeoIpStatsGeoIpDownloadStatistics.md + - file: api/IngestGeoIpStatsGeoIpNodeDatabaseName.md + - file: api/IngestGeoIpStatsGeoIpNodeDatabases.md + - file: api/IngestGeoIpStatsRequest.md + - file: api/IngestGeoIpStatsResponse.md + - file: api/IngestGetGeoipDatabaseDatabaseConfigurationMetadata.md + - file: api/IngestGetGeoipDatabaseRequest.md + - file: api/IngestGetGeoipDatabaseResponse.md + - file: api/IngestGetIpLocationDatabaseDatabaseConfigurationMetadata.md + - file: api/IngestGetIpLocationDatabaseRequest.md + - file: api/IngestGetIpLocationDatabaseResponse.md + - file: api/IngestGetPipelineRequest.md + - file: api/IngestGetPipelineResponse.md + - file: api/IngestGrokProcessor.md + - file: api/IngestGsubProcessor.md + - file: api/IngestHtmlStripProcessor.md + - file: api/IngestInferenceConfigClassification.md + - file: api/IngestInferenceConfig.md + - file: api/IngestInferenceConfigRegression.md + - file: api/IngestInferenceProcessor.md + - file: api/IngestIngest.md + - file: api/IngestInputConfig.md + - file: api/IngestIpinfo.md + - file: api/IngestIpLocationProcessor.md + - file: api/IngestJoinProcessor.md + - file: api/IngestJsonProcessorConflictStrategy.md + - file: api/IngestJsonProcessor.md + - file: api/IngestKeyValueProcessor.md + - file: api/IngestLocal.md + - file: api/IngestLowercaseProcessor.md + - file: api/IngestMaxmind.md + - file: api/Ingest.md + - file: api/IngestNetworkDirectionProcessor.md + - file: api/IngestPipelineConfig.md + - file: api/IngestPipeline.md + - file: api/IngestPipelineProcessor.md + - file: api/IngestPipelineProcessorResult.md + - file: api/IngestPipelineSimulationStatusOptions.md + - file: api/IngestProcessorBase.md + - file: api/IngestProcessorContainer.md + - file: api/IngestProcessorGrokRequest.md + - file: api/IngestProcessorGrokResponse.md + - file: api/IngestPutGeoipDatabaseRequest.md + - file: api/IngestPutGeoipDatabaseResponse.md + - file: api/IngestPutIpLocationDatabaseRequest.md + - file: api/IngestPutIpLocationDatabaseResponse.md + - file: api/IngestPutPipelineRequest.md + - file: api/IngestPutPipelineResponse.md + - file: api/IngestRedact.md + - file: api/IngestRedactProcessor.md + - file: api/IngestRegisteredDomainProcessor.md + - file: api/IngestRemoveProcessor.md + - file: api/IngestRenameProcessor.md + - file: api/IngestRerouteProcessor.md + - file: api/IngestScriptProcessor.md + - file: api/IngestSetProcessor.md + - file: api/IngestSetSecurityUserProcessor.md + - file: api/IngestShapeType.md + - file: api/IngestSimulateDocumentResult.md + - file: api/IngestSimulateRequest.md + - file: api/IngestSimulateResponse.md + - file: api/IngestSortProcessor.md + - file: api/IngestSplitProcessor.md + - file: api/IngestTerminateProcessor.md + - file: api/IngestTrimProcessor.md + - file: api/IngestUppercaseProcessor.md + - file: api/IngestUriPartsProcessor.md + - file: api/IngestUrlDecodeProcessor.md + - file: api/IngestUserAgentProcessor.md + - file: api/IngestUserAgentProperty.md + - file: api/IngestWeb.md + - file: api/InlineGetKeys.md + - file: api/InlineGet.md + - file: api/integer.md + - file: api/Ip.md + - file: api/KnnQuery.md + - file: api/KnnRetriever.md + - file: api/KnnSearchApi_1.md + - file: api/KnnSearchApi_2.md + - file: api/KnnSearchApi_3.md + - file: api/KnnSearch.md + - file: api/LatLonGeoLocation.md + - file: api/Level.md + - file: api/LicenseDeleteRequest.md + - file: api/LicenseDeleteResponse.md + - file: api/LicenseGetBasicStatusRequest.md + - file: api/LicenseGetBasicStatusResponse.md + - file: api/LicenseGetLicenseInformation.md + - file: api/LicenseGetRequest.md + - file: api/LicenseGetResponse.md + - file: api/LicenseGetTrialStatusRequest.md + - file: api/LicenseGetTrialStatusResponse.md + - file: api/LicenseLicense.md + - file: api/LicenseLicenseStatus.md + - file: api/LicenseLicenseType.md + - file: api/License.md + - file: api/LicensePostAcknowledgement.md + - file: api/LicensePostRequest.md + - file: api/LicensePostResponse.md + - file: api/LicensePostStartBasicRequest.md + - file: api/LicensePostStartBasicResponse.md + - file: api/LicensePostStartTrialRequest.md + - file: api/LicensePostStartTrialResponse.md + - file: api/LifecycleOperationMode.md + - file: api/LogstashDeletePipelineRequest.md + - file: api/LogstashDeletePipelineResponse.md + - file: api/LogstashGetPipelineRequest.md + - file: api/LogstashGetPipelineResponse.md + - file: api/Logstash.md + - file: api/LogstashPipeline.md + - file: api/LogstashPipelineMetadata.md + - file: api/LogstashPipelineSettings.md + - file: api/LogstashPutPipelineRequest.md + - file: api/LogstashPutPipelineResponse.md + - file: api/long.md + - file: api/MapboxVectorTiles.md + - file: api/MappingAggregateMetricDoubleProperty.md + - file: api/MappingAllField.md + - file: api/MappingBinaryProperty.md + - file: api/MappingBooleanProperty.md + - file: api/MappingByteNumberProperty.md + - file: api/MappingChunkingSettings.md + - file: api/MappingCompletionProperty.md + - file: api/MappingCompositeSubField.md + - file: api/MappingConstantKeywordProperty.md + - file: api/MappingCorePropertyBase.md + - file: api/MappingCountedKeywordProperty.md + - file: api/MappingDataStreamTimestamp.md + - file: api/MappingDateNanosProperty.md + - file: api/MappingDateProperty.md + - file: api/MappingDateRangeProperty.md + - file: api/MappingDenseVectorElementType.md + - file: api/MappingDenseVectorIndexOptions.md + - file: api/MappingDenseVectorIndexOptionsRescoreVector.md + - file: api/MappingDenseVectorIndexOptionsType.md + - file: api/MappingDenseVectorProperty.md + - file: api/MappingDenseVectorSimilarity.md + - file: api/MappingDocValuesPropertyBase.md + - file: api/MappingDoubleNumberProperty.md + - file: api/MappingDoubleRangeProperty.md + - file: api/MappingDynamicMapping.md + - file: api/MappingDynamicProperty.md + - file: api/MappingDynamicTemplate.md + - file: api/MappingFieldAliasProperty.md + - file: api/MappingFieldMapping.md + - file: api/MappingFieldNamesField.md + - file: api/MappingFieldType.md + - file: api/MappingFlattenedProperty.md + - file: api/MappingFloatNumberProperty.md + - file: api/MappingFloatRangeProperty.md + - file: api/MappingGeoOrientation.md + - file: api/MappingGeoPointProperty.md + - file: api/MappingGeoShapeProperty.md + - file: api/MappingGeoStrategy.md + - file: api/MappingHalfFloatNumberProperty.md + - file: api/MappingHistogramProperty.md + - file: api/MappingIcuCollationProperty.md + - file: api/MappingIndexField.md + - file: api/MappingIndexOptions.md + - file: api/MappingIntegerNumberProperty.md + - file: api/MappingIntegerRangeProperty.md + - file: api/MappingIpProperty.md + - file: api/MappingIpRangeProperty.md + - file: api/MappingJoinProperty.md + - file: api/MappingKeywordProperty.md + - file: api/MappingLongNumberProperty.md + - file: api/MappingLongRangeProperty.md + - file: api/MappingMatchOnlyTextProperty.md + - file: api/MappingMatchType.md + - file: api/MappingMurmur3HashProperty.md + - file: api/MappingNestedProperty.md + - file: api/MappingNumberPropertyBase.md + - file: api/MappingObjectProperty.md + - file: api/MappingOnScriptError.md + - file: api/MappingPassthroughObjectProperty.md + - file: api/MappingPercolatorProperty.md + - file: api/MappingPointProperty.md + - file: api/MappingPropertyBase.md + - file: api/MappingProperty.md + - file: api/MappingRangePropertyBase.md + - file: api/MappingRankFeatureProperty.md + - file: api/MappingRankFeaturesProperty.md + - file: api/MappingRoutingField.md + - file: api/MappingRuntimeFieldFetchFields.md + - file: api/MappingRuntimeField.md + - file: api/MappingRuntimeFields.md + - file: api/MappingRuntimeFieldType.md + - file: api/MappingScaledFloatNumberProperty.md + - file: api/MappingSearchAsYouTypeProperty.md + - file: api/MappingSemanticTextProperty.md + - file: api/MappingShapeProperty.md + - file: api/MappingShortNumberProperty.md + - file: api/MappingSizeField.md + - file: api/MappingSourceField.md + - file: api/MappingSourceFieldMode.md + - file: api/MappingSparseVectorProperty.md + - file: api/MappingSubobjects.md + - file: api/MappingSuggestContext.md + - file: api/MappingSyntheticSourceKeepEnum.md + - file: api/MappingTermVectorOption.md + - file: api/MappingTextIndexPrefixes.md + - file: api/MappingTextProperty.md + - file: api/MappingTimeSeriesMetricType.md + - file: api/MappingTokenCountProperty.md + - file: api/MappingTypeMapping.md + - file: api/MappingUnsignedLongNumberProperty.md + - file: api/MappingVersionProperty.md + - file: api/MappingWildcardProperty.md + - file: api/MergesStats.md + - file: api/Metadata.md + - file: api/Metrics.md + - file: api/MgetApi_1.md + - file: api/MgetApi_2.md + - file: api/MgetApi_3.md + - file: api/MgetMultiGetError.md + - file: api/MgetOperation.md + - file: api/MgetRequest.md + - file: api/MgetResponseItem.md + - file: api/MgetResponse.md + - file: api/MigrationDeprecationsDeprecationLevel.md + - file: api/MigrationDeprecationsDeprecation.md + - file: api/MigrationDeprecationsRequest.md + - file: api/MigrationDeprecationsResponse.md + - file: api/MigrationGetFeatureUpgradeStatusMigrationFeatureIndexInfo.md + - file: api/MigrationGetFeatureUpgradeStatusMigrationFeature.md + - file: api/MigrationGetFeatureUpgradeStatusMigrationStatus.md + - file: api/MigrationGetFeatureUpgradeStatusRequest.md + - file: api/MigrationGetFeatureUpgradeStatusResponse.md + - file: api/Migration.md + - file: api/MigrationPostFeatureUpgradeMigrationFeature.md + - file: api/MigrationPostFeatureUpgradeRequest.md + - file: api/MigrationPostFeatureUpgradeResponse.md + - file: api/MinimumShouldMatch.md + - file: api/MlAdaptiveAllocationsSettings.md + - file: api/MlAnalysisConfig.md + - file: api/MlAnalysisConfigRead.md + - file: api/MlAnalysisLimits.md + - file: api/MlAnalysisMemoryLimit.md + - file: api/MlAnomalyCause.md + - file: api/MlAnomalyExplanation.md + - file: api/MlAnomaly.md + - file: api/MlApiKeyAuthorization.md + - file: api/MlAppliesTo.md + - file: api/MlBucketInfluencer.md + - file: api/MlBucketSummary.md + - file: api/MlCalendarEvent.md + - file: api/MlCategorizationAnalyzerDefinition.md + - file: api/MlCategorizationAnalyzer.md + - file: api/MlCategorizationStatus.md + - file: api/MlCategory.md + - file: api/MlChunkingConfig.md + - file: api/MlChunkingMode.md + - file: api/MlClassificationInferenceOptions.md + - file: api/MlClearTrainedModelDeploymentCacheRequest.md + - file: api/MlClearTrainedModelDeploymentCacheResponse.md + - file: api/MlCloseJobRequest.md + - file: api/MlCloseJobResponse.md + - file: api/MlCommonTokenizationConfig.md + - file: api/MlConditionOperator.md + - file: api/MlCustomSettings.md + - file: api/MlDataCounts.md + - file: api/MlDataDescription.md + - file: api/MlDatafeedAuthorization.md + - file: api/MlDatafeedConfig.md + - file: api/MlDatafeed.md + - file: api/MlDatafeedRunningState.md + - file: api/MlDatafeedState.md + - file: api/MlDatafeedStats.md + - file: api/MlDatafeedTimingStats.md + - file: api/MlDataframeAnalysisAnalyzedFields.md + - file: api/MlDataframeAnalysisClassification.md + - file: api/MlDataframeAnalysisContainer.md + - file: api/MlDataframeAnalysisFeatureProcessorFrequencyEncoding.md + - file: api/MlDataframeAnalysisFeatureProcessor.md + - file: api/MlDataframeAnalysisFeatureProcessorMultiEncoding.md + - file: api/MlDataframeAnalysisFeatureProcessorNGramEncoding.md + - file: api/MlDataframeAnalysisFeatureProcessorOneHotEncoding.md + - file: api/MlDataframeAnalysisFeatureProcessorTargetMeanEncoding.md + - file: api/MlDataframeAnalysis.md + - file: api/MlDataframeAnalysisOutlierDetection.md + - file: api/MlDataframeAnalysisRegression.md + - file: api/MlDataframeAnalyticsAuthorization.md + - file: api/MlDataframeAnalyticsDestination.md + - file: api/MlDataframeAnalyticsFieldSelection.md + - file: api/MlDataframeAnalytics.md + - file: api/MlDataframeAnalyticsMemoryEstimation.md + - file: api/MlDataframeAnalyticsSource.md + - file: api/MlDataframeAnalyticsStatsContainer.md + - file: api/MlDataframeAnalyticsStatsDataCounts.md + - file: api/MlDataframeAnalyticsStatsHyperparameters.md + - file: api/MlDataframeAnalyticsStatsMemoryUsage.md + - file: api/MlDataframeAnalyticsStatsOutlierDetection.md + - file: api/MlDataframeAnalyticsStatsProgress.md + - file: api/MlDataframeAnalyticsSummary.md + - file: api/MlDataframeEvaluationClassification.md + - file: api/MlDataframeEvaluationClassificationMetricsAucRoc.md + - file: api/MlDataframeEvaluationClassificationMetrics.md + - file: api/MlDataframeEvaluationContainer.md + - file: api/MlDataframeEvaluationMetrics.md + - file: api/MlDataframeEvaluationOutlierDetection.md + - file: api/MlDataframeEvaluationOutlierDetectionMetrics.md + - file: api/MlDataframeEvaluationRegression.md + - file: api/MlDataframeEvaluationRegressionMetricsHuber.md + - file: api/MlDataframeEvaluationRegressionMetrics.md + - file: api/MlDataframeEvaluationRegressionMetricsMsle.md + - file: api/MlDataframeState.md + - file: api/MlDelayedDataCheckConfig.md + - file: api/MlDeleteCalendarEventRequest.md + - file: api/MlDeleteCalendarEventResponse.md + - file: api/MlDeleteCalendarJobRequest.md + - file: api/MlDeleteCalendarJobResponse.md + - file: api/MlDeleteCalendarRequest.md + - file: api/MlDeleteCalendarResponse.md + - file: api/MlDeleteDatafeedRequest.md + - file: api/MlDeleteDatafeedResponse.md + - file: api/MlDeleteDataFrameAnalyticsRequest.md + - file: api/MlDeleteDataFrameAnalyticsResponse.md + - file: api/MlDeleteExpiredDataRequest.md + - file: api/MlDeleteExpiredDataResponse.md + - file: api/MlDeleteFilterRequest.md + - file: api/MlDeleteFilterResponse.md + - file: api/MlDeleteForecastRequest.md + - file: api/MlDeleteForecastResponse.md + - file: api/MlDeleteJobRequest.md + - file: api/MlDeleteJobResponse.md + - file: api/MlDeleteModelSnapshotRequest.md + - file: api/MlDeleteModelSnapshotResponse.md + - file: api/MlDeleteTrainedModelAliasRequest.md + - file: api/MlDeleteTrainedModelAliasResponse.md + - file: api/MlDeleteTrainedModelRequest.md + - file: api/MlDeleteTrainedModelResponse.md + - file: api/MlDeploymentAllocationState.md + - file: api/MlDeploymentAssignmentState.md + - file: api/MlDetectionRule.md + - file: api/MlDetector.md + - file: api/MlDetectorRead.md + - file: api/MlDetectorUpdate.md + - file: api/MlDiscoveryNodeCompact.md + - file: api/MlDiscoveryNodeContent.md + - file: api/MlDiscoveryNode.md + - file: api/MlEstimateModelMemoryRequest.md + - file: api/MlEstimateModelMemoryResponse.md + - file: api/MlEvaluateDataFrameConfusionMatrixItem.md + - file: api/MlEvaluateDataFrameConfusionMatrixPrediction.md + - file: api/MlEvaluateDataFrameConfusionMatrixThreshold.md + - file: api/MlEvaluateDataFrameDataframeClassificationSummaryAccuracy.md + - file: api/MlEvaluateDataFrameDataframeClassificationSummary.md + - file: api/MlEvaluateDataFrameDataframeClassificationSummaryMulticlassConfusionMatrix.md + - file: api/MlEvaluateDataFrameDataframeClassificationSummaryPrecision.md + - file: api/MlEvaluateDataFrameDataframeClassificationSummaryRecall.md + - file: api/MlEvaluateDataFrameDataframeEvaluationClass.md + - file: api/MlEvaluateDataFrameDataframeEvaluationSummaryAucRocCurveItem.md + - file: api/MlEvaluateDataFrameDataframeEvaluationSummaryAucRoc.md + - file: api/MlEvaluateDataFrameDataframeEvaluationValue.md + - file: api/MlEvaluateDataFrameDataframeOutlierDetectionSummary.md + - file: api/MlEvaluateDataFrameDataframeRegressionSummary.md + - file: api/MlEvaluateDataFrameRequest.md + - file: api/MlEvaluateDataFrameResponse.md + - file: api/MlExcludeFrequent.md + - file: api/MlExplainDataFrameAnalyticsRequest.md + - file: api/MlExplainDataFrameAnalyticsResponse.md + - file: api/MlExponentialAverageCalculationContext.md + - file: api/MlFeatureExtractor.md + - file: api/MlFillMaskInferenceOptions.md + - file: api/MlFillMaskInferenceUpdateOptions.md + - file: api/MlFilter.md + - file: api/MlFilterRef.md + - file: api/MlFilterType.md + - file: api/MlFlushJobRequest.md + - file: api/MlFlushJobResponse.md + - file: api/MlForecastRequest.md + - file: api/MlForecastResponse.md + - file: api/MlGeoResults.md + - file: api/MlGetBucketsRequest.md + - file: api/MlGetBucketsResponse.md + - file: api/MlGetCalendarEventsRequest.md + - file: api/MlGetCalendarEventsResponse.md + - file: api/MlGetCalendarsCalendar.md + - file: api/MlGetCalendarsRequest.md + - file: api/MlGetCalendarsResponse.md + - file: api/MlGetCategoriesRequest.md + - file: api/MlGetCategoriesResponse.md + - file: api/MlGetDatafeedsRequest.md + - file: api/MlGetDatafeedsResponse.md + - file: api/MlGetDatafeedStatsRequest.md + - file: api/MlGetDatafeedStatsResponse.md + - file: api/MlGetDataFrameAnalyticsRequest.md + - file: api/MlGetDataFrameAnalyticsResponse.md + - file: api/MlGetDataFrameAnalyticsStatsRequest.md + - file: api/MlGetDataFrameAnalyticsStatsResponse.md + - file: api/MlGetFiltersRequest.md + - file: api/MlGetFiltersResponse.md + - file: api/MlGetInfluencersRequest.md + - file: api/MlGetInfluencersResponse.md + - file: api/MlGetJobsRequest.md + - file: api/MlGetJobsResponse.md + - file: api/MlGetJobStatsRequest.md + - file: api/MlGetJobStatsResponse.md + - file: api/MlGetMemoryStatsJvmStats.md + - file: api/MlGetMemoryStatsMemMlStats.md + - file: api/MlGetMemoryStatsMemory.md + - file: api/MlGetMemoryStatsMemStats.md + - file: api/MlGetMemoryStatsRequest.md + - file: api/MlGetMemoryStatsResponse.md + - file: api/MlGetModelSnapshotsRequest.md + - file: api/MlGetModelSnapshotsResponse.md + - file: api/MlGetModelSnapshotUpgradeStatsRequest.md + - file: api/MlGetModelSnapshotUpgradeStatsResponse.md + - file: api/MlGetOverallBucketsRequest.md + - file: api/MlGetOverallBucketsResponse.md + - file: api/MlGetRecordsRequest.md + - file: api/MlGetRecordsResponse.md + - file: api/MlGetTrainedModelsRequest.md + - file: api/MlGetTrainedModelsResponse.md + - file: api/MlGetTrainedModelsStatsRequest.md + - file: api/MlGetTrainedModelsStatsResponse.md + - file: api/MlHyperparameter.md + - file: api/MlHyperparameters.md + - file: api/MlInclude.md + - file: api/MlInferenceConfigCreateContainer.md + - file: api/MlInferenceConfigUpdateContainer.md + - file: api/MlInferenceResponseResult.md + - file: api/MlInferTrainedModelRequest.md + - file: api/MlInferTrainedModelResponse.md + - file: api/MlInfluence.md + - file: api/MlInfluencer.md + - file: api/MlInfoAnomalyDetectors.md + - file: api/MlInfoDatafeeds.md + - file: api/MlInfoDefaults.md + - file: api/MlInfoLimits.md + - file: api/MlInfoNativeCode.md + - file: api/MlInfoRequest.md + - file: api/MlInfoResponse.md + - file: api/MlJobBlocked.md + - file: api/MlJobBlockedReason.md + - file: api/MlJobConfig.md + - file: api/MlJobForecastStatistics.md + - file: api/MlJob.md + - file: api/MlJobState.md + - file: api/MlJobStatistics.md + - file: api/MlJobStats.md + - file: api/MlJobTimingStats.md + - file: api/MlLearningToRankConfig.md + - file: api/Ml.md + - file: api/MlMemoryStatus.md + - file: api/MlModelPackageConfig.md + - file: api/MlModelPlotConfig.md + - file: api/MlModelSizeStats.md + - file: api/MlModelSnapshot.md + - file: api/MlModelSnapshotUpgrade.md + - file: api/MlNerInferenceOptions.md + - file: api/MlNerInferenceUpdateOptions.md + - file: api/MlNlpBertTokenizationConfig.md + - file: api/MlNlpRobertaTokenizationConfig.md + - file: api/MlNlpTokenizationUpdateOptions.md + - file: api/MlOpenJobRequest.md + - file: api/MlOpenJobResponse.md + - file: api/MlOutlierDetectionParameters.md + - file: api/MlOverallBucketJob.md + - file: api/MlOverallBucket.md + - file: api/MlPage.md + - file: api/MlPassThroughInferenceOptions.md + - file: api/MlPassThroughInferenceUpdateOptions.md + - file: api/MlPerPartitionCategorization.md + - file: api/MlPostCalendarEventsRequest.md + - file: api/MlPostCalendarEventsResponse.md + - file: api/MlPostDataRequest.md + - file: api/MlPostDataResponse.md + - file: api/MlPredictedValue.md + - file: api/MlPreviewDatafeedRequest.md + - file: api/MlPreviewDatafeedResponse.md + - file: api/MlPreviewDataFrameAnalyticsDataframePreviewConfig.md + - file: api/MlPreviewDataFrameAnalyticsRequest.md + - file: api/MlPreviewDataFrameAnalyticsResponse.md + - file: api/MlPutCalendarJobRequest.md + - file: api/MlPutCalendarJobResponse.md + - file: api/MlPutCalendarRequest.md + - file: api/MlPutCalendarResponse.md + - file: api/MlPutDatafeedRequest.md + - file: api/MlPutDatafeedResponse.md + - file: api/MlPutDataFrameAnalyticsRequest.md + - file: api/MlPutDataFrameAnalyticsResponse.md + - file: api/MlPutFilterRequest.md + - file: api/MlPutFilterResponse.md + - file: api/MlPutJobRequest.md + - file: api/MlPutJobResponse.md + - file: api/MlPutTrainedModelAggregateOutput.md + - file: api/MlPutTrainedModelAliasRequest.md + - file: api/MlPutTrainedModelAliasResponse.md + - file: api/MlPutTrainedModelDefinition.md + - file: api/MlPutTrainedModelDefinitionPartRequest.md + - file: api/MlPutTrainedModelDefinitionPartResponse.md + - file: api/MlPutTrainedModelEnsemble.md + - file: api/MlPutTrainedModelFrequencyEncodingPreprocessor.md + - file: api/MlPutTrainedModelInput.md + - file: api/MlPutTrainedModelOneHotEncodingPreprocessor.md + - file: api/MlPutTrainedModelPreprocessor.md + - file: api/MlPutTrainedModelRequest.md + - file: api/MlPutTrainedModelResponse.md + - file: api/MlPutTrainedModelTargetMeanEncodingPreprocessor.md + - file: api/MlPutTrainedModelTrainedModel.md + - file: api/MlPutTrainedModelTrainedModelTree.md + - file: api/MlPutTrainedModelTrainedModelTreeNode.md + - file: api/MlPutTrainedModelVocabularyRequest.md + - file: api/MlPutTrainedModelVocabularyResponse.md + - file: api/MlPutTrainedModelWeights.md + - file: api/MlQueryFeatureExtractor.md + - file: api/MlQuestionAnsweringInferenceOptions.md + - file: api/MlQuestionAnsweringInferenceUpdateOptions.md + - file: api/MlRegressionInferenceOptions.md + - file: api/MlResetJobRequest.md + - file: api/MlResetJobResponse.md + - file: api/MlRevertModelSnapshotRequest.md + - file: api/MlRevertModelSnapshotResponse.md + - file: api/MlRoutingState.md + - file: api/MlRuleAction.md + - file: api/MlRuleCondition.md + - file: api/MlRunningStateSearchInterval.md + - file: api/MlSetUpgradeModeRequest.md + - file: api/MlSetUpgradeModeResponse.md + - file: api/MlSnapshotUpgradeState.md + - file: api/MlStartDatafeedRequest.md + - file: api/MlStartDatafeedResponse.md + - file: api/MlStartDataFrameAnalyticsRequest.md + - file: api/MlStartDataFrameAnalyticsResponse.md + - file: api/MlStartTrainedModelDeploymentRequest.md + - file: api/MlStartTrainedModelDeploymentResponse.md + - file: api/MlStopDatafeedRequest.md + - file: api/MlStopDatafeedResponse.md + - file: api/MlStopDataFrameAnalyticsRequest.md + - file: api/MlStopDataFrameAnalyticsResponse.md + - file: api/MlStopTrainedModelDeploymentRequest.md + - file: api/MlStopTrainedModelDeploymentResponse.md + - file: api/MlTextClassificationInferenceOptions.md + - file: api/MlTextClassificationInferenceUpdateOptions.md + - file: api/MlTextEmbeddingInferenceOptions.md + - file: api/MlTextEmbeddingInferenceUpdateOptions.md + - file: api/MlTextExpansionInferenceOptions.md + - file: api/MlTextExpansionInferenceUpdateOptions.md + - file: api/MlTimingStats.md + - file: api/MlTokenizationConfigContainer.md + - file: api/MlTokenizationTruncate.md + - file: api/MlTopClassEntry.md + - file: api/MlTotalFeatureImportanceClass.md + - file: api/MlTotalFeatureImportance.md + - file: api/MlTotalFeatureImportanceStatistics.md + - file: api/MlTrainedModelAssignment.md + - file: api/MlTrainedModelAssignmentRoutingStateAndReason.md + - file: api/MlTrainedModelAssignmentRoutingTable.md + - file: api/MlTrainedModelAssignmentTaskParameters.md + - file: api/MlTrainedModelConfigInput.md + - file: api/MlTrainedModelConfig.md + - file: api/MlTrainedModelConfigMetadata.md + - file: api/MlTrainedModelDeploymentAllocationStatus.md + - file: api/MlTrainedModelDeploymentNodesStats.md + - file: api/MlTrainedModelDeploymentStats.md + - file: api/MlTrainedModelEntities.md + - file: api/MlTrainedModelInferenceClassImportance.md + - file: api/MlTrainedModelInferenceFeatureImportance.md + - file: api/MlTrainedModelInferenceStats.md + - file: api/MlTrainedModelLocationIndex.md + - file: api/MlTrainedModelLocation.md + - file: api/MlTrainedModelPrefixStrings.md + - file: api/MlTrainedModelSizeStats.md + - file: api/MlTrainedModelStats.md + - file: api/MlTrainedModelType.md + - file: api/MlTrainingPriority.md + - file: api/MlTransformAuthorization.md + - file: api/MlUpdateDatafeedRequest.md + - file: api/MlUpdateDatafeedResponse.md + - file: api/MlUpdateDataFrameAnalyticsRequest.md + - file: api/MlUpdateDataFrameAnalyticsResponse.md + - file: api/MlUpdateFilterRequest.md + - file: api/MlUpdateFilterResponse.md + - file: api/MlUpdateJobRequest.md + - file: api/MlUpdateJobResponse.md + - file: api/MlUpdateModelSnapshotRequest.md + - file: api/MlUpdateModelSnapshotResponse.md + - file: api/MlUpdateTrainedModelDeploymentRequest.md + - file: api/MlUpdateTrainedModelDeploymentResponse.md + - file: api/MlUpgradeJobSnapshotRequest.md + - file: api/MlUpgradeJobSnapshotResponse.md + - file: api/MlValidateDetectorRequest.md + - file: api/MlValidateDetectorResponse.md + - file: api/MlValidateRequest.md + - file: api/MlValidateResponse.md + - file: api/MlValidationLoss.md + - file: api/MlVocabulary.md + - file: api/MlXlmRobertaTokenizationConfig.md + - file: api/MlZeroShotClassificationInferenceOptions.md + - file: api/MlZeroShotClassificationInferenceUpdateOptions.md + - file: api/MonitoringBulkRequest.md + - file: api/MonitoringBulkResponse.md + - file: api/Monitoring.md + - file: api/MsearchApi_1.md + - file: api/MsearchApi_2.md + - file: api/MsearchApi_3.md + - file: api/MsearchHelper.md + - file: api/MsearchHelperOptions.md + - file: api/MsearchHelperResponse.md + - file: api/MsearchMultisearchHeader.md + - file: api/MsearchMultiSearchItem.md + - file: api/MsearchMultiSearchResult.md + - file: api/MsearchRequestItem.md + - file: api/MsearchRequest.md + - file: api/MsearchResponseItem.md + - file: api/MsearchResponse.md + - file: api/MsearchTemplateApi_1.md + - file: api/MsearchTemplateApi_2.md + - file: api/MsearchTemplateApi_3.md + - file: api/MsearchTemplateRequestItem.md + - file: api/MsearchTemplateRequest.md + - file: api/MsearchTemplateResponse.md + - file: api/MsearchTemplateTemplateConfig.md + - file: api/MtermvectorsApi_1.md + - file: api/MtermvectorsApi_2.md + - file: api/MtermvectorsApi_3.md + - file: api/MtermvectorsOperation.md + - file: api/MtermvectorsRequest.md + - file: api/MtermvectorsResponse.md + - file: api/MtermvectorsTermVectorsResult.md + - file: api/MultiTermQueryRewrite.md + - file: api/Name.md + - file: api/Names.md + - file: api/Namespace.md + - file: api/NestedSortValue.md + - file: api/NodeAttributes.md + - file: api/NodeId.md + - file: api/NodeIds.md + - file: api/NodeName.md + - file: api/NodeOptions.md + - file: api/NodeRole.md + - file: api/NodeRoles.md + - file: api/NodesAdaptiveSelection.md + - file: api/NodesBreaker.md + - file: api/NodesCgroupCpu.md + - file: api/NodesCgroupCpuStat.md + - file: api/NodesCgroup.md + - file: api/NodesCgroupMemory.md + - file: api/NodesClearRepositoriesMeteringArchiveRequest.md + - file: api/NodesClearRepositoriesMeteringArchiveResponseBase.md + - file: api/NodesClearRepositoriesMeteringArchiveResponse.md + - file: api/NodesClient.md + - file: api/NodesClusterAppliedStats.md + - file: api/NodesClusterStateQueue.md + - file: api/NodesClusterStateUpdate.md + - file: api/NodesContext.md + - file: api/NodesCpuAcct.md + - file: api/NodesCpu.md + - file: api/NodesDataPathStats.md + - file: api/NodesDiscovery.md + - file: api/NodesExtendedMemoryStats.md + - file: api/NodesFileSystem.md + - file: api/NodesFileSystemTotal.md + - file: api/NodesGarbageCollector.md + - file: api/NodesGarbageCollectorTotal.md + - file: api/NodesGetRepositoriesMeteringInfoRequest.md + - file: api/NodesGetRepositoriesMeteringInfoResponseBase.md + - file: api/NodesGetRepositoriesMeteringInfoResponse.md + - file: api/NodeShard.md + - file: api/NodesHotThreadsRequest.md + - file: api/NodesHotThreadsResponse.md + - file: api/NodesHttp.md + - file: api/NodesHttpRoute.md + - file: api/NodesHttpRouteRequests.md + - file: api/NodesHttpRouteResponses.md + - file: api/NodesIndexingPressure.md + - file: api/NodesIndexingPressureMemory.md + - file: api/NodesInfoDeprecationIndexing.md + - file: api/NodesInfoNodeInfoAction.md + - file: api/NodesInfoNodeInfoAggregation.md + - file: api/NodesInfoNodeInfoBootstrap.md + - file: api/NodesInfoNodeInfoClient.md + - file: api/NodesInfoNodeInfoDiscoverKeys.md + - file: api/NodesInfoNodeInfoDiscover.md + - file: api/NodesInfoNodeInfoHttp.md + - file: api/NodesInfoNodeInfoIngestDownloader.md + - file: api/NodesInfoNodeInfoIngestInfo.md + - file: api/NodesInfoNodeInfoIngest.md + - file: api/NodesInfoNodeInfoIngestProcessor.md + - file: api/NodesInfoNodeInfoJvmMemory.md + - file: api/NodesInfoNodeInfo.md + - file: api/NodesInfoNodeInfoMemory.md + - file: api/NodesInfoNodeInfoNetworkInterface.md + - file: api/NodesInfoNodeInfoNetwork.md + - file: api/NodesInfoNodeInfoOSCPU.md + - file: api/NodesInfoNodeInfoPath.md + - file: api/NodesInfoNodeInfoRepositories.md + - file: api/NodesInfoNodeInfoRepositoriesUrl.md + - file: api/NodesInfoNodeInfoScript.md + - file: api/NodesInfoNodeInfoSearch.md + - file: api/NodesInfoNodeInfoSearchRemote.md + - file: api/NodesInfoNodeInfoSettingsClusterElection.md + - file: api/NodesInfoNodeInfoSettingsCluster.md + - file: api/NodesInfoNodeInfoSettingsHttp.md + - file: api/NodesInfoNodeInfoSettingsHttpType.md + - file: api/NodesInfoNodeInfoSettingsIngest.md + - file: api/NodesInfoNodeInfoSettings.md + - file: api/NodesInfoNodeInfoSettingsNetwork.md + - file: api/NodesInfoNodeInfoSettingsNode.md + - file: api/NodesInfoNodeInfoSettingsTransportFeatures.md + - file: api/NodesInfoNodeInfoSettingsTransport.md + - file: api/NodesInfoNodeInfoSettingsTransportType.md + - file: api/NodesInfoNodeInfoTransport.md + - file: api/NodesInfoNodeInfoXpackLicense.md + - file: api/NodesInfoNodeInfoXpackLicenseType.md + - file: api/NodesInfoNodeInfoXpack.md + - file: api/NodesInfoNodeInfoXpackMl.md + - file: api/NodesInfoNodeInfoXpackSecurityAuthc.md + - file: api/NodesInfoNodeInfoXpackSecurityAuthcRealms.md + - file: api/NodesInfoNodeInfoXpackSecurityAuthcRealmsStatus.md + - file: api/NodesInfoNodeInfoXpackSecurityAuthcToken.md + - file: api/NodesInfoNodeInfoXpackSecurity.md + - file: api/NodesInfoNodeInfoXpackSecuritySsl.md + - file: api/NodesInfoNodeJvmInfo.md + - file: api/NodesInfoNodeOperatingSystemInfo.md + - file: api/NodesInfoNodeProcessInfo.md + - file: api/NodesInfoNodeThreadPoolInfo.md + - file: api/NodesInfoRequest.md + - file: api/NodesInfoResponseBase.md + - file: api/NodesInfoResponse.md + - file: api/NodesIngest.md + - file: api/NodesIngestStats.md + - file: api/NodesIngestTotal.md + - file: api/NodesIoStatDevice.md + - file: api/NodesIoStats.md + - file: api/NodesJvmClasses.md + - file: api/NodesJvm.md + - file: api/NodesJvmMemoryStats.md + - file: api/NodesJvmThreads.md + - file: api/NodesKeyedProcessor.md + - file: api/Nodes.md + - file: api/NodesMemoryStats.md + - file: api/NodesNodeBufferPool.md + - file: api/NodesNodeReloadResult.md + - file: api/NodesNodesResponseBase.md + - file: api/NodesOperatingSystem.md + - file: api/NodesPool.md + - file: api/NodesPressureMemory.md + - file: api/NodesProcess.md + - file: api/NodesProcessor.md + - file: api/NodesPublishedClusterStates.md + - file: api/NodesRecording.md + - file: api/NodesReloadSecureSettingsRequest.md + - file: api/NodesReloadSecureSettingsResponseBase.md + - file: api/NodesReloadSecureSettingsResponse.md + - file: api/NodesRepositoryLocation.md + - file: api/NodesRepositoryMeteringInformation.md + - file: api/NodesRequestCounts.md + - file: api/NodesScriptCache.md + - file: api/NodesScripting.md + - file: api/NodesSerializedClusterStateDetail.md + - file: api/NodesSerializedClusterState.md + - file: api/NodesSizeHttpHistogram.md + - file: api/NodesStats.md + - file: api/NodesStatsRequest.md + - file: api/NodesStatsResponseBase.md + - file: api/NodesStatsResponse.md + - file: api/NodeStatistics.md + - file: api/NodesThreadCount.md + - file: api/NodesTimeHttpHistogram.md + - file: api/NodesTransportHistogram.md + - file: api/NodesTransport.md + - file: api/NodesUsageNodeUsage.md + - file: api/NodesUsageRequest.md + - file: api/NodesUsageResponseBase.md + - file: api/NodesUsageResponse.md + - file: api/Normalization.md + - file: api/OnDropDocument.md + - file: api/OnSuccessDocument.md + - file: api/OpenPointInTimeApi_1.md + - file: api/OpenPointInTimeApi_2.md + - file: api/OpenPointInTimeApi_3.md + - file: api/OpenPointInTimeRequest.md + - file: api/OpenPointInTimeResponse.md + - file: api/OpType.md + - file: api/Password.md + - file: api/Percentage.md + - file: api/PingApi_1.md + - file: api/PingApi_2.md + - file: api/PingApi_3.md + - file: api/PingRequest.md + - file: api/PingResponse.md + - file: api/PipelineName.md + - file: api/PluginStats.md + - file: api/Profiling.md + - file: api/PropertyName.md + - file: api/PutScriptApi_1.md + - file: api/PutScriptApi_2.md + - file: api/PutScriptApi_3.md + - file: api/PutScriptRequest.md + - file: api/PutScriptResponse.md + - file: api/QueryCacheStats.md + - file: api/QueryDslBoolQuery.md + - file: api/QueryDslBoostingQuery.md + - file: api/QueryDslChildScoreMode.md + - file: api/QueryDslCombinedFieldsOperator.md + - file: api/QueryDslCombinedFieldsQuery.md + - file: api/QueryDslCombinedFieldsZeroTerms.md + - file: api/QueryDslCommonTermsQuery.md + - file: api/QueryDslConstantScoreQuery.md + - file: api/QueryDslDateDecayFunctionKeys.md + - file: api/QueryDslDateDecayFunction.md + - file: api/QueryDslDateDistanceFeatureQuery.md + - file: api/QueryDslDateRangeQuery.md + - file: api/QueryDslDecayFunctionBase.md + - file: api/QueryDslDecayFunction.md + - file: api/QueryDslDecayPlacement.md + - file: api/QueryDslDisMaxQuery.md + - file: api/QueryDslDistanceFeatureQueryBase.md + - file: api/QueryDslDistanceFeatureQuery.md + - file: api/QueryDslExistsQuery.md + - file: api/QueryDslFieldAndFormat.md + - file: api/QueryDslFieldLookup.md + - file: api/QueryDslFieldValueFactorModifier.md + - file: api/QueryDslFieldValueFactorScoreFunction.md + - file: api/QueryDslFunctionBoostMode.md + - file: api/QueryDslFunctionScoreContainer.md + - file: api/QueryDslFunctionScoreMode.md + - file: api/QueryDslFunctionScoreQuery.md + - file: api/QueryDslFuzzyQuery.md + - file: api/QueryDslGeoBoundingBoxQueryKeys.md + - file: api/QueryDslGeoBoundingBoxQuery.md + - file: api/QueryDslGeoDecayFunctionKeys.md + - file: api/QueryDslGeoDecayFunction.md + - file: api/QueryDslGeoDistanceFeatureQuery.md + - file: api/QueryDslGeoDistanceQueryKeys.md + - file: api/QueryDslGeoDistanceQuery.md + - file: api/QueryDslGeoExecution.md + - file: api/QueryDslGeoGridQuery.md + - file: api/QueryDslGeoPolygonPoints.md + - file: api/QueryDslGeoPolygonQueryKeys.md + - file: api/QueryDslGeoPolygonQuery.md + - file: api/QueryDslGeoShapeFieldQuery.md + - file: api/QueryDslGeoShapeQueryKeys.md + - file: api/QueryDslGeoShapeQuery.md + - file: api/QueryDslGeoValidationMethod.md + - file: api/QueryDslHasChildQuery.md + - file: api/QueryDslHasParentQuery.md + - file: api/QueryDslIdsQuery.md + - file: api/QueryDslIntervalsAllOf.md + - file: api/QueryDslIntervalsAnyOf.md + - file: api/QueryDslIntervalsContainer.md + - file: api/QueryDslIntervalsFilter.md + - file: api/QueryDslIntervalsFuzzy.md + - file: api/QueryDslIntervalsMatch.md + - file: api/QueryDslIntervalsPrefix.md + - file: api/QueryDslIntervalsQuery.md + - file: api/QueryDslIntervalsWildcard.md + - file: api/QueryDslLikeDocument.md + - file: api/QueryDslLike.md + - file: api/QueryDslMatchAllQuery.md + - file: api/QueryDslMatchBoolPrefixQuery.md + - file: api/QueryDslMatchNoneQuery.md + - file: api/QueryDslMatchPhrasePrefixQuery.md + - file: api/QueryDslMatchPhraseQuery.md + - file: api/QueryDslMatchQuery.md + - file: api/QueryDslMoreLikeThisQuery.md + - file: api/QueryDslMultiMatchQuery.md + - file: api/QueryDslMultiValueMode.md + - file: api/QueryDslNestedQuery.md + - file: api/QueryDslNumberRangeQuery.md + - file: api/QueryDslNumericDecayFunctionKeys.md + - file: api/QueryDslNumericDecayFunction.md + - file: api/QueryDslOperator.md + - file: api/QueryDslParentIdQuery.md + - file: api/QueryDslPercolateQuery.md + - file: api/QueryDslPinnedDoc.md + - file: api/QueryDslPinnedQuery.md + - file: api/QueryDslPrefixQuery.md + - file: api/QueryDslQueryBase.md + - file: api/QueryDslQueryContainer.md + - file: api/QueryDslQueryStringQuery.md + - file: api/QueryDslRandomScoreFunction.md + - file: api/QueryDslRangeQueryBase.md + - file: api/QueryDslRangeQuery.md + - file: api/QueryDslRangeRelation.md + - file: api/QueryDslRankFeatureFunctionLinear.md + - file: api/QueryDslRankFeatureFunctionLogarithm.md + - file: api/QueryDslRankFeatureFunction.md + - file: api/QueryDslRankFeatureFunctionSaturation.md + - file: api/QueryDslRankFeatureFunctionSigmoid.md + - file: api/QueryDslRankFeatureQuery.md + - file: api/QueryDslRegexpQuery.md + - file: api/QueryDslRuleQuery.md + - file: api/QueryDslScriptQuery.md + - file: api/QueryDslScriptScoreFunction.md + - file: api/QueryDslScriptScoreQuery.md + - file: api/QueryDslSemanticQuery.md + - file: api/QueryDslShapeFieldQuery.md + - file: api/QueryDslShapeQueryKeys.md + - file: api/QueryDslShapeQuery.md + - file: api/QueryDslSimpleQueryStringFlag.md + - file: api/QueryDslSimpleQueryStringFlags.md + - file: api/QueryDslSimpleQueryStringQuery.md + - file: api/QueryDslSpanContainingQuery.md + - file: api/QueryDslSpanFieldMaskingQuery.md + - file: api/QueryDslSpanFirstQuery.md + - file: api/QueryDslSpanGapQuery.md + - file: api/QueryDslSpanMultiTermQuery.md + - file: api/QueryDslSpanNearQuery.md + - file: api/QueryDslSpanNotQuery.md + - file: api/QueryDslSpanOrQuery.md + - file: api/QueryDslSpanQuery.md + - file: api/QueryDslSpanTermQuery.md + - file: api/QueryDslSpanWithinQuery.md + - file: api/QueryDslSparseVectorQuery.md + - file: api/QueryDslTermQuery.md + - file: api/QueryDslTermRangeQuery.md + - file: api/QueryDslTermsLookup.md + - file: api/QueryDslTermsQueryField.md + - file: api/QueryDslTermsQueryKeys.md + - file: api/QueryDslTermsQuery.md + - file: api/QueryDslTermsSetQuery.md + - file: api/QueryDslTextExpansionQuery.md + - file: api/QueryDslTextQueryType.md + - file: api/QueryDslTokenPruningConfig.md + - file: api/QueryDslTypeQuery.md + - file: api/QueryDslUntypedDecayFunctionKeys.md + - file: api/QueryDslUntypedDecayFunction.md + - file: api/QueryDslUntypedDistanceFeatureQuery.md + - file: api/QueryDslUntypedRangeQuery.md + - file: api/QueryDslWeightedTokensQuery.md + - file: api/QueryDslWildcardQuery.md + - file: api/QueryDslWrapperQuery.md + - file: api/QueryDslZeroTermsQuery.md + - file: api/QueryRulesDeleteRuleRequest.md + - file: api/QueryRulesDeleteRuleResponse.md + - file: api/QueryRulesDeleteRulesetRequest.md + - file: api/QueryRulesDeleteRulesetResponse.md + - file: api/QueryRulesGetRuleRequest.md + - file: api/QueryRulesGetRuleResponse.md + - file: api/QueryRulesGetRulesetRequest.md + - file: api/QueryRulesGetRulesetResponse.md + - file: api/QueryRulesListRulesetsQueryRulesetListItem.md + - file: api/QueryRulesListRulesetsRequest.md + - file: api/QueryRulesListRulesetsResponse.md + - file: api/QueryRules.md + - file: api/QueryRulesPutRuleRequest.md + - file: api/QueryRulesPutRuleResponse.md + - file: api/QueryRulesPutRulesetRequest.md + - file: api/QueryRulesPutRulesetResponse.md + - file: api/QueryRulesQueryRuleActions.md + - file: api/QueryRulesQueryRuleCriteria.md + - file: api/QueryRulesQueryRuleCriteriaType.md + - file: api/QueryRulesQueryRule.md + - file: api/QueryRulesQueryRuleset.md + - file: api/QueryRulesQueryRuleType.md + - file: api/QueryRulesTestQueryRulesetMatchedRule.md + - file: api/QueryRulesTestRequest.md + - file: api/QueryRulesTestResponse.md + - file: api/QueryVectorBuilder.md + - file: api/QueryVector.md + - file: api/RankBase.md + - file: api/RankContainer.md + - file: api/RankEvalApi_1.md + - file: api/RankEvalApi_2.md + - file: api/RankEvalApi_3.md + - file: api/RankEvalDocumentRating.md + - file: api/RankEvalRankEvalHitItem.md + - file: api/RankEvalRankEvalHit.md + - file: api/RankEvalRankEvalMetricBase.md + - file: api/RankEvalRankEvalMetricDetail.md + - file: api/RankEvalRankEvalMetricDiscountedCumulativeGain.md + - file: api/RankEvalRankEvalMetricExpectedReciprocalRank.md + - file: api/RankEvalRankEvalMetric.md + - file: api/RankEvalRankEvalMetricMeanReciprocalRank.md + - file: api/RankEvalRankEvalMetricPrecision.md + - file: api/RankEvalRankEvalMetricRatingTreshold.md + - file: api/RankEvalRankEvalMetricRecall.md + - file: api/RankEvalRankEvalQuery.md + - file: api/RankEvalRankEvalRequestItem.md + - file: api/RankEvalRequest.md + - file: api/RankEvalResponse.md + - file: api/RankEvalUnratedDocument.md + - file: api/RecoveryStats.md + - file: api/Refresh.md + - file: api/RefreshStats.md + - file: api/ReindexApi_1.md + - file: api/ReindexApi_2.md + - file: api/ReindexApi_3.md + - file: api/ReindexDestination.md + - file: api/ReindexRemoteSource.md + - file: api/ReindexRequest.md + - file: api/ReindexResponse.md + - file: api/ReindexRethrottleApi_1.md + - file: api/ReindexRethrottleApi_2.md + - file: api/ReindexRethrottleApi_3.md + - file: api/ReindexRethrottleReindexNode.md + - file: api/ReindexRethrottleReindexStatus.md + - file: api/ReindexRethrottleReindexTask.md + - file: api/ReindexRethrottleRequest.md + - file: api/ReindexRethrottleResponse.md + - file: api/ReindexSource.md + - file: api/RelationName.md + - file: api/RelocationFailureInfo.md + - file: api/RenderSearchTemplateApi_1.md + - file: api/RenderSearchTemplateApi_2.md + - file: api/RenderSearchTemplateApi_3.md + - file: api/RenderSearchTemplateRequest.md + - file: api/RenderSearchTemplateResponse.md + - file: api/RequestBase.md + - file: api/RequestCacheStats.md + - file: api/RescoreVector.md + - file: api/Result.md + - file: api/Retries.md + - file: api/RetrieverBase.md + - file: api/RetrieverContainer.md + - file: api/RollupDateHistogramGrouping.md + - file: api/RollupDeleteJobRequest.md + - file: api/RollupDeleteJobResponse.md + - file: api/RollupFieldMetric.md + - file: api/RollupGetJobsIndexingJobState.md + - file: api/RollupGetJobsRequest.md + - file: api/RollupGetJobsResponse.md + - file: api/RollupGetJobsRollupJobConfiguration.md + - file: api/RollupGetJobsRollupJob.md + - file: api/RollupGetJobsRollupJobStats.md + - file: api/RollupGetJobsRollupJobStatus.md + - file: api/RollupGetRollupCapsRequest.md + - file: api/RollupGetRollupCapsResponse.md + - file: api/RollupGetRollupCapsRollupCapabilities.md + - file: api/RollupGetRollupCapsRollupCapabilitySummary.md + - file: api/RollupGetRollupCapsRollupFieldSummary.md + - file: api/RollupGetRollupIndexCapsIndexCapabilities.md + - file: api/RollupGetRollupIndexCapsRequest.md + - file: api/RollupGetRollupIndexCapsResponse.md + - file: api/RollupGetRollupIndexCapsRollupJobSummaryField.md + - file: api/RollupGetRollupIndexCapsRollupJobSummary.md + - file: api/RollupGroupings.md + - file: api/RollupHistogramGrouping.md + - file: api/Rollup.md + - file: api/RollupMetric.md + - file: api/RollupPutJobRequest.md + - file: api/RollupPutJobResponse.md + - file: api/RollupRollupSearchRequest.md + - file: api/RollupRollupSearchResponse.md + - file: api/RollupStartJobRequest.md + - file: api/RollupStartJobResponse.md + - file: api/RollupStopJobRequest.md + - file: api/RollupStopJobResponse.md + - file: api/RollupTermsGrouping.md + - file: api/Routing.md + - file: api/RrfRank.md + - file: api/RRFRetriever.md + - file: api/RuleRetriever.md + - file: api/ScalarValue.md + - file: api/ScoreSort.md + - file: api/ScriptField.md + - file: api/ScriptLanguage.md + - file: api/Script.md + - file: api/ScriptSort.md + - file: api/ScriptSortType.md + - file: api/ScriptSource.md + - file: api/ScriptsPainlessExecuteApi_1.md + - file: api/ScriptsPainlessExecuteApi_2.md + - file: api/ScriptsPainlessExecuteApi_3.md + - file: api/ScriptsPainlessExecutePainlessContext.md + - file: api/ScriptsPainlessExecutePainlessContextSetup.md + - file: api/ScriptsPainlessExecuteRequest.md + - file: api/ScriptsPainlessExecuteResponse.md + - file: api/ScriptTransform.md + - file: api/ScrollApi_1.md + - file: api/ScrollApi_2.md + - file: api/ScrollApi_3.md + - file: api/ScrollId.md + - file: api/ScrollIds.md + - file: api/ScrollRequest.md + - file: api/ScrollResponse.md + - file: api/ScrollSearchOptions.md + - file: api/ScrollSearchResponse.md + - file: api/SearchableSnapshotsCacheStatsNode.md + - file: api/SearchableSnapshotsCacheStatsRequest.md + - file: api/SearchableSnapshotsCacheStatsResponse.md + - file: api/SearchableSnapshotsCacheStatsShared.md + - file: api/SearchableSnapshotsClearCacheRequest.md + - file: api/SearchableSnapshotsClearCacheResponse.md + - file: api/SearchableSnapshots.md + - file: api/SearchableSnapshotsMountMountedSnapshot.md + - file: api/SearchableSnapshotsMountRequest.md + - file: api/SearchableSnapshotsMountResponse.md + - file: api/SearchableSnapshotsStatsLevel.md + - file: api/SearchableSnapshotsStatsRequest.md + - file: api/SearchableSnapshotsStatsResponse.md + - file: api/SearchAggregationBreakdown.md + - file: api/SearchAggregationProfileDebug.md + - file: api/SearchAggregationProfileDelegateDebugFilter.md + - file: api/SearchAggregationProfile.md + - file: api/SearchApi_1.md + - file: api/SearchApi_2.md + - file: api/SearchApi_3.md + - file: api/SearchApplicationAnalyticsCollection.md + - file: api/SearchApplicationDeleteBehavioralAnalyticsRequest.md + - file: api/SearchApplicationDeleteBehavioralAnalyticsResponse.md + - file: api/SearchApplicationDeleteRequest.md + - file: api/SearchApplicationDeleteResponse.md + - file: api/SearchApplicationEventDataStream.md + - file: api/SearchApplicationEventType.md + - file: api/SearchApplicationGetBehavioralAnalyticsRequest.md + - file: api/SearchApplicationGetBehavioralAnalyticsResponse.md + - file: api/SearchApplicationGetRequest.md + - file: api/SearchApplicationGetResponse.md + - file: api/SearchApplicationListRequest.md + - file: api/SearchApplicationListResponse.md + - file: api/SearchApplication.md + - file: api/SearchApplicationPostBehavioralAnalyticsEventRequest.md + - file: api/SearchApplicationPostBehavioralAnalyticsEventResponse.md + - file: api/SearchApplicationPutBehavioralAnalyticsAnalyticsAcknowledgeResponseBase.md + - file: api/SearchApplicationPutBehavioralAnalyticsRequest.md + - file: api/SearchApplicationPutBehavioralAnalyticsResponse.md + - file: api/SearchApplicationPutRequest.md + - file: api/SearchApplicationPutResponse.md + - file: api/SearchApplicationRenderQueryRequest.md + - file: api/SearchApplicationRenderQueryResponse.md + - file: api/SearchApplicationSearchApplication.md + - file: api/SearchApplicationSearchApplicationParameters.md + - file: api/SearchApplicationSearchApplicationTemplate.md + - file: api/SearchApplicationSearchRequest.md + - file: api/SearchApplicationSearchResponse.md + - file: api/SearchBoundaryScanner.md + - file: api/SearchCollector.md + - file: api/SearchCompletionContext.md + - file: api/SearchCompletionSuggester.md + - file: api/SearchCompletionSuggest.md + - file: api/SearchCompletionSuggestOption.md + - file: api/SearchContext.md + - file: api/SearchDfsKnnProfile.md + - file: api/SearchDfsProfile.md + - file: api/SearchDfsStatisticsBreakdown.md + - file: api/SearchDfsStatisticsProfile.md + - file: api/SearchDirectGenerator.md + - file: api/SearchFetchProfileBreakdown.md + - file: api/SearchFetchProfileDebug.md + - file: api/SearchFetchProfile.md + - file: api/SearchFieldCollapse.md + - file: api/SearchFieldSuggester.md + - file: api/SearchHighlightBase.md + - file: api/SearchHighlighterEncoder.md + - file: api/SearchHighlighterFragmenter.md + - file: api/SearchHighlighterOrder.md + - file: api/SearchHighlighterTagsSchema.md + - file: api/SearchHighlighterType.md + - file: api/SearchHighlightField.md + - file: api/SearchHighlight.md + - file: api/SearchHit.md + - file: api/SearchHitsMetadata.md + - file: api/SearchInnerHits.md + - file: api/SearchInnerHitsResult.md + - file: api/SearchKnnCollectorResult.md + - file: api/SearchKnnQueryProfileBreakdown.md + - file: api/SearchKnnQueryProfileResult.md + - file: api/SearchLaplaceSmoothingModel.md + - file: api/SearchLearningToRank.md + - file: api/SearchLinearInterpolationSmoothingModel.md + - file: api/SearchMvtApi_1.md + - file: api/SearchMvtApi_2.md + - file: api/SearchMvtApi_3.md + - file: api/SearchMvtCoordinate.md + - file: api/SearchMvtGridAggregationType.md + - file: api/SearchMvtGridType.md + - file: api/SearchMvtRequest.md + - file: api/SearchMvtResponse.md + - file: api/SearchMvtZoomLevel.md + - file: api/SearchNestedIdentity.md + - file: api/SearchPhraseSuggestCollate.md + - file: api/SearchPhraseSuggestCollateQuery.md + - file: api/SearchPhraseSuggester.md + - file: api/SearchPhraseSuggestHighlight.md + - file: api/SearchPhraseSuggest.md + - file: api/SearchPhraseSuggestOption.md + - file: api/SearchPointInTimeReference.md + - file: api/SearchProfile.md + - file: api/SearchQueryBreakdown.md + - file: api/SearchQueryProfile.md + - file: api/SearchRegexOptions.md + - file: api/SearchRequest.md + - file: api/SearchRescore.md + - file: api/SearchRescoreQuery.md + - file: api/SearchResponseBody.md + - file: api/SearchResponse.md + - file: api/SearchScoreMode.md + - file: api/SearchSearchProfile.md + - file: api/SearchSearchRequestBody.md + - file: api/SearchShardProfile.md + - file: api/SearchShardsApi_1.md + - file: api/SearchShardsApi_2.md + - file: api/SearchShardsApi_3.md + - file: api/SearchShardsRequest.md + - file: api/SearchShardsResponse.md + - file: api/SearchShardsSearchShardsNodeAttributes.md + - file: api/SearchShardsShardStoreIndex.md + - file: api/SearchSmoothingModelContainer.md + - file: api/SearchSourceConfig.md + - file: api/SearchSourceConfigParam.md + - file: api/SearchSourceFilter.md + - file: api/SearchStats.md + - file: api/SearchStringDistance.md + - file: api/SearchStupidBackoffSmoothingModel.md + - file: api/SearchSuggestBase.md + - file: api/SearchSuggesterBase.md + - file: api/SearchSuggesterKeys.md + - file: api/SearchSuggester.md + - file: api/SearchSuggestFuzziness.md + - file: api/SearchSuggest.md + - file: api/SearchSuggestSort.md + - file: api/SearchTemplateApi_1.md + - file: api/SearchTemplateApi_2.md + - file: api/SearchTemplateApi_3.md + - file: api/SearchTemplateRequest.md + - file: api/SearchTemplateResponse.md + - file: api/SearchTermSuggester.md + - file: api/SearchTermSuggest.md + - file: api/SearchTermSuggestOption.md + - file: api/SearchTotalHits.md + - file: api/SearchTotalHitsRelation.md + - file: api/SearchTrackHits.md + - file: api/SearchTransform.md + - file: api/SearchType.md + - file: api/SecurityAccess.md + - file: api/SecurityActivateUserProfileRequest.md + - file: api/SecurityActivateUserProfileResponse.md + - file: api/SecurityApiKey.md + - file: api/SecurityApiKeyType.md + - file: api/SecurityApplicationGlobalUserPrivileges.md + - file: api/SecurityApplicationPrivileges.md + - file: api/SecurityAuthenticateAuthenticateApiKey.md + - file: api/SecurityAuthenticateRequest.md + - file: api/SecurityAuthenticateResponse.md + - file: api/SecurityAuthenticateToken.md + - file: api/SecurityBulkDeleteRoleRequest.md + - file: api/SecurityBulkDeleteRoleResponse.md + - file: api/SecurityBulkError.md + - file: api/SecurityBulkPutRoleRequest.md + - file: api/SecurityBulkPutRoleResponse.md + - file: api/SecurityBulkUpdateApiKeysRequest.md + - file: api/SecurityBulkUpdateApiKeysResponse.md + - file: api/SecurityChangePasswordRequest.md + - file: api/SecurityChangePasswordResponse.md + - file: api/SecurityClearApiKeyCacheRequest.md + - file: api/SecurityClearApiKeyCacheResponse.md + - file: api/SecurityClearCachedPrivilegesRequest.md + - file: api/SecurityClearCachedPrivilegesResponse.md + - file: api/SecurityClearCachedRealmsRequest.md + - file: api/SecurityClearCachedRealmsResponse.md + - file: api/SecurityClearCachedRolesRequest.md + - file: api/SecurityClearCachedRolesResponse.md + - file: api/SecurityClearCachedServiceTokensRequest.md + - file: api/SecurityClearCachedServiceTokensResponse.md + - file: api/SecurityClusterNode.md + - file: api/SecurityClusterPrivilege.md + - file: api/SecurityCreateApiKeyRequest.md + - file: api/SecurityCreateApiKeyResponse.md + - file: api/SecurityCreateCrossClusterApiKeyRequest.md + - file: api/SecurityCreateCrossClusterApiKeyResponse.md + - file: api/SecurityCreatedStatus.md + - file: api/SecurityCreateServiceTokenRequest.md + - file: api/SecurityCreateServiceTokenResponse.md + - file: api/SecurityCreateServiceTokenToken.md + - file: api/SecurityDelegatePkiAuthentication.md + - file: api/SecurityDelegatePkiAuthenticationRealm.md + - file: api/SecurityDelegatePkiRequest.md + - file: api/SecurityDelegatePkiResponse.md + - file: api/SecurityDeletePrivilegesFoundStatus.md + - file: api/SecurityDeletePrivilegesRequest.md + - file: api/SecurityDeletePrivilegesResponse.md + - file: api/SecurityDeleteRoleMappingRequest.md + - file: api/SecurityDeleteRoleMappingResponse.md + - file: api/SecurityDeleteRoleRequest.md + - file: api/SecurityDeleteRoleResponse.md + - file: api/SecurityDeleteServiceTokenRequest.md + - file: api/SecurityDeleteServiceTokenResponse.md + - file: api/SecurityDeleteUserRequest.md + - file: api/SecurityDeleteUserResponse.md + - file: api/SecurityDisableUserProfileRequest.md + - file: api/SecurityDisableUserProfileResponse.md + - file: api/SecurityDisableUserRequest.md + - file: api/SecurityDisableUserResponse.md + - file: api/SecurityEnableUserProfileRequest.md + - file: api/SecurityEnableUserProfileResponse.md + - file: api/SecurityEnableUserRequest.md + - file: api/SecurityEnableUserResponse.md + - file: api/SecurityEnrollKibanaRequest.md + - file: api/SecurityEnrollKibanaResponse.md + - file: api/SecurityEnrollKibanaToken.md + - file: api/SecurityEnrollNodeRequest.md + - file: api/SecurityEnrollNodeResponse.md + - file: api/SecurityFieldSecurity.md + - file: api/SecurityGetApiKeyRequest.md + - file: api/SecurityGetApiKeyResponse.md + - file: api/SecurityGetBuiltinPrivilegesRequest.md + - file: api/SecurityGetBuiltinPrivilegesResponse.md + - file: api/SecurityGetPrivilegesRequest.md + - file: api/SecurityGetPrivilegesResponse.md + - file: api/SecurityGetRoleMappingRequest.md + - file: api/SecurityGetRoleMappingResponse.md + - file: api/SecurityGetRoleRequest.md + - file: api/SecurityGetRoleResponse.md + - file: api/SecurityGetRoleRole.md + - file: api/SecurityGetServiceAccountsRequest.md + - file: api/SecurityGetServiceAccountsResponse.md + - file: api/SecurityGetServiceAccountsRoleDescriptorWrapper.md + - file: api/SecurityGetServiceCredentialsNodesCredentialsFileToken.md + - file: api/SecurityGetServiceCredentialsNodesCredentials.md + - file: api/SecurityGetServiceCredentialsRequest.md + - file: api/SecurityGetServiceCredentialsResponse.md + - file: api/SecurityGetSettingsRequest.md + - file: api/SecurityGetSettingsResponse.md + - file: api/SecurityGetTokenAccessTokenGrantType.md + - file: api/SecurityGetTokenAuthenticatedUser.md + - file: api/SecurityGetTokenAuthenticationProvider.md + - file: api/SecurityGetTokenRequest.md + - file: api/SecurityGetTokenResponse.md + - file: api/SecurityGetTokenUserRealm.md + - file: api/SecurityGetUserPrivilegesRequest.md + - file: api/SecurityGetUserPrivilegesResponse.md + - file: api/SecurityGetUserProfileGetUserProfileErrors.md + - file: api/SecurityGetUserProfileRequest.md + - file: api/SecurityGetUserProfileResponse.md + - file: api/SecurityGetUserRequest.md + - file: api/SecurityGetUserResponse.md + - file: api/SecurityGlobalPrivilege.md + - file: api/SecurityGrantApiKeyApiKeyGrantType.md + - file: api/SecurityGrantApiKeyGrantApiKey.md + - file: api/SecurityGrantApiKeyRequest.md + - file: api/SecurityGrantApiKeyResponse.md + - file: api/SecurityGrantType.md + - file: api/SecurityHasPrivilegesApplicationPrivilegesCheck.md + - file: api/SecurityHasPrivilegesApplicationsPrivileges.md + - file: api/SecurityHasPrivilegesIndexPrivilegesCheck.md + - file: api/SecurityHasPrivilegesPrivileges.md + - file: api/SecurityHasPrivilegesRequest.md + - file: api/SecurityHasPrivilegesResourcePrivileges.md + - file: api/SecurityHasPrivilegesResponse.md + - file: api/SecurityHasPrivilegesUserProfileHasPrivilegesUserProfileErrors.md + - file: api/SecurityHasPrivilegesUserProfilePrivilegesCheck.md + - file: api/SecurityHasPrivilegesUserProfileRequest.md + - file: api/SecurityHasPrivilegesUserProfileResponse.md + - file: api/SecurityIndexPrivilege.md + - file: api/SecurityIndicesPrivileges.md + - file: api/SecurityIndicesPrivilegesQuery.md + - file: api/SecurityInvalidateApiKeyRequest.md + - file: api/SecurityInvalidateApiKeyResponse.md + - file: api/SecurityInvalidateTokenRequest.md + - file: api/SecurityInvalidateTokenResponse.md + - file: api/SecurityManageUserPrivileges.md + - file: api/Security.md + - file: api/SecurityOidcAuthenticateRequest.md + - file: api/SecurityOidcAuthenticateResponse.md + - file: api/SecurityOidcLogoutRequest.md + - file: api/SecurityOidcLogoutResponse.md + - file: api/SecurityOidcPrepareAuthenticationRequest.md + - file: api/SecurityOidcPrepareAuthenticationResponse.md + - file: api/SecurityPutPrivilegesActions.md + - file: api/SecurityPutPrivilegesRequest.md + - file: api/SecurityPutPrivilegesResponse.md + - file: api/SecurityPutRoleMappingRequest.md + - file: api/SecurityPutRoleMappingResponse.md + - file: api/SecurityPutRoleRequest.md + - file: api/SecurityPutRoleResponse.md + - file: api/SecurityPutUserRequest.md + - file: api/SecurityPutUserResponse.md + - file: api/SecurityQueryApiKeysApiKeyAggregate.md + - file: api/SecurityQueryApiKeysApiKeyAggregationContainer.md + - file: api/SecurityQueryApiKeysApiKeyFiltersAggregation.md + - file: api/SecurityQueryApiKeysApiKeyQueryContainer.md + - file: api/SecurityQueryApiKeysRequest.md + - file: api/SecurityQueryApiKeysResponse.md + - file: api/SecurityQueryRoleQueryRole.md + - file: api/SecurityQueryRoleRequest.md + - file: api/SecurityQueryRoleResponse.md + - file: api/SecurityQueryRoleRoleQueryContainer.md + - file: api/SecurityQueryUserQueryUser.md + - file: api/SecurityQueryUserRequest.md + - file: api/SecurityQueryUserResponse.md + - file: api/SecurityQueryUserUserQueryContainer.md + - file: api/SecurityRealmInfo.md + - file: api/SecurityRemoteClusterPrivilege.md + - file: api/SecurityRemoteClusterPrivileges.md + - file: api/SecurityRemoteIndicesPrivileges.md + - file: api/SecurityRemoteUserIndicesPrivileges.md + - file: api/SecurityReplicationAccess.md + - file: api/SecurityRestriction.md + - file: api/SecurityRestrictionWorkflow.md + - file: api/SecurityRoleDescriptor.md + - file: api/SecurityRoleDescriptorRead.md + - file: api/SecurityRoleMapping.md + - file: api/SecurityRoleMappingRule.md + - file: api/SecurityRoleTemplateInlineQuery.md + - file: api/SecurityRoleTemplate.md + - file: api/SecurityRoleTemplateQuery.md + - file: api/SecurityRoleTemplateScript.md + - file: api/SecuritySamlAuthenticateRequest.md + - file: api/SecuritySamlAuthenticateResponse.md + - file: api/SecuritySamlCompleteLogoutRequest.md + - file: api/SecuritySamlCompleteLogoutResponse.md + - file: api/SecuritySamlInvalidateRequest.md + - file: api/SecuritySamlInvalidateResponse.md + - file: api/SecuritySamlLogoutRequest.md + - file: api/SecuritySamlLogoutResponse.md + - file: api/SecuritySamlPrepareAuthenticationRequest.md + - file: api/SecuritySamlPrepareAuthenticationResponse.md + - file: api/SecuritySamlServiceProviderMetadataRequest.md + - file: api/SecuritySamlServiceProviderMetadataResponse.md + - file: api/SecuritySearchAccess.md + - file: api/SecuritySecuritySettings.md + - file: api/SecuritySuggestUserProfilesHint.md + - file: api/SecuritySuggestUserProfilesRequest.md + - file: api/SecuritySuggestUserProfilesResponse.md + - file: api/SecuritySuggestUserProfilesTotalUserProfiles.md + - file: api/SecurityTemplateFormat.md + - file: api/SecurityUpdateApiKeyRequest.md + - file: api/SecurityUpdateApiKeyResponse.md + - file: api/SecurityUpdateCrossClusterApiKeyRequest.md + - file: api/SecurityUpdateCrossClusterApiKeyResponse.md + - file: api/SecurityUpdateSettingsRequest.md + - file: api/SecurityUpdateSettingsResponse.md + - file: api/SecurityUpdateUserProfileDataRequest.md + - file: api/SecurityUpdateUserProfileDataResponse.md + - file: api/SecurityUserIndicesPrivileges.md + - file: api/SecurityUser.md + - file: api/SecurityUserProfileHitMetadata.md + - file: api/SecurityUserProfileId.md + - file: api/SecurityUserProfile.md + - file: api/SecurityUserProfileUser.md + - file: api/SecurityUserProfileWithMetadata.md + - file: api/SegmentsStats.md + - file: api/SequenceNumber.md + - file: api/Service.md + - file: api/ShardFailure.md + - file: api/ShardsOperationResponseBase.md + - file: api/ShardStatistics.md + - file: api/short.md + - file: api/ShutdownDeleteNodeRequest.md + - file: api/ShutdownDeleteNodeResponse.md + - file: api/ShutdownGetNodeNodeShutdownStatus.md + - file: api/ShutdownGetNodePersistentTaskStatus.md + - file: api/ShutdownGetNodePluginsStatus.md + - file: api/ShutdownGetNodeRequest.md + - file: api/ShutdownGetNodeResponse.md + - file: api/ShutdownGetNodeShardMigrationStatus.md + - file: api/ShutdownGetNodeShutdownStatus.md + - file: api/ShutdownGetNodeShutdownType.md + - file: api/Shutdown.md + - file: api/ShutdownPutNodeRequest.md + - file: api/ShutdownPutNodeResponse.md + - file: api/ShutdownType.md + - file: api/SimulateIngestIngestDocumentSimulationKeys.md + - file: api/SimulateIngestIngestDocumentSimulation.md + - file: api/SimulateIngestRequest.md + - file: api/SimulateIngestResponse.md + - file: api/SimulateIngestSimulateIngestDocumentResult.md + - file: api/Simulate.md + - file: api/SlicedScroll.md + - file: api/SlicesCalculation.md + - file: api/Slices.md + - file: api/SlmConfiguration.md + - file: api/SlmDeleteLifecycleRequest.md + - file: api/SlmDeleteLifecycleResponse.md + - file: api/SlmExecuteLifecycleRequest.md + - file: api/SlmExecuteLifecycleResponse.md + - file: api/SlmExecuteRetentionRequest.md + - file: api/SlmExecuteRetentionResponse.md + - file: api/SlmGetLifecycleRequest.md + - file: api/SlmGetLifecycleResponse.md + - file: api/SlmGetStatsRequest.md + - file: api/SlmGetStatsResponse.md + - file: api/SlmGetStatusRequest.md + - file: api/SlmGetStatusResponse.md + - file: api/SlmInProgress.md + - file: api/SlmInvocation.md + - file: api/Slm.md + - file: api/SlmPolicy.md + - file: api/SlmPutLifecycleRequest.md + - file: api/SlmPutLifecycleResponse.md + - file: api/SlmRetention.md + - file: api/SlmSnapshotLifecycle.md + - file: api/SlmStartRequest.md + - file: api/SlmStartResponse.md + - file: api/SlmStatistics.md + - file: api/SlmStopRequest.md + - file: api/SlmStopResponse.md + - file: api/SnapshotAzureRepository.md + - file: api/SnapshotAzureRepositorySettings.md + - file: api/SnapshotCleanupRepositoryCleanupRepositoryResults.md + - file: api/SnapshotCleanupRepositoryRequest.md + - file: api/SnapshotCleanupRepositoryResponse.md + - file: api/SnapshotCloneRequest.md + - file: api/SnapshotCloneResponse.md + - file: api/SnapshotCreateRepositoryRequest.md + - file: api/SnapshotCreateRepositoryResponse.md + - file: api/SnapshotCreateRequest.md + - file: api/SnapshotCreateResponse.md + - file: api/SnapshotDeleteRepositoryRequest.md + - file: api/SnapshotDeleteRepositoryResponse.md + - file: api/SnapshotDeleteRequest.md + - file: api/SnapshotDeleteResponse.md + - file: api/SnapshotFileCountSnapshotStats.md + - file: api/SnapshotGcsRepository.md + - file: api/SnapshotGcsRepositorySettings.md + - file: api/SnapshotGetRepositoryRequest.md + - file: api/SnapshotGetRepositoryResponse.md + - file: api/SnapshotGetRequest.md + - file: api/SnapshotGetResponse.md + - file: api/SnapshotGetSnapshotResponseItem.md + - file: api/SnapshotIndexDetails.md + - file: api/SnapshotInfoFeatureState.md + - file: api/Snapshot.md + - file: api/SnapshotReadOnlyUrlRepository.md + - file: api/SnapshotReadOnlyUrlRepositorySettings.md + - file: api/SnapshotRepositoryAnalyzeBlobDetails.md + - file: api/SnapshotRepositoryAnalyzeDetailsInfo.md + - file: api/SnapshotRepositoryAnalyzeReadBlobDetails.md + - file: api/SnapshotRepositoryAnalyzeReadSummaryInfo.md + - file: api/SnapshotRepositoryAnalyzeRequest.md + - file: api/SnapshotRepositoryAnalyzeResponse.md + - file: api/SnapshotRepositoryAnalyzeSnapshotNodeInfo.md + - file: api/SnapshotRepositoryAnalyzeSummaryInfo.md + - file: api/SnapshotRepositoryAnalyzeWriteSummaryInfo.md + - file: api/SnapshotRepositoryBase.md + - file: api/SnapshotRepository.md + - file: api/SnapshotRepositorySettingsBase.md + - file: api/SnapshotRepositoryVerifyIntegrityRequest.md + - file: api/SnapshotRepositoryVerifyIntegrityResponse.md + - file: api/SnapshotRestoreRequest.md + - file: api/SnapshotRestoreResponse.md + - file: api/SnapshotRestoreSnapshotRestore.md + - file: api/SnapshotS3Repository.md + - file: api/SnapshotS3RepositorySettings.md + - file: api/SnapshotShardsStats.md + - file: api/SnapshotShardsStatsStage.md + - file: api/SnapshotShardsStatsSummaryItem.md + - file: api/SnapshotShardsStatsSummary.md + - file: api/SnapshotSharedFileSystemRepository.md + - file: api/SnapshotSharedFileSystemRepositorySettings.md + - file: api/SnapshotSnapshotIndexStats.md + - file: api/SnapshotSnapshotInfo.md + - file: api/SnapshotSnapshotShardFailure.md + - file: api/SnapshotSnapshotShardsStatus.md + - file: api/SnapshotSnapshotSort.md + - file: api/SnapshotSnapshotStats.md + - file: api/SnapshotSourceOnlyRepository.md + - file: api/SnapshotSourceOnlyRepositorySettings.md + - file: api/SnapshotStatus.md + - file: api/SnapshotStatusRequest.md + - file: api/SnapshotStatusResponse.md + - file: api/SnapshotVerifyRepositoryCompactNodeInfo.md + - file: api/SnapshotVerifyRepositoryRequest.md + - file: api/SnapshotVerifyRepositoryResponse.md + - file: api/SniffingTransport.md + - file: api/SortCombinations.md + - file: api/Sort.md + - file: api/SortMode.md + - file: api/SortOptionsKeys.md + - file: api/SortOptions.md + - file: api/SortOrder.md + - file: api/SortResults.md + - file: api/SpecUtilsAdditionalProperties.md + - file: api/SpecUtilsAdditionalProperty.md + - file: api/SpecUtilsBaseNode.md + - file: api/SpecUtilsCommonCatQueryParameters.md + - file: api/SpecUtilsCommonQueryParameters.md + - file: api/SpecUtilsNullValue.md + - file: api/SpecUtilsOverloadOf.md + - file: api/SpecUtilsPipeSeparatedFlags.md + - file: api/SpecUtilsStringified.md + - file: api/SpecUtilsWithNullValue.md + - file: api/SqlClearCursorRequest.md + - file: api/SqlClearCursorResponse.md + - file: api/SqlColumn.md + - file: api/SqlDeleteAsyncRequest.md + - file: api/SqlDeleteAsyncResponse.md + - file: api/SqlGetAsyncRequest.md + - file: api/SqlGetAsyncResponse.md + - file: api/SqlGetAsyncStatusRequest.md + - file: api/SqlGetAsyncStatusResponse.md + - file: api/Sql.md + - file: api/SqlQueryRequest.md + - file: api/SqlQueryResponse.md + - file: api/SqlQuerySqlFormat.md + - file: api/SqlRow.md + - file: api/SqlTranslateRequest.md + - file: api/SqlTranslateResponse.md + - file: api/SslCertificatesCertificateInformation.md + - file: api/SslCertificatesRequest.md + - file: api/SslCertificatesResponse.md + - file: api/Ssl.md + - file: api/StandardRetriever.md + - file: api/StoredScript.md + - file: api/StoreStats.md + - file: api/StreamResult.md + - file: api/SuggestionName.md + - file: api/SuggestMode.md + - file: api/SynonymsDeleteSynonymRequest.md + - file: api/SynonymsDeleteSynonymResponse.md + - file: api/SynonymsDeleteSynonymRuleRequest.md + - file: api/SynonymsDeleteSynonymRuleResponse.md + - file: api/SynonymsGetSynonymRequest.md + - file: api/SynonymsGetSynonymResponse.md + - file: api/SynonymsGetSynonymRuleRequest.md + - file: api/SynonymsGetSynonymRuleResponse.md + - file: api/SynonymsGetSynonymsSetsRequest.md + - file: api/SynonymsGetSynonymsSetsResponse.md + - file: api/SynonymsGetSynonymsSetsSynonymsSetItem.md + - file: api/Synonyms.md + - file: api/SynonymsPutSynonymRequest.md + - file: api/SynonymsPutSynonymResponse.md + - file: api/SynonymsPutSynonymRuleRequest.md + - file: api/SynonymsPutSynonymRuleResponse.md + - file: api/SynonymsSynonymRule.md + - file: api/SynonymsSynonymRuleRead.md + - file: api/SynonymsSynonymString.md + - file: api/SynonymsSynonymsUpdateResult.md + - file: api/TaskFailure.md + - file: api/TaskId.md + - file: api/TasksCancelRequest.md + - file: api/TasksCancelResponse.md + - file: api/TasksGetRequest.md + - file: api/TasksGetResponse.md + - file: api/TasksGroupBy.md + - file: api/TasksListRequest.md + - file: api/TasksListResponse.md + - file: api/Tasks.md + - file: api/TasksNodeTasks.md + - file: api/TasksParentTaskInfo.md + - file: api/TasksTaskInfo.md + - file: api/TasksTaskInfos.md + - file: api/TasksTaskListResponseBase.md + - file: api/TermsEnumApi_1.md + - file: api/TermsEnumApi_2.md + - file: api/TermsEnumApi_3.md + - file: api/TermsEnumRequest.md + - file: api/TermsEnumResponse.md + - file: api/TermvectorsApi_1.md + - file: api/TermvectorsApi_2.md + - file: api/TermvectorsApi_3.md + - file: api/TermvectorsFieldStatistics.md + - file: api/TermvectorsFilter.md + - file: api/TermvectorsRequest.md + - file: api/TermvectorsResponse.md + - file: api/TermvectorsTerm.md + - file: api/TermvectorsTermVector.md + - file: api/TermvectorsToken.md + - file: api/TextEmbedding.md + - file: api/TextSimilarityReranker.md + - file: api/TextStructureEcsCompatibilityType.md + - file: api/TextStructureFieldStat.md + - file: api/TextStructureFindFieldStructureRequest.md + - file: api/TextStructureFindFieldStructureResponse.md + - file: api/TextStructureFindMessageStructureRequest.md + - file: api/TextStructureFindMessageStructureResponse.md + - file: api/TextStructureFindStructureRequest.md + - file: api/TextStructureFindStructureResponse.md + - file: api/TextStructureFormatType.md + - file: api/TextStructure.md + - file: api/TextStructureTestGrokPatternMatchedField.md + - file: api/TextStructureTestGrokPatternMatchedText.md + - file: api/TextStructureTestGrokPatternRequest.md + - file: api/TextStructureTestGrokPatternResponse.md + - file: api/TextStructureTopHit.md + - file: api/That_10.md + - file: api/That_11.md + - file: api/That_12.md + - file: api/That_13.md + - file: api/That_14.md + - file: api/That_15.md + - file: api/That_16.md + - file: api/That_17.md + - file: api/That_18.md + - file: api/That_19.md + - file: api/That_20.md + - file: api/That_21.md + - file: api/That_22.md + - file: api/That_23.md + - file: api/That_24.md + - file: api/That_25.md + - file: api/That_26.md + - file: api/That_27.md + - file: api/That_28.md + - file: api/That_29.md + - file: api/That_30.md + - file: api/That_31.md + - file: api/That_32.md + - file: api/That_33.md + - file: api/That_34.md + - file: api/That_35.md + - file: api/That_36.md + - file: api/That_37.md + - file: api/That_38.md + - file: api/That_39.md + - file: api/That_3.md + - file: api/That_40.md + - file: api/That_41.md + - file: api/That_42.md + - file: api/That_43.md + - file: api/That_44.md + - file: api/That_45.md + - file: api/That_46.md + - file: api/That_47.md + - file: api/That_48.md + - file: api/That_49.md + - file: api/That_4.md + - file: api/That_50.md + - file: api/That_51.md + - file: api/That_52.md + - file: api/That_53.md + - file: api/That_54.md + - file: api/That_55.md + - file: api/That_56.md + - file: api/That_57.md + - file: api/That_58.md + - file: api/That_59.md + - file: api/That_5.md + - file: api/That_60.md + - file: api/That_61.md + - file: api/That_62.md + - file: api/That_63.md + - file: api/That_64.md + - file: api/That_65.md + - file: api/That_66.md + - file: api/That_67.md + - file: api/That_68.md + - file: api/That_69.md + - file: api/That_6.md + - file: api/That_70.md + - file: api/That_71.md + - file: api/That_72.md + - file: api/That_73.md + - file: api/That_74.md + - file: api/That_75.md + - file: api/That_76.md + - file: api/That_77.md + - file: api/That_78.md + - file: api/That_79.md + - file: api/That_7.md + - file: api/That_80.md + - file: api/That_81.md + - file: api/That_82.md + - file: api/That_83.md + - file: api/That_84.md + - file: api/That_85.md + - file: api/That_86.md + - file: api/That_8.md + - file: api/That_9.md + - file: api/That.md + - file: api/ThreadType.md + - file: api/TimeOfDay.md + - file: api/TimeUnit.md + - file: api/TimeZone.md + - file: api/TODO.md + - file: api/TopLeftBottomRightGeoBounds.md + - file: api/TopRightBottomLeftGeoBounds.md + - file: api/TransformContainer.md + - file: api/TransformDeleteTransformRequest.md + - file: api/TransformDeleteTransformResponse.md + - file: api/TransformDestination.md + - file: api/TransformGetTransformRequest.md + - file: api/TransformGetTransformResponse.md + - file: api/TransformGetTransformStatsCheckpointing.md + - file: api/TransformGetTransformStatsCheckpointStats.md + - file: api/TransformGetTransformStatsRequest.md + - file: api/TransformGetTransformStatsResponse.md + - file: api/TransformGetTransformStatsTransformHealthIssue.md + - file: api/TransformGetTransformStatsTransformIndexerStats.md + - file: api/TransformGetTransformStatsTransformProgress.md + - file: api/TransformGetTransformStatsTransformStatsHealth.md + - file: api/TransformGetTransformStatsTransformStats.md + - file: api/TransformGetTransformTransformSummary.md + - file: api/TransformLatest.md + - file: api/Transform.md + - file: api/TransformPivotGroupByContainer.md + - file: api/TransformPivot.md + - file: api/TransformPreviewTransformRequest.md + - file: api/TransformPreviewTransformResponse.md + - file: api/TransformPutTransformRequest.md + - file: api/TransformPutTransformResponse.md + - file: api/TransformResetTransformRequest.md + - file: api/TransformResetTransformResponse.md + - file: api/TransformRetentionPolicyContainer.md + - file: api/TransformRetentionPolicy.md + - file: api/TransformScheduleNowTransformRequest.md + - file: api/TransformScheduleNowTransformResponse.md + - file: api/TransformSettings.md + - file: api/TransformSource.md + - file: api/TransformStartTransformRequest.md + - file: api/TransformStartTransformResponse.md + - file: api/TransformStopTransformRequest.md + - file: api/TransformStopTransformResponse.md + - file: api/TransformSyncContainer.md + - file: api/TransformTimeSync.md + - file: api/TransformUpdateTransformRequest.md + - file: api/TransformUpdateTransformResponse.md + - file: api/TransformUpgradeTransformsRequest.md + - file: api/TransformUpgradeTransformsResponse.md + - file: api/TranslogStats.md + - file: api/TransportAddress.md + - file: api/uint.md + - file: api/ulong.md + - file: api/UnitFloatMillis.md + - file: api/UnitMillis.md + - file: api/UnitNanos.md + - file: api/UnitSeconds.md + - file: api/UpdateAction.md + - file: api/UpdateActionOperation.md + - file: api/UpdateApi_1.md + - file: api/UpdateApi_2.md + - file: api/UpdateApi_3.md + - file: api/UpdateByQueryApi_1.md + - file: api/UpdateByQueryApi_2.md + - file: api/UpdateByQueryApi_3.md + - file: api/UpdateByQueryRequest.md + - file: api/UpdateByQueryResponse.md + - file: api/UpdateByQueryRethrottleApi_1.md + - file: api/UpdateByQueryRethrottleApi_2.md + - file: api/UpdateByQueryRethrottleApi_3.md + - file: api/UpdateByQueryRethrottleRequest.md + - file: api/UpdateByQueryRethrottleResponse.md + - file: api/UpdateByQueryRethrottleUpdateByQueryRethrottleNode.md + - file: api/UpdateRequest.md + - file: api/UpdateResponse.md + - file: api/UpdateUpdateWriteResponseBase.md + - file: api/Username.md + - file: api/Uuid.md + - file: api/VersionNumber.md + - file: api/VersionString.md + - file: api/VersionType.md + - file: api/WaitForActiveShardOptions.md + - file: api/WaitForActiveShards.md + - file: api/WaitForEvents.md + - file: api/WarmerStats.md + - file: api/WatcherAcknowledgementOptions.md + - file: api/WatcherAcknowledgeState.md + - file: api/WatcherAckWatchRequest.md + - file: api/WatcherAckWatchResponse.md + - file: api/WatcherActionExecutionMode.md + - file: api/WatcherAction.md + - file: api/WatcherActions.md + - file: api/WatcherActionStatus.md + - file: api/WatcherActionStatusOptions.md + - file: api/WatcherActionType.md + - file: api/WatcherActivateWatchRequest.md + - file: api/WatcherActivateWatchResponse.md + - file: api/WatcherActivationState.md + - file: api/WatcherActivationStatus.md + - file: api/WatcherAlwaysCondition.md + - file: api/WatcherArrayCompareConditionKeys.md + - file: api/WatcherArrayCompareCondition.md + - file: api/WatcherArrayCompareOpParams.md + - file: api/WatcherChainInput.md + - file: api/WatcherConditionContainer.md + - file: api/WatcherConditionOp.md + - file: api/WatcherConditionType.md + - file: api/WatcherConnectionScheme.md + - file: api/WatcherCronExpression.md + - file: api/WatcherDailySchedule.md + - file: api/WatcherDataAttachmentFormat.md + - file: api/WatcherDataEmailAttachment.md + - file: api/WatcherDay.md + - file: api/WatcherDeactivateWatchRequest.md + - file: api/WatcherDeactivateWatchResponse.md + - file: api/WatcherDeleteWatchRequest.md + - file: api/WatcherDeleteWatchResponse.md + - file: api/WatcherEmailAction.md + - file: api/WatcherEmailAttachmentContainer.md + - file: api/WatcherEmailBody.md + - file: api/WatcherEmail.md + - file: api/WatcherEmailPriority.md + - file: api/WatcherEmailResult.md + - file: api/WatcherExecuteWatchRequest.md + - file: api/WatcherExecuteWatchResponse.md + - file: api/WatcherExecuteWatchWatchRecord.md + - file: api/WatcherExecutionPhase.md + - file: api/WatcherExecutionResultAction.md + - file: api/WatcherExecutionResultCondition.md + - file: api/WatcherExecutionResultInput.md + - file: api/WatcherExecutionResult.md + - file: api/WatcherExecutionState.md + - file: api/WatcherExecutionStatus.md + - file: api/WatcherExecutionThreadPool.md + - file: api/WatcherGetSettingsRequest.md + - file: api/WatcherGetSettingsResponse.md + - file: api/WatcherGetWatchRequest.md + - file: api/WatcherGetWatchResponse.md + - file: api/WatcherHourAndMinute.md + - file: api/WatcherHourlySchedule.md + - file: api/WatcherHttpEmailAttachment.md + - file: api/WatcherHttpInputAuthentication.md + - file: api/WatcherHttpInputBasicAuthentication.md + - file: api/WatcherHttpInput.md + - file: api/WatcherHttpInputMethod.md + - file: api/WatcherHttpInputProxy.md + - file: api/WatcherHttpInputRequestDefinition.md + - file: api/WatcherHttpInputRequestResult.md + - file: api/WatcherHttpInputResponseResult.md + - file: api/WatcherIndexAction.md + - file: api/WatcherIndexResult.md + - file: api/WatcherIndexResultSummary.md + - file: api/WatcherInputContainer.md + - file: api/WatcherInputType.md + - file: api/WatcherLoggingAction.md + - file: api/WatcherLoggingResult.md + - file: api/Watcher.md + - file: api/WatcherMonth.md + - file: api/WatcherNeverCondition.md + - file: api/WatcherPagerDutyAction.md + - file: api/WatcherPagerDutyContext.md + - file: api/WatcherPagerDutyContextType.md + - file: api/WatcherPagerDutyEvent.md + - file: api/WatcherPagerDutyEventProxy.md + - file: api/WatcherPagerDutyEventType.md + - file: api/WatcherPagerDutyResult.md + - file: api/WatcherPutWatchRequest.md + - file: api/WatcherPutWatchResponse.md + - file: api/WatcherQuantifier.md + - file: api/WatcherQueryWatchesRequest.md + - file: api/WatcherQueryWatchesResponse.md + - file: api/WatcherQueryWatch.md + - file: api/WatcherReportingEmailAttachment.md + - file: api/WatcherResponseContentType.md + - file: api/WatcherScheduleContainer.md + - file: api/WatcherScheduleTimeOfDay.md + - file: api/WatcherScheduleTriggerEvent.md + - file: api/WatcherScriptCondition.md + - file: api/WatcherSearchInput.md + - file: api/WatcherSearchInputRequestBody.md + - file: api/WatcherSearchInputRequestDefinition.md + - file: api/WatcherSearchTemplateRequestBody.md + - file: api/WatcherSimulatedActions.md + - file: api/WatcherSlackAction.md + - file: api/WatcherSlackAttachmentField.md + - file: api/WatcherSlackAttachment.md + - file: api/WatcherSlackDynamicAttachment.md + - file: api/WatcherSlackMessage.md + - file: api/WatcherSlackResult.md + - file: api/WatcherStartRequest.md + - file: api/WatcherStartResponse.md + - file: api/WatcherStatsRequest.md + - file: api/WatcherStatsResponse.md + - file: api/WatcherStatsWatcherMetric.md + - file: api/WatcherStatsWatcherNodeStats.md + - file: api/WatcherStatsWatcherState.md + - file: api/WatcherStatsWatchRecordQueuedStats.md + - file: api/WatcherStatsWatchRecordStats.md + - file: api/WatcherStopRequest.md + - file: api/WatcherStopResponse.md + - file: api/WatcherThrottleState.md + - file: api/WatcherTimeOfMonth.md + - file: api/WatcherTimeOfWeek.md + - file: api/WatcherTimeOfYear.md + - file: api/WatcherTriggerContainer.md + - file: api/WatcherTriggerEventContainer.md + - file: api/WatcherTriggerEventResult.md + - file: api/WatcherUpdateSettingsRequest.md + - file: api/WatcherUpdateSettingsResponse.md + - file: api/WatcherWatch.md + - file: api/WatcherWatchStatus.md + - file: api/WatcherWebhookAction.md + - file: api/WatcherWebhookResult.md + - file: api/WktGeoBounds.md + - file: api/WriteResponseBase.md + - file: api/XpackInfoBuildInformation.md + - file: api/XpackInfoFeature.md + - file: api/XpackInfoFeatures.md + - file: api/XpackInfoMinimalLicenseInformation.md + - file: api/XpackInfoNativeCodeInformation.md + - file: api/XpackInfoRequest.md + - file: api/XpackInfoResponse.md + - file: api/XpackInfoXPackCategory.md + - file: api/Xpack.md + - file: api/XpackUsageAnalytics.md + - file: api/XpackUsageAnalyticsStatistics.md + - file: api/XpackUsageArchive.md + - file: api/XpackUsageAudit.md + - file: api/XpackUsageBase.md + - file: api/XpackUsageCcr.md + - file: api/XpackUsageCounter.md + - file: api/XpackUsageDatafeed.md + - file: api/XpackUsageDataStreams.md + - file: api/XpackUsageDataTierPhaseStatistics.md + - file: api/XpackUsageDataTiers.md + - file: api/XpackUsageEqlFeaturesJoin.md + - file: api/XpackUsageEqlFeaturesKeys.md + - file: api/XpackUsageEqlFeatures.md + - file: api/XpackUsageEqlFeaturesPipes.md + - file: api/XpackUsageEqlFeaturesSequences.md + - file: api/XpackUsageEql.md + - file: api/XpackUsageFeatureToggle.md + - file: api/XpackUsageFlattened.md + - file: api/XpackUsageHealthStatistics.md + - file: api/XpackUsageIlm.md + - file: api/XpackUsageIlmPolicyStatistics.md + - file: api/XpackUsageInvocations.md + - file: api/XpackUsageIpFilter.md + - file: api/XpackUsageJobUsage.md + - file: api/XpackUsageMachineLearning.md + - file: api/XpackUsageMlCounter.md + - file: api/XpackUsageMlDataFrameAnalyticsJobsAnalysis.md + - file: api/XpackUsageMlDataFrameAnalyticsJobsCount.md + - file: api/XpackUsageMlDataFrameAnalyticsJobs.md + - file: api/XpackUsageMlDataFrameAnalyticsJobsMemory.md + - file: api/XpackUsageMlInferenceDeployments.md + - file: api/XpackUsageMlInferenceDeploymentsTimeMs.md + - file: api/XpackUsageMlInferenceIngestProcessorCount.md + - file: api/XpackUsageMlInferenceIngestProcessor.md + - file: api/XpackUsageMlInference.md + - file: api/XpackUsageMlInferenceTrainedModelsCount.md + - file: api/XpackUsageMlInferenceTrainedModels.md + - file: api/XpackUsageMlJobForecasts.md + - file: api/XpackUsageMonitoring.md + - file: api/XpackUsagePhase.md + - file: api/XpackUsagePhases.md + - file: api/XpackUsageQuery.md + - file: api/XpackUsageRealmCache.md + - file: api/XpackUsageRealm.md + - file: api/XpackUsageRequest.md + - file: api/XpackUsageResponse.md + - file: api/XpackUsageRoleMapping.md + - file: api/XpackUsageRuntimeFieldsType.md + - file: api/XpackUsageRuntimeFieldTypes.md + - file: api/XpackUsageSearchableSnapshots.md + - file: api/XpackUsageSecurity.md + - file: api/XpackUsageSecurityRolesDlsBitSetCache.md + - file: api/XpackUsageSecurityRolesDls.md + - file: api/XpackUsageSecurityRolesFile.md + - file: api/XpackUsageSecurityRoles.md + - file: api/XpackUsageSecurityRolesNative.md + - file: api/XpackUsageSlm.md + - file: api/XpackUsageSql.md + - file: api/XpackUsageSsl.md + - file: api/XpackUsageVector.md + - file: api/XpackUsageWatcherActions.md + - file: api/XpackUsageWatcherActionTotals.md + - file: api/XpackUsageWatcher.md + - file: api/XpackUsageWatcherWatch.md + - file: api/XpackUsageWatcherWatchTrigger.md + - file: api/XpackUsageWatcherWatchTriggerSchedule.md - file: examples.md children: - file: as_stream_examples.md @@ -32,4 +3772,5 @@ toc: - file: update_by_query_examples.md - file: reindex_examples.md - file: client-helpers.md - - file: timeout-best-practices.md \ No newline at end of file + - file: timeout-best-practices.md + From 0284ec5b1a9edc899342ac15cd079d38884ba25f Mon Sep 17 00:00:00 2001 From: Josh Mock Date: Tue, 27 May 2025 16:07:27 -0500 Subject: [PATCH 5/7] Fix table formatting --- docs/reference/api/AsyncSearch.md | 13 +- docs/reference/api/Autoscaling.md | 13 +- docs/reference/api/Cat.md | 79 +++++++- docs/reference/api/Ccr.md | 40 +++- docs/reference/api/Client.md | 3 +- docs/reference/api/Cluster.md | 49 ++++- docs/reference/api/Connector.md | 103 +++++++++- docs/reference/api/DanglingIndices.md | 10 +- docs/reference/api/Enrich.md | 16 +- docs/reference/api/Eql.md | 13 +- docs/reference/api/Esql.md | 22 ++- docs/reference/api/Features.md | 7 +- docs/reference/api/Fleet.md | 19 +- docs/reference/api/Graph.md | 4 +- docs/reference/api/Helpers.md | 7 +- docs/reference/api/Ilm.md | 34 +++- docs/reference/api/Inference.md | 82 +++++++- docs/reference/api/Ingest.md | 37 +++- docs/reference/api/License.md | 22 ++- docs/reference/api/Logstash.md | 10 +- docs/reference/api/Migration.md | 10 +- docs/reference/api/Ml.md | 220 +++++++++++++++++++++- docs/reference/api/Monitoring.md | 4 +- docs/reference/api/Nodes.md | 22 ++- docs/reference/api/Profiling.md | 13 +- docs/reference/api/QueryRules.md | 25 ++- docs/reference/api/Rollup.md | 25 ++- docs/reference/api/SearchApplication.md | 31 ++- docs/reference/api/SearchableSnapshots.md | 13 +- docs/reference/api/Security.md | 193 ++++++++++++++++++- docs/reference/api/Shutdown.md | 10 +- docs/reference/api/Simulate.md | 4 +- docs/reference/api/Slm.md | 28 ++- docs/reference/api/Snapshot.md | 40 +++- docs/reference/api/SniffingTransport.md | 2 +- docs/reference/api/Sql.md | 19 +- docs/reference/api/Ssl.md | 4 +- docs/reference/api/Synonyms.md | 22 ++- docs/reference/api/Tasks.md | 10 +- docs/reference/api/TextStructure.md | 13 +- docs/reference/api/Transform.md | 37 +++- docs/reference/api/Watcher.md | 40 +++- docs/reference/api/Xpack.md | 7 +- 43 files changed, 1332 insertions(+), 43 deletions(-) diff --git a/docs/reference/api/AsyncSearch.md b/docs/reference/api/AsyncSearch.md index bc704c4bc..7f8ad603c 100644 --- a/docs/reference/api/AsyncSearch.md +++ b/docs/reference/api/AsyncSearch.md @@ -17,4 +17,15 @@ new AsyncSearch(transport: [Transport](./Transport.md)); | Name | Signature | Description | | - | - | - | -| `delete` | `delete(this: [That](./That.md), params: [AsyncSearchDeleteRequest](./AsyncSearchDeleteRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[AsyncSearchDeleteResponse](./AsyncSearchDeleteResponse.md)>;` | Delete an async search. If the asynchronous search is still running, it is cancelled. Otherwise, the saved search results are deleted. If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the `cancel_task` cluster privilege. || `delete` | `delete(this: [That](./That.md), params: [AsyncSearchDeleteRequest](./AsyncSearchDeleteRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[AsyncSearchDeleteResponse](./AsyncSearchDeleteResponse.md), unknown>>;` |   || `delete` | `delete(this: [That](./That.md), params: [AsyncSearchDeleteRequest](./AsyncSearchDeleteRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[AsyncSearchDeleteResponse](./AsyncSearchDeleteResponse.md)>;` |   || `get` | `get>(this: [That](./That.md), params: [AsyncSearchGetRequest](./AsyncSearchGetRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[AsyncSearchGetResponse](./AsyncSearchGetResponse.md)>;` | Get async search results. Retrieve the results of a previously submitted asynchronous search request. If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it. || `get` | `get>(this: [That](./That.md), params: [AsyncSearchGetRequest](./AsyncSearchGetRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[AsyncSearchGetResponse](./AsyncSearchGetResponse.md), unknown>>;` |   || `get` | `get>(this: [That](./That.md), params: [AsyncSearchGetRequest](./AsyncSearchGetRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[AsyncSearchGetResponse](./AsyncSearchGetResponse.md)>;` |   || `status` | `status(this: [That](./That.md), params: [AsyncSearchStatusRequest](./AsyncSearchStatusRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[AsyncSearchStatusResponse](./AsyncSearchStatusResponse.md)>;` | Get the async search status. Get the status of a previously submitted async search request given its identifier, without retrieving search results. If the Elasticsearch security features are enabled, the access to the status of a specific async search is restricted to: * The user or API key that submitted the original async search request. * Users that have the `monitor` cluster privilege or greater privileges. || `status` | `status(this: [That](./That.md), params: [AsyncSearchStatusRequest](./AsyncSearchStatusRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[AsyncSearchStatusResponse](./AsyncSearchStatusResponse.md), unknown>>;` |   || `status` | `status(this: [That](./That.md), params: [AsyncSearchStatusRequest](./AsyncSearchStatusRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[AsyncSearchStatusResponse](./AsyncSearchStatusResponse.md)>;` |   || `submit` | `submit>(this: [That](./That.md), params?: [AsyncSearchSubmitRequest](./AsyncSearchSubmitRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[AsyncSearchSubmitResponse](./AsyncSearchSubmitResponse.md)>;` | Run an async search. When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field. Partial results become available following the sort criteria that was requested. Warning: Asynchronous search does not support scroll or search requests that include only the suggest section. By default, Elasticsearch does not allow you to store an async search response larger than 10Mb and an attempt to do this results in an error. The maximum allowed size for a stored async search response can be set by changing the `search.max_async_search_response_size` cluster level setting. || `submit` | `submit>(this: [That](./That.md), params?: [AsyncSearchSubmitRequest](./AsyncSearchSubmitRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[AsyncSearchSubmitResponse](./AsyncSearchSubmitResponse.md), unknown>>;` |   || `submit` | `submit>(this: [That](./That.md), params?: [AsyncSearchSubmitRequest](./AsyncSearchSubmitRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[AsyncSearchSubmitResponse](./AsyncSearchSubmitResponse.md)>;` |   | \ No newline at end of file +| `delete` | `delete(this: [That](./That.md), params: [AsyncSearchDeleteRequest](./AsyncSearchDeleteRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[AsyncSearchDeleteResponse](./AsyncSearchDeleteResponse.md)>;` | Delete an async search. If the asynchronous search is still running, it is cancelled. Otherwise, the saved search results are deleted. If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the `cancel_task` cluster privilege. | +| `delete` | `delete(this: [That](./That.md), params: [AsyncSearchDeleteRequest](./AsyncSearchDeleteRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[AsyncSearchDeleteResponse](./AsyncSearchDeleteResponse.md), unknown>>;` |   | +| `delete` | `delete(this: [That](./That.md), params: [AsyncSearchDeleteRequest](./AsyncSearchDeleteRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[AsyncSearchDeleteResponse](./AsyncSearchDeleteResponse.md)>;` |   | +| `get` | `get>(this: [That](./That.md), params: [AsyncSearchGetRequest](./AsyncSearchGetRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[AsyncSearchGetResponse](./AsyncSearchGetResponse.md)>;` | Get async search results. Retrieve the results of a previously submitted asynchronous search request. If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it. | +| `get` | `get>(this: [That](./That.md), params: [AsyncSearchGetRequest](./AsyncSearchGetRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[AsyncSearchGetResponse](./AsyncSearchGetResponse.md), unknown>>;` |   | +| `get` | `get>(this: [That](./That.md), params: [AsyncSearchGetRequest](./AsyncSearchGetRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[AsyncSearchGetResponse](./AsyncSearchGetResponse.md)>;` |   | +| `status` | `status(this: [That](./That.md), params: [AsyncSearchStatusRequest](./AsyncSearchStatusRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[AsyncSearchStatusResponse](./AsyncSearchStatusResponse.md)>;` | Get the async search status. Get the status of a previously submitted async search request given its identifier, without retrieving search results. If the Elasticsearch security features are enabled, the access to the status of a specific async search is restricted to: * The user or API key that submitted the original async search request. * Users that have the `monitor` cluster privilege or greater privileges. | +| `status` | `status(this: [That](./That.md), params: [AsyncSearchStatusRequest](./AsyncSearchStatusRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[AsyncSearchStatusResponse](./AsyncSearchStatusResponse.md), unknown>>;` |   | +| `status` | `status(this: [That](./That.md), params: [AsyncSearchStatusRequest](./AsyncSearchStatusRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[AsyncSearchStatusResponse](./AsyncSearchStatusResponse.md)>;` |   | +| `submit` | `submit>(this: [That](./That.md), params?: [AsyncSearchSubmitRequest](./AsyncSearchSubmitRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[AsyncSearchSubmitResponse](./AsyncSearchSubmitResponse.md)>;` | Run an async search. When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field. Partial results become available following the sort criteria that was requested. Warning: Asynchronous search does not support scroll or search requests that include only the suggest section. By default, Elasticsearch does not allow you to store an async search response larger than 10Mb and an attempt to do this results in an error. The maximum allowed size for a stored async search response can be set by changing the `search.max_async_search_response_size` cluster level setting. | +| `submit` | `submit>(this: [That](./That.md), params?: [AsyncSearchSubmitRequest](./AsyncSearchSubmitRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[AsyncSearchSubmitResponse](./AsyncSearchSubmitResponse.md), unknown>>;` |   | +| `submit` | `submit>(this: [That](./That.md), params?: [AsyncSearchSubmitRequest](./AsyncSearchSubmitRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[AsyncSearchSubmitResponse](./AsyncSearchSubmitResponse.md)>;` |   | diff --git a/docs/reference/api/Autoscaling.md b/docs/reference/api/Autoscaling.md index 2518f5866..8de1cbd47 100644 --- a/docs/reference/api/Autoscaling.md +++ b/docs/reference/api/Autoscaling.md @@ -17,4 +17,15 @@ new Autoscaling(transport: [Transport](./Transport.md)); | Name | Signature | Description | | - | - | - | -| `deleteAutoscalingPolicy` | `deleteAutoscalingPolicy(this: [That](./That.md), params: [AutoscalingDeleteAutoscalingPolicyRequest](./AutoscalingDeleteAutoscalingPolicyRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[AutoscalingDeleteAutoscalingPolicyResponse](./AutoscalingDeleteAutoscalingPolicyResponse.md)>;` | Delete an autoscaling policy. NOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported. || `deleteAutoscalingPolicy` | `deleteAutoscalingPolicy(this: [That](./That.md), params: [AutoscalingDeleteAutoscalingPolicyRequest](./AutoscalingDeleteAutoscalingPolicyRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[AutoscalingDeleteAutoscalingPolicyResponse](./AutoscalingDeleteAutoscalingPolicyResponse.md), unknown>>;` |   || `deleteAutoscalingPolicy` | `deleteAutoscalingPolicy(this: [That](./That.md), params: [AutoscalingDeleteAutoscalingPolicyRequest](./AutoscalingDeleteAutoscalingPolicyRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[AutoscalingDeleteAutoscalingPolicyResponse](./AutoscalingDeleteAutoscalingPolicyResponse.md)>;` |   || `getAutoscalingCapacity` | `getAutoscalingCapacity(this: [That](./That.md), params?: [AutoscalingGetAutoscalingCapacityRequest](./AutoscalingGetAutoscalingCapacityRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[AutoscalingGetAutoscalingCapacityResponse](./AutoscalingGetAutoscalingCapacityResponse.md)>;` | Get the autoscaling capacity. NOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported. This API gets the current autoscaling capacity based on the configured autoscaling policy. It will return information to size the cluster appropriately to the current workload. The `required_capacity` is calculated as the maximum of the `required_capacity` result of all individual deciders that are enabled for the policy. The operator should verify that the `current_nodes` match the operator’s knowledge of the cluster to avoid making autoscaling decisions based on stale or incomplete information. The response contains decider-specific information you can use to diagnose how and why autoscaling determined a certain capacity was required. This information is provided for diagnosis only. Do not use this information to make autoscaling decisions. || `getAutoscalingCapacity` | `getAutoscalingCapacity(this: [That](./That.md), params?: [AutoscalingGetAutoscalingCapacityRequest](./AutoscalingGetAutoscalingCapacityRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[AutoscalingGetAutoscalingCapacityResponse](./AutoscalingGetAutoscalingCapacityResponse.md), unknown>>;` |   || `getAutoscalingCapacity` | `getAutoscalingCapacity(this: [That](./That.md), params?: [AutoscalingGetAutoscalingCapacityRequest](./AutoscalingGetAutoscalingCapacityRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[AutoscalingGetAutoscalingCapacityResponse](./AutoscalingGetAutoscalingCapacityResponse.md)>;` |   || `getAutoscalingPolicy` | `getAutoscalingPolicy(this: [That](./That.md), params: [AutoscalingGetAutoscalingPolicyRequest](./AutoscalingGetAutoscalingPolicyRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[AutoscalingGetAutoscalingPolicyResponse](./AutoscalingGetAutoscalingPolicyResponse.md)>;` | Get an autoscaling policy. NOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported. || `getAutoscalingPolicy` | `getAutoscalingPolicy(this: [That](./That.md), params: [AutoscalingGetAutoscalingPolicyRequest](./AutoscalingGetAutoscalingPolicyRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[AutoscalingGetAutoscalingPolicyResponse](./AutoscalingGetAutoscalingPolicyResponse.md), unknown>>;` |   || `getAutoscalingPolicy` | `getAutoscalingPolicy(this: [That](./That.md), params: [AutoscalingGetAutoscalingPolicyRequest](./AutoscalingGetAutoscalingPolicyRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[AutoscalingGetAutoscalingPolicyResponse](./AutoscalingGetAutoscalingPolicyResponse.md)>;` |   || `putAutoscalingPolicy` | `putAutoscalingPolicy(this: [That](./That.md), params: [AutoscalingPutAutoscalingPolicyRequest](./AutoscalingPutAutoscalingPolicyRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[AutoscalingPutAutoscalingPolicyResponse](./AutoscalingPutAutoscalingPolicyResponse.md)>;` | Create or update an autoscaling policy. NOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported. || `putAutoscalingPolicy` | `putAutoscalingPolicy(this: [That](./That.md), params: [AutoscalingPutAutoscalingPolicyRequest](./AutoscalingPutAutoscalingPolicyRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[AutoscalingPutAutoscalingPolicyResponse](./AutoscalingPutAutoscalingPolicyResponse.md), unknown>>;` |   || `putAutoscalingPolicy` | `putAutoscalingPolicy(this: [That](./That.md), params: [AutoscalingPutAutoscalingPolicyRequest](./AutoscalingPutAutoscalingPolicyRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[AutoscalingPutAutoscalingPolicyResponse](./AutoscalingPutAutoscalingPolicyResponse.md)>;` |   | \ No newline at end of file +| `deleteAutoscalingPolicy` | `deleteAutoscalingPolicy(this: [That](./That.md), params: [AutoscalingDeleteAutoscalingPolicyRequest](./AutoscalingDeleteAutoscalingPolicyRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[AutoscalingDeleteAutoscalingPolicyResponse](./AutoscalingDeleteAutoscalingPolicyResponse.md)>;` | Delete an autoscaling policy. NOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported. | +| `deleteAutoscalingPolicy` | `deleteAutoscalingPolicy(this: [That](./That.md), params: [AutoscalingDeleteAutoscalingPolicyRequest](./AutoscalingDeleteAutoscalingPolicyRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[AutoscalingDeleteAutoscalingPolicyResponse](./AutoscalingDeleteAutoscalingPolicyResponse.md), unknown>>;` |   | +| `deleteAutoscalingPolicy` | `deleteAutoscalingPolicy(this: [That](./That.md), params: [AutoscalingDeleteAutoscalingPolicyRequest](./AutoscalingDeleteAutoscalingPolicyRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[AutoscalingDeleteAutoscalingPolicyResponse](./AutoscalingDeleteAutoscalingPolicyResponse.md)>;` |   | +| `getAutoscalingCapacity` | `getAutoscalingCapacity(this: [That](./That.md), params?: [AutoscalingGetAutoscalingCapacityRequest](./AutoscalingGetAutoscalingCapacityRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[AutoscalingGetAutoscalingCapacityResponse](./AutoscalingGetAutoscalingCapacityResponse.md)>;` | Get the autoscaling capacity. NOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported. This API gets the current autoscaling capacity based on the configured autoscaling policy. It will return information to size the cluster appropriately to the current workload. The `required_capacity` is calculated as the maximum of the `required_capacity` result of all individual deciders that are enabled for the policy. The operator should verify that the `current_nodes` match the operator’s knowledge of the cluster to avoid making autoscaling decisions based on stale or incomplete information. The response contains decider-specific information you can use to diagnose how and why autoscaling determined a certain capacity was required. This information is provided for diagnosis only. Do not use this information to make autoscaling decisions. | +| `getAutoscalingCapacity` | `getAutoscalingCapacity(this: [That](./That.md), params?: [AutoscalingGetAutoscalingCapacityRequest](./AutoscalingGetAutoscalingCapacityRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[AutoscalingGetAutoscalingCapacityResponse](./AutoscalingGetAutoscalingCapacityResponse.md), unknown>>;` |   | +| `getAutoscalingCapacity` | `getAutoscalingCapacity(this: [That](./That.md), params?: [AutoscalingGetAutoscalingCapacityRequest](./AutoscalingGetAutoscalingCapacityRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[AutoscalingGetAutoscalingCapacityResponse](./AutoscalingGetAutoscalingCapacityResponse.md)>;` |   | +| `getAutoscalingPolicy` | `getAutoscalingPolicy(this: [That](./That.md), params: [AutoscalingGetAutoscalingPolicyRequest](./AutoscalingGetAutoscalingPolicyRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[AutoscalingGetAutoscalingPolicyResponse](./AutoscalingGetAutoscalingPolicyResponse.md)>;` | Get an autoscaling policy. NOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported. | +| `getAutoscalingPolicy` | `getAutoscalingPolicy(this: [That](./That.md), params: [AutoscalingGetAutoscalingPolicyRequest](./AutoscalingGetAutoscalingPolicyRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[AutoscalingGetAutoscalingPolicyResponse](./AutoscalingGetAutoscalingPolicyResponse.md), unknown>>;` |   | +| `getAutoscalingPolicy` | `getAutoscalingPolicy(this: [That](./That.md), params: [AutoscalingGetAutoscalingPolicyRequest](./AutoscalingGetAutoscalingPolicyRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[AutoscalingGetAutoscalingPolicyResponse](./AutoscalingGetAutoscalingPolicyResponse.md)>;` |   | +| `putAutoscalingPolicy` | `putAutoscalingPolicy(this: [That](./That.md), params: [AutoscalingPutAutoscalingPolicyRequest](./AutoscalingPutAutoscalingPolicyRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[AutoscalingPutAutoscalingPolicyResponse](./AutoscalingPutAutoscalingPolicyResponse.md)>;` | Create or update an autoscaling policy. NOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported. | +| `putAutoscalingPolicy` | `putAutoscalingPolicy(this: [That](./That.md), params: [AutoscalingPutAutoscalingPolicyRequest](./AutoscalingPutAutoscalingPolicyRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[AutoscalingPutAutoscalingPolicyResponse](./AutoscalingPutAutoscalingPolicyResponse.md), unknown>>;` |   | +| `putAutoscalingPolicy` | `putAutoscalingPolicy(this: [That](./That.md), params: [AutoscalingPutAutoscalingPolicyRequest](./AutoscalingPutAutoscalingPolicyRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[AutoscalingPutAutoscalingPolicyResponse](./AutoscalingPutAutoscalingPolicyResponse.md)>;` |   | diff --git a/docs/reference/api/Cat.md b/docs/reference/api/Cat.md index 925daa4f6..046112a1c 100644 --- a/docs/reference/api/Cat.md +++ b/docs/reference/api/Cat.md @@ -17,4 +17,81 @@ new Cat(transport: [Transport](./Transport.md)); | Name | Signature | Description | | - | - | - | -| `aliases` | `aliases(this: [That](./That.md), params?: [CatAliasesRequest](./CatAliasesRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatAliasesResponse](./CatAliasesResponse.md)>;` | Get aliases. Get the cluster's index aliases, including filter and routing information. This API does not return data stream aliases. IMPORTANT: CAT APIs are only intended for human consumption using the command line or the Kibana console. They are not intended for use by applications. For application consumption, use the aliases API. || `aliases` | `aliases(this: [That](./That.md), params?: [CatAliasesRequest](./CatAliasesRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatAliasesResponse](./CatAliasesResponse.md), unknown>>;` |   || `aliases` | `aliases(this: [That](./That.md), params?: [CatAliasesRequest](./CatAliasesRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatAliasesResponse](./CatAliasesResponse.md)>;` |   || `allocation` | `allocation(this: [That](./That.md), params?: [CatAllocationRequest](./CatAllocationRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatAllocationResponse](./CatAllocationResponse.md)>;` | Get shard allocation information. Get a snapshot of the number of shards allocated to each data node and their disk space. IMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. || `allocation` | `allocation(this: [That](./That.md), params?: [CatAllocationRequest](./CatAllocationRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatAllocationResponse](./CatAllocationResponse.md), unknown>>;` |   || `allocation` | `allocation(this: [That](./That.md), params?: [CatAllocationRequest](./CatAllocationRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatAllocationResponse](./CatAllocationResponse.md)>;` |   || `componentTemplates` | `componentTemplates(this: [That](./That.md), params?: [CatComponentTemplatesRequest](./CatComponentTemplatesRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatComponentTemplatesResponse](./CatComponentTemplatesResponse.md)>;` | Get component templates. Get information about component templates in a cluster. Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. IMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get component template API. || `componentTemplates` | `componentTemplates(this: [That](./That.md), params?: [CatComponentTemplatesRequest](./CatComponentTemplatesRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatComponentTemplatesResponse](./CatComponentTemplatesResponse.md), unknown>>;` |   || `componentTemplates` | `componentTemplates(this: [That](./That.md), params?: [CatComponentTemplatesRequest](./CatComponentTemplatesRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatComponentTemplatesResponse](./CatComponentTemplatesResponse.md)>;` |   || `count` | `count(this: [That](./That.md), params?: [CatCountRequest](./CatCountRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatCountResponse](./CatCountResponse.md)>;` | Get a document count. Get quick access to a document count for a data stream, an index, or an entire cluster. The document count only includes live documents, not deleted documents which have not yet been removed by the merge process. IMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the count API. || `count` | `count(this: [That](./That.md), params?: [CatCountRequest](./CatCountRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatCountResponse](./CatCountResponse.md), unknown>>;` |   || `count` | `count(this: [That](./That.md), params?: [CatCountRequest](./CatCountRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatCountResponse](./CatCountResponse.md)>;` |   || `fielddata` | `fielddata(this: [That](./That.md), params?: [CatFielddataRequest](./CatFielddataRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatFielddataResponse](./CatFielddataResponse.md)>;` | Get field data cache information. Get the amount of heap memory currently used by the field data cache on every data node in the cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes stats API. || `fielddata` | `fielddata(this: [That](./That.md), params?: [CatFielddataRequest](./CatFielddataRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatFielddataResponse](./CatFielddataResponse.md), unknown>>;` |   || `fielddata` | `fielddata(this: [That](./That.md), params?: [CatFielddataRequest](./CatFielddataRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatFielddataResponse](./CatFielddataResponse.md)>;` |   || `health` | `health(this: [That](./That.md), params?: [CatHealthRequest](./CatHealthRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatHealthResponse](./CatHealthResponse.md)>;` | Get the cluster health status. IMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the cluster health API. This API is often used to check malfunctioning clusters. To help you track cluster health alongside log files and alerting systems, the API returns timestamps in two formats: `HH:MM:SS`, which is human-readable but includes no date information; `Unix epoch time`, which is machine-sortable and includes date information. The latter format is useful for cluster recoveries that take multiple days. You can use the cat health API to verify cluster health across multiple nodes. You also can use the API to track the recovery of a large cluster over a longer period of time. || `health` | `health(this: [That](./That.md), params?: [CatHealthRequest](./CatHealthRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatHealthResponse](./CatHealthResponse.md), unknown>>;` |   || `health` | `health(this: [That](./That.md), params?: [CatHealthRequest](./CatHealthRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatHealthResponse](./CatHealthResponse.md)>;` |   || `help` | `help(this: [That](./That.md), params?: [CatHelpRequest](./CatHelpRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatHelpResponse](./CatHelpResponse.md)>;` | Get CAT help. Get help for the CAT APIs. || `help` | `help(this: [That](./That.md), params?: [CatHelpRequest](./CatHelpRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatHelpResponse](./CatHelpResponse.md), unknown>>;` |   || `help` | `help(this: [That](./That.md), params?: [CatHelpRequest](./CatHelpRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatHelpResponse](./CatHelpResponse.md)>;` |   || `indices` | `indices(this: [That](./That.md), params?: [CatIndicesRequest](./CatIndicesRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatIndicesResponse](./CatIndicesResponse.md)>;` | Get index information. Get high-level information about indices in a cluster, including backing indices for data streams. Use this request to get the following information for each index in a cluster: - shard count - document count - deleted document count - primary store size - total store size of all shards, including shard replicas These metrics are retrieved directly from Lucene, which Elasticsearch uses internally to power indexing and search. As a result, all document counts include hidden nested documents. To get an accurate count of Elasticsearch documents, use the cat count or count APIs. CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use an index endpoint. || `indices` | `indices(this: [That](./That.md), params?: [CatIndicesRequest](./CatIndicesRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatIndicesResponse](./CatIndicesResponse.md), unknown>>;` |   || `indices` | `indices(this: [That](./That.md), params?: [CatIndicesRequest](./CatIndicesRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatIndicesResponse](./CatIndicesResponse.md)>;` |   || `master` | `master(this: [That](./That.md), params?: [CatMasterRequest](./CatMasterRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatMasterResponse](./CatMasterResponse.md)>;` | Get master node information. Get information about the master node, including the ID, bound IP address, and name. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API. || `master` | `master(this: [That](./That.md), params?: [CatMasterRequest](./CatMasterRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatMasterResponse](./CatMasterResponse.md), unknown>>;` |   || `master` | `master(this: [That](./That.md), params?: [CatMasterRequest](./CatMasterRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatMasterResponse](./CatMasterResponse.md)>;` |   || `mlDatafeeds` | `mlDatafeeds(this: [That](./That.md), params?: [CatMlDatafeedsRequest](./CatMlDatafeedsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatMlDatafeedsResponse](./CatMlDatafeedsResponse.md)>;` | Get datafeeds. Get configuration and usage information about datafeeds. This API returns a maximum of 10,000 datafeeds. If the Elasticsearch security features are enabled, you must have `monitor_ml`, `monitor`, `manage_ml`, or `manage` cluster privileges to use this API. IMPORTANT: CAT APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get datafeed statistics API. || `mlDatafeeds` | `mlDatafeeds(this: [That](./That.md), params?: [CatMlDatafeedsRequest](./CatMlDatafeedsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatMlDatafeedsResponse](./CatMlDatafeedsResponse.md), unknown>>;` |   || `mlDatafeeds` | `mlDatafeeds(this: [That](./That.md), params?: [CatMlDatafeedsRequest](./CatMlDatafeedsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatMlDatafeedsResponse](./CatMlDatafeedsResponse.md)>;` |   || `mlDataFrameAnalytics` | `mlDataFrameAnalytics(this: [That](./That.md), params?: [CatMlDataFrameAnalyticsRequest](./CatMlDataFrameAnalyticsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatMlDataFrameAnalyticsResponse](./CatMlDataFrameAnalyticsResponse.md)>;` | Get data frame analytics jobs. Get configuration and usage information about data frame analytics jobs. IMPORTANT: CAT APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get data frame analytics jobs statistics API. || `mlDataFrameAnalytics` | `mlDataFrameAnalytics(this: [That](./That.md), params?: [CatMlDataFrameAnalyticsRequest](./CatMlDataFrameAnalyticsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatMlDataFrameAnalyticsResponse](./CatMlDataFrameAnalyticsResponse.md), unknown>>;` |   || `mlDataFrameAnalytics` | `mlDataFrameAnalytics(this: [That](./That.md), params?: [CatMlDataFrameAnalyticsRequest](./CatMlDataFrameAnalyticsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatMlDataFrameAnalyticsResponse](./CatMlDataFrameAnalyticsResponse.md)>;` |   || `mlJobs` | `mlJobs(this: [That](./That.md), params?: [CatMlJobsRequest](./CatMlJobsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatMlJobsResponse](./CatMlJobsResponse.md)>;` | Get anomaly detection jobs. Get configuration and usage information for anomaly detection jobs. This API returns a maximum of 10,000 jobs. If the Elasticsearch security features are enabled, you must have `monitor_ml`, `monitor`, `manage_ml`, or `manage` cluster privileges to use this API. IMPORTANT: CAT APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get anomaly detection job statistics API. || `mlJobs` | `mlJobs(this: [That](./That.md), params?: [CatMlJobsRequest](./CatMlJobsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatMlJobsResponse](./CatMlJobsResponse.md), unknown>>;` |   || `mlJobs` | `mlJobs(this: [That](./That.md), params?: [CatMlJobsRequest](./CatMlJobsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatMlJobsResponse](./CatMlJobsResponse.md)>;` |   || `mlTrainedModels` | `mlTrainedModels(this: [That](./That.md), params?: [CatMlTrainedModelsRequest](./CatMlTrainedModelsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatMlTrainedModelsResponse](./CatMlTrainedModelsResponse.md)>;` | Get trained models. Get configuration and usage information about inference trained models. IMPORTANT: CAT APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get trained models statistics API. || `mlTrainedModels` | `mlTrainedModels(this: [That](./That.md), params?: [CatMlTrainedModelsRequest](./CatMlTrainedModelsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatMlTrainedModelsResponse](./CatMlTrainedModelsResponse.md), unknown>>;` |   || `mlTrainedModels` | `mlTrainedModels(this: [That](./That.md), params?: [CatMlTrainedModelsRequest](./CatMlTrainedModelsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatMlTrainedModelsResponse](./CatMlTrainedModelsResponse.md)>;` |   || `nodeattrs` | `nodeattrs(this: [That](./That.md), params?: [CatNodeattrsRequest](./CatNodeattrsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatNodeattrsResponse](./CatNodeattrsResponse.md)>;` | Get node attribute information. Get information about custom node attributes. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API. || `nodeattrs` | `nodeattrs(this: [That](./That.md), params?: [CatNodeattrsRequest](./CatNodeattrsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatNodeattrsResponse](./CatNodeattrsResponse.md), unknown>>;` |   || `nodeattrs` | `nodeattrs(this: [That](./That.md), params?: [CatNodeattrsRequest](./CatNodeattrsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatNodeattrsResponse](./CatNodeattrsResponse.md)>;` |   || `nodes` | `nodes(this: [That](./That.md), params?: [CatNodesRequest](./CatNodesRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatNodesResponse](./CatNodesResponse.md)>;` | Get node information. Get information about the nodes in a cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API. || `nodes` | `nodes(this: [That](./That.md), params?: [CatNodesRequest](./CatNodesRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatNodesResponse](./CatNodesResponse.md), unknown>>;` |   || `nodes` | `nodes(this: [That](./That.md), params?: [CatNodesRequest](./CatNodesRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatNodesResponse](./CatNodesResponse.md)>;` |   || `pendingTasks` | `pendingTasks(this: [That](./That.md), params?: [CatPendingTasksRequest](./CatPendingTasksRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatPendingTasksResponse](./CatPendingTasksResponse.md)>;` | Get pending task information. Get information about cluster-level changes that have not yet taken effect. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the pending cluster tasks API. || `pendingTasks` | `pendingTasks(this: [That](./That.md), params?: [CatPendingTasksRequest](./CatPendingTasksRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatPendingTasksResponse](./CatPendingTasksResponse.md), unknown>>;` |   || `pendingTasks` | `pendingTasks(this: [That](./That.md), params?: [CatPendingTasksRequest](./CatPendingTasksRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatPendingTasksResponse](./CatPendingTasksResponse.md)>;` |   || `plugins` | `plugins(this: [That](./That.md), params?: [CatPluginsRequest](./CatPluginsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatPluginsResponse](./CatPluginsResponse.md)>;` | Get plugin information. Get a list of plugins running on each node of a cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API. || `plugins` | `plugins(this: [That](./That.md), params?: [CatPluginsRequest](./CatPluginsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatPluginsResponse](./CatPluginsResponse.md), unknown>>;` |   || `plugins` | `plugins(this: [That](./That.md), params?: [CatPluginsRequest](./CatPluginsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatPluginsResponse](./CatPluginsResponse.md)>;` |   || `recovery` | `recovery(this: [That](./That.md), params?: [CatRecoveryRequest](./CatRecoveryRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatRecoveryResponse](./CatRecoveryResponse.md)>;` | Get shard recovery information. Get information about ongoing and completed shard recoveries. Shard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or syncing a replica shard from a primary shard. When a shard recovery completes, the recovered shard is available for search and indexing. For data streams, the API returns information about the stream’s backing indices. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the index recovery API. || `recovery` | `recovery(this: [That](./That.md), params?: [CatRecoveryRequest](./CatRecoveryRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatRecoveryResponse](./CatRecoveryResponse.md), unknown>>;` |   || `recovery` | `recovery(this: [That](./That.md), params?: [CatRecoveryRequest](./CatRecoveryRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatRecoveryResponse](./CatRecoveryResponse.md)>;` |   || `repositories` | `repositories(this: [That](./That.md), params?: [CatRepositoriesRequest](./CatRepositoriesRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatRepositoriesResponse](./CatRepositoriesResponse.md)>;` | Get snapshot repository information. Get a list of snapshot repositories for a cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get snapshot repository API. || `repositories` | `repositories(this: [That](./That.md), params?: [CatRepositoriesRequest](./CatRepositoriesRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatRepositoriesResponse](./CatRepositoriesResponse.md), unknown>>;` |   || `repositories` | `repositories(this: [That](./That.md), params?: [CatRepositoriesRequest](./CatRepositoriesRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatRepositoriesResponse](./CatRepositoriesResponse.md)>;` |   || `segments` | `segments(this: [That](./That.md), params?: [CatSegmentsRequest](./CatSegmentsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatSegmentsResponse](./CatSegmentsResponse.md)>;` | Get segment information. Get low-level information about the Lucene segments in index shards. For data streams, the API returns information about the backing indices. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the index segments API. || `segments` | `segments(this: [That](./That.md), params?: [CatSegmentsRequest](./CatSegmentsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatSegmentsResponse](./CatSegmentsResponse.md), unknown>>;` |   || `segments` | `segments(this: [That](./That.md), params?: [CatSegmentsRequest](./CatSegmentsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatSegmentsResponse](./CatSegmentsResponse.md)>;` |   || `shards` | `shards(this: [That](./That.md), params?: [CatShardsRequest](./CatShardsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatShardsResponse](./CatShardsResponse.md)>;` | Get shard information. Get information about the shards in a cluster. For data streams, the API returns information about the backing indices. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. || `shards` | `shards(this: [That](./That.md), params?: [CatShardsRequest](./CatShardsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatShardsResponse](./CatShardsResponse.md), unknown>>;` |   || `shards` | `shards(this: [That](./That.md), params?: [CatShardsRequest](./CatShardsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatShardsResponse](./CatShardsResponse.md)>;` |   || `snapshots` | `snapshots(this: [That](./That.md), params?: [CatSnapshotsRequest](./CatSnapshotsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatSnapshotsResponse](./CatSnapshotsResponse.md)>;` | Get snapshot information. Get information about the snapshots stored in one or more repositories. A snapshot is a backup of an index or running Elasticsearch cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get snapshot API. || `snapshots` | `snapshots(this: [That](./That.md), params?: [CatSnapshotsRequest](./CatSnapshotsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatSnapshotsResponse](./CatSnapshotsResponse.md), unknown>>;` |   || `snapshots` | `snapshots(this: [That](./That.md), params?: [CatSnapshotsRequest](./CatSnapshotsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatSnapshotsResponse](./CatSnapshotsResponse.md)>;` |   || `tasks` | `tasks(this: [That](./That.md), params?: [CatTasksRequest](./CatTasksRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatTasksResponse](./CatTasksResponse.md)>;` | Get task information. Get information about tasks currently running in the cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the task management API. || `tasks` | `tasks(this: [That](./That.md), params?: [CatTasksRequest](./CatTasksRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatTasksResponse](./CatTasksResponse.md), unknown>>;` |   || `tasks` | `tasks(this: [That](./That.md), params?: [CatTasksRequest](./CatTasksRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatTasksResponse](./CatTasksResponse.md)>;` |   || `templates` | `templates(this: [That](./That.md), params?: [CatTemplatesRequest](./CatTemplatesRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatTemplatesResponse](./CatTemplatesResponse.md)>;` | Get index template information. Get information about the index templates in a cluster. You can use index templates to apply index settings and field mappings to new indices at creation. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get index template API. || `templates` | `templates(this: [That](./That.md), params?: [CatTemplatesRequest](./CatTemplatesRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatTemplatesResponse](./CatTemplatesResponse.md), unknown>>;` |   || `templates` | `templates(this: [That](./That.md), params?: [CatTemplatesRequest](./CatTemplatesRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatTemplatesResponse](./CatTemplatesResponse.md)>;` |   || `threadPool` | `threadPool(this: [That](./That.md), params?: [CatThreadPoolRequest](./CatThreadPoolRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatThreadPoolResponse](./CatThreadPoolResponse.md)>;` | Get thread pool statistics. Get thread pool statistics for each node in a cluster. Returned information includes all built-in thread pools and custom thread pools. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API. || `threadPool` | `threadPool(this: [That](./That.md), params?: [CatThreadPoolRequest](./CatThreadPoolRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatThreadPoolResponse](./CatThreadPoolResponse.md), unknown>>;` |   || `threadPool` | `threadPool(this: [That](./That.md), params?: [CatThreadPoolRequest](./CatThreadPoolRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatThreadPoolResponse](./CatThreadPoolResponse.md)>;` |   || `transforms` | `transforms(this: [That](./That.md), params?: [CatTransformsRequest](./CatTransformsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatTransformsResponse](./CatTransformsResponse.md)>;` | Get transform information. Get configuration and usage information about transforms. CAT APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get transform statistics API. || `transforms` | `transforms(this: [That](./That.md), params?: [CatTransformsRequest](./CatTransformsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatTransformsResponse](./CatTransformsResponse.md), unknown>>;` |   || `transforms` | `transforms(this: [That](./That.md), params?: [CatTransformsRequest](./CatTransformsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatTransformsResponse](./CatTransformsResponse.md)>;` |   | \ No newline at end of file +| `aliases` | `aliases(this: [That](./That.md), params?: [CatAliasesRequest](./CatAliasesRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatAliasesResponse](./CatAliasesResponse.md)>;` | Get aliases. Get the cluster's index aliases, including filter and routing information. This API does not return data stream aliases. IMPORTANT: CAT APIs are only intended for human consumption using the command line or the Kibana console. They are not intended for use by applications. For application consumption, use the aliases API. | +| `aliases` | `aliases(this: [That](./That.md), params?: [CatAliasesRequest](./CatAliasesRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatAliasesResponse](./CatAliasesResponse.md), unknown>>;` |   | +| `aliases` | `aliases(this: [That](./That.md), params?: [CatAliasesRequest](./CatAliasesRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatAliasesResponse](./CatAliasesResponse.md)>;` |   | +| `allocation` | `allocation(this: [That](./That.md), params?: [CatAllocationRequest](./CatAllocationRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatAllocationResponse](./CatAllocationResponse.md)>;` | Get shard allocation information. Get a snapshot of the number of shards allocated to each data node and their disk space. IMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. | +| `allocation` | `allocation(this: [That](./That.md), params?: [CatAllocationRequest](./CatAllocationRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatAllocationResponse](./CatAllocationResponse.md), unknown>>;` |   | +| `allocation` | `allocation(this: [That](./That.md), params?: [CatAllocationRequest](./CatAllocationRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatAllocationResponse](./CatAllocationResponse.md)>;` |   | +| `componentTemplates` | `componentTemplates(this: [That](./That.md), params?: [CatComponentTemplatesRequest](./CatComponentTemplatesRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatComponentTemplatesResponse](./CatComponentTemplatesResponse.md)>;` | Get component templates. Get information about component templates in a cluster. Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. IMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get component template API. | +| `componentTemplates` | `componentTemplates(this: [That](./That.md), params?: [CatComponentTemplatesRequest](./CatComponentTemplatesRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatComponentTemplatesResponse](./CatComponentTemplatesResponse.md), unknown>>;` |   | +| `componentTemplates` | `componentTemplates(this: [That](./That.md), params?: [CatComponentTemplatesRequest](./CatComponentTemplatesRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatComponentTemplatesResponse](./CatComponentTemplatesResponse.md)>;` |   | +| `count` | `count(this: [That](./That.md), params?: [CatCountRequest](./CatCountRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatCountResponse](./CatCountResponse.md)>;` | Get a document count. Get quick access to a document count for a data stream, an index, or an entire cluster. The document count only includes live documents, not deleted documents which have not yet been removed by the merge process. IMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the count API. | +| `count` | `count(this: [That](./That.md), params?: [CatCountRequest](./CatCountRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatCountResponse](./CatCountResponse.md), unknown>>;` |   | +| `count` | `count(this: [That](./That.md), params?: [CatCountRequest](./CatCountRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatCountResponse](./CatCountResponse.md)>;` |   | +| `fielddata` | `fielddata(this: [That](./That.md), params?: [CatFielddataRequest](./CatFielddataRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatFielddataResponse](./CatFielddataResponse.md)>;` | Get field data cache information. Get the amount of heap memory currently used by the field data cache on every data node in the cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes stats API. | +| `fielddata` | `fielddata(this: [That](./That.md), params?: [CatFielddataRequest](./CatFielddataRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatFielddataResponse](./CatFielddataResponse.md), unknown>>;` |   | +| `fielddata` | `fielddata(this: [That](./That.md), params?: [CatFielddataRequest](./CatFielddataRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatFielddataResponse](./CatFielddataResponse.md)>;` |   | +| `health` | `health(this: [That](./That.md), params?: [CatHealthRequest](./CatHealthRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatHealthResponse](./CatHealthResponse.md)>;` | Get the cluster health status. IMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the cluster health API. This API is often used to check malfunctioning clusters. To help you track cluster health alongside log files and alerting systems, the API returns timestamps in two formats: `HH:MM:SS`, which is human-readable but includes no date information; `Unix epoch time`, which is machine-sortable and includes date information. The latter format is useful for cluster recoveries that take multiple days. You can use the cat health API to verify cluster health across multiple nodes. You also can use the API to track the recovery of a large cluster over a longer period of time. | +| `health` | `health(this: [That](./That.md), params?: [CatHealthRequest](./CatHealthRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatHealthResponse](./CatHealthResponse.md), unknown>>;` |   | +| `health` | `health(this: [That](./That.md), params?: [CatHealthRequest](./CatHealthRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatHealthResponse](./CatHealthResponse.md)>;` |   | +| `help` | `help(this: [That](./That.md), params?: [CatHelpRequest](./CatHelpRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatHelpResponse](./CatHelpResponse.md)>;` | Get CAT help. Get help for the CAT APIs. | +| `help` | `help(this: [That](./That.md), params?: [CatHelpRequest](./CatHelpRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatHelpResponse](./CatHelpResponse.md), unknown>>;` |   | +| `help` | `help(this: [That](./That.md), params?: [CatHelpRequest](./CatHelpRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatHelpResponse](./CatHelpResponse.md)>;` |   | +| `indices` | `indices(this: [That](./That.md), params?: [CatIndicesRequest](./CatIndicesRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatIndicesResponse](./CatIndicesResponse.md)>;` | Get index information. Get high-level information about indices in a cluster, including backing indices for data streams. Use this request to get the following information for each index in a cluster: - shard count - document count - deleted document count - primary store size - total store size of all shards, including shard replicas These metrics are retrieved directly from Lucene, which Elasticsearch uses internally to power indexing and search. As a result, all document counts include hidden nested documents. To get an accurate count of Elasticsearch documents, use the cat count or count APIs. CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use an index endpoint. | +| `indices` | `indices(this: [That](./That.md), params?: [CatIndicesRequest](./CatIndicesRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatIndicesResponse](./CatIndicesResponse.md), unknown>>;` |   | +| `indices` | `indices(this: [That](./That.md), params?: [CatIndicesRequest](./CatIndicesRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatIndicesResponse](./CatIndicesResponse.md)>;` |   | +| `master` | `master(this: [That](./That.md), params?: [CatMasterRequest](./CatMasterRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatMasterResponse](./CatMasterResponse.md)>;` | Get master node information. Get information about the master node, including the ID, bound IP address, and name. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API. | +| `master` | `master(this: [That](./That.md), params?: [CatMasterRequest](./CatMasterRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatMasterResponse](./CatMasterResponse.md), unknown>>;` |   | +| `master` | `master(this: [That](./That.md), params?: [CatMasterRequest](./CatMasterRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatMasterResponse](./CatMasterResponse.md)>;` |   | +| `mlDatafeeds` | `mlDatafeeds(this: [That](./That.md), params?: [CatMlDatafeedsRequest](./CatMlDatafeedsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatMlDatafeedsResponse](./CatMlDatafeedsResponse.md)>;` | Get datafeeds. Get configuration and usage information about datafeeds. This API returns a maximum of 10,000 datafeeds. If the Elasticsearch security features are enabled, you must have `monitor_ml`, `monitor`, `manage_ml`, or `manage` cluster privileges to use this API. IMPORTANT: CAT APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get datafeed statistics API. | +| `mlDatafeeds` | `mlDatafeeds(this: [That](./That.md), params?: [CatMlDatafeedsRequest](./CatMlDatafeedsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatMlDatafeedsResponse](./CatMlDatafeedsResponse.md), unknown>>;` |   | +| `mlDatafeeds` | `mlDatafeeds(this: [That](./That.md), params?: [CatMlDatafeedsRequest](./CatMlDatafeedsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatMlDatafeedsResponse](./CatMlDatafeedsResponse.md)>;` |   | +| `mlDataFrameAnalytics` | `mlDataFrameAnalytics(this: [That](./That.md), params?: [CatMlDataFrameAnalyticsRequest](./CatMlDataFrameAnalyticsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatMlDataFrameAnalyticsResponse](./CatMlDataFrameAnalyticsResponse.md)>;` | Get data frame analytics jobs. Get configuration and usage information about data frame analytics jobs. IMPORTANT: CAT APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get data frame analytics jobs statistics API. | +| `mlDataFrameAnalytics` | `mlDataFrameAnalytics(this: [That](./That.md), params?: [CatMlDataFrameAnalyticsRequest](./CatMlDataFrameAnalyticsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatMlDataFrameAnalyticsResponse](./CatMlDataFrameAnalyticsResponse.md), unknown>>;` |   | +| `mlDataFrameAnalytics` | `mlDataFrameAnalytics(this: [That](./That.md), params?: [CatMlDataFrameAnalyticsRequest](./CatMlDataFrameAnalyticsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatMlDataFrameAnalyticsResponse](./CatMlDataFrameAnalyticsResponse.md)>;` |   | +| `mlJobs` | `mlJobs(this: [That](./That.md), params?: [CatMlJobsRequest](./CatMlJobsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatMlJobsResponse](./CatMlJobsResponse.md)>;` | Get anomaly detection jobs. Get configuration and usage information for anomaly detection jobs. This API returns a maximum of 10,000 jobs. If the Elasticsearch security features are enabled, you must have `monitor_ml`, `monitor`, `manage_ml`, or `manage` cluster privileges to use this API. IMPORTANT: CAT APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get anomaly detection job statistics API. | +| `mlJobs` | `mlJobs(this: [That](./That.md), params?: [CatMlJobsRequest](./CatMlJobsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatMlJobsResponse](./CatMlJobsResponse.md), unknown>>;` |   | +| `mlJobs` | `mlJobs(this: [That](./That.md), params?: [CatMlJobsRequest](./CatMlJobsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatMlJobsResponse](./CatMlJobsResponse.md)>;` |   | +| `mlTrainedModels` | `mlTrainedModels(this: [That](./That.md), params?: [CatMlTrainedModelsRequest](./CatMlTrainedModelsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatMlTrainedModelsResponse](./CatMlTrainedModelsResponse.md)>;` | Get trained models. Get configuration and usage information about inference trained models. IMPORTANT: CAT APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get trained models statistics API. | +| `mlTrainedModels` | `mlTrainedModels(this: [That](./That.md), params?: [CatMlTrainedModelsRequest](./CatMlTrainedModelsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatMlTrainedModelsResponse](./CatMlTrainedModelsResponse.md), unknown>>;` |   | +| `mlTrainedModels` | `mlTrainedModels(this: [That](./That.md), params?: [CatMlTrainedModelsRequest](./CatMlTrainedModelsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatMlTrainedModelsResponse](./CatMlTrainedModelsResponse.md)>;` |   | +| `nodeattrs` | `nodeattrs(this: [That](./That.md), params?: [CatNodeattrsRequest](./CatNodeattrsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatNodeattrsResponse](./CatNodeattrsResponse.md)>;` | Get node attribute information. Get information about custom node attributes. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API. | +| `nodeattrs` | `nodeattrs(this: [That](./That.md), params?: [CatNodeattrsRequest](./CatNodeattrsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatNodeattrsResponse](./CatNodeattrsResponse.md), unknown>>;` |   | +| `nodeattrs` | `nodeattrs(this: [That](./That.md), params?: [CatNodeattrsRequest](./CatNodeattrsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatNodeattrsResponse](./CatNodeattrsResponse.md)>;` |   | +| `nodes` | `nodes(this: [That](./That.md), params?: [CatNodesRequest](./CatNodesRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatNodesResponse](./CatNodesResponse.md)>;` | Get node information. Get information about the nodes in a cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API. | +| `nodes` | `nodes(this: [That](./That.md), params?: [CatNodesRequest](./CatNodesRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatNodesResponse](./CatNodesResponse.md), unknown>>;` |   | +| `nodes` | `nodes(this: [That](./That.md), params?: [CatNodesRequest](./CatNodesRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatNodesResponse](./CatNodesResponse.md)>;` |   | +| `pendingTasks` | `pendingTasks(this: [That](./That.md), params?: [CatPendingTasksRequest](./CatPendingTasksRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatPendingTasksResponse](./CatPendingTasksResponse.md)>;` | Get pending task information. Get information about cluster-level changes that have not yet taken effect. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the pending cluster tasks API. | +| `pendingTasks` | `pendingTasks(this: [That](./That.md), params?: [CatPendingTasksRequest](./CatPendingTasksRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatPendingTasksResponse](./CatPendingTasksResponse.md), unknown>>;` |   | +| `pendingTasks` | `pendingTasks(this: [That](./That.md), params?: [CatPendingTasksRequest](./CatPendingTasksRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatPendingTasksResponse](./CatPendingTasksResponse.md)>;` |   | +| `plugins` | `plugins(this: [That](./That.md), params?: [CatPluginsRequest](./CatPluginsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatPluginsResponse](./CatPluginsResponse.md)>;` | Get plugin information. Get a list of plugins running on each node of a cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API. | +| `plugins` | `plugins(this: [That](./That.md), params?: [CatPluginsRequest](./CatPluginsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatPluginsResponse](./CatPluginsResponse.md), unknown>>;` |   | +| `plugins` | `plugins(this: [That](./That.md), params?: [CatPluginsRequest](./CatPluginsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatPluginsResponse](./CatPluginsResponse.md)>;` |   | +| `recovery` | `recovery(this: [That](./That.md), params?: [CatRecoveryRequest](./CatRecoveryRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatRecoveryResponse](./CatRecoveryResponse.md)>;` | Get shard recovery information. Get information about ongoing and completed shard recoveries. Shard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or syncing a replica shard from a primary shard. When a shard recovery completes, the recovered shard is available for search and indexing. For data streams, the API returns information about the stream’s backing indices. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the index recovery API. | +| `recovery` | `recovery(this: [That](./That.md), params?: [CatRecoveryRequest](./CatRecoveryRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatRecoveryResponse](./CatRecoveryResponse.md), unknown>>;` |   | +| `recovery` | `recovery(this: [That](./That.md), params?: [CatRecoveryRequest](./CatRecoveryRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatRecoveryResponse](./CatRecoveryResponse.md)>;` |   | +| `repositories` | `repositories(this: [That](./That.md), params?: [CatRepositoriesRequest](./CatRepositoriesRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatRepositoriesResponse](./CatRepositoriesResponse.md)>;` | Get snapshot repository information. Get a list of snapshot repositories for a cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get snapshot repository API. | +| `repositories` | `repositories(this: [That](./That.md), params?: [CatRepositoriesRequest](./CatRepositoriesRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatRepositoriesResponse](./CatRepositoriesResponse.md), unknown>>;` |   | +| `repositories` | `repositories(this: [That](./That.md), params?: [CatRepositoriesRequest](./CatRepositoriesRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatRepositoriesResponse](./CatRepositoriesResponse.md)>;` |   | +| `segments` | `segments(this: [That](./That.md), params?: [CatSegmentsRequest](./CatSegmentsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatSegmentsResponse](./CatSegmentsResponse.md)>;` | Get segment information. Get low-level information about the Lucene segments in index shards. For data streams, the API returns information about the backing indices. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the index segments API. | +| `segments` | `segments(this: [That](./That.md), params?: [CatSegmentsRequest](./CatSegmentsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatSegmentsResponse](./CatSegmentsResponse.md), unknown>>;` |   | +| `segments` | `segments(this: [That](./That.md), params?: [CatSegmentsRequest](./CatSegmentsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatSegmentsResponse](./CatSegmentsResponse.md)>;` |   | +| `shards` | `shards(this: [That](./That.md), params?: [CatShardsRequest](./CatShardsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatShardsResponse](./CatShardsResponse.md)>;` | Get shard information. Get information about the shards in a cluster. For data streams, the API returns information about the backing indices. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. | +| `shards` | `shards(this: [That](./That.md), params?: [CatShardsRequest](./CatShardsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatShardsResponse](./CatShardsResponse.md), unknown>>;` |   | +| `shards` | `shards(this: [That](./That.md), params?: [CatShardsRequest](./CatShardsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatShardsResponse](./CatShardsResponse.md)>;` |   | +| `snapshots` | `snapshots(this: [That](./That.md), params?: [CatSnapshotsRequest](./CatSnapshotsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatSnapshotsResponse](./CatSnapshotsResponse.md)>;` | Get snapshot information. Get information about the snapshots stored in one or more repositories. A snapshot is a backup of an index or running Elasticsearch cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get snapshot API. | +| `snapshots` | `snapshots(this: [That](./That.md), params?: [CatSnapshotsRequest](./CatSnapshotsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatSnapshotsResponse](./CatSnapshotsResponse.md), unknown>>;` |   | +| `snapshots` | `snapshots(this: [That](./That.md), params?: [CatSnapshotsRequest](./CatSnapshotsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatSnapshotsResponse](./CatSnapshotsResponse.md)>;` |   | +| `tasks` | `tasks(this: [That](./That.md), params?: [CatTasksRequest](./CatTasksRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatTasksResponse](./CatTasksResponse.md)>;` | Get task information. Get information about tasks currently running in the cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the task management API. | +| `tasks` | `tasks(this: [That](./That.md), params?: [CatTasksRequest](./CatTasksRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatTasksResponse](./CatTasksResponse.md), unknown>>;` |   | +| `tasks` | `tasks(this: [That](./That.md), params?: [CatTasksRequest](./CatTasksRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatTasksResponse](./CatTasksResponse.md)>;` |   | +| `templates` | `templates(this: [That](./That.md), params?: [CatTemplatesRequest](./CatTemplatesRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatTemplatesResponse](./CatTemplatesResponse.md)>;` | Get index template information. Get information about the index templates in a cluster. You can use index templates to apply index settings and field mappings to new indices at creation. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get index template API. | +| `templates` | `templates(this: [That](./That.md), params?: [CatTemplatesRequest](./CatTemplatesRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatTemplatesResponse](./CatTemplatesResponse.md), unknown>>;` |   | +| `templates` | `templates(this: [That](./That.md), params?: [CatTemplatesRequest](./CatTemplatesRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatTemplatesResponse](./CatTemplatesResponse.md)>;` |   | +| `threadPool` | `threadPool(this: [That](./That.md), params?: [CatThreadPoolRequest](./CatThreadPoolRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatThreadPoolResponse](./CatThreadPoolResponse.md)>;` | Get thread pool statistics. Get thread pool statistics for each node in a cluster. Returned information includes all built-in thread pools and custom thread pools. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API. | +| `threadPool` | `threadPool(this: [That](./That.md), params?: [CatThreadPoolRequest](./CatThreadPoolRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatThreadPoolResponse](./CatThreadPoolResponse.md), unknown>>;` |   | +| `threadPool` | `threadPool(this: [That](./That.md), params?: [CatThreadPoolRequest](./CatThreadPoolRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatThreadPoolResponse](./CatThreadPoolResponse.md)>;` |   | +| `transforms` | `transforms(this: [That](./That.md), params?: [CatTransformsRequest](./CatTransformsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CatTransformsResponse](./CatTransformsResponse.md)>;` | Get transform information. Get configuration and usage information about transforms. CAT APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get transform statistics API. | +| `transforms` | `transforms(this: [That](./That.md), params?: [CatTransformsRequest](./CatTransformsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CatTransformsResponse](./CatTransformsResponse.md), unknown>>;` |   | +| `transforms` | `transforms(this: [That](./That.md), params?: [CatTransformsRequest](./CatTransformsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CatTransformsResponse](./CatTransformsResponse.md)>;` |   | diff --git a/docs/reference/api/Ccr.md b/docs/reference/api/Ccr.md index bb4103936..6fdc7500f 100644 --- a/docs/reference/api/Ccr.md +++ b/docs/reference/api/Ccr.md @@ -17,4 +17,42 @@ new Ccr(transport: [Transport](./Transport.md)); | Name | Signature | Description | | - | - | - | -| `deleteAutoFollowPattern` | `deleteAutoFollowPattern(this: [That](./That.md), params: [CcrDeleteAutoFollowPatternRequest](./CcrDeleteAutoFollowPatternRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CcrDeleteAutoFollowPatternResponse](./CcrDeleteAutoFollowPatternResponse.md)>;` | Delete auto-follow patterns. Delete a collection of cross-cluster replication auto-follow patterns. || `deleteAutoFollowPattern` | `deleteAutoFollowPattern(this: [That](./That.md), params: [CcrDeleteAutoFollowPatternRequest](./CcrDeleteAutoFollowPatternRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CcrDeleteAutoFollowPatternResponse](./CcrDeleteAutoFollowPatternResponse.md), unknown>>;` |   || `deleteAutoFollowPattern` | `deleteAutoFollowPattern(this: [That](./That.md), params: [CcrDeleteAutoFollowPatternRequest](./CcrDeleteAutoFollowPatternRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CcrDeleteAutoFollowPatternResponse](./CcrDeleteAutoFollowPatternResponse.md)>;` |   || `follow` | `follow(this: [That](./That.md), params: [CcrFollowRequest](./CcrFollowRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CcrFollowResponse](./CcrFollowResponse.md)>;` | Create a follower. Create a cross-cluster replication follower index that follows a specific leader index. When the API returns, the follower index exists and cross-cluster replication starts replicating operations from the leader index to the follower index. || `follow` | `follow(this: [That](./That.md), params: [CcrFollowRequest](./CcrFollowRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CcrFollowResponse](./CcrFollowResponse.md), unknown>>;` |   || `follow` | `follow(this: [That](./That.md), params: [CcrFollowRequest](./CcrFollowRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CcrFollowResponse](./CcrFollowResponse.md)>;` |   || `followInfo` | `followInfo(this: [That](./That.md), params: [CcrFollowInfoRequest](./CcrFollowInfoRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CcrFollowInfoResponse](./CcrFollowInfoResponse.md)>;` | Get follower information. Get information about all cross-cluster replication follower indices. For example, the results include follower index names, leader index names, replication options, and whether the follower indices are active or paused. || `followInfo` | `followInfo(this: [That](./That.md), params: [CcrFollowInfoRequest](./CcrFollowInfoRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CcrFollowInfoResponse](./CcrFollowInfoResponse.md), unknown>>;` |   || `followInfo` | `followInfo(this: [That](./That.md), params: [CcrFollowInfoRequest](./CcrFollowInfoRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CcrFollowInfoResponse](./CcrFollowInfoResponse.md)>;` |   || `followStats` | `followStats(this: [That](./That.md), params: [CcrFollowStatsRequest](./CcrFollowStatsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CcrFollowStatsResponse](./CcrFollowStatsResponse.md)>;` | Get follower stats. Get cross-cluster replication follower stats. The API returns shard-level stats about the "following tasks" associated with each shard for the specified indices. || `followStats` | `followStats(this: [That](./That.md), params: [CcrFollowStatsRequest](./CcrFollowStatsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CcrFollowStatsResponse](./CcrFollowStatsResponse.md), unknown>>;` |   || `followStats` | `followStats(this: [That](./That.md), params: [CcrFollowStatsRequest](./CcrFollowStatsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CcrFollowStatsResponse](./CcrFollowStatsResponse.md)>;` |   || `forgetFollower` | `forgetFollower(this: [That](./That.md), params: [CcrForgetFollowerRequest](./CcrForgetFollowerRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CcrForgetFollowerResponse](./CcrForgetFollowerResponse.md)>;` | Forget a follower. Remove the cross-cluster replication follower retention leases from the leader. A following index takes out retention leases on its leader index. These leases are used to increase the likelihood that the shards of the leader index retain the history of operations that the shards of the following index need to run replication. When a follower index is converted to a regular index by the unfollow API (either by directly calling the API or by index lifecycle management tasks), these leases are removed. However, removal of the leases can fail, for example when the remote cluster containing the leader index is unavailable. While the leases will eventually expire on their own, their extended existence can cause the leader index to hold more history than necessary and prevent index lifecycle management from performing some operations on the leader index. This API exists to enable manually removing the leases when the unfollow API is unable to do so. NOTE: This API does not stop replication by a following index. If you use this API with a follower index that is still actively following, the following index will add back retention leases on the leader. The only purpose of this API is to handle the case of failure to remove the following retention leases after the unfollow API is invoked. || `forgetFollower` | `forgetFollower(this: [That](./That.md), params: [CcrForgetFollowerRequest](./CcrForgetFollowerRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CcrForgetFollowerResponse](./CcrForgetFollowerResponse.md), unknown>>;` |   || `forgetFollower` | `forgetFollower(this: [That](./That.md), params: [CcrForgetFollowerRequest](./CcrForgetFollowerRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CcrForgetFollowerResponse](./CcrForgetFollowerResponse.md)>;` |   || `getAutoFollowPattern` | `getAutoFollowPattern(this: [That](./That.md), params?: [CcrGetAutoFollowPatternRequest](./CcrGetAutoFollowPatternRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CcrGetAutoFollowPatternResponse](./CcrGetAutoFollowPatternResponse.md)>;` | Get auto-follow patterns. Get cross-cluster replication auto-follow patterns. || `getAutoFollowPattern` | `getAutoFollowPattern(this: [That](./That.md), params?: [CcrGetAutoFollowPatternRequest](./CcrGetAutoFollowPatternRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CcrGetAutoFollowPatternResponse](./CcrGetAutoFollowPatternResponse.md), unknown>>;` |   || `getAutoFollowPattern` | `getAutoFollowPattern(this: [That](./That.md), params?: [CcrGetAutoFollowPatternRequest](./CcrGetAutoFollowPatternRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CcrGetAutoFollowPatternResponse](./CcrGetAutoFollowPatternResponse.md)>;` |   || `pauseAutoFollowPattern` | `pauseAutoFollowPattern(this: [That](./That.md), params: [CcrPauseAutoFollowPatternRequest](./CcrPauseAutoFollowPatternRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CcrPauseAutoFollowPatternResponse](./CcrPauseAutoFollowPatternResponse.md)>;` | Pause an auto-follow pattern. Pause a cross-cluster replication auto-follow pattern. When the API returns, the auto-follow pattern is inactive. New indices that are created on the remote cluster and match the auto-follow patterns are ignored. You can resume auto-following with the resume auto-follow pattern API. When it resumes, the auto-follow pattern is active again and automatically configures follower indices for newly created indices on the remote cluster that match its patterns. Remote indices that were created while the pattern was paused will also be followed, unless they have been deleted or closed in the interim. || `pauseAutoFollowPattern` | `pauseAutoFollowPattern(this: [That](./That.md), params: [CcrPauseAutoFollowPatternRequest](./CcrPauseAutoFollowPatternRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CcrPauseAutoFollowPatternResponse](./CcrPauseAutoFollowPatternResponse.md), unknown>>;` |   || `pauseAutoFollowPattern` | `pauseAutoFollowPattern(this: [That](./That.md), params: [CcrPauseAutoFollowPatternRequest](./CcrPauseAutoFollowPatternRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CcrPauseAutoFollowPatternResponse](./CcrPauseAutoFollowPatternResponse.md)>;` |   || `pauseFollow` | `pauseFollow(this: [That](./That.md), params: [CcrPauseFollowRequest](./CcrPauseFollowRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CcrPauseFollowResponse](./CcrPauseFollowResponse.md)>;` | Pause a follower. Pause a cross-cluster replication follower index. The follower index will not fetch any additional operations from the leader index. You can resume following with the resume follower API. You can pause and resume a follower index to change the configuration of the following task. || `pauseFollow` | `pauseFollow(this: [That](./That.md), params: [CcrPauseFollowRequest](./CcrPauseFollowRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CcrPauseFollowResponse](./CcrPauseFollowResponse.md), unknown>>;` |   || `pauseFollow` | `pauseFollow(this: [That](./That.md), params: [CcrPauseFollowRequest](./CcrPauseFollowRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CcrPauseFollowResponse](./CcrPauseFollowResponse.md)>;` |   || `putAutoFollowPattern` | `putAutoFollowPattern(this: [That](./That.md), params: [CcrPutAutoFollowPatternRequest](./CcrPutAutoFollowPatternRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CcrPutAutoFollowPatternResponse](./CcrPutAutoFollowPatternResponse.md)>;` | Create or update auto-follow patterns. Create a collection of cross-cluster replication auto-follow patterns for a remote cluster. Newly created indices on the remote cluster that match any of the patterns are automatically configured as follower indices. Indices on the remote cluster that were created before the auto-follow pattern was created will not be auto-followed even if they match the pattern. This API can also be used to update auto-follow patterns. NOTE: Follower indices that were configured automatically before updating an auto-follow pattern will remain unchanged even if they do not match against the new patterns. || `putAutoFollowPattern` | `putAutoFollowPattern(this: [That](./That.md), params: [CcrPutAutoFollowPatternRequest](./CcrPutAutoFollowPatternRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CcrPutAutoFollowPatternResponse](./CcrPutAutoFollowPatternResponse.md), unknown>>;` |   || `putAutoFollowPattern` | `putAutoFollowPattern(this: [That](./That.md), params: [CcrPutAutoFollowPatternRequest](./CcrPutAutoFollowPatternRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CcrPutAutoFollowPatternResponse](./CcrPutAutoFollowPatternResponse.md)>;` |   || `resumeAutoFollowPattern` | `resumeAutoFollowPattern(this: [That](./That.md), params: [CcrResumeAutoFollowPatternRequest](./CcrResumeAutoFollowPatternRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CcrResumeAutoFollowPatternResponse](./CcrResumeAutoFollowPatternResponse.md)>;` | Resume an auto-follow pattern. Resume a cross-cluster replication auto-follow pattern that was paused. The auto-follow pattern will resume configuring following indices for newly created indices that match its patterns on the remote cluster. Remote indices created while the pattern was paused will also be followed unless they have been deleted or closed in the interim. || `resumeAutoFollowPattern` | `resumeAutoFollowPattern(this: [That](./That.md), params: [CcrResumeAutoFollowPatternRequest](./CcrResumeAutoFollowPatternRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CcrResumeAutoFollowPatternResponse](./CcrResumeAutoFollowPatternResponse.md), unknown>>;` |   || `resumeAutoFollowPattern` | `resumeAutoFollowPattern(this: [That](./That.md), params: [CcrResumeAutoFollowPatternRequest](./CcrResumeAutoFollowPatternRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CcrResumeAutoFollowPatternResponse](./CcrResumeAutoFollowPatternResponse.md)>;` |   || `resumeFollow` | `resumeFollow(this: [That](./That.md), params: [CcrResumeFollowRequest](./CcrResumeFollowRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CcrResumeFollowResponse](./CcrResumeFollowResponse.md)>;` | Resume a follower. Resume a cross-cluster replication follower index that was paused. The follower index could have been paused with the pause follower API. Alternatively it could be paused due to replication that cannot be retried due to failures during following tasks. When this API returns, the follower index will resume fetching operations from the leader index. || `resumeFollow` | `resumeFollow(this: [That](./That.md), params: [CcrResumeFollowRequest](./CcrResumeFollowRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CcrResumeFollowResponse](./CcrResumeFollowResponse.md), unknown>>;` |   || `resumeFollow` | `resumeFollow(this: [That](./That.md), params: [CcrResumeFollowRequest](./CcrResumeFollowRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CcrResumeFollowResponse](./CcrResumeFollowResponse.md)>;` |   || `stats` | `stats(this: [That](./That.md), params?: [CcrStatsRequest](./CcrStatsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CcrStatsResponse](./CcrStatsResponse.md)>;` | Get cross-cluster replication stats. This API returns stats about auto-following and the same shard-level stats as the get follower stats API. || `stats` | `stats(this: [That](./That.md), params?: [CcrStatsRequest](./CcrStatsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CcrStatsResponse](./CcrStatsResponse.md), unknown>>;` |   || `stats` | `stats(this: [That](./That.md), params?: [CcrStatsRequest](./CcrStatsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CcrStatsResponse](./CcrStatsResponse.md)>;` |   || `unfollow` | `unfollow(this: [That](./That.md), params: [CcrUnfollowRequest](./CcrUnfollowRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CcrUnfollowResponse](./CcrUnfollowResponse.md)>;` | Unfollow an index. Convert a cross-cluster replication follower index to a regular index. The API stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. The follower index must be paused and closed before you call the unfollow API. > info > Currently cross-cluster replication does not support converting an existing regular index to a follower index. Converting a follower index to a regular index is an irreversible operation. || `unfollow` | `unfollow(this: [That](./That.md), params: [CcrUnfollowRequest](./CcrUnfollowRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CcrUnfollowResponse](./CcrUnfollowResponse.md), unknown>>;` |   || `unfollow` | `unfollow(this: [That](./That.md), params: [CcrUnfollowRequest](./CcrUnfollowRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CcrUnfollowResponse](./CcrUnfollowResponse.md)>;` |   | \ No newline at end of file +| `deleteAutoFollowPattern` | `deleteAutoFollowPattern(this: [That](./That.md), params: [CcrDeleteAutoFollowPatternRequest](./CcrDeleteAutoFollowPatternRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CcrDeleteAutoFollowPatternResponse](./CcrDeleteAutoFollowPatternResponse.md)>;` | Delete auto-follow patterns. Delete a collection of cross-cluster replication auto-follow patterns. | +| `deleteAutoFollowPattern` | `deleteAutoFollowPattern(this: [That](./That.md), params: [CcrDeleteAutoFollowPatternRequest](./CcrDeleteAutoFollowPatternRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CcrDeleteAutoFollowPatternResponse](./CcrDeleteAutoFollowPatternResponse.md), unknown>>;` |   | +| `deleteAutoFollowPattern` | `deleteAutoFollowPattern(this: [That](./That.md), params: [CcrDeleteAutoFollowPatternRequest](./CcrDeleteAutoFollowPatternRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CcrDeleteAutoFollowPatternResponse](./CcrDeleteAutoFollowPatternResponse.md)>;` |   | +| `follow` | `follow(this: [That](./That.md), params: [CcrFollowRequest](./CcrFollowRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CcrFollowResponse](./CcrFollowResponse.md)>;` | Create a follower. Create a cross-cluster replication follower index that follows a specific leader index. When the API returns, the follower index exists and cross-cluster replication starts replicating operations from the leader index to the follower index. | +| `follow` | `follow(this: [That](./That.md), params: [CcrFollowRequest](./CcrFollowRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CcrFollowResponse](./CcrFollowResponse.md), unknown>>;` |   | +| `follow` | `follow(this: [That](./That.md), params: [CcrFollowRequest](./CcrFollowRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CcrFollowResponse](./CcrFollowResponse.md)>;` |   | +| `followInfo` | `followInfo(this: [That](./That.md), params: [CcrFollowInfoRequest](./CcrFollowInfoRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CcrFollowInfoResponse](./CcrFollowInfoResponse.md)>;` | Get follower information. Get information about all cross-cluster replication follower indices. For example, the results include follower index names, leader index names, replication options, and whether the follower indices are active or paused. | +| `followInfo` | `followInfo(this: [That](./That.md), params: [CcrFollowInfoRequest](./CcrFollowInfoRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CcrFollowInfoResponse](./CcrFollowInfoResponse.md), unknown>>;` |   | +| `followInfo` | `followInfo(this: [That](./That.md), params: [CcrFollowInfoRequest](./CcrFollowInfoRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CcrFollowInfoResponse](./CcrFollowInfoResponse.md)>;` |   | +| `followStats` | `followStats(this: [That](./That.md), params: [CcrFollowStatsRequest](./CcrFollowStatsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CcrFollowStatsResponse](./CcrFollowStatsResponse.md)>;` | Get follower stats. Get cross-cluster replication follower stats. The API returns shard-level stats about the "following tasks" associated with each shard for the specified indices. | +| `followStats` | `followStats(this: [That](./That.md), params: [CcrFollowStatsRequest](./CcrFollowStatsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CcrFollowStatsResponse](./CcrFollowStatsResponse.md), unknown>>;` |   | +| `followStats` | `followStats(this: [That](./That.md), params: [CcrFollowStatsRequest](./CcrFollowStatsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CcrFollowStatsResponse](./CcrFollowStatsResponse.md)>;` |   | +| `forgetFollower` | `forgetFollower(this: [That](./That.md), params: [CcrForgetFollowerRequest](./CcrForgetFollowerRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CcrForgetFollowerResponse](./CcrForgetFollowerResponse.md)>;` | Forget a follower. Remove the cross-cluster replication follower retention leases from the leader. A following index takes out retention leases on its leader index. These leases are used to increase the likelihood that the shards of the leader index retain the history of operations that the shards of the following index need to run replication. When a follower index is converted to a regular index by the unfollow API (either by directly calling the API or by index lifecycle management tasks), these leases are removed. However, removal of the leases can fail, for example when the remote cluster containing the leader index is unavailable. While the leases will eventually expire on their own, their extended existence can cause the leader index to hold more history than necessary and prevent index lifecycle management from performing some operations on the leader index. This API exists to enable manually removing the leases when the unfollow API is unable to do so. NOTE: This API does not stop replication by a following index. If you use this API with a follower index that is still actively following, the following index will add back retention leases on the leader. The only purpose of this API is to handle the case of failure to remove the following retention leases after the unfollow API is invoked. | +| `forgetFollower` | `forgetFollower(this: [That](./That.md), params: [CcrForgetFollowerRequest](./CcrForgetFollowerRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CcrForgetFollowerResponse](./CcrForgetFollowerResponse.md), unknown>>;` |   | +| `forgetFollower` | `forgetFollower(this: [That](./That.md), params: [CcrForgetFollowerRequest](./CcrForgetFollowerRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CcrForgetFollowerResponse](./CcrForgetFollowerResponse.md)>;` |   | +| `getAutoFollowPattern` | `getAutoFollowPattern(this: [That](./That.md), params?: [CcrGetAutoFollowPatternRequest](./CcrGetAutoFollowPatternRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CcrGetAutoFollowPatternResponse](./CcrGetAutoFollowPatternResponse.md)>;` | Get auto-follow patterns. Get cross-cluster replication auto-follow patterns. | +| `getAutoFollowPattern` | `getAutoFollowPattern(this: [That](./That.md), params?: [CcrGetAutoFollowPatternRequest](./CcrGetAutoFollowPatternRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CcrGetAutoFollowPatternResponse](./CcrGetAutoFollowPatternResponse.md), unknown>>;` |   | +| `getAutoFollowPattern` | `getAutoFollowPattern(this: [That](./That.md), params?: [CcrGetAutoFollowPatternRequest](./CcrGetAutoFollowPatternRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CcrGetAutoFollowPatternResponse](./CcrGetAutoFollowPatternResponse.md)>;` |   | +| `pauseAutoFollowPattern` | `pauseAutoFollowPattern(this: [That](./That.md), params: [CcrPauseAutoFollowPatternRequest](./CcrPauseAutoFollowPatternRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CcrPauseAutoFollowPatternResponse](./CcrPauseAutoFollowPatternResponse.md)>;` | Pause an auto-follow pattern. Pause a cross-cluster replication auto-follow pattern. When the API returns, the auto-follow pattern is inactive. New indices that are created on the remote cluster and match the auto-follow patterns are ignored. You can resume auto-following with the resume auto-follow pattern API. When it resumes, the auto-follow pattern is active again and automatically configures follower indices for newly created indices on the remote cluster that match its patterns. Remote indices that were created while the pattern was paused will also be followed, unless they have been deleted or closed in the interim. | +| `pauseAutoFollowPattern` | `pauseAutoFollowPattern(this: [That](./That.md), params: [CcrPauseAutoFollowPatternRequest](./CcrPauseAutoFollowPatternRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CcrPauseAutoFollowPatternResponse](./CcrPauseAutoFollowPatternResponse.md), unknown>>;` |   | +| `pauseAutoFollowPattern` | `pauseAutoFollowPattern(this: [That](./That.md), params: [CcrPauseAutoFollowPatternRequest](./CcrPauseAutoFollowPatternRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CcrPauseAutoFollowPatternResponse](./CcrPauseAutoFollowPatternResponse.md)>;` |   | +| `pauseFollow` | `pauseFollow(this: [That](./That.md), params: [CcrPauseFollowRequest](./CcrPauseFollowRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CcrPauseFollowResponse](./CcrPauseFollowResponse.md)>;` | Pause a follower. Pause a cross-cluster replication follower index. The follower index will not fetch any additional operations from the leader index. You can resume following with the resume follower API. You can pause and resume a follower index to change the configuration of the following task. | +| `pauseFollow` | `pauseFollow(this: [That](./That.md), params: [CcrPauseFollowRequest](./CcrPauseFollowRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CcrPauseFollowResponse](./CcrPauseFollowResponse.md), unknown>>;` |   | +| `pauseFollow` | `pauseFollow(this: [That](./That.md), params: [CcrPauseFollowRequest](./CcrPauseFollowRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CcrPauseFollowResponse](./CcrPauseFollowResponse.md)>;` |   | +| `putAutoFollowPattern` | `putAutoFollowPattern(this: [That](./That.md), params: [CcrPutAutoFollowPatternRequest](./CcrPutAutoFollowPatternRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CcrPutAutoFollowPatternResponse](./CcrPutAutoFollowPatternResponse.md)>;` | Create or update auto-follow patterns. Create a collection of cross-cluster replication auto-follow patterns for a remote cluster. Newly created indices on the remote cluster that match any of the patterns are automatically configured as follower indices. Indices on the remote cluster that were created before the auto-follow pattern was created will not be auto-followed even if they match the pattern. This API can also be used to update auto-follow patterns. NOTE: Follower indices that were configured automatically before updating an auto-follow pattern will remain unchanged even if they do not match against the new patterns. | +| `putAutoFollowPattern` | `putAutoFollowPattern(this: [That](./That.md), params: [CcrPutAutoFollowPatternRequest](./CcrPutAutoFollowPatternRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CcrPutAutoFollowPatternResponse](./CcrPutAutoFollowPatternResponse.md), unknown>>;` |   | +| `putAutoFollowPattern` | `putAutoFollowPattern(this: [That](./That.md), params: [CcrPutAutoFollowPatternRequest](./CcrPutAutoFollowPatternRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CcrPutAutoFollowPatternResponse](./CcrPutAutoFollowPatternResponse.md)>;` |   | +| `resumeAutoFollowPattern` | `resumeAutoFollowPattern(this: [That](./That.md), params: [CcrResumeAutoFollowPatternRequest](./CcrResumeAutoFollowPatternRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CcrResumeAutoFollowPatternResponse](./CcrResumeAutoFollowPatternResponse.md)>;` | Resume an auto-follow pattern. Resume a cross-cluster replication auto-follow pattern that was paused. The auto-follow pattern will resume configuring following indices for newly created indices that match its patterns on the remote cluster. Remote indices created while the pattern was paused will also be followed unless they have been deleted or closed in the interim. | +| `resumeAutoFollowPattern` | `resumeAutoFollowPattern(this: [That](./That.md), params: [CcrResumeAutoFollowPatternRequest](./CcrResumeAutoFollowPatternRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CcrResumeAutoFollowPatternResponse](./CcrResumeAutoFollowPatternResponse.md), unknown>>;` |   | +| `resumeAutoFollowPattern` | `resumeAutoFollowPattern(this: [That](./That.md), params: [CcrResumeAutoFollowPatternRequest](./CcrResumeAutoFollowPatternRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CcrResumeAutoFollowPatternResponse](./CcrResumeAutoFollowPatternResponse.md)>;` |   | +| `resumeFollow` | `resumeFollow(this: [That](./That.md), params: [CcrResumeFollowRequest](./CcrResumeFollowRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CcrResumeFollowResponse](./CcrResumeFollowResponse.md)>;` | Resume a follower. Resume a cross-cluster replication follower index that was paused. The follower index could have been paused with the pause follower API. Alternatively it could be paused due to replication that cannot be retried due to failures during following tasks. When this API returns, the follower index will resume fetching operations from the leader index. | +| `resumeFollow` | `resumeFollow(this: [That](./That.md), params: [CcrResumeFollowRequest](./CcrResumeFollowRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CcrResumeFollowResponse](./CcrResumeFollowResponse.md), unknown>>;` |   | +| `resumeFollow` | `resumeFollow(this: [That](./That.md), params: [CcrResumeFollowRequest](./CcrResumeFollowRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CcrResumeFollowResponse](./CcrResumeFollowResponse.md)>;` |   | +| `stats` | `stats(this: [That](./That.md), params?: [CcrStatsRequest](./CcrStatsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CcrStatsResponse](./CcrStatsResponse.md)>;` | Get cross-cluster replication stats. This API returns stats about auto-following and the same shard-level stats as the get follower stats API. | +| `stats` | `stats(this: [That](./That.md), params?: [CcrStatsRequest](./CcrStatsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CcrStatsResponse](./CcrStatsResponse.md), unknown>>;` |   | +| `stats` | `stats(this: [That](./That.md), params?: [CcrStatsRequest](./CcrStatsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CcrStatsResponse](./CcrStatsResponse.md)>;` |   | +| `unfollow` | `unfollow(this: [That](./That.md), params: [CcrUnfollowRequest](./CcrUnfollowRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CcrUnfollowResponse](./CcrUnfollowResponse.md)>;` | Unfollow an index. Convert a cross-cluster replication follower index to a regular index. The API stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. The follower index must be paused and closed before you call the unfollow API. > info > Currently cross-cluster replication does not support converting an existing regular index to a follower index. Converting a follower index to a regular index is an irreversible operation. | +| `unfollow` | `unfollow(this: [That](./That.md), params: [CcrUnfollowRequest](./CcrUnfollowRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CcrUnfollowResponse](./CcrUnfollowResponse.md), unknown>>;` |   | +| `unfollow` | `unfollow(this: [That](./That.md), params: [CcrUnfollowRequest](./CcrUnfollowRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CcrUnfollowResponse](./CcrUnfollowResponse.md)>;` |   | diff --git a/docs/reference/api/Client.md b/docs/reference/api/Client.md index a638a6855..4998107b4 100644 --- a/docs/reference/api/Client.md +++ b/docs/reference/api/Client.md @@ -21,4 +21,5 @@ new Client(opts: [ClientOptions](./ClientOptions.md)); | Name | Signature | Description | | - | - | - | -| `child` | `child(opts: [ClientOptions](./ClientOptions.md)): [Client](./Client.md);` | Creates a child client instance that shared its connection pool with the parent client || `close` | `close(): Promise;` | Closes all connections in the connection pool. Connections shared with any parent or child instances will also be closed. | +| `child` | `child(opts: [ClientOptions](./ClientOptions.md)): [Client](./Client.md);` | Creates a child client instance that shared its connection pool with the parent client | +| `close` | `close(): Promise;` | Closes all connections in the connection pool. Connections shared with any parent or child instances will also be closed. | diff --git a/docs/reference/api/Cluster.md b/docs/reference/api/Cluster.md index 486626c6a..04d2d21e7 100644 --- a/docs/reference/api/Cluster.md +++ b/docs/reference/api/Cluster.md @@ -17,4 +17,51 @@ new Cluster(transport: [Transport](./Transport.md)); | Name | Signature | Description | | - | - | - | -| `allocationExplain` | `allocationExplain(this: [That](./That.md), params?: [ClusterAllocationExplainRequest](./ClusterAllocationExplainRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ClusterAllocationExplainResponse](./ClusterAllocationExplainResponse.md)>;` | Explain the shard allocations. Get explanations for shard allocations in the cluster. For unassigned shards, it provides an explanation for why the shard is unassigned. For assigned shards, it provides an explanation for why the shard is remaining on its current node and has not moved or rebalanced to another node. This API can be very useful when attempting to diagnose why a shard is unassigned or why a shard continues to remain on its current node when you might expect otherwise. || `allocationExplain` | `allocationExplain(this: [That](./That.md), params?: [ClusterAllocationExplainRequest](./ClusterAllocationExplainRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ClusterAllocationExplainResponse](./ClusterAllocationExplainResponse.md), unknown>>;` |   || `allocationExplain` | `allocationExplain(this: [That](./That.md), params?: [ClusterAllocationExplainRequest](./ClusterAllocationExplainRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ClusterAllocationExplainResponse](./ClusterAllocationExplainResponse.md)>;` |   || `deleteComponentTemplate` | `deleteComponentTemplate(this: [That](./That.md), params: [ClusterDeleteComponentTemplateRequest](./ClusterDeleteComponentTemplateRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ClusterDeleteComponentTemplateResponse](./ClusterDeleteComponentTemplateResponse.md)>;` | Delete component templates. Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. || `deleteComponentTemplate` | `deleteComponentTemplate(this: [That](./That.md), params: [ClusterDeleteComponentTemplateRequest](./ClusterDeleteComponentTemplateRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ClusterDeleteComponentTemplateResponse](./ClusterDeleteComponentTemplateResponse.md), unknown>>;` |   || `deleteComponentTemplate` | `deleteComponentTemplate(this: [That](./That.md), params: [ClusterDeleteComponentTemplateRequest](./ClusterDeleteComponentTemplateRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ClusterDeleteComponentTemplateResponse](./ClusterDeleteComponentTemplateResponse.md)>;` |   || `deleteVotingConfigExclusions` | `deleteVotingConfigExclusions(this: [That](./That.md), params?: [ClusterDeleteVotingConfigExclusionsRequest](./ClusterDeleteVotingConfigExclusionsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ClusterDeleteVotingConfigExclusionsResponse](./ClusterDeleteVotingConfigExclusionsResponse.md)>;` | Clear cluster voting config exclusions. Remove master-eligible nodes from the voting configuration exclusion list. || `deleteVotingConfigExclusions` | `deleteVotingConfigExclusions(this: [That](./That.md), params?: [ClusterDeleteVotingConfigExclusionsRequest](./ClusterDeleteVotingConfigExclusionsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ClusterDeleteVotingConfigExclusionsResponse](./ClusterDeleteVotingConfigExclusionsResponse.md), unknown>>;` |   || `deleteVotingConfigExclusions` | `deleteVotingConfigExclusions(this: [That](./That.md), params?: [ClusterDeleteVotingConfigExclusionsRequest](./ClusterDeleteVotingConfigExclusionsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ClusterDeleteVotingConfigExclusionsResponse](./ClusterDeleteVotingConfigExclusionsResponse.md)>;` |   || `existsComponentTemplate` | `existsComponentTemplate(this: [That](./That.md), params: [ClusterExistsComponentTemplateRequest](./ClusterExistsComponentTemplateRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ClusterExistsComponentTemplateResponse](./ClusterExistsComponentTemplateResponse.md)>;` | Check component templates. Returns information about whether a particular component template exists. || `existsComponentTemplate` | `existsComponentTemplate(this: [That](./That.md), params: [ClusterExistsComponentTemplateRequest](./ClusterExistsComponentTemplateRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ClusterExistsComponentTemplateResponse](./ClusterExistsComponentTemplateResponse.md), unknown>>;` |   || `existsComponentTemplate` | `existsComponentTemplate(this: [That](./That.md), params: [ClusterExistsComponentTemplateRequest](./ClusterExistsComponentTemplateRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ClusterExistsComponentTemplateResponse](./ClusterExistsComponentTemplateResponse.md)>;` |   || `getComponentTemplate` | `getComponentTemplate(this: [That](./That.md), params?: [ClusterGetComponentTemplateRequest](./ClusterGetComponentTemplateRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ClusterGetComponentTemplateResponse](./ClusterGetComponentTemplateResponse.md)>;` | Get component templates. Get information about component templates. || `getComponentTemplate` | `getComponentTemplate(this: [That](./That.md), params?: [ClusterGetComponentTemplateRequest](./ClusterGetComponentTemplateRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ClusterGetComponentTemplateResponse](./ClusterGetComponentTemplateResponse.md), unknown>>;` |   || `getComponentTemplate` | `getComponentTemplate(this: [That](./That.md), params?: [ClusterGetComponentTemplateRequest](./ClusterGetComponentTemplateRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ClusterGetComponentTemplateResponse](./ClusterGetComponentTemplateResponse.md)>;` |   || `getSettings` | `getSettings(this: [That](./That.md), params?: [ClusterGetSettingsRequest](./ClusterGetSettingsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ClusterGetSettingsResponse](./ClusterGetSettingsResponse.md)>;` | Get cluster-wide settings. By default, it returns only settings that have been explicitly defined. || `getSettings` | `getSettings(this: [That](./That.md), params?: [ClusterGetSettingsRequest](./ClusterGetSettingsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ClusterGetSettingsResponse](./ClusterGetSettingsResponse.md), unknown>>;` |   || `getSettings` | `getSettings(this: [That](./That.md), params?: [ClusterGetSettingsRequest](./ClusterGetSettingsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ClusterGetSettingsResponse](./ClusterGetSettingsResponse.md)>;` |   || `health` | `health(this: [That](./That.md), params?: [ClusterHealthRequest](./ClusterHealthRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ClusterHealthResponse](./ClusterHealthResponse.md)>;` | Get the cluster health status. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices. The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster. Yellow means that the primary shard is allocated but replicas are not. Green means that all shards are allocated. The index level status is controlled by the worst shard status. One of the main benefits of the API is the ability to wait until the cluster reaches a certain high watermark health level. The cluster status is controlled by the worst index status. || `health` | `health(this: [That](./That.md), params?: [ClusterHealthRequest](./ClusterHealthRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ClusterHealthResponse](./ClusterHealthResponse.md), unknown>>;` |   || `health` | `health(this: [That](./That.md), params?: [ClusterHealthRequest](./ClusterHealthRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ClusterHealthResponse](./ClusterHealthResponse.md)>;` |   || `info` | `info(this: [That](./That.md), params: [ClusterInfoRequest](./ClusterInfoRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ClusterInfoResponse](./ClusterInfoResponse.md)>;` | Get cluster info. Returns basic information about the cluster. || `info` | `info(this: [That](./That.md), params: [ClusterInfoRequest](./ClusterInfoRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ClusterInfoResponse](./ClusterInfoResponse.md), unknown>>;` |   || `info` | `info(this: [That](./That.md), params: [ClusterInfoRequest](./ClusterInfoRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ClusterInfoResponse](./ClusterInfoResponse.md)>;` |   || `pendingTasks` | `pendingTasks(this: [That](./That.md), params?: [ClusterPendingTasksRequest](./ClusterPendingTasksRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ClusterPendingTasksResponse](./ClusterPendingTasksResponse.md)>;` | Get the pending cluster tasks. Get information about cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet taken effect. NOTE: This API returns a list of any pending updates to the cluster state. These are distinct from the tasks reported by the task management API which include periodic tasks and tasks initiated by the user, such as node stats, search queries, or create index requests. However, if a user-initiated task such as a create index command causes a cluster state update, the activity of this task might be reported by both task api and pending cluster tasks API. || `pendingTasks` | `pendingTasks(this: [That](./That.md), params?: [ClusterPendingTasksRequest](./ClusterPendingTasksRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ClusterPendingTasksResponse](./ClusterPendingTasksResponse.md), unknown>>;` |   || `pendingTasks` | `pendingTasks(this: [That](./That.md), params?: [ClusterPendingTasksRequest](./ClusterPendingTasksRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ClusterPendingTasksResponse](./ClusterPendingTasksResponse.md)>;` |   || `postVotingConfigExclusions` | `postVotingConfigExclusions(this: [That](./That.md), params?: [ClusterPostVotingConfigExclusionsRequest](./ClusterPostVotingConfigExclusionsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ClusterPostVotingConfigExclusionsResponse](./ClusterPostVotingConfigExclusionsResponse.md)>;` | Update voting configuration exclusions. Update the cluster voting config exclusions by node IDs or node names. By default, if there are more than three master-eligible nodes in the cluster and you remove fewer than half of the master-eligible nodes in the cluster at once, the voting configuration automatically shrinks. If you want to shrink the voting configuration to contain fewer than three nodes or to remove half or more of the master-eligible nodes in the cluster at once, use this API to remove departing nodes from the voting configuration manually. The API adds an entry for each specified node to the cluster’s voting configuration exclusions list. It then waits until the cluster has reconfigured its voting configuration to exclude the specified nodes. Clusters should have no voting configuration exclusions in normal operation. Once the excluded nodes have stopped, clear the voting configuration exclusions with `DELETE /_cluster/voting_config_exclusions`. This API waits for the nodes to be fully removed from the cluster before it returns. If your cluster has voting configuration exclusions for nodes that you no longer intend to remove, use `DELETE /_cluster/voting_config_exclusions?wait_for_removal=false` to clear the voting configuration exclusions without waiting for the nodes to leave the cluster. A response to `POST /_cluster/voting_config_exclusions` with an HTTP status code of 200 OK guarantees that the node has been removed from the voting configuration and will not be reinstated until the voting configuration exclusions are cleared by calling `DELETE /_cluster/voting_config_exclusions`. If the call to `POST /_cluster/voting_config_exclusions` fails or returns a response with an HTTP status code other than 200 OK then the node may not have been removed from the voting configuration. In that case, you may safely retry the call. NOTE: Voting exclusions are required only when you remove at least half of the master-eligible nodes from a cluster in a short time period. They are not required when removing master-ineligible nodes or when removing fewer than half of the master-eligible nodes. || `postVotingConfigExclusions` | `postVotingConfigExclusions(this: [That](./That.md), params?: [ClusterPostVotingConfigExclusionsRequest](./ClusterPostVotingConfigExclusionsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ClusterPostVotingConfigExclusionsResponse](./ClusterPostVotingConfigExclusionsResponse.md), unknown>>;` |   || `postVotingConfigExclusions` | `postVotingConfigExclusions(this: [That](./That.md), params?: [ClusterPostVotingConfigExclusionsRequest](./ClusterPostVotingConfigExclusionsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ClusterPostVotingConfigExclusionsResponse](./ClusterPostVotingConfigExclusionsResponse.md)>;` |   || `putComponentTemplate` | `putComponentTemplate(this: [That](./That.md), params: [ClusterPutComponentTemplateRequest](./ClusterPutComponentTemplateRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ClusterPutComponentTemplateResponse](./ClusterPutComponentTemplateResponse.md)>;` | Create or update a component template. Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. An index template can be composed of multiple component templates. To use a component template, specify it in an index template’s `composed_of` list. Component templates are only applied to new data streams and indices as part of a matching index template. Settings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template. Component templates are only used during index creation. For data streams, this includes data stream creation and the creation of a stream’s backing indices. Changes to component templates do not affect existing indices, including a stream’s backing indices. You can use C-style `/* *\/` block comments in component templates. You can include comments anywhere in the request body except before the opening curly bracket. **Applying component templates** You cannot directly apply a component template to a data stream or index. To be applied, a component template must be included in an index template's `composed_of` list. || `putComponentTemplate` | `putComponentTemplate(this: [That](./That.md), params: [ClusterPutComponentTemplateRequest](./ClusterPutComponentTemplateRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ClusterPutComponentTemplateResponse](./ClusterPutComponentTemplateResponse.md), unknown>>;` |   || `putComponentTemplate` | `putComponentTemplate(this: [That](./That.md), params: [ClusterPutComponentTemplateRequest](./ClusterPutComponentTemplateRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ClusterPutComponentTemplateResponse](./ClusterPutComponentTemplateResponse.md)>;` |   || `putSettings` | `putSettings(this: [That](./That.md), params?: [ClusterPutSettingsRequest](./ClusterPutSettingsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ClusterPutSettingsResponse](./ClusterPutSettingsResponse.md)>;` | Update the cluster settings. Configure and update dynamic settings on a running cluster. You can also configure dynamic settings locally on an unstarted or shut down node in `elasticsearch.yml`. Updates made with this API can be persistent, which apply across cluster restarts, or transient, which reset after a cluster restart. You can also reset transient or persistent settings by assigning them a null value. If you configure the same setting using multiple methods, Elasticsearch applies the settings in following order of precedence: 1) Transient setting; 2) Persistent setting; 3) `elasticsearch.yml` setting; 4) Default setting value. For example, you can apply a transient setting to override a persistent setting or `elasticsearch.yml` setting. However, a change to an `elasticsearch.yml` setting will not override a defined transient or persistent setting. TIP: In Elastic Cloud, use the user settings feature to configure all cluster settings. This method automatically rejects unsafe settings that could break your cluster. If you run Elasticsearch on your own hardware, use this API to configure dynamic cluster settings. Only use `elasticsearch.yml` for static cluster settings and node settings. The API doesn’t require a restart and ensures a setting’s value is the same on all nodes. WARNING: Transient cluster settings are no longer recommended. Use persistent cluster settings instead. If a cluster becomes unstable, transient settings can clear unexpectedly, resulting in a potentially undesired cluster configuration. || `putSettings` | `putSettings(this: [That](./That.md), params?: [ClusterPutSettingsRequest](./ClusterPutSettingsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ClusterPutSettingsResponse](./ClusterPutSettingsResponse.md), unknown>>;` |   || `putSettings` | `putSettings(this: [That](./That.md), params?: [ClusterPutSettingsRequest](./ClusterPutSettingsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ClusterPutSettingsResponse](./ClusterPutSettingsResponse.md)>;` |   || `remoteInfo` | `remoteInfo(this: [That](./That.md), params?: [ClusterRemoteInfoRequest](./ClusterRemoteInfoRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ClusterRemoteInfoResponse](./ClusterRemoteInfoResponse.md)>;` | Get remote cluster information. Get information about configured remote clusters. The API returns connection and endpoint information keyed by the configured remote cluster alias. > info > This API returns information that reflects current state on the local cluster. > The `connected` field does not necessarily reflect whether a remote cluster is down or unavailable, only whether there is currently an open connection to it. > Elasticsearch does not spontaneously try to reconnect to a disconnected remote cluster. > To trigger a reconnection, attempt a cross-cluster search, ES|QL cross-cluster search, or try the [resolve cluster endpoint](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-resolve-cluster). || `remoteInfo` | `remoteInfo(this: [That](./That.md), params?: [ClusterRemoteInfoRequest](./ClusterRemoteInfoRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ClusterRemoteInfoResponse](./ClusterRemoteInfoResponse.md), unknown>>;` |   || `remoteInfo` | `remoteInfo(this: [That](./That.md), params?: [ClusterRemoteInfoRequest](./ClusterRemoteInfoRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ClusterRemoteInfoResponse](./ClusterRemoteInfoResponse.md)>;` |   || `reroute` | `reroute(this: [That](./That.md), params?: [ClusterRerouteRequest](./ClusterRerouteRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ClusterRerouteResponse](./ClusterRerouteResponse.md)>;` | Reroute the cluster. Manually change the allocation of individual shards in the cluster. For example, a shard can be moved from one node to another explicitly, an allocation can be canceled, and an unassigned shard can be explicitly allocated to a specific node. It is important to note that after processing any reroute commands Elasticsearch will perform rebalancing as normal (respecting the values of settings such as `cluster.routing.rebalance.enable`) in order to remain in a balanced state. For example, if the requested allocation includes moving a shard from node1 to node2 then this may cause a shard to be moved from node2 back to node1 to even things out. The cluster can be set to disable allocations using the `cluster.routing.allocation.enable` setting. If allocations are disabled then the only allocations that will be performed are explicit ones given using the reroute command, and consequent allocations due to rebalancing. The cluster will attempt to allocate a shard a maximum of `index.allocation.max_retries` times in a row (defaults to `5`), before giving up and leaving the shard unallocated. This scenario can be caused by structural problems such as having an analyzer which refers to a stopwords file which doesn’t exist on all nodes. Once the problem has been corrected, allocation can be manually retried by calling the reroute API with the `?retry_failed` URI query parameter, which will attempt a single retry round for these shards. || `reroute` | `reroute(this: [That](./That.md), params?: [ClusterRerouteRequest](./ClusterRerouteRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ClusterRerouteResponse](./ClusterRerouteResponse.md), unknown>>;` |   || `reroute` | `reroute(this: [That](./That.md), params?: [ClusterRerouteRequest](./ClusterRerouteRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ClusterRerouteResponse](./ClusterRerouteResponse.md)>;` |   || `state` | `state(this: [That](./That.md), params?: [ClusterStateRequest](./ClusterStateRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ClusterStateResponse](./ClusterStateResponse.md)>;` | Get the cluster state. Get comprehensive information about the state of the cluster. The cluster state is an internal data structure which keeps track of a variety of information needed by every node, including the identity and attributes of the other nodes in the cluster; cluster-wide settings; index metadata, including the mapping and settings for each index; the location and status of every shard copy in the cluster. The elected master node ensures that every node in the cluster has a copy of the same cluster state. This API lets you retrieve a representation of this internal state for debugging or diagnostic purposes. You may need to consult the Elasticsearch source code to determine the precise meaning of the response. By default the API will route requests to the elected master node since this node is the authoritative source of cluster states. You can also retrieve the cluster state held on the node handling the API request by adding the `?local=true` query parameter. Elasticsearch may need to expend significant effort to compute a response to this API in larger clusters, and the response may comprise a very large quantity of data. If you use this API repeatedly, your cluster may become unstable. WARNING: The response is a representation of an internal data structure. Its format is not subject to the same compatibility guarantees as other more stable APIs and may change from version to version. Do not query this API using external monitoring tools. Instead, obtain the information you require using other more stable cluster APIs. || `state` | `state(this: [That](./That.md), params?: [ClusterStateRequest](./ClusterStateRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ClusterStateResponse](./ClusterStateResponse.md), unknown>>;` |   || `state` | `state(this: [That](./That.md), params?: [ClusterStateRequest](./ClusterStateRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ClusterStateResponse](./ClusterStateResponse.md)>;` |   || `stats` | `stats(this: [That](./That.md), params?: [ClusterStatsRequest](./ClusterStatsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ClusterStatsResponse](./ClusterStatsResponse.md)>;` | Get cluster statistics. Get basic index metrics (shard numbers, store size, memory usage) and information about the current nodes that form the cluster (number, roles, os, jvm versions, memory usage, cpu and installed plugins). || `stats` | `stats(this: [That](./That.md), params?: [ClusterStatsRequest](./ClusterStatsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ClusterStatsResponse](./ClusterStatsResponse.md), unknown>>;` |   || `stats` | `stats(this: [That](./That.md), params?: [ClusterStatsRequest](./ClusterStatsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ClusterStatsResponse](./ClusterStatsResponse.md)>;` |   | \ No newline at end of file +| `allocationExplain` | `allocationExplain(this: [That](./That.md), params?: [ClusterAllocationExplainRequest](./ClusterAllocationExplainRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ClusterAllocationExplainResponse](./ClusterAllocationExplainResponse.md)>;` | Explain the shard allocations. Get explanations for shard allocations in the cluster. For unassigned shards, it provides an explanation for why the shard is unassigned. For assigned shards, it provides an explanation for why the shard is remaining on its current node and has not moved or rebalanced to another node. This API can be very useful when attempting to diagnose why a shard is unassigned or why a shard continues to remain on its current node when you might expect otherwise. | +| `allocationExplain` | `allocationExplain(this: [That](./That.md), params?: [ClusterAllocationExplainRequest](./ClusterAllocationExplainRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ClusterAllocationExplainResponse](./ClusterAllocationExplainResponse.md), unknown>>;` |   | +| `allocationExplain` | `allocationExplain(this: [That](./That.md), params?: [ClusterAllocationExplainRequest](./ClusterAllocationExplainRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ClusterAllocationExplainResponse](./ClusterAllocationExplainResponse.md)>;` |   | +| `deleteComponentTemplate` | `deleteComponentTemplate(this: [That](./That.md), params: [ClusterDeleteComponentTemplateRequest](./ClusterDeleteComponentTemplateRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ClusterDeleteComponentTemplateResponse](./ClusterDeleteComponentTemplateResponse.md)>;` | Delete component templates. Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. | +| `deleteComponentTemplate` | `deleteComponentTemplate(this: [That](./That.md), params: [ClusterDeleteComponentTemplateRequest](./ClusterDeleteComponentTemplateRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ClusterDeleteComponentTemplateResponse](./ClusterDeleteComponentTemplateResponse.md), unknown>>;` |   | +| `deleteComponentTemplate` | `deleteComponentTemplate(this: [That](./That.md), params: [ClusterDeleteComponentTemplateRequest](./ClusterDeleteComponentTemplateRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ClusterDeleteComponentTemplateResponse](./ClusterDeleteComponentTemplateResponse.md)>;` |   | +| `deleteVotingConfigExclusions` | `deleteVotingConfigExclusions(this: [That](./That.md), params?: [ClusterDeleteVotingConfigExclusionsRequest](./ClusterDeleteVotingConfigExclusionsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ClusterDeleteVotingConfigExclusionsResponse](./ClusterDeleteVotingConfigExclusionsResponse.md)>;` | Clear cluster voting config exclusions. Remove master-eligible nodes from the voting configuration exclusion list. | +| `deleteVotingConfigExclusions` | `deleteVotingConfigExclusions(this: [That](./That.md), params?: [ClusterDeleteVotingConfigExclusionsRequest](./ClusterDeleteVotingConfigExclusionsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ClusterDeleteVotingConfigExclusionsResponse](./ClusterDeleteVotingConfigExclusionsResponse.md), unknown>>;` |   | +| `deleteVotingConfigExclusions` | `deleteVotingConfigExclusions(this: [That](./That.md), params?: [ClusterDeleteVotingConfigExclusionsRequest](./ClusterDeleteVotingConfigExclusionsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ClusterDeleteVotingConfigExclusionsResponse](./ClusterDeleteVotingConfigExclusionsResponse.md)>;` |   | +| `existsComponentTemplate` | `existsComponentTemplate(this: [That](./That.md), params: [ClusterExistsComponentTemplateRequest](./ClusterExistsComponentTemplateRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ClusterExistsComponentTemplateResponse](./ClusterExistsComponentTemplateResponse.md)>;` | Check component templates. Returns information about whether a particular component template exists. | +| `existsComponentTemplate` | `existsComponentTemplate(this: [That](./That.md), params: [ClusterExistsComponentTemplateRequest](./ClusterExistsComponentTemplateRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ClusterExistsComponentTemplateResponse](./ClusterExistsComponentTemplateResponse.md), unknown>>;` |   | +| `existsComponentTemplate` | `existsComponentTemplate(this: [That](./That.md), params: [ClusterExistsComponentTemplateRequest](./ClusterExistsComponentTemplateRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ClusterExistsComponentTemplateResponse](./ClusterExistsComponentTemplateResponse.md)>;` |   | +| `getComponentTemplate` | `getComponentTemplate(this: [That](./That.md), params?: [ClusterGetComponentTemplateRequest](./ClusterGetComponentTemplateRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ClusterGetComponentTemplateResponse](./ClusterGetComponentTemplateResponse.md)>;` | Get component templates. Get information about component templates. | +| `getComponentTemplate` | `getComponentTemplate(this: [That](./That.md), params?: [ClusterGetComponentTemplateRequest](./ClusterGetComponentTemplateRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ClusterGetComponentTemplateResponse](./ClusterGetComponentTemplateResponse.md), unknown>>;` |   | +| `getComponentTemplate` | `getComponentTemplate(this: [That](./That.md), params?: [ClusterGetComponentTemplateRequest](./ClusterGetComponentTemplateRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ClusterGetComponentTemplateResponse](./ClusterGetComponentTemplateResponse.md)>;` |   | +| `getSettings` | `getSettings(this: [That](./That.md), params?: [ClusterGetSettingsRequest](./ClusterGetSettingsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ClusterGetSettingsResponse](./ClusterGetSettingsResponse.md)>;` | Get cluster-wide settings. By default, it returns only settings that have been explicitly defined. | +| `getSettings` | `getSettings(this: [That](./That.md), params?: [ClusterGetSettingsRequest](./ClusterGetSettingsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ClusterGetSettingsResponse](./ClusterGetSettingsResponse.md), unknown>>;` |   | +| `getSettings` | `getSettings(this: [That](./That.md), params?: [ClusterGetSettingsRequest](./ClusterGetSettingsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ClusterGetSettingsResponse](./ClusterGetSettingsResponse.md)>;` |   | +| `health` | `health(this: [That](./That.md), params?: [ClusterHealthRequest](./ClusterHealthRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ClusterHealthResponse](./ClusterHealthResponse.md)>;` | Get the cluster health status. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices. The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster. Yellow means that the primary shard is allocated but replicas are not. Green means that all shards are allocated. The index level status is controlled by the worst shard status. One of the main benefits of the API is the ability to wait until the cluster reaches a certain high watermark health level. The cluster status is controlled by the worst index status. | +| `health` | `health(this: [That](./That.md), params?: [ClusterHealthRequest](./ClusterHealthRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ClusterHealthResponse](./ClusterHealthResponse.md), unknown>>;` |   | +| `health` | `health(this: [That](./That.md), params?: [ClusterHealthRequest](./ClusterHealthRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ClusterHealthResponse](./ClusterHealthResponse.md)>;` |   | +| `info` | `info(this: [That](./That.md), params: [ClusterInfoRequest](./ClusterInfoRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ClusterInfoResponse](./ClusterInfoResponse.md)>;` | Get cluster info. Returns basic information about the cluster. | +| `info` | `info(this: [That](./That.md), params: [ClusterInfoRequest](./ClusterInfoRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ClusterInfoResponse](./ClusterInfoResponse.md), unknown>>;` |   | +| `info` | `info(this: [That](./That.md), params: [ClusterInfoRequest](./ClusterInfoRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ClusterInfoResponse](./ClusterInfoResponse.md)>;` |   | +| `pendingTasks` | `pendingTasks(this: [That](./That.md), params?: [ClusterPendingTasksRequest](./ClusterPendingTasksRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ClusterPendingTasksResponse](./ClusterPendingTasksResponse.md)>;` | Get the pending cluster tasks. Get information about cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet taken effect. NOTE: This API returns a list of any pending updates to the cluster state. These are distinct from the tasks reported by the task management API which include periodic tasks and tasks initiated by the user, such as node stats, search queries, or create index requests. However, if a user-initiated task such as a create index command causes a cluster state update, the activity of this task might be reported by both task api and pending cluster tasks API. | +| `pendingTasks` | `pendingTasks(this: [That](./That.md), params?: [ClusterPendingTasksRequest](./ClusterPendingTasksRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ClusterPendingTasksResponse](./ClusterPendingTasksResponse.md), unknown>>;` |   | +| `pendingTasks` | `pendingTasks(this: [That](./That.md), params?: [ClusterPendingTasksRequest](./ClusterPendingTasksRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ClusterPendingTasksResponse](./ClusterPendingTasksResponse.md)>;` |   | +| `postVotingConfigExclusions` | `postVotingConfigExclusions(this: [That](./That.md), params?: [ClusterPostVotingConfigExclusionsRequest](./ClusterPostVotingConfigExclusionsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ClusterPostVotingConfigExclusionsResponse](./ClusterPostVotingConfigExclusionsResponse.md)>;` | Update voting configuration exclusions. Update the cluster voting config exclusions by node IDs or node names. By default, if there are more than three master-eligible nodes in the cluster and you remove fewer than half of the master-eligible nodes in the cluster at once, the voting configuration automatically shrinks. If you want to shrink the voting configuration to contain fewer than three nodes or to remove half or more of the master-eligible nodes in the cluster at once, use this API to remove departing nodes from the voting configuration manually. The API adds an entry for each specified node to the cluster’s voting configuration exclusions list. It then waits until the cluster has reconfigured its voting configuration to exclude the specified nodes. Clusters should have no voting configuration exclusions in normal operation. Once the excluded nodes have stopped, clear the voting configuration exclusions with `DELETE /_cluster/voting_config_exclusions`. This API waits for the nodes to be fully removed from the cluster before it returns. If your cluster has voting configuration exclusions for nodes that you no longer intend to remove, use `DELETE /_cluster/voting_config_exclusions?wait_for_removal=false` to clear the voting configuration exclusions without waiting for the nodes to leave the cluster. A response to `POST /_cluster/voting_config_exclusions` with an HTTP status code of 200 OK guarantees that the node has been removed from the voting configuration and will not be reinstated until the voting configuration exclusions are cleared by calling `DELETE /_cluster/voting_config_exclusions`. If the call to `POST /_cluster/voting_config_exclusions` fails or returns a response with an HTTP status code other than 200 OK then the node may not have been removed from the voting configuration. In that case, you may safely retry the call. NOTE: Voting exclusions are required only when you remove at least half of the master-eligible nodes from a cluster in a short time period. They are not required when removing master-ineligible nodes or when removing fewer than half of the master-eligible nodes. | +| `postVotingConfigExclusions` | `postVotingConfigExclusions(this: [That](./That.md), params?: [ClusterPostVotingConfigExclusionsRequest](./ClusterPostVotingConfigExclusionsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ClusterPostVotingConfigExclusionsResponse](./ClusterPostVotingConfigExclusionsResponse.md), unknown>>;` |   | +| `postVotingConfigExclusions` | `postVotingConfigExclusions(this: [That](./That.md), params?: [ClusterPostVotingConfigExclusionsRequest](./ClusterPostVotingConfigExclusionsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ClusterPostVotingConfigExclusionsResponse](./ClusterPostVotingConfigExclusionsResponse.md)>;` |   | +| `putComponentTemplate` | `putComponentTemplate(this: [That](./That.md), params: [ClusterPutComponentTemplateRequest](./ClusterPutComponentTemplateRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ClusterPutComponentTemplateResponse](./ClusterPutComponentTemplateResponse.md)>;` | Create or update a component template. Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. An index template can be composed of multiple component templates. To use a component template, specify it in an index template’s `composed_of` list. Component templates are only applied to new data streams and indices as part of a matching index template. Settings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template. Component templates are only used during index creation. For data streams, this includes data stream creation and the creation of a stream’s backing indices. Changes to component templates do not affect existing indices, including a stream’s backing indices. You can use C-style `/* *\/` block comments in component templates. You can include comments anywhere in the request body except before the opening curly bracket. **Applying component templates** You cannot directly apply a component template to a data stream or index. To be applied, a component template must be included in an index template's `composed_of` list. | +| `putComponentTemplate` | `putComponentTemplate(this: [That](./That.md), params: [ClusterPutComponentTemplateRequest](./ClusterPutComponentTemplateRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ClusterPutComponentTemplateResponse](./ClusterPutComponentTemplateResponse.md), unknown>>;` |   | +| `putComponentTemplate` | `putComponentTemplate(this: [That](./That.md), params: [ClusterPutComponentTemplateRequest](./ClusterPutComponentTemplateRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ClusterPutComponentTemplateResponse](./ClusterPutComponentTemplateResponse.md)>;` |   | +| `putSettings` | `putSettings(this: [That](./That.md), params?: [ClusterPutSettingsRequest](./ClusterPutSettingsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ClusterPutSettingsResponse](./ClusterPutSettingsResponse.md)>;` | Update the cluster settings. Configure and update dynamic settings on a running cluster. You can also configure dynamic settings locally on an unstarted or shut down node in `elasticsearch.yml`. Updates made with this API can be persistent, which apply across cluster restarts, or transient, which reset after a cluster restart. You can also reset transient or persistent settings by assigning them a null value. If you configure the same setting using multiple methods, Elasticsearch applies the settings in following order of precedence: 1) Transient setting; 2) Persistent setting; 3) `elasticsearch.yml` setting; 4) Default setting value. For example, you can apply a transient setting to override a persistent setting or `elasticsearch.yml` setting. However, a change to an `elasticsearch.yml` setting will not override a defined transient or persistent setting. TIP: In Elastic Cloud, use the user settings feature to configure all cluster settings. This method automatically rejects unsafe settings that could break your cluster. If you run Elasticsearch on your own hardware, use this API to configure dynamic cluster settings. Only use `elasticsearch.yml` for static cluster settings and node settings. The API doesn’t require a restart and ensures a setting’s value is the same on all nodes. WARNING: Transient cluster settings are no longer recommended. Use persistent cluster settings instead. If a cluster becomes unstable, transient settings can clear unexpectedly, resulting in a potentially undesired cluster configuration. | +| `putSettings` | `putSettings(this: [That](./That.md), params?: [ClusterPutSettingsRequest](./ClusterPutSettingsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ClusterPutSettingsResponse](./ClusterPutSettingsResponse.md), unknown>>;` |   | +| `putSettings` | `putSettings(this: [That](./That.md), params?: [ClusterPutSettingsRequest](./ClusterPutSettingsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ClusterPutSettingsResponse](./ClusterPutSettingsResponse.md)>;` |   | +| `remoteInfo` | `remoteInfo(this: [That](./That.md), params?: [ClusterRemoteInfoRequest](./ClusterRemoteInfoRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ClusterRemoteInfoResponse](./ClusterRemoteInfoResponse.md)>;` | Get remote cluster information. Get information about configured remote clusters. The API returns connection and endpoint information keyed by the configured remote cluster alias. > info > This API returns information that reflects current state on the local cluster. > The `connected` field does not necessarily reflect whether a remote cluster is down or unavailable, only whether there is currently an open connection to it. > Elasticsearch does not spontaneously try to reconnect to a disconnected remote cluster. > To trigger a reconnection, attempt a cross-cluster search, ES|QL cross-cluster search, or try the [resolve cluster endpoint](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-resolve-cluster). | +| `remoteInfo` | `remoteInfo(this: [That](./That.md), params?: [ClusterRemoteInfoRequest](./ClusterRemoteInfoRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ClusterRemoteInfoResponse](./ClusterRemoteInfoResponse.md), unknown>>;` |   | +| `remoteInfo` | `remoteInfo(this: [That](./That.md), params?: [ClusterRemoteInfoRequest](./ClusterRemoteInfoRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ClusterRemoteInfoResponse](./ClusterRemoteInfoResponse.md)>;` |   | +| `reroute` | `reroute(this: [That](./That.md), params?: [ClusterRerouteRequest](./ClusterRerouteRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ClusterRerouteResponse](./ClusterRerouteResponse.md)>;` | Reroute the cluster. Manually change the allocation of individual shards in the cluster. For example, a shard can be moved from one node to another explicitly, an allocation can be canceled, and an unassigned shard can be explicitly allocated to a specific node. It is important to note that after processing any reroute commands Elasticsearch will perform rebalancing as normal (respecting the values of settings such as `cluster.routing.rebalance.enable`) in order to remain in a balanced state. For example, if the requested allocation includes moving a shard from node1 to node2 then this may cause a shard to be moved from node2 back to node1 to even things out. The cluster can be set to disable allocations using the `cluster.routing.allocation.enable` setting. If allocations are disabled then the only allocations that will be performed are explicit ones given using the reroute command, and consequent allocations due to rebalancing. The cluster will attempt to allocate a shard a maximum of `index.allocation.max_retries` times in a row (defaults to `5`), before giving up and leaving the shard unallocated. This scenario can be caused by structural problems such as having an analyzer which refers to a stopwords file which doesn’t exist on all nodes. Once the problem has been corrected, allocation can be manually retried by calling the reroute API with the `?retry_failed` URI query parameter, which will attempt a single retry round for these shards. | +| `reroute` | `reroute(this: [That](./That.md), params?: [ClusterRerouteRequest](./ClusterRerouteRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ClusterRerouteResponse](./ClusterRerouteResponse.md), unknown>>;` |   | +| `reroute` | `reroute(this: [That](./That.md), params?: [ClusterRerouteRequest](./ClusterRerouteRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ClusterRerouteResponse](./ClusterRerouteResponse.md)>;` |   | +| `state` | `state(this: [That](./That.md), params?: [ClusterStateRequest](./ClusterStateRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ClusterStateResponse](./ClusterStateResponse.md)>;` | Get the cluster state. Get comprehensive information about the state of the cluster. The cluster state is an internal data structure which keeps track of a variety of information needed by every node, including the identity and attributes of the other nodes in the cluster; cluster-wide settings; index metadata, including the mapping and settings for each index; the location and status of every shard copy in the cluster. The elected master node ensures that every node in the cluster has a copy of the same cluster state. This API lets you retrieve a representation of this internal state for debugging or diagnostic purposes. You may need to consult the Elasticsearch source code to determine the precise meaning of the response. By default the API will route requests to the elected master node since this node is the authoritative source of cluster states. You can also retrieve the cluster state held on the node handling the API request by adding the `?local=true` query parameter. Elasticsearch may need to expend significant effort to compute a response to this API in larger clusters, and the response may comprise a very large quantity of data. If you use this API repeatedly, your cluster may become unstable. WARNING: The response is a representation of an internal data structure. Its format is not subject to the same compatibility guarantees as other more stable APIs and may change from version to version. Do not query this API using external monitoring tools. Instead, obtain the information you require using other more stable cluster APIs. | +| `state` | `state(this: [That](./That.md), params?: [ClusterStateRequest](./ClusterStateRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ClusterStateResponse](./ClusterStateResponse.md), unknown>>;` |   | +| `state` | `state(this: [That](./That.md), params?: [ClusterStateRequest](./ClusterStateRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ClusterStateResponse](./ClusterStateResponse.md)>;` |   | +| `stats` | `stats(this: [That](./That.md), params?: [ClusterStatsRequest](./ClusterStatsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ClusterStatsResponse](./ClusterStatsResponse.md)>;` | Get cluster statistics. Get basic index metrics (shard numbers, store size, memory usage) and information about the current nodes that form the cluster (number, roles, os, jvm versions, memory usage, cpu and installed plugins). | +| `stats` | `stats(this: [That](./That.md), params?: [ClusterStatsRequest](./ClusterStatsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ClusterStatsResponse](./ClusterStatsResponse.md), unknown>>;` |   | +| `stats` | `stats(this: [That](./That.md), params?: [ClusterStatsRequest](./ClusterStatsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ClusterStatsResponse](./ClusterStatsResponse.md)>;` |   | diff --git a/docs/reference/api/Connector.md b/docs/reference/api/Connector.md index 07777ae5c..38fce3450 100644 --- a/docs/reference/api/Connector.md +++ b/docs/reference/api/Connector.md @@ -17,4 +17,105 @@ new Connector(transport: [Transport](./Transport.md)); | Name | Signature | Description | | - | - | - | -| `checkIn` | `checkIn(this: [That](./That.md), params: [ConnectorCheckInRequest](./ConnectorCheckInRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorCheckInResponse](./ConnectorCheckInResponse.md)>;` | Check in a connector. Update the `last_seen` field in the connector and set it to the current timestamp. || `checkIn` | `checkIn(this: [That](./That.md), params: [ConnectorCheckInRequest](./ConnectorCheckInRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorCheckInResponse](./ConnectorCheckInResponse.md), unknown>>;` |   || `checkIn` | `checkIn(this: [That](./That.md), params: [ConnectorCheckInRequest](./ConnectorCheckInRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorCheckInResponse](./ConnectorCheckInResponse.md)>;` |   || `delete` | `delete(this: [That](./That.md), params: [ConnectorDeleteRequest](./ConnectorDeleteRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorDeleteResponse](./ConnectorDeleteResponse.md)>;` | Delete a connector. Removes a connector and associated sync jobs. This is a destructive action that is not recoverable. NOTE: This action doesn’t delete any API keys, ingest pipelines, or data indices associated with the connector. These need to be removed manually. || `delete` | `delete(this: [That](./That.md), params: [ConnectorDeleteRequest](./ConnectorDeleteRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorDeleteResponse](./ConnectorDeleteResponse.md), unknown>>;` |   || `delete` | `delete(this: [That](./That.md), params: [ConnectorDeleteRequest](./ConnectorDeleteRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorDeleteResponse](./ConnectorDeleteResponse.md)>;` |   || `get` | `get(this: [That](./That.md), params: [ConnectorGetRequest](./ConnectorGetRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorGetResponse](./ConnectorGetResponse.md)>;` | Get a connector. Get the details about a connector. || `get` | `get(this: [That](./That.md), params: [ConnectorGetRequest](./ConnectorGetRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorGetResponse](./ConnectorGetResponse.md), unknown>>;` |   || `get` | `get(this: [That](./That.md), params: [ConnectorGetRequest](./ConnectorGetRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorGetResponse](./ConnectorGetResponse.md)>;` |   || `lastSync` | `lastSync(this: [That](./That.md), params: [ConnectorLastSyncRequest](./ConnectorLastSyncRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorLastSyncResponse](./ConnectorLastSyncResponse.md)>;` | Update the connector last sync stats. Update the fields related to the last sync of a connector. This action is used for analytics and monitoring. || `lastSync` | `lastSync(this: [That](./That.md), params: [ConnectorLastSyncRequest](./ConnectorLastSyncRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorLastSyncResponse](./ConnectorLastSyncResponse.md), unknown>>;` |   || `lastSync` | `lastSync(this: [That](./That.md), params: [ConnectorLastSyncRequest](./ConnectorLastSyncRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorLastSyncResponse](./ConnectorLastSyncResponse.md)>;` |   || `list` | `list(this: [That](./That.md), params?: [ConnectorListRequest](./ConnectorListRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorListResponse](./ConnectorListResponse.md)>;` | Get all connectors. Get information about all connectors. || `list` | `list(this: [That](./That.md), params?: [ConnectorListRequest](./ConnectorListRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorListResponse](./ConnectorListResponse.md), unknown>>;` |   || `list` | `list(this: [That](./That.md), params?: [ConnectorListRequest](./ConnectorListRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorListResponse](./ConnectorListResponse.md)>;` |   || `post` | `post(this: [That](./That.md), params?: [ConnectorPostRequest](./ConnectorPostRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorPostResponse](./ConnectorPostResponse.md)>;` | Create a connector. Connectors are Elasticsearch integrations that bring content from third-party data sources, which can be deployed on Elastic Cloud or hosted on your own infrastructure. Elastic managed connectors (Native connectors) are a managed service on Elastic Cloud. Self-managed connectors (Connector clients) are self-managed on your infrastructure. || `post` | `post(this: [That](./That.md), params?: [ConnectorPostRequest](./ConnectorPostRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorPostResponse](./ConnectorPostResponse.md), unknown>>;` |   || `post` | `post(this: [That](./That.md), params?: [ConnectorPostRequest](./ConnectorPostRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorPostResponse](./ConnectorPostResponse.md)>;` |   || `put` | `put(this: [That](./That.md), params?: [ConnectorPutRequest](./ConnectorPutRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorPutResponse](./ConnectorPutResponse.md)>;` | Create or update a connector. || `put` | `put(this: [That](./That.md), params?: [ConnectorPutRequest](./ConnectorPutRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorPutResponse](./ConnectorPutResponse.md), unknown>>;` |   || `put` | `put(this: [That](./That.md), params?: [ConnectorPutRequest](./ConnectorPutRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorPutResponse](./ConnectorPutResponse.md)>;` |   || `secretDelete` | `secretDelete(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TODO](./TODO.md)>;` | Deletes a connector secret. || `secretDelete` | `secretDelete(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TODO](./TODO.md), unknown>>;` |   || `secretDelete` | `secretDelete(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TODO](./TODO.md)>;` |   || `secretGet` | `secretGet(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TODO](./TODO.md)>;` | Retrieves a secret stored by Connectors. || `secretGet` | `secretGet(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TODO](./TODO.md), unknown>>;` |   || `secretGet` | `secretGet(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TODO](./TODO.md)>;` |   || `secretPost` | `secretPost(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TODO](./TODO.md)>;` | Creates a secret for a Connector. || `secretPost` | `secretPost(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TODO](./TODO.md), unknown>>;` |   || `secretPost` | `secretPost(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TODO](./TODO.md)>;` |   || `secretPut` | `secretPut(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TODO](./TODO.md)>;` | Creates or updates a secret for a Connector. || `secretPut` | `secretPut(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TODO](./TODO.md), unknown>>;` |   || `secretPut` | `secretPut(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TODO](./TODO.md)>;` |   || `syncJobCancel` | `syncJobCancel(this: [That](./That.md), params: [ConnectorSyncJobCancelRequest](./ConnectorSyncJobCancelRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorSyncJobCancelResponse](./ConnectorSyncJobCancelResponse.md)>;` | Cancel a connector sync job. Cancel a connector sync job, which sets the status to cancelling and updates `cancellation_requested_at` to the current time. The connector service is then responsible for setting the status of connector sync jobs to cancelled. || `syncJobCancel` | `syncJobCancel(this: [That](./That.md), params: [ConnectorSyncJobCancelRequest](./ConnectorSyncJobCancelRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorSyncJobCancelResponse](./ConnectorSyncJobCancelResponse.md), unknown>>;` |   || `syncJobCancel` | `syncJobCancel(this: [That](./That.md), params: [ConnectorSyncJobCancelRequest](./ConnectorSyncJobCancelRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorSyncJobCancelResponse](./ConnectorSyncJobCancelResponse.md)>;` |   || `syncJobCheckIn` | `syncJobCheckIn(this: [That](./That.md), params: [ConnectorSyncJobCheckInRequest](./ConnectorSyncJobCheckInRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorSyncJobCheckInResponse](./ConnectorSyncJobCheckInResponse.md)>;` | Check in a connector sync job. Check in a connector sync job and set the `last_seen` field to the current time before updating it in the internal index. To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure. This service runs automatically on Elastic Cloud for Elastic managed connectors. || `syncJobCheckIn` | `syncJobCheckIn(this: [That](./That.md), params: [ConnectorSyncJobCheckInRequest](./ConnectorSyncJobCheckInRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorSyncJobCheckInResponse](./ConnectorSyncJobCheckInResponse.md), unknown>>;` |   || `syncJobCheckIn` | `syncJobCheckIn(this: [That](./That.md), params: [ConnectorSyncJobCheckInRequest](./ConnectorSyncJobCheckInRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorSyncJobCheckInResponse](./ConnectorSyncJobCheckInResponse.md)>;` |   || `syncJobClaim` | `syncJobClaim(this: [That](./That.md), params: [ConnectorSyncJobClaimRequest](./ConnectorSyncJobClaimRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorSyncJobClaimResponse](./ConnectorSyncJobClaimResponse.md)>;` | Claim a connector sync job. This action updates the job status to `in_progress` and sets the `last_seen` and `started_at` timestamps to the current time. Additionally, it can set the `sync_cursor` property for the sync job. This API is not intended for direct connector management by users. It supports the implementation of services that utilize the connector protocol to communicate with Elasticsearch. To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure. This service runs automatically on Elastic Cloud for Elastic managed connectors. || `syncJobClaim` | `syncJobClaim(this: [That](./That.md), params: [ConnectorSyncJobClaimRequest](./ConnectorSyncJobClaimRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorSyncJobClaimResponse](./ConnectorSyncJobClaimResponse.md), unknown>>;` |   || `syncJobClaim` | `syncJobClaim(this: [That](./That.md), params: [ConnectorSyncJobClaimRequest](./ConnectorSyncJobClaimRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorSyncJobClaimResponse](./ConnectorSyncJobClaimResponse.md)>;` |   || `syncJobDelete` | `syncJobDelete(this: [That](./That.md), params: [ConnectorSyncJobDeleteRequest](./ConnectorSyncJobDeleteRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorSyncJobDeleteResponse](./ConnectorSyncJobDeleteResponse.md)>;` | Delete a connector sync job. Remove a connector sync job and its associated data. This is a destructive action that is not recoverable. || `syncJobDelete` | `syncJobDelete(this: [That](./That.md), params: [ConnectorSyncJobDeleteRequest](./ConnectorSyncJobDeleteRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorSyncJobDeleteResponse](./ConnectorSyncJobDeleteResponse.md), unknown>>;` |   || `syncJobDelete` | `syncJobDelete(this: [That](./That.md), params: [ConnectorSyncJobDeleteRequest](./ConnectorSyncJobDeleteRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorSyncJobDeleteResponse](./ConnectorSyncJobDeleteResponse.md)>;` |   || `syncJobError` | `syncJobError(this: [That](./That.md), params: [ConnectorSyncJobErrorRequest](./ConnectorSyncJobErrorRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorSyncJobErrorResponse](./ConnectorSyncJobErrorResponse.md)>;` | Set a connector sync job error. Set the `error` field for a connector sync job and set its `status` to `error`. To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure. This service runs automatically on Elastic Cloud for Elastic managed connectors. || `syncJobError` | `syncJobError(this: [That](./That.md), params: [ConnectorSyncJobErrorRequest](./ConnectorSyncJobErrorRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorSyncJobErrorResponse](./ConnectorSyncJobErrorResponse.md), unknown>>;` |   || `syncJobError` | `syncJobError(this: [That](./That.md), params: [ConnectorSyncJobErrorRequest](./ConnectorSyncJobErrorRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorSyncJobErrorResponse](./ConnectorSyncJobErrorResponse.md)>;` |   || `syncJobGet` | `syncJobGet(this: [That](./That.md), params: [ConnectorSyncJobGetRequest](./ConnectorSyncJobGetRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorSyncJobGetResponse](./ConnectorSyncJobGetResponse.md)>;` | Get a connector sync job. || `syncJobGet` | `syncJobGet(this: [That](./That.md), params: [ConnectorSyncJobGetRequest](./ConnectorSyncJobGetRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorSyncJobGetResponse](./ConnectorSyncJobGetResponse.md), unknown>>;` |   || `syncJobGet` | `syncJobGet(this: [That](./That.md), params: [ConnectorSyncJobGetRequest](./ConnectorSyncJobGetRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorSyncJobGetResponse](./ConnectorSyncJobGetResponse.md)>;` |   || `syncJobList` | `syncJobList(this: [That](./That.md), params?: [ConnectorSyncJobListRequest](./ConnectorSyncJobListRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorSyncJobListResponse](./ConnectorSyncJobListResponse.md)>;` | Get all connector sync jobs. Get information about all stored connector sync jobs listed by their creation date in ascending order. || `syncJobList` | `syncJobList(this: [That](./That.md), params?: [ConnectorSyncJobListRequest](./ConnectorSyncJobListRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorSyncJobListResponse](./ConnectorSyncJobListResponse.md), unknown>>;` |   || `syncJobList` | `syncJobList(this: [That](./That.md), params?: [ConnectorSyncJobListRequest](./ConnectorSyncJobListRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorSyncJobListResponse](./ConnectorSyncJobListResponse.md)>;` |   || `syncJobPost` | `syncJobPost(this: [That](./That.md), params: [ConnectorSyncJobPostRequest](./ConnectorSyncJobPostRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorSyncJobPostResponse](./ConnectorSyncJobPostResponse.md)>;` | Create a connector sync job. Create a connector sync job document in the internal index and initialize its counters and timestamps with default values. || `syncJobPost` | `syncJobPost(this: [That](./That.md), params: [ConnectorSyncJobPostRequest](./ConnectorSyncJobPostRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorSyncJobPostResponse](./ConnectorSyncJobPostResponse.md), unknown>>;` |   || `syncJobPost` | `syncJobPost(this: [That](./That.md), params: [ConnectorSyncJobPostRequest](./ConnectorSyncJobPostRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorSyncJobPostResponse](./ConnectorSyncJobPostResponse.md)>;` |   || `syncJobUpdateStats` | `syncJobUpdateStats(this: [That](./That.md), params: [ConnectorSyncJobUpdateStatsRequest](./ConnectorSyncJobUpdateStatsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorSyncJobUpdateStatsResponse](./ConnectorSyncJobUpdateStatsResponse.md)>;` | Set the connector sync job stats. Stats include: `deleted_document_count`, `indexed_document_count`, `indexed_document_volume`, and `total_document_count`. You can also update `last_seen`. This API is mainly used by the connector service for updating sync job information. To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure. This service runs automatically on Elastic Cloud for Elastic managed connectors. || `syncJobUpdateStats` | `syncJobUpdateStats(this: [That](./That.md), params: [ConnectorSyncJobUpdateStatsRequest](./ConnectorSyncJobUpdateStatsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorSyncJobUpdateStatsResponse](./ConnectorSyncJobUpdateStatsResponse.md), unknown>>;` |   || `syncJobUpdateStats` | `syncJobUpdateStats(this: [That](./That.md), params: [ConnectorSyncJobUpdateStatsRequest](./ConnectorSyncJobUpdateStatsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorSyncJobUpdateStatsResponse](./ConnectorSyncJobUpdateStatsResponse.md)>;` |   || `updateActiveFiltering` | `updateActiveFiltering(this: [That](./That.md), params: [ConnectorUpdateActiveFilteringRequest](./ConnectorUpdateActiveFilteringRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorUpdateActiveFilteringResponse](./ConnectorUpdateActiveFilteringResponse.md)>;` | Activate the connector draft filter. Activates the valid draft filtering for a connector. || `updateActiveFiltering` | `updateActiveFiltering(this: [That](./That.md), params: [ConnectorUpdateActiveFilteringRequest](./ConnectorUpdateActiveFilteringRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorUpdateActiveFilteringResponse](./ConnectorUpdateActiveFilteringResponse.md), unknown>>;` |   || `updateActiveFiltering` | `updateActiveFiltering(this: [That](./That.md), params: [ConnectorUpdateActiveFilteringRequest](./ConnectorUpdateActiveFilteringRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorUpdateActiveFilteringResponse](./ConnectorUpdateActiveFilteringResponse.md)>;` |   || `updateApiKeyId` | `updateApiKeyId(this: [That](./That.md), params: [ConnectorUpdateApiKeyIdRequest](./ConnectorUpdateApiKeyIdRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorUpdateApiKeyIdResponse](./ConnectorUpdateApiKeyIdResponse.md)>;` | Update the connector API key ID. Update the `api_key_id` and `api_key_secret_id` fields of a connector. You can specify the ID of the API key used for authorization and the ID of the connector secret where the API key is stored. The connector secret ID is required only for Elastic managed (native) connectors. Self-managed connectors (connector clients) do not use this field. || `updateApiKeyId` | `updateApiKeyId(this: [That](./That.md), params: [ConnectorUpdateApiKeyIdRequest](./ConnectorUpdateApiKeyIdRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorUpdateApiKeyIdResponse](./ConnectorUpdateApiKeyIdResponse.md), unknown>>;` |   || `updateApiKeyId` | `updateApiKeyId(this: [That](./That.md), params: [ConnectorUpdateApiKeyIdRequest](./ConnectorUpdateApiKeyIdRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorUpdateApiKeyIdResponse](./ConnectorUpdateApiKeyIdResponse.md)>;` |   || `updateConfiguration` | `updateConfiguration(this: [That](./That.md), params: [ConnectorUpdateConfigurationRequest](./ConnectorUpdateConfigurationRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorUpdateConfigurationResponse](./ConnectorUpdateConfigurationResponse.md)>;` | Update the connector configuration. Update the configuration field in the connector document. || `updateConfiguration` | `updateConfiguration(this: [That](./That.md), params: [ConnectorUpdateConfigurationRequest](./ConnectorUpdateConfigurationRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorUpdateConfigurationResponse](./ConnectorUpdateConfigurationResponse.md), unknown>>;` |   || `updateConfiguration` | `updateConfiguration(this: [That](./That.md), params: [ConnectorUpdateConfigurationRequest](./ConnectorUpdateConfigurationRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorUpdateConfigurationResponse](./ConnectorUpdateConfigurationResponse.md)>;` |   || `updateError` | `updateError(this: [That](./That.md), params: [ConnectorUpdateErrorRequest](./ConnectorUpdateErrorRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorUpdateErrorResponse](./ConnectorUpdateErrorResponse.md)>;` | Update the connector error field. Set the error field for the connector. If the error provided in the request body is non-null, the connector’s status is updated to error. Otherwise, if the error is reset to null, the connector status is updated to connected. || `updateError` | `updateError(this: [That](./That.md), params: [ConnectorUpdateErrorRequest](./ConnectorUpdateErrorRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorUpdateErrorResponse](./ConnectorUpdateErrorResponse.md), unknown>>;` |   || `updateError` | `updateError(this: [That](./That.md), params: [ConnectorUpdateErrorRequest](./ConnectorUpdateErrorRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorUpdateErrorResponse](./ConnectorUpdateErrorResponse.md)>;` |   || `updateFeatures` | `updateFeatures(this: [That](./That.md), params: [ConnectorUpdateFeaturesRequest](./ConnectorUpdateFeaturesRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorUpdateFeaturesResponse](./ConnectorUpdateFeaturesResponse.md)>;` | Update the connector features. Update the connector features in the connector document. This API can be used to control the following aspects of a connector: * document-level security * incremental syncs * advanced sync rules * basic sync rules Normally, the running connector service automatically manages these features. However, you can use this API to override the default behavior. To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure. This service runs automatically on Elastic Cloud for Elastic managed connectors. || `updateFeatures` | `updateFeatures(this: [That](./That.md), params: [ConnectorUpdateFeaturesRequest](./ConnectorUpdateFeaturesRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorUpdateFeaturesResponse](./ConnectorUpdateFeaturesResponse.md), unknown>>;` |   || `updateFeatures` | `updateFeatures(this: [That](./That.md), params: [ConnectorUpdateFeaturesRequest](./ConnectorUpdateFeaturesRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorUpdateFeaturesResponse](./ConnectorUpdateFeaturesResponse.md)>;` |   || `updateFiltering` | `updateFiltering(this: [That](./That.md), params: [ConnectorUpdateFilteringRequest](./ConnectorUpdateFilteringRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorUpdateFilteringResponse](./ConnectorUpdateFilteringResponse.md)>;` | Update the connector filtering. Update the draft filtering configuration of a connector and marks the draft validation state as edited. The filtering draft is activated once validated by the running Elastic connector service. The filtering property is used to configure sync rules (both basic and advanced) for a connector. || `updateFiltering` | `updateFiltering(this: [That](./That.md), params: [ConnectorUpdateFilteringRequest](./ConnectorUpdateFilteringRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorUpdateFilteringResponse](./ConnectorUpdateFilteringResponse.md), unknown>>;` |   || `updateFiltering` | `updateFiltering(this: [That](./That.md), params: [ConnectorUpdateFilteringRequest](./ConnectorUpdateFilteringRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorUpdateFilteringResponse](./ConnectorUpdateFilteringResponse.md)>;` |   || `updateFilteringValidation` | `updateFilteringValidation(this: [That](./That.md), params: [ConnectorUpdateFilteringValidationRequest](./ConnectorUpdateFilteringValidationRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorUpdateFilteringValidationResponse](./ConnectorUpdateFilteringValidationResponse.md)>;` | Update the connector draft filtering validation. Update the draft filtering validation info for a connector. || `updateFilteringValidation` | `updateFilteringValidation(this: [That](./That.md), params: [ConnectorUpdateFilteringValidationRequest](./ConnectorUpdateFilteringValidationRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorUpdateFilteringValidationResponse](./ConnectorUpdateFilteringValidationResponse.md), unknown>>;` |   || `updateFilteringValidation` | `updateFilteringValidation(this: [That](./That.md), params: [ConnectorUpdateFilteringValidationRequest](./ConnectorUpdateFilteringValidationRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorUpdateFilteringValidationResponse](./ConnectorUpdateFilteringValidationResponse.md)>;` |   || `updateIndexName` | `updateIndexName(this: [That](./That.md), params: [ConnectorUpdateIndexNameRequest](./ConnectorUpdateIndexNameRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorUpdateIndexNameResponse](./ConnectorUpdateIndexNameResponse.md)>;` | Update the connector index name. Update the `index_name` field of a connector, specifying the index where the data ingested by the connector is stored. || `updateIndexName` | `updateIndexName(this: [That](./That.md), params: [ConnectorUpdateIndexNameRequest](./ConnectorUpdateIndexNameRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorUpdateIndexNameResponse](./ConnectorUpdateIndexNameResponse.md), unknown>>;` |   || `updateIndexName` | `updateIndexName(this: [That](./That.md), params: [ConnectorUpdateIndexNameRequest](./ConnectorUpdateIndexNameRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorUpdateIndexNameResponse](./ConnectorUpdateIndexNameResponse.md)>;` |   || `updateName` | `updateName(this: [That](./That.md), params: [ConnectorUpdateNameRequest](./ConnectorUpdateNameRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorUpdateNameResponse](./ConnectorUpdateNameResponse.md)>;` | Update the connector name and description. || `updateName` | `updateName(this: [That](./That.md), params: [ConnectorUpdateNameRequest](./ConnectorUpdateNameRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorUpdateNameResponse](./ConnectorUpdateNameResponse.md), unknown>>;` |   || `updateName` | `updateName(this: [That](./That.md), params: [ConnectorUpdateNameRequest](./ConnectorUpdateNameRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorUpdateNameResponse](./ConnectorUpdateNameResponse.md)>;` |   || `updateNative` | `updateNative(this: [That](./That.md), params: [ConnectorUpdateNativeRequest](./ConnectorUpdateNativeRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorUpdateNativeResponse](./ConnectorUpdateNativeResponse.md)>;` | Update the connector is_native flag. || `updateNative` | `updateNative(this: [That](./That.md), params: [ConnectorUpdateNativeRequest](./ConnectorUpdateNativeRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorUpdateNativeResponse](./ConnectorUpdateNativeResponse.md), unknown>>;` |   || `updateNative` | `updateNative(this: [That](./That.md), params: [ConnectorUpdateNativeRequest](./ConnectorUpdateNativeRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorUpdateNativeResponse](./ConnectorUpdateNativeResponse.md)>;` |   || `updatePipeline` | `updatePipeline(this: [That](./That.md), params: [ConnectorUpdatePipelineRequest](./ConnectorUpdatePipelineRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorUpdatePipelineResponse](./ConnectorUpdatePipelineResponse.md)>;` | Update the connector pipeline. When you create a new connector, the configuration of an ingest pipeline is populated with default settings. || `updatePipeline` | `updatePipeline(this: [That](./That.md), params: [ConnectorUpdatePipelineRequest](./ConnectorUpdatePipelineRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorUpdatePipelineResponse](./ConnectorUpdatePipelineResponse.md), unknown>>;` |   || `updatePipeline` | `updatePipeline(this: [That](./That.md), params: [ConnectorUpdatePipelineRequest](./ConnectorUpdatePipelineRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorUpdatePipelineResponse](./ConnectorUpdatePipelineResponse.md)>;` |   || `updateScheduling` | `updateScheduling(this: [That](./That.md), params: [ConnectorUpdateSchedulingRequest](./ConnectorUpdateSchedulingRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorUpdateSchedulingResponse](./ConnectorUpdateSchedulingResponse.md)>;` | Update the connector scheduling. || `updateScheduling` | `updateScheduling(this: [That](./That.md), params: [ConnectorUpdateSchedulingRequest](./ConnectorUpdateSchedulingRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorUpdateSchedulingResponse](./ConnectorUpdateSchedulingResponse.md), unknown>>;` |   || `updateScheduling` | `updateScheduling(this: [That](./That.md), params: [ConnectorUpdateSchedulingRequest](./ConnectorUpdateSchedulingRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorUpdateSchedulingResponse](./ConnectorUpdateSchedulingResponse.md)>;` |   || `updateServiceType` | `updateServiceType(this: [That](./That.md), params: [ConnectorUpdateServiceTypeRequest](./ConnectorUpdateServiceTypeRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorUpdateServiceTypeResponse](./ConnectorUpdateServiceTypeResponse.md)>;` | Update the connector service type. || `updateServiceType` | `updateServiceType(this: [That](./That.md), params: [ConnectorUpdateServiceTypeRequest](./ConnectorUpdateServiceTypeRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorUpdateServiceTypeResponse](./ConnectorUpdateServiceTypeResponse.md), unknown>>;` |   || `updateServiceType` | `updateServiceType(this: [That](./That.md), params: [ConnectorUpdateServiceTypeRequest](./ConnectorUpdateServiceTypeRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorUpdateServiceTypeResponse](./ConnectorUpdateServiceTypeResponse.md)>;` |   || `updateStatus` | `updateStatus(this: [That](./That.md), params: [ConnectorUpdateStatusRequest](./ConnectorUpdateStatusRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorUpdateStatusResponse](./ConnectorUpdateStatusResponse.md)>;` | Update the connector status. || `updateStatus` | `updateStatus(this: [That](./That.md), params: [ConnectorUpdateStatusRequest](./ConnectorUpdateStatusRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorUpdateStatusResponse](./ConnectorUpdateStatusResponse.md), unknown>>;` |   || `updateStatus` | `updateStatus(this: [That](./That.md), params: [ConnectorUpdateStatusRequest](./ConnectorUpdateStatusRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorUpdateStatusResponse](./ConnectorUpdateStatusResponse.md)>;` |   | \ No newline at end of file +| `checkIn` | `checkIn(this: [That](./That.md), params: [ConnectorCheckInRequest](./ConnectorCheckInRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorCheckInResponse](./ConnectorCheckInResponse.md)>;` | Check in a connector. Update the `last_seen` field in the connector and set it to the current timestamp. | +| `checkIn` | `checkIn(this: [That](./That.md), params: [ConnectorCheckInRequest](./ConnectorCheckInRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorCheckInResponse](./ConnectorCheckInResponse.md), unknown>>;` |   | +| `checkIn` | `checkIn(this: [That](./That.md), params: [ConnectorCheckInRequest](./ConnectorCheckInRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorCheckInResponse](./ConnectorCheckInResponse.md)>;` |   | +| `delete` | `delete(this: [That](./That.md), params: [ConnectorDeleteRequest](./ConnectorDeleteRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorDeleteResponse](./ConnectorDeleteResponse.md)>;` | Delete a connector. Removes a connector and associated sync jobs. This is a destructive action that is not recoverable. NOTE: This action doesn’t delete any API keys, ingest pipelines, or data indices associated with the connector. These need to be removed manually. | +| `delete` | `delete(this: [That](./That.md), params: [ConnectorDeleteRequest](./ConnectorDeleteRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorDeleteResponse](./ConnectorDeleteResponse.md), unknown>>;` |   | +| `delete` | `delete(this: [That](./That.md), params: [ConnectorDeleteRequest](./ConnectorDeleteRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorDeleteResponse](./ConnectorDeleteResponse.md)>;` |   | +| `get` | `get(this: [That](./That.md), params: [ConnectorGetRequest](./ConnectorGetRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorGetResponse](./ConnectorGetResponse.md)>;` | Get a connector. Get the details about a connector. | +| `get` | `get(this: [That](./That.md), params: [ConnectorGetRequest](./ConnectorGetRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorGetResponse](./ConnectorGetResponse.md), unknown>>;` |   | +| `get` | `get(this: [That](./That.md), params: [ConnectorGetRequest](./ConnectorGetRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorGetResponse](./ConnectorGetResponse.md)>;` |   | +| `lastSync` | `lastSync(this: [That](./That.md), params: [ConnectorLastSyncRequest](./ConnectorLastSyncRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorLastSyncResponse](./ConnectorLastSyncResponse.md)>;` | Update the connector last sync stats. Update the fields related to the last sync of a connector. This action is used for analytics and monitoring. | +| `lastSync` | `lastSync(this: [That](./That.md), params: [ConnectorLastSyncRequest](./ConnectorLastSyncRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorLastSyncResponse](./ConnectorLastSyncResponse.md), unknown>>;` |   | +| `lastSync` | `lastSync(this: [That](./That.md), params: [ConnectorLastSyncRequest](./ConnectorLastSyncRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorLastSyncResponse](./ConnectorLastSyncResponse.md)>;` |   | +| `list` | `list(this: [That](./That.md), params?: [ConnectorListRequest](./ConnectorListRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorListResponse](./ConnectorListResponse.md)>;` | Get all connectors. Get information about all connectors. | +| `list` | `list(this: [That](./That.md), params?: [ConnectorListRequest](./ConnectorListRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorListResponse](./ConnectorListResponse.md), unknown>>;` |   | +| `list` | `list(this: [That](./That.md), params?: [ConnectorListRequest](./ConnectorListRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorListResponse](./ConnectorListResponse.md)>;` |   | +| `post` | `post(this: [That](./That.md), params?: [ConnectorPostRequest](./ConnectorPostRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorPostResponse](./ConnectorPostResponse.md)>;` | Create a connector. Connectors are Elasticsearch integrations that bring content from third-party data sources, which can be deployed on Elastic Cloud or hosted on your own infrastructure. Elastic managed connectors (Native connectors) are a managed service on Elastic Cloud. Self-managed connectors (Connector clients) are self-managed on your infrastructure. | +| `post` | `post(this: [That](./That.md), params?: [ConnectorPostRequest](./ConnectorPostRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorPostResponse](./ConnectorPostResponse.md), unknown>>;` |   | +| `post` | `post(this: [That](./That.md), params?: [ConnectorPostRequest](./ConnectorPostRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorPostResponse](./ConnectorPostResponse.md)>;` |   | +| `put` | `put(this: [That](./That.md), params?: [ConnectorPutRequest](./ConnectorPutRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorPutResponse](./ConnectorPutResponse.md)>;` | Create or update a connector. | +| `put` | `put(this: [That](./That.md), params?: [ConnectorPutRequest](./ConnectorPutRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorPutResponse](./ConnectorPutResponse.md), unknown>>;` |   | +| `put` | `put(this: [That](./That.md), params?: [ConnectorPutRequest](./ConnectorPutRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorPutResponse](./ConnectorPutResponse.md)>;` |   | +| `secretDelete` | `secretDelete(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TODO](./TODO.md)>;` | Deletes a connector secret. | +| `secretDelete` | `secretDelete(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TODO](./TODO.md), unknown>>;` |   | +| `secretDelete` | `secretDelete(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TODO](./TODO.md)>;` |   | +| `secretGet` | `secretGet(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TODO](./TODO.md)>;` | Retrieves a secret stored by Connectors. | +| `secretGet` | `secretGet(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TODO](./TODO.md), unknown>>;` |   | +| `secretGet` | `secretGet(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TODO](./TODO.md)>;` |   | +| `secretPost` | `secretPost(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TODO](./TODO.md)>;` | Creates a secret for a Connector. | +| `secretPost` | `secretPost(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TODO](./TODO.md), unknown>>;` |   | +| `secretPost` | `secretPost(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TODO](./TODO.md)>;` |   | +| `secretPut` | `secretPut(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TODO](./TODO.md)>;` | Creates or updates a secret for a Connector. | +| `secretPut` | `secretPut(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TODO](./TODO.md), unknown>>;` |   | +| `secretPut` | `secretPut(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TODO](./TODO.md)>;` |   | +| `syncJobCancel` | `syncJobCancel(this: [That](./That.md), params: [ConnectorSyncJobCancelRequest](./ConnectorSyncJobCancelRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorSyncJobCancelResponse](./ConnectorSyncJobCancelResponse.md)>;` | Cancel a connector sync job. Cancel a connector sync job, which sets the status to cancelling and updates `cancellation_requested_at` to the current time. The connector service is then responsible for setting the status of connector sync jobs to cancelled. | +| `syncJobCancel` | `syncJobCancel(this: [That](./That.md), params: [ConnectorSyncJobCancelRequest](./ConnectorSyncJobCancelRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorSyncJobCancelResponse](./ConnectorSyncJobCancelResponse.md), unknown>>;` |   | +| `syncJobCancel` | `syncJobCancel(this: [That](./That.md), params: [ConnectorSyncJobCancelRequest](./ConnectorSyncJobCancelRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorSyncJobCancelResponse](./ConnectorSyncJobCancelResponse.md)>;` |   | +| `syncJobCheckIn` | `syncJobCheckIn(this: [That](./That.md), params: [ConnectorSyncJobCheckInRequest](./ConnectorSyncJobCheckInRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorSyncJobCheckInResponse](./ConnectorSyncJobCheckInResponse.md)>;` | Check in a connector sync job. Check in a connector sync job and set the `last_seen` field to the current time before updating it in the internal index. To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure. This service runs automatically on Elastic Cloud for Elastic managed connectors. | +| `syncJobCheckIn` | `syncJobCheckIn(this: [That](./That.md), params: [ConnectorSyncJobCheckInRequest](./ConnectorSyncJobCheckInRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorSyncJobCheckInResponse](./ConnectorSyncJobCheckInResponse.md), unknown>>;` |   | +| `syncJobCheckIn` | `syncJobCheckIn(this: [That](./That.md), params: [ConnectorSyncJobCheckInRequest](./ConnectorSyncJobCheckInRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorSyncJobCheckInResponse](./ConnectorSyncJobCheckInResponse.md)>;` |   | +| `syncJobClaim` | `syncJobClaim(this: [That](./That.md), params: [ConnectorSyncJobClaimRequest](./ConnectorSyncJobClaimRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorSyncJobClaimResponse](./ConnectorSyncJobClaimResponse.md)>;` | Claim a connector sync job. This action updates the job status to `in_progress` and sets the `last_seen` and `started_at` timestamps to the current time. Additionally, it can set the `sync_cursor` property for the sync job. This API is not intended for direct connector management by users. It supports the implementation of services that utilize the connector protocol to communicate with Elasticsearch. To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure. This service runs automatically on Elastic Cloud for Elastic managed connectors. | +| `syncJobClaim` | `syncJobClaim(this: [That](./That.md), params: [ConnectorSyncJobClaimRequest](./ConnectorSyncJobClaimRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorSyncJobClaimResponse](./ConnectorSyncJobClaimResponse.md), unknown>>;` |   | +| `syncJobClaim` | `syncJobClaim(this: [That](./That.md), params: [ConnectorSyncJobClaimRequest](./ConnectorSyncJobClaimRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorSyncJobClaimResponse](./ConnectorSyncJobClaimResponse.md)>;` |   | +| `syncJobDelete` | `syncJobDelete(this: [That](./That.md), params: [ConnectorSyncJobDeleteRequest](./ConnectorSyncJobDeleteRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorSyncJobDeleteResponse](./ConnectorSyncJobDeleteResponse.md)>;` | Delete a connector sync job. Remove a connector sync job and its associated data. This is a destructive action that is not recoverable. | +| `syncJobDelete` | `syncJobDelete(this: [That](./That.md), params: [ConnectorSyncJobDeleteRequest](./ConnectorSyncJobDeleteRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorSyncJobDeleteResponse](./ConnectorSyncJobDeleteResponse.md), unknown>>;` |   | +| `syncJobDelete` | `syncJobDelete(this: [That](./That.md), params: [ConnectorSyncJobDeleteRequest](./ConnectorSyncJobDeleteRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorSyncJobDeleteResponse](./ConnectorSyncJobDeleteResponse.md)>;` |   | +| `syncJobError` | `syncJobError(this: [That](./That.md), params: [ConnectorSyncJobErrorRequest](./ConnectorSyncJobErrorRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorSyncJobErrorResponse](./ConnectorSyncJobErrorResponse.md)>;` | Set a connector sync job error. Set the `error` field for a connector sync job and set its `status` to `error`. To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure. This service runs automatically on Elastic Cloud for Elastic managed connectors. | +| `syncJobError` | `syncJobError(this: [That](./That.md), params: [ConnectorSyncJobErrorRequest](./ConnectorSyncJobErrorRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorSyncJobErrorResponse](./ConnectorSyncJobErrorResponse.md), unknown>>;` |   | +| `syncJobError` | `syncJobError(this: [That](./That.md), params: [ConnectorSyncJobErrorRequest](./ConnectorSyncJobErrorRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorSyncJobErrorResponse](./ConnectorSyncJobErrorResponse.md)>;` |   | +| `syncJobGet` | `syncJobGet(this: [That](./That.md), params: [ConnectorSyncJobGetRequest](./ConnectorSyncJobGetRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorSyncJobGetResponse](./ConnectorSyncJobGetResponse.md)>;` | Get a connector sync job. | +| `syncJobGet` | `syncJobGet(this: [That](./That.md), params: [ConnectorSyncJobGetRequest](./ConnectorSyncJobGetRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorSyncJobGetResponse](./ConnectorSyncJobGetResponse.md), unknown>>;` |   | +| `syncJobGet` | `syncJobGet(this: [That](./That.md), params: [ConnectorSyncJobGetRequest](./ConnectorSyncJobGetRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorSyncJobGetResponse](./ConnectorSyncJobGetResponse.md)>;` |   | +| `syncJobList` | `syncJobList(this: [That](./That.md), params?: [ConnectorSyncJobListRequest](./ConnectorSyncJobListRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorSyncJobListResponse](./ConnectorSyncJobListResponse.md)>;` | Get all connector sync jobs. Get information about all stored connector sync jobs listed by their creation date in ascending order. | +| `syncJobList` | `syncJobList(this: [That](./That.md), params?: [ConnectorSyncJobListRequest](./ConnectorSyncJobListRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorSyncJobListResponse](./ConnectorSyncJobListResponse.md), unknown>>;` |   | +| `syncJobList` | `syncJobList(this: [That](./That.md), params?: [ConnectorSyncJobListRequest](./ConnectorSyncJobListRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorSyncJobListResponse](./ConnectorSyncJobListResponse.md)>;` |   | +| `syncJobPost` | `syncJobPost(this: [That](./That.md), params: [ConnectorSyncJobPostRequest](./ConnectorSyncJobPostRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorSyncJobPostResponse](./ConnectorSyncJobPostResponse.md)>;` | Create a connector sync job. Create a connector sync job document in the internal index and initialize its counters and timestamps with default values. | +| `syncJobPost` | `syncJobPost(this: [That](./That.md), params: [ConnectorSyncJobPostRequest](./ConnectorSyncJobPostRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorSyncJobPostResponse](./ConnectorSyncJobPostResponse.md), unknown>>;` |   | +| `syncJobPost` | `syncJobPost(this: [That](./That.md), params: [ConnectorSyncJobPostRequest](./ConnectorSyncJobPostRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorSyncJobPostResponse](./ConnectorSyncJobPostResponse.md)>;` |   | +| `syncJobUpdateStats` | `syncJobUpdateStats(this: [That](./That.md), params: [ConnectorSyncJobUpdateStatsRequest](./ConnectorSyncJobUpdateStatsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorSyncJobUpdateStatsResponse](./ConnectorSyncJobUpdateStatsResponse.md)>;` | Set the connector sync job stats. Stats include: `deleted_document_count`, `indexed_document_count`, `indexed_document_volume`, and `total_document_count`. You can also update `last_seen`. This API is mainly used by the connector service for updating sync job information. To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure. This service runs automatically on Elastic Cloud for Elastic managed connectors. | +| `syncJobUpdateStats` | `syncJobUpdateStats(this: [That](./That.md), params: [ConnectorSyncJobUpdateStatsRequest](./ConnectorSyncJobUpdateStatsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorSyncJobUpdateStatsResponse](./ConnectorSyncJobUpdateStatsResponse.md), unknown>>;` |   | +| `syncJobUpdateStats` | `syncJobUpdateStats(this: [That](./That.md), params: [ConnectorSyncJobUpdateStatsRequest](./ConnectorSyncJobUpdateStatsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorSyncJobUpdateStatsResponse](./ConnectorSyncJobUpdateStatsResponse.md)>;` |   | +| `updateActiveFiltering` | `updateActiveFiltering(this: [That](./That.md), params: [ConnectorUpdateActiveFilteringRequest](./ConnectorUpdateActiveFilteringRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorUpdateActiveFilteringResponse](./ConnectorUpdateActiveFilteringResponse.md)>;` | Activate the connector draft filter. Activates the valid draft filtering for a connector. | +| `updateActiveFiltering` | `updateActiveFiltering(this: [That](./That.md), params: [ConnectorUpdateActiveFilteringRequest](./ConnectorUpdateActiveFilteringRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorUpdateActiveFilteringResponse](./ConnectorUpdateActiveFilteringResponse.md), unknown>>;` |   | +| `updateActiveFiltering` | `updateActiveFiltering(this: [That](./That.md), params: [ConnectorUpdateActiveFilteringRequest](./ConnectorUpdateActiveFilteringRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorUpdateActiveFilteringResponse](./ConnectorUpdateActiveFilteringResponse.md)>;` |   | +| `updateApiKeyId` | `updateApiKeyId(this: [That](./That.md), params: [ConnectorUpdateApiKeyIdRequest](./ConnectorUpdateApiKeyIdRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorUpdateApiKeyIdResponse](./ConnectorUpdateApiKeyIdResponse.md)>;` | Update the connector API key ID. Update the `api_key_id` and `api_key_secret_id` fields of a connector. You can specify the ID of the API key used for authorization and the ID of the connector secret where the API key is stored. The connector secret ID is required only for Elastic managed (native) connectors. Self-managed connectors (connector clients) do not use this field. | +| `updateApiKeyId` | `updateApiKeyId(this: [That](./That.md), params: [ConnectorUpdateApiKeyIdRequest](./ConnectorUpdateApiKeyIdRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorUpdateApiKeyIdResponse](./ConnectorUpdateApiKeyIdResponse.md), unknown>>;` |   | +| `updateApiKeyId` | `updateApiKeyId(this: [That](./That.md), params: [ConnectorUpdateApiKeyIdRequest](./ConnectorUpdateApiKeyIdRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorUpdateApiKeyIdResponse](./ConnectorUpdateApiKeyIdResponse.md)>;` |   | +| `updateConfiguration` | `updateConfiguration(this: [That](./That.md), params: [ConnectorUpdateConfigurationRequest](./ConnectorUpdateConfigurationRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorUpdateConfigurationResponse](./ConnectorUpdateConfigurationResponse.md)>;` | Update the connector configuration. Update the configuration field in the connector document. | +| `updateConfiguration` | `updateConfiguration(this: [That](./That.md), params: [ConnectorUpdateConfigurationRequest](./ConnectorUpdateConfigurationRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorUpdateConfigurationResponse](./ConnectorUpdateConfigurationResponse.md), unknown>>;` |   | +| `updateConfiguration` | `updateConfiguration(this: [That](./That.md), params: [ConnectorUpdateConfigurationRequest](./ConnectorUpdateConfigurationRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorUpdateConfigurationResponse](./ConnectorUpdateConfigurationResponse.md)>;` |   | +| `updateError` | `updateError(this: [That](./That.md), params: [ConnectorUpdateErrorRequest](./ConnectorUpdateErrorRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorUpdateErrorResponse](./ConnectorUpdateErrorResponse.md)>;` | Update the connector error field. Set the error field for the connector. If the error provided in the request body is non-null, the connector’s status is updated to error. Otherwise, if the error is reset to null, the connector status is updated to connected. | +| `updateError` | `updateError(this: [That](./That.md), params: [ConnectorUpdateErrorRequest](./ConnectorUpdateErrorRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorUpdateErrorResponse](./ConnectorUpdateErrorResponse.md), unknown>>;` |   | +| `updateError` | `updateError(this: [That](./That.md), params: [ConnectorUpdateErrorRequest](./ConnectorUpdateErrorRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorUpdateErrorResponse](./ConnectorUpdateErrorResponse.md)>;` |   | +| `updateFeatures` | `updateFeatures(this: [That](./That.md), params: [ConnectorUpdateFeaturesRequest](./ConnectorUpdateFeaturesRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorUpdateFeaturesResponse](./ConnectorUpdateFeaturesResponse.md)>;` | Update the connector features. Update the connector features in the connector document. This API can be used to control the following aspects of a connector: * document-level security * incremental syncs * advanced sync rules * basic sync rules Normally, the running connector service automatically manages these features. However, you can use this API to override the default behavior. To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure. This service runs automatically on Elastic Cloud for Elastic managed connectors. | +| `updateFeatures` | `updateFeatures(this: [That](./That.md), params: [ConnectorUpdateFeaturesRequest](./ConnectorUpdateFeaturesRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorUpdateFeaturesResponse](./ConnectorUpdateFeaturesResponse.md), unknown>>;` |   | +| `updateFeatures` | `updateFeatures(this: [That](./That.md), params: [ConnectorUpdateFeaturesRequest](./ConnectorUpdateFeaturesRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorUpdateFeaturesResponse](./ConnectorUpdateFeaturesResponse.md)>;` |   | +| `updateFiltering` | `updateFiltering(this: [That](./That.md), params: [ConnectorUpdateFilteringRequest](./ConnectorUpdateFilteringRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorUpdateFilteringResponse](./ConnectorUpdateFilteringResponse.md)>;` | Update the connector filtering. Update the draft filtering configuration of a connector and marks the draft validation state as edited. The filtering draft is activated once validated by the running Elastic connector service. The filtering property is used to configure sync rules (both basic and advanced) for a connector. | +| `updateFiltering` | `updateFiltering(this: [That](./That.md), params: [ConnectorUpdateFilteringRequest](./ConnectorUpdateFilteringRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorUpdateFilteringResponse](./ConnectorUpdateFilteringResponse.md), unknown>>;` |   | +| `updateFiltering` | `updateFiltering(this: [That](./That.md), params: [ConnectorUpdateFilteringRequest](./ConnectorUpdateFilteringRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorUpdateFilteringResponse](./ConnectorUpdateFilteringResponse.md)>;` |   | +| `updateFilteringValidation` | `updateFilteringValidation(this: [That](./That.md), params: [ConnectorUpdateFilteringValidationRequest](./ConnectorUpdateFilteringValidationRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorUpdateFilteringValidationResponse](./ConnectorUpdateFilteringValidationResponse.md)>;` | Update the connector draft filtering validation. Update the draft filtering validation info for a connector. | +| `updateFilteringValidation` | `updateFilteringValidation(this: [That](./That.md), params: [ConnectorUpdateFilteringValidationRequest](./ConnectorUpdateFilteringValidationRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorUpdateFilteringValidationResponse](./ConnectorUpdateFilteringValidationResponse.md), unknown>>;` |   | +| `updateFilteringValidation` | `updateFilteringValidation(this: [That](./That.md), params: [ConnectorUpdateFilteringValidationRequest](./ConnectorUpdateFilteringValidationRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorUpdateFilteringValidationResponse](./ConnectorUpdateFilteringValidationResponse.md)>;` |   | +| `updateIndexName` | `updateIndexName(this: [That](./That.md), params: [ConnectorUpdateIndexNameRequest](./ConnectorUpdateIndexNameRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorUpdateIndexNameResponse](./ConnectorUpdateIndexNameResponse.md)>;` | Update the connector index name. Update the `index_name` field of a connector, specifying the index where the data ingested by the connector is stored. | +| `updateIndexName` | `updateIndexName(this: [That](./That.md), params: [ConnectorUpdateIndexNameRequest](./ConnectorUpdateIndexNameRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorUpdateIndexNameResponse](./ConnectorUpdateIndexNameResponse.md), unknown>>;` |   | +| `updateIndexName` | `updateIndexName(this: [That](./That.md), params: [ConnectorUpdateIndexNameRequest](./ConnectorUpdateIndexNameRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorUpdateIndexNameResponse](./ConnectorUpdateIndexNameResponse.md)>;` |   | +| `updateName` | `updateName(this: [That](./That.md), params: [ConnectorUpdateNameRequest](./ConnectorUpdateNameRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorUpdateNameResponse](./ConnectorUpdateNameResponse.md)>;` | Update the connector name and description. | +| `updateName` | `updateName(this: [That](./That.md), params: [ConnectorUpdateNameRequest](./ConnectorUpdateNameRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorUpdateNameResponse](./ConnectorUpdateNameResponse.md), unknown>>;` |   | +| `updateName` | `updateName(this: [That](./That.md), params: [ConnectorUpdateNameRequest](./ConnectorUpdateNameRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorUpdateNameResponse](./ConnectorUpdateNameResponse.md)>;` |   | +| `updateNative` | `updateNative(this: [That](./That.md), params: [ConnectorUpdateNativeRequest](./ConnectorUpdateNativeRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorUpdateNativeResponse](./ConnectorUpdateNativeResponse.md)>;` | Update the connector is_native flag. | +| `updateNative` | `updateNative(this: [That](./That.md), params: [ConnectorUpdateNativeRequest](./ConnectorUpdateNativeRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorUpdateNativeResponse](./ConnectorUpdateNativeResponse.md), unknown>>;` |   | +| `updateNative` | `updateNative(this: [That](./That.md), params: [ConnectorUpdateNativeRequest](./ConnectorUpdateNativeRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorUpdateNativeResponse](./ConnectorUpdateNativeResponse.md)>;` |   | +| `updatePipeline` | `updatePipeline(this: [That](./That.md), params: [ConnectorUpdatePipelineRequest](./ConnectorUpdatePipelineRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorUpdatePipelineResponse](./ConnectorUpdatePipelineResponse.md)>;` | Update the connector pipeline. When you create a new connector, the configuration of an ingest pipeline is populated with default settings. | +| `updatePipeline` | `updatePipeline(this: [That](./That.md), params: [ConnectorUpdatePipelineRequest](./ConnectorUpdatePipelineRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorUpdatePipelineResponse](./ConnectorUpdatePipelineResponse.md), unknown>>;` |   | +| `updatePipeline` | `updatePipeline(this: [That](./That.md), params: [ConnectorUpdatePipelineRequest](./ConnectorUpdatePipelineRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorUpdatePipelineResponse](./ConnectorUpdatePipelineResponse.md)>;` |   | +| `updateScheduling` | `updateScheduling(this: [That](./That.md), params: [ConnectorUpdateSchedulingRequest](./ConnectorUpdateSchedulingRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorUpdateSchedulingResponse](./ConnectorUpdateSchedulingResponse.md)>;` | Update the connector scheduling. | +| `updateScheduling` | `updateScheduling(this: [That](./That.md), params: [ConnectorUpdateSchedulingRequest](./ConnectorUpdateSchedulingRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorUpdateSchedulingResponse](./ConnectorUpdateSchedulingResponse.md), unknown>>;` |   | +| `updateScheduling` | `updateScheduling(this: [That](./That.md), params: [ConnectorUpdateSchedulingRequest](./ConnectorUpdateSchedulingRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorUpdateSchedulingResponse](./ConnectorUpdateSchedulingResponse.md)>;` |   | +| `updateServiceType` | `updateServiceType(this: [That](./That.md), params: [ConnectorUpdateServiceTypeRequest](./ConnectorUpdateServiceTypeRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorUpdateServiceTypeResponse](./ConnectorUpdateServiceTypeResponse.md)>;` | Update the connector service type. | +| `updateServiceType` | `updateServiceType(this: [That](./That.md), params: [ConnectorUpdateServiceTypeRequest](./ConnectorUpdateServiceTypeRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorUpdateServiceTypeResponse](./ConnectorUpdateServiceTypeResponse.md), unknown>>;` |   | +| `updateServiceType` | `updateServiceType(this: [That](./That.md), params: [ConnectorUpdateServiceTypeRequest](./ConnectorUpdateServiceTypeRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorUpdateServiceTypeResponse](./ConnectorUpdateServiceTypeResponse.md)>;` |   | +| `updateStatus` | `updateStatus(this: [That](./That.md), params: [ConnectorUpdateStatusRequest](./ConnectorUpdateStatusRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ConnectorUpdateStatusResponse](./ConnectorUpdateStatusResponse.md)>;` | Update the connector status. | +| `updateStatus` | `updateStatus(this: [That](./That.md), params: [ConnectorUpdateStatusRequest](./ConnectorUpdateStatusRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ConnectorUpdateStatusResponse](./ConnectorUpdateStatusResponse.md), unknown>>;` |   | +| `updateStatus` | `updateStatus(this: [That](./That.md), params: [ConnectorUpdateStatusRequest](./ConnectorUpdateStatusRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ConnectorUpdateStatusResponse](./ConnectorUpdateStatusResponse.md)>;` |   | diff --git a/docs/reference/api/DanglingIndices.md b/docs/reference/api/DanglingIndices.md index 80b869dae..81add5af9 100644 --- a/docs/reference/api/DanglingIndices.md +++ b/docs/reference/api/DanglingIndices.md @@ -17,4 +17,12 @@ new DanglingIndices(transport: [Transport](./Transport.md)); | Name | Signature | Description | | - | - | - | -| `deleteDanglingIndex` | `deleteDanglingIndex(this: [That](./That.md), params: [DanglingIndicesDeleteDanglingIndexRequest](./DanglingIndicesDeleteDanglingIndexRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[DanglingIndicesDeleteDanglingIndexResponse](./DanglingIndicesDeleteDanglingIndexResponse.md)>;` | Delete a dangling index. If Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling. For example, this can happen if you delete more than `cluster.indices.tombstones.size` indices while an Elasticsearch node is offline. || `deleteDanglingIndex` | `deleteDanglingIndex(this: [That](./That.md), params: [DanglingIndicesDeleteDanglingIndexRequest](./DanglingIndicesDeleteDanglingIndexRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[DanglingIndicesDeleteDanglingIndexResponse](./DanglingIndicesDeleteDanglingIndexResponse.md), unknown>>;` |   || `deleteDanglingIndex` | `deleteDanglingIndex(this: [That](./That.md), params: [DanglingIndicesDeleteDanglingIndexRequest](./DanglingIndicesDeleteDanglingIndexRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[DanglingIndicesDeleteDanglingIndexResponse](./DanglingIndicesDeleteDanglingIndexResponse.md)>;` |   || `importDanglingIndex` | `importDanglingIndex(this: [That](./That.md), params: [DanglingIndicesImportDanglingIndexRequest](./DanglingIndicesImportDanglingIndexRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[DanglingIndicesImportDanglingIndexResponse](./DanglingIndicesImportDanglingIndexResponse.md)>;` | Import a dangling index. If Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling. For example, this can happen if you delete more than `cluster.indices.tombstones.size` indices while an Elasticsearch node is offline. || `importDanglingIndex` | `importDanglingIndex(this: [That](./That.md), params: [DanglingIndicesImportDanglingIndexRequest](./DanglingIndicesImportDanglingIndexRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[DanglingIndicesImportDanglingIndexResponse](./DanglingIndicesImportDanglingIndexResponse.md), unknown>>;` |   || `importDanglingIndex` | `importDanglingIndex(this: [That](./That.md), params: [DanglingIndicesImportDanglingIndexRequest](./DanglingIndicesImportDanglingIndexRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[DanglingIndicesImportDanglingIndexResponse](./DanglingIndicesImportDanglingIndexResponse.md)>;` |   || `listDanglingIndices` | `listDanglingIndices(this: [That](./That.md), params?: [DanglingIndicesListDanglingIndicesRequest](./DanglingIndicesListDanglingIndicesRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[DanglingIndicesListDanglingIndicesResponse](./DanglingIndicesListDanglingIndicesResponse.md)>;` | Get the dangling indices. If Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling. For example, this can happen if you delete more than `cluster.indices.tombstones.size` indices while an Elasticsearch node is offline. Use this API to list dangling indices, which you can then import or delete. || `listDanglingIndices` | `listDanglingIndices(this: [That](./That.md), params?: [DanglingIndicesListDanglingIndicesRequest](./DanglingIndicesListDanglingIndicesRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[DanglingIndicesListDanglingIndicesResponse](./DanglingIndicesListDanglingIndicesResponse.md), unknown>>;` |   || `listDanglingIndices` | `listDanglingIndices(this: [That](./That.md), params?: [DanglingIndicesListDanglingIndicesRequest](./DanglingIndicesListDanglingIndicesRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[DanglingIndicesListDanglingIndicesResponse](./DanglingIndicesListDanglingIndicesResponse.md)>;` |   | \ No newline at end of file +| `deleteDanglingIndex` | `deleteDanglingIndex(this: [That](./That.md), params: [DanglingIndicesDeleteDanglingIndexRequest](./DanglingIndicesDeleteDanglingIndexRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[DanglingIndicesDeleteDanglingIndexResponse](./DanglingIndicesDeleteDanglingIndexResponse.md)>;` | Delete a dangling index. If Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling. For example, this can happen if you delete more than `cluster.indices.tombstones.size` indices while an Elasticsearch node is offline. | +| `deleteDanglingIndex` | `deleteDanglingIndex(this: [That](./That.md), params: [DanglingIndicesDeleteDanglingIndexRequest](./DanglingIndicesDeleteDanglingIndexRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[DanglingIndicesDeleteDanglingIndexResponse](./DanglingIndicesDeleteDanglingIndexResponse.md), unknown>>;` |   | +| `deleteDanglingIndex` | `deleteDanglingIndex(this: [That](./That.md), params: [DanglingIndicesDeleteDanglingIndexRequest](./DanglingIndicesDeleteDanglingIndexRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[DanglingIndicesDeleteDanglingIndexResponse](./DanglingIndicesDeleteDanglingIndexResponse.md)>;` |   | +| `importDanglingIndex` | `importDanglingIndex(this: [That](./That.md), params: [DanglingIndicesImportDanglingIndexRequest](./DanglingIndicesImportDanglingIndexRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[DanglingIndicesImportDanglingIndexResponse](./DanglingIndicesImportDanglingIndexResponse.md)>;` | Import a dangling index. If Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling. For example, this can happen if you delete more than `cluster.indices.tombstones.size` indices while an Elasticsearch node is offline. | +| `importDanglingIndex` | `importDanglingIndex(this: [That](./That.md), params: [DanglingIndicesImportDanglingIndexRequest](./DanglingIndicesImportDanglingIndexRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[DanglingIndicesImportDanglingIndexResponse](./DanglingIndicesImportDanglingIndexResponse.md), unknown>>;` |   | +| `importDanglingIndex` | `importDanglingIndex(this: [That](./That.md), params: [DanglingIndicesImportDanglingIndexRequest](./DanglingIndicesImportDanglingIndexRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[DanglingIndicesImportDanglingIndexResponse](./DanglingIndicesImportDanglingIndexResponse.md)>;` |   | +| `listDanglingIndices` | `listDanglingIndices(this: [That](./That.md), params?: [DanglingIndicesListDanglingIndicesRequest](./DanglingIndicesListDanglingIndicesRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[DanglingIndicesListDanglingIndicesResponse](./DanglingIndicesListDanglingIndicesResponse.md)>;` | Get the dangling indices. If Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling. For example, this can happen if you delete more than `cluster.indices.tombstones.size` indices while an Elasticsearch node is offline. Use this API to list dangling indices, which you can then import or delete. | +| `listDanglingIndices` | `listDanglingIndices(this: [That](./That.md), params?: [DanglingIndicesListDanglingIndicesRequest](./DanglingIndicesListDanglingIndicesRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[DanglingIndicesListDanglingIndicesResponse](./DanglingIndicesListDanglingIndicesResponse.md), unknown>>;` |   | +| `listDanglingIndices` | `listDanglingIndices(this: [That](./That.md), params?: [DanglingIndicesListDanglingIndicesRequest](./DanglingIndicesListDanglingIndicesRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[DanglingIndicesListDanglingIndicesResponse](./DanglingIndicesListDanglingIndicesResponse.md)>;` |   | diff --git a/docs/reference/api/Enrich.md b/docs/reference/api/Enrich.md index 9fb9194ce..ef1fa5f53 100644 --- a/docs/reference/api/Enrich.md +++ b/docs/reference/api/Enrich.md @@ -17,4 +17,18 @@ new Enrich(transport: [Transport](./Transport.md)); | Name | Signature | Description | | - | - | - | -| `deletePolicy` | `deletePolicy(this: [That](./That.md), params: [EnrichDeletePolicyRequest](./EnrichDeletePolicyRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[EnrichDeletePolicyResponse](./EnrichDeletePolicyResponse.md)>;` | Delete an enrich policy. Deletes an existing enrich policy and its enrich index. || `deletePolicy` | `deletePolicy(this: [That](./That.md), params: [EnrichDeletePolicyRequest](./EnrichDeletePolicyRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[EnrichDeletePolicyResponse](./EnrichDeletePolicyResponse.md), unknown>>;` |   || `deletePolicy` | `deletePolicy(this: [That](./That.md), params: [EnrichDeletePolicyRequest](./EnrichDeletePolicyRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[EnrichDeletePolicyResponse](./EnrichDeletePolicyResponse.md)>;` |   || `executePolicy` | `executePolicy(this: [That](./That.md), params: [EnrichExecutePolicyRequest](./EnrichExecutePolicyRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[EnrichExecutePolicyResponse](./EnrichExecutePolicyResponse.md)>;` | Run an enrich policy. Create the enrich index for an existing enrich policy. || `executePolicy` | `executePolicy(this: [That](./That.md), params: [EnrichExecutePolicyRequest](./EnrichExecutePolicyRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[EnrichExecutePolicyResponse](./EnrichExecutePolicyResponse.md), unknown>>;` |   || `executePolicy` | `executePolicy(this: [That](./That.md), params: [EnrichExecutePolicyRequest](./EnrichExecutePolicyRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[EnrichExecutePolicyResponse](./EnrichExecutePolicyResponse.md)>;` |   || `getPolicy` | `getPolicy(this: [That](./That.md), params?: [EnrichGetPolicyRequest](./EnrichGetPolicyRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[EnrichGetPolicyResponse](./EnrichGetPolicyResponse.md)>;` | Get an enrich policy. Returns information about an enrich policy. || `getPolicy` | `getPolicy(this: [That](./That.md), params?: [EnrichGetPolicyRequest](./EnrichGetPolicyRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[EnrichGetPolicyResponse](./EnrichGetPolicyResponse.md), unknown>>;` |   || `getPolicy` | `getPolicy(this: [That](./That.md), params?: [EnrichGetPolicyRequest](./EnrichGetPolicyRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[EnrichGetPolicyResponse](./EnrichGetPolicyResponse.md)>;` |   || `putPolicy` | `putPolicy(this: [That](./That.md), params: [EnrichPutPolicyRequest](./EnrichPutPolicyRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[EnrichPutPolicyResponse](./EnrichPutPolicyResponse.md)>;` | Create an enrich policy. Creates an enrich policy. || `putPolicy` | `putPolicy(this: [That](./That.md), params: [EnrichPutPolicyRequest](./EnrichPutPolicyRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[EnrichPutPolicyResponse](./EnrichPutPolicyResponse.md), unknown>>;` |   || `putPolicy` | `putPolicy(this: [That](./That.md), params: [EnrichPutPolicyRequest](./EnrichPutPolicyRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[EnrichPutPolicyResponse](./EnrichPutPolicyResponse.md)>;` |   || `stats` | `stats(this: [That](./That.md), params?: [EnrichStatsRequest](./EnrichStatsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[EnrichStatsResponse](./EnrichStatsResponse.md)>;` | Get enrich stats. Returns enrich coordinator statistics and information about enrich policies that are currently executing. || `stats` | `stats(this: [That](./That.md), params?: [EnrichStatsRequest](./EnrichStatsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[EnrichStatsResponse](./EnrichStatsResponse.md), unknown>>;` |   || `stats` | `stats(this: [That](./That.md), params?: [EnrichStatsRequest](./EnrichStatsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[EnrichStatsResponse](./EnrichStatsResponse.md)>;` |   | \ No newline at end of file +| `deletePolicy` | `deletePolicy(this: [That](./That.md), params: [EnrichDeletePolicyRequest](./EnrichDeletePolicyRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[EnrichDeletePolicyResponse](./EnrichDeletePolicyResponse.md)>;` | Delete an enrich policy. Deletes an existing enrich policy and its enrich index. | +| `deletePolicy` | `deletePolicy(this: [That](./That.md), params: [EnrichDeletePolicyRequest](./EnrichDeletePolicyRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[EnrichDeletePolicyResponse](./EnrichDeletePolicyResponse.md), unknown>>;` |   | +| `deletePolicy` | `deletePolicy(this: [That](./That.md), params: [EnrichDeletePolicyRequest](./EnrichDeletePolicyRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[EnrichDeletePolicyResponse](./EnrichDeletePolicyResponse.md)>;` |   | +| `executePolicy` | `executePolicy(this: [That](./That.md), params: [EnrichExecutePolicyRequest](./EnrichExecutePolicyRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[EnrichExecutePolicyResponse](./EnrichExecutePolicyResponse.md)>;` | Run an enrich policy. Create the enrich index for an existing enrich policy. | +| `executePolicy` | `executePolicy(this: [That](./That.md), params: [EnrichExecutePolicyRequest](./EnrichExecutePolicyRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[EnrichExecutePolicyResponse](./EnrichExecutePolicyResponse.md), unknown>>;` |   | +| `executePolicy` | `executePolicy(this: [That](./That.md), params: [EnrichExecutePolicyRequest](./EnrichExecutePolicyRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[EnrichExecutePolicyResponse](./EnrichExecutePolicyResponse.md)>;` |   | +| `getPolicy` | `getPolicy(this: [That](./That.md), params?: [EnrichGetPolicyRequest](./EnrichGetPolicyRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[EnrichGetPolicyResponse](./EnrichGetPolicyResponse.md)>;` | Get an enrich policy. Returns information about an enrich policy. | +| `getPolicy` | `getPolicy(this: [That](./That.md), params?: [EnrichGetPolicyRequest](./EnrichGetPolicyRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[EnrichGetPolicyResponse](./EnrichGetPolicyResponse.md), unknown>>;` |   | +| `getPolicy` | `getPolicy(this: [That](./That.md), params?: [EnrichGetPolicyRequest](./EnrichGetPolicyRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[EnrichGetPolicyResponse](./EnrichGetPolicyResponse.md)>;` |   | +| `putPolicy` | `putPolicy(this: [That](./That.md), params: [EnrichPutPolicyRequest](./EnrichPutPolicyRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[EnrichPutPolicyResponse](./EnrichPutPolicyResponse.md)>;` | Create an enrich policy. Creates an enrich policy. | +| `putPolicy` | `putPolicy(this: [That](./That.md), params: [EnrichPutPolicyRequest](./EnrichPutPolicyRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[EnrichPutPolicyResponse](./EnrichPutPolicyResponse.md), unknown>>;` |   | +| `putPolicy` | `putPolicy(this: [That](./That.md), params: [EnrichPutPolicyRequest](./EnrichPutPolicyRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[EnrichPutPolicyResponse](./EnrichPutPolicyResponse.md)>;` |   | +| `stats` | `stats(this: [That](./That.md), params?: [EnrichStatsRequest](./EnrichStatsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[EnrichStatsResponse](./EnrichStatsResponse.md)>;` | Get enrich stats. Returns enrich coordinator statistics and information about enrich policies that are currently executing. | +| `stats` | `stats(this: [That](./That.md), params?: [EnrichStatsRequest](./EnrichStatsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[EnrichStatsResponse](./EnrichStatsResponse.md), unknown>>;` |   | +| `stats` | `stats(this: [That](./That.md), params?: [EnrichStatsRequest](./EnrichStatsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[EnrichStatsResponse](./EnrichStatsResponse.md)>;` |   | diff --git a/docs/reference/api/Eql.md b/docs/reference/api/Eql.md index da6243bf0..9d7722dcd 100644 --- a/docs/reference/api/Eql.md +++ b/docs/reference/api/Eql.md @@ -17,4 +17,15 @@ new Eql(transport: [Transport](./Transport.md)); | Name | Signature | Description | | - | - | - | -| `delete` | `delete(this: [That](./That.md), params: [EqlDeleteRequest](./EqlDeleteRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[EqlDeleteResponse](./EqlDeleteResponse.md)>;` | Delete an async EQL search. Delete an async EQL search or a stored synchronous EQL search. The API also deletes results for the search. || `delete` | `delete(this: [That](./That.md), params: [EqlDeleteRequest](./EqlDeleteRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[EqlDeleteResponse](./EqlDeleteResponse.md), unknown>>;` |   || `delete` | `delete(this: [That](./That.md), params: [EqlDeleteRequest](./EqlDeleteRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[EqlDeleteResponse](./EqlDeleteResponse.md)>;` |   || `get` | `get(this: [That](./That.md), params: [EqlGetRequest](./EqlGetRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[EqlGetResponse](./EqlGetResponse.md)>;` | Get async EQL search results. Get the current status and available results for an async EQL search or a stored synchronous EQL search. || `get` | `get(this: [That](./That.md), params: [EqlGetRequest](./EqlGetRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[EqlGetResponse](./EqlGetResponse.md), unknown>>;` |   || `get` | `get(this: [That](./That.md), params: [EqlGetRequest](./EqlGetRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[EqlGetResponse](./EqlGetResponse.md)>;` |   || `getStatus` | `getStatus(this: [That](./That.md), params: [EqlGetStatusRequest](./EqlGetStatusRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[EqlGetStatusResponse](./EqlGetStatusResponse.md)>;` | Get the async EQL status. Get the current status for an async EQL search or a stored synchronous EQL search without returning results. || `getStatus` | `getStatus(this: [That](./That.md), params: [EqlGetStatusRequest](./EqlGetStatusRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[EqlGetStatusResponse](./EqlGetStatusResponse.md), unknown>>;` |   || `getStatus` | `getStatus(this: [That](./That.md), params: [EqlGetStatusRequest](./EqlGetStatusRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[EqlGetStatusResponse](./EqlGetStatusResponse.md)>;` |   || `search` | `search(this: [That](./That.md), params: [EqlSearchRequest](./EqlSearchRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[EqlSearchResponse](./EqlSearchResponse.md)>;` | Get EQL search results. Returns search results for an Event Query Language (EQL) query. EQL assumes each document in a data stream or index corresponds to an event. || `search` | `search(this: [That](./That.md), params: [EqlSearchRequest](./EqlSearchRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[EqlSearchResponse](./EqlSearchResponse.md), unknown>>;` |   || `search` | `search(this: [That](./That.md), params: [EqlSearchRequest](./EqlSearchRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[EqlSearchResponse](./EqlSearchResponse.md)>;` |   | \ No newline at end of file +| `delete` | `delete(this: [That](./That.md), params: [EqlDeleteRequest](./EqlDeleteRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[EqlDeleteResponse](./EqlDeleteResponse.md)>;` | Delete an async EQL search. Delete an async EQL search or a stored synchronous EQL search. The API also deletes results for the search. | +| `delete` | `delete(this: [That](./That.md), params: [EqlDeleteRequest](./EqlDeleteRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[EqlDeleteResponse](./EqlDeleteResponse.md), unknown>>;` |   | +| `delete` | `delete(this: [That](./That.md), params: [EqlDeleteRequest](./EqlDeleteRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[EqlDeleteResponse](./EqlDeleteResponse.md)>;` |   | +| `get` | `get(this: [That](./That.md), params: [EqlGetRequest](./EqlGetRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[EqlGetResponse](./EqlGetResponse.md)>;` | Get async EQL search results. Get the current status and available results for an async EQL search or a stored synchronous EQL search. | +| `get` | `get(this: [That](./That.md), params: [EqlGetRequest](./EqlGetRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[EqlGetResponse](./EqlGetResponse.md), unknown>>;` |   | +| `get` | `get(this: [That](./That.md), params: [EqlGetRequest](./EqlGetRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[EqlGetResponse](./EqlGetResponse.md)>;` |   | +| `getStatus` | `getStatus(this: [That](./That.md), params: [EqlGetStatusRequest](./EqlGetStatusRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[EqlGetStatusResponse](./EqlGetStatusResponse.md)>;` | Get the async EQL status. Get the current status for an async EQL search or a stored synchronous EQL search without returning results. | +| `getStatus` | `getStatus(this: [That](./That.md), params: [EqlGetStatusRequest](./EqlGetStatusRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[EqlGetStatusResponse](./EqlGetStatusResponse.md), unknown>>;` |   | +| `getStatus` | `getStatus(this: [That](./That.md), params: [EqlGetStatusRequest](./EqlGetStatusRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[EqlGetStatusResponse](./EqlGetStatusResponse.md)>;` |   | +| `search` | `search(this: [That](./That.md), params: [EqlSearchRequest](./EqlSearchRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[EqlSearchResponse](./EqlSearchResponse.md)>;` | Get EQL search results. Returns search results for an Event Query Language (EQL) query. EQL assumes each document in a data stream or index corresponds to an event. | +| `search` | `search(this: [That](./That.md), params: [EqlSearchRequest](./EqlSearchRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[EqlSearchResponse](./EqlSearchResponse.md), unknown>>;` |   | +| `search` | `search(this: [That](./That.md), params: [EqlSearchRequest](./EqlSearchRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[EqlSearchResponse](./EqlSearchResponse.md)>;` |   | diff --git a/docs/reference/api/Esql.md b/docs/reference/api/Esql.md index 41530489f..07efa8c27 100644 --- a/docs/reference/api/Esql.md +++ b/docs/reference/api/Esql.md @@ -17,4 +17,24 @@ new Esql(transport: [Transport](./Transport.md)); | Name | Signature | Description | | - | - | - | -| `asyncQuery` | `asyncQuery(this: [That](./That.md), params: [EsqlAsyncQueryRequest](./EsqlAsyncQueryRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[EsqlAsyncQueryResponse](./EsqlAsyncQueryResponse.md)>;` | Run an async ES|QL query. Asynchronously run an ES|QL (Elasticsearch query language) query, monitor its progress, and retrieve results when they become available. The API accepts the same parameters and request body as the synchronous query API, along with additional async related properties. || `asyncQuery` | `asyncQuery(this: [That](./That.md), params: [EsqlAsyncQueryRequest](./EsqlAsyncQueryRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[EsqlAsyncQueryResponse](./EsqlAsyncQueryResponse.md), unknown>>;` |   || `asyncQuery` | `asyncQuery(this: [That](./That.md), params: [EsqlAsyncQueryRequest](./EsqlAsyncQueryRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[EsqlAsyncQueryResponse](./EsqlAsyncQueryResponse.md)>;` |   || `asyncQueryDelete` | `asyncQueryDelete(this: [That](./That.md), params: [EsqlAsyncQueryDeleteRequest](./EsqlAsyncQueryDeleteRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[EsqlAsyncQueryDeleteResponse](./EsqlAsyncQueryDeleteResponse.md)>;` | Delete an async ES|QL query. If the query is still running, it is cancelled. Otherwise, the stored results are deleted. If the Elasticsearch security features are enabled, only the following users can use this API to delete a query: * The authenticated user that submitted the original query request * Users with the `cancel_task` cluster privilege || `asyncQueryDelete` | `asyncQueryDelete(this: [That](./That.md), params: [EsqlAsyncQueryDeleteRequest](./EsqlAsyncQueryDeleteRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[EsqlAsyncQueryDeleteResponse](./EsqlAsyncQueryDeleteResponse.md), unknown>>;` |   || `asyncQueryDelete` | `asyncQueryDelete(this: [That](./That.md), params: [EsqlAsyncQueryDeleteRequest](./EsqlAsyncQueryDeleteRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[EsqlAsyncQueryDeleteResponse](./EsqlAsyncQueryDeleteResponse.md)>;` |   || `asyncQueryGet` | `asyncQueryGet(this: [That](./That.md), params: [EsqlAsyncQueryGetRequest](./EsqlAsyncQueryGetRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[EsqlAsyncQueryGetResponse](./EsqlAsyncQueryGetResponse.md)>;` | Get async ES|QL query results. Get the current status and available results or stored results for an ES|QL asynchronous query. If the Elasticsearch security features are enabled, only the user who first submitted the ES|QL query can retrieve the results using this API. || `asyncQueryGet` | `asyncQueryGet(this: [That](./That.md), params: [EsqlAsyncQueryGetRequest](./EsqlAsyncQueryGetRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[EsqlAsyncQueryGetResponse](./EsqlAsyncQueryGetResponse.md), unknown>>;` |   || `asyncQueryGet` | `asyncQueryGet(this: [That](./That.md), params: [EsqlAsyncQueryGetRequest](./EsqlAsyncQueryGetRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[EsqlAsyncQueryGetResponse](./EsqlAsyncQueryGetResponse.md)>;` |   || `asyncQueryStop` | `asyncQueryStop(this: [That](./That.md), params: [EsqlAsyncQueryStopRequest](./EsqlAsyncQueryStopRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[EsqlAsyncQueryStopResponse](./EsqlAsyncQueryStopResponse.md)>;` | Stop async ES|QL query. This API interrupts the query execution and returns the results so far. If the Elasticsearch security features are enabled, only the user who first submitted the ES|QL query can stop it. || `asyncQueryStop` | `asyncQueryStop(this: [That](./That.md), params: [EsqlAsyncQueryStopRequest](./EsqlAsyncQueryStopRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[EsqlAsyncQueryStopResponse](./EsqlAsyncQueryStopResponse.md), unknown>>;` |   || `asyncQueryStop` | `asyncQueryStop(this: [That](./That.md), params: [EsqlAsyncQueryStopRequest](./EsqlAsyncQueryStopRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[EsqlAsyncQueryStopResponse](./EsqlAsyncQueryStopResponse.md)>;` |   || `getQuery` | `getQuery(this: [That](./That.md), params: [EsqlGetQueryRequest](./EsqlGetQueryRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[EsqlGetQueryResponse](./EsqlGetQueryResponse.md)>;` | Get a specific running ES|QL query information. Returns an object extended information about a running ES|QL query. || `getQuery` | `getQuery(this: [That](./That.md), params: [EsqlGetQueryRequest](./EsqlGetQueryRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[EsqlGetQueryResponse](./EsqlGetQueryResponse.md), unknown>>;` |   || `getQuery` | `getQuery(this: [That](./That.md), params: [EsqlGetQueryRequest](./EsqlGetQueryRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[EsqlGetQueryResponse](./EsqlGetQueryResponse.md)>;` |   || `listQueries` | `listQueries(this: [That](./That.md), params?: [EsqlListQueriesRequest](./EsqlListQueriesRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[EsqlListQueriesResponse](./EsqlListQueriesResponse.md)>;` | Get running ES|QL queries information. Returns an object containing IDs and other information about the running ES|QL queries. || `listQueries` | `listQueries(this: [That](./That.md), params?: [EsqlListQueriesRequest](./EsqlListQueriesRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[EsqlListQueriesResponse](./EsqlListQueriesResponse.md), unknown>>;` |   || `listQueries` | `listQueries(this: [That](./That.md), params?: [EsqlListQueriesRequest](./EsqlListQueriesRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[EsqlListQueriesResponse](./EsqlListQueriesResponse.md)>;` |   || `query` | `query(this: [That](./That.md), params: [EsqlQueryRequest](./EsqlQueryRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[EsqlQueryResponse](./EsqlQueryResponse.md)>;` | Run an ES|QL query. Get search results for an ES|QL (Elasticsearch query language) query. || `query` | `query(this: [That](./That.md), params: [EsqlQueryRequest](./EsqlQueryRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[EsqlQueryResponse](./EsqlQueryResponse.md), unknown>>;` |   || `query` | `query(this: [That](./That.md), params: [EsqlQueryRequest](./EsqlQueryRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[EsqlQueryResponse](./EsqlQueryResponse.md)>;` |   | \ No newline at end of file +| `asyncQuery` | `asyncQuery(this: [That](./That.md), params: [EsqlAsyncQueryRequest](./EsqlAsyncQueryRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[EsqlAsyncQueryResponse](./EsqlAsyncQueryResponse.md)>;` | Run an async ES|QL query. Asynchronously run an ES|QL (Elasticsearch query language) query, monitor its progress, and retrieve results when they become available. The API accepts the same parameters and request body as the synchronous query API, along with additional async related properties. | +| `asyncQuery` | `asyncQuery(this: [That](./That.md), params: [EsqlAsyncQueryRequest](./EsqlAsyncQueryRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[EsqlAsyncQueryResponse](./EsqlAsyncQueryResponse.md), unknown>>;` |   | +| `asyncQuery` | `asyncQuery(this: [That](./That.md), params: [EsqlAsyncQueryRequest](./EsqlAsyncQueryRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[EsqlAsyncQueryResponse](./EsqlAsyncQueryResponse.md)>;` |   | +| `asyncQueryDelete` | `asyncQueryDelete(this: [That](./That.md), params: [EsqlAsyncQueryDeleteRequest](./EsqlAsyncQueryDeleteRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[EsqlAsyncQueryDeleteResponse](./EsqlAsyncQueryDeleteResponse.md)>;` | Delete an async ES|QL query. If the query is still running, it is cancelled. Otherwise, the stored results are deleted. If the Elasticsearch security features are enabled, only the following users can use this API to delete a query: * The authenticated user that submitted the original query request * Users with the `cancel_task` cluster privilege | +| `asyncQueryDelete` | `asyncQueryDelete(this: [That](./That.md), params: [EsqlAsyncQueryDeleteRequest](./EsqlAsyncQueryDeleteRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[EsqlAsyncQueryDeleteResponse](./EsqlAsyncQueryDeleteResponse.md), unknown>>;` |   | +| `asyncQueryDelete` | `asyncQueryDelete(this: [That](./That.md), params: [EsqlAsyncQueryDeleteRequest](./EsqlAsyncQueryDeleteRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[EsqlAsyncQueryDeleteResponse](./EsqlAsyncQueryDeleteResponse.md)>;` |   | +| `asyncQueryGet` | `asyncQueryGet(this: [That](./That.md), params: [EsqlAsyncQueryGetRequest](./EsqlAsyncQueryGetRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[EsqlAsyncQueryGetResponse](./EsqlAsyncQueryGetResponse.md)>;` | Get async ES|QL query results. Get the current status and available results or stored results for an ES|QL asynchronous query. If the Elasticsearch security features are enabled, only the user who first submitted the ES|QL query can retrieve the results using this API. | +| `asyncQueryGet` | `asyncQueryGet(this: [That](./That.md), params: [EsqlAsyncQueryGetRequest](./EsqlAsyncQueryGetRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[EsqlAsyncQueryGetResponse](./EsqlAsyncQueryGetResponse.md), unknown>>;` |   | +| `asyncQueryGet` | `asyncQueryGet(this: [That](./That.md), params: [EsqlAsyncQueryGetRequest](./EsqlAsyncQueryGetRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[EsqlAsyncQueryGetResponse](./EsqlAsyncQueryGetResponse.md)>;` |   | +| `asyncQueryStop` | `asyncQueryStop(this: [That](./That.md), params: [EsqlAsyncQueryStopRequest](./EsqlAsyncQueryStopRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[EsqlAsyncQueryStopResponse](./EsqlAsyncQueryStopResponse.md)>;` | Stop async ES|QL query. This API interrupts the query execution and returns the results so far. If the Elasticsearch security features are enabled, only the user who first submitted the ES|QL query can stop it. | +| `asyncQueryStop` | `asyncQueryStop(this: [That](./That.md), params: [EsqlAsyncQueryStopRequest](./EsqlAsyncQueryStopRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[EsqlAsyncQueryStopResponse](./EsqlAsyncQueryStopResponse.md), unknown>>;` |   | +| `asyncQueryStop` | `asyncQueryStop(this: [That](./That.md), params: [EsqlAsyncQueryStopRequest](./EsqlAsyncQueryStopRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[EsqlAsyncQueryStopResponse](./EsqlAsyncQueryStopResponse.md)>;` |   | +| `getQuery` | `getQuery(this: [That](./That.md), params: [EsqlGetQueryRequest](./EsqlGetQueryRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[EsqlGetQueryResponse](./EsqlGetQueryResponse.md)>;` | Get a specific running ES|QL query information. Returns an object extended information about a running ES|QL query. | +| `getQuery` | `getQuery(this: [That](./That.md), params: [EsqlGetQueryRequest](./EsqlGetQueryRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[EsqlGetQueryResponse](./EsqlGetQueryResponse.md), unknown>>;` |   | +| `getQuery` | `getQuery(this: [That](./That.md), params: [EsqlGetQueryRequest](./EsqlGetQueryRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[EsqlGetQueryResponse](./EsqlGetQueryResponse.md)>;` |   | +| `listQueries` | `listQueries(this: [That](./That.md), params?: [EsqlListQueriesRequest](./EsqlListQueriesRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[EsqlListQueriesResponse](./EsqlListQueriesResponse.md)>;` | Get running ES|QL queries information. Returns an object containing IDs and other information about the running ES|QL queries. | +| `listQueries` | `listQueries(this: [That](./That.md), params?: [EsqlListQueriesRequest](./EsqlListQueriesRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[EsqlListQueriesResponse](./EsqlListQueriesResponse.md), unknown>>;` |   | +| `listQueries` | `listQueries(this: [That](./That.md), params?: [EsqlListQueriesRequest](./EsqlListQueriesRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[EsqlListQueriesResponse](./EsqlListQueriesResponse.md)>;` |   | +| `query` | `query(this: [That](./That.md), params: [EsqlQueryRequest](./EsqlQueryRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[EsqlQueryResponse](./EsqlQueryResponse.md)>;` | Run an ES|QL query. Get search results for an ES|QL (Elasticsearch query language) query. | +| `query` | `query(this: [That](./That.md), params: [EsqlQueryRequest](./EsqlQueryRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[EsqlQueryResponse](./EsqlQueryResponse.md), unknown>>;` |   | +| `query` | `query(this: [That](./That.md), params: [EsqlQueryRequest](./EsqlQueryRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[EsqlQueryResponse](./EsqlQueryResponse.md)>;` |   | diff --git a/docs/reference/api/Features.md b/docs/reference/api/Features.md index 09c0b79b0..2a0018124 100644 --- a/docs/reference/api/Features.md +++ b/docs/reference/api/Features.md @@ -17,4 +17,9 @@ new Features(transport: [Transport](./Transport.md)); | Name | Signature | Description | | - | - | - | -| `getFeatures` | `getFeatures(this: [That](./That.md), params?: [FeaturesGetFeaturesRequest](./FeaturesGetFeaturesRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[FeaturesGetFeaturesResponse](./FeaturesGetFeaturesResponse.md)>;` | Get the features. Get a list of features that can be included in snapshots using the `feature_states` field when creating a snapshot. You can use this API to determine which feature states to include when taking a snapshot. By default, all feature states are included in a snapshot if that snapshot includes the global state, or none if it does not. A feature state includes one or more system indices necessary for a given feature to function. In order to ensure data integrity, all system indices that comprise a feature state are snapshotted and restored together. The features listed by this API are a combination of built-in features and features defined by plugins. In order for a feature state to be listed in this API and recognized as a valid feature state by the create snapshot API, the plugin that defines that feature must be installed on the master node. || `getFeatures` | `getFeatures(this: [That](./That.md), params?: [FeaturesGetFeaturesRequest](./FeaturesGetFeaturesRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[FeaturesGetFeaturesResponse](./FeaturesGetFeaturesResponse.md), unknown>>;` |   || `getFeatures` | `getFeatures(this: [That](./That.md), params?: [FeaturesGetFeaturesRequest](./FeaturesGetFeaturesRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[FeaturesGetFeaturesResponse](./FeaturesGetFeaturesResponse.md)>;` |   || `resetFeatures` | `resetFeatures(this: [That](./That.md), params?: [FeaturesResetFeaturesRequest](./FeaturesResetFeaturesRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[FeaturesResetFeaturesResponse](./FeaturesResetFeaturesResponse.md)>;` | Reset the features. Clear all of the state information stored in system indices by Elasticsearch features, including the security and machine learning indices. WARNING: Intended for development and testing use only. Do not reset features on a production cluster. Return a cluster to the same state as a new installation by resetting the feature state for all Elasticsearch features. This deletes all state information stored in system indices. The response code is HTTP 200 if the state is successfully reset for all features. It is HTTP 500 if the reset operation failed for any feature. Note that select features might provide a way to reset particular system indices. Using this API resets all features, both those that are built-in and implemented as plugins. To list the features that will be affected, use the get features API. IMPORTANT: The features installed on the node you submit this request to are the features that will be reset. Run on the master node if you have any doubts about which plugins are installed on individual nodes. || `resetFeatures` | `resetFeatures(this: [That](./That.md), params?: [FeaturesResetFeaturesRequest](./FeaturesResetFeaturesRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[FeaturesResetFeaturesResponse](./FeaturesResetFeaturesResponse.md), unknown>>;` |   || `resetFeatures` | `resetFeatures(this: [That](./That.md), params?: [FeaturesResetFeaturesRequest](./FeaturesResetFeaturesRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[FeaturesResetFeaturesResponse](./FeaturesResetFeaturesResponse.md)>;` |   | \ No newline at end of file +| `getFeatures` | `getFeatures(this: [That](./That.md), params?: [FeaturesGetFeaturesRequest](./FeaturesGetFeaturesRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[FeaturesGetFeaturesResponse](./FeaturesGetFeaturesResponse.md)>;` | Get the features. Get a list of features that can be included in snapshots using the `feature_states` field when creating a snapshot. You can use this API to determine which feature states to include when taking a snapshot. By default, all feature states are included in a snapshot if that snapshot includes the global state, or none if it does not. A feature state includes one or more system indices necessary for a given feature to function. In order to ensure data integrity, all system indices that comprise a feature state are snapshotted and restored together. The features listed by this API are a combination of built-in features and features defined by plugins. In order for a feature state to be listed in this API and recognized as a valid feature state by the create snapshot API, the plugin that defines that feature must be installed on the master node. | +| `getFeatures` | `getFeatures(this: [That](./That.md), params?: [FeaturesGetFeaturesRequest](./FeaturesGetFeaturesRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[FeaturesGetFeaturesResponse](./FeaturesGetFeaturesResponse.md), unknown>>;` |   | +| `getFeatures` | `getFeatures(this: [That](./That.md), params?: [FeaturesGetFeaturesRequest](./FeaturesGetFeaturesRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[FeaturesGetFeaturesResponse](./FeaturesGetFeaturesResponse.md)>;` |   | +| `resetFeatures` | `resetFeatures(this: [That](./That.md), params?: [FeaturesResetFeaturesRequest](./FeaturesResetFeaturesRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[FeaturesResetFeaturesResponse](./FeaturesResetFeaturesResponse.md)>;` | Reset the features. Clear all of the state information stored in system indices by Elasticsearch features, including the security and machine learning indices. WARNING: Intended for development and testing use only. Do not reset features on a production cluster. Return a cluster to the same state as a new installation by resetting the feature state for all Elasticsearch features. This deletes all state information stored in system indices. The response code is HTTP 200 if the state is successfully reset for all features. It is HTTP 500 if the reset operation failed for any feature. Note that select features might provide a way to reset particular system indices. Using this API resets all features, both those that are built-in and implemented as plugins. To list the features that will be affected, use the get features API. IMPORTANT: The features installed on the node you submit this request to are the features that will be reset. Run on the master node if you have any doubts about which plugins are installed on individual nodes. | +| `resetFeatures` | `resetFeatures(this: [That](./That.md), params?: [FeaturesResetFeaturesRequest](./FeaturesResetFeaturesRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[FeaturesResetFeaturesResponse](./FeaturesResetFeaturesResponse.md), unknown>>;` |   | +| `resetFeatures` | `resetFeatures(this: [That](./That.md), params?: [FeaturesResetFeaturesRequest](./FeaturesResetFeaturesRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[FeaturesResetFeaturesResponse](./FeaturesResetFeaturesResponse.md)>;` |   | diff --git a/docs/reference/api/Fleet.md b/docs/reference/api/Fleet.md index 99e9067ed..7d3039d14 100644 --- a/docs/reference/api/Fleet.md +++ b/docs/reference/api/Fleet.md @@ -17,4 +17,21 @@ new Fleet(transport: [Transport](./Transport.md)); | Name | Signature | Description | | - | - | - | -| `deleteSecret` | `deleteSecret(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TODO](./TODO.md)>;` | Deletes a secret stored by Fleet. || `deleteSecret` | `deleteSecret(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TODO](./TODO.md), unknown>>;` |   || `deleteSecret` | `deleteSecret(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TODO](./TODO.md)>;` |   || `getSecret` | `getSecret(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TODO](./TODO.md)>;` | Retrieves a secret stored by Fleet. || `getSecret` | `getSecret(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TODO](./TODO.md), unknown>>;` |   || `getSecret` | `getSecret(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TODO](./TODO.md)>;` |   || `globalCheckpoints` | `globalCheckpoints(this: [That](./That.md), params: [FleetGlobalCheckpointsRequest](./FleetGlobalCheckpointsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[FleetGlobalCheckpointsResponse](./FleetGlobalCheckpointsResponse.md)>;` | Get global checkpoints. Get the current global checkpoints for an index. This API is designed for internal use by the Fleet server project. || `globalCheckpoints` | `globalCheckpoints(this: [That](./That.md), params: [FleetGlobalCheckpointsRequest](./FleetGlobalCheckpointsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[FleetGlobalCheckpointsResponse](./FleetGlobalCheckpointsResponse.md), unknown>>;` |   || `globalCheckpoints` | `globalCheckpoints(this: [That](./That.md), params: [FleetGlobalCheckpointsRequest](./FleetGlobalCheckpointsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[FleetGlobalCheckpointsResponse](./FleetGlobalCheckpointsResponse.md)>;` |   || `msearch` | `msearch(this: [That](./That.md), params: [FleetMsearchRequest](./FleetMsearchRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[FleetMsearchResponse](./FleetMsearchResponse.md)>;` | Run multiple Fleet searches. Run several Fleet searches with a single API request. The API follows the same structure as the multi search API. However, similar to the Fleet search API, it supports the `wait_for_checkpoints` parameter. || `msearch` | `msearch(this: [That](./That.md), params: [FleetMsearchRequest](./FleetMsearchRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[FleetMsearchResponse](./FleetMsearchResponse.md), unknown>>;` |   || `msearch` | `msearch(this: [That](./That.md), params: [FleetMsearchRequest](./FleetMsearchRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[FleetMsearchResponse](./FleetMsearchResponse.md)>;` |   || `postSecret` | `postSecret(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TODO](./TODO.md)>;` | Creates a secret stored by Fleet. || `postSecret` | `postSecret(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TODO](./TODO.md), unknown>>;` |   || `postSecret` | `postSecret(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TODO](./TODO.md)>;` |   || `search` | `search(this: [That](./That.md), params: [FleetSearchRequest](./FleetSearchRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[FleetSearchResponse](./FleetSearchResponse.md)>;` | Run a Fleet search. The purpose of the Fleet search API is to provide an API where the search will be run only after the provided checkpoint has been processed and is visible for searches inside of Elasticsearch. || `search` | `search(this: [That](./That.md), params: [FleetSearchRequest](./FleetSearchRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[FleetSearchResponse](./FleetSearchResponse.md), unknown>>;` |   || `search` | `search(this: [That](./That.md), params: [FleetSearchRequest](./FleetSearchRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[FleetSearchResponse](./FleetSearchResponse.md)>;` |   | \ No newline at end of file +| `deleteSecret` | `deleteSecret(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TODO](./TODO.md)>;` | Deletes a secret stored by Fleet. | +| `deleteSecret` | `deleteSecret(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TODO](./TODO.md), unknown>>;` |   | +| `deleteSecret` | `deleteSecret(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TODO](./TODO.md)>;` |   | +| `getSecret` | `getSecret(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TODO](./TODO.md)>;` | Retrieves a secret stored by Fleet. | +| `getSecret` | `getSecret(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TODO](./TODO.md), unknown>>;` |   | +| `getSecret` | `getSecret(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TODO](./TODO.md)>;` |   | +| `globalCheckpoints` | `globalCheckpoints(this: [That](./That.md), params: [FleetGlobalCheckpointsRequest](./FleetGlobalCheckpointsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[FleetGlobalCheckpointsResponse](./FleetGlobalCheckpointsResponse.md)>;` | Get global checkpoints. Get the current global checkpoints for an index. This API is designed for internal use by the Fleet server project. | +| `globalCheckpoints` | `globalCheckpoints(this: [That](./That.md), params: [FleetGlobalCheckpointsRequest](./FleetGlobalCheckpointsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[FleetGlobalCheckpointsResponse](./FleetGlobalCheckpointsResponse.md), unknown>>;` |   | +| `globalCheckpoints` | `globalCheckpoints(this: [That](./That.md), params: [FleetGlobalCheckpointsRequest](./FleetGlobalCheckpointsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[FleetGlobalCheckpointsResponse](./FleetGlobalCheckpointsResponse.md)>;` |   | +| `msearch` | `msearch(this: [That](./That.md), params: [FleetMsearchRequest](./FleetMsearchRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[FleetMsearchResponse](./FleetMsearchResponse.md)>;` | Run multiple Fleet searches. Run several Fleet searches with a single API request. The API follows the same structure as the multi search API. However, similar to the Fleet search API, it supports the `wait_for_checkpoints` parameter. | +| `msearch` | `msearch(this: [That](./That.md), params: [FleetMsearchRequest](./FleetMsearchRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[FleetMsearchResponse](./FleetMsearchResponse.md), unknown>>;` |   | +| `msearch` | `msearch(this: [That](./That.md), params: [FleetMsearchRequest](./FleetMsearchRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[FleetMsearchResponse](./FleetMsearchResponse.md)>;` |   | +| `postSecret` | `postSecret(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TODO](./TODO.md)>;` | Creates a secret stored by Fleet. | +| `postSecret` | `postSecret(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TODO](./TODO.md), unknown>>;` |   | +| `postSecret` | `postSecret(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TODO](./TODO.md)>;` |   | +| `search` | `search(this: [That](./That.md), params: [FleetSearchRequest](./FleetSearchRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[FleetSearchResponse](./FleetSearchResponse.md)>;` | Run a Fleet search. The purpose of the Fleet search API is to provide an API where the search will be run only after the provided checkpoint has been processed and is visible for searches inside of Elasticsearch. | +| `search` | `search(this: [That](./That.md), params: [FleetSearchRequest](./FleetSearchRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[FleetSearchResponse](./FleetSearchResponse.md), unknown>>;` |   | +| `search` | `search(this: [That](./That.md), params: [FleetSearchRequest](./FleetSearchRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[FleetSearchResponse](./FleetSearchResponse.md)>;` |   | diff --git a/docs/reference/api/Graph.md b/docs/reference/api/Graph.md index 060841fa4..2b86d64af 100644 --- a/docs/reference/api/Graph.md +++ b/docs/reference/api/Graph.md @@ -17,4 +17,6 @@ new Graph(transport: [Transport](./Transport.md)); | Name | Signature | Description | | - | - | - | -| `explore` | `explore(this: [That](./That.md), params: [GraphExploreRequest](./GraphExploreRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[GraphExploreResponse](./GraphExploreResponse.md)>;` | Explore graph analytics. Extract and summarize information about the documents and terms in an Elasticsearch data stream or index. The easiest way to understand the behavior of this API is to use the Graph UI to explore connections. An initial request to the `_explore` API contains a seed query that identifies the documents of interest and specifies the fields that define the vertices and connections you want to include in the graph. Subsequent requests enable you to spider out from one more vertices of interest. You can exclude vertices that have already been returned. || `explore` | `explore(this: [That](./That.md), params: [GraphExploreRequest](./GraphExploreRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[GraphExploreResponse](./GraphExploreResponse.md), unknown>>;` |   || `explore` | `explore(this: [That](./That.md), params: [GraphExploreRequest](./GraphExploreRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[GraphExploreResponse](./GraphExploreResponse.md)>;` |   | \ No newline at end of file +| `explore` | `explore(this: [That](./That.md), params: [GraphExploreRequest](./GraphExploreRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[GraphExploreResponse](./GraphExploreResponse.md)>;` | Explore graph analytics. Extract and summarize information about the documents and terms in an Elasticsearch data stream or index. The easiest way to understand the behavior of this API is to use the Graph UI to explore connections. An initial request to the `_explore` API contains a seed query that identifies the documents of interest and specifies the fields that define the vertices and connections you want to include in the graph. Subsequent requests enable you to spider out from one more vertices of interest. You can exclude vertices that have already been returned. | +| `explore` | `explore(this: [That](./That.md), params: [GraphExploreRequest](./GraphExploreRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[GraphExploreResponse](./GraphExploreResponse.md), unknown>>;` |   | +| `explore` | `explore(this: [That](./That.md), params: [GraphExploreRequest](./GraphExploreRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[GraphExploreResponse](./GraphExploreResponse.md)>;` |   | diff --git a/docs/reference/api/Helpers.md b/docs/reference/api/Helpers.md index c14e4e6a8..c4f7c1928 100644 --- a/docs/reference/api/Helpers.md +++ b/docs/reference/api/Helpers.md @@ -15,4 +15,9 @@ new Helpers(opts: [HelpersOptions](./HelpersOptions.md)); | Name | Signature | Description | | - | - | - | -| `bulk` | `bulk(options: [BulkHelperOptions](./BulkHelperOptions.md), reqOptions?: [TransportRequestOptions](./TransportRequestOptions.md)): [BulkHelper](./BulkHelper.md);` | Creates a bulk helper instance. Once you configure it, you can pick which operation to execute with the given dataset, index, create, update, and delete. || `esql` | `esql(params: [EsqlQueryRequest](./EsqlQueryRequest.md), reqOptions?: [TransportRequestOptions](./TransportRequestOptions.md)): [EsqlHelper](./EsqlHelper.md);` | Creates an ES|QL helper instance, to help transform the data returned by an ES|QL query into easy-to-use formats. || `msearch` | `msearch(options?: [MsearchHelperOptions](./MsearchHelperOptions.md), reqOptions?: [TransportRequestOptions](./TransportRequestOptions.md)): [MsearchHelper](./MsearchHelper.md);` | Creates a msearch helper instance. Once you configure it, you can use the provided `search` method to add new searches in the queue. || `scrollDocuments` | `scrollDocuments(params: [SearchRequest](./SearchRequest.md), options?: [ScrollSearchOptions](./ScrollSearchOptions.md)): [AsyncIterable](./AsyncIterable.md);` | Runs a scroll search operation. This function returns an async iterator, allowing the user to use a for await loop to get all the documents of a given search. Each document is what you will find by running a scrollSearch and iterating on the hits array. This helper automatically adds `filter_path=hits.hits._source` to the querystring, as it will only need the documents source. || `scrollSearch` | `scrollSearch(params: [SearchRequest](./SearchRequest.md), options?: [ScrollSearchOptions](./ScrollSearchOptions.md)): [AsyncIterable](./AsyncIterable.md)<[ScrollSearchResponse](./ScrollSearchResponse.md)>;` | Runs a scroll search operation. This function returns an async iterator, allowing the user to use a for await loop to get all the results of a given search. Each result represents the entire body of a single scroll search request, if you just need to scroll the results, use scrollDocuments. This function handles automatically retries on 429 status code. || `search` | `search(params: [SearchRequest](./SearchRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise>;` | Runs a search operation. The only difference between client.search and this utility, is that we are only returning the hits to the user and not the full ES response. This helper automatically adds `filter_path=hits.hits._source` to the querystring, as it will only need the documents source. | \ No newline at end of file +| `bulk` | `bulk(options: [BulkHelperOptions](./BulkHelperOptions.md), reqOptions?: [TransportRequestOptions](./TransportRequestOptions.md)): [BulkHelper](./BulkHelper.md);` | Creates a bulk helper instance. Once you configure it, you can pick which operation to execute with the given dataset, index, create, update, and delete. | +| `esql` | `esql(params: [EsqlQueryRequest](./EsqlQueryRequest.md), reqOptions?: [TransportRequestOptions](./TransportRequestOptions.md)): [EsqlHelper](./EsqlHelper.md);` | Creates an ES|QL helper instance, to help transform the data returned by an ES|QL query into easy-to-use formats. | +| `msearch` | `msearch(options?: [MsearchHelperOptions](./MsearchHelperOptions.md), reqOptions?: [TransportRequestOptions](./TransportRequestOptions.md)): [MsearchHelper](./MsearchHelper.md);` | Creates a msearch helper instance. Once you configure it, you can use the provided `search` method to add new searches in the queue. | +| `scrollDocuments` | `scrollDocuments(params: [SearchRequest](./SearchRequest.md), options?: [ScrollSearchOptions](./ScrollSearchOptions.md)): [AsyncIterable](./AsyncIterable.md);` | Runs a scroll search operation. This function returns an async iterator, allowing the user to use a for await loop to get all the documents of a given search. Each document is what you will find by running a scrollSearch and iterating on the hits array. This helper automatically adds `filter_path=hits.hits._source` to the querystring, as it will only need the documents source. | +| `scrollSearch` | `scrollSearch(params: [SearchRequest](./SearchRequest.md), options?: [ScrollSearchOptions](./ScrollSearchOptions.md)): [AsyncIterable](./AsyncIterable.md)<[ScrollSearchResponse](./ScrollSearchResponse.md)>;` | Runs a scroll search operation. This function returns an async iterator, allowing the user to use a for await loop to get all the results of a given search. Each result represents the entire body of a single scroll search request, if you just need to scroll the results, use scrollDocuments. This function handles automatically retries on 429 status code. | +| `search` | `search(params: [SearchRequest](./SearchRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise>;` | Runs a search operation. The only difference between client.search and this utility, is that we are only returning the hits to the user and not the full ES response. This helper automatically adds `filter_path=hits.hits._source` to the querystring, as it will only need the documents source. | diff --git a/docs/reference/api/Ilm.md b/docs/reference/api/Ilm.md index 86e21e219..ea99831c9 100644 --- a/docs/reference/api/Ilm.md +++ b/docs/reference/api/Ilm.md @@ -17,4 +17,36 @@ new Ilm(transport: [Transport](./Transport.md)); | Name | Signature | Description | | - | - | - | -| `deleteLifecycle` | `deleteLifecycle(this: [That](./That.md), params: [IlmDeleteLifecycleRequest](./IlmDeleteLifecycleRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[IlmDeleteLifecycleResponse](./IlmDeleteLifecycleResponse.md)>;` | Delete a lifecycle policy. You cannot delete policies that are currently in use. If the policy is being used to manage any indices, the request fails and returns an error. || `deleteLifecycle` | `deleteLifecycle(this: [That](./That.md), params: [IlmDeleteLifecycleRequest](./IlmDeleteLifecycleRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[IlmDeleteLifecycleResponse](./IlmDeleteLifecycleResponse.md), unknown>>;` |   || `deleteLifecycle` | `deleteLifecycle(this: [That](./That.md), params: [IlmDeleteLifecycleRequest](./IlmDeleteLifecycleRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[IlmDeleteLifecycleResponse](./IlmDeleteLifecycleResponse.md)>;` |   || `explainLifecycle` | `explainLifecycle(this: [That](./That.md), params: [IlmExplainLifecycleRequest](./IlmExplainLifecycleRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[IlmExplainLifecycleResponse](./IlmExplainLifecycleResponse.md)>;` | Explain the lifecycle state. Get the current lifecycle status for one or more indices. For data streams, the API retrieves the current lifecycle status for the stream's backing indices. The response indicates when the index entered each lifecycle state, provides the definition of the running phase, and information about any failures. || `explainLifecycle` | `explainLifecycle(this: [That](./That.md), params: [IlmExplainLifecycleRequest](./IlmExplainLifecycleRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[IlmExplainLifecycleResponse](./IlmExplainLifecycleResponse.md), unknown>>;` |   || `explainLifecycle` | `explainLifecycle(this: [That](./That.md), params: [IlmExplainLifecycleRequest](./IlmExplainLifecycleRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[IlmExplainLifecycleResponse](./IlmExplainLifecycleResponse.md)>;` |   || `getLifecycle` | `getLifecycle(this: [That](./That.md), params?: [IlmGetLifecycleRequest](./IlmGetLifecycleRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[IlmGetLifecycleResponse](./IlmGetLifecycleResponse.md)>;` | Get lifecycle policies. || `getLifecycle` | `getLifecycle(this: [That](./That.md), params?: [IlmGetLifecycleRequest](./IlmGetLifecycleRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[IlmGetLifecycleResponse](./IlmGetLifecycleResponse.md), unknown>>;` |   || `getLifecycle` | `getLifecycle(this: [That](./That.md), params?: [IlmGetLifecycleRequest](./IlmGetLifecycleRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[IlmGetLifecycleResponse](./IlmGetLifecycleResponse.md)>;` |   || `getStatus` | `getStatus(this: [That](./That.md), params?: [IlmGetStatusRequest](./IlmGetStatusRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[IlmGetStatusResponse](./IlmGetStatusResponse.md)>;` | Get the ILM status. Get the current index lifecycle management status. || `getStatus` | `getStatus(this: [That](./That.md), params?: [IlmGetStatusRequest](./IlmGetStatusRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[IlmGetStatusResponse](./IlmGetStatusResponse.md), unknown>>;` |   || `getStatus` | `getStatus(this: [That](./That.md), params?: [IlmGetStatusRequest](./IlmGetStatusRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[IlmGetStatusResponse](./IlmGetStatusResponse.md)>;` |   || `migrateToDataTiers` | `migrateToDataTiers(this: [That](./That.md), params?: [IlmMigrateToDataTiersRequest](./IlmMigrateToDataTiersRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[IlmMigrateToDataTiersResponse](./IlmMigrateToDataTiersResponse.md)>;` | Migrate to data tiers routing. Switch the indices, ILM policies, and legacy, composable, and component templates from using custom node attributes and attribute-based allocation filters to using data tiers. Optionally, delete one legacy index template. Using node roles enables ILM to automatically move the indices between data tiers. Migrating away from custom node attributes routing can be manually performed. This API provides an automated way of performing three out of the four manual steps listed in the migration guide: 1. Stop setting the custom hot attribute on new indices. 1. Remove custom allocation settings from existing ILM policies. 1. Replace custom allocation settings from existing indices with the corresponding tier preference. ILM must be stopped before performing the migration. Use the stop ILM and get ILM status APIs to wait until the reported operation mode is `STOPPED`. || `migrateToDataTiers` | `migrateToDataTiers(this: [That](./That.md), params?: [IlmMigrateToDataTiersRequest](./IlmMigrateToDataTiersRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[IlmMigrateToDataTiersResponse](./IlmMigrateToDataTiersResponse.md), unknown>>;` |   || `migrateToDataTiers` | `migrateToDataTiers(this: [That](./That.md), params?: [IlmMigrateToDataTiersRequest](./IlmMigrateToDataTiersRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[IlmMigrateToDataTiersResponse](./IlmMigrateToDataTiersResponse.md)>;` |   || `moveToStep` | `moveToStep(this: [That](./That.md), params: [IlmMoveToStepRequest](./IlmMoveToStepRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[IlmMoveToStepResponse](./IlmMoveToStepResponse.md)>;` | Move to a lifecycle step. Manually move an index into a specific step in the lifecycle policy and run that step. WARNING: This operation can result in the loss of data. Manually moving an index into a specific step runs that step even if it has already been performed. This is a potentially destructive action and this should be considered an expert level API. You must specify both the current step and the step to be executed in the body of the request. The request will fail if the current step does not match the step currently running for the index This is to prevent the index from being moved from an unexpected step into the next step. When specifying the target ( `next_step`) to which the index will be moved, either the name or both the action and name fields are optional. If only the phase is specified, the index will move to the first step of the first action in the target phase. If the phase and action are specified, the index will move to the first step of the specified action in the specified phase. Only actions specified in the ILM policy are considered valid. An index cannot move to a step that is not part of its policy. || `moveToStep` | `moveToStep(this: [That](./That.md), params: [IlmMoveToStepRequest](./IlmMoveToStepRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[IlmMoveToStepResponse](./IlmMoveToStepResponse.md), unknown>>;` |   || `moveToStep` | `moveToStep(this: [That](./That.md), params: [IlmMoveToStepRequest](./IlmMoveToStepRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[IlmMoveToStepResponse](./IlmMoveToStepResponse.md)>;` |   || `putLifecycle` | `putLifecycle(this: [That](./That.md), params: [IlmPutLifecycleRequest](./IlmPutLifecycleRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[IlmPutLifecycleResponse](./IlmPutLifecycleResponse.md)>;` | Create or update a lifecycle policy. If the specified policy exists, it is replaced and the policy version is incremented. NOTE: Only the latest version of the policy is stored, you cannot revert to previous versions. || `putLifecycle` | `putLifecycle(this: [That](./That.md), params: [IlmPutLifecycleRequest](./IlmPutLifecycleRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[IlmPutLifecycleResponse](./IlmPutLifecycleResponse.md), unknown>>;` |   || `putLifecycle` | `putLifecycle(this: [That](./That.md), params: [IlmPutLifecycleRequest](./IlmPutLifecycleRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[IlmPutLifecycleResponse](./IlmPutLifecycleResponse.md)>;` |   || `removePolicy` | `removePolicy(this: [That](./That.md), params: [IlmRemovePolicyRequest](./IlmRemovePolicyRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[IlmRemovePolicyResponse](./IlmRemovePolicyResponse.md)>;` | Remove policies from an index. Remove the assigned lifecycle policies from an index or a data stream's backing indices. It also stops managing the indices. || `removePolicy` | `removePolicy(this: [That](./That.md), params: [IlmRemovePolicyRequest](./IlmRemovePolicyRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[IlmRemovePolicyResponse](./IlmRemovePolicyResponse.md), unknown>>;` |   || `removePolicy` | `removePolicy(this: [That](./That.md), params: [IlmRemovePolicyRequest](./IlmRemovePolicyRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[IlmRemovePolicyResponse](./IlmRemovePolicyResponse.md)>;` |   || `retry` | `retry(this: [That](./That.md), params: [IlmRetryRequest](./IlmRetryRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[IlmRetryResponse](./IlmRetryResponse.md)>;` | Retry a policy. Retry running the lifecycle policy for an index that is in the ERROR step. The API sets the policy back to the step where the error occurred and runs the step. Use the explain lifecycle state API to determine whether an index is in the ERROR step. || `retry` | `retry(this: [That](./That.md), params: [IlmRetryRequest](./IlmRetryRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[IlmRetryResponse](./IlmRetryResponse.md), unknown>>;` |   || `retry` | `retry(this: [That](./That.md), params: [IlmRetryRequest](./IlmRetryRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[IlmRetryResponse](./IlmRetryResponse.md)>;` |   || `start` | `start(this: [That](./That.md), params?: [IlmStartRequest](./IlmStartRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[IlmStartResponse](./IlmStartResponse.md)>;` | Start the ILM plugin. Start the index lifecycle management plugin if it is currently stopped. ILM is started automatically when the cluster is formed. Restarting ILM is necessary only when it has been stopped using the stop ILM API. || `start` | `start(this: [That](./That.md), params?: [IlmStartRequest](./IlmStartRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[IlmStartResponse](./IlmStartResponse.md), unknown>>;` |   || `start` | `start(this: [That](./That.md), params?: [IlmStartRequest](./IlmStartRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[IlmStartResponse](./IlmStartResponse.md)>;` |   || `stop` | `stop(this: [That](./That.md), params?: [IlmStopRequest](./IlmStopRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[IlmStopResponse](./IlmStopResponse.md)>;` | Stop the ILM plugin. Halt all lifecycle management operations and stop the index lifecycle management plugin. This is useful when you are performing maintenance on the cluster and need to prevent ILM from performing any actions on your indices. The API returns as soon as the stop request has been acknowledged, but the plugin might continue to run until in-progress operations complete and the plugin can be safely stopped. Use the get ILM status API to check whether ILM is running. || `stop` | `stop(this: [That](./That.md), params?: [IlmStopRequest](./IlmStopRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[IlmStopResponse](./IlmStopResponse.md), unknown>>;` |   || `stop` | `stop(this: [That](./That.md), params?: [IlmStopRequest](./IlmStopRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[IlmStopResponse](./IlmStopResponse.md)>;` |   | \ No newline at end of file +| `deleteLifecycle` | `deleteLifecycle(this: [That](./That.md), params: [IlmDeleteLifecycleRequest](./IlmDeleteLifecycleRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[IlmDeleteLifecycleResponse](./IlmDeleteLifecycleResponse.md)>;` | Delete a lifecycle policy. You cannot delete policies that are currently in use. If the policy is being used to manage any indices, the request fails and returns an error. | +| `deleteLifecycle` | `deleteLifecycle(this: [That](./That.md), params: [IlmDeleteLifecycleRequest](./IlmDeleteLifecycleRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[IlmDeleteLifecycleResponse](./IlmDeleteLifecycleResponse.md), unknown>>;` |   | +| `deleteLifecycle` | `deleteLifecycle(this: [That](./That.md), params: [IlmDeleteLifecycleRequest](./IlmDeleteLifecycleRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[IlmDeleteLifecycleResponse](./IlmDeleteLifecycleResponse.md)>;` |   | +| `explainLifecycle` | `explainLifecycle(this: [That](./That.md), params: [IlmExplainLifecycleRequest](./IlmExplainLifecycleRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[IlmExplainLifecycleResponse](./IlmExplainLifecycleResponse.md)>;` | Explain the lifecycle state. Get the current lifecycle status for one or more indices. For data streams, the API retrieves the current lifecycle status for the stream's backing indices. The response indicates when the index entered each lifecycle state, provides the definition of the running phase, and information about any failures. | +| `explainLifecycle` | `explainLifecycle(this: [That](./That.md), params: [IlmExplainLifecycleRequest](./IlmExplainLifecycleRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[IlmExplainLifecycleResponse](./IlmExplainLifecycleResponse.md), unknown>>;` |   | +| `explainLifecycle` | `explainLifecycle(this: [That](./That.md), params: [IlmExplainLifecycleRequest](./IlmExplainLifecycleRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[IlmExplainLifecycleResponse](./IlmExplainLifecycleResponse.md)>;` |   | +| `getLifecycle` | `getLifecycle(this: [That](./That.md), params?: [IlmGetLifecycleRequest](./IlmGetLifecycleRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[IlmGetLifecycleResponse](./IlmGetLifecycleResponse.md)>;` | Get lifecycle policies. | +| `getLifecycle` | `getLifecycle(this: [That](./That.md), params?: [IlmGetLifecycleRequest](./IlmGetLifecycleRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[IlmGetLifecycleResponse](./IlmGetLifecycleResponse.md), unknown>>;` |   | +| `getLifecycle` | `getLifecycle(this: [That](./That.md), params?: [IlmGetLifecycleRequest](./IlmGetLifecycleRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[IlmGetLifecycleResponse](./IlmGetLifecycleResponse.md)>;` |   | +| `getStatus` | `getStatus(this: [That](./That.md), params?: [IlmGetStatusRequest](./IlmGetStatusRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[IlmGetStatusResponse](./IlmGetStatusResponse.md)>;` | Get the ILM status. Get the current index lifecycle management status. | +| `getStatus` | `getStatus(this: [That](./That.md), params?: [IlmGetStatusRequest](./IlmGetStatusRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[IlmGetStatusResponse](./IlmGetStatusResponse.md), unknown>>;` |   | +| `getStatus` | `getStatus(this: [That](./That.md), params?: [IlmGetStatusRequest](./IlmGetStatusRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[IlmGetStatusResponse](./IlmGetStatusResponse.md)>;` |   | +| `migrateToDataTiers` | `migrateToDataTiers(this: [That](./That.md), params?: [IlmMigrateToDataTiersRequest](./IlmMigrateToDataTiersRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[IlmMigrateToDataTiersResponse](./IlmMigrateToDataTiersResponse.md)>;` | Migrate to data tiers routing. Switch the indices, ILM policies, and legacy, composable, and component templates from using custom node attributes and attribute-based allocation filters to using data tiers. Optionally, delete one legacy index template. Using node roles enables ILM to automatically move the indices between data tiers. Migrating away from custom node attributes routing can be manually performed. This API provides an automated way of performing three out of the four manual steps listed in the migration guide: 1. Stop setting the custom hot attribute on new indices. 1. Remove custom allocation settings from existing ILM policies. 1. Replace custom allocation settings from existing indices with the corresponding tier preference. ILM must be stopped before performing the migration. Use the stop ILM and get ILM status APIs to wait until the reported operation mode is `STOPPED`. | +| `migrateToDataTiers` | `migrateToDataTiers(this: [That](./That.md), params?: [IlmMigrateToDataTiersRequest](./IlmMigrateToDataTiersRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[IlmMigrateToDataTiersResponse](./IlmMigrateToDataTiersResponse.md), unknown>>;` |   | +| `migrateToDataTiers` | `migrateToDataTiers(this: [That](./That.md), params?: [IlmMigrateToDataTiersRequest](./IlmMigrateToDataTiersRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[IlmMigrateToDataTiersResponse](./IlmMigrateToDataTiersResponse.md)>;` |   | +| `moveToStep` | `moveToStep(this: [That](./That.md), params: [IlmMoveToStepRequest](./IlmMoveToStepRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[IlmMoveToStepResponse](./IlmMoveToStepResponse.md)>;` | Move to a lifecycle step. Manually move an index into a specific step in the lifecycle policy and run that step. WARNING: This operation can result in the loss of data. Manually moving an index into a specific step runs that step even if it has already been performed. This is a potentially destructive action and this should be considered an expert level API. You must specify both the current step and the step to be executed in the body of the request. The request will fail if the current step does not match the step currently running for the index This is to prevent the index from being moved from an unexpected step into the next step. When specifying the target ( `next_step`) to which the index will be moved, either the name or both the action and name fields are optional. If only the phase is specified, the index will move to the first step of the first action in the target phase. If the phase and action are specified, the index will move to the first step of the specified action in the specified phase. Only actions specified in the ILM policy are considered valid. An index cannot move to a step that is not part of its policy. | +| `moveToStep` | `moveToStep(this: [That](./That.md), params: [IlmMoveToStepRequest](./IlmMoveToStepRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[IlmMoveToStepResponse](./IlmMoveToStepResponse.md), unknown>>;` |   | +| `moveToStep` | `moveToStep(this: [That](./That.md), params: [IlmMoveToStepRequest](./IlmMoveToStepRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[IlmMoveToStepResponse](./IlmMoveToStepResponse.md)>;` |   | +| `putLifecycle` | `putLifecycle(this: [That](./That.md), params: [IlmPutLifecycleRequest](./IlmPutLifecycleRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[IlmPutLifecycleResponse](./IlmPutLifecycleResponse.md)>;` | Create or update a lifecycle policy. If the specified policy exists, it is replaced and the policy version is incremented. NOTE: Only the latest version of the policy is stored, you cannot revert to previous versions. | +| `putLifecycle` | `putLifecycle(this: [That](./That.md), params: [IlmPutLifecycleRequest](./IlmPutLifecycleRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[IlmPutLifecycleResponse](./IlmPutLifecycleResponse.md), unknown>>;` |   | +| `putLifecycle` | `putLifecycle(this: [That](./That.md), params: [IlmPutLifecycleRequest](./IlmPutLifecycleRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[IlmPutLifecycleResponse](./IlmPutLifecycleResponse.md)>;` |   | +| `removePolicy` | `removePolicy(this: [That](./That.md), params: [IlmRemovePolicyRequest](./IlmRemovePolicyRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[IlmRemovePolicyResponse](./IlmRemovePolicyResponse.md)>;` | Remove policies from an index. Remove the assigned lifecycle policies from an index or a data stream's backing indices. It also stops managing the indices. | +| `removePolicy` | `removePolicy(this: [That](./That.md), params: [IlmRemovePolicyRequest](./IlmRemovePolicyRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[IlmRemovePolicyResponse](./IlmRemovePolicyResponse.md), unknown>>;` |   | +| `removePolicy` | `removePolicy(this: [That](./That.md), params: [IlmRemovePolicyRequest](./IlmRemovePolicyRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[IlmRemovePolicyResponse](./IlmRemovePolicyResponse.md)>;` |   | +| `retry` | `retry(this: [That](./That.md), params: [IlmRetryRequest](./IlmRetryRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[IlmRetryResponse](./IlmRetryResponse.md)>;` | Retry a policy. Retry running the lifecycle policy for an index that is in the ERROR step. The API sets the policy back to the step where the error occurred and runs the step. Use the explain lifecycle state API to determine whether an index is in the ERROR step. | +| `retry` | `retry(this: [That](./That.md), params: [IlmRetryRequest](./IlmRetryRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[IlmRetryResponse](./IlmRetryResponse.md), unknown>>;` |   | +| `retry` | `retry(this: [That](./That.md), params: [IlmRetryRequest](./IlmRetryRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[IlmRetryResponse](./IlmRetryResponse.md)>;` |   | +| `start` | `start(this: [That](./That.md), params?: [IlmStartRequest](./IlmStartRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[IlmStartResponse](./IlmStartResponse.md)>;` | Start the ILM plugin. Start the index lifecycle management plugin if it is currently stopped. ILM is started automatically when the cluster is formed. Restarting ILM is necessary only when it has been stopped using the stop ILM API. | +| `start` | `start(this: [That](./That.md), params?: [IlmStartRequest](./IlmStartRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[IlmStartResponse](./IlmStartResponse.md), unknown>>;` |   | +| `start` | `start(this: [That](./That.md), params?: [IlmStartRequest](./IlmStartRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[IlmStartResponse](./IlmStartResponse.md)>;` |   | +| `stop` | `stop(this: [That](./That.md), params?: [IlmStopRequest](./IlmStopRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[IlmStopResponse](./IlmStopResponse.md)>;` | Stop the ILM plugin. Halt all lifecycle management operations and stop the index lifecycle management plugin. This is useful when you are performing maintenance on the cluster and need to prevent ILM from performing any actions on your indices. The API returns as soon as the stop request has been acknowledged, but the plugin might continue to run until in-progress operations complete and the plugin can be safely stopped. Use the get ILM status API to check whether ILM is running. | +| `stop` | `stop(this: [That](./That.md), params?: [IlmStopRequest](./IlmStopRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[IlmStopResponse](./IlmStopResponse.md), unknown>>;` |   | +| `stop` | `stop(this: [That](./That.md), params?: [IlmStopRequest](./IlmStopRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[IlmStopResponse](./IlmStopResponse.md)>;` |   | diff --git a/docs/reference/api/Inference.md b/docs/reference/api/Inference.md index 6b8013990..7b75f0efa 100644 --- a/docs/reference/api/Inference.md +++ b/docs/reference/api/Inference.md @@ -17,4 +17,84 @@ new Inference(transport: [Transport](./Transport.md)); | Name | Signature | Description | | - | - | - | -| `chatCompletionUnified` | `chatCompletionUnified(this: [That](./That.md), params: [InferenceChatCompletionUnifiedRequest](./InferenceChatCompletionUnifiedRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[InferenceChatCompletionUnifiedResponse](./InferenceChatCompletionUnifiedResponse.md)>;` | Perform chat completion inference The chat completion inference API enables real-time responses for chat completion tasks by delivering answers incrementally, reducing response times during computation. It only works with the `chat_completion` task type for `openai` and `elastic` inference services. IMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Azure, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face. For built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models. However, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs. NOTE: The `chat_completion` task type is only available within the _stream API and only supports streaming. The Chat completion inference API and the Stream inference API differ in their response structure and capabilities. The Chat completion inference API provides more comprehensive customization options through more fields and function calling support. If you use the `openai` service or the `elastic` service, use the Chat completion inference API. || `chatCompletionUnified` | `chatCompletionUnified(this: [That](./That.md), params: [InferenceChatCompletionUnifiedRequest](./InferenceChatCompletionUnifiedRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[InferenceChatCompletionUnifiedResponse](./InferenceChatCompletionUnifiedResponse.md), unknown>>;` |   || `chatCompletionUnified` | `chatCompletionUnified(this: [That](./That.md), params: [InferenceChatCompletionUnifiedRequest](./InferenceChatCompletionUnifiedRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[InferenceChatCompletionUnifiedResponse](./InferenceChatCompletionUnifiedResponse.md)>;` |   || `completion` | `completion(this: [That](./That.md), params: [InferenceCompletionRequest](./InferenceCompletionRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[InferenceCompletionResponse](./InferenceCompletionResponse.md)>;` | Perform completion inference on the service || `completion` | `completion(this: [That](./That.md), params: [InferenceCompletionRequest](./InferenceCompletionRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[InferenceCompletionResponse](./InferenceCompletionResponse.md), unknown>>;` |   || `completion` | `completion(this: [That](./That.md), params: [InferenceCompletionRequest](./InferenceCompletionRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[InferenceCompletionResponse](./InferenceCompletionResponse.md)>;` |   || `delete` | `delete(this: [That](./That.md), params: [InferenceDeleteRequest](./InferenceDeleteRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[InferenceDeleteResponse](./InferenceDeleteResponse.md)>;` | Delete an inference endpoint || `delete` | `delete(this: [That](./That.md), params: [InferenceDeleteRequest](./InferenceDeleteRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[InferenceDeleteResponse](./InferenceDeleteResponse.md), unknown>>;` |   || `delete` | `delete(this: [That](./That.md), params: [InferenceDeleteRequest](./InferenceDeleteRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[InferenceDeleteResponse](./InferenceDeleteResponse.md)>;` |   || `get` | `get(this: [That](./That.md), params?: [InferenceGetRequest](./InferenceGetRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[InferenceGetResponse](./InferenceGetResponse.md)>;` | Get an inference endpoint || `get` | `get(this: [That](./That.md), params?: [InferenceGetRequest](./InferenceGetRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[InferenceGetResponse](./InferenceGetResponse.md), unknown>>;` |   || `get` | `get(this: [That](./That.md), params?: [InferenceGetRequest](./InferenceGetRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[InferenceGetResponse](./InferenceGetResponse.md)>;` |   || `inference` | `inference(this: [That](./That.md), params: [InferenceInferenceRequest](./InferenceInferenceRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[InferenceInferenceResponse](./InferenceInferenceResponse.md)>;` | Perform inference on the service. This API enables you to use machine learning models to perform specific tasks on data that you provide as an input. It returns a response with the results of the tasks. The inference endpoint you use can perform one specific task that has been defined when the endpoint was created with the create inference API. For details about using this API with a service, such as Amazon Bedrock, Anthropic, or HuggingFace, refer to the service-specific documentation. > info > The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Azure, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face. For built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models. However, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs. || `inference` | `inference(this: [That](./That.md), params: [InferenceInferenceRequest](./InferenceInferenceRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[InferenceInferenceResponse](./InferenceInferenceResponse.md), unknown>>;` |   || `inference` | `inference(this: [That](./That.md), params: [InferenceInferenceRequest](./InferenceInferenceRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[InferenceInferenceResponse](./InferenceInferenceResponse.md)>;` |   || `put` | `put(this: [That](./That.md), params: [InferencePutRequest](./InferencePutRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[InferencePutResponse](./InferencePutResponse.md)>;` | Create an inference endpoint. IMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Mistral, Azure OpenAI, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face. For built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models. However, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs. || `put` | `put(this: [That](./That.md), params: [InferencePutRequest](./InferencePutRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[InferencePutResponse](./InferencePutResponse.md), unknown>>;` |   || `put` | `put(this: [That](./That.md), params: [InferencePutRequest](./InferencePutRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[InferencePutResponse](./InferencePutResponse.md)>;` |   || `putAlibabacloud` | `putAlibabacloud(this: [That](./That.md), params: [InferencePutAlibabacloudRequest](./InferencePutAlibabacloudRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[InferencePutAlibabacloudResponse](./InferencePutAlibabacloudResponse.md)>;` | Create an AlibabaCloud AI Search inference endpoint. Create an inference endpoint to perform an inference task with the `alibabacloud-ai-search` service. || `putAlibabacloud` | `putAlibabacloud(this: [That](./That.md), params: [InferencePutAlibabacloudRequest](./InferencePutAlibabacloudRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[InferencePutAlibabacloudResponse](./InferencePutAlibabacloudResponse.md), unknown>>;` |   || `putAlibabacloud` | `putAlibabacloud(this: [That](./That.md), params: [InferencePutAlibabacloudRequest](./InferencePutAlibabacloudRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[InferencePutAlibabacloudResponse](./InferencePutAlibabacloudResponse.md)>;` |   || `putAmazonbedrock` | `putAmazonbedrock(this: [That](./That.md), params: [InferencePutAmazonbedrockRequest](./InferencePutAmazonbedrockRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[InferencePutAmazonbedrockResponse](./InferencePutAmazonbedrockResponse.md)>;` | Create an Amazon Bedrock inference endpoint. Creates an inference endpoint to perform an inference task with the `amazonbedrock` service. > info > You need to provide the access and secret keys only once, during the inference model creation. The get inference API does not retrieve your access or secret keys. After creating the inference model, you cannot change the associated key pairs. If you want to use a different access and secret key pair, delete the inference model and recreate it with the same name and the updated keys. || `putAmazonbedrock` | `putAmazonbedrock(this: [That](./That.md), params: [InferencePutAmazonbedrockRequest](./InferencePutAmazonbedrockRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[InferencePutAmazonbedrockResponse](./InferencePutAmazonbedrockResponse.md), unknown>>;` |   || `putAmazonbedrock` | `putAmazonbedrock(this: [That](./That.md), params: [InferencePutAmazonbedrockRequest](./InferencePutAmazonbedrockRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[InferencePutAmazonbedrockResponse](./InferencePutAmazonbedrockResponse.md)>;` |   || `putAnthropic` | `putAnthropic(this: [That](./That.md), params: [InferencePutAnthropicRequest](./InferencePutAnthropicRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[InferencePutAnthropicResponse](./InferencePutAnthropicResponse.md)>;` | Create an Anthropic inference endpoint. Create an inference endpoint to perform an inference task with the `anthropic` service. || `putAnthropic` | `putAnthropic(this: [That](./That.md), params: [InferencePutAnthropicRequest](./InferencePutAnthropicRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[InferencePutAnthropicResponse](./InferencePutAnthropicResponse.md), unknown>>;` |   || `putAnthropic` | `putAnthropic(this: [That](./That.md), params: [InferencePutAnthropicRequest](./InferencePutAnthropicRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[InferencePutAnthropicResponse](./InferencePutAnthropicResponse.md)>;` |   || `putAzureaistudio` | `putAzureaistudio(this: [That](./That.md), params: [InferencePutAzureaistudioRequest](./InferencePutAzureaistudioRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[InferencePutAzureaistudioResponse](./InferencePutAzureaistudioResponse.md)>;` | Create an Azure AI studio inference endpoint. Create an inference endpoint to perform an inference task with the `azureaistudio` service. || `putAzureaistudio` | `putAzureaistudio(this: [That](./That.md), params: [InferencePutAzureaistudioRequest](./InferencePutAzureaistudioRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[InferencePutAzureaistudioResponse](./InferencePutAzureaistudioResponse.md), unknown>>;` |   || `putAzureaistudio` | `putAzureaistudio(this: [That](./That.md), params: [InferencePutAzureaistudioRequest](./InferencePutAzureaistudioRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[InferencePutAzureaistudioResponse](./InferencePutAzureaistudioResponse.md)>;` |   || `putAzureopenai` | `putAzureopenai(this: [That](./That.md), params: [InferencePutAzureopenaiRequest](./InferencePutAzureopenaiRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[InferencePutAzureopenaiResponse](./InferencePutAzureopenaiResponse.md)>;` | Create an Azure OpenAI inference endpoint. Create an inference endpoint to perform an inference task with the `azureopenai` service. The list of chat completion models that you can choose from in your Azure OpenAI deployment include: * [GPT-4 and GPT-4 Turbo models](https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models?tabs=global-standard%2Cstandard-chat-completions#gpt-4-and-gpt-4-turbo-models) * [GPT-3.5](https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models?tabs=global-standard%2Cstandard-chat-completions#gpt-35) The list of embeddings models that you can choose from in your deployment can be found in the [Azure models documentation](https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models?tabs=global-standard%2Cstandard-chat-completions#embeddings). || `putAzureopenai` | `putAzureopenai(this: [That](./That.md), params: [InferencePutAzureopenaiRequest](./InferencePutAzureopenaiRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[InferencePutAzureopenaiResponse](./InferencePutAzureopenaiResponse.md), unknown>>;` |   || `putAzureopenai` | `putAzureopenai(this: [That](./That.md), params: [InferencePutAzureopenaiRequest](./InferencePutAzureopenaiRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[InferencePutAzureopenaiResponse](./InferencePutAzureopenaiResponse.md)>;` |   || `putCohere` | `putCohere(this: [That](./That.md), params: [InferencePutCohereRequest](./InferencePutCohereRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[InferencePutCohereResponse](./InferencePutCohereResponse.md)>;` | Create a Cohere inference endpoint. Create an inference endpoint to perform an inference task with the `cohere` service. || `putCohere` | `putCohere(this: [That](./That.md), params: [InferencePutCohereRequest](./InferencePutCohereRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[InferencePutCohereResponse](./InferencePutCohereResponse.md), unknown>>;` |   || `putCohere` | `putCohere(this: [That](./That.md), params: [InferencePutCohereRequest](./InferencePutCohereRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[InferencePutCohereResponse](./InferencePutCohereResponse.md)>;` |   || `putElasticsearch` | `putElasticsearch(this: [That](./That.md), params: [InferencePutElasticsearchRequest](./InferencePutElasticsearchRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[InferencePutElasticsearchResponse](./InferencePutElasticsearchResponse.md)>;` | Create an Elasticsearch inference endpoint. Create an inference endpoint to perform an inference task with the `elasticsearch` service. > info > Your Elasticsearch deployment contains preconfigured ELSER and E5 inference endpoints, you only need to create the enpoints using the API if you want to customize the settings. If you use the ELSER or the E5 model through the `elasticsearch` service, the API request will automatically download and deploy the model if it isn't downloaded yet. > info > You might see a 502 bad gateway error in the response when using the Kibana Console. This error usually just reflects a timeout, while the model downloads in the background. You can check the download progress in the Machine Learning UI. If using the Python client, you can set the timeout parameter to a higher value. After creating the endpoint, wait for the model deployment to complete before using it. To verify the deployment status, use the get trained model statistics API. Look for `"state": "fully_allocated"` in the response and ensure that the `"allocation_count"` matches the `"target_allocation_count"`. Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources. || `putElasticsearch` | `putElasticsearch(this: [That](./That.md), params: [InferencePutElasticsearchRequest](./InferencePutElasticsearchRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[InferencePutElasticsearchResponse](./InferencePutElasticsearchResponse.md), unknown>>;` |   || `putElasticsearch` | `putElasticsearch(this: [That](./That.md), params: [InferencePutElasticsearchRequest](./InferencePutElasticsearchRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[InferencePutElasticsearchResponse](./InferencePutElasticsearchResponse.md)>;` |   || `putElser` | `putElser(this: [That](./That.md), params: [InferencePutElserRequest](./InferencePutElserRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[InferencePutElserResponse](./InferencePutElserResponse.md)>;` | Create an ELSER inference endpoint. Create an inference endpoint to perform an inference task with the `elser` service. You can also deploy ELSER by using the Elasticsearch inference integration. > info > Your Elasticsearch deployment contains a preconfigured ELSER inference endpoint, you only need to create the enpoint using the API if you want to customize the settings. The API request will automatically download and deploy the ELSER model if it isn't already downloaded. > info > You might see a 502 bad gateway error in the response when using the Kibana Console. This error usually just reflects a timeout, while the model downloads in the background. You can check the download progress in the Machine Learning UI. If using the Python client, you can set the timeout parameter to a higher value. After creating the endpoint, wait for the model deployment to complete before using it. To verify the deployment status, use the get trained model statistics API. Look for `"state": "fully_allocated"` in the response and ensure that the `"allocation_count"` matches the `"target_allocation_count"`. Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources. || `putElser` | `putElser(this: [That](./That.md), params: [InferencePutElserRequest](./InferencePutElserRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[InferencePutElserResponse](./InferencePutElserResponse.md), unknown>>;` |   || `putElser` | `putElser(this: [That](./That.md), params: [InferencePutElserRequest](./InferencePutElserRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[InferencePutElserResponse](./InferencePutElserResponse.md)>;` |   || `putGoogleaistudio` | `putGoogleaistudio(this: [That](./That.md), params: [InferencePutGoogleaistudioRequest](./InferencePutGoogleaistudioRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[InferencePutGoogleaistudioResponse](./InferencePutGoogleaistudioResponse.md)>;` | Create an Google AI Studio inference endpoint. Create an inference endpoint to perform an inference task with the `googleaistudio` service. || `putGoogleaistudio` | `putGoogleaistudio(this: [That](./That.md), params: [InferencePutGoogleaistudioRequest](./InferencePutGoogleaistudioRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[InferencePutGoogleaistudioResponse](./InferencePutGoogleaistudioResponse.md), unknown>>;` |   || `putGoogleaistudio` | `putGoogleaistudio(this: [That](./That.md), params: [InferencePutGoogleaistudioRequest](./InferencePutGoogleaistudioRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[InferencePutGoogleaistudioResponse](./InferencePutGoogleaistudioResponse.md)>;` |   || `putGooglevertexai` | `putGooglevertexai(this: [That](./That.md), params: [InferencePutGooglevertexaiRequest](./InferencePutGooglevertexaiRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[InferencePutGooglevertexaiResponse](./InferencePutGooglevertexaiResponse.md)>;` | Create a Google Vertex AI inference endpoint. Create an inference endpoint to perform an inference task with the `googlevertexai` service. || `putGooglevertexai` | `putGooglevertexai(this: [That](./That.md), params: [InferencePutGooglevertexaiRequest](./InferencePutGooglevertexaiRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[InferencePutGooglevertexaiResponse](./InferencePutGooglevertexaiResponse.md), unknown>>;` |   || `putGooglevertexai` | `putGooglevertexai(this: [That](./That.md), params: [InferencePutGooglevertexaiRequest](./InferencePutGooglevertexaiRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[InferencePutGooglevertexaiResponse](./InferencePutGooglevertexaiResponse.md)>;` |   || `putHuggingFace` | `putHuggingFace(this: [That](./That.md), params: [InferencePutHuggingFaceRequest](./InferencePutHuggingFaceRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[InferencePutHuggingFaceResponse](./InferencePutHuggingFaceResponse.md)>;` | Create a Hugging Face inference endpoint. Create an inference endpoint to perform an inference task with the `hugging_face` service. You must first create an inference endpoint on the Hugging Face endpoint page to get an endpoint URL. Select the model you want to use on the new endpoint creation page (for example `intfloat/e5-small-v2`), then select the sentence embeddings task under the advanced configuration section. Create the endpoint and copy the URL after the endpoint initialization has been finished. The following models are recommended for the Hugging Face service: * `all-MiniLM-L6-v2` * `all-MiniLM-L12-v2` * `all-mpnet-base-v2` * `e5-base-v2` * `e5-small-v2` * `multilingual-e5-base` * `multilingual-e5-small` || `putHuggingFace` | `putHuggingFace(this: [That](./That.md), params: [InferencePutHuggingFaceRequest](./InferencePutHuggingFaceRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[InferencePutHuggingFaceResponse](./InferencePutHuggingFaceResponse.md), unknown>>;` |   || `putHuggingFace` | `putHuggingFace(this: [That](./That.md), params: [InferencePutHuggingFaceRequest](./InferencePutHuggingFaceRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[InferencePutHuggingFaceResponse](./InferencePutHuggingFaceResponse.md)>;` |   || `putJinaai` | `putJinaai(this: [That](./That.md), params: [InferencePutJinaaiRequest](./InferencePutJinaaiRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[InferencePutJinaaiResponse](./InferencePutJinaaiResponse.md)>;` | Create an JinaAI inference endpoint. Create an inference endpoint to perform an inference task with the `jinaai` service. To review the available `rerank` models, refer to < https://jina.ai/reranker > . To review the available `text_embedding` models, refer to the < https://jina.ai/embeddings/ > . || `putJinaai` | `putJinaai(this: [That](./That.md), params: [InferencePutJinaaiRequest](./InferencePutJinaaiRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[InferencePutJinaaiResponse](./InferencePutJinaaiResponse.md), unknown>>;` |   || `putJinaai` | `putJinaai(this: [That](./That.md), params: [InferencePutJinaaiRequest](./InferencePutJinaaiRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[InferencePutJinaaiResponse](./InferencePutJinaaiResponse.md)>;` |   || `putMistral` | `putMistral(this: [That](./That.md), params: [InferencePutMistralRequest](./InferencePutMistralRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[InferencePutMistralResponse](./InferencePutMistralResponse.md)>;` | Create a Mistral inference endpoint. Creates an inference endpoint to perform an inference task with the `mistral` service. || `putMistral` | `putMistral(this: [That](./That.md), params: [InferencePutMistralRequest](./InferencePutMistralRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[InferencePutMistralResponse](./InferencePutMistralResponse.md), unknown>>;` |   || `putMistral` | `putMistral(this: [That](./That.md), params: [InferencePutMistralRequest](./InferencePutMistralRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[InferencePutMistralResponse](./InferencePutMistralResponse.md)>;` |   || `putOpenai` | `putOpenai(this: [That](./That.md), params: [InferencePutOpenaiRequest](./InferencePutOpenaiRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[InferencePutOpenaiResponse](./InferencePutOpenaiResponse.md)>;` | Create an OpenAI inference endpoint. Create an inference endpoint to perform an inference task with the `openai` service or `openai` compatible APIs. || `putOpenai` | `putOpenai(this: [That](./That.md), params: [InferencePutOpenaiRequest](./InferencePutOpenaiRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[InferencePutOpenaiResponse](./InferencePutOpenaiResponse.md), unknown>>;` |   || `putOpenai` | `putOpenai(this: [That](./That.md), params: [InferencePutOpenaiRequest](./InferencePutOpenaiRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[InferencePutOpenaiResponse](./InferencePutOpenaiResponse.md)>;` |   || `putVoyageai` | `putVoyageai(this: [That](./That.md), params: [InferencePutVoyageaiRequest](./InferencePutVoyageaiRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[InferencePutVoyageaiResponse](./InferencePutVoyageaiResponse.md)>;` | Create a VoyageAI inference endpoint. Create an inference endpoint to perform an inference task with the `voyageai` service. Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources. || `putVoyageai` | `putVoyageai(this: [That](./That.md), params: [InferencePutVoyageaiRequest](./InferencePutVoyageaiRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[InferencePutVoyageaiResponse](./InferencePutVoyageaiResponse.md), unknown>>;` |   || `putVoyageai` | `putVoyageai(this: [That](./That.md), params: [InferencePutVoyageaiRequest](./InferencePutVoyageaiRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[InferencePutVoyageaiResponse](./InferencePutVoyageaiResponse.md)>;` |   || `putWatsonx` | `putWatsonx(this: [That](./That.md), params: [InferencePutWatsonxRequest](./InferencePutWatsonxRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[InferencePutWatsonxResponse](./InferencePutWatsonxResponse.md)>;` | Create a Watsonx inference endpoint. Create an inference endpoint to perform an inference task with the `watsonxai` service. You need an IBM Cloud Databases for Elasticsearch deployment to use the `watsonxai` inference service. You can provision one through the IBM catalog, the Cloud Databases CLI plug-in, the Cloud Databases API, or Terraform. || `putWatsonx` | `putWatsonx(this: [That](./That.md), params: [InferencePutWatsonxRequest](./InferencePutWatsonxRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[InferencePutWatsonxResponse](./InferencePutWatsonxResponse.md), unknown>>;` |   || `putWatsonx` | `putWatsonx(this: [That](./That.md), params: [InferencePutWatsonxRequest](./InferencePutWatsonxRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[InferencePutWatsonxResponse](./InferencePutWatsonxResponse.md)>;` |   || `rerank` | `rerank(this: [That](./That.md), params: [InferenceRerankRequest](./InferenceRerankRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[InferenceRerankResponse](./InferenceRerankResponse.md)>;` | Perform rereanking inference on the service || `rerank` | `rerank(this: [That](./That.md), params: [InferenceRerankRequest](./InferenceRerankRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[InferenceRerankResponse](./InferenceRerankResponse.md), unknown>>;` |   || `rerank` | `rerank(this: [That](./That.md), params: [InferenceRerankRequest](./InferenceRerankRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[InferenceRerankResponse](./InferenceRerankResponse.md)>;` |   || `sparseEmbedding` | `sparseEmbedding(this: [That](./That.md), params: [InferenceSparseEmbeddingRequest](./InferenceSparseEmbeddingRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[InferenceSparseEmbeddingResponse](./InferenceSparseEmbeddingResponse.md)>;` | Perform sparse embedding inference on the service || `sparseEmbedding` | `sparseEmbedding(this: [That](./That.md), params: [InferenceSparseEmbeddingRequest](./InferenceSparseEmbeddingRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[InferenceSparseEmbeddingResponse](./InferenceSparseEmbeddingResponse.md), unknown>>;` |   || `sparseEmbedding` | `sparseEmbedding(this: [That](./That.md), params: [InferenceSparseEmbeddingRequest](./InferenceSparseEmbeddingRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[InferenceSparseEmbeddingResponse](./InferenceSparseEmbeddingResponse.md)>;` |   || `streamCompletion` | `streamCompletion(this: [That](./That.md), params: [InferenceStreamCompletionRequest](./InferenceStreamCompletionRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[InferenceStreamCompletionResponse](./InferenceStreamCompletionResponse.md)>;` | Perform streaming inference. Get real-time responses for completion tasks by delivering answers incrementally, reducing response times during computation. This API works only with the completion task type. IMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Azure, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face. For built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models. However, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs. This API requires the `monitor_inference` cluster privilege (the built-in `inference_admin` and `inference_user` roles grant this privilege). You must use a client that supports streaming. || `streamCompletion` | `streamCompletion(this: [That](./That.md), params: [InferenceStreamCompletionRequest](./InferenceStreamCompletionRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[InferenceStreamCompletionResponse](./InferenceStreamCompletionResponse.md), unknown>>;` |   || `streamCompletion` | `streamCompletion(this: [That](./That.md), params: [InferenceStreamCompletionRequest](./InferenceStreamCompletionRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[InferenceStreamCompletionResponse](./InferenceStreamCompletionResponse.md)>;` |   || `textEmbedding` | `textEmbedding(this: [That](./That.md), params: [InferenceTextEmbeddingRequest](./InferenceTextEmbeddingRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[InferenceTextEmbeddingResponse](./InferenceTextEmbeddingResponse.md)>;` | Perform text embedding inference on the service || `textEmbedding` | `textEmbedding(this: [That](./That.md), params: [InferenceTextEmbeddingRequest](./InferenceTextEmbeddingRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[InferenceTextEmbeddingResponse](./InferenceTextEmbeddingResponse.md), unknown>>;` |   || `textEmbedding` | `textEmbedding(this: [That](./That.md), params: [InferenceTextEmbeddingRequest](./InferenceTextEmbeddingRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[InferenceTextEmbeddingResponse](./InferenceTextEmbeddingResponse.md)>;` |   || `update` | `update(this: [That](./That.md), params: [InferenceUpdateRequest](./InferenceUpdateRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[InferenceUpdateResponse](./InferenceUpdateResponse.md)>;` | Update an inference endpoint. Modify `task_settings`, secrets (within `service_settings`), or `num_allocations` for an inference endpoint, depending on the specific endpoint service and `task_type`. IMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Azure, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face. For built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models. However, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs. || `update` | `update(this: [That](./That.md), params: [InferenceUpdateRequest](./InferenceUpdateRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[InferenceUpdateResponse](./InferenceUpdateResponse.md), unknown>>;` |   || `update` | `update(this: [That](./That.md), params: [InferenceUpdateRequest](./InferenceUpdateRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[InferenceUpdateResponse](./InferenceUpdateResponse.md)>;` |   | \ No newline at end of file +| `chatCompletionUnified` | `chatCompletionUnified(this: [That](./That.md), params: [InferenceChatCompletionUnifiedRequest](./InferenceChatCompletionUnifiedRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[InferenceChatCompletionUnifiedResponse](./InferenceChatCompletionUnifiedResponse.md)>;` | Perform chat completion inference The chat completion inference API enables real-time responses for chat completion tasks by delivering answers incrementally, reducing response times during computation. It only works with the `chat_completion` task type for `openai` and `elastic` inference services. IMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Azure, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face. For built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models. However, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs. NOTE: The `chat_completion` task type is only available within the _stream API and only supports streaming. The Chat completion inference API and the Stream inference API differ in their response structure and capabilities. The Chat completion inference API provides more comprehensive customization options through more fields and function calling support. If you use the `openai` service or the `elastic` service, use the Chat completion inference API. | +| `chatCompletionUnified` | `chatCompletionUnified(this: [That](./That.md), params: [InferenceChatCompletionUnifiedRequest](./InferenceChatCompletionUnifiedRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[InferenceChatCompletionUnifiedResponse](./InferenceChatCompletionUnifiedResponse.md), unknown>>;` |   | +| `chatCompletionUnified` | `chatCompletionUnified(this: [That](./That.md), params: [InferenceChatCompletionUnifiedRequest](./InferenceChatCompletionUnifiedRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[InferenceChatCompletionUnifiedResponse](./InferenceChatCompletionUnifiedResponse.md)>;` |   | +| `completion` | `completion(this: [That](./That.md), params: [InferenceCompletionRequest](./InferenceCompletionRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[InferenceCompletionResponse](./InferenceCompletionResponse.md)>;` | Perform completion inference on the service | +| `completion` | `completion(this: [That](./That.md), params: [InferenceCompletionRequest](./InferenceCompletionRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[InferenceCompletionResponse](./InferenceCompletionResponse.md), unknown>>;` |   | +| `completion` | `completion(this: [That](./That.md), params: [InferenceCompletionRequest](./InferenceCompletionRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[InferenceCompletionResponse](./InferenceCompletionResponse.md)>;` |   | +| `delete` | `delete(this: [That](./That.md), params: [InferenceDeleteRequest](./InferenceDeleteRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[InferenceDeleteResponse](./InferenceDeleteResponse.md)>;` | Delete an inference endpoint | +| `delete` | `delete(this: [That](./That.md), params: [InferenceDeleteRequest](./InferenceDeleteRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[InferenceDeleteResponse](./InferenceDeleteResponse.md), unknown>>;` |   | +| `delete` | `delete(this: [That](./That.md), params: [InferenceDeleteRequest](./InferenceDeleteRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[InferenceDeleteResponse](./InferenceDeleteResponse.md)>;` |   | +| `get` | `get(this: [That](./That.md), params?: [InferenceGetRequest](./InferenceGetRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[InferenceGetResponse](./InferenceGetResponse.md)>;` | Get an inference endpoint | +| `get` | `get(this: [That](./That.md), params?: [InferenceGetRequest](./InferenceGetRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[InferenceGetResponse](./InferenceGetResponse.md), unknown>>;` |   | +| `get` | `get(this: [That](./That.md), params?: [InferenceGetRequest](./InferenceGetRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[InferenceGetResponse](./InferenceGetResponse.md)>;` |   | +| `inference` | `inference(this: [That](./That.md), params: [InferenceInferenceRequest](./InferenceInferenceRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[InferenceInferenceResponse](./InferenceInferenceResponse.md)>;` | Perform inference on the service. This API enables you to use machine learning models to perform specific tasks on data that you provide as an input. It returns a response with the results of the tasks. The inference endpoint you use can perform one specific task that has been defined when the endpoint was created with the create inference API. For details about using this API with a service, such as Amazon Bedrock, Anthropic, or HuggingFace, refer to the service-specific documentation. > info > The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Azure, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face. For built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models. However, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs. | +| `inference` | `inference(this: [That](./That.md), params: [InferenceInferenceRequest](./InferenceInferenceRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[InferenceInferenceResponse](./InferenceInferenceResponse.md), unknown>>;` |   | +| `inference` | `inference(this: [That](./That.md), params: [InferenceInferenceRequest](./InferenceInferenceRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[InferenceInferenceResponse](./InferenceInferenceResponse.md)>;` |   | +| `put` | `put(this: [That](./That.md), params: [InferencePutRequest](./InferencePutRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[InferencePutResponse](./InferencePutResponse.md)>;` | Create an inference endpoint. IMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Mistral, Azure OpenAI, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face. For built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models. However, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs. | +| `put` | `put(this: [That](./That.md), params: [InferencePutRequest](./InferencePutRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[InferencePutResponse](./InferencePutResponse.md), unknown>>;` |   | +| `put` | `put(this: [That](./That.md), params: [InferencePutRequest](./InferencePutRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[InferencePutResponse](./InferencePutResponse.md)>;` |   | +| `putAlibabacloud` | `putAlibabacloud(this: [That](./That.md), params: [InferencePutAlibabacloudRequest](./InferencePutAlibabacloudRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[InferencePutAlibabacloudResponse](./InferencePutAlibabacloudResponse.md)>;` | Create an AlibabaCloud AI Search inference endpoint. Create an inference endpoint to perform an inference task with the `alibabacloud-ai-search` service. | +| `putAlibabacloud` | `putAlibabacloud(this: [That](./That.md), params: [InferencePutAlibabacloudRequest](./InferencePutAlibabacloudRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[InferencePutAlibabacloudResponse](./InferencePutAlibabacloudResponse.md), unknown>>;` |   | +| `putAlibabacloud` | `putAlibabacloud(this: [That](./That.md), params: [InferencePutAlibabacloudRequest](./InferencePutAlibabacloudRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[InferencePutAlibabacloudResponse](./InferencePutAlibabacloudResponse.md)>;` |   | +| `putAmazonbedrock` | `putAmazonbedrock(this: [That](./That.md), params: [InferencePutAmazonbedrockRequest](./InferencePutAmazonbedrockRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[InferencePutAmazonbedrockResponse](./InferencePutAmazonbedrockResponse.md)>;` | Create an Amazon Bedrock inference endpoint. Creates an inference endpoint to perform an inference task with the `amazonbedrock` service. > info > You need to provide the access and secret keys only once, during the inference model creation. The get inference API does not retrieve your access or secret keys. After creating the inference model, you cannot change the associated key pairs. If you want to use a different access and secret key pair, delete the inference model and recreate it with the same name and the updated keys. | +| `putAmazonbedrock` | `putAmazonbedrock(this: [That](./That.md), params: [InferencePutAmazonbedrockRequest](./InferencePutAmazonbedrockRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[InferencePutAmazonbedrockResponse](./InferencePutAmazonbedrockResponse.md), unknown>>;` |   | +| `putAmazonbedrock` | `putAmazonbedrock(this: [That](./That.md), params: [InferencePutAmazonbedrockRequest](./InferencePutAmazonbedrockRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[InferencePutAmazonbedrockResponse](./InferencePutAmazonbedrockResponse.md)>;` |   | +| `putAnthropic` | `putAnthropic(this: [That](./That.md), params: [InferencePutAnthropicRequest](./InferencePutAnthropicRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[InferencePutAnthropicResponse](./InferencePutAnthropicResponse.md)>;` | Create an Anthropic inference endpoint. Create an inference endpoint to perform an inference task with the `anthropic` service. | +| `putAnthropic` | `putAnthropic(this: [That](./That.md), params: [InferencePutAnthropicRequest](./InferencePutAnthropicRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[InferencePutAnthropicResponse](./InferencePutAnthropicResponse.md), unknown>>;` |   | +| `putAnthropic` | `putAnthropic(this: [That](./That.md), params: [InferencePutAnthropicRequest](./InferencePutAnthropicRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[InferencePutAnthropicResponse](./InferencePutAnthropicResponse.md)>;` |   | +| `putAzureaistudio` | `putAzureaistudio(this: [That](./That.md), params: [InferencePutAzureaistudioRequest](./InferencePutAzureaistudioRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[InferencePutAzureaistudioResponse](./InferencePutAzureaistudioResponse.md)>;` | Create an Azure AI studio inference endpoint. Create an inference endpoint to perform an inference task with the `azureaistudio` service. | +| `putAzureaistudio` | `putAzureaistudio(this: [That](./That.md), params: [InferencePutAzureaistudioRequest](./InferencePutAzureaistudioRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[InferencePutAzureaistudioResponse](./InferencePutAzureaistudioResponse.md), unknown>>;` |   | +| `putAzureaistudio` | `putAzureaistudio(this: [That](./That.md), params: [InferencePutAzureaistudioRequest](./InferencePutAzureaistudioRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[InferencePutAzureaistudioResponse](./InferencePutAzureaistudioResponse.md)>;` |   | +| `putAzureopenai` | `putAzureopenai(this: [That](./That.md), params: [InferencePutAzureopenaiRequest](./InferencePutAzureopenaiRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[InferencePutAzureopenaiResponse](./InferencePutAzureopenaiResponse.md)>;` | Create an Azure OpenAI inference endpoint. Create an inference endpoint to perform an inference task with the `azureopenai` service. The list of chat completion models that you can choose from in your Azure OpenAI deployment include: * [GPT-4 and GPT-4 Turbo models](https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models?tabs=global-standard%2Cstandard-chat-completions#gpt-4-and-gpt-4-turbo-models) * [GPT-3.5](https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models?tabs=global-standard%2Cstandard-chat-completions#gpt-35) The list of embeddings models that you can choose from in your deployment can be found in the [Azure models documentation](https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models?tabs=global-standard%2Cstandard-chat-completions#embeddings). | +| `putAzureopenai` | `putAzureopenai(this: [That](./That.md), params: [InferencePutAzureopenaiRequest](./InferencePutAzureopenaiRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[InferencePutAzureopenaiResponse](./InferencePutAzureopenaiResponse.md), unknown>>;` |   | +| `putAzureopenai` | `putAzureopenai(this: [That](./That.md), params: [InferencePutAzureopenaiRequest](./InferencePutAzureopenaiRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[InferencePutAzureopenaiResponse](./InferencePutAzureopenaiResponse.md)>;` |   | +| `putCohere` | `putCohere(this: [That](./That.md), params: [InferencePutCohereRequest](./InferencePutCohereRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[InferencePutCohereResponse](./InferencePutCohereResponse.md)>;` | Create a Cohere inference endpoint. Create an inference endpoint to perform an inference task with the `cohere` service. | +| `putCohere` | `putCohere(this: [That](./That.md), params: [InferencePutCohereRequest](./InferencePutCohereRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[InferencePutCohereResponse](./InferencePutCohereResponse.md), unknown>>;` |   | +| `putCohere` | `putCohere(this: [That](./That.md), params: [InferencePutCohereRequest](./InferencePutCohereRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[InferencePutCohereResponse](./InferencePutCohereResponse.md)>;` |   | +| `putElasticsearch` | `putElasticsearch(this: [That](./That.md), params: [InferencePutElasticsearchRequest](./InferencePutElasticsearchRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[InferencePutElasticsearchResponse](./InferencePutElasticsearchResponse.md)>;` | Create an Elasticsearch inference endpoint. Create an inference endpoint to perform an inference task with the `elasticsearch` service. > info > Your Elasticsearch deployment contains preconfigured ELSER and E5 inference endpoints, you only need to create the enpoints using the API if you want to customize the settings. If you use the ELSER or the E5 model through the `elasticsearch` service, the API request will automatically download and deploy the model if it isn't downloaded yet. > info > You might see a 502 bad gateway error in the response when using the Kibana Console. This error usually just reflects a timeout, while the model downloads in the background. You can check the download progress in the Machine Learning UI. If using the Python client, you can set the timeout parameter to a higher value. After creating the endpoint, wait for the model deployment to complete before using it. To verify the deployment status, use the get trained model statistics API. Look for `"state": "fully_allocated"` in the response and ensure that the `"allocation_count"` matches the `"target_allocation_count"`. Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources. | +| `putElasticsearch` | `putElasticsearch(this: [That](./That.md), params: [InferencePutElasticsearchRequest](./InferencePutElasticsearchRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[InferencePutElasticsearchResponse](./InferencePutElasticsearchResponse.md), unknown>>;` |   | +| `putElasticsearch` | `putElasticsearch(this: [That](./That.md), params: [InferencePutElasticsearchRequest](./InferencePutElasticsearchRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[InferencePutElasticsearchResponse](./InferencePutElasticsearchResponse.md)>;` |   | +| `putElser` | `putElser(this: [That](./That.md), params: [InferencePutElserRequest](./InferencePutElserRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[InferencePutElserResponse](./InferencePutElserResponse.md)>;` | Create an ELSER inference endpoint. Create an inference endpoint to perform an inference task with the `elser` service. You can also deploy ELSER by using the Elasticsearch inference integration. > info > Your Elasticsearch deployment contains a preconfigured ELSER inference endpoint, you only need to create the enpoint using the API if you want to customize the settings. The API request will automatically download and deploy the ELSER model if it isn't already downloaded. > info > You might see a 502 bad gateway error in the response when using the Kibana Console. This error usually just reflects a timeout, while the model downloads in the background. You can check the download progress in the Machine Learning UI. If using the Python client, you can set the timeout parameter to a higher value. After creating the endpoint, wait for the model deployment to complete before using it. To verify the deployment status, use the get trained model statistics API. Look for `"state": "fully_allocated"` in the response and ensure that the `"allocation_count"` matches the `"target_allocation_count"`. Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources. | +| `putElser` | `putElser(this: [That](./That.md), params: [InferencePutElserRequest](./InferencePutElserRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[InferencePutElserResponse](./InferencePutElserResponse.md), unknown>>;` |   | +| `putElser` | `putElser(this: [That](./That.md), params: [InferencePutElserRequest](./InferencePutElserRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[InferencePutElserResponse](./InferencePutElserResponse.md)>;` |   | +| `putGoogleaistudio` | `putGoogleaistudio(this: [That](./That.md), params: [InferencePutGoogleaistudioRequest](./InferencePutGoogleaistudioRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[InferencePutGoogleaistudioResponse](./InferencePutGoogleaistudioResponse.md)>;` | Create an Google AI Studio inference endpoint. Create an inference endpoint to perform an inference task with the `googleaistudio` service. | +| `putGoogleaistudio` | `putGoogleaistudio(this: [That](./That.md), params: [InferencePutGoogleaistudioRequest](./InferencePutGoogleaistudioRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[InferencePutGoogleaistudioResponse](./InferencePutGoogleaistudioResponse.md), unknown>>;` |   | +| `putGoogleaistudio` | `putGoogleaistudio(this: [That](./That.md), params: [InferencePutGoogleaistudioRequest](./InferencePutGoogleaistudioRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[InferencePutGoogleaistudioResponse](./InferencePutGoogleaistudioResponse.md)>;` |   | +| `putGooglevertexai` | `putGooglevertexai(this: [That](./That.md), params: [InferencePutGooglevertexaiRequest](./InferencePutGooglevertexaiRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[InferencePutGooglevertexaiResponse](./InferencePutGooglevertexaiResponse.md)>;` | Create a Google Vertex AI inference endpoint. Create an inference endpoint to perform an inference task with the `googlevertexai` service. | +| `putGooglevertexai` | `putGooglevertexai(this: [That](./That.md), params: [InferencePutGooglevertexaiRequest](./InferencePutGooglevertexaiRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[InferencePutGooglevertexaiResponse](./InferencePutGooglevertexaiResponse.md), unknown>>;` |   | +| `putGooglevertexai` | `putGooglevertexai(this: [That](./That.md), params: [InferencePutGooglevertexaiRequest](./InferencePutGooglevertexaiRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[InferencePutGooglevertexaiResponse](./InferencePutGooglevertexaiResponse.md)>;` |   | +| `putHuggingFace` | `putHuggingFace(this: [That](./That.md), params: [InferencePutHuggingFaceRequest](./InferencePutHuggingFaceRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[InferencePutHuggingFaceResponse](./InferencePutHuggingFaceResponse.md)>;` | Create a Hugging Face inference endpoint. Create an inference endpoint to perform an inference task with the `hugging_face` service. You must first create an inference endpoint on the Hugging Face endpoint page to get an endpoint URL. Select the model you want to use on the new endpoint creation page (for example `intfloat/e5-small-v2`), then select the sentence embeddings task under the advanced configuration section. Create the endpoint and copy the URL after the endpoint initialization has been finished. The following models are recommended for the Hugging Face service: * `all-MiniLM-L6-v2` * `all-MiniLM-L12-v2` * `all-mpnet-base-v2` * `e5-base-v2` * `e5-small-v2` * `multilingual-e5-base` * `multilingual-e5-small` | +| `putHuggingFace` | `putHuggingFace(this: [That](./That.md), params: [InferencePutHuggingFaceRequest](./InferencePutHuggingFaceRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[InferencePutHuggingFaceResponse](./InferencePutHuggingFaceResponse.md), unknown>>;` |   | +| `putHuggingFace` | `putHuggingFace(this: [That](./That.md), params: [InferencePutHuggingFaceRequest](./InferencePutHuggingFaceRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[InferencePutHuggingFaceResponse](./InferencePutHuggingFaceResponse.md)>;` |   | +| `putJinaai` | `putJinaai(this: [That](./That.md), params: [InferencePutJinaaiRequest](./InferencePutJinaaiRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[InferencePutJinaaiResponse](./InferencePutJinaaiResponse.md)>;` | Create an JinaAI inference endpoint. Create an inference endpoint to perform an inference task with the `jinaai` service. To review the available `rerank` models, refer to < https://jina.ai/reranker > . To review the available `text_embedding` models, refer to the < https://jina.ai/embeddings/ > . | +| `putJinaai` | `putJinaai(this: [That](./That.md), params: [InferencePutJinaaiRequest](./InferencePutJinaaiRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[InferencePutJinaaiResponse](./InferencePutJinaaiResponse.md), unknown>>;` |   | +| `putJinaai` | `putJinaai(this: [That](./That.md), params: [InferencePutJinaaiRequest](./InferencePutJinaaiRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[InferencePutJinaaiResponse](./InferencePutJinaaiResponse.md)>;` |   | +| `putMistral` | `putMistral(this: [That](./That.md), params: [InferencePutMistralRequest](./InferencePutMistralRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[InferencePutMistralResponse](./InferencePutMistralResponse.md)>;` | Create a Mistral inference endpoint. Creates an inference endpoint to perform an inference task with the `mistral` service. | +| `putMistral` | `putMistral(this: [That](./That.md), params: [InferencePutMistralRequest](./InferencePutMistralRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[InferencePutMistralResponse](./InferencePutMistralResponse.md), unknown>>;` |   | +| `putMistral` | `putMistral(this: [That](./That.md), params: [InferencePutMistralRequest](./InferencePutMistralRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[InferencePutMistralResponse](./InferencePutMistralResponse.md)>;` |   | +| `putOpenai` | `putOpenai(this: [That](./That.md), params: [InferencePutOpenaiRequest](./InferencePutOpenaiRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[InferencePutOpenaiResponse](./InferencePutOpenaiResponse.md)>;` | Create an OpenAI inference endpoint. Create an inference endpoint to perform an inference task with the `openai` service or `openai` compatible APIs. | +| `putOpenai` | `putOpenai(this: [That](./That.md), params: [InferencePutOpenaiRequest](./InferencePutOpenaiRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[InferencePutOpenaiResponse](./InferencePutOpenaiResponse.md), unknown>>;` |   | +| `putOpenai` | `putOpenai(this: [That](./That.md), params: [InferencePutOpenaiRequest](./InferencePutOpenaiRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[InferencePutOpenaiResponse](./InferencePutOpenaiResponse.md)>;` |   | +| `putVoyageai` | `putVoyageai(this: [That](./That.md), params: [InferencePutVoyageaiRequest](./InferencePutVoyageaiRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[InferencePutVoyageaiResponse](./InferencePutVoyageaiResponse.md)>;` | Create a VoyageAI inference endpoint. Create an inference endpoint to perform an inference task with the `voyageai` service. Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources. | +| `putVoyageai` | `putVoyageai(this: [That](./That.md), params: [InferencePutVoyageaiRequest](./InferencePutVoyageaiRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[InferencePutVoyageaiResponse](./InferencePutVoyageaiResponse.md), unknown>>;` |   | +| `putVoyageai` | `putVoyageai(this: [That](./That.md), params: [InferencePutVoyageaiRequest](./InferencePutVoyageaiRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[InferencePutVoyageaiResponse](./InferencePutVoyageaiResponse.md)>;` |   | +| `putWatsonx` | `putWatsonx(this: [That](./That.md), params: [InferencePutWatsonxRequest](./InferencePutWatsonxRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[InferencePutWatsonxResponse](./InferencePutWatsonxResponse.md)>;` | Create a Watsonx inference endpoint. Create an inference endpoint to perform an inference task with the `watsonxai` service. You need an IBM Cloud Databases for Elasticsearch deployment to use the `watsonxai` inference service. You can provision one through the IBM catalog, the Cloud Databases CLI plug-in, the Cloud Databases API, or Terraform. | +| `putWatsonx` | `putWatsonx(this: [That](./That.md), params: [InferencePutWatsonxRequest](./InferencePutWatsonxRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[InferencePutWatsonxResponse](./InferencePutWatsonxResponse.md), unknown>>;` |   | +| `putWatsonx` | `putWatsonx(this: [That](./That.md), params: [InferencePutWatsonxRequest](./InferencePutWatsonxRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[InferencePutWatsonxResponse](./InferencePutWatsonxResponse.md)>;` |   | +| `rerank` | `rerank(this: [That](./That.md), params: [InferenceRerankRequest](./InferenceRerankRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[InferenceRerankResponse](./InferenceRerankResponse.md)>;` | Perform rereanking inference on the service | +| `rerank` | `rerank(this: [That](./That.md), params: [InferenceRerankRequest](./InferenceRerankRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[InferenceRerankResponse](./InferenceRerankResponse.md), unknown>>;` |   | +| `rerank` | `rerank(this: [That](./That.md), params: [InferenceRerankRequest](./InferenceRerankRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[InferenceRerankResponse](./InferenceRerankResponse.md)>;` |   | +| `sparseEmbedding` | `sparseEmbedding(this: [That](./That.md), params: [InferenceSparseEmbeddingRequest](./InferenceSparseEmbeddingRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[InferenceSparseEmbeddingResponse](./InferenceSparseEmbeddingResponse.md)>;` | Perform sparse embedding inference on the service | +| `sparseEmbedding` | `sparseEmbedding(this: [That](./That.md), params: [InferenceSparseEmbeddingRequest](./InferenceSparseEmbeddingRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[InferenceSparseEmbeddingResponse](./InferenceSparseEmbeddingResponse.md), unknown>>;` |   | +| `sparseEmbedding` | `sparseEmbedding(this: [That](./That.md), params: [InferenceSparseEmbeddingRequest](./InferenceSparseEmbeddingRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[InferenceSparseEmbeddingResponse](./InferenceSparseEmbeddingResponse.md)>;` |   | +| `streamCompletion` | `streamCompletion(this: [That](./That.md), params: [InferenceStreamCompletionRequest](./InferenceStreamCompletionRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[InferenceStreamCompletionResponse](./InferenceStreamCompletionResponse.md)>;` | Perform streaming inference. Get real-time responses for completion tasks by delivering answers incrementally, reducing response times during computation. This API works only with the completion task type. IMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Azure, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face. For built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models. However, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs. This API requires the `monitor_inference` cluster privilege (the built-in `inference_admin` and `inference_user` roles grant this privilege). You must use a client that supports streaming. | +| `streamCompletion` | `streamCompletion(this: [That](./That.md), params: [InferenceStreamCompletionRequest](./InferenceStreamCompletionRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[InferenceStreamCompletionResponse](./InferenceStreamCompletionResponse.md), unknown>>;` |   | +| `streamCompletion` | `streamCompletion(this: [That](./That.md), params: [InferenceStreamCompletionRequest](./InferenceStreamCompletionRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[InferenceStreamCompletionResponse](./InferenceStreamCompletionResponse.md)>;` |   | +| `textEmbedding` | `textEmbedding(this: [That](./That.md), params: [InferenceTextEmbeddingRequest](./InferenceTextEmbeddingRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[InferenceTextEmbeddingResponse](./InferenceTextEmbeddingResponse.md)>;` | Perform text embedding inference on the service | +| `textEmbedding` | `textEmbedding(this: [That](./That.md), params: [InferenceTextEmbeddingRequest](./InferenceTextEmbeddingRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[InferenceTextEmbeddingResponse](./InferenceTextEmbeddingResponse.md), unknown>>;` |   | +| `textEmbedding` | `textEmbedding(this: [That](./That.md), params: [InferenceTextEmbeddingRequest](./InferenceTextEmbeddingRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[InferenceTextEmbeddingResponse](./InferenceTextEmbeddingResponse.md)>;` |   | +| `update` | `update(this: [That](./That.md), params: [InferenceUpdateRequest](./InferenceUpdateRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[InferenceUpdateResponse](./InferenceUpdateResponse.md)>;` | Update an inference endpoint. Modify `task_settings`, secrets (within `service_settings`), or `num_allocations` for an inference endpoint, depending on the specific endpoint service and `task_type`. IMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Azure, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face. For built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models. However, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs. | +| `update` | `update(this: [That](./That.md), params: [InferenceUpdateRequest](./InferenceUpdateRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[InferenceUpdateResponse](./InferenceUpdateResponse.md), unknown>>;` |   | +| `update` | `update(this: [That](./That.md), params: [InferenceUpdateRequest](./InferenceUpdateRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[InferenceUpdateResponse](./InferenceUpdateResponse.md)>;` |   | diff --git a/docs/reference/api/Ingest.md b/docs/reference/api/Ingest.md index 5a6da0139..6be1c6077 100644 --- a/docs/reference/api/Ingest.md +++ b/docs/reference/api/Ingest.md @@ -17,4 +17,39 @@ new Ingest(transport: [Transport](./Transport.md)); | Name | Signature | Description | | - | - | - | -| `deleteGeoipDatabase` | `deleteGeoipDatabase(this: [That](./That.md), params: [IngestDeleteGeoipDatabaseRequest](./IngestDeleteGeoipDatabaseRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[IngestDeleteGeoipDatabaseResponse](./IngestDeleteGeoipDatabaseResponse.md)>;` | Delete GeoIP database configurations. Delete one or more IP geolocation database configurations. || `deleteGeoipDatabase` | `deleteGeoipDatabase(this: [That](./That.md), params: [IngestDeleteGeoipDatabaseRequest](./IngestDeleteGeoipDatabaseRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[IngestDeleteGeoipDatabaseResponse](./IngestDeleteGeoipDatabaseResponse.md), unknown>>;` |   || `deleteGeoipDatabase` | `deleteGeoipDatabase(this: [That](./That.md), params: [IngestDeleteGeoipDatabaseRequest](./IngestDeleteGeoipDatabaseRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[IngestDeleteGeoipDatabaseResponse](./IngestDeleteGeoipDatabaseResponse.md)>;` |   || `deleteIpLocationDatabase` | `deleteIpLocationDatabase(this: [That](./That.md), params: [IngestDeleteIpLocationDatabaseRequest](./IngestDeleteIpLocationDatabaseRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[IngestDeleteIpLocationDatabaseResponse](./IngestDeleteIpLocationDatabaseResponse.md)>;` | Delete IP geolocation database configurations. || `deleteIpLocationDatabase` | `deleteIpLocationDatabase(this: [That](./That.md), params: [IngestDeleteIpLocationDatabaseRequest](./IngestDeleteIpLocationDatabaseRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[IngestDeleteIpLocationDatabaseResponse](./IngestDeleteIpLocationDatabaseResponse.md), unknown>>;` |   || `deleteIpLocationDatabase` | `deleteIpLocationDatabase(this: [That](./That.md), params: [IngestDeleteIpLocationDatabaseRequest](./IngestDeleteIpLocationDatabaseRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[IngestDeleteIpLocationDatabaseResponse](./IngestDeleteIpLocationDatabaseResponse.md)>;` |   || `deletePipeline` | `deletePipeline(this: [That](./That.md), params: [IngestDeletePipelineRequest](./IngestDeletePipelineRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[IngestDeletePipelineResponse](./IngestDeletePipelineResponse.md)>;` | Delete pipelines. Delete one or more ingest pipelines. || `deletePipeline` | `deletePipeline(this: [That](./That.md), params: [IngestDeletePipelineRequest](./IngestDeletePipelineRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[IngestDeletePipelineResponse](./IngestDeletePipelineResponse.md), unknown>>;` |   || `deletePipeline` | `deletePipeline(this: [That](./That.md), params: [IngestDeletePipelineRequest](./IngestDeletePipelineRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[IngestDeletePipelineResponse](./IngestDeletePipelineResponse.md)>;` |   || `geoIpStats` | `geoIpStats(this: [That](./That.md), params?: [IngestGeoIpStatsRequest](./IngestGeoIpStatsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[IngestGeoIpStatsResponse](./IngestGeoIpStatsResponse.md)>;` | Get GeoIP statistics. Get download statistics for GeoIP2 databases that are used with the GeoIP processor. || `geoIpStats` | `geoIpStats(this: [That](./That.md), params?: [IngestGeoIpStatsRequest](./IngestGeoIpStatsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[IngestGeoIpStatsResponse](./IngestGeoIpStatsResponse.md), unknown>>;` |   || `geoIpStats` | `geoIpStats(this: [That](./That.md), params?: [IngestGeoIpStatsRequest](./IngestGeoIpStatsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[IngestGeoIpStatsResponse](./IngestGeoIpStatsResponse.md)>;` |   || `getGeoipDatabase` | `getGeoipDatabase(this: [That](./That.md), params?: [IngestGetGeoipDatabaseRequest](./IngestGetGeoipDatabaseRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[IngestGetGeoipDatabaseResponse](./IngestGetGeoipDatabaseResponse.md)>;` | Get GeoIP database configurations. Get information about one or more IP geolocation database configurations. || `getGeoipDatabase` | `getGeoipDatabase(this: [That](./That.md), params?: [IngestGetGeoipDatabaseRequest](./IngestGetGeoipDatabaseRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[IngestGetGeoipDatabaseResponse](./IngestGetGeoipDatabaseResponse.md), unknown>>;` |   || `getGeoipDatabase` | `getGeoipDatabase(this: [That](./That.md), params?: [IngestGetGeoipDatabaseRequest](./IngestGetGeoipDatabaseRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[IngestGetGeoipDatabaseResponse](./IngestGetGeoipDatabaseResponse.md)>;` |   || `getIpLocationDatabase` | `getIpLocationDatabase(this: [That](./That.md), params?: [IngestGetIpLocationDatabaseRequest](./IngestGetIpLocationDatabaseRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[IngestGetIpLocationDatabaseResponse](./IngestGetIpLocationDatabaseResponse.md)>;` | Get IP geolocation database configurations. || `getIpLocationDatabase` | `getIpLocationDatabase(this: [That](./That.md), params?: [IngestGetIpLocationDatabaseRequest](./IngestGetIpLocationDatabaseRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[IngestGetIpLocationDatabaseResponse](./IngestGetIpLocationDatabaseResponse.md), unknown>>;` |   || `getIpLocationDatabase` | `getIpLocationDatabase(this: [That](./That.md), params?: [IngestGetIpLocationDatabaseRequest](./IngestGetIpLocationDatabaseRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[IngestGetIpLocationDatabaseResponse](./IngestGetIpLocationDatabaseResponse.md)>;` |   || `getPipeline` | `getPipeline(this: [That](./That.md), params?: [IngestGetPipelineRequest](./IngestGetPipelineRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[IngestGetPipelineResponse](./IngestGetPipelineResponse.md)>;` | Get pipelines. Get information about one or more ingest pipelines. This API returns a local reference of the pipeline. || `getPipeline` | `getPipeline(this: [That](./That.md), params?: [IngestGetPipelineRequest](./IngestGetPipelineRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[IngestGetPipelineResponse](./IngestGetPipelineResponse.md), unknown>>;` |   || `getPipeline` | `getPipeline(this: [That](./That.md), params?: [IngestGetPipelineRequest](./IngestGetPipelineRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[IngestGetPipelineResponse](./IngestGetPipelineResponse.md)>;` |   || `processorGrok` | `processorGrok(this: [That](./That.md), params?: [IngestProcessorGrokRequest](./IngestProcessorGrokRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[IngestProcessorGrokResponse](./IngestProcessorGrokResponse.md)>;` | Run a grok processor. Extract structured fields out of a single text field within a document. You must choose which field to extract matched fields from, as well as the grok pattern you expect will match. A grok pattern is like a regular expression that supports aliased expressions that can be reused. || `processorGrok` | `processorGrok(this: [That](./That.md), params?: [IngestProcessorGrokRequest](./IngestProcessorGrokRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[IngestProcessorGrokResponse](./IngestProcessorGrokResponse.md), unknown>>;` |   || `processorGrok` | `processorGrok(this: [That](./That.md), params?: [IngestProcessorGrokRequest](./IngestProcessorGrokRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[IngestProcessorGrokResponse](./IngestProcessorGrokResponse.md)>;` |   || `putGeoipDatabase` | `putGeoipDatabase(this: [That](./That.md), params: [IngestPutGeoipDatabaseRequest](./IngestPutGeoipDatabaseRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[IngestPutGeoipDatabaseResponse](./IngestPutGeoipDatabaseResponse.md)>;` | Create or update a GeoIP database configuration. Refer to the create or update IP geolocation database configuration API. || `putGeoipDatabase` | `putGeoipDatabase(this: [That](./That.md), params: [IngestPutGeoipDatabaseRequest](./IngestPutGeoipDatabaseRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[IngestPutGeoipDatabaseResponse](./IngestPutGeoipDatabaseResponse.md), unknown>>;` |   || `putGeoipDatabase` | `putGeoipDatabase(this: [That](./That.md), params: [IngestPutGeoipDatabaseRequest](./IngestPutGeoipDatabaseRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[IngestPutGeoipDatabaseResponse](./IngestPutGeoipDatabaseResponse.md)>;` |   || `putIpLocationDatabase` | `putIpLocationDatabase(this: [That](./That.md), params: [IngestPutIpLocationDatabaseRequest](./IngestPutIpLocationDatabaseRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[IngestPutIpLocationDatabaseResponse](./IngestPutIpLocationDatabaseResponse.md)>;` | Create or update an IP geolocation database configuration. || `putIpLocationDatabase` | `putIpLocationDatabase(this: [That](./That.md), params: [IngestPutIpLocationDatabaseRequest](./IngestPutIpLocationDatabaseRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[IngestPutIpLocationDatabaseResponse](./IngestPutIpLocationDatabaseResponse.md), unknown>>;` |   || `putIpLocationDatabase` | `putIpLocationDatabase(this: [That](./That.md), params: [IngestPutIpLocationDatabaseRequest](./IngestPutIpLocationDatabaseRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[IngestPutIpLocationDatabaseResponse](./IngestPutIpLocationDatabaseResponse.md)>;` |   || `putPipeline` | `putPipeline(this: [That](./That.md), params: [IngestPutPipelineRequest](./IngestPutPipelineRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[IngestPutPipelineResponse](./IngestPutPipelineResponse.md)>;` | Create or update a pipeline. Changes made using this API take effect immediately. || `putPipeline` | `putPipeline(this: [That](./That.md), params: [IngestPutPipelineRequest](./IngestPutPipelineRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[IngestPutPipelineResponse](./IngestPutPipelineResponse.md), unknown>>;` |   || `putPipeline` | `putPipeline(this: [That](./That.md), params: [IngestPutPipelineRequest](./IngestPutPipelineRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[IngestPutPipelineResponse](./IngestPutPipelineResponse.md)>;` |   || `simulate` | `simulate(this: [That](./That.md), params: [IngestSimulateRequest](./IngestSimulateRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[IngestSimulateResponse](./IngestSimulateResponse.md)>;` | Simulate a pipeline. Run an ingest pipeline against a set of provided documents. You can either specify an existing pipeline to use with the provided documents or supply a pipeline definition in the body of the request. || `simulate` | `simulate(this: [That](./That.md), params: [IngestSimulateRequest](./IngestSimulateRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[IngestSimulateResponse](./IngestSimulateResponse.md), unknown>>;` |   || `simulate` | `simulate(this: [That](./That.md), params: [IngestSimulateRequest](./IngestSimulateRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[IngestSimulateResponse](./IngestSimulateResponse.md)>;` |   | \ No newline at end of file +| `deleteGeoipDatabase` | `deleteGeoipDatabase(this: [That](./That.md), params: [IngestDeleteGeoipDatabaseRequest](./IngestDeleteGeoipDatabaseRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[IngestDeleteGeoipDatabaseResponse](./IngestDeleteGeoipDatabaseResponse.md)>;` | Delete GeoIP database configurations. Delete one or more IP geolocation database configurations. | +| `deleteGeoipDatabase` | `deleteGeoipDatabase(this: [That](./That.md), params: [IngestDeleteGeoipDatabaseRequest](./IngestDeleteGeoipDatabaseRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[IngestDeleteGeoipDatabaseResponse](./IngestDeleteGeoipDatabaseResponse.md), unknown>>;` |   | +| `deleteGeoipDatabase` | `deleteGeoipDatabase(this: [That](./That.md), params: [IngestDeleteGeoipDatabaseRequest](./IngestDeleteGeoipDatabaseRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[IngestDeleteGeoipDatabaseResponse](./IngestDeleteGeoipDatabaseResponse.md)>;` |   | +| `deleteIpLocationDatabase` | `deleteIpLocationDatabase(this: [That](./That.md), params: [IngestDeleteIpLocationDatabaseRequest](./IngestDeleteIpLocationDatabaseRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[IngestDeleteIpLocationDatabaseResponse](./IngestDeleteIpLocationDatabaseResponse.md)>;` | Delete IP geolocation database configurations. | +| `deleteIpLocationDatabase` | `deleteIpLocationDatabase(this: [That](./That.md), params: [IngestDeleteIpLocationDatabaseRequest](./IngestDeleteIpLocationDatabaseRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[IngestDeleteIpLocationDatabaseResponse](./IngestDeleteIpLocationDatabaseResponse.md), unknown>>;` |   | +| `deleteIpLocationDatabase` | `deleteIpLocationDatabase(this: [That](./That.md), params: [IngestDeleteIpLocationDatabaseRequest](./IngestDeleteIpLocationDatabaseRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[IngestDeleteIpLocationDatabaseResponse](./IngestDeleteIpLocationDatabaseResponse.md)>;` |   | +| `deletePipeline` | `deletePipeline(this: [That](./That.md), params: [IngestDeletePipelineRequest](./IngestDeletePipelineRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[IngestDeletePipelineResponse](./IngestDeletePipelineResponse.md)>;` | Delete pipelines. Delete one or more ingest pipelines. | +| `deletePipeline` | `deletePipeline(this: [That](./That.md), params: [IngestDeletePipelineRequest](./IngestDeletePipelineRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[IngestDeletePipelineResponse](./IngestDeletePipelineResponse.md), unknown>>;` |   | +| `deletePipeline` | `deletePipeline(this: [That](./That.md), params: [IngestDeletePipelineRequest](./IngestDeletePipelineRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[IngestDeletePipelineResponse](./IngestDeletePipelineResponse.md)>;` |   | +| `geoIpStats` | `geoIpStats(this: [That](./That.md), params?: [IngestGeoIpStatsRequest](./IngestGeoIpStatsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[IngestGeoIpStatsResponse](./IngestGeoIpStatsResponse.md)>;` | Get GeoIP statistics. Get download statistics for GeoIP2 databases that are used with the GeoIP processor. | +| `geoIpStats` | `geoIpStats(this: [That](./That.md), params?: [IngestGeoIpStatsRequest](./IngestGeoIpStatsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[IngestGeoIpStatsResponse](./IngestGeoIpStatsResponse.md), unknown>>;` |   | +| `geoIpStats` | `geoIpStats(this: [That](./That.md), params?: [IngestGeoIpStatsRequest](./IngestGeoIpStatsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[IngestGeoIpStatsResponse](./IngestGeoIpStatsResponse.md)>;` |   | +| `getGeoipDatabase` | `getGeoipDatabase(this: [That](./That.md), params?: [IngestGetGeoipDatabaseRequest](./IngestGetGeoipDatabaseRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[IngestGetGeoipDatabaseResponse](./IngestGetGeoipDatabaseResponse.md)>;` | Get GeoIP database configurations. Get information about one or more IP geolocation database configurations. | +| `getGeoipDatabase` | `getGeoipDatabase(this: [That](./That.md), params?: [IngestGetGeoipDatabaseRequest](./IngestGetGeoipDatabaseRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[IngestGetGeoipDatabaseResponse](./IngestGetGeoipDatabaseResponse.md), unknown>>;` |   | +| `getGeoipDatabase` | `getGeoipDatabase(this: [That](./That.md), params?: [IngestGetGeoipDatabaseRequest](./IngestGetGeoipDatabaseRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[IngestGetGeoipDatabaseResponse](./IngestGetGeoipDatabaseResponse.md)>;` |   | +| `getIpLocationDatabase` | `getIpLocationDatabase(this: [That](./That.md), params?: [IngestGetIpLocationDatabaseRequest](./IngestGetIpLocationDatabaseRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[IngestGetIpLocationDatabaseResponse](./IngestGetIpLocationDatabaseResponse.md)>;` | Get IP geolocation database configurations. | +| `getIpLocationDatabase` | `getIpLocationDatabase(this: [That](./That.md), params?: [IngestGetIpLocationDatabaseRequest](./IngestGetIpLocationDatabaseRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[IngestGetIpLocationDatabaseResponse](./IngestGetIpLocationDatabaseResponse.md), unknown>>;` |   | +| `getIpLocationDatabase` | `getIpLocationDatabase(this: [That](./That.md), params?: [IngestGetIpLocationDatabaseRequest](./IngestGetIpLocationDatabaseRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[IngestGetIpLocationDatabaseResponse](./IngestGetIpLocationDatabaseResponse.md)>;` |   | +| `getPipeline` | `getPipeline(this: [That](./That.md), params?: [IngestGetPipelineRequest](./IngestGetPipelineRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[IngestGetPipelineResponse](./IngestGetPipelineResponse.md)>;` | Get pipelines. Get information about one or more ingest pipelines. This API returns a local reference of the pipeline. | +| `getPipeline` | `getPipeline(this: [That](./That.md), params?: [IngestGetPipelineRequest](./IngestGetPipelineRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[IngestGetPipelineResponse](./IngestGetPipelineResponse.md), unknown>>;` |   | +| `getPipeline` | `getPipeline(this: [That](./That.md), params?: [IngestGetPipelineRequest](./IngestGetPipelineRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[IngestGetPipelineResponse](./IngestGetPipelineResponse.md)>;` |   | +| `processorGrok` | `processorGrok(this: [That](./That.md), params?: [IngestProcessorGrokRequest](./IngestProcessorGrokRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[IngestProcessorGrokResponse](./IngestProcessorGrokResponse.md)>;` | Run a grok processor. Extract structured fields out of a single text field within a document. You must choose which field to extract matched fields from, as well as the grok pattern you expect will match. A grok pattern is like a regular expression that supports aliased expressions that can be reused. | +| `processorGrok` | `processorGrok(this: [That](./That.md), params?: [IngestProcessorGrokRequest](./IngestProcessorGrokRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[IngestProcessorGrokResponse](./IngestProcessorGrokResponse.md), unknown>>;` |   | +| `processorGrok` | `processorGrok(this: [That](./That.md), params?: [IngestProcessorGrokRequest](./IngestProcessorGrokRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[IngestProcessorGrokResponse](./IngestProcessorGrokResponse.md)>;` |   | +| `putGeoipDatabase` | `putGeoipDatabase(this: [That](./That.md), params: [IngestPutGeoipDatabaseRequest](./IngestPutGeoipDatabaseRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[IngestPutGeoipDatabaseResponse](./IngestPutGeoipDatabaseResponse.md)>;` | Create or update a GeoIP database configuration. Refer to the create or update IP geolocation database configuration API. | +| `putGeoipDatabase` | `putGeoipDatabase(this: [That](./That.md), params: [IngestPutGeoipDatabaseRequest](./IngestPutGeoipDatabaseRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[IngestPutGeoipDatabaseResponse](./IngestPutGeoipDatabaseResponse.md), unknown>>;` |   | +| `putGeoipDatabase` | `putGeoipDatabase(this: [That](./That.md), params: [IngestPutGeoipDatabaseRequest](./IngestPutGeoipDatabaseRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[IngestPutGeoipDatabaseResponse](./IngestPutGeoipDatabaseResponse.md)>;` |   | +| `putIpLocationDatabase` | `putIpLocationDatabase(this: [That](./That.md), params: [IngestPutIpLocationDatabaseRequest](./IngestPutIpLocationDatabaseRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[IngestPutIpLocationDatabaseResponse](./IngestPutIpLocationDatabaseResponse.md)>;` | Create or update an IP geolocation database configuration. | +| `putIpLocationDatabase` | `putIpLocationDatabase(this: [That](./That.md), params: [IngestPutIpLocationDatabaseRequest](./IngestPutIpLocationDatabaseRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[IngestPutIpLocationDatabaseResponse](./IngestPutIpLocationDatabaseResponse.md), unknown>>;` |   | +| `putIpLocationDatabase` | `putIpLocationDatabase(this: [That](./That.md), params: [IngestPutIpLocationDatabaseRequest](./IngestPutIpLocationDatabaseRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[IngestPutIpLocationDatabaseResponse](./IngestPutIpLocationDatabaseResponse.md)>;` |   | +| `putPipeline` | `putPipeline(this: [That](./That.md), params: [IngestPutPipelineRequest](./IngestPutPipelineRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[IngestPutPipelineResponse](./IngestPutPipelineResponse.md)>;` | Create or update a pipeline. Changes made using this API take effect immediately. | +| `putPipeline` | `putPipeline(this: [That](./That.md), params: [IngestPutPipelineRequest](./IngestPutPipelineRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[IngestPutPipelineResponse](./IngestPutPipelineResponse.md), unknown>>;` |   | +| `putPipeline` | `putPipeline(this: [That](./That.md), params: [IngestPutPipelineRequest](./IngestPutPipelineRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[IngestPutPipelineResponse](./IngestPutPipelineResponse.md)>;` |   | +| `simulate` | `simulate(this: [That](./That.md), params: [IngestSimulateRequest](./IngestSimulateRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[IngestSimulateResponse](./IngestSimulateResponse.md)>;` | Simulate a pipeline. Run an ingest pipeline against a set of provided documents. You can either specify an existing pipeline to use with the provided documents or supply a pipeline definition in the body of the request. | +| `simulate` | `simulate(this: [That](./That.md), params: [IngestSimulateRequest](./IngestSimulateRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[IngestSimulateResponse](./IngestSimulateResponse.md), unknown>>;` |   | +| `simulate` | `simulate(this: [That](./That.md), params: [IngestSimulateRequest](./IngestSimulateRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[IngestSimulateResponse](./IngestSimulateResponse.md)>;` |   | diff --git a/docs/reference/api/License.md b/docs/reference/api/License.md index e3c95d626..3127430cc 100644 --- a/docs/reference/api/License.md +++ b/docs/reference/api/License.md @@ -17,4 +17,24 @@ new License(transport: [Transport](./Transport.md)); | Name | Signature | Description | | - | - | - | -| `delete` | `delete(this: [That](./That.md), params?: [LicenseDeleteRequest](./LicenseDeleteRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[LicenseDeleteResponse](./LicenseDeleteResponse.md)>;` | Delete the license. When the license expires, your subscription level reverts to Basic. If the operator privileges feature is enabled, only operator users can use this API. || `delete` | `delete(this: [That](./That.md), params?: [LicenseDeleteRequest](./LicenseDeleteRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[LicenseDeleteResponse](./LicenseDeleteResponse.md), unknown>>;` |   || `delete` | `delete(this: [That](./That.md), params?: [LicenseDeleteRequest](./LicenseDeleteRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[LicenseDeleteResponse](./LicenseDeleteResponse.md)>;` |   || `get` | `get(this: [That](./That.md), params?: [LicenseGetRequest](./LicenseGetRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[LicenseGetResponse](./LicenseGetResponse.md)>;` | Get license information. Get information about your Elastic license including its type, its status, when it was issued, and when it expires. > info > If the master node is generating a new cluster state, the get license API may return a `404 Not Found` response. > If you receive an unexpected 404 response after cluster startup, wait a short period and retry the request. || `get` | `get(this: [That](./That.md), params?: [LicenseGetRequest](./LicenseGetRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[LicenseGetResponse](./LicenseGetResponse.md), unknown>>;` |   || `get` | `get(this: [That](./That.md), params?: [LicenseGetRequest](./LicenseGetRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[LicenseGetResponse](./LicenseGetResponse.md)>;` |   || `getBasicStatus` | `getBasicStatus(this: [That](./That.md), params?: [LicenseGetBasicStatusRequest](./LicenseGetBasicStatusRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[LicenseGetBasicStatusResponse](./LicenseGetBasicStatusResponse.md)>;` | Get the basic license status. || `getBasicStatus` | `getBasicStatus(this: [That](./That.md), params?: [LicenseGetBasicStatusRequest](./LicenseGetBasicStatusRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[LicenseGetBasicStatusResponse](./LicenseGetBasicStatusResponse.md), unknown>>;` |   || `getBasicStatus` | `getBasicStatus(this: [That](./That.md), params?: [LicenseGetBasicStatusRequest](./LicenseGetBasicStatusRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[LicenseGetBasicStatusResponse](./LicenseGetBasicStatusResponse.md)>;` |   || `getTrialStatus` | `getTrialStatus(this: [That](./That.md), params?: [LicenseGetTrialStatusRequest](./LicenseGetTrialStatusRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[LicenseGetTrialStatusResponse](./LicenseGetTrialStatusResponse.md)>;` | Get the trial status. || `getTrialStatus` | `getTrialStatus(this: [That](./That.md), params?: [LicenseGetTrialStatusRequest](./LicenseGetTrialStatusRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[LicenseGetTrialStatusResponse](./LicenseGetTrialStatusResponse.md), unknown>>;` |   || `getTrialStatus` | `getTrialStatus(this: [That](./That.md), params?: [LicenseGetTrialStatusRequest](./LicenseGetTrialStatusRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[LicenseGetTrialStatusResponse](./LicenseGetTrialStatusResponse.md)>;` |   || `post` | `post(this: [That](./That.md), params?: [LicensePostRequest](./LicensePostRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[LicensePostResponse](./LicensePostResponse.md)>;` | Update the license. You can update your license at runtime without shutting down your nodes. License updates take effect immediately. If the license you are installing does not support all of the features that were available with your previous license, however, you are notified in the response. You must then re-submit the API request with the acknowledge parameter set to true. NOTE: If Elasticsearch security features are enabled and you are installing a gold or higher license, you must enable TLS on the transport networking layer before you install the license. If the operator privileges feature is enabled, only operator users can use this API. || `post` | `post(this: [That](./That.md), params?: [LicensePostRequest](./LicensePostRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[LicensePostResponse](./LicensePostResponse.md), unknown>>;` |   || `post` | `post(this: [That](./That.md), params?: [LicensePostRequest](./LicensePostRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[LicensePostResponse](./LicensePostResponse.md)>;` |   || `postStartBasic` | `postStartBasic(this: [That](./That.md), params?: [LicensePostStartBasicRequest](./LicensePostStartBasicRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[LicensePostStartBasicResponse](./LicensePostStartBasicResponse.md)>;` | Start a basic license. Start an indefinite basic license, which gives access to all the basic features. NOTE: In order to start a basic license, you must not currently have a basic license. If the basic license does not support all of the features that are available with your current license, however, you are notified in the response. You must then re-submit the API request with the `acknowledge` parameter set to `true`. To check the status of your basic license, use the get basic license API. || `postStartBasic` | `postStartBasic(this: [That](./That.md), params?: [LicensePostStartBasicRequest](./LicensePostStartBasicRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[LicensePostStartBasicResponse](./LicensePostStartBasicResponse.md), unknown>>;` |   || `postStartBasic` | `postStartBasic(this: [That](./That.md), params?: [LicensePostStartBasicRequest](./LicensePostStartBasicRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[LicensePostStartBasicResponse](./LicensePostStartBasicResponse.md)>;` |   || `postStartTrial` | `postStartTrial(this: [That](./That.md), params?: [LicensePostStartTrialRequest](./LicensePostStartTrialRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[LicensePostStartTrialResponse](./LicensePostStartTrialResponse.md)>;` | Start a trial. Start a 30-day trial, which gives access to all subscription features. NOTE: You are allowed to start a trial only if your cluster has not already activated a trial for the current major product version. For example, if you have already activated a trial for v8.0, you cannot start a new trial until v9.0. You can, however, request an extended trial at https://www.elastic.co/trialextension. To check the status of your trial, use the get trial status API. || `postStartTrial` | `postStartTrial(this: [That](./That.md), params?: [LicensePostStartTrialRequest](./LicensePostStartTrialRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[LicensePostStartTrialResponse](./LicensePostStartTrialResponse.md), unknown>>;` |   || `postStartTrial` | `postStartTrial(this: [That](./That.md), params?: [LicensePostStartTrialRequest](./LicensePostStartTrialRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[LicensePostStartTrialResponse](./LicensePostStartTrialResponse.md)>;` |   | \ No newline at end of file +| `delete` | `delete(this: [That](./That.md), params?: [LicenseDeleteRequest](./LicenseDeleteRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[LicenseDeleteResponse](./LicenseDeleteResponse.md)>;` | Delete the license. When the license expires, your subscription level reverts to Basic. If the operator privileges feature is enabled, only operator users can use this API. | +| `delete` | `delete(this: [That](./That.md), params?: [LicenseDeleteRequest](./LicenseDeleteRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[LicenseDeleteResponse](./LicenseDeleteResponse.md), unknown>>;` |   | +| `delete` | `delete(this: [That](./That.md), params?: [LicenseDeleteRequest](./LicenseDeleteRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[LicenseDeleteResponse](./LicenseDeleteResponse.md)>;` |   | +| `get` | `get(this: [That](./That.md), params?: [LicenseGetRequest](./LicenseGetRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[LicenseGetResponse](./LicenseGetResponse.md)>;` | Get license information. Get information about your Elastic license including its type, its status, when it was issued, and when it expires. > info > If the master node is generating a new cluster state, the get license API may return a `404 Not Found` response. > If you receive an unexpected 404 response after cluster startup, wait a short period and retry the request. | +| `get` | `get(this: [That](./That.md), params?: [LicenseGetRequest](./LicenseGetRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[LicenseGetResponse](./LicenseGetResponse.md), unknown>>;` |   | +| `get` | `get(this: [That](./That.md), params?: [LicenseGetRequest](./LicenseGetRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[LicenseGetResponse](./LicenseGetResponse.md)>;` |   | +| `getBasicStatus` | `getBasicStatus(this: [That](./That.md), params?: [LicenseGetBasicStatusRequest](./LicenseGetBasicStatusRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[LicenseGetBasicStatusResponse](./LicenseGetBasicStatusResponse.md)>;` | Get the basic license status. | +| `getBasicStatus` | `getBasicStatus(this: [That](./That.md), params?: [LicenseGetBasicStatusRequest](./LicenseGetBasicStatusRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[LicenseGetBasicStatusResponse](./LicenseGetBasicStatusResponse.md), unknown>>;` |   | +| `getBasicStatus` | `getBasicStatus(this: [That](./That.md), params?: [LicenseGetBasicStatusRequest](./LicenseGetBasicStatusRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[LicenseGetBasicStatusResponse](./LicenseGetBasicStatusResponse.md)>;` |   | +| `getTrialStatus` | `getTrialStatus(this: [That](./That.md), params?: [LicenseGetTrialStatusRequest](./LicenseGetTrialStatusRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[LicenseGetTrialStatusResponse](./LicenseGetTrialStatusResponse.md)>;` | Get the trial status. | +| `getTrialStatus` | `getTrialStatus(this: [That](./That.md), params?: [LicenseGetTrialStatusRequest](./LicenseGetTrialStatusRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[LicenseGetTrialStatusResponse](./LicenseGetTrialStatusResponse.md), unknown>>;` |   | +| `getTrialStatus` | `getTrialStatus(this: [That](./That.md), params?: [LicenseGetTrialStatusRequest](./LicenseGetTrialStatusRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[LicenseGetTrialStatusResponse](./LicenseGetTrialStatusResponse.md)>;` |   | +| `post` | `post(this: [That](./That.md), params?: [LicensePostRequest](./LicensePostRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[LicensePostResponse](./LicensePostResponse.md)>;` | Update the license. You can update your license at runtime without shutting down your nodes. License updates take effect immediately. If the license you are installing does not support all of the features that were available with your previous license, however, you are notified in the response. You must then re-submit the API request with the acknowledge parameter set to true. NOTE: If Elasticsearch security features are enabled and you are installing a gold or higher license, you must enable TLS on the transport networking layer before you install the license. If the operator privileges feature is enabled, only operator users can use this API. | +| `post` | `post(this: [That](./That.md), params?: [LicensePostRequest](./LicensePostRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[LicensePostResponse](./LicensePostResponse.md), unknown>>;` |   | +| `post` | `post(this: [That](./That.md), params?: [LicensePostRequest](./LicensePostRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[LicensePostResponse](./LicensePostResponse.md)>;` |   | +| `postStartBasic` | `postStartBasic(this: [That](./That.md), params?: [LicensePostStartBasicRequest](./LicensePostStartBasicRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[LicensePostStartBasicResponse](./LicensePostStartBasicResponse.md)>;` | Start a basic license. Start an indefinite basic license, which gives access to all the basic features. NOTE: In order to start a basic license, you must not currently have a basic license. If the basic license does not support all of the features that are available with your current license, however, you are notified in the response. You must then re-submit the API request with the `acknowledge` parameter set to `true`. To check the status of your basic license, use the get basic license API. | +| `postStartBasic` | `postStartBasic(this: [That](./That.md), params?: [LicensePostStartBasicRequest](./LicensePostStartBasicRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[LicensePostStartBasicResponse](./LicensePostStartBasicResponse.md), unknown>>;` |   | +| `postStartBasic` | `postStartBasic(this: [That](./That.md), params?: [LicensePostStartBasicRequest](./LicensePostStartBasicRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[LicensePostStartBasicResponse](./LicensePostStartBasicResponse.md)>;` |   | +| `postStartTrial` | `postStartTrial(this: [That](./That.md), params?: [LicensePostStartTrialRequest](./LicensePostStartTrialRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[LicensePostStartTrialResponse](./LicensePostStartTrialResponse.md)>;` | Start a trial. Start a 30-day trial, which gives access to all subscription features. NOTE: You are allowed to start a trial only if your cluster has not already activated a trial for the current major product version. For example, if you have already activated a trial for v8.0, you cannot start a new trial until v9.0. You can, however, request an extended trial at https://www.elastic.co/trialextension. To check the status of your trial, use the get trial status API. | +| `postStartTrial` | `postStartTrial(this: [That](./That.md), params?: [LicensePostStartTrialRequest](./LicensePostStartTrialRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[LicensePostStartTrialResponse](./LicensePostStartTrialResponse.md), unknown>>;` |   | +| `postStartTrial` | `postStartTrial(this: [That](./That.md), params?: [LicensePostStartTrialRequest](./LicensePostStartTrialRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[LicensePostStartTrialResponse](./LicensePostStartTrialResponse.md)>;` |   | diff --git a/docs/reference/api/Logstash.md b/docs/reference/api/Logstash.md index de53bba7b..e87049c73 100644 --- a/docs/reference/api/Logstash.md +++ b/docs/reference/api/Logstash.md @@ -17,4 +17,12 @@ new Logstash(transport: [Transport](./Transport.md)); | Name | Signature | Description | | - | - | - | -| `deletePipeline` | `deletePipeline(this: [That](./That.md), params: [LogstashDeletePipelineRequest](./LogstashDeletePipelineRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[LogstashDeletePipelineResponse](./LogstashDeletePipelineResponse.md)>;` | Delete a Logstash pipeline. Delete a pipeline that is used for Logstash Central Management. If the request succeeds, you receive an empty response with an appropriate status code. || `deletePipeline` | `deletePipeline(this: [That](./That.md), params: [LogstashDeletePipelineRequest](./LogstashDeletePipelineRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[LogstashDeletePipelineResponse](./LogstashDeletePipelineResponse.md), unknown>>;` |   || `deletePipeline` | `deletePipeline(this: [That](./That.md), params: [LogstashDeletePipelineRequest](./LogstashDeletePipelineRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[LogstashDeletePipelineResponse](./LogstashDeletePipelineResponse.md)>;` |   || `getPipeline` | `getPipeline(this: [That](./That.md), params?: [LogstashGetPipelineRequest](./LogstashGetPipelineRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[LogstashGetPipelineResponse](./LogstashGetPipelineResponse.md)>;` | Get Logstash pipelines. Get pipelines that are used for Logstash Central Management. || `getPipeline` | `getPipeline(this: [That](./That.md), params?: [LogstashGetPipelineRequest](./LogstashGetPipelineRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[LogstashGetPipelineResponse](./LogstashGetPipelineResponse.md), unknown>>;` |   || `getPipeline` | `getPipeline(this: [That](./That.md), params?: [LogstashGetPipelineRequest](./LogstashGetPipelineRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[LogstashGetPipelineResponse](./LogstashGetPipelineResponse.md)>;` |   || `putPipeline` | `putPipeline(this: [That](./That.md), params: [LogstashPutPipelineRequest](./LogstashPutPipelineRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[LogstashPutPipelineResponse](./LogstashPutPipelineResponse.md)>;` | Create or update a Logstash pipeline. Create a pipeline that is used for Logstash Central Management. If the specified pipeline exists, it is replaced. || `putPipeline` | `putPipeline(this: [That](./That.md), params: [LogstashPutPipelineRequest](./LogstashPutPipelineRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[LogstashPutPipelineResponse](./LogstashPutPipelineResponse.md), unknown>>;` |   || `putPipeline` | `putPipeline(this: [That](./That.md), params: [LogstashPutPipelineRequest](./LogstashPutPipelineRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[LogstashPutPipelineResponse](./LogstashPutPipelineResponse.md)>;` |   | \ No newline at end of file +| `deletePipeline` | `deletePipeline(this: [That](./That.md), params: [LogstashDeletePipelineRequest](./LogstashDeletePipelineRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[LogstashDeletePipelineResponse](./LogstashDeletePipelineResponse.md)>;` | Delete a Logstash pipeline. Delete a pipeline that is used for Logstash Central Management. If the request succeeds, you receive an empty response with an appropriate status code. | +| `deletePipeline` | `deletePipeline(this: [That](./That.md), params: [LogstashDeletePipelineRequest](./LogstashDeletePipelineRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[LogstashDeletePipelineResponse](./LogstashDeletePipelineResponse.md), unknown>>;` |   | +| `deletePipeline` | `deletePipeline(this: [That](./That.md), params: [LogstashDeletePipelineRequest](./LogstashDeletePipelineRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[LogstashDeletePipelineResponse](./LogstashDeletePipelineResponse.md)>;` |   | +| `getPipeline` | `getPipeline(this: [That](./That.md), params?: [LogstashGetPipelineRequest](./LogstashGetPipelineRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[LogstashGetPipelineResponse](./LogstashGetPipelineResponse.md)>;` | Get Logstash pipelines. Get pipelines that are used for Logstash Central Management. | +| `getPipeline` | `getPipeline(this: [That](./That.md), params?: [LogstashGetPipelineRequest](./LogstashGetPipelineRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[LogstashGetPipelineResponse](./LogstashGetPipelineResponse.md), unknown>>;` |   | +| `getPipeline` | `getPipeline(this: [That](./That.md), params?: [LogstashGetPipelineRequest](./LogstashGetPipelineRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[LogstashGetPipelineResponse](./LogstashGetPipelineResponse.md)>;` |   | +| `putPipeline` | `putPipeline(this: [That](./That.md), params: [LogstashPutPipelineRequest](./LogstashPutPipelineRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[LogstashPutPipelineResponse](./LogstashPutPipelineResponse.md)>;` | Create or update a Logstash pipeline. Create a pipeline that is used for Logstash Central Management. If the specified pipeline exists, it is replaced. | +| `putPipeline` | `putPipeline(this: [That](./That.md), params: [LogstashPutPipelineRequest](./LogstashPutPipelineRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[LogstashPutPipelineResponse](./LogstashPutPipelineResponse.md), unknown>>;` |   | +| `putPipeline` | `putPipeline(this: [That](./That.md), params: [LogstashPutPipelineRequest](./LogstashPutPipelineRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[LogstashPutPipelineResponse](./LogstashPutPipelineResponse.md)>;` |   | diff --git a/docs/reference/api/Migration.md b/docs/reference/api/Migration.md index 4805da27f..0e16368a8 100644 --- a/docs/reference/api/Migration.md +++ b/docs/reference/api/Migration.md @@ -17,4 +17,12 @@ new Migration(transport: [Transport](./Transport.md)); | Name | Signature | Description | | - | - | - | -| `deprecations` | `deprecations(this: [That](./That.md), params?: [MigrationDeprecationsRequest](./MigrationDeprecationsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MigrationDeprecationsResponse](./MigrationDeprecationsResponse.md)>;` | Get deprecation information. Get information about different cluster, node, and index level settings that use deprecated features that will be removed or changed in the next major version. TIP: This APIs is designed for indirect use by the Upgrade Assistant. You are strongly recommended to use the Upgrade Assistant. || `deprecations` | `deprecations(this: [That](./That.md), params?: [MigrationDeprecationsRequest](./MigrationDeprecationsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MigrationDeprecationsResponse](./MigrationDeprecationsResponse.md), unknown>>;` |   || `deprecations` | `deprecations(this: [That](./That.md), params?: [MigrationDeprecationsRequest](./MigrationDeprecationsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MigrationDeprecationsResponse](./MigrationDeprecationsResponse.md)>;` |   || `getFeatureUpgradeStatus` | `getFeatureUpgradeStatus(this: [That](./That.md), params?: [MigrationGetFeatureUpgradeStatusRequest](./MigrationGetFeatureUpgradeStatusRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MigrationGetFeatureUpgradeStatusResponse](./MigrationGetFeatureUpgradeStatusResponse.md)>;` | Get feature migration information. Version upgrades sometimes require changes to how features store configuration information and data in system indices. Check which features need to be migrated and the status of any migrations that are in progress. TIP: This API is designed for indirect use by the Upgrade Assistant. You are strongly recommended to use the Upgrade Assistant. || `getFeatureUpgradeStatus` | `getFeatureUpgradeStatus(this: [That](./That.md), params?: [MigrationGetFeatureUpgradeStatusRequest](./MigrationGetFeatureUpgradeStatusRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MigrationGetFeatureUpgradeStatusResponse](./MigrationGetFeatureUpgradeStatusResponse.md), unknown>>;` |   || `getFeatureUpgradeStatus` | `getFeatureUpgradeStatus(this: [That](./That.md), params?: [MigrationGetFeatureUpgradeStatusRequest](./MigrationGetFeatureUpgradeStatusRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MigrationGetFeatureUpgradeStatusResponse](./MigrationGetFeatureUpgradeStatusResponse.md)>;` |   || `postFeatureUpgrade` | `postFeatureUpgrade(this: [That](./That.md), params?: [MigrationPostFeatureUpgradeRequest](./MigrationPostFeatureUpgradeRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MigrationPostFeatureUpgradeResponse](./MigrationPostFeatureUpgradeResponse.md)>;` | Start the feature migration. Version upgrades sometimes require changes to how features store configuration information and data in system indices. This API starts the automatic migration process. Some functionality might be temporarily unavailable during the migration process. TIP: The API is designed for indirect use by the Upgrade Assistant. We strongly recommend you use the Upgrade Assistant. || `postFeatureUpgrade` | `postFeatureUpgrade(this: [That](./That.md), params?: [MigrationPostFeatureUpgradeRequest](./MigrationPostFeatureUpgradeRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MigrationPostFeatureUpgradeResponse](./MigrationPostFeatureUpgradeResponse.md), unknown>>;` |   || `postFeatureUpgrade` | `postFeatureUpgrade(this: [That](./That.md), params?: [MigrationPostFeatureUpgradeRequest](./MigrationPostFeatureUpgradeRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MigrationPostFeatureUpgradeResponse](./MigrationPostFeatureUpgradeResponse.md)>;` |   | \ No newline at end of file +| `deprecations` | `deprecations(this: [That](./That.md), params?: [MigrationDeprecationsRequest](./MigrationDeprecationsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MigrationDeprecationsResponse](./MigrationDeprecationsResponse.md)>;` | Get deprecation information. Get information about different cluster, node, and index level settings that use deprecated features that will be removed or changed in the next major version. TIP: This APIs is designed for indirect use by the Upgrade Assistant. You are strongly recommended to use the Upgrade Assistant. | +| `deprecations` | `deprecations(this: [That](./That.md), params?: [MigrationDeprecationsRequest](./MigrationDeprecationsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MigrationDeprecationsResponse](./MigrationDeprecationsResponse.md), unknown>>;` |   | +| `deprecations` | `deprecations(this: [That](./That.md), params?: [MigrationDeprecationsRequest](./MigrationDeprecationsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MigrationDeprecationsResponse](./MigrationDeprecationsResponse.md)>;` |   | +| `getFeatureUpgradeStatus` | `getFeatureUpgradeStatus(this: [That](./That.md), params?: [MigrationGetFeatureUpgradeStatusRequest](./MigrationGetFeatureUpgradeStatusRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MigrationGetFeatureUpgradeStatusResponse](./MigrationGetFeatureUpgradeStatusResponse.md)>;` | Get feature migration information. Version upgrades sometimes require changes to how features store configuration information and data in system indices. Check which features need to be migrated and the status of any migrations that are in progress. TIP: This API is designed for indirect use by the Upgrade Assistant. You are strongly recommended to use the Upgrade Assistant. | +| `getFeatureUpgradeStatus` | `getFeatureUpgradeStatus(this: [That](./That.md), params?: [MigrationGetFeatureUpgradeStatusRequest](./MigrationGetFeatureUpgradeStatusRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MigrationGetFeatureUpgradeStatusResponse](./MigrationGetFeatureUpgradeStatusResponse.md), unknown>>;` |   | +| `getFeatureUpgradeStatus` | `getFeatureUpgradeStatus(this: [That](./That.md), params?: [MigrationGetFeatureUpgradeStatusRequest](./MigrationGetFeatureUpgradeStatusRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MigrationGetFeatureUpgradeStatusResponse](./MigrationGetFeatureUpgradeStatusResponse.md)>;` |   | +| `postFeatureUpgrade` | `postFeatureUpgrade(this: [That](./That.md), params?: [MigrationPostFeatureUpgradeRequest](./MigrationPostFeatureUpgradeRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MigrationPostFeatureUpgradeResponse](./MigrationPostFeatureUpgradeResponse.md)>;` | Start the feature migration. Version upgrades sometimes require changes to how features store configuration information and data in system indices. This API starts the automatic migration process. Some functionality might be temporarily unavailable during the migration process. TIP: The API is designed for indirect use by the Upgrade Assistant. We strongly recommend you use the Upgrade Assistant. | +| `postFeatureUpgrade` | `postFeatureUpgrade(this: [That](./That.md), params?: [MigrationPostFeatureUpgradeRequest](./MigrationPostFeatureUpgradeRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MigrationPostFeatureUpgradeResponse](./MigrationPostFeatureUpgradeResponse.md), unknown>>;` |   | +| `postFeatureUpgrade` | `postFeatureUpgrade(this: [That](./That.md), params?: [MigrationPostFeatureUpgradeRequest](./MigrationPostFeatureUpgradeRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MigrationPostFeatureUpgradeResponse](./MigrationPostFeatureUpgradeResponse.md)>;` |   | diff --git a/docs/reference/api/Ml.md b/docs/reference/api/Ml.md index 25ca76cc8..438c5dd85 100644 --- a/docs/reference/api/Ml.md +++ b/docs/reference/api/Ml.md @@ -17,4 +17,222 @@ new Ml(transport: [Transport](./Transport.md)); | Name | Signature | Description | | - | - | - | -| `clearTrainedModelDeploymentCache` | `clearTrainedModelDeploymentCache(this: [That](./That.md), params: [MlClearTrainedModelDeploymentCacheRequest](./MlClearTrainedModelDeploymentCacheRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlClearTrainedModelDeploymentCacheResponse](./MlClearTrainedModelDeploymentCacheResponse.md)>;` | Clear trained model deployment cache. Cache will be cleared on all nodes where the trained model is assigned. A trained model deployment may have an inference cache enabled. As requests are handled by each allocated node, their responses may be cached on that individual node. Calling this API clears the caches without restarting the deployment. || `clearTrainedModelDeploymentCache` | `clearTrainedModelDeploymentCache(this: [That](./That.md), params: [MlClearTrainedModelDeploymentCacheRequest](./MlClearTrainedModelDeploymentCacheRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlClearTrainedModelDeploymentCacheResponse](./MlClearTrainedModelDeploymentCacheResponse.md), unknown>>;` |   || `clearTrainedModelDeploymentCache` | `clearTrainedModelDeploymentCache(this: [That](./That.md), params: [MlClearTrainedModelDeploymentCacheRequest](./MlClearTrainedModelDeploymentCacheRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlClearTrainedModelDeploymentCacheResponse](./MlClearTrainedModelDeploymentCacheResponse.md)>;` |   || `closeJob` | `closeJob(this: [That](./That.md), params: [MlCloseJobRequest](./MlCloseJobRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlCloseJobResponse](./MlCloseJobResponse.md)>;` | Close anomaly detection jobs. A job can be opened and closed multiple times throughout its lifecycle. A closed job cannot receive data or perform analysis operations, but you can still explore and navigate results. When you close a job, it runs housekeeping tasks such as pruning the model history, flushing buffers, calculating final results and persisting the model snapshots. Depending upon the size of the job, it could take several minutes to close and the equivalent time to re-open. After it is closed, the job has a minimal overhead on the cluster except for maintaining its meta data. Therefore it is a best practice to close jobs that are no longer required to process data. If you close an anomaly detection job whose datafeed is running, the request first tries to stop the datafeed. This behavior is equivalent to calling stop datafeed API with the same timeout and force parameters as the close job request. When a datafeed that has a specified end date stops, it automatically closes its associated job. || `closeJob` | `closeJob(this: [That](./That.md), params: [MlCloseJobRequest](./MlCloseJobRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlCloseJobResponse](./MlCloseJobResponse.md), unknown>>;` |   || `closeJob` | `closeJob(this: [That](./That.md), params: [MlCloseJobRequest](./MlCloseJobRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlCloseJobResponse](./MlCloseJobResponse.md)>;` |   || `deleteCalendar` | `deleteCalendar(this: [That](./That.md), params: [MlDeleteCalendarRequest](./MlDeleteCalendarRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlDeleteCalendarResponse](./MlDeleteCalendarResponse.md)>;` | Delete a calendar. Remove all scheduled events from a calendar, then delete it. || `deleteCalendar` | `deleteCalendar(this: [That](./That.md), params: [MlDeleteCalendarRequest](./MlDeleteCalendarRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlDeleteCalendarResponse](./MlDeleteCalendarResponse.md), unknown>>;` |   || `deleteCalendar` | `deleteCalendar(this: [That](./That.md), params: [MlDeleteCalendarRequest](./MlDeleteCalendarRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlDeleteCalendarResponse](./MlDeleteCalendarResponse.md)>;` |   || `deleteCalendarEvent` | `deleteCalendarEvent(this: [That](./That.md), params: [MlDeleteCalendarEventRequest](./MlDeleteCalendarEventRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlDeleteCalendarEventResponse](./MlDeleteCalendarEventResponse.md)>;` | Delete events from a calendar. || `deleteCalendarEvent` | `deleteCalendarEvent(this: [That](./That.md), params: [MlDeleteCalendarEventRequest](./MlDeleteCalendarEventRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlDeleteCalendarEventResponse](./MlDeleteCalendarEventResponse.md), unknown>>;` |   || `deleteCalendarEvent` | `deleteCalendarEvent(this: [That](./That.md), params: [MlDeleteCalendarEventRequest](./MlDeleteCalendarEventRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlDeleteCalendarEventResponse](./MlDeleteCalendarEventResponse.md)>;` |   || `deleteCalendarJob` | `deleteCalendarJob(this: [That](./That.md), params: [MlDeleteCalendarJobRequest](./MlDeleteCalendarJobRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlDeleteCalendarJobResponse](./MlDeleteCalendarJobResponse.md)>;` | Delete anomaly jobs from a calendar. || `deleteCalendarJob` | `deleteCalendarJob(this: [That](./That.md), params: [MlDeleteCalendarJobRequest](./MlDeleteCalendarJobRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlDeleteCalendarJobResponse](./MlDeleteCalendarJobResponse.md), unknown>>;` |   || `deleteCalendarJob` | `deleteCalendarJob(this: [That](./That.md), params: [MlDeleteCalendarJobRequest](./MlDeleteCalendarJobRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlDeleteCalendarJobResponse](./MlDeleteCalendarJobResponse.md)>;` |   || `deleteDatafeed` | `deleteDatafeed(this: [That](./That.md), params: [MlDeleteDatafeedRequest](./MlDeleteDatafeedRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlDeleteDatafeedResponse](./MlDeleteDatafeedResponse.md)>;` | Delete a datafeed. || `deleteDatafeed` | `deleteDatafeed(this: [That](./That.md), params: [MlDeleteDatafeedRequest](./MlDeleteDatafeedRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlDeleteDatafeedResponse](./MlDeleteDatafeedResponse.md), unknown>>;` |   || `deleteDatafeed` | `deleteDatafeed(this: [That](./That.md), params: [MlDeleteDatafeedRequest](./MlDeleteDatafeedRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlDeleteDatafeedResponse](./MlDeleteDatafeedResponse.md)>;` |   || `deleteDataFrameAnalytics` | `deleteDataFrameAnalytics(this: [That](./That.md), params: [MlDeleteDataFrameAnalyticsRequest](./MlDeleteDataFrameAnalyticsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlDeleteDataFrameAnalyticsResponse](./MlDeleteDataFrameAnalyticsResponse.md)>;` | Delete a data frame analytics job. || `deleteDataFrameAnalytics` | `deleteDataFrameAnalytics(this: [That](./That.md), params: [MlDeleteDataFrameAnalyticsRequest](./MlDeleteDataFrameAnalyticsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlDeleteDataFrameAnalyticsResponse](./MlDeleteDataFrameAnalyticsResponse.md), unknown>>;` |   || `deleteDataFrameAnalytics` | `deleteDataFrameAnalytics(this: [That](./That.md), params: [MlDeleteDataFrameAnalyticsRequest](./MlDeleteDataFrameAnalyticsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlDeleteDataFrameAnalyticsResponse](./MlDeleteDataFrameAnalyticsResponse.md)>;` |   || `deleteExpiredData` | `deleteExpiredData(this: [That](./That.md), params?: [MlDeleteExpiredDataRequest](./MlDeleteExpiredDataRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlDeleteExpiredDataResponse](./MlDeleteExpiredDataResponse.md)>;` | Delete expired ML data. Delete all job results, model snapshots and forecast data that have exceeded their retention days period. Machine learning state documents that are not associated with any job are also deleted. You can limit the request to a single or set of anomaly detection jobs by using a job identifier, a group name, a comma-separated list of jobs, or a wildcard expression. You can delete expired data for all anomaly detection jobs by using `_all`, by specifying `*` as the ``, or by omitting the ``. || `deleteExpiredData` | `deleteExpiredData(this: [That](./That.md), params?: [MlDeleteExpiredDataRequest](./MlDeleteExpiredDataRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlDeleteExpiredDataResponse](./MlDeleteExpiredDataResponse.md), unknown>>;` |   || `deleteExpiredData` | `deleteExpiredData(this: [That](./That.md), params?: [MlDeleteExpiredDataRequest](./MlDeleteExpiredDataRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlDeleteExpiredDataResponse](./MlDeleteExpiredDataResponse.md)>;` |   || `deleteFilter` | `deleteFilter(this: [That](./That.md), params: [MlDeleteFilterRequest](./MlDeleteFilterRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlDeleteFilterResponse](./MlDeleteFilterResponse.md)>;` | Delete a filter. If an anomaly detection job references the filter, you cannot delete the filter. You must update or delete the job before you can delete the filter. || `deleteFilter` | `deleteFilter(this: [That](./That.md), params: [MlDeleteFilterRequest](./MlDeleteFilterRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlDeleteFilterResponse](./MlDeleteFilterResponse.md), unknown>>;` |   || `deleteFilter` | `deleteFilter(this: [That](./That.md), params: [MlDeleteFilterRequest](./MlDeleteFilterRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlDeleteFilterResponse](./MlDeleteFilterResponse.md)>;` |   || `deleteForecast` | `deleteForecast(this: [That](./That.md), params: [MlDeleteForecastRequest](./MlDeleteForecastRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlDeleteForecastResponse](./MlDeleteForecastResponse.md)>;` | Delete forecasts from a job. By default, forecasts are retained for 14 days. You can specify a different retention period with the `expires_in` parameter in the forecast jobs API. The delete forecast API enables you to delete one or more forecasts before they expire. || `deleteForecast` | `deleteForecast(this: [That](./That.md), params: [MlDeleteForecastRequest](./MlDeleteForecastRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlDeleteForecastResponse](./MlDeleteForecastResponse.md), unknown>>;` |   || `deleteForecast` | `deleteForecast(this: [That](./That.md), params: [MlDeleteForecastRequest](./MlDeleteForecastRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlDeleteForecastResponse](./MlDeleteForecastResponse.md)>;` |   || `deleteJob` | `deleteJob(this: [That](./That.md), params: [MlDeleteJobRequest](./MlDeleteJobRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlDeleteJobResponse](./MlDeleteJobResponse.md)>;` | Delete an anomaly detection job. All job configuration, model state and results are deleted. It is not currently possible to delete multiple jobs using wildcards or a comma separated list. If you delete a job that has a datafeed, the request first tries to delete the datafeed. This behavior is equivalent to calling the delete datafeed API with the same timeout and force parameters as the delete job request. || `deleteJob` | `deleteJob(this: [That](./That.md), params: [MlDeleteJobRequest](./MlDeleteJobRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlDeleteJobResponse](./MlDeleteJobResponse.md), unknown>>;` |   || `deleteJob` | `deleteJob(this: [That](./That.md), params: [MlDeleteJobRequest](./MlDeleteJobRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlDeleteJobResponse](./MlDeleteJobResponse.md)>;` |   || `deleteModelSnapshot` | `deleteModelSnapshot(this: [That](./That.md), params: [MlDeleteModelSnapshotRequest](./MlDeleteModelSnapshotRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlDeleteModelSnapshotResponse](./MlDeleteModelSnapshotResponse.md)>;` | Delete a model snapshot. You cannot delete the active model snapshot. To delete that snapshot, first revert to a different one. To identify the active model snapshot, refer to the `model_snapshot_id` in the results from the get jobs API. || `deleteModelSnapshot` | `deleteModelSnapshot(this: [That](./That.md), params: [MlDeleteModelSnapshotRequest](./MlDeleteModelSnapshotRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlDeleteModelSnapshotResponse](./MlDeleteModelSnapshotResponse.md), unknown>>;` |   || `deleteModelSnapshot` | `deleteModelSnapshot(this: [That](./That.md), params: [MlDeleteModelSnapshotRequest](./MlDeleteModelSnapshotRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlDeleteModelSnapshotResponse](./MlDeleteModelSnapshotResponse.md)>;` |   || `deleteTrainedModel` | `deleteTrainedModel(this: [That](./That.md), params: [MlDeleteTrainedModelRequest](./MlDeleteTrainedModelRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlDeleteTrainedModelResponse](./MlDeleteTrainedModelResponse.md)>;` | Delete an unreferenced trained model. The request deletes a trained inference model that is not referenced by an ingest pipeline. || `deleteTrainedModel` | `deleteTrainedModel(this: [That](./That.md), params: [MlDeleteTrainedModelRequest](./MlDeleteTrainedModelRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlDeleteTrainedModelResponse](./MlDeleteTrainedModelResponse.md), unknown>>;` |   || `deleteTrainedModel` | `deleteTrainedModel(this: [That](./That.md), params: [MlDeleteTrainedModelRequest](./MlDeleteTrainedModelRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlDeleteTrainedModelResponse](./MlDeleteTrainedModelResponse.md)>;` |   || `deleteTrainedModelAlias` | `deleteTrainedModelAlias(this: [That](./That.md), params: [MlDeleteTrainedModelAliasRequest](./MlDeleteTrainedModelAliasRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlDeleteTrainedModelAliasResponse](./MlDeleteTrainedModelAliasResponse.md)>;` | Delete a trained model alias. This API deletes an existing model alias that refers to a trained model. If the model alias is missing or refers to a model other than the one identified by the `model_id`, this API returns an error. || `deleteTrainedModelAlias` | `deleteTrainedModelAlias(this: [That](./That.md), params: [MlDeleteTrainedModelAliasRequest](./MlDeleteTrainedModelAliasRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlDeleteTrainedModelAliasResponse](./MlDeleteTrainedModelAliasResponse.md), unknown>>;` |   || `deleteTrainedModelAlias` | `deleteTrainedModelAlias(this: [That](./That.md), params: [MlDeleteTrainedModelAliasRequest](./MlDeleteTrainedModelAliasRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlDeleteTrainedModelAliasResponse](./MlDeleteTrainedModelAliasResponse.md)>;` |   || `estimateModelMemory` | `estimateModelMemory(this: [That](./That.md), params?: [MlEstimateModelMemoryRequest](./MlEstimateModelMemoryRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlEstimateModelMemoryResponse](./MlEstimateModelMemoryResponse.md)>;` | Estimate job model memory usage. Make an estimation of the memory usage for an anomaly detection job model. The estimate is based on analysis configuration details for the job and cardinality estimates for the fields it references. || `estimateModelMemory` | `estimateModelMemory(this: [That](./That.md), params?: [MlEstimateModelMemoryRequest](./MlEstimateModelMemoryRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlEstimateModelMemoryResponse](./MlEstimateModelMemoryResponse.md), unknown>>;` |   || `estimateModelMemory` | `estimateModelMemory(this: [That](./That.md), params?: [MlEstimateModelMemoryRequest](./MlEstimateModelMemoryRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlEstimateModelMemoryResponse](./MlEstimateModelMemoryResponse.md)>;` |   || `evaluateDataFrame` | `evaluateDataFrame(this: [That](./That.md), params: [MlEvaluateDataFrameRequest](./MlEvaluateDataFrameRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlEvaluateDataFrameResponse](./MlEvaluateDataFrameResponse.md)>;` | Evaluate data frame analytics. The API packages together commonly used evaluation metrics for various types of machine learning features. This has been designed for use on indexes created by data frame analytics. Evaluation requires both a ground truth field and an analytics result field to be present. || `evaluateDataFrame` | `evaluateDataFrame(this: [That](./That.md), params: [MlEvaluateDataFrameRequest](./MlEvaluateDataFrameRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlEvaluateDataFrameResponse](./MlEvaluateDataFrameResponse.md), unknown>>;` |   || `evaluateDataFrame` | `evaluateDataFrame(this: [That](./That.md), params: [MlEvaluateDataFrameRequest](./MlEvaluateDataFrameRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlEvaluateDataFrameResponse](./MlEvaluateDataFrameResponse.md)>;` |   || `explainDataFrameAnalytics` | `explainDataFrameAnalytics(this: [That](./That.md), params?: [MlExplainDataFrameAnalyticsRequest](./MlExplainDataFrameAnalyticsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlExplainDataFrameAnalyticsResponse](./MlExplainDataFrameAnalyticsResponse.md)>;` | Explain data frame analytics config. This API provides explanations for a data frame analytics config that either exists already or one that has not been created yet. The following explanations are provided: * which fields are included or not in the analysis and why, * how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on. If you have object fields or fields that are excluded via source filtering, they are not included in the explanation. || `explainDataFrameAnalytics` | `explainDataFrameAnalytics(this: [That](./That.md), params?: [MlExplainDataFrameAnalyticsRequest](./MlExplainDataFrameAnalyticsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlExplainDataFrameAnalyticsResponse](./MlExplainDataFrameAnalyticsResponse.md), unknown>>;` |   || `explainDataFrameAnalytics` | `explainDataFrameAnalytics(this: [That](./That.md), params?: [MlExplainDataFrameAnalyticsRequest](./MlExplainDataFrameAnalyticsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlExplainDataFrameAnalyticsResponse](./MlExplainDataFrameAnalyticsResponse.md)>;` |   || `flushJob` | `flushJob(this: [That](./That.md), params: [MlFlushJobRequest](./MlFlushJobRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlFlushJobResponse](./MlFlushJobResponse.md)>;` | Force buffered data to be processed. The flush jobs API is only applicable when sending data for analysis using the post data API. Depending on the content of the buffer, then it might additionally calculate new results. Both flush and close operations are similar, however the flush is more efficient if you are expecting to send more data for analysis. When flushing, the job remains open and is available to continue analyzing data. A close operation additionally prunes and persists the model state to disk and the job must be opened again before analyzing further data. || `flushJob` | `flushJob(this: [That](./That.md), params: [MlFlushJobRequest](./MlFlushJobRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlFlushJobResponse](./MlFlushJobResponse.md), unknown>>;` |   || `flushJob` | `flushJob(this: [That](./That.md), params: [MlFlushJobRequest](./MlFlushJobRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlFlushJobResponse](./MlFlushJobResponse.md)>;` |   || `forecast` | `forecast(this: [That](./That.md), params: [MlForecastRequest](./MlForecastRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlForecastResponse](./MlForecastResponse.md)>;` | Predict future behavior of a time series. Forecasts are not supported for jobs that perform population analysis; an error occurs if you try to create a forecast for a job that has an `over_field_name` in its configuration. Forcasts predict future behavior based on historical data. || `forecast` | `forecast(this: [That](./That.md), params: [MlForecastRequest](./MlForecastRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlForecastResponse](./MlForecastResponse.md), unknown>>;` |   || `forecast` | `forecast(this: [That](./That.md), params: [MlForecastRequest](./MlForecastRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlForecastResponse](./MlForecastResponse.md)>;` |   || `getBuckets` | `getBuckets(this: [That](./That.md), params: [MlGetBucketsRequest](./MlGetBucketsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlGetBucketsResponse](./MlGetBucketsResponse.md)>;` | Get anomaly detection job results for buckets. The API presents a chronological view of the records, grouped by bucket. || `getBuckets` | `getBuckets(this: [That](./That.md), params: [MlGetBucketsRequest](./MlGetBucketsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlGetBucketsResponse](./MlGetBucketsResponse.md), unknown>>;` |   || `getBuckets` | `getBuckets(this: [That](./That.md), params: [MlGetBucketsRequest](./MlGetBucketsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlGetBucketsResponse](./MlGetBucketsResponse.md)>;` |   || `getCalendarEvents` | `getCalendarEvents(this: [That](./That.md), params: [MlGetCalendarEventsRequest](./MlGetCalendarEventsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlGetCalendarEventsResponse](./MlGetCalendarEventsResponse.md)>;` | Get info about events in calendars. || `getCalendarEvents` | `getCalendarEvents(this: [That](./That.md), params: [MlGetCalendarEventsRequest](./MlGetCalendarEventsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlGetCalendarEventsResponse](./MlGetCalendarEventsResponse.md), unknown>>;` |   || `getCalendarEvents` | `getCalendarEvents(this: [That](./That.md), params: [MlGetCalendarEventsRequest](./MlGetCalendarEventsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlGetCalendarEventsResponse](./MlGetCalendarEventsResponse.md)>;` |   || `getCalendars` | `getCalendars(this: [That](./That.md), params?: [MlGetCalendarsRequest](./MlGetCalendarsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlGetCalendarsResponse](./MlGetCalendarsResponse.md)>;` | Get calendar configuration info. || `getCalendars` | `getCalendars(this: [That](./That.md), params?: [MlGetCalendarsRequest](./MlGetCalendarsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlGetCalendarsResponse](./MlGetCalendarsResponse.md), unknown>>;` |   || `getCalendars` | `getCalendars(this: [That](./That.md), params?: [MlGetCalendarsRequest](./MlGetCalendarsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlGetCalendarsResponse](./MlGetCalendarsResponse.md)>;` |   || `getCategories` | `getCategories(this: [That](./That.md), params: [MlGetCategoriesRequest](./MlGetCategoriesRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlGetCategoriesResponse](./MlGetCategoriesResponse.md)>;` | Get anomaly detection job results for categories. || `getCategories` | `getCategories(this: [That](./That.md), params: [MlGetCategoriesRequest](./MlGetCategoriesRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlGetCategoriesResponse](./MlGetCategoriesResponse.md), unknown>>;` |   || `getCategories` | `getCategories(this: [That](./That.md), params: [MlGetCategoriesRequest](./MlGetCategoriesRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlGetCategoriesResponse](./MlGetCategoriesResponse.md)>;` |   || `getDatafeeds` | `getDatafeeds(this: [That](./That.md), params?: [MlGetDatafeedsRequest](./MlGetDatafeedsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlGetDatafeedsResponse](./MlGetDatafeedsResponse.md)>;` | Get datafeeds configuration info. You can get information for multiple datafeeds in a single API request by using a comma-separated list of datafeeds or a wildcard expression. You can get information for all datafeeds by using `_all`, by specifying `*` as the ``, or by omitting the ``. This API returns a maximum of 10,000 datafeeds. || `getDatafeeds` | `getDatafeeds(this: [That](./That.md), params?: [MlGetDatafeedsRequest](./MlGetDatafeedsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlGetDatafeedsResponse](./MlGetDatafeedsResponse.md), unknown>>;` |   || `getDatafeeds` | `getDatafeeds(this: [That](./That.md), params?: [MlGetDatafeedsRequest](./MlGetDatafeedsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlGetDatafeedsResponse](./MlGetDatafeedsResponse.md)>;` |   || `getDatafeedStats` | `getDatafeedStats(this: [That](./That.md), params?: [MlGetDatafeedStatsRequest](./MlGetDatafeedStatsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlGetDatafeedStatsResponse](./MlGetDatafeedStatsResponse.md)>;` | Get datafeed stats. You can get statistics for multiple datafeeds in a single API request by using a comma-separated list of datafeeds or a wildcard expression. You can get statistics for all datafeeds by using `_all`, by specifying `*` as the ``, or by omitting the ``. If the datafeed is stopped, the only information you receive is the `datafeed_id` and the `state`. This API returns a maximum of 10,000 datafeeds. || `getDatafeedStats` | `getDatafeedStats(this: [That](./That.md), params?: [MlGetDatafeedStatsRequest](./MlGetDatafeedStatsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlGetDatafeedStatsResponse](./MlGetDatafeedStatsResponse.md), unknown>>;` |   || `getDatafeedStats` | `getDatafeedStats(this: [That](./That.md), params?: [MlGetDatafeedStatsRequest](./MlGetDatafeedStatsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlGetDatafeedStatsResponse](./MlGetDatafeedStatsResponse.md)>;` |   || `getDataFrameAnalytics` | `getDataFrameAnalytics(this: [That](./That.md), params?: [MlGetDataFrameAnalyticsRequest](./MlGetDataFrameAnalyticsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlGetDataFrameAnalyticsResponse](./MlGetDataFrameAnalyticsResponse.md)>;` | Get data frame analytics job configuration info. You can get information for multiple data frame analytics jobs in a single API request by using a comma-separated list of data frame analytics jobs or a wildcard expression. || `getDataFrameAnalytics` | `getDataFrameAnalytics(this: [That](./That.md), params?: [MlGetDataFrameAnalyticsRequest](./MlGetDataFrameAnalyticsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlGetDataFrameAnalyticsResponse](./MlGetDataFrameAnalyticsResponse.md), unknown>>;` |   || `getDataFrameAnalytics` | `getDataFrameAnalytics(this: [That](./That.md), params?: [MlGetDataFrameAnalyticsRequest](./MlGetDataFrameAnalyticsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlGetDataFrameAnalyticsResponse](./MlGetDataFrameAnalyticsResponse.md)>;` |   || `getDataFrameAnalyticsStats` | `getDataFrameAnalyticsStats(this: [That](./That.md), params?: [MlGetDataFrameAnalyticsStatsRequest](./MlGetDataFrameAnalyticsStatsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlGetDataFrameAnalyticsStatsResponse](./MlGetDataFrameAnalyticsStatsResponse.md)>;` | Get data frame analytics job stats. || `getDataFrameAnalyticsStats` | `getDataFrameAnalyticsStats(this: [That](./That.md), params?: [MlGetDataFrameAnalyticsStatsRequest](./MlGetDataFrameAnalyticsStatsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlGetDataFrameAnalyticsStatsResponse](./MlGetDataFrameAnalyticsStatsResponse.md), unknown>>;` |   || `getDataFrameAnalyticsStats` | `getDataFrameAnalyticsStats(this: [That](./That.md), params?: [MlGetDataFrameAnalyticsStatsRequest](./MlGetDataFrameAnalyticsStatsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlGetDataFrameAnalyticsStatsResponse](./MlGetDataFrameAnalyticsStatsResponse.md)>;` |   || `getFilters` | `getFilters(this: [That](./That.md), params?: [MlGetFiltersRequest](./MlGetFiltersRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlGetFiltersResponse](./MlGetFiltersResponse.md)>;` | Get filters. You can get a single filter or all filters. || `getFilters` | `getFilters(this: [That](./That.md), params?: [MlGetFiltersRequest](./MlGetFiltersRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlGetFiltersResponse](./MlGetFiltersResponse.md), unknown>>;` |   || `getFilters` | `getFilters(this: [That](./That.md), params?: [MlGetFiltersRequest](./MlGetFiltersRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlGetFiltersResponse](./MlGetFiltersResponse.md)>;` |   || `getInfluencers` | `getInfluencers(this: [That](./That.md), params: [MlGetInfluencersRequest](./MlGetInfluencersRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlGetInfluencersResponse](./MlGetInfluencersResponse.md)>;` | Get anomaly detection job results for influencers. Influencers are the entities that have contributed to, or are to blame for, the anomalies. Influencer results are available only if an `influencer_field_name` is specified in the job configuration. || `getInfluencers` | `getInfluencers(this: [That](./That.md), params: [MlGetInfluencersRequest](./MlGetInfluencersRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlGetInfluencersResponse](./MlGetInfluencersResponse.md), unknown>>;` |   || `getInfluencers` | `getInfluencers(this: [That](./That.md), params: [MlGetInfluencersRequest](./MlGetInfluencersRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlGetInfluencersResponse](./MlGetInfluencersResponse.md)>;` |   || `getJobs` | `getJobs(this: [That](./That.md), params?: [MlGetJobsRequest](./MlGetJobsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlGetJobsResponse](./MlGetJobsResponse.md)>;` | Get anomaly detection jobs configuration info. You can get information for multiple anomaly detection jobs in a single API request by using a group name, a comma-separated list of jobs, or a wildcard expression. You can get information for all anomaly detection jobs by using `_all`, by specifying `*` as the ``, or by omitting the ``. || `getJobs` | `getJobs(this: [That](./That.md), params?: [MlGetJobsRequest](./MlGetJobsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlGetJobsResponse](./MlGetJobsResponse.md), unknown>>;` |   || `getJobs` | `getJobs(this: [That](./That.md), params?: [MlGetJobsRequest](./MlGetJobsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlGetJobsResponse](./MlGetJobsResponse.md)>;` |   || `getJobStats` | `getJobStats(this: [That](./That.md), params?: [MlGetJobStatsRequest](./MlGetJobStatsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlGetJobStatsResponse](./MlGetJobStatsResponse.md)>;` | Get anomaly detection job stats. || `getJobStats` | `getJobStats(this: [That](./That.md), params?: [MlGetJobStatsRequest](./MlGetJobStatsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlGetJobStatsResponse](./MlGetJobStatsResponse.md), unknown>>;` |   || `getJobStats` | `getJobStats(this: [That](./That.md), params?: [MlGetJobStatsRequest](./MlGetJobStatsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlGetJobStatsResponse](./MlGetJobStatsResponse.md)>;` |   || `getMemoryStats` | `getMemoryStats(this: [That](./That.md), params?: [MlGetMemoryStatsRequest](./MlGetMemoryStatsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlGetMemoryStatsResponse](./MlGetMemoryStatsResponse.md)>;` | Get machine learning memory usage info. Get information about how machine learning jobs and trained models are using memory, on each node, both within the JVM heap, and natively, outside of the JVM. || `getMemoryStats` | `getMemoryStats(this: [That](./That.md), params?: [MlGetMemoryStatsRequest](./MlGetMemoryStatsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlGetMemoryStatsResponse](./MlGetMemoryStatsResponse.md), unknown>>;` |   || `getMemoryStats` | `getMemoryStats(this: [That](./That.md), params?: [MlGetMemoryStatsRequest](./MlGetMemoryStatsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlGetMemoryStatsResponse](./MlGetMemoryStatsResponse.md)>;` |   || `getModelSnapshots` | `getModelSnapshots(this: [That](./That.md), params: [MlGetModelSnapshotsRequest](./MlGetModelSnapshotsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlGetModelSnapshotsResponse](./MlGetModelSnapshotsResponse.md)>;` | Get model snapshots info. || `getModelSnapshots` | `getModelSnapshots(this: [That](./That.md), params: [MlGetModelSnapshotsRequest](./MlGetModelSnapshotsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlGetModelSnapshotsResponse](./MlGetModelSnapshotsResponse.md), unknown>>;` |   || `getModelSnapshots` | `getModelSnapshots(this: [That](./That.md), params: [MlGetModelSnapshotsRequest](./MlGetModelSnapshotsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlGetModelSnapshotsResponse](./MlGetModelSnapshotsResponse.md)>;` |   || `getModelSnapshotUpgradeStats` | `getModelSnapshotUpgradeStats(this: [That](./That.md), params: [MlGetModelSnapshotUpgradeStatsRequest](./MlGetModelSnapshotUpgradeStatsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlGetModelSnapshotUpgradeStatsResponse](./MlGetModelSnapshotUpgradeStatsResponse.md)>;` | Get anomaly detection job model snapshot upgrade usage info. || `getModelSnapshotUpgradeStats` | `getModelSnapshotUpgradeStats(this: [That](./That.md), params: [MlGetModelSnapshotUpgradeStatsRequest](./MlGetModelSnapshotUpgradeStatsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlGetModelSnapshotUpgradeStatsResponse](./MlGetModelSnapshotUpgradeStatsResponse.md), unknown>>;` |   || `getModelSnapshotUpgradeStats` | `getModelSnapshotUpgradeStats(this: [That](./That.md), params: [MlGetModelSnapshotUpgradeStatsRequest](./MlGetModelSnapshotUpgradeStatsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlGetModelSnapshotUpgradeStatsResponse](./MlGetModelSnapshotUpgradeStatsResponse.md)>;` |   || `getOverallBuckets` | `getOverallBuckets(this: [That](./That.md), params: [MlGetOverallBucketsRequest](./MlGetOverallBucketsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlGetOverallBucketsResponse](./MlGetOverallBucketsResponse.md)>;` | Get overall bucket results. Retrievs overall bucket results that summarize the bucket results of multiple anomaly detection jobs. The `overall_score` is calculated by combining the scores of all the buckets within the overall bucket span. First, the maximum `anomaly_score` per anomaly detection job in the overall bucket is calculated. Then the `top_n` of those scores are averaged to result in the `overall_score`. This means that you can fine-tune the `overall_score` so that it is more or less sensitive to the number of jobs that detect an anomaly at the same time. For example, if you set `top_n` to `1`, the `overall_score` is the maximum bucket score in the overall bucket. Alternatively, if you set `top_n` to the number of jobs, the `overall_score` is high only when all jobs detect anomalies in that overall bucket. If you set the `bucket_span` parameter (to a value greater than its default), the `overall_score` is the maximum `overall_score` of the overall buckets that have a span equal to the jobs' largest bucket span. || `getOverallBuckets` | `getOverallBuckets(this: [That](./That.md), params: [MlGetOverallBucketsRequest](./MlGetOverallBucketsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlGetOverallBucketsResponse](./MlGetOverallBucketsResponse.md), unknown>>;` |   || `getOverallBuckets` | `getOverallBuckets(this: [That](./That.md), params: [MlGetOverallBucketsRequest](./MlGetOverallBucketsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlGetOverallBucketsResponse](./MlGetOverallBucketsResponse.md)>;` |   || `getRecords` | `getRecords(this: [That](./That.md), params: [MlGetRecordsRequest](./MlGetRecordsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlGetRecordsResponse](./MlGetRecordsResponse.md)>;` | Get anomaly records for an anomaly detection job. Records contain the detailed analytical results. They describe the anomalous activity that has been identified in the input data based on the detector configuration. There can be many anomaly records depending on the characteristics and size of the input data. In practice, there are often too many to be able to manually process them. The machine learning features therefore perform a sophisticated aggregation of the anomaly records into buckets. The number of record results depends on the number of anomalies found in each bucket, which relates to the number of time series being modeled and the number of detectors. || `getRecords` | `getRecords(this: [That](./That.md), params: [MlGetRecordsRequest](./MlGetRecordsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlGetRecordsResponse](./MlGetRecordsResponse.md), unknown>>;` |   || `getRecords` | `getRecords(this: [That](./That.md), params: [MlGetRecordsRequest](./MlGetRecordsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlGetRecordsResponse](./MlGetRecordsResponse.md)>;` |   || `getTrainedModels` | `getTrainedModels(this: [That](./That.md), params?: [MlGetTrainedModelsRequest](./MlGetTrainedModelsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlGetTrainedModelsResponse](./MlGetTrainedModelsResponse.md)>;` | Get trained model configuration info. || `getTrainedModels` | `getTrainedModels(this: [That](./That.md), params?: [MlGetTrainedModelsRequest](./MlGetTrainedModelsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlGetTrainedModelsResponse](./MlGetTrainedModelsResponse.md), unknown>>;` |   || `getTrainedModels` | `getTrainedModels(this: [That](./That.md), params?: [MlGetTrainedModelsRequest](./MlGetTrainedModelsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlGetTrainedModelsResponse](./MlGetTrainedModelsResponse.md)>;` |   || `getTrainedModelsStats` | `getTrainedModelsStats(this: [That](./That.md), params?: [MlGetTrainedModelsStatsRequest](./MlGetTrainedModelsStatsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlGetTrainedModelsStatsResponse](./MlGetTrainedModelsStatsResponse.md)>;` | Get trained models usage info. You can get usage information for multiple trained models in a single API request by using a comma-separated list of model IDs or a wildcard expression. || `getTrainedModelsStats` | `getTrainedModelsStats(this: [That](./That.md), params?: [MlGetTrainedModelsStatsRequest](./MlGetTrainedModelsStatsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlGetTrainedModelsStatsResponse](./MlGetTrainedModelsStatsResponse.md), unknown>>;` |   || `getTrainedModelsStats` | `getTrainedModelsStats(this: [That](./That.md), params?: [MlGetTrainedModelsStatsRequest](./MlGetTrainedModelsStatsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlGetTrainedModelsStatsResponse](./MlGetTrainedModelsStatsResponse.md)>;` |   || `inferTrainedModel` | `inferTrainedModel(this: [That](./That.md), params: [MlInferTrainedModelRequest](./MlInferTrainedModelRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlInferTrainedModelResponse](./MlInferTrainedModelResponse.md)>;` | Evaluate a trained model. || `inferTrainedModel` | `inferTrainedModel(this: [That](./That.md), params: [MlInferTrainedModelRequest](./MlInferTrainedModelRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlInferTrainedModelResponse](./MlInferTrainedModelResponse.md), unknown>>;` |   || `inferTrainedModel` | `inferTrainedModel(this: [That](./That.md), params: [MlInferTrainedModelRequest](./MlInferTrainedModelRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlInferTrainedModelResponse](./MlInferTrainedModelResponse.md)>;` |   || `info` | `info(this: [That](./That.md), params?: [MlInfoRequest](./MlInfoRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlInfoResponse](./MlInfoResponse.md)>;` | Get machine learning information. Get defaults and limits used by machine learning. This endpoint is designed to be used by a user interface that needs to fully understand machine learning configurations where some options are not specified, meaning that the defaults should be used. This endpoint may be used to find out what those defaults are. It also provides information about the maximum size of machine learning jobs that could run in the current cluster configuration. || `info` | `info(this: [That](./That.md), params?: [MlInfoRequest](./MlInfoRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlInfoResponse](./MlInfoResponse.md), unknown>>;` |   || `info` | `info(this: [That](./That.md), params?: [MlInfoRequest](./MlInfoRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlInfoResponse](./MlInfoResponse.md)>;` |   || `openJob` | `openJob(this: [That](./That.md), params: [MlOpenJobRequest](./MlOpenJobRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlOpenJobResponse](./MlOpenJobResponse.md)>;` | Open anomaly detection jobs. An anomaly detection job must be opened to be ready to receive and analyze data. It can be opened and closed multiple times throughout its lifecycle. When you open a new job, it starts with an empty model. When you open an existing job, the most recent model state is automatically loaded. The job is ready to resume its analysis from where it left off, once new data is received. || `openJob` | `openJob(this: [That](./That.md), params: [MlOpenJobRequest](./MlOpenJobRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlOpenJobResponse](./MlOpenJobResponse.md), unknown>>;` |   || `openJob` | `openJob(this: [That](./That.md), params: [MlOpenJobRequest](./MlOpenJobRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlOpenJobResponse](./MlOpenJobResponse.md)>;` |   || `postCalendarEvents` | `postCalendarEvents(this: [That](./That.md), params: [MlPostCalendarEventsRequest](./MlPostCalendarEventsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlPostCalendarEventsResponse](./MlPostCalendarEventsResponse.md)>;` | Add scheduled events to the calendar. || `postCalendarEvents` | `postCalendarEvents(this: [That](./That.md), params: [MlPostCalendarEventsRequest](./MlPostCalendarEventsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlPostCalendarEventsResponse](./MlPostCalendarEventsResponse.md), unknown>>;` |   || `postCalendarEvents` | `postCalendarEvents(this: [That](./That.md), params: [MlPostCalendarEventsRequest](./MlPostCalendarEventsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlPostCalendarEventsResponse](./MlPostCalendarEventsResponse.md)>;` |   || `postData` | `postData(this: [That](./That.md), params: [MlPostDataRequest](./MlPostDataRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlPostDataResponse](./MlPostDataResponse.md)>;` | Send data to an anomaly detection job for analysis. IMPORTANT: For each job, data can be accepted from only a single connection at a time. It is not currently possible to post data to multiple jobs using wildcards or a comma-separated list. || `postData` | `postData(this: [That](./That.md), params: [MlPostDataRequest](./MlPostDataRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlPostDataResponse](./MlPostDataResponse.md), unknown>>;` |   || `postData` | `postData(this: [That](./That.md), params: [MlPostDataRequest](./MlPostDataRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlPostDataResponse](./MlPostDataResponse.md)>;` |   || `previewDatafeed` | `previewDatafeed(this: [That](./That.md), params?: [MlPreviewDatafeedRequest](./MlPreviewDatafeedRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlPreviewDatafeedResponse](./MlPreviewDatafeedResponse.md)>;` | Preview a datafeed. This API returns the first "page" of search results from a datafeed. You can preview an existing datafeed or provide configuration details for a datafeed and anomaly detection job in the API. The preview shows the structure of the data that will be passed to the anomaly detection engine. IMPORTANT: When Elasticsearch security features are enabled, the preview uses the credentials of the user that called the API. However, when the datafeed starts it uses the roles of the last user that created or updated the datafeed. To get a preview that accurately reflects the behavior of the datafeed, use the appropriate credentials. You can also use secondary authorization headers to supply the credentials. || `previewDatafeed` | `previewDatafeed(this: [That](./That.md), params?: [MlPreviewDatafeedRequest](./MlPreviewDatafeedRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlPreviewDatafeedResponse](./MlPreviewDatafeedResponse.md), unknown>>;` |   || `previewDatafeed` | `previewDatafeed(this: [That](./That.md), params?: [MlPreviewDatafeedRequest](./MlPreviewDatafeedRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlPreviewDatafeedResponse](./MlPreviewDatafeedResponse.md)>;` |   || `previewDataFrameAnalytics` | `previewDataFrameAnalytics(this: [That](./That.md), params?: [MlPreviewDataFrameAnalyticsRequest](./MlPreviewDataFrameAnalyticsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlPreviewDataFrameAnalyticsResponse](./MlPreviewDataFrameAnalyticsResponse.md)>;` | Preview features used by data frame analytics. Preview the extracted features used by a data frame analytics config. || `previewDataFrameAnalytics` | `previewDataFrameAnalytics(this: [That](./That.md), params?: [MlPreviewDataFrameAnalyticsRequest](./MlPreviewDataFrameAnalyticsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlPreviewDataFrameAnalyticsResponse](./MlPreviewDataFrameAnalyticsResponse.md), unknown>>;` |   || `previewDataFrameAnalytics` | `previewDataFrameAnalytics(this: [That](./That.md), params?: [MlPreviewDataFrameAnalyticsRequest](./MlPreviewDataFrameAnalyticsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlPreviewDataFrameAnalyticsResponse](./MlPreviewDataFrameAnalyticsResponse.md)>;` |   || `putCalendar` | `putCalendar(this: [That](./That.md), params: [MlPutCalendarRequest](./MlPutCalendarRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlPutCalendarResponse](./MlPutCalendarResponse.md)>;` | Create a calendar. || `putCalendar` | `putCalendar(this: [That](./That.md), params: [MlPutCalendarRequest](./MlPutCalendarRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlPutCalendarResponse](./MlPutCalendarResponse.md), unknown>>;` |   || `putCalendar` | `putCalendar(this: [That](./That.md), params: [MlPutCalendarRequest](./MlPutCalendarRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlPutCalendarResponse](./MlPutCalendarResponse.md)>;` |   || `putCalendarJob` | `putCalendarJob(this: [That](./That.md), params: [MlPutCalendarJobRequest](./MlPutCalendarJobRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlPutCalendarJobResponse](./MlPutCalendarJobResponse.md)>;` | Add anomaly detection job to calendar. || `putCalendarJob` | `putCalendarJob(this: [That](./That.md), params: [MlPutCalendarJobRequest](./MlPutCalendarJobRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlPutCalendarJobResponse](./MlPutCalendarJobResponse.md), unknown>>;` |   || `putCalendarJob` | `putCalendarJob(this: [That](./That.md), params: [MlPutCalendarJobRequest](./MlPutCalendarJobRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlPutCalendarJobResponse](./MlPutCalendarJobResponse.md)>;` |   || `putDatafeed` | `putDatafeed(this: [That](./That.md), params: [MlPutDatafeedRequest](./MlPutDatafeedRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlPutDatafeedResponse](./MlPutDatafeedResponse.md)>;` | Create a datafeed. Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job. You can associate only one datafeed with each anomaly detection job. The datafeed contains a query that runs at a defined interval ( `frequency`). If you are concerned about delayed data, you can add a delay ( `query_delay') at each interval. By default, the datafeed uses the following query: `{ "match_all": { "boost": 1 } } `. When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead. You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed directly to the `.ml-config ` index. Do not give users `write ` privileges on the `.ml-config ` index. || `putDatafeed` | `putDatafeed(this: [That](./That.md), params: [MlPutDatafeedRequest](./MlPutDatafeedRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlPutDatafeedResponse](./MlPutDatafeedResponse.md), unknown>>;` |   || `putDatafeed` | `putDatafeed(this: [That](./That.md), params: [MlPutDatafeedRequest](./MlPutDatafeedRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlPutDatafeedResponse](./MlPutDatafeedResponse.md)>;` |   || `putDataFrameAnalytics` | `putDataFrameAnalytics(this: [That](./That.md), params: [MlPutDataFrameAnalyticsRequest](./MlPutDataFrameAnalyticsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlPutDataFrameAnalyticsResponse](./MlPutDataFrameAnalyticsResponse.md)>;` | Create a data frame analytics job. This API creates a data frame analytics job that performs an analysis on the source indices and stores the outcome in a destination index. By default, the query used in the source configuration is `{"match_all": {}}`. If the destination index does not exist, it is created automatically when you start the job. If you supply only a subset of the regression or classification parameters, hyperparameter optimization occurs. It determines a value for each of the undefined parameters. || `putDataFrameAnalytics` | `putDataFrameAnalytics(this: [That](./That.md), params: [MlPutDataFrameAnalyticsRequest](./MlPutDataFrameAnalyticsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlPutDataFrameAnalyticsResponse](./MlPutDataFrameAnalyticsResponse.md), unknown>>;` |   || `putDataFrameAnalytics` | `putDataFrameAnalytics(this: [That](./That.md), params: [MlPutDataFrameAnalyticsRequest](./MlPutDataFrameAnalyticsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlPutDataFrameAnalyticsResponse](./MlPutDataFrameAnalyticsResponse.md)>;` |   || `putFilter` | `putFilter(this: [That](./That.md), params: [MlPutFilterRequest](./MlPutFilterRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlPutFilterResponse](./MlPutFilterResponse.md)>;` | Create a filter. A filter contains a list of strings. It can be used by one or more anomaly detection jobs. Specifically, filters are referenced in the `custom_rules` property of detector configuration objects. || `putFilter` | `putFilter(this: [That](./That.md), params: [MlPutFilterRequest](./MlPutFilterRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlPutFilterResponse](./MlPutFilterResponse.md), unknown>>;` |   || `putFilter` | `putFilter(this: [That](./That.md), params: [MlPutFilterRequest](./MlPutFilterRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlPutFilterResponse](./MlPutFilterResponse.md)>;` |   || `putJob` | `putJob(this: [That](./That.md), params: [MlPutJobRequest](./MlPutJobRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlPutJobResponse](./MlPutJobResponse.md)>;` | Create an anomaly detection job. If you include a `datafeed_config`, you must have read index privileges on the source index. If you include a `datafeed_config` but do not provide a query, the datafeed uses `{"match_all": {"boost": 1}}`. || `putJob` | `putJob(this: [That](./That.md), params: [MlPutJobRequest](./MlPutJobRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlPutJobResponse](./MlPutJobResponse.md), unknown>>;` |   || `putJob` | `putJob(this: [That](./That.md), params: [MlPutJobRequest](./MlPutJobRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlPutJobResponse](./MlPutJobResponse.md)>;` |   || `putTrainedModel` | `putTrainedModel(this: [That](./That.md), params: [MlPutTrainedModelRequest](./MlPutTrainedModelRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlPutTrainedModelResponse](./MlPutTrainedModelResponse.md)>;` | Create a trained model. Enable you to supply a trained model that is not created by data frame analytics. || `putTrainedModel` | `putTrainedModel(this: [That](./That.md), params: [MlPutTrainedModelRequest](./MlPutTrainedModelRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlPutTrainedModelResponse](./MlPutTrainedModelResponse.md), unknown>>;` |   || `putTrainedModel` | `putTrainedModel(this: [That](./That.md), params: [MlPutTrainedModelRequest](./MlPutTrainedModelRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlPutTrainedModelResponse](./MlPutTrainedModelResponse.md)>;` |   || `putTrainedModelAlias` | `putTrainedModelAlias(this: [That](./That.md), params: [MlPutTrainedModelAliasRequest](./MlPutTrainedModelAliasRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlPutTrainedModelAliasResponse](./MlPutTrainedModelAliasResponse.md)>;` | Create or update a trained model alias. A trained model alias is a logical name used to reference a single trained model. You can use aliases instead of trained model identifiers to make it easier to reference your models. For example, you can use aliases in inference aggregations and processors. An alias must be unique and refer to only a single trained model. However, you can have multiple aliases for each trained model. If you use this API to update an alias such that it references a different trained model ID and the model uses a different type of data frame analytics, an error occurs. For example, this situation occurs if you have a trained model for regression analysis and a trained model for classification analysis; you cannot reassign an alias from one type of trained model to another. If you use this API to update an alias and there are very few input fields in common between the old and new trained models for the model alias, the API returns a warning. || `putTrainedModelAlias` | `putTrainedModelAlias(this: [That](./That.md), params: [MlPutTrainedModelAliasRequest](./MlPutTrainedModelAliasRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlPutTrainedModelAliasResponse](./MlPutTrainedModelAliasResponse.md), unknown>>;` |   || `putTrainedModelAlias` | `putTrainedModelAlias(this: [That](./That.md), params: [MlPutTrainedModelAliasRequest](./MlPutTrainedModelAliasRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlPutTrainedModelAliasResponse](./MlPutTrainedModelAliasResponse.md)>;` |   || `putTrainedModelDefinitionPart` | `putTrainedModelDefinitionPart(this: [That](./That.md), params: [MlPutTrainedModelDefinitionPartRequest](./MlPutTrainedModelDefinitionPartRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlPutTrainedModelDefinitionPartResponse](./MlPutTrainedModelDefinitionPartResponse.md)>;` | Create part of a trained model definition. || `putTrainedModelDefinitionPart` | `putTrainedModelDefinitionPart(this: [That](./That.md), params: [MlPutTrainedModelDefinitionPartRequest](./MlPutTrainedModelDefinitionPartRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlPutTrainedModelDefinitionPartResponse](./MlPutTrainedModelDefinitionPartResponse.md), unknown>>;` |   || `putTrainedModelDefinitionPart` | `putTrainedModelDefinitionPart(this: [That](./That.md), params: [MlPutTrainedModelDefinitionPartRequest](./MlPutTrainedModelDefinitionPartRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlPutTrainedModelDefinitionPartResponse](./MlPutTrainedModelDefinitionPartResponse.md)>;` |   || `putTrainedModelVocabulary` | `putTrainedModelVocabulary(this: [That](./That.md), params: [MlPutTrainedModelVocabularyRequest](./MlPutTrainedModelVocabularyRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlPutTrainedModelVocabularyResponse](./MlPutTrainedModelVocabularyResponse.md)>;` | Create a trained model vocabulary. This API is supported only for natural language processing (NLP) models. The vocabulary is stored in the index as described in `inference_config.*.vocabulary` of the trained model definition. || `putTrainedModelVocabulary` | `putTrainedModelVocabulary(this: [That](./That.md), params: [MlPutTrainedModelVocabularyRequest](./MlPutTrainedModelVocabularyRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlPutTrainedModelVocabularyResponse](./MlPutTrainedModelVocabularyResponse.md), unknown>>;` |   || `putTrainedModelVocabulary` | `putTrainedModelVocabulary(this: [That](./That.md), params: [MlPutTrainedModelVocabularyRequest](./MlPutTrainedModelVocabularyRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlPutTrainedModelVocabularyResponse](./MlPutTrainedModelVocabularyResponse.md)>;` |   || `resetJob` | `resetJob(this: [That](./That.md), params: [MlResetJobRequest](./MlResetJobRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlResetJobResponse](./MlResetJobResponse.md)>;` | Reset an anomaly detection job. All model state and results are deleted. The job is ready to start over as if it had just been created. It is not currently possible to reset multiple jobs using wildcards or a comma separated list. || `resetJob` | `resetJob(this: [That](./That.md), params: [MlResetJobRequest](./MlResetJobRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlResetJobResponse](./MlResetJobResponse.md), unknown>>;` |   || `resetJob` | `resetJob(this: [That](./That.md), params: [MlResetJobRequest](./MlResetJobRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlResetJobResponse](./MlResetJobResponse.md)>;` |   || `revertModelSnapshot` | `revertModelSnapshot(this: [That](./That.md), params: [MlRevertModelSnapshotRequest](./MlRevertModelSnapshotRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlRevertModelSnapshotResponse](./MlRevertModelSnapshotResponse.md)>;` | Revert to a snapshot. The machine learning features react quickly to anomalous input, learning new behaviors in data. Highly anomalous input increases the variance in the models whilst the system learns whether this is a new step-change in behavior or a one-off event. In the case where this anomalous input is known to be a one-off, then it might be appropriate to reset the model state to a time before this event. For example, you might consider reverting to a saved snapshot after Black Friday or a critical system failure. || `revertModelSnapshot` | `revertModelSnapshot(this: [That](./That.md), params: [MlRevertModelSnapshotRequest](./MlRevertModelSnapshotRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlRevertModelSnapshotResponse](./MlRevertModelSnapshotResponse.md), unknown>>;` |   || `revertModelSnapshot` | `revertModelSnapshot(this: [That](./That.md), params: [MlRevertModelSnapshotRequest](./MlRevertModelSnapshotRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlRevertModelSnapshotResponse](./MlRevertModelSnapshotResponse.md)>;` |   || `setUpgradeMode` | `setUpgradeMode(this: [That](./That.md), params?: [MlSetUpgradeModeRequest](./MlSetUpgradeModeRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlSetUpgradeModeResponse](./MlSetUpgradeModeResponse.md)>;` | Set upgrade_mode for ML indices. Sets a cluster wide upgrade_mode setting that prepares machine learning indices for an upgrade. When upgrading your cluster, in some circumstances you must restart your nodes and reindex your machine learning indices. In those circumstances, there must be no machine learning jobs running. You can close the machine learning jobs, do the upgrade, then open all the jobs again. Alternatively, you can use this API to temporarily halt tasks associated with the jobs and datafeeds and prevent new jobs from opening. You can also use this API during upgrades that do not require you to reindex your machine learning indices, though stopping jobs is not a requirement in that case. You can see the current value for the upgrade_mode setting by using the get machine learning info API. || `setUpgradeMode` | `setUpgradeMode(this: [That](./That.md), params?: [MlSetUpgradeModeRequest](./MlSetUpgradeModeRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlSetUpgradeModeResponse](./MlSetUpgradeModeResponse.md), unknown>>;` |   || `setUpgradeMode` | `setUpgradeMode(this: [That](./That.md), params?: [MlSetUpgradeModeRequest](./MlSetUpgradeModeRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlSetUpgradeModeResponse](./MlSetUpgradeModeResponse.md)>;` |   || `startDatafeed` | `startDatafeed(this: [That](./That.md), params: [MlStartDatafeedRequest](./MlStartDatafeedRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlStartDatafeedResponse](./MlStartDatafeedResponse.md)>;` | Start datafeeds. A datafeed must be started in order to retrieve data from Elasticsearch. A datafeed can be started and stopped multiple times throughout its lifecycle. Before you can start a datafeed, the anomaly detection job must be open. Otherwise, an error occurs. If you restart a stopped datafeed, it continues processing input data from the next millisecond after it was stopped. If new data was indexed for that exact millisecond between stopping and starting, it will be ignored. When Elasticsearch security features are enabled, your datafeed remembers which roles the last user to create or update it had at the time of creation or update and runs the query using those same roles. If you provided secondary authorization headers when you created or updated the datafeed, those credentials are used instead. || `startDatafeed` | `startDatafeed(this: [That](./That.md), params: [MlStartDatafeedRequest](./MlStartDatafeedRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlStartDatafeedResponse](./MlStartDatafeedResponse.md), unknown>>;` |   || `startDatafeed` | `startDatafeed(this: [That](./That.md), params: [MlStartDatafeedRequest](./MlStartDatafeedRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlStartDatafeedResponse](./MlStartDatafeedResponse.md)>;` |   || `startDataFrameAnalytics` | `startDataFrameAnalytics(this: [That](./That.md), params: [MlStartDataFrameAnalyticsRequest](./MlStartDataFrameAnalyticsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlStartDataFrameAnalyticsResponse](./MlStartDataFrameAnalyticsResponse.md)>;` | Start a data frame analytics job. A data frame analytics job can be started and stopped multiple times throughout its lifecycle. If the destination index does not exist, it is created automatically the first time you start the data frame analytics job. The `index.number_of_shards` and `index.number_of_replicas` settings for the destination index are copied from the source index. If there are multiple source indices, the destination index copies the highest setting values. The mappings for the destination index are also copied from the source indices. If there are any mapping conflicts, the job fails to start. If the destination index exists, it is used as is. You can therefore set up the destination index in advance with custom settings and mappings. || `startDataFrameAnalytics` | `startDataFrameAnalytics(this: [That](./That.md), params: [MlStartDataFrameAnalyticsRequest](./MlStartDataFrameAnalyticsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlStartDataFrameAnalyticsResponse](./MlStartDataFrameAnalyticsResponse.md), unknown>>;` |   || `startDataFrameAnalytics` | `startDataFrameAnalytics(this: [That](./That.md), params: [MlStartDataFrameAnalyticsRequest](./MlStartDataFrameAnalyticsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlStartDataFrameAnalyticsResponse](./MlStartDataFrameAnalyticsResponse.md)>;` |   || `startTrainedModelDeployment` | `startTrainedModelDeployment(this: [That](./That.md), params: [MlStartTrainedModelDeploymentRequest](./MlStartTrainedModelDeploymentRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlStartTrainedModelDeploymentResponse](./MlStartTrainedModelDeploymentResponse.md)>;` | Start a trained model deployment. It allocates the model to every machine learning node. || `startTrainedModelDeployment` | `startTrainedModelDeployment(this: [That](./That.md), params: [MlStartTrainedModelDeploymentRequest](./MlStartTrainedModelDeploymentRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlStartTrainedModelDeploymentResponse](./MlStartTrainedModelDeploymentResponse.md), unknown>>;` |   || `startTrainedModelDeployment` | `startTrainedModelDeployment(this: [That](./That.md), params: [MlStartTrainedModelDeploymentRequest](./MlStartTrainedModelDeploymentRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlStartTrainedModelDeploymentResponse](./MlStartTrainedModelDeploymentResponse.md)>;` |   || `stopDatafeed` | `stopDatafeed(this: [That](./That.md), params: [MlStopDatafeedRequest](./MlStopDatafeedRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlStopDatafeedResponse](./MlStopDatafeedResponse.md)>;` | Stop datafeeds. A datafeed that is stopped ceases to retrieve data from Elasticsearch. A datafeed can be started and stopped multiple times throughout its lifecycle. || `stopDatafeed` | `stopDatafeed(this: [That](./That.md), params: [MlStopDatafeedRequest](./MlStopDatafeedRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlStopDatafeedResponse](./MlStopDatafeedResponse.md), unknown>>;` |   || `stopDatafeed` | `stopDatafeed(this: [That](./That.md), params: [MlStopDatafeedRequest](./MlStopDatafeedRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlStopDatafeedResponse](./MlStopDatafeedResponse.md)>;` |   || `stopDataFrameAnalytics` | `stopDataFrameAnalytics(this: [That](./That.md), params: [MlStopDataFrameAnalyticsRequest](./MlStopDataFrameAnalyticsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlStopDataFrameAnalyticsResponse](./MlStopDataFrameAnalyticsResponse.md)>;` | Stop data frame analytics jobs. A data frame analytics job can be started and stopped multiple times throughout its lifecycle. || `stopDataFrameAnalytics` | `stopDataFrameAnalytics(this: [That](./That.md), params: [MlStopDataFrameAnalyticsRequest](./MlStopDataFrameAnalyticsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlStopDataFrameAnalyticsResponse](./MlStopDataFrameAnalyticsResponse.md), unknown>>;` |   || `stopDataFrameAnalytics` | `stopDataFrameAnalytics(this: [That](./That.md), params: [MlStopDataFrameAnalyticsRequest](./MlStopDataFrameAnalyticsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlStopDataFrameAnalyticsResponse](./MlStopDataFrameAnalyticsResponse.md)>;` |   || `stopTrainedModelDeployment` | `stopTrainedModelDeployment(this: [That](./That.md), params: [MlStopTrainedModelDeploymentRequest](./MlStopTrainedModelDeploymentRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlStopTrainedModelDeploymentResponse](./MlStopTrainedModelDeploymentResponse.md)>;` | Stop a trained model deployment. || `stopTrainedModelDeployment` | `stopTrainedModelDeployment(this: [That](./That.md), params: [MlStopTrainedModelDeploymentRequest](./MlStopTrainedModelDeploymentRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlStopTrainedModelDeploymentResponse](./MlStopTrainedModelDeploymentResponse.md), unknown>>;` |   || `stopTrainedModelDeployment` | `stopTrainedModelDeployment(this: [That](./That.md), params: [MlStopTrainedModelDeploymentRequest](./MlStopTrainedModelDeploymentRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlStopTrainedModelDeploymentResponse](./MlStopTrainedModelDeploymentResponse.md)>;` |   || `updateDatafeed` | `updateDatafeed(this: [That](./That.md), params: [MlUpdateDatafeedRequest](./MlUpdateDatafeedRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlUpdateDatafeedResponse](./MlUpdateDatafeedResponse.md)>;` | Update a datafeed. You must stop and start the datafeed for the changes to be applied. When Elasticsearch security features are enabled, your datafeed remembers which roles the user who updated it had at the time of the update and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead. || `updateDatafeed` | `updateDatafeed(this: [That](./That.md), params: [MlUpdateDatafeedRequest](./MlUpdateDatafeedRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlUpdateDatafeedResponse](./MlUpdateDatafeedResponse.md), unknown>>;` |   || `updateDatafeed` | `updateDatafeed(this: [That](./That.md), params: [MlUpdateDatafeedRequest](./MlUpdateDatafeedRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlUpdateDatafeedResponse](./MlUpdateDatafeedResponse.md)>;` |   || `updateDataFrameAnalytics` | `updateDataFrameAnalytics(this: [That](./That.md), params: [MlUpdateDataFrameAnalyticsRequest](./MlUpdateDataFrameAnalyticsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlUpdateDataFrameAnalyticsResponse](./MlUpdateDataFrameAnalyticsResponse.md)>;` | Update a data frame analytics job. || `updateDataFrameAnalytics` | `updateDataFrameAnalytics(this: [That](./That.md), params: [MlUpdateDataFrameAnalyticsRequest](./MlUpdateDataFrameAnalyticsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlUpdateDataFrameAnalyticsResponse](./MlUpdateDataFrameAnalyticsResponse.md), unknown>>;` |   || `updateDataFrameAnalytics` | `updateDataFrameAnalytics(this: [That](./That.md), params: [MlUpdateDataFrameAnalyticsRequest](./MlUpdateDataFrameAnalyticsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlUpdateDataFrameAnalyticsResponse](./MlUpdateDataFrameAnalyticsResponse.md)>;` |   || `updateFilter` | `updateFilter(this: [That](./That.md), params: [MlUpdateFilterRequest](./MlUpdateFilterRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlUpdateFilterResponse](./MlUpdateFilterResponse.md)>;` | Update a filter. Updates the description of a filter, adds items, or removes items from the list. || `updateFilter` | `updateFilter(this: [That](./That.md), params: [MlUpdateFilterRequest](./MlUpdateFilterRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlUpdateFilterResponse](./MlUpdateFilterResponse.md), unknown>>;` |   || `updateFilter` | `updateFilter(this: [That](./That.md), params: [MlUpdateFilterRequest](./MlUpdateFilterRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlUpdateFilterResponse](./MlUpdateFilterResponse.md)>;` |   || `updateJob` | `updateJob(this: [That](./That.md), params: [MlUpdateJobRequest](./MlUpdateJobRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlUpdateJobResponse](./MlUpdateJobResponse.md)>;` | Update an anomaly detection job. Updates certain properties of an anomaly detection job. || `updateJob` | `updateJob(this: [That](./That.md), params: [MlUpdateJobRequest](./MlUpdateJobRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlUpdateJobResponse](./MlUpdateJobResponse.md), unknown>>;` |   || `updateJob` | `updateJob(this: [That](./That.md), params: [MlUpdateJobRequest](./MlUpdateJobRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlUpdateJobResponse](./MlUpdateJobResponse.md)>;` |   || `updateModelSnapshot` | `updateModelSnapshot(this: [That](./That.md), params: [MlUpdateModelSnapshotRequest](./MlUpdateModelSnapshotRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlUpdateModelSnapshotResponse](./MlUpdateModelSnapshotResponse.md)>;` | Update a snapshot. Updates certain properties of a snapshot. || `updateModelSnapshot` | `updateModelSnapshot(this: [That](./That.md), params: [MlUpdateModelSnapshotRequest](./MlUpdateModelSnapshotRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlUpdateModelSnapshotResponse](./MlUpdateModelSnapshotResponse.md), unknown>>;` |   || `updateModelSnapshot` | `updateModelSnapshot(this: [That](./That.md), params: [MlUpdateModelSnapshotRequest](./MlUpdateModelSnapshotRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlUpdateModelSnapshotResponse](./MlUpdateModelSnapshotResponse.md)>;` |   || `updateTrainedModelDeployment` | `updateTrainedModelDeployment(this: [That](./That.md), params: [MlUpdateTrainedModelDeploymentRequest](./MlUpdateTrainedModelDeploymentRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlUpdateTrainedModelDeploymentResponse](./MlUpdateTrainedModelDeploymentResponse.md)>;` | Update a trained model deployment. || `updateTrainedModelDeployment` | `updateTrainedModelDeployment(this: [That](./That.md), params: [MlUpdateTrainedModelDeploymentRequest](./MlUpdateTrainedModelDeploymentRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlUpdateTrainedModelDeploymentResponse](./MlUpdateTrainedModelDeploymentResponse.md), unknown>>;` |   || `updateTrainedModelDeployment` | `updateTrainedModelDeployment(this: [That](./That.md), params: [MlUpdateTrainedModelDeploymentRequest](./MlUpdateTrainedModelDeploymentRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlUpdateTrainedModelDeploymentResponse](./MlUpdateTrainedModelDeploymentResponse.md)>;` |   || `upgradeJobSnapshot` | `upgradeJobSnapshot(this: [That](./That.md), params: [MlUpgradeJobSnapshotRequest](./MlUpgradeJobSnapshotRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlUpgradeJobSnapshotResponse](./MlUpgradeJobSnapshotResponse.md)>;` | Upgrade a snapshot. Upgrade an anomaly detection model snapshot to the latest major version. Over time, older snapshot formats are deprecated and removed. Anomaly detection jobs support only snapshots that are from the current or previous major version. This API provides a means to upgrade a snapshot to the current major version. This aids in preparing the cluster for an upgrade to the next major version. Only one snapshot per anomaly detection job can be upgraded at a time and the upgraded snapshot cannot be the current snapshot of the anomaly detection job. || `upgradeJobSnapshot` | `upgradeJobSnapshot(this: [That](./That.md), params: [MlUpgradeJobSnapshotRequest](./MlUpgradeJobSnapshotRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlUpgradeJobSnapshotResponse](./MlUpgradeJobSnapshotResponse.md), unknown>>;` |   || `upgradeJobSnapshot` | `upgradeJobSnapshot(this: [That](./That.md), params: [MlUpgradeJobSnapshotRequest](./MlUpgradeJobSnapshotRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlUpgradeJobSnapshotResponse](./MlUpgradeJobSnapshotResponse.md)>;` |   || `validate` | `validate(this: [That](./That.md), params?: [MlValidateRequest](./MlValidateRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlValidateResponse](./MlValidateResponse.md)>;` | Validate an anomaly detection job. || `validate` | `validate(this: [That](./That.md), params?: [MlValidateRequest](./MlValidateRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlValidateResponse](./MlValidateResponse.md), unknown>>;` |   || `validate` | `validate(this: [That](./That.md), params?: [MlValidateRequest](./MlValidateRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlValidateResponse](./MlValidateResponse.md)>;` |   || `validateDetector` | `validateDetector(this: [That](./That.md), params: [MlValidateDetectorRequest](./MlValidateDetectorRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlValidateDetectorResponse](./MlValidateDetectorResponse.md)>;` | Validate an anomaly detection job. || `validateDetector` | `validateDetector(this: [That](./That.md), params: [MlValidateDetectorRequest](./MlValidateDetectorRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlValidateDetectorResponse](./MlValidateDetectorResponse.md), unknown>>;` |   || `validateDetector` | `validateDetector(this: [That](./That.md), params: [MlValidateDetectorRequest](./MlValidateDetectorRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlValidateDetectorResponse](./MlValidateDetectorResponse.md)>;` |   | \ No newline at end of file +| `clearTrainedModelDeploymentCache` | `clearTrainedModelDeploymentCache(this: [That](./That.md), params: [MlClearTrainedModelDeploymentCacheRequest](./MlClearTrainedModelDeploymentCacheRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlClearTrainedModelDeploymentCacheResponse](./MlClearTrainedModelDeploymentCacheResponse.md)>;` | Clear trained model deployment cache. Cache will be cleared on all nodes where the trained model is assigned. A trained model deployment may have an inference cache enabled. As requests are handled by each allocated node, their responses may be cached on that individual node. Calling this API clears the caches without restarting the deployment. | +| `clearTrainedModelDeploymentCache` | `clearTrainedModelDeploymentCache(this: [That](./That.md), params: [MlClearTrainedModelDeploymentCacheRequest](./MlClearTrainedModelDeploymentCacheRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlClearTrainedModelDeploymentCacheResponse](./MlClearTrainedModelDeploymentCacheResponse.md), unknown>>;` |   | +| `clearTrainedModelDeploymentCache` | `clearTrainedModelDeploymentCache(this: [That](./That.md), params: [MlClearTrainedModelDeploymentCacheRequest](./MlClearTrainedModelDeploymentCacheRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlClearTrainedModelDeploymentCacheResponse](./MlClearTrainedModelDeploymentCacheResponse.md)>;` |   | +| `closeJob` | `closeJob(this: [That](./That.md), params: [MlCloseJobRequest](./MlCloseJobRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlCloseJobResponse](./MlCloseJobResponse.md)>;` | Close anomaly detection jobs. A job can be opened and closed multiple times throughout its lifecycle. A closed job cannot receive data or perform analysis operations, but you can still explore and navigate results. When you close a job, it runs housekeeping tasks such as pruning the model history, flushing buffers, calculating final results and persisting the model snapshots. Depending upon the size of the job, it could take several minutes to close and the equivalent time to re-open. After it is closed, the job has a minimal overhead on the cluster except for maintaining its meta data. Therefore it is a best practice to close jobs that are no longer required to process data. If you close an anomaly detection job whose datafeed is running, the request first tries to stop the datafeed. This behavior is equivalent to calling stop datafeed API with the same timeout and force parameters as the close job request. When a datafeed that has a specified end date stops, it automatically closes its associated job. | +| `closeJob` | `closeJob(this: [That](./That.md), params: [MlCloseJobRequest](./MlCloseJobRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlCloseJobResponse](./MlCloseJobResponse.md), unknown>>;` |   | +| `closeJob` | `closeJob(this: [That](./That.md), params: [MlCloseJobRequest](./MlCloseJobRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlCloseJobResponse](./MlCloseJobResponse.md)>;` |   | +| `deleteCalendar` | `deleteCalendar(this: [That](./That.md), params: [MlDeleteCalendarRequest](./MlDeleteCalendarRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlDeleteCalendarResponse](./MlDeleteCalendarResponse.md)>;` | Delete a calendar. Remove all scheduled events from a calendar, then delete it. | +| `deleteCalendar` | `deleteCalendar(this: [That](./That.md), params: [MlDeleteCalendarRequest](./MlDeleteCalendarRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlDeleteCalendarResponse](./MlDeleteCalendarResponse.md), unknown>>;` |   | +| `deleteCalendar` | `deleteCalendar(this: [That](./That.md), params: [MlDeleteCalendarRequest](./MlDeleteCalendarRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlDeleteCalendarResponse](./MlDeleteCalendarResponse.md)>;` |   | +| `deleteCalendarEvent` | `deleteCalendarEvent(this: [That](./That.md), params: [MlDeleteCalendarEventRequest](./MlDeleteCalendarEventRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlDeleteCalendarEventResponse](./MlDeleteCalendarEventResponse.md)>;` | Delete events from a calendar. | +| `deleteCalendarEvent` | `deleteCalendarEvent(this: [That](./That.md), params: [MlDeleteCalendarEventRequest](./MlDeleteCalendarEventRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlDeleteCalendarEventResponse](./MlDeleteCalendarEventResponse.md), unknown>>;` |   | +| `deleteCalendarEvent` | `deleteCalendarEvent(this: [That](./That.md), params: [MlDeleteCalendarEventRequest](./MlDeleteCalendarEventRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlDeleteCalendarEventResponse](./MlDeleteCalendarEventResponse.md)>;` |   | +| `deleteCalendarJob` | `deleteCalendarJob(this: [That](./That.md), params: [MlDeleteCalendarJobRequest](./MlDeleteCalendarJobRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlDeleteCalendarJobResponse](./MlDeleteCalendarJobResponse.md)>;` | Delete anomaly jobs from a calendar. | +| `deleteCalendarJob` | `deleteCalendarJob(this: [That](./That.md), params: [MlDeleteCalendarJobRequest](./MlDeleteCalendarJobRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlDeleteCalendarJobResponse](./MlDeleteCalendarJobResponse.md), unknown>>;` |   | +| `deleteCalendarJob` | `deleteCalendarJob(this: [That](./That.md), params: [MlDeleteCalendarJobRequest](./MlDeleteCalendarJobRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlDeleteCalendarJobResponse](./MlDeleteCalendarJobResponse.md)>;` |   | +| `deleteDatafeed` | `deleteDatafeed(this: [That](./That.md), params: [MlDeleteDatafeedRequest](./MlDeleteDatafeedRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlDeleteDatafeedResponse](./MlDeleteDatafeedResponse.md)>;` | Delete a datafeed. | +| `deleteDatafeed` | `deleteDatafeed(this: [That](./That.md), params: [MlDeleteDatafeedRequest](./MlDeleteDatafeedRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlDeleteDatafeedResponse](./MlDeleteDatafeedResponse.md), unknown>>;` |   | +| `deleteDatafeed` | `deleteDatafeed(this: [That](./That.md), params: [MlDeleteDatafeedRequest](./MlDeleteDatafeedRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlDeleteDatafeedResponse](./MlDeleteDatafeedResponse.md)>;` |   | +| `deleteDataFrameAnalytics` | `deleteDataFrameAnalytics(this: [That](./That.md), params: [MlDeleteDataFrameAnalyticsRequest](./MlDeleteDataFrameAnalyticsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlDeleteDataFrameAnalyticsResponse](./MlDeleteDataFrameAnalyticsResponse.md)>;` | Delete a data frame analytics job. | +| `deleteDataFrameAnalytics` | `deleteDataFrameAnalytics(this: [That](./That.md), params: [MlDeleteDataFrameAnalyticsRequest](./MlDeleteDataFrameAnalyticsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlDeleteDataFrameAnalyticsResponse](./MlDeleteDataFrameAnalyticsResponse.md), unknown>>;` |   | +| `deleteDataFrameAnalytics` | `deleteDataFrameAnalytics(this: [That](./That.md), params: [MlDeleteDataFrameAnalyticsRequest](./MlDeleteDataFrameAnalyticsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlDeleteDataFrameAnalyticsResponse](./MlDeleteDataFrameAnalyticsResponse.md)>;` |   | +| `deleteExpiredData` | `deleteExpiredData(this: [That](./That.md), params?: [MlDeleteExpiredDataRequest](./MlDeleteExpiredDataRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlDeleteExpiredDataResponse](./MlDeleteExpiredDataResponse.md)>;` | Delete expired ML data. Delete all job results, model snapshots and forecast data that have exceeded their retention days period. Machine learning state documents that are not associated with any job are also deleted. You can limit the request to a single or set of anomaly detection jobs by using a job identifier, a group name, a comma-separated list of jobs, or a wildcard expression. You can delete expired data for all anomaly detection jobs by using `_all`, by specifying `*` as the ``, or by omitting the ``. | +| `deleteExpiredData` | `deleteExpiredData(this: [That](./That.md), params?: [MlDeleteExpiredDataRequest](./MlDeleteExpiredDataRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlDeleteExpiredDataResponse](./MlDeleteExpiredDataResponse.md), unknown>>;` |   | +| `deleteExpiredData` | `deleteExpiredData(this: [That](./That.md), params?: [MlDeleteExpiredDataRequest](./MlDeleteExpiredDataRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlDeleteExpiredDataResponse](./MlDeleteExpiredDataResponse.md)>;` |   | +| `deleteFilter` | `deleteFilter(this: [That](./That.md), params: [MlDeleteFilterRequest](./MlDeleteFilterRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlDeleteFilterResponse](./MlDeleteFilterResponse.md)>;` | Delete a filter. If an anomaly detection job references the filter, you cannot delete the filter. You must update or delete the job before you can delete the filter. | +| `deleteFilter` | `deleteFilter(this: [That](./That.md), params: [MlDeleteFilterRequest](./MlDeleteFilterRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlDeleteFilterResponse](./MlDeleteFilterResponse.md), unknown>>;` |   | +| `deleteFilter` | `deleteFilter(this: [That](./That.md), params: [MlDeleteFilterRequest](./MlDeleteFilterRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlDeleteFilterResponse](./MlDeleteFilterResponse.md)>;` |   | +| `deleteForecast` | `deleteForecast(this: [That](./That.md), params: [MlDeleteForecastRequest](./MlDeleteForecastRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlDeleteForecastResponse](./MlDeleteForecastResponse.md)>;` | Delete forecasts from a job. By default, forecasts are retained for 14 days. You can specify a different retention period with the `expires_in` parameter in the forecast jobs API. The delete forecast API enables you to delete one or more forecasts before they expire. | +| `deleteForecast` | `deleteForecast(this: [That](./That.md), params: [MlDeleteForecastRequest](./MlDeleteForecastRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlDeleteForecastResponse](./MlDeleteForecastResponse.md), unknown>>;` |   | +| `deleteForecast` | `deleteForecast(this: [That](./That.md), params: [MlDeleteForecastRequest](./MlDeleteForecastRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlDeleteForecastResponse](./MlDeleteForecastResponse.md)>;` |   | +| `deleteJob` | `deleteJob(this: [That](./That.md), params: [MlDeleteJobRequest](./MlDeleteJobRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlDeleteJobResponse](./MlDeleteJobResponse.md)>;` | Delete an anomaly detection job. All job configuration, model state and results are deleted. It is not currently possible to delete multiple jobs using wildcards or a comma separated list. If you delete a job that has a datafeed, the request first tries to delete the datafeed. This behavior is equivalent to calling the delete datafeed API with the same timeout and force parameters as the delete job request. | +| `deleteJob` | `deleteJob(this: [That](./That.md), params: [MlDeleteJobRequest](./MlDeleteJobRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlDeleteJobResponse](./MlDeleteJobResponse.md), unknown>>;` |   | +| `deleteJob` | `deleteJob(this: [That](./That.md), params: [MlDeleteJobRequest](./MlDeleteJobRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlDeleteJobResponse](./MlDeleteJobResponse.md)>;` |   | +| `deleteModelSnapshot` | `deleteModelSnapshot(this: [That](./That.md), params: [MlDeleteModelSnapshotRequest](./MlDeleteModelSnapshotRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlDeleteModelSnapshotResponse](./MlDeleteModelSnapshotResponse.md)>;` | Delete a model snapshot. You cannot delete the active model snapshot. To delete that snapshot, first revert to a different one. To identify the active model snapshot, refer to the `model_snapshot_id` in the results from the get jobs API. | +| `deleteModelSnapshot` | `deleteModelSnapshot(this: [That](./That.md), params: [MlDeleteModelSnapshotRequest](./MlDeleteModelSnapshotRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlDeleteModelSnapshotResponse](./MlDeleteModelSnapshotResponse.md), unknown>>;` |   | +| `deleteModelSnapshot` | `deleteModelSnapshot(this: [That](./That.md), params: [MlDeleteModelSnapshotRequest](./MlDeleteModelSnapshotRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlDeleteModelSnapshotResponse](./MlDeleteModelSnapshotResponse.md)>;` |   | +| `deleteTrainedModel` | `deleteTrainedModel(this: [That](./That.md), params: [MlDeleteTrainedModelRequest](./MlDeleteTrainedModelRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlDeleteTrainedModelResponse](./MlDeleteTrainedModelResponse.md)>;` | Delete an unreferenced trained model. The request deletes a trained inference model that is not referenced by an ingest pipeline. | +| `deleteTrainedModel` | `deleteTrainedModel(this: [That](./That.md), params: [MlDeleteTrainedModelRequest](./MlDeleteTrainedModelRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlDeleteTrainedModelResponse](./MlDeleteTrainedModelResponse.md), unknown>>;` |   | +| `deleteTrainedModel` | `deleteTrainedModel(this: [That](./That.md), params: [MlDeleteTrainedModelRequest](./MlDeleteTrainedModelRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlDeleteTrainedModelResponse](./MlDeleteTrainedModelResponse.md)>;` |   | +| `deleteTrainedModelAlias` | `deleteTrainedModelAlias(this: [That](./That.md), params: [MlDeleteTrainedModelAliasRequest](./MlDeleteTrainedModelAliasRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlDeleteTrainedModelAliasResponse](./MlDeleteTrainedModelAliasResponse.md)>;` | Delete a trained model alias. This API deletes an existing model alias that refers to a trained model. If the model alias is missing or refers to a model other than the one identified by the `model_id`, this API returns an error. | +| `deleteTrainedModelAlias` | `deleteTrainedModelAlias(this: [That](./That.md), params: [MlDeleteTrainedModelAliasRequest](./MlDeleteTrainedModelAliasRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlDeleteTrainedModelAliasResponse](./MlDeleteTrainedModelAliasResponse.md), unknown>>;` |   | +| `deleteTrainedModelAlias` | `deleteTrainedModelAlias(this: [That](./That.md), params: [MlDeleteTrainedModelAliasRequest](./MlDeleteTrainedModelAliasRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlDeleteTrainedModelAliasResponse](./MlDeleteTrainedModelAliasResponse.md)>;` |   | +| `estimateModelMemory` | `estimateModelMemory(this: [That](./That.md), params?: [MlEstimateModelMemoryRequest](./MlEstimateModelMemoryRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlEstimateModelMemoryResponse](./MlEstimateModelMemoryResponse.md)>;` | Estimate job model memory usage. Make an estimation of the memory usage for an anomaly detection job model. The estimate is based on analysis configuration details for the job and cardinality estimates for the fields it references. | +| `estimateModelMemory` | `estimateModelMemory(this: [That](./That.md), params?: [MlEstimateModelMemoryRequest](./MlEstimateModelMemoryRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlEstimateModelMemoryResponse](./MlEstimateModelMemoryResponse.md), unknown>>;` |   | +| `estimateModelMemory` | `estimateModelMemory(this: [That](./That.md), params?: [MlEstimateModelMemoryRequest](./MlEstimateModelMemoryRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlEstimateModelMemoryResponse](./MlEstimateModelMemoryResponse.md)>;` |   | +| `evaluateDataFrame` | `evaluateDataFrame(this: [That](./That.md), params: [MlEvaluateDataFrameRequest](./MlEvaluateDataFrameRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlEvaluateDataFrameResponse](./MlEvaluateDataFrameResponse.md)>;` | Evaluate data frame analytics. The API packages together commonly used evaluation metrics for various types of machine learning features. This has been designed for use on indexes created by data frame analytics. Evaluation requires both a ground truth field and an analytics result field to be present. | +| `evaluateDataFrame` | `evaluateDataFrame(this: [That](./That.md), params: [MlEvaluateDataFrameRequest](./MlEvaluateDataFrameRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlEvaluateDataFrameResponse](./MlEvaluateDataFrameResponse.md), unknown>>;` |   | +| `evaluateDataFrame` | `evaluateDataFrame(this: [That](./That.md), params: [MlEvaluateDataFrameRequest](./MlEvaluateDataFrameRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlEvaluateDataFrameResponse](./MlEvaluateDataFrameResponse.md)>;` |   | +| `explainDataFrameAnalytics` | `explainDataFrameAnalytics(this: [That](./That.md), params?: [MlExplainDataFrameAnalyticsRequest](./MlExplainDataFrameAnalyticsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlExplainDataFrameAnalyticsResponse](./MlExplainDataFrameAnalyticsResponse.md)>;` | Explain data frame analytics config. This API provides explanations for a data frame analytics config that either exists already or one that has not been created yet. The following explanations are provided: * which fields are included or not in the analysis and why, * how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on. If you have object fields or fields that are excluded via source filtering, they are not included in the explanation. | +| `explainDataFrameAnalytics` | `explainDataFrameAnalytics(this: [That](./That.md), params?: [MlExplainDataFrameAnalyticsRequest](./MlExplainDataFrameAnalyticsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlExplainDataFrameAnalyticsResponse](./MlExplainDataFrameAnalyticsResponse.md), unknown>>;` |   | +| `explainDataFrameAnalytics` | `explainDataFrameAnalytics(this: [That](./That.md), params?: [MlExplainDataFrameAnalyticsRequest](./MlExplainDataFrameAnalyticsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlExplainDataFrameAnalyticsResponse](./MlExplainDataFrameAnalyticsResponse.md)>;` |   | +| `flushJob` | `flushJob(this: [That](./That.md), params: [MlFlushJobRequest](./MlFlushJobRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlFlushJobResponse](./MlFlushJobResponse.md)>;` | Force buffered data to be processed. The flush jobs API is only applicable when sending data for analysis using the post data API. Depending on the content of the buffer, then it might additionally calculate new results. Both flush and close operations are similar, however the flush is more efficient if you are expecting to send more data for analysis. When flushing, the job remains open and is available to continue analyzing data. A close operation additionally prunes and persists the model state to disk and the job must be opened again before analyzing further data. | +| `flushJob` | `flushJob(this: [That](./That.md), params: [MlFlushJobRequest](./MlFlushJobRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlFlushJobResponse](./MlFlushJobResponse.md), unknown>>;` |   | +| `flushJob` | `flushJob(this: [That](./That.md), params: [MlFlushJobRequest](./MlFlushJobRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlFlushJobResponse](./MlFlushJobResponse.md)>;` |   | +| `forecast` | `forecast(this: [That](./That.md), params: [MlForecastRequest](./MlForecastRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlForecastResponse](./MlForecastResponse.md)>;` | Predict future behavior of a time series. Forecasts are not supported for jobs that perform population analysis; an error occurs if you try to create a forecast for a job that has an `over_field_name` in its configuration. Forcasts predict future behavior based on historical data. | +| `forecast` | `forecast(this: [That](./That.md), params: [MlForecastRequest](./MlForecastRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlForecastResponse](./MlForecastResponse.md), unknown>>;` |   | +| `forecast` | `forecast(this: [That](./That.md), params: [MlForecastRequest](./MlForecastRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlForecastResponse](./MlForecastResponse.md)>;` |   | +| `getBuckets` | `getBuckets(this: [That](./That.md), params: [MlGetBucketsRequest](./MlGetBucketsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlGetBucketsResponse](./MlGetBucketsResponse.md)>;` | Get anomaly detection job results for buckets. The API presents a chronological view of the records, grouped by bucket. | +| `getBuckets` | `getBuckets(this: [That](./That.md), params: [MlGetBucketsRequest](./MlGetBucketsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlGetBucketsResponse](./MlGetBucketsResponse.md), unknown>>;` |   | +| `getBuckets` | `getBuckets(this: [That](./That.md), params: [MlGetBucketsRequest](./MlGetBucketsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlGetBucketsResponse](./MlGetBucketsResponse.md)>;` |   | +| `getCalendarEvents` | `getCalendarEvents(this: [That](./That.md), params: [MlGetCalendarEventsRequest](./MlGetCalendarEventsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlGetCalendarEventsResponse](./MlGetCalendarEventsResponse.md)>;` | Get info about events in calendars. | +| `getCalendarEvents` | `getCalendarEvents(this: [That](./That.md), params: [MlGetCalendarEventsRequest](./MlGetCalendarEventsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlGetCalendarEventsResponse](./MlGetCalendarEventsResponse.md), unknown>>;` |   | +| `getCalendarEvents` | `getCalendarEvents(this: [That](./That.md), params: [MlGetCalendarEventsRequest](./MlGetCalendarEventsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlGetCalendarEventsResponse](./MlGetCalendarEventsResponse.md)>;` |   | +| `getCalendars` | `getCalendars(this: [That](./That.md), params?: [MlGetCalendarsRequest](./MlGetCalendarsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlGetCalendarsResponse](./MlGetCalendarsResponse.md)>;` | Get calendar configuration info. | +| `getCalendars` | `getCalendars(this: [That](./That.md), params?: [MlGetCalendarsRequest](./MlGetCalendarsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlGetCalendarsResponse](./MlGetCalendarsResponse.md), unknown>>;` |   | +| `getCalendars` | `getCalendars(this: [That](./That.md), params?: [MlGetCalendarsRequest](./MlGetCalendarsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlGetCalendarsResponse](./MlGetCalendarsResponse.md)>;` |   | +| `getCategories` | `getCategories(this: [That](./That.md), params: [MlGetCategoriesRequest](./MlGetCategoriesRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlGetCategoriesResponse](./MlGetCategoriesResponse.md)>;` | Get anomaly detection job results for categories. | +| `getCategories` | `getCategories(this: [That](./That.md), params: [MlGetCategoriesRequest](./MlGetCategoriesRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlGetCategoriesResponse](./MlGetCategoriesResponse.md), unknown>>;` |   | +| `getCategories` | `getCategories(this: [That](./That.md), params: [MlGetCategoriesRequest](./MlGetCategoriesRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlGetCategoriesResponse](./MlGetCategoriesResponse.md)>;` |   | +| `getDatafeeds` | `getDatafeeds(this: [That](./That.md), params?: [MlGetDatafeedsRequest](./MlGetDatafeedsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlGetDatafeedsResponse](./MlGetDatafeedsResponse.md)>;` | Get datafeeds configuration info. You can get information for multiple datafeeds in a single API request by using a comma-separated list of datafeeds or a wildcard expression. You can get information for all datafeeds by using `_all`, by specifying `*` as the ``, or by omitting the ``. This API returns a maximum of 10,000 datafeeds. | +| `getDatafeeds` | `getDatafeeds(this: [That](./That.md), params?: [MlGetDatafeedsRequest](./MlGetDatafeedsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlGetDatafeedsResponse](./MlGetDatafeedsResponse.md), unknown>>;` |   | +| `getDatafeeds` | `getDatafeeds(this: [That](./That.md), params?: [MlGetDatafeedsRequest](./MlGetDatafeedsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlGetDatafeedsResponse](./MlGetDatafeedsResponse.md)>;` |   | +| `getDatafeedStats` | `getDatafeedStats(this: [That](./That.md), params?: [MlGetDatafeedStatsRequest](./MlGetDatafeedStatsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlGetDatafeedStatsResponse](./MlGetDatafeedStatsResponse.md)>;` | Get datafeed stats. You can get statistics for multiple datafeeds in a single API request by using a comma-separated list of datafeeds or a wildcard expression. You can get statistics for all datafeeds by using `_all`, by specifying `*` as the ``, or by omitting the ``. If the datafeed is stopped, the only information you receive is the `datafeed_id` and the `state`. This API returns a maximum of 10,000 datafeeds. | +| `getDatafeedStats` | `getDatafeedStats(this: [That](./That.md), params?: [MlGetDatafeedStatsRequest](./MlGetDatafeedStatsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlGetDatafeedStatsResponse](./MlGetDatafeedStatsResponse.md), unknown>>;` |   | +| `getDatafeedStats` | `getDatafeedStats(this: [That](./That.md), params?: [MlGetDatafeedStatsRequest](./MlGetDatafeedStatsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlGetDatafeedStatsResponse](./MlGetDatafeedStatsResponse.md)>;` |   | +| `getDataFrameAnalytics` | `getDataFrameAnalytics(this: [That](./That.md), params?: [MlGetDataFrameAnalyticsRequest](./MlGetDataFrameAnalyticsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlGetDataFrameAnalyticsResponse](./MlGetDataFrameAnalyticsResponse.md)>;` | Get data frame analytics job configuration info. You can get information for multiple data frame analytics jobs in a single API request by using a comma-separated list of data frame analytics jobs or a wildcard expression. | +| `getDataFrameAnalytics` | `getDataFrameAnalytics(this: [That](./That.md), params?: [MlGetDataFrameAnalyticsRequest](./MlGetDataFrameAnalyticsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlGetDataFrameAnalyticsResponse](./MlGetDataFrameAnalyticsResponse.md), unknown>>;` |   | +| `getDataFrameAnalytics` | `getDataFrameAnalytics(this: [That](./That.md), params?: [MlGetDataFrameAnalyticsRequest](./MlGetDataFrameAnalyticsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlGetDataFrameAnalyticsResponse](./MlGetDataFrameAnalyticsResponse.md)>;` |   | +| `getDataFrameAnalyticsStats` | `getDataFrameAnalyticsStats(this: [That](./That.md), params?: [MlGetDataFrameAnalyticsStatsRequest](./MlGetDataFrameAnalyticsStatsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlGetDataFrameAnalyticsStatsResponse](./MlGetDataFrameAnalyticsStatsResponse.md)>;` | Get data frame analytics job stats. | +| `getDataFrameAnalyticsStats` | `getDataFrameAnalyticsStats(this: [That](./That.md), params?: [MlGetDataFrameAnalyticsStatsRequest](./MlGetDataFrameAnalyticsStatsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlGetDataFrameAnalyticsStatsResponse](./MlGetDataFrameAnalyticsStatsResponse.md), unknown>>;` |   | +| `getDataFrameAnalyticsStats` | `getDataFrameAnalyticsStats(this: [That](./That.md), params?: [MlGetDataFrameAnalyticsStatsRequest](./MlGetDataFrameAnalyticsStatsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlGetDataFrameAnalyticsStatsResponse](./MlGetDataFrameAnalyticsStatsResponse.md)>;` |   | +| `getFilters` | `getFilters(this: [That](./That.md), params?: [MlGetFiltersRequest](./MlGetFiltersRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlGetFiltersResponse](./MlGetFiltersResponse.md)>;` | Get filters. You can get a single filter or all filters. | +| `getFilters` | `getFilters(this: [That](./That.md), params?: [MlGetFiltersRequest](./MlGetFiltersRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlGetFiltersResponse](./MlGetFiltersResponse.md), unknown>>;` |   | +| `getFilters` | `getFilters(this: [That](./That.md), params?: [MlGetFiltersRequest](./MlGetFiltersRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlGetFiltersResponse](./MlGetFiltersResponse.md)>;` |   | +| `getInfluencers` | `getInfluencers(this: [That](./That.md), params: [MlGetInfluencersRequest](./MlGetInfluencersRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlGetInfluencersResponse](./MlGetInfluencersResponse.md)>;` | Get anomaly detection job results for influencers. Influencers are the entities that have contributed to, or are to blame for, the anomalies. Influencer results are available only if an `influencer_field_name` is specified in the job configuration. | +| `getInfluencers` | `getInfluencers(this: [That](./That.md), params: [MlGetInfluencersRequest](./MlGetInfluencersRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlGetInfluencersResponse](./MlGetInfluencersResponse.md), unknown>>;` |   | +| `getInfluencers` | `getInfluencers(this: [That](./That.md), params: [MlGetInfluencersRequest](./MlGetInfluencersRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlGetInfluencersResponse](./MlGetInfluencersResponse.md)>;` |   | +| `getJobs` | `getJobs(this: [That](./That.md), params?: [MlGetJobsRequest](./MlGetJobsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlGetJobsResponse](./MlGetJobsResponse.md)>;` | Get anomaly detection jobs configuration info. You can get information for multiple anomaly detection jobs in a single API request by using a group name, a comma-separated list of jobs, or a wildcard expression. You can get information for all anomaly detection jobs by using `_all`, by specifying `*` as the ``, or by omitting the ``. | +| `getJobs` | `getJobs(this: [That](./That.md), params?: [MlGetJobsRequest](./MlGetJobsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlGetJobsResponse](./MlGetJobsResponse.md), unknown>>;` |   | +| `getJobs` | `getJobs(this: [That](./That.md), params?: [MlGetJobsRequest](./MlGetJobsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlGetJobsResponse](./MlGetJobsResponse.md)>;` |   | +| `getJobStats` | `getJobStats(this: [That](./That.md), params?: [MlGetJobStatsRequest](./MlGetJobStatsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlGetJobStatsResponse](./MlGetJobStatsResponse.md)>;` | Get anomaly detection job stats. | +| `getJobStats` | `getJobStats(this: [That](./That.md), params?: [MlGetJobStatsRequest](./MlGetJobStatsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlGetJobStatsResponse](./MlGetJobStatsResponse.md), unknown>>;` |   | +| `getJobStats` | `getJobStats(this: [That](./That.md), params?: [MlGetJobStatsRequest](./MlGetJobStatsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlGetJobStatsResponse](./MlGetJobStatsResponse.md)>;` |   | +| `getMemoryStats` | `getMemoryStats(this: [That](./That.md), params?: [MlGetMemoryStatsRequest](./MlGetMemoryStatsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlGetMemoryStatsResponse](./MlGetMemoryStatsResponse.md)>;` | Get machine learning memory usage info. Get information about how machine learning jobs and trained models are using memory, on each node, both within the JVM heap, and natively, outside of the JVM. | +| `getMemoryStats` | `getMemoryStats(this: [That](./That.md), params?: [MlGetMemoryStatsRequest](./MlGetMemoryStatsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlGetMemoryStatsResponse](./MlGetMemoryStatsResponse.md), unknown>>;` |   | +| `getMemoryStats` | `getMemoryStats(this: [That](./That.md), params?: [MlGetMemoryStatsRequest](./MlGetMemoryStatsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlGetMemoryStatsResponse](./MlGetMemoryStatsResponse.md)>;` |   | +| `getModelSnapshots` | `getModelSnapshots(this: [That](./That.md), params: [MlGetModelSnapshotsRequest](./MlGetModelSnapshotsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlGetModelSnapshotsResponse](./MlGetModelSnapshotsResponse.md)>;` | Get model snapshots info. | +| `getModelSnapshots` | `getModelSnapshots(this: [That](./That.md), params: [MlGetModelSnapshotsRequest](./MlGetModelSnapshotsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlGetModelSnapshotsResponse](./MlGetModelSnapshotsResponse.md), unknown>>;` |   | +| `getModelSnapshots` | `getModelSnapshots(this: [That](./That.md), params: [MlGetModelSnapshotsRequest](./MlGetModelSnapshotsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlGetModelSnapshotsResponse](./MlGetModelSnapshotsResponse.md)>;` |   | +| `getModelSnapshotUpgradeStats` | `getModelSnapshotUpgradeStats(this: [That](./That.md), params: [MlGetModelSnapshotUpgradeStatsRequest](./MlGetModelSnapshotUpgradeStatsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlGetModelSnapshotUpgradeStatsResponse](./MlGetModelSnapshotUpgradeStatsResponse.md)>;` | Get anomaly detection job model snapshot upgrade usage info. | +| `getModelSnapshotUpgradeStats` | `getModelSnapshotUpgradeStats(this: [That](./That.md), params: [MlGetModelSnapshotUpgradeStatsRequest](./MlGetModelSnapshotUpgradeStatsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlGetModelSnapshotUpgradeStatsResponse](./MlGetModelSnapshotUpgradeStatsResponse.md), unknown>>;` |   | +| `getModelSnapshotUpgradeStats` | `getModelSnapshotUpgradeStats(this: [That](./That.md), params: [MlGetModelSnapshotUpgradeStatsRequest](./MlGetModelSnapshotUpgradeStatsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlGetModelSnapshotUpgradeStatsResponse](./MlGetModelSnapshotUpgradeStatsResponse.md)>;` |   | +| `getOverallBuckets` | `getOverallBuckets(this: [That](./That.md), params: [MlGetOverallBucketsRequest](./MlGetOverallBucketsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlGetOverallBucketsResponse](./MlGetOverallBucketsResponse.md)>;` | Get overall bucket results. Retrievs overall bucket results that summarize the bucket results of multiple anomaly detection jobs. The `overall_score` is calculated by combining the scores of all the buckets within the overall bucket span. First, the maximum `anomaly_score` per anomaly detection job in the overall bucket is calculated. Then the `top_n` of those scores are averaged to result in the `overall_score`. This means that you can fine-tune the `overall_score` so that it is more or less sensitive to the number of jobs that detect an anomaly at the same time. For example, if you set `top_n` to `1`, the `overall_score` is the maximum bucket score in the overall bucket. Alternatively, if you set `top_n` to the number of jobs, the `overall_score` is high only when all jobs detect anomalies in that overall bucket. If you set the `bucket_span` parameter (to a value greater than its default), the `overall_score` is the maximum `overall_score` of the overall buckets that have a span equal to the jobs' largest bucket span. | +| `getOverallBuckets` | `getOverallBuckets(this: [That](./That.md), params: [MlGetOverallBucketsRequest](./MlGetOverallBucketsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlGetOverallBucketsResponse](./MlGetOverallBucketsResponse.md), unknown>>;` |   | +| `getOverallBuckets` | `getOverallBuckets(this: [That](./That.md), params: [MlGetOverallBucketsRequest](./MlGetOverallBucketsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlGetOverallBucketsResponse](./MlGetOverallBucketsResponse.md)>;` |   | +| `getRecords` | `getRecords(this: [That](./That.md), params: [MlGetRecordsRequest](./MlGetRecordsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlGetRecordsResponse](./MlGetRecordsResponse.md)>;` | Get anomaly records for an anomaly detection job. Records contain the detailed analytical results. They describe the anomalous activity that has been identified in the input data based on the detector configuration. There can be many anomaly records depending on the characteristics and size of the input data. In practice, there are often too many to be able to manually process them. The machine learning features therefore perform a sophisticated aggregation of the anomaly records into buckets. The number of record results depends on the number of anomalies found in each bucket, which relates to the number of time series being modeled and the number of detectors. | +| `getRecords` | `getRecords(this: [That](./That.md), params: [MlGetRecordsRequest](./MlGetRecordsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlGetRecordsResponse](./MlGetRecordsResponse.md), unknown>>;` |   | +| `getRecords` | `getRecords(this: [That](./That.md), params: [MlGetRecordsRequest](./MlGetRecordsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlGetRecordsResponse](./MlGetRecordsResponse.md)>;` |   | +| `getTrainedModels` | `getTrainedModels(this: [That](./That.md), params?: [MlGetTrainedModelsRequest](./MlGetTrainedModelsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlGetTrainedModelsResponse](./MlGetTrainedModelsResponse.md)>;` | Get trained model configuration info. | +| `getTrainedModels` | `getTrainedModels(this: [That](./That.md), params?: [MlGetTrainedModelsRequest](./MlGetTrainedModelsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlGetTrainedModelsResponse](./MlGetTrainedModelsResponse.md), unknown>>;` |   | +| `getTrainedModels` | `getTrainedModels(this: [That](./That.md), params?: [MlGetTrainedModelsRequest](./MlGetTrainedModelsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlGetTrainedModelsResponse](./MlGetTrainedModelsResponse.md)>;` |   | +| `getTrainedModelsStats` | `getTrainedModelsStats(this: [That](./That.md), params?: [MlGetTrainedModelsStatsRequest](./MlGetTrainedModelsStatsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlGetTrainedModelsStatsResponse](./MlGetTrainedModelsStatsResponse.md)>;` | Get trained models usage info. You can get usage information for multiple trained models in a single API request by using a comma-separated list of model IDs or a wildcard expression. | +| `getTrainedModelsStats` | `getTrainedModelsStats(this: [That](./That.md), params?: [MlGetTrainedModelsStatsRequest](./MlGetTrainedModelsStatsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlGetTrainedModelsStatsResponse](./MlGetTrainedModelsStatsResponse.md), unknown>>;` |   | +| `getTrainedModelsStats` | `getTrainedModelsStats(this: [That](./That.md), params?: [MlGetTrainedModelsStatsRequest](./MlGetTrainedModelsStatsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlGetTrainedModelsStatsResponse](./MlGetTrainedModelsStatsResponse.md)>;` |   | +| `inferTrainedModel` | `inferTrainedModel(this: [That](./That.md), params: [MlInferTrainedModelRequest](./MlInferTrainedModelRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlInferTrainedModelResponse](./MlInferTrainedModelResponse.md)>;` | Evaluate a trained model. | +| `inferTrainedModel` | `inferTrainedModel(this: [That](./That.md), params: [MlInferTrainedModelRequest](./MlInferTrainedModelRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlInferTrainedModelResponse](./MlInferTrainedModelResponse.md), unknown>>;` |   | +| `inferTrainedModel` | `inferTrainedModel(this: [That](./That.md), params: [MlInferTrainedModelRequest](./MlInferTrainedModelRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlInferTrainedModelResponse](./MlInferTrainedModelResponse.md)>;` |   | +| `info` | `info(this: [That](./That.md), params?: [MlInfoRequest](./MlInfoRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlInfoResponse](./MlInfoResponse.md)>;` | Get machine learning information. Get defaults and limits used by machine learning. This endpoint is designed to be used by a user interface that needs to fully understand machine learning configurations where some options are not specified, meaning that the defaults should be used. This endpoint may be used to find out what those defaults are. It also provides information about the maximum size of machine learning jobs that could run in the current cluster configuration. | +| `info` | `info(this: [That](./That.md), params?: [MlInfoRequest](./MlInfoRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlInfoResponse](./MlInfoResponse.md), unknown>>;` |   | +| `info` | `info(this: [That](./That.md), params?: [MlInfoRequest](./MlInfoRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlInfoResponse](./MlInfoResponse.md)>;` |   | +| `openJob` | `openJob(this: [That](./That.md), params: [MlOpenJobRequest](./MlOpenJobRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlOpenJobResponse](./MlOpenJobResponse.md)>;` | Open anomaly detection jobs. An anomaly detection job must be opened to be ready to receive and analyze data. It can be opened and closed multiple times throughout its lifecycle. When you open a new job, it starts with an empty model. When you open an existing job, the most recent model state is automatically loaded. The job is ready to resume its analysis from where it left off, once new data is received. | +| `openJob` | `openJob(this: [That](./That.md), params: [MlOpenJobRequest](./MlOpenJobRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlOpenJobResponse](./MlOpenJobResponse.md), unknown>>;` |   | +| `openJob` | `openJob(this: [That](./That.md), params: [MlOpenJobRequest](./MlOpenJobRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlOpenJobResponse](./MlOpenJobResponse.md)>;` |   | +| `postCalendarEvents` | `postCalendarEvents(this: [That](./That.md), params: [MlPostCalendarEventsRequest](./MlPostCalendarEventsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlPostCalendarEventsResponse](./MlPostCalendarEventsResponse.md)>;` | Add scheduled events to the calendar. | +| `postCalendarEvents` | `postCalendarEvents(this: [That](./That.md), params: [MlPostCalendarEventsRequest](./MlPostCalendarEventsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlPostCalendarEventsResponse](./MlPostCalendarEventsResponse.md), unknown>>;` |   | +| `postCalendarEvents` | `postCalendarEvents(this: [That](./That.md), params: [MlPostCalendarEventsRequest](./MlPostCalendarEventsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlPostCalendarEventsResponse](./MlPostCalendarEventsResponse.md)>;` |   | +| `postData` | `postData(this: [That](./That.md), params: [MlPostDataRequest](./MlPostDataRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlPostDataResponse](./MlPostDataResponse.md)>;` | Send data to an anomaly detection job for analysis. IMPORTANT: For each job, data can be accepted from only a single connection at a time. It is not currently possible to post data to multiple jobs using wildcards or a comma-separated list. | +| `postData` | `postData(this: [That](./That.md), params: [MlPostDataRequest](./MlPostDataRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlPostDataResponse](./MlPostDataResponse.md), unknown>>;` |   | +| `postData` | `postData(this: [That](./That.md), params: [MlPostDataRequest](./MlPostDataRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlPostDataResponse](./MlPostDataResponse.md)>;` |   | +| `previewDatafeed` | `previewDatafeed(this: [That](./That.md), params?: [MlPreviewDatafeedRequest](./MlPreviewDatafeedRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlPreviewDatafeedResponse](./MlPreviewDatafeedResponse.md)>;` | Preview a datafeed. This API returns the first "page" of search results from a datafeed. You can preview an existing datafeed or provide configuration details for a datafeed and anomaly detection job in the API. The preview shows the structure of the data that will be passed to the anomaly detection engine. IMPORTANT: When Elasticsearch security features are enabled, the preview uses the credentials of the user that called the API. However, when the datafeed starts it uses the roles of the last user that created or updated the datafeed. To get a preview that accurately reflects the behavior of the datafeed, use the appropriate credentials. You can also use secondary authorization headers to supply the credentials. | +| `previewDatafeed` | `previewDatafeed(this: [That](./That.md), params?: [MlPreviewDatafeedRequest](./MlPreviewDatafeedRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlPreviewDatafeedResponse](./MlPreviewDatafeedResponse.md), unknown>>;` |   | +| `previewDatafeed` | `previewDatafeed(this: [That](./That.md), params?: [MlPreviewDatafeedRequest](./MlPreviewDatafeedRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlPreviewDatafeedResponse](./MlPreviewDatafeedResponse.md)>;` |   | +| `previewDataFrameAnalytics` | `previewDataFrameAnalytics(this: [That](./That.md), params?: [MlPreviewDataFrameAnalyticsRequest](./MlPreviewDataFrameAnalyticsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlPreviewDataFrameAnalyticsResponse](./MlPreviewDataFrameAnalyticsResponse.md)>;` | Preview features used by data frame analytics. Preview the extracted features used by a data frame analytics config. | +| `previewDataFrameAnalytics` | `previewDataFrameAnalytics(this: [That](./That.md), params?: [MlPreviewDataFrameAnalyticsRequest](./MlPreviewDataFrameAnalyticsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlPreviewDataFrameAnalyticsResponse](./MlPreviewDataFrameAnalyticsResponse.md), unknown>>;` |   | +| `previewDataFrameAnalytics` | `previewDataFrameAnalytics(this: [That](./That.md), params?: [MlPreviewDataFrameAnalyticsRequest](./MlPreviewDataFrameAnalyticsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlPreviewDataFrameAnalyticsResponse](./MlPreviewDataFrameAnalyticsResponse.md)>;` |   | +| `putCalendar` | `putCalendar(this: [That](./That.md), params: [MlPutCalendarRequest](./MlPutCalendarRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlPutCalendarResponse](./MlPutCalendarResponse.md)>;` | Create a calendar. | +| `putCalendar` | `putCalendar(this: [That](./That.md), params: [MlPutCalendarRequest](./MlPutCalendarRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlPutCalendarResponse](./MlPutCalendarResponse.md), unknown>>;` |   | +| `putCalendar` | `putCalendar(this: [That](./That.md), params: [MlPutCalendarRequest](./MlPutCalendarRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlPutCalendarResponse](./MlPutCalendarResponse.md)>;` |   | +| `putCalendarJob` | `putCalendarJob(this: [That](./That.md), params: [MlPutCalendarJobRequest](./MlPutCalendarJobRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlPutCalendarJobResponse](./MlPutCalendarJobResponse.md)>;` | Add anomaly detection job to calendar. | +| `putCalendarJob` | `putCalendarJob(this: [That](./That.md), params: [MlPutCalendarJobRequest](./MlPutCalendarJobRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlPutCalendarJobResponse](./MlPutCalendarJobResponse.md), unknown>>;` |   | +| `putCalendarJob` | `putCalendarJob(this: [That](./That.md), params: [MlPutCalendarJobRequest](./MlPutCalendarJobRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlPutCalendarJobResponse](./MlPutCalendarJobResponse.md)>;` |   | +| `putDatafeed` | `putDatafeed(this: [That](./That.md), params: [MlPutDatafeedRequest](./MlPutDatafeedRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlPutDatafeedResponse](./MlPutDatafeedResponse.md)>;` | Create a datafeed. Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job. You can associate only one datafeed with each anomaly detection job. The datafeed contains a query that runs at a defined interval ( `frequency`). If you are concerned about delayed data, you can add a delay ( `query_delay') at each interval. By default, the datafeed uses the following query: `{ "match_all": { "boost": 1 } } `. When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead. You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed directly to the `.ml-config ` index. Do not give users `write ` privileges on the `.ml-config ` index. | +| `putDatafeed` | `putDatafeed(this: [That](./That.md), params: [MlPutDatafeedRequest](./MlPutDatafeedRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlPutDatafeedResponse](./MlPutDatafeedResponse.md), unknown>>;` |   | +| `putDatafeed` | `putDatafeed(this: [That](./That.md), params: [MlPutDatafeedRequest](./MlPutDatafeedRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlPutDatafeedResponse](./MlPutDatafeedResponse.md)>;` |   | +| `putDataFrameAnalytics` | `putDataFrameAnalytics(this: [That](./That.md), params: [MlPutDataFrameAnalyticsRequest](./MlPutDataFrameAnalyticsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlPutDataFrameAnalyticsResponse](./MlPutDataFrameAnalyticsResponse.md)>;` | Create a data frame analytics job. This API creates a data frame analytics job that performs an analysis on the source indices and stores the outcome in a destination index. By default, the query used in the source configuration is `{"match_all": {}}`. If the destination index does not exist, it is created automatically when you start the job. If you supply only a subset of the regression or classification parameters, hyperparameter optimization occurs. It determines a value for each of the undefined parameters. | +| `putDataFrameAnalytics` | `putDataFrameAnalytics(this: [That](./That.md), params: [MlPutDataFrameAnalyticsRequest](./MlPutDataFrameAnalyticsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlPutDataFrameAnalyticsResponse](./MlPutDataFrameAnalyticsResponse.md), unknown>>;` |   | +| `putDataFrameAnalytics` | `putDataFrameAnalytics(this: [That](./That.md), params: [MlPutDataFrameAnalyticsRequest](./MlPutDataFrameAnalyticsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlPutDataFrameAnalyticsResponse](./MlPutDataFrameAnalyticsResponse.md)>;` |   | +| `putFilter` | `putFilter(this: [That](./That.md), params: [MlPutFilterRequest](./MlPutFilterRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlPutFilterResponse](./MlPutFilterResponse.md)>;` | Create a filter. A filter contains a list of strings. It can be used by one or more anomaly detection jobs. Specifically, filters are referenced in the `custom_rules` property of detector configuration objects. | +| `putFilter` | `putFilter(this: [That](./That.md), params: [MlPutFilterRequest](./MlPutFilterRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlPutFilterResponse](./MlPutFilterResponse.md), unknown>>;` |   | +| `putFilter` | `putFilter(this: [That](./That.md), params: [MlPutFilterRequest](./MlPutFilterRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlPutFilterResponse](./MlPutFilterResponse.md)>;` |   | +| `putJob` | `putJob(this: [That](./That.md), params: [MlPutJobRequest](./MlPutJobRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlPutJobResponse](./MlPutJobResponse.md)>;` | Create an anomaly detection job. If you include a `datafeed_config`, you must have read index privileges on the source index. If you include a `datafeed_config` but do not provide a query, the datafeed uses `{"match_all": {"boost": 1}}`. | +| `putJob` | `putJob(this: [That](./That.md), params: [MlPutJobRequest](./MlPutJobRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlPutJobResponse](./MlPutJobResponse.md), unknown>>;` |   | +| `putJob` | `putJob(this: [That](./That.md), params: [MlPutJobRequest](./MlPutJobRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlPutJobResponse](./MlPutJobResponse.md)>;` |   | +| `putTrainedModel` | `putTrainedModel(this: [That](./That.md), params: [MlPutTrainedModelRequest](./MlPutTrainedModelRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlPutTrainedModelResponse](./MlPutTrainedModelResponse.md)>;` | Create a trained model. Enable you to supply a trained model that is not created by data frame analytics. | +| `putTrainedModel` | `putTrainedModel(this: [That](./That.md), params: [MlPutTrainedModelRequest](./MlPutTrainedModelRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlPutTrainedModelResponse](./MlPutTrainedModelResponse.md), unknown>>;` |   | +| `putTrainedModel` | `putTrainedModel(this: [That](./That.md), params: [MlPutTrainedModelRequest](./MlPutTrainedModelRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlPutTrainedModelResponse](./MlPutTrainedModelResponse.md)>;` |   | +| `putTrainedModelAlias` | `putTrainedModelAlias(this: [That](./That.md), params: [MlPutTrainedModelAliasRequest](./MlPutTrainedModelAliasRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlPutTrainedModelAliasResponse](./MlPutTrainedModelAliasResponse.md)>;` | Create or update a trained model alias. A trained model alias is a logical name used to reference a single trained model. You can use aliases instead of trained model identifiers to make it easier to reference your models. For example, you can use aliases in inference aggregations and processors. An alias must be unique and refer to only a single trained model. However, you can have multiple aliases for each trained model. If you use this API to update an alias such that it references a different trained model ID and the model uses a different type of data frame analytics, an error occurs. For example, this situation occurs if you have a trained model for regression analysis and a trained model for classification analysis; you cannot reassign an alias from one type of trained model to another. If you use this API to update an alias and there are very few input fields in common between the old and new trained models for the model alias, the API returns a warning. | +| `putTrainedModelAlias` | `putTrainedModelAlias(this: [That](./That.md), params: [MlPutTrainedModelAliasRequest](./MlPutTrainedModelAliasRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlPutTrainedModelAliasResponse](./MlPutTrainedModelAliasResponse.md), unknown>>;` |   | +| `putTrainedModelAlias` | `putTrainedModelAlias(this: [That](./That.md), params: [MlPutTrainedModelAliasRequest](./MlPutTrainedModelAliasRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlPutTrainedModelAliasResponse](./MlPutTrainedModelAliasResponse.md)>;` |   | +| `putTrainedModelDefinitionPart` | `putTrainedModelDefinitionPart(this: [That](./That.md), params: [MlPutTrainedModelDefinitionPartRequest](./MlPutTrainedModelDefinitionPartRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlPutTrainedModelDefinitionPartResponse](./MlPutTrainedModelDefinitionPartResponse.md)>;` | Create part of a trained model definition. | +| `putTrainedModelDefinitionPart` | `putTrainedModelDefinitionPart(this: [That](./That.md), params: [MlPutTrainedModelDefinitionPartRequest](./MlPutTrainedModelDefinitionPartRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlPutTrainedModelDefinitionPartResponse](./MlPutTrainedModelDefinitionPartResponse.md), unknown>>;` |   | +| `putTrainedModelDefinitionPart` | `putTrainedModelDefinitionPart(this: [That](./That.md), params: [MlPutTrainedModelDefinitionPartRequest](./MlPutTrainedModelDefinitionPartRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlPutTrainedModelDefinitionPartResponse](./MlPutTrainedModelDefinitionPartResponse.md)>;` |   | +| `putTrainedModelVocabulary` | `putTrainedModelVocabulary(this: [That](./That.md), params: [MlPutTrainedModelVocabularyRequest](./MlPutTrainedModelVocabularyRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlPutTrainedModelVocabularyResponse](./MlPutTrainedModelVocabularyResponse.md)>;` | Create a trained model vocabulary. This API is supported only for natural language processing (NLP) models. The vocabulary is stored in the index as described in `inference_config.*.vocabulary` of the trained model definition. | +| `putTrainedModelVocabulary` | `putTrainedModelVocabulary(this: [That](./That.md), params: [MlPutTrainedModelVocabularyRequest](./MlPutTrainedModelVocabularyRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlPutTrainedModelVocabularyResponse](./MlPutTrainedModelVocabularyResponse.md), unknown>>;` |   | +| `putTrainedModelVocabulary` | `putTrainedModelVocabulary(this: [That](./That.md), params: [MlPutTrainedModelVocabularyRequest](./MlPutTrainedModelVocabularyRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlPutTrainedModelVocabularyResponse](./MlPutTrainedModelVocabularyResponse.md)>;` |   | +| `resetJob` | `resetJob(this: [That](./That.md), params: [MlResetJobRequest](./MlResetJobRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlResetJobResponse](./MlResetJobResponse.md)>;` | Reset an anomaly detection job. All model state and results are deleted. The job is ready to start over as if it had just been created. It is not currently possible to reset multiple jobs using wildcards or a comma separated list. | +| `resetJob` | `resetJob(this: [That](./That.md), params: [MlResetJobRequest](./MlResetJobRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlResetJobResponse](./MlResetJobResponse.md), unknown>>;` |   | +| `resetJob` | `resetJob(this: [That](./That.md), params: [MlResetJobRequest](./MlResetJobRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlResetJobResponse](./MlResetJobResponse.md)>;` |   | +| `revertModelSnapshot` | `revertModelSnapshot(this: [That](./That.md), params: [MlRevertModelSnapshotRequest](./MlRevertModelSnapshotRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlRevertModelSnapshotResponse](./MlRevertModelSnapshotResponse.md)>;` | Revert to a snapshot. The machine learning features react quickly to anomalous input, learning new behaviors in data. Highly anomalous input increases the variance in the models whilst the system learns whether this is a new step-change in behavior or a one-off event. In the case where this anomalous input is known to be a one-off, then it might be appropriate to reset the model state to a time before this event. For example, you might consider reverting to a saved snapshot after Black Friday or a critical system failure. | +| `revertModelSnapshot` | `revertModelSnapshot(this: [That](./That.md), params: [MlRevertModelSnapshotRequest](./MlRevertModelSnapshotRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlRevertModelSnapshotResponse](./MlRevertModelSnapshotResponse.md), unknown>>;` |   | +| `revertModelSnapshot` | `revertModelSnapshot(this: [That](./That.md), params: [MlRevertModelSnapshotRequest](./MlRevertModelSnapshotRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlRevertModelSnapshotResponse](./MlRevertModelSnapshotResponse.md)>;` |   | +| `setUpgradeMode` | `setUpgradeMode(this: [That](./That.md), params?: [MlSetUpgradeModeRequest](./MlSetUpgradeModeRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlSetUpgradeModeResponse](./MlSetUpgradeModeResponse.md)>;` | Set upgrade_mode for ML indices. Sets a cluster wide upgrade_mode setting that prepares machine learning indices for an upgrade. When upgrading your cluster, in some circumstances you must restart your nodes and reindex your machine learning indices. In those circumstances, there must be no machine learning jobs running. You can close the machine learning jobs, do the upgrade, then open all the jobs again. Alternatively, you can use this API to temporarily halt tasks associated with the jobs and datafeeds and prevent new jobs from opening. You can also use this API during upgrades that do not require you to reindex your machine learning indices, though stopping jobs is not a requirement in that case. You can see the current value for the upgrade_mode setting by using the get machine learning info API. | +| `setUpgradeMode` | `setUpgradeMode(this: [That](./That.md), params?: [MlSetUpgradeModeRequest](./MlSetUpgradeModeRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlSetUpgradeModeResponse](./MlSetUpgradeModeResponse.md), unknown>>;` |   | +| `setUpgradeMode` | `setUpgradeMode(this: [That](./That.md), params?: [MlSetUpgradeModeRequest](./MlSetUpgradeModeRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlSetUpgradeModeResponse](./MlSetUpgradeModeResponse.md)>;` |   | +| `startDatafeed` | `startDatafeed(this: [That](./That.md), params: [MlStartDatafeedRequest](./MlStartDatafeedRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlStartDatafeedResponse](./MlStartDatafeedResponse.md)>;` | Start datafeeds. A datafeed must be started in order to retrieve data from Elasticsearch. A datafeed can be started and stopped multiple times throughout its lifecycle. Before you can start a datafeed, the anomaly detection job must be open. Otherwise, an error occurs. If you restart a stopped datafeed, it continues processing input data from the next millisecond after it was stopped. If new data was indexed for that exact millisecond between stopping and starting, it will be ignored. When Elasticsearch security features are enabled, your datafeed remembers which roles the last user to create or update it had at the time of creation or update and runs the query using those same roles. If you provided secondary authorization headers when you created or updated the datafeed, those credentials are used instead. | +| `startDatafeed` | `startDatafeed(this: [That](./That.md), params: [MlStartDatafeedRequest](./MlStartDatafeedRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlStartDatafeedResponse](./MlStartDatafeedResponse.md), unknown>>;` |   | +| `startDatafeed` | `startDatafeed(this: [That](./That.md), params: [MlStartDatafeedRequest](./MlStartDatafeedRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlStartDatafeedResponse](./MlStartDatafeedResponse.md)>;` |   | +| `startDataFrameAnalytics` | `startDataFrameAnalytics(this: [That](./That.md), params: [MlStartDataFrameAnalyticsRequest](./MlStartDataFrameAnalyticsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlStartDataFrameAnalyticsResponse](./MlStartDataFrameAnalyticsResponse.md)>;` | Start a data frame analytics job. A data frame analytics job can be started and stopped multiple times throughout its lifecycle. If the destination index does not exist, it is created automatically the first time you start the data frame analytics job. The `index.number_of_shards` and `index.number_of_replicas` settings for the destination index are copied from the source index. If there are multiple source indices, the destination index copies the highest setting values. The mappings for the destination index are also copied from the source indices. If there are any mapping conflicts, the job fails to start. If the destination index exists, it is used as is. You can therefore set up the destination index in advance with custom settings and mappings. | +| `startDataFrameAnalytics` | `startDataFrameAnalytics(this: [That](./That.md), params: [MlStartDataFrameAnalyticsRequest](./MlStartDataFrameAnalyticsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlStartDataFrameAnalyticsResponse](./MlStartDataFrameAnalyticsResponse.md), unknown>>;` |   | +| `startDataFrameAnalytics` | `startDataFrameAnalytics(this: [That](./That.md), params: [MlStartDataFrameAnalyticsRequest](./MlStartDataFrameAnalyticsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlStartDataFrameAnalyticsResponse](./MlStartDataFrameAnalyticsResponse.md)>;` |   | +| `startTrainedModelDeployment` | `startTrainedModelDeployment(this: [That](./That.md), params: [MlStartTrainedModelDeploymentRequest](./MlStartTrainedModelDeploymentRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlStartTrainedModelDeploymentResponse](./MlStartTrainedModelDeploymentResponse.md)>;` | Start a trained model deployment. It allocates the model to every machine learning node. | +| `startTrainedModelDeployment` | `startTrainedModelDeployment(this: [That](./That.md), params: [MlStartTrainedModelDeploymentRequest](./MlStartTrainedModelDeploymentRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlStartTrainedModelDeploymentResponse](./MlStartTrainedModelDeploymentResponse.md), unknown>>;` |   | +| `startTrainedModelDeployment` | `startTrainedModelDeployment(this: [That](./That.md), params: [MlStartTrainedModelDeploymentRequest](./MlStartTrainedModelDeploymentRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlStartTrainedModelDeploymentResponse](./MlStartTrainedModelDeploymentResponse.md)>;` |   | +| `stopDatafeed` | `stopDatafeed(this: [That](./That.md), params: [MlStopDatafeedRequest](./MlStopDatafeedRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlStopDatafeedResponse](./MlStopDatafeedResponse.md)>;` | Stop datafeeds. A datafeed that is stopped ceases to retrieve data from Elasticsearch. A datafeed can be started and stopped multiple times throughout its lifecycle. | +| `stopDatafeed` | `stopDatafeed(this: [That](./That.md), params: [MlStopDatafeedRequest](./MlStopDatafeedRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlStopDatafeedResponse](./MlStopDatafeedResponse.md), unknown>>;` |   | +| `stopDatafeed` | `stopDatafeed(this: [That](./That.md), params: [MlStopDatafeedRequest](./MlStopDatafeedRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlStopDatafeedResponse](./MlStopDatafeedResponse.md)>;` |   | +| `stopDataFrameAnalytics` | `stopDataFrameAnalytics(this: [That](./That.md), params: [MlStopDataFrameAnalyticsRequest](./MlStopDataFrameAnalyticsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlStopDataFrameAnalyticsResponse](./MlStopDataFrameAnalyticsResponse.md)>;` | Stop data frame analytics jobs. A data frame analytics job can be started and stopped multiple times throughout its lifecycle. | +| `stopDataFrameAnalytics` | `stopDataFrameAnalytics(this: [That](./That.md), params: [MlStopDataFrameAnalyticsRequest](./MlStopDataFrameAnalyticsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlStopDataFrameAnalyticsResponse](./MlStopDataFrameAnalyticsResponse.md), unknown>>;` |   | +| `stopDataFrameAnalytics` | `stopDataFrameAnalytics(this: [That](./That.md), params: [MlStopDataFrameAnalyticsRequest](./MlStopDataFrameAnalyticsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlStopDataFrameAnalyticsResponse](./MlStopDataFrameAnalyticsResponse.md)>;` |   | +| `stopTrainedModelDeployment` | `stopTrainedModelDeployment(this: [That](./That.md), params: [MlStopTrainedModelDeploymentRequest](./MlStopTrainedModelDeploymentRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlStopTrainedModelDeploymentResponse](./MlStopTrainedModelDeploymentResponse.md)>;` | Stop a trained model deployment. | +| `stopTrainedModelDeployment` | `stopTrainedModelDeployment(this: [That](./That.md), params: [MlStopTrainedModelDeploymentRequest](./MlStopTrainedModelDeploymentRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlStopTrainedModelDeploymentResponse](./MlStopTrainedModelDeploymentResponse.md), unknown>>;` |   | +| `stopTrainedModelDeployment` | `stopTrainedModelDeployment(this: [That](./That.md), params: [MlStopTrainedModelDeploymentRequest](./MlStopTrainedModelDeploymentRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlStopTrainedModelDeploymentResponse](./MlStopTrainedModelDeploymentResponse.md)>;` |   | +| `updateDatafeed` | `updateDatafeed(this: [That](./That.md), params: [MlUpdateDatafeedRequest](./MlUpdateDatafeedRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlUpdateDatafeedResponse](./MlUpdateDatafeedResponse.md)>;` | Update a datafeed. You must stop and start the datafeed for the changes to be applied. When Elasticsearch security features are enabled, your datafeed remembers which roles the user who updated it had at the time of the update and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead. | +| `updateDatafeed` | `updateDatafeed(this: [That](./That.md), params: [MlUpdateDatafeedRequest](./MlUpdateDatafeedRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlUpdateDatafeedResponse](./MlUpdateDatafeedResponse.md), unknown>>;` |   | +| `updateDatafeed` | `updateDatafeed(this: [That](./That.md), params: [MlUpdateDatafeedRequest](./MlUpdateDatafeedRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlUpdateDatafeedResponse](./MlUpdateDatafeedResponse.md)>;` |   | +| `updateDataFrameAnalytics` | `updateDataFrameAnalytics(this: [That](./That.md), params: [MlUpdateDataFrameAnalyticsRequest](./MlUpdateDataFrameAnalyticsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlUpdateDataFrameAnalyticsResponse](./MlUpdateDataFrameAnalyticsResponse.md)>;` | Update a data frame analytics job. | +| `updateDataFrameAnalytics` | `updateDataFrameAnalytics(this: [That](./That.md), params: [MlUpdateDataFrameAnalyticsRequest](./MlUpdateDataFrameAnalyticsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlUpdateDataFrameAnalyticsResponse](./MlUpdateDataFrameAnalyticsResponse.md), unknown>>;` |   | +| `updateDataFrameAnalytics` | `updateDataFrameAnalytics(this: [That](./That.md), params: [MlUpdateDataFrameAnalyticsRequest](./MlUpdateDataFrameAnalyticsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlUpdateDataFrameAnalyticsResponse](./MlUpdateDataFrameAnalyticsResponse.md)>;` |   | +| `updateFilter` | `updateFilter(this: [That](./That.md), params: [MlUpdateFilterRequest](./MlUpdateFilterRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlUpdateFilterResponse](./MlUpdateFilterResponse.md)>;` | Update a filter. Updates the description of a filter, adds items, or removes items from the list. | +| `updateFilter` | `updateFilter(this: [That](./That.md), params: [MlUpdateFilterRequest](./MlUpdateFilterRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlUpdateFilterResponse](./MlUpdateFilterResponse.md), unknown>>;` |   | +| `updateFilter` | `updateFilter(this: [That](./That.md), params: [MlUpdateFilterRequest](./MlUpdateFilterRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlUpdateFilterResponse](./MlUpdateFilterResponse.md)>;` |   | +| `updateJob` | `updateJob(this: [That](./That.md), params: [MlUpdateJobRequest](./MlUpdateJobRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlUpdateJobResponse](./MlUpdateJobResponse.md)>;` | Update an anomaly detection job. Updates certain properties of an anomaly detection job. | +| `updateJob` | `updateJob(this: [That](./That.md), params: [MlUpdateJobRequest](./MlUpdateJobRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlUpdateJobResponse](./MlUpdateJobResponse.md), unknown>>;` |   | +| `updateJob` | `updateJob(this: [That](./That.md), params: [MlUpdateJobRequest](./MlUpdateJobRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlUpdateJobResponse](./MlUpdateJobResponse.md)>;` |   | +| `updateModelSnapshot` | `updateModelSnapshot(this: [That](./That.md), params: [MlUpdateModelSnapshotRequest](./MlUpdateModelSnapshotRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlUpdateModelSnapshotResponse](./MlUpdateModelSnapshotResponse.md)>;` | Update a snapshot. Updates certain properties of a snapshot. | +| `updateModelSnapshot` | `updateModelSnapshot(this: [That](./That.md), params: [MlUpdateModelSnapshotRequest](./MlUpdateModelSnapshotRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlUpdateModelSnapshotResponse](./MlUpdateModelSnapshotResponse.md), unknown>>;` |   | +| `updateModelSnapshot` | `updateModelSnapshot(this: [That](./That.md), params: [MlUpdateModelSnapshotRequest](./MlUpdateModelSnapshotRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlUpdateModelSnapshotResponse](./MlUpdateModelSnapshotResponse.md)>;` |   | +| `updateTrainedModelDeployment` | `updateTrainedModelDeployment(this: [That](./That.md), params: [MlUpdateTrainedModelDeploymentRequest](./MlUpdateTrainedModelDeploymentRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlUpdateTrainedModelDeploymentResponse](./MlUpdateTrainedModelDeploymentResponse.md)>;` | Update a trained model deployment. | +| `updateTrainedModelDeployment` | `updateTrainedModelDeployment(this: [That](./That.md), params: [MlUpdateTrainedModelDeploymentRequest](./MlUpdateTrainedModelDeploymentRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlUpdateTrainedModelDeploymentResponse](./MlUpdateTrainedModelDeploymentResponse.md), unknown>>;` |   | +| `updateTrainedModelDeployment` | `updateTrainedModelDeployment(this: [That](./That.md), params: [MlUpdateTrainedModelDeploymentRequest](./MlUpdateTrainedModelDeploymentRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlUpdateTrainedModelDeploymentResponse](./MlUpdateTrainedModelDeploymentResponse.md)>;` |   | +| `upgradeJobSnapshot` | `upgradeJobSnapshot(this: [That](./That.md), params: [MlUpgradeJobSnapshotRequest](./MlUpgradeJobSnapshotRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlUpgradeJobSnapshotResponse](./MlUpgradeJobSnapshotResponse.md)>;` | Upgrade a snapshot. Upgrade an anomaly detection model snapshot to the latest major version. Over time, older snapshot formats are deprecated and removed. Anomaly detection jobs support only snapshots that are from the current or previous major version. This API provides a means to upgrade a snapshot to the current major version. This aids in preparing the cluster for an upgrade to the next major version. Only one snapshot per anomaly detection job can be upgraded at a time and the upgraded snapshot cannot be the current snapshot of the anomaly detection job. | +| `upgradeJobSnapshot` | `upgradeJobSnapshot(this: [That](./That.md), params: [MlUpgradeJobSnapshotRequest](./MlUpgradeJobSnapshotRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlUpgradeJobSnapshotResponse](./MlUpgradeJobSnapshotResponse.md), unknown>>;` |   | +| `upgradeJobSnapshot` | `upgradeJobSnapshot(this: [That](./That.md), params: [MlUpgradeJobSnapshotRequest](./MlUpgradeJobSnapshotRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlUpgradeJobSnapshotResponse](./MlUpgradeJobSnapshotResponse.md)>;` |   | +| `validate` | `validate(this: [That](./That.md), params?: [MlValidateRequest](./MlValidateRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlValidateResponse](./MlValidateResponse.md)>;` | Validate an anomaly detection job. | +| `validate` | `validate(this: [That](./That.md), params?: [MlValidateRequest](./MlValidateRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlValidateResponse](./MlValidateResponse.md), unknown>>;` |   | +| `validate` | `validate(this: [That](./That.md), params?: [MlValidateRequest](./MlValidateRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlValidateResponse](./MlValidateResponse.md)>;` |   | +| `validateDetector` | `validateDetector(this: [That](./That.md), params: [MlValidateDetectorRequest](./MlValidateDetectorRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MlValidateDetectorResponse](./MlValidateDetectorResponse.md)>;` | Validate an anomaly detection job. | +| `validateDetector` | `validateDetector(this: [That](./That.md), params: [MlValidateDetectorRequest](./MlValidateDetectorRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MlValidateDetectorResponse](./MlValidateDetectorResponse.md), unknown>>;` |   | +| `validateDetector` | `validateDetector(this: [That](./That.md), params: [MlValidateDetectorRequest](./MlValidateDetectorRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MlValidateDetectorResponse](./MlValidateDetectorResponse.md)>;` |   | diff --git a/docs/reference/api/Monitoring.md b/docs/reference/api/Monitoring.md index d277b3c2a..b48ff2b57 100644 --- a/docs/reference/api/Monitoring.md +++ b/docs/reference/api/Monitoring.md @@ -17,4 +17,6 @@ new Monitoring(transport: [Transport](./Transport.md)); | Name | Signature | Description | | - | - | - | -| `bulk` | `bulk(this: [That](./That.md), params: [MonitoringBulkRequest](./MonitoringBulkRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MonitoringBulkResponse](./MonitoringBulkResponse.md)>;` | Send monitoring data. This API is used by the monitoring features to send monitoring data. || `bulk` | `bulk(this: [That](./That.md), params: [MonitoringBulkRequest](./MonitoringBulkRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MonitoringBulkResponse](./MonitoringBulkResponse.md), unknown>>;` |   || `bulk` | `bulk(this: [That](./That.md), params: [MonitoringBulkRequest](./MonitoringBulkRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MonitoringBulkResponse](./MonitoringBulkResponse.md)>;` |   | \ No newline at end of file +| `bulk` | `bulk(this: [That](./That.md), params: [MonitoringBulkRequest](./MonitoringBulkRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MonitoringBulkResponse](./MonitoringBulkResponse.md)>;` | Send monitoring data. This API is used by the monitoring features to send monitoring data. | +| `bulk` | `bulk(this: [That](./That.md), params: [MonitoringBulkRequest](./MonitoringBulkRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MonitoringBulkResponse](./MonitoringBulkResponse.md), unknown>>;` |   | +| `bulk` | `bulk(this: [That](./That.md), params: [MonitoringBulkRequest](./MonitoringBulkRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MonitoringBulkResponse](./MonitoringBulkResponse.md)>;` |   | diff --git a/docs/reference/api/Nodes.md b/docs/reference/api/Nodes.md index 3f9b56e12..09b7dbf29 100644 --- a/docs/reference/api/Nodes.md +++ b/docs/reference/api/Nodes.md @@ -17,4 +17,24 @@ new Nodes(transport: [Transport](./Transport.md)); | Name | Signature | Description | | - | - | - | -| `clearRepositoriesMeteringArchive` | `clearRepositoriesMeteringArchive(this: [That](./That.md), params: [NodesClearRepositoriesMeteringArchiveRequest](./NodesClearRepositoriesMeteringArchiveRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[NodesClearRepositoriesMeteringArchiveResponse](./NodesClearRepositoriesMeteringArchiveResponse.md)>;` | Clear the archived repositories metering. Clear the archived repositories metering information in the cluster. || `clearRepositoriesMeteringArchive` | `clearRepositoriesMeteringArchive(this: [That](./That.md), params: [NodesClearRepositoriesMeteringArchiveRequest](./NodesClearRepositoriesMeteringArchiveRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[NodesClearRepositoriesMeteringArchiveResponse](./NodesClearRepositoriesMeteringArchiveResponse.md), unknown>>;` |   || `clearRepositoriesMeteringArchive` | `clearRepositoriesMeteringArchive(this: [That](./That.md), params: [NodesClearRepositoriesMeteringArchiveRequest](./NodesClearRepositoriesMeteringArchiveRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[NodesClearRepositoriesMeteringArchiveResponse](./NodesClearRepositoriesMeteringArchiveResponse.md)>;` |   || `getRepositoriesMeteringInfo` | `getRepositoriesMeteringInfo(this: [That](./That.md), params: [NodesGetRepositoriesMeteringInfoRequest](./NodesGetRepositoriesMeteringInfoRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[NodesGetRepositoriesMeteringInfoResponse](./NodesGetRepositoriesMeteringInfoResponse.md)>;` | Get cluster repositories metering. Get repositories metering information for a cluster. This API exposes monotonically non-decreasing counters and it is expected that clients would durably store the information needed to compute aggregations over a period of time. Additionally, the information exposed by this API is volatile, meaning that it will not be present after node restarts. || `getRepositoriesMeteringInfo` | `getRepositoriesMeteringInfo(this: [That](./That.md), params: [NodesGetRepositoriesMeteringInfoRequest](./NodesGetRepositoriesMeteringInfoRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[NodesGetRepositoriesMeteringInfoResponse](./NodesGetRepositoriesMeteringInfoResponse.md), unknown>>;` |   || `getRepositoriesMeteringInfo` | `getRepositoriesMeteringInfo(this: [That](./That.md), params: [NodesGetRepositoriesMeteringInfoRequest](./NodesGetRepositoriesMeteringInfoRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[NodesGetRepositoriesMeteringInfoResponse](./NodesGetRepositoriesMeteringInfoResponse.md)>;` |   || `hotThreads` | `hotThreads(this: [That](./That.md), params?: [NodesHotThreadsRequest](./NodesHotThreadsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[NodesHotThreadsResponse](./NodesHotThreadsResponse.md)>;` | Get the hot threads for nodes. Get a breakdown of the hot threads on each selected node in the cluster. The output is plain text with a breakdown of the top hot threads for each node. || `hotThreads` | `hotThreads(this: [That](./That.md), params?: [NodesHotThreadsRequest](./NodesHotThreadsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[NodesHotThreadsResponse](./NodesHotThreadsResponse.md), unknown>>;` |   || `hotThreads` | `hotThreads(this: [That](./That.md), params?: [NodesHotThreadsRequest](./NodesHotThreadsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[NodesHotThreadsResponse](./NodesHotThreadsResponse.md)>;` |   || `info` | `info(this: [That](./That.md), params?: [NodesInfoRequest](./NodesInfoRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[NodesInfoResponse](./NodesInfoResponse.md)>;` | Get node information. By default, the API returns all attributes and core settings for cluster nodes. || `info` | `info(this: [That](./That.md), params?: [NodesInfoRequest](./NodesInfoRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[NodesInfoResponse](./NodesInfoResponse.md), unknown>>;` |   || `info` | `info(this: [That](./That.md), params?: [NodesInfoRequest](./NodesInfoRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[NodesInfoResponse](./NodesInfoResponse.md)>;` |   || `reloadSecureSettings` | `reloadSecureSettings(this: [That](./That.md), params?: [NodesReloadSecureSettingsRequest](./NodesReloadSecureSettingsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[NodesReloadSecureSettingsResponse](./NodesReloadSecureSettingsResponse.md)>;` | Reload the keystore on nodes in the cluster. Secure settings are stored in an on-disk keystore. Certain of these settings are reloadable. That is, you can change them on disk and reload them without restarting any nodes in the cluster. When you have updated reloadable secure settings in your keystore, you can use this API to reload those settings on each node. When the Elasticsearch keystore is password protected and not simply obfuscated, you must provide the password for the keystore when you reload the secure settings. Reloading the settings for the whole cluster assumes that the keystores for all nodes are protected with the same password; this method is allowed only when inter-node communications are encrypted. Alternatively, you can reload the secure settings on each node by locally accessing the API and passing the node-specific Elasticsearch keystore password. || `reloadSecureSettings` | `reloadSecureSettings(this: [That](./That.md), params?: [NodesReloadSecureSettingsRequest](./NodesReloadSecureSettingsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[NodesReloadSecureSettingsResponse](./NodesReloadSecureSettingsResponse.md), unknown>>;` |   || `reloadSecureSettings` | `reloadSecureSettings(this: [That](./That.md), params?: [NodesReloadSecureSettingsRequest](./NodesReloadSecureSettingsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[NodesReloadSecureSettingsResponse](./NodesReloadSecureSettingsResponse.md)>;` |   || `stats` | `stats(this: [That](./That.md), params?: [NodesStatsRequest](./NodesStatsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[NodesStatsResponse](./NodesStatsResponse.md)>;` | Get node statistics. Get statistics for nodes in a cluster. By default, all stats are returned. You can limit the returned information by using metrics. || `stats` | `stats(this: [That](./That.md), params?: [NodesStatsRequest](./NodesStatsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[NodesStatsResponse](./NodesStatsResponse.md), unknown>>;` |   || `stats` | `stats(this: [That](./That.md), params?: [NodesStatsRequest](./NodesStatsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[NodesStatsResponse](./NodesStatsResponse.md)>;` |   || `usage` | `usage(this: [That](./That.md), params?: [NodesUsageRequest](./NodesUsageRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[NodesUsageResponse](./NodesUsageResponse.md)>;` | Get feature usage information. || `usage` | `usage(this: [That](./That.md), params?: [NodesUsageRequest](./NodesUsageRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[NodesUsageResponse](./NodesUsageResponse.md), unknown>>;` |   || `usage` | `usage(this: [That](./That.md), params?: [NodesUsageRequest](./NodesUsageRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[NodesUsageResponse](./NodesUsageResponse.md)>;` |   | \ No newline at end of file +| `clearRepositoriesMeteringArchive` | `clearRepositoriesMeteringArchive(this: [That](./That.md), params: [NodesClearRepositoriesMeteringArchiveRequest](./NodesClearRepositoriesMeteringArchiveRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[NodesClearRepositoriesMeteringArchiveResponse](./NodesClearRepositoriesMeteringArchiveResponse.md)>;` | Clear the archived repositories metering. Clear the archived repositories metering information in the cluster. | +| `clearRepositoriesMeteringArchive` | `clearRepositoriesMeteringArchive(this: [That](./That.md), params: [NodesClearRepositoriesMeteringArchiveRequest](./NodesClearRepositoriesMeteringArchiveRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[NodesClearRepositoriesMeteringArchiveResponse](./NodesClearRepositoriesMeteringArchiveResponse.md), unknown>>;` |   | +| `clearRepositoriesMeteringArchive` | `clearRepositoriesMeteringArchive(this: [That](./That.md), params: [NodesClearRepositoriesMeteringArchiveRequest](./NodesClearRepositoriesMeteringArchiveRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[NodesClearRepositoriesMeteringArchiveResponse](./NodesClearRepositoriesMeteringArchiveResponse.md)>;` |   | +| `getRepositoriesMeteringInfo` | `getRepositoriesMeteringInfo(this: [That](./That.md), params: [NodesGetRepositoriesMeteringInfoRequest](./NodesGetRepositoriesMeteringInfoRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[NodesGetRepositoriesMeteringInfoResponse](./NodesGetRepositoriesMeteringInfoResponse.md)>;` | Get cluster repositories metering. Get repositories metering information for a cluster. This API exposes monotonically non-decreasing counters and it is expected that clients would durably store the information needed to compute aggregations over a period of time. Additionally, the information exposed by this API is volatile, meaning that it will not be present after node restarts. | +| `getRepositoriesMeteringInfo` | `getRepositoriesMeteringInfo(this: [That](./That.md), params: [NodesGetRepositoriesMeteringInfoRequest](./NodesGetRepositoriesMeteringInfoRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[NodesGetRepositoriesMeteringInfoResponse](./NodesGetRepositoriesMeteringInfoResponse.md), unknown>>;` |   | +| `getRepositoriesMeteringInfo` | `getRepositoriesMeteringInfo(this: [That](./That.md), params: [NodesGetRepositoriesMeteringInfoRequest](./NodesGetRepositoriesMeteringInfoRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[NodesGetRepositoriesMeteringInfoResponse](./NodesGetRepositoriesMeteringInfoResponse.md)>;` |   | +| `hotThreads` | `hotThreads(this: [That](./That.md), params?: [NodesHotThreadsRequest](./NodesHotThreadsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[NodesHotThreadsResponse](./NodesHotThreadsResponse.md)>;` | Get the hot threads for nodes. Get a breakdown of the hot threads on each selected node in the cluster. The output is plain text with a breakdown of the top hot threads for each node. | +| `hotThreads` | `hotThreads(this: [That](./That.md), params?: [NodesHotThreadsRequest](./NodesHotThreadsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[NodesHotThreadsResponse](./NodesHotThreadsResponse.md), unknown>>;` |   | +| `hotThreads` | `hotThreads(this: [That](./That.md), params?: [NodesHotThreadsRequest](./NodesHotThreadsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[NodesHotThreadsResponse](./NodesHotThreadsResponse.md)>;` |   | +| `info` | `info(this: [That](./That.md), params?: [NodesInfoRequest](./NodesInfoRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[NodesInfoResponse](./NodesInfoResponse.md)>;` | Get node information. By default, the API returns all attributes and core settings for cluster nodes. | +| `info` | `info(this: [That](./That.md), params?: [NodesInfoRequest](./NodesInfoRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[NodesInfoResponse](./NodesInfoResponse.md), unknown>>;` |   | +| `info` | `info(this: [That](./That.md), params?: [NodesInfoRequest](./NodesInfoRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[NodesInfoResponse](./NodesInfoResponse.md)>;` |   | +| `reloadSecureSettings` | `reloadSecureSettings(this: [That](./That.md), params?: [NodesReloadSecureSettingsRequest](./NodesReloadSecureSettingsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[NodesReloadSecureSettingsResponse](./NodesReloadSecureSettingsResponse.md)>;` | Reload the keystore on nodes in the cluster. Secure settings are stored in an on-disk keystore. Certain of these settings are reloadable. That is, you can change them on disk and reload them without restarting any nodes in the cluster. When you have updated reloadable secure settings in your keystore, you can use this API to reload those settings on each node. When the Elasticsearch keystore is password protected and not simply obfuscated, you must provide the password for the keystore when you reload the secure settings. Reloading the settings for the whole cluster assumes that the keystores for all nodes are protected with the same password; this method is allowed only when inter-node communications are encrypted. Alternatively, you can reload the secure settings on each node by locally accessing the API and passing the node-specific Elasticsearch keystore password. | +| `reloadSecureSettings` | `reloadSecureSettings(this: [That](./That.md), params?: [NodesReloadSecureSettingsRequest](./NodesReloadSecureSettingsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[NodesReloadSecureSettingsResponse](./NodesReloadSecureSettingsResponse.md), unknown>>;` |   | +| `reloadSecureSettings` | `reloadSecureSettings(this: [That](./That.md), params?: [NodesReloadSecureSettingsRequest](./NodesReloadSecureSettingsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[NodesReloadSecureSettingsResponse](./NodesReloadSecureSettingsResponse.md)>;` |   | +| `stats` | `stats(this: [That](./That.md), params?: [NodesStatsRequest](./NodesStatsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[NodesStatsResponse](./NodesStatsResponse.md)>;` | Get node statistics. Get statistics for nodes in a cluster. By default, all stats are returned. You can limit the returned information by using metrics. | +| `stats` | `stats(this: [That](./That.md), params?: [NodesStatsRequest](./NodesStatsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[NodesStatsResponse](./NodesStatsResponse.md), unknown>>;` |   | +| `stats` | `stats(this: [That](./That.md), params?: [NodesStatsRequest](./NodesStatsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[NodesStatsResponse](./NodesStatsResponse.md)>;` |   | +| `usage` | `usage(this: [That](./That.md), params?: [NodesUsageRequest](./NodesUsageRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[NodesUsageResponse](./NodesUsageResponse.md)>;` | Get feature usage information. | +| `usage` | `usage(this: [That](./That.md), params?: [NodesUsageRequest](./NodesUsageRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[NodesUsageResponse](./NodesUsageResponse.md), unknown>>;` |   | +| `usage` | `usage(this: [That](./That.md), params?: [NodesUsageRequest](./NodesUsageRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[NodesUsageResponse](./NodesUsageResponse.md)>;` |   | diff --git a/docs/reference/api/Profiling.md b/docs/reference/api/Profiling.md index 03ce2a05a..82e4027c0 100644 --- a/docs/reference/api/Profiling.md +++ b/docs/reference/api/Profiling.md @@ -17,4 +17,15 @@ new Profiling(transport: [Transport](./Transport.md)); | Name | Signature | Description | | - | - | - | -| `flamegraph` | `flamegraph(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TODO](./TODO.md)>;` | Extracts a UI-optimized structure to render flamegraphs from Universal Profiling. || `flamegraph` | `flamegraph(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TODO](./TODO.md), unknown>>;` |   || `flamegraph` | `flamegraph(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TODO](./TODO.md)>;` |   || `stacktraces` | `stacktraces(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TODO](./TODO.md)>;` | Extracts raw stacktrace information from Universal Profiling. || `stacktraces` | `stacktraces(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TODO](./TODO.md), unknown>>;` |   || `stacktraces` | `stacktraces(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TODO](./TODO.md)>;` |   || `status` | `status(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TODO](./TODO.md)>;` | Returns basic information about the status of Universal Profiling. || `status` | `status(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TODO](./TODO.md), unknown>>;` |   || `status` | `status(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TODO](./TODO.md)>;` |   || `topnFunctions` | `topnFunctions(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TODO](./TODO.md)>;` | Extracts a list of topN functions from Universal Profiling. || `topnFunctions` | `topnFunctions(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TODO](./TODO.md), unknown>>;` |   || `topnFunctions` | `topnFunctions(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TODO](./TODO.md)>;` |   | \ No newline at end of file +| `flamegraph` | `flamegraph(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TODO](./TODO.md)>;` | Extracts a UI-optimized structure to render flamegraphs from Universal Profiling. | +| `flamegraph` | `flamegraph(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TODO](./TODO.md), unknown>>;` |   | +| `flamegraph` | `flamegraph(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TODO](./TODO.md)>;` |   | +| `stacktraces` | `stacktraces(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TODO](./TODO.md)>;` | Extracts raw stacktrace information from Universal Profiling. | +| `stacktraces` | `stacktraces(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TODO](./TODO.md), unknown>>;` |   | +| `stacktraces` | `stacktraces(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TODO](./TODO.md)>;` |   | +| `status` | `status(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TODO](./TODO.md)>;` | Returns basic information about the status of Universal Profiling. | +| `status` | `status(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TODO](./TODO.md), unknown>>;` |   | +| `status` | `status(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TODO](./TODO.md)>;` |   | +| `topnFunctions` | `topnFunctions(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TODO](./TODO.md)>;` | Extracts a list of topN functions from Universal Profiling. | +| `topnFunctions` | `topnFunctions(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TODO](./TODO.md), unknown>>;` |   | +| `topnFunctions` | `topnFunctions(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TODO](./TODO.md)>;` |   | diff --git a/docs/reference/api/QueryRules.md b/docs/reference/api/QueryRules.md index 29466905a..767c9220f 100644 --- a/docs/reference/api/QueryRules.md +++ b/docs/reference/api/QueryRules.md @@ -17,4 +17,27 @@ new QueryRules(transport: [Transport](./Transport.md)); | Name | Signature | Description | | - | - | - | -| `deleteRule` | `deleteRule(this: [That](./That.md), params: [QueryRulesDeleteRuleRequest](./QueryRulesDeleteRuleRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[QueryRulesDeleteRuleResponse](./QueryRulesDeleteRuleResponse.md)>;` | Delete a query rule. Delete a query rule within a query ruleset. This is a destructive action that is only recoverable by re-adding the same rule with the create or update query rule API. || `deleteRule` | `deleteRule(this: [That](./That.md), params: [QueryRulesDeleteRuleRequest](./QueryRulesDeleteRuleRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[QueryRulesDeleteRuleResponse](./QueryRulesDeleteRuleResponse.md), unknown>>;` |   || `deleteRule` | `deleteRule(this: [That](./That.md), params: [QueryRulesDeleteRuleRequest](./QueryRulesDeleteRuleRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[QueryRulesDeleteRuleResponse](./QueryRulesDeleteRuleResponse.md)>;` |   || `deleteRuleset` | `deleteRuleset(this: [That](./That.md), params: [QueryRulesDeleteRulesetRequest](./QueryRulesDeleteRulesetRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[QueryRulesDeleteRulesetResponse](./QueryRulesDeleteRulesetResponse.md)>;` | Delete a query ruleset. Remove a query ruleset and its associated data. This is a destructive action that is not recoverable. || `deleteRuleset` | `deleteRuleset(this: [That](./That.md), params: [QueryRulesDeleteRulesetRequest](./QueryRulesDeleteRulesetRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[QueryRulesDeleteRulesetResponse](./QueryRulesDeleteRulesetResponse.md), unknown>>;` |   || `deleteRuleset` | `deleteRuleset(this: [That](./That.md), params: [QueryRulesDeleteRulesetRequest](./QueryRulesDeleteRulesetRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[QueryRulesDeleteRulesetResponse](./QueryRulesDeleteRulesetResponse.md)>;` |   || `getRule` | `getRule(this: [That](./That.md), params: [QueryRulesGetRuleRequest](./QueryRulesGetRuleRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[QueryRulesGetRuleResponse](./QueryRulesGetRuleResponse.md)>;` | Get a query rule. Get details about a query rule within a query ruleset. || `getRule` | `getRule(this: [That](./That.md), params: [QueryRulesGetRuleRequest](./QueryRulesGetRuleRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[QueryRulesGetRuleResponse](./QueryRulesGetRuleResponse.md), unknown>>;` |   || `getRule` | `getRule(this: [That](./That.md), params: [QueryRulesGetRuleRequest](./QueryRulesGetRuleRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[QueryRulesGetRuleResponse](./QueryRulesGetRuleResponse.md)>;` |   || `getRuleset` | `getRuleset(this: [That](./That.md), params: [QueryRulesGetRulesetRequest](./QueryRulesGetRulesetRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[QueryRulesGetRulesetResponse](./QueryRulesGetRulesetResponse.md)>;` | Get a query ruleset. Get details about a query ruleset. || `getRuleset` | `getRuleset(this: [That](./That.md), params: [QueryRulesGetRulesetRequest](./QueryRulesGetRulesetRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[QueryRulesGetRulesetResponse](./QueryRulesGetRulesetResponse.md), unknown>>;` |   || `getRuleset` | `getRuleset(this: [That](./That.md), params: [QueryRulesGetRulesetRequest](./QueryRulesGetRulesetRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[QueryRulesGetRulesetResponse](./QueryRulesGetRulesetResponse.md)>;` |   || `listRulesets` | `listRulesets(this: [That](./That.md), params?: [QueryRulesListRulesetsRequest](./QueryRulesListRulesetsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[QueryRulesListRulesetsResponse](./QueryRulesListRulesetsResponse.md)>;` | Get all query rulesets. Get summarized information about the query rulesets. || `listRulesets` | `listRulesets(this: [That](./That.md), params?: [QueryRulesListRulesetsRequest](./QueryRulesListRulesetsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[QueryRulesListRulesetsResponse](./QueryRulesListRulesetsResponse.md), unknown>>;` |   || `listRulesets` | `listRulesets(this: [That](./That.md), params?: [QueryRulesListRulesetsRequest](./QueryRulesListRulesetsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[QueryRulesListRulesetsResponse](./QueryRulesListRulesetsResponse.md)>;` |   || `putRule` | `putRule(this: [That](./That.md), params: [QueryRulesPutRuleRequest](./QueryRulesPutRuleRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[QueryRulesPutRuleResponse](./QueryRulesPutRuleResponse.md)>;` | Create or update a query rule. Create or update a query rule within a query ruleset. IMPORTANT: Due to limitations within pinned queries, you can only pin documents using ids or docs, but cannot use both in single rule. It is advised to use one or the other in query rulesets, to avoid errors. Additionally, pinned queries have a maximum limit of 100 pinned hits. If multiple matching rules pin more than 100 documents, only the first 100 documents are pinned in the order they are specified in the ruleset. || `putRule` | `putRule(this: [That](./That.md), params: [QueryRulesPutRuleRequest](./QueryRulesPutRuleRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[QueryRulesPutRuleResponse](./QueryRulesPutRuleResponse.md), unknown>>;` |   || `putRule` | `putRule(this: [That](./That.md), params: [QueryRulesPutRuleRequest](./QueryRulesPutRuleRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[QueryRulesPutRuleResponse](./QueryRulesPutRuleResponse.md)>;` |   || `putRuleset` | `putRuleset(this: [That](./That.md), params: [QueryRulesPutRulesetRequest](./QueryRulesPutRulesetRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[QueryRulesPutRulesetResponse](./QueryRulesPutRulesetResponse.md)>;` | Create or update a query ruleset. There is a limit of 100 rules per ruleset. This limit can be increased by using the `xpack.applications.rules.max_rules_per_ruleset` cluster setting. IMPORTANT: Due to limitations within pinned queries, you can only select documents using `ids` or `docs`, but cannot use both in single rule. It is advised to use one or the other in query rulesets, to avoid errors. Additionally, pinned queries have a maximum limit of 100 pinned hits. If multiple matching rules pin more than 100 documents, only the first 100 documents are pinned in the order they are specified in the ruleset. || `putRuleset` | `putRuleset(this: [That](./That.md), params: [QueryRulesPutRulesetRequest](./QueryRulesPutRulesetRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[QueryRulesPutRulesetResponse](./QueryRulesPutRulesetResponse.md), unknown>>;` |   || `putRuleset` | `putRuleset(this: [That](./That.md), params: [QueryRulesPutRulesetRequest](./QueryRulesPutRulesetRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[QueryRulesPutRulesetResponse](./QueryRulesPutRulesetResponse.md)>;` |   || `test` | `test(this: [That](./That.md), params: [QueryRulesTestRequest](./QueryRulesTestRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[QueryRulesTestResponse](./QueryRulesTestResponse.md)>;` | Test a query ruleset. Evaluate match criteria against a query ruleset to identify the rules that would match that criteria. || `test` | `test(this: [That](./That.md), params: [QueryRulesTestRequest](./QueryRulesTestRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[QueryRulesTestResponse](./QueryRulesTestResponse.md), unknown>>;` |   || `test` | `test(this: [That](./That.md), params: [QueryRulesTestRequest](./QueryRulesTestRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[QueryRulesTestResponse](./QueryRulesTestResponse.md)>;` |   | \ No newline at end of file +| `deleteRule` | `deleteRule(this: [That](./That.md), params: [QueryRulesDeleteRuleRequest](./QueryRulesDeleteRuleRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[QueryRulesDeleteRuleResponse](./QueryRulesDeleteRuleResponse.md)>;` | Delete a query rule. Delete a query rule within a query ruleset. This is a destructive action that is only recoverable by re-adding the same rule with the create or update query rule API. | +| `deleteRule` | `deleteRule(this: [That](./That.md), params: [QueryRulesDeleteRuleRequest](./QueryRulesDeleteRuleRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[QueryRulesDeleteRuleResponse](./QueryRulesDeleteRuleResponse.md), unknown>>;` |   | +| `deleteRule` | `deleteRule(this: [That](./That.md), params: [QueryRulesDeleteRuleRequest](./QueryRulesDeleteRuleRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[QueryRulesDeleteRuleResponse](./QueryRulesDeleteRuleResponse.md)>;` |   | +| `deleteRuleset` | `deleteRuleset(this: [That](./That.md), params: [QueryRulesDeleteRulesetRequest](./QueryRulesDeleteRulesetRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[QueryRulesDeleteRulesetResponse](./QueryRulesDeleteRulesetResponse.md)>;` | Delete a query ruleset. Remove a query ruleset and its associated data. This is a destructive action that is not recoverable. | +| `deleteRuleset` | `deleteRuleset(this: [That](./That.md), params: [QueryRulesDeleteRulesetRequest](./QueryRulesDeleteRulesetRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[QueryRulesDeleteRulesetResponse](./QueryRulesDeleteRulesetResponse.md), unknown>>;` |   | +| `deleteRuleset` | `deleteRuleset(this: [That](./That.md), params: [QueryRulesDeleteRulesetRequest](./QueryRulesDeleteRulesetRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[QueryRulesDeleteRulesetResponse](./QueryRulesDeleteRulesetResponse.md)>;` |   | +| `getRule` | `getRule(this: [That](./That.md), params: [QueryRulesGetRuleRequest](./QueryRulesGetRuleRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[QueryRulesGetRuleResponse](./QueryRulesGetRuleResponse.md)>;` | Get a query rule. Get details about a query rule within a query ruleset. | +| `getRule` | `getRule(this: [That](./That.md), params: [QueryRulesGetRuleRequest](./QueryRulesGetRuleRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[QueryRulesGetRuleResponse](./QueryRulesGetRuleResponse.md), unknown>>;` |   | +| `getRule` | `getRule(this: [That](./That.md), params: [QueryRulesGetRuleRequest](./QueryRulesGetRuleRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[QueryRulesGetRuleResponse](./QueryRulesGetRuleResponse.md)>;` |   | +| `getRuleset` | `getRuleset(this: [That](./That.md), params: [QueryRulesGetRulesetRequest](./QueryRulesGetRulesetRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[QueryRulesGetRulesetResponse](./QueryRulesGetRulesetResponse.md)>;` | Get a query ruleset. Get details about a query ruleset. | +| `getRuleset` | `getRuleset(this: [That](./That.md), params: [QueryRulesGetRulesetRequest](./QueryRulesGetRulesetRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[QueryRulesGetRulesetResponse](./QueryRulesGetRulesetResponse.md), unknown>>;` |   | +| `getRuleset` | `getRuleset(this: [That](./That.md), params: [QueryRulesGetRulesetRequest](./QueryRulesGetRulesetRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[QueryRulesGetRulesetResponse](./QueryRulesGetRulesetResponse.md)>;` |   | +| `listRulesets` | `listRulesets(this: [That](./That.md), params?: [QueryRulesListRulesetsRequest](./QueryRulesListRulesetsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[QueryRulesListRulesetsResponse](./QueryRulesListRulesetsResponse.md)>;` | Get all query rulesets. Get summarized information about the query rulesets. | +| `listRulesets` | `listRulesets(this: [That](./That.md), params?: [QueryRulesListRulesetsRequest](./QueryRulesListRulesetsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[QueryRulesListRulesetsResponse](./QueryRulesListRulesetsResponse.md), unknown>>;` |   | +| `listRulesets` | `listRulesets(this: [That](./That.md), params?: [QueryRulesListRulesetsRequest](./QueryRulesListRulesetsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[QueryRulesListRulesetsResponse](./QueryRulesListRulesetsResponse.md)>;` |   | +| `putRule` | `putRule(this: [That](./That.md), params: [QueryRulesPutRuleRequest](./QueryRulesPutRuleRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[QueryRulesPutRuleResponse](./QueryRulesPutRuleResponse.md)>;` | Create or update a query rule. Create or update a query rule within a query ruleset. IMPORTANT: Due to limitations within pinned queries, you can only pin documents using ids or docs, but cannot use both in single rule. It is advised to use one or the other in query rulesets, to avoid errors. Additionally, pinned queries have a maximum limit of 100 pinned hits. If multiple matching rules pin more than 100 documents, only the first 100 documents are pinned in the order they are specified in the ruleset. | +| `putRule` | `putRule(this: [That](./That.md), params: [QueryRulesPutRuleRequest](./QueryRulesPutRuleRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[QueryRulesPutRuleResponse](./QueryRulesPutRuleResponse.md), unknown>>;` |   | +| `putRule` | `putRule(this: [That](./That.md), params: [QueryRulesPutRuleRequest](./QueryRulesPutRuleRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[QueryRulesPutRuleResponse](./QueryRulesPutRuleResponse.md)>;` |   | +| `putRuleset` | `putRuleset(this: [That](./That.md), params: [QueryRulesPutRulesetRequest](./QueryRulesPutRulesetRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[QueryRulesPutRulesetResponse](./QueryRulesPutRulesetResponse.md)>;` | Create or update a query ruleset. There is a limit of 100 rules per ruleset. This limit can be increased by using the `xpack.applications.rules.max_rules_per_ruleset` cluster setting. IMPORTANT: Due to limitations within pinned queries, you can only select documents using `ids` or `docs`, but cannot use both in single rule. It is advised to use one or the other in query rulesets, to avoid errors. Additionally, pinned queries have a maximum limit of 100 pinned hits. If multiple matching rules pin more than 100 documents, only the first 100 documents are pinned in the order they are specified in the ruleset. | +| `putRuleset` | `putRuleset(this: [That](./That.md), params: [QueryRulesPutRulesetRequest](./QueryRulesPutRulesetRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[QueryRulesPutRulesetResponse](./QueryRulesPutRulesetResponse.md), unknown>>;` |   | +| `putRuleset` | `putRuleset(this: [That](./That.md), params: [QueryRulesPutRulesetRequest](./QueryRulesPutRulesetRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[QueryRulesPutRulesetResponse](./QueryRulesPutRulesetResponse.md)>;` |   | +| `test` | `test(this: [That](./That.md), params: [QueryRulesTestRequest](./QueryRulesTestRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[QueryRulesTestResponse](./QueryRulesTestResponse.md)>;` | Test a query ruleset. Evaluate match criteria against a query ruleset to identify the rules that would match that criteria. | +| `test` | `test(this: [That](./That.md), params: [QueryRulesTestRequest](./QueryRulesTestRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[QueryRulesTestResponse](./QueryRulesTestResponse.md), unknown>>;` |   | +| `test` | `test(this: [That](./That.md), params: [QueryRulesTestRequest](./QueryRulesTestRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[QueryRulesTestResponse](./QueryRulesTestResponse.md)>;` |   | diff --git a/docs/reference/api/Rollup.md b/docs/reference/api/Rollup.md index 8768f048e..7ebedc3e7 100644 --- a/docs/reference/api/Rollup.md +++ b/docs/reference/api/Rollup.md @@ -17,4 +17,27 @@ new Rollup(transport: [Transport](./Transport.md)); | Name | Signature | Description | | - | - | - | -| `deleteJob` | `deleteJob(this: [That](./That.md), params: [RollupDeleteJobRequest](./RollupDeleteJobRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[RollupDeleteJobResponse](./RollupDeleteJobResponse.md)>;` | Delete a rollup job. A job must be stopped before it can be deleted. If you attempt to delete a started job, an error occurs. Similarly, if you attempt to delete a nonexistent job, an exception occurs. IMPORTANT: When you delete a job, you remove only the process that is actively monitoring and rolling up data. The API does not delete any previously rolled up data. This is by design; a user may wish to roll up a static data set. Because the data set is static, after it has been fully rolled up there is no need to keep the indexing rollup job around (as there will be no new data). Thus the job can be deleted, leaving behind the rolled up data for analysis. If you wish to also remove the rollup data and the rollup index contains the data for only a single job, you can delete the whole rollup index. If the rollup index stores data from several jobs, you must issue a delete-by-query that targets the rollup job's identifier in the rollup index. For example: ``` POST my_rollup_index/_delete_by_query { "query": { "term": { "_rollup.id": "the_rollup_job_id" } } } ``` || `deleteJob` | `deleteJob(this: [That](./That.md), params: [RollupDeleteJobRequest](./RollupDeleteJobRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[RollupDeleteJobResponse](./RollupDeleteJobResponse.md), unknown>>;` |   || `deleteJob` | `deleteJob(this: [That](./That.md), params: [RollupDeleteJobRequest](./RollupDeleteJobRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[RollupDeleteJobResponse](./RollupDeleteJobResponse.md)>;` |   || `getJobs` | `getJobs(this: [That](./That.md), params?: [RollupGetJobsRequest](./RollupGetJobsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[RollupGetJobsResponse](./RollupGetJobsResponse.md)>;` | Get rollup job information. Get the configuration, stats, and status of rollup jobs. NOTE: This API returns only active (both `STARTED` and `STOPPED`) jobs. If a job was created, ran for a while, then was deleted, the API does not return any details about it. For details about a historical rollup job, the rollup capabilities API may be more useful. || `getJobs` | `getJobs(this: [That](./That.md), params?: [RollupGetJobsRequest](./RollupGetJobsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[RollupGetJobsResponse](./RollupGetJobsResponse.md), unknown>>;` |   || `getJobs` | `getJobs(this: [That](./That.md), params?: [RollupGetJobsRequest](./RollupGetJobsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[RollupGetJobsResponse](./RollupGetJobsResponse.md)>;` |   || `getRollupCaps` | `getRollupCaps(this: [That](./That.md), params?: [RollupGetRollupCapsRequest](./RollupGetRollupCapsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[RollupGetRollupCapsResponse](./RollupGetRollupCapsResponse.md)>;` | Get the rollup job capabilities. Get the capabilities of any rollup jobs that have been configured for a specific index or index pattern. This API is useful because a rollup job is often configured to rollup only a subset of fields from the source index. Furthermore, only certain aggregations can be configured for various fields, leading to a limited subset of functionality depending on that configuration. This API enables you to inspect an index and determine: 1. Does this index have associated rollup data somewhere in the cluster? 2. If yes to the first question, what fields were rolled up, what aggregations can be performed, and where does the data live? || `getRollupCaps` | `getRollupCaps(this: [That](./That.md), params?: [RollupGetRollupCapsRequest](./RollupGetRollupCapsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[RollupGetRollupCapsResponse](./RollupGetRollupCapsResponse.md), unknown>>;` |   || `getRollupCaps` | `getRollupCaps(this: [That](./That.md), params?: [RollupGetRollupCapsRequest](./RollupGetRollupCapsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[RollupGetRollupCapsResponse](./RollupGetRollupCapsResponse.md)>;` |   || `getRollupIndexCaps` | `getRollupIndexCaps(this: [That](./That.md), params: [RollupGetRollupIndexCapsRequest](./RollupGetRollupIndexCapsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[RollupGetRollupIndexCapsResponse](./RollupGetRollupIndexCapsResponse.md)>;` | Get the rollup index capabilities. Get the rollup capabilities of all jobs inside of a rollup index. A single rollup index may store the data for multiple rollup jobs and may have a variety of capabilities depending on those jobs. This API enables you to determine: * What jobs are stored in an index (or indices specified via a pattern)? * What target indices were rolled up, what fields were used in those rollups, and what aggregations can be performed on each job? || `getRollupIndexCaps` | `getRollupIndexCaps(this: [That](./That.md), params: [RollupGetRollupIndexCapsRequest](./RollupGetRollupIndexCapsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[RollupGetRollupIndexCapsResponse](./RollupGetRollupIndexCapsResponse.md), unknown>>;` |   || `getRollupIndexCaps` | `getRollupIndexCaps(this: [That](./That.md), params: [RollupGetRollupIndexCapsRequest](./RollupGetRollupIndexCapsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[RollupGetRollupIndexCapsResponse](./RollupGetRollupIndexCapsResponse.md)>;` |   || `putJob` | `putJob(this: [That](./That.md), params: [RollupPutJobRequest](./RollupPutJobRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[RollupPutJobResponse](./RollupPutJobResponse.md)>;` | Create a rollup job. WARNING: From 8.15.0, calling this API in a cluster with no rollup usage will fail with a message about the deprecation and planned removal of rollup features. A cluster needs to contain either a rollup job or a rollup index in order for this API to be allowed to run. The rollup job configuration contains all the details about how the job should run, when it indexes documents, and what future queries will be able to run against the rollup index. There are three main sections to the job configuration: the logistical details about the job (for example, the cron schedule), the fields that are used for grouping, and what metrics to collect for each group. Jobs are created in a `STOPPED` state. You can start them with the start rollup jobs API. || `putJob` | `putJob(this: [That](./That.md), params: [RollupPutJobRequest](./RollupPutJobRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[RollupPutJobResponse](./RollupPutJobResponse.md), unknown>>;` |   || `putJob` | `putJob(this: [That](./That.md), params: [RollupPutJobRequest](./RollupPutJobRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[RollupPutJobResponse](./RollupPutJobResponse.md)>;` |   || `rollupSearch` | `rollupSearch>(this: [That](./That.md), params: [RollupRollupSearchRequest](./RollupRollupSearchRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[RollupRollupSearchResponse](./RollupRollupSearchResponse.md)>;` | Search rolled-up data. The rollup search endpoint is needed because, internally, rolled-up documents utilize a different document structure than the original data. It rewrites standard Query DSL into a format that matches the rollup documents then takes the response and rewrites it back to what a client would expect given the original query. The request body supports a subset of features from the regular search API. The following functionality is not available: `size`: Because rollups work on pre-aggregated data, no search hits can be returned and so size must be set to zero or omitted entirely. `highlighter`, `suggestors`, `post_filter`, `profile`, `explain`: These are similarly disallowed. **Searching both historical rollup and non-rollup data** The rollup search API has the capability to search across both "live" non-rollup data and the aggregated rollup data. This is done by simply adding the live indices to the URI. For example: ``` GET sensor-1,sensor_rollup/_rollup_search { "size": 0, "aggregations": { "max_temperature": { "max": { "field": "temperature" } } } } ``` The rollup search endpoint does two things when the search runs: * The original request is sent to the non-rollup index unaltered. * A rewritten version of the original request is sent to the rollup index. When the two responses are received, the endpoint rewrites the rollup response and merges the two together. During the merging process, if there is any overlap in buckets between the two responses, the buckets from the non-rollup index are used. || `rollupSearch` | `rollupSearch>(this: [That](./That.md), params: [RollupRollupSearchRequest](./RollupRollupSearchRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[RollupRollupSearchResponse](./RollupRollupSearchResponse.md), unknown>>;` |   || `rollupSearch` | `rollupSearch>(this: [That](./That.md), params: [RollupRollupSearchRequest](./RollupRollupSearchRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[RollupRollupSearchResponse](./RollupRollupSearchResponse.md)>;` |   || `startJob` | `startJob(this: [That](./That.md), params: [RollupStartJobRequest](./RollupStartJobRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[RollupStartJobResponse](./RollupStartJobResponse.md)>;` | Start rollup jobs. If you try to start a job that does not exist, an exception occurs. If you try to start a job that is already started, nothing happens. || `startJob` | `startJob(this: [That](./That.md), params: [RollupStartJobRequest](./RollupStartJobRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[RollupStartJobResponse](./RollupStartJobResponse.md), unknown>>;` |   || `startJob` | `startJob(this: [That](./That.md), params: [RollupStartJobRequest](./RollupStartJobRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[RollupStartJobResponse](./RollupStartJobResponse.md)>;` |   || `stopJob` | `stopJob(this: [That](./That.md), params: [RollupStopJobRequest](./RollupStopJobRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[RollupStopJobResponse](./RollupStopJobResponse.md)>;` | Stop rollup jobs. If you try to stop a job that does not exist, an exception occurs. If you try to stop a job that is already stopped, nothing happens. Since only a stopped job can be deleted, it can be useful to block the API until the indexer has fully stopped. This is accomplished with the `wait_for_completion` query parameter, and optionally a timeout. For example: ``` POST _rollup/job/sensor/_stop?wait_for_completion=true&timeout=10s ``` The parameter blocks the API call from returning until either the job has moved to STOPPED or the specified time has elapsed. If the specified time elapses without the job moving to STOPPED, a timeout exception occurs. || `stopJob` | `stopJob(this: [That](./That.md), params: [RollupStopJobRequest](./RollupStopJobRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[RollupStopJobResponse](./RollupStopJobResponse.md), unknown>>;` |   || `stopJob` | `stopJob(this: [That](./That.md), params: [RollupStopJobRequest](./RollupStopJobRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[RollupStopJobResponse](./RollupStopJobResponse.md)>;` |   | \ No newline at end of file +| `deleteJob` | `deleteJob(this: [That](./That.md), params: [RollupDeleteJobRequest](./RollupDeleteJobRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[RollupDeleteJobResponse](./RollupDeleteJobResponse.md)>;` | Delete a rollup job. A job must be stopped before it can be deleted. If you attempt to delete a started job, an error occurs. Similarly, if you attempt to delete a nonexistent job, an exception occurs. IMPORTANT: When you delete a job, you remove only the process that is actively monitoring and rolling up data. The API does not delete any previously rolled up data. This is by design; a user may wish to roll up a static data set. Because the data set is static, after it has been fully rolled up there is no need to keep the indexing rollup job around (as there will be no new data). Thus the job can be deleted, leaving behind the rolled up data for analysis. If you wish to also remove the rollup data and the rollup index contains the data for only a single job, you can delete the whole rollup index. If the rollup index stores data from several jobs, you must issue a delete-by-query that targets the rollup job's identifier in the rollup index. For example: ``` POST my_rollup_index/_delete_by_query { "query": { "term": { "_rollup.id": "the_rollup_job_id" } } } ``` | +| `deleteJob` | `deleteJob(this: [That](./That.md), params: [RollupDeleteJobRequest](./RollupDeleteJobRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[RollupDeleteJobResponse](./RollupDeleteJobResponse.md), unknown>>;` |   | +| `deleteJob` | `deleteJob(this: [That](./That.md), params: [RollupDeleteJobRequest](./RollupDeleteJobRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[RollupDeleteJobResponse](./RollupDeleteJobResponse.md)>;` |   | +| `getJobs` | `getJobs(this: [That](./That.md), params?: [RollupGetJobsRequest](./RollupGetJobsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[RollupGetJobsResponse](./RollupGetJobsResponse.md)>;` | Get rollup job information. Get the configuration, stats, and status of rollup jobs. NOTE: This API returns only active (both `STARTED` and `STOPPED`) jobs. If a job was created, ran for a while, then was deleted, the API does not return any details about it. For details about a historical rollup job, the rollup capabilities API may be more useful. | +| `getJobs` | `getJobs(this: [That](./That.md), params?: [RollupGetJobsRequest](./RollupGetJobsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[RollupGetJobsResponse](./RollupGetJobsResponse.md), unknown>>;` |   | +| `getJobs` | `getJobs(this: [That](./That.md), params?: [RollupGetJobsRequest](./RollupGetJobsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[RollupGetJobsResponse](./RollupGetJobsResponse.md)>;` |   | +| `getRollupCaps` | `getRollupCaps(this: [That](./That.md), params?: [RollupGetRollupCapsRequest](./RollupGetRollupCapsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[RollupGetRollupCapsResponse](./RollupGetRollupCapsResponse.md)>;` | Get the rollup job capabilities. Get the capabilities of any rollup jobs that have been configured for a specific index or index pattern. This API is useful because a rollup job is often configured to rollup only a subset of fields from the source index. Furthermore, only certain aggregations can be configured for various fields, leading to a limited subset of functionality depending on that configuration. This API enables you to inspect an index and determine: 1. Does this index have associated rollup data somewhere in the cluster? 2. If yes to the first question, what fields were rolled up, what aggregations can be performed, and where does the data live? | +| `getRollupCaps` | `getRollupCaps(this: [That](./That.md), params?: [RollupGetRollupCapsRequest](./RollupGetRollupCapsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[RollupGetRollupCapsResponse](./RollupGetRollupCapsResponse.md), unknown>>;` |   | +| `getRollupCaps` | `getRollupCaps(this: [That](./That.md), params?: [RollupGetRollupCapsRequest](./RollupGetRollupCapsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[RollupGetRollupCapsResponse](./RollupGetRollupCapsResponse.md)>;` |   | +| `getRollupIndexCaps` | `getRollupIndexCaps(this: [That](./That.md), params: [RollupGetRollupIndexCapsRequest](./RollupGetRollupIndexCapsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[RollupGetRollupIndexCapsResponse](./RollupGetRollupIndexCapsResponse.md)>;` | Get the rollup index capabilities. Get the rollup capabilities of all jobs inside of a rollup index. A single rollup index may store the data for multiple rollup jobs and may have a variety of capabilities depending on those jobs. This API enables you to determine: * What jobs are stored in an index (or indices specified via a pattern)? * What target indices were rolled up, what fields were used in those rollups, and what aggregations can be performed on each job? | +| `getRollupIndexCaps` | `getRollupIndexCaps(this: [That](./That.md), params: [RollupGetRollupIndexCapsRequest](./RollupGetRollupIndexCapsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[RollupGetRollupIndexCapsResponse](./RollupGetRollupIndexCapsResponse.md), unknown>>;` |   | +| `getRollupIndexCaps` | `getRollupIndexCaps(this: [That](./That.md), params: [RollupGetRollupIndexCapsRequest](./RollupGetRollupIndexCapsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[RollupGetRollupIndexCapsResponse](./RollupGetRollupIndexCapsResponse.md)>;` |   | +| `putJob` | `putJob(this: [That](./That.md), params: [RollupPutJobRequest](./RollupPutJobRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[RollupPutJobResponse](./RollupPutJobResponse.md)>;` | Create a rollup job. WARNING: From 8.15.0, calling this API in a cluster with no rollup usage will fail with a message about the deprecation and planned removal of rollup features. A cluster needs to contain either a rollup job or a rollup index in order for this API to be allowed to run. The rollup job configuration contains all the details about how the job should run, when it indexes documents, and what future queries will be able to run against the rollup index. There are three main sections to the job configuration: the logistical details about the job (for example, the cron schedule), the fields that are used for grouping, and what metrics to collect for each group. Jobs are created in a `STOPPED` state. You can start them with the start rollup jobs API. | +| `putJob` | `putJob(this: [That](./That.md), params: [RollupPutJobRequest](./RollupPutJobRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[RollupPutJobResponse](./RollupPutJobResponse.md), unknown>>;` |   | +| `putJob` | `putJob(this: [That](./That.md), params: [RollupPutJobRequest](./RollupPutJobRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[RollupPutJobResponse](./RollupPutJobResponse.md)>;` |   | +| `rollupSearch` | `rollupSearch>(this: [That](./That.md), params: [RollupRollupSearchRequest](./RollupRollupSearchRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[RollupRollupSearchResponse](./RollupRollupSearchResponse.md)>;` | Search rolled-up data. The rollup search endpoint is needed because, internally, rolled-up documents utilize a different document structure than the original data. It rewrites standard Query DSL into a format that matches the rollup documents then takes the response and rewrites it back to what a client would expect given the original query. The request body supports a subset of features from the regular search API. The following functionality is not available: `size`: Because rollups work on pre-aggregated data, no search hits can be returned and so size must be set to zero or omitted entirely. `highlighter`, `suggestors`, `post_filter`, `profile`, `explain`: These are similarly disallowed. **Searching both historical rollup and non-rollup data** The rollup search API has the capability to search across both "live" non-rollup data and the aggregated rollup data. This is done by simply adding the live indices to the URI. For example: ``` GET sensor-1,sensor_rollup/_rollup_search { "size": 0, "aggregations": { "max_temperature": { "max": { "field": "temperature" } } } } ``` The rollup search endpoint does two things when the search runs: * The original request is sent to the non-rollup index unaltered. * A rewritten version of the original request is sent to the rollup index. When the two responses are received, the endpoint rewrites the rollup response and merges the two together. During the merging process, if there is any overlap in buckets between the two responses, the buckets from the non-rollup index are used. | +| `rollupSearch` | `rollupSearch>(this: [That](./That.md), params: [RollupRollupSearchRequest](./RollupRollupSearchRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[RollupRollupSearchResponse](./RollupRollupSearchResponse.md), unknown>>;` |   | +| `rollupSearch` | `rollupSearch>(this: [That](./That.md), params: [RollupRollupSearchRequest](./RollupRollupSearchRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[RollupRollupSearchResponse](./RollupRollupSearchResponse.md)>;` |   | +| `startJob` | `startJob(this: [That](./That.md), params: [RollupStartJobRequest](./RollupStartJobRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[RollupStartJobResponse](./RollupStartJobResponse.md)>;` | Start rollup jobs. If you try to start a job that does not exist, an exception occurs. If you try to start a job that is already started, nothing happens. | +| `startJob` | `startJob(this: [That](./That.md), params: [RollupStartJobRequest](./RollupStartJobRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[RollupStartJobResponse](./RollupStartJobResponse.md), unknown>>;` |   | +| `startJob` | `startJob(this: [That](./That.md), params: [RollupStartJobRequest](./RollupStartJobRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[RollupStartJobResponse](./RollupStartJobResponse.md)>;` |   | +| `stopJob` | `stopJob(this: [That](./That.md), params: [RollupStopJobRequest](./RollupStopJobRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[RollupStopJobResponse](./RollupStopJobResponse.md)>;` | Stop rollup jobs. If you try to stop a job that does not exist, an exception occurs. If you try to stop a job that is already stopped, nothing happens. Since only a stopped job can be deleted, it can be useful to block the API until the indexer has fully stopped. This is accomplished with the `wait_for_completion` query parameter, and optionally a timeout. For example: ``` POST _rollup/job/sensor/_stop?wait_for_completion=true&timeout=10s ``` The parameter blocks the API call from returning until either the job has moved to STOPPED or the specified time has elapsed. If the specified time elapses without the job moving to STOPPED, a timeout exception occurs. | +| `stopJob` | `stopJob(this: [That](./That.md), params: [RollupStopJobRequest](./RollupStopJobRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[RollupStopJobResponse](./RollupStopJobResponse.md), unknown>>;` |   | +| `stopJob` | `stopJob(this: [That](./That.md), params: [RollupStopJobRequest](./RollupStopJobRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[RollupStopJobResponse](./RollupStopJobResponse.md)>;` |   | diff --git a/docs/reference/api/SearchApplication.md b/docs/reference/api/SearchApplication.md index 6ba363b3b..e0a0e8e0f 100644 --- a/docs/reference/api/SearchApplication.md +++ b/docs/reference/api/SearchApplication.md @@ -17,4 +17,33 @@ new SearchApplication(transport: [Transport](./Transport.md)); | Name | Signature | Description | | - | - | - | -| `delete` | `delete(this: [That](./That.md), params: [SearchApplicationDeleteRequest](./SearchApplicationDeleteRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SearchApplicationDeleteResponse](./SearchApplicationDeleteResponse.md)>;` | Delete a search application. Remove a search application and its associated alias. Indices attached to the search application are not removed. || `delete` | `delete(this: [That](./That.md), params: [SearchApplicationDeleteRequest](./SearchApplicationDeleteRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SearchApplicationDeleteResponse](./SearchApplicationDeleteResponse.md), unknown>>;` |   || `delete` | `delete(this: [That](./That.md), params: [SearchApplicationDeleteRequest](./SearchApplicationDeleteRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SearchApplicationDeleteResponse](./SearchApplicationDeleteResponse.md)>;` |   || `deleteBehavioralAnalytics` | `deleteBehavioralAnalytics(this: [That](./That.md), params: [SearchApplicationDeleteBehavioralAnalyticsRequest](./SearchApplicationDeleteBehavioralAnalyticsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SearchApplicationDeleteBehavioralAnalyticsResponse](./SearchApplicationDeleteBehavioralAnalyticsResponse.md)>;` | Delete a behavioral analytics collection. The associated data stream is also deleted. || `deleteBehavioralAnalytics` | `deleteBehavioralAnalytics(this: [That](./That.md), params: [SearchApplicationDeleteBehavioralAnalyticsRequest](./SearchApplicationDeleteBehavioralAnalyticsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SearchApplicationDeleteBehavioralAnalyticsResponse](./SearchApplicationDeleteBehavioralAnalyticsResponse.md), unknown>>;` |   || `deleteBehavioralAnalytics` | `deleteBehavioralAnalytics(this: [That](./That.md), params: [SearchApplicationDeleteBehavioralAnalyticsRequest](./SearchApplicationDeleteBehavioralAnalyticsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SearchApplicationDeleteBehavioralAnalyticsResponse](./SearchApplicationDeleteBehavioralAnalyticsResponse.md)>;` |   || `get` | `get(this: [That](./That.md), params: [SearchApplicationGetRequest](./SearchApplicationGetRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SearchApplicationGetResponse](./SearchApplicationGetResponse.md)>;` | Get search application details. || `get` | `get(this: [That](./That.md), params: [SearchApplicationGetRequest](./SearchApplicationGetRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SearchApplicationGetResponse](./SearchApplicationGetResponse.md), unknown>>;` |   || `get` | `get(this: [That](./That.md), params: [SearchApplicationGetRequest](./SearchApplicationGetRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SearchApplicationGetResponse](./SearchApplicationGetResponse.md)>;` |   || `getBehavioralAnalytics` | `getBehavioralAnalytics(this: [That](./That.md), params?: [SearchApplicationGetBehavioralAnalyticsRequest](./SearchApplicationGetBehavioralAnalyticsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SearchApplicationGetBehavioralAnalyticsResponse](./SearchApplicationGetBehavioralAnalyticsResponse.md)>;` | Get behavioral analytics collections. || `getBehavioralAnalytics` | `getBehavioralAnalytics(this: [That](./That.md), params?: [SearchApplicationGetBehavioralAnalyticsRequest](./SearchApplicationGetBehavioralAnalyticsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SearchApplicationGetBehavioralAnalyticsResponse](./SearchApplicationGetBehavioralAnalyticsResponse.md), unknown>>;` |   || `getBehavioralAnalytics` | `getBehavioralAnalytics(this: [That](./That.md), params?: [SearchApplicationGetBehavioralAnalyticsRequest](./SearchApplicationGetBehavioralAnalyticsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SearchApplicationGetBehavioralAnalyticsResponse](./SearchApplicationGetBehavioralAnalyticsResponse.md)>;` |   || `list` | `list(this: [That](./That.md), params?: [SearchApplicationListRequest](./SearchApplicationListRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SearchApplicationListResponse](./SearchApplicationListResponse.md)>;` | Get search applications. Get information about search applications. || `list` | `list(this: [That](./That.md), params?: [SearchApplicationListRequest](./SearchApplicationListRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SearchApplicationListResponse](./SearchApplicationListResponse.md), unknown>>;` |   || `list` | `list(this: [That](./That.md), params?: [SearchApplicationListRequest](./SearchApplicationListRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SearchApplicationListResponse](./SearchApplicationListResponse.md)>;` |   || `postBehavioralAnalyticsEvent` | `postBehavioralAnalyticsEvent(this: [That](./That.md), params: [SearchApplicationPostBehavioralAnalyticsEventRequest](./SearchApplicationPostBehavioralAnalyticsEventRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SearchApplicationPostBehavioralAnalyticsEventResponse](./SearchApplicationPostBehavioralAnalyticsEventResponse.md)>;` | Create a behavioral analytics collection event. || `postBehavioralAnalyticsEvent` | `postBehavioralAnalyticsEvent(this: [That](./That.md), params: [SearchApplicationPostBehavioralAnalyticsEventRequest](./SearchApplicationPostBehavioralAnalyticsEventRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SearchApplicationPostBehavioralAnalyticsEventResponse](./SearchApplicationPostBehavioralAnalyticsEventResponse.md), unknown>>;` |   || `postBehavioralAnalyticsEvent` | `postBehavioralAnalyticsEvent(this: [That](./That.md), params: [SearchApplicationPostBehavioralAnalyticsEventRequest](./SearchApplicationPostBehavioralAnalyticsEventRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SearchApplicationPostBehavioralAnalyticsEventResponse](./SearchApplicationPostBehavioralAnalyticsEventResponse.md)>;` |   || `put` | `put(this: [That](./That.md), params: [SearchApplicationPutRequest](./SearchApplicationPutRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SearchApplicationPutResponse](./SearchApplicationPutResponse.md)>;` | Create or update a search application. || `put` | `put(this: [That](./That.md), params: [SearchApplicationPutRequest](./SearchApplicationPutRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SearchApplicationPutResponse](./SearchApplicationPutResponse.md), unknown>>;` |   || `put` | `put(this: [That](./That.md), params: [SearchApplicationPutRequest](./SearchApplicationPutRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SearchApplicationPutResponse](./SearchApplicationPutResponse.md)>;` |   || `putBehavioralAnalytics` | `putBehavioralAnalytics(this: [That](./That.md), params: [SearchApplicationPutBehavioralAnalyticsRequest](./SearchApplicationPutBehavioralAnalyticsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SearchApplicationPutBehavioralAnalyticsResponse](./SearchApplicationPutBehavioralAnalyticsResponse.md)>;` | Create a behavioral analytics collection. || `putBehavioralAnalytics` | `putBehavioralAnalytics(this: [That](./That.md), params: [SearchApplicationPutBehavioralAnalyticsRequest](./SearchApplicationPutBehavioralAnalyticsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SearchApplicationPutBehavioralAnalyticsResponse](./SearchApplicationPutBehavioralAnalyticsResponse.md), unknown>>;` |   || `putBehavioralAnalytics` | `putBehavioralAnalytics(this: [That](./That.md), params: [SearchApplicationPutBehavioralAnalyticsRequest](./SearchApplicationPutBehavioralAnalyticsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SearchApplicationPutBehavioralAnalyticsResponse](./SearchApplicationPutBehavioralAnalyticsResponse.md)>;` |   || `renderQuery` | `renderQuery(this: [That](./That.md), params: [SearchApplicationRenderQueryRequest](./SearchApplicationRenderQueryRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SearchApplicationRenderQueryResponse](./SearchApplicationRenderQueryResponse.md)>;` | Render a search application query. Generate an Elasticsearch query using the specified query parameters and the search template associated with the search application or a default template if none is specified. If a parameter used in the search template is not specified in `params`, the parameter's default value will be used. The API returns the specific Elasticsearch query that would be generated and run by calling the search application search API. You must have `read` privileges on the backing alias of the search application. || `renderQuery` | `renderQuery(this: [That](./That.md), params: [SearchApplicationRenderQueryRequest](./SearchApplicationRenderQueryRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SearchApplicationRenderQueryResponse](./SearchApplicationRenderQueryResponse.md), unknown>>;` |   || `renderQuery` | `renderQuery(this: [That](./That.md), params: [SearchApplicationRenderQueryRequest](./SearchApplicationRenderQueryRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SearchApplicationRenderQueryResponse](./SearchApplicationRenderQueryResponse.md)>;` |   || `search` | `search>(this: [That](./That.md), params: [SearchApplicationSearchRequest](./SearchApplicationSearchRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SearchApplicationSearchResponse](./SearchApplicationSearchResponse.md)>;` | Run a search application search. Generate and run an Elasticsearch query that uses the specified query parameteter and the search template associated with the search application or default template. Unspecified template parameters are assigned their default values if applicable. || `search` | `search>(this: [That](./That.md), params: [SearchApplicationSearchRequest](./SearchApplicationSearchRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SearchApplicationSearchResponse](./SearchApplicationSearchResponse.md), unknown>>;` |   || `search` | `search>(this: [That](./That.md), params: [SearchApplicationSearchRequest](./SearchApplicationSearchRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SearchApplicationSearchResponse](./SearchApplicationSearchResponse.md)>;` |   | \ No newline at end of file +| `delete` | `delete(this: [That](./That.md), params: [SearchApplicationDeleteRequest](./SearchApplicationDeleteRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SearchApplicationDeleteResponse](./SearchApplicationDeleteResponse.md)>;` | Delete a search application. Remove a search application and its associated alias. Indices attached to the search application are not removed. | +| `delete` | `delete(this: [That](./That.md), params: [SearchApplicationDeleteRequest](./SearchApplicationDeleteRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SearchApplicationDeleteResponse](./SearchApplicationDeleteResponse.md), unknown>>;` |   | +| `delete` | `delete(this: [That](./That.md), params: [SearchApplicationDeleteRequest](./SearchApplicationDeleteRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SearchApplicationDeleteResponse](./SearchApplicationDeleteResponse.md)>;` |   | +| `deleteBehavioralAnalytics` | `deleteBehavioralAnalytics(this: [That](./That.md), params: [SearchApplicationDeleteBehavioralAnalyticsRequest](./SearchApplicationDeleteBehavioralAnalyticsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SearchApplicationDeleteBehavioralAnalyticsResponse](./SearchApplicationDeleteBehavioralAnalyticsResponse.md)>;` | Delete a behavioral analytics collection. The associated data stream is also deleted. | +| `deleteBehavioralAnalytics` | `deleteBehavioralAnalytics(this: [That](./That.md), params: [SearchApplicationDeleteBehavioralAnalyticsRequest](./SearchApplicationDeleteBehavioralAnalyticsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SearchApplicationDeleteBehavioralAnalyticsResponse](./SearchApplicationDeleteBehavioralAnalyticsResponse.md), unknown>>;` |   | +| `deleteBehavioralAnalytics` | `deleteBehavioralAnalytics(this: [That](./That.md), params: [SearchApplicationDeleteBehavioralAnalyticsRequest](./SearchApplicationDeleteBehavioralAnalyticsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SearchApplicationDeleteBehavioralAnalyticsResponse](./SearchApplicationDeleteBehavioralAnalyticsResponse.md)>;` |   | +| `get` | `get(this: [That](./That.md), params: [SearchApplicationGetRequest](./SearchApplicationGetRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SearchApplicationGetResponse](./SearchApplicationGetResponse.md)>;` | Get search application details. | +| `get` | `get(this: [That](./That.md), params: [SearchApplicationGetRequest](./SearchApplicationGetRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SearchApplicationGetResponse](./SearchApplicationGetResponse.md), unknown>>;` |   | +| `get` | `get(this: [That](./That.md), params: [SearchApplicationGetRequest](./SearchApplicationGetRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SearchApplicationGetResponse](./SearchApplicationGetResponse.md)>;` |   | +| `getBehavioralAnalytics` | `getBehavioralAnalytics(this: [That](./That.md), params?: [SearchApplicationGetBehavioralAnalyticsRequest](./SearchApplicationGetBehavioralAnalyticsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SearchApplicationGetBehavioralAnalyticsResponse](./SearchApplicationGetBehavioralAnalyticsResponse.md)>;` | Get behavioral analytics collections. | +| `getBehavioralAnalytics` | `getBehavioralAnalytics(this: [That](./That.md), params?: [SearchApplicationGetBehavioralAnalyticsRequest](./SearchApplicationGetBehavioralAnalyticsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SearchApplicationGetBehavioralAnalyticsResponse](./SearchApplicationGetBehavioralAnalyticsResponse.md), unknown>>;` |   | +| `getBehavioralAnalytics` | `getBehavioralAnalytics(this: [That](./That.md), params?: [SearchApplicationGetBehavioralAnalyticsRequest](./SearchApplicationGetBehavioralAnalyticsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SearchApplicationGetBehavioralAnalyticsResponse](./SearchApplicationGetBehavioralAnalyticsResponse.md)>;` |   | +| `list` | `list(this: [That](./That.md), params?: [SearchApplicationListRequest](./SearchApplicationListRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SearchApplicationListResponse](./SearchApplicationListResponse.md)>;` | Get search applications. Get information about search applications. | +| `list` | `list(this: [That](./That.md), params?: [SearchApplicationListRequest](./SearchApplicationListRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SearchApplicationListResponse](./SearchApplicationListResponse.md), unknown>>;` |   | +| `list` | `list(this: [That](./That.md), params?: [SearchApplicationListRequest](./SearchApplicationListRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SearchApplicationListResponse](./SearchApplicationListResponse.md)>;` |   | +| `postBehavioralAnalyticsEvent` | `postBehavioralAnalyticsEvent(this: [That](./That.md), params: [SearchApplicationPostBehavioralAnalyticsEventRequest](./SearchApplicationPostBehavioralAnalyticsEventRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SearchApplicationPostBehavioralAnalyticsEventResponse](./SearchApplicationPostBehavioralAnalyticsEventResponse.md)>;` | Create a behavioral analytics collection event. | +| `postBehavioralAnalyticsEvent` | `postBehavioralAnalyticsEvent(this: [That](./That.md), params: [SearchApplicationPostBehavioralAnalyticsEventRequest](./SearchApplicationPostBehavioralAnalyticsEventRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SearchApplicationPostBehavioralAnalyticsEventResponse](./SearchApplicationPostBehavioralAnalyticsEventResponse.md), unknown>>;` |   | +| `postBehavioralAnalyticsEvent` | `postBehavioralAnalyticsEvent(this: [That](./That.md), params: [SearchApplicationPostBehavioralAnalyticsEventRequest](./SearchApplicationPostBehavioralAnalyticsEventRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SearchApplicationPostBehavioralAnalyticsEventResponse](./SearchApplicationPostBehavioralAnalyticsEventResponse.md)>;` |   | +| `put` | `put(this: [That](./That.md), params: [SearchApplicationPutRequest](./SearchApplicationPutRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SearchApplicationPutResponse](./SearchApplicationPutResponse.md)>;` | Create or update a search application. | +| `put` | `put(this: [That](./That.md), params: [SearchApplicationPutRequest](./SearchApplicationPutRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SearchApplicationPutResponse](./SearchApplicationPutResponse.md), unknown>>;` |   | +| `put` | `put(this: [That](./That.md), params: [SearchApplicationPutRequest](./SearchApplicationPutRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SearchApplicationPutResponse](./SearchApplicationPutResponse.md)>;` |   | +| `putBehavioralAnalytics` | `putBehavioralAnalytics(this: [That](./That.md), params: [SearchApplicationPutBehavioralAnalyticsRequest](./SearchApplicationPutBehavioralAnalyticsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SearchApplicationPutBehavioralAnalyticsResponse](./SearchApplicationPutBehavioralAnalyticsResponse.md)>;` | Create a behavioral analytics collection. | +| `putBehavioralAnalytics` | `putBehavioralAnalytics(this: [That](./That.md), params: [SearchApplicationPutBehavioralAnalyticsRequest](./SearchApplicationPutBehavioralAnalyticsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SearchApplicationPutBehavioralAnalyticsResponse](./SearchApplicationPutBehavioralAnalyticsResponse.md), unknown>>;` |   | +| `putBehavioralAnalytics` | `putBehavioralAnalytics(this: [That](./That.md), params: [SearchApplicationPutBehavioralAnalyticsRequest](./SearchApplicationPutBehavioralAnalyticsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SearchApplicationPutBehavioralAnalyticsResponse](./SearchApplicationPutBehavioralAnalyticsResponse.md)>;` |   | +| `renderQuery` | `renderQuery(this: [That](./That.md), params: [SearchApplicationRenderQueryRequest](./SearchApplicationRenderQueryRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SearchApplicationRenderQueryResponse](./SearchApplicationRenderQueryResponse.md)>;` | Render a search application query. Generate an Elasticsearch query using the specified query parameters and the search template associated with the search application or a default template if none is specified. If a parameter used in the search template is not specified in `params`, the parameter's default value will be used. The API returns the specific Elasticsearch query that would be generated and run by calling the search application search API. You must have `read` privileges on the backing alias of the search application. | +| `renderQuery` | `renderQuery(this: [That](./That.md), params: [SearchApplicationRenderQueryRequest](./SearchApplicationRenderQueryRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SearchApplicationRenderQueryResponse](./SearchApplicationRenderQueryResponse.md), unknown>>;` |   | +| `renderQuery` | `renderQuery(this: [That](./That.md), params: [SearchApplicationRenderQueryRequest](./SearchApplicationRenderQueryRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SearchApplicationRenderQueryResponse](./SearchApplicationRenderQueryResponse.md)>;` |   | +| `search` | `search>(this: [That](./That.md), params: [SearchApplicationSearchRequest](./SearchApplicationSearchRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SearchApplicationSearchResponse](./SearchApplicationSearchResponse.md)>;` | Run a search application search. Generate and run an Elasticsearch query that uses the specified query parameteter and the search template associated with the search application or default template. Unspecified template parameters are assigned their default values if applicable. | +| `search` | `search>(this: [That](./That.md), params: [SearchApplicationSearchRequest](./SearchApplicationSearchRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SearchApplicationSearchResponse](./SearchApplicationSearchResponse.md), unknown>>;` |   | +| `search` | `search>(this: [That](./That.md), params: [SearchApplicationSearchRequest](./SearchApplicationSearchRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SearchApplicationSearchResponse](./SearchApplicationSearchResponse.md)>;` |   | diff --git a/docs/reference/api/SearchableSnapshots.md b/docs/reference/api/SearchableSnapshots.md index ced4ac437..8a2206aaa 100644 --- a/docs/reference/api/SearchableSnapshots.md +++ b/docs/reference/api/SearchableSnapshots.md @@ -17,4 +17,15 @@ new SearchableSnapshots(transport: [Transport](./Transport.md)); | Name | Signature | Description | | - | - | - | -| `cacheStats` | `cacheStats(this: [That](./That.md), params?: [SearchableSnapshotsCacheStatsRequest](./SearchableSnapshotsCacheStatsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SearchableSnapshotsCacheStatsResponse](./SearchableSnapshotsCacheStatsResponse.md)>;` | Get cache statistics. Get statistics about the shared cache for partially mounted indices. || `cacheStats` | `cacheStats(this: [That](./That.md), params?: [SearchableSnapshotsCacheStatsRequest](./SearchableSnapshotsCacheStatsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SearchableSnapshotsCacheStatsResponse](./SearchableSnapshotsCacheStatsResponse.md), unknown>>;` |   || `cacheStats` | `cacheStats(this: [That](./That.md), params?: [SearchableSnapshotsCacheStatsRequest](./SearchableSnapshotsCacheStatsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SearchableSnapshotsCacheStatsResponse](./SearchableSnapshotsCacheStatsResponse.md)>;` |   || `clearCache` | `clearCache(this: [That](./That.md), params?: [SearchableSnapshotsClearCacheRequest](./SearchableSnapshotsClearCacheRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SearchableSnapshotsClearCacheResponse](./SearchableSnapshotsClearCacheResponse.md)>;` | Clear the cache. Clear indices and data streams from the shared cache for partially mounted indices. || `clearCache` | `clearCache(this: [That](./That.md), params?: [SearchableSnapshotsClearCacheRequest](./SearchableSnapshotsClearCacheRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SearchableSnapshotsClearCacheResponse](./SearchableSnapshotsClearCacheResponse.md), unknown>>;` |   || `clearCache` | `clearCache(this: [That](./That.md), params?: [SearchableSnapshotsClearCacheRequest](./SearchableSnapshotsClearCacheRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SearchableSnapshotsClearCacheResponse](./SearchableSnapshotsClearCacheResponse.md)>;` |   || `mount` | `mount(this: [That](./That.md), params: [SearchableSnapshotsMountRequest](./SearchableSnapshotsMountRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SearchableSnapshotsMountResponse](./SearchableSnapshotsMountResponse.md)>;` | Mount a snapshot. Mount a snapshot as a searchable snapshot index. Do not use this API for snapshots managed by index lifecycle management (ILM). Manually mounting ILM-managed snapshots can interfere with ILM processes. || `mount` | `mount(this: [That](./That.md), params: [SearchableSnapshotsMountRequest](./SearchableSnapshotsMountRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SearchableSnapshotsMountResponse](./SearchableSnapshotsMountResponse.md), unknown>>;` |   || `mount` | `mount(this: [That](./That.md), params: [SearchableSnapshotsMountRequest](./SearchableSnapshotsMountRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SearchableSnapshotsMountResponse](./SearchableSnapshotsMountResponse.md)>;` |   || `stats` | `stats(this: [That](./That.md), params?: [SearchableSnapshotsStatsRequest](./SearchableSnapshotsStatsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SearchableSnapshotsStatsResponse](./SearchableSnapshotsStatsResponse.md)>;` | Get searchable snapshot statistics. || `stats` | `stats(this: [That](./That.md), params?: [SearchableSnapshotsStatsRequest](./SearchableSnapshotsStatsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SearchableSnapshotsStatsResponse](./SearchableSnapshotsStatsResponse.md), unknown>>;` |   || `stats` | `stats(this: [That](./That.md), params?: [SearchableSnapshotsStatsRequest](./SearchableSnapshotsStatsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SearchableSnapshotsStatsResponse](./SearchableSnapshotsStatsResponse.md)>;` |   | \ No newline at end of file +| `cacheStats` | `cacheStats(this: [That](./That.md), params?: [SearchableSnapshotsCacheStatsRequest](./SearchableSnapshotsCacheStatsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SearchableSnapshotsCacheStatsResponse](./SearchableSnapshotsCacheStatsResponse.md)>;` | Get cache statistics. Get statistics about the shared cache for partially mounted indices. | +| `cacheStats` | `cacheStats(this: [That](./That.md), params?: [SearchableSnapshotsCacheStatsRequest](./SearchableSnapshotsCacheStatsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SearchableSnapshotsCacheStatsResponse](./SearchableSnapshotsCacheStatsResponse.md), unknown>>;` |   | +| `cacheStats` | `cacheStats(this: [That](./That.md), params?: [SearchableSnapshotsCacheStatsRequest](./SearchableSnapshotsCacheStatsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SearchableSnapshotsCacheStatsResponse](./SearchableSnapshotsCacheStatsResponse.md)>;` |   | +| `clearCache` | `clearCache(this: [That](./That.md), params?: [SearchableSnapshotsClearCacheRequest](./SearchableSnapshotsClearCacheRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SearchableSnapshotsClearCacheResponse](./SearchableSnapshotsClearCacheResponse.md)>;` | Clear the cache. Clear indices and data streams from the shared cache for partially mounted indices. | +| `clearCache` | `clearCache(this: [That](./That.md), params?: [SearchableSnapshotsClearCacheRequest](./SearchableSnapshotsClearCacheRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SearchableSnapshotsClearCacheResponse](./SearchableSnapshotsClearCacheResponse.md), unknown>>;` |   | +| `clearCache` | `clearCache(this: [That](./That.md), params?: [SearchableSnapshotsClearCacheRequest](./SearchableSnapshotsClearCacheRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SearchableSnapshotsClearCacheResponse](./SearchableSnapshotsClearCacheResponse.md)>;` |   | +| `mount` | `mount(this: [That](./That.md), params: [SearchableSnapshotsMountRequest](./SearchableSnapshotsMountRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SearchableSnapshotsMountResponse](./SearchableSnapshotsMountResponse.md)>;` | Mount a snapshot. Mount a snapshot as a searchable snapshot index. Do not use this API for snapshots managed by index lifecycle management (ILM). Manually mounting ILM-managed snapshots can interfere with ILM processes. | +| `mount` | `mount(this: [That](./That.md), params: [SearchableSnapshotsMountRequest](./SearchableSnapshotsMountRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SearchableSnapshotsMountResponse](./SearchableSnapshotsMountResponse.md), unknown>>;` |   | +| `mount` | `mount(this: [That](./That.md), params: [SearchableSnapshotsMountRequest](./SearchableSnapshotsMountRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SearchableSnapshotsMountResponse](./SearchableSnapshotsMountResponse.md)>;` |   | +| `stats` | `stats(this: [That](./That.md), params?: [SearchableSnapshotsStatsRequest](./SearchableSnapshotsStatsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SearchableSnapshotsStatsResponse](./SearchableSnapshotsStatsResponse.md)>;` | Get searchable snapshot statistics. | +| `stats` | `stats(this: [That](./That.md), params?: [SearchableSnapshotsStatsRequest](./SearchableSnapshotsStatsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SearchableSnapshotsStatsResponse](./SearchableSnapshotsStatsResponse.md), unknown>>;` |   | +| `stats` | `stats(this: [That](./That.md), params?: [SearchableSnapshotsStatsRequest](./SearchableSnapshotsStatsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SearchableSnapshotsStatsResponse](./SearchableSnapshotsStatsResponse.md)>;` |   | diff --git a/docs/reference/api/Security.md b/docs/reference/api/Security.md index eb194694d..656235072 100644 --- a/docs/reference/api/Security.md +++ b/docs/reference/api/Security.md @@ -17,4 +17,195 @@ new Security(transport: [Transport](./Transport.md)); | Name | Signature | Description | | - | - | - | -| `activateUserProfile` | `activateUserProfile(this: [That](./That.md), params: [SecurityActivateUserProfileRequest](./SecurityActivateUserProfileRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityActivateUserProfileResponse](./SecurityActivateUserProfileResponse.md)>;` | Activate a user profile. Create or update a user profile on behalf of another user. NOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions. Individual users and external applications should not call this API directly. The calling application must have either an `access_token` or a combination of `username` and `password` for the user that the profile document is intended for. Elastic reserves the right to change or remove this feature in future releases without prior notice. This API creates or updates a profile document for end users with information that is extracted from the user's authentication object including `username`, `full_name,` `roles`, and the authentication realm. For example, in the JWT `access_token` case, the profile user's `username` is extracted from the JWT token claim pointed to by the `claims.principal` setting of the JWT realm that authenticated the token. When updating a profile document, the API enables the document if it was disabled. Any updates do not change existing content for either the `labels` or `data` fields. || `activateUserProfile` | `activateUserProfile(this: [That](./That.md), params: [SecurityActivateUserProfileRequest](./SecurityActivateUserProfileRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityActivateUserProfileResponse](./SecurityActivateUserProfileResponse.md), unknown>>;` |   || `activateUserProfile` | `activateUserProfile(this: [That](./That.md), params: [SecurityActivateUserProfileRequest](./SecurityActivateUserProfileRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityActivateUserProfileResponse](./SecurityActivateUserProfileResponse.md)>;` |   || `authenticate` | `authenticate(this: [That](./That.md), params?: [SecurityAuthenticateRequest](./SecurityAuthenticateRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityAuthenticateResponse](./SecurityAuthenticateResponse.md)>;` | Authenticate a user. Authenticates a user and returns information about the authenticated user. Include the user information in a [basic auth header](https://en.wikipedia.org/wiki/Basic_access_authentication). A successful call returns a JSON structure that shows user information such as their username, the roles that are assigned to the user, any assigned metadata, and information about the realms that authenticated and authorized the user. If the user cannot be authenticated, this API returns a 401 status code. || `authenticate` | `authenticate(this: [That](./That.md), params?: [SecurityAuthenticateRequest](./SecurityAuthenticateRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityAuthenticateResponse](./SecurityAuthenticateResponse.md), unknown>>;` |   || `authenticate` | `authenticate(this: [That](./That.md), params?: [SecurityAuthenticateRequest](./SecurityAuthenticateRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityAuthenticateResponse](./SecurityAuthenticateResponse.md)>;` |   || `bulkDeleteRole` | `bulkDeleteRole(this: [That](./That.md), params: [SecurityBulkDeleteRoleRequest](./SecurityBulkDeleteRoleRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityBulkDeleteRoleResponse](./SecurityBulkDeleteRoleResponse.md)>;` | Bulk delete roles. The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. The bulk delete roles API cannot delete roles that are defined in roles files. || `bulkDeleteRole` | `bulkDeleteRole(this: [That](./That.md), params: [SecurityBulkDeleteRoleRequest](./SecurityBulkDeleteRoleRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityBulkDeleteRoleResponse](./SecurityBulkDeleteRoleResponse.md), unknown>>;` |   || `bulkDeleteRole` | `bulkDeleteRole(this: [That](./That.md), params: [SecurityBulkDeleteRoleRequest](./SecurityBulkDeleteRoleRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityBulkDeleteRoleResponse](./SecurityBulkDeleteRoleResponse.md)>;` |   || `bulkPutRole` | `bulkPutRole(this: [That](./That.md), params: [SecurityBulkPutRoleRequest](./SecurityBulkPutRoleRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityBulkPutRoleResponse](./SecurityBulkPutRoleResponse.md)>;` | Bulk create or update roles. The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. The bulk create or update roles API cannot update roles that are defined in roles files. || `bulkPutRole` | `bulkPutRole(this: [That](./That.md), params: [SecurityBulkPutRoleRequest](./SecurityBulkPutRoleRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityBulkPutRoleResponse](./SecurityBulkPutRoleResponse.md), unknown>>;` |   || `bulkPutRole` | `bulkPutRole(this: [That](./That.md), params: [SecurityBulkPutRoleRequest](./SecurityBulkPutRoleRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityBulkPutRoleResponse](./SecurityBulkPutRoleResponse.md)>;` |   || `bulkUpdateApiKeys` | `bulkUpdateApiKeys(this: [That](./That.md), params: [SecurityBulkUpdateApiKeysRequest](./SecurityBulkUpdateApiKeysRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityBulkUpdateApiKeysResponse](./SecurityBulkUpdateApiKeysResponse.md)>;` | Bulk update API keys. Update the attributes for multiple API keys. IMPORTANT: It is not possible to use an API key as the authentication credential for this API. To update API keys, the owner user's credentials are required. This API is similar to the update API key API but enables you to apply the same update to multiple API keys in one API call. This operation can greatly improve performance over making individual updates. It is not possible to update expired or invalidated API keys. This API supports updates to API key access scope, metadata and expiration. The access scope of each API key is derived from the `role_descriptors` you specify in the request and a snapshot of the owner user's permissions at the time of the request. The snapshot of the owner's permissions is updated automatically on every call. IMPORTANT: If you don't specify `role_descriptors` in the request, a call to this API might still change an API key's access scope. This change can occur if the owner user's permissions have changed since the API key was created or last modified. A successful request returns a JSON structure that contains the IDs of all updated API keys, the IDs of API keys that already had the requested changes and did not require an update, and error details for any failed update. || `bulkUpdateApiKeys` | `bulkUpdateApiKeys(this: [That](./That.md), params: [SecurityBulkUpdateApiKeysRequest](./SecurityBulkUpdateApiKeysRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityBulkUpdateApiKeysResponse](./SecurityBulkUpdateApiKeysResponse.md), unknown>>;` |   || `bulkUpdateApiKeys` | `bulkUpdateApiKeys(this: [That](./That.md), params: [SecurityBulkUpdateApiKeysRequest](./SecurityBulkUpdateApiKeysRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityBulkUpdateApiKeysResponse](./SecurityBulkUpdateApiKeysResponse.md)>;` |   || `changePassword` | `changePassword(this: [That](./That.md), params?: [SecurityChangePasswordRequest](./SecurityChangePasswordRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityChangePasswordResponse](./SecurityChangePasswordResponse.md)>;` | Change passwords. Change the passwords of users in the native realm and built-in users. || `changePassword` | `changePassword(this: [That](./That.md), params?: [SecurityChangePasswordRequest](./SecurityChangePasswordRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityChangePasswordResponse](./SecurityChangePasswordResponse.md), unknown>>;` |   || `changePassword` | `changePassword(this: [That](./That.md), params?: [SecurityChangePasswordRequest](./SecurityChangePasswordRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityChangePasswordResponse](./SecurityChangePasswordResponse.md)>;` |   || `clearApiKeyCache` | `clearApiKeyCache(this: [That](./That.md), params: [SecurityClearApiKeyCacheRequest](./SecurityClearApiKeyCacheRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityClearApiKeyCacheResponse](./SecurityClearApiKeyCacheResponse.md)>;` | Clear the API key cache. Evict a subset of all entries from the API key cache. The cache is also automatically cleared on state changes of the security index. || `clearApiKeyCache` | `clearApiKeyCache(this: [That](./That.md), params: [SecurityClearApiKeyCacheRequest](./SecurityClearApiKeyCacheRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityClearApiKeyCacheResponse](./SecurityClearApiKeyCacheResponse.md), unknown>>;` |   || `clearApiKeyCache` | `clearApiKeyCache(this: [That](./That.md), params: [SecurityClearApiKeyCacheRequest](./SecurityClearApiKeyCacheRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityClearApiKeyCacheResponse](./SecurityClearApiKeyCacheResponse.md)>;` |   || `clearCachedPrivileges` | `clearCachedPrivileges(this: [That](./That.md), params: [SecurityClearCachedPrivilegesRequest](./SecurityClearCachedPrivilegesRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityClearCachedPrivilegesResponse](./SecurityClearCachedPrivilegesResponse.md)>;` | Clear the privileges cache. Evict privileges from the native application privilege cache. The cache is also automatically cleared for applications that have their privileges updated. || `clearCachedPrivileges` | `clearCachedPrivileges(this: [That](./That.md), params: [SecurityClearCachedPrivilegesRequest](./SecurityClearCachedPrivilegesRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityClearCachedPrivilegesResponse](./SecurityClearCachedPrivilegesResponse.md), unknown>>;` |   || `clearCachedPrivileges` | `clearCachedPrivileges(this: [That](./That.md), params: [SecurityClearCachedPrivilegesRequest](./SecurityClearCachedPrivilegesRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityClearCachedPrivilegesResponse](./SecurityClearCachedPrivilegesResponse.md)>;` |   || `clearCachedRealms` | `clearCachedRealms(this: [That](./That.md), params: [SecurityClearCachedRealmsRequest](./SecurityClearCachedRealmsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityClearCachedRealmsResponse](./SecurityClearCachedRealmsResponse.md)>;` | Clear the user cache. Evict users from the user cache. You can completely clear the cache or evict specific users. User credentials are cached in memory on each node to avoid connecting to a remote authentication service or hitting the disk for every incoming request. There are realm settings that you can use to configure the user cache. For more information, refer to the documentation about controlling the user cache. || `clearCachedRealms` | `clearCachedRealms(this: [That](./That.md), params: [SecurityClearCachedRealmsRequest](./SecurityClearCachedRealmsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityClearCachedRealmsResponse](./SecurityClearCachedRealmsResponse.md), unknown>>;` |   || `clearCachedRealms` | `clearCachedRealms(this: [That](./That.md), params: [SecurityClearCachedRealmsRequest](./SecurityClearCachedRealmsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityClearCachedRealmsResponse](./SecurityClearCachedRealmsResponse.md)>;` |   || `clearCachedRoles` | `clearCachedRoles(this: [That](./That.md), params: [SecurityClearCachedRolesRequest](./SecurityClearCachedRolesRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityClearCachedRolesResponse](./SecurityClearCachedRolesResponse.md)>;` | Clear the roles cache. Evict roles from the native role cache. || `clearCachedRoles` | `clearCachedRoles(this: [That](./That.md), params: [SecurityClearCachedRolesRequest](./SecurityClearCachedRolesRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityClearCachedRolesResponse](./SecurityClearCachedRolesResponse.md), unknown>>;` |   || `clearCachedRoles` | `clearCachedRoles(this: [That](./That.md), params: [SecurityClearCachedRolesRequest](./SecurityClearCachedRolesRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityClearCachedRolesResponse](./SecurityClearCachedRolesResponse.md)>;` |   || `clearCachedServiceTokens` | `clearCachedServiceTokens(this: [That](./That.md), params: [SecurityClearCachedServiceTokensRequest](./SecurityClearCachedServiceTokensRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityClearCachedServiceTokensResponse](./SecurityClearCachedServiceTokensResponse.md)>;` | Clear service account token caches. Evict a subset of all entries from the service account token caches. Two separate caches exist for service account tokens: one cache for tokens backed by the `service_tokens` file, and another for tokens backed by the `.security` index. This API clears matching entries from both caches. The cache for service account tokens backed by the `.security` index is cleared automatically on state changes of the security index. The cache for tokens backed by the `service_tokens` file is cleared automatically on file changes. || `clearCachedServiceTokens` | `clearCachedServiceTokens(this: [That](./That.md), params: [SecurityClearCachedServiceTokensRequest](./SecurityClearCachedServiceTokensRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityClearCachedServiceTokensResponse](./SecurityClearCachedServiceTokensResponse.md), unknown>>;` |   || `clearCachedServiceTokens` | `clearCachedServiceTokens(this: [That](./That.md), params: [SecurityClearCachedServiceTokensRequest](./SecurityClearCachedServiceTokensRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityClearCachedServiceTokensResponse](./SecurityClearCachedServiceTokensResponse.md)>;` |   || `createApiKey` | `createApiKey(this: [That](./That.md), params?: [SecurityCreateApiKeyRequest](./SecurityCreateApiKeyRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityCreateApiKeyResponse](./SecurityCreateApiKeyResponse.md)>;` | Create an API key. Create an API key for access without requiring basic authentication. IMPORTANT: If the credential that is used to authenticate this request is an API key, the derived API key cannot have any privileges. If you specify privileges, the API returns an error. A successful request returns a JSON structure that contains the API key, its unique id, and its name. If applicable, it also returns expiration information for the API key in milliseconds. NOTE: By default, API keys never expire. You can specify expiration information when you create the API keys. The API keys are created by the Elasticsearch API key service, which is automatically enabled. To configure or turn off the API key service, refer to API key service setting documentation. || `createApiKey` | `createApiKey(this: [That](./That.md), params?: [SecurityCreateApiKeyRequest](./SecurityCreateApiKeyRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityCreateApiKeyResponse](./SecurityCreateApiKeyResponse.md), unknown>>;` |   || `createApiKey` | `createApiKey(this: [That](./That.md), params?: [SecurityCreateApiKeyRequest](./SecurityCreateApiKeyRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityCreateApiKeyResponse](./SecurityCreateApiKeyResponse.md)>;` |   || `createCrossClusterApiKey` | `createCrossClusterApiKey(this: [That](./That.md), params: [SecurityCreateCrossClusterApiKeyRequest](./SecurityCreateCrossClusterApiKeyRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityCreateCrossClusterApiKeyResponse](./SecurityCreateCrossClusterApiKeyResponse.md)>;` | Create a cross-cluster API key. Create an API key of the `cross_cluster` type for the API key based remote cluster access. A `cross_cluster` API key cannot be used to authenticate through the REST interface. IMPORTANT: To authenticate this request you must use a credential that is not an API key. Even if you use an API key that has the required privilege, the API returns an error. Cross-cluster API keys are created by the Elasticsearch API key service, which is automatically enabled. NOTE: Unlike REST API keys, a cross-cluster API key does not capture permissions of the authenticated user. The API key’s effective permission is exactly as specified with the `access` property. A successful request returns a JSON structure that contains the API key, its unique ID, and its name. If applicable, it also returns expiration information for the API key in milliseconds. By default, API keys never expire. You can specify expiration information when you create the API keys. Cross-cluster API keys can only be updated with the update cross-cluster API key API. Attempting to update them with the update REST API key API or the bulk update REST API keys API will result in an error. || `createCrossClusterApiKey` | `createCrossClusterApiKey(this: [That](./That.md), params: [SecurityCreateCrossClusterApiKeyRequest](./SecurityCreateCrossClusterApiKeyRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityCreateCrossClusterApiKeyResponse](./SecurityCreateCrossClusterApiKeyResponse.md), unknown>>;` |   || `createCrossClusterApiKey` | `createCrossClusterApiKey(this: [That](./That.md), params: [SecurityCreateCrossClusterApiKeyRequest](./SecurityCreateCrossClusterApiKeyRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityCreateCrossClusterApiKeyResponse](./SecurityCreateCrossClusterApiKeyResponse.md)>;` |   || `createServiceToken` | `createServiceToken(this: [That](./That.md), params: [SecurityCreateServiceTokenRequest](./SecurityCreateServiceTokenRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityCreateServiceTokenResponse](./SecurityCreateServiceTokenResponse.md)>;` | Create a service account token. Create a service accounts token for access without requiring basic authentication. NOTE: Service account tokens never expire. You must actively delete them if they are no longer needed. || `createServiceToken` | `createServiceToken(this: [That](./That.md), params: [SecurityCreateServiceTokenRequest](./SecurityCreateServiceTokenRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityCreateServiceTokenResponse](./SecurityCreateServiceTokenResponse.md), unknown>>;` |   || `createServiceToken` | `createServiceToken(this: [That](./That.md), params: [SecurityCreateServiceTokenRequest](./SecurityCreateServiceTokenRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityCreateServiceTokenResponse](./SecurityCreateServiceTokenResponse.md)>;` |   || `delegatePki` | `delegatePki(this: [That](./That.md), params: [SecurityDelegatePkiRequest](./SecurityDelegatePkiRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityDelegatePkiResponse](./SecurityDelegatePkiResponse.md)>;` | Delegate PKI authentication. This API implements the exchange of an X509Certificate chain for an Elasticsearch access token. The certificate chain is validated, according to RFC 5280, by sequentially considering the trust configuration of every installed PKI realm that has `delegation.enabled` set to `true`. A successfully trusted client certificate is also subject to the validation of the subject distinguished name according to thw `username_pattern` of the respective realm. This API is called by smart and trusted proxies, such as Kibana, which terminate the user's TLS session but still want to authenticate the user by using a PKI realm—-as if the user connected directly to Elasticsearch. IMPORTANT: The association between the subject public key in the target certificate and the corresponding private key is not validated. This is part of the TLS authentication process and it is delegated to the proxy that calls this API. The proxy is trusted to have performed the TLS authentication and this API translates that authentication into an Elasticsearch access token. || `delegatePki` | `delegatePki(this: [That](./That.md), params: [SecurityDelegatePkiRequest](./SecurityDelegatePkiRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityDelegatePkiResponse](./SecurityDelegatePkiResponse.md), unknown>>;` |   || `delegatePki` | `delegatePki(this: [That](./That.md), params: [SecurityDelegatePkiRequest](./SecurityDelegatePkiRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityDelegatePkiResponse](./SecurityDelegatePkiResponse.md)>;` |   || `deletePrivileges` | `deletePrivileges(this: [That](./That.md), params: [SecurityDeletePrivilegesRequest](./SecurityDeletePrivilegesRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityDeletePrivilegesResponse](./SecurityDeletePrivilegesResponse.md)>;` | Delete application privileges. To use this API, you must have one of the following privileges: * The `manage_security` cluster privilege (or a greater privilege such as `all`). * The "Manage Application Privileges" global privilege for the application being referenced in the request. || `deletePrivileges` | `deletePrivileges(this: [That](./That.md), params: [SecurityDeletePrivilegesRequest](./SecurityDeletePrivilegesRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityDeletePrivilegesResponse](./SecurityDeletePrivilegesResponse.md), unknown>>;` |   || `deletePrivileges` | `deletePrivileges(this: [That](./That.md), params: [SecurityDeletePrivilegesRequest](./SecurityDeletePrivilegesRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityDeletePrivilegesResponse](./SecurityDeletePrivilegesResponse.md)>;` |   || `deleteRole` | `deleteRole(this: [That](./That.md), params: [SecurityDeleteRoleRequest](./SecurityDeleteRoleRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityDeleteRoleResponse](./SecurityDeleteRoleResponse.md)>;` | Delete roles. Delete roles in the native realm. The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. The delete roles API cannot remove roles that are defined in roles files. || `deleteRole` | `deleteRole(this: [That](./That.md), params: [SecurityDeleteRoleRequest](./SecurityDeleteRoleRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityDeleteRoleResponse](./SecurityDeleteRoleResponse.md), unknown>>;` |   || `deleteRole` | `deleteRole(this: [That](./That.md), params: [SecurityDeleteRoleRequest](./SecurityDeleteRoleRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityDeleteRoleResponse](./SecurityDeleteRoleResponse.md)>;` |   || `deleteRoleMapping` | `deleteRoleMapping(this: [That](./That.md), params: [SecurityDeleteRoleMappingRequest](./SecurityDeleteRoleMappingRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityDeleteRoleMappingResponse](./SecurityDeleteRoleMappingResponse.md)>;` | Delete role mappings. Role mappings define which roles are assigned to each user. The role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files. The delete role mappings API cannot remove role mappings that are defined in role mapping files. || `deleteRoleMapping` | `deleteRoleMapping(this: [That](./That.md), params: [SecurityDeleteRoleMappingRequest](./SecurityDeleteRoleMappingRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityDeleteRoleMappingResponse](./SecurityDeleteRoleMappingResponse.md), unknown>>;` |   || `deleteRoleMapping` | `deleteRoleMapping(this: [That](./That.md), params: [SecurityDeleteRoleMappingRequest](./SecurityDeleteRoleMappingRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityDeleteRoleMappingResponse](./SecurityDeleteRoleMappingResponse.md)>;` |   || `deleteServiceToken` | `deleteServiceToken(this: [That](./That.md), params: [SecurityDeleteServiceTokenRequest](./SecurityDeleteServiceTokenRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityDeleteServiceTokenResponse](./SecurityDeleteServiceTokenResponse.md)>;` | Delete service account tokens. Delete service account tokens for a service in a specified namespace. || `deleteServiceToken` | `deleteServiceToken(this: [That](./That.md), params: [SecurityDeleteServiceTokenRequest](./SecurityDeleteServiceTokenRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityDeleteServiceTokenResponse](./SecurityDeleteServiceTokenResponse.md), unknown>>;` |   || `deleteServiceToken` | `deleteServiceToken(this: [That](./That.md), params: [SecurityDeleteServiceTokenRequest](./SecurityDeleteServiceTokenRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityDeleteServiceTokenResponse](./SecurityDeleteServiceTokenResponse.md)>;` |   || `deleteUser` | `deleteUser(this: [That](./That.md), params: [SecurityDeleteUserRequest](./SecurityDeleteUserRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityDeleteUserResponse](./SecurityDeleteUserResponse.md)>;` | Delete users. Delete users from the native realm. || `deleteUser` | `deleteUser(this: [That](./That.md), params: [SecurityDeleteUserRequest](./SecurityDeleteUserRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityDeleteUserResponse](./SecurityDeleteUserResponse.md), unknown>>;` |   || `deleteUser` | `deleteUser(this: [That](./That.md), params: [SecurityDeleteUserRequest](./SecurityDeleteUserRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityDeleteUserResponse](./SecurityDeleteUserResponse.md)>;` |   || `disableUser` | `disableUser(this: [That](./That.md), params: [SecurityDisableUserRequest](./SecurityDisableUserRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityDisableUserResponse](./SecurityDisableUserResponse.md)>;` | Disable users. Disable users in the native realm. By default, when you create users, they are enabled. You can use this API to revoke a user's access to Elasticsearch. || `disableUser` | `disableUser(this: [That](./That.md), params: [SecurityDisableUserRequest](./SecurityDisableUserRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityDisableUserResponse](./SecurityDisableUserResponse.md), unknown>>;` |   || `disableUser` | `disableUser(this: [That](./That.md), params: [SecurityDisableUserRequest](./SecurityDisableUserRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityDisableUserResponse](./SecurityDisableUserResponse.md)>;` |   || `disableUserProfile` | `disableUserProfile(this: [That](./That.md), params: [SecurityDisableUserProfileRequest](./SecurityDisableUserProfileRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityDisableUserProfileResponse](./SecurityDisableUserProfileResponse.md)>;` | Disable a user profile. Disable user profiles so that they are not visible in user profile searches. NOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions. Individual users and external applications should not call this API directly. Elastic reserves the right to change or remove this feature in future releases without prior notice. When you activate a user profile, its automatically enabled and visible in user profile searches. You can use the disable user profile API to disable a user profile so it’s not visible in these searches. To re-enable a disabled user profile, use the enable user profile API . || `disableUserProfile` | `disableUserProfile(this: [That](./That.md), params: [SecurityDisableUserProfileRequest](./SecurityDisableUserProfileRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityDisableUserProfileResponse](./SecurityDisableUserProfileResponse.md), unknown>>;` |   || `disableUserProfile` | `disableUserProfile(this: [That](./That.md), params: [SecurityDisableUserProfileRequest](./SecurityDisableUserProfileRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityDisableUserProfileResponse](./SecurityDisableUserProfileResponse.md)>;` |   || `enableUser` | `enableUser(this: [That](./That.md), params: [SecurityEnableUserRequest](./SecurityEnableUserRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityEnableUserResponse](./SecurityEnableUserResponse.md)>;` | Enable users. Enable users in the native realm. By default, when you create users, they are enabled. || `enableUser` | `enableUser(this: [That](./That.md), params: [SecurityEnableUserRequest](./SecurityEnableUserRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityEnableUserResponse](./SecurityEnableUserResponse.md), unknown>>;` |   || `enableUser` | `enableUser(this: [That](./That.md), params: [SecurityEnableUserRequest](./SecurityEnableUserRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityEnableUserResponse](./SecurityEnableUserResponse.md)>;` |   || `enableUserProfile` | `enableUserProfile(this: [That](./That.md), params: [SecurityEnableUserProfileRequest](./SecurityEnableUserProfileRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityEnableUserProfileResponse](./SecurityEnableUserProfileResponse.md)>;` | Enable a user profile. Enable user profiles to make them visible in user profile searches. NOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions. Individual users and external applications should not call this API directly. Elastic reserves the right to change or remove this feature in future releases without prior notice. When you activate a user profile, it's automatically enabled and visible in user profile searches. If you later disable the user profile, you can use the enable user profile API to make the profile visible in these searches again. || `enableUserProfile` | `enableUserProfile(this: [That](./That.md), params: [SecurityEnableUserProfileRequest](./SecurityEnableUserProfileRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityEnableUserProfileResponse](./SecurityEnableUserProfileResponse.md), unknown>>;` |   || `enableUserProfile` | `enableUserProfile(this: [That](./That.md), params: [SecurityEnableUserProfileRequest](./SecurityEnableUserProfileRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityEnableUserProfileResponse](./SecurityEnableUserProfileResponse.md)>;` |   || `enrollKibana` | `enrollKibana(this: [That](./That.md), params?: [SecurityEnrollKibanaRequest](./SecurityEnrollKibanaRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityEnrollKibanaResponse](./SecurityEnrollKibanaResponse.md)>;` | Enroll Kibana. Enable a Kibana instance to configure itself for communication with a secured Elasticsearch cluster. NOTE: This API is currently intended for internal use only by Kibana. Kibana uses this API internally to configure itself for communications with an Elasticsearch cluster that already has security features enabled. || `enrollKibana` | `enrollKibana(this: [That](./That.md), params?: [SecurityEnrollKibanaRequest](./SecurityEnrollKibanaRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityEnrollKibanaResponse](./SecurityEnrollKibanaResponse.md), unknown>>;` |   || `enrollKibana` | `enrollKibana(this: [That](./That.md), params?: [SecurityEnrollKibanaRequest](./SecurityEnrollKibanaRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityEnrollKibanaResponse](./SecurityEnrollKibanaResponse.md)>;` |   || `enrollNode` | `enrollNode(this: [That](./That.md), params?: [SecurityEnrollNodeRequest](./SecurityEnrollNodeRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityEnrollNodeResponse](./SecurityEnrollNodeResponse.md)>;` | Enroll a node. Enroll a new node to allow it to join an existing cluster with security features enabled. The response contains all the necessary information for the joining node to bootstrap discovery and security related settings so that it can successfully join the cluster. The response contains key and certificate material that allows the caller to generate valid signed certificates for the HTTP layer of all nodes in the cluster. || `enrollNode` | `enrollNode(this: [That](./That.md), params?: [SecurityEnrollNodeRequest](./SecurityEnrollNodeRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityEnrollNodeResponse](./SecurityEnrollNodeResponse.md), unknown>>;` |   || `enrollNode` | `enrollNode(this: [That](./That.md), params?: [SecurityEnrollNodeRequest](./SecurityEnrollNodeRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityEnrollNodeResponse](./SecurityEnrollNodeResponse.md)>;` |   || `getApiKey` | `getApiKey(this: [That](./That.md), params?: [SecurityGetApiKeyRequest](./SecurityGetApiKeyRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityGetApiKeyResponse](./SecurityGetApiKeyResponse.md)>;` | Get API key information. Retrieves information for one or more API keys. NOTE: If you have only the `manage_own_api_key` privilege, this API returns only the API keys that you own. If you have `read_security`, `manage_api_key` or greater privileges (including `manage_security`), this API returns all API keys regardless of ownership. || `getApiKey` | `getApiKey(this: [That](./That.md), params?: [SecurityGetApiKeyRequest](./SecurityGetApiKeyRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityGetApiKeyResponse](./SecurityGetApiKeyResponse.md), unknown>>;` |   || `getApiKey` | `getApiKey(this: [That](./That.md), params?: [SecurityGetApiKeyRequest](./SecurityGetApiKeyRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityGetApiKeyResponse](./SecurityGetApiKeyResponse.md)>;` |   || `getBuiltinPrivileges` | `getBuiltinPrivileges(this: [That](./That.md), params?: [SecurityGetBuiltinPrivilegesRequest](./SecurityGetBuiltinPrivilegesRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityGetBuiltinPrivilegesResponse](./SecurityGetBuiltinPrivilegesResponse.md)>;` | Get builtin privileges. Get the list of cluster privileges and index privileges that are available in this version of Elasticsearch. || `getBuiltinPrivileges` | `getBuiltinPrivileges(this: [That](./That.md), params?: [SecurityGetBuiltinPrivilegesRequest](./SecurityGetBuiltinPrivilegesRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityGetBuiltinPrivilegesResponse](./SecurityGetBuiltinPrivilegesResponse.md), unknown>>;` |   || `getBuiltinPrivileges` | `getBuiltinPrivileges(this: [That](./That.md), params?: [SecurityGetBuiltinPrivilegesRequest](./SecurityGetBuiltinPrivilegesRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityGetBuiltinPrivilegesResponse](./SecurityGetBuiltinPrivilegesResponse.md)>;` |   || `getPrivileges` | `getPrivileges(this: [That](./That.md), params?: [SecurityGetPrivilegesRequest](./SecurityGetPrivilegesRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityGetPrivilegesResponse](./SecurityGetPrivilegesResponse.md)>;` | Get application privileges. To use this API, you must have one of the following privileges: * The `read_security` cluster privilege (or a greater privilege such as `manage_security` or `all`). * The "Manage Application Privileges" global privilege for the application being referenced in the request. || `getPrivileges` | `getPrivileges(this: [That](./That.md), params?: [SecurityGetPrivilegesRequest](./SecurityGetPrivilegesRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityGetPrivilegesResponse](./SecurityGetPrivilegesResponse.md), unknown>>;` |   || `getPrivileges` | `getPrivileges(this: [That](./That.md), params?: [SecurityGetPrivilegesRequest](./SecurityGetPrivilegesRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityGetPrivilegesResponse](./SecurityGetPrivilegesResponse.md)>;` |   || `getRole` | `getRole(this: [That](./That.md), params?: [SecurityGetRoleRequest](./SecurityGetRoleRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityGetRoleResponse](./SecurityGetRoleResponse.md)>;` | Get roles. Get roles in the native realm. The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. The get roles API cannot retrieve roles that are defined in roles files. || `getRole` | `getRole(this: [That](./That.md), params?: [SecurityGetRoleRequest](./SecurityGetRoleRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityGetRoleResponse](./SecurityGetRoleResponse.md), unknown>>;` |   || `getRole` | `getRole(this: [That](./That.md), params?: [SecurityGetRoleRequest](./SecurityGetRoleRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityGetRoleResponse](./SecurityGetRoleResponse.md)>;` |   || `getRoleMapping` | `getRoleMapping(this: [That](./That.md), params?: [SecurityGetRoleMappingRequest](./SecurityGetRoleMappingRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityGetRoleMappingResponse](./SecurityGetRoleMappingResponse.md)>;` | Get role mappings. Role mappings define which roles are assigned to each user. The role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files. The get role mappings API cannot retrieve role mappings that are defined in role mapping files. || `getRoleMapping` | `getRoleMapping(this: [That](./That.md), params?: [SecurityGetRoleMappingRequest](./SecurityGetRoleMappingRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityGetRoleMappingResponse](./SecurityGetRoleMappingResponse.md), unknown>>;` |   || `getRoleMapping` | `getRoleMapping(this: [That](./That.md), params?: [SecurityGetRoleMappingRequest](./SecurityGetRoleMappingRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityGetRoleMappingResponse](./SecurityGetRoleMappingResponse.md)>;` |   || `getServiceAccounts` | `getServiceAccounts(this: [That](./That.md), params?: [SecurityGetServiceAccountsRequest](./SecurityGetServiceAccountsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityGetServiceAccountsResponse](./SecurityGetServiceAccountsResponse.md)>;` | Get service accounts. Get a list of service accounts that match the provided path parameters. NOTE: Currently, only the `elastic/fleet-server` service account is available. || `getServiceAccounts` | `getServiceAccounts(this: [That](./That.md), params?: [SecurityGetServiceAccountsRequest](./SecurityGetServiceAccountsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityGetServiceAccountsResponse](./SecurityGetServiceAccountsResponse.md), unknown>>;` |   || `getServiceAccounts` | `getServiceAccounts(this: [That](./That.md), params?: [SecurityGetServiceAccountsRequest](./SecurityGetServiceAccountsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityGetServiceAccountsResponse](./SecurityGetServiceAccountsResponse.md)>;` |   || `getServiceCredentials` | `getServiceCredentials(this: [That](./That.md), params: [SecurityGetServiceCredentialsRequest](./SecurityGetServiceCredentialsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityGetServiceCredentialsResponse](./SecurityGetServiceCredentialsResponse.md)>;` | Get service account credentials. To use this API, you must have at least the `read_security` cluster privilege (or a greater privilege such as `manage_service_account` or `manage_security`). The response includes service account tokens that were created with the create service account tokens API as well as file-backed tokens from all nodes of the cluster. NOTE: For tokens backed by the `service_tokens` file, the API collects them from all nodes of the cluster. Tokens with the same name from different nodes are assumed to be the same token and are only counted once towards the total number of service tokens. || `getServiceCredentials` | `getServiceCredentials(this: [That](./That.md), params: [SecurityGetServiceCredentialsRequest](./SecurityGetServiceCredentialsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityGetServiceCredentialsResponse](./SecurityGetServiceCredentialsResponse.md), unknown>>;` |   || `getServiceCredentials` | `getServiceCredentials(this: [That](./That.md), params: [SecurityGetServiceCredentialsRequest](./SecurityGetServiceCredentialsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityGetServiceCredentialsResponse](./SecurityGetServiceCredentialsResponse.md)>;` |   || `getSettings` | `getSettings(this: [That](./That.md), params?: [SecurityGetSettingsRequest](./SecurityGetSettingsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityGetSettingsResponse](./SecurityGetSettingsResponse.md)>;` | Get security index settings. Get the user-configurable settings for the security internal index ( `.security` and associated indices). Only a subset of the index settings — those that are user-configurable—will be shown. This includes: * `index.auto_expand_replicas` * `index.number_of_replicas` || `getSettings` | `getSettings(this: [That](./That.md), params?: [SecurityGetSettingsRequest](./SecurityGetSettingsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityGetSettingsResponse](./SecurityGetSettingsResponse.md), unknown>>;` |   || `getSettings` | `getSettings(this: [That](./That.md), params?: [SecurityGetSettingsRequest](./SecurityGetSettingsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityGetSettingsResponse](./SecurityGetSettingsResponse.md)>;` |   || `getToken` | `getToken(this: [That](./That.md), params?: [SecurityGetTokenRequest](./SecurityGetTokenRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityGetTokenResponse](./SecurityGetTokenResponse.md)>;` | Get a token. Create a bearer token for access without requiring basic authentication. The tokens are created by the Elasticsearch Token Service, which is automatically enabled when you configure TLS on the HTTP interface. Alternatively, you can explicitly enable the `xpack.security.authc.token.enabled` setting. When you are running in production mode, a bootstrap check prevents you from enabling the token service unless you also enable TLS on the HTTP interface. The get token API takes the same parameters as a typical OAuth 2.0 token API except for the use of a JSON request body. A successful get token API call returns a JSON structure that contains the access token, the amount of time (seconds) that the token expires in, the type, and the scope if available. The tokens returned by the get token API have a finite period of time for which they are valid and after that time period, they can no longer be used. That time period is defined by the `xpack.security.authc.token.timeout` setting. If you want to invalidate a token immediately, you can do so by using the invalidate token API. || `getToken` | `getToken(this: [That](./That.md), params?: [SecurityGetTokenRequest](./SecurityGetTokenRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityGetTokenResponse](./SecurityGetTokenResponse.md), unknown>>;` |   || `getToken` | `getToken(this: [That](./That.md), params?: [SecurityGetTokenRequest](./SecurityGetTokenRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityGetTokenResponse](./SecurityGetTokenResponse.md)>;` |   || `getUser` | `getUser(this: [That](./That.md), params?: [SecurityGetUserRequest](./SecurityGetUserRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityGetUserResponse](./SecurityGetUserResponse.md)>;` | Get users. Get information about users in the native realm and built-in users. || `getUser` | `getUser(this: [That](./That.md), params?: [SecurityGetUserRequest](./SecurityGetUserRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityGetUserResponse](./SecurityGetUserResponse.md), unknown>>;` |   || `getUser` | `getUser(this: [That](./That.md), params?: [SecurityGetUserRequest](./SecurityGetUserRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityGetUserResponse](./SecurityGetUserResponse.md)>;` |   || `getUserPrivileges` | `getUserPrivileges(this: [That](./That.md), params?: [SecurityGetUserPrivilegesRequest](./SecurityGetUserPrivilegesRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityGetUserPrivilegesResponse](./SecurityGetUserPrivilegesResponse.md)>;` | Get user privileges. Get the security privileges for the logged in user. All users can use this API, but only to determine their own privileges. To check the privileges of other users, you must use the run as feature. To check whether a user has a specific list of privileges, use the has privileges API. || `getUserPrivileges` | `getUserPrivileges(this: [That](./That.md), params?: [SecurityGetUserPrivilegesRequest](./SecurityGetUserPrivilegesRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityGetUserPrivilegesResponse](./SecurityGetUserPrivilegesResponse.md), unknown>>;` |   || `getUserPrivileges` | `getUserPrivileges(this: [That](./That.md), params?: [SecurityGetUserPrivilegesRequest](./SecurityGetUserPrivilegesRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityGetUserPrivilegesResponse](./SecurityGetUserPrivilegesResponse.md)>;` |   || `getUserProfile` | `getUserProfile(this: [That](./That.md), params: [SecurityGetUserProfileRequest](./SecurityGetUserProfileRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityGetUserProfileResponse](./SecurityGetUserProfileResponse.md)>;` | Get a user profile. Get a user's profile using the unique profile ID. NOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions. Individual users and external applications should not call this API directly. Elastic reserves the right to change or remove this feature in future releases without prior notice. || `getUserProfile` | `getUserProfile(this: [That](./That.md), params: [SecurityGetUserProfileRequest](./SecurityGetUserProfileRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityGetUserProfileResponse](./SecurityGetUserProfileResponse.md), unknown>>;` |   || `getUserProfile` | `getUserProfile(this: [That](./That.md), params: [SecurityGetUserProfileRequest](./SecurityGetUserProfileRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityGetUserProfileResponse](./SecurityGetUserProfileResponse.md)>;` |   || `grantApiKey` | `grantApiKey(this: [That](./That.md), params: [SecurityGrantApiKeyRequest](./SecurityGrantApiKeyRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityGrantApiKeyResponse](./SecurityGrantApiKeyResponse.md)>;` | Grant an API key. Create an API key on behalf of another user. This API is similar to the create API keys API, however it creates the API key for a user that is different than the user that runs the API. The caller must have authentication credentials for the user on whose behalf the API key will be created. It is not possible to use this API to create an API key without that user's credentials. The supported user authentication credential types are: * username and password * Elasticsearch access tokens * JWTs The user, for whom the authentication credentials is provided, can optionally "run as" (impersonate) another user. In this case, the API key will be created on behalf of the impersonated user. This API is intended be used by applications that need to create and manage API keys for end users, but cannot guarantee that those users have permission to create API keys on their own behalf. The API keys are created by the Elasticsearch API key service, which is automatically enabled. A successful grant API key API call returns a JSON structure that contains the API key, its unique id, and its name. If applicable, it also returns expiration information for the API key in milliseconds. By default, API keys never expire. You can specify expiration information when you create the API keys. || `grantApiKey` | `grantApiKey(this: [That](./That.md), params: [SecurityGrantApiKeyRequest](./SecurityGrantApiKeyRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityGrantApiKeyResponse](./SecurityGrantApiKeyResponse.md), unknown>>;` |   || `grantApiKey` | `grantApiKey(this: [That](./That.md), params: [SecurityGrantApiKeyRequest](./SecurityGrantApiKeyRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityGrantApiKeyResponse](./SecurityGrantApiKeyResponse.md)>;` |   || `hasPrivileges` | `hasPrivileges(this: [That](./That.md), params?: [SecurityHasPrivilegesRequest](./SecurityHasPrivilegesRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityHasPrivilegesResponse](./SecurityHasPrivilegesResponse.md)>;` | Check user privileges. Determine whether the specified user has a specified list of privileges. All users can use this API, but only to determine their own privileges. To check the privileges of other users, you must use the run as feature. || `hasPrivileges` | `hasPrivileges(this: [That](./That.md), params?: [SecurityHasPrivilegesRequest](./SecurityHasPrivilegesRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityHasPrivilegesResponse](./SecurityHasPrivilegesResponse.md), unknown>>;` |   || `hasPrivileges` | `hasPrivileges(this: [That](./That.md), params?: [SecurityHasPrivilegesRequest](./SecurityHasPrivilegesRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityHasPrivilegesResponse](./SecurityHasPrivilegesResponse.md)>;` |   || `hasPrivilegesUserProfile` | `hasPrivilegesUserProfile(this: [That](./That.md), params: [SecurityHasPrivilegesUserProfileRequest](./SecurityHasPrivilegesUserProfileRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityHasPrivilegesUserProfileResponse](./SecurityHasPrivilegesUserProfileResponse.md)>;` | Check user profile privileges. Determine whether the users associated with the specified user profile IDs have all the requested privileges. NOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions. Individual users and external applications should not call this API directly. Elastic reserves the right to change or remove this feature in future releases without prior notice. || `hasPrivilegesUserProfile` | `hasPrivilegesUserProfile(this: [That](./That.md), params: [SecurityHasPrivilegesUserProfileRequest](./SecurityHasPrivilegesUserProfileRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityHasPrivilegesUserProfileResponse](./SecurityHasPrivilegesUserProfileResponse.md), unknown>>;` |   || `hasPrivilegesUserProfile` | `hasPrivilegesUserProfile(this: [That](./That.md), params: [SecurityHasPrivilegesUserProfileRequest](./SecurityHasPrivilegesUserProfileRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityHasPrivilegesUserProfileResponse](./SecurityHasPrivilegesUserProfileResponse.md)>;` |   || `invalidateApiKey` | `invalidateApiKey(this: [That](./That.md), params?: [SecurityInvalidateApiKeyRequest](./SecurityInvalidateApiKeyRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityInvalidateApiKeyResponse](./SecurityInvalidateApiKeyResponse.md)>;` | Invalidate API keys. This API invalidates API keys created by the create API key or grant API key APIs. Invalidated API keys fail authentication, but they can still be viewed using the get API key information and query API key information APIs, for at least the configured retention period, until they are automatically deleted. To use this API, you must have at least the `manage_security`, `manage_api_key`, or `manage_own_api_key` cluster privileges. The `manage_security` privilege allows deleting any API key, including both REST and cross cluster API keys. The `manage_api_key` privilege allows deleting any REST API key, but not cross cluster API keys. The `manage_own_api_key` only allows deleting REST API keys that are owned by the user. In addition, with the `manage_own_api_key` privilege, an invalidation request must be issued in one of the three formats: - Set the parameter `owner=true`. - Or, set both `username` and `realm_name` to match the user's identity. - Or, if the request is issued by an API key, that is to say an API key invalidates itself, specify its ID in the `ids` field. || `invalidateApiKey` | `invalidateApiKey(this: [That](./That.md), params?: [SecurityInvalidateApiKeyRequest](./SecurityInvalidateApiKeyRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityInvalidateApiKeyResponse](./SecurityInvalidateApiKeyResponse.md), unknown>>;` |   || `invalidateApiKey` | `invalidateApiKey(this: [That](./That.md), params?: [SecurityInvalidateApiKeyRequest](./SecurityInvalidateApiKeyRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityInvalidateApiKeyResponse](./SecurityInvalidateApiKeyResponse.md)>;` |   || `invalidateToken` | `invalidateToken(this: [That](./That.md), params?: [SecurityInvalidateTokenRequest](./SecurityInvalidateTokenRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityInvalidateTokenResponse](./SecurityInvalidateTokenResponse.md)>;` | Invalidate a token. The access tokens returned by the get token API have a finite period of time for which they are valid. After that time period, they can no longer be used. The time period is defined by the `xpack.security.authc.token.timeout` setting. The refresh tokens returned by the get token API are only valid for 24 hours. They can also be used exactly once. If you want to invalidate one or more access or refresh tokens immediately, use this invalidate token API. NOTE: While all parameters are optional, at least one of them is required. More specifically, either one of `token` or `refresh_token` parameters is required. If none of these two are specified, then `realm_name` and/or `username` need to be specified. || `invalidateToken` | `invalidateToken(this: [That](./That.md), params?: [SecurityInvalidateTokenRequest](./SecurityInvalidateTokenRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityInvalidateTokenResponse](./SecurityInvalidateTokenResponse.md), unknown>>;` |   || `invalidateToken` | `invalidateToken(this: [That](./That.md), params?: [SecurityInvalidateTokenRequest](./SecurityInvalidateTokenRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityInvalidateTokenResponse](./SecurityInvalidateTokenResponse.md)>;` |   || `oidcAuthenticate` | `oidcAuthenticate(this: [That](./That.md), params: [SecurityOidcAuthenticateRequest](./SecurityOidcAuthenticateRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityOidcAuthenticateResponse](./SecurityOidcAuthenticateResponse.md)>;` | Authenticate OpenID Connect. Exchange an OpenID Connect authentication response message for an Elasticsearch internal access token and refresh token that can be subsequently used for authentication. Elasticsearch exposes all the necessary OpenID Connect related functionality with the OpenID Connect APIs. These APIs are used internally by Kibana in order to provide OpenID Connect based authentication, but can also be used by other, custom web applications or other clients. || `oidcAuthenticate` | `oidcAuthenticate(this: [That](./That.md), params: [SecurityOidcAuthenticateRequest](./SecurityOidcAuthenticateRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityOidcAuthenticateResponse](./SecurityOidcAuthenticateResponse.md), unknown>>;` |   || `oidcAuthenticate` | `oidcAuthenticate(this: [That](./That.md), params: [SecurityOidcAuthenticateRequest](./SecurityOidcAuthenticateRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityOidcAuthenticateResponse](./SecurityOidcAuthenticateResponse.md)>;` |   || `oidcLogout` | `oidcLogout(this: [That](./That.md), params: [SecurityOidcLogoutRequest](./SecurityOidcLogoutRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityOidcLogoutResponse](./SecurityOidcLogoutResponse.md)>;` | Logout of OpenID Connect. Invalidate an access token and a refresh token that were generated as a response to the `/_security/oidc/authenticate` API. If the OpenID Connect authentication realm in Elasticsearch is accordingly configured, the response to this call will contain a URI pointing to the end session endpoint of the OpenID Connect Provider in order to perform single logout. Elasticsearch exposes all the necessary OpenID Connect related functionality with the OpenID Connect APIs. These APIs are used internally by Kibana in order to provide OpenID Connect based authentication, but can also be used by other, custom web applications or other clients. || `oidcLogout` | `oidcLogout(this: [That](./That.md), params: [SecurityOidcLogoutRequest](./SecurityOidcLogoutRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityOidcLogoutResponse](./SecurityOidcLogoutResponse.md), unknown>>;` |   || `oidcLogout` | `oidcLogout(this: [That](./That.md), params: [SecurityOidcLogoutRequest](./SecurityOidcLogoutRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityOidcLogoutResponse](./SecurityOidcLogoutResponse.md)>;` |   || `oidcPrepareAuthentication` | `oidcPrepareAuthentication(this: [That](./That.md), params?: [SecurityOidcPrepareAuthenticationRequest](./SecurityOidcPrepareAuthenticationRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityOidcPrepareAuthenticationResponse](./SecurityOidcPrepareAuthenticationResponse.md)>;` | Prepare OpenID connect authentication. Create an oAuth 2.0 authentication request as a URL string based on the configuration of the OpenID Connect authentication realm in Elasticsearch. The response of this API is a URL pointing to the Authorization Endpoint of the configured OpenID Connect Provider, which can be used to redirect the browser of the user in order to continue the authentication process. Elasticsearch exposes all the necessary OpenID Connect related functionality with the OpenID Connect APIs. These APIs are used internally by Kibana in order to provide OpenID Connect based authentication, but can also be used by other, custom web applications or other clients. || `oidcPrepareAuthentication` | `oidcPrepareAuthentication(this: [That](./That.md), params?: [SecurityOidcPrepareAuthenticationRequest](./SecurityOidcPrepareAuthenticationRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityOidcPrepareAuthenticationResponse](./SecurityOidcPrepareAuthenticationResponse.md), unknown>>;` |   || `oidcPrepareAuthentication` | `oidcPrepareAuthentication(this: [That](./That.md), params?: [SecurityOidcPrepareAuthenticationRequest](./SecurityOidcPrepareAuthenticationRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityOidcPrepareAuthenticationResponse](./SecurityOidcPrepareAuthenticationResponse.md)>;` |   || `putPrivileges` | `putPrivileges(this: [That](./That.md), params: [SecurityPutPrivilegesRequest](./SecurityPutPrivilegesRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityPutPrivilegesResponse](./SecurityPutPrivilegesResponse.md)>;` | Create or update application privileges. To use this API, you must have one of the following privileges: * The `manage_security` cluster privilege (or a greater privilege such as `all`). * The "Manage Application Privileges" global privilege for the application being referenced in the request. Application names are formed from a prefix, with an optional suffix that conform to the following rules: * The prefix must begin with a lowercase ASCII letter. * The prefix must contain only ASCII letters or digits. * The prefix must be at least 3 characters long. * If the suffix exists, it must begin with either a dash `-` or `_`. * The suffix cannot contain any of the following characters: `\`, `/`, `*`, `?`, `"`, `<`, `>`, `|`, `,`, `*`. * No part of the name can contain whitespace. Privilege names must begin with a lowercase ASCII letter and must contain only ASCII letters and digits along with the characters `_`, `-`, and `.`. Action names can contain any number of printable ASCII characters and must contain at least one of the following characters: `/`, `*`, `:`. || `putPrivileges` | `putPrivileges(this: [That](./That.md), params: [SecurityPutPrivilegesRequest](./SecurityPutPrivilegesRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityPutPrivilegesResponse](./SecurityPutPrivilegesResponse.md), unknown>>;` |   || `putPrivileges` | `putPrivileges(this: [That](./That.md), params: [SecurityPutPrivilegesRequest](./SecurityPutPrivilegesRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityPutPrivilegesResponse](./SecurityPutPrivilegesResponse.md)>;` |   || `putRole` | `putRole(this: [That](./That.md), params: [SecurityPutRoleRequest](./SecurityPutRoleRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityPutRoleResponse](./SecurityPutRoleResponse.md)>;` | Create or update roles. The role management APIs are generally the preferred way to manage roles in the native realm, rather than using file-based role management. The create or update roles API cannot update roles that are defined in roles files. File-based role management is not available in Elastic Serverless. || `putRole` | `putRole(this: [That](./That.md), params: [SecurityPutRoleRequest](./SecurityPutRoleRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityPutRoleResponse](./SecurityPutRoleResponse.md), unknown>>;` |   || `putRole` | `putRole(this: [That](./That.md), params: [SecurityPutRoleRequest](./SecurityPutRoleRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityPutRoleResponse](./SecurityPutRoleResponse.md)>;` |   || `putRoleMapping` | `putRoleMapping(this: [That](./That.md), params: [SecurityPutRoleMappingRequest](./SecurityPutRoleMappingRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityPutRoleMappingResponse](./SecurityPutRoleMappingResponse.md)>;` | Create or update role mappings. Role mappings define which roles are assigned to each user. Each mapping has rules that identify users and a list of roles that are granted to those users. The role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files. The create or update role mappings API cannot update role mappings that are defined in role mapping files. NOTE: This API does not create roles. Rather, it maps users to existing roles. Roles can be created by using the create or update roles API or roles files. **Role templates** The most common use for role mappings is to create a mapping from a known value on the user to a fixed role name. For example, all users in the `cn=admin,dc=example,dc=com` LDAP group should be given the superuser role in Elasticsearch. The `roles` field is used for this purpose. For more complex needs, it is possible to use Mustache templates to dynamically determine the names of the roles that should be granted to the user. The `role_templates` field is used for this purpose. NOTE: To use role templates successfully, the relevant scripting feature must be enabled. Otherwise, all attempts to create a role mapping with role templates fail. All of the user fields that are available in the role mapping rules are also available in the role templates. Thus it is possible to assign a user to a role that reflects their username, their groups, or the name of the realm to which they authenticated. By default a template is evaluated to produce a single string that is the name of the role which should be assigned to the user. If the format of the template is set to "json" then the template is expected to produce a JSON string or an array of JSON strings for the role names. || `putRoleMapping` | `putRoleMapping(this: [That](./That.md), params: [SecurityPutRoleMappingRequest](./SecurityPutRoleMappingRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityPutRoleMappingResponse](./SecurityPutRoleMappingResponse.md), unknown>>;` |   || `putRoleMapping` | `putRoleMapping(this: [That](./That.md), params: [SecurityPutRoleMappingRequest](./SecurityPutRoleMappingRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityPutRoleMappingResponse](./SecurityPutRoleMappingResponse.md)>;` |   || `putUser` | `putUser(this: [That](./That.md), params: [SecurityPutUserRequest](./SecurityPutUserRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityPutUserResponse](./SecurityPutUserResponse.md)>;` | Create or update users. Add and update users in the native realm. A password is required for adding a new user but is optional when updating an existing user. To change a user's password without updating any other fields, use the change password API. || `putUser` | `putUser(this: [That](./That.md), params: [SecurityPutUserRequest](./SecurityPutUserRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityPutUserResponse](./SecurityPutUserResponse.md), unknown>>;` |   || `putUser` | `putUser(this: [That](./That.md), params: [SecurityPutUserRequest](./SecurityPutUserRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityPutUserResponse](./SecurityPutUserResponse.md)>;` |   || `queryApiKeys` | `queryApiKeys(this: [That](./That.md), params?: [SecurityQueryApiKeysRequest](./SecurityQueryApiKeysRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityQueryApiKeysResponse](./SecurityQueryApiKeysResponse.md)>;` | Find API keys with a query. Get a paginated list of API keys and their information. You can optionally filter the results with a query. To use this API, you must have at least the `manage_own_api_key` or the `read_security` cluster privileges. If you have only the `manage_own_api_key` privilege, this API returns only the API keys that you own. If you have the `read_security`, `manage_api_key`, or greater privileges (including `manage_security`), this API returns all API keys regardless of ownership. || `queryApiKeys` | `queryApiKeys(this: [That](./That.md), params?: [SecurityQueryApiKeysRequest](./SecurityQueryApiKeysRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityQueryApiKeysResponse](./SecurityQueryApiKeysResponse.md), unknown>>;` |   || `queryApiKeys` | `queryApiKeys(this: [That](./That.md), params?: [SecurityQueryApiKeysRequest](./SecurityQueryApiKeysRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityQueryApiKeysResponse](./SecurityQueryApiKeysResponse.md)>;` |   || `queryRole` | `queryRole(this: [That](./That.md), params?: [SecurityQueryRoleRequest](./SecurityQueryRoleRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityQueryRoleResponse](./SecurityQueryRoleResponse.md)>;` | Find roles with a query. Get roles in a paginated manner. The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. The query roles API does not retrieve roles that are defined in roles files, nor built-in ones. You can optionally filter the results with a query. Also, the results can be paginated and sorted. || `queryRole` | `queryRole(this: [That](./That.md), params?: [SecurityQueryRoleRequest](./SecurityQueryRoleRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityQueryRoleResponse](./SecurityQueryRoleResponse.md), unknown>>;` |   || `queryRole` | `queryRole(this: [That](./That.md), params?: [SecurityQueryRoleRequest](./SecurityQueryRoleRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityQueryRoleResponse](./SecurityQueryRoleResponse.md)>;` |   || `queryUser` | `queryUser(this: [That](./That.md), params?: [SecurityQueryUserRequest](./SecurityQueryUserRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityQueryUserResponse](./SecurityQueryUserResponse.md)>;` | Find users with a query. Get information for users in a paginated manner. You can optionally filter the results with a query. NOTE: As opposed to the get user API, built-in users are excluded from the result. This API is only for native users. || `queryUser` | `queryUser(this: [That](./That.md), params?: [SecurityQueryUserRequest](./SecurityQueryUserRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityQueryUserResponse](./SecurityQueryUserResponse.md), unknown>>;` |   || `queryUser` | `queryUser(this: [That](./That.md), params?: [SecurityQueryUserRequest](./SecurityQueryUserRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityQueryUserResponse](./SecurityQueryUserResponse.md)>;` |   || `samlAuthenticate` | `samlAuthenticate(this: [That](./That.md), params: [SecuritySamlAuthenticateRequest](./SecuritySamlAuthenticateRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecuritySamlAuthenticateResponse](./SecuritySamlAuthenticateResponse.md)>;` | Authenticate SAML. Submit a SAML response message to Elasticsearch for consumption. NOTE: This API is intended for use by custom web applications other than Kibana. If you are using Kibana, refer to the documentation for configuring SAML single-sign-on on the Elastic Stack. The SAML message that is submitted can be: * A response to a SAML authentication request that was previously created using the SAML prepare authentication API. * An unsolicited SAML message in the case of an IdP-initiated single sign-on (SSO) flow. In either case, the SAML message needs to be a base64 encoded XML document with a root element of ``. After successful validation, Elasticsearch responds with an Elasticsearch internal access token and refresh token that can be subsequently used for authentication. This API endpoint essentially exchanges SAML responses that indicate successful authentication in the IdP for Elasticsearch access and refresh tokens, which can be used for authentication against Elasticsearch. || `samlAuthenticate` | `samlAuthenticate(this: [That](./That.md), params: [SecuritySamlAuthenticateRequest](./SecuritySamlAuthenticateRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecuritySamlAuthenticateResponse](./SecuritySamlAuthenticateResponse.md), unknown>>;` |   || `samlAuthenticate` | `samlAuthenticate(this: [That](./That.md), params: [SecuritySamlAuthenticateRequest](./SecuritySamlAuthenticateRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecuritySamlAuthenticateResponse](./SecuritySamlAuthenticateResponse.md)>;` |   || `samlCompleteLogout` | `samlCompleteLogout(this: [That](./That.md), params: [SecuritySamlCompleteLogoutRequest](./SecuritySamlCompleteLogoutRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecuritySamlCompleteLogoutResponse](./SecuritySamlCompleteLogoutResponse.md)>;` | Logout of SAML completely. Verifies the logout response sent from the SAML IdP. NOTE: This API is intended for use by custom web applications other than Kibana. If you are using Kibana, refer to the documentation for configuring SAML single-sign-on on the Elastic Stack. The SAML IdP may send a logout response back to the SP after handling the SP-initiated SAML Single Logout. This API verifies the response by ensuring the content is relevant and validating its signature. An empty response is returned if the verification process is successful. The response can be sent by the IdP with either the HTTP-Redirect or the HTTP-Post binding. The caller of this API must prepare the request accordingly so that this API can handle either of them. || `samlCompleteLogout` | `samlCompleteLogout(this: [That](./That.md), params: [SecuritySamlCompleteLogoutRequest](./SecuritySamlCompleteLogoutRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecuritySamlCompleteLogoutResponse](./SecuritySamlCompleteLogoutResponse.md), unknown>>;` |   || `samlCompleteLogout` | `samlCompleteLogout(this: [That](./That.md), params: [SecuritySamlCompleteLogoutRequest](./SecuritySamlCompleteLogoutRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecuritySamlCompleteLogoutResponse](./SecuritySamlCompleteLogoutResponse.md)>;` |   || `samlInvalidate` | `samlInvalidate(this: [That](./That.md), params: [SecuritySamlInvalidateRequest](./SecuritySamlInvalidateRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecuritySamlInvalidateResponse](./SecuritySamlInvalidateResponse.md)>;` | Invalidate SAML. Submit a SAML LogoutRequest message to Elasticsearch for consumption. NOTE: This API is intended for use by custom web applications other than Kibana. If you are using Kibana, refer to the documentation for configuring SAML single-sign-on on the Elastic Stack. The logout request comes from the SAML IdP during an IdP initiated Single Logout. The custom web application can use this API to have Elasticsearch process the `LogoutRequest`. After successful validation of the request, Elasticsearch invalidates the access token and refresh token that corresponds to that specific SAML principal and provides a URL that contains a SAML LogoutResponse message. Thus the user can be redirected back to their IdP. || `samlInvalidate` | `samlInvalidate(this: [That](./That.md), params: [SecuritySamlInvalidateRequest](./SecuritySamlInvalidateRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecuritySamlInvalidateResponse](./SecuritySamlInvalidateResponse.md), unknown>>;` |   || `samlInvalidate` | `samlInvalidate(this: [That](./That.md), params: [SecuritySamlInvalidateRequest](./SecuritySamlInvalidateRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecuritySamlInvalidateResponse](./SecuritySamlInvalidateResponse.md)>;` |   || `samlLogout` | `samlLogout(this: [That](./That.md), params: [SecuritySamlLogoutRequest](./SecuritySamlLogoutRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecuritySamlLogoutResponse](./SecuritySamlLogoutResponse.md)>;` | Logout of SAML. Submits a request to invalidate an access token and refresh token. NOTE: This API is intended for use by custom web applications other than Kibana. If you are using Kibana, refer to the documentation for configuring SAML single-sign-on on the Elastic Stack. This API invalidates the tokens that were generated for a user by the SAML authenticate API. If the SAML realm in Elasticsearch is configured accordingly and the SAML IdP supports this, the Elasticsearch response contains a URL to redirect the user to the IdP that contains a SAML logout request (starting an SP-initiated SAML Single Logout). || `samlLogout` | `samlLogout(this: [That](./That.md), params: [SecuritySamlLogoutRequest](./SecuritySamlLogoutRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecuritySamlLogoutResponse](./SecuritySamlLogoutResponse.md), unknown>>;` |   || `samlLogout` | `samlLogout(this: [That](./That.md), params: [SecuritySamlLogoutRequest](./SecuritySamlLogoutRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecuritySamlLogoutResponse](./SecuritySamlLogoutResponse.md)>;` |   || `samlPrepareAuthentication` | `samlPrepareAuthentication(this: [That](./That.md), params?: [SecuritySamlPrepareAuthenticationRequest](./SecuritySamlPrepareAuthenticationRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecuritySamlPrepareAuthenticationResponse](./SecuritySamlPrepareAuthenticationResponse.md)>;` | Prepare SAML authentication. Create a SAML authentication request ( ``) as a URL string based on the configuration of the respective SAML realm in Elasticsearch. NOTE: This API is intended for use by custom web applications other than Kibana. If you are using Kibana, refer to the documentation for configuring SAML single-sign-on on the Elastic Stack. This API returns a URL pointing to the SAML Identity Provider. You can use the URL to redirect the browser of the user in order to continue the authentication process. The URL includes a single parameter named `SAMLRequest`, which contains a SAML Authentication request that is deflated and Base64 encoded. If the configuration dictates that SAML authentication requests should be signed, the URL has two extra parameters named `SigAlg` and `Signature`. These parameters contain the algorithm used for the signature and the signature value itself. It also returns a random string that uniquely identifies this SAML Authentication request. The caller of this API needs to store this identifier as it needs to be used in a following step of the authentication process. || `samlPrepareAuthentication` | `samlPrepareAuthentication(this: [That](./That.md), params?: [SecuritySamlPrepareAuthenticationRequest](./SecuritySamlPrepareAuthenticationRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecuritySamlPrepareAuthenticationResponse](./SecuritySamlPrepareAuthenticationResponse.md), unknown>>;` |   || `samlPrepareAuthentication` | `samlPrepareAuthentication(this: [That](./That.md), params?: [SecuritySamlPrepareAuthenticationRequest](./SecuritySamlPrepareAuthenticationRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecuritySamlPrepareAuthenticationResponse](./SecuritySamlPrepareAuthenticationResponse.md)>;` |   || `samlServiceProviderMetadata` | `samlServiceProviderMetadata(this: [That](./That.md), params: [SecuritySamlServiceProviderMetadataRequest](./SecuritySamlServiceProviderMetadataRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecuritySamlServiceProviderMetadataResponse](./SecuritySamlServiceProviderMetadataResponse.md)>;` | Create SAML service provider metadata. Generate SAML metadata for a SAML 2.0 Service Provider. The SAML 2.0 specification provides a mechanism for Service Providers to describe their capabilities and configuration using a metadata file. This API generates Service Provider metadata based on the configuration of a SAML realm in Elasticsearch. || `samlServiceProviderMetadata` | `samlServiceProviderMetadata(this: [That](./That.md), params: [SecuritySamlServiceProviderMetadataRequest](./SecuritySamlServiceProviderMetadataRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecuritySamlServiceProviderMetadataResponse](./SecuritySamlServiceProviderMetadataResponse.md), unknown>>;` |   || `samlServiceProviderMetadata` | `samlServiceProviderMetadata(this: [That](./That.md), params: [SecuritySamlServiceProviderMetadataRequest](./SecuritySamlServiceProviderMetadataRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecuritySamlServiceProviderMetadataResponse](./SecuritySamlServiceProviderMetadataResponse.md)>;` |   || `suggestUserProfiles` | `suggestUserProfiles(this: [That](./That.md), params?: [SecuritySuggestUserProfilesRequest](./SecuritySuggestUserProfilesRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecuritySuggestUserProfilesResponse](./SecuritySuggestUserProfilesResponse.md)>;` | Suggest a user profile. Get suggestions for user profiles that match specified search criteria. NOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions. Individual users and external applications should not call this API directly. Elastic reserves the right to change or remove this feature in future releases without prior notice. || `suggestUserProfiles` | `suggestUserProfiles(this: [That](./That.md), params?: [SecuritySuggestUserProfilesRequest](./SecuritySuggestUserProfilesRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecuritySuggestUserProfilesResponse](./SecuritySuggestUserProfilesResponse.md), unknown>>;` |   || `suggestUserProfiles` | `suggestUserProfiles(this: [That](./That.md), params?: [SecuritySuggestUserProfilesRequest](./SecuritySuggestUserProfilesRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecuritySuggestUserProfilesResponse](./SecuritySuggestUserProfilesResponse.md)>;` |   || `updateApiKey` | `updateApiKey(this: [That](./That.md), params: [SecurityUpdateApiKeyRequest](./SecurityUpdateApiKeyRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityUpdateApiKeyResponse](./SecurityUpdateApiKeyResponse.md)>;` | Update an API key. Update attributes of an existing API key. This API supports updates to an API key's access scope, expiration, and metadata. To use this API, you must have at least the `manage_own_api_key` cluster privilege. Users can only update API keys that they created or that were granted to them. To update another user’s API key, use the `run_as` feature to submit a request on behalf of another user. IMPORTANT: It's not possible to use an API key as the authentication credential for this API. The owner user’s credentials are required. Use this API to update API keys created by the create API key or grant API Key APIs. If you need to apply the same update to many API keys, you can use the bulk update API keys API to reduce overhead. It's not possible to update expired API keys or API keys that have been invalidated by the invalidate API key API. The access scope of an API key is derived from the `role_descriptors` you specify in the request and a snapshot of the owner user's permissions at the time of the request. The snapshot of the owner's permissions is updated automatically on every call. IMPORTANT: If you don't specify `role_descriptors` in the request, a call to this API might still change the API key's access scope. This change can occur if the owner user's permissions have changed since the API key was created or last modified. || `updateApiKey` | `updateApiKey(this: [That](./That.md), params: [SecurityUpdateApiKeyRequest](./SecurityUpdateApiKeyRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityUpdateApiKeyResponse](./SecurityUpdateApiKeyResponse.md), unknown>>;` |   || `updateApiKey` | `updateApiKey(this: [That](./That.md), params: [SecurityUpdateApiKeyRequest](./SecurityUpdateApiKeyRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityUpdateApiKeyResponse](./SecurityUpdateApiKeyResponse.md)>;` |   || `updateCrossClusterApiKey` | `updateCrossClusterApiKey(this: [That](./That.md), params: [SecurityUpdateCrossClusterApiKeyRequest](./SecurityUpdateCrossClusterApiKeyRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityUpdateCrossClusterApiKeyResponse](./SecurityUpdateCrossClusterApiKeyResponse.md)>;` | Update a cross-cluster API key. Update the attributes of an existing cross-cluster API key, which is used for API key based remote cluster access. To use this API, you must have at least the `manage_security` cluster privilege. Users can only update API keys that they created. To update another user's API key, use the `run_as` feature to submit a request on behalf of another user. IMPORTANT: It's not possible to use an API key as the authentication credential for this API. To update an API key, the owner user's credentials are required. It's not possible to update expired API keys, or API keys that have been invalidated by the invalidate API key API. This API supports updates to an API key's access scope, metadata, and expiration. The owner user's information, such as the `username` and `realm`, is also updated automatically on every call. NOTE: This API cannot update REST API keys, which should be updated by either the update API key or bulk update API keys API. || `updateCrossClusterApiKey` | `updateCrossClusterApiKey(this: [That](./That.md), params: [SecurityUpdateCrossClusterApiKeyRequest](./SecurityUpdateCrossClusterApiKeyRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityUpdateCrossClusterApiKeyResponse](./SecurityUpdateCrossClusterApiKeyResponse.md), unknown>>;` |   || `updateCrossClusterApiKey` | `updateCrossClusterApiKey(this: [That](./That.md), params: [SecurityUpdateCrossClusterApiKeyRequest](./SecurityUpdateCrossClusterApiKeyRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityUpdateCrossClusterApiKeyResponse](./SecurityUpdateCrossClusterApiKeyResponse.md)>;` |   || `updateSettings` | `updateSettings(this: [That](./That.md), params?: [SecurityUpdateSettingsRequest](./SecurityUpdateSettingsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityUpdateSettingsResponse](./SecurityUpdateSettingsResponse.md)>;` | Update security index settings. Update the user-configurable settings for the security internal index ( `.security` and associated indices). Only a subset of settings are allowed to be modified. This includes `index.auto_expand_replicas` and `index.number_of_replicas`. NOTE: If `index.auto_expand_replicas` is set, `index.number_of_replicas` will be ignored during updates. If a specific index is not in use on the system and settings are provided for it, the request will be rejected. This API does not yet support configuring the settings for indices before they are in use. || `updateSettings` | `updateSettings(this: [That](./That.md), params?: [SecurityUpdateSettingsRequest](./SecurityUpdateSettingsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityUpdateSettingsResponse](./SecurityUpdateSettingsResponse.md), unknown>>;` |   || `updateSettings` | `updateSettings(this: [That](./That.md), params?: [SecurityUpdateSettingsRequest](./SecurityUpdateSettingsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityUpdateSettingsResponse](./SecurityUpdateSettingsResponse.md)>;` |   || `updateUserProfileData` | `updateUserProfileData(this: [That](./That.md), params: [SecurityUpdateUserProfileDataRequest](./SecurityUpdateUserProfileDataRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityUpdateUserProfileDataResponse](./SecurityUpdateUserProfileDataResponse.md)>;` | Update user profile data. Update specific data for the user profile that is associated with a unique ID. NOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions. Individual users and external applications should not call this API directly. Elastic reserves the right to change or remove this feature in future releases without prior notice. To use this API, you must have one of the following privileges: * The `manage_user_profile` cluster privilege. * The `update_profile_data` global privilege for the namespaces that are referenced in the request. This API updates the `labels` and `data` fields of an existing user profile document with JSON objects. New keys and their values are added to the profile document and conflicting keys are replaced by data that's included in the request. For both labels and data, content is namespaced by the top-level fields. The `update_profile_data` global privilege grants privileges for updating only the allowed namespaces. || `updateUserProfileData` | `updateUserProfileData(this: [That](./That.md), params: [SecurityUpdateUserProfileDataRequest](./SecurityUpdateUserProfileDataRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityUpdateUserProfileDataResponse](./SecurityUpdateUserProfileDataResponse.md), unknown>>;` |   || `updateUserProfileData` | `updateUserProfileData(this: [That](./That.md), params: [SecurityUpdateUserProfileDataRequest](./SecurityUpdateUserProfileDataRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityUpdateUserProfileDataResponse](./SecurityUpdateUserProfileDataResponse.md)>;` |   | \ No newline at end of file +| `activateUserProfile` | `activateUserProfile(this: [That](./That.md), params: [SecurityActivateUserProfileRequest](./SecurityActivateUserProfileRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityActivateUserProfileResponse](./SecurityActivateUserProfileResponse.md)>;` | Activate a user profile. Create or update a user profile on behalf of another user. NOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions. Individual users and external applications should not call this API directly. The calling application must have either an `access_token` or a combination of `username` and `password` for the user that the profile document is intended for. Elastic reserves the right to change or remove this feature in future releases without prior notice. This API creates or updates a profile document for end users with information that is extracted from the user's authentication object including `username`, `full_name,` `roles`, and the authentication realm. For example, in the JWT `access_token` case, the profile user's `username` is extracted from the JWT token claim pointed to by the `claims.principal` setting of the JWT realm that authenticated the token. When updating a profile document, the API enables the document if it was disabled. Any updates do not change existing content for either the `labels` or `data` fields. | +| `activateUserProfile` | `activateUserProfile(this: [That](./That.md), params: [SecurityActivateUserProfileRequest](./SecurityActivateUserProfileRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityActivateUserProfileResponse](./SecurityActivateUserProfileResponse.md), unknown>>;` |   | +| `activateUserProfile` | `activateUserProfile(this: [That](./That.md), params: [SecurityActivateUserProfileRequest](./SecurityActivateUserProfileRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityActivateUserProfileResponse](./SecurityActivateUserProfileResponse.md)>;` |   | +| `authenticate` | `authenticate(this: [That](./That.md), params?: [SecurityAuthenticateRequest](./SecurityAuthenticateRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityAuthenticateResponse](./SecurityAuthenticateResponse.md)>;` | Authenticate a user. Authenticates a user and returns information about the authenticated user. Include the user information in a [basic auth header](https://en.wikipedia.org/wiki/Basic_access_authentication). A successful call returns a JSON structure that shows user information such as their username, the roles that are assigned to the user, any assigned metadata, and information about the realms that authenticated and authorized the user. If the user cannot be authenticated, this API returns a 401 status code. | +| `authenticate` | `authenticate(this: [That](./That.md), params?: [SecurityAuthenticateRequest](./SecurityAuthenticateRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityAuthenticateResponse](./SecurityAuthenticateResponse.md), unknown>>;` |   | +| `authenticate` | `authenticate(this: [That](./That.md), params?: [SecurityAuthenticateRequest](./SecurityAuthenticateRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityAuthenticateResponse](./SecurityAuthenticateResponse.md)>;` |   | +| `bulkDeleteRole` | `bulkDeleteRole(this: [That](./That.md), params: [SecurityBulkDeleteRoleRequest](./SecurityBulkDeleteRoleRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityBulkDeleteRoleResponse](./SecurityBulkDeleteRoleResponse.md)>;` | Bulk delete roles. The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. The bulk delete roles API cannot delete roles that are defined in roles files. | +| `bulkDeleteRole` | `bulkDeleteRole(this: [That](./That.md), params: [SecurityBulkDeleteRoleRequest](./SecurityBulkDeleteRoleRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityBulkDeleteRoleResponse](./SecurityBulkDeleteRoleResponse.md), unknown>>;` |   | +| `bulkDeleteRole` | `bulkDeleteRole(this: [That](./That.md), params: [SecurityBulkDeleteRoleRequest](./SecurityBulkDeleteRoleRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityBulkDeleteRoleResponse](./SecurityBulkDeleteRoleResponse.md)>;` |   | +| `bulkPutRole` | `bulkPutRole(this: [That](./That.md), params: [SecurityBulkPutRoleRequest](./SecurityBulkPutRoleRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityBulkPutRoleResponse](./SecurityBulkPutRoleResponse.md)>;` | Bulk create or update roles. The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. The bulk create or update roles API cannot update roles that are defined in roles files. | +| `bulkPutRole` | `bulkPutRole(this: [That](./That.md), params: [SecurityBulkPutRoleRequest](./SecurityBulkPutRoleRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityBulkPutRoleResponse](./SecurityBulkPutRoleResponse.md), unknown>>;` |   | +| `bulkPutRole` | `bulkPutRole(this: [That](./That.md), params: [SecurityBulkPutRoleRequest](./SecurityBulkPutRoleRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityBulkPutRoleResponse](./SecurityBulkPutRoleResponse.md)>;` |   | +| `bulkUpdateApiKeys` | `bulkUpdateApiKeys(this: [That](./That.md), params: [SecurityBulkUpdateApiKeysRequest](./SecurityBulkUpdateApiKeysRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityBulkUpdateApiKeysResponse](./SecurityBulkUpdateApiKeysResponse.md)>;` | Bulk update API keys. Update the attributes for multiple API keys. IMPORTANT: It is not possible to use an API key as the authentication credential for this API. To update API keys, the owner user's credentials are required. This API is similar to the update API key API but enables you to apply the same update to multiple API keys in one API call. This operation can greatly improve performance over making individual updates. It is not possible to update expired or invalidated API keys. This API supports updates to API key access scope, metadata and expiration. The access scope of each API key is derived from the `role_descriptors` you specify in the request and a snapshot of the owner user's permissions at the time of the request. The snapshot of the owner's permissions is updated automatically on every call. IMPORTANT: If you don't specify `role_descriptors` in the request, a call to this API might still change an API key's access scope. This change can occur if the owner user's permissions have changed since the API key was created or last modified. A successful request returns a JSON structure that contains the IDs of all updated API keys, the IDs of API keys that already had the requested changes and did not require an update, and error details for any failed update. | +| `bulkUpdateApiKeys` | `bulkUpdateApiKeys(this: [That](./That.md), params: [SecurityBulkUpdateApiKeysRequest](./SecurityBulkUpdateApiKeysRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityBulkUpdateApiKeysResponse](./SecurityBulkUpdateApiKeysResponse.md), unknown>>;` |   | +| `bulkUpdateApiKeys` | `bulkUpdateApiKeys(this: [That](./That.md), params: [SecurityBulkUpdateApiKeysRequest](./SecurityBulkUpdateApiKeysRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityBulkUpdateApiKeysResponse](./SecurityBulkUpdateApiKeysResponse.md)>;` |   | +| `changePassword` | `changePassword(this: [That](./That.md), params?: [SecurityChangePasswordRequest](./SecurityChangePasswordRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityChangePasswordResponse](./SecurityChangePasswordResponse.md)>;` | Change passwords. Change the passwords of users in the native realm and built-in users. | +| `changePassword` | `changePassword(this: [That](./That.md), params?: [SecurityChangePasswordRequest](./SecurityChangePasswordRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityChangePasswordResponse](./SecurityChangePasswordResponse.md), unknown>>;` |   | +| `changePassword` | `changePassword(this: [That](./That.md), params?: [SecurityChangePasswordRequest](./SecurityChangePasswordRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityChangePasswordResponse](./SecurityChangePasswordResponse.md)>;` |   | +| `clearApiKeyCache` | `clearApiKeyCache(this: [That](./That.md), params: [SecurityClearApiKeyCacheRequest](./SecurityClearApiKeyCacheRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityClearApiKeyCacheResponse](./SecurityClearApiKeyCacheResponse.md)>;` | Clear the API key cache. Evict a subset of all entries from the API key cache. The cache is also automatically cleared on state changes of the security index. | +| `clearApiKeyCache` | `clearApiKeyCache(this: [That](./That.md), params: [SecurityClearApiKeyCacheRequest](./SecurityClearApiKeyCacheRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityClearApiKeyCacheResponse](./SecurityClearApiKeyCacheResponse.md), unknown>>;` |   | +| `clearApiKeyCache` | `clearApiKeyCache(this: [That](./That.md), params: [SecurityClearApiKeyCacheRequest](./SecurityClearApiKeyCacheRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityClearApiKeyCacheResponse](./SecurityClearApiKeyCacheResponse.md)>;` |   | +| `clearCachedPrivileges` | `clearCachedPrivileges(this: [That](./That.md), params: [SecurityClearCachedPrivilegesRequest](./SecurityClearCachedPrivilegesRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityClearCachedPrivilegesResponse](./SecurityClearCachedPrivilegesResponse.md)>;` | Clear the privileges cache. Evict privileges from the native application privilege cache. The cache is also automatically cleared for applications that have their privileges updated. | +| `clearCachedPrivileges` | `clearCachedPrivileges(this: [That](./That.md), params: [SecurityClearCachedPrivilegesRequest](./SecurityClearCachedPrivilegesRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityClearCachedPrivilegesResponse](./SecurityClearCachedPrivilegesResponse.md), unknown>>;` |   | +| `clearCachedPrivileges` | `clearCachedPrivileges(this: [That](./That.md), params: [SecurityClearCachedPrivilegesRequest](./SecurityClearCachedPrivilegesRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityClearCachedPrivilegesResponse](./SecurityClearCachedPrivilegesResponse.md)>;` |   | +| `clearCachedRealms` | `clearCachedRealms(this: [That](./That.md), params: [SecurityClearCachedRealmsRequest](./SecurityClearCachedRealmsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityClearCachedRealmsResponse](./SecurityClearCachedRealmsResponse.md)>;` | Clear the user cache. Evict users from the user cache. You can completely clear the cache or evict specific users. User credentials are cached in memory on each node to avoid connecting to a remote authentication service or hitting the disk for every incoming request. There are realm settings that you can use to configure the user cache. For more information, refer to the documentation about controlling the user cache. | +| `clearCachedRealms` | `clearCachedRealms(this: [That](./That.md), params: [SecurityClearCachedRealmsRequest](./SecurityClearCachedRealmsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityClearCachedRealmsResponse](./SecurityClearCachedRealmsResponse.md), unknown>>;` |   | +| `clearCachedRealms` | `clearCachedRealms(this: [That](./That.md), params: [SecurityClearCachedRealmsRequest](./SecurityClearCachedRealmsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityClearCachedRealmsResponse](./SecurityClearCachedRealmsResponse.md)>;` |   | +| `clearCachedRoles` | `clearCachedRoles(this: [That](./That.md), params: [SecurityClearCachedRolesRequest](./SecurityClearCachedRolesRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityClearCachedRolesResponse](./SecurityClearCachedRolesResponse.md)>;` | Clear the roles cache. Evict roles from the native role cache. | +| `clearCachedRoles` | `clearCachedRoles(this: [That](./That.md), params: [SecurityClearCachedRolesRequest](./SecurityClearCachedRolesRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityClearCachedRolesResponse](./SecurityClearCachedRolesResponse.md), unknown>>;` |   | +| `clearCachedRoles` | `clearCachedRoles(this: [That](./That.md), params: [SecurityClearCachedRolesRequest](./SecurityClearCachedRolesRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityClearCachedRolesResponse](./SecurityClearCachedRolesResponse.md)>;` |   | +| `clearCachedServiceTokens` | `clearCachedServiceTokens(this: [That](./That.md), params: [SecurityClearCachedServiceTokensRequest](./SecurityClearCachedServiceTokensRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityClearCachedServiceTokensResponse](./SecurityClearCachedServiceTokensResponse.md)>;` | Clear service account token caches. Evict a subset of all entries from the service account token caches. Two separate caches exist for service account tokens: one cache for tokens backed by the `service_tokens` file, and another for tokens backed by the `.security` index. This API clears matching entries from both caches. The cache for service account tokens backed by the `.security` index is cleared automatically on state changes of the security index. The cache for tokens backed by the `service_tokens` file is cleared automatically on file changes. | +| `clearCachedServiceTokens` | `clearCachedServiceTokens(this: [That](./That.md), params: [SecurityClearCachedServiceTokensRequest](./SecurityClearCachedServiceTokensRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityClearCachedServiceTokensResponse](./SecurityClearCachedServiceTokensResponse.md), unknown>>;` |   | +| `clearCachedServiceTokens` | `clearCachedServiceTokens(this: [That](./That.md), params: [SecurityClearCachedServiceTokensRequest](./SecurityClearCachedServiceTokensRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityClearCachedServiceTokensResponse](./SecurityClearCachedServiceTokensResponse.md)>;` |   | +| `createApiKey` | `createApiKey(this: [That](./That.md), params?: [SecurityCreateApiKeyRequest](./SecurityCreateApiKeyRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityCreateApiKeyResponse](./SecurityCreateApiKeyResponse.md)>;` | Create an API key. Create an API key for access without requiring basic authentication. IMPORTANT: If the credential that is used to authenticate this request is an API key, the derived API key cannot have any privileges. If you specify privileges, the API returns an error. A successful request returns a JSON structure that contains the API key, its unique id, and its name. If applicable, it also returns expiration information for the API key in milliseconds. NOTE: By default, API keys never expire. You can specify expiration information when you create the API keys. The API keys are created by the Elasticsearch API key service, which is automatically enabled. To configure or turn off the API key service, refer to API key service setting documentation. | +| `createApiKey` | `createApiKey(this: [That](./That.md), params?: [SecurityCreateApiKeyRequest](./SecurityCreateApiKeyRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityCreateApiKeyResponse](./SecurityCreateApiKeyResponse.md), unknown>>;` |   | +| `createApiKey` | `createApiKey(this: [That](./That.md), params?: [SecurityCreateApiKeyRequest](./SecurityCreateApiKeyRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityCreateApiKeyResponse](./SecurityCreateApiKeyResponse.md)>;` |   | +| `createCrossClusterApiKey` | `createCrossClusterApiKey(this: [That](./That.md), params: [SecurityCreateCrossClusterApiKeyRequest](./SecurityCreateCrossClusterApiKeyRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityCreateCrossClusterApiKeyResponse](./SecurityCreateCrossClusterApiKeyResponse.md)>;` | Create a cross-cluster API key. Create an API key of the `cross_cluster` type for the API key based remote cluster access. A `cross_cluster` API key cannot be used to authenticate through the REST interface. IMPORTANT: To authenticate this request you must use a credential that is not an API key. Even if you use an API key that has the required privilege, the API returns an error. Cross-cluster API keys are created by the Elasticsearch API key service, which is automatically enabled. NOTE: Unlike REST API keys, a cross-cluster API key does not capture permissions of the authenticated user. The API key’s effective permission is exactly as specified with the `access` property. A successful request returns a JSON structure that contains the API key, its unique ID, and its name. If applicable, it also returns expiration information for the API key in milliseconds. By default, API keys never expire. You can specify expiration information when you create the API keys. Cross-cluster API keys can only be updated with the update cross-cluster API key API. Attempting to update them with the update REST API key API or the bulk update REST API keys API will result in an error. | +| `createCrossClusterApiKey` | `createCrossClusterApiKey(this: [That](./That.md), params: [SecurityCreateCrossClusterApiKeyRequest](./SecurityCreateCrossClusterApiKeyRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityCreateCrossClusterApiKeyResponse](./SecurityCreateCrossClusterApiKeyResponse.md), unknown>>;` |   | +| `createCrossClusterApiKey` | `createCrossClusterApiKey(this: [That](./That.md), params: [SecurityCreateCrossClusterApiKeyRequest](./SecurityCreateCrossClusterApiKeyRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityCreateCrossClusterApiKeyResponse](./SecurityCreateCrossClusterApiKeyResponse.md)>;` |   | +| `createServiceToken` | `createServiceToken(this: [That](./That.md), params: [SecurityCreateServiceTokenRequest](./SecurityCreateServiceTokenRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityCreateServiceTokenResponse](./SecurityCreateServiceTokenResponse.md)>;` | Create a service account token. Create a service accounts token for access without requiring basic authentication. NOTE: Service account tokens never expire. You must actively delete them if they are no longer needed. | +| `createServiceToken` | `createServiceToken(this: [That](./That.md), params: [SecurityCreateServiceTokenRequest](./SecurityCreateServiceTokenRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityCreateServiceTokenResponse](./SecurityCreateServiceTokenResponse.md), unknown>>;` |   | +| `createServiceToken` | `createServiceToken(this: [That](./That.md), params: [SecurityCreateServiceTokenRequest](./SecurityCreateServiceTokenRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityCreateServiceTokenResponse](./SecurityCreateServiceTokenResponse.md)>;` |   | +| `delegatePki` | `delegatePki(this: [That](./That.md), params: [SecurityDelegatePkiRequest](./SecurityDelegatePkiRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityDelegatePkiResponse](./SecurityDelegatePkiResponse.md)>;` | Delegate PKI authentication. This API implements the exchange of an X509Certificate chain for an Elasticsearch access token. The certificate chain is validated, according to RFC 5280, by sequentially considering the trust configuration of every installed PKI realm that has `delegation.enabled` set to `true`. A successfully trusted client certificate is also subject to the validation of the subject distinguished name according to thw `username_pattern` of the respective realm. This API is called by smart and trusted proxies, such as Kibana, which terminate the user's TLS session but still want to authenticate the user by using a PKI realm—-as if the user connected directly to Elasticsearch. IMPORTANT: The association between the subject public key in the target certificate and the corresponding private key is not validated. This is part of the TLS authentication process and it is delegated to the proxy that calls this API. The proxy is trusted to have performed the TLS authentication and this API translates that authentication into an Elasticsearch access token. | +| `delegatePki` | `delegatePki(this: [That](./That.md), params: [SecurityDelegatePkiRequest](./SecurityDelegatePkiRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityDelegatePkiResponse](./SecurityDelegatePkiResponse.md), unknown>>;` |   | +| `delegatePki` | `delegatePki(this: [That](./That.md), params: [SecurityDelegatePkiRequest](./SecurityDelegatePkiRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityDelegatePkiResponse](./SecurityDelegatePkiResponse.md)>;` |   | +| `deletePrivileges` | `deletePrivileges(this: [That](./That.md), params: [SecurityDeletePrivilegesRequest](./SecurityDeletePrivilegesRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityDeletePrivilegesResponse](./SecurityDeletePrivilegesResponse.md)>;` | Delete application privileges. To use this API, you must have one of the following privileges: * The `manage_security` cluster privilege (or a greater privilege such as `all`). * The "Manage Application Privileges" global privilege for the application being referenced in the request. | +| `deletePrivileges` | `deletePrivileges(this: [That](./That.md), params: [SecurityDeletePrivilegesRequest](./SecurityDeletePrivilegesRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityDeletePrivilegesResponse](./SecurityDeletePrivilegesResponse.md), unknown>>;` |   | +| `deletePrivileges` | `deletePrivileges(this: [That](./That.md), params: [SecurityDeletePrivilegesRequest](./SecurityDeletePrivilegesRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityDeletePrivilegesResponse](./SecurityDeletePrivilegesResponse.md)>;` |   | +| `deleteRole` | `deleteRole(this: [That](./That.md), params: [SecurityDeleteRoleRequest](./SecurityDeleteRoleRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityDeleteRoleResponse](./SecurityDeleteRoleResponse.md)>;` | Delete roles. Delete roles in the native realm. The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. The delete roles API cannot remove roles that are defined in roles files. | +| `deleteRole` | `deleteRole(this: [That](./That.md), params: [SecurityDeleteRoleRequest](./SecurityDeleteRoleRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityDeleteRoleResponse](./SecurityDeleteRoleResponse.md), unknown>>;` |   | +| `deleteRole` | `deleteRole(this: [That](./That.md), params: [SecurityDeleteRoleRequest](./SecurityDeleteRoleRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityDeleteRoleResponse](./SecurityDeleteRoleResponse.md)>;` |   | +| `deleteRoleMapping` | `deleteRoleMapping(this: [That](./That.md), params: [SecurityDeleteRoleMappingRequest](./SecurityDeleteRoleMappingRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityDeleteRoleMappingResponse](./SecurityDeleteRoleMappingResponse.md)>;` | Delete role mappings. Role mappings define which roles are assigned to each user. The role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files. The delete role mappings API cannot remove role mappings that are defined in role mapping files. | +| `deleteRoleMapping` | `deleteRoleMapping(this: [That](./That.md), params: [SecurityDeleteRoleMappingRequest](./SecurityDeleteRoleMappingRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityDeleteRoleMappingResponse](./SecurityDeleteRoleMappingResponse.md), unknown>>;` |   | +| `deleteRoleMapping` | `deleteRoleMapping(this: [That](./That.md), params: [SecurityDeleteRoleMappingRequest](./SecurityDeleteRoleMappingRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityDeleteRoleMappingResponse](./SecurityDeleteRoleMappingResponse.md)>;` |   | +| `deleteServiceToken` | `deleteServiceToken(this: [That](./That.md), params: [SecurityDeleteServiceTokenRequest](./SecurityDeleteServiceTokenRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityDeleteServiceTokenResponse](./SecurityDeleteServiceTokenResponse.md)>;` | Delete service account tokens. Delete service account tokens for a service in a specified namespace. | +| `deleteServiceToken` | `deleteServiceToken(this: [That](./That.md), params: [SecurityDeleteServiceTokenRequest](./SecurityDeleteServiceTokenRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityDeleteServiceTokenResponse](./SecurityDeleteServiceTokenResponse.md), unknown>>;` |   | +| `deleteServiceToken` | `deleteServiceToken(this: [That](./That.md), params: [SecurityDeleteServiceTokenRequest](./SecurityDeleteServiceTokenRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityDeleteServiceTokenResponse](./SecurityDeleteServiceTokenResponse.md)>;` |   | +| `deleteUser` | `deleteUser(this: [That](./That.md), params: [SecurityDeleteUserRequest](./SecurityDeleteUserRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityDeleteUserResponse](./SecurityDeleteUserResponse.md)>;` | Delete users. Delete users from the native realm. | +| `deleteUser` | `deleteUser(this: [That](./That.md), params: [SecurityDeleteUserRequest](./SecurityDeleteUserRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityDeleteUserResponse](./SecurityDeleteUserResponse.md), unknown>>;` |   | +| `deleteUser` | `deleteUser(this: [That](./That.md), params: [SecurityDeleteUserRequest](./SecurityDeleteUserRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityDeleteUserResponse](./SecurityDeleteUserResponse.md)>;` |   | +| `disableUser` | `disableUser(this: [That](./That.md), params: [SecurityDisableUserRequest](./SecurityDisableUserRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityDisableUserResponse](./SecurityDisableUserResponse.md)>;` | Disable users. Disable users in the native realm. By default, when you create users, they are enabled. You can use this API to revoke a user's access to Elasticsearch. | +| `disableUser` | `disableUser(this: [That](./That.md), params: [SecurityDisableUserRequest](./SecurityDisableUserRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityDisableUserResponse](./SecurityDisableUserResponse.md), unknown>>;` |   | +| `disableUser` | `disableUser(this: [That](./That.md), params: [SecurityDisableUserRequest](./SecurityDisableUserRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityDisableUserResponse](./SecurityDisableUserResponse.md)>;` |   | +| `disableUserProfile` | `disableUserProfile(this: [That](./That.md), params: [SecurityDisableUserProfileRequest](./SecurityDisableUserProfileRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityDisableUserProfileResponse](./SecurityDisableUserProfileResponse.md)>;` | Disable a user profile. Disable user profiles so that they are not visible in user profile searches. NOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions. Individual users and external applications should not call this API directly. Elastic reserves the right to change or remove this feature in future releases without prior notice. When you activate a user profile, its automatically enabled and visible in user profile searches. You can use the disable user profile API to disable a user profile so it’s not visible in these searches. To re-enable a disabled user profile, use the enable user profile API . | +| `disableUserProfile` | `disableUserProfile(this: [That](./That.md), params: [SecurityDisableUserProfileRequest](./SecurityDisableUserProfileRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityDisableUserProfileResponse](./SecurityDisableUserProfileResponse.md), unknown>>;` |   | +| `disableUserProfile` | `disableUserProfile(this: [That](./That.md), params: [SecurityDisableUserProfileRequest](./SecurityDisableUserProfileRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityDisableUserProfileResponse](./SecurityDisableUserProfileResponse.md)>;` |   | +| `enableUser` | `enableUser(this: [That](./That.md), params: [SecurityEnableUserRequest](./SecurityEnableUserRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityEnableUserResponse](./SecurityEnableUserResponse.md)>;` | Enable users. Enable users in the native realm. By default, when you create users, they are enabled. | +| `enableUser` | `enableUser(this: [That](./That.md), params: [SecurityEnableUserRequest](./SecurityEnableUserRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityEnableUserResponse](./SecurityEnableUserResponse.md), unknown>>;` |   | +| `enableUser` | `enableUser(this: [That](./That.md), params: [SecurityEnableUserRequest](./SecurityEnableUserRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityEnableUserResponse](./SecurityEnableUserResponse.md)>;` |   | +| `enableUserProfile` | `enableUserProfile(this: [That](./That.md), params: [SecurityEnableUserProfileRequest](./SecurityEnableUserProfileRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityEnableUserProfileResponse](./SecurityEnableUserProfileResponse.md)>;` | Enable a user profile. Enable user profiles to make them visible in user profile searches. NOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions. Individual users and external applications should not call this API directly. Elastic reserves the right to change or remove this feature in future releases without prior notice. When you activate a user profile, it's automatically enabled and visible in user profile searches. If you later disable the user profile, you can use the enable user profile API to make the profile visible in these searches again. | +| `enableUserProfile` | `enableUserProfile(this: [That](./That.md), params: [SecurityEnableUserProfileRequest](./SecurityEnableUserProfileRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityEnableUserProfileResponse](./SecurityEnableUserProfileResponse.md), unknown>>;` |   | +| `enableUserProfile` | `enableUserProfile(this: [That](./That.md), params: [SecurityEnableUserProfileRequest](./SecurityEnableUserProfileRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityEnableUserProfileResponse](./SecurityEnableUserProfileResponse.md)>;` |   | +| `enrollKibana` | `enrollKibana(this: [That](./That.md), params?: [SecurityEnrollKibanaRequest](./SecurityEnrollKibanaRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityEnrollKibanaResponse](./SecurityEnrollKibanaResponse.md)>;` | Enroll Kibana. Enable a Kibana instance to configure itself for communication with a secured Elasticsearch cluster. NOTE: This API is currently intended for internal use only by Kibana. Kibana uses this API internally to configure itself for communications with an Elasticsearch cluster that already has security features enabled. | +| `enrollKibana` | `enrollKibana(this: [That](./That.md), params?: [SecurityEnrollKibanaRequest](./SecurityEnrollKibanaRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityEnrollKibanaResponse](./SecurityEnrollKibanaResponse.md), unknown>>;` |   | +| `enrollKibana` | `enrollKibana(this: [That](./That.md), params?: [SecurityEnrollKibanaRequest](./SecurityEnrollKibanaRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityEnrollKibanaResponse](./SecurityEnrollKibanaResponse.md)>;` |   | +| `enrollNode` | `enrollNode(this: [That](./That.md), params?: [SecurityEnrollNodeRequest](./SecurityEnrollNodeRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityEnrollNodeResponse](./SecurityEnrollNodeResponse.md)>;` | Enroll a node. Enroll a new node to allow it to join an existing cluster with security features enabled. The response contains all the necessary information for the joining node to bootstrap discovery and security related settings so that it can successfully join the cluster. The response contains key and certificate material that allows the caller to generate valid signed certificates for the HTTP layer of all nodes in the cluster. | +| `enrollNode` | `enrollNode(this: [That](./That.md), params?: [SecurityEnrollNodeRequest](./SecurityEnrollNodeRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityEnrollNodeResponse](./SecurityEnrollNodeResponse.md), unknown>>;` |   | +| `enrollNode` | `enrollNode(this: [That](./That.md), params?: [SecurityEnrollNodeRequest](./SecurityEnrollNodeRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityEnrollNodeResponse](./SecurityEnrollNodeResponse.md)>;` |   | +| `getApiKey` | `getApiKey(this: [That](./That.md), params?: [SecurityGetApiKeyRequest](./SecurityGetApiKeyRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityGetApiKeyResponse](./SecurityGetApiKeyResponse.md)>;` | Get API key information. Retrieves information for one or more API keys. NOTE: If you have only the `manage_own_api_key` privilege, this API returns only the API keys that you own. If you have `read_security`, `manage_api_key` or greater privileges (including `manage_security`), this API returns all API keys regardless of ownership. | +| `getApiKey` | `getApiKey(this: [That](./That.md), params?: [SecurityGetApiKeyRequest](./SecurityGetApiKeyRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityGetApiKeyResponse](./SecurityGetApiKeyResponse.md), unknown>>;` |   | +| `getApiKey` | `getApiKey(this: [That](./That.md), params?: [SecurityGetApiKeyRequest](./SecurityGetApiKeyRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityGetApiKeyResponse](./SecurityGetApiKeyResponse.md)>;` |   | +| `getBuiltinPrivileges` | `getBuiltinPrivileges(this: [That](./That.md), params?: [SecurityGetBuiltinPrivilegesRequest](./SecurityGetBuiltinPrivilegesRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityGetBuiltinPrivilegesResponse](./SecurityGetBuiltinPrivilegesResponse.md)>;` | Get builtin privileges. Get the list of cluster privileges and index privileges that are available in this version of Elasticsearch. | +| `getBuiltinPrivileges` | `getBuiltinPrivileges(this: [That](./That.md), params?: [SecurityGetBuiltinPrivilegesRequest](./SecurityGetBuiltinPrivilegesRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityGetBuiltinPrivilegesResponse](./SecurityGetBuiltinPrivilegesResponse.md), unknown>>;` |   | +| `getBuiltinPrivileges` | `getBuiltinPrivileges(this: [That](./That.md), params?: [SecurityGetBuiltinPrivilegesRequest](./SecurityGetBuiltinPrivilegesRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityGetBuiltinPrivilegesResponse](./SecurityGetBuiltinPrivilegesResponse.md)>;` |   | +| `getPrivileges` | `getPrivileges(this: [That](./That.md), params?: [SecurityGetPrivilegesRequest](./SecurityGetPrivilegesRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityGetPrivilegesResponse](./SecurityGetPrivilegesResponse.md)>;` | Get application privileges. To use this API, you must have one of the following privileges: * The `read_security` cluster privilege (or a greater privilege such as `manage_security` or `all`). * The "Manage Application Privileges" global privilege for the application being referenced in the request. | +| `getPrivileges` | `getPrivileges(this: [That](./That.md), params?: [SecurityGetPrivilegesRequest](./SecurityGetPrivilegesRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityGetPrivilegesResponse](./SecurityGetPrivilegesResponse.md), unknown>>;` |   | +| `getPrivileges` | `getPrivileges(this: [That](./That.md), params?: [SecurityGetPrivilegesRequest](./SecurityGetPrivilegesRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityGetPrivilegesResponse](./SecurityGetPrivilegesResponse.md)>;` |   | +| `getRole` | `getRole(this: [That](./That.md), params?: [SecurityGetRoleRequest](./SecurityGetRoleRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityGetRoleResponse](./SecurityGetRoleResponse.md)>;` | Get roles. Get roles in the native realm. The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. The get roles API cannot retrieve roles that are defined in roles files. | +| `getRole` | `getRole(this: [That](./That.md), params?: [SecurityGetRoleRequest](./SecurityGetRoleRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityGetRoleResponse](./SecurityGetRoleResponse.md), unknown>>;` |   | +| `getRole` | `getRole(this: [That](./That.md), params?: [SecurityGetRoleRequest](./SecurityGetRoleRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityGetRoleResponse](./SecurityGetRoleResponse.md)>;` |   | +| `getRoleMapping` | `getRoleMapping(this: [That](./That.md), params?: [SecurityGetRoleMappingRequest](./SecurityGetRoleMappingRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityGetRoleMappingResponse](./SecurityGetRoleMappingResponse.md)>;` | Get role mappings. Role mappings define which roles are assigned to each user. The role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files. The get role mappings API cannot retrieve role mappings that are defined in role mapping files. | +| `getRoleMapping` | `getRoleMapping(this: [That](./That.md), params?: [SecurityGetRoleMappingRequest](./SecurityGetRoleMappingRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityGetRoleMappingResponse](./SecurityGetRoleMappingResponse.md), unknown>>;` |   | +| `getRoleMapping` | `getRoleMapping(this: [That](./That.md), params?: [SecurityGetRoleMappingRequest](./SecurityGetRoleMappingRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityGetRoleMappingResponse](./SecurityGetRoleMappingResponse.md)>;` |   | +| `getServiceAccounts` | `getServiceAccounts(this: [That](./That.md), params?: [SecurityGetServiceAccountsRequest](./SecurityGetServiceAccountsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityGetServiceAccountsResponse](./SecurityGetServiceAccountsResponse.md)>;` | Get service accounts. Get a list of service accounts that match the provided path parameters. NOTE: Currently, only the `elastic/fleet-server` service account is available. | +| `getServiceAccounts` | `getServiceAccounts(this: [That](./That.md), params?: [SecurityGetServiceAccountsRequest](./SecurityGetServiceAccountsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityGetServiceAccountsResponse](./SecurityGetServiceAccountsResponse.md), unknown>>;` |   | +| `getServiceAccounts` | `getServiceAccounts(this: [That](./That.md), params?: [SecurityGetServiceAccountsRequest](./SecurityGetServiceAccountsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityGetServiceAccountsResponse](./SecurityGetServiceAccountsResponse.md)>;` |   | +| `getServiceCredentials` | `getServiceCredentials(this: [That](./That.md), params: [SecurityGetServiceCredentialsRequest](./SecurityGetServiceCredentialsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityGetServiceCredentialsResponse](./SecurityGetServiceCredentialsResponse.md)>;` | Get service account credentials. To use this API, you must have at least the `read_security` cluster privilege (or a greater privilege such as `manage_service_account` or `manage_security`). The response includes service account tokens that were created with the create service account tokens API as well as file-backed tokens from all nodes of the cluster. NOTE: For tokens backed by the `service_tokens` file, the API collects them from all nodes of the cluster. Tokens with the same name from different nodes are assumed to be the same token and are only counted once towards the total number of service tokens. | +| `getServiceCredentials` | `getServiceCredentials(this: [That](./That.md), params: [SecurityGetServiceCredentialsRequest](./SecurityGetServiceCredentialsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityGetServiceCredentialsResponse](./SecurityGetServiceCredentialsResponse.md), unknown>>;` |   | +| `getServiceCredentials` | `getServiceCredentials(this: [That](./That.md), params: [SecurityGetServiceCredentialsRequest](./SecurityGetServiceCredentialsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityGetServiceCredentialsResponse](./SecurityGetServiceCredentialsResponse.md)>;` |   | +| `getSettings` | `getSettings(this: [That](./That.md), params?: [SecurityGetSettingsRequest](./SecurityGetSettingsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityGetSettingsResponse](./SecurityGetSettingsResponse.md)>;` | Get security index settings. Get the user-configurable settings for the security internal index ( `.security` and associated indices). Only a subset of the index settings — those that are user-configurable—will be shown. This includes: * `index.auto_expand_replicas` * `index.number_of_replicas` | +| `getSettings` | `getSettings(this: [That](./That.md), params?: [SecurityGetSettingsRequest](./SecurityGetSettingsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityGetSettingsResponse](./SecurityGetSettingsResponse.md), unknown>>;` |   | +| `getSettings` | `getSettings(this: [That](./That.md), params?: [SecurityGetSettingsRequest](./SecurityGetSettingsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityGetSettingsResponse](./SecurityGetSettingsResponse.md)>;` |   | +| `getToken` | `getToken(this: [That](./That.md), params?: [SecurityGetTokenRequest](./SecurityGetTokenRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityGetTokenResponse](./SecurityGetTokenResponse.md)>;` | Get a token. Create a bearer token for access without requiring basic authentication. The tokens are created by the Elasticsearch Token Service, which is automatically enabled when you configure TLS on the HTTP interface. Alternatively, you can explicitly enable the `xpack.security.authc.token.enabled` setting. When you are running in production mode, a bootstrap check prevents you from enabling the token service unless you also enable TLS on the HTTP interface. The get token API takes the same parameters as a typical OAuth 2.0 token API except for the use of a JSON request body. A successful get token API call returns a JSON structure that contains the access token, the amount of time (seconds) that the token expires in, the type, and the scope if available. The tokens returned by the get token API have a finite period of time for which they are valid and after that time period, they can no longer be used. That time period is defined by the `xpack.security.authc.token.timeout` setting. If you want to invalidate a token immediately, you can do so by using the invalidate token API. | +| `getToken` | `getToken(this: [That](./That.md), params?: [SecurityGetTokenRequest](./SecurityGetTokenRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityGetTokenResponse](./SecurityGetTokenResponse.md), unknown>>;` |   | +| `getToken` | `getToken(this: [That](./That.md), params?: [SecurityGetTokenRequest](./SecurityGetTokenRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityGetTokenResponse](./SecurityGetTokenResponse.md)>;` |   | +| `getUser` | `getUser(this: [That](./That.md), params?: [SecurityGetUserRequest](./SecurityGetUserRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityGetUserResponse](./SecurityGetUserResponse.md)>;` | Get users. Get information about users in the native realm and built-in users. | +| `getUser` | `getUser(this: [That](./That.md), params?: [SecurityGetUserRequest](./SecurityGetUserRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityGetUserResponse](./SecurityGetUserResponse.md), unknown>>;` |   | +| `getUser` | `getUser(this: [That](./That.md), params?: [SecurityGetUserRequest](./SecurityGetUserRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityGetUserResponse](./SecurityGetUserResponse.md)>;` |   | +| `getUserPrivileges` | `getUserPrivileges(this: [That](./That.md), params?: [SecurityGetUserPrivilegesRequest](./SecurityGetUserPrivilegesRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityGetUserPrivilegesResponse](./SecurityGetUserPrivilegesResponse.md)>;` | Get user privileges. Get the security privileges for the logged in user. All users can use this API, but only to determine their own privileges. To check the privileges of other users, you must use the run as feature. To check whether a user has a specific list of privileges, use the has privileges API. | +| `getUserPrivileges` | `getUserPrivileges(this: [That](./That.md), params?: [SecurityGetUserPrivilegesRequest](./SecurityGetUserPrivilegesRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityGetUserPrivilegesResponse](./SecurityGetUserPrivilegesResponse.md), unknown>>;` |   | +| `getUserPrivileges` | `getUserPrivileges(this: [That](./That.md), params?: [SecurityGetUserPrivilegesRequest](./SecurityGetUserPrivilegesRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityGetUserPrivilegesResponse](./SecurityGetUserPrivilegesResponse.md)>;` |   | +| `getUserProfile` | `getUserProfile(this: [That](./That.md), params: [SecurityGetUserProfileRequest](./SecurityGetUserProfileRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityGetUserProfileResponse](./SecurityGetUserProfileResponse.md)>;` | Get a user profile. Get a user's profile using the unique profile ID. NOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions. Individual users and external applications should not call this API directly. Elastic reserves the right to change or remove this feature in future releases without prior notice. | +| `getUserProfile` | `getUserProfile(this: [That](./That.md), params: [SecurityGetUserProfileRequest](./SecurityGetUserProfileRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityGetUserProfileResponse](./SecurityGetUserProfileResponse.md), unknown>>;` |   | +| `getUserProfile` | `getUserProfile(this: [That](./That.md), params: [SecurityGetUserProfileRequest](./SecurityGetUserProfileRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityGetUserProfileResponse](./SecurityGetUserProfileResponse.md)>;` |   | +| `grantApiKey` | `grantApiKey(this: [That](./That.md), params: [SecurityGrantApiKeyRequest](./SecurityGrantApiKeyRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityGrantApiKeyResponse](./SecurityGrantApiKeyResponse.md)>;` | Grant an API key. Create an API key on behalf of another user. This API is similar to the create API keys API, however it creates the API key for a user that is different than the user that runs the API. The caller must have authentication credentials for the user on whose behalf the API key will be created. It is not possible to use this API to create an API key without that user's credentials. The supported user authentication credential types are: * username and password * Elasticsearch access tokens * JWTs The user, for whom the authentication credentials is provided, can optionally "run as" (impersonate) another user. In this case, the API key will be created on behalf of the impersonated user. This API is intended be used by applications that need to create and manage API keys for end users, but cannot guarantee that those users have permission to create API keys on their own behalf. The API keys are created by the Elasticsearch API key service, which is automatically enabled. A successful grant API key API call returns a JSON structure that contains the API key, its unique id, and its name. If applicable, it also returns expiration information for the API key in milliseconds. By default, API keys never expire. You can specify expiration information when you create the API keys. | +| `grantApiKey` | `grantApiKey(this: [That](./That.md), params: [SecurityGrantApiKeyRequest](./SecurityGrantApiKeyRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityGrantApiKeyResponse](./SecurityGrantApiKeyResponse.md), unknown>>;` |   | +| `grantApiKey` | `grantApiKey(this: [That](./That.md), params: [SecurityGrantApiKeyRequest](./SecurityGrantApiKeyRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityGrantApiKeyResponse](./SecurityGrantApiKeyResponse.md)>;` |   | +| `hasPrivileges` | `hasPrivileges(this: [That](./That.md), params?: [SecurityHasPrivilegesRequest](./SecurityHasPrivilegesRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityHasPrivilegesResponse](./SecurityHasPrivilegesResponse.md)>;` | Check user privileges. Determine whether the specified user has a specified list of privileges. All users can use this API, but only to determine their own privileges. To check the privileges of other users, you must use the run as feature. | +| `hasPrivileges` | `hasPrivileges(this: [That](./That.md), params?: [SecurityHasPrivilegesRequest](./SecurityHasPrivilegesRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityHasPrivilegesResponse](./SecurityHasPrivilegesResponse.md), unknown>>;` |   | +| `hasPrivileges` | `hasPrivileges(this: [That](./That.md), params?: [SecurityHasPrivilegesRequest](./SecurityHasPrivilegesRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityHasPrivilegesResponse](./SecurityHasPrivilegesResponse.md)>;` |   | +| `hasPrivilegesUserProfile` | `hasPrivilegesUserProfile(this: [That](./That.md), params: [SecurityHasPrivilegesUserProfileRequest](./SecurityHasPrivilegesUserProfileRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityHasPrivilegesUserProfileResponse](./SecurityHasPrivilegesUserProfileResponse.md)>;` | Check user profile privileges. Determine whether the users associated with the specified user profile IDs have all the requested privileges. NOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions. Individual users and external applications should not call this API directly. Elastic reserves the right to change or remove this feature in future releases without prior notice. | +| `hasPrivilegesUserProfile` | `hasPrivilegesUserProfile(this: [That](./That.md), params: [SecurityHasPrivilegesUserProfileRequest](./SecurityHasPrivilegesUserProfileRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityHasPrivilegesUserProfileResponse](./SecurityHasPrivilegesUserProfileResponse.md), unknown>>;` |   | +| `hasPrivilegesUserProfile` | `hasPrivilegesUserProfile(this: [That](./That.md), params: [SecurityHasPrivilegesUserProfileRequest](./SecurityHasPrivilegesUserProfileRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityHasPrivilegesUserProfileResponse](./SecurityHasPrivilegesUserProfileResponse.md)>;` |   | +| `invalidateApiKey` | `invalidateApiKey(this: [That](./That.md), params?: [SecurityInvalidateApiKeyRequest](./SecurityInvalidateApiKeyRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityInvalidateApiKeyResponse](./SecurityInvalidateApiKeyResponse.md)>;` | Invalidate API keys. This API invalidates API keys created by the create API key or grant API key APIs. Invalidated API keys fail authentication, but they can still be viewed using the get API key information and query API key information APIs, for at least the configured retention period, until they are automatically deleted. To use this API, you must have at least the `manage_security`, `manage_api_key`, or `manage_own_api_key` cluster privileges. The `manage_security` privilege allows deleting any API key, including both REST and cross cluster API keys. The `manage_api_key` privilege allows deleting any REST API key, but not cross cluster API keys. The `manage_own_api_key` only allows deleting REST API keys that are owned by the user. In addition, with the `manage_own_api_key` privilege, an invalidation request must be issued in one of the three formats: - Set the parameter `owner=true`. - Or, set both `username` and `realm_name` to match the user's identity. - Or, if the request is issued by an API key, that is to say an API key invalidates itself, specify its ID in the `ids` field. | +| `invalidateApiKey` | `invalidateApiKey(this: [That](./That.md), params?: [SecurityInvalidateApiKeyRequest](./SecurityInvalidateApiKeyRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityInvalidateApiKeyResponse](./SecurityInvalidateApiKeyResponse.md), unknown>>;` |   | +| `invalidateApiKey` | `invalidateApiKey(this: [That](./That.md), params?: [SecurityInvalidateApiKeyRequest](./SecurityInvalidateApiKeyRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityInvalidateApiKeyResponse](./SecurityInvalidateApiKeyResponse.md)>;` |   | +| `invalidateToken` | `invalidateToken(this: [That](./That.md), params?: [SecurityInvalidateTokenRequest](./SecurityInvalidateTokenRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityInvalidateTokenResponse](./SecurityInvalidateTokenResponse.md)>;` | Invalidate a token. The access tokens returned by the get token API have a finite period of time for which they are valid. After that time period, they can no longer be used. The time period is defined by the `xpack.security.authc.token.timeout` setting. The refresh tokens returned by the get token API are only valid for 24 hours. They can also be used exactly once. If you want to invalidate one or more access or refresh tokens immediately, use this invalidate token API. NOTE: While all parameters are optional, at least one of them is required. More specifically, either one of `token` or `refresh_token` parameters is required. If none of these two are specified, then `realm_name` and/or `username` need to be specified. | +| `invalidateToken` | `invalidateToken(this: [That](./That.md), params?: [SecurityInvalidateTokenRequest](./SecurityInvalidateTokenRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityInvalidateTokenResponse](./SecurityInvalidateTokenResponse.md), unknown>>;` |   | +| `invalidateToken` | `invalidateToken(this: [That](./That.md), params?: [SecurityInvalidateTokenRequest](./SecurityInvalidateTokenRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityInvalidateTokenResponse](./SecurityInvalidateTokenResponse.md)>;` |   | +| `oidcAuthenticate` | `oidcAuthenticate(this: [That](./That.md), params: [SecurityOidcAuthenticateRequest](./SecurityOidcAuthenticateRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityOidcAuthenticateResponse](./SecurityOidcAuthenticateResponse.md)>;` | Authenticate OpenID Connect. Exchange an OpenID Connect authentication response message for an Elasticsearch internal access token and refresh token that can be subsequently used for authentication. Elasticsearch exposes all the necessary OpenID Connect related functionality with the OpenID Connect APIs. These APIs are used internally by Kibana in order to provide OpenID Connect based authentication, but can also be used by other, custom web applications or other clients. | +| `oidcAuthenticate` | `oidcAuthenticate(this: [That](./That.md), params: [SecurityOidcAuthenticateRequest](./SecurityOidcAuthenticateRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityOidcAuthenticateResponse](./SecurityOidcAuthenticateResponse.md), unknown>>;` |   | +| `oidcAuthenticate` | `oidcAuthenticate(this: [That](./That.md), params: [SecurityOidcAuthenticateRequest](./SecurityOidcAuthenticateRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityOidcAuthenticateResponse](./SecurityOidcAuthenticateResponse.md)>;` |   | +| `oidcLogout` | `oidcLogout(this: [That](./That.md), params: [SecurityOidcLogoutRequest](./SecurityOidcLogoutRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityOidcLogoutResponse](./SecurityOidcLogoutResponse.md)>;` | Logout of OpenID Connect. Invalidate an access token and a refresh token that were generated as a response to the `/_security/oidc/authenticate` API. If the OpenID Connect authentication realm in Elasticsearch is accordingly configured, the response to this call will contain a URI pointing to the end session endpoint of the OpenID Connect Provider in order to perform single logout. Elasticsearch exposes all the necessary OpenID Connect related functionality with the OpenID Connect APIs. These APIs are used internally by Kibana in order to provide OpenID Connect based authentication, but can also be used by other, custom web applications or other clients. | +| `oidcLogout` | `oidcLogout(this: [That](./That.md), params: [SecurityOidcLogoutRequest](./SecurityOidcLogoutRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityOidcLogoutResponse](./SecurityOidcLogoutResponse.md), unknown>>;` |   | +| `oidcLogout` | `oidcLogout(this: [That](./That.md), params: [SecurityOidcLogoutRequest](./SecurityOidcLogoutRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityOidcLogoutResponse](./SecurityOidcLogoutResponse.md)>;` |   | +| `oidcPrepareAuthentication` | `oidcPrepareAuthentication(this: [That](./That.md), params?: [SecurityOidcPrepareAuthenticationRequest](./SecurityOidcPrepareAuthenticationRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityOidcPrepareAuthenticationResponse](./SecurityOidcPrepareAuthenticationResponse.md)>;` | Prepare OpenID connect authentication. Create an oAuth 2.0 authentication request as a URL string based on the configuration of the OpenID Connect authentication realm in Elasticsearch. The response of this API is a URL pointing to the Authorization Endpoint of the configured OpenID Connect Provider, which can be used to redirect the browser of the user in order to continue the authentication process. Elasticsearch exposes all the necessary OpenID Connect related functionality with the OpenID Connect APIs. These APIs are used internally by Kibana in order to provide OpenID Connect based authentication, but can also be used by other, custom web applications or other clients. | +| `oidcPrepareAuthentication` | `oidcPrepareAuthentication(this: [That](./That.md), params?: [SecurityOidcPrepareAuthenticationRequest](./SecurityOidcPrepareAuthenticationRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityOidcPrepareAuthenticationResponse](./SecurityOidcPrepareAuthenticationResponse.md), unknown>>;` |   | +| `oidcPrepareAuthentication` | `oidcPrepareAuthentication(this: [That](./That.md), params?: [SecurityOidcPrepareAuthenticationRequest](./SecurityOidcPrepareAuthenticationRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityOidcPrepareAuthenticationResponse](./SecurityOidcPrepareAuthenticationResponse.md)>;` |   | +| `putPrivileges` | `putPrivileges(this: [That](./That.md), params: [SecurityPutPrivilegesRequest](./SecurityPutPrivilegesRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityPutPrivilegesResponse](./SecurityPutPrivilegesResponse.md)>;` | Create or update application privileges. To use this API, you must have one of the following privileges: * The `manage_security` cluster privilege (or a greater privilege such as `all`). * The "Manage Application Privileges" global privilege for the application being referenced in the request. Application names are formed from a prefix, with an optional suffix that conform to the following rules: * The prefix must begin with a lowercase ASCII letter. * The prefix must contain only ASCII letters or digits. * The prefix must be at least 3 characters long. * If the suffix exists, it must begin with either a dash `-` or `_`. * The suffix cannot contain any of the following characters: `\`, `/`, `*`, `?`, `"`, `<`, `>`, `|`, `,`, `*`. * No part of the name can contain whitespace. Privilege names must begin with a lowercase ASCII letter and must contain only ASCII letters and digits along with the characters `_`, `-`, and `.`. Action names can contain any number of printable ASCII characters and must contain at least one of the following characters: `/`, `*`, `:`. | +| `putPrivileges` | `putPrivileges(this: [That](./That.md), params: [SecurityPutPrivilegesRequest](./SecurityPutPrivilegesRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityPutPrivilegesResponse](./SecurityPutPrivilegesResponse.md), unknown>>;` |   | +| `putPrivileges` | `putPrivileges(this: [That](./That.md), params: [SecurityPutPrivilegesRequest](./SecurityPutPrivilegesRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityPutPrivilegesResponse](./SecurityPutPrivilegesResponse.md)>;` |   | +| `putRole` | `putRole(this: [That](./That.md), params: [SecurityPutRoleRequest](./SecurityPutRoleRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityPutRoleResponse](./SecurityPutRoleResponse.md)>;` | Create or update roles. The role management APIs are generally the preferred way to manage roles in the native realm, rather than using file-based role management. The create or update roles API cannot update roles that are defined in roles files. File-based role management is not available in Elastic Serverless. | +| `putRole` | `putRole(this: [That](./That.md), params: [SecurityPutRoleRequest](./SecurityPutRoleRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityPutRoleResponse](./SecurityPutRoleResponse.md), unknown>>;` |   | +| `putRole` | `putRole(this: [That](./That.md), params: [SecurityPutRoleRequest](./SecurityPutRoleRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityPutRoleResponse](./SecurityPutRoleResponse.md)>;` |   | +| `putRoleMapping` | `putRoleMapping(this: [That](./That.md), params: [SecurityPutRoleMappingRequest](./SecurityPutRoleMappingRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityPutRoleMappingResponse](./SecurityPutRoleMappingResponse.md)>;` | Create or update role mappings. Role mappings define which roles are assigned to each user. Each mapping has rules that identify users and a list of roles that are granted to those users. The role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files. The create or update role mappings API cannot update role mappings that are defined in role mapping files. NOTE: This API does not create roles. Rather, it maps users to existing roles. Roles can be created by using the create or update roles API or roles files. **Role templates** The most common use for role mappings is to create a mapping from a known value on the user to a fixed role name. For example, all users in the `cn=admin,dc=example,dc=com` LDAP group should be given the superuser role in Elasticsearch. The `roles` field is used for this purpose. For more complex needs, it is possible to use Mustache templates to dynamically determine the names of the roles that should be granted to the user. The `role_templates` field is used for this purpose. NOTE: To use role templates successfully, the relevant scripting feature must be enabled. Otherwise, all attempts to create a role mapping with role templates fail. All of the user fields that are available in the role mapping rules are also available in the role templates. Thus it is possible to assign a user to a role that reflects their username, their groups, or the name of the realm to which they authenticated. By default a template is evaluated to produce a single string that is the name of the role which should be assigned to the user. If the format of the template is set to "json" then the template is expected to produce a JSON string or an array of JSON strings for the role names. | +| `putRoleMapping` | `putRoleMapping(this: [That](./That.md), params: [SecurityPutRoleMappingRequest](./SecurityPutRoleMappingRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityPutRoleMappingResponse](./SecurityPutRoleMappingResponse.md), unknown>>;` |   | +| `putRoleMapping` | `putRoleMapping(this: [That](./That.md), params: [SecurityPutRoleMappingRequest](./SecurityPutRoleMappingRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityPutRoleMappingResponse](./SecurityPutRoleMappingResponse.md)>;` |   | +| `putUser` | `putUser(this: [That](./That.md), params: [SecurityPutUserRequest](./SecurityPutUserRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityPutUserResponse](./SecurityPutUserResponse.md)>;` | Create or update users. Add and update users in the native realm. A password is required for adding a new user but is optional when updating an existing user. To change a user's password without updating any other fields, use the change password API. | +| `putUser` | `putUser(this: [That](./That.md), params: [SecurityPutUserRequest](./SecurityPutUserRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityPutUserResponse](./SecurityPutUserResponse.md), unknown>>;` |   | +| `putUser` | `putUser(this: [That](./That.md), params: [SecurityPutUserRequest](./SecurityPutUserRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityPutUserResponse](./SecurityPutUserResponse.md)>;` |   | +| `queryApiKeys` | `queryApiKeys(this: [That](./That.md), params?: [SecurityQueryApiKeysRequest](./SecurityQueryApiKeysRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityQueryApiKeysResponse](./SecurityQueryApiKeysResponse.md)>;` | Find API keys with a query. Get a paginated list of API keys and their information. You can optionally filter the results with a query. To use this API, you must have at least the `manage_own_api_key` or the `read_security` cluster privileges. If you have only the `manage_own_api_key` privilege, this API returns only the API keys that you own. If you have the `read_security`, `manage_api_key`, or greater privileges (including `manage_security`), this API returns all API keys regardless of ownership. | +| `queryApiKeys` | `queryApiKeys(this: [That](./That.md), params?: [SecurityQueryApiKeysRequest](./SecurityQueryApiKeysRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityQueryApiKeysResponse](./SecurityQueryApiKeysResponse.md), unknown>>;` |   | +| `queryApiKeys` | `queryApiKeys(this: [That](./That.md), params?: [SecurityQueryApiKeysRequest](./SecurityQueryApiKeysRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityQueryApiKeysResponse](./SecurityQueryApiKeysResponse.md)>;` |   | +| `queryRole` | `queryRole(this: [That](./That.md), params?: [SecurityQueryRoleRequest](./SecurityQueryRoleRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityQueryRoleResponse](./SecurityQueryRoleResponse.md)>;` | Find roles with a query. Get roles in a paginated manner. The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. The query roles API does not retrieve roles that are defined in roles files, nor built-in ones. You can optionally filter the results with a query. Also, the results can be paginated and sorted. | +| `queryRole` | `queryRole(this: [That](./That.md), params?: [SecurityQueryRoleRequest](./SecurityQueryRoleRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityQueryRoleResponse](./SecurityQueryRoleResponse.md), unknown>>;` |   | +| `queryRole` | `queryRole(this: [That](./That.md), params?: [SecurityQueryRoleRequest](./SecurityQueryRoleRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityQueryRoleResponse](./SecurityQueryRoleResponse.md)>;` |   | +| `queryUser` | `queryUser(this: [That](./That.md), params?: [SecurityQueryUserRequest](./SecurityQueryUserRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityQueryUserResponse](./SecurityQueryUserResponse.md)>;` | Find users with a query. Get information for users in a paginated manner. You can optionally filter the results with a query. NOTE: As opposed to the get user API, built-in users are excluded from the result. This API is only for native users. | +| `queryUser` | `queryUser(this: [That](./That.md), params?: [SecurityQueryUserRequest](./SecurityQueryUserRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityQueryUserResponse](./SecurityQueryUserResponse.md), unknown>>;` |   | +| `queryUser` | `queryUser(this: [That](./That.md), params?: [SecurityQueryUserRequest](./SecurityQueryUserRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityQueryUserResponse](./SecurityQueryUserResponse.md)>;` |   | +| `samlAuthenticate` | `samlAuthenticate(this: [That](./That.md), params: [SecuritySamlAuthenticateRequest](./SecuritySamlAuthenticateRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecuritySamlAuthenticateResponse](./SecuritySamlAuthenticateResponse.md)>;` | Authenticate SAML. Submit a SAML response message to Elasticsearch for consumption. NOTE: This API is intended for use by custom web applications other than Kibana. If you are using Kibana, refer to the documentation for configuring SAML single-sign-on on the Elastic Stack. The SAML message that is submitted can be: * A response to a SAML authentication request that was previously created using the SAML prepare authentication API. * An unsolicited SAML message in the case of an IdP-initiated single sign-on (SSO) flow. In either case, the SAML message needs to be a base64 encoded XML document with a root element of ``. After successful validation, Elasticsearch responds with an Elasticsearch internal access token and refresh token that can be subsequently used for authentication. This API endpoint essentially exchanges SAML responses that indicate successful authentication in the IdP for Elasticsearch access and refresh tokens, which can be used for authentication against Elasticsearch. | +| `samlAuthenticate` | `samlAuthenticate(this: [That](./That.md), params: [SecuritySamlAuthenticateRequest](./SecuritySamlAuthenticateRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecuritySamlAuthenticateResponse](./SecuritySamlAuthenticateResponse.md), unknown>>;` |   | +| `samlAuthenticate` | `samlAuthenticate(this: [That](./That.md), params: [SecuritySamlAuthenticateRequest](./SecuritySamlAuthenticateRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecuritySamlAuthenticateResponse](./SecuritySamlAuthenticateResponse.md)>;` |   | +| `samlCompleteLogout` | `samlCompleteLogout(this: [That](./That.md), params: [SecuritySamlCompleteLogoutRequest](./SecuritySamlCompleteLogoutRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecuritySamlCompleteLogoutResponse](./SecuritySamlCompleteLogoutResponse.md)>;` | Logout of SAML completely. Verifies the logout response sent from the SAML IdP. NOTE: This API is intended for use by custom web applications other than Kibana. If you are using Kibana, refer to the documentation for configuring SAML single-sign-on on the Elastic Stack. The SAML IdP may send a logout response back to the SP after handling the SP-initiated SAML Single Logout. This API verifies the response by ensuring the content is relevant and validating its signature. An empty response is returned if the verification process is successful. The response can be sent by the IdP with either the HTTP-Redirect or the HTTP-Post binding. The caller of this API must prepare the request accordingly so that this API can handle either of them. | +| `samlCompleteLogout` | `samlCompleteLogout(this: [That](./That.md), params: [SecuritySamlCompleteLogoutRequest](./SecuritySamlCompleteLogoutRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecuritySamlCompleteLogoutResponse](./SecuritySamlCompleteLogoutResponse.md), unknown>>;` |   | +| `samlCompleteLogout` | `samlCompleteLogout(this: [That](./That.md), params: [SecuritySamlCompleteLogoutRequest](./SecuritySamlCompleteLogoutRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecuritySamlCompleteLogoutResponse](./SecuritySamlCompleteLogoutResponse.md)>;` |   | +| `samlInvalidate` | `samlInvalidate(this: [That](./That.md), params: [SecuritySamlInvalidateRequest](./SecuritySamlInvalidateRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecuritySamlInvalidateResponse](./SecuritySamlInvalidateResponse.md)>;` | Invalidate SAML. Submit a SAML LogoutRequest message to Elasticsearch for consumption. NOTE: This API is intended for use by custom web applications other than Kibana. If you are using Kibana, refer to the documentation for configuring SAML single-sign-on on the Elastic Stack. The logout request comes from the SAML IdP during an IdP initiated Single Logout. The custom web application can use this API to have Elasticsearch process the `LogoutRequest`. After successful validation of the request, Elasticsearch invalidates the access token and refresh token that corresponds to that specific SAML principal and provides a URL that contains a SAML LogoutResponse message. Thus the user can be redirected back to their IdP. | +| `samlInvalidate` | `samlInvalidate(this: [That](./That.md), params: [SecuritySamlInvalidateRequest](./SecuritySamlInvalidateRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecuritySamlInvalidateResponse](./SecuritySamlInvalidateResponse.md), unknown>>;` |   | +| `samlInvalidate` | `samlInvalidate(this: [That](./That.md), params: [SecuritySamlInvalidateRequest](./SecuritySamlInvalidateRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecuritySamlInvalidateResponse](./SecuritySamlInvalidateResponse.md)>;` |   | +| `samlLogout` | `samlLogout(this: [That](./That.md), params: [SecuritySamlLogoutRequest](./SecuritySamlLogoutRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecuritySamlLogoutResponse](./SecuritySamlLogoutResponse.md)>;` | Logout of SAML. Submits a request to invalidate an access token and refresh token. NOTE: This API is intended for use by custom web applications other than Kibana. If you are using Kibana, refer to the documentation for configuring SAML single-sign-on on the Elastic Stack. This API invalidates the tokens that were generated for a user by the SAML authenticate API. If the SAML realm in Elasticsearch is configured accordingly and the SAML IdP supports this, the Elasticsearch response contains a URL to redirect the user to the IdP that contains a SAML logout request (starting an SP-initiated SAML Single Logout). | +| `samlLogout` | `samlLogout(this: [That](./That.md), params: [SecuritySamlLogoutRequest](./SecuritySamlLogoutRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecuritySamlLogoutResponse](./SecuritySamlLogoutResponse.md), unknown>>;` |   | +| `samlLogout` | `samlLogout(this: [That](./That.md), params: [SecuritySamlLogoutRequest](./SecuritySamlLogoutRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecuritySamlLogoutResponse](./SecuritySamlLogoutResponse.md)>;` |   | +| `samlPrepareAuthentication` | `samlPrepareAuthentication(this: [That](./That.md), params?: [SecuritySamlPrepareAuthenticationRequest](./SecuritySamlPrepareAuthenticationRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecuritySamlPrepareAuthenticationResponse](./SecuritySamlPrepareAuthenticationResponse.md)>;` | Prepare SAML authentication. Create a SAML authentication request ( ``) as a URL string based on the configuration of the respective SAML realm in Elasticsearch. NOTE: This API is intended for use by custom web applications other than Kibana. If you are using Kibana, refer to the documentation for configuring SAML single-sign-on on the Elastic Stack. This API returns a URL pointing to the SAML Identity Provider. You can use the URL to redirect the browser of the user in order to continue the authentication process. The URL includes a single parameter named `SAMLRequest`, which contains a SAML Authentication request that is deflated and Base64 encoded. If the configuration dictates that SAML authentication requests should be signed, the URL has two extra parameters named `SigAlg` and `Signature`. These parameters contain the algorithm used for the signature and the signature value itself. It also returns a random string that uniquely identifies this SAML Authentication request. The caller of this API needs to store this identifier as it needs to be used in a following step of the authentication process. | +| `samlPrepareAuthentication` | `samlPrepareAuthentication(this: [That](./That.md), params?: [SecuritySamlPrepareAuthenticationRequest](./SecuritySamlPrepareAuthenticationRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecuritySamlPrepareAuthenticationResponse](./SecuritySamlPrepareAuthenticationResponse.md), unknown>>;` |   | +| `samlPrepareAuthentication` | `samlPrepareAuthentication(this: [That](./That.md), params?: [SecuritySamlPrepareAuthenticationRequest](./SecuritySamlPrepareAuthenticationRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecuritySamlPrepareAuthenticationResponse](./SecuritySamlPrepareAuthenticationResponse.md)>;` |   | +| `samlServiceProviderMetadata` | `samlServiceProviderMetadata(this: [That](./That.md), params: [SecuritySamlServiceProviderMetadataRequest](./SecuritySamlServiceProviderMetadataRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecuritySamlServiceProviderMetadataResponse](./SecuritySamlServiceProviderMetadataResponse.md)>;` | Create SAML service provider metadata. Generate SAML metadata for a SAML 2.0 Service Provider. The SAML 2.0 specification provides a mechanism for Service Providers to describe their capabilities and configuration using a metadata file. This API generates Service Provider metadata based on the configuration of a SAML realm in Elasticsearch. | +| `samlServiceProviderMetadata` | `samlServiceProviderMetadata(this: [That](./That.md), params: [SecuritySamlServiceProviderMetadataRequest](./SecuritySamlServiceProviderMetadataRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecuritySamlServiceProviderMetadataResponse](./SecuritySamlServiceProviderMetadataResponse.md), unknown>>;` |   | +| `samlServiceProviderMetadata` | `samlServiceProviderMetadata(this: [That](./That.md), params: [SecuritySamlServiceProviderMetadataRequest](./SecuritySamlServiceProviderMetadataRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecuritySamlServiceProviderMetadataResponse](./SecuritySamlServiceProviderMetadataResponse.md)>;` |   | +| `suggestUserProfiles` | `suggestUserProfiles(this: [That](./That.md), params?: [SecuritySuggestUserProfilesRequest](./SecuritySuggestUserProfilesRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecuritySuggestUserProfilesResponse](./SecuritySuggestUserProfilesResponse.md)>;` | Suggest a user profile. Get suggestions for user profiles that match specified search criteria. NOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions. Individual users and external applications should not call this API directly. Elastic reserves the right to change or remove this feature in future releases without prior notice. | +| `suggestUserProfiles` | `suggestUserProfiles(this: [That](./That.md), params?: [SecuritySuggestUserProfilesRequest](./SecuritySuggestUserProfilesRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecuritySuggestUserProfilesResponse](./SecuritySuggestUserProfilesResponse.md), unknown>>;` |   | +| `suggestUserProfiles` | `suggestUserProfiles(this: [That](./That.md), params?: [SecuritySuggestUserProfilesRequest](./SecuritySuggestUserProfilesRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecuritySuggestUserProfilesResponse](./SecuritySuggestUserProfilesResponse.md)>;` |   | +| `updateApiKey` | `updateApiKey(this: [That](./That.md), params: [SecurityUpdateApiKeyRequest](./SecurityUpdateApiKeyRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityUpdateApiKeyResponse](./SecurityUpdateApiKeyResponse.md)>;` | Update an API key. Update attributes of an existing API key. This API supports updates to an API key's access scope, expiration, and metadata. To use this API, you must have at least the `manage_own_api_key` cluster privilege. Users can only update API keys that they created or that were granted to them. To update another user’s API key, use the `run_as` feature to submit a request on behalf of another user. IMPORTANT: It's not possible to use an API key as the authentication credential for this API. The owner user’s credentials are required. Use this API to update API keys created by the create API key or grant API Key APIs. If you need to apply the same update to many API keys, you can use the bulk update API keys API to reduce overhead. It's not possible to update expired API keys or API keys that have been invalidated by the invalidate API key API. The access scope of an API key is derived from the `role_descriptors` you specify in the request and a snapshot of the owner user's permissions at the time of the request. The snapshot of the owner's permissions is updated automatically on every call. IMPORTANT: If you don't specify `role_descriptors` in the request, a call to this API might still change the API key's access scope. This change can occur if the owner user's permissions have changed since the API key was created or last modified. | +| `updateApiKey` | `updateApiKey(this: [That](./That.md), params: [SecurityUpdateApiKeyRequest](./SecurityUpdateApiKeyRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityUpdateApiKeyResponse](./SecurityUpdateApiKeyResponse.md), unknown>>;` |   | +| `updateApiKey` | `updateApiKey(this: [That](./That.md), params: [SecurityUpdateApiKeyRequest](./SecurityUpdateApiKeyRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityUpdateApiKeyResponse](./SecurityUpdateApiKeyResponse.md)>;` |   | +| `updateCrossClusterApiKey` | `updateCrossClusterApiKey(this: [That](./That.md), params: [SecurityUpdateCrossClusterApiKeyRequest](./SecurityUpdateCrossClusterApiKeyRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityUpdateCrossClusterApiKeyResponse](./SecurityUpdateCrossClusterApiKeyResponse.md)>;` | Update a cross-cluster API key. Update the attributes of an existing cross-cluster API key, which is used for API key based remote cluster access. To use this API, you must have at least the `manage_security` cluster privilege. Users can only update API keys that they created. To update another user's API key, use the `run_as` feature to submit a request on behalf of another user. IMPORTANT: It's not possible to use an API key as the authentication credential for this API. To update an API key, the owner user's credentials are required. It's not possible to update expired API keys, or API keys that have been invalidated by the invalidate API key API. This API supports updates to an API key's access scope, metadata, and expiration. The owner user's information, such as the `username` and `realm`, is also updated automatically on every call. NOTE: This API cannot update REST API keys, which should be updated by either the update API key or bulk update API keys API. | +| `updateCrossClusterApiKey` | `updateCrossClusterApiKey(this: [That](./That.md), params: [SecurityUpdateCrossClusterApiKeyRequest](./SecurityUpdateCrossClusterApiKeyRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityUpdateCrossClusterApiKeyResponse](./SecurityUpdateCrossClusterApiKeyResponse.md), unknown>>;` |   | +| `updateCrossClusterApiKey` | `updateCrossClusterApiKey(this: [That](./That.md), params: [SecurityUpdateCrossClusterApiKeyRequest](./SecurityUpdateCrossClusterApiKeyRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityUpdateCrossClusterApiKeyResponse](./SecurityUpdateCrossClusterApiKeyResponse.md)>;` |   | +| `updateSettings` | `updateSettings(this: [That](./That.md), params?: [SecurityUpdateSettingsRequest](./SecurityUpdateSettingsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityUpdateSettingsResponse](./SecurityUpdateSettingsResponse.md)>;` | Update security index settings. Update the user-configurable settings for the security internal index ( `.security` and associated indices). Only a subset of settings are allowed to be modified. This includes `index.auto_expand_replicas` and `index.number_of_replicas`. NOTE: If `index.auto_expand_replicas` is set, `index.number_of_replicas` will be ignored during updates. If a specific index is not in use on the system and settings are provided for it, the request will be rejected. This API does not yet support configuring the settings for indices before they are in use. | +| `updateSettings` | `updateSettings(this: [That](./That.md), params?: [SecurityUpdateSettingsRequest](./SecurityUpdateSettingsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityUpdateSettingsResponse](./SecurityUpdateSettingsResponse.md), unknown>>;` |   | +| `updateSettings` | `updateSettings(this: [That](./That.md), params?: [SecurityUpdateSettingsRequest](./SecurityUpdateSettingsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityUpdateSettingsResponse](./SecurityUpdateSettingsResponse.md)>;` |   | +| `updateUserProfileData` | `updateUserProfileData(this: [That](./That.md), params: [SecurityUpdateUserProfileDataRequest](./SecurityUpdateUserProfileDataRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SecurityUpdateUserProfileDataResponse](./SecurityUpdateUserProfileDataResponse.md)>;` | Update user profile data. Update specific data for the user profile that is associated with a unique ID. NOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions. Individual users and external applications should not call this API directly. Elastic reserves the right to change or remove this feature in future releases without prior notice. To use this API, you must have one of the following privileges: * The `manage_user_profile` cluster privilege. * The `update_profile_data` global privilege for the namespaces that are referenced in the request. This API updates the `labels` and `data` fields of an existing user profile document with JSON objects. New keys and their values are added to the profile document and conflicting keys are replaced by data that's included in the request. For both labels and data, content is namespaced by the top-level fields. The `update_profile_data` global privilege grants privileges for updating only the allowed namespaces. | +| `updateUserProfileData` | `updateUserProfileData(this: [That](./That.md), params: [SecurityUpdateUserProfileDataRequest](./SecurityUpdateUserProfileDataRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SecurityUpdateUserProfileDataResponse](./SecurityUpdateUserProfileDataResponse.md), unknown>>;` |   | +| `updateUserProfileData` | `updateUserProfileData(this: [That](./That.md), params: [SecurityUpdateUserProfileDataRequest](./SecurityUpdateUserProfileDataRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SecurityUpdateUserProfileDataResponse](./SecurityUpdateUserProfileDataResponse.md)>;` |   | diff --git a/docs/reference/api/Shutdown.md b/docs/reference/api/Shutdown.md index eab4064c7..13b84daf4 100644 --- a/docs/reference/api/Shutdown.md +++ b/docs/reference/api/Shutdown.md @@ -17,4 +17,12 @@ new Shutdown(transport: [Transport](./Transport.md)); | Name | Signature | Description | | - | - | - | -| `deleteNode` | `deleteNode(this: [That](./That.md), params: [ShutdownDeleteNodeRequest](./ShutdownDeleteNodeRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ShutdownDeleteNodeResponse](./ShutdownDeleteNodeResponse.md)>;` | Cancel node shutdown preparations. Remove a node from the shutdown list so it can resume normal operations. You must explicitly clear the shutdown request when a node rejoins the cluster or when a node has permanently left the cluster. Shutdown requests are never removed automatically by Elasticsearch. NOTE: This feature is designed for indirect use by Elastic Cloud, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported. If the operator privileges feature is enabled, you must be an operator to use this API. || `deleteNode` | `deleteNode(this: [That](./That.md), params: [ShutdownDeleteNodeRequest](./ShutdownDeleteNodeRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ShutdownDeleteNodeResponse](./ShutdownDeleteNodeResponse.md), unknown>>;` |   || `deleteNode` | `deleteNode(this: [That](./That.md), params: [ShutdownDeleteNodeRequest](./ShutdownDeleteNodeRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ShutdownDeleteNodeResponse](./ShutdownDeleteNodeResponse.md)>;` |   || `getNode` | `getNode(this: [That](./That.md), params?: [ShutdownGetNodeRequest](./ShutdownGetNodeRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ShutdownGetNodeResponse](./ShutdownGetNodeResponse.md)>;` | Get the shutdown status. Get information about nodes that are ready to be shut down, have shut down preparations still in progress, or have stalled. The API returns status information for each part of the shut down process. NOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported. If the operator privileges feature is enabled, you must be an operator to use this API. || `getNode` | `getNode(this: [That](./That.md), params?: [ShutdownGetNodeRequest](./ShutdownGetNodeRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ShutdownGetNodeResponse](./ShutdownGetNodeResponse.md), unknown>>;` |   || `getNode` | `getNode(this: [That](./That.md), params?: [ShutdownGetNodeRequest](./ShutdownGetNodeRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ShutdownGetNodeResponse](./ShutdownGetNodeResponse.md)>;` |   || `putNode` | `putNode(this: [That](./That.md), params: [ShutdownPutNodeRequest](./ShutdownPutNodeRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ShutdownPutNodeResponse](./ShutdownPutNodeResponse.md)>;` | Prepare a node to be shut down. NOTE: This feature is designed for indirect use by Elastic Cloud, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported. If you specify a node that is offline, it will be prepared for shut down when it rejoins the cluster. If the operator privileges feature is enabled, you must be an operator to use this API. The API migrates ongoing tasks and index shards to other nodes as needed to prepare a node to be restarted or shut down and removed from the cluster. This ensures that Elasticsearch can be stopped safely with minimal disruption to the cluster. You must specify the type of shutdown: `restart`, `remove`, or `replace`. If a node is already being prepared for shutdown, you can use this API to change the shutdown type. IMPORTANT: This API does NOT terminate the Elasticsearch process. Monitor the node shutdown status to determine when it is safe to stop Elasticsearch. || `putNode` | `putNode(this: [That](./That.md), params: [ShutdownPutNodeRequest](./ShutdownPutNodeRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ShutdownPutNodeResponse](./ShutdownPutNodeResponse.md), unknown>>;` |   || `putNode` | `putNode(this: [That](./That.md), params: [ShutdownPutNodeRequest](./ShutdownPutNodeRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ShutdownPutNodeResponse](./ShutdownPutNodeResponse.md)>;` |   | \ No newline at end of file +| `deleteNode` | `deleteNode(this: [That](./That.md), params: [ShutdownDeleteNodeRequest](./ShutdownDeleteNodeRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ShutdownDeleteNodeResponse](./ShutdownDeleteNodeResponse.md)>;` | Cancel node shutdown preparations. Remove a node from the shutdown list so it can resume normal operations. You must explicitly clear the shutdown request when a node rejoins the cluster or when a node has permanently left the cluster. Shutdown requests are never removed automatically by Elasticsearch. NOTE: This feature is designed for indirect use by Elastic Cloud, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported. If the operator privileges feature is enabled, you must be an operator to use this API. | +| `deleteNode` | `deleteNode(this: [That](./That.md), params: [ShutdownDeleteNodeRequest](./ShutdownDeleteNodeRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ShutdownDeleteNodeResponse](./ShutdownDeleteNodeResponse.md), unknown>>;` |   | +| `deleteNode` | `deleteNode(this: [That](./That.md), params: [ShutdownDeleteNodeRequest](./ShutdownDeleteNodeRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ShutdownDeleteNodeResponse](./ShutdownDeleteNodeResponse.md)>;` |   | +| `getNode` | `getNode(this: [That](./That.md), params?: [ShutdownGetNodeRequest](./ShutdownGetNodeRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ShutdownGetNodeResponse](./ShutdownGetNodeResponse.md)>;` | Get the shutdown status. Get information about nodes that are ready to be shut down, have shut down preparations still in progress, or have stalled. The API returns status information for each part of the shut down process. NOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported. If the operator privileges feature is enabled, you must be an operator to use this API. | +| `getNode` | `getNode(this: [That](./That.md), params?: [ShutdownGetNodeRequest](./ShutdownGetNodeRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ShutdownGetNodeResponse](./ShutdownGetNodeResponse.md), unknown>>;` |   | +| `getNode` | `getNode(this: [That](./That.md), params?: [ShutdownGetNodeRequest](./ShutdownGetNodeRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ShutdownGetNodeResponse](./ShutdownGetNodeResponse.md)>;` |   | +| `putNode` | `putNode(this: [That](./That.md), params: [ShutdownPutNodeRequest](./ShutdownPutNodeRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ShutdownPutNodeResponse](./ShutdownPutNodeResponse.md)>;` | Prepare a node to be shut down. NOTE: This feature is designed for indirect use by Elastic Cloud, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported. If you specify a node that is offline, it will be prepared for shut down when it rejoins the cluster. If the operator privileges feature is enabled, you must be an operator to use this API. The API migrates ongoing tasks and index shards to other nodes as needed to prepare a node to be restarted or shut down and removed from the cluster. This ensures that Elasticsearch can be stopped safely with minimal disruption to the cluster. You must specify the type of shutdown: `restart`, `remove`, or `replace`. If a node is already being prepared for shutdown, you can use this API to change the shutdown type. IMPORTANT: This API does NOT terminate the Elasticsearch process. Monitor the node shutdown status to determine when it is safe to stop Elasticsearch. | +| `putNode` | `putNode(this: [That](./That.md), params: [ShutdownPutNodeRequest](./ShutdownPutNodeRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ShutdownPutNodeResponse](./ShutdownPutNodeResponse.md), unknown>>;` |   | +| `putNode` | `putNode(this: [That](./That.md), params: [ShutdownPutNodeRequest](./ShutdownPutNodeRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ShutdownPutNodeResponse](./ShutdownPutNodeResponse.md)>;` |   | diff --git a/docs/reference/api/Simulate.md b/docs/reference/api/Simulate.md index f01131ecd..1ea3524d9 100644 --- a/docs/reference/api/Simulate.md +++ b/docs/reference/api/Simulate.md @@ -17,4 +17,6 @@ new Simulate(transport: [Transport](./Transport.md)); | Name | Signature | Description | | - | - | - | -| `ingest` | `ingest(this: [That](./That.md), params: [SimulateIngestRequest](./SimulateIngestRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SimulateIngestResponse](./SimulateIngestResponse.md)>;` | Simulate data ingestion. Run ingest pipelines against a set of provided documents, optionally with substitute pipeline definitions, to simulate ingesting data into an index. This API is meant to be used for troubleshooting or pipeline development, as it does not actually index any data into Elasticsearch. The API runs the default and final pipeline for that index against a set of documents provided in the body of the request. If a pipeline contains a reroute processor, it follows that reroute processor to the new index, running that index's pipelines as well the same way that a non-simulated ingest would. No data is indexed into Elasticsearch. Instead, the transformed document is returned, along with the list of pipelines that have been run and the name of the index where the document would have been indexed if this were not a simulation. The transformed document is validated against the mappings that would apply to this index, and any validation error is reported in the result. This API differs from the simulate pipeline API in that you specify a single pipeline for that API, and it runs only that one pipeline. The simulate pipeline API is more useful for developing a single pipeline, while the simulate ingest API is more useful for troubleshooting the interaction of the various pipelines that get applied when ingesting into an index. By default, the pipeline definitions that are currently in the system are used. However, you can supply substitute pipeline definitions in the body of the request. These will be used in place of the pipeline definitions that are already in the system. This can be used to replace existing pipeline definitions or to create new ones. The pipeline substitutions are used only within this request. || `ingest` | `ingest(this: [That](./That.md), params: [SimulateIngestRequest](./SimulateIngestRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SimulateIngestResponse](./SimulateIngestResponse.md), unknown>>;` |   || `ingest` | `ingest(this: [That](./That.md), params: [SimulateIngestRequest](./SimulateIngestRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SimulateIngestResponse](./SimulateIngestResponse.md)>;` |   | \ No newline at end of file +| `ingest` | `ingest(this: [That](./That.md), params: [SimulateIngestRequest](./SimulateIngestRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SimulateIngestResponse](./SimulateIngestResponse.md)>;` | Simulate data ingestion. Run ingest pipelines against a set of provided documents, optionally with substitute pipeline definitions, to simulate ingesting data into an index. This API is meant to be used for troubleshooting or pipeline development, as it does not actually index any data into Elasticsearch. The API runs the default and final pipeline for that index against a set of documents provided in the body of the request. If a pipeline contains a reroute processor, it follows that reroute processor to the new index, running that index's pipelines as well the same way that a non-simulated ingest would. No data is indexed into Elasticsearch. Instead, the transformed document is returned, along with the list of pipelines that have been run and the name of the index where the document would have been indexed if this were not a simulation. The transformed document is validated against the mappings that would apply to this index, and any validation error is reported in the result. This API differs from the simulate pipeline API in that you specify a single pipeline for that API, and it runs only that one pipeline. The simulate pipeline API is more useful for developing a single pipeline, while the simulate ingest API is more useful for troubleshooting the interaction of the various pipelines that get applied when ingesting into an index. By default, the pipeline definitions that are currently in the system are used. However, you can supply substitute pipeline definitions in the body of the request. These will be used in place of the pipeline definitions that are already in the system. This can be used to replace existing pipeline definitions or to create new ones. The pipeline substitutions are used only within this request. | +| `ingest` | `ingest(this: [That](./That.md), params: [SimulateIngestRequest](./SimulateIngestRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SimulateIngestResponse](./SimulateIngestResponse.md), unknown>>;` |   | +| `ingest` | `ingest(this: [That](./That.md), params: [SimulateIngestRequest](./SimulateIngestRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SimulateIngestResponse](./SimulateIngestResponse.md)>;` |   | diff --git a/docs/reference/api/Slm.md b/docs/reference/api/Slm.md index 42a6c32fe..712874e89 100644 --- a/docs/reference/api/Slm.md +++ b/docs/reference/api/Slm.md @@ -17,4 +17,30 @@ new Slm(transport: [Transport](./Transport.md)); | Name | Signature | Description | | - | - | - | -| `deleteLifecycle` | `deleteLifecycle(this: [That](./That.md), params: [SlmDeleteLifecycleRequest](./SlmDeleteLifecycleRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SlmDeleteLifecycleResponse](./SlmDeleteLifecycleResponse.md)>;` | Delete a policy. Delete a snapshot lifecycle policy definition. This operation prevents any future snapshots from being taken but does not cancel in-progress snapshots or remove previously-taken snapshots. || `deleteLifecycle` | `deleteLifecycle(this: [That](./That.md), params: [SlmDeleteLifecycleRequest](./SlmDeleteLifecycleRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SlmDeleteLifecycleResponse](./SlmDeleteLifecycleResponse.md), unknown>>;` |   || `deleteLifecycle` | `deleteLifecycle(this: [That](./That.md), params: [SlmDeleteLifecycleRequest](./SlmDeleteLifecycleRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SlmDeleteLifecycleResponse](./SlmDeleteLifecycleResponse.md)>;` |   || `executeLifecycle` | `executeLifecycle(this: [That](./That.md), params: [SlmExecuteLifecycleRequest](./SlmExecuteLifecycleRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SlmExecuteLifecycleResponse](./SlmExecuteLifecycleResponse.md)>;` | Run a policy. Immediately create a snapshot according to the snapshot lifecycle policy without waiting for the scheduled time. The snapshot policy is normally applied according to its schedule, but you might want to manually run a policy before performing an upgrade or other maintenance. || `executeLifecycle` | `executeLifecycle(this: [That](./That.md), params: [SlmExecuteLifecycleRequest](./SlmExecuteLifecycleRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SlmExecuteLifecycleResponse](./SlmExecuteLifecycleResponse.md), unknown>>;` |   || `executeLifecycle` | `executeLifecycle(this: [That](./That.md), params: [SlmExecuteLifecycleRequest](./SlmExecuteLifecycleRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SlmExecuteLifecycleResponse](./SlmExecuteLifecycleResponse.md)>;` |   || `executeRetention` | `executeRetention(this: [That](./That.md), params?: [SlmExecuteRetentionRequest](./SlmExecuteRetentionRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SlmExecuteRetentionResponse](./SlmExecuteRetentionResponse.md)>;` | Run a retention policy. Manually apply the retention policy to force immediate removal of snapshots that are expired according to the snapshot lifecycle policy retention rules. The retention policy is normally applied according to its schedule. || `executeRetention` | `executeRetention(this: [That](./That.md), params?: [SlmExecuteRetentionRequest](./SlmExecuteRetentionRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SlmExecuteRetentionResponse](./SlmExecuteRetentionResponse.md), unknown>>;` |   || `executeRetention` | `executeRetention(this: [That](./That.md), params?: [SlmExecuteRetentionRequest](./SlmExecuteRetentionRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SlmExecuteRetentionResponse](./SlmExecuteRetentionResponse.md)>;` |   || `getLifecycle` | `getLifecycle(this: [That](./That.md), params?: [SlmGetLifecycleRequest](./SlmGetLifecycleRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SlmGetLifecycleResponse](./SlmGetLifecycleResponse.md)>;` | Get policy information. Get snapshot lifecycle policy definitions and information about the latest snapshot attempts. || `getLifecycle` | `getLifecycle(this: [That](./That.md), params?: [SlmGetLifecycleRequest](./SlmGetLifecycleRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SlmGetLifecycleResponse](./SlmGetLifecycleResponse.md), unknown>>;` |   || `getLifecycle` | `getLifecycle(this: [That](./That.md), params?: [SlmGetLifecycleRequest](./SlmGetLifecycleRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SlmGetLifecycleResponse](./SlmGetLifecycleResponse.md)>;` |   || `getStats` | `getStats(this: [That](./That.md), params?: [SlmGetStatsRequest](./SlmGetStatsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SlmGetStatsResponse](./SlmGetStatsResponse.md)>;` | Get snapshot lifecycle management statistics. Get global and policy-level statistics about actions taken by snapshot lifecycle management. || `getStats` | `getStats(this: [That](./That.md), params?: [SlmGetStatsRequest](./SlmGetStatsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SlmGetStatsResponse](./SlmGetStatsResponse.md), unknown>>;` |   || `getStats` | `getStats(this: [That](./That.md), params?: [SlmGetStatsRequest](./SlmGetStatsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SlmGetStatsResponse](./SlmGetStatsResponse.md)>;` |   || `getStatus` | `getStatus(this: [That](./That.md), params?: [SlmGetStatusRequest](./SlmGetStatusRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SlmGetStatusResponse](./SlmGetStatusResponse.md)>;` | Get the snapshot lifecycle management status. || `getStatus` | `getStatus(this: [That](./That.md), params?: [SlmGetStatusRequest](./SlmGetStatusRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SlmGetStatusResponse](./SlmGetStatusResponse.md), unknown>>;` |   || `getStatus` | `getStatus(this: [That](./That.md), params?: [SlmGetStatusRequest](./SlmGetStatusRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SlmGetStatusResponse](./SlmGetStatusResponse.md)>;` |   || `putLifecycle` | `putLifecycle(this: [That](./That.md), params: [SlmPutLifecycleRequest](./SlmPutLifecycleRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SlmPutLifecycleResponse](./SlmPutLifecycleResponse.md)>;` | Create or update a policy. Create or update a snapshot lifecycle policy. If the policy already exists, this request increments the policy version. Only the latest version of a policy is stored. || `putLifecycle` | `putLifecycle(this: [That](./That.md), params: [SlmPutLifecycleRequest](./SlmPutLifecycleRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SlmPutLifecycleResponse](./SlmPutLifecycleResponse.md), unknown>>;` |   || `putLifecycle` | `putLifecycle(this: [That](./That.md), params: [SlmPutLifecycleRequest](./SlmPutLifecycleRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SlmPutLifecycleResponse](./SlmPutLifecycleResponse.md)>;` |   || `start` | `start(this: [That](./That.md), params?: [SlmStartRequest](./SlmStartRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SlmStartResponse](./SlmStartResponse.md)>;` | Start snapshot lifecycle management. Snapshot lifecycle management (SLM) starts automatically when a cluster is formed. Manually starting SLM is necessary only if it has been stopped using the stop SLM API. || `start` | `start(this: [That](./That.md), params?: [SlmStartRequest](./SlmStartRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SlmStartResponse](./SlmStartResponse.md), unknown>>;` |   || `start` | `start(this: [That](./That.md), params?: [SlmStartRequest](./SlmStartRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SlmStartResponse](./SlmStartResponse.md)>;` |   || `stop` | `stop(this: [That](./That.md), params?: [SlmStopRequest](./SlmStopRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SlmStopResponse](./SlmStopResponse.md)>;` | Stop snapshot lifecycle management. Stop all snapshot lifecycle management (SLM) operations and the SLM plugin. This API is useful when you are performing maintenance on a cluster and need to prevent SLM from performing any actions on your data streams or indices. Stopping SLM does not stop any snapshots that are in progress. You can manually trigger snapshots with the run snapshot lifecycle policy API even if SLM is stopped. The API returns a response as soon as the request is acknowledged, but the plugin might continue to run until in-progress operations complete and it can be safely stopped. Use the get snapshot lifecycle management status API to see if SLM is running. || `stop` | `stop(this: [That](./That.md), params?: [SlmStopRequest](./SlmStopRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SlmStopResponse](./SlmStopResponse.md), unknown>>;` |   || `stop` | `stop(this: [That](./That.md), params?: [SlmStopRequest](./SlmStopRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SlmStopResponse](./SlmStopResponse.md)>;` |   | \ No newline at end of file +| `deleteLifecycle` | `deleteLifecycle(this: [That](./That.md), params: [SlmDeleteLifecycleRequest](./SlmDeleteLifecycleRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SlmDeleteLifecycleResponse](./SlmDeleteLifecycleResponse.md)>;` | Delete a policy. Delete a snapshot lifecycle policy definition. This operation prevents any future snapshots from being taken but does not cancel in-progress snapshots or remove previously-taken snapshots. | +| `deleteLifecycle` | `deleteLifecycle(this: [That](./That.md), params: [SlmDeleteLifecycleRequest](./SlmDeleteLifecycleRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SlmDeleteLifecycleResponse](./SlmDeleteLifecycleResponse.md), unknown>>;` |   | +| `deleteLifecycle` | `deleteLifecycle(this: [That](./That.md), params: [SlmDeleteLifecycleRequest](./SlmDeleteLifecycleRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SlmDeleteLifecycleResponse](./SlmDeleteLifecycleResponse.md)>;` |   | +| `executeLifecycle` | `executeLifecycle(this: [That](./That.md), params: [SlmExecuteLifecycleRequest](./SlmExecuteLifecycleRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SlmExecuteLifecycleResponse](./SlmExecuteLifecycleResponse.md)>;` | Run a policy. Immediately create a snapshot according to the snapshot lifecycle policy without waiting for the scheduled time. The snapshot policy is normally applied according to its schedule, but you might want to manually run a policy before performing an upgrade or other maintenance. | +| `executeLifecycle` | `executeLifecycle(this: [That](./That.md), params: [SlmExecuteLifecycleRequest](./SlmExecuteLifecycleRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SlmExecuteLifecycleResponse](./SlmExecuteLifecycleResponse.md), unknown>>;` |   | +| `executeLifecycle` | `executeLifecycle(this: [That](./That.md), params: [SlmExecuteLifecycleRequest](./SlmExecuteLifecycleRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SlmExecuteLifecycleResponse](./SlmExecuteLifecycleResponse.md)>;` |   | +| `executeRetention` | `executeRetention(this: [That](./That.md), params?: [SlmExecuteRetentionRequest](./SlmExecuteRetentionRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SlmExecuteRetentionResponse](./SlmExecuteRetentionResponse.md)>;` | Run a retention policy. Manually apply the retention policy to force immediate removal of snapshots that are expired according to the snapshot lifecycle policy retention rules. The retention policy is normally applied according to its schedule. | +| `executeRetention` | `executeRetention(this: [That](./That.md), params?: [SlmExecuteRetentionRequest](./SlmExecuteRetentionRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SlmExecuteRetentionResponse](./SlmExecuteRetentionResponse.md), unknown>>;` |   | +| `executeRetention` | `executeRetention(this: [That](./That.md), params?: [SlmExecuteRetentionRequest](./SlmExecuteRetentionRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SlmExecuteRetentionResponse](./SlmExecuteRetentionResponse.md)>;` |   | +| `getLifecycle` | `getLifecycle(this: [That](./That.md), params?: [SlmGetLifecycleRequest](./SlmGetLifecycleRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SlmGetLifecycleResponse](./SlmGetLifecycleResponse.md)>;` | Get policy information. Get snapshot lifecycle policy definitions and information about the latest snapshot attempts. | +| `getLifecycle` | `getLifecycle(this: [That](./That.md), params?: [SlmGetLifecycleRequest](./SlmGetLifecycleRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SlmGetLifecycleResponse](./SlmGetLifecycleResponse.md), unknown>>;` |   | +| `getLifecycle` | `getLifecycle(this: [That](./That.md), params?: [SlmGetLifecycleRequest](./SlmGetLifecycleRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SlmGetLifecycleResponse](./SlmGetLifecycleResponse.md)>;` |   | +| `getStats` | `getStats(this: [That](./That.md), params?: [SlmGetStatsRequest](./SlmGetStatsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SlmGetStatsResponse](./SlmGetStatsResponse.md)>;` | Get snapshot lifecycle management statistics. Get global and policy-level statistics about actions taken by snapshot lifecycle management. | +| `getStats` | `getStats(this: [That](./That.md), params?: [SlmGetStatsRequest](./SlmGetStatsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SlmGetStatsResponse](./SlmGetStatsResponse.md), unknown>>;` |   | +| `getStats` | `getStats(this: [That](./That.md), params?: [SlmGetStatsRequest](./SlmGetStatsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SlmGetStatsResponse](./SlmGetStatsResponse.md)>;` |   | +| `getStatus` | `getStatus(this: [That](./That.md), params?: [SlmGetStatusRequest](./SlmGetStatusRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SlmGetStatusResponse](./SlmGetStatusResponse.md)>;` | Get the snapshot lifecycle management status. | +| `getStatus` | `getStatus(this: [That](./That.md), params?: [SlmGetStatusRequest](./SlmGetStatusRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SlmGetStatusResponse](./SlmGetStatusResponse.md), unknown>>;` |   | +| `getStatus` | `getStatus(this: [That](./That.md), params?: [SlmGetStatusRequest](./SlmGetStatusRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SlmGetStatusResponse](./SlmGetStatusResponse.md)>;` |   | +| `putLifecycle` | `putLifecycle(this: [That](./That.md), params: [SlmPutLifecycleRequest](./SlmPutLifecycleRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SlmPutLifecycleResponse](./SlmPutLifecycleResponse.md)>;` | Create or update a policy. Create or update a snapshot lifecycle policy. If the policy already exists, this request increments the policy version. Only the latest version of a policy is stored. | +| `putLifecycle` | `putLifecycle(this: [That](./That.md), params: [SlmPutLifecycleRequest](./SlmPutLifecycleRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SlmPutLifecycleResponse](./SlmPutLifecycleResponse.md), unknown>>;` |   | +| `putLifecycle` | `putLifecycle(this: [That](./That.md), params: [SlmPutLifecycleRequest](./SlmPutLifecycleRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SlmPutLifecycleResponse](./SlmPutLifecycleResponse.md)>;` |   | +| `start` | `start(this: [That](./That.md), params?: [SlmStartRequest](./SlmStartRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SlmStartResponse](./SlmStartResponse.md)>;` | Start snapshot lifecycle management. Snapshot lifecycle management (SLM) starts automatically when a cluster is formed. Manually starting SLM is necessary only if it has been stopped using the stop SLM API. | +| `start` | `start(this: [That](./That.md), params?: [SlmStartRequest](./SlmStartRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SlmStartResponse](./SlmStartResponse.md), unknown>>;` |   | +| `start` | `start(this: [That](./That.md), params?: [SlmStartRequest](./SlmStartRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SlmStartResponse](./SlmStartResponse.md)>;` |   | +| `stop` | `stop(this: [That](./That.md), params?: [SlmStopRequest](./SlmStopRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SlmStopResponse](./SlmStopResponse.md)>;` | Stop snapshot lifecycle management. Stop all snapshot lifecycle management (SLM) operations and the SLM plugin. This API is useful when you are performing maintenance on a cluster and need to prevent SLM from performing any actions on your data streams or indices. Stopping SLM does not stop any snapshots that are in progress. You can manually trigger snapshots with the run snapshot lifecycle policy API even if SLM is stopped. The API returns a response as soon as the request is acknowledged, but the plugin might continue to run until in-progress operations complete and it can be safely stopped. Use the get snapshot lifecycle management status API to see if SLM is running. | +| `stop` | `stop(this: [That](./That.md), params?: [SlmStopRequest](./SlmStopRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SlmStopResponse](./SlmStopResponse.md), unknown>>;` |   | +| `stop` | `stop(this: [That](./That.md), params?: [SlmStopRequest](./SlmStopRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SlmStopResponse](./SlmStopResponse.md)>;` |   | diff --git a/docs/reference/api/Snapshot.md b/docs/reference/api/Snapshot.md index b2b9ce74e..d498344fb 100644 --- a/docs/reference/api/Snapshot.md +++ b/docs/reference/api/Snapshot.md @@ -17,4 +17,42 @@ new Snapshot(transport: [Transport](./Transport.md)); | Name | Signature | Description | | - | - | - | -| `cleanupRepository` | `cleanupRepository(this: [That](./That.md), params: [SnapshotCleanupRepositoryRequest](./SnapshotCleanupRepositoryRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SnapshotCleanupRepositoryResponse](./SnapshotCleanupRepositoryResponse.md)>;` | Clean up the snapshot repository. Trigger the review of the contents of a snapshot repository and delete any stale data not referenced by existing snapshots. || `cleanupRepository` | `cleanupRepository(this: [That](./That.md), params: [SnapshotCleanupRepositoryRequest](./SnapshotCleanupRepositoryRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SnapshotCleanupRepositoryResponse](./SnapshotCleanupRepositoryResponse.md), unknown>>;` |   || `cleanupRepository` | `cleanupRepository(this: [That](./That.md), params: [SnapshotCleanupRepositoryRequest](./SnapshotCleanupRepositoryRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SnapshotCleanupRepositoryResponse](./SnapshotCleanupRepositoryResponse.md)>;` |   || `clone` | `clone(this: [That](./That.md), params: [SnapshotCloneRequest](./SnapshotCloneRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SnapshotCloneResponse](./SnapshotCloneResponse.md)>;` | Clone a snapshot. Clone part of all of a snapshot into another snapshot in the same repository. || `clone` | `clone(this: [That](./That.md), params: [SnapshotCloneRequest](./SnapshotCloneRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SnapshotCloneResponse](./SnapshotCloneResponse.md), unknown>>;` |   || `clone` | `clone(this: [That](./That.md), params: [SnapshotCloneRequest](./SnapshotCloneRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SnapshotCloneResponse](./SnapshotCloneResponse.md)>;` |   || `create` | `create(this: [That](./That.md), params: [SnapshotCreateRequest](./SnapshotCreateRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SnapshotCreateResponse](./SnapshotCreateResponse.md)>;` | Create a snapshot. Take a snapshot of a cluster or of data streams and indices. || `create` | `create(this: [That](./That.md), params: [SnapshotCreateRequest](./SnapshotCreateRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SnapshotCreateResponse](./SnapshotCreateResponse.md), unknown>>;` |   || `create` | `create(this: [That](./That.md), params: [SnapshotCreateRequest](./SnapshotCreateRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SnapshotCreateResponse](./SnapshotCreateResponse.md)>;` |   || `createRepository` | `createRepository(this: [That](./That.md), params: [SnapshotCreateRepositoryRequest](./SnapshotCreateRepositoryRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SnapshotCreateRepositoryResponse](./SnapshotCreateRepositoryResponse.md)>;` | Create or update a snapshot repository. IMPORTANT: If you are migrating searchable snapshots, the repository name must be identical in the source and destination clusters. To register a snapshot repository, the cluster's global metadata must be writeable. Ensure there are no cluster blocks (for example, `cluster.blocks.read_only` and `clsuter.blocks.read_only_allow_delete` settings) that prevent write access. Several options for this API can be specified using a query parameter or a request body parameter. If both parameters are specified, only the query parameter is used. || `createRepository` | `createRepository(this: [That](./That.md), params: [SnapshotCreateRepositoryRequest](./SnapshotCreateRepositoryRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SnapshotCreateRepositoryResponse](./SnapshotCreateRepositoryResponse.md), unknown>>;` |   || `createRepository` | `createRepository(this: [That](./That.md), params: [SnapshotCreateRepositoryRequest](./SnapshotCreateRepositoryRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SnapshotCreateRepositoryResponse](./SnapshotCreateRepositoryResponse.md)>;` |   || `delete` | `delete(this: [That](./That.md), params: [SnapshotDeleteRequest](./SnapshotDeleteRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SnapshotDeleteResponse](./SnapshotDeleteResponse.md)>;` | Delete snapshots. || `delete` | `delete(this: [That](./That.md), params: [SnapshotDeleteRequest](./SnapshotDeleteRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SnapshotDeleteResponse](./SnapshotDeleteResponse.md), unknown>>;` |   || `delete` | `delete(this: [That](./That.md), params: [SnapshotDeleteRequest](./SnapshotDeleteRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SnapshotDeleteResponse](./SnapshotDeleteResponse.md)>;` |   || `deleteRepository` | `deleteRepository(this: [That](./That.md), params: [SnapshotDeleteRepositoryRequest](./SnapshotDeleteRepositoryRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SnapshotDeleteRepositoryResponse](./SnapshotDeleteRepositoryResponse.md)>;` | Delete snapshot repositories. When a repository is unregistered, Elasticsearch removes only the reference to the location where the repository is storing the snapshots. The snapshots themselves are left untouched and in place. || `deleteRepository` | `deleteRepository(this: [That](./That.md), params: [SnapshotDeleteRepositoryRequest](./SnapshotDeleteRepositoryRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SnapshotDeleteRepositoryResponse](./SnapshotDeleteRepositoryResponse.md), unknown>>;` |   || `deleteRepository` | `deleteRepository(this: [That](./That.md), params: [SnapshotDeleteRepositoryRequest](./SnapshotDeleteRepositoryRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SnapshotDeleteRepositoryResponse](./SnapshotDeleteRepositoryResponse.md)>;` |   || `get` | `get(this: [That](./That.md), params: [SnapshotGetRequest](./SnapshotGetRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SnapshotGetResponse](./SnapshotGetResponse.md)>;` | Get snapshot information. NOTE: The `after` parameter and `next` field enable you to iterate through snapshots with some consistency guarantees regarding concurrent creation or deletion of snapshots. It is guaranteed that any snapshot that exists at the beginning of the iteration and is not concurrently deleted will be seen during the iteration. Snapshots concurrently created may be seen during an iteration. || `get` | `get(this: [That](./That.md), params: [SnapshotGetRequest](./SnapshotGetRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SnapshotGetResponse](./SnapshotGetResponse.md), unknown>>;` |   || `get` | `get(this: [That](./That.md), params: [SnapshotGetRequest](./SnapshotGetRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SnapshotGetResponse](./SnapshotGetResponse.md)>;` |   || `getRepository` | `getRepository(this: [That](./That.md), params?: [SnapshotGetRepositoryRequest](./SnapshotGetRepositoryRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SnapshotGetRepositoryResponse](./SnapshotGetRepositoryResponse.md)>;` | Get snapshot repository information. || `getRepository` | `getRepository(this: [That](./That.md), params?: [SnapshotGetRepositoryRequest](./SnapshotGetRepositoryRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SnapshotGetRepositoryResponse](./SnapshotGetRepositoryResponse.md), unknown>>;` |   || `getRepository` | `getRepository(this: [That](./That.md), params?: [SnapshotGetRepositoryRequest](./SnapshotGetRepositoryRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SnapshotGetRepositoryResponse](./SnapshotGetRepositoryResponse.md)>;` |   || `repositoryAnalyze` | `repositoryAnalyze(this: [That](./That.md), params: [SnapshotRepositoryAnalyzeRequest](./SnapshotRepositoryAnalyzeRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SnapshotRepositoryAnalyzeResponse](./SnapshotRepositoryAnalyzeResponse.md)>;` | Analyze a snapshot repository. Analyze the performance characteristics and any incorrect behaviour found in a repository. The response exposes implementation details of the analysis which may change from version to version. The response body format is therefore not considered stable and may be different in newer versions. There are a large number of third-party storage systems available, not all of which are suitable for use as a snapshot repository by Elasticsearch. Some storage systems behave incorrectly, or perform poorly, especially when accessed concurrently by multiple clients as the nodes of an Elasticsearch cluster do. This API performs a collection of read and write operations on your repository which are designed to detect incorrect behaviour and to measure the performance characteristics of your storage system. The default values for the parameters are deliberately low to reduce the impact of running an analysis inadvertently and to provide a sensible starting point for your investigations. Run your first analysis with the default parameter values to check for simple problems. If successful, run a sequence of increasingly large analyses until you encounter a failure or you reach a `blob_count` of at least `2000`, a `max_blob_size` of at least `2gb`, a `max_total_data_size` of at least `1tb`, and a `register_operation_count` of at least `100`. Always specify a generous timeout, possibly `1h` or longer, to allow time for each analysis to run to completion. Perform the analyses using a multi-node cluster of a similar size to your production cluster so that it can detect any problems that only arise when the repository is accessed by many nodes at once. If the analysis fails, Elasticsearch detected that your repository behaved unexpectedly. This usually means you are using a third-party storage system with an incorrect or incompatible implementation of the API it claims to support. If so, this storage system is not suitable for use as a snapshot repository. You will need to work with the supplier of your storage system to address the incompatibilities that Elasticsearch detects. If the analysis is successful, the API returns details of the testing process, optionally including how long each operation took. You can use this information to determine the performance of your storage system. If any operation fails or returns an incorrect result, the API returns an error. If the API returns an error, it may not have removed all the data it wrote to the repository. The error will indicate the location of any leftover data and this path is also recorded in the Elasticsearch logs. You should verify that this location has been cleaned up correctly. If there is still leftover data at the specified location, you should manually remove it. If the connection from your client to Elasticsearch is closed while the client is waiting for the result of the analysis, the test is cancelled. Some clients are configured to close their connection if no response is received within a certain timeout. An analysis takes a long time to complete so you might need to relax any such client-side timeouts. On cancellation the analysis attempts to clean up the data it was writing, but it may not be able to remove it all. The path to the leftover data is recorded in the Elasticsearch logs. You should verify that this location has been cleaned up correctly. If there is still leftover data at the specified location, you should manually remove it. If the analysis is successful then it detected no incorrect behaviour, but this does not mean that correct behaviour is guaranteed. The analysis attempts to detect common bugs but it does not offer 100% coverage. Additionally, it does not test the following: * Your repository must perform durable writes. Once a blob has been written it must remain in place until it is deleted, even after a power loss or similar disaster. * Your repository must not suffer from silent data corruption. Once a blob has been written, its contents must remain unchanged until it is deliberately modified or deleted. * Your repository must behave correctly even if connectivity from the cluster is disrupted. Reads and writes may fail in this case, but they must not return incorrect results. IMPORTANT: An analysis writes a substantial amount of data to your repository and then reads it back again. This consumes bandwidth on the network between the cluster and the repository, and storage space and I/O bandwidth on the repository itself. You must ensure this load does not affect other users of these systems. Analyses respect the repository settings `max_snapshot_bytes_per_sec` and `max_restore_bytes_per_sec` if available and the cluster setting `indices.recovery.max_bytes_per_sec` which you can use to limit the bandwidth they consume. NOTE: This API is intended for exploratory use by humans. You should expect the request parameters and the response format to vary in future versions. NOTE: Different versions of Elasticsearch may perform different checks for repository compatibility, with newer versions typically being stricter than older ones. A storage system that passes repository analysis with one version of Elasticsearch may fail with a different version. This indicates it behaves incorrectly in ways that the former version did not detect. You must work with the supplier of your storage system to address the incompatibilities detected by the repository analysis API in any version of Elasticsearch. NOTE: This API may not work correctly in a mixed-version cluster. *Implementation details* NOTE: This section of documentation describes how the repository analysis API works in this version of Elasticsearch, but you should expect the implementation to vary between versions. The request parameters and response format depend on details of the implementation so may also be different in newer versions. The analysis comprises a number of blob-level tasks, as set by the `blob_count` parameter and a number of compare-and-exchange operations on linearizable registers, as set by the `register_operation_count` parameter. These tasks are distributed over the data and master-eligible nodes in the cluster for execution. For most blob-level tasks, the executing node first writes a blob to the repository and then instructs some of the other nodes in the cluster to attempt to read the data it just wrote. The size of the blob is chosen randomly, according to the `max_blob_size` and `max_total_data_size` parameters. If any of these reads fails then the repository does not implement the necessary read-after-write semantics that Elasticsearch requires. For some blob-level tasks, the executing node will instruct some of its peers to attempt to read the data before the writing process completes. These reads are permitted to fail, but must not return partial data. If any read returns partial data then the repository does not implement the necessary atomicity semantics that Elasticsearch requires. For some blob-level tasks, the executing node will overwrite the blob while its peers are reading it. In this case the data read may come from either the original or the overwritten blob, but the read operation must not return partial data or a mix of data from the two blobs. If any of these reads returns partial data or a mix of the two blobs then the repository does not implement the necessary atomicity semantics that Elasticsearch requires for overwrites. The executing node will use a variety of different methods to write the blob. For instance, where applicable, it will use both single-part and multi-part uploads. Similarly, the reading nodes will use a variety of different methods to read the data back again. For instance they may read the entire blob from start to end or may read only a subset of the data. For some blob-level tasks, the executing node will cancel the write before it is complete. In this case, it still instructs some of the other nodes in the cluster to attempt to read the blob but all of these reads must fail to find the blob. Linearizable registers are special blobs that Elasticsearch manipulates using an atomic compare-and-exchange operation. This operation ensures correct and strongly-consistent behavior even when the blob is accessed by multiple nodes at the same time. The detailed implementation of the compare-and-exchange operation on linearizable registers varies by repository type. Repository analysis verifies that that uncontended compare-and-exchange operations on a linearizable register blob always succeed. Repository analysis also verifies that contended operations either succeed or report the contention but do not return incorrect results. If an operation fails due to contention, Elasticsearch retries the operation until it succeeds. Most of the compare-and-exchange operations performed by repository analysis atomically increment a counter which is represented as an 8-byte blob. Some operations also verify the behavior on small blobs with sizes other than 8 bytes. || `repositoryAnalyze` | `repositoryAnalyze(this: [That](./That.md), params: [SnapshotRepositoryAnalyzeRequest](./SnapshotRepositoryAnalyzeRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SnapshotRepositoryAnalyzeResponse](./SnapshotRepositoryAnalyzeResponse.md), unknown>>;` |   || `repositoryAnalyze` | `repositoryAnalyze(this: [That](./That.md), params: [SnapshotRepositoryAnalyzeRequest](./SnapshotRepositoryAnalyzeRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SnapshotRepositoryAnalyzeResponse](./SnapshotRepositoryAnalyzeResponse.md)>;` |   || `repositoryVerifyIntegrity` | `repositoryVerifyIntegrity(this: [That](./That.md), params: [SnapshotRepositoryVerifyIntegrityRequest](./SnapshotRepositoryVerifyIntegrityRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SnapshotRepositoryVerifyIntegrityResponse](./SnapshotRepositoryVerifyIntegrityResponse.md)>;` | Verify the repository integrity. Verify the integrity of the contents of a snapshot repository. This API enables you to perform a comprehensive check of the contents of a repository, looking for any anomalies in its data or metadata which might prevent you from restoring snapshots from the repository or which might cause future snapshot create or delete operations to fail. If you suspect the integrity of the contents of one of your snapshot repositories, cease all write activity to this repository immediately, set its `read_only` option to `true`, and use this API to verify its integrity. Until you do so: * It may not be possible to restore some snapshots from this repository. * Searchable snapshots may report errors when searched or may have unassigned shards. * Taking snapshots into this repository may fail or may appear to succeed but have created a snapshot which cannot be restored. * Deleting snapshots from this repository may fail or may appear to succeed but leave the underlying data on disk. * Continuing to write to the repository while it is in an invalid state may causing additional damage to its contents. If the API finds any problems with the integrity of the contents of your repository, Elasticsearch will not be able to repair the damage. The only way to bring the repository back into a fully working state after its contents have been damaged is by restoring its contents from a repository backup which was taken before the damage occurred. You must also identify what caused the damage and take action to prevent it from happening again. If you cannot restore a repository backup, register a new repository and use this for all future snapshot operations. In some cases it may be possible to recover some of the contents of a damaged repository, either by restoring as many of its snapshots as needed and taking new snapshots of the restored data, or by using the reindex API to copy data from any searchable snapshots mounted from the damaged repository. Avoid all operations which write to the repository while the verify repository integrity API is running. If something changes the repository contents while an integrity verification is running then Elasticsearch may incorrectly report having detected some anomalies in its contents due to the concurrent writes. It may also incorrectly fail to report some anomalies that the concurrent writes prevented it from detecting. NOTE: This API is intended for exploratory use by humans. You should expect the request parameters and the response format to vary in future versions. NOTE: This API may not work correctly in a mixed-version cluster. The default values for the parameters of this API are designed to limit the impact of the integrity verification on other activities in your cluster. For instance, by default it will only use at most half of the `snapshot_meta` threads to verify the integrity of each snapshot, allowing other snapshot operations to use the other half of this thread pool. If you modify these parameters to speed up the verification process, you risk disrupting other snapshot-related operations in your cluster. For large repositories, consider setting up a separate single-node Elasticsearch cluster just for running the integrity verification API. The response exposes implementation details of the analysis which may change from version to version. The response body format is therefore not considered stable and may be different in newer versions. || `repositoryVerifyIntegrity` | `repositoryVerifyIntegrity(this: [That](./That.md), params: [SnapshotRepositoryVerifyIntegrityRequest](./SnapshotRepositoryVerifyIntegrityRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SnapshotRepositoryVerifyIntegrityResponse](./SnapshotRepositoryVerifyIntegrityResponse.md), unknown>>;` |   || `repositoryVerifyIntegrity` | `repositoryVerifyIntegrity(this: [That](./That.md), params: [SnapshotRepositoryVerifyIntegrityRequest](./SnapshotRepositoryVerifyIntegrityRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SnapshotRepositoryVerifyIntegrityResponse](./SnapshotRepositoryVerifyIntegrityResponse.md)>;` |   || `restore` | `restore(this: [That](./That.md), params: [SnapshotRestoreRequest](./SnapshotRestoreRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SnapshotRestoreResponse](./SnapshotRestoreResponse.md)>;` | Restore a snapshot. Restore a snapshot of a cluster or data streams and indices. You can restore a snapshot only to a running cluster with an elected master node. The snapshot repository must be registered and available to the cluster. The snapshot and cluster versions must be compatible. To restore a snapshot, the cluster's global metadata must be writable. Ensure there are't any cluster blocks that prevent writes. The restore operation ignores index blocks. Before you restore a data stream, ensure the cluster contains a matching index template with data streams enabled. To check, use the index management feature in Kibana or the get index template API: ``` GET _index_template/*?filter_path=index_templates.name,index_templates.index_template.index_patterns,index_templates.index_template.data_stream ``` If no such template exists, you can create one or restore a cluster state that contains one. Without a matching index template, a data stream can't roll over or create backing indices. If your snapshot contains data from App Search or Workplace Search, you must restore the Enterprise Search encryption key before you restore the snapshot. || `restore` | `restore(this: [That](./That.md), params: [SnapshotRestoreRequest](./SnapshotRestoreRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SnapshotRestoreResponse](./SnapshotRestoreResponse.md), unknown>>;` |   || `restore` | `restore(this: [That](./That.md), params: [SnapshotRestoreRequest](./SnapshotRestoreRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SnapshotRestoreResponse](./SnapshotRestoreResponse.md)>;` |   || `status` | `status(this: [That](./That.md), params?: [SnapshotStatusRequest](./SnapshotStatusRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SnapshotStatusResponse](./SnapshotStatusResponse.md)>;` | Get the snapshot status. Get a detailed description of the current state for each shard participating in the snapshot. Note that this API should be used only to obtain detailed shard-level information for ongoing snapshots. If this detail is not needed or you want to obtain information about one or more existing snapshots, use the get snapshot API. If you omit the `` request path parameter, the request retrieves information only for currently running snapshots. This usage is preferred. If needed, you can specify `` and `` to retrieve information for specific snapshots, even if they're not currently running. WARNING: Using the API to return the status of any snapshots other than currently running snapshots can be expensive. The API requires a read from the repository for each shard in each snapshot. For example, if you have 100 snapshots with 1,000 shards each, an API request that includes all snapshots will require 100,000 reads (100 snapshots x 1,000 shards). Depending on the latency of your storage, such requests can take an extremely long time to return results. These requests can also tax machine resources and, when using cloud storage, incur high processing costs. || `status` | `status(this: [That](./That.md), params?: [SnapshotStatusRequest](./SnapshotStatusRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SnapshotStatusResponse](./SnapshotStatusResponse.md), unknown>>;` |   || `status` | `status(this: [That](./That.md), params?: [SnapshotStatusRequest](./SnapshotStatusRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SnapshotStatusResponse](./SnapshotStatusResponse.md)>;` |   || `verifyRepository` | `verifyRepository(this: [That](./That.md), params: [SnapshotVerifyRepositoryRequest](./SnapshotVerifyRepositoryRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SnapshotVerifyRepositoryResponse](./SnapshotVerifyRepositoryResponse.md)>;` | Verify a snapshot repository. Check for common misconfigurations in a snapshot repository. || `verifyRepository` | `verifyRepository(this: [That](./That.md), params: [SnapshotVerifyRepositoryRequest](./SnapshotVerifyRepositoryRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SnapshotVerifyRepositoryResponse](./SnapshotVerifyRepositoryResponse.md), unknown>>;` |   || `verifyRepository` | `verifyRepository(this: [That](./That.md), params: [SnapshotVerifyRepositoryRequest](./SnapshotVerifyRepositoryRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SnapshotVerifyRepositoryResponse](./SnapshotVerifyRepositoryResponse.md)>;` |   | \ No newline at end of file +| `cleanupRepository` | `cleanupRepository(this: [That](./That.md), params: [SnapshotCleanupRepositoryRequest](./SnapshotCleanupRepositoryRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SnapshotCleanupRepositoryResponse](./SnapshotCleanupRepositoryResponse.md)>;` | Clean up the snapshot repository. Trigger the review of the contents of a snapshot repository and delete any stale data not referenced by existing snapshots. | +| `cleanupRepository` | `cleanupRepository(this: [That](./That.md), params: [SnapshotCleanupRepositoryRequest](./SnapshotCleanupRepositoryRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SnapshotCleanupRepositoryResponse](./SnapshotCleanupRepositoryResponse.md), unknown>>;` |   | +| `cleanupRepository` | `cleanupRepository(this: [That](./That.md), params: [SnapshotCleanupRepositoryRequest](./SnapshotCleanupRepositoryRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SnapshotCleanupRepositoryResponse](./SnapshotCleanupRepositoryResponse.md)>;` |   | +| `clone` | `clone(this: [That](./That.md), params: [SnapshotCloneRequest](./SnapshotCloneRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SnapshotCloneResponse](./SnapshotCloneResponse.md)>;` | Clone a snapshot. Clone part of all of a snapshot into another snapshot in the same repository. | +| `clone` | `clone(this: [That](./That.md), params: [SnapshotCloneRequest](./SnapshotCloneRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SnapshotCloneResponse](./SnapshotCloneResponse.md), unknown>>;` |   | +| `clone` | `clone(this: [That](./That.md), params: [SnapshotCloneRequest](./SnapshotCloneRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SnapshotCloneResponse](./SnapshotCloneResponse.md)>;` |   | +| `create` | `create(this: [That](./That.md), params: [SnapshotCreateRequest](./SnapshotCreateRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SnapshotCreateResponse](./SnapshotCreateResponse.md)>;` | Create a snapshot. Take a snapshot of a cluster or of data streams and indices. | +| `create` | `create(this: [That](./That.md), params: [SnapshotCreateRequest](./SnapshotCreateRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SnapshotCreateResponse](./SnapshotCreateResponse.md), unknown>>;` |   | +| `create` | `create(this: [That](./That.md), params: [SnapshotCreateRequest](./SnapshotCreateRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SnapshotCreateResponse](./SnapshotCreateResponse.md)>;` |   | +| `createRepository` | `createRepository(this: [That](./That.md), params: [SnapshotCreateRepositoryRequest](./SnapshotCreateRepositoryRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SnapshotCreateRepositoryResponse](./SnapshotCreateRepositoryResponse.md)>;` | Create or update a snapshot repository. IMPORTANT: If you are migrating searchable snapshots, the repository name must be identical in the source and destination clusters. To register a snapshot repository, the cluster's global metadata must be writeable. Ensure there are no cluster blocks (for example, `cluster.blocks.read_only` and `clsuter.blocks.read_only_allow_delete` settings) that prevent write access. Several options for this API can be specified using a query parameter or a request body parameter. If both parameters are specified, only the query parameter is used. | +| `createRepository` | `createRepository(this: [That](./That.md), params: [SnapshotCreateRepositoryRequest](./SnapshotCreateRepositoryRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SnapshotCreateRepositoryResponse](./SnapshotCreateRepositoryResponse.md), unknown>>;` |   | +| `createRepository` | `createRepository(this: [That](./That.md), params: [SnapshotCreateRepositoryRequest](./SnapshotCreateRepositoryRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SnapshotCreateRepositoryResponse](./SnapshotCreateRepositoryResponse.md)>;` |   | +| `delete` | `delete(this: [That](./That.md), params: [SnapshotDeleteRequest](./SnapshotDeleteRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SnapshotDeleteResponse](./SnapshotDeleteResponse.md)>;` | Delete snapshots. | +| `delete` | `delete(this: [That](./That.md), params: [SnapshotDeleteRequest](./SnapshotDeleteRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SnapshotDeleteResponse](./SnapshotDeleteResponse.md), unknown>>;` |   | +| `delete` | `delete(this: [That](./That.md), params: [SnapshotDeleteRequest](./SnapshotDeleteRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SnapshotDeleteResponse](./SnapshotDeleteResponse.md)>;` |   | +| `deleteRepository` | `deleteRepository(this: [That](./That.md), params: [SnapshotDeleteRepositoryRequest](./SnapshotDeleteRepositoryRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SnapshotDeleteRepositoryResponse](./SnapshotDeleteRepositoryResponse.md)>;` | Delete snapshot repositories. When a repository is unregistered, Elasticsearch removes only the reference to the location where the repository is storing the snapshots. The snapshots themselves are left untouched and in place. | +| `deleteRepository` | `deleteRepository(this: [That](./That.md), params: [SnapshotDeleteRepositoryRequest](./SnapshotDeleteRepositoryRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SnapshotDeleteRepositoryResponse](./SnapshotDeleteRepositoryResponse.md), unknown>>;` |   | +| `deleteRepository` | `deleteRepository(this: [That](./That.md), params: [SnapshotDeleteRepositoryRequest](./SnapshotDeleteRepositoryRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SnapshotDeleteRepositoryResponse](./SnapshotDeleteRepositoryResponse.md)>;` |   | +| `get` | `get(this: [That](./That.md), params: [SnapshotGetRequest](./SnapshotGetRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SnapshotGetResponse](./SnapshotGetResponse.md)>;` | Get snapshot information. NOTE: The `after` parameter and `next` field enable you to iterate through snapshots with some consistency guarantees regarding concurrent creation or deletion of snapshots. It is guaranteed that any snapshot that exists at the beginning of the iteration and is not concurrently deleted will be seen during the iteration. Snapshots concurrently created may be seen during an iteration. | +| `get` | `get(this: [That](./That.md), params: [SnapshotGetRequest](./SnapshotGetRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SnapshotGetResponse](./SnapshotGetResponse.md), unknown>>;` |   | +| `get` | `get(this: [That](./That.md), params: [SnapshotGetRequest](./SnapshotGetRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SnapshotGetResponse](./SnapshotGetResponse.md)>;` |   | +| `getRepository` | `getRepository(this: [That](./That.md), params?: [SnapshotGetRepositoryRequest](./SnapshotGetRepositoryRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SnapshotGetRepositoryResponse](./SnapshotGetRepositoryResponse.md)>;` | Get snapshot repository information. | +| `getRepository` | `getRepository(this: [That](./That.md), params?: [SnapshotGetRepositoryRequest](./SnapshotGetRepositoryRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SnapshotGetRepositoryResponse](./SnapshotGetRepositoryResponse.md), unknown>>;` |   | +| `getRepository` | `getRepository(this: [That](./That.md), params?: [SnapshotGetRepositoryRequest](./SnapshotGetRepositoryRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SnapshotGetRepositoryResponse](./SnapshotGetRepositoryResponse.md)>;` |   | +| `repositoryAnalyze` | `repositoryAnalyze(this: [That](./That.md), params: [SnapshotRepositoryAnalyzeRequest](./SnapshotRepositoryAnalyzeRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SnapshotRepositoryAnalyzeResponse](./SnapshotRepositoryAnalyzeResponse.md)>;` | Analyze a snapshot repository. Analyze the performance characteristics and any incorrect behaviour found in a repository. The response exposes implementation details of the analysis which may change from version to version. The response body format is therefore not considered stable and may be different in newer versions. There are a large number of third-party storage systems available, not all of which are suitable for use as a snapshot repository by Elasticsearch. Some storage systems behave incorrectly, or perform poorly, especially when accessed concurrently by multiple clients as the nodes of an Elasticsearch cluster do. This API performs a collection of read and write operations on your repository which are designed to detect incorrect behaviour and to measure the performance characteristics of your storage system. The default values for the parameters are deliberately low to reduce the impact of running an analysis inadvertently and to provide a sensible starting point for your investigations. Run your first analysis with the default parameter values to check for simple problems. If successful, run a sequence of increasingly large analyses until you encounter a failure or you reach a `blob_count` of at least `2000`, a `max_blob_size` of at least `2gb`, a `max_total_data_size` of at least `1tb`, and a `register_operation_count` of at least `100`. Always specify a generous timeout, possibly `1h` or longer, to allow time for each analysis to run to completion. Perform the analyses using a multi-node cluster of a similar size to your production cluster so that it can detect any problems that only arise when the repository is accessed by many nodes at once. If the analysis fails, Elasticsearch detected that your repository behaved unexpectedly. This usually means you are using a third-party storage system with an incorrect or incompatible implementation of the API it claims to support. If so, this storage system is not suitable for use as a snapshot repository. You will need to work with the supplier of your storage system to address the incompatibilities that Elasticsearch detects. If the analysis is successful, the API returns details of the testing process, optionally including how long each operation took. You can use this information to determine the performance of your storage system. If any operation fails or returns an incorrect result, the API returns an error. If the API returns an error, it may not have removed all the data it wrote to the repository. The error will indicate the location of any leftover data and this path is also recorded in the Elasticsearch logs. You should verify that this location has been cleaned up correctly. If there is still leftover data at the specified location, you should manually remove it. If the connection from your client to Elasticsearch is closed while the client is waiting for the result of the analysis, the test is cancelled. Some clients are configured to close their connection if no response is received within a certain timeout. An analysis takes a long time to complete so you might need to relax any such client-side timeouts. On cancellation the analysis attempts to clean up the data it was writing, but it may not be able to remove it all. The path to the leftover data is recorded in the Elasticsearch logs. You should verify that this location has been cleaned up correctly. If there is still leftover data at the specified location, you should manually remove it. If the analysis is successful then it detected no incorrect behaviour, but this does not mean that correct behaviour is guaranteed. The analysis attempts to detect common bugs but it does not offer 100% coverage. Additionally, it does not test the following: * Your repository must perform durable writes. Once a blob has been written it must remain in place until it is deleted, even after a power loss or similar disaster. * Your repository must not suffer from silent data corruption. Once a blob has been written, its contents must remain unchanged until it is deliberately modified or deleted. * Your repository must behave correctly even if connectivity from the cluster is disrupted. Reads and writes may fail in this case, but they must not return incorrect results. IMPORTANT: An analysis writes a substantial amount of data to your repository and then reads it back again. This consumes bandwidth on the network between the cluster and the repository, and storage space and I/O bandwidth on the repository itself. You must ensure this load does not affect other users of these systems. Analyses respect the repository settings `max_snapshot_bytes_per_sec` and `max_restore_bytes_per_sec` if available and the cluster setting `indices.recovery.max_bytes_per_sec` which you can use to limit the bandwidth they consume. NOTE: This API is intended for exploratory use by humans. You should expect the request parameters and the response format to vary in future versions. NOTE: Different versions of Elasticsearch may perform different checks for repository compatibility, with newer versions typically being stricter than older ones. A storage system that passes repository analysis with one version of Elasticsearch may fail with a different version. This indicates it behaves incorrectly in ways that the former version did not detect. You must work with the supplier of your storage system to address the incompatibilities detected by the repository analysis API in any version of Elasticsearch. NOTE: This API may not work correctly in a mixed-version cluster. *Implementation details* NOTE: This section of documentation describes how the repository analysis API works in this version of Elasticsearch, but you should expect the implementation to vary between versions. The request parameters and response format depend on details of the implementation so may also be different in newer versions. The analysis comprises a number of blob-level tasks, as set by the `blob_count` parameter and a number of compare-and-exchange operations on linearizable registers, as set by the `register_operation_count` parameter. These tasks are distributed over the data and master-eligible nodes in the cluster for execution. For most blob-level tasks, the executing node first writes a blob to the repository and then instructs some of the other nodes in the cluster to attempt to read the data it just wrote. The size of the blob is chosen randomly, according to the `max_blob_size` and `max_total_data_size` parameters. If any of these reads fails then the repository does not implement the necessary read-after-write semantics that Elasticsearch requires. For some blob-level tasks, the executing node will instruct some of its peers to attempt to read the data before the writing process completes. These reads are permitted to fail, but must not return partial data. If any read returns partial data then the repository does not implement the necessary atomicity semantics that Elasticsearch requires. For some blob-level tasks, the executing node will overwrite the blob while its peers are reading it. In this case the data read may come from either the original or the overwritten blob, but the read operation must not return partial data or a mix of data from the two blobs. If any of these reads returns partial data or a mix of the two blobs then the repository does not implement the necessary atomicity semantics that Elasticsearch requires for overwrites. The executing node will use a variety of different methods to write the blob. For instance, where applicable, it will use both single-part and multi-part uploads. Similarly, the reading nodes will use a variety of different methods to read the data back again. For instance they may read the entire blob from start to end or may read only a subset of the data. For some blob-level tasks, the executing node will cancel the write before it is complete. In this case, it still instructs some of the other nodes in the cluster to attempt to read the blob but all of these reads must fail to find the blob. Linearizable registers are special blobs that Elasticsearch manipulates using an atomic compare-and-exchange operation. This operation ensures correct and strongly-consistent behavior even when the blob is accessed by multiple nodes at the same time. The detailed implementation of the compare-and-exchange operation on linearizable registers varies by repository type. Repository analysis verifies that that uncontended compare-and-exchange operations on a linearizable register blob always succeed. Repository analysis also verifies that contended operations either succeed or report the contention but do not return incorrect results. If an operation fails due to contention, Elasticsearch retries the operation until it succeeds. Most of the compare-and-exchange operations performed by repository analysis atomically increment a counter which is represented as an 8-byte blob. Some operations also verify the behavior on small blobs with sizes other than 8 bytes. | +| `repositoryAnalyze` | `repositoryAnalyze(this: [That](./That.md), params: [SnapshotRepositoryAnalyzeRequest](./SnapshotRepositoryAnalyzeRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SnapshotRepositoryAnalyzeResponse](./SnapshotRepositoryAnalyzeResponse.md), unknown>>;` |   | +| `repositoryAnalyze` | `repositoryAnalyze(this: [That](./That.md), params: [SnapshotRepositoryAnalyzeRequest](./SnapshotRepositoryAnalyzeRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SnapshotRepositoryAnalyzeResponse](./SnapshotRepositoryAnalyzeResponse.md)>;` |   | +| `repositoryVerifyIntegrity` | `repositoryVerifyIntegrity(this: [That](./That.md), params: [SnapshotRepositoryVerifyIntegrityRequest](./SnapshotRepositoryVerifyIntegrityRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SnapshotRepositoryVerifyIntegrityResponse](./SnapshotRepositoryVerifyIntegrityResponse.md)>;` | Verify the repository integrity. Verify the integrity of the contents of a snapshot repository. This API enables you to perform a comprehensive check of the contents of a repository, looking for any anomalies in its data or metadata which might prevent you from restoring snapshots from the repository or which might cause future snapshot create or delete operations to fail. If you suspect the integrity of the contents of one of your snapshot repositories, cease all write activity to this repository immediately, set its `read_only` option to `true`, and use this API to verify its integrity. Until you do so: * It may not be possible to restore some snapshots from this repository. * Searchable snapshots may report errors when searched or may have unassigned shards. * Taking snapshots into this repository may fail or may appear to succeed but have created a snapshot which cannot be restored. * Deleting snapshots from this repository may fail or may appear to succeed but leave the underlying data on disk. * Continuing to write to the repository while it is in an invalid state may causing additional damage to its contents. If the API finds any problems with the integrity of the contents of your repository, Elasticsearch will not be able to repair the damage. The only way to bring the repository back into a fully working state after its contents have been damaged is by restoring its contents from a repository backup which was taken before the damage occurred. You must also identify what caused the damage and take action to prevent it from happening again. If you cannot restore a repository backup, register a new repository and use this for all future snapshot operations. In some cases it may be possible to recover some of the contents of a damaged repository, either by restoring as many of its snapshots as needed and taking new snapshots of the restored data, or by using the reindex API to copy data from any searchable snapshots mounted from the damaged repository. Avoid all operations which write to the repository while the verify repository integrity API is running. If something changes the repository contents while an integrity verification is running then Elasticsearch may incorrectly report having detected some anomalies in its contents due to the concurrent writes. It may also incorrectly fail to report some anomalies that the concurrent writes prevented it from detecting. NOTE: This API is intended for exploratory use by humans. You should expect the request parameters and the response format to vary in future versions. NOTE: This API may not work correctly in a mixed-version cluster. The default values for the parameters of this API are designed to limit the impact of the integrity verification on other activities in your cluster. For instance, by default it will only use at most half of the `snapshot_meta` threads to verify the integrity of each snapshot, allowing other snapshot operations to use the other half of this thread pool. If you modify these parameters to speed up the verification process, you risk disrupting other snapshot-related operations in your cluster. For large repositories, consider setting up a separate single-node Elasticsearch cluster just for running the integrity verification API. The response exposes implementation details of the analysis which may change from version to version. The response body format is therefore not considered stable and may be different in newer versions. | +| `repositoryVerifyIntegrity` | `repositoryVerifyIntegrity(this: [That](./That.md), params: [SnapshotRepositoryVerifyIntegrityRequest](./SnapshotRepositoryVerifyIntegrityRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SnapshotRepositoryVerifyIntegrityResponse](./SnapshotRepositoryVerifyIntegrityResponse.md), unknown>>;` |   | +| `repositoryVerifyIntegrity` | `repositoryVerifyIntegrity(this: [That](./That.md), params: [SnapshotRepositoryVerifyIntegrityRequest](./SnapshotRepositoryVerifyIntegrityRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SnapshotRepositoryVerifyIntegrityResponse](./SnapshotRepositoryVerifyIntegrityResponse.md)>;` |   | +| `restore` | `restore(this: [That](./That.md), params: [SnapshotRestoreRequest](./SnapshotRestoreRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SnapshotRestoreResponse](./SnapshotRestoreResponse.md)>;` | Restore a snapshot. Restore a snapshot of a cluster or data streams and indices. You can restore a snapshot only to a running cluster with an elected master node. The snapshot repository must be registered and available to the cluster. The snapshot and cluster versions must be compatible. To restore a snapshot, the cluster's global metadata must be writable. Ensure there are't any cluster blocks that prevent writes. The restore operation ignores index blocks. Before you restore a data stream, ensure the cluster contains a matching index template with data streams enabled. To check, use the index management feature in Kibana or the get index template API: ``` GET _index_template/*?filter_path=index_templates.name,index_templates.index_template.index_patterns,index_templates.index_template.data_stream ``` If no such template exists, you can create one or restore a cluster state that contains one. Without a matching index template, a data stream can't roll over or create backing indices. If your snapshot contains data from App Search or Workplace Search, you must restore the Enterprise Search encryption key before you restore the snapshot. | +| `restore` | `restore(this: [That](./That.md), params: [SnapshotRestoreRequest](./SnapshotRestoreRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SnapshotRestoreResponse](./SnapshotRestoreResponse.md), unknown>>;` |   | +| `restore` | `restore(this: [That](./That.md), params: [SnapshotRestoreRequest](./SnapshotRestoreRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SnapshotRestoreResponse](./SnapshotRestoreResponse.md)>;` |   | +| `status` | `status(this: [That](./That.md), params?: [SnapshotStatusRequest](./SnapshotStatusRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SnapshotStatusResponse](./SnapshotStatusResponse.md)>;` | Get the snapshot status. Get a detailed description of the current state for each shard participating in the snapshot. Note that this API should be used only to obtain detailed shard-level information for ongoing snapshots. If this detail is not needed or you want to obtain information about one or more existing snapshots, use the get snapshot API. If you omit the `` request path parameter, the request retrieves information only for currently running snapshots. This usage is preferred. If needed, you can specify `` and `` to retrieve information for specific snapshots, even if they're not currently running. WARNING: Using the API to return the status of any snapshots other than currently running snapshots can be expensive. The API requires a read from the repository for each shard in each snapshot. For example, if you have 100 snapshots with 1,000 shards each, an API request that includes all snapshots will require 100,000 reads (100 snapshots x 1,000 shards). Depending on the latency of your storage, such requests can take an extremely long time to return results. These requests can also tax machine resources and, when using cloud storage, incur high processing costs. | +| `status` | `status(this: [That](./That.md), params?: [SnapshotStatusRequest](./SnapshotStatusRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SnapshotStatusResponse](./SnapshotStatusResponse.md), unknown>>;` |   | +| `status` | `status(this: [That](./That.md), params?: [SnapshotStatusRequest](./SnapshotStatusRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SnapshotStatusResponse](./SnapshotStatusResponse.md)>;` |   | +| `verifyRepository` | `verifyRepository(this: [That](./That.md), params: [SnapshotVerifyRepositoryRequest](./SnapshotVerifyRepositoryRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SnapshotVerifyRepositoryResponse](./SnapshotVerifyRepositoryResponse.md)>;` | Verify a snapshot repository. Check for common misconfigurations in a snapshot repository. | +| `verifyRepository` | `verifyRepository(this: [That](./That.md), params: [SnapshotVerifyRepositoryRequest](./SnapshotVerifyRepositoryRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SnapshotVerifyRepositoryResponse](./SnapshotVerifyRepositoryResponse.md), unknown>>;` |   | +| `verifyRepository` | `verifyRepository(this: [That](./That.md), params: [SnapshotVerifyRepositoryRequest](./SnapshotVerifyRepositoryRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SnapshotVerifyRepositoryResponse](./SnapshotVerifyRepositoryResponse.md)>;` |   | diff --git a/docs/reference/api/SniffingTransport.md b/docs/reference/api/SniffingTransport.md index 5b9d59fd3..a96d2b431 100644 --- a/docs/reference/api/SniffingTransport.md +++ b/docs/reference/api/SniffingTransport.md @@ -7,4 +7,4 @@ | Name | Signature | Description | | - | - | - | -| `sniff` | `sniff(opts: [SniffOptions](./SniffOptions.md)): void;` |   | \ No newline at end of file +| `sniff` | `sniff(opts: [SniffOptions](./SniffOptions.md)): void;` |   | diff --git a/docs/reference/api/Sql.md b/docs/reference/api/Sql.md index b296ecc19..56885fbf8 100644 --- a/docs/reference/api/Sql.md +++ b/docs/reference/api/Sql.md @@ -17,4 +17,21 @@ new Sql(transport: [Transport](./Transport.md)); | Name | Signature | Description | | - | - | - | -| `clearCursor` | `clearCursor(this: [That](./That.md), params: [SqlClearCursorRequest](./SqlClearCursorRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SqlClearCursorResponse](./SqlClearCursorResponse.md)>;` | Clear an SQL search cursor. || `clearCursor` | `clearCursor(this: [That](./That.md), params: [SqlClearCursorRequest](./SqlClearCursorRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SqlClearCursorResponse](./SqlClearCursorResponse.md), unknown>>;` |   || `clearCursor` | `clearCursor(this: [That](./That.md), params: [SqlClearCursorRequest](./SqlClearCursorRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SqlClearCursorResponse](./SqlClearCursorResponse.md)>;` |   || `deleteAsync` | `deleteAsync(this: [That](./That.md), params: [SqlDeleteAsyncRequest](./SqlDeleteAsyncRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SqlDeleteAsyncResponse](./SqlDeleteAsyncResponse.md)>;` | Delete an async SQL search. Delete an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it. If the Elasticsearch security features are enabled, only the following users can use this API to delete a search: * Users with the `cancel_task` cluster privilege. * The user who first submitted the search. || `deleteAsync` | `deleteAsync(this: [That](./That.md), params: [SqlDeleteAsyncRequest](./SqlDeleteAsyncRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SqlDeleteAsyncResponse](./SqlDeleteAsyncResponse.md), unknown>>;` |   || `deleteAsync` | `deleteAsync(this: [That](./That.md), params: [SqlDeleteAsyncRequest](./SqlDeleteAsyncRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SqlDeleteAsyncResponse](./SqlDeleteAsyncResponse.md)>;` |   || `getAsync` | `getAsync(this: [That](./That.md), params: [SqlGetAsyncRequest](./SqlGetAsyncRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SqlGetAsyncResponse](./SqlGetAsyncResponse.md)>;` | Get async SQL search results. Get the current status and available results for an async SQL search or stored synchronous SQL search. If the Elasticsearch security features are enabled, only the user who first submitted the SQL search can retrieve the search using this API. || `getAsync` | `getAsync(this: [That](./That.md), params: [SqlGetAsyncRequest](./SqlGetAsyncRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SqlGetAsyncResponse](./SqlGetAsyncResponse.md), unknown>>;` |   || `getAsync` | `getAsync(this: [That](./That.md), params: [SqlGetAsyncRequest](./SqlGetAsyncRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SqlGetAsyncResponse](./SqlGetAsyncResponse.md)>;` |   || `getAsyncStatus` | `getAsyncStatus(this: [That](./That.md), params: [SqlGetAsyncStatusRequest](./SqlGetAsyncStatusRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SqlGetAsyncStatusResponse](./SqlGetAsyncStatusResponse.md)>;` | Get the async SQL search status. Get the current status of an async SQL search or a stored synchronous SQL search. || `getAsyncStatus` | `getAsyncStatus(this: [That](./That.md), params: [SqlGetAsyncStatusRequest](./SqlGetAsyncStatusRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SqlGetAsyncStatusResponse](./SqlGetAsyncStatusResponse.md), unknown>>;` |   || `getAsyncStatus` | `getAsyncStatus(this: [That](./That.md), params: [SqlGetAsyncStatusRequest](./SqlGetAsyncStatusRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SqlGetAsyncStatusResponse](./SqlGetAsyncStatusResponse.md)>;` |   || `query` | `query(this: [That](./That.md), params?: [SqlQueryRequest](./SqlQueryRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SqlQueryResponse](./SqlQueryResponse.md)>;` | Get SQL search results. Run an SQL request. || `query` | `query(this: [That](./That.md), params?: [SqlQueryRequest](./SqlQueryRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SqlQueryResponse](./SqlQueryResponse.md), unknown>>;` |   || `query` | `query(this: [That](./That.md), params?: [SqlQueryRequest](./SqlQueryRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SqlQueryResponse](./SqlQueryResponse.md)>;` |   || `translate` | `translate(this: [That](./That.md), params: [SqlTranslateRequest](./SqlTranslateRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SqlTranslateResponse](./SqlTranslateResponse.md)>;` | Translate SQL into Elasticsearch queries. Translate an SQL search into a search API request containing Query DSL. It accepts the same request body parameters as the SQL search API, excluding `cursor`. || `translate` | `translate(this: [That](./That.md), params: [SqlTranslateRequest](./SqlTranslateRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SqlTranslateResponse](./SqlTranslateResponse.md), unknown>>;` |   || `translate` | `translate(this: [That](./That.md), params: [SqlTranslateRequest](./SqlTranslateRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SqlTranslateResponse](./SqlTranslateResponse.md)>;` |   | \ No newline at end of file +| `clearCursor` | `clearCursor(this: [That](./That.md), params: [SqlClearCursorRequest](./SqlClearCursorRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SqlClearCursorResponse](./SqlClearCursorResponse.md)>;` | Clear an SQL search cursor. | +| `clearCursor` | `clearCursor(this: [That](./That.md), params: [SqlClearCursorRequest](./SqlClearCursorRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SqlClearCursorResponse](./SqlClearCursorResponse.md), unknown>>;` |   | +| `clearCursor` | `clearCursor(this: [That](./That.md), params: [SqlClearCursorRequest](./SqlClearCursorRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SqlClearCursorResponse](./SqlClearCursorResponse.md)>;` |   | +| `deleteAsync` | `deleteAsync(this: [That](./That.md), params: [SqlDeleteAsyncRequest](./SqlDeleteAsyncRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SqlDeleteAsyncResponse](./SqlDeleteAsyncResponse.md)>;` | Delete an async SQL search. Delete an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it. If the Elasticsearch security features are enabled, only the following users can use this API to delete a search: * Users with the `cancel_task` cluster privilege. * The user who first submitted the search. | +| `deleteAsync` | `deleteAsync(this: [That](./That.md), params: [SqlDeleteAsyncRequest](./SqlDeleteAsyncRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SqlDeleteAsyncResponse](./SqlDeleteAsyncResponse.md), unknown>>;` |   | +| `deleteAsync` | `deleteAsync(this: [That](./That.md), params: [SqlDeleteAsyncRequest](./SqlDeleteAsyncRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SqlDeleteAsyncResponse](./SqlDeleteAsyncResponse.md)>;` |   | +| `getAsync` | `getAsync(this: [That](./That.md), params: [SqlGetAsyncRequest](./SqlGetAsyncRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SqlGetAsyncResponse](./SqlGetAsyncResponse.md)>;` | Get async SQL search results. Get the current status and available results for an async SQL search or stored synchronous SQL search. If the Elasticsearch security features are enabled, only the user who first submitted the SQL search can retrieve the search using this API. | +| `getAsync` | `getAsync(this: [That](./That.md), params: [SqlGetAsyncRequest](./SqlGetAsyncRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SqlGetAsyncResponse](./SqlGetAsyncResponse.md), unknown>>;` |   | +| `getAsync` | `getAsync(this: [That](./That.md), params: [SqlGetAsyncRequest](./SqlGetAsyncRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SqlGetAsyncResponse](./SqlGetAsyncResponse.md)>;` |   | +| `getAsyncStatus` | `getAsyncStatus(this: [That](./That.md), params: [SqlGetAsyncStatusRequest](./SqlGetAsyncStatusRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SqlGetAsyncStatusResponse](./SqlGetAsyncStatusResponse.md)>;` | Get the async SQL search status. Get the current status of an async SQL search or a stored synchronous SQL search. | +| `getAsyncStatus` | `getAsyncStatus(this: [That](./That.md), params: [SqlGetAsyncStatusRequest](./SqlGetAsyncStatusRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SqlGetAsyncStatusResponse](./SqlGetAsyncStatusResponse.md), unknown>>;` |   | +| `getAsyncStatus` | `getAsyncStatus(this: [That](./That.md), params: [SqlGetAsyncStatusRequest](./SqlGetAsyncStatusRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SqlGetAsyncStatusResponse](./SqlGetAsyncStatusResponse.md)>;` |   | +| `query` | `query(this: [That](./That.md), params?: [SqlQueryRequest](./SqlQueryRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SqlQueryResponse](./SqlQueryResponse.md)>;` | Get SQL search results. Run an SQL request. | +| `query` | `query(this: [That](./That.md), params?: [SqlQueryRequest](./SqlQueryRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SqlQueryResponse](./SqlQueryResponse.md), unknown>>;` |   | +| `query` | `query(this: [That](./That.md), params?: [SqlQueryRequest](./SqlQueryRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SqlQueryResponse](./SqlQueryResponse.md)>;` |   | +| `translate` | `translate(this: [That](./That.md), params: [SqlTranslateRequest](./SqlTranslateRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SqlTranslateResponse](./SqlTranslateResponse.md)>;` | Translate SQL into Elasticsearch queries. Translate an SQL search into a search API request containing Query DSL. It accepts the same request body parameters as the SQL search API, excluding `cursor`. | +| `translate` | `translate(this: [That](./That.md), params: [SqlTranslateRequest](./SqlTranslateRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SqlTranslateResponse](./SqlTranslateResponse.md), unknown>>;` |   | +| `translate` | `translate(this: [That](./That.md), params: [SqlTranslateRequest](./SqlTranslateRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SqlTranslateResponse](./SqlTranslateResponse.md)>;` |   | diff --git a/docs/reference/api/Ssl.md b/docs/reference/api/Ssl.md index 3d6f08430..2931448ae 100644 --- a/docs/reference/api/Ssl.md +++ b/docs/reference/api/Ssl.md @@ -17,4 +17,6 @@ new Ssl(transport: [Transport](./Transport.md)); | Name | Signature | Description | | - | - | - | -| `certificates` | `certificates(this: [That](./That.md), params?: [SslCertificatesRequest](./SslCertificatesRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SslCertificatesResponse](./SslCertificatesResponse.md)>;` | Get SSL certificates. Get information about the X.509 certificates that are used to encrypt communications in the cluster. The API returns a list that includes certificates from all TLS contexts including: - Settings for transport and HTTP interfaces - TLS settings that are used within authentication realms - TLS settings for remote monitoring exporters The list includes certificates that are used for configuring trust, such as those configured in the `xpack.security.transport.ssl.truststore` and `xpack.security.transport.ssl.certificate_authorities` settings. It also includes certificates that are used for configuring server identity, such as `xpack.security.http.ssl.keystore` and `xpack.security.http.ssl.certificate settings`. The list does not include certificates that are sourced from the default SSL context of the Java Runtime Environment (JRE), even if those certificates are in use within Elasticsearch. NOTE: When a PKCS#11 token is configured as the truststore of the JRE, the API returns all the certificates that are included in the PKCS#11 token irrespective of whether these are used in the Elasticsearch TLS configuration. If Elasticsearch is configured to use a keystore or truststore, the API output includes all certificates in that store, even though some of the certificates might not be in active use within the cluster. || `certificates` | `certificates(this: [That](./That.md), params?: [SslCertificatesRequest](./SslCertificatesRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SslCertificatesResponse](./SslCertificatesResponse.md), unknown>>;` |   || `certificates` | `certificates(this: [That](./That.md), params?: [SslCertificatesRequest](./SslCertificatesRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SslCertificatesResponse](./SslCertificatesResponse.md)>;` |   | \ No newline at end of file +| `certificates` | `certificates(this: [That](./That.md), params?: [SslCertificatesRequest](./SslCertificatesRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SslCertificatesResponse](./SslCertificatesResponse.md)>;` | Get SSL certificates. Get information about the X.509 certificates that are used to encrypt communications in the cluster. The API returns a list that includes certificates from all TLS contexts including: - Settings for transport and HTTP interfaces - TLS settings that are used within authentication realms - TLS settings for remote monitoring exporters The list includes certificates that are used for configuring trust, such as those configured in the `xpack.security.transport.ssl.truststore` and `xpack.security.transport.ssl.certificate_authorities` settings. It also includes certificates that are used for configuring server identity, such as `xpack.security.http.ssl.keystore` and `xpack.security.http.ssl.certificate settings`. The list does not include certificates that are sourced from the default SSL context of the Java Runtime Environment (JRE), even if those certificates are in use within Elasticsearch. NOTE: When a PKCS#11 token is configured as the truststore of the JRE, the API returns all the certificates that are included in the PKCS#11 token irrespective of whether these are used in the Elasticsearch TLS configuration. If Elasticsearch is configured to use a keystore or truststore, the API output includes all certificates in that store, even though some of the certificates might not be in active use within the cluster. | +| `certificates` | `certificates(this: [That](./That.md), params?: [SslCertificatesRequest](./SslCertificatesRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SslCertificatesResponse](./SslCertificatesResponse.md), unknown>>;` |   | +| `certificates` | `certificates(this: [That](./That.md), params?: [SslCertificatesRequest](./SslCertificatesRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SslCertificatesResponse](./SslCertificatesResponse.md)>;` |   | diff --git a/docs/reference/api/Synonyms.md b/docs/reference/api/Synonyms.md index 90a98aeff..7e31d60e4 100644 --- a/docs/reference/api/Synonyms.md +++ b/docs/reference/api/Synonyms.md @@ -17,4 +17,24 @@ new Synonyms(transport: [Transport](./Transport.md)); | Name | Signature | Description | | - | - | - | -| `deleteSynonym` | `deleteSynonym(this: [That](./That.md), params: [SynonymsDeleteSynonymRequest](./SynonymsDeleteSynonymRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SynonymsDeleteSynonymResponse](./SynonymsDeleteSynonymResponse.md)>;` | Delete a synonym set. You can only delete a synonyms set that is not in use by any index analyzer. Synonyms sets can be used in synonym graph token filters and synonym token filters. These synonym filters can be used as part of search analyzers. Analyzers need to be loaded when an index is restored (such as when a node starts, or the index becomes open). Even if the analyzer is not used on any field mapping, it still needs to be loaded on the index recovery phase. If any analyzers cannot be loaded, the index becomes unavailable and the cluster status becomes red or yellow as index shards are not available. To prevent that, synonyms sets that are used in analyzers can't be deleted. A delete request in this case will return a 400 response code. To remove a synonyms set, you must first remove all indices that contain analyzers using it. You can migrate an index by creating a new index that does not contain the token filter with the synonyms set, and use the reindex API in order to copy over the index data. Once finished, you can delete the index. When the synonyms set is not used in analyzers, you will be able to delete it. || `deleteSynonym` | `deleteSynonym(this: [That](./That.md), params: [SynonymsDeleteSynonymRequest](./SynonymsDeleteSynonymRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SynonymsDeleteSynonymResponse](./SynonymsDeleteSynonymResponse.md), unknown>>;` |   || `deleteSynonym` | `deleteSynonym(this: [That](./That.md), params: [SynonymsDeleteSynonymRequest](./SynonymsDeleteSynonymRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SynonymsDeleteSynonymResponse](./SynonymsDeleteSynonymResponse.md)>;` |   || `deleteSynonymRule` | `deleteSynonymRule(this: [That](./That.md), params: [SynonymsDeleteSynonymRuleRequest](./SynonymsDeleteSynonymRuleRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SynonymsDeleteSynonymRuleResponse](./SynonymsDeleteSynonymRuleResponse.md)>;` | Delete a synonym rule. Delete a synonym rule from a synonym set. || `deleteSynonymRule` | `deleteSynonymRule(this: [That](./That.md), params: [SynonymsDeleteSynonymRuleRequest](./SynonymsDeleteSynonymRuleRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SynonymsDeleteSynonymRuleResponse](./SynonymsDeleteSynonymRuleResponse.md), unknown>>;` |   || `deleteSynonymRule` | `deleteSynonymRule(this: [That](./That.md), params: [SynonymsDeleteSynonymRuleRequest](./SynonymsDeleteSynonymRuleRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SynonymsDeleteSynonymRuleResponse](./SynonymsDeleteSynonymRuleResponse.md)>;` |   || `getSynonym` | `getSynonym(this: [That](./That.md), params: [SynonymsGetSynonymRequest](./SynonymsGetSynonymRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SynonymsGetSynonymResponse](./SynonymsGetSynonymResponse.md)>;` | Get a synonym set. || `getSynonym` | `getSynonym(this: [That](./That.md), params: [SynonymsGetSynonymRequest](./SynonymsGetSynonymRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SynonymsGetSynonymResponse](./SynonymsGetSynonymResponse.md), unknown>>;` |   || `getSynonym` | `getSynonym(this: [That](./That.md), params: [SynonymsGetSynonymRequest](./SynonymsGetSynonymRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SynonymsGetSynonymResponse](./SynonymsGetSynonymResponse.md)>;` |   || `getSynonymRule` | `getSynonymRule(this: [That](./That.md), params: [SynonymsGetSynonymRuleRequest](./SynonymsGetSynonymRuleRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SynonymsGetSynonymRuleResponse](./SynonymsGetSynonymRuleResponse.md)>;` | Get a synonym rule. Get a synonym rule from a synonym set. || `getSynonymRule` | `getSynonymRule(this: [That](./That.md), params: [SynonymsGetSynonymRuleRequest](./SynonymsGetSynonymRuleRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SynonymsGetSynonymRuleResponse](./SynonymsGetSynonymRuleResponse.md), unknown>>;` |   || `getSynonymRule` | `getSynonymRule(this: [That](./That.md), params: [SynonymsGetSynonymRuleRequest](./SynonymsGetSynonymRuleRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SynonymsGetSynonymRuleResponse](./SynonymsGetSynonymRuleResponse.md)>;` |   || `getSynonymsSets` | `getSynonymsSets(this: [That](./That.md), params?: [SynonymsGetSynonymsSetsRequest](./SynonymsGetSynonymsSetsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SynonymsGetSynonymsSetsResponse](./SynonymsGetSynonymsSetsResponse.md)>;` | Get all synonym sets. Get a summary of all defined synonym sets. || `getSynonymsSets` | `getSynonymsSets(this: [That](./That.md), params?: [SynonymsGetSynonymsSetsRequest](./SynonymsGetSynonymsSetsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SynonymsGetSynonymsSetsResponse](./SynonymsGetSynonymsSetsResponse.md), unknown>>;` |   || `getSynonymsSets` | `getSynonymsSets(this: [That](./That.md), params?: [SynonymsGetSynonymsSetsRequest](./SynonymsGetSynonymsSetsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SynonymsGetSynonymsSetsResponse](./SynonymsGetSynonymsSetsResponse.md)>;` |   || `putSynonym` | `putSynonym(this: [That](./That.md), params: [SynonymsPutSynonymRequest](./SynonymsPutSynonymRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SynonymsPutSynonymResponse](./SynonymsPutSynonymResponse.md)>;` | Create or update a synonym set. Synonyms sets are limited to a maximum of 10,000 synonym rules per set. If you need to manage more synonym rules, you can create multiple synonym sets. When an existing synonyms set is updated, the search analyzers that use the synonyms set are reloaded automatically for all indices. This is equivalent to invoking the reload search analyzers API for all indices that use the synonyms set. || `putSynonym` | `putSynonym(this: [That](./That.md), params: [SynonymsPutSynonymRequest](./SynonymsPutSynonymRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SynonymsPutSynonymResponse](./SynonymsPutSynonymResponse.md), unknown>>;` |   || `putSynonym` | `putSynonym(this: [That](./That.md), params: [SynonymsPutSynonymRequest](./SynonymsPutSynonymRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SynonymsPutSynonymResponse](./SynonymsPutSynonymResponse.md)>;` |   || `putSynonymRule` | `putSynonymRule(this: [That](./That.md), params: [SynonymsPutSynonymRuleRequest](./SynonymsPutSynonymRuleRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SynonymsPutSynonymRuleResponse](./SynonymsPutSynonymRuleResponse.md)>;` | Create or update a synonym rule. Create or update a synonym rule in a synonym set. If any of the synonym rules included is invalid, the API returns an error. When you update a synonym rule, all analyzers using the synonyms set will be reloaded automatically to reflect the new rule. || `putSynonymRule` | `putSynonymRule(this: [That](./That.md), params: [SynonymsPutSynonymRuleRequest](./SynonymsPutSynonymRuleRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SynonymsPutSynonymRuleResponse](./SynonymsPutSynonymRuleResponse.md), unknown>>;` |   || `putSynonymRule` | `putSynonymRule(this: [That](./That.md), params: [SynonymsPutSynonymRuleRequest](./SynonymsPutSynonymRuleRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SynonymsPutSynonymRuleResponse](./SynonymsPutSynonymRuleResponse.md)>;` |   | \ No newline at end of file +| `deleteSynonym` | `deleteSynonym(this: [That](./That.md), params: [SynonymsDeleteSynonymRequest](./SynonymsDeleteSynonymRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SynonymsDeleteSynonymResponse](./SynonymsDeleteSynonymResponse.md)>;` | Delete a synonym set. You can only delete a synonyms set that is not in use by any index analyzer. Synonyms sets can be used in synonym graph token filters and synonym token filters. These synonym filters can be used as part of search analyzers. Analyzers need to be loaded when an index is restored (such as when a node starts, or the index becomes open). Even if the analyzer is not used on any field mapping, it still needs to be loaded on the index recovery phase. If any analyzers cannot be loaded, the index becomes unavailable and the cluster status becomes red or yellow as index shards are not available. To prevent that, synonyms sets that are used in analyzers can't be deleted. A delete request in this case will return a 400 response code. To remove a synonyms set, you must first remove all indices that contain analyzers using it. You can migrate an index by creating a new index that does not contain the token filter with the synonyms set, and use the reindex API in order to copy over the index data. Once finished, you can delete the index. When the synonyms set is not used in analyzers, you will be able to delete it. | +| `deleteSynonym` | `deleteSynonym(this: [That](./That.md), params: [SynonymsDeleteSynonymRequest](./SynonymsDeleteSynonymRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SynonymsDeleteSynonymResponse](./SynonymsDeleteSynonymResponse.md), unknown>>;` |   | +| `deleteSynonym` | `deleteSynonym(this: [That](./That.md), params: [SynonymsDeleteSynonymRequest](./SynonymsDeleteSynonymRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SynonymsDeleteSynonymResponse](./SynonymsDeleteSynonymResponse.md)>;` |   | +| `deleteSynonymRule` | `deleteSynonymRule(this: [That](./That.md), params: [SynonymsDeleteSynonymRuleRequest](./SynonymsDeleteSynonymRuleRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SynonymsDeleteSynonymRuleResponse](./SynonymsDeleteSynonymRuleResponse.md)>;` | Delete a synonym rule. Delete a synonym rule from a synonym set. | +| `deleteSynonymRule` | `deleteSynonymRule(this: [That](./That.md), params: [SynonymsDeleteSynonymRuleRequest](./SynonymsDeleteSynonymRuleRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SynonymsDeleteSynonymRuleResponse](./SynonymsDeleteSynonymRuleResponse.md), unknown>>;` |   | +| `deleteSynonymRule` | `deleteSynonymRule(this: [That](./That.md), params: [SynonymsDeleteSynonymRuleRequest](./SynonymsDeleteSynonymRuleRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SynonymsDeleteSynonymRuleResponse](./SynonymsDeleteSynonymRuleResponse.md)>;` |   | +| `getSynonym` | `getSynonym(this: [That](./That.md), params: [SynonymsGetSynonymRequest](./SynonymsGetSynonymRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SynonymsGetSynonymResponse](./SynonymsGetSynonymResponse.md)>;` | Get a synonym set. | +| `getSynonym` | `getSynonym(this: [That](./That.md), params: [SynonymsGetSynonymRequest](./SynonymsGetSynonymRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SynonymsGetSynonymResponse](./SynonymsGetSynonymResponse.md), unknown>>;` |   | +| `getSynonym` | `getSynonym(this: [That](./That.md), params: [SynonymsGetSynonymRequest](./SynonymsGetSynonymRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SynonymsGetSynonymResponse](./SynonymsGetSynonymResponse.md)>;` |   | +| `getSynonymRule` | `getSynonymRule(this: [That](./That.md), params: [SynonymsGetSynonymRuleRequest](./SynonymsGetSynonymRuleRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SynonymsGetSynonymRuleResponse](./SynonymsGetSynonymRuleResponse.md)>;` | Get a synonym rule. Get a synonym rule from a synonym set. | +| `getSynonymRule` | `getSynonymRule(this: [That](./That.md), params: [SynonymsGetSynonymRuleRequest](./SynonymsGetSynonymRuleRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SynonymsGetSynonymRuleResponse](./SynonymsGetSynonymRuleResponse.md), unknown>>;` |   | +| `getSynonymRule` | `getSynonymRule(this: [That](./That.md), params: [SynonymsGetSynonymRuleRequest](./SynonymsGetSynonymRuleRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SynonymsGetSynonymRuleResponse](./SynonymsGetSynonymRuleResponse.md)>;` |   | +| `getSynonymsSets` | `getSynonymsSets(this: [That](./That.md), params?: [SynonymsGetSynonymsSetsRequest](./SynonymsGetSynonymsSetsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SynonymsGetSynonymsSetsResponse](./SynonymsGetSynonymsSetsResponse.md)>;` | Get all synonym sets. Get a summary of all defined synonym sets. | +| `getSynonymsSets` | `getSynonymsSets(this: [That](./That.md), params?: [SynonymsGetSynonymsSetsRequest](./SynonymsGetSynonymsSetsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SynonymsGetSynonymsSetsResponse](./SynonymsGetSynonymsSetsResponse.md), unknown>>;` |   | +| `getSynonymsSets` | `getSynonymsSets(this: [That](./That.md), params?: [SynonymsGetSynonymsSetsRequest](./SynonymsGetSynonymsSetsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SynonymsGetSynonymsSetsResponse](./SynonymsGetSynonymsSetsResponse.md)>;` |   | +| `putSynonym` | `putSynonym(this: [That](./That.md), params: [SynonymsPutSynonymRequest](./SynonymsPutSynonymRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SynonymsPutSynonymResponse](./SynonymsPutSynonymResponse.md)>;` | Create or update a synonym set. Synonyms sets are limited to a maximum of 10,000 synonym rules per set. If you need to manage more synonym rules, you can create multiple synonym sets. When an existing synonyms set is updated, the search analyzers that use the synonyms set are reloaded automatically for all indices. This is equivalent to invoking the reload search analyzers API for all indices that use the synonyms set. | +| `putSynonym` | `putSynonym(this: [That](./That.md), params: [SynonymsPutSynonymRequest](./SynonymsPutSynonymRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SynonymsPutSynonymResponse](./SynonymsPutSynonymResponse.md), unknown>>;` |   | +| `putSynonym` | `putSynonym(this: [That](./That.md), params: [SynonymsPutSynonymRequest](./SynonymsPutSynonymRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SynonymsPutSynonymResponse](./SynonymsPutSynonymResponse.md)>;` |   | +| `putSynonymRule` | `putSynonymRule(this: [That](./That.md), params: [SynonymsPutSynonymRuleRequest](./SynonymsPutSynonymRuleRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SynonymsPutSynonymRuleResponse](./SynonymsPutSynonymRuleResponse.md)>;` | Create or update a synonym rule. Create or update a synonym rule in a synonym set. If any of the synonym rules included is invalid, the API returns an error. When you update a synonym rule, all analyzers using the synonyms set will be reloaded automatically to reflect the new rule. | +| `putSynonymRule` | `putSynonymRule(this: [That](./That.md), params: [SynonymsPutSynonymRuleRequest](./SynonymsPutSynonymRuleRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SynonymsPutSynonymRuleResponse](./SynonymsPutSynonymRuleResponse.md), unknown>>;` |   | +| `putSynonymRule` | `putSynonymRule(this: [That](./That.md), params: [SynonymsPutSynonymRuleRequest](./SynonymsPutSynonymRuleRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SynonymsPutSynonymRuleResponse](./SynonymsPutSynonymRuleResponse.md)>;` |   | diff --git a/docs/reference/api/Tasks.md b/docs/reference/api/Tasks.md index 99a7a6fa9..f22644735 100644 --- a/docs/reference/api/Tasks.md +++ b/docs/reference/api/Tasks.md @@ -17,4 +17,12 @@ new Tasks(transport: [Transport](./Transport.md)); | Name | Signature | Description | | - | - | - | -| `cancel` | `cancel(this: [That](./That.md), params?: [TasksCancelRequest](./TasksCancelRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TasksCancelResponse](./TasksCancelResponse.md)>;` | Cancel a task. WARNING: The task management API is new and should still be considered a beta feature. The API may change in ways that are not backwards compatible. A task may continue to run for some time after it has been cancelled because it may not be able to safely stop its current activity straight away. It is also possible that Elasticsearch must complete its work on other tasks before it can process the cancellation. The get task information API will continue to list these cancelled tasks until they complete. The cancelled flag in the response indicates that the cancellation command has been processed and the task will stop as soon as possible. To troubleshoot why a cancelled task does not complete promptly, use the get task information API with the `?detailed` parameter to identify the other tasks the system is running. You can also use the node hot threads API to obtain detailed information about the work the system is doing instead of completing the cancelled task. || `cancel` | `cancel(this: [That](./That.md), params?: [TasksCancelRequest](./TasksCancelRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TasksCancelResponse](./TasksCancelResponse.md), unknown>>;` |   || `cancel` | `cancel(this: [That](./That.md), params?: [TasksCancelRequest](./TasksCancelRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TasksCancelResponse](./TasksCancelResponse.md)>;` |   || `get` | `get(this: [That](./That.md), params: [TasksGetRequest](./TasksGetRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TasksGetResponse](./TasksGetResponse.md)>;` | Get task information. Get information about a task currently running in the cluster. WARNING: The task management API is new and should still be considered a beta feature. The API may change in ways that are not backwards compatible. If the task identifier is not found, a 404 response code indicates that there are no resources that match the request. || `get` | `get(this: [That](./That.md), params: [TasksGetRequest](./TasksGetRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TasksGetResponse](./TasksGetResponse.md), unknown>>;` |   || `get` | `get(this: [That](./That.md), params: [TasksGetRequest](./TasksGetRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TasksGetResponse](./TasksGetResponse.md)>;` |   || `list` | `list(this: [That](./That.md), params?: [TasksListRequest](./TasksListRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TasksListResponse](./TasksListResponse.md)>;` | Get all tasks. Get information about the tasks currently running on one or more nodes in the cluster. WARNING: The task management API is new and should still be considered a beta feature. The API may change in ways that are not backwards compatible. **Identifying running tasks** The `X-Opaque-Id header`, when provided on the HTTP request header, is going to be returned as a header in the response as well as in the headers field for in the task information. This enables you to track certain calls or associate certain tasks with the client that started them. For example: ``` curl -i -H "X-Opaque-Id: 123456" "http://localhost:9200/_tasks?group_by=parents" ``` The API returns the following result: ``` HTTP/1.1 200 OK X-Opaque-Id: 123456 content-type: application/json; charset=UTF-8 content-length: 831 { "tasks" : { "u5lcZHqcQhu-rUoFaqDphA:45" : { "node" : "u5lcZHqcQhu-rUoFaqDphA", "id" : 45, "type" : "transport", "action" : "cluster:monitor/tasks/lists", "start_time_in_millis" : 1513823752749, "running_time_in_nanos" : 293139, "cancellable" : false, "headers" : { "X-Opaque-Id" : "123456" } , "children" : [ { "node" : "u5lcZHqcQhu-rUoFaqDphA", "id" : 46, "type" : "direct", "action" : "cluster:monitor/tasks/lists[n]", "start_time_in_millis" : 1513823752750, "running_time_in_nanos" : 92133, "cancellable" : false, "parent_task_id" : "u5lcZHqcQhu-rUoFaqDphA:45", "headers" : { "X-Opaque-Id" : "123456" } } ] } } } ``` In this example, `X-Opaque-Id: 123456` is the ID as a part of the response header. The `X-Opaque-Id` in the task `headers` is the ID for the task that was initiated by the REST request. The `X-Opaque-Id` in the children `headers` is the child task of the task that was initiated by the REST request. || `list` | `list(this: [That](./That.md), params?: [TasksListRequest](./TasksListRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TasksListResponse](./TasksListResponse.md), unknown>>;` |   || `list` | `list(this: [That](./That.md), params?: [TasksListRequest](./TasksListRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TasksListResponse](./TasksListResponse.md)>;` |   | \ No newline at end of file +| `cancel` | `cancel(this: [That](./That.md), params?: [TasksCancelRequest](./TasksCancelRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TasksCancelResponse](./TasksCancelResponse.md)>;` | Cancel a task. WARNING: The task management API is new and should still be considered a beta feature. The API may change in ways that are not backwards compatible. A task may continue to run for some time after it has been cancelled because it may not be able to safely stop its current activity straight away. It is also possible that Elasticsearch must complete its work on other tasks before it can process the cancellation. The get task information API will continue to list these cancelled tasks until they complete. The cancelled flag in the response indicates that the cancellation command has been processed and the task will stop as soon as possible. To troubleshoot why a cancelled task does not complete promptly, use the get task information API with the `?detailed` parameter to identify the other tasks the system is running. You can also use the node hot threads API to obtain detailed information about the work the system is doing instead of completing the cancelled task. | +| `cancel` | `cancel(this: [That](./That.md), params?: [TasksCancelRequest](./TasksCancelRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TasksCancelResponse](./TasksCancelResponse.md), unknown>>;` |   | +| `cancel` | `cancel(this: [That](./That.md), params?: [TasksCancelRequest](./TasksCancelRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TasksCancelResponse](./TasksCancelResponse.md)>;` |   | +| `get` | `get(this: [That](./That.md), params: [TasksGetRequest](./TasksGetRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TasksGetResponse](./TasksGetResponse.md)>;` | Get task information. Get information about a task currently running in the cluster. WARNING: The task management API is new and should still be considered a beta feature. The API may change in ways that are not backwards compatible. If the task identifier is not found, a 404 response code indicates that there are no resources that match the request. | +| `get` | `get(this: [That](./That.md), params: [TasksGetRequest](./TasksGetRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TasksGetResponse](./TasksGetResponse.md), unknown>>;` |   | +| `get` | `get(this: [That](./That.md), params: [TasksGetRequest](./TasksGetRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TasksGetResponse](./TasksGetResponse.md)>;` |   | +| `list` | `list(this: [That](./That.md), params?: [TasksListRequest](./TasksListRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TasksListResponse](./TasksListResponse.md)>;` | Get all tasks. Get information about the tasks currently running on one or more nodes in the cluster. WARNING: The task management API is new and should still be considered a beta feature. The API may change in ways that are not backwards compatible. **Identifying running tasks** The `X-Opaque-Id header`, when provided on the HTTP request header, is going to be returned as a header in the response as well as in the headers field for in the task information. This enables you to track certain calls or associate certain tasks with the client that started them. For example: ``` curl -i -H "X-Opaque-Id: 123456" "http://localhost:9200/_tasks?group_by=parents" ``` The API returns the following result: ``` HTTP/1.1 200 OK X-Opaque-Id: 123456 content-type: application/json; charset=UTF-8 content-length: 831 { "tasks" : { "u5lcZHqcQhu-rUoFaqDphA:45" : { "node" : "u5lcZHqcQhu-rUoFaqDphA", "id" : 45, "type" : "transport", "action" : "cluster:monitor/tasks/lists", "start_time_in_millis" : 1513823752749, "running_time_in_nanos" : 293139, "cancellable" : false, "headers" : { "X-Opaque-Id" : "123456" } , "children" : [ { "node" : "u5lcZHqcQhu-rUoFaqDphA", "id" : 46, "type" : "direct", "action" : "cluster:monitor/tasks/lists[n]", "start_time_in_millis" : 1513823752750, "running_time_in_nanos" : 92133, "cancellable" : false, "parent_task_id" : "u5lcZHqcQhu-rUoFaqDphA:45", "headers" : { "X-Opaque-Id" : "123456" } } ] } } } ``` In this example, `X-Opaque-Id: 123456` is the ID as a part of the response header. The `X-Opaque-Id` in the task `headers` is the ID for the task that was initiated by the REST request. The `X-Opaque-Id` in the children `headers` is the child task of the task that was initiated by the REST request. | +| `list` | `list(this: [That](./That.md), params?: [TasksListRequest](./TasksListRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TasksListResponse](./TasksListResponse.md), unknown>>;` |   | +| `list` | `list(this: [That](./That.md), params?: [TasksListRequest](./TasksListRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TasksListResponse](./TasksListResponse.md)>;` |   | diff --git a/docs/reference/api/TextStructure.md b/docs/reference/api/TextStructure.md index 2867d8f81..6778b0f41 100644 --- a/docs/reference/api/TextStructure.md +++ b/docs/reference/api/TextStructure.md @@ -17,4 +17,15 @@ new TextStructure(transport: [Transport](./Transport.md)); | Name | Signature | Description | | - | - | - | -| `findFieldStructure` | `findFieldStructure(this: [That](./That.md), params: [TextStructureFindFieldStructureRequest](./TextStructureFindFieldStructureRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TextStructureFindFieldStructureResponse](./TextStructureFindFieldStructureResponse.md)>;` | Find the structure of a text field. Find the structure of a text field in an Elasticsearch index. This API provides a starting point for extracting further information from log messages already ingested into Elasticsearch. For example, if you have ingested data into a very simple index that has just `@timestamp` and message fields, you can use this API to see what common structure exists in the message field. The response from the API contains: * Sample messages. * Statistics that reveal the most common values for all fields detected within the text and basic numeric statistics for numeric fields. * Information about the structure of the text, which is useful when you write ingest configurations to index it or similarly formatted text. * Appropriate mappings for an Elasticsearch index, which you could use to ingest the text. All this information can be calculated by the structure finder with no guidance. However, you can optionally override some of the decisions about the text structure by specifying one or more query parameters. If the structure finder produces unexpected results, specify the `explain` query parameter and an explanation will appear in the response. It helps determine why the returned structure was chosen. || `findFieldStructure` | `findFieldStructure(this: [That](./That.md), params: [TextStructureFindFieldStructureRequest](./TextStructureFindFieldStructureRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TextStructureFindFieldStructureResponse](./TextStructureFindFieldStructureResponse.md), unknown>>;` |   || `findFieldStructure` | `findFieldStructure(this: [That](./That.md), params: [TextStructureFindFieldStructureRequest](./TextStructureFindFieldStructureRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TextStructureFindFieldStructureResponse](./TextStructureFindFieldStructureResponse.md)>;` |   || `findMessageStructure` | `findMessageStructure(this: [That](./That.md), params: [TextStructureFindMessageStructureRequest](./TextStructureFindMessageStructureRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TextStructureFindMessageStructureResponse](./TextStructureFindMessageStructureResponse.md)>;` | Find the structure of text messages. Find the structure of a list of text messages. The messages must contain data that is suitable to be ingested into Elasticsearch. This API provides a starting point for ingesting data into Elasticsearch in a format that is suitable for subsequent use with other Elastic Stack functionality. Use this API rather than the find text structure API if your input text has already been split up into separate messages by some other process. The response from the API contains: * Sample messages. * Statistics that reveal the most common values for all fields detected within the text and basic numeric statistics for numeric fields. * Information about the structure of the text, which is useful when you write ingest configurations to index it or similarly formatted text. Appropriate mappings for an Elasticsearch index, which you could use to ingest the text. All this information can be calculated by the structure finder with no guidance. However, you can optionally override some of the decisions about the text structure by specifying one or more query parameters. If the structure finder produces unexpected results, specify the `explain` query parameter and an explanation will appear in the response. It helps determine why the returned structure was chosen. || `findMessageStructure` | `findMessageStructure(this: [That](./That.md), params: [TextStructureFindMessageStructureRequest](./TextStructureFindMessageStructureRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TextStructureFindMessageStructureResponse](./TextStructureFindMessageStructureResponse.md), unknown>>;` |   || `findMessageStructure` | `findMessageStructure(this: [That](./That.md), params: [TextStructureFindMessageStructureRequest](./TextStructureFindMessageStructureRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TextStructureFindMessageStructureResponse](./TextStructureFindMessageStructureResponse.md)>;` |   || `findStructure` | `findStructure(this: [That](./That.md), params: [TextStructureFindStructureRequest](./TextStructureFindStructureRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TextStructureFindStructureResponse](./TextStructureFindStructureResponse.md)>;` | Find the structure of a text file. The text file must contain data that is suitable to be ingested into Elasticsearch. This API provides a starting point for ingesting data into Elasticsearch in a format that is suitable for subsequent use with other Elastic Stack functionality. Unlike other Elasticsearch endpoints, the data that is posted to this endpoint does not need to be UTF-8 encoded and in JSON format. It must, however, be text; binary text formats are not currently supported. The size is limited to the Elasticsearch HTTP receive buffer size, which defaults to 100 Mb. The response from the API contains: * A couple of messages from the beginning of the text. * Statistics that reveal the most common values for all fields detected within the text and basic numeric statistics for numeric fields. * Information about the structure of the text, which is useful when you write ingest configurations to index it or similarly formatted text. * Appropriate mappings for an Elasticsearch index, which you could use to ingest the text. All this information can be calculated by the structure finder with no guidance. However, you can optionally override some of the decisions about the text structure by specifying one or more query parameters. || `findStructure` | `findStructure(this: [That](./That.md), params: [TextStructureFindStructureRequest](./TextStructureFindStructureRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TextStructureFindStructureResponse](./TextStructureFindStructureResponse.md), unknown>>;` |   || `findStructure` | `findStructure(this: [That](./That.md), params: [TextStructureFindStructureRequest](./TextStructureFindStructureRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TextStructureFindStructureResponse](./TextStructureFindStructureResponse.md)>;` |   || `testGrokPattern` | `testGrokPattern(this: [That](./That.md), params: [TextStructureTestGrokPatternRequest](./TextStructureTestGrokPatternRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TextStructureTestGrokPatternResponse](./TextStructureTestGrokPatternResponse.md)>;` | Test a Grok pattern. Test a Grok pattern on one or more lines of text. The API indicates whether the lines match the pattern together with the offsets and lengths of the matched substrings. || `testGrokPattern` | `testGrokPattern(this: [That](./That.md), params: [TextStructureTestGrokPatternRequest](./TextStructureTestGrokPatternRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TextStructureTestGrokPatternResponse](./TextStructureTestGrokPatternResponse.md), unknown>>;` |   || `testGrokPattern` | `testGrokPattern(this: [That](./That.md), params: [TextStructureTestGrokPatternRequest](./TextStructureTestGrokPatternRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TextStructureTestGrokPatternResponse](./TextStructureTestGrokPatternResponse.md)>;` |   | \ No newline at end of file +| `findFieldStructure` | `findFieldStructure(this: [That](./That.md), params: [TextStructureFindFieldStructureRequest](./TextStructureFindFieldStructureRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TextStructureFindFieldStructureResponse](./TextStructureFindFieldStructureResponse.md)>;` | Find the structure of a text field. Find the structure of a text field in an Elasticsearch index. This API provides a starting point for extracting further information from log messages already ingested into Elasticsearch. For example, if you have ingested data into a very simple index that has just `@timestamp` and message fields, you can use this API to see what common structure exists in the message field. The response from the API contains: * Sample messages. * Statistics that reveal the most common values for all fields detected within the text and basic numeric statistics for numeric fields. * Information about the structure of the text, which is useful when you write ingest configurations to index it or similarly formatted text. * Appropriate mappings for an Elasticsearch index, which you could use to ingest the text. All this information can be calculated by the structure finder with no guidance. However, you can optionally override some of the decisions about the text structure by specifying one or more query parameters. If the structure finder produces unexpected results, specify the `explain` query parameter and an explanation will appear in the response. It helps determine why the returned structure was chosen. | +| `findFieldStructure` | `findFieldStructure(this: [That](./That.md), params: [TextStructureFindFieldStructureRequest](./TextStructureFindFieldStructureRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TextStructureFindFieldStructureResponse](./TextStructureFindFieldStructureResponse.md), unknown>>;` |   | +| `findFieldStructure` | `findFieldStructure(this: [That](./That.md), params: [TextStructureFindFieldStructureRequest](./TextStructureFindFieldStructureRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TextStructureFindFieldStructureResponse](./TextStructureFindFieldStructureResponse.md)>;` |   | +| `findMessageStructure` | `findMessageStructure(this: [That](./That.md), params: [TextStructureFindMessageStructureRequest](./TextStructureFindMessageStructureRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TextStructureFindMessageStructureResponse](./TextStructureFindMessageStructureResponse.md)>;` | Find the structure of text messages. Find the structure of a list of text messages. The messages must contain data that is suitable to be ingested into Elasticsearch. This API provides a starting point for ingesting data into Elasticsearch in a format that is suitable for subsequent use with other Elastic Stack functionality. Use this API rather than the find text structure API if your input text has already been split up into separate messages by some other process. The response from the API contains: * Sample messages. * Statistics that reveal the most common values for all fields detected within the text and basic numeric statistics for numeric fields. * Information about the structure of the text, which is useful when you write ingest configurations to index it or similarly formatted text. Appropriate mappings for an Elasticsearch index, which you could use to ingest the text. All this information can be calculated by the structure finder with no guidance. However, you can optionally override some of the decisions about the text structure by specifying one or more query parameters. If the structure finder produces unexpected results, specify the `explain` query parameter and an explanation will appear in the response. It helps determine why the returned structure was chosen. | +| `findMessageStructure` | `findMessageStructure(this: [That](./That.md), params: [TextStructureFindMessageStructureRequest](./TextStructureFindMessageStructureRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TextStructureFindMessageStructureResponse](./TextStructureFindMessageStructureResponse.md), unknown>>;` |   | +| `findMessageStructure` | `findMessageStructure(this: [That](./That.md), params: [TextStructureFindMessageStructureRequest](./TextStructureFindMessageStructureRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TextStructureFindMessageStructureResponse](./TextStructureFindMessageStructureResponse.md)>;` |   | +| `findStructure` | `findStructure(this: [That](./That.md), params: [TextStructureFindStructureRequest](./TextStructureFindStructureRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TextStructureFindStructureResponse](./TextStructureFindStructureResponse.md)>;` | Find the structure of a text file. The text file must contain data that is suitable to be ingested into Elasticsearch. This API provides a starting point for ingesting data into Elasticsearch in a format that is suitable for subsequent use with other Elastic Stack functionality. Unlike other Elasticsearch endpoints, the data that is posted to this endpoint does not need to be UTF-8 encoded and in JSON format. It must, however, be text; binary text formats are not currently supported. The size is limited to the Elasticsearch HTTP receive buffer size, which defaults to 100 Mb. The response from the API contains: * A couple of messages from the beginning of the text. * Statistics that reveal the most common values for all fields detected within the text and basic numeric statistics for numeric fields. * Information about the structure of the text, which is useful when you write ingest configurations to index it or similarly formatted text. * Appropriate mappings for an Elasticsearch index, which you could use to ingest the text. All this information can be calculated by the structure finder with no guidance. However, you can optionally override some of the decisions about the text structure by specifying one or more query parameters. | +| `findStructure` | `findStructure(this: [That](./That.md), params: [TextStructureFindStructureRequest](./TextStructureFindStructureRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TextStructureFindStructureResponse](./TextStructureFindStructureResponse.md), unknown>>;` |   | +| `findStructure` | `findStructure(this: [That](./That.md), params: [TextStructureFindStructureRequest](./TextStructureFindStructureRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TextStructureFindStructureResponse](./TextStructureFindStructureResponse.md)>;` |   | +| `testGrokPattern` | `testGrokPattern(this: [That](./That.md), params: [TextStructureTestGrokPatternRequest](./TextStructureTestGrokPatternRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TextStructureTestGrokPatternResponse](./TextStructureTestGrokPatternResponse.md)>;` | Test a Grok pattern. Test a Grok pattern on one or more lines of text. The API indicates whether the lines match the pattern together with the offsets and lengths of the matched substrings. | +| `testGrokPattern` | `testGrokPattern(this: [That](./That.md), params: [TextStructureTestGrokPatternRequest](./TextStructureTestGrokPatternRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TextStructureTestGrokPatternResponse](./TextStructureTestGrokPatternResponse.md), unknown>>;` |   | +| `testGrokPattern` | `testGrokPattern(this: [That](./That.md), params: [TextStructureTestGrokPatternRequest](./TextStructureTestGrokPatternRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TextStructureTestGrokPatternResponse](./TextStructureTestGrokPatternResponse.md)>;` |   | diff --git a/docs/reference/api/Transform.md b/docs/reference/api/Transform.md index 31e17916a..bed0ecc7e 100644 --- a/docs/reference/api/Transform.md +++ b/docs/reference/api/Transform.md @@ -17,4 +17,39 @@ new Transform(transport: [Transport](./Transport.md)); | Name | Signature | Description | | - | - | - | -| `deleteTransform` | `deleteTransform(this: [That](./That.md), params: [TransformDeleteTransformRequest](./TransformDeleteTransformRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TransformDeleteTransformResponse](./TransformDeleteTransformResponse.md)>;` | Delete a transform. || `deleteTransform` | `deleteTransform(this: [That](./That.md), params: [TransformDeleteTransformRequest](./TransformDeleteTransformRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TransformDeleteTransformResponse](./TransformDeleteTransformResponse.md), unknown>>;` |   || `deleteTransform` | `deleteTransform(this: [That](./That.md), params: [TransformDeleteTransformRequest](./TransformDeleteTransformRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TransformDeleteTransformResponse](./TransformDeleteTransformResponse.md)>;` |   || `getNodeStats` | `getNodeStats(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TODO](./TODO.md)>;` | Retrieves transform usage information for transform nodes. || `getNodeStats` | `getNodeStats(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TODO](./TODO.md), unknown>>;` |   || `getNodeStats` | `getNodeStats(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TODO](./TODO.md)>;` |   || `getTransform` | `getTransform(this: [That](./That.md), params?: [TransformGetTransformRequest](./TransformGetTransformRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TransformGetTransformResponse](./TransformGetTransformResponse.md)>;` | Get transforms. Get configuration information for transforms. || `getTransform` | `getTransform(this: [That](./That.md), params?: [TransformGetTransformRequest](./TransformGetTransformRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TransformGetTransformResponse](./TransformGetTransformResponse.md), unknown>>;` |   || `getTransform` | `getTransform(this: [That](./That.md), params?: [TransformGetTransformRequest](./TransformGetTransformRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TransformGetTransformResponse](./TransformGetTransformResponse.md)>;` |   || `getTransformStats` | `getTransformStats(this: [That](./That.md), params: [TransformGetTransformStatsRequest](./TransformGetTransformStatsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TransformGetTransformStatsResponse](./TransformGetTransformStatsResponse.md)>;` | Get transform stats. Get usage information for transforms. || `getTransformStats` | `getTransformStats(this: [That](./That.md), params: [TransformGetTransformStatsRequest](./TransformGetTransformStatsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TransformGetTransformStatsResponse](./TransformGetTransformStatsResponse.md), unknown>>;` |   || `getTransformStats` | `getTransformStats(this: [That](./That.md), params: [TransformGetTransformStatsRequest](./TransformGetTransformStatsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TransformGetTransformStatsResponse](./TransformGetTransformStatsResponse.md)>;` |   || `previewTransform` | `previewTransform(this: [That](./That.md), params?: [TransformPreviewTransformRequest](./TransformPreviewTransformRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TransformPreviewTransformResponse](./TransformPreviewTransformResponse.md)>;` | Preview a transform. Generates a preview of the results that you will get when you create a transform with the same configuration. It returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also generates a list of mappings and settings for the destination index. These values are determined based on the field types of the source index and the transform aggregations. || `previewTransform` | `previewTransform(this: [That](./That.md), params?: [TransformPreviewTransformRequest](./TransformPreviewTransformRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TransformPreviewTransformResponse](./TransformPreviewTransformResponse.md), unknown>>;` |   || `previewTransform` | `previewTransform(this: [That](./That.md), params?: [TransformPreviewTransformRequest](./TransformPreviewTransformRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TransformPreviewTransformResponse](./TransformPreviewTransformResponse.md)>;` |   || `putTransform` | `putTransform(this: [That](./That.md), params: [TransformPutTransformRequest](./TransformPutTransformRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TransformPutTransformResponse](./TransformPutTransformResponse.md)>;` | Create a transform. Creates a transform. A transform copies data from source indices, transforms it, and persists it into an entity-centric destination index. You can also think of the destination index as a two-dimensional tabular data structure (known as a data frame). The ID for each document in the data frame is generated from a hash of the entity, so there is a unique row per entity. You must choose either the latest or pivot method for your transform; you cannot use both in a single transform. If you choose to use the pivot method for your transform, the entities are defined by the set of `group_by` fields in the pivot object. If you choose to use the latest method, the entities are defined by the `unique_key` field values in the latest object. You must have `create_index`, `index`, and `read` privileges on the destination index and `read` and `view_index_metadata` privileges on the source indices. When Elasticsearch security features are enabled, the transform remembers which roles the user that created it had at the time of creation and uses those same roles. If those roles do not have the required privileges on the source and destination indices, the transform fails when it attempts unauthorized operations. NOTE: You must use Kibana or this API to create a transform. Do not add a transform directly into any `.transform-internal*` indices using the Elasticsearch index API. If Elasticsearch security features are enabled, do not give users any privileges on `.transform-internal*` indices. If you used transforms prior to 7.5, also do not give users any privileges on `.data-frame-internal*` indices. || `putTransform` | `putTransform(this: [That](./That.md), params: [TransformPutTransformRequest](./TransformPutTransformRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TransformPutTransformResponse](./TransformPutTransformResponse.md), unknown>>;` |   || `putTransform` | `putTransform(this: [That](./That.md), params: [TransformPutTransformRequest](./TransformPutTransformRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TransformPutTransformResponse](./TransformPutTransformResponse.md)>;` |   || `resetTransform` | `resetTransform(this: [That](./That.md), params: [TransformResetTransformRequest](./TransformResetTransformRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TransformResetTransformResponse](./TransformResetTransformResponse.md)>;` | Reset a transform. Before you can reset it, you must stop it; alternatively, use the `force` query parameter. If the destination index was created by the transform, it is deleted. || `resetTransform` | `resetTransform(this: [That](./That.md), params: [TransformResetTransformRequest](./TransformResetTransformRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TransformResetTransformResponse](./TransformResetTransformResponse.md), unknown>>;` |   || `resetTransform` | `resetTransform(this: [That](./That.md), params: [TransformResetTransformRequest](./TransformResetTransformRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TransformResetTransformResponse](./TransformResetTransformResponse.md)>;` |   || `scheduleNowTransform` | `scheduleNowTransform(this: [That](./That.md), params: [TransformScheduleNowTransformRequest](./TransformScheduleNowTransformRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TransformScheduleNowTransformResponse](./TransformScheduleNowTransformResponse.md)>;` | Schedule a transform to start now. Instantly run a transform to process data. If you run this API, the transform will process the new data instantly, without waiting for the configured frequency interval. After the API is called, the transform will be processed again at `now + frequency` unless the API is called again in the meantime. || `scheduleNowTransform` | `scheduleNowTransform(this: [That](./That.md), params: [TransformScheduleNowTransformRequest](./TransformScheduleNowTransformRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TransformScheduleNowTransformResponse](./TransformScheduleNowTransformResponse.md), unknown>>;` |   || `scheduleNowTransform` | `scheduleNowTransform(this: [That](./That.md), params: [TransformScheduleNowTransformRequest](./TransformScheduleNowTransformRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TransformScheduleNowTransformResponse](./TransformScheduleNowTransformResponse.md)>;` |   || `startTransform` | `startTransform(this: [That](./That.md), params: [TransformStartTransformRequest](./TransformStartTransformRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TransformStartTransformResponse](./TransformStartTransformResponse.md)>;` | Start a transform. When you start a transform, it creates the destination index if it does not already exist. The `number_of_shards` is set to `1` and the `auto_expand_replicas` is set to `0-1`. If it is a pivot transform, it deduces the mapping definitions for the destination index from the source indices and the transform aggregations. If fields in the destination index are derived from scripts (as in the case of `scripted_metric` or `bucket_script` aggregations), the transform uses dynamic mappings unless an index template exists. If it is a latest transform, it does not deduce mapping definitions; it uses dynamic mappings. To use explicit mappings, create the destination index before you start the transform. Alternatively, you can create an index template, though it does not affect the deduced mappings in a pivot transform. When the transform starts, a series of validations occur to ensure its success. If you deferred validation when you created the transform, they occur when you start the transform—with the exception of privilege checks. When Elasticsearch security features are enabled, the transform remembers which roles the user that created it had at the time of creation and uses those same roles. If those roles do not have the required privileges on the source and destination indices, the transform fails when it attempts unauthorized operations. || `startTransform` | `startTransform(this: [That](./That.md), params: [TransformStartTransformRequest](./TransformStartTransformRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TransformStartTransformResponse](./TransformStartTransformResponse.md), unknown>>;` |   || `startTransform` | `startTransform(this: [That](./That.md), params: [TransformStartTransformRequest](./TransformStartTransformRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TransformStartTransformResponse](./TransformStartTransformResponse.md)>;` |   || `stopTransform` | `stopTransform(this: [That](./That.md), params: [TransformStopTransformRequest](./TransformStopTransformRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TransformStopTransformResponse](./TransformStopTransformResponse.md)>;` | Stop transforms. Stops one or more transforms. || `stopTransform` | `stopTransform(this: [That](./That.md), params: [TransformStopTransformRequest](./TransformStopTransformRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TransformStopTransformResponse](./TransformStopTransformResponse.md), unknown>>;` |   || `stopTransform` | `stopTransform(this: [That](./That.md), params: [TransformStopTransformRequest](./TransformStopTransformRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TransformStopTransformResponse](./TransformStopTransformResponse.md)>;` |   || `updateTransform` | `updateTransform(this: [That](./That.md), params: [TransformUpdateTransformRequest](./TransformUpdateTransformRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TransformUpdateTransformResponse](./TransformUpdateTransformResponse.md)>;` | Update a transform. Updates certain properties of a transform. All updated properties except `description` do not take effect until after the transform starts the next checkpoint, thus there is data consistency in each checkpoint. To use this API, you must have `read` and `view_index_metadata` privileges for the source indices. You must also have `index` and `read` privileges for the destination index. When Elasticsearch security features are enabled, the transform remembers which roles the user who updated it had at the time of update and runs with those privileges. || `updateTransform` | `updateTransform(this: [That](./That.md), params: [TransformUpdateTransformRequest](./TransformUpdateTransformRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TransformUpdateTransformResponse](./TransformUpdateTransformResponse.md), unknown>>;` |   || `updateTransform` | `updateTransform(this: [That](./That.md), params: [TransformUpdateTransformRequest](./TransformUpdateTransformRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TransformUpdateTransformResponse](./TransformUpdateTransformResponse.md)>;` |   || `upgradeTransforms` | `upgradeTransforms(this: [That](./That.md), params?: [TransformUpgradeTransformsRequest](./TransformUpgradeTransformsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TransformUpgradeTransformsResponse](./TransformUpgradeTransformsResponse.md)>;` | Upgrade all transforms. Transforms are compatible across minor versions and between supported major versions. However, over time, the format of transform configuration information may change. This API identifies transforms that have a legacy configuration format and upgrades them to the latest version. It also cleans up the internal data structures that store the transform state and checkpoints. The upgrade does not affect the source and destination indices. The upgrade also does not affect the roles that transforms use when Elasticsearch security features are enabled; the role used to read source data and write to the destination index remains unchanged. If a transform upgrade step fails, the upgrade stops and an error is returned about the underlying issue. Resolve the issue then re-run the process again. A summary is returned when the upgrade is finished. To ensure continuous transforms remain running during a major version upgrade of the cluster – for example, from 7.16 to 8.0 – it is recommended to upgrade transforms before upgrading the cluster. You may want to perform a recent cluster backup prior to the upgrade. || `upgradeTransforms` | `upgradeTransforms(this: [That](./That.md), params?: [TransformUpgradeTransformsRequest](./TransformUpgradeTransformsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TransformUpgradeTransformsResponse](./TransformUpgradeTransformsResponse.md), unknown>>;` |   || `upgradeTransforms` | `upgradeTransforms(this: [That](./That.md), params?: [TransformUpgradeTransformsRequest](./TransformUpgradeTransformsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TransformUpgradeTransformsResponse](./TransformUpgradeTransformsResponse.md)>;` |   | \ No newline at end of file +| `deleteTransform` | `deleteTransform(this: [That](./That.md), params: [TransformDeleteTransformRequest](./TransformDeleteTransformRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TransformDeleteTransformResponse](./TransformDeleteTransformResponse.md)>;` | Delete a transform. | +| `deleteTransform` | `deleteTransform(this: [That](./That.md), params: [TransformDeleteTransformRequest](./TransformDeleteTransformRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TransformDeleteTransformResponse](./TransformDeleteTransformResponse.md), unknown>>;` |   | +| `deleteTransform` | `deleteTransform(this: [That](./That.md), params: [TransformDeleteTransformRequest](./TransformDeleteTransformRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TransformDeleteTransformResponse](./TransformDeleteTransformResponse.md)>;` |   | +| `getNodeStats` | `getNodeStats(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TODO](./TODO.md)>;` | Retrieves transform usage information for transform nodes. | +| `getNodeStats` | `getNodeStats(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TODO](./TODO.md), unknown>>;` |   | +| `getNodeStats` | `getNodeStats(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TODO](./TODO.md)>;` |   | +| `getTransform` | `getTransform(this: [That](./That.md), params?: [TransformGetTransformRequest](./TransformGetTransformRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TransformGetTransformResponse](./TransformGetTransformResponse.md)>;` | Get transforms. Get configuration information for transforms. | +| `getTransform` | `getTransform(this: [That](./That.md), params?: [TransformGetTransformRequest](./TransformGetTransformRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TransformGetTransformResponse](./TransformGetTransformResponse.md), unknown>>;` |   | +| `getTransform` | `getTransform(this: [That](./That.md), params?: [TransformGetTransformRequest](./TransformGetTransformRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TransformGetTransformResponse](./TransformGetTransformResponse.md)>;` |   | +| `getTransformStats` | `getTransformStats(this: [That](./That.md), params: [TransformGetTransformStatsRequest](./TransformGetTransformStatsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TransformGetTransformStatsResponse](./TransformGetTransformStatsResponse.md)>;` | Get transform stats. Get usage information for transforms. | +| `getTransformStats` | `getTransformStats(this: [That](./That.md), params: [TransformGetTransformStatsRequest](./TransformGetTransformStatsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TransformGetTransformStatsResponse](./TransformGetTransformStatsResponse.md), unknown>>;` |   | +| `getTransformStats` | `getTransformStats(this: [That](./That.md), params: [TransformGetTransformStatsRequest](./TransformGetTransformStatsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TransformGetTransformStatsResponse](./TransformGetTransformStatsResponse.md)>;` |   | +| `previewTransform` | `previewTransform(this: [That](./That.md), params?: [TransformPreviewTransformRequest](./TransformPreviewTransformRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TransformPreviewTransformResponse](./TransformPreviewTransformResponse.md)>;` | Preview a transform. Generates a preview of the results that you will get when you create a transform with the same configuration. It returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also generates a list of mappings and settings for the destination index. These values are determined based on the field types of the source index and the transform aggregations. | +| `previewTransform` | `previewTransform(this: [That](./That.md), params?: [TransformPreviewTransformRequest](./TransformPreviewTransformRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TransformPreviewTransformResponse](./TransformPreviewTransformResponse.md), unknown>>;` |   | +| `previewTransform` | `previewTransform(this: [That](./That.md), params?: [TransformPreviewTransformRequest](./TransformPreviewTransformRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TransformPreviewTransformResponse](./TransformPreviewTransformResponse.md)>;` |   | +| `putTransform` | `putTransform(this: [That](./That.md), params: [TransformPutTransformRequest](./TransformPutTransformRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TransformPutTransformResponse](./TransformPutTransformResponse.md)>;` | Create a transform. Creates a transform. A transform copies data from source indices, transforms it, and persists it into an entity-centric destination index. You can also think of the destination index as a two-dimensional tabular data structure (known as a data frame). The ID for each document in the data frame is generated from a hash of the entity, so there is a unique row per entity. You must choose either the latest or pivot method for your transform; you cannot use both in a single transform. If you choose to use the pivot method for your transform, the entities are defined by the set of `group_by` fields in the pivot object. If you choose to use the latest method, the entities are defined by the `unique_key` field values in the latest object. You must have `create_index`, `index`, and `read` privileges on the destination index and `read` and `view_index_metadata` privileges on the source indices. When Elasticsearch security features are enabled, the transform remembers which roles the user that created it had at the time of creation and uses those same roles. If those roles do not have the required privileges on the source and destination indices, the transform fails when it attempts unauthorized operations. NOTE: You must use Kibana or this API to create a transform. Do not add a transform directly into any `.transform-internal*` indices using the Elasticsearch index API. If Elasticsearch security features are enabled, do not give users any privileges on `.transform-internal*` indices. If you used transforms prior to 7.5, also do not give users any privileges on `.data-frame-internal*` indices. | +| `putTransform` | `putTransform(this: [That](./That.md), params: [TransformPutTransformRequest](./TransformPutTransformRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TransformPutTransformResponse](./TransformPutTransformResponse.md), unknown>>;` |   | +| `putTransform` | `putTransform(this: [That](./That.md), params: [TransformPutTransformRequest](./TransformPutTransformRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TransformPutTransformResponse](./TransformPutTransformResponse.md)>;` |   | +| `resetTransform` | `resetTransform(this: [That](./That.md), params: [TransformResetTransformRequest](./TransformResetTransformRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TransformResetTransformResponse](./TransformResetTransformResponse.md)>;` | Reset a transform. Before you can reset it, you must stop it; alternatively, use the `force` query parameter. If the destination index was created by the transform, it is deleted. | +| `resetTransform` | `resetTransform(this: [That](./That.md), params: [TransformResetTransformRequest](./TransformResetTransformRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TransformResetTransformResponse](./TransformResetTransformResponse.md), unknown>>;` |   | +| `resetTransform` | `resetTransform(this: [That](./That.md), params: [TransformResetTransformRequest](./TransformResetTransformRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TransformResetTransformResponse](./TransformResetTransformResponse.md)>;` |   | +| `scheduleNowTransform` | `scheduleNowTransform(this: [That](./That.md), params: [TransformScheduleNowTransformRequest](./TransformScheduleNowTransformRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TransformScheduleNowTransformResponse](./TransformScheduleNowTransformResponse.md)>;` | Schedule a transform to start now. Instantly run a transform to process data. If you run this API, the transform will process the new data instantly, without waiting for the configured frequency interval. After the API is called, the transform will be processed again at `now + frequency` unless the API is called again in the meantime. | +| `scheduleNowTransform` | `scheduleNowTransform(this: [That](./That.md), params: [TransformScheduleNowTransformRequest](./TransformScheduleNowTransformRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TransformScheduleNowTransformResponse](./TransformScheduleNowTransformResponse.md), unknown>>;` |   | +| `scheduleNowTransform` | `scheduleNowTransform(this: [That](./That.md), params: [TransformScheduleNowTransformRequest](./TransformScheduleNowTransformRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TransformScheduleNowTransformResponse](./TransformScheduleNowTransformResponse.md)>;` |   | +| `startTransform` | `startTransform(this: [That](./That.md), params: [TransformStartTransformRequest](./TransformStartTransformRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TransformStartTransformResponse](./TransformStartTransformResponse.md)>;` | Start a transform. When you start a transform, it creates the destination index if it does not already exist. The `number_of_shards` is set to `1` and the `auto_expand_replicas` is set to `0-1`. If it is a pivot transform, it deduces the mapping definitions for the destination index from the source indices and the transform aggregations. If fields in the destination index are derived from scripts (as in the case of `scripted_metric` or `bucket_script` aggregations), the transform uses dynamic mappings unless an index template exists. If it is a latest transform, it does not deduce mapping definitions; it uses dynamic mappings. To use explicit mappings, create the destination index before you start the transform. Alternatively, you can create an index template, though it does not affect the deduced mappings in a pivot transform. When the transform starts, a series of validations occur to ensure its success. If you deferred validation when you created the transform, they occur when you start the transform—with the exception of privilege checks. When Elasticsearch security features are enabled, the transform remembers which roles the user that created it had at the time of creation and uses those same roles. If those roles do not have the required privileges on the source and destination indices, the transform fails when it attempts unauthorized operations. | +| `startTransform` | `startTransform(this: [That](./That.md), params: [TransformStartTransformRequest](./TransformStartTransformRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TransformStartTransformResponse](./TransformStartTransformResponse.md), unknown>>;` |   | +| `startTransform` | `startTransform(this: [That](./That.md), params: [TransformStartTransformRequest](./TransformStartTransformRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TransformStartTransformResponse](./TransformStartTransformResponse.md)>;` |   | +| `stopTransform` | `stopTransform(this: [That](./That.md), params: [TransformStopTransformRequest](./TransformStopTransformRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TransformStopTransformResponse](./TransformStopTransformResponse.md)>;` | Stop transforms. Stops one or more transforms. | +| `stopTransform` | `stopTransform(this: [That](./That.md), params: [TransformStopTransformRequest](./TransformStopTransformRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TransformStopTransformResponse](./TransformStopTransformResponse.md), unknown>>;` |   | +| `stopTransform` | `stopTransform(this: [That](./That.md), params: [TransformStopTransformRequest](./TransformStopTransformRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TransformStopTransformResponse](./TransformStopTransformResponse.md)>;` |   | +| `updateTransform` | `updateTransform(this: [That](./That.md), params: [TransformUpdateTransformRequest](./TransformUpdateTransformRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TransformUpdateTransformResponse](./TransformUpdateTransformResponse.md)>;` | Update a transform. Updates certain properties of a transform. All updated properties except `description` do not take effect until after the transform starts the next checkpoint, thus there is data consistency in each checkpoint. To use this API, you must have `read` and `view_index_metadata` privileges for the source indices. You must also have `index` and `read` privileges for the destination index. When Elasticsearch security features are enabled, the transform remembers which roles the user who updated it had at the time of update and runs with those privileges. | +| `updateTransform` | `updateTransform(this: [That](./That.md), params: [TransformUpdateTransformRequest](./TransformUpdateTransformRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TransformUpdateTransformResponse](./TransformUpdateTransformResponse.md), unknown>>;` |   | +| `updateTransform` | `updateTransform(this: [That](./That.md), params: [TransformUpdateTransformRequest](./TransformUpdateTransformRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TransformUpdateTransformResponse](./TransformUpdateTransformResponse.md)>;` |   | +| `upgradeTransforms` | `upgradeTransforms(this: [That](./That.md), params?: [TransformUpgradeTransformsRequest](./TransformUpgradeTransformsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TransformUpgradeTransformsResponse](./TransformUpgradeTransformsResponse.md)>;` | Upgrade all transforms. Transforms are compatible across minor versions and between supported major versions. However, over time, the format of transform configuration information may change. This API identifies transforms that have a legacy configuration format and upgrades them to the latest version. It also cleans up the internal data structures that store the transform state and checkpoints. The upgrade does not affect the source and destination indices. The upgrade also does not affect the roles that transforms use when Elasticsearch security features are enabled; the role used to read source data and write to the destination index remains unchanged. If a transform upgrade step fails, the upgrade stops and an error is returned about the underlying issue. Resolve the issue then re-run the process again. A summary is returned when the upgrade is finished. To ensure continuous transforms remain running during a major version upgrade of the cluster – for example, from 7.16 to 8.0 – it is recommended to upgrade transforms before upgrading the cluster. You may want to perform a recent cluster backup prior to the upgrade. | +| `upgradeTransforms` | `upgradeTransforms(this: [That](./That.md), params?: [TransformUpgradeTransformsRequest](./TransformUpgradeTransformsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TransformUpgradeTransformsResponse](./TransformUpgradeTransformsResponse.md), unknown>>;` |   | +| `upgradeTransforms` | `upgradeTransforms(this: [That](./That.md), params?: [TransformUpgradeTransformsRequest](./TransformUpgradeTransformsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TransformUpgradeTransformsResponse](./TransformUpgradeTransformsResponse.md)>;` |   | diff --git a/docs/reference/api/Watcher.md b/docs/reference/api/Watcher.md index 3b048d1d4..4258ac34e 100644 --- a/docs/reference/api/Watcher.md +++ b/docs/reference/api/Watcher.md @@ -17,4 +17,42 @@ new Watcher(transport: [Transport](./Transport.md)); | Name | Signature | Description | | - | - | - | -| `ackWatch` | `ackWatch(this: [That](./That.md), params: [WatcherAckWatchRequest](./WatcherAckWatchRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[WatcherAckWatchResponse](./WatcherAckWatchResponse.md)>;` | Acknowledge a watch. Acknowledging a watch enables you to manually throttle the execution of the watch's actions. The acknowledgement state of an action is stored in the `status.actions..ack.state` structure. IMPORTANT: If the specified watch is currently being executed, this API will return an error The reason for this behavior is to prevent overwriting the watch status from a watch execution. Acknowledging an action throttles further executions of that action until its `ack.state` is reset to `awaits_successful_execution`. This happens when the condition of the watch is not met (the condition evaluates to false). || `ackWatch` | `ackWatch(this: [That](./That.md), params: [WatcherAckWatchRequest](./WatcherAckWatchRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[WatcherAckWatchResponse](./WatcherAckWatchResponse.md), unknown>>;` |   || `ackWatch` | `ackWatch(this: [That](./That.md), params: [WatcherAckWatchRequest](./WatcherAckWatchRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[WatcherAckWatchResponse](./WatcherAckWatchResponse.md)>;` |   || `activateWatch` | `activateWatch(this: [That](./That.md), params: [WatcherActivateWatchRequest](./WatcherActivateWatchRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[WatcherActivateWatchResponse](./WatcherActivateWatchResponse.md)>;` | Activate a watch. A watch can be either active or inactive. || `activateWatch` | `activateWatch(this: [That](./That.md), params: [WatcherActivateWatchRequest](./WatcherActivateWatchRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[WatcherActivateWatchResponse](./WatcherActivateWatchResponse.md), unknown>>;` |   || `activateWatch` | `activateWatch(this: [That](./That.md), params: [WatcherActivateWatchRequest](./WatcherActivateWatchRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[WatcherActivateWatchResponse](./WatcherActivateWatchResponse.md)>;` |   || `deactivateWatch` | `deactivateWatch(this: [That](./That.md), params: [WatcherDeactivateWatchRequest](./WatcherDeactivateWatchRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[WatcherDeactivateWatchResponse](./WatcherDeactivateWatchResponse.md)>;` | Deactivate a watch. A watch can be either active or inactive. || `deactivateWatch` | `deactivateWatch(this: [That](./That.md), params: [WatcherDeactivateWatchRequest](./WatcherDeactivateWatchRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[WatcherDeactivateWatchResponse](./WatcherDeactivateWatchResponse.md), unknown>>;` |   || `deactivateWatch` | `deactivateWatch(this: [That](./That.md), params: [WatcherDeactivateWatchRequest](./WatcherDeactivateWatchRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[WatcherDeactivateWatchResponse](./WatcherDeactivateWatchResponse.md)>;` |   || `deleteWatch` | `deleteWatch(this: [That](./That.md), params: [WatcherDeleteWatchRequest](./WatcherDeleteWatchRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[WatcherDeleteWatchResponse](./WatcherDeleteWatchResponse.md)>;` | Delete a watch. When the watch is removed, the document representing the watch in the `.watches` index is gone and it will never be run again. Deleting a watch does not delete any watch execution records related to this watch from the watch history. IMPORTANT: Deleting a watch must be done by using only this API. Do not delete the watch directly from the `.watches` index using the Elasticsearch delete document API When Elasticsearch security features are enabled, make sure no write privileges are granted to anyone for the `.watches` index. || `deleteWatch` | `deleteWatch(this: [That](./That.md), params: [WatcherDeleteWatchRequest](./WatcherDeleteWatchRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[WatcherDeleteWatchResponse](./WatcherDeleteWatchResponse.md), unknown>>;` |   || `deleteWatch` | `deleteWatch(this: [That](./That.md), params: [WatcherDeleteWatchRequest](./WatcherDeleteWatchRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[WatcherDeleteWatchResponse](./WatcherDeleteWatchResponse.md)>;` |   || `executeWatch` | `executeWatch(this: [That](./That.md), params?: [WatcherExecuteWatchRequest](./WatcherExecuteWatchRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[WatcherExecuteWatchResponse](./WatcherExecuteWatchResponse.md)>;` | Run a watch. This API can be used to force execution of the watch outside of its triggering logic or to simulate the watch execution for debugging purposes. For testing and debugging purposes, you also have fine-grained control on how the watch runs. You can run the watch without running all of its actions or alternatively by simulating them. You can also force execution by ignoring the watch condition and control whether a watch record would be written to the watch history after it runs. You can use the run watch API to run watches that are not yet registered by specifying the watch definition inline. This serves as great tool for testing and debugging your watches prior to adding them to Watcher. When Elasticsearch security features are enabled on your cluster, watches are run with the privileges of the user that stored the watches. If your user is allowed to read index `a`, but not index `b`, then the exact same set of rules will apply during execution of a watch. When using the run watch API, the authorization data of the user that called the API will be used as a base, instead of the information who stored the watch. || `executeWatch` | `executeWatch(this: [That](./That.md), params?: [WatcherExecuteWatchRequest](./WatcherExecuteWatchRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[WatcherExecuteWatchResponse](./WatcherExecuteWatchResponse.md), unknown>>;` |   || `executeWatch` | `executeWatch(this: [That](./That.md), params?: [WatcherExecuteWatchRequest](./WatcherExecuteWatchRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[WatcherExecuteWatchResponse](./WatcherExecuteWatchResponse.md)>;` |   || `getSettings` | `getSettings(this: [That](./That.md), params?: [WatcherGetSettingsRequest](./WatcherGetSettingsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[WatcherGetSettingsResponse](./WatcherGetSettingsResponse.md)>;` | Get Watcher index settings. Get settings for the Watcher internal index ( `.watches`). Only a subset of settings are shown, for example `index.auto_expand_replicas` and `index.number_of_replicas`. || `getSettings` | `getSettings(this: [That](./That.md), params?: [WatcherGetSettingsRequest](./WatcherGetSettingsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[WatcherGetSettingsResponse](./WatcherGetSettingsResponse.md), unknown>>;` |   || `getSettings` | `getSettings(this: [That](./That.md), params?: [WatcherGetSettingsRequest](./WatcherGetSettingsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[WatcherGetSettingsResponse](./WatcherGetSettingsResponse.md)>;` |   || `getWatch` | `getWatch(this: [That](./That.md), params: [WatcherGetWatchRequest](./WatcherGetWatchRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[WatcherGetWatchResponse](./WatcherGetWatchResponse.md)>;` | Get a watch. || `getWatch` | `getWatch(this: [That](./That.md), params: [WatcherGetWatchRequest](./WatcherGetWatchRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[WatcherGetWatchResponse](./WatcherGetWatchResponse.md), unknown>>;` |   || `getWatch` | `getWatch(this: [That](./That.md), params: [WatcherGetWatchRequest](./WatcherGetWatchRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[WatcherGetWatchResponse](./WatcherGetWatchResponse.md)>;` |   || `putWatch` | `putWatch(this: [That](./That.md), params: [WatcherPutWatchRequest](./WatcherPutWatchRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[WatcherPutWatchResponse](./WatcherPutWatchResponse.md)>;` | Create or update a watch. When a watch is registered, a new document that represents the watch is added to the `.watches` index and its trigger is immediately registered with the relevant trigger engine. Typically for the `schedule` trigger, the scheduler is the trigger engine. IMPORTANT: You must use Kibana or this API to create a watch. Do not add a watch directly to the `.watches` index by using the Elasticsearch index API. If Elasticsearch security features are enabled, do not give users write privileges on the `.watches` index. When you add a watch you can also define its initial active state by setting the *active* parameter. When Elasticsearch security features are enabled, your watch can index or search only on indices for which the user that stored the watch has privileges. If the user is able to read index `a`, but not index `b`, the same will apply when the watch runs. || `putWatch` | `putWatch(this: [That](./That.md), params: [WatcherPutWatchRequest](./WatcherPutWatchRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[WatcherPutWatchResponse](./WatcherPutWatchResponse.md), unknown>>;` |   || `putWatch` | `putWatch(this: [That](./That.md), params: [WatcherPutWatchRequest](./WatcherPutWatchRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[WatcherPutWatchResponse](./WatcherPutWatchResponse.md)>;` |   || `queryWatches` | `queryWatches(this: [That](./That.md), params?: [WatcherQueryWatchesRequest](./WatcherQueryWatchesRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[WatcherQueryWatchesResponse](./WatcherQueryWatchesResponse.md)>;` | Query watches. Get all registered watches in a paginated manner and optionally filter watches by a query. Note that only the `_id` and `metadata.*` fields are queryable or sortable. || `queryWatches` | `queryWatches(this: [That](./That.md), params?: [WatcherQueryWatchesRequest](./WatcherQueryWatchesRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[WatcherQueryWatchesResponse](./WatcherQueryWatchesResponse.md), unknown>>;` |   || `queryWatches` | `queryWatches(this: [That](./That.md), params?: [WatcherQueryWatchesRequest](./WatcherQueryWatchesRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[WatcherQueryWatchesResponse](./WatcherQueryWatchesResponse.md)>;` |   || `start` | `start(this: [That](./That.md), params?: [WatcherStartRequest](./WatcherStartRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[WatcherStartResponse](./WatcherStartResponse.md)>;` | Start the watch service. Start the Watcher service if it is not already running. || `start` | `start(this: [That](./That.md), params?: [WatcherStartRequest](./WatcherStartRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[WatcherStartResponse](./WatcherStartResponse.md), unknown>>;` |   || `start` | `start(this: [That](./That.md), params?: [WatcherStartRequest](./WatcherStartRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[WatcherStartResponse](./WatcherStartResponse.md)>;` |   || `stats` | `stats(this: [That](./That.md), params?: [WatcherStatsRequest](./WatcherStatsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[WatcherStatsResponse](./WatcherStatsResponse.md)>;` | Get Watcher statistics. This API always returns basic metrics. You retrieve more metrics by using the metric parameter. || `stats` | `stats(this: [That](./That.md), params?: [WatcherStatsRequest](./WatcherStatsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[WatcherStatsResponse](./WatcherStatsResponse.md), unknown>>;` |   || `stats` | `stats(this: [That](./That.md), params?: [WatcherStatsRequest](./WatcherStatsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[WatcherStatsResponse](./WatcherStatsResponse.md)>;` |   || `stop` | `stop(this: [That](./That.md), params?: [WatcherStopRequest](./WatcherStopRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[WatcherStopResponse](./WatcherStopResponse.md)>;` | Stop the watch service. Stop the Watcher service if it is running. || `stop` | `stop(this: [That](./That.md), params?: [WatcherStopRequest](./WatcherStopRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[WatcherStopResponse](./WatcherStopResponse.md), unknown>>;` |   || `stop` | `stop(this: [That](./That.md), params?: [WatcherStopRequest](./WatcherStopRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[WatcherStopResponse](./WatcherStopResponse.md)>;` |   || `updateSettings` | `updateSettings(this: [That](./That.md), params?: [WatcherUpdateSettingsRequest](./WatcherUpdateSettingsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[WatcherUpdateSettingsResponse](./WatcherUpdateSettingsResponse.md)>;` | Update Watcher index settings. Update settings for the Watcher internal index ( `.watches`). Only a subset of settings can be modified. This includes `index.auto_expand_replicas`, `index.number_of_replicas`, `index.routing.allocation.exclude.*`, `index.routing.allocation.include.*` and `index.routing.allocation.require.*`. Modification of `index.routing.allocation.include._tier_preference` is an exception and is not allowed as the Watcher shards must always be in the `data_content` tier. || `updateSettings` | `updateSettings(this: [That](./That.md), params?: [WatcherUpdateSettingsRequest](./WatcherUpdateSettingsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[WatcherUpdateSettingsResponse](./WatcherUpdateSettingsResponse.md), unknown>>;` |   || `updateSettings` | `updateSettings(this: [That](./That.md), params?: [WatcherUpdateSettingsRequest](./WatcherUpdateSettingsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[WatcherUpdateSettingsResponse](./WatcherUpdateSettingsResponse.md)>;` |   | \ No newline at end of file +| `ackWatch` | `ackWatch(this: [That](./That.md), params: [WatcherAckWatchRequest](./WatcherAckWatchRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[WatcherAckWatchResponse](./WatcherAckWatchResponse.md)>;` | Acknowledge a watch. Acknowledging a watch enables you to manually throttle the execution of the watch's actions. The acknowledgement state of an action is stored in the `status.actions..ack.state` structure. IMPORTANT: If the specified watch is currently being executed, this API will return an error The reason for this behavior is to prevent overwriting the watch status from a watch execution. Acknowledging an action throttles further executions of that action until its `ack.state` is reset to `awaits_successful_execution`. This happens when the condition of the watch is not met (the condition evaluates to false). | +| `ackWatch` | `ackWatch(this: [That](./That.md), params: [WatcherAckWatchRequest](./WatcherAckWatchRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[WatcherAckWatchResponse](./WatcherAckWatchResponse.md), unknown>>;` |   | +| `ackWatch` | `ackWatch(this: [That](./That.md), params: [WatcherAckWatchRequest](./WatcherAckWatchRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[WatcherAckWatchResponse](./WatcherAckWatchResponse.md)>;` |   | +| `activateWatch` | `activateWatch(this: [That](./That.md), params: [WatcherActivateWatchRequest](./WatcherActivateWatchRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[WatcherActivateWatchResponse](./WatcherActivateWatchResponse.md)>;` | Activate a watch. A watch can be either active or inactive. | +| `activateWatch` | `activateWatch(this: [That](./That.md), params: [WatcherActivateWatchRequest](./WatcherActivateWatchRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[WatcherActivateWatchResponse](./WatcherActivateWatchResponse.md), unknown>>;` |   | +| `activateWatch` | `activateWatch(this: [That](./That.md), params: [WatcherActivateWatchRequest](./WatcherActivateWatchRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[WatcherActivateWatchResponse](./WatcherActivateWatchResponse.md)>;` |   | +| `deactivateWatch` | `deactivateWatch(this: [That](./That.md), params: [WatcherDeactivateWatchRequest](./WatcherDeactivateWatchRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[WatcherDeactivateWatchResponse](./WatcherDeactivateWatchResponse.md)>;` | Deactivate a watch. A watch can be either active or inactive. | +| `deactivateWatch` | `deactivateWatch(this: [That](./That.md), params: [WatcherDeactivateWatchRequest](./WatcherDeactivateWatchRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[WatcherDeactivateWatchResponse](./WatcherDeactivateWatchResponse.md), unknown>>;` |   | +| `deactivateWatch` | `deactivateWatch(this: [That](./That.md), params: [WatcherDeactivateWatchRequest](./WatcherDeactivateWatchRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[WatcherDeactivateWatchResponse](./WatcherDeactivateWatchResponse.md)>;` |   | +| `deleteWatch` | `deleteWatch(this: [That](./That.md), params: [WatcherDeleteWatchRequest](./WatcherDeleteWatchRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[WatcherDeleteWatchResponse](./WatcherDeleteWatchResponse.md)>;` | Delete a watch. When the watch is removed, the document representing the watch in the `.watches` index is gone and it will never be run again. Deleting a watch does not delete any watch execution records related to this watch from the watch history. IMPORTANT: Deleting a watch must be done by using only this API. Do not delete the watch directly from the `.watches` index using the Elasticsearch delete document API When Elasticsearch security features are enabled, make sure no write privileges are granted to anyone for the `.watches` index. | +| `deleteWatch` | `deleteWatch(this: [That](./That.md), params: [WatcherDeleteWatchRequest](./WatcherDeleteWatchRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[WatcherDeleteWatchResponse](./WatcherDeleteWatchResponse.md), unknown>>;` |   | +| `deleteWatch` | `deleteWatch(this: [That](./That.md), params: [WatcherDeleteWatchRequest](./WatcherDeleteWatchRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[WatcherDeleteWatchResponse](./WatcherDeleteWatchResponse.md)>;` |   | +| `executeWatch` | `executeWatch(this: [That](./That.md), params?: [WatcherExecuteWatchRequest](./WatcherExecuteWatchRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[WatcherExecuteWatchResponse](./WatcherExecuteWatchResponse.md)>;` | Run a watch. This API can be used to force execution of the watch outside of its triggering logic or to simulate the watch execution for debugging purposes. For testing and debugging purposes, you also have fine-grained control on how the watch runs. You can run the watch without running all of its actions or alternatively by simulating them. You can also force execution by ignoring the watch condition and control whether a watch record would be written to the watch history after it runs. You can use the run watch API to run watches that are not yet registered by specifying the watch definition inline. This serves as great tool for testing and debugging your watches prior to adding them to Watcher. When Elasticsearch security features are enabled on your cluster, watches are run with the privileges of the user that stored the watches. If your user is allowed to read index `a`, but not index `b`, then the exact same set of rules will apply during execution of a watch. When using the run watch API, the authorization data of the user that called the API will be used as a base, instead of the information who stored the watch. | +| `executeWatch` | `executeWatch(this: [That](./That.md), params?: [WatcherExecuteWatchRequest](./WatcherExecuteWatchRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[WatcherExecuteWatchResponse](./WatcherExecuteWatchResponse.md), unknown>>;` |   | +| `executeWatch` | `executeWatch(this: [That](./That.md), params?: [WatcherExecuteWatchRequest](./WatcherExecuteWatchRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[WatcherExecuteWatchResponse](./WatcherExecuteWatchResponse.md)>;` |   | +| `getSettings` | `getSettings(this: [That](./That.md), params?: [WatcherGetSettingsRequest](./WatcherGetSettingsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[WatcherGetSettingsResponse](./WatcherGetSettingsResponse.md)>;` | Get Watcher index settings. Get settings for the Watcher internal index ( `.watches`). Only a subset of settings are shown, for example `index.auto_expand_replicas` and `index.number_of_replicas`. | +| `getSettings` | `getSettings(this: [That](./That.md), params?: [WatcherGetSettingsRequest](./WatcherGetSettingsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[WatcherGetSettingsResponse](./WatcherGetSettingsResponse.md), unknown>>;` |   | +| `getSettings` | `getSettings(this: [That](./That.md), params?: [WatcherGetSettingsRequest](./WatcherGetSettingsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[WatcherGetSettingsResponse](./WatcherGetSettingsResponse.md)>;` |   | +| `getWatch` | `getWatch(this: [That](./That.md), params: [WatcherGetWatchRequest](./WatcherGetWatchRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[WatcherGetWatchResponse](./WatcherGetWatchResponse.md)>;` | Get a watch. | +| `getWatch` | `getWatch(this: [That](./That.md), params: [WatcherGetWatchRequest](./WatcherGetWatchRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[WatcherGetWatchResponse](./WatcherGetWatchResponse.md), unknown>>;` |   | +| `getWatch` | `getWatch(this: [That](./That.md), params: [WatcherGetWatchRequest](./WatcherGetWatchRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[WatcherGetWatchResponse](./WatcherGetWatchResponse.md)>;` |   | +| `putWatch` | `putWatch(this: [That](./That.md), params: [WatcherPutWatchRequest](./WatcherPutWatchRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[WatcherPutWatchResponse](./WatcherPutWatchResponse.md)>;` | Create or update a watch. When a watch is registered, a new document that represents the watch is added to the `.watches` index and its trigger is immediately registered with the relevant trigger engine. Typically for the `schedule` trigger, the scheduler is the trigger engine. IMPORTANT: You must use Kibana or this API to create a watch. Do not add a watch directly to the `.watches` index by using the Elasticsearch index API. If Elasticsearch security features are enabled, do not give users write privileges on the `.watches` index. When you add a watch you can also define its initial active state by setting the *active* parameter. When Elasticsearch security features are enabled, your watch can index or search only on indices for which the user that stored the watch has privileges. If the user is able to read index `a`, but not index `b`, the same will apply when the watch runs. | +| `putWatch` | `putWatch(this: [That](./That.md), params: [WatcherPutWatchRequest](./WatcherPutWatchRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[WatcherPutWatchResponse](./WatcherPutWatchResponse.md), unknown>>;` |   | +| `putWatch` | `putWatch(this: [That](./That.md), params: [WatcherPutWatchRequest](./WatcherPutWatchRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[WatcherPutWatchResponse](./WatcherPutWatchResponse.md)>;` |   | +| `queryWatches` | `queryWatches(this: [That](./That.md), params?: [WatcherQueryWatchesRequest](./WatcherQueryWatchesRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[WatcherQueryWatchesResponse](./WatcherQueryWatchesResponse.md)>;` | Query watches. Get all registered watches in a paginated manner and optionally filter watches by a query. Note that only the `_id` and `metadata.*` fields are queryable or sortable. | +| `queryWatches` | `queryWatches(this: [That](./That.md), params?: [WatcherQueryWatchesRequest](./WatcherQueryWatchesRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[WatcherQueryWatchesResponse](./WatcherQueryWatchesResponse.md), unknown>>;` |   | +| `queryWatches` | `queryWatches(this: [That](./That.md), params?: [WatcherQueryWatchesRequest](./WatcherQueryWatchesRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[WatcherQueryWatchesResponse](./WatcherQueryWatchesResponse.md)>;` |   | +| `start` | `start(this: [That](./That.md), params?: [WatcherStartRequest](./WatcherStartRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[WatcherStartResponse](./WatcherStartResponse.md)>;` | Start the watch service. Start the Watcher service if it is not already running. | +| `start` | `start(this: [That](./That.md), params?: [WatcherStartRequest](./WatcherStartRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[WatcherStartResponse](./WatcherStartResponse.md), unknown>>;` |   | +| `start` | `start(this: [That](./That.md), params?: [WatcherStartRequest](./WatcherStartRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[WatcherStartResponse](./WatcherStartResponse.md)>;` |   | +| `stats` | `stats(this: [That](./That.md), params?: [WatcherStatsRequest](./WatcherStatsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[WatcherStatsResponse](./WatcherStatsResponse.md)>;` | Get Watcher statistics. This API always returns basic metrics. You retrieve more metrics by using the metric parameter. | +| `stats` | `stats(this: [That](./That.md), params?: [WatcherStatsRequest](./WatcherStatsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[WatcherStatsResponse](./WatcherStatsResponse.md), unknown>>;` |   | +| `stats` | `stats(this: [That](./That.md), params?: [WatcherStatsRequest](./WatcherStatsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[WatcherStatsResponse](./WatcherStatsResponse.md)>;` |   | +| `stop` | `stop(this: [That](./That.md), params?: [WatcherStopRequest](./WatcherStopRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[WatcherStopResponse](./WatcherStopResponse.md)>;` | Stop the watch service. Stop the Watcher service if it is running. | +| `stop` | `stop(this: [That](./That.md), params?: [WatcherStopRequest](./WatcherStopRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[WatcherStopResponse](./WatcherStopResponse.md), unknown>>;` |   | +| `stop` | `stop(this: [That](./That.md), params?: [WatcherStopRequest](./WatcherStopRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[WatcherStopResponse](./WatcherStopResponse.md)>;` |   | +| `updateSettings` | `updateSettings(this: [That](./That.md), params?: [WatcherUpdateSettingsRequest](./WatcherUpdateSettingsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[WatcherUpdateSettingsResponse](./WatcherUpdateSettingsResponse.md)>;` | Update Watcher index settings. Update settings for the Watcher internal index ( `.watches`). Only a subset of settings can be modified. This includes `index.auto_expand_replicas`, `index.number_of_replicas`, `index.routing.allocation.exclude.*`, `index.routing.allocation.include.*` and `index.routing.allocation.require.*`. Modification of `index.routing.allocation.include._tier_preference` is an exception and is not allowed as the Watcher shards must always be in the `data_content` tier. | +| `updateSettings` | `updateSettings(this: [That](./That.md), params?: [WatcherUpdateSettingsRequest](./WatcherUpdateSettingsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[WatcherUpdateSettingsResponse](./WatcherUpdateSettingsResponse.md), unknown>>;` |   | +| `updateSettings` | `updateSettings(this: [That](./That.md), params?: [WatcherUpdateSettingsRequest](./WatcherUpdateSettingsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[WatcherUpdateSettingsResponse](./WatcherUpdateSettingsResponse.md)>;` |   | diff --git a/docs/reference/api/Xpack.md b/docs/reference/api/Xpack.md index 37e3e3b56..bdd62b8a2 100644 --- a/docs/reference/api/Xpack.md +++ b/docs/reference/api/Xpack.md @@ -17,4 +17,9 @@ new Xpack(transport: [Transport](./Transport.md)); | Name | Signature | Description | | - | - | - | -| `info` | `info(this: [That](./That.md), params?: [XpackInfoRequest](./XpackInfoRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[XpackInfoResponse](./XpackInfoResponse.md)>;` | Get information. The information provided by the API includes: * Build information including the build number and timestamp. * License information about the currently installed license. * Feature information for the features that are currently enabled and available under the current license. || `info` | `info(this: [That](./That.md), params?: [XpackInfoRequest](./XpackInfoRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[XpackInfoResponse](./XpackInfoResponse.md), unknown>>;` |   || `info` | `info(this: [That](./That.md), params?: [XpackInfoRequest](./XpackInfoRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[XpackInfoResponse](./XpackInfoResponse.md)>;` |   || `usage` | `usage(this: [That](./That.md), params?: [XpackUsageRequest](./XpackUsageRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[XpackUsageResponse](./XpackUsageResponse.md)>;` | Get usage information. Get information about the features that are currently enabled and available under the current license. The API also provides some usage statistics. || `usage` | `usage(this: [That](./That.md), params?: [XpackUsageRequest](./XpackUsageRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[XpackUsageResponse](./XpackUsageResponse.md), unknown>>;` |   || `usage` | `usage(this: [That](./That.md), params?: [XpackUsageRequest](./XpackUsageRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[XpackUsageResponse](./XpackUsageResponse.md)>;` |   | \ No newline at end of file +| `info` | `info(this: [That](./That.md), params?: [XpackInfoRequest](./XpackInfoRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[XpackInfoResponse](./XpackInfoResponse.md)>;` | Get information. The information provided by the API includes: * Build information including the build number and timestamp. * License information about the currently installed license. * Feature information for the features that are currently enabled and available under the current license. | +| `info` | `info(this: [That](./That.md), params?: [XpackInfoRequest](./XpackInfoRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[XpackInfoResponse](./XpackInfoResponse.md), unknown>>;` |   | +| `info` | `info(this: [That](./That.md), params?: [XpackInfoRequest](./XpackInfoRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[XpackInfoResponse](./XpackInfoResponse.md)>;` |   | +| `usage` | `usage(this: [That](./That.md), params?: [XpackUsageRequest](./XpackUsageRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[XpackUsageResponse](./XpackUsageResponse.md)>;` | Get usage information. Get information about the features that are currently enabled and available under the current license. The API also provides some usage statistics. | +| `usage` | `usage(this: [That](./That.md), params?: [XpackUsageRequest](./XpackUsageRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[XpackUsageResponse](./XpackUsageResponse.md), unknown>>;` |   | +| `usage` | `usage(this: [That](./That.md), params?: [XpackUsageRequest](./XpackUsageRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[XpackUsageResponse](./XpackUsageResponse.md)>;` |   | From b140fcda7f1d0e35dcf6fe3658ffe536a133c979 Mon Sep 17 00:00:00 2001 From: Josh Mock Date: Wed, 28 May 2025 10:02:30 -0500 Subject: [PATCH 6/7] Another round of tweaks --- docs/reference/api-reference.md | 2 +- docs/reference/api/API.md | 2 +- .../reference/api/AcknowledgedResponseBase.md | 2 +- docs/reference/api/Action.md | 6 ++-- docs/reference/api/AggregateName.md | 6 ++-- .../AggregationsAdjacencyMatrixAggregate.md | 2 +- .../AggregationsAdjacencyMatrixAggregation.md | 2 +- .../api/AggregationsAdjacencyMatrixBucket.md | 6 ++-- .../AggregationsAdjacencyMatrixBucketKeys.md | 2 +- docs/reference/api/AggregationsAggregate.md | 6 ++-- .../api/AggregationsAggregateBase.md | 2 +- .../api/AggregationsAggregateOrder.md | 6 ++-- docs/reference/api/AggregationsAggregation.md | 2 +- .../api/AggregationsAggregationContainer.md | 2 +- .../api/AggregationsAggregationRange.md | 2 +- .../api/AggregationsArrayPercentilesItem.md | 2 +- .../AggregationsAutoDateHistogramAggregate.md | 2 +- ...ggregationsAutoDateHistogramAggregation.md | 2 +- .../api/AggregationsAverageAggregation.md | 2 +- .../AggregationsAverageBucketAggregation.md | 2 +- .../reference/api/AggregationsAvgAggregate.md | 2 +- .../api/AggregationsBoxPlotAggregate.md | 2 +- .../api/AggregationsBoxplotAggregation.md | 2 +- .../api/AggregationsBucketAggregationBase.md | 2 +- ...ggregationsBucketCorrelationAggregation.md | 2 +- .../AggregationsBucketCorrelationFunction.md | 2 +- ...cketCorrelationFunctionCountCorrelation.md | 2 +- ...lationFunctionCountCorrelationIndicator.md | 2 +- .../api/AggregationsBucketKsAggregation.md | 2 +- .../AggregationsBucketMetricValueAggregate.md | 2 +- .../api/AggregationsBucketPathAggregation.md | 2 +- .../AggregationsBucketScriptAggregation.md | 2 +- .../AggregationsBucketSelectorAggregation.md | 2 +- .../api/AggregationsBucketSortAggregation.md | 2 +- docs/reference/api/AggregationsBuckets.md | 6 ++-- docs/reference/api/AggregationsBucketsPath.md | 6 ++-- .../api/AggregationsCalendarInterval.md | 6 ++-- .../api/AggregationsCardinalityAggregate.md | 2 +- .../api/AggregationsCardinalityAggregation.md | 2 +- .../AggregationsCardinalityExecutionMode.md | 6 ++-- .../AggregationsCategorizeTextAggregation.md | 2 +- .../api/AggregationsCategorizeTextAnalyzer.md | 6 ++-- .../api/AggregationsChiSquareHeuristic.md | 2 +- .../api/AggregationsChildrenAggregate.md | 6 ++-- .../api/AggregationsChildrenAggregateKeys.md | 2 +- .../api/AggregationsChildrenAggregation.md | 2 +- .../api/AggregationsCompositeAggregate.md | 2 +- .../api/AggregationsCompositeAggregateKey.md | 6 ++-- .../api/AggregationsCompositeAggregation.md | 2 +- .../AggregationsCompositeAggregationBase.md | 2 +- .../AggregationsCompositeAggregationSource.md | 2 +- .../api/AggregationsCompositeBucket.md | 6 ++-- .../api/AggregationsCompositeBucketKeys.md | 2 +- ...ationsCompositeDateHistogramAggregation.md | 2 +- ...egationsCompositeGeoTileGridAggregation.md | 2 +- ...gregationsCompositeHistogramAggregation.md | 2 +- .../AggregationsCompositeTermsAggregation.md | 2 +- ...regationsCumulativeCardinalityAggregate.md | 2 +- ...gationsCumulativeCardinalityAggregation.md | 2 +- .../AggregationsCumulativeSumAggregation.md | 2 +- ...ggregationsCustomCategorizeTextAnalyzer.md | 2 +- .../api/AggregationsDateHistogramAggregate.md | 2 +- .../AggregationsDateHistogramAggregation.md | 2 +- .../api/AggregationsDateHistogramBucket.md | 6 ++-- .../AggregationsDateHistogramBucketKeys.md | 2 +- .../api/AggregationsDateRangeAggregate.md | 2 +- .../api/AggregationsDateRangeAggregation.md | 2 +- .../api/AggregationsDateRangeExpression.md | 2 +- .../api/AggregationsDerivativeAggregate.md | 2 +- .../api/AggregationsDerivativeAggregation.md | 2 +- ...gregationsDiversifiedSamplerAggregation.md | 2 +- .../api/AggregationsDoubleTermsAggregate.md | 2 +- .../api/AggregationsDoubleTermsBucket.md | 6 ++-- .../api/AggregationsDoubleTermsBucketKeys.md | 2 +- .../api/AggregationsEwmaModelSettings.md | 2 +- ...ggregationsEwmaMovingAverageAggregation.md | 2 +- .../api/AggregationsExtendedBounds.md | 2 +- .../api/AggregationsExtendedStatsAggregate.md | 2 +- .../AggregationsExtendedStatsAggregation.md | 2 +- ...ggregationsExtendedStatsBucketAggregate.md | 2 +- ...regationsExtendedStatsBucketAggregation.md | 2 +- .../api/AggregationsFieldDateMath.md | 6 ++-- .../api/AggregationsFilterAggregate.md | 6 ++-- .../api/AggregationsFilterAggregateKeys.md | 2 +- .../api/AggregationsFiltersAggregate.md | 2 +- .../api/AggregationsFiltersAggregation.md | 2 +- .../api/AggregationsFiltersBucket.md | 6 ++-- .../api/AggregationsFiltersBucketKeys.md | 2 +- ...AggregationsFormatMetricAggregationBase.md | 2 +- ...ggregationsFormattableMetricAggregation.md | 2 +- .../AggregationsFrequentItemSetsAggregate.md | 2 +- ...AggregationsFrequentItemSetsAggregation.md | 2 +- .../api/AggregationsFrequentItemSetsBucket.md | 6 ++-- .../AggregationsFrequentItemSetsBucketKeys.md | 2 +- .../api/AggregationsFrequentItemSetsField.md | 2 +- docs/reference/api/AggregationsGapPolicy.md | 6 ++-- .../api/AggregationsGeoBoundsAggregate.md | 2 +- .../api/AggregationsGeoBoundsAggregation.md | 2 +- .../api/AggregationsGeoCentroidAggregate.md | 2 +- .../api/AggregationsGeoCentroidAggregation.md | 2 +- .../api/AggregationsGeoDistanceAggregate.md | 2 +- .../api/AggregationsGeoDistanceAggregation.md | 2 +- .../api/AggregationsGeoHashGridAggregate.md | 2 +- .../api/AggregationsGeoHashGridAggregation.md | 2 +- .../api/AggregationsGeoHashGridBucket.md | 6 ++-- .../api/AggregationsGeoHashGridBucketKeys.md | 2 +- .../api/AggregationsGeoHexGridAggregate.md | 2 +- .../api/AggregationsGeoHexGridBucket.md | 6 ++-- .../api/AggregationsGeoHexGridBucketKeys.md | 2 +- .../api/AggregationsGeoLineAggregate.md | 2 +- .../api/AggregationsGeoLineAggregation.md | 2 +- .../reference/api/AggregationsGeoLinePoint.md | 2 +- docs/reference/api/AggregationsGeoLineSort.md | 2 +- .../api/AggregationsGeoTileGridAggregate.md | 2 +- .../api/AggregationsGeoTileGridAggregation.md | 2 +- .../api/AggregationsGeoTileGridBucket.md | 6 ++-- .../api/AggregationsGeoTileGridBucketKeys.md | 2 +- .../api/AggregationsGeohexGridAggregation.md | 2 +- .../api/AggregationsGlobalAggregate.md | 6 ++-- .../api/AggregationsGlobalAggregateKeys.md | 2 +- .../api/AggregationsGlobalAggregation.md | 2 +- ...ationsGoogleNormalizedDistanceHeuristic.md | 2 +- docs/reference/api/AggregationsHdrMethod.md | 2 +- ...AggregationsHdrPercentileRanksAggregate.md | 2 +- .../AggregationsHdrPercentilesAggregate.md | 2 +- .../api/AggregationsHistogramAggregate.md | 2 +- .../api/AggregationsHistogramAggregation.md | 2 +- .../api/AggregationsHistogramBucket.md | 6 ++-- .../api/AggregationsHistogramBucketKeys.md | 2 +- .../AggregationsHoltLinearModelSettings.md | 2 +- ...ggregationsHoltMovingAverageAggregation.md | 2 +- .../AggregationsHoltWintersModelSettings.md | 2 +- ...ionsHoltWintersMovingAverageAggregation.md | 2 +- .../api/AggregationsHoltWintersType.md | 6 ++-- .../api/AggregationsInferenceAggregate.md | 6 ++-- .../api/AggregationsInferenceAggregateKeys.md | 2 +- .../api/AggregationsInferenceAggregation.md | 2 +- .../AggregationsInferenceClassImportance.md | 2 +- .../AggregationsInferenceConfigContainer.md | 2 +- .../AggregationsInferenceFeatureImportance.md | 2 +- .../api/AggregationsInferenceTopClassEntry.md | 2 +- .../api/AggregationsIpPrefixAggregate.md | 2 +- .../api/AggregationsIpPrefixAggregation.md | 2 +- .../api/AggregationsIpPrefixBucket.md | 6 ++-- .../api/AggregationsIpPrefixBucketKeys.md | 2 +- .../api/AggregationsIpRangeAggregate.md | 2 +- .../api/AggregationsIpRangeAggregation.md | 2 +- .../AggregationsIpRangeAggregationRange.md | 2 +- .../api/AggregationsIpRangeBucket.md | 6 ++-- .../api/AggregationsIpRangeBucketKeys.md | 2 +- .../api/AggregationsKeyedPercentiles.md | 6 ++-- ...regationsLinearMovingAverageAggregation.md | 2 +- .../api/AggregationsLongRareTermsAggregate.md | 2 +- .../api/AggregationsLongRareTermsBucket.md | 6 ++-- .../AggregationsLongRareTermsBucketKeys.md | 2 +- .../api/AggregationsLongTermsAggregate.md | 2 +- .../api/AggregationsLongTermsBucket.md | 6 ++-- .../api/AggregationsLongTermsBucketKeys.md | 2 +- .../api/AggregationsMatrixAggregation.md | 2 +- .../api/AggregationsMatrixStatsAggregate.md | 2 +- .../api/AggregationsMatrixStatsAggregation.md | 2 +- .../api/AggregationsMatrixStatsFields.md | 2 +- .../reference/api/AggregationsMaxAggregate.md | 2 +- .../api/AggregationsMaxAggregation.md | 2 +- .../api/AggregationsMaxBucketAggregation.md | 2 +- ...gationsMedianAbsoluteDeviationAggregate.md | 2 +- ...tionsMedianAbsoluteDeviationAggregation.md | 2 +- .../api/AggregationsMetricAggregationBase.md | 2 +- .../reference/api/AggregationsMinAggregate.md | 2 +- .../api/AggregationsMinAggregation.md | 2 +- .../api/AggregationsMinBucketAggregation.md | 2 +- .../api/AggregationsMinimumInterval.md | 6 ++-- docs/reference/api/AggregationsMissing.md | 6 ++-- .../api/AggregationsMissingAggregate.md | 6 ++-- .../api/AggregationsMissingAggregateKeys.md | 2 +- .../api/AggregationsMissingAggregation.md | 2 +- .../reference/api/AggregationsMissingOrder.md | 6 ++-- .../AggregationsMovingAverageAggregation.md | 6 ++-- ...ggregationsMovingAverageAggregationBase.md | 2 +- .../AggregationsMovingFunctionAggregation.md | 2 +- ...ggregationsMovingPercentilesAggregation.md | 2 +- .../AggregationsMultiBucketAggregateBase.md | 2 +- .../api/AggregationsMultiBucketBase.md | 2 +- .../api/AggregationsMultiTermLookup.md | 2 +- .../api/AggregationsMultiTermsAggregate.md | 2 +- .../api/AggregationsMultiTermsAggregation.md | 2 +- .../api/AggregationsMultiTermsBucket.md | 6 ++-- .../api/AggregationsMultiTermsBucketKeys.md | 2 +- .../AggregationsMutualInformationHeuristic.md | 2 +- .../api/AggregationsNestedAggregate.md | 6 ++-- .../api/AggregationsNestedAggregateKeys.md | 2 +- .../api/AggregationsNestedAggregation.md | 2 +- .../api/AggregationsNormalizeAggregation.md | 2 +- .../api/AggregationsNormalizeMethod.md | 6 ++-- .../api/AggregationsParentAggregate.md | 6 ++-- .../api/AggregationsParentAggregateKeys.md | 2 +- .../api/AggregationsParentAggregation.md | 2 +- .../AggregationsPercentageScoreHeuristic.md | 2 +- .../AggregationsPercentileRanksAggregation.md | 2 +- docs/reference/api/AggregationsPercentiles.md | 6 ++-- .../AggregationsPercentilesAggregateBase.md | 2 +- .../api/AggregationsPercentilesAggregation.md | 2 +- .../AggregationsPercentilesBucketAggregate.md | 2 +- ...ggregationsPercentilesBucketAggregation.md | 2 +- .../AggregationsPipelineAggregationBase.md | 2 +- .../AggregationsRandomSamplerAggregation.md | 2 +- .../api/AggregationsRangeAggregate.md | 2 +- .../api/AggregationsRangeAggregation.md | 2 +- docs/reference/api/AggregationsRangeBucket.md | 6 ++-- .../api/AggregationsRangeBucketKeys.md | 2 +- .../api/AggregationsRareTermsAggregation.md | 2 +- .../api/AggregationsRateAggregate.md | 2 +- .../api/AggregationsRateAggregation.md | 2 +- docs/reference/api/AggregationsRateMode.md | 6 ++-- .../api/AggregationsReverseNestedAggregate.md | 6 ++-- .../AggregationsReverseNestedAggregateKeys.md | 2 +- .../AggregationsReverseNestedAggregation.md | 2 +- .../api/AggregationsSamplerAggregate.md | 6 ++-- .../api/AggregationsSamplerAggregateKeys.md | 2 +- .../api/AggregationsSamplerAggregation.md | 2 +- ...egationsSamplerAggregationExecutionHint.md | 6 ++-- .../api/AggregationsScriptedHeuristic.md | 2 +- .../AggregationsScriptedMetricAggregate.md | 2 +- .../AggregationsScriptedMetricAggregation.md | 2 +- ...gregationsSerialDifferencingAggregation.md | 2 +- ...gregationsSignificantLongTermsAggregate.md | 2 +- .../AggregationsSignificantLongTermsBucket.md | 6 ++-- ...regationsSignificantLongTermsBucketKeys.md | 2 +- ...egationsSignificantStringTermsAggregate.md | 2 +- ...ggregationsSignificantStringTermsBucket.md | 6 ++-- ...gationsSignificantStringTermsBucketKeys.md | 2 +- ...gregationsSignificantTermsAggregateBase.md | 2 +- ...AggregationsSignificantTermsAggregation.md | 2 +- .../AggregationsSignificantTermsBucketBase.md | 2 +- .../AggregationsSignificantTextAggregation.md | 2 +- ...regationsSimpleMovingAverageAggregation.md | 2 +- .../api/AggregationsSimpleValueAggregate.md | 2 +- .../AggregationsSingleBucketAggregateBase.md | 2 +- .../AggregationsSingleMetricAggregateBase.md | 2 +- .../AggregationsStandardDeviationBounds.md | 2 +- ...egationsStandardDeviationBoundsAsString.md | 2 +- .../api/AggregationsStatsAggregate.md | 2 +- .../api/AggregationsStatsAggregation.md | 2 +- .../api/AggregationsStatsBucketAggregate.md | 2 +- .../api/AggregationsStatsBucketAggregation.md | 2 +- .../AggregationsStringRareTermsAggregate.md | 2 +- .../api/AggregationsStringRareTermsBucket.md | 6 ++-- .../AggregationsStringRareTermsBucketKeys.md | 2 +- .../api/AggregationsStringStatsAggregate.md | 2 +- .../api/AggregationsStringStatsAggregation.md | 2 +- .../api/AggregationsStringTermsAggregate.md | 2 +- .../api/AggregationsStringTermsBucket.md | 6 ++-- .../api/AggregationsStringTermsBucketKeys.md | 2 +- .../reference/api/AggregationsSumAggregate.md | 2 +- .../api/AggregationsSumAggregation.md | 2 +- .../api/AggregationsSumBucketAggregation.md | 2 +- docs/reference/api/AggregationsTDigest.md | 2 +- ...egationsTDigestPercentileRanksAggregate.md | 2 +- ...AggregationsTDigestPercentilesAggregate.md | 2 +- .../api/AggregationsTTestAggregate.md | 2 +- .../api/AggregationsTTestAggregation.md | 2 +- docs/reference/api/AggregationsTTestType.md | 6 ++-- .../api/AggregationsTermsAggregateBase.md | 2 +- .../api/AggregationsTermsAggregation.md | 2 +- ...AggregationsTermsAggregationCollectMode.md | 6 ++-- ...gregationsTermsAggregationExecutionHint.md | 6 ++-- .../api/AggregationsTermsBucketBase.md | 2 +- .../reference/api/AggregationsTermsExclude.md | 6 ++-- .../reference/api/AggregationsTermsInclude.md | 6 ++-- .../api/AggregationsTermsPartition.md | 2 +- .../api/AggregationsTestPopulation.md | 2 +- .../api/AggregationsTimeSeriesAggregate.md | 2 +- .../api/AggregationsTimeSeriesAggregation.md | 2 +- .../api/AggregationsTimeSeriesBucket.md | 6 ++-- .../api/AggregationsTimeSeriesBucketKeys.md | 2 +- .../api/AggregationsTopHitsAggregate.md | 2 +- .../api/AggregationsTopHitsAggregation.md | 2 +- docs/reference/api/AggregationsTopMetrics.md | 2 +- .../api/AggregationsTopMetricsAggregate.md | 2 +- .../api/AggregationsTopMetricsAggregation.md | 2 +- .../api/AggregationsTopMetricsValue.md | 2 +- .../AggregationsUnmappedRareTermsAggregate.md | 2 +- .../AggregationsUnmappedSamplerAggregate.md | 6 ++-- ...ggregationsUnmappedSamplerAggregateKeys.md | 2 +- ...ationsUnmappedSignificantTermsAggregate.md | 2 +- .../api/AggregationsUnmappedTermsAggregate.md | 2 +- .../api/AggregationsValueCountAggregate.md | 2 +- .../api/AggregationsValueCountAggregation.md | 2 +- docs/reference/api/AggregationsValueType.md | 6 ++-- ...egationsVariableWidthHistogramAggregate.md | 2 +- ...ationsVariableWidthHistogramAggregation.md | 2 +- ...ggregationsVariableWidthHistogramBucket.md | 6 ++-- ...gationsVariableWidthHistogramBucketKeys.md | 2 +- .../AggregationsWeightedAverageAggregation.md | 2 +- .../api/AggregationsWeightedAverageValue.md | 2 +- .../api/AggregationsWeightedAvgAggregate.md | 2 +- docs/reference/api/AnalysisAnalyzer.md | 6 ++-- .../api/AnalysisApostropheTokenFilter.md | 2 +- docs/reference/api/AnalysisArabicAnalyzer.md | 2 +- .../AnalysisArabicNormalizationTokenFilter.md | 2 +- .../reference/api/AnalysisArmenianAnalyzer.md | 2 +- .../api/AnalysisAsciiFoldingTokenFilter.md | 2 +- docs/reference/api/AnalysisBasqueAnalyzer.md | 2 +- docs/reference/api/AnalysisBengaliAnalyzer.md | 2 +- .../api/AnalysisBrazilianAnalyzer.md | 2 +- .../api/AnalysisBulgarianAnalyzer.md | 2 +- docs/reference/api/AnalysisCatalanAnalyzer.md | 2 +- docs/reference/api/AnalysisCharFilter.md | 6 ++-- docs/reference/api/AnalysisCharFilterBase.md | 2 +- .../api/AnalysisCharFilterDefinition.md | 6 ++-- .../api/AnalysisCharGroupTokenizer.md | 2 +- docs/reference/api/AnalysisChineseAnalyzer.md | 2 +- docs/reference/api/AnalysisCjkAnalyzer.md | 2 +- .../api/AnalysisCjkBigramIgnoredScript.md | 6 ++-- .../api/AnalysisCjkBigramTokenFilter.md | 2 +- .../api/AnalysisCjkWidthTokenFilter.md | 2 +- .../api/AnalysisClassicTokenFilter.md | 2 +- .../reference/api/AnalysisClassicTokenizer.md | 2 +- .../api/AnalysisCommonGramsTokenFilter.md | 2 +- .../AnalysisCompoundWordTokenFilterBase.md | 2 +- .../api/AnalysisConditionTokenFilter.md | 2 +- docs/reference/api/AnalysisCustomAnalyzer.md | 2 +- .../reference/api/AnalysisCustomNormalizer.md | 2 +- docs/reference/api/AnalysisCzechAnalyzer.md | 2 +- docs/reference/api/AnalysisDanishAnalyzer.md | 2 +- .../api/AnalysisDecimalDigitTokenFilter.md | 2 +- .../api/AnalysisDelimitedPayloadEncoding.md | 6 ++-- .../AnalysisDelimitedPayloadTokenFilter.md | 2 +- ...alysisDictionaryDecompounderTokenFilter.md | 2 +- docs/reference/api/AnalysisDutchAnalyzer.md | 2 +- docs/reference/api/AnalysisEdgeNGramSide.md | 6 ++-- .../api/AnalysisEdgeNGramTokenFilter.md | 2 +- .../api/AnalysisEdgeNGramTokenizer.md | 2 +- .../api/AnalysisElisionTokenFilter.md | 2 +- docs/reference/api/AnalysisEnglishAnalyzer.md | 2 +- .../reference/api/AnalysisEstonianAnalyzer.md | 2 +- .../api/AnalysisFingerprintAnalyzer.md | 2 +- .../api/AnalysisFingerprintTokenFilter.md | 2 +- docs/reference/api/AnalysisFinnishAnalyzer.md | 2 +- .../api/AnalysisFlattenGraphTokenFilter.md | 2 +- docs/reference/api/AnalysisFrenchAnalyzer.md | 2 +- .../reference/api/AnalysisGalicianAnalyzer.md | 2 +- docs/reference/api/AnalysisGermanAnalyzer.md | 2 +- .../AnalysisGermanNormalizationTokenFilter.md | 2 +- docs/reference/api/AnalysisGreekAnalyzer.md | 2 +- docs/reference/api/AnalysisHindiAnalyzer.md | 2 +- .../AnalysisHindiNormalizationTokenFilter.md | 2 +- .../api/AnalysisHtmlStripCharFilter.md | 2 +- .../api/AnalysisHungarianAnalyzer.md | 2 +- .../api/AnalysisHunspellTokenFilter.md | 2 +- ...lysisHyphenationDecompounderTokenFilter.md | 2 +- docs/reference/api/AnalysisIcuAnalyzer.md | 2 +- .../api/AnalysisIcuCollationAlternate.md | 6 ++-- .../api/AnalysisIcuCollationCaseFirst.md | 6 ++-- .../api/AnalysisIcuCollationDecomposition.md | 6 ++-- .../api/AnalysisIcuCollationStrength.md | 6 ++-- .../api/AnalysisIcuCollationTokenFilter.md | 2 +- .../api/AnalysisIcuFoldingTokenFilter.md | 2 +- .../api/AnalysisIcuNormalizationCharFilter.md | 2 +- .../api/AnalysisIcuNormalizationMode.md | 6 ++-- .../AnalysisIcuNormalizationTokenFilter.md | 2 +- .../api/AnalysisIcuNormalizationType.md | 6 ++-- docs/reference/api/AnalysisIcuTokenizer.md | 2 +- .../api/AnalysisIcuTransformDirection.md | 6 ++-- .../api/AnalysisIcuTransformTokenFilter.md | 2 +- .../AnalysisIndicNormalizationTokenFilter.md | 2 +- .../api/AnalysisIndonesianAnalyzer.md | 2 +- docs/reference/api/AnalysisIrishAnalyzer.md | 2 +- docs/reference/api/AnalysisItalianAnalyzer.md | 2 +- .../api/AnalysisJaStopTokenFilter.md | 2 +- .../reference/api/AnalysisKStemTokenFilter.md | 2 +- docs/reference/api/AnalysisKeepTypesMode.md | 6 ++-- .../api/AnalysisKeepTypesTokenFilter.md | 2 +- .../api/AnalysisKeepWordsTokenFilter.md | 2 +- docs/reference/api/AnalysisKeywordAnalyzer.md | 2 +- .../api/AnalysisKeywordMarkerTokenFilter.md | 2 +- .../api/AnalysisKeywordRepeatTokenFilter.md | 2 +- .../reference/api/AnalysisKeywordTokenizer.md | 2 +- .../reference/api/AnalysisKuromojiAnalyzer.md | 2 +- ...AnalysisKuromojiIterationMarkCharFilter.md | 2 +- ...AnalysisKuromojiPartOfSpeechTokenFilter.md | 2 +- .../AnalysisKuromojiReadingFormTokenFilter.md | 2 +- .../api/AnalysisKuromojiStemmerTokenFilter.md | 2 +- .../api/AnalysisKuromojiTokenizationMode.md | 6 ++-- .../api/AnalysisKuromojiTokenizer.md | 2 +- docs/reference/api/AnalysisLatvianAnalyzer.md | 2 +- .../api/AnalysisLengthTokenFilter.md | 2 +- docs/reference/api/AnalysisLetterTokenizer.md | 2 +- .../api/AnalysisLimitTokenCountTokenFilter.md | 2 +- .../api/AnalysisLithuanianAnalyzer.md | 2 +- .../api/AnalysisLowercaseNormalizer.md | 2 +- .../api/AnalysisLowercaseTokenFilter.md | 2 +- .../AnalysisLowercaseTokenFilterLanguages.md | 6 ++-- .../api/AnalysisLowercaseTokenizer.md | 2 +- .../api/AnalysisMappingCharFilter.md | 2 +- .../api/AnalysisMinHashTokenFilter.md | 2 +- .../api/AnalysisMultiplexerTokenFilter.md | 2 +- .../reference/api/AnalysisNGramTokenFilter.md | 2 +- docs/reference/api/AnalysisNGramTokenizer.md | 2 +- docs/reference/api/AnalysisNoriAnalyzer.md | 2 +- .../api/AnalysisNoriDecompoundMode.md | 6 ++-- .../AnalysisNoriPartOfSpeechTokenFilter.md | 2 +- docs/reference/api/AnalysisNoriTokenizer.md | 2 +- docs/reference/api/AnalysisNormalizer.md | 6 ++-- .../api/AnalysisNorwegianAnalyzer.md | 2 +- .../api/AnalysisPathHierarchyTokenizer.md | 2 +- docs/reference/api/AnalysisPatternAnalyzer.md | 2 +- .../api/AnalysisPatternCaptureTokenFilter.md | 2 +- .../api/AnalysisPatternReplaceCharFilter.md | 2 +- .../api/AnalysisPatternReplaceTokenFilter.md | 2 +- .../reference/api/AnalysisPatternTokenizer.md | 2 +- docs/reference/api/AnalysisPersianAnalyzer.md | 2 +- ...AnalysisPersianNormalizationTokenFilter.md | 2 +- docs/reference/api/AnalysisPhoneticEncoder.md | 6 ++-- .../reference/api/AnalysisPhoneticLanguage.md | 6 ++-- .../reference/api/AnalysisPhoneticNameType.md | 6 ++-- .../reference/api/AnalysisPhoneticRuleType.md | 6 ++-- .../api/AnalysisPhoneticTokenFilter.md | 2 +- .../api/AnalysisPorterStemTokenFilter.md | 2 +- .../api/AnalysisPortugueseAnalyzer.md | 2 +- .../api/AnalysisPredicateTokenFilter.md | 2 +- .../AnalysisRemoveDuplicatesTokenFilter.md | 2 +- .../api/AnalysisReverseTokenFilter.md | 2 +- .../reference/api/AnalysisRomanianAnalyzer.md | 2 +- docs/reference/api/AnalysisRussianAnalyzer.md | 2 +- .../AnalysisScandinavianFoldingTokenFilter.md | 2 +- ...sisScandinavianNormalizationTokenFilter.md | 2 +- docs/reference/api/AnalysisSerbianAnalyzer.md | 2 +- ...AnalysisSerbianNormalizationTokenFilter.md | 2 +- .../api/AnalysisShingleTokenFilter.md | 2 +- docs/reference/api/AnalysisSimpleAnalyzer.md | 2 +- .../AnalysisSimplePatternSplitTokenizer.md | 2 +- .../api/AnalysisSimplePatternTokenizer.md | 2 +- .../reference/api/AnalysisSnowballAnalyzer.md | 2 +- .../reference/api/AnalysisSnowballLanguage.md | 6 ++-- .../api/AnalysisSnowballTokenFilter.md | 2 +- docs/reference/api/AnalysisSoraniAnalyzer.md | 2 +- .../AnalysisSoraniNormalizationTokenFilter.md | 2 +- docs/reference/api/AnalysisSpanishAnalyzer.md | 2 +- .../reference/api/AnalysisStandardAnalyzer.md | 2 +- .../api/AnalysisStandardTokenizer.md | 2 +- .../api/AnalysisStemmerOverrideTokenFilter.md | 2 +- .../api/AnalysisStemmerTokenFilter.md | 2 +- docs/reference/api/AnalysisStopAnalyzer.md | 2 +- docs/reference/api/AnalysisStopTokenFilter.md | 2 +- .../reference/api/AnalysisStopWordLanguage.md | 6 ++-- docs/reference/api/AnalysisStopWords.md | 6 ++-- docs/reference/api/AnalysisSwedishAnalyzer.md | 2 +- docs/reference/api/AnalysisSynonymFormat.md | 6 ++-- .../api/AnalysisSynonymGraphTokenFilter.md | 2 +- .../api/AnalysisSynonymTokenFilter.md | 2 +- .../api/AnalysisSynonymTokenFilterBase.md | 2 +- docs/reference/api/AnalysisThaiAnalyzer.md | 2 +- docs/reference/api/AnalysisThaiTokenizer.md | 2 +- docs/reference/api/AnalysisTokenChar.md | 6 ++-- docs/reference/api/AnalysisTokenFilter.md | 6 ++-- docs/reference/api/AnalysisTokenFilterBase.md | 2 +- .../api/AnalysisTokenFilterDefinition.md | 6 ++-- docs/reference/api/AnalysisTokenizer.md | 6 ++-- docs/reference/api/AnalysisTokenizerBase.md | 2 +- .../api/AnalysisTokenizerDefinition.md | 6 ++-- docs/reference/api/AnalysisTrimTokenFilter.md | 2 +- .../api/AnalysisTruncateTokenFilter.md | 2 +- docs/reference/api/AnalysisTurkishAnalyzer.md | 2 +- .../api/AnalysisUaxEmailUrlTokenizer.md | 2 +- .../api/AnalysisUniqueTokenFilter.md | 2 +- .../api/AnalysisUppercaseTokenFilter.md | 2 +- .../api/AnalysisWhitespaceAnalyzer.md | 2 +- .../api/AnalysisWhitespaceTokenizer.md | 2 +- .../AnalysisWordDelimiterGraphTokenFilter.md | 2 +- .../api/AnalysisWordDelimiterTokenFilter.md | 2 +- .../AnalysisWordDelimiterTokenFilterBase.md | 2 +- docs/reference/api/AsyncSearch.md | 12 ++++---- docs/reference/api/AsyncSearchAsyncSearch.md | 2 +- ...ncSearchAsyncSearchDocumentResponseBase.md | 2 +- .../api/AsyncSearchAsyncSearchResponseBase.md | 2 +- .../reference/api/AsyncSearchDeleteRequest.md | 2 +- .../api/AsyncSearchDeleteResponse.md | 6 ++-- docs/reference/api/AsyncSearchGetRequest.md | 2 +- docs/reference/api/AsyncSearchGetResponse.md | 6 ++-- .../reference/api/AsyncSearchStatusRequest.md | 2 +- .../api/AsyncSearchStatusResponse.md | 6 ++-- .../AsyncSearchStatusStatusResponseBase.md | 2 +- .../reference/api/AsyncSearchSubmitRequest.md | 2 +- .../api/AsyncSearchSubmitResponse.md | 6 ++-- docs/reference/api/Autoscaling.md | 12 ++++---- .../api/AutoscalingAutoscalingPolicy.md | 2 +- ...toscalingDeleteAutoscalingPolicyRequest.md | 2 +- ...oscalingDeleteAutoscalingPolicyResponse.md | 6 ++-- ...tAutoscalingCapacityAutoscalingCapacity.md | 2 +- ...etAutoscalingCapacityAutoscalingDecider.md | 2 +- ...tAutoscalingCapacityAutoscalingDeciders.md | 2 +- ...ngGetAutoscalingCapacityAutoscalingNode.md | 2 +- ...AutoscalingCapacityAutoscalingResources.md | 2 +- ...utoscalingGetAutoscalingCapacityRequest.md | 2 +- ...toscalingGetAutoscalingCapacityResponse.md | 2 +- .../AutoscalingGetAutoscalingPolicyRequest.md | 2 +- ...AutoscalingGetAutoscalingPolicyResponse.md | 6 ++-- .../AutoscalingPutAutoscalingPolicyRequest.md | 2 +- ...AutoscalingPutAutoscalingPolicyResponse.md | 6 ++-- docs/reference/api/BulkApi_1.md | 4 +-- docs/reference/api/BulkApi_2.md | 4 +-- docs/reference/api/BulkApi_3.md | 4 +-- docs/reference/api/BulkCreateOperation.md | 2 +- docs/reference/api/BulkDeleteOperation.md | 2 +- docs/reference/api/BulkFailureStoreStatus.md | 6 ++-- docs/reference/api/BulkHelper.md | 2 +- docs/reference/api/BulkHelperOptions.md | 2 +- .../reference/api/BulkIndexByScrollFailure.md | 2 +- docs/reference/api/BulkIndexOperation.md | 2 +- docs/reference/api/BulkOperationBase.md | 2 +- docs/reference/api/BulkOperationContainer.md | 2 +- docs/reference/api/BulkOperationType.md | 6 ++-- docs/reference/api/BulkRequest.md | 2 +- docs/reference/api/BulkResponse.md | 2 +- docs/reference/api/BulkResponseItem.md | 2 +- docs/reference/api/BulkStats.md | 2 +- docs/reference/api/BulkUpdateAction.md | 2 +- docs/reference/api/BulkUpdateOperation.md | 2 +- docs/reference/api/BulkWriteOperation.md | 2 +- docs/reference/api/ByteSize.md | 6 ++-- docs/reference/api/Bytes.md | 6 ++-- docs/reference/api/CapabilitiesApi_1.md | 4 +-- docs/reference/api/CapabilitiesApi_2.md | 4 +-- docs/reference/api/CapabilitiesApi_3.md | 4 +-- docs/reference/api/Cat.md | 12 ++++---- docs/reference/api/CatAliasesAliasesRecord.md | 2 +- docs/reference/api/CatAliasesRequest.md | 2 +- docs/reference/api/CatAliasesResponse.md | 6 ++-- .../api/CatAllocationAllocationRecord.md | 2 +- docs/reference/api/CatAllocationRequest.md | 2 +- docs/reference/api/CatAllocationResponse.md | 6 ++-- .../api/CatCatAnomalyDetectorColumn.md | 6 ++-- .../api/CatCatAnonalyDetectorColumns.md | 6 ++-- docs/reference/api/CatCatDatafeedColumn.md | 6 ++-- docs/reference/api/CatCatDatafeedColumns.md | 6 ++-- docs/reference/api/CatCatDfaColumn.md | 6 ++-- docs/reference/api/CatCatDfaColumns.md | 6 ++-- docs/reference/api/CatCatNodeColumn.md | 6 ++-- docs/reference/api/CatCatNodeColumns.md | 6 ++-- docs/reference/api/CatCatRequestBase.md | 2 +- .../api/CatCatTrainedModelsColumn.md | 6 ++-- .../api/CatCatTrainedModelsColumns.md | 6 ++-- docs/reference/api/CatCatTransformColumn.md | 6 ++-- docs/reference/api/CatCatTransformColumns.md | 6 ++-- .../CatComponentTemplatesComponentTemplate.md | 2 +- .../api/CatComponentTemplatesRequest.md | 2 +- .../api/CatComponentTemplatesResponse.md | 6 ++-- docs/reference/api/CatCountCountRecord.md | 2 +- docs/reference/api/CatCountRequest.md | 2 +- docs/reference/api/CatCountResponse.md | 6 ++-- .../api/CatFielddataFielddataRecord.md | 2 +- docs/reference/api/CatFielddataRequest.md | 2 +- docs/reference/api/CatFielddataResponse.md | 6 ++-- docs/reference/api/CatHealthHealthRecord.md | 2 +- docs/reference/api/CatHealthRequest.md | 2 +- docs/reference/api/CatHealthResponse.md | 6 ++-- docs/reference/api/CatHelpRequest.md | 2 +- docs/reference/api/CatHelpResponse.md | 2 +- docs/reference/api/CatIndicesIndicesRecord.md | 2 +- docs/reference/api/CatIndicesRequest.md | 2 +- docs/reference/api/CatIndicesResponse.md | 6 ++-- docs/reference/api/CatMasterMasterRecord.md | 2 +- docs/reference/api/CatMasterRequest.md | 2 +- docs/reference/api/CatMasterResponse.md | 6 ++-- ...aFrameAnalyticsDataFrameAnalyticsRecord.md | 2 +- .../api/CatMlDataFrameAnalyticsRequest.md | 2 +- .../api/CatMlDataFrameAnalyticsResponse.md | 6 ++-- .../api/CatMlDatafeedsDatafeedsRecord.md | 2 +- docs/reference/api/CatMlDatafeedsRequest.md | 2 +- docs/reference/api/CatMlDatafeedsResponse.md | 6 ++-- docs/reference/api/CatMlJobsJobsRecord.md | 2 +- docs/reference/api/CatMlJobsRequest.md | 2 +- docs/reference/api/CatMlJobsResponse.md | 6 ++-- .../api/CatMlTrainedModelsRequest.md | 2 +- .../api/CatMlTrainedModelsResponse.md | 6 ++-- .../CatMlTrainedModelsTrainedModelsRecord.md | 2 +- .../api/CatNodeattrsNodeAttributesRecord.md | 2 +- docs/reference/api/CatNodeattrsRequest.md | 2 +- docs/reference/api/CatNodeattrsResponse.md | 6 ++-- docs/reference/api/CatNodesNodesRecord.md | 2 +- docs/reference/api/CatNodesRequest.md | 2 +- docs/reference/api/CatNodesResponse.md | 6 ++-- .../api/CatPendingTasksPendingTasksRecord.md | 2 +- docs/reference/api/CatPendingTasksRequest.md | 2 +- docs/reference/api/CatPendingTasksResponse.md | 6 ++-- docs/reference/api/CatPluginsPluginsRecord.md | 2 +- docs/reference/api/CatPluginsRequest.md | 2 +- docs/reference/api/CatPluginsResponse.md | 6 ++-- .../api/CatRecoveryRecoveryRecord.md | 2 +- docs/reference/api/CatRecoveryRequest.md | 2 +- docs/reference/api/CatRecoveryResponse.md | 6 ++-- .../api/CatRepositoriesRepositoriesRecord.md | 2 +- docs/reference/api/CatRepositoriesRequest.md | 2 +- docs/reference/api/CatRepositoriesResponse.md | 6 ++-- docs/reference/api/CatSegmentsRequest.md | 2 +- docs/reference/api/CatSegmentsResponse.md | 6 ++-- .../api/CatSegmentsSegmentsRecord.md | 2 +- docs/reference/api/CatShardsRequest.md | 2 +- docs/reference/api/CatShardsResponse.md | 6 ++-- docs/reference/api/CatShardsShardsRecord.md | 2 +- docs/reference/api/CatSnapshotsRequest.md | 2 +- docs/reference/api/CatSnapshotsResponse.md | 6 ++-- .../api/CatSnapshotsSnapshotsRecord.md | 2 +- docs/reference/api/CatTasksRequest.md | 2 +- docs/reference/api/CatTasksResponse.md | 6 ++-- docs/reference/api/CatTasksTasksRecord.md | 2 +- docs/reference/api/CatTemplatesRequest.md | 2 +- docs/reference/api/CatTemplatesResponse.md | 6 ++-- .../api/CatTemplatesTemplatesRecord.md | 2 +- docs/reference/api/CatThreadPoolRequest.md | 2 +- docs/reference/api/CatThreadPoolResponse.md | 6 ++-- .../api/CatThreadPoolThreadPoolRecord.md | 2 +- docs/reference/api/CatTransformsRequest.md | 2 +- docs/reference/api/CatTransformsResponse.md | 6 ++-- .../api/CatTransformsTransformsRecord.md | 2 +- docs/reference/api/CategoryId.md | 6 ++-- docs/reference/api/Ccr.md | 12 ++++---- .../api/CcrDeleteAutoFollowPatternRequest.md | 2 +- .../api/CcrDeleteAutoFollowPatternResponse.md | 6 ++-- docs/reference/api/CcrFollowIndexStats.md | 2 +- .../api/CcrFollowInfoFollowerIndex.md | 2 +- .../CcrFollowInfoFollowerIndexParameters.md | 2 +- .../api/CcrFollowInfoFollowerIndexStatus.md | 6 ++-- docs/reference/api/CcrFollowInfoRequest.md | 2 +- docs/reference/api/CcrFollowInfoResponse.md | 2 +- docs/reference/api/CcrFollowRequest.md | 2 +- docs/reference/api/CcrFollowResponse.md | 2 +- docs/reference/api/CcrFollowStatsRequest.md | 2 +- docs/reference/api/CcrFollowStatsResponse.md | 2 +- .../reference/api/CcrForgetFollowerRequest.md | 2 +- .../api/CcrForgetFollowerResponse.md | 2 +- ...crGetAutoFollowPatternAutoFollowPattern.md | 2 +- ...toFollowPatternAutoFollowPatternSummary.md | 2 +- .../api/CcrGetAutoFollowPatternRequest.md | 2 +- .../api/CcrGetAutoFollowPatternResponse.md | 2 +- .../api/CcrPauseAutoFollowPatternRequest.md | 2 +- .../api/CcrPauseAutoFollowPatternResponse.md | 6 ++-- docs/reference/api/CcrPauseFollowRequest.md | 2 +- docs/reference/api/CcrPauseFollowResponse.md | 6 ++-- .../api/CcrPutAutoFollowPatternRequest.md | 2 +- .../api/CcrPutAutoFollowPatternResponse.md | 6 ++-- docs/reference/api/CcrReadException.md | 2 +- .../api/CcrResumeAutoFollowPatternRequest.md | 2 +- .../api/CcrResumeAutoFollowPatternResponse.md | 6 ++-- docs/reference/api/CcrResumeFollowRequest.md | 2 +- docs/reference/api/CcrResumeFollowResponse.md | 6 ++-- docs/reference/api/CcrShardStats.md | 2 +- docs/reference/api/CcrStatsAutoFollowStats.md | 2 +- .../api/CcrStatsAutoFollowedCluster.md | 2 +- docs/reference/api/CcrStatsFollowStats.md | 2 +- docs/reference/api/CcrStatsRequest.md | 2 +- docs/reference/api/CcrStatsResponse.md | 2 +- docs/reference/api/CcrUnfollowRequest.md | 2 +- docs/reference/api/CcrUnfollowResponse.md | 6 ++-- docs/reference/api/ClearScrollApi_1.md | 4 +-- docs/reference/api/ClearScrollApi_2.md | 4 +-- docs/reference/api/ClearScrollApi_3.md | 4 +-- docs/reference/api/ClearScrollRequest.md | 2 +- docs/reference/api/ClearScrollResponse.md | 2 +- docs/reference/api/Client.md | 12 ++++---- docs/reference/api/ClientOptions.md | 2 +- docs/reference/api/ClosePointInTimeApi_1.md | 4 +-- docs/reference/api/ClosePointInTimeApi_2.md | 4 +-- docs/reference/api/ClosePointInTimeApi_3.md | 4 +-- docs/reference/api/ClosePointInTimeRequest.md | 2 +- .../reference/api/ClosePointInTimeResponse.md | 2 +- docs/reference/api/Cluster.md | 12 ++++---- docs/reference/api/ClusterAlias.md | 6 ++-- ...sterAllocationExplainAllocationDecision.md | 2 +- ...ocationExplainAllocationExplainDecision.md | 6 ++-- ...ClusterAllocationExplainAllocationStore.md | 2 +- .../ClusterAllocationExplainClusterInfo.md | 2 +- .../ClusterAllocationExplainCurrentNode.md | 2 +- .../api/ClusterAllocationExplainDecision.md | 6 ++-- .../api/ClusterAllocationExplainDiskUsage.md | 2 +- ...ocationExplainNodeAllocationExplanation.md | 2 +- .../ClusterAllocationExplainNodeDiskUsage.md | 2 +- .../api/ClusterAllocationExplainRequest.md | 2 +- .../ClusterAllocationExplainReservedSize.md | 2 +- .../api/ClusterAllocationExplainResponse.md | 2 +- ...rAllocationExplainUnassignedInformation.md | 2 +- ...ationExplainUnassignedInformationReason.md | 6 ++-- .../reference/api/ClusterComponentTemplate.md | 2 +- .../api/ClusterComponentTemplateNode.md | 2 +- .../api/ClusterComponentTemplateSummary.md | 2 +- .../ClusterDeleteComponentTemplateRequest.md | 2 +- .../ClusterDeleteComponentTemplateResponse.md | 6 ++-- ...sterDeleteVotingConfigExclusionsRequest.md | 2 +- ...terDeleteVotingConfigExclusionsResponse.md | 6 ++-- docs/reference/api/ClusterDetails.md | 2 +- .../ClusterExistsComponentTemplateRequest.md | 2 +- .../ClusterExistsComponentTemplateResponse.md | 6 ++-- .../api/ClusterGetComponentTemplateRequest.md | 2 +- .../ClusterGetComponentTemplateResponse.md | 2 +- .../api/ClusterGetSettingsRequest.md | 2 +- .../api/ClusterGetSettingsResponse.md | 2 +- .../api/ClusterHealthHealthResponseBody.md | 2 +- .../api/ClusterHealthIndexHealthStats.md | 2 +- docs/reference/api/ClusterHealthRequest.md | 2 +- docs/reference/api/ClusterHealthResponse.md | 6 ++-- .../api/ClusterHealthShardHealthStats.md | 2 +- .../api/ClusterHealthWaitForNodes.md | 6 ++-- docs/reference/api/ClusterInfoRequest.md | 2 +- docs/reference/api/ClusterInfoResponse.md | 2 +- docs/reference/api/ClusterInfoTarget.md | 6 ++-- docs/reference/api/ClusterInfoTargets.md | 6 ++-- .../api/ClusterPendingTasksPendingTask.md | 2 +- .../api/ClusterPendingTasksRequest.md | 2 +- .../api/ClusterPendingTasksResponse.md | 2 +- ...lusterPostVotingConfigExclusionsRequest.md | 2 +- ...usterPostVotingConfigExclusionsResponse.md | 6 ++-- .../api/ClusterPutComponentTemplateRequest.md | 2 +- .../ClusterPutComponentTemplateResponse.md | 6 ++-- .../api/ClusterPutSettingsRequest.md | 2 +- .../api/ClusterPutSettingsResponse.md | 2 +- .../api/ClusterRemoteInfoClusterRemoteInfo.md | 6 ++-- ...ClusterRemoteInfoClusterRemoteProxyInfo.md | 2 +- ...ClusterRemoteInfoClusterRemoteSniffInfo.md | 2 +- .../reference/api/ClusterRemoteInfoRequest.md | 2 +- .../api/ClusterRemoteInfoResponse.md | 6 ++-- docs/reference/api/ClusterRerouteCommand.md | 2 +- ...sterRerouteCommandAllocatePrimaryAction.md | 2 +- ...sterRerouteCommandAllocateReplicaAction.md | 2 +- .../api/ClusterRerouteCommandCancelAction.md | 2 +- .../api/ClusterRerouteCommandMoveAction.md | 2 +- docs/reference/api/ClusterRerouteRequest.md | 2 +- .../api/ClusterRerouteRerouteDecision.md | 2 +- .../api/ClusterRerouteRerouteExplanation.md | 2 +- .../api/ClusterRerouteRerouteParameters.md | 2 +- docs/reference/api/ClusterRerouteResponse.md | 2 +- docs/reference/api/ClusterSearchStatus.md | 6 ++-- docs/reference/api/ClusterStateRequest.md | 2 +- docs/reference/api/ClusterStateResponse.md | 6 ++-- docs/reference/api/ClusterStatistics.md | 2 +- docs/reference/api/ClusterStatsCCSStats.md | 2 +- .../api/ClusterStatsCCSUsageClusterStats.md | 2 +- .../api/ClusterStatsCCSUsageStats.md | 2 +- .../api/ClusterStatsCCSUsageTimeValue.md | 2 +- .../api/ClusterStatsCharFilterTypes.md | 2 +- .../api/ClusterStatsClusterFileSystem.md | 2 +- .../api/ClusterStatsClusterIndices.md | 2 +- .../api/ClusterStatsClusterIndicesShards.md | 2 +- .../ClusterStatsClusterIndicesShardsIndex.md | 2 +- .../api/ClusterStatsClusterIngest.md | 2 +- docs/reference/api/ClusterStatsClusterJvm.md | 2 +- .../api/ClusterStatsClusterJvmMemory.md | 2 +- .../api/ClusterStatsClusterJvmVersion.md | 2 +- .../api/ClusterStatsClusterNetworkTypes.md | 2 +- .../api/ClusterStatsClusterNodeCount.md | 2 +- .../reference/api/ClusterStatsClusterNodes.md | 2 +- .../api/ClusterStatsClusterOperatingSystem.md | 2 +- ...StatsClusterOperatingSystemArchitecture.md | 2 +- .../ClusterStatsClusterOperatingSystemName.md | 2 +- ...erStatsClusterOperatingSystemPrettyName.md | 2 +- .../api/ClusterStatsClusterProcess.md | 2 +- .../api/ClusterStatsClusterProcessCpu.md | 2 +- ...rStatsClusterProcessOpenFileDescriptors.md | 2 +- .../api/ClusterStatsClusterProcessor.md | 2 +- .../api/ClusterStatsClusterShardMetrics.md | 2 +- docs/reference/api/ClusterStatsFieldTypes.md | 2 +- .../api/ClusterStatsFieldTypesMappings.md | 2 +- .../api/ClusterStatsIndexingPressure.md | 2 +- .../api/ClusterStatsIndexingPressureMemory.md | 2 +- ...usterStatsIndexingPressureMemorySummary.md | 2 +- .../api/ClusterStatsIndicesVersions.md | 2 +- .../api/ClusterStatsNodePackagingType.md | 2 +- .../ClusterStatsOperatingSystemMemoryInfo.md | 2 +- .../api/ClusterStatsRemoteClusterInfo.md | 2 +- docs/reference/api/ClusterStatsRequest.md | 2 +- docs/reference/api/ClusterStatsResponse.md | 6 ++-- .../api/ClusterStatsRuntimeFieldTypes.md | 2 +- .../api/ClusterStatsStatsResponseBase.md | 2 +- docs/reference/api/CompletionStats.md | 2 +- docs/reference/api/Conflicts.md | 6 ++-- docs/reference/api/Connector.md | 12 ++++---- docs/reference/api/ConnectorCheckInRequest.md | 2 +- .../reference/api/ConnectorCheckInResponse.md | 2 +- docs/reference/api/ConnectorConnector.md | 2 +- .../api/ConnectorConnectorConfigProperties.md | 2 +- .../api/ConnectorConnectorConfiguration.md | 6 ++-- .../api/ConnectorConnectorCustomScheduling.md | 6 ++-- .../api/ConnectorConnectorFeatures.md | 2 +- .../api/ConnectorConnectorFieldType.md | 6 ++-- .../api/ConnectorConnectorScheduling.md | 2 +- .../reference/api/ConnectorConnectorStatus.md | 6 ++-- .../api/ConnectorConnectorSyncJob.md | 2 +- .../api/ConnectorCustomScheduling.md | 2 +- ...rCustomSchedulingConfigurationOverrides.md | 2 +- docs/reference/api/ConnectorDeleteRequest.md | 2 +- docs/reference/api/ConnectorDeleteResponse.md | 6 ++-- docs/reference/api/ConnectorDependency.md | 2 +- docs/reference/api/ConnectorDisplayType.md | 6 ++-- docs/reference/api/ConnectorFeatureEnabled.md | 2 +- .../api/ConnectorFilteringAdvancedSnippet.md | 2 +- .../reference/api/ConnectorFilteringConfig.md | 2 +- .../reference/api/ConnectorFilteringPolicy.md | 6 ++-- docs/reference/api/ConnectorFilteringRule.md | 2 +- .../api/ConnectorFilteringRuleRule.md | 6 ++-- docs/reference/api/ConnectorFilteringRules.md | 2 +- .../api/ConnectorFilteringRulesValidation.md | 2 +- .../api/ConnectorFilteringValidation.md | 2 +- .../api/ConnectorFilteringValidationState.md | 6 ++-- docs/reference/api/ConnectorGetRequest.md | 2 +- docs/reference/api/ConnectorGetResponse.md | 6 ++-- .../api/ConnectorGreaterThanValidation.md | 2 +- .../api/ConnectorIncludedInValidation.md | 2 +- .../api/ConnectorIngestPipelineParams.md | 2 +- .../reference/api/ConnectorLastSyncRequest.md | 2 +- .../api/ConnectorLastSyncResponse.md | 2 +- .../api/ConnectorLessThanValidation.md | 2 +- docs/reference/api/ConnectorListRequest.md | 2 +- docs/reference/api/ConnectorListResponse.md | 2 +- .../api/ConnectorListTypeValidation.md | 2 +- docs/reference/api/ConnectorPostRequest.md | 2 +- docs/reference/api/ConnectorPostResponse.md | 2 +- docs/reference/api/ConnectorPutRequest.md | 2 +- docs/reference/api/ConnectorPutResponse.md | 2 +- .../reference/api/ConnectorRegexValidation.md | 2 +- .../api/ConnectorSchedulingConfiguration.md | 2 +- docs/reference/api/ConnectorSelectOption.md | 2 +- .../api/ConnectorSyncJobCancelRequest.md | 2 +- .../api/ConnectorSyncJobCancelResponse.md | 2 +- .../api/ConnectorSyncJobCheckInRequest.md | 2 +- .../api/ConnectorSyncJobCheckInResponse.md | 2 +- .../api/ConnectorSyncJobClaimRequest.md | 2 +- .../api/ConnectorSyncJobClaimResponse.md | 2 +- .../api/ConnectorSyncJobConnectorReference.md | 2 +- .../api/ConnectorSyncJobDeleteRequest.md | 2 +- .../api/ConnectorSyncJobDeleteResponse.md | 6 ++-- .../api/ConnectorSyncJobErrorRequest.md | 2 +- .../api/ConnectorSyncJobErrorResponse.md | 2 +- .../api/ConnectorSyncJobGetRequest.md | 2 +- .../api/ConnectorSyncJobGetResponse.md | 6 ++-- .../api/ConnectorSyncJobListRequest.md | 2 +- .../api/ConnectorSyncJobListResponse.md | 2 +- .../api/ConnectorSyncJobPostRequest.md | 2 +- .../api/ConnectorSyncJobPostResponse.md | 2 +- .../api/ConnectorSyncJobTriggerMethod.md | 6 ++-- docs/reference/api/ConnectorSyncJobType.md | 6 ++-- .../api/ConnectorSyncJobUpdateStatsRequest.md | 2 +- .../ConnectorSyncJobUpdateStatsResponse.md | 2 +- .../api/ConnectorSyncRulesFeature.md | 2 +- docs/reference/api/ConnectorSyncStatus.md | 6 ++-- .../ConnectorUpdateActiveFilteringRequest.md | 2 +- .../ConnectorUpdateActiveFilteringResponse.md | 2 +- .../api/ConnectorUpdateApiKeyIdRequest.md | 2 +- .../api/ConnectorUpdateApiKeyIdResponse.md | 2 +- .../ConnectorUpdateConfigurationRequest.md | 2 +- .../ConnectorUpdateConfigurationResponse.md | 2 +- .../api/ConnectorUpdateErrorRequest.md | 2 +- .../api/ConnectorUpdateErrorResponse.md | 2 +- .../api/ConnectorUpdateFeaturesRequest.md | 2 +- .../api/ConnectorUpdateFeaturesResponse.md | 2 +- .../api/ConnectorUpdateFilteringRequest.md | 2 +- .../api/ConnectorUpdateFilteringResponse.md | 2 +- ...nnectorUpdateFilteringValidationRequest.md | 2 +- ...nectorUpdateFilteringValidationResponse.md | 2 +- .../api/ConnectorUpdateIndexNameRequest.md | 2 +- .../api/ConnectorUpdateIndexNameResponse.md | 2 +- .../api/ConnectorUpdateNameRequest.md | 2 +- .../api/ConnectorUpdateNameResponse.md | 2 +- .../api/ConnectorUpdateNativeRequest.md | 2 +- .../api/ConnectorUpdateNativeResponse.md | 2 +- .../api/ConnectorUpdatePipelineRequest.md | 2 +- .../api/ConnectorUpdatePipelineResponse.md | 2 +- .../api/ConnectorUpdateSchedulingRequest.md | 2 +- .../api/ConnectorUpdateSchedulingResponse.md | 2 +- .../api/ConnectorUpdateServiceTypeRequest.md | 2 +- .../api/ConnectorUpdateServiceTypeResponse.md | 2 +- .../api/ConnectorUpdateStatusRequest.md | 2 +- .../api/ConnectorUpdateStatusResponse.md | 2 +- docs/reference/api/ConnectorValidation.md | 6 ++-- docs/reference/api/CoordsGeoBounds.md | 2 +- docs/reference/api/CountApi_1.md | 4 +-- docs/reference/api/CountApi_2.md | 4 +-- docs/reference/api/CountApi_3.md | 4 +-- docs/reference/api/CountRequest.md | 2 +- docs/reference/api/CountResponse.md | 2 +- docs/reference/api/CreateAction.md | 6 ++-- docs/reference/api/CreateActionOperation.md | 2 +- docs/reference/api/CreateApi_1.md | 4 +-- docs/reference/api/CreateApi_2.md | 4 +-- docs/reference/api/CreateApi_3.md | 4 +-- docs/reference/api/CreateRequest.md | 2 +- docs/reference/api/CreateResponse.md | 6 ++-- docs/reference/api/DFIIndependenceMeasure.md | 6 ++-- docs/reference/api/DFRAfterEffect.md | 6 ++-- docs/reference/api/DFRBasicModel.md | 6 ++-- docs/reference/api/DanglingIndices.md | 12 ++++---- ...nglingIndicesDeleteDanglingIndexRequest.md | 2 +- ...glingIndicesDeleteDanglingIndexResponse.md | 6 ++-- ...nglingIndicesImportDanglingIndexRequest.md | 2 +- ...glingIndicesImportDanglingIndexResponse.md | 6 ++-- ...IndicesListDanglingIndicesDanglingIndex.md | 2 +- ...nglingIndicesListDanglingIndicesRequest.md | 2 +- ...glingIndicesListDanglingIndicesResponse.md | 2 +- docs/reference/api/DataStreamName.md | 6 ++-- docs/reference/api/DataStreamNames.md | 6 ++-- docs/reference/api/DateFormat.md | 6 ++-- docs/reference/api/DateMath.md | 6 ++-- docs/reference/api/DateTime.md | 6 ++-- docs/reference/api/DeleteAction.md | 2 +- docs/reference/api/DeleteApi_1.md | 4 +-- docs/reference/api/DeleteApi_2.md | 4 +-- docs/reference/api/DeleteApi_3.md | 4 +-- docs/reference/api/DeleteByQueryApi_1.md | 4 +-- docs/reference/api/DeleteByQueryApi_2.md | 4 +-- docs/reference/api/DeleteByQueryApi_3.md | 4 +-- docs/reference/api/DeleteByQueryRequest.md | 2 +- docs/reference/api/DeleteByQueryResponse.md | 2 +- .../api/DeleteByQueryRethrottleApi_1.md | 4 +-- .../api/DeleteByQueryRethrottleApi_2.md | 4 +-- .../api/DeleteByQueryRethrottleApi_3.md | 4 +-- .../api/DeleteByQueryRethrottleRequest.md | 2 +- .../api/DeleteByQueryRethrottleResponse.md | 6 ++-- docs/reference/api/DeleteRequest.md | 2 +- docs/reference/api/DeleteResponse.md | 6 ++-- docs/reference/api/DeleteScriptApi_1.md | 4 +-- docs/reference/api/DeleteScriptApi_2.md | 4 +-- docs/reference/api/DeleteScriptApi_3.md | 4 +-- docs/reference/api/DeleteScriptRequest.md | 2 +- docs/reference/api/DeleteScriptResponse.md | 6 ++-- docs/reference/api/Distance.md | 6 ++-- docs/reference/api/DistanceUnit.md | 6 ++-- docs/reference/api/DocStats.md | 2 +- docs/reference/api/Duration.md | 6 ++-- docs/reference/api/DurationLarge.md | 6 ++-- docs/reference/api/DurationValue.md | 6 ++-- .../reference/api/ElasticsearchVersionInfo.md | 2 +- .../api/ElasticsearchVersionMinInfo.md | 2 +- docs/reference/api/EmptyObject.md | 2 +- docs/reference/api/Enrich.md | 12 ++++---- .../api/EnrichDeletePolicyRequest.md | 2 +- .../api/EnrichDeletePolicyResponse.md | 6 ++-- .../EnrichExecutePolicyEnrichPolicyPhase.md | 6 ++-- ...hExecutePolicyExecuteEnrichPolicyStatus.md | 2 +- .../api/EnrichExecutePolicyRequest.md | 2 +- .../api/EnrichExecutePolicyResponse.md | 2 +- docs/reference/api/EnrichGetPolicyRequest.md | 2 +- docs/reference/api/EnrichGetPolicyResponse.md | 2 +- docs/reference/api/EnrichPolicy.md | 2 +- docs/reference/api/EnrichPolicyType.md | 6 ++-- docs/reference/api/EnrichPutPolicyRequest.md | 2 +- docs/reference/api/EnrichPutPolicyResponse.md | 6 ++-- docs/reference/api/EnrichStatsCacheStats.md | 2 +- .../api/EnrichStatsCoordinatorStats.md | 2 +- .../api/EnrichStatsExecutingPolicy.md | 2 +- docs/reference/api/EnrichStatsRequest.md | 2 +- docs/reference/api/EnrichStatsResponse.md | 2 +- docs/reference/api/EnrichSummary.md | 2 +- docs/reference/api/EpochTime.md | 6 ++-- docs/reference/api/Eql.md | 12 ++++---- docs/reference/api/EqlDeleteRequest.md | 2 +- docs/reference/api/EqlDeleteResponse.md | 6 ++-- docs/reference/api/EqlEqlHits.md | 2 +- .../reference/api/EqlEqlSearchResponseBase.md | 2 +- docs/reference/api/EqlGetRequest.md | 2 +- docs/reference/api/EqlGetResponse.md | 6 ++-- docs/reference/api/EqlGetStatusRequest.md | 2 +- docs/reference/api/EqlGetStatusResponse.md | 2 +- docs/reference/api/EqlHitsEvent.md | 2 +- docs/reference/api/EqlHitsSequence.md | 2 +- docs/reference/api/EqlSearchRequest.md | 2 +- docs/reference/api/EqlSearchResponse.md | 6 ++-- docs/reference/api/EqlSearchResultPosition.md | 6 ++-- docs/reference/api/ErrorCause.md | 6 ++-- docs/reference/api/ErrorCauseKeys.md | 2 +- docs/reference/api/ErrorResponseBase.md | 2 +- docs/reference/api/Esql.md | 12 ++++---- docs/reference/api/EsqlAsyncEsqlResult.md | 2 +- .../api/EsqlAsyncQueryDeleteRequest.md | 2 +- .../api/EsqlAsyncQueryDeleteResponse.md | 6 ++-- .../reference/api/EsqlAsyncQueryGetRequest.md | 2 +- .../api/EsqlAsyncQueryGetResponse.md | 6 ++-- docs/reference/api/EsqlAsyncQueryRequest.md | 2 +- docs/reference/api/EsqlAsyncQueryResponse.md | 6 ++-- .../api/EsqlAsyncQueryStopRequest.md | 2 +- .../api/EsqlAsyncQueryStopResponse.md | 6 ++-- docs/reference/api/EsqlColumn.md | 2 +- docs/reference/api/EsqlEsqlClusterDetails.md | 2 +- docs/reference/api/EsqlEsqlClusterInfo.md | 2 +- docs/reference/api/EsqlEsqlClusterStatus.md | 6 ++-- docs/reference/api/EsqlEsqlColumnInfo.md | 2 +- docs/reference/api/EsqlEsqlFormat.md | 6 ++-- docs/reference/api/EsqlEsqlResult.md | 2 +- docs/reference/api/EsqlEsqlShardFailure.md | 2 +- docs/reference/api/EsqlEsqlShardInfo.md | 2 +- docs/reference/api/EsqlGetQueryRequest.md | 2 +- docs/reference/api/EsqlGetQueryResponse.md | 2 +- docs/reference/api/EsqlHelper.md | 2 +- docs/reference/api/EsqlListQueriesBody.md | 2 +- docs/reference/api/EsqlListQueriesRequest.md | 2 +- docs/reference/api/EsqlListQueriesResponse.md | 2 +- docs/reference/api/EsqlQueryRequest.md | 2 +- docs/reference/api/EsqlQueryResponse.md | 6 ++-- .../reference/api/EsqlTableValuesContainer.md | 2 +- .../api/EsqlTableValuesIntegerValue.md | 6 ++-- .../api/EsqlTableValuesKeywordValue.md | 6 ++-- .../api/EsqlTableValuesLongDouble.md | 6 ++-- .../reference/api/EsqlTableValuesLongValue.md | 6 ++-- docs/reference/api/EsqlToRecords.md | 2 +- docs/reference/api/ExistsApi_1.md | 4 +-- docs/reference/api/ExistsApi_2.md | 4 +-- docs/reference/api/ExistsApi_3.md | 4 +-- docs/reference/api/ExistsRequest.md | 2 +- docs/reference/api/ExistsResponse.md | 6 ++-- docs/reference/api/ExistsSourceApi_1.md | 4 +-- docs/reference/api/ExistsSourceApi_2.md | 4 +-- docs/reference/api/ExistsSourceApi_3.md | 4 +-- docs/reference/api/ExistsSourceRequest.md | 2 +- docs/reference/api/ExistsSourceResponse.md | 6 ++-- docs/reference/api/ExpandWildcard.md | 6 ++-- docs/reference/api/ExpandWildcards.md | 6 ++-- docs/reference/api/ExplainApi_1.md | 4 +-- docs/reference/api/ExplainApi_2.md | 4 +-- docs/reference/api/ExplainApi_3.md | 4 +-- docs/reference/api/ExplainExplanation.md | 2 +- .../reference/api/ExplainExplanationDetail.md | 2 +- docs/reference/api/ExplainRequest.md | 2 +- docs/reference/api/ExplainResponse.md | 2 +- docs/reference/api/Features.md | 12 ++++---- docs/reference/api/FeaturesFeature.md | 2 +- .../api/FeaturesGetFeaturesRequest.md | 2 +- .../api/FeaturesGetFeaturesResponse.md | 2 +- .../api/FeaturesResetFeaturesRequest.md | 2 +- .../api/FeaturesResetFeaturesResponse.md | 2 +- docs/reference/api/Field.md | 6 ++-- docs/reference/api/FieldCapsApi_1.md | 4 +-- docs/reference/api/FieldCapsApi_2.md | 4 +-- docs/reference/api/FieldCapsApi_3.md | 4 +-- .../reference/api/FieldCapsFieldCapability.md | 2 +- docs/reference/api/FieldCapsRequest.md | 2 +- docs/reference/api/FieldCapsResponse.md | 2 +- docs/reference/api/FieldMemoryUsage.md | 2 +- docs/reference/api/FieldSizeUsage.md | 2 +- docs/reference/api/FieldSort.md | 2 +- docs/reference/api/FieldSortNumericType.md | 6 ++-- docs/reference/api/FieldValue.md | 6 ++-- docs/reference/api/FielddataStats.md | 2 +- docs/reference/api/Fields.md | 6 ++-- docs/reference/api/Fleet.md | 12 ++++---- docs/reference/api/FleetCheckpoint.md | 6 ++-- .../api/FleetGlobalCheckpointsRequest.md | 2 +- .../api/FleetGlobalCheckpointsResponse.md | 2 +- docs/reference/api/FleetMsearchRequest.md | 2 +- docs/reference/api/FleetMsearchResponse.md | 2 +- docs/reference/api/FleetSearchRequest.md | 2 +- docs/reference/api/FleetSearchResponse.md | 2 +- docs/reference/api/FlushStats.md | 2 +- docs/reference/api/Fuzziness.md | 6 ++-- docs/reference/api/GeoBounds.md | 6 ++-- docs/reference/api/GeoDistanceSort.md | 6 ++-- docs/reference/api/GeoDistanceSortKeys.md | 2 +- docs/reference/api/GeoDistanceType.md | 6 ++-- docs/reference/api/GeoHash.md | 6 ++-- docs/reference/api/GeoHashLocation.md | 2 +- docs/reference/api/GeoHashPrecision.md | 6 ++-- docs/reference/api/GeoHexCell.md | 6 ++-- docs/reference/api/GeoLine.md | 2 +- docs/reference/api/GeoLocation.md | 6 ++-- docs/reference/api/GeoShape.md | 6 ++-- docs/reference/api/GeoShapeRelation.md | 6 ++-- docs/reference/api/GeoTile.md | 6 ++-- docs/reference/api/GeoTilePrecision.md | 6 ++-- docs/reference/api/GetApi_1.md | 4 +-- docs/reference/api/GetApi_2.md | 4 +-- docs/reference/api/GetApi_3.md | 4 +-- docs/reference/api/GetGetResult.md | 2 +- docs/reference/api/GetRequest.md | 2 +- docs/reference/api/GetResponse.md | 6 ++-- docs/reference/api/GetScriptApi_1.md | 4 +-- docs/reference/api/GetScriptApi_2.md | 4 +-- docs/reference/api/GetScriptApi_3.md | 4 +-- docs/reference/api/GetScriptContextApi_1.md | 4 +-- docs/reference/api/GetScriptContextApi_2.md | 4 +-- docs/reference/api/GetScriptContextApi_3.md | 4 +-- docs/reference/api/GetScriptContextContext.md | 2 +- .../api/GetScriptContextContextMethod.md | 2 +- .../api/GetScriptContextContextMethodParam.md | 2 +- docs/reference/api/GetScriptContextRequest.md | 2 +- .../reference/api/GetScriptContextResponse.md | 2 +- docs/reference/api/GetScriptLanguagesApi_1.md | 4 +-- docs/reference/api/GetScriptLanguagesApi_2.md | 4 +-- docs/reference/api/GetScriptLanguagesApi_3.md | 4 +-- .../api/GetScriptLanguagesLanguageContext.md | 2 +- .../api/GetScriptLanguagesRequest.md | 2 +- .../api/GetScriptLanguagesResponse.md | 2 +- docs/reference/api/GetScriptRequest.md | 2 +- docs/reference/api/GetScriptResponse.md | 2 +- docs/reference/api/GetSourceApi_1.md | 4 +-- docs/reference/api/GetSourceApi_2.md | 4 +-- docs/reference/api/GetSourceApi_3.md | 4 +-- docs/reference/api/GetSourceRequest.md | 2 +- docs/reference/api/GetSourceResponse.md | 6 ++-- docs/reference/api/GetStats.md | 2 +- docs/reference/api/Graph.md | 12 ++++---- docs/reference/api/GraphConnection.md | 2 +- docs/reference/api/GraphExploreControls.md | 2 +- docs/reference/api/GraphExploreRequest.md | 2 +- docs/reference/api/GraphExploreResponse.md | 2 +- docs/reference/api/GraphHop.md | 2 +- docs/reference/api/GraphSampleDiversity.md | 2 +- docs/reference/api/GraphVertex.md | 2 +- docs/reference/api/GraphVertexDefinition.md | 2 +- docs/reference/api/GraphVertexInclude.md | 2 +- docs/reference/api/GrokPattern.md | 6 ++-- docs/reference/api/HealthReportApi_1.md | 4 +-- docs/reference/api/HealthReportApi_2.md | 4 +-- docs/reference/api/HealthReportApi_3.md | 4 +-- .../api/HealthReportBaseIndicator.md | 2 +- .../HealthReportDataStreamLifecycleDetails.md | 2 +- ...ealthReportDataStreamLifecycleIndicator.md | 2 +- docs/reference/api/HealthReportDiagnosis.md | 2 +- .../HealthReportDiagnosisAffectedResources.md | 2 +- .../api/HealthReportDiskIndicator.md | 2 +- .../api/HealthReportDiskIndicatorDetails.md | 2 +- .../api/HealthReportFileSettingsIndicator.md | 2 +- ...ealthReportFileSettingsIndicatorDetails.md | 2 +- .../reference/api/HealthReportIlmIndicator.md | 2 +- .../api/HealthReportIlmIndicatorDetails.md | 2 +- docs/reference/api/HealthReportImpact.md | 2 +- docs/reference/api/HealthReportImpactArea.md | 6 ++-- .../api/HealthReportIndicatorHealthStatus.md | 6 ++-- .../api/HealthReportIndicatorNode.md | 2 +- docs/reference/api/HealthReportIndicators.md | 2 +- .../HealthReportMasterIsStableIndicator.md | 2 +- ...erIsStableIndicatorClusterFormationNode.md | 2 +- ...lthReportMasterIsStableIndicatorDetails.md | 2 +- ...StableIndicatorExceptionFetchingHistory.md | 2 +- ...ealthReportRepositoryIntegrityIndicator.md | 2 +- ...portRepositoryIntegrityIndicatorDetails.md | 2 +- docs/reference/api/HealthReportRequest.md | 2 +- docs/reference/api/HealthReportResponse.md | 2 +- ...HealthReportShardsAvailabilityIndicator.md | 2 +- ...eportShardsAvailabilityIndicatorDetails.md | 2 +- .../HealthReportShardsCapacityIndicator.md | 2 +- ...lthReportShardsCapacityIndicatorDetails.md | 2 +- ...ReportShardsCapacityIndicatorTierDetail.md | 2 +- .../reference/api/HealthReportSlmIndicator.md | 2 +- .../api/HealthReportSlmIndicatorDetails.md | 2 +- ...althReportSlmIndicatorUnhealthyPolicies.md | 2 +- .../HealthReportStagnatingBackingIndices.md | 2 +- docs/reference/api/HealthStatus.md | 6 ++-- docs/reference/api/Helpers.md | 12 ++++---- docs/reference/api/HelpersOptions.md | 2 +- docs/reference/api/Host.md | 6 ++-- docs/reference/api/HttpHeaders.md | 6 ++-- docs/reference/api/IBDistribution.md | 6 ++-- docs/reference/api/IBLambda.md | 6 ++-- docs/reference/api/Id.md | 6 ++-- docs/reference/api/Ids.md | 6 ++-- docs/reference/api/Ilm.md | 12 ++++---- docs/reference/api/IlmActions.md | 2 +- docs/reference/api/IlmAllocateAction.md | 2 +- docs/reference/api/IlmDeleteAction.md | 2 +- .../api/IlmDeleteLifecycleRequest.md | 2 +- .../api/IlmDeleteLifecycleResponse.md | 6 ++-- docs/reference/api/IlmDownsampleAction.md | 2 +- .../IlmExplainLifecycleLifecycleExplain.md | 6 ++-- ...ExplainLifecycleLifecycleExplainManaged.md | 2 +- ...LifecycleLifecycleExplainPhaseExecution.md | 2 +- ...plainLifecycleLifecycleExplainUnmanaged.md | 2 +- .../api/IlmExplainLifecycleRequest.md | 2 +- .../api/IlmExplainLifecycleResponse.md | 2 +- docs/reference/api/IlmForceMergeAction.md | 2 +- .../reference/api/IlmGetLifecycleLifecycle.md | 2 +- docs/reference/api/IlmGetLifecycleRequest.md | 2 +- docs/reference/api/IlmGetLifecycleResponse.md | 6 ++-- docs/reference/api/IlmGetStatusRequest.md | 2 +- docs/reference/api/IlmGetStatusResponse.md | 2 +- docs/reference/api/IlmMigrateAction.md | 2 +- .../api/IlmMigrateToDataTiersRequest.md | 2 +- .../api/IlmMigrateToDataTiersResponse.md | 2 +- docs/reference/api/IlmMoveToStepRequest.md | 2 +- docs/reference/api/IlmMoveToStepResponse.md | 6 ++-- docs/reference/api/IlmMoveToStepStepKey.md | 2 +- docs/reference/api/IlmPhase.md | 2 +- docs/reference/api/IlmPhases.md | 2 +- docs/reference/api/IlmPolicy.md | 2 +- docs/reference/api/IlmPutLifecycleRequest.md | 2 +- docs/reference/api/IlmPutLifecycleResponse.md | 6 ++-- docs/reference/api/IlmRemovePolicyRequest.md | 2 +- docs/reference/api/IlmRemovePolicyResponse.md | 2 +- docs/reference/api/IlmRetryRequest.md | 2 +- docs/reference/api/IlmRetryResponse.md | 6 ++-- docs/reference/api/IlmRolloverAction.md | 2 +- .../api/IlmSearchableSnapshotAction.md | 2 +- docs/reference/api/IlmSetPriorityAction.md | 2 +- docs/reference/api/IlmShrinkAction.md | 2 +- docs/reference/api/IlmStartRequest.md | 2 +- docs/reference/api/IlmStartResponse.md | 6 ++-- docs/reference/api/IlmStopRequest.md | 2 +- docs/reference/api/IlmStopResponse.md | 6 ++-- .../reference/api/IlmWaitForSnapshotAction.md | 2 +- docs/reference/api/IndexAction.md | 6 ++-- docs/reference/api/IndexActionOperation.md | 2 +- docs/reference/api/IndexAlias.md | 6 ++-- docs/reference/api/IndexApi_1.md | 4 +-- docs/reference/api/IndexApi_2.md | 4 +-- docs/reference/api/IndexApi_3.md | 4 +-- docs/reference/api/IndexName.md | 6 ++-- docs/reference/api/IndexPattern.md | 6 ++-- docs/reference/api/IndexPatterns.md | 6 ++-- docs/reference/api/IndexRequest.md | 2 +- docs/reference/api/IndexResponse.md | 6 ++-- docs/reference/api/IndexingStats.md | 2 +- docs/reference/api/Indices.md | 6 ++-- .../api/IndicesAddBlockIndicesBlockOptions.md | 6 ++-- .../api/IndicesAddBlockIndicesBlockStatus.md | 2 +- docs/reference/api/IndicesAddBlockRequest.md | 2 +- docs/reference/api/IndicesAddBlockResponse.md | 2 +- docs/reference/api/IndicesAlias.md | 2 +- docs/reference/api/IndicesAliasDefinition.md | 2 +- .../api/IndicesAnalyzeAnalyzeDetail.md | 2 +- .../api/IndicesAnalyzeAnalyzeToken.md | 2 +- .../api/IndicesAnalyzeAnalyzerDetail.md | 2 +- .../api/IndicesAnalyzeCharFilterDetail.md | 2 +- .../api/IndicesAnalyzeExplainAnalyzeToken.md | 6 ++-- .../IndicesAnalyzeExplainAnalyzeTokenKeys.md | 2 +- docs/reference/api/IndicesAnalyzeRequest.md | 2 +- docs/reference/api/IndicesAnalyzeResponse.md | 2 +- .../api/IndicesAnalyzeTextToAnalyze.md | 6 ++-- .../api/IndicesAnalyzeTokenDetail.md | 2 +- docs/reference/api/IndicesCacheQueries.md | 2 +- .../api/IndicesCancelMigrateReindexRequest.md | 2 +- .../IndicesCancelMigrateReindexResponse.md | 6 ++-- .../reference/api/IndicesClearCacheRequest.md | 2 +- .../api/IndicesClearCacheResponse.md | 6 ++-- docs/reference/api/IndicesCloneRequest.md | 2 +- docs/reference/api/IndicesCloneResponse.md | 2 +- .../api/IndicesCloseCloseIndexResult.md | 2 +- .../api/IndicesCloseCloseShardResult.md | 2 +- docs/reference/api/IndicesCloseRequest.md | 2 +- docs/reference/api/IndicesCloseResponse.md | 2 +- .../api/IndicesCreateDataStreamRequest.md | 2 +- .../api/IndicesCreateDataStreamResponse.md | 6 ++-- .../api/IndicesCreateFromCreateFrom.md | 2 +- .../reference/api/IndicesCreateFromRequest.md | 2 +- .../api/IndicesCreateFromResponse.md | 2 +- docs/reference/api/IndicesCreateRequest.md | 2 +- docs/reference/api/IndicesCreateResponse.md | 2 +- docs/reference/api/IndicesDataStream.md | 2 +- docs/reference/api/IndicesDataStreamIndex.md | 2 +- .../api/IndicesDataStreamLifecycle.md | 2 +- .../IndicesDataStreamLifecycleDownsampling.md | 2 +- ...esDataStreamLifecycleRolloverConditions.md | 2 +- .../IndicesDataStreamLifecycleWithRollover.md | 2 +- .../api/IndicesDataStreamTimestampField.md | 2 +- .../api/IndicesDataStreamVisibility.md | 2 +- ...cesDataStreamsStatsDataStreamsStatsItem.md | 2 +- .../api/IndicesDataStreamsStatsRequest.md | 2 +- .../api/IndicesDataStreamsStatsResponse.md | 2 +- .../api/IndicesDeleteAliasRequest.md | 2 +- .../api/IndicesDeleteAliasResponse.md | 6 ++-- .../api/IndicesDeleteDataLifecycleRequest.md | 2 +- .../api/IndicesDeleteDataLifecycleResponse.md | 6 ++-- .../api/IndicesDeleteDataStreamRequest.md | 2 +- .../api/IndicesDeleteDataStreamResponse.md | 6 ++-- .../api/IndicesDeleteIndexTemplateRequest.md | 2 +- .../api/IndicesDeleteIndexTemplateResponse.md | 6 ++-- docs/reference/api/IndicesDeleteRequest.md | 2 +- docs/reference/api/IndicesDeleteResponse.md | 6 ++-- .../api/IndicesDeleteTemplateRequest.md | 2 +- .../api/IndicesDeleteTemplateResponse.md | 6 ++-- docs/reference/api/IndicesDiskUsageRequest.md | 2 +- .../reference/api/IndicesDiskUsageResponse.md | 6 ++-- docs/reference/api/IndicesDownsampleConfig.md | 2 +- .../reference/api/IndicesDownsampleRequest.md | 2 +- .../api/IndicesDownsampleResponse.md | 6 ++-- .../reference/api/IndicesDownsamplingRound.md | 2 +- .../api/IndicesExistsAliasRequest.md | 2 +- .../api/IndicesExistsAliasResponse.md | 6 ++-- .../api/IndicesExistsIndexTemplateRequest.md | 2 +- .../api/IndicesExistsIndexTemplateResponse.md | 6 ++-- docs/reference/api/IndicesExistsRequest.md | 2 +- docs/reference/api/IndicesExistsResponse.md | 6 ++-- .../api/IndicesExistsTemplateRequest.md | 2 +- .../api/IndicesExistsTemplateResponse.md | 6 ++-- ...DataLifecycleDataStreamLifecycleExplain.md | 2 +- .../api/IndicesExplainDataLifecycleRequest.md | 2 +- .../IndicesExplainDataLifecycleResponse.md | 2 +- docs/reference/api/IndicesFailureStore.md | 2 +- .../api/IndicesFieldUsageStatsFieldSummary.md | 2 +- .../IndicesFieldUsageStatsFieldsUsageBody.md | 6 ++-- ...dicesFieldUsageStatsFieldsUsageBodyKeys.md | 2 +- .../IndicesFieldUsageStatsInvertedIndex.md | 2 +- .../api/IndicesFieldUsageStatsRequest.md | 2 +- .../api/IndicesFieldUsageStatsResponse.md | 6 ++-- .../api/IndicesFieldUsageStatsShardsStats.md | 2 +- .../IndicesFieldUsageStatsUsageStatsIndex.md | 2 +- .../IndicesFieldUsageStatsUsageStatsShards.md | 2 +- .../api/IndicesFielddataFrequencyFilter.md | 2 +- docs/reference/api/IndicesFlushRequest.md | 2 +- docs/reference/api/IndicesFlushResponse.md | 6 ++-- ...IndicesForcemergeForceMergeResponseBody.md | 2 +- .../reference/api/IndicesForcemergeRequest.md | 2 +- .../api/IndicesForcemergeResponse.md | 6 ++-- .../api/IndicesGetAliasIndexAliases.md | 2 +- docs/reference/api/IndicesGetAliasRequest.md | 2 +- docs/reference/api/IndicesGetAliasResponse.md | 6 ++-- ...GetDataLifecycleDataStreamWithLifecycle.md | 2 +- .../api/IndicesGetDataLifecycleRequest.md | 2 +- .../api/IndicesGetDataLifecycleResponse.md | 2 +- ...cesGetDataLifecycleStatsDataStreamStats.md | 2 +- .../IndicesGetDataLifecycleStatsRequest.md | 2 +- .../IndicesGetDataLifecycleStatsResponse.md | 2 +- .../api/IndicesGetDataStreamRequest.md | 2 +- .../api/IndicesGetDataStreamResponse.md | 2 +- docs/reference/api/IndicesGetFeature.md | 6 ++-- docs/reference/api/IndicesGetFeatures.md | 6 ++-- .../api/IndicesGetFieldMappingRequest.md | 2 +- .../api/IndicesGetFieldMappingResponse.md | 6 ++-- ...IndicesGetFieldMappingTypeFieldMappings.md | 2 +- ...ndicesGetIndexTemplateIndexTemplateItem.md | 2 +- .../api/IndicesGetIndexTemplateRequest.md | 2 +- .../api/IndicesGetIndexTemplateResponse.md | 2 +- .../IndicesGetMappingIndexMappingRecord.md | 2 +- .../reference/api/IndicesGetMappingRequest.md | 2 +- .../api/IndicesGetMappingResponse.md | 6 ++-- .../IndicesGetMigrateReindexStatusRequest.md | 2 +- .../IndicesGetMigrateReindexStatusResponse.md | 2 +- ...dicesGetMigrateReindexStatusStatusError.md | 2 +- ...GetMigrateReindexStatusStatusInProgress.md | 2 +- docs/reference/api/IndicesGetRequest.md | 2 +- docs/reference/api/IndicesGetResponse.md | 6 ++-- .../api/IndicesGetSettingsRequest.md | 2 +- .../api/IndicesGetSettingsResponse.md | 6 ++-- .../api/IndicesGetTemplateRequest.md | 2 +- .../api/IndicesGetTemplateResponse.md | 6 ++-- .../api/IndicesIndexCheckOnStartup.md | 6 ++-- docs/reference/api/IndicesIndexMode.md | 6 ++-- docs/reference/api/IndicesIndexRouting.md | 2 +- .../api/IndicesIndexRoutingAllocation.md | 2 +- .../api/IndicesIndexRoutingAllocationDisk.md | 2 +- .../IndicesIndexRoutingAllocationInclude.md | 2 +- ...esIndexRoutingAllocationInitialRecovery.md | 2 +- .../IndicesIndexRoutingAllocationOptions.md | 6 ++-- .../api/IndicesIndexRoutingRebalance.md | 2 +- .../IndicesIndexRoutingRebalanceOptions.md | 6 ++-- docs/reference/api/IndicesIndexSegmentSort.md | 2 +- .../api/IndicesIndexSettingBlocks.md | 2 +- docs/reference/api/IndicesIndexSettings.md | 6 ++-- .../api/IndicesIndexSettingsAnalysis.md | 2 +- .../reference/api/IndicesIndexSettingsKeys.md | 2 +- .../api/IndicesIndexSettingsLifecycle.md | 2 +- .../api/IndicesIndexSettingsLifecycleStep.md | 2 +- .../api/IndicesIndexSettingsTimeSeries.md | 2 +- docs/reference/api/IndicesIndexState.md | 2 +- docs/reference/api/IndicesIndexTemplate.md | 2 +- ...cesIndexTemplateDataStreamConfiguration.md | 2 +- .../api/IndicesIndexTemplateSummary.md | 2 +- docs/reference/api/IndicesIndexVersioning.md | 2 +- docs/reference/api/IndicesIndexingPressure.md | 2 +- .../api/IndicesIndexingPressureMemory.md | 2 +- .../api/IndicesIndexingSlowlogSettings.md | 2 +- .../api/IndicesIndexingSlowlogTresholds.md | 2 +- docs/reference/api/IndicesManagedBy.md | 6 ++-- .../api/IndicesMappingLimitSettings.md | 2 +- .../api/IndicesMappingLimitSettingsDepth.md | 2 +- ...icesMappingLimitSettingsDimensionFields.md | 2 +- ...icesMappingLimitSettingsFieldNameLength.md | 2 +- ...IndicesMappingLimitSettingsNestedFields.md | 2 +- ...ndicesMappingLimitSettingsNestedObjects.md | 2 +- ...IndicesMappingLimitSettingsSourceFields.md | 2 +- .../IndicesMappingLimitSettingsTotalFields.md | 2 +- docs/reference/api/IndicesMerge.md | 2 +- docs/reference/api/IndicesMergeScheduler.md | 2 +- .../IndicesMigrateReindexMigrateReindex.md | 2 +- .../api/IndicesMigrateReindexModeEnum.md | 6 ++-- .../api/IndicesMigrateReindexRequest.md | 2 +- .../api/IndicesMigrateReindexResponse.md | 6 ++-- .../api/IndicesMigrateReindexSourceIndex.md | 2 +- .../api/IndicesMigrateToDataStreamRequest.md | 2 +- .../api/IndicesMigrateToDataStreamResponse.md | 6 ++-- .../api/IndicesModifyDataStreamAction.md | 2 +- ...odifyDataStreamIndexAndDataStreamAction.md | 2 +- .../api/IndicesModifyDataStreamRequest.md | 2 +- .../api/IndicesModifyDataStreamResponse.md | 6 ++-- docs/reference/api/IndicesNumericFielddata.md | 2 +- .../api/IndicesNumericFielddataFormat.md | 6 ++-- docs/reference/api/IndicesOpenRequest.md | 2 +- docs/reference/api/IndicesOpenResponse.md | 2 +- docs/reference/api/IndicesOptions.md | 2 +- .../api/IndicesPromoteDataStreamRequest.md | 2 +- .../api/IndicesPromoteDataStreamResponse.md | 6 ++-- docs/reference/api/IndicesPutAliasRequest.md | 2 +- docs/reference/api/IndicesPutAliasResponse.md | 6 ++-- .../api/IndicesPutDataLifecycleRequest.md | 2 +- .../api/IndicesPutDataLifecycleResponse.md | 6 ++-- ...cesPutIndexTemplateIndexTemplateMapping.md | 2 +- .../api/IndicesPutIndexTemplateRequest.md | 2 +- .../api/IndicesPutIndexTemplateResponse.md | 6 ++-- .../reference/api/IndicesPutMappingRequest.md | 2 +- .../api/IndicesPutMappingResponse.md | 6 ++-- .../api/IndicesPutSettingsRequest.md | 2 +- .../api/IndicesPutSettingsResponse.md | 6 ++-- .../api/IndicesPutTemplateRequest.md | 2 +- .../api/IndicesPutTemplateResponse.md | 6 ++-- docs/reference/api/IndicesQueries.md | 2 +- .../api/IndicesRecoveryFileDetails.md | 2 +- .../api/IndicesRecoveryRecoveryBytes.md | 2 +- .../api/IndicesRecoveryRecoveryFiles.md | 2 +- .../api/IndicesRecoveryRecoveryIndexStatus.md | 2 +- .../api/IndicesRecoveryRecoveryOrigin.md | 2 +- .../api/IndicesRecoveryRecoveryStartStatus.md | 2 +- .../api/IndicesRecoveryRecoveryStatus.md | 2 +- docs/reference/api/IndicesRecoveryRequest.md | 2 +- docs/reference/api/IndicesRecoveryResponse.md | 6 ++-- .../api/IndicesRecoveryShardRecovery.md | 2 +- .../api/IndicesRecoveryTranslogStatus.md | 2 +- .../api/IndicesRecoveryVerifyIndex.md | 2 +- docs/reference/api/IndicesRefreshRequest.md | 2 +- docs/reference/api/IndicesRefreshResponse.md | 6 ++-- ...dicesReloadSearchAnalyzersReloadDetails.md | 2 +- ...ndicesReloadSearchAnalyzersReloadResult.md | 2 +- .../IndicesReloadSearchAnalyzersRequest.md | 2 +- .../IndicesReloadSearchAnalyzersResponse.md | 6 ++-- .../api/IndicesResolveClusterRequest.md | 2 +- ...IndicesResolveClusterResolveClusterInfo.md | 2 +- .../api/IndicesResolveClusterResponse.md | 6 ++-- .../api/IndicesResolveIndexRequest.md | 2 +- ...ndicesResolveIndexResolveIndexAliasItem.md | 2 +- ...ResolveIndexResolveIndexDataStreamsItem.md | 2 +- .../IndicesResolveIndexResolveIndexItem.md | 2 +- .../api/IndicesResolveIndexResponse.md | 2 +- docs/reference/api/IndicesResponseBase.md | 2 +- docs/reference/api/IndicesRetentionLease.md | 2 +- docs/reference/api/IndicesRolloverRequest.md | 2 +- docs/reference/api/IndicesRolloverResponse.md | 2 +- .../api/IndicesRolloverRolloverConditions.md | 2 +- docs/reference/api/IndicesSearchIdle.md | 2 +- .../api/IndicesSegmentSortMissing.md | 6 ++-- docs/reference/api/IndicesSegmentSortMode.md | 6 ++-- docs/reference/api/IndicesSegmentSortOrder.md | 6 ++-- .../api/IndicesSegmentsIndexSegment.md | 2 +- docs/reference/api/IndicesSegmentsRequest.md | 2 +- docs/reference/api/IndicesSegmentsResponse.md | 2 +- docs/reference/api/IndicesSegmentsSegment.md | 2 +- .../api/IndicesSegmentsShardSegmentRouting.md | 2 +- .../api/IndicesSegmentsShardsSegment.md | 2 +- docs/reference/api/IndicesSettingsAnalyze.md | 2 +- .../reference/api/IndicesSettingsHighlight.md | 2 +- .../api/IndicesSettingsQueryString.md | 2 +- docs/reference/api/IndicesSettingsSearch.md | 2 +- .../api/IndicesSettingsSimilarity.md | 6 ++-- .../api/IndicesSettingsSimilarityBm25.md | 2 +- .../api/IndicesSettingsSimilarityBoolean.md | 2 +- .../api/IndicesSettingsSimilarityDfi.md | 2 +- .../api/IndicesSettingsSimilarityDfr.md | 2 +- .../api/IndicesSettingsSimilarityIb.md | 2 +- .../api/IndicesSettingsSimilarityLmd.md | 2 +- .../api/IndicesSettingsSimilarityLmj.md | 2 +- .../api/IndicesSettingsSimilarityScripted.md | 2 +- .../IndicesShardStoresIndicesShardStores.md | 2 +- .../api/IndicesShardStoresRequest.md | 2 +- .../api/IndicesShardStoresResponse.md | 2 +- .../api/IndicesShardStoresShardStore.md | 6 ++-- .../IndicesShardStoresShardStoreAllocation.md | 6 ++-- .../IndicesShardStoresShardStoreException.md | 2 +- .../api/IndicesShardStoresShardStoreKeys.md | 2 +- .../api/IndicesShardStoresShardStoreNode.md | 2 +- .../api/IndicesShardStoresShardStoreStatus.md | 6 ++-- .../IndicesShardStoresShardStoreWrapper.md | 2 +- docs/reference/api/IndicesShrinkRequest.md | 2 +- docs/reference/api/IndicesShrinkResponse.md | 2 +- .../IndicesSimulateIndexTemplateRequest.md | 2 +- .../IndicesSimulateIndexTemplateResponse.md | 2 +- .../api/IndicesSimulateTemplateOverlapping.md | 2 +- .../api/IndicesSimulateTemplateRequest.md | 2 +- .../api/IndicesSimulateTemplateResponse.md | 2 +- .../api/IndicesSimulateTemplateTemplate.md | 2 +- docs/reference/api/IndicesSlowlogSettings.md | 2 +- .../api/IndicesSlowlogTresholdLevels.md | 2 +- docs/reference/api/IndicesSlowlogTresholds.md | 2 +- docs/reference/api/IndicesSoftDeletes.md | 2 +- docs/reference/api/IndicesSourceMode.md | 6 ++-- docs/reference/api/IndicesSplitRequest.md | 2 +- docs/reference/api/IndicesSplitResponse.md | 2 +- .../api/IndicesStatsIndexMetadataState.md | 6 ++-- docs/reference/api/IndicesStatsIndexStats.md | 2 +- .../reference/api/IndicesStatsIndicesStats.md | 2 +- .../reference/api/IndicesStatsMappingStats.md | 2 +- docs/reference/api/IndicesStatsRequest.md | 2 +- docs/reference/api/IndicesStatsResponse.md | 2 +- docs/reference/api/IndicesStatsShardCommit.md | 2 +- .../api/IndicesStatsShardFileSizeInfo.md | 2 +- docs/reference/api/IndicesStatsShardLease.md | 2 +- docs/reference/api/IndicesStatsShardPath.md | 2 +- .../api/IndicesStatsShardQueryCache.md | 2 +- .../api/IndicesStatsShardRetentionLeases.md | 2 +- .../reference/api/IndicesStatsShardRouting.md | 2 +- .../api/IndicesStatsShardRoutingState.md | 6 ++-- .../api/IndicesStatsShardSequenceNumber.md | 2 +- docs/reference/api/IndicesStatsShardStats.md | 2 +- .../api/IndicesStatsShardsTotalStats.md | 2 +- docs/reference/api/IndicesStorage.md | 2 +- docs/reference/api/IndicesStorageType.md | 6 ++-- docs/reference/api/IndicesTemplateMapping.md | 2 +- docs/reference/api/IndicesTranslog.md | 2 +- .../api/IndicesTranslogDurability.md | 6 ++-- .../reference/api/IndicesTranslogRetention.md | 2 +- .../api/IndicesUpdateAliasesAction.md | 2 +- .../api/IndicesUpdateAliasesAddAction.md | 2 +- .../api/IndicesUpdateAliasesRemoveAction.md | 2 +- .../IndicesUpdateAliasesRemoveIndexAction.md | 2 +- .../api/IndicesUpdateAliasesRequest.md | 2 +- .../api/IndicesUpdateAliasesResponse.md | 6 ++-- ...lidateQueryIndicesValidationExplanation.md | 2 +- .../api/IndicesValidateQueryRequest.md | 2 +- .../api/IndicesValidateQueryResponse.md | 2 +- docs/reference/api/Inference.md | 12 ++++---- .../api/InferenceAdaptiveAllocations.md | 2 +- .../InferenceAlibabaCloudServiceSettings.md | 2 +- .../api/InferenceAlibabaCloudServiceType.md | 6 ++-- .../api/InferenceAlibabaCloudTaskSettings.md | 2 +- .../api/InferenceAlibabaCloudTaskType.md | 6 ++-- .../InferenceAmazonBedrockServiceSettings.md | 2 +- .../api/InferenceAmazonBedrockServiceType.md | 6 ++-- .../api/InferenceAmazonBedrockTaskSettings.md | 2 +- .../api/InferenceAmazonBedrockTaskType.md | 6 ++-- .../api/InferenceAnthropicServiceSettings.md | 2 +- .../api/InferenceAnthropicServiceType.md | 6 ++-- .../api/InferenceAnthropicTaskSettings.md | 2 +- .../api/InferenceAnthropicTaskType.md | 6 ++-- .../InferenceAzureAiStudioServiceSettings.md | 2 +- .../api/InferenceAzureAiStudioServiceType.md | 6 ++-- .../api/InferenceAzureAiStudioTaskSettings.md | 2 +- .../api/InferenceAzureAiStudioTaskType.md | 6 ++-- .../InferenceAzureOpenAIServiceSettings.md | 2 +- .../api/InferenceAzureOpenAIServiceType.md | 6 ++-- .../api/InferenceAzureOpenAITaskSettings.md | 2 +- .../api/InferenceAzureOpenAITaskType.md | 6 ++-- .../InferenceChatCompletionUnifiedRequest.md | 2 +- .../InferenceChatCompletionUnifiedResponse.md | 6 ++-- .../api/InferenceCohereEmbeddingType.md | 6 ++-- .../reference/api/InferenceCohereInputType.md | 6 ++-- .../api/InferenceCohereServiceSettings.md | 2 +- .../api/InferenceCohereServiceType.md | 6 ++-- .../api/InferenceCohereSimilarityType.md | 6 ++-- .../api/InferenceCohereTaskSettings.md | 2 +- docs/reference/api/InferenceCohereTaskType.md | 6 ++-- .../api/InferenceCohereTruncateType.md | 6 ++-- .../api/InferenceCompletionInferenceResult.md | 2 +- .../api/InferenceCompletionRequest.md | 2 +- .../api/InferenceCompletionResponse.md | 6 ++-- .../api/InferenceCompletionResult.md | 2 +- docs/reference/api/InferenceCompletionTool.md | 2 +- .../api/InferenceCompletionToolChoice.md | 2 +- .../InferenceCompletionToolChoiceFunction.md | 2 +- .../api/InferenceCompletionToolFunction.md | 2 +- .../api/InferenceCompletionToolType.md | 6 ++-- docs/reference/api/InferenceContentObject.md | 2 +- .../InferenceDeleteInferenceEndpointResult.md | 2 +- docs/reference/api/InferenceDeleteRequest.md | 2 +- docs/reference/api/InferenceDeleteResponse.md | 6 ++-- .../reference/api/InferenceDenseByteVector.md | 6 ++-- docs/reference/api/InferenceDenseVector.md | 6 ++-- .../InferenceElasticsearchServiceSettings.md | 2 +- .../api/InferenceElasticsearchServiceType.md | 6 ++-- .../api/InferenceElasticsearchTaskSettings.md | 2 +- .../api/InferenceElasticsearchTaskType.md | 6 ++-- .../api/InferenceElserServiceSettings.md | 2 +- .../api/InferenceElserServiceType.md | 6 ++-- docs/reference/api/InferenceElserTaskType.md | 6 ++-- docs/reference/api/InferenceGetRequest.md | 2 +- docs/reference/api/InferenceGetResponse.md | 2 +- .../api/InferenceGoogleAiServiceType.md | 6 ++-- .../InferenceGoogleAiStudioServiceSettings.md | 2 +- .../api/InferenceGoogleAiStudioTaskType.md | 6 ++-- .../InferenceGoogleVertexAIServiceSettings.md | 2 +- .../api/InferenceGoogleVertexAIServiceType.md | 6 ++-- .../InferenceGoogleVertexAITaskSettings.md | 2 +- .../api/InferenceGoogleVertexAITaskType.md | 6 ++-- .../InferenceHuggingFaceServiceSettings.md | 2 +- .../api/InferenceHuggingFaceServiceType.md | 6 ++-- .../api/InferenceHuggingFaceTaskType.md | 6 ++-- .../api/InferenceInferenceChunkingSettings.md | 2 +- .../api/InferenceInferenceEndpoint.md | 2 +- .../api/InferenceInferenceEndpointInfo.md | 2 +- .../api/InferenceInferenceRequest.md | 2 +- .../api/InferenceInferenceResponse.md | 6 ++-- .../reference/api/InferenceInferenceResult.md | 2 +- .../api/InferenceJinaAIServiceSettings.md | 2 +- .../api/InferenceJinaAIServiceType.md | 6 ++-- .../api/InferenceJinaAISimilarityType.md | 6 ++-- .../api/InferenceJinaAITaskSettings.md | 2 +- docs/reference/api/InferenceJinaAITaskType.md | 6 ++-- .../api/InferenceJinaAITextEmbeddingTask.md | 6 ++-- docs/reference/api/InferenceMessage.md | 2 +- docs/reference/api/InferenceMessageContent.md | 6 ++-- .../api/InferenceMistralServiceSettings.md | 2 +- .../api/InferenceMistralServiceType.md | 6 ++-- .../reference/api/InferenceMistralTaskType.md | 6 ++-- .../api/InferenceOpenAIServiceSettings.md | 2 +- .../api/InferenceOpenAIServiceType.md | 6 ++-- .../api/InferenceOpenAITaskSettings.md | 2 +- docs/reference/api/InferenceOpenAITaskType.md | 6 ++-- .../api/InferencePutAlibabacloudRequest.md | 2 +- .../api/InferencePutAlibabacloudResponse.md | 6 ++-- .../api/InferencePutAmazonbedrockRequest.md | 2 +- .../api/InferencePutAmazonbedrockResponse.md | 6 ++-- .../api/InferencePutAnthropicRequest.md | 2 +- .../api/InferencePutAnthropicResponse.md | 6 ++-- .../api/InferencePutAzureaistudioRequest.md | 2 +- .../api/InferencePutAzureaistudioResponse.md | 6 ++-- .../api/InferencePutAzureopenaiRequest.md | 2 +- .../api/InferencePutAzureopenaiResponse.md | 6 ++-- .../api/InferencePutCohereRequest.md | 2 +- .../api/InferencePutCohereResponse.md | 6 ++-- .../api/InferencePutElasticsearchRequest.md | 2 +- .../api/InferencePutElasticsearchResponse.md | 6 ++-- .../reference/api/InferencePutElserRequest.md | 2 +- .../api/InferencePutElserResponse.md | 6 ++-- .../api/InferencePutGoogleaistudioRequest.md | 2 +- .../api/InferencePutGoogleaistudioResponse.md | 6 ++-- .../api/InferencePutGooglevertexaiRequest.md | 2 +- .../api/InferencePutGooglevertexaiResponse.md | 6 ++-- .../api/InferencePutHuggingFaceRequest.md | 2 +- .../api/InferencePutHuggingFaceResponse.md | 6 ++-- .../api/InferencePutJinaaiRequest.md | 2 +- .../api/InferencePutJinaaiResponse.md | 6 ++-- .../api/InferencePutMistralRequest.md | 2 +- .../api/InferencePutMistralResponse.md | 6 ++-- .../api/InferencePutOpenaiRequest.md | 2 +- .../api/InferencePutOpenaiResponse.md | 6 ++-- docs/reference/api/InferencePutRequest.md | 2 +- docs/reference/api/InferencePutResponse.md | 6 ++-- .../api/InferencePutVoyageaiRequest.md | 2 +- .../api/InferencePutVoyageaiResponse.md | 6 ++-- .../api/InferencePutWatsonxRequest.md | 2 +- .../api/InferencePutWatsonxResponse.md | 6 ++-- docs/reference/api/InferenceRankedDocument.md | 2 +- .../api/InferenceRateLimitSetting.md | 2 +- .../api/InferenceRequestChatCompletion.md | 2 +- docs/reference/api/InferenceRerankRequest.md | 2 +- docs/reference/api/InferenceRerankResponse.md | 6 ++-- .../api/InferenceRerankedInferenceResult.md | 2 +- .../reference/api/InferenceServiceSettings.md | 6 ++-- ...InferenceSparseEmbeddingInferenceResult.md | 2 +- .../api/InferenceSparseEmbeddingRequest.md | 2 +- .../api/InferenceSparseEmbeddingResponse.md | 6 ++-- .../api/InferenceSparseEmbeddingResult.md | 2 +- docs/reference/api/InferenceSparseVector.md | 6 ++-- .../api/InferenceStreamCompletionRequest.md | 2 +- .../api/InferenceStreamCompletionResponse.md | 6 ++-- docs/reference/api/InferenceTaskSettings.md | 6 ++-- docs/reference/api/InferenceTaskType.md | 6 ++-- .../api/InferenceTextEmbeddingByteResult.md | 2 +- .../InferenceTextEmbeddingInferenceResult.md | 2 +- .../api/InferenceTextEmbeddingRequest.md | 2 +- .../api/InferenceTextEmbeddingResponse.md | 6 ++-- .../api/InferenceTextEmbeddingResult.md | 2 +- docs/reference/api/InferenceToolCall.md | 2 +- .../api/InferenceToolCallFunction.md | 2 +- docs/reference/api/InferenceUpdateRequest.md | 2 +- docs/reference/api/InferenceUpdateResponse.md | 6 ++-- .../api/InferenceVoyageAIServiceSettings.md | 2 +- .../api/InferenceVoyageAIServiceType.md | 6 ++-- .../api/InferenceVoyageAITaskSettings.md | 2 +- .../api/InferenceVoyageAITaskType.md | 6 ++-- .../api/InferenceWatsonxServiceSettings.md | 2 +- .../api/InferenceWatsonxServiceType.md | 6 ++-- .../reference/api/InferenceWatsonxTaskType.md | 6 ++-- docs/reference/api/InfoApi_1.md | 4 +-- docs/reference/api/InfoApi_2.md | 4 +-- docs/reference/api/InfoApi_3.md | 4 +-- docs/reference/api/InfoRequest.md | 2 +- docs/reference/api/InfoResponse.md | 2 +- docs/reference/api/Ingest.md | 12 ++++---- docs/reference/api/IngestAppendProcessor.md | 2 +- .../api/IngestAttachmentProcessor.md | 2 +- docs/reference/api/IngestBytesProcessor.md | 2 +- docs/reference/api/IngestCircleProcessor.md | 2 +- .../api/IngestCommunityIDProcessor.md | 2 +- docs/reference/api/IngestConvertProcessor.md | 2 +- docs/reference/api/IngestConvertType.md | 6 ++-- docs/reference/api/IngestCsvProcessor.md | 2 +- .../api/IngestDatabaseConfiguration.md | 2 +- .../api/IngestDatabaseConfigurationFull.md | 2 +- .../api/IngestDateIndexNameProcessor.md | 2 +- docs/reference/api/IngestDateProcessor.md | 2 +- .../api/IngestDeleteGeoipDatabaseRequest.md | 2 +- .../api/IngestDeleteGeoipDatabaseResponse.md | 6 ++-- .../IngestDeleteIpLocationDatabaseRequest.md | 2 +- .../IngestDeleteIpLocationDatabaseResponse.md | 6 ++-- .../api/IngestDeletePipelineRequest.md | 2 +- .../api/IngestDeletePipelineResponse.md | 6 ++-- docs/reference/api/IngestDissectProcessor.md | 2 +- docs/reference/api/IngestDocument.md | 2 +- .../reference/api/IngestDocumentSimulation.md | 6 ++-- .../api/IngestDocumentSimulationKeys.md | 2 +- .../api/IngestDotExpanderProcessor.md | 2 +- docs/reference/api/IngestDropProcessor.md | 2 +- docs/reference/api/IngestEnrichProcessor.md | 2 +- docs/reference/api/IngestFailProcessor.md | 2 +- docs/reference/api/IngestFingerprintDigest.md | 6 ++-- .../api/IngestFingerprintProcessor.md | 2 +- docs/reference/api/IngestForeachProcessor.md | 2 +- docs/reference/api/IngestGeoGridProcessor.md | 2 +- .../api/IngestGeoGridTargetFormat.md | 6 ++-- docs/reference/api/IngestGeoGridTileType.md | 6 ++-- docs/reference/api/IngestGeoIpProcessor.md | 2 +- ...IngestGeoIpStatsGeoIpDownloadStatistics.md | 2 +- .../IngestGeoIpStatsGeoIpNodeDatabaseName.md | 2 +- .../api/IngestGeoIpStatsGeoIpNodeDatabases.md | 2 +- docs/reference/api/IngestGeoIpStatsRequest.md | 2 +- .../reference/api/IngestGeoIpStatsResponse.md | 2 +- ...ipDatabaseDatabaseConfigurationMetadata.md | 2 +- .../api/IngestGetGeoipDatabaseRequest.md | 2 +- .../api/IngestGetGeoipDatabaseResponse.md | 2 +- ...onDatabaseDatabaseConfigurationMetadata.md | 2 +- .../api/IngestGetIpLocationDatabaseRequest.md | 2 +- .../IngestGetIpLocationDatabaseResponse.md | 2 +- .../reference/api/IngestGetPipelineRequest.md | 2 +- .../api/IngestGetPipelineResponse.md | 6 ++-- docs/reference/api/IngestGrokProcessor.md | 2 +- docs/reference/api/IngestGsubProcessor.md | 2 +- .../reference/api/IngestHtmlStripProcessor.md | 2 +- docs/reference/api/IngestInferenceConfig.md | 2 +- .../IngestInferenceConfigClassification.md | 2 +- .../api/IngestInferenceConfigRegression.md | 2 +- .../reference/api/IngestInferenceProcessor.md | 2 +- docs/reference/api/IngestIngest.md | 2 +- docs/reference/api/IngestInputConfig.md | 2 +- .../api/IngestIpLocationProcessor.md | 2 +- docs/reference/api/IngestIpinfo.md | 2 +- docs/reference/api/IngestJoinProcessor.md | 2 +- docs/reference/api/IngestJsonProcessor.md | 2 +- .../IngestJsonProcessorConflictStrategy.md | 6 ++-- docs/reference/api/IngestKeyValueProcessor.md | 2 +- docs/reference/api/IngestLocal.md | 2 +- .../reference/api/IngestLowercaseProcessor.md | 2 +- docs/reference/api/IngestMaxmind.md | 2 +- .../api/IngestNetworkDirectionProcessor.md | 2 +- docs/reference/api/IngestPipeline.md | 2 +- docs/reference/api/IngestPipelineConfig.md | 2 +- docs/reference/api/IngestPipelineProcessor.md | 2 +- .../api/IngestPipelineProcessorResult.md | 2 +- .../IngestPipelineSimulationStatusOptions.md | 6 ++-- docs/reference/api/IngestProcessorBase.md | 2 +- .../reference/api/IngestProcessorContainer.md | 2 +- .../api/IngestProcessorGrokRequest.md | 2 +- .../api/IngestProcessorGrokResponse.md | 2 +- .../api/IngestPutGeoipDatabaseRequest.md | 2 +- .../api/IngestPutGeoipDatabaseResponse.md | 6 ++-- .../api/IngestPutIpLocationDatabaseRequest.md | 2 +- .../IngestPutIpLocationDatabaseResponse.md | 6 ++-- .../reference/api/IngestPutPipelineRequest.md | 2 +- .../api/IngestPutPipelineResponse.md | 6 ++-- docs/reference/api/IngestRedact.md | 2 +- docs/reference/api/IngestRedactProcessor.md | 2 +- .../api/IngestRegisteredDomainProcessor.md | 2 +- docs/reference/api/IngestRemoveProcessor.md | 2 +- docs/reference/api/IngestRenameProcessor.md | 2 +- docs/reference/api/IngestRerouteProcessor.md | 2 +- docs/reference/api/IngestScriptProcessor.md | 2 +- docs/reference/api/IngestSetProcessor.md | 2 +- .../api/IngestSetSecurityUserProcessor.md | 2 +- docs/reference/api/IngestShapeType.md | 6 ++-- .../api/IngestSimulateDocumentResult.md | 2 +- docs/reference/api/IngestSimulateRequest.md | 2 +- docs/reference/api/IngestSimulateResponse.md | 2 +- docs/reference/api/IngestSortProcessor.md | 2 +- docs/reference/api/IngestSplitProcessor.md | 2 +- .../reference/api/IngestTerminateProcessor.md | 2 +- docs/reference/api/IngestTrimProcessor.md | 2 +- .../reference/api/IngestUppercaseProcessor.md | 2 +- docs/reference/api/IngestUriPartsProcessor.md | 2 +- .../reference/api/IngestUrlDecodeProcessor.md | 2 +- .../reference/api/IngestUserAgentProcessor.md | 2 +- docs/reference/api/IngestUserAgentProperty.md | 6 ++-- docs/reference/api/IngestWeb.md | 2 +- docs/reference/api/InlineGet.md | 6 ++-- docs/reference/api/InlineGetKeys.md | 2 +- docs/reference/api/Ip.md | 6 ++-- docs/reference/api/KnnQuery.md | 2 +- docs/reference/api/KnnRetriever.md | 2 +- docs/reference/api/KnnSearch.md | 2 +- docs/reference/api/KnnSearchApi_1.md | 4 +-- docs/reference/api/KnnSearchApi_2.md | 4 +-- docs/reference/api/KnnSearchApi_3.md | 4 +-- docs/reference/api/LatLonGeoLocation.md | 2 +- docs/reference/api/Level.md | 6 ++-- docs/reference/api/License.md | 12 ++++---- docs/reference/api/LicenseDeleteRequest.md | 2 +- docs/reference/api/LicenseDeleteResponse.md | 6 ++-- .../api/LicenseGetBasicStatusRequest.md | 2 +- .../api/LicenseGetBasicStatusResponse.md | 2 +- .../api/LicenseGetLicenseInformation.md | 2 +- docs/reference/api/LicenseGetRequest.md | 2 +- docs/reference/api/LicenseGetResponse.md | 2 +- .../api/LicenseGetTrialStatusRequest.md | 2 +- .../api/LicenseGetTrialStatusResponse.md | 2 +- docs/reference/api/LicenseLicense.md | 2 +- docs/reference/api/LicenseLicenseStatus.md | 6 ++-- docs/reference/api/LicenseLicenseType.md | 6 ++-- .../api/LicensePostAcknowledgement.md | 2 +- docs/reference/api/LicensePostRequest.md | 2 +- docs/reference/api/LicensePostResponse.md | 2 +- .../api/LicensePostStartBasicRequest.md | 2 +- .../api/LicensePostStartBasicResponse.md | 2 +- .../api/LicensePostStartTrialRequest.md | 2 +- .../api/LicensePostStartTrialResponse.md | 2 +- docs/reference/api/LifecycleOperationMode.md | 6 ++-- docs/reference/api/Logstash.md | 12 ++++---- .../api/LogstashDeletePipelineRequest.md | 2 +- .../api/LogstashDeletePipelineResponse.md | 6 ++-- .../api/LogstashGetPipelineRequest.md | 2 +- .../api/LogstashGetPipelineResponse.md | 6 ++-- docs/reference/api/LogstashPipeline.md | 2 +- .../reference/api/LogstashPipelineMetadata.md | 2 +- .../reference/api/LogstashPipelineSettings.md | 2 +- .../api/LogstashPutPipelineRequest.md | 2 +- .../api/LogstashPutPipelineResponse.md | 6 ++-- docs/reference/api/MapboxVectorTiles.md | 6 ++-- .../MappingAggregateMetricDoubleProperty.md | 2 +- docs/reference/api/MappingAllField.md | 2 +- docs/reference/api/MappingBinaryProperty.md | 2 +- docs/reference/api/MappingBooleanProperty.md | 2 +- .../api/MappingByteNumberProperty.md | 2 +- docs/reference/api/MappingChunkingSettings.md | 2 +- .../api/MappingCompletionProperty.md | 2 +- .../reference/api/MappingCompositeSubField.md | 2 +- .../api/MappingConstantKeywordProperty.md | 2 +- docs/reference/api/MappingCorePropertyBase.md | 2 +- .../api/MappingCountedKeywordProperty.md | 2 +- .../api/MappingDataStreamTimestamp.md | 2 +- .../reference/api/MappingDateNanosProperty.md | 2 +- docs/reference/api/MappingDateProperty.md | 2 +- .../reference/api/MappingDateRangeProperty.md | 2 +- .../api/MappingDenseVectorElementType.md | 6 ++-- .../api/MappingDenseVectorIndexOptions.md | 2 +- ...ingDenseVectorIndexOptionsRescoreVector.md | 2 +- .../api/MappingDenseVectorIndexOptionsType.md | 6 ++-- .../api/MappingDenseVectorProperty.md | 2 +- .../api/MappingDenseVectorSimilarity.md | 6 ++-- .../api/MappingDocValuesPropertyBase.md | 2 +- .../api/MappingDoubleNumberProperty.md | 2 +- .../api/MappingDoubleRangeProperty.md | 2 +- docs/reference/api/MappingDynamicMapping.md | 6 ++-- docs/reference/api/MappingDynamicProperty.md | 2 +- docs/reference/api/MappingDynamicTemplate.md | 2 +- .../api/MappingFieldAliasProperty.md | 2 +- docs/reference/api/MappingFieldMapping.md | 2 +- docs/reference/api/MappingFieldNamesField.md | 2 +- docs/reference/api/MappingFieldType.md | 6 ++-- .../reference/api/MappingFlattenedProperty.md | 2 +- .../api/MappingFloatNumberProperty.md | 2 +- .../api/MappingFloatRangeProperty.md | 2 +- docs/reference/api/MappingGeoOrientation.md | 6 ++-- docs/reference/api/MappingGeoPointProperty.md | 2 +- docs/reference/api/MappingGeoShapeProperty.md | 2 +- docs/reference/api/MappingGeoStrategy.md | 6 ++-- .../api/MappingHalfFloatNumberProperty.md | 2 +- .../reference/api/MappingHistogramProperty.md | 2 +- .../api/MappingIcuCollationProperty.md | 2 +- docs/reference/api/MappingIndexField.md | 2 +- docs/reference/api/MappingIndexOptions.md | 6 ++-- .../api/MappingIntegerNumberProperty.md | 2 +- .../api/MappingIntegerRangeProperty.md | 2 +- docs/reference/api/MappingIpProperty.md | 2 +- docs/reference/api/MappingIpRangeProperty.md | 2 +- docs/reference/api/MappingJoinProperty.md | 2 +- docs/reference/api/MappingKeywordProperty.md | 2 +- .../api/MappingLongNumberProperty.md | 2 +- .../reference/api/MappingLongRangeProperty.md | 2 +- .../api/MappingMatchOnlyTextProperty.md | 2 +- docs/reference/api/MappingMatchType.md | 6 ++-- .../api/MappingMurmur3HashProperty.md | 2 +- docs/reference/api/MappingNestedProperty.md | 2 +- .../api/MappingNumberPropertyBase.md | 2 +- docs/reference/api/MappingObjectProperty.md | 2 +- docs/reference/api/MappingOnScriptError.md | 6 ++-- .../api/MappingPassthroughObjectProperty.md | 2 +- .../api/MappingPercolatorProperty.md | 2 +- docs/reference/api/MappingPointProperty.md | 2 +- docs/reference/api/MappingProperty.md | 6 ++-- docs/reference/api/MappingPropertyBase.md | 2 +- .../reference/api/MappingRangePropertyBase.md | 2 +- .../api/MappingRankFeatureProperty.md | 2 +- .../api/MappingRankFeaturesProperty.md | 2 +- docs/reference/api/MappingRoutingField.md | 2 +- docs/reference/api/MappingRuntimeField.md | 2 +- .../api/MappingRuntimeFieldFetchFields.md | 2 +- docs/reference/api/MappingRuntimeFieldType.md | 6 ++-- docs/reference/api/MappingRuntimeFields.md | 6 ++-- .../api/MappingScaledFloatNumberProperty.md | 2 +- .../api/MappingSearchAsYouTypeProperty.md | 2 +- .../api/MappingSemanticTextProperty.md | 2 +- docs/reference/api/MappingShapeProperty.md | 2 +- .../api/MappingShortNumberProperty.md | 2 +- docs/reference/api/MappingSizeField.md | 2 +- docs/reference/api/MappingSourceField.md | 2 +- docs/reference/api/MappingSourceFieldMode.md | 6 ++-- .../api/MappingSparseVectorProperty.md | 2 +- docs/reference/api/MappingSubobjects.md | 6 ++-- docs/reference/api/MappingSuggestContext.md | 2 +- .../api/MappingSyntheticSourceKeepEnum.md | 6 ++-- docs/reference/api/MappingTermVectorOption.md | 6 ++-- .../reference/api/MappingTextIndexPrefixes.md | 2 +- docs/reference/api/MappingTextProperty.md | 2 +- .../api/MappingTimeSeriesMetricType.md | 6 ++-- .../api/MappingTokenCountProperty.md | 2 +- docs/reference/api/MappingTypeMapping.md | 2 +- .../api/MappingUnsignedLongNumberProperty.md | 2 +- docs/reference/api/MappingVersionProperty.md | 2 +- docs/reference/api/MappingWildcardProperty.md | 2 +- docs/reference/api/MergesStats.md | 2 +- docs/reference/api/Metadata.md | 6 ++-- docs/reference/api/Metrics.md | 6 ++-- docs/reference/api/MgetApi_1.md | 4 +-- docs/reference/api/MgetApi_2.md | 4 +-- docs/reference/api/MgetApi_3.md | 4 +-- docs/reference/api/MgetMultiGetError.md | 2 +- docs/reference/api/MgetOperation.md | 2 +- docs/reference/api/MgetRequest.md | 2 +- docs/reference/api/MgetResponse.md | 2 +- docs/reference/api/MgetResponseItem.md | 6 ++-- docs/reference/api/Migration.md | 12 ++++---- .../api/MigrationDeprecationsDeprecation.md | 2 +- .../MigrationDeprecationsDeprecationLevel.md | 6 ++-- .../api/MigrationDeprecationsRequest.md | 2 +- .../api/MigrationDeprecationsResponse.md | 2 +- ...GetFeatureUpgradeStatusMigrationFeature.md | 2 +- ...eUpgradeStatusMigrationFeatureIndexInfo.md | 2 +- ...nGetFeatureUpgradeStatusMigrationStatus.md | 6 ++-- ...MigrationGetFeatureUpgradeStatusRequest.md | 2 +- ...igrationGetFeatureUpgradeStatusResponse.md | 2 +- ...ationPostFeatureUpgradeMigrationFeature.md | 2 +- .../api/MigrationPostFeatureUpgradeRequest.md | 2 +- .../MigrationPostFeatureUpgradeResponse.md | 2 +- docs/reference/api/MinimumShouldMatch.md | 6 ++-- docs/reference/api/Ml.md | 12 ++++---- .../api/MlAdaptiveAllocationsSettings.md | 2 +- docs/reference/api/MlAnalysisConfig.md | 2 +- docs/reference/api/MlAnalysisConfigRead.md | 2 +- docs/reference/api/MlAnalysisLimits.md | 2 +- docs/reference/api/MlAnalysisMemoryLimit.md | 2 +- docs/reference/api/MlAnomaly.md | 2 +- docs/reference/api/MlAnomalyCause.md | 2 +- docs/reference/api/MlAnomalyExplanation.md | 2 +- docs/reference/api/MlApiKeyAuthorization.md | 2 +- docs/reference/api/MlAppliesTo.md | 6 ++-- docs/reference/api/MlBucketInfluencer.md | 2 +- docs/reference/api/MlBucketSummary.md | 2 +- docs/reference/api/MlCalendarEvent.md | 2 +- .../reference/api/MlCategorizationAnalyzer.md | 6 ++-- .../api/MlCategorizationAnalyzerDefinition.md | 2 +- docs/reference/api/MlCategorizationStatus.md | 6 ++-- docs/reference/api/MlCategory.md | 2 +- docs/reference/api/MlChunkingConfig.md | 2 +- docs/reference/api/MlChunkingMode.md | 6 ++-- .../api/MlClassificationInferenceOptions.md | 2 +- ...ClearTrainedModelDeploymentCacheRequest.md | 2 +- ...learTrainedModelDeploymentCacheResponse.md | 2 +- docs/reference/api/MlCloseJobRequest.md | 2 +- docs/reference/api/MlCloseJobResponse.md | 2 +- .../api/MlCommonTokenizationConfig.md | 2 +- docs/reference/api/MlConditionOperator.md | 6 ++-- docs/reference/api/MlCustomSettings.md | 6 ++-- docs/reference/api/MlDataCounts.md | 2 +- docs/reference/api/MlDataDescription.md | 2 +- docs/reference/api/MlDatafeed.md | 2 +- docs/reference/api/MlDatafeedAuthorization.md | 2 +- docs/reference/api/MlDatafeedConfig.md | 2 +- docs/reference/api/MlDatafeedRunningState.md | 2 +- docs/reference/api/MlDatafeedState.md | 6 ++-- docs/reference/api/MlDatafeedStats.md | 2 +- docs/reference/api/MlDatafeedTimingStats.md | 2 +- docs/reference/api/MlDataframeAnalysis.md | 2 +- .../api/MlDataframeAnalysisAnalyzedFields.md | 2 +- .../api/MlDataframeAnalysisClassification.md | 2 +- .../api/MlDataframeAnalysisContainer.md | 2 +- .../MlDataframeAnalysisFeatureProcessor.md | 2 +- ...alysisFeatureProcessorFrequencyEncoding.md | 2 +- ...meAnalysisFeatureProcessorMultiEncoding.md | 2 +- ...meAnalysisFeatureProcessorNGramEncoding.md | 2 +- ...eAnalysisFeatureProcessorOneHotEncoding.md | 2 +- ...lysisFeatureProcessorTargetMeanEncoding.md | 2 +- .../MlDataframeAnalysisOutlierDetection.md | 2 +- .../api/MlDataframeAnalysisRegression.md | 2 +- docs/reference/api/MlDataframeAnalytics.md | 2 +- .../api/MlDataframeAnalyticsAuthorization.md | 2 +- .../api/MlDataframeAnalyticsDestination.md | 2 +- .../api/MlDataframeAnalyticsFieldSelection.md | 2 +- .../MlDataframeAnalyticsMemoryEstimation.md | 2 +- .../api/MlDataframeAnalyticsSource.md | 2 +- .../api/MlDataframeAnalyticsStatsContainer.md | 2 +- .../MlDataframeAnalyticsStatsDataCounts.md | 2 +- ...lDataframeAnalyticsStatsHyperparameters.md | 2 +- .../MlDataframeAnalyticsStatsMemoryUsage.md | 2 +- ...DataframeAnalyticsStatsOutlierDetection.md | 2 +- .../api/MlDataframeAnalyticsStatsProgress.md | 2 +- .../api/MlDataframeAnalyticsSummary.md | 2 +- .../MlDataframeEvaluationClassification.md | 2 +- ...ataframeEvaluationClassificationMetrics.md | 2 +- ...meEvaluationClassificationMetricsAucRoc.md | 2 +- .../api/MlDataframeEvaluationContainer.md | 2 +- .../api/MlDataframeEvaluationMetrics.md | 2 +- .../MlDataframeEvaluationOutlierDetection.md | 2 +- ...aframeEvaluationOutlierDetectionMetrics.md | 2 +- .../api/MlDataframeEvaluationRegression.md | 2 +- .../MlDataframeEvaluationRegressionMetrics.md | 2 +- ...taframeEvaluationRegressionMetricsHuber.md | 2 +- ...ataframeEvaluationRegressionMetricsMsle.md | 2 +- docs/reference/api/MlDataframeState.md | 6 ++-- .../reference/api/MlDelayedDataCheckConfig.md | 2 +- .../api/MlDeleteCalendarEventRequest.md | 2 +- .../api/MlDeleteCalendarEventResponse.md | 6 ++-- .../api/MlDeleteCalendarJobRequest.md | 2 +- .../api/MlDeleteCalendarJobResponse.md | 2 +- docs/reference/api/MlDeleteCalendarRequest.md | 2 +- .../reference/api/MlDeleteCalendarResponse.md | 6 ++-- .../api/MlDeleteDataFrameAnalyticsRequest.md | 2 +- .../api/MlDeleteDataFrameAnalyticsResponse.md | 6 ++-- docs/reference/api/MlDeleteDatafeedRequest.md | 2 +- .../reference/api/MlDeleteDatafeedResponse.md | 6 ++-- .../api/MlDeleteExpiredDataRequest.md | 2 +- .../api/MlDeleteExpiredDataResponse.md | 2 +- docs/reference/api/MlDeleteFilterRequest.md | 2 +- docs/reference/api/MlDeleteFilterResponse.md | 6 ++-- docs/reference/api/MlDeleteForecastRequest.md | 2 +- .../reference/api/MlDeleteForecastResponse.md | 6 ++-- docs/reference/api/MlDeleteJobRequest.md | 2 +- docs/reference/api/MlDeleteJobResponse.md | 6 ++-- .../api/MlDeleteModelSnapshotRequest.md | 2 +- .../api/MlDeleteModelSnapshotResponse.md | 6 ++-- .../api/MlDeleteTrainedModelAliasRequest.md | 2 +- .../api/MlDeleteTrainedModelAliasResponse.md | 6 ++-- .../api/MlDeleteTrainedModelRequest.md | 2 +- .../api/MlDeleteTrainedModelResponse.md | 6 ++-- .../api/MlDeploymentAllocationState.md | 6 ++-- .../api/MlDeploymentAssignmentState.md | 6 ++-- docs/reference/api/MlDetectionRule.md | 2 +- docs/reference/api/MlDetector.md | 2 +- docs/reference/api/MlDetectorRead.md | 2 +- docs/reference/api/MlDetectorUpdate.md | 2 +- docs/reference/api/MlDiscoveryNode.md | 6 ++-- docs/reference/api/MlDiscoveryNodeCompact.md | 2 +- docs/reference/api/MlDiscoveryNodeContent.md | 2 +- .../api/MlEstimateModelMemoryRequest.md | 2 +- .../api/MlEstimateModelMemoryResponse.md | 2 +- .../MlEvaluateDataFrameConfusionMatrixItem.md | 2 +- ...luateDataFrameConfusionMatrixPrediction.md | 2 +- ...aluateDataFrameConfusionMatrixThreshold.md | 2 +- ...DataFrameDataframeClassificationSummary.md | 2 +- ...eDataframeClassificationSummaryAccuracy.md | 2 +- ...icationSummaryMulticlassConfusionMatrix.md | 2 +- ...DataframeClassificationSummaryPrecision.md | 2 +- ...ameDataframeClassificationSummaryRecall.md | 2 +- ...aluateDataFrameDataframeEvaluationClass.md | 2 +- ...taFrameDataframeEvaluationSummaryAucRoc.md | 2 +- ...taframeEvaluationSummaryAucRocCurveItem.md | 2 +- ...aluateDataFrameDataframeEvaluationValue.md | 2 +- ...taFrameDataframeOutlierDetectionSummary.md | 2 +- ...uateDataFrameDataframeRegressionSummary.md | 2 +- .../api/MlEvaluateDataFrameRequest.md | 2 +- .../api/MlEvaluateDataFrameResponse.md | 2 +- docs/reference/api/MlExcludeFrequent.md | 6 ++-- .../api/MlExplainDataFrameAnalyticsRequest.md | 2 +- .../MlExplainDataFrameAnalyticsResponse.md | 2 +- .../MlExponentialAverageCalculationContext.md | 2 +- docs/reference/api/MlFeatureExtractor.md | 6 ++-- .../api/MlFillMaskInferenceOptions.md | 2 +- .../api/MlFillMaskInferenceUpdateOptions.md | 2 +- docs/reference/api/MlFilter.md | 2 +- docs/reference/api/MlFilterRef.md | 2 +- docs/reference/api/MlFilterType.md | 6 ++-- docs/reference/api/MlFlushJobRequest.md | 2 +- docs/reference/api/MlFlushJobResponse.md | 2 +- docs/reference/api/MlForecastRequest.md | 2 +- docs/reference/api/MlForecastResponse.md | 2 +- docs/reference/api/MlGeoResults.md | 2 +- docs/reference/api/MlGetBucketsRequest.md | 2 +- docs/reference/api/MlGetBucketsResponse.md | 2 +- .../api/MlGetCalendarEventsRequest.md | 2 +- .../api/MlGetCalendarEventsResponse.md | 2 +- docs/reference/api/MlGetCalendarsCalendar.md | 2 +- docs/reference/api/MlGetCalendarsRequest.md | 2 +- docs/reference/api/MlGetCalendarsResponse.md | 2 +- docs/reference/api/MlGetCategoriesRequest.md | 2 +- docs/reference/api/MlGetCategoriesResponse.md | 2 +- .../api/MlGetDataFrameAnalyticsRequest.md | 2 +- .../api/MlGetDataFrameAnalyticsResponse.md | 2 +- .../MlGetDataFrameAnalyticsStatsRequest.md | 2 +- .../MlGetDataFrameAnalyticsStatsResponse.md | 2 +- .../api/MlGetDatafeedStatsRequest.md | 2 +- .../api/MlGetDatafeedStatsResponse.md | 2 +- docs/reference/api/MlGetDatafeedsRequest.md | 2 +- docs/reference/api/MlGetDatafeedsResponse.md | 2 +- docs/reference/api/MlGetFiltersRequest.md | 2 +- docs/reference/api/MlGetFiltersResponse.md | 2 +- docs/reference/api/MlGetInfluencersRequest.md | 2 +- .../reference/api/MlGetInfluencersResponse.md | 2 +- docs/reference/api/MlGetJobStatsRequest.md | 2 +- docs/reference/api/MlGetJobStatsResponse.md | 2 +- docs/reference/api/MlGetJobsRequest.md | 2 +- docs/reference/api/MlGetJobsResponse.md | 2 +- .../reference/api/MlGetMemoryStatsJvmStats.md | 2 +- .../api/MlGetMemoryStatsMemMlStats.md | 2 +- .../reference/api/MlGetMemoryStatsMemStats.md | 2 +- docs/reference/api/MlGetMemoryStatsMemory.md | 2 +- docs/reference/api/MlGetMemoryStatsRequest.md | 2 +- .../reference/api/MlGetMemoryStatsResponse.md | 2 +- .../MlGetModelSnapshotUpgradeStatsRequest.md | 2 +- .../MlGetModelSnapshotUpgradeStatsResponse.md | 2 +- .../api/MlGetModelSnapshotsRequest.md | 2 +- .../api/MlGetModelSnapshotsResponse.md | 2 +- .../api/MlGetOverallBucketsRequest.md | 2 +- .../api/MlGetOverallBucketsResponse.md | 2 +- docs/reference/api/MlGetRecordsRequest.md | 2 +- docs/reference/api/MlGetRecordsResponse.md | 2 +- .../api/MlGetTrainedModelsRequest.md | 2 +- .../api/MlGetTrainedModelsResponse.md | 2 +- .../api/MlGetTrainedModelsStatsRequest.md | 2 +- .../api/MlGetTrainedModelsStatsResponse.md | 2 +- docs/reference/api/MlHyperparameter.md | 2 +- docs/reference/api/MlHyperparameters.md | 2 +- docs/reference/api/MlInclude.md | 6 ++-- .../api/MlInferTrainedModelRequest.md | 2 +- .../api/MlInferTrainedModelResponse.md | 2 +- .../api/MlInferenceConfigCreateContainer.md | 2 +- .../api/MlInferenceConfigUpdateContainer.md | 2 +- .../api/MlInferenceResponseResult.md | 2 +- docs/reference/api/MlInfluence.md | 2 +- docs/reference/api/MlInfluencer.md | 2 +- docs/reference/api/MlInfoAnomalyDetectors.md | 2 +- docs/reference/api/MlInfoDatafeeds.md | 2 +- docs/reference/api/MlInfoDefaults.md | 2 +- docs/reference/api/MlInfoLimits.md | 2 +- docs/reference/api/MlInfoNativeCode.md | 2 +- docs/reference/api/MlInfoRequest.md | 2 +- docs/reference/api/MlInfoResponse.md | 2 +- docs/reference/api/MlJob.md | 2 +- docs/reference/api/MlJobBlocked.md | 2 +- docs/reference/api/MlJobBlockedReason.md | 6 ++-- docs/reference/api/MlJobConfig.md | 2 +- docs/reference/api/MlJobForecastStatistics.md | 2 +- docs/reference/api/MlJobState.md | 6 ++-- docs/reference/api/MlJobStatistics.md | 2 +- docs/reference/api/MlJobStats.md | 2 +- docs/reference/api/MlJobTimingStats.md | 2 +- docs/reference/api/MlLearningToRankConfig.md | 2 +- docs/reference/api/MlMemoryStatus.md | 6 ++-- docs/reference/api/MlModelPackageConfig.md | 2 +- docs/reference/api/MlModelPlotConfig.md | 2 +- docs/reference/api/MlModelSizeStats.md | 2 +- docs/reference/api/MlModelSnapshot.md | 2 +- docs/reference/api/MlModelSnapshotUpgrade.md | 2 +- docs/reference/api/MlNerInferenceOptions.md | 2 +- .../api/MlNerInferenceUpdateOptions.md | 2 +- .../api/MlNlpBertTokenizationConfig.md | 2 +- .../api/MlNlpRobertaTokenizationConfig.md | 2 +- .../api/MlNlpTokenizationUpdateOptions.md | 2 +- docs/reference/api/MlOpenJobRequest.md | 2 +- docs/reference/api/MlOpenJobResponse.md | 2 +- .../api/MlOutlierDetectionParameters.md | 2 +- docs/reference/api/MlOverallBucket.md | 2 +- docs/reference/api/MlOverallBucketJob.md | 2 +- docs/reference/api/MlPage.md | 2 +- .../api/MlPassThroughInferenceOptions.md | 2 +- .../MlPassThroughInferenceUpdateOptions.md | 2 +- .../api/MlPerPartitionCategorization.md | 2 +- .../api/MlPostCalendarEventsRequest.md | 2 +- .../api/MlPostCalendarEventsResponse.md | 2 +- docs/reference/api/MlPostDataRequest.md | 2 +- docs/reference/api/MlPostDataResponse.md | 2 +- docs/reference/api/MlPredictedValue.md | 6 ++-- ...ataFrameAnalyticsDataframePreviewConfig.md | 2 +- .../api/MlPreviewDataFrameAnalyticsRequest.md | 2 +- .../MlPreviewDataFrameAnalyticsResponse.md | 2 +- .../reference/api/MlPreviewDatafeedRequest.md | 2 +- .../api/MlPreviewDatafeedResponse.md | 6 ++-- docs/reference/api/MlPutCalendarJobRequest.md | 2 +- .../reference/api/MlPutCalendarJobResponse.md | 2 +- docs/reference/api/MlPutCalendarRequest.md | 2 +- docs/reference/api/MlPutCalendarResponse.md | 2 +- .../api/MlPutDataFrameAnalyticsRequest.md | 2 +- .../api/MlPutDataFrameAnalyticsResponse.md | 2 +- docs/reference/api/MlPutDatafeedRequest.md | 2 +- docs/reference/api/MlPutDatafeedResponse.md | 2 +- docs/reference/api/MlPutFilterRequest.md | 2 +- docs/reference/api/MlPutFilterResponse.md | 2 +- docs/reference/api/MlPutJobRequest.md | 2 +- docs/reference/api/MlPutJobResponse.md | 2 +- .../api/MlPutTrainedModelAggregateOutput.md | 2 +- .../api/MlPutTrainedModelAliasRequest.md | 2 +- .../api/MlPutTrainedModelAliasResponse.md | 6 ++-- .../api/MlPutTrainedModelDefinition.md | 2 +- .../MlPutTrainedModelDefinitionPartRequest.md | 2 +- ...MlPutTrainedModelDefinitionPartResponse.md | 6 ++-- .../api/MlPutTrainedModelEnsemble.md | 2 +- ...ainedModelFrequencyEncodingPreprocessor.md | 2 +- docs/reference/api/MlPutTrainedModelInput.md | 2 +- ...tTrainedModelOneHotEncodingPreprocessor.md | 2 +- .../api/MlPutTrainedModelPreprocessor.md | 2 +- .../reference/api/MlPutTrainedModelRequest.md | 2 +- .../api/MlPutTrainedModelResponse.md | 6 ++-- ...inedModelTargetMeanEncodingPreprocessor.md | 2 +- .../api/MlPutTrainedModelTrainedModel.md | 2 +- .../api/MlPutTrainedModelTrainedModelTree.md | 2 +- .../MlPutTrainedModelTrainedModelTreeNode.md | 2 +- .../api/MlPutTrainedModelVocabularyRequest.md | 2 +- .../MlPutTrainedModelVocabularyResponse.md | 6 ++-- .../reference/api/MlPutTrainedModelWeights.md | 2 +- docs/reference/api/MlQueryFeatureExtractor.md | 2 +- .../MlQuestionAnsweringInferenceOptions.md | 2 +- ...QuestionAnsweringInferenceUpdateOptions.md | 2 +- .../api/MlRegressionInferenceOptions.md | 2 +- docs/reference/api/MlResetJobRequest.md | 2 +- docs/reference/api/MlResetJobResponse.md | 6 ++-- .../api/MlRevertModelSnapshotRequest.md | 2 +- .../api/MlRevertModelSnapshotResponse.md | 2 +- docs/reference/api/MlRoutingState.md | 6 ++-- docs/reference/api/MlRuleAction.md | 6 ++-- docs/reference/api/MlRuleCondition.md | 2 +- .../api/MlRunningStateSearchInterval.md | 2 +- docs/reference/api/MlSetUpgradeModeRequest.md | 2 +- .../reference/api/MlSetUpgradeModeResponse.md | 6 ++-- docs/reference/api/MlSnapshotUpgradeState.md | 6 ++-- .../api/MlStartDataFrameAnalyticsRequest.md | 2 +- .../api/MlStartDataFrameAnalyticsResponse.md | 2 +- docs/reference/api/MlStartDatafeedRequest.md | 2 +- docs/reference/api/MlStartDatafeedResponse.md | 2 +- .../MlStartTrainedModelDeploymentRequest.md | 2 +- .../MlStartTrainedModelDeploymentResponse.md | 2 +- .../api/MlStopDataFrameAnalyticsRequest.md | 2 +- .../api/MlStopDataFrameAnalyticsResponse.md | 2 +- docs/reference/api/MlStopDatafeedRequest.md | 2 +- docs/reference/api/MlStopDatafeedResponse.md | 2 +- .../MlStopTrainedModelDeploymentRequest.md | 2 +- .../MlStopTrainedModelDeploymentResponse.md | 2 +- .../MlTextClassificationInferenceOptions.md | 2 +- ...extClassificationInferenceUpdateOptions.md | 2 +- .../api/MlTextEmbeddingInferenceOptions.md | 2 +- .../MlTextEmbeddingInferenceUpdateOptions.md | 2 +- .../api/MlTextExpansionInferenceOptions.md | 2 +- .../MlTextExpansionInferenceUpdateOptions.md | 2 +- docs/reference/api/MlTimingStats.md | 2 +- .../api/MlTokenizationConfigContainer.md | 2 +- docs/reference/api/MlTokenizationTruncate.md | 6 ++-- docs/reference/api/MlTopClassEntry.md | 2 +- .../reference/api/MlTotalFeatureImportance.md | 2 +- .../api/MlTotalFeatureImportanceClass.md | 2 +- .../api/MlTotalFeatureImportanceStatistics.md | 2 +- .../reference/api/MlTrainedModelAssignment.md | 2 +- ...nedModelAssignmentRoutingStateAndReason.md | 2 +- .../MlTrainedModelAssignmentRoutingTable.md | 2 +- .../MlTrainedModelAssignmentTaskParameters.md | 2 +- docs/reference/api/MlTrainedModelConfig.md | 2 +- .../api/MlTrainedModelConfigInput.md | 2 +- .../api/MlTrainedModelConfigMetadata.md | 2 +- ...lTrainedModelDeploymentAllocationStatus.md | 2 +- .../api/MlTrainedModelDeploymentNodesStats.md | 2 +- .../api/MlTrainedModelDeploymentStats.md | 2 +- docs/reference/api/MlTrainedModelEntities.md | 2 +- .../MlTrainedModelInferenceClassImportance.md | 2 +- ...lTrainedModelInferenceFeatureImportance.md | 2 +- .../api/MlTrainedModelInferenceStats.md | 2 +- docs/reference/api/MlTrainedModelLocation.md | 2 +- .../api/MlTrainedModelLocationIndex.md | 2 +- .../api/MlTrainedModelPrefixStrings.md | 2 +- docs/reference/api/MlTrainedModelSizeStats.md | 2 +- docs/reference/api/MlTrainedModelStats.md | 2 +- docs/reference/api/MlTrainedModelType.md | 6 ++-- docs/reference/api/MlTrainingPriority.md | 6 ++-- .../reference/api/MlTransformAuthorization.md | 2 +- .../api/MlUpdateDataFrameAnalyticsRequest.md | 2 +- .../api/MlUpdateDataFrameAnalyticsResponse.md | 2 +- docs/reference/api/MlUpdateDatafeedRequest.md | 2 +- .../reference/api/MlUpdateDatafeedResponse.md | 2 +- docs/reference/api/MlUpdateFilterRequest.md | 2 +- docs/reference/api/MlUpdateFilterResponse.md | 2 +- docs/reference/api/MlUpdateJobRequest.md | 2 +- docs/reference/api/MlUpdateJobResponse.md | 2 +- .../api/MlUpdateModelSnapshotRequest.md | 2 +- .../api/MlUpdateModelSnapshotResponse.md | 2 +- .../MlUpdateTrainedModelDeploymentRequest.md | 2 +- .../MlUpdateTrainedModelDeploymentResponse.md | 2 +- .../api/MlUpgradeJobSnapshotRequest.md | 2 +- .../api/MlUpgradeJobSnapshotResponse.md | 2 +- .../api/MlValidateDetectorRequest.md | 2 +- .../api/MlValidateDetectorResponse.md | 6 ++-- docs/reference/api/MlValidateRequest.md | 2 +- docs/reference/api/MlValidateResponse.md | 6 ++-- docs/reference/api/MlValidationLoss.md | 2 +- docs/reference/api/MlVocabulary.md | 2 +- .../api/MlXlmRobertaTokenizationConfig.md | 2 +- ...lZeroShotClassificationInferenceOptions.md | 2 +- ...hotClassificationInferenceUpdateOptions.md | 2 +- docs/reference/api/Monitoring.md | 12 ++++---- docs/reference/api/MonitoringBulkRequest.md | 2 +- docs/reference/api/MonitoringBulkResponse.md | 2 +- docs/reference/api/MsearchApi_1.md | 4 +-- docs/reference/api/MsearchApi_2.md | 4 +-- docs/reference/api/MsearchApi_3.md | 4 +-- docs/reference/api/MsearchHelper.md | 2 +- docs/reference/api/MsearchHelperOptions.md | 2 +- docs/reference/api/MsearchHelperResponse.md | 2 +- docs/reference/api/MsearchMultiSearchItem.md | 2 +- .../reference/api/MsearchMultiSearchResult.md | 2 +- .../reference/api/MsearchMultisearchHeader.md | 2 +- docs/reference/api/MsearchRequest.md | 2 +- docs/reference/api/MsearchRequestItem.md | 6 ++-- docs/reference/api/MsearchResponse.md | 6 ++-- docs/reference/api/MsearchResponseItem.md | 6 ++-- docs/reference/api/MsearchTemplateApi_1.md | 4 +-- docs/reference/api/MsearchTemplateApi_2.md | 4 +-- docs/reference/api/MsearchTemplateApi_3.md | 4 +-- docs/reference/api/MsearchTemplateRequest.md | 2 +- .../api/MsearchTemplateRequestItem.md | 6 ++-- docs/reference/api/MsearchTemplateResponse.md | 6 ++-- .../api/MsearchTemplateTemplateConfig.md | 2 +- docs/reference/api/MtermvectorsApi_1.md | 4 +-- docs/reference/api/MtermvectorsApi_2.md | 4 +-- docs/reference/api/MtermvectorsApi_3.md | 4 +-- docs/reference/api/MtermvectorsOperation.md | 2 +- docs/reference/api/MtermvectorsRequest.md | 2 +- docs/reference/api/MtermvectorsResponse.md | 2 +- .../api/MtermvectorsTermVectorsResult.md | 2 +- docs/reference/api/MultiTermQueryRewrite.md | 6 ++-- docs/reference/api/Name.md | 6 ++-- docs/reference/api/Names.md | 6 ++-- docs/reference/api/Namespace.md | 6 ++-- docs/reference/api/NestedSortValue.md | 2 +- docs/reference/api/NodeAttributes.md | 2 +- docs/reference/api/NodeId.md | 6 ++-- docs/reference/api/NodeIds.md | 6 ++-- docs/reference/api/NodeName.md | 6 ++-- docs/reference/api/NodeOptions.md | 2 +- docs/reference/api/NodeRole.md | 6 ++-- docs/reference/api/NodeRoles.md | 6 ++-- docs/reference/api/NodeShard.md | 2 +- docs/reference/api/NodeStatistics.md | 2 +- docs/reference/api/Nodes.md | 12 ++++---- docs/reference/api/NodesAdaptiveSelection.md | 2 +- docs/reference/api/NodesBreaker.md | 2 +- docs/reference/api/NodesCgroup.md | 2 +- docs/reference/api/NodesCgroupCpu.md | 2 +- docs/reference/api/NodesCgroupCpuStat.md | 2 +- docs/reference/api/NodesCgroupMemory.md | 2 +- ...ClearRepositoriesMeteringArchiveRequest.md | 2 +- ...learRepositoriesMeteringArchiveResponse.md | 6 ++-- ...RepositoriesMeteringArchiveResponseBase.md | 2 +- docs/reference/api/NodesClient.md | 2 +- .../reference/api/NodesClusterAppliedStats.md | 2 +- docs/reference/api/NodesClusterStateQueue.md | 2 +- docs/reference/api/NodesClusterStateUpdate.md | 2 +- docs/reference/api/NodesContext.md | 2 +- docs/reference/api/NodesCpu.md | 2 +- docs/reference/api/NodesCpuAcct.md | 2 +- docs/reference/api/NodesDataPathStats.md | 2 +- docs/reference/api/NodesDiscovery.md | 2 +- .../reference/api/NodesExtendedMemoryStats.md | 2 +- docs/reference/api/NodesFileSystem.md | 2 +- docs/reference/api/NodesFileSystemTotal.md | 2 +- docs/reference/api/NodesGarbageCollector.md | 2 +- .../api/NodesGarbageCollectorTotal.md | 2 +- ...NodesGetRepositoriesMeteringInfoRequest.md | 2 +- ...odesGetRepositoriesMeteringInfoResponse.md | 6 ++-- ...GetRepositoriesMeteringInfoResponseBase.md | 2 +- docs/reference/api/NodesHotThreadsRequest.md | 2 +- docs/reference/api/NodesHotThreadsResponse.md | 2 +- docs/reference/api/NodesHttp.md | 2 +- docs/reference/api/NodesHttpRoute.md | 2 +- docs/reference/api/NodesHttpRouteRequests.md | 2 +- docs/reference/api/NodesHttpRouteResponses.md | 2 +- docs/reference/api/NodesIndexingPressure.md | 2 +- .../api/NodesIndexingPressureMemory.md | 2 +- .../api/NodesInfoDeprecationIndexing.md | 2 +- docs/reference/api/NodesInfoNodeInfo.md | 2 +- docs/reference/api/NodesInfoNodeInfoAction.md | 2 +- .../api/NodesInfoNodeInfoAggregation.md | 2 +- .../api/NodesInfoNodeInfoBootstrap.md | 2 +- docs/reference/api/NodesInfoNodeInfoClient.md | 2 +- .../api/NodesInfoNodeInfoDiscover.md | 6 ++-- .../api/NodesInfoNodeInfoDiscoverKeys.md | 2 +- docs/reference/api/NodesInfoNodeInfoHttp.md | 2 +- docs/reference/api/NodesInfoNodeInfoIngest.md | 2 +- .../api/NodesInfoNodeInfoIngestDownloader.md | 2 +- .../api/NodesInfoNodeInfoIngestInfo.md | 2 +- .../api/NodesInfoNodeInfoIngestProcessor.md | 2 +- .../api/NodesInfoNodeInfoJvmMemory.md | 2 +- docs/reference/api/NodesInfoNodeInfoMemory.md | 2 +- .../reference/api/NodesInfoNodeInfoNetwork.md | 2 +- .../api/NodesInfoNodeInfoNetworkInterface.md | 2 +- docs/reference/api/NodesInfoNodeInfoOSCPU.md | 2 +- docs/reference/api/NodesInfoNodeInfoPath.md | 2 +- .../api/NodesInfoNodeInfoRepositories.md | 2 +- .../api/NodesInfoNodeInfoRepositoriesUrl.md | 2 +- docs/reference/api/NodesInfoNodeInfoScript.md | 2 +- docs/reference/api/NodesInfoNodeInfoSearch.md | 2 +- .../api/NodesInfoNodeInfoSearchRemote.md | 2 +- .../api/NodesInfoNodeInfoSettings.md | 2 +- .../api/NodesInfoNodeInfoSettingsCluster.md | 2 +- ...odesInfoNodeInfoSettingsClusterElection.md | 2 +- .../api/NodesInfoNodeInfoSettingsHttp.md | 2 +- .../api/NodesInfoNodeInfoSettingsHttpType.md | 2 +- .../api/NodesInfoNodeInfoSettingsIngest.md | 2 +- .../api/NodesInfoNodeInfoSettingsNetwork.md | 2 +- .../api/NodesInfoNodeInfoSettingsNode.md | 2 +- .../api/NodesInfoNodeInfoSettingsTransport.md | 2 +- ...esInfoNodeInfoSettingsTransportFeatures.md | 2 +- .../NodesInfoNodeInfoSettingsTransportType.md | 2 +- .../api/NodesInfoNodeInfoTransport.md | 2 +- docs/reference/api/NodesInfoNodeInfoXpack.md | 2 +- .../api/NodesInfoNodeInfoXpackLicense.md | 2 +- .../api/NodesInfoNodeInfoXpackLicenseType.md | 2 +- .../reference/api/NodesInfoNodeInfoXpackMl.md | 2 +- .../api/NodesInfoNodeInfoXpackSecurity.md | 2 +- .../NodesInfoNodeInfoXpackSecurityAuthc.md | 2 +- ...desInfoNodeInfoXpackSecurityAuthcRealms.md | 2 +- ...oNodeInfoXpackSecurityAuthcRealmsStatus.md | 2 +- ...odesInfoNodeInfoXpackSecurityAuthcToken.md | 2 +- .../api/NodesInfoNodeInfoXpackSecuritySsl.md | 2 +- docs/reference/api/NodesInfoNodeJvmInfo.md | 2 +- .../api/NodesInfoNodeOperatingSystemInfo.md | 2 +- .../reference/api/NodesInfoNodeProcessInfo.md | 2 +- .../api/NodesInfoNodeThreadPoolInfo.md | 2 +- docs/reference/api/NodesInfoRequest.md | 2 +- docs/reference/api/NodesInfoResponse.md | 6 ++-- docs/reference/api/NodesInfoResponseBase.md | 2 +- docs/reference/api/NodesIngest.md | 2 +- docs/reference/api/NodesIngestStats.md | 2 +- docs/reference/api/NodesIngestTotal.md | 2 +- docs/reference/api/NodesIoStatDevice.md | 2 +- docs/reference/api/NodesIoStats.md | 2 +- docs/reference/api/NodesJvm.md | 2 +- docs/reference/api/NodesJvmClasses.md | 2 +- docs/reference/api/NodesJvmMemoryStats.md | 2 +- docs/reference/api/NodesJvmThreads.md | 2 +- docs/reference/api/NodesKeyedProcessor.md | 2 +- docs/reference/api/NodesMemoryStats.md | 2 +- docs/reference/api/NodesNodeBufferPool.md | 2 +- docs/reference/api/NodesNodeReloadResult.md | 2 +- docs/reference/api/NodesNodesResponseBase.md | 2 +- docs/reference/api/NodesOperatingSystem.md | 2 +- docs/reference/api/NodesPool.md | 2 +- docs/reference/api/NodesPressureMemory.md | 2 +- docs/reference/api/NodesProcess.md | 2 +- docs/reference/api/NodesProcessor.md | 2 +- .../api/NodesPublishedClusterStates.md | 2 +- docs/reference/api/NodesRecording.md | 2 +- .../api/NodesReloadSecureSettingsRequest.md | 2 +- .../api/NodesReloadSecureSettingsResponse.md | 6 ++-- .../NodesReloadSecureSettingsResponseBase.md | 2 +- docs/reference/api/NodesRepositoryLocation.md | 2 +- .../api/NodesRepositoryMeteringInformation.md | 2 +- docs/reference/api/NodesRequestCounts.md | 2 +- docs/reference/api/NodesScriptCache.md | 2 +- docs/reference/api/NodesScripting.md | 2 +- .../api/NodesSerializedClusterState.md | 2 +- .../api/NodesSerializedClusterStateDetail.md | 2 +- docs/reference/api/NodesSizeHttpHistogram.md | 2 +- docs/reference/api/NodesStats.md | 2 +- docs/reference/api/NodesStatsRequest.md | 2 +- docs/reference/api/NodesStatsResponse.md | 6 ++-- docs/reference/api/NodesStatsResponseBase.md | 2 +- docs/reference/api/NodesThreadCount.md | 2 +- docs/reference/api/NodesTimeHttpHistogram.md | 2 +- docs/reference/api/NodesTransport.md | 2 +- docs/reference/api/NodesTransportHistogram.md | 2 +- docs/reference/api/NodesUsageNodeUsage.md | 2 +- docs/reference/api/NodesUsageRequest.md | 2 +- docs/reference/api/NodesUsageResponse.md | 6 ++-- docs/reference/api/NodesUsageResponseBase.md | 2 +- docs/reference/api/Normalization.md | 6 ++-- docs/reference/api/OnDropDocument.md | 2 +- docs/reference/api/OnSuccessDocument.md | 2 +- docs/reference/api/OpType.md | 6 ++-- docs/reference/api/OpenPointInTimeApi_1.md | 4 +-- docs/reference/api/OpenPointInTimeApi_2.md | 4 +-- docs/reference/api/OpenPointInTimeApi_3.md | 4 +-- docs/reference/api/OpenPointInTimeRequest.md | 2 +- docs/reference/api/OpenPointInTimeResponse.md | 2 +- docs/reference/api/Password.md | 6 ++-- docs/reference/api/Percentage.md | 6 ++-- docs/reference/api/PingApi_1.md | 4 +-- docs/reference/api/PingApi_2.md | 4 +-- docs/reference/api/PingApi_3.md | 4 +-- docs/reference/api/PingRequest.md | 2 +- docs/reference/api/PingResponse.md | 6 ++-- docs/reference/api/PipelineName.md | 6 ++-- docs/reference/api/PluginStats.md | 2 +- docs/reference/api/Profiling.md | 12 ++++---- docs/reference/api/PropertyName.md | 6 ++-- docs/reference/api/PutScriptApi_1.md | 4 +-- docs/reference/api/PutScriptApi_2.md | 4 +-- docs/reference/api/PutScriptApi_3.md | 4 +-- docs/reference/api/PutScriptRequest.md | 2 +- docs/reference/api/PutScriptResponse.md | 6 ++-- docs/reference/api/QueryCacheStats.md | 2 +- docs/reference/api/QueryDslBoolQuery.md | 2 +- docs/reference/api/QueryDslBoostingQuery.md | 2 +- docs/reference/api/QueryDslChildScoreMode.md | 6 ++-- .../api/QueryDslCombinedFieldsOperator.md | 6 ++-- .../api/QueryDslCombinedFieldsQuery.md | 2 +- .../api/QueryDslCombinedFieldsZeroTerms.md | 6 ++-- .../reference/api/QueryDslCommonTermsQuery.md | 2 +- .../api/QueryDslConstantScoreQuery.md | 2 +- .../api/QueryDslDateDecayFunction.md | 6 ++-- .../api/QueryDslDateDecayFunctionKeys.md | 2 +- .../api/QueryDslDateDistanceFeatureQuery.md | 2 +- docs/reference/api/QueryDslDateRangeQuery.md | 2 +- docs/reference/api/QueryDslDecayFunction.md | 6 ++-- .../api/QueryDslDecayFunctionBase.md | 2 +- docs/reference/api/QueryDslDecayPlacement.md | 2 +- docs/reference/api/QueryDslDisMaxQuery.md | 2 +- .../api/QueryDslDistanceFeatureQuery.md | 6 ++-- .../api/QueryDslDistanceFeatureQueryBase.md | 2 +- docs/reference/api/QueryDslExistsQuery.md | 2 +- docs/reference/api/QueryDslFieldAndFormat.md | 2 +- docs/reference/api/QueryDslFieldLookup.md | 2 +- .../api/QueryDslFieldValueFactorModifier.md | 6 ++-- .../QueryDslFieldValueFactorScoreFunction.md | 2 +- .../api/QueryDslFunctionBoostMode.md | 6 ++-- .../api/QueryDslFunctionScoreContainer.md | 2 +- .../api/QueryDslFunctionScoreMode.md | 6 ++-- .../api/QueryDslFunctionScoreQuery.md | 2 +- docs/reference/api/QueryDslFuzzyQuery.md | 2 +- .../api/QueryDslGeoBoundingBoxQuery.md | 6 ++-- .../api/QueryDslGeoBoundingBoxQueryKeys.md | 2 +- .../reference/api/QueryDslGeoDecayFunction.md | 6 ++-- .../api/QueryDslGeoDecayFunctionKeys.md | 2 +- .../api/QueryDslGeoDistanceFeatureQuery.md | 2 +- .../reference/api/QueryDslGeoDistanceQuery.md | 6 ++-- .../api/QueryDslGeoDistanceQueryKeys.md | 2 +- docs/reference/api/QueryDslGeoExecution.md | 6 ++-- docs/reference/api/QueryDslGeoGridQuery.md | 2 +- .../reference/api/QueryDslGeoPolygonPoints.md | 2 +- docs/reference/api/QueryDslGeoPolygonQuery.md | 6 ++-- .../api/QueryDslGeoPolygonQueryKeys.md | 2 +- .../api/QueryDslGeoShapeFieldQuery.md | 2 +- docs/reference/api/QueryDslGeoShapeQuery.md | 6 ++-- .../api/QueryDslGeoShapeQueryKeys.md | 2 +- .../api/QueryDslGeoValidationMethod.md | 6 ++-- docs/reference/api/QueryDslHasChildQuery.md | 2 +- docs/reference/api/QueryDslHasParentQuery.md | 2 +- docs/reference/api/QueryDslIdsQuery.md | 2 +- docs/reference/api/QueryDslIntervalsAllOf.md | 2 +- docs/reference/api/QueryDslIntervalsAnyOf.md | 2 +- .../api/QueryDslIntervalsContainer.md | 2 +- docs/reference/api/QueryDslIntervalsFilter.md | 2 +- docs/reference/api/QueryDslIntervalsFuzzy.md | 2 +- docs/reference/api/QueryDslIntervalsMatch.md | 2 +- docs/reference/api/QueryDslIntervalsPrefix.md | 2 +- docs/reference/api/QueryDslIntervalsQuery.md | 2 +- .../api/QueryDslIntervalsWildcard.md | 2 +- docs/reference/api/QueryDslLike.md | 6 ++-- docs/reference/api/QueryDslLikeDocument.md | 2 +- docs/reference/api/QueryDslMatchAllQuery.md | 2 +- .../api/QueryDslMatchBoolPrefixQuery.md | 2 +- docs/reference/api/QueryDslMatchNoneQuery.md | 2 +- .../api/QueryDslMatchPhrasePrefixQuery.md | 2 +- .../reference/api/QueryDslMatchPhraseQuery.md | 2 +- docs/reference/api/QueryDslMatchQuery.md | 2 +- .../api/QueryDslMoreLikeThisQuery.md | 2 +- docs/reference/api/QueryDslMultiMatchQuery.md | 2 +- docs/reference/api/QueryDslMultiValueMode.md | 6 ++-- docs/reference/api/QueryDslNestedQuery.md | 2 +- .../reference/api/QueryDslNumberRangeQuery.md | 2 +- .../api/QueryDslNumericDecayFunction.md | 6 ++-- .../api/QueryDslNumericDecayFunctionKeys.md | 2 +- docs/reference/api/QueryDslOperator.md | 6 ++-- docs/reference/api/QueryDslParentIdQuery.md | 2 +- docs/reference/api/QueryDslPercolateQuery.md | 2 +- docs/reference/api/QueryDslPinnedDoc.md | 2 +- docs/reference/api/QueryDslPinnedQuery.md | 2 +- docs/reference/api/QueryDslPrefixQuery.md | 2 +- docs/reference/api/QueryDslQueryBase.md | 2 +- docs/reference/api/QueryDslQueryContainer.md | 2 +- .../reference/api/QueryDslQueryStringQuery.md | 2 +- .../api/QueryDslRandomScoreFunction.md | 2 +- docs/reference/api/QueryDslRangeQuery.md | 6 ++-- docs/reference/api/QueryDslRangeQueryBase.md | 2 +- docs/reference/api/QueryDslRangeRelation.md | 6 ++-- .../api/QueryDslRankFeatureFunction.md | 2 +- .../api/QueryDslRankFeatureFunctionLinear.md | 2 +- .../QueryDslRankFeatureFunctionLogarithm.md | 2 +- .../QueryDslRankFeatureFunctionSaturation.md | 2 +- .../api/QueryDslRankFeatureFunctionSigmoid.md | 2 +- .../reference/api/QueryDslRankFeatureQuery.md | 2 +- docs/reference/api/QueryDslRegexpQuery.md | 2 +- docs/reference/api/QueryDslRuleQuery.md | 2 +- docs/reference/api/QueryDslScriptQuery.md | 2 +- .../api/QueryDslScriptScoreFunction.md | 2 +- .../reference/api/QueryDslScriptScoreQuery.md | 2 +- docs/reference/api/QueryDslSemanticQuery.md | 2 +- docs/reference/api/QueryDslShapeFieldQuery.md | 2 +- docs/reference/api/QueryDslShapeQuery.md | 6 ++-- docs/reference/api/QueryDslShapeQueryKeys.md | 2 +- .../api/QueryDslSimpleQueryStringFlag.md | 6 ++-- .../api/QueryDslSimpleQueryStringFlags.md | 6 ++-- .../api/QueryDslSimpleQueryStringQuery.md | 2 +- .../api/QueryDslSpanContainingQuery.md | 2 +- .../api/QueryDslSpanFieldMaskingQuery.md | 2 +- docs/reference/api/QueryDslSpanFirstQuery.md | 2 +- docs/reference/api/QueryDslSpanGapQuery.md | 6 ++-- .../api/QueryDslSpanMultiTermQuery.md | 2 +- docs/reference/api/QueryDslSpanNearQuery.md | 2 +- docs/reference/api/QueryDslSpanNotQuery.md | 2 +- docs/reference/api/QueryDslSpanOrQuery.md | 2 +- docs/reference/api/QueryDslSpanQuery.md | 2 +- docs/reference/api/QueryDslSpanTermQuery.md | 2 +- docs/reference/api/QueryDslSpanWithinQuery.md | 2 +- .../api/QueryDslSparseVectorQuery.md | 2 +- docs/reference/api/QueryDslTermQuery.md | 2 +- docs/reference/api/QueryDslTermRangeQuery.md | 2 +- docs/reference/api/QueryDslTermsLookup.md | 2 +- docs/reference/api/QueryDslTermsQuery.md | 6 ++-- docs/reference/api/QueryDslTermsQueryField.md | 6 ++-- docs/reference/api/QueryDslTermsQueryKeys.md | 2 +- docs/reference/api/QueryDslTermsSetQuery.md | 2 +- .../api/QueryDslTextExpansionQuery.md | 2 +- docs/reference/api/QueryDslTextQueryType.md | 6 ++-- .../api/QueryDslTokenPruningConfig.md | 2 +- docs/reference/api/QueryDslTypeQuery.md | 2 +- .../api/QueryDslUntypedDecayFunction.md | 6 ++-- .../api/QueryDslUntypedDecayFunctionKeys.md | 2 +- .../QueryDslUntypedDistanceFeatureQuery.md | 2 +- .../api/QueryDslUntypedRangeQuery.md | 2 +- .../api/QueryDslWeightedTokensQuery.md | 2 +- docs/reference/api/QueryDslWildcardQuery.md | 2 +- docs/reference/api/QueryDslWrapperQuery.md | 2 +- docs/reference/api/QueryDslZeroTermsQuery.md | 6 ++-- docs/reference/api/QueryRules.md | 12 ++++---- .../api/QueryRulesDeleteRuleRequest.md | 2 +- .../api/QueryRulesDeleteRuleResponse.md | 6 ++-- .../api/QueryRulesDeleteRulesetRequest.md | 2 +- .../api/QueryRulesDeleteRulesetResponse.md | 6 ++-- .../reference/api/QueryRulesGetRuleRequest.md | 2 +- .../api/QueryRulesGetRuleResponse.md | 6 ++-- .../api/QueryRulesGetRulesetRequest.md | 2 +- .../api/QueryRulesGetRulesetResponse.md | 6 ++-- ...ryRulesListRulesetsQueryRulesetListItem.md | 2 +- .../api/QueryRulesListRulesetsRequest.md | 2 +- .../api/QueryRulesListRulesetsResponse.md | 2 +- .../reference/api/QueryRulesPutRuleRequest.md | 2 +- .../api/QueryRulesPutRuleResponse.md | 2 +- .../api/QueryRulesPutRulesetRequest.md | 2 +- .../api/QueryRulesPutRulesetResponse.md | 2 +- docs/reference/api/QueryRulesQueryRule.md | 2 +- .../api/QueryRulesQueryRuleActions.md | 2 +- .../api/QueryRulesQueryRuleCriteria.md | 2 +- .../api/QueryRulesQueryRuleCriteriaType.md | 6 ++-- docs/reference/api/QueryRulesQueryRuleType.md | 6 ++-- docs/reference/api/QueryRulesQueryRuleset.md | 2 +- .../QueryRulesTestQueryRulesetMatchedRule.md | 2 +- docs/reference/api/QueryRulesTestRequest.md | 2 +- docs/reference/api/QueryRulesTestResponse.md | 2 +- docs/reference/api/QueryVector.md | 6 ++-- docs/reference/api/QueryVectorBuilder.md | 2 +- docs/reference/api/RRFRetriever.md | 2 +- docs/reference/api/RankBase.md | 2 +- docs/reference/api/RankContainer.md | 2 +- docs/reference/api/RankEvalApi_1.md | 4 +-- docs/reference/api/RankEvalApi_2.md | 4 +-- docs/reference/api/RankEvalApi_3.md | 4 +-- docs/reference/api/RankEvalDocumentRating.md | 2 +- docs/reference/api/RankEvalRankEvalHit.md | 2 +- docs/reference/api/RankEvalRankEvalHitItem.md | 2 +- docs/reference/api/RankEvalRankEvalMetric.md | 2 +- .../api/RankEvalRankEvalMetricBase.md | 2 +- .../api/RankEvalRankEvalMetricDetail.md | 2 +- ...lRankEvalMetricDiscountedCumulativeGain.md | 2 +- ...valRankEvalMetricExpectedReciprocalRank.md | 2 +- ...ankEvalRankEvalMetricMeanReciprocalRank.md | 2 +- .../api/RankEvalRankEvalMetricPrecision.md | 2 +- .../RankEvalRankEvalMetricRatingTreshold.md | 2 +- .../api/RankEvalRankEvalMetricRecall.md | 2 +- docs/reference/api/RankEvalRankEvalQuery.md | 2 +- .../api/RankEvalRankEvalRequestItem.md | 2 +- docs/reference/api/RankEvalRequest.md | 2 +- docs/reference/api/RankEvalResponse.md | 2 +- docs/reference/api/RankEvalUnratedDocument.md | 2 +- docs/reference/api/RecoveryStats.md | 2 +- docs/reference/api/Refresh.md | 6 ++-- docs/reference/api/RefreshStats.md | 2 +- docs/reference/api/ReindexApi_1.md | 4 +-- docs/reference/api/ReindexApi_2.md | 4 +-- docs/reference/api/ReindexApi_3.md | 4 +-- docs/reference/api/ReindexDestination.md | 2 +- docs/reference/api/ReindexRemoteSource.md | 2 +- docs/reference/api/ReindexRequest.md | 2 +- docs/reference/api/ReindexResponse.md | 2 +- docs/reference/api/ReindexRethrottleApi_1.md | 4 +-- docs/reference/api/ReindexRethrottleApi_2.md | 4 +-- docs/reference/api/ReindexRethrottleApi_3.md | 4 +-- .../api/ReindexRethrottleReindexNode.md | 2 +- .../api/ReindexRethrottleReindexStatus.md | 2 +- .../api/ReindexRethrottleReindexTask.md | 2 +- .../reference/api/ReindexRethrottleRequest.md | 2 +- .../api/ReindexRethrottleResponse.md | 2 +- docs/reference/api/ReindexSource.md | 2 +- docs/reference/api/RelationName.md | 6 ++-- docs/reference/api/RelocationFailureInfo.md | 2 +- .../api/RenderSearchTemplateApi_1.md | 4 +-- .../api/RenderSearchTemplateApi_2.md | 4 +-- .../api/RenderSearchTemplateApi_3.md | 4 +-- .../api/RenderSearchTemplateRequest.md | 2 +- .../api/RenderSearchTemplateResponse.md | 2 +- docs/reference/api/RequestBase.md | 2 +- docs/reference/api/RequestCacheStats.md | 2 +- docs/reference/api/RescoreVector.md | 2 +- docs/reference/api/Result.md | 6 ++-- docs/reference/api/Retries.md | 2 +- docs/reference/api/RetrieverBase.md | 2 +- docs/reference/api/RetrieverContainer.md | 2 +- docs/reference/api/Rollup.md | 12 ++++---- .../api/RollupDateHistogramGrouping.md | 2 +- docs/reference/api/RollupDeleteJobRequest.md | 2 +- docs/reference/api/RollupDeleteJobResponse.md | 2 +- docs/reference/api/RollupFieldMetric.md | 2 +- .../api/RollupGetJobsIndexingJobState.md | 6 ++-- docs/reference/api/RollupGetJobsRequest.md | 2 +- docs/reference/api/RollupGetJobsResponse.md | 2 +- docs/reference/api/RollupGetJobsRollupJob.md | 2 +- .../RollupGetJobsRollupJobConfiguration.md | 2 +- .../api/RollupGetJobsRollupJobStats.md | 2 +- .../api/RollupGetJobsRollupJobStatus.md | 2 +- .../api/RollupGetRollupCapsRequest.md | 2 +- .../api/RollupGetRollupCapsResponse.md | 6 ++-- .../RollupGetRollupCapsRollupCapabilities.md | 2 +- ...lupGetRollupCapsRollupCapabilitySummary.md | 2 +- .../RollupGetRollupCapsRollupFieldSummary.md | 2 +- ...llupGetRollupIndexCapsIndexCapabilities.md | 2 +- .../api/RollupGetRollupIndexCapsRequest.md | 2 +- .../api/RollupGetRollupIndexCapsResponse.md | 6 ++-- ...ollupGetRollupIndexCapsRollupJobSummary.md | 2 +- ...GetRollupIndexCapsRollupJobSummaryField.md | 2 +- docs/reference/api/RollupGroupings.md | 2 +- docs/reference/api/RollupHistogramGrouping.md | 2 +- docs/reference/api/RollupMetric.md | 6 ++-- docs/reference/api/RollupPutJobRequest.md | 2 +- docs/reference/api/RollupPutJobResponse.md | 6 ++-- .../api/RollupRollupSearchRequest.md | 2 +- .../api/RollupRollupSearchResponse.md | 2 +- docs/reference/api/RollupStartJobRequest.md | 2 +- docs/reference/api/RollupStartJobResponse.md | 2 +- docs/reference/api/RollupStopJobRequest.md | 2 +- docs/reference/api/RollupStopJobResponse.md | 2 +- docs/reference/api/RollupTermsGrouping.md | 2 +- docs/reference/api/Routing.md | 6 ++-- docs/reference/api/RrfRank.md | 2 +- docs/reference/api/RuleRetriever.md | 2 +- docs/reference/api/ScalarValue.md | 6 ++-- docs/reference/api/ScoreSort.md | 2 +- docs/reference/api/Script.md | 2 +- docs/reference/api/ScriptField.md | 2 +- docs/reference/api/ScriptLanguage.md | 6 ++-- docs/reference/api/ScriptSort.md | 2 +- docs/reference/api/ScriptSortType.md | 6 ++-- docs/reference/api/ScriptSource.md | 6 ++-- docs/reference/api/ScriptTransform.md | 2 +- .../api/ScriptsPainlessExecuteApi_1.md | 4 +-- .../api/ScriptsPainlessExecuteApi_2.md | 4 +-- .../api/ScriptsPainlessExecuteApi_3.md | 4 +-- .../ScriptsPainlessExecutePainlessContext.md | 6 ++-- ...iptsPainlessExecutePainlessContextSetup.md | 2 +- .../api/ScriptsPainlessExecuteRequest.md | 2 +- .../api/ScriptsPainlessExecuteResponse.md | 2 +- docs/reference/api/ScrollApi_1.md | 4 +-- docs/reference/api/ScrollApi_2.md | 4 +-- docs/reference/api/ScrollApi_3.md | 4 +-- docs/reference/api/ScrollId.md | 6 ++-- docs/reference/api/ScrollIds.md | 6 ++-- docs/reference/api/ScrollRequest.md | 2 +- docs/reference/api/ScrollResponse.md | 6 ++-- docs/reference/api/ScrollSearchOptions.md | 2 +- docs/reference/api/ScrollSearchResponse.md | 2 +- .../api/SearchAggregationBreakdown.md | 2 +- .../reference/api/SearchAggregationProfile.md | 2 +- .../api/SearchAggregationProfileDebug.md | 2 +- ...chAggregationProfileDelegateDebugFilter.md | 2 +- docs/reference/api/SearchApi_1.md | 4 +-- docs/reference/api/SearchApi_2.md | 4 +-- docs/reference/api/SearchApi_3.md | 4 +-- docs/reference/api/SearchApplication.md | 12 ++++---- .../SearchApplicationAnalyticsCollection.md | 2 +- ...icationDeleteBehavioralAnalyticsRequest.md | 2 +- ...cationDeleteBehavioralAnalyticsResponse.md | 6 ++-- .../api/SearchApplicationDeleteRequest.md | 2 +- .../api/SearchApplicationDeleteResponse.md | 6 ++-- .../api/SearchApplicationEventDataStream.md | 2 +- .../api/SearchApplicationEventType.md | 6 ++-- ...pplicationGetBehavioralAnalyticsRequest.md | 2 +- ...plicationGetBehavioralAnalyticsResponse.md | 6 ++-- .../api/SearchApplicationGetRequest.md | 2 +- .../api/SearchApplicationGetResponse.md | 6 ++-- .../api/SearchApplicationListRequest.md | 2 +- .../api/SearchApplicationListResponse.md | 2 +- ...tionPostBehavioralAnalyticsEventRequest.md | 2 +- ...ionPostBehavioralAnalyticsEventResponse.md | 2 +- ...alyticsAnalyticsAcknowledgeResponseBase.md | 2 +- ...pplicationPutBehavioralAnalyticsRequest.md | 2 +- ...plicationPutBehavioralAnalyticsResponse.md | 6 ++-- .../api/SearchApplicationPutRequest.md | 2 +- .../api/SearchApplicationPutResponse.md | 2 +- .../SearchApplicationRenderQueryRequest.md | 2 +- .../SearchApplicationRenderQueryResponse.md | 2 +- .../api/SearchApplicationSearchApplication.md | 2 +- ...hApplicationSearchApplicationParameters.md | 2 +- ...rchApplicationSearchApplicationTemplate.md | 2 +- .../api/SearchApplicationSearchRequest.md | 2 +- .../api/SearchApplicationSearchResponse.md | 6 ++-- docs/reference/api/SearchBoundaryScanner.md | 6 ++-- docs/reference/api/SearchCollector.md | 2 +- docs/reference/api/SearchCompletionContext.md | 2 +- docs/reference/api/SearchCompletionSuggest.md | 2 +- .../api/SearchCompletionSuggestOption.md | 2 +- .../api/SearchCompletionSuggester.md | 2 +- docs/reference/api/SearchContext.md | 6 ++-- docs/reference/api/SearchDfsKnnProfile.md | 2 +- docs/reference/api/SearchDfsProfile.md | 2 +- .../api/SearchDfsStatisticsBreakdown.md | 2 +- .../api/SearchDfsStatisticsProfile.md | 2 +- docs/reference/api/SearchDirectGenerator.md | 2 +- docs/reference/api/SearchFetchProfile.md | 2 +- .../api/SearchFetchProfileBreakdown.md | 2 +- docs/reference/api/SearchFetchProfileDebug.md | 2 +- docs/reference/api/SearchFieldCollapse.md | 2 +- docs/reference/api/SearchFieldSuggester.md | 2 +- docs/reference/api/SearchHighlight.md | 2 +- docs/reference/api/SearchHighlightBase.md | 2 +- docs/reference/api/SearchHighlightField.md | 2 +- .../reference/api/SearchHighlighterEncoder.md | 6 ++-- .../api/SearchHighlighterFragmenter.md | 6 ++-- docs/reference/api/SearchHighlighterOrder.md | 6 ++-- .../api/SearchHighlighterTagsSchema.md | 6 ++-- docs/reference/api/SearchHighlighterType.md | 6 ++-- docs/reference/api/SearchHit.md | 2 +- docs/reference/api/SearchHitsMetadata.md | 2 +- docs/reference/api/SearchInnerHits.md | 2 +- docs/reference/api/SearchInnerHitsResult.md | 2 +- .../reference/api/SearchKnnCollectorResult.md | 2 +- .../api/SearchKnnQueryProfileBreakdown.md | 2 +- .../api/SearchKnnQueryProfileResult.md | 2 +- .../api/SearchLaplaceSmoothingModel.md | 2 +- docs/reference/api/SearchLearningToRank.md | 2 +- ...SearchLinearInterpolationSmoothingModel.md | 2 +- docs/reference/api/SearchMvtApi_1.md | 4 +-- docs/reference/api/SearchMvtApi_2.md | 4 +-- docs/reference/api/SearchMvtApi_3.md | 4 +-- docs/reference/api/SearchMvtCoordinate.md | 6 ++-- .../api/SearchMvtGridAggregationType.md | 6 ++-- docs/reference/api/SearchMvtGridType.md | 6 ++-- docs/reference/api/SearchMvtRequest.md | 2 +- docs/reference/api/SearchMvtResponse.md | 6 ++-- docs/reference/api/SearchMvtZoomLevel.md | 6 ++-- docs/reference/api/SearchNestedIdentity.md | 2 +- docs/reference/api/SearchPhraseSuggest.md | 2 +- .../api/SearchPhraseSuggestCollate.md | 2 +- .../api/SearchPhraseSuggestCollateQuery.md | 2 +- .../api/SearchPhraseSuggestHighlight.md | 2 +- .../api/SearchPhraseSuggestOption.md | 2 +- docs/reference/api/SearchPhraseSuggester.md | 2 +- .../api/SearchPointInTimeReference.md | 2 +- docs/reference/api/SearchProfile.md | 2 +- docs/reference/api/SearchQueryBreakdown.md | 2 +- docs/reference/api/SearchQueryProfile.md | 2 +- docs/reference/api/SearchRegexOptions.md | 2 +- docs/reference/api/SearchRequest.md | 2 +- docs/reference/api/SearchRescore.md | 2 +- docs/reference/api/SearchRescoreQuery.md | 2 +- docs/reference/api/SearchResponse.md | 6 ++-- docs/reference/api/SearchResponseBody.md | 2 +- docs/reference/api/SearchScoreMode.md | 6 ++-- docs/reference/api/SearchSearchProfile.md | 2 +- docs/reference/api/SearchSearchRequestBody.md | 2 +- docs/reference/api/SearchShardProfile.md | 2 +- docs/reference/api/SearchShardsApi_1.md | 4 +-- docs/reference/api/SearchShardsApi_2.md | 4 +-- docs/reference/api/SearchShardsApi_3.md | 4 +-- docs/reference/api/SearchShardsRequest.md | 2 +- docs/reference/api/SearchShardsResponse.md | 2 +- .../SearchShardsSearchShardsNodeAttributes.md | 2 +- .../api/SearchShardsShardStoreIndex.md | 2 +- .../api/SearchSmoothingModelContainer.md | 2 +- docs/reference/api/SearchSourceConfig.md | 6 ++-- docs/reference/api/SearchSourceConfigParam.md | 6 ++-- docs/reference/api/SearchSourceFilter.md | 2 +- docs/reference/api/SearchStats.md | 2 +- docs/reference/api/SearchStringDistance.md | 6 ++-- .../api/SearchStupidBackoffSmoothingModel.md | 2 +- docs/reference/api/SearchSuggest.md | 6 ++-- docs/reference/api/SearchSuggestBase.md | 2 +- docs/reference/api/SearchSuggestFuzziness.md | 2 +- docs/reference/api/SearchSuggestSort.md | 6 ++-- docs/reference/api/SearchSuggester.md | 6 ++-- docs/reference/api/SearchSuggesterBase.md | 2 +- docs/reference/api/SearchSuggesterKeys.md | 2 +- docs/reference/api/SearchTemplateApi_1.md | 4 +-- docs/reference/api/SearchTemplateApi_2.md | 4 +-- docs/reference/api/SearchTemplateApi_3.md | 4 +-- docs/reference/api/SearchTemplateRequest.md | 2 +- docs/reference/api/SearchTemplateResponse.md | 2 +- docs/reference/api/SearchTermSuggest.md | 2 +- docs/reference/api/SearchTermSuggestOption.md | 2 +- docs/reference/api/SearchTermSuggester.md | 2 +- docs/reference/api/SearchTotalHits.md | 2 +- docs/reference/api/SearchTotalHitsRelation.md | 6 ++-- docs/reference/api/SearchTrackHits.md | 6 ++-- docs/reference/api/SearchTransform.md | 2 +- docs/reference/api/SearchType.md | 6 ++-- docs/reference/api/SearchableSnapshots.md | 12 ++++---- .../api/SearchableSnapshotsCacheStatsNode.md | 2 +- .../SearchableSnapshotsCacheStatsRequest.md | 2 +- .../SearchableSnapshotsCacheStatsResponse.md | 2 +- .../SearchableSnapshotsCacheStatsShared.md | 2 +- .../SearchableSnapshotsClearCacheRequest.md | 2 +- .../SearchableSnapshotsClearCacheResponse.md | 6 ++-- ...SearchableSnapshotsMountMountedSnapshot.md | 2 +- .../api/SearchableSnapshotsMountRequest.md | 2 +- .../api/SearchableSnapshotsMountResponse.md | 2 +- .../api/SearchableSnapshotsStatsLevel.md | 6 ++-- .../api/SearchableSnapshotsStatsRequest.md | 2 +- .../api/SearchableSnapshotsStatsResponse.md | 2 +- docs/reference/api/Security.md | 12 ++++---- docs/reference/api/SecurityAccess.md | 2 +- .../api/SecurityActivateUserProfileRequest.md | 2 +- .../SecurityActivateUserProfileResponse.md | 6 ++-- docs/reference/api/SecurityApiKey.md | 2 +- docs/reference/api/SecurityApiKeyType.md | 6 ++-- ...SecurityApplicationGlobalUserPrivileges.md | 2 +- .../api/SecurityApplicationPrivileges.md | 2 +- .../SecurityAuthenticateAuthenticateApiKey.md | 2 +- .../api/SecurityAuthenticateRequest.md | 2 +- .../api/SecurityAuthenticateResponse.md | 2 +- .../api/SecurityAuthenticateToken.md | 2 +- .../api/SecurityBulkDeleteRoleRequest.md | 2 +- .../api/SecurityBulkDeleteRoleResponse.md | 2 +- docs/reference/api/SecurityBulkError.md | 2 +- .../api/SecurityBulkPutRoleRequest.md | 2 +- .../api/SecurityBulkPutRoleResponse.md | 2 +- .../api/SecurityBulkUpdateApiKeysRequest.md | 2 +- .../api/SecurityBulkUpdateApiKeysResponse.md | 2 +- .../api/SecurityChangePasswordRequest.md | 2 +- .../api/SecurityChangePasswordResponse.md | 2 +- .../api/SecurityClearApiKeyCacheRequest.md | 2 +- .../api/SecurityClearApiKeyCacheResponse.md | 2 +- .../SecurityClearCachedPrivilegesRequest.md | 2 +- .../SecurityClearCachedPrivilegesResponse.md | 2 +- .../api/SecurityClearCachedRealmsRequest.md | 2 +- .../api/SecurityClearCachedRealmsResponse.md | 2 +- .../api/SecurityClearCachedRolesRequest.md | 2 +- .../api/SecurityClearCachedRolesResponse.md | 2 +- ...SecurityClearCachedServiceTokensRequest.md | 2 +- ...ecurityClearCachedServiceTokensResponse.md | 2 +- docs/reference/api/SecurityClusterNode.md | 2 +- .../reference/api/SecurityClusterPrivilege.md | 6 ++-- .../api/SecurityCreateApiKeyRequest.md | 2 +- .../api/SecurityCreateApiKeyResponse.md | 2 +- ...SecurityCreateCrossClusterApiKeyRequest.md | 2 +- ...ecurityCreateCrossClusterApiKeyResponse.md | 2 +- .../api/SecurityCreateServiceTokenRequest.md | 2 +- .../api/SecurityCreateServiceTokenResponse.md | 2 +- .../api/SecurityCreateServiceTokenToken.md | 2 +- docs/reference/api/SecurityCreatedStatus.md | 2 +- .../api/SecurityDelegatePkiAuthentication.md | 2 +- .../SecurityDelegatePkiAuthenticationRealm.md | 2 +- .../api/SecurityDelegatePkiRequest.md | 2 +- .../api/SecurityDelegatePkiResponse.md | 2 +- .../SecurityDeletePrivilegesFoundStatus.md | 2 +- .../api/SecurityDeletePrivilegesRequest.md | 2 +- .../api/SecurityDeletePrivilegesResponse.md | 6 ++-- .../api/SecurityDeleteRoleMappingRequest.md | 2 +- .../api/SecurityDeleteRoleMappingResponse.md | 2 +- .../api/SecurityDeleteRoleRequest.md | 2 +- .../api/SecurityDeleteRoleResponse.md | 2 +- .../api/SecurityDeleteServiceTokenRequest.md | 2 +- .../api/SecurityDeleteServiceTokenResponse.md | 2 +- .../api/SecurityDeleteUserRequest.md | 2 +- .../api/SecurityDeleteUserResponse.md | 2 +- .../api/SecurityDisableUserProfileRequest.md | 2 +- .../api/SecurityDisableUserProfileResponse.md | 6 ++-- .../api/SecurityDisableUserRequest.md | 2 +- .../api/SecurityDisableUserResponse.md | 2 +- .../api/SecurityEnableUserProfileRequest.md | 2 +- .../api/SecurityEnableUserProfileResponse.md | 6 ++-- .../api/SecurityEnableUserRequest.md | 2 +- .../api/SecurityEnableUserResponse.md | 2 +- .../api/SecurityEnrollKibanaRequest.md | 2 +- .../api/SecurityEnrollKibanaResponse.md | 2 +- .../api/SecurityEnrollKibanaToken.md | 2 +- .../api/SecurityEnrollNodeRequest.md | 2 +- .../api/SecurityEnrollNodeResponse.md | 2 +- docs/reference/api/SecurityFieldSecurity.md | 2 +- .../reference/api/SecurityGetApiKeyRequest.md | 2 +- .../api/SecurityGetApiKeyResponse.md | 2 +- .../SecurityGetBuiltinPrivilegesRequest.md | 2 +- .../SecurityGetBuiltinPrivilegesResponse.md | 2 +- .../api/SecurityGetPrivilegesRequest.md | 2 +- .../api/SecurityGetPrivilegesResponse.md | 6 ++-- .../api/SecurityGetRoleMappingRequest.md | 2 +- .../api/SecurityGetRoleMappingResponse.md | 6 ++-- docs/reference/api/SecurityGetRoleRequest.md | 2 +- docs/reference/api/SecurityGetRoleResponse.md | 6 ++-- docs/reference/api/SecurityGetRoleRole.md | 2 +- .../api/SecurityGetServiceAccountsRequest.md | 2 +- .../api/SecurityGetServiceAccountsResponse.md | 6 ++-- ...GetServiceAccountsRoleDescriptorWrapper.md | 2 +- ...tyGetServiceCredentialsNodesCredentials.md | 2 +- ...iceCredentialsNodesCredentialsFileToken.md | 2 +- .../SecurityGetServiceCredentialsRequest.md | 2 +- .../SecurityGetServiceCredentialsResponse.md | 2 +- .../api/SecurityGetSettingsRequest.md | 2 +- .../api/SecurityGetSettingsResponse.md | 2 +- .../SecurityGetTokenAccessTokenGrantType.md | 6 ++-- .../api/SecurityGetTokenAuthenticatedUser.md | 2 +- .../SecurityGetTokenAuthenticationProvider.md | 2 +- docs/reference/api/SecurityGetTokenRequest.md | 2 +- .../reference/api/SecurityGetTokenResponse.md | 2 +- .../api/SecurityGetTokenUserRealm.md | 2 +- .../api/SecurityGetUserPrivilegesRequest.md | 2 +- .../api/SecurityGetUserPrivilegesResponse.md | 2 +- ...urityGetUserProfileGetUserProfileErrors.md | 2 +- .../api/SecurityGetUserProfileRequest.md | 2 +- .../api/SecurityGetUserProfileResponse.md | 2 +- docs/reference/api/SecurityGetUserRequest.md | 2 +- docs/reference/api/SecurityGetUserResponse.md | 6 ++-- docs/reference/api/SecurityGlobalPrivilege.md | 2 +- .../api/SecurityGrantApiKeyApiKeyGrantType.md | 6 ++-- .../api/SecurityGrantApiKeyGrantApiKey.md | 2 +- .../api/SecurityGrantApiKeyRequest.md | 2 +- .../api/SecurityGrantApiKeyResponse.md | 2 +- docs/reference/api/SecurityGrantType.md | 6 ++-- ...HasPrivilegesApplicationPrivilegesCheck.md | 2 +- ...rityHasPrivilegesApplicationsPrivileges.md | 6 ++-- ...curityHasPrivilegesIndexPrivilegesCheck.md | 2 +- .../api/SecurityHasPrivilegesPrivileges.md | 6 ++-- .../api/SecurityHasPrivilegesRequest.md | 2 +- ...SecurityHasPrivilegesResourcePrivileges.md | 6 ++-- .../api/SecurityHasPrivilegesResponse.md | 2 +- ...erProfileHasPrivilegesUserProfileErrors.md | 2 +- ...HasPrivilegesUserProfilePrivilegesCheck.md | 2 +- ...SecurityHasPrivilegesUserProfileRequest.md | 2 +- ...ecurityHasPrivilegesUserProfileResponse.md | 2 +- docs/reference/api/SecurityIndexPrivilege.md | 6 ++-- .../api/SecurityIndicesPrivileges.md | 2 +- .../api/SecurityIndicesPrivilegesQuery.md | 6 ++-- .../api/SecurityInvalidateApiKeyRequest.md | 2 +- .../api/SecurityInvalidateApiKeyResponse.md | 2 +- .../api/SecurityInvalidateTokenRequest.md | 2 +- .../api/SecurityInvalidateTokenResponse.md | 2 +- .../api/SecurityManageUserPrivileges.md | 2 +- .../api/SecurityOidcAuthenticateRequest.md | 2 +- .../api/SecurityOidcAuthenticateResponse.md | 2 +- .../api/SecurityOidcLogoutRequest.md | 2 +- .../api/SecurityOidcLogoutResponse.md | 2 +- ...ecurityOidcPrepareAuthenticationRequest.md | 2 +- ...curityOidcPrepareAuthenticationResponse.md | 2 +- .../api/SecurityPutPrivilegesActions.md | 2 +- .../api/SecurityPutPrivilegesRequest.md | 2 +- .../api/SecurityPutPrivilegesResponse.md | 6 ++-- .../api/SecurityPutRoleMappingRequest.md | 2 +- .../api/SecurityPutRoleMappingResponse.md | 2 +- docs/reference/api/SecurityPutRoleRequest.md | 2 +- docs/reference/api/SecurityPutRoleResponse.md | 2 +- docs/reference/api/SecurityPutUserRequest.md | 2 +- docs/reference/api/SecurityPutUserResponse.md | 2 +- .../SecurityQueryApiKeysApiKeyAggregate.md | 6 ++-- ...yQueryApiKeysApiKeyAggregationContainer.md | 2 +- ...ityQueryApiKeysApiKeyFiltersAggregation.md | 2 +- ...ecurityQueryApiKeysApiKeyQueryContainer.md | 2 +- .../api/SecurityQueryApiKeysRequest.md | 2 +- .../api/SecurityQueryApiKeysResponse.md | 2 +- .../api/SecurityQueryRoleQueryRole.md | 2 +- .../reference/api/SecurityQueryRoleRequest.md | 2 +- .../api/SecurityQueryRoleResponse.md | 2 +- .../SecurityQueryRoleRoleQueryContainer.md | 2 +- .../api/SecurityQueryUserQueryUser.md | 2 +- .../reference/api/SecurityQueryUserRequest.md | 2 +- .../api/SecurityQueryUserResponse.md | 2 +- .../SecurityQueryUserUserQueryContainer.md | 2 +- docs/reference/api/SecurityRealmInfo.md | 2 +- .../api/SecurityRemoteClusterPrivilege.md | 6 ++-- .../api/SecurityRemoteClusterPrivileges.md | 2 +- .../api/SecurityRemoteIndicesPrivileges.md | 2 +- .../SecurityRemoteUserIndicesPrivileges.md | 2 +- .../api/SecurityReplicationAccess.md | 2 +- docs/reference/api/SecurityRestriction.md | 2 +- .../api/SecurityRestrictionWorkflow.md | 6 ++-- docs/reference/api/SecurityRoleDescriptor.md | 2 +- .../api/SecurityRoleDescriptorRead.md | 2 +- docs/reference/api/SecurityRoleMapping.md | 2 +- docs/reference/api/SecurityRoleMappingRule.md | 2 +- docs/reference/api/SecurityRoleTemplate.md | 2 +- .../api/SecurityRoleTemplateInlineQuery.md | 6 ++-- .../api/SecurityRoleTemplateQuery.md | 2 +- .../api/SecurityRoleTemplateScript.md | 2 +- .../api/SecuritySamlAuthenticateRequest.md | 2 +- .../api/SecuritySamlAuthenticateResponse.md | 2 +- .../api/SecuritySamlCompleteLogoutRequest.md | 2 +- .../api/SecuritySamlCompleteLogoutResponse.md | 6 ++-- .../api/SecuritySamlInvalidateRequest.md | 2 +- .../api/SecuritySamlInvalidateResponse.md | 2 +- .../api/SecuritySamlLogoutRequest.md | 2 +- .../api/SecuritySamlLogoutResponse.md | 2 +- ...ecuritySamlPrepareAuthenticationRequest.md | 2 +- ...curitySamlPrepareAuthenticationResponse.md | 2 +- ...uritySamlServiceProviderMetadataRequest.md | 2 +- ...ritySamlServiceProviderMetadataResponse.md | 2 +- docs/reference/api/SecuritySearchAccess.md | 2 +- .../reference/api/SecuritySecuritySettings.md | 2 +- .../api/SecuritySuggestUserProfilesHint.md | 2 +- .../api/SecuritySuggestUserProfilesRequest.md | 2 +- .../SecuritySuggestUserProfilesResponse.md | 2 +- ...itySuggestUserProfilesTotalUserProfiles.md | 2 +- docs/reference/api/SecurityTemplateFormat.md | 6 ++-- .../api/SecurityUpdateApiKeyRequest.md | 2 +- .../api/SecurityUpdateApiKeyResponse.md | 2 +- ...SecurityUpdateCrossClusterApiKeyRequest.md | 2 +- ...ecurityUpdateCrossClusterApiKeyResponse.md | 2 +- .../api/SecurityUpdateSettingsRequest.md | 2 +- .../api/SecurityUpdateSettingsResponse.md | 2 +- .../SecurityUpdateUserProfileDataRequest.md | 2 +- .../SecurityUpdateUserProfileDataResponse.md | 6 ++-- docs/reference/api/SecurityUser.md | 2 +- .../api/SecurityUserIndicesPrivileges.md | 2 +- docs/reference/api/SecurityUserProfile.md | 2 +- .../api/SecurityUserProfileHitMetadata.md | 2 +- docs/reference/api/SecurityUserProfileId.md | 6 ++-- docs/reference/api/SecurityUserProfileUser.md | 2 +- .../api/SecurityUserProfileWithMetadata.md | 2 +- docs/reference/api/SegmentsStats.md | 2 +- docs/reference/api/SequenceNumber.md | 6 ++-- docs/reference/api/Service.md | 6 ++-- docs/reference/api/ShardFailure.md | 2 +- docs/reference/api/ShardStatistics.md | 2 +- .../api/ShardsOperationResponseBase.md | 2 +- docs/reference/api/Shutdown.md | 12 ++++---- .../api/ShutdownDeleteNodeRequest.md | 2 +- .../api/ShutdownDeleteNodeResponse.md | 6 ++-- .../api/ShutdownGetNodeNodeShutdownStatus.md | 2 +- .../ShutdownGetNodePersistentTaskStatus.md | 2 +- .../api/ShutdownGetNodePluginsStatus.md | 2 +- docs/reference/api/ShutdownGetNodeRequest.md | 2 +- docs/reference/api/ShutdownGetNodeResponse.md | 2 +- .../ShutdownGetNodeShardMigrationStatus.md | 2 +- .../api/ShutdownGetNodeShutdownStatus.md | 6 ++-- .../api/ShutdownGetNodeShutdownType.md | 6 ++-- docs/reference/api/ShutdownPutNodeRequest.md | 2 +- docs/reference/api/ShutdownPutNodeResponse.md | 6 ++-- docs/reference/api/ShutdownType.md | 6 ++-- docs/reference/api/Simulate.md | 12 ++++---- .../SimulateIngestIngestDocumentSimulation.md | 6 ++-- ...ulateIngestIngestDocumentSimulationKeys.md | 2 +- docs/reference/api/SimulateIngestRequest.md | 2 +- docs/reference/api/SimulateIngestResponse.md | 2 +- ...ulateIngestSimulateIngestDocumentResult.md | 2 +- docs/reference/api/SlicedScroll.md | 2 +- docs/reference/api/Slices.md | 6 ++-- docs/reference/api/SlicesCalculation.md | 6 ++-- docs/reference/api/Slm.md | 12 ++++---- docs/reference/api/SlmConfiguration.md | 2 +- .../api/SlmDeleteLifecycleRequest.md | 2 +- .../api/SlmDeleteLifecycleResponse.md | 6 ++-- .../api/SlmExecuteLifecycleRequest.md | 2 +- .../api/SlmExecuteLifecycleResponse.md | 2 +- .../api/SlmExecuteRetentionRequest.md | 2 +- .../api/SlmExecuteRetentionResponse.md | 6 ++-- docs/reference/api/SlmGetLifecycleRequest.md | 2 +- docs/reference/api/SlmGetLifecycleResponse.md | 6 ++-- docs/reference/api/SlmGetStatsRequest.md | 2 +- docs/reference/api/SlmGetStatsResponse.md | 2 +- docs/reference/api/SlmGetStatusRequest.md | 2 +- docs/reference/api/SlmGetStatusResponse.md | 2 +- docs/reference/api/SlmInProgress.md | 2 +- docs/reference/api/SlmInvocation.md | 2 +- docs/reference/api/SlmPolicy.md | 2 +- docs/reference/api/SlmPutLifecycleRequest.md | 2 +- docs/reference/api/SlmPutLifecycleResponse.md | 6 ++-- docs/reference/api/SlmRetention.md | 2 +- docs/reference/api/SlmSnapshotLifecycle.md | 2 +- docs/reference/api/SlmStartRequest.md | 2 +- docs/reference/api/SlmStartResponse.md | 6 ++-- docs/reference/api/SlmStatistics.md | 2 +- docs/reference/api/SlmStopRequest.md | 2 +- docs/reference/api/SlmStopResponse.md | 6 ++-- docs/reference/api/Snapshot.md | 12 ++++---- docs/reference/api/SnapshotAzureRepository.md | 2 +- .../api/SnapshotAzureRepositorySettings.md | 2 +- ...eanupRepositoryCleanupRepositoryResults.md | 2 +- .../api/SnapshotCleanupRepositoryRequest.md | 2 +- .../api/SnapshotCleanupRepositoryResponse.md | 2 +- docs/reference/api/SnapshotCloneRequest.md | 2 +- docs/reference/api/SnapshotCloneResponse.md | 6 ++-- .../api/SnapshotCreateRepositoryRequest.md | 2 +- .../api/SnapshotCreateRepositoryResponse.md | 6 ++-- docs/reference/api/SnapshotCreateRequest.md | 2 +- docs/reference/api/SnapshotCreateResponse.md | 2 +- .../api/SnapshotDeleteRepositoryRequest.md | 2 +- .../api/SnapshotDeleteRepositoryResponse.md | 6 ++-- docs/reference/api/SnapshotDeleteRequest.md | 2 +- docs/reference/api/SnapshotDeleteResponse.md | 6 ++-- .../api/SnapshotFileCountSnapshotStats.md | 2 +- docs/reference/api/SnapshotGcsRepository.md | 2 +- .../api/SnapshotGcsRepositorySettings.md | 2 +- .../api/SnapshotGetRepositoryRequest.md | 2 +- .../api/SnapshotGetRepositoryResponse.md | 6 ++-- docs/reference/api/SnapshotGetRequest.md | 2 +- docs/reference/api/SnapshotGetResponse.md | 2 +- .../api/SnapshotGetSnapshotResponseItem.md | 2 +- docs/reference/api/SnapshotIndexDetails.md | 2 +- .../reference/api/SnapshotInfoFeatureState.md | 2 +- .../api/SnapshotReadOnlyUrlRepository.md | 2 +- .../SnapshotReadOnlyUrlRepositorySettings.md | 2 +- docs/reference/api/SnapshotRepository.md | 6 ++-- .../SnapshotRepositoryAnalyzeBlobDetails.md | 2 +- .../SnapshotRepositoryAnalyzeDetailsInfo.md | 2 +- ...napshotRepositoryAnalyzeReadBlobDetails.md | 2 +- ...napshotRepositoryAnalyzeReadSummaryInfo.md | 2 +- .../api/SnapshotRepositoryAnalyzeRequest.md | 2 +- .../api/SnapshotRepositoryAnalyzeResponse.md | 2 +- ...apshotRepositoryAnalyzeSnapshotNodeInfo.md | 2 +- .../SnapshotRepositoryAnalyzeSummaryInfo.md | 2 +- ...apshotRepositoryAnalyzeWriteSummaryInfo.md | 2 +- docs/reference/api/SnapshotRepositoryBase.md | 2 +- .../api/SnapshotRepositorySettingsBase.md | 2 +- ...napshotRepositoryVerifyIntegrityRequest.md | 2 +- ...apshotRepositoryVerifyIntegrityResponse.md | 6 ++-- docs/reference/api/SnapshotRestoreRequest.md | 2 +- docs/reference/api/SnapshotRestoreResponse.md | 2 +- .../api/SnapshotRestoreSnapshotRestore.md | 2 +- docs/reference/api/SnapshotS3Repository.md | 2 +- .../api/SnapshotS3RepositorySettings.md | 2 +- docs/reference/api/SnapshotShardsStats.md | 2 +- .../reference/api/SnapshotShardsStatsStage.md | 6 ++-- .../api/SnapshotShardsStatsSummary.md | 2 +- .../api/SnapshotShardsStatsSummaryItem.md | 2 +- .../api/SnapshotSharedFileSystemRepository.md | 2 +- ...pshotSharedFileSystemRepositorySettings.md | 2 +- .../api/SnapshotSnapshotIndexStats.md | 2 +- docs/reference/api/SnapshotSnapshotInfo.md | 2 +- .../api/SnapshotSnapshotShardFailure.md | 2 +- .../api/SnapshotSnapshotShardsStatus.md | 2 +- docs/reference/api/SnapshotSnapshotSort.md | 6 ++-- docs/reference/api/SnapshotSnapshotStats.md | 2 +- .../api/SnapshotSourceOnlyRepository.md | 2 +- .../SnapshotSourceOnlyRepositorySettings.md | 2 +- docs/reference/api/SnapshotStatus.md | 2 +- docs/reference/api/SnapshotStatusRequest.md | 2 +- docs/reference/api/SnapshotStatusResponse.md | 2 +- ...SnapshotVerifyRepositoryCompactNodeInfo.md | 2 +- .../api/SnapshotVerifyRepositoryRequest.md | 2 +- .../api/SnapshotVerifyRepositoryResponse.md | 2 +- docs/reference/api/SniffingTransport.md | 6 ++-- docs/reference/api/Sort.md | 6 ++-- docs/reference/api/SortCombinations.md | 6 ++-- docs/reference/api/SortMode.md | 6 ++-- docs/reference/api/SortOptions.md | 6 ++-- docs/reference/api/SortOptionsKeys.md | 2 +- docs/reference/api/SortOrder.md | 6 ++-- docs/reference/api/SortResults.md | 6 ++-- .../api/SpecUtilsAdditionalProperties.md | 2 +- .../api/SpecUtilsAdditionalProperty.md | 2 +- docs/reference/api/SpecUtilsBaseNode.md | 2 +- .../api/SpecUtilsCommonCatQueryParameters.md | 2 +- .../api/SpecUtilsCommonQueryParameters.md | 2 +- docs/reference/api/SpecUtilsNullValue.md | 6 ++-- docs/reference/api/SpecUtilsOverloadOf.md | 2 +- .../api/SpecUtilsPipeSeparatedFlags.md | 6 ++-- docs/reference/api/SpecUtilsStringified.md | 6 ++-- docs/reference/api/SpecUtilsWithNullValue.md | 6 ++-- docs/reference/api/Sql.md | 12 ++++---- docs/reference/api/SqlClearCursorRequest.md | 2 +- docs/reference/api/SqlClearCursorResponse.md | 2 +- docs/reference/api/SqlColumn.md | 2 +- docs/reference/api/SqlDeleteAsyncRequest.md | 2 +- docs/reference/api/SqlDeleteAsyncResponse.md | 6 ++-- docs/reference/api/SqlGetAsyncRequest.md | 2 +- docs/reference/api/SqlGetAsyncResponse.md | 2 +- .../reference/api/SqlGetAsyncStatusRequest.md | 2 +- .../api/SqlGetAsyncStatusResponse.md | 2 +- docs/reference/api/SqlQueryRequest.md | 2 +- docs/reference/api/SqlQueryResponse.md | 2 +- docs/reference/api/SqlQuerySqlFormat.md | 6 ++-- docs/reference/api/SqlRow.md | 6 ++-- docs/reference/api/SqlTranslateRequest.md | 2 +- docs/reference/api/SqlTranslateResponse.md | 2 +- docs/reference/api/Ssl.md | 12 ++++---- .../SslCertificatesCertificateInformation.md | 2 +- docs/reference/api/SslCertificatesRequest.md | 2 +- docs/reference/api/SslCertificatesResponse.md | 6 ++-- docs/reference/api/StandardRetriever.md | 2 +- docs/reference/api/StoreStats.md | 2 +- docs/reference/api/StoredScript.md | 2 +- docs/reference/api/StreamResult.md | 6 ++-- docs/reference/api/SuggestMode.md | 6 ++-- docs/reference/api/SuggestionName.md | 6 ++-- docs/reference/api/Synonyms.md | 12 ++++---- .../api/SynonymsDeleteSynonymRequest.md | 2 +- .../api/SynonymsDeleteSynonymResponse.md | 6 ++-- .../api/SynonymsDeleteSynonymRuleRequest.md | 2 +- .../api/SynonymsDeleteSynonymRuleResponse.md | 6 ++-- .../api/SynonymsGetSynonymRequest.md | 2 +- .../api/SynonymsGetSynonymResponse.md | 2 +- .../api/SynonymsGetSynonymRuleRequest.md | 2 +- .../api/SynonymsGetSynonymRuleResponse.md | 6 ++-- .../api/SynonymsGetSynonymsSetsRequest.md | 2 +- .../api/SynonymsGetSynonymsSetsResponse.md | 2 +- .../SynonymsGetSynonymsSetsSynonymsSetItem.md | 2 +- .../api/SynonymsPutSynonymRequest.md | 2 +- .../api/SynonymsPutSynonymResponse.md | 2 +- .../api/SynonymsPutSynonymRuleRequest.md | 2 +- .../api/SynonymsPutSynonymRuleResponse.md | 6 ++-- docs/reference/api/SynonymsSynonymRule.md | 2 +- docs/reference/api/SynonymsSynonymRuleRead.md | 2 +- docs/reference/api/SynonymsSynonymString.md | 6 ++-- .../api/SynonymsSynonymsUpdateResult.md | 2 +- docs/reference/api/TODO.md | 6 ++-- docs/reference/api/TaskFailure.md | 2 +- docs/reference/api/TaskId.md | 6 ++-- docs/reference/api/Tasks.md | 12 ++++---- docs/reference/api/TasksCancelRequest.md | 2 +- docs/reference/api/TasksCancelResponse.md | 6 ++-- docs/reference/api/TasksGetRequest.md | 2 +- docs/reference/api/TasksGetResponse.md | 2 +- docs/reference/api/TasksGroupBy.md | 6 ++-- docs/reference/api/TasksListRequest.md | 2 +- docs/reference/api/TasksListResponse.md | 6 ++-- docs/reference/api/TasksNodeTasks.md | 2 +- docs/reference/api/TasksParentTaskInfo.md | 2 +- docs/reference/api/TasksTaskInfo.md | 2 +- docs/reference/api/TasksTaskInfos.md | 6 ++-- .../api/TasksTaskListResponseBase.md | 2 +- docs/reference/api/TermsEnumApi_1.md | 4 +-- docs/reference/api/TermsEnumApi_2.md | 4 +-- docs/reference/api/TermsEnumApi_3.md | 4 +-- docs/reference/api/TermsEnumRequest.md | 2 +- docs/reference/api/TermsEnumResponse.md | 2 +- docs/reference/api/TermvectorsApi_1.md | 4 +-- docs/reference/api/TermvectorsApi_2.md | 4 +-- docs/reference/api/TermvectorsApi_3.md | 4 +-- .../api/TermvectorsFieldStatistics.md | 2 +- docs/reference/api/TermvectorsFilter.md | 2 +- docs/reference/api/TermvectorsRequest.md | 2 +- docs/reference/api/TermvectorsResponse.md | 2 +- docs/reference/api/TermvectorsTerm.md | 2 +- docs/reference/api/TermvectorsTermVector.md | 2 +- docs/reference/api/TermvectorsToken.md | 2 +- docs/reference/api/TextEmbedding.md | 2 +- docs/reference/api/TextSimilarityReranker.md | 2 +- docs/reference/api/TextStructure.md | 12 ++++---- .../api/TextStructureEcsCompatibilityType.md | 6 ++-- docs/reference/api/TextStructureFieldStat.md | 2 +- .../TextStructureFindFieldStructureRequest.md | 2 +- ...TextStructureFindFieldStructureResponse.md | 2 +- ...extStructureFindMessageStructureRequest.md | 2 +- ...xtStructureFindMessageStructureResponse.md | 2 +- .../api/TextStructureFindStructureRequest.md | 2 +- .../api/TextStructureFindStructureResponse.md | 2 +- docs/reference/api/TextStructureFormatType.md | 6 ++-- ...extStructureTestGrokPatternMatchedField.md | 2 +- ...TextStructureTestGrokPatternMatchedText.md | 2 +- .../TextStructureTestGrokPatternRequest.md | 2 +- .../TextStructureTestGrokPatternResponse.md | 2 +- docs/reference/api/TextStructureTopHit.md | 2 +- docs/reference/api/That.md | 2 +- docs/reference/api/That_10.md | 2 +- docs/reference/api/That_11.md | 2 +- docs/reference/api/That_12.md | 2 +- docs/reference/api/That_13.md | 2 +- docs/reference/api/That_14.md | 2 +- docs/reference/api/That_15.md | 2 +- docs/reference/api/That_16.md | 2 +- docs/reference/api/That_17.md | 2 +- docs/reference/api/That_18.md | 2 +- docs/reference/api/That_19.md | 2 +- docs/reference/api/That_20.md | 2 +- docs/reference/api/That_21.md | 2 +- docs/reference/api/That_22.md | 2 +- docs/reference/api/That_23.md | 2 +- docs/reference/api/That_24.md | 2 +- docs/reference/api/That_25.md | 2 +- docs/reference/api/That_26.md | 2 +- docs/reference/api/That_27.md | 2 +- docs/reference/api/That_28.md | 2 +- docs/reference/api/That_29.md | 2 +- docs/reference/api/That_3.md | 2 +- docs/reference/api/That_30.md | 2 +- docs/reference/api/That_31.md | 2 +- docs/reference/api/That_32.md | 2 +- docs/reference/api/That_33.md | 2 +- docs/reference/api/That_34.md | 2 +- docs/reference/api/That_35.md | 2 +- docs/reference/api/That_36.md | 2 +- docs/reference/api/That_37.md | 2 +- docs/reference/api/That_38.md | 2 +- docs/reference/api/That_39.md | 2 +- docs/reference/api/That_4.md | 2 +- docs/reference/api/That_40.md | 2 +- docs/reference/api/That_41.md | 2 +- docs/reference/api/That_42.md | 2 +- docs/reference/api/That_43.md | 2 +- docs/reference/api/That_44.md | 2 +- docs/reference/api/That_45.md | 2 +- docs/reference/api/That_46.md | 2 +- docs/reference/api/That_47.md | 2 +- docs/reference/api/That_48.md | 2 +- docs/reference/api/That_49.md | 2 +- docs/reference/api/That_5.md | 2 +- docs/reference/api/That_50.md | 2 +- docs/reference/api/That_51.md | 2 +- docs/reference/api/That_52.md | 2 +- docs/reference/api/That_53.md | 2 +- docs/reference/api/That_54.md | 2 +- docs/reference/api/That_55.md | 2 +- docs/reference/api/That_56.md | 2 +- docs/reference/api/That_57.md | 2 +- docs/reference/api/That_58.md | 2 +- docs/reference/api/That_59.md | 2 +- docs/reference/api/That_6.md | 2 +- docs/reference/api/That_60.md | 2 +- docs/reference/api/That_61.md | 2 +- docs/reference/api/That_62.md | 2 +- docs/reference/api/That_63.md | 2 +- docs/reference/api/That_64.md | 2 +- docs/reference/api/That_65.md | 2 +- docs/reference/api/That_66.md | 2 +- docs/reference/api/That_67.md | 2 +- docs/reference/api/That_68.md | 2 +- docs/reference/api/That_69.md | 2 +- docs/reference/api/That_7.md | 2 +- docs/reference/api/That_70.md | 2 +- docs/reference/api/That_71.md | 2 +- docs/reference/api/That_72.md | 2 +- docs/reference/api/That_73.md | 2 +- docs/reference/api/That_74.md | 2 +- docs/reference/api/That_75.md | 2 +- docs/reference/api/That_76.md | 2 +- docs/reference/api/That_77.md | 2 +- docs/reference/api/That_78.md | 2 +- docs/reference/api/That_79.md | 2 +- docs/reference/api/That_8.md | 2 +- docs/reference/api/That_80.md | 2 +- docs/reference/api/That_81.md | 2 +- docs/reference/api/That_82.md | 2 +- docs/reference/api/That_83.md | 2 +- docs/reference/api/That_84.md | 2 +- docs/reference/api/That_85.md | 2 +- docs/reference/api/That_86.md | 2 +- docs/reference/api/That_9.md | 2 +- docs/reference/api/ThreadType.md | 6 ++-- docs/reference/api/TimeOfDay.md | 6 ++-- docs/reference/api/TimeUnit.md | 6 ++-- docs/reference/api/TimeZone.md | 6 ++-- .../api/TopLeftBottomRightGeoBounds.md | 2 +- .../api/TopRightBottomLeftGeoBounds.md | 2 +- docs/reference/api/Transform.md | 12 ++++---- docs/reference/api/TransformContainer.md | 2 +- .../api/TransformDeleteTransformRequest.md | 2 +- .../api/TransformDeleteTransformResponse.md | 6 ++-- docs/reference/api/TransformDestination.md | 2 +- .../api/TransformGetTransformRequest.md | 2 +- .../api/TransformGetTransformResponse.md | 2 +- ...ansformGetTransformStatsCheckpointStats.md | 2 +- ...TransformGetTransformStatsCheckpointing.md | 2 +- .../api/TransformGetTransformStatsRequest.md | 2 +- .../api/TransformGetTransformStatsResponse.md | 2 +- ...rmGetTransformStatsTransformHealthIssue.md | 2 +- ...mGetTransformStatsTransformIndexerStats.md | 2 +- ...sformGetTransformStatsTransformProgress.md | 2 +- ...ransformGetTransformStatsTransformStats.md | 2 +- ...rmGetTransformStatsTransformStatsHealth.md | 2 +- .../TransformGetTransformTransformSummary.md | 2 +- docs/reference/api/TransformLatest.md | 2 +- docs/reference/api/TransformPivot.md | 2 +- .../api/TransformPivotGroupByContainer.md | 2 +- .../api/TransformPreviewTransformRequest.md | 2 +- .../api/TransformPreviewTransformResponse.md | 2 +- .../api/TransformPutTransformRequest.md | 2 +- .../api/TransformPutTransformResponse.md | 6 ++-- .../api/TransformResetTransformRequest.md | 2 +- .../api/TransformResetTransformResponse.md | 6 ++-- .../reference/api/TransformRetentionPolicy.md | 2 +- .../api/TransformRetentionPolicyContainer.md | 2 +- .../TransformScheduleNowTransformRequest.md | 2 +- .../TransformScheduleNowTransformResponse.md | 6 ++-- docs/reference/api/TransformSettings.md | 2 +- docs/reference/api/TransformSource.md | 2 +- .../api/TransformStartTransformRequest.md | 2 +- .../api/TransformStartTransformResponse.md | 6 ++-- .../api/TransformStopTransformRequest.md | 2 +- .../api/TransformStopTransformResponse.md | 6 ++-- docs/reference/api/TransformSyncContainer.md | 2 +- docs/reference/api/TransformTimeSync.md | 2 +- .../api/TransformUpdateTransformRequest.md | 2 +- .../api/TransformUpdateTransformResponse.md | 2 +- .../api/TransformUpgradeTransformsRequest.md | 2 +- .../api/TransformUpgradeTransformsResponse.md | 2 +- docs/reference/api/TranslogStats.md | 2 +- docs/reference/api/TransportAddress.md | 6 ++-- docs/reference/api/UnitFloatMillis.md | 6 ++-- docs/reference/api/UnitMillis.md | 6 ++-- docs/reference/api/UnitNanos.md | 6 ++-- docs/reference/api/UnitSeconds.md | 6 ++-- docs/reference/api/UpdateAction.md | 6 ++-- docs/reference/api/UpdateActionOperation.md | 2 +- docs/reference/api/UpdateApi_1.md | 4 +-- docs/reference/api/UpdateApi_2.md | 4 +-- docs/reference/api/UpdateApi_3.md | 4 +-- docs/reference/api/UpdateByQueryApi_1.md | 4 +-- docs/reference/api/UpdateByQueryApi_2.md | 4 +-- docs/reference/api/UpdateByQueryApi_3.md | 4 +-- docs/reference/api/UpdateByQueryRequest.md | 2 +- docs/reference/api/UpdateByQueryResponse.md | 2 +- .../api/UpdateByQueryRethrottleApi_1.md | 4 +-- .../api/UpdateByQueryRethrottleApi_2.md | 4 +-- .../api/UpdateByQueryRethrottleApi_3.md | 4 +-- .../api/UpdateByQueryRethrottleRequest.md | 2 +- .../api/UpdateByQueryRethrottleResponse.md | 2 +- ...ryRethrottleUpdateByQueryRethrottleNode.md | 2 +- docs/reference/api/UpdateRequest.md | 2 +- docs/reference/api/UpdateResponse.md | 6 ++-- .../api/UpdateUpdateWriteResponseBase.md | 2 +- docs/reference/api/Username.md | 6 ++-- docs/reference/api/Uuid.md | 6 ++-- docs/reference/api/VersionNumber.md | 6 ++-- docs/reference/api/VersionString.md | 6 ++-- docs/reference/api/VersionType.md | 6 ++-- .../api/WaitForActiveShardOptions.md | 6 ++-- docs/reference/api/WaitForActiveShards.md | 6 ++-- docs/reference/api/WaitForEvents.md | 6 ++-- docs/reference/api/WarmerStats.md | 2 +- docs/reference/api/Watcher.md | 12 ++++---- docs/reference/api/WatcherAckWatchRequest.md | 2 +- docs/reference/api/WatcherAckWatchResponse.md | 2 +- docs/reference/api/WatcherAcknowledgeState.md | 2 +- .../api/WatcherAcknowledgementOptions.md | 6 ++-- docs/reference/api/WatcherAction.md | 2 +- .../api/WatcherActionExecutionMode.md | 6 ++-- docs/reference/api/WatcherActionStatus.md | 2 +- .../api/WatcherActionStatusOptions.md | 6 ++-- docs/reference/api/WatcherActionType.md | 6 ++-- docs/reference/api/WatcherActions.md | 6 ++-- .../api/WatcherActivateWatchRequest.md | 2 +- .../api/WatcherActivateWatchResponse.md | 2 +- docs/reference/api/WatcherActivationState.md | 2 +- docs/reference/api/WatcherActivationStatus.md | 2 +- docs/reference/api/WatcherAlwaysCondition.md | 2 +- .../api/WatcherArrayCompareCondition.md | 6 ++-- .../api/WatcherArrayCompareConditionKeys.md | 2 +- .../api/WatcherArrayCompareOpParams.md | 2 +- docs/reference/api/WatcherChainInput.md | 2 +- .../api/WatcherConditionContainer.md | 2 +- docs/reference/api/WatcherConditionOp.md | 6 ++-- docs/reference/api/WatcherConditionType.md | 6 ++-- docs/reference/api/WatcherConnectionScheme.md | 6 ++-- docs/reference/api/WatcherCronExpression.md | 6 ++-- docs/reference/api/WatcherDailySchedule.md | 2 +- .../api/WatcherDataAttachmentFormat.md | 6 ++-- .../api/WatcherDataEmailAttachment.md | 2 +- docs/reference/api/WatcherDay.md | 6 ++-- .../api/WatcherDeactivateWatchRequest.md | 2 +- .../api/WatcherDeactivateWatchResponse.md | 2 +- .../api/WatcherDeleteWatchRequest.md | 2 +- .../api/WatcherDeleteWatchResponse.md | 2 +- docs/reference/api/WatcherEmail.md | 2 +- docs/reference/api/WatcherEmailAction.md | 2 +- .../api/WatcherEmailAttachmentContainer.md | 2 +- docs/reference/api/WatcherEmailBody.md | 2 +- docs/reference/api/WatcherEmailPriority.md | 6 ++-- docs/reference/api/WatcherEmailResult.md | 2 +- .../api/WatcherExecuteWatchRequest.md | 2 +- .../api/WatcherExecuteWatchResponse.md | 2 +- .../api/WatcherExecuteWatchWatchRecord.md | 2 +- docs/reference/api/WatcherExecutionPhase.md | 6 ++-- docs/reference/api/WatcherExecutionResult.md | 2 +- .../api/WatcherExecutionResultAction.md | 2 +- .../api/WatcherExecutionResultCondition.md | 2 +- .../api/WatcherExecutionResultInput.md | 2 +- docs/reference/api/WatcherExecutionState.md | 2 +- docs/reference/api/WatcherExecutionStatus.md | 6 ++-- .../api/WatcherExecutionThreadPool.md | 2 +- .../api/WatcherGetSettingsRequest.md | 2 +- .../api/WatcherGetSettingsResponse.md | 2 +- docs/reference/api/WatcherGetWatchRequest.md | 2 +- docs/reference/api/WatcherGetWatchResponse.md | 2 +- docs/reference/api/WatcherHourAndMinute.md | 2 +- docs/reference/api/WatcherHourlySchedule.md | 2 +- .../api/WatcherHttpEmailAttachment.md | 2 +- docs/reference/api/WatcherHttpInput.md | 2 +- .../api/WatcherHttpInputAuthentication.md | 2 +- .../WatcherHttpInputBasicAuthentication.md | 2 +- docs/reference/api/WatcherHttpInputMethod.md | 6 ++-- docs/reference/api/WatcherHttpInputProxy.md | 2 +- .../api/WatcherHttpInputRequestDefinition.md | 2 +- .../api/WatcherHttpInputRequestResult.md | 2 +- .../api/WatcherHttpInputResponseResult.md | 2 +- docs/reference/api/WatcherIndexAction.md | 2 +- docs/reference/api/WatcherIndexResult.md | 2 +- .../api/WatcherIndexResultSummary.md | 2 +- docs/reference/api/WatcherInputContainer.md | 2 +- docs/reference/api/WatcherInputType.md | 6 ++-- docs/reference/api/WatcherLoggingAction.md | 2 +- docs/reference/api/WatcherLoggingResult.md | 2 +- docs/reference/api/WatcherMonth.md | 6 ++-- docs/reference/api/WatcherNeverCondition.md | 2 +- docs/reference/api/WatcherPagerDutyAction.md | 2 +- docs/reference/api/WatcherPagerDutyContext.md | 2 +- .../api/WatcherPagerDutyContextType.md | 6 ++-- docs/reference/api/WatcherPagerDutyEvent.md | 2 +- .../api/WatcherPagerDutyEventProxy.md | 2 +- .../api/WatcherPagerDutyEventType.md | 6 ++-- docs/reference/api/WatcherPagerDutyResult.md | 2 +- docs/reference/api/WatcherPutWatchRequest.md | 2 +- docs/reference/api/WatcherPutWatchResponse.md | 2 +- docs/reference/api/WatcherQuantifier.md | 6 ++-- docs/reference/api/WatcherQueryWatch.md | 2 +- .../api/WatcherQueryWatchesRequest.md | 2 +- .../api/WatcherQueryWatchesResponse.md | 2 +- .../api/WatcherReportingEmailAttachment.md | 2 +- .../api/WatcherResponseContentType.md | 6 ++-- .../reference/api/WatcherScheduleContainer.md | 2 +- .../reference/api/WatcherScheduleTimeOfDay.md | 6 ++-- .../api/WatcherScheduleTriggerEvent.md | 2 +- docs/reference/api/WatcherScriptCondition.md | 2 +- docs/reference/api/WatcherSearchInput.md | 2 +- .../api/WatcherSearchInputRequestBody.md | 2 +- .../WatcherSearchInputRequestDefinition.md | 2 +- .../api/WatcherSearchTemplateRequestBody.md | 2 +- docs/reference/api/WatcherSimulatedActions.md | 2 +- docs/reference/api/WatcherSlackAction.md | 2 +- docs/reference/api/WatcherSlackAttachment.md | 2 +- .../api/WatcherSlackAttachmentField.md | 2 +- .../api/WatcherSlackDynamicAttachment.md | 2 +- docs/reference/api/WatcherSlackMessage.md | 2 +- docs/reference/api/WatcherSlackResult.md | 2 +- docs/reference/api/WatcherStartRequest.md | 2 +- docs/reference/api/WatcherStartResponse.md | 6 ++-- docs/reference/api/WatcherStatsRequest.md | 2 +- docs/reference/api/WatcherStatsResponse.md | 2 +- .../api/WatcherStatsWatchRecordQueuedStats.md | 2 +- .../api/WatcherStatsWatchRecordStats.md | 2 +- .../api/WatcherStatsWatcherMetric.md | 6 ++-- .../api/WatcherStatsWatcherNodeStats.md | 2 +- .../reference/api/WatcherStatsWatcherState.md | 6 ++-- docs/reference/api/WatcherStopRequest.md | 2 +- docs/reference/api/WatcherStopResponse.md | 6 ++-- docs/reference/api/WatcherThrottleState.md | 2 +- docs/reference/api/WatcherTimeOfMonth.md | 2 +- docs/reference/api/WatcherTimeOfWeek.md | 2 +- docs/reference/api/WatcherTimeOfYear.md | 2 +- docs/reference/api/WatcherTriggerContainer.md | 2 +- .../api/WatcherTriggerEventContainer.md | 2 +- .../api/WatcherTriggerEventResult.md | 2 +- .../api/WatcherUpdateSettingsRequest.md | 2 +- .../api/WatcherUpdateSettingsResponse.md | 2 +- docs/reference/api/WatcherWatch.md | 2 +- docs/reference/api/WatcherWatchStatus.md | 2 +- docs/reference/api/WatcherWebhookAction.md | 2 +- docs/reference/api/WatcherWebhookResult.md | 2 +- docs/reference/api/WktGeoBounds.md | 2 +- docs/reference/api/WriteResponseBase.md | 2 +- docs/reference/api/Xpack.md | 12 ++++---- .../api/XpackInfoBuildInformation.md | 2 +- docs/reference/api/XpackInfoFeature.md | 2 +- docs/reference/api/XpackInfoFeatures.md | 2 +- .../api/XpackInfoMinimalLicenseInformation.md | 2 +- .../api/XpackInfoNativeCodeInformation.md | 2 +- docs/reference/api/XpackInfoRequest.md | 2 +- docs/reference/api/XpackInfoResponse.md | 2 +- docs/reference/api/XpackInfoXPackCategory.md | 6 ++-- docs/reference/api/XpackUsageAnalytics.md | 2 +- .../api/XpackUsageAnalyticsStatistics.md | 2 +- docs/reference/api/XpackUsageArchive.md | 2 +- docs/reference/api/XpackUsageAudit.md | 2 +- docs/reference/api/XpackUsageBase.md | 2 +- docs/reference/api/XpackUsageCcr.md | 2 +- docs/reference/api/XpackUsageCounter.md | 2 +- docs/reference/api/XpackUsageDataStreams.md | 2 +- .../api/XpackUsageDataTierPhaseStatistics.md | 2 +- docs/reference/api/XpackUsageDataTiers.md | 2 +- docs/reference/api/XpackUsageDatafeed.md | 2 +- docs/reference/api/XpackUsageEql.md | 2 +- docs/reference/api/XpackUsageEqlFeatures.md | 2 +- .../api/XpackUsageEqlFeaturesJoin.md | 2 +- .../api/XpackUsageEqlFeaturesKeys.md | 2 +- .../api/XpackUsageEqlFeaturesPipes.md | 2 +- .../api/XpackUsageEqlFeaturesSequences.md | 2 +- docs/reference/api/XpackUsageFeatureToggle.md | 2 +- docs/reference/api/XpackUsageFlattened.md | 2 +- .../api/XpackUsageHealthStatistics.md | 2 +- docs/reference/api/XpackUsageIlm.md | 2 +- .../api/XpackUsageIlmPolicyStatistics.md | 2 +- docs/reference/api/XpackUsageInvocations.md | 2 +- docs/reference/api/XpackUsageIpFilter.md | 2 +- docs/reference/api/XpackUsageJobUsage.md | 2 +- .../api/XpackUsageMachineLearning.md | 2 +- docs/reference/api/XpackUsageMlCounter.md | 2 +- .../api/XpackUsageMlDataFrameAnalyticsJobs.md | 2 +- ...ckUsageMlDataFrameAnalyticsJobsAnalysis.md | 2 +- ...XpackUsageMlDataFrameAnalyticsJobsCount.md | 2 +- ...packUsageMlDataFrameAnalyticsJobsMemory.md | 2 +- docs/reference/api/XpackUsageMlInference.md | 2 +- .../api/XpackUsageMlInferenceDeployments.md | 2 +- .../XpackUsageMlInferenceDeploymentsTimeMs.md | 2 +- .../XpackUsageMlInferenceIngestProcessor.md | 2 +- ...ackUsageMlInferenceIngestProcessorCount.md | 2 +- .../api/XpackUsageMlInferenceTrainedModels.md | 2 +- ...XpackUsageMlInferenceTrainedModelsCount.md | 2 +- .../reference/api/XpackUsageMlJobForecasts.md | 2 +- docs/reference/api/XpackUsageMonitoring.md | 2 +- docs/reference/api/XpackUsagePhase.md | 2 +- docs/reference/api/XpackUsagePhases.md | 2 +- docs/reference/api/XpackUsageQuery.md | 2 +- docs/reference/api/XpackUsageRealm.md | 2 +- docs/reference/api/XpackUsageRealmCache.md | 2 +- docs/reference/api/XpackUsageRequest.md | 2 +- docs/reference/api/XpackUsageResponse.md | 2 +- docs/reference/api/XpackUsageRoleMapping.md | 2 +- .../api/XpackUsageRuntimeFieldTypes.md | 2 +- .../api/XpackUsageRuntimeFieldsType.md | 2 +- .../api/XpackUsageSearchableSnapshots.md | 2 +- docs/reference/api/XpackUsageSecurity.md | 2 +- docs/reference/api/XpackUsageSecurityRoles.md | 2 +- .../api/XpackUsageSecurityRolesDls.md | 2 +- .../XpackUsageSecurityRolesDlsBitSetCache.md | 2 +- .../api/XpackUsageSecurityRolesFile.md | 2 +- .../api/XpackUsageSecurityRolesNative.md | 2 +- docs/reference/api/XpackUsageSlm.md | 2 +- docs/reference/api/XpackUsageSql.md | 2 +- docs/reference/api/XpackUsageSsl.md | 2 +- docs/reference/api/XpackUsageVector.md | 2 +- docs/reference/api/XpackUsageWatcher.md | 2 +- .../api/XpackUsageWatcherActionTotals.md | 2 +- .../reference/api/XpackUsageWatcherActions.md | 2 +- docs/reference/api/XpackUsageWatcherWatch.md | 2 +- .../api/XpackUsageWatcherWatchTrigger.md | 2 +- .../XpackUsageWatcherWatchTriggerSchedule.md | 2 +- docs/reference/api/byte.md | 6 ++-- docs/reference/api/double.md | 6 ++-- docs/reference/api/float.md | 6 ++-- docs/reference/api/integer.md | 6 ++-- docs/reference/api/long.md | 6 ++-- docs/reference/api/short.md | 6 ++-- docs/reference/api/uint.md | 6 ++-- docs/reference/api/ulong.md | 6 ++-- scripts/docgen.mjs | 29 +++++++++---------- 3741 files changed, 5628 insertions(+), 5631 deletions(-) diff --git a/docs/reference/api-reference.md b/docs/reference/api-reference.md index 3e8c8e71b..e19c48139 100644 --- a/docs/reference/api-reference.md +++ b/docs/reference/api-reference.md @@ -3,6 +3,6 @@ mapped_pages: - https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/api-reference.html --- -## API Documentation [_index] +# API Reference [api-reference] See API documentation [here](./api/Client.md) diff --git a/docs/reference/api/API.md b/docs/reference/api/API.md index 84562a11b..20250049f 100644 --- a/docs/reference/api/API.md +++ b/docs/reference/api/API.md @@ -1,4 +1,4 @@ -## Interface `API` +# `API` [interface-API] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AcknowledgedResponseBase.md b/docs/reference/api/AcknowledgedResponseBase.md index bf1f8d932..57db7b158 100644 --- a/docs/reference/api/AcknowledgedResponseBase.md +++ b/docs/reference/api/AcknowledgedResponseBase.md @@ -1,4 +1,4 @@ -## Interface `AcknowledgedResponseBase` +# `AcknowledgedResponseBase` [interface-AcknowledgedResponseBase] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/Action.md b/docs/reference/api/Action.md index becfb8034..70551ea71 100644 --- a/docs/reference/api/Action.md +++ b/docs/reference/api/Action.md @@ -1,4 +1,4 @@ -## `Action` -::: +# `Action` [alias-Action] +```typescript type Action = [IndexAction](./IndexAction.md) | [CreateAction](./CreateAction.md) | [UpdateAction](./UpdateAction.md) | [DeleteAction](./DeleteAction.md); -::: +``` diff --git a/docs/reference/api/AggregateName.md b/docs/reference/api/AggregateName.md index 9c1fd5077..e327b1356 100644 --- a/docs/reference/api/AggregateName.md +++ b/docs/reference/api/AggregateName.md @@ -1,4 +1,4 @@ -## `AggregateName` -::: +# `AggregateName` [alias-AggregateName] +```typescript type AggregateName = string; -::: +``` diff --git a/docs/reference/api/AggregationsAdjacencyMatrixAggregate.md b/docs/reference/api/AggregationsAdjacencyMatrixAggregate.md index fb626e398..647b7797d 100644 --- a/docs/reference/api/AggregationsAdjacencyMatrixAggregate.md +++ b/docs/reference/api/AggregationsAdjacencyMatrixAggregate.md @@ -1,4 +1,4 @@ -## Interface `AggregationsAdjacencyMatrixAggregate` +# `AggregationsAdjacencyMatrixAggregate` [interface-AggregationsAdjacencyMatrixAggregate] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsAdjacencyMatrixAggregation.md b/docs/reference/api/AggregationsAdjacencyMatrixAggregation.md index b4bc5bbb0..3e7099df6 100644 --- a/docs/reference/api/AggregationsAdjacencyMatrixAggregation.md +++ b/docs/reference/api/AggregationsAdjacencyMatrixAggregation.md @@ -1,4 +1,4 @@ -## Interface `AggregationsAdjacencyMatrixAggregation` +# `AggregationsAdjacencyMatrixAggregation` [interface-AggregationsAdjacencyMatrixAggregation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsAdjacencyMatrixBucket.md b/docs/reference/api/AggregationsAdjacencyMatrixBucket.md index f5eefdeb0..4a215da7a 100644 --- a/docs/reference/api/AggregationsAdjacencyMatrixBucket.md +++ b/docs/reference/api/AggregationsAdjacencyMatrixBucket.md @@ -1,4 +1,4 @@ -## `AggregationsAdjacencyMatrixBucket` -::: +# `AggregationsAdjacencyMatrixBucket` [alias-AggregationsAdjacencyMatrixBucket] +```typescript type AggregationsAdjacencyMatrixBucket = [AggregationsAdjacencyMatrixBucketKeys](./AggregationsAdjacencyMatrixBucketKeys.md) & { [property: string]: [AggregationsAggregate](./AggregationsAggregate.md) | string | [long](./long.md);}; -::: +``` diff --git a/docs/reference/api/AggregationsAdjacencyMatrixBucketKeys.md b/docs/reference/api/AggregationsAdjacencyMatrixBucketKeys.md index ab6fb4a19..87011b269 100644 --- a/docs/reference/api/AggregationsAdjacencyMatrixBucketKeys.md +++ b/docs/reference/api/AggregationsAdjacencyMatrixBucketKeys.md @@ -1,4 +1,4 @@ -## Interface `AggregationsAdjacencyMatrixBucketKeys` +# `AggregationsAdjacencyMatrixBucketKeys` [interface-AggregationsAdjacencyMatrixBucketKeys] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsAggregate.md b/docs/reference/api/AggregationsAggregate.md index c95020134..516c1df6a 100644 --- a/docs/reference/api/AggregationsAggregate.md +++ b/docs/reference/api/AggregationsAggregate.md @@ -1,4 +1,4 @@ -## `AggregationsAggregate` -::: +# `AggregationsAggregate` [alias-AggregationsAggregate] +```typescript type AggregationsAggregate = [AggregationsCardinalityAggregate](./AggregationsCardinalityAggregate.md) | [AggregationsHdrPercentilesAggregate](./AggregationsHdrPercentilesAggregate.md) | [AggregationsHdrPercentileRanksAggregate](./AggregationsHdrPercentileRanksAggregate.md) | [AggregationsTDigestPercentilesAggregate](./AggregationsTDigestPercentilesAggregate.md) | [AggregationsTDigestPercentileRanksAggregate](./AggregationsTDigestPercentileRanksAggregate.md) | [AggregationsPercentilesBucketAggregate](./AggregationsPercentilesBucketAggregate.md) | [AggregationsMedianAbsoluteDeviationAggregate](./AggregationsMedianAbsoluteDeviationAggregate.md) | [AggregationsMinAggregate](./AggregationsMinAggregate.md) | [AggregationsMaxAggregate](./AggregationsMaxAggregate.md) | [AggregationsSumAggregate](./AggregationsSumAggregate.md) | [AggregationsAvgAggregate](./AggregationsAvgAggregate.md) | [AggregationsWeightedAvgAggregate](./AggregationsWeightedAvgAggregate.md) | [AggregationsValueCountAggregate](./AggregationsValueCountAggregate.md) | [AggregationsSimpleValueAggregate](./AggregationsSimpleValueAggregate.md) | [AggregationsDerivativeAggregate](./AggregationsDerivativeAggregate.md) | [AggregationsBucketMetricValueAggregate](./AggregationsBucketMetricValueAggregate.md) | [AggregationsStatsAggregate](./AggregationsStatsAggregate.md) | [AggregationsStatsBucketAggregate](./AggregationsStatsBucketAggregate.md) | [AggregationsExtendedStatsAggregate](./AggregationsExtendedStatsAggregate.md) | [AggregationsExtendedStatsBucketAggregate](./AggregationsExtendedStatsBucketAggregate.md) | [AggregationsGeoBoundsAggregate](./AggregationsGeoBoundsAggregate.md) | [AggregationsGeoCentroidAggregate](./AggregationsGeoCentroidAggregate.md) | [AggregationsHistogramAggregate](./AggregationsHistogramAggregate.md) | [AggregationsDateHistogramAggregate](./AggregationsDateHistogramAggregate.md) | [AggregationsAutoDateHistogramAggregate](./AggregationsAutoDateHistogramAggregate.md) | [AggregationsVariableWidthHistogramAggregate](./AggregationsVariableWidthHistogramAggregate.md) | [AggregationsStringTermsAggregate](./AggregationsStringTermsAggregate.md) | [AggregationsLongTermsAggregate](./AggregationsLongTermsAggregate.md) | [AggregationsDoubleTermsAggregate](./AggregationsDoubleTermsAggregate.md) | [AggregationsUnmappedTermsAggregate](./AggregationsUnmappedTermsAggregate.md) | [AggregationsLongRareTermsAggregate](./AggregationsLongRareTermsAggregate.md) | [AggregationsStringRareTermsAggregate](./AggregationsStringRareTermsAggregate.md) | [AggregationsUnmappedRareTermsAggregate](./AggregationsUnmappedRareTermsAggregate.md) | [AggregationsMultiTermsAggregate](./AggregationsMultiTermsAggregate.md) | [AggregationsMissingAggregate](./AggregationsMissingAggregate.md) | [AggregationsNestedAggregate](./AggregationsNestedAggregate.md) | [AggregationsReverseNestedAggregate](./AggregationsReverseNestedAggregate.md) | [AggregationsGlobalAggregate](./AggregationsGlobalAggregate.md) | [AggregationsFilterAggregate](./AggregationsFilterAggregate.md) | [AggregationsChildrenAggregate](./AggregationsChildrenAggregate.md) | [AggregationsParentAggregate](./AggregationsParentAggregate.md) | [AggregationsSamplerAggregate](./AggregationsSamplerAggregate.md) | [AggregationsUnmappedSamplerAggregate](./AggregationsUnmappedSamplerAggregate.md) | [AggregationsGeoHashGridAggregate](./AggregationsGeoHashGridAggregate.md) | [AggregationsGeoTileGridAggregate](./AggregationsGeoTileGridAggregate.md) | [AggregationsGeoHexGridAggregate](./AggregationsGeoHexGridAggregate.md) | [AggregationsRangeAggregate](./AggregationsRangeAggregate.md) | [AggregationsDateRangeAggregate](./AggregationsDateRangeAggregate.md) | [AggregationsGeoDistanceAggregate](./AggregationsGeoDistanceAggregate.md) | [AggregationsIpRangeAggregate](./AggregationsIpRangeAggregate.md) | [AggregationsIpPrefixAggregate](./AggregationsIpPrefixAggregate.md) | [AggregationsFiltersAggregate](./AggregationsFiltersAggregate.md) | [AggregationsAdjacencyMatrixAggregate](./AggregationsAdjacencyMatrixAggregate.md) | [AggregationsSignificantLongTermsAggregate](./AggregationsSignificantLongTermsAggregate.md) | [AggregationsSignificantStringTermsAggregate](./AggregationsSignificantStringTermsAggregate.md) | [AggregationsUnmappedSignificantTermsAggregate](./AggregationsUnmappedSignificantTermsAggregate.md) | [AggregationsCompositeAggregate](./AggregationsCompositeAggregate.md) | [AggregationsFrequentItemSetsAggregate](./AggregationsFrequentItemSetsAggregate.md) | [AggregationsTimeSeriesAggregate](./AggregationsTimeSeriesAggregate.md) | [AggregationsScriptedMetricAggregate](./AggregationsScriptedMetricAggregate.md) | [AggregationsTopHitsAggregate](./AggregationsTopHitsAggregate.md) | [AggregationsInferenceAggregate](./AggregationsInferenceAggregate.md) | [AggregationsStringStatsAggregate](./AggregationsStringStatsAggregate.md) | [AggregationsBoxPlotAggregate](./AggregationsBoxPlotAggregate.md) | [AggregationsTopMetricsAggregate](./AggregationsTopMetricsAggregate.md) | [AggregationsTTestAggregate](./AggregationsTTestAggregate.md) | [AggregationsRateAggregate](./AggregationsRateAggregate.md) | [AggregationsCumulativeCardinalityAggregate](./AggregationsCumulativeCardinalityAggregate.md) | [AggregationsMatrixStatsAggregate](./AggregationsMatrixStatsAggregate.md) | [AggregationsGeoLineAggregate](./AggregationsGeoLineAggregate.md); -::: +``` diff --git a/docs/reference/api/AggregationsAggregateBase.md b/docs/reference/api/AggregationsAggregateBase.md index 9f16a5c0b..578a4cad7 100644 --- a/docs/reference/api/AggregationsAggregateBase.md +++ b/docs/reference/api/AggregationsAggregateBase.md @@ -1,4 +1,4 @@ -## Interface `AggregationsAggregateBase` +# `AggregationsAggregateBase` [interface-AggregationsAggregateBase] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsAggregateOrder.md b/docs/reference/api/AggregationsAggregateOrder.md index 36bc9db21..35b37772f 100644 --- a/docs/reference/api/AggregationsAggregateOrder.md +++ b/docs/reference/api/AggregationsAggregateOrder.md @@ -1,4 +1,4 @@ -## `AggregationsAggregateOrder` -::: +# `AggregationsAggregateOrder` [alias-AggregationsAggregateOrder] +```typescript type AggregationsAggregateOrder = [Partial](./Partial.md)> | [Partial](./Partial.md)>[]; -::: +``` diff --git a/docs/reference/api/AggregationsAggregation.md b/docs/reference/api/AggregationsAggregation.md index a6c17e10d..96d682824 100644 --- a/docs/reference/api/AggregationsAggregation.md +++ b/docs/reference/api/AggregationsAggregation.md @@ -1,4 +1,4 @@ -## Interface `AggregationsAggregation` +# `AggregationsAggregation` [interface-AggregationsAggregation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsAggregationContainer.md b/docs/reference/api/AggregationsAggregationContainer.md index f2ee16502..18bd9d1e4 100644 --- a/docs/reference/api/AggregationsAggregationContainer.md +++ b/docs/reference/api/AggregationsAggregationContainer.md @@ -1,4 +1,4 @@ -## Interface `AggregationsAggregationContainer` +# `AggregationsAggregationContainer` [interface-AggregationsAggregationContainer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsAggregationRange.md b/docs/reference/api/AggregationsAggregationRange.md index 5b9275c9b..2d01f0615 100644 --- a/docs/reference/api/AggregationsAggregationRange.md +++ b/docs/reference/api/AggregationsAggregationRange.md @@ -1,4 +1,4 @@ -## Interface `AggregationsAggregationRange` +# `AggregationsAggregationRange` [interface-AggregationsAggregationRange] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsArrayPercentilesItem.md b/docs/reference/api/AggregationsArrayPercentilesItem.md index b03d277f5..7b34e94ca 100644 --- a/docs/reference/api/AggregationsArrayPercentilesItem.md +++ b/docs/reference/api/AggregationsArrayPercentilesItem.md @@ -1,4 +1,4 @@ -## Interface `AggregationsArrayPercentilesItem` +# `AggregationsArrayPercentilesItem` [interface-AggregationsArrayPercentilesItem] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsAutoDateHistogramAggregate.md b/docs/reference/api/AggregationsAutoDateHistogramAggregate.md index 08f862956..96797f7c8 100644 --- a/docs/reference/api/AggregationsAutoDateHistogramAggregate.md +++ b/docs/reference/api/AggregationsAutoDateHistogramAggregate.md @@ -1,4 +1,4 @@ -## Interface `AggregationsAutoDateHistogramAggregate` +# `AggregationsAutoDateHistogramAggregate` [interface-AggregationsAutoDateHistogramAggregate] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsAutoDateHistogramAggregation.md b/docs/reference/api/AggregationsAutoDateHistogramAggregation.md index eb9fd3f7e..344182ed6 100644 --- a/docs/reference/api/AggregationsAutoDateHistogramAggregation.md +++ b/docs/reference/api/AggregationsAutoDateHistogramAggregation.md @@ -1,4 +1,4 @@ -## Interface `AggregationsAutoDateHistogramAggregation` +# `AggregationsAutoDateHistogramAggregation` [interface-AggregationsAutoDateHistogramAggregation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsAverageAggregation.md b/docs/reference/api/AggregationsAverageAggregation.md index 88dcdef9f..16a17c44c 100644 --- a/docs/reference/api/AggregationsAverageAggregation.md +++ b/docs/reference/api/AggregationsAverageAggregation.md @@ -1,4 +1,4 @@ -## Interface `AggregationsAverageAggregation` +# `AggregationsAverageAggregation` [interface-AggregationsAverageAggregation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsAverageBucketAggregation.md b/docs/reference/api/AggregationsAverageBucketAggregation.md index 1e71c2336..3264869d7 100644 --- a/docs/reference/api/AggregationsAverageBucketAggregation.md +++ b/docs/reference/api/AggregationsAverageBucketAggregation.md @@ -1,4 +1,4 @@ -## Interface `AggregationsAverageBucketAggregation` +# `AggregationsAverageBucketAggregation` [interface-AggregationsAverageBucketAggregation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsAvgAggregate.md b/docs/reference/api/AggregationsAvgAggregate.md index 42c3bc744..20f013681 100644 --- a/docs/reference/api/AggregationsAvgAggregate.md +++ b/docs/reference/api/AggregationsAvgAggregate.md @@ -1,4 +1,4 @@ -## Interface `AggregationsAvgAggregate` +# `AggregationsAvgAggregate` [interface-AggregationsAvgAggregate] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsBoxPlotAggregate.md b/docs/reference/api/AggregationsBoxPlotAggregate.md index f99b70f9f..07e6b9f99 100644 --- a/docs/reference/api/AggregationsBoxPlotAggregate.md +++ b/docs/reference/api/AggregationsBoxPlotAggregate.md @@ -1,4 +1,4 @@ -## Interface `AggregationsBoxPlotAggregate` +# `AggregationsBoxPlotAggregate` [interface-AggregationsBoxPlotAggregate] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsBoxplotAggregation.md b/docs/reference/api/AggregationsBoxplotAggregation.md index 3870d5b41..e59d1dd37 100644 --- a/docs/reference/api/AggregationsBoxplotAggregation.md +++ b/docs/reference/api/AggregationsBoxplotAggregation.md @@ -1,4 +1,4 @@ -## Interface `AggregationsBoxplotAggregation` +# `AggregationsBoxplotAggregation` [interface-AggregationsBoxplotAggregation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsBucketAggregationBase.md b/docs/reference/api/AggregationsBucketAggregationBase.md index 575601551..7d9cb9079 100644 --- a/docs/reference/api/AggregationsBucketAggregationBase.md +++ b/docs/reference/api/AggregationsBucketAggregationBase.md @@ -1,4 +1,4 @@ -## Interface `AggregationsBucketAggregationBase` +# `AggregationsBucketAggregationBase` [interface-AggregationsBucketAggregationBase] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsBucketCorrelationAggregation.md b/docs/reference/api/AggregationsBucketCorrelationAggregation.md index 233828aa8..f96dbef70 100644 --- a/docs/reference/api/AggregationsBucketCorrelationAggregation.md +++ b/docs/reference/api/AggregationsBucketCorrelationAggregation.md @@ -1,4 +1,4 @@ -## Interface `AggregationsBucketCorrelationAggregation` +# `AggregationsBucketCorrelationAggregation` [interface-AggregationsBucketCorrelationAggregation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsBucketCorrelationFunction.md b/docs/reference/api/AggregationsBucketCorrelationFunction.md index 210fe79bc..7edb2a0ec 100644 --- a/docs/reference/api/AggregationsBucketCorrelationFunction.md +++ b/docs/reference/api/AggregationsBucketCorrelationFunction.md @@ -1,4 +1,4 @@ -## Interface `AggregationsBucketCorrelationFunction` +# `AggregationsBucketCorrelationFunction` [interface-AggregationsBucketCorrelationFunction] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsBucketCorrelationFunctionCountCorrelation.md b/docs/reference/api/AggregationsBucketCorrelationFunctionCountCorrelation.md index e68e82e49..8bdbd5ef7 100644 --- a/docs/reference/api/AggregationsBucketCorrelationFunctionCountCorrelation.md +++ b/docs/reference/api/AggregationsBucketCorrelationFunctionCountCorrelation.md @@ -1,4 +1,4 @@ -## Interface `AggregationsBucketCorrelationFunctionCountCorrelation` +# `AggregationsBucketCorrelationFunctionCountCorrelation` [interface-AggregationsBucketCorrelationFunctionCountCorrelation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsBucketCorrelationFunctionCountCorrelationIndicator.md b/docs/reference/api/AggregationsBucketCorrelationFunctionCountCorrelationIndicator.md index 544e71411..b3beeeec8 100644 --- a/docs/reference/api/AggregationsBucketCorrelationFunctionCountCorrelationIndicator.md +++ b/docs/reference/api/AggregationsBucketCorrelationFunctionCountCorrelationIndicator.md @@ -1,4 +1,4 @@ -## Interface `AggregationsBucketCorrelationFunctionCountCorrelationIndicator` +# `AggregationsBucketCorrelationFunctionCountCorrelationIndicator` [interface-AggregationsBucketCorrelationFunctionCountCorrelationIndicator] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsBucketKsAggregation.md b/docs/reference/api/AggregationsBucketKsAggregation.md index fbf67d4fc..8e6aef1a4 100644 --- a/docs/reference/api/AggregationsBucketKsAggregation.md +++ b/docs/reference/api/AggregationsBucketKsAggregation.md @@ -1,4 +1,4 @@ -## Interface `AggregationsBucketKsAggregation` +# `AggregationsBucketKsAggregation` [interface-AggregationsBucketKsAggregation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsBucketMetricValueAggregate.md b/docs/reference/api/AggregationsBucketMetricValueAggregate.md index 07b2df370..b6ce0f9d6 100644 --- a/docs/reference/api/AggregationsBucketMetricValueAggregate.md +++ b/docs/reference/api/AggregationsBucketMetricValueAggregate.md @@ -1,4 +1,4 @@ -## Interface `AggregationsBucketMetricValueAggregate` +# `AggregationsBucketMetricValueAggregate` [interface-AggregationsBucketMetricValueAggregate] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsBucketPathAggregation.md b/docs/reference/api/AggregationsBucketPathAggregation.md index 341db9797..befef4a2c 100644 --- a/docs/reference/api/AggregationsBucketPathAggregation.md +++ b/docs/reference/api/AggregationsBucketPathAggregation.md @@ -1,4 +1,4 @@ -## Interface `AggregationsBucketPathAggregation` +# `AggregationsBucketPathAggregation` [interface-AggregationsBucketPathAggregation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsBucketScriptAggregation.md b/docs/reference/api/AggregationsBucketScriptAggregation.md index 22609f05b..1d0607b12 100644 --- a/docs/reference/api/AggregationsBucketScriptAggregation.md +++ b/docs/reference/api/AggregationsBucketScriptAggregation.md @@ -1,4 +1,4 @@ -## Interface `AggregationsBucketScriptAggregation` +# `AggregationsBucketScriptAggregation` [interface-AggregationsBucketScriptAggregation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsBucketSelectorAggregation.md b/docs/reference/api/AggregationsBucketSelectorAggregation.md index 0bc2d0ce3..c27dc88d9 100644 --- a/docs/reference/api/AggregationsBucketSelectorAggregation.md +++ b/docs/reference/api/AggregationsBucketSelectorAggregation.md @@ -1,4 +1,4 @@ -## Interface `AggregationsBucketSelectorAggregation` +# `AggregationsBucketSelectorAggregation` [interface-AggregationsBucketSelectorAggregation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsBucketSortAggregation.md b/docs/reference/api/AggregationsBucketSortAggregation.md index 01835e7c2..c7e28729e 100644 --- a/docs/reference/api/AggregationsBucketSortAggregation.md +++ b/docs/reference/api/AggregationsBucketSortAggregation.md @@ -1,4 +1,4 @@ -## Interface `AggregationsBucketSortAggregation` +# `AggregationsBucketSortAggregation` [interface-AggregationsBucketSortAggregation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsBuckets.md b/docs/reference/api/AggregationsBuckets.md index cee16d45a..af9685f05 100644 --- a/docs/reference/api/AggregationsBuckets.md +++ b/docs/reference/api/AggregationsBuckets.md @@ -1,4 +1,4 @@ -## `AggregationsBuckets` -::: +# `AggregationsBuckets` [alias-AggregationsBuckets] +```typescript type AggregationsBuckets = Record | TBucket[]; -::: +``` diff --git a/docs/reference/api/AggregationsBucketsPath.md b/docs/reference/api/AggregationsBucketsPath.md index 45002eea6..123c78a8a 100644 --- a/docs/reference/api/AggregationsBucketsPath.md +++ b/docs/reference/api/AggregationsBucketsPath.md @@ -1,4 +1,4 @@ -## `AggregationsBucketsPath` -::: +# `AggregationsBucketsPath` [alias-AggregationsBucketsPath] +```typescript type AggregationsBucketsPath = string | string[] | Record; -::: +``` diff --git a/docs/reference/api/AggregationsCalendarInterval.md b/docs/reference/api/AggregationsCalendarInterval.md index a6bb000d9..d2391b6c0 100644 --- a/docs/reference/api/AggregationsCalendarInterval.md +++ b/docs/reference/api/AggregationsCalendarInterval.md @@ -1,4 +1,4 @@ -## `AggregationsCalendarInterval` -::: +# `AggregationsCalendarInterval` [alias-AggregationsCalendarInterval] +```typescript type AggregationsCalendarInterval = 'second' | '1s' | 'minute' | '1m' | 'hour' | '1h' | 'day' | '1d' | 'week' | '1w' | 'month' | '1M' | 'quarter' | '1q' | 'year' | '1y'; -::: +``` diff --git a/docs/reference/api/AggregationsCardinalityAggregate.md b/docs/reference/api/AggregationsCardinalityAggregate.md index 17dda94fb..e7fc171d0 100644 --- a/docs/reference/api/AggregationsCardinalityAggregate.md +++ b/docs/reference/api/AggregationsCardinalityAggregate.md @@ -1,4 +1,4 @@ -## Interface `AggregationsCardinalityAggregate` +# `AggregationsCardinalityAggregate` [interface-AggregationsCardinalityAggregate] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsCardinalityAggregation.md b/docs/reference/api/AggregationsCardinalityAggregation.md index 134a2a8f4..ecd97147a 100644 --- a/docs/reference/api/AggregationsCardinalityAggregation.md +++ b/docs/reference/api/AggregationsCardinalityAggregation.md @@ -1,4 +1,4 @@ -## Interface `AggregationsCardinalityAggregation` +# `AggregationsCardinalityAggregation` [interface-AggregationsCardinalityAggregation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsCardinalityExecutionMode.md b/docs/reference/api/AggregationsCardinalityExecutionMode.md index ee27db9ed..3faeea6bc 100644 --- a/docs/reference/api/AggregationsCardinalityExecutionMode.md +++ b/docs/reference/api/AggregationsCardinalityExecutionMode.md @@ -1,4 +1,4 @@ -## `AggregationsCardinalityExecutionMode` -::: +# `AggregationsCardinalityExecutionMode` [alias-AggregationsCardinalityExecutionMode] +```typescript type AggregationsCardinalityExecutionMode = 'global_ordinals' | 'segment_ordinals' | 'direct' | 'save_memory_heuristic' | 'save_time_heuristic'; -::: +``` diff --git a/docs/reference/api/AggregationsCategorizeTextAggregation.md b/docs/reference/api/AggregationsCategorizeTextAggregation.md index 2570d4810..30f7a678e 100644 --- a/docs/reference/api/AggregationsCategorizeTextAggregation.md +++ b/docs/reference/api/AggregationsCategorizeTextAggregation.md @@ -1,4 +1,4 @@ -## Interface `AggregationsCategorizeTextAggregation` +# `AggregationsCategorizeTextAggregation` [interface-AggregationsCategorizeTextAggregation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsCategorizeTextAnalyzer.md b/docs/reference/api/AggregationsCategorizeTextAnalyzer.md index 4ef93a62b..94298dde2 100644 --- a/docs/reference/api/AggregationsCategorizeTextAnalyzer.md +++ b/docs/reference/api/AggregationsCategorizeTextAnalyzer.md @@ -1,4 +1,4 @@ -## `AggregationsCategorizeTextAnalyzer` -::: +# `AggregationsCategorizeTextAnalyzer` [alias-AggregationsCategorizeTextAnalyzer] +```typescript type AggregationsCategorizeTextAnalyzer = string | [AggregationsCustomCategorizeTextAnalyzer](./AggregationsCustomCategorizeTextAnalyzer.md); -::: +``` diff --git a/docs/reference/api/AggregationsChiSquareHeuristic.md b/docs/reference/api/AggregationsChiSquareHeuristic.md index f56f13ffa..817414881 100644 --- a/docs/reference/api/AggregationsChiSquareHeuristic.md +++ b/docs/reference/api/AggregationsChiSquareHeuristic.md @@ -1,4 +1,4 @@ -## Interface `AggregationsChiSquareHeuristic` +# `AggregationsChiSquareHeuristic` [interface-AggregationsChiSquareHeuristic] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsChildrenAggregate.md b/docs/reference/api/AggregationsChildrenAggregate.md index 54e902007..6a6b5c9d2 100644 --- a/docs/reference/api/AggregationsChildrenAggregate.md +++ b/docs/reference/api/AggregationsChildrenAggregate.md @@ -1,4 +1,4 @@ -## `AggregationsChildrenAggregate` -::: +# `AggregationsChildrenAggregate` [alias-AggregationsChildrenAggregate] +```typescript type AggregationsChildrenAggregate = [AggregationsChildrenAggregateKeys](./AggregationsChildrenAggregateKeys.md) & { [property: string]: [AggregationsAggregate](./AggregationsAggregate.md) | [long](./long.md) | [Metadata](./Metadata.md);}; -::: +``` diff --git a/docs/reference/api/AggregationsChildrenAggregateKeys.md b/docs/reference/api/AggregationsChildrenAggregateKeys.md index fa5e026f3..4480b2652 100644 --- a/docs/reference/api/AggregationsChildrenAggregateKeys.md +++ b/docs/reference/api/AggregationsChildrenAggregateKeys.md @@ -1,4 +1,4 @@ -## Interface `AggregationsChildrenAggregateKeys` +# `AggregationsChildrenAggregateKeys` [interface-AggregationsChildrenAggregateKeys] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsChildrenAggregation.md b/docs/reference/api/AggregationsChildrenAggregation.md index cf359ff10..274ab2aa0 100644 --- a/docs/reference/api/AggregationsChildrenAggregation.md +++ b/docs/reference/api/AggregationsChildrenAggregation.md @@ -1,4 +1,4 @@ -## Interface `AggregationsChildrenAggregation` +# `AggregationsChildrenAggregation` [interface-AggregationsChildrenAggregation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsCompositeAggregate.md b/docs/reference/api/AggregationsCompositeAggregate.md index a811a9859..0bd55fe4b 100644 --- a/docs/reference/api/AggregationsCompositeAggregate.md +++ b/docs/reference/api/AggregationsCompositeAggregate.md @@ -1,4 +1,4 @@ -## Interface `AggregationsCompositeAggregate` +# `AggregationsCompositeAggregate` [interface-AggregationsCompositeAggregate] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsCompositeAggregateKey.md b/docs/reference/api/AggregationsCompositeAggregateKey.md index fbc739ec6..506cdd32f 100644 --- a/docs/reference/api/AggregationsCompositeAggregateKey.md +++ b/docs/reference/api/AggregationsCompositeAggregateKey.md @@ -1,4 +1,4 @@ -## `AggregationsCompositeAggregateKey` -::: +# `AggregationsCompositeAggregateKey` [alias-AggregationsCompositeAggregateKey] +```typescript type AggregationsCompositeAggregateKey = Record<[Field](./Field.md), [FieldValue](./FieldValue.md)>; -::: +``` diff --git a/docs/reference/api/AggregationsCompositeAggregation.md b/docs/reference/api/AggregationsCompositeAggregation.md index 74a70f6c0..eb7b118f2 100644 --- a/docs/reference/api/AggregationsCompositeAggregation.md +++ b/docs/reference/api/AggregationsCompositeAggregation.md @@ -1,4 +1,4 @@ -## Interface `AggregationsCompositeAggregation` +# `AggregationsCompositeAggregation` [interface-AggregationsCompositeAggregation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsCompositeAggregationBase.md b/docs/reference/api/AggregationsCompositeAggregationBase.md index 0335cf445..1c89c6468 100644 --- a/docs/reference/api/AggregationsCompositeAggregationBase.md +++ b/docs/reference/api/AggregationsCompositeAggregationBase.md @@ -1,4 +1,4 @@ -## Interface `AggregationsCompositeAggregationBase` +# `AggregationsCompositeAggregationBase` [interface-AggregationsCompositeAggregationBase] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsCompositeAggregationSource.md b/docs/reference/api/AggregationsCompositeAggregationSource.md index f40ca1e19..45009c26e 100644 --- a/docs/reference/api/AggregationsCompositeAggregationSource.md +++ b/docs/reference/api/AggregationsCompositeAggregationSource.md @@ -1,4 +1,4 @@ -## Interface `AggregationsCompositeAggregationSource` +# `AggregationsCompositeAggregationSource` [interface-AggregationsCompositeAggregationSource] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsCompositeBucket.md b/docs/reference/api/AggregationsCompositeBucket.md index 1f87da5dc..e313fdf2a 100644 --- a/docs/reference/api/AggregationsCompositeBucket.md +++ b/docs/reference/api/AggregationsCompositeBucket.md @@ -1,4 +1,4 @@ -## `AggregationsCompositeBucket` -::: +# `AggregationsCompositeBucket` [alias-AggregationsCompositeBucket] +```typescript type AggregationsCompositeBucket = [AggregationsCompositeBucketKeys](./AggregationsCompositeBucketKeys.md) & { [property: string]: [AggregationsAggregate](./AggregationsAggregate.md) | [AggregationsCompositeAggregateKey](./AggregationsCompositeAggregateKey.md) | [long](./long.md);}; -::: +``` diff --git a/docs/reference/api/AggregationsCompositeBucketKeys.md b/docs/reference/api/AggregationsCompositeBucketKeys.md index 1a537cc5f..e6de70f92 100644 --- a/docs/reference/api/AggregationsCompositeBucketKeys.md +++ b/docs/reference/api/AggregationsCompositeBucketKeys.md @@ -1,4 +1,4 @@ -## Interface `AggregationsCompositeBucketKeys` +# `AggregationsCompositeBucketKeys` [interface-AggregationsCompositeBucketKeys] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsCompositeDateHistogramAggregation.md b/docs/reference/api/AggregationsCompositeDateHistogramAggregation.md index 2e987455c..e602fae6b 100644 --- a/docs/reference/api/AggregationsCompositeDateHistogramAggregation.md +++ b/docs/reference/api/AggregationsCompositeDateHistogramAggregation.md @@ -1,4 +1,4 @@ -## Interface `AggregationsCompositeDateHistogramAggregation` +# `AggregationsCompositeDateHistogramAggregation` [interface-AggregationsCompositeDateHistogramAggregation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsCompositeGeoTileGridAggregation.md b/docs/reference/api/AggregationsCompositeGeoTileGridAggregation.md index db08c3a15..6057dca01 100644 --- a/docs/reference/api/AggregationsCompositeGeoTileGridAggregation.md +++ b/docs/reference/api/AggregationsCompositeGeoTileGridAggregation.md @@ -1,4 +1,4 @@ -## Interface `AggregationsCompositeGeoTileGridAggregation` +# `AggregationsCompositeGeoTileGridAggregation` [interface-AggregationsCompositeGeoTileGridAggregation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsCompositeHistogramAggregation.md b/docs/reference/api/AggregationsCompositeHistogramAggregation.md index 1633d1cf2..b288cd699 100644 --- a/docs/reference/api/AggregationsCompositeHistogramAggregation.md +++ b/docs/reference/api/AggregationsCompositeHistogramAggregation.md @@ -1,4 +1,4 @@ -## Interface `AggregationsCompositeHistogramAggregation` +# `AggregationsCompositeHistogramAggregation` [interface-AggregationsCompositeHistogramAggregation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsCompositeTermsAggregation.md b/docs/reference/api/AggregationsCompositeTermsAggregation.md index 55312c28f..e71956f68 100644 --- a/docs/reference/api/AggregationsCompositeTermsAggregation.md +++ b/docs/reference/api/AggregationsCompositeTermsAggregation.md @@ -1,4 +1,4 @@ -## Interface `AggregationsCompositeTermsAggregation` +# `AggregationsCompositeTermsAggregation` [interface-AggregationsCompositeTermsAggregation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsCumulativeCardinalityAggregate.md b/docs/reference/api/AggregationsCumulativeCardinalityAggregate.md index 3f9a86a48..67e1f5497 100644 --- a/docs/reference/api/AggregationsCumulativeCardinalityAggregate.md +++ b/docs/reference/api/AggregationsCumulativeCardinalityAggregate.md @@ -1,4 +1,4 @@ -## Interface `AggregationsCumulativeCardinalityAggregate` +# `AggregationsCumulativeCardinalityAggregate` [interface-AggregationsCumulativeCardinalityAggregate] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsCumulativeCardinalityAggregation.md b/docs/reference/api/AggregationsCumulativeCardinalityAggregation.md index 2aa8c29ff..a3afc8022 100644 --- a/docs/reference/api/AggregationsCumulativeCardinalityAggregation.md +++ b/docs/reference/api/AggregationsCumulativeCardinalityAggregation.md @@ -1,4 +1,4 @@ -## Interface `AggregationsCumulativeCardinalityAggregation` +# `AggregationsCumulativeCardinalityAggregation` [interface-AggregationsCumulativeCardinalityAggregation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsCumulativeSumAggregation.md b/docs/reference/api/AggregationsCumulativeSumAggregation.md index c70d6e6c7..e3c9b8353 100644 --- a/docs/reference/api/AggregationsCumulativeSumAggregation.md +++ b/docs/reference/api/AggregationsCumulativeSumAggregation.md @@ -1,4 +1,4 @@ -## Interface `AggregationsCumulativeSumAggregation` +# `AggregationsCumulativeSumAggregation` [interface-AggregationsCumulativeSumAggregation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsCustomCategorizeTextAnalyzer.md b/docs/reference/api/AggregationsCustomCategorizeTextAnalyzer.md index f47ba05af..252c69b28 100644 --- a/docs/reference/api/AggregationsCustomCategorizeTextAnalyzer.md +++ b/docs/reference/api/AggregationsCustomCategorizeTextAnalyzer.md @@ -1,4 +1,4 @@ -## Interface `AggregationsCustomCategorizeTextAnalyzer` +# `AggregationsCustomCategorizeTextAnalyzer` [interface-AggregationsCustomCategorizeTextAnalyzer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsDateHistogramAggregate.md b/docs/reference/api/AggregationsDateHistogramAggregate.md index b0e4d6cf7..cea669263 100644 --- a/docs/reference/api/AggregationsDateHistogramAggregate.md +++ b/docs/reference/api/AggregationsDateHistogramAggregate.md @@ -1,4 +1,4 @@ -## Interface `AggregationsDateHistogramAggregate` +# `AggregationsDateHistogramAggregate` [interface-AggregationsDateHistogramAggregate] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsDateHistogramAggregation.md b/docs/reference/api/AggregationsDateHistogramAggregation.md index f93942b43..b2739c50e 100644 --- a/docs/reference/api/AggregationsDateHistogramAggregation.md +++ b/docs/reference/api/AggregationsDateHistogramAggregation.md @@ -1,4 +1,4 @@ -## Interface `AggregationsDateHistogramAggregation` +# `AggregationsDateHistogramAggregation` [interface-AggregationsDateHistogramAggregation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsDateHistogramBucket.md b/docs/reference/api/AggregationsDateHistogramBucket.md index ed01d82a2..b7ba1f26a 100644 --- a/docs/reference/api/AggregationsDateHistogramBucket.md +++ b/docs/reference/api/AggregationsDateHistogramBucket.md @@ -1,4 +1,4 @@ -## `AggregationsDateHistogramBucket` -::: +# `AggregationsDateHistogramBucket` [alias-AggregationsDateHistogramBucket] +```typescript type AggregationsDateHistogramBucket = [AggregationsDateHistogramBucketKeys](./AggregationsDateHistogramBucketKeys.md) & { [property: string]: [AggregationsAggregate](./AggregationsAggregate.md) | string | [EpochTime](./EpochTime.md)<[UnitMillis](./UnitMillis.md)> | [long](./long.md);}; -::: +``` diff --git a/docs/reference/api/AggregationsDateHistogramBucketKeys.md b/docs/reference/api/AggregationsDateHistogramBucketKeys.md index 039fe506f..7436ac8a3 100644 --- a/docs/reference/api/AggregationsDateHistogramBucketKeys.md +++ b/docs/reference/api/AggregationsDateHistogramBucketKeys.md @@ -1,4 +1,4 @@ -## Interface `AggregationsDateHistogramBucketKeys` +# `AggregationsDateHistogramBucketKeys` [interface-AggregationsDateHistogramBucketKeys] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsDateRangeAggregate.md b/docs/reference/api/AggregationsDateRangeAggregate.md index b35f7041a..a948f6974 100644 --- a/docs/reference/api/AggregationsDateRangeAggregate.md +++ b/docs/reference/api/AggregationsDateRangeAggregate.md @@ -1,4 +1,4 @@ -## Interface `AggregationsDateRangeAggregate` +# `AggregationsDateRangeAggregate` [interface-AggregationsDateRangeAggregate] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsDateRangeAggregation.md b/docs/reference/api/AggregationsDateRangeAggregation.md index fde258317..6087a651e 100644 --- a/docs/reference/api/AggregationsDateRangeAggregation.md +++ b/docs/reference/api/AggregationsDateRangeAggregation.md @@ -1,4 +1,4 @@ -## Interface `AggregationsDateRangeAggregation` +# `AggregationsDateRangeAggregation` [interface-AggregationsDateRangeAggregation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsDateRangeExpression.md b/docs/reference/api/AggregationsDateRangeExpression.md index 2027da1bc..e916d5995 100644 --- a/docs/reference/api/AggregationsDateRangeExpression.md +++ b/docs/reference/api/AggregationsDateRangeExpression.md @@ -1,4 +1,4 @@ -## Interface `AggregationsDateRangeExpression` +# `AggregationsDateRangeExpression` [interface-AggregationsDateRangeExpression] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsDerivativeAggregate.md b/docs/reference/api/AggregationsDerivativeAggregate.md index d936c7c48..81bf6af89 100644 --- a/docs/reference/api/AggregationsDerivativeAggregate.md +++ b/docs/reference/api/AggregationsDerivativeAggregate.md @@ -1,4 +1,4 @@ -## Interface `AggregationsDerivativeAggregate` +# `AggregationsDerivativeAggregate` [interface-AggregationsDerivativeAggregate] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsDerivativeAggregation.md b/docs/reference/api/AggregationsDerivativeAggregation.md index 2a3c476cf..ab0fdfc28 100644 --- a/docs/reference/api/AggregationsDerivativeAggregation.md +++ b/docs/reference/api/AggregationsDerivativeAggregation.md @@ -1,4 +1,4 @@ -## Interface `AggregationsDerivativeAggregation` +# `AggregationsDerivativeAggregation` [interface-AggregationsDerivativeAggregation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsDiversifiedSamplerAggregation.md b/docs/reference/api/AggregationsDiversifiedSamplerAggregation.md index f8f53d58a..cb2c2f399 100644 --- a/docs/reference/api/AggregationsDiversifiedSamplerAggregation.md +++ b/docs/reference/api/AggregationsDiversifiedSamplerAggregation.md @@ -1,4 +1,4 @@ -## Interface `AggregationsDiversifiedSamplerAggregation` +# `AggregationsDiversifiedSamplerAggregation` [interface-AggregationsDiversifiedSamplerAggregation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsDoubleTermsAggregate.md b/docs/reference/api/AggregationsDoubleTermsAggregate.md index fc60b0297..b8fb9b188 100644 --- a/docs/reference/api/AggregationsDoubleTermsAggregate.md +++ b/docs/reference/api/AggregationsDoubleTermsAggregate.md @@ -1,4 +1,4 @@ -## Interface `AggregationsDoubleTermsAggregate` +# `AggregationsDoubleTermsAggregate` [interface-AggregationsDoubleTermsAggregate] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsDoubleTermsBucket.md b/docs/reference/api/AggregationsDoubleTermsBucket.md index 397dc3e04..350cd9fae 100644 --- a/docs/reference/api/AggregationsDoubleTermsBucket.md +++ b/docs/reference/api/AggregationsDoubleTermsBucket.md @@ -1,4 +1,4 @@ -## `AggregationsDoubleTermsBucket` -::: +# `AggregationsDoubleTermsBucket` [alias-AggregationsDoubleTermsBucket] +```typescript type AggregationsDoubleTermsBucket = [AggregationsDoubleTermsBucketKeys](./AggregationsDoubleTermsBucketKeys.md) & { [property: string]: [AggregationsAggregate](./AggregationsAggregate.md) | [double](./double.md) | string | [long](./long.md);}; -::: +``` diff --git a/docs/reference/api/AggregationsDoubleTermsBucketKeys.md b/docs/reference/api/AggregationsDoubleTermsBucketKeys.md index e3b3a25b1..c2bcf77d8 100644 --- a/docs/reference/api/AggregationsDoubleTermsBucketKeys.md +++ b/docs/reference/api/AggregationsDoubleTermsBucketKeys.md @@ -1,4 +1,4 @@ -## Interface `AggregationsDoubleTermsBucketKeys` +# `AggregationsDoubleTermsBucketKeys` [interface-AggregationsDoubleTermsBucketKeys] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsEwmaModelSettings.md b/docs/reference/api/AggregationsEwmaModelSettings.md index ead3e5d1f..c7e59c81e 100644 --- a/docs/reference/api/AggregationsEwmaModelSettings.md +++ b/docs/reference/api/AggregationsEwmaModelSettings.md @@ -1,4 +1,4 @@ -## Interface `AggregationsEwmaModelSettings` +# `AggregationsEwmaModelSettings` [interface-AggregationsEwmaModelSettings] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsEwmaMovingAverageAggregation.md b/docs/reference/api/AggregationsEwmaMovingAverageAggregation.md index 0a09d0259..b13866ee1 100644 --- a/docs/reference/api/AggregationsEwmaMovingAverageAggregation.md +++ b/docs/reference/api/AggregationsEwmaMovingAverageAggregation.md @@ -1,4 +1,4 @@ -## Interface `AggregationsEwmaMovingAverageAggregation` +# `AggregationsEwmaMovingAverageAggregation` [interface-AggregationsEwmaMovingAverageAggregation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsExtendedBounds.md b/docs/reference/api/AggregationsExtendedBounds.md index 821e1971b..fd8ae6f54 100644 --- a/docs/reference/api/AggregationsExtendedBounds.md +++ b/docs/reference/api/AggregationsExtendedBounds.md @@ -1,4 +1,4 @@ -## Interface `AggregationsExtendedBounds` +# `AggregationsExtendedBounds` [interface-AggregationsExtendedBounds] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsExtendedStatsAggregate.md b/docs/reference/api/AggregationsExtendedStatsAggregate.md index 306171a21..8e6755e1a 100644 --- a/docs/reference/api/AggregationsExtendedStatsAggregate.md +++ b/docs/reference/api/AggregationsExtendedStatsAggregate.md @@ -1,4 +1,4 @@ -## Interface `AggregationsExtendedStatsAggregate` +# `AggregationsExtendedStatsAggregate` [interface-AggregationsExtendedStatsAggregate] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsExtendedStatsAggregation.md b/docs/reference/api/AggregationsExtendedStatsAggregation.md index adac76dd8..f78bb80ee 100644 --- a/docs/reference/api/AggregationsExtendedStatsAggregation.md +++ b/docs/reference/api/AggregationsExtendedStatsAggregation.md @@ -1,4 +1,4 @@ -## Interface `AggregationsExtendedStatsAggregation` +# `AggregationsExtendedStatsAggregation` [interface-AggregationsExtendedStatsAggregation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsExtendedStatsBucketAggregate.md b/docs/reference/api/AggregationsExtendedStatsBucketAggregate.md index 2f843054c..46b632bd2 100644 --- a/docs/reference/api/AggregationsExtendedStatsBucketAggregate.md +++ b/docs/reference/api/AggregationsExtendedStatsBucketAggregate.md @@ -1,4 +1,4 @@ -## Interface `AggregationsExtendedStatsBucketAggregate` +# `AggregationsExtendedStatsBucketAggregate` [interface-AggregationsExtendedStatsBucketAggregate] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsExtendedStatsBucketAggregation.md b/docs/reference/api/AggregationsExtendedStatsBucketAggregation.md index 5aa6433f7..4e66f6b52 100644 --- a/docs/reference/api/AggregationsExtendedStatsBucketAggregation.md +++ b/docs/reference/api/AggregationsExtendedStatsBucketAggregation.md @@ -1,4 +1,4 @@ -## Interface `AggregationsExtendedStatsBucketAggregation` +# `AggregationsExtendedStatsBucketAggregation` [interface-AggregationsExtendedStatsBucketAggregation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsFieldDateMath.md b/docs/reference/api/AggregationsFieldDateMath.md index 75f846145..692386976 100644 --- a/docs/reference/api/AggregationsFieldDateMath.md +++ b/docs/reference/api/AggregationsFieldDateMath.md @@ -1,4 +1,4 @@ -## `AggregationsFieldDateMath` -::: +# `AggregationsFieldDateMath` [alias-AggregationsFieldDateMath] +```typescript type AggregationsFieldDateMath = [DateMath](./DateMath.md) | [double](./double.md); -::: +``` diff --git a/docs/reference/api/AggregationsFilterAggregate.md b/docs/reference/api/AggregationsFilterAggregate.md index ba02beab1..d680893e5 100644 --- a/docs/reference/api/AggregationsFilterAggregate.md +++ b/docs/reference/api/AggregationsFilterAggregate.md @@ -1,4 +1,4 @@ -## `AggregationsFilterAggregate` -::: +# `AggregationsFilterAggregate` [alias-AggregationsFilterAggregate] +```typescript type AggregationsFilterAggregate = [AggregationsFilterAggregateKeys](./AggregationsFilterAggregateKeys.md) & { [property: string]: [AggregationsAggregate](./AggregationsAggregate.md) | [long](./long.md) | [Metadata](./Metadata.md);}; -::: +``` diff --git a/docs/reference/api/AggregationsFilterAggregateKeys.md b/docs/reference/api/AggregationsFilterAggregateKeys.md index 0e8d70458..f57797e3b 100644 --- a/docs/reference/api/AggregationsFilterAggregateKeys.md +++ b/docs/reference/api/AggregationsFilterAggregateKeys.md @@ -1,4 +1,4 @@ -## Interface `AggregationsFilterAggregateKeys` +# `AggregationsFilterAggregateKeys` [interface-AggregationsFilterAggregateKeys] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsFiltersAggregate.md b/docs/reference/api/AggregationsFiltersAggregate.md index e7865967b..2cf97841c 100644 --- a/docs/reference/api/AggregationsFiltersAggregate.md +++ b/docs/reference/api/AggregationsFiltersAggregate.md @@ -1,4 +1,4 @@ -## Interface `AggregationsFiltersAggregate` +# `AggregationsFiltersAggregate` [interface-AggregationsFiltersAggregate] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsFiltersAggregation.md b/docs/reference/api/AggregationsFiltersAggregation.md index bc9d33db5..78e1a8382 100644 --- a/docs/reference/api/AggregationsFiltersAggregation.md +++ b/docs/reference/api/AggregationsFiltersAggregation.md @@ -1,4 +1,4 @@ -## Interface `AggregationsFiltersAggregation` +# `AggregationsFiltersAggregation` [interface-AggregationsFiltersAggregation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsFiltersBucket.md b/docs/reference/api/AggregationsFiltersBucket.md index 293a28755..3434ba14b 100644 --- a/docs/reference/api/AggregationsFiltersBucket.md +++ b/docs/reference/api/AggregationsFiltersBucket.md @@ -1,4 +1,4 @@ -## `AggregationsFiltersBucket` -::: +# `AggregationsFiltersBucket` [alias-AggregationsFiltersBucket] +```typescript type AggregationsFiltersBucket = [AggregationsFiltersBucketKeys](./AggregationsFiltersBucketKeys.md) & { [property: string]: [AggregationsAggregate](./AggregationsAggregate.md) | [long](./long.md);}; -::: +``` diff --git a/docs/reference/api/AggregationsFiltersBucketKeys.md b/docs/reference/api/AggregationsFiltersBucketKeys.md index 29dcf558a..115c2de86 100644 --- a/docs/reference/api/AggregationsFiltersBucketKeys.md +++ b/docs/reference/api/AggregationsFiltersBucketKeys.md @@ -1,4 +1,4 @@ -## Interface `AggregationsFiltersBucketKeys` +# `AggregationsFiltersBucketKeys` [interface-AggregationsFiltersBucketKeys] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsFormatMetricAggregationBase.md b/docs/reference/api/AggregationsFormatMetricAggregationBase.md index a8f6ad71b..3315feb4f 100644 --- a/docs/reference/api/AggregationsFormatMetricAggregationBase.md +++ b/docs/reference/api/AggregationsFormatMetricAggregationBase.md @@ -1,4 +1,4 @@ -## Interface `AggregationsFormatMetricAggregationBase` +# `AggregationsFormatMetricAggregationBase` [interface-AggregationsFormatMetricAggregationBase] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsFormattableMetricAggregation.md b/docs/reference/api/AggregationsFormattableMetricAggregation.md index d59f5133f..574344109 100644 --- a/docs/reference/api/AggregationsFormattableMetricAggregation.md +++ b/docs/reference/api/AggregationsFormattableMetricAggregation.md @@ -1,4 +1,4 @@ -## Interface `AggregationsFormattableMetricAggregation` +# `AggregationsFormattableMetricAggregation` [interface-AggregationsFormattableMetricAggregation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsFrequentItemSetsAggregate.md b/docs/reference/api/AggregationsFrequentItemSetsAggregate.md index a9ba62c0c..7803ba3ca 100644 --- a/docs/reference/api/AggregationsFrequentItemSetsAggregate.md +++ b/docs/reference/api/AggregationsFrequentItemSetsAggregate.md @@ -1,4 +1,4 @@ -## Interface `AggregationsFrequentItemSetsAggregate` +# `AggregationsFrequentItemSetsAggregate` [interface-AggregationsFrequentItemSetsAggregate] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsFrequentItemSetsAggregation.md b/docs/reference/api/AggregationsFrequentItemSetsAggregation.md index 3d93719ca..10b929442 100644 --- a/docs/reference/api/AggregationsFrequentItemSetsAggregation.md +++ b/docs/reference/api/AggregationsFrequentItemSetsAggregation.md @@ -1,4 +1,4 @@ -## Interface `AggregationsFrequentItemSetsAggregation` +# `AggregationsFrequentItemSetsAggregation` [interface-AggregationsFrequentItemSetsAggregation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsFrequentItemSetsBucket.md b/docs/reference/api/AggregationsFrequentItemSetsBucket.md index 479dc1060..82b110507 100644 --- a/docs/reference/api/AggregationsFrequentItemSetsBucket.md +++ b/docs/reference/api/AggregationsFrequentItemSetsBucket.md @@ -1,4 +1,4 @@ -## `AggregationsFrequentItemSetsBucket` -::: +# `AggregationsFrequentItemSetsBucket` [alias-AggregationsFrequentItemSetsBucket] +```typescript type AggregationsFrequentItemSetsBucket = [AggregationsFrequentItemSetsBucketKeys](./AggregationsFrequentItemSetsBucketKeys.md) & { [property: string]: [AggregationsAggregate](./AggregationsAggregate.md) | Record<[Field](./Field.md), string[]> | [double](./double.md) | [long](./long.md);}; -::: +``` diff --git a/docs/reference/api/AggregationsFrequentItemSetsBucketKeys.md b/docs/reference/api/AggregationsFrequentItemSetsBucketKeys.md index 5570a746a..5acc0feac 100644 --- a/docs/reference/api/AggregationsFrequentItemSetsBucketKeys.md +++ b/docs/reference/api/AggregationsFrequentItemSetsBucketKeys.md @@ -1,4 +1,4 @@ -## Interface `AggregationsFrequentItemSetsBucketKeys` +# `AggregationsFrequentItemSetsBucketKeys` [interface-AggregationsFrequentItemSetsBucketKeys] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsFrequentItemSetsField.md b/docs/reference/api/AggregationsFrequentItemSetsField.md index 552def2c8..00a8baa8e 100644 --- a/docs/reference/api/AggregationsFrequentItemSetsField.md +++ b/docs/reference/api/AggregationsFrequentItemSetsField.md @@ -1,4 +1,4 @@ -## Interface `AggregationsFrequentItemSetsField` +# `AggregationsFrequentItemSetsField` [interface-AggregationsFrequentItemSetsField] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsGapPolicy.md b/docs/reference/api/AggregationsGapPolicy.md index 9ab01d9e5..fffa185ae 100644 --- a/docs/reference/api/AggregationsGapPolicy.md +++ b/docs/reference/api/AggregationsGapPolicy.md @@ -1,4 +1,4 @@ -## `AggregationsGapPolicy` -::: +# `AggregationsGapPolicy` [alias-AggregationsGapPolicy] +```typescript type AggregationsGapPolicy = 'skip' | 'insert_zeros' | 'keep_values'; -::: +``` diff --git a/docs/reference/api/AggregationsGeoBoundsAggregate.md b/docs/reference/api/AggregationsGeoBoundsAggregate.md index f4df56fd1..b31071f34 100644 --- a/docs/reference/api/AggregationsGeoBoundsAggregate.md +++ b/docs/reference/api/AggregationsGeoBoundsAggregate.md @@ -1,4 +1,4 @@ -## Interface `AggregationsGeoBoundsAggregate` +# `AggregationsGeoBoundsAggregate` [interface-AggregationsGeoBoundsAggregate] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsGeoBoundsAggregation.md b/docs/reference/api/AggregationsGeoBoundsAggregation.md index e94f11697..230aafd3e 100644 --- a/docs/reference/api/AggregationsGeoBoundsAggregation.md +++ b/docs/reference/api/AggregationsGeoBoundsAggregation.md @@ -1,4 +1,4 @@ -## Interface `AggregationsGeoBoundsAggregation` +# `AggregationsGeoBoundsAggregation` [interface-AggregationsGeoBoundsAggregation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsGeoCentroidAggregate.md b/docs/reference/api/AggregationsGeoCentroidAggregate.md index 38f031bd6..f6d8aff09 100644 --- a/docs/reference/api/AggregationsGeoCentroidAggregate.md +++ b/docs/reference/api/AggregationsGeoCentroidAggregate.md @@ -1,4 +1,4 @@ -## Interface `AggregationsGeoCentroidAggregate` +# `AggregationsGeoCentroidAggregate` [interface-AggregationsGeoCentroidAggregate] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsGeoCentroidAggregation.md b/docs/reference/api/AggregationsGeoCentroidAggregation.md index bfb1069f3..57dc93458 100644 --- a/docs/reference/api/AggregationsGeoCentroidAggregation.md +++ b/docs/reference/api/AggregationsGeoCentroidAggregation.md @@ -1,4 +1,4 @@ -## Interface `AggregationsGeoCentroidAggregation` +# `AggregationsGeoCentroidAggregation` [interface-AggregationsGeoCentroidAggregation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsGeoDistanceAggregate.md b/docs/reference/api/AggregationsGeoDistanceAggregate.md index e44872c76..32eaec9bb 100644 --- a/docs/reference/api/AggregationsGeoDistanceAggregate.md +++ b/docs/reference/api/AggregationsGeoDistanceAggregate.md @@ -1,4 +1,4 @@ -## Interface `AggregationsGeoDistanceAggregate` +# `AggregationsGeoDistanceAggregate` [interface-AggregationsGeoDistanceAggregate] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsGeoDistanceAggregation.md b/docs/reference/api/AggregationsGeoDistanceAggregation.md index 225174fe2..f7c11a378 100644 --- a/docs/reference/api/AggregationsGeoDistanceAggregation.md +++ b/docs/reference/api/AggregationsGeoDistanceAggregation.md @@ -1,4 +1,4 @@ -## Interface `AggregationsGeoDistanceAggregation` +# `AggregationsGeoDistanceAggregation` [interface-AggregationsGeoDistanceAggregation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsGeoHashGridAggregate.md b/docs/reference/api/AggregationsGeoHashGridAggregate.md index b88d95f13..e5fef6047 100644 --- a/docs/reference/api/AggregationsGeoHashGridAggregate.md +++ b/docs/reference/api/AggregationsGeoHashGridAggregate.md @@ -1,4 +1,4 @@ -## Interface `AggregationsGeoHashGridAggregate` +# `AggregationsGeoHashGridAggregate` [interface-AggregationsGeoHashGridAggregate] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsGeoHashGridAggregation.md b/docs/reference/api/AggregationsGeoHashGridAggregation.md index 514645594..1af4cf92c 100644 --- a/docs/reference/api/AggregationsGeoHashGridAggregation.md +++ b/docs/reference/api/AggregationsGeoHashGridAggregation.md @@ -1,4 +1,4 @@ -## Interface `AggregationsGeoHashGridAggregation` +# `AggregationsGeoHashGridAggregation` [interface-AggregationsGeoHashGridAggregation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsGeoHashGridBucket.md b/docs/reference/api/AggregationsGeoHashGridBucket.md index ab489c24c..3d9ef380b 100644 --- a/docs/reference/api/AggregationsGeoHashGridBucket.md +++ b/docs/reference/api/AggregationsGeoHashGridBucket.md @@ -1,4 +1,4 @@ -## `AggregationsGeoHashGridBucket` -::: +# `AggregationsGeoHashGridBucket` [alias-AggregationsGeoHashGridBucket] +```typescript type AggregationsGeoHashGridBucket = [AggregationsGeoHashGridBucketKeys](./AggregationsGeoHashGridBucketKeys.md) & { [property: string]: [AggregationsAggregate](./AggregationsAggregate.md) | [GeoHash](./GeoHash.md) | [long](./long.md);}; -::: +``` diff --git a/docs/reference/api/AggregationsGeoHashGridBucketKeys.md b/docs/reference/api/AggregationsGeoHashGridBucketKeys.md index 86e2b60cb..98d1bc4b4 100644 --- a/docs/reference/api/AggregationsGeoHashGridBucketKeys.md +++ b/docs/reference/api/AggregationsGeoHashGridBucketKeys.md @@ -1,4 +1,4 @@ -## Interface `AggregationsGeoHashGridBucketKeys` +# `AggregationsGeoHashGridBucketKeys` [interface-AggregationsGeoHashGridBucketKeys] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsGeoHexGridAggregate.md b/docs/reference/api/AggregationsGeoHexGridAggregate.md index 29e63e360..03238e3d1 100644 --- a/docs/reference/api/AggregationsGeoHexGridAggregate.md +++ b/docs/reference/api/AggregationsGeoHexGridAggregate.md @@ -1,4 +1,4 @@ -## Interface `AggregationsGeoHexGridAggregate` +# `AggregationsGeoHexGridAggregate` [interface-AggregationsGeoHexGridAggregate] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsGeoHexGridBucket.md b/docs/reference/api/AggregationsGeoHexGridBucket.md index 6b36e88c8..52532601a 100644 --- a/docs/reference/api/AggregationsGeoHexGridBucket.md +++ b/docs/reference/api/AggregationsGeoHexGridBucket.md @@ -1,4 +1,4 @@ -## `AggregationsGeoHexGridBucket` -::: +# `AggregationsGeoHexGridBucket` [alias-AggregationsGeoHexGridBucket] +```typescript type AggregationsGeoHexGridBucket = [AggregationsGeoHexGridBucketKeys](./AggregationsGeoHexGridBucketKeys.md) & { [property: string]: [AggregationsAggregate](./AggregationsAggregate.md) | [GeoHexCell](./GeoHexCell.md) | [long](./long.md);}; -::: +``` diff --git a/docs/reference/api/AggregationsGeoHexGridBucketKeys.md b/docs/reference/api/AggregationsGeoHexGridBucketKeys.md index 0ec2bf8f5..d0fb7ee87 100644 --- a/docs/reference/api/AggregationsGeoHexGridBucketKeys.md +++ b/docs/reference/api/AggregationsGeoHexGridBucketKeys.md @@ -1,4 +1,4 @@ -## Interface `AggregationsGeoHexGridBucketKeys` +# `AggregationsGeoHexGridBucketKeys` [interface-AggregationsGeoHexGridBucketKeys] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsGeoLineAggregate.md b/docs/reference/api/AggregationsGeoLineAggregate.md index 3c477fdb9..c1ad9bc4f 100644 --- a/docs/reference/api/AggregationsGeoLineAggregate.md +++ b/docs/reference/api/AggregationsGeoLineAggregate.md @@ -1,4 +1,4 @@ -## Interface `AggregationsGeoLineAggregate` +# `AggregationsGeoLineAggregate` [interface-AggregationsGeoLineAggregate] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsGeoLineAggregation.md b/docs/reference/api/AggregationsGeoLineAggregation.md index 3f3da7ace..144b2ebde 100644 --- a/docs/reference/api/AggregationsGeoLineAggregation.md +++ b/docs/reference/api/AggregationsGeoLineAggregation.md @@ -1,4 +1,4 @@ -## Interface `AggregationsGeoLineAggregation` +# `AggregationsGeoLineAggregation` [interface-AggregationsGeoLineAggregation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsGeoLinePoint.md b/docs/reference/api/AggregationsGeoLinePoint.md index d0b2c73c9..9ff49f737 100644 --- a/docs/reference/api/AggregationsGeoLinePoint.md +++ b/docs/reference/api/AggregationsGeoLinePoint.md @@ -1,4 +1,4 @@ -## Interface `AggregationsGeoLinePoint` +# `AggregationsGeoLinePoint` [interface-AggregationsGeoLinePoint] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsGeoLineSort.md b/docs/reference/api/AggregationsGeoLineSort.md index cf71d8c83..17603205c 100644 --- a/docs/reference/api/AggregationsGeoLineSort.md +++ b/docs/reference/api/AggregationsGeoLineSort.md @@ -1,4 +1,4 @@ -## Interface `AggregationsGeoLineSort` +# `AggregationsGeoLineSort` [interface-AggregationsGeoLineSort] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsGeoTileGridAggregate.md b/docs/reference/api/AggregationsGeoTileGridAggregate.md index c73897e73..f70ea5387 100644 --- a/docs/reference/api/AggregationsGeoTileGridAggregate.md +++ b/docs/reference/api/AggregationsGeoTileGridAggregate.md @@ -1,4 +1,4 @@ -## Interface `AggregationsGeoTileGridAggregate` +# `AggregationsGeoTileGridAggregate` [interface-AggregationsGeoTileGridAggregate] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsGeoTileGridAggregation.md b/docs/reference/api/AggregationsGeoTileGridAggregation.md index b184e6243..1c3b51692 100644 --- a/docs/reference/api/AggregationsGeoTileGridAggregation.md +++ b/docs/reference/api/AggregationsGeoTileGridAggregation.md @@ -1,4 +1,4 @@ -## Interface `AggregationsGeoTileGridAggregation` +# `AggregationsGeoTileGridAggregation` [interface-AggregationsGeoTileGridAggregation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsGeoTileGridBucket.md b/docs/reference/api/AggregationsGeoTileGridBucket.md index 5af797251..9ae90f07c 100644 --- a/docs/reference/api/AggregationsGeoTileGridBucket.md +++ b/docs/reference/api/AggregationsGeoTileGridBucket.md @@ -1,4 +1,4 @@ -## `AggregationsGeoTileGridBucket` -::: +# `AggregationsGeoTileGridBucket` [alias-AggregationsGeoTileGridBucket] +```typescript type AggregationsGeoTileGridBucket = [AggregationsGeoTileGridBucketKeys](./AggregationsGeoTileGridBucketKeys.md) & { [property: string]: [AggregationsAggregate](./AggregationsAggregate.md) | [GeoTile](./GeoTile.md) | [long](./long.md);}; -::: +``` diff --git a/docs/reference/api/AggregationsGeoTileGridBucketKeys.md b/docs/reference/api/AggregationsGeoTileGridBucketKeys.md index 4fb14c5d6..7145acba3 100644 --- a/docs/reference/api/AggregationsGeoTileGridBucketKeys.md +++ b/docs/reference/api/AggregationsGeoTileGridBucketKeys.md @@ -1,4 +1,4 @@ -## Interface `AggregationsGeoTileGridBucketKeys` +# `AggregationsGeoTileGridBucketKeys` [interface-AggregationsGeoTileGridBucketKeys] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsGeohexGridAggregation.md b/docs/reference/api/AggregationsGeohexGridAggregation.md index 9ce91a69e..65e31ccfd 100644 --- a/docs/reference/api/AggregationsGeohexGridAggregation.md +++ b/docs/reference/api/AggregationsGeohexGridAggregation.md @@ -1,4 +1,4 @@ -## Interface `AggregationsGeohexGridAggregation` +# `AggregationsGeohexGridAggregation` [interface-AggregationsGeohexGridAggregation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsGlobalAggregate.md b/docs/reference/api/AggregationsGlobalAggregate.md index a54062ca1..430d70d03 100644 --- a/docs/reference/api/AggregationsGlobalAggregate.md +++ b/docs/reference/api/AggregationsGlobalAggregate.md @@ -1,4 +1,4 @@ -## `AggregationsGlobalAggregate` -::: +# `AggregationsGlobalAggregate` [alias-AggregationsGlobalAggregate] +```typescript type AggregationsGlobalAggregate = [AggregationsGlobalAggregateKeys](./AggregationsGlobalAggregateKeys.md) & { [property: string]: [AggregationsAggregate](./AggregationsAggregate.md) | [long](./long.md) | [Metadata](./Metadata.md);}; -::: +``` diff --git a/docs/reference/api/AggregationsGlobalAggregateKeys.md b/docs/reference/api/AggregationsGlobalAggregateKeys.md index 6cd872f5d..5e58909c7 100644 --- a/docs/reference/api/AggregationsGlobalAggregateKeys.md +++ b/docs/reference/api/AggregationsGlobalAggregateKeys.md @@ -1,4 +1,4 @@ -## Interface `AggregationsGlobalAggregateKeys` +# `AggregationsGlobalAggregateKeys` [interface-AggregationsGlobalAggregateKeys] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsGlobalAggregation.md b/docs/reference/api/AggregationsGlobalAggregation.md index 0509574f8..4521c5e90 100644 --- a/docs/reference/api/AggregationsGlobalAggregation.md +++ b/docs/reference/api/AggregationsGlobalAggregation.md @@ -1,4 +1,4 @@ -## Interface `AggregationsGlobalAggregation` +# `AggregationsGlobalAggregation` [interface-AggregationsGlobalAggregation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsGoogleNormalizedDistanceHeuristic.md b/docs/reference/api/AggregationsGoogleNormalizedDistanceHeuristic.md index 651b54381..e4422a185 100644 --- a/docs/reference/api/AggregationsGoogleNormalizedDistanceHeuristic.md +++ b/docs/reference/api/AggregationsGoogleNormalizedDistanceHeuristic.md @@ -1,4 +1,4 @@ -## Interface `AggregationsGoogleNormalizedDistanceHeuristic` +# `AggregationsGoogleNormalizedDistanceHeuristic` [interface-AggregationsGoogleNormalizedDistanceHeuristic] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsHdrMethod.md b/docs/reference/api/AggregationsHdrMethod.md index c13332207..6263b63ab 100644 --- a/docs/reference/api/AggregationsHdrMethod.md +++ b/docs/reference/api/AggregationsHdrMethod.md @@ -1,4 +1,4 @@ -## Interface `AggregationsHdrMethod` +# `AggregationsHdrMethod` [interface-AggregationsHdrMethod] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsHdrPercentileRanksAggregate.md b/docs/reference/api/AggregationsHdrPercentileRanksAggregate.md index 98095cbb5..b74d15b29 100644 --- a/docs/reference/api/AggregationsHdrPercentileRanksAggregate.md +++ b/docs/reference/api/AggregationsHdrPercentileRanksAggregate.md @@ -1,4 +1,4 @@ -## Interface `AggregationsHdrPercentileRanksAggregate` +# `AggregationsHdrPercentileRanksAggregate` [interface-AggregationsHdrPercentileRanksAggregate] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsHdrPercentilesAggregate.md b/docs/reference/api/AggregationsHdrPercentilesAggregate.md index 74759823e..2e5ccb041 100644 --- a/docs/reference/api/AggregationsHdrPercentilesAggregate.md +++ b/docs/reference/api/AggregationsHdrPercentilesAggregate.md @@ -1,4 +1,4 @@ -## Interface `AggregationsHdrPercentilesAggregate` +# `AggregationsHdrPercentilesAggregate` [interface-AggregationsHdrPercentilesAggregate] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsHistogramAggregate.md b/docs/reference/api/AggregationsHistogramAggregate.md index 1d3d6fa97..26d8d8a09 100644 --- a/docs/reference/api/AggregationsHistogramAggregate.md +++ b/docs/reference/api/AggregationsHistogramAggregate.md @@ -1,4 +1,4 @@ -## Interface `AggregationsHistogramAggregate` +# `AggregationsHistogramAggregate` [interface-AggregationsHistogramAggregate] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsHistogramAggregation.md b/docs/reference/api/AggregationsHistogramAggregation.md index af4570bb1..397bca470 100644 --- a/docs/reference/api/AggregationsHistogramAggregation.md +++ b/docs/reference/api/AggregationsHistogramAggregation.md @@ -1,4 +1,4 @@ -## Interface `AggregationsHistogramAggregation` +# `AggregationsHistogramAggregation` [interface-AggregationsHistogramAggregation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsHistogramBucket.md b/docs/reference/api/AggregationsHistogramBucket.md index b019ff8ae..ddec735c9 100644 --- a/docs/reference/api/AggregationsHistogramBucket.md +++ b/docs/reference/api/AggregationsHistogramBucket.md @@ -1,4 +1,4 @@ -## `AggregationsHistogramBucket` -::: +# `AggregationsHistogramBucket` [alias-AggregationsHistogramBucket] +```typescript type AggregationsHistogramBucket = [AggregationsHistogramBucketKeys](./AggregationsHistogramBucketKeys.md) & { [property: string]: [AggregationsAggregate](./AggregationsAggregate.md) | string | [double](./double.md) | [long](./long.md);}; -::: +``` diff --git a/docs/reference/api/AggregationsHistogramBucketKeys.md b/docs/reference/api/AggregationsHistogramBucketKeys.md index 4fecc2e8a..9c695a5e0 100644 --- a/docs/reference/api/AggregationsHistogramBucketKeys.md +++ b/docs/reference/api/AggregationsHistogramBucketKeys.md @@ -1,4 +1,4 @@ -## Interface `AggregationsHistogramBucketKeys` +# `AggregationsHistogramBucketKeys` [interface-AggregationsHistogramBucketKeys] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsHoltLinearModelSettings.md b/docs/reference/api/AggregationsHoltLinearModelSettings.md index 60926ef4f..3f1dc8792 100644 --- a/docs/reference/api/AggregationsHoltLinearModelSettings.md +++ b/docs/reference/api/AggregationsHoltLinearModelSettings.md @@ -1,4 +1,4 @@ -## Interface `AggregationsHoltLinearModelSettings` +# `AggregationsHoltLinearModelSettings` [interface-AggregationsHoltLinearModelSettings] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsHoltMovingAverageAggregation.md b/docs/reference/api/AggregationsHoltMovingAverageAggregation.md index 8c56867a7..39c74ee18 100644 --- a/docs/reference/api/AggregationsHoltMovingAverageAggregation.md +++ b/docs/reference/api/AggregationsHoltMovingAverageAggregation.md @@ -1,4 +1,4 @@ -## Interface `AggregationsHoltMovingAverageAggregation` +# `AggregationsHoltMovingAverageAggregation` [interface-AggregationsHoltMovingAverageAggregation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsHoltWintersModelSettings.md b/docs/reference/api/AggregationsHoltWintersModelSettings.md index 5a04168e2..45674ff43 100644 --- a/docs/reference/api/AggregationsHoltWintersModelSettings.md +++ b/docs/reference/api/AggregationsHoltWintersModelSettings.md @@ -1,4 +1,4 @@ -## Interface `AggregationsHoltWintersModelSettings` +# `AggregationsHoltWintersModelSettings` [interface-AggregationsHoltWintersModelSettings] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsHoltWintersMovingAverageAggregation.md b/docs/reference/api/AggregationsHoltWintersMovingAverageAggregation.md index 3b6a1f88a..52f4b2222 100644 --- a/docs/reference/api/AggregationsHoltWintersMovingAverageAggregation.md +++ b/docs/reference/api/AggregationsHoltWintersMovingAverageAggregation.md @@ -1,4 +1,4 @@ -## Interface `AggregationsHoltWintersMovingAverageAggregation` +# `AggregationsHoltWintersMovingAverageAggregation` [interface-AggregationsHoltWintersMovingAverageAggregation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsHoltWintersType.md b/docs/reference/api/AggregationsHoltWintersType.md index c207f6e9d..9788fa14b 100644 --- a/docs/reference/api/AggregationsHoltWintersType.md +++ b/docs/reference/api/AggregationsHoltWintersType.md @@ -1,4 +1,4 @@ -## `AggregationsHoltWintersType` -::: +# `AggregationsHoltWintersType` [alias-AggregationsHoltWintersType] +```typescript type AggregationsHoltWintersType = 'add' | 'mult'; -::: +``` diff --git a/docs/reference/api/AggregationsInferenceAggregate.md b/docs/reference/api/AggregationsInferenceAggregate.md index 6b202be4f..ade62b0f3 100644 --- a/docs/reference/api/AggregationsInferenceAggregate.md +++ b/docs/reference/api/AggregationsInferenceAggregate.md @@ -1,4 +1,4 @@ -## `AggregationsInferenceAggregate` -::: +# `AggregationsInferenceAggregate` [alias-AggregationsInferenceAggregate] +```typescript type AggregationsInferenceAggregate = [AggregationsInferenceAggregateKeys](./AggregationsInferenceAggregateKeys.md) & { [property: string]: any;}; -::: +``` diff --git a/docs/reference/api/AggregationsInferenceAggregateKeys.md b/docs/reference/api/AggregationsInferenceAggregateKeys.md index 5d2b6baa2..1abdd6ba3 100644 --- a/docs/reference/api/AggregationsInferenceAggregateKeys.md +++ b/docs/reference/api/AggregationsInferenceAggregateKeys.md @@ -1,4 +1,4 @@ -## Interface `AggregationsInferenceAggregateKeys` +# `AggregationsInferenceAggregateKeys` [interface-AggregationsInferenceAggregateKeys] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsInferenceAggregation.md b/docs/reference/api/AggregationsInferenceAggregation.md index 519e81d1b..2b185c00f 100644 --- a/docs/reference/api/AggregationsInferenceAggregation.md +++ b/docs/reference/api/AggregationsInferenceAggregation.md @@ -1,4 +1,4 @@ -## Interface `AggregationsInferenceAggregation` +# `AggregationsInferenceAggregation` [interface-AggregationsInferenceAggregation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsInferenceClassImportance.md b/docs/reference/api/AggregationsInferenceClassImportance.md index ca258e704..d3eb0be81 100644 --- a/docs/reference/api/AggregationsInferenceClassImportance.md +++ b/docs/reference/api/AggregationsInferenceClassImportance.md @@ -1,4 +1,4 @@ -## Interface `AggregationsInferenceClassImportance` +# `AggregationsInferenceClassImportance` [interface-AggregationsInferenceClassImportance] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsInferenceConfigContainer.md b/docs/reference/api/AggregationsInferenceConfigContainer.md index 18e750654..c4d0fe06d 100644 --- a/docs/reference/api/AggregationsInferenceConfigContainer.md +++ b/docs/reference/api/AggregationsInferenceConfigContainer.md @@ -1,4 +1,4 @@ -## Interface `AggregationsInferenceConfigContainer` +# `AggregationsInferenceConfigContainer` [interface-AggregationsInferenceConfigContainer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsInferenceFeatureImportance.md b/docs/reference/api/AggregationsInferenceFeatureImportance.md index ba2eecc7d..661c99792 100644 --- a/docs/reference/api/AggregationsInferenceFeatureImportance.md +++ b/docs/reference/api/AggregationsInferenceFeatureImportance.md @@ -1,4 +1,4 @@ -## Interface `AggregationsInferenceFeatureImportance` +# `AggregationsInferenceFeatureImportance` [interface-AggregationsInferenceFeatureImportance] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsInferenceTopClassEntry.md b/docs/reference/api/AggregationsInferenceTopClassEntry.md index cd67773cd..40081cfdd 100644 --- a/docs/reference/api/AggregationsInferenceTopClassEntry.md +++ b/docs/reference/api/AggregationsInferenceTopClassEntry.md @@ -1,4 +1,4 @@ -## Interface `AggregationsInferenceTopClassEntry` +# `AggregationsInferenceTopClassEntry` [interface-AggregationsInferenceTopClassEntry] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsIpPrefixAggregate.md b/docs/reference/api/AggregationsIpPrefixAggregate.md index 5e272baf1..0935e86ad 100644 --- a/docs/reference/api/AggregationsIpPrefixAggregate.md +++ b/docs/reference/api/AggregationsIpPrefixAggregate.md @@ -1,4 +1,4 @@ -## Interface `AggregationsIpPrefixAggregate` +# `AggregationsIpPrefixAggregate` [interface-AggregationsIpPrefixAggregate] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsIpPrefixAggregation.md b/docs/reference/api/AggregationsIpPrefixAggregation.md index 6df56f68b..01e6592e4 100644 --- a/docs/reference/api/AggregationsIpPrefixAggregation.md +++ b/docs/reference/api/AggregationsIpPrefixAggregation.md @@ -1,4 +1,4 @@ -## Interface `AggregationsIpPrefixAggregation` +# `AggregationsIpPrefixAggregation` [interface-AggregationsIpPrefixAggregation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsIpPrefixBucket.md b/docs/reference/api/AggregationsIpPrefixBucket.md index 392d80f1a..4fd0a2b52 100644 --- a/docs/reference/api/AggregationsIpPrefixBucket.md +++ b/docs/reference/api/AggregationsIpPrefixBucket.md @@ -1,4 +1,4 @@ -## `AggregationsIpPrefixBucket` -::: +# `AggregationsIpPrefixBucket` [alias-AggregationsIpPrefixBucket] +```typescript type AggregationsIpPrefixBucket = [AggregationsIpPrefixBucketKeys](./AggregationsIpPrefixBucketKeys.md) & { [property: string]: [AggregationsAggregate](./AggregationsAggregate.md) | boolean | string | [integer](./integer.md) | [long](./long.md);}; -::: +``` diff --git a/docs/reference/api/AggregationsIpPrefixBucketKeys.md b/docs/reference/api/AggregationsIpPrefixBucketKeys.md index 7dc2811ea..5333c6a5b 100644 --- a/docs/reference/api/AggregationsIpPrefixBucketKeys.md +++ b/docs/reference/api/AggregationsIpPrefixBucketKeys.md @@ -1,4 +1,4 @@ -## Interface `AggregationsIpPrefixBucketKeys` +# `AggregationsIpPrefixBucketKeys` [interface-AggregationsIpPrefixBucketKeys] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsIpRangeAggregate.md b/docs/reference/api/AggregationsIpRangeAggregate.md index f3bd5bd40..96d407ac0 100644 --- a/docs/reference/api/AggregationsIpRangeAggregate.md +++ b/docs/reference/api/AggregationsIpRangeAggregate.md @@ -1,4 +1,4 @@ -## Interface `AggregationsIpRangeAggregate` +# `AggregationsIpRangeAggregate` [interface-AggregationsIpRangeAggregate] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsIpRangeAggregation.md b/docs/reference/api/AggregationsIpRangeAggregation.md index 82f042f91..681058b0d 100644 --- a/docs/reference/api/AggregationsIpRangeAggregation.md +++ b/docs/reference/api/AggregationsIpRangeAggregation.md @@ -1,4 +1,4 @@ -## Interface `AggregationsIpRangeAggregation` +# `AggregationsIpRangeAggregation` [interface-AggregationsIpRangeAggregation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsIpRangeAggregationRange.md b/docs/reference/api/AggregationsIpRangeAggregationRange.md index 49755db8d..3b4ca8623 100644 --- a/docs/reference/api/AggregationsIpRangeAggregationRange.md +++ b/docs/reference/api/AggregationsIpRangeAggregationRange.md @@ -1,4 +1,4 @@ -## Interface `AggregationsIpRangeAggregationRange` +# `AggregationsIpRangeAggregationRange` [interface-AggregationsIpRangeAggregationRange] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsIpRangeBucket.md b/docs/reference/api/AggregationsIpRangeBucket.md index a3ce0bf0a..6391d5535 100644 --- a/docs/reference/api/AggregationsIpRangeBucket.md +++ b/docs/reference/api/AggregationsIpRangeBucket.md @@ -1,4 +1,4 @@ -## `AggregationsIpRangeBucket` -::: +# `AggregationsIpRangeBucket` [alias-AggregationsIpRangeBucket] +```typescript type AggregationsIpRangeBucket = [AggregationsIpRangeBucketKeys](./AggregationsIpRangeBucketKeys.md) & { [property: string]: [AggregationsAggregate](./AggregationsAggregate.md) | string | [long](./long.md);}; -::: +``` diff --git a/docs/reference/api/AggregationsIpRangeBucketKeys.md b/docs/reference/api/AggregationsIpRangeBucketKeys.md index 6b8feb930..ac60cd0e8 100644 --- a/docs/reference/api/AggregationsIpRangeBucketKeys.md +++ b/docs/reference/api/AggregationsIpRangeBucketKeys.md @@ -1,4 +1,4 @@ -## Interface `AggregationsIpRangeBucketKeys` +# `AggregationsIpRangeBucketKeys` [interface-AggregationsIpRangeBucketKeys] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsKeyedPercentiles.md b/docs/reference/api/AggregationsKeyedPercentiles.md index 424189914..9a1645834 100644 --- a/docs/reference/api/AggregationsKeyedPercentiles.md +++ b/docs/reference/api/AggregationsKeyedPercentiles.md @@ -1,4 +1,4 @@ -## `AggregationsKeyedPercentiles` -::: +# `AggregationsKeyedPercentiles` [alias-AggregationsKeyedPercentiles] +```typescript type AggregationsKeyedPercentiles = Record; -::: +``` diff --git a/docs/reference/api/AggregationsLinearMovingAverageAggregation.md b/docs/reference/api/AggregationsLinearMovingAverageAggregation.md index f270f1d7f..fd3e482ea 100644 --- a/docs/reference/api/AggregationsLinearMovingAverageAggregation.md +++ b/docs/reference/api/AggregationsLinearMovingAverageAggregation.md @@ -1,4 +1,4 @@ -## Interface `AggregationsLinearMovingAverageAggregation` +# `AggregationsLinearMovingAverageAggregation` [interface-AggregationsLinearMovingAverageAggregation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsLongRareTermsAggregate.md b/docs/reference/api/AggregationsLongRareTermsAggregate.md index 550562f0f..4f00ceac3 100644 --- a/docs/reference/api/AggregationsLongRareTermsAggregate.md +++ b/docs/reference/api/AggregationsLongRareTermsAggregate.md @@ -1,4 +1,4 @@ -## Interface `AggregationsLongRareTermsAggregate` +# `AggregationsLongRareTermsAggregate` [interface-AggregationsLongRareTermsAggregate] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsLongRareTermsBucket.md b/docs/reference/api/AggregationsLongRareTermsBucket.md index dcd329475..0608146c9 100644 --- a/docs/reference/api/AggregationsLongRareTermsBucket.md +++ b/docs/reference/api/AggregationsLongRareTermsBucket.md @@ -1,4 +1,4 @@ -## `AggregationsLongRareTermsBucket` -::: +# `AggregationsLongRareTermsBucket` [alias-AggregationsLongRareTermsBucket] +```typescript type AggregationsLongRareTermsBucket = [AggregationsLongRareTermsBucketKeys](./AggregationsLongRareTermsBucketKeys.md) & { [property: string]: [AggregationsAggregate](./AggregationsAggregate.md) | [long](./long.md) | string;}; -::: +``` diff --git a/docs/reference/api/AggregationsLongRareTermsBucketKeys.md b/docs/reference/api/AggregationsLongRareTermsBucketKeys.md index 4edd53b9e..b7f2ba0f4 100644 --- a/docs/reference/api/AggregationsLongRareTermsBucketKeys.md +++ b/docs/reference/api/AggregationsLongRareTermsBucketKeys.md @@ -1,4 +1,4 @@ -## Interface `AggregationsLongRareTermsBucketKeys` +# `AggregationsLongRareTermsBucketKeys` [interface-AggregationsLongRareTermsBucketKeys] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsLongTermsAggregate.md b/docs/reference/api/AggregationsLongTermsAggregate.md index b20816b7f..047572030 100644 --- a/docs/reference/api/AggregationsLongTermsAggregate.md +++ b/docs/reference/api/AggregationsLongTermsAggregate.md @@ -1,4 +1,4 @@ -## Interface `AggregationsLongTermsAggregate` +# `AggregationsLongTermsAggregate` [interface-AggregationsLongTermsAggregate] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsLongTermsBucket.md b/docs/reference/api/AggregationsLongTermsBucket.md index 026d74788..cd930b10f 100644 --- a/docs/reference/api/AggregationsLongTermsBucket.md +++ b/docs/reference/api/AggregationsLongTermsBucket.md @@ -1,4 +1,4 @@ -## `AggregationsLongTermsBucket` -::: +# `AggregationsLongTermsBucket` [alias-AggregationsLongTermsBucket] +```typescript type AggregationsLongTermsBucket = [AggregationsLongTermsBucketKeys](./AggregationsLongTermsBucketKeys.md) & { [property: string]: [AggregationsAggregate](./AggregationsAggregate.md) | [long](./long.md) | string;}; -::: +``` diff --git a/docs/reference/api/AggregationsLongTermsBucketKeys.md b/docs/reference/api/AggregationsLongTermsBucketKeys.md index b2eeb5bcd..eca44b2dd 100644 --- a/docs/reference/api/AggregationsLongTermsBucketKeys.md +++ b/docs/reference/api/AggregationsLongTermsBucketKeys.md @@ -1,4 +1,4 @@ -## Interface `AggregationsLongTermsBucketKeys` +# `AggregationsLongTermsBucketKeys` [interface-AggregationsLongTermsBucketKeys] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsMatrixAggregation.md b/docs/reference/api/AggregationsMatrixAggregation.md index e7d312720..9173f7b37 100644 --- a/docs/reference/api/AggregationsMatrixAggregation.md +++ b/docs/reference/api/AggregationsMatrixAggregation.md @@ -1,4 +1,4 @@ -## Interface `AggregationsMatrixAggregation` +# `AggregationsMatrixAggregation` [interface-AggregationsMatrixAggregation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsMatrixStatsAggregate.md b/docs/reference/api/AggregationsMatrixStatsAggregate.md index 90a2bf35c..1da355c36 100644 --- a/docs/reference/api/AggregationsMatrixStatsAggregate.md +++ b/docs/reference/api/AggregationsMatrixStatsAggregate.md @@ -1,4 +1,4 @@ -## Interface `AggregationsMatrixStatsAggregate` +# `AggregationsMatrixStatsAggregate` [interface-AggregationsMatrixStatsAggregate] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsMatrixStatsAggregation.md b/docs/reference/api/AggregationsMatrixStatsAggregation.md index 5431c28dc..df1a1fdf1 100644 --- a/docs/reference/api/AggregationsMatrixStatsAggregation.md +++ b/docs/reference/api/AggregationsMatrixStatsAggregation.md @@ -1,4 +1,4 @@ -## Interface `AggregationsMatrixStatsAggregation` +# `AggregationsMatrixStatsAggregation` [interface-AggregationsMatrixStatsAggregation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsMatrixStatsFields.md b/docs/reference/api/AggregationsMatrixStatsFields.md index 2ea0cda70..d497350cf 100644 --- a/docs/reference/api/AggregationsMatrixStatsFields.md +++ b/docs/reference/api/AggregationsMatrixStatsFields.md @@ -1,4 +1,4 @@ -## Interface `AggregationsMatrixStatsFields` +# `AggregationsMatrixStatsFields` [interface-AggregationsMatrixStatsFields] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsMaxAggregate.md b/docs/reference/api/AggregationsMaxAggregate.md index a61aa4a5e..4b22a9179 100644 --- a/docs/reference/api/AggregationsMaxAggregate.md +++ b/docs/reference/api/AggregationsMaxAggregate.md @@ -1,4 +1,4 @@ -## Interface `AggregationsMaxAggregate` +# `AggregationsMaxAggregate` [interface-AggregationsMaxAggregate] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsMaxAggregation.md b/docs/reference/api/AggregationsMaxAggregation.md index fef312852..c9a428c4c 100644 --- a/docs/reference/api/AggregationsMaxAggregation.md +++ b/docs/reference/api/AggregationsMaxAggregation.md @@ -1,4 +1,4 @@ -## Interface `AggregationsMaxAggregation` +# `AggregationsMaxAggregation` [interface-AggregationsMaxAggregation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsMaxBucketAggregation.md b/docs/reference/api/AggregationsMaxBucketAggregation.md index b4d829e7e..b15049c11 100644 --- a/docs/reference/api/AggregationsMaxBucketAggregation.md +++ b/docs/reference/api/AggregationsMaxBucketAggregation.md @@ -1,4 +1,4 @@ -## Interface `AggregationsMaxBucketAggregation` +# `AggregationsMaxBucketAggregation` [interface-AggregationsMaxBucketAggregation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsMedianAbsoluteDeviationAggregate.md b/docs/reference/api/AggregationsMedianAbsoluteDeviationAggregate.md index c45b19ce1..093db6605 100644 --- a/docs/reference/api/AggregationsMedianAbsoluteDeviationAggregate.md +++ b/docs/reference/api/AggregationsMedianAbsoluteDeviationAggregate.md @@ -1,4 +1,4 @@ -## Interface `AggregationsMedianAbsoluteDeviationAggregate` +# `AggregationsMedianAbsoluteDeviationAggregate` [interface-AggregationsMedianAbsoluteDeviationAggregate] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsMedianAbsoluteDeviationAggregation.md b/docs/reference/api/AggregationsMedianAbsoluteDeviationAggregation.md index e97e12d8b..476396af5 100644 --- a/docs/reference/api/AggregationsMedianAbsoluteDeviationAggregation.md +++ b/docs/reference/api/AggregationsMedianAbsoluteDeviationAggregation.md @@ -1,4 +1,4 @@ -## Interface `AggregationsMedianAbsoluteDeviationAggregation` +# `AggregationsMedianAbsoluteDeviationAggregation` [interface-AggregationsMedianAbsoluteDeviationAggregation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsMetricAggregationBase.md b/docs/reference/api/AggregationsMetricAggregationBase.md index 240c90b7c..479ad7490 100644 --- a/docs/reference/api/AggregationsMetricAggregationBase.md +++ b/docs/reference/api/AggregationsMetricAggregationBase.md @@ -1,4 +1,4 @@ -## Interface `AggregationsMetricAggregationBase` +# `AggregationsMetricAggregationBase` [interface-AggregationsMetricAggregationBase] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsMinAggregate.md b/docs/reference/api/AggregationsMinAggregate.md index c4f4ad114..c2d8f5ad0 100644 --- a/docs/reference/api/AggregationsMinAggregate.md +++ b/docs/reference/api/AggregationsMinAggregate.md @@ -1,4 +1,4 @@ -## Interface `AggregationsMinAggregate` +# `AggregationsMinAggregate` [interface-AggregationsMinAggregate] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsMinAggregation.md b/docs/reference/api/AggregationsMinAggregation.md index d3a062a75..296f0378c 100644 --- a/docs/reference/api/AggregationsMinAggregation.md +++ b/docs/reference/api/AggregationsMinAggregation.md @@ -1,4 +1,4 @@ -## Interface `AggregationsMinAggregation` +# `AggregationsMinAggregation` [interface-AggregationsMinAggregation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsMinBucketAggregation.md b/docs/reference/api/AggregationsMinBucketAggregation.md index 9e91f85b7..9b283d2e9 100644 --- a/docs/reference/api/AggregationsMinBucketAggregation.md +++ b/docs/reference/api/AggregationsMinBucketAggregation.md @@ -1,4 +1,4 @@ -## Interface `AggregationsMinBucketAggregation` +# `AggregationsMinBucketAggregation` [interface-AggregationsMinBucketAggregation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsMinimumInterval.md b/docs/reference/api/AggregationsMinimumInterval.md index 3cfc8e128..bad450d1e 100644 --- a/docs/reference/api/AggregationsMinimumInterval.md +++ b/docs/reference/api/AggregationsMinimumInterval.md @@ -1,4 +1,4 @@ -## `AggregationsMinimumInterval` -::: +# `AggregationsMinimumInterval` [alias-AggregationsMinimumInterval] +```typescript type AggregationsMinimumInterval = 'second' | 'minute' | 'hour' | 'day' | 'month' | 'year'; -::: +``` diff --git a/docs/reference/api/AggregationsMissing.md b/docs/reference/api/AggregationsMissing.md index 9c551fc3a..2a1acc6a2 100644 --- a/docs/reference/api/AggregationsMissing.md +++ b/docs/reference/api/AggregationsMissing.md @@ -1,4 +1,4 @@ -## `AggregationsMissing` -::: +# `AggregationsMissing` [alias-AggregationsMissing] +```typescript type AggregationsMissing = string | [integer](./integer.md) | [double](./double.md) | boolean; -::: +``` diff --git a/docs/reference/api/AggregationsMissingAggregate.md b/docs/reference/api/AggregationsMissingAggregate.md index b549ef379..1a1239b88 100644 --- a/docs/reference/api/AggregationsMissingAggregate.md +++ b/docs/reference/api/AggregationsMissingAggregate.md @@ -1,4 +1,4 @@ -## `AggregationsMissingAggregate` -::: +# `AggregationsMissingAggregate` [alias-AggregationsMissingAggregate] +```typescript type AggregationsMissingAggregate = [AggregationsMissingAggregateKeys](./AggregationsMissingAggregateKeys.md) & { [property: string]: [AggregationsAggregate](./AggregationsAggregate.md) | [long](./long.md) | [Metadata](./Metadata.md);}; -::: +``` diff --git a/docs/reference/api/AggregationsMissingAggregateKeys.md b/docs/reference/api/AggregationsMissingAggregateKeys.md index 60cb74bd8..9347e26a2 100644 --- a/docs/reference/api/AggregationsMissingAggregateKeys.md +++ b/docs/reference/api/AggregationsMissingAggregateKeys.md @@ -1,4 +1,4 @@ -## Interface `AggregationsMissingAggregateKeys` +# `AggregationsMissingAggregateKeys` [interface-AggregationsMissingAggregateKeys] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsMissingAggregation.md b/docs/reference/api/AggregationsMissingAggregation.md index a11a38f15..33024488d 100644 --- a/docs/reference/api/AggregationsMissingAggregation.md +++ b/docs/reference/api/AggregationsMissingAggregation.md @@ -1,4 +1,4 @@ -## Interface `AggregationsMissingAggregation` +# `AggregationsMissingAggregation` [interface-AggregationsMissingAggregation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsMissingOrder.md b/docs/reference/api/AggregationsMissingOrder.md index c0097e8f0..b488d104d 100644 --- a/docs/reference/api/AggregationsMissingOrder.md +++ b/docs/reference/api/AggregationsMissingOrder.md @@ -1,4 +1,4 @@ -## `AggregationsMissingOrder` -::: +# `AggregationsMissingOrder` [alias-AggregationsMissingOrder] +```typescript type AggregationsMissingOrder = 'first' | 'last' | 'default'; -::: +``` diff --git a/docs/reference/api/AggregationsMovingAverageAggregation.md b/docs/reference/api/AggregationsMovingAverageAggregation.md index ac7e81363..34d8d3637 100644 --- a/docs/reference/api/AggregationsMovingAverageAggregation.md +++ b/docs/reference/api/AggregationsMovingAverageAggregation.md @@ -1,4 +1,4 @@ -## `AggregationsMovingAverageAggregation` -::: +# `AggregationsMovingAverageAggregation` [alias-AggregationsMovingAverageAggregation] +```typescript type AggregationsMovingAverageAggregation = [AggregationsLinearMovingAverageAggregation](./AggregationsLinearMovingAverageAggregation.md) | [AggregationsSimpleMovingAverageAggregation](./AggregationsSimpleMovingAverageAggregation.md) | [AggregationsEwmaMovingAverageAggregation](./AggregationsEwmaMovingAverageAggregation.md) | [AggregationsHoltMovingAverageAggregation](./AggregationsHoltMovingAverageAggregation.md) | [AggregationsHoltWintersMovingAverageAggregation](./AggregationsHoltWintersMovingAverageAggregation.md); -::: +``` diff --git a/docs/reference/api/AggregationsMovingAverageAggregationBase.md b/docs/reference/api/AggregationsMovingAverageAggregationBase.md index c28ac02ba..a03fa8034 100644 --- a/docs/reference/api/AggregationsMovingAverageAggregationBase.md +++ b/docs/reference/api/AggregationsMovingAverageAggregationBase.md @@ -1,4 +1,4 @@ -## Interface `AggregationsMovingAverageAggregationBase` +# `AggregationsMovingAverageAggregationBase` [interface-AggregationsMovingAverageAggregationBase] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsMovingFunctionAggregation.md b/docs/reference/api/AggregationsMovingFunctionAggregation.md index 3abb9e7ff..76be09397 100644 --- a/docs/reference/api/AggregationsMovingFunctionAggregation.md +++ b/docs/reference/api/AggregationsMovingFunctionAggregation.md @@ -1,4 +1,4 @@ -## Interface `AggregationsMovingFunctionAggregation` +# `AggregationsMovingFunctionAggregation` [interface-AggregationsMovingFunctionAggregation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsMovingPercentilesAggregation.md b/docs/reference/api/AggregationsMovingPercentilesAggregation.md index 82dd7d5d0..0c7ec7724 100644 --- a/docs/reference/api/AggregationsMovingPercentilesAggregation.md +++ b/docs/reference/api/AggregationsMovingPercentilesAggregation.md @@ -1,4 +1,4 @@ -## Interface `AggregationsMovingPercentilesAggregation` +# `AggregationsMovingPercentilesAggregation` [interface-AggregationsMovingPercentilesAggregation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsMultiBucketAggregateBase.md b/docs/reference/api/AggregationsMultiBucketAggregateBase.md index e2daff018..a8444383e 100644 --- a/docs/reference/api/AggregationsMultiBucketAggregateBase.md +++ b/docs/reference/api/AggregationsMultiBucketAggregateBase.md @@ -1,4 +1,4 @@ -## Interface `AggregationsMultiBucketAggregateBase` +# `AggregationsMultiBucketAggregateBase` [interface-AggregationsMultiBucketAggregateBase] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsMultiBucketBase.md b/docs/reference/api/AggregationsMultiBucketBase.md index af258f11f..509a54b76 100644 --- a/docs/reference/api/AggregationsMultiBucketBase.md +++ b/docs/reference/api/AggregationsMultiBucketBase.md @@ -1,4 +1,4 @@ -## Interface `AggregationsMultiBucketBase` +# `AggregationsMultiBucketBase` [interface-AggregationsMultiBucketBase] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsMultiTermLookup.md b/docs/reference/api/AggregationsMultiTermLookup.md index 6e76380b9..d20045c72 100644 --- a/docs/reference/api/AggregationsMultiTermLookup.md +++ b/docs/reference/api/AggregationsMultiTermLookup.md @@ -1,4 +1,4 @@ -## Interface `AggregationsMultiTermLookup` +# `AggregationsMultiTermLookup` [interface-AggregationsMultiTermLookup] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsMultiTermsAggregate.md b/docs/reference/api/AggregationsMultiTermsAggregate.md index 3ae7a7ea7..b899acdeb 100644 --- a/docs/reference/api/AggregationsMultiTermsAggregate.md +++ b/docs/reference/api/AggregationsMultiTermsAggregate.md @@ -1,4 +1,4 @@ -## Interface `AggregationsMultiTermsAggregate` +# `AggregationsMultiTermsAggregate` [interface-AggregationsMultiTermsAggregate] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsMultiTermsAggregation.md b/docs/reference/api/AggregationsMultiTermsAggregation.md index f66eb802d..9abc2b94d 100644 --- a/docs/reference/api/AggregationsMultiTermsAggregation.md +++ b/docs/reference/api/AggregationsMultiTermsAggregation.md @@ -1,4 +1,4 @@ -## Interface `AggregationsMultiTermsAggregation` +# `AggregationsMultiTermsAggregation` [interface-AggregationsMultiTermsAggregation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsMultiTermsBucket.md b/docs/reference/api/AggregationsMultiTermsBucket.md index 835711b83..3ed381663 100644 --- a/docs/reference/api/AggregationsMultiTermsBucket.md +++ b/docs/reference/api/AggregationsMultiTermsBucket.md @@ -1,4 +1,4 @@ -## `AggregationsMultiTermsBucket` -::: +# `AggregationsMultiTermsBucket` [alias-AggregationsMultiTermsBucket] +```typescript type AggregationsMultiTermsBucket = [AggregationsMultiTermsBucketKeys](./AggregationsMultiTermsBucketKeys.md) & { [property: string]: [AggregationsAggregate](./AggregationsAggregate.md) | [FieldValue](./FieldValue.md)[] | string | [long](./long.md);}; -::: +``` diff --git a/docs/reference/api/AggregationsMultiTermsBucketKeys.md b/docs/reference/api/AggregationsMultiTermsBucketKeys.md index dc743d191..d6d5ff91c 100644 --- a/docs/reference/api/AggregationsMultiTermsBucketKeys.md +++ b/docs/reference/api/AggregationsMultiTermsBucketKeys.md @@ -1,4 +1,4 @@ -## Interface `AggregationsMultiTermsBucketKeys` +# `AggregationsMultiTermsBucketKeys` [interface-AggregationsMultiTermsBucketKeys] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsMutualInformationHeuristic.md b/docs/reference/api/AggregationsMutualInformationHeuristic.md index a5e4163bf..288ef7752 100644 --- a/docs/reference/api/AggregationsMutualInformationHeuristic.md +++ b/docs/reference/api/AggregationsMutualInformationHeuristic.md @@ -1,4 +1,4 @@ -## Interface `AggregationsMutualInformationHeuristic` +# `AggregationsMutualInformationHeuristic` [interface-AggregationsMutualInformationHeuristic] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsNestedAggregate.md b/docs/reference/api/AggregationsNestedAggregate.md index b7a806f39..d63f2ce44 100644 --- a/docs/reference/api/AggregationsNestedAggregate.md +++ b/docs/reference/api/AggregationsNestedAggregate.md @@ -1,4 +1,4 @@ -## `AggregationsNestedAggregate` -::: +# `AggregationsNestedAggregate` [alias-AggregationsNestedAggregate] +```typescript type AggregationsNestedAggregate = [AggregationsNestedAggregateKeys](./AggregationsNestedAggregateKeys.md) & { [property: string]: [AggregationsAggregate](./AggregationsAggregate.md) | [long](./long.md) | [Metadata](./Metadata.md);}; -::: +``` diff --git a/docs/reference/api/AggregationsNestedAggregateKeys.md b/docs/reference/api/AggregationsNestedAggregateKeys.md index 890d82f43..3a7d6c679 100644 --- a/docs/reference/api/AggregationsNestedAggregateKeys.md +++ b/docs/reference/api/AggregationsNestedAggregateKeys.md @@ -1,4 +1,4 @@ -## Interface `AggregationsNestedAggregateKeys` +# `AggregationsNestedAggregateKeys` [interface-AggregationsNestedAggregateKeys] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsNestedAggregation.md b/docs/reference/api/AggregationsNestedAggregation.md index a253bc1bb..ee659bc9d 100644 --- a/docs/reference/api/AggregationsNestedAggregation.md +++ b/docs/reference/api/AggregationsNestedAggregation.md @@ -1,4 +1,4 @@ -## Interface `AggregationsNestedAggregation` +# `AggregationsNestedAggregation` [interface-AggregationsNestedAggregation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsNormalizeAggregation.md b/docs/reference/api/AggregationsNormalizeAggregation.md index 604150578..9d211af01 100644 --- a/docs/reference/api/AggregationsNormalizeAggregation.md +++ b/docs/reference/api/AggregationsNormalizeAggregation.md @@ -1,4 +1,4 @@ -## Interface `AggregationsNormalizeAggregation` +# `AggregationsNormalizeAggregation` [interface-AggregationsNormalizeAggregation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsNormalizeMethod.md b/docs/reference/api/AggregationsNormalizeMethod.md index b386bfab1..1164ee468 100644 --- a/docs/reference/api/AggregationsNormalizeMethod.md +++ b/docs/reference/api/AggregationsNormalizeMethod.md @@ -1,4 +1,4 @@ -## `AggregationsNormalizeMethod` -::: +# `AggregationsNormalizeMethod` [alias-AggregationsNormalizeMethod] +```typescript type AggregationsNormalizeMethod = 'rescale_0_1' | 'rescale_0_100' | 'percent_of_sum' | 'mean' | 'z-score' | 'softmax'; -::: +``` diff --git a/docs/reference/api/AggregationsParentAggregate.md b/docs/reference/api/AggregationsParentAggregate.md index 7bff81894..eee96f509 100644 --- a/docs/reference/api/AggregationsParentAggregate.md +++ b/docs/reference/api/AggregationsParentAggregate.md @@ -1,4 +1,4 @@ -## `AggregationsParentAggregate` -::: +# `AggregationsParentAggregate` [alias-AggregationsParentAggregate] +```typescript type AggregationsParentAggregate = [AggregationsParentAggregateKeys](./AggregationsParentAggregateKeys.md) & { [property: string]: [AggregationsAggregate](./AggregationsAggregate.md) | [long](./long.md) | [Metadata](./Metadata.md);}; -::: +``` diff --git a/docs/reference/api/AggregationsParentAggregateKeys.md b/docs/reference/api/AggregationsParentAggregateKeys.md index 188558304..e1caca8e5 100644 --- a/docs/reference/api/AggregationsParentAggregateKeys.md +++ b/docs/reference/api/AggregationsParentAggregateKeys.md @@ -1,4 +1,4 @@ -## Interface `AggregationsParentAggregateKeys` +# `AggregationsParentAggregateKeys` [interface-AggregationsParentAggregateKeys] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsParentAggregation.md b/docs/reference/api/AggregationsParentAggregation.md index 6ef05e20c..8e88172bf 100644 --- a/docs/reference/api/AggregationsParentAggregation.md +++ b/docs/reference/api/AggregationsParentAggregation.md @@ -1,4 +1,4 @@ -## Interface `AggregationsParentAggregation` +# `AggregationsParentAggregation` [interface-AggregationsParentAggregation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsPercentageScoreHeuristic.md b/docs/reference/api/AggregationsPercentageScoreHeuristic.md index f0dcb3468..6682f632f 100644 --- a/docs/reference/api/AggregationsPercentageScoreHeuristic.md +++ b/docs/reference/api/AggregationsPercentageScoreHeuristic.md @@ -1,4 +1,4 @@ -## Interface `AggregationsPercentageScoreHeuristic` +# `AggregationsPercentageScoreHeuristic` [interface-AggregationsPercentageScoreHeuristic] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsPercentileRanksAggregation.md b/docs/reference/api/AggregationsPercentileRanksAggregation.md index 80d7b7c3c..c65c1ae73 100644 --- a/docs/reference/api/AggregationsPercentileRanksAggregation.md +++ b/docs/reference/api/AggregationsPercentileRanksAggregation.md @@ -1,4 +1,4 @@ -## Interface `AggregationsPercentileRanksAggregation` +# `AggregationsPercentileRanksAggregation` [interface-AggregationsPercentileRanksAggregation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsPercentiles.md b/docs/reference/api/AggregationsPercentiles.md index 9a8294a45..1275c74a9 100644 --- a/docs/reference/api/AggregationsPercentiles.md +++ b/docs/reference/api/AggregationsPercentiles.md @@ -1,4 +1,4 @@ -## `AggregationsPercentiles` -::: +# `AggregationsPercentiles` [alias-AggregationsPercentiles] +```typescript type AggregationsPercentiles = [AggregationsKeyedPercentiles](./AggregationsKeyedPercentiles.md) | [AggregationsArrayPercentilesItem](./AggregationsArrayPercentilesItem.md)[]; -::: +``` diff --git a/docs/reference/api/AggregationsPercentilesAggregateBase.md b/docs/reference/api/AggregationsPercentilesAggregateBase.md index a33a094f1..89073c8f3 100644 --- a/docs/reference/api/AggregationsPercentilesAggregateBase.md +++ b/docs/reference/api/AggregationsPercentilesAggregateBase.md @@ -1,4 +1,4 @@ -## Interface `AggregationsPercentilesAggregateBase` +# `AggregationsPercentilesAggregateBase` [interface-AggregationsPercentilesAggregateBase] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsPercentilesAggregation.md b/docs/reference/api/AggregationsPercentilesAggregation.md index 927ba373d..c3b8bd5e1 100644 --- a/docs/reference/api/AggregationsPercentilesAggregation.md +++ b/docs/reference/api/AggregationsPercentilesAggregation.md @@ -1,4 +1,4 @@ -## Interface `AggregationsPercentilesAggregation` +# `AggregationsPercentilesAggregation` [interface-AggregationsPercentilesAggregation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsPercentilesBucketAggregate.md b/docs/reference/api/AggregationsPercentilesBucketAggregate.md index 54d4e1ad8..415cbdea8 100644 --- a/docs/reference/api/AggregationsPercentilesBucketAggregate.md +++ b/docs/reference/api/AggregationsPercentilesBucketAggregate.md @@ -1,4 +1,4 @@ -## Interface `AggregationsPercentilesBucketAggregate` +# `AggregationsPercentilesBucketAggregate` [interface-AggregationsPercentilesBucketAggregate] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsPercentilesBucketAggregation.md b/docs/reference/api/AggregationsPercentilesBucketAggregation.md index 122fe43c8..2e1d8bc2f 100644 --- a/docs/reference/api/AggregationsPercentilesBucketAggregation.md +++ b/docs/reference/api/AggregationsPercentilesBucketAggregation.md @@ -1,4 +1,4 @@ -## Interface `AggregationsPercentilesBucketAggregation` +# `AggregationsPercentilesBucketAggregation` [interface-AggregationsPercentilesBucketAggregation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsPipelineAggregationBase.md b/docs/reference/api/AggregationsPipelineAggregationBase.md index 7ca8d7bd1..9ab68c587 100644 --- a/docs/reference/api/AggregationsPipelineAggregationBase.md +++ b/docs/reference/api/AggregationsPipelineAggregationBase.md @@ -1,4 +1,4 @@ -## Interface `AggregationsPipelineAggregationBase` +# `AggregationsPipelineAggregationBase` [interface-AggregationsPipelineAggregationBase] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsRandomSamplerAggregation.md b/docs/reference/api/AggregationsRandomSamplerAggregation.md index e38216327..dacacac4c 100644 --- a/docs/reference/api/AggregationsRandomSamplerAggregation.md +++ b/docs/reference/api/AggregationsRandomSamplerAggregation.md @@ -1,4 +1,4 @@ -## Interface `AggregationsRandomSamplerAggregation` +# `AggregationsRandomSamplerAggregation` [interface-AggregationsRandomSamplerAggregation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsRangeAggregate.md b/docs/reference/api/AggregationsRangeAggregate.md index 7e9ca369d..856799249 100644 --- a/docs/reference/api/AggregationsRangeAggregate.md +++ b/docs/reference/api/AggregationsRangeAggregate.md @@ -1,4 +1,4 @@ -## Interface `AggregationsRangeAggregate` +# `AggregationsRangeAggregate` [interface-AggregationsRangeAggregate] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsRangeAggregation.md b/docs/reference/api/AggregationsRangeAggregation.md index adf52d4da..3b76d6f5c 100644 --- a/docs/reference/api/AggregationsRangeAggregation.md +++ b/docs/reference/api/AggregationsRangeAggregation.md @@ -1,4 +1,4 @@ -## Interface `AggregationsRangeAggregation` +# `AggregationsRangeAggregation` [interface-AggregationsRangeAggregation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsRangeBucket.md b/docs/reference/api/AggregationsRangeBucket.md index a3afdd010..74d754fd5 100644 --- a/docs/reference/api/AggregationsRangeBucket.md +++ b/docs/reference/api/AggregationsRangeBucket.md @@ -1,4 +1,4 @@ -## `AggregationsRangeBucket` -::: +# `AggregationsRangeBucket` [alias-AggregationsRangeBucket] +```typescript type AggregationsRangeBucket = [AggregationsRangeBucketKeys](./AggregationsRangeBucketKeys.md) & { [property: string]: [AggregationsAggregate](./AggregationsAggregate.md) | [double](./double.md) | string | [long](./long.md);}; -::: +``` diff --git a/docs/reference/api/AggregationsRangeBucketKeys.md b/docs/reference/api/AggregationsRangeBucketKeys.md index aa72726e8..50fe2b828 100644 --- a/docs/reference/api/AggregationsRangeBucketKeys.md +++ b/docs/reference/api/AggregationsRangeBucketKeys.md @@ -1,4 +1,4 @@ -## Interface `AggregationsRangeBucketKeys` +# `AggregationsRangeBucketKeys` [interface-AggregationsRangeBucketKeys] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsRareTermsAggregation.md b/docs/reference/api/AggregationsRareTermsAggregation.md index 4f4d7a89f..c0a4bc4dd 100644 --- a/docs/reference/api/AggregationsRareTermsAggregation.md +++ b/docs/reference/api/AggregationsRareTermsAggregation.md @@ -1,4 +1,4 @@ -## Interface `AggregationsRareTermsAggregation` +# `AggregationsRareTermsAggregation` [interface-AggregationsRareTermsAggregation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsRateAggregate.md b/docs/reference/api/AggregationsRateAggregate.md index 994da3d3c..a4438d18f 100644 --- a/docs/reference/api/AggregationsRateAggregate.md +++ b/docs/reference/api/AggregationsRateAggregate.md @@ -1,4 +1,4 @@ -## Interface `AggregationsRateAggregate` +# `AggregationsRateAggregate` [interface-AggregationsRateAggregate] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsRateAggregation.md b/docs/reference/api/AggregationsRateAggregation.md index dbe40e7f8..484155cc3 100644 --- a/docs/reference/api/AggregationsRateAggregation.md +++ b/docs/reference/api/AggregationsRateAggregation.md @@ -1,4 +1,4 @@ -## Interface `AggregationsRateAggregation` +# `AggregationsRateAggregation` [interface-AggregationsRateAggregation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsRateMode.md b/docs/reference/api/AggregationsRateMode.md index 81c492d06..e371108d0 100644 --- a/docs/reference/api/AggregationsRateMode.md +++ b/docs/reference/api/AggregationsRateMode.md @@ -1,4 +1,4 @@ -## `AggregationsRateMode` -::: +# `AggregationsRateMode` [alias-AggregationsRateMode] +```typescript type AggregationsRateMode = 'sum' | 'value_count'; -::: +``` diff --git a/docs/reference/api/AggregationsReverseNestedAggregate.md b/docs/reference/api/AggregationsReverseNestedAggregate.md index 5ec524e75..75ec04256 100644 --- a/docs/reference/api/AggregationsReverseNestedAggregate.md +++ b/docs/reference/api/AggregationsReverseNestedAggregate.md @@ -1,4 +1,4 @@ -## `AggregationsReverseNestedAggregate` -::: +# `AggregationsReverseNestedAggregate` [alias-AggregationsReverseNestedAggregate] +```typescript type AggregationsReverseNestedAggregate = [AggregationsReverseNestedAggregateKeys](./AggregationsReverseNestedAggregateKeys.md) & { [property: string]: [AggregationsAggregate](./AggregationsAggregate.md) | [long](./long.md) | [Metadata](./Metadata.md);}; -::: +``` diff --git a/docs/reference/api/AggregationsReverseNestedAggregateKeys.md b/docs/reference/api/AggregationsReverseNestedAggregateKeys.md index d2e1410b8..9a963f8f2 100644 --- a/docs/reference/api/AggregationsReverseNestedAggregateKeys.md +++ b/docs/reference/api/AggregationsReverseNestedAggregateKeys.md @@ -1,4 +1,4 @@ -## Interface `AggregationsReverseNestedAggregateKeys` +# `AggregationsReverseNestedAggregateKeys` [interface-AggregationsReverseNestedAggregateKeys] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsReverseNestedAggregation.md b/docs/reference/api/AggregationsReverseNestedAggregation.md index 0afd60b96..afe89b96b 100644 --- a/docs/reference/api/AggregationsReverseNestedAggregation.md +++ b/docs/reference/api/AggregationsReverseNestedAggregation.md @@ -1,4 +1,4 @@ -## Interface `AggregationsReverseNestedAggregation` +# `AggregationsReverseNestedAggregation` [interface-AggregationsReverseNestedAggregation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsSamplerAggregate.md b/docs/reference/api/AggregationsSamplerAggregate.md index ef65d8d86..127508e8e 100644 --- a/docs/reference/api/AggregationsSamplerAggregate.md +++ b/docs/reference/api/AggregationsSamplerAggregate.md @@ -1,4 +1,4 @@ -## `AggregationsSamplerAggregate` -::: +# `AggregationsSamplerAggregate` [alias-AggregationsSamplerAggregate] +```typescript type AggregationsSamplerAggregate = [AggregationsSamplerAggregateKeys](./AggregationsSamplerAggregateKeys.md) & { [property: string]: [AggregationsAggregate](./AggregationsAggregate.md) | [long](./long.md) | [Metadata](./Metadata.md);}; -::: +``` diff --git a/docs/reference/api/AggregationsSamplerAggregateKeys.md b/docs/reference/api/AggregationsSamplerAggregateKeys.md index 1a8bef963..3d0e3391e 100644 --- a/docs/reference/api/AggregationsSamplerAggregateKeys.md +++ b/docs/reference/api/AggregationsSamplerAggregateKeys.md @@ -1,4 +1,4 @@ -## Interface `AggregationsSamplerAggregateKeys` +# `AggregationsSamplerAggregateKeys` [interface-AggregationsSamplerAggregateKeys] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsSamplerAggregation.md b/docs/reference/api/AggregationsSamplerAggregation.md index 6077f619a..660393723 100644 --- a/docs/reference/api/AggregationsSamplerAggregation.md +++ b/docs/reference/api/AggregationsSamplerAggregation.md @@ -1,4 +1,4 @@ -## Interface `AggregationsSamplerAggregation` +# `AggregationsSamplerAggregation` [interface-AggregationsSamplerAggregation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsSamplerAggregationExecutionHint.md b/docs/reference/api/AggregationsSamplerAggregationExecutionHint.md index dc2090af7..ec6abc41f 100644 --- a/docs/reference/api/AggregationsSamplerAggregationExecutionHint.md +++ b/docs/reference/api/AggregationsSamplerAggregationExecutionHint.md @@ -1,4 +1,4 @@ -## `AggregationsSamplerAggregationExecutionHint` -::: +# `AggregationsSamplerAggregationExecutionHint` [alias-AggregationsSamplerAggregationExecutionHint] +```typescript type AggregationsSamplerAggregationExecutionHint = 'map' | 'global_ordinals' | 'bytes_hash'; -::: +``` diff --git a/docs/reference/api/AggregationsScriptedHeuristic.md b/docs/reference/api/AggregationsScriptedHeuristic.md index 1bc6b7779..b3630e975 100644 --- a/docs/reference/api/AggregationsScriptedHeuristic.md +++ b/docs/reference/api/AggregationsScriptedHeuristic.md @@ -1,4 +1,4 @@ -## Interface `AggregationsScriptedHeuristic` +# `AggregationsScriptedHeuristic` [interface-AggregationsScriptedHeuristic] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsScriptedMetricAggregate.md b/docs/reference/api/AggregationsScriptedMetricAggregate.md index e03807554..b4a79cb14 100644 --- a/docs/reference/api/AggregationsScriptedMetricAggregate.md +++ b/docs/reference/api/AggregationsScriptedMetricAggregate.md @@ -1,4 +1,4 @@ -## Interface `AggregationsScriptedMetricAggregate` +# `AggregationsScriptedMetricAggregate` [interface-AggregationsScriptedMetricAggregate] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsScriptedMetricAggregation.md b/docs/reference/api/AggregationsScriptedMetricAggregation.md index 9640ea0e4..f56f4fe97 100644 --- a/docs/reference/api/AggregationsScriptedMetricAggregation.md +++ b/docs/reference/api/AggregationsScriptedMetricAggregation.md @@ -1,4 +1,4 @@ -## Interface `AggregationsScriptedMetricAggregation` +# `AggregationsScriptedMetricAggregation` [interface-AggregationsScriptedMetricAggregation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsSerialDifferencingAggregation.md b/docs/reference/api/AggregationsSerialDifferencingAggregation.md index 973c85b25..6a550a87b 100644 --- a/docs/reference/api/AggregationsSerialDifferencingAggregation.md +++ b/docs/reference/api/AggregationsSerialDifferencingAggregation.md @@ -1,4 +1,4 @@ -## Interface `AggregationsSerialDifferencingAggregation` +# `AggregationsSerialDifferencingAggregation` [interface-AggregationsSerialDifferencingAggregation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsSignificantLongTermsAggregate.md b/docs/reference/api/AggregationsSignificantLongTermsAggregate.md index 4629020f5..651112dcb 100644 --- a/docs/reference/api/AggregationsSignificantLongTermsAggregate.md +++ b/docs/reference/api/AggregationsSignificantLongTermsAggregate.md @@ -1,4 +1,4 @@ -## Interface `AggregationsSignificantLongTermsAggregate` +# `AggregationsSignificantLongTermsAggregate` [interface-AggregationsSignificantLongTermsAggregate] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsSignificantLongTermsBucket.md b/docs/reference/api/AggregationsSignificantLongTermsBucket.md index 364cbb3fa..09a087100 100644 --- a/docs/reference/api/AggregationsSignificantLongTermsBucket.md +++ b/docs/reference/api/AggregationsSignificantLongTermsBucket.md @@ -1,4 +1,4 @@ -## `AggregationsSignificantLongTermsBucket` -::: +# `AggregationsSignificantLongTermsBucket` [alias-AggregationsSignificantLongTermsBucket] +```typescript type AggregationsSignificantLongTermsBucket = [AggregationsSignificantLongTermsBucketKeys](./AggregationsSignificantLongTermsBucketKeys.md) & { [property: string]: [AggregationsAggregate](./AggregationsAggregate.md) | [long](./long.md) | string | [double](./double.md);}; -::: +``` diff --git a/docs/reference/api/AggregationsSignificantLongTermsBucketKeys.md b/docs/reference/api/AggregationsSignificantLongTermsBucketKeys.md index 776c24ea1..ce3557c70 100644 --- a/docs/reference/api/AggregationsSignificantLongTermsBucketKeys.md +++ b/docs/reference/api/AggregationsSignificantLongTermsBucketKeys.md @@ -1,4 +1,4 @@ -## Interface `AggregationsSignificantLongTermsBucketKeys` +# `AggregationsSignificantLongTermsBucketKeys` [interface-AggregationsSignificantLongTermsBucketKeys] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsSignificantStringTermsAggregate.md b/docs/reference/api/AggregationsSignificantStringTermsAggregate.md index f0acf3b1a..181d68511 100644 --- a/docs/reference/api/AggregationsSignificantStringTermsAggregate.md +++ b/docs/reference/api/AggregationsSignificantStringTermsAggregate.md @@ -1,4 +1,4 @@ -## Interface `AggregationsSignificantStringTermsAggregate` +# `AggregationsSignificantStringTermsAggregate` [interface-AggregationsSignificantStringTermsAggregate] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsSignificantStringTermsBucket.md b/docs/reference/api/AggregationsSignificantStringTermsBucket.md index ff2268342..d06cf2e91 100644 --- a/docs/reference/api/AggregationsSignificantStringTermsBucket.md +++ b/docs/reference/api/AggregationsSignificantStringTermsBucket.md @@ -1,4 +1,4 @@ -## `AggregationsSignificantStringTermsBucket` -::: +# `AggregationsSignificantStringTermsBucket` [alias-AggregationsSignificantStringTermsBucket] +```typescript type AggregationsSignificantStringTermsBucket = [AggregationsSignificantStringTermsBucketKeys](./AggregationsSignificantStringTermsBucketKeys.md) & { [property: string]: [AggregationsAggregate](./AggregationsAggregate.md) | string | [double](./double.md) | [long](./long.md);}; -::: +``` diff --git a/docs/reference/api/AggregationsSignificantStringTermsBucketKeys.md b/docs/reference/api/AggregationsSignificantStringTermsBucketKeys.md index d1bffaedd..ca238b430 100644 --- a/docs/reference/api/AggregationsSignificantStringTermsBucketKeys.md +++ b/docs/reference/api/AggregationsSignificantStringTermsBucketKeys.md @@ -1,4 +1,4 @@ -## Interface `AggregationsSignificantStringTermsBucketKeys` +# `AggregationsSignificantStringTermsBucketKeys` [interface-AggregationsSignificantStringTermsBucketKeys] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsSignificantTermsAggregateBase.md b/docs/reference/api/AggregationsSignificantTermsAggregateBase.md index 8d750614e..81fcefdf8 100644 --- a/docs/reference/api/AggregationsSignificantTermsAggregateBase.md +++ b/docs/reference/api/AggregationsSignificantTermsAggregateBase.md @@ -1,4 +1,4 @@ -## Interface `AggregationsSignificantTermsAggregateBase` +# `AggregationsSignificantTermsAggregateBase` [interface-AggregationsSignificantTermsAggregateBase] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsSignificantTermsAggregation.md b/docs/reference/api/AggregationsSignificantTermsAggregation.md index 1b9bb9685..3f7214a78 100644 --- a/docs/reference/api/AggregationsSignificantTermsAggregation.md +++ b/docs/reference/api/AggregationsSignificantTermsAggregation.md @@ -1,4 +1,4 @@ -## Interface `AggregationsSignificantTermsAggregation` +# `AggregationsSignificantTermsAggregation` [interface-AggregationsSignificantTermsAggregation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsSignificantTermsBucketBase.md b/docs/reference/api/AggregationsSignificantTermsBucketBase.md index defbfeb09..4256a7a09 100644 --- a/docs/reference/api/AggregationsSignificantTermsBucketBase.md +++ b/docs/reference/api/AggregationsSignificantTermsBucketBase.md @@ -1,4 +1,4 @@ -## Interface `AggregationsSignificantTermsBucketBase` +# `AggregationsSignificantTermsBucketBase` [interface-AggregationsSignificantTermsBucketBase] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsSignificantTextAggregation.md b/docs/reference/api/AggregationsSignificantTextAggregation.md index 4371cfd84..82f9a616e 100644 --- a/docs/reference/api/AggregationsSignificantTextAggregation.md +++ b/docs/reference/api/AggregationsSignificantTextAggregation.md @@ -1,4 +1,4 @@ -## Interface `AggregationsSignificantTextAggregation` +# `AggregationsSignificantTextAggregation` [interface-AggregationsSignificantTextAggregation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsSimpleMovingAverageAggregation.md b/docs/reference/api/AggregationsSimpleMovingAverageAggregation.md index a90f1aaf4..2a465c51b 100644 --- a/docs/reference/api/AggregationsSimpleMovingAverageAggregation.md +++ b/docs/reference/api/AggregationsSimpleMovingAverageAggregation.md @@ -1,4 +1,4 @@ -## Interface `AggregationsSimpleMovingAverageAggregation` +# `AggregationsSimpleMovingAverageAggregation` [interface-AggregationsSimpleMovingAverageAggregation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsSimpleValueAggregate.md b/docs/reference/api/AggregationsSimpleValueAggregate.md index 15644ce2e..873ea4acf 100644 --- a/docs/reference/api/AggregationsSimpleValueAggregate.md +++ b/docs/reference/api/AggregationsSimpleValueAggregate.md @@ -1,4 +1,4 @@ -## Interface `AggregationsSimpleValueAggregate` +# `AggregationsSimpleValueAggregate` [interface-AggregationsSimpleValueAggregate] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsSingleBucketAggregateBase.md b/docs/reference/api/AggregationsSingleBucketAggregateBase.md index 1b39842ab..c8884230e 100644 --- a/docs/reference/api/AggregationsSingleBucketAggregateBase.md +++ b/docs/reference/api/AggregationsSingleBucketAggregateBase.md @@ -1,4 +1,4 @@ -## Interface `AggregationsSingleBucketAggregateBase` +# `AggregationsSingleBucketAggregateBase` [interface-AggregationsSingleBucketAggregateBase] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsSingleMetricAggregateBase.md b/docs/reference/api/AggregationsSingleMetricAggregateBase.md index f16ebd418..a2f3b2b1a 100644 --- a/docs/reference/api/AggregationsSingleMetricAggregateBase.md +++ b/docs/reference/api/AggregationsSingleMetricAggregateBase.md @@ -1,4 +1,4 @@ -## Interface `AggregationsSingleMetricAggregateBase` +# `AggregationsSingleMetricAggregateBase` [interface-AggregationsSingleMetricAggregateBase] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsStandardDeviationBounds.md b/docs/reference/api/AggregationsStandardDeviationBounds.md index d2c4661d6..d77f3cf22 100644 --- a/docs/reference/api/AggregationsStandardDeviationBounds.md +++ b/docs/reference/api/AggregationsStandardDeviationBounds.md @@ -1,4 +1,4 @@ -## Interface `AggregationsStandardDeviationBounds` +# `AggregationsStandardDeviationBounds` [interface-AggregationsStandardDeviationBounds] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsStandardDeviationBoundsAsString.md b/docs/reference/api/AggregationsStandardDeviationBoundsAsString.md index d8f3dc518..94e5c8f96 100644 --- a/docs/reference/api/AggregationsStandardDeviationBoundsAsString.md +++ b/docs/reference/api/AggregationsStandardDeviationBoundsAsString.md @@ -1,4 +1,4 @@ -## Interface `AggregationsStandardDeviationBoundsAsString` +# `AggregationsStandardDeviationBoundsAsString` [interface-AggregationsStandardDeviationBoundsAsString] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsStatsAggregate.md b/docs/reference/api/AggregationsStatsAggregate.md index a6a0a5b46..b98571e98 100644 --- a/docs/reference/api/AggregationsStatsAggregate.md +++ b/docs/reference/api/AggregationsStatsAggregate.md @@ -1,4 +1,4 @@ -## Interface `AggregationsStatsAggregate` +# `AggregationsStatsAggregate` [interface-AggregationsStatsAggregate] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsStatsAggregation.md b/docs/reference/api/AggregationsStatsAggregation.md index 2b91b3d32..b3e8ff35a 100644 --- a/docs/reference/api/AggregationsStatsAggregation.md +++ b/docs/reference/api/AggregationsStatsAggregation.md @@ -1,4 +1,4 @@ -## Interface `AggregationsStatsAggregation` +# `AggregationsStatsAggregation` [interface-AggregationsStatsAggregation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsStatsBucketAggregate.md b/docs/reference/api/AggregationsStatsBucketAggregate.md index 983064b99..cad1c0fb8 100644 --- a/docs/reference/api/AggregationsStatsBucketAggregate.md +++ b/docs/reference/api/AggregationsStatsBucketAggregate.md @@ -1,4 +1,4 @@ -## Interface `AggregationsStatsBucketAggregate` +# `AggregationsStatsBucketAggregate` [interface-AggregationsStatsBucketAggregate] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsStatsBucketAggregation.md b/docs/reference/api/AggregationsStatsBucketAggregation.md index dd1a1b8f3..ee746c70e 100644 --- a/docs/reference/api/AggregationsStatsBucketAggregation.md +++ b/docs/reference/api/AggregationsStatsBucketAggregation.md @@ -1,4 +1,4 @@ -## Interface `AggregationsStatsBucketAggregation` +# `AggregationsStatsBucketAggregation` [interface-AggregationsStatsBucketAggregation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsStringRareTermsAggregate.md b/docs/reference/api/AggregationsStringRareTermsAggregate.md index 1632f17c1..7d366c128 100644 --- a/docs/reference/api/AggregationsStringRareTermsAggregate.md +++ b/docs/reference/api/AggregationsStringRareTermsAggregate.md @@ -1,4 +1,4 @@ -## Interface `AggregationsStringRareTermsAggregate` +# `AggregationsStringRareTermsAggregate` [interface-AggregationsStringRareTermsAggregate] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsStringRareTermsBucket.md b/docs/reference/api/AggregationsStringRareTermsBucket.md index f7ee13f19..d23c0e6ea 100644 --- a/docs/reference/api/AggregationsStringRareTermsBucket.md +++ b/docs/reference/api/AggregationsStringRareTermsBucket.md @@ -1,4 +1,4 @@ -## `AggregationsStringRareTermsBucket` -::: +# `AggregationsStringRareTermsBucket` [alias-AggregationsStringRareTermsBucket] +```typescript type AggregationsStringRareTermsBucket = [AggregationsStringRareTermsBucketKeys](./AggregationsStringRareTermsBucketKeys.md) & { [property: string]: [AggregationsAggregate](./AggregationsAggregate.md) | string | [long](./long.md);}; -::: +``` diff --git a/docs/reference/api/AggregationsStringRareTermsBucketKeys.md b/docs/reference/api/AggregationsStringRareTermsBucketKeys.md index f368b6f66..4eb7a06ff 100644 --- a/docs/reference/api/AggregationsStringRareTermsBucketKeys.md +++ b/docs/reference/api/AggregationsStringRareTermsBucketKeys.md @@ -1,4 +1,4 @@ -## Interface `AggregationsStringRareTermsBucketKeys` +# `AggregationsStringRareTermsBucketKeys` [interface-AggregationsStringRareTermsBucketKeys] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsStringStatsAggregate.md b/docs/reference/api/AggregationsStringStatsAggregate.md index ce7ab8988..f2fce5567 100644 --- a/docs/reference/api/AggregationsStringStatsAggregate.md +++ b/docs/reference/api/AggregationsStringStatsAggregate.md @@ -1,4 +1,4 @@ -## Interface `AggregationsStringStatsAggregate` +# `AggregationsStringStatsAggregate` [interface-AggregationsStringStatsAggregate] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsStringStatsAggregation.md b/docs/reference/api/AggregationsStringStatsAggregation.md index 766c127c9..8b66a545d 100644 --- a/docs/reference/api/AggregationsStringStatsAggregation.md +++ b/docs/reference/api/AggregationsStringStatsAggregation.md @@ -1,4 +1,4 @@ -## Interface `AggregationsStringStatsAggregation` +# `AggregationsStringStatsAggregation` [interface-AggregationsStringStatsAggregation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsStringTermsAggregate.md b/docs/reference/api/AggregationsStringTermsAggregate.md index 81d010fb2..217c40f49 100644 --- a/docs/reference/api/AggregationsStringTermsAggregate.md +++ b/docs/reference/api/AggregationsStringTermsAggregate.md @@ -1,4 +1,4 @@ -## Interface `AggregationsStringTermsAggregate` +# `AggregationsStringTermsAggregate` [interface-AggregationsStringTermsAggregate] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsStringTermsBucket.md b/docs/reference/api/AggregationsStringTermsBucket.md index 34f945d79..21803d2ef 100644 --- a/docs/reference/api/AggregationsStringTermsBucket.md +++ b/docs/reference/api/AggregationsStringTermsBucket.md @@ -1,4 +1,4 @@ -## `AggregationsStringTermsBucket` -::: +# `AggregationsStringTermsBucket` [alias-AggregationsStringTermsBucket] +```typescript type AggregationsStringTermsBucket = [AggregationsStringTermsBucketKeys](./AggregationsStringTermsBucketKeys.md) & { [property: string]: [AggregationsAggregate](./AggregationsAggregate.md) | [FieldValue](./FieldValue.md) | [long](./long.md);}; -::: +``` diff --git a/docs/reference/api/AggregationsStringTermsBucketKeys.md b/docs/reference/api/AggregationsStringTermsBucketKeys.md index 37d2c970b..8947a4024 100644 --- a/docs/reference/api/AggregationsStringTermsBucketKeys.md +++ b/docs/reference/api/AggregationsStringTermsBucketKeys.md @@ -1,4 +1,4 @@ -## Interface `AggregationsStringTermsBucketKeys` +# `AggregationsStringTermsBucketKeys` [interface-AggregationsStringTermsBucketKeys] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsSumAggregate.md b/docs/reference/api/AggregationsSumAggregate.md index e2f467d2a..fa86046bd 100644 --- a/docs/reference/api/AggregationsSumAggregate.md +++ b/docs/reference/api/AggregationsSumAggregate.md @@ -1,4 +1,4 @@ -## Interface `AggregationsSumAggregate` +# `AggregationsSumAggregate` [interface-AggregationsSumAggregate] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsSumAggregation.md b/docs/reference/api/AggregationsSumAggregation.md index 8d05bc452..10b2100b0 100644 --- a/docs/reference/api/AggregationsSumAggregation.md +++ b/docs/reference/api/AggregationsSumAggregation.md @@ -1,4 +1,4 @@ -## Interface `AggregationsSumAggregation` +# `AggregationsSumAggregation` [interface-AggregationsSumAggregation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsSumBucketAggregation.md b/docs/reference/api/AggregationsSumBucketAggregation.md index 6d744b20e..40c4a4060 100644 --- a/docs/reference/api/AggregationsSumBucketAggregation.md +++ b/docs/reference/api/AggregationsSumBucketAggregation.md @@ -1,4 +1,4 @@ -## Interface `AggregationsSumBucketAggregation` +# `AggregationsSumBucketAggregation` [interface-AggregationsSumBucketAggregation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsTDigest.md b/docs/reference/api/AggregationsTDigest.md index 387a2ff69..7ef643868 100644 --- a/docs/reference/api/AggregationsTDigest.md +++ b/docs/reference/api/AggregationsTDigest.md @@ -1,4 +1,4 @@ -## Interface `AggregationsTDigest` +# `AggregationsTDigest` [interface-AggregationsTDigest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsTDigestPercentileRanksAggregate.md b/docs/reference/api/AggregationsTDigestPercentileRanksAggregate.md index a8bd60bfb..8b5eedafc 100644 --- a/docs/reference/api/AggregationsTDigestPercentileRanksAggregate.md +++ b/docs/reference/api/AggregationsTDigestPercentileRanksAggregate.md @@ -1,4 +1,4 @@ -## Interface `AggregationsTDigestPercentileRanksAggregate` +# `AggregationsTDigestPercentileRanksAggregate` [interface-AggregationsTDigestPercentileRanksAggregate] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsTDigestPercentilesAggregate.md b/docs/reference/api/AggregationsTDigestPercentilesAggregate.md index 403edd265..b4e3e0d75 100644 --- a/docs/reference/api/AggregationsTDigestPercentilesAggregate.md +++ b/docs/reference/api/AggregationsTDigestPercentilesAggregate.md @@ -1,4 +1,4 @@ -## Interface `AggregationsTDigestPercentilesAggregate` +# `AggregationsTDigestPercentilesAggregate` [interface-AggregationsTDigestPercentilesAggregate] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsTTestAggregate.md b/docs/reference/api/AggregationsTTestAggregate.md index e3405eea0..877116f09 100644 --- a/docs/reference/api/AggregationsTTestAggregate.md +++ b/docs/reference/api/AggregationsTTestAggregate.md @@ -1,4 +1,4 @@ -## Interface `AggregationsTTestAggregate` +# `AggregationsTTestAggregate` [interface-AggregationsTTestAggregate] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsTTestAggregation.md b/docs/reference/api/AggregationsTTestAggregation.md index 480b2432d..b5d31a027 100644 --- a/docs/reference/api/AggregationsTTestAggregation.md +++ b/docs/reference/api/AggregationsTTestAggregation.md @@ -1,4 +1,4 @@ -## Interface `AggregationsTTestAggregation` +# `AggregationsTTestAggregation` [interface-AggregationsTTestAggregation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsTTestType.md b/docs/reference/api/AggregationsTTestType.md index 416c82a29..e27fbdcbe 100644 --- a/docs/reference/api/AggregationsTTestType.md +++ b/docs/reference/api/AggregationsTTestType.md @@ -1,4 +1,4 @@ -## `AggregationsTTestType` -::: +# `AggregationsTTestType` [alias-AggregationsTTestType] +```typescript type AggregationsTTestType = 'paired' | 'homoscedastic' | 'heteroscedastic'; -::: +``` diff --git a/docs/reference/api/AggregationsTermsAggregateBase.md b/docs/reference/api/AggregationsTermsAggregateBase.md index 7554576d1..52983c54f 100644 --- a/docs/reference/api/AggregationsTermsAggregateBase.md +++ b/docs/reference/api/AggregationsTermsAggregateBase.md @@ -1,4 +1,4 @@ -## Interface `AggregationsTermsAggregateBase` +# `AggregationsTermsAggregateBase` [interface-AggregationsTermsAggregateBase] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsTermsAggregation.md b/docs/reference/api/AggregationsTermsAggregation.md index 64befaff6..fc509d816 100644 --- a/docs/reference/api/AggregationsTermsAggregation.md +++ b/docs/reference/api/AggregationsTermsAggregation.md @@ -1,4 +1,4 @@ -## Interface `AggregationsTermsAggregation` +# `AggregationsTermsAggregation` [interface-AggregationsTermsAggregation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsTermsAggregationCollectMode.md b/docs/reference/api/AggregationsTermsAggregationCollectMode.md index d1fb8c5b3..a33516649 100644 --- a/docs/reference/api/AggregationsTermsAggregationCollectMode.md +++ b/docs/reference/api/AggregationsTermsAggregationCollectMode.md @@ -1,4 +1,4 @@ -## `AggregationsTermsAggregationCollectMode` -::: +# `AggregationsTermsAggregationCollectMode` [alias-AggregationsTermsAggregationCollectMode] +```typescript type AggregationsTermsAggregationCollectMode = 'depth_first' | 'breadth_first'; -::: +``` diff --git a/docs/reference/api/AggregationsTermsAggregationExecutionHint.md b/docs/reference/api/AggregationsTermsAggregationExecutionHint.md index b6b010c3d..3b4e3926d 100644 --- a/docs/reference/api/AggregationsTermsAggregationExecutionHint.md +++ b/docs/reference/api/AggregationsTermsAggregationExecutionHint.md @@ -1,4 +1,4 @@ -## `AggregationsTermsAggregationExecutionHint` -::: +# `AggregationsTermsAggregationExecutionHint` [alias-AggregationsTermsAggregationExecutionHint] +```typescript type AggregationsTermsAggregationExecutionHint = 'map' | 'global_ordinals' | 'global_ordinals_hash' | 'global_ordinals_low_cardinality'; -::: +``` diff --git a/docs/reference/api/AggregationsTermsBucketBase.md b/docs/reference/api/AggregationsTermsBucketBase.md index 05e0621bb..5dad48ad2 100644 --- a/docs/reference/api/AggregationsTermsBucketBase.md +++ b/docs/reference/api/AggregationsTermsBucketBase.md @@ -1,4 +1,4 @@ -## Interface `AggregationsTermsBucketBase` +# `AggregationsTermsBucketBase` [interface-AggregationsTermsBucketBase] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsTermsExclude.md b/docs/reference/api/AggregationsTermsExclude.md index b66c3b563..f819f61ec 100644 --- a/docs/reference/api/AggregationsTermsExclude.md +++ b/docs/reference/api/AggregationsTermsExclude.md @@ -1,4 +1,4 @@ -## `AggregationsTermsExclude` -::: +# `AggregationsTermsExclude` [alias-AggregationsTermsExclude] +```typescript type AggregationsTermsExclude = string | string[]; -::: +``` diff --git a/docs/reference/api/AggregationsTermsInclude.md b/docs/reference/api/AggregationsTermsInclude.md index 487aafe49..a5b8f583e 100644 --- a/docs/reference/api/AggregationsTermsInclude.md +++ b/docs/reference/api/AggregationsTermsInclude.md @@ -1,4 +1,4 @@ -## `AggregationsTermsInclude` -::: +# `AggregationsTermsInclude` [alias-AggregationsTermsInclude] +```typescript type AggregationsTermsInclude = string | string[] | [AggregationsTermsPartition](./AggregationsTermsPartition.md); -::: +``` diff --git a/docs/reference/api/AggregationsTermsPartition.md b/docs/reference/api/AggregationsTermsPartition.md index 3522943a6..3aad43a1d 100644 --- a/docs/reference/api/AggregationsTermsPartition.md +++ b/docs/reference/api/AggregationsTermsPartition.md @@ -1,4 +1,4 @@ -## Interface `AggregationsTermsPartition` +# `AggregationsTermsPartition` [interface-AggregationsTermsPartition] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsTestPopulation.md b/docs/reference/api/AggregationsTestPopulation.md index 1b5c6e3fc..6dc1a1eb3 100644 --- a/docs/reference/api/AggregationsTestPopulation.md +++ b/docs/reference/api/AggregationsTestPopulation.md @@ -1,4 +1,4 @@ -## Interface `AggregationsTestPopulation` +# `AggregationsTestPopulation` [interface-AggregationsTestPopulation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsTimeSeriesAggregate.md b/docs/reference/api/AggregationsTimeSeriesAggregate.md index 00df653d3..f6afcdc90 100644 --- a/docs/reference/api/AggregationsTimeSeriesAggregate.md +++ b/docs/reference/api/AggregationsTimeSeriesAggregate.md @@ -1,4 +1,4 @@ -## Interface `AggregationsTimeSeriesAggregate` +# `AggregationsTimeSeriesAggregate` [interface-AggregationsTimeSeriesAggregate] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsTimeSeriesAggregation.md b/docs/reference/api/AggregationsTimeSeriesAggregation.md index c3b98e4f0..453349b24 100644 --- a/docs/reference/api/AggregationsTimeSeriesAggregation.md +++ b/docs/reference/api/AggregationsTimeSeriesAggregation.md @@ -1,4 +1,4 @@ -## Interface `AggregationsTimeSeriesAggregation` +# `AggregationsTimeSeriesAggregation` [interface-AggregationsTimeSeriesAggregation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsTimeSeriesBucket.md b/docs/reference/api/AggregationsTimeSeriesBucket.md index 05e2b167e..9cd17c0e2 100644 --- a/docs/reference/api/AggregationsTimeSeriesBucket.md +++ b/docs/reference/api/AggregationsTimeSeriesBucket.md @@ -1,4 +1,4 @@ -## `AggregationsTimeSeriesBucket` -::: +# `AggregationsTimeSeriesBucket` [alias-AggregationsTimeSeriesBucket] +```typescript type AggregationsTimeSeriesBucket = [AggregationsTimeSeriesBucketKeys](./AggregationsTimeSeriesBucketKeys.md) & { [property: string]: [AggregationsAggregate](./AggregationsAggregate.md) | Record<[Field](./Field.md), [FieldValue](./FieldValue.md)> | [long](./long.md);}; -::: +``` diff --git a/docs/reference/api/AggregationsTimeSeriesBucketKeys.md b/docs/reference/api/AggregationsTimeSeriesBucketKeys.md index 267fb5062..bae4f65bd 100644 --- a/docs/reference/api/AggregationsTimeSeriesBucketKeys.md +++ b/docs/reference/api/AggregationsTimeSeriesBucketKeys.md @@ -1,4 +1,4 @@ -## Interface `AggregationsTimeSeriesBucketKeys` +# `AggregationsTimeSeriesBucketKeys` [interface-AggregationsTimeSeriesBucketKeys] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsTopHitsAggregate.md b/docs/reference/api/AggregationsTopHitsAggregate.md index 9e9e0646a..3d153311a 100644 --- a/docs/reference/api/AggregationsTopHitsAggregate.md +++ b/docs/reference/api/AggregationsTopHitsAggregate.md @@ -1,4 +1,4 @@ -## Interface `AggregationsTopHitsAggregate` +# `AggregationsTopHitsAggregate` [interface-AggregationsTopHitsAggregate] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsTopHitsAggregation.md b/docs/reference/api/AggregationsTopHitsAggregation.md index b84aba351..cd715ce59 100644 --- a/docs/reference/api/AggregationsTopHitsAggregation.md +++ b/docs/reference/api/AggregationsTopHitsAggregation.md @@ -1,4 +1,4 @@ -## Interface `AggregationsTopHitsAggregation` +# `AggregationsTopHitsAggregation` [interface-AggregationsTopHitsAggregation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsTopMetrics.md b/docs/reference/api/AggregationsTopMetrics.md index 7b2edfd60..9a15f579a 100644 --- a/docs/reference/api/AggregationsTopMetrics.md +++ b/docs/reference/api/AggregationsTopMetrics.md @@ -1,4 +1,4 @@ -## Interface `AggregationsTopMetrics` +# `AggregationsTopMetrics` [interface-AggregationsTopMetrics] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsTopMetricsAggregate.md b/docs/reference/api/AggregationsTopMetricsAggregate.md index 01f0c51e6..ebdc107ee 100644 --- a/docs/reference/api/AggregationsTopMetricsAggregate.md +++ b/docs/reference/api/AggregationsTopMetricsAggregate.md @@ -1,4 +1,4 @@ -## Interface `AggregationsTopMetricsAggregate` +# `AggregationsTopMetricsAggregate` [interface-AggregationsTopMetricsAggregate] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsTopMetricsAggregation.md b/docs/reference/api/AggregationsTopMetricsAggregation.md index f1588f49c..086272b5d 100644 --- a/docs/reference/api/AggregationsTopMetricsAggregation.md +++ b/docs/reference/api/AggregationsTopMetricsAggregation.md @@ -1,4 +1,4 @@ -## Interface `AggregationsTopMetricsAggregation` +# `AggregationsTopMetricsAggregation` [interface-AggregationsTopMetricsAggregation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsTopMetricsValue.md b/docs/reference/api/AggregationsTopMetricsValue.md index 45144600a..a843410ff 100644 --- a/docs/reference/api/AggregationsTopMetricsValue.md +++ b/docs/reference/api/AggregationsTopMetricsValue.md @@ -1,4 +1,4 @@ -## Interface `AggregationsTopMetricsValue` +# `AggregationsTopMetricsValue` [interface-AggregationsTopMetricsValue] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsUnmappedRareTermsAggregate.md b/docs/reference/api/AggregationsUnmappedRareTermsAggregate.md index db9cdfd5d..a533feda0 100644 --- a/docs/reference/api/AggregationsUnmappedRareTermsAggregate.md +++ b/docs/reference/api/AggregationsUnmappedRareTermsAggregate.md @@ -1,4 +1,4 @@ -## Interface `AggregationsUnmappedRareTermsAggregate` +# `AggregationsUnmappedRareTermsAggregate` [interface-AggregationsUnmappedRareTermsAggregate] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsUnmappedSamplerAggregate.md b/docs/reference/api/AggregationsUnmappedSamplerAggregate.md index 63492b647..d895493b5 100644 --- a/docs/reference/api/AggregationsUnmappedSamplerAggregate.md +++ b/docs/reference/api/AggregationsUnmappedSamplerAggregate.md @@ -1,4 +1,4 @@ -## `AggregationsUnmappedSamplerAggregate` -::: +# `AggregationsUnmappedSamplerAggregate` [alias-AggregationsUnmappedSamplerAggregate] +```typescript type AggregationsUnmappedSamplerAggregate = [AggregationsUnmappedSamplerAggregateKeys](./AggregationsUnmappedSamplerAggregateKeys.md) & { [property: string]: [AggregationsAggregate](./AggregationsAggregate.md) | [long](./long.md) | [Metadata](./Metadata.md);}; -::: +``` diff --git a/docs/reference/api/AggregationsUnmappedSamplerAggregateKeys.md b/docs/reference/api/AggregationsUnmappedSamplerAggregateKeys.md index 44485597a..4c0f19860 100644 --- a/docs/reference/api/AggregationsUnmappedSamplerAggregateKeys.md +++ b/docs/reference/api/AggregationsUnmappedSamplerAggregateKeys.md @@ -1,4 +1,4 @@ -## Interface `AggregationsUnmappedSamplerAggregateKeys` +# `AggregationsUnmappedSamplerAggregateKeys` [interface-AggregationsUnmappedSamplerAggregateKeys] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsUnmappedSignificantTermsAggregate.md b/docs/reference/api/AggregationsUnmappedSignificantTermsAggregate.md index c3745b65b..8ef425e0c 100644 --- a/docs/reference/api/AggregationsUnmappedSignificantTermsAggregate.md +++ b/docs/reference/api/AggregationsUnmappedSignificantTermsAggregate.md @@ -1,4 +1,4 @@ -## Interface `AggregationsUnmappedSignificantTermsAggregate` +# `AggregationsUnmappedSignificantTermsAggregate` [interface-AggregationsUnmappedSignificantTermsAggregate] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsUnmappedTermsAggregate.md b/docs/reference/api/AggregationsUnmappedTermsAggregate.md index a3a35f0f2..df2c1bbb0 100644 --- a/docs/reference/api/AggregationsUnmappedTermsAggregate.md +++ b/docs/reference/api/AggregationsUnmappedTermsAggregate.md @@ -1,4 +1,4 @@ -## Interface `AggregationsUnmappedTermsAggregate` +# `AggregationsUnmappedTermsAggregate` [interface-AggregationsUnmappedTermsAggregate] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsValueCountAggregate.md b/docs/reference/api/AggregationsValueCountAggregate.md index da6f8ef57..9c5dbec53 100644 --- a/docs/reference/api/AggregationsValueCountAggregate.md +++ b/docs/reference/api/AggregationsValueCountAggregate.md @@ -1,4 +1,4 @@ -## Interface `AggregationsValueCountAggregate` +# `AggregationsValueCountAggregate` [interface-AggregationsValueCountAggregate] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsValueCountAggregation.md b/docs/reference/api/AggregationsValueCountAggregation.md index 7c41921db..e197ead31 100644 --- a/docs/reference/api/AggregationsValueCountAggregation.md +++ b/docs/reference/api/AggregationsValueCountAggregation.md @@ -1,4 +1,4 @@ -## Interface `AggregationsValueCountAggregation` +# `AggregationsValueCountAggregation` [interface-AggregationsValueCountAggregation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsValueType.md b/docs/reference/api/AggregationsValueType.md index 1bec330ad..ad77a0d89 100644 --- a/docs/reference/api/AggregationsValueType.md +++ b/docs/reference/api/AggregationsValueType.md @@ -1,4 +1,4 @@ -## `AggregationsValueType` -::: +# `AggregationsValueType` [alias-AggregationsValueType] +```typescript type AggregationsValueType = 'string' | 'long' | 'double' | 'number' | 'date' | 'date_nanos' | 'ip' | 'numeric' | 'geo_point' | 'boolean'; -::: +``` diff --git a/docs/reference/api/AggregationsVariableWidthHistogramAggregate.md b/docs/reference/api/AggregationsVariableWidthHistogramAggregate.md index 2399c8e4f..b0c8b4955 100644 --- a/docs/reference/api/AggregationsVariableWidthHistogramAggregate.md +++ b/docs/reference/api/AggregationsVariableWidthHistogramAggregate.md @@ -1,4 +1,4 @@ -## Interface `AggregationsVariableWidthHistogramAggregate` +# `AggregationsVariableWidthHistogramAggregate` [interface-AggregationsVariableWidthHistogramAggregate] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsVariableWidthHistogramAggregation.md b/docs/reference/api/AggregationsVariableWidthHistogramAggregation.md index 8bc802341..d1f5e5baa 100644 --- a/docs/reference/api/AggregationsVariableWidthHistogramAggregation.md +++ b/docs/reference/api/AggregationsVariableWidthHistogramAggregation.md @@ -1,4 +1,4 @@ -## Interface `AggregationsVariableWidthHistogramAggregation` +# `AggregationsVariableWidthHistogramAggregation` [interface-AggregationsVariableWidthHistogramAggregation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsVariableWidthHistogramBucket.md b/docs/reference/api/AggregationsVariableWidthHistogramBucket.md index f4a2531bf..c8956b5be 100644 --- a/docs/reference/api/AggregationsVariableWidthHistogramBucket.md +++ b/docs/reference/api/AggregationsVariableWidthHistogramBucket.md @@ -1,4 +1,4 @@ -## `AggregationsVariableWidthHistogramBucket` -::: +# `AggregationsVariableWidthHistogramBucket` [alias-AggregationsVariableWidthHistogramBucket] +```typescript type AggregationsVariableWidthHistogramBucket = [AggregationsVariableWidthHistogramBucketKeys](./AggregationsVariableWidthHistogramBucketKeys.md) & { [property: string]: [AggregationsAggregate](./AggregationsAggregate.md) | [double](./double.md) | string | [long](./long.md);}; -::: +``` diff --git a/docs/reference/api/AggregationsVariableWidthHistogramBucketKeys.md b/docs/reference/api/AggregationsVariableWidthHistogramBucketKeys.md index bc5686aad..23836a735 100644 --- a/docs/reference/api/AggregationsVariableWidthHistogramBucketKeys.md +++ b/docs/reference/api/AggregationsVariableWidthHistogramBucketKeys.md @@ -1,4 +1,4 @@ -## Interface `AggregationsVariableWidthHistogramBucketKeys` +# `AggregationsVariableWidthHistogramBucketKeys` [interface-AggregationsVariableWidthHistogramBucketKeys] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsWeightedAverageAggregation.md b/docs/reference/api/AggregationsWeightedAverageAggregation.md index 454789266..512aec1c7 100644 --- a/docs/reference/api/AggregationsWeightedAverageAggregation.md +++ b/docs/reference/api/AggregationsWeightedAverageAggregation.md @@ -1,4 +1,4 @@ -## Interface `AggregationsWeightedAverageAggregation` +# `AggregationsWeightedAverageAggregation` [interface-AggregationsWeightedAverageAggregation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsWeightedAverageValue.md b/docs/reference/api/AggregationsWeightedAverageValue.md index 2265fa4df..e6ad0f72a 100644 --- a/docs/reference/api/AggregationsWeightedAverageValue.md +++ b/docs/reference/api/AggregationsWeightedAverageValue.md @@ -1,4 +1,4 @@ -## Interface `AggregationsWeightedAverageValue` +# `AggregationsWeightedAverageValue` [interface-AggregationsWeightedAverageValue] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AggregationsWeightedAvgAggregate.md b/docs/reference/api/AggregationsWeightedAvgAggregate.md index 0090f2b64..672388208 100644 --- a/docs/reference/api/AggregationsWeightedAvgAggregate.md +++ b/docs/reference/api/AggregationsWeightedAvgAggregate.md @@ -1,4 +1,4 @@ -## Interface `AggregationsWeightedAvgAggregate` +# `AggregationsWeightedAvgAggregate` [interface-AggregationsWeightedAvgAggregate] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisAnalyzer.md b/docs/reference/api/AnalysisAnalyzer.md index 44cfe1d35..c532fd7ff 100644 --- a/docs/reference/api/AnalysisAnalyzer.md +++ b/docs/reference/api/AnalysisAnalyzer.md @@ -1,4 +1,4 @@ -## `AnalysisAnalyzer` -::: +# `AnalysisAnalyzer` [alias-AnalysisAnalyzer] +```typescript type AnalysisAnalyzer = [AnalysisCustomAnalyzer](./AnalysisCustomAnalyzer.md) | [AnalysisFingerprintAnalyzer](./AnalysisFingerprintAnalyzer.md) | [AnalysisKeywordAnalyzer](./AnalysisKeywordAnalyzer.md) | [AnalysisNoriAnalyzer](./AnalysisNoriAnalyzer.md) | [AnalysisPatternAnalyzer](./AnalysisPatternAnalyzer.md) | [AnalysisSimpleAnalyzer](./AnalysisSimpleAnalyzer.md) | [AnalysisStandardAnalyzer](./AnalysisStandardAnalyzer.md) | [AnalysisStopAnalyzer](./AnalysisStopAnalyzer.md) | [AnalysisWhitespaceAnalyzer](./AnalysisWhitespaceAnalyzer.md) | [AnalysisIcuAnalyzer](./AnalysisIcuAnalyzer.md) | [AnalysisKuromojiAnalyzer](./AnalysisKuromojiAnalyzer.md) | [AnalysisSnowballAnalyzer](./AnalysisSnowballAnalyzer.md) | [AnalysisArabicAnalyzer](./AnalysisArabicAnalyzer.md) | [AnalysisArmenianAnalyzer](./AnalysisArmenianAnalyzer.md) | [AnalysisBasqueAnalyzer](./AnalysisBasqueAnalyzer.md) | [AnalysisBengaliAnalyzer](./AnalysisBengaliAnalyzer.md) | [AnalysisBrazilianAnalyzer](./AnalysisBrazilianAnalyzer.md) | [AnalysisBulgarianAnalyzer](./AnalysisBulgarianAnalyzer.md) | [AnalysisCatalanAnalyzer](./AnalysisCatalanAnalyzer.md) | [AnalysisChineseAnalyzer](./AnalysisChineseAnalyzer.md) | [AnalysisCjkAnalyzer](./AnalysisCjkAnalyzer.md) | [AnalysisCzechAnalyzer](./AnalysisCzechAnalyzer.md) | [AnalysisDanishAnalyzer](./AnalysisDanishAnalyzer.md) | [AnalysisDutchAnalyzer](./AnalysisDutchAnalyzer.md) | [AnalysisEnglishAnalyzer](./AnalysisEnglishAnalyzer.md) | [AnalysisEstonianAnalyzer](./AnalysisEstonianAnalyzer.md) | [AnalysisFinnishAnalyzer](./AnalysisFinnishAnalyzer.md) | [AnalysisFrenchAnalyzer](./AnalysisFrenchAnalyzer.md) | [AnalysisGalicianAnalyzer](./AnalysisGalicianAnalyzer.md) | [AnalysisGermanAnalyzer](./AnalysisGermanAnalyzer.md) | [AnalysisGreekAnalyzer](./AnalysisGreekAnalyzer.md) | [AnalysisHindiAnalyzer](./AnalysisHindiAnalyzer.md) | [AnalysisHungarianAnalyzer](./AnalysisHungarianAnalyzer.md) | [AnalysisIndonesianAnalyzer](./AnalysisIndonesianAnalyzer.md) | [AnalysisIrishAnalyzer](./AnalysisIrishAnalyzer.md) | [AnalysisItalianAnalyzer](./AnalysisItalianAnalyzer.md) | [AnalysisLatvianAnalyzer](./AnalysisLatvianAnalyzer.md) | [AnalysisLithuanianAnalyzer](./AnalysisLithuanianAnalyzer.md) | [AnalysisNorwegianAnalyzer](./AnalysisNorwegianAnalyzer.md) | [AnalysisPersianAnalyzer](./AnalysisPersianAnalyzer.md) | [AnalysisPortugueseAnalyzer](./AnalysisPortugueseAnalyzer.md) | [AnalysisRomanianAnalyzer](./AnalysisRomanianAnalyzer.md) | [AnalysisRussianAnalyzer](./AnalysisRussianAnalyzer.md) | [AnalysisSerbianAnalyzer](./AnalysisSerbianAnalyzer.md) | [AnalysisSoraniAnalyzer](./AnalysisSoraniAnalyzer.md) | [AnalysisSpanishAnalyzer](./AnalysisSpanishAnalyzer.md) | [AnalysisSwedishAnalyzer](./AnalysisSwedishAnalyzer.md) | [AnalysisTurkishAnalyzer](./AnalysisTurkishAnalyzer.md) | [AnalysisThaiAnalyzer](./AnalysisThaiAnalyzer.md); -::: +``` diff --git a/docs/reference/api/AnalysisApostropheTokenFilter.md b/docs/reference/api/AnalysisApostropheTokenFilter.md index 136bb00c4..644d291e0 100644 --- a/docs/reference/api/AnalysisApostropheTokenFilter.md +++ b/docs/reference/api/AnalysisApostropheTokenFilter.md @@ -1,4 +1,4 @@ -## Interface `AnalysisApostropheTokenFilter` +# `AnalysisApostropheTokenFilter` [interface-AnalysisApostropheTokenFilter] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisArabicAnalyzer.md b/docs/reference/api/AnalysisArabicAnalyzer.md index 4e5c78751..66fb59a0b 100644 --- a/docs/reference/api/AnalysisArabicAnalyzer.md +++ b/docs/reference/api/AnalysisArabicAnalyzer.md @@ -1,4 +1,4 @@ -## Interface `AnalysisArabicAnalyzer` +# `AnalysisArabicAnalyzer` [interface-AnalysisArabicAnalyzer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisArabicNormalizationTokenFilter.md b/docs/reference/api/AnalysisArabicNormalizationTokenFilter.md index bde929a63..e866502f9 100644 --- a/docs/reference/api/AnalysisArabicNormalizationTokenFilter.md +++ b/docs/reference/api/AnalysisArabicNormalizationTokenFilter.md @@ -1,4 +1,4 @@ -## Interface `AnalysisArabicNormalizationTokenFilter` +# `AnalysisArabicNormalizationTokenFilter` [interface-AnalysisArabicNormalizationTokenFilter] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisArmenianAnalyzer.md b/docs/reference/api/AnalysisArmenianAnalyzer.md index f02e7e5f6..d3d6cc74f 100644 --- a/docs/reference/api/AnalysisArmenianAnalyzer.md +++ b/docs/reference/api/AnalysisArmenianAnalyzer.md @@ -1,4 +1,4 @@ -## Interface `AnalysisArmenianAnalyzer` +# `AnalysisArmenianAnalyzer` [interface-AnalysisArmenianAnalyzer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisAsciiFoldingTokenFilter.md b/docs/reference/api/AnalysisAsciiFoldingTokenFilter.md index 87c1c7719..921b7f0c2 100644 --- a/docs/reference/api/AnalysisAsciiFoldingTokenFilter.md +++ b/docs/reference/api/AnalysisAsciiFoldingTokenFilter.md @@ -1,4 +1,4 @@ -## Interface `AnalysisAsciiFoldingTokenFilter` +# `AnalysisAsciiFoldingTokenFilter` [interface-AnalysisAsciiFoldingTokenFilter] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisBasqueAnalyzer.md b/docs/reference/api/AnalysisBasqueAnalyzer.md index 6b03d2aa6..3d4c1ef82 100644 --- a/docs/reference/api/AnalysisBasqueAnalyzer.md +++ b/docs/reference/api/AnalysisBasqueAnalyzer.md @@ -1,4 +1,4 @@ -## Interface `AnalysisBasqueAnalyzer` +# `AnalysisBasqueAnalyzer` [interface-AnalysisBasqueAnalyzer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisBengaliAnalyzer.md b/docs/reference/api/AnalysisBengaliAnalyzer.md index cc0922ba4..656336942 100644 --- a/docs/reference/api/AnalysisBengaliAnalyzer.md +++ b/docs/reference/api/AnalysisBengaliAnalyzer.md @@ -1,4 +1,4 @@ -## Interface `AnalysisBengaliAnalyzer` +# `AnalysisBengaliAnalyzer` [interface-AnalysisBengaliAnalyzer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisBrazilianAnalyzer.md b/docs/reference/api/AnalysisBrazilianAnalyzer.md index a58c347de..a0850f381 100644 --- a/docs/reference/api/AnalysisBrazilianAnalyzer.md +++ b/docs/reference/api/AnalysisBrazilianAnalyzer.md @@ -1,4 +1,4 @@ -## Interface `AnalysisBrazilianAnalyzer` +# `AnalysisBrazilianAnalyzer` [interface-AnalysisBrazilianAnalyzer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisBulgarianAnalyzer.md b/docs/reference/api/AnalysisBulgarianAnalyzer.md index fb1e1db38..e5710cb6d 100644 --- a/docs/reference/api/AnalysisBulgarianAnalyzer.md +++ b/docs/reference/api/AnalysisBulgarianAnalyzer.md @@ -1,4 +1,4 @@ -## Interface `AnalysisBulgarianAnalyzer` +# `AnalysisBulgarianAnalyzer` [interface-AnalysisBulgarianAnalyzer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisCatalanAnalyzer.md b/docs/reference/api/AnalysisCatalanAnalyzer.md index ccb1dfe84..f159ecbd7 100644 --- a/docs/reference/api/AnalysisCatalanAnalyzer.md +++ b/docs/reference/api/AnalysisCatalanAnalyzer.md @@ -1,4 +1,4 @@ -## Interface `AnalysisCatalanAnalyzer` +# `AnalysisCatalanAnalyzer` [interface-AnalysisCatalanAnalyzer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisCharFilter.md b/docs/reference/api/AnalysisCharFilter.md index 93ebeaf90..01aa48f46 100644 --- a/docs/reference/api/AnalysisCharFilter.md +++ b/docs/reference/api/AnalysisCharFilter.md @@ -1,4 +1,4 @@ -## `AnalysisCharFilter` -::: +# `AnalysisCharFilter` [alias-AnalysisCharFilter] +```typescript type AnalysisCharFilter = string | [AnalysisCharFilterDefinition](./AnalysisCharFilterDefinition.md); -::: +``` diff --git a/docs/reference/api/AnalysisCharFilterBase.md b/docs/reference/api/AnalysisCharFilterBase.md index 0652f823b..5894caa0e 100644 --- a/docs/reference/api/AnalysisCharFilterBase.md +++ b/docs/reference/api/AnalysisCharFilterBase.md @@ -1,4 +1,4 @@ -## Interface `AnalysisCharFilterBase` +# `AnalysisCharFilterBase` [interface-AnalysisCharFilterBase] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisCharFilterDefinition.md b/docs/reference/api/AnalysisCharFilterDefinition.md index 744ec7c49..f903e3e4d 100644 --- a/docs/reference/api/AnalysisCharFilterDefinition.md +++ b/docs/reference/api/AnalysisCharFilterDefinition.md @@ -1,4 +1,4 @@ -## `AnalysisCharFilterDefinition` -::: +# `AnalysisCharFilterDefinition` [alias-AnalysisCharFilterDefinition] +```typescript type AnalysisCharFilterDefinition = [AnalysisHtmlStripCharFilter](./AnalysisHtmlStripCharFilter.md) | [AnalysisMappingCharFilter](./AnalysisMappingCharFilter.md) | [AnalysisPatternReplaceCharFilter](./AnalysisPatternReplaceCharFilter.md) | [AnalysisIcuNormalizationCharFilter](./AnalysisIcuNormalizationCharFilter.md) | [AnalysisKuromojiIterationMarkCharFilter](./AnalysisKuromojiIterationMarkCharFilter.md); -::: +``` diff --git a/docs/reference/api/AnalysisCharGroupTokenizer.md b/docs/reference/api/AnalysisCharGroupTokenizer.md index e81d1eb02..3feaf4393 100644 --- a/docs/reference/api/AnalysisCharGroupTokenizer.md +++ b/docs/reference/api/AnalysisCharGroupTokenizer.md @@ -1,4 +1,4 @@ -## Interface `AnalysisCharGroupTokenizer` +# `AnalysisCharGroupTokenizer` [interface-AnalysisCharGroupTokenizer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisChineseAnalyzer.md b/docs/reference/api/AnalysisChineseAnalyzer.md index dee52e6f0..e03983d54 100644 --- a/docs/reference/api/AnalysisChineseAnalyzer.md +++ b/docs/reference/api/AnalysisChineseAnalyzer.md @@ -1,4 +1,4 @@ -## Interface `AnalysisChineseAnalyzer` +# `AnalysisChineseAnalyzer` [interface-AnalysisChineseAnalyzer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisCjkAnalyzer.md b/docs/reference/api/AnalysisCjkAnalyzer.md index 7399afb69..69087bd7e 100644 --- a/docs/reference/api/AnalysisCjkAnalyzer.md +++ b/docs/reference/api/AnalysisCjkAnalyzer.md @@ -1,4 +1,4 @@ -## Interface `AnalysisCjkAnalyzer` +# `AnalysisCjkAnalyzer` [interface-AnalysisCjkAnalyzer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisCjkBigramIgnoredScript.md b/docs/reference/api/AnalysisCjkBigramIgnoredScript.md index 89238454e..b0c842a3d 100644 --- a/docs/reference/api/AnalysisCjkBigramIgnoredScript.md +++ b/docs/reference/api/AnalysisCjkBigramIgnoredScript.md @@ -1,4 +1,4 @@ -## `AnalysisCjkBigramIgnoredScript` -::: +# `AnalysisCjkBigramIgnoredScript` [alias-AnalysisCjkBigramIgnoredScript] +```typescript type AnalysisCjkBigramIgnoredScript = 'han' | 'hangul' | 'hiragana' | 'katakana'; -::: +``` diff --git a/docs/reference/api/AnalysisCjkBigramTokenFilter.md b/docs/reference/api/AnalysisCjkBigramTokenFilter.md index 51aba3a1f..b812333dc 100644 --- a/docs/reference/api/AnalysisCjkBigramTokenFilter.md +++ b/docs/reference/api/AnalysisCjkBigramTokenFilter.md @@ -1,4 +1,4 @@ -## Interface `AnalysisCjkBigramTokenFilter` +# `AnalysisCjkBigramTokenFilter` [interface-AnalysisCjkBigramTokenFilter] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisCjkWidthTokenFilter.md b/docs/reference/api/AnalysisCjkWidthTokenFilter.md index fb632ee09..78013ab5d 100644 --- a/docs/reference/api/AnalysisCjkWidthTokenFilter.md +++ b/docs/reference/api/AnalysisCjkWidthTokenFilter.md @@ -1,4 +1,4 @@ -## Interface `AnalysisCjkWidthTokenFilter` +# `AnalysisCjkWidthTokenFilter` [interface-AnalysisCjkWidthTokenFilter] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisClassicTokenFilter.md b/docs/reference/api/AnalysisClassicTokenFilter.md index 3a23a3750..f64bf7dd1 100644 --- a/docs/reference/api/AnalysisClassicTokenFilter.md +++ b/docs/reference/api/AnalysisClassicTokenFilter.md @@ -1,4 +1,4 @@ -## Interface `AnalysisClassicTokenFilter` +# `AnalysisClassicTokenFilter` [interface-AnalysisClassicTokenFilter] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisClassicTokenizer.md b/docs/reference/api/AnalysisClassicTokenizer.md index ead51f034..59fb53697 100644 --- a/docs/reference/api/AnalysisClassicTokenizer.md +++ b/docs/reference/api/AnalysisClassicTokenizer.md @@ -1,4 +1,4 @@ -## Interface `AnalysisClassicTokenizer` +# `AnalysisClassicTokenizer` [interface-AnalysisClassicTokenizer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisCommonGramsTokenFilter.md b/docs/reference/api/AnalysisCommonGramsTokenFilter.md index 553cb2ed4..bfaaba50e 100644 --- a/docs/reference/api/AnalysisCommonGramsTokenFilter.md +++ b/docs/reference/api/AnalysisCommonGramsTokenFilter.md @@ -1,4 +1,4 @@ -## Interface `AnalysisCommonGramsTokenFilter` +# `AnalysisCommonGramsTokenFilter` [interface-AnalysisCommonGramsTokenFilter] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisCompoundWordTokenFilterBase.md b/docs/reference/api/AnalysisCompoundWordTokenFilterBase.md index de8ab629a..584f20cc4 100644 --- a/docs/reference/api/AnalysisCompoundWordTokenFilterBase.md +++ b/docs/reference/api/AnalysisCompoundWordTokenFilterBase.md @@ -1,4 +1,4 @@ -## Interface `AnalysisCompoundWordTokenFilterBase` +# `AnalysisCompoundWordTokenFilterBase` [interface-AnalysisCompoundWordTokenFilterBase] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisConditionTokenFilter.md b/docs/reference/api/AnalysisConditionTokenFilter.md index 2a1c6b6e2..bf2d6d172 100644 --- a/docs/reference/api/AnalysisConditionTokenFilter.md +++ b/docs/reference/api/AnalysisConditionTokenFilter.md @@ -1,4 +1,4 @@ -## Interface `AnalysisConditionTokenFilter` +# `AnalysisConditionTokenFilter` [interface-AnalysisConditionTokenFilter] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisCustomAnalyzer.md b/docs/reference/api/AnalysisCustomAnalyzer.md index e00dfdb21..8d03cbd0e 100644 --- a/docs/reference/api/AnalysisCustomAnalyzer.md +++ b/docs/reference/api/AnalysisCustomAnalyzer.md @@ -1,4 +1,4 @@ -## Interface `AnalysisCustomAnalyzer` +# `AnalysisCustomAnalyzer` [interface-AnalysisCustomAnalyzer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisCustomNormalizer.md b/docs/reference/api/AnalysisCustomNormalizer.md index ee6582a64..7657023f9 100644 --- a/docs/reference/api/AnalysisCustomNormalizer.md +++ b/docs/reference/api/AnalysisCustomNormalizer.md @@ -1,4 +1,4 @@ -## Interface `AnalysisCustomNormalizer` +# `AnalysisCustomNormalizer` [interface-AnalysisCustomNormalizer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisCzechAnalyzer.md b/docs/reference/api/AnalysisCzechAnalyzer.md index daf3a569f..e75097959 100644 --- a/docs/reference/api/AnalysisCzechAnalyzer.md +++ b/docs/reference/api/AnalysisCzechAnalyzer.md @@ -1,4 +1,4 @@ -## Interface `AnalysisCzechAnalyzer` +# `AnalysisCzechAnalyzer` [interface-AnalysisCzechAnalyzer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisDanishAnalyzer.md b/docs/reference/api/AnalysisDanishAnalyzer.md index d3441ed2b..728934b08 100644 --- a/docs/reference/api/AnalysisDanishAnalyzer.md +++ b/docs/reference/api/AnalysisDanishAnalyzer.md @@ -1,4 +1,4 @@ -## Interface `AnalysisDanishAnalyzer` +# `AnalysisDanishAnalyzer` [interface-AnalysisDanishAnalyzer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisDecimalDigitTokenFilter.md b/docs/reference/api/AnalysisDecimalDigitTokenFilter.md index f320eb325..8259736da 100644 --- a/docs/reference/api/AnalysisDecimalDigitTokenFilter.md +++ b/docs/reference/api/AnalysisDecimalDigitTokenFilter.md @@ -1,4 +1,4 @@ -## Interface `AnalysisDecimalDigitTokenFilter` +# `AnalysisDecimalDigitTokenFilter` [interface-AnalysisDecimalDigitTokenFilter] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisDelimitedPayloadEncoding.md b/docs/reference/api/AnalysisDelimitedPayloadEncoding.md index 962d44ca3..a2890bf4e 100644 --- a/docs/reference/api/AnalysisDelimitedPayloadEncoding.md +++ b/docs/reference/api/AnalysisDelimitedPayloadEncoding.md @@ -1,4 +1,4 @@ -## `AnalysisDelimitedPayloadEncoding` -::: +# `AnalysisDelimitedPayloadEncoding` [alias-AnalysisDelimitedPayloadEncoding] +```typescript type AnalysisDelimitedPayloadEncoding = 'int' | 'float' | 'identity'; -::: +``` diff --git a/docs/reference/api/AnalysisDelimitedPayloadTokenFilter.md b/docs/reference/api/AnalysisDelimitedPayloadTokenFilter.md index 1d9db166e..e2176a388 100644 --- a/docs/reference/api/AnalysisDelimitedPayloadTokenFilter.md +++ b/docs/reference/api/AnalysisDelimitedPayloadTokenFilter.md @@ -1,4 +1,4 @@ -## Interface `AnalysisDelimitedPayloadTokenFilter` +# `AnalysisDelimitedPayloadTokenFilter` [interface-AnalysisDelimitedPayloadTokenFilter] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisDictionaryDecompounderTokenFilter.md b/docs/reference/api/AnalysisDictionaryDecompounderTokenFilter.md index 0d53fa720..d0caf5a89 100644 --- a/docs/reference/api/AnalysisDictionaryDecompounderTokenFilter.md +++ b/docs/reference/api/AnalysisDictionaryDecompounderTokenFilter.md @@ -1,4 +1,4 @@ -## Interface `AnalysisDictionaryDecompounderTokenFilter` +# `AnalysisDictionaryDecompounderTokenFilter` [interface-AnalysisDictionaryDecompounderTokenFilter] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisDutchAnalyzer.md b/docs/reference/api/AnalysisDutchAnalyzer.md index 8af2e56da..e0480a7c4 100644 --- a/docs/reference/api/AnalysisDutchAnalyzer.md +++ b/docs/reference/api/AnalysisDutchAnalyzer.md @@ -1,4 +1,4 @@ -## Interface `AnalysisDutchAnalyzer` +# `AnalysisDutchAnalyzer` [interface-AnalysisDutchAnalyzer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisEdgeNGramSide.md b/docs/reference/api/AnalysisEdgeNGramSide.md index 814218f99..4cc8847f2 100644 --- a/docs/reference/api/AnalysisEdgeNGramSide.md +++ b/docs/reference/api/AnalysisEdgeNGramSide.md @@ -1,4 +1,4 @@ -## `AnalysisEdgeNGramSide` -::: +# `AnalysisEdgeNGramSide` [alias-AnalysisEdgeNGramSide] +```typescript type AnalysisEdgeNGramSide = 'front' | 'back'; -::: +``` diff --git a/docs/reference/api/AnalysisEdgeNGramTokenFilter.md b/docs/reference/api/AnalysisEdgeNGramTokenFilter.md index 02ce3f671..d24283603 100644 --- a/docs/reference/api/AnalysisEdgeNGramTokenFilter.md +++ b/docs/reference/api/AnalysisEdgeNGramTokenFilter.md @@ -1,4 +1,4 @@ -## Interface `AnalysisEdgeNGramTokenFilter` +# `AnalysisEdgeNGramTokenFilter` [interface-AnalysisEdgeNGramTokenFilter] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisEdgeNGramTokenizer.md b/docs/reference/api/AnalysisEdgeNGramTokenizer.md index 3598cabd8..532d47c23 100644 --- a/docs/reference/api/AnalysisEdgeNGramTokenizer.md +++ b/docs/reference/api/AnalysisEdgeNGramTokenizer.md @@ -1,4 +1,4 @@ -## Interface `AnalysisEdgeNGramTokenizer` +# `AnalysisEdgeNGramTokenizer` [interface-AnalysisEdgeNGramTokenizer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisElisionTokenFilter.md b/docs/reference/api/AnalysisElisionTokenFilter.md index 0a08837e3..30e48f110 100644 --- a/docs/reference/api/AnalysisElisionTokenFilter.md +++ b/docs/reference/api/AnalysisElisionTokenFilter.md @@ -1,4 +1,4 @@ -## Interface `AnalysisElisionTokenFilter` +# `AnalysisElisionTokenFilter` [interface-AnalysisElisionTokenFilter] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisEnglishAnalyzer.md b/docs/reference/api/AnalysisEnglishAnalyzer.md index 1526aca3e..bd121220b 100644 --- a/docs/reference/api/AnalysisEnglishAnalyzer.md +++ b/docs/reference/api/AnalysisEnglishAnalyzer.md @@ -1,4 +1,4 @@ -## Interface `AnalysisEnglishAnalyzer` +# `AnalysisEnglishAnalyzer` [interface-AnalysisEnglishAnalyzer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisEstonianAnalyzer.md b/docs/reference/api/AnalysisEstonianAnalyzer.md index 0af5380b5..c1d16f6df 100644 --- a/docs/reference/api/AnalysisEstonianAnalyzer.md +++ b/docs/reference/api/AnalysisEstonianAnalyzer.md @@ -1,4 +1,4 @@ -## Interface `AnalysisEstonianAnalyzer` +# `AnalysisEstonianAnalyzer` [interface-AnalysisEstonianAnalyzer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisFingerprintAnalyzer.md b/docs/reference/api/AnalysisFingerprintAnalyzer.md index 957b30c39..f7653a3a8 100644 --- a/docs/reference/api/AnalysisFingerprintAnalyzer.md +++ b/docs/reference/api/AnalysisFingerprintAnalyzer.md @@ -1,4 +1,4 @@ -## Interface `AnalysisFingerprintAnalyzer` +# `AnalysisFingerprintAnalyzer` [interface-AnalysisFingerprintAnalyzer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisFingerprintTokenFilter.md b/docs/reference/api/AnalysisFingerprintTokenFilter.md index 3d39d7442..c3a06f74e 100644 --- a/docs/reference/api/AnalysisFingerprintTokenFilter.md +++ b/docs/reference/api/AnalysisFingerprintTokenFilter.md @@ -1,4 +1,4 @@ -## Interface `AnalysisFingerprintTokenFilter` +# `AnalysisFingerprintTokenFilter` [interface-AnalysisFingerprintTokenFilter] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisFinnishAnalyzer.md b/docs/reference/api/AnalysisFinnishAnalyzer.md index 2657cdd33..4aac4e043 100644 --- a/docs/reference/api/AnalysisFinnishAnalyzer.md +++ b/docs/reference/api/AnalysisFinnishAnalyzer.md @@ -1,4 +1,4 @@ -## Interface `AnalysisFinnishAnalyzer` +# `AnalysisFinnishAnalyzer` [interface-AnalysisFinnishAnalyzer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisFlattenGraphTokenFilter.md b/docs/reference/api/AnalysisFlattenGraphTokenFilter.md index 628c29d0c..37a281005 100644 --- a/docs/reference/api/AnalysisFlattenGraphTokenFilter.md +++ b/docs/reference/api/AnalysisFlattenGraphTokenFilter.md @@ -1,4 +1,4 @@ -## Interface `AnalysisFlattenGraphTokenFilter` +# `AnalysisFlattenGraphTokenFilter` [interface-AnalysisFlattenGraphTokenFilter] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisFrenchAnalyzer.md b/docs/reference/api/AnalysisFrenchAnalyzer.md index 52cf61c50..127240dd1 100644 --- a/docs/reference/api/AnalysisFrenchAnalyzer.md +++ b/docs/reference/api/AnalysisFrenchAnalyzer.md @@ -1,4 +1,4 @@ -## Interface `AnalysisFrenchAnalyzer` +# `AnalysisFrenchAnalyzer` [interface-AnalysisFrenchAnalyzer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisGalicianAnalyzer.md b/docs/reference/api/AnalysisGalicianAnalyzer.md index 6241af166..7de41b1ac 100644 --- a/docs/reference/api/AnalysisGalicianAnalyzer.md +++ b/docs/reference/api/AnalysisGalicianAnalyzer.md @@ -1,4 +1,4 @@ -## Interface `AnalysisGalicianAnalyzer` +# `AnalysisGalicianAnalyzer` [interface-AnalysisGalicianAnalyzer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisGermanAnalyzer.md b/docs/reference/api/AnalysisGermanAnalyzer.md index 70ed807a5..1a2e5cc9a 100644 --- a/docs/reference/api/AnalysisGermanAnalyzer.md +++ b/docs/reference/api/AnalysisGermanAnalyzer.md @@ -1,4 +1,4 @@ -## Interface `AnalysisGermanAnalyzer` +# `AnalysisGermanAnalyzer` [interface-AnalysisGermanAnalyzer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisGermanNormalizationTokenFilter.md b/docs/reference/api/AnalysisGermanNormalizationTokenFilter.md index 70745905b..f0a3ee381 100644 --- a/docs/reference/api/AnalysisGermanNormalizationTokenFilter.md +++ b/docs/reference/api/AnalysisGermanNormalizationTokenFilter.md @@ -1,4 +1,4 @@ -## Interface `AnalysisGermanNormalizationTokenFilter` +# `AnalysisGermanNormalizationTokenFilter` [interface-AnalysisGermanNormalizationTokenFilter] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisGreekAnalyzer.md b/docs/reference/api/AnalysisGreekAnalyzer.md index 930bc7951..e47200676 100644 --- a/docs/reference/api/AnalysisGreekAnalyzer.md +++ b/docs/reference/api/AnalysisGreekAnalyzer.md @@ -1,4 +1,4 @@ -## Interface `AnalysisGreekAnalyzer` +# `AnalysisGreekAnalyzer` [interface-AnalysisGreekAnalyzer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisHindiAnalyzer.md b/docs/reference/api/AnalysisHindiAnalyzer.md index 9136a2cb6..268d758ff 100644 --- a/docs/reference/api/AnalysisHindiAnalyzer.md +++ b/docs/reference/api/AnalysisHindiAnalyzer.md @@ -1,4 +1,4 @@ -## Interface `AnalysisHindiAnalyzer` +# `AnalysisHindiAnalyzer` [interface-AnalysisHindiAnalyzer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisHindiNormalizationTokenFilter.md b/docs/reference/api/AnalysisHindiNormalizationTokenFilter.md index 9c85dd18d..00a64857e 100644 --- a/docs/reference/api/AnalysisHindiNormalizationTokenFilter.md +++ b/docs/reference/api/AnalysisHindiNormalizationTokenFilter.md @@ -1,4 +1,4 @@ -## Interface `AnalysisHindiNormalizationTokenFilter` +# `AnalysisHindiNormalizationTokenFilter` [interface-AnalysisHindiNormalizationTokenFilter] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisHtmlStripCharFilter.md b/docs/reference/api/AnalysisHtmlStripCharFilter.md index 92ac943cb..31ee64016 100644 --- a/docs/reference/api/AnalysisHtmlStripCharFilter.md +++ b/docs/reference/api/AnalysisHtmlStripCharFilter.md @@ -1,4 +1,4 @@ -## Interface `AnalysisHtmlStripCharFilter` +# `AnalysisHtmlStripCharFilter` [interface-AnalysisHtmlStripCharFilter] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisHungarianAnalyzer.md b/docs/reference/api/AnalysisHungarianAnalyzer.md index 77297b08c..6ab18e660 100644 --- a/docs/reference/api/AnalysisHungarianAnalyzer.md +++ b/docs/reference/api/AnalysisHungarianAnalyzer.md @@ -1,4 +1,4 @@ -## Interface `AnalysisHungarianAnalyzer` +# `AnalysisHungarianAnalyzer` [interface-AnalysisHungarianAnalyzer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisHunspellTokenFilter.md b/docs/reference/api/AnalysisHunspellTokenFilter.md index 46e270f8d..22d557386 100644 --- a/docs/reference/api/AnalysisHunspellTokenFilter.md +++ b/docs/reference/api/AnalysisHunspellTokenFilter.md @@ -1,4 +1,4 @@ -## Interface `AnalysisHunspellTokenFilter` +# `AnalysisHunspellTokenFilter` [interface-AnalysisHunspellTokenFilter] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisHyphenationDecompounderTokenFilter.md b/docs/reference/api/AnalysisHyphenationDecompounderTokenFilter.md index 813ca66e2..ecf8d3253 100644 --- a/docs/reference/api/AnalysisHyphenationDecompounderTokenFilter.md +++ b/docs/reference/api/AnalysisHyphenationDecompounderTokenFilter.md @@ -1,4 +1,4 @@ -## Interface `AnalysisHyphenationDecompounderTokenFilter` +# `AnalysisHyphenationDecompounderTokenFilter` [interface-AnalysisHyphenationDecompounderTokenFilter] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisIcuAnalyzer.md b/docs/reference/api/AnalysisIcuAnalyzer.md index bb8975abe..0c9e1ff77 100644 --- a/docs/reference/api/AnalysisIcuAnalyzer.md +++ b/docs/reference/api/AnalysisIcuAnalyzer.md @@ -1,4 +1,4 @@ -## Interface `AnalysisIcuAnalyzer` +# `AnalysisIcuAnalyzer` [interface-AnalysisIcuAnalyzer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisIcuCollationAlternate.md b/docs/reference/api/AnalysisIcuCollationAlternate.md index acd1e984d..1b9293695 100644 --- a/docs/reference/api/AnalysisIcuCollationAlternate.md +++ b/docs/reference/api/AnalysisIcuCollationAlternate.md @@ -1,4 +1,4 @@ -## `AnalysisIcuCollationAlternate` -::: +# `AnalysisIcuCollationAlternate` [alias-AnalysisIcuCollationAlternate] +```typescript type AnalysisIcuCollationAlternate = 'shifted' | 'non-ignorable'; -::: +``` diff --git a/docs/reference/api/AnalysisIcuCollationCaseFirst.md b/docs/reference/api/AnalysisIcuCollationCaseFirst.md index 7bcd99e96..2b95ce9a2 100644 --- a/docs/reference/api/AnalysisIcuCollationCaseFirst.md +++ b/docs/reference/api/AnalysisIcuCollationCaseFirst.md @@ -1,4 +1,4 @@ -## `AnalysisIcuCollationCaseFirst` -::: +# `AnalysisIcuCollationCaseFirst` [alias-AnalysisIcuCollationCaseFirst] +```typescript type AnalysisIcuCollationCaseFirst = 'lower' | 'upper'; -::: +``` diff --git a/docs/reference/api/AnalysisIcuCollationDecomposition.md b/docs/reference/api/AnalysisIcuCollationDecomposition.md index f5710a378..5af883841 100644 --- a/docs/reference/api/AnalysisIcuCollationDecomposition.md +++ b/docs/reference/api/AnalysisIcuCollationDecomposition.md @@ -1,4 +1,4 @@ -## `AnalysisIcuCollationDecomposition` -::: +# `AnalysisIcuCollationDecomposition` [alias-AnalysisIcuCollationDecomposition] +```typescript type AnalysisIcuCollationDecomposition = 'no' | 'identical'; -::: +``` diff --git a/docs/reference/api/AnalysisIcuCollationStrength.md b/docs/reference/api/AnalysisIcuCollationStrength.md index bca08521a..e03c7a663 100644 --- a/docs/reference/api/AnalysisIcuCollationStrength.md +++ b/docs/reference/api/AnalysisIcuCollationStrength.md @@ -1,4 +1,4 @@ -## `AnalysisIcuCollationStrength` -::: +# `AnalysisIcuCollationStrength` [alias-AnalysisIcuCollationStrength] +```typescript type AnalysisIcuCollationStrength = 'primary' | 'secondary' | 'tertiary' | 'quaternary' | 'identical'; -::: +``` diff --git a/docs/reference/api/AnalysisIcuCollationTokenFilter.md b/docs/reference/api/AnalysisIcuCollationTokenFilter.md index ac6bde71a..6e544675e 100644 --- a/docs/reference/api/AnalysisIcuCollationTokenFilter.md +++ b/docs/reference/api/AnalysisIcuCollationTokenFilter.md @@ -1,4 +1,4 @@ -## Interface `AnalysisIcuCollationTokenFilter` +# `AnalysisIcuCollationTokenFilter` [interface-AnalysisIcuCollationTokenFilter] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisIcuFoldingTokenFilter.md b/docs/reference/api/AnalysisIcuFoldingTokenFilter.md index 185c3a1ed..58f4c4b17 100644 --- a/docs/reference/api/AnalysisIcuFoldingTokenFilter.md +++ b/docs/reference/api/AnalysisIcuFoldingTokenFilter.md @@ -1,4 +1,4 @@ -## Interface `AnalysisIcuFoldingTokenFilter` +# `AnalysisIcuFoldingTokenFilter` [interface-AnalysisIcuFoldingTokenFilter] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisIcuNormalizationCharFilter.md b/docs/reference/api/AnalysisIcuNormalizationCharFilter.md index 85a0045af..5ae890503 100644 --- a/docs/reference/api/AnalysisIcuNormalizationCharFilter.md +++ b/docs/reference/api/AnalysisIcuNormalizationCharFilter.md @@ -1,4 +1,4 @@ -## Interface `AnalysisIcuNormalizationCharFilter` +# `AnalysisIcuNormalizationCharFilter` [interface-AnalysisIcuNormalizationCharFilter] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisIcuNormalizationMode.md b/docs/reference/api/AnalysisIcuNormalizationMode.md index dd7ba1ce3..f6a8dcbf4 100644 --- a/docs/reference/api/AnalysisIcuNormalizationMode.md +++ b/docs/reference/api/AnalysisIcuNormalizationMode.md @@ -1,4 +1,4 @@ -## `AnalysisIcuNormalizationMode` -::: +# `AnalysisIcuNormalizationMode` [alias-AnalysisIcuNormalizationMode] +```typescript type AnalysisIcuNormalizationMode = 'decompose' | 'compose'; -::: +``` diff --git a/docs/reference/api/AnalysisIcuNormalizationTokenFilter.md b/docs/reference/api/AnalysisIcuNormalizationTokenFilter.md index 327a8b212..a93a3d377 100644 --- a/docs/reference/api/AnalysisIcuNormalizationTokenFilter.md +++ b/docs/reference/api/AnalysisIcuNormalizationTokenFilter.md @@ -1,4 +1,4 @@ -## Interface `AnalysisIcuNormalizationTokenFilter` +# `AnalysisIcuNormalizationTokenFilter` [interface-AnalysisIcuNormalizationTokenFilter] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisIcuNormalizationType.md b/docs/reference/api/AnalysisIcuNormalizationType.md index 1ecad1481..3edbc2546 100644 --- a/docs/reference/api/AnalysisIcuNormalizationType.md +++ b/docs/reference/api/AnalysisIcuNormalizationType.md @@ -1,4 +1,4 @@ -## `AnalysisIcuNormalizationType` -::: +# `AnalysisIcuNormalizationType` [alias-AnalysisIcuNormalizationType] +```typescript type AnalysisIcuNormalizationType = 'nfc' | 'nfkc' | 'nfkc_cf'; -::: +``` diff --git a/docs/reference/api/AnalysisIcuTokenizer.md b/docs/reference/api/AnalysisIcuTokenizer.md index 6d041a957..177d23346 100644 --- a/docs/reference/api/AnalysisIcuTokenizer.md +++ b/docs/reference/api/AnalysisIcuTokenizer.md @@ -1,4 +1,4 @@ -## Interface `AnalysisIcuTokenizer` +# `AnalysisIcuTokenizer` [interface-AnalysisIcuTokenizer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisIcuTransformDirection.md b/docs/reference/api/AnalysisIcuTransformDirection.md index f2bc4d599..553dbeb91 100644 --- a/docs/reference/api/AnalysisIcuTransformDirection.md +++ b/docs/reference/api/AnalysisIcuTransformDirection.md @@ -1,4 +1,4 @@ -## `AnalysisIcuTransformDirection` -::: +# `AnalysisIcuTransformDirection` [alias-AnalysisIcuTransformDirection] +```typescript type AnalysisIcuTransformDirection = 'forward' | 'reverse'; -::: +``` diff --git a/docs/reference/api/AnalysisIcuTransformTokenFilter.md b/docs/reference/api/AnalysisIcuTransformTokenFilter.md index 00152ef39..095e9d1bb 100644 --- a/docs/reference/api/AnalysisIcuTransformTokenFilter.md +++ b/docs/reference/api/AnalysisIcuTransformTokenFilter.md @@ -1,4 +1,4 @@ -## Interface `AnalysisIcuTransformTokenFilter` +# `AnalysisIcuTransformTokenFilter` [interface-AnalysisIcuTransformTokenFilter] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisIndicNormalizationTokenFilter.md b/docs/reference/api/AnalysisIndicNormalizationTokenFilter.md index cd7aca579..7992a905f 100644 --- a/docs/reference/api/AnalysisIndicNormalizationTokenFilter.md +++ b/docs/reference/api/AnalysisIndicNormalizationTokenFilter.md @@ -1,4 +1,4 @@ -## Interface `AnalysisIndicNormalizationTokenFilter` +# `AnalysisIndicNormalizationTokenFilter` [interface-AnalysisIndicNormalizationTokenFilter] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisIndonesianAnalyzer.md b/docs/reference/api/AnalysisIndonesianAnalyzer.md index 059fb579e..7e97c7dab 100644 --- a/docs/reference/api/AnalysisIndonesianAnalyzer.md +++ b/docs/reference/api/AnalysisIndonesianAnalyzer.md @@ -1,4 +1,4 @@ -## Interface `AnalysisIndonesianAnalyzer` +# `AnalysisIndonesianAnalyzer` [interface-AnalysisIndonesianAnalyzer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisIrishAnalyzer.md b/docs/reference/api/AnalysisIrishAnalyzer.md index 3d6265961..841effbeb 100644 --- a/docs/reference/api/AnalysisIrishAnalyzer.md +++ b/docs/reference/api/AnalysisIrishAnalyzer.md @@ -1,4 +1,4 @@ -## Interface `AnalysisIrishAnalyzer` +# `AnalysisIrishAnalyzer` [interface-AnalysisIrishAnalyzer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisItalianAnalyzer.md b/docs/reference/api/AnalysisItalianAnalyzer.md index 394a5fb9c..2e817f344 100644 --- a/docs/reference/api/AnalysisItalianAnalyzer.md +++ b/docs/reference/api/AnalysisItalianAnalyzer.md @@ -1,4 +1,4 @@ -## Interface `AnalysisItalianAnalyzer` +# `AnalysisItalianAnalyzer` [interface-AnalysisItalianAnalyzer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisJaStopTokenFilter.md b/docs/reference/api/AnalysisJaStopTokenFilter.md index 2aface2aa..68899ff25 100644 --- a/docs/reference/api/AnalysisJaStopTokenFilter.md +++ b/docs/reference/api/AnalysisJaStopTokenFilter.md @@ -1,4 +1,4 @@ -## Interface `AnalysisJaStopTokenFilter` +# `AnalysisJaStopTokenFilter` [interface-AnalysisJaStopTokenFilter] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisKStemTokenFilter.md b/docs/reference/api/AnalysisKStemTokenFilter.md index f1de5265d..43b30289f 100644 --- a/docs/reference/api/AnalysisKStemTokenFilter.md +++ b/docs/reference/api/AnalysisKStemTokenFilter.md @@ -1,4 +1,4 @@ -## Interface `AnalysisKStemTokenFilter` +# `AnalysisKStemTokenFilter` [interface-AnalysisKStemTokenFilter] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisKeepTypesMode.md b/docs/reference/api/AnalysisKeepTypesMode.md index 71eab376b..f28e43c07 100644 --- a/docs/reference/api/AnalysisKeepTypesMode.md +++ b/docs/reference/api/AnalysisKeepTypesMode.md @@ -1,4 +1,4 @@ -## `AnalysisKeepTypesMode` -::: +# `AnalysisKeepTypesMode` [alias-AnalysisKeepTypesMode] +```typescript type AnalysisKeepTypesMode = 'include' | 'exclude'; -::: +``` diff --git a/docs/reference/api/AnalysisKeepTypesTokenFilter.md b/docs/reference/api/AnalysisKeepTypesTokenFilter.md index ba4b86aaf..f35fc6d46 100644 --- a/docs/reference/api/AnalysisKeepTypesTokenFilter.md +++ b/docs/reference/api/AnalysisKeepTypesTokenFilter.md @@ -1,4 +1,4 @@ -## Interface `AnalysisKeepTypesTokenFilter` +# `AnalysisKeepTypesTokenFilter` [interface-AnalysisKeepTypesTokenFilter] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisKeepWordsTokenFilter.md b/docs/reference/api/AnalysisKeepWordsTokenFilter.md index 902ee6038..82c59e0e7 100644 --- a/docs/reference/api/AnalysisKeepWordsTokenFilter.md +++ b/docs/reference/api/AnalysisKeepWordsTokenFilter.md @@ -1,4 +1,4 @@ -## Interface `AnalysisKeepWordsTokenFilter` +# `AnalysisKeepWordsTokenFilter` [interface-AnalysisKeepWordsTokenFilter] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisKeywordAnalyzer.md b/docs/reference/api/AnalysisKeywordAnalyzer.md index ac1876aed..6fd866d58 100644 --- a/docs/reference/api/AnalysisKeywordAnalyzer.md +++ b/docs/reference/api/AnalysisKeywordAnalyzer.md @@ -1,4 +1,4 @@ -## Interface `AnalysisKeywordAnalyzer` +# `AnalysisKeywordAnalyzer` [interface-AnalysisKeywordAnalyzer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisKeywordMarkerTokenFilter.md b/docs/reference/api/AnalysisKeywordMarkerTokenFilter.md index 2e5265ad0..d5e7bdc22 100644 --- a/docs/reference/api/AnalysisKeywordMarkerTokenFilter.md +++ b/docs/reference/api/AnalysisKeywordMarkerTokenFilter.md @@ -1,4 +1,4 @@ -## Interface `AnalysisKeywordMarkerTokenFilter` +# `AnalysisKeywordMarkerTokenFilter` [interface-AnalysisKeywordMarkerTokenFilter] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisKeywordRepeatTokenFilter.md b/docs/reference/api/AnalysisKeywordRepeatTokenFilter.md index c394a5df4..914e3b7c1 100644 --- a/docs/reference/api/AnalysisKeywordRepeatTokenFilter.md +++ b/docs/reference/api/AnalysisKeywordRepeatTokenFilter.md @@ -1,4 +1,4 @@ -## Interface `AnalysisKeywordRepeatTokenFilter` +# `AnalysisKeywordRepeatTokenFilter` [interface-AnalysisKeywordRepeatTokenFilter] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisKeywordTokenizer.md b/docs/reference/api/AnalysisKeywordTokenizer.md index 88bba70eb..1d531d185 100644 --- a/docs/reference/api/AnalysisKeywordTokenizer.md +++ b/docs/reference/api/AnalysisKeywordTokenizer.md @@ -1,4 +1,4 @@ -## Interface `AnalysisKeywordTokenizer` +# `AnalysisKeywordTokenizer` [interface-AnalysisKeywordTokenizer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisKuromojiAnalyzer.md b/docs/reference/api/AnalysisKuromojiAnalyzer.md index 7edc8ca28..54c834cef 100644 --- a/docs/reference/api/AnalysisKuromojiAnalyzer.md +++ b/docs/reference/api/AnalysisKuromojiAnalyzer.md @@ -1,4 +1,4 @@ -## Interface `AnalysisKuromojiAnalyzer` +# `AnalysisKuromojiAnalyzer` [interface-AnalysisKuromojiAnalyzer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisKuromojiIterationMarkCharFilter.md b/docs/reference/api/AnalysisKuromojiIterationMarkCharFilter.md index df15cc894..73b9c59cb 100644 --- a/docs/reference/api/AnalysisKuromojiIterationMarkCharFilter.md +++ b/docs/reference/api/AnalysisKuromojiIterationMarkCharFilter.md @@ -1,4 +1,4 @@ -## Interface `AnalysisKuromojiIterationMarkCharFilter` +# `AnalysisKuromojiIterationMarkCharFilter` [interface-AnalysisKuromojiIterationMarkCharFilter] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisKuromojiPartOfSpeechTokenFilter.md b/docs/reference/api/AnalysisKuromojiPartOfSpeechTokenFilter.md index f26d181c3..a70f99ca2 100644 --- a/docs/reference/api/AnalysisKuromojiPartOfSpeechTokenFilter.md +++ b/docs/reference/api/AnalysisKuromojiPartOfSpeechTokenFilter.md @@ -1,4 +1,4 @@ -## Interface `AnalysisKuromojiPartOfSpeechTokenFilter` +# `AnalysisKuromojiPartOfSpeechTokenFilter` [interface-AnalysisKuromojiPartOfSpeechTokenFilter] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisKuromojiReadingFormTokenFilter.md b/docs/reference/api/AnalysisKuromojiReadingFormTokenFilter.md index f027be704..b5369c9f0 100644 --- a/docs/reference/api/AnalysisKuromojiReadingFormTokenFilter.md +++ b/docs/reference/api/AnalysisKuromojiReadingFormTokenFilter.md @@ -1,4 +1,4 @@ -## Interface `AnalysisKuromojiReadingFormTokenFilter` +# `AnalysisKuromojiReadingFormTokenFilter` [interface-AnalysisKuromojiReadingFormTokenFilter] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisKuromojiStemmerTokenFilter.md b/docs/reference/api/AnalysisKuromojiStemmerTokenFilter.md index 86a5a3426..5225129dd 100644 --- a/docs/reference/api/AnalysisKuromojiStemmerTokenFilter.md +++ b/docs/reference/api/AnalysisKuromojiStemmerTokenFilter.md @@ -1,4 +1,4 @@ -## Interface `AnalysisKuromojiStemmerTokenFilter` +# `AnalysisKuromojiStemmerTokenFilter` [interface-AnalysisKuromojiStemmerTokenFilter] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisKuromojiTokenizationMode.md b/docs/reference/api/AnalysisKuromojiTokenizationMode.md index c8fa65cfb..f9a320693 100644 --- a/docs/reference/api/AnalysisKuromojiTokenizationMode.md +++ b/docs/reference/api/AnalysisKuromojiTokenizationMode.md @@ -1,4 +1,4 @@ -## `AnalysisKuromojiTokenizationMode` -::: +# `AnalysisKuromojiTokenizationMode` [alias-AnalysisKuromojiTokenizationMode] +```typescript type AnalysisKuromojiTokenizationMode = 'normal' | 'search' | 'extended'; -::: +``` diff --git a/docs/reference/api/AnalysisKuromojiTokenizer.md b/docs/reference/api/AnalysisKuromojiTokenizer.md index 62bcb80b1..fb91f5497 100644 --- a/docs/reference/api/AnalysisKuromojiTokenizer.md +++ b/docs/reference/api/AnalysisKuromojiTokenizer.md @@ -1,4 +1,4 @@ -## Interface `AnalysisKuromojiTokenizer` +# `AnalysisKuromojiTokenizer` [interface-AnalysisKuromojiTokenizer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisLatvianAnalyzer.md b/docs/reference/api/AnalysisLatvianAnalyzer.md index c2ae06fe1..6e51249c9 100644 --- a/docs/reference/api/AnalysisLatvianAnalyzer.md +++ b/docs/reference/api/AnalysisLatvianAnalyzer.md @@ -1,4 +1,4 @@ -## Interface `AnalysisLatvianAnalyzer` +# `AnalysisLatvianAnalyzer` [interface-AnalysisLatvianAnalyzer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisLengthTokenFilter.md b/docs/reference/api/AnalysisLengthTokenFilter.md index 2d2b80714..7f1d692f9 100644 --- a/docs/reference/api/AnalysisLengthTokenFilter.md +++ b/docs/reference/api/AnalysisLengthTokenFilter.md @@ -1,4 +1,4 @@ -## Interface `AnalysisLengthTokenFilter` +# `AnalysisLengthTokenFilter` [interface-AnalysisLengthTokenFilter] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisLetterTokenizer.md b/docs/reference/api/AnalysisLetterTokenizer.md index f6dfdfc43..e80c28651 100644 --- a/docs/reference/api/AnalysisLetterTokenizer.md +++ b/docs/reference/api/AnalysisLetterTokenizer.md @@ -1,4 +1,4 @@ -## Interface `AnalysisLetterTokenizer` +# `AnalysisLetterTokenizer` [interface-AnalysisLetterTokenizer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisLimitTokenCountTokenFilter.md b/docs/reference/api/AnalysisLimitTokenCountTokenFilter.md index bea22989b..22f7c2217 100644 --- a/docs/reference/api/AnalysisLimitTokenCountTokenFilter.md +++ b/docs/reference/api/AnalysisLimitTokenCountTokenFilter.md @@ -1,4 +1,4 @@ -## Interface `AnalysisLimitTokenCountTokenFilter` +# `AnalysisLimitTokenCountTokenFilter` [interface-AnalysisLimitTokenCountTokenFilter] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisLithuanianAnalyzer.md b/docs/reference/api/AnalysisLithuanianAnalyzer.md index 67c47bf0b..ca68a936d 100644 --- a/docs/reference/api/AnalysisLithuanianAnalyzer.md +++ b/docs/reference/api/AnalysisLithuanianAnalyzer.md @@ -1,4 +1,4 @@ -## Interface `AnalysisLithuanianAnalyzer` +# `AnalysisLithuanianAnalyzer` [interface-AnalysisLithuanianAnalyzer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisLowercaseNormalizer.md b/docs/reference/api/AnalysisLowercaseNormalizer.md index 6b0ce5185..0feb55a62 100644 --- a/docs/reference/api/AnalysisLowercaseNormalizer.md +++ b/docs/reference/api/AnalysisLowercaseNormalizer.md @@ -1,4 +1,4 @@ -## Interface `AnalysisLowercaseNormalizer` +# `AnalysisLowercaseNormalizer` [interface-AnalysisLowercaseNormalizer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisLowercaseTokenFilter.md b/docs/reference/api/AnalysisLowercaseTokenFilter.md index e14e6e63a..e65c4829e 100644 --- a/docs/reference/api/AnalysisLowercaseTokenFilter.md +++ b/docs/reference/api/AnalysisLowercaseTokenFilter.md @@ -1,4 +1,4 @@ -## Interface `AnalysisLowercaseTokenFilter` +# `AnalysisLowercaseTokenFilter` [interface-AnalysisLowercaseTokenFilter] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisLowercaseTokenFilterLanguages.md b/docs/reference/api/AnalysisLowercaseTokenFilterLanguages.md index f8afdabef..8ac641db2 100644 --- a/docs/reference/api/AnalysisLowercaseTokenFilterLanguages.md +++ b/docs/reference/api/AnalysisLowercaseTokenFilterLanguages.md @@ -1,4 +1,4 @@ -## `AnalysisLowercaseTokenFilterLanguages` -::: +# `AnalysisLowercaseTokenFilterLanguages` [alias-AnalysisLowercaseTokenFilterLanguages] +```typescript type AnalysisLowercaseTokenFilterLanguages = 'greek' | 'irish' | 'turkish'; -::: +``` diff --git a/docs/reference/api/AnalysisLowercaseTokenizer.md b/docs/reference/api/AnalysisLowercaseTokenizer.md index 855b08d6e..659baa382 100644 --- a/docs/reference/api/AnalysisLowercaseTokenizer.md +++ b/docs/reference/api/AnalysisLowercaseTokenizer.md @@ -1,4 +1,4 @@ -## Interface `AnalysisLowercaseTokenizer` +# `AnalysisLowercaseTokenizer` [interface-AnalysisLowercaseTokenizer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisMappingCharFilter.md b/docs/reference/api/AnalysisMappingCharFilter.md index b89c73500..e1eafc92d 100644 --- a/docs/reference/api/AnalysisMappingCharFilter.md +++ b/docs/reference/api/AnalysisMappingCharFilter.md @@ -1,4 +1,4 @@ -## Interface `AnalysisMappingCharFilter` +# `AnalysisMappingCharFilter` [interface-AnalysisMappingCharFilter] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisMinHashTokenFilter.md b/docs/reference/api/AnalysisMinHashTokenFilter.md index 1231edfa8..a50d19c8a 100644 --- a/docs/reference/api/AnalysisMinHashTokenFilter.md +++ b/docs/reference/api/AnalysisMinHashTokenFilter.md @@ -1,4 +1,4 @@ -## Interface `AnalysisMinHashTokenFilter` +# `AnalysisMinHashTokenFilter` [interface-AnalysisMinHashTokenFilter] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisMultiplexerTokenFilter.md b/docs/reference/api/AnalysisMultiplexerTokenFilter.md index 0282c73d6..453d4acac 100644 --- a/docs/reference/api/AnalysisMultiplexerTokenFilter.md +++ b/docs/reference/api/AnalysisMultiplexerTokenFilter.md @@ -1,4 +1,4 @@ -## Interface `AnalysisMultiplexerTokenFilter` +# `AnalysisMultiplexerTokenFilter` [interface-AnalysisMultiplexerTokenFilter] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisNGramTokenFilter.md b/docs/reference/api/AnalysisNGramTokenFilter.md index 829a63095..a12a3e1e3 100644 --- a/docs/reference/api/AnalysisNGramTokenFilter.md +++ b/docs/reference/api/AnalysisNGramTokenFilter.md @@ -1,4 +1,4 @@ -## Interface `AnalysisNGramTokenFilter` +# `AnalysisNGramTokenFilter` [interface-AnalysisNGramTokenFilter] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisNGramTokenizer.md b/docs/reference/api/AnalysisNGramTokenizer.md index 74b328cb1..c4b07ff1d 100644 --- a/docs/reference/api/AnalysisNGramTokenizer.md +++ b/docs/reference/api/AnalysisNGramTokenizer.md @@ -1,4 +1,4 @@ -## Interface `AnalysisNGramTokenizer` +# `AnalysisNGramTokenizer` [interface-AnalysisNGramTokenizer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisNoriAnalyzer.md b/docs/reference/api/AnalysisNoriAnalyzer.md index 7c2b9bb64..b0b0f9319 100644 --- a/docs/reference/api/AnalysisNoriAnalyzer.md +++ b/docs/reference/api/AnalysisNoriAnalyzer.md @@ -1,4 +1,4 @@ -## Interface `AnalysisNoriAnalyzer` +# `AnalysisNoriAnalyzer` [interface-AnalysisNoriAnalyzer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisNoriDecompoundMode.md b/docs/reference/api/AnalysisNoriDecompoundMode.md index 5c075647f..fb7219a36 100644 --- a/docs/reference/api/AnalysisNoriDecompoundMode.md +++ b/docs/reference/api/AnalysisNoriDecompoundMode.md @@ -1,4 +1,4 @@ -## `AnalysisNoriDecompoundMode` -::: +# `AnalysisNoriDecompoundMode` [alias-AnalysisNoriDecompoundMode] +```typescript type AnalysisNoriDecompoundMode = 'discard' | 'none' | 'mixed'; -::: +``` diff --git a/docs/reference/api/AnalysisNoriPartOfSpeechTokenFilter.md b/docs/reference/api/AnalysisNoriPartOfSpeechTokenFilter.md index a535c48fd..6398e5706 100644 --- a/docs/reference/api/AnalysisNoriPartOfSpeechTokenFilter.md +++ b/docs/reference/api/AnalysisNoriPartOfSpeechTokenFilter.md @@ -1,4 +1,4 @@ -## Interface `AnalysisNoriPartOfSpeechTokenFilter` +# `AnalysisNoriPartOfSpeechTokenFilter` [interface-AnalysisNoriPartOfSpeechTokenFilter] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisNoriTokenizer.md b/docs/reference/api/AnalysisNoriTokenizer.md index 4fc8af49b..e5176a442 100644 --- a/docs/reference/api/AnalysisNoriTokenizer.md +++ b/docs/reference/api/AnalysisNoriTokenizer.md @@ -1,4 +1,4 @@ -## Interface `AnalysisNoriTokenizer` +# `AnalysisNoriTokenizer` [interface-AnalysisNoriTokenizer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisNormalizer.md b/docs/reference/api/AnalysisNormalizer.md index 46279996f..f69385213 100644 --- a/docs/reference/api/AnalysisNormalizer.md +++ b/docs/reference/api/AnalysisNormalizer.md @@ -1,4 +1,4 @@ -## `AnalysisNormalizer` -::: +# `AnalysisNormalizer` [alias-AnalysisNormalizer] +```typescript type AnalysisNormalizer = [AnalysisLowercaseNormalizer](./AnalysisLowercaseNormalizer.md) | [AnalysisCustomNormalizer](./AnalysisCustomNormalizer.md); -::: +``` diff --git a/docs/reference/api/AnalysisNorwegianAnalyzer.md b/docs/reference/api/AnalysisNorwegianAnalyzer.md index 12025deca..06863f0d6 100644 --- a/docs/reference/api/AnalysisNorwegianAnalyzer.md +++ b/docs/reference/api/AnalysisNorwegianAnalyzer.md @@ -1,4 +1,4 @@ -## Interface `AnalysisNorwegianAnalyzer` +# `AnalysisNorwegianAnalyzer` [interface-AnalysisNorwegianAnalyzer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisPathHierarchyTokenizer.md b/docs/reference/api/AnalysisPathHierarchyTokenizer.md index 1d684d29b..a9729e1d1 100644 --- a/docs/reference/api/AnalysisPathHierarchyTokenizer.md +++ b/docs/reference/api/AnalysisPathHierarchyTokenizer.md @@ -1,4 +1,4 @@ -## Interface `AnalysisPathHierarchyTokenizer` +# `AnalysisPathHierarchyTokenizer` [interface-AnalysisPathHierarchyTokenizer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisPatternAnalyzer.md b/docs/reference/api/AnalysisPatternAnalyzer.md index b335e2864..51dbf6eed 100644 --- a/docs/reference/api/AnalysisPatternAnalyzer.md +++ b/docs/reference/api/AnalysisPatternAnalyzer.md @@ -1,4 +1,4 @@ -## Interface `AnalysisPatternAnalyzer` +# `AnalysisPatternAnalyzer` [interface-AnalysisPatternAnalyzer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisPatternCaptureTokenFilter.md b/docs/reference/api/AnalysisPatternCaptureTokenFilter.md index 7a0400ca5..9ac28ba79 100644 --- a/docs/reference/api/AnalysisPatternCaptureTokenFilter.md +++ b/docs/reference/api/AnalysisPatternCaptureTokenFilter.md @@ -1,4 +1,4 @@ -## Interface `AnalysisPatternCaptureTokenFilter` +# `AnalysisPatternCaptureTokenFilter` [interface-AnalysisPatternCaptureTokenFilter] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisPatternReplaceCharFilter.md b/docs/reference/api/AnalysisPatternReplaceCharFilter.md index fc91882d2..a4ea738fa 100644 --- a/docs/reference/api/AnalysisPatternReplaceCharFilter.md +++ b/docs/reference/api/AnalysisPatternReplaceCharFilter.md @@ -1,4 +1,4 @@ -## Interface `AnalysisPatternReplaceCharFilter` +# `AnalysisPatternReplaceCharFilter` [interface-AnalysisPatternReplaceCharFilter] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisPatternReplaceTokenFilter.md b/docs/reference/api/AnalysisPatternReplaceTokenFilter.md index d4f65114f..bd248b864 100644 --- a/docs/reference/api/AnalysisPatternReplaceTokenFilter.md +++ b/docs/reference/api/AnalysisPatternReplaceTokenFilter.md @@ -1,4 +1,4 @@ -## Interface `AnalysisPatternReplaceTokenFilter` +# `AnalysisPatternReplaceTokenFilter` [interface-AnalysisPatternReplaceTokenFilter] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisPatternTokenizer.md b/docs/reference/api/AnalysisPatternTokenizer.md index a6bbb4a23..68a009994 100644 --- a/docs/reference/api/AnalysisPatternTokenizer.md +++ b/docs/reference/api/AnalysisPatternTokenizer.md @@ -1,4 +1,4 @@ -## Interface `AnalysisPatternTokenizer` +# `AnalysisPatternTokenizer` [interface-AnalysisPatternTokenizer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisPersianAnalyzer.md b/docs/reference/api/AnalysisPersianAnalyzer.md index 2bec97b77..e622b1cae 100644 --- a/docs/reference/api/AnalysisPersianAnalyzer.md +++ b/docs/reference/api/AnalysisPersianAnalyzer.md @@ -1,4 +1,4 @@ -## Interface `AnalysisPersianAnalyzer` +# `AnalysisPersianAnalyzer` [interface-AnalysisPersianAnalyzer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisPersianNormalizationTokenFilter.md b/docs/reference/api/AnalysisPersianNormalizationTokenFilter.md index 85e247194..f64d5a9ba 100644 --- a/docs/reference/api/AnalysisPersianNormalizationTokenFilter.md +++ b/docs/reference/api/AnalysisPersianNormalizationTokenFilter.md @@ -1,4 +1,4 @@ -## Interface `AnalysisPersianNormalizationTokenFilter` +# `AnalysisPersianNormalizationTokenFilter` [interface-AnalysisPersianNormalizationTokenFilter] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisPhoneticEncoder.md b/docs/reference/api/AnalysisPhoneticEncoder.md index fa31086e6..ba18e0768 100644 --- a/docs/reference/api/AnalysisPhoneticEncoder.md +++ b/docs/reference/api/AnalysisPhoneticEncoder.md @@ -1,4 +1,4 @@ -## `AnalysisPhoneticEncoder` -::: +# `AnalysisPhoneticEncoder` [alias-AnalysisPhoneticEncoder] +```typescript type AnalysisPhoneticEncoder = 'metaphone' | 'double_metaphone' | 'soundex' | 'refined_soundex' | 'caverphone1' | 'caverphone2' | 'cologne' | 'nysiis' | 'koelnerphonetik' | 'haasephonetik' | 'beider_morse' | 'daitch_mokotoff'; -::: +``` diff --git a/docs/reference/api/AnalysisPhoneticLanguage.md b/docs/reference/api/AnalysisPhoneticLanguage.md index ff978d8da..2ba66cd07 100644 --- a/docs/reference/api/AnalysisPhoneticLanguage.md +++ b/docs/reference/api/AnalysisPhoneticLanguage.md @@ -1,4 +1,4 @@ -## `AnalysisPhoneticLanguage` -::: +# `AnalysisPhoneticLanguage` [alias-AnalysisPhoneticLanguage] +```typescript type AnalysisPhoneticLanguage = 'any' | 'common' | 'cyrillic' | 'english' | 'french' | 'german' | 'hebrew' | 'hungarian' | 'polish' | 'romanian' | 'russian' | 'spanish'; -::: +``` diff --git a/docs/reference/api/AnalysisPhoneticNameType.md b/docs/reference/api/AnalysisPhoneticNameType.md index 4f755d5f9..45a3a8994 100644 --- a/docs/reference/api/AnalysisPhoneticNameType.md +++ b/docs/reference/api/AnalysisPhoneticNameType.md @@ -1,4 +1,4 @@ -## `AnalysisPhoneticNameType` -::: +# `AnalysisPhoneticNameType` [alias-AnalysisPhoneticNameType] +```typescript type AnalysisPhoneticNameType = 'generic' | 'ashkenazi' | 'sephardic'; -::: +``` diff --git a/docs/reference/api/AnalysisPhoneticRuleType.md b/docs/reference/api/AnalysisPhoneticRuleType.md index 9d65dc339..6123240f5 100644 --- a/docs/reference/api/AnalysisPhoneticRuleType.md +++ b/docs/reference/api/AnalysisPhoneticRuleType.md @@ -1,4 +1,4 @@ -## `AnalysisPhoneticRuleType` -::: +# `AnalysisPhoneticRuleType` [alias-AnalysisPhoneticRuleType] +```typescript type AnalysisPhoneticRuleType = 'approx' | 'exact'; -::: +``` diff --git a/docs/reference/api/AnalysisPhoneticTokenFilter.md b/docs/reference/api/AnalysisPhoneticTokenFilter.md index 50d851929..50e72ad8e 100644 --- a/docs/reference/api/AnalysisPhoneticTokenFilter.md +++ b/docs/reference/api/AnalysisPhoneticTokenFilter.md @@ -1,4 +1,4 @@ -## Interface `AnalysisPhoneticTokenFilter` +# `AnalysisPhoneticTokenFilter` [interface-AnalysisPhoneticTokenFilter] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisPorterStemTokenFilter.md b/docs/reference/api/AnalysisPorterStemTokenFilter.md index fd624f980..2821238d0 100644 --- a/docs/reference/api/AnalysisPorterStemTokenFilter.md +++ b/docs/reference/api/AnalysisPorterStemTokenFilter.md @@ -1,4 +1,4 @@ -## Interface `AnalysisPorterStemTokenFilter` +# `AnalysisPorterStemTokenFilter` [interface-AnalysisPorterStemTokenFilter] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisPortugueseAnalyzer.md b/docs/reference/api/AnalysisPortugueseAnalyzer.md index e443bc953..73bb948a4 100644 --- a/docs/reference/api/AnalysisPortugueseAnalyzer.md +++ b/docs/reference/api/AnalysisPortugueseAnalyzer.md @@ -1,4 +1,4 @@ -## Interface `AnalysisPortugueseAnalyzer` +# `AnalysisPortugueseAnalyzer` [interface-AnalysisPortugueseAnalyzer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisPredicateTokenFilter.md b/docs/reference/api/AnalysisPredicateTokenFilter.md index b6c96c20f..59edcb6c7 100644 --- a/docs/reference/api/AnalysisPredicateTokenFilter.md +++ b/docs/reference/api/AnalysisPredicateTokenFilter.md @@ -1,4 +1,4 @@ -## Interface `AnalysisPredicateTokenFilter` +# `AnalysisPredicateTokenFilter` [interface-AnalysisPredicateTokenFilter] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisRemoveDuplicatesTokenFilter.md b/docs/reference/api/AnalysisRemoveDuplicatesTokenFilter.md index c115984cb..42c916a69 100644 --- a/docs/reference/api/AnalysisRemoveDuplicatesTokenFilter.md +++ b/docs/reference/api/AnalysisRemoveDuplicatesTokenFilter.md @@ -1,4 +1,4 @@ -## Interface `AnalysisRemoveDuplicatesTokenFilter` +# `AnalysisRemoveDuplicatesTokenFilter` [interface-AnalysisRemoveDuplicatesTokenFilter] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisReverseTokenFilter.md b/docs/reference/api/AnalysisReverseTokenFilter.md index dd73229f8..5bc93456f 100644 --- a/docs/reference/api/AnalysisReverseTokenFilter.md +++ b/docs/reference/api/AnalysisReverseTokenFilter.md @@ -1,4 +1,4 @@ -## Interface `AnalysisReverseTokenFilter` +# `AnalysisReverseTokenFilter` [interface-AnalysisReverseTokenFilter] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisRomanianAnalyzer.md b/docs/reference/api/AnalysisRomanianAnalyzer.md index 934a3c6ce..e518b763b 100644 --- a/docs/reference/api/AnalysisRomanianAnalyzer.md +++ b/docs/reference/api/AnalysisRomanianAnalyzer.md @@ -1,4 +1,4 @@ -## Interface `AnalysisRomanianAnalyzer` +# `AnalysisRomanianAnalyzer` [interface-AnalysisRomanianAnalyzer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisRussianAnalyzer.md b/docs/reference/api/AnalysisRussianAnalyzer.md index 17e6024f0..3748b421d 100644 --- a/docs/reference/api/AnalysisRussianAnalyzer.md +++ b/docs/reference/api/AnalysisRussianAnalyzer.md @@ -1,4 +1,4 @@ -## Interface `AnalysisRussianAnalyzer` +# `AnalysisRussianAnalyzer` [interface-AnalysisRussianAnalyzer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisScandinavianFoldingTokenFilter.md b/docs/reference/api/AnalysisScandinavianFoldingTokenFilter.md index 7742822f1..263b5ec97 100644 --- a/docs/reference/api/AnalysisScandinavianFoldingTokenFilter.md +++ b/docs/reference/api/AnalysisScandinavianFoldingTokenFilter.md @@ -1,4 +1,4 @@ -## Interface `AnalysisScandinavianFoldingTokenFilter` +# `AnalysisScandinavianFoldingTokenFilter` [interface-AnalysisScandinavianFoldingTokenFilter] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisScandinavianNormalizationTokenFilter.md b/docs/reference/api/AnalysisScandinavianNormalizationTokenFilter.md index 671679e34..80003eb7b 100644 --- a/docs/reference/api/AnalysisScandinavianNormalizationTokenFilter.md +++ b/docs/reference/api/AnalysisScandinavianNormalizationTokenFilter.md @@ -1,4 +1,4 @@ -## Interface `AnalysisScandinavianNormalizationTokenFilter` +# `AnalysisScandinavianNormalizationTokenFilter` [interface-AnalysisScandinavianNormalizationTokenFilter] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisSerbianAnalyzer.md b/docs/reference/api/AnalysisSerbianAnalyzer.md index db747314b..c42f56f6f 100644 --- a/docs/reference/api/AnalysisSerbianAnalyzer.md +++ b/docs/reference/api/AnalysisSerbianAnalyzer.md @@ -1,4 +1,4 @@ -## Interface `AnalysisSerbianAnalyzer` +# `AnalysisSerbianAnalyzer` [interface-AnalysisSerbianAnalyzer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisSerbianNormalizationTokenFilter.md b/docs/reference/api/AnalysisSerbianNormalizationTokenFilter.md index 2e18bcef5..d3351c6f7 100644 --- a/docs/reference/api/AnalysisSerbianNormalizationTokenFilter.md +++ b/docs/reference/api/AnalysisSerbianNormalizationTokenFilter.md @@ -1,4 +1,4 @@ -## Interface `AnalysisSerbianNormalizationTokenFilter` +# `AnalysisSerbianNormalizationTokenFilter` [interface-AnalysisSerbianNormalizationTokenFilter] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisShingleTokenFilter.md b/docs/reference/api/AnalysisShingleTokenFilter.md index 9141c184f..f90bf2cbd 100644 --- a/docs/reference/api/AnalysisShingleTokenFilter.md +++ b/docs/reference/api/AnalysisShingleTokenFilter.md @@ -1,4 +1,4 @@ -## Interface `AnalysisShingleTokenFilter` +# `AnalysisShingleTokenFilter` [interface-AnalysisShingleTokenFilter] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisSimpleAnalyzer.md b/docs/reference/api/AnalysisSimpleAnalyzer.md index 84f493fa7..52417929b 100644 --- a/docs/reference/api/AnalysisSimpleAnalyzer.md +++ b/docs/reference/api/AnalysisSimpleAnalyzer.md @@ -1,4 +1,4 @@ -## Interface `AnalysisSimpleAnalyzer` +# `AnalysisSimpleAnalyzer` [interface-AnalysisSimpleAnalyzer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisSimplePatternSplitTokenizer.md b/docs/reference/api/AnalysisSimplePatternSplitTokenizer.md index 706c4b107..e0c96559e 100644 --- a/docs/reference/api/AnalysisSimplePatternSplitTokenizer.md +++ b/docs/reference/api/AnalysisSimplePatternSplitTokenizer.md @@ -1,4 +1,4 @@ -## Interface `AnalysisSimplePatternSplitTokenizer` +# `AnalysisSimplePatternSplitTokenizer` [interface-AnalysisSimplePatternSplitTokenizer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisSimplePatternTokenizer.md b/docs/reference/api/AnalysisSimplePatternTokenizer.md index 100f2002c..d5c7b8070 100644 --- a/docs/reference/api/AnalysisSimplePatternTokenizer.md +++ b/docs/reference/api/AnalysisSimplePatternTokenizer.md @@ -1,4 +1,4 @@ -## Interface `AnalysisSimplePatternTokenizer` +# `AnalysisSimplePatternTokenizer` [interface-AnalysisSimplePatternTokenizer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisSnowballAnalyzer.md b/docs/reference/api/AnalysisSnowballAnalyzer.md index 68732f811..4c8c22ac9 100644 --- a/docs/reference/api/AnalysisSnowballAnalyzer.md +++ b/docs/reference/api/AnalysisSnowballAnalyzer.md @@ -1,4 +1,4 @@ -## Interface `AnalysisSnowballAnalyzer` +# `AnalysisSnowballAnalyzer` [interface-AnalysisSnowballAnalyzer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisSnowballLanguage.md b/docs/reference/api/AnalysisSnowballLanguage.md index eb0c04ce6..6c642fa9c 100644 --- a/docs/reference/api/AnalysisSnowballLanguage.md +++ b/docs/reference/api/AnalysisSnowballLanguage.md @@ -1,4 +1,4 @@ -## `AnalysisSnowballLanguage` -::: +# `AnalysisSnowballLanguage` [alias-AnalysisSnowballLanguage] +```typescript type AnalysisSnowballLanguage = 'Arabic' | 'Armenian' | 'Basque' | 'Catalan' | 'Danish' | 'Dutch' | 'English' | 'Estonian' | 'Finnish' | 'French' | 'German' | 'German2' | 'Hungarian' | 'Italian' | 'Irish' | 'Kp' | 'Lithuanian' | 'Lovins' | 'Norwegian' | 'Porter' | 'Portuguese' | 'Romanian' | 'Russian' | 'Serbian' | 'Spanish' | 'Swedish' | 'Turkish'; -::: +``` diff --git a/docs/reference/api/AnalysisSnowballTokenFilter.md b/docs/reference/api/AnalysisSnowballTokenFilter.md index 73a5f6b03..babbde309 100644 --- a/docs/reference/api/AnalysisSnowballTokenFilter.md +++ b/docs/reference/api/AnalysisSnowballTokenFilter.md @@ -1,4 +1,4 @@ -## Interface `AnalysisSnowballTokenFilter` +# `AnalysisSnowballTokenFilter` [interface-AnalysisSnowballTokenFilter] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisSoraniAnalyzer.md b/docs/reference/api/AnalysisSoraniAnalyzer.md index 40e8f423b..ae89e5db7 100644 --- a/docs/reference/api/AnalysisSoraniAnalyzer.md +++ b/docs/reference/api/AnalysisSoraniAnalyzer.md @@ -1,4 +1,4 @@ -## Interface `AnalysisSoraniAnalyzer` +# `AnalysisSoraniAnalyzer` [interface-AnalysisSoraniAnalyzer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisSoraniNormalizationTokenFilter.md b/docs/reference/api/AnalysisSoraniNormalizationTokenFilter.md index e8f0acdc6..bb884d09e 100644 --- a/docs/reference/api/AnalysisSoraniNormalizationTokenFilter.md +++ b/docs/reference/api/AnalysisSoraniNormalizationTokenFilter.md @@ -1,4 +1,4 @@ -## Interface `AnalysisSoraniNormalizationTokenFilter` +# `AnalysisSoraniNormalizationTokenFilter` [interface-AnalysisSoraniNormalizationTokenFilter] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisSpanishAnalyzer.md b/docs/reference/api/AnalysisSpanishAnalyzer.md index 7810da4e9..12006ee9d 100644 --- a/docs/reference/api/AnalysisSpanishAnalyzer.md +++ b/docs/reference/api/AnalysisSpanishAnalyzer.md @@ -1,4 +1,4 @@ -## Interface `AnalysisSpanishAnalyzer` +# `AnalysisSpanishAnalyzer` [interface-AnalysisSpanishAnalyzer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisStandardAnalyzer.md b/docs/reference/api/AnalysisStandardAnalyzer.md index 10d2a474c..ee82ae479 100644 --- a/docs/reference/api/AnalysisStandardAnalyzer.md +++ b/docs/reference/api/AnalysisStandardAnalyzer.md @@ -1,4 +1,4 @@ -## Interface `AnalysisStandardAnalyzer` +# `AnalysisStandardAnalyzer` [interface-AnalysisStandardAnalyzer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisStandardTokenizer.md b/docs/reference/api/AnalysisStandardTokenizer.md index 187e53cf0..648b702db 100644 --- a/docs/reference/api/AnalysisStandardTokenizer.md +++ b/docs/reference/api/AnalysisStandardTokenizer.md @@ -1,4 +1,4 @@ -## Interface `AnalysisStandardTokenizer` +# `AnalysisStandardTokenizer` [interface-AnalysisStandardTokenizer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisStemmerOverrideTokenFilter.md b/docs/reference/api/AnalysisStemmerOverrideTokenFilter.md index 270d5bc03..a7e837d8f 100644 --- a/docs/reference/api/AnalysisStemmerOverrideTokenFilter.md +++ b/docs/reference/api/AnalysisStemmerOverrideTokenFilter.md @@ -1,4 +1,4 @@ -## Interface `AnalysisStemmerOverrideTokenFilter` +# `AnalysisStemmerOverrideTokenFilter` [interface-AnalysisStemmerOverrideTokenFilter] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisStemmerTokenFilter.md b/docs/reference/api/AnalysisStemmerTokenFilter.md index 978edb06f..b9eb2fac2 100644 --- a/docs/reference/api/AnalysisStemmerTokenFilter.md +++ b/docs/reference/api/AnalysisStemmerTokenFilter.md @@ -1,4 +1,4 @@ -## Interface `AnalysisStemmerTokenFilter` +# `AnalysisStemmerTokenFilter` [interface-AnalysisStemmerTokenFilter] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisStopAnalyzer.md b/docs/reference/api/AnalysisStopAnalyzer.md index 7e5ad6d24..3ae3bcebb 100644 --- a/docs/reference/api/AnalysisStopAnalyzer.md +++ b/docs/reference/api/AnalysisStopAnalyzer.md @@ -1,4 +1,4 @@ -## Interface `AnalysisStopAnalyzer` +# `AnalysisStopAnalyzer` [interface-AnalysisStopAnalyzer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisStopTokenFilter.md b/docs/reference/api/AnalysisStopTokenFilter.md index 26c86ef32..ee6fadf30 100644 --- a/docs/reference/api/AnalysisStopTokenFilter.md +++ b/docs/reference/api/AnalysisStopTokenFilter.md @@ -1,4 +1,4 @@ -## Interface `AnalysisStopTokenFilter` +# `AnalysisStopTokenFilter` [interface-AnalysisStopTokenFilter] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisStopWordLanguage.md b/docs/reference/api/AnalysisStopWordLanguage.md index 330a7609d..bae9c2e6b 100644 --- a/docs/reference/api/AnalysisStopWordLanguage.md +++ b/docs/reference/api/AnalysisStopWordLanguage.md @@ -1,4 +1,4 @@ -## `AnalysisStopWordLanguage` -::: +# `AnalysisStopWordLanguage` [alias-AnalysisStopWordLanguage] +```typescript type AnalysisStopWordLanguage = '_arabic_' | '_armenian_' | '_basque_' | '_bengali_' | '_brazilian_' | '_bulgarian_' | '_catalan_' | '_cjk_' | '_czech_' | '_danish_' | '_dutch_' | '_english_' | '_estonian_' | '_finnish_' | '_french_' | '_galician_' | '_german_' | '_greek_' | '_hindi_' | '_hungarian_' | '_indonesian_' | '_irish_' | '_italian_' | '_latvian_' | '_lithuanian_' | '_norwegian_' | '_persian_' | '_portuguese_' | '_romanian_' | '_russian_' | '_serbian_' | '_sorani_' | '_spanish_' | '_swedish_' | '_thai_' | '_turkish_' | '_none_'; -::: +``` diff --git a/docs/reference/api/AnalysisStopWords.md b/docs/reference/api/AnalysisStopWords.md index 7f9d7fa3e..5afd97784 100644 --- a/docs/reference/api/AnalysisStopWords.md +++ b/docs/reference/api/AnalysisStopWords.md @@ -1,4 +1,4 @@ -## `AnalysisStopWords` -::: +# `AnalysisStopWords` [alias-AnalysisStopWords] +```typescript type AnalysisStopWords = [AnalysisStopWordLanguage](./AnalysisStopWordLanguage.md) | string[]; -::: +``` diff --git a/docs/reference/api/AnalysisSwedishAnalyzer.md b/docs/reference/api/AnalysisSwedishAnalyzer.md index 86e4301c1..49de8dda8 100644 --- a/docs/reference/api/AnalysisSwedishAnalyzer.md +++ b/docs/reference/api/AnalysisSwedishAnalyzer.md @@ -1,4 +1,4 @@ -## Interface `AnalysisSwedishAnalyzer` +# `AnalysisSwedishAnalyzer` [interface-AnalysisSwedishAnalyzer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisSynonymFormat.md b/docs/reference/api/AnalysisSynonymFormat.md index ca6ac77ae..53fccc418 100644 --- a/docs/reference/api/AnalysisSynonymFormat.md +++ b/docs/reference/api/AnalysisSynonymFormat.md @@ -1,4 +1,4 @@ -## `AnalysisSynonymFormat` -::: +# `AnalysisSynonymFormat` [alias-AnalysisSynonymFormat] +```typescript type AnalysisSynonymFormat = 'solr' | 'wordnet'; -::: +``` diff --git a/docs/reference/api/AnalysisSynonymGraphTokenFilter.md b/docs/reference/api/AnalysisSynonymGraphTokenFilter.md index f976e4480..77af0cd45 100644 --- a/docs/reference/api/AnalysisSynonymGraphTokenFilter.md +++ b/docs/reference/api/AnalysisSynonymGraphTokenFilter.md @@ -1,4 +1,4 @@ -## Interface `AnalysisSynonymGraphTokenFilter` +# `AnalysisSynonymGraphTokenFilter` [interface-AnalysisSynonymGraphTokenFilter] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisSynonymTokenFilter.md b/docs/reference/api/AnalysisSynonymTokenFilter.md index abce4c672..a241f5082 100644 --- a/docs/reference/api/AnalysisSynonymTokenFilter.md +++ b/docs/reference/api/AnalysisSynonymTokenFilter.md @@ -1,4 +1,4 @@ -## Interface `AnalysisSynonymTokenFilter` +# `AnalysisSynonymTokenFilter` [interface-AnalysisSynonymTokenFilter] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisSynonymTokenFilterBase.md b/docs/reference/api/AnalysisSynonymTokenFilterBase.md index 1049f75ef..18980cdee 100644 --- a/docs/reference/api/AnalysisSynonymTokenFilterBase.md +++ b/docs/reference/api/AnalysisSynonymTokenFilterBase.md @@ -1,4 +1,4 @@ -## Interface `AnalysisSynonymTokenFilterBase` +# `AnalysisSynonymTokenFilterBase` [interface-AnalysisSynonymTokenFilterBase] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisThaiAnalyzer.md b/docs/reference/api/AnalysisThaiAnalyzer.md index 8e9dc4f56..1e3481a67 100644 --- a/docs/reference/api/AnalysisThaiAnalyzer.md +++ b/docs/reference/api/AnalysisThaiAnalyzer.md @@ -1,4 +1,4 @@ -## Interface `AnalysisThaiAnalyzer` +# `AnalysisThaiAnalyzer` [interface-AnalysisThaiAnalyzer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisThaiTokenizer.md b/docs/reference/api/AnalysisThaiTokenizer.md index 2a54cc01d..2c691a92f 100644 --- a/docs/reference/api/AnalysisThaiTokenizer.md +++ b/docs/reference/api/AnalysisThaiTokenizer.md @@ -1,4 +1,4 @@ -## Interface `AnalysisThaiTokenizer` +# `AnalysisThaiTokenizer` [interface-AnalysisThaiTokenizer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisTokenChar.md b/docs/reference/api/AnalysisTokenChar.md index 12d9d3cb7..add7b034d 100644 --- a/docs/reference/api/AnalysisTokenChar.md +++ b/docs/reference/api/AnalysisTokenChar.md @@ -1,4 +1,4 @@ -## `AnalysisTokenChar` -::: +# `AnalysisTokenChar` [alias-AnalysisTokenChar] +```typescript type AnalysisTokenChar = 'letter' | 'digit' | 'whitespace' | 'punctuation' | 'symbol' | 'custom'; -::: +``` diff --git a/docs/reference/api/AnalysisTokenFilter.md b/docs/reference/api/AnalysisTokenFilter.md index 7a643b4c3..7f7c97126 100644 --- a/docs/reference/api/AnalysisTokenFilter.md +++ b/docs/reference/api/AnalysisTokenFilter.md @@ -1,4 +1,4 @@ -## `AnalysisTokenFilter` -::: +# `AnalysisTokenFilter` [alias-AnalysisTokenFilter] +```typescript type AnalysisTokenFilter = string | [AnalysisTokenFilterDefinition](./AnalysisTokenFilterDefinition.md); -::: +``` diff --git a/docs/reference/api/AnalysisTokenFilterBase.md b/docs/reference/api/AnalysisTokenFilterBase.md index 50128e97c..8d1ab80c0 100644 --- a/docs/reference/api/AnalysisTokenFilterBase.md +++ b/docs/reference/api/AnalysisTokenFilterBase.md @@ -1,4 +1,4 @@ -## Interface `AnalysisTokenFilterBase` +# `AnalysisTokenFilterBase` [interface-AnalysisTokenFilterBase] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisTokenFilterDefinition.md b/docs/reference/api/AnalysisTokenFilterDefinition.md index cb6967659..7f7f1bb05 100644 --- a/docs/reference/api/AnalysisTokenFilterDefinition.md +++ b/docs/reference/api/AnalysisTokenFilterDefinition.md @@ -1,4 +1,4 @@ -## `AnalysisTokenFilterDefinition` -::: +# `AnalysisTokenFilterDefinition` [alias-AnalysisTokenFilterDefinition] +```typescript type AnalysisTokenFilterDefinition = [AnalysisApostropheTokenFilter](./AnalysisApostropheTokenFilter.md) | [AnalysisArabicNormalizationTokenFilter](./AnalysisArabicNormalizationTokenFilter.md) | [AnalysisAsciiFoldingTokenFilter](./AnalysisAsciiFoldingTokenFilter.md) | [AnalysisCjkBigramTokenFilter](./AnalysisCjkBigramTokenFilter.md) | [AnalysisCjkWidthTokenFilter](./AnalysisCjkWidthTokenFilter.md) | [AnalysisClassicTokenFilter](./AnalysisClassicTokenFilter.md) | [AnalysisCommonGramsTokenFilter](./AnalysisCommonGramsTokenFilter.md) | [AnalysisConditionTokenFilter](./AnalysisConditionTokenFilter.md) | [AnalysisDecimalDigitTokenFilter](./AnalysisDecimalDigitTokenFilter.md) | [AnalysisDelimitedPayloadTokenFilter](./AnalysisDelimitedPayloadTokenFilter.md) | [AnalysisEdgeNGramTokenFilter](./AnalysisEdgeNGramTokenFilter.md) | [AnalysisElisionTokenFilter](./AnalysisElisionTokenFilter.md) | [AnalysisFingerprintTokenFilter](./AnalysisFingerprintTokenFilter.md) | [AnalysisFlattenGraphTokenFilter](./AnalysisFlattenGraphTokenFilter.md) | [AnalysisGermanNormalizationTokenFilter](./AnalysisGermanNormalizationTokenFilter.md) | [AnalysisHindiNormalizationTokenFilter](./AnalysisHindiNormalizationTokenFilter.md) | [AnalysisHunspellTokenFilter](./AnalysisHunspellTokenFilter.md) | [AnalysisHyphenationDecompounderTokenFilter](./AnalysisHyphenationDecompounderTokenFilter.md) | [AnalysisIndicNormalizationTokenFilter](./AnalysisIndicNormalizationTokenFilter.md) | [AnalysisKeepTypesTokenFilter](./AnalysisKeepTypesTokenFilter.md) | [AnalysisKeepWordsTokenFilter](./AnalysisKeepWordsTokenFilter.md) | [AnalysisKeywordMarkerTokenFilter](./AnalysisKeywordMarkerTokenFilter.md) | [AnalysisKeywordRepeatTokenFilter](./AnalysisKeywordRepeatTokenFilter.md) | [AnalysisKStemTokenFilter](./AnalysisKStemTokenFilter.md) | [AnalysisLengthTokenFilter](./AnalysisLengthTokenFilter.md) | [AnalysisLimitTokenCountTokenFilter](./AnalysisLimitTokenCountTokenFilter.md) | [AnalysisLowercaseTokenFilter](./AnalysisLowercaseTokenFilter.md) | [AnalysisMinHashTokenFilter](./AnalysisMinHashTokenFilter.md) | [AnalysisMultiplexerTokenFilter](./AnalysisMultiplexerTokenFilter.md) | [AnalysisNGramTokenFilter](./AnalysisNGramTokenFilter.md) | [AnalysisNoriPartOfSpeechTokenFilter](./AnalysisNoriPartOfSpeechTokenFilter.md) | [AnalysisPatternCaptureTokenFilter](./AnalysisPatternCaptureTokenFilter.md) | [AnalysisPatternReplaceTokenFilter](./AnalysisPatternReplaceTokenFilter.md) | [AnalysisPersianNormalizationTokenFilter](./AnalysisPersianNormalizationTokenFilter.md) | [AnalysisPorterStemTokenFilter](./AnalysisPorterStemTokenFilter.md) | [AnalysisPredicateTokenFilter](./AnalysisPredicateTokenFilter.md) | [AnalysisRemoveDuplicatesTokenFilter](./AnalysisRemoveDuplicatesTokenFilter.md) | [AnalysisReverseTokenFilter](./AnalysisReverseTokenFilter.md) | [AnalysisScandinavianFoldingTokenFilter](./AnalysisScandinavianFoldingTokenFilter.md) | [AnalysisScandinavianNormalizationTokenFilter](./AnalysisScandinavianNormalizationTokenFilter.md) | [AnalysisSerbianNormalizationTokenFilter](./AnalysisSerbianNormalizationTokenFilter.md) | [AnalysisShingleTokenFilter](./AnalysisShingleTokenFilter.md) | [AnalysisSnowballTokenFilter](./AnalysisSnowballTokenFilter.md) | [AnalysisSoraniNormalizationTokenFilter](./AnalysisSoraniNormalizationTokenFilter.md) | [AnalysisStemmerOverrideTokenFilter](./AnalysisStemmerOverrideTokenFilter.md) | [AnalysisStemmerTokenFilter](./AnalysisStemmerTokenFilter.md) | [AnalysisStopTokenFilter](./AnalysisStopTokenFilter.md) | [AnalysisSynonymGraphTokenFilter](./AnalysisSynonymGraphTokenFilter.md) | [AnalysisSynonymTokenFilter](./AnalysisSynonymTokenFilter.md) | [AnalysisTrimTokenFilter](./AnalysisTrimTokenFilter.md) | [AnalysisTruncateTokenFilter](./AnalysisTruncateTokenFilter.md) | [AnalysisUniqueTokenFilter](./AnalysisUniqueTokenFilter.md) | [AnalysisUppercaseTokenFilter](./AnalysisUppercaseTokenFilter.md) | [AnalysisWordDelimiterGraphTokenFilter](./AnalysisWordDelimiterGraphTokenFilter.md) | [AnalysisWordDelimiterTokenFilter](./AnalysisWordDelimiterTokenFilter.md) | [AnalysisJaStopTokenFilter](./AnalysisJaStopTokenFilter.md) | [AnalysisKuromojiStemmerTokenFilter](./AnalysisKuromojiStemmerTokenFilter.md) | [AnalysisKuromojiReadingFormTokenFilter](./AnalysisKuromojiReadingFormTokenFilter.md) | [AnalysisKuromojiPartOfSpeechTokenFilter](./AnalysisKuromojiPartOfSpeechTokenFilter.md) | [AnalysisIcuCollationTokenFilter](./AnalysisIcuCollationTokenFilter.md) | [AnalysisIcuFoldingTokenFilter](./AnalysisIcuFoldingTokenFilter.md) | [AnalysisIcuNormalizationTokenFilter](./AnalysisIcuNormalizationTokenFilter.md) | [AnalysisIcuTransformTokenFilter](./AnalysisIcuTransformTokenFilter.md) | [AnalysisPhoneticTokenFilter](./AnalysisPhoneticTokenFilter.md) | [AnalysisDictionaryDecompounderTokenFilter](./AnalysisDictionaryDecompounderTokenFilter.md); -::: +``` diff --git a/docs/reference/api/AnalysisTokenizer.md b/docs/reference/api/AnalysisTokenizer.md index e58b579f7..525abc499 100644 --- a/docs/reference/api/AnalysisTokenizer.md +++ b/docs/reference/api/AnalysisTokenizer.md @@ -1,4 +1,4 @@ -## `AnalysisTokenizer` -::: +# `AnalysisTokenizer` [alias-AnalysisTokenizer] +```typescript type AnalysisTokenizer = string | [AnalysisTokenizerDefinition](./AnalysisTokenizerDefinition.md); -::: +``` diff --git a/docs/reference/api/AnalysisTokenizerBase.md b/docs/reference/api/AnalysisTokenizerBase.md index aa56f40c6..f23afebb7 100644 --- a/docs/reference/api/AnalysisTokenizerBase.md +++ b/docs/reference/api/AnalysisTokenizerBase.md @@ -1,4 +1,4 @@ -## Interface `AnalysisTokenizerBase` +# `AnalysisTokenizerBase` [interface-AnalysisTokenizerBase] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisTokenizerDefinition.md b/docs/reference/api/AnalysisTokenizerDefinition.md index b1ccf089a..89de97b99 100644 --- a/docs/reference/api/AnalysisTokenizerDefinition.md +++ b/docs/reference/api/AnalysisTokenizerDefinition.md @@ -1,4 +1,4 @@ -## `AnalysisTokenizerDefinition` -::: +# `AnalysisTokenizerDefinition` [alias-AnalysisTokenizerDefinition] +```typescript type AnalysisTokenizerDefinition = [AnalysisCharGroupTokenizer](./AnalysisCharGroupTokenizer.md) | [AnalysisClassicTokenizer](./AnalysisClassicTokenizer.md) | [AnalysisEdgeNGramTokenizer](./AnalysisEdgeNGramTokenizer.md) | [AnalysisKeywordTokenizer](./AnalysisKeywordTokenizer.md) | [AnalysisLetterTokenizer](./AnalysisLetterTokenizer.md) | [AnalysisLowercaseTokenizer](./AnalysisLowercaseTokenizer.md) | [AnalysisNGramTokenizer](./AnalysisNGramTokenizer.md) | [AnalysisPathHierarchyTokenizer](./AnalysisPathHierarchyTokenizer.md) | [AnalysisPatternTokenizer](./AnalysisPatternTokenizer.md) | [AnalysisSimplePatternTokenizer](./AnalysisSimplePatternTokenizer.md) | [AnalysisSimplePatternSplitTokenizer](./AnalysisSimplePatternSplitTokenizer.md) | [AnalysisStandardTokenizer](./AnalysisStandardTokenizer.md) | [AnalysisThaiTokenizer](./AnalysisThaiTokenizer.md) | [AnalysisUaxEmailUrlTokenizer](./AnalysisUaxEmailUrlTokenizer.md) | [AnalysisWhitespaceTokenizer](./AnalysisWhitespaceTokenizer.md) | [AnalysisIcuTokenizer](./AnalysisIcuTokenizer.md) | [AnalysisKuromojiTokenizer](./AnalysisKuromojiTokenizer.md) | [AnalysisNoriTokenizer](./AnalysisNoriTokenizer.md); -::: +``` diff --git a/docs/reference/api/AnalysisTrimTokenFilter.md b/docs/reference/api/AnalysisTrimTokenFilter.md index 5710e7eca..df6da1eaa 100644 --- a/docs/reference/api/AnalysisTrimTokenFilter.md +++ b/docs/reference/api/AnalysisTrimTokenFilter.md @@ -1,4 +1,4 @@ -## Interface `AnalysisTrimTokenFilter` +# `AnalysisTrimTokenFilter` [interface-AnalysisTrimTokenFilter] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisTruncateTokenFilter.md b/docs/reference/api/AnalysisTruncateTokenFilter.md index bcd8dcc8d..84a5ed904 100644 --- a/docs/reference/api/AnalysisTruncateTokenFilter.md +++ b/docs/reference/api/AnalysisTruncateTokenFilter.md @@ -1,4 +1,4 @@ -## Interface `AnalysisTruncateTokenFilter` +# `AnalysisTruncateTokenFilter` [interface-AnalysisTruncateTokenFilter] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisTurkishAnalyzer.md b/docs/reference/api/AnalysisTurkishAnalyzer.md index 6a7c7def0..abd5ddadb 100644 --- a/docs/reference/api/AnalysisTurkishAnalyzer.md +++ b/docs/reference/api/AnalysisTurkishAnalyzer.md @@ -1,4 +1,4 @@ -## Interface `AnalysisTurkishAnalyzer` +# `AnalysisTurkishAnalyzer` [interface-AnalysisTurkishAnalyzer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisUaxEmailUrlTokenizer.md b/docs/reference/api/AnalysisUaxEmailUrlTokenizer.md index 4ebe87e3c..2e8f2364f 100644 --- a/docs/reference/api/AnalysisUaxEmailUrlTokenizer.md +++ b/docs/reference/api/AnalysisUaxEmailUrlTokenizer.md @@ -1,4 +1,4 @@ -## Interface `AnalysisUaxEmailUrlTokenizer` +# `AnalysisUaxEmailUrlTokenizer` [interface-AnalysisUaxEmailUrlTokenizer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisUniqueTokenFilter.md b/docs/reference/api/AnalysisUniqueTokenFilter.md index 7af8d753f..96b49d8d5 100644 --- a/docs/reference/api/AnalysisUniqueTokenFilter.md +++ b/docs/reference/api/AnalysisUniqueTokenFilter.md @@ -1,4 +1,4 @@ -## Interface `AnalysisUniqueTokenFilter` +# `AnalysisUniqueTokenFilter` [interface-AnalysisUniqueTokenFilter] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisUppercaseTokenFilter.md b/docs/reference/api/AnalysisUppercaseTokenFilter.md index 0c98b42ae..618a6460c 100644 --- a/docs/reference/api/AnalysisUppercaseTokenFilter.md +++ b/docs/reference/api/AnalysisUppercaseTokenFilter.md @@ -1,4 +1,4 @@ -## Interface `AnalysisUppercaseTokenFilter` +# `AnalysisUppercaseTokenFilter` [interface-AnalysisUppercaseTokenFilter] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisWhitespaceAnalyzer.md b/docs/reference/api/AnalysisWhitespaceAnalyzer.md index 44591f5f7..716d65832 100644 --- a/docs/reference/api/AnalysisWhitespaceAnalyzer.md +++ b/docs/reference/api/AnalysisWhitespaceAnalyzer.md @@ -1,4 +1,4 @@ -## Interface `AnalysisWhitespaceAnalyzer` +# `AnalysisWhitespaceAnalyzer` [interface-AnalysisWhitespaceAnalyzer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisWhitespaceTokenizer.md b/docs/reference/api/AnalysisWhitespaceTokenizer.md index 8e88297e1..7ccf5f68e 100644 --- a/docs/reference/api/AnalysisWhitespaceTokenizer.md +++ b/docs/reference/api/AnalysisWhitespaceTokenizer.md @@ -1,4 +1,4 @@ -## Interface `AnalysisWhitespaceTokenizer` +# `AnalysisWhitespaceTokenizer` [interface-AnalysisWhitespaceTokenizer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisWordDelimiterGraphTokenFilter.md b/docs/reference/api/AnalysisWordDelimiterGraphTokenFilter.md index 11ad43457..6876ffbcf 100644 --- a/docs/reference/api/AnalysisWordDelimiterGraphTokenFilter.md +++ b/docs/reference/api/AnalysisWordDelimiterGraphTokenFilter.md @@ -1,4 +1,4 @@ -## Interface `AnalysisWordDelimiterGraphTokenFilter` +# `AnalysisWordDelimiterGraphTokenFilter` [interface-AnalysisWordDelimiterGraphTokenFilter] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisWordDelimiterTokenFilter.md b/docs/reference/api/AnalysisWordDelimiterTokenFilter.md index 2b4e75666..4fafe24ed 100644 --- a/docs/reference/api/AnalysisWordDelimiterTokenFilter.md +++ b/docs/reference/api/AnalysisWordDelimiterTokenFilter.md @@ -1,4 +1,4 @@ -## Interface `AnalysisWordDelimiterTokenFilter` +# `AnalysisWordDelimiterTokenFilter` [interface-AnalysisWordDelimiterTokenFilter] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AnalysisWordDelimiterTokenFilterBase.md b/docs/reference/api/AnalysisWordDelimiterTokenFilterBase.md index 694ffe351..ef08e6382 100644 --- a/docs/reference/api/AnalysisWordDelimiterTokenFilterBase.md +++ b/docs/reference/api/AnalysisWordDelimiterTokenFilterBase.md @@ -1,4 +1,4 @@ -## Interface `AnalysisWordDelimiterTokenFilterBase` +# `AnalysisWordDelimiterTokenFilterBase` [interface-AnalysisWordDelimiterTokenFilterBase] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AsyncSearch.md b/docs/reference/api/AsyncSearch.md index 7f8ad603c..4fc042329 100644 --- a/docs/reference/api/AsyncSearch.md +++ b/docs/reference/api/AsyncSearch.md @@ -1,19 +1,19 @@ -## `AsyncSearch` +# `AsyncSearch` [class-AsyncSearch] -### Constructor +## Constructor -::: +```typescript new AsyncSearch(transport: [Transport](./Transport.md)); -::: +``` -### Properties +## Properties [class-properties-AsyncSearch] | Name | Type | Description | | - | - | - | | `acceptedParams` | Record |   | | `transport` | [Transport](./Transport.md) |   | -### Methods +## Methods [class-methods-AsyncSearch] | Name | Signature | Description | | - | - | - | diff --git a/docs/reference/api/AsyncSearchAsyncSearch.md b/docs/reference/api/AsyncSearchAsyncSearch.md index b5f8dd8ce..178e44522 100644 --- a/docs/reference/api/AsyncSearchAsyncSearch.md +++ b/docs/reference/api/AsyncSearchAsyncSearch.md @@ -1,4 +1,4 @@ -## Interface `AsyncSearchAsyncSearch` +# `AsyncSearchAsyncSearch` [interface-AsyncSearchAsyncSearch] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AsyncSearchAsyncSearchDocumentResponseBase.md b/docs/reference/api/AsyncSearchAsyncSearchDocumentResponseBase.md index b0f1ac3a1..ecfb0a3c3 100644 --- a/docs/reference/api/AsyncSearchAsyncSearchDocumentResponseBase.md +++ b/docs/reference/api/AsyncSearchAsyncSearchDocumentResponseBase.md @@ -1,4 +1,4 @@ -## Interface `AsyncSearchAsyncSearchDocumentResponseBase` +# `AsyncSearchAsyncSearchDocumentResponseBase` [interface-AsyncSearchAsyncSearchDocumentResponseBase] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AsyncSearchAsyncSearchResponseBase.md b/docs/reference/api/AsyncSearchAsyncSearchResponseBase.md index a52268c55..dd9fd0dc2 100644 --- a/docs/reference/api/AsyncSearchAsyncSearchResponseBase.md +++ b/docs/reference/api/AsyncSearchAsyncSearchResponseBase.md @@ -1,4 +1,4 @@ -## Interface `AsyncSearchAsyncSearchResponseBase` +# `AsyncSearchAsyncSearchResponseBase` [interface-AsyncSearchAsyncSearchResponseBase] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AsyncSearchDeleteRequest.md b/docs/reference/api/AsyncSearchDeleteRequest.md index ef6cf0679..00e745c0f 100644 --- a/docs/reference/api/AsyncSearchDeleteRequest.md +++ b/docs/reference/api/AsyncSearchDeleteRequest.md @@ -1,4 +1,4 @@ -## Interface `AsyncSearchDeleteRequest` +# `AsyncSearchDeleteRequest` [interface-AsyncSearchDeleteRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AsyncSearchDeleteResponse.md b/docs/reference/api/AsyncSearchDeleteResponse.md index 67e2ecf96..414c77a2e 100644 --- a/docs/reference/api/AsyncSearchDeleteResponse.md +++ b/docs/reference/api/AsyncSearchDeleteResponse.md @@ -1,4 +1,4 @@ -## `AsyncSearchDeleteResponse` -::: +# `AsyncSearchDeleteResponse` [alias-AsyncSearchDeleteResponse] +```typescript type AsyncSearchDeleteResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); -::: +``` diff --git a/docs/reference/api/AsyncSearchGetRequest.md b/docs/reference/api/AsyncSearchGetRequest.md index 2d3619686..7c6310f3c 100644 --- a/docs/reference/api/AsyncSearchGetRequest.md +++ b/docs/reference/api/AsyncSearchGetRequest.md @@ -1,4 +1,4 @@ -## Interface `AsyncSearchGetRequest` +# `AsyncSearchGetRequest` [interface-AsyncSearchGetRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AsyncSearchGetResponse.md b/docs/reference/api/AsyncSearchGetResponse.md index 4d1794ac1..f3441f0da 100644 --- a/docs/reference/api/AsyncSearchGetResponse.md +++ b/docs/reference/api/AsyncSearchGetResponse.md @@ -1,4 +1,4 @@ -## `AsyncSearchGetResponse` -::: +# `AsyncSearchGetResponse` [alias-AsyncSearchGetResponse] +```typescript type AsyncSearchGetResponse> = [AsyncSearchAsyncSearchDocumentResponseBase](./AsyncSearchAsyncSearchDocumentResponseBase.md); -::: +``` diff --git a/docs/reference/api/AsyncSearchStatusRequest.md b/docs/reference/api/AsyncSearchStatusRequest.md index 53281c5ea..46a8a7ef1 100644 --- a/docs/reference/api/AsyncSearchStatusRequest.md +++ b/docs/reference/api/AsyncSearchStatusRequest.md @@ -1,4 +1,4 @@ -## Interface `AsyncSearchStatusRequest` +# `AsyncSearchStatusRequest` [interface-AsyncSearchStatusRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AsyncSearchStatusResponse.md b/docs/reference/api/AsyncSearchStatusResponse.md index f803a49f9..c24937295 100644 --- a/docs/reference/api/AsyncSearchStatusResponse.md +++ b/docs/reference/api/AsyncSearchStatusResponse.md @@ -1,4 +1,4 @@ -## `AsyncSearchStatusResponse` -::: +# `AsyncSearchStatusResponse` [alias-AsyncSearchStatusResponse] +```typescript type AsyncSearchStatusResponse = [AsyncSearchStatusStatusResponseBase](./AsyncSearchStatusStatusResponseBase.md); -::: +``` diff --git a/docs/reference/api/AsyncSearchStatusStatusResponseBase.md b/docs/reference/api/AsyncSearchStatusStatusResponseBase.md index 4a371f062..e0fb0a2fb 100644 --- a/docs/reference/api/AsyncSearchStatusStatusResponseBase.md +++ b/docs/reference/api/AsyncSearchStatusStatusResponseBase.md @@ -1,4 +1,4 @@ -## Interface `AsyncSearchStatusStatusResponseBase` +# `AsyncSearchStatusStatusResponseBase` [interface-AsyncSearchStatusStatusResponseBase] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AsyncSearchSubmitRequest.md b/docs/reference/api/AsyncSearchSubmitRequest.md index 63d95b6af..dd7b2db39 100644 --- a/docs/reference/api/AsyncSearchSubmitRequest.md +++ b/docs/reference/api/AsyncSearchSubmitRequest.md @@ -1,4 +1,4 @@ -## Interface `AsyncSearchSubmitRequest` +# `AsyncSearchSubmitRequest` [interface-AsyncSearchSubmitRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AsyncSearchSubmitResponse.md b/docs/reference/api/AsyncSearchSubmitResponse.md index dbf472039..a356fa341 100644 --- a/docs/reference/api/AsyncSearchSubmitResponse.md +++ b/docs/reference/api/AsyncSearchSubmitResponse.md @@ -1,4 +1,4 @@ -## `AsyncSearchSubmitResponse` -::: +# `AsyncSearchSubmitResponse` [alias-AsyncSearchSubmitResponse] +```typescript type AsyncSearchSubmitResponse> = [AsyncSearchAsyncSearchDocumentResponseBase](./AsyncSearchAsyncSearchDocumentResponseBase.md); -::: +``` diff --git a/docs/reference/api/Autoscaling.md b/docs/reference/api/Autoscaling.md index 8de1cbd47..33dbbbfef 100644 --- a/docs/reference/api/Autoscaling.md +++ b/docs/reference/api/Autoscaling.md @@ -1,19 +1,19 @@ -## `Autoscaling` +# `Autoscaling` [class-Autoscaling] -### Constructor +## Constructor -::: +```typescript new Autoscaling(transport: [Transport](./Transport.md)); -::: +``` -### Properties +## Properties [class-properties-Autoscaling] | Name | Type | Description | | - | - | - | | `acceptedParams` | Record |   | | `transport` | [Transport](./Transport.md) |   | -### Methods +## Methods [class-methods-Autoscaling] | Name | Signature | Description | | - | - | - | diff --git a/docs/reference/api/AutoscalingAutoscalingPolicy.md b/docs/reference/api/AutoscalingAutoscalingPolicy.md index 634c2fa7b..169b1ee12 100644 --- a/docs/reference/api/AutoscalingAutoscalingPolicy.md +++ b/docs/reference/api/AutoscalingAutoscalingPolicy.md @@ -1,4 +1,4 @@ -## Interface `AutoscalingAutoscalingPolicy` +# `AutoscalingAutoscalingPolicy` [interface-AutoscalingAutoscalingPolicy] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AutoscalingDeleteAutoscalingPolicyRequest.md b/docs/reference/api/AutoscalingDeleteAutoscalingPolicyRequest.md index c35fe2bcf..3986660d8 100644 --- a/docs/reference/api/AutoscalingDeleteAutoscalingPolicyRequest.md +++ b/docs/reference/api/AutoscalingDeleteAutoscalingPolicyRequest.md @@ -1,4 +1,4 @@ -## Interface `AutoscalingDeleteAutoscalingPolicyRequest` +# `AutoscalingDeleteAutoscalingPolicyRequest` [interface-AutoscalingDeleteAutoscalingPolicyRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AutoscalingDeleteAutoscalingPolicyResponse.md b/docs/reference/api/AutoscalingDeleteAutoscalingPolicyResponse.md index 76b1a88e6..be01dc3fe 100644 --- a/docs/reference/api/AutoscalingDeleteAutoscalingPolicyResponse.md +++ b/docs/reference/api/AutoscalingDeleteAutoscalingPolicyResponse.md @@ -1,4 +1,4 @@ -## `AutoscalingDeleteAutoscalingPolicyResponse` -::: +# `AutoscalingDeleteAutoscalingPolicyResponse` [alias-AutoscalingDeleteAutoscalingPolicyResponse] +```typescript type AutoscalingDeleteAutoscalingPolicyResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); -::: +``` diff --git a/docs/reference/api/AutoscalingGetAutoscalingCapacityAutoscalingCapacity.md b/docs/reference/api/AutoscalingGetAutoscalingCapacityAutoscalingCapacity.md index 2b63d6329..fd1c70d58 100644 --- a/docs/reference/api/AutoscalingGetAutoscalingCapacityAutoscalingCapacity.md +++ b/docs/reference/api/AutoscalingGetAutoscalingCapacityAutoscalingCapacity.md @@ -1,4 +1,4 @@ -## Interface `AutoscalingGetAutoscalingCapacityAutoscalingCapacity` +# `AutoscalingGetAutoscalingCapacityAutoscalingCapacity` [interface-AutoscalingGetAutoscalingCapacityAutoscalingCapacity] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AutoscalingGetAutoscalingCapacityAutoscalingDecider.md b/docs/reference/api/AutoscalingGetAutoscalingCapacityAutoscalingDecider.md index 6c1b23a2c..16474b4dc 100644 --- a/docs/reference/api/AutoscalingGetAutoscalingCapacityAutoscalingDecider.md +++ b/docs/reference/api/AutoscalingGetAutoscalingCapacityAutoscalingDecider.md @@ -1,4 +1,4 @@ -## Interface `AutoscalingGetAutoscalingCapacityAutoscalingDecider` +# `AutoscalingGetAutoscalingCapacityAutoscalingDecider` [interface-AutoscalingGetAutoscalingCapacityAutoscalingDecider] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AutoscalingGetAutoscalingCapacityAutoscalingDeciders.md b/docs/reference/api/AutoscalingGetAutoscalingCapacityAutoscalingDeciders.md index 0b0d9eb35..bc6159e43 100644 --- a/docs/reference/api/AutoscalingGetAutoscalingCapacityAutoscalingDeciders.md +++ b/docs/reference/api/AutoscalingGetAutoscalingCapacityAutoscalingDeciders.md @@ -1,4 +1,4 @@ -## Interface `AutoscalingGetAutoscalingCapacityAutoscalingDeciders` +# `AutoscalingGetAutoscalingCapacityAutoscalingDeciders` [interface-AutoscalingGetAutoscalingCapacityAutoscalingDeciders] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AutoscalingGetAutoscalingCapacityAutoscalingNode.md b/docs/reference/api/AutoscalingGetAutoscalingCapacityAutoscalingNode.md index c3153a2c6..2725a1cbf 100644 --- a/docs/reference/api/AutoscalingGetAutoscalingCapacityAutoscalingNode.md +++ b/docs/reference/api/AutoscalingGetAutoscalingCapacityAutoscalingNode.md @@ -1,4 +1,4 @@ -## Interface `AutoscalingGetAutoscalingCapacityAutoscalingNode` +# `AutoscalingGetAutoscalingCapacityAutoscalingNode` [interface-AutoscalingGetAutoscalingCapacityAutoscalingNode] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AutoscalingGetAutoscalingCapacityAutoscalingResources.md b/docs/reference/api/AutoscalingGetAutoscalingCapacityAutoscalingResources.md index acdbe6cc9..a578dc01a 100644 --- a/docs/reference/api/AutoscalingGetAutoscalingCapacityAutoscalingResources.md +++ b/docs/reference/api/AutoscalingGetAutoscalingCapacityAutoscalingResources.md @@ -1,4 +1,4 @@ -## Interface `AutoscalingGetAutoscalingCapacityAutoscalingResources` +# `AutoscalingGetAutoscalingCapacityAutoscalingResources` [interface-AutoscalingGetAutoscalingCapacityAutoscalingResources] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AutoscalingGetAutoscalingCapacityRequest.md b/docs/reference/api/AutoscalingGetAutoscalingCapacityRequest.md index 1322661ad..b84374fbc 100644 --- a/docs/reference/api/AutoscalingGetAutoscalingCapacityRequest.md +++ b/docs/reference/api/AutoscalingGetAutoscalingCapacityRequest.md @@ -1,4 +1,4 @@ -## Interface `AutoscalingGetAutoscalingCapacityRequest` +# `AutoscalingGetAutoscalingCapacityRequest` [interface-AutoscalingGetAutoscalingCapacityRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AutoscalingGetAutoscalingCapacityResponse.md b/docs/reference/api/AutoscalingGetAutoscalingCapacityResponse.md index 4c91c8716..d024418f6 100644 --- a/docs/reference/api/AutoscalingGetAutoscalingCapacityResponse.md +++ b/docs/reference/api/AutoscalingGetAutoscalingCapacityResponse.md @@ -1,4 +1,4 @@ -## Interface `AutoscalingGetAutoscalingCapacityResponse` +# `AutoscalingGetAutoscalingCapacityResponse` [interface-AutoscalingGetAutoscalingCapacityResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AutoscalingGetAutoscalingPolicyRequest.md b/docs/reference/api/AutoscalingGetAutoscalingPolicyRequest.md index ff4925cb3..5cd1eb249 100644 --- a/docs/reference/api/AutoscalingGetAutoscalingPolicyRequest.md +++ b/docs/reference/api/AutoscalingGetAutoscalingPolicyRequest.md @@ -1,4 +1,4 @@ -## Interface `AutoscalingGetAutoscalingPolicyRequest` +# `AutoscalingGetAutoscalingPolicyRequest` [interface-AutoscalingGetAutoscalingPolicyRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AutoscalingGetAutoscalingPolicyResponse.md b/docs/reference/api/AutoscalingGetAutoscalingPolicyResponse.md index 26ad6ccc1..c91571795 100644 --- a/docs/reference/api/AutoscalingGetAutoscalingPolicyResponse.md +++ b/docs/reference/api/AutoscalingGetAutoscalingPolicyResponse.md @@ -1,4 +1,4 @@ -## `AutoscalingGetAutoscalingPolicyResponse` -::: +# `AutoscalingGetAutoscalingPolicyResponse` [alias-AutoscalingGetAutoscalingPolicyResponse] +```typescript type AutoscalingGetAutoscalingPolicyResponse = [AutoscalingAutoscalingPolicy](./AutoscalingAutoscalingPolicy.md); -::: +``` diff --git a/docs/reference/api/AutoscalingPutAutoscalingPolicyRequest.md b/docs/reference/api/AutoscalingPutAutoscalingPolicyRequest.md index bd77d27db..01c4757b4 100644 --- a/docs/reference/api/AutoscalingPutAutoscalingPolicyRequest.md +++ b/docs/reference/api/AutoscalingPutAutoscalingPolicyRequest.md @@ -1,4 +1,4 @@ -## Interface `AutoscalingPutAutoscalingPolicyRequest` +# `AutoscalingPutAutoscalingPolicyRequest` [interface-AutoscalingPutAutoscalingPolicyRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/AutoscalingPutAutoscalingPolicyResponse.md b/docs/reference/api/AutoscalingPutAutoscalingPolicyResponse.md index 77a1fa543..b539de7e2 100644 --- a/docs/reference/api/AutoscalingPutAutoscalingPolicyResponse.md +++ b/docs/reference/api/AutoscalingPutAutoscalingPolicyResponse.md @@ -1,4 +1,4 @@ -## `AutoscalingPutAutoscalingPolicyResponse` -::: +# `AutoscalingPutAutoscalingPolicyResponse` [alias-AutoscalingPutAutoscalingPolicyResponse] +```typescript type AutoscalingPutAutoscalingPolicyResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); -::: +``` diff --git a/docs/reference/api/BulkApi_1.md b/docs/reference/api/BulkApi_1.md index e36e367d7..1b70ecddc 100644 --- a/docs/reference/api/BulkApi_1.md +++ b/docs/reference/api/BulkApi_1.md @@ -1,3 +1,3 @@ -::: +```typescript default function BulkApi(this: [That](./That.md), params: [BulkRequest](./BulkRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[BulkResponse](./BulkResponse.md)>; -::: +``` diff --git a/docs/reference/api/BulkApi_2.md b/docs/reference/api/BulkApi_2.md index eb99682ca..b6998bd4c 100644 --- a/docs/reference/api/BulkApi_2.md +++ b/docs/reference/api/BulkApi_2.md @@ -1,3 +1,3 @@ -::: +```typescript default function BulkApi(this: [That](./That.md), params: [BulkRequest](./BulkRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[BulkResponse](./BulkResponse.md), unknown>>; -::: +``` diff --git a/docs/reference/api/BulkApi_3.md b/docs/reference/api/BulkApi_3.md index 14140b0f1..6401e5e98 100644 --- a/docs/reference/api/BulkApi_3.md +++ b/docs/reference/api/BulkApi_3.md @@ -1,3 +1,3 @@ -::: +```typescript default function BulkApi(this: [That](./That.md), params: [BulkRequest](./BulkRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[BulkResponse](./BulkResponse.md)>; -::: +``` diff --git a/docs/reference/api/BulkCreateOperation.md b/docs/reference/api/BulkCreateOperation.md index 8bc2752cf..fc9d10bce 100644 --- a/docs/reference/api/BulkCreateOperation.md +++ b/docs/reference/api/BulkCreateOperation.md @@ -1,4 +1,4 @@ -## Interface `BulkCreateOperation` +# `BulkCreateOperation` [interface-BulkCreateOperation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/BulkDeleteOperation.md b/docs/reference/api/BulkDeleteOperation.md index d3533875c..e9ee2ad97 100644 --- a/docs/reference/api/BulkDeleteOperation.md +++ b/docs/reference/api/BulkDeleteOperation.md @@ -1,4 +1,4 @@ -## Interface `BulkDeleteOperation` +# `BulkDeleteOperation` [interface-BulkDeleteOperation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/BulkFailureStoreStatus.md b/docs/reference/api/BulkFailureStoreStatus.md index 4c5152ee6..3690ea383 100644 --- a/docs/reference/api/BulkFailureStoreStatus.md +++ b/docs/reference/api/BulkFailureStoreStatus.md @@ -1,4 +1,4 @@ -## `BulkFailureStoreStatus` -::: +# `BulkFailureStoreStatus` [alias-BulkFailureStoreStatus] +```typescript type BulkFailureStoreStatus = 'not_applicable_or_unknown' | 'used' | 'not_enabled' | 'failed'; -::: +``` diff --git a/docs/reference/api/BulkHelper.md b/docs/reference/api/BulkHelper.md index 0d9d08851..52133e19f 100644 --- a/docs/reference/api/BulkHelper.md +++ b/docs/reference/api/BulkHelper.md @@ -1,4 +1,4 @@ -## Interface `BulkHelper` +# `BulkHelper` [interface-BulkHelper] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/BulkHelperOptions.md b/docs/reference/api/BulkHelperOptions.md index 52f7b6007..62e026b02 100644 --- a/docs/reference/api/BulkHelperOptions.md +++ b/docs/reference/api/BulkHelperOptions.md @@ -1,4 +1,4 @@ -## Interface `BulkHelperOptions` +# `BulkHelperOptions` [interface-BulkHelperOptions] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/BulkIndexByScrollFailure.md b/docs/reference/api/BulkIndexByScrollFailure.md index 9c498f27f..fcbc7d464 100644 --- a/docs/reference/api/BulkIndexByScrollFailure.md +++ b/docs/reference/api/BulkIndexByScrollFailure.md @@ -1,4 +1,4 @@ -## Interface `BulkIndexByScrollFailure` +# `BulkIndexByScrollFailure` [interface-BulkIndexByScrollFailure] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/BulkIndexOperation.md b/docs/reference/api/BulkIndexOperation.md index 02243672a..a5a433d86 100644 --- a/docs/reference/api/BulkIndexOperation.md +++ b/docs/reference/api/BulkIndexOperation.md @@ -1,4 +1,4 @@ -## Interface `BulkIndexOperation` +# `BulkIndexOperation` [interface-BulkIndexOperation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/BulkOperationBase.md b/docs/reference/api/BulkOperationBase.md index 8e8f1c47b..ad2068380 100644 --- a/docs/reference/api/BulkOperationBase.md +++ b/docs/reference/api/BulkOperationBase.md @@ -1,4 +1,4 @@ -## Interface `BulkOperationBase` +# `BulkOperationBase` [interface-BulkOperationBase] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/BulkOperationContainer.md b/docs/reference/api/BulkOperationContainer.md index 5f0d8bf1c..552dc8aac 100644 --- a/docs/reference/api/BulkOperationContainer.md +++ b/docs/reference/api/BulkOperationContainer.md @@ -1,4 +1,4 @@ -## Interface `BulkOperationContainer` +# `BulkOperationContainer` [interface-BulkOperationContainer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/BulkOperationType.md b/docs/reference/api/BulkOperationType.md index 49941d1ab..0971306e6 100644 --- a/docs/reference/api/BulkOperationType.md +++ b/docs/reference/api/BulkOperationType.md @@ -1,4 +1,4 @@ -## `BulkOperationType` -::: +# `BulkOperationType` [alias-BulkOperationType] +```typescript type BulkOperationType = 'index' | 'create' | 'update' | 'delete'; -::: +``` diff --git a/docs/reference/api/BulkRequest.md b/docs/reference/api/BulkRequest.md index 8d2407e55..439bf96f6 100644 --- a/docs/reference/api/BulkRequest.md +++ b/docs/reference/api/BulkRequest.md @@ -1,4 +1,4 @@ -## Interface `BulkRequest` +# `BulkRequest` [interface-BulkRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/BulkResponse.md b/docs/reference/api/BulkResponse.md index bd02c53ba..7dc08f97f 100644 --- a/docs/reference/api/BulkResponse.md +++ b/docs/reference/api/BulkResponse.md @@ -1,4 +1,4 @@ -## Interface `BulkResponse` +# `BulkResponse` [interface-BulkResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/BulkResponseItem.md b/docs/reference/api/BulkResponseItem.md index d073ca581..2a9f1c3d2 100644 --- a/docs/reference/api/BulkResponseItem.md +++ b/docs/reference/api/BulkResponseItem.md @@ -1,4 +1,4 @@ -## Interface `BulkResponseItem` +# `BulkResponseItem` [interface-BulkResponseItem] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/BulkStats.md b/docs/reference/api/BulkStats.md index 5ad29f696..898c1db57 100644 --- a/docs/reference/api/BulkStats.md +++ b/docs/reference/api/BulkStats.md @@ -1,4 +1,4 @@ -## Interface `BulkStats` +# `BulkStats` [interface-BulkStats] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/BulkUpdateAction.md b/docs/reference/api/BulkUpdateAction.md index a358bd320..4f5703dbf 100644 --- a/docs/reference/api/BulkUpdateAction.md +++ b/docs/reference/api/BulkUpdateAction.md @@ -1,4 +1,4 @@ -## Interface `BulkUpdateAction` +# `BulkUpdateAction` [interface-BulkUpdateAction] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/BulkUpdateOperation.md b/docs/reference/api/BulkUpdateOperation.md index 44fbd57b6..122c8f5bc 100644 --- a/docs/reference/api/BulkUpdateOperation.md +++ b/docs/reference/api/BulkUpdateOperation.md @@ -1,4 +1,4 @@ -## Interface `BulkUpdateOperation` +# `BulkUpdateOperation` [interface-BulkUpdateOperation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/BulkWriteOperation.md b/docs/reference/api/BulkWriteOperation.md index df1d455bc..ef29bde87 100644 --- a/docs/reference/api/BulkWriteOperation.md +++ b/docs/reference/api/BulkWriteOperation.md @@ -1,4 +1,4 @@ -## Interface `BulkWriteOperation` +# `BulkWriteOperation` [interface-BulkWriteOperation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ByteSize.md b/docs/reference/api/ByteSize.md index e9cd47861..a062a5104 100644 --- a/docs/reference/api/ByteSize.md +++ b/docs/reference/api/ByteSize.md @@ -1,4 +1,4 @@ -## `ByteSize` -::: +# `ByteSize` [alias-ByteSize] +```typescript type ByteSize = [long](./long.md) | string; -::: +``` diff --git a/docs/reference/api/Bytes.md b/docs/reference/api/Bytes.md index 8d2716194..8481146b1 100644 --- a/docs/reference/api/Bytes.md +++ b/docs/reference/api/Bytes.md @@ -1,4 +1,4 @@ -## `Bytes` -::: +# `Bytes` [alias-Bytes] +```typescript type Bytes = 'b' | 'kb' | 'mb' | 'gb' | 'tb' | 'pb'; -::: +``` diff --git a/docs/reference/api/CapabilitiesApi_1.md b/docs/reference/api/CapabilitiesApi_1.md index ef21fcb31..13abff59a 100644 --- a/docs/reference/api/CapabilitiesApi_1.md +++ b/docs/reference/api/CapabilitiesApi_1.md @@ -1,3 +1,3 @@ -::: +```typescript default function CapabilitiesApi(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TODO](./TODO.md)>; -::: +``` diff --git a/docs/reference/api/CapabilitiesApi_2.md b/docs/reference/api/CapabilitiesApi_2.md index 9d82b89d4..a932caf35 100644 --- a/docs/reference/api/CapabilitiesApi_2.md +++ b/docs/reference/api/CapabilitiesApi_2.md @@ -1,3 +1,3 @@ -::: +```typescript default function CapabilitiesApi(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TODO](./TODO.md), unknown>>; -::: +``` diff --git a/docs/reference/api/CapabilitiesApi_3.md b/docs/reference/api/CapabilitiesApi_3.md index 249b2276a..2fab9304c 100644 --- a/docs/reference/api/CapabilitiesApi_3.md +++ b/docs/reference/api/CapabilitiesApi_3.md @@ -1,3 +1,3 @@ -::: +```typescript default function CapabilitiesApi(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TODO](./TODO.md)>; -::: +``` diff --git a/docs/reference/api/Cat.md b/docs/reference/api/Cat.md index 046112a1c..c45231d6d 100644 --- a/docs/reference/api/Cat.md +++ b/docs/reference/api/Cat.md @@ -1,19 +1,19 @@ -## `Cat` +# `Cat` [class-Cat] -### Constructor +## Constructor -::: +```typescript new Cat(transport: [Transport](./Transport.md)); -::: +``` -### Properties +## Properties [class-properties-Cat] | Name | Type | Description | | - | - | - | | `acceptedParams` | Record |   | | `transport` | [Transport](./Transport.md) |   | -### Methods +## Methods [class-methods-Cat] | Name | Signature | Description | | - | - | - | diff --git a/docs/reference/api/CatAliasesAliasesRecord.md b/docs/reference/api/CatAliasesAliasesRecord.md index 98480fb93..70edf1dc4 100644 --- a/docs/reference/api/CatAliasesAliasesRecord.md +++ b/docs/reference/api/CatAliasesAliasesRecord.md @@ -1,4 +1,4 @@ -## Interface `CatAliasesAliasesRecord` +# `CatAliasesAliasesRecord` [interface-CatAliasesAliasesRecord] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/CatAliasesRequest.md b/docs/reference/api/CatAliasesRequest.md index 3cd000eac..a6b67e1ae 100644 --- a/docs/reference/api/CatAliasesRequest.md +++ b/docs/reference/api/CatAliasesRequest.md @@ -1,4 +1,4 @@ -## Interface `CatAliasesRequest` +# `CatAliasesRequest` [interface-CatAliasesRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/CatAliasesResponse.md b/docs/reference/api/CatAliasesResponse.md index eb0f9eb54..04f874da5 100644 --- a/docs/reference/api/CatAliasesResponse.md +++ b/docs/reference/api/CatAliasesResponse.md @@ -1,4 +1,4 @@ -## `CatAliasesResponse` -::: +# `CatAliasesResponse` [alias-CatAliasesResponse] +```typescript type CatAliasesResponse = [CatAliasesAliasesRecord](./CatAliasesAliasesRecord.md)[]; -::: +``` diff --git a/docs/reference/api/CatAllocationAllocationRecord.md b/docs/reference/api/CatAllocationAllocationRecord.md index 47e672675..cf2335b59 100644 --- a/docs/reference/api/CatAllocationAllocationRecord.md +++ b/docs/reference/api/CatAllocationAllocationRecord.md @@ -1,4 +1,4 @@ -## Interface `CatAllocationAllocationRecord` +# `CatAllocationAllocationRecord` [interface-CatAllocationAllocationRecord] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/CatAllocationRequest.md b/docs/reference/api/CatAllocationRequest.md index 08b2ee8c7..d2fe5ce75 100644 --- a/docs/reference/api/CatAllocationRequest.md +++ b/docs/reference/api/CatAllocationRequest.md @@ -1,4 +1,4 @@ -## Interface `CatAllocationRequest` +# `CatAllocationRequest` [interface-CatAllocationRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/CatAllocationResponse.md b/docs/reference/api/CatAllocationResponse.md index 46c038160..77d80f188 100644 --- a/docs/reference/api/CatAllocationResponse.md +++ b/docs/reference/api/CatAllocationResponse.md @@ -1,4 +1,4 @@ -## `CatAllocationResponse` -::: +# `CatAllocationResponse` [alias-CatAllocationResponse] +```typescript type CatAllocationResponse = [CatAllocationAllocationRecord](./CatAllocationAllocationRecord.md)[]; -::: +``` diff --git a/docs/reference/api/CatCatAnomalyDetectorColumn.md b/docs/reference/api/CatCatAnomalyDetectorColumn.md index 32d1b30f3..d77c05281 100644 --- a/docs/reference/api/CatCatAnomalyDetectorColumn.md +++ b/docs/reference/api/CatCatAnomalyDetectorColumn.md @@ -1,4 +1,4 @@ -## `CatCatAnomalyDetectorColumn` -::: +# `CatCatAnomalyDetectorColumn` [alias-CatCatAnomalyDetectorColumn] +```typescript type CatCatAnomalyDetectorColumn = 'assignment_explanation' | 'ae' | 'buckets.count' | 'bc' | 'bucketsCount' | 'buckets.time.exp_avg' | 'btea' | 'bucketsTimeExpAvg' | 'buckets.time.exp_avg_hour' | 'bteah' | 'bucketsTimeExpAvgHour' | 'buckets.time.max' | 'btmax' | 'bucketsTimeMax' | 'buckets.time.min' | 'btmin' | 'bucketsTimeMin' | 'buckets.time.total' | 'btt' | 'bucketsTimeTotal' | 'data.buckets' | 'db' | 'dataBuckets' | 'data.earliest_record' | 'der' | 'dataEarliestRecord' | 'data.empty_buckets' | 'deb' | 'dataEmptyBuckets' | 'data.input_bytes' | 'dib' | 'dataInputBytes' | 'data.input_fields' | 'dif' | 'dataInputFields' | 'data.input_records' | 'dir' | 'dataInputRecords' | 'data.invalid_dates' | 'did' | 'dataInvalidDates' | 'data.last' | 'dl' | 'dataLast' | 'data.last_empty_bucket' | 'dleb' | 'dataLastEmptyBucket' | 'data.last_sparse_bucket' | 'dlsb' | 'dataLastSparseBucket' | 'data.latest_record' | 'dlr' | 'dataLatestRecord' | 'data.missing_fields' | 'dmf' | 'dataMissingFields' | 'data.out_of_order_timestamps' | 'doot' | 'dataOutOfOrderTimestamps' | 'data.processed_fields' | 'dpf' | 'dataProcessedFields' | 'data.processed_records' | 'dpr' | 'dataProcessedRecords' | 'data.sparse_buckets' | 'dsb' | 'dataSparseBuckets' | 'forecasts.memory.avg' | 'fmavg' | 'forecastsMemoryAvg' | 'forecasts.memory.max' | 'fmmax' | 'forecastsMemoryMax' | 'forecasts.memory.min' | 'fmmin' | 'forecastsMemoryMin' | 'forecasts.memory.total' | 'fmt' | 'forecastsMemoryTotal' | 'forecasts.records.avg' | 'fravg' | 'forecastsRecordsAvg' | 'forecasts.records.max' | 'frmax' | 'forecastsRecordsMax' | 'forecasts.records.min' | 'frmin' | 'forecastsRecordsMin' | 'forecasts.records.total' | 'frt' | 'forecastsRecordsTotal' | 'forecasts.time.avg' | 'ftavg' | 'forecastsTimeAvg' | 'forecasts.time.max' | 'ftmax' | 'forecastsTimeMax' | 'forecasts.time.min' | 'ftmin' | 'forecastsTimeMin' | 'forecasts.time.total' | 'ftt' | 'forecastsTimeTotal' | 'forecasts.total' | 'ft' | 'forecastsTotal' | 'id' | 'model.bucket_allocation_failures' | 'mbaf' | 'modelBucketAllocationFailures' | 'model.by_fields' | 'mbf' | 'modelByFields' | 'model.bytes' | 'mb' | 'modelBytes' | 'model.bytes_exceeded' | 'mbe' | 'modelBytesExceeded' | 'model.categorization_status' | 'mcs' | 'modelCategorizationStatus' | 'model.categorized_doc_count' | 'mcdc' | 'modelCategorizedDocCount' | 'model.dead_category_count' | 'mdcc' | 'modelDeadCategoryCount' | 'model.failed_category_count' | 'mdcc' | 'modelFailedCategoryCount' | 'model.frequent_category_count' | 'mfcc' | 'modelFrequentCategoryCount' | 'model.log_time' | 'mlt' | 'modelLogTime' | 'model.memory_limit' | 'mml' | 'modelMemoryLimit' | 'model.memory_status' | 'mms' | 'modelMemoryStatus' | 'model.over_fields' | 'mof' | 'modelOverFields' | 'model.partition_fields' | 'mpf' | 'modelPartitionFields' | 'model.rare_category_count' | 'mrcc' | 'modelRareCategoryCount' | 'model.timestamp' | 'mt' | 'modelTimestamp' | 'model.total_category_count' | 'mtcc' | 'modelTotalCategoryCount' | 'node.address' | 'na' | 'nodeAddress' | 'node.ephemeral_id' | 'ne' | 'nodeEphemeralId' | 'node.id' | 'ni' | 'nodeId' | 'node.name' | 'nn' | 'nodeName' | 'opened_time' | 'ot' | 'state' | 's'; -::: +``` diff --git a/docs/reference/api/CatCatAnonalyDetectorColumns.md b/docs/reference/api/CatCatAnonalyDetectorColumns.md index f18e36649..9a8f3d80b 100644 --- a/docs/reference/api/CatCatAnonalyDetectorColumns.md +++ b/docs/reference/api/CatCatAnonalyDetectorColumns.md @@ -1,4 +1,4 @@ -## `CatCatAnonalyDetectorColumns` -::: +# `CatCatAnonalyDetectorColumns` [alias-CatCatAnonalyDetectorColumns] +```typescript type CatCatAnonalyDetectorColumns = [CatCatAnomalyDetectorColumn](./CatCatAnomalyDetectorColumn.md) | [CatCatAnomalyDetectorColumn](./CatCatAnomalyDetectorColumn.md)[]; -::: +``` diff --git a/docs/reference/api/CatCatDatafeedColumn.md b/docs/reference/api/CatCatDatafeedColumn.md index bddf115dd..67cb48d56 100644 --- a/docs/reference/api/CatCatDatafeedColumn.md +++ b/docs/reference/api/CatCatDatafeedColumn.md @@ -1,4 +1,4 @@ -## `CatCatDatafeedColumn` -::: +# `CatCatDatafeedColumn` [alias-CatCatDatafeedColumn] +```typescript type CatCatDatafeedColumn = 'ae' | 'assignment_explanation' | 'bc' | 'buckets.count' | 'bucketsCount' | 'id' | 'na' | 'node.address' | 'nodeAddress' | 'ne' | 'node.ephemeral_id' | 'nodeEphemeralId' | 'ni' | 'node.id' | 'nodeId' | 'nn' | 'node.name' | 'nodeName' | 'sba' | 'search.bucket_avg' | 'searchBucketAvg' | 'sc' | 'search.count' | 'searchCount' | 'seah' | 'search.exp_avg_hour' | 'searchExpAvgHour' | 'st' | 'search.time' | 'searchTime' | 's' | 'state'; -::: +``` diff --git a/docs/reference/api/CatCatDatafeedColumns.md b/docs/reference/api/CatCatDatafeedColumns.md index a1155886d..16240c2ae 100644 --- a/docs/reference/api/CatCatDatafeedColumns.md +++ b/docs/reference/api/CatCatDatafeedColumns.md @@ -1,4 +1,4 @@ -## `CatCatDatafeedColumns` -::: +# `CatCatDatafeedColumns` [alias-CatCatDatafeedColumns] +```typescript type CatCatDatafeedColumns = [CatCatDatafeedColumn](./CatCatDatafeedColumn.md) | [CatCatDatafeedColumn](./CatCatDatafeedColumn.md)[]; -::: +``` diff --git a/docs/reference/api/CatCatDfaColumn.md b/docs/reference/api/CatCatDfaColumn.md index beb64fc20..fba831751 100644 --- a/docs/reference/api/CatCatDfaColumn.md +++ b/docs/reference/api/CatCatDfaColumn.md @@ -1,4 +1,4 @@ -## `CatCatDfaColumn` -::: +# `CatCatDfaColumn` [alias-CatCatDfaColumn] +```typescript type CatCatDfaColumn = 'assignment_explanation' | 'ae' | 'create_time' | 'ct' | 'createTime' | 'description' | 'd' | 'dest_index' | 'di' | 'destIndex' | 'failure_reason' | 'fr' | 'failureReason' | 'id' | 'model_memory_limit' | 'mml' | 'modelMemoryLimit' | 'node.address' | 'na' | 'nodeAddress' | 'node.ephemeral_id' | 'ne' | 'nodeEphemeralId' | 'node.id' | 'ni' | 'nodeId' | 'node.name' | 'nn' | 'nodeName' | 'progress' | 'p' | 'source_index' | 'si' | 'sourceIndex' | 'state' | 's' | 'type' | 't' | 'version' | 'v'; -::: +``` diff --git a/docs/reference/api/CatCatDfaColumns.md b/docs/reference/api/CatCatDfaColumns.md index 9036177c6..41dcd747b 100644 --- a/docs/reference/api/CatCatDfaColumns.md +++ b/docs/reference/api/CatCatDfaColumns.md @@ -1,4 +1,4 @@ -## `CatCatDfaColumns` -::: +# `CatCatDfaColumns` [alias-CatCatDfaColumns] +```typescript type CatCatDfaColumns = [CatCatDfaColumn](./CatCatDfaColumn.md) | [CatCatDfaColumn](./CatCatDfaColumn.md)[]; -::: +``` diff --git a/docs/reference/api/CatCatNodeColumn.md b/docs/reference/api/CatCatNodeColumn.md index bab302955..504542439 100644 --- a/docs/reference/api/CatCatNodeColumn.md +++ b/docs/reference/api/CatCatNodeColumn.md @@ -1,4 +1,4 @@ -## `CatCatNodeColumn` -::: +# `CatCatNodeColumn` [alias-CatCatNodeColumn] +```typescript type CatCatNodeColumn = 'build' | 'b' | 'completion.size' | 'cs' | 'completionSize' | 'cpu' | 'disk.avail' | 'd' | 'disk' | 'diskAvail' | 'disk.total' | 'dt' | 'diskTotal' | 'disk.used' | 'du' | 'diskUsed' | 'disk.used_percent' | 'dup' | 'diskUsedPercent' | 'fielddata.evictions' | 'fe' | 'fielddataEvictions' | 'fielddata.memory_size' | 'fm' | 'fielddataMemory' | 'file_desc.current' | 'fdc' | 'fileDescriptorCurrent' | 'file_desc.max' | 'fdm' | 'fileDescriptorMax' | 'file_desc.percent' | 'fdp' | 'fileDescriptorPercent' | 'flush.total' | 'ft' | 'flushTotal' | 'flush.total_time' | 'ftt' | 'flushTotalTime' | 'get.current' | 'gc' | 'getCurrent' | 'get.exists_time' | 'geti' | 'getExistsTime' | 'get.exists_total' | 'geto' | 'getExistsTotal' | 'get.missing_time' | 'gmti' | 'getMissingTime' | 'get.missing_total' | 'gmto' | 'getMissingTotal' | 'get.time' | 'gti' | 'getTime' | 'get.total' | 'gto' | 'getTotal' | 'heap.current' | 'hc' | 'heapCurrent' | 'heap.max' | 'hm' | 'heapMax' | 'heap.percent' | 'hp' | 'heapPercent' | 'http_address' | 'http' | 'id' | 'nodeId' | 'indexing.delete_current' | 'idc' | 'indexingDeleteCurrent' | 'indexing.delete_time' | 'idti' | 'indexingDeleteTime' | 'indexing.delete_total' | 'idto' | 'indexingDeleteTotal' | 'indexing.index_current' | 'iic' | 'indexingIndexCurrent' | 'indexing.index_failed' | 'iif' | 'indexingIndexFailed' | 'indexing.index_failed_due_to_version_conflict' | 'iifvc' | 'indexingIndexFailedDueToVersionConflict' | 'indexing.index_time' | 'iiti' | 'indexingIndexTime' | 'indexing.index_total' | 'iito' | 'indexingIndexTotal' | 'ip' | 'i' | 'jdk' | 'j' | 'load_1m' | 'l' | 'load_5m' | 'l' | 'load_15m' | 'l' | 'mappings.total_count' | 'mtc' | 'mappingsTotalCount' | 'mappings.total_estimated_overhead_in_bytes' | 'mteo' | 'mappingsTotalEstimatedOverheadInBytes' | 'master' | 'm' | 'merges.current' | 'mc' | 'mergesCurrent' | 'merges.current_docs' | 'mcd' | 'mergesCurrentDocs' | 'merges.current_size' | 'mcs' | 'mergesCurrentSize' | 'merges.total' | 'mt' | 'mergesTotal' | 'merges.total_docs' | 'mtd' | 'mergesTotalDocs' | 'merges.total_size' | 'mts' | 'mergesTotalSize' | 'merges.total_time' | 'mtt' | 'mergesTotalTime' | 'name' | 'n' | 'node.role' | 'r' | 'role' | 'nodeRole' | 'pid' | 'p' | 'port' | 'po' | 'query_cache.memory_size' | 'qcm' | 'queryCacheMemory' | 'query_cache.evictions' | 'qce' | 'queryCacheEvictions' | 'query_cache.hit_count' | 'qchc' | 'queryCacheHitCount' | 'query_cache.miss_count' | 'qcmc' | 'queryCacheMissCount' | 'ram.current' | 'rc' | 'ramCurrent' | 'ram.max' | 'rm' | 'ramMax' | 'ram.percent' | 'rp' | 'ramPercent' | 'refresh.total' | 'rto' | 'refreshTotal' | 'refresh.time' | 'rti' | 'refreshTime' | 'request_cache.memory_size' | 'rcm' | 'requestCacheMemory' | 'request_cache.evictions' | 'rce' | 'requestCacheEvictions' | 'request_cache.hit_count' | 'rchc' | 'requestCacheHitCount' | 'request_cache.miss_count' | 'rcmc' | 'requestCacheMissCount' | 'script.compilations' | 'scrcc' | 'scriptCompilations' | 'script.cache_evictions' | 'scrce' | 'scriptCacheEvictions' | 'search.fetch_current' | 'sfc' | 'searchFetchCurrent' | 'search.fetch_time' | 'sfti' | 'searchFetchTime' | 'search.fetch_total' | 'sfto' | 'searchFetchTotal' | 'search.open_contexts' | 'so' | 'searchOpenContexts' | 'search.query_current' | 'sqc' | 'searchQueryCurrent' | 'search.query_time' | 'sqti' | 'searchQueryTime' | 'search.query_total' | 'sqto' | 'searchQueryTotal' | 'search.scroll_current' | 'scc' | 'searchScrollCurrent' | 'search.scroll_time' | 'scti' | 'searchScrollTime' | 'search.scroll_total' | 'scto' | 'searchScrollTotal' | 'segments.count' | 'sc' | 'segmentsCount' | 'segments.fixed_bitset_memory' | 'sfbm' | 'fixedBitsetMemory' | 'segments.index_writer_memory' | 'siwm' | 'segmentsIndexWriterMemory' | 'segments.memory' | 'sm' | 'segmentsMemory' | 'segments.version_map_memory' | 'svmm' | 'segmentsVersionMapMemory' | 'shard_stats.total_count' | 'sstc' | 'shards' | 'shardStatsTotalCount' | 'suggest.current' | 'suc' | 'suggestCurrent' | 'suggest.time' | 'suti' | 'suggestTime' | 'suggest.total' | 'suto' | 'suggestTotal' | 'uptime' | 'u' | 'version' | 'v' | string; -::: +``` diff --git a/docs/reference/api/CatCatNodeColumns.md b/docs/reference/api/CatCatNodeColumns.md index 9a9516efb..40b0750e8 100644 --- a/docs/reference/api/CatCatNodeColumns.md +++ b/docs/reference/api/CatCatNodeColumns.md @@ -1,4 +1,4 @@ -## `CatCatNodeColumns` -::: +# `CatCatNodeColumns` [alias-CatCatNodeColumns] +```typescript type CatCatNodeColumns = [CatCatNodeColumn](./CatCatNodeColumn.md) | [CatCatNodeColumn](./CatCatNodeColumn.md)[]; -::: +``` diff --git a/docs/reference/api/CatCatRequestBase.md b/docs/reference/api/CatCatRequestBase.md index b05e2754a..216ceebaf 100644 --- a/docs/reference/api/CatCatRequestBase.md +++ b/docs/reference/api/CatCatRequestBase.md @@ -1,4 +1,4 @@ -## Interface `CatCatRequestBase` +# `CatCatRequestBase` [interface-CatCatRequestBase] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/CatCatTrainedModelsColumn.md b/docs/reference/api/CatCatTrainedModelsColumn.md index d75efa650..ce70cdf56 100644 --- a/docs/reference/api/CatCatTrainedModelsColumn.md +++ b/docs/reference/api/CatCatTrainedModelsColumn.md @@ -1,4 +1,4 @@ -## `CatCatTrainedModelsColumn` -::: +# `CatCatTrainedModelsColumn` [alias-CatCatTrainedModelsColumn] +```typescript type CatCatTrainedModelsColumn = 'create_time' | 'ct' | 'created_by' | 'c' | 'createdBy' | 'data_frame_analytics_id' | 'df' | 'dataFrameAnalytics' | 'dfid' | 'description' | 'd' | 'heap_size' | 'hs' | 'modelHeapSize' | 'id' | 'ingest.count' | 'ic' | 'ingestCount' | 'ingest.current' | 'icurr' | 'ingestCurrent' | 'ingest.failed' | 'if' | 'ingestFailed' | 'ingest.pipelines' | 'ip' | 'ingestPipelines' | 'ingest.time' | 'it' | 'ingestTime' | 'license' | 'l' | 'operations' | 'o' | 'modelOperations' | 'version' | 'v'; -::: +``` diff --git a/docs/reference/api/CatCatTrainedModelsColumns.md b/docs/reference/api/CatCatTrainedModelsColumns.md index e2864fa0f..134d6adb2 100644 --- a/docs/reference/api/CatCatTrainedModelsColumns.md +++ b/docs/reference/api/CatCatTrainedModelsColumns.md @@ -1,4 +1,4 @@ -## `CatCatTrainedModelsColumns` -::: +# `CatCatTrainedModelsColumns` [alias-CatCatTrainedModelsColumns] +```typescript type CatCatTrainedModelsColumns = [CatCatTrainedModelsColumn](./CatCatTrainedModelsColumn.md) | [CatCatTrainedModelsColumn](./CatCatTrainedModelsColumn.md)[]; -::: +``` diff --git a/docs/reference/api/CatCatTransformColumn.md b/docs/reference/api/CatCatTransformColumn.md index c0482d714..30da05101 100644 --- a/docs/reference/api/CatCatTransformColumn.md +++ b/docs/reference/api/CatCatTransformColumn.md @@ -1,4 +1,4 @@ -## `CatCatTransformColumn` -::: +# `CatCatTransformColumn` [alias-CatCatTransformColumn] +```typescript type CatCatTransformColumn = 'changes_last_detection_time' | 'cldt' | 'checkpoint' | 'cp' | 'checkpoint_duration_time_exp_avg' | 'cdtea' | 'checkpointTimeExpAvg' | 'checkpoint_progress' | 'c' | 'checkpointProgress' | 'create_time' | 'ct' | 'createTime' | 'delete_time' | 'dtime' | 'description' | 'd' | 'dest_index' | 'di' | 'destIndex' | 'documents_deleted' | 'docd' | 'documents_indexed' | 'doci' | 'docs_per_second' | 'dps' | 'documents_processed' | 'docp' | 'frequency' | 'f' | 'id' | 'index_failure' | 'if' | 'index_time' | 'itime' | 'index_total' | 'it' | 'indexed_documents_exp_avg' | 'idea' | 'last_search_time' | 'lst' | 'lastSearchTime' | 'max_page_search_size' | 'mpsz' | 'pages_processed' | 'pp' | 'pipeline' | 'p' | 'processed_documents_exp_avg' | 'pdea' | 'processing_time' | 'pt' | 'reason' | 'r' | 'search_failure' | 'sf' | 'search_time' | 'stime' | 'search_total' | 'st' | 'source_index' | 'si' | 'sourceIndex' | 'state' | 's' | 'transform_type' | 'tt' | 'trigger_count' | 'tc' | 'version' | 'v'; -::: +``` diff --git a/docs/reference/api/CatCatTransformColumns.md b/docs/reference/api/CatCatTransformColumns.md index 3bd17e6e9..2d096ca2a 100644 --- a/docs/reference/api/CatCatTransformColumns.md +++ b/docs/reference/api/CatCatTransformColumns.md @@ -1,4 +1,4 @@ -## `CatCatTransformColumns` -::: +# `CatCatTransformColumns` [alias-CatCatTransformColumns] +```typescript type CatCatTransformColumns = [CatCatTransformColumn](./CatCatTransformColumn.md) | [CatCatTransformColumn](./CatCatTransformColumn.md)[]; -::: +``` diff --git a/docs/reference/api/CatComponentTemplatesComponentTemplate.md b/docs/reference/api/CatComponentTemplatesComponentTemplate.md index f7b04b03a..f4c689992 100644 --- a/docs/reference/api/CatComponentTemplatesComponentTemplate.md +++ b/docs/reference/api/CatComponentTemplatesComponentTemplate.md @@ -1,4 +1,4 @@ -## Interface `CatComponentTemplatesComponentTemplate` +# `CatComponentTemplatesComponentTemplate` [interface-CatComponentTemplatesComponentTemplate] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/CatComponentTemplatesRequest.md b/docs/reference/api/CatComponentTemplatesRequest.md index 4456a1eb8..43e315e04 100644 --- a/docs/reference/api/CatComponentTemplatesRequest.md +++ b/docs/reference/api/CatComponentTemplatesRequest.md @@ -1,4 +1,4 @@ -## Interface `CatComponentTemplatesRequest` +# `CatComponentTemplatesRequest` [interface-CatComponentTemplatesRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/CatComponentTemplatesResponse.md b/docs/reference/api/CatComponentTemplatesResponse.md index a8093b810..cdac6dc11 100644 --- a/docs/reference/api/CatComponentTemplatesResponse.md +++ b/docs/reference/api/CatComponentTemplatesResponse.md @@ -1,4 +1,4 @@ -## `CatComponentTemplatesResponse` -::: +# `CatComponentTemplatesResponse` [alias-CatComponentTemplatesResponse] +```typescript type CatComponentTemplatesResponse = [CatComponentTemplatesComponentTemplate](./CatComponentTemplatesComponentTemplate.md)[]; -::: +``` diff --git a/docs/reference/api/CatCountCountRecord.md b/docs/reference/api/CatCountCountRecord.md index 310ac3532..d625b723c 100644 --- a/docs/reference/api/CatCountCountRecord.md +++ b/docs/reference/api/CatCountCountRecord.md @@ -1,4 +1,4 @@ -## Interface `CatCountCountRecord` +# `CatCountCountRecord` [interface-CatCountCountRecord] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/CatCountRequest.md b/docs/reference/api/CatCountRequest.md index 3b38c74de..7ef35943a 100644 --- a/docs/reference/api/CatCountRequest.md +++ b/docs/reference/api/CatCountRequest.md @@ -1,4 +1,4 @@ -## Interface `CatCountRequest` +# `CatCountRequest` [interface-CatCountRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/CatCountResponse.md b/docs/reference/api/CatCountResponse.md index 2e5c67de5..948f8a271 100644 --- a/docs/reference/api/CatCountResponse.md +++ b/docs/reference/api/CatCountResponse.md @@ -1,4 +1,4 @@ -## `CatCountResponse` -::: +# `CatCountResponse` [alias-CatCountResponse] +```typescript type CatCountResponse = [CatCountCountRecord](./CatCountCountRecord.md)[]; -::: +``` diff --git a/docs/reference/api/CatFielddataFielddataRecord.md b/docs/reference/api/CatFielddataFielddataRecord.md index 54bd7c8ff..cc16daa22 100644 --- a/docs/reference/api/CatFielddataFielddataRecord.md +++ b/docs/reference/api/CatFielddataFielddataRecord.md @@ -1,4 +1,4 @@ -## Interface `CatFielddataFielddataRecord` +# `CatFielddataFielddataRecord` [interface-CatFielddataFielddataRecord] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/CatFielddataRequest.md b/docs/reference/api/CatFielddataRequest.md index 20b556f7d..a959e0a71 100644 --- a/docs/reference/api/CatFielddataRequest.md +++ b/docs/reference/api/CatFielddataRequest.md @@ -1,4 +1,4 @@ -## Interface `CatFielddataRequest` +# `CatFielddataRequest` [interface-CatFielddataRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/CatFielddataResponse.md b/docs/reference/api/CatFielddataResponse.md index e8e65472b..565c3677f 100644 --- a/docs/reference/api/CatFielddataResponse.md +++ b/docs/reference/api/CatFielddataResponse.md @@ -1,4 +1,4 @@ -## `CatFielddataResponse` -::: +# `CatFielddataResponse` [alias-CatFielddataResponse] +```typescript type CatFielddataResponse = [CatFielddataFielddataRecord](./CatFielddataFielddataRecord.md)[]; -::: +``` diff --git a/docs/reference/api/CatHealthHealthRecord.md b/docs/reference/api/CatHealthHealthRecord.md index 92662580b..80c170d9f 100644 --- a/docs/reference/api/CatHealthHealthRecord.md +++ b/docs/reference/api/CatHealthHealthRecord.md @@ -1,4 +1,4 @@ -## Interface `CatHealthHealthRecord` +# `CatHealthHealthRecord` [interface-CatHealthHealthRecord] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/CatHealthRequest.md b/docs/reference/api/CatHealthRequest.md index 2f9faddb3..80e1d113d 100644 --- a/docs/reference/api/CatHealthRequest.md +++ b/docs/reference/api/CatHealthRequest.md @@ -1,4 +1,4 @@ -## Interface `CatHealthRequest` +# `CatHealthRequest` [interface-CatHealthRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/CatHealthResponse.md b/docs/reference/api/CatHealthResponse.md index 7c1fa475c..6811903e2 100644 --- a/docs/reference/api/CatHealthResponse.md +++ b/docs/reference/api/CatHealthResponse.md @@ -1,4 +1,4 @@ -## `CatHealthResponse` -::: +# `CatHealthResponse` [alias-CatHealthResponse] +```typescript type CatHealthResponse = [CatHealthHealthRecord](./CatHealthHealthRecord.md)[]; -::: +``` diff --git a/docs/reference/api/CatHelpRequest.md b/docs/reference/api/CatHelpRequest.md index 41b6d60fd..524c89c48 100644 --- a/docs/reference/api/CatHelpRequest.md +++ b/docs/reference/api/CatHelpRequest.md @@ -1,4 +1,4 @@ -## Interface `CatHelpRequest` +# `CatHelpRequest` [interface-CatHelpRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/CatHelpResponse.md b/docs/reference/api/CatHelpResponse.md index bc681cb60..ae94dfbaa 100644 --- a/docs/reference/api/CatHelpResponse.md +++ b/docs/reference/api/CatHelpResponse.md @@ -1,4 +1,4 @@ -## Interface `CatHelpResponse` +# `CatHelpResponse` [interface-CatHelpResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/CatIndicesIndicesRecord.md b/docs/reference/api/CatIndicesIndicesRecord.md index a9cc8dd4c..a0c5df798 100644 --- a/docs/reference/api/CatIndicesIndicesRecord.md +++ b/docs/reference/api/CatIndicesIndicesRecord.md @@ -1,4 +1,4 @@ -## Interface `CatIndicesIndicesRecord` +# `CatIndicesIndicesRecord` [interface-CatIndicesIndicesRecord] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/CatIndicesRequest.md b/docs/reference/api/CatIndicesRequest.md index 4caac879d..3260d8bf5 100644 --- a/docs/reference/api/CatIndicesRequest.md +++ b/docs/reference/api/CatIndicesRequest.md @@ -1,4 +1,4 @@ -## Interface `CatIndicesRequest` +# `CatIndicesRequest` [interface-CatIndicesRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/CatIndicesResponse.md b/docs/reference/api/CatIndicesResponse.md index 0323091fd..3c8a8961e 100644 --- a/docs/reference/api/CatIndicesResponse.md +++ b/docs/reference/api/CatIndicesResponse.md @@ -1,4 +1,4 @@ -## `CatIndicesResponse` -::: +# `CatIndicesResponse` [alias-CatIndicesResponse] +```typescript type CatIndicesResponse = [CatIndicesIndicesRecord](./CatIndicesIndicesRecord.md)[]; -::: +``` diff --git a/docs/reference/api/CatMasterMasterRecord.md b/docs/reference/api/CatMasterMasterRecord.md index ddf118c33..9a39cdc3a 100644 --- a/docs/reference/api/CatMasterMasterRecord.md +++ b/docs/reference/api/CatMasterMasterRecord.md @@ -1,4 +1,4 @@ -## Interface `CatMasterMasterRecord` +# `CatMasterMasterRecord` [interface-CatMasterMasterRecord] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/CatMasterRequest.md b/docs/reference/api/CatMasterRequest.md index 75e057fd6..e28ea25be 100644 --- a/docs/reference/api/CatMasterRequest.md +++ b/docs/reference/api/CatMasterRequest.md @@ -1,4 +1,4 @@ -## Interface `CatMasterRequest` +# `CatMasterRequest` [interface-CatMasterRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/CatMasterResponse.md b/docs/reference/api/CatMasterResponse.md index 498edaabe..60aed8e9a 100644 --- a/docs/reference/api/CatMasterResponse.md +++ b/docs/reference/api/CatMasterResponse.md @@ -1,4 +1,4 @@ -## `CatMasterResponse` -::: +# `CatMasterResponse` [alias-CatMasterResponse] +```typescript type CatMasterResponse = [CatMasterMasterRecord](./CatMasterMasterRecord.md)[]; -::: +``` diff --git a/docs/reference/api/CatMlDataFrameAnalyticsDataFrameAnalyticsRecord.md b/docs/reference/api/CatMlDataFrameAnalyticsDataFrameAnalyticsRecord.md index 04e5ac050..d934590dc 100644 --- a/docs/reference/api/CatMlDataFrameAnalyticsDataFrameAnalyticsRecord.md +++ b/docs/reference/api/CatMlDataFrameAnalyticsDataFrameAnalyticsRecord.md @@ -1,4 +1,4 @@ -## Interface `CatMlDataFrameAnalyticsDataFrameAnalyticsRecord` +# `CatMlDataFrameAnalyticsDataFrameAnalyticsRecord` [interface-CatMlDataFrameAnalyticsDataFrameAnalyticsRecord] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/CatMlDataFrameAnalyticsRequest.md b/docs/reference/api/CatMlDataFrameAnalyticsRequest.md index c3fd757ae..1be47cfd7 100644 --- a/docs/reference/api/CatMlDataFrameAnalyticsRequest.md +++ b/docs/reference/api/CatMlDataFrameAnalyticsRequest.md @@ -1,4 +1,4 @@ -## Interface `CatMlDataFrameAnalyticsRequest` +# `CatMlDataFrameAnalyticsRequest` [interface-CatMlDataFrameAnalyticsRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/CatMlDataFrameAnalyticsResponse.md b/docs/reference/api/CatMlDataFrameAnalyticsResponse.md index 2e681a119..edf471541 100644 --- a/docs/reference/api/CatMlDataFrameAnalyticsResponse.md +++ b/docs/reference/api/CatMlDataFrameAnalyticsResponse.md @@ -1,4 +1,4 @@ -## `CatMlDataFrameAnalyticsResponse` -::: +# `CatMlDataFrameAnalyticsResponse` [alias-CatMlDataFrameAnalyticsResponse] +```typescript type CatMlDataFrameAnalyticsResponse = [CatMlDataFrameAnalyticsDataFrameAnalyticsRecord](./CatMlDataFrameAnalyticsDataFrameAnalyticsRecord.md)[]; -::: +``` diff --git a/docs/reference/api/CatMlDatafeedsDatafeedsRecord.md b/docs/reference/api/CatMlDatafeedsDatafeedsRecord.md index b8cec2aa5..81db75a84 100644 --- a/docs/reference/api/CatMlDatafeedsDatafeedsRecord.md +++ b/docs/reference/api/CatMlDatafeedsDatafeedsRecord.md @@ -1,4 +1,4 @@ -## Interface `CatMlDatafeedsDatafeedsRecord` +# `CatMlDatafeedsDatafeedsRecord` [interface-CatMlDatafeedsDatafeedsRecord] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/CatMlDatafeedsRequest.md b/docs/reference/api/CatMlDatafeedsRequest.md index d54a7270b..3b6491402 100644 --- a/docs/reference/api/CatMlDatafeedsRequest.md +++ b/docs/reference/api/CatMlDatafeedsRequest.md @@ -1,4 +1,4 @@ -## Interface `CatMlDatafeedsRequest` +# `CatMlDatafeedsRequest` [interface-CatMlDatafeedsRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/CatMlDatafeedsResponse.md b/docs/reference/api/CatMlDatafeedsResponse.md index a86cead69..f407d19e9 100644 --- a/docs/reference/api/CatMlDatafeedsResponse.md +++ b/docs/reference/api/CatMlDatafeedsResponse.md @@ -1,4 +1,4 @@ -## `CatMlDatafeedsResponse` -::: +# `CatMlDatafeedsResponse` [alias-CatMlDatafeedsResponse] +```typescript type CatMlDatafeedsResponse = [CatMlDatafeedsDatafeedsRecord](./CatMlDatafeedsDatafeedsRecord.md)[]; -::: +``` diff --git a/docs/reference/api/CatMlJobsJobsRecord.md b/docs/reference/api/CatMlJobsJobsRecord.md index 06f7eef0a..d90d49f38 100644 --- a/docs/reference/api/CatMlJobsJobsRecord.md +++ b/docs/reference/api/CatMlJobsJobsRecord.md @@ -1,4 +1,4 @@ -## Interface `CatMlJobsJobsRecord` +# `CatMlJobsJobsRecord` [interface-CatMlJobsJobsRecord] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/CatMlJobsRequest.md b/docs/reference/api/CatMlJobsRequest.md index a3fab502a..e5c33016d 100644 --- a/docs/reference/api/CatMlJobsRequest.md +++ b/docs/reference/api/CatMlJobsRequest.md @@ -1,4 +1,4 @@ -## Interface `CatMlJobsRequest` +# `CatMlJobsRequest` [interface-CatMlJobsRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/CatMlJobsResponse.md b/docs/reference/api/CatMlJobsResponse.md index 039389c79..bbe2105d8 100644 --- a/docs/reference/api/CatMlJobsResponse.md +++ b/docs/reference/api/CatMlJobsResponse.md @@ -1,4 +1,4 @@ -## `CatMlJobsResponse` -::: +# `CatMlJobsResponse` [alias-CatMlJobsResponse] +```typescript type CatMlJobsResponse = [CatMlJobsJobsRecord](./CatMlJobsJobsRecord.md)[]; -::: +``` diff --git a/docs/reference/api/CatMlTrainedModelsRequest.md b/docs/reference/api/CatMlTrainedModelsRequest.md index 031f2cd6a..527fcb30c 100644 --- a/docs/reference/api/CatMlTrainedModelsRequest.md +++ b/docs/reference/api/CatMlTrainedModelsRequest.md @@ -1,4 +1,4 @@ -## Interface `CatMlTrainedModelsRequest` +# `CatMlTrainedModelsRequest` [interface-CatMlTrainedModelsRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/CatMlTrainedModelsResponse.md b/docs/reference/api/CatMlTrainedModelsResponse.md index e97a55e4d..3561dd8be 100644 --- a/docs/reference/api/CatMlTrainedModelsResponse.md +++ b/docs/reference/api/CatMlTrainedModelsResponse.md @@ -1,4 +1,4 @@ -## `CatMlTrainedModelsResponse` -::: +# `CatMlTrainedModelsResponse` [alias-CatMlTrainedModelsResponse] +```typescript type CatMlTrainedModelsResponse = [CatMlTrainedModelsTrainedModelsRecord](./CatMlTrainedModelsTrainedModelsRecord.md)[]; -::: +``` diff --git a/docs/reference/api/CatMlTrainedModelsTrainedModelsRecord.md b/docs/reference/api/CatMlTrainedModelsTrainedModelsRecord.md index f24620b5b..652fb3712 100644 --- a/docs/reference/api/CatMlTrainedModelsTrainedModelsRecord.md +++ b/docs/reference/api/CatMlTrainedModelsTrainedModelsRecord.md @@ -1,4 +1,4 @@ -## Interface `CatMlTrainedModelsTrainedModelsRecord` +# `CatMlTrainedModelsTrainedModelsRecord` [interface-CatMlTrainedModelsTrainedModelsRecord] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/CatNodeattrsNodeAttributesRecord.md b/docs/reference/api/CatNodeattrsNodeAttributesRecord.md index 02d5563a1..f66085a82 100644 --- a/docs/reference/api/CatNodeattrsNodeAttributesRecord.md +++ b/docs/reference/api/CatNodeattrsNodeAttributesRecord.md @@ -1,4 +1,4 @@ -## Interface `CatNodeattrsNodeAttributesRecord` +# `CatNodeattrsNodeAttributesRecord` [interface-CatNodeattrsNodeAttributesRecord] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/CatNodeattrsRequest.md b/docs/reference/api/CatNodeattrsRequest.md index 29d4a0bae..4c4e3ca3d 100644 --- a/docs/reference/api/CatNodeattrsRequest.md +++ b/docs/reference/api/CatNodeattrsRequest.md @@ -1,4 +1,4 @@ -## Interface `CatNodeattrsRequest` +# `CatNodeattrsRequest` [interface-CatNodeattrsRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/CatNodeattrsResponse.md b/docs/reference/api/CatNodeattrsResponse.md index 8930d95f4..7be3b8427 100644 --- a/docs/reference/api/CatNodeattrsResponse.md +++ b/docs/reference/api/CatNodeattrsResponse.md @@ -1,4 +1,4 @@ -## `CatNodeattrsResponse` -::: +# `CatNodeattrsResponse` [alias-CatNodeattrsResponse] +```typescript type CatNodeattrsResponse = [CatNodeattrsNodeAttributesRecord](./CatNodeattrsNodeAttributesRecord.md)[]; -::: +``` diff --git a/docs/reference/api/CatNodesNodesRecord.md b/docs/reference/api/CatNodesNodesRecord.md index a40eb369b..f04d29970 100644 --- a/docs/reference/api/CatNodesNodesRecord.md +++ b/docs/reference/api/CatNodesNodesRecord.md @@ -1,4 +1,4 @@ -## Interface `CatNodesNodesRecord` +# `CatNodesNodesRecord` [interface-CatNodesNodesRecord] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/CatNodesRequest.md b/docs/reference/api/CatNodesRequest.md index 01f720c0e..398912436 100644 --- a/docs/reference/api/CatNodesRequest.md +++ b/docs/reference/api/CatNodesRequest.md @@ -1,4 +1,4 @@ -## Interface `CatNodesRequest` +# `CatNodesRequest` [interface-CatNodesRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/CatNodesResponse.md b/docs/reference/api/CatNodesResponse.md index 9398c0b83..7e1cb9448 100644 --- a/docs/reference/api/CatNodesResponse.md +++ b/docs/reference/api/CatNodesResponse.md @@ -1,4 +1,4 @@ -## `CatNodesResponse` -::: +# `CatNodesResponse` [alias-CatNodesResponse] +```typescript type CatNodesResponse = [CatNodesNodesRecord](./CatNodesNodesRecord.md)[]; -::: +``` diff --git a/docs/reference/api/CatPendingTasksPendingTasksRecord.md b/docs/reference/api/CatPendingTasksPendingTasksRecord.md index 31a0071ed..c6a3e01f9 100644 --- a/docs/reference/api/CatPendingTasksPendingTasksRecord.md +++ b/docs/reference/api/CatPendingTasksPendingTasksRecord.md @@ -1,4 +1,4 @@ -## Interface `CatPendingTasksPendingTasksRecord` +# `CatPendingTasksPendingTasksRecord` [interface-CatPendingTasksPendingTasksRecord] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/CatPendingTasksRequest.md b/docs/reference/api/CatPendingTasksRequest.md index 792f92f34..1d01030b3 100644 --- a/docs/reference/api/CatPendingTasksRequest.md +++ b/docs/reference/api/CatPendingTasksRequest.md @@ -1,4 +1,4 @@ -## Interface `CatPendingTasksRequest` +# `CatPendingTasksRequest` [interface-CatPendingTasksRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/CatPendingTasksResponse.md b/docs/reference/api/CatPendingTasksResponse.md index 866bfa88d..02599c584 100644 --- a/docs/reference/api/CatPendingTasksResponse.md +++ b/docs/reference/api/CatPendingTasksResponse.md @@ -1,4 +1,4 @@ -## `CatPendingTasksResponse` -::: +# `CatPendingTasksResponse` [alias-CatPendingTasksResponse] +```typescript type CatPendingTasksResponse = [CatPendingTasksPendingTasksRecord](./CatPendingTasksPendingTasksRecord.md)[]; -::: +``` diff --git a/docs/reference/api/CatPluginsPluginsRecord.md b/docs/reference/api/CatPluginsPluginsRecord.md index 75e723477..541da4c1b 100644 --- a/docs/reference/api/CatPluginsPluginsRecord.md +++ b/docs/reference/api/CatPluginsPluginsRecord.md @@ -1,4 +1,4 @@ -## Interface `CatPluginsPluginsRecord` +# `CatPluginsPluginsRecord` [interface-CatPluginsPluginsRecord] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/CatPluginsRequest.md b/docs/reference/api/CatPluginsRequest.md index 4c32eb525..9c7f42222 100644 --- a/docs/reference/api/CatPluginsRequest.md +++ b/docs/reference/api/CatPluginsRequest.md @@ -1,4 +1,4 @@ -## Interface `CatPluginsRequest` +# `CatPluginsRequest` [interface-CatPluginsRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/CatPluginsResponse.md b/docs/reference/api/CatPluginsResponse.md index 3e6499d79..c59335cda 100644 --- a/docs/reference/api/CatPluginsResponse.md +++ b/docs/reference/api/CatPluginsResponse.md @@ -1,4 +1,4 @@ -## `CatPluginsResponse` -::: +# `CatPluginsResponse` [alias-CatPluginsResponse] +```typescript type CatPluginsResponse = [CatPluginsPluginsRecord](./CatPluginsPluginsRecord.md)[]; -::: +``` diff --git a/docs/reference/api/CatRecoveryRecoveryRecord.md b/docs/reference/api/CatRecoveryRecoveryRecord.md index d20d6c039..02b498f49 100644 --- a/docs/reference/api/CatRecoveryRecoveryRecord.md +++ b/docs/reference/api/CatRecoveryRecoveryRecord.md @@ -1,4 +1,4 @@ -## Interface `CatRecoveryRecoveryRecord` +# `CatRecoveryRecoveryRecord` [interface-CatRecoveryRecoveryRecord] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/CatRecoveryRequest.md b/docs/reference/api/CatRecoveryRequest.md index 32a01f834..ead02dfdb 100644 --- a/docs/reference/api/CatRecoveryRequest.md +++ b/docs/reference/api/CatRecoveryRequest.md @@ -1,4 +1,4 @@ -## Interface `CatRecoveryRequest` +# `CatRecoveryRequest` [interface-CatRecoveryRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/CatRecoveryResponse.md b/docs/reference/api/CatRecoveryResponse.md index d87801f44..f4ae53053 100644 --- a/docs/reference/api/CatRecoveryResponse.md +++ b/docs/reference/api/CatRecoveryResponse.md @@ -1,4 +1,4 @@ -## `CatRecoveryResponse` -::: +# `CatRecoveryResponse` [alias-CatRecoveryResponse] +```typescript type CatRecoveryResponse = [CatRecoveryRecoveryRecord](./CatRecoveryRecoveryRecord.md)[]; -::: +``` diff --git a/docs/reference/api/CatRepositoriesRepositoriesRecord.md b/docs/reference/api/CatRepositoriesRepositoriesRecord.md index 7acc4cb7f..cb3392b8d 100644 --- a/docs/reference/api/CatRepositoriesRepositoriesRecord.md +++ b/docs/reference/api/CatRepositoriesRepositoriesRecord.md @@ -1,4 +1,4 @@ -## Interface `CatRepositoriesRepositoriesRecord` +# `CatRepositoriesRepositoriesRecord` [interface-CatRepositoriesRepositoriesRecord] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/CatRepositoriesRequest.md b/docs/reference/api/CatRepositoriesRequest.md index 1b971523e..93ad539c1 100644 --- a/docs/reference/api/CatRepositoriesRequest.md +++ b/docs/reference/api/CatRepositoriesRequest.md @@ -1,4 +1,4 @@ -## Interface `CatRepositoriesRequest` +# `CatRepositoriesRequest` [interface-CatRepositoriesRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/CatRepositoriesResponse.md b/docs/reference/api/CatRepositoriesResponse.md index f704850ab..05a86ea67 100644 --- a/docs/reference/api/CatRepositoriesResponse.md +++ b/docs/reference/api/CatRepositoriesResponse.md @@ -1,4 +1,4 @@ -## `CatRepositoriesResponse` -::: +# `CatRepositoriesResponse` [alias-CatRepositoriesResponse] +```typescript type CatRepositoriesResponse = [CatRepositoriesRepositoriesRecord](./CatRepositoriesRepositoriesRecord.md)[]; -::: +``` diff --git a/docs/reference/api/CatSegmentsRequest.md b/docs/reference/api/CatSegmentsRequest.md index 5c43a1651..b02625891 100644 --- a/docs/reference/api/CatSegmentsRequest.md +++ b/docs/reference/api/CatSegmentsRequest.md @@ -1,4 +1,4 @@ -## Interface `CatSegmentsRequest` +# `CatSegmentsRequest` [interface-CatSegmentsRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/CatSegmentsResponse.md b/docs/reference/api/CatSegmentsResponse.md index 788112c5b..e0a5d9ea8 100644 --- a/docs/reference/api/CatSegmentsResponse.md +++ b/docs/reference/api/CatSegmentsResponse.md @@ -1,4 +1,4 @@ -## `CatSegmentsResponse` -::: +# `CatSegmentsResponse` [alias-CatSegmentsResponse] +```typescript type CatSegmentsResponse = [CatSegmentsSegmentsRecord](./CatSegmentsSegmentsRecord.md)[]; -::: +``` diff --git a/docs/reference/api/CatSegmentsSegmentsRecord.md b/docs/reference/api/CatSegmentsSegmentsRecord.md index ead5e2b1d..8f9865564 100644 --- a/docs/reference/api/CatSegmentsSegmentsRecord.md +++ b/docs/reference/api/CatSegmentsSegmentsRecord.md @@ -1,4 +1,4 @@ -## Interface `CatSegmentsSegmentsRecord` +# `CatSegmentsSegmentsRecord` [interface-CatSegmentsSegmentsRecord] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/CatShardsRequest.md b/docs/reference/api/CatShardsRequest.md index 4092d3802..a48c6857c 100644 --- a/docs/reference/api/CatShardsRequest.md +++ b/docs/reference/api/CatShardsRequest.md @@ -1,4 +1,4 @@ -## Interface `CatShardsRequest` +# `CatShardsRequest` [interface-CatShardsRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/CatShardsResponse.md b/docs/reference/api/CatShardsResponse.md index 57ad8a71d..f983730b9 100644 --- a/docs/reference/api/CatShardsResponse.md +++ b/docs/reference/api/CatShardsResponse.md @@ -1,4 +1,4 @@ -## `CatShardsResponse` -::: +# `CatShardsResponse` [alias-CatShardsResponse] +```typescript type CatShardsResponse = [CatShardsShardsRecord](./CatShardsShardsRecord.md)[]; -::: +``` diff --git a/docs/reference/api/CatShardsShardsRecord.md b/docs/reference/api/CatShardsShardsRecord.md index ca66ea3c1..d57e8e1ed 100644 --- a/docs/reference/api/CatShardsShardsRecord.md +++ b/docs/reference/api/CatShardsShardsRecord.md @@ -1,4 +1,4 @@ -## Interface `CatShardsShardsRecord` +# `CatShardsShardsRecord` [interface-CatShardsShardsRecord] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/CatSnapshotsRequest.md b/docs/reference/api/CatSnapshotsRequest.md index 6e110f693..1047a9841 100644 --- a/docs/reference/api/CatSnapshotsRequest.md +++ b/docs/reference/api/CatSnapshotsRequest.md @@ -1,4 +1,4 @@ -## Interface `CatSnapshotsRequest` +# `CatSnapshotsRequest` [interface-CatSnapshotsRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/CatSnapshotsResponse.md b/docs/reference/api/CatSnapshotsResponse.md index 3bfc3e78b..0cd8d9e23 100644 --- a/docs/reference/api/CatSnapshotsResponse.md +++ b/docs/reference/api/CatSnapshotsResponse.md @@ -1,4 +1,4 @@ -## `CatSnapshotsResponse` -::: +# `CatSnapshotsResponse` [alias-CatSnapshotsResponse] +```typescript type CatSnapshotsResponse = [CatSnapshotsSnapshotsRecord](./CatSnapshotsSnapshotsRecord.md)[]; -::: +``` diff --git a/docs/reference/api/CatSnapshotsSnapshotsRecord.md b/docs/reference/api/CatSnapshotsSnapshotsRecord.md index 71f8af661..a48b49561 100644 --- a/docs/reference/api/CatSnapshotsSnapshotsRecord.md +++ b/docs/reference/api/CatSnapshotsSnapshotsRecord.md @@ -1,4 +1,4 @@ -## Interface `CatSnapshotsSnapshotsRecord` +# `CatSnapshotsSnapshotsRecord` [interface-CatSnapshotsSnapshotsRecord] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/CatTasksRequest.md b/docs/reference/api/CatTasksRequest.md index 169fd0da3..61c5f7613 100644 --- a/docs/reference/api/CatTasksRequest.md +++ b/docs/reference/api/CatTasksRequest.md @@ -1,4 +1,4 @@ -## Interface `CatTasksRequest` +# `CatTasksRequest` [interface-CatTasksRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/CatTasksResponse.md b/docs/reference/api/CatTasksResponse.md index d4b385f5d..3499494f6 100644 --- a/docs/reference/api/CatTasksResponse.md +++ b/docs/reference/api/CatTasksResponse.md @@ -1,4 +1,4 @@ -## `CatTasksResponse` -::: +# `CatTasksResponse` [alias-CatTasksResponse] +```typescript type CatTasksResponse = [CatTasksTasksRecord](./CatTasksTasksRecord.md)[]; -::: +``` diff --git a/docs/reference/api/CatTasksTasksRecord.md b/docs/reference/api/CatTasksTasksRecord.md index 1fc54fe0f..2daa55c2e 100644 --- a/docs/reference/api/CatTasksTasksRecord.md +++ b/docs/reference/api/CatTasksTasksRecord.md @@ -1,4 +1,4 @@ -## Interface `CatTasksTasksRecord` +# `CatTasksTasksRecord` [interface-CatTasksTasksRecord] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/CatTemplatesRequest.md b/docs/reference/api/CatTemplatesRequest.md index 41e1993cf..842a71967 100644 --- a/docs/reference/api/CatTemplatesRequest.md +++ b/docs/reference/api/CatTemplatesRequest.md @@ -1,4 +1,4 @@ -## Interface `CatTemplatesRequest` +# `CatTemplatesRequest` [interface-CatTemplatesRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/CatTemplatesResponse.md b/docs/reference/api/CatTemplatesResponse.md index 61f7dff8b..2fb0cac97 100644 --- a/docs/reference/api/CatTemplatesResponse.md +++ b/docs/reference/api/CatTemplatesResponse.md @@ -1,4 +1,4 @@ -## `CatTemplatesResponse` -::: +# `CatTemplatesResponse` [alias-CatTemplatesResponse] +```typescript type CatTemplatesResponse = [CatTemplatesTemplatesRecord](./CatTemplatesTemplatesRecord.md)[]; -::: +``` diff --git a/docs/reference/api/CatTemplatesTemplatesRecord.md b/docs/reference/api/CatTemplatesTemplatesRecord.md index 2e4119bbd..fb27f1e67 100644 --- a/docs/reference/api/CatTemplatesTemplatesRecord.md +++ b/docs/reference/api/CatTemplatesTemplatesRecord.md @@ -1,4 +1,4 @@ -## Interface `CatTemplatesTemplatesRecord` +# `CatTemplatesTemplatesRecord` [interface-CatTemplatesTemplatesRecord] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/CatThreadPoolRequest.md b/docs/reference/api/CatThreadPoolRequest.md index 975abb37c..a9f1783a5 100644 --- a/docs/reference/api/CatThreadPoolRequest.md +++ b/docs/reference/api/CatThreadPoolRequest.md @@ -1,4 +1,4 @@ -## Interface `CatThreadPoolRequest` +# `CatThreadPoolRequest` [interface-CatThreadPoolRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/CatThreadPoolResponse.md b/docs/reference/api/CatThreadPoolResponse.md index f13a4ecd4..bebda8e1f 100644 --- a/docs/reference/api/CatThreadPoolResponse.md +++ b/docs/reference/api/CatThreadPoolResponse.md @@ -1,4 +1,4 @@ -## `CatThreadPoolResponse` -::: +# `CatThreadPoolResponse` [alias-CatThreadPoolResponse] +```typescript type CatThreadPoolResponse = [CatThreadPoolThreadPoolRecord](./CatThreadPoolThreadPoolRecord.md)[]; -::: +``` diff --git a/docs/reference/api/CatThreadPoolThreadPoolRecord.md b/docs/reference/api/CatThreadPoolThreadPoolRecord.md index cddab7144..4e5eed468 100644 --- a/docs/reference/api/CatThreadPoolThreadPoolRecord.md +++ b/docs/reference/api/CatThreadPoolThreadPoolRecord.md @@ -1,4 +1,4 @@ -## Interface `CatThreadPoolThreadPoolRecord` +# `CatThreadPoolThreadPoolRecord` [interface-CatThreadPoolThreadPoolRecord] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/CatTransformsRequest.md b/docs/reference/api/CatTransformsRequest.md index 1adb91be3..0ac652e8d 100644 --- a/docs/reference/api/CatTransformsRequest.md +++ b/docs/reference/api/CatTransformsRequest.md @@ -1,4 +1,4 @@ -## Interface `CatTransformsRequest` +# `CatTransformsRequest` [interface-CatTransformsRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/CatTransformsResponse.md b/docs/reference/api/CatTransformsResponse.md index 13d4c2dc2..8ee179b04 100644 --- a/docs/reference/api/CatTransformsResponse.md +++ b/docs/reference/api/CatTransformsResponse.md @@ -1,4 +1,4 @@ -## `CatTransformsResponse` -::: +# `CatTransformsResponse` [alias-CatTransformsResponse] +```typescript type CatTransformsResponse = [CatTransformsTransformsRecord](./CatTransformsTransformsRecord.md)[]; -::: +``` diff --git a/docs/reference/api/CatTransformsTransformsRecord.md b/docs/reference/api/CatTransformsTransformsRecord.md index 942bf24a8..2e9733480 100644 --- a/docs/reference/api/CatTransformsTransformsRecord.md +++ b/docs/reference/api/CatTransformsTransformsRecord.md @@ -1,4 +1,4 @@ -## Interface `CatTransformsTransformsRecord` +# `CatTransformsTransformsRecord` [interface-CatTransformsTransformsRecord] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/CategoryId.md b/docs/reference/api/CategoryId.md index e685e7cb7..c6a24152d 100644 --- a/docs/reference/api/CategoryId.md +++ b/docs/reference/api/CategoryId.md @@ -1,4 +1,4 @@ -## `CategoryId` -::: +# `CategoryId` [alias-CategoryId] +```typescript type CategoryId = string; -::: +``` diff --git a/docs/reference/api/Ccr.md b/docs/reference/api/Ccr.md index 6fdc7500f..f9dc62293 100644 --- a/docs/reference/api/Ccr.md +++ b/docs/reference/api/Ccr.md @@ -1,19 +1,19 @@ -## `Ccr` +# `Ccr` [class-Ccr] -### Constructor +## Constructor -::: +```typescript new Ccr(transport: [Transport](./Transport.md)); -::: +``` -### Properties +## Properties [class-properties-Ccr] | Name | Type | Description | | - | - | - | | `acceptedParams` | Record |   | | `transport` | [Transport](./Transport.md) |   | -### Methods +## Methods [class-methods-Ccr] | Name | Signature | Description | | - | - | - | diff --git a/docs/reference/api/CcrDeleteAutoFollowPatternRequest.md b/docs/reference/api/CcrDeleteAutoFollowPatternRequest.md index 96a0bee3b..9935be45e 100644 --- a/docs/reference/api/CcrDeleteAutoFollowPatternRequest.md +++ b/docs/reference/api/CcrDeleteAutoFollowPatternRequest.md @@ -1,4 +1,4 @@ -## Interface `CcrDeleteAutoFollowPatternRequest` +# `CcrDeleteAutoFollowPatternRequest` [interface-CcrDeleteAutoFollowPatternRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/CcrDeleteAutoFollowPatternResponse.md b/docs/reference/api/CcrDeleteAutoFollowPatternResponse.md index 649f9ef0d..8a6aed11d 100644 --- a/docs/reference/api/CcrDeleteAutoFollowPatternResponse.md +++ b/docs/reference/api/CcrDeleteAutoFollowPatternResponse.md @@ -1,4 +1,4 @@ -## `CcrDeleteAutoFollowPatternResponse` -::: +# `CcrDeleteAutoFollowPatternResponse` [alias-CcrDeleteAutoFollowPatternResponse] +```typescript type CcrDeleteAutoFollowPatternResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); -::: +``` diff --git a/docs/reference/api/CcrFollowIndexStats.md b/docs/reference/api/CcrFollowIndexStats.md index c909609a1..acb0bda5e 100644 --- a/docs/reference/api/CcrFollowIndexStats.md +++ b/docs/reference/api/CcrFollowIndexStats.md @@ -1,4 +1,4 @@ -## Interface `CcrFollowIndexStats` +# `CcrFollowIndexStats` [interface-CcrFollowIndexStats] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/CcrFollowInfoFollowerIndex.md b/docs/reference/api/CcrFollowInfoFollowerIndex.md index 68282da1b..b6c28600f 100644 --- a/docs/reference/api/CcrFollowInfoFollowerIndex.md +++ b/docs/reference/api/CcrFollowInfoFollowerIndex.md @@ -1,4 +1,4 @@ -## Interface `CcrFollowInfoFollowerIndex` +# `CcrFollowInfoFollowerIndex` [interface-CcrFollowInfoFollowerIndex] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/CcrFollowInfoFollowerIndexParameters.md b/docs/reference/api/CcrFollowInfoFollowerIndexParameters.md index dc163f84d..f92453ce2 100644 --- a/docs/reference/api/CcrFollowInfoFollowerIndexParameters.md +++ b/docs/reference/api/CcrFollowInfoFollowerIndexParameters.md @@ -1,4 +1,4 @@ -## Interface `CcrFollowInfoFollowerIndexParameters` +# `CcrFollowInfoFollowerIndexParameters` [interface-CcrFollowInfoFollowerIndexParameters] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/CcrFollowInfoFollowerIndexStatus.md b/docs/reference/api/CcrFollowInfoFollowerIndexStatus.md index 8b89fcda6..6c60ef995 100644 --- a/docs/reference/api/CcrFollowInfoFollowerIndexStatus.md +++ b/docs/reference/api/CcrFollowInfoFollowerIndexStatus.md @@ -1,4 +1,4 @@ -## `CcrFollowInfoFollowerIndexStatus` -::: +# `CcrFollowInfoFollowerIndexStatus` [alias-CcrFollowInfoFollowerIndexStatus] +```typescript type CcrFollowInfoFollowerIndexStatus = 'active' | 'paused'; -::: +``` diff --git a/docs/reference/api/CcrFollowInfoRequest.md b/docs/reference/api/CcrFollowInfoRequest.md index f1ae2b231..fe950d45a 100644 --- a/docs/reference/api/CcrFollowInfoRequest.md +++ b/docs/reference/api/CcrFollowInfoRequest.md @@ -1,4 +1,4 @@ -## Interface `CcrFollowInfoRequest` +# `CcrFollowInfoRequest` [interface-CcrFollowInfoRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/CcrFollowInfoResponse.md b/docs/reference/api/CcrFollowInfoResponse.md index 7d552e7e5..54a84edc0 100644 --- a/docs/reference/api/CcrFollowInfoResponse.md +++ b/docs/reference/api/CcrFollowInfoResponse.md @@ -1,4 +1,4 @@ -## Interface `CcrFollowInfoResponse` +# `CcrFollowInfoResponse` [interface-CcrFollowInfoResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/CcrFollowRequest.md b/docs/reference/api/CcrFollowRequest.md index 4ed187ab9..0fa01810a 100644 --- a/docs/reference/api/CcrFollowRequest.md +++ b/docs/reference/api/CcrFollowRequest.md @@ -1,4 +1,4 @@ -## Interface `CcrFollowRequest` +# `CcrFollowRequest` [interface-CcrFollowRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/CcrFollowResponse.md b/docs/reference/api/CcrFollowResponse.md index 164ac5764..4a27afc2c 100644 --- a/docs/reference/api/CcrFollowResponse.md +++ b/docs/reference/api/CcrFollowResponse.md @@ -1,4 +1,4 @@ -## Interface `CcrFollowResponse` +# `CcrFollowResponse` [interface-CcrFollowResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/CcrFollowStatsRequest.md b/docs/reference/api/CcrFollowStatsRequest.md index 4101e0ace..aacbde115 100644 --- a/docs/reference/api/CcrFollowStatsRequest.md +++ b/docs/reference/api/CcrFollowStatsRequest.md @@ -1,4 +1,4 @@ -## Interface `CcrFollowStatsRequest` +# `CcrFollowStatsRequest` [interface-CcrFollowStatsRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/CcrFollowStatsResponse.md b/docs/reference/api/CcrFollowStatsResponse.md index 1c602130e..598255edd 100644 --- a/docs/reference/api/CcrFollowStatsResponse.md +++ b/docs/reference/api/CcrFollowStatsResponse.md @@ -1,4 +1,4 @@ -## Interface `CcrFollowStatsResponse` +# `CcrFollowStatsResponse` [interface-CcrFollowStatsResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/CcrForgetFollowerRequest.md b/docs/reference/api/CcrForgetFollowerRequest.md index 17637c0c7..8aa35e962 100644 --- a/docs/reference/api/CcrForgetFollowerRequest.md +++ b/docs/reference/api/CcrForgetFollowerRequest.md @@ -1,4 +1,4 @@ -## Interface `CcrForgetFollowerRequest` +# `CcrForgetFollowerRequest` [interface-CcrForgetFollowerRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/CcrForgetFollowerResponse.md b/docs/reference/api/CcrForgetFollowerResponse.md index 70cfde3ed..883c2d198 100644 --- a/docs/reference/api/CcrForgetFollowerResponse.md +++ b/docs/reference/api/CcrForgetFollowerResponse.md @@ -1,4 +1,4 @@ -## Interface `CcrForgetFollowerResponse` +# `CcrForgetFollowerResponse` [interface-CcrForgetFollowerResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/CcrGetAutoFollowPatternAutoFollowPattern.md b/docs/reference/api/CcrGetAutoFollowPatternAutoFollowPattern.md index 0af365570..6955904f2 100644 --- a/docs/reference/api/CcrGetAutoFollowPatternAutoFollowPattern.md +++ b/docs/reference/api/CcrGetAutoFollowPatternAutoFollowPattern.md @@ -1,4 +1,4 @@ -## Interface `CcrGetAutoFollowPatternAutoFollowPattern` +# `CcrGetAutoFollowPatternAutoFollowPattern` [interface-CcrGetAutoFollowPatternAutoFollowPattern] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/CcrGetAutoFollowPatternAutoFollowPatternSummary.md b/docs/reference/api/CcrGetAutoFollowPatternAutoFollowPatternSummary.md index 058fdc56d..1b3daa298 100644 --- a/docs/reference/api/CcrGetAutoFollowPatternAutoFollowPatternSummary.md +++ b/docs/reference/api/CcrGetAutoFollowPatternAutoFollowPatternSummary.md @@ -1,4 +1,4 @@ -## Interface `CcrGetAutoFollowPatternAutoFollowPatternSummary` +# `CcrGetAutoFollowPatternAutoFollowPatternSummary` [interface-CcrGetAutoFollowPatternAutoFollowPatternSummary] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/CcrGetAutoFollowPatternRequest.md b/docs/reference/api/CcrGetAutoFollowPatternRequest.md index bfa4d80c1..e7e22fe36 100644 --- a/docs/reference/api/CcrGetAutoFollowPatternRequest.md +++ b/docs/reference/api/CcrGetAutoFollowPatternRequest.md @@ -1,4 +1,4 @@ -## Interface `CcrGetAutoFollowPatternRequest` +# `CcrGetAutoFollowPatternRequest` [interface-CcrGetAutoFollowPatternRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/CcrGetAutoFollowPatternResponse.md b/docs/reference/api/CcrGetAutoFollowPatternResponse.md index 2e18e1540..0b4ece84c 100644 --- a/docs/reference/api/CcrGetAutoFollowPatternResponse.md +++ b/docs/reference/api/CcrGetAutoFollowPatternResponse.md @@ -1,4 +1,4 @@ -## Interface `CcrGetAutoFollowPatternResponse` +# `CcrGetAutoFollowPatternResponse` [interface-CcrGetAutoFollowPatternResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/CcrPauseAutoFollowPatternRequest.md b/docs/reference/api/CcrPauseAutoFollowPatternRequest.md index 69670af41..2c5a8d442 100644 --- a/docs/reference/api/CcrPauseAutoFollowPatternRequest.md +++ b/docs/reference/api/CcrPauseAutoFollowPatternRequest.md @@ -1,4 +1,4 @@ -## Interface `CcrPauseAutoFollowPatternRequest` +# `CcrPauseAutoFollowPatternRequest` [interface-CcrPauseAutoFollowPatternRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/CcrPauseAutoFollowPatternResponse.md b/docs/reference/api/CcrPauseAutoFollowPatternResponse.md index e29c13d4b..f6ea783ee 100644 --- a/docs/reference/api/CcrPauseAutoFollowPatternResponse.md +++ b/docs/reference/api/CcrPauseAutoFollowPatternResponse.md @@ -1,4 +1,4 @@ -## `CcrPauseAutoFollowPatternResponse` -::: +# `CcrPauseAutoFollowPatternResponse` [alias-CcrPauseAutoFollowPatternResponse] +```typescript type CcrPauseAutoFollowPatternResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); -::: +``` diff --git a/docs/reference/api/CcrPauseFollowRequest.md b/docs/reference/api/CcrPauseFollowRequest.md index 260a0944a..ca017a067 100644 --- a/docs/reference/api/CcrPauseFollowRequest.md +++ b/docs/reference/api/CcrPauseFollowRequest.md @@ -1,4 +1,4 @@ -## Interface `CcrPauseFollowRequest` +# `CcrPauseFollowRequest` [interface-CcrPauseFollowRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/CcrPauseFollowResponse.md b/docs/reference/api/CcrPauseFollowResponse.md index 5e5e2fb1a..9ed1d4a3f 100644 --- a/docs/reference/api/CcrPauseFollowResponse.md +++ b/docs/reference/api/CcrPauseFollowResponse.md @@ -1,4 +1,4 @@ -## `CcrPauseFollowResponse` -::: +# `CcrPauseFollowResponse` [alias-CcrPauseFollowResponse] +```typescript type CcrPauseFollowResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); -::: +``` diff --git a/docs/reference/api/CcrPutAutoFollowPatternRequest.md b/docs/reference/api/CcrPutAutoFollowPatternRequest.md index 5b78ed59d..12e7ba18f 100644 --- a/docs/reference/api/CcrPutAutoFollowPatternRequest.md +++ b/docs/reference/api/CcrPutAutoFollowPatternRequest.md @@ -1,4 +1,4 @@ -## Interface `CcrPutAutoFollowPatternRequest` +# `CcrPutAutoFollowPatternRequest` [interface-CcrPutAutoFollowPatternRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/CcrPutAutoFollowPatternResponse.md b/docs/reference/api/CcrPutAutoFollowPatternResponse.md index aec5d57c1..d1993a871 100644 --- a/docs/reference/api/CcrPutAutoFollowPatternResponse.md +++ b/docs/reference/api/CcrPutAutoFollowPatternResponse.md @@ -1,4 +1,4 @@ -## `CcrPutAutoFollowPatternResponse` -::: +# `CcrPutAutoFollowPatternResponse` [alias-CcrPutAutoFollowPatternResponse] +```typescript type CcrPutAutoFollowPatternResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); -::: +``` diff --git a/docs/reference/api/CcrReadException.md b/docs/reference/api/CcrReadException.md index a2dbcb67e..27ad1a9ae 100644 --- a/docs/reference/api/CcrReadException.md +++ b/docs/reference/api/CcrReadException.md @@ -1,4 +1,4 @@ -## Interface `CcrReadException` +# `CcrReadException` [interface-CcrReadException] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/CcrResumeAutoFollowPatternRequest.md b/docs/reference/api/CcrResumeAutoFollowPatternRequest.md index cbc188d68..bd27a6555 100644 --- a/docs/reference/api/CcrResumeAutoFollowPatternRequest.md +++ b/docs/reference/api/CcrResumeAutoFollowPatternRequest.md @@ -1,4 +1,4 @@ -## Interface `CcrResumeAutoFollowPatternRequest` +# `CcrResumeAutoFollowPatternRequest` [interface-CcrResumeAutoFollowPatternRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/CcrResumeAutoFollowPatternResponse.md b/docs/reference/api/CcrResumeAutoFollowPatternResponse.md index ef43ef10b..0b93b9626 100644 --- a/docs/reference/api/CcrResumeAutoFollowPatternResponse.md +++ b/docs/reference/api/CcrResumeAutoFollowPatternResponse.md @@ -1,4 +1,4 @@ -## `CcrResumeAutoFollowPatternResponse` -::: +# `CcrResumeAutoFollowPatternResponse` [alias-CcrResumeAutoFollowPatternResponse] +```typescript type CcrResumeAutoFollowPatternResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); -::: +``` diff --git a/docs/reference/api/CcrResumeFollowRequest.md b/docs/reference/api/CcrResumeFollowRequest.md index 0c585944d..afea5b7d8 100644 --- a/docs/reference/api/CcrResumeFollowRequest.md +++ b/docs/reference/api/CcrResumeFollowRequest.md @@ -1,4 +1,4 @@ -## Interface `CcrResumeFollowRequest` +# `CcrResumeFollowRequest` [interface-CcrResumeFollowRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/CcrResumeFollowResponse.md b/docs/reference/api/CcrResumeFollowResponse.md index ecf383d62..eac06a947 100644 --- a/docs/reference/api/CcrResumeFollowResponse.md +++ b/docs/reference/api/CcrResumeFollowResponse.md @@ -1,4 +1,4 @@ -## `CcrResumeFollowResponse` -::: +# `CcrResumeFollowResponse` [alias-CcrResumeFollowResponse] +```typescript type CcrResumeFollowResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); -::: +``` diff --git a/docs/reference/api/CcrShardStats.md b/docs/reference/api/CcrShardStats.md index 418abc915..793d84367 100644 --- a/docs/reference/api/CcrShardStats.md +++ b/docs/reference/api/CcrShardStats.md @@ -1,4 +1,4 @@ -## Interface `CcrShardStats` +# `CcrShardStats` [interface-CcrShardStats] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/CcrStatsAutoFollowStats.md b/docs/reference/api/CcrStatsAutoFollowStats.md index 3b3edd3d4..f0a716a80 100644 --- a/docs/reference/api/CcrStatsAutoFollowStats.md +++ b/docs/reference/api/CcrStatsAutoFollowStats.md @@ -1,4 +1,4 @@ -## Interface `CcrStatsAutoFollowStats` +# `CcrStatsAutoFollowStats` [interface-CcrStatsAutoFollowStats] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/CcrStatsAutoFollowedCluster.md b/docs/reference/api/CcrStatsAutoFollowedCluster.md index be41e7896..fbcf87507 100644 --- a/docs/reference/api/CcrStatsAutoFollowedCluster.md +++ b/docs/reference/api/CcrStatsAutoFollowedCluster.md @@ -1,4 +1,4 @@ -## Interface `CcrStatsAutoFollowedCluster` +# `CcrStatsAutoFollowedCluster` [interface-CcrStatsAutoFollowedCluster] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/CcrStatsFollowStats.md b/docs/reference/api/CcrStatsFollowStats.md index d1f679f59..de9c9161e 100644 --- a/docs/reference/api/CcrStatsFollowStats.md +++ b/docs/reference/api/CcrStatsFollowStats.md @@ -1,4 +1,4 @@ -## Interface `CcrStatsFollowStats` +# `CcrStatsFollowStats` [interface-CcrStatsFollowStats] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/CcrStatsRequest.md b/docs/reference/api/CcrStatsRequest.md index 706646421..fa86c11af 100644 --- a/docs/reference/api/CcrStatsRequest.md +++ b/docs/reference/api/CcrStatsRequest.md @@ -1,4 +1,4 @@ -## Interface `CcrStatsRequest` +# `CcrStatsRequest` [interface-CcrStatsRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/CcrStatsResponse.md b/docs/reference/api/CcrStatsResponse.md index 476dd1e52..5aa165883 100644 --- a/docs/reference/api/CcrStatsResponse.md +++ b/docs/reference/api/CcrStatsResponse.md @@ -1,4 +1,4 @@ -## Interface `CcrStatsResponse` +# `CcrStatsResponse` [interface-CcrStatsResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/CcrUnfollowRequest.md b/docs/reference/api/CcrUnfollowRequest.md index 5be7d33e3..165109200 100644 --- a/docs/reference/api/CcrUnfollowRequest.md +++ b/docs/reference/api/CcrUnfollowRequest.md @@ -1,4 +1,4 @@ -## Interface `CcrUnfollowRequest` +# `CcrUnfollowRequest` [interface-CcrUnfollowRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/CcrUnfollowResponse.md b/docs/reference/api/CcrUnfollowResponse.md index e60546901..663f54598 100644 --- a/docs/reference/api/CcrUnfollowResponse.md +++ b/docs/reference/api/CcrUnfollowResponse.md @@ -1,4 +1,4 @@ -## `CcrUnfollowResponse` -::: +# `CcrUnfollowResponse` [alias-CcrUnfollowResponse] +```typescript type CcrUnfollowResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); -::: +``` diff --git a/docs/reference/api/ClearScrollApi_1.md b/docs/reference/api/ClearScrollApi_1.md index 984acb6a4..a52a23bb0 100644 --- a/docs/reference/api/ClearScrollApi_1.md +++ b/docs/reference/api/ClearScrollApi_1.md @@ -1,3 +1,3 @@ -::: +```typescript default function ClearScrollApi(this: [That](./That.md), params?: [ClearScrollRequest](./ClearScrollRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ClearScrollResponse](./ClearScrollResponse.md)>; -::: +``` diff --git a/docs/reference/api/ClearScrollApi_2.md b/docs/reference/api/ClearScrollApi_2.md index 7cbd44737..21d6153b4 100644 --- a/docs/reference/api/ClearScrollApi_2.md +++ b/docs/reference/api/ClearScrollApi_2.md @@ -1,3 +1,3 @@ -::: +```typescript default function ClearScrollApi(this: [That](./That.md), params?: [ClearScrollRequest](./ClearScrollRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ClearScrollResponse](./ClearScrollResponse.md), unknown>>; -::: +``` diff --git a/docs/reference/api/ClearScrollApi_3.md b/docs/reference/api/ClearScrollApi_3.md index c5b636ea4..333aa20fa 100644 --- a/docs/reference/api/ClearScrollApi_3.md +++ b/docs/reference/api/ClearScrollApi_3.md @@ -1,3 +1,3 @@ -::: +```typescript default function ClearScrollApi(this: [That](./That.md), params?: [ClearScrollRequest](./ClearScrollRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ClearScrollResponse](./ClearScrollResponse.md)>; -::: +``` diff --git a/docs/reference/api/ClearScrollRequest.md b/docs/reference/api/ClearScrollRequest.md index 5304c32a4..7c0110a58 100644 --- a/docs/reference/api/ClearScrollRequest.md +++ b/docs/reference/api/ClearScrollRequest.md @@ -1,4 +1,4 @@ -## Interface `ClearScrollRequest` +# `ClearScrollRequest` [interface-ClearScrollRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ClearScrollResponse.md b/docs/reference/api/ClearScrollResponse.md index 6783b517f..7f6c07603 100644 --- a/docs/reference/api/ClearScrollResponse.md +++ b/docs/reference/api/ClearScrollResponse.md @@ -1,4 +1,4 @@ -## Interface `ClearScrollResponse` +# `ClearScrollResponse` [interface-ClearScrollResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/Client.md b/docs/reference/api/Client.md index 4998107b4..6166a5322 100644 --- a/docs/reference/api/Client.md +++ b/docs/reference/api/Client.md @@ -1,12 +1,12 @@ -## `Client` +# `Client` [class-Client] -### Constructor +## Constructor -::: +```typescript new Client(opts: [ClientOptions](./ClientOptions.md)); -::: +``` -### Properties +## Properties [class-properties-Client] | Name | Type | Description | | - | - | - | @@ -17,7 +17,7 @@ new Client(opts: [ClientOptions](./ClientOptions.md)); | `serializer` | [Serializer](./Serializer.md) |   | | `transport` | [SniffingTransport](./SniffingTransport.md) |   | -### Methods +## Methods [class-methods-Client] | Name | Signature | Description | | - | - | - | diff --git a/docs/reference/api/ClientOptions.md b/docs/reference/api/ClientOptions.md index 487f54f8e..7becff802 100644 --- a/docs/reference/api/ClientOptions.md +++ b/docs/reference/api/ClientOptions.md @@ -1,4 +1,4 @@ -## Interface `ClientOptions` +# `ClientOptions` [interface-ClientOptions] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ClosePointInTimeApi_1.md b/docs/reference/api/ClosePointInTimeApi_1.md index 8b03ccc60..ee89accf6 100644 --- a/docs/reference/api/ClosePointInTimeApi_1.md +++ b/docs/reference/api/ClosePointInTimeApi_1.md @@ -1,3 +1,3 @@ -::: +```typescript default function ClosePointInTimeApi(this: [That](./That.md), params: [ClosePointInTimeRequest](./ClosePointInTimeRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ClosePointInTimeResponse](./ClosePointInTimeResponse.md)>; -::: +``` diff --git a/docs/reference/api/ClosePointInTimeApi_2.md b/docs/reference/api/ClosePointInTimeApi_2.md index 6e25c35eb..c863d98fb 100644 --- a/docs/reference/api/ClosePointInTimeApi_2.md +++ b/docs/reference/api/ClosePointInTimeApi_2.md @@ -1,3 +1,3 @@ -::: +```typescript default function ClosePointInTimeApi(this: [That](./That.md), params: [ClosePointInTimeRequest](./ClosePointInTimeRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ClosePointInTimeResponse](./ClosePointInTimeResponse.md), unknown>>; -::: +``` diff --git a/docs/reference/api/ClosePointInTimeApi_3.md b/docs/reference/api/ClosePointInTimeApi_3.md index aeecba84a..947e5c7b9 100644 --- a/docs/reference/api/ClosePointInTimeApi_3.md +++ b/docs/reference/api/ClosePointInTimeApi_3.md @@ -1,3 +1,3 @@ -::: +```typescript default function ClosePointInTimeApi(this: [That](./That.md), params: [ClosePointInTimeRequest](./ClosePointInTimeRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ClosePointInTimeResponse](./ClosePointInTimeResponse.md)>; -::: +``` diff --git a/docs/reference/api/ClosePointInTimeRequest.md b/docs/reference/api/ClosePointInTimeRequest.md index 08bc21615..0041e12f4 100644 --- a/docs/reference/api/ClosePointInTimeRequest.md +++ b/docs/reference/api/ClosePointInTimeRequest.md @@ -1,4 +1,4 @@ -## Interface `ClosePointInTimeRequest` +# `ClosePointInTimeRequest` [interface-ClosePointInTimeRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ClosePointInTimeResponse.md b/docs/reference/api/ClosePointInTimeResponse.md index fc4c43403..95cf5f874 100644 --- a/docs/reference/api/ClosePointInTimeResponse.md +++ b/docs/reference/api/ClosePointInTimeResponse.md @@ -1,4 +1,4 @@ -## Interface `ClosePointInTimeResponse` +# `ClosePointInTimeResponse` [interface-ClosePointInTimeResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/Cluster.md b/docs/reference/api/Cluster.md index 04d2d21e7..736d56804 100644 --- a/docs/reference/api/Cluster.md +++ b/docs/reference/api/Cluster.md @@ -1,19 +1,19 @@ -## `Cluster` +# `Cluster` [class-Cluster] -### Constructor +## Constructor -::: +```typescript new Cluster(transport: [Transport](./Transport.md)); -::: +``` -### Properties +## Properties [class-properties-Cluster] | Name | Type | Description | | - | - | - | | `acceptedParams` | Record |   | | `transport` | [Transport](./Transport.md) |   | -### Methods +## Methods [class-methods-Cluster] | Name | Signature | Description | | - | - | - | diff --git a/docs/reference/api/ClusterAlias.md b/docs/reference/api/ClusterAlias.md index eabe0eb18..e12bd5151 100644 --- a/docs/reference/api/ClusterAlias.md +++ b/docs/reference/api/ClusterAlias.md @@ -1,4 +1,4 @@ -## `ClusterAlias` -::: +# `ClusterAlias` [alias-ClusterAlias] +```typescript type ClusterAlias = string; -::: +``` diff --git a/docs/reference/api/ClusterAllocationExplainAllocationDecision.md b/docs/reference/api/ClusterAllocationExplainAllocationDecision.md index 5b8ea01a3..585150ed0 100644 --- a/docs/reference/api/ClusterAllocationExplainAllocationDecision.md +++ b/docs/reference/api/ClusterAllocationExplainAllocationDecision.md @@ -1,4 +1,4 @@ -## Interface `ClusterAllocationExplainAllocationDecision` +# `ClusterAllocationExplainAllocationDecision` [interface-ClusterAllocationExplainAllocationDecision] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ClusterAllocationExplainAllocationExplainDecision.md b/docs/reference/api/ClusterAllocationExplainAllocationExplainDecision.md index e32f6ef8f..7e9fbf47e 100644 --- a/docs/reference/api/ClusterAllocationExplainAllocationExplainDecision.md +++ b/docs/reference/api/ClusterAllocationExplainAllocationExplainDecision.md @@ -1,4 +1,4 @@ -## `ClusterAllocationExplainAllocationExplainDecision` -::: +# `ClusterAllocationExplainAllocationExplainDecision` [alias-ClusterAllocationExplainAllocationExplainDecision] +```typescript type ClusterAllocationExplainAllocationExplainDecision = 'NO' | 'YES' | 'THROTTLE' | 'ALWAYS'; -::: +``` diff --git a/docs/reference/api/ClusterAllocationExplainAllocationStore.md b/docs/reference/api/ClusterAllocationExplainAllocationStore.md index 823f78ba8..b643d284a 100644 --- a/docs/reference/api/ClusterAllocationExplainAllocationStore.md +++ b/docs/reference/api/ClusterAllocationExplainAllocationStore.md @@ -1,4 +1,4 @@ -## Interface `ClusterAllocationExplainAllocationStore` +# `ClusterAllocationExplainAllocationStore` [interface-ClusterAllocationExplainAllocationStore] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ClusterAllocationExplainClusterInfo.md b/docs/reference/api/ClusterAllocationExplainClusterInfo.md index a8982579c..b92f8c5b8 100644 --- a/docs/reference/api/ClusterAllocationExplainClusterInfo.md +++ b/docs/reference/api/ClusterAllocationExplainClusterInfo.md @@ -1,4 +1,4 @@ -## Interface `ClusterAllocationExplainClusterInfo` +# `ClusterAllocationExplainClusterInfo` [interface-ClusterAllocationExplainClusterInfo] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ClusterAllocationExplainCurrentNode.md b/docs/reference/api/ClusterAllocationExplainCurrentNode.md index 7604f6ec1..873d627df 100644 --- a/docs/reference/api/ClusterAllocationExplainCurrentNode.md +++ b/docs/reference/api/ClusterAllocationExplainCurrentNode.md @@ -1,4 +1,4 @@ -## Interface `ClusterAllocationExplainCurrentNode` +# `ClusterAllocationExplainCurrentNode` [interface-ClusterAllocationExplainCurrentNode] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ClusterAllocationExplainDecision.md b/docs/reference/api/ClusterAllocationExplainDecision.md index 42ccde372..dc5420926 100644 --- a/docs/reference/api/ClusterAllocationExplainDecision.md +++ b/docs/reference/api/ClusterAllocationExplainDecision.md @@ -1,4 +1,4 @@ -## `ClusterAllocationExplainDecision` -::: +# `ClusterAllocationExplainDecision` [alias-ClusterAllocationExplainDecision] +```typescript type ClusterAllocationExplainDecision = 'yes' | 'no' | 'worse_balance' | 'throttled' | 'awaiting_info' | 'allocation_delayed' | 'no_valid_shard_copy' | 'no_attempt'; -::: +``` diff --git a/docs/reference/api/ClusterAllocationExplainDiskUsage.md b/docs/reference/api/ClusterAllocationExplainDiskUsage.md index eaaef3bfd..8b7fe9e80 100644 --- a/docs/reference/api/ClusterAllocationExplainDiskUsage.md +++ b/docs/reference/api/ClusterAllocationExplainDiskUsage.md @@ -1,4 +1,4 @@ -## Interface `ClusterAllocationExplainDiskUsage` +# `ClusterAllocationExplainDiskUsage` [interface-ClusterAllocationExplainDiskUsage] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ClusterAllocationExplainNodeAllocationExplanation.md b/docs/reference/api/ClusterAllocationExplainNodeAllocationExplanation.md index c5b441ef2..472fd9911 100644 --- a/docs/reference/api/ClusterAllocationExplainNodeAllocationExplanation.md +++ b/docs/reference/api/ClusterAllocationExplainNodeAllocationExplanation.md @@ -1,4 +1,4 @@ -## Interface `ClusterAllocationExplainNodeAllocationExplanation` +# `ClusterAllocationExplainNodeAllocationExplanation` [interface-ClusterAllocationExplainNodeAllocationExplanation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ClusterAllocationExplainNodeDiskUsage.md b/docs/reference/api/ClusterAllocationExplainNodeDiskUsage.md index e60a378a7..dd8a7d942 100644 --- a/docs/reference/api/ClusterAllocationExplainNodeDiskUsage.md +++ b/docs/reference/api/ClusterAllocationExplainNodeDiskUsage.md @@ -1,4 +1,4 @@ -## Interface `ClusterAllocationExplainNodeDiskUsage` +# `ClusterAllocationExplainNodeDiskUsage` [interface-ClusterAllocationExplainNodeDiskUsage] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ClusterAllocationExplainRequest.md b/docs/reference/api/ClusterAllocationExplainRequest.md index 9cd099306..758254983 100644 --- a/docs/reference/api/ClusterAllocationExplainRequest.md +++ b/docs/reference/api/ClusterAllocationExplainRequest.md @@ -1,4 +1,4 @@ -## Interface `ClusterAllocationExplainRequest` +# `ClusterAllocationExplainRequest` [interface-ClusterAllocationExplainRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ClusterAllocationExplainReservedSize.md b/docs/reference/api/ClusterAllocationExplainReservedSize.md index 175b84c39..665481233 100644 --- a/docs/reference/api/ClusterAllocationExplainReservedSize.md +++ b/docs/reference/api/ClusterAllocationExplainReservedSize.md @@ -1,4 +1,4 @@ -## Interface `ClusterAllocationExplainReservedSize` +# `ClusterAllocationExplainReservedSize` [interface-ClusterAllocationExplainReservedSize] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ClusterAllocationExplainResponse.md b/docs/reference/api/ClusterAllocationExplainResponse.md index ec5779c9f..8c24409b4 100644 --- a/docs/reference/api/ClusterAllocationExplainResponse.md +++ b/docs/reference/api/ClusterAllocationExplainResponse.md @@ -1,4 +1,4 @@ -## Interface `ClusterAllocationExplainResponse` +# `ClusterAllocationExplainResponse` [interface-ClusterAllocationExplainResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ClusterAllocationExplainUnassignedInformation.md b/docs/reference/api/ClusterAllocationExplainUnassignedInformation.md index a7e75eea2..ff3bca8e9 100644 --- a/docs/reference/api/ClusterAllocationExplainUnassignedInformation.md +++ b/docs/reference/api/ClusterAllocationExplainUnassignedInformation.md @@ -1,4 +1,4 @@ -## Interface `ClusterAllocationExplainUnassignedInformation` +# `ClusterAllocationExplainUnassignedInformation` [interface-ClusterAllocationExplainUnassignedInformation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ClusterAllocationExplainUnassignedInformationReason.md b/docs/reference/api/ClusterAllocationExplainUnassignedInformationReason.md index cca48a0d2..d35e4f85d 100644 --- a/docs/reference/api/ClusterAllocationExplainUnassignedInformationReason.md +++ b/docs/reference/api/ClusterAllocationExplainUnassignedInformationReason.md @@ -1,4 +1,4 @@ -## `ClusterAllocationExplainUnassignedInformationReason` -::: +# `ClusterAllocationExplainUnassignedInformationReason` [alias-ClusterAllocationExplainUnassignedInformationReason] +```typescript 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'; -::: +``` diff --git a/docs/reference/api/ClusterComponentTemplate.md b/docs/reference/api/ClusterComponentTemplate.md index 0a333f8e3..7faa91b28 100644 --- a/docs/reference/api/ClusterComponentTemplate.md +++ b/docs/reference/api/ClusterComponentTemplate.md @@ -1,4 +1,4 @@ -## Interface `ClusterComponentTemplate` +# `ClusterComponentTemplate` [interface-ClusterComponentTemplate] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ClusterComponentTemplateNode.md b/docs/reference/api/ClusterComponentTemplateNode.md index f6cbbc4d5..bd91988d6 100644 --- a/docs/reference/api/ClusterComponentTemplateNode.md +++ b/docs/reference/api/ClusterComponentTemplateNode.md @@ -1,4 +1,4 @@ -## Interface `ClusterComponentTemplateNode` +# `ClusterComponentTemplateNode` [interface-ClusterComponentTemplateNode] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ClusterComponentTemplateSummary.md b/docs/reference/api/ClusterComponentTemplateSummary.md index cf338840c..7cc2cf893 100644 --- a/docs/reference/api/ClusterComponentTemplateSummary.md +++ b/docs/reference/api/ClusterComponentTemplateSummary.md @@ -1,4 +1,4 @@ -## Interface `ClusterComponentTemplateSummary` +# `ClusterComponentTemplateSummary` [interface-ClusterComponentTemplateSummary] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ClusterDeleteComponentTemplateRequest.md b/docs/reference/api/ClusterDeleteComponentTemplateRequest.md index eb34e88ae..3ce7889fb 100644 --- a/docs/reference/api/ClusterDeleteComponentTemplateRequest.md +++ b/docs/reference/api/ClusterDeleteComponentTemplateRequest.md @@ -1,4 +1,4 @@ -## Interface `ClusterDeleteComponentTemplateRequest` +# `ClusterDeleteComponentTemplateRequest` [interface-ClusterDeleteComponentTemplateRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ClusterDeleteComponentTemplateResponse.md b/docs/reference/api/ClusterDeleteComponentTemplateResponse.md index cfc4e30be..ed4e6c2fa 100644 --- a/docs/reference/api/ClusterDeleteComponentTemplateResponse.md +++ b/docs/reference/api/ClusterDeleteComponentTemplateResponse.md @@ -1,4 +1,4 @@ -## `ClusterDeleteComponentTemplateResponse` -::: +# `ClusterDeleteComponentTemplateResponse` [alias-ClusterDeleteComponentTemplateResponse] +```typescript type ClusterDeleteComponentTemplateResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); -::: +``` diff --git a/docs/reference/api/ClusterDeleteVotingConfigExclusionsRequest.md b/docs/reference/api/ClusterDeleteVotingConfigExclusionsRequest.md index a4760ee81..bb5db5e1d 100644 --- a/docs/reference/api/ClusterDeleteVotingConfigExclusionsRequest.md +++ b/docs/reference/api/ClusterDeleteVotingConfigExclusionsRequest.md @@ -1,4 +1,4 @@ -## Interface `ClusterDeleteVotingConfigExclusionsRequest` +# `ClusterDeleteVotingConfigExclusionsRequest` [interface-ClusterDeleteVotingConfigExclusionsRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ClusterDeleteVotingConfigExclusionsResponse.md b/docs/reference/api/ClusterDeleteVotingConfigExclusionsResponse.md index 943f3c6b1..ef57fce1f 100644 --- a/docs/reference/api/ClusterDeleteVotingConfigExclusionsResponse.md +++ b/docs/reference/api/ClusterDeleteVotingConfigExclusionsResponse.md @@ -1,4 +1,4 @@ -## `ClusterDeleteVotingConfigExclusionsResponse` -::: +# `ClusterDeleteVotingConfigExclusionsResponse` [alias-ClusterDeleteVotingConfigExclusionsResponse] +```typescript type ClusterDeleteVotingConfigExclusionsResponse = boolean; -::: +``` diff --git a/docs/reference/api/ClusterDetails.md b/docs/reference/api/ClusterDetails.md index a61233ec0..24400aaef 100644 --- a/docs/reference/api/ClusterDetails.md +++ b/docs/reference/api/ClusterDetails.md @@ -1,4 +1,4 @@ -## Interface `ClusterDetails` +# `ClusterDetails` [interface-ClusterDetails] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ClusterExistsComponentTemplateRequest.md b/docs/reference/api/ClusterExistsComponentTemplateRequest.md index 656eea97b..53bc5b414 100644 --- a/docs/reference/api/ClusterExistsComponentTemplateRequest.md +++ b/docs/reference/api/ClusterExistsComponentTemplateRequest.md @@ -1,4 +1,4 @@ -## Interface `ClusterExistsComponentTemplateRequest` +# `ClusterExistsComponentTemplateRequest` [interface-ClusterExistsComponentTemplateRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ClusterExistsComponentTemplateResponse.md b/docs/reference/api/ClusterExistsComponentTemplateResponse.md index 27be92f22..8e645b111 100644 --- a/docs/reference/api/ClusterExistsComponentTemplateResponse.md +++ b/docs/reference/api/ClusterExistsComponentTemplateResponse.md @@ -1,4 +1,4 @@ -## `ClusterExistsComponentTemplateResponse` -::: +# `ClusterExistsComponentTemplateResponse` [alias-ClusterExistsComponentTemplateResponse] +```typescript type ClusterExistsComponentTemplateResponse = boolean; -::: +``` diff --git a/docs/reference/api/ClusterGetComponentTemplateRequest.md b/docs/reference/api/ClusterGetComponentTemplateRequest.md index aeb120df1..838d16d30 100644 --- a/docs/reference/api/ClusterGetComponentTemplateRequest.md +++ b/docs/reference/api/ClusterGetComponentTemplateRequest.md @@ -1,4 +1,4 @@ -## Interface `ClusterGetComponentTemplateRequest` +# `ClusterGetComponentTemplateRequest` [interface-ClusterGetComponentTemplateRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ClusterGetComponentTemplateResponse.md b/docs/reference/api/ClusterGetComponentTemplateResponse.md index d307c9e12..fa50317ea 100644 --- a/docs/reference/api/ClusterGetComponentTemplateResponse.md +++ b/docs/reference/api/ClusterGetComponentTemplateResponse.md @@ -1,4 +1,4 @@ -## Interface `ClusterGetComponentTemplateResponse` +# `ClusterGetComponentTemplateResponse` [interface-ClusterGetComponentTemplateResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ClusterGetSettingsRequest.md b/docs/reference/api/ClusterGetSettingsRequest.md index 6a6281749..eeddd96e4 100644 --- a/docs/reference/api/ClusterGetSettingsRequest.md +++ b/docs/reference/api/ClusterGetSettingsRequest.md @@ -1,4 +1,4 @@ -## Interface `ClusterGetSettingsRequest` +# `ClusterGetSettingsRequest` [interface-ClusterGetSettingsRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ClusterGetSettingsResponse.md b/docs/reference/api/ClusterGetSettingsResponse.md index 20d33d0e5..ac400aeae 100644 --- a/docs/reference/api/ClusterGetSettingsResponse.md +++ b/docs/reference/api/ClusterGetSettingsResponse.md @@ -1,4 +1,4 @@ -## Interface `ClusterGetSettingsResponse` +# `ClusterGetSettingsResponse` [interface-ClusterGetSettingsResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ClusterHealthHealthResponseBody.md b/docs/reference/api/ClusterHealthHealthResponseBody.md index dca7658e5..3e111430d 100644 --- a/docs/reference/api/ClusterHealthHealthResponseBody.md +++ b/docs/reference/api/ClusterHealthHealthResponseBody.md @@ -1,4 +1,4 @@ -## Interface `ClusterHealthHealthResponseBody` +# `ClusterHealthHealthResponseBody` [interface-ClusterHealthHealthResponseBody] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ClusterHealthIndexHealthStats.md b/docs/reference/api/ClusterHealthIndexHealthStats.md index 2f92954cb..7324302ad 100644 --- a/docs/reference/api/ClusterHealthIndexHealthStats.md +++ b/docs/reference/api/ClusterHealthIndexHealthStats.md @@ -1,4 +1,4 @@ -## Interface `ClusterHealthIndexHealthStats` +# `ClusterHealthIndexHealthStats` [interface-ClusterHealthIndexHealthStats] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ClusterHealthRequest.md b/docs/reference/api/ClusterHealthRequest.md index 21d9e4b2e..d03a4f284 100644 --- a/docs/reference/api/ClusterHealthRequest.md +++ b/docs/reference/api/ClusterHealthRequest.md @@ -1,4 +1,4 @@ -## Interface `ClusterHealthRequest` +# `ClusterHealthRequest` [interface-ClusterHealthRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ClusterHealthResponse.md b/docs/reference/api/ClusterHealthResponse.md index 1bc8759c2..d4ca054af 100644 --- a/docs/reference/api/ClusterHealthResponse.md +++ b/docs/reference/api/ClusterHealthResponse.md @@ -1,4 +1,4 @@ -## `ClusterHealthResponse` -::: +# `ClusterHealthResponse` [alias-ClusterHealthResponse] +```typescript type ClusterHealthResponse = [ClusterHealthHealthResponseBody](./ClusterHealthHealthResponseBody.md); -::: +``` diff --git a/docs/reference/api/ClusterHealthShardHealthStats.md b/docs/reference/api/ClusterHealthShardHealthStats.md index cd908eb3a..513ae0779 100644 --- a/docs/reference/api/ClusterHealthShardHealthStats.md +++ b/docs/reference/api/ClusterHealthShardHealthStats.md @@ -1,4 +1,4 @@ -## Interface `ClusterHealthShardHealthStats` +# `ClusterHealthShardHealthStats` [interface-ClusterHealthShardHealthStats] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ClusterHealthWaitForNodes.md b/docs/reference/api/ClusterHealthWaitForNodes.md index 378d6c262..3cfd87210 100644 --- a/docs/reference/api/ClusterHealthWaitForNodes.md +++ b/docs/reference/api/ClusterHealthWaitForNodes.md @@ -1,4 +1,4 @@ -## `ClusterHealthWaitForNodes` -::: +# `ClusterHealthWaitForNodes` [alias-ClusterHealthWaitForNodes] +```typescript type ClusterHealthWaitForNodes = string | [integer](./integer.md); -::: +``` diff --git a/docs/reference/api/ClusterInfoRequest.md b/docs/reference/api/ClusterInfoRequest.md index 9e638873e..2e98423b0 100644 --- a/docs/reference/api/ClusterInfoRequest.md +++ b/docs/reference/api/ClusterInfoRequest.md @@ -1,4 +1,4 @@ -## Interface `ClusterInfoRequest` +# `ClusterInfoRequest` [interface-ClusterInfoRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ClusterInfoResponse.md b/docs/reference/api/ClusterInfoResponse.md index 7a73caac3..6194c7df9 100644 --- a/docs/reference/api/ClusterInfoResponse.md +++ b/docs/reference/api/ClusterInfoResponse.md @@ -1,4 +1,4 @@ -## Interface `ClusterInfoResponse` +# `ClusterInfoResponse` [interface-ClusterInfoResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ClusterInfoTarget.md b/docs/reference/api/ClusterInfoTarget.md index f704957fe..79b5dc520 100644 --- a/docs/reference/api/ClusterInfoTarget.md +++ b/docs/reference/api/ClusterInfoTarget.md @@ -1,4 +1,4 @@ -## `ClusterInfoTarget` -::: +# `ClusterInfoTarget` [alias-ClusterInfoTarget] +```typescript type ClusterInfoTarget = '_all' | 'http' | 'ingest' | 'thread_pool' | 'script'; -::: +``` diff --git a/docs/reference/api/ClusterInfoTargets.md b/docs/reference/api/ClusterInfoTargets.md index 92b06030c..6b4b4182d 100644 --- a/docs/reference/api/ClusterInfoTargets.md +++ b/docs/reference/api/ClusterInfoTargets.md @@ -1,4 +1,4 @@ -## `ClusterInfoTargets` -::: +# `ClusterInfoTargets` [alias-ClusterInfoTargets] +```typescript type ClusterInfoTargets = [ClusterInfoTarget](./ClusterInfoTarget.md) | [ClusterInfoTarget](./ClusterInfoTarget.md)[]; -::: +``` diff --git a/docs/reference/api/ClusterPendingTasksPendingTask.md b/docs/reference/api/ClusterPendingTasksPendingTask.md index 681d25ed8..6f6f08cf9 100644 --- a/docs/reference/api/ClusterPendingTasksPendingTask.md +++ b/docs/reference/api/ClusterPendingTasksPendingTask.md @@ -1,4 +1,4 @@ -## Interface `ClusterPendingTasksPendingTask` +# `ClusterPendingTasksPendingTask` [interface-ClusterPendingTasksPendingTask] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ClusterPendingTasksRequest.md b/docs/reference/api/ClusterPendingTasksRequest.md index 250544131..a39069c21 100644 --- a/docs/reference/api/ClusterPendingTasksRequest.md +++ b/docs/reference/api/ClusterPendingTasksRequest.md @@ -1,4 +1,4 @@ -## Interface `ClusterPendingTasksRequest` +# `ClusterPendingTasksRequest` [interface-ClusterPendingTasksRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ClusterPendingTasksResponse.md b/docs/reference/api/ClusterPendingTasksResponse.md index fd11bb9f6..c01a0f681 100644 --- a/docs/reference/api/ClusterPendingTasksResponse.md +++ b/docs/reference/api/ClusterPendingTasksResponse.md @@ -1,4 +1,4 @@ -## Interface `ClusterPendingTasksResponse` +# `ClusterPendingTasksResponse` [interface-ClusterPendingTasksResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ClusterPostVotingConfigExclusionsRequest.md b/docs/reference/api/ClusterPostVotingConfigExclusionsRequest.md index 0c478a77d..ba0fb8c09 100644 --- a/docs/reference/api/ClusterPostVotingConfigExclusionsRequest.md +++ b/docs/reference/api/ClusterPostVotingConfigExclusionsRequest.md @@ -1,4 +1,4 @@ -## Interface `ClusterPostVotingConfigExclusionsRequest` +# `ClusterPostVotingConfigExclusionsRequest` [interface-ClusterPostVotingConfigExclusionsRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ClusterPostVotingConfigExclusionsResponse.md b/docs/reference/api/ClusterPostVotingConfigExclusionsResponse.md index 63cf5f689..10dfe3dac 100644 --- a/docs/reference/api/ClusterPostVotingConfigExclusionsResponse.md +++ b/docs/reference/api/ClusterPostVotingConfigExclusionsResponse.md @@ -1,4 +1,4 @@ -## `ClusterPostVotingConfigExclusionsResponse` -::: +# `ClusterPostVotingConfigExclusionsResponse` [alias-ClusterPostVotingConfigExclusionsResponse] +```typescript type ClusterPostVotingConfigExclusionsResponse = boolean; -::: +``` diff --git a/docs/reference/api/ClusterPutComponentTemplateRequest.md b/docs/reference/api/ClusterPutComponentTemplateRequest.md index baf485705..c2a7dc926 100644 --- a/docs/reference/api/ClusterPutComponentTemplateRequest.md +++ b/docs/reference/api/ClusterPutComponentTemplateRequest.md @@ -1,4 +1,4 @@ -## Interface `ClusterPutComponentTemplateRequest` +# `ClusterPutComponentTemplateRequest` [interface-ClusterPutComponentTemplateRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ClusterPutComponentTemplateResponse.md b/docs/reference/api/ClusterPutComponentTemplateResponse.md index 15904ef3d..f5e6b0ef9 100644 --- a/docs/reference/api/ClusterPutComponentTemplateResponse.md +++ b/docs/reference/api/ClusterPutComponentTemplateResponse.md @@ -1,4 +1,4 @@ -## `ClusterPutComponentTemplateResponse` -::: +# `ClusterPutComponentTemplateResponse` [alias-ClusterPutComponentTemplateResponse] +```typescript type ClusterPutComponentTemplateResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); -::: +``` diff --git a/docs/reference/api/ClusterPutSettingsRequest.md b/docs/reference/api/ClusterPutSettingsRequest.md index 3f9b74509..d41e62ca6 100644 --- a/docs/reference/api/ClusterPutSettingsRequest.md +++ b/docs/reference/api/ClusterPutSettingsRequest.md @@ -1,4 +1,4 @@ -## Interface `ClusterPutSettingsRequest` +# `ClusterPutSettingsRequest` [interface-ClusterPutSettingsRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ClusterPutSettingsResponse.md b/docs/reference/api/ClusterPutSettingsResponse.md index df41ca8dc..9991f8f94 100644 --- a/docs/reference/api/ClusterPutSettingsResponse.md +++ b/docs/reference/api/ClusterPutSettingsResponse.md @@ -1,4 +1,4 @@ -## Interface `ClusterPutSettingsResponse` +# `ClusterPutSettingsResponse` [interface-ClusterPutSettingsResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ClusterRemoteInfoClusterRemoteInfo.md b/docs/reference/api/ClusterRemoteInfoClusterRemoteInfo.md index c2567fc5f..16e1e566c 100644 --- a/docs/reference/api/ClusterRemoteInfoClusterRemoteInfo.md +++ b/docs/reference/api/ClusterRemoteInfoClusterRemoteInfo.md @@ -1,4 +1,4 @@ -## `ClusterRemoteInfoClusterRemoteInfo` -::: +# `ClusterRemoteInfoClusterRemoteInfo` [alias-ClusterRemoteInfoClusterRemoteInfo] +```typescript type ClusterRemoteInfoClusterRemoteInfo = [ClusterRemoteInfoClusterRemoteSniffInfo](./ClusterRemoteInfoClusterRemoteSniffInfo.md) | [ClusterRemoteInfoClusterRemoteProxyInfo](./ClusterRemoteInfoClusterRemoteProxyInfo.md); -::: +``` diff --git a/docs/reference/api/ClusterRemoteInfoClusterRemoteProxyInfo.md b/docs/reference/api/ClusterRemoteInfoClusterRemoteProxyInfo.md index 10b76718a..4212f452a 100644 --- a/docs/reference/api/ClusterRemoteInfoClusterRemoteProxyInfo.md +++ b/docs/reference/api/ClusterRemoteInfoClusterRemoteProxyInfo.md @@ -1,4 +1,4 @@ -## Interface `ClusterRemoteInfoClusterRemoteProxyInfo` +# `ClusterRemoteInfoClusterRemoteProxyInfo` [interface-ClusterRemoteInfoClusterRemoteProxyInfo] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ClusterRemoteInfoClusterRemoteSniffInfo.md b/docs/reference/api/ClusterRemoteInfoClusterRemoteSniffInfo.md index 96046614a..a9ceec93b 100644 --- a/docs/reference/api/ClusterRemoteInfoClusterRemoteSniffInfo.md +++ b/docs/reference/api/ClusterRemoteInfoClusterRemoteSniffInfo.md @@ -1,4 +1,4 @@ -## Interface `ClusterRemoteInfoClusterRemoteSniffInfo` +# `ClusterRemoteInfoClusterRemoteSniffInfo` [interface-ClusterRemoteInfoClusterRemoteSniffInfo] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ClusterRemoteInfoRequest.md b/docs/reference/api/ClusterRemoteInfoRequest.md index 63f442848..ad75fcef2 100644 --- a/docs/reference/api/ClusterRemoteInfoRequest.md +++ b/docs/reference/api/ClusterRemoteInfoRequest.md @@ -1,4 +1,4 @@ -## Interface `ClusterRemoteInfoRequest` +# `ClusterRemoteInfoRequest` [interface-ClusterRemoteInfoRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ClusterRemoteInfoResponse.md b/docs/reference/api/ClusterRemoteInfoResponse.md index 099dac0ee..4cc42db59 100644 --- a/docs/reference/api/ClusterRemoteInfoResponse.md +++ b/docs/reference/api/ClusterRemoteInfoResponse.md @@ -1,4 +1,4 @@ -## `ClusterRemoteInfoResponse` -::: +# `ClusterRemoteInfoResponse` [alias-ClusterRemoteInfoResponse] +```typescript type ClusterRemoteInfoResponse = Record; -::: +``` diff --git a/docs/reference/api/ClusterRerouteCommand.md b/docs/reference/api/ClusterRerouteCommand.md index c9fd264fe..97a4ed103 100644 --- a/docs/reference/api/ClusterRerouteCommand.md +++ b/docs/reference/api/ClusterRerouteCommand.md @@ -1,4 +1,4 @@ -## Interface `ClusterRerouteCommand` +# `ClusterRerouteCommand` [interface-ClusterRerouteCommand] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ClusterRerouteCommandAllocatePrimaryAction.md b/docs/reference/api/ClusterRerouteCommandAllocatePrimaryAction.md index 53dfbea5a..1474ed597 100644 --- a/docs/reference/api/ClusterRerouteCommandAllocatePrimaryAction.md +++ b/docs/reference/api/ClusterRerouteCommandAllocatePrimaryAction.md @@ -1,4 +1,4 @@ -## Interface `ClusterRerouteCommandAllocatePrimaryAction` +# `ClusterRerouteCommandAllocatePrimaryAction` [interface-ClusterRerouteCommandAllocatePrimaryAction] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ClusterRerouteCommandAllocateReplicaAction.md b/docs/reference/api/ClusterRerouteCommandAllocateReplicaAction.md index fdfbff13b..e3a26d13e 100644 --- a/docs/reference/api/ClusterRerouteCommandAllocateReplicaAction.md +++ b/docs/reference/api/ClusterRerouteCommandAllocateReplicaAction.md @@ -1,4 +1,4 @@ -## Interface `ClusterRerouteCommandAllocateReplicaAction` +# `ClusterRerouteCommandAllocateReplicaAction` [interface-ClusterRerouteCommandAllocateReplicaAction] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ClusterRerouteCommandCancelAction.md b/docs/reference/api/ClusterRerouteCommandCancelAction.md index a63f2077d..38cbc4011 100644 --- a/docs/reference/api/ClusterRerouteCommandCancelAction.md +++ b/docs/reference/api/ClusterRerouteCommandCancelAction.md @@ -1,4 +1,4 @@ -## Interface `ClusterRerouteCommandCancelAction` +# `ClusterRerouteCommandCancelAction` [interface-ClusterRerouteCommandCancelAction] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ClusterRerouteCommandMoveAction.md b/docs/reference/api/ClusterRerouteCommandMoveAction.md index cfd01ae0a..9c0b17496 100644 --- a/docs/reference/api/ClusterRerouteCommandMoveAction.md +++ b/docs/reference/api/ClusterRerouteCommandMoveAction.md @@ -1,4 +1,4 @@ -## Interface `ClusterRerouteCommandMoveAction` +# `ClusterRerouteCommandMoveAction` [interface-ClusterRerouteCommandMoveAction] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ClusterRerouteRequest.md b/docs/reference/api/ClusterRerouteRequest.md index 707a95a51..3aab1b368 100644 --- a/docs/reference/api/ClusterRerouteRequest.md +++ b/docs/reference/api/ClusterRerouteRequest.md @@ -1,4 +1,4 @@ -## Interface `ClusterRerouteRequest` +# `ClusterRerouteRequest` [interface-ClusterRerouteRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ClusterRerouteRerouteDecision.md b/docs/reference/api/ClusterRerouteRerouteDecision.md index cf2e25a95..4286f0fdd 100644 --- a/docs/reference/api/ClusterRerouteRerouteDecision.md +++ b/docs/reference/api/ClusterRerouteRerouteDecision.md @@ -1,4 +1,4 @@ -## Interface `ClusterRerouteRerouteDecision` +# `ClusterRerouteRerouteDecision` [interface-ClusterRerouteRerouteDecision] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ClusterRerouteRerouteExplanation.md b/docs/reference/api/ClusterRerouteRerouteExplanation.md index e286414db..01e7f94c8 100644 --- a/docs/reference/api/ClusterRerouteRerouteExplanation.md +++ b/docs/reference/api/ClusterRerouteRerouteExplanation.md @@ -1,4 +1,4 @@ -## Interface `ClusterRerouteRerouteExplanation` +# `ClusterRerouteRerouteExplanation` [interface-ClusterRerouteRerouteExplanation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ClusterRerouteRerouteParameters.md b/docs/reference/api/ClusterRerouteRerouteParameters.md index dd9dc04da..ae9b16d51 100644 --- a/docs/reference/api/ClusterRerouteRerouteParameters.md +++ b/docs/reference/api/ClusterRerouteRerouteParameters.md @@ -1,4 +1,4 @@ -## Interface `ClusterRerouteRerouteParameters` +# `ClusterRerouteRerouteParameters` [interface-ClusterRerouteRerouteParameters] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ClusterRerouteResponse.md b/docs/reference/api/ClusterRerouteResponse.md index 1ad5bc6d9..e0a549fe2 100644 --- a/docs/reference/api/ClusterRerouteResponse.md +++ b/docs/reference/api/ClusterRerouteResponse.md @@ -1,4 +1,4 @@ -## Interface `ClusterRerouteResponse` +# `ClusterRerouteResponse` [interface-ClusterRerouteResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ClusterSearchStatus.md b/docs/reference/api/ClusterSearchStatus.md index 68f553b97..14ecd802b 100644 --- a/docs/reference/api/ClusterSearchStatus.md +++ b/docs/reference/api/ClusterSearchStatus.md @@ -1,4 +1,4 @@ -## `ClusterSearchStatus` -::: +# `ClusterSearchStatus` [alias-ClusterSearchStatus] +```typescript type ClusterSearchStatus = 'running' | 'successful' | 'partial' | 'skipped' | 'failed'; -::: +``` diff --git a/docs/reference/api/ClusterStateRequest.md b/docs/reference/api/ClusterStateRequest.md index 1184067c3..b816838a9 100644 --- a/docs/reference/api/ClusterStateRequest.md +++ b/docs/reference/api/ClusterStateRequest.md @@ -1,4 +1,4 @@ -## Interface `ClusterStateRequest` +# `ClusterStateRequest` [interface-ClusterStateRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ClusterStateResponse.md b/docs/reference/api/ClusterStateResponse.md index 9547e4ce3..936fdcbc6 100644 --- a/docs/reference/api/ClusterStateResponse.md +++ b/docs/reference/api/ClusterStateResponse.md @@ -1,4 +1,4 @@ -## `ClusterStateResponse` -::: +# `ClusterStateResponse` [alias-ClusterStateResponse] +```typescript type ClusterStateResponse = any; -::: +``` diff --git a/docs/reference/api/ClusterStatistics.md b/docs/reference/api/ClusterStatistics.md index 5e832fb17..bcab2a83c 100644 --- a/docs/reference/api/ClusterStatistics.md +++ b/docs/reference/api/ClusterStatistics.md @@ -1,4 +1,4 @@ -## Interface `ClusterStatistics` +# `ClusterStatistics` [interface-ClusterStatistics] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ClusterStatsCCSStats.md b/docs/reference/api/ClusterStatsCCSStats.md index 0a58e4f51..cd60d2a15 100644 --- a/docs/reference/api/ClusterStatsCCSStats.md +++ b/docs/reference/api/ClusterStatsCCSStats.md @@ -1,4 +1,4 @@ -## Interface `ClusterStatsCCSStats` +# `ClusterStatsCCSStats` [interface-ClusterStatsCCSStats] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ClusterStatsCCSUsageClusterStats.md b/docs/reference/api/ClusterStatsCCSUsageClusterStats.md index bdd35c2fd..1c70efe9a 100644 --- a/docs/reference/api/ClusterStatsCCSUsageClusterStats.md +++ b/docs/reference/api/ClusterStatsCCSUsageClusterStats.md @@ -1,4 +1,4 @@ -## Interface `ClusterStatsCCSUsageClusterStats` +# `ClusterStatsCCSUsageClusterStats` [interface-ClusterStatsCCSUsageClusterStats] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ClusterStatsCCSUsageStats.md b/docs/reference/api/ClusterStatsCCSUsageStats.md index 734ef9f03..5d6e01d4c 100644 --- a/docs/reference/api/ClusterStatsCCSUsageStats.md +++ b/docs/reference/api/ClusterStatsCCSUsageStats.md @@ -1,4 +1,4 @@ -## Interface `ClusterStatsCCSUsageStats` +# `ClusterStatsCCSUsageStats` [interface-ClusterStatsCCSUsageStats] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ClusterStatsCCSUsageTimeValue.md b/docs/reference/api/ClusterStatsCCSUsageTimeValue.md index 4413912a8..3e0638212 100644 --- a/docs/reference/api/ClusterStatsCCSUsageTimeValue.md +++ b/docs/reference/api/ClusterStatsCCSUsageTimeValue.md @@ -1,4 +1,4 @@ -## Interface `ClusterStatsCCSUsageTimeValue` +# `ClusterStatsCCSUsageTimeValue` [interface-ClusterStatsCCSUsageTimeValue] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ClusterStatsCharFilterTypes.md b/docs/reference/api/ClusterStatsCharFilterTypes.md index e0bf5074c..e64a99c9e 100644 --- a/docs/reference/api/ClusterStatsCharFilterTypes.md +++ b/docs/reference/api/ClusterStatsCharFilterTypes.md @@ -1,4 +1,4 @@ -## Interface `ClusterStatsCharFilterTypes` +# `ClusterStatsCharFilterTypes` [interface-ClusterStatsCharFilterTypes] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ClusterStatsClusterFileSystem.md b/docs/reference/api/ClusterStatsClusterFileSystem.md index 917a05fa6..28f25f329 100644 --- a/docs/reference/api/ClusterStatsClusterFileSystem.md +++ b/docs/reference/api/ClusterStatsClusterFileSystem.md @@ -1,4 +1,4 @@ -## Interface `ClusterStatsClusterFileSystem` +# `ClusterStatsClusterFileSystem` [interface-ClusterStatsClusterFileSystem] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ClusterStatsClusterIndices.md b/docs/reference/api/ClusterStatsClusterIndices.md index 66ec0a701..fdcd970bf 100644 --- a/docs/reference/api/ClusterStatsClusterIndices.md +++ b/docs/reference/api/ClusterStatsClusterIndices.md @@ -1,4 +1,4 @@ -## Interface `ClusterStatsClusterIndices` +# `ClusterStatsClusterIndices` [interface-ClusterStatsClusterIndices] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ClusterStatsClusterIndicesShards.md b/docs/reference/api/ClusterStatsClusterIndicesShards.md index 78c7ed6d3..8987a01eb 100644 --- a/docs/reference/api/ClusterStatsClusterIndicesShards.md +++ b/docs/reference/api/ClusterStatsClusterIndicesShards.md @@ -1,4 +1,4 @@ -## Interface `ClusterStatsClusterIndicesShards` +# `ClusterStatsClusterIndicesShards` [interface-ClusterStatsClusterIndicesShards] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ClusterStatsClusterIndicesShardsIndex.md b/docs/reference/api/ClusterStatsClusterIndicesShardsIndex.md index ac1c50dcb..f4cce410b 100644 --- a/docs/reference/api/ClusterStatsClusterIndicesShardsIndex.md +++ b/docs/reference/api/ClusterStatsClusterIndicesShardsIndex.md @@ -1,4 +1,4 @@ -## Interface `ClusterStatsClusterIndicesShardsIndex` +# `ClusterStatsClusterIndicesShardsIndex` [interface-ClusterStatsClusterIndicesShardsIndex] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ClusterStatsClusterIngest.md b/docs/reference/api/ClusterStatsClusterIngest.md index cf7dfa331..9ace529c0 100644 --- a/docs/reference/api/ClusterStatsClusterIngest.md +++ b/docs/reference/api/ClusterStatsClusterIngest.md @@ -1,4 +1,4 @@ -## Interface `ClusterStatsClusterIngest` +# `ClusterStatsClusterIngest` [interface-ClusterStatsClusterIngest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ClusterStatsClusterJvm.md b/docs/reference/api/ClusterStatsClusterJvm.md index 0c4eeec3b..a86e15cf7 100644 --- a/docs/reference/api/ClusterStatsClusterJvm.md +++ b/docs/reference/api/ClusterStatsClusterJvm.md @@ -1,4 +1,4 @@ -## Interface `ClusterStatsClusterJvm` +# `ClusterStatsClusterJvm` [interface-ClusterStatsClusterJvm] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ClusterStatsClusterJvmMemory.md b/docs/reference/api/ClusterStatsClusterJvmMemory.md index d69f5cda6..a870def4b 100644 --- a/docs/reference/api/ClusterStatsClusterJvmMemory.md +++ b/docs/reference/api/ClusterStatsClusterJvmMemory.md @@ -1,4 +1,4 @@ -## Interface `ClusterStatsClusterJvmMemory` +# `ClusterStatsClusterJvmMemory` [interface-ClusterStatsClusterJvmMemory] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ClusterStatsClusterJvmVersion.md b/docs/reference/api/ClusterStatsClusterJvmVersion.md index cb3cc4487..2aa4a1f27 100644 --- a/docs/reference/api/ClusterStatsClusterJvmVersion.md +++ b/docs/reference/api/ClusterStatsClusterJvmVersion.md @@ -1,4 +1,4 @@ -## Interface `ClusterStatsClusterJvmVersion` +# `ClusterStatsClusterJvmVersion` [interface-ClusterStatsClusterJvmVersion] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ClusterStatsClusterNetworkTypes.md b/docs/reference/api/ClusterStatsClusterNetworkTypes.md index 72e8d4d62..78d0a9778 100644 --- a/docs/reference/api/ClusterStatsClusterNetworkTypes.md +++ b/docs/reference/api/ClusterStatsClusterNetworkTypes.md @@ -1,4 +1,4 @@ -## Interface `ClusterStatsClusterNetworkTypes` +# `ClusterStatsClusterNetworkTypes` [interface-ClusterStatsClusterNetworkTypes] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ClusterStatsClusterNodeCount.md b/docs/reference/api/ClusterStatsClusterNodeCount.md index b5fc06dfa..d8ed4a5d9 100644 --- a/docs/reference/api/ClusterStatsClusterNodeCount.md +++ b/docs/reference/api/ClusterStatsClusterNodeCount.md @@ -1,4 +1,4 @@ -## Interface `ClusterStatsClusterNodeCount` +# `ClusterStatsClusterNodeCount` [interface-ClusterStatsClusterNodeCount] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ClusterStatsClusterNodes.md b/docs/reference/api/ClusterStatsClusterNodes.md index 08b17c9ad..90ccb2e0e 100644 --- a/docs/reference/api/ClusterStatsClusterNodes.md +++ b/docs/reference/api/ClusterStatsClusterNodes.md @@ -1,4 +1,4 @@ -## Interface `ClusterStatsClusterNodes` +# `ClusterStatsClusterNodes` [interface-ClusterStatsClusterNodes] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ClusterStatsClusterOperatingSystem.md b/docs/reference/api/ClusterStatsClusterOperatingSystem.md index 86eda33e2..0042d235d 100644 --- a/docs/reference/api/ClusterStatsClusterOperatingSystem.md +++ b/docs/reference/api/ClusterStatsClusterOperatingSystem.md @@ -1,4 +1,4 @@ -## Interface `ClusterStatsClusterOperatingSystem` +# `ClusterStatsClusterOperatingSystem` [interface-ClusterStatsClusterOperatingSystem] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ClusterStatsClusterOperatingSystemArchitecture.md b/docs/reference/api/ClusterStatsClusterOperatingSystemArchitecture.md index 05146ea60..2d50e0a88 100644 --- a/docs/reference/api/ClusterStatsClusterOperatingSystemArchitecture.md +++ b/docs/reference/api/ClusterStatsClusterOperatingSystemArchitecture.md @@ -1,4 +1,4 @@ -## Interface `ClusterStatsClusterOperatingSystemArchitecture` +# `ClusterStatsClusterOperatingSystemArchitecture` [interface-ClusterStatsClusterOperatingSystemArchitecture] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ClusterStatsClusterOperatingSystemName.md b/docs/reference/api/ClusterStatsClusterOperatingSystemName.md index 369fa472b..2fdd34cad 100644 --- a/docs/reference/api/ClusterStatsClusterOperatingSystemName.md +++ b/docs/reference/api/ClusterStatsClusterOperatingSystemName.md @@ -1,4 +1,4 @@ -## Interface `ClusterStatsClusterOperatingSystemName` +# `ClusterStatsClusterOperatingSystemName` [interface-ClusterStatsClusterOperatingSystemName] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ClusterStatsClusterOperatingSystemPrettyName.md b/docs/reference/api/ClusterStatsClusterOperatingSystemPrettyName.md index c6c44d6c0..c5e54cabd 100644 --- a/docs/reference/api/ClusterStatsClusterOperatingSystemPrettyName.md +++ b/docs/reference/api/ClusterStatsClusterOperatingSystemPrettyName.md @@ -1,4 +1,4 @@ -## Interface `ClusterStatsClusterOperatingSystemPrettyName` +# `ClusterStatsClusterOperatingSystemPrettyName` [interface-ClusterStatsClusterOperatingSystemPrettyName] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ClusterStatsClusterProcess.md b/docs/reference/api/ClusterStatsClusterProcess.md index 1c4b529bd..15f5b05a6 100644 --- a/docs/reference/api/ClusterStatsClusterProcess.md +++ b/docs/reference/api/ClusterStatsClusterProcess.md @@ -1,4 +1,4 @@ -## Interface `ClusterStatsClusterProcess` +# `ClusterStatsClusterProcess` [interface-ClusterStatsClusterProcess] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ClusterStatsClusterProcessCpu.md b/docs/reference/api/ClusterStatsClusterProcessCpu.md index 248af65b5..5fd57ccc6 100644 --- a/docs/reference/api/ClusterStatsClusterProcessCpu.md +++ b/docs/reference/api/ClusterStatsClusterProcessCpu.md @@ -1,4 +1,4 @@ -## Interface `ClusterStatsClusterProcessCpu` +# `ClusterStatsClusterProcessCpu` [interface-ClusterStatsClusterProcessCpu] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ClusterStatsClusterProcessOpenFileDescriptors.md b/docs/reference/api/ClusterStatsClusterProcessOpenFileDescriptors.md index 3a280bd1e..a38daa6fc 100644 --- a/docs/reference/api/ClusterStatsClusterProcessOpenFileDescriptors.md +++ b/docs/reference/api/ClusterStatsClusterProcessOpenFileDescriptors.md @@ -1,4 +1,4 @@ -## Interface `ClusterStatsClusterProcessOpenFileDescriptors` +# `ClusterStatsClusterProcessOpenFileDescriptors` [interface-ClusterStatsClusterProcessOpenFileDescriptors] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ClusterStatsClusterProcessor.md b/docs/reference/api/ClusterStatsClusterProcessor.md index e32f063de..b50ca273a 100644 --- a/docs/reference/api/ClusterStatsClusterProcessor.md +++ b/docs/reference/api/ClusterStatsClusterProcessor.md @@ -1,4 +1,4 @@ -## Interface `ClusterStatsClusterProcessor` +# `ClusterStatsClusterProcessor` [interface-ClusterStatsClusterProcessor] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ClusterStatsClusterShardMetrics.md b/docs/reference/api/ClusterStatsClusterShardMetrics.md index 48f26eb94..6656d82c6 100644 --- a/docs/reference/api/ClusterStatsClusterShardMetrics.md +++ b/docs/reference/api/ClusterStatsClusterShardMetrics.md @@ -1,4 +1,4 @@ -## Interface `ClusterStatsClusterShardMetrics` +# `ClusterStatsClusterShardMetrics` [interface-ClusterStatsClusterShardMetrics] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ClusterStatsFieldTypes.md b/docs/reference/api/ClusterStatsFieldTypes.md index 8abdf32e2..6f8dc59c8 100644 --- a/docs/reference/api/ClusterStatsFieldTypes.md +++ b/docs/reference/api/ClusterStatsFieldTypes.md @@ -1,4 +1,4 @@ -## Interface `ClusterStatsFieldTypes` +# `ClusterStatsFieldTypes` [interface-ClusterStatsFieldTypes] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ClusterStatsFieldTypesMappings.md b/docs/reference/api/ClusterStatsFieldTypesMappings.md index 5e21af46d..03f003309 100644 --- a/docs/reference/api/ClusterStatsFieldTypesMappings.md +++ b/docs/reference/api/ClusterStatsFieldTypesMappings.md @@ -1,4 +1,4 @@ -## Interface `ClusterStatsFieldTypesMappings` +# `ClusterStatsFieldTypesMappings` [interface-ClusterStatsFieldTypesMappings] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ClusterStatsIndexingPressure.md b/docs/reference/api/ClusterStatsIndexingPressure.md index a7f5a7b9e..83ed7e895 100644 --- a/docs/reference/api/ClusterStatsIndexingPressure.md +++ b/docs/reference/api/ClusterStatsIndexingPressure.md @@ -1,4 +1,4 @@ -## Interface `ClusterStatsIndexingPressure` +# `ClusterStatsIndexingPressure` [interface-ClusterStatsIndexingPressure] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ClusterStatsIndexingPressureMemory.md b/docs/reference/api/ClusterStatsIndexingPressureMemory.md index cb0db93ad..09c458816 100644 --- a/docs/reference/api/ClusterStatsIndexingPressureMemory.md +++ b/docs/reference/api/ClusterStatsIndexingPressureMemory.md @@ -1,4 +1,4 @@ -## Interface `ClusterStatsIndexingPressureMemory` +# `ClusterStatsIndexingPressureMemory` [interface-ClusterStatsIndexingPressureMemory] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ClusterStatsIndexingPressureMemorySummary.md b/docs/reference/api/ClusterStatsIndexingPressureMemorySummary.md index d38f53b99..87c5ddd2e 100644 --- a/docs/reference/api/ClusterStatsIndexingPressureMemorySummary.md +++ b/docs/reference/api/ClusterStatsIndexingPressureMemorySummary.md @@ -1,4 +1,4 @@ -## Interface `ClusterStatsIndexingPressureMemorySummary` +# `ClusterStatsIndexingPressureMemorySummary` [interface-ClusterStatsIndexingPressureMemorySummary] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ClusterStatsIndicesVersions.md b/docs/reference/api/ClusterStatsIndicesVersions.md index 9ef4a0f8e..6c4354adb 100644 --- a/docs/reference/api/ClusterStatsIndicesVersions.md +++ b/docs/reference/api/ClusterStatsIndicesVersions.md @@ -1,4 +1,4 @@ -## Interface `ClusterStatsIndicesVersions` +# `ClusterStatsIndicesVersions` [interface-ClusterStatsIndicesVersions] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ClusterStatsNodePackagingType.md b/docs/reference/api/ClusterStatsNodePackagingType.md index 6317947a9..749c003bc 100644 --- a/docs/reference/api/ClusterStatsNodePackagingType.md +++ b/docs/reference/api/ClusterStatsNodePackagingType.md @@ -1,4 +1,4 @@ -## Interface `ClusterStatsNodePackagingType` +# `ClusterStatsNodePackagingType` [interface-ClusterStatsNodePackagingType] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ClusterStatsOperatingSystemMemoryInfo.md b/docs/reference/api/ClusterStatsOperatingSystemMemoryInfo.md index e3b6e18f6..650a01591 100644 --- a/docs/reference/api/ClusterStatsOperatingSystemMemoryInfo.md +++ b/docs/reference/api/ClusterStatsOperatingSystemMemoryInfo.md @@ -1,4 +1,4 @@ -## Interface `ClusterStatsOperatingSystemMemoryInfo` +# `ClusterStatsOperatingSystemMemoryInfo` [interface-ClusterStatsOperatingSystemMemoryInfo] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ClusterStatsRemoteClusterInfo.md b/docs/reference/api/ClusterStatsRemoteClusterInfo.md index c3b5ac2ab..f915d2074 100644 --- a/docs/reference/api/ClusterStatsRemoteClusterInfo.md +++ b/docs/reference/api/ClusterStatsRemoteClusterInfo.md @@ -1,4 +1,4 @@ -## Interface `ClusterStatsRemoteClusterInfo` +# `ClusterStatsRemoteClusterInfo` [interface-ClusterStatsRemoteClusterInfo] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ClusterStatsRequest.md b/docs/reference/api/ClusterStatsRequest.md index b088600c3..a1fce3d8f 100644 --- a/docs/reference/api/ClusterStatsRequest.md +++ b/docs/reference/api/ClusterStatsRequest.md @@ -1,4 +1,4 @@ -## Interface `ClusterStatsRequest` +# `ClusterStatsRequest` [interface-ClusterStatsRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ClusterStatsResponse.md b/docs/reference/api/ClusterStatsResponse.md index c2d4967a3..1f43bae1d 100644 --- a/docs/reference/api/ClusterStatsResponse.md +++ b/docs/reference/api/ClusterStatsResponse.md @@ -1,4 +1,4 @@ -## `ClusterStatsResponse` -::: +# `ClusterStatsResponse` [alias-ClusterStatsResponse] +```typescript type ClusterStatsResponse = [ClusterStatsStatsResponseBase](./ClusterStatsStatsResponseBase.md); -::: +``` diff --git a/docs/reference/api/ClusterStatsRuntimeFieldTypes.md b/docs/reference/api/ClusterStatsRuntimeFieldTypes.md index 0d76f6794..bd79b6e11 100644 --- a/docs/reference/api/ClusterStatsRuntimeFieldTypes.md +++ b/docs/reference/api/ClusterStatsRuntimeFieldTypes.md @@ -1,4 +1,4 @@ -## Interface `ClusterStatsRuntimeFieldTypes` +# `ClusterStatsRuntimeFieldTypes` [interface-ClusterStatsRuntimeFieldTypes] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ClusterStatsStatsResponseBase.md b/docs/reference/api/ClusterStatsStatsResponseBase.md index d53ecbca3..229a896af 100644 --- a/docs/reference/api/ClusterStatsStatsResponseBase.md +++ b/docs/reference/api/ClusterStatsStatsResponseBase.md @@ -1,4 +1,4 @@ -## Interface `ClusterStatsStatsResponseBase` +# `ClusterStatsStatsResponseBase` [interface-ClusterStatsStatsResponseBase] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/CompletionStats.md b/docs/reference/api/CompletionStats.md index 5a3778d97..35159b053 100644 --- a/docs/reference/api/CompletionStats.md +++ b/docs/reference/api/CompletionStats.md @@ -1,4 +1,4 @@ -## Interface `CompletionStats` +# `CompletionStats` [interface-CompletionStats] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/Conflicts.md b/docs/reference/api/Conflicts.md index f7ae441c0..e71b9623d 100644 --- a/docs/reference/api/Conflicts.md +++ b/docs/reference/api/Conflicts.md @@ -1,4 +1,4 @@ -## `Conflicts` -::: +# `Conflicts` [alias-Conflicts] +```typescript type Conflicts = 'abort' | 'proceed'; -::: +``` diff --git a/docs/reference/api/Connector.md b/docs/reference/api/Connector.md index 38fce3450..f0cc589ed 100644 --- a/docs/reference/api/Connector.md +++ b/docs/reference/api/Connector.md @@ -1,19 +1,19 @@ -## `Connector` +# `Connector` [class-Connector] -### Constructor +## Constructor -::: +```typescript new Connector(transport: [Transport](./Transport.md)); -::: +``` -### Properties +## Properties [class-properties-Connector] | Name | Type | Description | | - | - | - | | `acceptedParams` | Record |   | | `transport` | [Transport](./Transport.md) |   | -### Methods +## Methods [class-methods-Connector] | Name | Signature | Description | | - | - | - | diff --git a/docs/reference/api/ConnectorCheckInRequest.md b/docs/reference/api/ConnectorCheckInRequest.md index 630bdd9a7..8329b008e 100644 --- a/docs/reference/api/ConnectorCheckInRequest.md +++ b/docs/reference/api/ConnectorCheckInRequest.md @@ -1,4 +1,4 @@ -## Interface `ConnectorCheckInRequest` +# `ConnectorCheckInRequest` [interface-ConnectorCheckInRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ConnectorCheckInResponse.md b/docs/reference/api/ConnectorCheckInResponse.md index 740f4362a..2a0b6da98 100644 --- a/docs/reference/api/ConnectorCheckInResponse.md +++ b/docs/reference/api/ConnectorCheckInResponse.md @@ -1,4 +1,4 @@ -## Interface `ConnectorCheckInResponse` +# `ConnectorCheckInResponse` [interface-ConnectorCheckInResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ConnectorConnector.md b/docs/reference/api/ConnectorConnector.md index bdf6fcd41..fddaa7235 100644 --- a/docs/reference/api/ConnectorConnector.md +++ b/docs/reference/api/ConnectorConnector.md @@ -1,4 +1,4 @@ -## Interface `ConnectorConnector` +# `ConnectorConnector` [interface-ConnectorConnector] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ConnectorConnectorConfigProperties.md b/docs/reference/api/ConnectorConnectorConfigProperties.md index 5ee4157c4..7cc2a7395 100644 --- a/docs/reference/api/ConnectorConnectorConfigProperties.md +++ b/docs/reference/api/ConnectorConnectorConfigProperties.md @@ -1,4 +1,4 @@ -## Interface `ConnectorConnectorConfigProperties` +# `ConnectorConnectorConfigProperties` [interface-ConnectorConnectorConfigProperties] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ConnectorConnectorConfiguration.md b/docs/reference/api/ConnectorConnectorConfiguration.md index 2d5617d0d..acba2c757 100644 --- a/docs/reference/api/ConnectorConnectorConfiguration.md +++ b/docs/reference/api/ConnectorConnectorConfiguration.md @@ -1,4 +1,4 @@ -## `ConnectorConnectorConfiguration` -::: +# `ConnectorConnectorConfiguration` [alias-ConnectorConnectorConfiguration] +```typescript type ConnectorConnectorConfiguration = Record; -::: +``` diff --git a/docs/reference/api/ConnectorConnectorCustomScheduling.md b/docs/reference/api/ConnectorConnectorCustomScheduling.md index 863194cc7..6cc85c549 100644 --- a/docs/reference/api/ConnectorConnectorCustomScheduling.md +++ b/docs/reference/api/ConnectorConnectorCustomScheduling.md @@ -1,4 +1,4 @@ -## `ConnectorConnectorCustomScheduling` -::: +# `ConnectorConnectorCustomScheduling` [alias-ConnectorConnectorCustomScheduling] +```typescript type ConnectorConnectorCustomScheduling = Record; -::: +``` diff --git a/docs/reference/api/ConnectorConnectorFeatures.md b/docs/reference/api/ConnectorConnectorFeatures.md index c121e5456..667a5fa22 100644 --- a/docs/reference/api/ConnectorConnectorFeatures.md +++ b/docs/reference/api/ConnectorConnectorFeatures.md @@ -1,4 +1,4 @@ -## Interface `ConnectorConnectorFeatures` +# `ConnectorConnectorFeatures` [interface-ConnectorConnectorFeatures] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ConnectorConnectorFieldType.md b/docs/reference/api/ConnectorConnectorFieldType.md index 149625253..ccfb720aa 100644 --- a/docs/reference/api/ConnectorConnectorFieldType.md +++ b/docs/reference/api/ConnectorConnectorFieldType.md @@ -1,4 +1,4 @@ -## `ConnectorConnectorFieldType` -::: +# `ConnectorConnectorFieldType` [alias-ConnectorConnectorFieldType] +```typescript type ConnectorConnectorFieldType = 'str' | 'int' | 'list' | 'bool'; -::: +``` diff --git a/docs/reference/api/ConnectorConnectorScheduling.md b/docs/reference/api/ConnectorConnectorScheduling.md index da6d5effc..d37654d71 100644 --- a/docs/reference/api/ConnectorConnectorScheduling.md +++ b/docs/reference/api/ConnectorConnectorScheduling.md @@ -1,4 +1,4 @@ -## Interface `ConnectorConnectorScheduling` +# `ConnectorConnectorScheduling` [interface-ConnectorConnectorScheduling] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ConnectorConnectorStatus.md b/docs/reference/api/ConnectorConnectorStatus.md index b40fd797e..b02c108fc 100644 --- a/docs/reference/api/ConnectorConnectorStatus.md +++ b/docs/reference/api/ConnectorConnectorStatus.md @@ -1,4 +1,4 @@ -## `ConnectorConnectorStatus` -::: +# `ConnectorConnectorStatus` [alias-ConnectorConnectorStatus] +```typescript type ConnectorConnectorStatus = 'created' | 'needs_configuration' | 'configured' | 'connected' | 'error'; -::: +``` diff --git a/docs/reference/api/ConnectorConnectorSyncJob.md b/docs/reference/api/ConnectorConnectorSyncJob.md index c6a35fca0..d3d860bec 100644 --- a/docs/reference/api/ConnectorConnectorSyncJob.md +++ b/docs/reference/api/ConnectorConnectorSyncJob.md @@ -1,4 +1,4 @@ -## Interface `ConnectorConnectorSyncJob` +# `ConnectorConnectorSyncJob` [interface-ConnectorConnectorSyncJob] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ConnectorCustomScheduling.md b/docs/reference/api/ConnectorCustomScheduling.md index fb6b69d8b..67b7a2ba1 100644 --- a/docs/reference/api/ConnectorCustomScheduling.md +++ b/docs/reference/api/ConnectorCustomScheduling.md @@ -1,4 +1,4 @@ -## Interface `ConnectorCustomScheduling` +# `ConnectorCustomScheduling` [interface-ConnectorCustomScheduling] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ConnectorCustomSchedulingConfigurationOverrides.md b/docs/reference/api/ConnectorCustomSchedulingConfigurationOverrides.md index fa4ca6e36..3b7d92017 100644 --- a/docs/reference/api/ConnectorCustomSchedulingConfigurationOverrides.md +++ b/docs/reference/api/ConnectorCustomSchedulingConfigurationOverrides.md @@ -1,4 +1,4 @@ -## Interface `ConnectorCustomSchedulingConfigurationOverrides` +# `ConnectorCustomSchedulingConfigurationOverrides` [interface-ConnectorCustomSchedulingConfigurationOverrides] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ConnectorDeleteRequest.md b/docs/reference/api/ConnectorDeleteRequest.md index d09af8ccb..2abb61c2f 100644 --- a/docs/reference/api/ConnectorDeleteRequest.md +++ b/docs/reference/api/ConnectorDeleteRequest.md @@ -1,4 +1,4 @@ -## Interface `ConnectorDeleteRequest` +# `ConnectorDeleteRequest` [interface-ConnectorDeleteRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ConnectorDeleteResponse.md b/docs/reference/api/ConnectorDeleteResponse.md index d332c0098..8cb1a7fa6 100644 --- a/docs/reference/api/ConnectorDeleteResponse.md +++ b/docs/reference/api/ConnectorDeleteResponse.md @@ -1,4 +1,4 @@ -## `ConnectorDeleteResponse` -::: +# `ConnectorDeleteResponse` [alias-ConnectorDeleteResponse] +```typescript type ConnectorDeleteResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); -::: +``` diff --git a/docs/reference/api/ConnectorDependency.md b/docs/reference/api/ConnectorDependency.md index edbae2906..bde456155 100644 --- a/docs/reference/api/ConnectorDependency.md +++ b/docs/reference/api/ConnectorDependency.md @@ -1,4 +1,4 @@ -## Interface `ConnectorDependency` +# `ConnectorDependency` [interface-ConnectorDependency] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ConnectorDisplayType.md b/docs/reference/api/ConnectorDisplayType.md index c5eee31c1..2d19d0013 100644 --- a/docs/reference/api/ConnectorDisplayType.md +++ b/docs/reference/api/ConnectorDisplayType.md @@ -1,4 +1,4 @@ -## `ConnectorDisplayType` -::: +# `ConnectorDisplayType` [alias-ConnectorDisplayType] +```typescript type ConnectorDisplayType = 'textbox' | 'textarea' | 'numeric' | 'toggle' | 'dropdown'; -::: +``` diff --git a/docs/reference/api/ConnectorFeatureEnabled.md b/docs/reference/api/ConnectorFeatureEnabled.md index 5123d5675..25fb72c99 100644 --- a/docs/reference/api/ConnectorFeatureEnabled.md +++ b/docs/reference/api/ConnectorFeatureEnabled.md @@ -1,4 +1,4 @@ -## Interface `ConnectorFeatureEnabled` +# `ConnectorFeatureEnabled` [interface-ConnectorFeatureEnabled] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ConnectorFilteringAdvancedSnippet.md b/docs/reference/api/ConnectorFilteringAdvancedSnippet.md index 806d1ee70..65f2cf49a 100644 --- a/docs/reference/api/ConnectorFilteringAdvancedSnippet.md +++ b/docs/reference/api/ConnectorFilteringAdvancedSnippet.md @@ -1,4 +1,4 @@ -## Interface `ConnectorFilteringAdvancedSnippet` +# `ConnectorFilteringAdvancedSnippet` [interface-ConnectorFilteringAdvancedSnippet] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ConnectorFilteringConfig.md b/docs/reference/api/ConnectorFilteringConfig.md index e1a9d7c78..bd5c710e2 100644 --- a/docs/reference/api/ConnectorFilteringConfig.md +++ b/docs/reference/api/ConnectorFilteringConfig.md @@ -1,4 +1,4 @@ -## Interface `ConnectorFilteringConfig` +# `ConnectorFilteringConfig` [interface-ConnectorFilteringConfig] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ConnectorFilteringPolicy.md b/docs/reference/api/ConnectorFilteringPolicy.md index ff18cdbd6..4bb40486b 100644 --- a/docs/reference/api/ConnectorFilteringPolicy.md +++ b/docs/reference/api/ConnectorFilteringPolicy.md @@ -1,4 +1,4 @@ -## `ConnectorFilteringPolicy` -::: +# `ConnectorFilteringPolicy` [alias-ConnectorFilteringPolicy] +```typescript type ConnectorFilteringPolicy = 'exclude' | 'include'; -::: +``` diff --git a/docs/reference/api/ConnectorFilteringRule.md b/docs/reference/api/ConnectorFilteringRule.md index 69f260692..a4dcf81c6 100644 --- a/docs/reference/api/ConnectorFilteringRule.md +++ b/docs/reference/api/ConnectorFilteringRule.md @@ -1,4 +1,4 @@ -## Interface `ConnectorFilteringRule` +# `ConnectorFilteringRule` [interface-ConnectorFilteringRule] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ConnectorFilteringRuleRule.md b/docs/reference/api/ConnectorFilteringRuleRule.md index 356f0a132..8e0021b33 100644 --- a/docs/reference/api/ConnectorFilteringRuleRule.md +++ b/docs/reference/api/ConnectorFilteringRuleRule.md @@ -1,4 +1,4 @@ -## `ConnectorFilteringRuleRule` -::: +# `ConnectorFilteringRuleRule` [alias-ConnectorFilteringRuleRule] +```typescript type ConnectorFilteringRuleRule = 'contains' | 'ends_with' | 'equals' | 'regex' | 'starts_with' | '>' | '<'; -::: +``` diff --git a/docs/reference/api/ConnectorFilteringRules.md b/docs/reference/api/ConnectorFilteringRules.md index b0763a72c..f33429ec6 100644 --- a/docs/reference/api/ConnectorFilteringRules.md +++ b/docs/reference/api/ConnectorFilteringRules.md @@ -1,4 +1,4 @@ -## Interface `ConnectorFilteringRules` +# `ConnectorFilteringRules` [interface-ConnectorFilteringRules] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ConnectorFilteringRulesValidation.md b/docs/reference/api/ConnectorFilteringRulesValidation.md index 0e48ce67b..f527969ba 100644 --- a/docs/reference/api/ConnectorFilteringRulesValidation.md +++ b/docs/reference/api/ConnectorFilteringRulesValidation.md @@ -1,4 +1,4 @@ -## Interface `ConnectorFilteringRulesValidation` +# `ConnectorFilteringRulesValidation` [interface-ConnectorFilteringRulesValidation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ConnectorFilteringValidation.md b/docs/reference/api/ConnectorFilteringValidation.md index 53f8d7628..72a1d5995 100644 --- a/docs/reference/api/ConnectorFilteringValidation.md +++ b/docs/reference/api/ConnectorFilteringValidation.md @@ -1,4 +1,4 @@ -## Interface `ConnectorFilteringValidation` +# `ConnectorFilteringValidation` [interface-ConnectorFilteringValidation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ConnectorFilteringValidationState.md b/docs/reference/api/ConnectorFilteringValidationState.md index fb183139a..8fc4f1c69 100644 --- a/docs/reference/api/ConnectorFilteringValidationState.md +++ b/docs/reference/api/ConnectorFilteringValidationState.md @@ -1,4 +1,4 @@ -## `ConnectorFilteringValidationState` -::: +# `ConnectorFilteringValidationState` [alias-ConnectorFilteringValidationState] +```typescript type ConnectorFilteringValidationState = 'edited' | 'invalid' | 'valid'; -::: +``` diff --git a/docs/reference/api/ConnectorGetRequest.md b/docs/reference/api/ConnectorGetRequest.md index 7ce84599f..4151d0964 100644 --- a/docs/reference/api/ConnectorGetRequest.md +++ b/docs/reference/api/ConnectorGetRequest.md @@ -1,4 +1,4 @@ -## Interface `ConnectorGetRequest` +# `ConnectorGetRequest` [interface-ConnectorGetRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ConnectorGetResponse.md b/docs/reference/api/ConnectorGetResponse.md index 9f9755643..27825979a 100644 --- a/docs/reference/api/ConnectorGetResponse.md +++ b/docs/reference/api/ConnectorGetResponse.md @@ -1,4 +1,4 @@ -## `ConnectorGetResponse` -::: +# `ConnectorGetResponse` [alias-ConnectorGetResponse] +```typescript type ConnectorGetResponse = [ConnectorConnector](./ConnectorConnector.md); -::: +``` diff --git a/docs/reference/api/ConnectorGreaterThanValidation.md b/docs/reference/api/ConnectorGreaterThanValidation.md index 9af2193bc..06de8c0d4 100644 --- a/docs/reference/api/ConnectorGreaterThanValidation.md +++ b/docs/reference/api/ConnectorGreaterThanValidation.md @@ -1,4 +1,4 @@ -## Interface `ConnectorGreaterThanValidation` +# `ConnectorGreaterThanValidation` [interface-ConnectorGreaterThanValidation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ConnectorIncludedInValidation.md b/docs/reference/api/ConnectorIncludedInValidation.md index b3cd7a207..c08d17d62 100644 --- a/docs/reference/api/ConnectorIncludedInValidation.md +++ b/docs/reference/api/ConnectorIncludedInValidation.md @@ -1,4 +1,4 @@ -## Interface `ConnectorIncludedInValidation` +# `ConnectorIncludedInValidation` [interface-ConnectorIncludedInValidation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ConnectorIngestPipelineParams.md b/docs/reference/api/ConnectorIngestPipelineParams.md index 5ba2e5a30..1aa3cccf5 100644 --- a/docs/reference/api/ConnectorIngestPipelineParams.md +++ b/docs/reference/api/ConnectorIngestPipelineParams.md @@ -1,4 +1,4 @@ -## Interface `ConnectorIngestPipelineParams` +# `ConnectorIngestPipelineParams` [interface-ConnectorIngestPipelineParams] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ConnectorLastSyncRequest.md b/docs/reference/api/ConnectorLastSyncRequest.md index cafe2b4e9..4b5862d99 100644 --- a/docs/reference/api/ConnectorLastSyncRequest.md +++ b/docs/reference/api/ConnectorLastSyncRequest.md @@ -1,4 +1,4 @@ -## Interface `ConnectorLastSyncRequest` +# `ConnectorLastSyncRequest` [interface-ConnectorLastSyncRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ConnectorLastSyncResponse.md b/docs/reference/api/ConnectorLastSyncResponse.md index 2e4016734..e1e4ef970 100644 --- a/docs/reference/api/ConnectorLastSyncResponse.md +++ b/docs/reference/api/ConnectorLastSyncResponse.md @@ -1,4 +1,4 @@ -## Interface `ConnectorLastSyncResponse` +# `ConnectorLastSyncResponse` [interface-ConnectorLastSyncResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ConnectorLessThanValidation.md b/docs/reference/api/ConnectorLessThanValidation.md index 3f3068eaa..344974974 100644 --- a/docs/reference/api/ConnectorLessThanValidation.md +++ b/docs/reference/api/ConnectorLessThanValidation.md @@ -1,4 +1,4 @@ -## Interface `ConnectorLessThanValidation` +# `ConnectorLessThanValidation` [interface-ConnectorLessThanValidation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ConnectorListRequest.md b/docs/reference/api/ConnectorListRequest.md index 3556cf0c2..def6720fa 100644 --- a/docs/reference/api/ConnectorListRequest.md +++ b/docs/reference/api/ConnectorListRequest.md @@ -1,4 +1,4 @@ -## Interface `ConnectorListRequest` +# `ConnectorListRequest` [interface-ConnectorListRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ConnectorListResponse.md b/docs/reference/api/ConnectorListResponse.md index b2c53cd25..cdcfab51b 100644 --- a/docs/reference/api/ConnectorListResponse.md +++ b/docs/reference/api/ConnectorListResponse.md @@ -1,4 +1,4 @@ -## Interface `ConnectorListResponse` +# `ConnectorListResponse` [interface-ConnectorListResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ConnectorListTypeValidation.md b/docs/reference/api/ConnectorListTypeValidation.md index eeb51d3f0..92ca02daf 100644 --- a/docs/reference/api/ConnectorListTypeValidation.md +++ b/docs/reference/api/ConnectorListTypeValidation.md @@ -1,4 +1,4 @@ -## Interface `ConnectorListTypeValidation` +# `ConnectorListTypeValidation` [interface-ConnectorListTypeValidation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ConnectorPostRequest.md b/docs/reference/api/ConnectorPostRequest.md index d88e7f3ec..7f6bd6ac6 100644 --- a/docs/reference/api/ConnectorPostRequest.md +++ b/docs/reference/api/ConnectorPostRequest.md @@ -1,4 +1,4 @@ -## Interface `ConnectorPostRequest` +# `ConnectorPostRequest` [interface-ConnectorPostRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ConnectorPostResponse.md b/docs/reference/api/ConnectorPostResponse.md index cf71cb721..39d54ce45 100644 --- a/docs/reference/api/ConnectorPostResponse.md +++ b/docs/reference/api/ConnectorPostResponse.md @@ -1,4 +1,4 @@ -## Interface `ConnectorPostResponse` +# `ConnectorPostResponse` [interface-ConnectorPostResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ConnectorPutRequest.md b/docs/reference/api/ConnectorPutRequest.md index c83330776..c36ebb31f 100644 --- a/docs/reference/api/ConnectorPutRequest.md +++ b/docs/reference/api/ConnectorPutRequest.md @@ -1,4 +1,4 @@ -## Interface `ConnectorPutRequest` +# `ConnectorPutRequest` [interface-ConnectorPutRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ConnectorPutResponse.md b/docs/reference/api/ConnectorPutResponse.md index 008506ec8..6ed11629a 100644 --- a/docs/reference/api/ConnectorPutResponse.md +++ b/docs/reference/api/ConnectorPutResponse.md @@ -1,4 +1,4 @@ -## Interface `ConnectorPutResponse` +# `ConnectorPutResponse` [interface-ConnectorPutResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ConnectorRegexValidation.md b/docs/reference/api/ConnectorRegexValidation.md index 28e024755..fefab7c2c 100644 --- a/docs/reference/api/ConnectorRegexValidation.md +++ b/docs/reference/api/ConnectorRegexValidation.md @@ -1,4 +1,4 @@ -## Interface `ConnectorRegexValidation` +# `ConnectorRegexValidation` [interface-ConnectorRegexValidation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ConnectorSchedulingConfiguration.md b/docs/reference/api/ConnectorSchedulingConfiguration.md index f287c5e99..beaddf7ef 100644 --- a/docs/reference/api/ConnectorSchedulingConfiguration.md +++ b/docs/reference/api/ConnectorSchedulingConfiguration.md @@ -1,4 +1,4 @@ -## Interface `ConnectorSchedulingConfiguration` +# `ConnectorSchedulingConfiguration` [interface-ConnectorSchedulingConfiguration] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ConnectorSelectOption.md b/docs/reference/api/ConnectorSelectOption.md index c1b276038..ba943e422 100644 --- a/docs/reference/api/ConnectorSelectOption.md +++ b/docs/reference/api/ConnectorSelectOption.md @@ -1,4 +1,4 @@ -## Interface `ConnectorSelectOption` +# `ConnectorSelectOption` [interface-ConnectorSelectOption] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ConnectorSyncJobCancelRequest.md b/docs/reference/api/ConnectorSyncJobCancelRequest.md index 371ecd9bd..892d75b52 100644 --- a/docs/reference/api/ConnectorSyncJobCancelRequest.md +++ b/docs/reference/api/ConnectorSyncJobCancelRequest.md @@ -1,4 +1,4 @@ -## Interface `ConnectorSyncJobCancelRequest` +# `ConnectorSyncJobCancelRequest` [interface-ConnectorSyncJobCancelRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ConnectorSyncJobCancelResponse.md b/docs/reference/api/ConnectorSyncJobCancelResponse.md index 81d2b9a89..c262a52d3 100644 --- a/docs/reference/api/ConnectorSyncJobCancelResponse.md +++ b/docs/reference/api/ConnectorSyncJobCancelResponse.md @@ -1,4 +1,4 @@ -## Interface `ConnectorSyncJobCancelResponse` +# `ConnectorSyncJobCancelResponse` [interface-ConnectorSyncJobCancelResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ConnectorSyncJobCheckInRequest.md b/docs/reference/api/ConnectorSyncJobCheckInRequest.md index 427fc91ed..ed88017c1 100644 --- a/docs/reference/api/ConnectorSyncJobCheckInRequest.md +++ b/docs/reference/api/ConnectorSyncJobCheckInRequest.md @@ -1,4 +1,4 @@ -## Interface `ConnectorSyncJobCheckInRequest` +# `ConnectorSyncJobCheckInRequest` [interface-ConnectorSyncJobCheckInRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ConnectorSyncJobCheckInResponse.md b/docs/reference/api/ConnectorSyncJobCheckInResponse.md index 5184a6a6d..6e5bd210c 100644 --- a/docs/reference/api/ConnectorSyncJobCheckInResponse.md +++ b/docs/reference/api/ConnectorSyncJobCheckInResponse.md @@ -1,4 +1,4 @@ -## Interface `ConnectorSyncJobCheckInResponse` +# `ConnectorSyncJobCheckInResponse` [interface-ConnectorSyncJobCheckInResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ConnectorSyncJobClaimRequest.md b/docs/reference/api/ConnectorSyncJobClaimRequest.md index 17f5bae9e..3cbdf546f 100644 --- a/docs/reference/api/ConnectorSyncJobClaimRequest.md +++ b/docs/reference/api/ConnectorSyncJobClaimRequest.md @@ -1,4 +1,4 @@ -## Interface `ConnectorSyncJobClaimRequest` +# `ConnectorSyncJobClaimRequest` [interface-ConnectorSyncJobClaimRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ConnectorSyncJobClaimResponse.md b/docs/reference/api/ConnectorSyncJobClaimResponse.md index d8c539ab8..597a2e5ea 100644 --- a/docs/reference/api/ConnectorSyncJobClaimResponse.md +++ b/docs/reference/api/ConnectorSyncJobClaimResponse.md @@ -1,4 +1,4 @@ -## Interface `ConnectorSyncJobClaimResponse` +# `ConnectorSyncJobClaimResponse` [interface-ConnectorSyncJobClaimResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ConnectorSyncJobConnectorReference.md b/docs/reference/api/ConnectorSyncJobConnectorReference.md index 55b758651..15cc52236 100644 --- a/docs/reference/api/ConnectorSyncJobConnectorReference.md +++ b/docs/reference/api/ConnectorSyncJobConnectorReference.md @@ -1,4 +1,4 @@ -## Interface `ConnectorSyncJobConnectorReference` +# `ConnectorSyncJobConnectorReference` [interface-ConnectorSyncJobConnectorReference] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ConnectorSyncJobDeleteRequest.md b/docs/reference/api/ConnectorSyncJobDeleteRequest.md index 011d9e36d..3d54bfea5 100644 --- a/docs/reference/api/ConnectorSyncJobDeleteRequest.md +++ b/docs/reference/api/ConnectorSyncJobDeleteRequest.md @@ -1,4 +1,4 @@ -## Interface `ConnectorSyncJobDeleteRequest` +# `ConnectorSyncJobDeleteRequest` [interface-ConnectorSyncJobDeleteRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ConnectorSyncJobDeleteResponse.md b/docs/reference/api/ConnectorSyncJobDeleteResponse.md index 2121a6327..dd681a594 100644 --- a/docs/reference/api/ConnectorSyncJobDeleteResponse.md +++ b/docs/reference/api/ConnectorSyncJobDeleteResponse.md @@ -1,4 +1,4 @@ -## `ConnectorSyncJobDeleteResponse` -::: +# `ConnectorSyncJobDeleteResponse` [alias-ConnectorSyncJobDeleteResponse] +```typescript type ConnectorSyncJobDeleteResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); -::: +``` diff --git a/docs/reference/api/ConnectorSyncJobErrorRequest.md b/docs/reference/api/ConnectorSyncJobErrorRequest.md index 594059f6a..05f9b5f06 100644 --- a/docs/reference/api/ConnectorSyncJobErrorRequest.md +++ b/docs/reference/api/ConnectorSyncJobErrorRequest.md @@ -1,4 +1,4 @@ -## Interface `ConnectorSyncJobErrorRequest` +# `ConnectorSyncJobErrorRequest` [interface-ConnectorSyncJobErrorRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ConnectorSyncJobErrorResponse.md b/docs/reference/api/ConnectorSyncJobErrorResponse.md index 00b73067c..5de56fb6b 100644 --- a/docs/reference/api/ConnectorSyncJobErrorResponse.md +++ b/docs/reference/api/ConnectorSyncJobErrorResponse.md @@ -1,4 +1,4 @@ -## Interface `ConnectorSyncJobErrorResponse` +# `ConnectorSyncJobErrorResponse` [interface-ConnectorSyncJobErrorResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ConnectorSyncJobGetRequest.md b/docs/reference/api/ConnectorSyncJobGetRequest.md index c2732f2c5..ae5496bb1 100644 --- a/docs/reference/api/ConnectorSyncJobGetRequest.md +++ b/docs/reference/api/ConnectorSyncJobGetRequest.md @@ -1,4 +1,4 @@ -## Interface `ConnectorSyncJobGetRequest` +# `ConnectorSyncJobGetRequest` [interface-ConnectorSyncJobGetRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ConnectorSyncJobGetResponse.md b/docs/reference/api/ConnectorSyncJobGetResponse.md index 1cd7d37de..ed2877997 100644 --- a/docs/reference/api/ConnectorSyncJobGetResponse.md +++ b/docs/reference/api/ConnectorSyncJobGetResponse.md @@ -1,4 +1,4 @@ -## `ConnectorSyncJobGetResponse` -::: +# `ConnectorSyncJobGetResponse` [alias-ConnectorSyncJobGetResponse] +```typescript type ConnectorSyncJobGetResponse = [ConnectorConnectorSyncJob](./ConnectorConnectorSyncJob.md); -::: +``` diff --git a/docs/reference/api/ConnectorSyncJobListRequest.md b/docs/reference/api/ConnectorSyncJobListRequest.md index 22124ab9e..b494de810 100644 --- a/docs/reference/api/ConnectorSyncJobListRequest.md +++ b/docs/reference/api/ConnectorSyncJobListRequest.md @@ -1,4 +1,4 @@ -## Interface `ConnectorSyncJobListRequest` +# `ConnectorSyncJobListRequest` [interface-ConnectorSyncJobListRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ConnectorSyncJobListResponse.md b/docs/reference/api/ConnectorSyncJobListResponse.md index 4746f5b1f..74f0067dc 100644 --- a/docs/reference/api/ConnectorSyncJobListResponse.md +++ b/docs/reference/api/ConnectorSyncJobListResponse.md @@ -1,4 +1,4 @@ -## Interface `ConnectorSyncJobListResponse` +# `ConnectorSyncJobListResponse` [interface-ConnectorSyncJobListResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ConnectorSyncJobPostRequest.md b/docs/reference/api/ConnectorSyncJobPostRequest.md index fd4230a68..bcbebc34c 100644 --- a/docs/reference/api/ConnectorSyncJobPostRequest.md +++ b/docs/reference/api/ConnectorSyncJobPostRequest.md @@ -1,4 +1,4 @@ -## Interface `ConnectorSyncJobPostRequest` +# `ConnectorSyncJobPostRequest` [interface-ConnectorSyncJobPostRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ConnectorSyncJobPostResponse.md b/docs/reference/api/ConnectorSyncJobPostResponse.md index 42239429a..94863d1ef 100644 --- a/docs/reference/api/ConnectorSyncJobPostResponse.md +++ b/docs/reference/api/ConnectorSyncJobPostResponse.md @@ -1,4 +1,4 @@ -## Interface `ConnectorSyncJobPostResponse` +# `ConnectorSyncJobPostResponse` [interface-ConnectorSyncJobPostResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ConnectorSyncJobTriggerMethod.md b/docs/reference/api/ConnectorSyncJobTriggerMethod.md index dd80f1fc3..ebdc38c83 100644 --- a/docs/reference/api/ConnectorSyncJobTriggerMethod.md +++ b/docs/reference/api/ConnectorSyncJobTriggerMethod.md @@ -1,4 +1,4 @@ -## `ConnectorSyncJobTriggerMethod` -::: +# `ConnectorSyncJobTriggerMethod` [alias-ConnectorSyncJobTriggerMethod] +```typescript type ConnectorSyncJobTriggerMethod = 'on_demand' | 'scheduled'; -::: +``` diff --git a/docs/reference/api/ConnectorSyncJobType.md b/docs/reference/api/ConnectorSyncJobType.md index e44afce47..7144f5866 100644 --- a/docs/reference/api/ConnectorSyncJobType.md +++ b/docs/reference/api/ConnectorSyncJobType.md @@ -1,4 +1,4 @@ -## `ConnectorSyncJobType` -::: +# `ConnectorSyncJobType` [alias-ConnectorSyncJobType] +```typescript type ConnectorSyncJobType = 'full' | 'incremental' | 'access_control'; -::: +``` diff --git a/docs/reference/api/ConnectorSyncJobUpdateStatsRequest.md b/docs/reference/api/ConnectorSyncJobUpdateStatsRequest.md index 47b72d102..15619d83c 100644 --- a/docs/reference/api/ConnectorSyncJobUpdateStatsRequest.md +++ b/docs/reference/api/ConnectorSyncJobUpdateStatsRequest.md @@ -1,4 +1,4 @@ -## Interface `ConnectorSyncJobUpdateStatsRequest` +# `ConnectorSyncJobUpdateStatsRequest` [interface-ConnectorSyncJobUpdateStatsRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ConnectorSyncJobUpdateStatsResponse.md b/docs/reference/api/ConnectorSyncJobUpdateStatsResponse.md index 5f3f5578d..312b49b15 100644 --- a/docs/reference/api/ConnectorSyncJobUpdateStatsResponse.md +++ b/docs/reference/api/ConnectorSyncJobUpdateStatsResponse.md @@ -1,4 +1,4 @@ -## Interface `ConnectorSyncJobUpdateStatsResponse` +# `ConnectorSyncJobUpdateStatsResponse` [interface-ConnectorSyncJobUpdateStatsResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ConnectorSyncRulesFeature.md b/docs/reference/api/ConnectorSyncRulesFeature.md index 091108e93..18b5ce088 100644 --- a/docs/reference/api/ConnectorSyncRulesFeature.md +++ b/docs/reference/api/ConnectorSyncRulesFeature.md @@ -1,4 +1,4 @@ -## Interface `ConnectorSyncRulesFeature` +# `ConnectorSyncRulesFeature` [interface-ConnectorSyncRulesFeature] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ConnectorSyncStatus.md b/docs/reference/api/ConnectorSyncStatus.md index 77dfc29ac..96e080071 100644 --- a/docs/reference/api/ConnectorSyncStatus.md +++ b/docs/reference/api/ConnectorSyncStatus.md @@ -1,4 +1,4 @@ -## `ConnectorSyncStatus` -::: +# `ConnectorSyncStatus` [alias-ConnectorSyncStatus] +```typescript type ConnectorSyncStatus = 'canceling' | 'canceled' | 'completed' | 'error' | 'in_progress' | 'pending' | 'suspended'; -::: +``` diff --git a/docs/reference/api/ConnectorUpdateActiveFilteringRequest.md b/docs/reference/api/ConnectorUpdateActiveFilteringRequest.md index 32bbe4282..48c2bca15 100644 --- a/docs/reference/api/ConnectorUpdateActiveFilteringRequest.md +++ b/docs/reference/api/ConnectorUpdateActiveFilteringRequest.md @@ -1,4 +1,4 @@ -## Interface `ConnectorUpdateActiveFilteringRequest` +# `ConnectorUpdateActiveFilteringRequest` [interface-ConnectorUpdateActiveFilteringRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ConnectorUpdateActiveFilteringResponse.md b/docs/reference/api/ConnectorUpdateActiveFilteringResponse.md index 91c257cbc..97273d819 100644 --- a/docs/reference/api/ConnectorUpdateActiveFilteringResponse.md +++ b/docs/reference/api/ConnectorUpdateActiveFilteringResponse.md @@ -1,4 +1,4 @@ -## Interface `ConnectorUpdateActiveFilteringResponse` +# `ConnectorUpdateActiveFilteringResponse` [interface-ConnectorUpdateActiveFilteringResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ConnectorUpdateApiKeyIdRequest.md b/docs/reference/api/ConnectorUpdateApiKeyIdRequest.md index 1c6f65172..63653f622 100644 --- a/docs/reference/api/ConnectorUpdateApiKeyIdRequest.md +++ b/docs/reference/api/ConnectorUpdateApiKeyIdRequest.md @@ -1,4 +1,4 @@ -## Interface `ConnectorUpdateApiKeyIdRequest` +# `ConnectorUpdateApiKeyIdRequest` [interface-ConnectorUpdateApiKeyIdRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ConnectorUpdateApiKeyIdResponse.md b/docs/reference/api/ConnectorUpdateApiKeyIdResponse.md index 404cd13cf..eec8b6f66 100644 --- a/docs/reference/api/ConnectorUpdateApiKeyIdResponse.md +++ b/docs/reference/api/ConnectorUpdateApiKeyIdResponse.md @@ -1,4 +1,4 @@ -## Interface `ConnectorUpdateApiKeyIdResponse` +# `ConnectorUpdateApiKeyIdResponse` [interface-ConnectorUpdateApiKeyIdResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ConnectorUpdateConfigurationRequest.md b/docs/reference/api/ConnectorUpdateConfigurationRequest.md index da4565541..3d60f0da8 100644 --- a/docs/reference/api/ConnectorUpdateConfigurationRequest.md +++ b/docs/reference/api/ConnectorUpdateConfigurationRequest.md @@ -1,4 +1,4 @@ -## Interface `ConnectorUpdateConfigurationRequest` +# `ConnectorUpdateConfigurationRequest` [interface-ConnectorUpdateConfigurationRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ConnectorUpdateConfigurationResponse.md b/docs/reference/api/ConnectorUpdateConfigurationResponse.md index 217066506..657e4b735 100644 --- a/docs/reference/api/ConnectorUpdateConfigurationResponse.md +++ b/docs/reference/api/ConnectorUpdateConfigurationResponse.md @@ -1,4 +1,4 @@ -## Interface `ConnectorUpdateConfigurationResponse` +# `ConnectorUpdateConfigurationResponse` [interface-ConnectorUpdateConfigurationResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ConnectorUpdateErrorRequest.md b/docs/reference/api/ConnectorUpdateErrorRequest.md index 7c4fef2e4..252c75196 100644 --- a/docs/reference/api/ConnectorUpdateErrorRequest.md +++ b/docs/reference/api/ConnectorUpdateErrorRequest.md @@ -1,4 +1,4 @@ -## Interface `ConnectorUpdateErrorRequest` +# `ConnectorUpdateErrorRequest` [interface-ConnectorUpdateErrorRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ConnectorUpdateErrorResponse.md b/docs/reference/api/ConnectorUpdateErrorResponse.md index efcb9552b..c2edc892a 100644 --- a/docs/reference/api/ConnectorUpdateErrorResponse.md +++ b/docs/reference/api/ConnectorUpdateErrorResponse.md @@ -1,4 +1,4 @@ -## Interface `ConnectorUpdateErrorResponse` +# `ConnectorUpdateErrorResponse` [interface-ConnectorUpdateErrorResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ConnectorUpdateFeaturesRequest.md b/docs/reference/api/ConnectorUpdateFeaturesRequest.md index 6e9d49846..d7c03642d 100644 --- a/docs/reference/api/ConnectorUpdateFeaturesRequest.md +++ b/docs/reference/api/ConnectorUpdateFeaturesRequest.md @@ -1,4 +1,4 @@ -## Interface `ConnectorUpdateFeaturesRequest` +# `ConnectorUpdateFeaturesRequest` [interface-ConnectorUpdateFeaturesRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ConnectorUpdateFeaturesResponse.md b/docs/reference/api/ConnectorUpdateFeaturesResponse.md index 8c77b65fc..d9cb90830 100644 --- a/docs/reference/api/ConnectorUpdateFeaturesResponse.md +++ b/docs/reference/api/ConnectorUpdateFeaturesResponse.md @@ -1,4 +1,4 @@ -## Interface `ConnectorUpdateFeaturesResponse` +# `ConnectorUpdateFeaturesResponse` [interface-ConnectorUpdateFeaturesResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ConnectorUpdateFilteringRequest.md b/docs/reference/api/ConnectorUpdateFilteringRequest.md index 4778f5e65..14c8fccf7 100644 --- a/docs/reference/api/ConnectorUpdateFilteringRequest.md +++ b/docs/reference/api/ConnectorUpdateFilteringRequest.md @@ -1,4 +1,4 @@ -## Interface `ConnectorUpdateFilteringRequest` +# `ConnectorUpdateFilteringRequest` [interface-ConnectorUpdateFilteringRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ConnectorUpdateFilteringResponse.md b/docs/reference/api/ConnectorUpdateFilteringResponse.md index 97a90f4a6..914921d25 100644 --- a/docs/reference/api/ConnectorUpdateFilteringResponse.md +++ b/docs/reference/api/ConnectorUpdateFilteringResponse.md @@ -1,4 +1,4 @@ -## Interface `ConnectorUpdateFilteringResponse` +# `ConnectorUpdateFilteringResponse` [interface-ConnectorUpdateFilteringResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ConnectorUpdateFilteringValidationRequest.md b/docs/reference/api/ConnectorUpdateFilteringValidationRequest.md index 87198a044..e677ced41 100644 --- a/docs/reference/api/ConnectorUpdateFilteringValidationRequest.md +++ b/docs/reference/api/ConnectorUpdateFilteringValidationRequest.md @@ -1,4 +1,4 @@ -## Interface `ConnectorUpdateFilteringValidationRequest` +# `ConnectorUpdateFilteringValidationRequest` [interface-ConnectorUpdateFilteringValidationRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ConnectorUpdateFilteringValidationResponse.md b/docs/reference/api/ConnectorUpdateFilteringValidationResponse.md index d04776b91..fa414f89f 100644 --- a/docs/reference/api/ConnectorUpdateFilteringValidationResponse.md +++ b/docs/reference/api/ConnectorUpdateFilteringValidationResponse.md @@ -1,4 +1,4 @@ -## Interface `ConnectorUpdateFilteringValidationResponse` +# `ConnectorUpdateFilteringValidationResponse` [interface-ConnectorUpdateFilteringValidationResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ConnectorUpdateIndexNameRequest.md b/docs/reference/api/ConnectorUpdateIndexNameRequest.md index 54b55348b..8fb393c51 100644 --- a/docs/reference/api/ConnectorUpdateIndexNameRequest.md +++ b/docs/reference/api/ConnectorUpdateIndexNameRequest.md @@ -1,4 +1,4 @@ -## Interface `ConnectorUpdateIndexNameRequest` +# `ConnectorUpdateIndexNameRequest` [interface-ConnectorUpdateIndexNameRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ConnectorUpdateIndexNameResponse.md b/docs/reference/api/ConnectorUpdateIndexNameResponse.md index 60342a837..f260f320e 100644 --- a/docs/reference/api/ConnectorUpdateIndexNameResponse.md +++ b/docs/reference/api/ConnectorUpdateIndexNameResponse.md @@ -1,4 +1,4 @@ -## Interface `ConnectorUpdateIndexNameResponse` +# `ConnectorUpdateIndexNameResponse` [interface-ConnectorUpdateIndexNameResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ConnectorUpdateNameRequest.md b/docs/reference/api/ConnectorUpdateNameRequest.md index c5e75ffc9..7cdebc176 100644 --- a/docs/reference/api/ConnectorUpdateNameRequest.md +++ b/docs/reference/api/ConnectorUpdateNameRequest.md @@ -1,4 +1,4 @@ -## Interface `ConnectorUpdateNameRequest` +# `ConnectorUpdateNameRequest` [interface-ConnectorUpdateNameRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ConnectorUpdateNameResponse.md b/docs/reference/api/ConnectorUpdateNameResponse.md index 75d94b6ad..36989f480 100644 --- a/docs/reference/api/ConnectorUpdateNameResponse.md +++ b/docs/reference/api/ConnectorUpdateNameResponse.md @@ -1,4 +1,4 @@ -## Interface `ConnectorUpdateNameResponse` +# `ConnectorUpdateNameResponse` [interface-ConnectorUpdateNameResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ConnectorUpdateNativeRequest.md b/docs/reference/api/ConnectorUpdateNativeRequest.md index b309c656e..4ba689c98 100644 --- a/docs/reference/api/ConnectorUpdateNativeRequest.md +++ b/docs/reference/api/ConnectorUpdateNativeRequest.md @@ -1,4 +1,4 @@ -## Interface `ConnectorUpdateNativeRequest` +# `ConnectorUpdateNativeRequest` [interface-ConnectorUpdateNativeRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ConnectorUpdateNativeResponse.md b/docs/reference/api/ConnectorUpdateNativeResponse.md index 4da9efc8b..ee0bc29c5 100644 --- a/docs/reference/api/ConnectorUpdateNativeResponse.md +++ b/docs/reference/api/ConnectorUpdateNativeResponse.md @@ -1,4 +1,4 @@ -## Interface `ConnectorUpdateNativeResponse` +# `ConnectorUpdateNativeResponse` [interface-ConnectorUpdateNativeResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ConnectorUpdatePipelineRequest.md b/docs/reference/api/ConnectorUpdatePipelineRequest.md index 37fe7617c..32a9cad4c 100644 --- a/docs/reference/api/ConnectorUpdatePipelineRequest.md +++ b/docs/reference/api/ConnectorUpdatePipelineRequest.md @@ -1,4 +1,4 @@ -## Interface `ConnectorUpdatePipelineRequest` +# `ConnectorUpdatePipelineRequest` [interface-ConnectorUpdatePipelineRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ConnectorUpdatePipelineResponse.md b/docs/reference/api/ConnectorUpdatePipelineResponse.md index 8441e66ba..75730f92e 100644 --- a/docs/reference/api/ConnectorUpdatePipelineResponse.md +++ b/docs/reference/api/ConnectorUpdatePipelineResponse.md @@ -1,4 +1,4 @@ -## Interface `ConnectorUpdatePipelineResponse` +# `ConnectorUpdatePipelineResponse` [interface-ConnectorUpdatePipelineResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ConnectorUpdateSchedulingRequest.md b/docs/reference/api/ConnectorUpdateSchedulingRequest.md index 7d2ec00a1..e36bffd34 100644 --- a/docs/reference/api/ConnectorUpdateSchedulingRequest.md +++ b/docs/reference/api/ConnectorUpdateSchedulingRequest.md @@ -1,4 +1,4 @@ -## Interface `ConnectorUpdateSchedulingRequest` +# `ConnectorUpdateSchedulingRequest` [interface-ConnectorUpdateSchedulingRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ConnectorUpdateSchedulingResponse.md b/docs/reference/api/ConnectorUpdateSchedulingResponse.md index 697829ab3..09ffe3ba0 100644 --- a/docs/reference/api/ConnectorUpdateSchedulingResponse.md +++ b/docs/reference/api/ConnectorUpdateSchedulingResponse.md @@ -1,4 +1,4 @@ -## Interface `ConnectorUpdateSchedulingResponse` +# `ConnectorUpdateSchedulingResponse` [interface-ConnectorUpdateSchedulingResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ConnectorUpdateServiceTypeRequest.md b/docs/reference/api/ConnectorUpdateServiceTypeRequest.md index 259482b96..3d151a61a 100644 --- a/docs/reference/api/ConnectorUpdateServiceTypeRequest.md +++ b/docs/reference/api/ConnectorUpdateServiceTypeRequest.md @@ -1,4 +1,4 @@ -## Interface `ConnectorUpdateServiceTypeRequest` +# `ConnectorUpdateServiceTypeRequest` [interface-ConnectorUpdateServiceTypeRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ConnectorUpdateServiceTypeResponse.md b/docs/reference/api/ConnectorUpdateServiceTypeResponse.md index 6f4f8dd11..cdac7c194 100644 --- a/docs/reference/api/ConnectorUpdateServiceTypeResponse.md +++ b/docs/reference/api/ConnectorUpdateServiceTypeResponse.md @@ -1,4 +1,4 @@ -## Interface `ConnectorUpdateServiceTypeResponse` +# `ConnectorUpdateServiceTypeResponse` [interface-ConnectorUpdateServiceTypeResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ConnectorUpdateStatusRequest.md b/docs/reference/api/ConnectorUpdateStatusRequest.md index bca80871e..9cefe6d6d 100644 --- a/docs/reference/api/ConnectorUpdateStatusRequest.md +++ b/docs/reference/api/ConnectorUpdateStatusRequest.md @@ -1,4 +1,4 @@ -## Interface `ConnectorUpdateStatusRequest` +# `ConnectorUpdateStatusRequest` [interface-ConnectorUpdateStatusRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ConnectorUpdateStatusResponse.md b/docs/reference/api/ConnectorUpdateStatusResponse.md index 2eb2a4256..8ca656767 100644 --- a/docs/reference/api/ConnectorUpdateStatusResponse.md +++ b/docs/reference/api/ConnectorUpdateStatusResponse.md @@ -1,4 +1,4 @@ -## Interface `ConnectorUpdateStatusResponse` +# `ConnectorUpdateStatusResponse` [interface-ConnectorUpdateStatusResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ConnectorValidation.md b/docs/reference/api/ConnectorValidation.md index 7a0da9720..288f8f617 100644 --- a/docs/reference/api/ConnectorValidation.md +++ b/docs/reference/api/ConnectorValidation.md @@ -1,4 +1,4 @@ -## `ConnectorValidation` -::: +# `ConnectorValidation` [alias-ConnectorValidation] +```typescript type ConnectorValidation = [ConnectorLessThanValidation](./ConnectorLessThanValidation.md) | [ConnectorGreaterThanValidation](./ConnectorGreaterThanValidation.md) | [ConnectorListTypeValidation](./ConnectorListTypeValidation.md) | [ConnectorIncludedInValidation](./ConnectorIncludedInValidation.md) | [ConnectorRegexValidation](./ConnectorRegexValidation.md); -::: +``` diff --git a/docs/reference/api/CoordsGeoBounds.md b/docs/reference/api/CoordsGeoBounds.md index b08d8a7d6..240cfc511 100644 --- a/docs/reference/api/CoordsGeoBounds.md +++ b/docs/reference/api/CoordsGeoBounds.md @@ -1,4 +1,4 @@ -## Interface `CoordsGeoBounds` +# `CoordsGeoBounds` [interface-CoordsGeoBounds] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/CountApi_1.md b/docs/reference/api/CountApi_1.md index 62c2a55f5..f434f9d03 100644 --- a/docs/reference/api/CountApi_1.md +++ b/docs/reference/api/CountApi_1.md @@ -1,3 +1,3 @@ -::: +```typescript default function CountApi(this: [That](./That.md), params?: [CountRequest](./CountRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CountResponse](./CountResponse.md)>; -::: +``` diff --git a/docs/reference/api/CountApi_2.md b/docs/reference/api/CountApi_2.md index 77424fcea..e6f66ba29 100644 --- a/docs/reference/api/CountApi_2.md +++ b/docs/reference/api/CountApi_2.md @@ -1,3 +1,3 @@ -::: +```typescript default function CountApi(this: [That](./That.md), params?: [CountRequest](./CountRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CountResponse](./CountResponse.md), unknown>>; -::: +``` diff --git a/docs/reference/api/CountApi_3.md b/docs/reference/api/CountApi_3.md index edaec1b7d..489d65ee9 100644 --- a/docs/reference/api/CountApi_3.md +++ b/docs/reference/api/CountApi_3.md @@ -1,3 +1,3 @@ -::: +```typescript default function CountApi(this: [That](./That.md), params?: [CountRequest](./CountRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CountResponse](./CountResponse.md)>; -::: +``` diff --git a/docs/reference/api/CountRequest.md b/docs/reference/api/CountRequest.md index dd632e962..29c4a547b 100644 --- a/docs/reference/api/CountRequest.md +++ b/docs/reference/api/CountRequest.md @@ -1,4 +1,4 @@ -## Interface `CountRequest` +# `CountRequest` [interface-CountRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/CountResponse.md b/docs/reference/api/CountResponse.md index 6dd4fc54f..eb81cabd9 100644 --- a/docs/reference/api/CountResponse.md +++ b/docs/reference/api/CountResponse.md @@ -1,4 +1,4 @@ -## Interface `CountResponse` +# `CountResponse` [interface-CountResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/CreateAction.md b/docs/reference/api/CreateAction.md index 74e7b092d..432e1ea26 100644 --- a/docs/reference/api/CreateAction.md +++ b/docs/reference/api/CreateAction.md @@ -1,4 +1,4 @@ -## `CreateAction` -::: +# `CreateAction` [alias-CreateAction] +```typescript type CreateAction = [CreateActionOperation](./CreateActionOperation.md) | [[CreateActionOperation](./CreateActionOperation.md), unknown]; -::: +``` diff --git a/docs/reference/api/CreateActionOperation.md b/docs/reference/api/CreateActionOperation.md index 995feebc4..b0616110c 100644 --- a/docs/reference/api/CreateActionOperation.md +++ b/docs/reference/api/CreateActionOperation.md @@ -1,4 +1,4 @@ -## Interface `CreateActionOperation` +# `CreateActionOperation` [interface-CreateActionOperation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/CreateApi_1.md b/docs/reference/api/CreateApi_1.md index 722dda8ab..9c9b8739b 100644 --- a/docs/reference/api/CreateApi_1.md +++ b/docs/reference/api/CreateApi_1.md @@ -1,3 +1,3 @@ -::: +```typescript default function CreateApi(this: [That](./That.md), params: [CreateRequest](./CreateRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[CreateResponse](./CreateResponse.md)>; -::: +``` diff --git a/docs/reference/api/CreateApi_2.md b/docs/reference/api/CreateApi_2.md index 404affe73..129a3f952 100644 --- a/docs/reference/api/CreateApi_2.md +++ b/docs/reference/api/CreateApi_2.md @@ -1,3 +1,3 @@ -::: +```typescript default function CreateApi(this: [That](./That.md), params: [CreateRequest](./CreateRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[CreateResponse](./CreateResponse.md), unknown>>; -::: +``` diff --git a/docs/reference/api/CreateApi_3.md b/docs/reference/api/CreateApi_3.md index f940e4937..92493170c 100644 --- a/docs/reference/api/CreateApi_3.md +++ b/docs/reference/api/CreateApi_3.md @@ -1,3 +1,3 @@ -::: +```typescript default function CreateApi(this: [That](./That.md), params: [CreateRequest](./CreateRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[CreateResponse](./CreateResponse.md)>; -::: +``` diff --git a/docs/reference/api/CreateRequest.md b/docs/reference/api/CreateRequest.md index 0e9597de9..4118e9f11 100644 --- a/docs/reference/api/CreateRequest.md +++ b/docs/reference/api/CreateRequest.md @@ -1,4 +1,4 @@ -## Interface `CreateRequest` +# `CreateRequest` [interface-CreateRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/CreateResponse.md b/docs/reference/api/CreateResponse.md index dbbb09fce..badb8468e 100644 --- a/docs/reference/api/CreateResponse.md +++ b/docs/reference/api/CreateResponse.md @@ -1,4 +1,4 @@ -## `CreateResponse` -::: +# `CreateResponse` [alias-CreateResponse] +```typescript type CreateResponse = [WriteResponseBase](./WriteResponseBase.md); -::: +``` diff --git a/docs/reference/api/DFIIndependenceMeasure.md b/docs/reference/api/DFIIndependenceMeasure.md index 75e6bfb5d..05ea7b93e 100644 --- a/docs/reference/api/DFIIndependenceMeasure.md +++ b/docs/reference/api/DFIIndependenceMeasure.md @@ -1,4 +1,4 @@ -## `DFIIndependenceMeasure` -::: +# `DFIIndependenceMeasure` [alias-DFIIndependenceMeasure] +```typescript type DFIIndependenceMeasure = 'standardized' | 'saturated' | 'chisquared'; -::: +``` diff --git a/docs/reference/api/DFRAfterEffect.md b/docs/reference/api/DFRAfterEffect.md index 201bbf9e8..6fbb64ad7 100644 --- a/docs/reference/api/DFRAfterEffect.md +++ b/docs/reference/api/DFRAfterEffect.md @@ -1,4 +1,4 @@ -## `DFRAfterEffect` -::: +# `DFRAfterEffect` [alias-DFRAfterEffect] +```typescript type DFRAfterEffect = 'no' | 'b' | 'l'; -::: +``` diff --git a/docs/reference/api/DFRBasicModel.md b/docs/reference/api/DFRBasicModel.md index 1cffe83c1..99700e903 100644 --- a/docs/reference/api/DFRBasicModel.md +++ b/docs/reference/api/DFRBasicModel.md @@ -1,4 +1,4 @@ -## `DFRBasicModel` -::: +# `DFRBasicModel` [alias-DFRBasicModel] +```typescript type DFRBasicModel = 'be' | 'd' | 'g' | 'if' | 'in' | 'ine' | 'p'; -::: +``` diff --git a/docs/reference/api/DanglingIndices.md b/docs/reference/api/DanglingIndices.md index 81add5af9..38ae66de5 100644 --- a/docs/reference/api/DanglingIndices.md +++ b/docs/reference/api/DanglingIndices.md @@ -1,19 +1,19 @@ -## `DanglingIndices` +# `DanglingIndices` [class-DanglingIndices] -### Constructor +## Constructor -::: +```typescript new DanglingIndices(transport: [Transport](./Transport.md)); -::: +``` -### Properties +## Properties [class-properties-DanglingIndices] | Name | Type | Description | | - | - | - | | `acceptedParams` | Record |   | | `transport` | [Transport](./Transport.md) |   | -### Methods +## Methods [class-methods-DanglingIndices] | Name | Signature | Description | | - | - | - | diff --git a/docs/reference/api/DanglingIndicesDeleteDanglingIndexRequest.md b/docs/reference/api/DanglingIndicesDeleteDanglingIndexRequest.md index 56043c983..cda57bc06 100644 --- a/docs/reference/api/DanglingIndicesDeleteDanglingIndexRequest.md +++ b/docs/reference/api/DanglingIndicesDeleteDanglingIndexRequest.md @@ -1,4 +1,4 @@ -## Interface `DanglingIndicesDeleteDanglingIndexRequest` +# `DanglingIndicesDeleteDanglingIndexRequest` [interface-DanglingIndicesDeleteDanglingIndexRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/DanglingIndicesDeleteDanglingIndexResponse.md b/docs/reference/api/DanglingIndicesDeleteDanglingIndexResponse.md index e809c81ff..5fef9f213 100644 --- a/docs/reference/api/DanglingIndicesDeleteDanglingIndexResponse.md +++ b/docs/reference/api/DanglingIndicesDeleteDanglingIndexResponse.md @@ -1,4 +1,4 @@ -## `DanglingIndicesDeleteDanglingIndexResponse` -::: +# `DanglingIndicesDeleteDanglingIndexResponse` [alias-DanglingIndicesDeleteDanglingIndexResponse] +```typescript type DanglingIndicesDeleteDanglingIndexResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); -::: +``` diff --git a/docs/reference/api/DanglingIndicesImportDanglingIndexRequest.md b/docs/reference/api/DanglingIndicesImportDanglingIndexRequest.md index 71171c4da..2b2267d99 100644 --- a/docs/reference/api/DanglingIndicesImportDanglingIndexRequest.md +++ b/docs/reference/api/DanglingIndicesImportDanglingIndexRequest.md @@ -1,4 +1,4 @@ -## Interface `DanglingIndicesImportDanglingIndexRequest` +# `DanglingIndicesImportDanglingIndexRequest` [interface-DanglingIndicesImportDanglingIndexRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/DanglingIndicesImportDanglingIndexResponse.md b/docs/reference/api/DanglingIndicesImportDanglingIndexResponse.md index 4eae4185d..07c75f7f0 100644 --- a/docs/reference/api/DanglingIndicesImportDanglingIndexResponse.md +++ b/docs/reference/api/DanglingIndicesImportDanglingIndexResponse.md @@ -1,4 +1,4 @@ -## `DanglingIndicesImportDanglingIndexResponse` -::: +# `DanglingIndicesImportDanglingIndexResponse` [alias-DanglingIndicesImportDanglingIndexResponse] +```typescript type DanglingIndicesImportDanglingIndexResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); -::: +``` diff --git a/docs/reference/api/DanglingIndicesListDanglingIndicesDanglingIndex.md b/docs/reference/api/DanglingIndicesListDanglingIndicesDanglingIndex.md index 8f3e2ebaa..6219ea0df 100644 --- a/docs/reference/api/DanglingIndicesListDanglingIndicesDanglingIndex.md +++ b/docs/reference/api/DanglingIndicesListDanglingIndicesDanglingIndex.md @@ -1,4 +1,4 @@ -## Interface `DanglingIndicesListDanglingIndicesDanglingIndex` +# `DanglingIndicesListDanglingIndicesDanglingIndex` [interface-DanglingIndicesListDanglingIndicesDanglingIndex] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/DanglingIndicesListDanglingIndicesRequest.md b/docs/reference/api/DanglingIndicesListDanglingIndicesRequest.md index a61704761..e3fabeb49 100644 --- a/docs/reference/api/DanglingIndicesListDanglingIndicesRequest.md +++ b/docs/reference/api/DanglingIndicesListDanglingIndicesRequest.md @@ -1,4 +1,4 @@ -## Interface `DanglingIndicesListDanglingIndicesRequest` +# `DanglingIndicesListDanglingIndicesRequest` [interface-DanglingIndicesListDanglingIndicesRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/DanglingIndicesListDanglingIndicesResponse.md b/docs/reference/api/DanglingIndicesListDanglingIndicesResponse.md index f7671a803..ecdbe2619 100644 --- a/docs/reference/api/DanglingIndicesListDanglingIndicesResponse.md +++ b/docs/reference/api/DanglingIndicesListDanglingIndicesResponse.md @@ -1,4 +1,4 @@ -## Interface `DanglingIndicesListDanglingIndicesResponse` +# `DanglingIndicesListDanglingIndicesResponse` [interface-DanglingIndicesListDanglingIndicesResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/DataStreamName.md b/docs/reference/api/DataStreamName.md index 0797bc0e0..9d8b8068c 100644 --- a/docs/reference/api/DataStreamName.md +++ b/docs/reference/api/DataStreamName.md @@ -1,4 +1,4 @@ -## `DataStreamName` -::: +# `DataStreamName` [alias-DataStreamName] +```typescript type DataStreamName = string; -::: +``` diff --git a/docs/reference/api/DataStreamNames.md b/docs/reference/api/DataStreamNames.md index db15334cf..ac7884189 100644 --- a/docs/reference/api/DataStreamNames.md +++ b/docs/reference/api/DataStreamNames.md @@ -1,4 +1,4 @@ -## `DataStreamNames` -::: +# `DataStreamNames` [alias-DataStreamNames] +```typescript type DataStreamNames = [DataStreamName](./DataStreamName.md) | [DataStreamName](./DataStreamName.md)[]; -::: +``` diff --git a/docs/reference/api/DateFormat.md b/docs/reference/api/DateFormat.md index 9e15f2e49..1a95f781a 100644 --- a/docs/reference/api/DateFormat.md +++ b/docs/reference/api/DateFormat.md @@ -1,4 +1,4 @@ -## `DateFormat` -::: +# `DateFormat` [alias-DateFormat] +```typescript type DateFormat = string; -::: +``` diff --git a/docs/reference/api/DateMath.md b/docs/reference/api/DateMath.md index 5507c3ec6..f9cf9006d 100644 --- a/docs/reference/api/DateMath.md +++ b/docs/reference/api/DateMath.md @@ -1,4 +1,4 @@ -## `DateMath` -::: +# `DateMath` [alias-DateMath] +```typescript type DateMath = string | [Date](./Date.md); -::: +``` diff --git a/docs/reference/api/DateTime.md b/docs/reference/api/DateTime.md index d1ecc0e7d..d62bbf392 100644 --- a/docs/reference/api/DateTime.md +++ b/docs/reference/api/DateTime.md @@ -1,4 +1,4 @@ -## `DateTime` -::: +# `DateTime` [alias-DateTime] +```typescript type DateTime = string | [EpochTime](./EpochTime.md)<[UnitMillis](./UnitMillis.md)> | [Date](./Date.md); -::: +``` diff --git a/docs/reference/api/DeleteAction.md b/docs/reference/api/DeleteAction.md index 7f61e3767..ca67a9cab 100644 --- a/docs/reference/api/DeleteAction.md +++ b/docs/reference/api/DeleteAction.md @@ -1,4 +1,4 @@ -## Interface `DeleteAction` +# `DeleteAction` [interface-DeleteAction] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/DeleteApi_1.md b/docs/reference/api/DeleteApi_1.md index f5844be66..3ee5b8ca5 100644 --- a/docs/reference/api/DeleteApi_1.md +++ b/docs/reference/api/DeleteApi_1.md @@ -1,3 +1,3 @@ -::: +```typescript default function DeleteApi(this: [That](./That.md), params: [DeleteRequest](./DeleteRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[DeleteResponse](./DeleteResponse.md)>; -::: +``` diff --git a/docs/reference/api/DeleteApi_2.md b/docs/reference/api/DeleteApi_2.md index fd2f1e276..331a2ebd2 100644 --- a/docs/reference/api/DeleteApi_2.md +++ b/docs/reference/api/DeleteApi_2.md @@ -1,3 +1,3 @@ -::: +```typescript default function DeleteApi(this: [That](./That.md), params: [DeleteRequest](./DeleteRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[DeleteResponse](./DeleteResponse.md), unknown>>; -::: +``` diff --git a/docs/reference/api/DeleteApi_3.md b/docs/reference/api/DeleteApi_3.md index d03130325..8c6638c84 100644 --- a/docs/reference/api/DeleteApi_3.md +++ b/docs/reference/api/DeleteApi_3.md @@ -1,3 +1,3 @@ -::: +```typescript default function DeleteApi(this: [That](./That.md), params: [DeleteRequest](./DeleteRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[DeleteResponse](./DeleteResponse.md)>; -::: +``` diff --git a/docs/reference/api/DeleteByQueryApi_1.md b/docs/reference/api/DeleteByQueryApi_1.md index f8fe5939e..980316d2f 100644 --- a/docs/reference/api/DeleteByQueryApi_1.md +++ b/docs/reference/api/DeleteByQueryApi_1.md @@ -1,3 +1,3 @@ -::: +```typescript default function DeleteByQueryApi(this: [That](./That.md), params: [DeleteByQueryRequest](./DeleteByQueryRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[DeleteByQueryResponse](./DeleteByQueryResponse.md)>; -::: +``` diff --git a/docs/reference/api/DeleteByQueryApi_2.md b/docs/reference/api/DeleteByQueryApi_2.md index 81f3d635e..e84696f82 100644 --- a/docs/reference/api/DeleteByQueryApi_2.md +++ b/docs/reference/api/DeleteByQueryApi_2.md @@ -1,3 +1,3 @@ -::: +```typescript default function DeleteByQueryApi(this: [That](./That.md), params: [DeleteByQueryRequest](./DeleteByQueryRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[DeleteByQueryResponse](./DeleteByQueryResponse.md), unknown>>; -::: +``` diff --git a/docs/reference/api/DeleteByQueryApi_3.md b/docs/reference/api/DeleteByQueryApi_3.md index b93a836c5..d247f24fe 100644 --- a/docs/reference/api/DeleteByQueryApi_3.md +++ b/docs/reference/api/DeleteByQueryApi_3.md @@ -1,3 +1,3 @@ -::: +```typescript default function DeleteByQueryApi(this: [That](./That.md), params: [DeleteByQueryRequest](./DeleteByQueryRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[DeleteByQueryResponse](./DeleteByQueryResponse.md)>; -::: +``` diff --git a/docs/reference/api/DeleteByQueryRequest.md b/docs/reference/api/DeleteByQueryRequest.md index f4103127a..08465b33d 100644 --- a/docs/reference/api/DeleteByQueryRequest.md +++ b/docs/reference/api/DeleteByQueryRequest.md @@ -1,4 +1,4 @@ -## Interface `DeleteByQueryRequest` +# `DeleteByQueryRequest` [interface-DeleteByQueryRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/DeleteByQueryResponse.md b/docs/reference/api/DeleteByQueryResponse.md index d51b6a577..b1b4f920d 100644 --- a/docs/reference/api/DeleteByQueryResponse.md +++ b/docs/reference/api/DeleteByQueryResponse.md @@ -1,4 +1,4 @@ -## Interface `DeleteByQueryResponse` +# `DeleteByQueryResponse` [interface-DeleteByQueryResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/DeleteByQueryRethrottleApi_1.md b/docs/reference/api/DeleteByQueryRethrottleApi_1.md index 431a53aa7..ecddd2955 100644 --- a/docs/reference/api/DeleteByQueryRethrottleApi_1.md +++ b/docs/reference/api/DeleteByQueryRethrottleApi_1.md @@ -1,3 +1,3 @@ -::: +```typescript default function DeleteByQueryRethrottleApi(this: [That](./That.md), params: [DeleteByQueryRethrottleRequest](./DeleteByQueryRethrottleRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[DeleteByQueryRethrottleResponse](./DeleteByQueryRethrottleResponse.md)>; -::: +``` diff --git a/docs/reference/api/DeleteByQueryRethrottleApi_2.md b/docs/reference/api/DeleteByQueryRethrottleApi_2.md index 6c7afd0f5..30537921d 100644 --- a/docs/reference/api/DeleteByQueryRethrottleApi_2.md +++ b/docs/reference/api/DeleteByQueryRethrottleApi_2.md @@ -1,3 +1,3 @@ -::: +```typescript default function DeleteByQueryRethrottleApi(this: [That](./That.md), params: [DeleteByQueryRethrottleRequest](./DeleteByQueryRethrottleRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[DeleteByQueryRethrottleResponse](./DeleteByQueryRethrottleResponse.md), unknown>>; -::: +``` diff --git a/docs/reference/api/DeleteByQueryRethrottleApi_3.md b/docs/reference/api/DeleteByQueryRethrottleApi_3.md index e9f5c4e3f..e94fbd7bb 100644 --- a/docs/reference/api/DeleteByQueryRethrottleApi_3.md +++ b/docs/reference/api/DeleteByQueryRethrottleApi_3.md @@ -1,3 +1,3 @@ -::: +```typescript default function DeleteByQueryRethrottleApi(this: [That](./That.md), params: [DeleteByQueryRethrottleRequest](./DeleteByQueryRethrottleRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[DeleteByQueryRethrottleResponse](./DeleteByQueryRethrottleResponse.md)>; -::: +``` diff --git a/docs/reference/api/DeleteByQueryRethrottleRequest.md b/docs/reference/api/DeleteByQueryRethrottleRequest.md index c2f917367..25c944dab 100644 --- a/docs/reference/api/DeleteByQueryRethrottleRequest.md +++ b/docs/reference/api/DeleteByQueryRethrottleRequest.md @@ -1,4 +1,4 @@ -## Interface `DeleteByQueryRethrottleRequest` +# `DeleteByQueryRethrottleRequest` [interface-DeleteByQueryRethrottleRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/DeleteByQueryRethrottleResponse.md b/docs/reference/api/DeleteByQueryRethrottleResponse.md index 23e0287e7..a69075f9a 100644 --- a/docs/reference/api/DeleteByQueryRethrottleResponse.md +++ b/docs/reference/api/DeleteByQueryRethrottleResponse.md @@ -1,4 +1,4 @@ -## `DeleteByQueryRethrottleResponse` -::: +# `DeleteByQueryRethrottleResponse` [alias-DeleteByQueryRethrottleResponse] +```typescript type DeleteByQueryRethrottleResponse = [TasksTaskListResponseBase](./TasksTaskListResponseBase.md); -::: +``` diff --git a/docs/reference/api/DeleteRequest.md b/docs/reference/api/DeleteRequest.md index 0667c74f3..80767158b 100644 --- a/docs/reference/api/DeleteRequest.md +++ b/docs/reference/api/DeleteRequest.md @@ -1,4 +1,4 @@ -## Interface `DeleteRequest` +# `DeleteRequest` [interface-DeleteRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/DeleteResponse.md b/docs/reference/api/DeleteResponse.md index 9db48cc74..afe8f8740 100644 --- a/docs/reference/api/DeleteResponse.md +++ b/docs/reference/api/DeleteResponse.md @@ -1,4 +1,4 @@ -## `DeleteResponse` -::: +# `DeleteResponse` [alias-DeleteResponse] +```typescript type DeleteResponse = [WriteResponseBase](./WriteResponseBase.md); -::: +``` diff --git a/docs/reference/api/DeleteScriptApi_1.md b/docs/reference/api/DeleteScriptApi_1.md index 53bad8dce..1420399b3 100644 --- a/docs/reference/api/DeleteScriptApi_1.md +++ b/docs/reference/api/DeleteScriptApi_1.md @@ -1,3 +1,3 @@ -::: +```typescript default function DeleteScriptApi(this: [That](./That.md), params: [DeleteScriptRequest](./DeleteScriptRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[DeleteScriptResponse](./DeleteScriptResponse.md)>; -::: +``` diff --git a/docs/reference/api/DeleteScriptApi_2.md b/docs/reference/api/DeleteScriptApi_2.md index b66639fc5..1133e963d 100644 --- a/docs/reference/api/DeleteScriptApi_2.md +++ b/docs/reference/api/DeleteScriptApi_2.md @@ -1,3 +1,3 @@ -::: +```typescript default function DeleteScriptApi(this: [That](./That.md), params: [DeleteScriptRequest](./DeleteScriptRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[DeleteScriptResponse](./DeleteScriptResponse.md), unknown>>; -::: +``` diff --git a/docs/reference/api/DeleteScriptApi_3.md b/docs/reference/api/DeleteScriptApi_3.md index 0b85e37bd..878d1e247 100644 --- a/docs/reference/api/DeleteScriptApi_3.md +++ b/docs/reference/api/DeleteScriptApi_3.md @@ -1,3 +1,3 @@ -::: +```typescript default function DeleteScriptApi(this: [That](./That.md), params: [DeleteScriptRequest](./DeleteScriptRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[DeleteScriptResponse](./DeleteScriptResponse.md)>; -::: +``` diff --git a/docs/reference/api/DeleteScriptRequest.md b/docs/reference/api/DeleteScriptRequest.md index 8cb6201eb..d63da7b4e 100644 --- a/docs/reference/api/DeleteScriptRequest.md +++ b/docs/reference/api/DeleteScriptRequest.md @@ -1,4 +1,4 @@ -## Interface `DeleteScriptRequest` +# `DeleteScriptRequest` [interface-DeleteScriptRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/DeleteScriptResponse.md b/docs/reference/api/DeleteScriptResponse.md index 4460bad7c..a43dda309 100644 --- a/docs/reference/api/DeleteScriptResponse.md +++ b/docs/reference/api/DeleteScriptResponse.md @@ -1,4 +1,4 @@ -## `DeleteScriptResponse` -::: +# `DeleteScriptResponse` [alias-DeleteScriptResponse] +```typescript type DeleteScriptResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); -::: +``` diff --git a/docs/reference/api/Distance.md b/docs/reference/api/Distance.md index c0e0c9010..76cbe44d6 100644 --- a/docs/reference/api/Distance.md +++ b/docs/reference/api/Distance.md @@ -1,4 +1,4 @@ -## `Distance` -::: +# `Distance` [alias-Distance] +```typescript type Distance = string; -::: +``` diff --git a/docs/reference/api/DistanceUnit.md b/docs/reference/api/DistanceUnit.md index c1356f0d1..a2c4acbd3 100644 --- a/docs/reference/api/DistanceUnit.md +++ b/docs/reference/api/DistanceUnit.md @@ -1,4 +1,4 @@ -## `DistanceUnit` -::: +# `DistanceUnit` [alias-DistanceUnit] +```typescript type DistanceUnit = 'in' | 'ft' | 'yd' | 'mi' | 'nmi' | 'km' | 'm' | 'cm' | 'mm'; -::: +``` diff --git a/docs/reference/api/DocStats.md b/docs/reference/api/DocStats.md index e5e4de566..ebacab521 100644 --- a/docs/reference/api/DocStats.md +++ b/docs/reference/api/DocStats.md @@ -1,4 +1,4 @@ -## Interface `DocStats` +# `DocStats` [interface-DocStats] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/Duration.md b/docs/reference/api/Duration.md index 3f29386bb..7e05fd7ab 100644 --- a/docs/reference/api/Duration.md +++ b/docs/reference/api/Duration.md @@ -1,4 +1,4 @@ -## `Duration` -::: +# `Duration` [alias-Duration] +```typescript type Duration = string | -1 | 0; -::: +``` diff --git a/docs/reference/api/DurationLarge.md b/docs/reference/api/DurationLarge.md index d722dd095..17e6b1ddf 100644 --- a/docs/reference/api/DurationLarge.md +++ b/docs/reference/api/DurationLarge.md @@ -1,4 +1,4 @@ -## `DurationLarge` -::: +# `DurationLarge` [alias-DurationLarge] +```typescript type DurationLarge = string; -::: +``` diff --git a/docs/reference/api/DurationValue.md b/docs/reference/api/DurationValue.md index df98a7610..7a8a40a16 100644 --- a/docs/reference/api/DurationValue.md +++ b/docs/reference/api/DurationValue.md @@ -1,4 +1,4 @@ -## `DurationValue` -::: +# `DurationValue` [alias-DurationValue] +```typescript type DurationValue = Unit; -::: +``` diff --git a/docs/reference/api/ElasticsearchVersionInfo.md b/docs/reference/api/ElasticsearchVersionInfo.md index 813c3d08c..976e5f821 100644 --- a/docs/reference/api/ElasticsearchVersionInfo.md +++ b/docs/reference/api/ElasticsearchVersionInfo.md @@ -1,4 +1,4 @@ -## Interface `ElasticsearchVersionInfo` +# `ElasticsearchVersionInfo` [interface-ElasticsearchVersionInfo] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ElasticsearchVersionMinInfo.md b/docs/reference/api/ElasticsearchVersionMinInfo.md index 80069ee09..d50ddef90 100644 --- a/docs/reference/api/ElasticsearchVersionMinInfo.md +++ b/docs/reference/api/ElasticsearchVersionMinInfo.md @@ -1,4 +1,4 @@ -## Interface `ElasticsearchVersionMinInfo` +# `ElasticsearchVersionMinInfo` [interface-ElasticsearchVersionMinInfo] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/EmptyObject.md b/docs/reference/api/EmptyObject.md index de563b81c..f2550b6b0 100644 --- a/docs/reference/api/EmptyObject.md +++ b/docs/reference/api/EmptyObject.md @@ -1,4 +1,4 @@ -## Interface `EmptyObject` +# `EmptyObject` [interface-EmptyObject] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/Enrich.md b/docs/reference/api/Enrich.md index ef1fa5f53..4c21744cd 100644 --- a/docs/reference/api/Enrich.md +++ b/docs/reference/api/Enrich.md @@ -1,19 +1,19 @@ -## `Enrich` +# `Enrich` [class-Enrich] -### Constructor +## Constructor -::: +```typescript new Enrich(transport: [Transport](./Transport.md)); -::: +``` -### Properties +## Properties [class-properties-Enrich] | Name | Type | Description | | - | - | - | | `acceptedParams` | Record |   | | `transport` | [Transport](./Transport.md) |   | -### Methods +## Methods [class-methods-Enrich] | Name | Signature | Description | | - | - | - | diff --git a/docs/reference/api/EnrichDeletePolicyRequest.md b/docs/reference/api/EnrichDeletePolicyRequest.md index 9a9ab2a68..4e29af6b7 100644 --- a/docs/reference/api/EnrichDeletePolicyRequest.md +++ b/docs/reference/api/EnrichDeletePolicyRequest.md @@ -1,4 +1,4 @@ -## Interface `EnrichDeletePolicyRequest` +# `EnrichDeletePolicyRequest` [interface-EnrichDeletePolicyRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/EnrichDeletePolicyResponse.md b/docs/reference/api/EnrichDeletePolicyResponse.md index 83c2bd0cb..890b78b93 100644 --- a/docs/reference/api/EnrichDeletePolicyResponse.md +++ b/docs/reference/api/EnrichDeletePolicyResponse.md @@ -1,4 +1,4 @@ -## `EnrichDeletePolicyResponse` -::: +# `EnrichDeletePolicyResponse` [alias-EnrichDeletePolicyResponse] +```typescript type EnrichDeletePolicyResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); -::: +``` diff --git a/docs/reference/api/EnrichExecutePolicyEnrichPolicyPhase.md b/docs/reference/api/EnrichExecutePolicyEnrichPolicyPhase.md index 329702e00..406018085 100644 --- a/docs/reference/api/EnrichExecutePolicyEnrichPolicyPhase.md +++ b/docs/reference/api/EnrichExecutePolicyEnrichPolicyPhase.md @@ -1,4 +1,4 @@ -## `EnrichExecutePolicyEnrichPolicyPhase` -::: +# `EnrichExecutePolicyEnrichPolicyPhase` [alias-EnrichExecutePolicyEnrichPolicyPhase] +```typescript type EnrichExecutePolicyEnrichPolicyPhase = 'SCHEDULED' | 'RUNNING' | 'COMPLETE' | 'FAILED' | 'CANCELLED'; -::: +``` diff --git a/docs/reference/api/EnrichExecutePolicyExecuteEnrichPolicyStatus.md b/docs/reference/api/EnrichExecutePolicyExecuteEnrichPolicyStatus.md index 00c611645..6bcdbd64f 100644 --- a/docs/reference/api/EnrichExecutePolicyExecuteEnrichPolicyStatus.md +++ b/docs/reference/api/EnrichExecutePolicyExecuteEnrichPolicyStatus.md @@ -1,4 +1,4 @@ -## Interface `EnrichExecutePolicyExecuteEnrichPolicyStatus` +# `EnrichExecutePolicyExecuteEnrichPolicyStatus` [interface-EnrichExecutePolicyExecuteEnrichPolicyStatus] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/EnrichExecutePolicyRequest.md b/docs/reference/api/EnrichExecutePolicyRequest.md index cd332c440..329c900ba 100644 --- a/docs/reference/api/EnrichExecutePolicyRequest.md +++ b/docs/reference/api/EnrichExecutePolicyRequest.md @@ -1,4 +1,4 @@ -## Interface `EnrichExecutePolicyRequest` +# `EnrichExecutePolicyRequest` [interface-EnrichExecutePolicyRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/EnrichExecutePolicyResponse.md b/docs/reference/api/EnrichExecutePolicyResponse.md index 4f0d9cc8e..3253c4edd 100644 --- a/docs/reference/api/EnrichExecutePolicyResponse.md +++ b/docs/reference/api/EnrichExecutePolicyResponse.md @@ -1,4 +1,4 @@ -## Interface `EnrichExecutePolicyResponse` +# `EnrichExecutePolicyResponse` [interface-EnrichExecutePolicyResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/EnrichGetPolicyRequest.md b/docs/reference/api/EnrichGetPolicyRequest.md index 5f2580c5f..7536f5637 100644 --- a/docs/reference/api/EnrichGetPolicyRequest.md +++ b/docs/reference/api/EnrichGetPolicyRequest.md @@ -1,4 +1,4 @@ -## Interface `EnrichGetPolicyRequest` +# `EnrichGetPolicyRequest` [interface-EnrichGetPolicyRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/EnrichGetPolicyResponse.md b/docs/reference/api/EnrichGetPolicyResponse.md index 0dc6ba991..6dc3cb563 100644 --- a/docs/reference/api/EnrichGetPolicyResponse.md +++ b/docs/reference/api/EnrichGetPolicyResponse.md @@ -1,4 +1,4 @@ -## Interface `EnrichGetPolicyResponse` +# `EnrichGetPolicyResponse` [interface-EnrichGetPolicyResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/EnrichPolicy.md b/docs/reference/api/EnrichPolicy.md index 0758d9f08..ec6449231 100644 --- a/docs/reference/api/EnrichPolicy.md +++ b/docs/reference/api/EnrichPolicy.md @@ -1,4 +1,4 @@ -## Interface `EnrichPolicy` +# `EnrichPolicy` [interface-EnrichPolicy] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/EnrichPolicyType.md b/docs/reference/api/EnrichPolicyType.md index 514037c73..16ebb905a 100644 --- a/docs/reference/api/EnrichPolicyType.md +++ b/docs/reference/api/EnrichPolicyType.md @@ -1,4 +1,4 @@ -## `EnrichPolicyType` -::: +# `EnrichPolicyType` [alias-EnrichPolicyType] +```typescript type EnrichPolicyType = 'geo_match' | 'match' | 'range'; -::: +``` diff --git a/docs/reference/api/EnrichPutPolicyRequest.md b/docs/reference/api/EnrichPutPolicyRequest.md index 86920afb8..5a046b4e2 100644 --- a/docs/reference/api/EnrichPutPolicyRequest.md +++ b/docs/reference/api/EnrichPutPolicyRequest.md @@ -1,4 +1,4 @@ -## Interface `EnrichPutPolicyRequest` +# `EnrichPutPolicyRequest` [interface-EnrichPutPolicyRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/EnrichPutPolicyResponse.md b/docs/reference/api/EnrichPutPolicyResponse.md index 8f9d7ddb5..31a904870 100644 --- a/docs/reference/api/EnrichPutPolicyResponse.md +++ b/docs/reference/api/EnrichPutPolicyResponse.md @@ -1,4 +1,4 @@ -## `EnrichPutPolicyResponse` -::: +# `EnrichPutPolicyResponse` [alias-EnrichPutPolicyResponse] +```typescript type EnrichPutPolicyResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); -::: +``` diff --git a/docs/reference/api/EnrichStatsCacheStats.md b/docs/reference/api/EnrichStatsCacheStats.md index 2864640a4..8b74091dd 100644 --- a/docs/reference/api/EnrichStatsCacheStats.md +++ b/docs/reference/api/EnrichStatsCacheStats.md @@ -1,4 +1,4 @@ -## Interface `EnrichStatsCacheStats` +# `EnrichStatsCacheStats` [interface-EnrichStatsCacheStats] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/EnrichStatsCoordinatorStats.md b/docs/reference/api/EnrichStatsCoordinatorStats.md index 9229337fa..875458959 100644 --- a/docs/reference/api/EnrichStatsCoordinatorStats.md +++ b/docs/reference/api/EnrichStatsCoordinatorStats.md @@ -1,4 +1,4 @@ -## Interface `EnrichStatsCoordinatorStats` +# `EnrichStatsCoordinatorStats` [interface-EnrichStatsCoordinatorStats] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/EnrichStatsExecutingPolicy.md b/docs/reference/api/EnrichStatsExecutingPolicy.md index 1b277c0d2..e99343027 100644 --- a/docs/reference/api/EnrichStatsExecutingPolicy.md +++ b/docs/reference/api/EnrichStatsExecutingPolicy.md @@ -1,4 +1,4 @@ -## Interface `EnrichStatsExecutingPolicy` +# `EnrichStatsExecutingPolicy` [interface-EnrichStatsExecutingPolicy] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/EnrichStatsRequest.md b/docs/reference/api/EnrichStatsRequest.md index 759d29ad2..aa9c587e7 100644 --- a/docs/reference/api/EnrichStatsRequest.md +++ b/docs/reference/api/EnrichStatsRequest.md @@ -1,4 +1,4 @@ -## Interface `EnrichStatsRequest` +# `EnrichStatsRequest` [interface-EnrichStatsRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/EnrichStatsResponse.md b/docs/reference/api/EnrichStatsResponse.md index 8f203b38a..f47df7325 100644 --- a/docs/reference/api/EnrichStatsResponse.md +++ b/docs/reference/api/EnrichStatsResponse.md @@ -1,4 +1,4 @@ -## Interface `EnrichStatsResponse` +# `EnrichStatsResponse` [interface-EnrichStatsResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/EnrichSummary.md b/docs/reference/api/EnrichSummary.md index 2626ad099..d89246080 100644 --- a/docs/reference/api/EnrichSummary.md +++ b/docs/reference/api/EnrichSummary.md @@ -1,4 +1,4 @@ -## Interface `EnrichSummary` +# `EnrichSummary` [interface-EnrichSummary] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/EpochTime.md b/docs/reference/api/EpochTime.md index e6f446485..f68a971b7 100644 --- a/docs/reference/api/EpochTime.md +++ b/docs/reference/api/EpochTime.md @@ -1,4 +1,4 @@ -## `EpochTime` -::: +# `EpochTime` [alias-EpochTime] +```typescript type EpochTime = Unit; -::: +``` diff --git a/docs/reference/api/Eql.md b/docs/reference/api/Eql.md index 9d7722dcd..5aff98eec 100644 --- a/docs/reference/api/Eql.md +++ b/docs/reference/api/Eql.md @@ -1,19 +1,19 @@ -## `Eql` +# `Eql` [class-Eql] -### Constructor +## Constructor -::: +```typescript new Eql(transport: [Transport](./Transport.md)); -::: +``` -### Properties +## Properties [class-properties-Eql] | Name | Type | Description | | - | - | - | | `acceptedParams` | Record |   | | `transport` | [Transport](./Transport.md) |   | -### Methods +## Methods [class-methods-Eql] | Name | Signature | Description | | - | - | - | diff --git a/docs/reference/api/EqlDeleteRequest.md b/docs/reference/api/EqlDeleteRequest.md index f144804d7..def9b1ee2 100644 --- a/docs/reference/api/EqlDeleteRequest.md +++ b/docs/reference/api/EqlDeleteRequest.md @@ -1,4 +1,4 @@ -## Interface `EqlDeleteRequest` +# `EqlDeleteRequest` [interface-EqlDeleteRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/EqlDeleteResponse.md b/docs/reference/api/EqlDeleteResponse.md index 8fd958654..438fa894d 100644 --- a/docs/reference/api/EqlDeleteResponse.md +++ b/docs/reference/api/EqlDeleteResponse.md @@ -1,4 +1,4 @@ -## `EqlDeleteResponse` -::: +# `EqlDeleteResponse` [alias-EqlDeleteResponse] +```typescript type EqlDeleteResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); -::: +``` diff --git a/docs/reference/api/EqlEqlHits.md b/docs/reference/api/EqlEqlHits.md index 42e7f321d..d6a9cd6d3 100644 --- a/docs/reference/api/EqlEqlHits.md +++ b/docs/reference/api/EqlEqlHits.md @@ -1,4 +1,4 @@ -## Interface `EqlEqlHits` +# `EqlEqlHits` [interface-EqlEqlHits] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/EqlEqlSearchResponseBase.md b/docs/reference/api/EqlEqlSearchResponseBase.md index 9d4320e83..734105626 100644 --- a/docs/reference/api/EqlEqlSearchResponseBase.md +++ b/docs/reference/api/EqlEqlSearchResponseBase.md @@ -1,4 +1,4 @@ -## Interface `EqlEqlSearchResponseBase` +# `EqlEqlSearchResponseBase` [interface-EqlEqlSearchResponseBase] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/EqlGetRequest.md b/docs/reference/api/EqlGetRequest.md index 83fb557da..b73e772a5 100644 --- a/docs/reference/api/EqlGetRequest.md +++ b/docs/reference/api/EqlGetRequest.md @@ -1,4 +1,4 @@ -## Interface `EqlGetRequest` +# `EqlGetRequest` [interface-EqlGetRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/EqlGetResponse.md b/docs/reference/api/EqlGetResponse.md index f7888d9f7..635a4c5b5 100644 --- a/docs/reference/api/EqlGetResponse.md +++ b/docs/reference/api/EqlGetResponse.md @@ -1,4 +1,4 @@ -## `EqlGetResponse` -::: +# `EqlGetResponse` [alias-EqlGetResponse] +```typescript type EqlGetResponse = [EqlEqlSearchResponseBase](./EqlEqlSearchResponseBase.md); -::: +``` diff --git a/docs/reference/api/EqlGetStatusRequest.md b/docs/reference/api/EqlGetStatusRequest.md index eb17445e1..1efc13a90 100644 --- a/docs/reference/api/EqlGetStatusRequest.md +++ b/docs/reference/api/EqlGetStatusRequest.md @@ -1,4 +1,4 @@ -## Interface `EqlGetStatusRequest` +# `EqlGetStatusRequest` [interface-EqlGetStatusRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/EqlGetStatusResponse.md b/docs/reference/api/EqlGetStatusResponse.md index 262f6845c..137c92189 100644 --- a/docs/reference/api/EqlGetStatusResponse.md +++ b/docs/reference/api/EqlGetStatusResponse.md @@ -1,4 +1,4 @@ -## Interface `EqlGetStatusResponse` +# `EqlGetStatusResponse` [interface-EqlGetStatusResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/EqlHitsEvent.md b/docs/reference/api/EqlHitsEvent.md index cf03e67a5..152a4b5b3 100644 --- a/docs/reference/api/EqlHitsEvent.md +++ b/docs/reference/api/EqlHitsEvent.md @@ -1,4 +1,4 @@ -## Interface `EqlHitsEvent` +# `EqlHitsEvent` [interface-EqlHitsEvent] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/EqlHitsSequence.md b/docs/reference/api/EqlHitsSequence.md index 7c33c9960..30ff74649 100644 --- a/docs/reference/api/EqlHitsSequence.md +++ b/docs/reference/api/EqlHitsSequence.md @@ -1,4 +1,4 @@ -## Interface `EqlHitsSequence` +# `EqlHitsSequence` [interface-EqlHitsSequence] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/EqlSearchRequest.md b/docs/reference/api/EqlSearchRequest.md index 3a2b2438a..757c150d4 100644 --- a/docs/reference/api/EqlSearchRequest.md +++ b/docs/reference/api/EqlSearchRequest.md @@ -1,4 +1,4 @@ -## Interface `EqlSearchRequest` +# `EqlSearchRequest` [interface-EqlSearchRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/EqlSearchResponse.md b/docs/reference/api/EqlSearchResponse.md index c5532179c..e6eb47a31 100644 --- a/docs/reference/api/EqlSearchResponse.md +++ b/docs/reference/api/EqlSearchResponse.md @@ -1,4 +1,4 @@ -## `EqlSearchResponse` -::: +# `EqlSearchResponse` [alias-EqlSearchResponse] +```typescript type EqlSearchResponse = [EqlEqlSearchResponseBase](./EqlEqlSearchResponseBase.md); -::: +``` diff --git a/docs/reference/api/EqlSearchResultPosition.md b/docs/reference/api/EqlSearchResultPosition.md index 6c2ff5c39..96bb74908 100644 --- a/docs/reference/api/EqlSearchResultPosition.md +++ b/docs/reference/api/EqlSearchResultPosition.md @@ -1,4 +1,4 @@ -## `EqlSearchResultPosition` -::: +# `EqlSearchResultPosition` [alias-EqlSearchResultPosition] +```typescript type EqlSearchResultPosition = 'tail' | 'head'; -::: +``` diff --git a/docs/reference/api/ErrorCause.md b/docs/reference/api/ErrorCause.md index e8d31362f..b09906ab4 100644 --- a/docs/reference/api/ErrorCause.md +++ b/docs/reference/api/ErrorCause.md @@ -1,4 +1,4 @@ -## `ErrorCause` -::: +# `ErrorCause` [alias-ErrorCause] +```typescript type ErrorCause = [ErrorCauseKeys](./ErrorCauseKeys.md) & { [property: string]: any;}; -::: +``` diff --git a/docs/reference/api/ErrorCauseKeys.md b/docs/reference/api/ErrorCauseKeys.md index 8f93e8a1b..405ce4842 100644 --- a/docs/reference/api/ErrorCauseKeys.md +++ b/docs/reference/api/ErrorCauseKeys.md @@ -1,4 +1,4 @@ -## Interface `ErrorCauseKeys` +# `ErrorCauseKeys` [interface-ErrorCauseKeys] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ErrorResponseBase.md b/docs/reference/api/ErrorResponseBase.md index 16e687479..f6abedc1a 100644 --- a/docs/reference/api/ErrorResponseBase.md +++ b/docs/reference/api/ErrorResponseBase.md @@ -1,4 +1,4 @@ -## Interface `ErrorResponseBase` +# `ErrorResponseBase` [interface-ErrorResponseBase] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/Esql.md b/docs/reference/api/Esql.md index 07efa8c27..738a80263 100644 --- a/docs/reference/api/Esql.md +++ b/docs/reference/api/Esql.md @@ -1,19 +1,19 @@ -## `Esql` +# `Esql` [class-Esql] -### Constructor +## Constructor -::: +```typescript new Esql(transport: [Transport](./Transport.md)); -::: +``` -### Properties +## Properties [class-properties-Esql] | Name | Type | Description | | - | - | - | | `acceptedParams` | Record |   | | `transport` | [Transport](./Transport.md) |   | -### Methods +## Methods [class-methods-Esql] | Name | Signature | Description | | - | - | - | diff --git a/docs/reference/api/EsqlAsyncEsqlResult.md b/docs/reference/api/EsqlAsyncEsqlResult.md index e0880b234..8b79c620f 100644 --- a/docs/reference/api/EsqlAsyncEsqlResult.md +++ b/docs/reference/api/EsqlAsyncEsqlResult.md @@ -1,4 +1,4 @@ -## Interface `EsqlAsyncEsqlResult` +# `EsqlAsyncEsqlResult` [interface-EsqlAsyncEsqlResult] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/EsqlAsyncQueryDeleteRequest.md b/docs/reference/api/EsqlAsyncQueryDeleteRequest.md index 42a3dbef5..7c066319b 100644 --- a/docs/reference/api/EsqlAsyncQueryDeleteRequest.md +++ b/docs/reference/api/EsqlAsyncQueryDeleteRequest.md @@ -1,4 +1,4 @@ -## Interface `EsqlAsyncQueryDeleteRequest` +# `EsqlAsyncQueryDeleteRequest` [interface-EsqlAsyncQueryDeleteRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/EsqlAsyncQueryDeleteResponse.md b/docs/reference/api/EsqlAsyncQueryDeleteResponse.md index 8f2455a91..eb08b8485 100644 --- a/docs/reference/api/EsqlAsyncQueryDeleteResponse.md +++ b/docs/reference/api/EsqlAsyncQueryDeleteResponse.md @@ -1,4 +1,4 @@ -## `EsqlAsyncQueryDeleteResponse` -::: +# `EsqlAsyncQueryDeleteResponse` [alias-EsqlAsyncQueryDeleteResponse] +```typescript type EsqlAsyncQueryDeleteResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); -::: +``` diff --git a/docs/reference/api/EsqlAsyncQueryGetRequest.md b/docs/reference/api/EsqlAsyncQueryGetRequest.md index 1ff8018b5..2edfe5f11 100644 --- a/docs/reference/api/EsqlAsyncQueryGetRequest.md +++ b/docs/reference/api/EsqlAsyncQueryGetRequest.md @@ -1,4 +1,4 @@ -## Interface `EsqlAsyncQueryGetRequest` +# `EsqlAsyncQueryGetRequest` [interface-EsqlAsyncQueryGetRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/EsqlAsyncQueryGetResponse.md b/docs/reference/api/EsqlAsyncQueryGetResponse.md index 1e8db8131..b3813322f 100644 --- a/docs/reference/api/EsqlAsyncQueryGetResponse.md +++ b/docs/reference/api/EsqlAsyncQueryGetResponse.md @@ -1,4 +1,4 @@ -## `EsqlAsyncQueryGetResponse` -::: +# `EsqlAsyncQueryGetResponse` [alias-EsqlAsyncQueryGetResponse] +```typescript type EsqlAsyncQueryGetResponse = [EsqlAsyncEsqlResult](./EsqlAsyncEsqlResult.md); -::: +``` diff --git a/docs/reference/api/EsqlAsyncQueryRequest.md b/docs/reference/api/EsqlAsyncQueryRequest.md index f7505b046..bd146be43 100644 --- a/docs/reference/api/EsqlAsyncQueryRequest.md +++ b/docs/reference/api/EsqlAsyncQueryRequest.md @@ -1,4 +1,4 @@ -## Interface `EsqlAsyncQueryRequest` +# `EsqlAsyncQueryRequest` [interface-EsqlAsyncQueryRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/EsqlAsyncQueryResponse.md b/docs/reference/api/EsqlAsyncQueryResponse.md index 7750afc77..a9ca00423 100644 --- a/docs/reference/api/EsqlAsyncQueryResponse.md +++ b/docs/reference/api/EsqlAsyncQueryResponse.md @@ -1,4 +1,4 @@ -## `EsqlAsyncQueryResponse` -::: +# `EsqlAsyncQueryResponse` [alias-EsqlAsyncQueryResponse] +```typescript type EsqlAsyncQueryResponse = [EsqlAsyncEsqlResult](./EsqlAsyncEsqlResult.md); -::: +``` diff --git a/docs/reference/api/EsqlAsyncQueryStopRequest.md b/docs/reference/api/EsqlAsyncQueryStopRequest.md index 436021d4b..5ddec766c 100644 --- a/docs/reference/api/EsqlAsyncQueryStopRequest.md +++ b/docs/reference/api/EsqlAsyncQueryStopRequest.md @@ -1,4 +1,4 @@ -## Interface `EsqlAsyncQueryStopRequest` +# `EsqlAsyncQueryStopRequest` [interface-EsqlAsyncQueryStopRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/EsqlAsyncQueryStopResponse.md b/docs/reference/api/EsqlAsyncQueryStopResponse.md index 7e84effc7..7befe9299 100644 --- a/docs/reference/api/EsqlAsyncQueryStopResponse.md +++ b/docs/reference/api/EsqlAsyncQueryStopResponse.md @@ -1,4 +1,4 @@ -## `EsqlAsyncQueryStopResponse` -::: +# `EsqlAsyncQueryStopResponse` [alias-EsqlAsyncQueryStopResponse] +```typescript type EsqlAsyncQueryStopResponse = [EsqlEsqlResult](./EsqlEsqlResult.md); -::: +``` diff --git a/docs/reference/api/EsqlColumn.md b/docs/reference/api/EsqlColumn.md index f436e77f5..6c737a241 100644 --- a/docs/reference/api/EsqlColumn.md +++ b/docs/reference/api/EsqlColumn.md @@ -1,4 +1,4 @@ -## Interface `EsqlColumn` +# `EsqlColumn` [interface-EsqlColumn] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/EsqlEsqlClusterDetails.md b/docs/reference/api/EsqlEsqlClusterDetails.md index 657cd6660..679d2115b 100644 --- a/docs/reference/api/EsqlEsqlClusterDetails.md +++ b/docs/reference/api/EsqlEsqlClusterDetails.md @@ -1,4 +1,4 @@ -## Interface `EsqlEsqlClusterDetails` +# `EsqlEsqlClusterDetails` [interface-EsqlEsqlClusterDetails] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/EsqlEsqlClusterInfo.md b/docs/reference/api/EsqlEsqlClusterInfo.md index 77e76f631..6bc27fa15 100644 --- a/docs/reference/api/EsqlEsqlClusterInfo.md +++ b/docs/reference/api/EsqlEsqlClusterInfo.md @@ -1,4 +1,4 @@ -## Interface `EsqlEsqlClusterInfo` +# `EsqlEsqlClusterInfo` [interface-EsqlEsqlClusterInfo] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/EsqlEsqlClusterStatus.md b/docs/reference/api/EsqlEsqlClusterStatus.md index 1a7b3877b..8d4134d4e 100644 --- a/docs/reference/api/EsqlEsqlClusterStatus.md +++ b/docs/reference/api/EsqlEsqlClusterStatus.md @@ -1,4 +1,4 @@ -## `EsqlEsqlClusterStatus` -::: +# `EsqlEsqlClusterStatus` [alias-EsqlEsqlClusterStatus] +```typescript type EsqlEsqlClusterStatus = 'running' | 'successful' | 'partial' | 'skipped' | 'failed'; -::: +``` diff --git a/docs/reference/api/EsqlEsqlColumnInfo.md b/docs/reference/api/EsqlEsqlColumnInfo.md index 3c297d3a7..209be773d 100644 --- a/docs/reference/api/EsqlEsqlColumnInfo.md +++ b/docs/reference/api/EsqlEsqlColumnInfo.md @@ -1,4 +1,4 @@ -## Interface `EsqlEsqlColumnInfo` +# `EsqlEsqlColumnInfo` [interface-EsqlEsqlColumnInfo] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/EsqlEsqlFormat.md b/docs/reference/api/EsqlEsqlFormat.md index 3063399bf..de1412265 100644 --- a/docs/reference/api/EsqlEsqlFormat.md +++ b/docs/reference/api/EsqlEsqlFormat.md @@ -1,4 +1,4 @@ -## `EsqlEsqlFormat` -::: +# `EsqlEsqlFormat` [alias-EsqlEsqlFormat] +```typescript type EsqlEsqlFormat = 'csv' | 'json' | 'tsv' | 'txt' | 'yaml' | 'cbor' | 'smile' | 'arrow'; -::: +``` diff --git a/docs/reference/api/EsqlEsqlResult.md b/docs/reference/api/EsqlEsqlResult.md index 405371aee..b59feae2c 100644 --- a/docs/reference/api/EsqlEsqlResult.md +++ b/docs/reference/api/EsqlEsqlResult.md @@ -1,4 +1,4 @@ -## Interface `EsqlEsqlResult` +# `EsqlEsqlResult` [interface-EsqlEsqlResult] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/EsqlEsqlShardFailure.md b/docs/reference/api/EsqlEsqlShardFailure.md index 5785f3269..91bae0a72 100644 --- a/docs/reference/api/EsqlEsqlShardFailure.md +++ b/docs/reference/api/EsqlEsqlShardFailure.md @@ -1,4 +1,4 @@ -## Interface `EsqlEsqlShardFailure` +# `EsqlEsqlShardFailure` [interface-EsqlEsqlShardFailure] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/EsqlEsqlShardInfo.md b/docs/reference/api/EsqlEsqlShardInfo.md index de085e70a..84d8d5381 100644 --- a/docs/reference/api/EsqlEsqlShardInfo.md +++ b/docs/reference/api/EsqlEsqlShardInfo.md @@ -1,4 +1,4 @@ -## Interface `EsqlEsqlShardInfo` +# `EsqlEsqlShardInfo` [interface-EsqlEsqlShardInfo] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/EsqlGetQueryRequest.md b/docs/reference/api/EsqlGetQueryRequest.md index b09dee07b..b13bf6aff 100644 --- a/docs/reference/api/EsqlGetQueryRequest.md +++ b/docs/reference/api/EsqlGetQueryRequest.md @@ -1,4 +1,4 @@ -## Interface `EsqlGetQueryRequest` +# `EsqlGetQueryRequest` [interface-EsqlGetQueryRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/EsqlGetQueryResponse.md b/docs/reference/api/EsqlGetQueryResponse.md index 9f955f019..f5e94ec97 100644 --- a/docs/reference/api/EsqlGetQueryResponse.md +++ b/docs/reference/api/EsqlGetQueryResponse.md @@ -1,4 +1,4 @@ -## Interface `EsqlGetQueryResponse` +# `EsqlGetQueryResponse` [interface-EsqlGetQueryResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/EsqlHelper.md b/docs/reference/api/EsqlHelper.md index dbdeee413..c6e201503 100644 --- a/docs/reference/api/EsqlHelper.md +++ b/docs/reference/api/EsqlHelper.md @@ -1,4 +1,4 @@ -## Interface `EsqlHelper` +# `EsqlHelper` [interface-EsqlHelper] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/EsqlListQueriesBody.md b/docs/reference/api/EsqlListQueriesBody.md index 2dd051c65..a12d600b0 100644 --- a/docs/reference/api/EsqlListQueriesBody.md +++ b/docs/reference/api/EsqlListQueriesBody.md @@ -1,4 +1,4 @@ -## Interface `EsqlListQueriesBody` +# `EsqlListQueriesBody` [interface-EsqlListQueriesBody] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/EsqlListQueriesRequest.md b/docs/reference/api/EsqlListQueriesRequest.md index ead55e2c4..fba35a817 100644 --- a/docs/reference/api/EsqlListQueriesRequest.md +++ b/docs/reference/api/EsqlListQueriesRequest.md @@ -1,4 +1,4 @@ -## Interface `EsqlListQueriesRequest` +# `EsqlListQueriesRequest` [interface-EsqlListQueriesRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/EsqlListQueriesResponse.md b/docs/reference/api/EsqlListQueriesResponse.md index 07d24f59d..0ee83aa7a 100644 --- a/docs/reference/api/EsqlListQueriesResponse.md +++ b/docs/reference/api/EsqlListQueriesResponse.md @@ -1,4 +1,4 @@ -## Interface `EsqlListQueriesResponse` +# `EsqlListQueriesResponse` [interface-EsqlListQueriesResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/EsqlQueryRequest.md b/docs/reference/api/EsqlQueryRequest.md index b162062a5..7272e1ef8 100644 --- a/docs/reference/api/EsqlQueryRequest.md +++ b/docs/reference/api/EsqlQueryRequest.md @@ -1,4 +1,4 @@ -## Interface `EsqlQueryRequest` +# `EsqlQueryRequest` [interface-EsqlQueryRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/EsqlQueryResponse.md b/docs/reference/api/EsqlQueryResponse.md index 6f0edd5e9..6a535ca01 100644 --- a/docs/reference/api/EsqlQueryResponse.md +++ b/docs/reference/api/EsqlQueryResponse.md @@ -1,4 +1,4 @@ -## `EsqlQueryResponse` -::: +# `EsqlQueryResponse` [alias-EsqlQueryResponse] +```typescript type EsqlQueryResponse = [EsqlEsqlResult](./EsqlEsqlResult.md); -::: +``` diff --git a/docs/reference/api/EsqlTableValuesContainer.md b/docs/reference/api/EsqlTableValuesContainer.md index 0d528155e..e924f2623 100644 --- a/docs/reference/api/EsqlTableValuesContainer.md +++ b/docs/reference/api/EsqlTableValuesContainer.md @@ -1,4 +1,4 @@ -## Interface `EsqlTableValuesContainer` +# `EsqlTableValuesContainer` [interface-EsqlTableValuesContainer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/EsqlTableValuesIntegerValue.md b/docs/reference/api/EsqlTableValuesIntegerValue.md index b3b41d6c8..cebf18508 100644 --- a/docs/reference/api/EsqlTableValuesIntegerValue.md +++ b/docs/reference/api/EsqlTableValuesIntegerValue.md @@ -1,4 +1,4 @@ -## `EsqlTableValuesIntegerValue` -::: +# `EsqlTableValuesIntegerValue` [alias-EsqlTableValuesIntegerValue] +```typescript type EsqlTableValuesIntegerValue = [integer](./integer.md) | [integer](./integer.md)[]; -::: +``` diff --git a/docs/reference/api/EsqlTableValuesKeywordValue.md b/docs/reference/api/EsqlTableValuesKeywordValue.md index 34f54807a..6089044d8 100644 --- a/docs/reference/api/EsqlTableValuesKeywordValue.md +++ b/docs/reference/api/EsqlTableValuesKeywordValue.md @@ -1,4 +1,4 @@ -## `EsqlTableValuesKeywordValue` -::: +# `EsqlTableValuesKeywordValue` [alias-EsqlTableValuesKeywordValue] +```typescript type EsqlTableValuesKeywordValue = string | string[]; -::: +``` diff --git a/docs/reference/api/EsqlTableValuesLongDouble.md b/docs/reference/api/EsqlTableValuesLongDouble.md index a7fb608b4..661cd0bef 100644 --- a/docs/reference/api/EsqlTableValuesLongDouble.md +++ b/docs/reference/api/EsqlTableValuesLongDouble.md @@ -1,4 +1,4 @@ -## `EsqlTableValuesLongDouble` -::: +# `EsqlTableValuesLongDouble` [alias-EsqlTableValuesLongDouble] +```typescript type EsqlTableValuesLongDouble = [double](./double.md) | [double](./double.md)[]; -::: +``` diff --git a/docs/reference/api/EsqlTableValuesLongValue.md b/docs/reference/api/EsqlTableValuesLongValue.md index 032ac2cc0..f107e7cbf 100644 --- a/docs/reference/api/EsqlTableValuesLongValue.md +++ b/docs/reference/api/EsqlTableValuesLongValue.md @@ -1,4 +1,4 @@ -## `EsqlTableValuesLongValue` -::: +# `EsqlTableValuesLongValue` [alias-EsqlTableValuesLongValue] +```typescript type EsqlTableValuesLongValue = [long](./long.md) | [long](./long.md)[]; -::: +``` diff --git a/docs/reference/api/EsqlToRecords.md b/docs/reference/api/EsqlToRecords.md index 525be86d7..51fc17e6b 100644 --- a/docs/reference/api/EsqlToRecords.md +++ b/docs/reference/api/EsqlToRecords.md @@ -1,4 +1,4 @@ -## Interface `EsqlToRecords` +# `EsqlToRecords` [interface-EsqlToRecords] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ExistsApi_1.md b/docs/reference/api/ExistsApi_1.md index 2e26103b4..f9a2c769e 100644 --- a/docs/reference/api/ExistsApi_1.md +++ b/docs/reference/api/ExistsApi_1.md @@ -1,3 +1,3 @@ -::: +```typescript default function ExistsApi(this: [That](./That.md), params: [ExistsRequest](./ExistsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ExistsResponse](./ExistsResponse.md)>; -::: +``` diff --git a/docs/reference/api/ExistsApi_2.md b/docs/reference/api/ExistsApi_2.md index 8e7f26b45..3af64f7fa 100644 --- a/docs/reference/api/ExistsApi_2.md +++ b/docs/reference/api/ExistsApi_2.md @@ -1,3 +1,3 @@ -::: +```typescript default function ExistsApi(this: [That](./That.md), params: [ExistsRequest](./ExistsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ExistsResponse](./ExistsResponse.md), unknown>>; -::: +``` diff --git a/docs/reference/api/ExistsApi_3.md b/docs/reference/api/ExistsApi_3.md index 4787d0d5f..815800058 100644 --- a/docs/reference/api/ExistsApi_3.md +++ b/docs/reference/api/ExistsApi_3.md @@ -1,3 +1,3 @@ -::: +```typescript default function ExistsApi(this: [That](./That.md), params: [ExistsRequest](./ExistsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ExistsResponse](./ExistsResponse.md)>; -::: +``` diff --git a/docs/reference/api/ExistsRequest.md b/docs/reference/api/ExistsRequest.md index 6b274db71..a7b69ff0e 100644 --- a/docs/reference/api/ExistsRequest.md +++ b/docs/reference/api/ExistsRequest.md @@ -1,4 +1,4 @@ -## Interface `ExistsRequest` +# `ExistsRequest` [interface-ExistsRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ExistsResponse.md b/docs/reference/api/ExistsResponse.md index e562d8e90..a5e60252a 100644 --- a/docs/reference/api/ExistsResponse.md +++ b/docs/reference/api/ExistsResponse.md @@ -1,4 +1,4 @@ -## `ExistsResponse` -::: +# `ExistsResponse` [alias-ExistsResponse] +```typescript type ExistsResponse = boolean; -::: +``` diff --git a/docs/reference/api/ExistsSourceApi_1.md b/docs/reference/api/ExistsSourceApi_1.md index c05901cb5..6ff16b24e 100644 --- a/docs/reference/api/ExistsSourceApi_1.md +++ b/docs/reference/api/ExistsSourceApi_1.md @@ -1,3 +1,3 @@ -::: +```typescript default function ExistsSourceApi(this: [That](./That.md), params: [ExistsSourceRequest](./ExistsSourceRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ExistsSourceResponse](./ExistsSourceResponse.md)>; -::: +``` diff --git a/docs/reference/api/ExistsSourceApi_2.md b/docs/reference/api/ExistsSourceApi_2.md index 5e559cfcf..9c22d33ea 100644 --- a/docs/reference/api/ExistsSourceApi_2.md +++ b/docs/reference/api/ExistsSourceApi_2.md @@ -1,3 +1,3 @@ -::: +```typescript default function ExistsSourceApi(this: [That](./That.md), params: [ExistsSourceRequest](./ExistsSourceRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ExistsSourceResponse](./ExistsSourceResponse.md), unknown>>; -::: +``` diff --git a/docs/reference/api/ExistsSourceApi_3.md b/docs/reference/api/ExistsSourceApi_3.md index 478f15687..688259b09 100644 --- a/docs/reference/api/ExistsSourceApi_3.md +++ b/docs/reference/api/ExistsSourceApi_3.md @@ -1,3 +1,3 @@ -::: +```typescript default function ExistsSourceApi(this: [That](./That.md), params: [ExistsSourceRequest](./ExistsSourceRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ExistsSourceResponse](./ExistsSourceResponse.md)>; -::: +``` diff --git a/docs/reference/api/ExistsSourceRequest.md b/docs/reference/api/ExistsSourceRequest.md index 153f1a4bb..49ffcdac7 100644 --- a/docs/reference/api/ExistsSourceRequest.md +++ b/docs/reference/api/ExistsSourceRequest.md @@ -1,4 +1,4 @@ -## Interface `ExistsSourceRequest` +# `ExistsSourceRequest` [interface-ExistsSourceRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ExistsSourceResponse.md b/docs/reference/api/ExistsSourceResponse.md index 50cc7f675..7018d08c8 100644 --- a/docs/reference/api/ExistsSourceResponse.md +++ b/docs/reference/api/ExistsSourceResponse.md @@ -1,4 +1,4 @@ -## `ExistsSourceResponse` -::: +# `ExistsSourceResponse` [alias-ExistsSourceResponse] +```typescript type ExistsSourceResponse = boolean; -::: +``` diff --git a/docs/reference/api/ExpandWildcard.md b/docs/reference/api/ExpandWildcard.md index 4f70e66fe..1bfa7f34b 100644 --- a/docs/reference/api/ExpandWildcard.md +++ b/docs/reference/api/ExpandWildcard.md @@ -1,4 +1,4 @@ -## `ExpandWildcard` -::: +# `ExpandWildcard` [alias-ExpandWildcard] +```typescript type ExpandWildcard = 'all' | 'open' | 'closed' | 'hidden' | 'none'; -::: +``` diff --git a/docs/reference/api/ExpandWildcards.md b/docs/reference/api/ExpandWildcards.md index a6b8643bb..fde292ae3 100644 --- a/docs/reference/api/ExpandWildcards.md +++ b/docs/reference/api/ExpandWildcards.md @@ -1,4 +1,4 @@ -## `ExpandWildcards` -::: +# `ExpandWildcards` [alias-ExpandWildcards] +```typescript type ExpandWildcards = [ExpandWildcard](./ExpandWildcard.md) | [ExpandWildcard](./ExpandWildcard.md)[]; -::: +``` diff --git a/docs/reference/api/ExplainApi_1.md b/docs/reference/api/ExplainApi_1.md index 3ee44a0cc..21f38f2ca 100644 --- a/docs/reference/api/ExplainApi_1.md +++ b/docs/reference/api/ExplainApi_1.md @@ -1,3 +1,3 @@ -::: +```typescript default function ExplainApi(this: [That](./That.md), params: [ExplainRequest](./ExplainRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ExplainResponse](./ExplainResponse.md)>; -::: +``` diff --git a/docs/reference/api/ExplainApi_2.md b/docs/reference/api/ExplainApi_2.md index b4d3a00bd..e30b6c546 100644 --- a/docs/reference/api/ExplainApi_2.md +++ b/docs/reference/api/ExplainApi_2.md @@ -1,3 +1,3 @@ -::: +```typescript default function ExplainApi(this: [That](./That.md), params: [ExplainRequest](./ExplainRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ExplainResponse](./ExplainResponse.md), unknown>>; -::: +``` diff --git a/docs/reference/api/ExplainApi_3.md b/docs/reference/api/ExplainApi_3.md index fdb481510..8ba086793 100644 --- a/docs/reference/api/ExplainApi_3.md +++ b/docs/reference/api/ExplainApi_3.md @@ -1,3 +1,3 @@ -::: +```typescript default function ExplainApi(this: [That](./That.md), params: [ExplainRequest](./ExplainRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ExplainResponse](./ExplainResponse.md)>; -::: +``` diff --git a/docs/reference/api/ExplainExplanation.md b/docs/reference/api/ExplainExplanation.md index 43a4447ff..2c61fbb9d 100644 --- a/docs/reference/api/ExplainExplanation.md +++ b/docs/reference/api/ExplainExplanation.md @@ -1,4 +1,4 @@ -## Interface `ExplainExplanation` +# `ExplainExplanation` [interface-ExplainExplanation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ExplainExplanationDetail.md b/docs/reference/api/ExplainExplanationDetail.md index 6064a909e..ecb8a6b7a 100644 --- a/docs/reference/api/ExplainExplanationDetail.md +++ b/docs/reference/api/ExplainExplanationDetail.md @@ -1,4 +1,4 @@ -## Interface `ExplainExplanationDetail` +# `ExplainExplanationDetail` [interface-ExplainExplanationDetail] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ExplainRequest.md b/docs/reference/api/ExplainRequest.md index d5304a673..2e9bf568f 100644 --- a/docs/reference/api/ExplainRequest.md +++ b/docs/reference/api/ExplainRequest.md @@ -1,4 +1,4 @@ -## Interface `ExplainRequest` +# `ExplainRequest` [interface-ExplainRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ExplainResponse.md b/docs/reference/api/ExplainResponse.md index 3e72e7733..55426e8af 100644 --- a/docs/reference/api/ExplainResponse.md +++ b/docs/reference/api/ExplainResponse.md @@ -1,4 +1,4 @@ -## Interface `ExplainResponse` +# `ExplainResponse` [interface-ExplainResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/Features.md b/docs/reference/api/Features.md index 2a0018124..ee96d4efd 100644 --- a/docs/reference/api/Features.md +++ b/docs/reference/api/Features.md @@ -1,19 +1,19 @@ -## `Features` +# `Features` [class-Features] -### Constructor +## Constructor -::: +```typescript new Features(transport: [Transport](./Transport.md)); -::: +``` -### Properties +## Properties [class-properties-Features] | Name | Type | Description | | - | - | - | | `acceptedParams` | Record |   | | `transport` | [Transport](./Transport.md) |   | -### Methods +## Methods [class-methods-Features] | Name | Signature | Description | | - | - | - | diff --git a/docs/reference/api/FeaturesFeature.md b/docs/reference/api/FeaturesFeature.md index 664620cab..3fdf1380d 100644 --- a/docs/reference/api/FeaturesFeature.md +++ b/docs/reference/api/FeaturesFeature.md @@ -1,4 +1,4 @@ -## Interface `FeaturesFeature` +# `FeaturesFeature` [interface-FeaturesFeature] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/FeaturesGetFeaturesRequest.md b/docs/reference/api/FeaturesGetFeaturesRequest.md index 41758c574..6da290349 100644 --- a/docs/reference/api/FeaturesGetFeaturesRequest.md +++ b/docs/reference/api/FeaturesGetFeaturesRequest.md @@ -1,4 +1,4 @@ -## Interface `FeaturesGetFeaturesRequest` +# `FeaturesGetFeaturesRequest` [interface-FeaturesGetFeaturesRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/FeaturesGetFeaturesResponse.md b/docs/reference/api/FeaturesGetFeaturesResponse.md index fb2818038..2f124eadb 100644 --- a/docs/reference/api/FeaturesGetFeaturesResponse.md +++ b/docs/reference/api/FeaturesGetFeaturesResponse.md @@ -1,4 +1,4 @@ -## Interface `FeaturesGetFeaturesResponse` +# `FeaturesGetFeaturesResponse` [interface-FeaturesGetFeaturesResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/FeaturesResetFeaturesRequest.md b/docs/reference/api/FeaturesResetFeaturesRequest.md index ae24f8ee6..adb5aaf9d 100644 --- a/docs/reference/api/FeaturesResetFeaturesRequest.md +++ b/docs/reference/api/FeaturesResetFeaturesRequest.md @@ -1,4 +1,4 @@ -## Interface `FeaturesResetFeaturesRequest` +# `FeaturesResetFeaturesRequest` [interface-FeaturesResetFeaturesRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/FeaturesResetFeaturesResponse.md b/docs/reference/api/FeaturesResetFeaturesResponse.md index fd3154a47..5e56f3606 100644 --- a/docs/reference/api/FeaturesResetFeaturesResponse.md +++ b/docs/reference/api/FeaturesResetFeaturesResponse.md @@ -1,4 +1,4 @@ -## Interface `FeaturesResetFeaturesResponse` +# `FeaturesResetFeaturesResponse` [interface-FeaturesResetFeaturesResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/Field.md b/docs/reference/api/Field.md index e8caad181..56589b0ef 100644 --- a/docs/reference/api/Field.md +++ b/docs/reference/api/Field.md @@ -1,4 +1,4 @@ -## `Field` -::: +# `Field` [alias-Field] +```typescript type Field = string; -::: +``` diff --git a/docs/reference/api/FieldCapsApi_1.md b/docs/reference/api/FieldCapsApi_1.md index 96612ede2..b76aeeaef 100644 --- a/docs/reference/api/FieldCapsApi_1.md +++ b/docs/reference/api/FieldCapsApi_1.md @@ -1,3 +1,3 @@ -::: +```typescript default function FieldCapsApi(this: [That](./That.md), params?: [FieldCapsRequest](./FieldCapsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[FieldCapsResponse](./FieldCapsResponse.md)>; -::: +``` diff --git a/docs/reference/api/FieldCapsApi_2.md b/docs/reference/api/FieldCapsApi_2.md index 920dd26fd..eb9993a93 100644 --- a/docs/reference/api/FieldCapsApi_2.md +++ b/docs/reference/api/FieldCapsApi_2.md @@ -1,3 +1,3 @@ -::: +```typescript default function FieldCapsApi(this: [That](./That.md), params?: [FieldCapsRequest](./FieldCapsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[FieldCapsResponse](./FieldCapsResponse.md), unknown>>; -::: +``` diff --git a/docs/reference/api/FieldCapsApi_3.md b/docs/reference/api/FieldCapsApi_3.md index d5db849ce..297c82ce6 100644 --- a/docs/reference/api/FieldCapsApi_3.md +++ b/docs/reference/api/FieldCapsApi_3.md @@ -1,3 +1,3 @@ -::: +```typescript default function FieldCapsApi(this: [That](./That.md), params?: [FieldCapsRequest](./FieldCapsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[FieldCapsResponse](./FieldCapsResponse.md)>; -::: +``` diff --git a/docs/reference/api/FieldCapsFieldCapability.md b/docs/reference/api/FieldCapsFieldCapability.md index 3ed906542..9ae6bb31f 100644 --- a/docs/reference/api/FieldCapsFieldCapability.md +++ b/docs/reference/api/FieldCapsFieldCapability.md @@ -1,4 +1,4 @@ -## Interface `FieldCapsFieldCapability` +# `FieldCapsFieldCapability` [interface-FieldCapsFieldCapability] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/FieldCapsRequest.md b/docs/reference/api/FieldCapsRequest.md index 18e87357d..8747dbd28 100644 --- a/docs/reference/api/FieldCapsRequest.md +++ b/docs/reference/api/FieldCapsRequest.md @@ -1,4 +1,4 @@ -## Interface `FieldCapsRequest` +# `FieldCapsRequest` [interface-FieldCapsRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/FieldCapsResponse.md b/docs/reference/api/FieldCapsResponse.md index d69d57d91..0e0981e29 100644 --- a/docs/reference/api/FieldCapsResponse.md +++ b/docs/reference/api/FieldCapsResponse.md @@ -1,4 +1,4 @@ -## Interface `FieldCapsResponse` +# `FieldCapsResponse` [interface-FieldCapsResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/FieldMemoryUsage.md b/docs/reference/api/FieldMemoryUsage.md index 793afb78b..d5d6061f6 100644 --- a/docs/reference/api/FieldMemoryUsage.md +++ b/docs/reference/api/FieldMemoryUsage.md @@ -1,4 +1,4 @@ -## Interface `FieldMemoryUsage` +# `FieldMemoryUsage` [interface-FieldMemoryUsage] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/FieldSizeUsage.md b/docs/reference/api/FieldSizeUsage.md index a323072b5..57f6f3b3e 100644 --- a/docs/reference/api/FieldSizeUsage.md +++ b/docs/reference/api/FieldSizeUsage.md @@ -1,4 +1,4 @@ -## Interface `FieldSizeUsage` +# `FieldSizeUsage` [interface-FieldSizeUsage] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/FieldSort.md b/docs/reference/api/FieldSort.md index 9ee243d35..f3113490c 100644 --- a/docs/reference/api/FieldSort.md +++ b/docs/reference/api/FieldSort.md @@ -1,4 +1,4 @@ -## Interface `FieldSort` +# `FieldSort` [interface-FieldSort] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/FieldSortNumericType.md b/docs/reference/api/FieldSortNumericType.md index fedef0217..6529bcb0c 100644 --- a/docs/reference/api/FieldSortNumericType.md +++ b/docs/reference/api/FieldSortNumericType.md @@ -1,4 +1,4 @@ -## `FieldSortNumericType` -::: +# `FieldSortNumericType` [alias-FieldSortNumericType] +```typescript type FieldSortNumericType = 'long' | 'double' | 'date' | 'date_nanos'; -::: +``` diff --git a/docs/reference/api/FieldValue.md b/docs/reference/api/FieldValue.md index 83b13eea6..63fa28742 100644 --- a/docs/reference/api/FieldValue.md +++ b/docs/reference/api/FieldValue.md @@ -1,4 +1,4 @@ -## `FieldValue` -::: +# `FieldValue` [alias-FieldValue] +```typescript type FieldValue = [long](./long.md) | [double](./double.md) | string | boolean | null; -::: +``` diff --git a/docs/reference/api/FielddataStats.md b/docs/reference/api/FielddataStats.md index a97573440..b0fa1c1c1 100644 --- a/docs/reference/api/FielddataStats.md +++ b/docs/reference/api/FielddataStats.md @@ -1,4 +1,4 @@ -## Interface `FielddataStats` +# `FielddataStats` [interface-FielddataStats] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/Fields.md b/docs/reference/api/Fields.md index 1d7948357..6665947f1 100644 --- a/docs/reference/api/Fields.md +++ b/docs/reference/api/Fields.md @@ -1,4 +1,4 @@ -## `Fields` -::: +# `Fields` [alias-Fields] +```typescript type Fields = [Field](./Field.md) | [Field](./Field.md)[]; -::: +``` diff --git a/docs/reference/api/Fleet.md b/docs/reference/api/Fleet.md index 7d3039d14..774ea09bd 100644 --- a/docs/reference/api/Fleet.md +++ b/docs/reference/api/Fleet.md @@ -1,19 +1,19 @@ -## `Fleet` +# `Fleet` [class-Fleet] -### Constructor +## Constructor -::: +```typescript new Fleet(transport: [Transport](./Transport.md)); -::: +``` -### Properties +## Properties [class-properties-Fleet] | Name | Type | Description | | - | - | - | | `acceptedParams` | Record |   | | `transport` | [Transport](./Transport.md) |   | -### Methods +## Methods [class-methods-Fleet] | Name | Signature | Description | | - | - | - | diff --git a/docs/reference/api/FleetCheckpoint.md b/docs/reference/api/FleetCheckpoint.md index 7920af644..e9854ebc3 100644 --- a/docs/reference/api/FleetCheckpoint.md +++ b/docs/reference/api/FleetCheckpoint.md @@ -1,4 +1,4 @@ -## `FleetCheckpoint` -::: +# `FleetCheckpoint` [alias-FleetCheckpoint] +```typescript type FleetCheckpoint = [long](./long.md); -::: +``` diff --git a/docs/reference/api/FleetGlobalCheckpointsRequest.md b/docs/reference/api/FleetGlobalCheckpointsRequest.md index 397fc66dd..73921be9c 100644 --- a/docs/reference/api/FleetGlobalCheckpointsRequest.md +++ b/docs/reference/api/FleetGlobalCheckpointsRequest.md @@ -1,4 +1,4 @@ -## Interface `FleetGlobalCheckpointsRequest` +# `FleetGlobalCheckpointsRequest` [interface-FleetGlobalCheckpointsRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/FleetGlobalCheckpointsResponse.md b/docs/reference/api/FleetGlobalCheckpointsResponse.md index 5c21f0716..70364a5cd 100644 --- a/docs/reference/api/FleetGlobalCheckpointsResponse.md +++ b/docs/reference/api/FleetGlobalCheckpointsResponse.md @@ -1,4 +1,4 @@ -## Interface `FleetGlobalCheckpointsResponse` +# `FleetGlobalCheckpointsResponse` [interface-FleetGlobalCheckpointsResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/FleetMsearchRequest.md b/docs/reference/api/FleetMsearchRequest.md index b20160260..6f06d0b21 100644 --- a/docs/reference/api/FleetMsearchRequest.md +++ b/docs/reference/api/FleetMsearchRequest.md @@ -1,4 +1,4 @@ -## Interface `FleetMsearchRequest` +# `FleetMsearchRequest` [interface-FleetMsearchRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/FleetMsearchResponse.md b/docs/reference/api/FleetMsearchResponse.md index be53fe44d..2ea68e34a 100644 --- a/docs/reference/api/FleetMsearchResponse.md +++ b/docs/reference/api/FleetMsearchResponse.md @@ -1,4 +1,4 @@ -## Interface `FleetMsearchResponse` +# `FleetMsearchResponse` [interface-FleetMsearchResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/FleetSearchRequest.md b/docs/reference/api/FleetSearchRequest.md index b005d6cb4..57fb895cf 100644 --- a/docs/reference/api/FleetSearchRequest.md +++ b/docs/reference/api/FleetSearchRequest.md @@ -1,4 +1,4 @@ -## Interface `FleetSearchRequest` +# `FleetSearchRequest` [interface-FleetSearchRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/FleetSearchResponse.md b/docs/reference/api/FleetSearchResponse.md index f05615b81..15a8463f1 100644 --- a/docs/reference/api/FleetSearchResponse.md +++ b/docs/reference/api/FleetSearchResponse.md @@ -1,4 +1,4 @@ -## Interface `FleetSearchResponse` +# `FleetSearchResponse` [interface-FleetSearchResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/FlushStats.md b/docs/reference/api/FlushStats.md index a42f102d7..67313edcb 100644 --- a/docs/reference/api/FlushStats.md +++ b/docs/reference/api/FlushStats.md @@ -1,4 +1,4 @@ -## Interface `FlushStats` +# `FlushStats` [interface-FlushStats] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/Fuzziness.md b/docs/reference/api/Fuzziness.md index 588ad12f5..58b6826c8 100644 --- a/docs/reference/api/Fuzziness.md +++ b/docs/reference/api/Fuzziness.md @@ -1,4 +1,4 @@ -## `Fuzziness` -::: +# `Fuzziness` [alias-Fuzziness] +```typescript type Fuzziness = string | [integer](./integer.md); -::: +``` diff --git a/docs/reference/api/GeoBounds.md b/docs/reference/api/GeoBounds.md index bfb1ba12d..fae8a8021 100644 --- a/docs/reference/api/GeoBounds.md +++ b/docs/reference/api/GeoBounds.md @@ -1,4 +1,4 @@ -## `GeoBounds` -::: +# `GeoBounds` [alias-GeoBounds] +```typescript type GeoBounds = [CoordsGeoBounds](./CoordsGeoBounds.md) | [TopLeftBottomRightGeoBounds](./TopLeftBottomRightGeoBounds.md) | [TopRightBottomLeftGeoBounds](./TopRightBottomLeftGeoBounds.md) | [WktGeoBounds](./WktGeoBounds.md); -::: +``` diff --git a/docs/reference/api/GeoDistanceSort.md b/docs/reference/api/GeoDistanceSort.md index 5b3633684..196552ab3 100644 --- a/docs/reference/api/GeoDistanceSort.md +++ b/docs/reference/api/GeoDistanceSort.md @@ -1,4 +1,4 @@ -## `GeoDistanceSort` -::: +# `GeoDistanceSort` [alias-GeoDistanceSort] +```typescript type GeoDistanceSort = [GeoDistanceSortKeys](./GeoDistanceSortKeys.md) & { [property: string]: [GeoLocation](./GeoLocation.md) | [GeoLocation](./GeoLocation.md)[] | [SortMode](./SortMode.md) | [GeoDistanceType](./GeoDistanceType.md) | boolean | [SortOrder](./SortOrder.md) | [DistanceUnit](./DistanceUnit.md) | [NestedSortValue](./NestedSortValue.md);}; -::: +``` diff --git a/docs/reference/api/GeoDistanceSortKeys.md b/docs/reference/api/GeoDistanceSortKeys.md index 17355b8d1..974dfe70e 100644 --- a/docs/reference/api/GeoDistanceSortKeys.md +++ b/docs/reference/api/GeoDistanceSortKeys.md @@ -1,4 +1,4 @@ -## Interface `GeoDistanceSortKeys` +# `GeoDistanceSortKeys` [interface-GeoDistanceSortKeys] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/GeoDistanceType.md b/docs/reference/api/GeoDistanceType.md index 0678f12fa..e0392d4c5 100644 --- a/docs/reference/api/GeoDistanceType.md +++ b/docs/reference/api/GeoDistanceType.md @@ -1,4 +1,4 @@ -## `GeoDistanceType` -::: +# `GeoDistanceType` [alias-GeoDistanceType] +```typescript type GeoDistanceType = 'arc' | 'plane'; -::: +``` diff --git a/docs/reference/api/GeoHash.md b/docs/reference/api/GeoHash.md index a7e411e19..4bf4a6ef2 100644 --- a/docs/reference/api/GeoHash.md +++ b/docs/reference/api/GeoHash.md @@ -1,4 +1,4 @@ -## `GeoHash` -::: +# `GeoHash` [alias-GeoHash] +```typescript type GeoHash = string; -::: +``` diff --git a/docs/reference/api/GeoHashLocation.md b/docs/reference/api/GeoHashLocation.md index 07b1a66ca..c4803102e 100644 --- a/docs/reference/api/GeoHashLocation.md +++ b/docs/reference/api/GeoHashLocation.md @@ -1,4 +1,4 @@ -## Interface `GeoHashLocation` +# `GeoHashLocation` [interface-GeoHashLocation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/GeoHashPrecision.md b/docs/reference/api/GeoHashPrecision.md index 3f21eba22..086ccd9ad 100644 --- a/docs/reference/api/GeoHashPrecision.md +++ b/docs/reference/api/GeoHashPrecision.md @@ -1,4 +1,4 @@ -## `GeoHashPrecision` -::: +# `GeoHashPrecision` [alias-GeoHashPrecision] +```typescript type GeoHashPrecision = number | string; -::: +``` diff --git a/docs/reference/api/GeoHexCell.md b/docs/reference/api/GeoHexCell.md index e61ee4029..006c73840 100644 --- a/docs/reference/api/GeoHexCell.md +++ b/docs/reference/api/GeoHexCell.md @@ -1,4 +1,4 @@ -## `GeoHexCell` -::: +# `GeoHexCell` [alias-GeoHexCell] +```typescript type GeoHexCell = string; -::: +``` diff --git a/docs/reference/api/GeoLine.md b/docs/reference/api/GeoLine.md index a577baa7a..214fc47c8 100644 --- a/docs/reference/api/GeoLine.md +++ b/docs/reference/api/GeoLine.md @@ -1,4 +1,4 @@ -## Interface `GeoLine` +# `GeoLine` [interface-GeoLine] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/GeoLocation.md b/docs/reference/api/GeoLocation.md index cdeaf7d8a..5546ed4bb 100644 --- a/docs/reference/api/GeoLocation.md +++ b/docs/reference/api/GeoLocation.md @@ -1,4 +1,4 @@ -## `GeoLocation` -::: +# `GeoLocation` [alias-GeoLocation] +```typescript type GeoLocation = [LatLonGeoLocation](./LatLonGeoLocation.md) | [GeoHashLocation](./GeoHashLocation.md) | [double](./double.md)[] | string; -::: +``` diff --git a/docs/reference/api/GeoShape.md b/docs/reference/api/GeoShape.md index 27ecaab90..238490908 100644 --- a/docs/reference/api/GeoShape.md +++ b/docs/reference/api/GeoShape.md @@ -1,4 +1,4 @@ -## `GeoShape` -::: +# `GeoShape` [alias-GeoShape] +```typescript type GeoShape = any; -::: +``` diff --git a/docs/reference/api/GeoShapeRelation.md b/docs/reference/api/GeoShapeRelation.md index c745b446f..522d1088d 100644 --- a/docs/reference/api/GeoShapeRelation.md +++ b/docs/reference/api/GeoShapeRelation.md @@ -1,4 +1,4 @@ -## `GeoShapeRelation` -::: +# `GeoShapeRelation` [alias-GeoShapeRelation] +```typescript type GeoShapeRelation = 'intersects' | 'disjoint' | 'within' | 'contains'; -::: +``` diff --git a/docs/reference/api/GeoTile.md b/docs/reference/api/GeoTile.md index f47e5f1b2..0a781756d 100644 --- a/docs/reference/api/GeoTile.md +++ b/docs/reference/api/GeoTile.md @@ -1,4 +1,4 @@ -## `GeoTile` -::: +# `GeoTile` [alias-GeoTile] +```typescript type GeoTile = string; -::: +``` diff --git a/docs/reference/api/GeoTilePrecision.md b/docs/reference/api/GeoTilePrecision.md index 413d38bdd..f96137c55 100644 --- a/docs/reference/api/GeoTilePrecision.md +++ b/docs/reference/api/GeoTilePrecision.md @@ -1,4 +1,4 @@ -## `GeoTilePrecision` -::: +# `GeoTilePrecision` [alias-GeoTilePrecision] +```typescript type GeoTilePrecision = number; -::: +``` diff --git a/docs/reference/api/GetApi_1.md b/docs/reference/api/GetApi_1.md index 69d20b083..6fd6d622e 100644 --- a/docs/reference/api/GetApi_1.md +++ b/docs/reference/api/GetApi_1.md @@ -1,3 +1,3 @@ -::: +```typescript default function GetApi(this: [That](./That.md), params: [GetRequest](./GetRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[GetResponse](./GetResponse.md)>; -::: +``` diff --git a/docs/reference/api/GetApi_2.md b/docs/reference/api/GetApi_2.md index b3ee00f3c..2bf0c4ef8 100644 --- a/docs/reference/api/GetApi_2.md +++ b/docs/reference/api/GetApi_2.md @@ -1,3 +1,3 @@ -::: +```typescript default function GetApi(this: [That](./That.md), params: [GetRequest](./GetRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[GetResponse](./GetResponse.md), unknown>>; -::: +``` diff --git a/docs/reference/api/GetApi_3.md b/docs/reference/api/GetApi_3.md index 99c831157..1f9c4e9fa 100644 --- a/docs/reference/api/GetApi_3.md +++ b/docs/reference/api/GetApi_3.md @@ -1,3 +1,3 @@ -::: +```typescript default function GetApi(this: [That](./That.md), params: [GetRequest](./GetRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[GetResponse](./GetResponse.md)>; -::: +``` diff --git a/docs/reference/api/GetGetResult.md b/docs/reference/api/GetGetResult.md index 7f31f7a4f..6baa548ca 100644 --- a/docs/reference/api/GetGetResult.md +++ b/docs/reference/api/GetGetResult.md @@ -1,4 +1,4 @@ -## Interface `GetGetResult` +# `GetGetResult` [interface-GetGetResult] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/GetRequest.md b/docs/reference/api/GetRequest.md index 33ff7dbde..6f91e5406 100644 --- a/docs/reference/api/GetRequest.md +++ b/docs/reference/api/GetRequest.md @@ -1,4 +1,4 @@ -## Interface `GetRequest` +# `GetRequest` [interface-GetRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/GetResponse.md b/docs/reference/api/GetResponse.md index 52d889fc9..4e46cea7c 100644 --- a/docs/reference/api/GetResponse.md +++ b/docs/reference/api/GetResponse.md @@ -1,4 +1,4 @@ -## `GetResponse` -::: +# `GetResponse` [alias-GetResponse] +```typescript type GetResponse = [GetGetResult](./GetGetResult.md); -::: +``` diff --git a/docs/reference/api/GetScriptApi_1.md b/docs/reference/api/GetScriptApi_1.md index 35666903d..c64b594f2 100644 --- a/docs/reference/api/GetScriptApi_1.md +++ b/docs/reference/api/GetScriptApi_1.md @@ -1,3 +1,3 @@ -::: +```typescript default function GetScriptApi(this: [That](./That.md), params: [GetScriptRequest](./GetScriptRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[GetScriptResponse](./GetScriptResponse.md)>; -::: +``` diff --git a/docs/reference/api/GetScriptApi_2.md b/docs/reference/api/GetScriptApi_2.md index cd4bad5d1..fe4867caf 100644 --- a/docs/reference/api/GetScriptApi_2.md +++ b/docs/reference/api/GetScriptApi_2.md @@ -1,3 +1,3 @@ -::: +```typescript default function GetScriptApi(this: [That](./That.md), params: [GetScriptRequest](./GetScriptRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[GetScriptResponse](./GetScriptResponse.md), unknown>>; -::: +``` diff --git a/docs/reference/api/GetScriptApi_3.md b/docs/reference/api/GetScriptApi_3.md index 52279c45b..627185b68 100644 --- a/docs/reference/api/GetScriptApi_3.md +++ b/docs/reference/api/GetScriptApi_3.md @@ -1,3 +1,3 @@ -::: +```typescript default function GetScriptApi(this: [That](./That.md), params: [GetScriptRequest](./GetScriptRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[GetScriptResponse](./GetScriptResponse.md)>; -::: +``` diff --git a/docs/reference/api/GetScriptContextApi_1.md b/docs/reference/api/GetScriptContextApi_1.md index 936b6c1b0..40a721660 100644 --- a/docs/reference/api/GetScriptContextApi_1.md +++ b/docs/reference/api/GetScriptContextApi_1.md @@ -1,3 +1,3 @@ -::: +```typescript default function GetScriptContextApi(this: [That](./That.md), params?: [GetScriptContextRequest](./GetScriptContextRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[GetScriptContextResponse](./GetScriptContextResponse.md)>; -::: +``` diff --git a/docs/reference/api/GetScriptContextApi_2.md b/docs/reference/api/GetScriptContextApi_2.md index bbb7ec450..18f3125a8 100644 --- a/docs/reference/api/GetScriptContextApi_2.md +++ b/docs/reference/api/GetScriptContextApi_2.md @@ -1,3 +1,3 @@ -::: +```typescript default function GetScriptContextApi(this: [That](./That.md), params?: [GetScriptContextRequest](./GetScriptContextRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[GetScriptContextResponse](./GetScriptContextResponse.md), unknown>>; -::: +``` diff --git a/docs/reference/api/GetScriptContextApi_3.md b/docs/reference/api/GetScriptContextApi_3.md index d662b6aa1..c891a8508 100644 --- a/docs/reference/api/GetScriptContextApi_3.md +++ b/docs/reference/api/GetScriptContextApi_3.md @@ -1,3 +1,3 @@ -::: +```typescript default function GetScriptContextApi(this: [That](./That.md), params?: [GetScriptContextRequest](./GetScriptContextRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[GetScriptContextResponse](./GetScriptContextResponse.md)>; -::: +``` diff --git a/docs/reference/api/GetScriptContextContext.md b/docs/reference/api/GetScriptContextContext.md index 442e4c740..63d90c10e 100644 --- a/docs/reference/api/GetScriptContextContext.md +++ b/docs/reference/api/GetScriptContextContext.md @@ -1,4 +1,4 @@ -## Interface `GetScriptContextContext` +# `GetScriptContextContext` [interface-GetScriptContextContext] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/GetScriptContextContextMethod.md b/docs/reference/api/GetScriptContextContextMethod.md index 51548e285..044aa7e6c 100644 --- a/docs/reference/api/GetScriptContextContextMethod.md +++ b/docs/reference/api/GetScriptContextContextMethod.md @@ -1,4 +1,4 @@ -## Interface `GetScriptContextContextMethod` +# `GetScriptContextContextMethod` [interface-GetScriptContextContextMethod] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/GetScriptContextContextMethodParam.md b/docs/reference/api/GetScriptContextContextMethodParam.md index 90d7cbb71..8f3f95657 100644 --- a/docs/reference/api/GetScriptContextContextMethodParam.md +++ b/docs/reference/api/GetScriptContextContextMethodParam.md @@ -1,4 +1,4 @@ -## Interface `GetScriptContextContextMethodParam` +# `GetScriptContextContextMethodParam` [interface-GetScriptContextContextMethodParam] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/GetScriptContextRequest.md b/docs/reference/api/GetScriptContextRequest.md index 19f92a3c3..f2b6a7376 100644 --- a/docs/reference/api/GetScriptContextRequest.md +++ b/docs/reference/api/GetScriptContextRequest.md @@ -1,4 +1,4 @@ -## Interface `GetScriptContextRequest` +# `GetScriptContextRequest` [interface-GetScriptContextRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/GetScriptContextResponse.md b/docs/reference/api/GetScriptContextResponse.md index 2c856681c..c731b4a28 100644 --- a/docs/reference/api/GetScriptContextResponse.md +++ b/docs/reference/api/GetScriptContextResponse.md @@ -1,4 +1,4 @@ -## Interface `GetScriptContextResponse` +# `GetScriptContextResponse` [interface-GetScriptContextResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/GetScriptLanguagesApi_1.md b/docs/reference/api/GetScriptLanguagesApi_1.md index 4195f1a2d..5d284ce9e 100644 --- a/docs/reference/api/GetScriptLanguagesApi_1.md +++ b/docs/reference/api/GetScriptLanguagesApi_1.md @@ -1,3 +1,3 @@ -::: +```typescript default function GetScriptLanguagesApi(this: [That](./That.md), params?: [GetScriptLanguagesRequest](./GetScriptLanguagesRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[GetScriptLanguagesResponse](./GetScriptLanguagesResponse.md)>; -::: +``` diff --git a/docs/reference/api/GetScriptLanguagesApi_2.md b/docs/reference/api/GetScriptLanguagesApi_2.md index 6c62c49f4..5cbcbecd9 100644 --- a/docs/reference/api/GetScriptLanguagesApi_2.md +++ b/docs/reference/api/GetScriptLanguagesApi_2.md @@ -1,3 +1,3 @@ -::: +```typescript default function GetScriptLanguagesApi(this: [That](./That.md), params?: [GetScriptLanguagesRequest](./GetScriptLanguagesRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[GetScriptLanguagesResponse](./GetScriptLanguagesResponse.md), unknown>>; -::: +``` diff --git a/docs/reference/api/GetScriptLanguagesApi_3.md b/docs/reference/api/GetScriptLanguagesApi_3.md index b544b5f64..c6145ec3d 100644 --- a/docs/reference/api/GetScriptLanguagesApi_3.md +++ b/docs/reference/api/GetScriptLanguagesApi_3.md @@ -1,3 +1,3 @@ -::: +```typescript default function GetScriptLanguagesApi(this: [That](./That.md), params?: [GetScriptLanguagesRequest](./GetScriptLanguagesRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[GetScriptLanguagesResponse](./GetScriptLanguagesResponse.md)>; -::: +``` diff --git a/docs/reference/api/GetScriptLanguagesLanguageContext.md b/docs/reference/api/GetScriptLanguagesLanguageContext.md index d095387ef..601c5761d 100644 --- a/docs/reference/api/GetScriptLanguagesLanguageContext.md +++ b/docs/reference/api/GetScriptLanguagesLanguageContext.md @@ -1,4 +1,4 @@ -## Interface `GetScriptLanguagesLanguageContext` +# `GetScriptLanguagesLanguageContext` [interface-GetScriptLanguagesLanguageContext] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/GetScriptLanguagesRequest.md b/docs/reference/api/GetScriptLanguagesRequest.md index be4274289..365aa3283 100644 --- a/docs/reference/api/GetScriptLanguagesRequest.md +++ b/docs/reference/api/GetScriptLanguagesRequest.md @@ -1,4 +1,4 @@ -## Interface `GetScriptLanguagesRequest` +# `GetScriptLanguagesRequest` [interface-GetScriptLanguagesRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/GetScriptLanguagesResponse.md b/docs/reference/api/GetScriptLanguagesResponse.md index dc9cd60c7..4d4bf2b5a 100644 --- a/docs/reference/api/GetScriptLanguagesResponse.md +++ b/docs/reference/api/GetScriptLanguagesResponse.md @@ -1,4 +1,4 @@ -## Interface `GetScriptLanguagesResponse` +# `GetScriptLanguagesResponse` [interface-GetScriptLanguagesResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/GetScriptRequest.md b/docs/reference/api/GetScriptRequest.md index 1a800538d..2ddb245cc 100644 --- a/docs/reference/api/GetScriptRequest.md +++ b/docs/reference/api/GetScriptRequest.md @@ -1,4 +1,4 @@ -## Interface `GetScriptRequest` +# `GetScriptRequest` [interface-GetScriptRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/GetScriptResponse.md b/docs/reference/api/GetScriptResponse.md index 39aa9825f..c6a3239a7 100644 --- a/docs/reference/api/GetScriptResponse.md +++ b/docs/reference/api/GetScriptResponse.md @@ -1,4 +1,4 @@ -## Interface `GetScriptResponse` +# `GetScriptResponse` [interface-GetScriptResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/GetSourceApi_1.md b/docs/reference/api/GetSourceApi_1.md index e2446711c..d44b2380c 100644 --- a/docs/reference/api/GetSourceApi_1.md +++ b/docs/reference/api/GetSourceApi_1.md @@ -1,3 +1,3 @@ -::: +```typescript default function GetSourceApi(this: [That](./That.md), params: [GetSourceRequest](./GetSourceRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[GetSourceResponse](./GetSourceResponse.md)>; -::: +``` diff --git a/docs/reference/api/GetSourceApi_2.md b/docs/reference/api/GetSourceApi_2.md index afd005bb6..3f31ca516 100644 --- a/docs/reference/api/GetSourceApi_2.md +++ b/docs/reference/api/GetSourceApi_2.md @@ -1,3 +1,3 @@ -::: +```typescript default function GetSourceApi(this: [That](./That.md), params: [GetSourceRequest](./GetSourceRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[GetSourceResponse](./GetSourceResponse.md), unknown>>; -::: +``` diff --git a/docs/reference/api/GetSourceApi_3.md b/docs/reference/api/GetSourceApi_3.md index 8e1de9878..a3ca38c12 100644 --- a/docs/reference/api/GetSourceApi_3.md +++ b/docs/reference/api/GetSourceApi_3.md @@ -1,3 +1,3 @@ -::: +```typescript default function GetSourceApi(this: [That](./That.md), params: [GetSourceRequest](./GetSourceRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[GetSourceResponse](./GetSourceResponse.md)>; -::: +``` diff --git a/docs/reference/api/GetSourceRequest.md b/docs/reference/api/GetSourceRequest.md index 6f91363e7..24a7630e3 100644 --- a/docs/reference/api/GetSourceRequest.md +++ b/docs/reference/api/GetSourceRequest.md @@ -1,4 +1,4 @@ -## Interface `GetSourceRequest` +# `GetSourceRequest` [interface-GetSourceRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/GetSourceResponse.md b/docs/reference/api/GetSourceResponse.md index c8483ae61..e405cb167 100644 --- a/docs/reference/api/GetSourceResponse.md +++ b/docs/reference/api/GetSourceResponse.md @@ -1,4 +1,4 @@ -## `GetSourceResponse` -::: +# `GetSourceResponse` [alias-GetSourceResponse] +```typescript type GetSourceResponse = TDocument; -::: +``` diff --git a/docs/reference/api/GetStats.md b/docs/reference/api/GetStats.md index 25315aaec..768fbd204 100644 --- a/docs/reference/api/GetStats.md +++ b/docs/reference/api/GetStats.md @@ -1,4 +1,4 @@ -## Interface `GetStats` +# `GetStats` [interface-GetStats] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/Graph.md b/docs/reference/api/Graph.md index 2b86d64af..e3a8267a9 100644 --- a/docs/reference/api/Graph.md +++ b/docs/reference/api/Graph.md @@ -1,19 +1,19 @@ -## `Graph` +# `Graph` [class-Graph] -### Constructor +## Constructor -::: +```typescript new Graph(transport: [Transport](./Transport.md)); -::: +``` -### Properties +## Properties [class-properties-Graph] | Name | Type | Description | | - | - | - | | `acceptedParams` | Record |   | | `transport` | [Transport](./Transport.md) |   | -### Methods +## Methods [class-methods-Graph] | Name | Signature | Description | | - | - | - | diff --git a/docs/reference/api/GraphConnection.md b/docs/reference/api/GraphConnection.md index 9a39f0f8b..9c0b9fcd5 100644 --- a/docs/reference/api/GraphConnection.md +++ b/docs/reference/api/GraphConnection.md @@ -1,4 +1,4 @@ -## Interface `GraphConnection` +# `GraphConnection` [interface-GraphConnection] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/GraphExploreControls.md b/docs/reference/api/GraphExploreControls.md index 9bfe85cb7..beaeb2c41 100644 --- a/docs/reference/api/GraphExploreControls.md +++ b/docs/reference/api/GraphExploreControls.md @@ -1,4 +1,4 @@ -## Interface `GraphExploreControls` +# `GraphExploreControls` [interface-GraphExploreControls] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/GraphExploreRequest.md b/docs/reference/api/GraphExploreRequest.md index 470a64f8e..ca017f400 100644 --- a/docs/reference/api/GraphExploreRequest.md +++ b/docs/reference/api/GraphExploreRequest.md @@ -1,4 +1,4 @@ -## Interface `GraphExploreRequest` +# `GraphExploreRequest` [interface-GraphExploreRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/GraphExploreResponse.md b/docs/reference/api/GraphExploreResponse.md index b4841d63b..aa78a0ab0 100644 --- a/docs/reference/api/GraphExploreResponse.md +++ b/docs/reference/api/GraphExploreResponse.md @@ -1,4 +1,4 @@ -## Interface `GraphExploreResponse` +# `GraphExploreResponse` [interface-GraphExploreResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/GraphHop.md b/docs/reference/api/GraphHop.md index d4a411473..048f6c426 100644 --- a/docs/reference/api/GraphHop.md +++ b/docs/reference/api/GraphHop.md @@ -1,4 +1,4 @@ -## Interface `GraphHop` +# `GraphHop` [interface-GraphHop] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/GraphSampleDiversity.md b/docs/reference/api/GraphSampleDiversity.md index b2925007b..3cb5112ca 100644 --- a/docs/reference/api/GraphSampleDiversity.md +++ b/docs/reference/api/GraphSampleDiversity.md @@ -1,4 +1,4 @@ -## Interface `GraphSampleDiversity` +# `GraphSampleDiversity` [interface-GraphSampleDiversity] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/GraphVertex.md b/docs/reference/api/GraphVertex.md index 052cf3ec4..8997d2978 100644 --- a/docs/reference/api/GraphVertex.md +++ b/docs/reference/api/GraphVertex.md @@ -1,4 +1,4 @@ -## Interface `GraphVertex` +# `GraphVertex` [interface-GraphVertex] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/GraphVertexDefinition.md b/docs/reference/api/GraphVertexDefinition.md index a8a445fa1..951523251 100644 --- a/docs/reference/api/GraphVertexDefinition.md +++ b/docs/reference/api/GraphVertexDefinition.md @@ -1,4 +1,4 @@ -## Interface `GraphVertexDefinition` +# `GraphVertexDefinition` [interface-GraphVertexDefinition] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/GraphVertexInclude.md b/docs/reference/api/GraphVertexInclude.md index 23fedcf04..356db9c39 100644 --- a/docs/reference/api/GraphVertexInclude.md +++ b/docs/reference/api/GraphVertexInclude.md @@ -1,4 +1,4 @@ -## Interface `GraphVertexInclude` +# `GraphVertexInclude` [interface-GraphVertexInclude] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/GrokPattern.md b/docs/reference/api/GrokPattern.md index 4d4372e3d..6d84848dd 100644 --- a/docs/reference/api/GrokPattern.md +++ b/docs/reference/api/GrokPattern.md @@ -1,4 +1,4 @@ -## `GrokPattern` -::: +# `GrokPattern` [alias-GrokPattern] +```typescript type GrokPattern = string; -::: +``` diff --git a/docs/reference/api/HealthReportApi_1.md b/docs/reference/api/HealthReportApi_1.md index 8a6d04c53..62e9d2dce 100644 --- a/docs/reference/api/HealthReportApi_1.md +++ b/docs/reference/api/HealthReportApi_1.md @@ -1,3 +1,3 @@ -::: +```typescript default function HealthReportApi(this: [That](./That.md), params?: [HealthReportRequest](./HealthReportRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[HealthReportResponse](./HealthReportResponse.md)>; -::: +``` diff --git a/docs/reference/api/HealthReportApi_2.md b/docs/reference/api/HealthReportApi_2.md index 0cf714790..b93b7bee2 100644 --- a/docs/reference/api/HealthReportApi_2.md +++ b/docs/reference/api/HealthReportApi_2.md @@ -1,3 +1,3 @@ -::: +```typescript default function HealthReportApi(this: [That](./That.md), params?: [HealthReportRequest](./HealthReportRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[HealthReportResponse](./HealthReportResponse.md), unknown>>; -::: +``` diff --git a/docs/reference/api/HealthReportApi_3.md b/docs/reference/api/HealthReportApi_3.md index 2feb8c759..894d59679 100644 --- a/docs/reference/api/HealthReportApi_3.md +++ b/docs/reference/api/HealthReportApi_3.md @@ -1,3 +1,3 @@ -::: +```typescript default function HealthReportApi(this: [That](./That.md), params?: [HealthReportRequest](./HealthReportRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[HealthReportResponse](./HealthReportResponse.md)>; -::: +``` diff --git a/docs/reference/api/HealthReportBaseIndicator.md b/docs/reference/api/HealthReportBaseIndicator.md index b26cdc79d..ca048a075 100644 --- a/docs/reference/api/HealthReportBaseIndicator.md +++ b/docs/reference/api/HealthReportBaseIndicator.md @@ -1,4 +1,4 @@ -## Interface `HealthReportBaseIndicator` +# `HealthReportBaseIndicator` [interface-HealthReportBaseIndicator] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/HealthReportDataStreamLifecycleDetails.md b/docs/reference/api/HealthReportDataStreamLifecycleDetails.md index 83f02460b..0c21a8f0b 100644 --- a/docs/reference/api/HealthReportDataStreamLifecycleDetails.md +++ b/docs/reference/api/HealthReportDataStreamLifecycleDetails.md @@ -1,4 +1,4 @@ -## Interface `HealthReportDataStreamLifecycleDetails` +# `HealthReportDataStreamLifecycleDetails` [interface-HealthReportDataStreamLifecycleDetails] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/HealthReportDataStreamLifecycleIndicator.md b/docs/reference/api/HealthReportDataStreamLifecycleIndicator.md index 816b90248..43522ae20 100644 --- a/docs/reference/api/HealthReportDataStreamLifecycleIndicator.md +++ b/docs/reference/api/HealthReportDataStreamLifecycleIndicator.md @@ -1,4 +1,4 @@ -## Interface `HealthReportDataStreamLifecycleIndicator` +# `HealthReportDataStreamLifecycleIndicator` [interface-HealthReportDataStreamLifecycleIndicator] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/HealthReportDiagnosis.md b/docs/reference/api/HealthReportDiagnosis.md index f3781003a..7282f5a23 100644 --- a/docs/reference/api/HealthReportDiagnosis.md +++ b/docs/reference/api/HealthReportDiagnosis.md @@ -1,4 +1,4 @@ -## Interface `HealthReportDiagnosis` +# `HealthReportDiagnosis` [interface-HealthReportDiagnosis] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/HealthReportDiagnosisAffectedResources.md b/docs/reference/api/HealthReportDiagnosisAffectedResources.md index 937c01513..51eb5d4ea 100644 --- a/docs/reference/api/HealthReportDiagnosisAffectedResources.md +++ b/docs/reference/api/HealthReportDiagnosisAffectedResources.md @@ -1,4 +1,4 @@ -## Interface `HealthReportDiagnosisAffectedResources` +# `HealthReportDiagnosisAffectedResources` [interface-HealthReportDiagnosisAffectedResources] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/HealthReportDiskIndicator.md b/docs/reference/api/HealthReportDiskIndicator.md index 78751bf6d..18c46d15b 100644 --- a/docs/reference/api/HealthReportDiskIndicator.md +++ b/docs/reference/api/HealthReportDiskIndicator.md @@ -1,4 +1,4 @@ -## Interface `HealthReportDiskIndicator` +# `HealthReportDiskIndicator` [interface-HealthReportDiskIndicator] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/HealthReportDiskIndicatorDetails.md b/docs/reference/api/HealthReportDiskIndicatorDetails.md index e9aa0d896..711d6fc92 100644 --- a/docs/reference/api/HealthReportDiskIndicatorDetails.md +++ b/docs/reference/api/HealthReportDiskIndicatorDetails.md @@ -1,4 +1,4 @@ -## Interface `HealthReportDiskIndicatorDetails` +# `HealthReportDiskIndicatorDetails` [interface-HealthReportDiskIndicatorDetails] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/HealthReportFileSettingsIndicator.md b/docs/reference/api/HealthReportFileSettingsIndicator.md index 0c1bd1be0..f0c6b36a3 100644 --- a/docs/reference/api/HealthReportFileSettingsIndicator.md +++ b/docs/reference/api/HealthReportFileSettingsIndicator.md @@ -1,4 +1,4 @@ -## Interface `HealthReportFileSettingsIndicator` +# `HealthReportFileSettingsIndicator` [interface-HealthReportFileSettingsIndicator] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/HealthReportFileSettingsIndicatorDetails.md b/docs/reference/api/HealthReportFileSettingsIndicatorDetails.md index 7e4d05abe..1219889ef 100644 --- a/docs/reference/api/HealthReportFileSettingsIndicatorDetails.md +++ b/docs/reference/api/HealthReportFileSettingsIndicatorDetails.md @@ -1,4 +1,4 @@ -## Interface `HealthReportFileSettingsIndicatorDetails` +# `HealthReportFileSettingsIndicatorDetails` [interface-HealthReportFileSettingsIndicatorDetails] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/HealthReportIlmIndicator.md b/docs/reference/api/HealthReportIlmIndicator.md index ad55add54..5a058217c 100644 --- a/docs/reference/api/HealthReportIlmIndicator.md +++ b/docs/reference/api/HealthReportIlmIndicator.md @@ -1,4 +1,4 @@ -## Interface `HealthReportIlmIndicator` +# `HealthReportIlmIndicator` [interface-HealthReportIlmIndicator] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/HealthReportIlmIndicatorDetails.md b/docs/reference/api/HealthReportIlmIndicatorDetails.md index 048780330..9d8a97a08 100644 --- a/docs/reference/api/HealthReportIlmIndicatorDetails.md +++ b/docs/reference/api/HealthReportIlmIndicatorDetails.md @@ -1,4 +1,4 @@ -## Interface `HealthReportIlmIndicatorDetails` +# `HealthReportIlmIndicatorDetails` [interface-HealthReportIlmIndicatorDetails] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/HealthReportImpact.md b/docs/reference/api/HealthReportImpact.md index 6a3b0469f..294ac60ee 100644 --- a/docs/reference/api/HealthReportImpact.md +++ b/docs/reference/api/HealthReportImpact.md @@ -1,4 +1,4 @@ -## Interface `HealthReportImpact` +# `HealthReportImpact` [interface-HealthReportImpact] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/HealthReportImpactArea.md b/docs/reference/api/HealthReportImpactArea.md index e04bf08da..a1969f152 100644 --- a/docs/reference/api/HealthReportImpactArea.md +++ b/docs/reference/api/HealthReportImpactArea.md @@ -1,4 +1,4 @@ -## `HealthReportImpactArea` -::: +# `HealthReportImpactArea` [alias-HealthReportImpactArea] +```typescript type HealthReportImpactArea = 'search' | 'ingest' | 'backup' | 'deployment_management'; -::: +``` diff --git a/docs/reference/api/HealthReportIndicatorHealthStatus.md b/docs/reference/api/HealthReportIndicatorHealthStatus.md index 3c872bf50..ed2802fc9 100644 --- a/docs/reference/api/HealthReportIndicatorHealthStatus.md +++ b/docs/reference/api/HealthReportIndicatorHealthStatus.md @@ -1,4 +1,4 @@ -## `HealthReportIndicatorHealthStatus` -::: +# `HealthReportIndicatorHealthStatus` [alias-HealthReportIndicatorHealthStatus] +```typescript type HealthReportIndicatorHealthStatus = 'green' | 'yellow' | 'red' | 'unknown'; -::: +``` diff --git a/docs/reference/api/HealthReportIndicatorNode.md b/docs/reference/api/HealthReportIndicatorNode.md index 153aa3d4b..93ac1e96f 100644 --- a/docs/reference/api/HealthReportIndicatorNode.md +++ b/docs/reference/api/HealthReportIndicatorNode.md @@ -1,4 +1,4 @@ -## Interface `HealthReportIndicatorNode` +# `HealthReportIndicatorNode` [interface-HealthReportIndicatorNode] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/HealthReportIndicators.md b/docs/reference/api/HealthReportIndicators.md index 5d4c83233..a5967ccaf 100644 --- a/docs/reference/api/HealthReportIndicators.md +++ b/docs/reference/api/HealthReportIndicators.md @@ -1,4 +1,4 @@ -## Interface `HealthReportIndicators` +# `HealthReportIndicators` [interface-HealthReportIndicators] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/HealthReportMasterIsStableIndicator.md b/docs/reference/api/HealthReportMasterIsStableIndicator.md index a82d95302..cb9e5cbdb 100644 --- a/docs/reference/api/HealthReportMasterIsStableIndicator.md +++ b/docs/reference/api/HealthReportMasterIsStableIndicator.md @@ -1,4 +1,4 @@ -## Interface `HealthReportMasterIsStableIndicator` +# `HealthReportMasterIsStableIndicator` [interface-HealthReportMasterIsStableIndicator] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/HealthReportMasterIsStableIndicatorClusterFormationNode.md b/docs/reference/api/HealthReportMasterIsStableIndicatorClusterFormationNode.md index 372e9b456..967bb655a 100644 --- a/docs/reference/api/HealthReportMasterIsStableIndicatorClusterFormationNode.md +++ b/docs/reference/api/HealthReportMasterIsStableIndicatorClusterFormationNode.md @@ -1,4 +1,4 @@ -## Interface `HealthReportMasterIsStableIndicatorClusterFormationNode` +# `HealthReportMasterIsStableIndicatorClusterFormationNode` [interface-HealthReportMasterIsStableIndicatorClusterFormationNode] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/HealthReportMasterIsStableIndicatorDetails.md b/docs/reference/api/HealthReportMasterIsStableIndicatorDetails.md index 6ca2edada..e1503e8f6 100644 --- a/docs/reference/api/HealthReportMasterIsStableIndicatorDetails.md +++ b/docs/reference/api/HealthReportMasterIsStableIndicatorDetails.md @@ -1,4 +1,4 @@ -## Interface `HealthReportMasterIsStableIndicatorDetails` +# `HealthReportMasterIsStableIndicatorDetails` [interface-HealthReportMasterIsStableIndicatorDetails] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/HealthReportMasterIsStableIndicatorExceptionFetchingHistory.md b/docs/reference/api/HealthReportMasterIsStableIndicatorExceptionFetchingHistory.md index b83d6214f..bbd5d8059 100644 --- a/docs/reference/api/HealthReportMasterIsStableIndicatorExceptionFetchingHistory.md +++ b/docs/reference/api/HealthReportMasterIsStableIndicatorExceptionFetchingHistory.md @@ -1,4 +1,4 @@ -## Interface `HealthReportMasterIsStableIndicatorExceptionFetchingHistory` +# `HealthReportMasterIsStableIndicatorExceptionFetchingHistory` [interface-HealthReportMasterIsStableIndicatorExceptionFetchingHistory] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/HealthReportRepositoryIntegrityIndicator.md b/docs/reference/api/HealthReportRepositoryIntegrityIndicator.md index 5e783ac2b..8d953ea40 100644 --- a/docs/reference/api/HealthReportRepositoryIntegrityIndicator.md +++ b/docs/reference/api/HealthReportRepositoryIntegrityIndicator.md @@ -1,4 +1,4 @@ -## Interface `HealthReportRepositoryIntegrityIndicator` +# `HealthReportRepositoryIntegrityIndicator` [interface-HealthReportRepositoryIntegrityIndicator] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/HealthReportRepositoryIntegrityIndicatorDetails.md b/docs/reference/api/HealthReportRepositoryIntegrityIndicatorDetails.md index 9839402e3..08404220e 100644 --- a/docs/reference/api/HealthReportRepositoryIntegrityIndicatorDetails.md +++ b/docs/reference/api/HealthReportRepositoryIntegrityIndicatorDetails.md @@ -1,4 +1,4 @@ -## Interface `HealthReportRepositoryIntegrityIndicatorDetails` +# `HealthReportRepositoryIntegrityIndicatorDetails` [interface-HealthReportRepositoryIntegrityIndicatorDetails] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/HealthReportRequest.md b/docs/reference/api/HealthReportRequest.md index 4477ea8a8..17ed3a902 100644 --- a/docs/reference/api/HealthReportRequest.md +++ b/docs/reference/api/HealthReportRequest.md @@ -1,4 +1,4 @@ -## Interface `HealthReportRequest` +# `HealthReportRequest` [interface-HealthReportRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/HealthReportResponse.md b/docs/reference/api/HealthReportResponse.md index 95d882828..7826f42a7 100644 --- a/docs/reference/api/HealthReportResponse.md +++ b/docs/reference/api/HealthReportResponse.md @@ -1,4 +1,4 @@ -## Interface `HealthReportResponse` +# `HealthReportResponse` [interface-HealthReportResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/HealthReportShardsAvailabilityIndicator.md b/docs/reference/api/HealthReportShardsAvailabilityIndicator.md index 7f3338c8e..80341bdca 100644 --- a/docs/reference/api/HealthReportShardsAvailabilityIndicator.md +++ b/docs/reference/api/HealthReportShardsAvailabilityIndicator.md @@ -1,4 +1,4 @@ -## Interface `HealthReportShardsAvailabilityIndicator` +# `HealthReportShardsAvailabilityIndicator` [interface-HealthReportShardsAvailabilityIndicator] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/HealthReportShardsAvailabilityIndicatorDetails.md b/docs/reference/api/HealthReportShardsAvailabilityIndicatorDetails.md index 5c313923d..12c5337be 100644 --- a/docs/reference/api/HealthReportShardsAvailabilityIndicatorDetails.md +++ b/docs/reference/api/HealthReportShardsAvailabilityIndicatorDetails.md @@ -1,4 +1,4 @@ -## Interface `HealthReportShardsAvailabilityIndicatorDetails` +# `HealthReportShardsAvailabilityIndicatorDetails` [interface-HealthReportShardsAvailabilityIndicatorDetails] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/HealthReportShardsCapacityIndicator.md b/docs/reference/api/HealthReportShardsCapacityIndicator.md index 4e2391265..09e5a8ac8 100644 --- a/docs/reference/api/HealthReportShardsCapacityIndicator.md +++ b/docs/reference/api/HealthReportShardsCapacityIndicator.md @@ -1,4 +1,4 @@ -## Interface `HealthReportShardsCapacityIndicator` +# `HealthReportShardsCapacityIndicator` [interface-HealthReportShardsCapacityIndicator] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/HealthReportShardsCapacityIndicatorDetails.md b/docs/reference/api/HealthReportShardsCapacityIndicatorDetails.md index 5f99cf5ba..d1d668f20 100644 --- a/docs/reference/api/HealthReportShardsCapacityIndicatorDetails.md +++ b/docs/reference/api/HealthReportShardsCapacityIndicatorDetails.md @@ -1,4 +1,4 @@ -## Interface `HealthReportShardsCapacityIndicatorDetails` +# `HealthReportShardsCapacityIndicatorDetails` [interface-HealthReportShardsCapacityIndicatorDetails] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/HealthReportShardsCapacityIndicatorTierDetail.md b/docs/reference/api/HealthReportShardsCapacityIndicatorTierDetail.md index 625ad7c65..e5257afc3 100644 --- a/docs/reference/api/HealthReportShardsCapacityIndicatorTierDetail.md +++ b/docs/reference/api/HealthReportShardsCapacityIndicatorTierDetail.md @@ -1,4 +1,4 @@ -## Interface `HealthReportShardsCapacityIndicatorTierDetail` +# `HealthReportShardsCapacityIndicatorTierDetail` [interface-HealthReportShardsCapacityIndicatorTierDetail] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/HealthReportSlmIndicator.md b/docs/reference/api/HealthReportSlmIndicator.md index 145a3da93..f83295e9d 100644 --- a/docs/reference/api/HealthReportSlmIndicator.md +++ b/docs/reference/api/HealthReportSlmIndicator.md @@ -1,4 +1,4 @@ -## Interface `HealthReportSlmIndicator` +# `HealthReportSlmIndicator` [interface-HealthReportSlmIndicator] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/HealthReportSlmIndicatorDetails.md b/docs/reference/api/HealthReportSlmIndicatorDetails.md index e53bb9722..851ae4ab2 100644 --- a/docs/reference/api/HealthReportSlmIndicatorDetails.md +++ b/docs/reference/api/HealthReportSlmIndicatorDetails.md @@ -1,4 +1,4 @@ -## Interface `HealthReportSlmIndicatorDetails` +# `HealthReportSlmIndicatorDetails` [interface-HealthReportSlmIndicatorDetails] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/HealthReportSlmIndicatorUnhealthyPolicies.md b/docs/reference/api/HealthReportSlmIndicatorUnhealthyPolicies.md index 1b0d08e6e..4d167eb32 100644 --- a/docs/reference/api/HealthReportSlmIndicatorUnhealthyPolicies.md +++ b/docs/reference/api/HealthReportSlmIndicatorUnhealthyPolicies.md @@ -1,4 +1,4 @@ -## Interface `HealthReportSlmIndicatorUnhealthyPolicies` +# `HealthReportSlmIndicatorUnhealthyPolicies` [interface-HealthReportSlmIndicatorUnhealthyPolicies] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/HealthReportStagnatingBackingIndices.md b/docs/reference/api/HealthReportStagnatingBackingIndices.md index 1e58996a9..bf87af40b 100644 --- a/docs/reference/api/HealthReportStagnatingBackingIndices.md +++ b/docs/reference/api/HealthReportStagnatingBackingIndices.md @@ -1,4 +1,4 @@ -## Interface `HealthReportStagnatingBackingIndices` +# `HealthReportStagnatingBackingIndices` [interface-HealthReportStagnatingBackingIndices] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/HealthStatus.md b/docs/reference/api/HealthStatus.md index a6adeba68..ba6d7cec2 100644 --- a/docs/reference/api/HealthStatus.md +++ b/docs/reference/api/HealthStatus.md @@ -1,4 +1,4 @@ -## `HealthStatus` -::: +# `HealthStatus` [alias-HealthStatus] +```typescript type HealthStatus = 'green' | 'GREEN' | 'yellow' | 'YELLOW' | 'red' | 'RED'; -::: +``` diff --git a/docs/reference/api/Helpers.md b/docs/reference/api/Helpers.md index c4f7c1928..7cde710e5 100644 --- a/docs/reference/api/Helpers.md +++ b/docs/reference/api/Helpers.md @@ -1,17 +1,17 @@ -## `Helpers` +# `Helpers` [class-Helpers] -### Constructor +## Constructor -::: +```typescript new Helpers(opts: [HelpersOptions](./HelpersOptions.md)); -::: +``` -### Properties +## Properties [class-properties-Helpers] | Name | Type | Description | | - | - | - | -### Methods +## Methods [class-methods-Helpers] | Name | Signature | Description | | - | - | - | diff --git a/docs/reference/api/HelpersOptions.md b/docs/reference/api/HelpersOptions.md index 00b6181b0..bc47856da 100644 --- a/docs/reference/api/HelpersOptions.md +++ b/docs/reference/api/HelpersOptions.md @@ -1,4 +1,4 @@ -## Interface `HelpersOptions` +# `HelpersOptions` [interface-HelpersOptions] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/Host.md b/docs/reference/api/Host.md index a5776edde..d893d4616 100644 --- a/docs/reference/api/Host.md +++ b/docs/reference/api/Host.md @@ -1,4 +1,4 @@ -## `Host` -::: +# `Host` [alias-Host] +```typescript type Host = string; -::: +``` diff --git a/docs/reference/api/HttpHeaders.md b/docs/reference/api/HttpHeaders.md index 61980b450..db9ddf40c 100644 --- a/docs/reference/api/HttpHeaders.md +++ b/docs/reference/api/HttpHeaders.md @@ -1,4 +1,4 @@ -## `HttpHeaders` -::: +# `HttpHeaders` [alias-HttpHeaders] +```typescript type HttpHeaders = Record; -::: +``` diff --git a/docs/reference/api/IBDistribution.md b/docs/reference/api/IBDistribution.md index aee923fe8..77c35ddc2 100644 --- a/docs/reference/api/IBDistribution.md +++ b/docs/reference/api/IBDistribution.md @@ -1,4 +1,4 @@ -## `IBDistribution` -::: +# `IBDistribution` [alias-IBDistribution] +```typescript type IBDistribution = 'll' | 'spl'; -::: +``` diff --git a/docs/reference/api/IBLambda.md b/docs/reference/api/IBLambda.md index acc824309..e5e165218 100644 --- a/docs/reference/api/IBLambda.md +++ b/docs/reference/api/IBLambda.md @@ -1,4 +1,4 @@ -## `IBLambda` -::: +# `IBLambda` [alias-IBLambda] +```typescript type IBLambda = 'df' | 'ttf'; -::: +``` diff --git a/docs/reference/api/Id.md b/docs/reference/api/Id.md index 403a3d115..8019c90e0 100644 --- a/docs/reference/api/Id.md +++ b/docs/reference/api/Id.md @@ -1,4 +1,4 @@ -## `Id` -::: +# `Id` [alias-Id] +```typescript type Id = string; -::: +``` diff --git a/docs/reference/api/Ids.md b/docs/reference/api/Ids.md index f623dd0c8..f60da89ba 100644 --- a/docs/reference/api/Ids.md +++ b/docs/reference/api/Ids.md @@ -1,4 +1,4 @@ -## `Ids` -::: +# `Ids` [alias-Ids] +```typescript type Ids = [Id](./Id.md) | [Id](./Id.md)[]; -::: +``` diff --git a/docs/reference/api/Ilm.md b/docs/reference/api/Ilm.md index ea99831c9..a77fe2cc1 100644 --- a/docs/reference/api/Ilm.md +++ b/docs/reference/api/Ilm.md @@ -1,19 +1,19 @@ -## `Ilm` +# `Ilm` [class-Ilm] -### Constructor +## Constructor -::: +```typescript new Ilm(transport: [Transport](./Transport.md)); -::: +``` -### Properties +## Properties [class-properties-Ilm] | Name | Type | Description | | - | - | - | | `acceptedParams` | Record |   | | `transport` | [Transport](./Transport.md) |   | -### Methods +## Methods [class-methods-Ilm] | Name | Signature | Description | | - | - | - | diff --git a/docs/reference/api/IlmActions.md b/docs/reference/api/IlmActions.md index eee25490d..e3ee9bf82 100644 --- a/docs/reference/api/IlmActions.md +++ b/docs/reference/api/IlmActions.md @@ -1,4 +1,4 @@ -## Interface `IlmActions` +# `IlmActions` [interface-IlmActions] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IlmAllocateAction.md b/docs/reference/api/IlmAllocateAction.md index 8ef0c5772..98dc8a06a 100644 --- a/docs/reference/api/IlmAllocateAction.md +++ b/docs/reference/api/IlmAllocateAction.md @@ -1,4 +1,4 @@ -## Interface `IlmAllocateAction` +# `IlmAllocateAction` [interface-IlmAllocateAction] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IlmDeleteAction.md b/docs/reference/api/IlmDeleteAction.md index ec10bc61d..5aefbd3b1 100644 --- a/docs/reference/api/IlmDeleteAction.md +++ b/docs/reference/api/IlmDeleteAction.md @@ -1,4 +1,4 @@ -## Interface `IlmDeleteAction` +# `IlmDeleteAction` [interface-IlmDeleteAction] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IlmDeleteLifecycleRequest.md b/docs/reference/api/IlmDeleteLifecycleRequest.md index 9c1948ebb..f91195565 100644 --- a/docs/reference/api/IlmDeleteLifecycleRequest.md +++ b/docs/reference/api/IlmDeleteLifecycleRequest.md @@ -1,4 +1,4 @@ -## Interface `IlmDeleteLifecycleRequest` +# `IlmDeleteLifecycleRequest` [interface-IlmDeleteLifecycleRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IlmDeleteLifecycleResponse.md b/docs/reference/api/IlmDeleteLifecycleResponse.md index 6bfaf84d1..89d36123f 100644 --- a/docs/reference/api/IlmDeleteLifecycleResponse.md +++ b/docs/reference/api/IlmDeleteLifecycleResponse.md @@ -1,4 +1,4 @@ -## `IlmDeleteLifecycleResponse` -::: +# `IlmDeleteLifecycleResponse` [alias-IlmDeleteLifecycleResponse] +```typescript type IlmDeleteLifecycleResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); -::: +``` diff --git a/docs/reference/api/IlmDownsampleAction.md b/docs/reference/api/IlmDownsampleAction.md index 1e850d8e5..984bc5156 100644 --- a/docs/reference/api/IlmDownsampleAction.md +++ b/docs/reference/api/IlmDownsampleAction.md @@ -1,4 +1,4 @@ -## Interface `IlmDownsampleAction` +# `IlmDownsampleAction` [interface-IlmDownsampleAction] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IlmExplainLifecycleLifecycleExplain.md b/docs/reference/api/IlmExplainLifecycleLifecycleExplain.md index 5beb9ddd5..254212f33 100644 --- a/docs/reference/api/IlmExplainLifecycleLifecycleExplain.md +++ b/docs/reference/api/IlmExplainLifecycleLifecycleExplain.md @@ -1,4 +1,4 @@ -## `IlmExplainLifecycleLifecycleExplain` -::: +# `IlmExplainLifecycleLifecycleExplain` [alias-IlmExplainLifecycleLifecycleExplain] +```typescript type IlmExplainLifecycleLifecycleExplain = [IlmExplainLifecycleLifecycleExplainManaged](./IlmExplainLifecycleLifecycleExplainManaged.md) | [IlmExplainLifecycleLifecycleExplainUnmanaged](./IlmExplainLifecycleLifecycleExplainUnmanaged.md); -::: +``` diff --git a/docs/reference/api/IlmExplainLifecycleLifecycleExplainManaged.md b/docs/reference/api/IlmExplainLifecycleLifecycleExplainManaged.md index 4d374d317..de35c5c32 100644 --- a/docs/reference/api/IlmExplainLifecycleLifecycleExplainManaged.md +++ b/docs/reference/api/IlmExplainLifecycleLifecycleExplainManaged.md @@ -1,4 +1,4 @@ -## Interface `IlmExplainLifecycleLifecycleExplainManaged` +# `IlmExplainLifecycleLifecycleExplainManaged` [interface-IlmExplainLifecycleLifecycleExplainManaged] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IlmExplainLifecycleLifecycleExplainPhaseExecution.md b/docs/reference/api/IlmExplainLifecycleLifecycleExplainPhaseExecution.md index 35b50e430..6e9ac9a07 100644 --- a/docs/reference/api/IlmExplainLifecycleLifecycleExplainPhaseExecution.md +++ b/docs/reference/api/IlmExplainLifecycleLifecycleExplainPhaseExecution.md @@ -1,4 +1,4 @@ -## Interface `IlmExplainLifecycleLifecycleExplainPhaseExecution` +# `IlmExplainLifecycleLifecycleExplainPhaseExecution` [interface-IlmExplainLifecycleLifecycleExplainPhaseExecution] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IlmExplainLifecycleLifecycleExplainUnmanaged.md b/docs/reference/api/IlmExplainLifecycleLifecycleExplainUnmanaged.md index 4f2425123..02e19156c 100644 --- a/docs/reference/api/IlmExplainLifecycleLifecycleExplainUnmanaged.md +++ b/docs/reference/api/IlmExplainLifecycleLifecycleExplainUnmanaged.md @@ -1,4 +1,4 @@ -## Interface `IlmExplainLifecycleLifecycleExplainUnmanaged` +# `IlmExplainLifecycleLifecycleExplainUnmanaged` [interface-IlmExplainLifecycleLifecycleExplainUnmanaged] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IlmExplainLifecycleRequest.md b/docs/reference/api/IlmExplainLifecycleRequest.md index 15632b2be..93bbedb41 100644 --- a/docs/reference/api/IlmExplainLifecycleRequest.md +++ b/docs/reference/api/IlmExplainLifecycleRequest.md @@ -1,4 +1,4 @@ -## Interface `IlmExplainLifecycleRequest` +# `IlmExplainLifecycleRequest` [interface-IlmExplainLifecycleRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IlmExplainLifecycleResponse.md b/docs/reference/api/IlmExplainLifecycleResponse.md index 2d22098ee..971b0fc85 100644 --- a/docs/reference/api/IlmExplainLifecycleResponse.md +++ b/docs/reference/api/IlmExplainLifecycleResponse.md @@ -1,4 +1,4 @@ -## Interface `IlmExplainLifecycleResponse` +# `IlmExplainLifecycleResponse` [interface-IlmExplainLifecycleResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IlmForceMergeAction.md b/docs/reference/api/IlmForceMergeAction.md index 3ef7ebdd1..b72eadb5a 100644 --- a/docs/reference/api/IlmForceMergeAction.md +++ b/docs/reference/api/IlmForceMergeAction.md @@ -1,4 +1,4 @@ -## Interface `IlmForceMergeAction` +# `IlmForceMergeAction` [interface-IlmForceMergeAction] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IlmGetLifecycleLifecycle.md b/docs/reference/api/IlmGetLifecycleLifecycle.md index 9c6a1daf0..46cd43bd6 100644 --- a/docs/reference/api/IlmGetLifecycleLifecycle.md +++ b/docs/reference/api/IlmGetLifecycleLifecycle.md @@ -1,4 +1,4 @@ -## Interface `IlmGetLifecycleLifecycle` +# `IlmGetLifecycleLifecycle` [interface-IlmGetLifecycleLifecycle] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IlmGetLifecycleRequest.md b/docs/reference/api/IlmGetLifecycleRequest.md index 3ea5fa940..8acc4d786 100644 --- a/docs/reference/api/IlmGetLifecycleRequest.md +++ b/docs/reference/api/IlmGetLifecycleRequest.md @@ -1,4 +1,4 @@ -## Interface `IlmGetLifecycleRequest` +# `IlmGetLifecycleRequest` [interface-IlmGetLifecycleRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IlmGetLifecycleResponse.md b/docs/reference/api/IlmGetLifecycleResponse.md index 21aa8cebc..30e010c77 100644 --- a/docs/reference/api/IlmGetLifecycleResponse.md +++ b/docs/reference/api/IlmGetLifecycleResponse.md @@ -1,4 +1,4 @@ -## `IlmGetLifecycleResponse` -::: +# `IlmGetLifecycleResponse` [alias-IlmGetLifecycleResponse] +```typescript type IlmGetLifecycleResponse = Record; -::: +``` diff --git a/docs/reference/api/IlmGetStatusRequest.md b/docs/reference/api/IlmGetStatusRequest.md index 6143565c3..880a28302 100644 --- a/docs/reference/api/IlmGetStatusRequest.md +++ b/docs/reference/api/IlmGetStatusRequest.md @@ -1,4 +1,4 @@ -## Interface `IlmGetStatusRequest` +# `IlmGetStatusRequest` [interface-IlmGetStatusRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IlmGetStatusResponse.md b/docs/reference/api/IlmGetStatusResponse.md index d2c54f3d6..22e3eae6e 100644 --- a/docs/reference/api/IlmGetStatusResponse.md +++ b/docs/reference/api/IlmGetStatusResponse.md @@ -1,4 +1,4 @@ -## Interface `IlmGetStatusResponse` +# `IlmGetStatusResponse` [interface-IlmGetStatusResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IlmMigrateAction.md b/docs/reference/api/IlmMigrateAction.md index a3e5a6ee4..efe4bd950 100644 --- a/docs/reference/api/IlmMigrateAction.md +++ b/docs/reference/api/IlmMigrateAction.md @@ -1,4 +1,4 @@ -## Interface `IlmMigrateAction` +# `IlmMigrateAction` [interface-IlmMigrateAction] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IlmMigrateToDataTiersRequest.md b/docs/reference/api/IlmMigrateToDataTiersRequest.md index 68c9a7fd1..06e50354d 100644 --- a/docs/reference/api/IlmMigrateToDataTiersRequest.md +++ b/docs/reference/api/IlmMigrateToDataTiersRequest.md @@ -1,4 +1,4 @@ -## Interface `IlmMigrateToDataTiersRequest` +# `IlmMigrateToDataTiersRequest` [interface-IlmMigrateToDataTiersRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IlmMigrateToDataTiersResponse.md b/docs/reference/api/IlmMigrateToDataTiersResponse.md index 6d4f70119..9bb69627f 100644 --- a/docs/reference/api/IlmMigrateToDataTiersResponse.md +++ b/docs/reference/api/IlmMigrateToDataTiersResponse.md @@ -1,4 +1,4 @@ -## Interface `IlmMigrateToDataTiersResponse` +# `IlmMigrateToDataTiersResponse` [interface-IlmMigrateToDataTiersResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IlmMoveToStepRequest.md b/docs/reference/api/IlmMoveToStepRequest.md index ab02c6da4..160b91112 100644 --- a/docs/reference/api/IlmMoveToStepRequest.md +++ b/docs/reference/api/IlmMoveToStepRequest.md @@ -1,4 +1,4 @@ -## Interface `IlmMoveToStepRequest` +# `IlmMoveToStepRequest` [interface-IlmMoveToStepRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IlmMoveToStepResponse.md b/docs/reference/api/IlmMoveToStepResponse.md index f5465ea4f..940d930b7 100644 --- a/docs/reference/api/IlmMoveToStepResponse.md +++ b/docs/reference/api/IlmMoveToStepResponse.md @@ -1,4 +1,4 @@ -## `IlmMoveToStepResponse` -::: +# `IlmMoveToStepResponse` [alias-IlmMoveToStepResponse] +```typescript type IlmMoveToStepResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); -::: +``` diff --git a/docs/reference/api/IlmMoveToStepStepKey.md b/docs/reference/api/IlmMoveToStepStepKey.md index 0bbcb3f89..01d2b359e 100644 --- a/docs/reference/api/IlmMoveToStepStepKey.md +++ b/docs/reference/api/IlmMoveToStepStepKey.md @@ -1,4 +1,4 @@ -## Interface `IlmMoveToStepStepKey` +# `IlmMoveToStepStepKey` [interface-IlmMoveToStepStepKey] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IlmPhase.md b/docs/reference/api/IlmPhase.md index b83726fcd..46110ad82 100644 --- a/docs/reference/api/IlmPhase.md +++ b/docs/reference/api/IlmPhase.md @@ -1,4 +1,4 @@ -## Interface `IlmPhase` +# `IlmPhase` [interface-IlmPhase] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IlmPhases.md b/docs/reference/api/IlmPhases.md index 18d49517d..bd79351f6 100644 --- a/docs/reference/api/IlmPhases.md +++ b/docs/reference/api/IlmPhases.md @@ -1,4 +1,4 @@ -## Interface `IlmPhases` +# `IlmPhases` [interface-IlmPhases] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IlmPolicy.md b/docs/reference/api/IlmPolicy.md index 78e5f30c1..833c7d77c 100644 --- a/docs/reference/api/IlmPolicy.md +++ b/docs/reference/api/IlmPolicy.md @@ -1,4 +1,4 @@ -## Interface `IlmPolicy` +# `IlmPolicy` [interface-IlmPolicy] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IlmPutLifecycleRequest.md b/docs/reference/api/IlmPutLifecycleRequest.md index fc8f6649a..78583aa3d 100644 --- a/docs/reference/api/IlmPutLifecycleRequest.md +++ b/docs/reference/api/IlmPutLifecycleRequest.md @@ -1,4 +1,4 @@ -## Interface `IlmPutLifecycleRequest` +# `IlmPutLifecycleRequest` [interface-IlmPutLifecycleRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IlmPutLifecycleResponse.md b/docs/reference/api/IlmPutLifecycleResponse.md index 235ab244b..56b39e883 100644 --- a/docs/reference/api/IlmPutLifecycleResponse.md +++ b/docs/reference/api/IlmPutLifecycleResponse.md @@ -1,4 +1,4 @@ -## `IlmPutLifecycleResponse` -::: +# `IlmPutLifecycleResponse` [alias-IlmPutLifecycleResponse] +```typescript type IlmPutLifecycleResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); -::: +``` diff --git a/docs/reference/api/IlmRemovePolicyRequest.md b/docs/reference/api/IlmRemovePolicyRequest.md index 34f7d0e5a..0de74798e 100644 --- a/docs/reference/api/IlmRemovePolicyRequest.md +++ b/docs/reference/api/IlmRemovePolicyRequest.md @@ -1,4 +1,4 @@ -## Interface `IlmRemovePolicyRequest` +# `IlmRemovePolicyRequest` [interface-IlmRemovePolicyRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IlmRemovePolicyResponse.md b/docs/reference/api/IlmRemovePolicyResponse.md index 41d31e2e4..dbd888f9d 100644 --- a/docs/reference/api/IlmRemovePolicyResponse.md +++ b/docs/reference/api/IlmRemovePolicyResponse.md @@ -1,4 +1,4 @@ -## Interface `IlmRemovePolicyResponse` +# `IlmRemovePolicyResponse` [interface-IlmRemovePolicyResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IlmRetryRequest.md b/docs/reference/api/IlmRetryRequest.md index ca65ee8c7..1ece484d7 100644 --- a/docs/reference/api/IlmRetryRequest.md +++ b/docs/reference/api/IlmRetryRequest.md @@ -1,4 +1,4 @@ -## Interface `IlmRetryRequest` +# `IlmRetryRequest` [interface-IlmRetryRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IlmRetryResponse.md b/docs/reference/api/IlmRetryResponse.md index e25f5a641..5ba601c37 100644 --- a/docs/reference/api/IlmRetryResponse.md +++ b/docs/reference/api/IlmRetryResponse.md @@ -1,4 +1,4 @@ -## `IlmRetryResponse` -::: +# `IlmRetryResponse` [alias-IlmRetryResponse] +```typescript type IlmRetryResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); -::: +``` diff --git a/docs/reference/api/IlmRolloverAction.md b/docs/reference/api/IlmRolloverAction.md index 5a63822b3..e10d04012 100644 --- a/docs/reference/api/IlmRolloverAction.md +++ b/docs/reference/api/IlmRolloverAction.md @@ -1,4 +1,4 @@ -## Interface `IlmRolloverAction` +# `IlmRolloverAction` [interface-IlmRolloverAction] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IlmSearchableSnapshotAction.md b/docs/reference/api/IlmSearchableSnapshotAction.md index ab78509aa..05525c123 100644 --- a/docs/reference/api/IlmSearchableSnapshotAction.md +++ b/docs/reference/api/IlmSearchableSnapshotAction.md @@ -1,4 +1,4 @@ -## Interface `IlmSearchableSnapshotAction` +# `IlmSearchableSnapshotAction` [interface-IlmSearchableSnapshotAction] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IlmSetPriorityAction.md b/docs/reference/api/IlmSetPriorityAction.md index 02a517a8c..3d5e22db0 100644 --- a/docs/reference/api/IlmSetPriorityAction.md +++ b/docs/reference/api/IlmSetPriorityAction.md @@ -1,4 +1,4 @@ -## Interface `IlmSetPriorityAction` +# `IlmSetPriorityAction` [interface-IlmSetPriorityAction] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IlmShrinkAction.md b/docs/reference/api/IlmShrinkAction.md index f0518dfca..e2c123d3e 100644 --- a/docs/reference/api/IlmShrinkAction.md +++ b/docs/reference/api/IlmShrinkAction.md @@ -1,4 +1,4 @@ -## Interface `IlmShrinkAction` +# `IlmShrinkAction` [interface-IlmShrinkAction] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IlmStartRequest.md b/docs/reference/api/IlmStartRequest.md index dc712a3e2..eeb142cf5 100644 --- a/docs/reference/api/IlmStartRequest.md +++ b/docs/reference/api/IlmStartRequest.md @@ -1,4 +1,4 @@ -## Interface `IlmStartRequest` +# `IlmStartRequest` [interface-IlmStartRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IlmStartResponse.md b/docs/reference/api/IlmStartResponse.md index c62579f7f..ce21193a7 100644 --- a/docs/reference/api/IlmStartResponse.md +++ b/docs/reference/api/IlmStartResponse.md @@ -1,4 +1,4 @@ -## `IlmStartResponse` -::: +# `IlmStartResponse` [alias-IlmStartResponse] +```typescript type IlmStartResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); -::: +``` diff --git a/docs/reference/api/IlmStopRequest.md b/docs/reference/api/IlmStopRequest.md index d95c67ef2..a03bc99f0 100644 --- a/docs/reference/api/IlmStopRequest.md +++ b/docs/reference/api/IlmStopRequest.md @@ -1,4 +1,4 @@ -## Interface `IlmStopRequest` +# `IlmStopRequest` [interface-IlmStopRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IlmStopResponse.md b/docs/reference/api/IlmStopResponse.md index 960c4d0f5..997bbe677 100644 --- a/docs/reference/api/IlmStopResponse.md +++ b/docs/reference/api/IlmStopResponse.md @@ -1,4 +1,4 @@ -## `IlmStopResponse` -::: +# `IlmStopResponse` [alias-IlmStopResponse] +```typescript type IlmStopResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); -::: +``` diff --git a/docs/reference/api/IlmWaitForSnapshotAction.md b/docs/reference/api/IlmWaitForSnapshotAction.md index af4b8f02f..b6dd85461 100644 --- a/docs/reference/api/IlmWaitForSnapshotAction.md +++ b/docs/reference/api/IlmWaitForSnapshotAction.md @@ -1,4 +1,4 @@ -## Interface `IlmWaitForSnapshotAction` +# `IlmWaitForSnapshotAction` [interface-IlmWaitForSnapshotAction] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndexAction.md b/docs/reference/api/IndexAction.md index dc950a114..ebcc12b2d 100644 --- a/docs/reference/api/IndexAction.md +++ b/docs/reference/api/IndexAction.md @@ -1,4 +1,4 @@ -## `IndexAction` -::: +# `IndexAction` [alias-IndexAction] +```typescript type IndexAction = [IndexActionOperation](./IndexActionOperation.md) | [[IndexActionOperation](./IndexActionOperation.md), unknown]; -::: +``` diff --git a/docs/reference/api/IndexActionOperation.md b/docs/reference/api/IndexActionOperation.md index fc1f602e7..c89665b9d 100644 --- a/docs/reference/api/IndexActionOperation.md +++ b/docs/reference/api/IndexActionOperation.md @@ -1,4 +1,4 @@ -## Interface `IndexActionOperation` +# `IndexActionOperation` [interface-IndexActionOperation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndexAlias.md b/docs/reference/api/IndexAlias.md index fb9052888..71f03c8c6 100644 --- a/docs/reference/api/IndexAlias.md +++ b/docs/reference/api/IndexAlias.md @@ -1,4 +1,4 @@ -## `IndexAlias` -::: +# `IndexAlias` [alias-IndexAlias] +```typescript type IndexAlias = string; -::: +``` diff --git a/docs/reference/api/IndexApi_1.md b/docs/reference/api/IndexApi_1.md index acd77a7b4..b26fdd936 100644 --- a/docs/reference/api/IndexApi_1.md +++ b/docs/reference/api/IndexApi_1.md @@ -1,3 +1,3 @@ -::: +```typescript default function IndexApi(this: [That](./That.md), params: [IndexRequest](./IndexRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[IndexResponse](./IndexResponse.md)>; -::: +``` diff --git a/docs/reference/api/IndexApi_2.md b/docs/reference/api/IndexApi_2.md index 401355e93..7a371998f 100644 --- a/docs/reference/api/IndexApi_2.md +++ b/docs/reference/api/IndexApi_2.md @@ -1,3 +1,3 @@ -::: +```typescript default function IndexApi(this: [That](./That.md), params: [IndexRequest](./IndexRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[IndexResponse](./IndexResponse.md), unknown>>; -::: +``` diff --git a/docs/reference/api/IndexApi_3.md b/docs/reference/api/IndexApi_3.md index 9f495f7c1..35c7ece1a 100644 --- a/docs/reference/api/IndexApi_3.md +++ b/docs/reference/api/IndexApi_3.md @@ -1,3 +1,3 @@ -::: +```typescript default function IndexApi(this: [That](./That.md), params: [IndexRequest](./IndexRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[IndexResponse](./IndexResponse.md)>; -::: +``` diff --git a/docs/reference/api/IndexName.md b/docs/reference/api/IndexName.md index 2361aaa74..d07ebd9bd 100644 --- a/docs/reference/api/IndexName.md +++ b/docs/reference/api/IndexName.md @@ -1,4 +1,4 @@ -## `IndexName` -::: +# `IndexName` [alias-IndexName] +```typescript type IndexName = string; -::: +``` diff --git a/docs/reference/api/IndexPattern.md b/docs/reference/api/IndexPattern.md index 25ebe087f..0f80ee763 100644 --- a/docs/reference/api/IndexPattern.md +++ b/docs/reference/api/IndexPattern.md @@ -1,4 +1,4 @@ -## `IndexPattern` -::: +# `IndexPattern` [alias-IndexPattern] +```typescript type IndexPattern = string; -::: +``` diff --git a/docs/reference/api/IndexPatterns.md b/docs/reference/api/IndexPatterns.md index 588a1a1d1..3ccc6d57c 100644 --- a/docs/reference/api/IndexPatterns.md +++ b/docs/reference/api/IndexPatterns.md @@ -1,4 +1,4 @@ -## `IndexPatterns` -::: +# `IndexPatterns` [alias-IndexPatterns] +```typescript type IndexPatterns = [IndexPattern](./IndexPattern.md)[]; -::: +``` diff --git a/docs/reference/api/IndexRequest.md b/docs/reference/api/IndexRequest.md index f2e334b58..23d1ff069 100644 --- a/docs/reference/api/IndexRequest.md +++ b/docs/reference/api/IndexRequest.md @@ -1,4 +1,4 @@ -## Interface `IndexRequest` +# `IndexRequest` [interface-IndexRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndexResponse.md b/docs/reference/api/IndexResponse.md index 8d70fe2e5..78ac7e312 100644 --- a/docs/reference/api/IndexResponse.md +++ b/docs/reference/api/IndexResponse.md @@ -1,4 +1,4 @@ -## `IndexResponse` -::: +# `IndexResponse` [alias-IndexResponse] +```typescript type IndexResponse = [WriteResponseBase](./WriteResponseBase.md); -::: +``` diff --git a/docs/reference/api/IndexingStats.md b/docs/reference/api/IndexingStats.md index 677299613..89ce69027 100644 --- a/docs/reference/api/IndexingStats.md +++ b/docs/reference/api/IndexingStats.md @@ -1,4 +1,4 @@ -## Interface `IndexingStats` +# `IndexingStats` [interface-IndexingStats] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/Indices.md b/docs/reference/api/Indices.md index afdc9d564..312946d42 100644 --- a/docs/reference/api/Indices.md +++ b/docs/reference/api/Indices.md @@ -1,4 +1,4 @@ -## `Indices` -::: +# `Indices` [alias-Indices] +```typescript type Indices = [IndexName](./IndexName.md) | [IndexName](./IndexName.md)[]; -::: +``` diff --git a/docs/reference/api/IndicesAddBlockIndicesBlockOptions.md b/docs/reference/api/IndicesAddBlockIndicesBlockOptions.md index fc4b80c65..0f55189af 100644 --- a/docs/reference/api/IndicesAddBlockIndicesBlockOptions.md +++ b/docs/reference/api/IndicesAddBlockIndicesBlockOptions.md @@ -1,4 +1,4 @@ -## `IndicesAddBlockIndicesBlockOptions` -::: +# `IndicesAddBlockIndicesBlockOptions` [alias-IndicesAddBlockIndicesBlockOptions] +```typescript type IndicesAddBlockIndicesBlockOptions = 'metadata' | 'read' | 'read_only' | 'write'; -::: +``` diff --git a/docs/reference/api/IndicesAddBlockIndicesBlockStatus.md b/docs/reference/api/IndicesAddBlockIndicesBlockStatus.md index 2192c00a0..485bf0c93 100644 --- a/docs/reference/api/IndicesAddBlockIndicesBlockStatus.md +++ b/docs/reference/api/IndicesAddBlockIndicesBlockStatus.md @@ -1,4 +1,4 @@ -## Interface `IndicesAddBlockIndicesBlockStatus` +# `IndicesAddBlockIndicesBlockStatus` [interface-IndicesAddBlockIndicesBlockStatus] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesAddBlockRequest.md b/docs/reference/api/IndicesAddBlockRequest.md index 77d6fca60..f1bf2333d 100644 --- a/docs/reference/api/IndicesAddBlockRequest.md +++ b/docs/reference/api/IndicesAddBlockRequest.md @@ -1,4 +1,4 @@ -## Interface `IndicesAddBlockRequest` +# `IndicesAddBlockRequest` [interface-IndicesAddBlockRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesAddBlockResponse.md b/docs/reference/api/IndicesAddBlockResponse.md index 860ec20e0..38d63dd1e 100644 --- a/docs/reference/api/IndicesAddBlockResponse.md +++ b/docs/reference/api/IndicesAddBlockResponse.md @@ -1,4 +1,4 @@ -## Interface `IndicesAddBlockResponse` +# `IndicesAddBlockResponse` [interface-IndicesAddBlockResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesAlias.md b/docs/reference/api/IndicesAlias.md index f459cebc2..9bc521979 100644 --- a/docs/reference/api/IndicesAlias.md +++ b/docs/reference/api/IndicesAlias.md @@ -1,4 +1,4 @@ -## Interface `IndicesAlias` +# `IndicesAlias` [interface-IndicesAlias] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesAliasDefinition.md b/docs/reference/api/IndicesAliasDefinition.md index 6ed4ffa5a..3853690fa 100644 --- a/docs/reference/api/IndicesAliasDefinition.md +++ b/docs/reference/api/IndicesAliasDefinition.md @@ -1,4 +1,4 @@ -## Interface `IndicesAliasDefinition` +# `IndicesAliasDefinition` [interface-IndicesAliasDefinition] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesAnalyzeAnalyzeDetail.md b/docs/reference/api/IndicesAnalyzeAnalyzeDetail.md index 47289c421..41fc6d0b8 100644 --- a/docs/reference/api/IndicesAnalyzeAnalyzeDetail.md +++ b/docs/reference/api/IndicesAnalyzeAnalyzeDetail.md @@ -1,4 +1,4 @@ -## Interface `IndicesAnalyzeAnalyzeDetail` +# `IndicesAnalyzeAnalyzeDetail` [interface-IndicesAnalyzeAnalyzeDetail] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesAnalyzeAnalyzeToken.md b/docs/reference/api/IndicesAnalyzeAnalyzeToken.md index 98512f895..a8af8f568 100644 --- a/docs/reference/api/IndicesAnalyzeAnalyzeToken.md +++ b/docs/reference/api/IndicesAnalyzeAnalyzeToken.md @@ -1,4 +1,4 @@ -## Interface `IndicesAnalyzeAnalyzeToken` +# `IndicesAnalyzeAnalyzeToken` [interface-IndicesAnalyzeAnalyzeToken] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesAnalyzeAnalyzerDetail.md b/docs/reference/api/IndicesAnalyzeAnalyzerDetail.md index 1db4eb8bf..6f70c5eae 100644 --- a/docs/reference/api/IndicesAnalyzeAnalyzerDetail.md +++ b/docs/reference/api/IndicesAnalyzeAnalyzerDetail.md @@ -1,4 +1,4 @@ -## Interface `IndicesAnalyzeAnalyzerDetail` +# `IndicesAnalyzeAnalyzerDetail` [interface-IndicesAnalyzeAnalyzerDetail] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesAnalyzeCharFilterDetail.md b/docs/reference/api/IndicesAnalyzeCharFilterDetail.md index 06e9203ab..fbfd7da50 100644 --- a/docs/reference/api/IndicesAnalyzeCharFilterDetail.md +++ b/docs/reference/api/IndicesAnalyzeCharFilterDetail.md @@ -1,4 +1,4 @@ -## Interface `IndicesAnalyzeCharFilterDetail` +# `IndicesAnalyzeCharFilterDetail` [interface-IndicesAnalyzeCharFilterDetail] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesAnalyzeExplainAnalyzeToken.md b/docs/reference/api/IndicesAnalyzeExplainAnalyzeToken.md index 4b241cdaa..079604652 100644 --- a/docs/reference/api/IndicesAnalyzeExplainAnalyzeToken.md +++ b/docs/reference/api/IndicesAnalyzeExplainAnalyzeToken.md @@ -1,4 +1,4 @@ -## `IndicesAnalyzeExplainAnalyzeToken` -::: +# `IndicesAnalyzeExplainAnalyzeToken` [alias-IndicesAnalyzeExplainAnalyzeToken] +```typescript type IndicesAnalyzeExplainAnalyzeToken = [IndicesAnalyzeExplainAnalyzeTokenKeys](./IndicesAnalyzeExplainAnalyzeTokenKeys.md) & { [property: string]: any;}; -::: +``` diff --git a/docs/reference/api/IndicesAnalyzeExplainAnalyzeTokenKeys.md b/docs/reference/api/IndicesAnalyzeExplainAnalyzeTokenKeys.md index 13d3cf170..e74770cc9 100644 --- a/docs/reference/api/IndicesAnalyzeExplainAnalyzeTokenKeys.md +++ b/docs/reference/api/IndicesAnalyzeExplainAnalyzeTokenKeys.md @@ -1,4 +1,4 @@ -## Interface `IndicesAnalyzeExplainAnalyzeTokenKeys` +# `IndicesAnalyzeExplainAnalyzeTokenKeys` [interface-IndicesAnalyzeExplainAnalyzeTokenKeys] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesAnalyzeRequest.md b/docs/reference/api/IndicesAnalyzeRequest.md index 50cba70c5..46ac05ec2 100644 --- a/docs/reference/api/IndicesAnalyzeRequest.md +++ b/docs/reference/api/IndicesAnalyzeRequest.md @@ -1,4 +1,4 @@ -## Interface `IndicesAnalyzeRequest` +# `IndicesAnalyzeRequest` [interface-IndicesAnalyzeRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesAnalyzeResponse.md b/docs/reference/api/IndicesAnalyzeResponse.md index f2d100d0c..991c6a567 100644 --- a/docs/reference/api/IndicesAnalyzeResponse.md +++ b/docs/reference/api/IndicesAnalyzeResponse.md @@ -1,4 +1,4 @@ -## Interface `IndicesAnalyzeResponse` +# `IndicesAnalyzeResponse` [interface-IndicesAnalyzeResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesAnalyzeTextToAnalyze.md b/docs/reference/api/IndicesAnalyzeTextToAnalyze.md index 40cea9ed8..1ad548254 100644 --- a/docs/reference/api/IndicesAnalyzeTextToAnalyze.md +++ b/docs/reference/api/IndicesAnalyzeTextToAnalyze.md @@ -1,4 +1,4 @@ -## `IndicesAnalyzeTextToAnalyze` -::: +# `IndicesAnalyzeTextToAnalyze` [alias-IndicesAnalyzeTextToAnalyze] +```typescript type IndicesAnalyzeTextToAnalyze = string | string[]; -::: +``` diff --git a/docs/reference/api/IndicesAnalyzeTokenDetail.md b/docs/reference/api/IndicesAnalyzeTokenDetail.md index 6c7afa2c7..1559b8597 100644 --- a/docs/reference/api/IndicesAnalyzeTokenDetail.md +++ b/docs/reference/api/IndicesAnalyzeTokenDetail.md @@ -1,4 +1,4 @@ -## Interface `IndicesAnalyzeTokenDetail` +# `IndicesAnalyzeTokenDetail` [interface-IndicesAnalyzeTokenDetail] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesCacheQueries.md b/docs/reference/api/IndicesCacheQueries.md index 1f2869a06..32f214904 100644 --- a/docs/reference/api/IndicesCacheQueries.md +++ b/docs/reference/api/IndicesCacheQueries.md @@ -1,4 +1,4 @@ -## Interface `IndicesCacheQueries` +# `IndicesCacheQueries` [interface-IndicesCacheQueries] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesCancelMigrateReindexRequest.md b/docs/reference/api/IndicesCancelMigrateReindexRequest.md index 3b4ee3f8a..480a70c7f 100644 --- a/docs/reference/api/IndicesCancelMigrateReindexRequest.md +++ b/docs/reference/api/IndicesCancelMigrateReindexRequest.md @@ -1,4 +1,4 @@ -## Interface `IndicesCancelMigrateReindexRequest` +# `IndicesCancelMigrateReindexRequest` [interface-IndicesCancelMigrateReindexRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesCancelMigrateReindexResponse.md b/docs/reference/api/IndicesCancelMigrateReindexResponse.md index 4400f14aa..5eb017aec 100644 --- a/docs/reference/api/IndicesCancelMigrateReindexResponse.md +++ b/docs/reference/api/IndicesCancelMigrateReindexResponse.md @@ -1,4 +1,4 @@ -## `IndicesCancelMigrateReindexResponse` -::: +# `IndicesCancelMigrateReindexResponse` [alias-IndicesCancelMigrateReindexResponse] +```typescript type IndicesCancelMigrateReindexResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); -::: +``` diff --git a/docs/reference/api/IndicesClearCacheRequest.md b/docs/reference/api/IndicesClearCacheRequest.md index d3b5c0f8f..965562270 100644 --- a/docs/reference/api/IndicesClearCacheRequest.md +++ b/docs/reference/api/IndicesClearCacheRequest.md @@ -1,4 +1,4 @@ -## Interface `IndicesClearCacheRequest` +# `IndicesClearCacheRequest` [interface-IndicesClearCacheRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesClearCacheResponse.md b/docs/reference/api/IndicesClearCacheResponse.md index 7f84c9895..5b40eb031 100644 --- a/docs/reference/api/IndicesClearCacheResponse.md +++ b/docs/reference/api/IndicesClearCacheResponse.md @@ -1,4 +1,4 @@ -## `IndicesClearCacheResponse` -::: +# `IndicesClearCacheResponse` [alias-IndicesClearCacheResponse] +```typescript type IndicesClearCacheResponse = [ShardsOperationResponseBase](./ShardsOperationResponseBase.md); -::: +``` diff --git a/docs/reference/api/IndicesCloneRequest.md b/docs/reference/api/IndicesCloneRequest.md index 77fbf1ddf..1e27a42e4 100644 --- a/docs/reference/api/IndicesCloneRequest.md +++ b/docs/reference/api/IndicesCloneRequest.md @@ -1,4 +1,4 @@ -## Interface `IndicesCloneRequest` +# `IndicesCloneRequest` [interface-IndicesCloneRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesCloneResponse.md b/docs/reference/api/IndicesCloneResponse.md index 6b10e5a56..9e8e001eb 100644 --- a/docs/reference/api/IndicesCloneResponse.md +++ b/docs/reference/api/IndicesCloneResponse.md @@ -1,4 +1,4 @@ -## Interface `IndicesCloneResponse` +# `IndicesCloneResponse` [interface-IndicesCloneResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesCloseCloseIndexResult.md b/docs/reference/api/IndicesCloseCloseIndexResult.md index 411ab4cb3..769cdc09b 100644 --- a/docs/reference/api/IndicesCloseCloseIndexResult.md +++ b/docs/reference/api/IndicesCloseCloseIndexResult.md @@ -1,4 +1,4 @@ -## Interface `IndicesCloseCloseIndexResult` +# `IndicesCloseCloseIndexResult` [interface-IndicesCloseCloseIndexResult] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesCloseCloseShardResult.md b/docs/reference/api/IndicesCloseCloseShardResult.md index 3e076a469..e6deaeffc 100644 --- a/docs/reference/api/IndicesCloseCloseShardResult.md +++ b/docs/reference/api/IndicesCloseCloseShardResult.md @@ -1,4 +1,4 @@ -## Interface `IndicesCloseCloseShardResult` +# `IndicesCloseCloseShardResult` [interface-IndicesCloseCloseShardResult] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesCloseRequest.md b/docs/reference/api/IndicesCloseRequest.md index 455bcd46e..e3607c620 100644 --- a/docs/reference/api/IndicesCloseRequest.md +++ b/docs/reference/api/IndicesCloseRequest.md @@ -1,4 +1,4 @@ -## Interface `IndicesCloseRequest` +# `IndicesCloseRequest` [interface-IndicesCloseRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesCloseResponse.md b/docs/reference/api/IndicesCloseResponse.md index 1fe3cd022..f607f2209 100644 --- a/docs/reference/api/IndicesCloseResponse.md +++ b/docs/reference/api/IndicesCloseResponse.md @@ -1,4 +1,4 @@ -## Interface `IndicesCloseResponse` +# `IndicesCloseResponse` [interface-IndicesCloseResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesCreateDataStreamRequest.md b/docs/reference/api/IndicesCreateDataStreamRequest.md index 5f7c0bba3..553bb7900 100644 --- a/docs/reference/api/IndicesCreateDataStreamRequest.md +++ b/docs/reference/api/IndicesCreateDataStreamRequest.md @@ -1,4 +1,4 @@ -## Interface `IndicesCreateDataStreamRequest` +# `IndicesCreateDataStreamRequest` [interface-IndicesCreateDataStreamRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesCreateDataStreamResponse.md b/docs/reference/api/IndicesCreateDataStreamResponse.md index a3878b37f..b034b0236 100644 --- a/docs/reference/api/IndicesCreateDataStreamResponse.md +++ b/docs/reference/api/IndicesCreateDataStreamResponse.md @@ -1,4 +1,4 @@ -## `IndicesCreateDataStreamResponse` -::: +# `IndicesCreateDataStreamResponse` [alias-IndicesCreateDataStreamResponse] +```typescript type IndicesCreateDataStreamResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); -::: +``` diff --git a/docs/reference/api/IndicesCreateFromCreateFrom.md b/docs/reference/api/IndicesCreateFromCreateFrom.md index e4d66706e..3c5bc140e 100644 --- a/docs/reference/api/IndicesCreateFromCreateFrom.md +++ b/docs/reference/api/IndicesCreateFromCreateFrom.md @@ -1,4 +1,4 @@ -## Interface `IndicesCreateFromCreateFrom` +# `IndicesCreateFromCreateFrom` [interface-IndicesCreateFromCreateFrom] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesCreateFromRequest.md b/docs/reference/api/IndicesCreateFromRequest.md index 0b7911190..fb3e3a82e 100644 --- a/docs/reference/api/IndicesCreateFromRequest.md +++ b/docs/reference/api/IndicesCreateFromRequest.md @@ -1,4 +1,4 @@ -## Interface `IndicesCreateFromRequest` +# `IndicesCreateFromRequest` [interface-IndicesCreateFromRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesCreateFromResponse.md b/docs/reference/api/IndicesCreateFromResponse.md index a6109d74c..17ba39669 100644 --- a/docs/reference/api/IndicesCreateFromResponse.md +++ b/docs/reference/api/IndicesCreateFromResponse.md @@ -1,4 +1,4 @@ -## Interface `IndicesCreateFromResponse` +# `IndicesCreateFromResponse` [interface-IndicesCreateFromResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesCreateRequest.md b/docs/reference/api/IndicesCreateRequest.md index 6f92ad3ae..b7bc3b90d 100644 --- a/docs/reference/api/IndicesCreateRequest.md +++ b/docs/reference/api/IndicesCreateRequest.md @@ -1,4 +1,4 @@ -## Interface `IndicesCreateRequest` +# `IndicesCreateRequest` [interface-IndicesCreateRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesCreateResponse.md b/docs/reference/api/IndicesCreateResponse.md index 7fde4b3ab..ec8e81d62 100644 --- a/docs/reference/api/IndicesCreateResponse.md +++ b/docs/reference/api/IndicesCreateResponse.md @@ -1,4 +1,4 @@ -## Interface `IndicesCreateResponse` +# `IndicesCreateResponse` [interface-IndicesCreateResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesDataStream.md b/docs/reference/api/IndicesDataStream.md index 278775db4..577d183b9 100644 --- a/docs/reference/api/IndicesDataStream.md +++ b/docs/reference/api/IndicesDataStream.md @@ -1,4 +1,4 @@ -## Interface `IndicesDataStream` +# `IndicesDataStream` [interface-IndicesDataStream] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesDataStreamIndex.md b/docs/reference/api/IndicesDataStreamIndex.md index ca2f458cf..ba4ee4c75 100644 --- a/docs/reference/api/IndicesDataStreamIndex.md +++ b/docs/reference/api/IndicesDataStreamIndex.md @@ -1,4 +1,4 @@ -## Interface `IndicesDataStreamIndex` +# `IndicesDataStreamIndex` [interface-IndicesDataStreamIndex] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesDataStreamLifecycle.md b/docs/reference/api/IndicesDataStreamLifecycle.md index 5470b280a..c16bccff1 100644 --- a/docs/reference/api/IndicesDataStreamLifecycle.md +++ b/docs/reference/api/IndicesDataStreamLifecycle.md @@ -1,4 +1,4 @@ -## Interface `IndicesDataStreamLifecycle` +# `IndicesDataStreamLifecycle` [interface-IndicesDataStreamLifecycle] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesDataStreamLifecycleDownsampling.md b/docs/reference/api/IndicesDataStreamLifecycleDownsampling.md index 75571e8b7..338e7903a 100644 --- a/docs/reference/api/IndicesDataStreamLifecycleDownsampling.md +++ b/docs/reference/api/IndicesDataStreamLifecycleDownsampling.md @@ -1,4 +1,4 @@ -## Interface `IndicesDataStreamLifecycleDownsampling` +# `IndicesDataStreamLifecycleDownsampling` [interface-IndicesDataStreamLifecycleDownsampling] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesDataStreamLifecycleRolloverConditions.md b/docs/reference/api/IndicesDataStreamLifecycleRolloverConditions.md index 78cc670b3..56b5e5f21 100644 --- a/docs/reference/api/IndicesDataStreamLifecycleRolloverConditions.md +++ b/docs/reference/api/IndicesDataStreamLifecycleRolloverConditions.md @@ -1,4 +1,4 @@ -## Interface `IndicesDataStreamLifecycleRolloverConditions` +# `IndicesDataStreamLifecycleRolloverConditions` [interface-IndicesDataStreamLifecycleRolloverConditions] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesDataStreamLifecycleWithRollover.md b/docs/reference/api/IndicesDataStreamLifecycleWithRollover.md index e1e761d80..9dc6dd63d 100644 --- a/docs/reference/api/IndicesDataStreamLifecycleWithRollover.md +++ b/docs/reference/api/IndicesDataStreamLifecycleWithRollover.md @@ -1,4 +1,4 @@ -## Interface `IndicesDataStreamLifecycleWithRollover` +# `IndicesDataStreamLifecycleWithRollover` [interface-IndicesDataStreamLifecycleWithRollover] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesDataStreamTimestampField.md b/docs/reference/api/IndicesDataStreamTimestampField.md index 83cf29de5..21daa2e48 100644 --- a/docs/reference/api/IndicesDataStreamTimestampField.md +++ b/docs/reference/api/IndicesDataStreamTimestampField.md @@ -1,4 +1,4 @@ -## Interface `IndicesDataStreamTimestampField` +# `IndicesDataStreamTimestampField` [interface-IndicesDataStreamTimestampField] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesDataStreamVisibility.md b/docs/reference/api/IndicesDataStreamVisibility.md index 63aeb9025..36fc5a3ed 100644 --- a/docs/reference/api/IndicesDataStreamVisibility.md +++ b/docs/reference/api/IndicesDataStreamVisibility.md @@ -1,4 +1,4 @@ -## Interface `IndicesDataStreamVisibility` +# `IndicesDataStreamVisibility` [interface-IndicesDataStreamVisibility] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesDataStreamsStatsDataStreamsStatsItem.md b/docs/reference/api/IndicesDataStreamsStatsDataStreamsStatsItem.md index e4f23b012..978ada98e 100644 --- a/docs/reference/api/IndicesDataStreamsStatsDataStreamsStatsItem.md +++ b/docs/reference/api/IndicesDataStreamsStatsDataStreamsStatsItem.md @@ -1,4 +1,4 @@ -## Interface `IndicesDataStreamsStatsDataStreamsStatsItem` +# `IndicesDataStreamsStatsDataStreamsStatsItem` [interface-IndicesDataStreamsStatsDataStreamsStatsItem] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesDataStreamsStatsRequest.md b/docs/reference/api/IndicesDataStreamsStatsRequest.md index 6a3dcdc35..62bce840a 100644 --- a/docs/reference/api/IndicesDataStreamsStatsRequest.md +++ b/docs/reference/api/IndicesDataStreamsStatsRequest.md @@ -1,4 +1,4 @@ -## Interface `IndicesDataStreamsStatsRequest` +# `IndicesDataStreamsStatsRequest` [interface-IndicesDataStreamsStatsRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesDataStreamsStatsResponse.md b/docs/reference/api/IndicesDataStreamsStatsResponse.md index 3f09cf17c..2ce884577 100644 --- a/docs/reference/api/IndicesDataStreamsStatsResponse.md +++ b/docs/reference/api/IndicesDataStreamsStatsResponse.md @@ -1,4 +1,4 @@ -## Interface `IndicesDataStreamsStatsResponse` +# `IndicesDataStreamsStatsResponse` [interface-IndicesDataStreamsStatsResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesDeleteAliasRequest.md b/docs/reference/api/IndicesDeleteAliasRequest.md index 1a595d979..5888f449c 100644 --- a/docs/reference/api/IndicesDeleteAliasRequest.md +++ b/docs/reference/api/IndicesDeleteAliasRequest.md @@ -1,4 +1,4 @@ -## Interface `IndicesDeleteAliasRequest` +# `IndicesDeleteAliasRequest` [interface-IndicesDeleteAliasRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesDeleteAliasResponse.md b/docs/reference/api/IndicesDeleteAliasResponse.md index c074f4d05..f5bc4577e 100644 --- a/docs/reference/api/IndicesDeleteAliasResponse.md +++ b/docs/reference/api/IndicesDeleteAliasResponse.md @@ -1,4 +1,4 @@ -## `IndicesDeleteAliasResponse` -::: +# `IndicesDeleteAliasResponse` [alias-IndicesDeleteAliasResponse] +```typescript type IndicesDeleteAliasResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); -::: +``` diff --git a/docs/reference/api/IndicesDeleteDataLifecycleRequest.md b/docs/reference/api/IndicesDeleteDataLifecycleRequest.md index dfcbc592c..b04d343da 100644 --- a/docs/reference/api/IndicesDeleteDataLifecycleRequest.md +++ b/docs/reference/api/IndicesDeleteDataLifecycleRequest.md @@ -1,4 +1,4 @@ -## Interface `IndicesDeleteDataLifecycleRequest` +# `IndicesDeleteDataLifecycleRequest` [interface-IndicesDeleteDataLifecycleRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesDeleteDataLifecycleResponse.md b/docs/reference/api/IndicesDeleteDataLifecycleResponse.md index 36c26832e..a7e89fe67 100644 --- a/docs/reference/api/IndicesDeleteDataLifecycleResponse.md +++ b/docs/reference/api/IndicesDeleteDataLifecycleResponse.md @@ -1,4 +1,4 @@ -## `IndicesDeleteDataLifecycleResponse` -::: +# `IndicesDeleteDataLifecycleResponse` [alias-IndicesDeleteDataLifecycleResponse] +```typescript type IndicesDeleteDataLifecycleResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); -::: +``` diff --git a/docs/reference/api/IndicesDeleteDataStreamRequest.md b/docs/reference/api/IndicesDeleteDataStreamRequest.md index 741fa3bb8..82f821c8a 100644 --- a/docs/reference/api/IndicesDeleteDataStreamRequest.md +++ b/docs/reference/api/IndicesDeleteDataStreamRequest.md @@ -1,4 +1,4 @@ -## Interface `IndicesDeleteDataStreamRequest` +# `IndicesDeleteDataStreamRequest` [interface-IndicesDeleteDataStreamRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesDeleteDataStreamResponse.md b/docs/reference/api/IndicesDeleteDataStreamResponse.md index d42ccd1de..0ae4d74d8 100644 --- a/docs/reference/api/IndicesDeleteDataStreamResponse.md +++ b/docs/reference/api/IndicesDeleteDataStreamResponse.md @@ -1,4 +1,4 @@ -## `IndicesDeleteDataStreamResponse` -::: +# `IndicesDeleteDataStreamResponse` [alias-IndicesDeleteDataStreamResponse] +```typescript type IndicesDeleteDataStreamResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); -::: +``` diff --git a/docs/reference/api/IndicesDeleteIndexTemplateRequest.md b/docs/reference/api/IndicesDeleteIndexTemplateRequest.md index c7b8f0116..c537da001 100644 --- a/docs/reference/api/IndicesDeleteIndexTemplateRequest.md +++ b/docs/reference/api/IndicesDeleteIndexTemplateRequest.md @@ -1,4 +1,4 @@ -## Interface `IndicesDeleteIndexTemplateRequest` +# `IndicesDeleteIndexTemplateRequest` [interface-IndicesDeleteIndexTemplateRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesDeleteIndexTemplateResponse.md b/docs/reference/api/IndicesDeleteIndexTemplateResponse.md index 32604b0fb..645dd511e 100644 --- a/docs/reference/api/IndicesDeleteIndexTemplateResponse.md +++ b/docs/reference/api/IndicesDeleteIndexTemplateResponse.md @@ -1,4 +1,4 @@ -## `IndicesDeleteIndexTemplateResponse` -::: +# `IndicesDeleteIndexTemplateResponse` [alias-IndicesDeleteIndexTemplateResponse] +```typescript type IndicesDeleteIndexTemplateResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); -::: +``` diff --git a/docs/reference/api/IndicesDeleteRequest.md b/docs/reference/api/IndicesDeleteRequest.md index 20c8da195..18daaea91 100644 --- a/docs/reference/api/IndicesDeleteRequest.md +++ b/docs/reference/api/IndicesDeleteRequest.md @@ -1,4 +1,4 @@ -## Interface `IndicesDeleteRequest` +# `IndicesDeleteRequest` [interface-IndicesDeleteRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesDeleteResponse.md b/docs/reference/api/IndicesDeleteResponse.md index 38306e11c..2ced79fdf 100644 --- a/docs/reference/api/IndicesDeleteResponse.md +++ b/docs/reference/api/IndicesDeleteResponse.md @@ -1,4 +1,4 @@ -## `IndicesDeleteResponse` -::: +# `IndicesDeleteResponse` [alias-IndicesDeleteResponse] +```typescript type IndicesDeleteResponse = [IndicesResponseBase](./IndicesResponseBase.md); -::: +``` diff --git a/docs/reference/api/IndicesDeleteTemplateRequest.md b/docs/reference/api/IndicesDeleteTemplateRequest.md index ccbfffb58..3b2b50110 100644 --- a/docs/reference/api/IndicesDeleteTemplateRequest.md +++ b/docs/reference/api/IndicesDeleteTemplateRequest.md @@ -1,4 +1,4 @@ -## Interface `IndicesDeleteTemplateRequest` +# `IndicesDeleteTemplateRequest` [interface-IndicesDeleteTemplateRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesDeleteTemplateResponse.md b/docs/reference/api/IndicesDeleteTemplateResponse.md index f20fcbb94..1842d12c2 100644 --- a/docs/reference/api/IndicesDeleteTemplateResponse.md +++ b/docs/reference/api/IndicesDeleteTemplateResponse.md @@ -1,4 +1,4 @@ -## `IndicesDeleteTemplateResponse` -::: +# `IndicesDeleteTemplateResponse` [alias-IndicesDeleteTemplateResponse] +```typescript type IndicesDeleteTemplateResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); -::: +``` diff --git a/docs/reference/api/IndicesDiskUsageRequest.md b/docs/reference/api/IndicesDiskUsageRequest.md index b63be1c3b..5b1839592 100644 --- a/docs/reference/api/IndicesDiskUsageRequest.md +++ b/docs/reference/api/IndicesDiskUsageRequest.md @@ -1,4 +1,4 @@ -## Interface `IndicesDiskUsageRequest` +# `IndicesDiskUsageRequest` [interface-IndicesDiskUsageRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesDiskUsageResponse.md b/docs/reference/api/IndicesDiskUsageResponse.md index 72c2e669b..008a3e157 100644 --- a/docs/reference/api/IndicesDiskUsageResponse.md +++ b/docs/reference/api/IndicesDiskUsageResponse.md @@ -1,4 +1,4 @@ -## `IndicesDiskUsageResponse` -::: +# `IndicesDiskUsageResponse` [alias-IndicesDiskUsageResponse] +```typescript type IndicesDiskUsageResponse = any; -::: +``` diff --git a/docs/reference/api/IndicesDownsampleConfig.md b/docs/reference/api/IndicesDownsampleConfig.md index a61c8879f..b02496bd5 100644 --- a/docs/reference/api/IndicesDownsampleConfig.md +++ b/docs/reference/api/IndicesDownsampleConfig.md @@ -1,4 +1,4 @@ -## Interface `IndicesDownsampleConfig` +# `IndicesDownsampleConfig` [interface-IndicesDownsampleConfig] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesDownsampleRequest.md b/docs/reference/api/IndicesDownsampleRequest.md index c3f929ca9..b5a9de779 100644 --- a/docs/reference/api/IndicesDownsampleRequest.md +++ b/docs/reference/api/IndicesDownsampleRequest.md @@ -1,4 +1,4 @@ -## Interface `IndicesDownsampleRequest` +# `IndicesDownsampleRequest` [interface-IndicesDownsampleRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesDownsampleResponse.md b/docs/reference/api/IndicesDownsampleResponse.md index df619f247..a4b605c46 100644 --- a/docs/reference/api/IndicesDownsampleResponse.md +++ b/docs/reference/api/IndicesDownsampleResponse.md @@ -1,4 +1,4 @@ -## `IndicesDownsampleResponse` -::: +# `IndicesDownsampleResponse` [alias-IndicesDownsampleResponse] +```typescript type IndicesDownsampleResponse = any; -::: +``` diff --git a/docs/reference/api/IndicesDownsamplingRound.md b/docs/reference/api/IndicesDownsamplingRound.md index d97366871..896bde46c 100644 --- a/docs/reference/api/IndicesDownsamplingRound.md +++ b/docs/reference/api/IndicesDownsamplingRound.md @@ -1,4 +1,4 @@ -## Interface `IndicesDownsamplingRound` +# `IndicesDownsamplingRound` [interface-IndicesDownsamplingRound] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesExistsAliasRequest.md b/docs/reference/api/IndicesExistsAliasRequest.md index abff5fb58..0fe454eb0 100644 --- a/docs/reference/api/IndicesExistsAliasRequest.md +++ b/docs/reference/api/IndicesExistsAliasRequest.md @@ -1,4 +1,4 @@ -## Interface `IndicesExistsAliasRequest` +# `IndicesExistsAliasRequest` [interface-IndicesExistsAliasRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesExistsAliasResponse.md b/docs/reference/api/IndicesExistsAliasResponse.md index bfd8d6c4d..68a1e95a1 100644 --- a/docs/reference/api/IndicesExistsAliasResponse.md +++ b/docs/reference/api/IndicesExistsAliasResponse.md @@ -1,4 +1,4 @@ -## `IndicesExistsAliasResponse` -::: +# `IndicesExistsAliasResponse` [alias-IndicesExistsAliasResponse] +```typescript type IndicesExistsAliasResponse = boolean; -::: +``` diff --git a/docs/reference/api/IndicesExistsIndexTemplateRequest.md b/docs/reference/api/IndicesExistsIndexTemplateRequest.md index 89f8361d2..0af9b7a5c 100644 --- a/docs/reference/api/IndicesExistsIndexTemplateRequest.md +++ b/docs/reference/api/IndicesExistsIndexTemplateRequest.md @@ -1,4 +1,4 @@ -## Interface `IndicesExistsIndexTemplateRequest` +# `IndicesExistsIndexTemplateRequest` [interface-IndicesExistsIndexTemplateRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesExistsIndexTemplateResponse.md b/docs/reference/api/IndicesExistsIndexTemplateResponse.md index 841a0d313..3958efc72 100644 --- a/docs/reference/api/IndicesExistsIndexTemplateResponse.md +++ b/docs/reference/api/IndicesExistsIndexTemplateResponse.md @@ -1,4 +1,4 @@ -## `IndicesExistsIndexTemplateResponse` -::: +# `IndicesExistsIndexTemplateResponse` [alias-IndicesExistsIndexTemplateResponse] +```typescript type IndicesExistsIndexTemplateResponse = boolean; -::: +``` diff --git a/docs/reference/api/IndicesExistsRequest.md b/docs/reference/api/IndicesExistsRequest.md index 8181048a6..f83cabff9 100644 --- a/docs/reference/api/IndicesExistsRequest.md +++ b/docs/reference/api/IndicesExistsRequest.md @@ -1,4 +1,4 @@ -## Interface `IndicesExistsRequest` +# `IndicesExistsRequest` [interface-IndicesExistsRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesExistsResponse.md b/docs/reference/api/IndicesExistsResponse.md index 4da8d3ec1..073817a8a 100644 --- a/docs/reference/api/IndicesExistsResponse.md +++ b/docs/reference/api/IndicesExistsResponse.md @@ -1,4 +1,4 @@ -## `IndicesExistsResponse` -::: +# `IndicesExistsResponse` [alias-IndicesExistsResponse] +```typescript type IndicesExistsResponse = boolean; -::: +``` diff --git a/docs/reference/api/IndicesExistsTemplateRequest.md b/docs/reference/api/IndicesExistsTemplateRequest.md index 160b87179..d1b5c8aab 100644 --- a/docs/reference/api/IndicesExistsTemplateRequest.md +++ b/docs/reference/api/IndicesExistsTemplateRequest.md @@ -1,4 +1,4 @@ -## Interface `IndicesExistsTemplateRequest` +# `IndicesExistsTemplateRequest` [interface-IndicesExistsTemplateRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesExistsTemplateResponse.md b/docs/reference/api/IndicesExistsTemplateResponse.md index 8c2766bdd..3aea188e9 100644 --- a/docs/reference/api/IndicesExistsTemplateResponse.md +++ b/docs/reference/api/IndicesExistsTemplateResponse.md @@ -1,4 +1,4 @@ -## `IndicesExistsTemplateResponse` -::: +# `IndicesExistsTemplateResponse` [alias-IndicesExistsTemplateResponse] +```typescript type IndicesExistsTemplateResponse = boolean; -::: +``` diff --git a/docs/reference/api/IndicesExplainDataLifecycleDataStreamLifecycleExplain.md b/docs/reference/api/IndicesExplainDataLifecycleDataStreamLifecycleExplain.md index 2b9c96b20..d804f21d2 100644 --- a/docs/reference/api/IndicesExplainDataLifecycleDataStreamLifecycleExplain.md +++ b/docs/reference/api/IndicesExplainDataLifecycleDataStreamLifecycleExplain.md @@ -1,4 +1,4 @@ -## Interface `IndicesExplainDataLifecycleDataStreamLifecycleExplain` +# `IndicesExplainDataLifecycleDataStreamLifecycleExplain` [interface-IndicesExplainDataLifecycleDataStreamLifecycleExplain] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesExplainDataLifecycleRequest.md b/docs/reference/api/IndicesExplainDataLifecycleRequest.md index 591a82aaf..c50ab774e 100644 --- a/docs/reference/api/IndicesExplainDataLifecycleRequest.md +++ b/docs/reference/api/IndicesExplainDataLifecycleRequest.md @@ -1,4 +1,4 @@ -## Interface `IndicesExplainDataLifecycleRequest` +# `IndicesExplainDataLifecycleRequest` [interface-IndicesExplainDataLifecycleRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesExplainDataLifecycleResponse.md b/docs/reference/api/IndicesExplainDataLifecycleResponse.md index 2d56252bd..8e3ba0a37 100644 --- a/docs/reference/api/IndicesExplainDataLifecycleResponse.md +++ b/docs/reference/api/IndicesExplainDataLifecycleResponse.md @@ -1,4 +1,4 @@ -## Interface `IndicesExplainDataLifecycleResponse` +# `IndicesExplainDataLifecycleResponse` [interface-IndicesExplainDataLifecycleResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesFailureStore.md b/docs/reference/api/IndicesFailureStore.md index 3600aad54..bca727f4f 100644 --- a/docs/reference/api/IndicesFailureStore.md +++ b/docs/reference/api/IndicesFailureStore.md @@ -1,4 +1,4 @@ -## Interface `IndicesFailureStore` +# `IndicesFailureStore` [interface-IndicesFailureStore] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesFieldUsageStatsFieldSummary.md b/docs/reference/api/IndicesFieldUsageStatsFieldSummary.md index e807e44bd..5d0e0782f 100644 --- a/docs/reference/api/IndicesFieldUsageStatsFieldSummary.md +++ b/docs/reference/api/IndicesFieldUsageStatsFieldSummary.md @@ -1,4 +1,4 @@ -## Interface `IndicesFieldUsageStatsFieldSummary` +# `IndicesFieldUsageStatsFieldSummary` [interface-IndicesFieldUsageStatsFieldSummary] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesFieldUsageStatsFieldsUsageBody.md b/docs/reference/api/IndicesFieldUsageStatsFieldsUsageBody.md index 4ac997e9e..8f91edb0f 100644 --- a/docs/reference/api/IndicesFieldUsageStatsFieldsUsageBody.md +++ b/docs/reference/api/IndicesFieldUsageStatsFieldsUsageBody.md @@ -1,4 +1,4 @@ -## `IndicesFieldUsageStatsFieldsUsageBody` -::: +# `IndicesFieldUsageStatsFieldsUsageBody` [alias-IndicesFieldUsageStatsFieldsUsageBody] +```typescript type IndicesFieldUsageStatsFieldsUsageBody = [IndicesFieldUsageStatsFieldsUsageBodyKeys](./IndicesFieldUsageStatsFieldsUsageBodyKeys.md) & { [property: string]: [IndicesFieldUsageStatsUsageStatsIndex](./IndicesFieldUsageStatsUsageStatsIndex.md) | [ShardStatistics](./ShardStatistics.md);}; -::: +``` diff --git a/docs/reference/api/IndicesFieldUsageStatsFieldsUsageBodyKeys.md b/docs/reference/api/IndicesFieldUsageStatsFieldsUsageBodyKeys.md index 73aa6dfd2..2f3b0b51c 100644 --- a/docs/reference/api/IndicesFieldUsageStatsFieldsUsageBodyKeys.md +++ b/docs/reference/api/IndicesFieldUsageStatsFieldsUsageBodyKeys.md @@ -1,4 +1,4 @@ -## Interface `IndicesFieldUsageStatsFieldsUsageBodyKeys` +# `IndicesFieldUsageStatsFieldsUsageBodyKeys` [interface-IndicesFieldUsageStatsFieldsUsageBodyKeys] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesFieldUsageStatsInvertedIndex.md b/docs/reference/api/IndicesFieldUsageStatsInvertedIndex.md index 707ff2085..5feb30bff 100644 --- a/docs/reference/api/IndicesFieldUsageStatsInvertedIndex.md +++ b/docs/reference/api/IndicesFieldUsageStatsInvertedIndex.md @@ -1,4 +1,4 @@ -## Interface `IndicesFieldUsageStatsInvertedIndex` +# `IndicesFieldUsageStatsInvertedIndex` [interface-IndicesFieldUsageStatsInvertedIndex] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesFieldUsageStatsRequest.md b/docs/reference/api/IndicesFieldUsageStatsRequest.md index 977182324..fad07a54c 100644 --- a/docs/reference/api/IndicesFieldUsageStatsRequest.md +++ b/docs/reference/api/IndicesFieldUsageStatsRequest.md @@ -1,4 +1,4 @@ -## Interface `IndicesFieldUsageStatsRequest` +# `IndicesFieldUsageStatsRequest` [interface-IndicesFieldUsageStatsRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesFieldUsageStatsResponse.md b/docs/reference/api/IndicesFieldUsageStatsResponse.md index 47e35c067..4f6ea9d89 100644 --- a/docs/reference/api/IndicesFieldUsageStatsResponse.md +++ b/docs/reference/api/IndicesFieldUsageStatsResponse.md @@ -1,4 +1,4 @@ -## `IndicesFieldUsageStatsResponse` -::: +# `IndicesFieldUsageStatsResponse` [alias-IndicesFieldUsageStatsResponse] +```typescript type IndicesFieldUsageStatsResponse = [IndicesFieldUsageStatsFieldsUsageBody](./IndicesFieldUsageStatsFieldsUsageBody.md); -::: +``` diff --git a/docs/reference/api/IndicesFieldUsageStatsShardsStats.md b/docs/reference/api/IndicesFieldUsageStatsShardsStats.md index 1d072a114..b7a887605 100644 --- a/docs/reference/api/IndicesFieldUsageStatsShardsStats.md +++ b/docs/reference/api/IndicesFieldUsageStatsShardsStats.md @@ -1,4 +1,4 @@ -## Interface `IndicesFieldUsageStatsShardsStats` +# `IndicesFieldUsageStatsShardsStats` [interface-IndicesFieldUsageStatsShardsStats] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesFieldUsageStatsUsageStatsIndex.md b/docs/reference/api/IndicesFieldUsageStatsUsageStatsIndex.md index 5afbe7133..4e551fb45 100644 --- a/docs/reference/api/IndicesFieldUsageStatsUsageStatsIndex.md +++ b/docs/reference/api/IndicesFieldUsageStatsUsageStatsIndex.md @@ -1,4 +1,4 @@ -## Interface `IndicesFieldUsageStatsUsageStatsIndex` +# `IndicesFieldUsageStatsUsageStatsIndex` [interface-IndicesFieldUsageStatsUsageStatsIndex] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesFieldUsageStatsUsageStatsShards.md b/docs/reference/api/IndicesFieldUsageStatsUsageStatsShards.md index 0cbcd2535..47ac4df23 100644 --- a/docs/reference/api/IndicesFieldUsageStatsUsageStatsShards.md +++ b/docs/reference/api/IndicesFieldUsageStatsUsageStatsShards.md @@ -1,4 +1,4 @@ -## Interface `IndicesFieldUsageStatsUsageStatsShards` +# `IndicesFieldUsageStatsUsageStatsShards` [interface-IndicesFieldUsageStatsUsageStatsShards] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesFielddataFrequencyFilter.md b/docs/reference/api/IndicesFielddataFrequencyFilter.md index c173cd27a..4d6491abd 100644 --- a/docs/reference/api/IndicesFielddataFrequencyFilter.md +++ b/docs/reference/api/IndicesFielddataFrequencyFilter.md @@ -1,4 +1,4 @@ -## Interface `IndicesFielddataFrequencyFilter` +# `IndicesFielddataFrequencyFilter` [interface-IndicesFielddataFrequencyFilter] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesFlushRequest.md b/docs/reference/api/IndicesFlushRequest.md index ab7916ade..b88ba446c 100644 --- a/docs/reference/api/IndicesFlushRequest.md +++ b/docs/reference/api/IndicesFlushRequest.md @@ -1,4 +1,4 @@ -## Interface `IndicesFlushRequest` +# `IndicesFlushRequest` [interface-IndicesFlushRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesFlushResponse.md b/docs/reference/api/IndicesFlushResponse.md index 662224b66..bc08802fc 100644 --- a/docs/reference/api/IndicesFlushResponse.md +++ b/docs/reference/api/IndicesFlushResponse.md @@ -1,4 +1,4 @@ -## `IndicesFlushResponse` -::: +# `IndicesFlushResponse` [alias-IndicesFlushResponse] +```typescript type IndicesFlushResponse = [ShardsOperationResponseBase](./ShardsOperationResponseBase.md); -::: +``` diff --git a/docs/reference/api/IndicesForcemergeForceMergeResponseBody.md b/docs/reference/api/IndicesForcemergeForceMergeResponseBody.md index a9d6e1e4a..6d4da1c0e 100644 --- a/docs/reference/api/IndicesForcemergeForceMergeResponseBody.md +++ b/docs/reference/api/IndicesForcemergeForceMergeResponseBody.md @@ -1,4 +1,4 @@ -## Interface `IndicesForcemergeForceMergeResponseBody` +# `IndicesForcemergeForceMergeResponseBody` [interface-IndicesForcemergeForceMergeResponseBody] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesForcemergeRequest.md b/docs/reference/api/IndicesForcemergeRequest.md index 1f4232788..189581120 100644 --- a/docs/reference/api/IndicesForcemergeRequest.md +++ b/docs/reference/api/IndicesForcemergeRequest.md @@ -1,4 +1,4 @@ -## Interface `IndicesForcemergeRequest` +# `IndicesForcemergeRequest` [interface-IndicesForcemergeRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesForcemergeResponse.md b/docs/reference/api/IndicesForcemergeResponse.md index 5f70ede27..e6a864529 100644 --- a/docs/reference/api/IndicesForcemergeResponse.md +++ b/docs/reference/api/IndicesForcemergeResponse.md @@ -1,4 +1,4 @@ -## `IndicesForcemergeResponse` -::: +# `IndicesForcemergeResponse` [alias-IndicesForcemergeResponse] +```typescript type IndicesForcemergeResponse = [IndicesForcemergeForceMergeResponseBody](./IndicesForcemergeForceMergeResponseBody.md); -::: +``` diff --git a/docs/reference/api/IndicesGetAliasIndexAliases.md b/docs/reference/api/IndicesGetAliasIndexAliases.md index 05b3b332c..920ee791e 100644 --- a/docs/reference/api/IndicesGetAliasIndexAliases.md +++ b/docs/reference/api/IndicesGetAliasIndexAliases.md @@ -1,4 +1,4 @@ -## Interface `IndicesGetAliasIndexAliases` +# `IndicesGetAliasIndexAliases` [interface-IndicesGetAliasIndexAliases] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesGetAliasRequest.md b/docs/reference/api/IndicesGetAliasRequest.md index 76d415f40..f690e05b4 100644 --- a/docs/reference/api/IndicesGetAliasRequest.md +++ b/docs/reference/api/IndicesGetAliasRequest.md @@ -1,4 +1,4 @@ -## Interface `IndicesGetAliasRequest` +# `IndicesGetAliasRequest` [interface-IndicesGetAliasRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesGetAliasResponse.md b/docs/reference/api/IndicesGetAliasResponse.md index 553c42ac3..91c1edcd5 100644 --- a/docs/reference/api/IndicesGetAliasResponse.md +++ b/docs/reference/api/IndicesGetAliasResponse.md @@ -1,4 +1,4 @@ -## `IndicesGetAliasResponse` -::: +# `IndicesGetAliasResponse` [alias-IndicesGetAliasResponse] +```typescript type IndicesGetAliasResponse = Record<[IndexName](./IndexName.md), [IndicesGetAliasIndexAliases](./IndicesGetAliasIndexAliases.md)>; -::: +``` diff --git a/docs/reference/api/IndicesGetDataLifecycleDataStreamWithLifecycle.md b/docs/reference/api/IndicesGetDataLifecycleDataStreamWithLifecycle.md index c674ef1c3..e751283ca 100644 --- a/docs/reference/api/IndicesGetDataLifecycleDataStreamWithLifecycle.md +++ b/docs/reference/api/IndicesGetDataLifecycleDataStreamWithLifecycle.md @@ -1,4 +1,4 @@ -## Interface `IndicesGetDataLifecycleDataStreamWithLifecycle` +# `IndicesGetDataLifecycleDataStreamWithLifecycle` [interface-IndicesGetDataLifecycleDataStreamWithLifecycle] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesGetDataLifecycleRequest.md b/docs/reference/api/IndicesGetDataLifecycleRequest.md index 7d7f87c0d..f45eef91d 100644 --- a/docs/reference/api/IndicesGetDataLifecycleRequest.md +++ b/docs/reference/api/IndicesGetDataLifecycleRequest.md @@ -1,4 +1,4 @@ -## Interface `IndicesGetDataLifecycleRequest` +# `IndicesGetDataLifecycleRequest` [interface-IndicesGetDataLifecycleRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesGetDataLifecycleResponse.md b/docs/reference/api/IndicesGetDataLifecycleResponse.md index e5e64d678..584972f80 100644 --- a/docs/reference/api/IndicesGetDataLifecycleResponse.md +++ b/docs/reference/api/IndicesGetDataLifecycleResponse.md @@ -1,4 +1,4 @@ -## Interface `IndicesGetDataLifecycleResponse` +# `IndicesGetDataLifecycleResponse` [interface-IndicesGetDataLifecycleResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesGetDataLifecycleStatsDataStreamStats.md b/docs/reference/api/IndicesGetDataLifecycleStatsDataStreamStats.md index 56a340996..5f8ab54ee 100644 --- a/docs/reference/api/IndicesGetDataLifecycleStatsDataStreamStats.md +++ b/docs/reference/api/IndicesGetDataLifecycleStatsDataStreamStats.md @@ -1,4 +1,4 @@ -## Interface `IndicesGetDataLifecycleStatsDataStreamStats` +# `IndicesGetDataLifecycleStatsDataStreamStats` [interface-IndicesGetDataLifecycleStatsDataStreamStats] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesGetDataLifecycleStatsRequest.md b/docs/reference/api/IndicesGetDataLifecycleStatsRequest.md index ad413f884..0ddd9c347 100644 --- a/docs/reference/api/IndicesGetDataLifecycleStatsRequest.md +++ b/docs/reference/api/IndicesGetDataLifecycleStatsRequest.md @@ -1,4 +1,4 @@ -## Interface `IndicesGetDataLifecycleStatsRequest` +# `IndicesGetDataLifecycleStatsRequest` [interface-IndicesGetDataLifecycleStatsRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesGetDataLifecycleStatsResponse.md b/docs/reference/api/IndicesGetDataLifecycleStatsResponse.md index f7a69bfb1..dea9a3d03 100644 --- a/docs/reference/api/IndicesGetDataLifecycleStatsResponse.md +++ b/docs/reference/api/IndicesGetDataLifecycleStatsResponse.md @@ -1,4 +1,4 @@ -## Interface `IndicesGetDataLifecycleStatsResponse` +# `IndicesGetDataLifecycleStatsResponse` [interface-IndicesGetDataLifecycleStatsResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesGetDataStreamRequest.md b/docs/reference/api/IndicesGetDataStreamRequest.md index 4ba29cea3..f458667c8 100644 --- a/docs/reference/api/IndicesGetDataStreamRequest.md +++ b/docs/reference/api/IndicesGetDataStreamRequest.md @@ -1,4 +1,4 @@ -## Interface `IndicesGetDataStreamRequest` +# `IndicesGetDataStreamRequest` [interface-IndicesGetDataStreamRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesGetDataStreamResponse.md b/docs/reference/api/IndicesGetDataStreamResponse.md index 6f0da2f2e..33f7dd4bd 100644 --- a/docs/reference/api/IndicesGetDataStreamResponse.md +++ b/docs/reference/api/IndicesGetDataStreamResponse.md @@ -1,4 +1,4 @@ -## Interface `IndicesGetDataStreamResponse` +# `IndicesGetDataStreamResponse` [interface-IndicesGetDataStreamResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesGetFeature.md b/docs/reference/api/IndicesGetFeature.md index b50d4442f..a757f66a7 100644 --- a/docs/reference/api/IndicesGetFeature.md +++ b/docs/reference/api/IndicesGetFeature.md @@ -1,4 +1,4 @@ -## `IndicesGetFeature` -::: +# `IndicesGetFeature` [alias-IndicesGetFeature] +```typescript type IndicesGetFeature = 'aliases' | 'mappings' | 'settings'; -::: +``` diff --git a/docs/reference/api/IndicesGetFeatures.md b/docs/reference/api/IndicesGetFeatures.md index 841ffafc9..b95f5e8a1 100644 --- a/docs/reference/api/IndicesGetFeatures.md +++ b/docs/reference/api/IndicesGetFeatures.md @@ -1,4 +1,4 @@ -## `IndicesGetFeatures` -::: +# `IndicesGetFeatures` [alias-IndicesGetFeatures] +```typescript type IndicesGetFeatures = [IndicesGetFeature](./IndicesGetFeature.md) | [IndicesGetFeature](./IndicesGetFeature.md)[]; -::: +``` diff --git a/docs/reference/api/IndicesGetFieldMappingRequest.md b/docs/reference/api/IndicesGetFieldMappingRequest.md index e980571fe..c241cd9cc 100644 --- a/docs/reference/api/IndicesGetFieldMappingRequest.md +++ b/docs/reference/api/IndicesGetFieldMappingRequest.md @@ -1,4 +1,4 @@ -## Interface `IndicesGetFieldMappingRequest` +# `IndicesGetFieldMappingRequest` [interface-IndicesGetFieldMappingRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesGetFieldMappingResponse.md b/docs/reference/api/IndicesGetFieldMappingResponse.md index ea48b9fd6..19c411f3e 100644 --- a/docs/reference/api/IndicesGetFieldMappingResponse.md +++ b/docs/reference/api/IndicesGetFieldMappingResponse.md @@ -1,4 +1,4 @@ -## `IndicesGetFieldMappingResponse` -::: +# `IndicesGetFieldMappingResponse` [alias-IndicesGetFieldMappingResponse] +```typescript type IndicesGetFieldMappingResponse = Record<[IndexName](./IndexName.md), [IndicesGetFieldMappingTypeFieldMappings](./IndicesGetFieldMappingTypeFieldMappings.md)>; -::: +``` diff --git a/docs/reference/api/IndicesGetFieldMappingTypeFieldMappings.md b/docs/reference/api/IndicesGetFieldMappingTypeFieldMappings.md index 30095a05a..7536b48e8 100644 --- a/docs/reference/api/IndicesGetFieldMappingTypeFieldMappings.md +++ b/docs/reference/api/IndicesGetFieldMappingTypeFieldMappings.md @@ -1,4 +1,4 @@ -## Interface `IndicesGetFieldMappingTypeFieldMappings` +# `IndicesGetFieldMappingTypeFieldMappings` [interface-IndicesGetFieldMappingTypeFieldMappings] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesGetIndexTemplateIndexTemplateItem.md b/docs/reference/api/IndicesGetIndexTemplateIndexTemplateItem.md index 85b677371..d4c8539d6 100644 --- a/docs/reference/api/IndicesGetIndexTemplateIndexTemplateItem.md +++ b/docs/reference/api/IndicesGetIndexTemplateIndexTemplateItem.md @@ -1,4 +1,4 @@ -## Interface `IndicesGetIndexTemplateIndexTemplateItem` +# `IndicesGetIndexTemplateIndexTemplateItem` [interface-IndicesGetIndexTemplateIndexTemplateItem] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesGetIndexTemplateRequest.md b/docs/reference/api/IndicesGetIndexTemplateRequest.md index 979e04a15..ef40ec578 100644 --- a/docs/reference/api/IndicesGetIndexTemplateRequest.md +++ b/docs/reference/api/IndicesGetIndexTemplateRequest.md @@ -1,4 +1,4 @@ -## Interface `IndicesGetIndexTemplateRequest` +# `IndicesGetIndexTemplateRequest` [interface-IndicesGetIndexTemplateRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesGetIndexTemplateResponse.md b/docs/reference/api/IndicesGetIndexTemplateResponse.md index 174dbbfde..c1187ede3 100644 --- a/docs/reference/api/IndicesGetIndexTemplateResponse.md +++ b/docs/reference/api/IndicesGetIndexTemplateResponse.md @@ -1,4 +1,4 @@ -## Interface `IndicesGetIndexTemplateResponse` +# `IndicesGetIndexTemplateResponse` [interface-IndicesGetIndexTemplateResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesGetMappingIndexMappingRecord.md b/docs/reference/api/IndicesGetMappingIndexMappingRecord.md index 0137a713d..b54e87417 100644 --- a/docs/reference/api/IndicesGetMappingIndexMappingRecord.md +++ b/docs/reference/api/IndicesGetMappingIndexMappingRecord.md @@ -1,4 +1,4 @@ -## Interface `IndicesGetMappingIndexMappingRecord` +# `IndicesGetMappingIndexMappingRecord` [interface-IndicesGetMappingIndexMappingRecord] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesGetMappingRequest.md b/docs/reference/api/IndicesGetMappingRequest.md index 0f159b8c9..168d548c8 100644 --- a/docs/reference/api/IndicesGetMappingRequest.md +++ b/docs/reference/api/IndicesGetMappingRequest.md @@ -1,4 +1,4 @@ -## Interface `IndicesGetMappingRequest` +# `IndicesGetMappingRequest` [interface-IndicesGetMappingRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesGetMappingResponse.md b/docs/reference/api/IndicesGetMappingResponse.md index ee2a07b9a..8654ad9f0 100644 --- a/docs/reference/api/IndicesGetMappingResponse.md +++ b/docs/reference/api/IndicesGetMappingResponse.md @@ -1,4 +1,4 @@ -## `IndicesGetMappingResponse` -::: +# `IndicesGetMappingResponse` [alias-IndicesGetMappingResponse] +```typescript type IndicesGetMappingResponse = Record<[IndexName](./IndexName.md), [IndicesGetMappingIndexMappingRecord](./IndicesGetMappingIndexMappingRecord.md)>; -::: +``` diff --git a/docs/reference/api/IndicesGetMigrateReindexStatusRequest.md b/docs/reference/api/IndicesGetMigrateReindexStatusRequest.md index 6968fb202..acbf5be71 100644 --- a/docs/reference/api/IndicesGetMigrateReindexStatusRequest.md +++ b/docs/reference/api/IndicesGetMigrateReindexStatusRequest.md @@ -1,4 +1,4 @@ -## Interface `IndicesGetMigrateReindexStatusRequest` +# `IndicesGetMigrateReindexStatusRequest` [interface-IndicesGetMigrateReindexStatusRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesGetMigrateReindexStatusResponse.md b/docs/reference/api/IndicesGetMigrateReindexStatusResponse.md index 7c644781b..3e505841f 100644 --- a/docs/reference/api/IndicesGetMigrateReindexStatusResponse.md +++ b/docs/reference/api/IndicesGetMigrateReindexStatusResponse.md @@ -1,4 +1,4 @@ -## Interface `IndicesGetMigrateReindexStatusResponse` +# `IndicesGetMigrateReindexStatusResponse` [interface-IndicesGetMigrateReindexStatusResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesGetMigrateReindexStatusStatusError.md b/docs/reference/api/IndicesGetMigrateReindexStatusStatusError.md index 577451aab..27bc23085 100644 --- a/docs/reference/api/IndicesGetMigrateReindexStatusStatusError.md +++ b/docs/reference/api/IndicesGetMigrateReindexStatusStatusError.md @@ -1,4 +1,4 @@ -## Interface `IndicesGetMigrateReindexStatusStatusError` +# `IndicesGetMigrateReindexStatusStatusError` [interface-IndicesGetMigrateReindexStatusStatusError] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesGetMigrateReindexStatusStatusInProgress.md b/docs/reference/api/IndicesGetMigrateReindexStatusStatusInProgress.md index 2cfbadd96..cc3659581 100644 --- a/docs/reference/api/IndicesGetMigrateReindexStatusStatusInProgress.md +++ b/docs/reference/api/IndicesGetMigrateReindexStatusStatusInProgress.md @@ -1,4 +1,4 @@ -## Interface `IndicesGetMigrateReindexStatusStatusInProgress` +# `IndicesGetMigrateReindexStatusStatusInProgress` [interface-IndicesGetMigrateReindexStatusStatusInProgress] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesGetRequest.md b/docs/reference/api/IndicesGetRequest.md index bb0111aa1..9e3b67acf 100644 --- a/docs/reference/api/IndicesGetRequest.md +++ b/docs/reference/api/IndicesGetRequest.md @@ -1,4 +1,4 @@ -## Interface `IndicesGetRequest` +# `IndicesGetRequest` [interface-IndicesGetRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesGetResponse.md b/docs/reference/api/IndicesGetResponse.md index d9327f30d..ec0053c58 100644 --- a/docs/reference/api/IndicesGetResponse.md +++ b/docs/reference/api/IndicesGetResponse.md @@ -1,4 +1,4 @@ -## `IndicesGetResponse` -::: +# `IndicesGetResponse` [alias-IndicesGetResponse] +```typescript type IndicesGetResponse = Record<[IndexName](./IndexName.md), [IndicesIndexState](./IndicesIndexState.md)>; -::: +``` diff --git a/docs/reference/api/IndicesGetSettingsRequest.md b/docs/reference/api/IndicesGetSettingsRequest.md index c3a1b6748..9ad9a8ad2 100644 --- a/docs/reference/api/IndicesGetSettingsRequest.md +++ b/docs/reference/api/IndicesGetSettingsRequest.md @@ -1,4 +1,4 @@ -## Interface `IndicesGetSettingsRequest` +# `IndicesGetSettingsRequest` [interface-IndicesGetSettingsRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesGetSettingsResponse.md b/docs/reference/api/IndicesGetSettingsResponse.md index 7a9d03914..462e0cda7 100644 --- a/docs/reference/api/IndicesGetSettingsResponse.md +++ b/docs/reference/api/IndicesGetSettingsResponse.md @@ -1,4 +1,4 @@ -## `IndicesGetSettingsResponse` -::: +# `IndicesGetSettingsResponse` [alias-IndicesGetSettingsResponse] +```typescript type IndicesGetSettingsResponse = Record<[IndexName](./IndexName.md), [IndicesIndexState](./IndicesIndexState.md)>; -::: +``` diff --git a/docs/reference/api/IndicesGetTemplateRequest.md b/docs/reference/api/IndicesGetTemplateRequest.md index 5208e0a1c..3d48a7445 100644 --- a/docs/reference/api/IndicesGetTemplateRequest.md +++ b/docs/reference/api/IndicesGetTemplateRequest.md @@ -1,4 +1,4 @@ -## Interface `IndicesGetTemplateRequest` +# `IndicesGetTemplateRequest` [interface-IndicesGetTemplateRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesGetTemplateResponse.md b/docs/reference/api/IndicesGetTemplateResponse.md index f56376a14..6435520f9 100644 --- a/docs/reference/api/IndicesGetTemplateResponse.md +++ b/docs/reference/api/IndicesGetTemplateResponse.md @@ -1,4 +1,4 @@ -## `IndicesGetTemplateResponse` -::: +# `IndicesGetTemplateResponse` [alias-IndicesGetTemplateResponse] +```typescript type IndicesGetTemplateResponse = Record; -::: +``` diff --git a/docs/reference/api/IndicesIndexCheckOnStartup.md b/docs/reference/api/IndicesIndexCheckOnStartup.md index ae97fce53..20b722db3 100644 --- a/docs/reference/api/IndicesIndexCheckOnStartup.md +++ b/docs/reference/api/IndicesIndexCheckOnStartup.md @@ -1,4 +1,4 @@ -## `IndicesIndexCheckOnStartup` -::: +# `IndicesIndexCheckOnStartup` [alias-IndicesIndexCheckOnStartup] +```typescript type IndicesIndexCheckOnStartup = boolean | 'true' | 'false' | 'checksum'; -::: +``` diff --git a/docs/reference/api/IndicesIndexMode.md b/docs/reference/api/IndicesIndexMode.md index d1fccdb8e..4040f11e6 100644 --- a/docs/reference/api/IndicesIndexMode.md +++ b/docs/reference/api/IndicesIndexMode.md @@ -1,4 +1,4 @@ -## `IndicesIndexMode` -::: +# `IndicesIndexMode` [alias-IndicesIndexMode] +```typescript type IndicesIndexMode = 'standard' | 'time_series' | 'logsdb' | 'lookup'; -::: +``` diff --git a/docs/reference/api/IndicesIndexRouting.md b/docs/reference/api/IndicesIndexRouting.md index be65dfe65..3a932b7f8 100644 --- a/docs/reference/api/IndicesIndexRouting.md +++ b/docs/reference/api/IndicesIndexRouting.md @@ -1,4 +1,4 @@ -## Interface `IndicesIndexRouting` +# `IndicesIndexRouting` [interface-IndicesIndexRouting] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesIndexRoutingAllocation.md b/docs/reference/api/IndicesIndexRoutingAllocation.md index 7511d6216..be11e26db 100644 --- a/docs/reference/api/IndicesIndexRoutingAllocation.md +++ b/docs/reference/api/IndicesIndexRoutingAllocation.md @@ -1,4 +1,4 @@ -## Interface `IndicesIndexRoutingAllocation` +# `IndicesIndexRoutingAllocation` [interface-IndicesIndexRoutingAllocation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesIndexRoutingAllocationDisk.md b/docs/reference/api/IndicesIndexRoutingAllocationDisk.md index 795ca5ee5..739dce3a2 100644 --- a/docs/reference/api/IndicesIndexRoutingAllocationDisk.md +++ b/docs/reference/api/IndicesIndexRoutingAllocationDisk.md @@ -1,4 +1,4 @@ -## Interface `IndicesIndexRoutingAllocationDisk` +# `IndicesIndexRoutingAllocationDisk` [interface-IndicesIndexRoutingAllocationDisk] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesIndexRoutingAllocationInclude.md b/docs/reference/api/IndicesIndexRoutingAllocationInclude.md index 3d906623c..98b8e22e0 100644 --- a/docs/reference/api/IndicesIndexRoutingAllocationInclude.md +++ b/docs/reference/api/IndicesIndexRoutingAllocationInclude.md @@ -1,4 +1,4 @@ -## Interface `IndicesIndexRoutingAllocationInclude` +# `IndicesIndexRoutingAllocationInclude` [interface-IndicesIndexRoutingAllocationInclude] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesIndexRoutingAllocationInitialRecovery.md b/docs/reference/api/IndicesIndexRoutingAllocationInitialRecovery.md index b04eff3f4..6661b73a1 100644 --- a/docs/reference/api/IndicesIndexRoutingAllocationInitialRecovery.md +++ b/docs/reference/api/IndicesIndexRoutingAllocationInitialRecovery.md @@ -1,4 +1,4 @@ -## Interface `IndicesIndexRoutingAllocationInitialRecovery` +# `IndicesIndexRoutingAllocationInitialRecovery` [interface-IndicesIndexRoutingAllocationInitialRecovery] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesIndexRoutingAllocationOptions.md b/docs/reference/api/IndicesIndexRoutingAllocationOptions.md index ca9cd5818..bf738557a 100644 --- a/docs/reference/api/IndicesIndexRoutingAllocationOptions.md +++ b/docs/reference/api/IndicesIndexRoutingAllocationOptions.md @@ -1,4 +1,4 @@ -## `IndicesIndexRoutingAllocationOptions` -::: +# `IndicesIndexRoutingAllocationOptions` [alias-IndicesIndexRoutingAllocationOptions] +```typescript type IndicesIndexRoutingAllocationOptions = 'all' | 'primaries' | 'new_primaries' | 'none'; -::: +``` diff --git a/docs/reference/api/IndicesIndexRoutingRebalance.md b/docs/reference/api/IndicesIndexRoutingRebalance.md index 65ee6f2e8..700edeadc 100644 --- a/docs/reference/api/IndicesIndexRoutingRebalance.md +++ b/docs/reference/api/IndicesIndexRoutingRebalance.md @@ -1,4 +1,4 @@ -## Interface `IndicesIndexRoutingRebalance` +# `IndicesIndexRoutingRebalance` [interface-IndicesIndexRoutingRebalance] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesIndexRoutingRebalanceOptions.md b/docs/reference/api/IndicesIndexRoutingRebalanceOptions.md index 689a6fd9f..5620572ad 100644 --- a/docs/reference/api/IndicesIndexRoutingRebalanceOptions.md +++ b/docs/reference/api/IndicesIndexRoutingRebalanceOptions.md @@ -1,4 +1,4 @@ -## `IndicesIndexRoutingRebalanceOptions` -::: +# `IndicesIndexRoutingRebalanceOptions` [alias-IndicesIndexRoutingRebalanceOptions] +```typescript type IndicesIndexRoutingRebalanceOptions = 'all' | 'primaries' | 'replicas' | 'none'; -::: +``` diff --git a/docs/reference/api/IndicesIndexSegmentSort.md b/docs/reference/api/IndicesIndexSegmentSort.md index f8e8aa18f..de8892121 100644 --- a/docs/reference/api/IndicesIndexSegmentSort.md +++ b/docs/reference/api/IndicesIndexSegmentSort.md @@ -1,4 +1,4 @@ -## Interface `IndicesIndexSegmentSort` +# `IndicesIndexSegmentSort` [interface-IndicesIndexSegmentSort] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesIndexSettingBlocks.md b/docs/reference/api/IndicesIndexSettingBlocks.md index 722cf1828..6fc75af2b 100644 --- a/docs/reference/api/IndicesIndexSettingBlocks.md +++ b/docs/reference/api/IndicesIndexSettingBlocks.md @@ -1,4 +1,4 @@ -## Interface `IndicesIndexSettingBlocks` +# `IndicesIndexSettingBlocks` [interface-IndicesIndexSettingBlocks] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesIndexSettings.md b/docs/reference/api/IndicesIndexSettings.md index 58cc460b1..df2a3273a 100644 --- a/docs/reference/api/IndicesIndexSettings.md +++ b/docs/reference/api/IndicesIndexSettings.md @@ -1,4 +1,4 @@ -## `IndicesIndexSettings` -::: +# `IndicesIndexSettings` [alias-IndicesIndexSettings] +```typescript type IndicesIndexSettings = [IndicesIndexSettingsKeys](./IndicesIndexSettingsKeys.md) & { [property: string]: any;}; -::: +``` diff --git a/docs/reference/api/IndicesIndexSettingsAnalysis.md b/docs/reference/api/IndicesIndexSettingsAnalysis.md index ee045c6bd..4404e4370 100644 --- a/docs/reference/api/IndicesIndexSettingsAnalysis.md +++ b/docs/reference/api/IndicesIndexSettingsAnalysis.md @@ -1,4 +1,4 @@ -## Interface `IndicesIndexSettingsAnalysis` +# `IndicesIndexSettingsAnalysis` [interface-IndicesIndexSettingsAnalysis] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesIndexSettingsKeys.md b/docs/reference/api/IndicesIndexSettingsKeys.md index 293c720b7..cbe7883be 100644 --- a/docs/reference/api/IndicesIndexSettingsKeys.md +++ b/docs/reference/api/IndicesIndexSettingsKeys.md @@ -1,4 +1,4 @@ -## Interface `IndicesIndexSettingsKeys` +# `IndicesIndexSettingsKeys` [interface-IndicesIndexSettingsKeys] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesIndexSettingsLifecycle.md b/docs/reference/api/IndicesIndexSettingsLifecycle.md index 882752861..0922c87e5 100644 --- a/docs/reference/api/IndicesIndexSettingsLifecycle.md +++ b/docs/reference/api/IndicesIndexSettingsLifecycle.md @@ -1,4 +1,4 @@ -## Interface `IndicesIndexSettingsLifecycle` +# `IndicesIndexSettingsLifecycle` [interface-IndicesIndexSettingsLifecycle] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesIndexSettingsLifecycleStep.md b/docs/reference/api/IndicesIndexSettingsLifecycleStep.md index 6857c7a58..a2b1a83a0 100644 --- a/docs/reference/api/IndicesIndexSettingsLifecycleStep.md +++ b/docs/reference/api/IndicesIndexSettingsLifecycleStep.md @@ -1,4 +1,4 @@ -## Interface `IndicesIndexSettingsLifecycleStep` +# `IndicesIndexSettingsLifecycleStep` [interface-IndicesIndexSettingsLifecycleStep] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesIndexSettingsTimeSeries.md b/docs/reference/api/IndicesIndexSettingsTimeSeries.md index 37900e7da..e126a04be 100644 --- a/docs/reference/api/IndicesIndexSettingsTimeSeries.md +++ b/docs/reference/api/IndicesIndexSettingsTimeSeries.md @@ -1,4 +1,4 @@ -## Interface `IndicesIndexSettingsTimeSeries` +# `IndicesIndexSettingsTimeSeries` [interface-IndicesIndexSettingsTimeSeries] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesIndexState.md b/docs/reference/api/IndicesIndexState.md index 51780aa92..0d12d9984 100644 --- a/docs/reference/api/IndicesIndexState.md +++ b/docs/reference/api/IndicesIndexState.md @@ -1,4 +1,4 @@ -## Interface `IndicesIndexState` +# `IndicesIndexState` [interface-IndicesIndexState] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesIndexTemplate.md b/docs/reference/api/IndicesIndexTemplate.md index b390032c3..2f91d0f02 100644 --- a/docs/reference/api/IndicesIndexTemplate.md +++ b/docs/reference/api/IndicesIndexTemplate.md @@ -1,4 +1,4 @@ -## Interface `IndicesIndexTemplate` +# `IndicesIndexTemplate` [interface-IndicesIndexTemplate] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesIndexTemplateDataStreamConfiguration.md b/docs/reference/api/IndicesIndexTemplateDataStreamConfiguration.md index bf6145dc1..24635635b 100644 --- a/docs/reference/api/IndicesIndexTemplateDataStreamConfiguration.md +++ b/docs/reference/api/IndicesIndexTemplateDataStreamConfiguration.md @@ -1,4 +1,4 @@ -## Interface `IndicesIndexTemplateDataStreamConfiguration` +# `IndicesIndexTemplateDataStreamConfiguration` [interface-IndicesIndexTemplateDataStreamConfiguration] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesIndexTemplateSummary.md b/docs/reference/api/IndicesIndexTemplateSummary.md index 02274996a..aea2020c0 100644 --- a/docs/reference/api/IndicesIndexTemplateSummary.md +++ b/docs/reference/api/IndicesIndexTemplateSummary.md @@ -1,4 +1,4 @@ -## Interface `IndicesIndexTemplateSummary` +# `IndicesIndexTemplateSummary` [interface-IndicesIndexTemplateSummary] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesIndexVersioning.md b/docs/reference/api/IndicesIndexVersioning.md index 9ef15a5d8..5b321ac8a 100644 --- a/docs/reference/api/IndicesIndexVersioning.md +++ b/docs/reference/api/IndicesIndexVersioning.md @@ -1,4 +1,4 @@ -## Interface `IndicesIndexVersioning` +# `IndicesIndexVersioning` [interface-IndicesIndexVersioning] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesIndexingPressure.md b/docs/reference/api/IndicesIndexingPressure.md index c435f9768..46009e271 100644 --- a/docs/reference/api/IndicesIndexingPressure.md +++ b/docs/reference/api/IndicesIndexingPressure.md @@ -1,4 +1,4 @@ -## Interface `IndicesIndexingPressure` +# `IndicesIndexingPressure` [interface-IndicesIndexingPressure] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesIndexingPressureMemory.md b/docs/reference/api/IndicesIndexingPressureMemory.md index 5c45b49ea..e3508ffda 100644 --- a/docs/reference/api/IndicesIndexingPressureMemory.md +++ b/docs/reference/api/IndicesIndexingPressureMemory.md @@ -1,4 +1,4 @@ -## Interface `IndicesIndexingPressureMemory` +# `IndicesIndexingPressureMemory` [interface-IndicesIndexingPressureMemory] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesIndexingSlowlogSettings.md b/docs/reference/api/IndicesIndexingSlowlogSettings.md index 55da376b1..112687090 100644 --- a/docs/reference/api/IndicesIndexingSlowlogSettings.md +++ b/docs/reference/api/IndicesIndexingSlowlogSettings.md @@ -1,4 +1,4 @@ -## Interface `IndicesIndexingSlowlogSettings` +# `IndicesIndexingSlowlogSettings` [interface-IndicesIndexingSlowlogSettings] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesIndexingSlowlogTresholds.md b/docs/reference/api/IndicesIndexingSlowlogTresholds.md index 5b348dadf..0257ab08e 100644 --- a/docs/reference/api/IndicesIndexingSlowlogTresholds.md +++ b/docs/reference/api/IndicesIndexingSlowlogTresholds.md @@ -1,4 +1,4 @@ -## Interface `IndicesIndexingSlowlogTresholds` +# `IndicesIndexingSlowlogTresholds` [interface-IndicesIndexingSlowlogTresholds] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesManagedBy.md b/docs/reference/api/IndicesManagedBy.md index 73d4ecdd7..da3140b60 100644 --- a/docs/reference/api/IndicesManagedBy.md +++ b/docs/reference/api/IndicesManagedBy.md @@ -1,4 +1,4 @@ -## `IndicesManagedBy` -::: +# `IndicesManagedBy` [alias-IndicesManagedBy] +```typescript type IndicesManagedBy = 'Index Lifecycle Management' | 'Data stream lifecycle' | 'Unmanaged'; -::: +``` diff --git a/docs/reference/api/IndicesMappingLimitSettings.md b/docs/reference/api/IndicesMappingLimitSettings.md index d155e5cd0..ecb0cd696 100644 --- a/docs/reference/api/IndicesMappingLimitSettings.md +++ b/docs/reference/api/IndicesMappingLimitSettings.md @@ -1,4 +1,4 @@ -## Interface `IndicesMappingLimitSettings` +# `IndicesMappingLimitSettings` [interface-IndicesMappingLimitSettings] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesMappingLimitSettingsDepth.md b/docs/reference/api/IndicesMappingLimitSettingsDepth.md index 6e7a5bb80..9e93ecbbc 100644 --- a/docs/reference/api/IndicesMappingLimitSettingsDepth.md +++ b/docs/reference/api/IndicesMappingLimitSettingsDepth.md @@ -1,4 +1,4 @@ -## Interface `IndicesMappingLimitSettingsDepth` +# `IndicesMappingLimitSettingsDepth` [interface-IndicesMappingLimitSettingsDepth] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesMappingLimitSettingsDimensionFields.md b/docs/reference/api/IndicesMappingLimitSettingsDimensionFields.md index 85ede244f..107ae980a 100644 --- a/docs/reference/api/IndicesMappingLimitSettingsDimensionFields.md +++ b/docs/reference/api/IndicesMappingLimitSettingsDimensionFields.md @@ -1,4 +1,4 @@ -## Interface `IndicesMappingLimitSettingsDimensionFields` +# `IndicesMappingLimitSettingsDimensionFields` [interface-IndicesMappingLimitSettingsDimensionFields] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesMappingLimitSettingsFieldNameLength.md b/docs/reference/api/IndicesMappingLimitSettingsFieldNameLength.md index 8963b0dfb..1ee0a9e10 100644 --- a/docs/reference/api/IndicesMappingLimitSettingsFieldNameLength.md +++ b/docs/reference/api/IndicesMappingLimitSettingsFieldNameLength.md @@ -1,4 +1,4 @@ -## Interface `IndicesMappingLimitSettingsFieldNameLength` +# `IndicesMappingLimitSettingsFieldNameLength` [interface-IndicesMappingLimitSettingsFieldNameLength] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesMappingLimitSettingsNestedFields.md b/docs/reference/api/IndicesMappingLimitSettingsNestedFields.md index 3383442ca..84c8ec7e3 100644 --- a/docs/reference/api/IndicesMappingLimitSettingsNestedFields.md +++ b/docs/reference/api/IndicesMappingLimitSettingsNestedFields.md @@ -1,4 +1,4 @@ -## Interface `IndicesMappingLimitSettingsNestedFields` +# `IndicesMappingLimitSettingsNestedFields` [interface-IndicesMappingLimitSettingsNestedFields] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesMappingLimitSettingsNestedObjects.md b/docs/reference/api/IndicesMappingLimitSettingsNestedObjects.md index ad2959ba5..e28a414b1 100644 --- a/docs/reference/api/IndicesMappingLimitSettingsNestedObjects.md +++ b/docs/reference/api/IndicesMappingLimitSettingsNestedObjects.md @@ -1,4 +1,4 @@ -## Interface `IndicesMappingLimitSettingsNestedObjects` +# `IndicesMappingLimitSettingsNestedObjects` [interface-IndicesMappingLimitSettingsNestedObjects] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesMappingLimitSettingsSourceFields.md b/docs/reference/api/IndicesMappingLimitSettingsSourceFields.md index 23502e881..fc4837f27 100644 --- a/docs/reference/api/IndicesMappingLimitSettingsSourceFields.md +++ b/docs/reference/api/IndicesMappingLimitSettingsSourceFields.md @@ -1,4 +1,4 @@ -## Interface `IndicesMappingLimitSettingsSourceFields` +# `IndicesMappingLimitSettingsSourceFields` [interface-IndicesMappingLimitSettingsSourceFields] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesMappingLimitSettingsTotalFields.md b/docs/reference/api/IndicesMappingLimitSettingsTotalFields.md index f5a1ab49a..eca3ba24d 100644 --- a/docs/reference/api/IndicesMappingLimitSettingsTotalFields.md +++ b/docs/reference/api/IndicesMappingLimitSettingsTotalFields.md @@ -1,4 +1,4 @@ -## Interface `IndicesMappingLimitSettingsTotalFields` +# `IndicesMappingLimitSettingsTotalFields` [interface-IndicesMappingLimitSettingsTotalFields] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesMerge.md b/docs/reference/api/IndicesMerge.md index 7855731b2..48887c408 100644 --- a/docs/reference/api/IndicesMerge.md +++ b/docs/reference/api/IndicesMerge.md @@ -1,4 +1,4 @@ -## Interface `IndicesMerge` +# `IndicesMerge` [interface-IndicesMerge] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesMergeScheduler.md b/docs/reference/api/IndicesMergeScheduler.md index 118e605a1..eeccdae12 100644 --- a/docs/reference/api/IndicesMergeScheduler.md +++ b/docs/reference/api/IndicesMergeScheduler.md @@ -1,4 +1,4 @@ -## Interface `IndicesMergeScheduler` +# `IndicesMergeScheduler` [interface-IndicesMergeScheduler] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesMigrateReindexMigrateReindex.md b/docs/reference/api/IndicesMigrateReindexMigrateReindex.md index ade1296fd..87214effd 100644 --- a/docs/reference/api/IndicesMigrateReindexMigrateReindex.md +++ b/docs/reference/api/IndicesMigrateReindexMigrateReindex.md @@ -1,4 +1,4 @@ -## Interface `IndicesMigrateReindexMigrateReindex` +# `IndicesMigrateReindexMigrateReindex` [interface-IndicesMigrateReindexMigrateReindex] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesMigrateReindexModeEnum.md b/docs/reference/api/IndicesMigrateReindexModeEnum.md index e0aacb2c7..14a1d8cc2 100644 --- a/docs/reference/api/IndicesMigrateReindexModeEnum.md +++ b/docs/reference/api/IndicesMigrateReindexModeEnum.md @@ -1,4 +1,4 @@ -## `IndicesMigrateReindexModeEnum` -::: +# `IndicesMigrateReindexModeEnum` [alias-IndicesMigrateReindexModeEnum] +```typescript type IndicesMigrateReindexModeEnum = 'upgrade'; -::: +``` diff --git a/docs/reference/api/IndicesMigrateReindexRequest.md b/docs/reference/api/IndicesMigrateReindexRequest.md index 9dc28c28b..b9980ac24 100644 --- a/docs/reference/api/IndicesMigrateReindexRequest.md +++ b/docs/reference/api/IndicesMigrateReindexRequest.md @@ -1,4 +1,4 @@ -## Interface `IndicesMigrateReindexRequest` +# `IndicesMigrateReindexRequest` [interface-IndicesMigrateReindexRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesMigrateReindexResponse.md b/docs/reference/api/IndicesMigrateReindexResponse.md index e132b4e83..53d9a0843 100644 --- a/docs/reference/api/IndicesMigrateReindexResponse.md +++ b/docs/reference/api/IndicesMigrateReindexResponse.md @@ -1,4 +1,4 @@ -## `IndicesMigrateReindexResponse` -::: +# `IndicesMigrateReindexResponse` [alias-IndicesMigrateReindexResponse] +```typescript type IndicesMigrateReindexResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); -::: +``` diff --git a/docs/reference/api/IndicesMigrateReindexSourceIndex.md b/docs/reference/api/IndicesMigrateReindexSourceIndex.md index 2ba65866d..a8f499460 100644 --- a/docs/reference/api/IndicesMigrateReindexSourceIndex.md +++ b/docs/reference/api/IndicesMigrateReindexSourceIndex.md @@ -1,4 +1,4 @@ -## Interface `IndicesMigrateReindexSourceIndex` +# `IndicesMigrateReindexSourceIndex` [interface-IndicesMigrateReindexSourceIndex] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesMigrateToDataStreamRequest.md b/docs/reference/api/IndicesMigrateToDataStreamRequest.md index 204b9bfb8..bab283716 100644 --- a/docs/reference/api/IndicesMigrateToDataStreamRequest.md +++ b/docs/reference/api/IndicesMigrateToDataStreamRequest.md @@ -1,4 +1,4 @@ -## Interface `IndicesMigrateToDataStreamRequest` +# `IndicesMigrateToDataStreamRequest` [interface-IndicesMigrateToDataStreamRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesMigrateToDataStreamResponse.md b/docs/reference/api/IndicesMigrateToDataStreamResponse.md index b2bc272bd..dc3ca5b43 100644 --- a/docs/reference/api/IndicesMigrateToDataStreamResponse.md +++ b/docs/reference/api/IndicesMigrateToDataStreamResponse.md @@ -1,4 +1,4 @@ -## `IndicesMigrateToDataStreamResponse` -::: +# `IndicesMigrateToDataStreamResponse` [alias-IndicesMigrateToDataStreamResponse] +```typescript type IndicesMigrateToDataStreamResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); -::: +``` diff --git a/docs/reference/api/IndicesModifyDataStreamAction.md b/docs/reference/api/IndicesModifyDataStreamAction.md index 3210bc6f7..bdf269fb9 100644 --- a/docs/reference/api/IndicesModifyDataStreamAction.md +++ b/docs/reference/api/IndicesModifyDataStreamAction.md @@ -1,4 +1,4 @@ -## Interface `IndicesModifyDataStreamAction` +# `IndicesModifyDataStreamAction` [interface-IndicesModifyDataStreamAction] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesModifyDataStreamIndexAndDataStreamAction.md b/docs/reference/api/IndicesModifyDataStreamIndexAndDataStreamAction.md index 22426e12d..24a8dba01 100644 --- a/docs/reference/api/IndicesModifyDataStreamIndexAndDataStreamAction.md +++ b/docs/reference/api/IndicesModifyDataStreamIndexAndDataStreamAction.md @@ -1,4 +1,4 @@ -## Interface `IndicesModifyDataStreamIndexAndDataStreamAction` +# `IndicesModifyDataStreamIndexAndDataStreamAction` [interface-IndicesModifyDataStreamIndexAndDataStreamAction] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesModifyDataStreamRequest.md b/docs/reference/api/IndicesModifyDataStreamRequest.md index fe41eced4..567b58603 100644 --- a/docs/reference/api/IndicesModifyDataStreamRequest.md +++ b/docs/reference/api/IndicesModifyDataStreamRequest.md @@ -1,4 +1,4 @@ -## Interface `IndicesModifyDataStreamRequest` +# `IndicesModifyDataStreamRequest` [interface-IndicesModifyDataStreamRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesModifyDataStreamResponse.md b/docs/reference/api/IndicesModifyDataStreamResponse.md index b74dd312b..7c3363f16 100644 --- a/docs/reference/api/IndicesModifyDataStreamResponse.md +++ b/docs/reference/api/IndicesModifyDataStreamResponse.md @@ -1,4 +1,4 @@ -## `IndicesModifyDataStreamResponse` -::: +# `IndicesModifyDataStreamResponse` [alias-IndicesModifyDataStreamResponse] +```typescript type IndicesModifyDataStreamResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); -::: +``` diff --git a/docs/reference/api/IndicesNumericFielddata.md b/docs/reference/api/IndicesNumericFielddata.md index 752decfe3..0db18d60b 100644 --- a/docs/reference/api/IndicesNumericFielddata.md +++ b/docs/reference/api/IndicesNumericFielddata.md @@ -1,4 +1,4 @@ -## Interface `IndicesNumericFielddata` +# `IndicesNumericFielddata` [interface-IndicesNumericFielddata] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesNumericFielddataFormat.md b/docs/reference/api/IndicesNumericFielddataFormat.md index bee1245a3..cdabe4661 100644 --- a/docs/reference/api/IndicesNumericFielddataFormat.md +++ b/docs/reference/api/IndicesNumericFielddataFormat.md @@ -1,4 +1,4 @@ -## `IndicesNumericFielddataFormat` -::: +# `IndicesNumericFielddataFormat` [alias-IndicesNumericFielddataFormat] +```typescript type IndicesNumericFielddataFormat = 'array' | 'disabled'; -::: +``` diff --git a/docs/reference/api/IndicesOpenRequest.md b/docs/reference/api/IndicesOpenRequest.md index 7ff98fd42..2391ba76a 100644 --- a/docs/reference/api/IndicesOpenRequest.md +++ b/docs/reference/api/IndicesOpenRequest.md @@ -1,4 +1,4 @@ -## Interface `IndicesOpenRequest` +# `IndicesOpenRequest` [interface-IndicesOpenRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesOpenResponse.md b/docs/reference/api/IndicesOpenResponse.md index 3c07301ca..334c19d80 100644 --- a/docs/reference/api/IndicesOpenResponse.md +++ b/docs/reference/api/IndicesOpenResponse.md @@ -1,4 +1,4 @@ -## Interface `IndicesOpenResponse` +# `IndicesOpenResponse` [interface-IndicesOpenResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesOptions.md b/docs/reference/api/IndicesOptions.md index 287a77398..1fbe092d2 100644 --- a/docs/reference/api/IndicesOptions.md +++ b/docs/reference/api/IndicesOptions.md @@ -1,4 +1,4 @@ -## Interface `IndicesOptions` +# `IndicesOptions` [interface-IndicesOptions] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesPromoteDataStreamRequest.md b/docs/reference/api/IndicesPromoteDataStreamRequest.md index 3217cc28c..2643a26fd 100644 --- a/docs/reference/api/IndicesPromoteDataStreamRequest.md +++ b/docs/reference/api/IndicesPromoteDataStreamRequest.md @@ -1,4 +1,4 @@ -## Interface `IndicesPromoteDataStreamRequest` +# `IndicesPromoteDataStreamRequest` [interface-IndicesPromoteDataStreamRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesPromoteDataStreamResponse.md b/docs/reference/api/IndicesPromoteDataStreamResponse.md index 67ae6e4c8..65ad08380 100644 --- a/docs/reference/api/IndicesPromoteDataStreamResponse.md +++ b/docs/reference/api/IndicesPromoteDataStreamResponse.md @@ -1,4 +1,4 @@ -## `IndicesPromoteDataStreamResponse` -::: +# `IndicesPromoteDataStreamResponse` [alias-IndicesPromoteDataStreamResponse] +```typescript type IndicesPromoteDataStreamResponse = any; -::: +``` diff --git a/docs/reference/api/IndicesPutAliasRequest.md b/docs/reference/api/IndicesPutAliasRequest.md index 98f4cbd48..60392becb 100644 --- a/docs/reference/api/IndicesPutAliasRequest.md +++ b/docs/reference/api/IndicesPutAliasRequest.md @@ -1,4 +1,4 @@ -## Interface `IndicesPutAliasRequest` +# `IndicesPutAliasRequest` [interface-IndicesPutAliasRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesPutAliasResponse.md b/docs/reference/api/IndicesPutAliasResponse.md index 56604c9bf..28fd88057 100644 --- a/docs/reference/api/IndicesPutAliasResponse.md +++ b/docs/reference/api/IndicesPutAliasResponse.md @@ -1,4 +1,4 @@ -## `IndicesPutAliasResponse` -::: +# `IndicesPutAliasResponse` [alias-IndicesPutAliasResponse] +```typescript type IndicesPutAliasResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); -::: +``` diff --git a/docs/reference/api/IndicesPutDataLifecycleRequest.md b/docs/reference/api/IndicesPutDataLifecycleRequest.md index 45a8edb6c..d0fc4070f 100644 --- a/docs/reference/api/IndicesPutDataLifecycleRequest.md +++ b/docs/reference/api/IndicesPutDataLifecycleRequest.md @@ -1,4 +1,4 @@ -## Interface `IndicesPutDataLifecycleRequest` +# `IndicesPutDataLifecycleRequest` [interface-IndicesPutDataLifecycleRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesPutDataLifecycleResponse.md b/docs/reference/api/IndicesPutDataLifecycleResponse.md index 13292e82f..1c406e216 100644 --- a/docs/reference/api/IndicesPutDataLifecycleResponse.md +++ b/docs/reference/api/IndicesPutDataLifecycleResponse.md @@ -1,4 +1,4 @@ -## `IndicesPutDataLifecycleResponse` -::: +# `IndicesPutDataLifecycleResponse` [alias-IndicesPutDataLifecycleResponse] +```typescript type IndicesPutDataLifecycleResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); -::: +``` diff --git a/docs/reference/api/IndicesPutIndexTemplateIndexTemplateMapping.md b/docs/reference/api/IndicesPutIndexTemplateIndexTemplateMapping.md index 48eb797cc..a71cf97ba 100644 --- a/docs/reference/api/IndicesPutIndexTemplateIndexTemplateMapping.md +++ b/docs/reference/api/IndicesPutIndexTemplateIndexTemplateMapping.md @@ -1,4 +1,4 @@ -## Interface `IndicesPutIndexTemplateIndexTemplateMapping` +# `IndicesPutIndexTemplateIndexTemplateMapping` [interface-IndicesPutIndexTemplateIndexTemplateMapping] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesPutIndexTemplateRequest.md b/docs/reference/api/IndicesPutIndexTemplateRequest.md index 9ff54696d..39ddbb48c 100644 --- a/docs/reference/api/IndicesPutIndexTemplateRequest.md +++ b/docs/reference/api/IndicesPutIndexTemplateRequest.md @@ -1,4 +1,4 @@ -## Interface `IndicesPutIndexTemplateRequest` +# `IndicesPutIndexTemplateRequest` [interface-IndicesPutIndexTemplateRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesPutIndexTemplateResponse.md b/docs/reference/api/IndicesPutIndexTemplateResponse.md index c3a781caf..4685feab4 100644 --- a/docs/reference/api/IndicesPutIndexTemplateResponse.md +++ b/docs/reference/api/IndicesPutIndexTemplateResponse.md @@ -1,4 +1,4 @@ -## `IndicesPutIndexTemplateResponse` -::: +# `IndicesPutIndexTemplateResponse` [alias-IndicesPutIndexTemplateResponse] +```typescript type IndicesPutIndexTemplateResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); -::: +``` diff --git a/docs/reference/api/IndicesPutMappingRequest.md b/docs/reference/api/IndicesPutMappingRequest.md index f34fe59f1..693aec5a4 100644 --- a/docs/reference/api/IndicesPutMappingRequest.md +++ b/docs/reference/api/IndicesPutMappingRequest.md @@ -1,4 +1,4 @@ -## Interface `IndicesPutMappingRequest` +# `IndicesPutMappingRequest` [interface-IndicesPutMappingRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesPutMappingResponse.md b/docs/reference/api/IndicesPutMappingResponse.md index a33810780..67b57ea84 100644 --- a/docs/reference/api/IndicesPutMappingResponse.md +++ b/docs/reference/api/IndicesPutMappingResponse.md @@ -1,4 +1,4 @@ -## `IndicesPutMappingResponse` -::: +# `IndicesPutMappingResponse` [alias-IndicesPutMappingResponse] +```typescript type IndicesPutMappingResponse = [IndicesResponseBase](./IndicesResponseBase.md); -::: +``` diff --git a/docs/reference/api/IndicesPutSettingsRequest.md b/docs/reference/api/IndicesPutSettingsRequest.md index 5f40e8946..05b0efd60 100644 --- a/docs/reference/api/IndicesPutSettingsRequest.md +++ b/docs/reference/api/IndicesPutSettingsRequest.md @@ -1,4 +1,4 @@ -## Interface `IndicesPutSettingsRequest` +# `IndicesPutSettingsRequest` [interface-IndicesPutSettingsRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesPutSettingsResponse.md b/docs/reference/api/IndicesPutSettingsResponse.md index dfb9ec68b..df560231d 100644 --- a/docs/reference/api/IndicesPutSettingsResponse.md +++ b/docs/reference/api/IndicesPutSettingsResponse.md @@ -1,4 +1,4 @@ -## `IndicesPutSettingsResponse` -::: +# `IndicesPutSettingsResponse` [alias-IndicesPutSettingsResponse] +```typescript type IndicesPutSettingsResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); -::: +``` diff --git a/docs/reference/api/IndicesPutTemplateRequest.md b/docs/reference/api/IndicesPutTemplateRequest.md index 2f429b9fc..36307906a 100644 --- a/docs/reference/api/IndicesPutTemplateRequest.md +++ b/docs/reference/api/IndicesPutTemplateRequest.md @@ -1,4 +1,4 @@ -## Interface `IndicesPutTemplateRequest` +# `IndicesPutTemplateRequest` [interface-IndicesPutTemplateRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesPutTemplateResponse.md b/docs/reference/api/IndicesPutTemplateResponse.md index af81a9e2c..5e903a29d 100644 --- a/docs/reference/api/IndicesPutTemplateResponse.md +++ b/docs/reference/api/IndicesPutTemplateResponse.md @@ -1,4 +1,4 @@ -## `IndicesPutTemplateResponse` -::: +# `IndicesPutTemplateResponse` [alias-IndicesPutTemplateResponse] +```typescript type IndicesPutTemplateResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); -::: +``` diff --git a/docs/reference/api/IndicesQueries.md b/docs/reference/api/IndicesQueries.md index 99c00d0ab..0d77744b1 100644 --- a/docs/reference/api/IndicesQueries.md +++ b/docs/reference/api/IndicesQueries.md @@ -1,4 +1,4 @@ -## Interface `IndicesQueries` +# `IndicesQueries` [interface-IndicesQueries] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesRecoveryFileDetails.md b/docs/reference/api/IndicesRecoveryFileDetails.md index a55e7bcc1..fc8e854a1 100644 --- a/docs/reference/api/IndicesRecoveryFileDetails.md +++ b/docs/reference/api/IndicesRecoveryFileDetails.md @@ -1,4 +1,4 @@ -## Interface `IndicesRecoveryFileDetails` +# `IndicesRecoveryFileDetails` [interface-IndicesRecoveryFileDetails] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesRecoveryRecoveryBytes.md b/docs/reference/api/IndicesRecoveryRecoveryBytes.md index a4bf6ed51..c483b3ce2 100644 --- a/docs/reference/api/IndicesRecoveryRecoveryBytes.md +++ b/docs/reference/api/IndicesRecoveryRecoveryBytes.md @@ -1,4 +1,4 @@ -## Interface `IndicesRecoveryRecoveryBytes` +# `IndicesRecoveryRecoveryBytes` [interface-IndicesRecoveryRecoveryBytes] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesRecoveryRecoveryFiles.md b/docs/reference/api/IndicesRecoveryRecoveryFiles.md index 9fc117b3d..929b37a1c 100644 --- a/docs/reference/api/IndicesRecoveryRecoveryFiles.md +++ b/docs/reference/api/IndicesRecoveryRecoveryFiles.md @@ -1,4 +1,4 @@ -## Interface `IndicesRecoveryRecoveryFiles` +# `IndicesRecoveryRecoveryFiles` [interface-IndicesRecoveryRecoveryFiles] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesRecoveryRecoveryIndexStatus.md b/docs/reference/api/IndicesRecoveryRecoveryIndexStatus.md index 677a22ceb..7ea0fb493 100644 --- a/docs/reference/api/IndicesRecoveryRecoveryIndexStatus.md +++ b/docs/reference/api/IndicesRecoveryRecoveryIndexStatus.md @@ -1,4 +1,4 @@ -## Interface `IndicesRecoveryRecoveryIndexStatus` +# `IndicesRecoveryRecoveryIndexStatus` [interface-IndicesRecoveryRecoveryIndexStatus] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesRecoveryRecoveryOrigin.md b/docs/reference/api/IndicesRecoveryRecoveryOrigin.md index f8679b822..78ccd5f87 100644 --- a/docs/reference/api/IndicesRecoveryRecoveryOrigin.md +++ b/docs/reference/api/IndicesRecoveryRecoveryOrigin.md @@ -1,4 +1,4 @@ -## Interface `IndicesRecoveryRecoveryOrigin` +# `IndicesRecoveryRecoveryOrigin` [interface-IndicesRecoveryRecoveryOrigin] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesRecoveryRecoveryStartStatus.md b/docs/reference/api/IndicesRecoveryRecoveryStartStatus.md index a3347f19a..22ae56c42 100644 --- a/docs/reference/api/IndicesRecoveryRecoveryStartStatus.md +++ b/docs/reference/api/IndicesRecoveryRecoveryStartStatus.md @@ -1,4 +1,4 @@ -## Interface `IndicesRecoveryRecoveryStartStatus` +# `IndicesRecoveryRecoveryStartStatus` [interface-IndicesRecoveryRecoveryStartStatus] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesRecoveryRecoveryStatus.md b/docs/reference/api/IndicesRecoveryRecoveryStatus.md index c10879456..07f555cec 100644 --- a/docs/reference/api/IndicesRecoveryRecoveryStatus.md +++ b/docs/reference/api/IndicesRecoveryRecoveryStatus.md @@ -1,4 +1,4 @@ -## Interface `IndicesRecoveryRecoveryStatus` +# `IndicesRecoveryRecoveryStatus` [interface-IndicesRecoveryRecoveryStatus] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesRecoveryRequest.md b/docs/reference/api/IndicesRecoveryRequest.md index 381cbd092..dcc82e289 100644 --- a/docs/reference/api/IndicesRecoveryRequest.md +++ b/docs/reference/api/IndicesRecoveryRequest.md @@ -1,4 +1,4 @@ -## Interface `IndicesRecoveryRequest` +# `IndicesRecoveryRequest` [interface-IndicesRecoveryRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesRecoveryResponse.md b/docs/reference/api/IndicesRecoveryResponse.md index 5466ae902..e2f3173e9 100644 --- a/docs/reference/api/IndicesRecoveryResponse.md +++ b/docs/reference/api/IndicesRecoveryResponse.md @@ -1,4 +1,4 @@ -## `IndicesRecoveryResponse` -::: +# `IndicesRecoveryResponse` [alias-IndicesRecoveryResponse] +```typescript type IndicesRecoveryResponse = Record<[IndexName](./IndexName.md), [IndicesRecoveryRecoveryStatus](./IndicesRecoveryRecoveryStatus.md)>; -::: +``` diff --git a/docs/reference/api/IndicesRecoveryShardRecovery.md b/docs/reference/api/IndicesRecoveryShardRecovery.md index 3dffeb7ff..e0bccf56a 100644 --- a/docs/reference/api/IndicesRecoveryShardRecovery.md +++ b/docs/reference/api/IndicesRecoveryShardRecovery.md @@ -1,4 +1,4 @@ -## Interface `IndicesRecoveryShardRecovery` +# `IndicesRecoveryShardRecovery` [interface-IndicesRecoveryShardRecovery] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesRecoveryTranslogStatus.md b/docs/reference/api/IndicesRecoveryTranslogStatus.md index 723923c98..039239075 100644 --- a/docs/reference/api/IndicesRecoveryTranslogStatus.md +++ b/docs/reference/api/IndicesRecoveryTranslogStatus.md @@ -1,4 +1,4 @@ -## Interface `IndicesRecoveryTranslogStatus` +# `IndicesRecoveryTranslogStatus` [interface-IndicesRecoveryTranslogStatus] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesRecoveryVerifyIndex.md b/docs/reference/api/IndicesRecoveryVerifyIndex.md index 3ad6effc0..96b0b32a7 100644 --- a/docs/reference/api/IndicesRecoveryVerifyIndex.md +++ b/docs/reference/api/IndicesRecoveryVerifyIndex.md @@ -1,4 +1,4 @@ -## Interface `IndicesRecoveryVerifyIndex` +# `IndicesRecoveryVerifyIndex` [interface-IndicesRecoveryVerifyIndex] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesRefreshRequest.md b/docs/reference/api/IndicesRefreshRequest.md index eb19e5efe..244075740 100644 --- a/docs/reference/api/IndicesRefreshRequest.md +++ b/docs/reference/api/IndicesRefreshRequest.md @@ -1,4 +1,4 @@ -## Interface `IndicesRefreshRequest` +# `IndicesRefreshRequest` [interface-IndicesRefreshRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesRefreshResponse.md b/docs/reference/api/IndicesRefreshResponse.md index c0d086096..4109cd152 100644 --- a/docs/reference/api/IndicesRefreshResponse.md +++ b/docs/reference/api/IndicesRefreshResponse.md @@ -1,4 +1,4 @@ -## `IndicesRefreshResponse` -::: +# `IndicesRefreshResponse` [alias-IndicesRefreshResponse] +```typescript type IndicesRefreshResponse = [ShardsOperationResponseBase](./ShardsOperationResponseBase.md); -::: +``` diff --git a/docs/reference/api/IndicesReloadSearchAnalyzersReloadDetails.md b/docs/reference/api/IndicesReloadSearchAnalyzersReloadDetails.md index 2a033652e..7d35ab01c 100644 --- a/docs/reference/api/IndicesReloadSearchAnalyzersReloadDetails.md +++ b/docs/reference/api/IndicesReloadSearchAnalyzersReloadDetails.md @@ -1,4 +1,4 @@ -## Interface `IndicesReloadSearchAnalyzersReloadDetails` +# `IndicesReloadSearchAnalyzersReloadDetails` [interface-IndicesReloadSearchAnalyzersReloadDetails] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesReloadSearchAnalyzersReloadResult.md b/docs/reference/api/IndicesReloadSearchAnalyzersReloadResult.md index 317cba9d2..89f68db2f 100644 --- a/docs/reference/api/IndicesReloadSearchAnalyzersReloadResult.md +++ b/docs/reference/api/IndicesReloadSearchAnalyzersReloadResult.md @@ -1,4 +1,4 @@ -## Interface `IndicesReloadSearchAnalyzersReloadResult` +# `IndicesReloadSearchAnalyzersReloadResult` [interface-IndicesReloadSearchAnalyzersReloadResult] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesReloadSearchAnalyzersRequest.md b/docs/reference/api/IndicesReloadSearchAnalyzersRequest.md index f43927fd4..9c5d95197 100644 --- a/docs/reference/api/IndicesReloadSearchAnalyzersRequest.md +++ b/docs/reference/api/IndicesReloadSearchAnalyzersRequest.md @@ -1,4 +1,4 @@ -## Interface `IndicesReloadSearchAnalyzersRequest` +# `IndicesReloadSearchAnalyzersRequest` [interface-IndicesReloadSearchAnalyzersRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesReloadSearchAnalyzersResponse.md b/docs/reference/api/IndicesReloadSearchAnalyzersResponse.md index d7e915c12..c32eddca0 100644 --- a/docs/reference/api/IndicesReloadSearchAnalyzersResponse.md +++ b/docs/reference/api/IndicesReloadSearchAnalyzersResponse.md @@ -1,4 +1,4 @@ -## `IndicesReloadSearchAnalyzersResponse` -::: +# `IndicesReloadSearchAnalyzersResponse` [alias-IndicesReloadSearchAnalyzersResponse] +```typescript type IndicesReloadSearchAnalyzersResponse = [IndicesReloadSearchAnalyzersReloadResult](./IndicesReloadSearchAnalyzersReloadResult.md); -::: +``` diff --git a/docs/reference/api/IndicesResolveClusterRequest.md b/docs/reference/api/IndicesResolveClusterRequest.md index 367e15a54..993134cd3 100644 --- a/docs/reference/api/IndicesResolveClusterRequest.md +++ b/docs/reference/api/IndicesResolveClusterRequest.md @@ -1,4 +1,4 @@ -## Interface `IndicesResolveClusterRequest` +# `IndicesResolveClusterRequest` [interface-IndicesResolveClusterRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesResolveClusterResolveClusterInfo.md b/docs/reference/api/IndicesResolveClusterResolveClusterInfo.md index 2a9dc7e3c..36ee38355 100644 --- a/docs/reference/api/IndicesResolveClusterResolveClusterInfo.md +++ b/docs/reference/api/IndicesResolveClusterResolveClusterInfo.md @@ -1,4 +1,4 @@ -## Interface `IndicesResolveClusterResolveClusterInfo` +# `IndicesResolveClusterResolveClusterInfo` [interface-IndicesResolveClusterResolveClusterInfo] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesResolveClusterResponse.md b/docs/reference/api/IndicesResolveClusterResponse.md index 5cc472faf..89d792b1d 100644 --- a/docs/reference/api/IndicesResolveClusterResponse.md +++ b/docs/reference/api/IndicesResolveClusterResponse.md @@ -1,4 +1,4 @@ -## `IndicesResolveClusterResponse` -::: +# `IndicesResolveClusterResponse` [alias-IndicesResolveClusterResponse] +```typescript type IndicesResolveClusterResponse = Record<[ClusterAlias](./ClusterAlias.md), [IndicesResolveClusterResolveClusterInfo](./IndicesResolveClusterResolveClusterInfo.md)>; -::: +``` diff --git a/docs/reference/api/IndicesResolveIndexRequest.md b/docs/reference/api/IndicesResolveIndexRequest.md index 1a0b00c29..729a0f43f 100644 --- a/docs/reference/api/IndicesResolveIndexRequest.md +++ b/docs/reference/api/IndicesResolveIndexRequest.md @@ -1,4 +1,4 @@ -## Interface `IndicesResolveIndexRequest` +# `IndicesResolveIndexRequest` [interface-IndicesResolveIndexRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesResolveIndexResolveIndexAliasItem.md b/docs/reference/api/IndicesResolveIndexResolveIndexAliasItem.md index 49e9bbf01..a7b36272c 100644 --- a/docs/reference/api/IndicesResolveIndexResolveIndexAliasItem.md +++ b/docs/reference/api/IndicesResolveIndexResolveIndexAliasItem.md @@ -1,4 +1,4 @@ -## Interface `IndicesResolveIndexResolveIndexAliasItem` +# `IndicesResolveIndexResolveIndexAliasItem` [interface-IndicesResolveIndexResolveIndexAliasItem] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesResolveIndexResolveIndexDataStreamsItem.md b/docs/reference/api/IndicesResolveIndexResolveIndexDataStreamsItem.md index cf5663ccb..1767011f9 100644 --- a/docs/reference/api/IndicesResolveIndexResolveIndexDataStreamsItem.md +++ b/docs/reference/api/IndicesResolveIndexResolveIndexDataStreamsItem.md @@ -1,4 +1,4 @@ -## Interface `IndicesResolveIndexResolveIndexDataStreamsItem` +# `IndicesResolveIndexResolveIndexDataStreamsItem` [interface-IndicesResolveIndexResolveIndexDataStreamsItem] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesResolveIndexResolveIndexItem.md b/docs/reference/api/IndicesResolveIndexResolveIndexItem.md index e5d2347d3..26e683354 100644 --- a/docs/reference/api/IndicesResolveIndexResolveIndexItem.md +++ b/docs/reference/api/IndicesResolveIndexResolveIndexItem.md @@ -1,4 +1,4 @@ -## Interface `IndicesResolveIndexResolveIndexItem` +# `IndicesResolveIndexResolveIndexItem` [interface-IndicesResolveIndexResolveIndexItem] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesResolveIndexResponse.md b/docs/reference/api/IndicesResolveIndexResponse.md index 8b50bee74..7dfa3d009 100644 --- a/docs/reference/api/IndicesResolveIndexResponse.md +++ b/docs/reference/api/IndicesResolveIndexResponse.md @@ -1,4 +1,4 @@ -## Interface `IndicesResolveIndexResponse` +# `IndicesResolveIndexResponse` [interface-IndicesResolveIndexResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesResponseBase.md b/docs/reference/api/IndicesResponseBase.md index 8bfe5fb89..2fa1a66a1 100644 --- a/docs/reference/api/IndicesResponseBase.md +++ b/docs/reference/api/IndicesResponseBase.md @@ -1,4 +1,4 @@ -## Interface `IndicesResponseBase` +# `IndicesResponseBase` [interface-IndicesResponseBase] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesRetentionLease.md b/docs/reference/api/IndicesRetentionLease.md index 00f96faef..f9f30db06 100644 --- a/docs/reference/api/IndicesRetentionLease.md +++ b/docs/reference/api/IndicesRetentionLease.md @@ -1,4 +1,4 @@ -## Interface `IndicesRetentionLease` +# `IndicesRetentionLease` [interface-IndicesRetentionLease] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesRolloverRequest.md b/docs/reference/api/IndicesRolloverRequest.md index cd1d20509..6f5ba86bc 100644 --- a/docs/reference/api/IndicesRolloverRequest.md +++ b/docs/reference/api/IndicesRolloverRequest.md @@ -1,4 +1,4 @@ -## Interface `IndicesRolloverRequest` +# `IndicesRolloverRequest` [interface-IndicesRolloverRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesRolloverResponse.md b/docs/reference/api/IndicesRolloverResponse.md index 0bb46b3b1..cb4715169 100644 --- a/docs/reference/api/IndicesRolloverResponse.md +++ b/docs/reference/api/IndicesRolloverResponse.md @@ -1,4 +1,4 @@ -## Interface `IndicesRolloverResponse` +# `IndicesRolloverResponse` [interface-IndicesRolloverResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesRolloverRolloverConditions.md b/docs/reference/api/IndicesRolloverRolloverConditions.md index 9aa8ccd23..3eccba671 100644 --- a/docs/reference/api/IndicesRolloverRolloverConditions.md +++ b/docs/reference/api/IndicesRolloverRolloverConditions.md @@ -1,4 +1,4 @@ -## Interface `IndicesRolloverRolloverConditions` +# `IndicesRolloverRolloverConditions` [interface-IndicesRolloverRolloverConditions] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesSearchIdle.md b/docs/reference/api/IndicesSearchIdle.md index b914fbb8f..fa557e49a 100644 --- a/docs/reference/api/IndicesSearchIdle.md +++ b/docs/reference/api/IndicesSearchIdle.md @@ -1,4 +1,4 @@ -## Interface `IndicesSearchIdle` +# `IndicesSearchIdle` [interface-IndicesSearchIdle] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesSegmentSortMissing.md b/docs/reference/api/IndicesSegmentSortMissing.md index 4b51fbf0d..a529a79c6 100644 --- a/docs/reference/api/IndicesSegmentSortMissing.md +++ b/docs/reference/api/IndicesSegmentSortMissing.md @@ -1,4 +1,4 @@ -## `IndicesSegmentSortMissing` -::: +# `IndicesSegmentSortMissing` [alias-IndicesSegmentSortMissing] +```typescript type IndicesSegmentSortMissing = '_last' | '_first'; -::: +``` diff --git a/docs/reference/api/IndicesSegmentSortMode.md b/docs/reference/api/IndicesSegmentSortMode.md index 8127daddc..36c063d82 100644 --- a/docs/reference/api/IndicesSegmentSortMode.md +++ b/docs/reference/api/IndicesSegmentSortMode.md @@ -1,4 +1,4 @@ -## `IndicesSegmentSortMode` -::: +# `IndicesSegmentSortMode` [alias-IndicesSegmentSortMode] +```typescript type IndicesSegmentSortMode = 'min' | 'MIN' | 'max' | 'MAX'; -::: +``` diff --git a/docs/reference/api/IndicesSegmentSortOrder.md b/docs/reference/api/IndicesSegmentSortOrder.md index c14671772..66626bddb 100644 --- a/docs/reference/api/IndicesSegmentSortOrder.md +++ b/docs/reference/api/IndicesSegmentSortOrder.md @@ -1,4 +1,4 @@ -## `IndicesSegmentSortOrder` -::: +# `IndicesSegmentSortOrder` [alias-IndicesSegmentSortOrder] +```typescript type IndicesSegmentSortOrder = 'asc' | 'ASC' | 'desc' | 'DESC'; -::: +``` diff --git a/docs/reference/api/IndicesSegmentsIndexSegment.md b/docs/reference/api/IndicesSegmentsIndexSegment.md index e2f87ca23..0316ddf3d 100644 --- a/docs/reference/api/IndicesSegmentsIndexSegment.md +++ b/docs/reference/api/IndicesSegmentsIndexSegment.md @@ -1,4 +1,4 @@ -## Interface `IndicesSegmentsIndexSegment` +# `IndicesSegmentsIndexSegment` [interface-IndicesSegmentsIndexSegment] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesSegmentsRequest.md b/docs/reference/api/IndicesSegmentsRequest.md index 98cdbf902..a69d9827a 100644 --- a/docs/reference/api/IndicesSegmentsRequest.md +++ b/docs/reference/api/IndicesSegmentsRequest.md @@ -1,4 +1,4 @@ -## Interface `IndicesSegmentsRequest` +# `IndicesSegmentsRequest` [interface-IndicesSegmentsRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesSegmentsResponse.md b/docs/reference/api/IndicesSegmentsResponse.md index 6fbb7ee72..9b81dfdff 100644 --- a/docs/reference/api/IndicesSegmentsResponse.md +++ b/docs/reference/api/IndicesSegmentsResponse.md @@ -1,4 +1,4 @@ -## Interface `IndicesSegmentsResponse` +# `IndicesSegmentsResponse` [interface-IndicesSegmentsResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesSegmentsSegment.md b/docs/reference/api/IndicesSegmentsSegment.md index 5e77bd129..aa0d27470 100644 --- a/docs/reference/api/IndicesSegmentsSegment.md +++ b/docs/reference/api/IndicesSegmentsSegment.md @@ -1,4 +1,4 @@ -## Interface `IndicesSegmentsSegment` +# `IndicesSegmentsSegment` [interface-IndicesSegmentsSegment] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesSegmentsShardSegmentRouting.md b/docs/reference/api/IndicesSegmentsShardSegmentRouting.md index 3022d6508..a00938402 100644 --- a/docs/reference/api/IndicesSegmentsShardSegmentRouting.md +++ b/docs/reference/api/IndicesSegmentsShardSegmentRouting.md @@ -1,4 +1,4 @@ -## Interface `IndicesSegmentsShardSegmentRouting` +# `IndicesSegmentsShardSegmentRouting` [interface-IndicesSegmentsShardSegmentRouting] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesSegmentsShardsSegment.md b/docs/reference/api/IndicesSegmentsShardsSegment.md index 9d091f60a..4fb7e1a30 100644 --- a/docs/reference/api/IndicesSegmentsShardsSegment.md +++ b/docs/reference/api/IndicesSegmentsShardsSegment.md @@ -1,4 +1,4 @@ -## Interface `IndicesSegmentsShardsSegment` +# `IndicesSegmentsShardsSegment` [interface-IndicesSegmentsShardsSegment] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesSettingsAnalyze.md b/docs/reference/api/IndicesSettingsAnalyze.md index 2ee4a53ef..aafe5d7c7 100644 --- a/docs/reference/api/IndicesSettingsAnalyze.md +++ b/docs/reference/api/IndicesSettingsAnalyze.md @@ -1,4 +1,4 @@ -## Interface `IndicesSettingsAnalyze` +# `IndicesSettingsAnalyze` [interface-IndicesSettingsAnalyze] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesSettingsHighlight.md b/docs/reference/api/IndicesSettingsHighlight.md index df4aa6d8a..ad4dbe69f 100644 --- a/docs/reference/api/IndicesSettingsHighlight.md +++ b/docs/reference/api/IndicesSettingsHighlight.md @@ -1,4 +1,4 @@ -## Interface `IndicesSettingsHighlight` +# `IndicesSettingsHighlight` [interface-IndicesSettingsHighlight] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesSettingsQueryString.md b/docs/reference/api/IndicesSettingsQueryString.md index 32adc28f4..deef91fcd 100644 --- a/docs/reference/api/IndicesSettingsQueryString.md +++ b/docs/reference/api/IndicesSettingsQueryString.md @@ -1,4 +1,4 @@ -## Interface `IndicesSettingsQueryString` +# `IndicesSettingsQueryString` [interface-IndicesSettingsQueryString] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesSettingsSearch.md b/docs/reference/api/IndicesSettingsSearch.md index fa70ad20b..b2fc9ac33 100644 --- a/docs/reference/api/IndicesSettingsSearch.md +++ b/docs/reference/api/IndicesSettingsSearch.md @@ -1,4 +1,4 @@ -## Interface `IndicesSettingsSearch` +# `IndicesSettingsSearch` [interface-IndicesSettingsSearch] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesSettingsSimilarity.md b/docs/reference/api/IndicesSettingsSimilarity.md index ff4ab730f..ff351db9d 100644 --- a/docs/reference/api/IndicesSettingsSimilarity.md +++ b/docs/reference/api/IndicesSettingsSimilarity.md @@ -1,4 +1,4 @@ -## `IndicesSettingsSimilarity` -::: +# `IndicesSettingsSimilarity` [alias-IndicesSettingsSimilarity] +```typescript type IndicesSettingsSimilarity = [IndicesSettingsSimilarityBm25](./IndicesSettingsSimilarityBm25.md) | [IndicesSettingsSimilarityBoolean](./IndicesSettingsSimilarityBoolean.md) | [IndicesSettingsSimilarityDfi](./IndicesSettingsSimilarityDfi.md) | [IndicesSettingsSimilarityDfr](./IndicesSettingsSimilarityDfr.md) | [IndicesSettingsSimilarityIb](./IndicesSettingsSimilarityIb.md) | [IndicesSettingsSimilarityLmd](./IndicesSettingsSimilarityLmd.md) | [IndicesSettingsSimilarityLmj](./IndicesSettingsSimilarityLmj.md) | [IndicesSettingsSimilarityScripted](./IndicesSettingsSimilarityScripted.md); -::: +``` diff --git a/docs/reference/api/IndicesSettingsSimilarityBm25.md b/docs/reference/api/IndicesSettingsSimilarityBm25.md index 0f4fb884d..9146f0866 100644 --- a/docs/reference/api/IndicesSettingsSimilarityBm25.md +++ b/docs/reference/api/IndicesSettingsSimilarityBm25.md @@ -1,4 +1,4 @@ -## Interface `IndicesSettingsSimilarityBm25` +# `IndicesSettingsSimilarityBm25` [interface-IndicesSettingsSimilarityBm25] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesSettingsSimilarityBoolean.md b/docs/reference/api/IndicesSettingsSimilarityBoolean.md index 1ab91ea93..0cb26602b 100644 --- a/docs/reference/api/IndicesSettingsSimilarityBoolean.md +++ b/docs/reference/api/IndicesSettingsSimilarityBoolean.md @@ -1,4 +1,4 @@ -## Interface `IndicesSettingsSimilarityBoolean` +# `IndicesSettingsSimilarityBoolean` [interface-IndicesSettingsSimilarityBoolean] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesSettingsSimilarityDfi.md b/docs/reference/api/IndicesSettingsSimilarityDfi.md index 7f455800c..e502c7e27 100644 --- a/docs/reference/api/IndicesSettingsSimilarityDfi.md +++ b/docs/reference/api/IndicesSettingsSimilarityDfi.md @@ -1,4 +1,4 @@ -## Interface `IndicesSettingsSimilarityDfi` +# `IndicesSettingsSimilarityDfi` [interface-IndicesSettingsSimilarityDfi] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesSettingsSimilarityDfr.md b/docs/reference/api/IndicesSettingsSimilarityDfr.md index 4aab7c729..3556ad1ca 100644 --- a/docs/reference/api/IndicesSettingsSimilarityDfr.md +++ b/docs/reference/api/IndicesSettingsSimilarityDfr.md @@ -1,4 +1,4 @@ -## Interface `IndicesSettingsSimilarityDfr` +# `IndicesSettingsSimilarityDfr` [interface-IndicesSettingsSimilarityDfr] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesSettingsSimilarityIb.md b/docs/reference/api/IndicesSettingsSimilarityIb.md index 23f924c50..edf7e8a34 100644 --- a/docs/reference/api/IndicesSettingsSimilarityIb.md +++ b/docs/reference/api/IndicesSettingsSimilarityIb.md @@ -1,4 +1,4 @@ -## Interface `IndicesSettingsSimilarityIb` +# `IndicesSettingsSimilarityIb` [interface-IndicesSettingsSimilarityIb] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesSettingsSimilarityLmd.md b/docs/reference/api/IndicesSettingsSimilarityLmd.md index 822940b82..71e4f1341 100644 --- a/docs/reference/api/IndicesSettingsSimilarityLmd.md +++ b/docs/reference/api/IndicesSettingsSimilarityLmd.md @@ -1,4 +1,4 @@ -## Interface `IndicesSettingsSimilarityLmd` +# `IndicesSettingsSimilarityLmd` [interface-IndicesSettingsSimilarityLmd] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesSettingsSimilarityLmj.md b/docs/reference/api/IndicesSettingsSimilarityLmj.md index 091bad49e..d629d5b31 100644 --- a/docs/reference/api/IndicesSettingsSimilarityLmj.md +++ b/docs/reference/api/IndicesSettingsSimilarityLmj.md @@ -1,4 +1,4 @@ -## Interface `IndicesSettingsSimilarityLmj` +# `IndicesSettingsSimilarityLmj` [interface-IndicesSettingsSimilarityLmj] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesSettingsSimilarityScripted.md b/docs/reference/api/IndicesSettingsSimilarityScripted.md index ed45ba6d3..581464eea 100644 --- a/docs/reference/api/IndicesSettingsSimilarityScripted.md +++ b/docs/reference/api/IndicesSettingsSimilarityScripted.md @@ -1,4 +1,4 @@ -## Interface `IndicesSettingsSimilarityScripted` +# `IndicesSettingsSimilarityScripted` [interface-IndicesSettingsSimilarityScripted] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesShardStoresIndicesShardStores.md b/docs/reference/api/IndicesShardStoresIndicesShardStores.md index c5a468997..7d0c48c88 100644 --- a/docs/reference/api/IndicesShardStoresIndicesShardStores.md +++ b/docs/reference/api/IndicesShardStoresIndicesShardStores.md @@ -1,4 +1,4 @@ -## Interface `IndicesShardStoresIndicesShardStores` +# `IndicesShardStoresIndicesShardStores` [interface-IndicesShardStoresIndicesShardStores] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesShardStoresRequest.md b/docs/reference/api/IndicesShardStoresRequest.md index 7ac5fb698..f5dd315bc 100644 --- a/docs/reference/api/IndicesShardStoresRequest.md +++ b/docs/reference/api/IndicesShardStoresRequest.md @@ -1,4 +1,4 @@ -## Interface `IndicesShardStoresRequest` +# `IndicesShardStoresRequest` [interface-IndicesShardStoresRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesShardStoresResponse.md b/docs/reference/api/IndicesShardStoresResponse.md index 7407e8249..0a25868c9 100644 --- a/docs/reference/api/IndicesShardStoresResponse.md +++ b/docs/reference/api/IndicesShardStoresResponse.md @@ -1,4 +1,4 @@ -## Interface `IndicesShardStoresResponse` +# `IndicesShardStoresResponse` [interface-IndicesShardStoresResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesShardStoresShardStore.md b/docs/reference/api/IndicesShardStoresShardStore.md index 8f60a47d6..44d88f8c5 100644 --- a/docs/reference/api/IndicesShardStoresShardStore.md +++ b/docs/reference/api/IndicesShardStoresShardStore.md @@ -1,4 +1,4 @@ -## `IndicesShardStoresShardStore` -::: +# `IndicesShardStoresShardStore` [alias-IndicesShardStoresShardStore] +```typescript type IndicesShardStoresShardStore = [IndicesShardStoresShardStoreKeys](./IndicesShardStoresShardStoreKeys.md) & { [property: string]: [IndicesShardStoresShardStoreNode](./IndicesShardStoresShardStoreNode.md) | [IndicesShardStoresShardStoreAllocation](./IndicesShardStoresShardStoreAllocation.md) | [Id](./Id.md) | [IndicesShardStoresShardStoreException](./IndicesShardStoresShardStoreException.md);}; -::: +``` diff --git a/docs/reference/api/IndicesShardStoresShardStoreAllocation.md b/docs/reference/api/IndicesShardStoresShardStoreAllocation.md index b7cb152a0..e6a6edb06 100644 --- a/docs/reference/api/IndicesShardStoresShardStoreAllocation.md +++ b/docs/reference/api/IndicesShardStoresShardStoreAllocation.md @@ -1,4 +1,4 @@ -## `IndicesShardStoresShardStoreAllocation` -::: +# `IndicesShardStoresShardStoreAllocation` [alias-IndicesShardStoresShardStoreAllocation] +```typescript type IndicesShardStoresShardStoreAllocation = 'primary' | 'replica' | 'unused'; -::: +``` diff --git a/docs/reference/api/IndicesShardStoresShardStoreException.md b/docs/reference/api/IndicesShardStoresShardStoreException.md index 5b4533e14..e064fbb10 100644 --- a/docs/reference/api/IndicesShardStoresShardStoreException.md +++ b/docs/reference/api/IndicesShardStoresShardStoreException.md @@ -1,4 +1,4 @@ -## Interface `IndicesShardStoresShardStoreException` +# `IndicesShardStoresShardStoreException` [interface-IndicesShardStoresShardStoreException] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesShardStoresShardStoreKeys.md b/docs/reference/api/IndicesShardStoresShardStoreKeys.md index 6c344cc64..9a7a4e658 100644 --- a/docs/reference/api/IndicesShardStoresShardStoreKeys.md +++ b/docs/reference/api/IndicesShardStoresShardStoreKeys.md @@ -1,4 +1,4 @@ -## Interface `IndicesShardStoresShardStoreKeys` +# `IndicesShardStoresShardStoreKeys` [interface-IndicesShardStoresShardStoreKeys] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesShardStoresShardStoreNode.md b/docs/reference/api/IndicesShardStoresShardStoreNode.md index 30862c820..2cb83dfcf 100644 --- a/docs/reference/api/IndicesShardStoresShardStoreNode.md +++ b/docs/reference/api/IndicesShardStoresShardStoreNode.md @@ -1,4 +1,4 @@ -## Interface `IndicesShardStoresShardStoreNode` +# `IndicesShardStoresShardStoreNode` [interface-IndicesShardStoresShardStoreNode] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesShardStoresShardStoreStatus.md b/docs/reference/api/IndicesShardStoresShardStoreStatus.md index f6f3fdd6d..0ce476b51 100644 --- a/docs/reference/api/IndicesShardStoresShardStoreStatus.md +++ b/docs/reference/api/IndicesShardStoresShardStoreStatus.md @@ -1,4 +1,4 @@ -## `IndicesShardStoresShardStoreStatus` -::: +# `IndicesShardStoresShardStoreStatus` [alias-IndicesShardStoresShardStoreStatus] +```typescript type IndicesShardStoresShardStoreStatus = 'green' | 'yellow' | 'red' | 'all'; -::: +``` diff --git a/docs/reference/api/IndicesShardStoresShardStoreWrapper.md b/docs/reference/api/IndicesShardStoresShardStoreWrapper.md index 04e4d0cd1..3d100704d 100644 --- a/docs/reference/api/IndicesShardStoresShardStoreWrapper.md +++ b/docs/reference/api/IndicesShardStoresShardStoreWrapper.md @@ -1,4 +1,4 @@ -## Interface `IndicesShardStoresShardStoreWrapper` +# `IndicesShardStoresShardStoreWrapper` [interface-IndicesShardStoresShardStoreWrapper] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesShrinkRequest.md b/docs/reference/api/IndicesShrinkRequest.md index 36fd11b4f..058c158e6 100644 --- a/docs/reference/api/IndicesShrinkRequest.md +++ b/docs/reference/api/IndicesShrinkRequest.md @@ -1,4 +1,4 @@ -## Interface `IndicesShrinkRequest` +# `IndicesShrinkRequest` [interface-IndicesShrinkRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesShrinkResponse.md b/docs/reference/api/IndicesShrinkResponse.md index 0032b17fd..7a69dba19 100644 --- a/docs/reference/api/IndicesShrinkResponse.md +++ b/docs/reference/api/IndicesShrinkResponse.md @@ -1,4 +1,4 @@ -## Interface `IndicesShrinkResponse` +# `IndicesShrinkResponse` [interface-IndicesShrinkResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesSimulateIndexTemplateRequest.md b/docs/reference/api/IndicesSimulateIndexTemplateRequest.md index a7fe69920..e1a27188b 100644 --- a/docs/reference/api/IndicesSimulateIndexTemplateRequest.md +++ b/docs/reference/api/IndicesSimulateIndexTemplateRequest.md @@ -1,4 +1,4 @@ -## Interface `IndicesSimulateIndexTemplateRequest` +# `IndicesSimulateIndexTemplateRequest` [interface-IndicesSimulateIndexTemplateRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesSimulateIndexTemplateResponse.md b/docs/reference/api/IndicesSimulateIndexTemplateResponse.md index d5f008d77..2aaaa3880 100644 --- a/docs/reference/api/IndicesSimulateIndexTemplateResponse.md +++ b/docs/reference/api/IndicesSimulateIndexTemplateResponse.md @@ -1,4 +1,4 @@ -## Interface `IndicesSimulateIndexTemplateResponse` +# `IndicesSimulateIndexTemplateResponse` [interface-IndicesSimulateIndexTemplateResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesSimulateTemplateOverlapping.md b/docs/reference/api/IndicesSimulateTemplateOverlapping.md index a7bba81b7..4ee7be3d2 100644 --- a/docs/reference/api/IndicesSimulateTemplateOverlapping.md +++ b/docs/reference/api/IndicesSimulateTemplateOverlapping.md @@ -1,4 +1,4 @@ -## Interface `IndicesSimulateTemplateOverlapping` +# `IndicesSimulateTemplateOverlapping` [interface-IndicesSimulateTemplateOverlapping] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesSimulateTemplateRequest.md b/docs/reference/api/IndicesSimulateTemplateRequest.md index d5750efca..08210a832 100644 --- a/docs/reference/api/IndicesSimulateTemplateRequest.md +++ b/docs/reference/api/IndicesSimulateTemplateRequest.md @@ -1,4 +1,4 @@ -## Interface `IndicesSimulateTemplateRequest` +# `IndicesSimulateTemplateRequest` [interface-IndicesSimulateTemplateRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesSimulateTemplateResponse.md b/docs/reference/api/IndicesSimulateTemplateResponse.md index 74cf7559c..a2383cf22 100644 --- a/docs/reference/api/IndicesSimulateTemplateResponse.md +++ b/docs/reference/api/IndicesSimulateTemplateResponse.md @@ -1,4 +1,4 @@ -## Interface `IndicesSimulateTemplateResponse` +# `IndicesSimulateTemplateResponse` [interface-IndicesSimulateTemplateResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesSimulateTemplateTemplate.md b/docs/reference/api/IndicesSimulateTemplateTemplate.md index d9bb2cf04..1b34f9a65 100644 --- a/docs/reference/api/IndicesSimulateTemplateTemplate.md +++ b/docs/reference/api/IndicesSimulateTemplateTemplate.md @@ -1,4 +1,4 @@ -## Interface `IndicesSimulateTemplateTemplate` +# `IndicesSimulateTemplateTemplate` [interface-IndicesSimulateTemplateTemplate] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesSlowlogSettings.md b/docs/reference/api/IndicesSlowlogSettings.md index 5174f97a2..34b3d50e8 100644 --- a/docs/reference/api/IndicesSlowlogSettings.md +++ b/docs/reference/api/IndicesSlowlogSettings.md @@ -1,4 +1,4 @@ -## Interface `IndicesSlowlogSettings` +# `IndicesSlowlogSettings` [interface-IndicesSlowlogSettings] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesSlowlogTresholdLevels.md b/docs/reference/api/IndicesSlowlogTresholdLevels.md index 658abc191..506362031 100644 --- a/docs/reference/api/IndicesSlowlogTresholdLevels.md +++ b/docs/reference/api/IndicesSlowlogTresholdLevels.md @@ -1,4 +1,4 @@ -## Interface `IndicesSlowlogTresholdLevels` +# `IndicesSlowlogTresholdLevels` [interface-IndicesSlowlogTresholdLevels] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesSlowlogTresholds.md b/docs/reference/api/IndicesSlowlogTresholds.md index 3e328c456..1a192d2a1 100644 --- a/docs/reference/api/IndicesSlowlogTresholds.md +++ b/docs/reference/api/IndicesSlowlogTresholds.md @@ -1,4 +1,4 @@ -## Interface `IndicesSlowlogTresholds` +# `IndicesSlowlogTresholds` [interface-IndicesSlowlogTresholds] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesSoftDeletes.md b/docs/reference/api/IndicesSoftDeletes.md index 7f7f1a69f..f8376f341 100644 --- a/docs/reference/api/IndicesSoftDeletes.md +++ b/docs/reference/api/IndicesSoftDeletes.md @@ -1,4 +1,4 @@ -## Interface `IndicesSoftDeletes` +# `IndicesSoftDeletes` [interface-IndicesSoftDeletes] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesSourceMode.md b/docs/reference/api/IndicesSourceMode.md index 28f734bc2..4cf386dc7 100644 --- a/docs/reference/api/IndicesSourceMode.md +++ b/docs/reference/api/IndicesSourceMode.md @@ -1,4 +1,4 @@ -## `IndicesSourceMode` -::: +# `IndicesSourceMode` [alias-IndicesSourceMode] +```typescript type IndicesSourceMode = 'disabled' | 'stored' | 'synthetic'; -::: +``` diff --git a/docs/reference/api/IndicesSplitRequest.md b/docs/reference/api/IndicesSplitRequest.md index c238db684..9dc2f0a0e 100644 --- a/docs/reference/api/IndicesSplitRequest.md +++ b/docs/reference/api/IndicesSplitRequest.md @@ -1,4 +1,4 @@ -## Interface `IndicesSplitRequest` +# `IndicesSplitRequest` [interface-IndicesSplitRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesSplitResponse.md b/docs/reference/api/IndicesSplitResponse.md index 9f0ddf779..0dcd34e9c 100644 --- a/docs/reference/api/IndicesSplitResponse.md +++ b/docs/reference/api/IndicesSplitResponse.md @@ -1,4 +1,4 @@ -## Interface `IndicesSplitResponse` +# `IndicesSplitResponse` [interface-IndicesSplitResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesStatsIndexMetadataState.md b/docs/reference/api/IndicesStatsIndexMetadataState.md index 77df7c4be..428308b6e 100644 --- a/docs/reference/api/IndicesStatsIndexMetadataState.md +++ b/docs/reference/api/IndicesStatsIndexMetadataState.md @@ -1,4 +1,4 @@ -## `IndicesStatsIndexMetadataState` -::: +# `IndicesStatsIndexMetadataState` [alias-IndicesStatsIndexMetadataState] +```typescript type IndicesStatsIndexMetadataState = 'open' | 'close'; -::: +``` diff --git a/docs/reference/api/IndicesStatsIndexStats.md b/docs/reference/api/IndicesStatsIndexStats.md index e78b3055c..287e2feab 100644 --- a/docs/reference/api/IndicesStatsIndexStats.md +++ b/docs/reference/api/IndicesStatsIndexStats.md @@ -1,4 +1,4 @@ -## Interface `IndicesStatsIndexStats` +# `IndicesStatsIndexStats` [interface-IndicesStatsIndexStats] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesStatsIndicesStats.md b/docs/reference/api/IndicesStatsIndicesStats.md index ce1954a93..70bd67d0e 100644 --- a/docs/reference/api/IndicesStatsIndicesStats.md +++ b/docs/reference/api/IndicesStatsIndicesStats.md @@ -1,4 +1,4 @@ -## Interface `IndicesStatsIndicesStats` +# `IndicesStatsIndicesStats` [interface-IndicesStatsIndicesStats] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesStatsMappingStats.md b/docs/reference/api/IndicesStatsMappingStats.md index 495e3cb03..87424071c 100644 --- a/docs/reference/api/IndicesStatsMappingStats.md +++ b/docs/reference/api/IndicesStatsMappingStats.md @@ -1,4 +1,4 @@ -## Interface `IndicesStatsMappingStats` +# `IndicesStatsMappingStats` [interface-IndicesStatsMappingStats] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesStatsRequest.md b/docs/reference/api/IndicesStatsRequest.md index aa0e8935a..e038ded48 100644 --- a/docs/reference/api/IndicesStatsRequest.md +++ b/docs/reference/api/IndicesStatsRequest.md @@ -1,4 +1,4 @@ -## Interface `IndicesStatsRequest` +# `IndicesStatsRequest` [interface-IndicesStatsRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesStatsResponse.md b/docs/reference/api/IndicesStatsResponse.md index 78e9b9bac..e4b7e5a7a 100644 --- a/docs/reference/api/IndicesStatsResponse.md +++ b/docs/reference/api/IndicesStatsResponse.md @@ -1,4 +1,4 @@ -## Interface `IndicesStatsResponse` +# `IndicesStatsResponse` [interface-IndicesStatsResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesStatsShardCommit.md b/docs/reference/api/IndicesStatsShardCommit.md index 5799cdd2e..d9bd0cd9c 100644 --- a/docs/reference/api/IndicesStatsShardCommit.md +++ b/docs/reference/api/IndicesStatsShardCommit.md @@ -1,4 +1,4 @@ -## Interface `IndicesStatsShardCommit` +# `IndicesStatsShardCommit` [interface-IndicesStatsShardCommit] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesStatsShardFileSizeInfo.md b/docs/reference/api/IndicesStatsShardFileSizeInfo.md index de836a7a6..e61a687d2 100644 --- a/docs/reference/api/IndicesStatsShardFileSizeInfo.md +++ b/docs/reference/api/IndicesStatsShardFileSizeInfo.md @@ -1,4 +1,4 @@ -## Interface `IndicesStatsShardFileSizeInfo` +# `IndicesStatsShardFileSizeInfo` [interface-IndicesStatsShardFileSizeInfo] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesStatsShardLease.md b/docs/reference/api/IndicesStatsShardLease.md index 85c47dbcb..ad5a641b1 100644 --- a/docs/reference/api/IndicesStatsShardLease.md +++ b/docs/reference/api/IndicesStatsShardLease.md @@ -1,4 +1,4 @@ -## Interface `IndicesStatsShardLease` +# `IndicesStatsShardLease` [interface-IndicesStatsShardLease] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesStatsShardPath.md b/docs/reference/api/IndicesStatsShardPath.md index 9da5bd67b..c0445723f 100644 --- a/docs/reference/api/IndicesStatsShardPath.md +++ b/docs/reference/api/IndicesStatsShardPath.md @@ -1,4 +1,4 @@ -## Interface `IndicesStatsShardPath` +# `IndicesStatsShardPath` [interface-IndicesStatsShardPath] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesStatsShardQueryCache.md b/docs/reference/api/IndicesStatsShardQueryCache.md index 26e1cdf43..fe32abfe1 100644 --- a/docs/reference/api/IndicesStatsShardQueryCache.md +++ b/docs/reference/api/IndicesStatsShardQueryCache.md @@ -1,4 +1,4 @@ -## Interface `IndicesStatsShardQueryCache` +# `IndicesStatsShardQueryCache` [interface-IndicesStatsShardQueryCache] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesStatsShardRetentionLeases.md b/docs/reference/api/IndicesStatsShardRetentionLeases.md index 44b5c7a08..b19577fd4 100644 --- a/docs/reference/api/IndicesStatsShardRetentionLeases.md +++ b/docs/reference/api/IndicesStatsShardRetentionLeases.md @@ -1,4 +1,4 @@ -## Interface `IndicesStatsShardRetentionLeases` +# `IndicesStatsShardRetentionLeases` [interface-IndicesStatsShardRetentionLeases] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesStatsShardRouting.md b/docs/reference/api/IndicesStatsShardRouting.md index 1c9fd0af7..51f306df4 100644 --- a/docs/reference/api/IndicesStatsShardRouting.md +++ b/docs/reference/api/IndicesStatsShardRouting.md @@ -1,4 +1,4 @@ -## Interface `IndicesStatsShardRouting` +# `IndicesStatsShardRouting` [interface-IndicesStatsShardRouting] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesStatsShardRoutingState.md b/docs/reference/api/IndicesStatsShardRoutingState.md index 985085bac..6c452f06d 100644 --- a/docs/reference/api/IndicesStatsShardRoutingState.md +++ b/docs/reference/api/IndicesStatsShardRoutingState.md @@ -1,4 +1,4 @@ -## `IndicesStatsShardRoutingState` -::: +# `IndicesStatsShardRoutingState` [alias-IndicesStatsShardRoutingState] +```typescript type IndicesStatsShardRoutingState = 'UNASSIGNED' | 'INITIALIZING' | 'STARTED' | 'RELOCATING'; -::: +``` diff --git a/docs/reference/api/IndicesStatsShardSequenceNumber.md b/docs/reference/api/IndicesStatsShardSequenceNumber.md index 034cd100c..9c37df77d 100644 --- a/docs/reference/api/IndicesStatsShardSequenceNumber.md +++ b/docs/reference/api/IndicesStatsShardSequenceNumber.md @@ -1,4 +1,4 @@ -## Interface `IndicesStatsShardSequenceNumber` +# `IndicesStatsShardSequenceNumber` [interface-IndicesStatsShardSequenceNumber] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesStatsShardStats.md b/docs/reference/api/IndicesStatsShardStats.md index 8372cf314..d1b594e99 100644 --- a/docs/reference/api/IndicesStatsShardStats.md +++ b/docs/reference/api/IndicesStatsShardStats.md @@ -1,4 +1,4 @@ -## Interface `IndicesStatsShardStats` +# `IndicesStatsShardStats` [interface-IndicesStatsShardStats] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesStatsShardsTotalStats.md b/docs/reference/api/IndicesStatsShardsTotalStats.md index dfa01494c..6ff48a6e3 100644 --- a/docs/reference/api/IndicesStatsShardsTotalStats.md +++ b/docs/reference/api/IndicesStatsShardsTotalStats.md @@ -1,4 +1,4 @@ -## Interface `IndicesStatsShardsTotalStats` +# `IndicesStatsShardsTotalStats` [interface-IndicesStatsShardsTotalStats] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesStorage.md b/docs/reference/api/IndicesStorage.md index 26aedc06a..4e6f9b5a0 100644 --- a/docs/reference/api/IndicesStorage.md +++ b/docs/reference/api/IndicesStorage.md @@ -1,4 +1,4 @@ -## Interface `IndicesStorage` +# `IndicesStorage` [interface-IndicesStorage] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesStorageType.md b/docs/reference/api/IndicesStorageType.md index c711559bf..268a0266c 100644 --- a/docs/reference/api/IndicesStorageType.md +++ b/docs/reference/api/IndicesStorageType.md @@ -1,4 +1,4 @@ -## `IndicesStorageType` -::: +# `IndicesStorageType` [alias-IndicesStorageType] +```typescript type IndicesStorageType = 'fs' | 'niofs' | 'mmapfs' | 'hybridfs' | string; -::: +``` diff --git a/docs/reference/api/IndicesTemplateMapping.md b/docs/reference/api/IndicesTemplateMapping.md index 13ce338e8..9c424c072 100644 --- a/docs/reference/api/IndicesTemplateMapping.md +++ b/docs/reference/api/IndicesTemplateMapping.md @@ -1,4 +1,4 @@ -## Interface `IndicesTemplateMapping` +# `IndicesTemplateMapping` [interface-IndicesTemplateMapping] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesTranslog.md b/docs/reference/api/IndicesTranslog.md index 7d94fde1f..bbefc3b78 100644 --- a/docs/reference/api/IndicesTranslog.md +++ b/docs/reference/api/IndicesTranslog.md @@ -1,4 +1,4 @@ -## Interface `IndicesTranslog` +# `IndicesTranslog` [interface-IndicesTranslog] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesTranslogDurability.md b/docs/reference/api/IndicesTranslogDurability.md index d2d3fa7b0..1ea8edeef 100644 --- a/docs/reference/api/IndicesTranslogDurability.md +++ b/docs/reference/api/IndicesTranslogDurability.md @@ -1,4 +1,4 @@ -## `IndicesTranslogDurability` -::: +# `IndicesTranslogDurability` [alias-IndicesTranslogDurability] +```typescript type IndicesTranslogDurability = 'request' | 'REQUEST' | 'async' | 'ASYNC'; -::: +``` diff --git a/docs/reference/api/IndicesTranslogRetention.md b/docs/reference/api/IndicesTranslogRetention.md index e1df8db19..794e0065a 100644 --- a/docs/reference/api/IndicesTranslogRetention.md +++ b/docs/reference/api/IndicesTranslogRetention.md @@ -1,4 +1,4 @@ -## Interface `IndicesTranslogRetention` +# `IndicesTranslogRetention` [interface-IndicesTranslogRetention] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesUpdateAliasesAction.md b/docs/reference/api/IndicesUpdateAliasesAction.md index 274649992..ddbb90693 100644 --- a/docs/reference/api/IndicesUpdateAliasesAction.md +++ b/docs/reference/api/IndicesUpdateAliasesAction.md @@ -1,4 +1,4 @@ -## Interface `IndicesUpdateAliasesAction` +# `IndicesUpdateAliasesAction` [interface-IndicesUpdateAliasesAction] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesUpdateAliasesAddAction.md b/docs/reference/api/IndicesUpdateAliasesAddAction.md index 28a91b619..928c16645 100644 --- a/docs/reference/api/IndicesUpdateAliasesAddAction.md +++ b/docs/reference/api/IndicesUpdateAliasesAddAction.md @@ -1,4 +1,4 @@ -## Interface `IndicesUpdateAliasesAddAction` +# `IndicesUpdateAliasesAddAction` [interface-IndicesUpdateAliasesAddAction] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesUpdateAliasesRemoveAction.md b/docs/reference/api/IndicesUpdateAliasesRemoveAction.md index d686193cc..65c46e6f6 100644 --- a/docs/reference/api/IndicesUpdateAliasesRemoveAction.md +++ b/docs/reference/api/IndicesUpdateAliasesRemoveAction.md @@ -1,4 +1,4 @@ -## Interface `IndicesUpdateAliasesRemoveAction` +# `IndicesUpdateAliasesRemoveAction` [interface-IndicesUpdateAliasesRemoveAction] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesUpdateAliasesRemoveIndexAction.md b/docs/reference/api/IndicesUpdateAliasesRemoveIndexAction.md index 5376a706f..e78c10074 100644 --- a/docs/reference/api/IndicesUpdateAliasesRemoveIndexAction.md +++ b/docs/reference/api/IndicesUpdateAliasesRemoveIndexAction.md @@ -1,4 +1,4 @@ -## Interface `IndicesUpdateAliasesRemoveIndexAction` +# `IndicesUpdateAliasesRemoveIndexAction` [interface-IndicesUpdateAliasesRemoveIndexAction] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesUpdateAliasesRequest.md b/docs/reference/api/IndicesUpdateAliasesRequest.md index bae5d2b81..a76838503 100644 --- a/docs/reference/api/IndicesUpdateAliasesRequest.md +++ b/docs/reference/api/IndicesUpdateAliasesRequest.md @@ -1,4 +1,4 @@ -## Interface `IndicesUpdateAliasesRequest` +# `IndicesUpdateAliasesRequest` [interface-IndicesUpdateAliasesRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesUpdateAliasesResponse.md b/docs/reference/api/IndicesUpdateAliasesResponse.md index 030dcf607..a1d0ff26f 100644 --- a/docs/reference/api/IndicesUpdateAliasesResponse.md +++ b/docs/reference/api/IndicesUpdateAliasesResponse.md @@ -1,4 +1,4 @@ -## `IndicesUpdateAliasesResponse` -::: +# `IndicesUpdateAliasesResponse` [alias-IndicesUpdateAliasesResponse] +```typescript type IndicesUpdateAliasesResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); -::: +``` diff --git a/docs/reference/api/IndicesValidateQueryIndicesValidationExplanation.md b/docs/reference/api/IndicesValidateQueryIndicesValidationExplanation.md index 8c911f2fa..9ba4a982b 100644 --- a/docs/reference/api/IndicesValidateQueryIndicesValidationExplanation.md +++ b/docs/reference/api/IndicesValidateQueryIndicesValidationExplanation.md @@ -1,4 +1,4 @@ -## Interface `IndicesValidateQueryIndicesValidationExplanation` +# `IndicesValidateQueryIndicesValidationExplanation` [interface-IndicesValidateQueryIndicesValidationExplanation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesValidateQueryRequest.md b/docs/reference/api/IndicesValidateQueryRequest.md index 55c517325..747fd6fb0 100644 --- a/docs/reference/api/IndicesValidateQueryRequest.md +++ b/docs/reference/api/IndicesValidateQueryRequest.md @@ -1,4 +1,4 @@ -## Interface `IndicesValidateQueryRequest` +# `IndicesValidateQueryRequest` [interface-IndicesValidateQueryRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IndicesValidateQueryResponse.md b/docs/reference/api/IndicesValidateQueryResponse.md index 9d84097d7..b24fcbf0a 100644 --- a/docs/reference/api/IndicesValidateQueryResponse.md +++ b/docs/reference/api/IndicesValidateQueryResponse.md @@ -1,4 +1,4 @@ -## Interface `IndicesValidateQueryResponse` +# `IndicesValidateQueryResponse` [interface-IndicesValidateQueryResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/Inference.md b/docs/reference/api/Inference.md index 7b75f0efa..6b209db26 100644 --- a/docs/reference/api/Inference.md +++ b/docs/reference/api/Inference.md @@ -1,19 +1,19 @@ -## `Inference` +# `Inference` [class-Inference] -### Constructor +## Constructor -::: +```typescript new Inference(transport: [Transport](./Transport.md)); -::: +``` -### Properties +## Properties [class-properties-Inference] | Name | Type | Description | | - | - | - | | `acceptedParams` | Record |   | | `transport` | [Transport](./Transport.md) |   | -### Methods +## Methods [class-methods-Inference] | Name | Signature | Description | | - | - | - | diff --git a/docs/reference/api/InferenceAdaptiveAllocations.md b/docs/reference/api/InferenceAdaptiveAllocations.md index bb8893188..68ce4dc33 100644 --- a/docs/reference/api/InferenceAdaptiveAllocations.md +++ b/docs/reference/api/InferenceAdaptiveAllocations.md @@ -1,4 +1,4 @@ -## Interface `InferenceAdaptiveAllocations` +# `InferenceAdaptiveAllocations` [interface-InferenceAdaptiveAllocations] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/InferenceAlibabaCloudServiceSettings.md b/docs/reference/api/InferenceAlibabaCloudServiceSettings.md index 355dcf467..a530525f1 100644 --- a/docs/reference/api/InferenceAlibabaCloudServiceSettings.md +++ b/docs/reference/api/InferenceAlibabaCloudServiceSettings.md @@ -1,4 +1,4 @@ -## Interface `InferenceAlibabaCloudServiceSettings` +# `InferenceAlibabaCloudServiceSettings` [interface-InferenceAlibabaCloudServiceSettings] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/InferenceAlibabaCloudServiceType.md b/docs/reference/api/InferenceAlibabaCloudServiceType.md index ee2d6b65c..92847a3a9 100644 --- a/docs/reference/api/InferenceAlibabaCloudServiceType.md +++ b/docs/reference/api/InferenceAlibabaCloudServiceType.md @@ -1,4 +1,4 @@ -## `InferenceAlibabaCloudServiceType` -::: +# `InferenceAlibabaCloudServiceType` [alias-InferenceAlibabaCloudServiceType] +```typescript type InferenceAlibabaCloudServiceType = 'alibabacloud-ai-search'; -::: +``` diff --git a/docs/reference/api/InferenceAlibabaCloudTaskSettings.md b/docs/reference/api/InferenceAlibabaCloudTaskSettings.md index 381dd591f..555b0139a 100644 --- a/docs/reference/api/InferenceAlibabaCloudTaskSettings.md +++ b/docs/reference/api/InferenceAlibabaCloudTaskSettings.md @@ -1,4 +1,4 @@ -## Interface `InferenceAlibabaCloudTaskSettings` +# `InferenceAlibabaCloudTaskSettings` [interface-InferenceAlibabaCloudTaskSettings] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/InferenceAlibabaCloudTaskType.md b/docs/reference/api/InferenceAlibabaCloudTaskType.md index ec64cc24e..8ef5e1423 100644 --- a/docs/reference/api/InferenceAlibabaCloudTaskType.md +++ b/docs/reference/api/InferenceAlibabaCloudTaskType.md @@ -1,4 +1,4 @@ -## `InferenceAlibabaCloudTaskType` -::: +# `InferenceAlibabaCloudTaskType` [alias-InferenceAlibabaCloudTaskType] +```typescript type InferenceAlibabaCloudTaskType = 'completion' | 'rerank' | 'space_embedding' | 'text_embedding'; -::: +``` diff --git a/docs/reference/api/InferenceAmazonBedrockServiceSettings.md b/docs/reference/api/InferenceAmazonBedrockServiceSettings.md index a23bf0080..8107c27d0 100644 --- a/docs/reference/api/InferenceAmazonBedrockServiceSettings.md +++ b/docs/reference/api/InferenceAmazonBedrockServiceSettings.md @@ -1,4 +1,4 @@ -## Interface `InferenceAmazonBedrockServiceSettings` +# `InferenceAmazonBedrockServiceSettings` [interface-InferenceAmazonBedrockServiceSettings] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/InferenceAmazonBedrockServiceType.md b/docs/reference/api/InferenceAmazonBedrockServiceType.md index 984eb2676..b41be5daa 100644 --- a/docs/reference/api/InferenceAmazonBedrockServiceType.md +++ b/docs/reference/api/InferenceAmazonBedrockServiceType.md @@ -1,4 +1,4 @@ -## `InferenceAmazonBedrockServiceType` -::: +# `InferenceAmazonBedrockServiceType` [alias-InferenceAmazonBedrockServiceType] +```typescript type InferenceAmazonBedrockServiceType = 'amazonbedrock'; -::: +``` diff --git a/docs/reference/api/InferenceAmazonBedrockTaskSettings.md b/docs/reference/api/InferenceAmazonBedrockTaskSettings.md index 747f42bb9..570bb4834 100644 --- a/docs/reference/api/InferenceAmazonBedrockTaskSettings.md +++ b/docs/reference/api/InferenceAmazonBedrockTaskSettings.md @@ -1,4 +1,4 @@ -## Interface `InferenceAmazonBedrockTaskSettings` +# `InferenceAmazonBedrockTaskSettings` [interface-InferenceAmazonBedrockTaskSettings] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/InferenceAmazonBedrockTaskType.md b/docs/reference/api/InferenceAmazonBedrockTaskType.md index 2ef473b95..4a64a2c04 100644 --- a/docs/reference/api/InferenceAmazonBedrockTaskType.md +++ b/docs/reference/api/InferenceAmazonBedrockTaskType.md @@ -1,4 +1,4 @@ -## `InferenceAmazonBedrockTaskType` -::: +# `InferenceAmazonBedrockTaskType` [alias-InferenceAmazonBedrockTaskType] +```typescript type InferenceAmazonBedrockTaskType = 'completion' | 'text_embedding'; -::: +``` diff --git a/docs/reference/api/InferenceAnthropicServiceSettings.md b/docs/reference/api/InferenceAnthropicServiceSettings.md index bcc47a020..7d661082f 100644 --- a/docs/reference/api/InferenceAnthropicServiceSettings.md +++ b/docs/reference/api/InferenceAnthropicServiceSettings.md @@ -1,4 +1,4 @@ -## Interface `InferenceAnthropicServiceSettings` +# `InferenceAnthropicServiceSettings` [interface-InferenceAnthropicServiceSettings] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/InferenceAnthropicServiceType.md b/docs/reference/api/InferenceAnthropicServiceType.md index 8f18f511a..df06b533e 100644 --- a/docs/reference/api/InferenceAnthropicServiceType.md +++ b/docs/reference/api/InferenceAnthropicServiceType.md @@ -1,4 +1,4 @@ -## `InferenceAnthropicServiceType` -::: +# `InferenceAnthropicServiceType` [alias-InferenceAnthropicServiceType] +```typescript type InferenceAnthropicServiceType = 'anthropic'; -::: +``` diff --git a/docs/reference/api/InferenceAnthropicTaskSettings.md b/docs/reference/api/InferenceAnthropicTaskSettings.md index a0dfc5edc..6fdcc62e0 100644 --- a/docs/reference/api/InferenceAnthropicTaskSettings.md +++ b/docs/reference/api/InferenceAnthropicTaskSettings.md @@ -1,4 +1,4 @@ -## Interface `InferenceAnthropicTaskSettings` +# `InferenceAnthropicTaskSettings` [interface-InferenceAnthropicTaskSettings] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/InferenceAnthropicTaskType.md b/docs/reference/api/InferenceAnthropicTaskType.md index 28157ae85..cf6a6b719 100644 --- a/docs/reference/api/InferenceAnthropicTaskType.md +++ b/docs/reference/api/InferenceAnthropicTaskType.md @@ -1,4 +1,4 @@ -## `InferenceAnthropicTaskType` -::: +# `InferenceAnthropicTaskType` [alias-InferenceAnthropicTaskType] +```typescript type InferenceAnthropicTaskType = 'completion'; -::: +``` diff --git a/docs/reference/api/InferenceAzureAiStudioServiceSettings.md b/docs/reference/api/InferenceAzureAiStudioServiceSettings.md index 6a0eacdc8..818024f45 100644 --- a/docs/reference/api/InferenceAzureAiStudioServiceSettings.md +++ b/docs/reference/api/InferenceAzureAiStudioServiceSettings.md @@ -1,4 +1,4 @@ -## Interface `InferenceAzureAiStudioServiceSettings` +# `InferenceAzureAiStudioServiceSettings` [interface-InferenceAzureAiStudioServiceSettings] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/InferenceAzureAiStudioServiceType.md b/docs/reference/api/InferenceAzureAiStudioServiceType.md index 87b42a4c0..cd4883a39 100644 --- a/docs/reference/api/InferenceAzureAiStudioServiceType.md +++ b/docs/reference/api/InferenceAzureAiStudioServiceType.md @@ -1,4 +1,4 @@ -## `InferenceAzureAiStudioServiceType` -::: +# `InferenceAzureAiStudioServiceType` [alias-InferenceAzureAiStudioServiceType] +```typescript type InferenceAzureAiStudioServiceType = 'azureaistudio'; -::: +``` diff --git a/docs/reference/api/InferenceAzureAiStudioTaskSettings.md b/docs/reference/api/InferenceAzureAiStudioTaskSettings.md index 122c07008..552becfa1 100644 --- a/docs/reference/api/InferenceAzureAiStudioTaskSettings.md +++ b/docs/reference/api/InferenceAzureAiStudioTaskSettings.md @@ -1,4 +1,4 @@ -## Interface `InferenceAzureAiStudioTaskSettings` +# `InferenceAzureAiStudioTaskSettings` [interface-InferenceAzureAiStudioTaskSettings] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/InferenceAzureAiStudioTaskType.md b/docs/reference/api/InferenceAzureAiStudioTaskType.md index 70f861efd..8fab81be4 100644 --- a/docs/reference/api/InferenceAzureAiStudioTaskType.md +++ b/docs/reference/api/InferenceAzureAiStudioTaskType.md @@ -1,4 +1,4 @@ -## `InferenceAzureAiStudioTaskType` -::: +# `InferenceAzureAiStudioTaskType` [alias-InferenceAzureAiStudioTaskType] +```typescript type InferenceAzureAiStudioTaskType = 'completion' | 'text_embedding'; -::: +``` diff --git a/docs/reference/api/InferenceAzureOpenAIServiceSettings.md b/docs/reference/api/InferenceAzureOpenAIServiceSettings.md index f83aab7ae..37425af12 100644 --- a/docs/reference/api/InferenceAzureOpenAIServiceSettings.md +++ b/docs/reference/api/InferenceAzureOpenAIServiceSettings.md @@ -1,4 +1,4 @@ -## Interface `InferenceAzureOpenAIServiceSettings` +# `InferenceAzureOpenAIServiceSettings` [interface-InferenceAzureOpenAIServiceSettings] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/InferenceAzureOpenAIServiceType.md b/docs/reference/api/InferenceAzureOpenAIServiceType.md index fb98514a0..328f97ef7 100644 --- a/docs/reference/api/InferenceAzureOpenAIServiceType.md +++ b/docs/reference/api/InferenceAzureOpenAIServiceType.md @@ -1,4 +1,4 @@ -## `InferenceAzureOpenAIServiceType` -::: +# `InferenceAzureOpenAIServiceType` [alias-InferenceAzureOpenAIServiceType] +```typescript type InferenceAzureOpenAIServiceType = 'azureopenai'; -::: +``` diff --git a/docs/reference/api/InferenceAzureOpenAITaskSettings.md b/docs/reference/api/InferenceAzureOpenAITaskSettings.md index f7ff032a7..db07cb70e 100644 --- a/docs/reference/api/InferenceAzureOpenAITaskSettings.md +++ b/docs/reference/api/InferenceAzureOpenAITaskSettings.md @@ -1,4 +1,4 @@ -## Interface `InferenceAzureOpenAITaskSettings` +# `InferenceAzureOpenAITaskSettings` [interface-InferenceAzureOpenAITaskSettings] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/InferenceAzureOpenAITaskType.md b/docs/reference/api/InferenceAzureOpenAITaskType.md index 2728e70eb..18211d89b 100644 --- a/docs/reference/api/InferenceAzureOpenAITaskType.md +++ b/docs/reference/api/InferenceAzureOpenAITaskType.md @@ -1,4 +1,4 @@ -## `InferenceAzureOpenAITaskType` -::: +# `InferenceAzureOpenAITaskType` [alias-InferenceAzureOpenAITaskType] +```typescript type InferenceAzureOpenAITaskType = 'completion' | 'text_embedding'; -::: +``` diff --git a/docs/reference/api/InferenceChatCompletionUnifiedRequest.md b/docs/reference/api/InferenceChatCompletionUnifiedRequest.md index cca6a8377..ff015169a 100644 --- a/docs/reference/api/InferenceChatCompletionUnifiedRequest.md +++ b/docs/reference/api/InferenceChatCompletionUnifiedRequest.md @@ -1,4 +1,4 @@ -## Interface `InferenceChatCompletionUnifiedRequest` +# `InferenceChatCompletionUnifiedRequest` [interface-InferenceChatCompletionUnifiedRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/InferenceChatCompletionUnifiedResponse.md b/docs/reference/api/InferenceChatCompletionUnifiedResponse.md index e681780a5..316d74de3 100644 --- a/docs/reference/api/InferenceChatCompletionUnifiedResponse.md +++ b/docs/reference/api/InferenceChatCompletionUnifiedResponse.md @@ -1,4 +1,4 @@ -## `InferenceChatCompletionUnifiedResponse` -::: +# `InferenceChatCompletionUnifiedResponse` [alias-InferenceChatCompletionUnifiedResponse] +```typescript type InferenceChatCompletionUnifiedResponse = [StreamResult](./StreamResult.md); -::: +``` diff --git a/docs/reference/api/InferenceCohereEmbeddingType.md b/docs/reference/api/InferenceCohereEmbeddingType.md index 542210af6..b453c5a58 100644 --- a/docs/reference/api/InferenceCohereEmbeddingType.md +++ b/docs/reference/api/InferenceCohereEmbeddingType.md @@ -1,4 +1,4 @@ -## `InferenceCohereEmbeddingType` -::: +# `InferenceCohereEmbeddingType` [alias-InferenceCohereEmbeddingType] +```typescript type InferenceCohereEmbeddingType = 'byte' | 'float' | 'int8'; -::: +``` diff --git a/docs/reference/api/InferenceCohereInputType.md b/docs/reference/api/InferenceCohereInputType.md index af0fecf50..f1c8a614a 100644 --- a/docs/reference/api/InferenceCohereInputType.md +++ b/docs/reference/api/InferenceCohereInputType.md @@ -1,4 +1,4 @@ -## `InferenceCohereInputType` -::: +# `InferenceCohereInputType` [alias-InferenceCohereInputType] +```typescript type InferenceCohereInputType = 'classification' | 'clustering' | 'ingest' | 'search'; -::: +``` diff --git a/docs/reference/api/InferenceCohereServiceSettings.md b/docs/reference/api/InferenceCohereServiceSettings.md index 16616052d..c14250a24 100644 --- a/docs/reference/api/InferenceCohereServiceSettings.md +++ b/docs/reference/api/InferenceCohereServiceSettings.md @@ -1,4 +1,4 @@ -## Interface `InferenceCohereServiceSettings` +# `InferenceCohereServiceSettings` [interface-InferenceCohereServiceSettings] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/InferenceCohereServiceType.md b/docs/reference/api/InferenceCohereServiceType.md index 07f99bb9f..97c0205a0 100644 --- a/docs/reference/api/InferenceCohereServiceType.md +++ b/docs/reference/api/InferenceCohereServiceType.md @@ -1,4 +1,4 @@ -## `InferenceCohereServiceType` -::: +# `InferenceCohereServiceType` [alias-InferenceCohereServiceType] +```typescript type InferenceCohereServiceType = 'cohere'; -::: +``` diff --git a/docs/reference/api/InferenceCohereSimilarityType.md b/docs/reference/api/InferenceCohereSimilarityType.md index 98f877c03..752cd9e38 100644 --- a/docs/reference/api/InferenceCohereSimilarityType.md +++ b/docs/reference/api/InferenceCohereSimilarityType.md @@ -1,4 +1,4 @@ -## `InferenceCohereSimilarityType` -::: +# `InferenceCohereSimilarityType` [alias-InferenceCohereSimilarityType] +```typescript type InferenceCohereSimilarityType = 'cosine' | 'dot_product' | 'l2_norm'; -::: +``` diff --git a/docs/reference/api/InferenceCohereTaskSettings.md b/docs/reference/api/InferenceCohereTaskSettings.md index b06237645..0940d8a76 100644 --- a/docs/reference/api/InferenceCohereTaskSettings.md +++ b/docs/reference/api/InferenceCohereTaskSettings.md @@ -1,4 +1,4 @@ -## Interface `InferenceCohereTaskSettings` +# `InferenceCohereTaskSettings` [interface-InferenceCohereTaskSettings] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/InferenceCohereTaskType.md b/docs/reference/api/InferenceCohereTaskType.md index 7c176077d..ca73f1824 100644 --- a/docs/reference/api/InferenceCohereTaskType.md +++ b/docs/reference/api/InferenceCohereTaskType.md @@ -1,4 +1,4 @@ -## `InferenceCohereTaskType` -::: +# `InferenceCohereTaskType` [alias-InferenceCohereTaskType] +```typescript type InferenceCohereTaskType = 'completion' | 'rerank' | 'text_embedding'; -::: +``` diff --git a/docs/reference/api/InferenceCohereTruncateType.md b/docs/reference/api/InferenceCohereTruncateType.md index e3d22e39a..e283a4114 100644 --- a/docs/reference/api/InferenceCohereTruncateType.md +++ b/docs/reference/api/InferenceCohereTruncateType.md @@ -1,4 +1,4 @@ -## `InferenceCohereTruncateType` -::: +# `InferenceCohereTruncateType` [alias-InferenceCohereTruncateType] +```typescript type InferenceCohereTruncateType = 'END' | 'NONE' | 'START'; -::: +``` diff --git a/docs/reference/api/InferenceCompletionInferenceResult.md b/docs/reference/api/InferenceCompletionInferenceResult.md index 013b3d674..54cd9965e 100644 --- a/docs/reference/api/InferenceCompletionInferenceResult.md +++ b/docs/reference/api/InferenceCompletionInferenceResult.md @@ -1,4 +1,4 @@ -## Interface `InferenceCompletionInferenceResult` +# `InferenceCompletionInferenceResult` [interface-InferenceCompletionInferenceResult] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/InferenceCompletionRequest.md b/docs/reference/api/InferenceCompletionRequest.md index e7e2c0693..d05302041 100644 --- a/docs/reference/api/InferenceCompletionRequest.md +++ b/docs/reference/api/InferenceCompletionRequest.md @@ -1,4 +1,4 @@ -## Interface `InferenceCompletionRequest` +# `InferenceCompletionRequest` [interface-InferenceCompletionRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/InferenceCompletionResponse.md b/docs/reference/api/InferenceCompletionResponse.md index bce396617..bb2ba328f 100644 --- a/docs/reference/api/InferenceCompletionResponse.md +++ b/docs/reference/api/InferenceCompletionResponse.md @@ -1,4 +1,4 @@ -## `InferenceCompletionResponse` -::: +# `InferenceCompletionResponse` [alias-InferenceCompletionResponse] +```typescript type InferenceCompletionResponse = [InferenceCompletionInferenceResult](./InferenceCompletionInferenceResult.md); -::: +``` diff --git a/docs/reference/api/InferenceCompletionResult.md b/docs/reference/api/InferenceCompletionResult.md index decb733c9..168857c18 100644 --- a/docs/reference/api/InferenceCompletionResult.md +++ b/docs/reference/api/InferenceCompletionResult.md @@ -1,4 +1,4 @@ -## Interface `InferenceCompletionResult` +# `InferenceCompletionResult` [interface-InferenceCompletionResult] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/InferenceCompletionTool.md b/docs/reference/api/InferenceCompletionTool.md index 11ae92873..66e18a6a8 100644 --- a/docs/reference/api/InferenceCompletionTool.md +++ b/docs/reference/api/InferenceCompletionTool.md @@ -1,4 +1,4 @@ -## Interface `InferenceCompletionTool` +# `InferenceCompletionTool` [interface-InferenceCompletionTool] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/InferenceCompletionToolChoice.md b/docs/reference/api/InferenceCompletionToolChoice.md index ac036bf94..708e8c984 100644 --- a/docs/reference/api/InferenceCompletionToolChoice.md +++ b/docs/reference/api/InferenceCompletionToolChoice.md @@ -1,4 +1,4 @@ -## Interface `InferenceCompletionToolChoice` +# `InferenceCompletionToolChoice` [interface-InferenceCompletionToolChoice] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/InferenceCompletionToolChoiceFunction.md b/docs/reference/api/InferenceCompletionToolChoiceFunction.md index 1ba04445d..825da3789 100644 --- a/docs/reference/api/InferenceCompletionToolChoiceFunction.md +++ b/docs/reference/api/InferenceCompletionToolChoiceFunction.md @@ -1,4 +1,4 @@ -## Interface `InferenceCompletionToolChoiceFunction` +# `InferenceCompletionToolChoiceFunction` [interface-InferenceCompletionToolChoiceFunction] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/InferenceCompletionToolFunction.md b/docs/reference/api/InferenceCompletionToolFunction.md index 9a1a013bc..e9982745f 100644 --- a/docs/reference/api/InferenceCompletionToolFunction.md +++ b/docs/reference/api/InferenceCompletionToolFunction.md @@ -1,4 +1,4 @@ -## Interface `InferenceCompletionToolFunction` +# `InferenceCompletionToolFunction` [interface-InferenceCompletionToolFunction] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/InferenceCompletionToolType.md b/docs/reference/api/InferenceCompletionToolType.md index e80c3ae48..466a7e976 100644 --- a/docs/reference/api/InferenceCompletionToolType.md +++ b/docs/reference/api/InferenceCompletionToolType.md @@ -1,4 +1,4 @@ -## `InferenceCompletionToolType` -::: +# `InferenceCompletionToolType` [alias-InferenceCompletionToolType] +```typescript type InferenceCompletionToolType = string | [InferenceCompletionToolChoice](./InferenceCompletionToolChoice.md); -::: +``` diff --git a/docs/reference/api/InferenceContentObject.md b/docs/reference/api/InferenceContentObject.md index 03f7135b5..962378208 100644 --- a/docs/reference/api/InferenceContentObject.md +++ b/docs/reference/api/InferenceContentObject.md @@ -1,4 +1,4 @@ -## Interface `InferenceContentObject` +# `InferenceContentObject` [interface-InferenceContentObject] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/InferenceDeleteInferenceEndpointResult.md b/docs/reference/api/InferenceDeleteInferenceEndpointResult.md index 706a8a9de..fd686975c 100644 --- a/docs/reference/api/InferenceDeleteInferenceEndpointResult.md +++ b/docs/reference/api/InferenceDeleteInferenceEndpointResult.md @@ -1,4 +1,4 @@ -## Interface `InferenceDeleteInferenceEndpointResult` +# `InferenceDeleteInferenceEndpointResult` [interface-InferenceDeleteInferenceEndpointResult] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/InferenceDeleteRequest.md b/docs/reference/api/InferenceDeleteRequest.md index 2896a1e97..2ccf25142 100644 --- a/docs/reference/api/InferenceDeleteRequest.md +++ b/docs/reference/api/InferenceDeleteRequest.md @@ -1,4 +1,4 @@ -## Interface `InferenceDeleteRequest` +# `InferenceDeleteRequest` [interface-InferenceDeleteRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/InferenceDeleteResponse.md b/docs/reference/api/InferenceDeleteResponse.md index d6ce69dd4..9f55a0b58 100644 --- a/docs/reference/api/InferenceDeleteResponse.md +++ b/docs/reference/api/InferenceDeleteResponse.md @@ -1,4 +1,4 @@ -## `InferenceDeleteResponse` -::: +# `InferenceDeleteResponse` [alias-InferenceDeleteResponse] +```typescript type InferenceDeleteResponse = [InferenceDeleteInferenceEndpointResult](./InferenceDeleteInferenceEndpointResult.md); -::: +``` diff --git a/docs/reference/api/InferenceDenseByteVector.md b/docs/reference/api/InferenceDenseByteVector.md index 6c484daa6..2700b105a 100644 --- a/docs/reference/api/InferenceDenseByteVector.md +++ b/docs/reference/api/InferenceDenseByteVector.md @@ -1,4 +1,4 @@ -## `InferenceDenseByteVector` -::: +# `InferenceDenseByteVector` [alias-InferenceDenseByteVector] +```typescript type InferenceDenseByteVector = [byte](./byte.md)[]; -::: +``` diff --git a/docs/reference/api/InferenceDenseVector.md b/docs/reference/api/InferenceDenseVector.md index ab0399d29..cf9df77bb 100644 --- a/docs/reference/api/InferenceDenseVector.md +++ b/docs/reference/api/InferenceDenseVector.md @@ -1,4 +1,4 @@ -## `InferenceDenseVector` -::: +# `InferenceDenseVector` [alias-InferenceDenseVector] +```typescript type InferenceDenseVector = [float](./float.md)[]; -::: +``` diff --git a/docs/reference/api/InferenceElasticsearchServiceSettings.md b/docs/reference/api/InferenceElasticsearchServiceSettings.md index 272de8c37..cab26e65b 100644 --- a/docs/reference/api/InferenceElasticsearchServiceSettings.md +++ b/docs/reference/api/InferenceElasticsearchServiceSettings.md @@ -1,4 +1,4 @@ -## Interface `InferenceElasticsearchServiceSettings` +# `InferenceElasticsearchServiceSettings` [interface-InferenceElasticsearchServiceSettings] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/InferenceElasticsearchServiceType.md b/docs/reference/api/InferenceElasticsearchServiceType.md index 700512cab..a2ce851d6 100644 --- a/docs/reference/api/InferenceElasticsearchServiceType.md +++ b/docs/reference/api/InferenceElasticsearchServiceType.md @@ -1,4 +1,4 @@ -## `InferenceElasticsearchServiceType` -::: +# `InferenceElasticsearchServiceType` [alias-InferenceElasticsearchServiceType] +```typescript type InferenceElasticsearchServiceType = 'elasticsearch'; -::: +``` diff --git a/docs/reference/api/InferenceElasticsearchTaskSettings.md b/docs/reference/api/InferenceElasticsearchTaskSettings.md index 4d8978050..27d001ff7 100644 --- a/docs/reference/api/InferenceElasticsearchTaskSettings.md +++ b/docs/reference/api/InferenceElasticsearchTaskSettings.md @@ -1,4 +1,4 @@ -## Interface `InferenceElasticsearchTaskSettings` +# `InferenceElasticsearchTaskSettings` [interface-InferenceElasticsearchTaskSettings] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/InferenceElasticsearchTaskType.md b/docs/reference/api/InferenceElasticsearchTaskType.md index 9b1d58e71..32ce4a7d2 100644 --- a/docs/reference/api/InferenceElasticsearchTaskType.md +++ b/docs/reference/api/InferenceElasticsearchTaskType.md @@ -1,4 +1,4 @@ -## `InferenceElasticsearchTaskType` -::: +# `InferenceElasticsearchTaskType` [alias-InferenceElasticsearchTaskType] +```typescript type InferenceElasticsearchTaskType = 'rerank' | 'sparse_embedding' | 'text_embedding'; -::: +``` diff --git a/docs/reference/api/InferenceElserServiceSettings.md b/docs/reference/api/InferenceElserServiceSettings.md index aff203ad5..71b0fb456 100644 --- a/docs/reference/api/InferenceElserServiceSettings.md +++ b/docs/reference/api/InferenceElserServiceSettings.md @@ -1,4 +1,4 @@ -## Interface `InferenceElserServiceSettings` +# `InferenceElserServiceSettings` [interface-InferenceElserServiceSettings] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/InferenceElserServiceType.md b/docs/reference/api/InferenceElserServiceType.md index 20cb23d87..dc44a75fd 100644 --- a/docs/reference/api/InferenceElserServiceType.md +++ b/docs/reference/api/InferenceElserServiceType.md @@ -1,4 +1,4 @@ -## `InferenceElserServiceType` -::: +# `InferenceElserServiceType` [alias-InferenceElserServiceType] +```typescript type InferenceElserServiceType = 'elser'; -::: +``` diff --git a/docs/reference/api/InferenceElserTaskType.md b/docs/reference/api/InferenceElserTaskType.md index 91bac1f59..1b70e0595 100644 --- a/docs/reference/api/InferenceElserTaskType.md +++ b/docs/reference/api/InferenceElserTaskType.md @@ -1,4 +1,4 @@ -## `InferenceElserTaskType` -::: +# `InferenceElserTaskType` [alias-InferenceElserTaskType] +```typescript type InferenceElserTaskType = 'sparse_embedding'; -::: +``` diff --git a/docs/reference/api/InferenceGetRequest.md b/docs/reference/api/InferenceGetRequest.md index 13dd87683..1e8b79523 100644 --- a/docs/reference/api/InferenceGetRequest.md +++ b/docs/reference/api/InferenceGetRequest.md @@ -1,4 +1,4 @@ -## Interface `InferenceGetRequest` +# `InferenceGetRequest` [interface-InferenceGetRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/InferenceGetResponse.md b/docs/reference/api/InferenceGetResponse.md index 69305b7ed..928dede31 100644 --- a/docs/reference/api/InferenceGetResponse.md +++ b/docs/reference/api/InferenceGetResponse.md @@ -1,4 +1,4 @@ -## Interface `InferenceGetResponse` +# `InferenceGetResponse` [interface-InferenceGetResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/InferenceGoogleAiServiceType.md b/docs/reference/api/InferenceGoogleAiServiceType.md index 44967278d..a13857862 100644 --- a/docs/reference/api/InferenceGoogleAiServiceType.md +++ b/docs/reference/api/InferenceGoogleAiServiceType.md @@ -1,4 +1,4 @@ -## `InferenceGoogleAiServiceType` -::: +# `InferenceGoogleAiServiceType` [alias-InferenceGoogleAiServiceType] +```typescript type InferenceGoogleAiServiceType = 'googleaistudio'; -::: +``` diff --git a/docs/reference/api/InferenceGoogleAiStudioServiceSettings.md b/docs/reference/api/InferenceGoogleAiStudioServiceSettings.md index 9669af95e..833adba1b 100644 --- a/docs/reference/api/InferenceGoogleAiStudioServiceSettings.md +++ b/docs/reference/api/InferenceGoogleAiStudioServiceSettings.md @@ -1,4 +1,4 @@ -## Interface `InferenceGoogleAiStudioServiceSettings` +# `InferenceGoogleAiStudioServiceSettings` [interface-InferenceGoogleAiStudioServiceSettings] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/InferenceGoogleAiStudioTaskType.md b/docs/reference/api/InferenceGoogleAiStudioTaskType.md index 20242502c..af0412db0 100644 --- a/docs/reference/api/InferenceGoogleAiStudioTaskType.md +++ b/docs/reference/api/InferenceGoogleAiStudioTaskType.md @@ -1,4 +1,4 @@ -## `InferenceGoogleAiStudioTaskType` -::: +# `InferenceGoogleAiStudioTaskType` [alias-InferenceGoogleAiStudioTaskType] +```typescript type InferenceGoogleAiStudioTaskType = 'completion' | 'text_embedding'; -::: +``` diff --git a/docs/reference/api/InferenceGoogleVertexAIServiceSettings.md b/docs/reference/api/InferenceGoogleVertexAIServiceSettings.md index e2caaf9c0..ef3bcc918 100644 --- a/docs/reference/api/InferenceGoogleVertexAIServiceSettings.md +++ b/docs/reference/api/InferenceGoogleVertexAIServiceSettings.md @@ -1,4 +1,4 @@ -## Interface `InferenceGoogleVertexAIServiceSettings` +# `InferenceGoogleVertexAIServiceSettings` [interface-InferenceGoogleVertexAIServiceSettings] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/InferenceGoogleVertexAIServiceType.md b/docs/reference/api/InferenceGoogleVertexAIServiceType.md index d77710a5c..837b1a764 100644 --- a/docs/reference/api/InferenceGoogleVertexAIServiceType.md +++ b/docs/reference/api/InferenceGoogleVertexAIServiceType.md @@ -1,4 +1,4 @@ -## `InferenceGoogleVertexAIServiceType` -::: +# `InferenceGoogleVertexAIServiceType` [alias-InferenceGoogleVertexAIServiceType] +```typescript type InferenceGoogleVertexAIServiceType = 'googlevertexai'; -::: +``` diff --git a/docs/reference/api/InferenceGoogleVertexAITaskSettings.md b/docs/reference/api/InferenceGoogleVertexAITaskSettings.md index 7a6ebed40..a7e781144 100644 --- a/docs/reference/api/InferenceGoogleVertexAITaskSettings.md +++ b/docs/reference/api/InferenceGoogleVertexAITaskSettings.md @@ -1,4 +1,4 @@ -## Interface `InferenceGoogleVertexAITaskSettings` +# `InferenceGoogleVertexAITaskSettings` [interface-InferenceGoogleVertexAITaskSettings] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/InferenceGoogleVertexAITaskType.md b/docs/reference/api/InferenceGoogleVertexAITaskType.md index 9a2f75b74..e6366adeb 100644 --- a/docs/reference/api/InferenceGoogleVertexAITaskType.md +++ b/docs/reference/api/InferenceGoogleVertexAITaskType.md @@ -1,4 +1,4 @@ -## `InferenceGoogleVertexAITaskType` -::: +# `InferenceGoogleVertexAITaskType` [alias-InferenceGoogleVertexAITaskType] +```typescript type InferenceGoogleVertexAITaskType = 'rerank' | 'text_embedding'; -::: +``` diff --git a/docs/reference/api/InferenceHuggingFaceServiceSettings.md b/docs/reference/api/InferenceHuggingFaceServiceSettings.md index 838c6a2b6..4f1816851 100644 --- a/docs/reference/api/InferenceHuggingFaceServiceSettings.md +++ b/docs/reference/api/InferenceHuggingFaceServiceSettings.md @@ -1,4 +1,4 @@ -## Interface `InferenceHuggingFaceServiceSettings` +# `InferenceHuggingFaceServiceSettings` [interface-InferenceHuggingFaceServiceSettings] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/InferenceHuggingFaceServiceType.md b/docs/reference/api/InferenceHuggingFaceServiceType.md index 3da5a3fab..9e4fcdb17 100644 --- a/docs/reference/api/InferenceHuggingFaceServiceType.md +++ b/docs/reference/api/InferenceHuggingFaceServiceType.md @@ -1,4 +1,4 @@ -## `InferenceHuggingFaceServiceType` -::: +# `InferenceHuggingFaceServiceType` [alias-InferenceHuggingFaceServiceType] +```typescript type InferenceHuggingFaceServiceType = 'hugging_face'; -::: +``` diff --git a/docs/reference/api/InferenceHuggingFaceTaskType.md b/docs/reference/api/InferenceHuggingFaceTaskType.md index 06d3add0f..c6ce48217 100644 --- a/docs/reference/api/InferenceHuggingFaceTaskType.md +++ b/docs/reference/api/InferenceHuggingFaceTaskType.md @@ -1,4 +1,4 @@ -## `InferenceHuggingFaceTaskType` -::: +# `InferenceHuggingFaceTaskType` [alias-InferenceHuggingFaceTaskType] +```typescript type InferenceHuggingFaceTaskType = 'text_embedding'; -::: +``` diff --git a/docs/reference/api/InferenceInferenceChunkingSettings.md b/docs/reference/api/InferenceInferenceChunkingSettings.md index 55223f5ce..997c7016d 100644 --- a/docs/reference/api/InferenceInferenceChunkingSettings.md +++ b/docs/reference/api/InferenceInferenceChunkingSettings.md @@ -1,4 +1,4 @@ -## Interface `InferenceInferenceChunkingSettings` +# `InferenceInferenceChunkingSettings` [interface-InferenceInferenceChunkingSettings] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/InferenceInferenceEndpoint.md b/docs/reference/api/InferenceInferenceEndpoint.md index 3e3cd6ebe..1d06951a8 100644 --- a/docs/reference/api/InferenceInferenceEndpoint.md +++ b/docs/reference/api/InferenceInferenceEndpoint.md @@ -1,4 +1,4 @@ -## Interface `InferenceInferenceEndpoint` +# `InferenceInferenceEndpoint` [interface-InferenceInferenceEndpoint] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/InferenceInferenceEndpointInfo.md b/docs/reference/api/InferenceInferenceEndpointInfo.md index f0bb2f41a..6f51dae95 100644 --- a/docs/reference/api/InferenceInferenceEndpointInfo.md +++ b/docs/reference/api/InferenceInferenceEndpointInfo.md @@ -1,4 +1,4 @@ -## Interface `InferenceInferenceEndpointInfo` +# `InferenceInferenceEndpointInfo` [interface-InferenceInferenceEndpointInfo] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/InferenceInferenceRequest.md b/docs/reference/api/InferenceInferenceRequest.md index 144e10b31..0ba242f74 100644 --- a/docs/reference/api/InferenceInferenceRequest.md +++ b/docs/reference/api/InferenceInferenceRequest.md @@ -1,4 +1,4 @@ -## Interface `InferenceInferenceRequest` +# `InferenceInferenceRequest` [interface-InferenceInferenceRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/InferenceInferenceResponse.md b/docs/reference/api/InferenceInferenceResponse.md index 6c4fcc004..985c79b7d 100644 --- a/docs/reference/api/InferenceInferenceResponse.md +++ b/docs/reference/api/InferenceInferenceResponse.md @@ -1,4 +1,4 @@ -## `InferenceInferenceResponse` -::: +# `InferenceInferenceResponse` [alias-InferenceInferenceResponse] +```typescript type InferenceInferenceResponse = [InferenceInferenceResult](./InferenceInferenceResult.md); -::: +``` diff --git a/docs/reference/api/InferenceInferenceResult.md b/docs/reference/api/InferenceInferenceResult.md index 2bfed3140..997ae2856 100644 --- a/docs/reference/api/InferenceInferenceResult.md +++ b/docs/reference/api/InferenceInferenceResult.md @@ -1,4 +1,4 @@ -## Interface `InferenceInferenceResult` +# `InferenceInferenceResult` [interface-InferenceInferenceResult] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/InferenceJinaAIServiceSettings.md b/docs/reference/api/InferenceJinaAIServiceSettings.md index 948d7204c..6583ed4d8 100644 --- a/docs/reference/api/InferenceJinaAIServiceSettings.md +++ b/docs/reference/api/InferenceJinaAIServiceSettings.md @@ -1,4 +1,4 @@ -## Interface `InferenceJinaAIServiceSettings` +# `InferenceJinaAIServiceSettings` [interface-InferenceJinaAIServiceSettings] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/InferenceJinaAIServiceType.md b/docs/reference/api/InferenceJinaAIServiceType.md index 3ace6e193..1870c1f90 100644 --- a/docs/reference/api/InferenceJinaAIServiceType.md +++ b/docs/reference/api/InferenceJinaAIServiceType.md @@ -1,4 +1,4 @@ -## `InferenceJinaAIServiceType` -::: +# `InferenceJinaAIServiceType` [alias-InferenceJinaAIServiceType] +```typescript type InferenceJinaAIServiceType = 'jinaai'; -::: +``` diff --git a/docs/reference/api/InferenceJinaAISimilarityType.md b/docs/reference/api/InferenceJinaAISimilarityType.md index 820749c9f..7ab80857a 100644 --- a/docs/reference/api/InferenceJinaAISimilarityType.md +++ b/docs/reference/api/InferenceJinaAISimilarityType.md @@ -1,4 +1,4 @@ -## `InferenceJinaAISimilarityType` -::: +# `InferenceJinaAISimilarityType` [alias-InferenceJinaAISimilarityType] +```typescript type InferenceJinaAISimilarityType = 'cosine' | 'dot_product' | 'l2_norm'; -::: +``` diff --git a/docs/reference/api/InferenceJinaAITaskSettings.md b/docs/reference/api/InferenceJinaAITaskSettings.md index 408466ba3..966ce7525 100644 --- a/docs/reference/api/InferenceJinaAITaskSettings.md +++ b/docs/reference/api/InferenceJinaAITaskSettings.md @@ -1,4 +1,4 @@ -## Interface `InferenceJinaAITaskSettings` +# `InferenceJinaAITaskSettings` [interface-InferenceJinaAITaskSettings] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/InferenceJinaAITaskType.md b/docs/reference/api/InferenceJinaAITaskType.md index e15be196f..503c47ae1 100644 --- a/docs/reference/api/InferenceJinaAITaskType.md +++ b/docs/reference/api/InferenceJinaAITaskType.md @@ -1,4 +1,4 @@ -## `InferenceJinaAITaskType` -::: +# `InferenceJinaAITaskType` [alias-InferenceJinaAITaskType] +```typescript type InferenceJinaAITaskType = 'rerank' | 'text_embedding'; -::: +``` diff --git a/docs/reference/api/InferenceJinaAITextEmbeddingTask.md b/docs/reference/api/InferenceJinaAITextEmbeddingTask.md index bf2e5b108..21e050564 100644 --- a/docs/reference/api/InferenceJinaAITextEmbeddingTask.md +++ b/docs/reference/api/InferenceJinaAITextEmbeddingTask.md @@ -1,4 +1,4 @@ -## `InferenceJinaAITextEmbeddingTask` -::: +# `InferenceJinaAITextEmbeddingTask` [alias-InferenceJinaAITextEmbeddingTask] +```typescript type InferenceJinaAITextEmbeddingTask = 'classification' | 'clustering' | 'ingest' | 'search'; -::: +``` diff --git a/docs/reference/api/InferenceMessage.md b/docs/reference/api/InferenceMessage.md index 7b802d522..25d96b155 100644 --- a/docs/reference/api/InferenceMessage.md +++ b/docs/reference/api/InferenceMessage.md @@ -1,4 +1,4 @@ -## Interface `InferenceMessage` +# `InferenceMessage` [interface-InferenceMessage] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/InferenceMessageContent.md b/docs/reference/api/InferenceMessageContent.md index 782a1eaa5..2f13657ee 100644 --- a/docs/reference/api/InferenceMessageContent.md +++ b/docs/reference/api/InferenceMessageContent.md @@ -1,4 +1,4 @@ -## `InferenceMessageContent` -::: +# `InferenceMessageContent` [alias-InferenceMessageContent] +```typescript type InferenceMessageContent = string | [InferenceContentObject](./InferenceContentObject.md)[]; -::: +``` diff --git a/docs/reference/api/InferenceMistralServiceSettings.md b/docs/reference/api/InferenceMistralServiceSettings.md index d5066cf1c..f5b461131 100644 --- a/docs/reference/api/InferenceMistralServiceSettings.md +++ b/docs/reference/api/InferenceMistralServiceSettings.md @@ -1,4 +1,4 @@ -## Interface `InferenceMistralServiceSettings` +# `InferenceMistralServiceSettings` [interface-InferenceMistralServiceSettings] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/InferenceMistralServiceType.md b/docs/reference/api/InferenceMistralServiceType.md index 843246129..62f0f4377 100644 --- a/docs/reference/api/InferenceMistralServiceType.md +++ b/docs/reference/api/InferenceMistralServiceType.md @@ -1,4 +1,4 @@ -## `InferenceMistralServiceType` -::: +# `InferenceMistralServiceType` [alias-InferenceMistralServiceType] +```typescript type InferenceMistralServiceType = 'mistral'; -::: +``` diff --git a/docs/reference/api/InferenceMistralTaskType.md b/docs/reference/api/InferenceMistralTaskType.md index af01491e5..49632c243 100644 --- a/docs/reference/api/InferenceMistralTaskType.md +++ b/docs/reference/api/InferenceMistralTaskType.md @@ -1,4 +1,4 @@ -## `InferenceMistralTaskType` -::: +# `InferenceMistralTaskType` [alias-InferenceMistralTaskType] +```typescript type InferenceMistralTaskType = 'text_embedding'; -::: +``` diff --git a/docs/reference/api/InferenceOpenAIServiceSettings.md b/docs/reference/api/InferenceOpenAIServiceSettings.md index bc154e3ba..3f6242ba7 100644 --- a/docs/reference/api/InferenceOpenAIServiceSettings.md +++ b/docs/reference/api/InferenceOpenAIServiceSettings.md @@ -1,4 +1,4 @@ -## Interface `InferenceOpenAIServiceSettings` +# `InferenceOpenAIServiceSettings` [interface-InferenceOpenAIServiceSettings] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/InferenceOpenAIServiceType.md b/docs/reference/api/InferenceOpenAIServiceType.md index 3e31b6526..9e931c59b 100644 --- a/docs/reference/api/InferenceOpenAIServiceType.md +++ b/docs/reference/api/InferenceOpenAIServiceType.md @@ -1,4 +1,4 @@ -## `InferenceOpenAIServiceType` -::: +# `InferenceOpenAIServiceType` [alias-InferenceOpenAIServiceType] +```typescript type InferenceOpenAIServiceType = 'openai'; -::: +``` diff --git a/docs/reference/api/InferenceOpenAITaskSettings.md b/docs/reference/api/InferenceOpenAITaskSettings.md index 8969b8edb..c42ba9669 100644 --- a/docs/reference/api/InferenceOpenAITaskSettings.md +++ b/docs/reference/api/InferenceOpenAITaskSettings.md @@ -1,4 +1,4 @@ -## Interface `InferenceOpenAITaskSettings` +# `InferenceOpenAITaskSettings` [interface-InferenceOpenAITaskSettings] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/InferenceOpenAITaskType.md b/docs/reference/api/InferenceOpenAITaskType.md index 6b8c5897d..a5aed25dd 100644 --- a/docs/reference/api/InferenceOpenAITaskType.md +++ b/docs/reference/api/InferenceOpenAITaskType.md @@ -1,4 +1,4 @@ -## `InferenceOpenAITaskType` -::: +# `InferenceOpenAITaskType` [alias-InferenceOpenAITaskType] +```typescript type InferenceOpenAITaskType = 'chat_completion' | 'completion' | 'text_embedding'; -::: +``` diff --git a/docs/reference/api/InferencePutAlibabacloudRequest.md b/docs/reference/api/InferencePutAlibabacloudRequest.md index 190110c5c..cea06b737 100644 --- a/docs/reference/api/InferencePutAlibabacloudRequest.md +++ b/docs/reference/api/InferencePutAlibabacloudRequest.md @@ -1,4 +1,4 @@ -## Interface `InferencePutAlibabacloudRequest` +# `InferencePutAlibabacloudRequest` [interface-InferencePutAlibabacloudRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/InferencePutAlibabacloudResponse.md b/docs/reference/api/InferencePutAlibabacloudResponse.md index c52d57f1f..a4e0b868a 100644 --- a/docs/reference/api/InferencePutAlibabacloudResponse.md +++ b/docs/reference/api/InferencePutAlibabacloudResponse.md @@ -1,4 +1,4 @@ -## `InferencePutAlibabacloudResponse` -::: +# `InferencePutAlibabacloudResponse` [alias-InferencePutAlibabacloudResponse] +```typescript type InferencePutAlibabacloudResponse = [InferenceInferenceEndpointInfo](./InferenceInferenceEndpointInfo.md); -::: +``` diff --git a/docs/reference/api/InferencePutAmazonbedrockRequest.md b/docs/reference/api/InferencePutAmazonbedrockRequest.md index ea5b1e0a1..09b0a5e47 100644 --- a/docs/reference/api/InferencePutAmazonbedrockRequest.md +++ b/docs/reference/api/InferencePutAmazonbedrockRequest.md @@ -1,4 +1,4 @@ -## Interface `InferencePutAmazonbedrockRequest` +# `InferencePutAmazonbedrockRequest` [interface-InferencePutAmazonbedrockRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/InferencePutAmazonbedrockResponse.md b/docs/reference/api/InferencePutAmazonbedrockResponse.md index c2d031460..6f4a55da3 100644 --- a/docs/reference/api/InferencePutAmazonbedrockResponse.md +++ b/docs/reference/api/InferencePutAmazonbedrockResponse.md @@ -1,4 +1,4 @@ -## `InferencePutAmazonbedrockResponse` -::: +# `InferencePutAmazonbedrockResponse` [alias-InferencePutAmazonbedrockResponse] +```typescript type InferencePutAmazonbedrockResponse = [InferenceInferenceEndpointInfo](./InferenceInferenceEndpointInfo.md); -::: +``` diff --git a/docs/reference/api/InferencePutAnthropicRequest.md b/docs/reference/api/InferencePutAnthropicRequest.md index 95cabb363..04879ab64 100644 --- a/docs/reference/api/InferencePutAnthropicRequest.md +++ b/docs/reference/api/InferencePutAnthropicRequest.md @@ -1,4 +1,4 @@ -## Interface `InferencePutAnthropicRequest` +# `InferencePutAnthropicRequest` [interface-InferencePutAnthropicRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/InferencePutAnthropicResponse.md b/docs/reference/api/InferencePutAnthropicResponse.md index 0e12930c1..7c2f7fe87 100644 --- a/docs/reference/api/InferencePutAnthropicResponse.md +++ b/docs/reference/api/InferencePutAnthropicResponse.md @@ -1,4 +1,4 @@ -## `InferencePutAnthropicResponse` -::: +# `InferencePutAnthropicResponse` [alias-InferencePutAnthropicResponse] +```typescript type InferencePutAnthropicResponse = [InferenceInferenceEndpointInfo](./InferenceInferenceEndpointInfo.md); -::: +``` diff --git a/docs/reference/api/InferencePutAzureaistudioRequest.md b/docs/reference/api/InferencePutAzureaistudioRequest.md index ea15ccdf6..3fa6c3153 100644 --- a/docs/reference/api/InferencePutAzureaistudioRequest.md +++ b/docs/reference/api/InferencePutAzureaistudioRequest.md @@ -1,4 +1,4 @@ -## Interface `InferencePutAzureaistudioRequest` +# `InferencePutAzureaistudioRequest` [interface-InferencePutAzureaistudioRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/InferencePutAzureaistudioResponse.md b/docs/reference/api/InferencePutAzureaistudioResponse.md index 443b9e3e3..dc6b28361 100644 --- a/docs/reference/api/InferencePutAzureaistudioResponse.md +++ b/docs/reference/api/InferencePutAzureaistudioResponse.md @@ -1,4 +1,4 @@ -## `InferencePutAzureaistudioResponse` -::: +# `InferencePutAzureaistudioResponse` [alias-InferencePutAzureaistudioResponse] +```typescript type InferencePutAzureaistudioResponse = [InferenceInferenceEndpointInfo](./InferenceInferenceEndpointInfo.md); -::: +``` diff --git a/docs/reference/api/InferencePutAzureopenaiRequest.md b/docs/reference/api/InferencePutAzureopenaiRequest.md index cf8879a4e..52d440045 100644 --- a/docs/reference/api/InferencePutAzureopenaiRequest.md +++ b/docs/reference/api/InferencePutAzureopenaiRequest.md @@ -1,4 +1,4 @@ -## Interface `InferencePutAzureopenaiRequest` +# `InferencePutAzureopenaiRequest` [interface-InferencePutAzureopenaiRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/InferencePutAzureopenaiResponse.md b/docs/reference/api/InferencePutAzureopenaiResponse.md index 53a61a52f..029c6a9c7 100644 --- a/docs/reference/api/InferencePutAzureopenaiResponse.md +++ b/docs/reference/api/InferencePutAzureopenaiResponse.md @@ -1,4 +1,4 @@ -## `InferencePutAzureopenaiResponse` -::: +# `InferencePutAzureopenaiResponse` [alias-InferencePutAzureopenaiResponse] +```typescript type InferencePutAzureopenaiResponse = [InferenceInferenceEndpointInfo](./InferenceInferenceEndpointInfo.md); -::: +``` diff --git a/docs/reference/api/InferencePutCohereRequest.md b/docs/reference/api/InferencePutCohereRequest.md index 16bd48072..d705a9c62 100644 --- a/docs/reference/api/InferencePutCohereRequest.md +++ b/docs/reference/api/InferencePutCohereRequest.md @@ -1,4 +1,4 @@ -## Interface `InferencePutCohereRequest` +# `InferencePutCohereRequest` [interface-InferencePutCohereRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/InferencePutCohereResponse.md b/docs/reference/api/InferencePutCohereResponse.md index f7d670bc4..329e0688d 100644 --- a/docs/reference/api/InferencePutCohereResponse.md +++ b/docs/reference/api/InferencePutCohereResponse.md @@ -1,4 +1,4 @@ -## `InferencePutCohereResponse` -::: +# `InferencePutCohereResponse` [alias-InferencePutCohereResponse] +```typescript type InferencePutCohereResponse = [InferenceInferenceEndpointInfo](./InferenceInferenceEndpointInfo.md); -::: +``` diff --git a/docs/reference/api/InferencePutElasticsearchRequest.md b/docs/reference/api/InferencePutElasticsearchRequest.md index f5987a4d8..63faec278 100644 --- a/docs/reference/api/InferencePutElasticsearchRequest.md +++ b/docs/reference/api/InferencePutElasticsearchRequest.md @@ -1,4 +1,4 @@ -## Interface `InferencePutElasticsearchRequest` +# `InferencePutElasticsearchRequest` [interface-InferencePutElasticsearchRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/InferencePutElasticsearchResponse.md b/docs/reference/api/InferencePutElasticsearchResponse.md index 689ab1d25..7728e7c85 100644 --- a/docs/reference/api/InferencePutElasticsearchResponse.md +++ b/docs/reference/api/InferencePutElasticsearchResponse.md @@ -1,4 +1,4 @@ -## `InferencePutElasticsearchResponse` -::: +# `InferencePutElasticsearchResponse` [alias-InferencePutElasticsearchResponse] +```typescript type InferencePutElasticsearchResponse = [InferenceInferenceEndpointInfo](./InferenceInferenceEndpointInfo.md); -::: +``` diff --git a/docs/reference/api/InferencePutElserRequest.md b/docs/reference/api/InferencePutElserRequest.md index 9eeff33ae..c74e14ad0 100644 --- a/docs/reference/api/InferencePutElserRequest.md +++ b/docs/reference/api/InferencePutElserRequest.md @@ -1,4 +1,4 @@ -## Interface `InferencePutElserRequest` +# `InferencePutElserRequest` [interface-InferencePutElserRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/InferencePutElserResponse.md b/docs/reference/api/InferencePutElserResponse.md index 9bc6f7c10..59d784203 100644 --- a/docs/reference/api/InferencePutElserResponse.md +++ b/docs/reference/api/InferencePutElserResponse.md @@ -1,4 +1,4 @@ -## `InferencePutElserResponse` -::: +# `InferencePutElserResponse` [alias-InferencePutElserResponse] +```typescript type InferencePutElserResponse = [InferenceInferenceEndpointInfo](./InferenceInferenceEndpointInfo.md); -::: +``` diff --git a/docs/reference/api/InferencePutGoogleaistudioRequest.md b/docs/reference/api/InferencePutGoogleaistudioRequest.md index db7b8ca03..6d1d9d497 100644 --- a/docs/reference/api/InferencePutGoogleaistudioRequest.md +++ b/docs/reference/api/InferencePutGoogleaistudioRequest.md @@ -1,4 +1,4 @@ -## Interface `InferencePutGoogleaistudioRequest` +# `InferencePutGoogleaistudioRequest` [interface-InferencePutGoogleaistudioRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/InferencePutGoogleaistudioResponse.md b/docs/reference/api/InferencePutGoogleaistudioResponse.md index 1e893cf1e..52e933e03 100644 --- a/docs/reference/api/InferencePutGoogleaistudioResponse.md +++ b/docs/reference/api/InferencePutGoogleaistudioResponse.md @@ -1,4 +1,4 @@ -## `InferencePutGoogleaistudioResponse` -::: +# `InferencePutGoogleaistudioResponse` [alias-InferencePutGoogleaistudioResponse] +```typescript type InferencePutGoogleaistudioResponse = [InferenceInferenceEndpointInfo](./InferenceInferenceEndpointInfo.md); -::: +``` diff --git a/docs/reference/api/InferencePutGooglevertexaiRequest.md b/docs/reference/api/InferencePutGooglevertexaiRequest.md index f13502342..de2343833 100644 --- a/docs/reference/api/InferencePutGooglevertexaiRequest.md +++ b/docs/reference/api/InferencePutGooglevertexaiRequest.md @@ -1,4 +1,4 @@ -## Interface `InferencePutGooglevertexaiRequest` +# `InferencePutGooglevertexaiRequest` [interface-InferencePutGooglevertexaiRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/InferencePutGooglevertexaiResponse.md b/docs/reference/api/InferencePutGooglevertexaiResponse.md index 29453ce1b..9e7e98934 100644 --- a/docs/reference/api/InferencePutGooglevertexaiResponse.md +++ b/docs/reference/api/InferencePutGooglevertexaiResponse.md @@ -1,4 +1,4 @@ -## `InferencePutGooglevertexaiResponse` -::: +# `InferencePutGooglevertexaiResponse` [alias-InferencePutGooglevertexaiResponse] +```typescript type InferencePutGooglevertexaiResponse = [InferenceInferenceEndpointInfo](./InferenceInferenceEndpointInfo.md); -::: +``` diff --git a/docs/reference/api/InferencePutHuggingFaceRequest.md b/docs/reference/api/InferencePutHuggingFaceRequest.md index 6b3e4676e..cb1f305ac 100644 --- a/docs/reference/api/InferencePutHuggingFaceRequest.md +++ b/docs/reference/api/InferencePutHuggingFaceRequest.md @@ -1,4 +1,4 @@ -## Interface `InferencePutHuggingFaceRequest` +# `InferencePutHuggingFaceRequest` [interface-InferencePutHuggingFaceRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/InferencePutHuggingFaceResponse.md b/docs/reference/api/InferencePutHuggingFaceResponse.md index 17b0682bb..0ad674b00 100644 --- a/docs/reference/api/InferencePutHuggingFaceResponse.md +++ b/docs/reference/api/InferencePutHuggingFaceResponse.md @@ -1,4 +1,4 @@ -## `InferencePutHuggingFaceResponse` -::: +# `InferencePutHuggingFaceResponse` [alias-InferencePutHuggingFaceResponse] +```typescript type InferencePutHuggingFaceResponse = [InferenceInferenceEndpointInfo](./InferenceInferenceEndpointInfo.md); -::: +``` diff --git a/docs/reference/api/InferencePutJinaaiRequest.md b/docs/reference/api/InferencePutJinaaiRequest.md index f0eb533be..fa5a91b1c 100644 --- a/docs/reference/api/InferencePutJinaaiRequest.md +++ b/docs/reference/api/InferencePutJinaaiRequest.md @@ -1,4 +1,4 @@ -## Interface `InferencePutJinaaiRequest` +# `InferencePutJinaaiRequest` [interface-InferencePutJinaaiRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/InferencePutJinaaiResponse.md b/docs/reference/api/InferencePutJinaaiResponse.md index c6542dbf4..699358e5a 100644 --- a/docs/reference/api/InferencePutJinaaiResponse.md +++ b/docs/reference/api/InferencePutJinaaiResponse.md @@ -1,4 +1,4 @@ -## `InferencePutJinaaiResponse` -::: +# `InferencePutJinaaiResponse` [alias-InferencePutJinaaiResponse] +```typescript type InferencePutJinaaiResponse = [InferenceInferenceEndpointInfo](./InferenceInferenceEndpointInfo.md); -::: +``` diff --git a/docs/reference/api/InferencePutMistralRequest.md b/docs/reference/api/InferencePutMistralRequest.md index 4a5d27a67..85e161f7e 100644 --- a/docs/reference/api/InferencePutMistralRequest.md +++ b/docs/reference/api/InferencePutMistralRequest.md @@ -1,4 +1,4 @@ -## Interface `InferencePutMistralRequest` +# `InferencePutMistralRequest` [interface-InferencePutMistralRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/InferencePutMistralResponse.md b/docs/reference/api/InferencePutMistralResponse.md index 623bd058d..2b69c9a5a 100644 --- a/docs/reference/api/InferencePutMistralResponse.md +++ b/docs/reference/api/InferencePutMistralResponse.md @@ -1,4 +1,4 @@ -## `InferencePutMistralResponse` -::: +# `InferencePutMistralResponse` [alias-InferencePutMistralResponse] +```typescript type InferencePutMistralResponse = [InferenceInferenceEndpointInfo](./InferenceInferenceEndpointInfo.md); -::: +``` diff --git a/docs/reference/api/InferencePutOpenaiRequest.md b/docs/reference/api/InferencePutOpenaiRequest.md index 6518821ce..e0ed0ddca 100644 --- a/docs/reference/api/InferencePutOpenaiRequest.md +++ b/docs/reference/api/InferencePutOpenaiRequest.md @@ -1,4 +1,4 @@ -## Interface `InferencePutOpenaiRequest` +# `InferencePutOpenaiRequest` [interface-InferencePutOpenaiRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/InferencePutOpenaiResponse.md b/docs/reference/api/InferencePutOpenaiResponse.md index 3f94fc474..24198c0d7 100644 --- a/docs/reference/api/InferencePutOpenaiResponse.md +++ b/docs/reference/api/InferencePutOpenaiResponse.md @@ -1,4 +1,4 @@ -## `InferencePutOpenaiResponse` -::: +# `InferencePutOpenaiResponse` [alias-InferencePutOpenaiResponse] +```typescript type InferencePutOpenaiResponse = [InferenceInferenceEndpointInfo](./InferenceInferenceEndpointInfo.md); -::: +``` diff --git a/docs/reference/api/InferencePutRequest.md b/docs/reference/api/InferencePutRequest.md index 957aa5d27..ca029f893 100644 --- a/docs/reference/api/InferencePutRequest.md +++ b/docs/reference/api/InferencePutRequest.md @@ -1,4 +1,4 @@ -## Interface `InferencePutRequest` +# `InferencePutRequest` [interface-InferencePutRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/InferencePutResponse.md b/docs/reference/api/InferencePutResponse.md index 836eb0d27..f4581471c 100644 --- a/docs/reference/api/InferencePutResponse.md +++ b/docs/reference/api/InferencePutResponse.md @@ -1,4 +1,4 @@ -## `InferencePutResponse` -::: +# `InferencePutResponse` [alias-InferencePutResponse] +```typescript type InferencePutResponse = [InferenceInferenceEndpointInfo](./InferenceInferenceEndpointInfo.md); -::: +``` diff --git a/docs/reference/api/InferencePutVoyageaiRequest.md b/docs/reference/api/InferencePutVoyageaiRequest.md index d521b3058..3bfa64c18 100644 --- a/docs/reference/api/InferencePutVoyageaiRequest.md +++ b/docs/reference/api/InferencePutVoyageaiRequest.md @@ -1,4 +1,4 @@ -## Interface `InferencePutVoyageaiRequest` +# `InferencePutVoyageaiRequest` [interface-InferencePutVoyageaiRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/InferencePutVoyageaiResponse.md b/docs/reference/api/InferencePutVoyageaiResponse.md index 1d2a942f2..bb5b5b8db 100644 --- a/docs/reference/api/InferencePutVoyageaiResponse.md +++ b/docs/reference/api/InferencePutVoyageaiResponse.md @@ -1,4 +1,4 @@ -## `InferencePutVoyageaiResponse` -::: +# `InferencePutVoyageaiResponse` [alias-InferencePutVoyageaiResponse] +```typescript type InferencePutVoyageaiResponse = [InferenceInferenceEndpointInfo](./InferenceInferenceEndpointInfo.md); -::: +``` diff --git a/docs/reference/api/InferencePutWatsonxRequest.md b/docs/reference/api/InferencePutWatsonxRequest.md index 6d393c707..ce1f42f72 100644 --- a/docs/reference/api/InferencePutWatsonxRequest.md +++ b/docs/reference/api/InferencePutWatsonxRequest.md @@ -1,4 +1,4 @@ -## Interface `InferencePutWatsonxRequest` +# `InferencePutWatsonxRequest` [interface-InferencePutWatsonxRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/InferencePutWatsonxResponse.md b/docs/reference/api/InferencePutWatsonxResponse.md index 3e25844a9..8c6b7f108 100644 --- a/docs/reference/api/InferencePutWatsonxResponse.md +++ b/docs/reference/api/InferencePutWatsonxResponse.md @@ -1,4 +1,4 @@ -## `InferencePutWatsonxResponse` -::: +# `InferencePutWatsonxResponse` [alias-InferencePutWatsonxResponse] +```typescript type InferencePutWatsonxResponse = [InferenceInferenceEndpointInfo](./InferenceInferenceEndpointInfo.md); -::: +``` diff --git a/docs/reference/api/InferenceRankedDocument.md b/docs/reference/api/InferenceRankedDocument.md index 1e79f5f37..fb5b53f46 100644 --- a/docs/reference/api/InferenceRankedDocument.md +++ b/docs/reference/api/InferenceRankedDocument.md @@ -1,4 +1,4 @@ -## Interface `InferenceRankedDocument` +# `InferenceRankedDocument` [interface-InferenceRankedDocument] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/InferenceRateLimitSetting.md b/docs/reference/api/InferenceRateLimitSetting.md index 4a643375f..d67b45de5 100644 --- a/docs/reference/api/InferenceRateLimitSetting.md +++ b/docs/reference/api/InferenceRateLimitSetting.md @@ -1,4 +1,4 @@ -## Interface `InferenceRateLimitSetting` +# `InferenceRateLimitSetting` [interface-InferenceRateLimitSetting] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/InferenceRequestChatCompletion.md b/docs/reference/api/InferenceRequestChatCompletion.md index d62b1365b..7dbecd8ae 100644 --- a/docs/reference/api/InferenceRequestChatCompletion.md +++ b/docs/reference/api/InferenceRequestChatCompletion.md @@ -1,4 +1,4 @@ -## Interface `InferenceRequestChatCompletion` +# `InferenceRequestChatCompletion` [interface-InferenceRequestChatCompletion] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/InferenceRerankRequest.md b/docs/reference/api/InferenceRerankRequest.md index 8249c4d56..672ee80be 100644 --- a/docs/reference/api/InferenceRerankRequest.md +++ b/docs/reference/api/InferenceRerankRequest.md @@ -1,4 +1,4 @@ -## Interface `InferenceRerankRequest` +# `InferenceRerankRequest` [interface-InferenceRerankRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/InferenceRerankResponse.md b/docs/reference/api/InferenceRerankResponse.md index 7192605c1..c6ed2ca7a 100644 --- a/docs/reference/api/InferenceRerankResponse.md +++ b/docs/reference/api/InferenceRerankResponse.md @@ -1,4 +1,4 @@ -## `InferenceRerankResponse` -::: +# `InferenceRerankResponse` [alias-InferenceRerankResponse] +```typescript type InferenceRerankResponse = [InferenceRerankedInferenceResult](./InferenceRerankedInferenceResult.md); -::: +``` diff --git a/docs/reference/api/InferenceRerankedInferenceResult.md b/docs/reference/api/InferenceRerankedInferenceResult.md index 37fe124f7..a4b23249e 100644 --- a/docs/reference/api/InferenceRerankedInferenceResult.md +++ b/docs/reference/api/InferenceRerankedInferenceResult.md @@ -1,4 +1,4 @@ -## Interface `InferenceRerankedInferenceResult` +# `InferenceRerankedInferenceResult` [interface-InferenceRerankedInferenceResult] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/InferenceServiceSettings.md b/docs/reference/api/InferenceServiceSettings.md index 2b9ca0d2a..854cfd4cc 100644 --- a/docs/reference/api/InferenceServiceSettings.md +++ b/docs/reference/api/InferenceServiceSettings.md @@ -1,4 +1,4 @@ -## `InferenceServiceSettings` -::: +# `InferenceServiceSettings` [alias-InferenceServiceSettings] +```typescript type InferenceServiceSettings = any; -::: +``` diff --git a/docs/reference/api/InferenceSparseEmbeddingInferenceResult.md b/docs/reference/api/InferenceSparseEmbeddingInferenceResult.md index 808e9afff..7ffc18799 100644 --- a/docs/reference/api/InferenceSparseEmbeddingInferenceResult.md +++ b/docs/reference/api/InferenceSparseEmbeddingInferenceResult.md @@ -1,4 +1,4 @@ -## Interface `InferenceSparseEmbeddingInferenceResult` +# `InferenceSparseEmbeddingInferenceResult` [interface-InferenceSparseEmbeddingInferenceResult] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/InferenceSparseEmbeddingRequest.md b/docs/reference/api/InferenceSparseEmbeddingRequest.md index b95db5187..b8322d23d 100644 --- a/docs/reference/api/InferenceSparseEmbeddingRequest.md +++ b/docs/reference/api/InferenceSparseEmbeddingRequest.md @@ -1,4 +1,4 @@ -## Interface `InferenceSparseEmbeddingRequest` +# `InferenceSparseEmbeddingRequest` [interface-InferenceSparseEmbeddingRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/InferenceSparseEmbeddingResponse.md b/docs/reference/api/InferenceSparseEmbeddingResponse.md index 67f2bc240..ab690d0ab 100644 --- a/docs/reference/api/InferenceSparseEmbeddingResponse.md +++ b/docs/reference/api/InferenceSparseEmbeddingResponse.md @@ -1,4 +1,4 @@ -## `InferenceSparseEmbeddingResponse` -::: +# `InferenceSparseEmbeddingResponse` [alias-InferenceSparseEmbeddingResponse] +```typescript type InferenceSparseEmbeddingResponse = [InferenceSparseEmbeddingInferenceResult](./InferenceSparseEmbeddingInferenceResult.md); -::: +``` diff --git a/docs/reference/api/InferenceSparseEmbeddingResult.md b/docs/reference/api/InferenceSparseEmbeddingResult.md index 1d6688a40..62c8caf21 100644 --- a/docs/reference/api/InferenceSparseEmbeddingResult.md +++ b/docs/reference/api/InferenceSparseEmbeddingResult.md @@ -1,4 +1,4 @@ -## Interface `InferenceSparseEmbeddingResult` +# `InferenceSparseEmbeddingResult` [interface-InferenceSparseEmbeddingResult] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/InferenceSparseVector.md b/docs/reference/api/InferenceSparseVector.md index 8c39bb607..330eb2f9f 100644 --- a/docs/reference/api/InferenceSparseVector.md +++ b/docs/reference/api/InferenceSparseVector.md @@ -1,4 +1,4 @@ -## `InferenceSparseVector` -::: +# `InferenceSparseVector` [alias-InferenceSparseVector] +```typescript type InferenceSparseVector = Record; -::: +``` diff --git a/docs/reference/api/InferenceStreamCompletionRequest.md b/docs/reference/api/InferenceStreamCompletionRequest.md index 94a9d27b9..e2427824f 100644 --- a/docs/reference/api/InferenceStreamCompletionRequest.md +++ b/docs/reference/api/InferenceStreamCompletionRequest.md @@ -1,4 +1,4 @@ -## Interface `InferenceStreamCompletionRequest` +# `InferenceStreamCompletionRequest` [interface-InferenceStreamCompletionRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/InferenceStreamCompletionResponse.md b/docs/reference/api/InferenceStreamCompletionResponse.md index df3482014..60b067a01 100644 --- a/docs/reference/api/InferenceStreamCompletionResponse.md +++ b/docs/reference/api/InferenceStreamCompletionResponse.md @@ -1,4 +1,4 @@ -## `InferenceStreamCompletionResponse` -::: +# `InferenceStreamCompletionResponse` [alias-InferenceStreamCompletionResponse] +```typescript type InferenceStreamCompletionResponse = [StreamResult](./StreamResult.md); -::: +``` diff --git a/docs/reference/api/InferenceTaskSettings.md b/docs/reference/api/InferenceTaskSettings.md index bd0e19e6b..969251c0d 100644 --- a/docs/reference/api/InferenceTaskSettings.md +++ b/docs/reference/api/InferenceTaskSettings.md @@ -1,4 +1,4 @@ -## `InferenceTaskSettings` -::: +# `InferenceTaskSettings` [alias-InferenceTaskSettings] +```typescript type InferenceTaskSettings = any; -::: +``` diff --git a/docs/reference/api/InferenceTaskType.md b/docs/reference/api/InferenceTaskType.md index 4cd397e87..bf255f5df 100644 --- a/docs/reference/api/InferenceTaskType.md +++ b/docs/reference/api/InferenceTaskType.md @@ -1,4 +1,4 @@ -## `InferenceTaskType` -::: +# `InferenceTaskType` [alias-InferenceTaskType] +```typescript type InferenceTaskType = 'sparse_embedding' | 'text_embedding' | 'rerank' | 'completion' | 'chat_completion'; -::: +``` diff --git a/docs/reference/api/InferenceTextEmbeddingByteResult.md b/docs/reference/api/InferenceTextEmbeddingByteResult.md index b07bf9302..1b107bfeb 100644 --- a/docs/reference/api/InferenceTextEmbeddingByteResult.md +++ b/docs/reference/api/InferenceTextEmbeddingByteResult.md @@ -1,4 +1,4 @@ -## Interface `InferenceTextEmbeddingByteResult` +# `InferenceTextEmbeddingByteResult` [interface-InferenceTextEmbeddingByteResult] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/InferenceTextEmbeddingInferenceResult.md b/docs/reference/api/InferenceTextEmbeddingInferenceResult.md index af8392f6b..6fdc18bbe 100644 --- a/docs/reference/api/InferenceTextEmbeddingInferenceResult.md +++ b/docs/reference/api/InferenceTextEmbeddingInferenceResult.md @@ -1,4 +1,4 @@ -## Interface `InferenceTextEmbeddingInferenceResult` +# `InferenceTextEmbeddingInferenceResult` [interface-InferenceTextEmbeddingInferenceResult] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/InferenceTextEmbeddingRequest.md b/docs/reference/api/InferenceTextEmbeddingRequest.md index 16b26b1df..bbfbc02a9 100644 --- a/docs/reference/api/InferenceTextEmbeddingRequest.md +++ b/docs/reference/api/InferenceTextEmbeddingRequest.md @@ -1,4 +1,4 @@ -## Interface `InferenceTextEmbeddingRequest` +# `InferenceTextEmbeddingRequest` [interface-InferenceTextEmbeddingRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/InferenceTextEmbeddingResponse.md b/docs/reference/api/InferenceTextEmbeddingResponse.md index d729b7e54..e8ca56b00 100644 --- a/docs/reference/api/InferenceTextEmbeddingResponse.md +++ b/docs/reference/api/InferenceTextEmbeddingResponse.md @@ -1,4 +1,4 @@ -## `InferenceTextEmbeddingResponse` -::: +# `InferenceTextEmbeddingResponse` [alias-InferenceTextEmbeddingResponse] +```typescript type InferenceTextEmbeddingResponse = [InferenceTextEmbeddingInferenceResult](./InferenceTextEmbeddingInferenceResult.md); -::: +``` diff --git a/docs/reference/api/InferenceTextEmbeddingResult.md b/docs/reference/api/InferenceTextEmbeddingResult.md index 4481cd7b3..b5be764ef 100644 --- a/docs/reference/api/InferenceTextEmbeddingResult.md +++ b/docs/reference/api/InferenceTextEmbeddingResult.md @@ -1,4 +1,4 @@ -## Interface `InferenceTextEmbeddingResult` +# `InferenceTextEmbeddingResult` [interface-InferenceTextEmbeddingResult] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/InferenceToolCall.md b/docs/reference/api/InferenceToolCall.md index f8698dd56..d5c9e1ea1 100644 --- a/docs/reference/api/InferenceToolCall.md +++ b/docs/reference/api/InferenceToolCall.md @@ -1,4 +1,4 @@ -## Interface `InferenceToolCall` +# `InferenceToolCall` [interface-InferenceToolCall] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/InferenceToolCallFunction.md b/docs/reference/api/InferenceToolCallFunction.md index 69455b0b4..b092c28b8 100644 --- a/docs/reference/api/InferenceToolCallFunction.md +++ b/docs/reference/api/InferenceToolCallFunction.md @@ -1,4 +1,4 @@ -## Interface `InferenceToolCallFunction` +# `InferenceToolCallFunction` [interface-InferenceToolCallFunction] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/InferenceUpdateRequest.md b/docs/reference/api/InferenceUpdateRequest.md index 16b80eca0..f4046e654 100644 --- a/docs/reference/api/InferenceUpdateRequest.md +++ b/docs/reference/api/InferenceUpdateRequest.md @@ -1,4 +1,4 @@ -## Interface `InferenceUpdateRequest` +# `InferenceUpdateRequest` [interface-InferenceUpdateRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/InferenceUpdateResponse.md b/docs/reference/api/InferenceUpdateResponse.md index c6f71d63f..1768c30d2 100644 --- a/docs/reference/api/InferenceUpdateResponse.md +++ b/docs/reference/api/InferenceUpdateResponse.md @@ -1,4 +1,4 @@ -## `InferenceUpdateResponse` -::: +# `InferenceUpdateResponse` [alias-InferenceUpdateResponse] +```typescript type InferenceUpdateResponse = [InferenceInferenceEndpointInfo](./InferenceInferenceEndpointInfo.md); -::: +``` diff --git a/docs/reference/api/InferenceVoyageAIServiceSettings.md b/docs/reference/api/InferenceVoyageAIServiceSettings.md index eb7921df4..14b1bcdf1 100644 --- a/docs/reference/api/InferenceVoyageAIServiceSettings.md +++ b/docs/reference/api/InferenceVoyageAIServiceSettings.md @@ -1,4 +1,4 @@ -## Interface `InferenceVoyageAIServiceSettings` +# `InferenceVoyageAIServiceSettings` [interface-InferenceVoyageAIServiceSettings] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/InferenceVoyageAIServiceType.md b/docs/reference/api/InferenceVoyageAIServiceType.md index 91404fe9d..bdcdb7d50 100644 --- a/docs/reference/api/InferenceVoyageAIServiceType.md +++ b/docs/reference/api/InferenceVoyageAIServiceType.md @@ -1,4 +1,4 @@ -## `InferenceVoyageAIServiceType` -::: +# `InferenceVoyageAIServiceType` [alias-InferenceVoyageAIServiceType] +```typescript type InferenceVoyageAIServiceType = 'voyageai'; -::: +``` diff --git a/docs/reference/api/InferenceVoyageAITaskSettings.md b/docs/reference/api/InferenceVoyageAITaskSettings.md index c8180abe6..5acdc07d3 100644 --- a/docs/reference/api/InferenceVoyageAITaskSettings.md +++ b/docs/reference/api/InferenceVoyageAITaskSettings.md @@ -1,4 +1,4 @@ -## Interface `InferenceVoyageAITaskSettings` +# `InferenceVoyageAITaskSettings` [interface-InferenceVoyageAITaskSettings] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/InferenceVoyageAITaskType.md b/docs/reference/api/InferenceVoyageAITaskType.md index 46ab9e173..db4ad808a 100644 --- a/docs/reference/api/InferenceVoyageAITaskType.md +++ b/docs/reference/api/InferenceVoyageAITaskType.md @@ -1,4 +1,4 @@ -## `InferenceVoyageAITaskType` -::: +# `InferenceVoyageAITaskType` [alias-InferenceVoyageAITaskType] +```typescript type InferenceVoyageAITaskType = 'text_embedding' | 'rerank'; -::: +``` diff --git a/docs/reference/api/InferenceWatsonxServiceSettings.md b/docs/reference/api/InferenceWatsonxServiceSettings.md index f9e70cac5..b14689a0d 100644 --- a/docs/reference/api/InferenceWatsonxServiceSettings.md +++ b/docs/reference/api/InferenceWatsonxServiceSettings.md @@ -1,4 +1,4 @@ -## Interface `InferenceWatsonxServiceSettings` +# `InferenceWatsonxServiceSettings` [interface-InferenceWatsonxServiceSettings] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/InferenceWatsonxServiceType.md b/docs/reference/api/InferenceWatsonxServiceType.md index 18018d665..812378159 100644 --- a/docs/reference/api/InferenceWatsonxServiceType.md +++ b/docs/reference/api/InferenceWatsonxServiceType.md @@ -1,4 +1,4 @@ -## `InferenceWatsonxServiceType` -::: +# `InferenceWatsonxServiceType` [alias-InferenceWatsonxServiceType] +```typescript type InferenceWatsonxServiceType = 'watsonxai'; -::: +``` diff --git a/docs/reference/api/InferenceWatsonxTaskType.md b/docs/reference/api/InferenceWatsonxTaskType.md index d71520a77..cdb5d9764 100644 --- a/docs/reference/api/InferenceWatsonxTaskType.md +++ b/docs/reference/api/InferenceWatsonxTaskType.md @@ -1,4 +1,4 @@ -## `InferenceWatsonxTaskType` -::: +# `InferenceWatsonxTaskType` [alias-InferenceWatsonxTaskType] +```typescript type InferenceWatsonxTaskType = 'text_embedding'; -::: +``` diff --git a/docs/reference/api/InfoApi_1.md b/docs/reference/api/InfoApi_1.md index d4faa65b8..3a704eb0b 100644 --- a/docs/reference/api/InfoApi_1.md +++ b/docs/reference/api/InfoApi_1.md @@ -1,3 +1,3 @@ -::: +```typescript default function InfoApi(this: [That](./That.md), params?: [InfoRequest](./InfoRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[InfoResponse](./InfoResponse.md)>; -::: +``` diff --git a/docs/reference/api/InfoApi_2.md b/docs/reference/api/InfoApi_2.md index f0a0f7229..fc8f4379d 100644 --- a/docs/reference/api/InfoApi_2.md +++ b/docs/reference/api/InfoApi_2.md @@ -1,3 +1,3 @@ -::: +```typescript default function InfoApi(this: [That](./That.md), params?: [InfoRequest](./InfoRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[InfoResponse](./InfoResponse.md), unknown>>; -::: +``` diff --git a/docs/reference/api/InfoApi_3.md b/docs/reference/api/InfoApi_3.md index 6268aa1d9..5132e0f44 100644 --- a/docs/reference/api/InfoApi_3.md +++ b/docs/reference/api/InfoApi_3.md @@ -1,3 +1,3 @@ -::: +```typescript default function InfoApi(this: [That](./That.md), params?: [InfoRequest](./InfoRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[InfoResponse](./InfoResponse.md)>; -::: +``` diff --git a/docs/reference/api/InfoRequest.md b/docs/reference/api/InfoRequest.md index 9a1532658..047af1844 100644 --- a/docs/reference/api/InfoRequest.md +++ b/docs/reference/api/InfoRequest.md @@ -1,4 +1,4 @@ -## Interface `InfoRequest` +# `InfoRequest` [interface-InfoRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/InfoResponse.md b/docs/reference/api/InfoResponse.md index 6f98b0574..90110c436 100644 --- a/docs/reference/api/InfoResponse.md +++ b/docs/reference/api/InfoResponse.md @@ -1,4 +1,4 @@ -## Interface `InfoResponse` +# `InfoResponse` [interface-InfoResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/Ingest.md b/docs/reference/api/Ingest.md index 6be1c6077..b348eaad3 100644 --- a/docs/reference/api/Ingest.md +++ b/docs/reference/api/Ingest.md @@ -1,19 +1,19 @@ -## `Ingest` +# `Ingest` [class-Ingest] -### Constructor +## Constructor -::: +```typescript new Ingest(transport: [Transport](./Transport.md)); -::: +``` -### Properties +## Properties [class-properties-Ingest] | Name | Type | Description | | - | - | - | | `acceptedParams` | Record |   | | `transport` | [Transport](./Transport.md) |   | -### Methods +## Methods [class-methods-Ingest] | Name | Signature | Description | | - | - | - | diff --git a/docs/reference/api/IngestAppendProcessor.md b/docs/reference/api/IngestAppendProcessor.md index 993fbab23..966371497 100644 --- a/docs/reference/api/IngestAppendProcessor.md +++ b/docs/reference/api/IngestAppendProcessor.md @@ -1,4 +1,4 @@ -## Interface `IngestAppendProcessor` +# `IngestAppendProcessor` [interface-IngestAppendProcessor] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IngestAttachmentProcessor.md b/docs/reference/api/IngestAttachmentProcessor.md index 50b567f26..dc0ca3530 100644 --- a/docs/reference/api/IngestAttachmentProcessor.md +++ b/docs/reference/api/IngestAttachmentProcessor.md @@ -1,4 +1,4 @@ -## Interface `IngestAttachmentProcessor` +# `IngestAttachmentProcessor` [interface-IngestAttachmentProcessor] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IngestBytesProcessor.md b/docs/reference/api/IngestBytesProcessor.md index 6708dd87c..cbb2c69df 100644 --- a/docs/reference/api/IngestBytesProcessor.md +++ b/docs/reference/api/IngestBytesProcessor.md @@ -1,4 +1,4 @@ -## Interface `IngestBytesProcessor` +# `IngestBytesProcessor` [interface-IngestBytesProcessor] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IngestCircleProcessor.md b/docs/reference/api/IngestCircleProcessor.md index 6d1993900..c41802faa 100644 --- a/docs/reference/api/IngestCircleProcessor.md +++ b/docs/reference/api/IngestCircleProcessor.md @@ -1,4 +1,4 @@ -## Interface `IngestCircleProcessor` +# `IngestCircleProcessor` [interface-IngestCircleProcessor] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IngestCommunityIDProcessor.md b/docs/reference/api/IngestCommunityIDProcessor.md index 9ae73ba52..c2aeb24c3 100644 --- a/docs/reference/api/IngestCommunityIDProcessor.md +++ b/docs/reference/api/IngestCommunityIDProcessor.md @@ -1,4 +1,4 @@ -## Interface `IngestCommunityIDProcessor` +# `IngestCommunityIDProcessor` [interface-IngestCommunityIDProcessor] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IngestConvertProcessor.md b/docs/reference/api/IngestConvertProcessor.md index 89817c474..bafa8f2a0 100644 --- a/docs/reference/api/IngestConvertProcessor.md +++ b/docs/reference/api/IngestConvertProcessor.md @@ -1,4 +1,4 @@ -## Interface `IngestConvertProcessor` +# `IngestConvertProcessor` [interface-IngestConvertProcessor] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IngestConvertType.md b/docs/reference/api/IngestConvertType.md index b773077c9..61f6af6f2 100644 --- a/docs/reference/api/IngestConvertType.md +++ b/docs/reference/api/IngestConvertType.md @@ -1,4 +1,4 @@ -## `IngestConvertType` -::: +# `IngestConvertType` [alias-IngestConvertType] +```typescript type IngestConvertType = 'integer' | 'long' | 'double' | 'float' | 'boolean' | 'ip' | 'string' | 'auto'; -::: +``` diff --git a/docs/reference/api/IngestCsvProcessor.md b/docs/reference/api/IngestCsvProcessor.md index e29a1ee32..388db5ca4 100644 --- a/docs/reference/api/IngestCsvProcessor.md +++ b/docs/reference/api/IngestCsvProcessor.md @@ -1,4 +1,4 @@ -## Interface `IngestCsvProcessor` +# `IngestCsvProcessor` [interface-IngestCsvProcessor] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IngestDatabaseConfiguration.md b/docs/reference/api/IngestDatabaseConfiguration.md index a497b6e48..0d9a74681 100644 --- a/docs/reference/api/IngestDatabaseConfiguration.md +++ b/docs/reference/api/IngestDatabaseConfiguration.md @@ -1,4 +1,4 @@ -## Interface `IngestDatabaseConfiguration` +# `IngestDatabaseConfiguration` [interface-IngestDatabaseConfiguration] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IngestDatabaseConfigurationFull.md b/docs/reference/api/IngestDatabaseConfigurationFull.md index 031e32dd4..c4fe1d568 100644 --- a/docs/reference/api/IngestDatabaseConfigurationFull.md +++ b/docs/reference/api/IngestDatabaseConfigurationFull.md @@ -1,4 +1,4 @@ -## Interface `IngestDatabaseConfigurationFull` +# `IngestDatabaseConfigurationFull` [interface-IngestDatabaseConfigurationFull] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IngestDateIndexNameProcessor.md b/docs/reference/api/IngestDateIndexNameProcessor.md index 2e28480bb..c313ba639 100644 --- a/docs/reference/api/IngestDateIndexNameProcessor.md +++ b/docs/reference/api/IngestDateIndexNameProcessor.md @@ -1,4 +1,4 @@ -## Interface `IngestDateIndexNameProcessor` +# `IngestDateIndexNameProcessor` [interface-IngestDateIndexNameProcessor] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IngestDateProcessor.md b/docs/reference/api/IngestDateProcessor.md index bf2bf7161..6640fd539 100644 --- a/docs/reference/api/IngestDateProcessor.md +++ b/docs/reference/api/IngestDateProcessor.md @@ -1,4 +1,4 @@ -## Interface `IngestDateProcessor` +# `IngestDateProcessor` [interface-IngestDateProcessor] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IngestDeleteGeoipDatabaseRequest.md b/docs/reference/api/IngestDeleteGeoipDatabaseRequest.md index dbd143862..54089ba7d 100644 --- a/docs/reference/api/IngestDeleteGeoipDatabaseRequest.md +++ b/docs/reference/api/IngestDeleteGeoipDatabaseRequest.md @@ -1,4 +1,4 @@ -## Interface `IngestDeleteGeoipDatabaseRequest` +# `IngestDeleteGeoipDatabaseRequest` [interface-IngestDeleteGeoipDatabaseRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IngestDeleteGeoipDatabaseResponse.md b/docs/reference/api/IngestDeleteGeoipDatabaseResponse.md index 718856739..22fe5691d 100644 --- a/docs/reference/api/IngestDeleteGeoipDatabaseResponse.md +++ b/docs/reference/api/IngestDeleteGeoipDatabaseResponse.md @@ -1,4 +1,4 @@ -## `IngestDeleteGeoipDatabaseResponse` -::: +# `IngestDeleteGeoipDatabaseResponse` [alias-IngestDeleteGeoipDatabaseResponse] +```typescript type IngestDeleteGeoipDatabaseResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); -::: +``` diff --git a/docs/reference/api/IngestDeleteIpLocationDatabaseRequest.md b/docs/reference/api/IngestDeleteIpLocationDatabaseRequest.md index 960e9787e..2752d0a68 100644 --- a/docs/reference/api/IngestDeleteIpLocationDatabaseRequest.md +++ b/docs/reference/api/IngestDeleteIpLocationDatabaseRequest.md @@ -1,4 +1,4 @@ -## Interface `IngestDeleteIpLocationDatabaseRequest` +# `IngestDeleteIpLocationDatabaseRequest` [interface-IngestDeleteIpLocationDatabaseRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IngestDeleteIpLocationDatabaseResponse.md b/docs/reference/api/IngestDeleteIpLocationDatabaseResponse.md index b96af4706..f8206d5ef 100644 --- a/docs/reference/api/IngestDeleteIpLocationDatabaseResponse.md +++ b/docs/reference/api/IngestDeleteIpLocationDatabaseResponse.md @@ -1,4 +1,4 @@ -## `IngestDeleteIpLocationDatabaseResponse` -::: +# `IngestDeleteIpLocationDatabaseResponse` [alias-IngestDeleteIpLocationDatabaseResponse] +```typescript type IngestDeleteIpLocationDatabaseResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); -::: +``` diff --git a/docs/reference/api/IngestDeletePipelineRequest.md b/docs/reference/api/IngestDeletePipelineRequest.md index 97b81a45c..867962cc0 100644 --- a/docs/reference/api/IngestDeletePipelineRequest.md +++ b/docs/reference/api/IngestDeletePipelineRequest.md @@ -1,4 +1,4 @@ -## Interface `IngestDeletePipelineRequest` +# `IngestDeletePipelineRequest` [interface-IngestDeletePipelineRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IngestDeletePipelineResponse.md b/docs/reference/api/IngestDeletePipelineResponse.md index caebb1912..717551542 100644 --- a/docs/reference/api/IngestDeletePipelineResponse.md +++ b/docs/reference/api/IngestDeletePipelineResponse.md @@ -1,4 +1,4 @@ -## `IngestDeletePipelineResponse` -::: +# `IngestDeletePipelineResponse` [alias-IngestDeletePipelineResponse] +```typescript type IngestDeletePipelineResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); -::: +``` diff --git a/docs/reference/api/IngestDissectProcessor.md b/docs/reference/api/IngestDissectProcessor.md index cd13dbf52..99d4e84ef 100644 --- a/docs/reference/api/IngestDissectProcessor.md +++ b/docs/reference/api/IngestDissectProcessor.md @@ -1,4 +1,4 @@ -## Interface `IngestDissectProcessor` +# `IngestDissectProcessor` [interface-IngestDissectProcessor] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IngestDocument.md b/docs/reference/api/IngestDocument.md index e1bc88a0c..9c91ef9a5 100644 --- a/docs/reference/api/IngestDocument.md +++ b/docs/reference/api/IngestDocument.md @@ -1,4 +1,4 @@ -## Interface `IngestDocument` +# `IngestDocument` [interface-IngestDocument] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IngestDocumentSimulation.md b/docs/reference/api/IngestDocumentSimulation.md index 275eedc87..16be75ac5 100644 --- a/docs/reference/api/IngestDocumentSimulation.md +++ b/docs/reference/api/IngestDocumentSimulation.md @@ -1,4 +1,4 @@ -## `IngestDocumentSimulation` -::: +# `IngestDocumentSimulation` [alias-IngestDocumentSimulation] +```typescript type IngestDocumentSimulation = [IngestDocumentSimulationKeys](./IngestDocumentSimulationKeys.md) & { [property: string]: string | [Id](./Id.md) | [IndexName](./IndexName.md) | [IngestIngest](./IngestIngest.md) | Record | [SpecUtilsStringified](./SpecUtilsStringified.md)<[VersionNumber](./VersionNumber.md)> | [VersionType](./VersionType.md);}; -::: +``` diff --git a/docs/reference/api/IngestDocumentSimulationKeys.md b/docs/reference/api/IngestDocumentSimulationKeys.md index df9569512..17ee91a74 100644 --- a/docs/reference/api/IngestDocumentSimulationKeys.md +++ b/docs/reference/api/IngestDocumentSimulationKeys.md @@ -1,4 +1,4 @@ -## Interface `IngestDocumentSimulationKeys` +# `IngestDocumentSimulationKeys` [interface-IngestDocumentSimulationKeys] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IngestDotExpanderProcessor.md b/docs/reference/api/IngestDotExpanderProcessor.md index 47fefb449..26c74db86 100644 --- a/docs/reference/api/IngestDotExpanderProcessor.md +++ b/docs/reference/api/IngestDotExpanderProcessor.md @@ -1,4 +1,4 @@ -## Interface `IngestDotExpanderProcessor` +# `IngestDotExpanderProcessor` [interface-IngestDotExpanderProcessor] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IngestDropProcessor.md b/docs/reference/api/IngestDropProcessor.md index 169a295a7..2e2ec5535 100644 --- a/docs/reference/api/IngestDropProcessor.md +++ b/docs/reference/api/IngestDropProcessor.md @@ -1,4 +1,4 @@ -## Interface `IngestDropProcessor` +# `IngestDropProcessor` [interface-IngestDropProcessor] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IngestEnrichProcessor.md b/docs/reference/api/IngestEnrichProcessor.md index 4d0707392..eeadd6305 100644 --- a/docs/reference/api/IngestEnrichProcessor.md +++ b/docs/reference/api/IngestEnrichProcessor.md @@ -1,4 +1,4 @@ -## Interface `IngestEnrichProcessor` +# `IngestEnrichProcessor` [interface-IngestEnrichProcessor] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IngestFailProcessor.md b/docs/reference/api/IngestFailProcessor.md index a191ed5c4..09ddc9548 100644 --- a/docs/reference/api/IngestFailProcessor.md +++ b/docs/reference/api/IngestFailProcessor.md @@ -1,4 +1,4 @@ -## Interface `IngestFailProcessor` +# `IngestFailProcessor` [interface-IngestFailProcessor] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IngestFingerprintDigest.md b/docs/reference/api/IngestFingerprintDigest.md index 13f9c2b19..66dd65eda 100644 --- a/docs/reference/api/IngestFingerprintDigest.md +++ b/docs/reference/api/IngestFingerprintDigest.md @@ -1,4 +1,4 @@ -## `IngestFingerprintDigest` -::: +# `IngestFingerprintDigest` [alias-IngestFingerprintDigest] +```typescript type IngestFingerprintDigest = 'MD5' | 'SHA-1' | 'SHA-256' | 'SHA-512' | 'MurmurHash3'; -::: +``` diff --git a/docs/reference/api/IngestFingerprintProcessor.md b/docs/reference/api/IngestFingerprintProcessor.md index 38160d370..c0f488df5 100644 --- a/docs/reference/api/IngestFingerprintProcessor.md +++ b/docs/reference/api/IngestFingerprintProcessor.md @@ -1,4 +1,4 @@ -## Interface `IngestFingerprintProcessor` +# `IngestFingerprintProcessor` [interface-IngestFingerprintProcessor] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IngestForeachProcessor.md b/docs/reference/api/IngestForeachProcessor.md index 690b09748..5454e0816 100644 --- a/docs/reference/api/IngestForeachProcessor.md +++ b/docs/reference/api/IngestForeachProcessor.md @@ -1,4 +1,4 @@ -## Interface `IngestForeachProcessor` +# `IngestForeachProcessor` [interface-IngestForeachProcessor] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IngestGeoGridProcessor.md b/docs/reference/api/IngestGeoGridProcessor.md index fc50aecf4..1a83e0c31 100644 --- a/docs/reference/api/IngestGeoGridProcessor.md +++ b/docs/reference/api/IngestGeoGridProcessor.md @@ -1,4 +1,4 @@ -## Interface `IngestGeoGridProcessor` +# `IngestGeoGridProcessor` [interface-IngestGeoGridProcessor] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IngestGeoGridTargetFormat.md b/docs/reference/api/IngestGeoGridTargetFormat.md index d82c469fa..edf0ecfe2 100644 --- a/docs/reference/api/IngestGeoGridTargetFormat.md +++ b/docs/reference/api/IngestGeoGridTargetFormat.md @@ -1,4 +1,4 @@ -## `IngestGeoGridTargetFormat` -::: +# `IngestGeoGridTargetFormat` [alias-IngestGeoGridTargetFormat] +```typescript type IngestGeoGridTargetFormat = 'geojson' | 'wkt'; -::: +``` diff --git a/docs/reference/api/IngestGeoGridTileType.md b/docs/reference/api/IngestGeoGridTileType.md index 7d06684da..6c50afd3b 100644 --- a/docs/reference/api/IngestGeoGridTileType.md +++ b/docs/reference/api/IngestGeoGridTileType.md @@ -1,4 +1,4 @@ -## `IngestGeoGridTileType` -::: +# `IngestGeoGridTileType` [alias-IngestGeoGridTileType] +```typescript type IngestGeoGridTileType = 'geotile' | 'geohex' | 'geohash'; -::: +``` diff --git a/docs/reference/api/IngestGeoIpProcessor.md b/docs/reference/api/IngestGeoIpProcessor.md index a24ab9709..7e8f2d550 100644 --- a/docs/reference/api/IngestGeoIpProcessor.md +++ b/docs/reference/api/IngestGeoIpProcessor.md @@ -1,4 +1,4 @@ -## Interface `IngestGeoIpProcessor` +# `IngestGeoIpProcessor` [interface-IngestGeoIpProcessor] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IngestGeoIpStatsGeoIpDownloadStatistics.md b/docs/reference/api/IngestGeoIpStatsGeoIpDownloadStatistics.md index bcf03db86..74d90bcdd 100644 --- a/docs/reference/api/IngestGeoIpStatsGeoIpDownloadStatistics.md +++ b/docs/reference/api/IngestGeoIpStatsGeoIpDownloadStatistics.md @@ -1,4 +1,4 @@ -## Interface `IngestGeoIpStatsGeoIpDownloadStatistics` +# `IngestGeoIpStatsGeoIpDownloadStatistics` [interface-IngestGeoIpStatsGeoIpDownloadStatistics] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IngestGeoIpStatsGeoIpNodeDatabaseName.md b/docs/reference/api/IngestGeoIpStatsGeoIpNodeDatabaseName.md index fae2ec780..3093723c0 100644 --- a/docs/reference/api/IngestGeoIpStatsGeoIpNodeDatabaseName.md +++ b/docs/reference/api/IngestGeoIpStatsGeoIpNodeDatabaseName.md @@ -1,4 +1,4 @@ -## Interface `IngestGeoIpStatsGeoIpNodeDatabaseName` +# `IngestGeoIpStatsGeoIpNodeDatabaseName` [interface-IngestGeoIpStatsGeoIpNodeDatabaseName] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IngestGeoIpStatsGeoIpNodeDatabases.md b/docs/reference/api/IngestGeoIpStatsGeoIpNodeDatabases.md index 31a118dd7..8ddc023f7 100644 --- a/docs/reference/api/IngestGeoIpStatsGeoIpNodeDatabases.md +++ b/docs/reference/api/IngestGeoIpStatsGeoIpNodeDatabases.md @@ -1,4 +1,4 @@ -## Interface `IngestGeoIpStatsGeoIpNodeDatabases` +# `IngestGeoIpStatsGeoIpNodeDatabases` [interface-IngestGeoIpStatsGeoIpNodeDatabases] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IngestGeoIpStatsRequest.md b/docs/reference/api/IngestGeoIpStatsRequest.md index 054319b02..86b8989e3 100644 --- a/docs/reference/api/IngestGeoIpStatsRequest.md +++ b/docs/reference/api/IngestGeoIpStatsRequest.md @@ -1,4 +1,4 @@ -## Interface `IngestGeoIpStatsRequest` +# `IngestGeoIpStatsRequest` [interface-IngestGeoIpStatsRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IngestGeoIpStatsResponse.md b/docs/reference/api/IngestGeoIpStatsResponse.md index ab35ba885..40dbe7b2a 100644 --- a/docs/reference/api/IngestGeoIpStatsResponse.md +++ b/docs/reference/api/IngestGeoIpStatsResponse.md @@ -1,4 +1,4 @@ -## Interface `IngestGeoIpStatsResponse` +# `IngestGeoIpStatsResponse` [interface-IngestGeoIpStatsResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IngestGetGeoipDatabaseDatabaseConfigurationMetadata.md b/docs/reference/api/IngestGetGeoipDatabaseDatabaseConfigurationMetadata.md index 84919cda1..0f097b345 100644 --- a/docs/reference/api/IngestGetGeoipDatabaseDatabaseConfigurationMetadata.md +++ b/docs/reference/api/IngestGetGeoipDatabaseDatabaseConfigurationMetadata.md @@ -1,4 +1,4 @@ -## Interface `IngestGetGeoipDatabaseDatabaseConfigurationMetadata` +# `IngestGetGeoipDatabaseDatabaseConfigurationMetadata` [interface-IngestGetGeoipDatabaseDatabaseConfigurationMetadata] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IngestGetGeoipDatabaseRequest.md b/docs/reference/api/IngestGetGeoipDatabaseRequest.md index 929924a21..a44c51039 100644 --- a/docs/reference/api/IngestGetGeoipDatabaseRequest.md +++ b/docs/reference/api/IngestGetGeoipDatabaseRequest.md @@ -1,4 +1,4 @@ -## Interface `IngestGetGeoipDatabaseRequest` +# `IngestGetGeoipDatabaseRequest` [interface-IngestGetGeoipDatabaseRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IngestGetGeoipDatabaseResponse.md b/docs/reference/api/IngestGetGeoipDatabaseResponse.md index 7491bf942..805145a6c 100644 --- a/docs/reference/api/IngestGetGeoipDatabaseResponse.md +++ b/docs/reference/api/IngestGetGeoipDatabaseResponse.md @@ -1,4 +1,4 @@ -## Interface `IngestGetGeoipDatabaseResponse` +# `IngestGetGeoipDatabaseResponse` [interface-IngestGetGeoipDatabaseResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IngestGetIpLocationDatabaseDatabaseConfigurationMetadata.md b/docs/reference/api/IngestGetIpLocationDatabaseDatabaseConfigurationMetadata.md index 7c905bf24..9b8c17cd2 100644 --- a/docs/reference/api/IngestGetIpLocationDatabaseDatabaseConfigurationMetadata.md +++ b/docs/reference/api/IngestGetIpLocationDatabaseDatabaseConfigurationMetadata.md @@ -1,4 +1,4 @@ -## Interface `IngestGetIpLocationDatabaseDatabaseConfigurationMetadata` +# `IngestGetIpLocationDatabaseDatabaseConfigurationMetadata` [interface-IngestGetIpLocationDatabaseDatabaseConfigurationMetadata] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IngestGetIpLocationDatabaseRequest.md b/docs/reference/api/IngestGetIpLocationDatabaseRequest.md index f2c1e05a8..58b55a5b8 100644 --- a/docs/reference/api/IngestGetIpLocationDatabaseRequest.md +++ b/docs/reference/api/IngestGetIpLocationDatabaseRequest.md @@ -1,4 +1,4 @@ -## Interface `IngestGetIpLocationDatabaseRequest` +# `IngestGetIpLocationDatabaseRequest` [interface-IngestGetIpLocationDatabaseRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IngestGetIpLocationDatabaseResponse.md b/docs/reference/api/IngestGetIpLocationDatabaseResponse.md index 852b96094..f561e2226 100644 --- a/docs/reference/api/IngestGetIpLocationDatabaseResponse.md +++ b/docs/reference/api/IngestGetIpLocationDatabaseResponse.md @@ -1,4 +1,4 @@ -## Interface `IngestGetIpLocationDatabaseResponse` +# `IngestGetIpLocationDatabaseResponse` [interface-IngestGetIpLocationDatabaseResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IngestGetPipelineRequest.md b/docs/reference/api/IngestGetPipelineRequest.md index 530baf5bf..859f8d947 100644 --- a/docs/reference/api/IngestGetPipelineRequest.md +++ b/docs/reference/api/IngestGetPipelineRequest.md @@ -1,4 +1,4 @@ -## Interface `IngestGetPipelineRequest` +# `IngestGetPipelineRequest` [interface-IngestGetPipelineRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IngestGetPipelineResponse.md b/docs/reference/api/IngestGetPipelineResponse.md index 4e8fa0b9c..88122340e 100644 --- a/docs/reference/api/IngestGetPipelineResponse.md +++ b/docs/reference/api/IngestGetPipelineResponse.md @@ -1,4 +1,4 @@ -## `IngestGetPipelineResponse` -::: +# `IngestGetPipelineResponse` [alias-IngestGetPipelineResponse] +```typescript type IngestGetPipelineResponse = Record; -::: +``` diff --git a/docs/reference/api/IngestGrokProcessor.md b/docs/reference/api/IngestGrokProcessor.md index 4701a00ed..51e74bcda 100644 --- a/docs/reference/api/IngestGrokProcessor.md +++ b/docs/reference/api/IngestGrokProcessor.md @@ -1,4 +1,4 @@ -## Interface `IngestGrokProcessor` +# `IngestGrokProcessor` [interface-IngestGrokProcessor] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IngestGsubProcessor.md b/docs/reference/api/IngestGsubProcessor.md index 9debfa931..4619138cc 100644 --- a/docs/reference/api/IngestGsubProcessor.md +++ b/docs/reference/api/IngestGsubProcessor.md @@ -1,4 +1,4 @@ -## Interface `IngestGsubProcessor` +# `IngestGsubProcessor` [interface-IngestGsubProcessor] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IngestHtmlStripProcessor.md b/docs/reference/api/IngestHtmlStripProcessor.md index 4e811c6e2..5049e5154 100644 --- a/docs/reference/api/IngestHtmlStripProcessor.md +++ b/docs/reference/api/IngestHtmlStripProcessor.md @@ -1,4 +1,4 @@ -## Interface `IngestHtmlStripProcessor` +# `IngestHtmlStripProcessor` [interface-IngestHtmlStripProcessor] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IngestInferenceConfig.md b/docs/reference/api/IngestInferenceConfig.md index 8e20a379a..0c856c49a 100644 --- a/docs/reference/api/IngestInferenceConfig.md +++ b/docs/reference/api/IngestInferenceConfig.md @@ -1,4 +1,4 @@ -## Interface `IngestInferenceConfig` +# `IngestInferenceConfig` [interface-IngestInferenceConfig] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IngestInferenceConfigClassification.md b/docs/reference/api/IngestInferenceConfigClassification.md index 98c56c9bd..c498ce166 100644 --- a/docs/reference/api/IngestInferenceConfigClassification.md +++ b/docs/reference/api/IngestInferenceConfigClassification.md @@ -1,4 +1,4 @@ -## Interface `IngestInferenceConfigClassification` +# `IngestInferenceConfigClassification` [interface-IngestInferenceConfigClassification] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IngestInferenceConfigRegression.md b/docs/reference/api/IngestInferenceConfigRegression.md index 3660f40e2..ec8fb5780 100644 --- a/docs/reference/api/IngestInferenceConfigRegression.md +++ b/docs/reference/api/IngestInferenceConfigRegression.md @@ -1,4 +1,4 @@ -## Interface `IngestInferenceConfigRegression` +# `IngestInferenceConfigRegression` [interface-IngestInferenceConfigRegression] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IngestInferenceProcessor.md b/docs/reference/api/IngestInferenceProcessor.md index ab26c42b9..c78ba8887 100644 --- a/docs/reference/api/IngestInferenceProcessor.md +++ b/docs/reference/api/IngestInferenceProcessor.md @@ -1,4 +1,4 @@ -## Interface `IngestInferenceProcessor` +# `IngestInferenceProcessor` [interface-IngestInferenceProcessor] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IngestIngest.md b/docs/reference/api/IngestIngest.md index bb8135501..6c29680d7 100644 --- a/docs/reference/api/IngestIngest.md +++ b/docs/reference/api/IngestIngest.md @@ -1,4 +1,4 @@ -## Interface `IngestIngest` +# `IngestIngest` [interface-IngestIngest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IngestInputConfig.md b/docs/reference/api/IngestInputConfig.md index 3bef4b640..65d1c60f6 100644 --- a/docs/reference/api/IngestInputConfig.md +++ b/docs/reference/api/IngestInputConfig.md @@ -1,4 +1,4 @@ -## Interface `IngestInputConfig` +# `IngestInputConfig` [interface-IngestInputConfig] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IngestIpLocationProcessor.md b/docs/reference/api/IngestIpLocationProcessor.md index 7ea87caf5..c27f9d81b 100644 --- a/docs/reference/api/IngestIpLocationProcessor.md +++ b/docs/reference/api/IngestIpLocationProcessor.md @@ -1,4 +1,4 @@ -## Interface `IngestIpLocationProcessor` +# `IngestIpLocationProcessor` [interface-IngestIpLocationProcessor] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IngestIpinfo.md b/docs/reference/api/IngestIpinfo.md index 107dfafa8..84697efb9 100644 --- a/docs/reference/api/IngestIpinfo.md +++ b/docs/reference/api/IngestIpinfo.md @@ -1,4 +1,4 @@ -## Interface `IngestIpinfo` +# `IngestIpinfo` [interface-IngestIpinfo] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IngestJoinProcessor.md b/docs/reference/api/IngestJoinProcessor.md index e10a9920c..e8dfc58e7 100644 --- a/docs/reference/api/IngestJoinProcessor.md +++ b/docs/reference/api/IngestJoinProcessor.md @@ -1,4 +1,4 @@ -## Interface `IngestJoinProcessor` +# `IngestJoinProcessor` [interface-IngestJoinProcessor] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IngestJsonProcessor.md b/docs/reference/api/IngestJsonProcessor.md index 3dbcb41d3..c6107893d 100644 --- a/docs/reference/api/IngestJsonProcessor.md +++ b/docs/reference/api/IngestJsonProcessor.md @@ -1,4 +1,4 @@ -## Interface `IngestJsonProcessor` +# `IngestJsonProcessor` [interface-IngestJsonProcessor] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IngestJsonProcessorConflictStrategy.md b/docs/reference/api/IngestJsonProcessorConflictStrategy.md index 19cc77956..23b117ad8 100644 --- a/docs/reference/api/IngestJsonProcessorConflictStrategy.md +++ b/docs/reference/api/IngestJsonProcessorConflictStrategy.md @@ -1,4 +1,4 @@ -## `IngestJsonProcessorConflictStrategy` -::: +# `IngestJsonProcessorConflictStrategy` [alias-IngestJsonProcessorConflictStrategy] +```typescript type IngestJsonProcessorConflictStrategy = 'replace' | 'merge'; -::: +``` diff --git a/docs/reference/api/IngestKeyValueProcessor.md b/docs/reference/api/IngestKeyValueProcessor.md index c0ef648dc..221b90105 100644 --- a/docs/reference/api/IngestKeyValueProcessor.md +++ b/docs/reference/api/IngestKeyValueProcessor.md @@ -1,4 +1,4 @@ -## Interface `IngestKeyValueProcessor` +# `IngestKeyValueProcessor` [interface-IngestKeyValueProcessor] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IngestLocal.md b/docs/reference/api/IngestLocal.md index 989afa5bc..552063854 100644 --- a/docs/reference/api/IngestLocal.md +++ b/docs/reference/api/IngestLocal.md @@ -1,4 +1,4 @@ -## Interface `IngestLocal` +# `IngestLocal` [interface-IngestLocal] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IngestLowercaseProcessor.md b/docs/reference/api/IngestLowercaseProcessor.md index b367828b0..632b275dd 100644 --- a/docs/reference/api/IngestLowercaseProcessor.md +++ b/docs/reference/api/IngestLowercaseProcessor.md @@ -1,4 +1,4 @@ -## Interface `IngestLowercaseProcessor` +# `IngestLowercaseProcessor` [interface-IngestLowercaseProcessor] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IngestMaxmind.md b/docs/reference/api/IngestMaxmind.md index 4c59a9502..a28694c86 100644 --- a/docs/reference/api/IngestMaxmind.md +++ b/docs/reference/api/IngestMaxmind.md @@ -1,4 +1,4 @@ -## Interface `IngestMaxmind` +# `IngestMaxmind` [interface-IngestMaxmind] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IngestNetworkDirectionProcessor.md b/docs/reference/api/IngestNetworkDirectionProcessor.md index bb6b9885e..10012aed8 100644 --- a/docs/reference/api/IngestNetworkDirectionProcessor.md +++ b/docs/reference/api/IngestNetworkDirectionProcessor.md @@ -1,4 +1,4 @@ -## Interface `IngestNetworkDirectionProcessor` +# `IngestNetworkDirectionProcessor` [interface-IngestNetworkDirectionProcessor] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IngestPipeline.md b/docs/reference/api/IngestPipeline.md index 6a2332cc5..a142e8ea3 100644 --- a/docs/reference/api/IngestPipeline.md +++ b/docs/reference/api/IngestPipeline.md @@ -1,4 +1,4 @@ -## Interface `IngestPipeline` +# `IngestPipeline` [interface-IngestPipeline] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IngestPipelineConfig.md b/docs/reference/api/IngestPipelineConfig.md index 93ac46004..eebe9bf14 100644 --- a/docs/reference/api/IngestPipelineConfig.md +++ b/docs/reference/api/IngestPipelineConfig.md @@ -1,4 +1,4 @@ -## Interface `IngestPipelineConfig` +# `IngestPipelineConfig` [interface-IngestPipelineConfig] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IngestPipelineProcessor.md b/docs/reference/api/IngestPipelineProcessor.md index d997ab3ef..3813597de 100644 --- a/docs/reference/api/IngestPipelineProcessor.md +++ b/docs/reference/api/IngestPipelineProcessor.md @@ -1,4 +1,4 @@ -## Interface `IngestPipelineProcessor` +# `IngestPipelineProcessor` [interface-IngestPipelineProcessor] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IngestPipelineProcessorResult.md b/docs/reference/api/IngestPipelineProcessorResult.md index 62c7f427b..f85d53490 100644 --- a/docs/reference/api/IngestPipelineProcessorResult.md +++ b/docs/reference/api/IngestPipelineProcessorResult.md @@ -1,4 +1,4 @@ -## Interface `IngestPipelineProcessorResult` +# `IngestPipelineProcessorResult` [interface-IngestPipelineProcessorResult] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IngestPipelineSimulationStatusOptions.md b/docs/reference/api/IngestPipelineSimulationStatusOptions.md index 091cc34c3..95d05440e 100644 --- a/docs/reference/api/IngestPipelineSimulationStatusOptions.md +++ b/docs/reference/api/IngestPipelineSimulationStatusOptions.md @@ -1,4 +1,4 @@ -## `IngestPipelineSimulationStatusOptions` -::: +# `IngestPipelineSimulationStatusOptions` [alias-IngestPipelineSimulationStatusOptions] +```typescript type IngestPipelineSimulationStatusOptions = 'success' | 'error' | 'error_ignored' | 'skipped' | 'dropped'; -::: +``` diff --git a/docs/reference/api/IngestProcessorBase.md b/docs/reference/api/IngestProcessorBase.md index 3efbdf357..586b7982b 100644 --- a/docs/reference/api/IngestProcessorBase.md +++ b/docs/reference/api/IngestProcessorBase.md @@ -1,4 +1,4 @@ -## Interface `IngestProcessorBase` +# `IngestProcessorBase` [interface-IngestProcessorBase] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IngestProcessorContainer.md b/docs/reference/api/IngestProcessorContainer.md index fba1758dc..0c348609f 100644 --- a/docs/reference/api/IngestProcessorContainer.md +++ b/docs/reference/api/IngestProcessorContainer.md @@ -1,4 +1,4 @@ -## Interface `IngestProcessorContainer` +# `IngestProcessorContainer` [interface-IngestProcessorContainer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IngestProcessorGrokRequest.md b/docs/reference/api/IngestProcessorGrokRequest.md index ce7ef5408..a15a428f3 100644 --- a/docs/reference/api/IngestProcessorGrokRequest.md +++ b/docs/reference/api/IngestProcessorGrokRequest.md @@ -1,4 +1,4 @@ -## Interface `IngestProcessorGrokRequest` +# `IngestProcessorGrokRequest` [interface-IngestProcessorGrokRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IngestProcessorGrokResponse.md b/docs/reference/api/IngestProcessorGrokResponse.md index 667894d0e..9d688699e 100644 --- a/docs/reference/api/IngestProcessorGrokResponse.md +++ b/docs/reference/api/IngestProcessorGrokResponse.md @@ -1,4 +1,4 @@ -## Interface `IngestProcessorGrokResponse` +# `IngestProcessorGrokResponse` [interface-IngestProcessorGrokResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IngestPutGeoipDatabaseRequest.md b/docs/reference/api/IngestPutGeoipDatabaseRequest.md index 57617ad40..18d41bd39 100644 --- a/docs/reference/api/IngestPutGeoipDatabaseRequest.md +++ b/docs/reference/api/IngestPutGeoipDatabaseRequest.md @@ -1,4 +1,4 @@ -## Interface `IngestPutGeoipDatabaseRequest` +# `IngestPutGeoipDatabaseRequest` [interface-IngestPutGeoipDatabaseRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IngestPutGeoipDatabaseResponse.md b/docs/reference/api/IngestPutGeoipDatabaseResponse.md index 7cc4338e1..7b4e6130d 100644 --- a/docs/reference/api/IngestPutGeoipDatabaseResponse.md +++ b/docs/reference/api/IngestPutGeoipDatabaseResponse.md @@ -1,4 +1,4 @@ -## `IngestPutGeoipDatabaseResponse` -::: +# `IngestPutGeoipDatabaseResponse` [alias-IngestPutGeoipDatabaseResponse] +```typescript type IngestPutGeoipDatabaseResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); -::: +``` diff --git a/docs/reference/api/IngestPutIpLocationDatabaseRequest.md b/docs/reference/api/IngestPutIpLocationDatabaseRequest.md index be923c9fe..8703a5e12 100644 --- a/docs/reference/api/IngestPutIpLocationDatabaseRequest.md +++ b/docs/reference/api/IngestPutIpLocationDatabaseRequest.md @@ -1,4 +1,4 @@ -## Interface `IngestPutIpLocationDatabaseRequest` +# `IngestPutIpLocationDatabaseRequest` [interface-IngestPutIpLocationDatabaseRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IngestPutIpLocationDatabaseResponse.md b/docs/reference/api/IngestPutIpLocationDatabaseResponse.md index 0fe04f453..4007680b0 100644 --- a/docs/reference/api/IngestPutIpLocationDatabaseResponse.md +++ b/docs/reference/api/IngestPutIpLocationDatabaseResponse.md @@ -1,4 +1,4 @@ -## `IngestPutIpLocationDatabaseResponse` -::: +# `IngestPutIpLocationDatabaseResponse` [alias-IngestPutIpLocationDatabaseResponse] +```typescript type IngestPutIpLocationDatabaseResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); -::: +``` diff --git a/docs/reference/api/IngestPutPipelineRequest.md b/docs/reference/api/IngestPutPipelineRequest.md index 870ca6ca6..9ba89dc70 100644 --- a/docs/reference/api/IngestPutPipelineRequest.md +++ b/docs/reference/api/IngestPutPipelineRequest.md @@ -1,4 +1,4 @@ -## Interface `IngestPutPipelineRequest` +# `IngestPutPipelineRequest` [interface-IngestPutPipelineRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IngestPutPipelineResponse.md b/docs/reference/api/IngestPutPipelineResponse.md index 53b31e50a..b63c7f87d 100644 --- a/docs/reference/api/IngestPutPipelineResponse.md +++ b/docs/reference/api/IngestPutPipelineResponse.md @@ -1,4 +1,4 @@ -## `IngestPutPipelineResponse` -::: +# `IngestPutPipelineResponse` [alias-IngestPutPipelineResponse] +```typescript type IngestPutPipelineResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); -::: +``` diff --git a/docs/reference/api/IngestRedact.md b/docs/reference/api/IngestRedact.md index 54dd437ed..67311bf58 100644 --- a/docs/reference/api/IngestRedact.md +++ b/docs/reference/api/IngestRedact.md @@ -1,4 +1,4 @@ -## Interface `IngestRedact` +# `IngestRedact` [interface-IngestRedact] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IngestRedactProcessor.md b/docs/reference/api/IngestRedactProcessor.md index af10c40c2..7084d46f0 100644 --- a/docs/reference/api/IngestRedactProcessor.md +++ b/docs/reference/api/IngestRedactProcessor.md @@ -1,4 +1,4 @@ -## Interface `IngestRedactProcessor` +# `IngestRedactProcessor` [interface-IngestRedactProcessor] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IngestRegisteredDomainProcessor.md b/docs/reference/api/IngestRegisteredDomainProcessor.md index 761220de1..b389fc3fb 100644 --- a/docs/reference/api/IngestRegisteredDomainProcessor.md +++ b/docs/reference/api/IngestRegisteredDomainProcessor.md @@ -1,4 +1,4 @@ -## Interface `IngestRegisteredDomainProcessor` +# `IngestRegisteredDomainProcessor` [interface-IngestRegisteredDomainProcessor] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IngestRemoveProcessor.md b/docs/reference/api/IngestRemoveProcessor.md index 27e237cd3..f47a83049 100644 --- a/docs/reference/api/IngestRemoveProcessor.md +++ b/docs/reference/api/IngestRemoveProcessor.md @@ -1,4 +1,4 @@ -## Interface `IngestRemoveProcessor` +# `IngestRemoveProcessor` [interface-IngestRemoveProcessor] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IngestRenameProcessor.md b/docs/reference/api/IngestRenameProcessor.md index 43e63e1ec..e965380b3 100644 --- a/docs/reference/api/IngestRenameProcessor.md +++ b/docs/reference/api/IngestRenameProcessor.md @@ -1,4 +1,4 @@ -## Interface `IngestRenameProcessor` +# `IngestRenameProcessor` [interface-IngestRenameProcessor] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IngestRerouteProcessor.md b/docs/reference/api/IngestRerouteProcessor.md index 1ffb45cbb..39e47a687 100644 --- a/docs/reference/api/IngestRerouteProcessor.md +++ b/docs/reference/api/IngestRerouteProcessor.md @@ -1,4 +1,4 @@ -## Interface `IngestRerouteProcessor` +# `IngestRerouteProcessor` [interface-IngestRerouteProcessor] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IngestScriptProcessor.md b/docs/reference/api/IngestScriptProcessor.md index d663bd559..8f486d72a 100644 --- a/docs/reference/api/IngestScriptProcessor.md +++ b/docs/reference/api/IngestScriptProcessor.md @@ -1,4 +1,4 @@ -## Interface `IngestScriptProcessor` +# `IngestScriptProcessor` [interface-IngestScriptProcessor] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IngestSetProcessor.md b/docs/reference/api/IngestSetProcessor.md index c518cefcb..d7b144785 100644 --- a/docs/reference/api/IngestSetProcessor.md +++ b/docs/reference/api/IngestSetProcessor.md @@ -1,4 +1,4 @@ -## Interface `IngestSetProcessor` +# `IngestSetProcessor` [interface-IngestSetProcessor] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IngestSetSecurityUserProcessor.md b/docs/reference/api/IngestSetSecurityUserProcessor.md index e41a826b5..3746c2cb2 100644 --- a/docs/reference/api/IngestSetSecurityUserProcessor.md +++ b/docs/reference/api/IngestSetSecurityUserProcessor.md @@ -1,4 +1,4 @@ -## Interface `IngestSetSecurityUserProcessor` +# `IngestSetSecurityUserProcessor` [interface-IngestSetSecurityUserProcessor] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IngestShapeType.md b/docs/reference/api/IngestShapeType.md index 87893f4d7..e742a977d 100644 --- a/docs/reference/api/IngestShapeType.md +++ b/docs/reference/api/IngestShapeType.md @@ -1,4 +1,4 @@ -## `IngestShapeType` -::: +# `IngestShapeType` [alias-IngestShapeType] +```typescript type IngestShapeType = 'geo_shape' | 'shape'; -::: +``` diff --git a/docs/reference/api/IngestSimulateDocumentResult.md b/docs/reference/api/IngestSimulateDocumentResult.md index b82306034..ff776d821 100644 --- a/docs/reference/api/IngestSimulateDocumentResult.md +++ b/docs/reference/api/IngestSimulateDocumentResult.md @@ -1,4 +1,4 @@ -## Interface `IngestSimulateDocumentResult` +# `IngestSimulateDocumentResult` [interface-IngestSimulateDocumentResult] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IngestSimulateRequest.md b/docs/reference/api/IngestSimulateRequest.md index 1619447ff..0f51d20ca 100644 --- a/docs/reference/api/IngestSimulateRequest.md +++ b/docs/reference/api/IngestSimulateRequest.md @@ -1,4 +1,4 @@ -## Interface `IngestSimulateRequest` +# `IngestSimulateRequest` [interface-IngestSimulateRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IngestSimulateResponse.md b/docs/reference/api/IngestSimulateResponse.md index 3eee6bc8c..f220b75b5 100644 --- a/docs/reference/api/IngestSimulateResponse.md +++ b/docs/reference/api/IngestSimulateResponse.md @@ -1,4 +1,4 @@ -## Interface `IngestSimulateResponse` +# `IngestSimulateResponse` [interface-IngestSimulateResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IngestSortProcessor.md b/docs/reference/api/IngestSortProcessor.md index 47f0d5724..82f8d3d50 100644 --- a/docs/reference/api/IngestSortProcessor.md +++ b/docs/reference/api/IngestSortProcessor.md @@ -1,4 +1,4 @@ -## Interface `IngestSortProcessor` +# `IngestSortProcessor` [interface-IngestSortProcessor] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IngestSplitProcessor.md b/docs/reference/api/IngestSplitProcessor.md index afa561f59..2e02bc1b3 100644 --- a/docs/reference/api/IngestSplitProcessor.md +++ b/docs/reference/api/IngestSplitProcessor.md @@ -1,4 +1,4 @@ -## Interface `IngestSplitProcessor` +# `IngestSplitProcessor` [interface-IngestSplitProcessor] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IngestTerminateProcessor.md b/docs/reference/api/IngestTerminateProcessor.md index d82b5d9c8..68057373a 100644 --- a/docs/reference/api/IngestTerminateProcessor.md +++ b/docs/reference/api/IngestTerminateProcessor.md @@ -1,4 +1,4 @@ -## Interface `IngestTerminateProcessor` +# `IngestTerminateProcessor` [interface-IngestTerminateProcessor] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IngestTrimProcessor.md b/docs/reference/api/IngestTrimProcessor.md index de7aaf325..f2ff01397 100644 --- a/docs/reference/api/IngestTrimProcessor.md +++ b/docs/reference/api/IngestTrimProcessor.md @@ -1,4 +1,4 @@ -## Interface `IngestTrimProcessor` +# `IngestTrimProcessor` [interface-IngestTrimProcessor] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IngestUppercaseProcessor.md b/docs/reference/api/IngestUppercaseProcessor.md index bbaf071e1..d740e3557 100644 --- a/docs/reference/api/IngestUppercaseProcessor.md +++ b/docs/reference/api/IngestUppercaseProcessor.md @@ -1,4 +1,4 @@ -## Interface `IngestUppercaseProcessor` +# `IngestUppercaseProcessor` [interface-IngestUppercaseProcessor] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IngestUriPartsProcessor.md b/docs/reference/api/IngestUriPartsProcessor.md index c259acae8..35c1607a0 100644 --- a/docs/reference/api/IngestUriPartsProcessor.md +++ b/docs/reference/api/IngestUriPartsProcessor.md @@ -1,4 +1,4 @@ -## Interface `IngestUriPartsProcessor` +# `IngestUriPartsProcessor` [interface-IngestUriPartsProcessor] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IngestUrlDecodeProcessor.md b/docs/reference/api/IngestUrlDecodeProcessor.md index b97ab6710..4ebe2ebf0 100644 --- a/docs/reference/api/IngestUrlDecodeProcessor.md +++ b/docs/reference/api/IngestUrlDecodeProcessor.md @@ -1,4 +1,4 @@ -## Interface `IngestUrlDecodeProcessor` +# `IngestUrlDecodeProcessor` [interface-IngestUrlDecodeProcessor] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IngestUserAgentProcessor.md b/docs/reference/api/IngestUserAgentProcessor.md index 945015bfd..063bf6538 100644 --- a/docs/reference/api/IngestUserAgentProcessor.md +++ b/docs/reference/api/IngestUserAgentProcessor.md @@ -1,4 +1,4 @@ -## Interface `IngestUserAgentProcessor` +# `IngestUserAgentProcessor` [interface-IngestUserAgentProcessor] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/IngestUserAgentProperty.md b/docs/reference/api/IngestUserAgentProperty.md index 6f5e92854..f4b158223 100644 --- a/docs/reference/api/IngestUserAgentProperty.md +++ b/docs/reference/api/IngestUserAgentProperty.md @@ -1,4 +1,4 @@ -## `IngestUserAgentProperty` -::: +# `IngestUserAgentProperty` [alias-IngestUserAgentProperty] +```typescript type IngestUserAgentProperty = 'name' | 'os' | 'device' | 'original' | 'version'; -::: +``` diff --git a/docs/reference/api/IngestWeb.md b/docs/reference/api/IngestWeb.md index d6b42b0cf..f34a5bc01 100644 --- a/docs/reference/api/IngestWeb.md +++ b/docs/reference/api/IngestWeb.md @@ -1,4 +1,4 @@ -## Interface `IngestWeb` +# `IngestWeb` [interface-IngestWeb] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/InlineGet.md b/docs/reference/api/InlineGet.md index b6273c4c3..3ed903c22 100644 --- a/docs/reference/api/InlineGet.md +++ b/docs/reference/api/InlineGet.md @@ -1,4 +1,4 @@ -## `InlineGet` -::: +# `InlineGet` [alias-InlineGet] +```typescript type InlineGet = [InlineGetKeys](./InlineGetKeys.md) & { [property: string]: any;}; -::: +``` diff --git a/docs/reference/api/InlineGetKeys.md b/docs/reference/api/InlineGetKeys.md index a095747e0..8ef3e4a57 100644 --- a/docs/reference/api/InlineGetKeys.md +++ b/docs/reference/api/InlineGetKeys.md @@ -1,4 +1,4 @@ -## Interface `InlineGetKeys` +# `InlineGetKeys` [interface-InlineGetKeys] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/Ip.md b/docs/reference/api/Ip.md index 581c4ea80..bee7e0f03 100644 --- a/docs/reference/api/Ip.md +++ b/docs/reference/api/Ip.md @@ -1,4 +1,4 @@ -## `Ip` -::: +# `Ip` [alias-Ip] +```typescript type Ip = string; -::: +``` diff --git a/docs/reference/api/KnnQuery.md b/docs/reference/api/KnnQuery.md index 6bf5b1db9..bc0d1c628 100644 --- a/docs/reference/api/KnnQuery.md +++ b/docs/reference/api/KnnQuery.md @@ -1,4 +1,4 @@ -## Interface `KnnQuery` +# `KnnQuery` [interface-KnnQuery] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/KnnRetriever.md b/docs/reference/api/KnnRetriever.md index 0496c66e6..e27a7034a 100644 --- a/docs/reference/api/KnnRetriever.md +++ b/docs/reference/api/KnnRetriever.md @@ -1,4 +1,4 @@ -## Interface `KnnRetriever` +# `KnnRetriever` [interface-KnnRetriever] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/KnnSearch.md b/docs/reference/api/KnnSearch.md index 616840b14..89b553322 100644 --- a/docs/reference/api/KnnSearch.md +++ b/docs/reference/api/KnnSearch.md @@ -1,4 +1,4 @@ -## Interface `KnnSearch` +# `KnnSearch` [interface-KnnSearch] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/KnnSearchApi_1.md b/docs/reference/api/KnnSearchApi_1.md index 2cabff590..42070daa9 100644 --- a/docs/reference/api/KnnSearchApi_1.md +++ b/docs/reference/api/KnnSearchApi_1.md @@ -1,3 +1,3 @@ -::: +```typescript default function KnnSearchApi(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TODO](./TODO.md)>; -::: +``` diff --git a/docs/reference/api/KnnSearchApi_2.md b/docs/reference/api/KnnSearchApi_2.md index 44c32557c..513634e13 100644 --- a/docs/reference/api/KnnSearchApi_2.md +++ b/docs/reference/api/KnnSearchApi_2.md @@ -1,3 +1,3 @@ -::: +```typescript default function KnnSearchApi(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TODO](./TODO.md), unknown>>; -::: +``` diff --git a/docs/reference/api/KnnSearchApi_3.md b/docs/reference/api/KnnSearchApi_3.md index c57f4f2ea..5879158bb 100644 --- a/docs/reference/api/KnnSearchApi_3.md +++ b/docs/reference/api/KnnSearchApi_3.md @@ -1,3 +1,3 @@ -::: +```typescript default function KnnSearchApi(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TODO](./TODO.md)>; -::: +``` diff --git a/docs/reference/api/LatLonGeoLocation.md b/docs/reference/api/LatLonGeoLocation.md index fab1b9f3a..2e44d5012 100644 --- a/docs/reference/api/LatLonGeoLocation.md +++ b/docs/reference/api/LatLonGeoLocation.md @@ -1,4 +1,4 @@ -## Interface `LatLonGeoLocation` +# `LatLonGeoLocation` [interface-LatLonGeoLocation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/Level.md b/docs/reference/api/Level.md index 838c2d377..992def71d 100644 --- a/docs/reference/api/Level.md +++ b/docs/reference/api/Level.md @@ -1,4 +1,4 @@ -## `Level` -::: +# `Level` [alias-Level] +```typescript type Level = 'cluster' | 'indices' | 'shards'; -::: +``` diff --git a/docs/reference/api/License.md b/docs/reference/api/License.md index 3127430cc..e765ac46a 100644 --- a/docs/reference/api/License.md +++ b/docs/reference/api/License.md @@ -1,19 +1,19 @@ -## `License` +# `License` [class-License] -### Constructor +## Constructor -::: +```typescript new License(transport: [Transport](./Transport.md)); -::: +``` -### Properties +## Properties [class-properties-License] | Name | Type | Description | | - | - | - | | `acceptedParams` | Record |   | | `transport` | [Transport](./Transport.md) |   | -### Methods +## Methods [class-methods-License] | Name | Signature | Description | | - | - | - | diff --git a/docs/reference/api/LicenseDeleteRequest.md b/docs/reference/api/LicenseDeleteRequest.md index 811bcff15..754df0dfd 100644 --- a/docs/reference/api/LicenseDeleteRequest.md +++ b/docs/reference/api/LicenseDeleteRequest.md @@ -1,4 +1,4 @@ -## Interface `LicenseDeleteRequest` +# `LicenseDeleteRequest` [interface-LicenseDeleteRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/LicenseDeleteResponse.md b/docs/reference/api/LicenseDeleteResponse.md index 8232f9e3c..dd0c8da89 100644 --- a/docs/reference/api/LicenseDeleteResponse.md +++ b/docs/reference/api/LicenseDeleteResponse.md @@ -1,4 +1,4 @@ -## `LicenseDeleteResponse` -::: +# `LicenseDeleteResponse` [alias-LicenseDeleteResponse] +```typescript type LicenseDeleteResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); -::: +``` diff --git a/docs/reference/api/LicenseGetBasicStatusRequest.md b/docs/reference/api/LicenseGetBasicStatusRequest.md index 7c7f11d60..63684cade 100644 --- a/docs/reference/api/LicenseGetBasicStatusRequest.md +++ b/docs/reference/api/LicenseGetBasicStatusRequest.md @@ -1,4 +1,4 @@ -## Interface `LicenseGetBasicStatusRequest` +# `LicenseGetBasicStatusRequest` [interface-LicenseGetBasicStatusRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/LicenseGetBasicStatusResponse.md b/docs/reference/api/LicenseGetBasicStatusResponse.md index 19fc0ddb7..e292fe131 100644 --- a/docs/reference/api/LicenseGetBasicStatusResponse.md +++ b/docs/reference/api/LicenseGetBasicStatusResponse.md @@ -1,4 +1,4 @@ -## Interface `LicenseGetBasicStatusResponse` +# `LicenseGetBasicStatusResponse` [interface-LicenseGetBasicStatusResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/LicenseGetLicenseInformation.md b/docs/reference/api/LicenseGetLicenseInformation.md index 056bc5e0f..7ac02ad4c 100644 --- a/docs/reference/api/LicenseGetLicenseInformation.md +++ b/docs/reference/api/LicenseGetLicenseInformation.md @@ -1,4 +1,4 @@ -## Interface `LicenseGetLicenseInformation` +# `LicenseGetLicenseInformation` [interface-LicenseGetLicenseInformation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/LicenseGetRequest.md b/docs/reference/api/LicenseGetRequest.md index cde8df8ab..8fa0f355b 100644 --- a/docs/reference/api/LicenseGetRequest.md +++ b/docs/reference/api/LicenseGetRequest.md @@ -1,4 +1,4 @@ -## Interface `LicenseGetRequest` +# `LicenseGetRequest` [interface-LicenseGetRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/LicenseGetResponse.md b/docs/reference/api/LicenseGetResponse.md index c61942ec0..f78d4a6ed 100644 --- a/docs/reference/api/LicenseGetResponse.md +++ b/docs/reference/api/LicenseGetResponse.md @@ -1,4 +1,4 @@ -## Interface `LicenseGetResponse` +# `LicenseGetResponse` [interface-LicenseGetResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/LicenseGetTrialStatusRequest.md b/docs/reference/api/LicenseGetTrialStatusRequest.md index d731cc5c5..89d19db54 100644 --- a/docs/reference/api/LicenseGetTrialStatusRequest.md +++ b/docs/reference/api/LicenseGetTrialStatusRequest.md @@ -1,4 +1,4 @@ -## Interface `LicenseGetTrialStatusRequest` +# `LicenseGetTrialStatusRequest` [interface-LicenseGetTrialStatusRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/LicenseGetTrialStatusResponse.md b/docs/reference/api/LicenseGetTrialStatusResponse.md index 35aef1588..441b320a3 100644 --- a/docs/reference/api/LicenseGetTrialStatusResponse.md +++ b/docs/reference/api/LicenseGetTrialStatusResponse.md @@ -1,4 +1,4 @@ -## Interface `LicenseGetTrialStatusResponse` +# `LicenseGetTrialStatusResponse` [interface-LicenseGetTrialStatusResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/LicenseLicense.md b/docs/reference/api/LicenseLicense.md index 29d364f30..4e03f745c 100644 --- a/docs/reference/api/LicenseLicense.md +++ b/docs/reference/api/LicenseLicense.md @@ -1,4 +1,4 @@ -## Interface `LicenseLicense` +# `LicenseLicense` [interface-LicenseLicense] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/LicenseLicenseStatus.md b/docs/reference/api/LicenseLicenseStatus.md index 06d51f5e6..d5c0b0b62 100644 --- a/docs/reference/api/LicenseLicenseStatus.md +++ b/docs/reference/api/LicenseLicenseStatus.md @@ -1,4 +1,4 @@ -## `LicenseLicenseStatus` -::: +# `LicenseLicenseStatus` [alias-LicenseLicenseStatus] +```typescript type LicenseLicenseStatus = 'active' | 'valid' | 'invalid' | 'expired'; -::: +``` diff --git a/docs/reference/api/LicenseLicenseType.md b/docs/reference/api/LicenseLicenseType.md index e29946ddb..a951d88e8 100644 --- a/docs/reference/api/LicenseLicenseType.md +++ b/docs/reference/api/LicenseLicenseType.md @@ -1,4 +1,4 @@ -## `LicenseLicenseType` -::: +# `LicenseLicenseType` [alias-LicenseLicenseType] +```typescript type LicenseLicenseType = 'missing' | 'trial' | 'basic' | 'standard' | 'dev' | 'silver' | 'gold' | 'platinum' | 'enterprise'; -::: +``` diff --git a/docs/reference/api/LicensePostAcknowledgement.md b/docs/reference/api/LicensePostAcknowledgement.md index 7da6fc09b..80acd6285 100644 --- a/docs/reference/api/LicensePostAcknowledgement.md +++ b/docs/reference/api/LicensePostAcknowledgement.md @@ -1,4 +1,4 @@ -## Interface `LicensePostAcknowledgement` +# `LicensePostAcknowledgement` [interface-LicensePostAcknowledgement] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/LicensePostRequest.md b/docs/reference/api/LicensePostRequest.md index 81aa593d0..92a64f519 100644 --- a/docs/reference/api/LicensePostRequest.md +++ b/docs/reference/api/LicensePostRequest.md @@ -1,4 +1,4 @@ -## Interface `LicensePostRequest` +# `LicensePostRequest` [interface-LicensePostRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/LicensePostResponse.md b/docs/reference/api/LicensePostResponse.md index c0127a787..873731aba 100644 --- a/docs/reference/api/LicensePostResponse.md +++ b/docs/reference/api/LicensePostResponse.md @@ -1,4 +1,4 @@ -## Interface `LicensePostResponse` +# `LicensePostResponse` [interface-LicensePostResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/LicensePostStartBasicRequest.md b/docs/reference/api/LicensePostStartBasicRequest.md index 807c5e335..fdd498ad1 100644 --- a/docs/reference/api/LicensePostStartBasicRequest.md +++ b/docs/reference/api/LicensePostStartBasicRequest.md @@ -1,4 +1,4 @@ -## Interface `LicensePostStartBasicRequest` +# `LicensePostStartBasicRequest` [interface-LicensePostStartBasicRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/LicensePostStartBasicResponse.md b/docs/reference/api/LicensePostStartBasicResponse.md index 702b4985f..3cc1e197c 100644 --- a/docs/reference/api/LicensePostStartBasicResponse.md +++ b/docs/reference/api/LicensePostStartBasicResponse.md @@ -1,4 +1,4 @@ -## Interface `LicensePostStartBasicResponse` +# `LicensePostStartBasicResponse` [interface-LicensePostStartBasicResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/LicensePostStartTrialRequest.md b/docs/reference/api/LicensePostStartTrialRequest.md index c45b7fcae..a91fbdfe4 100644 --- a/docs/reference/api/LicensePostStartTrialRequest.md +++ b/docs/reference/api/LicensePostStartTrialRequest.md @@ -1,4 +1,4 @@ -## Interface `LicensePostStartTrialRequest` +# `LicensePostStartTrialRequest` [interface-LicensePostStartTrialRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/LicensePostStartTrialResponse.md b/docs/reference/api/LicensePostStartTrialResponse.md index 48c8c21fd..f3528c579 100644 --- a/docs/reference/api/LicensePostStartTrialResponse.md +++ b/docs/reference/api/LicensePostStartTrialResponse.md @@ -1,4 +1,4 @@ -## Interface `LicensePostStartTrialResponse` +# `LicensePostStartTrialResponse` [interface-LicensePostStartTrialResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/LifecycleOperationMode.md b/docs/reference/api/LifecycleOperationMode.md index 08da635ac..3163723db 100644 --- a/docs/reference/api/LifecycleOperationMode.md +++ b/docs/reference/api/LifecycleOperationMode.md @@ -1,4 +1,4 @@ -## `LifecycleOperationMode` -::: +# `LifecycleOperationMode` [alias-LifecycleOperationMode] +```typescript type LifecycleOperationMode = 'RUNNING' | 'STOPPING' | 'STOPPED'; -::: +``` diff --git a/docs/reference/api/Logstash.md b/docs/reference/api/Logstash.md index e87049c73..249b6005d 100644 --- a/docs/reference/api/Logstash.md +++ b/docs/reference/api/Logstash.md @@ -1,19 +1,19 @@ -## `Logstash` +# `Logstash` [class-Logstash] -### Constructor +## Constructor -::: +```typescript new Logstash(transport: [Transport](./Transport.md)); -::: +``` -### Properties +## Properties [class-properties-Logstash] | Name | Type | Description | | - | - | - | | `acceptedParams` | Record |   | | `transport` | [Transport](./Transport.md) |   | -### Methods +## Methods [class-methods-Logstash] | Name | Signature | Description | | - | - | - | diff --git a/docs/reference/api/LogstashDeletePipelineRequest.md b/docs/reference/api/LogstashDeletePipelineRequest.md index c115d52b0..c698b2e2d 100644 --- a/docs/reference/api/LogstashDeletePipelineRequest.md +++ b/docs/reference/api/LogstashDeletePipelineRequest.md @@ -1,4 +1,4 @@ -## Interface `LogstashDeletePipelineRequest` +# `LogstashDeletePipelineRequest` [interface-LogstashDeletePipelineRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/LogstashDeletePipelineResponse.md b/docs/reference/api/LogstashDeletePipelineResponse.md index 3324b5810..b3fc755f0 100644 --- a/docs/reference/api/LogstashDeletePipelineResponse.md +++ b/docs/reference/api/LogstashDeletePipelineResponse.md @@ -1,4 +1,4 @@ -## `LogstashDeletePipelineResponse` -::: +# `LogstashDeletePipelineResponse` [alias-LogstashDeletePipelineResponse] +```typescript type LogstashDeletePipelineResponse = boolean; -::: +``` diff --git a/docs/reference/api/LogstashGetPipelineRequest.md b/docs/reference/api/LogstashGetPipelineRequest.md index b81828c46..444edc9e8 100644 --- a/docs/reference/api/LogstashGetPipelineRequest.md +++ b/docs/reference/api/LogstashGetPipelineRequest.md @@ -1,4 +1,4 @@ -## Interface `LogstashGetPipelineRequest` +# `LogstashGetPipelineRequest` [interface-LogstashGetPipelineRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/LogstashGetPipelineResponse.md b/docs/reference/api/LogstashGetPipelineResponse.md index eb0642aff..a2f9918d1 100644 --- a/docs/reference/api/LogstashGetPipelineResponse.md +++ b/docs/reference/api/LogstashGetPipelineResponse.md @@ -1,4 +1,4 @@ -## `LogstashGetPipelineResponse` -::: +# `LogstashGetPipelineResponse` [alias-LogstashGetPipelineResponse] +```typescript type LogstashGetPipelineResponse = Record<[Id](./Id.md), [LogstashPipeline](./LogstashPipeline.md)>; -::: +``` diff --git a/docs/reference/api/LogstashPipeline.md b/docs/reference/api/LogstashPipeline.md index 8425868c9..c38a90c93 100644 --- a/docs/reference/api/LogstashPipeline.md +++ b/docs/reference/api/LogstashPipeline.md @@ -1,4 +1,4 @@ -## Interface `LogstashPipeline` +# `LogstashPipeline` [interface-LogstashPipeline] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/LogstashPipelineMetadata.md b/docs/reference/api/LogstashPipelineMetadata.md index 152b05b6a..4e03f62d5 100644 --- a/docs/reference/api/LogstashPipelineMetadata.md +++ b/docs/reference/api/LogstashPipelineMetadata.md @@ -1,4 +1,4 @@ -## Interface `LogstashPipelineMetadata` +# `LogstashPipelineMetadata` [interface-LogstashPipelineMetadata] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/LogstashPipelineSettings.md b/docs/reference/api/LogstashPipelineSettings.md index e68fc09ab..4e46e2104 100644 --- a/docs/reference/api/LogstashPipelineSettings.md +++ b/docs/reference/api/LogstashPipelineSettings.md @@ -1,4 +1,4 @@ -## Interface `LogstashPipelineSettings` +# `LogstashPipelineSettings` [interface-LogstashPipelineSettings] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/LogstashPutPipelineRequest.md b/docs/reference/api/LogstashPutPipelineRequest.md index b18aee406..c67839db0 100644 --- a/docs/reference/api/LogstashPutPipelineRequest.md +++ b/docs/reference/api/LogstashPutPipelineRequest.md @@ -1,4 +1,4 @@ -## Interface `LogstashPutPipelineRequest` +# `LogstashPutPipelineRequest` [interface-LogstashPutPipelineRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/LogstashPutPipelineResponse.md b/docs/reference/api/LogstashPutPipelineResponse.md index bcf9d5687..c8f5c5c04 100644 --- a/docs/reference/api/LogstashPutPipelineResponse.md +++ b/docs/reference/api/LogstashPutPipelineResponse.md @@ -1,4 +1,4 @@ -## `LogstashPutPipelineResponse` -::: +# `LogstashPutPipelineResponse` [alias-LogstashPutPipelineResponse] +```typescript type LogstashPutPipelineResponse = boolean; -::: +``` diff --git a/docs/reference/api/MapboxVectorTiles.md b/docs/reference/api/MapboxVectorTiles.md index 21ebac20c..15720c319 100644 --- a/docs/reference/api/MapboxVectorTiles.md +++ b/docs/reference/api/MapboxVectorTiles.md @@ -1,4 +1,4 @@ -## `MapboxVectorTiles` -::: +# `MapboxVectorTiles` [alias-MapboxVectorTiles] +```typescript type MapboxVectorTiles = [ArrayBuffer](./ArrayBuffer.md); -::: +``` diff --git a/docs/reference/api/MappingAggregateMetricDoubleProperty.md b/docs/reference/api/MappingAggregateMetricDoubleProperty.md index 756bd23ae..af3dbe134 100644 --- a/docs/reference/api/MappingAggregateMetricDoubleProperty.md +++ b/docs/reference/api/MappingAggregateMetricDoubleProperty.md @@ -1,4 +1,4 @@ -## Interface `MappingAggregateMetricDoubleProperty` +# `MappingAggregateMetricDoubleProperty` [interface-MappingAggregateMetricDoubleProperty] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MappingAllField.md b/docs/reference/api/MappingAllField.md index 38bd61936..566f283fb 100644 --- a/docs/reference/api/MappingAllField.md +++ b/docs/reference/api/MappingAllField.md @@ -1,4 +1,4 @@ -## Interface `MappingAllField` +# `MappingAllField` [interface-MappingAllField] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MappingBinaryProperty.md b/docs/reference/api/MappingBinaryProperty.md index 4c9dc5094..7fbe2b57d 100644 --- a/docs/reference/api/MappingBinaryProperty.md +++ b/docs/reference/api/MappingBinaryProperty.md @@ -1,4 +1,4 @@ -## Interface `MappingBinaryProperty` +# `MappingBinaryProperty` [interface-MappingBinaryProperty] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MappingBooleanProperty.md b/docs/reference/api/MappingBooleanProperty.md index 459a87bd3..ff58b9bcb 100644 --- a/docs/reference/api/MappingBooleanProperty.md +++ b/docs/reference/api/MappingBooleanProperty.md @@ -1,4 +1,4 @@ -## Interface `MappingBooleanProperty` +# `MappingBooleanProperty` [interface-MappingBooleanProperty] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MappingByteNumberProperty.md b/docs/reference/api/MappingByteNumberProperty.md index 5018f0d49..fbb0cbcb7 100644 --- a/docs/reference/api/MappingByteNumberProperty.md +++ b/docs/reference/api/MappingByteNumberProperty.md @@ -1,4 +1,4 @@ -## Interface `MappingByteNumberProperty` +# `MappingByteNumberProperty` [interface-MappingByteNumberProperty] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MappingChunkingSettings.md b/docs/reference/api/MappingChunkingSettings.md index 1c79bea42..26f943e35 100644 --- a/docs/reference/api/MappingChunkingSettings.md +++ b/docs/reference/api/MappingChunkingSettings.md @@ -1,4 +1,4 @@ -## Interface `MappingChunkingSettings` +# `MappingChunkingSettings` [interface-MappingChunkingSettings] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MappingCompletionProperty.md b/docs/reference/api/MappingCompletionProperty.md index 5db5449ff..803f4e704 100644 --- a/docs/reference/api/MappingCompletionProperty.md +++ b/docs/reference/api/MappingCompletionProperty.md @@ -1,4 +1,4 @@ -## Interface `MappingCompletionProperty` +# `MappingCompletionProperty` [interface-MappingCompletionProperty] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MappingCompositeSubField.md b/docs/reference/api/MappingCompositeSubField.md index 32db0a0d6..b4f9ac4ac 100644 --- a/docs/reference/api/MappingCompositeSubField.md +++ b/docs/reference/api/MappingCompositeSubField.md @@ -1,4 +1,4 @@ -## Interface `MappingCompositeSubField` +# `MappingCompositeSubField` [interface-MappingCompositeSubField] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MappingConstantKeywordProperty.md b/docs/reference/api/MappingConstantKeywordProperty.md index 9a975a389..8a1c3a864 100644 --- a/docs/reference/api/MappingConstantKeywordProperty.md +++ b/docs/reference/api/MappingConstantKeywordProperty.md @@ -1,4 +1,4 @@ -## Interface `MappingConstantKeywordProperty` +# `MappingConstantKeywordProperty` [interface-MappingConstantKeywordProperty] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MappingCorePropertyBase.md b/docs/reference/api/MappingCorePropertyBase.md index 79c3bcdb6..4990d1582 100644 --- a/docs/reference/api/MappingCorePropertyBase.md +++ b/docs/reference/api/MappingCorePropertyBase.md @@ -1,4 +1,4 @@ -## Interface `MappingCorePropertyBase` +# `MappingCorePropertyBase` [interface-MappingCorePropertyBase] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MappingCountedKeywordProperty.md b/docs/reference/api/MappingCountedKeywordProperty.md index 37ce8c56e..928a8514f 100644 --- a/docs/reference/api/MappingCountedKeywordProperty.md +++ b/docs/reference/api/MappingCountedKeywordProperty.md @@ -1,4 +1,4 @@ -## Interface `MappingCountedKeywordProperty` +# `MappingCountedKeywordProperty` [interface-MappingCountedKeywordProperty] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MappingDataStreamTimestamp.md b/docs/reference/api/MappingDataStreamTimestamp.md index d4003b609..86b7caabf 100644 --- a/docs/reference/api/MappingDataStreamTimestamp.md +++ b/docs/reference/api/MappingDataStreamTimestamp.md @@ -1,4 +1,4 @@ -## Interface `MappingDataStreamTimestamp` +# `MappingDataStreamTimestamp` [interface-MappingDataStreamTimestamp] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MappingDateNanosProperty.md b/docs/reference/api/MappingDateNanosProperty.md index bff7aedf8..93bdd3660 100644 --- a/docs/reference/api/MappingDateNanosProperty.md +++ b/docs/reference/api/MappingDateNanosProperty.md @@ -1,4 +1,4 @@ -## Interface `MappingDateNanosProperty` +# `MappingDateNanosProperty` [interface-MappingDateNanosProperty] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MappingDateProperty.md b/docs/reference/api/MappingDateProperty.md index 7fb3b35eb..66d878539 100644 --- a/docs/reference/api/MappingDateProperty.md +++ b/docs/reference/api/MappingDateProperty.md @@ -1,4 +1,4 @@ -## Interface `MappingDateProperty` +# `MappingDateProperty` [interface-MappingDateProperty] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MappingDateRangeProperty.md b/docs/reference/api/MappingDateRangeProperty.md index eaa720838..e82af4a60 100644 --- a/docs/reference/api/MappingDateRangeProperty.md +++ b/docs/reference/api/MappingDateRangeProperty.md @@ -1,4 +1,4 @@ -## Interface `MappingDateRangeProperty` +# `MappingDateRangeProperty` [interface-MappingDateRangeProperty] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MappingDenseVectorElementType.md b/docs/reference/api/MappingDenseVectorElementType.md index fd69e8844..38de7823d 100644 --- a/docs/reference/api/MappingDenseVectorElementType.md +++ b/docs/reference/api/MappingDenseVectorElementType.md @@ -1,4 +1,4 @@ -## `MappingDenseVectorElementType` -::: +# `MappingDenseVectorElementType` [alias-MappingDenseVectorElementType] +```typescript type MappingDenseVectorElementType = 'bit' | 'byte' | 'float'; -::: +``` diff --git a/docs/reference/api/MappingDenseVectorIndexOptions.md b/docs/reference/api/MappingDenseVectorIndexOptions.md index 5d316f0c0..8b4184456 100644 --- a/docs/reference/api/MappingDenseVectorIndexOptions.md +++ b/docs/reference/api/MappingDenseVectorIndexOptions.md @@ -1,4 +1,4 @@ -## Interface `MappingDenseVectorIndexOptions` +# `MappingDenseVectorIndexOptions` [interface-MappingDenseVectorIndexOptions] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MappingDenseVectorIndexOptionsRescoreVector.md b/docs/reference/api/MappingDenseVectorIndexOptionsRescoreVector.md index 82c790c61..96a07280a 100644 --- a/docs/reference/api/MappingDenseVectorIndexOptionsRescoreVector.md +++ b/docs/reference/api/MappingDenseVectorIndexOptionsRescoreVector.md @@ -1,4 +1,4 @@ -## Interface `MappingDenseVectorIndexOptionsRescoreVector` +# `MappingDenseVectorIndexOptionsRescoreVector` [interface-MappingDenseVectorIndexOptionsRescoreVector] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MappingDenseVectorIndexOptionsType.md b/docs/reference/api/MappingDenseVectorIndexOptionsType.md index 181a75957..de9c7ef74 100644 --- a/docs/reference/api/MappingDenseVectorIndexOptionsType.md +++ b/docs/reference/api/MappingDenseVectorIndexOptionsType.md @@ -1,4 +1,4 @@ -## `MappingDenseVectorIndexOptionsType` -::: +# `MappingDenseVectorIndexOptionsType` [alias-MappingDenseVectorIndexOptionsType] +```typescript type MappingDenseVectorIndexOptionsType = 'bbq_flat' | 'bbq_hnsw' | 'flat' | 'hnsw' | 'int4_flat' | 'int4_hnsw' | 'int8_flat' | 'int8_hnsw'; -::: +``` diff --git a/docs/reference/api/MappingDenseVectorProperty.md b/docs/reference/api/MappingDenseVectorProperty.md index 28727bbdd..2633f2570 100644 --- a/docs/reference/api/MappingDenseVectorProperty.md +++ b/docs/reference/api/MappingDenseVectorProperty.md @@ -1,4 +1,4 @@ -## Interface `MappingDenseVectorProperty` +# `MappingDenseVectorProperty` [interface-MappingDenseVectorProperty] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MappingDenseVectorSimilarity.md b/docs/reference/api/MappingDenseVectorSimilarity.md index 6d4ef8742..afef858df 100644 --- a/docs/reference/api/MappingDenseVectorSimilarity.md +++ b/docs/reference/api/MappingDenseVectorSimilarity.md @@ -1,4 +1,4 @@ -## `MappingDenseVectorSimilarity` -::: +# `MappingDenseVectorSimilarity` [alias-MappingDenseVectorSimilarity] +```typescript type MappingDenseVectorSimilarity = 'cosine' | 'dot_product' | 'l2_norm' | 'max_inner_product'; -::: +``` diff --git a/docs/reference/api/MappingDocValuesPropertyBase.md b/docs/reference/api/MappingDocValuesPropertyBase.md index 176ee9195..fbc44b3d9 100644 --- a/docs/reference/api/MappingDocValuesPropertyBase.md +++ b/docs/reference/api/MappingDocValuesPropertyBase.md @@ -1,4 +1,4 @@ -## Interface `MappingDocValuesPropertyBase` +# `MappingDocValuesPropertyBase` [interface-MappingDocValuesPropertyBase] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MappingDoubleNumberProperty.md b/docs/reference/api/MappingDoubleNumberProperty.md index 62b9ef542..eb4e12779 100644 --- a/docs/reference/api/MappingDoubleNumberProperty.md +++ b/docs/reference/api/MappingDoubleNumberProperty.md @@ -1,4 +1,4 @@ -## Interface `MappingDoubleNumberProperty` +# `MappingDoubleNumberProperty` [interface-MappingDoubleNumberProperty] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MappingDoubleRangeProperty.md b/docs/reference/api/MappingDoubleRangeProperty.md index c3af1603e..dfd5f72dd 100644 --- a/docs/reference/api/MappingDoubleRangeProperty.md +++ b/docs/reference/api/MappingDoubleRangeProperty.md @@ -1,4 +1,4 @@ -## Interface `MappingDoubleRangeProperty` +# `MappingDoubleRangeProperty` [interface-MappingDoubleRangeProperty] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MappingDynamicMapping.md b/docs/reference/api/MappingDynamicMapping.md index c748d3385..ddb59bc45 100644 --- a/docs/reference/api/MappingDynamicMapping.md +++ b/docs/reference/api/MappingDynamicMapping.md @@ -1,4 +1,4 @@ -## `MappingDynamicMapping` -::: +# `MappingDynamicMapping` [alias-MappingDynamicMapping] +```typescript type MappingDynamicMapping = boolean | 'strict' | 'runtime' | 'true' | 'false'; -::: +``` diff --git a/docs/reference/api/MappingDynamicProperty.md b/docs/reference/api/MappingDynamicProperty.md index b03e89155..828e58095 100644 --- a/docs/reference/api/MappingDynamicProperty.md +++ b/docs/reference/api/MappingDynamicProperty.md @@ -1,4 +1,4 @@ -## Interface `MappingDynamicProperty` +# `MappingDynamicProperty` [interface-MappingDynamicProperty] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MappingDynamicTemplate.md b/docs/reference/api/MappingDynamicTemplate.md index 426cc3088..0894c039b 100644 --- a/docs/reference/api/MappingDynamicTemplate.md +++ b/docs/reference/api/MappingDynamicTemplate.md @@ -1,4 +1,4 @@ -## Interface `MappingDynamicTemplate` +# `MappingDynamicTemplate` [interface-MappingDynamicTemplate] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MappingFieldAliasProperty.md b/docs/reference/api/MappingFieldAliasProperty.md index a1a939205..c691f4f03 100644 --- a/docs/reference/api/MappingFieldAliasProperty.md +++ b/docs/reference/api/MappingFieldAliasProperty.md @@ -1,4 +1,4 @@ -## Interface `MappingFieldAliasProperty` +# `MappingFieldAliasProperty` [interface-MappingFieldAliasProperty] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MappingFieldMapping.md b/docs/reference/api/MappingFieldMapping.md index fb763288c..a8cec56ba 100644 --- a/docs/reference/api/MappingFieldMapping.md +++ b/docs/reference/api/MappingFieldMapping.md @@ -1,4 +1,4 @@ -## Interface `MappingFieldMapping` +# `MappingFieldMapping` [interface-MappingFieldMapping] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MappingFieldNamesField.md b/docs/reference/api/MappingFieldNamesField.md index 10d5c573c..e1aac9c53 100644 --- a/docs/reference/api/MappingFieldNamesField.md +++ b/docs/reference/api/MappingFieldNamesField.md @@ -1,4 +1,4 @@ -## Interface `MappingFieldNamesField` +# `MappingFieldNamesField` [interface-MappingFieldNamesField] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MappingFieldType.md b/docs/reference/api/MappingFieldType.md index ce15a68c6..7f20936b8 100644 --- a/docs/reference/api/MappingFieldType.md +++ b/docs/reference/api/MappingFieldType.md @@ -1,4 +1,4 @@ -## `MappingFieldType` -::: +# `MappingFieldType` [alias-MappingFieldType] +```typescript type MappingFieldType = 'none' | 'geo_point' | 'geo_shape' | 'ip' | 'binary' | 'keyword' | 'text' | 'search_as_you_type' | 'date' | 'date_nanos' | 'boolean' | 'completion' | 'nested' | 'object' | 'passthrough' | 'version' | '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' | 'counted_keyword' | 'aggregate_metric_double' | 'dense_vector' | 'semantic_text' | 'sparse_vector' | 'match_only_text' | 'icu_collation_keyword'; -::: +``` diff --git a/docs/reference/api/MappingFlattenedProperty.md b/docs/reference/api/MappingFlattenedProperty.md index 4cfa47112..c9648892a 100644 --- a/docs/reference/api/MappingFlattenedProperty.md +++ b/docs/reference/api/MappingFlattenedProperty.md @@ -1,4 +1,4 @@ -## Interface `MappingFlattenedProperty` +# `MappingFlattenedProperty` [interface-MappingFlattenedProperty] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MappingFloatNumberProperty.md b/docs/reference/api/MappingFloatNumberProperty.md index b484d0518..a0d96bf12 100644 --- a/docs/reference/api/MappingFloatNumberProperty.md +++ b/docs/reference/api/MappingFloatNumberProperty.md @@ -1,4 +1,4 @@ -## Interface `MappingFloatNumberProperty` +# `MappingFloatNumberProperty` [interface-MappingFloatNumberProperty] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MappingFloatRangeProperty.md b/docs/reference/api/MappingFloatRangeProperty.md index 60543db48..65400e8cd 100644 --- a/docs/reference/api/MappingFloatRangeProperty.md +++ b/docs/reference/api/MappingFloatRangeProperty.md @@ -1,4 +1,4 @@ -## Interface `MappingFloatRangeProperty` +# `MappingFloatRangeProperty` [interface-MappingFloatRangeProperty] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MappingGeoOrientation.md b/docs/reference/api/MappingGeoOrientation.md index 0b9aa141e..5fb1ae03b 100644 --- a/docs/reference/api/MappingGeoOrientation.md +++ b/docs/reference/api/MappingGeoOrientation.md @@ -1,4 +1,4 @@ -## `MappingGeoOrientation` -::: +# `MappingGeoOrientation` [alias-MappingGeoOrientation] +```typescript type MappingGeoOrientation = 'right' | 'RIGHT' | 'counterclockwise' | 'ccw' | 'left' | 'LEFT' | 'clockwise' | 'cw'; -::: +``` diff --git a/docs/reference/api/MappingGeoPointProperty.md b/docs/reference/api/MappingGeoPointProperty.md index 47129d1fd..b63970753 100644 --- a/docs/reference/api/MappingGeoPointProperty.md +++ b/docs/reference/api/MappingGeoPointProperty.md @@ -1,4 +1,4 @@ -## Interface `MappingGeoPointProperty` +# `MappingGeoPointProperty` [interface-MappingGeoPointProperty] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MappingGeoShapeProperty.md b/docs/reference/api/MappingGeoShapeProperty.md index a2edfde48..3ba1bed4a 100644 --- a/docs/reference/api/MappingGeoShapeProperty.md +++ b/docs/reference/api/MappingGeoShapeProperty.md @@ -1,4 +1,4 @@ -## Interface `MappingGeoShapeProperty` +# `MappingGeoShapeProperty` [interface-MappingGeoShapeProperty] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MappingGeoStrategy.md b/docs/reference/api/MappingGeoStrategy.md index 6e2bea3b7..ae7eb02c3 100644 --- a/docs/reference/api/MappingGeoStrategy.md +++ b/docs/reference/api/MappingGeoStrategy.md @@ -1,4 +1,4 @@ -## `MappingGeoStrategy` -::: +# `MappingGeoStrategy` [alias-MappingGeoStrategy] +```typescript type MappingGeoStrategy = 'recursive' | 'term'; -::: +``` diff --git a/docs/reference/api/MappingHalfFloatNumberProperty.md b/docs/reference/api/MappingHalfFloatNumberProperty.md index 490f7109e..5b9ffd6fe 100644 --- a/docs/reference/api/MappingHalfFloatNumberProperty.md +++ b/docs/reference/api/MappingHalfFloatNumberProperty.md @@ -1,4 +1,4 @@ -## Interface `MappingHalfFloatNumberProperty` +# `MappingHalfFloatNumberProperty` [interface-MappingHalfFloatNumberProperty] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MappingHistogramProperty.md b/docs/reference/api/MappingHistogramProperty.md index 6caac0b06..7f895dcaa 100644 --- a/docs/reference/api/MappingHistogramProperty.md +++ b/docs/reference/api/MappingHistogramProperty.md @@ -1,4 +1,4 @@ -## Interface `MappingHistogramProperty` +# `MappingHistogramProperty` [interface-MappingHistogramProperty] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MappingIcuCollationProperty.md b/docs/reference/api/MappingIcuCollationProperty.md index abb23d02d..ce114d23c 100644 --- a/docs/reference/api/MappingIcuCollationProperty.md +++ b/docs/reference/api/MappingIcuCollationProperty.md @@ -1,4 +1,4 @@ -## Interface `MappingIcuCollationProperty` +# `MappingIcuCollationProperty` [interface-MappingIcuCollationProperty] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MappingIndexField.md b/docs/reference/api/MappingIndexField.md index afeb02483..976be0fc0 100644 --- a/docs/reference/api/MappingIndexField.md +++ b/docs/reference/api/MappingIndexField.md @@ -1,4 +1,4 @@ -## Interface `MappingIndexField` +# `MappingIndexField` [interface-MappingIndexField] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MappingIndexOptions.md b/docs/reference/api/MappingIndexOptions.md index f9995468f..064f949e9 100644 --- a/docs/reference/api/MappingIndexOptions.md +++ b/docs/reference/api/MappingIndexOptions.md @@ -1,4 +1,4 @@ -## `MappingIndexOptions` -::: +# `MappingIndexOptions` [alias-MappingIndexOptions] +```typescript type MappingIndexOptions = 'docs' | 'freqs' | 'positions' | 'offsets'; -::: +``` diff --git a/docs/reference/api/MappingIntegerNumberProperty.md b/docs/reference/api/MappingIntegerNumberProperty.md index af421dcc9..25564de72 100644 --- a/docs/reference/api/MappingIntegerNumberProperty.md +++ b/docs/reference/api/MappingIntegerNumberProperty.md @@ -1,4 +1,4 @@ -## Interface `MappingIntegerNumberProperty` +# `MappingIntegerNumberProperty` [interface-MappingIntegerNumberProperty] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MappingIntegerRangeProperty.md b/docs/reference/api/MappingIntegerRangeProperty.md index ddf78774d..2def56b84 100644 --- a/docs/reference/api/MappingIntegerRangeProperty.md +++ b/docs/reference/api/MappingIntegerRangeProperty.md @@ -1,4 +1,4 @@ -## Interface `MappingIntegerRangeProperty` +# `MappingIntegerRangeProperty` [interface-MappingIntegerRangeProperty] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MappingIpProperty.md b/docs/reference/api/MappingIpProperty.md index e1f578d6b..fb429921a 100644 --- a/docs/reference/api/MappingIpProperty.md +++ b/docs/reference/api/MappingIpProperty.md @@ -1,4 +1,4 @@ -## Interface `MappingIpProperty` +# `MappingIpProperty` [interface-MappingIpProperty] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MappingIpRangeProperty.md b/docs/reference/api/MappingIpRangeProperty.md index 7b4447681..ac97a9b03 100644 --- a/docs/reference/api/MappingIpRangeProperty.md +++ b/docs/reference/api/MappingIpRangeProperty.md @@ -1,4 +1,4 @@ -## Interface `MappingIpRangeProperty` +# `MappingIpRangeProperty` [interface-MappingIpRangeProperty] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MappingJoinProperty.md b/docs/reference/api/MappingJoinProperty.md index f12cc9cab..ac1b9f280 100644 --- a/docs/reference/api/MappingJoinProperty.md +++ b/docs/reference/api/MappingJoinProperty.md @@ -1,4 +1,4 @@ -## Interface `MappingJoinProperty` +# `MappingJoinProperty` [interface-MappingJoinProperty] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MappingKeywordProperty.md b/docs/reference/api/MappingKeywordProperty.md index 197e415c0..ff02bd2ab 100644 --- a/docs/reference/api/MappingKeywordProperty.md +++ b/docs/reference/api/MappingKeywordProperty.md @@ -1,4 +1,4 @@ -## Interface `MappingKeywordProperty` +# `MappingKeywordProperty` [interface-MappingKeywordProperty] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MappingLongNumberProperty.md b/docs/reference/api/MappingLongNumberProperty.md index 1f8e1b658..baaa6f578 100644 --- a/docs/reference/api/MappingLongNumberProperty.md +++ b/docs/reference/api/MappingLongNumberProperty.md @@ -1,4 +1,4 @@ -## Interface `MappingLongNumberProperty` +# `MappingLongNumberProperty` [interface-MappingLongNumberProperty] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MappingLongRangeProperty.md b/docs/reference/api/MappingLongRangeProperty.md index 33ee6b802..c3940f3ee 100644 --- a/docs/reference/api/MappingLongRangeProperty.md +++ b/docs/reference/api/MappingLongRangeProperty.md @@ -1,4 +1,4 @@ -## Interface `MappingLongRangeProperty` +# `MappingLongRangeProperty` [interface-MappingLongRangeProperty] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MappingMatchOnlyTextProperty.md b/docs/reference/api/MappingMatchOnlyTextProperty.md index 3a80fff69..63aac735e 100644 --- a/docs/reference/api/MappingMatchOnlyTextProperty.md +++ b/docs/reference/api/MappingMatchOnlyTextProperty.md @@ -1,4 +1,4 @@ -## Interface `MappingMatchOnlyTextProperty` +# `MappingMatchOnlyTextProperty` [interface-MappingMatchOnlyTextProperty] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MappingMatchType.md b/docs/reference/api/MappingMatchType.md index 9d139287e..c90d1b058 100644 --- a/docs/reference/api/MappingMatchType.md +++ b/docs/reference/api/MappingMatchType.md @@ -1,4 +1,4 @@ -## `MappingMatchType` -::: +# `MappingMatchType` [alias-MappingMatchType] +```typescript type MappingMatchType = 'simple' | 'regex'; -::: +``` diff --git a/docs/reference/api/MappingMurmur3HashProperty.md b/docs/reference/api/MappingMurmur3HashProperty.md index 408a82bde..241e9c882 100644 --- a/docs/reference/api/MappingMurmur3HashProperty.md +++ b/docs/reference/api/MappingMurmur3HashProperty.md @@ -1,4 +1,4 @@ -## Interface `MappingMurmur3HashProperty` +# `MappingMurmur3HashProperty` [interface-MappingMurmur3HashProperty] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MappingNestedProperty.md b/docs/reference/api/MappingNestedProperty.md index d9f7a05e3..9ffa0808e 100644 --- a/docs/reference/api/MappingNestedProperty.md +++ b/docs/reference/api/MappingNestedProperty.md @@ -1,4 +1,4 @@ -## Interface `MappingNestedProperty` +# `MappingNestedProperty` [interface-MappingNestedProperty] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MappingNumberPropertyBase.md b/docs/reference/api/MappingNumberPropertyBase.md index 1d826a501..34f9acb6e 100644 --- a/docs/reference/api/MappingNumberPropertyBase.md +++ b/docs/reference/api/MappingNumberPropertyBase.md @@ -1,4 +1,4 @@ -## Interface `MappingNumberPropertyBase` +# `MappingNumberPropertyBase` [interface-MappingNumberPropertyBase] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MappingObjectProperty.md b/docs/reference/api/MappingObjectProperty.md index c31bc911f..a8d092492 100644 --- a/docs/reference/api/MappingObjectProperty.md +++ b/docs/reference/api/MappingObjectProperty.md @@ -1,4 +1,4 @@ -## Interface `MappingObjectProperty` +# `MappingObjectProperty` [interface-MappingObjectProperty] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MappingOnScriptError.md b/docs/reference/api/MappingOnScriptError.md index a548430a1..a6a92b9c5 100644 --- a/docs/reference/api/MappingOnScriptError.md +++ b/docs/reference/api/MappingOnScriptError.md @@ -1,4 +1,4 @@ -## `MappingOnScriptError` -::: +# `MappingOnScriptError` [alias-MappingOnScriptError] +```typescript type MappingOnScriptError = 'fail' | 'continue'; -::: +``` diff --git a/docs/reference/api/MappingPassthroughObjectProperty.md b/docs/reference/api/MappingPassthroughObjectProperty.md index b8c313e0a..6d76b633a 100644 --- a/docs/reference/api/MappingPassthroughObjectProperty.md +++ b/docs/reference/api/MappingPassthroughObjectProperty.md @@ -1,4 +1,4 @@ -## Interface `MappingPassthroughObjectProperty` +# `MappingPassthroughObjectProperty` [interface-MappingPassthroughObjectProperty] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MappingPercolatorProperty.md b/docs/reference/api/MappingPercolatorProperty.md index dc2a426a9..b30506e94 100644 --- a/docs/reference/api/MappingPercolatorProperty.md +++ b/docs/reference/api/MappingPercolatorProperty.md @@ -1,4 +1,4 @@ -## Interface `MappingPercolatorProperty` +# `MappingPercolatorProperty` [interface-MappingPercolatorProperty] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MappingPointProperty.md b/docs/reference/api/MappingPointProperty.md index cfece523c..c867347ef 100644 --- a/docs/reference/api/MappingPointProperty.md +++ b/docs/reference/api/MappingPointProperty.md @@ -1,4 +1,4 @@ -## Interface `MappingPointProperty` +# `MappingPointProperty` [interface-MappingPointProperty] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MappingProperty.md b/docs/reference/api/MappingProperty.md index 1193df07a..2d93767de 100644 --- a/docs/reference/api/MappingProperty.md +++ b/docs/reference/api/MappingProperty.md @@ -1,4 +1,4 @@ -## `MappingProperty` -::: +# `MappingProperty` [alias-MappingProperty] +```typescript type MappingProperty = [MappingBinaryProperty](./MappingBinaryProperty.md) | [MappingBooleanProperty](./MappingBooleanProperty.md) | [MappingDynamicProperty](./MappingDynamicProperty.md) | [MappingJoinProperty](./MappingJoinProperty.md) | [MappingKeywordProperty](./MappingKeywordProperty.md) | [MappingMatchOnlyTextProperty](./MappingMatchOnlyTextProperty.md) | [MappingPercolatorProperty](./MappingPercolatorProperty.md) | [MappingRankFeatureProperty](./MappingRankFeatureProperty.md) | [MappingRankFeaturesProperty](./MappingRankFeaturesProperty.md) | [MappingSearchAsYouTypeProperty](./MappingSearchAsYouTypeProperty.md) | [MappingTextProperty](./MappingTextProperty.md) | [MappingVersionProperty](./MappingVersionProperty.md) | [MappingWildcardProperty](./MappingWildcardProperty.md) | [MappingDateNanosProperty](./MappingDateNanosProperty.md) | [MappingDateProperty](./MappingDateProperty.md) | [MappingAggregateMetricDoubleProperty](./MappingAggregateMetricDoubleProperty.md) | [MappingDenseVectorProperty](./MappingDenseVectorProperty.md) | [MappingFlattenedProperty](./MappingFlattenedProperty.md) | [MappingNestedProperty](./MappingNestedProperty.md) | [MappingObjectProperty](./MappingObjectProperty.md) | [MappingPassthroughObjectProperty](./MappingPassthroughObjectProperty.md) | [MappingSemanticTextProperty](./MappingSemanticTextProperty.md) | [MappingSparseVectorProperty](./MappingSparseVectorProperty.md) | [MappingCompletionProperty](./MappingCompletionProperty.md) | [MappingConstantKeywordProperty](./MappingConstantKeywordProperty.md) | [MappingCountedKeywordProperty](./MappingCountedKeywordProperty.md) | [MappingFieldAliasProperty](./MappingFieldAliasProperty.md) | [MappingHistogramProperty](./MappingHistogramProperty.md) | [MappingIpProperty](./MappingIpProperty.md) | [MappingMurmur3HashProperty](./MappingMurmur3HashProperty.md) | [MappingTokenCountProperty](./MappingTokenCountProperty.md) | [MappingGeoPointProperty](./MappingGeoPointProperty.md) | [MappingGeoShapeProperty](./MappingGeoShapeProperty.md) | [MappingPointProperty](./MappingPointProperty.md) | [MappingShapeProperty](./MappingShapeProperty.md) | [MappingByteNumberProperty](./MappingByteNumberProperty.md) | [MappingDoubleNumberProperty](./MappingDoubleNumberProperty.md) | [MappingFloatNumberProperty](./MappingFloatNumberProperty.md) | [MappingHalfFloatNumberProperty](./MappingHalfFloatNumberProperty.md) | [MappingIntegerNumberProperty](./MappingIntegerNumberProperty.md) | [MappingLongNumberProperty](./MappingLongNumberProperty.md) | [MappingScaledFloatNumberProperty](./MappingScaledFloatNumberProperty.md) | [MappingShortNumberProperty](./MappingShortNumberProperty.md) | [MappingUnsignedLongNumberProperty](./MappingUnsignedLongNumberProperty.md) | [MappingDateRangeProperty](./MappingDateRangeProperty.md) | [MappingDoubleRangeProperty](./MappingDoubleRangeProperty.md) | [MappingFloatRangeProperty](./MappingFloatRangeProperty.md) | [MappingIntegerRangeProperty](./MappingIntegerRangeProperty.md) | [MappingIpRangeProperty](./MappingIpRangeProperty.md) | [MappingLongRangeProperty](./MappingLongRangeProperty.md) | [MappingIcuCollationProperty](./MappingIcuCollationProperty.md); -::: +``` diff --git a/docs/reference/api/MappingPropertyBase.md b/docs/reference/api/MappingPropertyBase.md index b12741054..eb1333917 100644 --- a/docs/reference/api/MappingPropertyBase.md +++ b/docs/reference/api/MappingPropertyBase.md @@ -1,4 +1,4 @@ -## Interface `MappingPropertyBase` +# `MappingPropertyBase` [interface-MappingPropertyBase] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MappingRangePropertyBase.md b/docs/reference/api/MappingRangePropertyBase.md index 5635dabc8..01b455414 100644 --- a/docs/reference/api/MappingRangePropertyBase.md +++ b/docs/reference/api/MappingRangePropertyBase.md @@ -1,4 +1,4 @@ -## Interface `MappingRangePropertyBase` +# `MappingRangePropertyBase` [interface-MappingRangePropertyBase] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MappingRankFeatureProperty.md b/docs/reference/api/MappingRankFeatureProperty.md index bd2876073..86da1053c 100644 --- a/docs/reference/api/MappingRankFeatureProperty.md +++ b/docs/reference/api/MappingRankFeatureProperty.md @@ -1,4 +1,4 @@ -## Interface `MappingRankFeatureProperty` +# `MappingRankFeatureProperty` [interface-MappingRankFeatureProperty] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MappingRankFeaturesProperty.md b/docs/reference/api/MappingRankFeaturesProperty.md index 4515ec672..0e6944fc1 100644 --- a/docs/reference/api/MappingRankFeaturesProperty.md +++ b/docs/reference/api/MappingRankFeaturesProperty.md @@ -1,4 +1,4 @@ -## Interface `MappingRankFeaturesProperty` +# `MappingRankFeaturesProperty` [interface-MappingRankFeaturesProperty] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MappingRoutingField.md b/docs/reference/api/MappingRoutingField.md index 376479854..448a98503 100644 --- a/docs/reference/api/MappingRoutingField.md +++ b/docs/reference/api/MappingRoutingField.md @@ -1,4 +1,4 @@ -## Interface `MappingRoutingField` +# `MappingRoutingField` [interface-MappingRoutingField] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MappingRuntimeField.md b/docs/reference/api/MappingRuntimeField.md index 0ac004b2b..2859f144e 100644 --- a/docs/reference/api/MappingRuntimeField.md +++ b/docs/reference/api/MappingRuntimeField.md @@ -1,4 +1,4 @@ -## Interface `MappingRuntimeField` +# `MappingRuntimeField` [interface-MappingRuntimeField] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MappingRuntimeFieldFetchFields.md b/docs/reference/api/MappingRuntimeFieldFetchFields.md index 511e17556..2188b8dcb 100644 --- a/docs/reference/api/MappingRuntimeFieldFetchFields.md +++ b/docs/reference/api/MappingRuntimeFieldFetchFields.md @@ -1,4 +1,4 @@ -## Interface `MappingRuntimeFieldFetchFields` +# `MappingRuntimeFieldFetchFields` [interface-MappingRuntimeFieldFetchFields] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MappingRuntimeFieldType.md b/docs/reference/api/MappingRuntimeFieldType.md index 80aa48948..32d7d5ae1 100644 --- a/docs/reference/api/MappingRuntimeFieldType.md +++ b/docs/reference/api/MappingRuntimeFieldType.md @@ -1,4 +1,4 @@ -## `MappingRuntimeFieldType` -::: +# `MappingRuntimeFieldType` [alias-MappingRuntimeFieldType] +```typescript type MappingRuntimeFieldType = 'boolean' | 'composite' | 'date' | 'double' | 'geo_point' | 'geo_shape' | 'ip' | 'keyword' | 'long' | 'lookup'; -::: +``` diff --git a/docs/reference/api/MappingRuntimeFields.md b/docs/reference/api/MappingRuntimeFields.md index feb91814c..d56b3b811 100644 --- a/docs/reference/api/MappingRuntimeFields.md +++ b/docs/reference/api/MappingRuntimeFields.md @@ -1,4 +1,4 @@ -## `MappingRuntimeFields` -::: +# `MappingRuntimeFields` [alias-MappingRuntimeFields] +```typescript type MappingRuntimeFields = Record<[Field](./Field.md), [MappingRuntimeField](./MappingRuntimeField.md)>; -::: +``` diff --git a/docs/reference/api/MappingScaledFloatNumberProperty.md b/docs/reference/api/MappingScaledFloatNumberProperty.md index 9c343ba96..29b980b89 100644 --- a/docs/reference/api/MappingScaledFloatNumberProperty.md +++ b/docs/reference/api/MappingScaledFloatNumberProperty.md @@ -1,4 +1,4 @@ -## Interface `MappingScaledFloatNumberProperty` +# `MappingScaledFloatNumberProperty` [interface-MappingScaledFloatNumberProperty] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MappingSearchAsYouTypeProperty.md b/docs/reference/api/MappingSearchAsYouTypeProperty.md index 57d3ecba5..d65e971ab 100644 --- a/docs/reference/api/MappingSearchAsYouTypeProperty.md +++ b/docs/reference/api/MappingSearchAsYouTypeProperty.md @@ -1,4 +1,4 @@ -## Interface `MappingSearchAsYouTypeProperty` +# `MappingSearchAsYouTypeProperty` [interface-MappingSearchAsYouTypeProperty] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MappingSemanticTextProperty.md b/docs/reference/api/MappingSemanticTextProperty.md index e35bace32..2c78e2785 100644 --- a/docs/reference/api/MappingSemanticTextProperty.md +++ b/docs/reference/api/MappingSemanticTextProperty.md @@ -1,4 +1,4 @@ -## Interface `MappingSemanticTextProperty` +# `MappingSemanticTextProperty` [interface-MappingSemanticTextProperty] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MappingShapeProperty.md b/docs/reference/api/MappingShapeProperty.md index d98a711f6..e994bd2de 100644 --- a/docs/reference/api/MappingShapeProperty.md +++ b/docs/reference/api/MappingShapeProperty.md @@ -1,4 +1,4 @@ -## Interface `MappingShapeProperty` +# `MappingShapeProperty` [interface-MappingShapeProperty] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MappingShortNumberProperty.md b/docs/reference/api/MappingShortNumberProperty.md index aee2e1f5b..7153d41ef 100644 --- a/docs/reference/api/MappingShortNumberProperty.md +++ b/docs/reference/api/MappingShortNumberProperty.md @@ -1,4 +1,4 @@ -## Interface `MappingShortNumberProperty` +# `MappingShortNumberProperty` [interface-MappingShortNumberProperty] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MappingSizeField.md b/docs/reference/api/MappingSizeField.md index b367e66d7..73d493327 100644 --- a/docs/reference/api/MappingSizeField.md +++ b/docs/reference/api/MappingSizeField.md @@ -1,4 +1,4 @@ -## Interface `MappingSizeField` +# `MappingSizeField` [interface-MappingSizeField] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MappingSourceField.md b/docs/reference/api/MappingSourceField.md index cf15cb18f..f186f44b5 100644 --- a/docs/reference/api/MappingSourceField.md +++ b/docs/reference/api/MappingSourceField.md @@ -1,4 +1,4 @@ -## Interface `MappingSourceField` +# `MappingSourceField` [interface-MappingSourceField] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MappingSourceFieldMode.md b/docs/reference/api/MappingSourceFieldMode.md index 46672025b..2d4a9b9c5 100644 --- a/docs/reference/api/MappingSourceFieldMode.md +++ b/docs/reference/api/MappingSourceFieldMode.md @@ -1,4 +1,4 @@ -## `MappingSourceFieldMode` -::: +# `MappingSourceFieldMode` [alias-MappingSourceFieldMode] +```typescript type MappingSourceFieldMode = 'disabled' | 'stored' | 'synthetic'; -::: +``` diff --git a/docs/reference/api/MappingSparseVectorProperty.md b/docs/reference/api/MappingSparseVectorProperty.md index a43c4b74d..a67323396 100644 --- a/docs/reference/api/MappingSparseVectorProperty.md +++ b/docs/reference/api/MappingSparseVectorProperty.md @@ -1,4 +1,4 @@ -## Interface `MappingSparseVectorProperty` +# `MappingSparseVectorProperty` [interface-MappingSparseVectorProperty] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MappingSubobjects.md b/docs/reference/api/MappingSubobjects.md index 6baaaf429..cecc4bcf8 100644 --- a/docs/reference/api/MappingSubobjects.md +++ b/docs/reference/api/MappingSubobjects.md @@ -1,4 +1,4 @@ -## `MappingSubobjects` -::: +# `MappingSubobjects` [alias-MappingSubobjects] +```typescript type MappingSubobjects = boolean | 'true' | 'false' | 'auto'; -::: +``` diff --git a/docs/reference/api/MappingSuggestContext.md b/docs/reference/api/MappingSuggestContext.md index 9fb649031..36c7ce05c 100644 --- a/docs/reference/api/MappingSuggestContext.md +++ b/docs/reference/api/MappingSuggestContext.md @@ -1,4 +1,4 @@ -## Interface `MappingSuggestContext` +# `MappingSuggestContext` [interface-MappingSuggestContext] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MappingSyntheticSourceKeepEnum.md b/docs/reference/api/MappingSyntheticSourceKeepEnum.md index aae989ec0..ccba0d737 100644 --- a/docs/reference/api/MappingSyntheticSourceKeepEnum.md +++ b/docs/reference/api/MappingSyntheticSourceKeepEnum.md @@ -1,4 +1,4 @@ -## `MappingSyntheticSourceKeepEnum` -::: +# `MappingSyntheticSourceKeepEnum` [alias-MappingSyntheticSourceKeepEnum] +```typescript type MappingSyntheticSourceKeepEnum = 'none' | 'arrays' | 'all'; -::: +``` diff --git a/docs/reference/api/MappingTermVectorOption.md b/docs/reference/api/MappingTermVectorOption.md index ca5c24e84..2cc3b331f 100644 --- a/docs/reference/api/MappingTermVectorOption.md +++ b/docs/reference/api/MappingTermVectorOption.md @@ -1,4 +1,4 @@ -## `MappingTermVectorOption` -::: +# `MappingTermVectorOption` [alias-MappingTermVectorOption] +```typescript type MappingTermVectorOption = 'no' | 'yes' | 'with_offsets' | 'with_positions' | 'with_positions_offsets' | 'with_positions_offsets_payloads' | 'with_positions_payloads'; -::: +``` diff --git a/docs/reference/api/MappingTextIndexPrefixes.md b/docs/reference/api/MappingTextIndexPrefixes.md index 4a14be607..1f1ddb667 100644 --- a/docs/reference/api/MappingTextIndexPrefixes.md +++ b/docs/reference/api/MappingTextIndexPrefixes.md @@ -1,4 +1,4 @@ -## Interface `MappingTextIndexPrefixes` +# `MappingTextIndexPrefixes` [interface-MappingTextIndexPrefixes] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MappingTextProperty.md b/docs/reference/api/MappingTextProperty.md index eae39cccf..93454b578 100644 --- a/docs/reference/api/MappingTextProperty.md +++ b/docs/reference/api/MappingTextProperty.md @@ -1,4 +1,4 @@ -## Interface `MappingTextProperty` +# `MappingTextProperty` [interface-MappingTextProperty] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MappingTimeSeriesMetricType.md b/docs/reference/api/MappingTimeSeriesMetricType.md index 0e93c03c4..0278c8b87 100644 --- a/docs/reference/api/MappingTimeSeriesMetricType.md +++ b/docs/reference/api/MappingTimeSeriesMetricType.md @@ -1,4 +1,4 @@ -## `MappingTimeSeriesMetricType` -::: +# `MappingTimeSeriesMetricType` [alias-MappingTimeSeriesMetricType] +```typescript type MappingTimeSeriesMetricType = 'gauge' | 'counter' | 'summary' | 'histogram' | 'position'; -::: +``` diff --git a/docs/reference/api/MappingTokenCountProperty.md b/docs/reference/api/MappingTokenCountProperty.md index b2f6f1baa..96821f7cb 100644 --- a/docs/reference/api/MappingTokenCountProperty.md +++ b/docs/reference/api/MappingTokenCountProperty.md @@ -1,4 +1,4 @@ -## Interface `MappingTokenCountProperty` +# `MappingTokenCountProperty` [interface-MappingTokenCountProperty] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MappingTypeMapping.md b/docs/reference/api/MappingTypeMapping.md index 7a3b01c66..6a6b0ae2c 100644 --- a/docs/reference/api/MappingTypeMapping.md +++ b/docs/reference/api/MappingTypeMapping.md @@ -1,4 +1,4 @@ -## Interface `MappingTypeMapping` +# `MappingTypeMapping` [interface-MappingTypeMapping] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MappingUnsignedLongNumberProperty.md b/docs/reference/api/MappingUnsignedLongNumberProperty.md index 7f85e0ec5..152d2479f 100644 --- a/docs/reference/api/MappingUnsignedLongNumberProperty.md +++ b/docs/reference/api/MappingUnsignedLongNumberProperty.md @@ -1,4 +1,4 @@ -## Interface `MappingUnsignedLongNumberProperty` +# `MappingUnsignedLongNumberProperty` [interface-MappingUnsignedLongNumberProperty] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MappingVersionProperty.md b/docs/reference/api/MappingVersionProperty.md index 0b90dbb7c..34678fd83 100644 --- a/docs/reference/api/MappingVersionProperty.md +++ b/docs/reference/api/MappingVersionProperty.md @@ -1,4 +1,4 @@ -## Interface `MappingVersionProperty` +# `MappingVersionProperty` [interface-MappingVersionProperty] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MappingWildcardProperty.md b/docs/reference/api/MappingWildcardProperty.md index 382cfc067..b31f329b2 100644 --- a/docs/reference/api/MappingWildcardProperty.md +++ b/docs/reference/api/MappingWildcardProperty.md @@ -1,4 +1,4 @@ -## Interface `MappingWildcardProperty` +# `MappingWildcardProperty` [interface-MappingWildcardProperty] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MergesStats.md b/docs/reference/api/MergesStats.md index 43e24ded4..d331c0287 100644 --- a/docs/reference/api/MergesStats.md +++ b/docs/reference/api/MergesStats.md @@ -1,4 +1,4 @@ -## Interface `MergesStats` +# `MergesStats` [interface-MergesStats] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/Metadata.md b/docs/reference/api/Metadata.md index 6906100c7..61e453a61 100644 --- a/docs/reference/api/Metadata.md +++ b/docs/reference/api/Metadata.md @@ -1,4 +1,4 @@ -## `Metadata` -::: +# `Metadata` [alias-Metadata] +```typescript type Metadata = Record; -::: +``` diff --git a/docs/reference/api/Metrics.md b/docs/reference/api/Metrics.md index 6a941c7c1..39b1938c5 100644 --- a/docs/reference/api/Metrics.md +++ b/docs/reference/api/Metrics.md @@ -1,4 +1,4 @@ -## `Metrics` -::: +# `Metrics` [alias-Metrics] +```typescript type Metrics = string | string[]; -::: +``` diff --git a/docs/reference/api/MgetApi_1.md b/docs/reference/api/MgetApi_1.md index 4ae359648..509012937 100644 --- a/docs/reference/api/MgetApi_1.md +++ b/docs/reference/api/MgetApi_1.md @@ -1,3 +1,3 @@ -::: +```typescript default function MgetApi(this: [That](./That.md), params?: [MgetRequest](./MgetRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MgetResponse](./MgetResponse.md)>; -::: +``` diff --git a/docs/reference/api/MgetApi_2.md b/docs/reference/api/MgetApi_2.md index 55074e15b..fd94b328c 100644 --- a/docs/reference/api/MgetApi_2.md +++ b/docs/reference/api/MgetApi_2.md @@ -1,3 +1,3 @@ -::: +```typescript default function MgetApi(this: [That](./That.md), params?: [MgetRequest](./MgetRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MgetResponse](./MgetResponse.md), unknown>>; -::: +``` diff --git a/docs/reference/api/MgetApi_3.md b/docs/reference/api/MgetApi_3.md index e337f5cac..e7e534677 100644 --- a/docs/reference/api/MgetApi_3.md +++ b/docs/reference/api/MgetApi_3.md @@ -1,3 +1,3 @@ -::: +```typescript default function MgetApi(this: [That](./That.md), params?: [MgetRequest](./MgetRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MgetResponse](./MgetResponse.md)>; -::: +``` diff --git a/docs/reference/api/MgetMultiGetError.md b/docs/reference/api/MgetMultiGetError.md index 8b1f32b0e..4252c20fe 100644 --- a/docs/reference/api/MgetMultiGetError.md +++ b/docs/reference/api/MgetMultiGetError.md @@ -1,4 +1,4 @@ -## Interface `MgetMultiGetError` +# `MgetMultiGetError` [interface-MgetMultiGetError] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MgetOperation.md b/docs/reference/api/MgetOperation.md index d50c52112..3803fa34a 100644 --- a/docs/reference/api/MgetOperation.md +++ b/docs/reference/api/MgetOperation.md @@ -1,4 +1,4 @@ -## Interface `MgetOperation` +# `MgetOperation` [interface-MgetOperation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MgetRequest.md b/docs/reference/api/MgetRequest.md index b3acc9edc..8ac5482bf 100644 --- a/docs/reference/api/MgetRequest.md +++ b/docs/reference/api/MgetRequest.md @@ -1,4 +1,4 @@ -## Interface `MgetRequest` +# `MgetRequest` [interface-MgetRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MgetResponse.md b/docs/reference/api/MgetResponse.md index db11ce46f..d48bdc360 100644 --- a/docs/reference/api/MgetResponse.md +++ b/docs/reference/api/MgetResponse.md @@ -1,4 +1,4 @@ -## Interface `MgetResponse` +# `MgetResponse` [interface-MgetResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MgetResponseItem.md b/docs/reference/api/MgetResponseItem.md index ee2173e8b..723d738c0 100644 --- a/docs/reference/api/MgetResponseItem.md +++ b/docs/reference/api/MgetResponseItem.md @@ -1,4 +1,4 @@ -## `MgetResponseItem` -::: +# `MgetResponseItem` [alias-MgetResponseItem] +```typescript type MgetResponseItem = [GetGetResult](./GetGetResult.md) | [MgetMultiGetError](./MgetMultiGetError.md); -::: +``` diff --git a/docs/reference/api/Migration.md b/docs/reference/api/Migration.md index 0e16368a8..2f3d0192b 100644 --- a/docs/reference/api/Migration.md +++ b/docs/reference/api/Migration.md @@ -1,19 +1,19 @@ -## `Migration` +# `Migration` [class-Migration] -### Constructor +## Constructor -::: +```typescript new Migration(transport: [Transport](./Transport.md)); -::: +``` -### Properties +## Properties [class-properties-Migration] | Name | Type | Description | | - | - | - | | `acceptedParams` | Record |   | | `transport` | [Transport](./Transport.md) |   | -### Methods +## Methods [class-methods-Migration] | Name | Signature | Description | | - | - | - | diff --git a/docs/reference/api/MigrationDeprecationsDeprecation.md b/docs/reference/api/MigrationDeprecationsDeprecation.md index 2b0481f17..f4e054078 100644 --- a/docs/reference/api/MigrationDeprecationsDeprecation.md +++ b/docs/reference/api/MigrationDeprecationsDeprecation.md @@ -1,4 +1,4 @@ -## Interface `MigrationDeprecationsDeprecation` +# `MigrationDeprecationsDeprecation` [interface-MigrationDeprecationsDeprecation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MigrationDeprecationsDeprecationLevel.md b/docs/reference/api/MigrationDeprecationsDeprecationLevel.md index 4add57682..6f285a294 100644 --- a/docs/reference/api/MigrationDeprecationsDeprecationLevel.md +++ b/docs/reference/api/MigrationDeprecationsDeprecationLevel.md @@ -1,4 +1,4 @@ -## `MigrationDeprecationsDeprecationLevel` -::: +# `MigrationDeprecationsDeprecationLevel` [alias-MigrationDeprecationsDeprecationLevel] +```typescript type MigrationDeprecationsDeprecationLevel = 'none' | 'info' | 'warning' | 'critical'; -::: +``` diff --git a/docs/reference/api/MigrationDeprecationsRequest.md b/docs/reference/api/MigrationDeprecationsRequest.md index 54f29b10a..d0a071fa2 100644 --- a/docs/reference/api/MigrationDeprecationsRequest.md +++ b/docs/reference/api/MigrationDeprecationsRequest.md @@ -1,4 +1,4 @@ -## Interface `MigrationDeprecationsRequest` +# `MigrationDeprecationsRequest` [interface-MigrationDeprecationsRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MigrationDeprecationsResponse.md b/docs/reference/api/MigrationDeprecationsResponse.md index 5ce77c00e..0a96c9084 100644 --- a/docs/reference/api/MigrationDeprecationsResponse.md +++ b/docs/reference/api/MigrationDeprecationsResponse.md @@ -1,4 +1,4 @@ -## Interface `MigrationDeprecationsResponse` +# `MigrationDeprecationsResponse` [interface-MigrationDeprecationsResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MigrationGetFeatureUpgradeStatusMigrationFeature.md b/docs/reference/api/MigrationGetFeatureUpgradeStatusMigrationFeature.md index 27d47a560..a5d7f8171 100644 --- a/docs/reference/api/MigrationGetFeatureUpgradeStatusMigrationFeature.md +++ b/docs/reference/api/MigrationGetFeatureUpgradeStatusMigrationFeature.md @@ -1,4 +1,4 @@ -## Interface `MigrationGetFeatureUpgradeStatusMigrationFeature` +# `MigrationGetFeatureUpgradeStatusMigrationFeature` [interface-MigrationGetFeatureUpgradeStatusMigrationFeature] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MigrationGetFeatureUpgradeStatusMigrationFeatureIndexInfo.md b/docs/reference/api/MigrationGetFeatureUpgradeStatusMigrationFeatureIndexInfo.md index 514176ba9..7c94de844 100644 --- a/docs/reference/api/MigrationGetFeatureUpgradeStatusMigrationFeatureIndexInfo.md +++ b/docs/reference/api/MigrationGetFeatureUpgradeStatusMigrationFeatureIndexInfo.md @@ -1,4 +1,4 @@ -## Interface `MigrationGetFeatureUpgradeStatusMigrationFeatureIndexInfo` +# `MigrationGetFeatureUpgradeStatusMigrationFeatureIndexInfo` [interface-MigrationGetFeatureUpgradeStatusMigrationFeatureIndexInfo] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MigrationGetFeatureUpgradeStatusMigrationStatus.md b/docs/reference/api/MigrationGetFeatureUpgradeStatusMigrationStatus.md index 0cf881c77..0ae781c17 100644 --- a/docs/reference/api/MigrationGetFeatureUpgradeStatusMigrationStatus.md +++ b/docs/reference/api/MigrationGetFeatureUpgradeStatusMigrationStatus.md @@ -1,4 +1,4 @@ -## `MigrationGetFeatureUpgradeStatusMigrationStatus` -::: +# `MigrationGetFeatureUpgradeStatusMigrationStatus` [alias-MigrationGetFeatureUpgradeStatusMigrationStatus] +```typescript type MigrationGetFeatureUpgradeStatusMigrationStatus = 'NO_MIGRATION_NEEDED' | 'MIGRATION_NEEDED' | 'IN_PROGRESS' | 'ERROR'; -::: +``` diff --git a/docs/reference/api/MigrationGetFeatureUpgradeStatusRequest.md b/docs/reference/api/MigrationGetFeatureUpgradeStatusRequest.md index d756ccf67..1e34387a1 100644 --- a/docs/reference/api/MigrationGetFeatureUpgradeStatusRequest.md +++ b/docs/reference/api/MigrationGetFeatureUpgradeStatusRequest.md @@ -1,4 +1,4 @@ -## Interface `MigrationGetFeatureUpgradeStatusRequest` +# `MigrationGetFeatureUpgradeStatusRequest` [interface-MigrationGetFeatureUpgradeStatusRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MigrationGetFeatureUpgradeStatusResponse.md b/docs/reference/api/MigrationGetFeatureUpgradeStatusResponse.md index f35b3ca7b..b5a735ad1 100644 --- a/docs/reference/api/MigrationGetFeatureUpgradeStatusResponse.md +++ b/docs/reference/api/MigrationGetFeatureUpgradeStatusResponse.md @@ -1,4 +1,4 @@ -## Interface `MigrationGetFeatureUpgradeStatusResponse` +# `MigrationGetFeatureUpgradeStatusResponse` [interface-MigrationGetFeatureUpgradeStatusResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MigrationPostFeatureUpgradeMigrationFeature.md b/docs/reference/api/MigrationPostFeatureUpgradeMigrationFeature.md index ba45d9891..33a424eae 100644 --- a/docs/reference/api/MigrationPostFeatureUpgradeMigrationFeature.md +++ b/docs/reference/api/MigrationPostFeatureUpgradeMigrationFeature.md @@ -1,4 +1,4 @@ -## Interface `MigrationPostFeatureUpgradeMigrationFeature` +# `MigrationPostFeatureUpgradeMigrationFeature` [interface-MigrationPostFeatureUpgradeMigrationFeature] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MigrationPostFeatureUpgradeRequest.md b/docs/reference/api/MigrationPostFeatureUpgradeRequest.md index d9763851c..e2f16f586 100644 --- a/docs/reference/api/MigrationPostFeatureUpgradeRequest.md +++ b/docs/reference/api/MigrationPostFeatureUpgradeRequest.md @@ -1,4 +1,4 @@ -## Interface `MigrationPostFeatureUpgradeRequest` +# `MigrationPostFeatureUpgradeRequest` [interface-MigrationPostFeatureUpgradeRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MigrationPostFeatureUpgradeResponse.md b/docs/reference/api/MigrationPostFeatureUpgradeResponse.md index 96dea468c..63a52419f 100644 --- a/docs/reference/api/MigrationPostFeatureUpgradeResponse.md +++ b/docs/reference/api/MigrationPostFeatureUpgradeResponse.md @@ -1,4 +1,4 @@ -## Interface `MigrationPostFeatureUpgradeResponse` +# `MigrationPostFeatureUpgradeResponse` [interface-MigrationPostFeatureUpgradeResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MinimumShouldMatch.md b/docs/reference/api/MinimumShouldMatch.md index 55cc3519d..b4113e38a 100644 --- a/docs/reference/api/MinimumShouldMatch.md +++ b/docs/reference/api/MinimumShouldMatch.md @@ -1,4 +1,4 @@ -## `MinimumShouldMatch` -::: +# `MinimumShouldMatch` [alias-MinimumShouldMatch] +```typescript type MinimumShouldMatch = [integer](./integer.md) | string; -::: +``` diff --git a/docs/reference/api/Ml.md b/docs/reference/api/Ml.md index 438c5dd85..738028c9d 100644 --- a/docs/reference/api/Ml.md +++ b/docs/reference/api/Ml.md @@ -1,19 +1,19 @@ -## `Ml` +# `Ml` [class-Ml] -### Constructor +## Constructor -::: +```typescript new Ml(transport: [Transport](./Transport.md)); -::: +``` -### Properties +## Properties [class-properties-Ml] | Name | Type | Description | | - | - | - | | `acceptedParams` | Record |   | | `transport` | [Transport](./Transport.md) |   | -### Methods +## Methods [class-methods-Ml] | Name | Signature | Description | | - | - | - | diff --git a/docs/reference/api/MlAdaptiveAllocationsSettings.md b/docs/reference/api/MlAdaptiveAllocationsSettings.md index e035abc4d..afeb8b4f5 100644 --- a/docs/reference/api/MlAdaptiveAllocationsSettings.md +++ b/docs/reference/api/MlAdaptiveAllocationsSettings.md @@ -1,4 +1,4 @@ -## Interface `MlAdaptiveAllocationsSettings` +# `MlAdaptiveAllocationsSettings` [interface-MlAdaptiveAllocationsSettings] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlAnalysisConfig.md b/docs/reference/api/MlAnalysisConfig.md index 36f953b30..cb20664a1 100644 --- a/docs/reference/api/MlAnalysisConfig.md +++ b/docs/reference/api/MlAnalysisConfig.md @@ -1,4 +1,4 @@ -## Interface `MlAnalysisConfig` +# `MlAnalysisConfig` [interface-MlAnalysisConfig] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlAnalysisConfigRead.md b/docs/reference/api/MlAnalysisConfigRead.md index 473fff930..510c220ca 100644 --- a/docs/reference/api/MlAnalysisConfigRead.md +++ b/docs/reference/api/MlAnalysisConfigRead.md @@ -1,4 +1,4 @@ -## Interface `MlAnalysisConfigRead` +# `MlAnalysisConfigRead` [interface-MlAnalysisConfigRead] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlAnalysisLimits.md b/docs/reference/api/MlAnalysisLimits.md index f177fee24..2ef6714c9 100644 --- a/docs/reference/api/MlAnalysisLimits.md +++ b/docs/reference/api/MlAnalysisLimits.md @@ -1,4 +1,4 @@ -## Interface `MlAnalysisLimits` +# `MlAnalysisLimits` [interface-MlAnalysisLimits] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlAnalysisMemoryLimit.md b/docs/reference/api/MlAnalysisMemoryLimit.md index 17525576e..76c079397 100644 --- a/docs/reference/api/MlAnalysisMemoryLimit.md +++ b/docs/reference/api/MlAnalysisMemoryLimit.md @@ -1,4 +1,4 @@ -## Interface `MlAnalysisMemoryLimit` +# `MlAnalysisMemoryLimit` [interface-MlAnalysisMemoryLimit] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlAnomaly.md b/docs/reference/api/MlAnomaly.md index 4f3a86d2b..d2dbd4514 100644 --- a/docs/reference/api/MlAnomaly.md +++ b/docs/reference/api/MlAnomaly.md @@ -1,4 +1,4 @@ -## Interface `MlAnomaly` +# `MlAnomaly` [interface-MlAnomaly] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlAnomalyCause.md b/docs/reference/api/MlAnomalyCause.md index 9d833487c..9d6e97705 100644 --- a/docs/reference/api/MlAnomalyCause.md +++ b/docs/reference/api/MlAnomalyCause.md @@ -1,4 +1,4 @@ -## Interface `MlAnomalyCause` +# `MlAnomalyCause` [interface-MlAnomalyCause] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlAnomalyExplanation.md b/docs/reference/api/MlAnomalyExplanation.md index f923f995c..b3eeaf8f5 100644 --- a/docs/reference/api/MlAnomalyExplanation.md +++ b/docs/reference/api/MlAnomalyExplanation.md @@ -1,4 +1,4 @@ -## Interface `MlAnomalyExplanation` +# `MlAnomalyExplanation` [interface-MlAnomalyExplanation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlApiKeyAuthorization.md b/docs/reference/api/MlApiKeyAuthorization.md index 286c83ed9..231257d08 100644 --- a/docs/reference/api/MlApiKeyAuthorization.md +++ b/docs/reference/api/MlApiKeyAuthorization.md @@ -1,4 +1,4 @@ -## Interface `MlApiKeyAuthorization` +# `MlApiKeyAuthorization` [interface-MlApiKeyAuthorization] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlAppliesTo.md b/docs/reference/api/MlAppliesTo.md index ecc768c77..2b8a93ba7 100644 --- a/docs/reference/api/MlAppliesTo.md +++ b/docs/reference/api/MlAppliesTo.md @@ -1,4 +1,4 @@ -## `MlAppliesTo` -::: +# `MlAppliesTo` [alias-MlAppliesTo] +```typescript type MlAppliesTo = 'actual' | 'typical' | 'diff_from_typical' | 'time'; -::: +``` diff --git a/docs/reference/api/MlBucketInfluencer.md b/docs/reference/api/MlBucketInfluencer.md index cca4f404b..c2924dbc0 100644 --- a/docs/reference/api/MlBucketInfluencer.md +++ b/docs/reference/api/MlBucketInfluencer.md @@ -1,4 +1,4 @@ -## Interface `MlBucketInfluencer` +# `MlBucketInfluencer` [interface-MlBucketInfluencer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlBucketSummary.md b/docs/reference/api/MlBucketSummary.md index 5ea621a0f..9c7487ebb 100644 --- a/docs/reference/api/MlBucketSummary.md +++ b/docs/reference/api/MlBucketSummary.md @@ -1,4 +1,4 @@ -## Interface `MlBucketSummary` +# `MlBucketSummary` [interface-MlBucketSummary] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlCalendarEvent.md b/docs/reference/api/MlCalendarEvent.md index ea0d813b4..2646af188 100644 --- a/docs/reference/api/MlCalendarEvent.md +++ b/docs/reference/api/MlCalendarEvent.md @@ -1,4 +1,4 @@ -## Interface `MlCalendarEvent` +# `MlCalendarEvent` [interface-MlCalendarEvent] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlCategorizationAnalyzer.md b/docs/reference/api/MlCategorizationAnalyzer.md index 237aa342a..70cfa1631 100644 --- a/docs/reference/api/MlCategorizationAnalyzer.md +++ b/docs/reference/api/MlCategorizationAnalyzer.md @@ -1,4 +1,4 @@ -## `MlCategorizationAnalyzer` -::: +# `MlCategorizationAnalyzer` [alias-MlCategorizationAnalyzer] +```typescript type MlCategorizationAnalyzer = string | [MlCategorizationAnalyzerDefinition](./MlCategorizationAnalyzerDefinition.md); -::: +``` diff --git a/docs/reference/api/MlCategorizationAnalyzerDefinition.md b/docs/reference/api/MlCategorizationAnalyzerDefinition.md index c998b0f4b..ab52e7c60 100644 --- a/docs/reference/api/MlCategorizationAnalyzerDefinition.md +++ b/docs/reference/api/MlCategorizationAnalyzerDefinition.md @@ -1,4 +1,4 @@ -## Interface `MlCategorizationAnalyzerDefinition` +# `MlCategorizationAnalyzerDefinition` [interface-MlCategorizationAnalyzerDefinition] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlCategorizationStatus.md b/docs/reference/api/MlCategorizationStatus.md index 27688e673..f42c6872f 100644 --- a/docs/reference/api/MlCategorizationStatus.md +++ b/docs/reference/api/MlCategorizationStatus.md @@ -1,4 +1,4 @@ -## `MlCategorizationStatus` -::: +# `MlCategorizationStatus` [alias-MlCategorizationStatus] +```typescript type MlCategorizationStatus = 'ok' | 'warn'; -::: +``` diff --git a/docs/reference/api/MlCategory.md b/docs/reference/api/MlCategory.md index 0a85eb257..a0939d9e0 100644 --- a/docs/reference/api/MlCategory.md +++ b/docs/reference/api/MlCategory.md @@ -1,4 +1,4 @@ -## Interface `MlCategory` +# `MlCategory` [interface-MlCategory] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlChunkingConfig.md b/docs/reference/api/MlChunkingConfig.md index d0e156c3c..312a829bf 100644 --- a/docs/reference/api/MlChunkingConfig.md +++ b/docs/reference/api/MlChunkingConfig.md @@ -1,4 +1,4 @@ -## Interface `MlChunkingConfig` +# `MlChunkingConfig` [interface-MlChunkingConfig] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlChunkingMode.md b/docs/reference/api/MlChunkingMode.md index b116e4bb2..05680a209 100644 --- a/docs/reference/api/MlChunkingMode.md +++ b/docs/reference/api/MlChunkingMode.md @@ -1,4 +1,4 @@ -## `MlChunkingMode` -::: +# `MlChunkingMode` [alias-MlChunkingMode] +```typescript type MlChunkingMode = 'auto' | 'manual' | 'off'; -::: +``` diff --git a/docs/reference/api/MlClassificationInferenceOptions.md b/docs/reference/api/MlClassificationInferenceOptions.md index e2b7a5d45..446216565 100644 --- a/docs/reference/api/MlClassificationInferenceOptions.md +++ b/docs/reference/api/MlClassificationInferenceOptions.md @@ -1,4 +1,4 @@ -## Interface `MlClassificationInferenceOptions` +# `MlClassificationInferenceOptions` [interface-MlClassificationInferenceOptions] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlClearTrainedModelDeploymentCacheRequest.md b/docs/reference/api/MlClearTrainedModelDeploymentCacheRequest.md index a249fe5f6..0dc02bbe6 100644 --- a/docs/reference/api/MlClearTrainedModelDeploymentCacheRequest.md +++ b/docs/reference/api/MlClearTrainedModelDeploymentCacheRequest.md @@ -1,4 +1,4 @@ -## Interface `MlClearTrainedModelDeploymentCacheRequest` +# `MlClearTrainedModelDeploymentCacheRequest` [interface-MlClearTrainedModelDeploymentCacheRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlClearTrainedModelDeploymentCacheResponse.md b/docs/reference/api/MlClearTrainedModelDeploymentCacheResponse.md index dab1afb2f..9f8d0b290 100644 --- a/docs/reference/api/MlClearTrainedModelDeploymentCacheResponse.md +++ b/docs/reference/api/MlClearTrainedModelDeploymentCacheResponse.md @@ -1,4 +1,4 @@ -## Interface `MlClearTrainedModelDeploymentCacheResponse` +# `MlClearTrainedModelDeploymentCacheResponse` [interface-MlClearTrainedModelDeploymentCacheResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlCloseJobRequest.md b/docs/reference/api/MlCloseJobRequest.md index 12c251890..cedc48095 100644 --- a/docs/reference/api/MlCloseJobRequest.md +++ b/docs/reference/api/MlCloseJobRequest.md @@ -1,4 +1,4 @@ -## Interface `MlCloseJobRequest` +# `MlCloseJobRequest` [interface-MlCloseJobRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlCloseJobResponse.md b/docs/reference/api/MlCloseJobResponse.md index ab74ee195..040819e2b 100644 --- a/docs/reference/api/MlCloseJobResponse.md +++ b/docs/reference/api/MlCloseJobResponse.md @@ -1,4 +1,4 @@ -## Interface `MlCloseJobResponse` +# `MlCloseJobResponse` [interface-MlCloseJobResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlCommonTokenizationConfig.md b/docs/reference/api/MlCommonTokenizationConfig.md index 8097ec1ed..6f4d710df 100644 --- a/docs/reference/api/MlCommonTokenizationConfig.md +++ b/docs/reference/api/MlCommonTokenizationConfig.md @@ -1,4 +1,4 @@ -## Interface `MlCommonTokenizationConfig` +# `MlCommonTokenizationConfig` [interface-MlCommonTokenizationConfig] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlConditionOperator.md b/docs/reference/api/MlConditionOperator.md index 99dc39432..f02199a65 100644 --- a/docs/reference/api/MlConditionOperator.md +++ b/docs/reference/api/MlConditionOperator.md @@ -1,4 +1,4 @@ -## `MlConditionOperator` -::: +# `MlConditionOperator` [alias-MlConditionOperator] +```typescript type MlConditionOperator = 'gt' | 'gte' | 'lt' | 'lte'; -::: +``` diff --git a/docs/reference/api/MlCustomSettings.md b/docs/reference/api/MlCustomSettings.md index 6ada95792..1fd6a0eae 100644 --- a/docs/reference/api/MlCustomSettings.md +++ b/docs/reference/api/MlCustomSettings.md @@ -1,4 +1,4 @@ -## `MlCustomSettings` -::: +# `MlCustomSettings` [alias-MlCustomSettings] +```typescript type MlCustomSettings = any; -::: +``` diff --git a/docs/reference/api/MlDataCounts.md b/docs/reference/api/MlDataCounts.md index afbf7d396..e61eae7b5 100644 --- a/docs/reference/api/MlDataCounts.md +++ b/docs/reference/api/MlDataCounts.md @@ -1,4 +1,4 @@ -## Interface `MlDataCounts` +# `MlDataCounts` [interface-MlDataCounts] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlDataDescription.md b/docs/reference/api/MlDataDescription.md index b20a47baa..96aa86f54 100644 --- a/docs/reference/api/MlDataDescription.md +++ b/docs/reference/api/MlDataDescription.md @@ -1,4 +1,4 @@ -## Interface `MlDataDescription` +# `MlDataDescription` [interface-MlDataDescription] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlDatafeed.md b/docs/reference/api/MlDatafeed.md index 503d0daa4..731ee2252 100644 --- a/docs/reference/api/MlDatafeed.md +++ b/docs/reference/api/MlDatafeed.md @@ -1,4 +1,4 @@ -## Interface `MlDatafeed` +# `MlDatafeed` [interface-MlDatafeed] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlDatafeedAuthorization.md b/docs/reference/api/MlDatafeedAuthorization.md index 9914aecb6..dce7762b4 100644 --- a/docs/reference/api/MlDatafeedAuthorization.md +++ b/docs/reference/api/MlDatafeedAuthorization.md @@ -1,4 +1,4 @@ -## Interface `MlDatafeedAuthorization` +# `MlDatafeedAuthorization` [interface-MlDatafeedAuthorization] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlDatafeedConfig.md b/docs/reference/api/MlDatafeedConfig.md index c6de3e0ed..04062f5ee 100644 --- a/docs/reference/api/MlDatafeedConfig.md +++ b/docs/reference/api/MlDatafeedConfig.md @@ -1,4 +1,4 @@ -## Interface `MlDatafeedConfig` +# `MlDatafeedConfig` [interface-MlDatafeedConfig] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlDatafeedRunningState.md b/docs/reference/api/MlDatafeedRunningState.md index 977d674e4..2f9e80839 100644 --- a/docs/reference/api/MlDatafeedRunningState.md +++ b/docs/reference/api/MlDatafeedRunningState.md @@ -1,4 +1,4 @@ -## Interface `MlDatafeedRunningState` +# `MlDatafeedRunningState` [interface-MlDatafeedRunningState] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlDatafeedState.md b/docs/reference/api/MlDatafeedState.md index c71e31272..24fece3d9 100644 --- a/docs/reference/api/MlDatafeedState.md +++ b/docs/reference/api/MlDatafeedState.md @@ -1,4 +1,4 @@ -## `MlDatafeedState` -::: +# `MlDatafeedState` [alias-MlDatafeedState] +```typescript type MlDatafeedState = 'started' | 'stopped' | 'starting' | 'stopping'; -::: +``` diff --git a/docs/reference/api/MlDatafeedStats.md b/docs/reference/api/MlDatafeedStats.md index 8bc054018..977a04153 100644 --- a/docs/reference/api/MlDatafeedStats.md +++ b/docs/reference/api/MlDatafeedStats.md @@ -1,4 +1,4 @@ -## Interface `MlDatafeedStats` +# `MlDatafeedStats` [interface-MlDatafeedStats] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlDatafeedTimingStats.md b/docs/reference/api/MlDatafeedTimingStats.md index 27ae9da2b..65a2386a5 100644 --- a/docs/reference/api/MlDatafeedTimingStats.md +++ b/docs/reference/api/MlDatafeedTimingStats.md @@ -1,4 +1,4 @@ -## Interface `MlDatafeedTimingStats` +# `MlDatafeedTimingStats` [interface-MlDatafeedTimingStats] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlDataframeAnalysis.md b/docs/reference/api/MlDataframeAnalysis.md index 1c4147fc1..01b8dbc14 100644 --- a/docs/reference/api/MlDataframeAnalysis.md +++ b/docs/reference/api/MlDataframeAnalysis.md @@ -1,4 +1,4 @@ -## Interface `MlDataframeAnalysis` +# `MlDataframeAnalysis` [interface-MlDataframeAnalysis] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlDataframeAnalysisAnalyzedFields.md b/docs/reference/api/MlDataframeAnalysisAnalyzedFields.md index 250e15cbb..4b9368c81 100644 --- a/docs/reference/api/MlDataframeAnalysisAnalyzedFields.md +++ b/docs/reference/api/MlDataframeAnalysisAnalyzedFields.md @@ -1,4 +1,4 @@ -## Interface `MlDataframeAnalysisAnalyzedFields` +# `MlDataframeAnalysisAnalyzedFields` [interface-MlDataframeAnalysisAnalyzedFields] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlDataframeAnalysisClassification.md b/docs/reference/api/MlDataframeAnalysisClassification.md index 43b239be8..0ead3e6a3 100644 --- a/docs/reference/api/MlDataframeAnalysisClassification.md +++ b/docs/reference/api/MlDataframeAnalysisClassification.md @@ -1,4 +1,4 @@ -## Interface `MlDataframeAnalysisClassification` +# `MlDataframeAnalysisClassification` [interface-MlDataframeAnalysisClassification] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlDataframeAnalysisContainer.md b/docs/reference/api/MlDataframeAnalysisContainer.md index 3ceb4931c..4c57caf95 100644 --- a/docs/reference/api/MlDataframeAnalysisContainer.md +++ b/docs/reference/api/MlDataframeAnalysisContainer.md @@ -1,4 +1,4 @@ -## Interface `MlDataframeAnalysisContainer` +# `MlDataframeAnalysisContainer` [interface-MlDataframeAnalysisContainer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlDataframeAnalysisFeatureProcessor.md b/docs/reference/api/MlDataframeAnalysisFeatureProcessor.md index bea6b0def..2055f9466 100644 --- a/docs/reference/api/MlDataframeAnalysisFeatureProcessor.md +++ b/docs/reference/api/MlDataframeAnalysisFeatureProcessor.md @@ -1,4 +1,4 @@ -## Interface `MlDataframeAnalysisFeatureProcessor` +# `MlDataframeAnalysisFeatureProcessor` [interface-MlDataframeAnalysisFeatureProcessor] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlDataframeAnalysisFeatureProcessorFrequencyEncoding.md b/docs/reference/api/MlDataframeAnalysisFeatureProcessorFrequencyEncoding.md index 3c48c6e28..b1ae4dd68 100644 --- a/docs/reference/api/MlDataframeAnalysisFeatureProcessorFrequencyEncoding.md +++ b/docs/reference/api/MlDataframeAnalysisFeatureProcessorFrequencyEncoding.md @@ -1,4 +1,4 @@ -## Interface `MlDataframeAnalysisFeatureProcessorFrequencyEncoding` +# `MlDataframeAnalysisFeatureProcessorFrequencyEncoding` [interface-MlDataframeAnalysisFeatureProcessorFrequencyEncoding] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlDataframeAnalysisFeatureProcessorMultiEncoding.md b/docs/reference/api/MlDataframeAnalysisFeatureProcessorMultiEncoding.md index 97d09d687..be38e1219 100644 --- a/docs/reference/api/MlDataframeAnalysisFeatureProcessorMultiEncoding.md +++ b/docs/reference/api/MlDataframeAnalysisFeatureProcessorMultiEncoding.md @@ -1,4 +1,4 @@ -## Interface `MlDataframeAnalysisFeatureProcessorMultiEncoding` +# `MlDataframeAnalysisFeatureProcessorMultiEncoding` [interface-MlDataframeAnalysisFeatureProcessorMultiEncoding] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlDataframeAnalysisFeatureProcessorNGramEncoding.md b/docs/reference/api/MlDataframeAnalysisFeatureProcessorNGramEncoding.md index f1be49ba1..9b782a643 100644 --- a/docs/reference/api/MlDataframeAnalysisFeatureProcessorNGramEncoding.md +++ b/docs/reference/api/MlDataframeAnalysisFeatureProcessorNGramEncoding.md @@ -1,4 +1,4 @@ -## Interface `MlDataframeAnalysisFeatureProcessorNGramEncoding` +# `MlDataframeAnalysisFeatureProcessorNGramEncoding` [interface-MlDataframeAnalysisFeatureProcessorNGramEncoding] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlDataframeAnalysisFeatureProcessorOneHotEncoding.md b/docs/reference/api/MlDataframeAnalysisFeatureProcessorOneHotEncoding.md index 89429f080..1a80f8071 100644 --- a/docs/reference/api/MlDataframeAnalysisFeatureProcessorOneHotEncoding.md +++ b/docs/reference/api/MlDataframeAnalysisFeatureProcessorOneHotEncoding.md @@ -1,4 +1,4 @@ -## Interface `MlDataframeAnalysisFeatureProcessorOneHotEncoding` +# `MlDataframeAnalysisFeatureProcessorOneHotEncoding` [interface-MlDataframeAnalysisFeatureProcessorOneHotEncoding] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlDataframeAnalysisFeatureProcessorTargetMeanEncoding.md b/docs/reference/api/MlDataframeAnalysisFeatureProcessorTargetMeanEncoding.md index 52250cfd6..5bad0142e 100644 --- a/docs/reference/api/MlDataframeAnalysisFeatureProcessorTargetMeanEncoding.md +++ b/docs/reference/api/MlDataframeAnalysisFeatureProcessorTargetMeanEncoding.md @@ -1,4 +1,4 @@ -## Interface `MlDataframeAnalysisFeatureProcessorTargetMeanEncoding` +# `MlDataframeAnalysisFeatureProcessorTargetMeanEncoding` [interface-MlDataframeAnalysisFeatureProcessorTargetMeanEncoding] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlDataframeAnalysisOutlierDetection.md b/docs/reference/api/MlDataframeAnalysisOutlierDetection.md index 0c59cc3f4..3d155a81d 100644 --- a/docs/reference/api/MlDataframeAnalysisOutlierDetection.md +++ b/docs/reference/api/MlDataframeAnalysisOutlierDetection.md @@ -1,4 +1,4 @@ -## Interface `MlDataframeAnalysisOutlierDetection` +# `MlDataframeAnalysisOutlierDetection` [interface-MlDataframeAnalysisOutlierDetection] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlDataframeAnalysisRegression.md b/docs/reference/api/MlDataframeAnalysisRegression.md index ac50d0534..f78fea736 100644 --- a/docs/reference/api/MlDataframeAnalysisRegression.md +++ b/docs/reference/api/MlDataframeAnalysisRegression.md @@ -1,4 +1,4 @@ -## Interface `MlDataframeAnalysisRegression` +# `MlDataframeAnalysisRegression` [interface-MlDataframeAnalysisRegression] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlDataframeAnalytics.md b/docs/reference/api/MlDataframeAnalytics.md index ace056acc..a39601ae2 100644 --- a/docs/reference/api/MlDataframeAnalytics.md +++ b/docs/reference/api/MlDataframeAnalytics.md @@ -1,4 +1,4 @@ -## Interface `MlDataframeAnalytics` +# `MlDataframeAnalytics` [interface-MlDataframeAnalytics] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlDataframeAnalyticsAuthorization.md b/docs/reference/api/MlDataframeAnalyticsAuthorization.md index 232eb1212..f5e0d5a0d 100644 --- a/docs/reference/api/MlDataframeAnalyticsAuthorization.md +++ b/docs/reference/api/MlDataframeAnalyticsAuthorization.md @@ -1,4 +1,4 @@ -## Interface `MlDataframeAnalyticsAuthorization` +# `MlDataframeAnalyticsAuthorization` [interface-MlDataframeAnalyticsAuthorization] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlDataframeAnalyticsDestination.md b/docs/reference/api/MlDataframeAnalyticsDestination.md index 184062f90..673435baa 100644 --- a/docs/reference/api/MlDataframeAnalyticsDestination.md +++ b/docs/reference/api/MlDataframeAnalyticsDestination.md @@ -1,4 +1,4 @@ -## Interface `MlDataframeAnalyticsDestination` +# `MlDataframeAnalyticsDestination` [interface-MlDataframeAnalyticsDestination] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlDataframeAnalyticsFieldSelection.md b/docs/reference/api/MlDataframeAnalyticsFieldSelection.md index d6723f78a..3769e4a4e 100644 --- a/docs/reference/api/MlDataframeAnalyticsFieldSelection.md +++ b/docs/reference/api/MlDataframeAnalyticsFieldSelection.md @@ -1,4 +1,4 @@ -## Interface `MlDataframeAnalyticsFieldSelection` +# `MlDataframeAnalyticsFieldSelection` [interface-MlDataframeAnalyticsFieldSelection] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlDataframeAnalyticsMemoryEstimation.md b/docs/reference/api/MlDataframeAnalyticsMemoryEstimation.md index 2ff96e4b3..2354a86b8 100644 --- a/docs/reference/api/MlDataframeAnalyticsMemoryEstimation.md +++ b/docs/reference/api/MlDataframeAnalyticsMemoryEstimation.md @@ -1,4 +1,4 @@ -## Interface `MlDataframeAnalyticsMemoryEstimation` +# `MlDataframeAnalyticsMemoryEstimation` [interface-MlDataframeAnalyticsMemoryEstimation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlDataframeAnalyticsSource.md b/docs/reference/api/MlDataframeAnalyticsSource.md index dc00a4f86..56c341c75 100644 --- a/docs/reference/api/MlDataframeAnalyticsSource.md +++ b/docs/reference/api/MlDataframeAnalyticsSource.md @@ -1,4 +1,4 @@ -## Interface `MlDataframeAnalyticsSource` +# `MlDataframeAnalyticsSource` [interface-MlDataframeAnalyticsSource] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlDataframeAnalyticsStatsContainer.md b/docs/reference/api/MlDataframeAnalyticsStatsContainer.md index c7e626908..065336e85 100644 --- a/docs/reference/api/MlDataframeAnalyticsStatsContainer.md +++ b/docs/reference/api/MlDataframeAnalyticsStatsContainer.md @@ -1,4 +1,4 @@ -## Interface `MlDataframeAnalyticsStatsContainer` +# `MlDataframeAnalyticsStatsContainer` [interface-MlDataframeAnalyticsStatsContainer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlDataframeAnalyticsStatsDataCounts.md b/docs/reference/api/MlDataframeAnalyticsStatsDataCounts.md index ea2b0cb69..16cdc35eb 100644 --- a/docs/reference/api/MlDataframeAnalyticsStatsDataCounts.md +++ b/docs/reference/api/MlDataframeAnalyticsStatsDataCounts.md @@ -1,4 +1,4 @@ -## Interface `MlDataframeAnalyticsStatsDataCounts` +# `MlDataframeAnalyticsStatsDataCounts` [interface-MlDataframeAnalyticsStatsDataCounts] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlDataframeAnalyticsStatsHyperparameters.md b/docs/reference/api/MlDataframeAnalyticsStatsHyperparameters.md index d340c35e8..5a6add1ba 100644 --- a/docs/reference/api/MlDataframeAnalyticsStatsHyperparameters.md +++ b/docs/reference/api/MlDataframeAnalyticsStatsHyperparameters.md @@ -1,4 +1,4 @@ -## Interface `MlDataframeAnalyticsStatsHyperparameters` +# `MlDataframeAnalyticsStatsHyperparameters` [interface-MlDataframeAnalyticsStatsHyperparameters] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlDataframeAnalyticsStatsMemoryUsage.md b/docs/reference/api/MlDataframeAnalyticsStatsMemoryUsage.md index ed355657c..c36e5dc55 100644 --- a/docs/reference/api/MlDataframeAnalyticsStatsMemoryUsage.md +++ b/docs/reference/api/MlDataframeAnalyticsStatsMemoryUsage.md @@ -1,4 +1,4 @@ -## Interface `MlDataframeAnalyticsStatsMemoryUsage` +# `MlDataframeAnalyticsStatsMemoryUsage` [interface-MlDataframeAnalyticsStatsMemoryUsage] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlDataframeAnalyticsStatsOutlierDetection.md b/docs/reference/api/MlDataframeAnalyticsStatsOutlierDetection.md index 3f89e0c7b..2229872f1 100644 --- a/docs/reference/api/MlDataframeAnalyticsStatsOutlierDetection.md +++ b/docs/reference/api/MlDataframeAnalyticsStatsOutlierDetection.md @@ -1,4 +1,4 @@ -## Interface `MlDataframeAnalyticsStatsOutlierDetection` +# `MlDataframeAnalyticsStatsOutlierDetection` [interface-MlDataframeAnalyticsStatsOutlierDetection] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlDataframeAnalyticsStatsProgress.md b/docs/reference/api/MlDataframeAnalyticsStatsProgress.md index e649df98f..9214f633f 100644 --- a/docs/reference/api/MlDataframeAnalyticsStatsProgress.md +++ b/docs/reference/api/MlDataframeAnalyticsStatsProgress.md @@ -1,4 +1,4 @@ -## Interface `MlDataframeAnalyticsStatsProgress` +# `MlDataframeAnalyticsStatsProgress` [interface-MlDataframeAnalyticsStatsProgress] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlDataframeAnalyticsSummary.md b/docs/reference/api/MlDataframeAnalyticsSummary.md index 35dac0d52..c137a0bde 100644 --- a/docs/reference/api/MlDataframeAnalyticsSummary.md +++ b/docs/reference/api/MlDataframeAnalyticsSummary.md @@ -1,4 +1,4 @@ -## Interface `MlDataframeAnalyticsSummary` +# `MlDataframeAnalyticsSummary` [interface-MlDataframeAnalyticsSummary] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlDataframeEvaluationClassification.md b/docs/reference/api/MlDataframeEvaluationClassification.md index def9bc9d8..192ba9f54 100644 --- a/docs/reference/api/MlDataframeEvaluationClassification.md +++ b/docs/reference/api/MlDataframeEvaluationClassification.md @@ -1,4 +1,4 @@ -## Interface `MlDataframeEvaluationClassification` +# `MlDataframeEvaluationClassification` [interface-MlDataframeEvaluationClassification] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlDataframeEvaluationClassificationMetrics.md b/docs/reference/api/MlDataframeEvaluationClassificationMetrics.md index 7fcf33e82..785794037 100644 --- a/docs/reference/api/MlDataframeEvaluationClassificationMetrics.md +++ b/docs/reference/api/MlDataframeEvaluationClassificationMetrics.md @@ -1,4 +1,4 @@ -## Interface `MlDataframeEvaluationClassificationMetrics` +# `MlDataframeEvaluationClassificationMetrics` [interface-MlDataframeEvaluationClassificationMetrics] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlDataframeEvaluationClassificationMetricsAucRoc.md b/docs/reference/api/MlDataframeEvaluationClassificationMetricsAucRoc.md index 0f6f33682..a8b60525f 100644 --- a/docs/reference/api/MlDataframeEvaluationClassificationMetricsAucRoc.md +++ b/docs/reference/api/MlDataframeEvaluationClassificationMetricsAucRoc.md @@ -1,4 +1,4 @@ -## Interface `MlDataframeEvaluationClassificationMetricsAucRoc` +# `MlDataframeEvaluationClassificationMetricsAucRoc` [interface-MlDataframeEvaluationClassificationMetricsAucRoc] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlDataframeEvaluationContainer.md b/docs/reference/api/MlDataframeEvaluationContainer.md index 64a3b89b6..cb3aacce0 100644 --- a/docs/reference/api/MlDataframeEvaluationContainer.md +++ b/docs/reference/api/MlDataframeEvaluationContainer.md @@ -1,4 +1,4 @@ -## Interface `MlDataframeEvaluationContainer` +# `MlDataframeEvaluationContainer` [interface-MlDataframeEvaluationContainer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlDataframeEvaluationMetrics.md b/docs/reference/api/MlDataframeEvaluationMetrics.md index 71bbee464..31ad8b4ae 100644 --- a/docs/reference/api/MlDataframeEvaluationMetrics.md +++ b/docs/reference/api/MlDataframeEvaluationMetrics.md @@ -1,4 +1,4 @@ -## Interface `MlDataframeEvaluationMetrics` +# `MlDataframeEvaluationMetrics` [interface-MlDataframeEvaluationMetrics] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlDataframeEvaluationOutlierDetection.md b/docs/reference/api/MlDataframeEvaluationOutlierDetection.md index a0e6939e1..947ebf1da 100644 --- a/docs/reference/api/MlDataframeEvaluationOutlierDetection.md +++ b/docs/reference/api/MlDataframeEvaluationOutlierDetection.md @@ -1,4 +1,4 @@ -## Interface `MlDataframeEvaluationOutlierDetection` +# `MlDataframeEvaluationOutlierDetection` [interface-MlDataframeEvaluationOutlierDetection] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlDataframeEvaluationOutlierDetectionMetrics.md b/docs/reference/api/MlDataframeEvaluationOutlierDetectionMetrics.md index 16f1656db..84f40dd8f 100644 --- a/docs/reference/api/MlDataframeEvaluationOutlierDetectionMetrics.md +++ b/docs/reference/api/MlDataframeEvaluationOutlierDetectionMetrics.md @@ -1,4 +1,4 @@ -## Interface `MlDataframeEvaluationOutlierDetectionMetrics` +# `MlDataframeEvaluationOutlierDetectionMetrics` [interface-MlDataframeEvaluationOutlierDetectionMetrics] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlDataframeEvaluationRegression.md b/docs/reference/api/MlDataframeEvaluationRegression.md index 8a16567a8..80b9a9f09 100644 --- a/docs/reference/api/MlDataframeEvaluationRegression.md +++ b/docs/reference/api/MlDataframeEvaluationRegression.md @@ -1,4 +1,4 @@ -## Interface `MlDataframeEvaluationRegression` +# `MlDataframeEvaluationRegression` [interface-MlDataframeEvaluationRegression] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlDataframeEvaluationRegressionMetrics.md b/docs/reference/api/MlDataframeEvaluationRegressionMetrics.md index 421b9c54c..63279d784 100644 --- a/docs/reference/api/MlDataframeEvaluationRegressionMetrics.md +++ b/docs/reference/api/MlDataframeEvaluationRegressionMetrics.md @@ -1,4 +1,4 @@ -## Interface `MlDataframeEvaluationRegressionMetrics` +# `MlDataframeEvaluationRegressionMetrics` [interface-MlDataframeEvaluationRegressionMetrics] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlDataframeEvaluationRegressionMetricsHuber.md b/docs/reference/api/MlDataframeEvaluationRegressionMetricsHuber.md index 041aeef18..e412dd23a 100644 --- a/docs/reference/api/MlDataframeEvaluationRegressionMetricsHuber.md +++ b/docs/reference/api/MlDataframeEvaluationRegressionMetricsHuber.md @@ -1,4 +1,4 @@ -## Interface `MlDataframeEvaluationRegressionMetricsHuber` +# `MlDataframeEvaluationRegressionMetricsHuber` [interface-MlDataframeEvaluationRegressionMetricsHuber] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlDataframeEvaluationRegressionMetricsMsle.md b/docs/reference/api/MlDataframeEvaluationRegressionMetricsMsle.md index af34ca5f3..5126fb3c8 100644 --- a/docs/reference/api/MlDataframeEvaluationRegressionMetricsMsle.md +++ b/docs/reference/api/MlDataframeEvaluationRegressionMetricsMsle.md @@ -1,4 +1,4 @@ -## Interface `MlDataframeEvaluationRegressionMetricsMsle` +# `MlDataframeEvaluationRegressionMetricsMsle` [interface-MlDataframeEvaluationRegressionMetricsMsle] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlDataframeState.md b/docs/reference/api/MlDataframeState.md index 6dd5b7b6b..40a34d47b 100644 --- a/docs/reference/api/MlDataframeState.md +++ b/docs/reference/api/MlDataframeState.md @@ -1,4 +1,4 @@ -## `MlDataframeState` -::: +# `MlDataframeState` [alias-MlDataframeState] +```typescript type MlDataframeState = 'started' | 'stopped' | 'starting' | 'stopping' | 'failed'; -::: +``` diff --git a/docs/reference/api/MlDelayedDataCheckConfig.md b/docs/reference/api/MlDelayedDataCheckConfig.md index e78f04ef1..3f9e18a07 100644 --- a/docs/reference/api/MlDelayedDataCheckConfig.md +++ b/docs/reference/api/MlDelayedDataCheckConfig.md @@ -1,4 +1,4 @@ -## Interface `MlDelayedDataCheckConfig` +# `MlDelayedDataCheckConfig` [interface-MlDelayedDataCheckConfig] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlDeleteCalendarEventRequest.md b/docs/reference/api/MlDeleteCalendarEventRequest.md index 2811eb080..29250ff27 100644 --- a/docs/reference/api/MlDeleteCalendarEventRequest.md +++ b/docs/reference/api/MlDeleteCalendarEventRequest.md @@ -1,4 +1,4 @@ -## Interface `MlDeleteCalendarEventRequest` +# `MlDeleteCalendarEventRequest` [interface-MlDeleteCalendarEventRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlDeleteCalendarEventResponse.md b/docs/reference/api/MlDeleteCalendarEventResponse.md index 64dd3e72e..4212de078 100644 --- a/docs/reference/api/MlDeleteCalendarEventResponse.md +++ b/docs/reference/api/MlDeleteCalendarEventResponse.md @@ -1,4 +1,4 @@ -## `MlDeleteCalendarEventResponse` -::: +# `MlDeleteCalendarEventResponse` [alias-MlDeleteCalendarEventResponse] +```typescript type MlDeleteCalendarEventResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); -::: +``` diff --git a/docs/reference/api/MlDeleteCalendarJobRequest.md b/docs/reference/api/MlDeleteCalendarJobRequest.md index a3bee4051..d7caab0ed 100644 --- a/docs/reference/api/MlDeleteCalendarJobRequest.md +++ b/docs/reference/api/MlDeleteCalendarJobRequest.md @@ -1,4 +1,4 @@ -## Interface `MlDeleteCalendarJobRequest` +# `MlDeleteCalendarJobRequest` [interface-MlDeleteCalendarJobRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlDeleteCalendarJobResponse.md b/docs/reference/api/MlDeleteCalendarJobResponse.md index d337fa48c..a6eca7452 100644 --- a/docs/reference/api/MlDeleteCalendarJobResponse.md +++ b/docs/reference/api/MlDeleteCalendarJobResponse.md @@ -1,4 +1,4 @@ -## Interface `MlDeleteCalendarJobResponse` +# `MlDeleteCalendarJobResponse` [interface-MlDeleteCalendarJobResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlDeleteCalendarRequest.md b/docs/reference/api/MlDeleteCalendarRequest.md index 0abd52836..107930c15 100644 --- a/docs/reference/api/MlDeleteCalendarRequest.md +++ b/docs/reference/api/MlDeleteCalendarRequest.md @@ -1,4 +1,4 @@ -## Interface `MlDeleteCalendarRequest` +# `MlDeleteCalendarRequest` [interface-MlDeleteCalendarRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlDeleteCalendarResponse.md b/docs/reference/api/MlDeleteCalendarResponse.md index 0191904ff..640c56879 100644 --- a/docs/reference/api/MlDeleteCalendarResponse.md +++ b/docs/reference/api/MlDeleteCalendarResponse.md @@ -1,4 +1,4 @@ -## `MlDeleteCalendarResponse` -::: +# `MlDeleteCalendarResponse` [alias-MlDeleteCalendarResponse] +```typescript type MlDeleteCalendarResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); -::: +``` diff --git a/docs/reference/api/MlDeleteDataFrameAnalyticsRequest.md b/docs/reference/api/MlDeleteDataFrameAnalyticsRequest.md index 7d394dc83..fdf285666 100644 --- a/docs/reference/api/MlDeleteDataFrameAnalyticsRequest.md +++ b/docs/reference/api/MlDeleteDataFrameAnalyticsRequest.md @@ -1,4 +1,4 @@ -## Interface `MlDeleteDataFrameAnalyticsRequest` +# `MlDeleteDataFrameAnalyticsRequest` [interface-MlDeleteDataFrameAnalyticsRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlDeleteDataFrameAnalyticsResponse.md b/docs/reference/api/MlDeleteDataFrameAnalyticsResponse.md index dfe5e5181..20402f5f5 100644 --- a/docs/reference/api/MlDeleteDataFrameAnalyticsResponse.md +++ b/docs/reference/api/MlDeleteDataFrameAnalyticsResponse.md @@ -1,4 +1,4 @@ -## `MlDeleteDataFrameAnalyticsResponse` -::: +# `MlDeleteDataFrameAnalyticsResponse` [alias-MlDeleteDataFrameAnalyticsResponse] +```typescript type MlDeleteDataFrameAnalyticsResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); -::: +``` diff --git a/docs/reference/api/MlDeleteDatafeedRequest.md b/docs/reference/api/MlDeleteDatafeedRequest.md index b3a128e0f..b78bd3f63 100644 --- a/docs/reference/api/MlDeleteDatafeedRequest.md +++ b/docs/reference/api/MlDeleteDatafeedRequest.md @@ -1,4 +1,4 @@ -## Interface `MlDeleteDatafeedRequest` +# `MlDeleteDatafeedRequest` [interface-MlDeleteDatafeedRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlDeleteDatafeedResponse.md b/docs/reference/api/MlDeleteDatafeedResponse.md index 4bf44932d..b769aeddd 100644 --- a/docs/reference/api/MlDeleteDatafeedResponse.md +++ b/docs/reference/api/MlDeleteDatafeedResponse.md @@ -1,4 +1,4 @@ -## `MlDeleteDatafeedResponse` -::: +# `MlDeleteDatafeedResponse` [alias-MlDeleteDatafeedResponse] +```typescript type MlDeleteDatafeedResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); -::: +``` diff --git a/docs/reference/api/MlDeleteExpiredDataRequest.md b/docs/reference/api/MlDeleteExpiredDataRequest.md index 9b543f368..e636fa8e0 100644 --- a/docs/reference/api/MlDeleteExpiredDataRequest.md +++ b/docs/reference/api/MlDeleteExpiredDataRequest.md @@ -1,4 +1,4 @@ -## Interface `MlDeleteExpiredDataRequest` +# `MlDeleteExpiredDataRequest` [interface-MlDeleteExpiredDataRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlDeleteExpiredDataResponse.md b/docs/reference/api/MlDeleteExpiredDataResponse.md index 96c38328e..afe2a17e9 100644 --- a/docs/reference/api/MlDeleteExpiredDataResponse.md +++ b/docs/reference/api/MlDeleteExpiredDataResponse.md @@ -1,4 +1,4 @@ -## Interface `MlDeleteExpiredDataResponse` +# `MlDeleteExpiredDataResponse` [interface-MlDeleteExpiredDataResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlDeleteFilterRequest.md b/docs/reference/api/MlDeleteFilterRequest.md index 59d768669..1a6751b5e 100644 --- a/docs/reference/api/MlDeleteFilterRequest.md +++ b/docs/reference/api/MlDeleteFilterRequest.md @@ -1,4 +1,4 @@ -## Interface `MlDeleteFilterRequest` +# `MlDeleteFilterRequest` [interface-MlDeleteFilterRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlDeleteFilterResponse.md b/docs/reference/api/MlDeleteFilterResponse.md index 72b6e67d6..32a3dcdbe 100644 --- a/docs/reference/api/MlDeleteFilterResponse.md +++ b/docs/reference/api/MlDeleteFilterResponse.md @@ -1,4 +1,4 @@ -## `MlDeleteFilterResponse` -::: +# `MlDeleteFilterResponse` [alias-MlDeleteFilterResponse] +```typescript type MlDeleteFilterResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); -::: +``` diff --git a/docs/reference/api/MlDeleteForecastRequest.md b/docs/reference/api/MlDeleteForecastRequest.md index 2ae4ccba0..ac0629ce8 100644 --- a/docs/reference/api/MlDeleteForecastRequest.md +++ b/docs/reference/api/MlDeleteForecastRequest.md @@ -1,4 +1,4 @@ -## Interface `MlDeleteForecastRequest` +# `MlDeleteForecastRequest` [interface-MlDeleteForecastRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlDeleteForecastResponse.md b/docs/reference/api/MlDeleteForecastResponse.md index bac02c193..fa9b3a35c 100644 --- a/docs/reference/api/MlDeleteForecastResponse.md +++ b/docs/reference/api/MlDeleteForecastResponse.md @@ -1,4 +1,4 @@ -## `MlDeleteForecastResponse` -::: +# `MlDeleteForecastResponse` [alias-MlDeleteForecastResponse] +```typescript type MlDeleteForecastResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); -::: +``` diff --git a/docs/reference/api/MlDeleteJobRequest.md b/docs/reference/api/MlDeleteJobRequest.md index 125e45974..fc60ae2a4 100644 --- a/docs/reference/api/MlDeleteJobRequest.md +++ b/docs/reference/api/MlDeleteJobRequest.md @@ -1,4 +1,4 @@ -## Interface `MlDeleteJobRequest` +# `MlDeleteJobRequest` [interface-MlDeleteJobRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlDeleteJobResponse.md b/docs/reference/api/MlDeleteJobResponse.md index ba60c21b3..669ac2fe8 100644 --- a/docs/reference/api/MlDeleteJobResponse.md +++ b/docs/reference/api/MlDeleteJobResponse.md @@ -1,4 +1,4 @@ -## `MlDeleteJobResponse` -::: +# `MlDeleteJobResponse` [alias-MlDeleteJobResponse] +```typescript type MlDeleteJobResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); -::: +``` diff --git a/docs/reference/api/MlDeleteModelSnapshotRequest.md b/docs/reference/api/MlDeleteModelSnapshotRequest.md index c61a8b540..97f51c080 100644 --- a/docs/reference/api/MlDeleteModelSnapshotRequest.md +++ b/docs/reference/api/MlDeleteModelSnapshotRequest.md @@ -1,4 +1,4 @@ -## Interface `MlDeleteModelSnapshotRequest` +# `MlDeleteModelSnapshotRequest` [interface-MlDeleteModelSnapshotRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlDeleteModelSnapshotResponse.md b/docs/reference/api/MlDeleteModelSnapshotResponse.md index b86e6e703..8284272a9 100644 --- a/docs/reference/api/MlDeleteModelSnapshotResponse.md +++ b/docs/reference/api/MlDeleteModelSnapshotResponse.md @@ -1,4 +1,4 @@ -## `MlDeleteModelSnapshotResponse` -::: +# `MlDeleteModelSnapshotResponse` [alias-MlDeleteModelSnapshotResponse] +```typescript type MlDeleteModelSnapshotResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); -::: +``` diff --git a/docs/reference/api/MlDeleteTrainedModelAliasRequest.md b/docs/reference/api/MlDeleteTrainedModelAliasRequest.md index 4e4c1e209..b81473986 100644 --- a/docs/reference/api/MlDeleteTrainedModelAliasRequest.md +++ b/docs/reference/api/MlDeleteTrainedModelAliasRequest.md @@ -1,4 +1,4 @@ -## Interface `MlDeleteTrainedModelAliasRequest` +# `MlDeleteTrainedModelAliasRequest` [interface-MlDeleteTrainedModelAliasRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlDeleteTrainedModelAliasResponse.md b/docs/reference/api/MlDeleteTrainedModelAliasResponse.md index 0e7b4465f..132ed6d4d 100644 --- a/docs/reference/api/MlDeleteTrainedModelAliasResponse.md +++ b/docs/reference/api/MlDeleteTrainedModelAliasResponse.md @@ -1,4 +1,4 @@ -## `MlDeleteTrainedModelAliasResponse` -::: +# `MlDeleteTrainedModelAliasResponse` [alias-MlDeleteTrainedModelAliasResponse] +```typescript type MlDeleteTrainedModelAliasResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); -::: +``` diff --git a/docs/reference/api/MlDeleteTrainedModelRequest.md b/docs/reference/api/MlDeleteTrainedModelRequest.md index c4d9b2267..3f931f0e4 100644 --- a/docs/reference/api/MlDeleteTrainedModelRequest.md +++ b/docs/reference/api/MlDeleteTrainedModelRequest.md @@ -1,4 +1,4 @@ -## Interface `MlDeleteTrainedModelRequest` +# `MlDeleteTrainedModelRequest` [interface-MlDeleteTrainedModelRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlDeleteTrainedModelResponse.md b/docs/reference/api/MlDeleteTrainedModelResponse.md index 88b34bf50..0a6033786 100644 --- a/docs/reference/api/MlDeleteTrainedModelResponse.md +++ b/docs/reference/api/MlDeleteTrainedModelResponse.md @@ -1,4 +1,4 @@ -## `MlDeleteTrainedModelResponse` -::: +# `MlDeleteTrainedModelResponse` [alias-MlDeleteTrainedModelResponse] +```typescript type MlDeleteTrainedModelResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); -::: +``` diff --git a/docs/reference/api/MlDeploymentAllocationState.md b/docs/reference/api/MlDeploymentAllocationState.md index f0a3eaf8a..24f3bcce0 100644 --- a/docs/reference/api/MlDeploymentAllocationState.md +++ b/docs/reference/api/MlDeploymentAllocationState.md @@ -1,4 +1,4 @@ -## `MlDeploymentAllocationState` -::: +# `MlDeploymentAllocationState` [alias-MlDeploymentAllocationState] +```typescript type MlDeploymentAllocationState = 'started' | 'starting' | 'fully_allocated'; -::: +``` diff --git a/docs/reference/api/MlDeploymentAssignmentState.md b/docs/reference/api/MlDeploymentAssignmentState.md index 5e09b81bd..6cb9d8828 100644 --- a/docs/reference/api/MlDeploymentAssignmentState.md +++ b/docs/reference/api/MlDeploymentAssignmentState.md @@ -1,4 +1,4 @@ -## `MlDeploymentAssignmentState` -::: +# `MlDeploymentAssignmentState` [alias-MlDeploymentAssignmentState] +```typescript type MlDeploymentAssignmentState = 'started' | 'starting' | 'stopping' | 'failed'; -::: +``` diff --git a/docs/reference/api/MlDetectionRule.md b/docs/reference/api/MlDetectionRule.md index 1fb085f94..02e89ff66 100644 --- a/docs/reference/api/MlDetectionRule.md +++ b/docs/reference/api/MlDetectionRule.md @@ -1,4 +1,4 @@ -## Interface `MlDetectionRule` +# `MlDetectionRule` [interface-MlDetectionRule] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlDetector.md b/docs/reference/api/MlDetector.md index 07eeffd72..afa363063 100644 --- a/docs/reference/api/MlDetector.md +++ b/docs/reference/api/MlDetector.md @@ -1,4 +1,4 @@ -## Interface `MlDetector` +# `MlDetector` [interface-MlDetector] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlDetectorRead.md b/docs/reference/api/MlDetectorRead.md index 57b7b3bf0..b2f5e4508 100644 --- a/docs/reference/api/MlDetectorRead.md +++ b/docs/reference/api/MlDetectorRead.md @@ -1,4 +1,4 @@ -## Interface `MlDetectorRead` +# `MlDetectorRead` [interface-MlDetectorRead] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlDetectorUpdate.md b/docs/reference/api/MlDetectorUpdate.md index 017dc2cee..57353282f 100644 --- a/docs/reference/api/MlDetectorUpdate.md +++ b/docs/reference/api/MlDetectorUpdate.md @@ -1,4 +1,4 @@ -## Interface `MlDetectorUpdate` +# `MlDetectorUpdate` [interface-MlDetectorUpdate] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlDiscoveryNode.md b/docs/reference/api/MlDiscoveryNode.md index 5bd943d7d..d3993aa64 100644 --- a/docs/reference/api/MlDiscoveryNode.md +++ b/docs/reference/api/MlDiscoveryNode.md @@ -1,4 +1,4 @@ -## `MlDiscoveryNode` -::: +# `MlDiscoveryNode` [alias-MlDiscoveryNode] +```typescript type MlDiscoveryNode = [Partial](./Partial.md)>; -::: +``` diff --git a/docs/reference/api/MlDiscoveryNodeCompact.md b/docs/reference/api/MlDiscoveryNodeCompact.md index 9865910d3..54bf18029 100644 --- a/docs/reference/api/MlDiscoveryNodeCompact.md +++ b/docs/reference/api/MlDiscoveryNodeCompact.md @@ -1,4 +1,4 @@ -## Interface `MlDiscoveryNodeCompact` +# `MlDiscoveryNodeCompact` [interface-MlDiscoveryNodeCompact] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlDiscoveryNodeContent.md b/docs/reference/api/MlDiscoveryNodeContent.md index 3848971fb..5de93e9be 100644 --- a/docs/reference/api/MlDiscoveryNodeContent.md +++ b/docs/reference/api/MlDiscoveryNodeContent.md @@ -1,4 +1,4 @@ -## Interface `MlDiscoveryNodeContent` +# `MlDiscoveryNodeContent` [interface-MlDiscoveryNodeContent] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlEstimateModelMemoryRequest.md b/docs/reference/api/MlEstimateModelMemoryRequest.md index 7c7af659d..8b0317ef5 100644 --- a/docs/reference/api/MlEstimateModelMemoryRequest.md +++ b/docs/reference/api/MlEstimateModelMemoryRequest.md @@ -1,4 +1,4 @@ -## Interface `MlEstimateModelMemoryRequest` +# `MlEstimateModelMemoryRequest` [interface-MlEstimateModelMemoryRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlEstimateModelMemoryResponse.md b/docs/reference/api/MlEstimateModelMemoryResponse.md index bf9526ebc..8f237fdef 100644 --- a/docs/reference/api/MlEstimateModelMemoryResponse.md +++ b/docs/reference/api/MlEstimateModelMemoryResponse.md @@ -1,4 +1,4 @@ -## Interface `MlEstimateModelMemoryResponse` +# `MlEstimateModelMemoryResponse` [interface-MlEstimateModelMemoryResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlEvaluateDataFrameConfusionMatrixItem.md b/docs/reference/api/MlEvaluateDataFrameConfusionMatrixItem.md index b8906a47c..17b224493 100644 --- a/docs/reference/api/MlEvaluateDataFrameConfusionMatrixItem.md +++ b/docs/reference/api/MlEvaluateDataFrameConfusionMatrixItem.md @@ -1,4 +1,4 @@ -## Interface `MlEvaluateDataFrameConfusionMatrixItem` +# `MlEvaluateDataFrameConfusionMatrixItem` [interface-MlEvaluateDataFrameConfusionMatrixItem] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlEvaluateDataFrameConfusionMatrixPrediction.md b/docs/reference/api/MlEvaluateDataFrameConfusionMatrixPrediction.md index de7400e2d..0bad04a0c 100644 --- a/docs/reference/api/MlEvaluateDataFrameConfusionMatrixPrediction.md +++ b/docs/reference/api/MlEvaluateDataFrameConfusionMatrixPrediction.md @@ -1,4 +1,4 @@ -## Interface `MlEvaluateDataFrameConfusionMatrixPrediction` +# `MlEvaluateDataFrameConfusionMatrixPrediction` [interface-MlEvaluateDataFrameConfusionMatrixPrediction] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlEvaluateDataFrameConfusionMatrixThreshold.md b/docs/reference/api/MlEvaluateDataFrameConfusionMatrixThreshold.md index c06d763d6..1d1f571ae 100644 --- a/docs/reference/api/MlEvaluateDataFrameConfusionMatrixThreshold.md +++ b/docs/reference/api/MlEvaluateDataFrameConfusionMatrixThreshold.md @@ -1,4 +1,4 @@ -## Interface `MlEvaluateDataFrameConfusionMatrixThreshold` +# `MlEvaluateDataFrameConfusionMatrixThreshold` [interface-MlEvaluateDataFrameConfusionMatrixThreshold] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlEvaluateDataFrameDataframeClassificationSummary.md b/docs/reference/api/MlEvaluateDataFrameDataframeClassificationSummary.md index 313b8b11c..236fd43ca 100644 --- a/docs/reference/api/MlEvaluateDataFrameDataframeClassificationSummary.md +++ b/docs/reference/api/MlEvaluateDataFrameDataframeClassificationSummary.md @@ -1,4 +1,4 @@ -## Interface `MlEvaluateDataFrameDataframeClassificationSummary` +# `MlEvaluateDataFrameDataframeClassificationSummary` [interface-MlEvaluateDataFrameDataframeClassificationSummary] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlEvaluateDataFrameDataframeClassificationSummaryAccuracy.md b/docs/reference/api/MlEvaluateDataFrameDataframeClassificationSummaryAccuracy.md index c3f88829d..ad4f335ac 100644 --- a/docs/reference/api/MlEvaluateDataFrameDataframeClassificationSummaryAccuracy.md +++ b/docs/reference/api/MlEvaluateDataFrameDataframeClassificationSummaryAccuracy.md @@ -1,4 +1,4 @@ -## Interface `MlEvaluateDataFrameDataframeClassificationSummaryAccuracy` +# `MlEvaluateDataFrameDataframeClassificationSummaryAccuracy` [interface-MlEvaluateDataFrameDataframeClassificationSummaryAccuracy] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlEvaluateDataFrameDataframeClassificationSummaryMulticlassConfusionMatrix.md b/docs/reference/api/MlEvaluateDataFrameDataframeClassificationSummaryMulticlassConfusionMatrix.md index bc71b832f..022674494 100644 --- a/docs/reference/api/MlEvaluateDataFrameDataframeClassificationSummaryMulticlassConfusionMatrix.md +++ b/docs/reference/api/MlEvaluateDataFrameDataframeClassificationSummaryMulticlassConfusionMatrix.md @@ -1,4 +1,4 @@ -## Interface `MlEvaluateDataFrameDataframeClassificationSummaryMulticlassConfusionMatrix` +# `MlEvaluateDataFrameDataframeClassificationSummaryMulticlassConfusionMatrix` [interface-MlEvaluateDataFrameDataframeClassificationSummaryMulticlassConfusionMatrix] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlEvaluateDataFrameDataframeClassificationSummaryPrecision.md b/docs/reference/api/MlEvaluateDataFrameDataframeClassificationSummaryPrecision.md index 0f9adf8c1..c934f68f2 100644 --- a/docs/reference/api/MlEvaluateDataFrameDataframeClassificationSummaryPrecision.md +++ b/docs/reference/api/MlEvaluateDataFrameDataframeClassificationSummaryPrecision.md @@ -1,4 +1,4 @@ -## Interface `MlEvaluateDataFrameDataframeClassificationSummaryPrecision` +# `MlEvaluateDataFrameDataframeClassificationSummaryPrecision` [interface-MlEvaluateDataFrameDataframeClassificationSummaryPrecision] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlEvaluateDataFrameDataframeClassificationSummaryRecall.md b/docs/reference/api/MlEvaluateDataFrameDataframeClassificationSummaryRecall.md index 0c29aff0c..fa77e7a00 100644 --- a/docs/reference/api/MlEvaluateDataFrameDataframeClassificationSummaryRecall.md +++ b/docs/reference/api/MlEvaluateDataFrameDataframeClassificationSummaryRecall.md @@ -1,4 +1,4 @@ -## Interface `MlEvaluateDataFrameDataframeClassificationSummaryRecall` +# `MlEvaluateDataFrameDataframeClassificationSummaryRecall` [interface-MlEvaluateDataFrameDataframeClassificationSummaryRecall] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlEvaluateDataFrameDataframeEvaluationClass.md b/docs/reference/api/MlEvaluateDataFrameDataframeEvaluationClass.md index 4f5ba990c..a13c0a88c 100644 --- a/docs/reference/api/MlEvaluateDataFrameDataframeEvaluationClass.md +++ b/docs/reference/api/MlEvaluateDataFrameDataframeEvaluationClass.md @@ -1,4 +1,4 @@ -## Interface `MlEvaluateDataFrameDataframeEvaluationClass` +# `MlEvaluateDataFrameDataframeEvaluationClass` [interface-MlEvaluateDataFrameDataframeEvaluationClass] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlEvaluateDataFrameDataframeEvaluationSummaryAucRoc.md b/docs/reference/api/MlEvaluateDataFrameDataframeEvaluationSummaryAucRoc.md index 7a41812aa..eb8c56d1f 100644 --- a/docs/reference/api/MlEvaluateDataFrameDataframeEvaluationSummaryAucRoc.md +++ b/docs/reference/api/MlEvaluateDataFrameDataframeEvaluationSummaryAucRoc.md @@ -1,4 +1,4 @@ -## Interface `MlEvaluateDataFrameDataframeEvaluationSummaryAucRoc` +# `MlEvaluateDataFrameDataframeEvaluationSummaryAucRoc` [interface-MlEvaluateDataFrameDataframeEvaluationSummaryAucRoc] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlEvaluateDataFrameDataframeEvaluationSummaryAucRocCurveItem.md b/docs/reference/api/MlEvaluateDataFrameDataframeEvaluationSummaryAucRocCurveItem.md index f5401d9c2..cd7b61e70 100644 --- a/docs/reference/api/MlEvaluateDataFrameDataframeEvaluationSummaryAucRocCurveItem.md +++ b/docs/reference/api/MlEvaluateDataFrameDataframeEvaluationSummaryAucRocCurveItem.md @@ -1,4 +1,4 @@ -## Interface `MlEvaluateDataFrameDataframeEvaluationSummaryAucRocCurveItem` +# `MlEvaluateDataFrameDataframeEvaluationSummaryAucRocCurveItem` [interface-MlEvaluateDataFrameDataframeEvaluationSummaryAucRocCurveItem] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlEvaluateDataFrameDataframeEvaluationValue.md b/docs/reference/api/MlEvaluateDataFrameDataframeEvaluationValue.md index d314aa0b8..51f93981e 100644 --- a/docs/reference/api/MlEvaluateDataFrameDataframeEvaluationValue.md +++ b/docs/reference/api/MlEvaluateDataFrameDataframeEvaluationValue.md @@ -1,4 +1,4 @@ -## Interface `MlEvaluateDataFrameDataframeEvaluationValue` +# `MlEvaluateDataFrameDataframeEvaluationValue` [interface-MlEvaluateDataFrameDataframeEvaluationValue] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlEvaluateDataFrameDataframeOutlierDetectionSummary.md b/docs/reference/api/MlEvaluateDataFrameDataframeOutlierDetectionSummary.md index 7c137c674..b0757dfd0 100644 --- a/docs/reference/api/MlEvaluateDataFrameDataframeOutlierDetectionSummary.md +++ b/docs/reference/api/MlEvaluateDataFrameDataframeOutlierDetectionSummary.md @@ -1,4 +1,4 @@ -## Interface `MlEvaluateDataFrameDataframeOutlierDetectionSummary` +# `MlEvaluateDataFrameDataframeOutlierDetectionSummary` [interface-MlEvaluateDataFrameDataframeOutlierDetectionSummary] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlEvaluateDataFrameDataframeRegressionSummary.md b/docs/reference/api/MlEvaluateDataFrameDataframeRegressionSummary.md index 76b215768..20fd3ef27 100644 --- a/docs/reference/api/MlEvaluateDataFrameDataframeRegressionSummary.md +++ b/docs/reference/api/MlEvaluateDataFrameDataframeRegressionSummary.md @@ -1,4 +1,4 @@ -## Interface `MlEvaluateDataFrameDataframeRegressionSummary` +# `MlEvaluateDataFrameDataframeRegressionSummary` [interface-MlEvaluateDataFrameDataframeRegressionSummary] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlEvaluateDataFrameRequest.md b/docs/reference/api/MlEvaluateDataFrameRequest.md index 3f2e4d8c2..020daadc9 100644 --- a/docs/reference/api/MlEvaluateDataFrameRequest.md +++ b/docs/reference/api/MlEvaluateDataFrameRequest.md @@ -1,4 +1,4 @@ -## Interface `MlEvaluateDataFrameRequest` +# `MlEvaluateDataFrameRequest` [interface-MlEvaluateDataFrameRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlEvaluateDataFrameResponse.md b/docs/reference/api/MlEvaluateDataFrameResponse.md index 9e0cc007c..c35beece4 100644 --- a/docs/reference/api/MlEvaluateDataFrameResponse.md +++ b/docs/reference/api/MlEvaluateDataFrameResponse.md @@ -1,4 +1,4 @@ -## Interface `MlEvaluateDataFrameResponse` +# `MlEvaluateDataFrameResponse` [interface-MlEvaluateDataFrameResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlExcludeFrequent.md b/docs/reference/api/MlExcludeFrequent.md index 915b6d90d..06a652efa 100644 --- a/docs/reference/api/MlExcludeFrequent.md +++ b/docs/reference/api/MlExcludeFrequent.md @@ -1,4 +1,4 @@ -## `MlExcludeFrequent` -::: +# `MlExcludeFrequent` [alias-MlExcludeFrequent] +```typescript type MlExcludeFrequent = 'all' | 'none' | 'by' | 'over'; -::: +``` diff --git a/docs/reference/api/MlExplainDataFrameAnalyticsRequest.md b/docs/reference/api/MlExplainDataFrameAnalyticsRequest.md index d18cb0287..b4c7f9ce8 100644 --- a/docs/reference/api/MlExplainDataFrameAnalyticsRequest.md +++ b/docs/reference/api/MlExplainDataFrameAnalyticsRequest.md @@ -1,4 +1,4 @@ -## Interface `MlExplainDataFrameAnalyticsRequest` +# `MlExplainDataFrameAnalyticsRequest` [interface-MlExplainDataFrameAnalyticsRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlExplainDataFrameAnalyticsResponse.md b/docs/reference/api/MlExplainDataFrameAnalyticsResponse.md index b40cc833f..a6582c4f4 100644 --- a/docs/reference/api/MlExplainDataFrameAnalyticsResponse.md +++ b/docs/reference/api/MlExplainDataFrameAnalyticsResponse.md @@ -1,4 +1,4 @@ -## Interface `MlExplainDataFrameAnalyticsResponse` +# `MlExplainDataFrameAnalyticsResponse` [interface-MlExplainDataFrameAnalyticsResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlExponentialAverageCalculationContext.md b/docs/reference/api/MlExponentialAverageCalculationContext.md index 82a73b37a..681f60c38 100644 --- a/docs/reference/api/MlExponentialAverageCalculationContext.md +++ b/docs/reference/api/MlExponentialAverageCalculationContext.md @@ -1,4 +1,4 @@ -## Interface `MlExponentialAverageCalculationContext` +# `MlExponentialAverageCalculationContext` [interface-MlExponentialAverageCalculationContext] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlFeatureExtractor.md b/docs/reference/api/MlFeatureExtractor.md index 37d8ee7fa..a756ecc16 100644 --- a/docs/reference/api/MlFeatureExtractor.md +++ b/docs/reference/api/MlFeatureExtractor.md @@ -1,4 +1,4 @@ -## `MlFeatureExtractor` -::: +# `MlFeatureExtractor` [alias-MlFeatureExtractor] +```typescript type MlFeatureExtractor = [MlQueryFeatureExtractor](./MlQueryFeatureExtractor.md); -::: +``` diff --git a/docs/reference/api/MlFillMaskInferenceOptions.md b/docs/reference/api/MlFillMaskInferenceOptions.md index 83d82b2a7..adeb6e037 100644 --- a/docs/reference/api/MlFillMaskInferenceOptions.md +++ b/docs/reference/api/MlFillMaskInferenceOptions.md @@ -1,4 +1,4 @@ -## Interface `MlFillMaskInferenceOptions` +# `MlFillMaskInferenceOptions` [interface-MlFillMaskInferenceOptions] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlFillMaskInferenceUpdateOptions.md b/docs/reference/api/MlFillMaskInferenceUpdateOptions.md index ca8505889..057f59f37 100644 --- a/docs/reference/api/MlFillMaskInferenceUpdateOptions.md +++ b/docs/reference/api/MlFillMaskInferenceUpdateOptions.md @@ -1,4 +1,4 @@ -## Interface `MlFillMaskInferenceUpdateOptions` +# `MlFillMaskInferenceUpdateOptions` [interface-MlFillMaskInferenceUpdateOptions] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlFilter.md b/docs/reference/api/MlFilter.md index 53971c0ba..21e612646 100644 --- a/docs/reference/api/MlFilter.md +++ b/docs/reference/api/MlFilter.md @@ -1,4 +1,4 @@ -## Interface `MlFilter` +# `MlFilter` [interface-MlFilter] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlFilterRef.md b/docs/reference/api/MlFilterRef.md index d438c14d9..c405230b6 100644 --- a/docs/reference/api/MlFilterRef.md +++ b/docs/reference/api/MlFilterRef.md @@ -1,4 +1,4 @@ -## Interface `MlFilterRef` +# `MlFilterRef` [interface-MlFilterRef] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlFilterType.md b/docs/reference/api/MlFilterType.md index 5b9b422f1..27d91dfd0 100644 --- a/docs/reference/api/MlFilterType.md +++ b/docs/reference/api/MlFilterType.md @@ -1,4 +1,4 @@ -## `MlFilterType` -::: +# `MlFilterType` [alias-MlFilterType] +```typescript type MlFilterType = 'include' | 'exclude'; -::: +``` diff --git a/docs/reference/api/MlFlushJobRequest.md b/docs/reference/api/MlFlushJobRequest.md index e71a1c522..986185d28 100644 --- a/docs/reference/api/MlFlushJobRequest.md +++ b/docs/reference/api/MlFlushJobRequest.md @@ -1,4 +1,4 @@ -## Interface `MlFlushJobRequest` +# `MlFlushJobRequest` [interface-MlFlushJobRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlFlushJobResponse.md b/docs/reference/api/MlFlushJobResponse.md index 63626a144..76d3aecd7 100644 --- a/docs/reference/api/MlFlushJobResponse.md +++ b/docs/reference/api/MlFlushJobResponse.md @@ -1,4 +1,4 @@ -## Interface `MlFlushJobResponse` +# `MlFlushJobResponse` [interface-MlFlushJobResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlForecastRequest.md b/docs/reference/api/MlForecastRequest.md index 35969d2b7..00f830708 100644 --- a/docs/reference/api/MlForecastRequest.md +++ b/docs/reference/api/MlForecastRequest.md @@ -1,4 +1,4 @@ -## Interface `MlForecastRequest` +# `MlForecastRequest` [interface-MlForecastRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlForecastResponse.md b/docs/reference/api/MlForecastResponse.md index ee3446162..02f2fd887 100644 --- a/docs/reference/api/MlForecastResponse.md +++ b/docs/reference/api/MlForecastResponse.md @@ -1,4 +1,4 @@ -## Interface `MlForecastResponse` +# `MlForecastResponse` [interface-MlForecastResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlGeoResults.md b/docs/reference/api/MlGeoResults.md index c0661ae8d..c9b2577c6 100644 --- a/docs/reference/api/MlGeoResults.md +++ b/docs/reference/api/MlGeoResults.md @@ -1,4 +1,4 @@ -## Interface `MlGeoResults` +# `MlGeoResults` [interface-MlGeoResults] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlGetBucketsRequest.md b/docs/reference/api/MlGetBucketsRequest.md index 2fcf8e4d8..c0c5e3dfd 100644 --- a/docs/reference/api/MlGetBucketsRequest.md +++ b/docs/reference/api/MlGetBucketsRequest.md @@ -1,4 +1,4 @@ -## Interface `MlGetBucketsRequest` +# `MlGetBucketsRequest` [interface-MlGetBucketsRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlGetBucketsResponse.md b/docs/reference/api/MlGetBucketsResponse.md index 8fbb65975..29416e5ae 100644 --- a/docs/reference/api/MlGetBucketsResponse.md +++ b/docs/reference/api/MlGetBucketsResponse.md @@ -1,4 +1,4 @@ -## Interface `MlGetBucketsResponse` +# `MlGetBucketsResponse` [interface-MlGetBucketsResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlGetCalendarEventsRequest.md b/docs/reference/api/MlGetCalendarEventsRequest.md index 3faf42f42..2951cb3b5 100644 --- a/docs/reference/api/MlGetCalendarEventsRequest.md +++ b/docs/reference/api/MlGetCalendarEventsRequest.md @@ -1,4 +1,4 @@ -## Interface `MlGetCalendarEventsRequest` +# `MlGetCalendarEventsRequest` [interface-MlGetCalendarEventsRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlGetCalendarEventsResponse.md b/docs/reference/api/MlGetCalendarEventsResponse.md index 568675699..02be2816e 100644 --- a/docs/reference/api/MlGetCalendarEventsResponse.md +++ b/docs/reference/api/MlGetCalendarEventsResponse.md @@ -1,4 +1,4 @@ -## Interface `MlGetCalendarEventsResponse` +# `MlGetCalendarEventsResponse` [interface-MlGetCalendarEventsResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlGetCalendarsCalendar.md b/docs/reference/api/MlGetCalendarsCalendar.md index 063a7c507..0ea012975 100644 --- a/docs/reference/api/MlGetCalendarsCalendar.md +++ b/docs/reference/api/MlGetCalendarsCalendar.md @@ -1,4 +1,4 @@ -## Interface `MlGetCalendarsCalendar` +# `MlGetCalendarsCalendar` [interface-MlGetCalendarsCalendar] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlGetCalendarsRequest.md b/docs/reference/api/MlGetCalendarsRequest.md index e87c30933..d222f762d 100644 --- a/docs/reference/api/MlGetCalendarsRequest.md +++ b/docs/reference/api/MlGetCalendarsRequest.md @@ -1,4 +1,4 @@ -## Interface `MlGetCalendarsRequest` +# `MlGetCalendarsRequest` [interface-MlGetCalendarsRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlGetCalendarsResponse.md b/docs/reference/api/MlGetCalendarsResponse.md index d75f774be..d3d9e6e59 100644 --- a/docs/reference/api/MlGetCalendarsResponse.md +++ b/docs/reference/api/MlGetCalendarsResponse.md @@ -1,4 +1,4 @@ -## Interface `MlGetCalendarsResponse` +# `MlGetCalendarsResponse` [interface-MlGetCalendarsResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlGetCategoriesRequest.md b/docs/reference/api/MlGetCategoriesRequest.md index c2797dda7..00f1f2a38 100644 --- a/docs/reference/api/MlGetCategoriesRequest.md +++ b/docs/reference/api/MlGetCategoriesRequest.md @@ -1,4 +1,4 @@ -## Interface `MlGetCategoriesRequest` +# `MlGetCategoriesRequest` [interface-MlGetCategoriesRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlGetCategoriesResponse.md b/docs/reference/api/MlGetCategoriesResponse.md index c34ce1f76..8b23cf7dd 100644 --- a/docs/reference/api/MlGetCategoriesResponse.md +++ b/docs/reference/api/MlGetCategoriesResponse.md @@ -1,4 +1,4 @@ -## Interface `MlGetCategoriesResponse` +# `MlGetCategoriesResponse` [interface-MlGetCategoriesResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlGetDataFrameAnalyticsRequest.md b/docs/reference/api/MlGetDataFrameAnalyticsRequest.md index 23d39ef24..9c685f71f 100644 --- a/docs/reference/api/MlGetDataFrameAnalyticsRequest.md +++ b/docs/reference/api/MlGetDataFrameAnalyticsRequest.md @@ -1,4 +1,4 @@ -## Interface `MlGetDataFrameAnalyticsRequest` +# `MlGetDataFrameAnalyticsRequest` [interface-MlGetDataFrameAnalyticsRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlGetDataFrameAnalyticsResponse.md b/docs/reference/api/MlGetDataFrameAnalyticsResponse.md index 9567e6a6f..1d4cc440b 100644 --- a/docs/reference/api/MlGetDataFrameAnalyticsResponse.md +++ b/docs/reference/api/MlGetDataFrameAnalyticsResponse.md @@ -1,4 +1,4 @@ -## Interface `MlGetDataFrameAnalyticsResponse` +# `MlGetDataFrameAnalyticsResponse` [interface-MlGetDataFrameAnalyticsResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlGetDataFrameAnalyticsStatsRequest.md b/docs/reference/api/MlGetDataFrameAnalyticsStatsRequest.md index 4bb5b169b..f410328e2 100644 --- a/docs/reference/api/MlGetDataFrameAnalyticsStatsRequest.md +++ b/docs/reference/api/MlGetDataFrameAnalyticsStatsRequest.md @@ -1,4 +1,4 @@ -## Interface `MlGetDataFrameAnalyticsStatsRequest` +# `MlGetDataFrameAnalyticsStatsRequest` [interface-MlGetDataFrameAnalyticsStatsRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlGetDataFrameAnalyticsStatsResponse.md b/docs/reference/api/MlGetDataFrameAnalyticsStatsResponse.md index 465b91877..0bf8c705e 100644 --- a/docs/reference/api/MlGetDataFrameAnalyticsStatsResponse.md +++ b/docs/reference/api/MlGetDataFrameAnalyticsStatsResponse.md @@ -1,4 +1,4 @@ -## Interface `MlGetDataFrameAnalyticsStatsResponse` +# `MlGetDataFrameAnalyticsStatsResponse` [interface-MlGetDataFrameAnalyticsStatsResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlGetDatafeedStatsRequest.md b/docs/reference/api/MlGetDatafeedStatsRequest.md index 29196de21..78ac54086 100644 --- a/docs/reference/api/MlGetDatafeedStatsRequest.md +++ b/docs/reference/api/MlGetDatafeedStatsRequest.md @@ -1,4 +1,4 @@ -## Interface `MlGetDatafeedStatsRequest` +# `MlGetDatafeedStatsRequest` [interface-MlGetDatafeedStatsRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlGetDatafeedStatsResponse.md b/docs/reference/api/MlGetDatafeedStatsResponse.md index 301736e2c..620be8cfb 100644 --- a/docs/reference/api/MlGetDatafeedStatsResponse.md +++ b/docs/reference/api/MlGetDatafeedStatsResponse.md @@ -1,4 +1,4 @@ -## Interface `MlGetDatafeedStatsResponse` +# `MlGetDatafeedStatsResponse` [interface-MlGetDatafeedStatsResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlGetDatafeedsRequest.md b/docs/reference/api/MlGetDatafeedsRequest.md index af552e22a..2514097e1 100644 --- a/docs/reference/api/MlGetDatafeedsRequest.md +++ b/docs/reference/api/MlGetDatafeedsRequest.md @@ -1,4 +1,4 @@ -## Interface `MlGetDatafeedsRequest` +# `MlGetDatafeedsRequest` [interface-MlGetDatafeedsRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlGetDatafeedsResponse.md b/docs/reference/api/MlGetDatafeedsResponse.md index 6f8e27fbc..efd5283d7 100644 --- a/docs/reference/api/MlGetDatafeedsResponse.md +++ b/docs/reference/api/MlGetDatafeedsResponse.md @@ -1,4 +1,4 @@ -## Interface `MlGetDatafeedsResponse` +# `MlGetDatafeedsResponse` [interface-MlGetDatafeedsResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlGetFiltersRequest.md b/docs/reference/api/MlGetFiltersRequest.md index 06f63ab61..3d0410f10 100644 --- a/docs/reference/api/MlGetFiltersRequest.md +++ b/docs/reference/api/MlGetFiltersRequest.md @@ -1,4 +1,4 @@ -## Interface `MlGetFiltersRequest` +# `MlGetFiltersRequest` [interface-MlGetFiltersRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlGetFiltersResponse.md b/docs/reference/api/MlGetFiltersResponse.md index 4099d21a2..be4909c4e 100644 --- a/docs/reference/api/MlGetFiltersResponse.md +++ b/docs/reference/api/MlGetFiltersResponse.md @@ -1,4 +1,4 @@ -## Interface `MlGetFiltersResponse` +# `MlGetFiltersResponse` [interface-MlGetFiltersResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlGetInfluencersRequest.md b/docs/reference/api/MlGetInfluencersRequest.md index a0fc89862..d3cc0bb78 100644 --- a/docs/reference/api/MlGetInfluencersRequest.md +++ b/docs/reference/api/MlGetInfluencersRequest.md @@ -1,4 +1,4 @@ -## Interface `MlGetInfluencersRequest` +# `MlGetInfluencersRequest` [interface-MlGetInfluencersRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlGetInfluencersResponse.md b/docs/reference/api/MlGetInfluencersResponse.md index 78386e25d..a9c138b31 100644 --- a/docs/reference/api/MlGetInfluencersResponse.md +++ b/docs/reference/api/MlGetInfluencersResponse.md @@ -1,4 +1,4 @@ -## Interface `MlGetInfluencersResponse` +# `MlGetInfluencersResponse` [interface-MlGetInfluencersResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlGetJobStatsRequest.md b/docs/reference/api/MlGetJobStatsRequest.md index e475eecea..92276ae93 100644 --- a/docs/reference/api/MlGetJobStatsRequest.md +++ b/docs/reference/api/MlGetJobStatsRequest.md @@ -1,4 +1,4 @@ -## Interface `MlGetJobStatsRequest` +# `MlGetJobStatsRequest` [interface-MlGetJobStatsRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlGetJobStatsResponse.md b/docs/reference/api/MlGetJobStatsResponse.md index 2dae75012..be520d914 100644 --- a/docs/reference/api/MlGetJobStatsResponse.md +++ b/docs/reference/api/MlGetJobStatsResponse.md @@ -1,4 +1,4 @@ -## Interface `MlGetJobStatsResponse` +# `MlGetJobStatsResponse` [interface-MlGetJobStatsResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlGetJobsRequest.md b/docs/reference/api/MlGetJobsRequest.md index 2389a0a91..270211d04 100644 --- a/docs/reference/api/MlGetJobsRequest.md +++ b/docs/reference/api/MlGetJobsRequest.md @@ -1,4 +1,4 @@ -## Interface `MlGetJobsRequest` +# `MlGetJobsRequest` [interface-MlGetJobsRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlGetJobsResponse.md b/docs/reference/api/MlGetJobsResponse.md index 664f49d46..64d8e695f 100644 --- a/docs/reference/api/MlGetJobsResponse.md +++ b/docs/reference/api/MlGetJobsResponse.md @@ -1,4 +1,4 @@ -## Interface `MlGetJobsResponse` +# `MlGetJobsResponse` [interface-MlGetJobsResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlGetMemoryStatsJvmStats.md b/docs/reference/api/MlGetMemoryStatsJvmStats.md index 71b8619e3..ae90fffac 100644 --- a/docs/reference/api/MlGetMemoryStatsJvmStats.md +++ b/docs/reference/api/MlGetMemoryStatsJvmStats.md @@ -1,4 +1,4 @@ -## Interface `MlGetMemoryStatsJvmStats` +# `MlGetMemoryStatsJvmStats` [interface-MlGetMemoryStatsJvmStats] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlGetMemoryStatsMemMlStats.md b/docs/reference/api/MlGetMemoryStatsMemMlStats.md index 0f8e734df..887a31563 100644 --- a/docs/reference/api/MlGetMemoryStatsMemMlStats.md +++ b/docs/reference/api/MlGetMemoryStatsMemMlStats.md @@ -1,4 +1,4 @@ -## Interface `MlGetMemoryStatsMemMlStats` +# `MlGetMemoryStatsMemMlStats` [interface-MlGetMemoryStatsMemMlStats] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlGetMemoryStatsMemStats.md b/docs/reference/api/MlGetMemoryStatsMemStats.md index aa78101c8..4f4ed8469 100644 --- a/docs/reference/api/MlGetMemoryStatsMemStats.md +++ b/docs/reference/api/MlGetMemoryStatsMemStats.md @@ -1,4 +1,4 @@ -## Interface `MlGetMemoryStatsMemStats` +# `MlGetMemoryStatsMemStats` [interface-MlGetMemoryStatsMemStats] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlGetMemoryStatsMemory.md b/docs/reference/api/MlGetMemoryStatsMemory.md index 32d04bccb..e67d6847c 100644 --- a/docs/reference/api/MlGetMemoryStatsMemory.md +++ b/docs/reference/api/MlGetMemoryStatsMemory.md @@ -1,4 +1,4 @@ -## Interface `MlGetMemoryStatsMemory` +# `MlGetMemoryStatsMemory` [interface-MlGetMemoryStatsMemory] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlGetMemoryStatsRequest.md b/docs/reference/api/MlGetMemoryStatsRequest.md index a953a70f3..b5aa34cf8 100644 --- a/docs/reference/api/MlGetMemoryStatsRequest.md +++ b/docs/reference/api/MlGetMemoryStatsRequest.md @@ -1,4 +1,4 @@ -## Interface `MlGetMemoryStatsRequest` +# `MlGetMemoryStatsRequest` [interface-MlGetMemoryStatsRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlGetMemoryStatsResponse.md b/docs/reference/api/MlGetMemoryStatsResponse.md index 7ed3040ef..525121370 100644 --- a/docs/reference/api/MlGetMemoryStatsResponse.md +++ b/docs/reference/api/MlGetMemoryStatsResponse.md @@ -1,4 +1,4 @@ -## Interface `MlGetMemoryStatsResponse` +# `MlGetMemoryStatsResponse` [interface-MlGetMemoryStatsResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlGetModelSnapshotUpgradeStatsRequest.md b/docs/reference/api/MlGetModelSnapshotUpgradeStatsRequest.md index c12c87ea3..e6d3b9554 100644 --- a/docs/reference/api/MlGetModelSnapshotUpgradeStatsRequest.md +++ b/docs/reference/api/MlGetModelSnapshotUpgradeStatsRequest.md @@ -1,4 +1,4 @@ -## Interface `MlGetModelSnapshotUpgradeStatsRequest` +# `MlGetModelSnapshotUpgradeStatsRequest` [interface-MlGetModelSnapshotUpgradeStatsRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlGetModelSnapshotUpgradeStatsResponse.md b/docs/reference/api/MlGetModelSnapshotUpgradeStatsResponse.md index 4fec2ec74..72ea5c8f6 100644 --- a/docs/reference/api/MlGetModelSnapshotUpgradeStatsResponse.md +++ b/docs/reference/api/MlGetModelSnapshotUpgradeStatsResponse.md @@ -1,4 +1,4 @@ -## Interface `MlGetModelSnapshotUpgradeStatsResponse` +# `MlGetModelSnapshotUpgradeStatsResponse` [interface-MlGetModelSnapshotUpgradeStatsResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlGetModelSnapshotsRequest.md b/docs/reference/api/MlGetModelSnapshotsRequest.md index eedf1a833..37bfa3ec0 100644 --- a/docs/reference/api/MlGetModelSnapshotsRequest.md +++ b/docs/reference/api/MlGetModelSnapshotsRequest.md @@ -1,4 +1,4 @@ -## Interface `MlGetModelSnapshotsRequest` +# `MlGetModelSnapshotsRequest` [interface-MlGetModelSnapshotsRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlGetModelSnapshotsResponse.md b/docs/reference/api/MlGetModelSnapshotsResponse.md index b17683846..9cec85628 100644 --- a/docs/reference/api/MlGetModelSnapshotsResponse.md +++ b/docs/reference/api/MlGetModelSnapshotsResponse.md @@ -1,4 +1,4 @@ -## Interface `MlGetModelSnapshotsResponse` +# `MlGetModelSnapshotsResponse` [interface-MlGetModelSnapshotsResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlGetOverallBucketsRequest.md b/docs/reference/api/MlGetOverallBucketsRequest.md index 9aa923560..9fd3c771a 100644 --- a/docs/reference/api/MlGetOverallBucketsRequest.md +++ b/docs/reference/api/MlGetOverallBucketsRequest.md @@ -1,4 +1,4 @@ -## Interface `MlGetOverallBucketsRequest` +# `MlGetOverallBucketsRequest` [interface-MlGetOverallBucketsRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlGetOverallBucketsResponse.md b/docs/reference/api/MlGetOverallBucketsResponse.md index a15617928..f270c2905 100644 --- a/docs/reference/api/MlGetOverallBucketsResponse.md +++ b/docs/reference/api/MlGetOverallBucketsResponse.md @@ -1,4 +1,4 @@ -## Interface `MlGetOverallBucketsResponse` +# `MlGetOverallBucketsResponse` [interface-MlGetOverallBucketsResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlGetRecordsRequest.md b/docs/reference/api/MlGetRecordsRequest.md index b83ffed63..f232772df 100644 --- a/docs/reference/api/MlGetRecordsRequest.md +++ b/docs/reference/api/MlGetRecordsRequest.md @@ -1,4 +1,4 @@ -## Interface `MlGetRecordsRequest` +# `MlGetRecordsRequest` [interface-MlGetRecordsRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlGetRecordsResponse.md b/docs/reference/api/MlGetRecordsResponse.md index a33b0af34..dd143b9e2 100644 --- a/docs/reference/api/MlGetRecordsResponse.md +++ b/docs/reference/api/MlGetRecordsResponse.md @@ -1,4 +1,4 @@ -## Interface `MlGetRecordsResponse` +# `MlGetRecordsResponse` [interface-MlGetRecordsResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlGetTrainedModelsRequest.md b/docs/reference/api/MlGetTrainedModelsRequest.md index 1bd8b6e3e..76469cf92 100644 --- a/docs/reference/api/MlGetTrainedModelsRequest.md +++ b/docs/reference/api/MlGetTrainedModelsRequest.md @@ -1,4 +1,4 @@ -## Interface `MlGetTrainedModelsRequest` +# `MlGetTrainedModelsRequest` [interface-MlGetTrainedModelsRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlGetTrainedModelsResponse.md b/docs/reference/api/MlGetTrainedModelsResponse.md index f9d53be0b..5d4cc17d1 100644 --- a/docs/reference/api/MlGetTrainedModelsResponse.md +++ b/docs/reference/api/MlGetTrainedModelsResponse.md @@ -1,4 +1,4 @@ -## Interface `MlGetTrainedModelsResponse` +# `MlGetTrainedModelsResponse` [interface-MlGetTrainedModelsResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlGetTrainedModelsStatsRequest.md b/docs/reference/api/MlGetTrainedModelsStatsRequest.md index 5b416d91b..05dae8aa7 100644 --- a/docs/reference/api/MlGetTrainedModelsStatsRequest.md +++ b/docs/reference/api/MlGetTrainedModelsStatsRequest.md @@ -1,4 +1,4 @@ -## Interface `MlGetTrainedModelsStatsRequest` +# `MlGetTrainedModelsStatsRequest` [interface-MlGetTrainedModelsStatsRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlGetTrainedModelsStatsResponse.md b/docs/reference/api/MlGetTrainedModelsStatsResponse.md index d3c2092b6..4937351d6 100644 --- a/docs/reference/api/MlGetTrainedModelsStatsResponse.md +++ b/docs/reference/api/MlGetTrainedModelsStatsResponse.md @@ -1,4 +1,4 @@ -## Interface `MlGetTrainedModelsStatsResponse` +# `MlGetTrainedModelsStatsResponse` [interface-MlGetTrainedModelsStatsResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlHyperparameter.md b/docs/reference/api/MlHyperparameter.md index 804399163..6fe97d3dd 100644 --- a/docs/reference/api/MlHyperparameter.md +++ b/docs/reference/api/MlHyperparameter.md @@ -1,4 +1,4 @@ -## Interface `MlHyperparameter` +# `MlHyperparameter` [interface-MlHyperparameter] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlHyperparameters.md b/docs/reference/api/MlHyperparameters.md index e4b7870e1..1d97b935d 100644 --- a/docs/reference/api/MlHyperparameters.md +++ b/docs/reference/api/MlHyperparameters.md @@ -1,4 +1,4 @@ -## Interface `MlHyperparameters` +# `MlHyperparameters` [interface-MlHyperparameters] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlInclude.md b/docs/reference/api/MlInclude.md index cd442795c..2798265a7 100644 --- a/docs/reference/api/MlInclude.md +++ b/docs/reference/api/MlInclude.md @@ -1,4 +1,4 @@ -## `MlInclude` -::: +# `MlInclude` [alias-MlInclude] +```typescript type MlInclude = 'definition' | 'feature_importance_baseline' | 'hyperparameters' | 'total_feature_importance' | 'definition_status'; -::: +``` diff --git a/docs/reference/api/MlInferTrainedModelRequest.md b/docs/reference/api/MlInferTrainedModelRequest.md index 1f1c758a5..e4e652d41 100644 --- a/docs/reference/api/MlInferTrainedModelRequest.md +++ b/docs/reference/api/MlInferTrainedModelRequest.md @@ -1,4 +1,4 @@ -## Interface `MlInferTrainedModelRequest` +# `MlInferTrainedModelRequest` [interface-MlInferTrainedModelRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlInferTrainedModelResponse.md b/docs/reference/api/MlInferTrainedModelResponse.md index 923902d13..ca2fd655e 100644 --- a/docs/reference/api/MlInferTrainedModelResponse.md +++ b/docs/reference/api/MlInferTrainedModelResponse.md @@ -1,4 +1,4 @@ -## Interface `MlInferTrainedModelResponse` +# `MlInferTrainedModelResponse` [interface-MlInferTrainedModelResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlInferenceConfigCreateContainer.md b/docs/reference/api/MlInferenceConfigCreateContainer.md index 40c2cc89e..af242ae02 100644 --- a/docs/reference/api/MlInferenceConfigCreateContainer.md +++ b/docs/reference/api/MlInferenceConfigCreateContainer.md @@ -1,4 +1,4 @@ -## Interface `MlInferenceConfigCreateContainer` +# `MlInferenceConfigCreateContainer` [interface-MlInferenceConfigCreateContainer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlInferenceConfigUpdateContainer.md b/docs/reference/api/MlInferenceConfigUpdateContainer.md index 97ea03655..73b2dcdcc 100644 --- a/docs/reference/api/MlInferenceConfigUpdateContainer.md +++ b/docs/reference/api/MlInferenceConfigUpdateContainer.md @@ -1,4 +1,4 @@ -## Interface `MlInferenceConfigUpdateContainer` +# `MlInferenceConfigUpdateContainer` [interface-MlInferenceConfigUpdateContainer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlInferenceResponseResult.md b/docs/reference/api/MlInferenceResponseResult.md index 46453675f..039b0e36d 100644 --- a/docs/reference/api/MlInferenceResponseResult.md +++ b/docs/reference/api/MlInferenceResponseResult.md @@ -1,4 +1,4 @@ -## Interface `MlInferenceResponseResult` +# `MlInferenceResponseResult` [interface-MlInferenceResponseResult] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlInfluence.md b/docs/reference/api/MlInfluence.md index 75eb6a08d..18428cddf 100644 --- a/docs/reference/api/MlInfluence.md +++ b/docs/reference/api/MlInfluence.md @@ -1,4 +1,4 @@ -## Interface `MlInfluence` +# `MlInfluence` [interface-MlInfluence] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlInfluencer.md b/docs/reference/api/MlInfluencer.md index 3081a1a77..385f55464 100644 --- a/docs/reference/api/MlInfluencer.md +++ b/docs/reference/api/MlInfluencer.md @@ -1,4 +1,4 @@ -## Interface `MlInfluencer` +# `MlInfluencer` [interface-MlInfluencer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlInfoAnomalyDetectors.md b/docs/reference/api/MlInfoAnomalyDetectors.md index 837238383..3edc9c5da 100644 --- a/docs/reference/api/MlInfoAnomalyDetectors.md +++ b/docs/reference/api/MlInfoAnomalyDetectors.md @@ -1,4 +1,4 @@ -## Interface `MlInfoAnomalyDetectors` +# `MlInfoAnomalyDetectors` [interface-MlInfoAnomalyDetectors] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlInfoDatafeeds.md b/docs/reference/api/MlInfoDatafeeds.md index 0b067500d..6c062eaa2 100644 --- a/docs/reference/api/MlInfoDatafeeds.md +++ b/docs/reference/api/MlInfoDatafeeds.md @@ -1,4 +1,4 @@ -## Interface `MlInfoDatafeeds` +# `MlInfoDatafeeds` [interface-MlInfoDatafeeds] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlInfoDefaults.md b/docs/reference/api/MlInfoDefaults.md index dc6763198..6adc8a657 100644 --- a/docs/reference/api/MlInfoDefaults.md +++ b/docs/reference/api/MlInfoDefaults.md @@ -1,4 +1,4 @@ -## Interface `MlInfoDefaults` +# `MlInfoDefaults` [interface-MlInfoDefaults] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlInfoLimits.md b/docs/reference/api/MlInfoLimits.md index 143655aca..4930c7ae3 100644 --- a/docs/reference/api/MlInfoLimits.md +++ b/docs/reference/api/MlInfoLimits.md @@ -1,4 +1,4 @@ -## Interface `MlInfoLimits` +# `MlInfoLimits` [interface-MlInfoLimits] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlInfoNativeCode.md b/docs/reference/api/MlInfoNativeCode.md index 288b5812d..3d3c4fc12 100644 --- a/docs/reference/api/MlInfoNativeCode.md +++ b/docs/reference/api/MlInfoNativeCode.md @@ -1,4 +1,4 @@ -## Interface `MlInfoNativeCode` +# `MlInfoNativeCode` [interface-MlInfoNativeCode] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlInfoRequest.md b/docs/reference/api/MlInfoRequest.md index 0a8eb8b54..17e4fc75a 100644 --- a/docs/reference/api/MlInfoRequest.md +++ b/docs/reference/api/MlInfoRequest.md @@ -1,4 +1,4 @@ -## Interface `MlInfoRequest` +# `MlInfoRequest` [interface-MlInfoRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlInfoResponse.md b/docs/reference/api/MlInfoResponse.md index 9b2049c36..236dde378 100644 --- a/docs/reference/api/MlInfoResponse.md +++ b/docs/reference/api/MlInfoResponse.md @@ -1,4 +1,4 @@ -## Interface `MlInfoResponse` +# `MlInfoResponse` [interface-MlInfoResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlJob.md b/docs/reference/api/MlJob.md index a81f45932..16dedbf80 100644 --- a/docs/reference/api/MlJob.md +++ b/docs/reference/api/MlJob.md @@ -1,4 +1,4 @@ -## Interface `MlJob` +# `MlJob` [interface-MlJob] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlJobBlocked.md b/docs/reference/api/MlJobBlocked.md index 02f06d8ca..e8ebda834 100644 --- a/docs/reference/api/MlJobBlocked.md +++ b/docs/reference/api/MlJobBlocked.md @@ -1,4 +1,4 @@ -## Interface `MlJobBlocked` +# `MlJobBlocked` [interface-MlJobBlocked] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlJobBlockedReason.md b/docs/reference/api/MlJobBlockedReason.md index ae74655d4..b18ac6012 100644 --- a/docs/reference/api/MlJobBlockedReason.md +++ b/docs/reference/api/MlJobBlockedReason.md @@ -1,4 +1,4 @@ -## `MlJobBlockedReason` -::: +# `MlJobBlockedReason` [alias-MlJobBlockedReason] +```typescript type MlJobBlockedReason = 'delete' | 'reset' | 'revert'; -::: +``` diff --git a/docs/reference/api/MlJobConfig.md b/docs/reference/api/MlJobConfig.md index 17af774ff..72f66905b 100644 --- a/docs/reference/api/MlJobConfig.md +++ b/docs/reference/api/MlJobConfig.md @@ -1,4 +1,4 @@ -## Interface `MlJobConfig` +# `MlJobConfig` [interface-MlJobConfig] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlJobForecastStatistics.md b/docs/reference/api/MlJobForecastStatistics.md index fff3077ab..9968fbf0a 100644 --- a/docs/reference/api/MlJobForecastStatistics.md +++ b/docs/reference/api/MlJobForecastStatistics.md @@ -1,4 +1,4 @@ -## Interface `MlJobForecastStatistics` +# `MlJobForecastStatistics` [interface-MlJobForecastStatistics] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlJobState.md b/docs/reference/api/MlJobState.md index 802e42799..0b24603b4 100644 --- a/docs/reference/api/MlJobState.md +++ b/docs/reference/api/MlJobState.md @@ -1,4 +1,4 @@ -## `MlJobState` -::: +# `MlJobState` [alias-MlJobState] +```typescript type MlJobState = 'closing' | 'closed' | 'opened' | 'failed' | 'opening'; -::: +``` diff --git a/docs/reference/api/MlJobStatistics.md b/docs/reference/api/MlJobStatistics.md index cf507cd56..8eb599885 100644 --- a/docs/reference/api/MlJobStatistics.md +++ b/docs/reference/api/MlJobStatistics.md @@ -1,4 +1,4 @@ -## Interface `MlJobStatistics` +# `MlJobStatistics` [interface-MlJobStatistics] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlJobStats.md b/docs/reference/api/MlJobStats.md index 340b21c37..fb5235864 100644 --- a/docs/reference/api/MlJobStats.md +++ b/docs/reference/api/MlJobStats.md @@ -1,4 +1,4 @@ -## Interface `MlJobStats` +# `MlJobStats` [interface-MlJobStats] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlJobTimingStats.md b/docs/reference/api/MlJobTimingStats.md index e58b1c418..4e88d73b4 100644 --- a/docs/reference/api/MlJobTimingStats.md +++ b/docs/reference/api/MlJobTimingStats.md @@ -1,4 +1,4 @@ -## Interface `MlJobTimingStats` +# `MlJobTimingStats` [interface-MlJobTimingStats] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlLearningToRankConfig.md b/docs/reference/api/MlLearningToRankConfig.md index 5f390a3b6..ff330fba8 100644 --- a/docs/reference/api/MlLearningToRankConfig.md +++ b/docs/reference/api/MlLearningToRankConfig.md @@ -1,4 +1,4 @@ -## Interface `MlLearningToRankConfig` +# `MlLearningToRankConfig` [interface-MlLearningToRankConfig] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlMemoryStatus.md b/docs/reference/api/MlMemoryStatus.md index 093328d96..679b8b1e6 100644 --- a/docs/reference/api/MlMemoryStatus.md +++ b/docs/reference/api/MlMemoryStatus.md @@ -1,4 +1,4 @@ -## `MlMemoryStatus` -::: +# `MlMemoryStatus` [alias-MlMemoryStatus] +```typescript type MlMemoryStatus = 'ok' | 'soft_limit' | 'hard_limit'; -::: +``` diff --git a/docs/reference/api/MlModelPackageConfig.md b/docs/reference/api/MlModelPackageConfig.md index 5f948fb0e..a003b887e 100644 --- a/docs/reference/api/MlModelPackageConfig.md +++ b/docs/reference/api/MlModelPackageConfig.md @@ -1,4 +1,4 @@ -## Interface `MlModelPackageConfig` +# `MlModelPackageConfig` [interface-MlModelPackageConfig] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlModelPlotConfig.md b/docs/reference/api/MlModelPlotConfig.md index e645bbb1c..b377d40f4 100644 --- a/docs/reference/api/MlModelPlotConfig.md +++ b/docs/reference/api/MlModelPlotConfig.md @@ -1,4 +1,4 @@ -## Interface `MlModelPlotConfig` +# `MlModelPlotConfig` [interface-MlModelPlotConfig] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlModelSizeStats.md b/docs/reference/api/MlModelSizeStats.md index 7259fcacc..a796228fc 100644 --- a/docs/reference/api/MlModelSizeStats.md +++ b/docs/reference/api/MlModelSizeStats.md @@ -1,4 +1,4 @@ -## Interface `MlModelSizeStats` +# `MlModelSizeStats` [interface-MlModelSizeStats] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlModelSnapshot.md b/docs/reference/api/MlModelSnapshot.md index 7c2eda368..a6553d209 100644 --- a/docs/reference/api/MlModelSnapshot.md +++ b/docs/reference/api/MlModelSnapshot.md @@ -1,4 +1,4 @@ -## Interface `MlModelSnapshot` +# `MlModelSnapshot` [interface-MlModelSnapshot] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlModelSnapshotUpgrade.md b/docs/reference/api/MlModelSnapshotUpgrade.md index 874858c74..6ffdfe565 100644 --- a/docs/reference/api/MlModelSnapshotUpgrade.md +++ b/docs/reference/api/MlModelSnapshotUpgrade.md @@ -1,4 +1,4 @@ -## Interface `MlModelSnapshotUpgrade` +# `MlModelSnapshotUpgrade` [interface-MlModelSnapshotUpgrade] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlNerInferenceOptions.md b/docs/reference/api/MlNerInferenceOptions.md index 049163f9d..05c9fb88e 100644 --- a/docs/reference/api/MlNerInferenceOptions.md +++ b/docs/reference/api/MlNerInferenceOptions.md @@ -1,4 +1,4 @@ -## Interface `MlNerInferenceOptions` +# `MlNerInferenceOptions` [interface-MlNerInferenceOptions] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlNerInferenceUpdateOptions.md b/docs/reference/api/MlNerInferenceUpdateOptions.md index f9565f390..56cc48de8 100644 --- a/docs/reference/api/MlNerInferenceUpdateOptions.md +++ b/docs/reference/api/MlNerInferenceUpdateOptions.md @@ -1,4 +1,4 @@ -## Interface `MlNerInferenceUpdateOptions` +# `MlNerInferenceUpdateOptions` [interface-MlNerInferenceUpdateOptions] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlNlpBertTokenizationConfig.md b/docs/reference/api/MlNlpBertTokenizationConfig.md index 574b9853a..f47291fed 100644 --- a/docs/reference/api/MlNlpBertTokenizationConfig.md +++ b/docs/reference/api/MlNlpBertTokenizationConfig.md @@ -1,4 +1,4 @@ -## Interface `MlNlpBertTokenizationConfig` +# `MlNlpBertTokenizationConfig` [interface-MlNlpBertTokenizationConfig] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlNlpRobertaTokenizationConfig.md b/docs/reference/api/MlNlpRobertaTokenizationConfig.md index 93460432c..fd66c63ea 100644 --- a/docs/reference/api/MlNlpRobertaTokenizationConfig.md +++ b/docs/reference/api/MlNlpRobertaTokenizationConfig.md @@ -1,4 +1,4 @@ -## Interface `MlNlpRobertaTokenizationConfig` +# `MlNlpRobertaTokenizationConfig` [interface-MlNlpRobertaTokenizationConfig] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlNlpTokenizationUpdateOptions.md b/docs/reference/api/MlNlpTokenizationUpdateOptions.md index e1d180db6..fdfb4a6ae 100644 --- a/docs/reference/api/MlNlpTokenizationUpdateOptions.md +++ b/docs/reference/api/MlNlpTokenizationUpdateOptions.md @@ -1,4 +1,4 @@ -## Interface `MlNlpTokenizationUpdateOptions` +# `MlNlpTokenizationUpdateOptions` [interface-MlNlpTokenizationUpdateOptions] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlOpenJobRequest.md b/docs/reference/api/MlOpenJobRequest.md index f3c4ffeb5..5cf3c177c 100644 --- a/docs/reference/api/MlOpenJobRequest.md +++ b/docs/reference/api/MlOpenJobRequest.md @@ -1,4 +1,4 @@ -## Interface `MlOpenJobRequest` +# `MlOpenJobRequest` [interface-MlOpenJobRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlOpenJobResponse.md b/docs/reference/api/MlOpenJobResponse.md index 9286869c6..d8edbfa4c 100644 --- a/docs/reference/api/MlOpenJobResponse.md +++ b/docs/reference/api/MlOpenJobResponse.md @@ -1,4 +1,4 @@ -## Interface `MlOpenJobResponse` +# `MlOpenJobResponse` [interface-MlOpenJobResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlOutlierDetectionParameters.md b/docs/reference/api/MlOutlierDetectionParameters.md index f9579ba7f..d16a75e95 100644 --- a/docs/reference/api/MlOutlierDetectionParameters.md +++ b/docs/reference/api/MlOutlierDetectionParameters.md @@ -1,4 +1,4 @@ -## Interface `MlOutlierDetectionParameters` +# `MlOutlierDetectionParameters` [interface-MlOutlierDetectionParameters] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlOverallBucket.md b/docs/reference/api/MlOverallBucket.md index 723d1b3d7..90abd7360 100644 --- a/docs/reference/api/MlOverallBucket.md +++ b/docs/reference/api/MlOverallBucket.md @@ -1,4 +1,4 @@ -## Interface `MlOverallBucket` +# `MlOverallBucket` [interface-MlOverallBucket] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlOverallBucketJob.md b/docs/reference/api/MlOverallBucketJob.md index 422d0a8b9..87784eb19 100644 --- a/docs/reference/api/MlOverallBucketJob.md +++ b/docs/reference/api/MlOverallBucketJob.md @@ -1,4 +1,4 @@ -## Interface `MlOverallBucketJob` +# `MlOverallBucketJob` [interface-MlOverallBucketJob] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlPage.md b/docs/reference/api/MlPage.md index c7e32abd0..d01e86bd4 100644 --- a/docs/reference/api/MlPage.md +++ b/docs/reference/api/MlPage.md @@ -1,4 +1,4 @@ -## Interface `MlPage` +# `MlPage` [interface-MlPage] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlPassThroughInferenceOptions.md b/docs/reference/api/MlPassThroughInferenceOptions.md index 36f4aab45..75a87a1d8 100644 --- a/docs/reference/api/MlPassThroughInferenceOptions.md +++ b/docs/reference/api/MlPassThroughInferenceOptions.md @@ -1,4 +1,4 @@ -## Interface `MlPassThroughInferenceOptions` +# `MlPassThroughInferenceOptions` [interface-MlPassThroughInferenceOptions] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlPassThroughInferenceUpdateOptions.md b/docs/reference/api/MlPassThroughInferenceUpdateOptions.md index 0558f00ea..290ce1f98 100644 --- a/docs/reference/api/MlPassThroughInferenceUpdateOptions.md +++ b/docs/reference/api/MlPassThroughInferenceUpdateOptions.md @@ -1,4 +1,4 @@ -## Interface `MlPassThroughInferenceUpdateOptions` +# `MlPassThroughInferenceUpdateOptions` [interface-MlPassThroughInferenceUpdateOptions] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlPerPartitionCategorization.md b/docs/reference/api/MlPerPartitionCategorization.md index c2f31b6fb..c738d830b 100644 --- a/docs/reference/api/MlPerPartitionCategorization.md +++ b/docs/reference/api/MlPerPartitionCategorization.md @@ -1,4 +1,4 @@ -## Interface `MlPerPartitionCategorization` +# `MlPerPartitionCategorization` [interface-MlPerPartitionCategorization] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlPostCalendarEventsRequest.md b/docs/reference/api/MlPostCalendarEventsRequest.md index a4e1b0881..6a401bf97 100644 --- a/docs/reference/api/MlPostCalendarEventsRequest.md +++ b/docs/reference/api/MlPostCalendarEventsRequest.md @@ -1,4 +1,4 @@ -## Interface `MlPostCalendarEventsRequest` +# `MlPostCalendarEventsRequest` [interface-MlPostCalendarEventsRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlPostCalendarEventsResponse.md b/docs/reference/api/MlPostCalendarEventsResponse.md index f0c535e21..93cd791ea 100644 --- a/docs/reference/api/MlPostCalendarEventsResponse.md +++ b/docs/reference/api/MlPostCalendarEventsResponse.md @@ -1,4 +1,4 @@ -## Interface `MlPostCalendarEventsResponse` +# `MlPostCalendarEventsResponse` [interface-MlPostCalendarEventsResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlPostDataRequest.md b/docs/reference/api/MlPostDataRequest.md index c14d430ea..ac5aacf36 100644 --- a/docs/reference/api/MlPostDataRequest.md +++ b/docs/reference/api/MlPostDataRequest.md @@ -1,4 +1,4 @@ -## Interface `MlPostDataRequest` +# `MlPostDataRequest` [interface-MlPostDataRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlPostDataResponse.md b/docs/reference/api/MlPostDataResponse.md index 652c7364c..abfb2914c 100644 --- a/docs/reference/api/MlPostDataResponse.md +++ b/docs/reference/api/MlPostDataResponse.md @@ -1,4 +1,4 @@ -## Interface `MlPostDataResponse` +# `MlPostDataResponse` [interface-MlPostDataResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlPredictedValue.md b/docs/reference/api/MlPredictedValue.md index 041fc0ad9..90c4d1655 100644 --- a/docs/reference/api/MlPredictedValue.md +++ b/docs/reference/api/MlPredictedValue.md @@ -1,4 +1,4 @@ -## `MlPredictedValue` -::: +# `MlPredictedValue` [alias-MlPredictedValue] +```typescript type MlPredictedValue = [ScalarValue](./ScalarValue.md) | [ScalarValue](./ScalarValue.md)[]; -::: +``` diff --git a/docs/reference/api/MlPreviewDataFrameAnalyticsDataframePreviewConfig.md b/docs/reference/api/MlPreviewDataFrameAnalyticsDataframePreviewConfig.md index af04f3c4d..9dfc5c49e 100644 --- a/docs/reference/api/MlPreviewDataFrameAnalyticsDataframePreviewConfig.md +++ b/docs/reference/api/MlPreviewDataFrameAnalyticsDataframePreviewConfig.md @@ -1,4 +1,4 @@ -## Interface `MlPreviewDataFrameAnalyticsDataframePreviewConfig` +# `MlPreviewDataFrameAnalyticsDataframePreviewConfig` [interface-MlPreviewDataFrameAnalyticsDataframePreviewConfig] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlPreviewDataFrameAnalyticsRequest.md b/docs/reference/api/MlPreviewDataFrameAnalyticsRequest.md index 9f2782880..3bd7f3e5d 100644 --- a/docs/reference/api/MlPreviewDataFrameAnalyticsRequest.md +++ b/docs/reference/api/MlPreviewDataFrameAnalyticsRequest.md @@ -1,4 +1,4 @@ -## Interface `MlPreviewDataFrameAnalyticsRequest` +# `MlPreviewDataFrameAnalyticsRequest` [interface-MlPreviewDataFrameAnalyticsRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlPreviewDataFrameAnalyticsResponse.md b/docs/reference/api/MlPreviewDataFrameAnalyticsResponse.md index c6e3b8c3d..bb972e636 100644 --- a/docs/reference/api/MlPreviewDataFrameAnalyticsResponse.md +++ b/docs/reference/api/MlPreviewDataFrameAnalyticsResponse.md @@ -1,4 +1,4 @@ -## Interface `MlPreviewDataFrameAnalyticsResponse` +# `MlPreviewDataFrameAnalyticsResponse` [interface-MlPreviewDataFrameAnalyticsResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlPreviewDatafeedRequest.md b/docs/reference/api/MlPreviewDatafeedRequest.md index 3877f87ba..b7bd67606 100644 --- a/docs/reference/api/MlPreviewDatafeedRequest.md +++ b/docs/reference/api/MlPreviewDatafeedRequest.md @@ -1,4 +1,4 @@ -## Interface `MlPreviewDatafeedRequest` +# `MlPreviewDatafeedRequest` [interface-MlPreviewDatafeedRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlPreviewDatafeedResponse.md b/docs/reference/api/MlPreviewDatafeedResponse.md index 70ff5fefa..2af49a955 100644 --- a/docs/reference/api/MlPreviewDatafeedResponse.md +++ b/docs/reference/api/MlPreviewDatafeedResponse.md @@ -1,4 +1,4 @@ -## `MlPreviewDatafeedResponse` -::: +# `MlPreviewDatafeedResponse` [alias-MlPreviewDatafeedResponse] +```typescript type MlPreviewDatafeedResponse = TDocument[]; -::: +``` diff --git a/docs/reference/api/MlPutCalendarJobRequest.md b/docs/reference/api/MlPutCalendarJobRequest.md index 26b99ae65..896851814 100644 --- a/docs/reference/api/MlPutCalendarJobRequest.md +++ b/docs/reference/api/MlPutCalendarJobRequest.md @@ -1,4 +1,4 @@ -## Interface `MlPutCalendarJobRequest` +# `MlPutCalendarJobRequest` [interface-MlPutCalendarJobRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlPutCalendarJobResponse.md b/docs/reference/api/MlPutCalendarJobResponse.md index 7d77aca11..10e5ceee2 100644 --- a/docs/reference/api/MlPutCalendarJobResponse.md +++ b/docs/reference/api/MlPutCalendarJobResponse.md @@ -1,4 +1,4 @@ -## Interface `MlPutCalendarJobResponse` +# `MlPutCalendarJobResponse` [interface-MlPutCalendarJobResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlPutCalendarRequest.md b/docs/reference/api/MlPutCalendarRequest.md index f7dca65c7..6ba52d637 100644 --- a/docs/reference/api/MlPutCalendarRequest.md +++ b/docs/reference/api/MlPutCalendarRequest.md @@ -1,4 +1,4 @@ -## Interface `MlPutCalendarRequest` +# `MlPutCalendarRequest` [interface-MlPutCalendarRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlPutCalendarResponse.md b/docs/reference/api/MlPutCalendarResponse.md index e357a20b6..fc903d367 100644 --- a/docs/reference/api/MlPutCalendarResponse.md +++ b/docs/reference/api/MlPutCalendarResponse.md @@ -1,4 +1,4 @@ -## Interface `MlPutCalendarResponse` +# `MlPutCalendarResponse` [interface-MlPutCalendarResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlPutDataFrameAnalyticsRequest.md b/docs/reference/api/MlPutDataFrameAnalyticsRequest.md index b3520eb95..86ab3b66e 100644 --- a/docs/reference/api/MlPutDataFrameAnalyticsRequest.md +++ b/docs/reference/api/MlPutDataFrameAnalyticsRequest.md @@ -1,4 +1,4 @@ -## Interface `MlPutDataFrameAnalyticsRequest` +# `MlPutDataFrameAnalyticsRequest` [interface-MlPutDataFrameAnalyticsRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlPutDataFrameAnalyticsResponse.md b/docs/reference/api/MlPutDataFrameAnalyticsResponse.md index e395c0dea..4b40483e0 100644 --- a/docs/reference/api/MlPutDataFrameAnalyticsResponse.md +++ b/docs/reference/api/MlPutDataFrameAnalyticsResponse.md @@ -1,4 +1,4 @@ -## Interface `MlPutDataFrameAnalyticsResponse` +# `MlPutDataFrameAnalyticsResponse` [interface-MlPutDataFrameAnalyticsResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlPutDatafeedRequest.md b/docs/reference/api/MlPutDatafeedRequest.md index 3f00514d6..c8961555d 100644 --- a/docs/reference/api/MlPutDatafeedRequest.md +++ b/docs/reference/api/MlPutDatafeedRequest.md @@ -1,4 +1,4 @@ -## Interface `MlPutDatafeedRequest` +# `MlPutDatafeedRequest` [interface-MlPutDatafeedRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlPutDatafeedResponse.md b/docs/reference/api/MlPutDatafeedResponse.md index f2dd15e19..07bdd2545 100644 --- a/docs/reference/api/MlPutDatafeedResponse.md +++ b/docs/reference/api/MlPutDatafeedResponse.md @@ -1,4 +1,4 @@ -## Interface `MlPutDatafeedResponse` +# `MlPutDatafeedResponse` [interface-MlPutDatafeedResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlPutFilterRequest.md b/docs/reference/api/MlPutFilterRequest.md index 6f151a96e..0c6b6580c 100644 --- a/docs/reference/api/MlPutFilterRequest.md +++ b/docs/reference/api/MlPutFilterRequest.md @@ -1,4 +1,4 @@ -## Interface `MlPutFilterRequest` +# `MlPutFilterRequest` [interface-MlPutFilterRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlPutFilterResponse.md b/docs/reference/api/MlPutFilterResponse.md index 8cd1e9ad1..8e1d1c4ad 100644 --- a/docs/reference/api/MlPutFilterResponse.md +++ b/docs/reference/api/MlPutFilterResponse.md @@ -1,4 +1,4 @@ -## Interface `MlPutFilterResponse` +# `MlPutFilterResponse` [interface-MlPutFilterResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlPutJobRequest.md b/docs/reference/api/MlPutJobRequest.md index 9ee952c95..1d044cc85 100644 --- a/docs/reference/api/MlPutJobRequest.md +++ b/docs/reference/api/MlPutJobRequest.md @@ -1,4 +1,4 @@ -## Interface `MlPutJobRequest` +# `MlPutJobRequest` [interface-MlPutJobRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlPutJobResponse.md b/docs/reference/api/MlPutJobResponse.md index 26c9a86cd..b91d42480 100644 --- a/docs/reference/api/MlPutJobResponse.md +++ b/docs/reference/api/MlPutJobResponse.md @@ -1,4 +1,4 @@ -## Interface `MlPutJobResponse` +# `MlPutJobResponse` [interface-MlPutJobResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlPutTrainedModelAggregateOutput.md b/docs/reference/api/MlPutTrainedModelAggregateOutput.md index 85c03f627..96e2bfac9 100644 --- a/docs/reference/api/MlPutTrainedModelAggregateOutput.md +++ b/docs/reference/api/MlPutTrainedModelAggregateOutput.md @@ -1,4 +1,4 @@ -## Interface `MlPutTrainedModelAggregateOutput` +# `MlPutTrainedModelAggregateOutput` [interface-MlPutTrainedModelAggregateOutput] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlPutTrainedModelAliasRequest.md b/docs/reference/api/MlPutTrainedModelAliasRequest.md index 1d10775d9..e14607dbf 100644 --- a/docs/reference/api/MlPutTrainedModelAliasRequest.md +++ b/docs/reference/api/MlPutTrainedModelAliasRequest.md @@ -1,4 +1,4 @@ -## Interface `MlPutTrainedModelAliasRequest` +# `MlPutTrainedModelAliasRequest` [interface-MlPutTrainedModelAliasRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlPutTrainedModelAliasResponse.md b/docs/reference/api/MlPutTrainedModelAliasResponse.md index d33022520..304f16b77 100644 --- a/docs/reference/api/MlPutTrainedModelAliasResponse.md +++ b/docs/reference/api/MlPutTrainedModelAliasResponse.md @@ -1,4 +1,4 @@ -## `MlPutTrainedModelAliasResponse` -::: +# `MlPutTrainedModelAliasResponse` [alias-MlPutTrainedModelAliasResponse] +```typescript type MlPutTrainedModelAliasResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); -::: +``` diff --git a/docs/reference/api/MlPutTrainedModelDefinition.md b/docs/reference/api/MlPutTrainedModelDefinition.md index ca55f0152..22ee744b8 100644 --- a/docs/reference/api/MlPutTrainedModelDefinition.md +++ b/docs/reference/api/MlPutTrainedModelDefinition.md @@ -1,4 +1,4 @@ -## Interface `MlPutTrainedModelDefinition` +# `MlPutTrainedModelDefinition` [interface-MlPutTrainedModelDefinition] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlPutTrainedModelDefinitionPartRequest.md b/docs/reference/api/MlPutTrainedModelDefinitionPartRequest.md index 16f581e01..3841e624d 100644 --- a/docs/reference/api/MlPutTrainedModelDefinitionPartRequest.md +++ b/docs/reference/api/MlPutTrainedModelDefinitionPartRequest.md @@ -1,4 +1,4 @@ -## Interface `MlPutTrainedModelDefinitionPartRequest` +# `MlPutTrainedModelDefinitionPartRequest` [interface-MlPutTrainedModelDefinitionPartRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlPutTrainedModelDefinitionPartResponse.md b/docs/reference/api/MlPutTrainedModelDefinitionPartResponse.md index 36c2d5a73..f38240f61 100644 --- a/docs/reference/api/MlPutTrainedModelDefinitionPartResponse.md +++ b/docs/reference/api/MlPutTrainedModelDefinitionPartResponse.md @@ -1,4 +1,4 @@ -## `MlPutTrainedModelDefinitionPartResponse` -::: +# `MlPutTrainedModelDefinitionPartResponse` [alias-MlPutTrainedModelDefinitionPartResponse] +```typescript type MlPutTrainedModelDefinitionPartResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); -::: +``` diff --git a/docs/reference/api/MlPutTrainedModelEnsemble.md b/docs/reference/api/MlPutTrainedModelEnsemble.md index 1f3922b5d..eeb77a1d1 100644 --- a/docs/reference/api/MlPutTrainedModelEnsemble.md +++ b/docs/reference/api/MlPutTrainedModelEnsemble.md @@ -1,4 +1,4 @@ -## Interface `MlPutTrainedModelEnsemble` +# `MlPutTrainedModelEnsemble` [interface-MlPutTrainedModelEnsemble] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlPutTrainedModelFrequencyEncodingPreprocessor.md b/docs/reference/api/MlPutTrainedModelFrequencyEncodingPreprocessor.md index 2b344bc83..e7b61b2a4 100644 --- a/docs/reference/api/MlPutTrainedModelFrequencyEncodingPreprocessor.md +++ b/docs/reference/api/MlPutTrainedModelFrequencyEncodingPreprocessor.md @@ -1,4 +1,4 @@ -## Interface `MlPutTrainedModelFrequencyEncodingPreprocessor` +# `MlPutTrainedModelFrequencyEncodingPreprocessor` [interface-MlPutTrainedModelFrequencyEncodingPreprocessor] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlPutTrainedModelInput.md b/docs/reference/api/MlPutTrainedModelInput.md index f36c44c8e..8a76b3f0a 100644 --- a/docs/reference/api/MlPutTrainedModelInput.md +++ b/docs/reference/api/MlPutTrainedModelInput.md @@ -1,4 +1,4 @@ -## Interface `MlPutTrainedModelInput` +# `MlPutTrainedModelInput` [interface-MlPutTrainedModelInput] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlPutTrainedModelOneHotEncodingPreprocessor.md b/docs/reference/api/MlPutTrainedModelOneHotEncodingPreprocessor.md index 02b7474ea..d33e9d65a 100644 --- a/docs/reference/api/MlPutTrainedModelOneHotEncodingPreprocessor.md +++ b/docs/reference/api/MlPutTrainedModelOneHotEncodingPreprocessor.md @@ -1,4 +1,4 @@ -## Interface `MlPutTrainedModelOneHotEncodingPreprocessor` +# `MlPutTrainedModelOneHotEncodingPreprocessor` [interface-MlPutTrainedModelOneHotEncodingPreprocessor] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlPutTrainedModelPreprocessor.md b/docs/reference/api/MlPutTrainedModelPreprocessor.md index 2cd0a8866..c96593d53 100644 --- a/docs/reference/api/MlPutTrainedModelPreprocessor.md +++ b/docs/reference/api/MlPutTrainedModelPreprocessor.md @@ -1,4 +1,4 @@ -## Interface `MlPutTrainedModelPreprocessor` +# `MlPutTrainedModelPreprocessor` [interface-MlPutTrainedModelPreprocessor] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlPutTrainedModelRequest.md b/docs/reference/api/MlPutTrainedModelRequest.md index 76a2e06e7..82e660122 100644 --- a/docs/reference/api/MlPutTrainedModelRequest.md +++ b/docs/reference/api/MlPutTrainedModelRequest.md @@ -1,4 +1,4 @@ -## Interface `MlPutTrainedModelRequest` +# `MlPutTrainedModelRequest` [interface-MlPutTrainedModelRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlPutTrainedModelResponse.md b/docs/reference/api/MlPutTrainedModelResponse.md index f6f8a71fe..1b4eadd83 100644 --- a/docs/reference/api/MlPutTrainedModelResponse.md +++ b/docs/reference/api/MlPutTrainedModelResponse.md @@ -1,4 +1,4 @@ -## `MlPutTrainedModelResponse` -::: +# `MlPutTrainedModelResponse` [alias-MlPutTrainedModelResponse] +```typescript type MlPutTrainedModelResponse = [MlTrainedModelConfig](./MlTrainedModelConfig.md); -::: +``` diff --git a/docs/reference/api/MlPutTrainedModelTargetMeanEncodingPreprocessor.md b/docs/reference/api/MlPutTrainedModelTargetMeanEncodingPreprocessor.md index fe69c51b7..1cfce91b9 100644 --- a/docs/reference/api/MlPutTrainedModelTargetMeanEncodingPreprocessor.md +++ b/docs/reference/api/MlPutTrainedModelTargetMeanEncodingPreprocessor.md @@ -1,4 +1,4 @@ -## Interface `MlPutTrainedModelTargetMeanEncodingPreprocessor` +# `MlPutTrainedModelTargetMeanEncodingPreprocessor` [interface-MlPutTrainedModelTargetMeanEncodingPreprocessor] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlPutTrainedModelTrainedModel.md b/docs/reference/api/MlPutTrainedModelTrainedModel.md index 95c4657f8..7f5a071b1 100644 --- a/docs/reference/api/MlPutTrainedModelTrainedModel.md +++ b/docs/reference/api/MlPutTrainedModelTrainedModel.md @@ -1,4 +1,4 @@ -## Interface `MlPutTrainedModelTrainedModel` +# `MlPutTrainedModelTrainedModel` [interface-MlPutTrainedModelTrainedModel] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlPutTrainedModelTrainedModelTree.md b/docs/reference/api/MlPutTrainedModelTrainedModelTree.md index 7327989cc..7fbf7b2d2 100644 --- a/docs/reference/api/MlPutTrainedModelTrainedModelTree.md +++ b/docs/reference/api/MlPutTrainedModelTrainedModelTree.md @@ -1,4 +1,4 @@ -## Interface `MlPutTrainedModelTrainedModelTree` +# `MlPutTrainedModelTrainedModelTree` [interface-MlPutTrainedModelTrainedModelTree] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlPutTrainedModelTrainedModelTreeNode.md b/docs/reference/api/MlPutTrainedModelTrainedModelTreeNode.md index 507852c9b..cae86cdf7 100644 --- a/docs/reference/api/MlPutTrainedModelTrainedModelTreeNode.md +++ b/docs/reference/api/MlPutTrainedModelTrainedModelTreeNode.md @@ -1,4 +1,4 @@ -## Interface `MlPutTrainedModelTrainedModelTreeNode` +# `MlPutTrainedModelTrainedModelTreeNode` [interface-MlPutTrainedModelTrainedModelTreeNode] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlPutTrainedModelVocabularyRequest.md b/docs/reference/api/MlPutTrainedModelVocabularyRequest.md index 63065f5e0..a7ac42015 100644 --- a/docs/reference/api/MlPutTrainedModelVocabularyRequest.md +++ b/docs/reference/api/MlPutTrainedModelVocabularyRequest.md @@ -1,4 +1,4 @@ -## Interface `MlPutTrainedModelVocabularyRequest` +# `MlPutTrainedModelVocabularyRequest` [interface-MlPutTrainedModelVocabularyRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlPutTrainedModelVocabularyResponse.md b/docs/reference/api/MlPutTrainedModelVocabularyResponse.md index d5238d889..96b834375 100644 --- a/docs/reference/api/MlPutTrainedModelVocabularyResponse.md +++ b/docs/reference/api/MlPutTrainedModelVocabularyResponse.md @@ -1,4 +1,4 @@ -## `MlPutTrainedModelVocabularyResponse` -::: +# `MlPutTrainedModelVocabularyResponse` [alias-MlPutTrainedModelVocabularyResponse] +```typescript type MlPutTrainedModelVocabularyResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); -::: +``` diff --git a/docs/reference/api/MlPutTrainedModelWeights.md b/docs/reference/api/MlPutTrainedModelWeights.md index c917f2599..803c8f189 100644 --- a/docs/reference/api/MlPutTrainedModelWeights.md +++ b/docs/reference/api/MlPutTrainedModelWeights.md @@ -1,4 +1,4 @@ -## Interface `MlPutTrainedModelWeights` +# `MlPutTrainedModelWeights` [interface-MlPutTrainedModelWeights] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlQueryFeatureExtractor.md b/docs/reference/api/MlQueryFeatureExtractor.md index 4d12e7e6e..a1795ce9a 100644 --- a/docs/reference/api/MlQueryFeatureExtractor.md +++ b/docs/reference/api/MlQueryFeatureExtractor.md @@ -1,4 +1,4 @@ -## Interface `MlQueryFeatureExtractor` +# `MlQueryFeatureExtractor` [interface-MlQueryFeatureExtractor] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlQuestionAnsweringInferenceOptions.md b/docs/reference/api/MlQuestionAnsweringInferenceOptions.md index 7bfb51d41..edbb5ddd4 100644 --- a/docs/reference/api/MlQuestionAnsweringInferenceOptions.md +++ b/docs/reference/api/MlQuestionAnsweringInferenceOptions.md @@ -1,4 +1,4 @@ -## Interface `MlQuestionAnsweringInferenceOptions` +# `MlQuestionAnsweringInferenceOptions` [interface-MlQuestionAnsweringInferenceOptions] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlQuestionAnsweringInferenceUpdateOptions.md b/docs/reference/api/MlQuestionAnsweringInferenceUpdateOptions.md index 4bbdd5378..d04db7b46 100644 --- a/docs/reference/api/MlQuestionAnsweringInferenceUpdateOptions.md +++ b/docs/reference/api/MlQuestionAnsweringInferenceUpdateOptions.md @@ -1,4 +1,4 @@ -## Interface `MlQuestionAnsweringInferenceUpdateOptions` +# `MlQuestionAnsweringInferenceUpdateOptions` [interface-MlQuestionAnsweringInferenceUpdateOptions] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlRegressionInferenceOptions.md b/docs/reference/api/MlRegressionInferenceOptions.md index a1a3ade30..8294e8eda 100644 --- a/docs/reference/api/MlRegressionInferenceOptions.md +++ b/docs/reference/api/MlRegressionInferenceOptions.md @@ -1,4 +1,4 @@ -## Interface `MlRegressionInferenceOptions` +# `MlRegressionInferenceOptions` [interface-MlRegressionInferenceOptions] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlResetJobRequest.md b/docs/reference/api/MlResetJobRequest.md index f836a900c..0486a4fe8 100644 --- a/docs/reference/api/MlResetJobRequest.md +++ b/docs/reference/api/MlResetJobRequest.md @@ -1,4 +1,4 @@ -## Interface `MlResetJobRequest` +# `MlResetJobRequest` [interface-MlResetJobRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlResetJobResponse.md b/docs/reference/api/MlResetJobResponse.md index cd889e0f8..c406fe86d 100644 --- a/docs/reference/api/MlResetJobResponse.md +++ b/docs/reference/api/MlResetJobResponse.md @@ -1,4 +1,4 @@ -## `MlResetJobResponse` -::: +# `MlResetJobResponse` [alias-MlResetJobResponse] +```typescript type MlResetJobResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); -::: +``` diff --git a/docs/reference/api/MlRevertModelSnapshotRequest.md b/docs/reference/api/MlRevertModelSnapshotRequest.md index 749f8da74..70ccb0b25 100644 --- a/docs/reference/api/MlRevertModelSnapshotRequest.md +++ b/docs/reference/api/MlRevertModelSnapshotRequest.md @@ -1,4 +1,4 @@ -## Interface `MlRevertModelSnapshotRequest` +# `MlRevertModelSnapshotRequest` [interface-MlRevertModelSnapshotRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlRevertModelSnapshotResponse.md b/docs/reference/api/MlRevertModelSnapshotResponse.md index da3cee0d3..006fc5011 100644 --- a/docs/reference/api/MlRevertModelSnapshotResponse.md +++ b/docs/reference/api/MlRevertModelSnapshotResponse.md @@ -1,4 +1,4 @@ -## Interface `MlRevertModelSnapshotResponse` +# `MlRevertModelSnapshotResponse` [interface-MlRevertModelSnapshotResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlRoutingState.md b/docs/reference/api/MlRoutingState.md index c7eda096f..0ac2234b9 100644 --- a/docs/reference/api/MlRoutingState.md +++ b/docs/reference/api/MlRoutingState.md @@ -1,4 +1,4 @@ -## `MlRoutingState` -::: +# `MlRoutingState` [alias-MlRoutingState] +```typescript type MlRoutingState = 'failed' | 'started' | 'starting' | 'stopped' | 'stopping'; -::: +``` diff --git a/docs/reference/api/MlRuleAction.md b/docs/reference/api/MlRuleAction.md index 7c2f4d003..624bc52ac 100644 --- a/docs/reference/api/MlRuleAction.md +++ b/docs/reference/api/MlRuleAction.md @@ -1,4 +1,4 @@ -## `MlRuleAction` -::: +# `MlRuleAction` [alias-MlRuleAction] +```typescript type MlRuleAction = 'skip_result' | 'skip_model_update'; -::: +``` diff --git a/docs/reference/api/MlRuleCondition.md b/docs/reference/api/MlRuleCondition.md index f7a371bd2..88fa51363 100644 --- a/docs/reference/api/MlRuleCondition.md +++ b/docs/reference/api/MlRuleCondition.md @@ -1,4 +1,4 @@ -## Interface `MlRuleCondition` +# `MlRuleCondition` [interface-MlRuleCondition] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlRunningStateSearchInterval.md b/docs/reference/api/MlRunningStateSearchInterval.md index 4cfa32487..84a7746f2 100644 --- a/docs/reference/api/MlRunningStateSearchInterval.md +++ b/docs/reference/api/MlRunningStateSearchInterval.md @@ -1,4 +1,4 @@ -## Interface `MlRunningStateSearchInterval` +# `MlRunningStateSearchInterval` [interface-MlRunningStateSearchInterval] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlSetUpgradeModeRequest.md b/docs/reference/api/MlSetUpgradeModeRequest.md index 289460e21..d44bd69f9 100644 --- a/docs/reference/api/MlSetUpgradeModeRequest.md +++ b/docs/reference/api/MlSetUpgradeModeRequest.md @@ -1,4 +1,4 @@ -## Interface `MlSetUpgradeModeRequest` +# `MlSetUpgradeModeRequest` [interface-MlSetUpgradeModeRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlSetUpgradeModeResponse.md b/docs/reference/api/MlSetUpgradeModeResponse.md index e18b9cf19..1bd8e36b4 100644 --- a/docs/reference/api/MlSetUpgradeModeResponse.md +++ b/docs/reference/api/MlSetUpgradeModeResponse.md @@ -1,4 +1,4 @@ -## `MlSetUpgradeModeResponse` -::: +# `MlSetUpgradeModeResponse` [alias-MlSetUpgradeModeResponse] +```typescript type MlSetUpgradeModeResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); -::: +``` diff --git a/docs/reference/api/MlSnapshotUpgradeState.md b/docs/reference/api/MlSnapshotUpgradeState.md index 6ebf38423..4d9de7e25 100644 --- a/docs/reference/api/MlSnapshotUpgradeState.md +++ b/docs/reference/api/MlSnapshotUpgradeState.md @@ -1,4 +1,4 @@ -## `MlSnapshotUpgradeState` -::: +# `MlSnapshotUpgradeState` [alias-MlSnapshotUpgradeState] +```typescript type MlSnapshotUpgradeState = 'loading_old_state' | 'saving_new_state' | 'stopped' | 'failed'; -::: +``` diff --git a/docs/reference/api/MlStartDataFrameAnalyticsRequest.md b/docs/reference/api/MlStartDataFrameAnalyticsRequest.md index 861c7b7ef..75e0038a4 100644 --- a/docs/reference/api/MlStartDataFrameAnalyticsRequest.md +++ b/docs/reference/api/MlStartDataFrameAnalyticsRequest.md @@ -1,4 +1,4 @@ -## Interface `MlStartDataFrameAnalyticsRequest` +# `MlStartDataFrameAnalyticsRequest` [interface-MlStartDataFrameAnalyticsRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlStartDataFrameAnalyticsResponse.md b/docs/reference/api/MlStartDataFrameAnalyticsResponse.md index e44141ede..6440f5bb6 100644 --- a/docs/reference/api/MlStartDataFrameAnalyticsResponse.md +++ b/docs/reference/api/MlStartDataFrameAnalyticsResponse.md @@ -1,4 +1,4 @@ -## Interface `MlStartDataFrameAnalyticsResponse` +# `MlStartDataFrameAnalyticsResponse` [interface-MlStartDataFrameAnalyticsResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlStartDatafeedRequest.md b/docs/reference/api/MlStartDatafeedRequest.md index f03599eab..716c3270d 100644 --- a/docs/reference/api/MlStartDatafeedRequest.md +++ b/docs/reference/api/MlStartDatafeedRequest.md @@ -1,4 +1,4 @@ -## Interface `MlStartDatafeedRequest` +# `MlStartDatafeedRequest` [interface-MlStartDatafeedRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlStartDatafeedResponse.md b/docs/reference/api/MlStartDatafeedResponse.md index b8009f84b..04dabddb9 100644 --- a/docs/reference/api/MlStartDatafeedResponse.md +++ b/docs/reference/api/MlStartDatafeedResponse.md @@ -1,4 +1,4 @@ -## Interface `MlStartDatafeedResponse` +# `MlStartDatafeedResponse` [interface-MlStartDatafeedResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlStartTrainedModelDeploymentRequest.md b/docs/reference/api/MlStartTrainedModelDeploymentRequest.md index cf0826236..c87b61367 100644 --- a/docs/reference/api/MlStartTrainedModelDeploymentRequest.md +++ b/docs/reference/api/MlStartTrainedModelDeploymentRequest.md @@ -1,4 +1,4 @@ -## Interface `MlStartTrainedModelDeploymentRequest` +# `MlStartTrainedModelDeploymentRequest` [interface-MlStartTrainedModelDeploymentRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlStartTrainedModelDeploymentResponse.md b/docs/reference/api/MlStartTrainedModelDeploymentResponse.md index f0ad276d4..f5cd06751 100644 --- a/docs/reference/api/MlStartTrainedModelDeploymentResponse.md +++ b/docs/reference/api/MlStartTrainedModelDeploymentResponse.md @@ -1,4 +1,4 @@ -## Interface `MlStartTrainedModelDeploymentResponse` +# `MlStartTrainedModelDeploymentResponse` [interface-MlStartTrainedModelDeploymentResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlStopDataFrameAnalyticsRequest.md b/docs/reference/api/MlStopDataFrameAnalyticsRequest.md index 870212687..b70bbc86c 100644 --- a/docs/reference/api/MlStopDataFrameAnalyticsRequest.md +++ b/docs/reference/api/MlStopDataFrameAnalyticsRequest.md @@ -1,4 +1,4 @@ -## Interface `MlStopDataFrameAnalyticsRequest` +# `MlStopDataFrameAnalyticsRequest` [interface-MlStopDataFrameAnalyticsRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlStopDataFrameAnalyticsResponse.md b/docs/reference/api/MlStopDataFrameAnalyticsResponse.md index d175aecdd..8ec7a0b84 100644 --- a/docs/reference/api/MlStopDataFrameAnalyticsResponse.md +++ b/docs/reference/api/MlStopDataFrameAnalyticsResponse.md @@ -1,4 +1,4 @@ -## Interface `MlStopDataFrameAnalyticsResponse` +# `MlStopDataFrameAnalyticsResponse` [interface-MlStopDataFrameAnalyticsResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlStopDatafeedRequest.md b/docs/reference/api/MlStopDatafeedRequest.md index e83d6505f..2f02728e6 100644 --- a/docs/reference/api/MlStopDatafeedRequest.md +++ b/docs/reference/api/MlStopDatafeedRequest.md @@ -1,4 +1,4 @@ -## Interface `MlStopDatafeedRequest` +# `MlStopDatafeedRequest` [interface-MlStopDatafeedRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlStopDatafeedResponse.md b/docs/reference/api/MlStopDatafeedResponse.md index e643a3310..8019fd107 100644 --- a/docs/reference/api/MlStopDatafeedResponse.md +++ b/docs/reference/api/MlStopDatafeedResponse.md @@ -1,4 +1,4 @@ -## Interface `MlStopDatafeedResponse` +# `MlStopDatafeedResponse` [interface-MlStopDatafeedResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlStopTrainedModelDeploymentRequest.md b/docs/reference/api/MlStopTrainedModelDeploymentRequest.md index cb7a2d1ea..e1adbdf40 100644 --- a/docs/reference/api/MlStopTrainedModelDeploymentRequest.md +++ b/docs/reference/api/MlStopTrainedModelDeploymentRequest.md @@ -1,4 +1,4 @@ -## Interface `MlStopTrainedModelDeploymentRequest` +# `MlStopTrainedModelDeploymentRequest` [interface-MlStopTrainedModelDeploymentRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlStopTrainedModelDeploymentResponse.md b/docs/reference/api/MlStopTrainedModelDeploymentResponse.md index aba8d8fa1..093639a9a 100644 --- a/docs/reference/api/MlStopTrainedModelDeploymentResponse.md +++ b/docs/reference/api/MlStopTrainedModelDeploymentResponse.md @@ -1,4 +1,4 @@ -## Interface `MlStopTrainedModelDeploymentResponse` +# `MlStopTrainedModelDeploymentResponse` [interface-MlStopTrainedModelDeploymentResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlTextClassificationInferenceOptions.md b/docs/reference/api/MlTextClassificationInferenceOptions.md index a5105cd20..8ada4f865 100644 --- a/docs/reference/api/MlTextClassificationInferenceOptions.md +++ b/docs/reference/api/MlTextClassificationInferenceOptions.md @@ -1,4 +1,4 @@ -## Interface `MlTextClassificationInferenceOptions` +# `MlTextClassificationInferenceOptions` [interface-MlTextClassificationInferenceOptions] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlTextClassificationInferenceUpdateOptions.md b/docs/reference/api/MlTextClassificationInferenceUpdateOptions.md index ed0771aca..80243d5a2 100644 --- a/docs/reference/api/MlTextClassificationInferenceUpdateOptions.md +++ b/docs/reference/api/MlTextClassificationInferenceUpdateOptions.md @@ -1,4 +1,4 @@ -## Interface `MlTextClassificationInferenceUpdateOptions` +# `MlTextClassificationInferenceUpdateOptions` [interface-MlTextClassificationInferenceUpdateOptions] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlTextEmbeddingInferenceOptions.md b/docs/reference/api/MlTextEmbeddingInferenceOptions.md index e268dc984..ac73cf455 100644 --- a/docs/reference/api/MlTextEmbeddingInferenceOptions.md +++ b/docs/reference/api/MlTextEmbeddingInferenceOptions.md @@ -1,4 +1,4 @@ -## Interface `MlTextEmbeddingInferenceOptions` +# `MlTextEmbeddingInferenceOptions` [interface-MlTextEmbeddingInferenceOptions] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlTextEmbeddingInferenceUpdateOptions.md b/docs/reference/api/MlTextEmbeddingInferenceUpdateOptions.md index 0968162a5..7b2ccb412 100644 --- a/docs/reference/api/MlTextEmbeddingInferenceUpdateOptions.md +++ b/docs/reference/api/MlTextEmbeddingInferenceUpdateOptions.md @@ -1,4 +1,4 @@ -## Interface `MlTextEmbeddingInferenceUpdateOptions` +# `MlTextEmbeddingInferenceUpdateOptions` [interface-MlTextEmbeddingInferenceUpdateOptions] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlTextExpansionInferenceOptions.md b/docs/reference/api/MlTextExpansionInferenceOptions.md index ae78826b6..f02c72fad 100644 --- a/docs/reference/api/MlTextExpansionInferenceOptions.md +++ b/docs/reference/api/MlTextExpansionInferenceOptions.md @@ -1,4 +1,4 @@ -## Interface `MlTextExpansionInferenceOptions` +# `MlTextExpansionInferenceOptions` [interface-MlTextExpansionInferenceOptions] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlTextExpansionInferenceUpdateOptions.md b/docs/reference/api/MlTextExpansionInferenceUpdateOptions.md index 7ec50c50f..58261db18 100644 --- a/docs/reference/api/MlTextExpansionInferenceUpdateOptions.md +++ b/docs/reference/api/MlTextExpansionInferenceUpdateOptions.md @@ -1,4 +1,4 @@ -## Interface `MlTextExpansionInferenceUpdateOptions` +# `MlTextExpansionInferenceUpdateOptions` [interface-MlTextExpansionInferenceUpdateOptions] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlTimingStats.md b/docs/reference/api/MlTimingStats.md index 58c4b1d24..fceeb6341 100644 --- a/docs/reference/api/MlTimingStats.md +++ b/docs/reference/api/MlTimingStats.md @@ -1,4 +1,4 @@ -## Interface `MlTimingStats` +# `MlTimingStats` [interface-MlTimingStats] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlTokenizationConfigContainer.md b/docs/reference/api/MlTokenizationConfigContainer.md index ed9fd2f81..a05d58784 100644 --- a/docs/reference/api/MlTokenizationConfigContainer.md +++ b/docs/reference/api/MlTokenizationConfigContainer.md @@ -1,4 +1,4 @@ -## Interface `MlTokenizationConfigContainer` +# `MlTokenizationConfigContainer` [interface-MlTokenizationConfigContainer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlTokenizationTruncate.md b/docs/reference/api/MlTokenizationTruncate.md index 2ec430835..461ee14ab 100644 --- a/docs/reference/api/MlTokenizationTruncate.md +++ b/docs/reference/api/MlTokenizationTruncate.md @@ -1,4 +1,4 @@ -## `MlTokenizationTruncate` -::: +# `MlTokenizationTruncate` [alias-MlTokenizationTruncate] +```typescript type MlTokenizationTruncate = 'first' | 'second' | 'none'; -::: +``` diff --git a/docs/reference/api/MlTopClassEntry.md b/docs/reference/api/MlTopClassEntry.md index 3a50b68f0..a30916262 100644 --- a/docs/reference/api/MlTopClassEntry.md +++ b/docs/reference/api/MlTopClassEntry.md @@ -1,4 +1,4 @@ -## Interface `MlTopClassEntry` +# `MlTopClassEntry` [interface-MlTopClassEntry] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlTotalFeatureImportance.md b/docs/reference/api/MlTotalFeatureImportance.md index fc7b7b187..9d1be643c 100644 --- a/docs/reference/api/MlTotalFeatureImportance.md +++ b/docs/reference/api/MlTotalFeatureImportance.md @@ -1,4 +1,4 @@ -## Interface `MlTotalFeatureImportance` +# `MlTotalFeatureImportance` [interface-MlTotalFeatureImportance] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlTotalFeatureImportanceClass.md b/docs/reference/api/MlTotalFeatureImportanceClass.md index 5f01c02ea..f22b18305 100644 --- a/docs/reference/api/MlTotalFeatureImportanceClass.md +++ b/docs/reference/api/MlTotalFeatureImportanceClass.md @@ -1,4 +1,4 @@ -## Interface `MlTotalFeatureImportanceClass` +# `MlTotalFeatureImportanceClass` [interface-MlTotalFeatureImportanceClass] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlTotalFeatureImportanceStatistics.md b/docs/reference/api/MlTotalFeatureImportanceStatistics.md index 6a63f2977..6a941e5df 100644 --- a/docs/reference/api/MlTotalFeatureImportanceStatistics.md +++ b/docs/reference/api/MlTotalFeatureImportanceStatistics.md @@ -1,4 +1,4 @@ -## Interface `MlTotalFeatureImportanceStatistics` +# `MlTotalFeatureImportanceStatistics` [interface-MlTotalFeatureImportanceStatistics] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlTrainedModelAssignment.md b/docs/reference/api/MlTrainedModelAssignment.md index 667df9d66..1fe8ee9dc 100644 --- a/docs/reference/api/MlTrainedModelAssignment.md +++ b/docs/reference/api/MlTrainedModelAssignment.md @@ -1,4 +1,4 @@ -## Interface `MlTrainedModelAssignment` +# `MlTrainedModelAssignment` [interface-MlTrainedModelAssignment] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlTrainedModelAssignmentRoutingStateAndReason.md b/docs/reference/api/MlTrainedModelAssignmentRoutingStateAndReason.md index bbbae8b03..501e59e74 100644 --- a/docs/reference/api/MlTrainedModelAssignmentRoutingStateAndReason.md +++ b/docs/reference/api/MlTrainedModelAssignmentRoutingStateAndReason.md @@ -1,4 +1,4 @@ -## Interface `MlTrainedModelAssignmentRoutingStateAndReason` +# `MlTrainedModelAssignmentRoutingStateAndReason` [interface-MlTrainedModelAssignmentRoutingStateAndReason] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlTrainedModelAssignmentRoutingTable.md b/docs/reference/api/MlTrainedModelAssignmentRoutingTable.md index bedc0ef7c..7ae4eb812 100644 --- a/docs/reference/api/MlTrainedModelAssignmentRoutingTable.md +++ b/docs/reference/api/MlTrainedModelAssignmentRoutingTable.md @@ -1,4 +1,4 @@ -## Interface `MlTrainedModelAssignmentRoutingTable` +# `MlTrainedModelAssignmentRoutingTable` [interface-MlTrainedModelAssignmentRoutingTable] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlTrainedModelAssignmentTaskParameters.md b/docs/reference/api/MlTrainedModelAssignmentTaskParameters.md index c7cd22209..7cc28594e 100644 --- a/docs/reference/api/MlTrainedModelAssignmentTaskParameters.md +++ b/docs/reference/api/MlTrainedModelAssignmentTaskParameters.md @@ -1,4 +1,4 @@ -## Interface `MlTrainedModelAssignmentTaskParameters` +# `MlTrainedModelAssignmentTaskParameters` [interface-MlTrainedModelAssignmentTaskParameters] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlTrainedModelConfig.md b/docs/reference/api/MlTrainedModelConfig.md index 4831da466..46241cc9d 100644 --- a/docs/reference/api/MlTrainedModelConfig.md +++ b/docs/reference/api/MlTrainedModelConfig.md @@ -1,4 +1,4 @@ -## Interface `MlTrainedModelConfig` +# `MlTrainedModelConfig` [interface-MlTrainedModelConfig] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlTrainedModelConfigInput.md b/docs/reference/api/MlTrainedModelConfigInput.md index 7ebe33aed..2ced5d2e2 100644 --- a/docs/reference/api/MlTrainedModelConfigInput.md +++ b/docs/reference/api/MlTrainedModelConfigInput.md @@ -1,4 +1,4 @@ -## Interface `MlTrainedModelConfigInput` +# `MlTrainedModelConfigInput` [interface-MlTrainedModelConfigInput] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlTrainedModelConfigMetadata.md b/docs/reference/api/MlTrainedModelConfigMetadata.md index 74513f730..16d784ed1 100644 --- a/docs/reference/api/MlTrainedModelConfigMetadata.md +++ b/docs/reference/api/MlTrainedModelConfigMetadata.md @@ -1,4 +1,4 @@ -## Interface `MlTrainedModelConfigMetadata` +# `MlTrainedModelConfigMetadata` [interface-MlTrainedModelConfigMetadata] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlTrainedModelDeploymentAllocationStatus.md b/docs/reference/api/MlTrainedModelDeploymentAllocationStatus.md index ca26cbaab..8a348a58e 100644 --- a/docs/reference/api/MlTrainedModelDeploymentAllocationStatus.md +++ b/docs/reference/api/MlTrainedModelDeploymentAllocationStatus.md @@ -1,4 +1,4 @@ -## Interface `MlTrainedModelDeploymentAllocationStatus` +# `MlTrainedModelDeploymentAllocationStatus` [interface-MlTrainedModelDeploymentAllocationStatus] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlTrainedModelDeploymentNodesStats.md b/docs/reference/api/MlTrainedModelDeploymentNodesStats.md index 4a83428e6..6678e2cd9 100644 --- a/docs/reference/api/MlTrainedModelDeploymentNodesStats.md +++ b/docs/reference/api/MlTrainedModelDeploymentNodesStats.md @@ -1,4 +1,4 @@ -## Interface `MlTrainedModelDeploymentNodesStats` +# `MlTrainedModelDeploymentNodesStats` [interface-MlTrainedModelDeploymentNodesStats] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlTrainedModelDeploymentStats.md b/docs/reference/api/MlTrainedModelDeploymentStats.md index 6aa16369d..ffa846177 100644 --- a/docs/reference/api/MlTrainedModelDeploymentStats.md +++ b/docs/reference/api/MlTrainedModelDeploymentStats.md @@ -1,4 +1,4 @@ -## Interface `MlTrainedModelDeploymentStats` +# `MlTrainedModelDeploymentStats` [interface-MlTrainedModelDeploymentStats] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlTrainedModelEntities.md b/docs/reference/api/MlTrainedModelEntities.md index ea4823515..c3a781742 100644 --- a/docs/reference/api/MlTrainedModelEntities.md +++ b/docs/reference/api/MlTrainedModelEntities.md @@ -1,4 +1,4 @@ -## Interface `MlTrainedModelEntities` +# `MlTrainedModelEntities` [interface-MlTrainedModelEntities] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlTrainedModelInferenceClassImportance.md b/docs/reference/api/MlTrainedModelInferenceClassImportance.md index 3a9ac3cd4..625feb5ea 100644 --- a/docs/reference/api/MlTrainedModelInferenceClassImportance.md +++ b/docs/reference/api/MlTrainedModelInferenceClassImportance.md @@ -1,4 +1,4 @@ -## Interface `MlTrainedModelInferenceClassImportance` +# `MlTrainedModelInferenceClassImportance` [interface-MlTrainedModelInferenceClassImportance] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlTrainedModelInferenceFeatureImportance.md b/docs/reference/api/MlTrainedModelInferenceFeatureImportance.md index d3624c59c..ba7208d97 100644 --- a/docs/reference/api/MlTrainedModelInferenceFeatureImportance.md +++ b/docs/reference/api/MlTrainedModelInferenceFeatureImportance.md @@ -1,4 +1,4 @@ -## Interface `MlTrainedModelInferenceFeatureImportance` +# `MlTrainedModelInferenceFeatureImportance` [interface-MlTrainedModelInferenceFeatureImportance] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlTrainedModelInferenceStats.md b/docs/reference/api/MlTrainedModelInferenceStats.md index dc2cd3a28..db67fcbd4 100644 --- a/docs/reference/api/MlTrainedModelInferenceStats.md +++ b/docs/reference/api/MlTrainedModelInferenceStats.md @@ -1,4 +1,4 @@ -## Interface `MlTrainedModelInferenceStats` +# `MlTrainedModelInferenceStats` [interface-MlTrainedModelInferenceStats] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlTrainedModelLocation.md b/docs/reference/api/MlTrainedModelLocation.md index 65554db63..4ba8ad890 100644 --- a/docs/reference/api/MlTrainedModelLocation.md +++ b/docs/reference/api/MlTrainedModelLocation.md @@ -1,4 +1,4 @@ -## Interface `MlTrainedModelLocation` +# `MlTrainedModelLocation` [interface-MlTrainedModelLocation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlTrainedModelLocationIndex.md b/docs/reference/api/MlTrainedModelLocationIndex.md index 37fd91bb4..f71ff50bf 100644 --- a/docs/reference/api/MlTrainedModelLocationIndex.md +++ b/docs/reference/api/MlTrainedModelLocationIndex.md @@ -1,4 +1,4 @@ -## Interface `MlTrainedModelLocationIndex` +# `MlTrainedModelLocationIndex` [interface-MlTrainedModelLocationIndex] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlTrainedModelPrefixStrings.md b/docs/reference/api/MlTrainedModelPrefixStrings.md index bd7ff76fb..9418d60f1 100644 --- a/docs/reference/api/MlTrainedModelPrefixStrings.md +++ b/docs/reference/api/MlTrainedModelPrefixStrings.md @@ -1,4 +1,4 @@ -## Interface `MlTrainedModelPrefixStrings` +# `MlTrainedModelPrefixStrings` [interface-MlTrainedModelPrefixStrings] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlTrainedModelSizeStats.md b/docs/reference/api/MlTrainedModelSizeStats.md index 316361026..b5b01dcdc 100644 --- a/docs/reference/api/MlTrainedModelSizeStats.md +++ b/docs/reference/api/MlTrainedModelSizeStats.md @@ -1,4 +1,4 @@ -## Interface `MlTrainedModelSizeStats` +# `MlTrainedModelSizeStats` [interface-MlTrainedModelSizeStats] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlTrainedModelStats.md b/docs/reference/api/MlTrainedModelStats.md index 00f9f18b8..4f2ce2142 100644 --- a/docs/reference/api/MlTrainedModelStats.md +++ b/docs/reference/api/MlTrainedModelStats.md @@ -1,4 +1,4 @@ -## Interface `MlTrainedModelStats` +# `MlTrainedModelStats` [interface-MlTrainedModelStats] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlTrainedModelType.md b/docs/reference/api/MlTrainedModelType.md index ab453d832..338bf7d97 100644 --- a/docs/reference/api/MlTrainedModelType.md +++ b/docs/reference/api/MlTrainedModelType.md @@ -1,4 +1,4 @@ -## `MlTrainedModelType` -::: +# `MlTrainedModelType` [alias-MlTrainedModelType] +```typescript type MlTrainedModelType = 'tree_ensemble' | 'lang_ident' | 'pytorch'; -::: +``` diff --git a/docs/reference/api/MlTrainingPriority.md b/docs/reference/api/MlTrainingPriority.md index 1d4c80271..54bf76f8d 100644 --- a/docs/reference/api/MlTrainingPriority.md +++ b/docs/reference/api/MlTrainingPriority.md @@ -1,4 +1,4 @@ -## `MlTrainingPriority` -::: +# `MlTrainingPriority` [alias-MlTrainingPriority] +```typescript type MlTrainingPriority = 'normal' | 'low'; -::: +``` diff --git a/docs/reference/api/MlTransformAuthorization.md b/docs/reference/api/MlTransformAuthorization.md index 0eb5bbe02..83b08a7b7 100644 --- a/docs/reference/api/MlTransformAuthorization.md +++ b/docs/reference/api/MlTransformAuthorization.md @@ -1,4 +1,4 @@ -## Interface `MlTransformAuthorization` +# `MlTransformAuthorization` [interface-MlTransformAuthorization] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlUpdateDataFrameAnalyticsRequest.md b/docs/reference/api/MlUpdateDataFrameAnalyticsRequest.md index ed95e6aa1..f8c4ff18f 100644 --- a/docs/reference/api/MlUpdateDataFrameAnalyticsRequest.md +++ b/docs/reference/api/MlUpdateDataFrameAnalyticsRequest.md @@ -1,4 +1,4 @@ -## Interface `MlUpdateDataFrameAnalyticsRequest` +# `MlUpdateDataFrameAnalyticsRequest` [interface-MlUpdateDataFrameAnalyticsRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlUpdateDataFrameAnalyticsResponse.md b/docs/reference/api/MlUpdateDataFrameAnalyticsResponse.md index e869162ce..02febb96f 100644 --- a/docs/reference/api/MlUpdateDataFrameAnalyticsResponse.md +++ b/docs/reference/api/MlUpdateDataFrameAnalyticsResponse.md @@ -1,4 +1,4 @@ -## Interface `MlUpdateDataFrameAnalyticsResponse` +# `MlUpdateDataFrameAnalyticsResponse` [interface-MlUpdateDataFrameAnalyticsResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlUpdateDatafeedRequest.md b/docs/reference/api/MlUpdateDatafeedRequest.md index 2942ead4d..4926fbf2e 100644 --- a/docs/reference/api/MlUpdateDatafeedRequest.md +++ b/docs/reference/api/MlUpdateDatafeedRequest.md @@ -1,4 +1,4 @@ -## Interface `MlUpdateDatafeedRequest` +# `MlUpdateDatafeedRequest` [interface-MlUpdateDatafeedRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlUpdateDatafeedResponse.md b/docs/reference/api/MlUpdateDatafeedResponse.md index c6c6aa164..79380f370 100644 --- a/docs/reference/api/MlUpdateDatafeedResponse.md +++ b/docs/reference/api/MlUpdateDatafeedResponse.md @@ -1,4 +1,4 @@ -## Interface `MlUpdateDatafeedResponse` +# `MlUpdateDatafeedResponse` [interface-MlUpdateDatafeedResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlUpdateFilterRequest.md b/docs/reference/api/MlUpdateFilterRequest.md index 96f221fc2..64ca9b9a5 100644 --- a/docs/reference/api/MlUpdateFilterRequest.md +++ b/docs/reference/api/MlUpdateFilterRequest.md @@ -1,4 +1,4 @@ -## Interface `MlUpdateFilterRequest` +# `MlUpdateFilterRequest` [interface-MlUpdateFilterRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlUpdateFilterResponse.md b/docs/reference/api/MlUpdateFilterResponse.md index 4b739d23d..c2c21e150 100644 --- a/docs/reference/api/MlUpdateFilterResponse.md +++ b/docs/reference/api/MlUpdateFilterResponse.md @@ -1,4 +1,4 @@ -## Interface `MlUpdateFilterResponse` +# `MlUpdateFilterResponse` [interface-MlUpdateFilterResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlUpdateJobRequest.md b/docs/reference/api/MlUpdateJobRequest.md index 9a31c220e..312cebdd0 100644 --- a/docs/reference/api/MlUpdateJobRequest.md +++ b/docs/reference/api/MlUpdateJobRequest.md @@ -1,4 +1,4 @@ -## Interface `MlUpdateJobRequest` +# `MlUpdateJobRequest` [interface-MlUpdateJobRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlUpdateJobResponse.md b/docs/reference/api/MlUpdateJobResponse.md index 43d14f37a..c1dd55fcd 100644 --- a/docs/reference/api/MlUpdateJobResponse.md +++ b/docs/reference/api/MlUpdateJobResponse.md @@ -1,4 +1,4 @@ -## Interface `MlUpdateJobResponse` +# `MlUpdateJobResponse` [interface-MlUpdateJobResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlUpdateModelSnapshotRequest.md b/docs/reference/api/MlUpdateModelSnapshotRequest.md index 8d2dad744..779ca15b0 100644 --- a/docs/reference/api/MlUpdateModelSnapshotRequest.md +++ b/docs/reference/api/MlUpdateModelSnapshotRequest.md @@ -1,4 +1,4 @@ -## Interface `MlUpdateModelSnapshotRequest` +# `MlUpdateModelSnapshotRequest` [interface-MlUpdateModelSnapshotRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlUpdateModelSnapshotResponse.md b/docs/reference/api/MlUpdateModelSnapshotResponse.md index 84054b8d0..fb3b86967 100644 --- a/docs/reference/api/MlUpdateModelSnapshotResponse.md +++ b/docs/reference/api/MlUpdateModelSnapshotResponse.md @@ -1,4 +1,4 @@ -## Interface `MlUpdateModelSnapshotResponse` +# `MlUpdateModelSnapshotResponse` [interface-MlUpdateModelSnapshotResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlUpdateTrainedModelDeploymentRequest.md b/docs/reference/api/MlUpdateTrainedModelDeploymentRequest.md index cf9e609e5..d2a954413 100644 --- a/docs/reference/api/MlUpdateTrainedModelDeploymentRequest.md +++ b/docs/reference/api/MlUpdateTrainedModelDeploymentRequest.md @@ -1,4 +1,4 @@ -## Interface `MlUpdateTrainedModelDeploymentRequest` +# `MlUpdateTrainedModelDeploymentRequest` [interface-MlUpdateTrainedModelDeploymentRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlUpdateTrainedModelDeploymentResponse.md b/docs/reference/api/MlUpdateTrainedModelDeploymentResponse.md index 55b7846b9..661d46ee8 100644 --- a/docs/reference/api/MlUpdateTrainedModelDeploymentResponse.md +++ b/docs/reference/api/MlUpdateTrainedModelDeploymentResponse.md @@ -1,4 +1,4 @@ -## Interface `MlUpdateTrainedModelDeploymentResponse` +# `MlUpdateTrainedModelDeploymentResponse` [interface-MlUpdateTrainedModelDeploymentResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlUpgradeJobSnapshotRequest.md b/docs/reference/api/MlUpgradeJobSnapshotRequest.md index 1691dcb20..30e36be50 100644 --- a/docs/reference/api/MlUpgradeJobSnapshotRequest.md +++ b/docs/reference/api/MlUpgradeJobSnapshotRequest.md @@ -1,4 +1,4 @@ -## Interface `MlUpgradeJobSnapshotRequest` +# `MlUpgradeJobSnapshotRequest` [interface-MlUpgradeJobSnapshotRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlUpgradeJobSnapshotResponse.md b/docs/reference/api/MlUpgradeJobSnapshotResponse.md index d217cb44e..76247507b 100644 --- a/docs/reference/api/MlUpgradeJobSnapshotResponse.md +++ b/docs/reference/api/MlUpgradeJobSnapshotResponse.md @@ -1,4 +1,4 @@ -## Interface `MlUpgradeJobSnapshotResponse` +# `MlUpgradeJobSnapshotResponse` [interface-MlUpgradeJobSnapshotResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlValidateDetectorRequest.md b/docs/reference/api/MlValidateDetectorRequest.md index 8f72d216d..886a88f10 100644 --- a/docs/reference/api/MlValidateDetectorRequest.md +++ b/docs/reference/api/MlValidateDetectorRequest.md @@ -1,4 +1,4 @@ -## Interface `MlValidateDetectorRequest` +# `MlValidateDetectorRequest` [interface-MlValidateDetectorRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlValidateDetectorResponse.md b/docs/reference/api/MlValidateDetectorResponse.md index 76ea14cfd..c2ca534fe 100644 --- a/docs/reference/api/MlValidateDetectorResponse.md +++ b/docs/reference/api/MlValidateDetectorResponse.md @@ -1,4 +1,4 @@ -## `MlValidateDetectorResponse` -::: +# `MlValidateDetectorResponse` [alias-MlValidateDetectorResponse] +```typescript type MlValidateDetectorResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); -::: +``` diff --git a/docs/reference/api/MlValidateRequest.md b/docs/reference/api/MlValidateRequest.md index 812619d6d..b83ee54c3 100644 --- a/docs/reference/api/MlValidateRequest.md +++ b/docs/reference/api/MlValidateRequest.md @@ -1,4 +1,4 @@ -## Interface `MlValidateRequest` +# `MlValidateRequest` [interface-MlValidateRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlValidateResponse.md b/docs/reference/api/MlValidateResponse.md index 0f7a19c1f..715370573 100644 --- a/docs/reference/api/MlValidateResponse.md +++ b/docs/reference/api/MlValidateResponse.md @@ -1,4 +1,4 @@ -## `MlValidateResponse` -::: +# `MlValidateResponse` [alias-MlValidateResponse] +```typescript type MlValidateResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); -::: +``` diff --git a/docs/reference/api/MlValidationLoss.md b/docs/reference/api/MlValidationLoss.md index c02362dd9..03a17687f 100644 --- a/docs/reference/api/MlValidationLoss.md +++ b/docs/reference/api/MlValidationLoss.md @@ -1,4 +1,4 @@ -## Interface `MlValidationLoss` +# `MlValidationLoss` [interface-MlValidationLoss] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlVocabulary.md b/docs/reference/api/MlVocabulary.md index 479a92ca0..3d2d737d2 100644 --- a/docs/reference/api/MlVocabulary.md +++ b/docs/reference/api/MlVocabulary.md @@ -1,4 +1,4 @@ -## Interface `MlVocabulary` +# `MlVocabulary` [interface-MlVocabulary] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlXlmRobertaTokenizationConfig.md b/docs/reference/api/MlXlmRobertaTokenizationConfig.md index f06e6e711..51d5ef984 100644 --- a/docs/reference/api/MlXlmRobertaTokenizationConfig.md +++ b/docs/reference/api/MlXlmRobertaTokenizationConfig.md @@ -1,4 +1,4 @@ -## Interface `MlXlmRobertaTokenizationConfig` +# `MlXlmRobertaTokenizationConfig` [interface-MlXlmRobertaTokenizationConfig] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlZeroShotClassificationInferenceOptions.md b/docs/reference/api/MlZeroShotClassificationInferenceOptions.md index da2fe8162..eb3bfefaf 100644 --- a/docs/reference/api/MlZeroShotClassificationInferenceOptions.md +++ b/docs/reference/api/MlZeroShotClassificationInferenceOptions.md @@ -1,4 +1,4 @@ -## Interface `MlZeroShotClassificationInferenceOptions` +# `MlZeroShotClassificationInferenceOptions` [interface-MlZeroShotClassificationInferenceOptions] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MlZeroShotClassificationInferenceUpdateOptions.md b/docs/reference/api/MlZeroShotClassificationInferenceUpdateOptions.md index b3eb97404..30e9e581b 100644 --- a/docs/reference/api/MlZeroShotClassificationInferenceUpdateOptions.md +++ b/docs/reference/api/MlZeroShotClassificationInferenceUpdateOptions.md @@ -1,4 +1,4 @@ -## Interface `MlZeroShotClassificationInferenceUpdateOptions` +# `MlZeroShotClassificationInferenceUpdateOptions` [interface-MlZeroShotClassificationInferenceUpdateOptions] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/Monitoring.md b/docs/reference/api/Monitoring.md index b48ff2b57..a9ec8e3ce 100644 --- a/docs/reference/api/Monitoring.md +++ b/docs/reference/api/Monitoring.md @@ -1,19 +1,19 @@ -## `Monitoring` +# `Monitoring` [class-Monitoring] -### Constructor +## Constructor -::: +```typescript new Monitoring(transport: [Transport](./Transport.md)); -::: +``` -### Properties +## Properties [class-properties-Monitoring] | Name | Type | Description | | - | - | - | | `acceptedParams` | Record |   | | `transport` | [Transport](./Transport.md) |   | -### Methods +## Methods [class-methods-Monitoring] | Name | Signature | Description | | - | - | - | diff --git a/docs/reference/api/MonitoringBulkRequest.md b/docs/reference/api/MonitoringBulkRequest.md index b8c718100..00de403dd 100644 --- a/docs/reference/api/MonitoringBulkRequest.md +++ b/docs/reference/api/MonitoringBulkRequest.md @@ -1,4 +1,4 @@ -## Interface `MonitoringBulkRequest` +# `MonitoringBulkRequest` [interface-MonitoringBulkRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MonitoringBulkResponse.md b/docs/reference/api/MonitoringBulkResponse.md index 6f9a027bd..a84836321 100644 --- a/docs/reference/api/MonitoringBulkResponse.md +++ b/docs/reference/api/MonitoringBulkResponse.md @@ -1,4 +1,4 @@ -## Interface `MonitoringBulkResponse` +# `MonitoringBulkResponse` [interface-MonitoringBulkResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MsearchApi_1.md b/docs/reference/api/MsearchApi_1.md index 84fdab035..82f0775a1 100644 --- a/docs/reference/api/MsearchApi_1.md +++ b/docs/reference/api/MsearchApi_1.md @@ -1,3 +1,3 @@ -::: +```typescript default function MsearchApi>(this: [That](./That.md), params: [MsearchRequest](./MsearchRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MsearchResponse](./MsearchResponse.md)>; -::: +``` diff --git a/docs/reference/api/MsearchApi_2.md b/docs/reference/api/MsearchApi_2.md index b5042c23e..20eff9709 100644 --- a/docs/reference/api/MsearchApi_2.md +++ b/docs/reference/api/MsearchApi_2.md @@ -1,3 +1,3 @@ -::: +```typescript default function MsearchApi>(this: [That](./That.md), params: [MsearchRequest](./MsearchRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MsearchResponse](./MsearchResponse.md), unknown>>; -::: +``` diff --git a/docs/reference/api/MsearchApi_3.md b/docs/reference/api/MsearchApi_3.md index 688077abd..e890a6244 100644 --- a/docs/reference/api/MsearchApi_3.md +++ b/docs/reference/api/MsearchApi_3.md @@ -1,3 +1,3 @@ -::: +```typescript default function MsearchApi>(this: [That](./That.md), params: [MsearchRequest](./MsearchRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MsearchResponse](./MsearchResponse.md)>; -::: +``` diff --git a/docs/reference/api/MsearchHelper.md b/docs/reference/api/MsearchHelper.md index 0ec7fcfec..1aa99cfea 100644 --- a/docs/reference/api/MsearchHelper.md +++ b/docs/reference/api/MsearchHelper.md @@ -1,4 +1,4 @@ -## Interface `MsearchHelper` +# `MsearchHelper` [interface-MsearchHelper] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MsearchHelperOptions.md b/docs/reference/api/MsearchHelperOptions.md index 8ecaaadb0..9fd8cc0bb 100644 --- a/docs/reference/api/MsearchHelperOptions.md +++ b/docs/reference/api/MsearchHelperOptions.md @@ -1,4 +1,4 @@ -## Interface `MsearchHelperOptions` +# `MsearchHelperOptions` [interface-MsearchHelperOptions] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MsearchHelperResponse.md b/docs/reference/api/MsearchHelperResponse.md index 2c5263fa3..9756df99a 100644 --- a/docs/reference/api/MsearchHelperResponse.md +++ b/docs/reference/api/MsearchHelperResponse.md @@ -1,4 +1,4 @@ -## Interface `MsearchHelperResponse` +# `MsearchHelperResponse` [interface-MsearchHelperResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MsearchMultiSearchItem.md b/docs/reference/api/MsearchMultiSearchItem.md index 3f0fe5d2e..77963a3fe 100644 --- a/docs/reference/api/MsearchMultiSearchItem.md +++ b/docs/reference/api/MsearchMultiSearchItem.md @@ -1,4 +1,4 @@ -## Interface `MsearchMultiSearchItem` +# `MsearchMultiSearchItem` [interface-MsearchMultiSearchItem] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MsearchMultiSearchResult.md b/docs/reference/api/MsearchMultiSearchResult.md index f7d42fbcf..397dca889 100644 --- a/docs/reference/api/MsearchMultiSearchResult.md +++ b/docs/reference/api/MsearchMultiSearchResult.md @@ -1,4 +1,4 @@ -## Interface `MsearchMultiSearchResult` +# `MsearchMultiSearchResult` [interface-MsearchMultiSearchResult] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MsearchMultisearchHeader.md b/docs/reference/api/MsearchMultisearchHeader.md index 18891a544..722d3bd15 100644 --- a/docs/reference/api/MsearchMultisearchHeader.md +++ b/docs/reference/api/MsearchMultisearchHeader.md @@ -1,4 +1,4 @@ -## Interface `MsearchMultisearchHeader` +# `MsearchMultisearchHeader` [interface-MsearchMultisearchHeader] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MsearchRequest.md b/docs/reference/api/MsearchRequest.md index 6913c29ff..a66c9c194 100644 --- a/docs/reference/api/MsearchRequest.md +++ b/docs/reference/api/MsearchRequest.md @@ -1,4 +1,4 @@ -## Interface `MsearchRequest` +# `MsearchRequest` [interface-MsearchRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MsearchRequestItem.md b/docs/reference/api/MsearchRequestItem.md index 6109a71c0..5bfdc8bc5 100644 --- a/docs/reference/api/MsearchRequestItem.md +++ b/docs/reference/api/MsearchRequestItem.md @@ -1,4 +1,4 @@ -## `MsearchRequestItem` -::: +# `MsearchRequestItem` [alias-MsearchRequestItem] +```typescript type MsearchRequestItem = [MsearchMultisearchHeader](./MsearchMultisearchHeader.md) | [SearchSearchRequestBody](./SearchSearchRequestBody.md); -::: +``` diff --git a/docs/reference/api/MsearchResponse.md b/docs/reference/api/MsearchResponse.md index 7cf96c530..b5a753af3 100644 --- a/docs/reference/api/MsearchResponse.md +++ b/docs/reference/api/MsearchResponse.md @@ -1,4 +1,4 @@ -## `MsearchResponse` -::: +# `MsearchResponse` [alias-MsearchResponse] +```typescript type MsearchResponse> = [MsearchMultiSearchResult](./MsearchMultiSearchResult.md); -::: +``` diff --git a/docs/reference/api/MsearchResponseItem.md b/docs/reference/api/MsearchResponseItem.md index b758a53bc..114b30bc4 100644 --- a/docs/reference/api/MsearchResponseItem.md +++ b/docs/reference/api/MsearchResponseItem.md @@ -1,4 +1,4 @@ -## `MsearchResponseItem` -::: +# `MsearchResponseItem` [alias-MsearchResponseItem] +```typescript type MsearchResponseItem = [MsearchMultiSearchItem](./MsearchMultiSearchItem.md) | [ErrorResponseBase](./ErrorResponseBase.md); -::: +``` diff --git a/docs/reference/api/MsearchTemplateApi_1.md b/docs/reference/api/MsearchTemplateApi_1.md index 485cbe4a9..1b9780dba 100644 --- a/docs/reference/api/MsearchTemplateApi_1.md +++ b/docs/reference/api/MsearchTemplateApi_1.md @@ -1,3 +1,3 @@ -::: +```typescript default function MsearchTemplateApi>(this: [That](./That.md), params: [MsearchTemplateRequest](./MsearchTemplateRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MsearchTemplateResponse](./MsearchTemplateResponse.md)>; -::: +``` diff --git a/docs/reference/api/MsearchTemplateApi_2.md b/docs/reference/api/MsearchTemplateApi_2.md index 0299f947b..39a634a70 100644 --- a/docs/reference/api/MsearchTemplateApi_2.md +++ b/docs/reference/api/MsearchTemplateApi_2.md @@ -1,3 +1,3 @@ -::: +```typescript default function MsearchTemplateApi>(this: [That](./That.md), params: [MsearchTemplateRequest](./MsearchTemplateRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MsearchTemplateResponse](./MsearchTemplateResponse.md), unknown>>; -::: +``` diff --git a/docs/reference/api/MsearchTemplateApi_3.md b/docs/reference/api/MsearchTemplateApi_3.md index d2f127a6e..e9a6c7365 100644 --- a/docs/reference/api/MsearchTemplateApi_3.md +++ b/docs/reference/api/MsearchTemplateApi_3.md @@ -1,3 +1,3 @@ -::: +```typescript default function MsearchTemplateApi>(this: [That](./That.md), params: [MsearchTemplateRequest](./MsearchTemplateRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MsearchTemplateResponse](./MsearchTemplateResponse.md)>; -::: +``` diff --git a/docs/reference/api/MsearchTemplateRequest.md b/docs/reference/api/MsearchTemplateRequest.md index bd3c257e7..c2baa695a 100644 --- a/docs/reference/api/MsearchTemplateRequest.md +++ b/docs/reference/api/MsearchTemplateRequest.md @@ -1,4 +1,4 @@ -## Interface `MsearchTemplateRequest` +# `MsearchTemplateRequest` [interface-MsearchTemplateRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MsearchTemplateRequestItem.md b/docs/reference/api/MsearchTemplateRequestItem.md index 38843dbea..d8fdb9e97 100644 --- a/docs/reference/api/MsearchTemplateRequestItem.md +++ b/docs/reference/api/MsearchTemplateRequestItem.md @@ -1,4 +1,4 @@ -## `MsearchTemplateRequestItem` -::: +# `MsearchTemplateRequestItem` [alias-MsearchTemplateRequestItem] +```typescript type MsearchTemplateRequestItem = [MsearchMultisearchHeader](./MsearchMultisearchHeader.md) | [MsearchTemplateTemplateConfig](./MsearchTemplateTemplateConfig.md); -::: +``` diff --git a/docs/reference/api/MsearchTemplateResponse.md b/docs/reference/api/MsearchTemplateResponse.md index af06bc769..86ea92a9f 100644 --- a/docs/reference/api/MsearchTemplateResponse.md +++ b/docs/reference/api/MsearchTemplateResponse.md @@ -1,4 +1,4 @@ -## `MsearchTemplateResponse` -::: +# `MsearchTemplateResponse` [alias-MsearchTemplateResponse] +```typescript type MsearchTemplateResponse> = [MsearchMultiSearchResult](./MsearchMultiSearchResult.md); -::: +``` diff --git a/docs/reference/api/MsearchTemplateTemplateConfig.md b/docs/reference/api/MsearchTemplateTemplateConfig.md index 1531e91c8..e52c41fbe 100644 --- a/docs/reference/api/MsearchTemplateTemplateConfig.md +++ b/docs/reference/api/MsearchTemplateTemplateConfig.md @@ -1,4 +1,4 @@ -## Interface `MsearchTemplateTemplateConfig` +# `MsearchTemplateTemplateConfig` [interface-MsearchTemplateTemplateConfig] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MtermvectorsApi_1.md b/docs/reference/api/MtermvectorsApi_1.md index 750bc88b8..fb12c7549 100644 --- a/docs/reference/api/MtermvectorsApi_1.md +++ b/docs/reference/api/MtermvectorsApi_1.md @@ -1,3 +1,3 @@ -::: +```typescript default function MtermvectorsApi(this: [That](./That.md), params?: [MtermvectorsRequest](./MtermvectorsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MtermvectorsResponse](./MtermvectorsResponse.md)>; -::: +``` diff --git a/docs/reference/api/MtermvectorsApi_2.md b/docs/reference/api/MtermvectorsApi_2.md index 06ff7289c..66cb2d89f 100644 --- a/docs/reference/api/MtermvectorsApi_2.md +++ b/docs/reference/api/MtermvectorsApi_2.md @@ -1,3 +1,3 @@ -::: +```typescript default function MtermvectorsApi(this: [That](./That.md), params?: [MtermvectorsRequest](./MtermvectorsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MtermvectorsResponse](./MtermvectorsResponse.md), unknown>>; -::: +``` diff --git a/docs/reference/api/MtermvectorsApi_3.md b/docs/reference/api/MtermvectorsApi_3.md index 5ff94be24..6c5878048 100644 --- a/docs/reference/api/MtermvectorsApi_3.md +++ b/docs/reference/api/MtermvectorsApi_3.md @@ -1,3 +1,3 @@ -::: +```typescript default function MtermvectorsApi(this: [That](./That.md), params?: [MtermvectorsRequest](./MtermvectorsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MtermvectorsResponse](./MtermvectorsResponse.md)>; -::: +``` diff --git a/docs/reference/api/MtermvectorsOperation.md b/docs/reference/api/MtermvectorsOperation.md index f6afe144d..5c25e91c0 100644 --- a/docs/reference/api/MtermvectorsOperation.md +++ b/docs/reference/api/MtermvectorsOperation.md @@ -1,4 +1,4 @@ -## Interface `MtermvectorsOperation` +# `MtermvectorsOperation` [interface-MtermvectorsOperation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MtermvectorsRequest.md b/docs/reference/api/MtermvectorsRequest.md index 7f78fd0f9..b8c3ee67b 100644 --- a/docs/reference/api/MtermvectorsRequest.md +++ b/docs/reference/api/MtermvectorsRequest.md @@ -1,4 +1,4 @@ -## Interface `MtermvectorsRequest` +# `MtermvectorsRequest` [interface-MtermvectorsRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MtermvectorsResponse.md b/docs/reference/api/MtermvectorsResponse.md index 6ac6727ce..db7d36e89 100644 --- a/docs/reference/api/MtermvectorsResponse.md +++ b/docs/reference/api/MtermvectorsResponse.md @@ -1,4 +1,4 @@ -## Interface `MtermvectorsResponse` +# `MtermvectorsResponse` [interface-MtermvectorsResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MtermvectorsTermVectorsResult.md b/docs/reference/api/MtermvectorsTermVectorsResult.md index 62442602c..5a5f073a7 100644 --- a/docs/reference/api/MtermvectorsTermVectorsResult.md +++ b/docs/reference/api/MtermvectorsTermVectorsResult.md @@ -1,4 +1,4 @@ -## Interface `MtermvectorsTermVectorsResult` +# `MtermvectorsTermVectorsResult` [interface-MtermvectorsTermVectorsResult] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/MultiTermQueryRewrite.md b/docs/reference/api/MultiTermQueryRewrite.md index 55a9ae49b..f21a0e38a 100644 --- a/docs/reference/api/MultiTermQueryRewrite.md +++ b/docs/reference/api/MultiTermQueryRewrite.md @@ -1,4 +1,4 @@ -## `MultiTermQueryRewrite` -::: +# `MultiTermQueryRewrite` [alias-MultiTermQueryRewrite] +```typescript type MultiTermQueryRewrite = string; -::: +``` diff --git a/docs/reference/api/Name.md b/docs/reference/api/Name.md index cff4ff4ad..5f2b683c8 100644 --- a/docs/reference/api/Name.md +++ b/docs/reference/api/Name.md @@ -1,4 +1,4 @@ -## `Name` -::: +# `Name` [alias-Name] +```typescript type Name = string; -::: +``` diff --git a/docs/reference/api/Names.md b/docs/reference/api/Names.md index 5e34e868e..a97688c9a 100644 --- a/docs/reference/api/Names.md +++ b/docs/reference/api/Names.md @@ -1,4 +1,4 @@ -## `Names` -::: +# `Names` [alias-Names] +```typescript type Names = [Name](./Name.md) | [Name](./Name.md)[]; -::: +``` diff --git a/docs/reference/api/Namespace.md b/docs/reference/api/Namespace.md index a03f8fcca..a1f088f5e 100644 --- a/docs/reference/api/Namespace.md +++ b/docs/reference/api/Namespace.md @@ -1,4 +1,4 @@ -## `Namespace` -::: +# `Namespace` [alias-Namespace] +```typescript type Namespace = string; -::: +``` diff --git a/docs/reference/api/NestedSortValue.md b/docs/reference/api/NestedSortValue.md index a154b2bb3..4a9a7a23c 100644 --- a/docs/reference/api/NestedSortValue.md +++ b/docs/reference/api/NestedSortValue.md @@ -1,4 +1,4 @@ -## Interface `NestedSortValue` +# `NestedSortValue` [interface-NestedSortValue] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodeAttributes.md b/docs/reference/api/NodeAttributes.md index 10a1f0e4a..f3d67b41e 100644 --- a/docs/reference/api/NodeAttributes.md +++ b/docs/reference/api/NodeAttributes.md @@ -1,4 +1,4 @@ -## Interface `NodeAttributes` +# `NodeAttributes` [interface-NodeAttributes] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodeId.md b/docs/reference/api/NodeId.md index d25127ee4..79ec5c3a4 100644 --- a/docs/reference/api/NodeId.md +++ b/docs/reference/api/NodeId.md @@ -1,4 +1,4 @@ -## `NodeId` -::: +# `NodeId` [alias-NodeId] +```typescript type NodeId = string; -::: +``` diff --git a/docs/reference/api/NodeIds.md b/docs/reference/api/NodeIds.md index 3035274bf..d54d5d5be 100644 --- a/docs/reference/api/NodeIds.md +++ b/docs/reference/api/NodeIds.md @@ -1,4 +1,4 @@ -## `NodeIds` -::: +# `NodeIds` [alias-NodeIds] +```typescript type NodeIds = [NodeId](./NodeId.md) | [NodeId](./NodeId.md)[]; -::: +``` diff --git a/docs/reference/api/NodeName.md b/docs/reference/api/NodeName.md index ebc5ef517..2505876ae 100644 --- a/docs/reference/api/NodeName.md +++ b/docs/reference/api/NodeName.md @@ -1,4 +1,4 @@ -## `NodeName` -::: +# `NodeName` [alias-NodeName] +```typescript type NodeName = string; -::: +``` diff --git a/docs/reference/api/NodeOptions.md b/docs/reference/api/NodeOptions.md index bfe94d8ba..f9efd8bb7 100644 --- a/docs/reference/api/NodeOptions.md +++ b/docs/reference/api/NodeOptions.md @@ -1,4 +1,4 @@ -## Interface `NodeOptions` +# `NodeOptions` [interface-NodeOptions] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodeRole.md b/docs/reference/api/NodeRole.md index 7a864e11c..9aabc67fd 100644 --- a/docs/reference/api/NodeRole.md +++ b/docs/reference/api/NodeRole.md @@ -1,4 +1,4 @@ -## `NodeRole` -::: +# `NodeRole` [alias-NodeRole] +```typescript type NodeRole = 'master' | 'data' | 'data_cold' | 'data_content' | 'data_frozen' | 'data_hot' | 'data_warm' | 'client' | 'ingest' | 'ml' | 'voting_only' | 'transform' | 'remote_cluster_client' | 'coordinating_only'; -::: +``` diff --git a/docs/reference/api/NodeRoles.md b/docs/reference/api/NodeRoles.md index a687f5ba9..7dde6263a 100644 --- a/docs/reference/api/NodeRoles.md +++ b/docs/reference/api/NodeRoles.md @@ -1,4 +1,4 @@ -## `NodeRoles` -::: +# `NodeRoles` [alias-NodeRoles] +```typescript type NodeRoles = [NodeRole](./NodeRole.md)[]; -::: +``` diff --git a/docs/reference/api/NodeShard.md b/docs/reference/api/NodeShard.md index 6c79e84f2..c415b6325 100644 --- a/docs/reference/api/NodeShard.md +++ b/docs/reference/api/NodeShard.md @@ -1,4 +1,4 @@ -## Interface `NodeShard` +# `NodeShard` [interface-NodeShard] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodeStatistics.md b/docs/reference/api/NodeStatistics.md index 103a69a78..33de9a177 100644 --- a/docs/reference/api/NodeStatistics.md +++ b/docs/reference/api/NodeStatistics.md @@ -1,4 +1,4 @@ -## Interface `NodeStatistics` +# `NodeStatistics` [interface-NodeStatistics] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/Nodes.md b/docs/reference/api/Nodes.md index 09b7dbf29..fea81a647 100644 --- a/docs/reference/api/Nodes.md +++ b/docs/reference/api/Nodes.md @@ -1,19 +1,19 @@ -## `Nodes` +# `Nodes` [class-Nodes] -### Constructor +## Constructor -::: +```typescript new Nodes(transport: [Transport](./Transport.md)); -::: +``` -### Properties +## Properties [class-properties-Nodes] | Name | Type | Description | | - | - | - | | `acceptedParams` | Record |   | | `transport` | [Transport](./Transport.md) |   | -### Methods +## Methods [class-methods-Nodes] | Name | Signature | Description | | - | - | - | diff --git a/docs/reference/api/NodesAdaptiveSelection.md b/docs/reference/api/NodesAdaptiveSelection.md index acede7bf6..5986f9bec 100644 --- a/docs/reference/api/NodesAdaptiveSelection.md +++ b/docs/reference/api/NodesAdaptiveSelection.md @@ -1,4 +1,4 @@ -## Interface `NodesAdaptiveSelection` +# `NodesAdaptiveSelection` [interface-NodesAdaptiveSelection] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesBreaker.md b/docs/reference/api/NodesBreaker.md index e9e8053c6..3632486e8 100644 --- a/docs/reference/api/NodesBreaker.md +++ b/docs/reference/api/NodesBreaker.md @@ -1,4 +1,4 @@ -## Interface `NodesBreaker` +# `NodesBreaker` [interface-NodesBreaker] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesCgroup.md b/docs/reference/api/NodesCgroup.md index d1e862dcd..96de7476c 100644 --- a/docs/reference/api/NodesCgroup.md +++ b/docs/reference/api/NodesCgroup.md @@ -1,4 +1,4 @@ -## Interface `NodesCgroup` +# `NodesCgroup` [interface-NodesCgroup] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesCgroupCpu.md b/docs/reference/api/NodesCgroupCpu.md index 207ef1d1f..54d7900ec 100644 --- a/docs/reference/api/NodesCgroupCpu.md +++ b/docs/reference/api/NodesCgroupCpu.md @@ -1,4 +1,4 @@ -## Interface `NodesCgroupCpu` +# `NodesCgroupCpu` [interface-NodesCgroupCpu] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesCgroupCpuStat.md b/docs/reference/api/NodesCgroupCpuStat.md index ecf43b8d4..00edf300b 100644 --- a/docs/reference/api/NodesCgroupCpuStat.md +++ b/docs/reference/api/NodesCgroupCpuStat.md @@ -1,4 +1,4 @@ -## Interface `NodesCgroupCpuStat` +# `NodesCgroupCpuStat` [interface-NodesCgroupCpuStat] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesCgroupMemory.md b/docs/reference/api/NodesCgroupMemory.md index 734df45d8..400ead2cc 100644 --- a/docs/reference/api/NodesCgroupMemory.md +++ b/docs/reference/api/NodesCgroupMemory.md @@ -1,4 +1,4 @@ -## Interface `NodesCgroupMemory` +# `NodesCgroupMemory` [interface-NodesCgroupMemory] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesClearRepositoriesMeteringArchiveRequest.md b/docs/reference/api/NodesClearRepositoriesMeteringArchiveRequest.md index 849a4ce3c..dacf89b61 100644 --- a/docs/reference/api/NodesClearRepositoriesMeteringArchiveRequest.md +++ b/docs/reference/api/NodesClearRepositoriesMeteringArchiveRequest.md @@ -1,4 +1,4 @@ -## Interface `NodesClearRepositoriesMeteringArchiveRequest` +# `NodesClearRepositoriesMeteringArchiveRequest` [interface-NodesClearRepositoriesMeteringArchiveRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesClearRepositoriesMeteringArchiveResponse.md b/docs/reference/api/NodesClearRepositoriesMeteringArchiveResponse.md index 55c07b010..10ba49847 100644 --- a/docs/reference/api/NodesClearRepositoriesMeteringArchiveResponse.md +++ b/docs/reference/api/NodesClearRepositoriesMeteringArchiveResponse.md @@ -1,4 +1,4 @@ -## `NodesClearRepositoriesMeteringArchiveResponse` -::: +# `NodesClearRepositoriesMeteringArchiveResponse` [alias-NodesClearRepositoriesMeteringArchiveResponse] +```typescript type NodesClearRepositoriesMeteringArchiveResponse = [NodesClearRepositoriesMeteringArchiveResponseBase](./NodesClearRepositoriesMeteringArchiveResponseBase.md); -::: +``` diff --git a/docs/reference/api/NodesClearRepositoriesMeteringArchiveResponseBase.md b/docs/reference/api/NodesClearRepositoriesMeteringArchiveResponseBase.md index 7a7c81e57..09555176c 100644 --- a/docs/reference/api/NodesClearRepositoriesMeteringArchiveResponseBase.md +++ b/docs/reference/api/NodesClearRepositoriesMeteringArchiveResponseBase.md @@ -1,4 +1,4 @@ -## Interface `NodesClearRepositoriesMeteringArchiveResponseBase` +# `NodesClearRepositoriesMeteringArchiveResponseBase` [interface-NodesClearRepositoriesMeteringArchiveResponseBase] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesClient.md b/docs/reference/api/NodesClient.md index 72934c22f..2c0a46d42 100644 --- a/docs/reference/api/NodesClient.md +++ b/docs/reference/api/NodesClient.md @@ -1,4 +1,4 @@ -## Interface `NodesClient` +# `NodesClient` [interface-NodesClient] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesClusterAppliedStats.md b/docs/reference/api/NodesClusterAppliedStats.md index eeef14c99..2f7853c8d 100644 --- a/docs/reference/api/NodesClusterAppliedStats.md +++ b/docs/reference/api/NodesClusterAppliedStats.md @@ -1,4 +1,4 @@ -## Interface `NodesClusterAppliedStats` +# `NodesClusterAppliedStats` [interface-NodesClusterAppliedStats] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesClusterStateQueue.md b/docs/reference/api/NodesClusterStateQueue.md index fbc106fd5..eef79ed4d 100644 --- a/docs/reference/api/NodesClusterStateQueue.md +++ b/docs/reference/api/NodesClusterStateQueue.md @@ -1,4 +1,4 @@ -## Interface `NodesClusterStateQueue` +# `NodesClusterStateQueue` [interface-NodesClusterStateQueue] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesClusterStateUpdate.md b/docs/reference/api/NodesClusterStateUpdate.md index 955ebe4c5..a7b3cf45a 100644 --- a/docs/reference/api/NodesClusterStateUpdate.md +++ b/docs/reference/api/NodesClusterStateUpdate.md @@ -1,4 +1,4 @@ -## Interface `NodesClusterStateUpdate` +# `NodesClusterStateUpdate` [interface-NodesClusterStateUpdate] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesContext.md b/docs/reference/api/NodesContext.md index 6af796788..a94e4ab93 100644 --- a/docs/reference/api/NodesContext.md +++ b/docs/reference/api/NodesContext.md @@ -1,4 +1,4 @@ -## Interface `NodesContext` +# `NodesContext` [interface-NodesContext] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesCpu.md b/docs/reference/api/NodesCpu.md index 1f46b4d1a..429ce73d7 100644 --- a/docs/reference/api/NodesCpu.md +++ b/docs/reference/api/NodesCpu.md @@ -1,4 +1,4 @@ -## Interface `NodesCpu` +# `NodesCpu` [interface-NodesCpu] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesCpuAcct.md b/docs/reference/api/NodesCpuAcct.md index 244908115..dc41dfcae 100644 --- a/docs/reference/api/NodesCpuAcct.md +++ b/docs/reference/api/NodesCpuAcct.md @@ -1,4 +1,4 @@ -## Interface `NodesCpuAcct` +# `NodesCpuAcct` [interface-NodesCpuAcct] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesDataPathStats.md b/docs/reference/api/NodesDataPathStats.md index 240cae9e1..17ea37e09 100644 --- a/docs/reference/api/NodesDataPathStats.md +++ b/docs/reference/api/NodesDataPathStats.md @@ -1,4 +1,4 @@ -## Interface `NodesDataPathStats` +# `NodesDataPathStats` [interface-NodesDataPathStats] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesDiscovery.md b/docs/reference/api/NodesDiscovery.md index 4fe170b33..0e3094c9c 100644 --- a/docs/reference/api/NodesDiscovery.md +++ b/docs/reference/api/NodesDiscovery.md @@ -1,4 +1,4 @@ -## Interface `NodesDiscovery` +# `NodesDiscovery` [interface-NodesDiscovery] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesExtendedMemoryStats.md b/docs/reference/api/NodesExtendedMemoryStats.md index 961f9c8d1..844c3b452 100644 --- a/docs/reference/api/NodesExtendedMemoryStats.md +++ b/docs/reference/api/NodesExtendedMemoryStats.md @@ -1,4 +1,4 @@ -## Interface `NodesExtendedMemoryStats` +# `NodesExtendedMemoryStats` [interface-NodesExtendedMemoryStats] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesFileSystem.md b/docs/reference/api/NodesFileSystem.md index 18d164ea6..89b351b26 100644 --- a/docs/reference/api/NodesFileSystem.md +++ b/docs/reference/api/NodesFileSystem.md @@ -1,4 +1,4 @@ -## Interface `NodesFileSystem` +# `NodesFileSystem` [interface-NodesFileSystem] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesFileSystemTotal.md b/docs/reference/api/NodesFileSystemTotal.md index 39cc87029..0635a04ba 100644 --- a/docs/reference/api/NodesFileSystemTotal.md +++ b/docs/reference/api/NodesFileSystemTotal.md @@ -1,4 +1,4 @@ -## Interface `NodesFileSystemTotal` +# `NodesFileSystemTotal` [interface-NodesFileSystemTotal] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesGarbageCollector.md b/docs/reference/api/NodesGarbageCollector.md index 8d5a70c02..da8053bdd 100644 --- a/docs/reference/api/NodesGarbageCollector.md +++ b/docs/reference/api/NodesGarbageCollector.md @@ -1,4 +1,4 @@ -## Interface `NodesGarbageCollector` +# `NodesGarbageCollector` [interface-NodesGarbageCollector] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesGarbageCollectorTotal.md b/docs/reference/api/NodesGarbageCollectorTotal.md index 5c9a6343f..56c19502f 100644 --- a/docs/reference/api/NodesGarbageCollectorTotal.md +++ b/docs/reference/api/NodesGarbageCollectorTotal.md @@ -1,4 +1,4 @@ -## Interface `NodesGarbageCollectorTotal` +# `NodesGarbageCollectorTotal` [interface-NodesGarbageCollectorTotal] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesGetRepositoriesMeteringInfoRequest.md b/docs/reference/api/NodesGetRepositoriesMeteringInfoRequest.md index e71d50a20..e8b442e04 100644 --- a/docs/reference/api/NodesGetRepositoriesMeteringInfoRequest.md +++ b/docs/reference/api/NodesGetRepositoriesMeteringInfoRequest.md @@ -1,4 +1,4 @@ -## Interface `NodesGetRepositoriesMeteringInfoRequest` +# `NodesGetRepositoriesMeteringInfoRequest` [interface-NodesGetRepositoriesMeteringInfoRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesGetRepositoriesMeteringInfoResponse.md b/docs/reference/api/NodesGetRepositoriesMeteringInfoResponse.md index 7a4c826dd..e2424bead 100644 --- a/docs/reference/api/NodesGetRepositoriesMeteringInfoResponse.md +++ b/docs/reference/api/NodesGetRepositoriesMeteringInfoResponse.md @@ -1,4 +1,4 @@ -## `NodesGetRepositoriesMeteringInfoResponse` -::: +# `NodesGetRepositoriesMeteringInfoResponse` [alias-NodesGetRepositoriesMeteringInfoResponse] +```typescript type NodesGetRepositoriesMeteringInfoResponse = [NodesGetRepositoriesMeteringInfoResponseBase](./NodesGetRepositoriesMeteringInfoResponseBase.md); -::: +``` diff --git a/docs/reference/api/NodesGetRepositoriesMeteringInfoResponseBase.md b/docs/reference/api/NodesGetRepositoriesMeteringInfoResponseBase.md index 97a2195d6..7f2293322 100644 --- a/docs/reference/api/NodesGetRepositoriesMeteringInfoResponseBase.md +++ b/docs/reference/api/NodesGetRepositoriesMeteringInfoResponseBase.md @@ -1,4 +1,4 @@ -## Interface `NodesGetRepositoriesMeteringInfoResponseBase` +# `NodesGetRepositoriesMeteringInfoResponseBase` [interface-NodesGetRepositoriesMeteringInfoResponseBase] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesHotThreadsRequest.md b/docs/reference/api/NodesHotThreadsRequest.md index 776ebdeac..8199fd8d5 100644 --- a/docs/reference/api/NodesHotThreadsRequest.md +++ b/docs/reference/api/NodesHotThreadsRequest.md @@ -1,4 +1,4 @@ -## Interface `NodesHotThreadsRequest` +# `NodesHotThreadsRequest` [interface-NodesHotThreadsRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesHotThreadsResponse.md b/docs/reference/api/NodesHotThreadsResponse.md index 74cb30af3..f88fb80df 100644 --- a/docs/reference/api/NodesHotThreadsResponse.md +++ b/docs/reference/api/NodesHotThreadsResponse.md @@ -1,4 +1,4 @@ -## Interface `NodesHotThreadsResponse` +# `NodesHotThreadsResponse` [interface-NodesHotThreadsResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesHttp.md b/docs/reference/api/NodesHttp.md index b96796c54..1521d29c2 100644 --- a/docs/reference/api/NodesHttp.md +++ b/docs/reference/api/NodesHttp.md @@ -1,4 +1,4 @@ -## Interface `NodesHttp` +# `NodesHttp` [interface-NodesHttp] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesHttpRoute.md b/docs/reference/api/NodesHttpRoute.md index 8f25d3cb9..4063c10de 100644 --- a/docs/reference/api/NodesHttpRoute.md +++ b/docs/reference/api/NodesHttpRoute.md @@ -1,4 +1,4 @@ -## Interface `NodesHttpRoute` +# `NodesHttpRoute` [interface-NodesHttpRoute] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesHttpRouteRequests.md b/docs/reference/api/NodesHttpRouteRequests.md index 7fc796303..f55f7c987 100644 --- a/docs/reference/api/NodesHttpRouteRequests.md +++ b/docs/reference/api/NodesHttpRouteRequests.md @@ -1,4 +1,4 @@ -## Interface `NodesHttpRouteRequests` +# `NodesHttpRouteRequests` [interface-NodesHttpRouteRequests] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesHttpRouteResponses.md b/docs/reference/api/NodesHttpRouteResponses.md index 9bb2b0f79..0d6980cb7 100644 --- a/docs/reference/api/NodesHttpRouteResponses.md +++ b/docs/reference/api/NodesHttpRouteResponses.md @@ -1,4 +1,4 @@ -## Interface `NodesHttpRouteResponses` +# `NodesHttpRouteResponses` [interface-NodesHttpRouteResponses] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesIndexingPressure.md b/docs/reference/api/NodesIndexingPressure.md index 76d057568..292a4eb46 100644 --- a/docs/reference/api/NodesIndexingPressure.md +++ b/docs/reference/api/NodesIndexingPressure.md @@ -1,4 +1,4 @@ -## Interface `NodesIndexingPressure` +# `NodesIndexingPressure` [interface-NodesIndexingPressure] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesIndexingPressureMemory.md b/docs/reference/api/NodesIndexingPressureMemory.md index a49652090..c40d6870f 100644 --- a/docs/reference/api/NodesIndexingPressureMemory.md +++ b/docs/reference/api/NodesIndexingPressureMemory.md @@ -1,4 +1,4 @@ -## Interface `NodesIndexingPressureMemory` +# `NodesIndexingPressureMemory` [interface-NodesIndexingPressureMemory] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesInfoDeprecationIndexing.md b/docs/reference/api/NodesInfoDeprecationIndexing.md index ca0c563e5..3c21b522f 100644 --- a/docs/reference/api/NodesInfoDeprecationIndexing.md +++ b/docs/reference/api/NodesInfoDeprecationIndexing.md @@ -1,4 +1,4 @@ -## Interface `NodesInfoDeprecationIndexing` +# `NodesInfoDeprecationIndexing` [interface-NodesInfoDeprecationIndexing] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesInfoNodeInfo.md b/docs/reference/api/NodesInfoNodeInfo.md index 900dc9829..f26df82c4 100644 --- a/docs/reference/api/NodesInfoNodeInfo.md +++ b/docs/reference/api/NodesInfoNodeInfo.md @@ -1,4 +1,4 @@ -## Interface `NodesInfoNodeInfo` +# `NodesInfoNodeInfo` [interface-NodesInfoNodeInfo] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesInfoNodeInfoAction.md b/docs/reference/api/NodesInfoNodeInfoAction.md index 6dfcf50c3..139a2b121 100644 --- a/docs/reference/api/NodesInfoNodeInfoAction.md +++ b/docs/reference/api/NodesInfoNodeInfoAction.md @@ -1,4 +1,4 @@ -## Interface `NodesInfoNodeInfoAction` +# `NodesInfoNodeInfoAction` [interface-NodesInfoNodeInfoAction] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesInfoNodeInfoAggregation.md b/docs/reference/api/NodesInfoNodeInfoAggregation.md index be45ff4c3..0b0e534ec 100644 --- a/docs/reference/api/NodesInfoNodeInfoAggregation.md +++ b/docs/reference/api/NodesInfoNodeInfoAggregation.md @@ -1,4 +1,4 @@ -## Interface `NodesInfoNodeInfoAggregation` +# `NodesInfoNodeInfoAggregation` [interface-NodesInfoNodeInfoAggregation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesInfoNodeInfoBootstrap.md b/docs/reference/api/NodesInfoNodeInfoBootstrap.md index 74373b6bf..62380a2b2 100644 --- a/docs/reference/api/NodesInfoNodeInfoBootstrap.md +++ b/docs/reference/api/NodesInfoNodeInfoBootstrap.md @@ -1,4 +1,4 @@ -## Interface `NodesInfoNodeInfoBootstrap` +# `NodesInfoNodeInfoBootstrap` [interface-NodesInfoNodeInfoBootstrap] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesInfoNodeInfoClient.md b/docs/reference/api/NodesInfoNodeInfoClient.md index ee128826d..aae9506e4 100644 --- a/docs/reference/api/NodesInfoNodeInfoClient.md +++ b/docs/reference/api/NodesInfoNodeInfoClient.md @@ -1,4 +1,4 @@ -## Interface `NodesInfoNodeInfoClient` +# `NodesInfoNodeInfoClient` [interface-NodesInfoNodeInfoClient] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesInfoNodeInfoDiscover.md b/docs/reference/api/NodesInfoNodeInfoDiscover.md index eb25b42aa..358244edd 100644 --- a/docs/reference/api/NodesInfoNodeInfoDiscover.md +++ b/docs/reference/api/NodesInfoNodeInfoDiscover.md @@ -1,4 +1,4 @@ -## `NodesInfoNodeInfoDiscover` -::: +# `NodesInfoNodeInfoDiscover` [alias-NodesInfoNodeInfoDiscover] +```typescript type NodesInfoNodeInfoDiscover = [NodesInfoNodeInfoDiscoverKeys](./NodesInfoNodeInfoDiscoverKeys.md) & { [property: string]: any;}; -::: +``` diff --git a/docs/reference/api/NodesInfoNodeInfoDiscoverKeys.md b/docs/reference/api/NodesInfoNodeInfoDiscoverKeys.md index c390506d4..43c65709b 100644 --- a/docs/reference/api/NodesInfoNodeInfoDiscoverKeys.md +++ b/docs/reference/api/NodesInfoNodeInfoDiscoverKeys.md @@ -1,4 +1,4 @@ -## Interface `NodesInfoNodeInfoDiscoverKeys` +# `NodesInfoNodeInfoDiscoverKeys` [interface-NodesInfoNodeInfoDiscoverKeys] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesInfoNodeInfoHttp.md b/docs/reference/api/NodesInfoNodeInfoHttp.md index 54f048686..6f44faa1b 100644 --- a/docs/reference/api/NodesInfoNodeInfoHttp.md +++ b/docs/reference/api/NodesInfoNodeInfoHttp.md @@ -1,4 +1,4 @@ -## Interface `NodesInfoNodeInfoHttp` +# `NodesInfoNodeInfoHttp` [interface-NodesInfoNodeInfoHttp] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesInfoNodeInfoIngest.md b/docs/reference/api/NodesInfoNodeInfoIngest.md index 6f5c3871d..c50a29a49 100644 --- a/docs/reference/api/NodesInfoNodeInfoIngest.md +++ b/docs/reference/api/NodesInfoNodeInfoIngest.md @@ -1,4 +1,4 @@ -## Interface `NodesInfoNodeInfoIngest` +# `NodesInfoNodeInfoIngest` [interface-NodesInfoNodeInfoIngest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesInfoNodeInfoIngestDownloader.md b/docs/reference/api/NodesInfoNodeInfoIngestDownloader.md index 24ae7d605..3a712f6d5 100644 --- a/docs/reference/api/NodesInfoNodeInfoIngestDownloader.md +++ b/docs/reference/api/NodesInfoNodeInfoIngestDownloader.md @@ -1,4 +1,4 @@ -## Interface `NodesInfoNodeInfoIngestDownloader` +# `NodesInfoNodeInfoIngestDownloader` [interface-NodesInfoNodeInfoIngestDownloader] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesInfoNodeInfoIngestInfo.md b/docs/reference/api/NodesInfoNodeInfoIngestInfo.md index d8a649f4b..ab35598a5 100644 --- a/docs/reference/api/NodesInfoNodeInfoIngestInfo.md +++ b/docs/reference/api/NodesInfoNodeInfoIngestInfo.md @@ -1,4 +1,4 @@ -## Interface `NodesInfoNodeInfoIngestInfo` +# `NodesInfoNodeInfoIngestInfo` [interface-NodesInfoNodeInfoIngestInfo] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesInfoNodeInfoIngestProcessor.md b/docs/reference/api/NodesInfoNodeInfoIngestProcessor.md index ad1e2cc7e..ad9ee3f8f 100644 --- a/docs/reference/api/NodesInfoNodeInfoIngestProcessor.md +++ b/docs/reference/api/NodesInfoNodeInfoIngestProcessor.md @@ -1,4 +1,4 @@ -## Interface `NodesInfoNodeInfoIngestProcessor` +# `NodesInfoNodeInfoIngestProcessor` [interface-NodesInfoNodeInfoIngestProcessor] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesInfoNodeInfoJvmMemory.md b/docs/reference/api/NodesInfoNodeInfoJvmMemory.md index b2df1cd9f..e091edb61 100644 --- a/docs/reference/api/NodesInfoNodeInfoJvmMemory.md +++ b/docs/reference/api/NodesInfoNodeInfoJvmMemory.md @@ -1,4 +1,4 @@ -## Interface `NodesInfoNodeInfoJvmMemory` +# `NodesInfoNodeInfoJvmMemory` [interface-NodesInfoNodeInfoJvmMemory] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesInfoNodeInfoMemory.md b/docs/reference/api/NodesInfoNodeInfoMemory.md index 14d7b8603..1a7f6bbd7 100644 --- a/docs/reference/api/NodesInfoNodeInfoMemory.md +++ b/docs/reference/api/NodesInfoNodeInfoMemory.md @@ -1,4 +1,4 @@ -## Interface `NodesInfoNodeInfoMemory` +# `NodesInfoNodeInfoMemory` [interface-NodesInfoNodeInfoMemory] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesInfoNodeInfoNetwork.md b/docs/reference/api/NodesInfoNodeInfoNetwork.md index e3710a398..f0bb3bb12 100644 --- a/docs/reference/api/NodesInfoNodeInfoNetwork.md +++ b/docs/reference/api/NodesInfoNodeInfoNetwork.md @@ -1,4 +1,4 @@ -## Interface `NodesInfoNodeInfoNetwork` +# `NodesInfoNodeInfoNetwork` [interface-NodesInfoNodeInfoNetwork] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesInfoNodeInfoNetworkInterface.md b/docs/reference/api/NodesInfoNodeInfoNetworkInterface.md index 7b3521632..1070621c3 100644 --- a/docs/reference/api/NodesInfoNodeInfoNetworkInterface.md +++ b/docs/reference/api/NodesInfoNodeInfoNetworkInterface.md @@ -1,4 +1,4 @@ -## Interface `NodesInfoNodeInfoNetworkInterface` +# `NodesInfoNodeInfoNetworkInterface` [interface-NodesInfoNodeInfoNetworkInterface] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesInfoNodeInfoOSCPU.md b/docs/reference/api/NodesInfoNodeInfoOSCPU.md index f129eddd4..664467aee 100644 --- a/docs/reference/api/NodesInfoNodeInfoOSCPU.md +++ b/docs/reference/api/NodesInfoNodeInfoOSCPU.md @@ -1,4 +1,4 @@ -## Interface `NodesInfoNodeInfoOSCPU` +# `NodesInfoNodeInfoOSCPU` [interface-NodesInfoNodeInfoOSCPU] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesInfoNodeInfoPath.md b/docs/reference/api/NodesInfoNodeInfoPath.md index 697e5cd20..31617e454 100644 --- a/docs/reference/api/NodesInfoNodeInfoPath.md +++ b/docs/reference/api/NodesInfoNodeInfoPath.md @@ -1,4 +1,4 @@ -## Interface `NodesInfoNodeInfoPath` +# `NodesInfoNodeInfoPath` [interface-NodesInfoNodeInfoPath] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesInfoNodeInfoRepositories.md b/docs/reference/api/NodesInfoNodeInfoRepositories.md index 7c0714ef1..51bd3a728 100644 --- a/docs/reference/api/NodesInfoNodeInfoRepositories.md +++ b/docs/reference/api/NodesInfoNodeInfoRepositories.md @@ -1,4 +1,4 @@ -## Interface `NodesInfoNodeInfoRepositories` +# `NodesInfoNodeInfoRepositories` [interface-NodesInfoNodeInfoRepositories] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesInfoNodeInfoRepositoriesUrl.md b/docs/reference/api/NodesInfoNodeInfoRepositoriesUrl.md index ece387e95..ddb7ad7d0 100644 --- a/docs/reference/api/NodesInfoNodeInfoRepositoriesUrl.md +++ b/docs/reference/api/NodesInfoNodeInfoRepositoriesUrl.md @@ -1,4 +1,4 @@ -## Interface `NodesInfoNodeInfoRepositoriesUrl` +# `NodesInfoNodeInfoRepositoriesUrl` [interface-NodesInfoNodeInfoRepositoriesUrl] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesInfoNodeInfoScript.md b/docs/reference/api/NodesInfoNodeInfoScript.md index 70fc99ade..27b9aead9 100644 --- a/docs/reference/api/NodesInfoNodeInfoScript.md +++ b/docs/reference/api/NodesInfoNodeInfoScript.md @@ -1,4 +1,4 @@ -## Interface `NodesInfoNodeInfoScript` +# `NodesInfoNodeInfoScript` [interface-NodesInfoNodeInfoScript] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesInfoNodeInfoSearch.md b/docs/reference/api/NodesInfoNodeInfoSearch.md index ae2c574c8..e1fd92bc9 100644 --- a/docs/reference/api/NodesInfoNodeInfoSearch.md +++ b/docs/reference/api/NodesInfoNodeInfoSearch.md @@ -1,4 +1,4 @@ -## Interface `NodesInfoNodeInfoSearch` +# `NodesInfoNodeInfoSearch` [interface-NodesInfoNodeInfoSearch] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesInfoNodeInfoSearchRemote.md b/docs/reference/api/NodesInfoNodeInfoSearchRemote.md index 977bfb98f..0856c9d0f 100644 --- a/docs/reference/api/NodesInfoNodeInfoSearchRemote.md +++ b/docs/reference/api/NodesInfoNodeInfoSearchRemote.md @@ -1,4 +1,4 @@ -## Interface `NodesInfoNodeInfoSearchRemote` +# `NodesInfoNodeInfoSearchRemote` [interface-NodesInfoNodeInfoSearchRemote] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesInfoNodeInfoSettings.md b/docs/reference/api/NodesInfoNodeInfoSettings.md index 107ac93dd..c0efd9603 100644 --- a/docs/reference/api/NodesInfoNodeInfoSettings.md +++ b/docs/reference/api/NodesInfoNodeInfoSettings.md @@ -1,4 +1,4 @@ -## Interface `NodesInfoNodeInfoSettings` +# `NodesInfoNodeInfoSettings` [interface-NodesInfoNodeInfoSettings] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesInfoNodeInfoSettingsCluster.md b/docs/reference/api/NodesInfoNodeInfoSettingsCluster.md index 9ae408f42..89daa8518 100644 --- a/docs/reference/api/NodesInfoNodeInfoSettingsCluster.md +++ b/docs/reference/api/NodesInfoNodeInfoSettingsCluster.md @@ -1,4 +1,4 @@ -## Interface `NodesInfoNodeInfoSettingsCluster` +# `NodesInfoNodeInfoSettingsCluster` [interface-NodesInfoNodeInfoSettingsCluster] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesInfoNodeInfoSettingsClusterElection.md b/docs/reference/api/NodesInfoNodeInfoSettingsClusterElection.md index 56baa4424..1974839e1 100644 --- a/docs/reference/api/NodesInfoNodeInfoSettingsClusterElection.md +++ b/docs/reference/api/NodesInfoNodeInfoSettingsClusterElection.md @@ -1,4 +1,4 @@ -## Interface `NodesInfoNodeInfoSettingsClusterElection` +# `NodesInfoNodeInfoSettingsClusterElection` [interface-NodesInfoNodeInfoSettingsClusterElection] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesInfoNodeInfoSettingsHttp.md b/docs/reference/api/NodesInfoNodeInfoSettingsHttp.md index a7b941d9c..0e98157bd 100644 --- a/docs/reference/api/NodesInfoNodeInfoSettingsHttp.md +++ b/docs/reference/api/NodesInfoNodeInfoSettingsHttp.md @@ -1,4 +1,4 @@ -## Interface `NodesInfoNodeInfoSettingsHttp` +# `NodesInfoNodeInfoSettingsHttp` [interface-NodesInfoNodeInfoSettingsHttp] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesInfoNodeInfoSettingsHttpType.md b/docs/reference/api/NodesInfoNodeInfoSettingsHttpType.md index a641bf5b3..126aea433 100644 --- a/docs/reference/api/NodesInfoNodeInfoSettingsHttpType.md +++ b/docs/reference/api/NodesInfoNodeInfoSettingsHttpType.md @@ -1,4 +1,4 @@ -## Interface `NodesInfoNodeInfoSettingsHttpType` +# `NodesInfoNodeInfoSettingsHttpType` [interface-NodesInfoNodeInfoSettingsHttpType] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesInfoNodeInfoSettingsIngest.md b/docs/reference/api/NodesInfoNodeInfoSettingsIngest.md index 8ddec0573..2803c9378 100644 --- a/docs/reference/api/NodesInfoNodeInfoSettingsIngest.md +++ b/docs/reference/api/NodesInfoNodeInfoSettingsIngest.md @@ -1,4 +1,4 @@ -## Interface `NodesInfoNodeInfoSettingsIngest` +# `NodesInfoNodeInfoSettingsIngest` [interface-NodesInfoNodeInfoSettingsIngest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesInfoNodeInfoSettingsNetwork.md b/docs/reference/api/NodesInfoNodeInfoSettingsNetwork.md index 341b09841..218178f9e 100644 --- a/docs/reference/api/NodesInfoNodeInfoSettingsNetwork.md +++ b/docs/reference/api/NodesInfoNodeInfoSettingsNetwork.md @@ -1,4 +1,4 @@ -## Interface `NodesInfoNodeInfoSettingsNetwork` +# `NodesInfoNodeInfoSettingsNetwork` [interface-NodesInfoNodeInfoSettingsNetwork] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesInfoNodeInfoSettingsNode.md b/docs/reference/api/NodesInfoNodeInfoSettingsNode.md index c8c89348e..390ac1506 100644 --- a/docs/reference/api/NodesInfoNodeInfoSettingsNode.md +++ b/docs/reference/api/NodesInfoNodeInfoSettingsNode.md @@ -1,4 +1,4 @@ -## Interface `NodesInfoNodeInfoSettingsNode` +# `NodesInfoNodeInfoSettingsNode` [interface-NodesInfoNodeInfoSettingsNode] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesInfoNodeInfoSettingsTransport.md b/docs/reference/api/NodesInfoNodeInfoSettingsTransport.md index 3bd3b84e9..dc3d6b4a1 100644 --- a/docs/reference/api/NodesInfoNodeInfoSettingsTransport.md +++ b/docs/reference/api/NodesInfoNodeInfoSettingsTransport.md @@ -1,4 +1,4 @@ -## Interface `NodesInfoNodeInfoSettingsTransport` +# `NodesInfoNodeInfoSettingsTransport` [interface-NodesInfoNodeInfoSettingsTransport] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesInfoNodeInfoSettingsTransportFeatures.md b/docs/reference/api/NodesInfoNodeInfoSettingsTransportFeatures.md index 2ec4c48e7..4ff27e937 100644 --- a/docs/reference/api/NodesInfoNodeInfoSettingsTransportFeatures.md +++ b/docs/reference/api/NodesInfoNodeInfoSettingsTransportFeatures.md @@ -1,4 +1,4 @@ -## Interface `NodesInfoNodeInfoSettingsTransportFeatures` +# `NodesInfoNodeInfoSettingsTransportFeatures` [interface-NodesInfoNodeInfoSettingsTransportFeatures] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesInfoNodeInfoSettingsTransportType.md b/docs/reference/api/NodesInfoNodeInfoSettingsTransportType.md index c60a52da0..9f5d60fae 100644 --- a/docs/reference/api/NodesInfoNodeInfoSettingsTransportType.md +++ b/docs/reference/api/NodesInfoNodeInfoSettingsTransportType.md @@ -1,4 +1,4 @@ -## Interface `NodesInfoNodeInfoSettingsTransportType` +# `NodesInfoNodeInfoSettingsTransportType` [interface-NodesInfoNodeInfoSettingsTransportType] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesInfoNodeInfoTransport.md b/docs/reference/api/NodesInfoNodeInfoTransport.md index cca58fc43..14c722afb 100644 --- a/docs/reference/api/NodesInfoNodeInfoTransport.md +++ b/docs/reference/api/NodesInfoNodeInfoTransport.md @@ -1,4 +1,4 @@ -## Interface `NodesInfoNodeInfoTransport` +# `NodesInfoNodeInfoTransport` [interface-NodesInfoNodeInfoTransport] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesInfoNodeInfoXpack.md b/docs/reference/api/NodesInfoNodeInfoXpack.md index a536ab0d9..db41f0115 100644 --- a/docs/reference/api/NodesInfoNodeInfoXpack.md +++ b/docs/reference/api/NodesInfoNodeInfoXpack.md @@ -1,4 +1,4 @@ -## Interface `NodesInfoNodeInfoXpack` +# `NodesInfoNodeInfoXpack` [interface-NodesInfoNodeInfoXpack] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesInfoNodeInfoXpackLicense.md b/docs/reference/api/NodesInfoNodeInfoXpackLicense.md index 88fac4507..3c62b9523 100644 --- a/docs/reference/api/NodesInfoNodeInfoXpackLicense.md +++ b/docs/reference/api/NodesInfoNodeInfoXpackLicense.md @@ -1,4 +1,4 @@ -## Interface `NodesInfoNodeInfoXpackLicense` +# `NodesInfoNodeInfoXpackLicense` [interface-NodesInfoNodeInfoXpackLicense] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesInfoNodeInfoXpackLicenseType.md b/docs/reference/api/NodesInfoNodeInfoXpackLicenseType.md index c923c611d..e3141807f 100644 --- a/docs/reference/api/NodesInfoNodeInfoXpackLicenseType.md +++ b/docs/reference/api/NodesInfoNodeInfoXpackLicenseType.md @@ -1,4 +1,4 @@ -## Interface `NodesInfoNodeInfoXpackLicenseType` +# `NodesInfoNodeInfoXpackLicenseType` [interface-NodesInfoNodeInfoXpackLicenseType] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesInfoNodeInfoXpackMl.md b/docs/reference/api/NodesInfoNodeInfoXpackMl.md index 39b90c5ed..7c57e710e 100644 --- a/docs/reference/api/NodesInfoNodeInfoXpackMl.md +++ b/docs/reference/api/NodesInfoNodeInfoXpackMl.md @@ -1,4 +1,4 @@ -## Interface `NodesInfoNodeInfoXpackMl` +# `NodesInfoNodeInfoXpackMl` [interface-NodesInfoNodeInfoXpackMl] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesInfoNodeInfoXpackSecurity.md b/docs/reference/api/NodesInfoNodeInfoXpackSecurity.md index 25c728b20..2bfed2fbb 100644 --- a/docs/reference/api/NodesInfoNodeInfoXpackSecurity.md +++ b/docs/reference/api/NodesInfoNodeInfoXpackSecurity.md @@ -1,4 +1,4 @@ -## Interface `NodesInfoNodeInfoXpackSecurity` +# `NodesInfoNodeInfoXpackSecurity` [interface-NodesInfoNodeInfoXpackSecurity] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesInfoNodeInfoXpackSecurityAuthc.md b/docs/reference/api/NodesInfoNodeInfoXpackSecurityAuthc.md index 3e29bccb7..5131d44ac 100644 --- a/docs/reference/api/NodesInfoNodeInfoXpackSecurityAuthc.md +++ b/docs/reference/api/NodesInfoNodeInfoXpackSecurityAuthc.md @@ -1,4 +1,4 @@ -## Interface `NodesInfoNodeInfoXpackSecurityAuthc` +# `NodesInfoNodeInfoXpackSecurityAuthc` [interface-NodesInfoNodeInfoXpackSecurityAuthc] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesInfoNodeInfoXpackSecurityAuthcRealms.md b/docs/reference/api/NodesInfoNodeInfoXpackSecurityAuthcRealms.md index dabff5ddd..be80b3bd4 100644 --- a/docs/reference/api/NodesInfoNodeInfoXpackSecurityAuthcRealms.md +++ b/docs/reference/api/NodesInfoNodeInfoXpackSecurityAuthcRealms.md @@ -1,4 +1,4 @@ -## Interface `NodesInfoNodeInfoXpackSecurityAuthcRealms` +# `NodesInfoNodeInfoXpackSecurityAuthcRealms` [interface-NodesInfoNodeInfoXpackSecurityAuthcRealms] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesInfoNodeInfoXpackSecurityAuthcRealmsStatus.md b/docs/reference/api/NodesInfoNodeInfoXpackSecurityAuthcRealmsStatus.md index dc4cb5e25..115fffe57 100644 --- a/docs/reference/api/NodesInfoNodeInfoXpackSecurityAuthcRealmsStatus.md +++ b/docs/reference/api/NodesInfoNodeInfoXpackSecurityAuthcRealmsStatus.md @@ -1,4 +1,4 @@ -## Interface `NodesInfoNodeInfoXpackSecurityAuthcRealmsStatus` +# `NodesInfoNodeInfoXpackSecurityAuthcRealmsStatus` [interface-NodesInfoNodeInfoXpackSecurityAuthcRealmsStatus] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesInfoNodeInfoXpackSecurityAuthcToken.md b/docs/reference/api/NodesInfoNodeInfoXpackSecurityAuthcToken.md index 2dc45d5c0..4b440b0d5 100644 --- a/docs/reference/api/NodesInfoNodeInfoXpackSecurityAuthcToken.md +++ b/docs/reference/api/NodesInfoNodeInfoXpackSecurityAuthcToken.md @@ -1,4 +1,4 @@ -## Interface `NodesInfoNodeInfoXpackSecurityAuthcToken` +# `NodesInfoNodeInfoXpackSecurityAuthcToken` [interface-NodesInfoNodeInfoXpackSecurityAuthcToken] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesInfoNodeInfoXpackSecuritySsl.md b/docs/reference/api/NodesInfoNodeInfoXpackSecuritySsl.md index 3204c6956..b3b06b239 100644 --- a/docs/reference/api/NodesInfoNodeInfoXpackSecuritySsl.md +++ b/docs/reference/api/NodesInfoNodeInfoXpackSecuritySsl.md @@ -1,4 +1,4 @@ -## Interface `NodesInfoNodeInfoXpackSecuritySsl` +# `NodesInfoNodeInfoXpackSecuritySsl` [interface-NodesInfoNodeInfoXpackSecuritySsl] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesInfoNodeJvmInfo.md b/docs/reference/api/NodesInfoNodeJvmInfo.md index 258bda44f..0f087f4cd 100644 --- a/docs/reference/api/NodesInfoNodeJvmInfo.md +++ b/docs/reference/api/NodesInfoNodeJvmInfo.md @@ -1,4 +1,4 @@ -## Interface `NodesInfoNodeJvmInfo` +# `NodesInfoNodeJvmInfo` [interface-NodesInfoNodeJvmInfo] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesInfoNodeOperatingSystemInfo.md b/docs/reference/api/NodesInfoNodeOperatingSystemInfo.md index cfaf16c90..6dc0dbbcc 100644 --- a/docs/reference/api/NodesInfoNodeOperatingSystemInfo.md +++ b/docs/reference/api/NodesInfoNodeOperatingSystemInfo.md @@ -1,4 +1,4 @@ -## Interface `NodesInfoNodeOperatingSystemInfo` +# `NodesInfoNodeOperatingSystemInfo` [interface-NodesInfoNodeOperatingSystemInfo] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesInfoNodeProcessInfo.md b/docs/reference/api/NodesInfoNodeProcessInfo.md index 65dc5fde0..5072b96d9 100644 --- a/docs/reference/api/NodesInfoNodeProcessInfo.md +++ b/docs/reference/api/NodesInfoNodeProcessInfo.md @@ -1,4 +1,4 @@ -## Interface `NodesInfoNodeProcessInfo` +# `NodesInfoNodeProcessInfo` [interface-NodesInfoNodeProcessInfo] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesInfoNodeThreadPoolInfo.md b/docs/reference/api/NodesInfoNodeThreadPoolInfo.md index 5afed8519..0d8a9803e 100644 --- a/docs/reference/api/NodesInfoNodeThreadPoolInfo.md +++ b/docs/reference/api/NodesInfoNodeThreadPoolInfo.md @@ -1,4 +1,4 @@ -## Interface `NodesInfoNodeThreadPoolInfo` +# `NodesInfoNodeThreadPoolInfo` [interface-NodesInfoNodeThreadPoolInfo] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesInfoRequest.md b/docs/reference/api/NodesInfoRequest.md index 872fc8ac1..976ae904a 100644 --- a/docs/reference/api/NodesInfoRequest.md +++ b/docs/reference/api/NodesInfoRequest.md @@ -1,4 +1,4 @@ -## Interface `NodesInfoRequest` +# `NodesInfoRequest` [interface-NodesInfoRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesInfoResponse.md b/docs/reference/api/NodesInfoResponse.md index b8cd4cb22..18927c90d 100644 --- a/docs/reference/api/NodesInfoResponse.md +++ b/docs/reference/api/NodesInfoResponse.md @@ -1,4 +1,4 @@ -## `NodesInfoResponse` -::: +# `NodesInfoResponse` [alias-NodesInfoResponse] +```typescript type NodesInfoResponse = [NodesInfoResponseBase](./NodesInfoResponseBase.md); -::: +``` diff --git a/docs/reference/api/NodesInfoResponseBase.md b/docs/reference/api/NodesInfoResponseBase.md index 0b3241f7f..6f6067e53 100644 --- a/docs/reference/api/NodesInfoResponseBase.md +++ b/docs/reference/api/NodesInfoResponseBase.md @@ -1,4 +1,4 @@ -## Interface `NodesInfoResponseBase` +# `NodesInfoResponseBase` [interface-NodesInfoResponseBase] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesIngest.md b/docs/reference/api/NodesIngest.md index f32b4d4d0..2db5b5b1e 100644 --- a/docs/reference/api/NodesIngest.md +++ b/docs/reference/api/NodesIngest.md @@ -1,4 +1,4 @@ -## Interface `NodesIngest` +# `NodesIngest` [interface-NodesIngest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesIngestStats.md b/docs/reference/api/NodesIngestStats.md index 59acd5c1b..1347f5ce4 100644 --- a/docs/reference/api/NodesIngestStats.md +++ b/docs/reference/api/NodesIngestStats.md @@ -1,4 +1,4 @@ -## Interface `NodesIngestStats` +# `NodesIngestStats` [interface-NodesIngestStats] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesIngestTotal.md b/docs/reference/api/NodesIngestTotal.md index 9fad514da..c0f2fe253 100644 --- a/docs/reference/api/NodesIngestTotal.md +++ b/docs/reference/api/NodesIngestTotal.md @@ -1,4 +1,4 @@ -## Interface `NodesIngestTotal` +# `NodesIngestTotal` [interface-NodesIngestTotal] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesIoStatDevice.md b/docs/reference/api/NodesIoStatDevice.md index dfdbd450e..ea1782298 100644 --- a/docs/reference/api/NodesIoStatDevice.md +++ b/docs/reference/api/NodesIoStatDevice.md @@ -1,4 +1,4 @@ -## Interface `NodesIoStatDevice` +# `NodesIoStatDevice` [interface-NodesIoStatDevice] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesIoStats.md b/docs/reference/api/NodesIoStats.md index 669c569c4..948545289 100644 --- a/docs/reference/api/NodesIoStats.md +++ b/docs/reference/api/NodesIoStats.md @@ -1,4 +1,4 @@ -## Interface `NodesIoStats` +# `NodesIoStats` [interface-NodesIoStats] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesJvm.md b/docs/reference/api/NodesJvm.md index c1cd2579a..48bc0e6ed 100644 --- a/docs/reference/api/NodesJvm.md +++ b/docs/reference/api/NodesJvm.md @@ -1,4 +1,4 @@ -## Interface `NodesJvm` +# `NodesJvm` [interface-NodesJvm] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesJvmClasses.md b/docs/reference/api/NodesJvmClasses.md index 8baa897e6..8476c3ddc 100644 --- a/docs/reference/api/NodesJvmClasses.md +++ b/docs/reference/api/NodesJvmClasses.md @@ -1,4 +1,4 @@ -## Interface `NodesJvmClasses` +# `NodesJvmClasses` [interface-NodesJvmClasses] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesJvmMemoryStats.md b/docs/reference/api/NodesJvmMemoryStats.md index 7a73d0759..6991a8463 100644 --- a/docs/reference/api/NodesJvmMemoryStats.md +++ b/docs/reference/api/NodesJvmMemoryStats.md @@ -1,4 +1,4 @@ -## Interface `NodesJvmMemoryStats` +# `NodesJvmMemoryStats` [interface-NodesJvmMemoryStats] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesJvmThreads.md b/docs/reference/api/NodesJvmThreads.md index 432751ba3..5c375eefa 100644 --- a/docs/reference/api/NodesJvmThreads.md +++ b/docs/reference/api/NodesJvmThreads.md @@ -1,4 +1,4 @@ -## Interface `NodesJvmThreads` +# `NodesJvmThreads` [interface-NodesJvmThreads] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesKeyedProcessor.md b/docs/reference/api/NodesKeyedProcessor.md index c6bd94492..bc5f0449a 100644 --- a/docs/reference/api/NodesKeyedProcessor.md +++ b/docs/reference/api/NodesKeyedProcessor.md @@ -1,4 +1,4 @@ -## Interface `NodesKeyedProcessor` +# `NodesKeyedProcessor` [interface-NodesKeyedProcessor] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesMemoryStats.md b/docs/reference/api/NodesMemoryStats.md index c4736d398..17d5c6ad7 100644 --- a/docs/reference/api/NodesMemoryStats.md +++ b/docs/reference/api/NodesMemoryStats.md @@ -1,4 +1,4 @@ -## Interface `NodesMemoryStats` +# `NodesMemoryStats` [interface-NodesMemoryStats] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesNodeBufferPool.md b/docs/reference/api/NodesNodeBufferPool.md index 9941a07ee..6dc175261 100644 --- a/docs/reference/api/NodesNodeBufferPool.md +++ b/docs/reference/api/NodesNodeBufferPool.md @@ -1,4 +1,4 @@ -## Interface `NodesNodeBufferPool` +# `NodesNodeBufferPool` [interface-NodesNodeBufferPool] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesNodeReloadResult.md b/docs/reference/api/NodesNodeReloadResult.md index 628cea5e6..0404d5557 100644 --- a/docs/reference/api/NodesNodeReloadResult.md +++ b/docs/reference/api/NodesNodeReloadResult.md @@ -1,4 +1,4 @@ -## Interface `NodesNodeReloadResult` +# `NodesNodeReloadResult` [interface-NodesNodeReloadResult] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesNodesResponseBase.md b/docs/reference/api/NodesNodesResponseBase.md index b1081f8ec..c3064a466 100644 --- a/docs/reference/api/NodesNodesResponseBase.md +++ b/docs/reference/api/NodesNodesResponseBase.md @@ -1,4 +1,4 @@ -## Interface `NodesNodesResponseBase` +# `NodesNodesResponseBase` [interface-NodesNodesResponseBase] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesOperatingSystem.md b/docs/reference/api/NodesOperatingSystem.md index 9971b0f14..9d43ac4fa 100644 --- a/docs/reference/api/NodesOperatingSystem.md +++ b/docs/reference/api/NodesOperatingSystem.md @@ -1,4 +1,4 @@ -## Interface `NodesOperatingSystem` +# `NodesOperatingSystem` [interface-NodesOperatingSystem] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesPool.md b/docs/reference/api/NodesPool.md index 7e6972594..f257bc454 100644 --- a/docs/reference/api/NodesPool.md +++ b/docs/reference/api/NodesPool.md @@ -1,4 +1,4 @@ -## Interface `NodesPool` +# `NodesPool` [interface-NodesPool] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesPressureMemory.md b/docs/reference/api/NodesPressureMemory.md index d6b1f8db3..252b8454c 100644 --- a/docs/reference/api/NodesPressureMemory.md +++ b/docs/reference/api/NodesPressureMemory.md @@ -1,4 +1,4 @@ -## Interface `NodesPressureMemory` +# `NodesPressureMemory` [interface-NodesPressureMemory] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesProcess.md b/docs/reference/api/NodesProcess.md index bcfc030ec..e6a856ecf 100644 --- a/docs/reference/api/NodesProcess.md +++ b/docs/reference/api/NodesProcess.md @@ -1,4 +1,4 @@ -## Interface `NodesProcess` +# `NodesProcess` [interface-NodesProcess] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesProcessor.md b/docs/reference/api/NodesProcessor.md index 830365bae..003582622 100644 --- a/docs/reference/api/NodesProcessor.md +++ b/docs/reference/api/NodesProcessor.md @@ -1,4 +1,4 @@ -## Interface `NodesProcessor` +# `NodesProcessor` [interface-NodesProcessor] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesPublishedClusterStates.md b/docs/reference/api/NodesPublishedClusterStates.md index 83daa3043..dde5d1196 100644 --- a/docs/reference/api/NodesPublishedClusterStates.md +++ b/docs/reference/api/NodesPublishedClusterStates.md @@ -1,4 +1,4 @@ -## Interface `NodesPublishedClusterStates` +# `NodesPublishedClusterStates` [interface-NodesPublishedClusterStates] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesRecording.md b/docs/reference/api/NodesRecording.md index 57af49d3b..82ec83639 100644 --- a/docs/reference/api/NodesRecording.md +++ b/docs/reference/api/NodesRecording.md @@ -1,4 +1,4 @@ -## Interface `NodesRecording` +# `NodesRecording` [interface-NodesRecording] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesReloadSecureSettingsRequest.md b/docs/reference/api/NodesReloadSecureSettingsRequest.md index 7e56a3968..48d44818d 100644 --- a/docs/reference/api/NodesReloadSecureSettingsRequest.md +++ b/docs/reference/api/NodesReloadSecureSettingsRequest.md @@ -1,4 +1,4 @@ -## Interface `NodesReloadSecureSettingsRequest` +# `NodesReloadSecureSettingsRequest` [interface-NodesReloadSecureSettingsRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesReloadSecureSettingsResponse.md b/docs/reference/api/NodesReloadSecureSettingsResponse.md index 88e0b0c1c..aa5bcf759 100644 --- a/docs/reference/api/NodesReloadSecureSettingsResponse.md +++ b/docs/reference/api/NodesReloadSecureSettingsResponse.md @@ -1,4 +1,4 @@ -## `NodesReloadSecureSettingsResponse` -::: +# `NodesReloadSecureSettingsResponse` [alias-NodesReloadSecureSettingsResponse] +```typescript type NodesReloadSecureSettingsResponse = [NodesReloadSecureSettingsResponseBase](./NodesReloadSecureSettingsResponseBase.md); -::: +``` diff --git a/docs/reference/api/NodesReloadSecureSettingsResponseBase.md b/docs/reference/api/NodesReloadSecureSettingsResponseBase.md index c9a4ee051..c34f897a1 100644 --- a/docs/reference/api/NodesReloadSecureSettingsResponseBase.md +++ b/docs/reference/api/NodesReloadSecureSettingsResponseBase.md @@ -1,4 +1,4 @@ -## Interface `NodesReloadSecureSettingsResponseBase` +# `NodesReloadSecureSettingsResponseBase` [interface-NodesReloadSecureSettingsResponseBase] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesRepositoryLocation.md b/docs/reference/api/NodesRepositoryLocation.md index 70d0b8e4f..8cb5399cd 100644 --- a/docs/reference/api/NodesRepositoryLocation.md +++ b/docs/reference/api/NodesRepositoryLocation.md @@ -1,4 +1,4 @@ -## Interface `NodesRepositoryLocation` +# `NodesRepositoryLocation` [interface-NodesRepositoryLocation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesRepositoryMeteringInformation.md b/docs/reference/api/NodesRepositoryMeteringInformation.md index 543472b1a..c2ba030cd 100644 --- a/docs/reference/api/NodesRepositoryMeteringInformation.md +++ b/docs/reference/api/NodesRepositoryMeteringInformation.md @@ -1,4 +1,4 @@ -## Interface `NodesRepositoryMeteringInformation` +# `NodesRepositoryMeteringInformation` [interface-NodesRepositoryMeteringInformation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesRequestCounts.md b/docs/reference/api/NodesRequestCounts.md index db09bd712..b0fe69242 100644 --- a/docs/reference/api/NodesRequestCounts.md +++ b/docs/reference/api/NodesRequestCounts.md @@ -1,4 +1,4 @@ -## Interface `NodesRequestCounts` +# `NodesRequestCounts` [interface-NodesRequestCounts] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesScriptCache.md b/docs/reference/api/NodesScriptCache.md index 494c0a7d4..2d07ae93f 100644 --- a/docs/reference/api/NodesScriptCache.md +++ b/docs/reference/api/NodesScriptCache.md @@ -1,4 +1,4 @@ -## Interface `NodesScriptCache` +# `NodesScriptCache` [interface-NodesScriptCache] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesScripting.md b/docs/reference/api/NodesScripting.md index 9fafe673f..81962cb19 100644 --- a/docs/reference/api/NodesScripting.md +++ b/docs/reference/api/NodesScripting.md @@ -1,4 +1,4 @@ -## Interface `NodesScripting` +# `NodesScripting` [interface-NodesScripting] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesSerializedClusterState.md b/docs/reference/api/NodesSerializedClusterState.md index b13405a57..2eb9cb829 100644 --- a/docs/reference/api/NodesSerializedClusterState.md +++ b/docs/reference/api/NodesSerializedClusterState.md @@ -1,4 +1,4 @@ -## Interface `NodesSerializedClusterState` +# `NodesSerializedClusterState` [interface-NodesSerializedClusterState] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesSerializedClusterStateDetail.md b/docs/reference/api/NodesSerializedClusterStateDetail.md index a99fe47c7..5b4d3d35c 100644 --- a/docs/reference/api/NodesSerializedClusterStateDetail.md +++ b/docs/reference/api/NodesSerializedClusterStateDetail.md @@ -1,4 +1,4 @@ -## Interface `NodesSerializedClusterStateDetail` +# `NodesSerializedClusterStateDetail` [interface-NodesSerializedClusterStateDetail] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesSizeHttpHistogram.md b/docs/reference/api/NodesSizeHttpHistogram.md index 753a4655a..8714da125 100644 --- a/docs/reference/api/NodesSizeHttpHistogram.md +++ b/docs/reference/api/NodesSizeHttpHistogram.md @@ -1,4 +1,4 @@ -## Interface `NodesSizeHttpHistogram` +# `NodesSizeHttpHistogram` [interface-NodesSizeHttpHistogram] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesStats.md b/docs/reference/api/NodesStats.md index 779677f12..dd2cda167 100644 --- a/docs/reference/api/NodesStats.md +++ b/docs/reference/api/NodesStats.md @@ -1,4 +1,4 @@ -## Interface `NodesStats` +# `NodesStats` [interface-NodesStats] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesStatsRequest.md b/docs/reference/api/NodesStatsRequest.md index efaa8f3c3..155760365 100644 --- a/docs/reference/api/NodesStatsRequest.md +++ b/docs/reference/api/NodesStatsRequest.md @@ -1,4 +1,4 @@ -## Interface `NodesStatsRequest` +# `NodesStatsRequest` [interface-NodesStatsRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesStatsResponse.md b/docs/reference/api/NodesStatsResponse.md index f611868b8..72e222026 100644 --- a/docs/reference/api/NodesStatsResponse.md +++ b/docs/reference/api/NodesStatsResponse.md @@ -1,4 +1,4 @@ -## `NodesStatsResponse` -::: +# `NodesStatsResponse` [alias-NodesStatsResponse] +```typescript type NodesStatsResponse = [NodesStatsResponseBase](./NodesStatsResponseBase.md); -::: +``` diff --git a/docs/reference/api/NodesStatsResponseBase.md b/docs/reference/api/NodesStatsResponseBase.md index 82f27a6d2..07554ef83 100644 --- a/docs/reference/api/NodesStatsResponseBase.md +++ b/docs/reference/api/NodesStatsResponseBase.md @@ -1,4 +1,4 @@ -## Interface `NodesStatsResponseBase` +# `NodesStatsResponseBase` [interface-NodesStatsResponseBase] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesThreadCount.md b/docs/reference/api/NodesThreadCount.md index b9935bd37..9025a0f86 100644 --- a/docs/reference/api/NodesThreadCount.md +++ b/docs/reference/api/NodesThreadCount.md @@ -1,4 +1,4 @@ -## Interface `NodesThreadCount` +# `NodesThreadCount` [interface-NodesThreadCount] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesTimeHttpHistogram.md b/docs/reference/api/NodesTimeHttpHistogram.md index 1ed2e6a15..d3f398098 100644 --- a/docs/reference/api/NodesTimeHttpHistogram.md +++ b/docs/reference/api/NodesTimeHttpHistogram.md @@ -1,4 +1,4 @@ -## Interface `NodesTimeHttpHistogram` +# `NodesTimeHttpHistogram` [interface-NodesTimeHttpHistogram] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesTransport.md b/docs/reference/api/NodesTransport.md index 63f301435..3f6fb958e 100644 --- a/docs/reference/api/NodesTransport.md +++ b/docs/reference/api/NodesTransport.md @@ -1,4 +1,4 @@ -## Interface `NodesTransport` +# `NodesTransport` [interface-NodesTransport] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesTransportHistogram.md b/docs/reference/api/NodesTransportHistogram.md index 4a05743c6..aa3546755 100644 --- a/docs/reference/api/NodesTransportHistogram.md +++ b/docs/reference/api/NodesTransportHistogram.md @@ -1,4 +1,4 @@ -## Interface `NodesTransportHistogram` +# `NodesTransportHistogram` [interface-NodesTransportHistogram] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesUsageNodeUsage.md b/docs/reference/api/NodesUsageNodeUsage.md index 81d93fe03..d2453fec7 100644 --- a/docs/reference/api/NodesUsageNodeUsage.md +++ b/docs/reference/api/NodesUsageNodeUsage.md @@ -1,4 +1,4 @@ -## Interface `NodesUsageNodeUsage` +# `NodesUsageNodeUsage` [interface-NodesUsageNodeUsage] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesUsageRequest.md b/docs/reference/api/NodesUsageRequest.md index 6df96d1c7..229b17208 100644 --- a/docs/reference/api/NodesUsageRequest.md +++ b/docs/reference/api/NodesUsageRequest.md @@ -1,4 +1,4 @@ -## Interface `NodesUsageRequest` +# `NodesUsageRequest` [interface-NodesUsageRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/NodesUsageResponse.md b/docs/reference/api/NodesUsageResponse.md index 2f1371830..5f7afb01e 100644 --- a/docs/reference/api/NodesUsageResponse.md +++ b/docs/reference/api/NodesUsageResponse.md @@ -1,4 +1,4 @@ -## `NodesUsageResponse` -::: +# `NodesUsageResponse` [alias-NodesUsageResponse] +```typescript type NodesUsageResponse = [NodesUsageResponseBase](./NodesUsageResponseBase.md); -::: +``` diff --git a/docs/reference/api/NodesUsageResponseBase.md b/docs/reference/api/NodesUsageResponseBase.md index ad9cd759b..c6099de3d 100644 --- a/docs/reference/api/NodesUsageResponseBase.md +++ b/docs/reference/api/NodesUsageResponseBase.md @@ -1,4 +1,4 @@ -## Interface `NodesUsageResponseBase` +# `NodesUsageResponseBase` [interface-NodesUsageResponseBase] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/Normalization.md b/docs/reference/api/Normalization.md index 65ecd251d..d14ca7efe 100644 --- a/docs/reference/api/Normalization.md +++ b/docs/reference/api/Normalization.md @@ -1,4 +1,4 @@ -## `Normalization` -::: +# `Normalization` [alias-Normalization] +```typescript type Normalization = 'no' | 'h1' | 'h2' | 'h3' | 'z'; -::: +``` diff --git a/docs/reference/api/OnDropDocument.md b/docs/reference/api/OnDropDocument.md index 2cd03ed0a..963521314 100644 --- a/docs/reference/api/OnDropDocument.md +++ b/docs/reference/api/OnDropDocument.md @@ -1,4 +1,4 @@ -## Interface `OnDropDocument` +# `OnDropDocument` [interface-OnDropDocument] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/OnSuccessDocument.md b/docs/reference/api/OnSuccessDocument.md index b85d89906..62e3e2ba0 100644 --- a/docs/reference/api/OnSuccessDocument.md +++ b/docs/reference/api/OnSuccessDocument.md @@ -1,4 +1,4 @@ -## Interface `OnSuccessDocument` +# `OnSuccessDocument` [interface-OnSuccessDocument] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/OpType.md b/docs/reference/api/OpType.md index fd1900147..4989f8f9e 100644 --- a/docs/reference/api/OpType.md +++ b/docs/reference/api/OpType.md @@ -1,4 +1,4 @@ -## `OpType` -::: +# `OpType` [alias-OpType] +```typescript type OpType = 'index' | 'create'; -::: +``` diff --git a/docs/reference/api/OpenPointInTimeApi_1.md b/docs/reference/api/OpenPointInTimeApi_1.md index 68671fc46..8a4b0164e 100644 --- a/docs/reference/api/OpenPointInTimeApi_1.md +++ b/docs/reference/api/OpenPointInTimeApi_1.md @@ -1,3 +1,3 @@ -::: +```typescript default function OpenPointInTimeApi(this: [That](./That.md), params: [OpenPointInTimeRequest](./OpenPointInTimeRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[OpenPointInTimeResponse](./OpenPointInTimeResponse.md)>; -::: +``` diff --git a/docs/reference/api/OpenPointInTimeApi_2.md b/docs/reference/api/OpenPointInTimeApi_2.md index c9fbe614c..b4e203982 100644 --- a/docs/reference/api/OpenPointInTimeApi_2.md +++ b/docs/reference/api/OpenPointInTimeApi_2.md @@ -1,3 +1,3 @@ -::: +```typescript default function OpenPointInTimeApi(this: [That](./That.md), params: [OpenPointInTimeRequest](./OpenPointInTimeRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[OpenPointInTimeResponse](./OpenPointInTimeResponse.md), unknown>>; -::: +``` diff --git a/docs/reference/api/OpenPointInTimeApi_3.md b/docs/reference/api/OpenPointInTimeApi_3.md index f7d03ef19..5031838c0 100644 --- a/docs/reference/api/OpenPointInTimeApi_3.md +++ b/docs/reference/api/OpenPointInTimeApi_3.md @@ -1,3 +1,3 @@ -::: +```typescript default function OpenPointInTimeApi(this: [That](./That.md), params: [OpenPointInTimeRequest](./OpenPointInTimeRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[OpenPointInTimeResponse](./OpenPointInTimeResponse.md)>; -::: +``` diff --git a/docs/reference/api/OpenPointInTimeRequest.md b/docs/reference/api/OpenPointInTimeRequest.md index 333c6c087..bd17ad439 100644 --- a/docs/reference/api/OpenPointInTimeRequest.md +++ b/docs/reference/api/OpenPointInTimeRequest.md @@ -1,4 +1,4 @@ -## Interface `OpenPointInTimeRequest` +# `OpenPointInTimeRequest` [interface-OpenPointInTimeRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/OpenPointInTimeResponse.md b/docs/reference/api/OpenPointInTimeResponse.md index 3576e2ffe..0c2b3ea8d 100644 --- a/docs/reference/api/OpenPointInTimeResponse.md +++ b/docs/reference/api/OpenPointInTimeResponse.md @@ -1,4 +1,4 @@ -## Interface `OpenPointInTimeResponse` +# `OpenPointInTimeResponse` [interface-OpenPointInTimeResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/Password.md b/docs/reference/api/Password.md index b3ed97527..49673f361 100644 --- a/docs/reference/api/Password.md +++ b/docs/reference/api/Password.md @@ -1,4 +1,4 @@ -## `Password` -::: +# `Password` [alias-Password] +```typescript type Password = string; -::: +``` diff --git a/docs/reference/api/Percentage.md b/docs/reference/api/Percentage.md index 957f5e8bc..70c5b8f97 100644 --- a/docs/reference/api/Percentage.md +++ b/docs/reference/api/Percentage.md @@ -1,4 +1,4 @@ -## `Percentage` -::: +# `Percentage` [alias-Percentage] +```typescript type Percentage = string | [float](./float.md); -::: +``` diff --git a/docs/reference/api/PingApi_1.md b/docs/reference/api/PingApi_1.md index a4e9c2285..15cdfb775 100644 --- a/docs/reference/api/PingApi_1.md +++ b/docs/reference/api/PingApi_1.md @@ -1,3 +1,3 @@ -::: +```typescript default function PingApi(this: [That](./That.md), params?: [PingRequest](./PingRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[PingResponse](./PingResponse.md)>; -::: +``` diff --git a/docs/reference/api/PingApi_2.md b/docs/reference/api/PingApi_2.md index 4382d3052..bdb8c6ed9 100644 --- a/docs/reference/api/PingApi_2.md +++ b/docs/reference/api/PingApi_2.md @@ -1,3 +1,3 @@ -::: +```typescript default function PingApi(this: [That](./That.md), params?: [PingRequest](./PingRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[PingResponse](./PingResponse.md), unknown>>; -::: +``` diff --git a/docs/reference/api/PingApi_3.md b/docs/reference/api/PingApi_3.md index 30adbfe44..3a8132a6d 100644 --- a/docs/reference/api/PingApi_3.md +++ b/docs/reference/api/PingApi_3.md @@ -1,3 +1,3 @@ -::: +```typescript default function PingApi(this: [That](./That.md), params?: [PingRequest](./PingRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[PingResponse](./PingResponse.md)>; -::: +``` diff --git a/docs/reference/api/PingRequest.md b/docs/reference/api/PingRequest.md index d16a510e8..d89a5c0b2 100644 --- a/docs/reference/api/PingRequest.md +++ b/docs/reference/api/PingRequest.md @@ -1,4 +1,4 @@ -## Interface `PingRequest` +# `PingRequest` [interface-PingRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/PingResponse.md b/docs/reference/api/PingResponse.md index bb58e4413..32db007db 100644 --- a/docs/reference/api/PingResponse.md +++ b/docs/reference/api/PingResponse.md @@ -1,4 +1,4 @@ -## `PingResponse` -::: +# `PingResponse` [alias-PingResponse] +```typescript type PingResponse = boolean; -::: +``` diff --git a/docs/reference/api/PipelineName.md b/docs/reference/api/PipelineName.md index afe37a1b8..2ce416575 100644 --- a/docs/reference/api/PipelineName.md +++ b/docs/reference/api/PipelineName.md @@ -1,4 +1,4 @@ -## `PipelineName` -::: +# `PipelineName` [alias-PipelineName] +```typescript type PipelineName = string; -::: +``` diff --git a/docs/reference/api/PluginStats.md b/docs/reference/api/PluginStats.md index cacf24a24..f7985272a 100644 --- a/docs/reference/api/PluginStats.md +++ b/docs/reference/api/PluginStats.md @@ -1,4 +1,4 @@ -## Interface `PluginStats` +# `PluginStats` [interface-PluginStats] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/Profiling.md b/docs/reference/api/Profiling.md index 82e4027c0..ffe7d36a2 100644 --- a/docs/reference/api/Profiling.md +++ b/docs/reference/api/Profiling.md @@ -1,19 +1,19 @@ -## `Profiling` +# `Profiling` [class-Profiling] -### Constructor +## Constructor -::: +```typescript new Profiling(transport: [Transport](./Transport.md)); -::: +``` -### Properties +## Properties [class-properties-Profiling] | Name | Type | Description | | - | - | - | | `acceptedParams` | Record |   | | `transport` | [Transport](./Transport.md) |   | -### Methods +## Methods [class-methods-Profiling] | Name | Signature | Description | | - | - | - | diff --git a/docs/reference/api/PropertyName.md b/docs/reference/api/PropertyName.md index c833c35b2..0c235830e 100644 --- a/docs/reference/api/PropertyName.md +++ b/docs/reference/api/PropertyName.md @@ -1,4 +1,4 @@ -## `PropertyName` -::: +# `PropertyName` [alias-PropertyName] +```typescript type PropertyName = string; -::: +``` diff --git a/docs/reference/api/PutScriptApi_1.md b/docs/reference/api/PutScriptApi_1.md index 386b64dcc..ccb01ff4c 100644 --- a/docs/reference/api/PutScriptApi_1.md +++ b/docs/reference/api/PutScriptApi_1.md @@ -1,3 +1,3 @@ -::: +```typescript default function PutScriptApi(this: [That](./That.md), params: [PutScriptRequest](./PutScriptRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[PutScriptResponse](./PutScriptResponse.md)>; -::: +``` diff --git a/docs/reference/api/PutScriptApi_2.md b/docs/reference/api/PutScriptApi_2.md index 21f681bf4..c9cad17ea 100644 --- a/docs/reference/api/PutScriptApi_2.md +++ b/docs/reference/api/PutScriptApi_2.md @@ -1,3 +1,3 @@ -::: +```typescript default function PutScriptApi(this: [That](./That.md), params: [PutScriptRequest](./PutScriptRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[PutScriptResponse](./PutScriptResponse.md), unknown>>; -::: +``` diff --git a/docs/reference/api/PutScriptApi_3.md b/docs/reference/api/PutScriptApi_3.md index 5358c0264..aefa30ce0 100644 --- a/docs/reference/api/PutScriptApi_3.md +++ b/docs/reference/api/PutScriptApi_3.md @@ -1,3 +1,3 @@ -::: +```typescript default function PutScriptApi(this: [That](./That.md), params: [PutScriptRequest](./PutScriptRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[PutScriptResponse](./PutScriptResponse.md)>; -::: +``` diff --git a/docs/reference/api/PutScriptRequest.md b/docs/reference/api/PutScriptRequest.md index 16c8bb56b..c02274526 100644 --- a/docs/reference/api/PutScriptRequest.md +++ b/docs/reference/api/PutScriptRequest.md @@ -1,4 +1,4 @@ -## Interface `PutScriptRequest` +# `PutScriptRequest` [interface-PutScriptRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/PutScriptResponse.md b/docs/reference/api/PutScriptResponse.md index 1d21c2811..7a875c6b4 100644 --- a/docs/reference/api/PutScriptResponse.md +++ b/docs/reference/api/PutScriptResponse.md @@ -1,4 +1,4 @@ -## `PutScriptResponse` -::: +# `PutScriptResponse` [alias-PutScriptResponse] +```typescript type PutScriptResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); -::: +``` diff --git a/docs/reference/api/QueryCacheStats.md b/docs/reference/api/QueryCacheStats.md index ea95df52a..8fa40c113 100644 --- a/docs/reference/api/QueryCacheStats.md +++ b/docs/reference/api/QueryCacheStats.md @@ -1,4 +1,4 @@ -## Interface `QueryCacheStats` +# `QueryCacheStats` [interface-QueryCacheStats] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslBoolQuery.md b/docs/reference/api/QueryDslBoolQuery.md index 6cc45f6cb..ee8f65692 100644 --- a/docs/reference/api/QueryDslBoolQuery.md +++ b/docs/reference/api/QueryDslBoolQuery.md @@ -1,4 +1,4 @@ -## Interface `QueryDslBoolQuery` +# `QueryDslBoolQuery` [interface-QueryDslBoolQuery] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslBoostingQuery.md b/docs/reference/api/QueryDslBoostingQuery.md index d96d610e5..10ce64228 100644 --- a/docs/reference/api/QueryDslBoostingQuery.md +++ b/docs/reference/api/QueryDslBoostingQuery.md @@ -1,4 +1,4 @@ -## Interface `QueryDslBoostingQuery` +# `QueryDslBoostingQuery` [interface-QueryDslBoostingQuery] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslChildScoreMode.md b/docs/reference/api/QueryDslChildScoreMode.md index 34f5812e6..6ea32feb3 100644 --- a/docs/reference/api/QueryDslChildScoreMode.md +++ b/docs/reference/api/QueryDslChildScoreMode.md @@ -1,4 +1,4 @@ -## `QueryDslChildScoreMode` -::: +# `QueryDslChildScoreMode` [alias-QueryDslChildScoreMode] +```typescript type QueryDslChildScoreMode = 'none' | 'avg' | 'sum' | 'max' | 'min'; -::: +``` diff --git a/docs/reference/api/QueryDslCombinedFieldsOperator.md b/docs/reference/api/QueryDslCombinedFieldsOperator.md index b384e4b21..d5dde61d0 100644 --- a/docs/reference/api/QueryDslCombinedFieldsOperator.md +++ b/docs/reference/api/QueryDslCombinedFieldsOperator.md @@ -1,4 +1,4 @@ -## `QueryDslCombinedFieldsOperator` -::: +# `QueryDslCombinedFieldsOperator` [alias-QueryDslCombinedFieldsOperator] +```typescript type QueryDslCombinedFieldsOperator = 'or' | 'and'; -::: +``` diff --git a/docs/reference/api/QueryDslCombinedFieldsQuery.md b/docs/reference/api/QueryDslCombinedFieldsQuery.md index 51f5e88e3..c1efad91f 100644 --- a/docs/reference/api/QueryDslCombinedFieldsQuery.md +++ b/docs/reference/api/QueryDslCombinedFieldsQuery.md @@ -1,4 +1,4 @@ -## Interface `QueryDslCombinedFieldsQuery` +# `QueryDslCombinedFieldsQuery` [interface-QueryDslCombinedFieldsQuery] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslCombinedFieldsZeroTerms.md b/docs/reference/api/QueryDslCombinedFieldsZeroTerms.md index 6f213af2e..73872be4e 100644 --- a/docs/reference/api/QueryDslCombinedFieldsZeroTerms.md +++ b/docs/reference/api/QueryDslCombinedFieldsZeroTerms.md @@ -1,4 +1,4 @@ -## `QueryDslCombinedFieldsZeroTerms` -::: +# `QueryDslCombinedFieldsZeroTerms` [alias-QueryDslCombinedFieldsZeroTerms] +```typescript type QueryDslCombinedFieldsZeroTerms = 'none' | 'all'; -::: +``` diff --git a/docs/reference/api/QueryDslCommonTermsQuery.md b/docs/reference/api/QueryDslCommonTermsQuery.md index 0bd62e2a9..ee74d0040 100644 --- a/docs/reference/api/QueryDslCommonTermsQuery.md +++ b/docs/reference/api/QueryDslCommonTermsQuery.md @@ -1,4 +1,4 @@ -## Interface `QueryDslCommonTermsQuery` +# `QueryDslCommonTermsQuery` [interface-QueryDslCommonTermsQuery] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslConstantScoreQuery.md b/docs/reference/api/QueryDslConstantScoreQuery.md index 5b4903bb2..f8347becd 100644 --- a/docs/reference/api/QueryDslConstantScoreQuery.md +++ b/docs/reference/api/QueryDslConstantScoreQuery.md @@ -1,4 +1,4 @@ -## Interface `QueryDslConstantScoreQuery` +# `QueryDslConstantScoreQuery` [interface-QueryDslConstantScoreQuery] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslDateDecayFunction.md b/docs/reference/api/QueryDslDateDecayFunction.md index ce47688d6..435444e81 100644 --- a/docs/reference/api/QueryDslDateDecayFunction.md +++ b/docs/reference/api/QueryDslDateDecayFunction.md @@ -1,4 +1,4 @@ -## `QueryDslDateDecayFunction` -::: +# `QueryDslDateDecayFunction` [alias-QueryDslDateDecayFunction] +```typescript type QueryDslDateDecayFunction = [QueryDslDateDecayFunctionKeys](./QueryDslDateDecayFunctionKeys.md) & { [property: string]: [QueryDslDecayPlacement](./QueryDslDecayPlacement.md) | [QueryDslMultiValueMode](./QueryDslMultiValueMode.md);}; -::: +``` diff --git a/docs/reference/api/QueryDslDateDecayFunctionKeys.md b/docs/reference/api/QueryDslDateDecayFunctionKeys.md index dab67c465..563bacebc 100644 --- a/docs/reference/api/QueryDslDateDecayFunctionKeys.md +++ b/docs/reference/api/QueryDslDateDecayFunctionKeys.md @@ -1,4 +1,4 @@ -## Interface `QueryDslDateDecayFunctionKeys` +# `QueryDslDateDecayFunctionKeys` [interface-QueryDslDateDecayFunctionKeys] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslDateDistanceFeatureQuery.md b/docs/reference/api/QueryDslDateDistanceFeatureQuery.md index ccef0b59e..0b3b23ec8 100644 --- a/docs/reference/api/QueryDslDateDistanceFeatureQuery.md +++ b/docs/reference/api/QueryDslDateDistanceFeatureQuery.md @@ -1,4 +1,4 @@ -## Interface `QueryDslDateDistanceFeatureQuery` +# `QueryDslDateDistanceFeatureQuery` [interface-QueryDslDateDistanceFeatureQuery] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslDateRangeQuery.md b/docs/reference/api/QueryDslDateRangeQuery.md index ec38917f8..4b5d40e55 100644 --- a/docs/reference/api/QueryDslDateRangeQuery.md +++ b/docs/reference/api/QueryDslDateRangeQuery.md @@ -1,4 +1,4 @@ -## Interface `QueryDslDateRangeQuery` +# `QueryDslDateRangeQuery` [interface-QueryDslDateRangeQuery] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslDecayFunction.md b/docs/reference/api/QueryDslDecayFunction.md index 055d9072b..00cf68e3e 100644 --- a/docs/reference/api/QueryDslDecayFunction.md +++ b/docs/reference/api/QueryDslDecayFunction.md @@ -1,4 +1,4 @@ -## `QueryDslDecayFunction` -::: +# `QueryDslDecayFunction` [alias-QueryDslDecayFunction] +```typescript type QueryDslDecayFunction = [QueryDslUntypedDecayFunction](./QueryDslUntypedDecayFunction.md) | [QueryDslDateDecayFunction](./QueryDslDateDecayFunction.md) | [QueryDslNumericDecayFunction](./QueryDslNumericDecayFunction.md) | [QueryDslGeoDecayFunction](./QueryDslGeoDecayFunction.md); -::: +``` diff --git a/docs/reference/api/QueryDslDecayFunctionBase.md b/docs/reference/api/QueryDslDecayFunctionBase.md index ab72e7a4f..be0b32803 100644 --- a/docs/reference/api/QueryDslDecayFunctionBase.md +++ b/docs/reference/api/QueryDslDecayFunctionBase.md @@ -1,4 +1,4 @@ -## Interface `QueryDslDecayFunctionBase` +# `QueryDslDecayFunctionBase` [interface-QueryDslDecayFunctionBase] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslDecayPlacement.md b/docs/reference/api/QueryDslDecayPlacement.md index aba9faefa..b0c7ffcd4 100644 --- a/docs/reference/api/QueryDslDecayPlacement.md +++ b/docs/reference/api/QueryDslDecayPlacement.md @@ -1,4 +1,4 @@ -## Interface `QueryDslDecayPlacement` +# `QueryDslDecayPlacement` [interface-QueryDslDecayPlacement] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslDisMaxQuery.md b/docs/reference/api/QueryDslDisMaxQuery.md index f43f07334..cf1359737 100644 --- a/docs/reference/api/QueryDslDisMaxQuery.md +++ b/docs/reference/api/QueryDslDisMaxQuery.md @@ -1,4 +1,4 @@ -## Interface `QueryDslDisMaxQuery` +# `QueryDslDisMaxQuery` [interface-QueryDslDisMaxQuery] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslDistanceFeatureQuery.md b/docs/reference/api/QueryDslDistanceFeatureQuery.md index a96c84028..d1bc856a3 100644 --- a/docs/reference/api/QueryDslDistanceFeatureQuery.md +++ b/docs/reference/api/QueryDslDistanceFeatureQuery.md @@ -1,4 +1,4 @@ -## `QueryDslDistanceFeatureQuery` -::: +# `QueryDslDistanceFeatureQuery` [alias-QueryDslDistanceFeatureQuery] +```typescript type QueryDslDistanceFeatureQuery = [QueryDslUntypedDistanceFeatureQuery](./QueryDslUntypedDistanceFeatureQuery.md) | [QueryDslGeoDistanceFeatureQuery](./QueryDslGeoDistanceFeatureQuery.md) | [QueryDslDateDistanceFeatureQuery](./QueryDslDateDistanceFeatureQuery.md); -::: +``` diff --git a/docs/reference/api/QueryDslDistanceFeatureQueryBase.md b/docs/reference/api/QueryDslDistanceFeatureQueryBase.md index 22891edda..efa3f8ee6 100644 --- a/docs/reference/api/QueryDslDistanceFeatureQueryBase.md +++ b/docs/reference/api/QueryDslDistanceFeatureQueryBase.md @@ -1,4 +1,4 @@ -## Interface `QueryDslDistanceFeatureQueryBase` +# `QueryDslDistanceFeatureQueryBase` [interface-QueryDslDistanceFeatureQueryBase] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslExistsQuery.md b/docs/reference/api/QueryDslExistsQuery.md index b987aa498..8986078c5 100644 --- a/docs/reference/api/QueryDslExistsQuery.md +++ b/docs/reference/api/QueryDslExistsQuery.md @@ -1,4 +1,4 @@ -## Interface `QueryDslExistsQuery` +# `QueryDslExistsQuery` [interface-QueryDslExistsQuery] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslFieldAndFormat.md b/docs/reference/api/QueryDslFieldAndFormat.md index d9d12f67f..ae745c1c7 100644 --- a/docs/reference/api/QueryDslFieldAndFormat.md +++ b/docs/reference/api/QueryDslFieldAndFormat.md @@ -1,4 +1,4 @@ -## Interface `QueryDslFieldAndFormat` +# `QueryDslFieldAndFormat` [interface-QueryDslFieldAndFormat] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslFieldLookup.md b/docs/reference/api/QueryDslFieldLookup.md index 9ffaf6681..0a18d574c 100644 --- a/docs/reference/api/QueryDslFieldLookup.md +++ b/docs/reference/api/QueryDslFieldLookup.md @@ -1,4 +1,4 @@ -## Interface `QueryDslFieldLookup` +# `QueryDslFieldLookup` [interface-QueryDslFieldLookup] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslFieldValueFactorModifier.md b/docs/reference/api/QueryDslFieldValueFactorModifier.md index 19064d5cc..1f955685f 100644 --- a/docs/reference/api/QueryDslFieldValueFactorModifier.md +++ b/docs/reference/api/QueryDslFieldValueFactorModifier.md @@ -1,4 +1,4 @@ -## `QueryDslFieldValueFactorModifier` -::: +# `QueryDslFieldValueFactorModifier` [alias-QueryDslFieldValueFactorModifier] +```typescript type QueryDslFieldValueFactorModifier = 'none' | 'log' | 'log1p' | 'log2p' | 'ln' | 'ln1p' | 'ln2p' | 'square' | 'sqrt' | 'reciprocal'; -::: +``` diff --git a/docs/reference/api/QueryDslFieldValueFactorScoreFunction.md b/docs/reference/api/QueryDslFieldValueFactorScoreFunction.md index e1301fcec..10896b854 100644 --- a/docs/reference/api/QueryDslFieldValueFactorScoreFunction.md +++ b/docs/reference/api/QueryDslFieldValueFactorScoreFunction.md @@ -1,4 +1,4 @@ -## Interface `QueryDslFieldValueFactorScoreFunction` +# `QueryDslFieldValueFactorScoreFunction` [interface-QueryDslFieldValueFactorScoreFunction] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslFunctionBoostMode.md b/docs/reference/api/QueryDslFunctionBoostMode.md index f7e924786..18cc64eee 100644 --- a/docs/reference/api/QueryDslFunctionBoostMode.md +++ b/docs/reference/api/QueryDslFunctionBoostMode.md @@ -1,4 +1,4 @@ -## `QueryDslFunctionBoostMode` -::: +# `QueryDslFunctionBoostMode` [alias-QueryDslFunctionBoostMode] +```typescript type QueryDslFunctionBoostMode = 'multiply' | 'replace' | 'sum' | 'avg' | 'max' | 'min'; -::: +``` diff --git a/docs/reference/api/QueryDslFunctionScoreContainer.md b/docs/reference/api/QueryDslFunctionScoreContainer.md index bda3740e2..20ada511d 100644 --- a/docs/reference/api/QueryDslFunctionScoreContainer.md +++ b/docs/reference/api/QueryDslFunctionScoreContainer.md @@ -1,4 +1,4 @@ -## Interface `QueryDslFunctionScoreContainer` +# `QueryDslFunctionScoreContainer` [interface-QueryDslFunctionScoreContainer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslFunctionScoreMode.md b/docs/reference/api/QueryDslFunctionScoreMode.md index 284ace0c5..dd3ead041 100644 --- a/docs/reference/api/QueryDslFunctionScoreMode.md +++ b/docs/reference/api/QueryDslFunctionScoreMode.md @@ -1,4 +1,4 @@ -## `QueryDslFunctionScoreMode` -::: +# `QueryDslFunctionScoreMode` [alias-QueryDslFunctionScoreMode] +```typescript type QueryDslFunctionScoreMode = 'multiply' | 'sum' | 'avg' | 'first' | 'max' | 'min'; -::: +``` diff --git a/docs/reference/api/QueryDslFunctionScoreQuery.md b/docs/reference/api/QueryDslFunctionScoreQuery.md index 89565c9a3..b6efc2276 100644 --- a/docs/reference/api/QueryDslFunctionScoreQuery.md +++ b/docs/reference/api/QueryDslFunctionScoreQuery.md @@ -1,4 +1,4 @@ -## Interface `QueryDslFunctionScoreQuery` +# `QueryDslFunctionScoreQuery` [interface-QueryDslFunctionScoreQuery] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslFuzzyQuery.md b/docs/reference/api/QueryDslFuzzyQuery.md index 6abc1d473..e6dd3ff72 100644 --- a/docs/reference/api/QueryDslFuzzyQuery.md +++ b/docs/reference/api/QueryDslFuzzyQuery.md @@ -1,4 +1,4 @@ -## Interface `QueryDslFuzzyQuery` +# `QueryDslFuzzyQuery` [interface-QueryDslFuzzyQuery] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslGeoBoundingBoxQuery.md b/docs/reference/api/QueryDslGeoBoundingBoxQuery.md index 416a4cebc..907fa5a23 100644 --- a/docs/reference/api/QueryDslGeoBoundingBoxQuery.md +++ b/docs/reference/api/QueryDslGeoBoundingBoxQuery.md @@ -1,4 +1,4 @@ -## `QueryDslGeoBoundingBoxQuery` -::: +# `QueryDslGeoBoundingBoxQuery` [alias-QueryDslGeoBoundingBoxQuery] +```typescript type QueryDslGeoBoundingBoxQuery = [QueryDslGeoBoundingBoxQueryKeys](./QueryDslGeoBoundingBoxQueryKeys.md) & { [property: string]: [GeoBounds](./GeoBounds.md) | [QueryDslGeoExecution](./QueryDslGeoExecution.md) | [QueryDslGeoValidationMethod](./QueryDslGeoValidationMethod.md) | boolean | [float](./float.md) | string;}; -::: +``` diff --git a/docs/reference/api/QueryDslGeoBoundingBoxQueryKeys.md b/docs/reference/api/QueryDslGeoBoundingBoxQueryKeys.md index eb586bc46..df9cf9130 100644 --- a/docs/reference/api/QueryDslGeoBoundingBoxQueryKeys.md +++ b/docs/reference/api/QueryDslGeoBoundingBoxQueryKeys.md @@ -1,4 +1,4 @@ -## Interface `QueryDslGeoBoundingBoxQueryKeys` +# `QueryDslGeoBoundingBoxQueryKeys` [interface-QueryDslGeoBoundingBoxQueryKeys] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslGeoDecayFunction.md b/docs/reference/api/QueryDslGeoDecayFunction.md index cf76454da..9bed7083a 100644 --- a/docs/reference/api/QueryDslGeoDecayFunction.md +++ b/docs/reference/api/QueryDslGeoDecayFunction.md @@ -1,4 +1,4 @@ -## `QueryDslGeoDecayFunction` -::: +# `QueryDslGeoDecayFunction` [alias-QueryDslGeoDecayFunction] +```typescript type QueryDslGeoDecayFunction = [QueryDslGeoDecayFunctionKeys](./QueryDslGeoDecayFunctionKeys.md) & { [property: string]: [QueryDslDecayPlacement](./QueryDslDecayPlacement.md) | [QueryDslMultiValueMode](./QueryDslMultiValueMode.md);}; -::: +``` diff --git a/docs/reference/api/QueryDslGeoDecayFunctionKeys.md b/docs/reference/api/QueryDslGeoDecayFunctionKeys.md index 7927a0282..5fdc22ad8 100644 --- a/docs/reference/api/QueryDslGeoDecayFunctionKeys.md +++ b/docs/reference/api/QueryDslGeoDecayFunctionKeys.md @@ -1,4 +1,4 @@ -## Interface `QueryDslGeoDecayFunctionKeys` +# `QueryDslGeoDecayFunctionKeys` [interface-QueryDslGeoDecayFunctionKeys] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslGeoDistanceFeatureQuery.md b/docs/reference/api/QueryDslGeoDistanceFeatureQuery.md index ae4810131..150cb580f 100644 --- a/docs/reference/api/QueryDslGeoDistanceFeatureQuery.md +++ b/docs/reference/api/QueryDslGeoDistanceFeatureQuery.md @@ -1,4 +1,4 @@ -## Interface `QueryDslGeoDistanceFeatureQuery` +# `QueryDslGeoDistanceFeatureQuery` [interface-QueryDslGeoDistanceFeatureQuery] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslGeoDistanceQuery.md b/docs/reference/api/QueryDslGeoDistanceQuery.md index 488d67af7..ae6e7326a 100644 --- a/docs/reference/api/QueryDslGeoDistanceQuery.md +++ b/docs/reference/api/QueryDslGeoDistanceQuery.md @@ -1,4 +1,4 @@ -## `QueryDslGeoDistanceQuery` -::: +# `QueryDslGeoDistanceQuery` [alias-QueryDslGeoDistanceQuery] +```typescript type QueryDslGeoDistanceQuery = [QueryDslGeoDistanceQueryKeys](./QueryDslGeoDistanceQueryKeys.md) & { [property: string]: [GeoLocation](./GeoLocation.md) | [Distance](./Distance.md) | [GeoDistanceType](./GeoDistanceType.md) | [QueryDslGeoValidationMethod](./QueryDslGeoValidationMethod.md) | boolean | [float](./float.md) | string;}; -::: +``` diff --git a/docs/reference/api/QueryDslGeoDistanceQueryKeys.md b/docs/reference/api/QueryDslGeoDistanceQueryKeys.md index 6f76eceaf..2551fc392 100644 --- a/docs/reference/api/QueryDslGeoDistanceQueryKeys.md +++ b/docs/reference/api/QueryDslGeoDistanceQueryKeys.md @@ -1,4 +1,4 @@ -## Interface `QueryDslGeoDistanceQueryKeys` +# `QueryDslGeoDistanceQueryKeys` [interface-QueryDslGeoDistanceQueryKeys] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslGeoExecution.md b/docs/reference/api/QueryDslGeoExecution.md index 9e60f058c..b9a63c297 100644 --- a/docs/reference/api/QueryDslGeoExecution.md +++ b/docs/reference/api/QueryDslGeoExecution.md @@ -1,4 +1,4 @@ -## `QueryDslGeoExecution` -::: +# `QueryDslGeoExecution` [alias-QueryDslGeoExecution] +```typescript type QueryDslGeoExecution = 'memory' | 'indexed'; -::: +``` diff --git a/docs/reference/api/QueryDslGeoGridQuery.md b/docs/reference/api/QueryDslGeoGridQuery.md index d61e43fbf..5c3bed8a5 100644 --- a/docs/reference/api/QueryDslGeoGridQuery.md +++ b/docs/reference/api/QueryDslGeoGridQuery.md @@ -1,4 +1,4 @@ -## Interface `QueryDslGeoGridQuery` +# `QueryDslGeoGridQuery` [interface-QueryDslGeoGridQuery] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslGeoPolygonPoints.md b/docs/reference/api/QueryDslGeoPolygonPoints.md index c50fbc27a..014962b05 100644 --- a/docs/reference/api/QueryDslGeoPolygonPoints.md +++ b/docs/reference/api/QueryDslGeoPolygonPoints.md @@ -1,4 +1,4 @@ -## Interface `QueryDslGeoPolygonPoints` +# `QueryDslGeoPolygonPoints` [interface-QueryDslGeoPolygonPoints] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslGeoPolygonQuery.md b/docs/reference/api/QueryDslGeoPolygonQuery.md index a937d81db..2354de77e 100644 --- a/docs/reference/api/QueryDslGeoPolygonQuery.md +++ b/docs/reference/api/QueryDslGeoPolygonQuery.md @@ -1,4 +1,4 @@ -## `QueryDslGeoPolygonQuery` -::: +# `QueryDslGeoPolygonQuery` [alias-QueryDslGeoPolygonQuery] +```typescript type QueryDslGeoPolygonQuery = [QueryDslGeoPolygonQueryKeys](./QueryDslGeoPolygonQueryKeys.md) & { [property: string]: [QueryDslGeoPolygonPoints](./QueryDslGeoPolygonPoints.md) | [QueryDslGeoValidationMethod](./QueryDslGeoValidationMethod.md) | boolean | [float](./float.md) | string;}; -::: +``` diff --git a/docs/reference/api/QueryDslGeoPolygonQueryKeys.md b/docs/reference/api/QueryDslGeoPolygonQueryKeys.md index 3938aa3ee..b6fcf6665 100644 --- a/docs/reference/api/QueryDslGeoPolygonQueryKeys.md +++ b/docs/reference/api/QueryDslGeoPolygonQueryKeys.md @@ -1,4 +1,4 @@ -## Interface `QueryDslGeoPolygonQueryKeys` +# `QueryDslGeoPolygonQueryKeys` [interface-QueryDslGeoPolygonQueryKeys] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslGeoShapeFieldQuery.md b/docs/reference/api/QueryDslGeoShapeFieldQuery.md index c00672cbe..b4b21492f 100644 --- a/docs/reference/api/QueryDslGeoShapeFieldQuery.md +++ b/docs/reference/api/QueryDslGeoShapeFieldQuery.md @@ -1,4 +1,4 @@ -## Interface `QueryDslGeoShapeFieldQuery` +# `QueryDslGeoShapeFieldQuery` [interface-QueryDslGeoShapeFieldQuery] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslGeoShapeQuery.md b/docs/reference/api/QueryDslGeoShapeQuery.md index 09192b368..aaeb93cdb 100644 --- a/docs/reference/api/QueryDslGeoShapeQuery.md +++ b/docs/reference/api/QueryDslGeoShapeQuery.md @@ -1,4 +1,4 @@ -## `QueryDslGeoShapeQuery` -::: +# `QueryDslGeoShapeQuery` [alias-QueryDslGeoShapeQuery] +```typescript type QueryDslGeoShapeQuery = [QueryDslGeoShapeQueryKeys](./QueryDslGeoShapeQueryKeys.md) & { [property: string]: [QueryDslGeoShapeFieldQuery](./QueryDslGeoShapeFieldQuery.md) | boolean | [float](./float.md) | string;}; -::: +``` diff --git a/docs/reference/api/QueryDslGeoShapeQueryKeys.md b/docs/reference/api/QueryDslGeoShapeQueryKeys.md index 246c0a952..e7a26a60d 100644 --- a/docs/reference/api/QueryDslGeoShapeQueryKeys.md +++ b/docs/reference/api/QueryDslGeoShapeQueryKeys.md @@ -1,4 +1,4 @@ -## Interface `QueryDslGeoShapeQueryKeys` +# `QueryDslGeoShapeQueryKeys` [interface-QueryDslGeoShapeQueryKeys] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslGeoValidationMethod.md b/docs/reference/api/QueryDslGeoValidationMethod.md index 3eff8fa0e..225ec8cd9 100644 --- a/docs/reference/api/QueryDslGeoValidationMethod.md +++ b/docs/reference/api/QueryDslGeoValidationMethod.md @@ -1,4 +1,4 @@ -## `QueryDslGeoValidationMethod` -::: +# `QueryDslGeoValidationMethod` [alias-QueryDslGeoValidationMethod] +```typescript type QueryDslGeoValidationMethod = 'coerce' | 'ignore_malformed' | 'strict'; -::: +``` diff --git a/docs/reference/api/QueryDslHasChildQuery.md b/docs/reference/api/QueryDslHasChildQuery.md index 1b58bcd0c..57ec74ac8 100644 --- a/docs/reference/api/QueryDslHasChildQuery.md +++ b/docs/reference/api/QueryDslHasChildQuery.md @@ -1,4 +1,4 @@ -## Interface `QueryDslHasChildQuery` +# `QueryDslHasChildQuery` [interface-QueryDslHasChildQuery] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslHasParentQuery.md b/docs/reference/api/QueryDslHasParentQuery.md index bf3c90a17..ac17369d5 100644 --- a/docs/reference/api/QueryDslHasParentQuery.md +++ b/docs/reference/api/QueryDslHasParentQuery.md @@ -1,4 +1,4 @@ -## Interface `QueryDslHasParentQuery` +# `QueryDslHasParentQuery` [interface-QueryDslHasParentQuery] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslIdsQuery.md b/docs/reference/api/QueryDslIdsQuery.md index c8533b947..2546e4bee 100644 --- a/docs/reference/api/QueryDslIdsQuery.md +++ b/docs/reference/api/QueryDslIdsQuery.md @@ -1,4 +1,4 @@ -## Interface `QueryDslIdsQuery` +# `QueryDslIdsQuery` [interface-QueryDslIdsQuery] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslIntervalsAllOf.md b/docs/reference/api/QueryDslIntervalsAllOf.md index c8bb7cfdf..e58ce6577 100644 --- a/docs/reference/api/QueryDslIntervalsAllOf.md +++ b/docs/reference/api/QueryDslIntervalsAllOf.md @@ -1,4 +1,4 @@ -## Interface `QueryDslIntervalsAllOf` +# `QueryDslIntervalsAllOf` [interface-QueryDslIntervalsAllOf] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslIntervalsAnyOf.md b/docs/reference/api/QueryDslIntervalsAnyOf.md index 01889ffa3..ec75a556f 100644 --- a/docs/reference/api/QueryDslIntervalsAnyOf.md +++ b/docs/reference/api/QueryDslIntervalsAnyOf.md @@ -1,4 +1,4 @@ -## Interface `QueryDslIntervalsAnyOf` +# `QueryDslIntervalsAnyOf` [interface-QueryDslIntervalsAnyOf] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslIntervalsContainer.md b/docs/reference/api/QueryDslIntervalsContainer.md index 310a445fc..aaf215b91 100644 --- a/docs/reference/api/QueryDslIntervalsContainer.md +++ b/docs/reference/api/QueryDslIntervalsContainer.md @@ -1,4 +1,4 @@ -## Interface `QueryDslIntervalsContainer` +# `QueryDslIntervalsContainer` [interface-QueryDslIntervalsContainer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslIntervalsFilter.md b/docs/reference/api/QueryDslIntervalsFilter.md index 1a0638988..fe8058a4d 100644 --- a/docs/reference/api/QueryDslIntervalsFilter.md +++ b/docs/reference/api/QueryDslIntervalsFilter.md @@ -1,4 +1,4 @@ -## Interface `QueryDslIntervalsFilter` +# `QueryDslIntervalsFilter` [interface-QueryDslIntervalsFilter] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslIntervalsFuzzy.md b/docs/reference/api/QueryDslIntervalsFuzzy.md index 79abf2011..49ebebe9e 100644 --- a/docs/reference/api/QueryDslIntervalsFuzzy.md +++ b/docs/reference/api/QueryDslIntervalsFuzzy.md @@ -1,4 +1,4 @@ -## Interface `QueryDslIntervalsFuzzy` +# `QueryDslIntervalsFuzzy` [interface-QueryDslIntervalsFuzzy] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslIntervalsMatch.md b/docs/reference/api/QueryDslIntervalsMatch.md index 321f1de0c..c9aa5d175 100644 --- a/docs/reference/api/QueryDslIntervalsMatch.md +++ b/docs/reference/api/QueryDslIntervalsMatch.md @@ -1,4 +1,4 @@ -## Interface `QueryDslIntervalsMatch` +# `QueryDslIntervalsMatch` [interface-QueryDslIntervalsMatch] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslIntervalsPrefix.md b/docs/reference/api/QueryDslIntervalsPrefix.md index 41f14d3fa..484033f76 100644 --- a/docs/reference/api/QueryDslIntervalsPrefix.md +++ b/docs/reference/api/QueryDslIntervalsPrefix.md @@ -1,4 +1,4 @@ -## Interface `QueryDslIntervalsPrefix` +# `QueryDslIntervalsPrefix` [interface-QueryDslIntervalsPrefix] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslIntervalsQuery.md b/docs/reference/api/QueryDslIntervalsQuery.md index bec8891c1..9d01e423b 100644 --- a/docs/reference/api/QueryDslIntervalsQuery.md +++ b/docs/reference/api/QueryDslIntervalsQuery.md @@ -1,4 +1,4 @@ -## Interface `QueryDslIntervalsQuery` +# `QueryDslIntervalsQuery` [interface-QueryDslIntervalsQuery] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslIntervalsWildcard.md b/docs/reference/api/QueryDslIntervalsWildcard.md index 910629b23..85c3c92f1 100644 --- a/docs/reference/api/QueryDslIntervalsWildcard.md +++ b/docs/reference/api/QueryDslIntervalsWildcard.md @@ -1,4 +1,4 @@ -## Interface `QueryDslIntervalsWildcard` +# `QueryDslIntervalsWildcard` [interface-QueryDslIntervalsWildcard] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslLike.md b/docs/reference/api/QueryDslLike.md index 97d607d51..290d5750c 100644 --- a/docs/reference/api/QueryDslLike.md +++ b/docs/reference/api/QueryDslLike.md @@ -1,4 +1,4 @@ -## `QueryDslLike` -::: +# `QueryDslLike` [alias-QueryDslLike] +```typescript type QueryDslLike = string | [QueryDslLikeDocument](./QueryDslLikeDocument.md); -::: +``` diff --git a/docs/reference/api/QueryDslLikeDocument.md b/docs/reference/api/QueryDslLikeDocument.md index a57ae730e..46c83f4ce 100644 --- a/docs/reference/api/QueryDslLikeDocument.md +++ b/docs/reference/api/QueryDslLikeDocument.md @@ -1,4 +1,4 @@ -## Interface `QueryDslLikeDocument` +# `QueryDslLikeDocument` [interface-QueryDslLikeDocument] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslMatchAllQuery.md b/docs/reference/api/QueryDslMatchAllQuery.md index 1d590e5ee..8a5b7dacc 100644 --- a/docs/reference/api/QueryDslMatchAllQuery.md +++ b/docs/reference/api/QueryDslMatchAllQuery.md @@ -1,4 +1,4 @@ -## Interface `QueryDslMatchAllQuery` +# `QueryDslMatchAllQuery` [interface-QueryDslMatchAllQuery] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslMatchBoolPrefixQuery.md b/docs/reference/api/QueryDslMatchBoolPrefixQuery.md index 336631993..dabf16fc8 100644 --- a/docs/reference/api/QueryDslMatchBoolPrefixQuery.md +++ b/docs/reference/api/QueryDslMatchBoolPrefixQuery.md @@ -1,4 +1,4 @@ -## Interface `QueryDslMatchBoolPrefixQuery` +# `QueryDslMatchBoolPrefixQuery` [interface-QueryDslMatchBoolPrefixQuery] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslMatchNoneQuery.md b/docs/reference/api/QueryDslMatchNoneQuery.md index 792e1d261..f02a2b9c9 100644 --- a/docs/reference/api/QueryDslMatchNoneQuery.md +++ b/docs/reference/api/QueryDslMatchNoneQuery.md @@ -1,4 +1,4 @@ -## Interface `QueryDslMatchNoneQuery` +# `QueryDslMatchNoneQuery` [interface-QueryDslMatchNoneQuery] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslMatchPhrasePrefixQuery.md b/docs/reference/api/QueryDslMatchPhrasePrefixQuery.md index 51d57d363..91261153c 100644 --- a/docs/reference/api/QueryDslMatchPhrasePrefixQuery.md +++ b/docs/reference/api/QueryDslMatchPhrasePrefixQuery.md @@ -1,4 +1,4 @@ -## Interface `QueryDslMatchPhrasePrefixQuery` +# `QueryDslMatchPhrasePrefixQuery` [interface-QueryDslMatchPhrasePrefixQuery] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslMatchPhraseQuery.md b/docs/reference/api/QueryDslMatchPhraseQuery.md index 1317ee1fb..2732a9532 100644 --- a/docs/reference/api/QueryDslMatchPhraseQuery.md +++ b/docs/reference/api/QueryDslMatchPhraseQuery.md @@ -1,4 +1,4 @@ -## Interface `QueryDslMatchPhraseQuery` +# `QueryDslMatchPhraseQuery` [interface-QueryDslMatchPhraseQuery] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslMatchQuery.md b/docs/reference/api/QueryDslMatchQuery.md index afb755b36..e2550f5e5 100644 --- a/docs/reference/api/QueryDslMatchQuery.md +++ b/docs/reference/api/QueryDslMatchQuery.md @@ -1,4 +1,4 @@ -## Interface `QueryDslMatchQuery` +# `QueryDslMatchQuery` [interface-QueryDslMatchQuery] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslMoreLikeThisQuery.md b/docs/reference/api/QueryDslMoreLikeThisQuery.md index c83c82ae3..ed6263adb 100644 --- a/docs/reference/api/QueryDslMoreLikeThisQuery.md +++ b/docs/reference/api/QueryDslMoreLikeThisQuery.md @@ -1,4 +1,4 @@ -## Interface `QueryDslMoreLikeThisQuery` +# `QueryDslMoreLikeThisQuery` [interface-QueryDslMoreLikeThisQuery] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslMultiMatchQuery.md b/docs/reference/api/QueryDslMultiMatchQuery.md index 3185538c5..2df0dab6d 100644 --- a/docs/reference/api/QueryDslMultiMatchQuery.md +++ b/docs/reference/api/QueryDslMultiMatchQuery.md @@ -1,4 +1,4 @@ -## Interface `QueryDslMultiMatchQuery` +# `QueryDslMultiMatchQuery` [interface-QueryDslMultiMatchQuery] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslMultiValueMode.md b/docs/reference/api/QueryDslMultiValueMode.md index b3ed45836..8e009aaeb 100644 --- a/docs/reference/api/QueryDslMultiValueMode.md +++ b/docs/reference/api/QueryDslMultiValueMode.md @@ -1,4 +1,4 @@ -## `QueryDslMultiValueMode` -::: +# `QueryDslMultiValueMode` [alias-QueryDslMultiValueMode] +```typescript type QueryDslMultiValueMode = 'min' | 'max' | 'avg' | 'sum'; -::: +``` diff --git a/docs/reference/api/QueryDslNestedQuery.md b/docs/reference/api/QueryDslNestedQuery.md index 3e872dd3c..346b4fc3c 100644 --- a/docs/reference/api/QueryDslNestedQuery.md +++ b/docs/reference/api/QueryDslNestedQuery.md @@ -1,4 +1,4 @@ -## Interface `QueryDslNestedQuery` +# `QueryDslNestedQuery` [interface-QueryDslNestedQuery] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslNumberRangeQuery.md b/docs/reference/api/QueryDslNumberRangeQuery.md index 09d8f6d0a..fbead55ee 100644 --- a/docs/reference/api/QueryDslNumberRangeQuery.md +++ b/docs/reference/api/QueryDslNumberRangeQuery.md @@ -1,4 +1,4 @@ -## Interface `QueryDslNumberRangeQuery` +# `QueryDslNumberRangeQuery` [interface-QueryDslNumberRangeQuery] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslNumericDecayFunction.md b/docs/reference/api/QueryDslNumericDecayFunction.md index 1f38e1fab..7acf3e62d 100644 --- a/docs/reference/api/QueryDslNumericDecayFunction.md +++ b/docs/reference/api/QueryDslNumericDecayFunction.md @@ -1,4 +1,4 @@ -## `QueryDslNumericDecayFunction` -::: +# `QueryDslNumericDecayFunction` [alias-QueryDslNumericDecayFunction] +```typescript type QueryDslNumericDecayFunction = [QueryDslNumericDecayFunctionKeys](./QueryDslNumericDecayFunctionKeys.md) & { [property: string]: [QueryDslDecayPlacement](./QueryDslDecayPlacement.md) | [QueryDslMultiValueMode](./QueryDslMultiValueMode.md);}; -::: +``` diff --git a/docs/reference/api/QueryDslNumericDecayFunctionKeys.md b/docs/reference/api/QueryDslNumericDecayFunctionKeys.md index 4466b2524..9bf03a5ef 100644 --- a/docs/reference/api/QueryDslNumericDecayFunctionKeys.md +++ b/docs/reference/api/QueryDslNumericDecayFunctionKeys.md @@ -1,4 +1,4 @@ -## Interface `QueryDslNumericDecayFunctionKeys` +# `QueryDslNumericDecayFunctionKeys` [interface-QueryDslNumericDecayFunctionKeys] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslOperator.md b/docs/reference/api/QueryDslOperator.md index 7fe45b375..a385b8875 100644 --- a/docs/reference/api/QueryDslOperator.md +++ b/docs/reference/api/QueryDslOperator.md @@ -1,4 +1,4 @@ -## `QueryDslOperator` -::: +# `QueryDslOperator` [alias-QueryDslOperator] +```typescript type QueryDslOperator = 'and' | 'AND' | 'or' | 'OR'; -::: +``` diff --git a/docs/reference/api/QueryDslParentIdQuery.md b/docs/reference/api/QueryDslParentIdQuery.md index 080c0184c..300e684a9 100644 --- a/docs/reference/api/QueryDslParentIdQuery.md +++ b/docs/reference/api/QueryDslParentIdQuery.md @@ -1,4 +1,4 @@ -## Interface `QueryDslParentIdQuery` +# `QueryDslParentIdQuery` [interface-QueryDslParentIdQuery] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslPercolateQuery.md b/docs/reference/api/QueryDslPercolateQuery.md index 857f613dd..567660bd7 100644 --- a/docs/reference/api/QueryDslPercolateQuery.md +++ b/docs/reference/api/QueryDslPercolateQuery.md @@ -1,4 +1,4 @@ -## Interface `QueryDslPercolateQuery` +# `QueryDslPercolateQuery` [interface-QueryDslPercolateQuery] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslPinnedDoc.md b/docs/reference/api/QueryDslPinnedDoc.md index 28f6013b6..7be1f7941 100644 --- a/docs/reference/api/QueryDslPinnedDoc.md +++ b/docs/reference/api/QueryDslPinnedDoc.md @@ -1,4 +1,4 @@ -## Interface `QueryDslPinnedDoc` +# `QueryDslPinnedDoc` [interface-QueryDslPinnedDoc] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslPinnedQuery.md b/docs/reference/api/QueryDslPinnedQuery.md index 5ae74b4db..9072fc81c 100644 --- a/docs/reference/api/QueryDslPinnedQuery.md +++ b/docs/reference/api/QueryDslPinnedQuery.md @@ -1,4 +1,4 @@ -## Interface `QueryDslPinnedQuery` +# `QueryDslPinnedQuery` [interface-QueryDslPinnedQuery] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslPrefixQuery.md b/docs/reference/api/QueryDslPrefixQuery.md index c2651c5d6..a0353b1c6 100644 --- a/docs/reference/api/QueryDslPrefixQuery.md +++ b/docs/reference/api/QueryDslPrefixQuery.md @@ -1,4 +1,4 @@ -## Interface `QueryDslPrefixQuery` +# `QueryDslPrefixQuery` [interface-QueryDslPrefixQuery] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslQueryBase.md b/docs/reference/api/QueryDslQueryBase.md index 449546273..7386649b8 100644 --- a/docs/reference/api/QueryDslQueryBase.md +++ b/docs/reference/api/QueryDslQueryBase.md @@ -1,4 +1,4 @@ -## Interface `QueryDslQueryBase` +# `QueryDslQueryBase` [interface-QueryDslQueryBase] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslQueryContainer.md b/docs/reference/api/QueryDslQueryContainer.md index b2a2c4ef2..db82d1bc1 100644 --- a/docs/reference/api/QueryDslQueryContainer.md +++ b/docs/reference/api/QueryDslQueryContainer.md @@ -1,4 +1,4 @@ -## Interface `QueryDslQueryContainer` +# `QueryDslQueryContainer` [interface-QueryDslQueryContainer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslQueryStringQuery.md b/docs/reference/api/QueryDslQueryStringQuery.md index 32919044f..4d68984b6 100644 --- a/docs/reference/api/QueryDslQueryStringQuery.md +++ b/docs/reference/api/QueryDslQueryStringQuery.md @@ -1,4 +1,4 @@ -## Interface `QueryDslQueryStringQuery` +# `QueryDslQueryStringQuery` [interface-QueryDslQueryStringQuery] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslRandomScoreFunction.md b/docs/reference/api/QueryDslRandomScoreFunction.md index 6436ebdcb..04a32de97 100644 --- a/docs/reference/api/QueryDslRandomScoreFunction.md +++ b/docs/reference/api/QueryDslRandomScoreFunction.md @@ -1,4 +1,4 @@ -## Interface `QueryDslRandomScoreFunction` +# `QueryDslRandomScoreFunction` [interface-QueryDslRandomScoreFunction] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslRangeQuery.md b/docs/reference/api/QueryDslRangeQuery.md index faec7bb1f..a082cdb48 100644 --- a/docs/reference/api/QueryDslRangeQuery.md +++ b/docs/reference/api/QueryDslRangeQuery.md @@ -1,4 +1,4 @@ -## `QueryDslRangeQuery` -::: +# `QueryDslRangeQuery` [alias-QueryDslRangeQuery] +```typescript type QueryDslRangeQuery = [QueryDslUntypedRangeQuery](./QueryDslUntypedRangeQuery.md) | [QueryDslDateRangeQuery](./QueryDslDateRangeQuery.md) | [QueryDslNumberRangeQuery](./QueryDslNumberRangeQuery.md) | [QueryDslTermRangeQuery](./QueryDslTermRangeQuery.md); -::: +``` diff --git a/docs/reference/api/QueryDslRangeQueryBase.md b/docs/reference/api/QueryDslRangeQueryBase.md index f5cc57a63..6ba3e35e3 100644 --- a/docs/reference/api/QueryDslRangeQueryBase.md +++ b/docs/reference/api/QueryDslRangeQueryBase.md @@ -1,4 +1,4 @@ -## Interface `QueryDslRangeQueryBase` +# `QueryDslRangeQueryBase` [interface-QueryDslRangeQueryBase] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslRangeRelation.md b/docs/reference/api/QueryDslRangeRelation.md index c1516f2ae..51d5ee08b 100644 --- a/docs/reference/api/QueryDslRangeRelation.md +++ b/docs/reference/api/QueryDslRangeRelation.md @@ -1,4 +1,4 @@ -## `QueryDslRangeRelation` -::: +# `QueryDslRangeRelation` [alias-QueryDslRangeRelation] +```typescript type QueryDslRangeRelation = 'within' | 'contains' | 'intersects'; -::: +``` diff --git a/docs/reference/api/QueryDslRankFeatureFunction.md b/docs/reference/api/QueryDslRankFeatureFunction.md index cae22c921..0c6c2396c 100644 --- a/docs/reference/api/QueryDslRankFeatureFunction.md +++ b/docs/reference/api/QueryDslRankFeatureFunction.md @@ -1,4 +1,4 @@ -## Interface `QueryDslRankFeatureFunction` +# `QueryDslRankFeatureFunction` [interface-QueryDslRankFeatureFunction] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslRankFeatureFunctionLinear.md b/docs/reference/api/QueryDslRankFeatureFunctionLinear.md index 50adb8683..fc31e64dd 100644 --- a/docs/reference/api/QueryDslRankFeatureFunctionLinear.md +++ b/docs/reference/api/QueryDslRankFeatureFunctionLinear.md @@ -1,4 +1,4 @@ -## Interface `QueryDslRankFeatureFunctionLinear` +# `QueryDslRankFeatureFunctionLinear` [interface-QueryDslRankFeatureFunctionLinear] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslRankFeatureFunctionLogarithm.md b/docs/reference/api/QueryDslRankFeatureFunctionLogarithm.md index 7eb4cfddc..d65db4664 100644 --- a/docs/reference/api/QueryDslRankFeatureFunctionLogarithm.md +++ b/docs/reference/api/QueryDslRankFeatureFunctionLogarithm.md @@ -1,4 +1,4 @@ -## Interface `QueryDslRankFeatureFunctionLogarithm` +# `QueryDslRankFeatureFunctionLogarithm` [interface-QueryDslRankFeatureFunctionLogarithm] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslRankFeatureFunctionSaturation.md b/docs/reference/api/QueryDslRankFeatureFunctionSaturation.md index 68956af82..e8d62f80a 100644 --- a/docs/reference/api/QueryDslRankFeatureFunctionSaturation.md +++ b/docs/reference/api/QueryDslRankFeatureFunctionSaturation.md @@ -1,4 +1,4 @@ -## Interface `QueryDslRankFeatureFunctionSaturation` +# `QueryDslRankFeatureFunctionSaturation` [interface-QueryDslRankFeatureFunctionSaturation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslRankFeatureFunctionSigmoid.md b/docs/reference/api/QueryDslRankFeatureFunctionSigmoid.md index 967bcc2db..7c8830b5e 100644 --- a/docs/reference/api/QueryDslRankFeatureFunctionSigmoid.md +++ b/docs/reference/api/QueryDslRankFeatureFunctionSigmoid.md @@ -1,4 +1,4 @@ -## Interface `QueryDslRankFeatureFunctionSigmoid` +# `QueryDslRankFeatureFunctionSigmoid` [interface-QueryDslRankFeatureFunctionSigmoid] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslRankFeatureQuery.md b/docs/reference/api/QueryDslRankFeatureQuery.md index 22158eae2..7449ccebe 100644 --- a/docs/reference/api/QueryDslRankFeatureQuery.md +++ b/docs/reference/api/QueryDslRankFeatureQuery.md @@ -1,4 +1,4 @@ -## Interface `QueryDslRankFeatureQuery` +# `QueryDslRankFeatureQuery` [interface-QueryDslRankFeatureQuery] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslRegexpQuery.md b/docs/reference/api/QueryDslRegexpQuery.md index e6963fe35..37b52c442 100644 --- a/docs/reference/api/QueryDslRegexpQuery.md +++ b/docs/reference/api/QueryDslRegexpQuery.md @@ -1,4 +1,4 @@ -## Interface `QueryDslRegexpQuery` +# `QueryDslRegexpQuery` [interface-QueryDslRegexpQuery] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslRuleQuery.md b/docs/reference/api/QueryDslRuleQuery.md index 1a3047f7a..d33fb4ade 100644 --- a/docs/reference/api/QueryDslRuleQuery.md +++ b/docs/reference/api/QueryDslRuleQuery.md @@ -1,4 +1,4 @@ -## Interface `QueryDslRuleQuery` +# `QueryDslRuleQuery` [interface-QueryDslRuleQuery] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslScriptQuery.md b/docs/reference/api/QueryDslScriptQuery.md index 24f51e548..98c1ed73d 100644 --- a/docs/reference/api/QueryDslScriptQuery.md +++ b/docs/reference/api/QueryDslScriptQuery.md @@ -1,4 +1,4 @@ -## Interface `QueryDslScriptQuery` +# `QueryDslScriptQuery` [interface-QueryDslScriptQuery] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslScriptScoreFunction.md b/docs/reference/api/QueryDslScriptScoreFunction.md index 85bd62027..79fec6bfc 100644 --- a/docs/reference/api/QueryDslScriptScoreFunction.md +++ b/docs/reference/api/QueryDslScriptScoreFunction.md @@ -1,4 +1,4 @@ -## Interface `QueryDslScriptScoreFunction` +# `QueryDslScriptScoreFunction` [interface-QueryDslScriptScoreFunction] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslScriptScoreQuery.md b/docs/reference/api/QueryDslScriptScoreQuery.md index ca4b57663..f16de60de 100644 --- a/docs/reference/api/QueryDslScriptScoreQuery.md +++ b/docs/reference/api/QueryDslScriptScoreQuery.md @@ -1,4 +1,4 @@ -## Interface `QueryDslScriptScoreQuery` +# `QueryDslScriptScoreQuery` [interface-QueryDslScriptScoreQuery] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslSemanticQuery.md b/docs/reference/api/QueryDslSemanticQuery.md index 1bbac26a5..8c1f80251 100644 --- a/docs/reference/api/QueryDslSemanticQuery.md +++ b/docs/reference/api/QueryDslSemanticQuery.md @@ -1,4 +1,4 @@ -## Interface `QueryDslSemanticQuery` +# `QueryDslSemanticQuery` [interface-QueryDslSemanticQuery] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslShapeFieldQuery.md b/docs/reference/api/QueryDslShapeFieldQuery.md index 97da4a4e5..9664cd25f 100644 --- a/docs/reference/api/QueryDslShapeFieldQuery.md +++ b/docs/reference/api/QueryDslShapeFieldQuery.md @@ -1,4 +1,4 @@ -## Interface `QueryDslShapeFieldQuery` +# `QueryDslShapeFieldQuery` [interface-QueryDslShapeFieldQuery] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslShapeQuery.md b/docs/reference/api/QueryDslShapeQuery.md index d36800eab..f6879cdd8 100644 --- a/docs/reference/api/QueryDslShapeQuery.md +++ b/docs/reference/api/QueryDslShapeQuery.md @@ -1,4 +1,4 @@ -## `QueryDslShapeQuery` -::: +# `QueryDslShapeQuery` [alias-QueryDslShapeQuery] +```typescript type QueryDslShapeQuery = [QueryDslShapeQueryKeys](./QueryDslShapeQueryKeys.md) & { [property: string]: [QueryDslShapeFieldQuery](./QueryDslShapeFieldQuery.md) | boolean | [float](./float.md) | string;}; -::: +``` diff --git a/docs/reference/api/QueryDslShapeQueryKeys.md b/docs/reference/api/QueryDslShapeQueryKeys.md index 66e853fed..7a1b36a86 100644 --- a/docs/reference/api/QueryDslShapeQueryKeys.md +++ b/docs/reference/api/QueryDslShapeQueryKeys.md @@ -1,4 +1,4 @@ -## Interface `QueryDslShapeQueryKeys` +# `QueryDslShapeQueryKeys` [interface-QueryDslShapeQueryKeys] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslSimpleQueryStringFlag.md b/docs/reference/api/QueryDslSimpleQueryStringFlag.md index a02b5a918..f265d2a3a 100644 --- a/docs/reference/api/QueryDslSimpleQueryStringFlag.md +++ b/docs/reference/api/QueryDslSimpleQueryStringFlag.md @@ -1,4 +1,4 @@ -## `QueryDslSimpleQueryStringFlag` -::: +# `QueryDslSimpleQueryStringFlag` [alias-QueryDslSimpleQueryStringFlag] +```typescript type QueryDslSimpleQueryStringFlag = 'NONE' | 'AND' | 'NOT' | 'OR' | 'PREFIX' | 'PHRASE' | 'PRECEDENCE' | 'ESCAPE' | 'WHITESPACE' | 'FUZZY' | 'NEAR' | 'SLOP' | 'ALL'; -::: +``` diff --git a/docs/reference/api/QueryDslSimpleQueryStringFlags.md b/docs/reference/api/QueryDslSimpleQueryStringFlags.md index c4fdafbe2..74c156805 100644 --- a/docs/reference/api/QueryDslSimpleQueryStringFlags.md +++ b/docs/reference/api/QueryDslSimpleQueryStringFlags.md @@ -1,4 +1,4 @@ -## `QueryDslSimpleQueryStringFlags` -::: +# `QueryDslSimpleQueryStringFlags` [alias-QueryDslSimpleQueryStringFlags] +```typescript type QueryDslSimpleQueryStringFlags = [SpecUtilsPipeSeparatedFlags](./SpecUtilsPipeSeparatedFlags.md)<[QueryDslSimpleQueryStringFlag](./QueryDslSimpleQueryStringFlag.md)>; -::: +``` diff --git a/docs/reference/api/QueryDslSimpleQueryStringQuery.md b/docs/reference/api/QueryDslSimpleQueryStringQuery.md index afd1b68c3..99b3663d4 100644 --- a/docs/reference/api/QueryDslSimpleQueryStringQuery.md +++ b/docs/reference/api/QueryDslSimpleQueryStringQuery.md @@ -1,4 +1,4 @@ -## Interface `QueryDslSimpleQueryStringQuery` +# `QueryDslSimpleQueryStringQuery` [interface-QueryDslSimpleQueryStringQuery] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslSpanContainingQuery.md b/docs/reference/api/QueryDslSpanContainingQuery.md index 0866d66fd..bc4c8578a 100644 --- a/docs/reference/api/QueryDslSpanContainingQuery.md +++ b/docs/reference/api/QueryDslSpanContainingQuery.md @@ -1,4 +1,4 @@ -## Interface `QueryDslSpanContainingQuery` +# `QueryDslSpanContainingQuery` [interface-QueryDslSpanContainingQuery] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslSpanFieldMaskingQuery.md b/docs/reference/api/QueryDslSpanFieldMaskingQuery.md index 2f90db3d1..883dadd4e 100644 --- a/docs/reference/api/QueryDslSpanFieldMaskingQuery.md +++ b/docs/reference/api/QueryDslSpanFieldMaskingQuery.md @@ -1,4 +1,4 @@ -## Interface `QueryDslSpanFieldMaskingQuery` +# `QueryDslSpanFieldMaskingQuery` [interface-QueryDslSpanFieldMaskingQuery] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslSpanFirstQuery.md b/docs/reference/api/QueryDslSpanFirstQuery.md index 2b033b3f3..1a7fa41b5 100644 --- a/docs/reference/api/QueryDslSpanFirstQuery.md +++ b/docs/reference/api/QueryDslSpanFirstQuery.md @@ -1,4 +1,4 @@ -## Interface `QueryDslSpanFirstQuery` +# `QueryDslSpanFirstQuery` [interface-QueryDslSpanFirstQuery] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslSpanGapQuery.md b/docs/reference/api/QueryDslSpanGapQuery.md index 5997d9502..718da6c3f 100644 --- a/docs/reference/api/QueryDslSpanGapQuery.md +++ b/docs/reference/api/QueryDslSpanGapQuery.md @@ -1,4 +1,4 @@ -## `QueryDslSpanGapQuery` -::: +# `QueryDslSpanGapQuery` [alias-QueryDslSpanGapQuery] +```typescript type QueryDslSpanGapQuery = [Partial](./Partial.md)>; -::: +``` diff --git a/docs/reference/api/QueryDslSpanMultiTermQuery.md b/docs/reference/api/QueryDslSpanMultiTermQuery.md index 889e4bb01..501ae5fdd 100644 --- a/docs/reference/api/QueryDslSpanMultiTermQuery.md +++ b/docs/reference/api/QueryDslSpanMultiTermQuery.md @@ -1,4 +1,4 @@ -## Interface `QueryDslSpanMultiTermQuery` +# `QueryDslSpanMultiTermQuery` [interface-QueryDslSpanMultiTermQuery] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslSpanNearQuery.md b/docs/reference/api/QueryDslSpanNearQuery.md index 5d8b9a0be..fc442cfb2 100644 --- a/docs/reference/api/QueryDslSpanNearQuery.md +++ b/docs/reference/api/QueryDslSpanNearQuery.md @@ -1,4 +1,4 @@ -## Interface `QueryDslSpanNearQuery` +# `QueryDslSpanNearQuery` [interface-QueryDslSpanNearQuery] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslSpanNotQuery.md b/docs/reference/api/QueryDslSpanNotQuery.md index b3f2d82d8..589ecb1d1 100644 --- a/docs/reference/api/QueryDslSpanNotQuery.md +++ b/docs/reference/api/QueryDslSpanNotQuery.md @@ -1,4 +1,4 @@ -## Interface `QueryDslSpanNotQuery` +# `QueryDslSpanNotQuery` [interface-QueryDslSpanNotQuery] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslSpanOrQuery.md b/docs/reference/api/QueryDslSpanOrQuery.md index f7858f82e..073f17262 100644 --- a/docs/reference/api/QueryDslSpanOrQuery.md +++ b/docs/reference/api/QueryDslSpanOrQuery.md @@ -1,4 +1,4 @@ -## Interface `QueryDslSpanOrQuery` +# `QueryDslSpanOrQuery` [interface-QueryDslSpanOrQuery] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslSpanQuery.md b/docs/reference/api/QueryDslSpanQuery.md index da4e56786..7af537b0a 100644 --- a/docs/reference/api/QueryDslSpanQuery.md +++ b/docs/reference/api/QueryDslSpanQuery.md @@ -1,4 +1,4 @@ -## Interface `QueryDslSpanQuery` +# `QueryDslSpanQuery` [interface-QueryDslSpanQuery] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslSpanTermQuery.md b/docs/reference/api/QueryDslSpanTermQuery.md index 663778588..ea88c3699 100644 --- a/docs/reference/api/QueryDslSpanTermQuery.md +++ b/docs/reference/api/QueryDslSpanTermQuery.md @@ -1,4 +1,4 @@ -## Interface `QueryDslSpanTermQuery` +# `QueryDslSpanTermQuery` [interface-QueryDslSpanTermQuery] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslSpanWithinQuery.md b/docs/reference/api/QueryDslSpanWithinQuery.md index 828b6b13a..a7c8640a1 100644 --- a/docs/reference/api/QueryDslSpanWithinQuery.md +++ b/docs/reference/api/QueryDslSpanWithinQuery.md @@ -1,4 +1,4 @@ -## Interface `QueryDslSpanWithinQuery` +# `QueryDslSpanWithinQuery` [interface-QueryDslSpanWithinQuery] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslSparseVectorQuery.md b/docs/reference/api/QueryDslSparseVectorQuery.md index ea79c9641..0069ae4b1 100644 --- a/docs/reference/api/QueryDslSparseVectorQuery.md +++ b/docs/reference/api/QueryDslSparseVectorQuery.md @@ -1,4 +1,4 @@ -## Interface `QueryDslSparseVectorQuery` +# `QueryDslSparseVectorQuery` [interface-QueryDslSparseVectorQuery] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslTermQuery.md b/docs/reference/api/QueryDslTermQuery.md index 3572e3cc6..c682632ed 100644 --- a/docs/reference/api/QueryDslTermQuery.md +++ b/docs/reference/api/QueryDslTermQuery.md @@ -1,4 +1,4 @@ -## Interface `QueryDslTermQuery` +# `QueryDslTermQuery` [interface-QueryDslTermQuery] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslTermRangeQuery.md b/docs/reference/api/QueryDslTermRangeQuery.md index 3d95f7492..05967acb0 100644 --- a/docs/reference/api/QueryDslTermRangeQuery.md +++ b/docs/reference/api/QueryDslTermRangeQuery.md @@ -1,4 +1,4 @@ -## Interface `QueryDslTermRangeQuery` +# `QueryDslTermRangeQuery` [interface-QueryDslTermRangeQuery] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslTermsLookup.md b/docs/reference/api/QueryDslTermsLookup.md index ca6f7a20f..d0af00c35 100644 --- a/docs/reference/api/QueryDslTermsLookup.md +++ b/docs/reference/api/QueryDslTermsLookup.md @@ -1,4 +1,4 @@ -## Interface `QueryDslTermsLookup` +# `QueryDslTermsLookup` [interface-QueryDslTermsLookup] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslTermsQuery.md b/docs/reference/api/QueryDslTermsQuery.md index 900484a20..ae4217f9e 100644 --- a/docs/reference/api/QueryDslTermsQuery.md +++ b/docs/reference/api/QueryDslTermsQuery.md @@ -1,4 +1,4 @@ -## `QueryDslTermsQuery` -::: +# `QueryDslTermsQuery` [alias-QueryDslTermsQuery] +```typescript type QueryDslTermsQuery = [QueryDslTermsQueryKeys](./QueryDslTermsQueryKeys.md) & { [property: string]: [QueryDslTermsQueryField](./QueryDslTermsQueryField.md) | [float](./float.md) | string;}; -::: +``` diff --git a/docs/reference/api/QueryDslTermsQueryField.md b/docs/reference/api/QueryDslTermsQueryField.md index be9ef9787..19f2b7549 100644 --- a/docs/reference/api/QueryDslTermsQueryField.md +++ b/docs/reference/api/QueryDslTermsQueryField.md @@ -1,4 +1,4 @@ -## `QueryDslTermsQueryField` -::: +# `QueryDslTermsQueryField` [alias-QueryDslTermsQueryField] +```typescript type QueryDslTermsQueryField = [FieldValue](./FieldValue.md)[] | [QueryDslTermsLookup](./QueryDslTermsLookup.md); -::: +``` diff --git a/docs/reference/api/QueryDslTermsQueryKeys.md b/docs/reference/api/QueryDslTermsQueryKeys.md index 1793d92c8..5dd914fa3 100644 --- a/docs/reference/api/QueryDslTermsQueryKeys.md +++ b/docs/reference/api/QueryDslTermsQueryKeys.md @@ -1,4 +1,4 @@ -## Interface `QueryDslTermsQueryKeys` +# `QueryDslTermsQueryKeys` [interface-QueryDslTermsQueryKeys] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslTermsSetQuery.md b/docs/reference/api/QueryDslTermsSetQuery.md index 7e0def4d1..a749647a7 100644 --- a/docs/reference/api/QueryDslTermsSetQuery.md +++ b/docs/reference/api/QueryDslTermsSetQuery.md @@ -1,4 +1,4 @@ -## Interface `QueryDslTermsSetQuery` +# `QueryDslTermsSetQuery` [interface-QueryDslTermsSetQuery] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslTextExpansionQuery.md b/docs/reference/api/QueryDslTextExpansionQuery.md index 7c9cdbfbf..16aa3a927 100644 --- a/docs/reference/api/QueryDslTextExpansionQuery.md +++ b/docs/reference/api/QueryDslTextExpansionQuery.md @@ -1,4 +1,4 @@ -## Interface `QueryDslTextExpansionQuery` +# `QueryDslTextExpansionQuery` [interface-QueryDslTextExpansionQuery] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslTextQueryType.md b/docs/reference/api/QueryDslTextQueryType.md index 3e56cf94d..ed3b7e7c6 100644 --- a/docs/reference/api/QueryDslTextQueryType.md +++ b/docs/reference/api/QueryDslTextQueryType.md @@ -1,4 +1,4 @@ -## `QueryDslTextQueryType` -::: +# `QueryDslTextQueryType` [alias-QueryDslTextQueryType] +```typescript type QueryDslTextQueryType = 'best_fields' | 'most_fields' | 'cross_fields' | 'phrase' | 'phrase_prefix' | 'bool_prefix'; -::: +``` diff --git a/docs/reference/api/QueryDslTokenPruningConfig.md b/docs/reference/api/QueryDslTokenPruningConfig.md index 868610c02..1b61919bf 100644 --- a/docs/reference/api/QueryDslTokenPruningConfig.md +++ b/docs/reference/api/QueryDslTokenPruningConfig.md @@ -1,4 +1,4 @@ -## Interface `QueryDslTokenPruningConfig` +# `QueryDslTokenPruningConfig` [interface-QueryDslTokenPruningConfig] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslTypeQuery.md b/docs/reference/api/QueryDslTypeQuery.md index bed46e6d6..fb4e8c06b 100644 --- a/docs/reference/api/QueryDslTypeQuery.md +++ b/docs/reference/api/QueryDslTypeQuery.md @@ -1,4 +1,4 @@ -## Interface `QueryDslTypeQuery` +# `QueryDslTypeQuery` [interface-QueryDslTypeQuery] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslUntypedDecayFunction.md b/docs/reference/api/QueryDslUntypedDecayFunction.md index 8281b32d5..074de3882 100644 --- a/docs/reference/api/QueryDslUntypedDecayFunction.md +++ b/docs/reference/api/QueryDslUntypedDecayFunction.md @@ -1,4 +1,4 @@ -## `QueryDslUntypedDecayFunction` -::: +# `QueryDslUntypedDecayFunction` [alias-QueryDslUntypedDecayFunction] +```typescript type QueryDslUntypedDecayFunction = [QueryDslUntypedDecayFunctionKeys](./QueryDslUntypedDecayFunctionKeys.md) & { [property: string]: [QueryDslDecayPlacement](./QueryDslDecayPlacement.md) | [QueryDslMultiValueMode](./QueryDslMultiValueMode.md);}; -::: +``` diff --git a/docs/reference/api/QueryDslUntypedDecayFunctionKeys.md b/docs/reference/api/QueryDslUntypedDecayFunctionKeys.md index c2b7e689b..f691e090f 100644 --- a/docs/reference/api/QueryDslUntypedDecayFunctionKeys.md +++ b/docs/reference/api/QueryDslUntypedDecayFunctionKeys.md @@ -1,4 +1,4 @@ -## Interface `QueryDslUntypedDecayFunctionKeys` +# `QueryDslUntypedDecayFunctionKeys` [interface-QueryDslUntypedDecayFunctionKeys] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslUntypedDistanceFeatureQuery.md b/docs/reference/api/QueryDslUntypedDistanceFeatureQuery.md index 7ffed5a03..6ca973ee8 100644 --- a/docs/reference/api/QueryDslUntypedDistanceFeatureQuery.md +++ b/docs/reference/api/QueryDslUntypedDistanceFeatureQuery.md @@ -1,4 +1,4 @@ -## Interface `QueryDslUntypedDistanceFeatureQuery` +# `QueryDslUntypedDistanceFeatureQuery` [interface-QueryDslUntypedDistanceFeatureQuery] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslUntypedRangeQuery.md b/docs/reference/api/QueryDslUntypedRangeQuery.md index 112bd0f67..1817f3478 100644 --- a/docs/reference/api/QueryDslUntypedRangeQuery.md +++ b/docs/reference/api/QueryDslUntypedRangeQuery.md @@ -1,4 +1,4 @@ -## Interface `QueryDslUntypedRangeQuery` +# `QueryDslUntypedRangeQuery` [interface-QueryDslUntypedRangeQuery] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslWeightedTokensQuery.md b/docs/reference/api/QueryDslWeightedTokensQuery.md index 034810c4c..843a91e0f 100644 --- a/docs/reference/api/QueryDslWeightedTokensQuery.md +++ b/docs/reference/api/QueryDslWeightedTokensQuery.md @@ -1,4 +1,4 @@ -## Interface `QueryDslWeightedTokensQuery` +# `QueryDslWeightedTokensQuery` [interface-QueryDslWeightedTokensQuery] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslWildcardQuery.md b/docs/reference/api/QueryDslWildcardQuery.md index 9dba21fae..3c736d0f7 100644 --- a/docs/reference/api/QueryDslWildcardQuery.md +++ b/docs/reference/api/QueryDslWildcardQuery.md @@ -1,4 +1,4 @@ -## Interface `QueryDslWildcardQuery` +# `QueryDslWildcardQuery` [interface-QueryDslWildcardQuery] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslWrapperQuery.md b/docs/reference/api/QueryDslWrapperQuery.md index 7ba77c89d..14fedba8a 100644 --- a/docs/reference/api/QueryDslWrapperQuery.md +++ b/docs/reference/api/QueryDslWrapperQuery.md @@ -1,4 +1,4 @@ -## Interface `QueryDslWrapperQuery` +# `QueryDslWrapperQuery` [interface-QueryDslWrapperQuery] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryDslZeroTermsQuery.md b/docs/reference/api/QueryDslZeroTermsQuery.md index 44f3563c2..641efc2d9 100644 --- a/docs/reference/api/QueryDslZeroTermsQuery.md +++ b/docs/reference/api/QueryDslZeroTermsQuery.md @@ -1,4 +1,4 @@ -## `QueryDslZeroTermsQuery` -::: +# `QueryDslZeroTermsQuery` [alias-QueryDslZeroTermsQuery] +```typescript type QueryDslZeroTermsQuery = 'all' | 'none'; -::: +``` diff --git a/docs/reference/api/QueryRules.md b/docs/reference/api/QueryRules.md index 767c9220f..1f798fb76 100644 --- a/docs/reference/api/QueryRules.md +++ b/docs/reference/api/QueryRules.md @@ -1,19 +1,19 @@ -## `QueryRules` +# `QueryRules` [class-QueryRules] -### Constructor +## Constructor -::: +```typescript new QueryRules(transport: [Transport](./Transport.md)); -::: +``` -### Properties +## Properties [class-properties-QueryRules] | Name | Type | Description | | - | - | - | | `acceptedParams` | Record |   | | `transport` | [Transport](./Transport.md) |   | -### Methods +## Methods [class-methods-QueryRules] | Name | Signature | Description | | - | - | - | diff --git a/docs/reference/api/QueryRulesDeleteRuleRequest.md b/docs/reference/api/QueryRulesDeleteRuleRequest.md index de1ae8475..dde4fed48 100644 --- a/docs/reference/api/QueryRulesDeleteRuleRequest.md +++ b/docs/reference/api/QueryRulesDeleteRuleRequest.md @@ -1,4 +1,4 @@ -## Interface `QueryRulesDeleteRuleRequest` +# `QueryRulesDeleteRuleRequest` [interface-QueryRulesDeleteRuleRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryRulesDeleteRuleResponse.md b/docs/reference/api/QueryRulesDeleteRuleResponse.md index 9e7edfeda..700d9ddfd 100644 --- a/docs/reference/api/QueryRulesDeleteRuleResponse.md +++ b/docs/reference/api/QueryRulesDeleteRuleResponse.md @@ -1,4 +1,4 @@ -## `QueryRulesDeleteRuleResponse` -::: +# `QueryRulesDeleteRuleResponse` [alias-QueryRulesDeleteRuleResponse] +```typescript type QueryRulesDeleteRuleResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); -::: +``` diff --git a/docs/reference/api/QueryRulesDeleteRulesetRequest.md b/docs/reference/api/QueryRulesDeleteRulesetRequest.md index ab5e7278f..d79fa45cd 100644 --- a/docs/reference/api/QueryRulesDeleteRulesetRequest.md +++ b/docs/reference/api/QueryRulesDeleteRulesetRequest.md @@ -1,4 +1,4 @@ -## Interface `QueryRulesDeleteRulesetRequest` +# `QueryRulesDeleteRulesetRequest` [interface-QueryRulesDeleteRulesetRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryRulesDeleteRulesetResponse.md b/docs/reference/api/QueryRulesDeleteRulesetResponse.md index 2ee181dec..b4ff9beb2 100644 --- a/docs/reference/api/QueryRulesDeleteRulesetResponse.md +++ b/docs/reference/api/QueryRulesDeleteRulesetResponse.md @@ -1,4 +1,4 @@ -## `QueryRulesDeleteRulesetResponse` -::: +# `QueryRulesDeleteRulesetResponse` [alias-QueryRulesDeleteRulesetResponse] +```typescript type QueryRulesDeleteRulesetResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); -::: +``` diff --git a/docs/reference/api/QueryRulesGetRuleRequest.md b/docs/reference/api/QueryRulesGetRuleRequest.md index d4110a213..a391b7af5 100644 --- a/docs/reference/api/QueryRulesGetRuleRequest.md +++ b/docs/reference/api/QueryRulesGetRuleRequest.md @@ -1,4 +1,4 @@ -## Interface `QueryRulesGetRuleRequest` +# `QueryRulesGetRuleRequest` [interface-QueryRulesGetRuleRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryRulesGetRuleResponse.md b/docs/reference/api/QueryRulesGetRuleResponse.md index 7c4f8a5c7..51cbc0beb 100644 --- a/docs/reference/api/QueryRulesGetRuleResponse.md +++ b/docs/reference/api/QueryRulesGetRuleResponse.md @@ -1,4 +1,4 @@ -## `QueryRulesGetRuleResponse` -::: +# `QueryRulesGetRuleResponse` [alias-QueryRulesGetRuleResponse] +```typescript type QueryRulesGetRuleResponse = [QueryRulesQueryRule](./QueryRulesQueryRule.md); -::: +``` diff --git a/docs/reference/api/QueryRulesGetRulesetRequest.md b/docs/reference/api/QueryRulesGetRulesetRequest.md index a21e406d4..378dbb8b1 100644 --- a/docs/reference/api/QueryRulesGetRulesetRequest.md +++ b/docs/reference/api/QueryRulesGetRulesetRequest.md @@ -1,4 +1,4 @@ -## Interface `QueryRulesGetRulesetRequest` +# `QueryRulesGetRulesetRequest` [interface-QueryRulesGetRulesetRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryRulesGetRulesetResponse.md b/docs/reference/api/QueryRulesGetRulesetResponse.md index c53dc7aca..d8b487255 100644 --- a/docs/reference/api/QueryRulesGetRulesetResponse.md +++ b/docs/reference/api/QueryRulesGetRulesetResponse.md @@ -1,4 +1,4 @@ -## `QueryRulesGetRulesetResponse` -::: +# `QueryRulesGetRulesetResponse` [alias-QueryRulesGetRulesetResponse] +```typescript type QueryRulesGetRulesetResponse = [QueryRulesQueryRuleset](./QueryRulesQueryRuleset.md); -::: +``` diff --git a/docs/reference/api/QueryRulesListRulesetsQueryRulesetListItem.md b/docs/reference/api/QueryRulesListRulesetsQueryRulesetListItem.md index 20803114b..d54ea5950 100644 --- a/docs/reference/api/QueryRulesListRulesetsQueryRulesetListItem.md +++ b/docs/reference/api/QueryRulesListRulesetsQueryRulesetListItem.md @@ -1,4 +1,4 @@ -## Interface `QueryRulesListRulesetsQueryRulesetListItem` +# `QueryRulesListRulesetsQueryRulesetListItem` [interface-QueryRulesListRulesetsQueryRulesetListItem] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryRulesListRulesetsRequest.md b/docs/reference/api/QueryRulesListRulesetsRequest.md index f6feffe19..e38a7a77f 100644 --- a/docs/reference/api/QueryRulesListRulesetsRequest.md +++ b/docs/reference/api/QueryRulesListRulesetsRequest.md @@ -1,4 +1,4 @@ -## Interface `QueryRulesListRulesetsRequest` +# `QueryRulesListRulesetsRequest` [interface-QueryRulesListRulesetsRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryRulesListRulesetsResponse.md b/docs/reference/api/QueryRulesListRulesetsResponse.md index 852b4c4c0..4d01c797e 100644 --- a/docs/reference/api/QueryRulesListRulesetsResponse.md +++ b/docs/reference/api/QueryRulesListRulesetsResponse.md @@ -1,4 +1,4 @@ -## Interface `QueryRulesListRulesetsResponse` +# `QueryRulesListRulesetsResponse` [interface-QueryRulesListRulesetsResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryRulesPutRuleRequest.md b/docs/reference/api/QueryRulesPutRuleRequest.md index bfcf965c7..40d887d49 100644 --- a/docs/reference/api/QueryRulesPutRuleRequest.md +++ b/docs/reference/api/QueryRulesPutRuleRequest.md @@ -1,4 +1,4 @@ -## Interface `QueryRulesPutRuleRequest` +# `QueryRulesPutRuleRequest` [interface-QueryRulesPutRuleRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryRulesPutRuleResponse.md b/docs/reference/api/QueryRulesPutRuleResponse.md index 6b5b75e8e..4c404203c 100644 --- a/docs/reference/api/QueryRulesPutRuleResponse.md +++ b/docs/reference/api/QueryRulesPutRuleResponse.md @@ -1,4 +1,4 @@ -## Interface `QueryRulesPutRuleResponse` +# `QueryRulesPutRuleResponse` [interface-QueryRulesPutRuleResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryRulesPutRulesetRequest.md b/docs/reference/api/QueryRulesPutRulesetRequest.md index 02abe3209..60fc45f2b 100644 --- a/docs/reference/api/QueryRulesPutRulesetRequest.md +++ b/docs/reference/api/QueryRulesPutRulesetRequest.md @@ -1,4 +1,4 @@ -## Interface `QueryRulesPutRulesetRequest` +# `QueryRulesPutRulesetRequest` [interface-QueryRulesPutRulesetRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryRulesPutRulesetResponse.md b/docs/reference/api/QueryRulesPutRulesetResponse.md index 61a94065f..b8df087ba 100644 --- a/docs/reference/api/QueryRulesPutRulesetResponse.md +++ b/docs/reference/api/QueryRulesPutRulesetResponse.md @@ -1,4 +1,4 @@ -## Interface `QueryRulesPutRulesetResponse` +# `QueryRulesPutRulesetResponse` [interface-QueryRulesPutRulesetResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryRulesQueryRule.md b/docs/reference/api/QueryRulesQueryRule.md index 97b50863e..7dc9c3fc7 100644 --- a/docs/reference/api/QueryRulesQueryRule.md +++ b/docs/reference/api/QueryRulesQueryRule.md @@ -1,4 +1,4 @@ -## Interface `QueryRulesQueryRule` +# `QueryRulesQueryRule` [interface-QueryRulesQueryRule] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryRulesQueryRuleActions.md b/docs/reference/api/QueryRulesQueryRuleActions.md index 02573457e..ffe5146e9 100644 --- a/docs/reference/api/QueryRulesQueryRuleActions.md +++ b/docs/reference/api/QueryRulesQueryRuleActions.md @@ -1,4 +1,4 @@ -## Interface `QueryRulesQueryRuleActions` +# `QueryRulesQueryRuleActions` [interface-QueryRulesQueryRuleActions] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryRulesQueryRuleCriteria.md b/docs/reference/api/QueryRulesQueryRuleCriteria.md index 22b3ee383..04973a205 100644 --- a/docs/reference/api/QueryRulesQueryRuleCriteria.md +++ b/docs/reference/api/QueryRulesQueryRuleCriteria.md @@ -1,4 +1,4 @@ -## Interface `QueryRulesQueryRuleCriteria` +# `QueryRulesQueryRuleCriteria` [interface-QueryRulesQueryRuleCriteria] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryRulesQueryRuleCriteriaType.md b/docs/reference/api/QueryRulesQueryRuleCriteriaType.md index f8a4a35d7..721c5fea6 100644 --- a/docs/reference/api/QueryRulesQueryRuleCriteriaType.md +++ b/docs/reference/api/QueryRulesQueryRuleCriteriaType.md @@ -1,4 +1,4 @@ -## `QueryRulesQueryRuleCriteriaType` -::: +# `QueryRulesQueryRuleCriteriaType` [alias-QueryRulesQueryRuleCriteriaType] +```typescript type QueryRulesQueryRuleCriteriaType = 'global' | 'exact' | 'exact_fuzzy' | 'fuzzy' | 'prefix' | 'suffix' | 'contains' | 'lt' | 'lte' | 'gt' | 'gte' | 'always'; -::: +``` diff --git a/docs/reference/api/QueryRulesQueryRuleType.md b/docs/reference/api/QueryRulesQueryRuleType.md index f5e9ef511..29c1d29e2 100644 --- a/docs/reference/api/QueryRulesQueryRuleType.md +++ b/docs/reference/api/QueryRulesQueryRuleType.md @@ -1,4 +1,4 @@ -## `QueryRulesQueryRuleType` -::: +# `QueryRulesQueryRuleType` [alias-QueryRulesQueryRuleType] +```typescript type QueryRulesQueryRuleType = 'pinned' | 'exclude'; -::: +``` diff --git a/docs/reference/api/QueryRulesQueryRuleset.md b/docs/reference/api/QueryRulesQueryRuleset.md index 60499a011..56d14b088 100644 --- a/docs/reference/api/QueryRulesQueryRuleset.md +++ b/docs/reference/api/QueryRulesQueryRuleset.md @@ -1,4 +1,4 @@ -## Interface `QueryRulesQueryRuleset` +# `QueryRulesQueryRuleset` [interface-QueryRulesQueryRuleset] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryRulesTestQueryRulesetMatchedRule.md b/docs/reference/api/QueryRulesTestQueryRulesetMatchedRule.md index f17c56b70..cf871d3f5 100644 --- a/docs/reference/api/QueryRulesTestQueryRulesetMatchedRule.md +++ b/docs/reference/api/QueryRulesTestQueryRulesetMatchedRule.md @@ -1,4 +1,4 @@ -## Interface `QueryRulesTestQueryRulesetMatchedRule` +# `QueryRulesTestQueryRulesetMatchedRule` [interface-QueryRulesTestQueryRulesetMatchedRule] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryRulesTestRequest.md b/docs/reference/api/QueryRulesTestRequest.md index 20e04aef2..4939efeb3 100644 --- a/docs/reference/api/QueryRulesTestRequest.md +++ b/docs/reference/api/QueryRulesTestRequest.md @@ -1,4 +1,4 @@ -## Interface `QueryRulesTestRequest` +# `QueryRulesTestRequest` [interface-QueryRulesTestRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryRulesTestResponse.md b/docs/reference/api/QueryRulesTestResponse.md index 13b0d6130..844ada19a 100644 --- a/docs/reference/api/QueryRulesTestResponse.md +++ b/docs/reference/api/QueryRulesTestResponse.md @@ -1,4 +1,4 @@ -## Interface `QueryRulesTestResponse` +# `QueryRulesTestResponse` [interface-QueryRulesTestResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/QueryVector.md b/docs/reference/api/QueryVector.md index a59df2954..27615ad46 100644 --- a/docs/reference/api/QueryVector.md +++ b/docs/reference/api/QueryVector.md @@ -1,4 +1,4 @@ -## `QueryVector` -::: +# `QueryVector` [alias-QueryVector] +```typescript type QueryVector = [float](./float.md)[]; -::: +``` diff --git a/docs/reference/api/QueryVectorBuilder.md b/docs/reference/api/QueryVectorBuilder.md index 02bf8ab0e..02fdfb0c4 100644 --- a/docs/reference/api/QueryVectorBuilder.md +++ b/docs/reference/api/QueryVectorBuilder.md @@ -1,4 +1,4 @@ -## Interface `QueryVectorBuilder` +# `QueryVectorBuilder` [interface-QueryVectorBuilder] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/RRFRetriever.md b/docs/reference/api/RRFRetriever.md index 9dba43d00..dcf403b63 100644 --- a/docs/reference/api/RRFRetriever.md +++ b/docs/reference/api/RRFRetriever.md @@ -1,4 +1,4 @@ -## Interface `RRFRetriever` +# `RRFRetriever` [interface-RRFRetriever] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/RankBase.md b/docs/reference/api/RankBase.md index 52f8aa591..93383e59c 100644 --- a/docs/reference/api/RankBase.md +++ b/docs/reference/api/RankBase.md @@ -1,4 +1,4 @@ -## Interface `RankBase` +# `RankBase` [interface-RankBase] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/RankContainer.md b/docs/reference/api/RankContainer.md index 3983ee23a..76c212cb0 100644 --- a/docs/reference/api/RankContainer.md +++ b/docs/reference/api/RankContainer.md @@ -1,4 +1,4 @@ -## Interface `RankContainer` +# `RankContainer` [interface-RankContainer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/RankEvalApi_1.md b/docs/reference/api/RankEvalApi_1.md index b908aa0eb..3e322a33f 100644 --- a/docs/reference/api/RankEvalApi_1.md +++ b/docs/reference/api/RankEvalApi_1.md @@ -1,3 +1,3 @@ -::: +```typescript default function RankEvalApi(this: [That](./That.md), params: [RankEvalRequest](./RankEvalRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[RankEvalResponse](./RankEvalResponse.md)>; -::: +``` diff --git a/docs/reference/api/RankEvalApi_2.md b/docs/reference/api/RankEvalApi_2.md index 198cf8205..9b7d7fea3 100644 --- a/docs/reference/api/RankEvalApi_2.md +++ b/docs/reference/api/RankEvalApi_2.md @@ -1,3 +1,3 @@ -::: +```typescript default function RankEvalApi(this: [That](./That.md), params: [RankEvalRequest](./RankEvalRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[RankEvalResponse](./RankEvalResponse.md), unknown>>; -::: +``` diff --git a/docs/reference/api/RankEvalApi_3.md b/docs/reference/api/RankEvalApi_3.md index 6024561f6..bfce73b62 100644 --- a/docs/reference/api/RankEvalApi_3.md +++ b/docs/reference/api/RankEvalApi_3.md @@ -1,3 +1,3 @@ -::: +```typescript default function RankEvalApi(this: [That](./That.md), params: [RankEvalRequest](./RankEvalRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[RankEvalResponse](./RankEvalResponse.md)>; -::: +``` diff --git a/docs/reference/api/RankEvalDocumentRating.md b/docs/reference/api/RankEvalDocumentRating.md index 521cb9fe8..9b64f5d00 100644 --- a/docs/reference/api/RankEvalDocumentRating.md +++ b/docs/reference/api/RankEvalDocumentRating.md @@ -1,4 +1,4 @@ -## Interface `RankEvalDocumentRating` +# `RankEvalDocumentRating` [interface-RankEvalDocumentRating] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/RankEvalRankEvalHit.md b/docs/reference/api/RankEvalRankEvalHit.md index ed22c3686..1826e6803 100644 --- a/docs/reference/api/RankEvalRankEvalHit.md +++ b/docs/reference/api/RankEvalRankEvalHit.md @@ -1,4 +1,4 @@ -## Interface `RankEvalRankEvalHit` +# `RankEvalRankEvalHit` [interface-RankEvalRankEvalHit] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/RankEvalRankEvalHitItem.md b/docs/reference/api/RankEvalRankEvalHitItem.md index 63ce999c2..cff4ff5ec 100644 --- a/docs/reference/api/RankEvalRankEvalHitItem.md +++ b/docs/reference/api/RankEvalRankEvalHitItem.md @@ -1,4 +1,4 @@ -## Interface `RankEvalRankEvalHitItem` +# `RankEvalRankEvalHitItem` [interface-RankEvalRankEvalHitItem] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/RankEvalRankEvalMetric.md b/docs/reference/api/RankEvalRankEvalMetric.md index 55b210f26..4db7f4c5c 100644 --- a/docs/reference/api/RankEvalRankEvalMetric.md +++ b/docs/reference/api/RankEvalRankEvalMetric.md @@ -1,4 +1,4 @@ -## Interface `RankEvalRankEvalMetric` +# `RankEvalRankEvalMetric` [interface-RankEvalRankEvalMetric] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/RankEvalRankEvalMetricBase.md b/docs/reference/api/RankEvalRankEvalMetricBase.md index bea2d7146..24c3e9996 100644 --- a/docs/reference/api/RankEvalRankEvalMetricBase.md +++ b/docs/reference/api/RankEvalRankEvalMetricBase.md @@ -1,4 +1,4 @@ -## Interface `RankEvalRankEvalMetricBase` +# `RankEvalRankEvalMetricBase` [interface-RankEvalRankEvalMetricBase] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/RankEvalRankEvalMetricDetail.md b/docs/reference/api/RankEvalRankEvalMetricDetail.md index e58e36ea9..884dc8850 100644 --- a/docs/reference/api/RankEvalRankEvalMetricDetail.md +++ b/docs/reference/api/RankEvalRankEvalMetricDetail.md @@ -1,4 +1,4 @@ -## Interface `RankEvalRankEvalMetricDetail` +# `RankEvalRankEvalMetricDetail` [interface-RankEvalRankEvalMetricDetail] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/RankEvalRankEvalMetricDiscountedCumulativeGain.md b/docs/reference/api/RankEvalRankEvalMetricDiscountedCumulativeGain.md index 74a0d5f4e..d8194c5df 100644 --- a/docs/reference/api/RankEvalRankEvalMetricDiscountedCumulativeGain.md +++ b/docs/reference/api/RankEvalRankEvalMetricDiscountedCumulativeGain.md @@ -1,4 +1,4 @@ -## Interface `RankEvalRankEvalMetricDiscountedCumulativeGain` +# `RankEvalRankEvalMetricDiscountedCumulativeGain` [interface-RankEvalRankEvalMetricDiscountedCumulativeGain] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/RankEvalRankEvalMetricExpectedReciprocalRank.md b/docs/reference/api/RankEvalRankEvalMetricExpectedReciprocalRank.md index 8f5ada34b..fe720ec0d 100644 --- a/docs/reference/api/RankEvalRankEvalMetricExpectedReciprocalRank.md +++ b/docs/reference/api/RankEvalRankEvalMetricExpectedReciprocalRank.md @@ -1,4 +1,4 @@ -## Interface `RankEvalRankEvalMetricExpectedReciprocalRank` +# `RankEvalRankEvalMetricExpectedReciprocalRank` [interface-RankEvalRankEvalMetricExpectedReciprocalRank] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/RankEvalRankEvalMetricMeanReciprocalRank.md b/docs/reference/api/RankEvalRankEvalMetricMeanReciprocalRank.md index f5cd9fa80..61e72114c 100644 --- a/docs/reference/api/RankEvalRankEvalMetricMeanReciprocalRank.md +++ b/docs/reference/api/RankEvalRankEvalMetricMeanReciprocalRank.md @@ -1,4 +1,4 @@ -## Interface `RankEvalRankEvalMetricMeanReciprocalRank` +# `RankEvalRankEvalMetricMeanReciprocalRank` [interface-RankEvalRankEvalMetricMeanReciprocalRank] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/RankEvalRankEvalMetricPrecision.md b/docs/reference/api/RankEvalRankEvalMetricPrecision.md index 8bdb55168..6ac52e103 100644 --- a/docs/reference/api/RankEvalRankEvalMetricPrecision.md +++ b/docs/reference/api/RankEvalRankEvalMetricPrecision.md @@ -1,4 +1,4 @@ -## Interface `RankEvalRankEvalMetricPrecision` +# `RankEvalRankEvalMetricPrecision` [interface-RankEvalRankEvalMetricPrecision] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/RankEvalRankEvalMetricRatingTreshold.md b/docs/reference/api/RankEvalRankEvalMetricRatingTreshold.md index babeb5df7..0f5543a1b 100644 --- a/docs/reference/api/RankEvalRankEvalMetricRatingTreshold.md +++ b/docs/reference/api/RankEvalRankEvalMetricRatingTreshold.md @@ -1,4 +1,4 @@ -## Interface `RankEvalRankEvalMetricRatingTreshold` +# `RankEvalRankEvalMetricRatingTreshold` [interface-RankEvalRankEvalMetricRatingTreshold] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/RankEvalRankEvalMetricRecall.md b/docs/reference/api/RankEvalRankEvalMetricRecall.md index 1603da323..058b1cc69 100644 --- a/docs/reference/api/RankEvalRankEvalMetricRecall.md +++ b/docs/reference/api/RankEvalRankEvalMetricRecall.md @@ -1,4 +1,4 @@ -## Interface `RankEvalRankEvalMetricRecall` +# `RankEvalRankEvalMetricRecall` [interface-RankEvalRankEvalMetricRecall] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/RankEvalRankEvalQuery.md b/docs/reference/api/RankEvalRankEvalQuery.md index 44d09a250..83457c0d4 100644 --- a/docs/reference/api/RankEvalRankEvalQuery.md +++ b/docs/reference/api/RankEvalRankEvalQuery.md @@ -1,4 +1,4 @@ -## Interface `RankEvalRankEvalQuery` +# `RankEvalRankEvalQuery` [interface-RankEvalRankEvalQuery] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/RankEvalRankEvalRequestItem.md b/docs/reference/api/RankEvalRankEvalRequestItem.md index a33a3e72e..5ed75e783 100644 --- a/docs/reference/api/RankEvalRankEvalRequestItem.md +++ b/docs/reference/api/RankEvalRankEvalRequestItem.md @@ -1,4 +1,4 @@ -## Interface `RankEvalRankEvalRequestItem` +# `RankEvalRankEvalRequestItem` [interface-RankEvalRankEvalRequestItem] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/RankEvalRequest.md b/docs/reference/api/RankEvalRequest.md index e96e3de47..05569c958 100644 --- a/docs/reference/api/RankEvalRequest.md +++ b/docs/reference/api/RankEvalRequest.md @@ -1,4 +1,4 @@ -## Interface `RankEvalRequest` +# `RankEvalRequest` [interface-RankEvalRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/RankEvalResponse.md b/docs/reference/api/RankEvalResponse.md index 39c17a14b..697dcea00 100644 --- a/docs/reference/api/RankEvalResponse.md +++ b/docs/reference/api/RankEvalResponse.md @@ -1,4 +1,4 @@ -## Interface `RankEvalResponse` +# `RankEvalResponse` [interface-RankEvalResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/RankEvalUnratedDocument.md b/docs/reference/api/RankEvalUnratedDocument.md index ce1136d7c..fbf17a838 100644 --- a/docs/reference/api/RankEvalUnratedDocument.md +++ b/docs/reference/api/RankEvalUnratedDocument.md @@ -1,4 +1,4 @@ -## Interface `RankEvalUnratedDocument` +# `RankEvalUnratedDocument` [interface-RankEvalUnratedDocument] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/RecoveryStats.md b/docs/reference/api/RecoveryStats.md index 4ab8617b1..1bda4d949 100644 --- a/docs/reference/api/RecoveryStats.md +++ b/docs/reference/api/RecoveryStats.md @@ -1,4 +1,4 @@ -## Interface `RecoveryStats` +# `RecoveryStats` [interface-RecoveryStats] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/Refresh.md b/docs/reference/api/Refresh.md index 911d454e6..0c44ab897 100644 --- a/docs/reference/api/Refresh.md +++ b/docs/reference/api/Refresh.md @@ -1,4 +1,4 @@ -## `Refresh` -::: +# `Refresh` [alias-Refresh] +```typescript type Refresh = boolean | 'true' | 'false' | 'wait_for'; -::: +``` diff --git a/docs/reference/api/RefreshStats.md b/docs/reference/api/RefreshStats.md index c74cdea29..113669ced 100644 --- a/docs/reference/api/RefreshStats.md +++ b/docs/reference/api/RefreshStats.md @@ -1,4 +1,4 @@ -## Interface `RefreshStats` +# `RefreshStats` [interface-RefreshStats] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ReindexApi_1.md b/docs/reference/api/ReindexApi_1.md index 34d978b2b..763fc647e 100644 --- a/docs/reference/api/ReindexApi_1.md +++ b/docs/reference/api/ReindexApi_1.md @@ -1,3 +1,3 @@ -::: +```typescript default function ReindexApi(this: [That](./That.md), params: [ReindexRequest](./ReindexRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ReindexResponse](./ReindexResponse.md)>; -::: +``` diff --git a/docs/reference/api/ReindexApi_2.md b/docs/reference/api/ReindexApi_2.md index 38757fd58..b0021cb36 100644 --- a/docs/reference/api/ReindexApi_2.md +++ b/docs/reference/api/ReindexApi_2.md @@ -1,3 +1,3 @@ -::: +```typescript default function ReindexApi(this: [That](./That.md), params: [ReindexRequest](./ReindexRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ReindexResponse](./ReindexResponse.md), unknown>>; -::: +``` diff --git a/docs/reference/api/ReindexApi_3.md b/docs/reference/api/ReindexApi_3.md index df977454e..52401133a 100644 --- a/docs/reference/api/ReindexApi_3.md +++ b/docs/reference/api/ReindexApi_3.md @@ -1,3 +1,3 @@ -::: +```typescript default function ReindexApi(this: [That](./That.md), params: [ReindexRequest](./ReindexRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ReindexResponse](./ReindexResponse.md)>; -::: +``` diff --git a/docs/reference/api/ReindexDestination.md b/docs/reference/api/ReindexDestination.md index 3b27d06a8..13576da47 100644 --- a/docs/reference/api/ReindexDestination.md +++ b/docs/reference/api/ReindexDestination.md @@ -1,4 +1,4 @@ -## Interface `ReindexDestination` +# `ReindexDestination` [interface-ReindexDestination] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ReindexRemoteSource.md b/docs/reference/api/ReindexRemoteSource.md index 76938fc8b..42c12e5b1 100644 --- a/docs/reference/api/ReindexRemoteSource.md +++ b/docs/reference/api/ReindexRemoteSource.md @@ -1,4 +1,4 @@ -## Interface `ReindexRemoteSource` +# `ReindexRemoteSource` [interface-ReindexRemoteSource] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ReindexRequest.md b/docs/reference/api/ReindexRequest.md index 72e8bdb23..c1722be0d 100644 --- a/docs/reference/api/ReindexRequest.md +++ b/docs/reference/api/ReindexRequest.md @@ -1,4 +1,4 @@ -## Interface `ReindexRequest` +# `ReindexRequest` [interface-ReindexRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ReindexResponse.md b/docs/reference/api/ReindexResponse.md index 9da2f6846..0268c027d 100644 --- a/docs/reference/api/ReindexResponse.md +++ b/docs/reference/api/ReindexResponse.md @@ -1,4 +1,4 @@ -## Interface `ReindexResponse` +# `ReindexResponse` [interface-ReindexResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ReindexRethrottleApi_1.md b/docs/reference/api/ReindexRethrottleApi_1.md index b9a0750a1..2e2db3986 100644 --- a/docs/reference/api/ReindexRethrottleApi_1.md +++ b/docs/reference/api/ReindexRethrottleApi_1.md @@ -1,3 +1,3 @@ -::: +```typescript default function ReindexRethrottleApi(this: [That](./That.md), params: [ReindexRethrottleRequest](./ReindexRethrottleRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ReindexRethrottleResponse](./ReindexRethrottleResponse.md)>; -::: +``` diff --git a/docs/reference/api/ReindexRethrottleApi_2.md b/docs/reference/api/ReindexRethrottleApi_2.md index 8a7f25581..609369c0c 100644 --- a/docs/reference/api/ReindexRethrottleApi_2.md +++ b/docs/reference/api/ReindexRethrottleApi_2.md @@ -1,3 +1,3 @@ -::: +```typescript default function ReindexRethrottleApi(this: [That](./That.md), params: [ReindexRethrottleRequest](./ReindexRethrottleRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ReindexRethrottleResponse](./ReindexRethrottleResponse.md), unknown>>; -::: +``` diff --git a/docs/reference/api/ReindexRethrottleApi_3.md b/docs/reference/api/ReindexRethrottleApi_3.md index f8bfaf775..2f9328f9c 100644 --- a/docs/reference/api/ReindexRethrottleApi_3.md +++ b/docs/reference/api/ReindexRethrottleApi_3.md @@ -1,3 +1,3 @@ -::: +```typescript default function ReindexRethrottleApi(this: [That](./That.md), params: [ReindexRethrottleRequest](./ReindexRethrottleRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ReindexRethrottleResponse](./ReindexRethrottleResponse.md)>; -::: +``` diff --git a/docs/reference/api/ReindexRethrottleReindexNode.md b/docs/reference/api/ReindexRethrottleReindexNode.md index 6d50d426c..2c0f3c598 100644 --- a/docs/reference/api/ReindexRethrottleReindexNode.md +++ b/docs/reference/api/ReindexRethrottleReindexNode.md @@ -1,4 +1,4 @@ -## Interface `ReindexRethrottleReindexNode` +# `ReindexRethrottleReindexNode` [interface-ReindexRethrottleReindexNode] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ReindexRethrottleReindexStatus.md b/docs/reference/api/ReindexRethrottleReindexStatus.md index 9b833afd4..856b041ea 100644 --- a/docs/reference/api/ReindexRethrottleReindexStatus.md +++ b/docs/reference/api/ReindexRethrottleReindexStatus.md @@ -1,4 +1,4 @@ -## Interface `ReindexRethrottleReindexStatus` +# `ReindexRethrottleReindexStatus` [interface-ReindexRethrottleReindexStatus] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ReindexRethrottleReindexTask.md b/docs/reference/api/ReindexRethrottleReindexTask.md index 53c6aa273..6b6bccd13 100644 --- a/docs/reference/api/ReindexRethrottleReindexTask.md +++ b/docs/reference/api/ReindexRethrottleReindexTask.md @@ -1,4 +1,4 @@ -## Interface `ReindexRethrottleReindexTask` +# `ReindexRethrottleReindexTask` [interface-ReindexRethrottleReindexTask] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ReindexRethrottleRequest.md b/docs/reference/api/ReindexRethrottleRequest.md index 177d976ac..70639d3f8 100644 --- a/docs/reference/api/ReindexRethrottleRequest.md +++ b/docs/reference/api/ReindexRethrottleRequest.md @@ -1,4 +1,4 @@ -## Interface `ReindexRethrottleRequest` +# `ReindexRethrottleRequest` [interface-ReindexRethrottleRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ReindexRethrottleResponse.md b/docs/reference/api/ReindexRethrottleResponse.md index 6df0ab4c5..7a14f6370 100644 --- a/docs/reference/api/ReindexRethrottleResponse.md +++ b/docs/reference/api/ReindexRethrottleResponse.md @@ -1,4 +1,4 @@ -## Interface `ReindexRethrottleResponse` +# `ReindexRethrottleResponse` [interface-ReindexRethrottleResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ReindexSource.md b/docs/reference/api/ReindexSource.md index 6ae864190..9b06533a4 100644 --- a/docs/reference/api/ReindexSource.md +++ b/docs/reference/api/ReindexSource.md @@ -1,4 +1,4 @@ -## Interface `ReindexSource` +# `ReindexSource` [interface-ReindexSource] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/RelationName.md b/docs/reference/api/RelationName.md index c04c77153..131676169 100644 --- a/docs/reference/api/RelationName.md +++ b/docs/reference/api/RelationName.md @@ -1,4 +1,4 @@ -## `RelationName` -::: +# `RelationName` [alias-RelationName] +```typescript type RelationName = string; -::: +``` diff --git a/docs/reference/api/RelocationFailureInfo.md b/docs/reference/api/RelocationFailureInfo.md index 150e29133..c5a171dc2 100644 --- a/docs/reference/api/RelocationFailureInfo.md +++ b/docs/reference/api/RelocationFailureInfo.md @@ -1,4 +1,4 @@ -## Interface `RelocationFailureInfo` +# `RelocationFailureInfo` [interface-RelocationFailureInfo] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/RenderSearchTemplateApi_1.md b/docs/reference/api/RenderSearchTemplateApi_1.md index 46620b99e..aee255fc5 100644 --- a/docs/reference/api/RenderSearchTemplateApi_1.md +++ b/docs/reference/api/RenderSearchTemplateApi_1.md @@ -1,3 +1,3 @@ -::: +```typescript default function RenderSearchTemplateApi(this: [That](./That.md), params?: [RenderSearchTemplateRequest](./RenderSearchTemplateRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[RenderSearchTemplateResponse](./RenderSearchTemplateResponse.md)>; -::: +``` diff --git a/docs/reference/api/RenderSearchTemplateApi_2.md b/docs/reference/api/RenderSearchTemplateApi_2.md index 80dfa495b..fa2f3f28f 100644 --- a/docs/reference/api/RenderSearchTemplateApi_2.md +++ b/docs/reference/api/RenderSearchTemplateApi_2.md @@ -1,3 +1,3 @@ -::: +```typescript default function RenderSearchTemplateApi(this: [That](./That.md), params?: [RenderSearchTemplateRequest](./RenderSearchTemplateRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[RenderSearchTemplateResponse](./RenderSearchTemplateResponse.md), unknown>>; -::: +``` diff --git a/docs/reference/api/RenderSearchTemplateApi_3.md b/docs/reference/api/RenderSearchTemplateApi_3.md index 37c59138f..fea60e3b9 100644 --- a/docs/reference/api/RenderSearchTemplateApi_3.md +++ b/docs/reference/api/RenderSearchTemplateApi_3.md @@ -1,3 +1,3 @@ -::: +```typescript default function RenderSearchTemplateApi(this: [That](./That.md), params?: [RenderSearchTemplateRequest](./RenderSearchTemplateRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[RenderSearchTemplateResponse](./RenderSearchTemplateResponse.md)>; -::: +``` diff --git a/docs/reference/api/RenderSearchTemplateRequest.md b/docs/reference/api/RenderSearchTemplateRequest.md index 89bed0044..af1c1b8d5 100644 --- a/docs/reference/api/RenderSearchTemplateRequest.md +++ b/docs/reference/api/RenderSearchTemplateRequest.md @@ -1,4 +1,4 @@ -## Interface `RenderSearchTemplateRequest` +# `RenderSearchTemplateRequest` [interface-RenderSearchTemplateRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/RenderSearchTemplateResponse.md b/docs/reference/api/RenderSearchTemplateResponse.md index 219884ab8..54d09b6bc 100644 --- a/docs/reference/api/RenderSearchTemplateResponse.md +++ b/docs/reference/api/RenderSearchTemplateResponse.md @@ -1,4 +1,4 @@ -## Interface `RenderSearchTemplateResponse` +# `RenderSearchTemplateResponse` [interface-RenderSearchTemplateResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/RequestBase.md b/docs/reference/api/RequestBase.md index 6c0299267..26743e4f2 100644 --- a/docs/reference/api/RequestBase.md +++ b/docs/reference/api/RequestBase.md @@ -1,4 +1,4 @@ -## Interface `RequestBase` +# `RequestBase` [interface-RequestBase] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/RequestCacheStats.md b/docs/reference/api/RequestCacheStats.md index 6753290e1..bc164eac3 100644 --- a/docs/reference/api/RequestCacheStats.md +++ b/docs/reference/api/RequestCacheStats.md @@ -1,4 +1,4 @@ -## Interface `RequestCacheStats` +# `RequestCacheStats` [interface-RequestCacheStats] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/RescoreVector.md b/docs/reference/api/RescoreVector.md index be1672257..eeb5ac9b3 100644 --- a/docs/reference/api/RescoreVector.md +++ b/docs/reference/api/RescoreVector.md @@ -1,4 +1,4 @@ -## Interface `RescoreVector` +# `RescoreVector` [interface-RescoreVector] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/Result.md b/docs/reference/api/Result.md index 7ff4fadb5..dfa92d31f 100644 --- a/docs/reference/api/Result.md +++ b/docs/reference/api/Result.md @@ -1,4 +1,4 @@ -## `Result` -::: +# `Result` [alias-Result] +```typescript type Result = 'created' | 'updated' | 'deleted' | 'not_found' | 'noop'; -::: +``` diff --git a/docs/reference/api/Retries.md b/docs/reference/api/Retries.md index 8f1ee791b..94588c533 100644 --- a/docs/reference/api/Retries.md +++ b/docs/reference/api/Retries.md @@ -1,4 +1,4 @@ -## Interface `Retries` +# `Retries` [interface-Retries] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/RetrieverBase.md b/docs/reference/api/RetrieverBase.md index 4df96dfd6..b5ddcae55 100644 --- a/docs/reference/api/RetrieverBase.md +++ b/docs/reference/api/RetrieverBase.md @@ -1,4 +1,4 @@ -## Interface `RetrieverBase` +# `RetrieverBase` [interface-RetrieverBase] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/RetrieverContainer.md b/docs/reference/api/RetrieverContainer.md index a28685cb4..55a56f084 100644 --- a/docs/reference/api/RetrieverContainer.md +++ b/docs/reference/api/RetrieverContainer.md @@ -1,4 +1,4 @@ -## Interface `RetrieverContainer` +# `RetrieverContainer` [interface-RetrieverContainer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/Rollup.md b/docs/reference/api/Rollup.md index 7ebedc3e7..2ef910cb7 100644 --- a/docs/reference/api/Rollup.md +++ b/docs/reference/api/Rollup.md @@ -1,19 +1,19 @@ -## `Rollup` +# `Rollup` [class-Rollup] -### Constructor +## Constructor -::: +```typescript new Rollup(transport: [Transport](./Transport.md)); -::: +``` -### Properties +## Properties [class-properties-Rollup] | Name | Type | Description | | - | - | - | | `acceptedParams` | Record |   | | `transport` | [Transport](./Transport.md) |   | -### Methods +## Methods [class-methods-Rollup] | Name | Signature | Description | | - | - | - | diff --git a/docs/reference/api/RollupDateHistogramGrouping.md b/docs/reference/api/RollupDateHistogramGrouping.md index e33b9afd4..7507491b5 100644 --- a/docs/reference/api/RollupDateHistogramGrouping.md +++ b/docs/reference/api/RollupDateHistogramGrouping.md @@ -1,4 +1,4 @@ -## Interface `RollupDateHistogramGrouping` +# `RollupDateHistogramGrouping` [interface-RollupDateHistogramGrouping] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/RollupDeleteJobRequest.md b/docs/reference/api/RollupDeleteJobRequest.md index 1e08bfe76..f1e12a440 100644 --- a/docs/reference/api/RollupDeleteJobRequest.md +++ b/docs/reference/api/RollupDeleteJobRequest.md @@ -1,4 +1,4 @@ -## Interface `RollupDeleteJobRequest` +# `RollupDeleteJobRequest` [interface-RollupDeleteJobRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/RollupDeleteJobResponse.md b/docs/reference/api/RollupDeleteJobResponse.md index 153348452..7f04113bf 100644 --- a/docs/reference/api/RollupDeleteJobResponse.md +++ b/docs/reference/api/RollupDeleteJobResponse.md @@ -1,4 +1,4 @@ -## Interface `RollupDeleteJobResponse` +# `RollupDeleteJobResponse` [interface-RollupDeleteJobResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/RollupFieldMetric.md b/docs/reference/api/RollupFieldMetric.md index e188abe59..4de8c50b7 100644 --- a/docs/reference/api/RollupFieldMetric.md +++ b/docs/reference/api/RollupFieldMetric.md @@ -1,4 +1,4 @@ -## Interface `RollupFieldMetric` +# `RollupFieldMetric` [interface-RollupFieldMetric] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/RollupGetJobsIndexingJobState.md b/docs/reference/api/RollupGetJobsIndexingJobState.md index d47ede937..827f86977 100644 --- a/docs/reference/api/RollupGetJobsIndexingJobState.md +++ b/docs/reference/api/RollupGetJobsIndexingJobState.md @@ -1,4 +1,4 @@ -## `RollupGetJobsIndexingJobState` -::: +# `RollupGetJobsIndexingJobState` [alias-RollupGetJobsIndexingJobState] +```typescript type RollupGetJobsIndexingJobState = 'started' | 'indexing' | 'stopping' | 'stopped' | 'aborting'; -::: +``` diff --git a/docs/reference/api/RollupGetJobsRequest.md b/docs/reference/api/RollupGetJobsRequest.md index e2139f7c4..4307a991b 100644 --- a/docs/reference/api/RollupGetJobsRequest.md +++ b/docs/reference/api/RollupGetJobsRequest.md @@ -1,4 +1,4 @@ -## Interface `RollupGetJobsRequest` +# `RollupGetJobsRequest` [interface-RollupGetJobsRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/RollupGetJobsResponse.md b/docs/reference/api/RollupGetJobsResponse.md index 59cba3cb2..a8b07b84a 100644 --- a/docs/reference/api/RollupGetJobsResponse.md +++ b/docs/reference/api/RollupGetJobsResponse.md @@ -1,4 +1,4 @@ -## Interface `RollupGetJobsResponse` +# `RollupGetJobsResponse` [interface-RollupGetJobsResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/RollupGetJobsRollupJob.md b/docs/reference/api/RollupGetJobsRollupJob.md index 8a1d0ba1d..bbdcb30b1 100644 --- a/docs/reference/api/RollupGetJobsRollupJob.md +++ b/docs/reference/api/RollupGetJobsRollupJob.md @@ -1,4 +1,4 @@ -## Interface `RollupGetJobsRollupJob` +# `RollupGetJobsRollupJob` [interface-RollupGetJobsRollupJob] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/RollupGetJobsRollupJobConfiguration.md b/docs/reference/api/RollupGetJobsRollupJobConfiguration.md index 972e99767..d05836a0f 100644 --- a/docs/reference/api/RollupGetJobsRollupJobConfiguration.md +++ b/docs/reference/api/RollupGetJobsRollupJobConfiguration.md @@ -1,4 +1,4 @@ -## Interface `RollupGetJobsRollupJobConfiguration` +# `RollupGetJobsRollupJobConfiguration` [interface-RollupGetJobsRollupJobConfiguration] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/RollupGetJobsRollupJobStats.md b/docs/reference/api/RollupGetJobsRollupJobStats.md index 76248fa62..70f9d0d62 100644 --- a/docs/reference/api/RollupGetJobsRollupJobStats.md +++ b/docs/reference/api/RollupGetJobsRollupJobStats.md @@ -1,4 +1,4 @@ -## Interface `RollupGetJobsRollupJobStats` +# `RollupGetJobsRollupJobStats` [interface-RollupGetJobsRollupJobStats] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/RollupGetJobsRollupJobStatus.md b/docs/reference/api/RollupGetJobsRollupJobStatus.md index 72020dacd..2fcb71bf7 100644 --- a/docs/reference/api/RollupGetJobsRollupJobStatus.md +++ b/docs/reference/api/RollupGetJobsRollupJobStatus.md @@ -1,4 +1,4 @@ -## Interface `RollupGetJobsRollupJobStatus` +# `RollupGetJobsRollupJobStatus` [interface-RollupGetJobsRollupJobStatus] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/RollupGetRollupCapsRequest.md b/docs/reference/api/RollupGetRollupCapsRequest.md index 5046d3fc5..d86af7a12 100644 --- a/docs/reference/api/RollupGetRollupCapsRequest.md +++ b/docs/reference/api/RollupGetRollupCapsRequest.md @@ -1,4 +1,4 @@ -## Interface `RollupGetRollupCapsRequest` +# `RollupGetRollupCapsRequest` [interface-RollupGetRollupCapsRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/RollupGetRollupCapsResponse.md b/docs/reference/api/RollupGetRollupCapsResponse.md index 98f5e5004..6e2d398b9 100644 --- a/docs/reference/api/RollupGetRollupCapsResponse.md +++ b/docs/reference/api/RollupGetRollupCapsResponse.md @@ -1,4 +1,4 @@ -## `RollupGetRollupCapsResponse` -::: +# `RollupGetRollupCapsResponse` [alias-RollupGetRollupCapsResponse] +```typescript type RollupGetRollupCapsResponse = Record<[IndexName](./IndexName.md), [RollupGetRollupCapsRollupCapabilities](./RollupGetRollupCapsRollupCapabilities.md)>; -::: +``` diff --git a/docs/reference/api/RollupGetRollupCapsRollupCapabilities.md b/docs/reference/api/RollupGetRollupCapsRollupCapabilities.md index 029a771bd..d26961d8e 100644 --- a/docs/reference/api/RollupGetRollupCapsRollupCapabilities.md +++ b/docs/reference/api/RollupGetRollupCapsRollupCapabilities.md @@ -1,4 +1,4 @@ -## Interface `RollupGetRollupCapsRollupCapabilities` +# `RollupGetRollupCapsRollupCapabilities` [interface-RollupGetRollupCapsRollupCapabilities] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/RollupGetRollupCapsRollupCapabilitySummary.md b/docs/reference/api/RollupGetRollupCapsRollupCapabilitySummary.md index 17299005e..fd5134cc7 100644 --- a/docs/reference/api/RollupGetRollupCapsRollupCapabilitySummary.md +++ b/docs/reference/api/RollupGetRollupCapsRollupCapabilitySummary.md @@ -1,4 +1,4 @@ -## Interface `RollupGetRollupCapsRollupCapabilitySummary` +# `RollupGetRollupCapsRollupCapabilitySummary` [interface-RollupGetRollupCapsRollupCapabilitySummary] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/RollupGetRollupCapsRollupFieldSummary.md b/docs/reference/api/RollupGetRollupCapsRollupFieldSummary.md index 30eae0886..a50ed712a 100644 --- a/docs/reference/api/RollupGetRollupCapsRollupFieldSummary.md +++ b/docs/reference/api/RollupGetRollupCapsRollupFieldSummary.md @@ -1,4 +1,4 @@ -## Interface `RollupGetRollupCapsRollupFieldSummary` +# `RollupGetRollupCapsRollupFieldSummary` [interface-RollupGetRollupCapsRollupFieldSummary] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/RollupGetRollupIndexCapsIndexCapabilities.md b/docs/reference/api/RollupGetRollupIndexCapsIndexCapabilities.md index ce1428cbe..61045fb03 100644 --- a/docs/reference/api/RollupGetRollupIndexCapsIndexCapabilities.md +++ b/docs/reference/api/RollupGetRollupIndexCapsIndexCapabilities.md @@ -1,4 +1,4 @@ -## Interface `RollupGetRollupIndexCapsIndexCapabilities` +# `RollupGetRollupIndexCapsIndexCapabilities` [interface-RollupGetRollupIndexCapsIndexCapabilities] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/RollupGetRollupIndexCapsRequest.md b/docs/reference/api/RollupGetRollupIndexCapsRequest.md index 6115c4643..6773dd580 100644 --- a/docs/reference/api/RollupGetRollupIndexCapsRequest.md +++ b/docs/reference/api/RollupGetRollupIndexCapsRequest.md @@ -1,4 +1,4 @@ -## Interface `RollupGetRollupIndexCapsRequest` +# `RollupGetRollupIndexCapsRequest` [interface-RollupGetRollupIndexCapsRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/RollupGetRollupIndexCapsResponse.md b/docs/reference/api/RollupGetRollupIndexCapsResponse.md index 19c5dcde0..144c1c423 100644 --- a/docs/reference/api/RollupGetRollupIndexCapsResponse.md +++ b/docs/reference/api/RollupGetRollupIndexCapsResponse.md @@ -1,4 +1,4 @@ -## `RollupGetRollupIndexCapsResponse` -::: +# `RollupGetRollupIndexCapsResponse` [alias-RollupGetRollupIndexCapsResponse] +```typescript type RollupGetRollupIndexCapsResponse = Record<[IndexName](./IndexName.md), [RollupGetRollupIndexCapsIndexCapabilities](./RollupGetRollupIndexCapsIndexCapabilities.md)>; -::: +``` diff --git a/docs/reference/api/RollupGetRollupIndexCapsRollupJobSummary.md b/docs/reference/api/RollupGetRollupIndexCapsRollupJobSummary.md index c099af645..fed935df2 100644 --- a/docs/reference/api/RollupGetRollupIndexCapsRollupJobSummary.md +++ b/docs/reference/api/RollupGetRollupIndexCapsRollupJobSummary.md @@ -1,4 +1,4 @@ -## Interface `RollupGetRollupIndexCapsRollupJobSummary` +# `RollupGetRollupIndexCapsRollupJobSummary` [interface-RollupGetRollupIndexCapsRollupJobSummary] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/RollupGetRollupIndexCapsRollupJobSummaryField.md b/docs/reference/api/RollupGetRollupIndexCapsRollupJobSummaryField.md index c8d29618d..09c5d5e59 100644 --- a/docs/reference/api/RollupGetRollupIndexCapsRollupJobSummaryField.md +++ b/docs/reference/api/RollupGetRollupIndexCapsRollupJobSummaryField.md @@ -1,4 +1,4 @@ -## Interface `RollupGetRollupIndexCapsRollupJobSummaryField` +# `RollupGetRollupIndexCapsRollupJobSummaryField` [interface-RollupGetRollupIndexCapsRollupJobSummaryField] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/RollupGroupings.md b/docs/reference/api/RollupGroupings.md index bd8fa2431..0e2859326 100644 --- a/docs/reference/api/RollupGroupings.md +++ b/docs/reference/api/RollupGroupings.md @@ -1,4 +1,4 @@ -## Interface `RollupGroupings` +# `RollupGroupings` [interface-RollupGroupings] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/RollupHistogramGrouping.md b/docs/reference/api/RollupHistogramGrouping.md index 415414099..736bad564 100644 --- a/docs/reference/api/RollupHistogramGrouping.md +++ b/docs/reference/api/RollupHistogramGrouping.md @@ -1,4 +1,4 @@ -## Interface `RollupHistogramGrouping` +# `RollupHistogramGrouping` [interface-RollupHistogramGrouping] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/RollupMetric.md b/docs/reference/api/RollupMetric.md index 7d781a37a..5740e7350 100644 --- a/docs/reference/api/RollupMetric.md +++ b/docs/reference/api/RollupMetric.md @@ -1,4 +1,4 @@ -## `RollupMetric` -::: +# `RollupMetric` [alias-RollupMetric] +```typescript type RollupMetric = 'min' | 'max' | 'sum' | 'avg' | 'value_count'; -::: +``` diff --git a/docs/reference/api/RollupPutJobRequest.md b/docs/reference/api/RollupPutJobRequest.md index d2c53155e..3dab8f2dc 100644 --- a/docs/reference/api/RollupPutJobRequest.md +++ b/docs/reference/api/RollupPutJobRequest.md @@ -1,4 +1,4 @@ -## Interface `RollupPutJobRequest` +# `RollupPutJobRequest` [interface-RollupPutJobRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/RollupPutJobResponse.md b/docs/reference/api/RollupPutJobResponse.md index 62ebad45e..ad812ecd2 100644 --- a/docs/reference/api/RollupPutJobResponse.md +++ b/docs/reference/api/RollupPutJobResponse.md @@ -1,4 +1,4 @@ -## `RollupPutJobResponse` -::: +# `RollupPutJobResponse` [alias-RollupPutJobResponse] +```typescript type RollupPutJobResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); -::: +``` diff --git a/docs/reference/api/RollupRollupSearchRequest.md b/docs/reference/api/RollupRollupSearchRequest.md index b3b22a146..c83c92a9d 100644 --- a/docs/reference/api/RollupRollupSearchRequest.md +++ b/docs/reference/api/RollupRollupSearchRequest.md @@ -1,4 +1,4 @@ -## Interface `RollupRollupSearchRequest` +# `RollupRollupSearchRequest` [interface-RollupRollupSearchRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/RollupRollupSearchResponse.md b/docs/reference/api/RollupRollupSearchResponse.md index 8869fde81..bdba8727a 100644 --- a/docs/reference/api/RollupRollupSearchResponse.md +++ b/docs/reference/api/RollupRollupSearchResponse.md @@ -1,4 +1,4 @@ -## Interface `RollupRollupSearchResponse` +# `RollupRollupSearchResponse` [interface-RollupRollupSearchResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/RollupStartJobRequest.md b/docs/reference/api/RollupStartJobRequest.md index c06fe5fd4..2acd9a4b5 100644 --- a/docs/reference/api/RollupStartJobRequest.md +++ b/docs/reference/api/RollupStartJobRequest.md @@ -1,4 +1,4 @@ -## Interface `RollupStartJobRequest` +# `RollupStartJobRequest` [interface-RollupStartJobRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/RollupStartJobResponse.md b/docs/reference/api/RollupStartJobResponse.md index 09e61ed4c..34536eec8 100644 --- a/docs/reference/api/RollupStartJobResponse.md +++ b/docs/reference/api/RollupStartJobResponse.md @@ -1,4 +1,4 @@ -## Interface `RollupStartJobResponse` +# `RollupStartJobResponse` [interface-RollupStartJobResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/RollupStopJobRequest.md b/docs/reference/api/RollupStopJobRequest.md index 63dc522e8..755ce542c 100644 --- a/docs/reference/api/RollupStopJobRequest.md +++ b/docs/reference/api/RollupStopJobRequest.md @@ -1,4 +1,4 @@ -## Interface `RollupStopJobRequest` +# `RollupStopJobRequest` [interface-RollupStopJobRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/RollupStopJobResponse.md b/docs/reference/api/RollupStopJobResponse.md index 41be43cb2..0140aff42 100644 --- a/docs/reference/api/RollupStopJobResponse.md +++ b/docs/reference/api/RollupStopJobResponse.md @@ -1,4 +1,4 @@ -## Interface `RollupStopJobResponse` +# `RollupStopJobResponse` [interface-RollupStopJobResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/RollupTermsGrouping.md b/docs/reference/api/RollupTermsGrouping.md index fff4c05c4..1f8b93783 100644 --- a/docs/reference/api/RollupTermsGrouping.md +++ b/docs/reference/api/RollupTermsGrouping.md @@ -1,4 +1,4 @@ -## Interface `RollupTermsGrouping` +# `RollupTermsGrouping` [interface-RollupTermsGrouping] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/Routing.md b/docs/reference/api/Routing.md index 2763e2e25..6cf094dbf 100644 --- a/docs/reference/api/Routing.md +++ b/docs/reference/api/Routing.md @@ -1,4 +1,4 @@ -## `Routing` -::: +# `Routing` [alias-Routing] +```typescript type Routing = string; -::: +``` diff --git a/docs/reference/api/RrfRank.md b/docs/reference/api/RrfRank.md index c6bf05664..c1b0b90ab 100644 --- a/docs/reference/api/RrfRank.md +++ b/docs/reference/api/RrfRank.md @@ -1,4 +1,4 @@ -## Interface `RrfRank` +# `RrfRank` [interface-RrfRank] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/RuleRetriever.md b/docs/reference/api/RuleRetriever.md index 631fe809a..de28e52bf 100644 --- a/docs/reference/api/RuleRetriever.md +++ b/docs/reference/api/RuleRetriever.md @@ -1,4 +1,4 @@ -## Interface `RuleRetriever` +# `RuleRetriever` [interface-RuleRetriever] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ScalarValue.md b/docs/reference/api/ScalarValue.md index 0cc4ae095..5b9e9f0d6 100644 --- a/docs/reference/api/ScalarValue.md +++ b/docs/reference/api/ScalarValue.md @@ -1,4 +1,4 @@ -## `ScalarValue` -::: +# `ScalarValue` [alias-ScalarValue] +```typescript type ScalarValue = [long](./long.md) | [double](./double.md) | string | boolean | null; -::: +``` diff --git a/docs/reference/api/ScoreSort.md b/docs/reference/api/ScoreSort.md index 0d08e54c1..b2982a63d 100644 --- a/docs/reference/api/ScoreSort.md +++ b/docs/reference/api/ScoreSort.md @@ -1,4 +1,4 @@ -## Interface `ScoreSort` +# `ScoreSort` [interface-ScoreSort] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/Script.md b/docs/reference/api/Script.md index af74d9ecd..ee6790574 100644 --- a/docs/reference/api/Script.md +++ b/docs/reference/api/Script.md @@ -1,4 +1,4 @@ -## Interface `Script` +# `Script` [interface-Script] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ScriptField.md b/docs/reference/api/ScriptField.md index ce56a4b72..a73e33eaa 100644 --- a/docs/reference/api/ScriptField.md +++ b/docs/reference/api/ScriptField.md @@ -1,4 +1,4 @@ -## Interface `ScriptField` +# `ScriptField` [interface-ScriptField] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ScriptLanguage.md b/docs/reference/api/ScriptLanguage.md index 444bef409..534dea727 100644 --- a/docs/reference/api/ScriptLanguage.md +++ b/docs/reference/api/ScriptLanguage.md @@ -1,4 +1,4 @@ -## `ScriptLanguage` -::: +# `ScriptLanguage` [alias-ScriptLanguage] +```typescript type ScriptLanguage = 'painless' | 'expression' | 'mustache' | 'java' | string; -::: +``` diff --git a/docs/reference/api/ScriptSort.md b/docs/reference/api/ScriptSort.md index 3317ab5e9..9e70e8fa5 100644 --- a/docs/reference/api/ScriptSort.md +++ b/docs/reference/api/ScriptSort.md @@ -1,4 +1,4 @@ -## Interface `ScriptSort` +# `ScriptSort` [interface-ScriptSort] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ScriptSortType.md b/docs/reference/api/ScriptSortType.md index fcdf9652f..96c607c85 100644 --- a/docs/reference/api/ScriptSortType.md +++ b/docs/reference/api/ScriptSortType.md @@ -1,4 +1,4 @@ -## `ScriptSortType` -::: +# `ScriptSortType` [alias-ScriptSortType] +```typescript type ScriptSortType = 'string' | 'number' | 'version'; -::: +``` diff --git a/docs/reference/api/ScriptSource.md b/docs/reference/api/ScriptSource.md index 248d12381..0800c96c6 100644 --- a/docs/reference/api/ScriptSource.md +++ b/docs/reference/api/ScriptSource.md @@ -1,4 +1,4 @@ -## `ScriptSource` -::: +# `ScriptSource` [alias-ScriptSource] +```typescript type ScriptSource = string | [SearchSearchRequestBody](./SearchSearchRequestBody.md); -::: +``` diff --git a/docs/reference/api/ScriptTransform.md b/docs/reference/api/ScriptTransform.md index a294948ea..d643a696c 100644 --- a/docs/reference/api/ScriptTransform.md +++ b/docs/reference/api/ScriptTransform.md @@ -1,4 +1,4 @@ -## Interface `ScriptTransform` +# `ScriptTransform` [interface-ScriptTransform] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ScriptsPainlessExecuteApi_1.md b/docs/reference/api/ScriptsPainlessExecuteApi_1.md index f69d9565f..28ccbb8e4 100644 --- a/docs/reference/api/ScriptsPainlessExecuteApi_1.md +++ b/docs/reference/api/ScriptsPainlessExecuteApi_1.md @@ -1,3 +1,3 @@ -::: +```typescript default function ScriptsPainlessExecuteApi(this: [That](./That.md), params?: [ScriptsPainlessExecuteRequest](./ScriptsPainlessExecuteRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ScriptsPainlessExecuteResponse](./ScriptsPainlessExecuteResponse.md)>; -::: +``` diff --git a/docs/reference/api/ScriptsPainlessExecuteApi_2.md b/docs/reference/api/ScriptsPainlessExecuteApi_2.md index fd1728ee1..fd6a3e7b9 100644 --- a/docs/reference/api/ScriptsPainlessExecuteApi_2.md +++ b/docs/reference/api/ScriptsPainlessExecuteApi_2.md @@ -1,3 +1,3 @@ -::: +```typescript default function ScriptsPainlessExecuteApi(this: [That](./That.md), params?: [ScriptsPainlessExecuteRequest](./ScriptsPainlessExecuteRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ScriptsPainlessExecuteResponse](./ScriptsPainlessExecuteResponse.md), unknown>>; -::: +``` diff --git a/docs/reference/api/ScriptsPainlessExecuteApi_3.md b/docs/reference/api/ScriptsPainlessExecuteApi_3.md index 9761c3e8f..5965883a0 100644 --- a/docs/reference/api/ScriptsPainlessExecuteApi_3.md +++ b/docs/reference/api/ScriptsPainlessExecuteApi_3.md @@ -1,3 +1,3 @@ -::: +```typescript default function ScriptsPainlessExecuteApi(this: [That](./That.md), params?: [ScriptsPainlessExecuteRequest](./ScriptsPainlessExecuteRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ScriptsPainlessExecuteResponse](./ScriptsPainlessExecuteResponse.md)>; -::: +``` diff --git a/docs/reference/api/ScriptsPainlessExecutePainlessContext.md b/docs/reference/api/ScriptsPainlessExecutePainlessContext.md index 63b75fc17..7ea37c5f1 100644 --- a/docs/reference/api/ScriptsPainlessExecutePainlessContext.md +++ b/docs/reference/api/ScriptsPainlessExecutePainlessContext.md @@ -1,4 +1,4 @@ -## `ScriptsPainlessExecutePainlessContext` -::: +# `ScriptsPainlessExecutePainlessContext` [alias-ScriptsPainlessExecutePainlessContext] +```typescript type ScriptsPainlessExecutePainlessContext = 'painless_test' | 'filter' | 'score' | 'boolean_field' | 'date_field' | 'double_field' | 'geo_point_field' | 'ip_field' | 'keyword_field' | 'long_field' | 'composite_field'; -::: +``` diff --git a/docs/reference/api/ScriptsPainlessExecutePainlessContextSetup.md b/docs/reference/api/ScriptsPainlessExecutePainlessContextSetup.md index 76da5a50d..8a0e5c437 100644 --- a/docs/reference/api/ScriptsPainlessExecutePainlessContextSetup.md +++ b/docs/reference/api/ScriptsPainlessExecutePainlessContextSetup.md @@ -1,4 +1,4 @@ -## Interface `ScriptsPainlessExecutePainlessContextSetup` +# `ScriptsPainlessExecutePainlessContextSetup` [interface-ScriptsPainlessExecutePainlessContextSetup] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ScriptsPainlessExecuteRequest.md b/docs/reference/api/ScriptsPainlessExecuteRequest.md index 44b6e96f7..6066af509 100644 --- a/docs/reference/api/ScriptsPainlessExecuteRequest.md +++ b/docs/reference/api/ScriptsPainlessExecuteRequest.md @@ -1,4 +1,4 @@ -## Interface `ScriptsPainlessExecuteRequest` +# `ScriptsPainlessExecuteRequest` [interface-ScriptsPainlessExecuteRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ScriptsPainlessExecuteResponse.md b/docs/reference/api/ScriptsPainlessExecuteResponse.md index e5f313c12..77f443a63 100644 --- a/docs/reference/api/ScriptsPainlessExecuteResponse.md +++ b/docs/reference/api/ScriptsPainlessExecuteResponse.md @@ -1,4 +1,4 @@ -## Interface `ScriptsPainlessExecuteResponse` +# `ScriptsPainlessExecuteResponse` [interface-ScriptsPainlessExecuteResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ScrollApi_1.md b/docs/reference/api/ScrollApi_1.md index c7764e66e..9f73061e8 100644 --- a/docs/reference/api/ScrollApi_1.md +++ b/docs/reference/api/ScrollApi_1.md @@ -1,3 +1,3 @@ -::: +```typescript default function ScrollApi>(this: [That](./That.md), params: [ScrollRequest](./ScrollRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ScrollResponse](./ScrollResponse.md)>; -::: +``` diff --git a/docs/reference/api/ScrollApi_2.md b/docs/reference/api/ScrollApi_2.md index b9281ca42..f40caea8b 100644 --- a/docs/reference/api/ScrollApi_2.md +++ b/docs/reference/api/ScrollApi_2.md @@ -1,3 +1,3 @@ -::: +```typescript default function ScrollApi>(this: [That](./That.md), params: [ScrollRequest](./ScrollRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ScrollResponse](./ScrollResponse.md), unknown>>; -::: +``` diff --git a/docs/reference/api/ScrollApi_3.md b/docs/reference/api/ScrollApi_3.md index 93fca7cb0..2a2f9340b 100644 --- a/docs/reference/api/ScrollApi_3.md +++ b/docs/reference/api/ScrollApi_3.md @@ -1,3 +1,3 @@ -::: +```typescript default function ScrollApi>(this: [That](./That.md), params: [ScrollRequest](./ScrollRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ScrollResponse](./ScrollResponse.md)>; -::: +``` diff --git a/docs/reference/api/ScrollId.md b/docs/reference/api/ScrollId.md index 4914d7480..04a12e4db 100644 --- a/docs/reference/api/ScrollId.md +++ b/docs/reference/api/ScrollId.md @@ -1,4 +1,4 @@ -## `ScrollId` -::: +# `ScrollId` [alias-ScrollId] +```typescript type ScrollId = string; -::: +``` diff --git a/docs/reference/api/ScrollIds.md b/docs/reference/api/ScrollIds.md index cf0b2417e..118dcd7e9 100644 --- a/docs/reference/api/ScrollIds.md +++ b/docs/reference/api/ScrollIds.md @@ -1,4 +1,4 @@ -## `ScrollIds` -::: +# `ScrollIds` [alias-ScrollIds] +```typescript type ScrollIds = [ScrollId](./ScrollId.md) | [ScrollId](./ScrollId.md)[]; -::: +``` diff --git a/docs/reference/api/ScrollRequest.md b/docs/reference/api/ScrollRequest.md index 833f2fbcf..58d751f9f 100644 --- a/docs/reference/api/ScrollRequest.md +++ b/docs/reference/api/ScrollRequest.md @@ -1,4 +1,4 @@ -## Interface `ScrollRequest` +# `ScrollRequest` [interface-ScrollRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ScrollResponse.md b/docs/reference/api/ScrollResponse.md index 57051cc68..a8094c1a1 100644 --- a/docs/reference/api/ScrollResponse.md +++ b/docs/reference/api/ScrollResponse.md @@ -1,4 +1,4 @@ -## `ScrollResponse` -::: +# `ScrollResponse` [alias-ScrollResponse] +```typescript type ScrollResponse> = [SearchResponseBody](./SearchResponseBody.md); -::: +``` diff --git a/docs/reference/api/ScrollSearchOptions.md b/docs/reference/api/ScrollSearchOptions.md index 0753471b2..d626bc575 100644 --- a/docs/reference/api/ScrollSearchOptions.md +++ b/docs/reference/api/ScrollSearchOptions.md @@ -1,4 +1,4 @@ -## Interface `ScrollSearchOptions` +# `ScrollSearchOptions` [interface-ScrollSearchOptions] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ScrollSearchResponse.md b/docs/reference/api/ScrollSearchResponse.md index 2832b460f..a592e2002 100644 --- a/docs/reference/api/ScrollSearchResponse.md +++ b/docs/reference/api/ScrollSearchResponse.md @@ -1,4 +1,4 @@ -## Interface `ScrollSearchResponse` +# `ScrollSearchResponse` [interface-ScrollSearchResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchAggregationBreakdown.md b/docs/reference/api/SearchAggregationBreakdown.md index 8cc5e9f79..bf3b18161 100644 --- a/docs/reference/api/SearchAggregationBreakdown.md +++ b/docs/reference/api/SearchAggregationBreakdown.md @@ -1,4 +1,4 @@ -## Interface `SearchAggregationBreakdown` +# `SearchAggregationBreakdown` [interface-SearchAggregationBreakdown] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchAggregationProfile.md b/docs/reference/api/SearchAggregationProfile.md index b42ff5c1c..0038c693e 100644 --- a/docs/reference/api/SearchAggregationProfile.md +++ b/docs/reference/api/SearchAggregationProfile.md @@ -1,4 +1,4 @@ -## Interface `SearchAggregationProfile` +# `SearchAggregationProfile` [interface-SearchAggregationProfile] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchAggregationProfileDebug.md b/docs/reference/api/SearchAggregationProfileDebug.md index 62e04df10..f6374d6ff 100644 --- a/docs/reference/api/SearchAggregationProfileDebug.md +++ b/docs/reference/api/SearchAggregationProfileDebug.md @@ -1,4 +1,4 @@ -## Interface `SearchAggregationProfileDebug` +# `SearchAggregationProfileDebug` [interface-SearchAggregationProfileDebug] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchAggregationProfileDelegateDebugFilter.md b/docs/reference/api/SearchAggregationProfileDelegateDebugFilter.md index 8dcded6c2..e074a1553 100644 --- a/docs/reference/api/SearchAggregationProfileDelegateDebugFilter.md +++ b/docs/reference/api/SearchAggregationProfileDelegateDebugFilter.md @@ -1,4 +1,4 @@ -## Interface `SearchAggregationProfileDelegateDebugFilter` +# `SearchAggregationProfileDelegateDebugFilter` [interface-SearchAggregationProfileDelegateDebugFilter] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchApi_1.md b/docs/reference/api/SearchApi_1.md index 6563fc763..8fbe514a5 100644 --- a/docs/reference/api/SearchApi_1.md +++ b/docs/reference/api/SearchApi_1.md @@ -1,3 +1,3 @@ -::: +```typescript default function SearchApi>(this: [That](./That.md), params?: [SearchRequest](./SearchRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SearchResponse](./SearchResponse.md)>; -::: +``` diff --git a/docs/reference/api/SearchApi_2.md b/docs/reference/api/SearchApi_2.md index 0f0d5aab2..283b37d78 100644 --- a/docs/reference/api/SearchApi_2.md +++ b/docs/reference/api/SearchApi_2.md @@ -1,3 +1,3 @@ -::: +```typescript default function SearchApi>(this: [That](./That.md), params?: [SearchRequest](./SearchRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SearchResponse](./SearchResponse.md), unknown>>; -::: +``` diff --git a/docs/reference/api/SearchApi_3.md b/docs/reference/api/SearchApi_3.md index 58eb62d0e..2439be88f 100644 --- a/docs/reference/api/SearchApi_3.md +++ b/docs/reference/api/SearchApi_3.md @@ -1,3 +1,3 @@ -::: +```typescript default function SearchApi>(this: [That](./That.md), params?: [SearchRequest](./SearchRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SearchResponse](./SearchResponse.md)>; -::: +``` diff --git a/docs/reference/api/SearchApplication.md b/docs/reference/api/SearchApplication.md index e0a0e8e0f..30886ee37 100644 --- a/docs/reference/api/SearchApplication.md +++ b/docs/reference/api/SearchApplication.md @@ -1,19 +1,19 @@ -## `SearchApplication` +# `SearchApplication` [class-SearchApplication] -### Constructor +## Constructor -::: +```typescript new SearchApplication(transport: [Transport](./Transport.md)); -::: +``` -### Properties +## Properties [class-properties-SearchApplication] | Name | Type | Description | | - | - | - | | `acceptedParams` | Record |   | | `transport` | [Transport](./Transport.md) |   | -### Methods +## Methods [class-methods-SearchApplication] | Name | Signature | Description | | - | - | - | diff --git a/docs/reference/api/SearchApplicationAnalyticsCollection.md b/docs/reference/api/SearchApplicationAnalyticsCollection.md index a179b414b..980924c4e 100644 --- a/docs/reference/api/SearchApplicationAnalyticsCollection.md +++ b/docs/reference/api/SearchApplicationAnalyticsCollection.md @@ -1,4 +1,4 @@ -## Interface `SearchApplicationAnalyticsCollection` +# `SearchApplicationAnalyticsCollection` [interface-SearchApplicationAnalyticsCollection] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchApplicationDeleteBehavioralAnalyticsRequest.md b/docs/reference/api/SearchApplicationDeleteBehavioralAnalyticsRequest.md index db49dccb3..a30b15ab7 100644 --- a/docs/reference/api/SearchApplicationDeleteBehavioralAnalyticsRequest.md +++ b/docs/reference/api/SearchApplicationDeleteBehavioralAnalyticsRequest.md @@ -1,4 +1,4 @@ -## Interface `SearchApplicationDeleteBehavioralAnalyticsRequest` +# `SearchApplicationDeleteBehavioralAnalyticsRequest` [interface-SearchApplicationDeleteBehavioralAnalyticsRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchApplicationDeleteBehavioralAnalyticsResponse.md b/docs/reference/api/SearchApplicationDeleteBehavioralAnalyticsResponse.md index 073641fb6..c3e286686 100644 --- a/docs/reference/api/SearchApplicationDeleteBehavioralAnalyticsResponse.md +++ b/docs/reference/api/SearchApplicationDeleteBehavioralAnalyticsResponse.md @@ -1,4 +1,4 @@ -## `SearchApplicationDeleteBehavioralAnalyticsResponse` -::: +# `SearchApplicationDeleteBehavioralAnalyticsResponse` [alias-SearchApplicationDeleteBehavioralAnalyticsResponse] +```typescript type SearchApplicationDeleteBehavioralAnalyticsResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); -::: +``` diff --git a/docs/reference/api/SearchApplicationDeleteRequest.md b/docs/reference/api/SearchApplicationDeleteRequest.md index 3901a49d5..530a1319b 100644 --- a/docs/reference/api/SearchApplicationDeleteRequest.md +++ b/docs/reference/api/SearchApplicationDeleteRequest.md @@ -1,4 +1,4 @@ -## Interface `SearchApplicationDeleteRequest` +# `SearchApplicationDeleteRequest` [interface-SearchApplicationDeleteRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchApplicationDeleteResponse.md b/docs/reference/api/SearchApplicationDeleteResponse.md index 406e3255e..daf6813d0 100644 --- a/docs/reference/api/SearchApplicationDeleteResponse.md +++ b/docs/reference/api/SearchApplicationDeleteResponse.md @@ -1,4 +1,4 @@ -## `SearchApplicationDeleteResponse` -::: +# `SearchApplicationDeleteResponse` [alias-SearchApplicationDeleteResponse] +```typescript type SearchApplicationDeleteResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); -::: +``` diff --git a/docs/reference/api/SearchApplicationEventDataStream.md b/docs/reference/api/SearchApplicationEventDataStream.md index e7a0d32a8..a0061c058 100644 --- a/docs/reference/api/SearchApplicationEventDataStream.md +++ b/docs/reference/api/SearchApplicationEventDataStream.md @@ -1,4 +1,4 @@ -## Interface `SearchApplicationEventDataStream` +# `SearchApplicationEventDataStream` [interface-SearchApplicationEventDataStream] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchApplicationEventType.md b/docs/reference/api/SearchApplicationEventType.md index fca21ffcf..ba4591f59 100644 --- a/docs/reference/api/SearchApplicationEventType.md +++ b/docs/reference/api/SearchApplicationEventType.md @@ -1,4 +1,4 @@ -## `SearchApplicationEventType` -::: +# `SearchApplicationEventType` [alias-SearchApplicationEventType] +```typescript type SearchApplicationEventType = 'page_view' | 'search' | 'search_click'; -::: +``` diff --git a/docs/reference/api/SearchApplicationGetBehavioralAnalyticsRequest.md b/docs/reference/api/SearchApplicationGetBehavioralAnalyticsRequest.md index 69db447ac..65698885d 100644 --- a/docs/reference/api/SearchApplicationGetBehavioralAnalyticsRequest.md +++ b/docs/reference/api/SearchApplicationGetBehavioralAnalyticsRequest.md @@ -1,4 +1,4 @@ -## Interface `SearchApplicationGetBehavioralAnalyticsRequest` +# `SearchApplicationGetBehavioralAnalyticsRequest` [interface-SearchApplicationGetBehavioralAnalyticsRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchApplicationGetBehavioralAnalyticsResponse.md b/docs/reference/api/SearchApplicationGetBehavioralAnalyticsResponse.md index 63bbc41f6..6de91571b 100644 --- a/docs/reference/api/SearchApplicationGetBehavioralAnalyticsResponse.md +++ b/docs/reference/api/SearchApplicationGetBehavioralAnalyticsResponse.md @@ -1,4 +1,4 @@ -## `SearchApplicationGetBehavioralAnalyticsResponse` -::: +# `SearchApplicationGetBehavioralAnalyticsResponse` [alias-SearchApplicationGetBehavioralAnalyticsResponse] +```typescript type SearchApplicationGetBehavioralAnalyticsResponse = Record<[Name](./Name.md), [SearchApplicationAnalyticsCollection](./SearchApplicationAnalyticsCollection.md)>; -::: +``` diff --git a/docs/reference/api/SearchApplicationGetRequest.md b/docs/reference/api/SearchApplicationGetRequest.md index 2face3a9a..167eaf5d9 100644 --- a/docs/reference/api/SearchApplicationGetRequest.md +++ b/docs/reference/api/SearchApplicationGetRequest.md @@ -1,4 +1,4 @@ -## Interface `SearchApplicationGetRequest` +# `SearchApplicationGetRequest` [interface-SearchApplicationGetRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchApplicationGetResponse.md b/docs/reference/api/SearchApplicationGetResponse.md index a027c34fa..a21f3fa48 100644 --- a/docs/reference/api/SearchApplicationGetResponse.md +++ b/docs/reference/api/SearchApplicationGetResponse.md @@ -1,4 +1,4 @@ -## `SearchApplicationGetResponse` -::: +# `SearchApplicationGetResponse` [alias-SearchApplicationGetResponse] +```typescript type SearchApplicationGetResponse = [SearchApplicationSearchApplication](./SearchApplicationSearchApplication.md); -::: +``` diff --git a/docs/reference/api/SearchApplicationListRequest.md b/docs/reference/api/SearchApplicationListRequest.md index 962b25712..ded41a1ed 100644 --- a/docs/reference/api/SearchApplicationListRequest.md +++ b/docs/reference/api/SearchApplicationListRequest.md @@ -1,4 +1,4 @@ -## Interface `SearchApplicationListRequest` +# `SearchApplicationListRequest` [interface-SearchApplicationListRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchApplicationListResponse.md b/docs/reference/api/SearchApplicationListResponse.md index c91707383..9d6b981f8 100644 --- a/docs/reference/api/SearchApplicationListResponse.md +++ b/docs/reference/api/SearchApplicationListResponse.md @@ -1,4 +1,4 @@ -## Interface `SearchApplicationListResponse` +# `SearchApplicationListResponse` [interface-SearchApplicationListResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchApplicationPostBehavioralAnalyticsEventRequest.md b/docs/reference/api/SearchApplicationPostBehavioralAnalyticsEventRequest.md index ee3ab5012..f1a84e26d 100644 --- a/docs/reference/api/SearchApplicationPostBehavioralAnalyticsEventRequest.md +++ b/docs/reference/api/SearchApplicationPostBehavioralAnalyticsEventRequest.md @@ -1,4 +1,4 @@ -## Interface `SearchApplicationPostBehavioralAnalyticsEventRequest` +# `SearchApplicationPostBehavioralAnalyticsEventRequest` [interface-SearchApplicationPostBehavioralAnalyticsEventRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchApplicationPostBehavioralAnalyticsEventResponse.md b/docs/reference/api/SearchApplicationPostBehavioralAnalyticsEventResponse.md index f37618b66..74bcedd4a 100644 --- a/docs/reference/api/SearchApplicationPostBehavioralAnalyticsEventResponse.md +++ b/docs/reference/api/SearchApplicationPostBehavioralAnalyticsEventResponse.md @@ -1,4 +1,4 @@ -## Interface `SearchApplicationPostBehavioralAnalyticsEventResponse` +# `SearchApplicationPostBehavioralAnalyticsEventResponse` [interface-SearchApplicationPostBehavioralAnalyticsEventResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchApplicationPutBehavioralAnalyticsAnalyticsAcknowledgeResponseBase.md b/docs/reference/api/SearchApplicationPutBehavioralAnalyticsAnalyticsAcknowledgeResponseBase.md index e47aa1db3..77605d6b3 100644 --- a/docs/reference/api/SearchApplicationPutBehavioralAnalyticsAnalyticsAcknowledgeResponseBase.md +++ b/docs/reference/api/SearchApplicationPutBehavioralAnalyticsAnalyticsAcknowledgeResponseBase.md @@ -1,4 +1,4 @@ -## Interface `SearchApplicationPutBehavioralAnalyticsAnalyticsAcknowledgeResponseBase` +# `SearchApplicationPutBehavioralAnalyticsAnalyticsAcknowledgeResponseBase` [interface-SearchApplicationPutBehavioralAnalyticsAnalyticsAcknowledgeResponseBase] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchApplicationPutBehavioralAnalyticsRequest.md b/docs/reference/api/SearchApplicationPutBehavioralAnalyticsRequest.md index 7da1c0d07..73b1320b5 100644 --- a/docs/reference/api/SearchApplicationPutBehavioralAnalyticsRequest.md +++ b/docs/reference/api/SearchApplicationPutBehavioralAnalyticsRequest.md @@ -1,4 +1,4 @@ -## Interface `SearchApplicationPutBehavioralAnalyticsRequest` +# `SearchApplicationPutBehavioralAnalyticsRequest` [interface-SearchApplicationPutBehavioralAnalyticsRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchApplicationPutBehavioralAnalyticsResponse.md b/docs/reference/api/SearchApplicationPutBehavioralAnalyticsResponse.md index 2de20d5f4..e4efd364e 100644 --- a/docs/reference/api/SearchApplicationPutBehavioralAnalyticsResponse.md +++ b/docs/reference/api/SearchApplicationPutBehavioralAnalyticsResponse.md @@ -1,4 +1,4 @@ -## `SearchApplicationPutBehavioralAnalyticsResponse` -::: +# `SearchApplicationPutBehavioralAnalyticsResponse` [alias-SearchApplicationPutBehavioralAnalyticsResponse] +```typescript type SearchApplicationPutBehavioralAnalyticsResponse = [SearchApplicationPutBehavioralAnalyticsAnalyticsAcknowledgeResponseBase](./SearchApplicationPutBehavioralAnalyticsAnalyticsAcknowledgeResponseBase.md); -::: +``` diff --git a/docs/reference/api/SearchApplicationPutRequest.md b/docs/reference/api/SearchApplicationPutRequest.md index a0c6dc280..ca5d9203f 100644 --- a/docs/reference/api/SearchApplicationPutRequest.md +++ b/docs/reference/api/SearchApplicationPutRequest.md @@ -1,4 +1,4 @@ -## Interface `SearchApplicationPutRequest` +# `SearchApplicationPutRequest` [interface-SearchApplicationPutRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchApplicationPutResponse.md b/docs/reference/api/SearchApplicationPutResponse.md index 11346b5e2..ab43db145 100644 --- a/docs/reference/api/SearchApplicationPutResponse.md +++ b/docs/reference/api/SearchApplicationPutResponse.md @@ -1,4 +1,4 @@ -## Interface `SearchApplicationPutResponse` +# `SearchApplicationPutResponse` [interface-SearchApplicationPutResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchApplicationRenderQueryRequest.md b/docs/reference/api/SearchApplicationRenderQueryRequest.md index 1490bdb9a..b2d4d01e1 100644 --- a/docs/reference/api/SearchApplicationRenderQueryRequest.md +++ b/docs/reference/api/SearchApplicationRenderQueryRequest.md @@ -1,4 +1,4 @@ -## Interface `SearchApplicationRenderQueryRequest` +# `SearchApplicationRenderQueryRequest` [interface-SearchApplicationRenderQueryRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchApplicationRenderQueryResponse.md b/docs/reference/api/SearchApplicationRenderQueryResponse.md index 6c0eb2db9..0b0415220 100644 --- a/docs/reference/api/SearchApplicationRenderQueryResponse.md +++ b/docs/reference/api/SearchApplicationRenderQueryResponse.md @@ -1,4 +1,4 @@ -## Interface `SearchApplicationRenderQueryResponse` +# `SearchApplicationRenderQueryResponse` [interface-SearchApplicationRenderQueryResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchApplicationSearchApplication.md b/docs/reference/api/SearchApplicationSearchApplication.md index 4beed6edf..7efe5c81a 100644 --- a/docs/reference/api/SearchApplicationSearchApplication.md +++ b/docs/reference/api/SearchApplicationSearchApplication.md @@ -1,4 +1,4 @@ -## Interface `SearchApplicationSearchApplication` +# `SearchApplicationSearchApplication` [interface-SearchApplicationSearchApplication] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchApplicationSearchApplicationParameters.md b/docs/reference/api/SearchApplicationSearchApplicationParameters.md index ae7f4af3c..fd35845d5 100644 --- a/docs/reference/api/SearchApplicationSearchApplicationParameters.md +++ b/docs/reference/api/SearchApplicationSearchApplicationParameters.md @@ -1,4 +1,4 @@ -## Interface `SearchApplicationSearchApplicationParameters` +# `SearchApplicationSearchApplicationParameters` [interface-SearchApplicationSearchApplicationParameters] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchApplicationSearchApplicationTemplate.md b/docs/reference/api/SearchApplicationSearchApplicationTemplate.md index 077912f94..c28247dce 100644 --- a/docs/reference/api/SearchApplicationSearchApplicationTemplate.md +++ b/docs/reference/api/SearchApplicationSearchApplicationTemplate.md @@ -1,4 +1,4 @@ -## Interface `SearchApplicationSearchApplicationTemplate` +# `SearchApplicationSearchApplicationTemplate` [interface-SearchApplicationSearchApplicationTemplate] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchApplicationSearchRequest.md b/docs/reference/api/SearchApplicationSearchRequest.md index b52c4a506..b4766b981 100644 --- a/docs/reference/api/SearchApplicationSearchRequest.md +++ b/docs/reference/api/SearchApplicationSearchRequest.md @@ -1,4 +1,4 @@ -## Interface `SearchApplicationSearchRequest` +# `SearchApplicationSearchRequest` [interface-SearchApplicationSearchRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchApplicationSearchResponse.md b/docs/reference/api/SearchApplicationSearchResponse.md index a0955c111..9b7af1b2f 100644 --- a/docs/reference/api/SearchApplicationSearchResponse.md +++ b/docs/reference/api/SearchApplicationSearchResponse.md @@ -1,4 +1,4 @@ -## `SearchApplicationSearchResponse` -::: +# `SearchApplicationSearchResponse` [alias-SearchApplicationSearchResponse] +```typescript type SearchApplicationSearchResponse> = [SearchResponseBody](./SearchResponseBody.md); -::: +``` diff --git a/docs/reference/api/SearchBoundaryScanner.md b/docs/reference/api/SearchBoundaryScanner.md index d3961052b..90f09c43b 100644 --- a/docs/reference/api/SearchBoundaryScanner.md +++ b/docs/reference/api/SearchBoundaryScanner.md @@ -1,4 +1,4 @@ -## `SearchBoundaryScanner` -::: +# `SearchBoundaryScanner` [alias-SearchBoundaryScanner] +```typescript type SearchBoundaryScanner = 'chars' | 'sentence' | 'word'; -::: +``` diff --git a/docs/reference/api/SearchCollector.md b/docs/reference/api/SearchCollector.md index 5907ac8c8..b60f1afd1 100644 --- a/docs/reference/api/SearchCollector.md +++ b/docs/reference/api/SearchCollector.md @@ -1,4 +1,4 @@ -## Interface `SearchCollector` +# `SearchCollector` [interface-SearchCollector] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchCompletionContext.md b/docs/reference/api/SearchCompletionContext.md index b2a867d04..3e41a7e69 100644 --- a/docs/reference/api/SearchCompletionContext.md +++ b/docs/reference/api/SearchCompletionContext.md @@ -1,4 +1,4 @@ -## Interface `SearchCompletionContext` +# `SearchCompletionContext` [interface-SearchCompletionContext] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchCompletionSuggest.md b/docs/reference/api/SearchCompletionSuggest.md index d1ed40e8d..f8356a37e 100644 --- a/docs/reference/api/SearchCompletionSuggest.md +++ b/docs/reference/api/SearchCompletionSuggest.md @@ -1,4 +1,4 @@ -## Interface `SearchCompletionSuggest` +# `SearchCompletionSuggest` [interface-SearchCompletionSuggest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchCompletionSuggestOption.md b/docs/reference/api/SearchCompletionSuggestOption.md index 4e67fc129..fef1e7655 100644 --- a/docs/reference/api/SearchCompletionSuggestOption.md +++ b/docs/reference/api/SearchCompletionSuggestOption.md @@ -1,4 +1,4 @@ -## Interface `SearchCompletionSuggestOption` +# `SearchCompletionSuggestOption` [interface-SearchCompletionSuggestOption] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchCompletionSuggester.md b/docs/reference/api/SearchCompletionSuggester.md index 8c20b7050..a053d4357 100644 --- a/docs/reference/api/SearchCompletionSuggester.md +++ b/docs/reference/api/SearchCompletionSuggester.md @@ -1,4 +1,4 @@ -## Interface `SearchCompletionSuggester` +# `SearchCompletionSuggester` [interface-SearchCompletionSuggester] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchContext.md b/docs/reference/api/SearchContext.md index 80a2a9c08..91663d0ff 100644 --- a/docs/reference/api/SearchContext.md +++ b/docs/reference/api/SearchContext.md @@ -1,4 +1,4 @@ -## `SearchContext` -::: +# `SearchContext` [alias-SearchContext] +```typescript type SearchContext = string | [GeoLocation](./GeoLocation.md); -::: +``` diff --git a/docs/reference/api/SearchDfsKnnProfile.md b/docs/reference/api/SearchDfsKnnProfile.md index ef0d9ff73..1ad69bf73 100644 --- a/docs/reference/api/SearchDfsKnnProfile.md +++ b/docs/reference/api/SearchDfsKnnProfile.md @@ -1,4 +1,4 @@ -## Interface `SearchDfsKnnProfile` +# `SearchDfsKnnProfile` [interface-SearchDfsKnnProfile] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchDfsProfile.md b/docs/reference/api/SearchDfsProfile.md index 8a5f1f028..14561174e 100644 --- a/docs/reference/api/SearchDfsProfile.md +++ b/docs/reference/api/SearchDfsProfile.md @@ -1,4 +1,4 @@ -## Interface `SearchDfsProfile` +# `SearchDfsProfile` [interface-SearchDfsProfile] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchDfsStatisticsBreakdown.md b/docs/reference/api/SearchDfsStatisticsBreakdown.md index 9b760cb34..b9ca09e9d 100644 --- a/docs/reference/api/SearchDfsStatisticsBreakdown.md +++ b/docs/reference/api/SearchDfsStatisticsBreakdown.md @@ -1,4 +1,4 @@ -## Interface `SearchDfsStatisticsBreakdown` +# `SearchDfsStatisticsBreakdown` [interface-SearchDfsStatisticsBreakdown] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchDfsStatisticsProfile.md b/docs/reference/api/SearchDfsStatisticsProfile.md index d0d6eaa5a..4e96e7740 100644 --- a/docs/reference/api/SearchDfsStatisticsProfile.md +++ b/docs/reference/api/SearchDfsStatisticsProfile.md @@ -1,4 +1,4 @@ -## Interface `SearchDfsStatisticsProfile` +# `SearchDfsStatisticsProfile` [interface-SearchDfsStatisticsProfile] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchDirectGenerator.md b/docs/reference/api/SearchDirectGenerator.md index f61b37018..7e7c30af4 100644 --- a/docs/reference/api/SearchDirectGenerator.md +++ b/docs/reference/api/SearchDirectGenerator.md @@ -1,4 +1,4 @@ -## Interface `SearchDirectGenerator` +# `SearchDirectGenerator` [interface-SearchDirectGenerator] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchFetchProfile.md b/docs/reference/api/SearchFetchProfile.md index 566bd5fdc..5bb7892d6 100644 --- a/docs/reference/api/SearchFetchProfile.md +++ b/docs/reference/api/SearchFetchProfile.md @@ -1,4 +1,4 @@ -## Interface `SearchFetchProfile` +# `SearchFetchProfile` [interface-SearchFetchProfile] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchFetchProfileBreakdown.md b/docs/reference/api/SearchFetchProfileBreakdown.md index b906db047..d7f44eb6e 100644 --- a/docs/reference/api/SearchFetchProfileBreakdown.md +++ b/docs/reference/api/SearchFetchProfileBreakdown.md @@ -1,4 +1,4 @@ -## Interface `SearchFetchProfileBreakdown` +# `SearchFetchProfileBreakdown` [interface-SearchFetchProfileBreakdown] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchFetchProfileDebug.md b/docs/reference/api/SearchFetchProfileDebug.md index 03f64e033..68df82aa4 100644 --- a/docs/reference/api/SearchFetchProfileDebug.md +++ b/docs/reference/api/SearchFetchProfileDebug.md @@ -1,4 +1,4 @@ -## Interface `SearchFetchProfileDebug` +# `SearchFetchProfileDebug` [interface-SearchFetchProfileDebug] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchFieldCollapse.md b/docs/reference/api/SearchFieldCollapse.md index d9ee95c16..235f661a7 100644 --- a/docs/reference/api/SearchFieldCollapse.md +++ b/docs/reference/api/SearchFieldCollapse.md @@ -1,4 +1,4 @@ -## Interface `SearchFieldCollapse` +# `SearchFieldCollapse` [interface-SearchFieldCollapse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchFieldSuggester.md b/docs/reference/api/SearchFieldSuggester.md index fe72caf11..6650a759b 100644 --- a/docs/reference/api/SearchFieldSuggester.md +++ b/docs/reference/api/SearchFieldSuggester.md @@ -1,4 +1,4 @@ -## Interface `SearchFieldSuggester` +# `SearchFieldSuggester` [interface-SearchFieldSuggester] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchHighlight.md b/docs/reference/api/SearchHighlight.md index 2f99ee597..2625c996b 100644 --- a/docs/reference/api/SearchHighlight.md +++ b/docs/reference/api/SearchHighlight.md @@ -1,4 +1,4 @@ -## Interface `SearchHighlight` +# `SearchHighlight` [interface-SearchHighlight] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchHighlightBase.md b/docs/reference/api/SearchHighlightBase.md index 3e22909f8..8df759cd7 100644 --- a/docs/reference/api/SearchHighlightBase.md +++ b/docs/reference/api/SearchHighlightBase.md @@ -1,4 +1,4 @@ -## Interface `SearchHighlightBase` +# `SearchHighlightBase` [interface-SearchHighlightBase] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchHighlightField.md b/docs/reference/api/SearchHighlightField.md index 2025f169a..4e7f74518 100644 --- a/docs/reference/api/SearchHighlightField.md +++ b/docs/reference/api/SearchHighlightField.md @@ -1,4 +1,4 @@ -## Interface `SearchHighlightField` +# `SearchHighlightField` [interface-SearchHighlightField] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchHighlighterEncoder.md b/docs/reference/api/SearchHighlighterEncoder.md index 2a557f9d8..c64de9b68 100644 --- a/docs/reference/api/SearchHighlighterEncoder.md +++ b/docs/reference/api/SearchHighlighterEncoder.md @@ -1,4 +1,4 @@ -## `SearchHighlighterEncoder` -::: +# `SearchHighlighterEncoder` [alias-SearchHighlighterEncoder] +```typescript type SearchHighlighterEncoder = 'default' | 'html'; -::: +``` diff --git a/docs/reference/api/SearchHighlighterFragmenter.md b/docs/reference/api/SearchHighlighterFragmenter.md index e057a8b05..dc2a5583b 100644 --- a/docs/reference/api/SearchHighlighterFragmenter.md +++ b/docs/reference/api/SearchHighlighterFragmenter.md @@ -1,4 +1,4 @@ -## `SearchHighlighterFragmenter` -::: +# `SearchHighlighterFragmenter` [alias-SearchHighlighterFragmenter] +```typescript type SearchHighlighterFragmenter = 'simple' | 'span'; -::: +``` diff --git a/docs/reference/api/SearchHighlighterOrder.md b/docs/reference/api/SearchHighlighterOrder.md index 18d3763be..b072ea3f1 100644 --- a/docs/reference/api/SearchHighlighterOrder.md +++ b/docs/reference/api/SearchHighlighterOrder.md @@ -1,4 +1,4 @@ -## `SearchHighlighterOrder` -::: +# `SearchHighlighterOrder` [alias-SearchHighlighterOrder] +```typescript type SearchHighlighterOrder = 'score'; -::: +``` diff --git a/docs/reference/api/SearchHighlighterTagsSchema.md b/docs/reference/api/SearchHighlighterTagsSchema.md index e7fae6291..d5e177498 100644 --- a/docs/reference/api/SearchHighlighterTagsSchema.md +++ b/docs/reference/api/SearchHighlighterTagsSchema.md @@ -1,4 +1,4 @@ -## `SearchHighlighterTagsSchema` -::: +# `SearchHighlighterTagsSchema` [alias-SearchHighlighterTagsSchema] +```typescript type SearchHighlighterTagsSchema = 'styled'; -::: +``` diff --git a/docs/reference/api/SearchHighlighterType.md b/docs/reference/api/SearchHighlighterType.md index 0b6885cfd..071f8c5b0 100644 --- a/docs/reference/api/SearchHighlighterType.md +++ b/docs/reference/api/SearchHighlighterType.md @@ -1,4 +1,4 @@ -## `SearchHighlighterType` -::: +# `SearchHighlighterType` [alias-SearchHighlighterType] +```typescript type SearchHighlighterType = 'plain' | 'fvh' | 'unified' | string; -::: +``` diff --git a/docs/reference/api/SearchHit.md b/docs/reference/api/SearchHit.md index 9b5c00601..a257a21d9 100644 --- a/docs/reference/api/SearchHit.md +++ b/docs/reference/api/SearchHit.md @@ -1,4 +1,4 @@ -## Interface `SearchHit` +# `SearchHit` [interface-SearchHit] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchHitsMetadata.md b/docs/reference/api/SearchHitsMetadata.md index a2cdbd975..9b92fafa0 100644 --- a/docs/reference/api/SearchHitsMetadata.md +++ b/docs/reference/api/SearchHitsMetadata.md @@ -1,4 +1,4 @@ -## Interface `SearchHitsMetadata` +# `SearchHitsMetadata` [interface-SearchHitsMetadata] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchInnerHits.md b/docs/reference/api/SearchInnerHits.md index eb3f206a0..7ba7d6848 100644 --- a/docs/reference/api/SearchInnerHits.md +++ b/docs/reference/api/SearchInnerHits.md @@ -1,4 +1,4 @@ -## Interface `SearchInnerHits` +# `SearchInnerHits` [interface-SearchInnerHits] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchInnerHitsResult.md b/docs/reference/api/SearchInnerHitsResult.md index 99a421f91..45e522cd3 100644 --- a/docs/reference/api/SearchInnerHitsResult.md +++ b/docs/reference/api/SearchInnerHitsResult.md @@ -1,4 +1,4 @@ -## Interface `SearchInnerHitsResult` +# `SearchInnerHitsResult` [interface-SearchInnerHitsResult] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchKnnCollectorResult.md b/docs/reference/api/SearchKnnCollectorResult.md index 0f994f64b..f227e5982 100644 --- a/docs/reference/api/SearchKnnCollectorResult.md +++ b/docs/reference/api/SearchKnnCollectorResult.md @@ -1,4 +1,4 @@ -## Interface `SearchKnnCollectorResult` +# `SearchKnnCollectorResult` [interface-SearchKnnCollectorResult] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchKnnQueryProfileBreakdown.md b/docs/reference/api/SearchKnnQueryProfileBreakdown.md index b744c4d5b..621b47641 100644 --- a/docs/reference/api/SearchKnnQueryProfileBreakdown.md +++ b/docs/reference/api/SearchKnnQueryProfileBreakdown.md @@ -1,4 +1,4 @@ -## Interface `SearchKnnQueryProfileBreakdown` +# `SearchKnnQueryProfileBreakdown` [interface-SearchKnnQueryProfileBreakdown] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchKnnQueryProfileResult.md b/docs/reference/api/SearchKnnQueryProfileResult.md index 365e62fcd..75fc426bf 100644 --- a/docs/reference/api/SearchKnnQueryProfileResult.md +++ b/docs/reference/api/SearchKnnQueryProfileResult.md @@ -1,4 +1,4 @@ -## Interface `SearchKnnQueryProfileResult` +# `SearchKnnQueryProfileResult` [interface-SearchKnnQueryProfileResult] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchLaplaceSmoothingModel.md b/docs/reference/api/SearchLaplaceSmoothingModel.md index 176435fec..e3b72ba91 100644 --- a/docs/reference/api/SearchLaplaceSmoothingModel.md +++ b/docs/reference/api/SearchLaplaceSmoothingModel.md @@ -1,4 +1,4 @@ -## Interface `SearchLaplaceSmoothingModel` +# `SearchLaplaceSmoothingModel` [interface-SearchLaplaceSmoothingModel] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchLearningToRank.md b/docs/reference/api/SearchLearningToRank.md index a5a486f5e..fb193e503 100644 --- a/docs/reference/api/SearchLearningToRank.md +++ b/docs/reference/api/SearchLearningToRank.md @@ -1,4 +1,4 @@ -## Interface `SearchLearningToRank` +# `SearchLearningToRank` [interface-SearchLearningToRank] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchLinearInterpolationSmoothingModel.md b/docs/reference/api/SearchLinearInterpolationSmoothingModel.md index 1674b3f60..2c182acce 100644 --- a/docs/reference/api/SearchLinearInterpolationSmoothingModel.md +++ b/docs/reference/api/SearchLinearInterpolationSmoothingModel.md @@ -1,4 +1,4 @@ -## Interface `SearchLinearInterpolationSmoothingModel` +# `SearchLinearInterpolationSmoothingModel` [interface-SearchLinearInterpolationSmoothingModel] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchMvtApi_1.md b/docs/reference/api/SearchMvtApi_1.md index d2ea4aa85..767159eeb 100644 --- a/docs/reference/api/SearchMvtApi_1.md +++ b/docs/reference/api/SearchMvtApi_1.md @@ -1,3 +1,3 @@ -::: +```typescript default function SearchMvtApi(this: [That](./That.md), params: [SearchMvtRequest](./SearchMvtRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SearchMvtResponse](./SearchMvtResponse.md)>; -::: +``` diff --git a/docs/reference/api/SearchMvtApi_2.md b/docs/reference/api/SearchMvtApi_2.md index b43b09176..932f02876 100644 --- a/docs/reference/api/SearchMvtApi_2.md +++ b/docs/reference/api/SearchMvtApi_2.md @@ -1,3 +1,3 @@ -::: +```typescript default function SearchMvtApi(this: [That](./That.md), params: [SearchMvtRequest](./SearchMvtRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SearchMvtResponse](./SearchMvtResponse.md), unknown>>; -::: +``` diff --git a/docs/reference/api/SearchMvtApi_3.md b/docs/reference/api/SearchMvtApi_3.md index 5b2a13449..96429178a 100644 --- a/docs/reference/api/SearchMvtApi_3.md +++ b/docs/reference/api/SearchMvtApi_3.md @@ -1,3 +1,3 @@ -::: +```typescript default function SearchMvtApi(this: [That](./That.md), params: [SearchMvtRequest](./SearchMvtRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SearchMvtResponse](./SearchMvtResponse.md)>; -::: +``` diff --git a/docs/reference/api/SearchMvtCoordinate.md b/docs/reference/api/SearchMvtCoordinate.md index 04e667dd9..3e97d057a 100644 --- a/docs/reference/api/SearchMvtCoordinate.md +++ b/docs/reference/api/SearchMvtCoordinate.md @@ -1,4 +1,4 @@ -## `SearchMvtCoordinate` -::: +# `SearchMvtCoordinate` [alias-SearchMvtCoordinate] +```typescript type SearchMvtCoordinate = [integer](./integer.md); -::: +``` diff --git a/docs/reference/api/SearchMvtGridAggregationType.md b/docs/reference/api/SearchMvtGridAggregationType.md index 590210f37..dd5c18177 100644 --- a/docs/reference/api/SearchMvtGridAggregationType.md +++ b/docs/reference/api/SearchMvtGridAggregationType.md @@ -1,4 +1,4 @@ -## `SearchMvtGridAggregationType` -::: +# `SearchMvtGridAggregationType` [alias-SearchMvtGridAggregationType] +```typescript type SearchMvtGridAggregationType = 'geotile' | 'geohex'; -::: +``` diff --git a/docs/reference/api/SearchMvtGridType.md b/docs/reference/api/SearchMvtGridType.md index 2617eb738..79180fdaf 100644 --- a/docs/reference/api/SearchMvtGridType.md +++ b/docs/reference/api/SearchMvtGridType.md @@ -1,4 +1,4 @@ -## `SearchMvtGridType` -::: +# `SearchMvtGridType` [alias-SearchMvtGridType] +```typescript type SearchMvtGridType = 'grid' | 'point' | 'centroid'; -::: +``` diff --git a/docs/reference/api/SearchMvtRequest.md b/docs/reference/api/SearchMvtRequest.md index 1654c4b3c..6fd7cb4f2 100644 --- a/docs/reference/api/SearchMvtRequest.md +++ b/docs/reference/api/SearchMvtRequest.md @@ -1,4 +1,4 @@ -## Interface `SearchMvtRequest` +# `SearchMvtRequest` [interface-SearchMvtRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchMvtResponse.md b/docs/reference/api/SearchMvtResponse.md index c3006f472..8f4681f6d 100644 --- a/docs/reference/api/SearchMvtResponse.md +++ b/docs/reference/api/SearchMvtResponse.md @@ -1,4 +1,4 @@ -## `SearchMvtResponse` -::: +# `SearchMvtResponse` [alias-SearchMvtResponse] +```typescript type SearchMvtResponse = [MapboxVectorTiles](./MapboxVectorTiles.md); -::: +``` diff --git a/docs/reference/api/SearchMvtZoomLevel.md b/docs/reference/api/SearchMvtZoomLevel.md index 5abdd344e..a61ce2b87 100644 --- a/docs/reference/api/SearchMvtZoomLevel.md +++ b/docs/reference/api/SearchMvtZoomLevel.md @@ -1,4 +1,4 @@ -## `SearchMvtZoomLevel` -::: +# `SearchMvtZoomLevel` [alias-SearchMvtZoomLevel] +```typescript type SearchMvtZoomLevel = [integer](./integer.md); -::: +``` diff --git a/docs/reference/api/SearchNestedIdentity.md b/docs/reference/api/SearchNestedIdentity.md index 9c9eb82b7..b66668870 100644 --- a/docs/reference/api/SearchNestedIdentity.md +++ b/docs/reference/api/SearchNestedIdentity.md @@ -1,4 +1,4 @@ -## Interface `SearchNestedIdentity` +# `SearchNestedIdentity` [interface-SearchNestedIdentity] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchPhraseSuggest.md b/docs/reference/api/SearchPhraseSuggest.md index faba96edb..2ce7b0e89 100644 --- a/docs/reference/api/SearchPhraseSuggest.md +++ b/docs/reference/api/SearchPhraseSuggest.md @@ -1,4 +1,4 @@ -## Interface `SearchPhraseSuggest` +# `SearchPhraseSuggest` [interface-SearchPhraseSuggest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchPhraseSuggestCollate.md b/docs/reference/api/SearchPhraseSuggestCollate.md index a04f5ca53..2fd5409d2 100644 --- a/docs/reference/api/SearchPhraseSuggestCollate.md +++ b/docs/reference/api/SearchPhraseSuggestCollate.md @@ -1,4 +1,4 @@ -## Interface `SearchPhraseSuggestCollate` +# `SearchPhraseSuggestCollate` [interface-SearchPhraseSuggestCollate] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchPhraseSuggestCollateQuery.md b/docs/reference/api/SearchPhraseSuggestCollateQuery.md index 20ef58bb6..d3d181f90 100644 --- a/docs/reference/api/SearchPhraseSuggestCollateQuery.md +++ b/docs/reference/api/SearchPhraseSuggestCollateQuery.md @@ -1,4 +1,4 @@ -## Interface `SearchPhraseSuggestCollateQuery` +# `SearchPhraseSuggestCollateQuery` [interface-SearchPhraseSuggestCollateQuery] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchPhraseSuggestHighlight.md b/docs/reference/api/SearchPhraseSuggestHighlight.md index 0cf6b0ce0..39db3ce9d 100644 --- a/docs/reference/api/SearchPhraseSuggestHighlight.md +++ b/docs/reference/api/SearchPhraseSuggestHighlight.md @@ -1,4 +1,4 @@ -## Interface `SearchPhraseSuggestHighlight` +# `SearchPhraseSuggestHighlight` [interface-SearchPhraseSuggestHighlight] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchPhraseSuggestOption.md b/docs/reference/api/SearchPhraseSuggestOption.md index e97e2e93d..c3d7efde4 100644 --- a/docs/reference/api/SearchPhraseSuggestOption.md +++ b/docs/reference/api/SearchPhraseSuggestOption.md @@ -1,4 +1,4 @@ -## Interface `SearchPhraseSuggestOption` +# `SearchPhraseSuggestOption` [interface-SearchPhraseSuggestOption] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchPhraseSuggester.md b/docs/reference/api/SearchPhraseSuggester.md index 1b1e8acd8..5f25ea873 100644 --- a/docs/reference/api/SearchPhraseSuggester.md +++ b/docs/reference/api/SearchPhraseSuggester.md @@ -1,4 +1,4 @@ -## Interface `SearchPhraseSuggester` +# `SearchPhraseSuggester` [interface-SearchPhraseSuggester] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchPointInTimeReference.md b/docs/reference/api/SearchPointInTimeReference.md index 58a09aa8a..50983a8a4 100644 --- a/docs/reference/api/SearchPointInTimeReference.md +++ b/docs/reference/api/SearchPointInTimeReference.md @@ -1,4 +1,4 @@ -## Interface `SearchPointInTimeReference` +# `SearchPointInTimeReference` [interface-SearchPointInTimeReference] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchProfile.md b/docs/reference/api/SearchProfile.md index 57b0ead08..c374908d2 100644 --- a/docs/reference/api/SearchProfile.md +++ b/docs/reference/api/SearchProfile.md @@ -1,4 +1,4 @@ -## Interface `SearchProfile` +# `SearchProfile` [interface-SearchProfile] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchQueryBreakdown.md b/docs/reference/api/SearchQueryBreakdown.md index 21f6ca939..02391a3a5 100644 --- a/docs/reference/api/SearchQueryBreakdown.md +++ b/docs/reference/api/SearchQueryBreakdown.md @@ -1,4 +1,4 @@ -## Interface `SearchQueryBreakdown` +# `SearchQueryBreakdown` [interface-SearchQueryBreakdown] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchQueryProfile.md b/docs/reference/api/SearchQueryProfile.md index aef98ab21..320d79563 100644 --- a/docs/reference/api/SearchQueryProfile.md +++ b/docs/reference/api/SearchQueryProfile.md @@ -1,4 +1,4 @@ -## Interface `SearchQueryProfile` +# `SearchQueryProfile` [interface-SearchQueryProfile] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchRegexOptions.md b/docs/reference/api/SearchRegexOptions.md index 64b2679fe..176cc6c9c 100644 --- a/docs/reference/api/SearchRegexOptions.md +++ b/docs/reference/api/SearchRegexOptions.md @@ -1,4 +1,4 @@ -## Interface `SearchRegexOptions` +# `SearchRegexOptions` [interface-SearchRegexOptions] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchRequest.md b/docs/reference/api/SearchRequest.md index a1bff6a29..430c6edf1 100644 --- a/docs/reference/api/SearchRequest.md +++ b/docs/reference/api/SearchRequest.md @@ -1,4 +1,4 @@ -## Interface `SearchRequest` +# `SearchRequest` [interface-SearchRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchRescore.md b/docs/reference/api/SearchRescore.md index 79958f7d4..5518f6859 100644 --- a/docs/reference/api/SearchRescore.md +++ b/docs/reference/api/SearchRescore.md @@ -1,4 +1,4 @@ -## Interface `SearchRescore` +# `SearchRescore` [interface-SearchRescore] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchRescoreQuery.md b/docs/reference/api/SearchRescoreQuery.md index 21a432c85..336a84f71 100644 --- a/docs/reference/api/SearchRescoreQuery.md +++ b/docs/reference/api/SearchRescoreQuery.md @@ -1,4 +1,4 @@ -## Interface `SearchRescoreQuery` +# `SearchRescoreQuery` [interface-SearchRescoreQuery] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchResponse.md b/docs/reference/api/SearchResponse.md index b74eb9d23..be682485b 100644 --- a/docs/reference/api/SearchResponse.md +++ b/docs/reference/api/SearchResponse.md @@ -1,4 +1,4 @@ -## `SearchResponse` -::: +# `SearchResponse` [alias-SearchResponse] +```typescript type SearchResponse> = [SearchResponseBody](./SearchResponseBody.md); -::: +``` diff --git a/docs/reference/api/SearchResponseBody.md b/docs/reference/api/SearchResponseBody.md index 761008a78..e8466fd2a 100644 --- a/docs/reference/api/SearchResponseBody.md +++ b/docs/reference/api/SearchResponseBody.md @@ -1,4 +1,4 @@ -## Interface `SearchResponseBody` +# `SearchResponseBody` [interface-SearchResponseBody] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchScoreMode.md b/docs/reference/api/SearchScoreMode.md index 5c55101ca..4a2f8eb24 100644 --- a/docs/reference/api/SearchScoreMode.md +++ b/docs/reference/api/SearchScoreMode.md @@ -1,4 +1,4 @@ -## `SearchScoreMode` -::: +# `SearchScoreMode` [alias-SearchScoreMode] +```typescript type SearchScoreMode = 'avg' | 'max' | 'min' | 'multiply' | 'total'; -::: +``` diff --git a/docs/reference/api/SearchSearchProfile.md b/docs/reference/api/SearchSearchProfile.md index 67f3e717d..45be0941c 100644 --- a/docs/reference/api/SearchSearchProfile.md +++ b/docs/reference/api/SearchSearchProfile.md @@ -1,4 +1,4 @@ -## Interface `SearchSearchProfile` +# `SearchSearchProfile` [interface-SearchSearchProfile] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchSearchRequestBody.md b/docs/reference/api/SearchSearchRequestBody.md index 2c9256658..7782138a0 100644 --- a/docs/reference/api/SearchSearchRequestBody.md +++ b/docs/reference/api/SearchSearchRequestBody.md @@ -1,4 +1,4 @@ -## Interface `SearchSearchRequestBody` +# `SearchSearchRequestBody` [interface-SearchSearchRequestBody] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchShardProfile.md b/docs/reference/api/SearchShardProfile.md index a62b2de9b..f66d5bf24 100644 --- a/docs/reference/api/SearchShardProfile.md +++ b/docs/reference/api/SearchShardProfile.md @@ -1,4 +1,4 @@ -## Interface `SearchShardProfile` +# `SearchShardProfile` [interface-SearchShardProfile] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchShardsApi_1.md b/docs/reference/api/SearchShardsApi_1.md index c1e98d543..dbb0b4cab 100644 --- a/docs/reference/api/SearchShardsApi_1.md +++ b/docs/reference/api/SearchShardsApi_1.md @@ -1,3 +1,3 @@ -::: +```typescript default function SearchShardsApi(this: [That](./That.md), params?: [SearchShardsRequest](./SearchShardsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SearchShardsResponse](./SearchShardsResponse.md)>; -::: +``` diff --git a/docs/reference/api/SearchShardsApi_2.md b/docs/reference/api/SearchShardsApi_2.md index 5aeb01bc1..e3b8910c4 100644 --- a/docs/reference/api/SearchShardsApi_2.md +++ b/docs/reference/api/SearchShardsApi_2.md @@ -1,3 +1,3 @@ -::: +```typescript default function SearchShardsApi(this: [That](./That.md), params?: [SearchShardsRequest](./SearchShardsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SearchShardsResponse](./SearchShardsResponse.md), unknown>>; -::: +``` diff --git a/docs/reference/api/SearchShardsApi_3.md b/docs/reference/api/SearchShardsApi_3.md index 484493ae5..2ec8a15b6 100644 --- a/docs/reference/api/SearchShardsApi_3.md +++ b/docs/reference/api/SearchShardsApi_3.md @@ -1,3 +1,3 @@ -::: +```typescript default function SearchShardsApi(this: [That](./That.md), params?: [SearchShardsRequest](./SearchShardsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SearchShardsResponse](./SearchShardsResponse.md)>; -::: +``` diff --git a/docs/reference/api/SearchShardsRequest.md b/docs/reference/api/SearchShardsRequest.md index 36d92ba4f..f0cde619e 100644 --- a/docs/reference/api/SearchShardsRequest.md +++ b/docs/reference/api/SearchShardsRequest.md @@ -1,4 +1,4 @@ -## Interface `SearchShardsRequest` +# `SearchShardsRequest` [interface-SearchShardsRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchShardsResponse.md b/docs/reference/api/SearchShardsResponse.md index 2b04b7783..7a859bda9 100644 --- a/docs/reference/api/SearchShardsResponse.md +++ b/docs/reference/api/SearchShardsResponse.md @@ -1,4 +1,4 @@ -## Interface `SearchShardsResponse` +# `SearchShardsResponse` [interface-SearchShardsResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchShardsSearchShardsNodeAttributes.md b/docs/reference/api/SearchShardsSearchShardsNodeAttributes.md index 1ebb96085..7d35125c3 100644 --- a/docs/reference/api/SearchShardsSearchShardsNodeAttributes.md +++ b/docs/reference/api/SearchShardsSearchShardsNodeAttributes.md @@ -1,4 +1,4 @@ -## Interface `SearchShardsSearchShardsNodeAttributes` +# `SearchShardsSearchShardsNodeAttributes` [interface-SearchShardsSearchShardsNodeAttributes] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchShardsShardStoreIndex.md b/docs/reference/api/SearchShardsShardStoreIndex.md index 5f2b20c7f..fcd639ce6 100644 --- a/docs/reference/api/SearchShardsShardStoreIndex.md +++ b/docs/reference/api/SearchShardsShardStoreIndex.md @@ -1,4 +1,4 @@ -## Interface `SearchShardsShardStoreIndex` +# `SearchShardsShardStoreIndex` [interface-SearchShardsShardStoreIndex] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchSmoothingModelContainer.md b/docs/reference/api/SearchSmoothingModelContainer.md index f9ef44bdc..26460df18 100644 --- a/docs/reference/api/SearchSmoothingModelContainer.md +++ b/docs/reference/api/SearchSmoothingModelContainer.md @@ -1,4 +1,4 @@ -## Interface `SearchSmoothingModelContainer` +# `SearchSmoothingModelContainer` [interface-SearchSmoothingModelContainer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchSourceConfig.md b/docs/reference/api/SearchSourceConfig.md index dc0d543bf..51b1a75f6 100644 --- a/docs/reference/api/SearchSourceConfig.md +++ b/docs/reference/api/SearchSourceConfig.md @@ -1,4 +1,4 @@ -## `SearchSourceConfig` -::: +# `SearchSourceConfig` [alias-SearchSourceConfig] +```typescript type SearchSourceConfig = boolean | [SearchSourceFilter](./SearchSourceFilter.md) | [Fields](./Fields.md); -::: +``` diff --git a/docs/reference/api/SearchSourceConfigParam.md b/docs/reference/api/SearchSourceConfigParam.md index f467be8be..676d7a78c 100644 --- a/docs/reference/api/SearchSourceConfigParam.md +++ b/docs/reference/api/SearchSourceConfigParam.md @@ -1,4 +1,4 @@ -## `SearchSourceConfigParam` -::: +# `SearchSourceConfigParam` [alias-SearchSourceConfigParam] +```typescript type SearchSourceConfigParam = boolean | [Fields](./Fields.md); -::: +``` diff --git a/docs/reference/api/SearchSourceFilter.md b/docs/reference/api/SearchSourceFilter.md index 1f879977f..d40fb2578 100644 --- a/docs/reference/api/SearchSourceFilter.md +++ b/docs/reference/api/SearchSourceFilter.md @@ -1,4 +1,4 @@ -## Interface `SearchSourceFilter` +# `SearchSourceFilter` [interface-SearchSourceFilter] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchStats.md b/docs/reference/api/SearchStats.md index b59063170..e528707fa 100644 --- a/docs/reference/api/SearchStats.md +++ b/docs/reference/api/SearchStats.md @@ -1,4 +1,4 @@ -## Interface `SearchStats` +# `SearchStats` [interface-SearchStats] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchStringDistance.md b/docs/reference/api/SearchStringDistance.md index 1beddce54..58847bccf 100644 --- a/docs/reference/api/SearchStringDistance.md +++ b/docs/reference/api/SearchStringDistance.md @@ -1,4 +1,4 @@ -## `SearchStringDistance` -::: +# `SearchStringDistance` [alias-SearchStringDistance] +```typescript type SearchStringDistance = 'internal' | 'damerau_levenshtein' | 'levenshtein' | 'jaro_winkler' | 'ngram'; -::: +``` diff --git a/docs/reference/api/SearchStupidBackoffSmoothingModel.md b/docs/reference/api/SearchStupidBackoffSmoothingModel.md index 30d5e716b..cd1bfb773 100644 --- a/docs/reference/api/SearchStupidBackoffSmoothingModel.md +++ b/docs/reference/api/SearchStupidBackoffSmoothingModel.md @@ -1,4 +1,4 @@ -## Interface `SearchStupidBackoffSmoothingModel` +# `SearchStupidBackoffSmoothingModel` [interface-SearchStupidBackoffSmoothingModel] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchSuggest.md b/docs/reference/api/SearchSuggest.md index 05996648d..743f385e8 100644 --- a/docs/reference/api/SearchSuggest.md +++ b/docs/reference/api/SearchSuggest.md @@ -1,4 +1,4 @@ -## `SearchSuggest` -::: +# `SearchSuggest` [alias-SearchSuggest] +```typescript type SearchSuggest = [SearchCompletionSuggest](./SearchCompletionSuggest.md) | [SearchPhraseSuggest](./SearchPhraseSuggest.md) | [SearchTermSuggest](./SearchTermSuggest.md); -::: +``` diff --git a/docs/reference/api/SearchSuggestBase.md b/docs/reference/api/SearchSuggestBase.md index 17eb5e85a..94ff116b3 100644 --- a/docs/reference/api/SearchSuggestBase.md +++ b/docs/reference/api/SearchSuggestBase.md @@ -1,4 +1,4 @@ -## Interface `SearchSuggestBase` +# `SearchSuggestBase` [interface-SearchSuggestBase] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchSuggestFuzziness.md b/docs/reference/api/SearchSuggestFuzziness.md index b236395f9..9d408462b 100644 --- a/docs/reference/api/SearchSuggestFuzziness.md +++ b/docs/reference/api/SearchSuggestFuzziness.md @@ -1,4 +1,4 @@ -## Interface `SearchSuggestFuzziness` +# `SearchSuggestFuzziness` [interface-SearchSuggestFuzziness] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchSuggestSort.md b/docs/reference/api/SearchSuggestSort.md index c9ab10b6d..86647a2d4 100644 --- a/docs/reference/api/SearchSuggestSort.md +++ b/docs/reference/api/SearchSuggestSort.md @@ -1,4 +1,4 @@ -## `SearchSuggestSort` -::: +# `SearchSuggestSort` [alias-SearchSuggestSort] +```typescript type SearchSuggestSort = 'score' | 'frequency'; -::: +``` diff --git a/docs/reference/api/SearchSuggester.md b/docs/reference/api/SearchSuggester.md index 1e781f106..82af45aa8 100644 --- a/docs/reference/api/SearchSuggester.md +++ b/docs/reference/api/SearchSuggester.md @@ -1,4 +1,4 @@ -## `SearchSuggester` -::: +# `SearchSuggester` [alias-SearchSuggester] +```typescript type SearchSuggester = [SearchSuggesterKeys](./SearchSuggesterKeys.md) & { [property: string]: [SearchFieldSuggester](./SearchFieldSuggester.md) | string;}; -::: +``` diff --git a/docs/reference/api/SearchSuggesterBase.md b/docs/reference/api/SearchSuggesterBase.md index 869fb6685..42b68cd0c 100644 --- a/docs/reference/api/SearchSuggesterBase.md +++ b/docs/reference/api/SearchSuggesterBase.md @@ -1,4 +1,4 @@ -## Interface `SearchSuggesterBase` +# `SearchSuggesterBase` [interface-SearchSuggesterBase] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchSuggesterKeys.md b/docs/reference/api/SearchSuggesterKeys.md index 835b84434..57e6ca7ba 100644 --- a/docs/reference/api/SearchSuggesterKeys.md +++ b/docs/reference/api/SearchSuggesterKeys.md @@ -1,4 +1,4 @@ -## Interface `SearchSuggesterKeys` +# `SearchSuggesterKeys` [interface-SearchSuggesterKeys] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchTemplateApi_1.md b/docs/reference/api/SearchTemplateApi_1.md index 2fb4d1e0c..d7dccfef4 100644 --- a/docs/reference/api/SearchTemplateApi_1.md +++ b/docs/reference/api/SearchTemplateApi_1.md @@ -1,3 +1,3 @@ -::: +```typescript default function SearchTemplateApi(this: [That](./That.md), params?: [SearchTemplateRequest](./SearchTemplateRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SearchTemplateResponse](./SearchTemplateResponse.md)>; -::: +``` diff --git a/docs/reference/api/SearchTemplateApi_2.md b/docs/reference/api/SearchTemplateApi_2.md index 636a9d0f6..6715387fa 100644 --- a/docs/reference/api/SearchTemplateApi_2.md +++ b/docs/reference/api/SearchTemplateApi_2.md @@ -1,3 +1,3 @@ -::: +```typescript default function SearchTemplateApi(this: [That](./That.md), params?: [SearchTemplateRequest](./SearchTemplateRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SearchTemplateResponse](./SearchTemplateResponse.md), unknown>>; -::: +``` diff --git a/docs/reference/api/SearchTemplateApi_3.md b/docs/reference/api/SearchTemplateApi_3.md index adf7b6c14..e54f20935 100644 --- a/docs/reference/api/SearchTemplateApi_3.md +++ b/docs/reference/api/SearchTemplateApi_3.md @@ -1,3 +1,3 @@ -::: +```typescript default function SearchTemplateApi(this: [That](./That.md), params?: [SearchTemplateRequest](./SearchTemplateRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SearchTemplateResponse](./SearchTemplateResponse.md)>; -::: +``` diff --git a/docs/reference/api/SearchTemplateRequest.md b/docs/reference/api/SearchTemplateRequest.md index 370e419c1..38ae31d3f 100644 --- a/docs/reference/api/SearchTemplateRequest.md +++ b/docs/reference/api/SearchTemplateRequest.md @@ -1,4 +1,4 @@ -## Interface `SearchTemplateRequest` +# `SearchTemplateRequest` [interface-SearchTemplateRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchTemplateResponse.md b/docs/reference/api/SearchTemplateResponse.md index c6bd4a9ef..d63ee7d99 100644 --- a/docs/reference/api/SearchTemplateResponse.md +++ b/docs/reference/api/SearchTemplateResponse.md @@ -1,4 +1,4 @@ -## Interface `SearchTemplateResponse` +# `SearchTemplateResponse` [interface-SearchTemplateResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchTermSuggest.md b/docs/reference/api/SearchTermSuggest.md index d7b6233af..b054bc7dd 100644 --- a/docs/reference/api/SearchTermSuggest.md +++ b/docs/reference/api/SearchTermSuggest.md @@ -1,4 +1,4 @@ -## Interface `SearchTermSuggest` +# `SearchTermSuggest` [interface-SearchTermSuggest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchTermSuggestOption.md b/docs/reference/api/SearchTermSuggestOption.md index 83ff1deb1..02ed957f4 100644 --- a/docs/reference/api/SearchTermSuggestOption.md +++ b/docs/reference/api/SearchTermSuggestOption.md @@ -1,4 +1,4 @@ -## Interface `SearchTermSuggestOption` +# `SearchTermSuggestOption` [interface-SearchTermSuggestOption] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchTermSuggester.md b/docs/reference/api/SearchTermSuggester.md index 5122ce7bd..7f29d8d22 100644 --- a/docs/reference/api/SearchTermSuggester.md +++ b/docs/reference/api/SearchTermSuggester.md @@ -1,4 +1,4 @@ -## Interface `SearchTermSuggester` +# `SearchTermSuggester` [interface-SearchTermSuggester] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchTotalHits.md b/docs/reference/api/SearchTotalHits.md index 70c43f81c..619ea99ab 100644 --- a/docs/reference/api/SearchTotalHits.md +++ b/docs/reference/api/SearchTotalHits.md @@ -1,4 +1,4 @@ -## Interface `SearchTotalHits` +# `SearchTotalHits` [interface-SearchTotalHits] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchTotalHitsRelation.md b/docs/reference/api/SearchTotalHitsRelation.md index 54969b514..ded435107 100644 --- a/docs/reference/api/SearchTotalHitsRelation.md +++ b/docs/reference/api/SearchTotalHitsRelation.md @@ -1,4 +1,4 @@ -## `SearchTotalHitsRelation` -::: +# `SearchTotalHitsRelation` [alias-SearchTotalHitsRelation] +```typescript type SearchTotalHitsRelation = 'eq' | 'gte'; -::: +``` diff --git a/docs/reference/api/SearchTrackHits.md b/docs/reference/api/SearchTrackHits.md index f29f19c3a..b16dca7c4 100644 --- a/docs/reference/api/SearchTrackHits.md +++ b/docs/reference/api/SearchTrackHits.md @@ -1,4 +1,4 @@ -## `SearchTrackHits` -::: +# `SearchTrackHits` [alias-SearchTrackHits] +```typescript type SearchTrackHits = boolean | [integer](./integer.md); -::: +``` diff --git a/docs/reference/api/SearchTransform.md b/docs/reference/api/SearchTransform.md index 0bab2bc10..8f908a16a 100644 --- a/docs/reference/api/SearchTransform.md +++ b/docs/reference/api/SearchTransform.md @@ -1,4 +1,4 @@ -## Interface `SearchTransform` +# `SearchTransform` [interface-SearchTransform] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchType.md b/docs/reference/api/SearchType.md index 665b1accb..b4b489558 100644 --- a/docs/reference/api/SearchType.md +++ b/docs/reference/api/SearchType.md @@ -1,4 +1,4 @@ -## `SearchType` -::: +# `SearchType` [alias-SearchType] +```typescript type SearchType = 'query_then_fetch' | 'dfs_query_then_fetch'; -::: +``` diff --git a/docs/reference/api/SearchableSnapshots.md b/docs/reference/api/SearchableSnapshots.md index 8a2206aaa..03bf0d46c 100644 --- a/docs/reference/api/SearchableSnapshots.md +++ b/docs/reference/api/SearchableSnapshots.md @@ -1,19 +1,19 @@ -## `SearchableSnapshots` +# `SearchableSnapshots` [class-SearchableSnapshots] -### Constructor +## Constructor -::: +```typescript new SearchableSnapshots(transport: [Transport](./Transport.md)); -::: +``` -### Properties +## Properties [class-properties-SearchableSnapshots] | Name | Type | Description | | - | - | - | | `acceptedParams` | Record |   | | `transport` | [Transport](./Transport.md) |   | -### Methods +## Methods [class-methods-SearchableSnapshots] | Name | Signature | Description | | - | - | - | diff --git a/docs/reference/api/SearchableSnapshotsCacheStatsNode.md b/docs/reference/api/SearchableSnapshotsCacheStatsNode.md index 9ec9b867a..da159c0b0 100644 --- a/docs/reference/api/SearchableSnapshotsCacheStatsNode.md +++ b/docs/reference/api/SearchableSnapshotsCacheStatsNode.md @@ -1,4 +1,4 @@ -## Interface `SearchableSnapshotsCacheStatsNode` +# `SearchableSnapshotsCacheStatsNode` [interface-SearchableSnapshotsCacheStatsNode] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchableSnapshotsCacheStatsRequest.md b/docs/reference/api/SearchableSnapshotsCacheStatsRequest.md index 7247e8803..689562b6d 100644 --- a/docs/reference/api/SearchableSnapshotsCacheStatsRequest.md +++ b/docs/reference/api/SearchableSnapshotsCacheStatsRequest.md @@ -1,4 +1,4 @@ -## Interface `SearchableSnapshotsCacheStatsRequest` +# `SearchableSnapshotsCacheStatsRequest` [interface-SearchableSnapshotsCacheStatsRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchableSnapshotsCacheStatsResponse.md b/docs/reference/api/SearchableSnapshotsCacheStatsResponse.md index c04eccaeb..2661e787e 100644 --- a/docs/reference/api/SearchableSnapshotsCacheStatsResponse.md +++ b/docs/reference/api/SearchableSnapshotsCacheStatsResponse.md @@ -1,4 +1,4 @@ -## Interface `SearchableSnapshotsCacheStatsResponse` +# `SearchableSnapshotsCacheStatsResponse` [interface-SearchableSnapshotsCacheStatsResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchableSnapshotsCacheStatsShared.md b/docs/reference/api/SearchableSnapshotsCacheStatsShared.md index 01f749fc5..f78fd2363 100644 --- a/docs/reference/api/SearchableSnapshotsCacheStatsShared.md +++ b/docs/reference/api/SearchableSnapshotsCacheStatsShared.md @@ -1,4 +1,4 @@ -## Interface `SearchableSnapshotsCacheStatsShared` +# `SearchableSnapshotsCacheStatsShared` [interface-SearchableSnapshotsCacheStatsShared] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchableSnapshotsClearCacheRequest.md b/docs/reference/api/SearchableSnapshotsClearCacheRequest.md index 7092fd609..56eea76d5 100644 --- a/docs/reference/api/SearchableSnapshotsClearCacheRequest.md +++ b/docs/reference/api/SearchableSnapshotsClearCacheRequest.md @@ -1,4 +1,4 @@ -## Interface `SearchableSnapshotsClearCacheRequest` +# `SearchableSnapshotsClearCacheRequest` [interface-SearchableSnapshotsClearCacheRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchableSnapshotsClearCacheResponse.md b/docs/reference/api/SearchableSnapshotsClearCacheResponse.md index e3c11f2e5..ae0e72c94 100644 --- a/docs/reference/api/SearchableSnapshotsClearCacheResponse.md +++ b/docs/reference/api/SearchableSnapshotsClearCacheResponse.md @@ -1,4 +1,4 @@ -## `SearchableSnapshotsClearCacheResponse` -::: +# `SearchableSnapshotsClearCacheResponse` [alias-SearchableSnapshotsClearCacheResponse] +```typescript type SearchableSnapshotsClearCacheResponse = any; -::: +``` diff --git a/docs/reference/api/SearchableSnapshotsMountMountedSnapshot.md b/docs/reference/api/SearchableSnapshotsMountMountedSnapshot.md index 8d474e222..e699f04a1 100644 --- a/docs/reference/api/SearchableSnapshotsMountMountedSnapshot.md +++ b/docs/reference/api/SearchableSnapshotsMountMountedSnapshot.md @@ -1,4 +1,4 @@ -## Interface `SearchableSnapshotsMountMountedSnapshot` +# `SearchableSnapshotsMountMountedSnapshot` [interface-SearchableSnapshotsMountMountedSnapshot] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchableSnapshotsMountRequest.md b/docs/reference/api/SearchableSnapshotsMountRequest.md index dcf8f2dac..f802096f7 100644 --- a/docs/reference/api/SearchableSnapshotsMountRequest.md +++ b/docs/reference/api/SearchableSnapshotsMountRequest.md @@ -1,4 +1,4 @@ -## Interface `SearchableSnapshotsMountRequest` +# `SearchableSnapshotsMountRequest` [interface-SearchableSnapshotsMountRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchableSnapshotsMountResponse.md b/docs/reference/api/SearchableSnapshotsMountResponse.md index 302da7ca4..33beef38d 100644 --- a/docs/reference/api/SearchableSnapshotsMountResponse.md +++ b/docs/reference/api/SearchableSnapshotsMountResponse.md @@ -1,4 +1,4 @@ -## Interface `SearchableSnapshotsMountResponse` +# `SearchableSnapshotsMountResponse` [interface-SearchableSnapshotsMountResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchableSnapshotsStatsLevel.md b/docs/reference/api/SearchableSnapshotsStatsLevel.md index 2e8c2e1e6..2f648736e 100644 --- a/docs/reference/api/SearchableSnapshotsStatsLevel.md +++ b/docs/reference/api/SearchableSnapshotsStatsLevel.md @@ -1,4 +1,4 @@ -## `SearchableSnapshotsStatsLevel` -::: +# `SearchableSnapshotsStatsLevel` [alias-SearchableSnapshotsStatsLevel] +```typescript type SearchableSnapshotsStatsLevel = 'cluster' | 'indices' | 'shards'; -::: +``` diff --git a/docs/reference/api/SearchableSnapshotsStatsRequest.md b/docs/reference/api/SearchableSnapshotsStatsRequest.md index ad5eede82..1bed37e64 100644 --- a/docs/reference/api/SearchableSnapshotsStatsRequest.md +++ b/docs/reference/api/SearchableSnapshotsStatsRequest.md @@ -1,4 +1,4 @@ -## Interface `SearchableSnapshotsStatsRequest` +# `SearchableSnapshotsStatsRequest` [interface-SearchableSnapshotsStatsRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SearchableSnapshotsStatsResponse.md b/docs/reference/api/SearchableSnapshotsStatsResponse.md index 73c033bc0..3127a7516 100644 --- a/docs/reference/api/SearchableSnapshotsStatsResponse.md +++ b/docs/reference/api/SearchableSnapshotsStatsResponse.md @@ -1,4 +1,4 @@ -## Interface `SearchableSnapshotsStatsResponse` +# `SearchableSnapshotsStatsResponse` [interface-SearchableSnapshotsStatsResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/Security.md b/docs/reference/api/Security.md index 656235072..0932f924d 100644 --- a/docs/reference/api/Security.md +++ b/docs/reference/api/Security.md @@ -1,19 +1,19 @@ -## `Security` +# `Security` [class-Security] -### Constructor +## Constructor -::: +```typescript new Security(transport: [Transport](./Transport.md)); -::: +``` -### Properties +## Properties [class-properties-Security] | Name | Type | Description | | - | - | - | | `acceptedParams` | Record |   | | `transport` | [Transport](./Transport.md) |   | -### Methods +## Methods [class-methods-Security] | Name | Signature | Description | | - | - | - | diff --git a/docs/reference/api/SecurityAccess.md b/docs/reference/api/SecurityAccess.md index 5196ea6f8..1ab42ea82 100644 --- a/docs/reference/api/SecurityAccess.md +++ b/docs/reference/api/SecurityAccess.md @@ -1,4 +1,4 @@ -## Interface `SecurityAccess` +# `SecurityAccess` [interface-SecurityAccess] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityActivateUserProfileRequest.md b/docs/reference/api/SecurityActivateUserProfileRequest.md index d0c8f40ca..412590d5d 100644 --- a/docs/reference/api/SecurityActivateUserProfileRequest.md +++ b/docs/reference/api/SecurityActivateUserProfileRequest.md @@ -1,4 +1,4 @@ -## Interface `SecurityActivateUserProfileRequest` +# `SecurityActivateUserProfileRequest` [interface-SecurityActivateUserProfileRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityActivateUserProfileResponse.md b/docs/reference/api/SecurityActivateUserProfileResponse.md index cf2554fd2..9a6777c61 100644 --- a/docs/reference/api/SecurityActivateUserProfileResponse.md +++ b/docs/reference/api/SecurityActivateUserProfileResponse.md @@ -1,4 +1,4 @@ -## `SecurityActivateUserProfileResponse` -::: +# `SecurityActivateUserProfileResponse` [alias-SecurityActivateUserProfileResponse] +```typescript type SecurityActivateUserProfileResponse = [SecurityUserProfileWithMetadata](./SecurityUserProfileWithMetadata.md); -::: +``` diff --git a/docs/reference/api/SecurityApiKey.md b/docs/reference/api/SecurityApiKey.md index e01c4ab12..02e0b81da 100644 --- a/docs/reference/api/SecurityApiKey.md +++ b/docs/reference/api/SecurityApiKey.md @@ -1,4 +1,4 @@ -## Interface `SecurityApiKey` +# `SecurityApiKey` [interface-SecurityApiKey] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityApiKeyType.md b/docs/reference/api/SecurityApiKeyType.md index 6298fec69..51edb1754 100644 --- a/docs/reference/api/SecurityApiKeyType.md +++ b/docs/reference/api/SecurityApiKeyType.md @@ -1,4 +1,4 @@ -## `SecurityApiKeyType` -::: +# `SecurityApiKeyType` [alias-SecurityApiKeyType] +```typescript type SecurityApiKeyType = 'rest' | 'cross_cluster'; -::: +``` diff --git a/docs/reference/api/SecurityApplicationGlobalUserPrivileges.md b/docs/reference/api/SecurityApplicationGlobalUserPrivileges.md index 52106df49..549c18c41 100644 --- a/docs/reference/api/SecurityApplicationGlobalUserPrivileges.md +++ b/docs/reference/api/SecurityApplicationGlobalUserPrivileges.md @@ -1,4 +1,4 @@ -## Interface `SecurityApplicationGlobalUserPrivileges` +# `SecurityApplicationGlobalUserPrivileges` [interface-SecurityApplicationGlobalUserPrivileges] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityApplicationPrivileges.md b/docs/reference/api/SecurityApplicationPrivileges.md index 48c651b97..d2f48c764 100644 --- a/docs/reference/api/SecurityApplicationPrivileges.md +++ b/docs/reference/api/SecurityApplicationPrivileges.md @@ -1,4 +1,4 @@ -## Interface `SecurityApplicationPrivileges` +# `SecurityApplicationPrivileges` [interface-SecurityApplicationPrivileges] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityAuthenticateAuthenticateApiKey.md b/docs/reference/api/SecurityAuthenticateAuthenticateApiKey.md index 5703126e4..60338da40 100644 --- a/docs/reference/api/SecurityAuthenticateAuthenticateApiKey.md +++ b/docs/reference/api/SecurityAuthenticateAuthenticateApiKey.md @@ -1,4 +1,4 @@ -## Interface `SecurityAuthenticateAuthenticateApiKey` +# `SecurityAuthenticateAuthenticateApiKey` [interface-SecurityAuthenticateAuthenticateApiKey] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityAuthenticateRequest.md b/docs/reference/api/SecurityAuthenticateRequest.md index 8b6765628..7337e9e34 100644 --- a/docs/reference/api/SecurityAuthenticateRequest.md +++ b/docs/reference/api/SecurityAuthenticateRequest.md @@ -1,4 +1,4 @@ -## Interface `SecurityAuthenticateRequest` +# `SecurityAuthenticateRequest` [interface-SecurityAuthenticateRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityAuthenticateResponse.md b/docs/reference/api/SecurityAuthenticateResponse.md index bc013f576..13355ecb7 100644 --- a/docs/reference/api/SecurityAuthenticateResponse.md +++ b/docs/reference/api/SecurityAuthenticateResponse.md @@ -1,4 +1,4 @@ -## Interface `SecurityAuthenticateResponse` +# `SecurityAuthenticateResponse` [interface-SecurityAuthenticateResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityAuthenticateToken.md b/docs/reference/api/SecurityAuthenticateToken.md index ffbe9bedb..0d4eb8954 100644 --- a/docs/reference/api/SecurityAuthenticateToken.md +++ b/docs/reference/api/SecurityAuthenticateToken.md @@ -1,4 +1,4 @@ -## Interface `SecurityAuthenticateToken` +# `SecurityAuthenticateToken` [interface-SecurityAuthenticateToken] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityBulkDeleteRoleRequest.md b/docs/reference/api/SecurityBulkDeleteRoleRequest.md index c8b6cb288..61c4d6998 100644 --- a/docs/reference/api/SecurityBulkDeleteRoleRequest.md +++ b/docs/reference/api/SecurityBulkDeleteRoleRequest.md @@ -1,4 +1,4 @@ -## Interface `SecurityBulkDeleteRoleRequest` +# `SecurityBulkDeleteRoleRequest` [interface-SecurityBulkDeleteRoleRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityBulkDeleteRoleResponse.md b/docs/reference/api/SecurityBulkDeleteRoleResponse.md index f8e5b1ff0..dd6456a1a 100644 --- a/docs/reference/api/SecurityBulkDeleteRoleResponse.md +++ b/docs/reference/api/SecurityBulkDeleteRoleResponse.md @@ -1,4 +1,4 @@ -## Interface `SecurityBulkDeleteRoleResponse` +# `SecurityBulkDeleteRoleResponse` [interface-SecurityBulkDeleteRoleResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityBulkError.md b/docs/reference/api/SecurityBulkError.md index 73208fcdf..7002c21b4 100644 --- a/docs/reference/api/SecurityBulkError.md +++ b/docs/reference/api/SecurityBulkError.md @@ -1,4 +1,4 @@ -## Interface `SecurityBulkError` +# `SecurityBulkError` [interface-SecurityBulkError] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityBulkPutRoleRequest.md b/docs/reference/api/SecurityBulkPutRoleRequest.md index e131903a7..4b948f603 100644 --- a/docs/reference/api/SecurityBulkPutRoleRequest.md +++ b/docs/reference/api/SecurityBulkPutRoleRequest.md @@ -1,4 +1,4 @@ -## Interface `SecurityBulkPutRoleRequest` +# `SecurityBulkPutRoleRequest` [interface-SecurityBulkPutRoleRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityBulkPutRoleResponse.md b/docs/reference/api/SecurityBulkPutRoleResponse.md index 229ab7afe..23f45b9e6 100644 --- a/docs/reference/api/SecurityBulkPutRoleResponse.md +++ b/docs/reference/api/SecurityBulkPutRoleResponse.md @@ -1,4 +1,4 @@ -## Interface `SecurityBulkPutRoleResponse` +# `SecurityBulkPutRoleResponse` [interface-SecurityBulkPutRoleResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityBulkUpdateApiKeysRequest.md b/docs/reference/api/SecurityBulkUpdateApiKeysRequest.md index 37c12a7b7..62f98f0e1 100644 --- a/docs/reference/api/SecurityBulkUpdateApiKeysRequest.md +++ b/docs/reference/api/SecurityBulkUpdateApiKeysRequest.md @@ -1,4 +1,4 @@ -## Interface `SecurityBulkUpdateApiKeysRequest` +# `SecurityBulkUpdateApiKeysRequest` [interface-SecurityBulkUpdateApiKeysRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityBulkUpdateApiKeysResponse.md b/docs/reference/api/SecurityBulkUpdateApiKeysResponse.md index a42496199..1696cc0ea 100644 --- a/docs/reference/api/SecurityBulkUpdateApiKeysResponse.md +++ b/docs/reference/api/SecurityBulkUpdateApiKeysResponse.md @@ -1,4 +1,4 @@ -## Interface `SecurityBulkUpdateApiKeysResponse` +# `SecurityBulkUpdateApiKeysResponse` [interface-SecurityBulkUpdateApiKeysResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityChangePasswordRequest.md b/docs/reference/api/SecurityChangePasswordRequest.md index ab1d8b22b..80b728d98 100644 --- a/docs/reference/api/SecurityChangePasswordRequest.md +++ b/docs/reference/api/SecurityChangePasswordRequest.md @@ -1,4 +1,4 @@ -## Interface `SecurityChangePasswordRequest` +# `SecurityChangePasswordRequest` [interface-SecurityChangePasswordRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityChangePasswordResponse.md b/docs/reference/api/SecurityChangePasswordResponse.md index efa8fd32e..5582af96d 100644 --- a/docs/reference/api/SecurityChangePasswordResponse.md +++ b/docs/reference/api/SecurityChangePasswordResponse.md @@ -1,4 +1,4 @@ -## Interface `SecurityChangePasswordResponse` +# `SecurityChangePasswordResponse` [interface-SecurityChangePasswordResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityClearApiKeyCacheRequest.md b/docs/reference/api/SecurityClearApiKeyCacheRequest.md index 236b50450..2d84ab3c5 100644 --- a/docs/reference/api/SecurityClearApiKeyCacheRequest.md +++ b/docs/reference/api/SecurityClearApiKeyCacheRequest.md @@ -1,4 +1,4 @@ -## Interface `SecurityClearApiKeyCacheRequest` +# `SecurityClearApiKeyCacheRequest` [interface-SecurityClearApiKeyCacheRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityClearApiKeyCacheResponse.md b/docs/reference/api/SecurityClearApiKeyCacheResponse.md index 99095dbb0..937e7a1fa 100644 --- a/docs/reference/api/SecurityClearApiKeyCacheResponse.md +++ b/docs/reference/api/SecurityClearApiKeyCacheResponse.md @@ -1,4 +1,4 @@ -## Interface `SecurityClearApiKeyCacheResponse` +# `SecurityClearApiKeyCacheResponse` [interface-SecurityClearApiKeyCacheResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityClearCachedPrivilegesRequest.md b/docs/reference/api/SecurityClearCachedPrivilegesRequest.md index 0e5e72f77..f79a21c7e 100644 --- a/docs/reference/api/SecurityClearCachedPrivilegesRequest.md +++ b/docs/reference/api/SecurityClearCachedPrivilegesRequest.md @@ -1,4 +1,4 @@ -## Interface `SecurityClearCachedPrivilegesRequest` +# `SecurityClearCachedPrivilegesRequest` [interface-SecurityClearCachedPrivilegesRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityClearCachedPrivilegesResponse.md b/docs/reference/api/SecurityClearCachedPrivilegesResponse.md index 472761116..48d950702 100644 --- a/docs/reference/api/SecurityClearCachedPrivilegesResponse.md +++ b/docs/reference/api/SecurityClearCachedPrivilegesResponse.md @@ -1,4 +1,4 @@ -## Interface `SecurityClearCachedPrivilegesResponse` +# `SecurityClearCachedPrivilegesResponse` [interface-SecurityClearCachedPrivilegesResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityClearCachedRealmsRequest.md b/docs/reference/api/SecurityClearCachedRealmsRequest.md index bdcc14a31..cc16ecad1 100644 --- a/docs/reference/api/SecurityClearCachedRealmsRequest.md +++ b/docs/reference/api/SecurityClearCachedRealmsRequest.md @@ -1,4 +1,4 @@ -## Interface `SecurityClearCachedRealmsRequest` +# `SecurityClearCachedRealmsRequest` [interface-SecurityClearCachedRealmsRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityClearCachedRealmsResponse.md b/docs/reference/api/SecurityClearCachedRealmsResponse.md index 64b3e094d..d0452192f 100644 --- a/docs/reference/api/SecurityClearCachedRealmsResponse.md +++ b/docs/reference/api/SecurityClearCachedRealmsResponse.md @@ -1,4 +1,4 @@ -## Interface `SecurityClearCachedRealmsResponse` +# `SecurityClearCachedRealmsResponse` [interface-SecurityClearCachedRealmsResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityClearCachedRolesRequest.md b/docs/reference/api/SecurityClearCachedRolesRequest.md index 72274375f..eaf5850e1 100644 --- a/docs/reference/api/SecurityClearCachedRolesRequest.md +++ b/docs/reference/api/SecurityClearCachedRolesRequest.md @@ -1,4 +1,4 @@ -## Interface `SecurityClearCachedRolesRequest` +# `SecurityClearCachedRolesRequest` [interface-SecurityClearCachedRolesRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityClearCachedRolesResponse.md b/docs/reference/api/SecurityClearCachedRolesResponse.md index 06b060158..9fbfc2b81 100644 --- a/docs/reference/api/SecurityClearCachedRolesResponse.md +++ b/docs/reference/api/SecurityClearCachedRolesResponse.md @@ -1,4 +1,4 @@ -## Interface `SecurityClearCachedRolesResponse` +# `SecurityClearCachedRolesResponse` [interface-SecurityClearCachedRolesResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityClearCachedServiceTokensRequest.md b/docs/reference/api/SecurityClearCachedServiceTokensRequest.md index 39f83b678..2e68f0042 100644 --- a/docs/reference/api/SecurityClearCachedServiceTokensRequest.md +++ b/docs/reference/api/SecurityClearCachedServiceTokensRequest.md @@ -1,4 +1,4 @@ -## Interface `SecurityClearCachedServiceTokensRequest` +# `SecurityClearCachedServiceTokensRequest` [interface-SecurityClearCachedServiceTokensRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityClearCachedServiceTokensResponse.md b/docs/reference/api/SecurityClearCachedServiceTokensResponse.md index 1abb07ce0..e59de923c 100644 --- a/docs/reference/api/SecurityClearCachedServiceTokensResponse.md +++ b/docs/reference/api/SecurityClearCachedServiceTokensResponse.md @@ -1,4 +1,4 @@ -## Interface `SecurityClearCachedServiceTokensResponse` +# `SecurityClearCachedServiceTokensResponse` [interface-SecurityClearCachedServiceTokensResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityClusterNode.md b/docs/reference/api/SecurityClusterNode.md index 20882bf9d..47251c9f8 100644 --- a/docs/reference/api/SecurityClusterNode.md +++ b/docs/reference/api/SecurityClusterNode.md @@ -1,4 +1,4 @@ -## Interface `SecurityClusterNode` +# `SecurityClusterNode` [interface-SecurityClusterNode] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityClusterPrivilege.md b/docs/reference/api/SecurityClusterPrivilege.md index 6a937aeda..c4df46448 100644 --- a/docs/reference/api/SecurityClusterPrivilege.md +++ b/docs/reference/api/SecurityClusterPrivilege.md @@ -1,4 +1,4 @@ -## `SecurityClusterPrivilege` -::: +# `SecurityClusterPrivilege` [alias-SecurityClusterPrivilege] +```typescript type SecurityClusterPrivilege = 'all' | 'cancel_task' | 'create_snapshot' | 'cross_cluster_replication' | 'cross_cluster_search' | 'delegate_pki' | 'grant_api_key' | 'manage' | 'manage_api_key' | 'manage_autoscaling' | 'manage_behavioral_analytics' | 'manage_ccr' | 'manage_data_frame_transforms' | 'manage_data_stream_global_retention' | 'manage_enrich' | 'manage_esql' | 'manage_ilm' | 'manage_index_templates' | 'manage_inference' | 'manage_ingest_pipelines' | 'manage_logstash_pipelines' | 'manage_ml' | 'manage_oidc' | 'manage_own_api_key' | 'manage_pipeline' | 'manage_rollup' | 'manage_saml' | 'manage_search_application' | 'manage_search_query_rules' | 'manage_search_synonyms' | 'manage_security' | 'manage_service_account' | 'manage_slm' | 'manage_token' | 'manage_transform' | 'manage_user_profile' | 'manage_watcher' | 'monitor' | 'monitor_data_frame_transforms' | 'monitor_data_stream_global_retention' | 'monitor_enrich' | 'monitor_esql' | 'monitor_inference' | 'monitor_ml' | 'monitor_rollup' | 'monitor_snapshot' | 'monitor_stats' | 'monitor_text_structure' | 'monitor_transform' | 'monitor_watcher' | 'none' | 'post_behavioral_analytics_event' | 'read_ccr' | 'read_fleet_secrets' | 'read_ilm' | 'read_pipeline' | 'read_security' | 'read_slm' | 'transport_client' | 'write_connector_secrets' | 'write_fleet_secrets' | string; -::: +``` diff --git a/docs/reference/api/SecurityCreateApiKeyRequest.md b/docs/reference/api/SecurityCreateApiKeyRequest.md index 47c2a4585..24a8efeea 100644 --- a/docs/reference/api/SecurityCreateApiKeyRequest.md +++ b/docs/reference/api/SecurityCreateApiKeyRequest.md @@ -1,4 +1,4 @@ -## Interface `SecurityCreateApiKeyRequest` +# `SecurityCreateApiKeyRequest` [interface-SecurityCreateApiKeyRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityCreateApiKeyResponse.md b/docs/reference/api/SecurityCreateApiKeyResponse.md index c24a640ea..b02fe301c 100644 --- a/docs/reference/api/SecurityCreateApiKeyResponse.md +++ b/docs/reference/api/SecurityCreateApiKeyResponse.md @@ -1,4 +1,4 @@ -## Interface `SecurityCreateApiKeyResponse` +# `SecurityCreateApiKeyResponse` [interface-SecurityCreateApiKeyResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityCreateCrossClusterApiKeyRequest.md b/docs/reference/api/SecurityCreateCrossClusterApiKeyRequest.md index 8bdb0ced0..51e13c6cf 100644 --- a/docs/reference/api/SecurityCreateCrossClusterApiKeyRequest.md +++ b/docs/reference/api/SecurityCreateCrossClusterApiKeyRequest.md @@ -1,4 +1,4 @@ -## Interface `SecurityCreateCrossClusterApiKeyRequest` +# `SecurityCreateCrossClusterApiKeyRequest` [interface-SecurityCreateCrossClusterApiKeyRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityCreateCrossClusterApiKeyResponse.md b/docs/reference/api/SecurityCreateCrossClusterApiKeyResponse.md index ec2450fe2..ca2284944 100644 --- a/docs/reference/api/SecurityCreateCrossClusterApiKeyResponse.md +++ b/docs/reference/api/SecurityCreateCrossClusterApiKeyResponse.md @@ -1,4 +1,4 @@ -## Interface `SecurityCreateCrossClusterApiKeyResponse` +# `SecurityCreateCrossClusterApiKeyResponse` [interface-SecurityCreateCrossClusterApiKeyResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityCreateServiceTokenRequest.md b/docs/reference/api/SecurityCreateServiceTokenRequest.md index 72a708b99..b7d807d6b 100644 --- a/docs/reference/api/SecurityCreateServiceTokenRequest.md +++ b/docs/reference/api/SecurityCreateServiceTokenRequest.md @@ -1,4 +1,4 @@ -## Interface `SecurityCreateServiceTokenRequest` +# `SecurityCreateServiceTokenRequest` [interface-SecurityCreateServiceTokenRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityCreateServiceTokenResponse.md b/docs/reference/api/SecurityCreateServiceTokenResponse.md index 1a5b0e477..f83ef5249 100644 --- a/docs/reference/api/SecurityCreateServiceTokenResponse.md +++ b/docs/reference/api/SecurityCreateServiceTokenResponse.md @@ -1,4 +1,4 @@ -## Interface `SecurityCreateServiceTokenResponse` +# `SecurityCreateServiceTokenResponse` [interface-SecurityCreateServiceTokenResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityCreateServiceTokenToken.md b/docs/reference/api/SecurityCreateServiceTokenToken.md index fd5ea71b7..d95242bf0 100644 --- a/docs/reference/api/SecurityCreateServiceTokenToken.md +++ b/docs/reference/api/SecurityCreateServiceTokenToken.md @@ -1,4 +1,4 @@ -## Interface `SecurityCreateServiceTokenToken` +# `SecurityCreateServiceTokenToken` [interface-SecurityCreateServiceTokenToken] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityCreatedStatus.md b/docs/reference/api/SecurityCreatedStatus.md index 63e128c95..bf5d0e41d 100644 --- a/docs/reference/api/SecurityCreatedStatus.md +++ b/docs/reference/api/SecurityCreatedStatus.md @@ -1,4 +1,4 @@ -## Interface `SecurityCreatedStatus` +# `SecurityCreatedStatus` [interface-SecurityCreatedStatus] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityDelegatePkiAuthentication.md b/docs/reference/api/SecurityDelegatePkiAuthentication.md index 8ab735e7c..7c9f6d9e2 100644 --- a/docs/reference/api/SecurityDelegatePkiAuthentication.md +++ b/docs/reference/api/SecurityDelegatePkiAuthentication.md @@ -1,4 +1,4 @@ -## Interface `SecurityDelegatePkiAuthentication` +# `SecurityDelegatePkiAuthentication` [interface-SecurityDelegatePkiAuthentication] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityDelegatePkiAuthenticationRealm.md b/docs/reference/api/SecurityDelegatePkiAuthenticationRealm.md index 25a2dfa7e..96c4eec28 100644 --- a/docs/reference/api/SecurityDelegatePkiAuthenticationRealm.md +++ b/docs/reference/api/SecurityDelegatePkiAuthenticationRealm.md @@ -1,4 +1,4 @@ -## Interface `SecurityDelegatePkiAuthenticationRealm` +# `SecurityDelegatePkiAuthenticationRealm` [interface-SecurityDelegatePkiAuthenticationRealm] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityDelegatePkiRequest.md b/docs/reference/api/SecurityDelegatePkiRequest.md index 2a5c88e1c..65c8d10f7 100644 --- a/docs/reference/api/SecurityDelegatePkiRequest.md +++ b/docs/reference/api/SecurityDelegatePkiRequest.md @@ -1,4 +1,4 @@ -## Interface `SecurityDelegatePkiRequest` +# `SecurityDelegatePkiRequest` [interface-SecurityDelegatePkiRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityDelegatePkiResponse.md b/docs/reference/api/SecurityDelegatePkiResponse.md index 2bda5484c..fe766f40f 100644 --- a/docs/reference/api/SecurityDelegatePkiResponse.md +++ b/docs/reference/api/SecurityDelegatePkiResponse.md @@ -1,4 +1,4 @@ -## Interface `SecurityDelegatePkiResponse` +# `SecurityDelegatePkiResponse` [interface-SecurityDelegatePkiResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityDeletePrivilegesFoundStatus.md b/docs/reference/api/SecurityDeletePrivilegesFoundStatus.md index 63942c07e..e3bbaaa4d 100644 --- a/docs/reference/api/SecurityDeletePrivilegesFoundStatus.md +++ b/docs/reference/api/SecurityDeletePrivilegesFoundStatus.md @@ -1,4 +1,4 @@ -## Interface `SecurityDeletePrivilegesFoundStatus` +# `SecurityDeletePrivilegesFoundStatus` [interface-SecurityDeletePrivilegesFoundStatus] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityDeletePrivilegesRequest.md b/docs/reference/api/SecurityDeletePrivilegesRequest.md index 16997f665..e4f6ea7fa 100644 --- a/docs/reference/api/SecurityDeletePrivilegesRequest.md +++ b/docs/reference/api/SecurityDeletePrivilegesRequest.md @@ -1,4 +1,4 @@ -## Interface `SecurityDeletePrivilegesRequest` +# `SecurityDeletePrivilegesRequest` [interface-SecurityDeletePrivilegesRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityDeletePrivilegesResponse.md b/docs/reference/api/SecurityDeletePrivilegesResponse.md index dff9ed9ad..6e55e2cca 100644 --- a/docs/reference/api/SecurityDeletePrivilegesResponse.md +++ b/docs/reference/api/SecurityDeletePrivilegesResponse.md @@ -1,4 +1,4 @@ -## `SecurityDeletePrivilegesResponse` -::: +# `SecurityDeletePrivilegesResponse` [alias-SecurityDeletePrivilegesResponse] +```typescript type SecurityDeletePrivilegesResponse = Record>; -::: +``` diff --git a/docs/reference/api/SecurityDeleteRoleMappingRequest.md b/docs/reference/api/SecurityDeleteRoleMappingRequest.md index d959220e6..c6e4e0831 100644 --- a/docs/reference/api/SecurityDeleteRoleMappingRequest.md +++ b/docs/reference/api/SecurityDeleteRoleMappingRequest.md @@ -1,4 +1,4 @@ -## Interface `SecurityDeleteRoleMappingRequest` +# `SecurityDeleteRoleMappingRequest` [interface-SecurityDeleteRoleMappingRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityDeleteRoleMappingResponse.md b/docs/reference/api/SecurityDeleteRoleMappingResponse.md index abda2b2da..db2af5a9e 100644 --- a/docs/reference/api/SecurityDeleteRoleMappingResponse.md +++ b/docs/reference/api/SecurityDeleteRoleMappingResponse.md @@ -1,4 +1,4 @@ -## Interface `SecurityDeleteRoleMappingResponse` +# `SecurityDeleteRoleMappingResponse` [interface-SecurityDeleteRoleMappingResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityDeleteRoleRequest.md b/docs/reference/api/SecurityDeleteRoleRequest.md index 71ebfe14b..d37adda27 100644 --- a/docs/reference/api/SecurityDeleteRoleRequest.md +++ b/docs/reference/api/SecurityDeleteRoleRequest.md @@ -1,4 +1,4 @@ -## Interface `SecurityDeleteRoleRequest` +# `SecurityDeleteRoleRequest` [interface-SecurityDeleteRoleRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityDeleteRoleResponse.md b/docs/reference/api/SecurityDeleteRoleResponse.md index 7d7908fd1..b6b012325 100644 --- a/docs/reference/api/SecurityDeleteRoleResponse.md +++ b/docs/reference/api/SecurityDeleteRoleResponse.md @@ -1,4 +1,4 @@ -## Interface `SecurityDeleteRoleResponse` +# `SecurityDeleteRoleResponse` [interface-SecurityDeleteRoleResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityDeleteServiceTokenRequest.md b/docs/reference/api/SecurityDeleteServiceTokenRequest.md index ac776cf4f..f251d03b5 100644 --- a/docs/reference/api/SecurityDeleteServiceTokenRequest.md +++ b/docs/reference/api/SecurityDeleteServiceTokenRequest.md @@ -1,4 +1,4 @@ -## Interface `SecurityDeleteServiceTokenRequest` +# `SecurityDeleteServiceTokenRequest` [interface-SecurityDeleteServiceTokenRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityDeleteServiceTokenResponse.md b/docs/reference/api/SecurityDeleteServiceTokenResponse.md index dd3845caf..dc52d2601 100644 --- a/docs/reference/api/SecurityDeleteServiceTokenResponse.md +++ b/docs/reference/api/SecurityDeleteServiceTokenResponse.md @@ -1,4 +1,4 @@ -## Interface `SecurityDeleteServiceTokenResponse` +# `SecurityDeleteServiceTokenResponse` [interface-SecurityDeleteServiceTokenResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityDeleteUserRequest.md b/docs/reference/api/SecurityDeleteUserRequest.md index 092be02ec..b164e6ed3 100644 --- a/docs/reference/api/SecurityDeleteUserRequest.md +++ b/docs/reference/api/SecurityDeleteUserRequest.md @@ -1,4 +1,4 @@ -## Interface `SecurityDeleteUserRequest` +# `SecurityDeleteUserRequest` [interface-SecurityDeleteUserRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityDeleteUserResponse.md b/docs/reference/api/SecurityDeleteUserResponse.md index bf62d879e..938e04dfb 100644 --- a/docs/reference/api/SecurityDeleteUserResponse.md +++ b/docs/reference/api/SecurityDeleteUserResponse.md @@ -1,4 +1,4 @@ -## Interface `SecurityDeleteUserResponse` +# `SecurityDeleteUserResponse` [interface-SecurityDeleteUserResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityDisableUserProfileRequest.md b/docs/reference/api/SecurityDisableUserProfileRequest.md index 87140a2e1..2265df145 100644 --- a/docs/reference/api/SecurityDisableUserProfileRequest.md +++ b/docs/reference/api/SecurityDisableUserProfileRequest.md @@ -1,4 +1,4 @@ -## Interface `SecurityDisableUserProfileRequest` +# `SecurityDisableUserProfileRequest` [interface-SecurityDisableUserProfileRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityDisableUserProfileResponse.md b/docs/reference/api/SecurityDisableUserProfileResponse.md index 01be19a63..3766f8633 100644 --- a/docs/reference/api/SecurityDisableUserProfileResponse.md +++ b/docs/reference/api/SecurityDisableUserProfileResponse.md @@ -1,4 +1,4 @@ -## `SecurityDisableUserProfileResponse` -::: +# `SecurityDisableUserProfileResponse` [alias-SecurityDisableUserProfileResponse] +```typescript type SecurityDisableUserProfileResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); -::: +``` diff --git a/docs/reference/api/SecurityDisableUserRequest.md b/docs/reference/api/SecurityDisableUserRequest.md index 92025ec8a..b500c1b19 100644 --- a/docs/reference/api/SecurityDisableUserRequest.md +++ b/docs/reference/api/SecurityDisableUserRequest.md @@ -1,4 +1,4 @@ -## Interface `SecurityDisableUserRequest` +# `SecurityDisableUserRequest` [interface-SecurityDisableUserRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityDisableUserResponse.md b/docs/reference/api/SecurityDisableUserResponse.md index d70e5a227..b5ad47e7e 100644 --- a/docs/reference/api/SecurityDisableUserResponse.md +++ b/docs/reference/api/SecurityDisableUserResponse.md @@ -1,4 +1,4 @@ -## Interface `SecurityDisableUserResponse` +# `SecurityDisableUserResponse` [interface-SecurityDisableUserResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityEnableUserProfileRequest.md b/docs/reference/api/SecurityEnableUserProfileRequest.md index 207482225..1a282801c 100644 --- a/docs/reference/api/SecurityEnableUserProfileRequest.md +++ b/docs/reference/api/SecurityEnableUserProfileRequest.md @@ -1,4 +1,4 @@ -## Interface `SecurityEnableUserProfileRequest` +# `SecurityEnableUserProfileRequest` [interface-SecurityEnableUserProfileRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityEnableUserProfileResponse.md b/docs/reference/api/SecurityEnableUserProfileResponse.md index 9b8f9482b..9491d7faa 100644 --- a/docs/reference/api/SecurityEnableUserProfileResponse.md +++ b/docs/reference/api/SecurityEnableUserProfileResponse.md @@ -1,4 +1,4 @@ -## `SecurityEnableUserProfileResponse` -::: +# `SecurityEnableUserProfileResponse` [alias-SecurityEnableUserProfileResponse] +```typescript type SecurityEnableUserProfileResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); -::: +``` diff --git a/docs/reference/api/SecurityEnableUserRequest.md b/docs/reference/api/SecurityEnableUserRequest.md index 5f62dead9..1e862d8b2 100644 --- a/docs/reference/api/SecurityEnableUserRequest.md +++ b/docs/reference/api/SecurityEnableUserRequest.md @@ -1,4 +1,4 @@ -## Interface `SecurityEnableUserRequest` +# `SecurityEnableUserRequest` [interface-SecurityEnableUserRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityEnableUserResponse.md b/docs/reference/api/SecurityEnableUserResponse.md index 1756bdc38..bffa6b8d9 100644 --- a/docs/reference/api/SecurityEnableUserResponse.md +++ b/docs/reference/api/SecurityEnableUserResponse.md @@ -1,4 +1,4 @@ -## Interface `SecurityEnableUserResponse` +# `SecurityEnableUserResponse` [interface-SecurityEnableUserResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityEnrollKibanaRequest.md b/docs/reference/api/SecurityEnrollKibanaRequest.md index 183ebd629..28c12dd24 100644 --- a/docs/reference/api/SecurityEnrollKibanaRequest.md +++ b/docs/reference/api/SecurityEnrollKibanaRequest.md @@ -1,4 +1,4 @@ -## Interface `SecurityEnrollKibanaRequest` +# `SecurityEnrollKibanaRequest` [interface-SecurityEnrollKibanaRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityEnrollKibanaResponse.md b/docs/reference/api/SecurityEnrollKibanaResponse.md index 6719c5341..5fd1ec23d 100644 --- a/docs/reference/api/SecurityEnrollKibanaResponse.md +++ b/docs/reference/api/SecurityEnrollKibanaResponse.md @@ -1,4 +1,4 @@ -## Interface `SecurityEnrollKibanaResponse` +# `SecurityEnrollKibanaResponse` [interface-SecurityEnrollKibanaResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityEnrollKibanaToken.md b/docs/reference/api/SecurityEnrollKibanaToken.md index 25882bac2..fda23064a 100644 --- a/docs/reference/api/SecurityEnrollKibanaToken.md +++ b/docs/reference/api/SecurityEnrollKibanaToken.md @@ -1,4 +1,4 @@ -## Interface `SecurityEnrollKibanaToken` +# `SecurityEnrollKibanaToken` [interface-SecurityEnrollKibanaToken] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityEnrollNodeRequest.md b/docs/reference/api/SecurityEnrollNodeRequest.md index 2ad881402..2144ae9e8 100644 --- a/docs/reference/api/SecurityEnrollNodeRequest.md +++ b/docs/reference/api/SecurityEnrollNodeRequest.md @@ -1,4 +1,4 @@ -## Interface `SecurityEnrollNodeRequest` +# `SecurityEnrollNodeRequest` [interface-SecurityEnrollNodeRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityEnrollNodeResponse.md b/docs/reference/api/SecurityEnrollNodeResponse.md index 6f3e38f17..4c98ec6e2 100644 --- a/docs/reference/api/SecurityEnrollNodeResponse.md +++ b/docs/reference/api/SecurityEnrollNodeResponse.md @@ -1,4 +1,4 @@ -## Interface `SecurityEnrollNodeResponse` +# `SecurityEnrollNodeResponse` [interface-SecurityEnrollNodeResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityFieldSecurity.md b/docs/reference/api/SecurityFieldSecurity.md index 6cdf2d0cd..53f4d3194 100644 --- a/docs/reference/api/SecurityFieldSecurity.md +++ b/docs/reference/api/SecurityFieldSecurity.md @@ -1,4 +1,4 @@ -## Interface `SecurityFieldSecurity` +# `SecurityFieldSecurity` [interface-SecurityFieldSecurity] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityGetApiKeyRequest.md b/docs/reference/api/SecurityGetApiKeyRequest.md index fa424f512..1d511cc0f 100644 --- a/docs/reference/api/SecurityGetApiKeyRequest.md +++ b/docs/reference/api/SecurityGetApiKeyRequest.md @@ -1,4 +1,4 @@ -## Interface `SecurityGetApiKeyRequest` +# `SecurityGetApiKeyRequest` [interface-SecurityGetApiKeyRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityGetApiKeyResponse.md b/docs/reference/api/SecurityGetApiKeyResponse.md index 1d54a47a5..46b95cc54 100644 --- a/docs/reference/api/SecurityGetApiKeyResponse.md +++ b/docs/reference/api/SecurityGetApiKeyResponse.md @@ -1,4 +1,4 @@ -## Interface `SecurityGetApiKeyResponse` +# `SecurityGetApiKeyResponse` [interface-SecurityGetApiKeyResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityGetBuiltinPrivilegesRequest.md b/docs/reference/api/SecurityGetBuiltinPrivilegesRequest.md index 450bb4fcc..fa2006309 100644 --- a/docs/reference/api/SecurityGetBuiltinPrivilegesRequest.md +++ b/docs/reference/api/SecurityGetBuiltinPrivilegesRequest.md @@ -1,4 +1,4 @@ -## Interface `SecurityGetBuiltinPrivilegesRequest` +# `SecurityGetBuiltinPrivilegesRequest` [interface-SecurityGetBuiltinPrivilegesRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityGetBuiltinPrivilegesResponse.md b/docs/reference/api/SecurityGetBuiltinPrivilegesResponse.md index 3eab4f3a0..7f0bae93f 100644 --- a/docs/reference/api/SecurityGetBuiltinPrivilegesResponse.md +++ b/docs/reference/api/SecurityGetBuiltinPrivilegesResponse.md @@ -1,4 +1,4 @@ -## Interface `SecurityGetBuiltinPrivilegesResponse` +# `SecurityGetBuiltinPrivilegesResponse` [interface-SecurityGetBuiltinPrivilegesResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityGetPrivilegesRequest.md b/docs/reference/api/SecurityGetPrivilegesRequest.md index 72f490174..fd58598ca 100644 --- a/docs/reference/api/SecurityGetPrivilegesRequest.md +++ b/docs/reference/api/SecurityGetPrivilegesRequest.md @@ -1,4 +1,4 @@ -## Interface `SecurityGetPrivilegesRequest` +# `SecurityGetPrivilegesRequest` [interface-SecurityGetPrivilegesRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityGetPrivilegesResponse.md b/docs/reference/api/SecurityGetPrivilegesResponse.md index e5c3525da..eadd8edeb 100644 --- a/docs/reference/api/SecurityGetPrivilegesResponse.md +++ b/docs/reference/api/SecurityGetPrivilegesResponse.md @@ -1,4 +1,4 @@ -## `SecurityGetPrivilegesResponse` -::: +# `SecurityGetPrivilegesResponse` [alias-SecurityGetPrivilegesResponse] +```typescript type SecurityGetPrivilegesResponse = Record>; -::: +``` diff --git a/docs/reference/api/SecurityGetRoleMappingRequest.md b/docs/reference/api/SecurityGetRoleMappingRequest.md index 7c6c8eac9..201743de5 100644 --- a/docs/reference/api/SecurityGetRoleMappingRequest.md +++ b/docs/reference/api/SecurityGetRoleMappingRequest.md @@ -1,4 +1,4 @@ -## Interface `SecurityGetRoleMappingRequest` +# `SecurityGetRoleMappingRequest` [interface-SecurityGetRoleMappingRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityGetRoleMappingResponse.md b/docs/reference/api/SecurityGetRoleMappingResponse.md index ba0e06812..398661eec 100644 --- a/docs/reference/api/SecurityGetRoleMappingResponse.md +++ b/docs/reference/api/SecurityGetRoleMappingResponse.md @@ -1,4 +1,4 @@ -## `SecurityGetRoleMappingResponse` -::: +# `SecurityGetRoleMappingResponse` [alias-SecurityGetRoleMappingResponse] +```typescript type SecurityGetRoleMappingResponse = Record; -::: +``` diff --git a/docs/reference/api/SecurityGetRoleRequest.md b/docs/reference/api/SecurityGetRoleRequest.md index feeef77d9..e207788d4 100644 --- a/docs/reference/api/SecurityGetRoleRequest.md +++ b/docs/reference/api/SecurityGetRoleRequest.md @@ -1,4 +1,4 @@ -## Interface `SecurityGetRoleRequest` +# `SecurityGetRoleRequest` [interface-SecurityGetRoleRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityGetRoleResponse.md b/docs/reference/api/SecurityGetRoleResponse.md index ec3f4bf64..91bee584a 100644 --- a/docs/reference/api/SecurityGetRoleResponse.md +++ b/docs/reference/api/SecurityGetRoleResponse.md @@ -1,4 +1,4 @@ -## `SecurityGetRoleResponse` -::: +# `SecurityGetRoleResponse` [alias-SecurityGetRoleResponse] +```typescript type SecurityGetRoleResponse = Record; -::: +``` diff --git a/docs/reference/api/SecurityGetRoleRole.md b/docs/reference/api/SecurityGetRoleRole.md index 27c3132a6..1d5cdfa63 100644 --- a/docs/reference/api/SecurityGetRoleRole.md +++ b/docs/reference/api/SecurityGetRoleRole.md @@ -1,4 +1,4 @@ -## Interface `SecurityGetRoleRole` +# `SecurityGetRoleRole` [interface-SecurityGetRoleRole] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityGetServiceAccountsRequest.md b/docs/reference/api/SecurityGetServiceAccountsRequest.md index a59284442..ecf355def 100644 --- a/docs/reference/api/SecurityGetServiceAccountsRequest.md +++ b/docs/reference/api/SecurityGetServiceAccountsRequest.md @@ -1,4 +1,4 @@ -## Interface `SecurityGetServiceAccountsRequest` +# `SecurityGetServiceAccountsRequest` [interface-SecurityGetServiceAccountsRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityGetServiceAccountsResponse.md b/docs/reference/api/SecurityGetServiceAccountsResponse.md index ac878b1b5..edf9ffb83 100644 --- a/docs/reference/api/SecurityGetServiceAccountsResponse.md +++ b/docs/reference/api/SecurityGetServiceAccountsResponse.md @@ -1,4 +1,4 @@ -## `SecurityGetServiceAccountsResponse` -::: +# `SecurityGetServiceAccountsResponse` [alias-SecurityGetServiceAccountsResponse] +```typescript type SecurityGetServiceAccountsResponse = Record; -::: +``` diff --git a/docs/reference/api/SecurityGetServiceAccountsRoleDescriptorWrapper.md b/docs/reference/api/SecurityGetServiceAccountsRoleDescriptorWrapper.md index 625a013bc..0d7f1f9cf 100644 --- a/docs/reference/api/SecurityGetServiceAccountsRoleDescriptorWrapper.md +++ b/docs/reference/api/SecurityGetServiceAccountsRoleDescriptorWrapper.md @@ -1,4 +1,4 @@ -## Interface `SecurityGetServiceAccountsRoleDescriptorWrapper` +# `SecurityGetServiceAccountsRoleDescriptorWrapper` [interface-SecurityGetServiceAccountsRoleDescriptorWrapper] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityGetServiceCredentialsNodesCredentials.md b/docs/reference/api/SecurityGetServiceCredentialsNodesCredentials.md index 1ef48e23a..27747cd5d 100644 --- a/docs/reference/api/SecurityGetServiceCredentialsNodesCredentials.md +++ b/docs/reference/api/SecurityGetServiceCredentialsNodesCredentials.md @@ -1,4 +1,4 @@ -## Interface `SecurityGetServiceCredentialsNodesCredentials` +# `SecurityGetServiceCredentialsNodesCredentials` [interface-SecurityGetServiceCredentialsNodesCredentials] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityGetServiceCredentialsNodesCredentialsFileToken.md b/docs/reference/api/SecurityGetServiceCredentialsNodesCredentialsFileToken.md index 1520e6ae8..5a084ea65 100644 --- a/docs/reference/api/SecurityGetServiceCredentialsNodesCredentialsFileToken.md +++ b/docs/reference/api/SecurityGetServiceCredentialsNodesCredentialsFileToken.md @@ -1,4 +1,4 @@ -## Interface `SecurityGetServiceCredentialsNodesCredentialsFileToken` +# `SecurityGetServiceCredentialsNodesCredentialsFileToken` [interface-SecurityGetServiceCredentialsNodesCredentialsFileToken] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityGetServiceCredentialsRequest.md b/docs/reference/api/SecurityGetServiceCredentialsRequest.md index b2175a8fc..51067b780 100644 --- a/docs/reference/api/SecurityGetServiceCredentialsRequest.md +++ b/docs/reference/api/SecurityGetServiceCredentialsRequest.md @@ -1,4 +1,4 @@ -## Interface `SecurityGetServiceCredentialsRequest` +# `SecurityGetServiceCredentialsRequest` [interface-SecurityGetServiceCredentialsRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityGetServiceCredentialsResponse.md b/docs/reference/api/SecurityGetServiceCredentialsResponse.md index 492a5ddf3..83c5155d9 100644 --- a/docs/reference/api/SecurityGetServiceCredentialsResponse.md +++ b/docs/reference/api/SecurityGetServiceCredentialsResponse.md @@ -1,4 +1,4 @@ -## Interface `SecurityGetServiceCredentialsResponse` +# `SecurityGetServiceCredentialsResponse` [interface-SecurityGetServiceCredentialsResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityGetSettingsRequest.md b/docs/reference/api/SecurityGetSettingsRequest.md index 5cd67a893..f6b97588b 100644 --- a/docs/reference/api/SecurityGetSettingsRequest.md +++ b/docs/reference/api/SecurityGetSettingsRequest.md @@ -1,4 +1,4 @@ -## Interface `SecurityGetSettingsRequest` +# `SecurityGetSettingsRequest` [interface-SecurityGetSettingsRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityGetSettingsResponse.md b/docs/reference/api/SecurityGetSettingsResponse.md index c9f2a7c93..4c9248c10 100644 --- a/docs/reference/api/SecurityGetSettingsResponse.md +++ b/docs/reference/api/SecurityGetSettingsResponse.md @@ -1,4 +1,4 @@ -## Interface `SecurityGetSettingsResponse` +# `SecurityGetSettingsResponse` [interface-SecurityGetSettingsResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityGetTokenAccessTokenGrantType.md b/docs/reference/api/SecurityGetTokenAccessTokenGrantType.md index cd9f7cf55..f3d4cacd5 100644 --- a/docs/reference/api/SecurityGetTokenAccessTokenGrantType.md +++ b/docs/reference/api/SecurityGetTokenAccessTokenGrantType.md @@ -1,4 +1,4 @@ -## `SecurityGetTokenAccessTokenGrantType` -::: +# `SecurityGetTokenAccessTokenGrantType` [alias-SecurityGetTokenAccessTokenGrantType] +```typescript type SecurityGetTokenAccessTokenGrantType = 'password' | 'client_credentials' | '_kerberos' | 'refresh_token'; -::: +``` diff --git a/docs/reference/api/SecurityGetTokenAuthenticatedUser.md b/docs/reference/api/SecurityGetTokenAuthenticatedUser.md index 2045fb9c8..520de40bb 100644 --- a/docs/reference/api/SecurityGetTokenAuthenticatedUser.md +++ b/docs/reference/api/SecurityGetTokenAuthenticatedUser.md @@ -1,4 +1,4 @@ -## Interface `SecurityGetTokenAuthenticatedUser` +# `SecurityGetTokenAuthenticatedUser` [interface-SecurityGetTokenAuthenticatedUser] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityGetTokenAuthenticationProvider.md b/docs/reference/api/SecurityGetTokenAuthenticationProvider.md index 55a3d4395..0e8bdba01 100644 --- a/docs/reference/api/SecurityGetTokenAuthenticationProvider.md +++ b/docs/reference/api/SecurityGetTokenAuthenticationProvider.md @@ -1,4 +1,4 @@ -## Interface `SecurityGetTokenAuthenticationProvider` +# `SecurityGetTokenAuthenticationProvider` [interface-SecurityGetTokenAuthenticationProvider] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityGetTokenRequest.md b/docs/reference/api/SecurityGetTokenRequest.md index c599487b7..fa6950044 100644 --- a/docs/reference/api/SecurityGetTokenRequest.md +++ b/docs/reference/api/SecurityGetTokenRequest.md @@ -1,4 +1,4 @@ -## Interface `SecurityGetTokenRequest` +# `SecurityGetTokenRequest` [interface-SecurityGetTokenRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityGetTokenResponse.md b/docs/reference/api/SecurityGetTokenResponse.md index 59578de56..037256f86 100644 --- a/docs/reference/api/SecurityGetTokenResponse.md +++ b/docs/reference/api/SecurityGetTokenResponse.md @@ -1,4 +1,4 @@ -## Interface `SecurityGetTokenResponse` +# `SecurityGetTokenResponse` [interface-SecurityGetTokenResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityGetTokenUserRealm.md b/docs/reference/api/SecurityGetTokenUserRealm.md index 04f311387..7461ed84b 100644 --- a/docs/reference/api/SecurityGetTokenUserRealm.md +++ b/docs/reference/api/SecurityGetTokenUserRealm.md @@ -1,4 +1,4 @@ -## Interface `SecurityGetTokenUserRealm` +# `SecurityGetTokenUserRealm` [interface-SecurityGetTokenUserRealm] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityGetUserPrivilegesRequest.md b/docs/reference/api/SecurityGetUserPrivilegesRequest.md index b73ec0987..220faae44 100644 --- a/docs/reference/api/SecurityGetUserPrivilegesRequest.md +++ b/docs/reference/api/SecurityGetUserPrivilegesRequest.md @@ -1,4 +1,4 @@ -## Interface `SecurityGetUserPrivilegesRequest` +# `SecurityGetUserPrivilegesRequest` [interface-SecurityGetUserPrivilegesRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityGetUserPrivilegesResponse.md b/docs/reference/api/SecurityGetUserPrivilegesResponse.md index 7db1a9d63..ed862b5af 100644 --- a/docs/reference/api/SecurityGetUserPrivilegesResponse.md +++ b/docs/reference/api/SecurityGetUserPrivilegesResponse.md @@ -1,4 +1,4 @@ -## Interface `SecurityGetUserPrivilegesResponse` +# `SecurityGetUserPrivilegesResponse` [interface-SecurityGetUserPrivilegesResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityGetUserProfileGetUserProfileErrors.md b/docs/reference/api/SecurityGetUserProfileGetUserProfileErrors.md index 3b1e370bc..801c7b040 100644 --- a/docs/reference/api/SecurityGetUserProfileGetUserProfileErrors.md +++ b/docs/reference/api/SecurityGetUserProfileGetUserProfileErrors.md @@ -1,4 +1,4 @@ -## Interface `SecurityGetUserProfileGetUserProfileErrors` +# `SecurityGetUserProfileGetUserProfileErrors` [interface-SecurityGetUserProfileGetUserProfileErrors] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityGetUserProfileRequest.md b/docs/reference/api/SecurityGetUserProfileRequest.md index d84ea23b4..c8ba56513 100644 --- a/docs/reference/api/SecurityGetUserProfileRequest.md +++ b/docs/reference/api/SecurityGetUserProfileRequest.md @@ -1,4 +1,4 @@ -## Interface `SecurityGetUserProfileRequest` +# `SecurityGetUserProfileRequest` [interface-SecurityGetUserProfileRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityGetUserProfileResponse.md b/docs/reference/api/SecurityGetUserProfileResponse.md index 76afd530f..3e4d4bba1 100644 --- a/docs/reference/api/SecurityGetUserProfileResponse.md +++ b/docs/reference/api/SecurityGetUserProfileResponse.md @@ -1,4 +1,4 @@ -## Interface `SecurityGetUserProfileResponse` +# `SecurityGetUserProfileResponse` [interface-SecurityGetUserProfileResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityGetUserRequest.md b/docs/reference/api/SecurityGetUserRequest.md index 6e089fdd7..c8acde7df 100644 --- a/docs/reference/api/SecurityGetUserRequest.md +++ b/docs/reference/api/SecurityGetUserRequest.md @@ -1,4 +1,4 @@ -## Interface `SecurityGetUserRequest` +# `SecurityGetUserRequest` [interface-SecurityGetUserRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityGetUserResponse.md b/docs/reference/api/SecurityGetUserResponse.md index f5abca3e0..26f2574c1 100644 --- a/docs/reference/api/SecurityGetUserResponse.md +++ b/docs/reference/api/SecurityGetUserResponse.md @@ -1,4 +1,4 @@ -## `SecurityGetUserResponse` -::: +# `SecurityGetUserResponse` [alias-SecurityGetUserResponse] +```typescript type SecurityGetUserResponse = Record; -::: +``` diff --git a/docs/reference/api/SecurityGlobalPrivilege.md b/docs/reference/api/SecurityGlobalPrivilege.md index 59ea2338e..7dafa0e39 100644 --- a/docs/reference/api/SecurityGlobalPrivilege.md +++ b/docs/reference/api/SecurityGlobalPrivilege.md @@ -1,4 +1,4 @@ -## Interface `SecurityGlobalPrivilege` +# `SecurityGlobalPrivilege` [interface-SecurityGlobalPrivilege] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityGrantApiKeyApiKeyGrantType.md b/docs/reference/api/SecurityGrantApiKeyApiKeyGrantType.md index e14a61a86..5ae9ccdb8 100644 --- a/docs/reference/api/SecurityGrantApiKeyApiKeyGrantType.md +++ b/docs/reference/api/SecurityGrantApiKeyApiKeyGrantType.md @@ -1,4 +1,4 @@ -## `SecurityGrantApiKeyApiKeyGrantType` -::: +# `SecurityGrantApiKeyApiKeyGrantType` [alias-SecurityGrantApiKeyApiKeyGrantType] +```typescript type SecurityGrantApiKeyApiKeyGrantType = 'access_token' | 'password'; -::: +``` diff --git a/docs/reference/api/SecurityGrantApiKeyGrantApiKey.md b/docs/reference/api/SecurityGrantApiKeyGrantApiKey.md index 2480c9ab0..694e8ae8a 100644 --- a/docs/reference/api/SecurityGrantApiKeyGrantApiKey.md +++ b/docs/reference/api/SecurityGrantApiKeyGrantApiKey.md @@ -1,4 +1,4 @@ -## Interface `SecurityGrantApiKeyGrantApiKey` +# `SecurityGrantApiKeyGrantApiKey` [interface-SecurityGrantApiKeyGrantApiKey] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityGrantApiKeyRequest.md b/docs/reference/api/SecurityGrantApiKeyRequest.md index 41d8f01fc..0bf804b7b 100644 --- a/docs/reference/api/SecurityGrantApiKeyRequest.md +++ b/docs/reference/api/SecurityGrantApiKeyRequest.md @@ -1,4 +1,4 @@ -## Interface `SecurityGrantApiKeyRequest` +# `SecurityGrantApiKeyRequest` [interface-SecurityGrantApiKeyRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityGrantApiKeyResponse.md b/docs/reference/api/SecurityGrantApiKeyResponse.md index 9286dd4f4..05a504e03 100644 --- a/docs/reference/api/SecurityGrantApiKeyResponse.md +++ b/docs/reference/api/SecurityGrantApiKeyResponse.md @@ -1,4 +1,4 @@ -## Interface `SecurityGrantApiKeyResponse` +# `SecurityGrantApiKeyResponse` [interface-SecurityGrantApiKeyResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityGrantType.md b/docs/reference/api/SecurityGrantType.md index c296010a7..15cd8f97d 100644 --- a/docs/reference/api/SecurityGrantType.md +++ b/docs/reference/api/SecurityGrantType.md @@ -1,4 +1,4 @@ -## `SecurityGrantType` -::: +# `SecurityGrantType` [alias-SecurityGrantType] +```typescript type SecurityGrantType = 'password' | 'access_token'; -::: +``` diff --git a/docs/reference/api/SecurityHasPrivilegesApplicationPrivilegesCheck.md b/docs/reference/api/SecurityHasPrivilegesApplicationPrivilegesCheck.md index c9ad1aafb..f770cc06f 100644 --- a/docs/reference/api/SecurityHasPrivilegesApplicationPrivilegesCheck.md +++ b/docs/reference/api/SecurityHasPrivilegesApplicationPrivilegesCheck.md @@ -1,4 +1,4 @@ -## Interface `SecurityHasPrivilegesApplicationPrivilegesCheck` +# `SecurityHasPrivilegesApplicationPrivilegesCheck` [interface-SecurityHasPrivilegesApplicationPrivilegesCheck] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityHasPrivilegesApplicationsPrivileges.md b/docs/reference/api/SecurityHasPrivilegesApplicationsPrivileges.md index 2f62c478b..dad5084d0 100644 --- a/docs/reference/api/SecurityHasPrivilegesApplicationsPrivileges.md +++ b/docs/reference/api/SecurityHasPrivilegesApplicationsPrivileges.md @@ -1,4 +1,4 @@ -## `SecurityHasPrivilegesApplicationsPrivileges` -::: +# `SecurityHasPrivilegesApplicationsPrivileges` [alias-SecurityHasPrivilegesApplicationsPrivileges] +```typescript type SecurityHasPrivilegesApplicationsPrivileges = Record<[Name](./Name.md), [SecurityHasPrivilegesResourcePrivileges](./SecurityHasPrivilegesResourcePrivileges.md)>; -::: +``` diff --git a/docs/reference/api/SecurityHasPrivilegesIndexPrivilegesCheck.md b/docs/reference/api/SecurityHasPrivilegesIndexPrivilegesCheck.md index 74b1c3f33..b22bd50fb 100644 --- a/docs/reference/api/SecurityHasPrivilegesIndexPrivilegesCheck.md +++ b/docs/reference/api/SecurityHasPrivilegesIndexPrivilegesCheck.md @@ -1,4 +1,4 @@ -## Interface `SecurityHasPrivilegesIndexPrivilegesCheck` +# `SecurityHasPrivilegesIndexPrivilegesCheck` [interface-SecurityHasPrivilegesIndexPrivilegesCheck] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityHasPrivilegesPrivileges.md b/docs/reference/api/SecurityHasPrivilegesPrivileges.md index c1d75cbec..702244cbb 100644 --- a/docs/reference/api/SecurityHasPrivilegesPrivileges.md +++ b/docs/reference/api/SecurityHasPrivilegesPrivileges.md @@ -1,4 +1,4 @@ -## `SecurityHasPrivilegesPrivileges` -::: +# `SecurityHasPrivilegesPrivileges` [alias-SecurityHasPrivilegesPrivileges] +```typescript type SecurityHasPrivilegesPrivileges = Record; -::: +``` diff --git a/docs/reference/api/SecurityHasPrivilegesRequest.md b/docs/reference/api/SecurityHasPrivilegesRequest.md index 0a5fe9290..b8ce67ee6 100644 --- a/docs/reference/api/SecurityHasPrivilegesRequest.md +++ b/docs/reference/api/SecurityHasPrivilegesRequest.md @@ -1,4 +1,4 @@ -## Interface `SecurityHasPrivilegesRequest` +# `SecurityHasPrivilegesRequest` [interface-SecurityHasPrivilegesRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityHasPrivilegesResourcePrivileges.md b/docs/reference/api/SecurityHasPrivilegesResourcePrivileges.md index dbc712cd1..8f1c7ed95 100644 --- a/docs/reference/api/SecurityHasPrivilegesResourcePrivileges.md +++ b/docs/reference/api/SecurityHasPrivilegesResourcePrivileges.md @@ -1,4 +1,4 @@ -## `SecurityHasPrivilegesResourcePrivileges` -::: +# `SecurityHasPrivilegesResourcePrivileges` [alias-SecurityHasPrivilegesResourcePrivileges] +```typescript type SecurityHasPrivilegesResourcePrivileges = Record<[Name](./Name.md), [SecurityHasPrivilegesPrivileges](./SecurityHasPrivilegesPrivileges.md)>; -::: +``` diff --git a/docs/reference/api/SecurityHasPrivilegesResponse.md b/docs/reference/api/SecurityHasPrivilegesResponse.md index f2453bcbb..bc90b7c36 100644 --- a/docs/reference/api/SecurityHasPrivilegesResponse.md +++ b/docs/reference/api/SecurityHasPrivilegesResponse.md @@ -1,4 +1,4 @@ -## Interface `SecurityHasPrivilegesResponse` +# `SecurityHasPrivilegesResponse` [interface-SecurityHasPrivilegesResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityHasPrivilegesUserProfileHasPrivilegesUserProfileErrors.md b/docs/reference/api/SecurityHasPrivilegesUserProfileHasPrivilegesUserProfileErrors.md index d7ebb2800..eb217e1b1 100644 --- a/docs/reference/api/SecurityHasPrivilegesUserProfileHasPrivilegesUserProfileErrors.md +++ b/docs/reference/api/SecurityHasPrivilegesUserProfileHasPrivilegesUserProfileErrors.md @@ -1,4 +1,4 @@ -## Interface `SecurityHasPrivilegesUserProfileHasPrivilegesUserProfileErrors` +# `SecurityHasPrivilegesUserProfileHasPrivilegesUserProfileErrors` [interface-SecurityHasPrivilegesUserProfileHasPrivilegesUserProfileErrors] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityHasPrivilegesUserProfilePrivilegesCheck.md b/docs/reference/api/SecurityHasPrivilegesUserProfilePrivilegesCheck.md index 880b52b5a..3e38aab98 100644 --- a/docs/reference/api/SecurityHasPrivilegesUserProfilePrivilegesCheck.md +++ b/docs/reference/api/SecurityHasPrivilegesUserProfilePrivilegesCheck.md @@ -1,4 +1,4 @@ -## Interface `SecurityHasPrivilegesUserProfilePrivilegesCheck` +# `SecurityHasPrivilegesUserProfilePrivilegesCheck` [interface-SecurityHasPrivilegesUserProfilePrivilegesCheck] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityHasPrivilegesUserProfileRequest.md b/docs/reference/api/SecurityHasPrivilegesUserProfileRequest.md index 988266472..0625af9a4 100644 --- a/docs/reference/api/SecurityHasPrivilegesUserProfileRequest.md +++ b/docs/reference/api/SecurityHasPrivilegesUserProfileRequest.md @@ -1,4 +1,4 @@ -## Interface `SecurityHasPrivilegesUserProfileRequest` +# `SecurityHasPrivilegesUserProfileRequest` [interface-SecurityHasPrivilegesUserProfileRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityHasPrivilegesUserProfileResponse.md b/docs/reference/api/SecurityHasPrivilegesUserProfileResponse.md index ae2b34ddf..3fcb3bac4 100644 --- a/docs/reference/api/SecurityHasPrivilegesUserProfileResponse.md +++ b/docs/reference/api/SecurityHasPrivilegesUserProfileResponse.md @@ -1,4 +1,4 @@ -## Interface `SecurityHasPrivilegesUserProfileResponse` +# `SecurityHasPrivilegesUserProfileResponse` [interface-SecurityHasPrivilegesUserProfileResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityIndexPrivilege.md b/docs/reference/api/SecurityIndexPrivilege.md index 2cd496d31..31f744caa 100644 --- a/docs/reference/api/SecurityIndexPrivilege.md +++ b/docs/reference/api/SecurityIndexPrivilege.md @@ -1,4 +1,4 @@ -## `SecurityIndexPrivilege` -::: +# `SecurityIndexPrivilege` [alias-SecurityIndexPrivilege] +```typescript type SecurityIndexPrivilege = 'all' | 'auto_configure' | 'create' | 'create_doc' | 'create_index' | 'cross_cluster_replication' | 'cross_cluster_replication_internal' | 'delete' | 'delete_index' | 'index' | 'maintenance' | 'manage' | 'manage_data_stream_lifecycle' | 'manage_follow_index' | 'manage_ilm' | 'manage_leader_index' | 'monitor' | 'none' | 'read' | 'read_cross_cluster' | 'view_index_metadata' | 'write' | string; -::: +``` diff --git a/docs/reference/api/SecurityIndicesPrivileges.md b/docs/reference/api/SecurityIndicesPrivileges.md index 4e444b762..22c571291 100644 --- a/docs/reference/api/SecurityIndicesPrivileges.md +++ b/docs/reference/api/SecurityIndicesPrivileges.md @@ -1,4 +1,4 @@ -## Interface `SecurityIndicesPrivileges` +# `SecurityIndicesPrivileges` [interface-SecurityIndicesPrivileges] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityIndicesPrivilegesQuery.md b/docs/reference/api/SecurityIndicesPrivilegesQuery.md index 9577553c1..bfca73eb2 100644 --- a/docs/reference/api/SecurityIndicesPrivilegesQuery.md +++ b/docs/reference/api/SecurityIndicesPrivilegesQuery.md @@ -1,4 +1,4 @@ -## `SecurityIndicesPrivilegesQuery` -::: +# `SecurityIndicesPrivilegesQuery` [alias-SecurityIndicesPrivilegesQuery] +```typescript type SecurityIndicesPrivilegesQuery = string | [QueryDslQueryContainer](./QueryDslQueryContainer.md) | [SecurityRoleTemplateQuery](./SecurityRoleTemplateQuery.md); -::: +``` diff --git a/docs/reference/api/SecurityInvalidateApiKeyRequest.md b/docs/reference/api/SecurityInvalidateApiKeyRequest.md index b84126068..7ee35e9eb 100644 --- a/docs/reference/api/SecurityInvalidateApiKeyRequest.md +++ b/docs/reference/api/SecurityInvalidateApiKeyRequest.md @@ -1,4 +1,4 @@ -## Interface `SecurityInvalidateApiKeyRequest` +# `SecurityInvalidateApiKeyRequest` [interface-SecurityInvalidateApiKeyRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityInvalidateApiKeyResponse.md b/docs/reference/api/SecurityInvalidateApiKeyResponse.md index faef0c533..99547d5a4 100644 --- a/docs/reference/api/SecurityInvalidateApiKeyResponse.md +++ b/docs/reference/api/SecurityInvalidateApiKeyResponse.md @@ -1,4 +1,4 @@ -## Interface `SecurityInvalidateApiKeyResponse` +# `SecurityInvalidateApiKeyResponse` [interface-SecurityInvalidateApiKeyResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityInvalidateTokenRequest.md b/docs/reference/api/SecurityInvalidateTokenRequest.md index 78a58a9b3..5de4a2688 100644 --- a/docs/reference/api/SecurityInvalidateTokenRequest.md +++ b/docs/reference/api/SecurityInvalidateTokenRequest.md @@ -1,4 +1,4 @@ -## Interface `SecurityInvalidateTokenRequest` +# `SecurityInvalidateTokenRequest` [interface-SecurityInvalidateTokenRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityInvalidateTokenResponse.md b/docs/reference/api/SecurityInvalidateTokenResponse.md index bf4b639b2..fc270ddec 100644 --- a/docs/reference/api/SecurityInvalidateTokenResponse.md +++ b/docs/reference/api/SecurityInvalidateTokenResponse.md @@ -1,4 +1,4 @@ -## Interface `SecurityInvalidateTokenResponse` +# `SecurityInvalidateTokenResponse` [interface-SecurityInvalidateTokenResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityManageUserPrivileges.md b/docs/reference/api/SecurityManageUserPrivileges.md index f1cc24f21..1f979bd75 100644 --- a/docs/reference/api/SecurityManageUserPrivileges.md +++ b/docs/reference/api/SecurityManageUserPrivileges.md @@ -1,4 +1,4 @@ -## Interface `SecurityManageUserPrivileges` +# `SecurityManageUserPrivileges` [interface-SecurityManageUserPrivileges] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityOidcAuthenticateRequest.md b/docs/reference/api/SecurityOidcAuthenticateRequest.md index 80862babb..c949b4613 100644 --- a/docs/reference/api/SecurityOidcAuthenticateRequest.md +++ b/docs/reference/api/SecurityOidcAuthenticateRequest.md @@ -1,4 +1,4 @@ -## Interface `SecurityOidcAuthenticateRequest` +# `SecurityOidcAuthenticateRequest` [interface-SecurityOidcAuthenticateRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityOidcAuthenticateResponse.md b/docs/reference/api/SecurityOidcAuthenticateResponse.md index 665a9b7b8..c1f2e7459 100644 --- a/docs/reference/api/SecurityOidcAuthenticateResponse.md +++ b/docs/reference/api/SecurityOidcAuthenticateResponse.md @@ -1,4 +1,4 @@ -## Interface `SecurityOidcAuthenticateResponse` +# `SecurityOidcAuthenticateResponse` [interface-SecurityOidcAuthenticateResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityOidcLogoutRequest.md b/docs/reference/api/SecurityOidcLogoutRequest.md index d4b2f6e79..ec8b050c5 100644 --- a/docs/reference/api/SecurityOidcLogoutRequest.md +++ b/docs/reference/api/SecurityOidcLogoutRequest.md @@ -1,4 +1,4 @@ -## Interface `SecurityOidcLogoutRequest` +# `SecurityOidcLogoutRequest` [interface-SecurityOidcLogoutRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityOidcLogoutResponse.md b/docs/reference/api/SecurityOidcLogoutResponse.md index dfaa88426..18451651a 100644 --- a/docs/reference/api/SecurityOidcLogoutResponse.md +++ b/docs/reference/api/SecurityOidcLogoutResponse.md @@ -1,4 +1,4 @@ -## Interface `SecurityOidcLogoutResponse` +# `SecurityOidcLogoutResponse` [interface-SecurityOidcLogoutResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityOidcPrepareAuthenticationRequest.md b/docs/reference/api/SecurityOidcPrepareAuthenticationRequest.md index 6c3761474..df71e5960 100644 --- a/docs/reference/api/SecurityOidcPrepareAuthenticationRequest.md +++ b/docs/reference/api/SecurityOidcPrepareAuthenticationRequest.md @@ -1,4 +1,4 @@ -## Interface `SecurityOidcPrepareAuthenticationRequest` +# `SecurityOidcPrepareAuthenticationRequest` [interface-SecurityOidcPrepareAuthenticationRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityOidcPrepareAuthenticationResponse.md b/docs/reference/api/SecurityOidcPrepareAuthenticationResponse.md index 44ad7ae20..aef1234ae 100644 --- a/docs/reference/api/SecurityOidcPrepareAuthenticationResponse.md +++ b/docs/reference/api/SecurityOidcPrepareAuthenticationResponse.md @@ -1,4 +1,4 @@ -## Interface `SecurityOidcPrepareAuthenticationResponse` +# `SecurityOidcPrepareAuthenticationResponse` [interface-SecurityOidcPrepareAuthenticationResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityPutPrivilegesActions.md b/docs/reference/api/SecurityPutPrivilegesActions.md index 661d630f7..d591a25f1 100644 --- a/docs/reference/api/SecurityPutPrivilegesActions.md +++ b/docs/reference/api/SecurityPutPrivilegesActions.md @@ -1,4 +1,4 @@ -## Interface `SecurityPutPrivilegesActions` +# `SecurityPutPrivilegesActions` [interface-SecurityPutPrivilegesActions] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityPutPrivilegesRequest.md b/docs/reference/api/SecurityPutPrivilegesRequest.md index 7416c99da..ecfa4cb93 100644 --- a/docs/reference/api/SecurityPutPrivilegesRequest.md +++ b/docs/reference/api/SecurityPutPrivilegesRequest.md @@ -1,4 +1,4 @@ -## Interface `SecurityPutPrivilegesRequest` +# `SecurityPutPrivilegesRequest` [interface-SecurityPutPrivilegesRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityPutPrivilegesResponse.md b/docs/reference/api/SecurityPutPrivilegesResponse.md index 0d085616d..42d074602 100644 --- a/docs/reference/api/SecurityPutPrivilegesResponse.md +++ b/docs/reference/api/SecurityPutPrivilegesResponse.md @@ -1,4 +1,4 @@ -## `SecurityPutPrivilegesResponse` -::: +# `SecurityPutPrivilegesResponse` [alias-SecurityPutPrivilegesResponse] +```typescript type SecurityPutPrivilegesResponse = Record>; -::: +``` diff --git a/docs/reference/api/SecurityPutRoleMappingRequest.md b/docs/reference/api/SecurityPutRoleMappingRequest.md index cb8e4c44b..86029ec90 100644 --- a/docs/reference/api/SecurityPutRoleMappingRequest.md +++ b/docs/reference/api/SecurityPutRoleMappingRequest.md @@ -1,4 +1,4 @@ -## Interface `SecurityPutRoleMappingRequest` +# `SecurityPutRoleMappingRequest` [interface-SecurityPutRoleMappingRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityPutRoleMappingResponse.md b/docs/reference/api/SecurityPutRoleMappingResponse.md index be791f7d5..449db8ad0 100644 --- a/docs/reference/api/SecurityPutRoleMappingResponse.md +++ b/docs/reference/api/SecurityPutRoleMappingResponse.md @@ -1,4 +1,4 @@ -## Interface `SecurityPutRoleMappingResponse` +# `SecurityPutRoleMappingResponse` [interface-SecurityPutRoleMappingResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityPutRoleRequest.md b/docs/reference/api/SecurityPutRoleRequest.md index 4865744ab..25c80c732 100644 --- a/docs/reference/api/SecurityPutRoleRequest.md +++ b/docs/reference/api/SecurityPutRoleRequest.md @@ -1,4 +1,4 @@ -## Interface `SecurityPutRoleRequest` +# `SecurityPutRoleRequest` [interface-SecurityPutRoleRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityPutRoleResponse.md b/docs/reference/api/SecurityPutRoleResponse.md index 36af9d8dd..bbac83c72 100644 --- a/docs/reference/api/SecurityPutRoleResponse.md +++ b/docs/reference/api/SecurityPutRoleResponse.md @@ -1,4 +1,4 @@ -## Interface `SecurityPutRoleResponse` +# `SecurityPutRoleResponse` [interface-SecurityPutRoleResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityPutUserRequest.md b/docs/reference/api/SecurityPutUserRequest.md index 4ad54a910..4fec505c0 100644 --- a/docs/reference/api/SecurityPutUserRequest.md +++ b/docs/reference/api/SecurityPutUserRequest.md @@ -1,4 +1,4 @@ -## Interface `SecurityPutUserRequest` +# `SecurityPutUserRequest` [interface-SecurityPutUserRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityPutUserResponse.md b/docs/reference/api/SecurityPutUserResponse.md index b54d69c8b..d0e71d6ce 100644 --- a/docs/reference/api/SecurityPutUserResponse.md +++ b/docs/reference/api/SecurityPutUserResponse.md @@ -1,4 +1,4 @@ -## Interface `SecurityPutUserResponse` +# `SecurityPutUserResponse` [interface-SecurityPutUserResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityQueryApiKeysApiKeyAggregate.md b/docs/reference/api/SecurityQueryApiKeysApiKeyAggregate.md index 8bcafadb6..0ad132d75 100644 --- a/docs/reference/api/SecurityQueryApiKeysApiKeyAggregate.md +++ b/docs/reference/api/SecurityQueryApiKeysApiKeyAggregate.md @@ -1,4 +1,4 @@ -## `SecurityQueryApiKeysApiKeyAggregate` -::: +# `SecurityQueryApiKeysApiKeyAggregate` [alias-SecurityQueryApiKeysApiKeyAggregate] +```typescript type SecurityQueryApiKeysApiKeyAggregate = [AggregationsCardinalityAggregate](./AggregationsCardinalityAggregate.md) | [AggregationsValueCountAggregate](./AggregationsValueCountAggregate.md) | [AggregationsStringTermsAggregate](./AggregationsStringTermsAggregate.md) | [AggregationsLongTermsAggregate](./AggregationsLongTermsAggregate.md) | [AggregationsDoubleTermsAggregate](./AggregationsDoubleTermsAggregate.md) | [AggregationsUnmappedTermsAggregate](./AggregationsUnmappedTermsAggregate.md) | [AggregationsMultiTermsAggregate](./AggregationsMultiTermsAggregate.md) | [AggregationsMissingAggregate](./AggregationsMissingAggregate.md) | [AggregationsFilterAggregate](./AggregationsFilterAggregate.md) | [AggregationsFiltersAggregate](./AggregationsFiltersAggregate.md) | [AggregationsRangeAggregate](./AggregationsRangeAggregate.md) | [AggregationsDateRangeAggregate](./AggregationsDateRangeAggregate.md) | [AggregationsCompositeAggregate](./AggregationsCompositeAggregate.md); -::: +``` diff --git a/docs/reference/api/SecurityQueryApiKeysApiKeyAggregationContainer.md b/docs/reference/api/SecurityQueryApiKeysApiKeyAggregationContainer.md index 5a6d5bcc5..fa1970f20 100644 --- a/docs/reference/api/SecurityQueryApiKeysApiKeyAggregationContainer.md +++ b/docs/reference/api/SecurityQueryApiKeysApiKeyAggregationContainer.md @@ -1,4 +1,4 @@ -## Interface `SecurityQueryApiKeysApiKeyAggregationContainer` +# `SecurityQueryApiKeysApiKeyAggregationContainer` [interface-SecurityQueryApiKeysApiKeyAggregationContainer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityQueryApiKeysApiKeyFiltersAggregation.md b/docs/reference/api/SecurityQueryApiKeysApiKeyFiltersAggregation.md index 0f7ef2ce1..aaee84f18 100644 --- a/docs/reference/api/SecurityQueryApiKeysApiKeyFiltersAggregation.md +++ b/docs/reference/api/SecurityQueryApiKeysApiKeyFiltersAggregation.md @@ -1,4 +1,4 @@ -## Interface `SecurityQueryApiKeysApiKeyFiltersAggregation` +# `SecurityQueryApiKeysApiKeyFiltersAggregation` [interface-SecurityQueryApiKeysApiKeyFiltersAggregation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityQueryApiKeysApiKeyQueryContainer.md b/docs/reference/api/SecurityQueryApiKeysApiKeyQueryContainer.md index d01e6d42c..8a8d650a6 100644 --- a/docs/reference/api/SecurityQueryApiKeysApiKeyQueryContainer.md +++ b/docs/reference/api/SecurityQueryApiKeysApiKeyQueryContainer.md @@ -1,4 +1,4 @@ -## Interface `SecurityQueryApiKeysApiKeyQueryContainer` +# `SecurityQueryApiKeysApiKeyQueryContainer` [interface-SecurityQueryApiKeysApiKeyQueryContainer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityQueryApiKeysRequest.md b/docs/reference/api/SecurityQueryApiKeysRequest.md index 1fba7cddb..c22911259 100644 --- a/docs/reference/api/SecurityQueryApiKeysRequest.md +++ b/docs/reference/api/SecurityQueryApiKeysRequest.md @@ -1,4 +1,4 @@ -## Interface `SecurityQueryApiKeysRequest` +# `SecurityQueryApiKeysRequest` [interface-SecurityQueryApiKeysRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityQueryApiKeysResponse.md b/docs/reference/api/SecurityQueryApiKeysResponse.md index b098e83f1..84341ccc8 100644 --- a/docs/reference/api/SecurityQueryApiKeysResponse.md +++ b/docs/reference/api/SecurityQueryApiKeysResponse.md @@ -1,4 +1,4 @@ -## Interface `SecurityQueryApiKeysResponse` +# `SecurityQueryApiKeysResponse` [interface-SecurityQueryApiKeysResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityQueryRoleQueryRole.md b/docs/reference/api/SecurityQueryRoleQueryRole.md index 01eb5847c..f22bfb8f8 100644 --- a/docs/reference/api/SecurityQueryRoleQueryRole.md +++ b/docs/reference/api/SecurityQueryRoleQueryRole.md @@ -1,4 +1,4 @@ -## Interface `SecurityQueryRoleQueryRole` +# `SecurityQueryRoleQueryRole` [interface-SecurityQueryRoleQueryRole] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityQueryRoleRequest.md b/docs/reference/api/SecurityQueryRoleRequest.md index 402bafc86..a454bd560 100644 --- a/docs/reference/api/SecurityQueryRoleRequest.md +++ b/docs/reference/api/SecurityQueryRoleRequest.md @@ -1,4 +1,4 @@ -## Interface `SecurityQueryRoleRequest` +# `SecurityQueryRoleRequest` [interface-SecurityQueryRoleRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityQueryRoleResponse.md b/docs/reference/api/SecurityQueryRoleResponse.md index 00086b872..0657c0c80 100644 --- a/docs/reference/api/SecurityQueryRoleResponse.md +++ b/docs/reference/api/SecurityQueryRoleResponse.md @@ -1,4 +1,4 @@ -## Interface `SecurityQueryRoleResponse` +# `SecurityQueryRoleResponse` [interface-SecurityQueryRoleResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityQueryRoleRoleQueryContainer.md b/docs/reference/api/SecurityQueryRoleRoleQueryContainer.md index c104b89d1..fdf1a9ffe 100644 --- a/docs/reference/api/SecurityQueryRoleRoleQueryContainer.md +++ b/docs/reference/api/SecurityQueryRoleRoleQueryContainer.md @@ -1,4 +1,4 @@ -## Interface `SecurityQueryRoleRoleQueryContainer` +# `SecurityQueryRoleRoleQueryContainer` [interface-SecurityQueryRoleRoleQueryContainer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityQueryUserQueryUser.md b/docs/reference/api/SecurityQueryUserQueryUser.md index 96756fdc1..50bbc31c4 100644 --- a/docs/reference/api/SecurityQueryUserQueryUser.md +++ b/docs/reference/api/SecurityQueryUserQueryUser.md @@ -1,4 +1,4 @@ -## Interface `SecurityQueryUserQueryUser` +# `SecurityQueryUserQueryUser` [interface-SecurityQueryUserQueryUser] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityQueryUserRequest.md b/docs/reference/api/SecurityQueryUserRequest.md index fae4e22d9..3a8c0934e 100644 --- a/docs/reference/api/SecurityQueryUserRequest.md +++ b/docs/reference/api/SecurityQueryUserRequest.md @@ -1,4 +1,4 @@ -## Interface `SecurityQueryUserRequest` +# `SecurityQueryUserRequest` [interface-SecurityQueryUserRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityQueryUserResponse.md b/docs/reference/api/SecurityQueryUserResponse.md index 5a723c7ea..621b501f3 100644 --- a/docs/reference/api/SecurityQueryUserResponse.md +++ b/docs/reference/api/SecurityQueryUserResponse.md @@ -1,4 +1,4 @@ -## Interface `SecurityQueryUserResponse` +# `SecurityQueryUserResponse` [interface-SecurityQueryUserResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityQueryUserUserQueryContainer.md b/docs/reference/api/SecurityQueryUserUserQueryContainer.md index 5fd819980..9c2a7e24a 100644 --- a/docs/reference/api/SecurityQueryUserUserQueryContainer.md +++ b/docs/reference/api/SecurityQueryUserUserQueryContainer.md @@ -1,4 +1,4 @@ -## Interface `SecurityQueryUserUserQueryContainer` +# `SecurityQueryUserUserQueryContainer` [interface-SecurityQueryUserUserQueryContainer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityRealmInfo.md b/docs/reference/api/SecurityRealmInfo.md index e31de973a..7799d60fe 100644 --- a/docs/reference/api/SecurityRealmInfo.md +++ b/docs/reference/api/SecurityRealmInfo.md @@ -1,4 +1,4 @@ -## Interface `SecurityRealmInfo` +# `SecurityRealmInfo` [interface-SecurityRealmInfo] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityRemoteClusterPrivilege.md b/docs/reference/api/SecurityRemoteClusterPrivilege.md index 6eb745911..5c7b39a17 100644 --- a/docs/reference/api/SecurityRemoteClusterPrivilege.md +++ b/docs/reference/api/SecurityRemoteClusterPrivilege.md @@ -1,4 +1,4 @@ -## `SecurityRemoteClusterPrivilege` -::: +# `SecurityRemoteClusterPrivilege` [alias-SecurityRemoteClusterPrivilege] +```typescript type SecurityRemoteClusterPrivilege = 'monitor_enrich' | 'monitor_stats'; -::: +``` diff --git a/docs/reference/api/SecurityRemoteClusterPrivileges.md b/docs/reference/api/SecurityRemoteClusterPrivileges.md index 3ac9ac72a..7ce103a2e 100644 --- a/docs/reference/api/SecurityRemoteClusterPrivileges.md +++ b/docs/reference/api/SecurityRemoteClusterPrivileges.md @@ -1,4 +1,4 @@ -## Interface `SecurityRemoteClusterPrivileges` +# `SecurityRemoteClusterPrivileges` [interface-SecurityRemoteClusterPrivileges] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityRemoteIndicesPrivileges.md b/docs/reference/api/SecurityRemoteIndicesPrivileges.md index e3e71a257..09a6633da 100644 --- a/docs/reference/api/SecurityRemoteIndicesPrivileges.md +++ b/docs/reference/api/SecurityRemoteIndicesPrivileges.md @@ -1,4 +1,4 @@ -## Interface `SecurityRemoteIndicesPrivileges` +# `SecurityRemoteIndicesPrivileges` [interface-SecurityRemoteIndicesPrivileges] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityRemoteUserIndicesPrivileges.md b/docs/reference/api/SecurityRemoteUserIndicesPrivileges.md index cc65b7488..839cd04dc 100644 --- a/docs/reference/api/SecurityRemoteUserIndicesPrivileges.md +++ b/docs/reference/api/SecurityRemoteUserIndicesPrivileges.md @@ -1,4 +1,4 @@ -## Interface `SecurityRemoteUserIndicesPrivileges` +# `SecurityRemoteUserIndicesPrivileges` [interface-SecurityRemoteUserIndicesPrivileges] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityReplicationAccess.md b/docs/reference/api/SecurityReplicationAccess.md index 05143c2b1..cf0a335bd 100644 --- a/docs/reference/api/SecurityReplicationAccess.md +++ b/docs/reference/api/SecurityReplicationAccess.md @@ -1,4 +1,4 @@ -## Interface `SecurityReplicationAccess` +# `SecurityReplicationAccess` [interface-SecurityReplicationAccess] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityRestriction.md b/docs/reference/api/SecurityRestriction.md index 9acf5340c..379b096c6 100644 --- a/docs/reference/api/SecurityRestriction.md +++ b/docs/reference/api/SecurityRestriction.md @@ -1,4 +1,4 @@ -## Interface `SecurityRestriction` +# `SecurityRestriction` [interface-SecurityRestriction] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityRestrictionWorkflow.md b/docs/reference/api/SecurityRestrictionWorkflow.md index 9ff9ccf15..1477f04ba 100644 --- a/docs/reference/api/SecurityRestrictionWorkflow.md +++ b/docs/reference/api/SecurityRestrictionWorkflow.md @@ -1,4 +1,4 @@ -## `SecurityRestrictionWorkflow` -::: +# `SecurityRestrictionWorkflow` [alias-SecurityRestrictionWorkflow] +```typescript type SecurityRestrictionWorkflow = 'search_application_query' | string; -::: +``` diff --git a/docs/reference/api/SecurityRoleDescriptor.md b/docs/reference/api/SecurityRoleDescriptor.md index b4cc379f5..74323cd39 100644 --- a/docs/reference/api/SecurityRoleDescriptor.md +++ b/docs/reference/api/SecurityRoleDescriptor.md @@ -1,4 +1,4 @@ -## Interface `SecurityRoleDescriptor` +# `SecurityRoleDescriptor` [interface-SecurityRoleDescriptor] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityRoleDescriptorRead.md b/docs/reference/api/SecurityRoleDescriptorRead.md index 8638aaa61..6d73a0dba 100644 --- a/docs/reference/api/SecurityRoleDescriptorRead.md +++ b/docs/reference/api/SecurityRoleDescriptorRead.md @@ -1,4 +1,4 @@ -## Interface `SecurityRoleDescriptorRead` +# `SecurityRoleDescriptorRead` [interface-SecurityRoleDescriptorRead] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityRoleMapping.md b/docs/reference/api/SecurityRoleMapping.md index 3f3f39c1c..37de3389a 100644 --- a/docs/reference/api/SecurityRoleMapping.md +++ b/docs/reference/api/SecurityRoleMapping.md @@ -1,4 +1,4 @@ -## Interface `SecurityRoleMapping` +# `SecurityRoleMapping` [interface-SecurityRoleMapping] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityRoleMappingRule.md b/docs/reference/api/SecurityRoleMappingRule.md index 8704bf160..821efa77a 100644 --- a/docs/reference/api/SecurityRoleMappingRule.md +++ b/docs/reference/api/SecurityRoleMappingRule.md @@ -1,4 +1,4 @@ -## Interface `SecurityRoleMappingRule` +# `SecurityRoleMappingRule` [interface-SecurityRoleMappingRule] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityRoleTemplate.md b/docs/reference/api/SecurityRoleTemplate.md index 81e4bcab5..2d0ac944f 100644 --- a/docs/reference/api/SecurityRoleTemplate.md +++ b/docs/reference/api/SecurityRoleTemplate.md @@ -1,4 +1,4 @@ -## Interface `SecurityRoleTemplate` +# `SecurityRoleTemplate` [interface-SecurityRoleTemplate] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityRoleTemplateInlineQuery.md b/docs/reference/api/SecurityRoleTemplateInlineQuery.md index 40dc9e707..90b0f19d7 100644 --- a/docs/reference/api/SecurityRoleTemplateInlineQuery.md +++ b/docs/reference/api/SecurityRoleTemplateInlineQuery.md @@ -1,4 +1,4 @@ -## `SecurityRoleTemplateInlineQuery` -::: +# `SecurityRoleTemplateInlineQuery` [alias-SecurityRoleTemplateInlineQuery] +```typescript type SecurityRoleTemplateInlineQuery = string | [QueryDslQueryContainer](./QueryDslQueryContainer.md); -::: +``` diff --git a/docs/reference/api/SecurityRoleTemplateQuery.md b/docs/reference/api/SecurityRoleTemplateQuery.md index 61a2988a0..88d2616bd 100644 --- a/docs/reference/api/SecurityRoleTemplateQuery.md +++ b/docs/reference/api/SecurityRoleTemplateQuery.md @@ -1,4 +1,4 @@ -## Interface `SecurityRoleTemplateQuery` +# `SecurityRoleTemplateQuery` [interface-SecurityRoleTemplateQuery] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityRoleTemplateScript.md b/docs/reference/api/SecurityRoleTemplateScript.md index 1b0c6511b..6d7055ab7 100644 --- a/docs/reference/api/SecurityRoleTemplateScript.md +++ b/docs/reference/api/SecurityRoleTemplateScript.md @@ -1,4 +1,4 @@ -## Interface `SecurityRoleTemplateScript` +# `SecurityRoleTemplateScript` [interface-SecurityRoleTemplateScript] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecuritySamlAuthenticateRequest.md b/docs/reference/api/SecuritySamlAuthenticateRequest.md index eb2a307b0..c53cca357 100644 --- a/docs/reference/api/SecuritySamlAuthenticateRequest.md +++ b/docs/reference/api/SecuritySamlAuthenticateRequest.md @@ -1,4 +1,4 @@ -## Interface `SecuritySamlAuthenticateRequest` +# `SecuritySamlAuthenticateRequest` [interface-SecuritySamlAuthenticateRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecuritySamlAuthenticateResponse.md b/docs/reference/api/SecuritySamlAuthenticateResponse.md index ad2146589..5f51157dc 100644 --- a/docs/reference/api/SecuritySamlAuthenticateResponse.md +++ b/docs/reference/api/SecuritySamlAuthenticateResponse.md @@ -1,4 +1,4 @@ -## Interface `SecuritySamlAuthenticateResponse` +# `SecuritySamlAuthenticateResponse` [interface-SecuritySamlAuthenticateResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecuritySamlCompleteLogoutRequest.md b/docs/reference/api/SecuritySamlCompleteLogoutRequest.md index 3a1d3aa2c..57e908a81 100644 --- a/docs/reference/api/SecuritySamlCompleteLogoutRequest.md +++ b/docs/reference/api/SecuritySamlCompleteLogoutRequest.md @@ -1,4 +1,4 @@ -## Interface `SecuritySamlCompleteLogoutRequest` +# `SecuritySamlCompleteLogoutRequest` [interface-SecuritySamlCompleteLogoutRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecuritySamlCompleteLogoutResponse.md b/docs/reference/api/SecuritySamlCompleteLogoutResponse.md index e6a9c254e..ca679738f 100644 --- a/docs/reference/api/SecuritySamlCompleteLogoutResponse.md +++ b/docs/reference/api/SecuritySamlCompleteLogoutResponse.md @@ -1,4 +1,4 @@ -## `SecuritySamlCompleteLogoutResponse` -::: +# `SecuritySamlCompleteLogoutResponse` [alias-SecuritySamlCompleteLogoutResponse] +```typescript type SecuritySamlCompleteLogoutResponse = boolean; -::: +``` diff --git a/docs/reference/api/SecuritySamlInvalidateRequest.md b/docs/reference/api/SecuritySamlInvalidateRequest.md index 1bd43fbc1..88f745932 100644 --- a/docs/reference/api/SecuritySamlInvalidateRequest.md +++ b/docs/reference/api/SecuritySamlInvalidateRequest.md @@ -1,4 +1,4 @@ -## Interface `SecuritySamlInvalidateRequest` +# `SecuritySamlInvalidateRequest` [interface-SecuritySamlInvalidateRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecuritySamlInvalidateResponse.md b/docs/reference/api/SecuritySamlInvalidateResponse.md index b2ad3e429..882bc893c 100644 --- a/docs/reference/api/SecuritySamlInvalidateResponse.md +++ b/docs/reference/api/SecuritySamlInvalidateResponse.md @@ -1,4 +1,4 @@ -## Interface `SecuritySamlInvalidateResponse` +# `SecuritySamlInvalidateResponse` [interface-SecuritySamlInvalidateResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecuritySamlLogoutRequest.md b/docs/reference/api/SecuritySamlLogoutRequest.md index a75792bb4..112971456 100644 --- a/docs/reference/api/SecuritySamlLogoutRequest.md +++ b/docs/reference/api/SecuritySamlLogoutRequest.md @@ -1,4 +1,4 @@ -## Interface `SecuritySamlLogoutRequest` +# `SecuritySamlLogoutRequest` [interface-SecuritySamlLogoutRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecuritySamlLogoutResponse.md b/docs/reference/api/SecuritySamlLogoutResponse.md index 4e7609a99..412506e68 100644 --- a/docs/reference/api/SecuritySamlLogoutResponse.md +++ b/docs/reference/api/SecuritySamlLogoutResponse.md @@ -1,4 +1,4 @@ -## Interface `SecuritySamlLogoutResponse` +# `SecuritySamlLogoutResponse` [interface-SecuritySamlLogoutResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecuritySamlPrepareAuthenticationRequest.md b/docs/reference/api/SecuritySamlPrepareAuthenticationRequest.md index 408fc1b70..479c45c7b 100644 --- a/docs/reference/api/SecuritySamlPrepareAuthenticationRequest.md +++ b/docs/reference/api/SecuritySamlPrepareAuthenticationRequest.md @@ -1,4 +1,4 @@ -## Interface `SecuritySamlPrepareAuthenticationRequest` +# `SecuritySamlPrepareAuthenticationRequest` [interface-SecuritySamlPrepareAuthenticationRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecuritySamlPrepareAuthenticationResponse.md b/docs/reference/api/SecuritySamlPrepareAuthenticationResponse.md index 3480bbd62..adef99c53 100644 --- a/docs/reference/api/SecuritySamlPrepareAuthenticationResponse.md +++ b/docs/reference/api/SecuritySamlPrepareAuthenticationResponse.md @@ -1,4 +1,4 @@ -## Interface `SecuritySamlPrepareAuthenticationResponse` +# `SecuritySamlPrepareAuthenticationResponse` [interface-SecuritySamlPrepareAuthenticationResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecuritySamlServiceProviderMetadataRequest.md b/docs/reference/api/SecuritySamlServiceProviderMetadataRequest.md index f7e3494e9..6afbd0f81 100644 --- a/docs/reference/api/SecuritySamlServiceProviderMetadataRequest.md +++ b/docs/reference/api/SecuritySamlServiceProviderMetadataRequest.md @@ -1,4 +1,4 @@ -## Interface `SecuritySamlServiceProviderMetadataRequest` +# `SecuritySamlServiceProviderMetadataRequest` [interface-SecuritySamlServiceProviderMetadataRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecuritySamlServiceProviderMetadataResponse.md b/docs/reference/api/SecuritySamlServiceProviderMetadataResponse.md index 5a118ad64..c76b77c58 100644 --- a/docs/reference/api/SecuritySamlServiceProviderMetadataResponse.md +++ b/docs/reference/api/SecuritySamlServiceProviderMetadataResponse.md @@ -1,4 +1,4 @@ -## Interface `SecuritySamlServiceProviderMetadataResponse` +# `SecuritySamlServiceProviderMetadataResponse` [interface-SecuritySamlServiceProviderMetadataResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecuritySearchAccess.md b/docs/reference/api/SecuritySearchAccess.md index 9307625eb..c2e3b0737 100644 --- a/docs/reference/api/SecuritySearchAccess.md +++ b/docs/reference/api/SecuritySearchAccess.md @@ -1,4 +1,4 @@ -## Interface `SecuritySearchAccess` +# `SecuritySearchAccess` [interface-SecuritySearchAccess] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecuritySecuritySettings.md b/docs/reference/api/SecuritySecuritySettings.md index 5e7b32a93..2f4c39ddb 100644 --- a/docs/reference/api/SecuritySecuritySettings.md +++ b/docs/reference/api/SecuritySecuritySettings.md @@ -1,4 +1,4 @@ -## Interface `SecuritySecuritySettings` +# `SecuritySecuritySettings` [interface-SecuritySecuritySettings] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecuritySuggestUserProfilesHint.md b/docs/reference/api/SecuritySuggestUserProfilesHint.md index b956b4b23..4f15787f0 100644 --- a/docs/reference/api/SecuritySuggestUserProfilesHint.md +++ b/docs/reference/api/SecuritySuggestUserProfilesHint.md @@ -1,4 +1,4 @@ -## Interface `SecuritySuggestUserProfilesHint` +# `SecuritySuggestUserProfilesHint` [interface-SecuritySuggestUserProfilesHint] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecuritySuggestUserProfilesRequest.md b/docs/reference/api/SecuritySuggestUserProfilesRequest.md index 05c8b96ed..34b7db171 100644 --- a/docs/reference/api/SecuritySuggestUserProfilesRequest.md +++ b/docs/reference/api/SecuritySuggestUserProfilesRequest.md @@ -1,4 +1,4 @@ -## Interface `SecuritySuggestUserProfilesRequest` +# `SecuritySuggestUserProfilesRequest` [interface-SecuritySuggestUserProfilesRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecuritySuggestUserProfilesResponse.md b/docs/reference/api/SecuritySuggestUserProfilesResponse.md index dd31bef8a..5cf9b4903 100644 --- a/docs/reference/api/SecuritySuggestUserProfilesResponse.md +++ b/docs/reference/api/SecuritySuggestUserProfilesResponse.md @@ -1,4 +1,4 @@ -## Interface `SecuritySuggestUserProfilesResponse` +# `SecuritySuggestUserProfilesResponse` [interface-SecuritySuggestUserProfilesResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecuritySuggestUserProfilesTotalUserProfiles.md b/docs/reference/api/SecuritySuggestUserProfilesTotalUserProfiles.md index a90642d88..e0002e658 100644 --- a/docs/reference/api/SecuritySuggestUserProfilesTotalUserProfiles.md +++ b/docs/reference/api/SecuritySuggestUserProfilesTotalUserProfiles.md @@ -1,4 +1,4 @@ -## Interface `SecuritySuggestUserProfilesTotalUserProfiles` +# `SecuritySuggestUserProfilesTotalUserProfiles` [interface-SecuritySuggestUserProfilesTotalUserProfiles] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityTemplateFormat.md b/docs/reference/api/SecurityTemplateFormat.md index af572c41b..34c84862d 100644 --- a/docs/reference/api/SecurityTemplateFormat.md +++ b/docs/reference/api/SecurityTemplateFormat.md @@ -1,4 +1,4 @@ -## `SecurityTemplateFormat` -::: +# `SecurityTemplateFormat` [alias-SecurityTemplateFormat] +```typescript type SecurityTemplateFormat = 'string' | 'json'; -::: +``` diff --git a/docs/reference/api/SecurityUpdateApiKeyRequest.md b/docs/reference/api/SecurityUpdateApiKeyRequest.md index e8daa0dd5..5980020ef 100644 --- a/docs/reference/api/SecurityUpdateApiKeyRequest.md +++ b/docs/reference/api/SecurityUpdateApiKeyRequest.md @@ -1,4 +1,4 @@ -## Interface `SecurityUpdateApiKeyRequest` +# `SecurityUpdateApiKeyRequest` [interface-SecurityUpdateApiKeyRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityUpdateApiKeyResponse.md b/docs/reference/api/SecurityUpdateApiKeyResponse.md index 0ebf5d3a1..cb2469394 100644 --- a/docs/reference/api/SecurityUpdateApiKeyResponse.md +++ b/docs/reference/api/SecurityUpdateApiKeyResponse.md @@ -1,4 +1,4 @@ -## Interface `SecurityUpdateApiKeyResponse` +# `SecurityUpdateApiKeyResponse` [interface-SecurityUpdateApiKeyResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityUpdateCrossClusterApiKeyRequest.md b/docs/reference/api/SecurityUpdateCrossClusterApiKeyRequest.md index 1ff73dff2..670fd4e3a 100644 --- a/docs/reference/api/SecurityUpdateCrossClusterApiKeyRequest.md +++ b/docs/reference/api/SecurityUpdateCrossClusterApiKeyRequest.md @@ -1,4 +1,4 @@ -## Interface `SecurityUpdateCrossClusterApiKeyRequest` +# `SecurityUpdateCrossClusterApiKeyRequest` [interface-SecurityUpdateCrossClusterApiKeyRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityUpdateCrossClusterApiKeyResponse.md b/docs/reference/api/SecurityUpdateCrossClusterApiKeyResponse.md index 4c8fd2996..49f9cba39 100644 --- a/docs/reference/api/SecurityUpdateCrossClusterApiKeyResponse.md +++ b/docs/reference/api/SecurityUpdateCrossClusterApiKeyResponse.md @@ -1,4 +1,4 @@ -## Interface `SecurityUpdateCrossClusterApiKeyResponse` +# `SecurityUpdateCrossClusterApiKeyResponse` [interface-SecurityUpdateCrossClusterApiKeyResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityUpdateSettingsRequest.md b/docs/reference/api/SecurityUpdateSettingsRequest.md index 6d05a0b90..b903d62da 100644 --- a/docs/reference/api/SecurityUpdateSettingsRequest.md +++ b/docs/reference/api/SecurityUpdateSettingsRequest.md @@ -1,4 +1,4 @@ -## Interface `SecurityUpdateSettingsRequest` +# `SecurityUpdateSettingsRequest` [interface-SecurityUpdateSettingsRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityUpdateSettingsResponse.md b/docs/reference/api/SecurityUpdateSettingsResponse.md index 2d28ad016..507ca8055 100644 --- a/docs/reference/api/SecurityUpdateSettingsResponse.md +++ b/docs/reference/api/SecurityUpdateSettingsResponse.md @@ -1,4 +1,4 @@ -## Interface `SecurityUpdateSettingsResponse` +# `SecurityUpdateSettingsResponse` [interface-SecurityUpdateSettingsResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityUpdateUserProfileDataRequest.md b/docs/reference/api/SecurityUpdateUserProfileDataRequest.md index 806aa5fba..6ba7df0b5 100644 --- a/docs/reference/api/SecurityUpdateUserProfileDataRequest.md +++ b/docs/reference/api/SecurityUpdateUserProfileDataRequest.md @@ -1,4 +1,4 @@ -## Interface `SecurityUpdateUserProfileDataRequest` +# `SecurityUpdateUserProfileDataRequest` [interface-SecurityUpdateUserProfileDataRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityUpdateUserProfileDataResponse.md b/docs/reference/api/SecurityUpdateUserProfileDataResponse.md index d07ef5ddf..a6e0304a0 100644 --- a/docs/reference/api/SecurityUpdateUserProfileDataResponse.md +++ b/docs/reference/api/SecurityUpdateUserProfileDataResponse.md @@ -1,4 +1,4 @@ -## `SecurityUpdateUserProfileDataResponse` -::: +# `SecurityUpdateUserProfileDataResponse` [alias-SecurityUpdateUserProfileDataResponse] +```typescript type SecurityUpdateUserProfileDataResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); -::: +``` diff --git a/docs/reference/api/SecurityUser.md b/docs/reference/api/SecurityUser.md index e6ab13a2a..04217f90d 100644 --- a/docs/reference/api/SecurityUser.md +++ b/docs/reference/api/SecurityUser.md @@ -1,4 +1,4 @@ -## Interface `SecurityUser` +# `SecurityUser` [interface-SecurityUser] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityUserIndicesPrivileges.md b/docs/reference/api/SecurityUserIndicesPrivileges.md index a79d22421..e0f07db9b 100644 --- a/docs/reference/api/SecurityUserIndicesPrivileges.md +++ b/docs/reference/api/SecurityUserIndicesPrivileges.md @@ -1,4 +1,4 @@ -## Interface `SecurityUserIndicesPrivileges` +# `SecurityUserIndicesPrivileges` [interface-SecurityUserIndicesPrivileges] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityUserProfile.md b/docs/reference/api/SecurityUserProfile.md index 9e2856da1..df3f31ff2 100644 --- a/docs/reference/api/SecurityUserProfile.md +++ b/docs/reference/api/SecurityUserProfile.md @@ -1,4 +1,4 @@ -## Interface `SecurityUserProfile` +# `SecurityUserProfile` [interface-SecurityUserProfile] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityUserProfileHitMetadata.md b/docs/reference/api/SecurityUserProfileHitMetadata.md index 07fc2fccf..ee1e744dc 100644 --- a/docs/reference/api/SecurityUserProfileHitMetadata.md +++ b/docs/reference/api/SecurityUserProfileHitMetadata.md @@ -1,4 +1,4 @@ -## Interface `SecurityUserProfileHitMetadata` +# `SecurityUserProfileHitMetadata` [interface-SecurityUserProfileHitMetadata] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityUserProfileId.md b/docs/reference/api/SecurityUserProfileId.md index 19ae129b1..a302bb1ea 100644 --- a/docs/reference/api/SecurityUserProfileId.md +++ b/docs/reference/api/SecurityUserProfileId.md @@ -1,4 +1,4 @@ -## `SecurityUserProfileId` -::: +# `SecurityUserProfileId` [alias-SecurityUserProfileId] +```typescript type SecurityUserProfileId = string; -::: +``` diff --git a/docs/reference/api/SecurityUserProfileUser.md b/docs/reference/api/SecurityUserProfileUser.md index e9bcb4218..c64230b5c 100644 --- a/docs/reference/api/SecurityUserProfileUser.md +++ b/docs/reference/api/SecurityUserProfileUser.md @@ -1,4 +1,4 @@ -## Interface `SecurityUserProfileUser` +# `SecurityUserProfileUser` [interface-SecurityUserProfileUser] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SecurityUserProfileWithMetadata.md b/docs/reference/api/SecurityUserProfileWithMetadata.md index ec9e3dde3..a4e09f2ae 100644 --- a/docs/reference/api/SecurityUserProfileWithMetadata.md +++ b/docs/reference/api/SecurityUserProfileWithMetadata.md @@ -1,4 +1,4 @@ -## Interface `SecurityUserProfileWithMetadata` +# `SecurityUserProfileWithMetadata` [interface-SecurityUserProfileWithMetadata] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SegmentsStats.md b/docs/reference/api/SegmentsStats.md index b226ef2b8..fba735afc 100644 --- a/docs/reference/api/SegmentsStats.md +++ b/docs/reference/api/SegmentsStats.md @@ -1,4 +1,4 @@ -## Interface `SegmentsStats` +# `SegmentsStats` [interface-SegmentsStats] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SequenceNumber.md b/docs/reference/api/SequenceNumber.md index 545f2587b..111c1a781 100644 --- a/docs/reference/api/SequenceNumber.md +++ b/docs/reference/api/SequenceNumber.md @@ -1,4 +1,4 @@ -## `SequenceNumber` -::: +# `SequenceNumber` [alias-SequenceNumber] +```typescript type SequenceNumber = [long](./long.md); -::: +``` diff --git a/docs/reference/api/Service.md b/docs/reference/api/Service.md index ed15e9572..c36bc8df9 100644 --- a/docs/reference/api/Service.md +++ b/docs/reference/api/Service.md @@ -1,4 +1,4 @@ -## `Service` -::: +# `Service` [alias-Service] +```typescript type Service = string; -::: +``` diff --git a/docs/reference/api/ShardFailure.md b/docs/reference/api/ShardFailure.md index 100c03c5b..f3aa24768 100644 --- a/docs/reference/api/ShardFailure.md +++ b/docs/reference/api/ShardFailure.md @@ -1,4 +1,4 @@ -## Interface `ShardFailure` +# `ShardFailure` [interface-ShardFailure] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ShardStatistics.md b/docs/reference/api/ShardStatistics.md index af7446607..ba3d4ac05 100644 --- a/docs/reference/api/ShardStatistics.md +++ b/docs/reference/api/ShardStatistics.md @@ -1,4 +1,4 @@ -## Interface `ShardStatistics` +# `ShardStatistics` [interface-ShardStatistics] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ShardsOperationResponseBase.md b/docs/reference/api/ShardsOperationResponseBase.md index 6ea3648f0..5f6f10af1 100644 --- a/docs/reference/api/ShardsOperationResponseBase.md +++ b/docs/reference/api/ShardsOperationResponseBase.md @@ -1,4 +1,4 @@ -## Interface `ShardsOperationResponseBase` +# `ShardsOperationResponseBase` [interface-ShardsOperationResponseBase] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/Shutdown.md b/docs/reference/api/Shutdown.md index 13b84daf4..130705875 100644 --- a/docs/reference/api/Shutdown.md +++ b/docs/reference/api/Shutdown.md @@ -1,19 +1,19 @@ -## `Shutdown` +# `Shutdown` [class-Shutdown] -### Constructor +## Constructor -::: +```typescript new Shutdown(transport: [Transport](./Transport.md)); -::: +``` -### Properties +## Properties [class-properties-Shutdown] | Name | Type | Description | | - | - | - | | `acceptedParams` | Record |   | | `transport` | [Transport](./Transport.md) |   | -### Methods +## Methods [class-methods-Shutdown] | Name | Signature | Description | | - | - | - | diff --git a/docs/reference/api/ShutdownDeleteNodeRequest.md b/docs/reference/api/ShutdownDeleteNodeRequest.md index 036c6dec5..8319b253e 100644 --- a/docs/reference/api/ShutdownDeleteNodeRequest.md +++ b/docs/reference/api/ShutdownDeleteNodeRequest.md @@ -1,4 +1,4 @@ -## Interface `ShutdownDeleteNodeRequest` +# `ShutdownDeleteNodeRequest` [interface-ShutdownDeleteNodeRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ShutdownDeleteNodeResponse.md b/docs/reference/api/ShutdownDeleteNodeResponse.md index 816d2d346..5114c3e82 100644 --- a/docs/reference/api/ShutdownDeleteNodeResponse.md +++ b/docs/reference/api/ShutdownDeleteNodeResponse.md @@ -1,4 +1,4 @@ -## `ShutdownDeleteNodeResponse` -::: +# `ShutdownDeleteNodeResponse` [alias-ShutdownDeleteNodeResponse] +```typescript type ShutdownDeleteNodeResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); -::: +``` diff --git a/docs/reference/api/ShutdownGetNodeNodeShutdownStatus.md b/docs/reference/api/ShutdownGetNodeNodeShutdownStatus.md index ea20da843..9d2cabf20 100644 --- a/docs/reference/api/ShutdownGetNodeNodeShutdownStatus.md +++ b/docs/reference/api/ShutdownGetNodeNodeShutdownStatus.md @@ -1,4 +1,4 @@ -## Interface `ShutdownGetNodeNodeShutdownStatus` +# `ShutdownGetNodeNodeShutdownStatus` [interface-ShutdownGetNodeNodeShutdownStatus] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ShutdownGetNodePersistentTaskStatus.md b/docs/reference/api/ShutdownGetNodePersistentTaskStatus.md index 3ca047819..10133c8d1 100644 --- a/docs/reference/api/ShutdownGetNodePersistentTaskStatus.md +++ b/docs/reference/api/ShutdownGetNodePersistentTaskStatus.md @@ -1,4 +1,4 @@ -## Interface `ShutdownGetNodePersistentTaskStatus` +# `ShutdownGetNodePersistentTaskStatus` [interface-ShutdownGetNodePersistentTaskStatus] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ShutdownGetNodePluginsStatus.md b/docs/reference/api/ShutdownGetNodePluginsStatus.md index bbbdfb2c4..41027a2bb 100644 --- a/docs/reference/api/ShutdownGetNodePluginsStatus.md +++ b/docs/reference/api/ShutdownGetNodePluginsStatus.md @@ -1,4 +1,4 @@ -## Interface `ShutdownGetNodePluginsStatus` +# `ShutdownGetNodePluginsStatus` [interface-ShutdownGetNodePluginsStatus] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ShutdownGetNodeRequest.md b/docs/reference/api/ShutdownGetNodeRequest.md index c7ed89c9c..071b2438b 100644 --- a/docs/reference/api/ShutdownGetNodeRequest.md +++ b/docs/reference/api/ShutdownGetNodeRequest.md @@ -1,4 +1,4 @@ -## Interface `ShutdownGetNodeRequest` +# `ShutdownGetNodeRequest` [interface-ShutdownGetNodeRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ShutdownGetNodeResponse.md b/docs/reference/api/ShutdownGetNodeResponse.md index fe8690467..7a58deee1 100644 --- a/docs/reference/api/ShutdownGetNodeResponse.md +++ b/docs/reference/api/ShutdownGetNodeResponse.md @@ -1,4 +1,4 @@ -## Interface `ShutdownGetNodeResponse` +# `ShutdownGetNodeResponse` [interface-ShutdownGetNodeResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ShutdownGetNodeShardMigrationStatus.md b/docs/reference/api/ShutdownGetNodeShardMigrationStatus.md index 855f16306..4a15f582e 100644 --- a/docs/reference/api/ShutdownGetNodeShardMigrationStatus.md +++ b/docs/reference/api/ShutdownGetNodeShardMigrationStatus.md @@ -1,4 +1,4 @@ -## Interface `ShutdownGetNodeShardMigrationStatus` +# `ShutdownGetNodeShardMigrationStatus` [interface-ShutdownGetNodeShardMigrationStatus] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ShutdownGetNodeShutdownStatus.md b/docs/reference/api/ShutdownGetNodeShutdownStatus.md index 429b7f494..27b7cc494 100644 --- a/docs/reference/api/ShutdownGetNodeShutdownStatus.md +++ b/docs/reference/api/ShutdownGetNodeShutdownStatus.md @@ -1,4 +1,4 @@ -## `ShutdownGetNodeShutdownStatus` -::: +# `ShutdownGetNodeShutdownStatus` [alias-ShutdownGetNodeShutdownStatus] +```typescript type ShutdownGetNodeShutdownStatus = 'not_started' | 'in_progress' | 'stalled' | 'complete'; -::: +``` diff --git a/docs/reference/api/ShutdownGetNodeShutdownType.md b/docs/reference/api/ShutdownGetNodeShutdownType.md index b85ed6315..bab33b788 100644 --- a/docs/reference/api/ShutdownGetNodeShutdownType.md +++ b/docs/reference/api/ShutdownGetNodeShutdownType.md @@ -1,4 +1,4 @@ -## `ShutdownGetNodeShutdownType` -::: +# `ShutdownGetNodeShutdownType` [alias-ShutdownGetNodeShutdownType] +```typescript type ShutdownGetNodeShutdownType = 'remove' | 'restart'; -::: +``` diff --git a/docs/reference/api/ShutdownPutNodeRequest.md b/docs/reference/api/ShutdownPutNodeRequest.md index 8a94f76c5..4d1fe29ef 100644 --- a/docs/reference/api/ShutdownPutNodeRequest.md +++ b/docs/reference/api/ShutdownPutNodeRequest.md @@ -1,4 +1,4 @@ -## Interface `ShutdownPutNodeRequest` +# `ShutdownPutNodeRequest` [interface-ShutdownPutNodeRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ShutdownPutNodeResponse.md b/docs/reference/api/ShutdownPutNodeResponse.md index f4ddaddda..eb6d67b16 100644 --- a/docs/reference/api/ShutdownPutNodeResponse.md +++ b/docs/reference/api/ShutdownPutNodeResponse.md @@ -1,4 +1,4 @@ -## `ShutdownPutNodeResponse` -::: +# `ShutdownPutNodeResponse` [alias-ShutdownPutNodeResponse] +```typescript type ShutdownPutNodeResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); -::: +``` diff --git a/docs/reference/api/ShutdownType.md b/docs/reference/api/ShutdownType.md index e7030bc2f..ea16cf45d 100644 --- a/docs/reference/api/ShutdownType.md +++ b/docs/reference/api/ShutdownType.md @@ -1,4 +1,4 @@ -## `ShutdownType` -::: +# `ShutdownType` [alias-ShutdownType] +```typescript type ShutdownType = 'restart' | 'remove' | 'replace'; -::: +``` diff --git a/docs/reference/api/Simulate.md b/docs/reference/api/Simulate.md index 1ea3524d9..e8df37864 100644 --- a/docs/reference/api/Simulate.md +++ b/docs/reference/api/Simulate.md @@ -1,19 +1,19 @@ -## `Simulate` +# `Simulate` [class-Simulate] -### Constructor +## Constructor -::: +```typescript new Simulate(transport: [Transport](./Transport.md)); -::: +``` -### Properties +## Properties [class-properties-Simulate] | Name | Type | Description | | - | - | - | | `acceptedParams` | Record |   | | `transport` | [Transport](./Transport.md) |   | -### Methods +## Methods [class-methods-Simulate] | Name | Signature | Description | | - | - | - | diff --git a/docs/reference/api/SimulateIngestIngestDocumentSimulation.md b/docs/reference/api/SimulateIngestIngestDocumentSimulation.md index aeda5fa67..451cc67a0 100644 --- a/docs/reference/api/SimulateIngestIngestDocumentSimulation.md +++ b/docs/reference/api/SimulateIngestIngestDocumentSimulation.md @@ -1,4 +1,4 @@ -## `SimulateIngestIngestDocumentSimulation` -::: +# `SimulateIngestIngestDocumentSimulation` [alias-SimulateIngestIngestDocumentSimulation] +```typescript type SimulateIngestIngestDocumentSimulation = [SimulateIngestIngestDocumentSimulationKeys](./SimulateIngestIngestDocumentSimulationKeys.md) & { [property: string]: string | [Id](./Id.md) | [IndexName](./IndexName.md) | Record | [SpecUtilsStringified](./SpecUtilsStringified.md)<[VersionNumber](./VersionNumber.md)> | string[] | Record[] | [ErrorCause](./ErrorCause.md);}; -::: +``` diff --git a/docs/reference/api/SimulateIngestIngestDocumentSimulationKeys.md b/docs/reference/api/SimulateIngestIngestDocumentSimulationKeys.md index 6e81dab25..f9901f877 100644 --- a/docs/reference/api/SimulateIngestIngestDocumentSimulationKeys.md +++ b/docs/reference/api/SimulateIngestIngestDocumentSimulationKeys.md @@ -1,4 +1,4 @@ -## Interface `SimulateIngestIngestDocumentSimulationKeys` +# `SimulateIngestIngestDocumentSimulationKeys` [interface-SimulateIngestIngestDocumentSimulationKeys] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SimulateIngestRequest.md b/docs/reference/api/SimulateIngestRequest.md index 7094dcb60..30cbf4996 100644 --- a/docs/reference/api/SimulateIngestRequest.md +++ b/docs/reference/api/SimulateIngestRequest.md @@ -1,4 +1,4 @@ -## Interface `SimulateIngestRequest` +# `SimulateIngestRequest` [interface-SimulateIngestRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SimulateIngestResponse.md b/docs/reference/api/SimulateIngestResponse.md index f781cf0d4..03eac6966 100644 --- a/docs/reference/api/SimulateIngestResponse.md +++ b/docs/reference/api/SimulateIngestResponse.md @@ -1,4 +1,4 @@ -## Interface `SimulateIngestResponse` +# `SimulateIngestResponse` [interface-SimulateIngestResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SimulateIngestSimulateIngestDocumentResult.md b/docs/reference/api/SimulateIngestSimulateIngestDocumentResult.md index 240d568ea..ad7065418 100644 --- a/docs/reference/api/SimulateIngestSimulateIngestDocumentResult.md +++ b/docs/reference/api/SimulateIngestSimulateIngestDocumentResult.md @@ -1,4 +1,4 @@ -## Interface `SimulateIngestSimulateIngestDocumentResult` +# `SimulateIngestSimulateIngestDocumentResult` [interface-SimulateIngestSimulateIngestDocumentResult] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SlicedScroll.md b/docs/reference/api/SlicedScroll.md index 8a708f27a..5845fce35 100644 --- a/docs/reference/api/SlicedScroll.md +++ b/docs/reference/api/SlicedScroll.md @@ -1,4 +1,4 @@ -## Interface `SlicedScroll` +# `SlicedScroll` [interface-SlicedScroll] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/Slices.md b/docs/reference/api/Slices.md index 53b8bac43..d374873f6 100644 --- a/docs/reference/api/Slices.md +++ b/docs/reference/api/Slices.md @@ -1,4 +1,4 @@ -## `Slices` -::: +# `Slices` [alias-Slices] +```typescript type Slices = [integer](./integer.md) | [SlicesCalculation](./SlicesCalculation.md); -::: +``` diff --git a/docs/reference/api/SlicesCalculation.md b/docs/reference/api/SlicesCalculation.md index 61b17837c..c5ac260ca 100644 --- a/docs/reference/api/SlicesCalculation.md +++ b/docs/reference/api/SlicesCalculation.md @@ -1,4 +1,4 @@ -## `SlicesCalculation` -::: +# `SlicesCalculation` [alias-SlicesCalculation] +```typescript type SlicesCalculation = 'auto'; -::: +``` diff --git a/docs/reference/api/Slm.md b/docs/reference/api/Slm.md index 712874e89..22e31048e 100644 --- a/docs/reference/api/Slm.md +++ b/docs/reference/api/Slm.md @@ -1,19 +1,19 @@ -## `Slm` +# `Slm` [class-Slm] -### Constructor +## Constructor -::: +```typescript new Slm(transport: [Transport](./Transport.md)); -::: +``` -### Properties +## Properties [class-properties-Slm] | Name | Type | Description | | - | - | - | | `acceptedParams` | Record |   | | `transport` | [Transport](./Transport.md) |   | -### Methods +## Methods [class-methods-Slm] | Name | Signature | Description | | - | - | - | diff --git a/docs/reference/api/SlmConfiguration.md b/docs/reference/api/SlmConfiguration.md index 1d49ac894..ecefa699d 100644 --- a/docs/reference/api/SlmConfiguration.md +++ b/docs/reference/api/SlmConfiguration.md @@ -1,4 +1,4 @@ -## Interface `SlmConfiguration` +# `SlmConfiguration` [interface-SlmConfiguration] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SlmDeleteLifecycleRequest.md b/docs/reference/api/SlmDeleteLifecycleRequest.md index ddd8d9ee2..7d301e5e2 100644 --- a/docs/reference/api/SlmDeleteLifecycleRequest.md +++ b/docs/reference/api/SlmDeleteLifecycleRequest.md @@ -1,4 +1,4 @@ -## Interface `SlmDeleteLifecycleRequest` +# `SlmDeleteLifecycleRequest` [interface-SlmDeleteLifecycleRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SlmDeleteLifecycleResponse.md b/docs/reference/api/SlmDeleteLifecycleResponse.md index 9297b1bfb..f71f0c2ad 100644 --- a/docs/reference/api/SlmDeleteLifecycleResponse.md +++ b/docs/reference/api/SlmDeleteLifecycleResponse.md @@ -1,4 +1,4 @@ -## `SlmDeleteLifecycleResponse` -::: +# `SlmDeleteLifecycleResponse` [alias-SlmDeleteLifecycleResponse] +```typescript type SlmDeleteLifecycleResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); -::: +``` diff --git a/docs/reference/api/SlmExecuteLifecycleRequest.md b/docs/reference/api/SlmExecuteLifecycleRequest.md index 848285c20..b681ab30a 100644 --- a/docs/reference/api/SlmExecuteLifecycleRequest.md +++ b/docs/reference/api/SlmExecuteLifecycleRequest.md @@ -1,4 +1,4 @@ -## Interface `SlmExecuteLifecycleRequest` +# `SlmExecuteLifecycleRequest` [interface-SlmExecuteLifecycleRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SlmExecuteLifecycleResponse.md b/docs/reference/api/SlmExecuteLifecycleResponse.md index 6bee818a5..465628f7f 100644 --- a/docs/reference/api/SlmExecuteLifecycleResponse.md +++ b/docs/reference/api/SlmExecuteLifecycleResponse.md @@ -1,4 +1,4 @@ -## Interface `SlmExecuteLifecycleResponse` +# `SlmExecuteLifecycleResponse` [interface-SlmExecuteLifecycleResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SlmExecuteRetentionRequest.md b/docs/reference/api/SlmExecuteRetentionRequest.md index dc248f2e7..b3cdebe4a 100644 --- a/docs/reference/api/SlmExecuteRetentionRequest.md +++ b/docs/reference/api/SlmExecuteRetentionRequest.md @@ -1,4 +1,4 @@ -## Interface `SlmExecuteRetentionRequest` +# `SlmExecuteRetentionRequest` [interface-SlmExecuteRetentionRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SlmExecuteRetentionResponse.md b/docs/reference/api/SlmExecuteRetentionResponse.md index a27ddd358..7a2d06ad2 100644 --- a/docs/reference/api/SlmExecuteRetentionResponse.md +++ b/docs/reference/api/SlmExecuteRetentionResponse.md @@ -1,4 +1,4 @@ -## `SlmExecuteRetentionResponse` -::: +# `SlmExecuteRetentionResponse` [alias-SlmExecuteRetentionResponse] +```typescript type SlmExecuteRetentionResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); -::: +``` diff --git a/docs/reference/api/SlmGetLifecycleRequest.md b/docs/reference/api/SlmGetLifecycleRequest.md index 7daf8b0ac..1be3772d0 100644 --- a/docs/reference/api/SlmGetLifecycleRequest.md +++ b/docs/reference/api/SlmGetLifecycleRequest.md @@ -1,4 +1,4 @@ -## Interface `SlmGetLifecycleRequest` +# `SlmGetLifecycleRequest` [interface-SlmGetLifecycleRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SlmGetLifecycleResponse.md b/docs/reference/api/SlmGetLifecycleResponse.md index 24f61b6e5..1c0b0461b 100644 --- a/docs/reference/api/SlmGetLifecycleResponse.md +++ b/docs/reference/api/SlmGetLifecycleResponse.md @@ -1,4 +1,4 @@ -## `SlmGetLifecycleResponse` -::: +# `SlmGetLifecycleResponse` [alias-SlmGetLifecycleResponse] +```typescript type SlmGetLifecycleResponse = Record<[Id](./Id.md), [SlmSnapshotLifecycle](./SlmSnapshotLifecycle.md)>; -::: +``` diff --git a/docs/reference/api/SlmGetStatsRequest.md b/docs/reference/api/SlmGetStatsRequest.md index be0cc892f..e6e66f2ae 100644 --- a/docs/reference/api/SlmGetStatsRequest.md +++ b/docs/reference/api/SlmGetStatsRequest.md @@ -1,4 +1,4 @@ -## Interface `SlmGetStatsRequest` +# `SlmGetStatsRequest` [interface-SlmGetStatsRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SlmGetStatsResponse.md b/docs/reference/api/SlmGetStatsResponse.md index 77e475e4e..b5d66cb74 100644 --- a/docs/reference/api/SlmGetStatsResponse.md +++ b/docs/reference/api/SlmGetStatsResponse.md @@ -1,4 +1,4 @@ -## Interface `SlmGetStatsResponse` +# `SlmGetStatsResponse` [interface-SlmGetStatsResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SlmGetStatusRequest.md b/docs/reference/api/SlmGetStatusRequest.md index e1e702b33..48165fad4 100644 --- a/docs/reference/api/SlmGetStatusRequest.md +++ b/docs/reference/api/SlmGetStatusRequest.md @@ -1,4 +1,4 @@ -## Interface `SlmGetStatusRequest` +# `SlmGetStatusRequest` [interface-SlmGetStatusRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SlmGetStatusResponse.md b/docs/reference/api/SlmGetStatusResponse.md index c9d2c58b1..94b0a2fbf 100644 --- a/docs/reference/api/SlmGetStatusResponse.md +++ b/docs/reference/api/SlmGetStatusResponse.md @@ -1,4 +1,4 @@ -## Interface `SlmGetStatusResponse` +# `SlmGetStatusResponse` [interface-SlmGetStatusResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SlmInProgress.md b/docs/reference/api/SlmInProgress.md index 4218d6e75..343937779 100644 --- a/docs/reference/api/SlmInProgress.md +++ b/docs/reference/api/SlmInProgress.md @@ -1,4 +1,4 @@ -## Interface `SlmInProgress` +# `SlmInProgress` [interface-SlmInProgress] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SlmInvocation.md b/docs/reference/api/SlmInvocation.md index 24d1df714..5db0e41f1 100644 --- a/docs/reference/api/SlmInvocation.md +++ b/docs/reference/api/SlmInvocation.md @@ -1,4 +1,4 @@ -## Interface `SlmInvocation` +# `SlmInvocation` [interface-SlmInvocation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SlmPolicy.md b/docs/reference/api/SlmPolicy.md index b65feb0a6..6bc436a5d 100644 --- a/docs/reference/api/SlmPolicy.md +++ b/docs/reference/api/SlmPolicy.md @@ -1,4 +1,4 @@ -## Interface `SlmPolicy` +# `SlmPolicy` [interface-SlmPolicy] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SlmPutLifecycleRequest.md b/docs/reference/api/SlmPutLifecycleRequest.md index 856402f4e..a5543f164 100644 --- a/docs/reference/api/SlmPutLifecycleRequest.md +++ b/docs/reference/api/SlmPutLifecycleRequest.md @@ -1,4 +1,4 @@ -## Interface `SlmPutLifecycleRequest` +# `SlmPutLifecycleRequest` [interface-SlmPutLifecycleRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SlmPutLifecycleResponse.md b/docs/reference/api/SlmPutLifecycleResponse.md index fd840bb86..6bb27e719 100644 --- a/docs/reference/api/SlmPutLifecycleResponse.md +++ b/docs/reference/api/SlmPutLifecycleResponse.md @@ -1,4 +1,4 @@ -## `SlmPutLifecycleResponse` -::: +# `SlmPutLifecycleResponse` [alias-SlmPutLifecycleResponse] +```typescript type SlmPutLifecycleResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); -::: +``` diff --git a/docs/reference/api/SlmRetention.md b/docs/reference/api/SlmRetention.md index 193c426a1..cc6749c46 100644 --- a/docs/reference/api/SlmRetention.md +++ b/docs/reference/api/SlmRetention.md @@ -1,4 +1,4 @@ -## Interface `SlmRetention` +# `SlmRetention` [interface-SlmRetention] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SlmSnapshotLifecycle.md b/docs/reference/api/SlmSnapshotLifecycle.md index 7c20a4be4..7beaedf9b 100644 --- a/docs/reference/api/SlmSnapshotLifecycle.md +++ b/docs/reference/api/SlmSnapshotLifecycle.md @@ -1,4 +1,4 @@ -## Interface `SlmSnapshotLifecycle` +# `SlmSnapshotLifecycle` [interface-SlmSnapshotLifecycle] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SlmStartRequest.md b/docs/reference/api/SlmStartRequest.md index fe03e47c0..a9f062f35 100644 --- a/docs/reference/api/SlmStartRequest.md +++ b/docs/reference/api/SlmStartRequest.md @@ -1,4 +1,4 @@ -## Interface `SlmStartRequest` +# `SlmStartRequest` [interface-SlmStartRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SlmStartResponse.md b/docs/reference/api/SlmStartResponse.md index 6c40e7d3c..a529c3154 100644 --- a/docs/reference/api/SlmStartResponse.md +++ b/docs/reference/api/SlmStartResponse.md @@ -1,4 +1,4 @@ -## `SlmStartResponse` -::: +# `SlmStartResponse` [alias-SlmStartResponse] +```typescript type SlmStartResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); -::: +``` diff --git a/docs/reference/api/SlmStatistics.md b/docs/reference/api/SlmStatistics.md index 7c02ca5d9..4254a9b2e 100644 --- a/docs/reference/api/SlmStatistics.md +++ b/docs/reference/api/SlmStatistics.md @@ -1,4 +1,4 @@ -## Interface `SlmStatistics` +# `SlmStatistics` [interface-SlmStatistics] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SlmStopRequest.md b/docs/reference/api/SlmStopRequest.md index 2d111c5d3..629d1d821 100644 --- a/docs/reference/api/SlmStopRequest.md +++ b/docs/reference/api/SlmStopRequest.md @@ -1,4 +1,4 @@ -## Interface `SlmStopRequest` +# `SlmStopRequest` [interface-SlmStopRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SlmStopResponse.md b/docs/reference/api/SlmStopResponse.md index 86dda46b5..27d25820c 100644 --- a/docs/reference/api/SlmStopResponse.md +++ b/docs/reference/api/SlmStopResponse.md @@ -1,4 +1,4 @@ -## `SlmStopResponse` -::: +# `SlmStopResponse` [alias-SlmStopResponse] +```typescript type SlmStopResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); -::: +``` diff --git a/docs/reference/api/Snapshot.md b/docs/reference/api/Snapshot.md index d498344fb..20dc27d7f 100644 --- a/docs/reference/api/Snapshot.md +++ b/docs/reference/api/Snapshot.md @@ -1,19 +1,19 @@ -## `Snapshot` +# `Snapshot` [class-Snapshot] -### Constructor +## Constructor -::: +```typescript new Snapshot(transport: [Transport](./Transport.md)); -::: +``` -### Properties +## Properties [class-properties-Snapshot] | Name | Type | Description | | - | - | - | | `acceptedParams` | Record |   | | `transport` | [Transport](./Transport.md) |   | -### Methods +## Methods [class-methods-Snapshot] | Name | Signature | Description | | - | - | - | diff --git a/docs/reference/api/SnapshotAzureRepository.md b/docs/reference/api/SnapshotAzureRepository.md index 68639b0d4..34f21d90e 100644 --- a/docs/reference/api/SnapshotAzureRepository.md +++ b/docs/reference/api/SnapshotAzureRepository.md @@ -1,4 +1,4 @@ -## Interface `SnapshotAzureRepository` +# `SnapshotAzureRepository` [interface-SnapshotAzureRepository] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SnapshotAzureRepositorySettings.md b/docs/reference/api/SnapshotAzureRepositorySettings.md index f6c72177b..baf3f5c67 100644 --- a/docs/reference/api/SnapshotAzureRepositorySettings.md +++ b/docs/reference/api/SnapshotAzureRepositorySettings.md @@ -1,4 +1,4 @@ -## Interface `SnapshotAzureRepositorySettings` +# `SnapshotAzureRepositorySettings` [interface-SnapshotAzureRepositorySettings] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SnapshotCleanupRepositoryCleanupRepositoryResults.md b/docs/reference/api/SnapshotCleanupRepositoryCleanupRepositoryResults.md index 0a709403b..dd0a5bbca 100644 --- a/docs/reference/api/SnapshotCleanupRepositoryCleanupRepositoryResults.md +++ b/docs/reference/api/SnapshotCleanupRepositoryCleanupRepositoryResults.md @@ -1,4 +1,4 @@ -## Interface `SnapshotCleanupRepositoryCleanupRepositoryResults` +# `SnapshotCleanupRepositoryCleanupRepositoryResults` [interface-SnapshotCleanupRepositoryCleanupRepositoryResults] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SnapshotCleanupRepositoryRequest.md b/docs/reference/api/SnapshotCleanupRepositoryRequest.md index 207df338a..68f55549c 100644 --- a/docs/reference/api/SnapshotCleanupRepositoryRequest.md +++ b/docs/reference/api/SnapshotCleanupRepositoryRequest.md @@ -1,4 +1,4 @@ -## Interface `SnapshotCleanupRepositoryRequest` +# `SnapshotCleanupRepositoryRequest` [interface-SnapshotCleanupRepositoryRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SnapshotCleanupRepositoryResponse.md b/docs/reference/api/SnapshotCleanupRepositoryResponse.md index e323023f6..3f0b19d0d 100644 --- a/docs/reference/api/SnapshotCleanupRepositoryResponse.md +++ b/docs/reference/api/SnapshotCleanupRepositoryResponse.md @@ -1,4 +1,4 @@ -## Interface `SnapshotCleanupRepositoryResponse` +# `SnapshotCleanupRepositoryResponse` [interface-SnapshotCleanupRepositoryResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SnapshotCloneRequest.md b/docs/reference/api/SnapshotCloneRequest.md index 6122c07df..d21b9568f 100644 --- a/docs/reference/api/SnapshotCloneRequest.md +++ b/docs/reference/api/SnapshotCloneRequest.md @@ -1,4 +1,4 @@ -## Interface `SnapshotCloneRequest` +# `SnapshotCloneRequest` [interface-SnapshotCloneRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SnapshotCloneResponse.md b/docs/reference/api/SnapshotCloneResponse.md index d2719bd06..dd6528f7a 100644 --- a/docs/reference/api/SnapshotCloneResponse.md +++ b/docs/reference/api/SnapshotCloneResponse.md @@ -1,4 +1,4 @@ -## `SnapshotCloneResponse` -::: +# `SnapshotCloneResponse` [alias-SnapshotCloneResponse] +```typescript type SnapshotCloneResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); -::: +``` diff --git a/docs/reference/api/SnapshotCreateRepositoryRequest.md b/docs/reference/api/SnapshotCreateRepositoryRequest.md index 2f7463a25..7c7695564 100644 --- a/docs/reference/api/SnapshotCreateRepositoryRequest.md +++ b/docs/reference/api/SnapshotCreateRepositoryRequest.md @@ -1,4 +1,4 @@ -## Interface `SnapshotCreateRepositoryRequest` +# `SnapshotCreateRepositoryRequest` [interface-SnapshotCreateRepositoryRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SnapshotCreateRepositoryResponse.md b/docs/reference/api/SnapshotCreateRepositoryResponse.md index a1602984b..0d4e75b1e 100644 --- a/docs/reference/api/SnapshotCreateRepositoryResponse.md +++ b/docs/reference/api/SnapshotCreateRepositoryResponse.md @@ -1,4 +1,4 @@ -## `SnapshotCreateRepositoryResponse` -::: +# `SnapshotCreateRepositoryResponse` [alias-SnapshotCreateRepositoryResponse] +```typescript type SnapshotCreateRepositoryResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); -::: +``` diff --git a/docs/reference/api/SnapshotCreateRequest.md b/docs/reference/api/SnapshotCreateRequest.md index aa1904328..b8019d75d 100644 --- a/docs/reference/api/SnapshotCreateRequest.md +++ b/docs/reference/api/SnapshotCreateRequest.md @@ -1,4 +1,4 @@ -## Interface `SnapshotCreateRequest` +# `SnapshotCreateRequest` [interface-SnapshotCreateRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SnapshotCreateResponse.md b/docs/reference/api/SnapshotCreateResponse.md index 667f32559..8b634bf9e 100644 --- a/docs/reference/api/SnapshotCreateResponse.md +++ b/docs/reference/api/SnapshotCreateResponse.md @@ -1,4 +1,4 @@ -## Interface `SnapshotCreateResponse` +# `SnapshotCreateResponse` [interface-SnapshotCreateResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SnapshotDeleteRepositoryRequest.md b/docs/reference/api/SnapshotDeleteRepositoryRequest.md index 91b6c03ce..82bdecb2d 100644 --- a/docs/reference/api/SnapshotDeleteRepositoryRequest.md +++ b/docs/reference/api/SnapshotDeleteRepositoryRequest.md @@ -1,4 +1,4 @@ -## Interface `SnapshotDeleteRepositoryRequest` +# `SnapshotDeleteRepositoryRequest` [interface-SnapshotDeleteRepositoryRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SnapshotDeleteRepositoryResponse.md b/docs/reference/api/SnapshotDeleteRepositoryResponse.md index bdf8b400b..021d48eec 100644 --- a/docs/reference/api/SnapshotDeleteRepositoryResponse.md +++ b/docs/reference/api/SnapshotDeleteRepositoryResponse.md @@ -1,4 +1,4 @@ -## `SnapshotDeleteRepositoryResponse` -::: +# `SnapshotDeleteRepositoryResponse` [alias-SnapshotDeleteRepositoryResponse] +```typescript type SnapshotDeleteRepositoryResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); -::: +``` diff --git a/docs/reference/api/SnapshotDeleteRequest.md b/docs/reference/api/SnapshotDeleteRequest.md index 39c63ff8b..347493ebd 100644 --- a/docs/reference/api/SnapshotDeleteRequest.md +++ b/docs/reference/api/SnapshotDeleteRequest.md @@ -1,4 +1,4 @@ -## Interface `SnapshotDeleteRequest` +# `SnapshotDeleteRequest` [interface-SnapshotDeleteRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SnapshotDeleteResponse.md b/docs/reference/api/SnapshotDeleteResponse.md index 7411ce088..59aaf8072 100644 --- a/docs/reference/api/SnapshotDeleteResponse.md +++ b/docs/reference/api/SnapshotDeleteResponse.md @@ -1,4 +1,4 @@ -## `SnapshotDeleteResponse` -::: +# `SnapshotDeleteResponse` [alias-SnapshotDeleteResponse] +```typescript type SnapshotDeleteResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); -::: +``` diff --git a/docs/reference/api/SnapshotFileCountSnapshotStats.md b/docs/reference/api/SnapshotFileCountSnapshotStats.md index 6a23f5b6d..1e6cdbb75 100644 --- a/docs/reference/api/SnapshotFileCountSnapshotStats.md +++ b/docs/reference/api/SnapshotFileCountSnapshotStats.md @@ -1,4 +1,4 @@ -## Interface `SnapshotFileCountSnapshotStats` +# `SnapshotFileCountSnapshotStats` [interface-SnapshotFileCountSnapshotStats] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SnapshotGcsRepository.md b/docs/reference/api/SnapshotGcsRepository.md index 4bebd299f..6ebb0c7b7 100644 --- a/docs/reference/api/SnapshotGcsRepository.md +++ b/docs/reference/api/SnapshotGcsRepository.md @@ -1,4 +1,4 @@ -## Interface `SnapshotGcsRepository` +# `SnapshotGcsRepository` [interface-SnapshotGcsRepository] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SnapshotGcsRepositorySettings.md b/docs/reference/api/SnapshotGcsRepositorySettings.md index d2d341022..01c6ab979 100644 --- a/docs/reference/api/SnapshotGcsRepositorySettings.md +++ b/docs/reference/api/SnapshotGcsRepositorySettings.md @@ -1,4 +1,4 @@ -## Interface `SnapshotGcsRepositorySettings` +# `SnapshotGcsRepositorySettings` [interface-SnapshotGcsRepositorySettings] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SnapshotGetRepositoryRequest.md b/docs/reference/api/SnapshotGetRepositoryRequest.md index add7bef2a..52fda45aa 100644 --- a/docs/reference/api/SnapshotGetRepositoryRequest.md +++ b/docs/reference/api/SnapshotGetRepositoryRequest.md @@ -1,4 +1,4 @@ -## Interface `SnapshotGetRepositoryRequest` +# `SnapshotGetRepositoryRequest` [interface-SnapshotGetRepositoryRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SnapshotGetRepositoryResponse.md b/docs/reference/api/SnapshotGetRepositoryResponse.md index acb3111bd..a3878c85a 100644 --- a/docs/reference/api/SnapshotGetRepositoryResponse.md +++ b/docs/reference/api/SnapshotGetRepositoryResponse.md @@ -1,4 +1,4 @@ -## `SnapshotGetRepositoryResponse` -::: +# `SnapshotGetRepositoryResponse` [alias-SnapshotGetRepositoryResponse] +```typescript type SnapshotGetRepositoryResponse = Record; -::: +``` diff --git a/docs/reference/api/SnapshotGetRequest.md b/docs/reference/api/SnapshotGetRequest.md index 68e4e1f20..42edb8c23 100644 --- a/docs/reference/api/SnapshotGetRequest.md +++ b/docs/reference/api/SnapshotGetRequest.md @@ -1,4 +1,4 @@ -## Interface `SnapshotGetRequest` +# `SnapshotGetRequest` [interface-SnapshotGetRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SnapshotGetResponse.md b/docs/reference/api/SnapshotGetResponse.md index 32cfb9197..161641a54 100644 --- a/docs/reference/api/SnapshotGetResponse.md +++ b/docs/reference/api/SnapshotGetResponse.md @@ -1,4 +1,4 @@ -## Interface `SnapshotGetResponse` +# `SnapshotGetResponse` [interface-SnapshotGetResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SnapshotGetSnapshotResponseItem.md b/docs/reference/api/SnapshotGetSnapshotResponseItem.md index cc1cb8e7e..4509ee833 100644 --- a/docs/reference/api/SnapshotGetSnapshotResponseItem.md +++ b/docs/reference/api/SnapshotGetSnapshotResponseItem.md @@ -1,4 +1,4 @@ -## Interface `SnapshotGetSnapshotResponseItem` +# `SnapshotGetSnapshotResponseItem` [interface-SnapshotGetSnapshotResponseItem] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SnapshotIndexDetails.md b/docs/reference/api/SnapshotIndexDetails.md index e25548ae2..ee233a0d1 100644 --- a/docs/reference/api/SnapshotIndexDetails.md +++ b/docs/reference/api/SnapshotIndexDetails.md @@ -1,4 +1,4 @@ -## Interface `SnapshotIndexDetails` +# `SnapshotIndexDetails` [interface-SnapshotIndexDetails] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SnapshotInfoFeatureState.md b/docs/reference/api/SnapshotInfoFeatureState.md index 643ad4819..f4f361242 100644 --- a/docs/reference/api/SnapshotInfoFeatureState.md +++ b/docs/reference/api/SnapshotInfoFeatureState.md @@ -1,4 +1,4 @@ -## Interface `SnapshotInfoFeatureState` +# `SnapshotInfoFeatureState` [interface-SnapshotInfoFeatureState] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SnapshotReadOnlyUrlRepository.md b/docs/reference/api/SnapshotReadOnlyUrlRepository.md index 936865ffd..03cf4fda9 100644 --- a/docs/reference/api/SnapshotReadOnlyUrlRepository.md +++ b/docs/reference/api/SnapshotReadOnlyUrlRepository.md @@ -1,4 +1,4 @@ -## Interface `SnapshotReadOnlyUrlRepository` +# `SnapshotReadOnlyUrlRepository` [interface-SnapshotReadOnlyUrlRepository] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SnapshotReadOnlyUrlRepositorySettings.md b/docs/reference/api/SnapshotReadOnlyUrlRepositorySettings.md index 52c46141c..2f3506692 100644 --- a/docs/reference/api/SnapshotReadOnlyUrlRepositorySettings.md +++ b/docs/reference/api/SnapshotReadOnlyUrlRepositorySettings.md @@ -1,4 +1,4 @@ -## Interface `SnapshotReadOnlyUrlRepositorySettings` +# `SnapshotReadOnlyUrlRepositorySettings` [interface-SnapshotReadOnlyUrlRepositorySettings] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SnapshotRepository.md b/docs/reference/api/SnapshotRepository.md index a374505ea..726b939e9 100644 --- a/docs/reference/api/SnapshotRepository.md +++ b/docs/reference/api/SnapshotRepository.md @@ -1,4 +1,4 @@ -## `SnapshotRepository` -::: +# `SnapshotRepository` [alias-SnapshotRepository] +```typescript type SnapshotRepository = [SnapshotAzureRepository](./SnapshotAzureRepository.md) | [SnapshotGcsRepository](./SnapshotGcsRepository.md) | [SnapshotS3Repository](./SnapshotS3Repository.md) | [SnapshotSharedFileSystemRepository](./SnapshotSharedFileSystemRepository.md) | [SnapshotReadOnlyUrlRepository](./SnapshotReadOnlyUrlRepository.md) | [SnapshotSourceOnlyRepository](./SnapshotSourceOnlyRepository.md); -::: +``` diff --git a/docs/reference/api/SnapshotRepositoryAnalyzeBlobDetails.md b/docs/reference/api/SnapshotRepositoryAnalyzeBlobDetails.md index e940d77d3..a38a3347d 100644 --- a/docs/reference/api/SnapshotRepositoryAnalyzeBlobDetails.md +++ b/docs/reference/api/SnapshotRepositoryAnalyzeBlobDetails.md @@ -1,4 +1,4 @@ -## Interface `SnapshotRepositoryAnalyzeBlobDetails` +# `SnapshotRepositoryAnalyzeBlobDetails` [interface-SnapshotRepositoryAnalyzeBlobDetails] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SnapshotRepositoryAnalyzeDetailsInfo.md b/docs/reference/api/SnapshotRepositoryAnalyzeDetailsInfo.md index d7d573937..d4b284374 100644 --- a/docs/reference/api/SnapshotRepositoryAnalyzeDetailsInfo.md +++ b/docs/reference/api/SnapshotRepositoryAnalyzeDetailsInfo.md @@ -1,4 +1,4 @@ -## Interface `SnapshotRepositoryAnalyzeDetailsInfo` +# `SnapshotRepositoryAnalyzeDetailsInfo` [interface-SnapshotRepositoryAnalyzeDetailsInfo] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SnapshotRepositoryAnalyzeReadBlobDetails.md b/docs/reference/api/SnapshotRepositoryAnalyzeReadBlobDetails.md index 965dfa838..348f20a5e 100644 --- a/docs/reference/api/SnapshotRepositoryAnalyzeReadBlobDetails.md +++ b/docs/reference/api/SnapshotRepositoryAnalyzeReadBlobDetails.md @@ -1,4 +1,4 @@ -## Interface `SnapshotRepositoryAnalyzeReadBlobDetails` +# `SnapshotRepositoryAnalyzeReadBlobDetails` [interface-SnapshotRepositoryAnalyzeReadBlobDetails] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SnapshotRepositoryAnalyzeReadSummaryInfo.md b/docs/reference/api/SnapshotRepositoryAnalyzeReadSummaryInfo.md index 1fd4b66d1..715960ccc 100644 --- a/docs/reference/api/SnapshotRepositoryAnalyzeReadSummaryInfo.md +++ b/docs/reference/api/SnapshotRepositoryAnalyzeReadSummaryInfo.md @@ -1,4 +1,4 @@ -## Interface `SnapshotRepositoryAnalyzeReadSummaryInfo` +# `SnapshotRepositoryAnalyzeReadSummaryInfo` [interface-SnapshotRepositoryAnalyzeReadSummaryInfo] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SnapshotRepositoryAnalyzeRequest.md b/docs/reference/api/SnapshotRepositoryAnalyzeRequest.md index cbadfb1f3..2a1ad0a61 100644 --- a/docs/reference/api/SnapshotRepositoryAnalyzeRequest.md +++ b/docs/reference/api/SnapshotRepositoryAnalyzeRequest.md @@ -1,4 +1,4 @@ -## Interface `SnapshotRepositoryAnalyzeRequest` +# `SnapshotRepositoryAnalyzeRequest` [interface-SnapshotRepositoryAnalyzeRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SnapshotRepositoryAnalyzeResponse.md b/docs/reference/api/SnapshotRepositoryAnalyzeResponse.md index 057774315..341e8f262 100644 --- a/docs/reference/api/SnapshotRepositoryAnalyzeResponse.md +++ b/docs/reference/api/SnapshotRepositoryAnalyzeResponse.md @@ -1,4 +1,4 @@ -## Interface `SnapshotRepositoryAnalyzeResponse` +# `SnapshotRepositoryAnalyzeResponse` [interface-SnapshotRepositoryAnalyzeResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SnapshotRepositoryAnalyzeSnapshotNodeInfo.md b/docs/reference/api/SnapshotRepositoryAnalyzeSnapshotNodeInfo.md index c89e7914f..f4464b712 100644 --- a/docs/reference/api/SnapshotRepositoryAnalyzeSnapshotNodeInfo.md +++ b/docs/reference/api/SnapshotRepositoryAnalyzeSnapshotNodeInfo.md @@ -1,4 +1,4 @@ -## Interface `SnapshotRepositoryAnalyzeSnapshotNodeInfo` +# `SnapshotRepositoryAnalyzeSnapshotNodeInfo` [interface-SnapshotRepositoryAnalyzeSnapshotNodeInfo] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SnapshotRepositoryAnalyzeSummaryInfo.md b/docs/reference/api/SnapshotRepositoryAnalyzeSummaryInfo.md index 7363225fa..8623b0cd4 100644 --- a/docs/reference/api/SnapshotRepositoryAnalyzeSummaryInfo.md +++ b/docs/reference/api/SnapshotRepositoryAnalyzeSummaryInfo.md @@ -1,4 +1,4 @@ -## Interface `SnapshotRepositoryAnalyzeSummaryInfo` +# `SnapshotRepositoryAnalyzeSummaryInfo` [interface-SnapshotRepositoryAnalyzeSummaryInfo] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SnapshotRepositoryAnalyzeWriteSummaryInfo.md b/docs/reference/api/SnapshotRepositoryAnalyzeWriteSummaryInfo.md index 2058c6668..9cb761d61 100644 --- a/docs/reference/api/SnapshotRepositoryAnalyzeWriteSummaryInfo.md +++ b/docs/reference/api/SnapshotRepositoryAnalyzeWriteSummaryInfo.md @@ -1,4 +1,4 @@ -## Interface `SnapshotRepositoryAnalyzeWriteSummaryInfo` +# `SnapshotRepositoryAnalyzeWriteSummaryInfo` [interface-SnapshotRepositoryAnalyzeWriteSummaryInfo] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SnapshotRepositoryBase.md b/docs/reference/api/SnapshotRepositoryBase.md index b8333cfd0..21a3a5508 100644 --- a/docs/reference/api/SnapshotRepositoryBase.md +++ b/docs/reference/api/SnapshotRepositoryBase.md @@ -1,4 +1,4 @@ -## Interface `SnapshotRepositoryBase` +# `SnapshotRepositoryBase` [interface-SnapshotRepositoryBase] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SnapshotRepositorySettingsBase.md b/docs/reference/api/SnapshotRepositorySettingsBase.md index 0c8e5920d..d5ecc2ed7 100644 --- a/docs/reference/api/SnapshotRepositorySettingsBase.md +++ b/docs/reference/api/SnapshotRepositorySettingsBase.md @@ -1,4 +1,4 @@ -## Interface `SnapshotRepositorySettingsBase` +# `SnapshotRepositorySettingsBase` [interface-SnapshotRepositorySettingsBase] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SnapshotRepositoryVerifyIntegrityRequest.md b/docs/reference/api/SnapshotRepositoryVerifyIntegrityRequest.md index 7699177b3..0554e3098 100644 --- a/docs/reference/api/SnapshotRepositoryVerifyIntegrityRequest.md +++ b/docs/reference/api/SnapshotRepositoryVerifyIntegrityRequest.md @@ -1,4 +1,4 @@ -## Interface `SnapshotRepositoryVerifyIntegrityRequest` +# `SnapshotRepositoryVerifyIntegrityRequest` [interface-SnapshotRepositoryVerifyIntegrityRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SnapshotRepositoryVerifyIntegrityResponse.md b/docs/reference/api/SnapshotRepositoryVerifyIntegrityResponse.md index 537332527..8c892556f 100644 --- a/docs/reference/api/SnapshotRepositoryVerifyIntegrityResponse.md +++ b/docs/reference/api/SnapshotRepositoryVerifyIntegrityResponse.md @@ -1,4 +1,4 @@ -## `SnapshotRepositoryVerifyIntegrityResponse` -::: +# `SnapshotRepositoryVerifyIntegrityResponse` [alias-SnapshotRepositoryVerifyIntegrityResponse] +```typescript type SnapshotRepositoryVerifyIntegrityResponse = any; -::: +``` diff --git a/docs/reference/api/SnapshotRestoreRequest.md b/docs/reference/api/SnapshotRestoreRequest.md index 3dda082aa..9bbcfff7c 100644 --- a/docs/reference/api/SnapshotRestoreRequest.md +++ b/docs/reference/api/SnapshotRestoreRequest.md @@ -1,4 +1,4 @@ -## Interface `SnapshotRestoreRequest` +# `SnapshotRestoreRequest` [interface-SnapshotRestoreRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SnapshotRestoreResponse.md b/docs/reference/api/SnapshotRestoreResponse.md index 4f17d7cf3..190c4c08c 100644 --- a/docs/reference/api/SnapshotRestoreResponse.md +++ b/docs/reference/api/SnapshotRestoreResponse.md @@ -1,4 +1,4 @@ -## Interface `SnapshotRestoreResponse` +# `SnapshotRestoreResponse` [interface-SnapshotRestoreResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SnapshotRestoreSnapshotRestore.md b/docs/reference/api/SnapshotRestoreSnapshotRestore.md index fc7e95539..9b1c329cb 100644 --- a/docs/reference/api/SnapshotRestoreSnapshotRestore.md +++ b/docs/reference/api/SnapshotRestoreSnapshotRestore.md @@ -1,4 +1,4 @@ -## Interface `SnapshotRestoreSnapshotRestore` +# `SnapshotRestoreSnapshotRestore` [interface-SnapshotRestoreSnapshotRestore] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SnapshotS3Repository.md b/docs/reference/api/SnapshotS3Repository.md index f3e408b0b..3c82bd57a 100644 --- a/docs/reference/api/SnapshotS3Repository.md +++ b/docs/reference/api/SnapshotS3Repository.md @@ -1,4 +1,4 @@ -## Interface `SnapshotS3Repository` +# `SnapshotS3Repository` [interface-SnapshotS3Repository] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SnapshotS3RepositorySettings.md b/docs/reference/api/SnapshotS3RepositorySettings.md index 1380494d9..1fa72445a 100644 --- a/docs/reference/api/SnapshotS3RepositorySettings.md +++ b/docs/reference/api/SnapshotS3RepositorySettings.md @@ -1,4 +1,4 @@ -## Interface `SnapshotS3RepositorySettings` +# `SnapshotS3RepositorySettings` [interface-SnapshotS3RepositorySettings] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SnapshotShardsStats.md b/docs/reference/api/SnapshotShardsStats.md index b584cbaf5..c1b42b073 100644 --- a/docs/reference/api/SnapshotShardsStats.md +++ b/docs/reference/api/SnapshotShardsStats.md @@ -1,4 +1,4 @@ -## Interface `SnapshotShardsStats` +# `SnapshotShardsStats` [interface-SnapshotShardsStats] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SnapshotShardsStatsStage.md b/docs/reference/api/SnapshotShardsStatsStage.md index 6b55288a0..98c6200f1 100644 --- a/docs/reference/api/SnapshotShardsStatsStage.md +++ b/docs/reference/api/SnapshotShardsStatsStage.md @@ -1,4 +1,4 @@ -## `SnapshotShardsStatsStage` -::: +# `SnapshotShardsStatsStage` [alias-SnapshotShardsStatsStage] +```typescript type SnapshotShardsStatsStage = 'DONE' | 'FAILURE' | 'FINALIZE' | 'INIT' | 'STARTED'; -::: +``` diff --git a/docs/reference/api/SnapshotShardsStatsSummary.md b/docs/reference/api/SnapshotShardsStatsSummary.md index c9273ebd7..fa1790940 100644 --- a/docs/reference/api/SnapshotShardsStatsSummary.md +++ b/docs/reference/api/SnapshotShardsStatsSummary.md @@ -1,4 +1,4 @@ -## Interface `SnapshotShardsStatsSummary` +# `SnapshotShardsStatsSummary` [interface-SnapshotShardsStatsSummary] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SnapshotShardsStatsSummaryItem.md b/docs/reference/api/SnapshotShardsStatsSummaryItem.md index 71d2aec76..034ba9d7b 100644 --- a/docs/reference/api/SnapshotShardsStatsSummaryItem.md +++ b/docs/reference/api/SnapshotShardsStatsSummaryItem.md @@ -1,4 +1,4 @@ -## Interface `SnapshotShardsStatsSummaryItem` +# `SnapshotShardsStatsSummaryItem` [interface-SnapshotShardsStatsSummaryItem] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SnapshotSharedFileSystemRepository.md b/docs/reference/api/SnapshotSharedFileSystemRepository.md index 0c3a03da1..6c9cebcc7 100644 --- a/docs/reference/api/SnapshotSharedFileSystemRepository.md +++ b/docs/reference/api/SnapshotSharedFileSystemRepository.md @@ -1,4 +1,4 @@ -## Interface `SnapshotSharedFileSystemRepository` +# `SnapshotSharedFileSystemRepository` [interface-SnapshotSharedFileSystemRepository] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SnapshotSharedFileSystemRepositorySettings.md b/docs/reference/api/SnapshotSharedFileSystemRepositorySettings.md index 321a1e3dd..d7f5fa82b 100644 --- a/docs/reference/api/SnapshotSharedFileSystemRepositorySettings.md +++ b/docs/reference/api/SnapshotSharedFileSystemRepositorySettings.md @@ -1,4 +1,4 @@ -## Interface `SnapshotSharedFileSystemRepositorySettings` +# `SnapshotSharedFileSystemRepositorySettings` [interface-SnapshotSharedFileSystemRepositorySettings] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SnapshotSnapshotIndexStats.md b/docs/reference/api/SnapshotSnapshotIndexStats.md index 1f27d434a..063f879e7 100644 --- a/docs/reference/api/SnapshotSnapshotIndexStats.md +++ b/docs/reference/api/SnapshotSnapshotIndexStats.md @@ -1,4 +1,4 @@ -## Interface `SnapshotSnapshotIndexStats` +# `SnapshotSnapshotIndexStats` [interface-SnapshotSnapshotIndexStats] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SnapshotSnapshotInfo.md b/docs/reference/api/SnapshotSnapshotInfo.md index b4776b98e..19dbef75c 100644 --- a/docs/reference/api/SnapshotSnapshotInfo.md +++ b/docs/reference/api/SnapshotSnapshotInfo.md @@ -1,4 +1,4 @@ -## Interface `SnapshotSnapshotInfo` +# `SnapshotSnapshotInfo` [interface-SnapshotSnapshotInfo] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SnapshotSnapshotShardFailure.md b/docs/reference/api/SnapshotSnapshotShardFailure.md index d0ffbb8be..39d6c40b3 100644 --- a/docs/reference/api/SnapshotSnapshotShardFailure.md +++ b/docs/reference/api/SnapshotSnapshotShardFailure.md @@ -1,4 +1,4 @@ -## Interface `SnapshotSnapshotShardFailure` +# `SnapshotSnapshotShardFailure` [interface-SnapshotSnapshotShardFailure] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SnapshotSnapshotShardsStatus.md b/docs/reference/api/SnapshotSnapshotShardsStatus.md index 27ac1ca47..3b5e4e07c 100644 --- a/docs/reference/api/SnapshotSnapshotShardsStatus.md +++ b/docs/reference/api/SnapshotSnapshotShardsStatus.md @@ -1,4 +1,4 @@ -## Interface `SnapshotSnapshotShardsStatus` +# `SnapshotSnapshotShardsStatus` [interface-SnapshotSnapshotShardsStatus] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SnapshotSnapshotSort.md b/docs/reference/api/SnapshotSnapshotSort.md index 4f8704b36..0a9b9f19a 100644 --- a/docs/reference/api/SnapshotSnapshotSort.md +++ b/docs/reference/api/SnapshotSnapshotSort.md @@ -1,4 +1,4 @@ -## `SnapshotSnapshotSort` -::: +# `SnapshotSnapshotSort` [alias-SnapshotSnapshotSort] +```typescript type SnapshotSnapshotSort = 'start_time' | 'duration' | 'name' | 'index_count' | 'repository' | 'shard_count' | 'failed_shard_count'; -::: +``` diff --git a/docs/reference/api/SnapshotSnapshotStats.md b/docs/reference/api/SnapshotSnapshotStats.md index 91f874c1d..202db29a0 100644 --- a/docs/reference/api/SnapshotSnapshotStats.md +++ b/docs/reference/api/SnapshotSnapshotStats.md @@ -1,4 +1,4 @@ -## Interface `SnapshotSnapshotStats` +# `SnapshotSnapshotStats` [interface-SnapshotSnapshotStats] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SnapshotSourceOnlyRepository.md b/docs/reference/api/SnapshotSourceOnlyRepository.md index ec78b2ce7..b8c662a20 100644 --- a/docs/reference/api/SnapshotSourceOnlyRepository.md +++ b/docs/reference/api/SnapshotSourceOnlyRepository.md @@ -1,4 +1,4 @@ -## Interface `SnapshotSourceOnlyRepository` +# `SnapshotSourceOnlyRepository` [interface-SnapshotSourceOnlyRepository] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SnapshotSourceOnlyRepositorySettings.md b/docs/reference/api/SnapshotSourceOnlyRepositorySettings.md index 06fbbfaa7..037e5cf0f 100644 --- a/docs/reference/api/SnapshotSourceOnlyRepositorySettings.md +++ b/docs/reference/api/SnapshotSourceOnlyRepositorySettings.md @@ -1,4 +1,4 @@ -## Interface `SnapshotSourceOnlyRepositorySettings` +# `SnapshotSourceOnlyRepositorySettings` [interface-SnapshotSourceOnlyRepositorySettings] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SnapshotStatus.md b/docs/reference/api/SnapshotStatus.md index 11cbcc9b0..89e31f22d 100644 --- a/docs/reference/api/SnapshotStatus.md +++ b/docs/reference/api/SnapshotStatus.md @@ -1,4 +1,4 @@ -## Interface `SnapshotStatus` +# `SnapshotStatus` [interface-SnapshotStatus] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SnapshotStatusRequest.md b/docs/reference/api/SnapshotStatusRequest.md index f00e6a9db..bab7b76c4 100644 --- a/docs/reference/api/SnapshotStatusRequest.md +++ b/docs/reference/api/SnapshotStatusRequest.md @@ -1,4 +1,4 @@ -## Interface `SnapshotStatusRequest` +# `SnapshotStatusRequest` [interface-SnapshotStatusRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SnapshotStatusResponse.md b/docs/reference/api/SnapshotStatusResponse.md index 9de3a780b..06c5ae5f4 100644 --- a/docs/reference/api/SnapshotStatusResponse.md +++ b/docs/reference/api/SnapshotStatusResponse.md @@ -1,4 +1,4 @@ -## Interface `SnapshotStatusResponse` +# `SnapshotStatusResponse` [interface-SnapshotStatusResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SnapshotVerifyRepositoryCompactNodeInfo.md b/docs/reference/api/SnapshotVerifyRepositoryCompactNodeInfo.md index 3c6cf73ce..9c8a22ace 100644 --- a/docs/reference/api/SnapshotVerifyRepositoryCompactNodeInfo.md +++ b/docs/reference/api/SnapshotVerifyRepositoryCompactNodeInfo.md @@ -1,4 +1,4 @@ -## Interface `SnapshotVerifyRepositoryCompactNodeInfo` +# `SnapshotVerifyRepositoryCompactNodeInfo` [interface-SnapshotVerifyRepositoryCompactNodeInfo] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SnapshotVerifyRepositoryRequest.md b/docs/reference/api/SnapshotVerifyRepositoryRequest.md index bad81c770..82f4c1a24 100644 --- a/docs/reference/api/SnapshotVerifyRepositoryRequest.md +++ b/docs/reference/api/SnapshotVerifyRepositoryRequest.md @@ -1,4 +1,4 @@ -## Interface `SnapshotVerifyRepositoryRequest` +# `SnapshotVerifyRepositoryRequest` [interface-SnapshotVerifyRepositoryRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SnapshotVerifyRepositoryResponse.md b/docs/reference/api/SnapshotVerifyRepositoryResponse.md index 36709b382..fcb881527 100644 --- a/docs/reference/api/SnapshotVerifyRepositoryResponse.md +++ b/docs/reference/api/SnapshotVerifyRepositoryResponse.md @@ -1,4 +1,4 @@ -## Interface `SnapshotVerifyRepositoryResponse` +# `SnapshotVerifyRepositoryResponse` [interface-SnapshotVerifyRepositoryResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SniffingTransport.md b/docs/reference/api/SniffingTransport.md index a96d2b431..c56c0a0c7 100644 --- a/docs/reference/api/SniffingTransport.md +++ b/docs/reference/api/SniffingTransport.md @@ -1,9 +1,9 @@ -## `SniffingTransport` +# `SniffingTransport` [class-SniffingTransport] -### Constructor +## Constructor -### Methods +## Methods [class-methods-SniffingTransport] | Name | Signature | Description | | - | - | - | diff --git a/docs/reference/api/Sort.md b/docs/reference/api/Sort.md index 6f83b9b93..5d91eef98 100644 --- a/docs/reference/api/Sort.md +++ b/docs/reference/api/Sort.md @@ -1,4 +1,4 @@ -## `Sort` -::: +# `Sort` [alias-Sort] +```typescript type Sort = [SortCombinations](./SortCombinations.md) | [SortCombinations](./SortCombinations.md)[]; -::: +``` diff --git a/docs/reference/api/SortCombinations.md b/docs/reference/api/SortCombinations.md index 262319cb8..25edc85d8 100644 --- a/docs/reference/api/SortCombinations.md +++ b/docs/reference/api/SortCombinations.md @@ -1,4 +1,4 @@ -## `SortCombinations` -::: +# `SortCombinations` [alias-SortCombinations] +```typescript type SortCombinations = [Field](./Field.md) | [SortOptions](./SortOptions.md); -::: +``` diff --git a/docs/reference/api/SortMode.md b/docs/reference/api/SortMode.md index f7d8b1c4c..71d80bd1e 100644 --- a/docs/reference/api/SortMode.md +++ b/docs/reference/api/SortMode.md @@ -1,4 +1,4 @@ -## `SortMode` -::: +# `SortMode` [alias-SortMode] +```typescript type SortMode = 'min' | 'max' | 'sum' | 'avg' | 'median'; -::: +``` diff --git a/docs/reference/api/SortOptions.md b/docs/reference/api/SortOptions.md index 42c9f76fe..7bbb27c7d 100644 --- a/docs/reference/api/SortOptions.md +++ b/docs/reference/api/SortOptions.md @@ -1,4 +1,4 @@ -## `SortOptions` -::: +# `SortOptions` [alias-SortOptions] +```typescript type SortOptions = [SortOptionsKeys](./SortOptionsKeys.md) & { [property: string]: [FieldSort](./FieldSort.md) | [SortOrder](./SortOrder.md) | [ScoreSort](./ScoreSort.md) | [GeoDistanceSort](./GeoDistanceSort.md) | [ScriptSort](./ScriptSort.md);}; -::: +``` diff --git a/docs/reference/api/SortOptionsKeys.md b/docs/reference/api/SortOptionsKeys.md index 44355d4e7..ef940cdf5 100644 --- a/docs/reference/api/SortOptionsKeys.md +++ b/docs/reference/api/SortOptionsKeys.md @@ -1,4 +1,4 @@ -## Interface `SortOptionsKeys` +# `SortOptionsKeys` [interface-SortOptionsKeys] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SortOrder.md b/docs/reference/api/SortOrder.md index 0ecea72b5..37502091a 100644 --- a/docs/reference/api/SortOrder.md +++ b/docs/reference/api/SortOrder.md @@ -1,4 +1,4 @@ -## `SortOrder` -::: +# `SortOrder` [alias-SortOrder] +```typescript type SortOrder = 'asc' | 'desc'; -::: +``` diff --git a/docs/reference/api/SortResults.md b/docs/reference/api/SortResults.md index 67ecd1715..394ab371a 100644 --- a/docs/reference/api/SortResults.md +++ b/docs/reference/api/SortResults.md @@ -1,4 +1,4 @@ -## `SortResults` -::: +# `SortResults` [alias-SortResults] +```typescript type SortResults = [FieldValue](./FieldValue.md)[]; -::: +``` diff --git a/docs/reference/api/SpecUtilsAdditionalProperties.md b/docs/reference/api/SpecUtilsAdditionalProperties.md index 8ce8c023e..2435bec3b 100644 --- a/docs/reference/api/SpecUtilsAdditionalProperties.md +++ b/docs/reference/api/SpecUtilsAdditionalProperties.md @@ -1,4 +1,4 @@ -## Interface `SpecUtilsAdditionalProperties` +# `SpecUtilsAdditionalProperties` [interface-SpecUtilsAdditionalProperties] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SpecUtilsAdditionalProperty.md b/docs/reference/api/SpecUtilsAdditionalProperty.md index 127f0de0a..45aedc2b8 100644 --- a/docs/reference/api/SpecUtilsAdditionalProperty.md +++ b/docs/reference/api/SpecUtilsAdditionalProperty.md @@ -1,4 +1,4 @@ -## Interface `SpecUtilsAdditionalProperty` +# `SpecUtilsAdditionalProperty` [interface-SpecUtilsAdditionalProperty] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SpecUtilsBaseNode.md b/docs/reference/api/SpecUtilsBaseNode.md index 875e950a0..d1bf0c5d5 100644 --- a/docs/reference/api/SpecUtilsBaseNode.md +++ b/docs/reference/api/SpecUtilsBaseNode.md @@ -1,4 +1,4 @@ -## Interface `SpecUtilsBaseNode` +# `SpecUtilsBaseNode` [interface-SpecUtilsBaseNode] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SpecUtilsCommonCatQueryParameters.md b/docs/reference/api/SpecUtilsCommonCatQueryParameters.md index a1ff52d4b..cda073216 100644 --- a/docs/reference/api/SpecUtilsCommonCatQueryParameters.md +++ b/docs/reference/api/SpecUtilsCommonCatQueryParameters.md @@ -1,4 +1,4 @@ -## Interface `SpecUtilsCommonCatQueryParameters` +# `SpecUtilsCommonCatQueryParameters` [interface-SpecUtilsCommonCatQueryParameters] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SpecUtilsCommonQueryParameters.md b/docs/reference/api/SpecUtilsCommonQueryParameters.md index 4675fca86..de6ca3c06 100644 --- a/docs/reference/api/SpecUtilsCommonQueryParameters.md +++ b/docs/reference/api/SpecUtilsCommonQueryParameters.md @@ -1,4 +1,4 @@ -## Interface `SpecUtilsCommonQueryParameters` +# `SpecUtilsCommonQueryParameters` [interface-SpecUtilsCommonQueryParameters] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SpecUtilsNullValue.md b/docs/reference/api/SpecUtilsNullValue.md index 29ac73708..fa036d958 100644 --- a/docs/reference/api/SpecUtilsNullValue.md +++ b/docs/reference/api/SpecUtilsNullValue.md @@ -1,4 +1,4 @@ -## `SpecUtilsNullValue` -::: +# `SpecUtilsNullValue` [alias-SpecUtilsNullValue] +```typescript type SpecUtilsNullValue = null; -::: +``` diff --git a/docs/reference/api/SpecUtilsOverloadOf.md b/docs/reference/api/SpecUtilsOverloadOf.md index 6898cfb25..fbd696548 100644 --- a/docs/reference/api/SpecUtilsOverloadOf.md +++ b/docs/reference/api/SpecUtilsOverloadOf.md @@ -1,4 +1,4 @@ -## Interface `SpecUtilsOverloadOf` +# `SpecUtilsOverloadOf` [interface-SpecUtilsOverloadOf] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SpecUtilsPipeSeparatedFlags.md b/docs/reference/api/SpecUtilsPipeSeparatedFlags.md index 0874e8188..bf7f1a6bf 100644 --- a/docs/reference/api/SpecUtilsPipeSeparatedFlags.md +++ b/docs/reference/api/SpecUtilsPipeSeparatedFlags.md @@ -1,4 +1,4 @@ -## `SpecUtilsPipeSeparatedFlags` -::: +# `SpecUtilsPipeSeparatedFlags` [alias-SpecUtilsPipeSeparatedFlags] +```typescript type SpecUtilsPipeSeparatedFlags = T | string; -::: +``` diff --git a/docs/reference/api/SpecUtilsStringified.md b/docs/reference/api/SpecUtilsStringified.md index 694904112..64dd9bf5a 100644 --- a/docs/reference/api/SpecUtilsStringified.md +++ b/docs/reference/api/SpecUtilsStringified.md @@ -1,4 +1,4 @@ -## `SpecUtilsStringified` -::: +# `SpecUtilsStringified` [alias-SpecUtilsStringified] +```typescript type SpecUtilsStringified = T | string; -::: +``` diff --git a/docs/reference/api/SpecUtilsWithNullValue.md b/docs/reference/api/SpecUtilsWithNullValue.md index 9a2267e14..78ea31f17 100644 --- a/docs/reference/api/SpecUtilsWithNullValue.md +++ b/docs/reference/api/SpecUtilsWithNullValue.md @@ -1,4 +1,4 @@ -## `SpecUtilsWithNullValue` -::: +# `SpecUtilsWithNullValue` [alias-SpecUtilsWithNullValue] +```typescript type SpecUtilsWithNullValue = T | [SpecUtilsNullValue](./SpecUtilsNullValue.md); -::: +``` diff --git a/docs/reference/api/Sql.md b/docs/reference/api/Sql.md index 56885fbf8..fab7e2468 100644 --- a/docs/reference/api/Sql.md +++ b/docs/reference/api/Sql.md @@ -1,19 +1,19 @@ -## `Sql` +# `Sql` [class-Sql] -### Constructor +## Constructor -::: +```typescript new Sql(transport: [Transport](./Transport.md)); -::: +``` -### Properties +## Properties [class-properties-Sql] | Name | Type | Description | | - | - | - | | `acceptedParams` | Record |   | | `transport` | [Transport](./Transport.md) |   | -### Methods +## Methods [class-methods-Sql] | Name | Signature | Description | | - | - | - | diff --git a/docs/reference/api/SqlClearCursorRequest.md b/docs/reference/api/SqlClearCursorRequest.md index 71cc79ac6..751abd8e7 100644 --- a/docs/reference/api/SqlClearCursorRequest.md +++ b/docs/reference/api/SqlClearCursorRequest.md @@ -1,4 +1,4 @@ -## Interface `SqlClearCursorRequest` +# `SqlClearCursorRequest` [interface-SqlClearCursorRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SqlClearCursorResponse.md b/docs/reference/api/SqlClearCursorResponse.md index 4d8e9d682..cc5f7dc0f 100644 --- a/docs/reference/api/SqlClearCursorResponse.md +++ b/docs/reference/api/SqlClearCursorResponse.md @@ -1,4 +1,4 @@ -## Interface `SqlClearCursorResponse` +# `SqlClearCursorResponse` [interface-SqlClearCursorResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SqlColumn.md b/docs/reference/api/SqlColumn.md index cb85b6ba5..960529401 100644 --- a/docs/reference/api/SqlColumn.md +++ b/docs/reference/api/SqlColumn.md @@ -1,4 +1,4 @@ -## Interface `SqlColumn` +# `SqlColumn` [interface-SqlColumn] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SqlDeleteAsyncRequest.md b/docs/reference/api/SqlDeleteAsyncRequest.md index 70361ce89..dc2d5882d 100644 --- a/docs/reference/api/SqlDeleteAsyncRequest.md +++ b/docs/reference/api/SqlDeleteAsyncRequest.md @@ -1,4 +1,4 @@ -## Interface `SqlDeleteAsyncRequest` +# `SqlDeleteAsyncRequest` [interface-SqlDeleteAsyncRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SqlDeleteAsyncResponse.md b/docs/reference/api/SqlDeleteAsyncResponse.md index c584c510f..f6273c61a 100644 --- a/docs/reference/api/SqlDeleteAsyncResponse.md +++ b/docs/reference/api/SqlDeleteAsyncResponse.md @@ -1,4 +1,4 @@ -## `SqlDeleteAsyncResponse` -::: +# `SqlDeleteAsyncResponse` [alias-SqlDeleteAsyncResponse] +```typescript type SqlDeleteAsyncResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); -::: +``` diff --git a/docs/reference/api/SqlGetAsyncRequest.md b/docs/reference/api/SqlGetAsyncRequest.md index ba2920a7a..a07647bdb 100644 --- a/docs/reference/api/SqlGetAsyncRequest.md +++ b/docs/reference/api/SqlGetAsyncRequest.md @@ -1,4 +1,4 @@ -## Interface `SqlGetAsyncRequest` +# `SqlGetAsyncRequest` [interface-SqlGetAsyncRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SqlGetAsyncResponse.md b/docs/reference/api/SqlGetAsyncResponse.md index 3bb3d9dd8..69e89a8fd 100644 --- a/docs/reference/api/SqlGetAsyncResponse.md +++ b/docs/reference/api/SqlGetAsyncResponse.md @@ -1,4 +1,4 @@ -## Interface `SqlGetAsyncResponse` +# `SqlGetAsyncResponse` [interface-SqlGetAsyncResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SqlGetAsyncStatusRequest.md b/docs/reference/api/SqlGetAsyncStatusRequest.md index 4b88b1455..4ba8372ba 100644 --- a/docs/reference/api/SqlGetAsyncStatusRequest.md +++ b/docs/reference/api/SqlGetAsyncStatusRequest.md @@ -1,4 +1,4 @@ -## Interface `SqlGetAsyncStatusRequest` +# `SqlGetAsyncStatusRequest` [interface-SqlGetAsyncStatusRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SqlGetAsyncStatusResponse.md b/docs/reference/api/SqlGetAsyncStatusResponse.md index 8e9874a9d..0b1bcfd2a 100644 --- a/docs/reference/api/SqlGetAsyncStatusResponse.md +++ b/docs/reference/api/SqlGetAsyncStatusResponse.md @@ -1,4 +1,4 @@ -## Interface `SqlGetAsyncStatusResponse` +# `SqlGetAsyncStatusResponse` [interface-SqlGetAsyncStatusResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SqlQueryRequest.md b/docs/reference/api/SqlQueryRequest.md index b2a1e0c1d..4cacb0656 100644 --- a/docs/reference/api/SqlQueryRequest.md +++ b/docs/reference/api/SqlQueryRequest.md @@ -1,4 +1,4 @@ -## Interface `SqlQueryRequest` +# `SqlQueryRequest` [interface-SqlQueryRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SqlQueryResponse.md b/docs/reference/api/SqlQueryResponse.md index 50c010248..e81b50fce 100644 --- a/docs/reference/api/SqlQueryResponse.md +++ b/docs/reference/api/SqlQueryResponse.md @@ -1,4 +1,4 @@ -## Interface `SqlQueryResponse` +# `SqlQueryResponse` [interface-SqlQueryResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SqlQuerySqlFormat.md b/docs/reference/api/SqlQuerySqlFormat.md index 27669de73..fa38edf90 100644 --- a/docs/reference/api/SqlQuerySqlFormat.md +++ b/docs/reference/api/SqlQuerySqlFormat.md @@ -1,4 +1,4 @@ -## `SqlQuerySqlFormat` -::: +# `SqlQuerySqlFormat` [alias-SqlQuerySqlFormat] +```typescript type SqlQuerySqlFormat = 'csv' | 'json' | 'tsv' | 'txt' | 'yaml' | 'cbor' | 'smile'; -::: +``` diff --git a/docs/reference/api/SqlRow.md b/docs/reference/api/SqlRow.md index 78bab4eec..7cc573cf7 100644 --- a/docs/reference/api/SqlRow.md +++ b/docs/reference/api/SqlRow.md @@ -1,4 +1,4 @@ -## `SqlRow` -::: +# `SqlRow` [alias-SqlRow] +```typescript type SqlRow = any[]; -::: +``` diff --git a/docs/reference/api/SqlTranslateRequest.md b/docs/reference/api/SqlTranslateRequest.md index d8f98548a..d0ae782f3 100644 --- a/docs/reference/api/SqlTranslateRequest.md +++ b/docs/reference/api/SqlTranslateRequest.md @@ -1,4 +1,4 @@ -## Interface `SqlTranslateRequest` +# `SqlTranslateRequest` [interface-SqlTranslateRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SqlTranslateResponse.md b/docs/reference/api/SqlTranslateResponse.md index 5c6dbbbeb..f11c1cc57 100644 --- a/docs/reference/api/SqlTranslateResponse.md +++ b/docs/reference/api/SqlTranslateResponse.md @@ -1,4 +1,4 @@ -## Interface `SqlTranslateResponse` +# `SqlTranslateResponse` [interface-SqlTranslateResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/Ssl.md b/docs/reference/api/Ssl.md index 2931448ae..9d95b355c 100644 --- a/docs/reference/api/Ssl.md +++ b/docs/reference/api/Ssl.md @@ -1,19 +1,19 @@ -## `Ssl` +# `Ssl` [class-Ssl] -### Constructor +## Constructor -::: +```typescript new Ssl(transport: [Transport](./Transport.md)); -::: +``` -### Properties +## Properties [class-properties-Ssl] | Name | Type | Description | | - | - | - | | `acceptedParams` | Record |   | | `transport` | [Transport](./Transport.md) |   | -### Methods +## Methods [class-methods-Ssl] | Name | Signature | Description | | - | - | - | diff --git a/docs/reference/api/SslCertificatesCertificateInformation.md b/docs/reference/api/SslCertificatesCertificateInformation.md index 950ca767a..8fecb7122 100644 --- a/docs/reference/api/SslCertificatesCertificateInformation.md +++ b/docs/reference/api/SslCertificatesCertificateInformation.md @@ -1,4 +1,4 @@ -## Interface `SslCertificatesCertificateInformation` +# `SslCertificatesCertificateInformation` [interface-SslCertificatesCertificateInformation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SslCertificatesRequest.md b/docs/reference/api/SslCertificatesRequest.md index f889c284c..63b18537e 100644 --- a/docs/reference/api/SslCertificatesRequest.md +++ b/docs/reference/api/SslCertificatesRequest.md @@ -1,4 +1,4 @@ -## Interface `SslCertificatesRequest` +# `SslCertificatesRequest` [interface-SslCertificatesRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SslCertificatesResponse.md b/docs/reference/api/SslCertificatesResponse.md index 5be715487..5be5d1a06 100644 --- a/docs/reference/api/SslCertificatesResponse.md +++ b/docs/reference/api/SslCertificatesResponse.md @@ -1,4 +1,4 @@ -## `SslCertificatesResponse` -::: +# `SslCertificatesResponse` [alias-SslCertificatesResponse] +```typescript type SslCertificatesResponse = [SslCertificatesCertificateInformation](./SslCertificatesCertificateInformation.md)[]; -::: +``` diff --git a/docs/reference/api/StandardRetriever.md b/docs/reference/api/StandardRetriever.md index 9103d2306..4d8cfecf1 100644 --- a/docs/reference/api/StandardRetriever.md +++ b/docs/reference/api/StandardRetriever.md @@ -1,4 +1,4 @@ -## Interface `StandardRetriever` +# `StandardRetriever` [interface-StandardRetriever] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/StoreStats.md b/docs/reference/api/StoreStats.md index e1b7d6d80..9b0f6923a 100644 --- a/docs/reference/api/StoreStats.md +++ b/docs/reference/api/StoreStats.md @@ -1,4 +1,4 @@ -## Interface `StoreStats` +# `StoreStats` [interface-StoreStats] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/StoredScript.md b/docs/reference/api/StoredScript.md index d8e747eea..e81a4fe90 100644 --- a/docs/reference/api/StoredScript.md +++ b/docs/reference/api/StoredScript.md @@ -1,4 +1,4 @@ -## Interface `StoredScript` +# `StoredScript` [interface-StoredScript] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/StreamResult.md b/docs/reference/api/StreamResult.md index bd6ac9fc5..57d4ed2ce 100644 --- a/docs/reference/api/StreamResult.md +++ b/docs/reference/api/StreamResult.md @@ -1,4 +1,4 @@ -## `StreamResult` -::: +# `StreamResult` [alias-StreamResult] +```typescript type StreamResult = [ArrayBuffer](./ArrayBuffer.md); -::: +``` diff --git a/docs/reference/api/SuggestMode.md b/docs/reference/api/SuggestMode.md index 25ef9577c..fe659ba18 100644 --- a/docs/reference/api/SuggestMode.md +++ b/docs/reference/api/SuggestMode.md @@ -1,4 +1,4 @@ -## `SuggestMode` -::: +# `SuggestMode` [alias-SuggestMode] +```typescript type SuggestMode = 'missing' | 'popular' | 'always'; -::: +``` diff --git a/docs/reference/api/SuggestionName.md b/docs/reference/api/SuggestionName.md index ffeacdd31..6e7c682d1 100644 --- a/docs/reference/api/SuggestionName.md +++ b/docs/reference/api/SuggestionName.md @@ -1,4 +1,4 @@ -## `SuggestionName` -::: +# `SuggestionName` [alias-SuggestionName] +```typescript type SuggestionName = string; -::: +``` diff --git a/docs/reference/api/Synonyms.md b/docs/reference/api/Synonyms.md index 7e31d60e4..57c67126b 100644 --- a/docs/reference/api/Synonyms.md +++ b/docs/reference/api/Synonyms.md @@ -1,19 +1,19 @@ -## `Synonyms` +# `Synonyms` [class-Synonyms] -### Constructor +## Constructor -::: +```typescript new Synonyms(transport: [Transport](./Transport.md)); -::: +``` -### Properties +## Properties [class-properties-Synonyms] | Name | Type | Description | | - | - | - | | `acceptedParams` | Record |   | | `transport` | [Transport](./Transport.md) |   | -### Methods +## Methods [class-methods-Synonyms] | Name | Signature | Description | | - | - | - | diff --git a/docs/reference/api/SynonymsDeleteSynonymRequest.md b/docs/reference/api/SynonymsDeleteSynonymRequest.md index c75da8338..32ee4842d 100644 --- a/docs/reference/api/SynonymsDeleteSynonymRequest.md +++ b/docs/reference/api/SynonymsDeleteSynonymRequest.md @@ -1,4 +1,4 @@ -## Interface `SynonymsDeleteSynonymRequest` +# `SynonymsDeleteSynonymRequest` [interface-SynonymsDeleteSynonymRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SynonymsDeleteSynonymResponse.md b/docs/reference/api/SynonymsDeleteSynonymResponse.md index ca51be4cd..441c83b59 100644 --- a/docs/reference/api/SynonymsDeleteSynonymResponse.md +++ b/docs/reference/api/SynonymsDeleteSynonymResponse.md @@ -1,4 +1,4 @@ -## `SynonymsDeleteSynonymResponse` -::: +# `SynonymsDeleteSynonymResponse` [alias-SynonymsDeleteSynonymResponse] +```typescript type SynonymsDeleteSynonymResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); -::: +``` diff --git a/docs/reference/api/SynonymsDeleteSynonymRuleRequest.md b/docs/reference/api/SynonymsDeleteSynonymRuleRequest.md index 7f96044c6..a2e6f3cb7 100644 --- a/docs/reference/api/SynonymsDeleteSynonymRuleRequest.md +++ b/docs/reference/api/SynonymsDeleteSynonymRuleRequest.md @@ -1,4 +1,4 @@ -## Interface `SynonymsDeleteSynonymRuleRequest` +# `SynonymsDeleteSynonymRuleRequest` [interface-SynonymsDeleteSynonymRuleRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SynonymsDeleteSynonymRuleResponse.md b/docs/reference/api/SynonymsDeleteSynonymRuleResponse.md index 581791697..cb55449bc 100644 --- a/docs/reference/api/SynonymsDeleteSynonymRuleResponse.md +++ b/docs/reference/api/SynonymsDeleteSynonymRuleResponse.md @@ -1,4 +1,4 @@ -## `SynonymsDeleteSynonymRuleResponse` -::: +# `SynonymsDeleteSynonymRuleResponse` [alias-SynonymsDeleteSynonymRuleResponse] +```typescript type SynonymsDeleteSynonymRuleResponse = [SynonymsSynonymsUpdateResult](./SynonymsSynonymsUpdateResult.md); -::: +``` diff --git a/docs/reference/api/SynonymsGetSynonymRequest.md b/docs/reference/api/SynonymsGetSynonymRequest.md index 0fc29f1e1..29e17ce01 100644 --- a/docs/reference/api/SynonymsGetSynonymRequest.md +++ b/docs/reference/api/SynonymsGetSynonymRequest.md @@ -1,4 +1,4 @@ -## Interface `SynonymsGetSynonymRequest` +# `SynonymsGetSynonymRequest` [interface-SynonymsGetSynonymRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SynonymsGetSynonymResponse.md b/docs/reference/api/SynonymsGetSynonymResponse.md index 8f3601bf7..abf439839 100644 --- a/docs/reference/api/SynonymsGetSynonymResponse.md +++ b/docs/reference/api/SynonymsGetSynonymResponse.md @@ -1,4 +1,4 @@ -## Interface `SynonymsGetSynonymResponse` +# `SynonymsGetSynonymResponse` [interface-SynonymsGetSynonymResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SynonymsGetSynonymRuleRequest.md b/docs/reference/api/SynonymsGetSynonymRuleRequest.md index 955e2db53..5e0d4dec5 100644 --- a/docs/reference/api/SynonymsGetSynonymRuleRequest.md +++ b/docs/reference/api/SynonymsGetSynonymRuleRequest.md @@ -1,4 +1,4 @@ -## Interface `SynonymsGetSynonymRuleRequest` +# `SynonymsGetSynonymRuleRequest` [interface-SynonymsGetSynonymRuleRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SynonymsGetSynonymRuleResponse.md b/docs/reference/api/SynonymsGetSynonymRuleResponse.md index fe5e71b99..8b22e35c2 100644 --- a/docs/reference/api/SynonymsGetSynonymRuleResponse.md +++ b/docs/reference/api/SynonymsGetSynonymRuleResponse.md @@ -1,4 +1,4 @@ -## `SynonymsGetSynonymRuleResponse` -::: +# `SynonymsGetSynonymRuleResponse` [alias-SynonymsGetSynonymRuleResponse] +```typescript type SynonymsGetSynonymRuleResponse = [SynonymsSynonymRuleRead](./SynonymsSynonymRuleRead.md); -::: +``` diff --git a/docs/reference/api/SynonymsGetSynonymsSetsRequest.md b/docs/reference/api/SynonymsGetSynonymsSetsRequest.md index 75a9f185a..714b9a205 100644 --- a/docs/reference/api/SynonymsGetSynonymsSetsRequest.md +++ b/docs/reference/api/SynonymsGetSynonymsSetsRequest.md @@ -1,4 +1,4 @@ -## Interface `SynonymsGetSynonymsSetsRequest` +# `SynonymsGetSynonymsSetsRequest` [interface-SynonymsGetSynonymsSetsRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SynonymsGetSynonymsSetsResponse.md b/docs/reference/api/SynonymsGetSynonymsSetsResponse.md index a9497efe4..305e8692e 100644 --- a/docs/reference/api/SynonymsGetSynonymsSetsResponse.md +++ b/docs/reference/api/SynonymsGetSynonymsSetsResponse.md @@ -1,4 +1,4 @@ -## Interface `SynonymsGetSynonymsSetsResponse` +# `SynonymsGetSynonymsSetsResponse` [interface-SynonymsGetSynonymsSetsResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SynonymsGetSynonymsSetsSynonymsSetItem.md b/docs/reference/api/SynonymsGetSynonymsSetsSynonymsSetItem.md index c9895e79a..179289745 100644 --- a/docs/reference/api/SynonymsGetSynonymsSetsSynonymsSetItem.md +++ b/docs/reference/api/SynonymsGetSynonymsSetsSynonymsSetItem.md @@ -1,4 +1,4 @@ -## Interface `SynonymsGetSynonymsSetsSynonymsSetItem` +# `SynonymsGetSynonymsSetsSynonymsSetItem` [interface-SynonymsGetSynonymsSetsSynonymsSetItem] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SynonymsPutSynonymRequest.md b/docs/reference/api/SynonymsPutSynonymRequest.md index bf56275db..f8709a3b6 100644 --- a/docs/reference/api/SynonymsPutSynonymRequest.md +++ b/docs/reference/api/SynonymsPutSynonymRequest.md @@ -1,4 +1,4 @@ -## Interface `SynonymsPutSynonymRequest` +# `SynonymsPutSynonymRequest` [interface-SynonymsPutSynonymRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SynonymsPutSynonymResponse.md b/docs/reference/api/SynonymsPutSynonymResponse.md index 69e1ece6e..fdfe5d973 100644 --- a/docs/reference/api/SynonymsPutSynonymResponse.md +++ b/docs/reference/api/SynonymsPutSynonymResponse.md @@ -1,4 +1,4 @@ -## Interface `SynonymsPutSynonymResponse` +# `SynonymsPutSynonymResponse` [interface-SynonymsPutSynonymResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SynonymsPutSynonymRuleRequest.md b/docs/reference/api/SynonymsPutSynonymRuleRequest.md index adc195f1e..5ba3ee476 100644 --- a/docs/reference/api/SynonymsPutSynonymRuleRequest.md +++ b/docs/reference/api/SynonymsPutSynonymRuleRequest.md @@ -1,4 +1,4 @@ -## Interface `SynonymsPutSynonymRuleRequest` +# `SynonymsPutSynonymRuleRequest` [interface-SynonymsPutSynonymRuleRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SynonymsPutSynonymRuleResponse.md b/docs/reference/api/SynonymsPutSynonymRuleResponse.md index 1517a682a..8616e4e54 100644 --- a/docs/reference/api/SynonymsPutSynonymRuleResponse.md +++ b/docs/reference/api/SynonymsPutSynonymRuleResponse.md @@ -1,4 +1,4 @@ -## `SynonymsPutSynonymRuleResponse` -::: +# `SynonymsPutSynonymRuleResponse` [alias-SynonymsPutSynonymRuleResponse] +```typescript type SynonymsPutSynonymRuleResponse = [SynonymsSynonymsUpdateResult](./SynonymsSynonymsUpdateResult.md); -::: +``` diff --git a/docs/reference/api/SynonymsSynonymRule.md b/docs/reference/api/SynonymsSynonymRule.md index 8ae02bc9c..2615c20bb 100644 --- a/docs/reference/api/SynonymsSynonymRule.md +++ b/docs/reference/api/SynonymsSynonymRule.md @@ -1,4 +1,4 @@ -## Interface `SynonymsSynonymRule` +# `SynonymsSynonymRule` [interface-SynonymsSynonymRule] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SynonymsSynonymRuleRead.md b/docs/reference/api/SynonymsSynonymRuleRead.md index b54232cbd..cc82e7b04 100644 --- a/docs/reference/api/SynonymsSynonymRuleRead.md +++ b/docs/reference/api/SynonymsSynonymRuleRead.md @@ -1,4 +1,4 @@ -## Interface `SynonymsSynonymRuleRead` +# `SynonymsSynonymRuleRead` [interface-SynonymsSynonymRuleRead] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/SynonymsSynonymString.md b/docs/reference/api/SynonymsSynonymString.md index d38fd266a..bb1e46dc8 100644 --- a/docs/reference/api/SynonymsSynonymString.md +++ b/docs/reference/api/SynonymsSynonymString.md @@ -1,4 +1,4 @@ -## `SynonymsSynonymString` -::: +# `SynonymsSynonymString` [alias-SynonymsSynonymString] +```typescript type SynonymsSynonymString = string; -::: +``` diff --git a/docs/reference/api/SynonymsSynonymsUpdateResult.md b/docs/reference/api/SynonymsSynonymsUpdateResult.md index 59a0c870a..0c8e52f72 100644 --- a/docs/reference/api/SynonymsSynonymsUpdateResult.md +++ b/docs/reference/api/SynonymsSynonymsUpdateResult.md @@ -1,4 +1,4 @@ -## Interface `SynonymsSynonymsUpdateResult` +# `SynonymsSynonymsUpdateResult` [interface-SynonymsSynonymsUpdateResult] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/TODO.md b/docs/reference/api/TODO.md index 7d603058a..9a449e990 100644 --- a/docs/reference/api/TODO.md +++ b/docs/reference/api/TODO.md @@ -1,4 +1,4 @@ -## `TODO` -::: +# `TODO` [alias-TODO] +```typescript type TODO = Record; -::: +``` diff --git a/docs/reference/api/TaskFailure.md b/docs/reference/api/TaskFailure.md index aa3fa0519..17203194e 100644 --- a/docs/reference/api/TaskFailure.md +++ b/docs/reference/api/TaskFailure.md @@ -1,4 +1,4 @@ -## Interface `TaskFailure` +# `TaskFailure` [interface-TaskFailure] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/TaskId.md b/docs/reference/api/TaskId.md index 416d92583..3f67a986b 100644 --- a/docs/reference/api/TaskId.md +++ b/docs/reference/api/TaskId.md @@ -1,4 +1,4 @@ -## `TaskId` -::: +# `TaskId` [alias-TaskId] +```typescript type TaskId = string | [integer](./integer.md); -::: +``` diff --git a/docs/reference/api/Tasks.md b/docs/reference/api/Tasks.md index f22644735..abf94dedf 100644 --- a/docs/reference/api/Tasks.md +++ b/docs/reference/api/Tasks.md @@ -1,19 +1,19 @@ -## `Tasks` +# `Tasks` [class-Tasks] -### Constructor +## Constructor -::: +```typescript new Tasks(transport: [Transport](./Transport.md)); -::: +``` -### Properties +## Properties [class-properties-Tasks] | Name | Type | Description | | - | - | - | | `acceptedParams` | Record |   | | `transport` | [Transport](./Transport.md) |   | -### Methods +## Methods [class-methods-Tasks] | Name | Signature | Description | | - | - | - | diff --git a/docs/reference/api/TasksCancelRequest.md b/docs/reference/api/TasksCancelRequest.md index 8c700b5ae..7d3e5ded6 100644 --- a/docs/reference/api/TasksCancelRequest.md +++ b/docs/reference/api/TasksCancelRequest.md @@ -1,4 +1,4 @@ -## Interface `TasksCancelRequest` +# `TasksCancelRequest` [interface-TasksCancelRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/TasksCancelResponse.md b/docs/reference/api/TasksCancelResponse.md index c21638612..bacf42d77 100644 --- a/docs/reference/api/TasksCancelResponse.md +++ b/docs/reference/api/TasksCancelResponse.md @@ -1,4 +1,4 @@ -## `TasksCancelResponse` -::: +# `TasksCancelResponse` [alias-TasksCancelResponse] +```typescript type TasksCancelResponse = [TasksTaskListResponseBase](./TasksTaskListResponseBase.md); -::: +``` diff --git a/docs/reference/api/TasksGetRequest.md b/docs/reference/api/TasksGetRequest.md index 97f0b580d..6b8c7f60c 100644 --- a/docs/reference/api/TasksGetRequest.md +++ b/docs/reference/api/TasksGetRequest.md @@ -1,4 +1,4 @@ -## Interface `TasksGetRequest` +# `TasksGetRequest` [interface-TasksGetRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/TasksGetResponse.md b/docs/reference/api/TasksGetResponse.md index fba480497..cb5000bfa 100644 --- a/docs/reference/api/TasksGetResponse.md +++ b/docs/reference/api/TasksGetResponse.md @@ -1,4 +1,4 @@ -## Interface `TasksGetResponse` +# `TasksGetResponse` [interface-TasksGetResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/TasksGroupBy.md b/docs/reference/api/TasksGroupBy.md index 9d7a10a0b..cc98c0a7e 100644 --- a/docs/reference/api/TasksGroupBy.md +++ b/docs/reference/api/TasksGroupBy.md @@ -1,4 +1,4 @@ -## `TasksGroupBy` -::: +# `TasksGroupBy` [alias-TasksGroupBy] +```typescript type TasksGroupBy = 'nodes' | 'parents' | 'none'; -::: +``` diff --git a/docs/reference/api/TasksListRequest.md b/docs/reference/api/TasksListRequest.md index 60cfddfe7..f86080e9b 100644 --- a/docs/reference/api/TasksListRequest.md +++ b/docs/reference/api/TasksListRequest.md @@ -1,4 +1,4 @@ -## Interface `TasksListRequest` +# `TasksListRequest` [interface-TasksListRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/TasksListResponse.md b/docs/reference/api/TasksListResponse.md index 23977bad1..4f517dd8b 100644 --- a/docs/reference/api/TasksListResponse.md +++ b/docs/reference/api/TasksListResponse.md @@ -1,4 +1,4 @@ -## `TasksListResponse` -::: +# `TasksListResponse` [alias-TasksListResponse] +```typescript type TasksListResponse = [TasksTaskListResponseBase](./TasksTaskListResponseBase.md); -::: +``` diff --git a/docs/reference/api/TasksNodeTasks.md b/docs/reference/api/TasksNodeTasks.md index 22c164d2d..98d2da38e 100644 --- a/docs/reference/api/TasksNodeTasks.md +++ b/docs/reference/api/TasksNodeTasks.md @@ -1,4 +1,4 @@ -## Interface `TasksNodeTasks` +# `TasksNodeTasks` [interface-TasksNodeTasks] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/TasksParentTaskInfo.md b/docs/reference/api/TasksParentTaskInfo.md index d87a4a6d3..1c7f403a4 100644 --- a/docs/reference/api/TasksParentTaskInfo.md +++ b/docs/reference/api/TasksParentTaskInfo.md @@ -1,4 +1,4 @@ -## Interface `TasksParentTaskInfo` +# `TasksParentTaskInfo` [interface-TasksParentTaskInfo] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/TasksTaskInfo.md b/docs/reference/api/TasksTaskInfo.md index f98bf7cd9..05290979a 100644 --- a/docs/reference/api/TasksTaskInfo.md +++ b/docs/reference/api/TasksTaskInfo.md @@ -1,4 +1,4 @@ -## Interface `TasksTaskInfo` +# `TasksTaskInfo` [interface-TasksTaskInfo] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/TasksTaskInfos.md b/docs/reference/api/TasksTaskInfos.md index 1f7d7fbde..01c743b20 100644 --- a/docs/reference/api/TasksTaskInfos.md +++ b/docs/reference/api/TasksTaskInfos.md @@ -1,4 +1,4 @@ -## `TasksTaskInfos` -::: +# `TasksTaskInfos` [alias-TasksTaskInfos] +```typescript type TasksTaskInfos = [TasksTaskInfo](./TasksTaskInfo.md)[] | Record; -::: +``` diff --git a/docs/reference/api/TasksTaskListResponseBase.md b/docs/reference/api/TasksTaskListResponseBase.md index fb687309b..422a1d9b9 100644 --- a/docs/reference/api/TasksTaskListResponseBase.md +++ b/docs/reference/api/TasksTaskListResponseBase.md @@ -1,4 +1,4 @@ -## Interface `TasksTaskListResponseBase` +# `TasksTaskListResponseBase` [interface-TasksTaskListResponseBase] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/TermsEnumApi_1.md b/docs/reference/api/TermsEnumApi_1.md index 81ba616b0..d6171f791 100644 --- a/docs/reference/api/TermsEnumApi_1.md +++ b/docs/reference/api/TermsEnumApi_1.md @@ -1,3 +1,3 @@ -::: +```typescript default function TermsEnumApi(this: [That](./That.md), params: [TermsEnumRequest](./TermsEnumRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TermsEnumResponse](./TermsEnumResponse.md)>; -::: +``` diff --git a/docs/reference/api/TermsEnumApi_2.md b/docs/reference/api/TermsEnumApi_2.md index 734dfb127..16fa8314f 100644 --- a/docs/reference/api/TermsEnumApi_2.md +++ b/docs/reference/api/TermsEnumApi_2.md @@ -1,3 +1,3 @@ -::: +```typescript default function TermsEnumApi(this: [That](./That.md), params: [TermsEnumRequest](./TermsEnumRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TermsEnumResponse](./TermsEnumResponse.md), unknown>>; -::: +``` diff --git a/docs/reference/api/TermsEnumApi_3.md b/docs/reference/api/TermsEnumApi_3.md index a1b365cf0..7079921b3 100644 --- a/docs/reference/api/TermsEnumApi_3.md +++ b/docs/reference/api/TermsEnumApi_3.md @@ -1,3 +1,3 @@ -::: +```typescript default function TermsEnumApi(this: [That](./That.md), params: [TermsEnumRequest](./TermsEnumRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TermsEnumResponse](./TermsEnumResponse.md)>; -::: +``` diff --git a/docs/reference/api/TermsEnumRequest.md b/docs/reference/api/TermsEnumRequest.md index b426e1c66..bf44fac9c 100644 --- a/docs/reference/api/TermsEnumRequest.md +++ b/docs/reference/api/TermsEnumRequest.md @@ -1,4 +1,4 @@ -## Interface `TermsEnumRequest` +# `TermsEnumRequest` [interface-TermsEnumRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/TermsEnumResponse.md b/docs/reference/api/TermsEnumResponse.md index 8268f8efc..bbe267fe2 100644 --- a/docs/reference/api/TermsEnumResponse.md +++ b/docs/reference/api/TermsEnumResponse.md @@ -1,4 +1,4 @@ -## Interface `TermsEnumResponse` +# `TermsEnumResponse` [interface-TermsEnumResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/TermvectorsApi_1.md b/docs/reference/api/TermvectorsApi_1.md index 1faf2c3c9..296f5f734 100644 --- a/docs/reference/api/TermvectorsApi_1.md +++ b/docs/reference/api/TermvectorsApi_1.md @@ -1,3 +1,3 @@ -::: +```typescript default function TermvectorsApi(this: [That](./That.md), params: [TermvectorsRequest](./TermvectorsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TermvectorsResponse](./TermvectorsResponse.md)>; -::: +``` diff --git a/docs/reference/api/TermvectorsApi_2.md b/docs/reference/api/TermvectorsApi_2.md index 235b242f6..19b0edff4 100644 --- a/docs/reference/api/TermvectorsApi_2.md +++ b/docs/reference/api/TermvectorsApi_2.md @@ -1,3 +1,3 @@ -::: +```typescript default function TermvectorsApi(this: [That](./That.md), params: [TermvectorsRequest](./TermvectorsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TermvectorsResponse](./TermvectorsResponse.md), unknown>>; -::: +``` diff --git a/docs/reference/api/TermvectorsApi_3.md b/docs/reference/api/TermvectorsApi_3.md index 0edb0c0b4..9f8bc2afa 100644 --- a/docs/reference/api/TermvectorsApi_3.md +++ b/docs/reference/api/TermvectorsApi_3.md @@ -1,3 +1,3 @@ -::: +```typescript default function TermvectorsApi(this: [That](./That.md), params: [TermvectorsRequest](./TermvectorsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TermvectorsResponse](./TermvectorsResponse.md)>; -::: +``` diff --git a/docs/reference/api/TermvectorsFieldStatistics.md b/docs/reference/api/TermvectorsFieldStatistics.md index 277f87177..2866a863a 100644 --- a/docs/reference/api/TermvectorsFieldStatistics.md +++ b/docs/reference/api/TermvectorsFieldStatistics.md @@ -1,4 +1,4 @@ -## Interface `TermvectorsFieldStatistics` +# `TermvectorsFieldStatistics` [interface-TermvectorsFieldStatistics] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/TermvectorsFilter.md b/docs/reference/api/TermvectorsFilter.md index 1d5955220..835d28406 100644 --- a/docs/reference/api/TermvectorsFilter.md +++ b/docs/reference/api/TermvectorsFilter.md @@ -1,4 +1,4 @@ -## Interface `TermvectorsFilter` +# `TermvectorsFilter` [interface-TermvectorsFilter] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/TermvectorsRequest.md b/docs/reference/api/TermvectorsRequest.md index 78df6907c..670cfe6db 100644 --- a/docs/reference/api/TermvectorsRequest.md +++ b/docs/reference/api/TermvectorsRequest.md @@ -1,4 +1,4 @@ -## Interface `TermvectorsRequest` +# `TermvectorsRequest` [interface-TermvectorsRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/TermvectorsResponse.md b/docs/reference/api/TermvectorsResponse.md index 0058311b2..fc6dd66f1 100644 --- a/docs/reference/api/TermvectorsResponse.md +++ b/docs/reference/api/TermvectorsResponse.md @@ -1,4 +1,4 @@ -## Interface `TermvectorsResponse` +# `TermvectorsResponse` [interface-TermvectorsResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/TermvectorsTerm.md b/docs/reference/api/TermvectorsTerm.md index 786412b46..e67e150bf 100644 --- a/docs/reference/api/TermvectorsTerm.md +++ b/docs/reference/api/TermvectorsTerm.md @@ -1,4 +1,4 @@ -## Interface `TermvectorsTerm` +# `TermvectorsTerm` [interface-TermvectorsTerm] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/TermvectorsTermVector.md b/docs/reference/api/TermvectorsTermVector.md index 6e11008fa..8a02d73f2 100644 --- a/docs/reference/api/TermvectorsTermVector.md +++ b/docs/reference/api/TermvectorsTermVector.md @@ -1,4 +1,4 @@ -## Interface `TermvectorsTermVector` +# `TermvectorsTermVector` [interface-TermvectorsTermVector] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/TermvectorsToken.md b/docs/reference/api/TermvectorsToken.md index bb14d7b9e..9a15829c7 100644 --- a/docs/reference/api/TermvectorsToken.md +++ b/docs/reference/api/TermvectorsToken.md @@ -1,4 +1,4 @@ -## Interface `TermvectorsToken` +# `TermvectorsToken` [interface-TermvectorsToken] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/TextEmbedding.md b/docs/reference/api/TextEmbedding.md index aa5cd1d9f..822747c7f 100644 --- a/docs/reference/api/TextEmbedding.md +++ b/docs/reference/api/TextEmbedding.md @@ -1,4 +1,4 @@ -## Interface `TextEmbedding` +# `TextEmbedding` [interface-TextEmbedding] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/TextSimilarityReranker.md b/docs/reference/api/TextSimilarityReranker.md index ac49770de..420d1a4c6 100644 --- a/docs/reference/api/TextSimilarityReranker.md +++ b/docs/reference/api/TextSimilarityReranker.md @@ -1,4 +1,4 @@ -## Interface `TextSimilarityReranker` +# `TextSimilarityReranker` [interface-TextSimilarityReranker] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/TextStructure.md b/docs/reference/api/TextStructure.md index 6778b0f41..a0ee8d95c 100644 --- a/docs/reference/api/TextStructure.md +++ b/docs/reference/api/TextStructure.md @@ -1,19 +1,19 @@ -## `TextStructure` +# `TextStructure` [class-TextStructure] -### Constructor +## Constructor -::: +```typescript new TextStructure(transport: [Transport](./Transport.md)); -::: +``` -### Properties +## Properties [class-properties-TextStructure] | Name | Type | Description | | - | - | - | | `acceptedParams` | Record |   | | `transport` | [Transport](./Transport.md) |   | -### Methods +## Methods [class-methods-TextStructure] | Name | Signature | Description | | - | - | - | diff --git a/docs/reference/api/TextStructureEcsCompatibilityType.md b/docs/reference/api/TextStructureEcsCompatibilityType.md index 2e32db195..941e6ab66 100644 --- a/docs/reference/api/TextStructureEcsCompatibilityType.md +++ b/docs/reference/api/TextStructureEcsCompatibilityType.md @@ -1,4 +1,4 @@ -## `TextStructureEcsCompatibilityType` -::: +# `TextStructureEcsCompatibilityType` [alias-TextStructureEcsCompatibilityType] +```typescript type TextStructureEcsCompatibilityType = 'disabled' | 'v1'; -::: +``` diff --git a/docs/reference/api/TextStructureFieldStat.md b/docs/reference/api/TextStructureFieldStat.md index e92f131c8..56dd1d138 100644 --- a/docs/reference/api/TextStructureFieldStat.md +++ b/docs/reference/api/TextStructureFieldStat.md @@ -1,4 +1,4 @@ -## Interface `TextStructureFieldStat` +# `TextStructureFieldStat` [interface-TextStructureFieldStat] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/TextStructureFindFieldStructureRequest.md b/docs/reference/api/TextStructureFindFieldStructureRequest.md index f9cb10203..23d8464f4 100644 --- a/docs/reference/api/TextStructureFindFieldStructureRequest.md +++ b/docs/reference/api/TextStructureFindFieldStructureRequest.md @@ -1,4 +1,4 @@ -## Interface `TextStructureFindFieldStructureRequest` +# `TextStructureFindFieldStructureRequest` [interface-TextStructureFindFieldStructureRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/TextStructureFindFieldStructureResponse.md b/docs/reference/api/TextStructureFindFieldStructureResponse.md index 4a8b5cecb..94c18114c 100644 --- a/docs/reference/api/TextStructureFindFieldStructureResponse.md +++ b/docs/reference/api/TextStructureFindFieldStructureResponse.md @@ -1,4 +1,4 @@ -## Interface `TextStructureFindFieldStructureResponse` +# `TextStructureFindFieldStructureResponse` [interface-TextStructureFindFieldStructureResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/TextStructureFindMessageStructureRequest.md b/docs/reference/api/TextStructureFindMessageStructureRequest.md index 9a0ff5109..610c21f9f 100644 --- a/docs/reference/api/TextStructureFindMessageStructureRequest.md +++ b/docs/reference/api/TextStructureFindMessageStructureRequest.md @@ -1,4 +1,4 @@ -## Interface `TextStructureFindMessageStructureRequest` +# `TextStructureFindMessageStructureRequest` [interface-TextStructureFindMessageStructureRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/TextStructureFindMessageStructureResponse.md b/docs/reference/api/TextStructureFindMessageStructureResponse.md index 964dc3f6f..592b47578 100644 --- a/docs/reference/api/TextStructureFindMessageStructureResponse.md +++ b/docs/reference/api/TextStructureFindMessageStructureResponse.md @@ -1,4 +1,4 @@ -## Interface `TextStructureFindMessageStructureResponse` +# `TextStructureFindMessageStructureResponse` [interface-TextStructureFindMessageStructureResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/TextStructureFindStructureRequest.md b/docs/reference/api/TextStructureFindStructureRequest.md index 5bf541fbd..48c8e2974 100644 --- a/docs/reference/api/TextStructureFindStructureRequest.md +++ b/docs/reference/api/TextStructureFindStructureRequest.md @@ -1,4 +1,4 @@ -## Interface `TextStructureFindStructureRequest` +# `TextStructureFindStructureRequest` [interface-TextStructureFindStructureRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/TextStructureFindStructureResponse.md b/docs/reference/api/TextStructureFindStructureResponse.md index bcf09c0dc..2c5a93b58 100644 --- a/docs/reference/api/TextStructureFindStructureResponse.md +++ b/docs/reference/api/TextStructureFindStructureResponse.md @@ -1,4 +1,4 @@ -## Interface `TextStructureFindStructureResponse` +# `TextStructureFindStructureResponse` [interface-TextStructureFindStructureResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/TextStructureFormatType.md b/docs/reference/api/TextStructureFormatType.md index 9dd75460b..67f8f276a 100644 --- a/docs/reference/api/TextStructureFormatType.md +++ b/docs/reference/api/TextStructureFormatType.md @@ -1,4 +1,4 @@ -## `TextStructureFormatType` -::: +# `TextStructureFormatType` [alias-TextStructureFormatType] +```typescript type TextStructureFormatType = 'delimited' | 'ndjson' | 'semi_structured_text' | 'xml'; -::: +``` diff --git a/docs/reference/api/TextStructureTestGrokPatternMatchedField.md b/docs/reference/api/TextStructureTestGrokPatternMatchedField.md index a036b66f4..fe07ebd7f 100644 --- a/docs/reference/api/TextStructureTestGrokPatternMatchedField.md +++ b/docs/reference/api/TextStructureTestGrokPatternMatchedField.md @@ -1,4 +1,4 @@ -## Interface `TextStructureTestGrokPatternMatchedField` +# `TextStructureTestGrokPatternMatchedField` [interface-TextStructureTestGrokPatternMatchedField] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/TextStructureTestGrokPatternMatchedText.md b/docs/reference/api/TextStructureTestGrokPatternMatchedText.md index ccf17b185..72a9d0fc7 100644 --- a/docs/reference/api/TextStructureTestGrokPatternMatchedText.md +++ b/docs/reference/api/TextStructureTestGrokPatternMatchedText.md @@ -1,4 +1,4 @@ -## Interface `TextStructureTestGrokPatternMatchedText` +# `TextStructureTestGrokPatternMatchedText` [interface-TextStructureTestGrokPatternMatchedText] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/TextStructureTestGrokPatternRequest.md b/docs/reference/api/TextStructureTestGrokPatternRequest.md index 451d65901..f6c3c017d 100644 --- a/docs/reference/api/TextStructureTestGrokPatternRequest.md +++ b/docs/reference/api/TextStructureTestGrokPatternRequest.md @@ -1,4 +1,4 @@ -## Interface `TextStructureTestGrokPatternRequest` +# `TextStructureTestGrokPatternRequest` [interface-TextStructureTestGrokPatternRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/TextStructureTestGrokPatternResponse.md b/docs/reference/api/TextStructureTestGrokPatternResponse.md index dbd1ae4cc..8e72d1dd7 100644 --- a/docs/reference/api/TextStructureTestGrokPatternResponse.md +++ b/docs/reference/api/TextStructureTestGrokPatternResponse.md @@ -1,4 +1,4 @@ -## Interface `TextStructureTestGrokPatternResponse` +# `TextStructureTestGrokPatternResponse` [interface-TextStructureTestGrokPatternResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/TextStructureTopHit.md b/docs/reference/api/TextStructureTopHit.md index 68fa5b2dc..cb19e4ab3 100644 --- a/docs/reference/api/TextStructureTopHit.md +++ b/docs/reference/api/TextStructureTopHit.md @@ -1,4 +1,4 @@ -## Interface `TextStructureTopHit` +# `TextStructureTopHit` [interface-TextStructureTopHit] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/That.md b/docs/reference/api/That.md index 49e001014..ad8721a33 100644 --- a/docs/reference/api/That.md +++ b/docs/reference/api/That.md @@ -1,4 +1,4 @@ -## Interface `That` +# `That` [interface-That] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/That_10.md b/docs/reference/api/That_10.md index 5d1947908..1b47e157a 100644 --- a/docs/reference/api/That_10.md +++ b/docs/reference/api/That_10.md @@ -1,4 +1,4 @@ -## Interface `That_10` +# `That_10` [interface-That_10] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/That_11.md b/docs/reference/api/That_11.md index 0df4b0346..118d57fb6 100644 --- a/docs/reference/api/That_11.md +++ b/docs/reference/api/That_11.md @@ -1,4 +1,4 @@ -## Interface `That_11` +# `That_11` [interface-That_11] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/That_12.md b/docs/reference/api/That_12.md index f76370fd8..eb3de226b 100644 --- a/docs/reference/api/That_12.md +++ b/docs/reference/api/That_12.md @@ -1,4 +1,4 @@ -## Interface `That_12` +# `That_12` [interface-That_12] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/That_13.md b/docs/reference/api/That_13.md index f19549708..a990d7866 100644 --- a/docs/reference/api/That_13.md +++ b/docs/reference/api/That_13.md @@ -1,4 +1,4 @@ -## Interface `That_13` +# `That_13` [interface-That_13] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/That_14.md b/docs/reference/api/That_14.md index bc2b95421..9553f4838 100644 --- a/docs/reference/api/That_14.md +++ b/docs/reference/api/That_14.md @@ -1,4 +1,4 @@ -## Interface `That_14` +# `That_14` [interface-That_14] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/That_15.md b/docs/reference/api/That_15.md index db5c10268..fa1b5c50f 100644 --- a/docs/reference/api/That_15.md +++ b/docs/reference/api/That_15.md @@ -1,4 +1,4 @@ -## Interface `That_15` +# `That_15` [interface-That_15] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/That_16.md b/docs/reference/api/That_16.md index 8c98b9f0c..cf9dea714 100644 --- a/docs/reference/api/That_16.md +++ b/docs/reference/api/That_16.md @@ -1,4 +1,4 @@ -## Interface `That_16` +# `That_16` [interface-That_16] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/That_17.md b/docs/reference/api/That_17.md index f85eabbdf..c475367ee 100644 --- a/docs/reference/api/That_17.md +++ b/docs/reference/api/That_17.md @@ -1,4 +1,4 @@ -## Interface `That_17` +# `That_17` [interface-That_17] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/That_18.md b/docs/reference/api/That_18.md index 50e482bc8..d689847a9 100644 --- a/docs/reference/api/That_18.md +++ b/docs/reference/api/That_18.md @@ -1,4 +1,4 @@ -## Interface `That_18` +# `That_18` [interface-That_18] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/That_19.md b/docs/reference/api/That_19.md index de51d501b..943536354 100644 --- a/docs/reference/api/That_19.md +++ b/docs/reference/api/That_19.md @@ -1,4 +1,4 @@ -## Interface `That_19` +# `That_19` [interface-That_19] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/That_20.md b/docs/reference/api/That_20.md index e99ae758e..14f08d7ae 100644 --- a/docs/reference/api/That_20.md +++ b/docs/reference/api/That_20.md @@ -1,4 +1,4 @@ -## Interface `That_20` +# `That_20` [interface-That_20] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/That_21.md b/docs/reference/api/That_21.md index 2067b14f8..6bbdff08d 100644 --- a/docs/reference/api/That_21.md +++ b/docs/reference/api/That_21.md @@ -1,4 +1,4 @@ -## Interface `That_21` +# `That_21` [interface-That_21] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/That_22.md b/docs/reference/api/That_22.md index a61b0847f..020fcb20e 100644 --- a/docs/reference/api/That_22.md +++ b/docs/reference/api/That_22.md @@ -1,4 +1,4 @@ -## Interface `That_22` +# `That_22` [interface-That_22] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/That_23.md b/docs/reference/api/That_23.md index 0bcbd01dd..34bbc5e70 100644 --- a/docs/reference/api/That_23.md +++ b/docs/reference/api/That_23.md @@ -1,4 +1,4 @@ -## Interface `That_23` +# `That_23` [interface-That_23] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/That_24.md b/docs/reference/api/That_24.md index e0011f687..c9612b456 100644 --- a/docs/reference/api/That_24.md +++ b/docs/reference/api/That_24.md @@ -1,4 +1,4 @@ -## Interface `That_24` +# `That_24` [interface-That_24] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/That_25.md b/docs/reference/api/That_25.md index 008939434..d526e45b9 100644 --- a/docs/reference/api/That_25.md +++ b/docs/reference/api/That_25.md @@ -1,4 +1,4 @@ -## Interface `That_25` +# `That_25` [interface-That_25] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/That_26.md b/docs/reference/api/That_26.md index 6b70eaa2b..1d038070b 100644 --- a/docs/reference/api/That_26.md +++ b/docs/reference/api/That_26.md @@ -1,4 +1,4 @@ -## Interface `That_26` +# `That_26` [interface-That_26] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/That_27.md b/docs/reference/api/That_27.md index 6ec75f008..210db169b 100644 --- a/docs/reference/api/That_27.md +++ b/docs/reference/api/That_27.md @@ -1,4 +1,4 @@ -## Interface `That_27` +# `That_27` [interface-That_27] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/That_28.md b/docs/reference/api/That_28.md index e8000fd90..b3efa7151 100644 --- a/docs/reference/api/That_28.md +++ b/docs/reference/api/That_28.md @@ -1,4 +1,4 @@ -## Interface `That_28` +# `That_28` [interface-That_28] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/That_29.md b/docs/reference/api/That_29.md index 9ce75a10d..45787c3a7 100644 --- a/docs/reference/api/That_29.md +++ b/docs/reference/api/That_29.md @@ -1,4 +1,4 @@ -## Interface `That_29` +# `That_29` [interface-That_29] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/That_3.md b/docs/reference/api/That_3.md index e178eaa9c..4785077ad 100644 --- a/docs/reference/api/That_3.md +++ b/docs/reference/api/That_3.md @@ -1,4 +1,4 @@ -## Interface `That_3` +# `That_3` [interface-That_3] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/That_30.md b/docs/reference/api/That_30.md index 9515bc3fb..32992b9c7 100644 --- a/docs/reference/api/That_30.md +++ b/docs/reference/api/That_30.md @@ -1,4 +1,4 @@ -## Interface `That_30` +# `That_30` [interface-That_30] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/That_31.md b/docs/reference/api/That_31.md index fd2a733a0..c4ae0acbe 100644 --- a/docs/reference/api/That_31.md +++ b/docs/reference/api/That_31.md @@ -1,4 +1,4 @@ -## Interface `That_31` +# `That_31` [interface-That_31] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/That_32.md b/docs/reference/api/That_32.md index 94abe50f2..9c95da730 100644 --- a/docs/reference/api/That_32.md +++ b/docs/reference/api/That_32.md @@ -1,4 +1,4 @@ -## Interface `That_32` +# `That_32` [interface-That_32] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/That_33.md b/docs/reference/api/That_33.md index f6fbb8ff1..cbd2a66d4 100644 --- a/docs/reference/api/That_33.md +++ b/docs/reference/api/That_33.md @@ -1,4 +1,4 @@ -## Interface `That_33` +# `That_33` [interface-That_33] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/That_34.md b/docs/reference/api/That_34.md index 89f9c11e6..8c2be9165 100644 --- a/docs/reference/api/That_34.md +++ b/docs/reference/api/That_34.md @@ -1,4 +1,4 @@ -## Interface `That_34` +# `That_34` [interface-That_34] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/That_35.md b/docs/reference/api/That_35.md index af87a1e05..a441b835e 100644 --- a/docs/reference/api/That_35.md +++ b/docs/reference/api/That_35.md @@ -1,4 +1,4 @@ -## Interface `That_35` +# `That_35` [interface-That_35] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/That_36.md b/docs/reference/api/That_36.md index f75d120c2..b1c8df78d 100644 --- a/docs/reference/api/That_36.md +++ b/docs/reference/api/That_36.md @@ -1,4 +1,4 @@ -## Interface `That_36` +# `That_36` [interface-That_36] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/That_37.md b/docs/reference/api/That_37.md index 2f4a5eeb3..71c484197 100644 --- a/docs/reference/api/That_37.md +++ b/docs/reference/api/That_37.md @@ -1,4 +1,4 @@ -## Interface `That_37` +# `That_37` [interface-That_37] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/That_38.md b/docs/reference/api/That_38.md index 0eebddb4b..8a50352b7 100644 --- a/docs/reference/api/That_38.md +++ b/docs/reference/api/That_38.md @@ -1,4 +1,4 @@ -## Interface `That_38` +# `That_38` [interface-That_38] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/That_39.md b/docs/reference/api/That_39.md index 922ed7098..ca4a3484c 100644 --- a/docs/reference/api/That_39.md +++ b/docs/reference/api/That_39.md @@ -1,4 +1,4 @@ -## Interface `That_39` +# `That_39` [interface-That_39] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/That_4.md b/docs/reference/api/That_4.md index 304fd9984..b4f63d5e1 100644 --- a/docs/reference/api/That_4.md +++ b/docs/reference/api/That_4.md @@ -1,4 +1,4 @@ -## Interface `That_4` +# `That_4` [interface-That_4] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/That_40.md b/docs/reference/api/That_40.md index e3de796a1..9f1d7893c 100644 --- a/docs/reference/api/That_40.md +++ b/docs/reference/api/That_40.md @@ -1,4 +1,4 @@ -## Interface `That_40` +# `That_40` [interface-That_40] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/That_41.md b/docs/reference/api/That_41.md index c3c5a2252..cf7d334d1 100644 --- a/docs/reference/api/That_41.md +++ b/docs/reference/api/That_41.md @@ -1,4 +1,4 @@ -## Interface `That_41` +# `That_41` [interface-That_41] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/That_42.md b/docs/reference/api/That_42.md index 104381863..8e2f85b1b 100644 --- a/docs/reference/api/That_42.md +++ b/docs/reference/api/That_42.md @@ -1,4 +1,4 @@ -## Interface `That_42` +# `That_42` [interface-That_42] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/That_43.md b/docs/reference/api/That_43.md index fb74b2cbd..d8de0f5c2 100644 --- a/docs/reference/api/That_43.md +++ b/docs/reference/api/That_43.md @@ -1,4 +1,4 @@ -## Interface `That_43` +# `That_43` [interface-That_43] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/That_44.md b/docs/reference/api/That_44.md index 5f0a7992b..afcf7d298 100644 --- a/docs/reference/api/That_44.md +++ b/docs/reference/api/That_44.md @@ -1,4 +1,4 @@ -## Interface `That_44` +# `That_44` [interface-That_44] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/That_45.md b/docs/reference/api/That_45.md index 61e0805bf..042f370d9 100644 --- a/docs/reference/api/That_45.md +++ b/docs/reference/api/That_45.md @@ -1,4 +1,4 @@ -## Interface `That_45` +# `That_45` [interface-That_45] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/That_46.md b/docs/reference/api/That_46.md index f4ead338b..01234e05c 100644 --- a/docs/reference/api/That_46.md +++ b/docs/reference/api/That_46.md @@ -1,4 +1,4 @@ -## Interface `That_46` +# `That_46` [interface-That_46] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/That_47.md b/docs/reference/api/That_47.md index c12963b77..a78a08f5c 100644 --- a/docs/reference/api/That_47.md +++ b/docs/reference/api/That_47.md @@ -1,4 +1,4 @@ -## Interface `That_47` +# `That_47` [interface-That_47] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/That_48.md b/docs/reference/api/That_48.md index f1ee8c466..4e66cfaaa 100644 --- a/docs/reference/api/That_48.md +++ b/docs/reference/api/That_48.md @@ -1,4 +1,4 @@ -## Interface `That_48` +# `That_48` [interface-That_48] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/That_49.md b/docs/reference/api/That_49.md index b4c2023d7..125264c79 100644 --- a/docs/reference/api/That_49.md +++ b/docs/reference/api/That_49.md @@ -1,4 +1,4 @@ -## Interface `That_49` +# `That_49` [interface-That_49] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/That_5.md b/docs/reference/api/That_5.md index 206ee0ff2..88f86fa32 100644 --- a/docs/reference/api/That_5.md +++ b/docs/reference/api/That_5.md @@ -1,4 +1,4 @@ -## Interface `That_5` +# `That_5` [interface-That_5] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/That_50.md b/docs/reference/api/That_50.md index 0c566f5c3..64c4feefe 100644 --- a/docs/reference/api/That_50.md +++ b/docs/reference/api/That_50.md @@ -1,4 +1,4 @@ -## Interface `That_50` +# `That_50` [interface-That_50] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/That_51.md b/docs/reference/api/That_51.md index bf8893151..179ec1da6 100644 --- a/docs/reference/api/That_51.md +++ b/docs/reference/api/That_51.md @@ -1,4 +1,4 @@ -## Interface `That_51` +# `That_51` [interface-That_51] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/That_52.md b/docs/reference/api/That_52.md index 64a5a5d8b..d4e833cce 100644 --- a/docs/reference/api/That_52.md +++ b/docs/reference/api/That_52.md @@ -1,4 +1,4 @@ -## Interface `That_52` +# `That_52` [interface-That_52] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/That_53.md b/docs/reference/api/That_53.md index 5132f009f..ee1545db2 100644 --- a/docs/reference/api/That_53.md +++ b/docs/reference/api/That_53.md @@ -1,4 +1,4 @@ -## Interface `That_53` +# `That_53` [interface-That_53] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/That_54.md b/docs/reference/api/That_54.md index 7d623eda4..7badafa59 100644 --- a/docs/reference/api/That_54.md +++ b/docs/reference/api/That_54.md @@ -1,4 +1,4 @@ -## Interface `That_54` +# `That_54` [interface-That_54] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/That_55.md b/docs/reference/api/That_55.md index c8f795f6c..c3533c2f5 100644 --- a/docs/reference/api/That_55.md +++ b/docs/reference/api/That_55.md @@ -1,4 +1,4 @@ -## Interface `That_55` +# `That_55` [interface-That_55] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/That_56.md b/docs/reference/api/That_56.md index 21858ba8e..814d41161 100644 --- a/docs/reference/api/That_56.md +++ b/docs/reference/api/That_56.md @@ -1,4 +1,4 @@ -## Interface `That_56` +# `That_56` [interface-That_56] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/That_57.md b/docs/reference/api/That_57.md index bebed2888..d38991da5 100644 --- a/docs/reference/api/That_57.md +++ b/docs/reference/api/That_57.md @@ -1,4 +1,4 @@ -## Interface `That_57` +# `That_57` [interface-That_57] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/That_58.md b/docs/reference/api/That_58.md index 95a62bb9e..8167a5249 100644 --- a/docs/reference/api/That_58.md +++ b/docs/reference/api/That_58.md @@ -1,4 +1,4 @@ -## Interface `That_58` +# `That_58` [interface-That_58] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/That_59.md b/docs/reference/api/That_59.md index b4c095682..566b4288f 100644 --- a/docs/reference/api/That_59.md +++ b/docs/reference/api/That_59.md @@ -1,4 +1,4 @@ -## Interface `That_59` +# `That_59` [interface-That_59] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/That_6.md b/docs/reference/api/That_6.md index c38ec9287..4446c17f1 100644 --- a/docs/reference/api/That_6.md +++ b/docs/reference/api/That_6.md @@ -1,4 +1,4 @@ -## Interface `That_6` +# `That_6` [interface-That_6] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/That_60.md b/docs/reference/api/That_60.md index ebca87543..4dfe33f0a 100644 --- a/docs/reference/api/That_60.md +++ b/docs/reference/api/That_60.md @@ -1,4 +1,4 @@ -## Interface `That_60` +# `That_60` [interface-That_60] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/That_61.md b/docs/reference/api/That_61.md index 96fac04a1..ed035c5c3 100644 --- a/docs/reference/api/That_61.md +++ b/docs/reference/api/That_61.md @@ -1,4 +1,4 @@ -## Interface `That_61` +# `That_61` [interface-That_61] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/That_62.md b/docs/reference/api/That_62.md index 0fe2c04aa..52a0da44f 100644 --- a/docs/reference/api/That_62.md +++ b/docs/reference/api/That_62.md @@ -1,4 +1,4 @@ -## Interface `That_62` +# `That_62` [interface-That_62] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/That_63.md b/docs/reference/api/That_63.md index 313dfeea0..58da62bcc 100644 --- a/docs/reference/api/That_63.md +++ b/docs/reference/api/That_63.md @@ -1,4 +1,4 @@ -## Interface `That_63` +# `That_63` [interface-That_63] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/That_64.md b/docs/reference/api/That_64.md index 5612a4f4e..d0f2eaca9 100644 --- a/docs/reference/api/That_64.md +++ b/docs/reference/api/That_64.md @@ -1,4 +1,4 @@ -## Interface `That_64` +# `That_64` [interface-That_64] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/That_65.md b/docs/reference/api/That_65.md index fef02bcba..05df1f559 100644 --- a/docs/reference/api/That_65.md +++ b/docs/reference/api/That_65.md @@ -1,4 +1,4 @@ -## Interface `That_65` +# `That_65` [interface-That_65] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/That_66.md b/docs/reference/api/That_66.md index 3dd775d45..008454111 100644 --- a/docs/reference/api/That_66.md +++ b/docs/reference/api/That_66.md @@ -1,4 +1,4 @@ -## Interface `That_66` +# `That_66` [interface-That_66] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/That_67.md b/docs/reference/api/That_67.md index f789219e7..d97344b5d 100644 --- a/docs/reference/api/That_67.md +++ b/docs/reference/api/That_67.md @@ -1,4 +1,4 @@ -## Interface `That_67` +# `That_67` [interface-That_67] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/That_68.md b/docs/reference/api/That_68.md index 1a07132a8..bc2831d9c 100644 --- a/docs/reference/api/That_68.md +++ b/docs/reference/api/That_68.md @@ -1,4 +1,4 @@ -## Interface `That_68` +# `That_68` [interface-That_68] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/That_69.md b/docs/reference/api/That_69.md index 0ea2a338e..61e76f88b 100644 --- a/docs/reference/api/That_69.md +++ b/docs/reference/api/That_69.md @@ -1,4 +1,4 @@ -## Interface `That_69` +# `That_69` [interface-That_69] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/That_7.md b/docs/reference/api/That_7.md index 5ecb09d34..1e334c1da 100644 --- a/docs/reference/api/That_7.md +++ b/docs/reference/api/That_7.md @@ -1,4 +1,4 @@ -## Interface `That_7` +# `That_7` [interface-That_7] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/That_70.md b/docs/reference/api/That_70.md index 13433ad6e..5e415130b 100644 --- a/docs/reference/api/That_70.md +++ b/docs/reference/api/That_70.md @@ -1,4 +1,4 @@ -## Interface `That_70` +# `That_70` [interface-That_70] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/That_71.md b/docs/reference/api/That_71.md index 0e3be3f6b..7c140a63d 100644 --- a/docs/reference/api/That_71.md +++ b/docs/reference/api/That_71.md @@ -1,4 +1,4 @@ -## Interface `That_71` +# `That_71` [interface-That_71] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/That_72.md b/docs/reference/api/That_72.md index fd5bda427..2aba2320d 100644 --- a/docs/reference/api/That_72.md +++ b/docs/reference/api/That_72.md @@ -1,4 +1,4 @@ -## Interface `That_72` +# `That_72` [interface-That_72] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/That_73.md b/docs/reference/api/That_73.md index e48b5e987..6193327ae 100644 --- a/docs/reference/api/That_73.md +++ b/docs/reference/api/That_73.md @@ -1,4 +1,4 @@ -## Interface `That_73` +# `That_73` [interface-That_73] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/That_74.md b/docs/reference/api/That_74.md index e817d8838..cf12d011a 100644 --- a/docs/reference/api/That_74.md +++ b/docs/reference/api/That_74.md @@ -1,4 +1,4 @@ -## Interface `That_74` +# `That_74` [interface-That_74] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/That_75.md b/docs/reference/api/That_75.md index d54085ca6..f65e9e676 100644 --- a/docs/reference/api/That_75.md +++ b/docs/reference/api/That_75.md @@ -1,4 +1,4 @@ -## Interface `That_75` +# `That_75` [interface-That_75] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/That_76.md b/docs/reference/api/That_76.md index 0356c9875..a07fbba46 100644 --- a/docs/reference/api/That_76.md +++ b/docs/reference/api/That_76.md @@ -1,4 +1,4 @@ -## Interface `That_76` +# `That_76` [interface-That_76] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/That_77.md b/docs/reference/api/That_77.md index f79ec8ff7..04771d276 100644 --- a/docs/reference/api/That_77.md +++ b/docs/reference/api/That_77.md @@ -1,4 +1,4 @@ -## Interface `That_77` +# `That_77` [interface-That_77] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/That_78.md b/docs/reference/api/That_78.md index 0ea4b0af6..d0a30bb0b 100644 --- a/docs/reference/api/That_78.md +++ b/docs/reference/api/That_78.md @@ -1,4 +1,4 @@ -## Interface `That_78` +# `That_78` [interface-That_78] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/That_79.md b/docs/reference/api/That_79.md index 5acfb5f1d..cdade565f 100644 --- a/docs/reference/api/That_79.md +++ b/docs/reference/api/That_79.md @@ -1,4 +1,4 @@ -## Interface `That_79` +# `That_79` [interface-That_79] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/That_8.md b/docs/reference/api/That_8.md index 58ad67cc6..3c4b74120 100644 --- a/docs/reference/api/That_8.md +++ b/docs/reference/api/That_8.md @@ -1,4 +1,4 @@ -## Interface `That_8` +# `That_8` [interface-That_8] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/That_80.md b/docs/reference/api/That_80.md index 3b2c2f958..8c3e7c8b0 100644 --- a/docs/reference/api/That_80.md +++ b/docs/reference/api/That_80.md @@ -1,4 +1,4 @@ -## Interface `That_80` +# `That_80` [interface-That_80] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/That_81.md b/docs/reference/api/That_81.md index 3e0d0e3ee..4b1ca790b 100644 --- a/docs/reference/api/That_81.md +++ b/docs/reference/api/That_81.md @@ -1,4 +1,4 @@ -## Interface `That_81` +# `That_81` [interface-That_81] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/That_82.md b/docs/reference/api/That_82.md index d62b2a10a..9df192f40 100644 --- a/docs/reference/api/That_82.md +++ b/docs/reference/api/That_82.md @@ -1,4 +1,4 @@ -## Interface `That_82` +# `That_82` [interface-That_82] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/That_83.md b/docs/reference/api/That_83.md index 20aebee5a..e29c136cf 100644 --- a/docs/reference/api/That_83.md +++ b/docs/reference/api/That_83.md @@ -1,4 +1,4 @@ -## Interface `That_83` +# `That_83` [interface-That_83] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/That_84.md b/docs/reference/api/That_84.md index 8c1f7558a..e99081ac4 100644 --- a/docs/reference/api/That_84.md +++ b/docs/reference/api/That_84.md @@ -1,4 +1,4 @@ -## Interface `That_84` +# `That_84` [interface-That_84] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/That_85.md b/docs/reference/api/That_85.md index bdb90b6a5..201f06995 100644 --- a/docs/reference/api/That_85.md +++ b/docs/reference/api/That_85.md @@ -1,4 +1,4 @@ -## Interface `That_85` +# `That_85` [interface-That_85] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/That_86.md b/docs/reference/api/That_86.md index d5d5b4231..175d160d1 100644 --- a/docs/reference/api/That_86.md +++ b/docs/reference/api/That_86.md @@ -1,4 +1,4 @@ -## Interface `That_86` +# `That_86` [interface-That_86] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/That_9.md b/docs/reference/api/That_9.md index 606f71cc6..f77394d34 100644 --- a/docs/reference/api/That_9.md +++ b/docs/reference/api/That_9.md @@ -1,4 +1,4 @@ -## Interface `That_9` +# `That_9` [interface-That_9] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/ThreadType.md b/docs/reference/api/ThreadType.md index f95e00363..168aff6c0 100644 --- a/docs/reference/api/ThreadType.md +++ b/docs/reference/api/ThreadType.md @@ -1,4 +1,4 @@ -## `ThreadType` -::: +# `ThreadType` [alias-ThreadType] +```typescript type ThreadType = 'cpu' | 'wait' | 'block' | 'gpu' | 'mem'; -::: +``` diff --git a/docs/reference/api/TimeOfDay.md b/docs/reference/api/TimeOfDay.md index 62c19119e..df87c2e18 100644 --- a/docs/reference/api/TimeOfDay.md +++ b/docs/reference/api/TimeOfDay.md @@ -1,4 +1,4 @@ -## `TimeOfDay` -::: +# `TimeOfDay` [alias-TimeOfDay] +```typescript type TimeOfDay = string; -::: +``` diff --git a/docs/reference/api/TimeUnit.md b/docs/reference/api/TimeUnit.md index 7efa0afd3..b5b0ad757 100644 --- a/docs/reference/api/TimeUnit.md +++ b/docs/reference/api/TimeUnit.md @@ -1,4 +1,4 @@ -## `TimeUnit` -::: +# `TimeUnit` [alias-TimeUnit] +```typescript type TimeUnit = 'nanos' | 'micros' | 'ms' | 's' | 'm' | 'h' | 'd'; -::: +``` diff --git a/docs/reference/api/TimeZone.md b/docs/reference/api/TimeZone.md index bbcb14373..033e503a1 100644 --- a/docs/reference/api/TimeZone.md +++ b/docs/reference/api/TimeZone.md @@ -1,4 +1,4 @@ -## `TimeZone` -::: +# `TimeZone` [alias-TimeZone] +```typescript type TimeZone = string; -::: +``` diff --git a/docs/reference/api/TopLeftBottomRightGeoBounds.md b/docs/reference/api/TopLeftBottomRightGeoBounds.md index f5518950b..8ae80102c 100644 --- a/docs/reference/api/TopLeftBottomRightGeoBounds.md +++ b/docs/reference/api/TopLeftBottomRightGeoBounds.md @@ -1,4 +1,4 @@ -## Interface `TopLeftBottomRightGeoBounds` +# `TopLeftBottomRightGeoBounds` [interface-TopLeftBottomRightGeoBounds] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/TopRightBottomLeftGeoBounds.md b/docs/reference/api/TopRightBottomLeftGeoBounds.md index aa04c1ebf..7198e2c94 100644 --- a/docs/reference/api/TopRightBottomLeftGeoBounds.md +++ b/docs/reference/api/TopRightBottomLeftGeoBounds.md @@ -1,4 +1,4 @@ -## Interface `TopRightBottomLeftGeoBounds` +# `TopRightBottomLeftGeoBounds` [interface-TopRightBottomLeftGeoBounds] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/Transform.md b/docs/reference/api/Transform.md index bed0ecc7e..b8a8528e5 100644 --- a/docs/reference/api/Transform.md +++ b/docs/reference/api/Transform.md @@ -1,19 +1,19 @@ -## `Transform` +# `Transform` [class-Transform] -### Constructor +## Constructor -::: +```typescript new Transform(transport: [Transport](./Transport.md)); -::: +``` -### Properties +## Properties [class-properties-Transform] | Name | Type | Description | | - | - | - | | `acceptedParams` | Record |   | | `transport` | [Transport](./Transport.md) |   | -### Methods +## Methods [class-methods-Transform] | Name | Signature | Description | | - | - | - | diff --git a/docs/reference/api/TransformContainer.md b/docs/reference/api/TransformContainer.md index f8970fcaf..9c7d234ba 100644 --- a/docs/reference/api/TransformContainer.md +++ b/docs/reference/api/TransformContainer.md @@ -1,4 +1,4 @@ -## Interface `TransformContainer` +# `TransformContainer` [interface-TransformContainer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/TransformDeleteTransformRequest.md b/docs/reference/api/TransformDeleteTransformRequest.md index 4120cbd79..52fc1362e 100644 --- a/docs/reference/api/TransformDeleteTransformRequest.md +++ b/docs/reference/api/TransformDeleteTransformRequest.md @@ -1,4 +1,4 @@ -## Interface `TransformDeleteTransformRequest` +# `TransformDeleteTransformRequest` [interface-TransformDeleteTransformRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/TransformDeleteTransformResponse.md b/docs/reference/api/TransformDeleteTransformResponse.md index a5ade904a..e3a23a80b 100644 --- a/docs/reference/api/TransformDeleteTransformResponse.md +++ b/docs/reference/api/TransformDeleteTransformResponse.md @@ -1,4 +1,4 @@ -## `TransformDeleteTransformResponse` -::: +# `TransformDeleteTransformResponse` [alias-TransformDeleteTransformResponse] +```typescript type TransformDeleteTransformResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); -::: +``` diff --git a/docs/reference/api/TransformDestination.md b/docs/reference/api/TransformDestination.md index 6532bf50d..336209b2c 100644 --- a/docs/reference/api/TransformDestination.md +++ b/docs/reference/api/TransformDestination.md @@ -1,4 +1,4 @@ -## Interface `TransformDestination` +# `TransformDestination` [interface-TransformDestination] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/TransformGetTransformRequest.md b/docs/reference/api/TransformGetTransformRequest.md index 2425da1c8..12f09c74a 100644 --- a/docs/reference/api/TransformGetTransformRequest.md +++ b/docs/reference/api/TransformGetTransformRequest.md @@ -1,4 +1,4 @@ -## Interface `TransformGetTransformRequest` +# `TransformGetTransformRequest` [interface-TransformGetTransformRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/TransformGetTransformResponse.md b/docs/reference/api/TransformGetTransformResponse.md index 37cb73852..8f47e1441 100644 --- a/docs/reference/api/TransformGetTransformResponse.md +++ b/docs/reference/api/TransformGetTransformResponse.md @@ -1,4 +1,4 @@ -## Interface `TransformGetTransformResponse` +# `TransformGetTransformResponse` [interface-TransformGetTransformResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/TransformGetTransformStatsCheckpointStats.md b/docs/reference/api/TransformGetTransformStatsCheckpointStats.md index 3c1ba38b6..ac8cd4419 100644 --- a/docs/reference/api/TransformGetTransformStatsCheckpointStats.md +++ b/docs/reference/api/TransformGetTransformStatsCheckpointStats.md @@ -1,4 +1,4 @@ -## Interface `TransformGetTransformStatsCheckpointStats` +# `TransformGetTransformStatsCheckpointStats` [interface-TransformGetTransformStatsCheckpointStats] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/TransformGetTransformStatsCheckpointing.md b/docs/reference/api/TransformGetTransformStatsCheckpointing.md index 4edacd5ca..c0679b73f 100644 --- a/docs/reference/api/TransformGetTransformStatsCheckpointing.md +++ b/docs/reference/api/TransformGetTransformStatsCheckpointing.md @@ -1,4 +1,4 @@ -## Interface `TransformGetTransformStatsCheckpointing` +# `TransformGetTransformStatsCheckpointing` [interface-TransformGetTransformStatsCheckpointing] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/TransformGetTransformStatsRequest.md b/docs/reference/api/TransformGetTransformStatsRequest.md index 88f0d5734..c40a98e39 100644 --- a/docs/reference/api/TransformGetTransformStatsRequest.md +++ b/docs/reference/api/TransformGetTransformStatsRequest.md @@ -1,4 +1,4 @@ -## Interface `TransformGetTransformStatsRequest` +# `TransformGetTransformStatsRequest` [interface-TransformGetTransformStatsRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/TransformGetTransformStatsResponse.md b/docs/reference/api/TransformGetTransformStatsResponse.md index f7e318ad7..5f231d117 100644 --- a/docs/reference/api/TransformGetTransformStatsResponse.md +++ b/docs/reference/api/TransformGetTransformStatsResponse.md @@ -1,4 +1,4 @@ -## Interface `TransformGetTransformStatsResponse` +# `TransformGetTransformStatsResponse` [interface-TransformGetTransformStatsResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/TransformGetTransformStatsTransformHealthIssue.md b/docs/reference/api/TransformGetTransformStatsTransformHealthIssue.md index 6aa20b441..0227537f7 100644 --- a/docs/reference/api/TransformGetTransformStatsTransformHealthIssue.md +++ b/docs/reference/api/TransformGetTransformStatsTransformHealthIssue.md @@ -1,4 +1,4 @@ -## Interface `TransformGetTransformStatsTransformHealthIssue` +# `TransformGetTransformStatsTransformHealthIssue` [interface-TransformGetTransformStatsTransformHealthIssue] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/TransformGetTransformStatsTransformIndexerStats.md b/docs/reference/api/TransformGetTransformStatsTransformIndexerStats.md index 5dbe037ce..4d4169e33 100644 --- a/docs/reference/api/TransformGetTransformStatsTransformIndexerStats.md +++ b/docs/reference/api/TransformGetTransformStatsTransformIndexerStats.md @@ -1,4 +1,4 @@ -## Interface `TransformGetTransformStatsTransformIndexerStats` +# `TransformGetTransformStatsTransformIndexerStats` [interface-TransformGetTransformStatsTransformIndexerStats] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/TransformGetTransformStatsTransformProgress.md b/docs/reference/api/TransformGetTransformStatsTransformProgress.md index a2dbb635a..1ebffb3be 100644 --- a/docs/reference/api/TransformGetTransformStatsTransformProgress.md +++ b/docs/reference/api/TransformGetTransformStatsTransformProgress.md @@ -1,4 +1,4 @@ -## Interface `TransformGetTransformStatsTransformProgress` +# `TransformGetTransformStatsTransformProgress` [interface-TransformGetTransformStatsTransformProgress] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/TransformGetTransformStatsTransformStats.md b/docs/reference/api/TransformGetTransformStatsTransformStats.md index 6ce74560d..05a35f5f2 100644 --- a/docs/reference/api/TransformGetTransformStatsTransformStats.md +++ b/docs/reference/api/TransformGetTransformStatsTransformStats.md @@ -1,4 +1,4 @@ -## Interface `TransformGetTransformStatsTransformStats` +# `TransformGetTransformStatsTransformStats` [interface-TransformGetTransformStatsTransformStats] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/TransformGetTransformStatsTransformStatsHealth.md b/docs/reference/api/TransformGetTransformStatsTransformStatsHealth.md index c2611ac7b..2f359d19c 100644 --- a/docs/reference/api/TransformGetTransformStatsTransformStatsHealth.md +++ b/docs/reference/api/TransformGetTransformStatsTransformStatsHealth.md @@ -1,4 +1,4 @@ -## Interface `TransformGetTransformStatsTransformStatsHealth` +# `TransformGetTransformStatsTransformStatsHealth` [interface-TransformGetTransformStatsTransformStatsHealth] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/TransformGetTransformTransformSummary.md b/docs/reference/api/TransformGetTransformTransformSummary.md index c332aedb3..fe617ffca 100644 --- a/docs/reference/api/TransformGetTransformTransformSummary.md +++ b/docs/reference/api/TransformGetTransformTransformSummary.md @@ -1,4 +1,4 @@ -## Interface `TransformGetTransformTransformSummary` +# `TransformGetTransformTransformSummary` [interface-TransformGetTransformTransformSummary] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/TransformLatest.md b/docs/reference/api/TransformLatest.md index 5ec8b3161..284beb9aa 100644 --- a/docs/reference/api/TransformLatest.md +++ b/docs/reference/api/TransformLatest.md @@ -1,4 +1,4 @@ -## Interface `TransformLatest` +# `TransformLatest` [interface-TransformLatest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/TransformPivot.md b/docs/reference/api/TransformPivot.md index 33dab0556..e2942ab3f 100644 --- a/docs/reference/api/TransformPivot.md +++ b/docs/reference/api/TransformPivot.md @@ -1,4 +1,4 @@ -## Interface `TransformPivot` +# `TransformPivot` [interface-TransformPivot] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/TransformPivotGroupByContainer.md b/docs/reference/api/TransformPivotGroupByContainer.md index c024ef7f9..7000c0ad8 100644 --- a/docs/reference/api/TransformPivotGroupByContainer.md +++ b/docs/reference/api/TransformPivotGroupByContainer.md @@ -1,4 +1,4 @@ -## Interface `TransformPivotGroupByContainer` +# `TransformPivotGroupByContainer` [interface-TransformPivotGroupByContainer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/TransformPreviewTransformRequest.md b/docs/reference/api/TransformPreviewTransformRequest.md index f58b631ab..ee51a0697 100644 --- a/docs/reference/api/TransformPreviewTransformRequest.md +++ b/docs/reference/api/TransformPreviewTransformRequest.md @@ -1,4 +1,4 @@ -## Interface `TransformPreviewTransformRequest` +# `TransformPreviewTransformRequest` [interface-TransformPreviewTransformRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/TransformPreviewTransformResponse.md b/docs/reference/api/TransformPreviewTransformResponse.md index 1cb248717..17e6fc202 100644 --- a/docs/reference/api/TransformPreviewTransformResponse.md +++ b/docs/reference/api/TransformPreviewTransformResponse.md @@ -1,4 +1,4 @@ -## Interface `TransformPreviewTransformResponse` +# `TransformPreviewTransformResponse` [interface-TransformPreviewTransformResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/TransformPutTransformRequest.md b/docs/reference/api/TransformPutTransformRequest.md index 84900d08a..f85471209 100644 --- a/docs/reference/api/TransformPutTransformRequest.md +++ b/docs/reference/api/TransformPutTransformRequest.md @@ -1,4 +1,4 @@ -## Interface `TransformPutTransformRequest` +# `TransformPutTransformRequest` [interface-TransformPutTransformRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/TransformPutTransformResponse.md b/docs/reference/api/TransformPutTransformResponse.md index ec5ebfa9b..9c5c067fa 100644 --- a/docs/reference/api/TransformPutTransformResponse.md +++ b/docs/reference/api/TransformPutTransformResponse.md @@ -1,4 +1,4 @@ -## `TransformPutTransformResponse` -::: +# `TransformPutTransformResponse` [alias-TransformPutTransformResponse] +```typescript type TransformPutTransformResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); -::: +``` diff --git a/docs/reference/api/TransformResetTransformRequest.md b/docs/reference/api/TransformResetTransformRequest.md index 3d7e39dd2..e78927407 100644 --- a/docs/reference/api/TransformResetTransformRequest.md +++ b/docs/reference/api/TransformResetTransformRequest.md @@ -1,4 +1,4 @@ -## Interface `TransformResetTransformRequest` +# `TransformResetTransformRequest` [interface-TransformResetTransformRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/TransformResetTransformResponse.md b/docs/reference/api/TransformResetTransformResponse.md index 6a5ad3999..2576a5c33 100644 --- a/docs/reference/api/TransformResetTransformResponse.md +++ b/docs/reference/api/TransformResetTransformResponse.md @@ -1,4 +1,4 @@ -## `TransformResetTransformResponse` -::: +# `TransformResetTransformResponse` [alias-TransformResetTransformResponse] +```typescript type TransformResetTransformResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); -::: +``` diff --git a/docs/reference/api/TransformRetentionPolicy.md b/docs/reference/api/TransformRetentionPolicy.md index f139af179..ea933c8c6 100644 --- a/docs/reference/api/TransformRetentionPolicy.md +++ b/docs/reference/api/TransformRetentionPolicy.md @@ -1,4 +1,4 @@ -## Interface `TransformRetentionPolicy` +# `TransformRetentionPolicy` [interface-TransformRetentionPolicy] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/TransformRetentionPolicyContainer.md b/docs/reference/api/TransformRetentionPolicyContainer.md index 38862720a..0e3e6bee9 100644 --- a/docs/reference/api/TransformRetentionPolicyContainer.md +++ b/docs/reference/api/TransformRetentionPolicyContainer.md @@ -1,4 +1,4 @@ -## Interface `TransformRetentionPolicyContainer` +# `TransformRetentionPolicyContainer` [interface-TransformRetentionPolicyContainer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/TransformScheduleNowTransformRequest.md b/docs/reference/api/TransformScheduleNowTransformRequest.md index d487f1ea2..b877ad8d0 100644 --- a/docs/reference/api/TransformScheduleNowTransformRequest.md +++ b/docs/reference/api/TransformScheduleNowTransformRequest.md @@ -1,4 +1,4 @@ -## Interface `TransformScheduleNowTransformRequest` +# `TransformScheduleNowTransformRequest` [interface-TransformScheduleNowTransformRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/TransformScheduleNowTransformResponse.md b/docs/reference/api/TransformScheduleNowTransformResponse.md index 5b725397b..5484cdb9c 100644 --- a/docs/reference/api/TransformScheduleNowTransformResponse.md +++ b/docs/reference/api/TransformScheduleNowTransformResponse.md @@ -1,4 +1,4 @@ -## `TransformScheduleNowTransformResponse` -::: +# `TransformScheduleNowTransformResponse` [alias-TransformScheduleNowTransformResponse] +```typescript type TransformScheduleNowTransformResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); -::: +``` diff --git a/docs/reference/api/TransformSettings.md b/docs/reference/api/TransformSettings.md index 6d0afcfb6..1eb0ec7a0 100644 --- a/docs/reference/api/TransformSettings.md +++ b/docs/reference/api/TransformSettings.md @@ -1,4 +1,4 @@ -## Interface `TransformSettings` +# `TransformSettings` [interface-TransformSettings] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/TransformSource.md b/docs/reference/api/TransformSource.md index 0a8d5a345..eed669e91 100644 --- a/docs/reference/api/TransformSource.md +++ b/docs/reference/api/TransformSource.md @@ -1,4 +1,4 @@ -## Interface `TransformSource` +# `TransformSource` [interface-TransformSource] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/TransformStartTransformRequest.md b/docs/reference/api/TransformStartTransformRequest.md index 6d7e77739..ad7ba6bef 100644 --- a/docs/reference/api/TransformStartTransformRequest.md +++ b/docs/reference/api/TransformStartTransformRequest.md @@ -1,4 +1,4 @@ -## Interface `TransformStartTransformRequest` +# `TransformStartTransformRequest` [interface-TransformStartTransformRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/TransformStartTransformResponse.md b/docs/reference/api/TransformStartTransformResponse.md index fe4d88296..68c8cc973 100644 --- a/docs/reference/api/TransformStartTransformResponse.md +++ b/docs/reference/api/TransformStartTransformResponse.md @@ -1,4 +1,4 @@ -## `TransformStartTransformResponse` -::: +# `TransformStartTransformResponse` [alias-TransformStartTransformResponse] +```typescript type TransformStartTransformResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); -::: +``` diff --git a/docs/reference/api/TransformStopTransformRequest.md b/docs/reference/api/TransformStopTransformRequest.md index cae445718..473c87e26 100644 --- a/docs/reference/api/TransformStopTransformRequest.md +++ b/docs/reference/api/TransformStopTransformRequest.md @@ -1,4 +1,4 @@ -## Interface `TransformStopTransformRequest` +# `TransformStopTransformRequest` [interface-TransformStopTransformRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/TransformStopTransformResponse.md b/docs/reference/api/TransformStopTransformResponse.md index 45134e905..e908c4552 100644 --- a/docs/reference/api/TransformStopTransformResponse.md +++ b/docs/reference/api/TransformStopTransformResponse.md @@ -1,4 +1,4 @@ -## `TransformStopTransformResponse` -::: +# `TransformStopTransformResponse` [alias-TransformStopTransformResponse] +```typescript type TransformStopTransformResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); -::: +``` diff --git a/docs/reference/api/TransformSyncContainer.md b/docs/reference/api/TransformSyncContainer.md index a9331c94d..dbde67279 100644 --- a/docs/reference/api/TransformSyncContainer.md +++ b/docs/reference/api/TransformSyncContainer.md @@ -1,4 +1,4 @@ -## Interface `TransformSyncContainer` +# `TransformSyncContainer` [interface-TransformSyncContainer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/TransformTimeSync.md b/docs/reference/api/TransformTimeSync.md index 14dbaf55a..61e374fdc 100644 --- a/docs/reference/api/TransformTimeSync.md +++ b/docs/reference/api/TransformTimeSync.md @@ -1,4 +1,4 @@ -## Interface `TransformTimeSync` +# `TransformTimeSync` [interface-TransformTimeSync] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/TransformUpdateTransformRequest.md b/docs/reference/api/TransformUpdateTransformRequest.md index 6e4ab3b3e..9da571b92 100644 --- a/docs/reference/api/TransformUpdateTransformRequest.md +++ b/docs/reference/api/TransformUpdateTransformRequest.md @@ -1,4 +1,4 @@ -## Interface `TransformUpdateTransformRequest` +# `TransformUpdateTransformRequest` [interface-TransformUpdateTransformRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/TransformUpdateTransformResponse.md b/docs/reference/api/TransformUpdateTransformResponse.md index 4bd7a3546..ce6dc2d5f 100644 --- a/docs/reference/api/TransformUpdateTransformResponse.md +++ b/docs/reference/api/TransformUpdateTransformResponse.md @@ -1,4 +1,4 @@ -## Interface `TransformUpdateTransformResponse` +# `TransformUpdateTransformResponse` [interface-TransformUpdateTransformResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/TransformUpgradeTransformsRequest.md b/docs/reference/api/TransformUpgradeTransformsRequest.md index 33c0bc6c2..afa29de34 100644 --- a/docs/reference/api/TransformUpgradeTransformsRequest.md +++ b/docs/reference/api/TransformUpgradeTransformsRequest.md @@ -1,4 +1,4 @@ -## Interface `TransformUpgradeTransformsRequest` +# `TransformUpgradeTransformsRequest` [interface-TransformUpgradeTransformsRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/TransformUpgradeTransformsResponse.md b/docs/reference/api/TransformUpgradeTransformsResponse.md index 5645a93f5..ba15983e1 100644 --- a/docs/reference/api/TransformUpgradeTransformsResponse.md +++ b/docs/reference/api/TransformUpgradeTransformsResponse.md @@ -1,4 +1,4 @@ -## Interface `TransformUpgradeTransformsResponse` +# `TransformUpgradeTransformsResponse` [interface-TransformUpgradeTransformsResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/TranslogStats.md b/docs/reference/api/TranslogStats.md index 51e9d51fd..69a4b7ff1 100644 --- a/docs/reference/api/TranslogStats.md +++ b/docs/reference/api/TranslogStats.md @@ -1,4 +1,4 @@ -## Interface `TranslogStats` +# `TranslogStats` [interface-TranslogStats] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/TransportAddress.md b/docs/reference/api/TransportAddress.md index f1fed2cbe..90a36df7a 100644 --- a/docs/reference/api/TransportAddress.md +++ b/docs/reference/api/TransportAddress.md @@ -1,4 +1,4 @@ -## `TransportAddress` -::: +# `TransportAddress` [alias-TransportAddress] +```typescript type TransportAddress = string; -::: +``` diff --git a/docs/reference/api/UnitFloatMillis.md b/docs/reference/api/UnitFloatMillis.md index 6d201c052..7cfa5b4b7 100644 --- a/docs/reference/api/UnitFloatMillis.md +++ b/docs/reference/api/UnitFloatMillis.md @@ -1,4 +1,4 @@ -## `UnitFloatMillis` -::: +# `UnitFloatMillis` [alias-UnitFloatMillis] +```typescript type UnitFloatMillis = [double](./double.md); -::: +``` diff --git a/docs/reference/api/UnitMillis.md b/docs/reference/api/UnitMillis.md index 0c39defbb..973c00932 100644 --- a/docs/reference/api/UnitMillis.md +++ b/docs/reference/api/UnitMillis.md @@ -1,4 +1,4 @@ -## `UnitMillis` -::: +# `UnitMillis` [alias-UnitMillis] +```typescript type UnitMillis = [long](./long.md); -::: +``` diff --git a/docs/reference/api/UnitNanos.md b/docs/reference/api/UnitNanos.md index e04193059..f93a20bd3 100644 --- a/docs/reference/api/UnitNanos.md +++ b/docs/reference/api/UnitNanos.md @@ -1,4 +1,4 @@ -## `UnitNanos` -::: +# `UnitNanos` [alias-UnitNanos] +```typescript type UnitNanos = [long](./long.md); -::: +``` diff --git a/docs/reference/api/UnitSeconds.md b/docs/reference/api/UnitSeconds.md index 5ddddf824..47959f927 100644 --- a/docs/reference/api/UnitSeconds.md +++ b/docs/reference/api/UnitSeconds.md @@ -1,4 +1,4 @@ -## `UnitSeconds` -::: +# `UnitSeconds` [alias-UnitSeconds] +```typescript type UnitSeconds = [long](./long.md); -::: +``` diff --git a/docs/reference/api/UpdateAction.md b/docs/reference/api/UpdateAction.md index 4f2d98631..0859f0a60 100644 --- a/docs/reference/api/UpdateAction.md +++ b/docs/reference/api/UpdateAction.md @@ -1,4 +1,4 @@ -## `UpdateAction` -::: +# `UpdateAction` [alias-UpdateAction] +```typescript type UpdateAction = [[UpdateActionOperation](./UpdateActionOperation.md), [BulkUpdateAction](./BulkUpdateAction.md)]; -::: +``` diff --git a/docs/reference/api/UpdateActionOperation.md b/docs/reference/api/UpdateActionOperation.md index f259b547f..bab5a46da 100644 --- a/docs/reference/api/UpdateActionOperation.md +++ b/docs/reference/api/UpdateActionOperation.md @@ -1,4 +1,4 @@ -## Interface `UpdateActionOperation` +# `UpdateActionOperation` [interface-UpdateActionOperation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/UpdateApi_1.md b/docs/reference/api/UpdateApi_1.md index f85328aff..2966317fe 100644 --- a/docs/reference/api/UpdateApi_1.md +++ b/docs/reference/api/UpdateApi_1.md @@ -1,3 +1,3 @@ -::: +```typescript default function UpdateApi(this: [That](./That.md), params: [UpdateRequest](./UpdateRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[UpdateResponse](./UpdateResponse.md)>; -::: +``` diff --git a/docs/reference/api/UpdateApi_2.md b/docs/reference/api/UpdateApi_2.md index 4070bc67c..8745eb5a3 100644 --- a/docs/reference/api/UpdateApi_2.md +++ b/docs/reference/api/UpdateApi_2.md @@ -1,3 +1,3 @@ -::: +```typescript default function UpdateApi(this: [That](./That.md), params: [UpdateRequest](./UpdateRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[UpdateResponse](./UpdateResponse.md), unknown>>; -::: +``` diff --git a/docs/reference/api/UpdateApi_3.md b/docs/reference/api/UpdateApi_3.md index c953d5e05..a9d2246cb 100644 --- a/docs/reference/api/UpdateApi_3.md +++ b/docs/reference/api/UpdateApi_3.md @@ -1,3 +1,3 @@ -::: +```typescript default function UpdateApi(this: [That](./That.md), params: [UpdateRequest](./UpdateRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[UpdateResponse](./UpdateResponse.md)>; -::: +``` diff --git a/docs/reference/api/UpdateByQueryApi_1.md b/docs/reference/api/UpdateByQueryApi_1.md index c48fac709..174719127 100644 --- a/docs/reference/api/UpdateByQueryApi_1.md +++ b/docs/reference/api/UpdateByQueryApi_1.md @@ -1,3 +1,3 @@ -::: +```typescript default function UpdateByQueryApi(this: [That](./That.md), params: [UpdateByQueryRequest](./UpdateByQueryRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[UpdateByQueryResponse](./UpdateByQueryResponse.md)>; -::: +``` diff --git a/docs/reference/api/UpdateByQueryApi_2.md b/docs/reference/api/UpdateByQueryApi_2.md index 39668353e..f156db751 100644 --- a/docs/reference/api/UpdateByQueryApi_2.md +++ b/docs/reference/api/UpdateByQueryApi_2.md @@ -1,3 +1,3 @@ -::: +```typescript default function UpdateByQueryApi(this: [That](./That.md), params: [UpdateByQueryRequest](./UpdateByQueryRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[UpdateByQueryResponse](./UpdateByQueryResponse.md), unknown>>; -::: +``` diff --git a/docs/reference/api/UpdateByQueryApi_3.md b/docs/reference/api/UpdateByQueryApi_3.md index b88bdfccb..6d5dc452f 100644 --- a/docs/reference/api/UpdateByQueryApi_3.md +++ b/docs/reference/api/UpdateByQueryApi_3.md @@ -1,3 +1,3 @@ -::: +```typescript default function UpdateByQueryApi(this: [That](./That.md), params: [UpdateByQueryRequest](./UpdateByQueryRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[UpdateByQueryResponse](./UpdateByQueryResponse.md)>; -::: +``` diff --git a/docs/reference/api/UpdateByQueryRequest.md b/docs/reference/api/UpdateByQueryRequest.md index 7858a41db..1e2ca9eb2 100644 --- a/docs/reference/api/UpdateByQueryRequest.md +++ b/docs/reference/api/UpdateByQueryRequest.md @@ -1,4 +1,4 @@ -## Interface `UpdateByQueryRequest` +# `UpdateByQueryRequest` [interface-UpdateByQueryRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/UpdateByQueryResponse.md b/docs/reference/api/UpdateByQueryResponse.md index 9b3292ee9..d55135ef7 100644 --- a/docs/reference/api/UpdateByQueryResponse.md +++ b/docs/reference/api/UpdateByQueryResponse.md @@ -1,4 +1,4 @@ -## Interface `UpdateByQueryResponse` +# `UpdateByQueryResponse` [interface-UpdateByQueryResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/UpdateByQueryRethrottleApi_1.md b/docs/reference/api/UpdateByQueryRethrottleApi_1.md index c4912c7f6..4d46ddec9 100644 --- a/docs/reference/api/UpdateByQueryRethrottleApi_1.md +++ b/docs/reference/api/UpdateByQueryRethrottleApi_1.md @@ -1,3 +1,3 @@ -::: +```typescript default function UpdateByQueryRethrottleApi(this: [That](./That.md), params: [UpdateByQueryRethrottleRequest](./UpdateByQueryRethrottleRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[UpdateByQueryRethrottleResponse](./UpdateByQueryRethrottleResponse.md)>; -::: +``` diff --git a/docs/reference/api/UpdateByQueryRethrottleApi_2.md b/docs/reference/api/UpdateByQueryRethrottleApi_2.md index f728c8179..d701097b8 100644 --- a/docs/reference/api/UpdateByQueryRethrottleApi_2.md +++ b/docs/reference/api/UpdateByQueryRethrottleApi_2.md @@ -1,3 +1,3 @@ -::: +```typescript default function UpdateByQueryRethrottleApi(this: [That](./That.md), params: [UpdateByQueryRethrottleRequest](./UpdateByQueryRethrottleRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[UpdateByQueryRethrottleResponse](./UpdateByQueryRethrottleResponse.md), unknown>>; -::: +``` diff --git a/docs/reference/api/UpdateByQueryRethrottleApi_3.md b/docs/reference/api/UpdateByQueryRethrottleApi_3.md index 5ff1b9c49..50daf0d2f 100644 --- a/docs/reference/api/UpdateByQueryRethrottleApi_3.md +++ b/docs/reference/api/UpdateByQueryRethrottleApi_3.md @@ -1,3 +1,3 @@ -::: +```typescript default function UpdateByQueryRethrottleApi(this: [That](./That.md), params: [UpdateByQueryRethrottleRequest](./UpdateByQueryRethrottleRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[UpdateByQueryRethrottleResponse](./UpdateByQueryRethrottleResponse.md)>; -::: +``` diff --git a/docs/reference/api/UpdateByQueryRethrottleRequest.md b/docs/reference/api/UpdateByQueryRethrottleRequest.md index 7b5671bc8..d2ddb6496 100644 --- a/docs/reference/api/UpdateByQueryRethrottleRequest.md +++ b/docs/reference/api/UpdateByQueryRethrottleRequest.md @@ -1,4 +1,4 @@ -## Interface `UpdateByQueryRethrottleRequest` +# `UpdateByQueryRethrottleRequest` [interface-UpdateByQueryRethrottleRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/UpdateByQueryRethrottleResponse.md b/docs/reference/api/UpdateByQueryRethrottleResponse.md index 9412df9a2..34dc9f5c0 100644 --- a/docs/reference/api/UpdateByQueryRethrottleResponse.md +++ b/docs/reference/api/UpdateByQueryRethrottleResponse.md @@ -1,4 +1,4 @@ -## Interface `UpdateByQueryRethrottleResponse` +# `UpdateByQueryRethrottleResponse` [interface-UpdateByQueryRethrottleResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/UpdateByQueryRethrottleUpdateByQueryRethrottleNode.md b/docs/reference/api/UpdateByQueryRethrottleUpdateByQueryRethrottleNode.md index 3b054f0d6..94a31ecf4 100644 --- a/docs/reference/api/UpdateByQueryRethrottleUpdateByQueryRethrottleNode.md +++ b/docs/reference/api/UpdateByQueryRethrottleUpdateByQueryRethrottleNode.md @@ -1,4 +1,4 @@ -## Interface `UpdateByQueryRethrottleUpdateByQueryRethrottleNode` +# `UpdateByQueryRethrottleUpdateByQueryRethrottleNode` [interface-UpdateByQueryRethrottleUpdateByQueryRethrottleNode] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/UpdateRequest.md b/docs/reference/api/UpdateRequest.md index 2ddcb4440..26f4ac52e 100644 --- a/docs/reference/api/UpdateRequest.md +++ b/docs/reference/api/UpdateRequest.md @@ -1,4 +1,4 @@ -## Interface `UpdateRequest` +# `UpdateRequest` [interface-UpdateRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/UpdateResponse.md b/docs/reference/api/UpdateResponse.md index 27cbdc1f3..1bc931575 100644 --- a/docs/reference/api/UpdateResponse.md +++ b/docs/reference/api/UpdateResponse.md @@ -1,4 +1,4 @@ -## `UpdateResponse` -::: +# `UpdateResponse` [alias-UpdateResponse] +```typescript type UpdateResponse = [UpdateUpdateWriteResponseBase](./UpdateUpdateWriteResponseBase.md); -::: +``` diff --git a/docs/reference/api/UpdateUpdateWriteResponseBase.md b/docs/reference/api/UpdateUpdateWriteResponseBase.md index 1a1145a40..26ff1a7bc 100644 --- a/docs/reference/api/UpdateUpdateWriteResponseBase.md +++ b/docs/reference/api/UpdateUpdateWriteResponseBase.md @@ -1,4 +1,4 @@ -## Interface `UpdateUpdateWriteResponseBase` +# `UpdateUpdateWriteResponseBase` [interface-UpdateUpdateWriteResponseBase] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/Username.md b/docs/reference/api/Username.md index ca607e195..7f543b2c0 100644 --- a/docs/reference/api/Username.md +++ b/docs/reference/api/Username.md @@ -1,4 +1,4 @@ -## `Username` -::: +# `Username` [alias-Username] +```typescript type Username = string; -::: +``` diff --git a/docs/reference/api/Uuid.md b/docs/reference/api/Uuid.md index 527e5f8d7..62e12e8fb 100644 --- a/docs/reference/api/Uuid.md +++ b/docs/reference/api/Uuid.md @@ -1,4 +1,4 @@ -## `Uuid` -::: +# `Uuid` [alias-Uuid] +```typescript type Uuid = string; -::: +``` diff --git a/docs/reference/api/VersionNumber.md b/docs/reference/api/VersionNumber.md index d097abce9..42d209590 100644 --- a/docs/reference/api/VersionNumber.md +++ b/docs/reference/api/VersionNumber.md @@ -1,4 +1,4 @@ -## `VersionNumber` -::: +# `VersionNumber` [alias-VersionNumber] +```typescript type VersionNumber = [long](./long.md); -::: +``` diff --git a/docs/reference/api/VersionString.md b/docs/reference/api/VersionString.md index e3b249178..1e44d57af 100644 --- a/docs/reference/api/VersionString.md +++ b/docs/reference/api/VersionString.md @@ -1,4 +1,4 @@ -## `VersionString` -::: +# `VersionString` [alias-VersionString] +```typescript type VersionString = string; -::: +``` diff --git a/docs/reference/api/VersionType.md b/docs/reference/api/VersionType.md index b0ff5079d..08d27e83c 100644 --- a/docs/reference/api/VersionType.md +++ b/docs/reference/api/VersionType.md @@ -1,4 +1,4 @@ -## `VersionType` -::: +# `VersionType` [alias-VersionType] +```typescript type VersionType = 'internal' | 'external' | 'external_gte' | 'force'; -::: +``` diff --git a/docs/reference/api/WaitForActiveShardOptions.md b/docs/reference/api/WaitForActiveShardOptions.md index 48171d46c..9c248fd9e 100644 --- a/docs/reference/api/WaitForActiveShardOptions.md +++ b/docs/reference/api/WaitForActiveShardOptions.md @@ -1,4 +1,4 @@ -## `WaitForActiveShardOptions` -::: +# `WaitForActiveShardOptions` [alias-WaitForActiveShardOptions] +```typescript type WaitForActiveShardOptions = 'all' | 'index-setting'; -::: +``` diff --git a/docs/reference/api/WaitForActiveShards.md b/docs/reference/api/WaitForActiveShards.md index 595d4386d..6d0e210fd 100644 --- a/docs/reference/api/WaitForActiveShards.md +++ b/docs/reference/api/WaitForActiveShards.md @@ -1,4 +1,4 @@ -## `WaitForActiveShards` -::: +# `WaitForActiveShards` [alias-WaitForActiveShards] +```typescript type WaitForActiveShards = [integer](./integer.md) | [WaitForActiveShardOptions](./WaitForActiveShardOptions.md); -::: +``` diff --git a/docs/reference/api/WaitForEvents.md b/docs/reference/api/WaitForEvents.md index 2fb753c33..4ce040308 100644 --- a/docs/reference/api/WaitForEvents.md +++ b/docs/reference/api/WaitForEvents.md @@ -1,4 +1,4 @@ -## `WaitForEvents` -::: +# `WaitForEvents` [alias-WaitForEvents] +```typescript type WaitForEvents = 'immediate' | 'urgent' | 'high' | 'normal' | 'low' | 'languid'; -::: +``` diff --git a/docs/reference/api/WarmerStats.md b/docs/reference/api/WarmerStats.md index 9111f80ac..1ce88b87d 100644 --- a/docs/reference/api/WarmerStats.md +++ b/docs/reference/api/WarmerStats.md @@ -1,4 +1,4 @@ -## Interface `WarmerStats` +# `WarmerStats` [interface-WarmerStats] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/Watcher.md b/docs/reference/api/Watcher.md index 4258ac34e..0af0918b4 100644 --- a/docs/reference/api/Watcher.md +++ b/docs/reference/api/Watcher.md @@ -1,19 +1,19 @@ -## `Watcher` +# `Watcher` [class-Watcher] -### Constructor +## Constructor -::: +```typescript new Watcher(transport: [Transport](./Transport.md)); -::: +``` -### Properties +## Properties [class-properties-Watcher] | Name | Type | Description | | - | - | - | | `acceptedParams` | Record |   | | `transport` | [Transport](./Transport.md) |   | -### Methods +## Methods [class-methods-Watcher] | Name | Signature | Description | | - | - | - | diff --git a/docs/reference/api/WatcherAckWatchRequest.md b/docs/reference/api/WatcherAckWatchRequest.md index 7982abcea..d13c1e51f 100644 --- a/docs/reference/api/WatcherAckWatchRequest.md +++ b/docs/reference/api/WatcherAckWatchRequest.md @@ -1,4 +1,4 @@ -## Interface `WatcherAckWatchRequest` +# `WatcherAckWatchRequest` [interface-WatcherAckWatchRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherAckWatchResponse.md b/docs/reference/api/WatcherAckWatchResponse.md index 0b191d149..7c3129e31 100644 --- a/docs/reference/api/WatcherAckWatchResponse.md +++ b/docs/reference/api/WatcherAckWatchResponse.md @@ -1,4 +1,4 @@ -## Interface `WatcherAckWatchResponse` +# `WatcherAckWatchResponse` [interface-WatcherAckWatchResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherAcknowledgeState.md b/docs/reference/api/WatcherAcknowledgeState.md index 59e289152..4b50a45de 100644 --- a/docs/reference/api/WatcherAcknowledgeState.md +++ b/docs/reference/api/WatcherAcknowledgeState.md @@ -1,4 +1,4 @@ -## Interface `WatcherAcknowledgeState` +# `WatcherAcknowledgeState` [interface-WatcherAcknowledgeState] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherAcknowledgementOptions.md b/docs/reference/api/WatcherAcknowledgementOptions.md index 544627af8..44963ff75 100644 --- a/docs/reference/api/WatcherAcknowledgementOptions.md +++ b/docs/reference/api/WatcherAcknowledgementOptions.md @@ -1,4 +1,4 @@ -## `WatcherAcknowledgementOptions` -::: +# `WatcherAcknowledgementOptions` [alias-WatcherAcknowledgementOptions] +```typescript type WatcherAcknowledgementOptions = 'awaits_successful_execution' | 'ackable' | 'acked'; -::: +``` diff --git a/docs/reference/api/WatcherAction.md b/docs/reference/api/WatcherAction.md index 46dce2148..aa7d9724c 100644 --- a/docs/reference/api/WatcherAction.md +++ b/docs/reference/api/WatcherAction.md @@ -1,4 +1,4 @@ -## Interface `WatcherAction` +# `WatcherAction` [interface-WatcherAction] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherActionExecutionMode.md b/docs/reference/api/WatcherActionExecutionMode.md index 6a6d9422e..a0d7792f8 100644 --- a/docs/reference/api/WatcherActionExecutionMode.md +++ b/docs/reference/api/WatcherActionExecutionMode.md @@ -1,4 +1,4 @@ -## `WatcherActionExecutionMode` -::: +# `WatcherActionExecutionMode` [alias-WatcherActionExecutionMode] +```typescript type WatcherActionExecutionMode = 'simulate' | 'force_simulate' | 'execute' | 'force_execute' | 'skip'; -::: +``` diff --git a/docs/reference/api/WatcherActionStatus.md b/docs/reference/api/WatcherActionStatus.md index b02ac21e9..61b10d8ca 100644 --- a/docs/reference/api/WatcherActionStatus.md +++ b/docs/reference/api/WatcherActionStatus.md @@ -1,4 +1,4 @@ -## Interface `WatcherActionStatus` +# `WatcherActionStatus` [interface-WatcherActionStatus] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherActionStatusOptions.md b/docs/reference/api/WatcherActionStatusOptions.md index af5fbc36b..1134df3b2 100644 --- a/docs/reference/api/WatcherActionStatusOptions.md +++ b/docs/reference/api/WatcherActionStatusOptions.md @@ -1,4 +1,4 @@ -## `WatcherActionStatusOptions` -::: +# `WatcherActionStatusOptions` [alias-WatcherActionStatusOptions] +```typescript type WatcherActionStatusOptions = 'success' | 'failure' | 'simulated' | 'throttled'; -::: +``` diff --git a/docs/reference/api/WatcherActionType.md b/docs/reference/api/WatcherActionType.md index 63c07c82e..92d02a29b 100644 --- a/docs/reference/api/WatcherActionType.md +++ b/docs/reference/api/WatcherActionType.md @@ -1,4 +1,4 @@ -## `WatcherActionType` -::: +# `WatcherActionType` [alias-WatcherActionType] +```typescript type WatcherActionType = 'email' | 'webhook' | 'index' | 'logging' | 'slack' | 'pagerduty'; -::: +``` diff --git a/docs/reference/api/WatcherActions.md b/docs/reference/api/WatcherActions.md index ce9c11f03..2d0492c11 100644 --- a/docs/reference/api/WatcherActions.md +++ b/docs/reference/api/WatcherActions.md @@ -1,4 +1,4 @@ -## `WatcherActions` -::: +# `WatcherActions` [alias-WatcherActions] +```typescript type WatcherActions = Record<[IndexName](./IndexName.md), [WatcherActionStatus](./WatcherActionStatus.md)>; -::: +``` diff --git a/docs/reference/api/WatcherActivateWatchRequest.md b/docs/reference/api/WatcherActivateWatchRequest.md index 09bf48492..2537b79b9 100644 --- a/docs/reference/api/WatcherActivateWatchRequest.md +++ b/docs/reference/api/WatcherActivateWatchRequest.md @@ -1,4 +1,4 @@ -## Interface `WatcherActivateWatchRequest` +# `WatcherActivateWatchRequest` [interface-WatcherActivateWatchRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherActivateWatchResponse.md b/docs/reference/api/WatcherActivateWatchResponse.md index d8e4cebf7..07fd42739 100644 --- a/docs/reference/api/WatcherActivateWatchResponse.md +++ b/docs/reference/api/WatcherActivateWatchResponse.md @@ -1,4 +1,4 @@ -## Interface `WatcherActivateWatchResponse` +# `WatcherActivateWatchResponse` [interface-WatcherActivateWatchResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherActivationState.md b/docs/reference/api/WatcherActivationState.md index 10d106986..96181a245 100644 --- a/docs/reference/api/WatcherActivationState.md +++ b/docs/reference/api/WatcherActivationState.md @@ -1,4 +1,4 @@ -## Interface `WatcherActivationState` +# `WatcherActivationState` [interface-WatcherActivationState] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherActivationStatus.md b/docs/reference/api/WatcherActivationStatus.md index 661bcbaf9..1025c01e4 100644 --- a/docs/reference/api/WatcherActivationStatus.md +++ b/docs/reference/api/WatcherActivationStatus.md @@ -1,4 +1,4 @@ -## Interface `WatcherActivationStatus` +# `WatcherActivationStatus` [interface-WatcherActivationStatus] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherAlwaysCondition.md b/docs/reference/api/WatcherAlwaysCondition.md index f7400bad1..eca00fa72 100644 --- a/docs/reference/api/WatcherAlwaysCondition.md +++ b/docs/reference/api/WatcherAlwaysCondition.md @@ -1,4 +1,4 @@ -## Interface `WatcherAlwaysCondition` +# `WatcherAlwaysCondition` [interface-WatcherAlwaysCondition] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherArrayCompareCondition.md b/docs/reference/api/WatcherArrayCompareCondition.md index ed3c903e0..06ade5a4b 100644 --- a/docs/reference/api/WatcherArrayCompareCondition.md +++ b/docs/reference/api/WatcherArrayCompareCondition.md @@ -1,4 +1,4 @@ -## `WatcherArrayCompareCondition` -::: +# `WatcherArrayCompareCondition` [alias-WatcherArrayCompareCondition] +```typescript type WatcherArrayCompareCondition = [WatcherArrayCompareConditionKeys](./WatcherArrayCompareConditionKeys.md) & { [property: string]: [WatcherArrayCompareOpParams](./WatcherArrayCompareOpParams.md) | string;}; -::: +``` diff --git a/docs/reference/api/WatcherArrayCompareConditionKeys.md b/docs/reference/api/WatcherArrayCompareConditionKeys.md index d7a832429..55a41f7c2 100644 --- a/docs/reference/api/WatcherArrayCompareConditionKeys.md +++ b/docs/reference/api/WatcherArrayCompareConditionKeys.md @@ -1,4 +1,4 @@ -## Interface `WatcherArrayCompareConditionKeys` +# `WatcherArrayCompareConditionKeys` [interface-WatcherArrayCompareConditionKeys] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherArrayCompareOpParams.md b/docs/reference/api/WatcherArrayCompareOpParams.md index 58196e345..04b224c34 100644 --- a/docs/reference/api/WatcherArrayCompareOpParams.md +++ b/docs/reference/api/WatcherArrayCompareOpParams.md @@ -1,4 +1,4 @@ -## Interface `WatcherArrayCompareOpParams` +# `WatcherArrayCompareOpParams` [interface-WatcherArrayCompareOpParams] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherChainInput.md b/docs/reference/api/WatcherChainInput.md index 866f8e4d2..205e0019c 100644 --- a/docs/reference/api/WatcherChainInput.md +++ b/docs/reference/api/WatcherChainInput.md @@ -1,4 +1,4 @@ -## Interface `WatcherChainInput` +# `WatcherChainInput` [interface-WatcherChainInput] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherConditionContainer.md b/docs/reference/api/WatcherConditionContainer.md index 7b2e5a7c8..69e9afd98 100644 --- a/docs/reference/api/WatcherConditionContainer.md +++ b/docs/reference/api/WatcherConditionContainer.md @@ -1,4 +1,4 @@ -## Interface `WatcherConditionContainer` +# `WatcherConditionContainer` [interface-WatcherConditionContainer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherConditionOp.md b/docs/reference/api/WatcherConditionOp.md index f2a1fe72b..b933a10e2 100644 --- a/docs/reference/api/WatcherConditionOp.md +++ b/docs/reference/api/WatcherConditionOp.md @@ -1,4 +1,4 @@ -## `WatcherConditionOp` -::: +# `WatcherConditionOp` [alias-WatcherConditionOp] +```typescript type WatcherConditionOp = 'not_eq' | 'eq' | 'lt' | 'gt' | 'lte' | 'gte'; -::: +``` diff --git a/docs/reference/api/WatcherConditionType.md b/docs/reference/api/WatcherConditionType.md index 8c1af4841..3d97fd778 100644 --- a/docs/reference/api/WatcherConditionType.md +++ b/docs/reference/api/WatcherConditionType.md @@ -1,4 +1,4 @@ -## `WatcherConditionType` -::: +# `WatcherConditionType` [alias-WatcherConditionType] +```typescript type WatcherConditionType = 'always' | 'never' | 'script' | 'compare' | 'array_compare'; -::: +``` diff --git a/docs/reference/api/WatcherConnectionScheme.md b/docs/reference/api/WatcherConnectionScheme.md index 97381c663..4b8b40ad1 100644 --- a/docs/reference/api/WatcherConnectionScheme.md +++ b/docs/reference/api/WatcherConnectionScheme.md @@ -1,4 +1,4 @@ -## `WatcherConnectionScheme` -::: +# `WatcherConnectionScheme` [alias-WatcherConnectionScheme] +```typescript type WatcherConnectionScheme = 'http' | 'https'; -::: +``` diff --git a/docs/reference/api/WatcherCronExpression.md b/docs/reference/api/WatcherCronExpression.md index b0c27e2ab..54158b732 100644 --- a/docs/reference/api/WatcherCronExpression.md +++ b/docs/reference/api/WatcherCronExpression.md @@ -1,4 +1,4 @@ -## `WatcherCronExpression` -::: +# `WatcherCronExpression` [alias-WatcherCronExpression] +```typescript type WatcherCronExpression = string; -::: +``` diff --git a/docs/reference/api/WatcherDailySchedule.md b/docs/reference/api/WatcherDailySchedule.md index 83916f455..7baa4a38a 100644 --- a/docs/reference/api/WatcherDailySchedule.md +++ b/docs/reference/api/WatcherDailySchedule.md @@ -1,4 +1,4 @@ -## Interface `WatcherDailySchedule` +# `WatcherDailySchedule` [interface-WatcherDailySchedule] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherDataAttachmentFormat.md b/docs/reference/api/WatcherDataAttachmentFormat.md index 6ce7344bb..5fd025dc3 100644 --- a/docs/reference/api/WatcherDataAttachmentFormat.md +++ b/docs/reference/api/WatcherDataAttachmentFormat.md @@ -1,4 +1,4 @@ -## `WatcherDataAttachmentFormat` -::: +# `WatcherDataAttachmentFormat` [alias-WatcherDataAttachmentFormat] +```typescript type WatcherDataAttachmentFormat = 'json' | 'yaml'; -::: +``` diff --git a/docs/reference/api/WatcherDataEmailAttachment.md b/docs/reference/api/WatcherDataEmailAttachment.md index 7bb82ae7b..97153f4f1 100644 --- a/docs/reference/api/WatcherDataEmailAttachment.md +++ b/docs/reference/api/WatcherDataEmailAttachment.md @@ -1,4 +1,4 @@ -## Interface `WatcherDataEmailAttachment` +# `WatcherDataEmailAttachment` [interface-WatcherDataEmailAttachment] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherDay.md b/docs/reference/api/WatcherDay.md index 58f73a288..dedc88c60 100644 --- a/docs/reference/api/WatcherDay.md +++ b/docs/reference/api/WatcherDay.md @@ -1,4 +1,4 @@ -## `WatcherDay` -::: +# `WatcherDay` [alias-WatcherDay] +```typescript type WatcherDay = 'sunday' | 'monday' | 'tuesday' | 'wednesday' | 'thursday' | 'friday' | 'saturday'; -::: +``` diff --git a/docs/reference/api/WatcherDeactivateWatchRequest.md b/docs/reference/api/WatcherDeactivateWatchRequest.md index c18d63aba..42f033051 100644 --- a/docs/reference/api/WatcherDeactivateWatchRequest.md +++ b/docs/reference/api/WatcherDeactivateWatchRequest.md @@ -1,4 +1,4 @@ -## Interface `WatcherDeactivateWatchRequest` +# `WatcherDeactivateWatchRequest` [interface-WatcherDeactivateWatchRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherDeactivateWatchResponse.md b/docs/reference/api/WatcherDeactivateWatchResponse.md index 3ea7cda92..89686e40a 100644 --- a/docs/reference/api/WatcherDeactivateWatchResponse.md +++ b/docs/reference/api/WatcherDeactivateWatchResponse.md @@ -1,4 +1,4 @@ -## Interface `WatcherDeactivateWatchResponse` +# `WatcherDeactivateWatchResponse` [interface-WatcherDeactivateWatchResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherDeleteWatchRequest.md b/docs/reference/api/WatcherDeleteWatchRequest.md index 14dd55c5d..59205c53a 100644 --- a/docs/reference/api/WatcherDeleteWatchRequest.md +++ b/docs/reference/api/WatcherDeleteWatchRequest.md @@ -1,4 +1,4 @@ -## Interface `WatcherDeleteWatchRequest` +# `WatcherDeleteWatchRequest` [interface-WatcherDeleteWatchRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherDeleteWatchResponse.md b/docs/reference/api/WatcherDeleteWatchResponse.md index 9b3921fb1..03238637c 100644 --- a/docs/reference/api/WatcherDeleteWatchResponse.md +++ b/docs/reference/api/WatcherDeleteWatchResponse.md @@ -1,4 +1,4 @@ -## Interface `WatcherDeleteWatchResponse` +# `WatcherDeleteWatchResponse` [interface-WatcherDeleteWatchResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherEmail.md b/docs/reference/api/WatcherEmail.md index d84643c5f..568500c23 100644 --- a/docs/reference/api/WatcherEmail.md +++ b/docs/reference/api/WatcherEmail.md @@ -1,4 +1,4 @@ -## Interface `WatcherEmail` +# `WatcherEmail` [interface-WatcherEmail] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherEmailAction.md b/docs/reference/api/WatcherEmailAction.md index cdefcbf01..d79eff02d 100644 --- a/docs/reference/api/WatcherEmailAction.md +++ b/docs/reference/api/WatcherEmailAction.md @@ -1,4 +1,4 @@ -## Interface `WatcherEmailAction` +# `WatcherEmailAction` [interface-WatcherEmailAction] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherEmailAttachmentContainer.md b/docs/reference/api/WatcherEmailAttachmentContainer.md index 81dd75b5d..640f509ae 100644 --- a/docs/reference/api/WatcherEmailAttachmentContainer.md +++ b/docs/reference/api/WatcherEmailAttachmentContainer.md @@ -1,4 +1,4 @@ -## Interface `WatcherEmailAttachmentContainer` +# `WatcherEmailAttachmentContainer` [interface-WatcherEmailAttachmentContainer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherEmailBody.md b/docs/reference/api/WatcherEmailBody.md index b8ba7cdc8..f2a41a7f4 100644 --- a/docs/reference/api/WatcherEmailBody.md +++ b/docs/reference/api/WatcherEmailBody.md @@ -1,4 +1,4 @@ -## Interface `WatcherEmailBody` +# `WatcherEmailBody` [interface-WatcherEmailBody] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherEmailPriority.md b/docs/reference/api/WatcherEmailPriority.md index 4414c2f58..01cd062f2 100644 --- a/docs/reference/api/WatcherEmailPriority.md +++ b/docs/reference/api/WatcherEmailPriority.md @@ -1,4 +1,4 @@ -## `WatcherEmailPriority` -::: +# `WatcherEmailPriority` [alias-WatcherEmailPriority] +```typescript type WatcherEmailPriority = 'lowest' | 'low' | 'normal' | 'high' | 'highest'; -::: +``` diff --git a/docs/reference/api/WatcherEmailResult.md b/docs/reference/api/WatcherEmailResult.md index 30d620807..9ba3e9084 100644 --- a/docs/reference/api/WatcherEmailResult.md +++ b/docs/reference/api/WatcherEmailResult.md @@ -1,4 +1,4 @@ -## Interface `WatcherEmailResult` +# `WatcherEmailResult` [interface-WatcherEmailResult] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherExecuteWatchRequest.md b/docs/reference/api/WatcherExecuteWatchRequest.md index 760e1da3c..d882a9943 100644 --- a/docs/reference/api/WatcherExecuteWatchRequest.md +++ b/docs/reference/api/WatcherExecuteWatchRequest.md @@ -1,4 +1,4 @@ -## Interface `WatcherExecuteWatchRequest` +# `WatcherExecuteWatchRequest` [interface-WatcherExecuteWatchRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherExecuteWatchResponse.md b/docs/reference/api/WatcherExecuteWatchResponse.md index 5ccdf9432..014eb3925 100644 --- a/docs/reference/api/WatcherExecuteWatchResponse.md +++ b/docs/reference/api/WatcherExecuteWatchResponse.md @@ -1,4 +1,4 @@ -## Interface `WatcherExecuteWatchResponse` +# `WatcherExecuteWatchResponse` [interface-WatcherExecuteWatchResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherExecuteWatchWatchRecord.md b/docs/reference/api/WatcherExecuteWatchWatchRecord.md index 05908f07f..21643511c 100644 --- a/docs/reference/api/WatcherExecuteWatchWatchRecord.md +++ b/docs/reference/api/WatcherExecuteWatchWatchRecord.md @@ -1,4 +1,4 @@ -## Interface `WatcherExecuteWatchWatchRecord` +# `WatcherExecuteWatchWatchRecord` [interface-WatcherExecuteWatchWatchRecord] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherExecutionPhase.md b/docs/reference/api/WatcherExecutionPhase.md index e0c4c2ae8..eee0f60e3 100644 --- a/docs/reference/api/WatcherExecutionPhase.md +++ b/docs/reference/api/WatcherExecutionPhase.md @@ -1,4 +1,4 @@ -## `WatcherExecutionPhase` -::: +# `WatcherExecutionPhase` [alias-WatcherExecutionPhase] +```typescript type WatcherExecutionPhase = 'awaits_execution' | 'started' | 'input' | 'condition' | 'actions' | 'watch_transform' | 'aborted' | 'finished'; -::: +``` diff --git a/docs/reference/api/WatcherExecutionResult.md b/docs/reference/api/WatcherExecutionResult.md index 595d381a2..93fba02e2 100644 --- a/docs/reference/api/WatcherExecutionResult.md +++ b/docs/reference/api/WatcherExecutionResult.md @@ -1,4 +1,4 @@ -## Interface `WatcherExecutionResult` +# `WatcherExecutionResult` [interface-WatcherExecutionResult] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherExecutionResultAction.md b/docs/reference/api/WatcherExecutionResultAction.md index d331c5610..417fc84be 100644 --- a/docs/reference/api/WatcherExecutionResultAction.md +++ b/docs/reference/api/WatcherExecutionResultAction.md @@ -1,4 +1,4 @@ -## Interface `WatcherExecutionResultAction` +# `WatcherExecutionResultAction` [interface-WatcherExecutionResultAction] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherExecutionResultCondition.md b/docs/reference/api/WatcherExecutionResultCondition.md index 88762d02d..54f35d540 100644 --- a/docs/reference/api/WatcherExecutionResultCondition.md +++ b/docs/reference/api/WatcherExecutionResultCondition.md @@ -1,4 +1,4 @@ -## Interface `WatcherExecutionResultCondition` +# `WatcherExecutionResultCondition` [interface-WatcherExecutionResultCondition] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherExecutionResultInput.md b/docs/reference/api/WatcherExecutionResultInput.md index b93fb8a2e..a26a0a222 100644 --- a/docs/reference/api/WatcherExecutionResultInput.md +++ b/docs/reference/api/WatcherExecutionResultInput.md @@ -1,4 +1,4 @@ -## Interface `WatcherExecutionResultInput` +# `WatcherExecutionResultInput` [interface-WatcherExecutionResultInput] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherExecutionState.md b/docs/reference/api/WatcherExecutionState.md index c12b19cd7..8122ef498 100644 --- a/docs/reference/api/WatcherExecutionState.md +++ b/docs/reference/api/WatcherExecutionState.md @@ -1,4 +1,4 @@ -## Interface `WatcherExecutionState` +# `WatcherExecutionState` [interface-WatcherExecutionState] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherExecutionStatus.md b/docs/reference/api/WatcherExecutionStatus.md index dadac069a..a09822994 100644 --- a/docs/reference/api/WatcherExecutionStatus.md +++ b/docs/reference/api/WatcherExecutionStatus.md @@ -1,4 +1,4 @@ -## `WatcherExecutionStatus` -::: +# `WatcherExecutionStatus` [alias-WatcherExecutionStatus] +```typescript type WatcherExecutionStatus = 'awaits_execution' | 'checking' | 'execution_not_needed' | 'throttled' | 'executed' | 'failed' | 'deleted_while_queued' | 'not_executed_already_queued'; -::: +``` diff --git a/docs/reference/api/WatcherExecutionThreadPool.md b/docs/reference/api/WatcherExecutionThreadPool.md index 738de21d3..4caa7c798 100644 --- a/docs/reference/api/WatcherExecutionThreadPool.md +++ b/docs/reference/api/WatcherExecutionThreadPool.md @@ -1,4 +1,4 @@ -## Interface `WatcherExecutionThreadPool` +# `WatcherExecutionThreadPool` [interface-WatcherExecutionThreadPool] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherGetSettingsRequest.md b/docs/reference/api/WatcherGetSettingsRequest.md index 84cccfb56..85140feba 100644 --- a/docs/reference/api/WatcherGetSettingsRequest.md +++ b/docs/reference/api/WatcherGetSettingsRequest.md @@ -1,4 +1,4 @@ -## Interface `WatcherGetSettingsRequest` +# `WatcherGetSettingsRequest` [interface-WatcherGetSettingsRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherGetSettingsResponse.md b/docs/reference/api/WatcherGetSettingsResponse.md index e37849e87..5b9d391be 100644 --- a/docs/reference/api/WatcherGetSettingsResponse.md +++ b/docs/reference/api/WatcherGetSettingsResponse.md @@ -1,4 +1,4 @@ -## Interface `WatcherGetSettingsResponse` +# `WatcherGetSettingsResponse` [interface-WatcherGetSettingsResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherGetWatchRequest.md b/docs/reference/api/WatcherGetWatchRequest.md index fe938c739..70b7789a7 100644 --- a/docs/reference/api/WatcherGetWatchRequest.md +++ b/docs/reference/api/WatcherGetWatchRequest.md @@ -1,4 +1,4 @@ -## Interface `WatcherGetWatchRequest` +# `WatcherGetWatchRequest` [interface-WatcherGetWatchRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherGetWatchResponse.md b/docs/reference/api/WatcherGetWatchResponse.md index 72aa9f864..a713d4d62 100644 --- a/docs/reference/api/WatcherGetWatchResponse.md +++ b/docs/reference/api/WatcherGetWatchResponse.md @@ -1,4 +1,4 @@ -## Interface `WatcherGetWatchResponse` +# `WatcherGetWatchResponse` [interface-WatcherGetWatchResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherHourAndMinute.md b/docs/reference/api/WatcherHourAndMinute.md index 6028e0f9b..06eba9976 100644 --- a/docs/reference/api/WatcherHourAndMinute.md +++ b/docs/reference/api/WatcherHourAndMinute.md @@ -1,4 +1,4 @@ -## Interface `WatcherHourAndMinute` +# `WatcherHourAndMinute` [interface-WatcherHourAndMinute] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherHourlySchedule.md b/docs/reference/api/WatcherHourlySchedule.md index 37002356e..f5f41ece4 100644 --- a/docs/reference/api/WatcherHourlySchedule.md +++ b/docs/reference/api/WatcherHourlySchedule.md @@ -1,4 +1,4 @@ -## Interface `WatcherHourlySchedule` +# `WatcherHourlySchedule` [interface-WatcherHourlySchedule] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherHttpEmailAttachment.md b/docs/reference/api/WatcherHttpEmailAttachment.md index 1c7bad572..25bb0cb32 100644 --- a/docs/reference/api/WatcherHttpEmailAttachment.md +++ b/docs/reference/api/WatcherHttpEmailAttachment.md @@ -1,4 +1,4 @@ -## Interface `WatcherHttpEmailAttachment` +# `WatcherHttpEmailAttachment` [interface-WatcherHttpEmailAttachment] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherHttpInput.md b/docs/reference/api/WatcherHttpInput.md index 0806fe124..6f68bdb35 100644 --- a/docs/reference/api/WatcherHttpInput.md +++ b/docs/reference/api/WatcherHttpInput.md @@ -1,4 +1,4 @@ -## Interface `WatcherHttpInput` +# `WatcherHttpInput` [interface-WatcherHttpInput] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherHttpInputAuthentication.md b/docs/reference/api/WatcherHttpInputAuthentication.md index 3e0727ee5..c4d74714b 100644 --- a/docs/reference/api/WatcherHttpInputAuthentication.md +++ b/docs/reference/api/WatcherHttpInputAuthentication.md @@ -1,4 +1,4 @@ -## Interface `WatcherHttpInputAuthentication` +# `WatcherHttpInputAuthentication` [interface-WatcherHttpInputAuthentication] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherHttpInputBasicAuthentication.md b/docs/reference/api/WatcherHttpInputBasicAuthentication.md index 2b15ebaa5..821937c9f 100644 --- a/docs/reference/api/WatcherHttpInputBasicAuthentication.md +++ b/docs/reference/api/WatcherHttpInputBasicAuthentication.md @@ -1,4 +1,4 @@ -## Interface `WatcherHttpInputBasicAuthentication` +# `WatcherHttpInputBasicAuthentication` [interface-WatcherHttpInputBasicAuthentication] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherHttpInputMethod.md b/docs/reference/api/WatcherHttpInputMethod.md index 9a7acc1c7..4c43e9016 100644 --- a/docs/reference/api/WatcherHttpInputMethod.md +++ b/docs/reference/api/WatcherHttpInputMethod.md @@ -1,4 +1,4 @@ -## `WatcherHttpInputMethod` -::: +# `WatcherHttpInputMethod` [alias-WatcherHttpInputMethod] +```typescript type WatcherHttpInputMethod = 'head' | 'get' | 'post' | 'put' | 'delete'; -::: +``` diff --git a/docs/reference/api/WatcherHttpInputProxy.md b/docs/reference/api/WatcherHttpInputProxy.md index 9b446d386..6020e69eb 100644 --- a/docs/reference/api/WatcherHttpInputProxy.md +++ b/docs/reference/api/WatcherHttpInputProxy.md @@ -1,4 +1,4 @@ -## Interface `WatcherHttpInputProxy` +# `WatcherHttpInputProxy` [interface-WatcherHttpInputProxy] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherHttpInputRequestDefinition.md b/docs/reference/api/WatcherHttpInputRequestDefinition.md index 125b249dc..7263ad5f4 100644 --- a/docs/reference/api/WatcherHttpInputRequestDefinition.md +++ b/docs/reference/api/WatcherHttpInputRequestDefinition.md @@ -1,4 +1,4 @@ -## Interface `WatcherHttpInputRequestDefinition` +# `WatcherHttpInputRequestDefinition` [interface-WatcherHttpInputRequestDefinition] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherHttpInputRequestResult.md b/docs/reference/api/WatcherHttpInputRequestResult.md index 39e08def2..03552f5c2 100644 --- a/docs/reference/api/WatcherHttpInputRequestResult.md +++ b/docs/reference/api/WatcherHttpInputRequestResult.md @@ -1,4 +1,4 @@ -## Interface `WatcherHttpInputRequestResult` +# `WatcherHttpInputRequestResult` [interface-WatcherHttpInputRequestResult] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherHttpInputResponseResult.md b/docs/reference/api/WatcherHttpInputResponseResult.md index 9d53171bc..e628f6cf2 100644 --- a/docs/reference/api/WatcherHttpInputResponseResult.md +++ b/docs/reference/api/WatcherHttpInputResponseResult.md @@ -1,4 +1,4 @@ -## Interface `WatcherHttpInputResponseResult` +# `WatcherHttpInputResponseResult` [interface-WatcherHttpInputResponseResult] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherIndexAction.md b/docs/reference/api/WatcherIndexAction.md index 39d19cba1..3c3ec906c 100644 --- a/docs/reference/api/WatcherIndexAction.md +++ b/docs/reference/api/WatcherIndexAction.md @@ -1,4 +1,4 @@ -## Interface `WatcherIndexAction` +# `WatcherIndexAction` [interface-WatcherIndexAction] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherIndexResult.md b/docs/reference/api/WatcherIndexResult.md index 40138e0b6..97b03aa42 100644 --- a/docs/reference/api/WatcherIndexResult.md +++ b/docs/reference/api/WatcherIndexResult.md @@ -1,4 +1,4 @@ -## Interface `WatcherIndexResult` +# `WatcherIndexResult` [interface-WatcherIndexResult] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherIndexResultSummary.md b/docs/reference/api/WatcherIndexResultSummary.md index e1e903c3e..b199033a5 100644 --- a/docs/reference/api/WatcherIndexResultSummary.md +++ b/docs/reference/api/WatcherIndexResultSummary.md @@ -1,4 +1,4 @@ -## Interface `WatcherIndexResultSummary` +# `WatcherIndexResultSummary` [interface-WatcherIndexResultSummary] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherInputContainer.md b/docs/reference/api/WatcherInputContainer.md index c6ac3cfde..fe43a405d 100644 --- a/docs/reference/api/WatcherInputContainer.md +++ b/docs/reference/api/WatcherInputContainer.md @@ -1,4 +1,4 @@ -## Interface `WatcherInputContainer` +# `WatcherInputContainer` [interface-WatcherInputContainer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherInputType.md b/docs/reference/api/WatcherInputType.md index 3214ab0cf..ed215b99f 100644 --- a/docs/reference/api/WatcherInputType.md +++ b/docs/reference/api/WatcherInputType.md @@ -1,4 +1,4 @@ -## `WatcherInputType` -::: +# `WatcherInputType` [alias-WatcherInputType] +```typescript type WatcherInputType = 'http' | 'search' | 'simple'; -::: +``` diff --git a/docs/reference/api/WatcherLoggingAction.md b/docs/reference/api/WatcherLoggingAction.md index 033b1ce70..8828e4748 100644 --- a/docs/reference/api/WatcherLoggingAction.md +++ b/docs/reference/api/WatcherLoggingAction.md @@ -1,4 +1,4 @@ -## Interface `WatcherLoggingAction` +# `WatcherLoggingAction` [interface-WatcherLoggingAction] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherLoggingResult.md b/docs/reference/api/WatcherLoggingResult.md index 7055f03cc..7eb86e993 100644 --- a/docs/reference/api/WatcherLoggingResult.md +++ b/docs/reference/api/WatcherLoggingResult.md @@ -1,4 +1,4 @@ -## Interface `WatcherLoggingResult` +# `WatcherLoggingResult` [interface-WatcherLoggingResult] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherMonth.md b/docs/reference/api/WatcherMonth.md index 5dadbeeb0..0750f40d0 100644 --- a/docs/reference/api/WatcherMonth.md +++ b/docs/reference/api/WatcherMonth.md @@ -1,4 +1,4 @@ -## `WatcherMonth` -::: +# `WatcherMonth` [alias-WatcherMonth] +```typescript type WatcherMonth = 'january' | 'february' | 'march' | 'april' | 'may' | 'june' | 'july' | 'august' | 'september' | 'october' | 'november' | 'december'; -::: +``` diff --git a/docs/reference/api/WatcherNeverCondition.md b/docs/reference/api/WatcherNeverCondition.md index 1a76cb090..913df8da7 100644 --- a/docs/reference/api/WatcherNeverCondition.md +++ b/docs/reference/api/WatcherNeverCondition.md @@ -1,4 +1,4 @@ -## Interface `WatcherNeverCondition` +# `WatcherNeverCondition` [interface-WatcherNeverCondition] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherPagerDutyAction.md b/docs/reference/api/WatcherPagerDutyAction.md index 12de4e621..b0da066b4 100644 --- a/docs/reference/api/WatcherPagerDutyAction.md +++ b/docs/reference/api/WatcherPagerDutyAction.md @@ -1,4 +1,4 @@ -## Interface `WatcherPagerDutyAction` +# `WatcherPagerDutyAction` [interface-WatcherPagerDutyAction] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherPagerDutyContext.md b/docs/reference/api/WatcherPagerDutyContext.md index 6e007fca3..93db0933a 100644 --- a/docs/reference/api/WatcherPagerDutyContext.md +++ b/docs/reference/api/WatcherPagerDutyContext.md @@ -1,4 +1,4 @@ -## Interface `WatcherPagerDutyContext` +# `WatcherPagerDutyContext` [interface-WatcherPagerDutyContext] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherPagerDutyContextType.md b/docs/reference/api/WatcherPagerDutyContextType.md index abc800255..848aecee9 100644 --- a/docs/reference/api/WatcherPagerDutyContextType.md +++ b/docs/reference/api/WatcherPagerDutyContextType.md @@ -1,4 +1,4 @@ -## `WatcherPagerDutyContextType` -::: +# `WatcherPagerDutyContextType` [alias-WatcherPagerDutyContextType] +```typescript type WatcherPagerDutyContextType = 'link' | 'image'; -::: +``` diff --git a/docs/reference/api/WatcherPagerDutyEvent.md b/docs/reference/api/WatcherPagerDutyEvent.md index 837822c3e..c08a02bf0 100644 --- a/docs/reference/api/WatcherPagerDutyEvent.md +++ b/docs/reference/api/WatcherPagerDutyEvent.md @@ -1,4 +1,4 @@ -## Interface `WatcherPagerDutyEvent` +# `WatcherPagerDutyEvent` [interface-WatcherPagerDutyEvent] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherPagerDutyEventProxy.md b/docs/reference/api/WatcherPagerDutyEventProxy.md index fb8354a96..d21daa226 100644 --- a/docs/reference/api/WatcherPagerDutyEventProxy.md +++ b/docs/reference/api/WatcherPagerDutyEventProxy.md @@ -1,4 +1,4 @@ -## Interface `WatcherPagerDutyEventProxy` +# `WatcherPagerDutyEventProxy` [interface-WatcherPagerDutyEventProxy] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherPagerDutyEventType.md b/docs/reference/api/WatcherPagerDutyEventType.md index 329cda1cd..79ad7304b 100644 --- a/docs/reference/api/WatcherPagerDutyEventType.md +++ b/docs/reference/api/WatcherPagerDutyEventType.md @@ -1,4 +1,4 @@ -## `WatcherPagerDutyEventType` -::: +# `WatcherPagerDutyEventType` [alias-WatcherPagerDutyEventType] +```typescript type WatcherPagerDutyEventType = 'trigger' | 'resolve' | 'acknowledge'; -::: +``` diff --git a/docs/reference/api/WatcherPagerDutyResult.md b/docs/reference/api/WatcherPagerDutyResult.md index 8f9f9b3ab..b6a6ad3e1 100644 --- a/docs/reference/api/WatcherPagerDutyResult.md +++ b/docs/reference/api/WatcherPagerDutyResult.md @@ -1,4 +1,4 @@ -## Interface `WatcherPagerDutyResult` +# `WatcherPagerDutyResult` [interface-WatcherPagerDutyResult] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherPutWatchRequest.md b/docs/reference/api/WatcherPutWatchRequest.md index 40769735b..e3077e6d1 100644 --- a/docs/reference/api/WatcherPutWatchRequest.md +++ b/docs/reference/api/WatcherPutWatchRequest.md @@ -1,4 +1,4 @@ -## Interface `WatcherPutWatchRequest` +# `WatcherPutWatchRequest` [interface-WatcherPutWatchRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherPutWatchResponse.md b/docs/reference/api/WatcherPutWatchResponse.md index 9c10a8596..dd0cb0baf 100644 --- a/docs/reference/api/WatcherPutWatchResponse.md +++ b/docs/reference/api/WatcherPutWatchResponse.md @@ -1,4 +1,4 @@ -## Interface `WatcherPutWatchResponse` +# `WatcherPutWatchResponse` [interface-WatcherPutWatchResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherQuantifier.md b/docs/reference/api/WatcherQuantifier.md index 63e7f6790..227d8d27f 100644 --- a/docs/reference/api/WatcherQuantifier.md +++ b/docs/reference/api/WatcherQuantifier.md @@ -1,4 +1,4 @@ -## `WatcherQuantifier` -::: +# `WatcherQuantifier` [alias-WatcherQuantifier] +```typescript type WatcherQuantifier = 'some' | 'all'; -::: +``` diff --git a/docs/reference/api/WatcherQueryWatch.md b/docs/reference/api/WatcherQueryWatch.md index 3d44f9c6d..e5f9f723c 100644 --- a/docs/reference/api/WatcherQueryWatch.md +++ b/docs/reference/api/WatcherQueryWatch.md @@ -1,4 +1,4 @@ -## Interface `WatcherQueryWatch` +# `WatcherQueryWatch` [interface-WatcherQueryWatch] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherQueryWatchesRequest.md b/docs/reference/api/WatcherQueryWatchesRequest.md index 06bc2cca1..685ce0bd1 100644 --- a/docs/reference/api/WatcherQueryWatchesRequest.md +++ b/docs/reference/api/WatcherQueryWatchesRequest.md @@ -1,4 +1,4 @@ -## Interface `WatcherQueryWatchesRequest` +# `WatcherQueryWatchesRequest` [interface-WatcherQueryWatchesRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherQueryWatchesResponse.md b/docs/reference/api/WatcherQueryWatchesResponse.md index 86b535874..25c86524d 100644 --- a/docs/reference/api/WatcherQueryWatchesResponse.md +++ b/docs/reference/api/WatcherQueryWatchesResponse.md @@ -1,4 +1,4 @@ -## Interface `WatcherQueryWatchesResponse` +# `WatcherQueryWatchesResponse` [interface-WatcherQueryWatchesResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherReportingEmailAttachment.md b/docs/reference/api/WatcherReportingEmailAttachment.md index a4b1a5c49..b5662bc07 100644 --- a/docs/reference/api/WatcherReportingEmailAttachment.md +++ b/docs/reference/api/WatcherReportingEmailAttachment.md @@ -1,4 +1,4 @@ -## Interface `WatcherReportingEmailAttachment` +# `WatcherReportingEmailAttachment` [interface-WatcherReportingEmailAttachment] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherResponseContentType.md b/docs/reference/api/WatcherResponseContentType.md index af43c1832..38995500f 100644 --- a/docs/reference/api/WatcherResponseContentType.md +++ b/docs/reference/api/WatcherResponseContentType.md @@ -1,4 +1,4 @@ -## `WatcherResponseContentType` -::: +# `WatcherResponseContentType` [alias-WatcherResponseContentType] +```typescript type WatcherResponseContentType = 'json' | 'yaml' | 'text'; -::: +``` diff --git a/docs/reference/api/WatcherScheduleContainer.md b/docs/reference/api/WatcherScheduleContainer.md index f5599416c..3f78ef2fc 100644 --- a/docs/reference/api/WatcherScheduleContainer.md +++ b/docs/reference/api/WatcherScheduleContainer.md @@ -1,4 +1,4 @@ -## Interface `WatcherScheduleContainer` +# `WatcherScheduleContainer` [interface-WatcherScheduleContainer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherScheduleTimeOfDay.md b/docs/reference/api/WatcherScheduleTimeOfDay.md index 4dd591c38..9dab1a90a 100644 --- a/docs/reference/api/WatcherScheduleTimeOfDay.md +++ b/docs/reference/api/WatcherScheduleTimeOfDay.md @@ -1,4 +1,4 @@ -## `WatcherScheduleTimeOfDay` -::: +# `WatcherScheduleTimeOfDay` [alias-WatcherScheduleTimeOfDay] +```typescript type WatcherScheduleTimeOfDay = string | [WatcherHourAndMinute](./WatcherHourAndMinute.md); -::: +``` diff --git a/docs/reference/api/WatcherScheduleTriggerEvent.md b/docs/reference/api/WatcherScheduleTriggerEvent.md index 69dca292a..89d3c084a 100644 --- a/docs/reference/api/WatcherScheduleTriggerEvent.md +++ b/docs/reference/api/WatcherScheduleTriggerEvent.md @@ -1,4 +1,4 @@ -## Interface `WatcherScheduleTriggerEvent` +# `WatcherScheduleTriggerEvent` [interface-WatcherScheduleTriggerEvent] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherScriptCondition.md b/docs/reference/api/WatcherScriptCondition.md index 9049db04a..7c99eca22 100644 --- a/docs/reference/api/WatcherScriptCondition.md +++ b/docs/reference/api/WatcherScriptCondition.md @@ -1,4 +1,4 @@ -## Interface `WatcherScriptCondition` +# `WatcherScriptCondition` [interface-WatcherScriptCondition] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherSearchInput.md b/docs/reference/api/WatcherSearchInput.md index 88f6ca37d..df3729f84 100644 --- a/docs/reference/api/WatcherSearchInput.md +++ b/docs/reference/api/WatcherSearchInput.md @@ -1,4 +1,4 @@ -## Interface `WatcherSearchInput` +# `WatcherSearchInput` [interface-WatcherSearchInput] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherSearchInputRequestBody.md b/docs/reference/api/WatcherSearchInputRequestBody.md index c1b191959..7ec29f696 100644 --- a/docs/reference/api/WatcherSearchInputRequestBody.md +++ b/docs/reference/api/WatcherSearchInputRequestBody.md @@ -1,4 +1,4 @@ -## Interface `WatcherSearchInputRequestBody` +# `WatcherSearchInputRequestBody` [interface-WatcherSearchInputRequestBody] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherSearchInputRequestDefinition.md b/docs/reference/api/WatcherSearchInputRequestDefinition.md index f08d37da9..77b1e7581 100644 --- a/docs/reference/api/WatcherSearchInputRequestDefinition.md +++ b/docs/reference/api/WatcherSearchInputRequestDefinition.md @@ -1,4 +1,4 @@ -## Interface `WatcherSearchInputRequestDefinition` +# `WatcherSearchInputRequestDefinition` [interface-WatcherSearchInputRequestDefinition] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherSearchTemplateRequestBody.md b/docs/reference/api/WatcherSearchTemplateRequestBody.md index f31ec4834..5b6c0c886 100644 --- a/docs/reference/api/WatcherSearchTemplateRequestBody.md +++ b/docs/reference/api/WatcherSearchTemplateRequestBody.md @@ -1,4 +1,4 @@ -## Interface `WatcherSearchTemplateRequestBody` +# `WatcherSearchTemplateRequestBody` [interface-WatcherSearchTemplateRequestBody] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherSimulatedActions.md b/docs/reference/api/WatcherSimulatedActions.md index 342a656c9..2b02e017b 100644 --- a/docs/reference/api/WatcherSimulatedActions.md +++ b/docs/reference/api/WatcherSimulatedActions.md @@ -1,4 +1,4 @@ -## Interface `WatcherSimulatedActions` +# `WatcherSimulatedActions` [interface-WatcherSimulatedActions] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherSlackAction.md b/docs/reference/api/WatcherSlackAction.md index 8a183db77..ac8cf0b9e 100644 --- a/docs/reference/api/WatcherSlackAction.md +++ b/docs/reference/api/WatcherSlackAction.md @@ -1,4 +1,4 @@ -## Interface `WatcherSlackAction` +# `WatcherSlackAction` [interface-WatcherSlackAction] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherSlackAttachment.md b/docs/reference/api/WatcherSlackAttachment.md index f0129eeb4..d2b66522c 100644 --- a/docs/reference/api/WatcherSlackAttachment.md +++ b/docs/reference/api/WatcherSlackAttachment.md @@ -1,4 +1,4 @@ -## Interface `WatcherSlackAttachment` +# `WatcherSlackAttachment` [interface-WatcherSlackAttachment] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherSlackAttachmentField.md b/docs/reference/api/WatcherSlackAttachmentField.md index 99d527362..fc76c669e 100644 --- a/docs/reference/api/WatcherSlackAttachmentField.md +++ b/docs/reference/api/WatcherSlackAttachmentField.md @@ -1,4 +1,4 @@ -## Interface `WatcherSlackAttachmentField` +# `WatcherSlackAttachmentField` [interface-WatcherSlackAttachmentField] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherSlackDynamicAttachment.md b/docs/reference/api/WatcherSlackDynamicAttachment.md index 2a33c908e..7db772b8b 100644 --- a/docs/reference/api/WatcherSlackDynamicAttachment.md +++ b/docs/reference/api/WatcherSlackDynamicAttachment.md @@ -1,4 +1,4 @@ -## Interface `WatcherSlackDynamicAttachment` +# `WatcherSlackDynamicAttachment` [interface-WatcherSlackDynamicAttachment] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherSlackMessage.md b/docs/reference/api/WatcherSlackMessage.md index caf8b99d9..8478e2fb3 100644 --- a/docs/reference/api/WatcherSlackMessage.md +++ b/docs/reference/api/WatcherSlackMessage.md @@ -1,4 +1,4 @@ -## Interface `WatcherSlackMessage` +# `WatcherSlackMessage` [interface-WatcherSlackMessage] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherSlackResult.md b/docs/reference/api/WatcherSlackResult.md index 7ae8b1554..e4eb34cb5 100644 --- a/docs/reference/api/WatcherSlackResult.md +++ b/docs/reference/api/WatcherSlackResult.md @@ -1,4 +1,4 @@ -## Interface `WatcherSlackResult` +# `WatcherSlackResult` [interface-WatcherSlackResult] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherStartRequest.md b/docs/reference/api/WatcherStartRequest.md index 32d5a9d3e..6db62f78f 100644 --- a/docs/reference/api/WatcherStartRequest.md +++ b/docs/reference/api/WatcherStartRequest.md @@ -1,4 +1,4 @@ -## Interface `WatcherStartRequest` +# `WatcherStartRequest` [interface-WatcherStartRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherStartResponse.md b/docs/reference/api/WatcherStartResponse.md index f27ca8f2b..70da5a451 100644 --- a/docs/reference/api/WatcherStartResponse.md +++ b/docs/reference/api/WatcherStartResponse.md @@ -1,4 +1,4 @@ -## `WatcherStartResponse` -::: +# `WatcherStartResponse` [alias-WatcherStartResponse] +```typescript type WatcherStartResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); -::: +``` diff --git a/docs/reference/api/WatcherStatsRequest.md b/docs/reference/api/WatcherStatsRequest.md index 374c53b07..53026ba83 100644 --- a/docs/reference/api/WatcherStatsRequest.md +++ b/docs/reference/api/WatcherStatsRequest.md @@ -1,4 +1,4 @@ -## Interface `WatcherStatsRequest` +# `WatcherStatsRequest` [interface-WatcherStatsRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherStatsResponse.md b/docs/reference/api/WatcherStatsResponse.md index 383e5308b..00c534fd2 100644 --- a/docs/reference/api/WatcherStatsResponse.md +++ b/docs/reference/api/WatcherStatsResponse.md @@ -1,4 +1,4 @@ -## Interface `WatcherStatsResponse` +# `WatcherStatsResponse` [interface-WatcherStatsResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherStatsWatchRecordQueuedStats.md b/docs/reference/api/WatcherStatsWatchRecordQueuedStats.md index e0f3c2e62..45beeff69 100644 --- a/docs/reference/api/WatcherStatsWatchRecordQueuedStats.md +++ b/docs/reference/api/WatcherStatsWatchRecordQueuedStats.md @@ -1,4 +1,4 @@ -## Interface `WatcherStatsWatchRecordQueuedStats` +# `WatcherStatsWatchRecordQueuedStats` [interface-WatcherStatsWatchRecordQueuedStats] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherStatsWatchRecordStats.md b/docs/reference/api/WatcherStatsWatchRecordStats.md index 736c946a0..4d3c55f89 100644 --- a/docs/reference/api/WatcherStatsWatchRecordStats.md +++ b/docs/reference/api/WatcherStatsWatchRecordStats.md @@ -1,4 +1,4 @@ -## Interface `WatcherStatsWatchRecordStats` +# `WatcherStatsWatchRecordStats` [interface-WatcherStatsWatchRecordStats] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherStatsWatcherMetric.md b/docs/reference/api/WatcherStatsWatcherMetric.md index c469ea804..60b842399 100644 --- a/docs/reference/api/WatcherStatsWatcherMetric.md +++ b/docs/reference/api/WatcherStatsWatcherMetric.md @@ -1,4 +1,4 @@ -## `WatcherStatsWatcherMetric` -::: +# `WatcherStatsWatcherMetric` [alias-WatcherStatsWatcherMetric] +```typescript type WatcherStatsWatcherMetric = '_all' | 'all' | 'queued_watches' | 'current_watches' | 'pending_watches'; -::: +``` diff --git a/docs/reference/api/WatcherStatsWatcherNodeStats.md b/docs/reference/api/WatcherStatsWatcherNodeStats.md index 43805fcdb..081faa98f 100644 --- a/docs/reference/api/WatcherStatsWatcherNodeStats.md +++ b/docs/reference/api/WatcherStatsWatcherNodeStats.md @@ -1,4 +1,4 @@ -## Interface `WatcherStatsWatcherNodeStats` +# `WatcherStatsWatcherNodeStats` [interface-WatcherStatsWatcherNodeStats] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherStatsWatcherState.md b/docs/reference/api/WatcherStatsWatcherState.md index 8ecb7b1d2..20988c3d4 100644 --- a/docs/reference/api/WatcherStatsWatcherState.md +++ b/docs/reference/api/WatcherStatsWatcherState.md @@ -1,4 +1,4 @@ -## `WatcherStatsWatcherState` -::: +# `WatcherStatsWatcherState` [alias-WatcherStatsWatcherState] +```typescript type WatcherStatsWatcherState = 'stopped' | 'starting' | 'started' | 'stopping'; -::: +``` diff --git a/docs/reference/api/WatcherStopRequest.md b/docs/reference/api/WatcherStopRequest.md index 1c66b11fd..9e45250f0 100644 --- a/docs/reference/api/WatcherStopRequest.md +++ b/docs/reference/api/WatcherStopRequest.md @@ -1,4 +1,4 @@ -## Interface `WatcherStopRequest` +# `WatcherStopRequest` [interface-WatcherStopRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherStopResponse.md b/docs/reference/api/WatcherStopResponse.md index b6db405e9..9727018ff 100644 --- a/docs/reference/api/WatcherStopResponse.md +++ b/docs/reference/api/WatcherStopResponse.md @@ -1,4 +1,4 @@ -## `WatcherStopResponse` -::: +# `WatcherStopResponse` [alias-WatcherStopResponse] +```typescript type WatcherStopResponse = [AcknowledgedResponseBase](./AcknowledgedResponseBase.md); -::: +``` diff --git a/docs/reference/api/WatcherThrottleState.md b/docs/reference/api/WatcherThrottleState.md index 1c4d28f41..d51bd9d4e 100644 --- a/docs/reference/api/WatcherThrottleState.md +++ b/docs/reference/api/WatcherThrottleState.md @@ -1,4 +1,4 @@ -## Interface `WatcherThrottleState` +# `WatcherThrottleState` [interface-WatcherThrottleState] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherTimeOfMonth.md b/docs/reference/api/WatcherTimeOfMonth.md index 604e104c4..83b2b549f 100644 --- a/docs/reference/api/WatcherTimeOfMonth.md +++ b/docs/reference/api/WatcherTimeOfMonth.md @@ -1,4 +1,4 @@ -## Interface `WatcherTimeOfMonth` +# `WatcherTimeOfMonth` [interface-WatcherTimeOfMonth] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherTimeOfWeek.md b/docs/reference/api/WatcherTimeOfWeek.md index 4b07dd068..2b760a7b2 100644 --- a/docs/reference/api/WatcherTimeOfWeek.md +++ b/docs/reference/api/WatcherTimeOfWeek.md @@ -1,4 +1,4 @@ -## Interface `WatcherTimeOfWeek` +# `WatcherTimeOfWeek` [interface-WatcherTimeOfWeek] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherTimeOfYear.md b/docs/reference/api/WatcherTimeOfYear.md index da23c0003..f7fe9a6da 100644 --- a/docs/reference/api/WatcherTimeOfYear.md +++ b/docs/reference/api/WatcherTimeOfYear.md @@ -1,4 +1,4 @@ -## Interface `WatcherTimeOfYear` +# `WatcherTimeOfYear` [interface-WatcherTimeOfYear] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherTriggerContainer.md b/docs/reference/api/WatcherTriggerContainer.md index c254f51b2..69054df67 100644 --- a/docs/reference/api/WatcherTriggerContainer.md +++ b/docs/reference/api/WatcherTriggerContainer.md @@ -1,4 +1,4 @@ -## Interface `WatcherTriggerContainer` +# `WatcherTriggerContainer` [interface-WatcherTriggerContainer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherTriggerEventContainer.md b/docs/reference/api/WatcherTriggerEventContainer.md index fd75f8ad7..d43c317ac 100644 --- a/docs/reference/api/WatcherTriggerEventContainer.md +++ b/docs/reference/api/WatcherTriggerEventContainer.md @@ -1,4 +1,4 @@ -## Interface `WatcherTriggerEventContainer` +# `WatcherTriggerEventContainer` [interface-WatcherTriggerEventContainer] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherTriggerEventResult.md b/docs/reference/api/WatcherTriggerEventResult.md index aaadeee51..652ef47d7 100644 --- a/docs/reference/api/WatcherTriggerEventResult.md +++ b/docs/reference/api/WatcherTriggerEventResult.md @@ -1,4 +1,4 @@ -## Interface `WatcherTriggerEventResult` +# `WatcherTriggerEventResult` [interface-WatcherTriggerEventResult] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherUpdateSettingsRequest.md b/docs/reference/api/WatcherUpdateSettingsRequest.md index 1667afd12..2ee7a7c0a 100644 --- a/docs/reference/api/WatcherUpdateSettingsRequest.md +++ b/docs/reference/api/WatcherUpdateSettingsRequest.md @@ -1,4 +1,4 @@ -## Interface `WatcherUpdateSettingsRequest` +# `WatcherUpdateSettingsRequest` [interface-WatcherUpdateSettingsRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherUpdateSettingsResponse.md b/docs/reference/api/WatcherUpdateSettingsResponse.md index 59fc1ea4d..8abd36a27 100644 --- a/docs/reference/api/WatcherUpdateSettingsResponse.md +++ b/docs/reference/api/WatcherUpdateSettingsResponse.md @@ -1,4 +1,4 @@ -## Interface `WatcherUpdateSettingsResponse` +# `WatcherUpdateSettingsResponse` [interface-WatcherUpdateSettingsResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherWatch.md b/docs/reference/api/WatcherWatch.md index a98c4b0c3..fb87048ba 100644 --- a/docs/reference/api/WatcherWatch.md +++ b/docs/reference/api/WatcherWatch.md @@ -1,4 +1,4 @@ -## Interface `WatcherWatch` +# `WatcherWatch` [interface-WatcherWatch] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherWatchStatus.md b/docs/reference/api/WatcherWatchStatus.md index 78555c125..120bddf9a 100644 --- a/docs/reference/api/WatcherWatchStatus.md +++ b/docs/reference/api/WatcherWatchStatus.md @@ -1,4 +1,4 @@ -## Interface `WatcherWatchStatus` +# `WatcherWatchStatus` [interface-WatcherWatchStatus] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherWebhookAction.md b/docs/reference/api/WatcherWebhookAction.md index ab8be7be7..9be002fa4 100644 --- a/docs/reference/api/WatcherWebhookAction.md +++ b/docs/reference/api/WatcherWebhookAction.md @@ -1,4 +1,4 @@ -## Interface `WatcherWebhookAction` +# `WatcherWebhookAction` [interface-WatcherWebhookAction] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WatcherWebhookResult.md b/docs/reference/api/WatcherWebhookResult.md index d29c319e5..ddf319dee 100644 --- a/docs/reference/api/WatcherWebhookResult.md +++ b/docs/reference/api/WatcherWebhookResult.md @@ -1,4 +1,4 @@ -## Interface `WatcherWebhookResult` +# `WatcherWebhookResult` [interface-WatcherWebhookResult] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WktGeoBounds.md b/docs/reference/api/WktGeoBounds.md index 61295cdd5..e1007ba1f 100644 --- a/docs/reference/api/WktGeoBounds.md +++ b/docs/reference/api/WktGeoBounds.md @@ -1,4 +1,4 @@ -## Interface `WktGeoBounds` +# `WktGeoBounds` [interface-WktGeoBounds] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/WriteResponseBase.md b/docs/reference/api/WriteResponseBase.md index 9c96ace71..0a64bcb4a 100644 --- a/docs/reference/api/WriteResponseBase.md +++ b/docs/reference/api/WriteResponseBase.md @@ -1,4 +1,4 @@ -## Interface `WriteResponseBase` +# `WriteResponseBase` [interface-WriteResponseBase] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/Xpack.md b/docs/reference/api/Xpack.md index bdd62b8a2..6003901ab 100644 --- a/docs/reference/api/Xpack.md +++ b/docs/reference/api/Xpack.md @@ -1,19 +1,19 @@ -## `Xpack` +# `Xpack` [class-Xpack] -### Constructor +## Constructor -::: +```typescript new Xpack(transport: [Transport](./Transport.md)); -::: +``` -### Properties +## Properties [class-properties-Xpack] | Name | Type | Description | | - | - | - | | `acceptedParams` | Record |   | | `transport` | [Transport](./Transport.md) |   | -### Methods +## Methods [class-methods-Xpack] | Name | Signature | Description | | - | - | - | diff --git a/docs/reference/api/XpackInfoBuildInformation.md b/docs/reference/api/XpackInfoBuildInformation.md index bbf6486d1..df49d232c 100644 --- a/docs/reference/api/XpackInfoBuildInformation.md +++ b/docs/reference/api/XpackInfoBuildInformation.md @@ -1,4 +1,4 @@ -## Interface `XpackInfoBuildInformation` +# `XpackInfoBuildInformation` [interface-XpackInfoBuildInformation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/XpackInfoFeature.md b/docs/reference/api/XpackInfoFeature.md index 739bdd318..dc6e0fe61 100644 --- a/docs/reference/api/XpackInfoFeature.md +++ b/docs/reference/api/XpackInfoFeature.md @@ -1,4 +1,4 @@ -## Interface `XpackInfoFeature` +# `XpackInfoFeature` [interface-XpackInfoFeature] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/XpackInfoFeatures.md b/docs/reference/api/XpackInfoFeatures.md index d0871c0f4..fd04c0a8a 100644 --- a/docs/reference/api/XpackInfoFeatures.md +++ b/docs/reference/api/XpackInfoFeatures.md @@ -1,4 +1,4 @@ -## Interface `XpackInfoFeatures` +# `XpackInfoFeatures` [interface-XpackInfoFeatures] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/XpackInfoMinimalLicenseInformation.md b/docs/reference/api/XpackInfoMinimalLicenseInformation.md index 221f167bd..d26e3fb55 100644 --- a/docs/reference/api/XpackInfoMinimalLicenseInformation.md +++ b/docs/reference/api/XpackInfoMinimalLicenseInformation.md @@ -1,4 +1,4 @@ -## Interface `XpackInfoMinimalLicenseInformation` +# `XpackInfoMinimalLicenseInformation` [interface-XpackInfoMinimalLicenseInformation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/XpackInfoNativeCodeInformation.md b/docs/reference/api/XpackInfoNativeCodeInformation.md index 8b187172a..865b1159d 100644 --- a/docs/reference/api/XpackInfoNativeCodeInformation.md +++ b/docs/reference/api/XpackInfoNativeCodeInformation.md @@ -1,4 +1,4 @@ -## Interface `XpackInfoNativeCodeInformation` +# `XpackInfoNativeCodeInformation` [interface-XpackInfoNativeCodeInformation] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/XpackInfoRequest.md b/docs/reference/api/XpackInfoRequest.md index ff1b7d277..9e2cfcddc 100644 --- a/docs/reference/api/XpackInfoRequest.md +++ b/docs/reference/api/XpackInfoRequest.md @@ -1,4 +1,4 @@ -## Interface `XpackInfoRequest` +# `XpackInfoRequest` [interface-XpackInfoRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/XpackInfoResponse.md b/docs/reference/api/XpackInfoResponse.md index cb6ccc5d1..206377400 100644 --- a/docs/reference/api/XpackInfoResponse.md +++ b/docs/reference/api/XpackInfoResponse.md @@ -1,4 +1,4 @@ -## Interface `XpackInfoResponse` +# `XpackInfoResponse` [interface-XpackInfoResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/XpackInfoXPackCategory.md b/docs/reference/api/XpackInfoXPackCategory.md index 5989e89e9..20185eb13 100644 --- a/docs/reference/api/XpackInfoXPackCategory.md +++ b/docs/reference/api/XpackInfoXPackCategory.md @@ -1,4 +1,4 @@ -## `XpackInfoXPackCategory` -::: +# `XpackInfoXPackCategory` [alias-XpackInfoXPackCategory] +```typescript type XpackInfoXPackCategory = 'build' | 'features' | 'license'; -::: +``` diff --git a/docs/reference/api/XpackUsageAnalytics.md b/docs/reference/api/XpackUsageAnalytics.md index a8d1aa59c..c020f7296 100644 --- a/docs/reference/api/XpackUsageAnalytics.md +++ b/docs/reference/api/XpackUsageAnalytics.md @@ -1,4 +1,4 @@ -## Interface `XpackUsageAnalytics` +# `XpackUsageAnalytics` [interface-XpackUsageAnalytics] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/XpackUsageAnalyticsStatistics.md b/docs/reference/api/XpackUsageAnalyticsStatistics.md index af3c7d8da..4e02b5833 100644 --- a/docs/reference/api/XpackUsageAnalyticsStatistics.md +++ b/docs/reference/api/XpackUsageAnalyticsStatistics.md @@ -1,4 +1,4 @@ -## Interface `XpackUsageAnalyticsStatistics` +# `XpackUsageAnalyticsStatistics` [interface-XpackUsageAnalyticsStatistics] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/XpackUsageArchive.md b/docs/reference/api/XpackUsageArchive.md index 2ce2b4829..d1574aecf 100644 --- a/docs/reference/api/XpackUsageArchive.md +++ b/docs/reference/api/XpackUsageArchive.md @@ -1,4 +1,4 @@ -## Interface `XpackUsageArchive` +# `XpackUsageArchive` [interface-XpackUsageArchive] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/XpackUsageAudit.md b/docs/reference/api/XpackUsageAudit.md index 9d9ceaed8..8166baad7 100644 --- a/docs/reference/api/XpackUsageAudit.md +++ b/docs/reference/api/XpackUsageAudit.md @@ -1,4 +1,4 @@ -## Interface `XpackUsageAudit` +# `XpackUsageAudit` [interface-XpackUsageAudit] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/XpackUsageBase.md b/docs/reference/api/XpackUsageBase.md index 3ec4b2607..1df551206 100644 --- a/docs/reference/api/XpackUsageBase.md +++ b/docs/reference/api/XpackUsageBase.md @@ -1,4 +1,4 @@ -## Interface `XpackUsageBase` +# `XpackUsageBase` [interface-XpackUsageBase] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/XpackUsageCcr.md b/docs/reference/api/XpackUsageCcr.md index ef4bec7f2..215854f88 100644 --- a/docs/reference/api/XpackUsageCcr.md +++ b/docs/reference/api/XpackUsageCcr.md @@ -1,4 +1,4 @@ -## Interface `XpackUsageCcr` +# `XpackUsageCcr` [interface-XpackUsageCcr] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/XpackUsageCounter.md b/docs/reference/api/XpackUsageCounter.md index f31ac5f57..a35593d6f 100644 --- a/docs/reference/api/XpackUsageCounter.md +++ b/docs/reference/api/XpackUsageCounter.md @@ -1,4 +1,4 @@ -## Interface `XpackUsageCounter` +# `XpackUsageCounter` [interface-XpackUsageCounter] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/XpackUsageDataStreams.md b/docs/reference/api/XpackUsageDataStreams.md index e1137b226..423e1518b 100644 --- a/docs/reference/api/XpackUsageDataStreams.md +++ b/docs/reference/api/XpackUsageDataStreams.md @@ -1,4 +1,4 @@ -## Interface `XpackUsageDataStreams` +# `XpackUsageDataStreams` [interface-XpackUsageDataStreams] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/XpackUsageDataTierPhaseStatistics.md b/docs/reference/api/XpackUsageDataTierPhaseStatistics.md index be3f5af3c..98227df94 100644 --- a/docs/reference/api/XpackUsageDataTierPhaseStatistics.md +++ b/docs/reference/api/XpackUsageDataTierPhaseStatistics.md @@ -1,4 +1,4 @@ -## Interface `XpackUsageDataTierPhaseStatistics` +# `XpackUsageDataTierPhaseStatistics` [interface-XpackUsageDataTierPhaseStatistics] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/XpackUsageDataTiers.md b/docs/reference/api/XpackUsageDataTiers.md index fd286e2f2..be3f0ee9b 100644 --- a/docs/reference/api/XpackUsageDataTiers.md +++ b/docs/reference/api/XpackUsageDataTiers.md @@ -1,4 +1,4 @@ -## Interface `XpackUsageDataTiers` +# `XpackUsageDataTiers` [interface-XpackUsageDataTiers] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/XpackUsageDatafeed.md b/docs/reference/api/XpackUsageDatafeed.md index 9ab52d948..f98dcc803 100644 --- a/docs/reference/api/XpackUsageDatafeed.md +++ b/docs/reference/api/XpackUsageDatafeed.md @@ -1,4 +1,4 @@ -## Interface `XpackUsageDatafeed` +# `XpackUsageDatafeed` [interface-XpackUsageDatafeed] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/XpackUsageEql.md b/docs/reference/api/XpackUsageEql.md index bf676576f..8ebcdd53a 100644 --- a/docs/reference/api/XpackUsageEql.md +++ b/docs/reference/api/XpackUsageEql.md @@ -1,4 +1,4 @@ -## Interface `XpackUsageEql` +# `XpackUsageEql` [interface-XpackUsageEql] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/XpackUsageEqlFeatures.md b/docs/reference/api/XpackUsageEqlFeatures.md index a8f57cfdc..b3275068e 100644 --- a/docs/reference/api/XpackUsageEqlFeatures.md +++ b/docs/reference/api/XpackUsageEqlFeatures.md @@ -1,4 +1,4 @@ -## Interface `XpackUsageEqlFeatures` +# `XpackUsageEqlFeatures` [interface-XpackUsageEqlFeatures] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/XpackUsageEqlFeaturesJoin.md b/docs/reference/api/XpackUsageEqlFeaturesJoin.md index aaed538cb..c8dcd9587 100644 --- a/docs/reference/api/XpackUsageEqlFeaturesJoin.md +++ b/docs/reference/api/XpackUsageEqlFeaturesJoin.md @@ -1,4 +1,4 @@ -## Interface `XpackUsageEqlFeaturesJoin` +# `XpackUsageEqlFeaturesJoin` [interface-XpackUsageEqlFeaturesJoin] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/XpackUsageEqlFeaturesKeys.md b/docs/reference/api/XpackUsageEqlFeaturesKeys.md index f1e523461..fe5450279 100644 --- a/docs/reference/api/XpackUsageEqlFeaturesKeys.md +++ b/docs/reference/api/XpackUsageEqlFeaturesKeys.md @@ -1,4 +1,4 @@ -## Interface `XpackUsageEqlFeaturesKeys` +# `XpackUsageEqlFeaturesKeys` [interface-XpackUsageEqlFeaturesKeys] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/XpackUsageEqlFeaturesPipes.md b/docs/reference/api/XpackUsageEqlFeaturesPipes.md index 3a3f8bad5..90a3949a1 100644 --- a/docs/reference/api/XpackUsageEqlFeaturesPipes.md +++ b/docs/reference/api/XpackUsageEqlFeaturesPipes.md @@ -1,4 +1,4 @@ -## Interface `XpackUsageEqlFeaturesPipes` +# `XpackUsageEqlFeaturesPipes` [interface-XpackUsageEqlFeaturesPipes] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/XpackUsageEqlFeaturesSequences.md b/docs/reference/api/XpackUsageEqlFeaturesSequences.md index a620710bd..8adc89f3e 100644 --- a/docs/reference/api/XpackUsageEqlFeaturesSequences.md +++ b/docs/reference/api/XpackUsageEqlFeaturesSequences.md @@ -1,4 +1,4 @@ -## Interface `XpackUsageEqlFeaturesSequences` +# `XpackUsageEqlFeaturesSequences` [interface-XpackUsageEqlFeaturesSequences] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/XpackUsageFeatureToggle.md b/docs/reference/api/XpackUsageFeatureToggle.md index f005b84d3..a45737c0b 100644 --- a/docs/reference/api/XpackUsageFeatureToggle.md +++ b/docs/reference/api/XpackUsageFeatureToggle.md @@ -1,4 +1,4 @@ -## Interface `XpackUsageFeatureToggle` +# `XpackUsageFeatureToggle` [interface-XpackUsageFeatureToggle] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/XpackUsageFlattened.md b/docs/reference/api/XpackUsageFlattened.md index 65cabca7d..81bd78080 100644 --- a/docs/reference/api/XpackUsageFlattened.md +++ b/docs/reference/api/XpackUsageFlattened.md @@ -1,4 +1,4 @@ -## Interface `XpackUsageFlattened` +# `XpackUsageFlattened` [interface-XpackUsageFlattened] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/XpackUsageHealthStatistics.md b/docs/reference/api/XpackUsageHealthStatistics.md index d442df5d6..b8906178a 100644 --- a/docs/reference/api/XpackUsageHealthStatistics.md +++ b/docs/reference/api/XpackUsageHealthStatistics.md @@ -1,4 +1,4 @@ -## Interface `XpackUsageHealthStatistics` +# `XpackUsageHealthStatistics` [interface-XpackUsageHealthStatistics] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/XpackUsageIlm.md b/docs/reference/api/XpackUsageIlm.md index b5cd7fc01..1469301db 100644 --- a/docs/reference/api/XpackUsageIlm.md +++ b/docs/reference/api/XpackUsageIlm.md @@ -1,4 +1,4 @@ -## Interface `XpackUsageIlm` +# `XpackUsageIlm` [interface-XpackUsageIlm] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/XpackUsageIlmPolicyStatistics.md b/docs/reference/api/XpackUsageIlmPolicyStatistics.md index f5242b7e1..ebd52efa7 100644 --- a/docs/reference/api/XpackUsageIlmPolicyStatistics.md +++ b/docs/reference/api/XpackUsageIlmPolicyStatistics.md @@ -1,4 +1,4 @@ -## Interface `XpackUsageIlmPolicyStatistics` +# `XpackUsageIlmPolicyStatistics` [interface-XpackUsageIlmPolicyStatistics] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/XpackUsageInvocations.md b/docs/reference/api/XpackUsageInvocations.md index 258bbe0d6..b52971059 100644 --- a/docs/reference/api/XpackUsageInvocations.md +++ b/docs/reference/api/XpackUsageInvocations.md @@ -1,4 +1,4 @@ -## Interface `XpackUsageInvocations` +# `XpackUsageInvocations` [interface-XpackUsageInvocations] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/XpackUsageIpFilter.md b/docs/reference/api/XpackUsageIpFilter.md index 2806edf23..2055feb33 100644 --- a/docs/reference/api/XpackUsageIpFilter.md +++ b/docs/reference/api/XpackUsageIpFilter.md @@ -1,4 +1,4 @@ -## Interface `XpackUsageIpFilter` +# `XpackUsageIpFilter` [interface-XpackUsageIpFilter] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/XpackUsageJobUsage.md b/docs/reference/api/XpackUsageJobUsage.md index 0a7a922e0..9c54ae809 100644 --- a/docs/reference/api/XpackUsageJobUsage.md +++ b/docs/reference/api/XpackUsageJobUsage.md @@ -1,4 +1,4 @@ -## Interface `XpackUsageJobUsage` +# `XpackUsageJobUsage` [interface-XpackUsageJobUsage] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/XpackUsageMachineLearning.md b/docs/reference/api/XpackUsageMachineLearning.md index 8723a97d5..f986010fb 100644 --- a/docs/reference/api/XpackUsageMachineLearning.md +++ b/docs/reference/api/XpackUsageMachineLearning.md @@ -1,4 +1,4 @@ -## Interface `XpackUsageMachineLearning` +# `XpackUsageMachineLearning` [interface-XpackUsageMachineLearning] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/XpackUsageMlCounter.md b/docs/reference/api/XpackUsageMlCounter.md index 2a1963d07..4a7fddf72 100644 --- a/docs/reference/api/XpackUsageMlCounter.md +++ b/docs/reference/api/XpackUsageMlCounter.md @@ -1,4 +1,4 @@ -## Interface `XpackUsageMlCounter` +# `XpackUsageMlCounter` [interface-XpackUsageMlCounter] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/XpackUsageMlDataFrameAnalyticsJobs.md b/docs/reference/api/XpackUsageMlDataFrameAnalyticsJobs.md index 1a9597e10..ca71b8cc1 100644 --- a/docs/reference/api/XpackUsageMlDataFrameAnalyticsJobs.md +++ b/docs/reference/api/XpackUsageMlDataFrameAnalyticsJobs.md @@ -1,4 +1,4 @@ -## Interface `XpackUsageMlDataFrameAnalyticsJobs` +# `XpackUsageMlDataFrameAnalyticsJobs` [interface-XpackUsageMlDataFrameAnalyticsJobs] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/XpackUsageMlDataFrameAnalyticsJobsAnalysis.md b/docs/reference/api/XpackUsageMlDataFrameAnalyticsJobsAnalysis.md index 90c209528..db5e05522 100644 --- a/docs/reference/api/XpackUsageMlDataFrameAnalyticsJobsAnalysis.md +++ b/docs/reference/api/XpackUsageMlDataFrameAnalyticsJobsAnalysis.md @@ -1,4 +1,4 @@ -## Interface `XpackUsageMlDataFrameAnalyticsJobsAnalysis` +# `XpackUsageMlDataFrameAnalyticsJobsAnalysis` [interface-XpackUsageMlDataFrameAnalyticsJobsAnalysis] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/XpackUsageMlDataFrameAnalyticsJobsCount.md b/docs/reference/api/XpackUsageMlDataFrameAnalyticsJobsCount.md index 2e9952165..0f34a2e45 100644 --- a/docs/reference/api/XpackUsageMlDataFrameAnalyticsJobsCount.md +++ b/docs/reference/api/XpackUsageMlDataFrameAnalyticsJobsCount.md @@ -1,4 +1,4 @@ -## Interface `XpackUsageMlDataFrameAnalyticsJobsCount` +# `XpackUsageMlDataFrameAnalyticsJobsCount` [interface-XpackUsageMlDataFrameAnalyticsJobsCount] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/XpackUsageMlDataFrameAnalyticsJobsMemory.md b/docs/reference/api/XpackUsageMlDataFrameAnalyticsJobsMemory.md index 2c97e8bf7..8da053f3b 100644 --- a/docs/reference/api/XpackUsageMlDataFrameAnalyticsJobsMemory.md +++ b/docs/reference/api/XpackUsageMlDataFrameAnalyticsJobsMemory.md @@ -1,4 +1,4 @@ -## Interface `XpackUsageMlDataFrameAnalyticsJobsMemory` +# `XpackUsageMlDataFrameAnalyticsJobsMemory` [interface-XpackUsageMlDataFrameAnalyticsJobsMemory] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/XpackUsageMlInference.md b/docs/reference/api/XpackUsageMlInference.md index 6995e3a81..f20ab8f18 100644 --- a/docs/reference/api/XpackUsageMlInference.md +++ b/docs/reference/api/XpackUsageMlInference.md @@ -1,4 +1,4 @@ -## Interface `XpackUsageMlInference` +# `XpackUsageMlInference` [interface-XpackUsageMlInference] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/XpackUsageMlInferenceDeployments.md b/docs/reference/api/XpackUsageMlInferenceDeployments.md index 71fc0e8f3..e2cf78687 100644 --- a/docs/reference/api/XpackUsageMlInferenceDeployments.md +++ b/docs/reference/api/XpackUsageMlInferenceDeployments.md @@ -1,4 +1,4 @@ -## Interface `XpackUsageMlInferenceDeployments` +# `XpackUsageMlInferenceDeployments` [interface-XpackUsageMlInferenceDeployments] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/XpackUsageMlInferenceDeploymentsTimeMs.md b/docs/reference/api/XpackUsageMlInferenceDeploymentsTimeMs.md index 2962442c9..af7512855 100644 --- a/docs/reference/api/XpackUsageMlInferenceDeploymentsTimeMs.md +++ b/docs/reference/api/XpackUsageMlInferenceDeploymentsTimeMs.md @@ -1,4 +1,4 @@ -## Interface `XpackUsageMlInferenceDeploymentsTimeMs` +# `XpackUsageMlInferenceDeploymentsTimeMs` [interface-XpackUsageMlInferenceDeploymentsTimeMs] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/XpackUsageMlInferenceIngestProcessor.md b/docs/reference/api/XpackUsageMlInferenceIngestProcessor.md index 1d0faf3a5..daf1fa000 100644 --- a/docs/reference/api/XpackUsageMlInferenceIngestProcessor.md +++ b/docs/reference/api/XpackUsageMlInferenceIngestProcessor.md @@ -1,4 +1,4 @@ -## Interface `XpackUsageMlInferenceIngestProcessor` +# `XpackUsageMlInferenceIngestProcessor` [interface-XpackUsageMlInferenceIngestProcessor] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/XpackUsageMlInferenceIngestProcessorCount.md b/docs/reference/api/XpackUsageMlInferenceIngestProcessorCount.md index 9b8801d03..6e2792df7 100644 --- a/docs/reference/api/XpackUsageMlInferenceIngestProcessorCount.md +++ b/docs/reference/api/XpackUsageMlInferenceIngestProcessorCount.md @@ -1,4 +1,4 @@ -## Interface `XpackUsageMlInferenceIngestProcessorCount` +# `XpackUsageMlInferenceIngestProcessorCount` [interface-XpackUsageMlInferenceIngestProcessorCount] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/XpackUsageMlInferenceTrainedModels.md b/docs/reference/api/XpackUsageMlInferenceTrainedModels.md index af7c74fbc..260bde2fc 100644 --- a/docs/reference/api/XpackUsageMlInferenceTrainedModels.md +++ b/docs/reference/api/XpackUsageMlInferenceTrainedModels.md @@ -1,4 +1,4 @@ -## Interface `XpackUsageMlInferenceTrainedModels` +# `XpackUsageMlInferenceTrainedModels` [interface-XpackUsageMlInferenceTrainedModels] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/XpackUsageMlInferenceTrainedModelsCount.md b/docs/reference/api/XpackUsageMlInferenceTrainedModelsCount.md index 2bed7a914..eeadaadc7 100644 --- a/docs/reference/api/XpackUsageMlInferenceTrainedModelsCount.md +++ b/docs/reference/api/XpackUsageMlInferenceTrainedModelsCount.md @@ -1,4 +1,4 @@ -## Interface `XpackUsageMlInferenceTrainedModelsCount` +# `XpackUsageMlInferenceTrainedModelsCount` [interface-XpackUsageMlInferenceTrainedModelsCount] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/XpackUsageMlJobForecasts.md b/docs/reference/api/XpackUsageMlJobForecasts.md index a3736fa28..dd3bf4a9d 100644 --- a/docs/reference/api/XpackUsageMlJobForecasts.md +++ b/docs/reference/api/XpackUsageMlJobForecasts.md @@ -1,4 +1,4 @@ -## Interface `XpackUsageMlJobForecasts` +# `XpackUsageMlJobForecasts` [interface-XpackUsageMlJobForecasts] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/XpackUsageMonitoring.md b/docs/reference/api/XpackUsageMonitoring.md index 1a3e8e93e..974453c17 100644 --- a/docs/reference/api/XpackUsageMonitoring.md +++ b/docs/reference/api/XpackUsageMonitoring.md @@ -1,4 +1,4 @@ -## Interface `XpackUsageMonitoring` +# `XpackUsageMonitoring` [interface-XpackUsageMonitoring] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/XpackUsagePhase.md b/docs/reference/api/XpackUsagePhase.md index f5b04698d..77177994e 100644 --- a/docs/reference/api/XpackUsagePhase.md +++ b/docs/reference/api/XpackUsagePhase.md @@ -1,4 +1,4 @@ -## Interface `XpackUsagePhase` +# `XpackUsagePhase` [interface-XpackUsagePhase] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/XpackUsagePhases.md b/docs/reference/api/XpackUsagePhases.md index 29f6dd668..12088f701 100644 --- a/docs/reference/api/XpackUsagePhases.md +++ b/docs/reference/api/XpackUsagePhases.md @@ -1,4 +1,4 @@ -## Interface `XpackUsagePhases` +# `XpackUsagePhases` [interface-XpackUsagePhases] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/XpackUsageQuery.md b/docs/reference/api/XpackUsageQuery.md index 45b9e298c..194c83501 100644 --- a/docs/reference/api/XpackUsageQuery.md +++ b/docs/reference/api/XpackUsageQuery.md @@ -1,4 +1,4 @@ -## Interface `XpackUsageQuery` +# `XpackUsageQuery` [interface-XpackUsageQuery] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/XpackUsageRealm.md b/docs/reference/api/XpackUsageRealm.md index 7c665c820..df8f9f583 100644 --- a/docs/reference/api/XpackUsageRealm.md +++ b/docs/reference/api/XpackUsageRealm.md @@ -1,4 +1,4 @@ -## Interface `XpackUsageRealm` +# `XpackUsageRealm` [interface-XpackUsageRealm] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/XpackUsageRealmCache.md b/docs/reference/api/XpackUsageRealmCache.md index 09e6a9e71..3651a89aa 100644 --- a/docs/reference/api/XpackUsageRealmCache.md +++ b/docs/reference/api/XpackUsageRealmCache.md @@ -1,4 +1,4 @@ -## Interface `XpackUsageRealmCache` +# `XpackUsageRealmCache` [interface-XpackUsageRealmCache] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/XpackUsageRequest.md b/docs/reference/api/XpackUsageRequest.md index 277947ac4..c5f9e2904 100644 --- a/docs/reference/api/XpackUsageRequest.md +++ b/docs/reference/api/XpackUsageRequest.md @@ -1,4 +1,4 @@ -## Interface `XpackUsageRequest` +# `XpackUsageRequest` [interface-XpackUsageRequest] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/XpackUsageResponse.md b/docs/reference/api/XpackUsageResponse.md index 4d43f1ee7..4ac3078f2 100644 --- a/docs/reference/api/XpackUsageResponse.md +++ b/docs/reference/api/XpackUsageResponse.md @@ -1,4 +1,4 @@ -## Interface `XpackUsageResponse` +# `XpackUsageResponse` [interface-XpackUsageResponse] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/XpackUsageRoleMapping.md b/docs/reference/api/XpackUsageRoleMapping.md index e56f6be9f..e4bf306cc 100644 --- a/docs/reference/api/XpackUsageRoleMapping.md +++ b/docs/reference/api/XpackUsageRoleMapping.md @@ -1,4 +1,4 @@ -## Interface `XpackUsageRoleMapping` +# `XpackUsageRoleMapping` [interface-XpackUsageRoleMapping] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/XpackUsageRuntimeFieldTypes.md b/docs/reference/api/XpackUsageRuntimeFieldTypes.md index a9a1cf5d5..ccf495439 100644 --- a/docs/reference/api/XpackUsageRuntimeFieldTypes.md +++ b/docs/reference/api/XpackUsageRuntimeFieldTypes.md @@ -1,4 +1,4 @@ -## Interface `XpackUsageRuntimeFieldTypes` +# `XpackUsageRuntimeFieldTypes` [interface-XpackUsageRuntimeFieldTypes] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/XpackUsageRuntimeFieldsType.md b/docs/reference/api/XpackUsageRuntimeFieldsType.md index 013ad36a9..4905a4d11 100644 --- a/docs/reference/api/XpackUsageRuntimeFieldsType.md +++ b/docs/reference/api/XpackUsageRuntimeFieldsType.md @@ -1,4 +1,4 @@ -## Interface `XpackUsageRuntimeFieldsType` +# `XpackUsageRuntimeFieldsType` [interface-XpackUsageRuntimeFieldsType] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/XpackUsageSearchableSnapshots.md b/docs/reference/api/XpackUsageSearchableSnapshots.md index 16bdf0c14..c088a5086 100644 --- a/docs/reference/api/XpackUsageSearchableSnapshots.md +++ b/docs/reference/api/XpackUsageSearchableSnapshots.md @@ -1,4 +1,4 @@ -## Interface `XpackUsageSearchableSnapshots` +# `XpackUsageSearchableSnapshots` [interface-XpackUsageSearchableSnapshots] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/XpackUsageSecurity.md b/docs/reference/api/XpackUsageSecurity.md index 0f6cd9774..2daeae5c9 100644 --- a/docs/reference/api/XpackUsageSecurity.md +++ b/docs/reference/api/XpackUsageSecurity.md @@ -1,4 +1,4 @@ -## Interface `XpackUsageSecurity` +# `XpackUsageSecurity` [interface-XpackUsageSecurity] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/XpackUsageSecurityRoles.md b/docs/reference/api/XpackUsageSecurityRoles.md index 00203010c..2b705f522 100644 --- a/docs/reference/api/XpackUsageSecurityRoles.md +++ b/docs/reference/api/XpackUsageSecurityRoles.md @@ -1,4 +1,4 @@ -## Interface `XpackUsageSecurityRoles` +# `XpackUsageSecurityRoles` [interface-XpackUsageSecurityRoles] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/XpackUsageSecurityRolesDls.md b/docs/reference/api/XpackUsageSecurityRolesDls.md index 0981d2eba..cce2ae5eb 100644 --- a/docs/reference/api/XpackUsageSecurityRolesDls.md +++ b/docs/reference/api/XpackUsageSecurityRolesDls.md @@ -1,4 +1,4 @@ -## Interface `XpackUsageSecurityRolesDls` +# `XpackUsageSecurityRolesDls` [interface-XpackUsageSecurityRolesDls] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/XpackUsageSecurityRolesDlsBitSetCache.md b/docs/reference/api/XpackUsageSecurityRolesDlsBitSetCache.md index c78d236bf..c4b2741ff 100644 --- a/docs/reference/api/XpackUsageSecurityRolesDlsBitSetCache.md +++ b/docs/reference/api/XpackUsageSecurityRolesDlsBitSetCache.md @@ -1,4 +1,4 @@ -## Interface `XpackUsageSecurityRolesDlsBitSetCache` +# `XpackUsageSecurityRolesDlsBitSetCache` [interface-XpackUsageSecurityRolesDlsBitSetCache] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/XpackUsageSecurityRolesFile.md b/docs/reference/api/XpackUsageSecurityRolesFile.md index 6948b259b..c8ce7782e 100644 --- a/docs/reference/api/XpackUsageSecurityRolesFile.md +++ b/docs/reference/api/XpackUsageSecurityRolesFile.md @@ -1,4 +1,4 @@ -## Interface `XpackUsageSecurityRolesFile` +# `XpackUsageSecurityRolesFile` [interface-XpackUsageSecurityRolesFile] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/XpackUsageSecurityRolesNative.md b/docs/reference/api/XpackUsageSecurityRolesNative.md index 2a5e8fe75..e6018131c 100644 --- a/docs/reference/api/XpackUsageSecurityRolesNative.md +++ b/docs/reference/api/XpackUsageSecurityRolesNative.md @@ -1,4 +1,4 @@ -## Interface `XpackUsageSecurityRolesNative` +# `XpackUsageSecurityRolesNative` [interface-XpackUsageSecurityRolesNative] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/XpackUsageSlm.md b/docs/reference/api/XpackUsageSlm.md index fb94e4490..e16a6cd2d 100644 --- a/docs/reference/api/XpackUsageSlm.md +++ b/docs/reference/api/XpackUsageSlm.md @@ -1,4 +1,4 @@ -## Interface `XpackUsageSlm` +# `XpackUsageSlm` [interface-XpackUsageSlm] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/XpackUsageSql.md b/docs/reference/api/XpackUsageSql.md index a82039d4f..8e63e5862 100644 --- a/docs/reference/api/XpackUsageSql.md +++ b/docs/reference/api/XpackUsageSql.md @@ -1,4 +1,4 @@ -## Interface `XpackUsageSql` +# `XpackUsageSql` [interface-XpackUsageSql] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/XpackUsageSsl.md b/docs/reference/api/XpackUsageSsl.md index 82a95065e..9dd413216 100644 --- a/docs/reference/api/XpackUsageSsl.md +++ b/docs/reference/api/XpackUsageSsl.md @@ -1,4 +1,4 @@ -## Interface `XpackUsageSsl` +# `XpackUsageSsl` [interface-XpackUsageSsl] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/XpackUsageVector.md b/docs/reference/api/XpackUsageVector.md index cf0a36ed8..3d85b932f 100644 --- a/docs/reference/api/XpackUsageVector.md +++ b/docs/reference/api/XpackUsageVector.md @@ -1,4 +1,4 @@ -## Interface `XpackUsageVector` +# `XpackUsageVector` [interface-XpackUsageVector] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/XpackUsageWatcher.md b/docs/reference/api/XpackUsageWatcher.md index dd7872cb5..677e4515e 100644 --- a/docs/reference/api/XpackUsageWatcher.md +++ b/docs/reference/api/XpackUsageWatcher.md @@ -1,4 +1,4 @@ -## Interface `XpackUsageWatcher` +# `XpackUsageWatcher` [interface-XpackUsageWatcher] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/XpackUsageWatcherActionTotals.md b/docs/reference/api/XpackUsageWatcherActionTotals.md index 9017bdd21..dc00611db 100644 --- a/docs/reference/api/XpackUsageWatcherActionTotals.md +++ b/docs/reference/api/XpackUsageWatcherActionTotals.md @@ -1,4 +1,4 @@ -## Interface `XpackUsageWatcherActionTotals` +# `XpackUsageWatcherActionTotals` [interface-XpackUsageWatcherActionTotals] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/XpackUsageWatcherActions.md b/docs/reference/api/XpackUsageWatcherActions.md index 3a2d4e02e..4914c0c26 100644 --- a/docs/reference/api/XpackUsageWatcherActions.md +++ b/docs/reference/api/XpackUsageWatcherActions.md @@ -1,4 +1,4 @@ -## Interface `XpackUsageWatcherActions` +# `XpackUsageWatcherActions` [interface-XpackUsageWatcherActions] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/XpackUsageWatcherWatch.md b/docs/reference/api/XpackUsageWatcherWatch.md index aadb45a9a..cd9c56e17 100644 --- a/docs/reference/api/XpackUsageWatcherWatch.md +++ b/docs/reference/api/XpackUsageWatcherWatch.md @@ -1,4 +1,4 @@ -## Interface `XpackUsageWatcherWatch` +# `XpackUsageWatcherWatch` [interface-XpackUsageWatcherWatch] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/XpackUsageWatcherWatchTrigger.md b/docs/reference/api/XpackUsageWatcherWatchTrigger.md index c4572bfdf..28622f93e 100644 --- a/docs/reference/api/XpackUsageWatcherWatchTrigger.md +++ b/docs/reference/api/XpackUsageWatcherWatchTrigger.md @@ -1,4 +1,4 @@ -## Interface `XpackUsageWatcherWatchTrigger` +# `XpackUsageWatcherWatchTrigger` [interface-XpackUsageWatcherWatchTrigger] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/XpackUsageWatcherWatchTriggerSchedule.md b/docs/reference/api/XpackUsageWatcherWatchTriggerSchedule.md index 1eb3a9e49..60efa1dfd 100644 --- a/docs/reference/api/XpackUsageWatcherWatchTriggerSchedule.md +++ b/docs/reference/api/XpackUsageWatcherWatchTriggerSchedule.md @@ -1,4 +1,4 @@ -## Interface `XpackUsageWatcherWatchTriggerSchedule` +# `XpackUsageWatcherWatchTriggerSchedule` [interface-XpackUsageWatcherWatchTriggerSchedule] | Name | Type | Description | | - | - | - | diff --git a/docs/reference/api/byte.md b/docs/reference/api/byte.md index 98a472e84..35bb0b6ef 100644 --- a/docs/reference/api/byte.md +++ b/docs/reference/api/byte.md @@ -1,4 +1,4 @@ -## `byte` -::: +# `byte` [alias-byte] +```typescript type byte = number; -::: +``` diff --git a/docs/reference/api/double.md b/docs/reference/api/double.md index 385ded8a8..6bd943ad9 100644 --- a/docs/reference/api/double.md +++ b/docs/reference/api/double.md @@ -1,4 +1,4 @@ -## `double` -::: +# `double` [alias-double] +```typescript type double = number; -::: +``` diff --git a/docs/reference/api/float.md b/docs/reference/api/float.md index 668ba113b..a31f96969 100644 --- a/docs/reference/api/float.md +++ b/docs/reference/api/float.md @@ -1,4 +1,4 @@ -## `float` -::: +# `float` [alias-float] +```typescript type float = number; -::: +``` diff --git a/docs/reference/api/integer.md b/docs/reference/api/integer.md index 62d06e790..99bc03a04 100644 --- a/docs/reference/api/integer.md +++ b/docs/reference/api/integer.md @@ -1,4 +1,4 @@ -## `integer` -::: +# `integer` [alias-integer] +```typescript type integer = number; -::: +``` diff --git a/docs/reference/api/long.md b/docs/reference/api/long.md index db4818f0e..ed303c3e7 100644 --- a/docs/reference/api/long.md +++ b/docs/reference/api/long.md @@ -1,4 +1,4 @@ -## `long` -::: +# `long` [alias-long] +```typescript type long = number; -::: +``` diff --git a/docs/reference/api/short.md b/docs/reference/api/short.md index c6f58e5ba..3e0d47ef4 100644 --- a/docs/reference/api/short.md +++ b/docs/reference/api/short.md @@ -1,4 +1,4 @@ -## `short` -::: +# `short` [alias-short] +```typescript type short = number; -::: +``` diff --git a/docs/reference/api/uint.md b/docs/reference/api/uint.md index 228798433..a1793aa07 100644 --- a/docs/reference/api/uint.md +++ b/docs/reference/api/uint.md @@ -1,4 +1,4 @@ -## `uint` -::: +# `uint` [alias-uint] +```typescript type uint = number; -::: +``` diff --git a/docs/reference/api/ulong.md b/docs/reference/api/ulong.md index ad621a8ac..e2dc79ff1 100644 --- a/docs/reference/api/ulong.md +++ b/docs/reference/api/ulong.md @@ -1,4 +1,4 @@ -## `ulong` -::: +# `ulong` [alias-ulong] +```typescript type ulong = number; -::: +``` diff --git a/scripts/docgen.mjs b/scripts/docgen.mjs index 2f2ff1b94..eaa28806d 100644 --- a/scripts/docgen.mjs +++ b/scripts/docgen.mjs @@ -105,16 +105,15 @@ function generateDescription(comment) { } function generateApiFunction(spec) { - // let code = '```typescript\n' - let code = ':::\n' + let code = '```typescript\n' code += generatePropertyType(spec.excerptTokens) code += '\n' - code += ':::\n' + code += '```\n' return code } function generateInterface(spec) { - let code = `## Interface \`${spec.displayName}\`\n\n` + let code = `# \`${spec.displayName}\` [interface-${spec.displayName}]\n\n` code += '| Name | Type | Description |\n' code += '| - | - | - |\n' @@ -131,22 +130,21 @@ function generateInterface(spec) { } function generateClass(spec) { - let code = `## \`${spec.displayName}\`\n` + let code = `# \`${spec.displayName}\` [class-${spec.displayName}]\n` - code += '\n### Constructor\n\n' + code += '\n## Constructor\n\n' const cons = spec.members.filter(m => m.kind === 'Constructor') for (const con of cons) { - // code += '```typescript\n' - code += ':::\n' + code += '```typescript\n' code += generatePropertyType(con.excerptTokens).replace(/^constructor/, `new ${spec.displayName}`) code += '\n' - code += ':::\n' + code += '```\n' } // generate properties const props = spec.members.filter(m => m.kind === 'Property') if (props.length > 0) { - code += '\n### Properties\n\n' + code += `\n## Properties [class-properties-${spec.displayName}]\n\n` code += '| Name | Type | Description |\n' code += '| - | - | - |\n' @@ -165,7 +163,7 @@ function generateClass(spec) { // generate methods const methods = spec.members.filter(m => m.kind === 'Method') if (methods.length > 0) { - code += '\n### Methods\n\n' + code += `\n## Methods [class-methods-${spec.displayName}]\n\n` code += '| Name | Signature | Description |\n' code += '| - | - | - |\n' @@ -174,7 +172,7 @@ function generateClass(spec) { code += ` | \`${generatePropertyType(method.excerptTokens)}\`` const description = generateDescription(method.tsdocComment, false) code += ` | ${description.length > 0 ? description : ' '}` - code += ' |' + code += ' |\n' } } @@ -182,11 +180,10 @@ function generateClass(spec) { } function generateAlias(spec) { - let code = `## \`${spec.displayName}\`\n` - // code += '```typescript\n' - code += ':::\n' + let code = `# \`${spec.displayName}\` [alias-${spec.displayName}]\n` + code += '```typescript\n' code += `${generatePropertyType(spec.excerpt.tokens)}\n` - code += ':::\n' + code += '```\n' return code } From d68f2b566a87c83dd92d19a36de5238ff1b19a86 Mon Sep 17 00:00:00 2001 From: Josh Mock Date: Tue, 10 Jun 2025 14:56:07 -0500 Subject: [PATCH 7/7] WIP changes to docgen --- scripts/docgen.mjs | 222 +++++++++++++++++++++++++++++++++++++-------- 1 file changed, 183 insertions(+), 39 deletions(-) diff --git a/scripts/docgen.mjs b/scripts/docgen.mjs index eaa28806d..795657053 100644 --- a/scripts/docgen.mjs +++ b/scripts/docgen.mjs @@ -5,6 +5,7 @@ import path from 'node:path' import fs from 'node:fs/promises' +import { rimraf } from 'rimraf' import * as Extractor from '@microsoft/api-extractor-model' const header = `