Skip to main content

@terascope/types / elasticsearch-interfaces

elasticsearch-interfaces

Index​

Enumerations​

EnumerationDescription
ElasticsearchDistribution-

Interfaces​

InterfaceDescription
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-
ESIndexSettings-
ESMapping-
ESTypeMappings-
ElasticsearchDSLOptions-
ErrorCauseKeys-
ExistsQuery-
ExplainExplanation-
ExplainExplanationDetail-
FieldMemoryUsage-
FieldSizeUsage-
FielddataStats-
FlushStats-
GeoHashLocation-
GeoQuery-
GetStats-
HitsTotal-
IndexTemplate-
IndexTemplateProperties-
IndexedScript-
IndexingStats-
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-
LatLon-
LatLonGeoLocation-
MGetBody-
MGetDocs-
MSearchBody-
MSearchHeader-
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-
MultiMatchQuery-
NodeStatistics-
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-
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"

Source​

elasticsearch-interfaces.ts:342

AggregationsAggregate​

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

Source​

elasticsearch-interfaces.ts:2444

AggregationsBucket​

AggregationsBucket: AggregationsValueBucket | AggregationsKeyedBucket<any>

Source​

elasticsearch-interfaces.ts:2467

AggregationsFiltersBucketItem​

AggregationsFiltersBucketItem: AggregationsFiltersBucketItemKeys | object

Source​

elasticsearch-interfaces.ts:2706

AggregationsKeyedBucket<TKey>​

AggregationsKeyedBucket<TKey>: AggregationsKeyedBucketKeys<TKey> | object

Type parameters​

Type parameterValue
TKeyunknown

Source​

elasticsearch-interfaces.ts:2730

AggregationsMetricAggregate​

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

Source​

elasticsearch-interfaces.ts:2528

AggregationsSingleBucketAggregate​

AggregationsSingleBucketAggregate: AggregationsSingleBucketAggregateKeys | object

Source​

elasticsearch-interfaces.ts:2734

AggregationsValueBucket​

AggregationsValueBucket: object

Index signature​

[property: string]: AggregationsAggregate

Source​

elasticsearch-interfaces.ts:2465

AnalysisCharFilter​

AnalysisCharFilter: AnalysisHtmlStripCharFilter | AnalysisMappingCharFilter | AnalysisPatternReplaceTokenFilter

Source​

elasticsearch-interfaces.ts:1524

AnalysisHtmlStripCharFilter​

AnalysisHtmlStripCharFilter: AnalysisCharFilterBase

Source​

elasticsearch-interfaces.ts:1529

AnyQuery​

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

Source​

elasticsearch-interfaces.ts:27

AnyQuerySort​

AnyQuerySort: GeoSortQuery

Source​

elasticsearch-interfaces.ts:157

BoolQuery​

BoolQuery: object

Type declaration​

bool​

bool: object

bool.filter?​

optional filter: AnyQuery[]

bool.must_not?​

optional must_not: AnyQuery[]

bool.should?​

optional should: AnyQuery[]

Source​

elasticsearch-interfaces.ts:17

BoolQueryTypes​

BoolQueryTypes: "filter" | "should" | "must_not"

Source​

elasticsearch-interfaces.ts:25

BulkCreateOperation​

BulkCreateOperation: BulkOperation

Source​

elasticsearch-interfaces.ts:452

BulkCreateResponseItem​

BulkCreateResponseItem: BulkResponseItemBase

Source​

elasticsearch-interfaces.ts:454

BulkDeleteOperation​

BulkDeleteOperation: BulkOperation

Source​

elasticsearch-interfaces.ts:456

BulkDeleteResponseItem​

BulkDeleteResponseItem: BulkResponseItemBase

Source​

elasticsearch-interfaces.ts:458

BulkIndexOperation​

BulkIndexOperation: BulkOperation

Source​

elasticsearch-interfaces.ts:460

BulkIndexResponseItem​

BulkIndexResponseItem: BulkResponseItemBase

Source​

elasticsearch-interfaces.ts:462

BulkUpdateOperation​

BulkUpdateOperation: BulkOperation

Source​

elasticsearch-interfaces.ts:513

BulkUpdateResponseItem​

BulkUpdateResponseItem: BulkResponseItemBase

Source​

elasticsearch-interfaces.ts:515

