@terascope/types / elasticsearch-interfaces

elasticsearch-interfaces

Enumerations

Enumeration	Description
ElasticsearchDistribution	-

Interfaces

Interface	Description
AggregationsAggregateBase	-
AggregationsAutoDateHistogramAggregate	-
AggregationsBoxPlotAggregate	-
AggregationsBucketAggregate	-
AggregationsCompositeBucketAggregate	-
AggregationsExtendedStatsAggregate	-
AggregationsFiltersAggregate	-
AggregationsFiltersBucketItemKeys	-
AggregationsGeoBounds	-
AggregationsGeoBoundsAggregate	-
AggregationsGeoCentroidAggregate	-
AggregationsGeoLineAggregate	-
AggregationsGeoLineProperties	-
AggregationsHdrPercentileItem	-
AggregationsHdrPercentilesAggregate	-
AggregationsKeyedBucketKeys	-
AggregationsKeyedValueAggregate	-
AggregationsLineStringGeoShape	-
AggregationsMatrixStatsAggregate	-
AggregationsMultiBucketAggregate	-
AggregationsPercentileItem	-
AggregationsPercentilesAggregate	-
AggregationsScriptedMetricAggregate	-
AggregationsSignificantTermsAggregate	-
AggregationsSingleBucketAggregateKeys	-
AggregationsStandardDeviationBounds	-
AggregationsStatsAggregate	-
AggregationsStringStatsAggregate	-
AggregationsTDigestPercentilesAggregate	-
AggregationsTermsAggregate	-
AggregationsTopHitsAggregate	-
AggregationsTopMetrics	-
AggregationsTopMetricsAggregate	-
AggregationsValueAggregate	-
Alias	-
AnalysisCharFilterBase	-
AnalysisMappingCharFilter	-
AnalysisPatternReplaceTokenFilter	-
AnalysisTokenFilterBase	-
BulkIndexByScrollFailure	-
BulkOperation	-
BulkOperationContainer	-
BulkResponseItemBase	-
BulkResponseItemContainer	-
BulkStats	-
BulkUpdateAction	-
CatIndicesIndicesRecord	-
ClientMetadata	-
ClusterHealthIndexHealthStats	-
ClusterHealthShardHealthStats	-
CompletionStats	-
DictionaryResponseBase	-
DocStats	-
ElasticsearchDSLOptions	-
ErrorCauseKeys	-
ESIndexSettings	-
ESMapping	-
ESTypeMappings	-
ExistsQuery	-
ExplainExplanation	-
ExplainExplanationDetail	-
FielddataStats	-
FieldMemoryUsage	-
FieldSizeUsage	-
FlushStats	-
GeoHashLocation	-
GeoQuery	-
GetStats	-
HitsTotal	-
IndexedScript	-
IndexingStats	-
IndexTemplate	-
IndexTemplateProperties	-
IndicesAlias	-
IndicesFielddataFrequencyFilter	-
IndicesGetFieldMappingTypeFieldMappings	-
IndicesGetMappingIndexMappingRecord	-
IndicesIndexRouting	-
IndicesIndexRoutingAllocation	-
IndicesIndexRoutingAllocationDisk	-
IndicesIndexRoutingAllocationInclude	-
IndicesIndexRoutingAllocationInitialRecovery	-
IndicesIndexRoutingRebalance	-
IndicesIndexSettingBlocks	-
IndicesIndexSettings	-
IndicesIndexSettingsAnalysis	-
IndicesIndexSettingsLifecycle	-
IndicesIndexState	-
IndicesIndexStatePrefixedSettings	-
IndicesIndexVersioning	-
IndicesNumericFielddata	-
IndicesPutMappingTypeFieldMappings	-
IndicesPutSettingsIndexSettingsBody	-
IndicesRecoveryFileDetails	-
IndicesRecoveryRecoveryBytes	-
IndicesRecoveryRecoveryFiles	-
IndicesRecoveryRecoveryIndexStatus	-
IndicesRecoveryRecoveryOrigin	-
IndicesRecoveryRecoveryStartStatus	-
IndicesRecoveryRecoveryStatus	-
IndicesRecoveryShardRecovery	-
IndicesRecoveryTranslogStatus	-
IndicesRecoveryVerifyIndex	-
IndicesResponseBase	-
IndicesStatsIndexStats	-
IndicesStatsIndicesStats	-
IndicesStatsShardCommit	-
IndicesStatsShardFileSizeInfo	-
IndicesStatsShardLease	-
IndicesStatsShardPath	-
IndicesStatsShardQueryCache	-
IndicesStatsShardRetentionLeases	-
IndicesStatsShardRouting	-
IndicesStatsShardSequenceNumber	-
IndicesStatsShardStats	-
IndicesValidateQueryIndicesValidationExplanation	-
IndividualResponse	-
InlineGet	-
InlineScript	-
KNNQuery	-
LatLon	-
LatLonGeoLocation	-
MappingAllField	-
MappingBinaryProperty	-
MappingBooleanProperty	-
MappingByteNumberProperty	-
MappingCompletionProperty	-
MappingConstantKeywordProperty	-
MappingCorePropertyBase	-
MappingDateNanosProperty	-
MappingDateProperty	-
MappingDateRangeProperty	-
MappingDocValuesPropertyBase	-
MappingDoubleNumberProperty	-
MappingDoubleRangeProperty	-
MappingDynamicTemplate	-
MappingFieldAliasProperty	-
MappingFieldMapping	-
MappingFieldNamesField	-
MappingFlattenedProperty	-
MappingFloatNumberProperty	-
MappingFloatRangeProperty	-
MappingGeoPointProperty	-
MappingGeoShapeProperty	-
MappingHalfFloatNumberProperty	-
MappingHistogramProperty	-
MappingIndexField	-
MappingIntegerNumberProperty	-
MappingIntegerRangeProperty	-
MappingIpProperty	-
MappingIpRangeProperty	-
MappingJoinProperty	-
MappingKeywordProperty	-
MappingLongNumberProperty	-
MappingLongRangeProperty	-
MappingMurmur3HashProperty	-
MappingNestedProperty	-
MappingNumberPropertyBase	-
MappingObjectProperty	-
MappingPercolatorProperty	-
MappingPointProperty	-
MappingPropertyBase	-
MappingRangePropertyBase	-
MappingRankFeatureProperty	-
MappingRankFeaturesProperty	-
MappingRoutingField	-
MappingRuntimeField	-
MappingScaledFloatNumberProperty	-
MappingSearchAsYouTypeProperty	-
MappingShapeProperty	-
MappingShortNumberProperty	-
MappingSizeField	-
MappingSourceField	-
MappingStandardNumberProperty	-
MappingSuggestContext	-
MappingTextIndexPrefixes	-
MappingTextProperty	-
MappingTokenCountProperty	-
MappingTypeMapping	-
MappingUnsignedLongNumberProperty	-
MappingVersionProperty	-
MappingWildcardProperty	-
MatchPhraseQuery	-
MatchQuery	-
MergesStats	-
MGetBody	-
MGetDocs	-
MSearchBody	-
MSearchHeader	-
MultiMatchQuery	-
NodesAdaptiveSelection	-
NodesBreaker	-
NodesCpu	-
NodesDataPathStats	-
NodesExtendedMemoryStats	-
NodesFileSystem	-
NodesFileSystemTotal	-
NodesGarbageCollector	-
NodesGarbageCollectorTotal	-
NodesInfoNodeInfo	-
NodesInfoNodeInfoAction	-
NodesInfoNodeInfoAggregation	-
NodesInfoNodeInfoBootstrap	-
NodesInfoNodeInfoClient	-
NodesInfoNodeInfoDiscover	-
NodesInfoNodeInfoHttp	-
NodesInfoNodeInfoIngest	-
NodesInfoNodeInfoIngestProcessor	-
NodesInfoNodeInfoJvmMemory	-
NodesInfoNodeInfoMemory	-
NodesInfoNodeInfoNetwork	-
NodesInfoNodeInfoNetworkInterface	-
NodesInfoNodeInfoOSCPU	-
NodesInfoNodeInfoPath	-
NodesInfoNodeInfoRepositories	-
NodesInfoNodeInfoRepositoriesUrl	-
NodesInfoNodeInfoScript	-
NodesInfoNodeInfoSearch	-
NodesInfoNodeInfoSearchRemote	-
NodesInfoNodeInfoSettings	-
NodesInfoNodeInfoSettingsCluster	-
NodesInfoNodeInfoSettingsClusterElection	-
NodesInfoNodeInfoSettingsHttp	-
NodesInfoNodeInfoSettingsHttpType	-
NodesInfoNodeInfoSettingsNetwork	-
NodesInfoNodeInfoSettingsNode	-
NodesInfoNodeInfoSettingsTransport	-
NodesInfoNodeInfoSettingsTransportType	-
NodesInfoNodeInfoTransport	-
NodesInfoNodeJvmInfo	-
NodesInfoNodeOperatingSystemInfo	-
NodesInfoNodeProcessInfo	-
NodesInfoNodeThreadPoolInfo	-
NodesIngest	-
NodesIngestTotal	-
NodesJvm	-
NodesJvmClasses	-
NodesJvmThreads	-
NodesKeyedProcessor	-
NodesMemoryStats	-
NodesNodeBufferPool	-
NodesOperatingSystem	-
NodesProcess	-
NodesScripting	-
NodesStats	-
NodeStatistics	-
NodesThreadCount	-
NodesTransport	-
PluginStats	-
QueryCacheStats	-
QueryDslThreeDimensionalPoint	-
QueryStringQuery	-
RangeExpression	-
RangeQuery	-
RecoveryStats	-
RefreshStats	-
RegExprQuery	-
ReindexBody	-
Remote	-
RequestCacheStats	-
ScriptBase	-
SearchHitsMetadata	-
SearchInnerHitsMetadata	-
SearchInnerHitsResult	-
SearchNestedIdentity	-
SearchRecordResponse	-
SearchResult	-
SearchSourceFilter	-
SearchStats	-
SearchTotalHits	-
SegmentsStats	-
ShardFailure	-
ShardStatistics	-
StoreStats	-
TemplateBody	-
TermQuery	-
TranslogStats	-
WarmerStats	-
WildcardQuery	-
WriteResponseBase	-

