@terascope/types / elasticsearch-client/elasticsearch-types
elasticsearch-client/elasticsearch-types
Interfaces
Type Aliases
Action
Action =
"Error"|"created"|"updated"|"deleted"|"not_found"|"noop"
Defined in: packages/types/src/elasticsearch-client/elasticsearch-types.ts:74
AggregationsAggregate
AggregationsAggregate =
AggregationsSingleBucketAggregate|AggregationsAutoDateHistogramAggregate|AggregationsFiltersAggregate|AggregationsSignificantTermsAggregate<any> |AggregationsTermsAggregate<any> |AggregationsBucketAggregate|AggregationsCompositeBucketAggregate|AggregationsMultiBucketAggregate<AggregationsBucket> |AggregationsMatrixStatsAggregate|AggregationsKeyedValueAggregate|AggregationsMetricAggregate
Defined in: packages/types/src/elasticsearch-client/elasticsearch-types.ts:2176
AggregationsBucket
AggregationsBucket =
AggregationsValueBucket|AggregationsKeyedBucket<any>
Defined in: packages/types/src/elasticsearch-client/elasticsearch-types.ts:2199
AggregationsFiltersBucketItem
AggregationsFiltersBucketItem =
AggregationsFiltersBucketItemKeys| {[property:string]:AggregationsAggregate; }
Defined in: packages/types/src/elasticsearch-client/elasticsearch-types.ts:2438
AggregationsKeyedBucket<TKey>
AggregationsKeyedBucket<
TKey> =AggregationsKeyedBucketKeys<TKey> | {[property:string]:AggregationsAggregate; }
Defined in: packages/types/src/elasticsearch-client/elasticsearch-types.ts:2462
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-client/elasticsearch-types.ts:2260
AggregationsSingleBucketAggregate
AggregationsSingleBucketAggregate =
AggregationsSingleBucketAggregateKeys| {[property:string]:AggregationsAggregate; }
Defined in: packages/types/src/elasticsearch-client/elasticsearch-types.ts:2466
AggregationsValueBucket
AggregationsValueBucket =
object
Defined in: packages/types/src/elasticsearch-client/elasticsearch-types.ts:2197
Index Signature
[property: string]: AggregationsAggregate
AnalysisCharFilter
AnalysisCharFilter =
AnalysisHtmlStripCharFilter|AnalysisMappingCharFilter|AnalysisPatternReplaceTokenFilter
Defined in: packages/types/src/elasticsearch-client/elasticsearch-types.ts:1256
AnalysisHtmlStripCharFilter
AnalysisHtmlStripCharFilter =
AnalysisCharFilterBase
Defined in: packages/types/src/elasticsearch-client/elasticsearch-types.ts:1261
BulkCreateOperation
BulkCreateOperation =
BulkOperation
Defined in: packages/types/src/elasticsearch-client/elasticsearch-types.ts:184
BulkCreateResponseItem
BulkCreateResponseItem =
BulkResponseItemBase
Defined in: packages/types/src/elasticsearch-client/elasticsearch-types.ts:186
BulkDeleteOperation
BulkDeleteOperation =
BulkOperation
Defined in: packages/types/src/elasticsearch-client/elasticsearch-types.ts:188
BulkDeleteResponseItem
BulkDeleteResponseItem =
BulkResponseItemBase
Defined in: packages/types/src/elasticsearch-client/elasticsearch-types.ts:190
BulkIndexOperation
BulkIndexOperation =
BulkOperation
Defined in: packages/types/src/elasticsearch-client/elasticsearch-types.ts:192
BulkIndexResponseItem
BulkIndexResponseItem =
BulkResponseItemBase
Defined in: packages/types/src/elasticsearch-client/elasticsearch-types.ts:194
BulkUpdateOperation
BulkUpdateOperation =
BulkOperation
Defined in: packages/types/src/elasticsearch-client/elasticsearch-types.ts:245
BulkUpdateResponseItem
BulkUpdateResponseItem =
BulkResponseItemBase
Defined in: packages/types/src/elasticsearch-client/elasticsearch-types.ts:247
Bytes
Bytes =
"b"|"k"|"kb"|"m"|"mb"|"g"|"gb"|"t"|"tb"|"p"|"pb"
Defined in: packages/types/src/elasticsearch-client/elasticsearch-types.ts:18
ConflictOptions
ConflictOptions =
"abort"|"proceed"
Defined in: packages/types/src/elasticsearch-client/elasticsearch-types.ts:12
Duration
Duration =
number
Defined in: packages/types/src/elasticsearch-client/elasticsearch-types.ts:1
ErrorCause
ErrorCause =
ErrorCauseKeys&object
Defined in: packages/types/src/elasticsearch-client/elasticsearch-types.ts:37
ExpandWildcards
ExpandWildcards =
"open"|"closed"|"hidden"|"none"|"all"
Defined in: packages/types/src/elasticsearch-client/elasticsearch-types.ts:6
GeoHash
GeoHash =
string
Defined in: packages/types/src/elasticsearch-client/elasticsearch-types.ts:812
GeoLocation
GeoLocation =
LatLonGeoLocation|GeoHashLocation|number[] |string
Defined in: packages/types/src/elasticsearch-client/elasticsearch-types.ts:805
Health
Health =
"green"|"yellow"|"red"
Defined in: packages/types/src/elasticsearch-client/elasticsearch-types.ts:16
IndexRefresh
IndexRefresh =
boolean|RefreshOptions
Defined in: packages/types/src/elasticsearch-client/elasticsearch-types.ts:70
IndicesIndexCheckOnStartup
IndicesIndexCheckOnStartup =
"false"|"checksum"|"true"
Defined in: packages/types/src/elasticsearch-client/elasticsearch-types.ts:1144
IndicesIndexRoutingAllocationOptions
IndicesIndexRoutingAllocationOptions =
"all"|"primaries"|"new_primaries"|"none"
Defined in: packages/types/src/elasticsearch-client/elasticsearch-types.ts:1593
IndicesIndexRoutingRebalanceOptions
IndicesIndexRoutingRebalanceOptions =
"all"|"primaries"|"replicas"|"none"
Defined in: packages/types/src/elasticsearch-client/elasticsearch-types.ts:1599
IndicesNumericFielddataFormat
IndicesNumericFielddataFormat =
"array"|"disabled"
Defined in: packages/types/src/elasticsearch-client/elasticsearch-types.ts:721
IndicesStatsShardRoutingState
IndicesStatsShardRoutingState =
"UNASSIGNED"|"INITIALIZING"|"STARTED"|"RELOCATING"
Defined in: packages/types/src/elasticsearch-client/elasticsearch-types.ts:2520
Level
Level =
"cluster"|"indices"|"shards"
Defined in: packages/types/src/elasticsearch-client/elasticsearch-types.ts:1707
MappingCoreProperty
MappingCoreProperty =
MappingObjectProperty|MappingNestedProperty|MappingSearchAsYouTypeProperty|MappingTextProperty|MappingDocValuesProperty
Defined in: packages/types/src/elasticsearch-client/elasticsearch-types.ts:683
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-client/elasticsearch-types.ts:690
MappingDynamicMapping
MappingDynamicMapping =
"strict"|"runtime"|"true"|"false"
Defined in: packages/types/src/elasticsearch-client/elasticsearch-types.ts:1072
MappingGeoOrientation
MappingGeoOrientation =
"right"|"RIGHT"|"counterclockwise"|"ccw"|"left"|"LEFT"|"clockwise"|"cw"
Defined in: packages/types/src/elasticsearch-client/elasticsearch-types.ts:756
MappingGeoStrategy
MappingGeoStrategy =
"recursive"|"term"
Defined in: packages/types/src/elasticsearch-client/elasticsearch-types.ts:787
MappingIndexOptions
MappingIndexOptions =
"docs"|"freqs"|"positions"|"offsets"
Defined in: packages/types/src/elasticsearch-client/elasticsearch-types.ts:1024
MappingMatchType
MappingMatchType =
"simple"|"regex"
Defined in: packages/types/src/elasticsearch-client/elasticsearch-types.ts:1070
MappingNumberProperty
MappingNumberProperty =
MappingFloatNumberProperty|MappingHalfFloatNumberProperty|MappingDoubleNumberProperty|MappingIntegerNumberProperty|MappingLongNumberProperty|MappingShortNumberProperty|MappingByteNumberProperty|MappingUnsignedLongNumberProperty|MappingScaledFloatNumberProperty
Defined in: packages/types/src/elasticsearch-client/elasticsearch-types.ts:848
MappingOnScriptError
MappingOnScriptError =
"fail"|"continue"
Defined in: packages/types/src/elasticsearch-client/elasticsearch-types.ts:878
MappingProperty
MappingProperty =
MappingFlattenedProperty|MappingJoinProperty|MappingPercolatorProperty|MappingRankFeatureProperty|MappingRankFeaturesProperty|MappingConstantKeywordProperty|MappingFieldAliasProperty|MappingHistogramProperty|MappingCoreProperty
Defined in: packages/types/src/elasticsearch-client/elasticsearch-types.ts:659
MappingRangeProperty
MappingRangeProperty =
MappingLongRangeProperty|MappingIpRangeProperty|MappingIntegerRangeProperty|MappingFloatRangeProperty|MappingDoubleRangeProperty|MappingDateRangeProperty
Defined in: packages/types/src/elasticsearch-client/elasticsearch-types.ts:840
MappingRuntimeFields
MappingRuntimeFields =
Record<string,MappingRuntimeField>
Defined in: packages/types/src/elasticsearch-client/elasticsearch-types.ts:1105
MappingRuntimeFieldType
MappingRuntimeFieldType =
"boolean"|"date"|"number"|"geo_point"|"ip"|"keyword"|"long"
Defined in: packages/types/src/elasticsearch-client/elasticsearch-types.ts:630
MappingTermVectorOption
MappingTermVectorOption =
"no"|"yes"|"with_offsets"|"with_positions"|"with_positions_offsets"|"with_positions_offsets_payloads"|"with_positions_payloads"
Defined in: packages/types/src/elasticsearch-client/elasticsearch-types.ts:993
MappingTimeSeriesMetricType
MappingTimeSeriesMetricType =
"gauge"|"counter"|"summary"|"histogram"
Defined in: packages/types/src/elasticsearch-client/elasticsearch-types.ts:870
Metrics
Metrics =
string|string[]
Defined in: packages/types/src/elasticsearch-client/elasticsearch-types.ts:1709
NodeRole
NodeRole =
"cluster_manager"|"master"|"data"|"client"|"ingest"|"voting_only"|"remote_cluster_client"|"coordinating_only"
Defined in: packages/types/src/elasticsearch-client/elasticsearch-types.ts:148
NodeRoles
NodeRoles =
NodeRole[]
Defined in: packages/types/src/elasticsearch-client/elasticsearch-types.ts:150
OpType
OpType =
"index"|"create"
Defined in: packages/types/src/elasticsearch-client/elasticsearch-types.ts:100
QueryDslGeoCoordinate
QueryDslGeoCoordinate =
string|number[] |QueryDslThreeDimensionalPoint
Defined in: packages/types/src/elasticsearch-client/elasticsearch-types.ts:2247
QueryDslGeoLocation
QueryDslGeoLocation =
string|number[] |LatLon
Defined in: packages/types/src/elasticsearch-client/elasticsearch-types.ts:2235
RefreshOptions
RefreshOptions =
"wait_for"
Defined in: packages/types/src/elasticsearch-client/elasticsearch-types.ts:71
Script
Script =
InlineScript|IndexedScript|string
Defined in: packages/types/src/elasticsearch-client/elasticsearch-types.ts:117
ScriptLangs
ScriptLangs =
"painless"|"expression"|"mustache"|"java"
Defined in: packages/types/src/elasticsearch-client/elasticsearch-types.ts:14
ScriptLanguage
ScriptLanguage =
"painless"|"expression"|"mustache"|"java"
Defined in: packages/types/src/elasticsearch-client/elasticsearch-types.ts:102
SearchAggregations
SearchAggregations =
Record<string,AggregationsAggregate>
Defined in: packages/types/src/elasticsearch-client/elasticsearch-types.ts:1434
SearchSortResults
SearchSortResults = (
number|string|null)[]
Defined in: packages/types/src/elasticsearch-client/elasticsearch-types.ts:2324
SearchSourceConfig
SearchSourceConfig =
boolean|SearchSourceFilter|string|string[]
Defined in: packages/types/src/elasticsearch-client/elasticsearch-types.ts:212
SearchTotalHitsRelation
SearchTotalHitsRelation =
"eq"|"gte"
Defined in: packages/types/src/elasticsearch-client/elasticsearch-types.ts:2354
SearchTypes
SearchTypes =
"query_then_fetch"|"dfs_query_then_fetch"
Defined in: packages/types/src/elasticsearch-client/elasticsearch-types.ts:8
SuggestMode
SuggestMode =
"missing"|"popular"|"always"
Defined in: packages/types/src/elasticsearch-client/elasticsearch-types.ts:10
TimeSpan
TimeSpan =
`${Duration}${TimeUnit}`
Defined in: packages/types/src/elasticsearch-client/elasticsearch-types.ts:4
TimeUnit
TimeUnit =
"d"|"h"|"m"|"s"|"ms"|"micros"|"nanos"
Defined in: packages/types/src/elasticsearch-client/elasticsearch-types.ts:2
VersionType
VersionType =
"internal"|"external"|"external_gte"|"force"
Defined in: packages/types/src/elasticsearch-client/elasticsearch-types.ts:73
WaitForActiveShardOptions
WaitForActiveShardOptions =
"all"
Defined in: packages/types/src/elasticsearch-client/elasticsearch-types.ts:96
WaitForActiveShards
WaitForActiveShards =
number|WaitForActiveShardOptions
Defined in: packages/types/src/elasticsearch-client/elasticsearch-types.ts:98