Skip to main content

@terascope/types / elasticsearch-client/elasticsearch-types

elasticsearch-client/elasticsearch-types

Index​

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-
ClusterHealthIndexHealthStats-
ClusterHealthShardHealthStats-
CompletionStats-
DictionaryResponseBase-
DocStats-
ErrorCauseKeys-
ExplainExplanation-
ExplainExplanationDetail-
FieldMemoryUsage-
FieldSizeUsage-
FielddataStats-
FlushStats-
GeoHashLocation-
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-
MergesStats-
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-
RecoveryStats-
RefreshStats-
ReindexBody-
Remote-
RequestCacheStats-
ScriptBase-
SearchHitsMetadata-
SearchInnerHitsMetadata-
SearchInnerHitsResult-
SearchNestedIdentity-
SearchRecordResponse-
SearchResult-
SearchSourceFilter-
SearchStats-
SearchTotalHits-
SegmentsStats-
ShardFailure-
ShardStatistics-
StoreStats-
TemplateBody-
TranslogStats-
WarmerStats-
WriteResponseBase-

Type Aliases​

Action​

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

Source​

elasticsearch-client/elasticsearch-types.ts:74

AggregationsAggregate​

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

Source​

elasticsearch-client/elasticsearch-types.ts:2176

AggregationsBucket​

AggregationsBucket: AggregationsValueBucket | AggregationsKeyedBucket<any>

Source​

elasticsearch-client/elasticsearch-types.ts:2199

AggregationsFiltersBucketItem​

AggregationsFiltersBucketItem: AggregationsFiltersBucketItemKeys | object

Source​

elasticsearch-client/elasticsearch-types.ts:2438

AggregationsKeyedBucket<TKey>​

AggregationsKeyedBucket<TKey>: AggregationsKeyedBucketKeys<TKey> | object

Type parameters​

Type parameterValue
TKeyunknown

Source​

elasticsearch-client/elasticsearch-types.ts:2462

AggregationsMetricAggregate​

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

Source​

elasticsearch-client/elasticsearch-types.ts:2260

AggregationsSingleBucketAggregate​

AggregationsSingleBucketAggregate: AggregationsSingleBucketAggregateKeys | object

Source​

elasticsearch-client/elasticsearch-types.ts:2466

AggregationsValueBucket​

AggregationsValueBucket: object

Index signature​

[property: string]: AggregationsAggregate

Source​

elasticsearch-client/elasticsearch-types.ts:2197

AnalysisCharFilter​

AnalysisCharFilter: AnalysisHtmlStripCharFilter | AnalysisMappingCharFilter | AnalysisPatternReplaceTokenFilter

Source​

elasticsearch-client/elasticsearch-types.ts:1256

AnalysisHtmlStripCharFilter​

AnalysisHtmlStripCharFilter: AnalysisCharFilterBase

Source​

elasticsearch-client/elasticsearch-types.ts:1261

BulkCreateOperation​

BulkCreateOperation: BulkOperation

Source​

elasticsearch-client/elasticsearch-types.ts:184

BulkCreateResponseItem​

BulkCreateResponseItem: BulkResponseItemBase

Source​

elasticsearch-client/elasticsearch-types.ts:186

BulkDeleteOperation​

BulkDeleteOperation: BulkOperation

Source​

elasticsearch-client/elasticsearch-types.ts:188

BulkDeleteResponseItem​

BulkDeleteResponseItem: BulkResponseItemBase

Source​

elasticsearch-client/elasticsearch-types.ts:190

BulkIndexOperation​

BulkIndexOperation: BulkOperation

Source​

elasticsearch-client/elasticsearch-types.ts:192

BulkIndexResponseItem​

BulkIndexResponseItem: BulkResponseItemBase

Source​

elasticsearch-client/elasticsearch-types.ts:194

BulkUpdateOperation​

BulkUpdateOperation: BulkOperation

Source​

elasticsearch-client/elasticsearch-types.ts:245

BulkUpdateResponseItem​

BulkUpdateResponseItem: BulkResponseItemBase

Source​

elasticsearch-client/elasticsearch-types.ts:247

Bytes​

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

Source​

elasticsearch-client/elasticsearch-types.ts:18

ConflictOptions​

ConflictOptions: "abort" | "proceed"

Source​

elasticsearch-client/elasticsearch-types.ts:12

Duration​

Duration: number

Source​

elasticsearch-client/elasticsearch-types.ts:1

ErrorCause​

ErrorCause: ErrorCauseKeys & object

Source​

elasticsearch-client/elasticsearch-types.ts:37

ExpandWildcards​

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

Source​

elasticsearch-client/elasticsearch-types.ts:6

GeoHash​

GeoHash: string

Source​

elasticsearch-client/elasticsearch-types.ts:812

GeoLocation​

GeoLocation: LatLonGeoLocation | GeoHashLocation | number[] | string

Source​

elasticsearch-client/elasticsearch-types.ts:805

Health​

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

Source​

elasticsearch-client/elasticsearch-types.ts:16

IndexRefresh​

IndexRefresh: boolean | RefreshOptions

Source​

elasticsearch-client/elasticsearch-types.ts:70

IndicesIndexCheckOnStartup​

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

Source​

