/*
* Licensed to Elasticsearch B.V. under one or more contributor
* license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright
* ownership. Elasticsearch B.V. licenses this file to you under
* the Apache License, Version 2.0 (the "License"); you may
* not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
///
import {
ClientOptions,
ConnectionPool,
Serializer,
Transport,
errors,
RequestEvent,
ResurrectEvent,
ApiError
} from '../index'
import Helpers from '../lib/Helpers'
import {
ApiResponse,
TransportRequestPromise,
TransportRequestParams,
TransportRequestOptions
} from '../lib/Transport'
import * as T from './types'
/**
* We are still working on this type, it will arrive soon.
* If it's critical for you, please open an issue.
* https://github.com/elastic/elasticsearch-js
*/
type TODO = Record
// Extend API
interface ClientExtendsCallbackOptions {
ConfigurationError: errors.ConfigurationError,
makeRequest(params: TransportRequestParams, options?: TransportRequestOptions): Promise | void;
result: {
body: null,
statusCode: null,
headers: null,
warnings: null
}
}
declare type extendsCallback = (options: ClientExtendsCallbackOptions) => any;
// /Extend API
interface KibanaClient {
connectionPool: ConnectionPool
transport: Transport
serializer: Serializer
extend(method: string, fn: extendsCallback): void
extend(method: string, opts: { force: boolean }, fn: extendsCallback): void;
helpers: Helpers
child(opts?: ClientOptions): KibanaClient
close(): Promise;
emit(event: string | symbol, ...args: any[]): boolean;
on(event: 'request', listener: (err: ApiError, meta: RequestEvent) => void): this;
on(event: 'response', listener: (err: ApiError, meta: RequestEvent) => void): this;
on(event: 'sniff', listener: (err: ApiError, meta: RequestEvent) => void): this;
on(event: 'resurrect', listener: (err: null, meta: ResurrectEvent) => void): this;
once(event: 'request', listener: (err: ApiError, meta: RequestEvent) => void): this;
once(event: 'response', listener: (err: ApiError, meta: RequestEvent) => void): this;
once(event: 'sniff', listener: (err: ApiError, meta: RequestEvent) => void): this;
once(event: 'resurrect', listener: (err: null, meta: ResurrectEvent) => void): this;
off(event: string | symbol, listener: (...args: any[]) => void): this;
asyncSearch: {
delete(params: T.AsyncSearchDeleteRequest, options?: TransportRequestOptions): TransportRequestPromise>
get(params: T.AsyncSearchGetRequest, options?: TransportRequestOptions): TransportRequestPromise, TContext>>
status(params: T.AsyncSearchStatusRequest, options?: TransportRequestOptions): TransportRequestPromise, TContext>>
submit(params?: T.AsyncSearchSubmitRequest, options?: TransportRequestOptions): TransportRequestPromise, TContext>>
}
autoscaling: {
deleteAutoscalingPolicy(params?: TODO, options?: TransportRequestOptions): TransportRequestPromise>
getAutoscalingCapacity(params?: TODO, options?: TransportRequestOptions): TransportRequestPromise>
getAutoscalingPolicy(params?: TODO, options?: TransportRequestOptions): TransportRequestPromise>
putAutoscalingPolicy(params?: TODO, options?: TransportRequestOptions): TransportRequestPromise>
}
bulk(params: T.BulkRequest, options?: TransportRequestOptions): TransportRequestPromise>
cat: {
aliases(params?: T.CatAliasesRequest, options?: TransportRequestOptions): TransportRequestPromise>
allocation(params?: T.CatAllocationRequest, options?: TransportRequestOptions): TransportRequestPromise>
count(params?: T.CatCountRequest, options?: TransportRequestOptions): TransportRequestPromise>
fielddata(params?: T.CatFielddataRequest, options?: TransportRequestOptions): TransportRequestPromise>
health(params?: T.CatHealthRequest, options?: TransportRequestOptions): TransportRequestPromise>
help(params?: T.CatHelpRequest, options?: TransportRequestOptions): TransportRequestPromise>
indices(params?: T.CatIndicesRequest, options?: TransportRequestOptions): TransportRequestPromise>
master(params?: T.CatMasterRequest, options?: TransportRequestOptions): TransportRequestPromise>
mlDataFrameAnalytics(params?: T.CatDataFrameAnalyticsRequest, options?: TransportRequestOptions): TransportRequestPromise>
mlDatafeeds(params?: T.CatDatafeedsRequest, options?: TransportRequestOptions): TransportRequestPromise>
mlJobs(params?: T.CatJobsRequest, options?: TransportRequestOptions): TransportRequestPromise>
mlTrainedModels(params?: T.CatTrainedModelsRequest, options?: TransportRequestOptions): TransportRequestPromise>
nodeattrs(params?: T.CatNodeAttributesRequest, options?: TransportRequestOptions): TransportRequestPromise>
nodes(params?: T.CatNodesRequest, options?: TransportRequestOptions): TransportRequestPromise>
pendingTasks(params?: T.CatPendingTasksRequest, options?: TransportRequestOptions): TransportRequestPromise>
plugins(params?: T.CatPluginsRequest, options?: TransportRequestOptions): TransportRequestPromise>
recovery(params?: T.CatRecoveryRequest, options?: TransportRequestOptions): TransportRequestPromise>
repositories(params?: T.CatRepositoriesRequest, options?: TransportRequestOptions): TransportRequestPromise>
segments(params?: T.CatSegmentsRequest, options?: TransportRequestOptions): TransportRequestPromise>
shards(params?: T.CatShardsRequest, options?: TransportRequestOptions): TransportRequestPromise>
snapshots(params?: T.CatSnapshotsRequest, options?: TransportRequestOptions): TransportRequestPromise>
tasks(params?: T.CatTasksRequest, options?: TransportRequestOptions): TransportRequestPromise>
templates(params?: T.CatTemplatesRequest, options?: TransportRequestOptions): TransportRequestPromise>
threadPool(params?: T.CatThreadPoolRequest, options?: TransportRequestOptions): TransportRequestPromise>
transforms(params?: T.CatTransformsRequest, options?: TransportRequestOptions): TransportRequestPromise>
}
ccr: {
deleteAutoFollowPattern(params: T.CcrDeleteAutoFollowPatternRequest, options?: TransportRequestOptions): TransportRequestPromise>
follow(params: T.CcrCreateFollowIndexRequest, options?: TransportRequestOptions): TransportRequestPromise>
followInfo(params: T.CcrFollowInfoRequest, options?: TransportRequestOptions): TransportRequestPromise>
followStats(params: T.CcrFollowIndexStatsRequest, options?: TransportRequestOptions): TransportRequestPromise>
forgetFollower(params: T.CcrForgetFollowerIndexRequest, options?: TransportRequestOptions): TransportRequestPromise>
getAutoFollowPattern(params?: T.CcrGetAutoFollowPatternRequest, options?: TransportRequestOptions): TransportRequestPromise>
pauseAutoFollowPattern(params: T.CcrPauseAutoFollowPatternRequest, options?: TransportRequestOptions): TransportRequestPromise>
pauseFollow(params: T.CcrPauseFollowIndexRequest, options?: TransportRequestOptions): TransportRequestPromise>
putAutoFollowPattern(params: T.CcrPutAutoFollowPatternRequest, options?: TransportRequestOptions): TransportRequestPromise>
resumeAutoFollowPattern(params: T.CcrResumeAutoFollowPatternRequest, options?: TransportRequestOptions): TransportRequestPromise>
resumeFollow(params: T.CcrResumeFollowIndexRequest, options?: TransportRequestOptions): TransportRequestPromise>
stats(params?: T.CcrStatsRequest, options?: TransportRequestOptions): TransportRequestPromise>
unfollow(params: T.CcrUnfollowIndexRequest, options?: TransportRequestOptions): TransportRequestPromise>
}
clearScroll(params?: T.ClearScrollRequest, options?: TransportRequestOptions): TransportRequestPromise>
closePointInTime(params?: T.ClosePointInTimeRequest, options?: TransportRequestOptions): TransportRequestPromise>
cluster: {
allocationExplain(params?: T.ClusterAllocationExplainRequest, options?: TransportRequestOptions): TransportRequestPromise>
deleteComponentTemplate(params: T.ClusterDeleteComponentTemplateRequest, options?: TransportRequestOptions): TransportRequestPromise>
deleteVotingConfigExclusions(params?: TODO, options?: TransportRequestOptions): TransportRequestPromise>
existsComponentTemplate(params?: TODO, options?: TransportRequestOptions): TransportRequestPromise>
getComponentTemplate(params?: T.ClusterGetComponentTemplateRequest, options?: TransportRequestOptions): TransportRequestPromise>
getSettings(params?: T.ClusterGetSettingsRequest, options?: TransportRequestOptions): TransportRequestPromise>
health(params?: T.ClusterHealthRequest, options?: TransportRequestOptions): TransportRequestPromise>
pendingTasks(params?: T.ClusterPendingTasksRequest, options?: TransportRequestOptions): TransportRequestPromise>
postVotingConfigExclusions(params?: TODO, options?: TransportRequestOptions): TransportRequestPromise>
putComponentTemplate(params: T.ClusterPutComponentTemplateRequest, options?: TransportRequestOptions): TransportRequestPromise>
putSettings(params?: T.ClusterPutSettingsRequest, options?: TransportRequestOptions): TransportRequestPromise>
remoteInfo(params?: T.ClusterRemoteInfoRequest, options?: TransportRequestOptions): TransportRequestPromise>
reroute(params?: T.ClusterRerouteRequest, options?: TransportRequestOptions): TransportRequestPromise>
state(params?: T.ClusterStateRequest, options?: TransportRequestOptions): TransportRequestPromise>
stats(params?: T.ClusterStatsRequest, options?: TransportRequestOptions): TransportRequestPromise>
}
count(params?: T.CountRequest, options?: TransportRequestOptions): TransportRequestPromise>
create(params: T.CreateRequest, options?: TransportRequestOptions): TransportRequestPromise>
danglingIndices: {
deleteDanglingIndex(params?: TODO, options?: TransportRequestOptions): TransportRequestPromise>
importDanglingIndex(params?: TODO, options?: TransportRequestOptions): TransportRequestPromise>
listDanglingIndices(params?: TODO, options?: TransportRequestOptions): TransportRequestPromise>
}
dataFrameTransformDeprecated: {
deleteTransform(params?: TODO, options?: TransportRequestOptions): TransportRequestPromise>
getTransform(params?: TODO, options?: TransportRequestOptions): TransportRequestPromise>
getTransformStats(params?: TODO, options?: TransportRequestOptions): TransportRequestPromise>
previewTransform(params?: TODO, options?: TransportRequestOptions): TransportRequestPromise>
putTransform(params?: TODO, options?: TransportRequestOptions): TransportRequestPromise>
startTransform(params?: TODO, options?: TransportRequestOptions): TransportRequestPromise>
stopTransform(params?: TODO, options?: TransportRequestOptions): TransportRequestPromise>
updateTransform(params?: TODO, options?: TransportRequestOptions): TransportRequestPromise>
}
delete(params: T.DeleteRequest, options?: TransportRequestOptions): TransportRequestPromise>
deleteByQuery(params: T.DeleteByQueryRequest, options?: TransportRequestOptions): TransportRequestPromise>
deleteByQueryRethrottle(params: T.DeleteByQueryRethrottleRequest, options?: TransportRequestOptions): TransportRequestPromise>
deleteScript(params: T.DeleteScriptRequest, options?: TransportRequestOptions): TransportRequestPromise>
enrich: {
deletePolicy(params: T.EnrichDeletePolicyRequest, options?: TransportRequestOptions): TransportRequestPromise>
executePolicy(params: T.EnrichExecutePolicyRequest, options?: TransportRequestOptions): TransportRequestPromise>
getPolicy(params?: T.EnrichGetPolicyRequest, options?: TransportRequestOptions): TransportRequestPromise>
putPolicy(params: T.EnrichPutPolicyRequest, options?: TransportRequestOptions): TransportRequestPromise>
stats(params?: T.EnrichStatsRequest, options?: TransportRequestOptions): TransportRequestPromise>
}
eql: {
delete(params: T.EqlDeleteRequest, options?: TransportRequestOptions): TransportRequestPromise>
get(params: T.EqlGetRequest, options?: TransportRequestOptions): TransportRequestPromise, TContext>>
getStatus(params: T.EqlGetStatusRequest, options?: TransportRequestOptions): TransportRequestPromise>
search(params: T.EqlSearchRequest, options?: TransportRequestOptions): TransportRequestPromise, TContext>>
}
exists(params: T.ExistsRequest, options?: TransportRequestOptions): TransportRequestPromise>
existsSource(params: T.ExistsSourceRequest, options?: TransportRequestOptions): TransportRequestPromise>
explain(params: T.ExplainRequest, options?: TransportRequestOptions): TransportRequestPromise, TContext>>
features: {
getFeatures(params?: TODO, options?: TransportRequestOptions): TransportRequestPromise>
resetFeatures(params?: TODO, options?: TransportRequestOptions): TransportRequestPromise>
}
fieldCaps(params?: T.FieldCapsRequest, options?: TransportRequestOptions): TransportRequestPromise>
fleet: {
globalCheckpoints(params?: TODO, options?: TransportRequestOptions): TransportRequestPromise>
}
get(params: T.GetRequest, options?: TransportRequestOptions): TransportRequestPromise, TContext>>
getScript(params: T.GetScriptRequest, options?: TransportRequestOptions): TransportRequestPromise>
getScriptContext(params?: T.GetScriptContextRequest, options?: TransportRequestOptions): TransportRequestPromise>
getScriptLanguages(params?: T.GetScriptLanguagesRequest, options?: TransportRequestOptions): TransportRequestPromise>
getSource(params?: T.GetSourceRequest, options?: TransportRequestOptions): TransportRequestPromise, TContext>>
graph: {
explore(params: T.GraphExploreRequest, options?: TransportRequestOptions): TransportRequestPromise>
}
ilm: {
deleteLifecycle(params: T.IlmDeleteLifecycleRequest, options?: TransportRequestOptions): TransportRequestPromise>
explainLifecycle(params: T.IlmExplainLifecycleRequest, options?: TransportRequestOptions): TransportRequestPromise>
getLifecycle(params?: T.IlmGetLifecycleRequest, options?: TransportRequestOptions): TransportRequestPromise>
getStatus(params?: T.IlmGetStatusRequest, options?: TransportRequestOptions): TransportRequestPromise>
migrateToDataTiers(params?: TODO, options?: TransportRequestOptions): TransportRequestPromise>
moveToStep(params: T.IlmMoveToStepRequest, options?: TransportRequestOptions): TransportRequestPromise>
putLifecycle(params?: T.IlmPutLifecycleRequest, options?: TransportRequestOptions): TransportRequestPromise>
removePolicy(params: T.IlmRemovePolicyRequest, options?: TransportRequestOptions): TransportRequestPromise>
retry(params: T.IlmRetryRequest, options?: TransportRequestOptions): TransportRequestPromise>
start(params?: T.IlmStartRequest, options?: TransportRequestOptions): TransportRequestPromise>
stop(params?: T.IlmStopRequest, options?: TransportRequestOptions): TransportRequestPromise>
}
index(params: T.IndexRequest, options?: TransportRequestOptions): TransportRequestPromise>
indices: {
addBlock(params: T.IndicesAddBlockRequest, options?: TransportRequestOptions): TransportRequestPromise>
analyze(params?: T.IndicesAnalyzeRequest, options?: TransportRequestOptions): TransportRequestPromise>
clearCache(params?: T.IndicesClearCacheRequest, options?: TransportRequestOptions): TransportRequestPromise>
clone(params: T.IndicesCloneRequest, options?: TransportRequestOptions): TransportRequestPromise>
close(params: T.IndicesCloseRequest, options?: TransportRequestOptions): TransportRequestPromise>
create(params: T.IndicesCreateRequest, options?: TransportRequestOptions): TransportRequestPromise>
createDataStream(params: T.IndicesCreateDataStreamRequest, options?: TransportRequestOptions): TransportRequestPromise>
dataStreamsStats(params?: T.IndicesDataStreamsStatsRequest, options?: TransportRequestOptions): TransportRequestPromise>
delete(params: T.IndicesDeleteRequest, options?: TransportRequestOptions): TransportRequestPromise>
deleteAlias