@types/elasticsearch

bulk: {
    (
        params: BulkIndexDocumentsParams,
        callback: (error: any, response: any) => void
    ): void;
    (params: BulkIndexDocumentsParams): Promise<any>;
};

method clearScroll

clearScroll: {
    (
        params: ClearScrollParams,
        callback: (error: any, response: any) => void
    ): void;
    (params: ClearScrollParams): Promise<any>;
};

method close

close: () => void;

method count

count: {
    (
        params: CountParams,
        callback: (error: any, response: CountResponse) => void
    ): void;
    (params: CountParams): Promise<CountResponse>;
};

method create

create: {
    (
        params: CreateDocumentParams,
        callback: (
            err: any,
            response: CreateDocumentResponse,
            status: any
        ) => void
    ): void;
    (params: CreateDocumentParams): Promise<CreateDocumentResponse>;
};

method delete

delete: {
    (
        params: DeleteDocumentParams,
        callback: (error: any, response: DeleteDocumentResponse) => void
    ): void;
    (params: DeleteDocumentParams): Promise<DeleteDocumentResponse>;
};

method deleteByQuery

deleteByQuery: {
    (
        params: DeleteDocumentByQueryParams,
        callback: (error: any, response: DeleteDocumentByQueryResponse) => void
    ): void;
    (
        params: DeleteDocumentByQueryParams
    ): Promise<DeleteDocumentByQueryResponse>;
};

method deleteScript

deleteScript: {
    (
        params: DeleteScriptParams,
        callback: (error: any, response: any) => void
    ): void;
    (params: DeleteScriptParams): Promise<any>;
};

method deleteTemplate

deleteTemplate: {
    (
        params: DeleteTemplateParams,
        callback: (error: any, response: any) => void
    ): void;
    (params: DeleteTemplateParams): Promise<any>;
};

method exists

exists: {
    (
        params: ExistsParams,
        callback: (error: any, response: boolean, status?: any) => void
    ): void;
    (params: ExistsParams): Promise<boolean>;
};

method explain

explain: {
    (
        params: ExplainParams,
        callback: (error: any, response: ExplainResponse) => void
    ): void;
    (params: ExplainParams): Promise<ExplainResponse>;
};

method fieldStats

fieldStats: {
    (
        params: FieldStatsParams,
        callback: (error: any, response: FieldStatsResponse) => void
    ): void;
    (params: FieldStatsParams): Promise<FieldStatsResponse>;
};

method get

get: {
    <T>(
        params: GetParams,
        callback: (error: any, response: GetResponse<T>) => void
    ): void;
    <T>(params: GetParams): Promise<GetResponse<T>>;
};

method getScript

getScript: {
    (
        params: GetScriptParams,
        callback: (error: any, response: any) => void
    ): void;
    (params: GetScriptParams): Promise<any>;
};

method getSource

getSource: {
    (
        params: GetSourceParams,
        callback: (error: any, response: any) => void
    ): void;
    (params: GetSourceParams): Promise<any>;
};

method getTemplate

getTemplate: {
    (
        params: GetTemplateParams,
        callback: (error: any, response: any) => void
    ): void;
    (params: GetTemplateParams): Promise<any>;
};

method index

index: {
    <T>(
        params: IndexDocumentParams<T>,
        callback: (error: any, response: any) => void
    ): void;
    <T>(params: IndexDocumentParams<T>): Promise<any>;
};

method info

info: {
    (params: InfoParams, callback: (error: any, response: any) => void): void;
    (params: InfoParams): Promise<any>;
};

method mget

mget: {
    <T>(
        params: MGetParams,
        callback: (error: any, response: MGetResponse<T>) => void
    ): void;
    <T>(params: MGetParams): Promise<MGetResponse<T>>;
};

method msearch

msearch: {
    <T>(
        params: MSearchParams,
        callback: (error: any, response: MSearchResponse<T>) => void
    ): void;
    <T>(params: MSearchParams): Promise<MSearchResponse<T>>;
};

method msearchTemplate

msearchTemplate: {
    <T>(
        params: MSearchTemplateParams,
        callback: (error: any, response: MSearchResponse<T>) => void
    ): void;
    <T>(params: MSearchTemplateParams): Promise<MSearchResponse<T>>;
};

method mtermvectors

mtermvectors: {
    (
        params: MTermVectorsParams,
        callback: (error: any, response: any) => void
    ): void;
    (params: MTermVectorsParams): Promise<any>;
};

method ping

ping: {
    (
        params: PingParams,
        callback: (err: any, response: any, status: any) => void
    ): void;
    (params: PingParams): Promise<any>;
};

method putScript

putScript: {
    (
        params: PutScriptParams,
        callback: (err: any, response: any, status: any) => void
    ): void;
    (params: PutScriptParams): Promise<any>;
};

method putTemplate

putTemplate: {
    (
        params: PutTemplateParams,
        callback: (err: any, response: any, status: any) => void
    ): void;
    (params: PutTemplateParams): Promise<any>;
};

method reindex

reindex: {
    (
        params: ReindexParams,
        callback: (error: any, response: ReindexResponse) => void
    ): void;
    (params: ReindexParams): Promise<ReindexResponse>;
};

method reindexRethrottle

reindexRethrottle: {
    (
        params: ReindexRethrottleParams,
        callback: (error: any, response: any) => void
    ): void;
    (params: ReindexRethrottleParams): Promise<any>;
};

method renderSearchTemplate

renderSearchTemplate: {
    (
        params: RenderSearchTemplateParams,
        callback: (error: any, response: any) => void
    ): void;
    (params: RenderSearchTemplateParams): Promise<any>;
};

method scroll

scroll: {
    <T>(
        params: ScrollParams,
        callback: (error: any, response: SearchResponse<T>) => void
    ): void;
    <T>(params: ScrollParams): Promise<SearchResponse<T>>;
};

method search

search: {
    <T>(
        params: SearchParams,
        callback: (error: any, response: SearchResponse<T>) => void
    ): void;
    <T>(params: SearchParams): Promise<SearchResponse<T>>;
};

method searchShards

searchShards: {
    (
        params: SearchShardsParams,
        callback: (error: any, response: SearchShardsResponse) => void
    ): void;
    (params: SearchShardsParams): Promise<SearchShardsResponse>;
};

method searchTemplate

searchTemplate: {
    (
        params: SearchTemplateParams,
        callback: (error: any, response: any) => void
    ): void;
    (params: SearchTemplateParams): Promise<any>;
};

method suggest

suggest: {
    (params: SuggestParams, callback: (error: any, response: any) => void): void;
    (params: SuggestParams): Promise<any>;
};

method termvectors

termvectors: {
    (
        params: TermvectorsParams,
        callback: (error: any, response: any) => void
    ): void;
    (params: TermvectorsParams): Promise<any>;
};

method update

update: {
    (
        params: UpdateDocumentParams,
        callback: (error: any, response: any) => void
    ): void;
    (params: UpdateDocumentParams): Promise<any>;
};

method updateByQuery

updateByQuery: {
    (
        params: UpdateDocumentByQueryParams,
        callback: (error: any, response: UpdateDocumentByQueryResponse) => void
    ): void;
    (
        params: UpdateDocumentByQueryParams
    ): Promise<UpdateDocumentByQueryResponse>;
};

class Indices

class Indices {}

method analyze

analyze: {
    (
        params: IndicesAnalyzeParams,
        callback: (error: any, response: any, status: any) => void
    ): void;
    (params: IndicesAnalyzeParams): Promise<any>;
};

method clearCache

clearCache: {
    (
        params: IndicesClearCacheParams,
        callback: (error: any, response: any, status: any) => void
    ): void;
    (params: IndicesClearCacheParams): Promise<any>;
};

method close

close: {
    (
        params: IndicesCloseParams,
        callback: (error: any, response: any, status: any) => void
    ): void;
    (params: IndicesCloseParams): Promise<any>;
};

method create

create: {
    (
        params: IndicesCreateParams,
        callback: (error: any, response: any, status: any) => void
    ): void;
    (params: IndicesCreateParams): Promise<any>;
};

method delete

delete: {
    (
        params: IndicesDeleteParams,
        callback: (error: any, response: any, status: any) => void
    ): void;
    (params: IndicesDeleteParams): Promise<any>;
};

method deleteAlias

deleteAlias: {
    (
        params: IndicesDeleteAliasParams,
        callback: (error: any, response: any, status: any) => void
    ): void;
    (params: IndicesDeleteAliasParams): Promise<any>;
};

method deleteTemplate

deleteTemplate: {
    (
        params: IndicesDeleteTemplateParams,
        callback: (error: any, response: any, status: any) => void
    ): void;
    (params: IndicesDeleteTemplateParams): Promise<any>;
};

method exists

exists: {
    (
        params: IndicesExistsParams,
        callback: (error: any, response: boolean, status: any) => void
    ): void;
    (params: IndicesExistsParams): Promise<boolean>;
};

method existsAlias

existsAlias: {
    (
        params: IndicesExistsAliasParams,
        callback: (error: any, response: boolean, status: any) => void
    ): void;
    (params: IndicesExistsAliasParams): Promise<boolean>;
};

method existsTemplate

existsTemplate: {
    (
        params: IndicesExistsTemplateParams,
        callback: (error: any, response: boolean, status: any) => void
    ): void;
    (params: IndicesExistsTemplateParams): Promise<boolean>;
};

method existsType

existsType: {
    (
        params: IndicesExistsTypeParams,
        callback: (error: any, response: boolean, status: any) => void
    ): void;
    (params: IndicesExistsTypeParams): Promise<boolean>;
};

method flush

flush: {
    (
        params: IndicesFlushParams,
        callback: (error: any, response: any, status: any) => void
    ): void;
    (params: IndicesFlushParams): Promise<any>;
};

method flushSynced

flushSynced: {
    (
        params: IndicesFlushSyncedParams,
        callback: (error: any, response: any, status: any) => void
    ): void;
    (params: IndicesFlushSyncedParams): Promise<any>;
};

method forcemerge

forcemerge: {
    (
        params: IndicesForcemergeParams,
        callback: (error: any, response: any, status: any) => void
    ): void;
    (params: IndicesForcemergeParams): Promise<any>;
};