Type Aliases

Action

Action = "Error" | "created" | "updated" | "deleted" | "not_found" | "noop"

Defined in: packages/types/src/elasticsearch-interfaces.ts:361

---

AggregationsAggregate

AggregationsAggregate = AggregationsSingleBucketAggregate | AggregationsAutoDateHistogramAggregate | AggregationsFiltersAggregate | AggregationsSignificantTermsAggregate<any> | AggregationsTermsAggregate<any> | AggregationsBucketAggregate | AggregationsCompositeBucketAggregate | AggregationsMultiBucketAggregate<AggregationsBucket> | AggregationsMatrixStatsAggregate | AggregationsKeyedValueAggregate | AggregationsMetricAggregate

Defined in: packages/types/src/elasticsearch-interfaces.ts:2463

---

AggregationsBucket

AggregationsBucket = AggregationsValueBucket | AggregationsKeyedBucket<any>

Defined in: packages/types/src/elasticsearch-interfaces.ts:2486

---

AggregationsFiltersBucketItem

AggregationsFiltersBucketItem = AggregationsFiltersBucketItemKeys | {[property: string]: AggregationsAggregate; }

Defined in: packages/types/src/elasticsearch-interfaces.ts:2725

---

AggregationsKeyedBucket<TKey>

AggregationsKeyedBucket<TKey> = AggregationsKeyedBucketKeys<TKey> | {[property: string]: AggregationsAggregate; }