Bytes​

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

Source​

elasticsearch-interfaces.ts:286

ConflictOptions​

ConflictOptions: "abort" | "proceed"

Source​

elasticsearch-interfaces.ts:280

ConstantScoreQuery​

ConstantScoreQuery: object

Type declaration​

constant_score​

constant_score: object

constant_score.filter​

filter: AnyQuery | AnyQuery[]

Source​

elasticsearch-interfaces.ts:136

Duration​

Duration: number

Source​

elasticsearch-interfaces.ts:269

ESFieldType​

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

Source​

elasticsearch-interfaces.ts:164

ESTypeMapping​

ESTypeMapping: PropertyESTypeMapping | FieldsESTypeMapping | BasicESTypeMapping | IgnoredESTypeMapping

Source​

elasticsearch-interfaces.ts:182

ElasticsearchDSLResult​

ElasticsearchDSLResult: object

Type declaration​

query​

query: ConstantScoreQuery | MatchAllQuery

sort?​

optional sort: AnyQuerySort | AnyQuerySort[]

Source​

elasticsearch-interfaces.ts:159

ErrorCause​

ErrorCause: ErrorCauseKeys & object

Source​

elasticsearch-interfaces.ts:305

ExpandWildcards​

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

Source​

elasticsearch-interfaces.ts:274

GeoDistanceSort​

GeoDistanceSort: object

Index signature​

[field: string]: SortOrder | GeoDistanceUnit | object

Source​

elasticsearch-interfaces.ts:146

GeoHash​

GeoHash: string

Source​

elasticsearch-interfaces.ts:1080

GeoLocation​

GeoLocation: LatLonGeoLocation | GeoHashLocation | number[] | string

Source​

elasticsearch-interfaces.ts:1073

GeoSortQuery​

GeoSortQuery: object

Type declaration​

_geo_distance​

_geo_distance: GeoDistanceSort

Source​

elasticsearch-interfaces.ts:153

Health​

Health: "green" | "yellow" | "red"

Source​

elasticsearch-interfaces.ts:284

IndexRefresh​

IndexRefresh: boolean | RefreshOptions

Source​

elasticsearch-interfaces.ts:338

IndicesIndexCheckOnStartup​

IndicesIndexCheckOnStartup: "false" | "checksum" | "true"

Source​

elasticsearch-interfaces.ts:1412

IndicesIndexRoutingAllocationOptions​

IndicesIndexRoutingAllocationOptions: "all" | "primaries" | "new_primaries" | "none"

Source​

elasticsearch-interfaces.ts:1861

IndicesIndexRoutingRebalanceOptions​

IndicesIndexRoutingRebalanceOptions: "all" | "primaries" | "replicas" | "none"

Source​

elasticsearch-interfaces.ts:1867

IndicesNumericFielddataFormat​

IndicesNumericFielddataFormat: "array" | "disabled"

Source​

elasticsearch-interfaces.ts:989

IndicesStatsShardRoutingState​

IndicesStatsShardRoutingState: "UNASSIGNED" | "INITIALIZING" | "STARTED" | "RELOCATING"

Source​

elasticsearch-interfaces.ts:2788

Level​

Level: "cluster" | "indices" | "shards"

Source​

elasticsearch-interfaces.ts:1975

MappingCoreProperty​

MappingCoreProperty: MappingObjectProperty | MappingNestedProperty | MappingSearchAsYouTypeProperty | MappingTextProperty | MappingDocValuesProperty

Source​

elasticsearch-interfaces.ts:951

MappingDocValuesProperty​

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

Source​

elasticsearch-interfaces.ts:958

MappingDynamicMapping​

MappingDynamicMapping: "strict" | "runtime" | "true" | "false"

Source​

elasticsearch-interfaces.ts:1340

MappingGeoOrientation​

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

Source​

elasticsearch-interfaces.ts:1024

MappingGeoStrategy​

MappingGeoStrategy: "recursive" | "term"

Source​

elasticsearch-interfaces.ts:1055

MappingIndexOptions​

MappingIndexOptions: "docs" | "freqs" | "positions" | "offsets"

Source​

elasticsearch-interfaces.ts:1292

MappingMatchType​

MappingMatchType: "simple" | "regex"

Source​

elasticsearch-interfaces.ts:1338

MappingNumberProperty​

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