method get

get: {
    (
        params: IndicesGetParams,
        callback: (error: any, response: any, status: any) => void
    ): void;
    (params: IndicesGetParams): Promise<any>;
};

method getAlias

getAlias: {
    (
        params: IndicesGetAliasParams,
        callback: (error: any, response: any, status: any) => void
    ): void;
    (params: IndicesGetAliasParams): Promise<any>;
};

method getFieldMapping

getFieldMapping: {
    (
        params: IndicesGetFieldMappingParams,
        callback: (error: any, response: any, status: any) => void
    ): void;
    (params: IndicesGetFieldMappingParams): Promise<any>;
};

method getMapping

getMapping: {
    (
        params: IndicesGetMappingParams,
        callback: (error: any, response: any, status: any) => void
    ): void;
    (params: IndicesGetMappingParams): Promise<any>;
};

method getSettings

getSettings: {
    (
        params: IndicesGetSettingsParams,
        callback: (error: any, response: any, status: any) => void
    ): void;
    (params: IndicesGetSettingsParams): Promise<any>;
};

method getTemplate

getTemplate: {
    (
        params: IndicesGetTemplateParams,
        callback: (error: any, response: any, status: any) => void
    ): void;
    (params: IndicesGetTemplateParams): Promise<any>;
};

method getUpgrade

getUpgrade: {
    (
        params: IndicesGetUpgradeParams,
        callback: (error: any, response: any, status: any) => void
    ): void;
    (params: IndicesGetUpgradeParams): Promise<any>;
};

method open

open: {
    (
        params: IndicesOpenParams,
        callback: (error: any, response: any, status: any) => void
    ): void;
    (params: IndicesOpenParams): Promise<any>;
};

method putAlias

putAlias: {
    (
        params: IndicesPutAliasParams,
        callback: (error: any, response: any, status: any) => void
    ): void;
    (params: IndicesPutAliasParams): Promise<any>;
};

method putMapping

putMapping: {
    (
        params: IndicesPutMappingParams,
        callback: (error: any, response: any, status: any) => void
    ): void;
    (params: IndicesPutMappingParams): Promise<any>;
};

method putSettings

putSettings: {
    (
        params: IndicesPutSettingsParams,
        callback: (error: any, response: any, status: any) => void
    ): void;
    (params: IndicesPutSettingsParams): Promise<any>;
};

method putTemplate

putTemplate: {
    (
        params: IndicesPutTemplateParams,
        callback: (error: any, response: any) => void
    ): void;
    (params: IndicesPutTemplateParams): Promise<any>;
};

method recovery

recovery: {
    (
        params: IndicesRecoveryParams,
        callback: (error: any, response: any) => void
    ): void;
    (params: IndicesRecoveryParams): Promise<any>;
};

method refresh

refresh: {
    (
        params: IndicesRefreshParams,
        callback: (error: any, response: any) => void
    ): void;
    (params: IndicesRefreshParams): Promise<any>;
};

method rollover

rollover: {
    (
        params: IndicesRolloverParams,
        callback: (error: any, response: IndicesRolloverResponse) => void
    ): void;
    (params: IndicesRolloverParams): Promise<IndicesRolloverResponse>;
};

method segments

segments: {
    (
        params: IndicesSegmentsParams,
        callback: (error: any, response: any) => void
    ): void;
    (params: IndicesSegmentsParams): Promise<any>;
};

method shardStores

shardStores: {
    (
        params: IndicesShardStoresParams,
        callback: (error: any, response: any) => void
    ): void;
    (params: IndicesShardStoresParams): Promise<any>;
};

method shrink

shrink: {
    (
        params: IndicesShrinkParams,
        callback: (error: any, response: any) => void
    ): void;
    (params: IndicesShrinkParams): Promise<any>;
};

method stats

stats: {
    (
        params: IndicesStatsParams,
        callback: (error: any, response: any) => void
    ): void;
    (params: IndicesStatsParams): Promise<any>;
};

method updateAliases

updateAliases: {
    (
        params: IndicesUpdateAliasesParams,
        callback: (error: any, response: any) => void
    ): void;
    (params: IndicesUpdateAliasesParams): Promise<any>;
};

method upgrade

upgrade: {
    (
        params: IndicesUpgradeParams,
        callback: (error: any, response: any) => void
    ): void;
    (params: IndicesUpgradeParams): Promise<any>;
};

method validateQuery

validateQuery: {
    (
        params: IndicesValidateQueryParams,
        callback: (error: any, response: any) => void
    ): void;
    (params: IndicesValidateQueryParams): Promise<any>;
};

class Ingest

class Ingest {}

method deletePipeline

deletePipeline: {
    (
        params: IngestDeletePipelineParams,
        callback: (error: any, response: any, status: any) => void
    ): void;
    (params: IngestDeletePipelineParams): Promise<any>;
};

method getPipeline

getPipeline: {
    (
        params: IngestGetPipelineParams,
        callback: (error: any, response: any, status: any) => void
    ): void;
    (params: IngestGetPipelineParams): Promise<any>;
};

method putPipeline

putPipeline: {
    (
        params: IngestPutPipelineParams,
        callback: (error: any, response: any, status: any) => void
    ): void;
    (params: IngestPutPipelineParams): Promise<any>;
};

method simulate

simulate: {
    (
        params: IngestSimulateParams,
        callback: (error: any, response: any, status: any) => void
    ): void;
    (params: IngestSimulateParams): Promise<any>;
};

class Nodes

class Nodes {}

method hotThreads

hotThreads: {
    (
        params: NodesHotThreadsParams,
        callback: (error: any, response: any, status: any) => void
    ): void;
    (params: NodesHotThreadsParams): Promise<any>;
};

method info

info: {
    (
        params: NodesInfoParams,
        callback: (error: any, response: any, status: any) => void
    ): void;
    (params: NodesInfoParams): Promise<any>;
};

method stats

stats: {
    (
        params: NodesStatsParams,
        callback: (error: any, response: any, status: any) => void
    ): void;
    (params: NodesStatsParams): Promise<any>;
};

class Snapshot

class Snapshot {}

method create

create: {
    (
        params: SnapshotCreateParams,
        callback: (error: any, response: any, status: any) => void
    ): void;
    (params: SnapshotCreateParams): Promise<any>;
};

method createRepository

createRepository: {
    (
        params: SnapshotCreateRepositoryParams,
        callback: (error: any, response: any, status: any) => void
    ): void;
    (params: SnapshotCreateRepositoryParams): Promise<any>;
};

method delete

delete: {
    (
        params: SnapshotDeleteParams,
        callback: (error: any, response: any, status: any) => void
    ): void;
    (params: SnapshotDeleteParams): Promise<any>;
};

method deleteRepository

deleteRepository: {
    (
        params: SnapshotDeleteRepositoryParams,
        callback: (error: any, response: any, status: any) => void
    ): void;
    (params: SnapshotDeleteRepositoryParams): Promise<any>;
};

method get

get: {
    (
        params: SnapshotGetParams,
        callback: (error: any, response: any, status: any) => void
    ): void;
    (params: SnapshotGetParams): Promise<any>;
};

method getRepository

getRepository: {
    (
        params: SnapshotGetRepositoryParams,
        callback: (error: any, response: any, status: any) => void
    ): void;
    (params: SnapshotGetRepositoryParams): Promise<any>;
};

method restore

restore: {
    (
        params: SnapshotRestoreParams,
        callback: (error: any, response: any, status: any) => void
    ): void;
    (params: SnapshotRestoreParams): Promise<any>;
};

method status

status: {
    (
        params: SnapshotStatusParams,
        callback: (error: any, response: any, status: any) => void
    ): void;
    (params: SnapshotStatusParams): Promise<any>;
};

method verifyRepository

verifyRepository: {
    (
        params: SnapshotVerifyRepositoryParams,
        callback: (error: any, response: any, status: any) => void
    ): void;
    (params: SnapshotVerifyRepositoryParams): Promise<any>;
};

class Tasks

class Tasks {}

method cancel

cancel: {
    (
        params: TasksCancelParams,
        callback: (error: any, response: any, status: any) => void
    ): void;
    (params: TasksCancelParams): Promise<any>;
};

method get

get: {
    (
        params: TasksGetParams,
        callback: (error: any, response: any, status: any) => void
    ): void;
    (params: TasksGetParams): Promise<any>;
};

method list

list: {
    (
        params: TasksListParams,
        callback: (error: any, response: any, status: any) => void
    ): void;
    (params: TasksListParams): Promise<any>;
};

Interfaces

interface BulkIndexDocumentsParams

interface BulkIndexDocumentsParams extends GenericParams {}

property fields

fields?: NameList | undefined;

property index

index?: string | undefined;

property pipeline

pipeline?: string | undefined;

property refresh

refresh?: Refresh | undefined;

property routing

routing?: string | undefined;

property timeout

timeout?: TimeSpan | undefined;

property type

type?: string | undefined;

property waitForActiveShards

waitForActiveShards?: string | undefined;

interface Cat

interface Cat {}

method aliases

aliases: {
    (
        params: CatAliasesParams,
        callback: (error: any, response: any) => void
    ): void;
    (params: CatAliasesParams): Promise<any>;
};

method allocation

allocation: {
    (
        params: CatAllocationParams,
        callback: (error: any, response: any) => void
    ): void;
    (params: CatAllocationParams): Promise<any>;
};

method count

count: {
    (
        params: CatCountParams,
        callback: (error: any, response: any) => void
    ): void;
    (params: CatAllocationParams): Promise<any>;
};

method fielddata

fielddata: {
    (
        params: CatFielddataParams,
        callback: (error: any, response: any) => void
    ): void;
    (params: CatFielddataParams): Promise<any>;
};

method health

health: {
    (
        params: CatHealthParams,
        callback: (error: any, response: any) => void
    ): void;
    (params: CatHealthParams): Promise<any>;
};

method help

help: {
    (params: CatHelpParams, callback: (error: any, response: any) => void): void;
    (params: CatHelpParams): Promise<any>;
};