Defined in: packages/types/src/elasticsearch-interfaces.ts:2749

Type Parameters

Type Parameter	Default type
TKey	unknown

---

AggregationsMetricAggregate

AggregationsMetricAggregate = AggregationsValueAggregate | AggregationsBoxPlotAggregate | AggregationsGeoBoundsAggregate | AggregationsGeoCentroidAggregate | AggregationsGeoLineAggregate | AggregationsPercentilesAggregate | AggregationsScriptedMetricAggregate | AggregationsStatsAggregate | AggregationsStringStatsAggregate | AggregationsTopHitsAggregate | AggregationsTopMetricsAggregate | AggregationsExtendedStatsAggregate | AggregationsTDigestPercentilesAggregate | AggregationsHdrPercentilesAggregate

Defined in: packages/types/src/elasticsearch-interfaces.ts:2547

---

AggregationsSingleBucketAggregate

AggregationsSingleBucketAggregate = AggregationsSingleBucketAggregateKeys | {[property: string]: AggregationsAggregate; }

Defined in: packages/types/src/elasticsearch-interfaces.ts:2753

---

AggregationsValueBucket

AggregationsValueBucket = object

Defined in: packages/types/src/elasticsearch-interfaces.ts:2484

Index Signature

[property: string]: AggregationsAggregate