elasticsearch-client/elasticsearch-types.ts:1144

IndicesIndexRoutingAllocationOptions​

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

Source​

elasticsearch-client/elasticsearch-types.ts:1593

IndicesIndexRoutingRebalanceOptions​

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

Source​

elasticsearch-client/elasticsearch-types.ts:1599

IndicesNumericFielddataFormat​

IndicesNumericFielddataFormat: "array" | "disabled"

Source​

elasticsearch-client/elasticsearch-types.ts:721

IndicesStatsShardRoutingState​

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

Source​

elasticsearch-client/elasticsearch-types.ts:2520

Level​

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

Source​

elasticsearch-client/elasticsearch-types.ts:1707

MappingCoreProperty​

MappingCoreProperty: MappingObjectProperty | MappingNestedProperty | MappingSearchAsYouTypeProperty | MappingTextProperty | MappingDocValuesProperty

Source​

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

Source​

elasticsearch-client/elasticsearch-types.ts:690

MappingDynamicMapping​

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

Source​

elasticsearch-client/elasticsearch-types.ts:1072

MappingGeoOrientation​

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

Source​

elasticsearch-client/elasticsearch-types.ts:756

MappingGeoStrategy​

MappingGeoStrategy: "recursive" | "term"

Source​

elasticsearch-client/elasticsearch-types.ts:787

MappingIndexOptions​

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

Source​

elasticsearch-client/elasticsearch-types.ts:1024

MappingMatchType​

MappingMatchType: "simple" | "regex"

Source​

elasticsearch-client/elasticsearch-types.ts:1070

MappingNumberProperty​

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

Source​

elasticsearch-client/elasticsearch-types.ts:848

MappingOnScriptError​

MappingOnScriptError: "fail" | "continue"

Source​

elasticsearch-client/elasticsearch-types.ts:878

MappingProperty​

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

Source​

elasticsearch-client/elasticsearch-types.ts:659

MappingRangeProperty​

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

Source​

elasticsearch-client/elasticsearch-types.ts:840

MappingRuntimeFieldType​

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

Source​

elasticsearch-client/elasticsearch-types.ts:630

MappingRuntimeFields​

MappingRuntimeFields: Record<string, MappingRuntimeField>

Source​

elasticsearch-client/elasticsearch-types.ts:1105

MappingTermVectorOption​

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

Source​

elasticsearch-client/elasticsearch-types.ts:993

MappingTimeSeriesMetricType​

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

Source​

elasticsearch-client/elasticsearch-types.ts:870

Metrics​

Metrics: string | string[]

Source​

elasticsearch-client/elasticsearch-types.ts:1709

NodeRole​

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

Source​

elasticsearch-client/elasticsearch-types.ts:148

NodeRoles​

NodeRoles: NodeRole[]

Source​

elasticsearch-client/elasticsearch-types.ts:150

OpType​

OpType: "index" | "create"

Source​

elasticsearch-client/elasticsearch-types.ts:100

QueryDslGeoCoordinate​

QueryDslGeoCoordinate: string | number[] | QueryDslThreeDimensionalPoint

Source​

elasticsearch-client/elasticsearch-types.ts:2247

QueryDslGeoLocation​

QueryDslGeoLocation: string | number[] | LatLon

Source​

elasticsearch-client/elasticsearch-types.ts:2235

RefreshOptions​

RefreshOptions: "wait_for"

Source​

elasticsearch-client/elasticsearch-types.ts:71

Script​

Script: InlineScript | IndexedScript | string

Source​

elasticsearch-client/elasticsearch-types.ts:117

ScriptLangs​

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

Source​

elasticsearch-client/elasticsearch-types.ts:14

ScriptLanguage​

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

Source​

elasticsearch-client/elasticsearch-types.ts:102

SearchAggregations​

SearchAggregations: Record<string, AggregationsAggregate>

Source​

elasticsearch-client/elasticsearch-types.ts:1434

SearchSortResults​

SearchSortResults: (number | string | null)[]

Source​

elasticsearch-client/elasticsearch-types.ts:2324

SearchSourceConfig​

SearchSourceConfig: boolean | SearchSourceFilter | string | string[]

Source​

elasticsearch-client/elasticsearch-types.ts:212

SearchTotalHitsRelation​

SearchTotalHitsRelation: "eq" | "gte"

Source​

elasticsearch-client/elasticsearch-types.ts:2354

SearchTypes​

SearchTypes: "query_then_fetch" | "dfs_query_then_fetch"

Source​

elasticsearch-client/elasticsearch-types.ts:8

SuggestMode​

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

Source​

elasticsearch-client/elasticsearch-types.ts:10

TimeSpan​

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

Source​

elasticsearch-client/elasticsearch-types.ts:4

TimeUnit​

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

Source​

elasticsearch-client/elasticsearch-types.ts:2

VersionType​

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

Source​

elasticsearch-client/elasticsearch-types.ts:73

WaitForActiveShardOptions​

WaitForActiveShardOptions: "all"

Source​

elasticsearch-client/elasticsearch-types.ts:96

WaitForActiveShards​

WaitForActiveShards: number | WaitForActiveShardOptions

Source​

elasticsearch-client/elasticsearch-types.ts:98