method indices

indices: {
    (
        params: CatIndicesParams,
        callback: (error: any, response: any) => void
    ): void;
    (params: CatIndicesParams): Promise<any>;
};

method master

master: {
    (
        params: CatCommonParams,
        callback: (error: any, response: any) => void
    ): void;
    (params: CatCommonParams): Promise<any>;
};

method nodeattrs

nodeattrs: {
    (
        params: CatCommonParams,
        callback: (error: any, response: any) => void
    ): void;
    (params: CatCommonParams): Promise<any>;
};

method nodes

nodes: {
    (
        params: CatCommonParams,
        callback: (error: any, response: any) => void
    ): void;
    (params: CatCommonParams): Promise<any>;
};

method pendingTasks

pendingTasks: {
    (
        params: CatCommonParams,
        callback: (error: any, response: any) => void
    ): void;
    (params: CatCommonParams): Promise<any>;
};

method plugins

plugins: {
    (
        params: CatCommonParams,
        callback: (error: any, response: any) => void
    ): void;
    (params: CatCommonParams): Promise<any>;
};

method recovery

recovery: {
    (
        params: CatRecoveryParams,
        callback: (error: any, response: any) => void
    ): void;
    (params: CatRecoveryParams): Promise<any>;
};

method repositories

repositories: {
    (
        params: CatCommonParams,
        callback: (error: any, response: any) => void
    ): void;
    (params: CatCommonParams): Promise<any>;
};

method segments

segments: {
    (
        params: CatSegmentsParams,
        callback: (error: any, response: any) => void
    ): void;
    (params: CatSegmentsParams): Promise<any>;
};

method shards

shards: {
    (
        params: CatShardsParams,
        callback: (error: any, response: any) => void
    ): void;
    (params: CatShardsParams): Promise<any>;
};

method snapshots

snapshots: {
    (
        params: CatSnapshotsParams,
        callback: (error: any, response: any) => void
    ): void;
    (params: CatSnapshotsParams): Promise<any>;
};

method tasks

tasks: {
    (
        params: CatTasksParams,
        callback: (error: any, response: any) => void
    ): void;
    (params: CatTasksParams): Promise<any>;
};

method threadPool

threadPool: {
    (
        params: CatThreadPoolParams,
        callback: (error: any, response: any) => void
    ): void;
    (params: CatThreadPoolParams): Promise<any>;
};

interface CatAliasesParams

interface CatAliasesParams extends CatCommonParams {}

property name

name?: NameList | undefined;

interface CatAllocationParams

interface CatAllocationParams extends CatCommonParams {}

property bytes

bytes?: CatBytes | undefined;

property nodeId

nodeId?: NameList | undefined;

interface CatCommonParams

interface CatCommonParams extends GenericParams {}

property format

format: string;

property h

h?: NameList | undefined;

property help

help?: boolean | undefined;

property local

local?: boolean | undefined;

property masterTimeout

masterTimeout?: TimeSpan | undefined;

property v

v?: boolean | undefined;

interface CatCountParams

interface CatCountParams extends CatCommonParams {}

property index

index?: NameList | undefined;

interface CatFielddataParams

interface CatFielddataParams extends CatCommonParams {}

property bytes

bytes?: CatBytes | undefined;

property fields

fields?: NameList | undefined;

interface CatHealthParams

interface CatHealthParams extends CatCommonParams {}

property ts

ts?: boolean | undefined;

interface CatHelpParams

interface CatHelpParams extends GenericParams {}

property help

help?: boolean | undefined;

interface CatIndicesParams

interface CatIndicesParams extends CatCommonParams {}

property bytes

bytes?: CatBytes | undefined;

property health

health?: 'green' | 'yellow' | 'red' | undefined;

property index

index?: NameList | undefined;

property pri

pri?: boolean | undefined;

interface CatRecoveryParams

interface CatRecoveryParams extends GenericParams {}

property bytes

bytes?: CatBytes | undefined;

property format

format: string;

property h

h?: NameList | undefined;

property help

help?: boolean | undefined;

property masterTimeout

masterTimeout?: TimeSpan | undefined;

property v

v?: boolean | undefined;

interface CatSegmentsParams

interface CatSegmentsParams extends GenericParams {}

property format

format: string;

property h

h?: NameList | undefined;

property help

help?: boolean | undefined;

property index

index?: NameList | undefined;

property v

v?: boolean | undefined;

interface CatShardsParams

interface CatShardsParams extends CatCommonParams {}

property bytes

bytes?: CatBytes | undefined;

property index

index?: NameList | undefined;

interface CatSnapshotsParams

interface CatSnapshotsParams extends GenericParams {}

property format

format: string;

property h

h?: NameList | undefined;

property help

help?: boolean | undefined;

property ignoreUnavailable

ignoreUnavailable?: boolean | undefined;

property masterTimeout

masterTimeout?: TimeSpan | undefined;

property repository

repository?: NameList | undefined;

property v

v?: boolean | undefined;

interface CatTasksParams

interface CatTasksParams extends GenericParams {}

property actions

actions?: NameList | undefined;

property detailed

detailed?: boolean | undefined;

property format

format: string;

property h

h?: NameList | undefined;

property help

help?: boolean | undefined;

property nodeId

nodeId?: NameList | undefined;

property parentNode

parentNode?: string | undefined;

property parentTask

parentTask?: number | undefined;

property v

v?: boolean | undefined;

interface CatThreadPoolParams

interface CatThreadPoolParams extends CatCommonParams {}

property size

size?: '' | 'k' | 'm' | 'g' | 't' | 'p' | undefined;

property threadPoolPatterns

threadPoolPatterns?: NameList | undefined;

interface ClearScrollParams

interface ClearScrollParams extends GenericParams {}

property scrollId

scrollId: NameList;

interface Cluster

interface Cluster {}

method allocationExplain

allocationExplain: {
    (
        params: ClusterAllocationExplainParams,
        callback: (error: any, response: any) => void
    ): void;
    (params: ClusterAllocationExplainParams): Promise<any>;
};

method getSettings

getSettings: {
    (
        params: ClusterGetSettingsParams,
        callback: (error: any, response: any) => void
    ): void;
    (params: ClusterGetSettingsParams): Promise<any>;
};

method health

health: {
    (
        params: ClusterHealthParams,
        callback: (error: any, response: any) => void
    ): void;
    (params: ClusterHealthParams): Promise<any>;
};

method pendingTasks

pendingTasks: {
    (
        params: ClusterPendingTasksParams,
        callback: (error: any, response: any) => void
    ): void;
    (params: ClusterPendingTasksParams): Promise<any>;
};

method putSettings

putSettings: {
    (
        params: ClusterPutSettingsParams,
        callback: (error: any, response: any) => void
    ): void;
    (params: ClusterPutSettingsParams): Promise<any>;
};

method reroute

reroute: {
    (
        params: ClusterRerouteParams,
        callback: (error: any, response: any) => void
    ): void;
    (params: ClusterRerouteParams): Promise<any>;
};

method state

state: {
    (
        params: ClusterStateParams,
        callback: (error: any, response: any) => void
    ): void;
    (params: ClusterStateParams): Promise<any>;
};

method stats

stats: {
    (
        params: ClusterStatsParams,
        callback: (error: any, response: any) => void
    ): void;
    (params: ClusterStatsParams): Promise<any>;
};

interface ClusterAllocationExplainParams

interface ClusterAllocationExplainParams extends GenericParams {}

property includeDiskInfo

includeDiskInfo?: boolean | undefined;

property includeYesDecisions

includeYesDecisions?: boolean | undefined;

interface ClusterGetSettingsParams

interface ClusterGetSettingsParams extends GenericParams {}

property flatSettings

flatSettings?: boolean | undefined;

property includeDefaults

includeDefaults?: boolean | undefined;

property masterTimeout

masterTimeout?: TimeSpan | undefined;

property timeout

timeout?: TimeSpan | undefined;

interface ClusterHealthParams

interface ClusterHealthParams extends GenericParams {}

property index

index?: NameList | undefined;

property level

level?: 'cluster' | 'indices' | 'shards' | undefined;

property local

local?: boolean | undefined;

property masterTimeout

masterTimeout?: TimeSpan | undefined;

property waitForActiveShards

waitForActiveShards?: string | undefined;

property waitForEvents

waitForEvents?:
    | 'immediate'
    | 'urgent'
    | 'high'
    | 'normal'
    | 'low'
    | 'languid'
    | undefined;

property waitForNodes

waitForNodes?: string | undefined;

property waitForRelocatingShards

waitForRelocatingShards?: boolean | undefined;

property waitForStatus

waitForStatus?: 'green' | 'yellow' | 'red' | undefined;

interface ClusterPendingTasksParams

interface ClusterPendingTasksParams extends GenericParams {}

property local

local?: boolean | undefined;

property masterTimeout

masterTimeout?: TimeSpan | undefined;

interface ClusterPutSettingsParams

interface ClusterPutSettingsParams extends GenericParams {}

property flatSettings

flatSettings?: boolean | undefined;

property masterTimeout

masterTimeout?: TimeSpan | undefined;

property timeout

timeout?: TimeSpan | undefined;

interface ClusterRerouteParams

interface ClusterRerouteParams extends GenericParams {}

property dryRun

dryRun?: boolean | undefined;

property explain

explain?: boolean | undefined;

property masterTimeout

masterTimeout?: TimeSpan | undefined;

property metric

metric?: NameList | undefined;

property retryFailed

retryFailed?: boolean | undefined;

property timeout

timeout?: TimeSpan | undefined;

interface ClusterStateParams

interface ClusterStateParams extends GenericParams {}

property allowNoIndices

allowNoIndices?: boolean | undefined;

property expandWildcards

expandWildcards?: ExpandWildcards | undefined;

property flatSettings

flatSettings?: boolean | undefined;

property ignoreUnavailable

ignoreUnavailable?: boolean | undefined;

property index

index?: NameList | undefined;

property local

local?: boolean | undefined;

property masterTimeout

masterTimeout?: TimeSpan | undefined;

property metric

metric?: NameList | undefined;

interface ClusterStatsParams