---

AnalysisCharFilter

AnalysisCharFilter = AnalysisHtmlStripCharFilter | AnalysisMappingCharFilter | AnalysisPatternReplaceTokenFilter

Defined in: packages/types/src/elasticsearch-interfaces.ts:1543

---

AnalysisHtmlStripCharFilter

AnalysisHtmlStripCharFilter = AnalysisCharFilterBase

Defined in: packages/types/src/elasticsearch-interfaces.ts:1548

---

AnyQuery

AnyQuery = BoolQuery | GeoQuery | TermQuery | MatchQuery | MatchPhraseQuery | WildcardQuery | ExistsQuery | RegExprQuery | QueryStringQuery | RangeQuery | MultiMatchQuery | KNNQuery

Defined in: packages/types/src/elasticsearch-interfaces.ts:38

---

AnyQuerySort

AnyQuerySort = GeoSortQuery

Defined in: packages/types/src/elasticsearch-interfaces.ts:173

---

BoolQuery

BoolQuery = object

Defined in: packages/types/src/elasticsearch-interfaces.ts:17

Properties

bool

bool: object

Defined in: packages/types/src/elasticsearch-interfaces.ts:18

Name	Type	Defined in
filter?	AnyQuery[]	packages/types/src/elasticsearch-interfaces.ts:19
must_not?	AnyQuery[]	packages/types/src/elasticsearch-interfaces.ts:20
should?	AnyQuery[]	packages/types/src/elasticsearch-interfaces.ts:21

---

BoolQueryTypes

BoolQueryTypes = "filter" | "should" | "must_not"

Defined in: packages/types/src/elasticsearch-interfaces.ts:25

---

BulkCreateOperation

BulkCreateOperation = BulkOperation

Defined in: packages/types/src/elasticsearch-interfaces.ts:471

---

BulkCreateResponseItem

BulkCreateResponseItem = BulkResponseItemBase

Defined in: packages/types/src/elasticsearch-interfaces.ts:473

---

BulkDeleteOperation

BulkDeleteOperation = BulkOperation

Defined in: packages/types/src/elasticsearch-interfaces.ts:475

---

BulkDeleteResponseItem

BulkDeleteResponseItem = BulkResponseItemBase

Defined in: packages/types/src/elasticsearch-interfaces.ts:477

---

BulkIndexOperation

BulkIndexOperation = BulkOperation

Defined in: packages/types/src/elasticsearch-interfaces.ts:479

---

BulkIndexResponseItem

BulkIndexResponseItem = BulkResponseItemBase

Defined in: packages/types/src/elasticsearch-interfaces.ts:481

---

BulkUpdateOperation

BulkUpdateOperation = BulkOperation

Defined in: packages/types/src/elasticsearch-interfaces.ts:532

---

BulkUpdateResponseItem

BulkUpdateResponseItem = BulkResponseItemBase

Defined in: packages/types/src/elasticsearch-interfaces.ts:534

---

Bytes

Bytes = "b" | "k" | "kb" | "m" | "mb" | "g" | "gb" | "t" | "tb" | "p" | "pb"

Defined in: packages/types/src/elasticsearch-interfaces.ts:305

---

ConflictOptions

ConflictOptions = "abort" | "proceed"

Defined in: packages/types/src/elasticsearch-interfaces.ts:299

---

ConstantScoreQuery

ConstantScoreQuery = object

Defined in: packages/types/src/elasticsearch-interfaces.ts:148

Properties

constant_score

constant_score: object

Defined in: packages/types/src/elasticsearch-interfaces.ts:149

Name	Type	Defined in
filter	AnyQuery | AnyQuery[]	packages/types/src/elasticsearch-interfaces.ts:150