Source​

elasticsearch-interfaces.ts:1116

MappingOnScriptError​

MappingOnScriptError: "fail" | "continue"

Source​

elasticsearch-interfaces.ts:1146

MappingProperty​

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

Source​

elasticsearch-interfaces.ts:927

MappingRangeProperty​

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

Source​

elasticsearch-interfaces.ts:1108

MappingRuntimeFieldType​

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

Source​

elasticsearch-interfaces.ts:898

MappingRuntimeFields​

MappingRuntimeFields: Record<string, MappingRuntimeField>

Source​

elasticsearch-interfaces.ts:1373

MappingTermVectorOption​

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

Source​

elasticsearch-interfaces.ts:1261

MappingTimeSeriesMetricType​

MappingTimeSeriesMetricType: "gauge" | "counter" | "summary" | "histogram"

Source​

elasticsearch-interfaces.ts:1138

MatchAllQuery​

MatchAllQuery: object

Type declaration​

match_all​

match_all: Record<string, never>

Source​

elasticsearch-interfaces.ts:142

Metrics​

Metrics: string | string[]

Source​

elasticsearch-interfaces.ts:1977

NodeRole​

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

Source​

elasticsearch-interfaces.ts:416

NodeRoles​

NodeRoles: NodeRole[]

Source​

elasticsearch-interfaces.ts:418

OpType​

OpType: "index" | "create"

Source​

elasticsearch-interfaces.ts:368

PropertyESTypeMapping​

PropertyESTypeMapping: object

Type declaration​

properties​

properties: object

Index signature​

[key: string]: PropertyESTypes

type?​

optional type: "nested" | "object"

Source​

elasticsearch-interfaces.ts:209

PropertyESTypes​

PropertyESTypes: FieldsESTypeMapping | BasicESTypeMapping

Source​

elasticsearch-interfaces.ts:208

QueryDslGeoCoordinate​

QueryDslGeoCoordinate: string | number[] | QueryDslThreeDimensionalPoint

Source​

elasticsearch-interfaces.ts:2515

QueryDslGeoLocation​

QueryDslGeoLocation: string | number[] | LatLon

Source​

elasticsearch-interfaces.ts:2503

RefreshOptions​

RefreshOptions: "wait_for"

Source​

elasticsearch-interfaces.ts:339

Script​

Script: InlineScript | IndexedScript | string

Source​

elasticsearch-interfaces.ts:385

ScriptLangs​

ScriptLangs: "painless" | "expression" | "mustache" | "java"

Source​

elasticsearch-interfaces.ts:282

ScriptLanguage​

ScriptLanguage: "painless" | "expression" | "mustache" | "java"

Source​

elasticsearch-interfaces.ts:370

SearchAggregations​

SearchAggregations: Record<string, AggregationsAggregate>

Source​

elasticsearch-interfaces.ts:1702

SearchSortResults​

SearchSortResults: (number | string | null)[]

Source​

elasticsearch-interfaces.ts:2592

SearchSourceConfig​

SearchSourceConfig: boolean | SearchSourceFilter | string | string[]

Source​

elasticsearch-interfaces.ts:480

SearchTotalHitsRelation​

SearchTotalHitsRelation: "eq" | "gte"

Source​

elasticsearch-interfaces.ts:2622

SearchTypes​

SearchTypes: "query_then_fetch" | "dfs_query_then_fetch"

Source​

elasticsearch-interfaces.ts:276

SortOrder​

SortOrder: "asc" | "desc"

The sort direction

Source​

elasticsearch-interfaces.ts:6

SuggestMode​

SuggestMode: "missing" | "popular" | "always"

Source​

elasticsearch-interfaces.ts:278

TimeSpan​

TimeSpan: `${Duration}${TimeUnit}`

Source​

elasticsearch-interfaces.ts:272

TimeUnit​

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

Source​

elasticsearch-interfaces.ts:270

VersionType​

VersionType: "internal" | "external" | "external_gte" | "force"

Source​

elasticsearch-interfaces.ts:341

WaitForActiveShardOptions​

WaitForActiveShardOptions: "all"

Source​

elasticsearch-interfaces.ts:364

WaitForActiveShards​

WaitForActiveShards: number | WaitForActiveShardOptions

Source​

elasticsearch-interfaces.ts:366