interface ClusterStatsParams extends GenericParams {}

property flatSettings

flatSettings?: boolean | undefined;

property human

human?: boolean | undefined;

property nodeId

nodeId?: NameList | undefined;

property timeout

timeout?: TimeSpan | undefined;

interface ConfigOptions

interface ConfigOptions {}

property apiVersion

apiVersion?: string | undefined;

property connectionClass

connectionClass?: string | typeof HttpConnector | undefined;

property createNodeAgent

createNodeAgent?: any;

property deadTimeout

deadTimeout?: number | undefined;

property defer

defer?: (() => void) | undefined;

property host

host?: any;

property hosts

hosts?: any;

property httpAuth

httpAuth?: string | undefined;

property keepAlive

keepAlive?: boolean | undefined;

property log

log?: any;

property maxRetries

maxRetries?: number | undefined;

property maxSockets

maxSockets?: number | undefined;

property nodesToHostCallback

nodesToHostCallback?: any;

property pingTimeout

pingTimeout?: number | undefined;

property plugins

plugins?: any;

property requestTimeout

requestTimeout?: number | undefined;

property selector

selector?: any;

property sniffedNodesProtocol

sniffedNodesProtocol?: string | undefined;

property sniffInterval

sniffInterval?: number | undefined;

property sniffOnConnectionFault

sniffOnConnectionFault?: boolean | undefined;

property sniffOnStart

sniffOnStart?: boolean | undefined;

property ssl

ssl?: object | undefined;

property suggestCompression

suggestCompression?: boolean | undefined;

interface CountParams

interface CountParams extends GenericParams {}

property allowNoIndices

allowNoIndices?: boolean | undefined;

property analyzer

analyzer?: string | undefined;

property analyzeWildcard

analyzeWildcard?: boolean | undefined;

property defaultOperator

defaultOperator?: DefaultOperator | undefined;

property df

df?: string | undefined;

property expandWildcards

expandWildcards?: ExpandWildcards | undefined;

property ignoreUnavailable

ignoreUnavailable?: boolean | undefined;

property index

index?: NameList | undefined;

property lenient

lenient?: boolean | undefined;

property lowercaseExpandedTerms

lowercaseExpandedTerms?: boolean | undefined;

property minScore

minScore?: number | undefined;

property preference

preference?: string | undefined;

property q

q?: string | undefined;

property routing

routing?: string | undefined;

property type

type?: NameList | undefined;

interface CountResponse

interface CountResponse {}

property count

count: number;

interface CreateDocumentParams

interface CreateDocumentParams extends GenericParams {}

property id

id?: string | undefined;

property index

index: string;

property parent

parent?: string | undefined;

property pipeline

pipeline?: string | undefined;

property refresh

refresh?: Refresh | undefined;

property routing

routing?: string | undefined;

property timeout

timeout?: TimeSpan | undefined;

property timestamp

timestamp?: Date | number | undefined;

property ttl

ttl?: TimeSpan | undefined;

property type

type: string;

property version

version?: number | undefined;

property versionType

versionType?: VersionType | undefined;

property waitForActiveShards

waitForActiveShards?: string | undefined;

interface CreateDocumentResponse

interface CreateDocumentResponse {}

property created

created: boolean;

property result

result: string;

interface DeleteDocumentByQueryParams

interface DeleteDocumentByQueryParams extends GenericParams {}

property allowNoIndices

allowNoIndices?: boolean | undefined;

property analyzer

analyzer?: string | undefined;

property analyzeWildcard

analyzeWildcard?: boolean | undefined;

property conflicts

conflicts?: Conflicts | undefined;

property defaultOperator

defaultOperator?: DefaultOperator | undefined;

property df

df?: string | undefined;

property expandWildcards

expandWildcards?: ExpandWildcards | undefined;

property from

from?: number | undefined;

property ignoreUnavailable

ignoreUnavailable?: boolean | undefined;

property index

index?: string | undefined;

property lenient

lenient?: boolean | undefined;

property lowercaseExpandedTerms

lowercaseExpandedTerms?: boolean | undefined;

property preference

preference?: string | undefined;

property q

q?: string | undefined;

property refresh

refresh?: Refresh | undefined;

property requestCache

requestCache?: boolean | undefined;

property requestsPerSecond

requestsPerSecond?: number | undefined;

property routing

routing?: string | string[] | boolean | undefined;

property scroll

scroll?: string | undefined;

property scrollSize

scrollSize?: number | undefined;

property searchTimeout

searchTimeout?: TimeSpan | undefined;

property searchType

searchType?: 'query_then_fetch' | 'dfs_query_then_fetch' | undefined;

property size

size?: number | undefined;

property slices

slices?: number | undefined;

property sort

sort?: NameList | undefined;

property stats

stats?: string | string[] | boolean | undefined;

property terminateAfter

terminateAfter?: number | undefined;

property timeout

timeout?: TimeSpan | undefined;

property type

type?: string | undefined;

property version

version?: number | undefined;

property waitForActiveShards

waitForActiveShards?: string | undefined;

property waitForCompletion

waitForCompletion?: boolean | undefined;

interface DeleteDocumentByQueryResponse

interface DeleteDocumentByQueryResponse extends ReindexResponse {}

interface DeleteDocumentParams

interface DeleteDocumentParams extends GenericParams {}

property id

id: string;

property index

index: string;

property parent

parent?: string | undefined;

property refresh

refresh?: Refresh | undefined;

property routing

routing?: string | undefined;

property timeout

timeout?: TimeSpan | undefined;

property type

type: string;

property version

version?: number | undefined;

property versionType

versionType?: VersionType | undefined;

property waitForActiveShards

waitForActiveShards?: string | undefined;

interface DeleteDocumentResponse

interface DeleteDocumentResponse {}

property found

found: boolean;

property result

result: string;

interface DeleteScriptParams

interface DeleteScriptParams extends GenericParams {}

property id

id: string;

property lang

lang: string;

interface DeleteTemplateParams

interface DeleteTemplateParams extends GenericParams {}

property id

id: string;

interface ExistsParams

interface ExistsParams extends GenericParams {}

property id

id: string;

property index

index: string;

property parent

parent?: string | undefined;

property preference

preference?: string | undefined;

property realtime

realtime?: boolean | undefined;

property refresh

refresh?: boolean | undefined;

property routing

routing?: string | undefined;

property type

type: string;

interface ExplainParams

interface ExplainParams extends GenericParams {}

property analyzer

analyzer?: string | undefined;

property analyzeWildcard

analyzeWildcard?: boolean | undefined;

property defaultOperator

defaultOperator?: DefaultOperator | undefined;

property df

df?: string | undefined;

property id

id?: string | undefined;

property index

index?: string | undefined;

property lenient

lenient?: boolean | undefined;

property lowercaseExpandedTerms

lowercaseExpandedTerms?: boolean | undefined;

property parent

parent?: string | undefined;

property preference

preference?: string | undefined;

property q

q?: string | undefined;

property routing

routing?: string | undefined;

property storedFields

storedFields?: NameList | undefined;

property type

type?: string | undefined;

interface ExplainResponse

interface ExplainResponse {}

property explanation

explanation: ExplainResponseDetails;

property matched

matched: boolean;

interface ExplainResponseDetails

interface ExplainResponseDetails {}

property description

description: string;

property details

details: ExplainResponseDetails[];

property value

value: number;

interface Explanation

interface Explanation {}

property description

description: string;

property details

details: Explanation[];

property value

value: number;

interface FieldStatsParams

interface FieldStatsParams extends GenericParams {}

property allowNoIndices

allowNoIndices?: boolean | undefined;

property expandWildcards

expandWildcards?: ExpandWildcards | undefined;

property fields

fields?: NameList | undefined;

property ignoreUnavailable

ignoreUnavailable?: boolean | undefined;

property index

index?: NameList | undefined;

property level

level?: 'indices' | 'cluster' | undefined;

interface FieldStatsResponse

interface FieldStatsResponse {}

property conflicts

conflicts?: { [fieldName: string]: string } | undefined;

property indices

indices: { [indexName: string]: FieldStatsResponseIndex };

interface FieldStatsResponseField

interface FieldStatsResponseField {}

property density

density: number;

property doc_count

doc_count: number;

property is_aggregatable

is_aggregatable: string;

property is_searchable

is_searchable: string;

property max_doc

max_doc: number;

property max_value

max_value: any;

property min_value

min_value: any;

property sum_doc_freq

sum_doc_freq: number;

property sum_total_term_freq

sum_total_term_freq: number;

interface FieldStatsResponseIndex

interface FieldStatsResponseIndex {}

property fields

fields: { [fieldName: string]: FieldStatsResponseField };

interface GenericParams

interface GenericParams {}

property body

body?: any;

property filterPath

filterPath?: string | string[] | undefined;

property ignore

ignore?: number | number[] | undefined;

property maxRetries

maxRetries?: number | undefined;

property method

method?: string | undefined;

property requestTimeout

requestTimeout?: number | undefined;

interface GetParams

interface GetParams extends GenericParams {}

property id

id: string;

property index

index: string;

property parent

parent?: string | undefined;

property preference

preference?: string | undefined;

property realtime

realtime?: boolean | undefined;

property refresh

refresh?: boolean | undefined;

property routing

routing?: string | undefined;

property storedFields

storedFields?: NameList | undefined;

property type

type: string;

property version

version?: number | undefined;

property versionType

versionType?: VersionType | undefined;

interface GetResponse

interface GetResponse<T> {}

property found

found: boolean;

interface GetScriptParams

interface GetScriptParams extends GenericParams {}

property id

id: string;

property lang

lang: string;

interface GetSourceParams

interface GetSourceParams extends GenericParams {}

property id

id: string;

property index

index: string;

property preference

preference?: string | undefined;

property realtime

realtime?: boolean | undefined;

property refresh

refresh?: boolean | undefined;

property routing

routing?: string | undefined;

property type

type: string;

property version

version?: number | undefined;

property versionType

versionType?: VersionType | undefined;

interface GetTemplateParams

interface GetTemplateParams extends GenericParams {}

property id

id: string;

interface IndexDocumentParams