---

Duration

Duration = number

Defined in: packages/types/src/elasticsearch-interfaces.ts:288

---

ElasticsearchDSLResult

ElasticsearchDSLResult = object

Defined in: packages/types/src/elasticsearch-interfaces.ts:175

Properties

query

query: ConstantScoreQuery | MatchAllQuery | MatchNoneQuery | KNNQuery

Defined in: packages/types/src/elasticsearch-interfaces.ts:176

sort?

optional sort: AnyQuerySort | AnyQuerySort[]

Defined in: packages/types/src/elasticsearch-interfaces.ts:177

---

ErrorCause

ErrorCause = ErrorCauseKeys & object

Defined in: packages/types/src/elasticsearch-interfaces.ts:324

---

ESFieldType

ESFieldType = "long" | "integer" | "short" | "byte" | "double" | "float" | "keyword" | "text" | "boolean" | "ip" | "ip_range" | "date" | "geo_point" | "geo_shape" | "object" | "nested" | "knn_vector"

Defined in: packages/types/src/elasticsearch-interfaces.ts:180

---

ESTypeMapping

ESTypeMapping = PropertyESTypeMapping | FieldsESTypeMapping | BasicESTypeMapping | IgnoredESTypeMapping

Defined in: packages/types/src/elasticsearch-interfaces.ts:199

---

ExpandWildcards

ExpandWildcards = "open" | "closed" | "hidden" | "none" | "all"

Defined in: packages/types/src/elasticsearch-interfaces.ts:293

---

GeoDistanceSort

GeoDistanceSort = object

Defined in: packages/types/src/elasticsearch-interfaces.ts:162

Index Signature

[field: string]: GeoDistanceUnit | SortOrder | { lat: number; lon: number; }

---

GeoHash

GeoHash = string

Defined in: packages/types/src/elasticsearch-interfaces.ts:1099

---

GeoLocation

GeoLocation = LatLonGeoLocation | GeoHashLocation | number[] | string

Defined in: packages/types/src/elasticsearch-interfaces.ts:1092

---

GeoSortQuery

GeoSortQuery = object

Defined in: packages/types/src/elasticsearch-interfaces.ts:169

Properties

_geo_distance

_geo_distance: GeoDistanceSort

Defined in: packages/types/src/elasticsearch-interfaces.ts:170

---

Health

Health = "green" | "yellow" | "red"

Defined in: packages/types/src/elasticsearch-interfaces.ts:303

---

IndexRefresh

IndexRefresh = boolean | RefreshOptions

Defined in: packages/types/src/elasticsearch-interfaces.ts:357

---

IndicesIndexCheckOnStartup

IndicesIndexCheckOnStartup = "false" | "checksum" | "true"

Defined in: packages/types/src/elasticsearch-interfaces.ts:1431

---

IndicesIndexRoutingAllocationOptions

IndicesIndexRoutingAllocationOptions = "all" | "primaries" | "new_primaries" | "none"

Defined in: packages/types/src/elasticsearch-interfaces.ts:1880

---

IndicesIndexRoutingRebalanceOptions

IndicesIndexRoutingRebalanceOptions = "all" | "primaries" | "replicas" | "none"

Defined in: packages/types/src/elasticsearch-interfaces.ts:1886

---

IndicesNumericFielddataFormat

IndicesNumericFielddataFormat = "array" | "disabled"

Defined in: packages/types/src/elasticsearch-interfaces.ts:1008

---

IndicesStatsShardRoutingState

IndicesStatsShardRoutingState = "UNASSIGNED" | "INITIALIZING" | "STARTED" | "RELOCATING"

Defined in: packages/types/src/elasticsearch-interfaces.ts:2807

---

Level

Level = "cluster" | "indices" | "shards"

Defined in: packages/types/src/elasticsearch-interfaces.ts:1994

---

MappingCoreProperty

MappingCoreProperty = MappingObjectProperty | MappingNestedProperty | MappingSearchAsYouTypeProperty | MappingTextProperty | MappingDocValuesProperty

Defined in: packages/types/src/elasticsearch-interfaces.ts:970

---

MappingDocValuesProperty

