@terascope/types / elasticsearch-interfaces
elasticsearch-interfaces
Enumerations
Enumeration | Description |
---|---|
ElasticsearchDistribution | - |
Interfaces
Type Aliases
Action
Action:
"Error"
|"created"
|"updated"
|"deleted"
|"not_found"
|"noop"
Defined in: packages/types/src/elasticsearch-interfaces.ts:344
AggregationsAggregate
AggregationsAggregate:
AggregationsSingleBucketAggregate
|AggregationsAutoDateHistogramAggregate
|AggregationsFiltersAggregate
|AggregationsSignificantTermsAggregate
<any
> |AggregationsTermsAggregate
<any
> |AggregationsBucketAggregate
|AggregationsCompositeBucketAggregate
|AggregationsMultiBucketAggregate
<AggregationsBucket
> |AggregationsMatrixStatsAggregate
|AggregationsKeyedValueAggregate
|AggregationsMetricAggregate
Defined in: packages/types/src/elasticsearch-interfaces.ts:2446
AggregationsBucket
AggregationsBucket:
AggregationsValueBucket
|AggregationsKeyedBucket
<any
>
Defined in: packages/types/src/elasticsearch-interfaces.ts:2469
AggregationsFiltersBucketItem
AggregationsFiltersBucketItem:
AggregationsFiltersBucketItemKeys
| {}
Defined in: packages/types/src/elasticsearch-interfaces.ts:2708
AggregationsKeyedBucket<TKey>
AggregationsKeyedBucket<
TKey
>:AggregationsKeyedBucketKeys
<TKey
> | {}
Defined in: packages/types/src/elasticsearch-interfaces.ts:2732
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:2530
AggregationsSingleBucketAggregate
AggregationsSingleBucketAggregate:
AggregationsSingleBucketAggregateKeys
| {}
Defined in: packages/types/src/elasticsearch-interfaces.ts:2736
AggregationsValueBucket
AggregationsValueBucket:
object
Defined in: packages/types/src/elasticsearch-interfaces.ts:2467
Index Signature
[property
: string
]: AggregationsAggregate
AnalysisCharFilter
AnalysisCharFilter:
AnalysisHtmlStripCharFilter
|AnalysisMappingCharFilter
|AnalysisPatternReplaceTokenFilter
Defined in: packages/types/src/elasticsearch-interfaces.ts:1526
AnalysisHtmlStripCharFilter
AnalysisHtmlStripCharFilter:
AnalysisCharFilterBase
Defined in: packages/types/src/elasticsearch-interfaces.ts:1531
AnyQuery
AnyQuery:
BoolQuery
|GeoQuery
|TermQuery
|MatchQuery
|MatchPhraseQuery
|WildcardQuery
|ExistsQuery
|RegExprQuery
|QueryStringQuery
|RangeQuery
|MultiMatchQuery
Defined in: packages/types/src/elasticsearch-interfaces.ts:27
AnyQuerySort
AnyQuerySort:
GeoSortQuery
Defined in: packages/types/src/elasticsearch-interfaces.ts:157
BoolQuery
BoolQuery:
object
Defined in: packages/types/src/elasticsearch-interfaces.ts:17
Type declaration
bool
bool:
object
bool.filter?
optional
filter:AnyQuery
[]
bool.must_not?
optional
must_not:AnyQuery
[]
bool.should?
optional
should:AnyQuery
[]
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:454
BulkCreateResponseItem
BulkCreateResponseItem:
BulkResponseItemBase
Defined in: packages/types/src/elasticsearch-interfaces.ts:456
BulkDeleteOperation
BulkDeleteOperation:
BulkOperation
Defined in: packages/types/src/elasticsearch-interfaces.ts:458
BulkDeleteResponseItem
BulkDeleteResponseItem:
BulkResponseItemBase
Defined in: packages/types/src/elasticsearch-interfaces.ts:460
BulkIndexOperation
BulkIndexOperation:
BulkOperation
Defined in: packages/types/src/elasticsearch-interfaces.ts:462
BulkIndexResponseItem
BulkIndexResponseItem:
BulkResponseItemBase
Defined in: packages/types/src/elasticsearch-interfaces.ts:464
BulkUpdateOperation
BulkUpdateOperation:
BulkOperation
Defined in: packages/types/src/elasticsearch-interfaces.ts:515
BulkUpdateResponseItem
BulkUpdateResponseItem:
BulkResponseItemBase
Defined in: packages/types/src/elasticsearch-interfaces.ts:517
Bytes
Bytes:
"b"
|"k"
|"kb"
|"m"
|"mb"
|"g"
|"gb"
|"t"
|"tb"
|"p"
|"pb"
Defined in: packages/types/src/elasticsearch-interfaces.ts:288
ConflictOptions
ConflictOptions:
"abort"
|"proceed"
Defined in: packages/types/src/elasticsearch-interfaces.ts:282
ConstantScoreQuery
ConstantScoreQuery:
object
Defined in: packages/types/src/elasticsearch-interfaces.ts:136
Type declaration
constant_score
constant_score:
object
constant_score.filter
Duration
Duration:
number
Defined in: packages/types/src/elasticsearch-interfaces.ts:271
ElasticsearchDSLResult
ElasticsearchDSLResult:
object
Defined in: packages/types/src/elasticsearch-interfaces.ts:159
Type declaration
query
query:
ConstantScoreQuery
|MatchAllQuery
sort?
optional
sort:AnyQuerySort
|AnyQuerySort
[]
ErrorCause
ErrorCause:
ErrorCauseKeys
&object
Defined in: packages/types/src/elasticsearch-interfaces.ts:307
ESFieldType
ESFieldType:
"long"
|"integer"
|"short"
|"byte"
|"double"
|"float"
|"keyword"
|"text"
|"boolean"
|"ip"
|"ip_range"
|"date"
|"geo_point"
|"geo_shape"
|"object"
|"nested"
Defined in: packages/types/src/elasticsearch-interfaces.ts:164
ESTypeMapping
ESTypeMapping:
PropertyESTypeMapping
|FieldsESTypeMapping
|BasicESTypeMapping
|IgnoredESTypeMapping
Defined in: packages/types/src/elasticsearch-interfaces.ts:182
ExpandWildcards
ExpandWildcards:
"open"
|"closed"
|"hidden"
|"none"
|"all"
Defined in: packages/types/src/elasticsearch-interfaces.ts:276
GeoDistanceSort
GeoDistanceSort:
object
Defined in: packages/types/src/elasticsearch-interfaces.ts:146
Index Signature
[field
: string
]: GeoDistanceUnit
| SortOrder
| { lat
: number
; lon
: number
; }
GeoHash
GeoHash:
string
Defined in: packages/types/src/elasticsearch-interfaces.ts:1082
GeoLocation
GeoLocation:
LatLonGeoLocation
|GeoHashLocation
|number
[] |string
Defined in: packages/types/src/elasticsearch-interfaces.ts:1075
GeoSortQuery
GeoSortQuery:
object
Defined in: packages/types/src/elasticsearch-interfaces.ts:153
Type declaration
_geo_distance
_geo_distance:
GeoDistanceSort
Health
Health:
"green"
|"yellow"
|"red"
Defined in: packages/types/src/elasticsearch-interfaces.ts:286
IndexRefresh
IndexRefresh:
boolean
|RefreshOptions
Defined in: packages/types/src/elasticsearch-interfaces.ts:340
IndicesIndexCheckOnStartup
IndicesIndexCheckOnStartup:
"false"
|"checksum"
|"true"
Defined in: packages/types/src/elasticsearch-interfaces.ts:1414
IndicesIndexRoutingAllocationOptions
IndicesIndexRoutingAllocationOptions:
"all"
|"primaries"
|"new_primaries"
|"none"
Defined in: packages/types/src/elasticsearch-interfaces.ts:1863
IndicesIndexRoutingRebalanceOptions
IndicesIndexRoutingRebalanceOptions:
"all"
|"primaries"
|"replicas"
|"none"
Defined in: packages/types/src/elasticsearch-interfaces.ts:1869
IndicesNumericFielddataFormat
IndicesNumericFielddataFormat:
"array"
|"disabled"
Defined in: packages/types/src/elasticsearch-interfaces.ts:991
IndicesStatsShardRoutingState
IndicesStatsShardRoutingState:
"UNASSIGNED"
|"INITIALIZING"
|"STARTED"
|"RELOCATING"
Defined in: packages/types/src/elasticsearch-interfaces.ts:2790
Level
Level:
"cluster"
|"indices"
|"shards"
Defined in: packages/types/src/elasticsearch-interfaces.ts:1977
MappingCoreProperty
MappingCoreProperty:
MappingObjectProperty
|MappingNestedProperty
|MappingSearchAsYouTypeProperty
|MappingTextProperty
|MappingDocValuesProperty
Defined in: packages/types/src/elasticsearch-interfaces.ts:953
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:960
MappingDynamicMapping
MappingDynamicMapping:
"strict"
|"runtime"
|"true"
|"false"
Defined in: packages/types/src/elasticsearch-interfaces.ts:1342
MappingGeoOrientation
MappingGeoOrientation:
"right"
|"RIGHT"
|"counterclockwise"
|"ccw"
|"left"
|"LEFT"
|"clockwise"
|"cw"
Defined in: packages/types/src/elasticsearch-interfaces.ts:1026
MappingGeoStrategy
MappingGeoStrategy:
"recursive"
|"term"
Defined in: packages/types/src/elasticsearch-interfaces.ts:1057
MappingIndexOptions
MappingIndexOptions:
"docs"
|"freqs"
|"positions"
|"offsets"
Defined in: packages/types/src/elasticsearch-interfaces.ts:1294
MappingMatchType
MappingMatchType:
"simple"
|"regex"
Defined in: packages/types/src/elasticsearch-interfaces.ts:1340
MappingNumberProperty
MappingNumberProperty:
MappingFloatNumberProperty
|MappingHalfFloatNumberProperty
|MappingDoubleNumberProperty
|MappingIntegerNumberProperty
|MappingLongNumberProperty
|MappingShortNumberProperty
|MappingByteNumberProperty
|MappingUnsignedLongNumberProperty
|MappingScaledFloatNumberProperty
Defined in: packages/types/src/elasticsearch-interfaces.ts:1118
MappingOnScriptError
MappingOnScriptError:
"fail"
|"continue"
Defined in: packages/types/src/elasticsearch-interfaces.ts:1148
MappingProperty
MappingProperty:
MappingFlattenedProperty
|MappingJoinProperty
|MappingPercolatorProperty
|MappingRankFeatureProperty
|MappingRankFeaturesProperty
|MappingConstantKeywordProperty
|MappingFieldAliasProperty
|MappingHistogramProperty
|MappingCoreProperty
Defined in: packages/types/src/elasticsearch-interfaces.ts:929
MappingRangeProperty
MappingRangeProperty:
MappingLongRangeProperty
|MappingIpRangeProperty
|MappingIntegerRangeProperty
|MappingFloatRangeProperty
|MappingDoubleRangeProperty
|MappingDateRangeProperty
Defined in: packages/types/src/elasticsearch-interfaces.ts:1110
MappingRuntimeFields
MappingRuntimeFields:
Record
<string
,MappingRuntimeField
>
Defined in: packages/types/src/elasticsearch-interfaces.ts:1375
MappingRuntimeFieldType
MappingRuntimeFieldType:
"boolean"
|"date"
|"number"
|"geo_point"
|"ip"
|"keyword"
|"long"
Defined in: packages/types/src/elasticsearch-interfaces.ts:900
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:1263
MappingTimeSeriesMetricType
MappingTimeSeriesMetricType:
"gauge"
|"counter"
|"summary"
|"histogram"
Defined in: packages/types/src/elasticsearch-interfaces.ts:1140
MatchAllQuery
MatchAllQuery:
object
Defined in: packages/types/src/elasticsearch-interfaces.ts:142
Type declaration
match_all
match_all:
Record
<string
,never
>
Metrics
Metrics:
string
|string
[]
Defined in: packages/types/src/elasticsearch-interfaces.ts:1979
NodeRole
NodeRole:
"cluster_manager"
|"master"
|"data"
|"client"
|"ingest"
|"voting_only"
|"remote_cluster_client"
|"coordinating_only"
Defined in: packages/types/src/elasticsearch-interfaces.ts:418
NodeRoles
NodeRoles:
NodeRole
[]
Defined in: packages/types/src/elasticsearch-interfaces.ts:420
OpType
OpType:
"index"
|"create"
Defined in: packages/types/src/elasticsearch-interfaces.ts:370
PropertyESTypeMapping
PropertyESTypeMapping:
object
Defined in: packages/types/src/elasticsearch-interfaces.ts:211
Type declaration
properties
properties:
object
Index Signature
[key
: string
]: PropertyESTypes
type?
optional
type:"nested"
|"object"
PropertyESTypes
PropertyESTypes:
FieldsESTypeMapping
|BasicESTypeMapping
Defined in: packages/types/src/elasticsearch-interfaces.ts:210
QueryDslGeoCoordinate
QueryDslGeoCoordinate:
string
|number
[] |QueryDslThreeDimensionalPoint
Defined in: packages/types/src/elasticsearch-interfaces.ts:2517
QueryDslGeoLocation
QueryDslGeoLocation:
string
|number
[] |LatLon
Defined in: packages/types/src/elasticsearch-interfaces.ts:2505
RefreshOptions
RefreshOptions:
"wait_for"
Defined in: packages/types/src/elasticsearch-interfaces.ts:341
Script
Script:
InlineScript
|IndexedScript
|string
Defined in: packages/types/src/elasticsearch-interfaces.ts:387
ScriptLangs
ScriptLangs:
"painless"
|"expression"
|"mustache"
|"java"
Defined in: packages/types/src/elasticsearch-interfaces.ts:284
ScriptLanguage
ScriptLanguage:
"painless"
|"expression"
|"mustache"
|"java"
Defined in: packages/types/src/elasticsearch-interfaces.ts:372
SearchAggregations
SearchAggregations:
Record
<string
,AggregationsAggregate
>
Defined in: packages/types/src/elasticsearch-interfaces.ts:1704
SearchSortResults
SearchSortResults: (
number
|string
|null
)[]
Defined in: packages/types/src/elasticsearch-interfaces.ts:2594
SearchSourceConfig
SearchSourceConfig:
boolean
|SearchSourceFilter
|string
|string
[]
Defined in: packages/types/src/elasticsearch-interfaces.ts:482
SearchTotalHitsRelation
SearchTotalHitsRelation:
"eq"
|"gte"
Defined in: packages/types/src/elasticsearch-interfaces.ts:2624
SearchTypes
SearchTypes:
"query_then_fetch"
|"dfs_query_then_fetch"
Defined in: packages/types/src/elasticsearch-interfaces.ts:278
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:280
TimeSpan
TimeSpan:
`${Duration}${TimeUnit}`
Defined in: packages/types/src/elasticsearch-interfaces.ts:274
TimeUnit
TimeUnit:
"d"
|"h"
|"m"
|"s"
|"ms"
|"micros"
|"nanos"
Defined in: packages/types/src/elasticsearch-interfaces.ts:272
VersionType
VersionType:
"internal"
|"external"
|"external_gte"
|"force"
Defined in: packages/types/src/elasticsearch-interfaces.ts:343
WaitForActiveShardOptions
WaitForActiveShardOptions:
"all"
Defined in: packages/types/src/elasticsearch-interfaces.ts:366
WaitForActiveShards
WaitForActiveShards:
number
|WaitForActiveShardOptions
Defined in: packages/types/src/elasticsearch-interfaces.ts:368