interface IndexDocumentParams<T> extends GenericParams {}

property body

body: T;

property id

id?: string | undefined;

property index

index: string;

property opType

opType?: 'index' | 'create' | undefined;

property parent

parent?: string | undefined;

property pipeline

pipeline?: string | undefined;

property refresh

refresh?: Refresh | undefined;

property routing

routing?: string | undefined;

property timeout

timeout?: TimeSpan | undefined;

property timestamp

timestamp?: Date | number | undefined;

property ttl

ttl?: TimeSpan | undefined;

property type

type: string;

property version

version?: number | undefined;

property versionType

versionType?: VersionType | undefined;

property waitForActiveShards

waitForActiveShards?: string | undefined;

interface IndicesAnalyzeParams

interface IndicesAnalyzeParams extends GenericParams {}

property analyzer

analyzer?: string | undefined;

property attributes

attributes?: NameList | undefined;

property charFilter

charFilter?: NameList | undefined;

property explain

explain?: boolean | undefined;

property field

field?: string | undefined;

property filter

filter?: NameList | undefined;

property format

format?: '' | undefined;

property index

index?: string | undefined;

property perferLocal

perferLocal?: boolean | undefined;

property text

text?: NameList | undefined;

property tokenizer

tokenizer?: string | undefined;

interface IndicesClearCacheParams

interface IndicesClearCacheParams extends GenericParams {}

property allowNoIndices

allowNoIndices?: boolean | undefined;

property expandWildcards

expandWildcards?: ExpandWildcards | undefined;

property fielddata

fielddata?: boolean | undefined;

property fieldData

fieldData?: boolean | undefined;

property fields

fields?: NameList | undefined;

property ignoreUnavailable

ignoreUnavailable?: boolean | undefined;

property index

index?: NameList | undefined;

property query

query?: boolean | undefined;

property recycler

recycler?: boolean | undefined;

property request

request?: boolean | undefined;

interface IndicesCloseParams

interface IndicesCloseParams extends GenericParams {}

property allowNoIndices

allowNoIndices?: boolean | undefined;

property expandWildcards

expandWildcards?: ExpandWildcards | undefined;

property ignoreUnavailable

ignoreUnavailable?: boolean | undefined;

property index

index: NameList;

property masterTimeout

masterTimeout?: TimeSpan | undefined;

property timeout

timeout?: TimeSpan | undefined;

interface IndicesCreateParams

interface IndicesCreateParams extends GenericParams {}

property includeTypeName

includeTypeName?: boolean | undefined;

property index

index: string;

property masterTimeout

masterTimeout?: TimeSpan | undefined;

property timeout

timeout?: TimeSpan | undefined;

property updateAllTypes

updateAllTypes?: boolean | undefined;

property waitForActiveShards

waitForActiveShards?: string | undefined;

interface IndicesDeleteAliasParams

interface IndicesDeleteAliasParams extends GenericParams {}

property index

index: NameList;

property masterTimeout

masterTimeout?: TimeSpan | undefined;

property name

name: NameList;

property timeout

timeout?: TimeSpan | undefined;

interface IndicesDeleteParams

interface IndicesDeleteParams extends GenericParams {}

property ignoreUnavailable

ignoreUnavailable?: boolean | undefined;

property index

index: NameList;

property masterTimeout

masterTimeout?: TimeSpan | undefined;

property timeout

timeout?: TimeSpan | undefined;

interface IndicesDeleteTemplateParams

interface IndicesDeleteTemplateParams extends GenericParams {}

property masterTimeout

masterTimeout?: TimeSpan | undefined;

property name

name: string;

property timeout

timeout?: TimeSpan | undefined;

interface IndicesExistsAliasParams

interface IndicesExistsAliasParams extends IndicesExistsParams {}

property name

name: NameList;

interface IndicesExistsParams

interface IndicesExistsParams extends GenericParams {}

property allowNoIndices

allowNoIndices?: boolean | undefined;

property expandWildcards

expandWildcards?: ExpandWildcards | undefined;

property ignoreUnavailable

ignoreUnavailable?: boolean | undefined;

property index

index: NameList;

property local

local?: boolean | undefined;

interface IndicesExistsTemplateParams

interface IndicesExistsTemplateParams extends GenericParams {}

property masterTimeout

masterTimeout?: TimeSpan | undefined;

property name

name: NameList;

property timeout

timeout?: TimeSpan | undefined;

interface IndicesExistsTypeParams

interface IndicesExistsTypeParams extends IndicesExistsParams {}

property type

type: NameList;

interface IndicesFlushParams

interface IndicesFlushParams extends GenericParams {}

property allowNoIndices

allowNoIndices?: boolean | undefined;

property expandWildcards

expandWildcards?: ExpandWildcards | undefined;

property force

force?: boolean | undefined;

property ignoreUnavailable

ignoreUnavailable?: boolean | undefined;

property index

index: NameList;

property waitIfOngoing

waitIfOngoing?: boolean | undefined;

interface IndicesFlushSyncedParams

interface IndicesFlushSyncedParams extends GenericParams {}

property allowNoIndices

allowNoIndices?: boolean | undefined;

property expandWildcards

expandWildcards?: ExpandWildcards | undefined;

property ignoreUnavailable

ignoreUnavailable?: boolean | undefined;

property index

index: NameList;

interface IndicesForcemergeParams

interface IndicesForcemergeParams extends GenericParams {}

property allowNoIndices

allowNoIndices?: boolean | undefined;

property expandWildcards

expandWildcards?: ExpandWildcards | undefined;

property flush

flush?: boolean | undefined;

property ignoreUnavailable

ignoreUnavailable?: boolean | undefined;

property index

index: NameList;

property maxNumSegments

maxNumSegments?: number | undefined;

property onlyExpungeDeletes

onlyExpungeDeletes?: boolean | undefined;

property operationThreading

operationThreading?: any;

property waitForMerge

waitForMerge?: boolean | undefined;

interface IndicesGetAliasParams

interface IndicesGetAliasParams extends GenericParams {}

property allowNoIndices

allowNoIndices?: boolean | undefined;

property expandWildcards

expandWildcards?: ExpandWildcards | undefined;

property ignoreUnavailable

ignoreUnavailable?: boolean | undefined;

property index

index?: NameList | undefined;

property local

local?: boolean | undefined;

property name

name?: NameList | undefined;

interface IndicesGetFieldMappingParams

interface IndicesGetFieldMappingParams extends GenericParams {}

property allowNoIndices

allowNoIndices?: boolean | undefined;

property expandWildcards

expandWildcards?: ExpandWildcards | undefined;

property fields

fields?: NameList | undefined;

property ignoreUnavailable

ignoreUnavailable?: boolean | undefined;

property includeDefaults

includeDefaults?: boolean | undefined;

property includeTypeName

includeTypeName?: boolean | undefined;

property index

index?: NameList | undefined;

property local

local?: boolean | undefined;

property type

type?: NameList | undefined;

interface IndicesGetMappingParams

interface IndicesGetMappingParams extends GenericParams {}

property allowNoIndices

allowNoIndices?: boolean | undefined;

property expandWildcards

expandWildcards?: ExpandWildcards | undefined;

property ignoreUnavailable

ignoreUnavailable?: boolean | undefined;

property includeTypeName

includeTypeName?: boolean | undefined;

property index

index?: NameList | undefined;

property local

local?: boolean | undefined;

property type

type?: NameList | undefined;

interface IndicesGetParams

interface IndicesGetParams extends GenericParams {}

property allowNoIndices

allowNoIndices?: boolean | undefined;

property expandWildcards

expandWildcards?: ExpandWildcards | undefined;

property feature

feature?: NameList | undefined;

property flatSettings

flatSettings?: boolean | undefined;

property human

human?: boolean | undefined;

property ignoreUnavailable

ignoreUnavailable?: boolean | undefined;

property includeDefaults

includeDefaults?: boolean | undefined;

property includeTypeName

includeTypeName?: boolean | undefined;

property index

index?: NameList | undefined;

property local

local?: boolean | undefined;

interface IndicesGetSettingsParams

interface IndicesGetSettingsParams extends GenericParams {}

property allowNoIndices

allowNoIndices?: boolean | undefined;

property expandWildcards

expandWildcards?: ExpandWildcards | undefined;

property flatSettings

flatSettings?: boolean | undefined;

property human

human?: boolean | undefined;

property ignoreUnavailable

ignoreUnavailable?: boolean | undefined;

property includeDefaults

includeDefaults?: boolean | undefined;

property index

index?: NameList | undefined;

property local

local?: boolean | undefined;

property name

name?: NameList | undefined;

interface IndicesGetTemplateParams

interface IndicesGetTemplateParams extends GenericParams {}

property flatSettings

flatSettings?: boolean | undefined;

property includeTypeName

includeTypeName?: boolean | undefined;

property local

local?: boolean | undefined;

property masterTimeout

masterTimeout?: TimeSpan | undefined;

property name

name?: NameList | undefined;

interface IndicesGetUpgradeParams

interface IndicesGetUpgradeParams extends GenericParams {}

property allowNoIndices

allowNoIndices?: boolean | undefined;

property expandWildcards

expandWildcards?: ExpandWildcards | undefined;

property human

human?: boolean | undefined;

property ignoreUnavailable

ignoreUnavailable?: boolean | undefined;

property index

index?: NameList | undefined;

interface IndicesOpenParams

interface IndicesOpenParams extends GenericParams {}

property allowNoIndices

allowNoIndices?: boolean | undefined;

property expandWildcards

expandWildcards?: ExpandWildcards | undefined;

property ignoreUnavailable

ignoreUnavailable?: boolean | undefined;

property index

index?: NameList | undefined;

property masterTimeout

masterTimeout?: TimeSpan | undefined;

property timeout

timeout?: TimeSpan | undefined;

interface IndicesPutAliasParams

interface IndicesPutAliasParams extends GenericParams {}

property index

index?: NameList | undefined;

property masterTimeout

masterTimeout?: TimeSpan | undefined;

property name

name: NameList;

property timeout

timeout?: TimeSpan | undefined;

interface IndicesPutMappingParams