MappingDocValuesProperty = MappingBinaryProperty | MappingBooleanProperty | MappingDateProperty | MappingDateNanosProperty | MappingKeywordProperty | MappingNumberProperty | MappingRangeProperty | MappingGeoPointProperty | MappingGeoShapeProperty | MappingCompletionProperty | MappingIpProperty | MappingMurmur3HashProperty | MappingShapeProperty | MappingTokenCountProperty | MappingVersionProperty | MappingWildcardProperty | MappingPointProperty

Defined in: packages/types/src/elasticsearch-interfaces.ts:977

---

MappingDynamicMapping

MappingDynamicMapping = "strict" | "runtime" | "true" | "false"

Defined in: packages/types/src/elasticsearch-interfaces.ts:1359

---

MappingGeoOrientation

MappingGeoOrientation = "right" | "RIGHT" | "counterclockwise" | "ccw" | "left" | "LEFT" | "clockwise" | "cw"

Defined in: packages/types/src/elasticsearch-interfaces.ts:1043

---

MappingGeoStrategy

MappingGeoStrategy = "recursive" | "term"

Defined in: packages/types/src/elasticsearch-interfaces.ts:1074

---

MappingIndexOptions

MappingIndexOptions = "docs" | "freqs" | "positions" | "offsets"

Defined in: packages/types/src/elasticsearch-interfaces.ts:1311

---

MappingMatchType

MappingMatchType = "simple" | "regex"

Defined in: packages/types/src/elasticsearch-interfaces.ts:1357

---

MappingNumberProperty

MappingNumberProperty = MappingFloatNumberProperty | MappingHalfFloatNumberProperty | MappingDoubleNumberProperty | MappingIntegerNumberProperty | MappingLongNumberProperty | MappingShortNumberProperty | MappingByteNumberProperty | MappingUnsignedLongNumberProperty | MappingScaledFloatNumberProperty

Defined in: packages/types/src/elasticsearch-interfaces.ts:1135

---

MappingOnScriptError

MappingOnScriptError = "fail" | "continue"

Defined in: packages/types/src/elasticsearch-interfaces.ts:1165

---

MappingProperty

MappingProperty = MappingFlattenedProperty | MappingJoinProperty | MappingPercolatorProperty | MappingRankFeatureProperty | MappingRankFeaturesProperty | MappingConstantKeywordProperty | MappingFieldAliasProperty | MappingHistogramProperty | MappingCoreProperty

Defined in: packages/types/src/elasticsearch-interfaces.ts:946

---

MappingRangeProperty

MappingRangeProperty = MappingLongRangeProperty | MappingIpRangeProperty | MappingIntegerRangeProperty | MappingFloatRangeProperty | MappingDoubleRangeProperty | MappingDateRangeProperty

Defined in: packages/types/src/elasticsearch-interfaces.ts:1127

---

MappingRuntimeFields

MappingRuntimeFields = Record<string, MappingRuntimeField>

Defined in: packages/types/src/elasticsearch-interfaces.ts:1392

---

MappingRuntimeFieldType

MappingRuntimeFieldType = "boolean" | "date" | "number" | "geo_point" | "ip" | "keyword" | "long"

Defined in: packages/types/src/elasticsearch-interfaces.ts:917

---

MappingTermVectorOption

MappingTermVectorOption = "no" | "yes" | "with_offsets" | "with_positions" | "with_positions_offsets" | "with_positions_offsets_payloads" | "with_positions_payloads"

Defined in: packages/types/src/elasticsearch-interfaces.ts:1280

---

MappingTimeSeriesMetricType

MappingTimeSeriesMetricType = "gauge" | "counter" | "summary" | "histogram"

Defined in: packages/types/src/elasticsearch-interfaces.ts:1157

---

MatchAllQuery

MatchAllQuery = object

Defined in: packages/types/src/elasticsearch-interfaces.ts:154

Properties

match_all

match_all: Record<string, never>

Defined in: packages/types/src/elasticsearch-interfaces.ts:155

---

MatchNoneQuery

MatchNoneQuery = object

Defined in: packages/types/src/elasticsearch-interfaces.ts:158

Properties

match_none

match_none: Record<PropertyKey, never>