interface IndicesPutMappingParams extends GenericParams {}

property allowNoIndices

allowNoIndices?: boolean | undefined;

property body

body: any;

property expandWildcards

expandWildcards?: ExpandWildcards | undefined;

property ignoreUnavailable

ignoreUnavailable?: boolean | undefined;

property includeTypeName

includeTypeName?: boolean | undefined;

property index

index: NameList;

property masterTimeout

masterTimeout?: TimeSpan | undefined;

property timeout

timeout?: TimeSpan | undefined;

property type

type: string;

property updateAllTypes

updateAllTypes?: boolean | undefined;

interface IndicesPutSettingsParams

interface IndicesPutSettingsParams extends GenericParams {}

property allowNoIndices

allowNoIndices?: boolean | undefined;

property body

body: any;

property expandWildcards

expandWildcards?: ExpandWildcards | undefined;

property flatSettings

flatSettings?: boolean | undefined;

property ignoreUnavailable

ignoreUnavailable?: boolean | undefined;

property index

index: NameList;

property masterTimeout

masterTimeout?: TimeSpan | undefined;

property preserveExisting

preserveExisting?: boolean | undefined;

interface IndicesPutTemplateParams

interface IndicesPutTemplateParams extends GenericParams {}

property body

body: any;

property create

create?: boolean | undefined;

property flatSettings

flatSettings?: boolean | undefined;

property includeTypeName

includeTypeName?: boolean | undefined;

property masterTimeout

masterTimeout?: TimeSpan | undefined;

property name

name: string;

property order

order?: number | undefined;

property timeout

timeout?: TimeSpan | undefined;

interface IndicesRecoveryParams

interface IndicesRecoveryParams extends GenericParams {}

property activeOnly

activeOnly?: boolean | undefined;

property detailed

detailed?: boolean | undefined;

property human

human?: boolean | undefined;

property index

index: NameList;

interface IndicesRefreshParams

interface IndicesRefreshParams extends GenericParams {}

property allowNoIndices

allowNoIndices?: boolean | undefined;

property expandWildcards

expandWildcards?: ExpandWildcards | undefined;

property force

force?: boolean | undefined;

property ignoreUnavailable

ignoreUnavailable?: boolean | undefined;

property index

index: NameList;

property operationThreading

operationThreading?: any;

interface IndicesRolloverParams

interface IndicesRolloverParams extends GenericParams {}

property alias

alias?: string | undefined;

property includeTypeName

includeTypeName?: boolean | undefined;

property masterTimeout

masterTimeout?: TimeSpan | undefined;

property newIndex

newIndex?: string | undefined;

property timeout

timeout?: TimeSpan | undefined;

property waitForActiveShards

waitForActiveShards?: number | string | undefined;

interface IndicesRolloverResponse

interface IndicesRolloverResponse {}

property acknowledged

acknowledged: boolean;

property conditions

conditions: { [condition: string]: boolean };

property dry_run

dry_run: boolean;

property new_index

new_index: string;

property old_index

old_index: string;

property rolled_over

rolled_over: boolean;

property shards_acknowledged

shards_acknowledged: boolean;

interface IndicesSegmentsParams

interface IndicesSegmentsParams extends GenericParams {}

property allowNoIndices

allowNoIndices?: boolean | undefined;

property expandWildcards

expandWildcards?: ExpandWildcards | undefined;

property human

human?: boolean | undefined;

property ignoreUnavailable

ignoreUnavailable?: boolean | undefined;

property index

index: NameList;

property operationThreading

operationThreading?: any;

property verbose

verbose?: boolean | undefined;

interface IndicesShardStoresParams

interface IndicesShardStoresParams extends GenericParams {}

property allowNoIndices

allowNoIndices?: boolean | undefined;

property expandWildcards

expandWildcards?: ExpandWildcards | undefined;

property ignoreUnavailable

ignoreUnavailable?: boolean | undefined;

property index

index: NameList;

property operationThreading

operationThreading?: any;

property status

status?: NameList | undefined;

interface IndicesShrinkParams

interface IndicesShrinkParams extends GenericParams {}

property index

index: string;

property masterTimeout

masterTimeout?: TimeSpan | undefined;

property target

target: string;

property timeout

timeout?: TimeSpan | undefined;

property waitForActiveShards

waitForActiveShards?: string | number | undefined;

interface IndicesStatsParams

interface IndicesStatsParams extends GenericParams {}

property completionFields

completionFields?: NameList | undefined;

property fielddataFields

fielddataFields?: NameList | undefined;

property fields

fields?: NameList | undefined;

property groups

groups?: NameList | undefined;

property human

human?: boolean | undefined;

property index

index: NameList;

property level

level?: 'cluster' | 'indices' | 'shards' | undefined;

property metric

metric?: NameList | undefined;

property types

types?: NameList | undefined;

interface IndicesUpdateAliasesParams

interface IndicesUpdateAliasesParams extends GenericParams {}

property body

body: {
    actions: IndicesUpdateAliasesParamsAction[];
};

property masterTimeout

masterTimeout?: TimeSpan | undefined;

property timeout

timeout?: TimeSpan | undefined;

interface IndicesUpdateAliasesParamsAction

interface IndicesUpdateAliasesParamsAction {}

property add

add?:
    | {
          index?: string | undefined;
          indices?: string[] | undefined;
          alias: string;
          routing?: string | undefined;
          filter?: object | undefined;
      }
    | undefined;

property remove

remove?:
    | {
          index?: string | undefined;
          indices?: string[] | undefined;
          alias: string;
      }
    | undefined;

property remove_index

remove_index?:
    | {
          index: string;
      }
    | undefined;

interface IndicesUpgradeParams

interface IndicesUpgradeParams extends GenericParams {}

property expandWildcards

expandWildcards?: ExpandWildcards | undefined;

property ignoreUnavailable

ignoreUnavailable?: boolean | undefined;

property index

index: NameList;

property onlyAncientSegments

onlyAncientSegments?: boolean | undefined;

property waitForCompletion

waitForCompletion?: boolean | undefined;

interface IndicesValidateQueryParams

interface IndicesValidateQueryParams extends GenericParams {}

property allowNoIndices

allowNoIndices?: boolean | undefined;

property analyzer

analyzer?: string | undefined;

property analyzeWildcard

analyzeWildcard?: boolean | undefined;

property defaultOperator

defaultOperator?: DefaultOperator | undefined;

property df

df?: string | undefined;

property expandWildcards

expandWildcards?: ExpandWildcards | undefined;

property explain

explain?: boolean | undefined;

property ignoreUnavailable

ignoreUnavailable?: boolean | undefined;

property index

index: NameList;

property lenient

lenient?: boolean | undefined;

property lowercaseExpandedTerms

lowercaseExpandedTerms?: boolean | undefined;

property operationThreading

operationThreading?: any;

property q

q?: string | undefined;

property rewrite

rewrite?: boolean | undefined;

property type

type?: NameList | undefined;

interface InfoParams

interface InfoParams extends GenericParams {}

interface IngestDeletePipelineParams

interface IngestDeletePipelineParams extends GenericParams {}

property id

id: string;

property masterTimeout

masterTimeout?: number | undefined;

property timeout

timeout?: number | undefined;

interface IngestGetPipelineParams

interface IngestGetPipelineParams extends GenericParams {}

property id

id: string;

property masterTimeout

masterTimeout?: number | undefined;

interface IngestPutPipelineParams

interface IngestPutPipelineParams extends GenericParams {}

property body

body: any;

property id

id: string;

property masterTimeout

masterTimeout?: number | undefined;

property timeout

timeout?: number | undefined;

interface IngestSimulateParams

interface IngestSimulateParams extends GenericParams {}

property id

id: string;

property verbose

verbose?: boolean | undefined;

interface MGetParams

interface MGetParams extends GenericParams {}

property index

index?: string | undefined;

property preference

preference?: string | undefined;

property realtime

realtime?: boolean | undefined;

property refresh

refresh?: boolean | undefined;

property routing

routing?: string | undefined;

property storedFields

storedFields?: NameList | undefined;

property type

type?: string | undefined;

interface MGetResponse

interface MGetResponse<T> {}

property docs

docs?: Array<GetResponse<T>> | undefined;

interface MSearchParams

interface MSearchParams extends GenericParams {}

property index

index?: NameList | undefined;

property maxConcurrentSearches

maxConcurrentSearches?: number | undefined;

property search_type

search_type?:
    | 'query_then_fetch'
    | 'query_and_fetch'
    | 'dfs_query_then_fetch'
    | 'dfs_query_and_fetch'
    | undefined;

property type

type?: NameList | undefined;

interface MSearchResponse

interface MSearchResponse<T> {}

property responses

responses?: Array<SearchResponse<T>> | undefined;

interface MSearchTemplateParams

interface MSearchTemplateParams extends GenericParams {}

property index

index?: NameList | undefined;

property search_type

search_type?:
    | 'query_then_fetch'
    | 'query_and_fetch'
    | 'dfs_query_then_fetch'
    | 'dfs_query_and_fetch'
    | undefined;

property type

type?: NameList | undefined;

interface MTermVectorsParams

interface MTermVectorsParams extends GenericParams {}

property fields

fields?: NameList | undefined;

property fieldStatistics

fieldStatistics?: boolean | undefined;

property ids

ids?: NameList | undefined;

property index

index: string;

property offsets

offsets?: boolean | undefined;

property parent

parent?: string | undefined;

property payloads

payloads?: boolean | undefined;

property positions

positions?: boolean | undefined;

property preference

preference?: string | undefined;

property realtime

realtime?: boolean | undefined;

property routing

routing?: string | undefined;

property termStatistics

termStatistics?: boolean | undefined;

property type

type: string;

property version

version?: number | undefined;

property versionType

versionType?: VersionType | undefined;

interface NodesHotThreadsParams

interface NodesHotThreadsParams extends GenericParams {}

property ignoreIdleThreads

ignoreIdleThreads?: boolean | undefined;

property interval

interval?: TimeSpan | undefined;

property nodeId

nodeId: NameList;

property snapshots

snapshots?: number | undefined;

property threads

threads?: number | undefined;

property timeout

timeout?: TimeSpan | undefined;

property type

type?: 'cpu' | 'wait' | 'blocked' | undefined;

interface NodesInfoParams

interface NodesInfoParams extends GenericParams {}

property flatSettings

flatSettings?: boolean | undefined;

property human

human?: boolean | undefined;

property metric

metric?: NameList | undefined;

property nodeId

nodeId: NameList;

property timeout

timeout?: TimeSpan | undefined;

interface NodesStatsParams

interface NodesStatsParams extends GenericParams {}

property completionFields

completionFields?: NameList | undefined;

property fielddataFields

fielddataFields?: NameList | undefined;

property fields

fields?: NameList | undefined;

property groups

groups?: boolean | undefined;

property human

human?: boolean | undefined;

property indexMetric

indexMetric?: NameList | undefined;

property level

level?: 'indices' | 'node' | 'shards' | undefined;

property metric

metric?: NameList | undefined;

property nodeId

nodeId?: NameList | undefined;

property timeout

timeout?: TimeSpan | undefined;

property types

types?: NameList | undefined;

interface PingParams

interface PingParams extends GenericParams {}

interface PutScriptParams

interface PutScriptParams extends GenericParams {}

property body

body: any;

property id

id: string;

property lang

lang: string;

interface PutTemplateParams

interface PutTemplateParams extends GenericParams {}

property body

body: any;

property id

id: string;

interface ReindexOrByQueryResponseSlice

interface ReindexOrByQueryResponseSlice extends ReindexResponseBase {}

property slice_id

slice_id: number;

interface ReindexParams

interface ReindexParams extends GenericParams {}

property body

body: {
    conflicts?: string | undefined;
    source: {
        index: string | string[];
        type?: string | string[] | undefined;
        query?: any;
        sort?: any;
        size?: number | undefined;
        remote?:
            | {
                  host: string;
                  username?: string | undefined;
                  password?: string | undefined;
              }
            | undefined;
    };
    dest: {
        index: string;
        version_type?: string | undefined;
        op_type?: string | undefined;
        routing?: string | undefined;
        pipeline?: string | undefined;
    };
    script?:
        | {
              inline: string;
              lang: string;
          }
        | undefined;
};

property refresh

refresh?: boolean | undefined;

property requestsPerSecond

requestsPerSecond?: number | undefined;

property slices

slices?: number | undefined;

property timeout

timeout?: TimeSpan | undefined;

property waitForActiveShards

waitForActiveShards?: string | undefined;

property waitForCompletion

waitForCompletion?: boolean | undefined;

interface ReindexResponse

interface ReindexResponse extends ReindexResponseBase {}

property failures

failures: any[];

property slices

slices?: ReindexOrByQueryResponseSlice[] | undefined;

property timed_out

timed_out: boolean;

property took

took: number;

interface ReindexResponseBase

interface ReindexResponseBase {}

property batches

batches: number;

property deleted

deleted: number;

property noops

noops: number;

property requests_per_second

requests_per_second: number;

property retries

retries: {
    bulk: number;
    search: number;
};

property throttled_millis

throttled_millis: number;

property throttled_until_millis

throttled_until_millis: number;

property total

total: number;

property updated

updated: number;

property version_conflicts

version_conflicts: number;

interface ReindexRethrottleParams

interface ReindexRethrottleParams extends GenericParams {}

property requestsPerSecond

requestsPerSecond: number;

property taskId

taskId: string;

interface RenderSearchTemplateParams

interface RenderSearchTemplateParams extends GenericParams {}

property id

id: string;

interface ScrollParams

interface ScrollParams extends GenericParams {}

property scroll

scroll: TimeSpan;

property scrollId

scrollId: string;

interface SearchParams

interface SearchParams extends GenericParams {}

property allowNoIndices

allowNoIndices?: boolean | undefined;

property analyzer

analyzer?: string | undefined;

property analyzeWildcard

analyzeWildcard?: boolean | undefined;

property defaultOperator

defaultOperator?: DefaultOperator | undefined;

property df

df?: string | undefined;

property docvalueFields

docvalueFields?: NameList | undefined;

property expandWildcards

expandWildcards?: ExpandWildcards | undefined;

property explain

explain?: boolean | undefined;

property fielddataFields

fielddataFields?: NameList | undefined;

property from

from?: number | undefined;

property ignoreUnavailable

ignoreUnavailable?: boolean | undefined;

property index

index?: NameList | undefined;

property lenient

lenient?: boolean | undefined;

property lowercaseExpandedTerms

lowercaseExpandedTerms?: boolean | undefined;

property preference

preference?: string | undefined;

property q

q?: string | undefined;

property requestCache

requestCache?: boolean | undefined;

property routing

routing?: NameList | undefined;

property scroll

scroll?: TimeSpan | undefined;

property searchType

searchType?: 'query_then_fetch' | 'dfs_query_then_fetch' | undefined;

property size

size?: number | undefined;

property sort

sort?: NameList | undefined;

property stats

stats?: NameList | undefined;

property storedFields

storedFields?: NameList | undefined;

property suggestField

suggestField?: string | undefined;

property suggestMode

suggestMode?: 'missing' | 'popular' | 'always' | undefined;

property suggestSize

suggestSize?: number | undefined;

property suggestText

suggestText?: string | undefined;

property terminateAfter

terminateAfter?: number | undefined;

property timeout

timeout?: TimeSpan | undefined;

property trackScores

trackScores?: boolean | undefined;

property type

type?: NameList | undefined;

property version

version?: boolean | undefined;

interface SearchResponse

interface SearchResponse<T> {}

property aggregations

aggregations?: any;

property hits

hits: {
    total: number;
    max_score: number;
    hits: Array<{
        _index: string;
        _type: string;
        _id: string;
        _score: number;
        _source: T;
        _version?: number | undefined;
        _explanation?: Explanation | undefined;
        fields?: any;
        highlight?: any;
        inner_hits?: any;
        matched_queries?: string[] | undefined;
        sort?: string[] | undefined;
    }>;
};

property timed_out

timed_out: boolean;

property took

took: number;

interface SearchShardsParams

interface SearchShardsParams extends GenericParams {}

property allowNoIndices

allowNoIndices?: boolean | undefined;

property expandWildcards

expandWildcards?: ExpandWildcards | undefined;

property ignoreUnavailable

ignoreUnavailable?: boolean | undefined;

property index

index: NameList;

property local

local?: boolean | undefined;

property preference

preference?: string | undefined;

property routing

routing?: string | undefined;

property type

type?: NameList;

interface SearchShardsResponse

interface SearchShardsResponse {}

property nodes

nodes: any;

property shards

shards: SearchShardsResponseShard[][];

interface SearchShardsResponseShard

interface SearchShardsResponseShard {}

property allocation_id

allocation_id: {
    id: string;
};

property index

index: string;

property node

node: string;

property primary

primary: boolean;

property relocating_node

relocating_node: any;

property shard

shard: number;

property state

state: string;

interface SearchTemplateParams

interface SearchTemplateParams extends GenericParams {}

property allowNoIndices

allowNoIndices?: boolean | undefined;

property expandWildcards

expandWildcards?: ExpandWildcards | undefined;

property ignoreUnavailable

ignoreUnavailable?: boolean | undefined;

property index

index: NameList;

property preference

preference?: string | undefined;

property routing

routing?: NameList | undefined;

property scroll

scroll?: TimeSpan | undefined;

property searchType

searchType?:
    | 'query_then_fetch'
    | 'query_and_fetch'
    | 'dfs_query_then_fetch'
    | 'dfs_query_and_fetch'
    | undefined;

property type

type: NameList;

interface ShardsResponse

interface ShardsResponse {}

property failed

failed: number;

property skipped

skipped: number;

property successful

successful: number;

property total

total: number;

interface SnapshotCreateParams

interface SnapshotCreateParams extends GenericParams {}

property masterTimeout

masterTimeout?: TimeSpan | undefined;

property repository

repository: string;

property snapshot

snapshot: string;

property waitForCompletion

waitForCompletion?: boolean | undefined;

interface SnapshotCreateRepositoryParams

interface SnapshotCreateRepositoryParams extends GenericParams {}

property masterTimeout

masterTimeout?: TimeSpan | undefined;

property repository

repository: string;

property timeout

timeout?: TimeSpan | undefined;

property verify

verify?: boolean | undefined;

interface SnapshotDeleteParams

interface SnapshotDeleteParams extends GenericParams {}

property masterTimeout

masterTimeout?: TimeSpan | undefined;

property repository

repository: string;

property snapshot

snapshot: string;

interface SnapshotDeleteRepositoryParams

interface SnapshotDeleteRepositoryParams extends GenericParams {}

property masterTimeout

masterTimeout?: TimeSpan | undefined;

property repository

repository: string;

property timeout

timeout?: TimeSpan | undefined;

interface SnapshotGetParams

interface SnapshotGetParams extends GenericParams {}

property ignoreUnavailable

ignoreUnavailable?: boolean | undefined;

property masterTimeout

masterTimeout?: TimeSpan | undefined;

property repository

repository: string;

property snapshot

snapshot: NameList;

interface SnapshotGetRepositoryParams

interface SnapshotGetRepositoryParams extends GenericParams {}

property local

local?: boolean | undefined;

property masterTimeout

masterTimeout?: TimeSpan | undefined;

property repository

repository: NameList;

interface SnapshotRestoreParams

interface SnapshotRestoreParams extends GenericParams {}

property masterTimeout

masterTimeout?: TimeSpan | undefined;

property repository

repository: string;

property snapshot

snapshot: string;

property waitForCompletion

waitForCompletion?: boolean | undefined;

interface SnapshotStatusParams

interface SnapshotStatusParams extends GenericParams {}

property ignoreUnavailable

ignoreUnavailable?: boolean | undefined;

property masterTimeout

masterTimeout?: TimeSpan | undefined;

property repository

repository: string;

property snapshot

snapshot: NameList;

interface SnapshotVerifyRepositoryParams

interface SnapshotVerifyRepositoryParams extends GenericParams {}

property masterTimeout

masterTimeout?: TimeSpan | undefined;