Defined in: packages/types/src/elasticsearch-interfaces.ts:159

---

Metrics

Metrics = string | string[]

Defined in: packages/types/src/elasticsearch-interfaces.ts:1996

---

NodeRole

NodeRole = "cluster_manager" | "master" | "data" | "client" | "ingest" | "voting_only" | "remote_cluster_client" | "coordinating_only"

Defined in: packages/types/src/elasticsearch-interfaces.ts:435

---

NodeRoles

NodeRoles = NodeRole[]

Defined in: packages/types/src/elasticsearch-interfaces.ts:437

---

OpType

OpType = "index" | "create"

Defined in: packages/types/src/elasticsearch-interfaces.ts:387

---

PropertyESTypeMapping

PropertyESTypeMapping = object

Defined in: packages/types/src/elasticsearch-interfaces.ts:228

Properties

properties

properties: object

Defined in: packages/types/src/elasticsearch-interfaces.ts:230

Index Signature

[key: string]: PropertyESTypes

type?

optional type: "nested" | "object"

Defined in: packages/types/src/elasticsearch-interfaces.ts:229

---

PropertyESTypes

PropertyESTypes = FieldsESTypeMapping | BasicESTypeMapping

Defined in: packages/types/src/elasticsearch-interfaces.ts:227

---

QueryDslGeoCoordinate

QueryDslGeoCoordinate = string | number[] | QueryDslThreeDimensionalPoint

Defined in: packages/types/src/elasticsearch-interfaces.ts:2534

---

QueryDslGeoLocation

QueryDslGeoLocation = string | number[] | LatLon

Defined in: packages/types/src/elasticsearch-interfaces.ts:2522

---

RefreshOptions

RefreshOptions = "wait_for"

Defined in: packages/types/src/elasticsearch-interfaces.ts:358

---

Script

Script = InlineScript | IndexedScript | string

Defined in: packages/types/src/elasticsearch-interfaces.ts:404

---

ScriptLangs

ScriptLangs = "painless" | "expression" | "mustache" | "java"

Defined in: packages/types/src/elasticsearch-interfaces.ts:301

---

ScriptLanguage

ScriptLanguage = "painless" | "expression" | "mustache" | "java"

Defined in: packages/types/src/elasticsearch-interfaces.ts:389

---

SearchAggregations

SearchAggregations = Record<string, AggregationsAggregate>

Defined in: packages/types/src/elasticsearch-interfaces.ts:1721

---

SearchSortResults

SearchSortResults = (number | string | null)[]

Defined in: packages/types/src/elasticsearch-interfaces.ts:2611

---

SearchSourceConfig

SearchSourceConfig = boolean | SearchSourceFilter | string | string[]

Defined in: packages/types/src/elasticsearch-interfaces.ts:499

---

SearchTotalHitsRelation

SearchTotalHitsRelation = "eq" | "gte"

Defined in: packages/types/src/elasticsearch-interfaces.ts:2641

---

SearchTypes

SearchTypes = "query_then_fetch" | "dfs_query_then_fetch"

Defined in: packages/types/src/elasticsearch-interfaces.ts:295

---

SortOrder

SortOrder = "asc" | "desc"

Defined in: packages/types/src/elasticsearch-interfaces.ts:6

The sort direction

---

SuggestMode

SuggestMode = "missing" | "popular" | "always"

Defined in: packages/types/src/elasticsearch-interfaces.ts:297

---

TimeSpan

TimeSpan = `${Duration}${TimeUnit}`

Defined in: packages/types/src/elasticsearch-interfaces.ts:291

---

TimeUnit

TimeUnit = "d" | "h" | "m" | "s" | "ms" | "micros" | "nanos"

Defined in: packages/types/src/elasticsearch-interfaces.ts:289

---

VersionType

VersionType = "internal" | "external" | "external_gte" | "force"

Defined in: packages/types/src/elasticsearch-interfaces.ts:360

---

WaitForActiveShardOptions

WaitForActiveShardOptions = "all"

Defined in: packages/types/src/elasticsearch-interfaces.ts:383

---

WaitForActiveShards

WaitForActiveShards = number | WaitForActiveShardOptions

Defined in: packages/types/src/elasticsearch-interfaces.ts:385