property repository

repository: string;

property timeout

timeout?: TimeSpan | undefined;

interface SuggestParams

interface SuggestParams extends GenericParams {}

property allowNoIndices

allowNoIndices?: boolean | undefined;

property expandWildcards

expandWildcards?: ExpandWildcards | undefined;

property ignoreUnavailable

ignoreUnavailable?: boolean | undefined;

property index

index: NameList;

property preference

preference?: string | undefined;

property routing

routing?: string | undefined;

interface TasksCancelParams

interface TasksCancelParams extends GenericParams {}

property actions

actions?: NameList | undefined;

property nodeId

nodeId?: NameList | undefined;

property parentNode

parentNode?: string | undefined;

property parentTask

parentTask?: string | undefined;

property taskId

taskId?: string | undefined;

interface TasksGetParams

interface TasksGetParams extends GenericParams {}

property taskId

taskId?: string | undefined;

property waitForCompletion

waitForCompletion?: boolean | undefined;

interface TasksListParams

interface TasksListParams extends GenericParams {}

property actions

actions?: NameList | undefined;

property detailed

detailed?: boolean | undefined;

property groupBy

groupBy?: 'nodes' | 'parents' | undefined;

property nodeId

nodeId?: NameList | undefined;

property parentNode

parentNode?: string | undefined;

property parentTask

parentTask?: string | undefined;

property waitForCompletion

waitForCompletion?: boolean | undefined;

interface TermvectorsParams

interface TermvectorsParams extends GenericParams {}

property fields

fields?: NameList | undefined;

property fieldStatistics

fieldStatistics?: boolean | undefined;

property id

id?: string | undefined;

property index

index: string;

property offsets

offsets?: boolean | undefined;

property parent

parent?: string | undefined;

property payloads

payloads?: boolean | undefined;

property positions

positions?: boolean | undefined;

property preference

preference?: string | undefined;

property realtime

realtime?: boolean | undefined;

property routing

routing?: string | undefined;

property termStatistics

termStatistics?: boolean | undefined;

property type

type: string;

property version

version?: number | undefined;

property versionType

versionType?: VersionType | undefined;

interface UpdateDocumentByQueryParams

interface UpdateDocumentByQueryParams extends GenericParams {}

property allowNoIndices

allowNoIndices?: boolean | undefined;

property analyzer

analyzer?: string | undefined;

property analyzeWildcard

analyzeWildcard?: boolean | undefined;

property conflicts

conflicts?: Conflicts | undefined;

property defaultOperator

defaultOperator?: DefaultOperator | undefined;

property df

df?: string | undefined;

property docvalueFields

docvalueFields?: NameList | undefined;

property expandWildcards

expandWildcards?: ExpandWildcards | undefined;

property explain

explain?: boolean | undefined;

property fielddataFields

fielddataFields?: NameList | undefined;

property from

from?: number | undefined;

property ignoreUnavailable

ignoreUnavailable?: boolean | undefined;

property index

index: NameList;

property lenient

lenient?: boolean | undefined;

property lowercaseExpandedTerms

lowercaseExpandedTerms?: boolean | undefined;

property pipeline

pipeline?: string | undefined;

property preference

preference?: string | undefined;

property q

q?: string | undefined;

property refresh

refresh?: boolean | undefined;

property requestCache

requestCache?: boolean | undefined;

property requestsPerSecond

requestsPerSecond?: number | undefined;

property routing

routing?: NameList | undefined;

property scroll

scroll?: TimeSpan | undefined;

property scrollSize

scrollSize?: number | undefined;

property searchTimeout

searchTimeout?: TimeSpan | undefined;

property searchType

searchType?: 'query_then_fetch' | 'dfs_query_then_fetch' | undefined;

property size

size?: number | undefined;

property slices

slices?: number | undefined;

property sort

sort?: NameList | undefined;

property stats

stats?: NameList | undefined;

property storedFields

storedFields?: NameList | undefined;

property suggestField

suggestField?: string | undefined;

property suggestMode

suggestMode?: 'missing' | 'popular' | 'always' | undefined;

property suggestSize

suggestSize?: number | undefined;

property suggestText

suggestText?: string | undefined;

property terminateAfter

terminateAfter?: number | undefined;

property timeout

timeout?: TimeSpan | undefined;

property trackScores

trackScores?: boolean | undefined;

property type

type: NameList;

property version

version?: boolean | undefined;

property versionType

versionType?: boolean | undefined;

property waitForActiveShards

waitForActiveShards?: string | undefined;

property waitForCompletion

waitForCompletion?: boolean | undefined;

interface UpdateDocumentByQueryResponse

interface UpdateDocumentByQueryResponse extends ReindexResponse {}

interface UpdateDocumentParams

interface UpdateDocumentParams extends GenericParams {}

property fields

fields?: NameList | undefined;

property id

id: string;

property index

index: string;

property lang

lang?: string | undefined;

property parent

parent?: string | undefined;

property refresh

refresh?: Refresh | undefined;

property retryOnConflict

retryOnConflict?: number | undefined;

property routing

routing?: string | undefined;

property timeout

timeout?: TimeSpan | undefined;

property timestamp

timestamp?: Date | number | undefined;

property ttl

ttl?: TimeSpan | undefined;

property type

type: string;

property version

version?: number | undefined;

property versionType

versionType?: 'internal' | 'force' | undefined;

property waitForActiveShards

waitForActiveShards?: string | undefined;

Type Aliases

type CatBytes

type CatBytes = 'b' | 'k' | 'kb' | 'm' | 'mb' | 'g' | 'gb' | 't' | 'tb' | 'p' | 'pb';

type Conflicts

type Conflicts = 'abort' | 'proceed';

type DefaultOperator

type DefaultOperator = 'AND' | 'OR';

type ExpandWildcards

type ExpandWildcards = 'open' | 'closed' | 'none' | 'all';

type NameList

type NameList = string | string[] | boolean;

type Refresh

type Refresh = boolean | 'true' | 'false' | 'wait_for' | '';

type TimeSpan

type TimeSpan = string;

A string of a number and a time unit. A time unit is one of [d, h, m, s, ms, micros, nanos]. eg: "30s" for 30 seconds. These are incorrectly identified as Date | number in the docs as of 2016-11-15.

type VersionType

type VersionType = 'internal' | 'external' | 'external_gte' | 'force';

Namespaces

namespace errors

namespace errors {}

class AuthenticationException

class AuthenticationException extends _Abstract {}

class AuthorizationException

class AuthorizationException extends _Abstract {}

class BadGateway

class BadGateway extends _Abstract {}

class BadRequest

class BadRequest extends _Abstract {}

class BlockedByWindowsParentalControls

class BlockedByWindowsParentalControls extends _Abstract {}

class ClientClosedRequest

class ClientClosedRequest extends _Abstract {}

class Conflict

class Conflict extends _Abstract {}

class ConnectionFault

class ConnectionFault extends _Abstract {}

class ExpectationFailed

class ExpectationFailed extends _Abstract {}

class Forbidden

class Forbidden extends _Abstract {}

class GatewayTimeout

class GatewayTimeout extends _Abstract {}

class Generic

class Generic extends _Abstract {}

class HTTPToHTTPS

class HTTPToHTTPS extends _Abstract {}

class HTTPVersionNotSupported

class HTTPVersionNotSupported extends _Abstract {}

class ImATeapot

class ImATeapot extends _Abstract {}

class InternalServerError

class InternalServerError extends _Abstract {}

class LengthRequired

class LengthRequired extends _Abstract {}

class MethodNotAllowed

class MethodNotAllowed extends _Abstract {}

class MovedPermanently

class MovedPermanently extends _Abstract {}

class MultipleChoices

class MultipleChoices extends _Abstract {}

class NoConnections

class NoConnections extends _Abstract {}

class NotAcceptable

class NotAcceptable extends _Abstract {}

class NotExtended

class NotExtended extends _Abstract {}

class NotFound

class NotFound extends _Abstract {}

class NotImplemented

class NotImplemented extends _Abstract {}

class NotModified

class NotModified extends _Abstract {}

class PaymentRequired

class PaymentRequired extends _Abstract {}

class PermanentRedirect

class PermanentRedirect extends _Abstract {}

class PreconditionFailed

class PreconditionFailed extends _Abstract {}

class ProxyAuthenticationRequired

class ProxyAuthenticationRequired extends _Abstract {}

class RequestedRangeNotSatisfiable

class RequestedRangeNotSatisfiable extends _Abstract {}

class RequestEntityTooLarge

class RequestEntityTooLarge extends _Abstract {}

class RequestHeaderTooLarge

class RequestHeaderTooLarge extends _Abstract {}

class RequestTimeout

class RequestTimeout extends _Abstract {}

class RequestTypeError

class RequestTypeError extends _Abstract {}

class RequestURITooLong

class RequestURITooLong extends _Abstract {}

class SeeOther

class SeeOther extends _Abstract {}

class Serialization

class Serialization extends _Abstract {}

class ServiceUnavailable

class ServiceUnavailable extends _Abstract {}

class TemporaryRedirect

class TemporaryRedirect extends _Abstract {}

class TooManyConnectionsFromThisIP

class TooManyConnectionsFromThisIP extends _Abstract {}

class TooManyRequests

class TooManyRequests extends _Abstract {}

class UnsupportedMediaType

class UnsupportedMediaType extends _Abstract {}

class UpgradeRequired

class UpgradeRequired extends _Abstract {}

class UseProxy

class UseProxy extends _Abstract {}

class VariantAlsoNegotiates

class VariantAlsoNegotiates extends _Abstract {}

Package Files (1)

index.d.ts

Dependencies (0)

No dependencies.

Dev Dependencies (0)

No dev dependencies.

Peer Dependencies (0)

No peer dependencies.

Badge

To add a badge like this oneto your package's README, use the codes available below.

You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@types/elasticsearch.

Markdown

[![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@types/elasticsearch)

HTML

<a href="https://www.jsdocs.io/package/@types/elasticsearch"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>

Updated 5 months ago.
Package analyzed in 10965 ms.
Missing or incorrect documentation? Open an issue for this package.